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

package/CHANGELOG.md

@@ -2,6 +2,41 @@
 
 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)
+
+
+### Features
+
+* alter life cycle for pre consent ([#1411](https://github.com/rudderlabs/rudder-sdk-js/issues/1411)) ([60ec092](https://github.com/rudderlabs/rudder-sdk-js/commit/60ec0924a1229678fb16d76a34a494c40a622a11))
+* auto capture timezone as a part of context ([#1464](https://github.com/rudderlabs/rudder-sdk-js/issues/1464)) ([8e66069](https://github.com/rudderlabs/rudder-sdk-js/commit/8e660693d75727d2131a57ca57859e6d0b920e84))
+* configure cookie to be fetched from exact domain ([#1468](https://github.com/rudderlabs/rudder-sdk-js/issues/1468)) ([4db1b10](https://github.com/rudderlabs/rudder-sdk-js/commit/4db1b10b45b4ffcd652aec6bd684943ca35c6c08))
+* consent api ([#1458](https://github.com/rudderlabs/rudder-sdk-js/issues/1458)) ([216b405](https://github.com/rudderlabs/rudder-sdk-js/commit/216b405f7c319d5ff2d799d2e3a5efe2ee4a03af))
+
+
+### Bug Fixes
+
+* **analytics-js:** correct declared global extended type ([#1460](https://github.com/rudderlabs/rudder-sdk-js/issues/1460)) ([3f15290](https://github.com/rudderlabs/rudder-sdk-js/commit/3f1529037ba0541391b5f8033e37f867fdd7931c))
+* **analytics-js:** fix remote import error when npm package is bundled with webpack ([#1466](https://github.com/rudderlabs/rudder-sdk-js/issues/1466)) ([3a818ac](https://github.com/rudderlabs/rudder-sdk-js/commit/3a818accd24e6b3667c75a6b60fb12aba36bdf7e))
+* **monorepo:** update vulnerable dependencies ([#1457](https://github.com/rudderlabs/rudder-sdk-js/issues/1457)) ([7a4bc4c](https://github.com/rudderlabs/rudder-sdk-js/commit/7a4bc4cc641e4fff2a8f561ce6fd67d16c0cd5a0))
+* upgrade vulnerable cryptoJS dependency, rolup to v4 & NX to v17 ([#1471](https://github.com/rudderlabs/rudder-sdk-js/issues/1471)) ([b2bb21c](https://github.com/rudderlabs/rudder-sdk-js/commit/b2bb21cb3f618f6c86f593d1706abe9e6349066d))
+
 ## [3.0.0-beta.13](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/analytics-js@3.0.0-beta.12...@rudderstack/analytics-js@3.0.0-beta.13) (2023-10-16)
 
 

package/dist/npm/index.d.ts

@@ -139,26 +139,36 @@ interface IPluginsManager {
     invokeSingle<T = any>(extPoint?: string, ...args: any[]): Nullable<T>;
     register(plugins: ExtensionPlugin[]): void;
 }
-type PluginName = 'BeaconQueue' | 'Bugsnag' | 'DeviceModeDestinations' | 'DeviceModeTransformation' | 'ErrorReporting' | 'ExternalAnonymousId' | 'GoogleLinker' | 'KetchConsentManager' | 'NativeDestinationQueue' | 'OneTrustConsentManager' | 'StorageEncryption' | 'StorageEncryptionLegacy' | 'StorageMigrator' | 'XhrQueue';
+type PluginName = 'BeaconQueue' | 'Bugsnag' | 'CustomConsentManager' | 'DeviceModeDestinations' | 'DeviceModeTransformation' | 'ErrorReporting' | 'ExternalAnonymousId' | 'GoogleLinker' | 'KetchConsentManager' | 'NativeDestinationQueue' | 'OneTrustConsentManager' | 'StorageEncryption' | 'StorageEncryptionLegacy' | 'StorageMigrator' | 'XhrQueue';
 
 type OneTrustCookieCategory = {
     oneTrustCookieCategory: string;
 };
-type CookieConsentOptions = {
-    [key: string]: {
-        enabled: boolean;
-    };
+type ConsentManagementMetadata = {
+    providers: ConsentManagementProviderMetadata[];
 };
-type ConsentInfo = {
-    initialized: boolean;
-    allowedConsents?: Record<string, string> | string[];
-    deniedConsentIds?: string[];
+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: ConsentManagementProvider;
+    allowedConsentIds?: Consents;
+    deniedConsentIds?: Consents;
+};
+type ConsentsInfo = {
+    allowedConsentIds?: Consents;
+    deniedConsentIds?: Consents;
 };
 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';
@@ -174,7 +184,7 @@ type StorageOpts = {
     type?: StorageType;
     cookie?: CookieOptions;
     entries?: {
-        [key in UserSessionKeys]?: LoadOptionStorageEntry;
+        [key in UserSessionKey]?: LoadOptionStorageEntry;
     };
 };
 type CookieOptions = {
@@ -255,7 +265,6 @@ type PreConsentOptions = {
     enabled: boolean;
     storage?: PreConsentStorageOptions;
     events?: PreConsentEventsOptions;
-    trackConsent?: boolean;
 };
 /**
  * Represents the options parameter in the load API
@@ -263,22 +272,21 @@ 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;
     useBeacon?: boolean;
     beaconQueueOptions?: BeaconQueueOpts;
     destinationsQueueOptions?: DestinationsQueueOpts;
-    cookieConsentManager?: CookieConsentOptions;
     anonymousIdOptions?: AnonymousIdOptions;
     setCookieDomain?: string;
-    sameSiteCookie: CookieSameSite;
+    sameSiteCookie?: CookieSameSite;
     lockIntegrationsVersion?: boolean;
-    polyfillIfRequired: boolean;
+    polyfillIfRequired?: boolean;
     onLoaded?: OnLoadedCallback;
     uaChTrackLevel?: UaChTrackLevel;
     residencyServer?: ResidencyServerRegion;
@@ -293,6 +301,16 @@ type LoadOptions = {
     storage?: StorageOpts;
     preConsent?: PreConsentOptions;
     transportMode?: EventsTransportMode;
+    consentManagement?: ConsentManagementOptions;
+    sameDomainCookiesOnly?: boolean;
+};
+type ConsentOptions = {
+    storage?: StorageOpts;
+    consentManagement?: ConsentManagementOptions;
+    integrations?: IntegrationOpts;
+    discardPreConsentEvents?: boolean;
+    sendPageEvent?: boolean;
+    trackConsent?: boolean;
 };
 
 type Address = {
@@ -500,10 +518,20 @@ interface IRudderAnalytics<T = any> {
      * To manually end user session in the SDK
      */
     endSession(): void;
+    /**
+     * To set authorization token
+     * @param token token value
+     */
+    setAuthToken(token: string): void;
     /**
      * To fetch the current sessionId
      */
     getSessionId(): Nullable<number>;
+    /**
+     * To provide consent
+     * @param options Consent API options
+     */
+    consent(options?: ConsentOptions): void;
 }
 
 interface IExternalSourceLoadConfig {
@@ -572,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;
@@ -591,7 +617,7 @@ interface IStoreManager {
     errorHandler?: IErrorHandler;
     logger?: ILogger;
     init(): void;
-    initClientDataStore(): void;
+    initializeStorageState(): void;
     setStore(storeConfig: IStoreConfig): IStore;
     getStore(id: StoreId): IStore | undefined;
 }
@@ -628,6 +654,7 @@ interface ICookieStorageOptions extends CookieOptions {
     domain?: string;
     secure?: boolean;
     enabled?: boolean;
+    sameDomainCookiesOnly?: boolean;
 }
 interface ILocalStorageOptions {
     enabled?: boolean;
@@ -746,7 +773,8 @@ interface IUserSessionManager {
     reset(resetAnonymousId?: boolean, noNewSessionStart?: boolean): void;
     start(sessionId?: number): void;
     end(): void;
-    setAuthToken(token: string): void;
+    syncStorageDataToState(): void;
+    setAuthToken(token: Nullable<string>): void;
 }
 
 type DestinationConnectionMode = 'hybrid' | 'cloud' | 'device';
@@ -763,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[];
@@ -843,6 +880,7 @@ interface IConfigManager {
 interface IEventManager {
     init(): void;
     addEvent(event: APIEvent): void;
+    resume(): void;
 }
 
 interface ICapabilitiesManager {
@@ -857,6 +895,9 @@ interface ICapabilitiesManager {
 }
 
 type PreloadedEventCall = Array<string | any>;
+type RudderAnalyticsPreloader = {
+    [index: string]: (...args: number[]) => any;
+};
 
 /**
  * A buffer queue to serve as a store for any type of data
@@ -875,7 +916,6 @@ declare class BufferQueue<T = any> {
 interface IAnalytics {
     preloadBuffer: BufferQueue<PreloadedEventCall>;
     initialized: boolean;
-    status?: LifecycleStatus;
     httpClient: IHttpClient;
     logger: ILogger;
     errorHandler: IErrorHandler;
@@ -898,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
      */
@@ -918,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
      */
@@ -946,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
      */
@@ -974,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
      */
@@ -998,15 +1042,20 @@ 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
      */
     getSessionId(): Nullable<number>;
+    /**
+     * To record consent
+     * @param options Consent API options
+     */
+    consent(options?: ConsentOptions, isBufferedInvocation?: boolean): void;
     /**
      * To set auth token
      */
@@ -1034,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;
     /**
@@ -1076,6 +1122,7 @@ declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
     endSession(): void;
     getSessionId(): Nullable<number>;
     setAuthToken(token: string): void;
+    consent(options?: ConsentOptions): void;
 }
 //# sourceMappingURL=RudderAnalytics.d.ts.map
 
@@ -1102,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;
@@ -1126,9 +1175,15 @@ type CapabilitiesState = {
     isAdBlocked: Signal<boolean>;
 };
 type ConsentsState = {
-    data: Signal<ConsentInfo>;
+    enabled: Signal<boolean>;
+    data: Signal<ConsentsInfo>;
+    initialized: Signal<boolean>;
     activeConsentManagerPluginName: Signal<PluginName | undefined>;
-    preConsentOptions: Signal<PreConsentOptions>;
+    preConsent: Signal<PreConsentOptions>;
+    postConsent: Signal<ConsentOptions>;
+    resolutionStrategy: Signal<ConsentResolutionStrategy | undefined>;
+    provider: Signal<ConsentManagementProvider | undefined>;
+    metadata: Signal<ConsentManagementMetadata | undefined>;
 };
 type ContextState = {
     app: Signal<AppInfo>;
@@ -1141,6 +1196,7 @@ type ContextState = {
     locale: Signal<Nullable<string>>;
     screen: Signal<ScreenInfo>;
     'ua-ch': Signal<UADataValues | undefined>;
+    timezone: Signal<string | undefined>;
 };
 type EventBufferState = {
     toBeProcessedArray: Signal<BufferedEvent[]>;
@@ -1207,7 +1263,7 @@ type StorageEntry = {
     key: string;
 };
 type StorageEntries = {
-    [key in UserSessionKeys]?: StorageEntry;
+    [key in UserSessionKey]?: StorageEntry;
 };
 type StorageState = {
     encryptionPluginName: Signal<PluginName | undefined>;
@@ -1253,7 +1309,7 @@ interface IRudderStackGlobals {
 
 declare global {
     interface Window {
-        rudderanalytics: RudderAnalytics | PreloadedEventCall[];
+        rudderanalytics: RudderAnalytics | PreloadedEventCall[] | RudderAnalyticsPreloader;
         RudderStackGlobals: IRudderStackGlobals;
         rudderAnalyticsMount: () => void;
         rudderAnalyticsBuildType: 'legacy' | 'modern';
@@ -1261,4 +1317,4 @@ declare global {
 }
 //# sourceMappingURL=index.d.ts.map
 
-export { type AnonymousIdOptions, type ApiCallback, type ApiObject, type ApiOptions, type BeaconQueueOpts, type CookieSameSite, type DestinationsQueueOpts, type IRudderStackGlobals, type IntegrationOpts, type LoadOptions, type LogLevel, type PluginName, type PreloadedEventCall, type QueueOpts, type ResidencyServerRegion, RudderAnalytics, type SessionOpts, type UaChTrackLevel };
+export { type AnonymousIdOptions, type ApiCallback, type ApiObject, type ApiOptions, type BeaconQueueOpts, type ConsentOptions, type CookieSameSite, type DestinationsQueueOpts, type IRudderStackGlobals, type IdentifyTraits, type IntegrationOpts, type LoadOptions, type LogLevel, type PluginName, type PreloadedEventCall, type QueueOpts, type ResidencyServerRegion, RudderAnalytics, type RudderAnalyticsPreloader, type SessionOpts, type UaChTrackLevel };