@rudderstack/analytics-js 3.21.0-beta.pr.2309.4f0ffa0 → 3.21.0

package/dist/npm/index.d.cts

@@ -14,7 +14,6 @@ interface ILogger {
     setMinLogLevel(logLevel: LogLevel): void;
 }
 type LogLevel = 'LOG' | 'INFO' | 'DEBUG' | 'WARN' | 'ERROR' | 'NONE';
-type RSALogger = Pick<ILogger, 'log' | 'info' | 'debug' | 'warn' | 'error' | 'setMinLogLevel'>;
 
 type LoggerProvider = Record<Exclude<Lowercase<LogLevel>, Lowercase<'NONE'>>, (...data: any[]) => void>;
 
@@ -63,7 +62,6 @@ type IntegrationOpts = {
     [index: string]: DestinationIntgConfig;
 };
 
-type Traits = Nullable<ApiObject>;
 type ApiCallback = (data?: any) => void;
 /**
  * Represents the options parameter in the APIs
@@ -163,11 +161,6 @@ type CookieSameSite = 'Strict' | 'Lax' | 'None';
 type OneTrustCookieCategory = {
     oneTrustCookieCategory: string;
 };
-type ConsentManagement = {
-    deniedConsentIds: Consents;
-    allowedConsentIds: Consents;
-    provider: ConsentManagementProvider;
-};
 type ConsentManagementMetadata = {
     providers: ConsentManagementProviderMetadata[];
 };
@@ -428,76 +421,6 @@ type IdentifyTraits = {
     [index: string]: string | number | boolean | ApiObject | null | Date | (string | number | boolean | null | Date | ApiObject)[] | undefined;
 };
 
-type AppInfo = {
-    readonly name: string;
-    readonly version: string;
-    readonly namespace: string;
-    readonly installType: string;
-};
-type LibraryInfo = {
-    readonly name: string;
-    readonly version: string;
-    readonly snippetVersion?: string;
-};
-type OSInfo = {
-    readonly name: string;
-    readonly version: string;
-};
-type ScreenInfo = {
-    readonly density: number;
-    readonly width: number;
-    readonly height: number;
-    readonly innerWidth: number;
-    readonly innerHeight: number;
-};
-type UTMParameters = Record<string, string>;
-
-type PageLifecycle = {
-    pageViewId: string;
-};
-type AutoTrack = {
-    page: PageLifecycle;
-};
-type RudderContext = {
-    [index: string]: string | number | boolean | ApiObject | UADataValues | Nullable<string> | (string | number | boolean | ApiObject)[] | undefined;
-    traits?: Nullable<ApiObject>;
-    sessionId?: number;
-    sessionStart?: boolean;
-    consentManagement?: ConsentManagement;
-    'ua-ch'?: UADataValues;
-    app: AppInfo;
-    library: LibraryInfo;
-    userAgent: Nullable<string>;
-    os: OSInfo;
-    locale: Nullable<string>;
-    screen: ScreenInfo;
-    campaign?: UTMParameters;
-    trulyAnonymousTracking?: boolean;
-    timezone: string;
-    autoTrack?: AutoTrack;
-};
-type RudderEvent = {
-    type: RudderEventType;
-    channel: string;
-    anonymousId: string;
-    context: RudderContext;
-    originalTimestamp: string;
-    integrations: IntegrationOpts;
-    messageId: string;
-    event: Nullable<string>;
-    previousId?: string;
-    userId?: Nullable<string>;
-    sentAt?: string;
-    properties?: Nullable<ApiObject>;
-    name?: Nullable<string>;
-    category?: Nullable<string>;
-    traits?: Traits;
-    groupId?: Nullable<string>;
-};
-type RSAEvent = {
-    message: RudderEvent;
-};
-
 type AnalyticsIdentifyMethod = {
     (userId: string, traits?: Nullable<IdentifyTraits>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
     (userId: string, traits?: Nullable<IdentifyTraits>, callback?: ApiCallback): void;
@@ -635,75 +558,7 @@ interface IRudderAnalytics<T = any> {
      * @param options Consent API options
      */
     consent(options?: ConsentOptions): void;
-    /**
-     * To add a custom integration
-     * @param name The name of the custom integration
-     * @param integration The custom integration object
-     */
-    addCustomIntegration(name: string, integration: RSACustomIntegration): void;
 }
-type RSAnalytics = Pick<IRudderAnalytics, 'track' | 'page' | 'identify' | 'group' | 'alias' | 'getAnonymousId' | 'getUserId' | 'getUserTraits' | 'getGroupId' | 'getGroupTraits' | 'getSessionId'>;
-/**
- * Type for the custom integration to be used in addCustomIntegration API
- * Defines the contract that all custom integrations must implement
- */
-type RSACustomIntegration = {
-    /**
-     * Initialize the integration
-     * @param analytics - The RudderStack analytics instance
-     * @param logger - The logger instance for this integration
-     * @optional
-     */
-    init?: (analytics: RSAnalytics, logger: RSALogger) => void;
-    /**
-     * Check if the integration is ready to process events
-     * @param analytics - The RudderStack analytics instance
-     * @param logger - The logger instance for this integration
-     * @returns boolean indicating whether the integration is ready
-     * @required
-     */
-    isReady: (analytics: RSAnalytics, logger: RSALogger) => boolean;
-    /**
-     * Process track events
-     * @param analytics - The RudderStack analytics instance
-     * @param logger - The logger instance for this integration
-     * @param event - The track event payload to process
-     * @optional
-     */
-    track?: (analytics: RSAnalytics, logger: RSALogger, event: RSAEvent) => void;
-    /**
-     * Process page events
-     * @param analytics - The RudderStack analytics instance
-     * @param logger - The logger instance for this integration
-     * @param event - The page event payload to process
-     * @optional
-     */
-    page?: (analytics: RSAnalytics, logger: RSALogger, event: RSAEvent) => void;
-    /**
-     * Process identify events
-     * @param analytics - The RudderStack analytics instance
-     * @param logger - The logger instance for this integration
-     * @param event - The identify event payload to process
-     * @optional
-     */
-    identify?: (analytics: RSAnalytics, logger: RSALogger, event: RSAEvent) => void;
-    /**
-     * Process group events
-     * @param analytics - The RudderStack analytics instance
-     * @param logger - The logger instance for this integration
-     * @param event - The group event payload to process
-     * @optional
-     */
-    group?: (analytics: RSAnalytics, logger: RSALogger, event: RSAEvent) => void;
-    /**
-     * Process alias events
-     * @param analytics - The RudderStack analytics instance
-     * @param logger - The logger instance for this integration
-     * @param event - The alias event payload to process
-     * @optional
-     */
-    alias?: (analytics: RSAnalytics, logger: RSALogger, event: RSAEvent) => void;
-};
 
 type SDKError = unknown | Error | ErrorEvent | Event | PromiseRejectionEvent;
 type ErrorInfo = {
@@ -1278,13 +1133,6 @@ interface IAnalytics {
      * To set auth token
      */
     setAuthToken(token: string): void;
-    /**
-     * Add a custom integration to the SDK
-     * @param name - Unique name for the custom integration
-     * @param integration - The custom integration instance implementing RSACustomIntegration
-     * @param isBufferedInvocation - Internal flag to indicate if this is a buffered call
-     */
-    addCustomIntegration(name: string, integration: RSACustomIntegration, isBufferedInvocation?: boolean): void;
 }
 
 declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
@@ -1293,12 +1141,6 @@ declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
     defaultAnalyticsKey: string;
     logger: Logger;
     constructor();
-    /**
-     * Create an instance of the current instance that can be used
-     * to call a subset of methods of the current instance.
-     * It is typically used to expose the analytics instance to the integrations (standard and custom)
-     */
-    createSafeAnalyticsInstance(): void;
     static initializeGlobalResources(): void;
     /**
      * Set instance to use if no specific writeKey is provided in methods
@@ -1393,7 +1235,6 @@ declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
     getSessionId(): Nullable<number> | undefined;
     setAuthToken(token: string): void;
     consent(options?: ConsentOptions): void;
-    addCustomIntegration(name: string, integration: RSACustomIntegration): void;
 }
 //# sourceMappingURL=RudderAnalytics.d.ts.map
 
@@ -1405,4 +1246,4 @@ declare global {
 //# sourceMappingURL=index.d.ts.map
 
 export { RudderAnalytics };
-export type { AnonymousIdOptions, ApiCallback, ApiObject, ApiOptions, BeaconQueueOpts, ConsentOptions, CookieSameSite, DestinationsQueueOpts, IdentifyTraits, IntegrationOpts, LoadOptions, LogLevel, PluginName, PreloadedEventCall, QueueOpts, RSACustomIntegration, RSAEvent, RSALogger, RSAnalytics, RudderAnalyticsPreloader, SessionOpts, UaChTrackLevel };
+export type { AnonymousIdOptions, ApiCallback, ApiObject, ApiOptions, BeaconQueueOpts, ConsentOptions, CookieSameSite, DestinationsQueueOpts, IdentifyTraits, IntegrationOpts, LoadOptions, LogLevel, PluginName, PreloadedEventCall, QueueOpts, RudderAnalyticsPreloader, SessionOpts, UaChTrackLevel };

package/dist/npm/index.d.mts

@@ -14,7 +14,6 @@ interface ILogger {
     setMinLogLevel(logLevel: LogLevel): void;
 }
 type LogLevel = 'LOG' | 'INFO' | 'DEBUG' | 'WARN' | 'ERROR' | 'NONE';
-type RSALogger = Pick<ILogger, 'log' | 'info' | 'debug' | 'warn' | 'error' | 'setMinLogLevel'>;
 
 type LoggerProvider = Record<Exclude<Lowercase<LogLevel>, Lowercase<'NONE'>>, (...data: any[]) => void>;
 
@@ -63,7 +62,6 @@ type IntegrationOpts = {
     [index: string]: DestinationIntgConfig;
 };
 
-type Traits = Nullable<ApiObject>;
 type ApiCallback = (data?: any) => void;
 /**
  * Represents the options parameter in the APIs
@@ -163,11 +161,6 @@ type CookieSameSite = 'Strict' | 'Lax' | 'None';
 type OneTrustCookieCategory = {
     oneTrustCookieCategory: string;
 };
-type ConsentManagement = {
-    deniedConsentIds: Consents;
-    allowedConsentIds: Consents;
-    provider: ConsentManagementProvider;
-};
 type ConsentManagementMetadata = {
     providers: ConsentManagementProviderMetadata[];
 };
@@ -428,76 +421,6 @@ type IdentifyTraits = {
     [index: string]: string | number | boolean | ApiObject | null | Date | (string | number | boolean | null | Date | ApiObject)[] | undefined;
 };
 
-type AppInfo = {
-    readonly name: string;
-    readonly version: string;
-    readonly namespace: string;
-    readonly installType: string;
-};
-type LibraryInfo = {
-    readonly name: string;
-    readonly version: string;
-    readonly snippetVersion?: string;
-};
-type OSInfo = {
-    readonly name: string;
-    readonly version: string;
-};
-type ScreenInfo = {
-    readonly density: number;
-    readonly width: number;
-    readonly height: number;
-    readonly innerWidth: number;
-    readonly innerHeight: number;
-};
-type UTMParameters = Record<string, string>;
-
-type PageLifecycle = {
-    pageViewId: string;
-};
-type AutoTrack = {
-    page: PageLifecycle;
-};
-type RudderContext = {
-    [index: string]: string | number | boolean | ApiObject | UADataValues | Nullable<string> | (string | number | boolean | ApiObject)[] | undefined;
-    traits?: Nullable<ApiObject>;
-    sessionId?: number;
-    sessionStart?: boolean;
-    consentManagement?: ConsentManagement;
-    'ua-ch'?: UADataValues;
-    app: AppInfo;
-    library: LibraryInfo;
-    userAgent: Nullable<string>;
-    os: OSInfo;
-    locale: Nullable<string>;
-    screen: ScreenInfo;
-    campaign?: UTMParameters;
-    trulyAnonymousTracking?: boolean;
-    timezone: string;
-    autoTrack?: AutoTrack;
-};
-type RudderEvent = {
-    type: RudderEventType;
-    channel: string;
-    anonymousId: string;
-    context: RudderContext;
-    originalTimestamp: string;
-    integrations: IntegrationOpts;
-    messageId: string;
-    event: Nullable<string>;
-    previousId?: string;
-    userId?: Nullable<string>;
-    sentAt?: string;
-    properties?: Nullable<ApiObject>;
-    name?: Nullable<string>;
-    category?: Nullable<string>;
-    traits?: Traits;
-    groupId?: Nullable<string>;
-};
-type RSAEvent = {
-    message: RudderEvent;
-};
-
 type AnalyticsIdentifyMethod = {
     (userId: string, traits?: Nullable<IdentifyTraits>, options?: Nullable<ApiOptions>, callback?: ApiCallback): void;
     (userId: string, traits?: Nullable<IdentifyTraits>, callback?: ApiCallback): void;
@@ -635,75 +558,7 @@ interface IRudderAnalytics<T = any> {
      * @param options Consent API options
      */
     consent(options?: ConsentOptions): void;
-    /**
-     * To add a custom integration
-     * @param name The name of the custom integration
-     * @param integration The custom integration object
-     */
-    addCustomIntegration(name: string, integration: RSACustomIntegration): void;
 }
-type RSAnalytics = Pick<IRudderAnalytics, 'track' | 'page' | 'identify' | 'group' | 'alias' | 'getAnonymousId' | 'getUserId' | 'getUserTraits' | 'getGroupId' | 'getGroupTraits' | 'getSessionId'>;
-/**
- * Type for the custom integration to be used in addCustomIntegration API
- * Defines the contract that all custom integrations must implement
- */
-type RSACustomIntegration = {
-    /**
-     * Initialize the integration
-     * @param analytics - The RudderStack analytics instance
-     * @param logger - The logger instance for this integration
-     * @optional
-     */
-    init?: (analytics: RSAnalytics, logger: RSALogger) => void;
-    /**
-     * Check if the integration is ready to process events
-     * @param analytics - The RudderStack analytics instance
-     * @param logger - The logger instance for this integration
-     * @returns boolean indicating whether the integration is ready
-     * @required
-     */
-    isReady: (analytics: RSAnalytics, logger: RSALogger) => boolean;
-    /**
-     * Process track events
-     * @param analytics - The RudderStack analytics instance
-     * @param logger - The logger instance for this integration
-     * @param event - The track event payload to process
-     * @optional
-     */
-    track?: (analytics: RSAnalytics, logger: RSALogger, event: RSAEvent) => void;
-    /**
-     * Process page events
-     * @param analytics - The RudderStack analytics instance
-     * @param logger - The logger instance for this integration
-     * @param event - The page event payload to process
-     * @optional
-     */
-    page?: (analytics: RSAnalytics, logger: RSALogger, event: RSAEvent) => void;
-    /**
-     * Process identify events
-     * @param analytics - The RudderStack analytics instance
-     * @param logger - The logger instance for this integration
-     * @param event - The identify event payload to process
-     * @optional
-     */
-    identify?: (analytics: RSAnalytics, logger: RSALogger, event: RSAEvent) => void;
-    /**
-     * Process group events
-     * @param analytics - The RudderStack analytics instance
-     * @param logger - The logger instance for this integration
-     * @param event - The group event payload to process
-     * @optional
-     */
-    group?: (analytics: RSAnalytics, logger: RSALogger, event: RSAEvent) => void;
-    /**
-     * Process alias events
-     * @param analytics - The RudderStack analytics instance
-     * @param logger - The logger instance for this integration
-     * @param event - The alias event payload to process
-     * @optional
-     */
-    alias?: (analytics: RSAnalytics, logger: RSALogger, event: RSAEvent) => void;
-};
 
 type SDKError = unknown | Error | ErrorEvent | Event | PromiseRejectionEvent;
 type ErrorInfo = {
@@ -1278,13 +1133,6 @@ interface IAnalytics {
      * To set auth token
      */
     setAuthToken(token: string): void;
-    /**
-     * Add a custom integration to the SDK
-     * @param name - Unique name for the custom integration
-     * @param integration - The custom integration instance implementing RSACustomIntegration
-     * @param isBufferedInvocation - Internal flag to indicate if this is a buffered call
-     */
-    addCustomIntegration(name: string, integration: RSACustomIntegration, isBufferedInvocation?: boolean): void;
 }
 
 declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
@@ -1293,12 +1141,6 @@ declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
     defaultAnalyticsKey: string;
     logger: Logger;
     constructor();
-    /**
-     * Create an instance of the current instance that can be used
-     * to call a subset of methods of the current instance.
-     * It is typically used to expose the analytics instance to the integrations (standard and custom)
-     */
-    createSafeAnalyticsInstance(): void;
     static initializeGlobalResources(): void;
     /**
      * Set instance to use if no specific writeKey is provided in methods
@@ -1393,7 +1235,6 @@ declare class RudderAnalytics implements IRudderAnalytics<IAnalytics> {
     getSessionId(): Nullable<number> | undefined;
     setAuthToken(token: string): void;
     consent(options?: ConsentOptions): void;
-    addCustomIntegration(name: string, integration: RSACustomIntegration): void;
 }
 //# sourceMappingURL=RudderAnalytics.d.ts.map
 
@@ -1405,4 +1246,4 @@ declare global {
 //# sourceMappingURL=index.d.ts.map
 
 export { RudderAnalytics };
-export type { AnonymousIdOptions, ApiCallback, ApiObject, ApiOptions, BeaconQueueOpts, ConsentOptions, CookieSameSite, DestinationsQueueOpts, IdentifyTraits, IntegrationOpts, LoadOptions, LogLevel, PluginName, PreloadedEventCall, QueueOpts, RSACustomIntegration, RSAEvent, RSALogger, RSAnalytics, RudderAnalyticsPreloader, SessionOpts, UaChTrackLevel };
+export type { AnonymousIdOptions, ApiCallback, ApiObject, ApiOptions, BeaconQueueOpts, ConsentOptions, CookieSameSite, DestinationsQueueOpts, IdentifyTraits, IntegrationOpts, LoadOptions, LogLevel, PluginName, PreloadedEventCall, QueueOpts, RudderAnalyticsPreloader, SessionOpts, UaChTrackLevel };