@rudderstack/analytics-js 3.0.0-beta.6 → 3.0.0-beta.8

package/package.json

@@ -1,26 +1,31 @@
 {
   "name": "@rudderstack/analytics-js",
-  "version": "3.0.0-beta.6",
+  "version": "3.0.0-beta.8",
   "description": "RudderStack Javascript SDK",
-  "main": "modern/cjs/index.js",
-  "module": "modern/esm/index.js",
+  "main": "dist/npm/modern/cjs/index.js",
+  "module": "dist/npm/modern/esm/index.js",
   "exports": {
     ".": {
-      "types": "./index.d.ts",
-      "require": "./modern/cjs/index.js",
-      "import": "./modern/esm/index.js"
+      "types": "./dist/npm/index.d.ts",
+      "require": "./dist/npm/modern/cjs/index.js",
+      "import": "./dist/npm/modern/esm/index.js"
     },
     "./legacy": {
-      "types": "./index.d.ts",
-      "require": "./legacy/cjs/index.js",
-      "import": "./legacy/esm/index.js"
+      "types": "./dist/npm/index.d.ts",
+      "require": "./dist/npm/legacy/cjs/index.js",
+      "import": "./dist/npm/legacy/esm/index.js"
     }
   },
-  "types": "./index.d.ts",
+  "types": "./dist/npm/index.d.ts",
   "publishConfig": {
-    "directory": "dist/npm",
     "access": "public"
   },
+  "files": [
+    "dist/npm",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
   "keywords": [
     "analytics",
     "rudder"
@@ -37,8 +42,9 @@
   },
   "homepage": "https://github.com/rudderlabs/rudder-sdk-js/blob/main/packages/analytics-js/README.md",
   "scripts": {
-    "clean": "rimraf -rf ./dist && rimraf -rf ./node_modules/.cache && rimraf tsconfig.tsbuildinfo && rimraf -rf ./reports",
+    "clean": "rimraf -rf ./dist && rimraf -rf ./node_modules/.cache && rimraf -rf ./reports",
     "start": "rollup -c --watch --environment DEV_SERVER,PROD_DEBUG",
+    "start:modern": "BROWSERSLIST_ENV=modern npm run start",
     "build": "npm run build:browser && npm run build:package",
     "build:browser:modern": "BROWSERSLIST_ENV=modern npm run build:browser",
     "build:browser": "rollup -c --environment VERSION:$npm_package_version,UGLIFY,PROD_DEBUG,ENV:prod",
@@ -46,11 +52,11 @@
     "build:npm:modern": "BROWSERSLIST_ENV=modern npm run build:npm",
     "build:package": "npm run build:npm:modern && npm run build:npm",
     "build:browser:test": "ONLY_IIFE=true npm run build:browser && sed 's/var rudderanalytics/rudderanalytics/g' dist/cdn/legacy/iife/rsa.min.js > __mocks__/cdnSDKv3.js",
-    "test": "npm run build:browser:test && jest --watchAll=false --detectOpenHandles --forceExit --maxWorkers=50% --coverage",
-    "test:ci": "npm run build:browser:test && jest --watchAll=false --detectOpenHandles --forceExit --maxWorkers=2 --coverage",
+    "test": "npm run build:browser:test && nx test --maxWorkers=50%",
+    "test:ci": "npm run build:browser:test && nx test --parallel=false --configuration=ci --runInBand --maxWorkers=1 --forceExit",
     "check:lint:dev": "eslint --ext .js,.ts src",
     "check:lint": "eslint --ext .js,.ts src -f json -o reports/eslint.json || exit 0",
-    "check:size:build": "npm run clean && npm run build:browser && npm run build:browser:modern && npm run build:package",
+    "check:size:build": "npm run build:browser && npm run build:browser:modern && npm run build:package",
     "check:size": "npm run check:size:build && size-limit",
     "check:size:json": "size-limit --json",
     "check:circular": "madge --circular --extensions js,ts src || exit 0",
@@ -58,103 +64,19 @@
     "check:support:modern": "NODE_ENV=modern npx browserslist --mobile-to-desktop",
     "check:duplicates": "jscpd src",
     "check:security": "npm audit --recursive --audit-level=high",
-    "start:modern": "BROWSERSLIST_ENV=modern npm run start",
     "build:modern": "npm run build:browser:modern && npm run build:npm:modern",
-    "prepare": "npm run build:package",
-    "package": "cd dist/npm && npm pack --pack-destination ../../",
+    "package": "npm pack",
     "release": "npm publish"
   },
-  "engines": {
-    "node": ">=v16"
-  },
   "dependencies": {
     "@lukeed/uuid": "2.0.1",
-    "@preact/signals-core": "1.3.1",
-    "@rudderstack/analytics-js-common": "3.0.0-beta.6",
-    "@rudderstack/analytics-js-plugins": "3.0.0-beta.6",
+    "@preact/signals-core": "1.4.0",
+    "@rudderstack/analytics-js-common": "3.0.0-beta.8",
+    "@rudderstack/analytics-js-plugins": "3.0.0-beta.8",
     "ramda": "0.29.0",
-    "storejs": "2.0.5"
-  },
-  "devDependencies": {
-    "@babel/core": "7.22.9",
-    "@babel/eslint-parser": "7.22.9",
-    "@babel/plugin-proposal-class-properties": "7.18.6",
-    "@babel/plugin-transform-arrow-functions": "7.22.5",
-    "@babel/plugin-transform-object-assign": "7.22.5",
-    "@babel/plugin-transform-runtime": "7.22.9",
-    "@babel/preset-env": "7.22.9",
-    "@babel/preset-typescript": "7.22.5",
-    "@commitlint/config-conventional": "17.6.7",
-    "@commitlint/config-lerna-scopes": "17.6.6",
-    "@digitalroute/cz-conventional-changelog-for-jira": "8.0.1",
-    "@originjs/vite-plugin-federation": "1.2.2",
-    "@rollup/plugin-alias": "5.0.0",
-    "@rollup/plugin-babel": "6.0.3",
-    "@rollup/plugin-commonjs": "25.0.3",
-    "@rollup/plugin-json": "6.0.0",
-    "@rollup/plugin-node-resolve": "15.1.0",
-    "@rollup/plugin-replace": "5.0.2",
-    "@rollup/plugin-terser": "0.4.3",
-    "@size-limit/file": "8.2.6",
-    "@size-limit/webpack": "8.2.6",
-    "@types/jest": "29.5.3",
-    "@types/ramda": "0.29.3",
-    "@typescript-eslint/eslint-plugin": "5.59.11",
-    "@typescript-eslint/parser": "5.59.11",
-    "assert": "2.0.0",
-    "babel-eslint": "10.1.0",
-    "babel-plugin-transform-object-hasown": "1.1.0",
-    "commitizen": "4.3.0",
-    "commitlint": "17.6.7",
-    "conventional-changelog-cli": "2.2.2",
-    "conventional-github-releaser": "3.1.5",
-    "dotenv": "16.3.1",
-    "eslint": "8.45.0",
-    "eslint-config-airbnb": "19.0.4",
-    "eslint-config-airbnb-base": "15.0.0",
-    "eslint-config-airbnb-typescript": "17.1.0",
-    "eslint-config-prettier": "8.8.0",
-    "eslint-import-resolver-typescript": "3.5.5",
-    "eslint-plugin-compat": "4.1.4",
-    "eslint-plugin-import": "2.27.5",
-    "eslint-plugin-sonarjs": "0.19.0",
-    "eslint-plugin-unicorn": "48.0.0",
-    "esm": "3.2.25",
-    "http-server": "14.1.1",
-    "husky": "8.0.3",
-    "isomorphic-fetch": "3.0.0",
-    "jest": "29.6.1",
-    "jest-date-mock": "1.0.8",
-    "jest-environment-jsdom": "29.6.1",
-    "jest-junit": "16.0.0",
-    "jest-sonar": "0.2.16",
-    "jest-watch-typeahead": "2.2.2",
-    "jscpd": "3.5.9",
-    "lint-staged": "13.2.3",
-    "madge": "6.1.0",
-    "msw": "1.2.2",
-    "patch-package": "7.0.2",
-    "prettier": "2.8.8",
-    "rollup": "3.20.2",
-    "rollup-plugin-copy": "3.4.0",
-    "rollup-plugin-delete": "2.0.0",
-    "rollup-plugin-dts": "5.3.0",
-    "rollup-plugin-exclude-dependencies-from-bundle": "1.1.23",
-    "rollup-plugin-external-globals": "0.8.0",
-    "rollup-plugin-filesize": "10.0.0",
-    "rollup-plugin-generate-html-template": "1.7.0",
-    "rollup-plugin-livereload": "2.0.5",
-    "rollup-plugin-polyfill-node": "0.12.0",
-    "rollup-plugin-serve": "2.0.2",
-    "rollup-plugin-typescript2": "0.35.0",
-    "rollup-plugin-visualizer": "5.9.2",
-    "size-limit": "8.2.6",
-    "standard-version": "9.5.0",
-    "ts-jest": "29.1.1",
-    "tslib": "2.6.0",
-    "typescript": "4.9.5"
+    "storejs": "2.0.6"
   },
-  "overrides": {},
+  "devDependencies": {},
   "browserslist": {
     "production": [
       "defaults",
@@ -174,6 +96,5 @@
       "last 1 edge version",
       "last 1 safari version"
     ]
-  },
-  "gitHead": "a0c227a8f6ac8b7421fe945e0e261dfbcaec11ec"
+  }
 }

package/index.d.ts

@@ -1,387 +0,0 @@
-import { AnonymousIdOptions, LoadOptions } from '@rudderstack/analytics-js-common/types/LoadOptions';
-export { AnonymousIdOptions, BeaconQueueOpts, CookieSameSite, DestinationsQueueOpts, LoadOptions, QueueOpts, SessionOpts, UaChTrackLevel } from '@rudderstack/analytics-js-common/types/LoadOptions';
-import { APIEvent, ApiCallback, ApiOptions } from '@rudderstack/analytics-js-common/types/EventApi';
-export { ApiCallback, ApiOptions } from '@rudderstack/analytics-js-common/types/EventApi';
-import { ApiObject } from '@rudderstack/analytics-js-common/types/ApiObject';
-export { ApiObject } from '@rudderstack/analytics-js-common/types/ApiObject';
-export { IntegrationOpts } from '@rudderstack/analytics-js-common/types/Integration';
-export { ResidencyServerRegion } from '@rudderstack/analytics-js-common/types/DataResidency';
-import { LogLevel, ILogger } from '@rudderstack/analytics-js-common/types/Logger';
-export { LogLevel } from '@rudderstack/analytics-js-common/types/Logger';
-import { IPluginsManager } from '@rudderstack/analytics-js-common/types/PluginsManager';
-export { PluginName } from '@rudderstack/analytics-js-common/types/PluginsManager';
-import { IRudderAnalytics } from '@rudderstack/analytics-js-common/types/IRudderAnalytics';
-import { Nullable } from '@rudderstack/analytics-js-common/types/Nullable';
-import { IHttpClient } from '@rudderstack/analytics-js-common/types/HttpClient';
-import { LifecycleStatus } from '@rudderstack/analytics-js-common/types/ApplicationLifecycle';
-import { IErrorHandler } from '@rudderstack/analytics-js-common/types/ErrorHandler';
-import { IExternalSrcLoader } from '@rudderstack/analytics-js-common/services/ExternalSrcLoader/types';
-import { IStore, IStorage, IStoreConfig, IStoreManager } from '@rudderstack/analytics-js-common/types/Store';
-import { PageCallOptions, TrackCallOptions, IdentifyCallOptions, AliasCallOptions, GroupCallOptions } from '@rudderstack/analytics-js-common/utilities/eventMethodOverloads';
-import { ApplicationState } from '@rudderstack/analytics-js-common/types/ApplicationState';
-
-type LoggerProvider = Record<Exclude<Lowercase<LogLevel>, Lowercase<LogLevel.None>>, (...data: any[]) => void>;
-
-/**
- * Service to log messages/data to output provider, default is console
- */
-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
-
-/**
- * Store Implementation with dedicated storage
- */
-declare class Store implements IStore {
-    id: string;
-    name: string;
-    isEncrypted: boolean;
-    validKeys: Record<string, string>;
-    engine: IStorage;
-    originalEngine: IStorage;
-    noKeyValidation?: boolean;
-    noCompoundKey?: boolean;
-    errorHandler?: IErrorHandler;
-    hasErrorHandler: boolean;
-    logger?: ILogger;
-    pluginsManager?: IPluginsManager;
-    constructor(config: IStoreConfig, engine?: IStorage, pluginsManager?: IPluginsManager);
-    /**
-     * Ensure the key is valid and with correct format
-     */
-    createValidKey(key: string): string | undefined;
-    /**
-     * Switch to inMemoryEngine, bringing any existing data with.
-     */
-    swapQueueStoreToInMemoryEngine(): void;
-    /**
-     * Set value by key.
-     */
-    set(key: string, value: any): void;
-    /**
-     * Get by Key.
-     */
-    get<T = any>(key: string): Nullable<T>;
-    /**
-     * Remove by Key.
-     */
-    remove(key: string): void;
-    /**
-     * Get original engine
-     */
-    getOriginalEngine(): IStorage;
-    /**
-     * Decrypt values
-     */
-    decrypt(value?: Nullable<string>): Nullable<string>;
-    /**
-     * Encrypt value
-     */
-    encrypt(value: Nullable<any>): string;
-    /**
-     * Extension point to use with encryption plugins
-     */
-    crypto(value: Nullable<any>, mode: 'encrypt' | 'decrypt'): string;
-    /**
-     * Handle errors
-     */
-    onError(error: unknown): void;
-}
-//# sourceMappingURL=Store.d.ts.map
-
-interface IUserSessionManager {
-    store?: IStore;
-    init(store: IStore | undefined): void;
-    setAnonymousId(anonymousId?: string, rudderAmpLinkerParam?: string): void;
-    getAnonymousId(options?: AnonymousIdOptions): string;
-    refreshSession(): void;
-    getGroupId(): Nullable<string>;
-    getUserId(): Nullable<string>;
-    setUserId(userId?: null | string): void;
-    setUserTraits(traits?: Nullable<ApiObject>): void;
-    getUserTraits(): Nullable<ApiObject>;
-    getGroupTraits(): Nullable<ApiObject>;
-    setGroupId(groupId?: Nullable<string>): void;
-    setGroupTraits(traits?: Nullable<ApiObject>): void;
-    reset(resetAnonymousId?: boolean, noNewSessionStart?: boolean): void;
-    start(sessionId?: number): void;
-    end(): void;
-    clearUserSessionStorage(resetAnonymousId?: boolean): void;
-}
-
-interface IConfigManager {
-    httpClient: IHttpClient;
-    errorHandler?: IErrorHandler;
-    logger?: ILogger;
-    init: () => void;
-    getConfig: () => void;
-    processConfig: () => void;
-}
-
-interface IEventManager {
-    init(): void;
-    addEvent(event: APIEvent): void;
-}
-
-interface ICapabilitiesManager {
-    logger?: ILogger;
-    errorHandler?: IErrorHandler;
-    externalSrcLoader?: IExternalSrcLoader;
-    init(): void;
-    detectBrowserCapabilities(): void;
-    prepareBrowserCapabilities(): void;
-    attachWindowListeners(): void;
-    onReady(): void;
-}
-
-type PreloadedEventCall = Array<string | any>;
-
-/**
- * A buffer queue to serve as a store for any type of data
- */
-declare class BufferQueue<T = any> {
-    items: T[];
-    constructor();
-    enqueue(item: T): void;
-    dequeue(): Nullable<T> | undefined;
-    isEmpty(): boolean;
-    size(): number;
-    clear(): void;
-}
-//# sourceMappingURL=BufferQueue.d.ts.map
-
-interface IAnalytics {
-    preloadBuffer: BufferQueue<PreloadedEventCall>;
-    initialized: boolean;
-    status?: LifecycleStatus;
-    httpClient: IHttpClient;
-    logger: ILogger;
-    errorHandler: IErrorHandler;
-    externalSrcLoader: IExternalSrcLoader;
-    capabilitiesManager: ICapabilitiesManager;
-    storeManager?: IStoreManager;
-    configManager?: IConfigManager;
-    eventManager?: IEventManager;
-    userSessionManager?: IUserSessionManager;
-    pluginsManager?: IPluginsManager;
-    clientDataStore?: Store;
-    /**
-     * Start application lifecycle if not already started
-     */
-    load(writeKey: string, dataPlaneUrl?: string | Partial<LoadOptions>, loadOptions?: Partial<LoadOptions>): void;
-    /**
-     * Orchestrate the lifecycle of the application phases/status
-     */
-    startLifecycle(): void;
-    /**
-     * Load browser polyfill if required
-     */
-    prepareBrowserCapabilities(): void;
-    /**
-     * Enqueue in buffer the events that were triggered pre SDK initialization
-     */
-    enqueuePreloadBufferEvents(bufferedEvents: PreloadedEventCall[]): void;
-    /**
-     * Start the process of consuming the buffered events that were triggered pre SDK initialization
-     */
-    processDataInPreloadBuffer(): void;
-    /**
-     * Assign instances for the internal services
-     */
-    prepareInternalServices(): void;
-    /**
-     * Load configuration
-     */
-    loadConfig(): void;
-    /**
-     * Initialize the storage and event queue
-     */
-    init(): void;
-    /**
-     * Load plugins
-     */
-    loadPlugins(): void;
-    /**
-     * Trigger onLoaded callback if any is provided in config & emit initialised event
-     */
-    onInitialized(): void;
-    /**
-     * Emit ready event
-     */
-    onReady(): void;
-    /**
-     * Consume preloaded events buffer
-     */
-    processBufferedEvents(): void;
-    /**
-     * Load device mode destinations
-     */
-    loadDestinations(): void;
-    /**
-     * Invoke the ready callbacks if any exist
-     */
-    onDestinationsReady(): void;
-    /**
-     * To register a callback for SDK ready state
-     */
-    ready(callback: ApiCallback): void;
-    /**
-     * To record a page view event
-     */
-    page(pageOptions: PageCallOptions): void;
-    /**
-     * To record a user track event
-     */
-    track(trackCallOptions: TrackCallOptions): void;
-    /**
-     * To record a user identification event
-     */
-    identify(identifyCallOptions: IdentifyCallOptions): void;
-    /**
-     * To record a user alias event
-     */
-    alias(aliasCallOptions: AliasCallOptions): void;
-    /**
-     * To record a user group event
-     */
-    group(groupCallOptions: GroupCallOptions): void;
-    /**
-     * To get anonymousId set in the SDK
-     */
-    getAnonymousId(options?: AnonymousIdOptions): string | undefined;
-    /**
-     * To set anonymousId
-     */
-    setAnonymousId(anonymousId?: string, rudderAmpLinkerParam?: string): void;
-    /**
-     * Clear user information, optionally anonymousId as well
-     */
-    reset(resetAnonymousId?: boolean): void;
-    /**
-     * To get userId set in the SDK
-     */
-    getUserId(): Nullable<string> | undefined;
-    /**
-     * To get user traits set in the SDK
-     */
-    getUserTraits(): Nullable<ApiObject> | undefined;
-    /**
-     * To get groupId set in the SDK
-     */
-    getGroupId(): Nullable<string> | undefined;
-    /**
-     * To get group traits set in the SDK
-     */
-    getGroupTraits(): Nullable<ApiObject> | undefined;
-    /**
-     * To manually start user session in the SDK
-     */
-    startSession(sessionId?: number): void;
-    /**
-     * To manually end user session in the SDK
-     */
-    endSession(): void;
-    /**
-     * To fetch the current sessionId
-     */
-    getSessionId(): Nullable<number>;
-}
-
-declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
-    static globalSingleton: Nullable<RudderAnalytics>;
-    analyticsInstances: Record<string, IAnalytics>;
-    defaultAnalyticsKey: string;
-    logger: Logger;
-    constructor();
-    /**
-     * Set instance to use if no specific writeKey is provided in methods
-     * automatically for the first created instance
-     * TODO: to support multiple analytics instances in the near future
-     */
-    setDefaultInstanceKey(writeKey: string): void;
-    /**
-     * Retrieve an existing analytics instance
-     */
-    getAnalyticsInstance(writeKey?: string): IAnalytics;
-    /**
-     * Create new analytics instance and trigger application lifecycle start
-     */
-    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
-     */
-    triggerBufferedLoadEvent(): void;
-    /**
-     * Get ready callback arguments and forward to ready call
-     */
-    ready(callback: ApiCallback): void;
-    /**
-     * Process page arguments and forward to page call
-     */
-    page(category?: string | Nullable<ApiObject> | ApiCallback, name?: string | Nullable<ApiOptions> | Nullable<ApiObject> | ApiCallback, properties?: Nullable<ApiOptions> | Nullable<ApiObject> | ApiCallback, options?: Nullable<ApiOptions> | ApiCallback, callback?: ApiCallback): void;
-    /**
-     * Process track arguments and forward to page call
-     */
-    track(event: string, properties?: Nullable<ApiObject> | ApiCallback, options?: Nullable<ApiOptions> | ApiCallback, callback?: ApiCallback): void;
-    /**
-     * 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;
-    /**
-     * Process alias arguments and forward to page call
-     */
-    alias(to?: Nullable<string> | ApiCallback, from?: string | Nullable<ApiOptions> | ApiCallback, options?: Nullable<ApiOptions> | ApiCallback, callback?: ApiCallback): void;
-    /**
-     * Process group arguments and forward to page call
-     */
-    group(groupId: string | number | Nullable<ApiObject> | ApiCallback, traits?: Nullable<ApiOptions> | Nullable<ApiObject> | ApiCallback, options?: Nullable<ApiOptions> | ApiCallback, callback?: ApiCallback): void;
-    reset(resetAnonymousId?: boolean): void;
-    getAnonymousId(options?: AnonymousIdOptions): string | undefined;
-    setAnonymousId(anonymousId?: string, rudderAmpLinkerParam?: string): void;
-    getUserId(): Nullable<string> | undefined;
-    getUserTraits(): Nullable<ApiObject> | undefined;
-    getGroupId(): Nullable<string> | undefined;
-    getGroupTraits(): Nullable<ApiObject> | undefined;
-    startSession(sessionId?: number): void;
-    endSession(): void;
-    getSessionId(): Nullable<number>;
-}
-//# sourceMappingURL=RudderAnalytics.d.ts.map
-
-/**
- * Exposed values that can be accessed as global objects per analytics instance
- * TODO: find all values that need to be exposed in globals if anything else
- */
-type ExposedGlobals = {
-    state?: ApplicationState;
-    preloadedEventsBuffer?: PreloadedEventCall[];
-    pluginsCDNPath?: string;
-};
-/**
- * Exposing all globally accessible values for all analytics instances
- * As key, we use the value of writeKey assigned to analytics instance that the values belong to
- */
-interface IRudderStackGlobals {
-    [key: string]: ExposedGlobals;
-}
-
-export { IRudderStackGlobals, RudderAnalytics };