rudder-sdk-js 1.0.19 → 1.2.2

package/index.d.ts

@@ -1,46 +1,396 @@
 declare module "rudder-sdk-js" {
-  function load(writeKey: string, dataPlaneUrl: string, options?: any): any;
+  /**
+   * Represents the integration options object
+   * Example usages:
+   * integrationOptions { All: false, "Google Analytics": true, "Braze": true}
+   * integrationOptions { All: true, "Chartbeat": false, "Customer.io": false}
+   */
+  interface integrationOptions {
+    // Defaults to true
+    All?: boolean;
+    // Destination name: Enable/Disable
+    [index: string]: boolean | undefined;
+  }
 
-  function ready(callback: any): any;
+  /**
+   * Represents the queue options parameter in loadOptions type
+   */
+  interface queueOptions {
+    // Upper cap on maximum delay for an event
+    maxRetryDelay?: number;
+    // Minimum delay before sending an event
+    minRetryDelay?: number;
+    // Exponential base
+    backoffFactor?: number;
+    // Maximum number of attempts
+    maxAttempts?: number;
+    // Maximum number of events in storage
+    maxItems?: number;
+  }
 
+  /**
+   * Represents the options parameter in the load API
+   */
+  interface loadOptions {
+    integrations?: integrationOptions;
+    // defaults to https://api.rudderlabs.com
+    configUrl?: string;
+    queueOptions?: queueOptions;
+    // Defaults to true
+    loadIntegration?: boolean;
+    logLevel?: string;
+    getSourceConfig?: () =>
+      | string
+      | apiObject
+      | Promise<apiObject>
+      | Promise<string>;
+    setCookieDomain?: string;
+    sendAdblockPage?: boolean;
+    sendAdblockPageOptions?: apiOptions;
+    clientSuppliedCallbacks?: { string: () => void };
+  }
+
+  /**
+   * Represents the options parameter in the APIs
+   */
+  interface apiOptions {
+    integrations?: integrationOptions;
+    anonymousId?: string;
+    // ISO 8601 date string
+    originalTimestamp?: string;
+    // Merged with event's contextual information
+    [index: string]:
+      | string
+      | number
+      | boolean
+      | apiObject
+      | integrationOptions
+      | undefined;
+  }
+
+  /**
+   * Represents a generic object in the APIs
+   * Use for parameters like properties, traits etc.
+   */
+  interface apiObject {
+    [index: string]: string | number | boolean | apiObject;
+  }
+
+  /**
+   * Represents the callback in the APIs
+   */
+  type apiCallback = () => void;
+
+  /**
+   * Call control pane to get client configs
+   * @param writeKey
+   * @param dataPlaneUrl
+   * @param options
+   */
+  function load(
+    writeKey: string,
+    dataPlaneUrl: string,
+    options?: loadOptions
+  ): void;
+
+  /**
+   * To register a callback for SDK ready state
+   * @param callback
+   */
+  function ready(callback: apiCallback): void;
+
+  /**
+   * To record a page view event
+   * @param category
+   * @param name
+   * @param properties
+   * @param options
+   * @param callback
+   */
   function page(
     category?: string,
     name?: string,
-    properties?: any,
-    options?: any,
-    callback?: any
-  ): any;
+    properties?: apiObject,
+    options?: apiOptions,
+    callback?: apiCallback
+  ): void;
+
+  /**
+   * To record a page view event
+   * @param category
+   * @param name
+   * @param properties
+   * @param callback
+   */
+  function page(
+    category: string,
+    name: string,
+    properties: apiObject,
+    callback: apiCallback
+  ): void;
+
+  /**
+   * To record a page view event
+   * @param category
+   * @param name
+   * @param callback
+   */
+  function page(category: string, name: string, callback: apiCallback): void;
+
+  /**
+   * To record a page view event
+   * @param name
+   * @param properties
+   * @param options
+   * @param callback
+   */
+  function page(
+    name: string,
+    properties?: apiObject,
+    options?: apiOptions,
+    callback?: apiCallback
+  ): void;
+
+  /**
+   * To record a page view event
+   * @param name
+   * @param properties
+   * @param callback
+   */
+  function page(
+    name: string,
+    properties: apiObject,
+    callback: apiCallback
+  ): void;
+
+  /**
+   *
+   * @param name
+   * @param callback
+   */
+  function page(name: string, callback: apiCallback): void;
+
+  /**
+   *
+   * @param properties
+   * @param options
+   * @param callback
+   */
+  function page(
+    properties: apiObject,
+    options: apiOptions,
+    callback?: apiCallback
+  ): void;
+
+  /**
+   * To record a page view event
+   * @param properties
+   * @param callback
+   */
+  function page(properties: apiObject, callback?: apiCallback): void;
+
+  /**
+   * To record a user track event
+   * @param event
+   * @param properties
+   * @param options
+   * @param callback
+   */
+  function track(
+    event: string,
+    properties?: apiObject,
+    options?: apiOptions,
+    callback?: apiCallback
+  ): void;
 
+  /**
+   * To record a user track event
+   * @param event
+   * @param properties
+   * @param callback
+   */
   function track(
     event: string,
-    properties?: any,
-    options?: any,
-    callback?: any
-  ): any;
+    properties: apiObject,
+    callback: apiCallback
+  ): void;
+
+  /**
+   * To record a user track event
+   * @param event
+   * @param callback
+   */
+  function track(event: string, callback: apiCallback): void;
+
+  /**
+   * To record a user identification event
+   * @param userId
+   * @param traits
+   * @param options
+   * @param callback
+   */
+  function identify(
+    userId?: string,
+    traits?: apiObject,
+    options?: apiOptions,
+    callback?: apiCallback
+  ): void;
 
+  /**
+   * To record a user identification event
+   * @param userId
+   * @param traits
+   * @param callback
+   */
   function identify(
-    id?: string,
-    traits?: any,
-    options?: any,
-    callback?: any
-  ): any;
+    userId: string,
+    traits: apiObject,
+    callback: apiCallback
+  ): void;
+
+  /**
+   * To record a user identification event
+   * @param userId
+   * @param callback
+   */
+  function identify(userId: string, callback: apiCallback): void;
+
+  /**
+   *
+   * @param traits
+   * @param options
+   * @param callback
+   */
+  function identify(
+    traits: apiObject,
+    options: apiOptions,
+    callback?: apiCallback
+  ): void;
+
+  /**
+   *
+   * @param traits
+   * @param callback
+   */
+  function identify(traits: apiObject, callback?: apiCallback): void;
 
-  function alias(to: string, from?: string, options?: any, callback?: any): any;
+  /**
+   * To record a user alias event
+   * @param to
+   * @param from
+   * @param options
+   * @param callback
+   */
+  function alias(
+    to: string,
+    from?: string,
+    options?: apiOptions,
+    callback?: apiCallback
+  ): void;
 
+  /**
+   * To record a user alias event
+   * @param to
+   * @param from
+   * @param callback
+   */
+  function alias(to: string, from: string, callback: apiCallback): void;
+
+  /**
+   * To record a user alias event
+   * @param to
+   * @param callback
+   */
+  function alias(to: string, callback: apiCallback): void;
+
+  /**
+   * To record a user alias event
+   * @param to
+   * @param options
+   * @param callback
+   */
+  function alias(to: string, options: apiOptions, callback?: apiCallback): void;
+
+  /**
+   * To record a user group event
+   * @param groupId
+   * @param traits
+   * @param options
+   * @param callback
+   */
+  function group(
+    groupId: string,
+    traits?: apiObject,
+    options?: apiOptions,
+    callback?: apiCallback
+  ): void;
+
+  /**
+   * To record a user group event
+   * @param groupId
+   * @param traits
+   * @param callback
+   */
   function group(
-    group: string,
-    traits?: any,
-    options?: any,
-    callback?: any
-  ): any;
+    groupId: string,
+    traits: apiObject,
+    callback: apiCallback
+  ): void;
+
+  /**
+   * To record a user group event
+   * @param groupId
+   * @param callback
+   */
+  function group(groupId: string, callback: apiCallback): void;
+
+  /**
+   * To record a user group event
+   * @param traits
+   * @param options
+   * @param callback
+   */
+  function group(
+    traits: apiObject,
+    options: apiOptions,
+    callback?: apiCallback
+  ): void;
+
+  /**
+   * To record a user group event
+   * @param traits
+   * @param callback
+   */
+  function group(traits: apiObject, callback?: apiCallback): void;
 
-  function getAnonymousId(): any;
+  /**
+   * To get anonymousId set in the SDK
+   */
+  function getAnonymousId(): string;
 
-  function setAnonymousId(id?: string): any;
+  /**
+   * To set anonymousId
+   * @param anonymousId
+   * @param rudderAmpLinkerParm AMP Linker ID string
+   */
+  function setAnonymousId(
+    anonymousId?: string,
+    rudderAmpLinkerParm?: string
+  ): void;
 
-  function reset(): any;
+  /**
+   * Clear user information
+   * @param flag If true, clears anonymousId as well
+   */
+  function reset(flag?: boolean): void;
 
   export {
+    integrationOptions,
+    loadOptions,
+    apiOptions,
+    queueOptions,
+    apiObject,
+    apiCallback,
     load,
     ready,
     reset,