Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dist/types/src/consent.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ConsentState, PrivacyConsentState } from '@mparticle/web-sdk';
import { ConsentState, PrivacyConsentState } from './publicSdkTypes';
import { Dictionary } from './utils';
import { IMParticleUser } from './identity-user-interfaces';
import { IMParticleWebSDKInstance } from './mp-instance';
Expand Down
2 changes: 1 addition & 1 deletion dist/types/src/cookieSyncManager.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Dictionary } from './utils';
import { MPID } from '@mparticle/web-sdk';
import { MPID } from './publicSdkTypes';
import { IConsentRules } from './consent';
import { IMParticleWebSDKInstance } from './mp-instance';
export declare const DAYS_IN_MILLISECONDS: number;
Expand Down
7 changes: 3 additions & 4 deletions dist/types/src/ecommerce.interfaces.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { ProductAction, Product, Promotion, CommerceEvent } from '@mparticle/event-models';
import { SDKEventAttrs, SDKEventOptions, TransactionAttributes } from '@mparticle/web-sdk';
import { SDKEventAttrs, SDKEventOptions, TransactionAttributes } from './publicSdkTypes';
import { valueof } from './utils';
import { ProductActionType, PromotionActionType, CommerceEventType, EventType } from './types';
import { SDKEvent, SDKEventCustomFlags, SDKImpression, SDKProduct, SDKProductImpression, SDKPromotion } from './sdkRuntimeModels';
Expand Down Expand Up @@ -58,9 +58,8 @@ interface ExtractedTransactionId {
}
export interface IECommerce extends IECommerceShared {
buildProductList(event: SDKEvent, product: Product | Product[]): Product[];
convertProductActionToEventType(productActionType: valueof<typeof ProductActionType>): // https://go.mparticle.com/work/SQDSDKS-4801
typeof CommerceEventType | typeof EventType | null;
convertPromotionActionToEventType(promotionActionType: valueof<typeof PromotionActionType>): typeof CommerceEventType | null;
convertProductActionToEventType(productActionType: valueof<typeof ProductActionType>): valueof<typeof CommerceEventType> | valueof<typeof EventType> | null;
convertPromotionActionToEventType(promotionActionType: valueof<typeof PromotionActionType>): valueof<typeof CommerceEventType> | null;
convertTransactionAttributesToProductAction(transactionAttributes: TransactionAttributes, productAction: ProductAction): void;
createCommerceEventObject(customFlags: SDKEventCustomFlags, options?: SDKEventOptions): SDKEvent | null;
expandProductAction(commerceEvent: CommerceEvent): SDKEvent[];
Expand Down
2 changes: 1 addition & 1 deletion dist/types/src/events.interfaces.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Callback, SDKEventAttrs, SDKEventOptions, TransactionAttributes } from '@mparticle/web-sdk';
import { Callback, SDKEventAttrs, SDKEventOptions, TransactionAttributes } from './publicSdkTypes';
import { BaseEvent, SDKEvent, SDKEventCustomFlags, SDKProduct, SDKProductImpression, SDKPromotion } from './sdkRuntimeModels';
import { valueof } from './utils';
import { EventType, ProductActionType, PromotionActionType } from './types';
Expand Down
3 changes: 2 additions & 1 deletion dist/types/src/forwarders.interfaces.d.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import { SDKEvent, SDKEventCustomFlags } from './sdkRuntimeModels';
import { Dictionary } from './utils';
import { IKitConfigs, IKitFilterSettings } from './configAPIClient';
import { IdentityApiData, IdentityType } from '@mparticle/web-sdk';
import { IdentityApiData } from './publicSdkTypes';
import { IdentityType } from './types';
import { Batch } from '@mparticle/event-models';
import { IMParticleUser, ISDKUserIdentity, UserAttributes } from './identity-user-interfaces';
export type MPForwarder = Dictionary;
Expand Down
4 changes: 2 additions & 2 deletions dist/types/src/helpers.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ export default class Helpers {
isStringOrNumber: (value: any) => boolean;
isValidAttributeValue: (value: any) => boolean;
isValidKeyValue: (key: any) => boolean;
removeFalsyIdentityValues: (identityApiData: import("@mparticle/web-sdk").IdentityApiData, logger: any) => import("@mparticle/web-sdk").IdentityApiData;
validateIdentities: (identityApiData: import("@mparticle/web-sdk").IdentityApiData, method?: import("./identity.interfaces").IdentityAPIMethod) => {
removeFalsyIdentityValues: (identityApiData: import("./publicSdkTypes").IdentityApiData, logger: any) => import("./publicSdkTypes").IdentityApiData;
validateIdentities: (identityApiData: import("./publicSdkTypes").IdentityApiData, method?: import("./identity.interfaces").IdentityAPIMethod) => {
valid: boolean;
error?: utils.valueof<{
readonly ModifyIdentityRequestUserIdentitiesPresent: "identityRequests to modify require userIdentities to be present. Request not sent to server. Please fix and try again";
Expand Down
35 changes: 2 additions & 33 deletions dist/types/src/identity-user-interfaces.d.ts
Original file line number Diff line number Diff line change
@@ -1,16 +1,8 @@
import { AllUserAttributes, MPID, User } from '@mparticle/web-sdk';
import type { AllUserAttributes, IdentityCallback, IdentityResultBody, User } from './publicSdkTypes';
import { SDKIdentityTypeEnum } from './identity.interfaces';
import { MessageType } from './types';
import { BaseEvent, SDKProduct } from './sdkRuntimeModels';
declare const HTTPCodes: {
readonly noHttpCoverage: -1;
readonly activeIdentityRequest: -2;
readonly activeSession: -3;
readonly validationIssue: -4;
readonly nativeIdentityRequest: -5;
readonly loggingDisabledOrMissingAPIKey: -6;
readonly tooManyRequests: 429;
};
export type { IdentityCallback, IdentityModifyResultBody, IdentityResult, IdentityResultBody, } from './publicSdkTypes';
interface ICart {
/**
* @deprecated Cart persistence in mParticle has been deprecated. Please use mParticle.eCommerce.logProductAction(mParticle.ProductActionType.AddToCart, [products])
Expand Down Expand Up @@ -68,39 +60,16 @@ export interface IUserAttributeChangeEvent extends BaseEvent {
messageType: typeof MessageType.UserAttributeChange;
userAttributeChanges: ISDKUserAttributeChangeData;
}
export interface IdentityCallback {
(result: IdentityResult): void;
}
export interface IIdentityResponse {
responseText: IdentityResultBody;
status: number;
cacheMaxAge?: number;
expireTimestamp?: number;
}
export interface IdentityResult {
httpCode: typeof HTTPCodes;
getPreviousUser(): User;
getUser(): User;
body: IdentityResultBody | IdentityModifyResultBody;
}
export interface IdentityResultBody {
context: string | null;
is_ephemeral: boolean;
is_logged_in: boolean;
matched_identities: Record<string, unknown>;
mpid?: MPID;
}
export interface IdentityModifyResultBody {
change_results?: {
identity_type: SDKIdentityTypeEnum;
modified_mpid: MPID;
};
}
export interface mParticleUserCart {
add(): void;
remove(): void;
clear(): void;
getCartProducts(): SDKProduct[];
}
export type UserAttributes = AllUserAttributes;
export {};
4 changes: 2 additions & 2 deletions dist/types/src/identity-utils.d.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { Dictionary, Environment } from './utils';
import { BaseVault } from './vault';
import { IdentityApiData, UserIdentities, IdentityCallback } from '@mparticle/web-sdk';
import { IdentityApiData, UserIdentities } from './publicSdkTypes';
import { IdentityAPIMethod } from './identity.interfaces';
import { IIdentityResponse, IMParticleUser } from './identity-user-interfaces';
import { IdentityCallback, IIdentityResponse, IMParticleUser } from './identity-user-interfaces';
import { IStore } from './store';
import type { IMParticleWebSDKInstance } from './mp-instance';
import { IIdentitySearchRequestBody, IdentitySearchCallback } from './identity/search';
Expand Down
32 changes: 16 additions & 16 deletions dist/types/src/identity.interfaces.d.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { IdentityApiData, MPID, UserIdentities } from '@mparticle/web-sdk';
import { IdentityApiData, MPID, UserIdentities } from './publicSdkTypes';
import AudienceManager from './audienceManager';
import { ICachedIdentityCall, IKnownIdentities } from './identity-utils';
import { BaseVault } from './vault';
import { Dictionary, Environment, valueof } from './utils';
import { Dictionary, valueof } from './utils';
import Constants from './constants';
import { IdentityCallback, IUserAttributeChangeEvent, IUserIdentityChangeEvent, IMParticleUser, mParticleUserCart, IIdentityResponse } from './identity-user-interfaces';
import { IdentitySearchCallback } from './identity/search';
Expand Down Expand Up @@ -51,25 +51,25 @@ export interface IIdentityAPIRequestData {
sdk_version: typeof sdkVersion;
};
context: string | null;
environment: Environment;
environment: string;
request_id: string;
request_timestamp_unixtime_ms: number;
request_timestamp_ms: number;
previous_mpid: MPID | null;
known_identities: IKnownIdentities;
}
export interface IIdentityAPIModifyRequestData extends Omit<IIdentityAPIRequestData, 'known_identities' | 'previous_mpid'> {
identity_changes: IIdentityAPIIdentityChangeData[];
}
export interface IIdentityAPIIdentityChangeData {
identity_type: SDKIdentityTypeEnum;
identity_type: SDKIdentityTypeEnum | string;
old_value: string;
new_value: string;
}
export interface IIdentityRequest {
combineUserIdentities(previousUIByName: UserIdentities, newUIByName: UserIdentities): UserIdentities;
createIdentityRequest(identityApiData: IdentityApiData, platform: string, sdkVendor: string, sdkVersion: string, deviceId: string, context: string | null, mpid: MPID): IIdentityAPIRequestData;
createModifyIdentityRequest(currentUserIdentities: UserIdentities, newUserIdentities: UserIdentities, platform: string, sdkVendor: string, sdkVersion: string, context: string | null): IIdentityAPIModifyRequestData;
createIdentityChanges(previousIdentities: UserIdentities, newIdentitie: UserIdentities): IIdentityAPIIdentityChangeData;
createIdentityChanges(previousIdentities: UserIdentities, newIdentitie: UserIdentities): IIdentityAPIIdentityChangeData[];
preProcessIdentityRequest(identityApiData: IdentityApiData, callback: IdentityCallback, method: IdentityAPIMethod): IdentityPreProcessResult;
}
export type AliasRequestScope = 'device' | 'mpid';
Expand All @@ -89,15 +89,15 @@ export interface IAliasResult {
}
export interface SDKIdentityApi {
HTTPCodes: typeof HTTPCodes;
identify?(identityApiData?: IdentityApiData, callback?: IdentityCallback): void;
login?(identityApiData?: IdentityApiData, callback?: IdentityCallback): void;
logout?(identityApiData?: IdentityApiData, callback?: IdentityCallback): void;
modify?(identityApiData?: IdentityApiData, callback?: IdentityCallback): void;
getCurrentUser?(): IMParticleUser;
getUser?(mpid: string): IMParticleUser;
getUsers?(): IMParticleUser[];
aliasUsers?(aliasRequest?: IAliasRequest, callback?: IdentityCallback): void;
createAliasRequest?(sourceUser: IMParticleUser, destinationUser: IMParticleUser, scope?: AliasRequestScope): IAliasRequest;
identify(identityApiData?: IdentityApiData, callback?: IdentityCallback): void;
login(identityApiData?: IdentityApiData, callback?: IdentityCallback): void;
logout(identityApiData?: IdentityApiData, callback?: IdentityCallback): void;
modify(identityApiData?: IdentityApiData, callback?: IdentityCallback): void;
getCurrentUser(): IMParticleUser;
getUser(mpid: string): IMParticleUser;
getUsers(): IMParticleUser[];
aliasUsers(aliasRequest?: IAliasRequest, callback?: IdentityCallback): void;
createAliasRequest(sourceUser: IMParticleUser, destinationUser: IMParticleUser, scope?: AliasRequestScope): IAliasRequest;
/**
* Sends a request to mParticle's IDSync `/v1/search` endpoint to look up
* a workspace identity without affecting the current user. The callback
Expand All @@ -109,7 +109,7 @@ export interface SDKIdentityApi {
* caller (from a kit's settings). It is sent as the `x-mp-key` header.
* The SDK's own workspace token is intentionally not used.
*/
search?(workspaceApiKey: string, knownIdentities: UserIdentities, callback: IdentitySearchCallback): void;
search(workspaceApiKey: string, knownIdentities: UserIdentities, callback: IdentitySearchCallback): void;
}
export type { IIdentitySearchResult, IIdentitySearchResponseBody, IdentitySearchCallback, } from './identity/search';
export interface IUserIdentities {
Expand Down
2 changes: 1 addition & 1 deletion dist/types/src/identity/search.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { SDKLoggerApi } from '../sdkRuntimeModels';
import { Environment } from '../utils';
import { AsyncUploader } from '../uploaders';
import { IErrorReportingService } from '../reporting/types';
import { UserIdentities } from '@mparticle/web-sdk';
import { UserIdentities } from '../publicSdkTypes';
/**
* Body payload returned by the `/v1/search` endpoint, as parsed JSON.
*
Expand Down
2 changes: 1 addition & 1 deletion dist/types/src/identityApiClient.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { IAliasCallback, IAliasRequest, IdentityAPIMethod, IIdentity, IIdentityAPIRequestData } from './identity.interfaces';
import { IdentityApiData, MPID, UserIdentities } from '@mparticle/web-sdk';
import { IdentityApiData, MPID, UserIdentities } from './publicSdkTypes';
import { IdentityCallback, IdentityResultBody, IIdentityResponse } from './identity-user-interfaces';
import { IMParticleWebSDKInstance } from './mp-instance';
export interface IIdentityApiClient {
Expand Down
3 changes: 2 additions & 1 deletion dist/types/src/internal-types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
* Customers should NOT import from this path.
*/
export * from './public-types';
export type { KitInterface, } from './forwarders.interfaces';
export type { ConfiguredKit, forwardingStatsCallback, KitInterface, KitRegistrationConfig, MPForwarder, RegisteredKit, UnregisteredKit, UserAttributeFilters, UserIdentityFilters, UserIdentityId, UserIdentityType, } from './forwarders.interfaces';
export type { IKitConfigs, IKitFilterSettings, } from './configAPIClient';
export type { RoktAttributeValue, RoktAttributeValueType, RoktAttributeValueArray, RoktAttributes, IRoktPartnerExtensionData, IRoktSelectPlacementsOptions, IRoktSelection, IRoktLauncher, IRoktMessage, RoktKitFilterSettings, IRoktKitSettings, IRoktKit, IRoktOptions, IRoktLauncherOptions, } from './roktManager';
export type { ErrorCodes, WSDKErrorSeverity, } from './reporting/types';
export type { ISDKError, ISDKLogEntry, IErrorReportingService, ILoggingService, } from './reporting/types';
Expand Down
2 changes: 1 addition & 1 deletion dist/types/src/mp-instance.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ import { IServerModel } from './serverModel';
import ForwardingStatsUploader from './forwardingStatsUploader';
import { IConsent } from './consent';
import IdentityAPIClient from './identityApiClient';
import { Dictionary } from './utils';
import IntegrationCapture from './integrationCapture';
import { IPreInit } from './pre-init-utils';
import { MParticleWebSDK, SDKHelpersApi } from './sdkRuntimeModels';
import { Dictionary } from '@mparticle/web-sdk';
import { IIdentity } from './identity.interfaces';
import { IEvents } from './events.interfaces';
import { IECommerce } from './ecommerce.interfaces';
Expand Down
4 changes: 2 additions & 2 deletions dist/types/src/persistence.interfaces.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Context } from '@mparticle/event-models';
import { IdentityApiData, MPID, Product, UserIdentities } from '@mparticle/web-sdk';
import { IdentityApiData, MPID, Product, UserIdentities } from './publicSdkTypes';
import { IForwardingStatsData } from './apiClient';
import { IntegrationAttributes, ServerSettings, SessionAttributes, LocalSessionAttributes } from './store';
import { Dictionary } from './utils';
Expand Down Expand Up @@ -48,7 +48,7 @@ export interface IPersistence {
storeDataInMemory(obj: IPersistenceMinified, currentMPID: MPID): void;
determineLocalStorageAvailability(storage: Storage): boolean;
setLocalStorage(): void;
getLocalStorage(): IPersistenceMinified | null;
getLocalStorage(): IPersistenceMinified | Dictionary | null;
expireCookies(cookieName: string): void;
getCookie(): IPersistenceMinified | null;
setCookie(): void;
Expand Down
19 changes: 11 additions & 8 deletions dist/types/src/public-types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,20 @@
* Usage:
* import type { SDKInitConfig, EventType } from '@mparticle/web-sdk';
*
* Note: Types from @types/mparticle__web-sdk (e.g., MPConfiguration, MPID,
* ConsentState) are NOT re-exported here to avoid circular references.
* Consumers get those automatically via DefinitelyTyped until they are
* natively defined in this SDK and the DT package is deprecated.
* These declarations replace the legacy DefinitelyTyped surface. Keep this
* file focused on customer-facing SDK types; kit and SDK implementation types
* belong in internal-types.ts.
*/
import type { MParticleWebSDKManager } from './sdkRuntimeModels';
declare const mParticle: MParticleWebSDKManager;
export default mParticle;
export type { Batch, } from '@mparticle/event-models';
export type { AliasRequestScope, AliasUsersCallback, AllUserAttributes, Callback, Cart, CCPAConsentState, ConsentState, DataPlanConfig, DataPlanResult, Dictionary, GDPRConsentState, IdentityApiData, IdentityCallback, IdentityModifyResultBody, IdentityResult, IdentityResultBody, IdentifyRequest, Impression, Location, Logger, LogLevel, MPConfiguration, MPForwarder, MPID, OnCreateBatch, onCreateBatch, PrivacyConsentState, Product, Promotion, SDKEventAttrs, SDKEventAttrTypes, SDKEventCustomFlags, SDKEventOptions, TrackLocationCallback, TransactionAttributes, User, UserAliasRequest, UserAttributesValue, UserIdentities, } from './publicSdkTypes';
export type { EventType, CommerceEventType, IdentityType, ProductActionType, PromotionActionType, MessageType, } from './types';
export type { SDKInitConfig, DataPlanConfig, BaseEvent, SDKEventCustomFlags, LogLevelType, MParticleWebSDK, } from './sdkRuntimeModels';
export type { IMParticleUser, IdentityCallback, IdentityResult, IdentityResultBody, IdentityModifyResultBody, ISDKUserIdentity, ISDKUserAttributes, } from './identity-user-interfaces';
export type { SDKIdentityApi, IAliasRequest, IAliasCallback, IAliasResult, SDKIdentityTypeEnum, IIdentitySearchResult, IIdentitySearchResponseBody, IdentitySearchCallback, IUserIdentities } from './identity.interfaces';
export type { SDKInitConfig, BaseEvent, LogLevelType, MParticleWebSDKInstance, MParticleWebSDKManager, MParticleWebSDK, } from './sdkRuntimeModels';
export type { IMParticleUser, ISDKUserIdentity, ISDKUserAttributes, } from './identity-user-interfaces';
export type { SDKIdentityApi, IAliasRequest, IAliasCallback, IAliasResult, SDKIdentityTypeEnum, IIdentitySearchResult, IIdentitySearchResponseBody, IdentitySearchCallback, IUserIdentities, } from './identity.interfaces';
export type { SDKECommerceAPI, SDKCart, } from './ecommerce.interfaces';
export type { SDKProduct, SDKPromotion, SDKImpression, SDKProductImpression, } from './sdkRuntimeModels';
export type { SDKConsentApi, SDKConsentState, SDKConsentStateData, SDKGDPRConsentState, SDKCCPAConsentState, } from './consent';
export type { Dictionary, valueof } from './utils';
export type { valueof } from './utils';
Loading
Loading