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

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [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)
+
+
+### Features
+
+* add support for session storage ([#1440](https://github.com/rudderlabs/rudder-sdk-js/issues/1440)) ([7e3106b](https://github.com/rudderlabs/rudder-sdk-js/commit/7e3106b5317af05ad28a9c0c22a50638dbaebdc2))
+* **analytics-js-service-worker:** deprecate service worker export of rudder-sdk-js package  in favor of the new standalone package([#1437](https://github.com/rudderlabs/rudder-sdk-js/issues/1437)) ([1797d3e](https://github.com/rudderlabs/rudder-sdk-js/commit/1797d3ef356e947a528c2de9abcfde245cc28178))
+* dmt plugin for v3 ([#1412](https://github.com/rudderlabs/rudder-sdk-js/issues/1412)) ([97ee68a](https://github.com/rudderlabs/rudder-sdk-js/commit/97ee68a27daa5ce8c3a098cdc84c4ee7981f1149))
+
+
+### Bug Fixes
+
+* **analytics-js-loading-scripts:** add globalThis polyfill for safari ([#1446](https://github.com/rudderlabs/rudder-sdk-js/issues/1446)) ([bf111f8](https://github.com/rudderlabs/rudder-sdk-js/commit/bf111f8fc24fe75d183ea4924423e3c560ce457d))
+* **analytics-js:** add global definitions extended window type ([#1445](https://github.com/rudderlabs/rudder-sdk-js/issues/1445)) ([b995635](https://github.com/rudderlabs/rudder-sdk-js/commit/b995635a7a3979173d35b34fa32b41b4429b166f))
+* empty anonymous id after reset call ([#1433](https://github.com/rudderlabs/rudder-sdk-js/issues/1433)) ([b078347](https://github.com/rudderlabs/rudder-sdk-js/commit/b0783478917a75833f6e7133f10ad5f8999866de))
+* identify traits type ([#1427](https://github.com/rudderlabs/rudder-sdk-js/issues/1427)) ([a58c919](https://github.com/rudderlabs/rudder-sdk-js/commit/a58c919ca36fc4e14d134455a08fe0e35f3e66ce))
+* pass anonymous id load option to getanonymousid method ([#1443](https://github.com/rudderlabs/rudder-sdk-js/issues/1443)) ([e234a8f](https://github.com/rudderlabs/rudder-sdk-js/commit/e234a8fa7538ac84fbf451aa4b104c1b26b5a04e))
+
 ## [3.0.0-beta.12](https://github.com/rudderlabs/rudder-sdk-js/compare/@rudderstack/analytics-js@3.0.0-beta.11...@rudderstack/analytics-js@3.0.0-beta.12) (2023-10-02)
 
 

package/README.md

@@ -2,7 +2,7 @@
 
 <p align="center">
   <a href="https://rudderstack.com/">
-    <img src="https://user-images.githubusercontent.com/59817155/121357083-1c571300-c94f-11eb-8cc7-ce6df13855c9.png">
+    <img alt="RudderStack" width="512" src="https://raw.githubusercontent.com/rudderlabs/rudder-sdk-js/develop/assets/rs-logo-full-light.jpg">
   </a>
   <br />
   <caption>The Customer Data Platform for Developers</caption>
@@ -19,7 +19,7 @@
 
 ---
 
-# [](https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-js/README.md#@rudderstack-analytics-js)@rudderstack/analytics-js
+# @rudderstack/analytics-js
 
 RudderStack Javascript SDK for browsers.
 
@@ -27,9 +27,12 @@ RudderStack Javascript SDK for browsers.
 
 ## Table of Contents
 
-- [**Installing the package**](https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-js/README.md#installing-the-package)
+- [**Installing the package**](#installing-the-package)
+- [**How to build the SDK**](#How-to-build-the-SDK)
+- [**Usage in Chrome Extensions**](#usage-in-chrome-extensions)
+- [**Usage in Serverless Runtimes**](#usage-in-serverless-runtimes)
 
-## [](https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-js/README.md#installing-the-package)Installing the package
+## Installing the package
 
 To install the package via npm, run the following command:
 
@@ -39,15 +42,59 @@ npm install @rudderstack/analytics-js --save
 
 **Note that this NPM module is only meant to be used for a browser installation**. If you want to integrate RudderStack with your Node.js application, refer to the [**RudderStack Node.js repository**](https://github.com/rudderlabs/rudder-sdk-node).
 
+### Available exports
+
+Default export will fetch the plugins during runtime as federated modules in separate requests.
+
+```javascript
+import { RudderAnalytics } from '@rudderstack/analytics-js';
+
+const analytics = new RudderAnalytics();
+analytics.load(<WRITE_KEY>, <DATA_PLANE_URL>);
+window.rudderanalytics = analytics;
+```
+
+Bundled export will contain the plugins code as part of the bundle in build time.
+
+```javascript
+import { RudderAnalytics } from '@rudderstack/analytics-js/bundled';
+
+const analytics = new RudderAnalytics();
+analytics.load(<WRITE_KEY>, <DATA_PLANE_URL>);
+window.rudderanalytics = analytics;
+```
+
+Legacy export will contain the plugins code as part of the bundle in build time and support legacy browsers like IE11.
+
+```javascript
+import { RudderAnalytics } from '@rudderstack/analytics-js/legacy';
+
+const analytics = new RudderAnalytics();
+analytics.load(<WRITE_KEY>, <DATA_PLANE_URL>);
+window.rudderanalytics = analytics;
+```
+
+## How to build the SDK
+
+Look for run scripts in the `package.json` file for getting the browser minified and non-minified builds. The builds are
+updated in the `dist` folder of the directory. Among the others, some of the important ones are:
+
+- `npm run build:browser:modern`: This outputs **dist/cdn/modern** folder that contains the cdn package contents.
+- `npm run build:npm`: This outputs **dist/npm** folder that contains the npm package contents.
+
 ## Usage in Chrome Extensions
 
-RudderStack JS SDK can be used for browsers.
+RudderStack JS SDK can be used in Chrome Extensions with manifest v3, both as a content script (via the JavaScript SDK package)
+or as a background script service worker (via the [service worker package](https://www.npmjs.com/package/@rudderstack/analytics-js-service-worker)).
+
+For examples and specific details look into [Chrome Extensions Usage](https://github.com/rudderlabs/rudder-sdk-js/blob/main/examples/chrome-extension/USAGE.md)
 
-For examples and specific details look into [examples folder](https://github.com/rudderlabs/rudder-sdk-js/blob/main/examples)
+## Usage in Serverless Runtimes
 
-## [](https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-js/README.md#how-to-build-the-sdk)How to build the SDK
+RudderStack JS SDK [service worker](https://www.npmjs.com/package/@rudderstack/analytics-js-service-worker) can be used
+in serverless runtimes like Cloudflare Workers or Vercel Edge functions.
 
-- Look for run scripts in the `package.json` file for getting the browser minified and non-minified builds. The builds are updated in the `dist` folder of the directory. Among the others, some of the important ones are:
+For examples and specific details look into:
 
-  - `npm run build:browser:modern`: This outputs **dist/cdn** folder that contains the cdn package contents.
-  - `npm run build:npm`: This outputs **dist/npm** folder that contains the npm package contents.
+- [Vercel Edge Usage](https://github.com/rudderlabs/rudder-sdk-js/blob/main/examples/serverless/USAGE.md)
+- [Cloudflare Worker Usage](https://github.com/rudderlabs/rudder-sdk-js/blob/main/examples/serverless/USAGE.md)

package/dist/npm/index.d.ts

@@ -16,58 +16,31 @@ interface ILogger {
 }
 type LogLevel = 'LOG' | 'INFO' | 'DEBUG' | 'WARN' | 'ERROR' | 'NONE';
 
-type RegionDetails = {
-    url: string;
-    default: boolean;
-};
-/**
- * Represents residency server input the options
- */
-type ResidencyServerRegion = 'US' | 'EU';
-
-type Nullable<T> = T | null;
+type LoggerProvider = Record<Exclude<Lowercase<LogLevel>, Lowercase<'NONE'>>, (...data: any[]) => void>;
 
-interface ExtensionPoint {
-    [lifeCycleName: string]: (...args: any[]) => unknown;
-}
 /**
- * ExtensionPoint can be nested, e.g. 'sdk.initialize.phase1'
- * When index signature is provided, every key have to match the type, the types
- * for 'name', 'deps',  and 'initialize' is added as index signature.
+ * Service to log messages/data to output provider, default is console
  */
-interface ExtensionPlugin {
-    name: string;
-    initialize?: (state?: any) => void;
-    deps?: string[];
-    [key: string]: string | (() => void) | ExtensionPoint | ((...args: any[]) => unknown | void) | string[] | undefined;
-}
-type PluginEngineConfig = {
-    throws?: boolean | RegExp;
-};
-interface IPluginEngine {
-    plugins: ExtensionPlugin[];
-    byName: Record<string, ExtensionPlugin>;
-    cache: Record<string, ExtensionPlugin[]>;
-    config: PluginEngineConfig;
-    register: (plugin: ExtensionPlugin, state?: Record<string, any>) => void;
-    unregister: (name: string) => void;
-    getPlugin: (name: string) => ExtensionPlugin | undefined;
-    getPlugins: (extPoint?: string) => ExtensionPlugin[];
-    invoke: <T = any>(extPoint?: string, allowMultiple?: boolean, ...args: any[]) => Nullable<T>[];
-    invokeSingle: <T = any>(extPoint?: string, ...args: any[]) => Nullable<T>;
-    invokeMultiple: <T = any>(extPoint?: string, ...args: any[]) => Nullable<T>[];
-}
+declare class Logger implements ILogger {
+    minLogLevel: number;
+    scope?: string;
+    logProvider: LoggerProvider;
+    constructor(minLogLevel?: LogLevel, scope?: string, logProvider?: Console);
+    log(...data: any[]): void;
+    info(...data: any[]): void;
+    debug(...data: any[]): void;
+    warn(...data: any[]): void;
+    error(...data: any[]): void;
+    outputLog(logMethod: LogLevel, data: any[]): void;
+    setScope(scopeVal: string): void;
+    setMinLogLevel(logLevel: LogLevel): void;
+    /**
+     * Formats the console message using `scope` and styles
+     */
+    formatLogData(data: any[]): any[];
+}//# sourceMappingURL=Logger.d.ts.map
 
-interface IPluginsManager {
-    engine: IPluginEngine;
-    init(): void;
-    attachEffects(): void;
-    setActivePlugins(): void;
-    invokeMultiple<T = any>(extPoint?: string, ...args: any[]): Nullable<T>[];
-    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 Nullable<T> = T | null;
 
 /**
  * Represents a generic object in the APIs
@@ -117,6 +90,57 @@ type APIEvent = {
 type RudderEventType = 'page' | 'track' | 'identify' | 'alias' | 'group';
 type ReadyCallback = () => void;
 
+type RegionDetails = {
+    url: string;
+    default: boolean;
+};
+/**
+ * Represents residency server input the options
+ */
+type ResidencyServerRegion = 'US' | 'EU';
+
+interface ExtensionPoint {
+    [lifeCycleName: string]: (...args: any[]) => unknown;
+}
+/**
+ * ExtensionPoint can be nested, e.g. 'sdk.initialize.phase1'
+ * When index signature is provided, every key have to match the type, the types
+ * for 'name', 'deps',  and 'initialize' is added as index signature.
+ */
+interface ExtensionPlugin {
+    name: string;
+    initialize?: (state?: any) => void;
+    deps?: string[];
+    [key: string]: string | (() => void) | ExtensionPoint | ((...args: any[]) => unknown | void) | string[] | undefined;
+}
+type PluginEngineConfig = {
+    throws?: boolean | RegExp;
+};
+interface IPluginEngine {
+    plugins: ExtensionPlugin[];
+    byName: Record<string, ExtensionPlugin>;
+    cache: Record<string, ExtensionPlugin[]>;
+    config: PluginEngineConfig;
+    register: (plugin: ExtensionPlugin, state?: Record<string, any>) => void;
+    unregister: (name: string) => void;
+    getPlugin: (name: string) => ExtensionPlugin | undefined;
+    getPlugins: (extPoint?: string) => ExtensionPlugin[];
+    invoke: <T = any>(extPoint?: string, allowMultiple?: boolean, ...args: any[]) => Nullable<T>[];
+    invokeSingle: <T = any>(extPoint?: string, ...args: any[]) => Nullable<T>;
+    invokeMultiple: <T = any>(extPoint?: string, ...args: any[]) => Nullable<T>[];
+}
+
+interface IPluginsManager {
+    engine: IPluginEngine;
+    init(): void;
+    attachEffects(): void;
+    setActivePlugins(): void;
+    invokeMultiple<T = any>(extPoint?: string, ...args: any[]): Nullable<T>[];
+    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 OneTrustCookieCategory = {
     oneTrustCookieCategory: string;
 };
@@ -134,7 +158,7 @@ type KetchConsentPurpose = {
     purpose: string;
 };
 
-type UserSessionKeys = 'userId' | 'userTraits' | 'anonymousId' | 'groupId' | 'groupTraits' | 'initialReferrer' | 'initialReferringDomain' | 'sessionInfo';
+type UserSessionKeys = 'userId' | 'userTraits' | 'anonymousId' | 'groupId' | 'groupTraits' | 'initialReferrer' | 'initialReferringDomain' | 'sessionInfo' | 'authToken';
 
 type StorageEncryptionVersion = 'legacy' | 'v3';
 type StorageType = 'cookieStorage' | 'localStorage' | 'memoryStorage' | 'sessionStorage' | 'none';
@@ -271,36 +295,93 @@ type LoadOptions = {
     transportMode?: EventsTransportMode;
 };
 
-type LoggerProvider = Record<Exclude<Lowercase<LogLevel>, Lowercase<'NONE'>>, (...data: any[]) => void>;
-
+type Address = {
+    city?: string;
+    City?: string;
+    country?: string;
+    Country?: string;
+    postalCode?: string;
+    state?: string;
+    State?: string;
+    street?: string;
+};
+type Company = {
+    name?: string;
+    id?: string;
+    industry?: string;
+    employee_count?: string;
+    plan?: string;
+};
 /**
- * Service to log messages/data to output provider, default is console
+ * Represents a traits object in the Identify API
  */
-declare class Logger implements ILogger {
-    minLogLevel: number;
-    scope?: string;
-    logProvider: LoggerProvider;
-    constructor(minLogLevel?: LogLevel, scope?: string, logProvider?: Console);
-    log(...data: any[]): void;
-    info(...data: any[]): void;
-    debug(...data: any[]): void;
-    warn(...data: any[]): void;
-    error(...data: any[]): void;
-    outputLog(logMethod: LogLevel, data: any[]): void;
-    setScope(scopeVal: string): void;
-    setMinLogLevel(logLevel: LogLevel): void;
-    /**
-     * Formats the console message using `scope` and styles
-     */
-    formatLogData(data: any[]): any[];
-}//# sourceMappingURL=Logger.d.ts.map
+type IdentifyTraits = {
+    id?: string;
+    userId?: string;
+    firstName?: string;
+    firstname?: string;
+    first_name?: string;
+    lastName?: string;
+    lastname?: string;
+    last_name?: string;
+    name?: string;
+    Name?: string;
+    age?: number;
+    email?: string;
+    Email?: string;
+    'E-mail'?: string;
+    phone?: string;
+    address?: string | Address;
+    birthday?: string;
+    company?: Company;
+    createdAt?: string;
+    description?: string;
+    gender?: string;
+    title?: string;
+    username?: string;
+    website?: string;
+    avatar?: string;
+    zip?: string | number;
+    state?: string;
+    State?: string;
+    dob?: string;
+    employed?: string | boolean;
+    education?: string;
+    married?: string | boolean;
+    customerType?: string | number;
+    euConsent?: string;
+    euConsentMessage?: string;
+    newEmail?: string;
+    tags?: string | string[];
+    removeTags?: string | string[];
+    prospect?: string | boolean;
+    doubleOptin?: string | boolean;
+    event_id?: string;
+    constructor?: Record<string, string>;
+    organization?: string;
+    region?: string;
+    anonymous?: string | boolean;
+    country?: string;
+    custom?: string;
+    ip?: string;
+    privateAttributeNames?: any;
+    secondary?: any;
+    customPageId?: string;
+    isRudderEvents?: boolean;
+    optOutType?: boolean | string | number;
+    groupType?: string | number;
+    anonymousId?: string | number;
+    ip_address?: string;
+    number?: string | number;
+    [index: string]: string | number | boolean | ApiObject | null | (string | number | boolean | null | ApiObject)[] | undefined;
+};
 
 type AnalyticsIdentifyMethod = {
-    (userId?: string, traits?: Nullable<ApiObject>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
-    (userId: string, traits: Nullable<ApiObject>, callback: ApiCallback): void;
+    (userId?: string, traits?: Nullable<IdentifyTraits>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    (userId: string, traits: Nullable<IdentifyTraits>, callback: ApiCallback): void;
     (userId: string, callback: ApiCallback): void;
-    (traits: Nullable<ApiObject>, options: Nullable<ApiOptions>, callback?: ApiCallback): void;
-    (traits: Nullable<ApiObject>, callback?: ApiCallback): void;
+    (traits: Nullable<IdentifyTraits>, options: Nullable<ApiOptions>, callback?: ApiCallback): void;
+    (traits: Nullable<IdentifyTraits>, callback?: ApiCallback): void;
 };
 type AnalyticsPageMethod = {
     (category?: string, name?: string, properties?: Nullable<ApiObject>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
@@ -570,7 +651,7 @@ type TrackCallOptions = {
 };
 type IdentifyCallOptions = {
     userId?: string | null;
-    traits?: Nullable<ApiObject>;
+    traits?: Nullable<IdentifyTraits>;
     options?: Nullable<ApiOptions>;
     callback?: ApiCallback;
 };
@@ -665,6 +746,7 @@ interface IUserSessionManager {
     reset(resetAnonymousId?: boolean, noNewSessionStart?: boolean): void;
     start(sessionId?: number): void;
     end(): void;
+    setAuthToken(token: string): void;
 }
 
 type DestinationConnectionMode = 'hybrid' | 'cloud' | 'device';
@@ -925,6 +1007,10 @@ interface IAnalytics {
      * To fetch the current sessionId
      */
     getSessionId(): Nullable<number>;
+    /**
+     * To set auth token
+     */
+    setAuthToken(token: string): void;
 }
 
 declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
@@ -970,7 +1056,7 @@ declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
     /**
      * Process identify arguments and forward to page call
      */
-    identify(userId?: string | number | Nullable<ApiObject>, traits?: Nullable<ApiObject> | ApiCallback, options?: Nullable<ApiOptions> | ApiCallback, callback?: ApiCallback): void;
+    identify(userId?: string | number | Nullable<IdentifyTraits>, traits?: Nullable<IdentifyTraits> | Nullable<ApiOptions> | ApiCallback, options?: Nullable<ApiOptions> | ApiCallback, callback?: ApiCallback): void;
     /**
      * Process alias arguments and forward to page call
      */
@@ -989,6 +1075,7 @@ declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
     startSession(sessionId?: number): void;
     endSession(): void;
     getSessionId(): Nullable<number>;
+    setAuthToken(token: string): void;
 }
 //# sourceMappingURL=RudderAnalytics.d.ts.map
 
@@ -1112,6 +1199,7 @@ type SessionState = {
     readonly initialReferrer: Signal<string | undefined>;
     readonly initialReferringDomain: Signal<string | undefined>;
     readonly sessionInfo: Signal<SessionInfo>;
+    readonly authToken: Signal<Nullable<string>>;
 };
 type SourceConfigState = Signal<Source | undefined>;
 type StorageEntry = {
@@ -1163,4 +1251,14 @@ interface IRudderStackGlobals {
     [key: string]: ExposedGlobals;
 }
 
+declare global {
+    interface Window {
+        rudderanalytics: RudderAnalytics | PreloadedEventCall[];
+        RudderStackGlobals: IRudderStackGlobals;
+        rudderAnalyticsMount: () => void;
+        rudderAnalyticsBuildType: 'legacy' | 'modern';
+    }
+}
+//# 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 };