@rudderstack/analytics-js 3.0.0-beta.14 → 3.0.0-beta.15

package/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [3.0.0-beta.15](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/analytics-js@3.0.0-beta.14...@rudderstack/analytics-js@3.0.0-beta.15) (2023-11-13)
+
+
+### Features
+
+* add beacon polyfill ([#1487](https://github.com/rudderlabs/rudder-sdk-js/issues/1487)) ([8053ae2](https://github.com/rudderlabs/rudder-sdk-js/commit/8053ae2ec7c5757bb65a1881ca1b79fe08c30fc7))
+* buffer consent method invocations ([#1501](https://github.com/rudderlabs/rudder-sdk-js/issues/1501)) ([70f6f64](https://github.com/rudderlabs/rudder-sdk-js/commit/70f6f64500b6b08bbb657498ec0e1fdecf72b82c))
+* consent api wrap up ([#1477](https://github.com/rudderlabs/rudder-sdk-js/issues/1477)) ([edc78ac](https://github.com/rudderlabs/rudder-sdk-js/commit/edc78ac54235aabfc8d1d78f961fbd650a3b7c73))
+* reinitialize persistent data from consent options ([#1465](https://github.com/rudderlabs/rudder-sdk-js/issues/1465)) ([43f30b7](https://github.com/rudderlabs/rudder-sdk-js/commit/43f30b7296ae9a0862810fd0b3c520e8bddf614c))
+
+
+### Bug Fixes
+
+* gcm post consent issues ([#1507](https://github.com/rudderlabs/rudder-sdk-js/issues/1507)) ([6241d3d](https://github.com/rudderlabs/rudder-sdk-js/commit/6241d3da28edc9b5f478774a763226d9d72f7dcc))
+* gcm qa fixes ([#1499](https://github.com/rudderlabs/rudder-sdk-js/issues/1499)) ([84ca784](https://github.com/rudderlabs/rudder-sdk-js/commit/84ca784e6848e7fd8988c4a93db46d4636f2f89c))
+* storage migration to allow empty string values ([#1488](https://github.com/rudderlabs/rudder-sdk-js/issues/1488)) ([b639fa1](https://github.com/rudderlabs/rudder-sdk-js/commit/b639fa17f22d1bbad951b293c9edba36f164163e))
+
 ## [3.0.0-beta.14](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/analytics-js@3.0.0-beta.13...@rudderstack/analytics-js@3.0.0-beta.14) (2023-10-27)
 
 

package/dist/npm/index.d.ts

@@ -144,11 +144,19 @@ type PluginName = 'BeaconQueue' | 'Bugsnag' | 'CustomConsentManager' | 'DeviceMo
 type OneTrustCookieCategory = {
     oneTrustCookieCategory: string;
 };
-type ConsentProvider = 'oneTrust' | 'ketch' | 'custom';
+type ConsentManagementMetadata = {
+    providers: ConsentManagementProviderMetadata[];
+};
+type ConsentManagementProviderMetadata = {
+    provider: ConsentManagementProvider;
+    resolutionStrategy: ConsentResolutionStrategy;
+};
+type ConsentManagementProvider = 'oneTrust' | 'ketch' | 'custom';
+type ConsentResolutionStrategy = 'and' | 'or';
 type Consents = Record<string, string> | string[];
 type ConsentManagementOptions = {
     enabled: boolean;
-    provider: ConsentProvider;
+    provider: ConsentManagementProvider;
     allowedConsentIds?: Consents;
     deniedConsentIds?: Consents;
 };
@@ -160,7 +168,7 @@ type KetchConsentPurpose = {
     purpose: string;
 };
 
-type UserSessionKeys = 'userId' | 'userTraits' | 'anonymousId' | 'groupId' | 'groupTraits' | 'initialReferrer' | 'initialReferringDomain' | 'sessionInfo' | 'authToken';
+type UserSessionKey = 'userId' | 'userTraits' | 'anonymousId' | 'groupId' | 'groupTraits' | 'initialReferrer' | 'initialReferringDomain' | 'sessionInfo' | 'authToken';
 
 type StorageEncryptionVersion = 'legacy' | 'v3';
 type StorageType = 'cookieStorage' | 'localStorage' | 'memoryStorage' | 'sessionStorage' | 'none';
@@ -176,7 +184,7 @@ type StorageOpts = {
     type?: StorageType;
     cookie?: CookieOptions;
     entries?: {
-        [key in UserSessionKeys]?: LoadOptionStorageEntry;
+        [key in UserSessionKey]?: LoadOptionStorageEntry;
     };
 };
 type CookieOptions = {
@@ -264,10 +272,10 @@ type PreConsentOptions = {
 type LoadOptions = {
     logLevel?: LogLevel;
     integrations?: IntegrationOpts;
-    configUrl: string;
+    configUrl?: string;
     queueOptions?: QueueOpts;
     loadIntegration?: boolean;
-    sessions: SessionOpts;
+    sessions?: SessionOpts;
     secureCookie?: boolean;
     destSDKBaseURL?: string;
     pluginsSDKBaseURL?: string;
@@ -276,9 +284,9 @@ type LoadOptions = {
     destinationsQueueOptions?: DestinationsQueueOpts;
     anonymousIdOptions?: AnonymousIdOptions;
     setCookieDomain?: string;
-    sameSiteCookie: CookieSameSite;
+    sameSiteCookie?: CookieSameSite;
     lockIntegrationsVersion?: boolean;
-    polyfillIfRequired: boolean;
+    polyfillIfRequired?: boolean;
     onLoaded?: OnLoadedCallback;
     uaChTrackLevel?: UaChTrackLevel;
     residencyServer?: ResidencyServerRegion;
@@ -592,8 +600,6 @@ interface IHttpClient {
     resetAuthHeader(): void;
 }
 
-type LifecycleStatus = 'mounted' | 'browserCapabilitiesReady' | 'configured' | 'pluginsLoading' | 'pluginsReady' | 'initialized' | 'loaded' | 'destinationsLoading' | 'destinationsReady' | 'ready';
-
 type StoreId = string;
 interface IStoreConfig {
     name: string;
@@ -611,7 +617,7 @@ interface IStoreManager {
     errorHandler?: IErrorHandler;
     logger?: ILogger;
     init(): void;
-    initClientDataStores(): void;
+    initializeStorageState(): void;
     setStore(storeConfig: IStoreConfig): IStore;
     getStore(id: StoreId): IStore | undefined;
 }
@@ -768,7 +774,7 @@ interface IUserSessionManager {
     start(sessionId?: number): void;
     end(): void;
     syncStorageDataToState(): void;
-    setAuthToken(token: string): void;
+    setAuthToken(token: Nullable<string>): void;
 }
 
 type DestinationConnectionMode = 'hybrid' | 'cloud' | 'device';
@@ -785,11 +791,20 @@ type DeviceModeDestination = {
     isLoaded: () => boolean;
     isReady?: () => boolean;
 };
+type ConsentsConfig = {
+    consent: string;
+};
+type ConsentManagementProviderConfig = {
+    provider: ConsentManagementProvider;
+    consents: ConsentsConfig[];
+    resolutionStrategy: string | undefined;
+};
 type DestinationConfig = {
     blacklistedEvents: DestinationEvent[];
     whitelistedEvents: DestinationEvent[];
-    oneTrustCookieCategories: OneTrustCookieCategory[];
-    ketchConsentPurposes: KetchConsentPurpose[];
+    oneTrustCookieCategories?: OneTrustCookieCategory[];
+    ketchConsentPurposes?: KetchConsentPurpose[];
+    consentManagement?: ConsentManagementProviderConfig[];
     eventFilteringOption: EventFilteringOption;
     clickEventConversions?: Conversion[];
     pageLoadConversions?: Conversion[];
@@ -901,7 +916,6 @@ declare class BufferQueue<T = any> {
 interface IAnalytics {
     preloadBuffer: BufferQueue<PreloadedEventCall>;
     initialized: boolean;
-    status?: LifecycleStatus;
     httpClient: IHttpClient;
     logger: ILogger;
     errorHandler: IErrorHandler;
@@ -924,7 +938,11 @@ interface IAnalytics {
     /**
      * Load browser polyfill if required
      */
-    prepareBrowserCapabilities(): void;
+    onMounted(): void;
+    /**
+     * Prepare internal services and load configuration
+     */
+    onBrowserCapabilitiesReady(): void;
     /**
      * Enqueue in buffer the events that were triggered pre SDK initialization
      */
@@ -944,11 +962,11 @@ interface IAnalytics {
     /**
      * Initialize the storage and event queue
      */
-    init(): void;
+    onPluginsReady(): void;
     /**
      * Load plugins
      */
-    loadPlugins(): void;
+    onConfigured(): void;
     /**
      * Trigger onLoaded callback if any is provided in config & emit initialised event
      */
@@ -972,27 +990,27 @@ interface IAnalytics {
     /**
      * To register a callback for SDK ready state
      */
-    ready(callback: ApiCallback): void;
+    ready(callback: ApiCallback, isBufferedInvocation?: boolean): void;
     /**
      * To record a page view event
      */
-    page(pageOptions: PageCallOptions): void;
+    page(pageOptions: PageCallOptions, isBufferedInvocation?: boolean): void;
     /**
      * To record a user track event
      */
-    track(trackCallOptions: TrackCallOptions): void;
+    track(trackCallOptions: TrackCallOptions, isBufferedInvocation?: boolean): void;
     /**
      * To record a user identification event
      */
-    identify(identifyCallOptions: IdentifyCallOptions): void;
+    identify(identifyCallOptions: IdentifyCallOptions, isBufferedInvocation?: boolean): void;
     /**
      * To record a user alias event
      */
-    alias(aliasCallOptions: AliasCallOptions): void;
+    alias(aliasCallOptions: AliasCallOptions, isBufferedInvocation?: boolean): void;
     /**
      * To record a user group event
      */
-    group(groupCallOptions: GroupCallOptions): void;
+    group(groupCallOptions: GroupCallOptions, isBufferedInvocation?: boolean): void;
     /**
      * To get anonymousId set in the SDK
      */
@@ -1000,11 +1018,11 @@ interface IAnalytics {
     /**
      * To set anonymousId
      */
-    setAnonymousId(anonymousId?: string, rudderAmpLinkerParam?: string): void;
+    setAnonymousId(anonymousId?: string, rudderAmpLinkerParam?: string, isBufferedInvocation?: boolean): void;
     /**
      * Clear user information, optionally anonymousId as well
      */
-    reset(resetAnonymousId?: boolean): void;
+    reset(resetAnonymousId?: boolean, isBufferedInvocation?: boolean): void;
     /**
      * To get userId set in the SDK
      */
@@ -1024,11 +1042,11 @@ interface IAnalytics {
     /**
      * To manually start user session in the SDK
      */
-    startSession(sessionId?: number): void;
+    startSession(sessionId?: number, isBufferedInvocation?: boolean): void;
     /**
      * To manually end user session in the SDK
      */
-    endSession(): void;
+    endSession(isBufferedInvocation?: boolean): void;
     /**
      * To fetch the current sessionId
      */
@@ -1037,7 +1055,7 @@ interface IAnalytics {
      * To record consent
      * @param options Consent API options
      */
-    consent(options?: ConsentOptions): void;
+    consent(options?: ConsentOptions, isBufferedInvocation?: boolean): void;
     /**
      * To set auth token
      */
@@ -1065,11 +1083,8 @@ declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
      */
     load(writeKey: string, dataPlaneUrl: string, loadOptions?: Partial<LoadOptions>): void;
     /**
-     * Get preloaded events in buffer queue if exists
-     */
-    getPreloadBuffer(): void;
-    /**
-     * Trigger load event in buffer queue if exists
+     * Trigger load event in buffer queue if exists and stores the
+     * remaining preloaded events array in global object
      */
     triggerBufferedLoadEvent(): void;
     /**
@@ -1134,6 +1149,8 @@ type ScreenInfo = {
 
 type BufferedEvent = any[];
 
+type LifecycleStatus = 'mounted' | 'browserCapabilitiesReady' | 'configured' | 'pluginsLoading' | 'pluginsReady' | 'initialized' | 'loaded' | 'destinationsLoading' | 'destinationsReady' | 'ready';
+
 type SessionInfo = {
     autoTrack?: boolean;
     manualTrack?: boolean;
@@ -1164,6 +1181,9 @@ type ConsentsState = {
     activeConsentManagerPluginName: Signal<PluginName | undefined>;
     preConsent: Signal<PreConsentOptions>;
     postConsent: Signal<ConsentOptions>;
+    resolutionStrategy: Signal<ConsentResolutionStrategy | undefined>;
+    provider: Signal<ConsentManagementProvider | undefined>;
+    metadata: Signal<ConsentManagementMetadata | undefined>;
 };
 type ContextState = {
     app: Signal<AppInfo>;
@@ -1243,7 +1263,7 @@ type StorageEntry = {
     key: string;
 };
 type StorageEntries = {
-    [key in UserSessionKeys]?: StorageEntry;
+    [key in UserSessionKey]?: StorageEntry;
 };
 type StorageState = {
     encryptionPluginName: Signal<PluginName | undefined>;