@capgo/capacitor-rudderstack 8.1.2

package/dist/docs.json

@@ -0,0 +1,525 @@
+{
+  "api": {
+    "name": "RudderStackPlugin",
+    "slug": "rudderstackplugin",
+    "docs": "Capacitor API that mirrors the public surface of `rudder-sdk-cordova`.",
+    "tags": [],
+    "methods": [
+      {
+        "name": "initialize",
+        "signature": "(writeKey: string, config?: RudderConfiguration | RudderOptions | undefined, options?: RudderOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "writeKey",
+            "docs": "",
+            "type": "string"
+          },
+          {
+            "name": "config",
+            "docs": "",
+            "type": "RudderConfiguration | RudderOptions | undefined"
+          },
+          {
+            "name": "options",
+            "docs": "",
+            "type": "RudderOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Initializes the RudderStack client.\n\nThe method keeps the Cordova signature, so the second argument may be either a config object or\na Rudder options object.",
+        "complexTypes": [
+          "RudderConfiguration",
+          "RudderOptions"
+        ],
+        "slug": "initialize"
+      },
+      {
+        "name": "identify",
+        "signature": "(userId: string, traits?: RudderOptions | RudderTraits | undefined, options?: RudderOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "userId",
+            "docs": "",
+            "type": "string"
+          },
+          {
+            "name": "traits",
+            "docs": "",
+            "type": "RudderOptions | RudderTraits | undefined"
+          },
+          {
+            "name": "options",
+            "docs": "",
+            "type": "RudderOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Sends an identify call for the provided user id.",
+        "complexTypes": [
+          "RudderTraits",
+          "RudderOptions"
+        ],
+        "slug": "identify"
+      },
+      {
+        "name": "group",
+        "signature": "(groupId: string, groupTraits?: RudderOptions | RudderTraits | undefined, options?: RudderOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "groupId",
+            "docs": "",
+            "type": "string"
+          },
+          {
+            "name": "groupTraits",
+            "docs": "",
+            "type": "RudderOptions | RudderTraits | undefined"
+          },
+          {
+            "name": "options",
+            "docs": "",
+            "type": "RudderOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Sends a group call for the provided group id.",
+        "complexTypes": [
+          "RudderTraits",
+          "RudderOptions"
+        ],
+        "slug": "group"
+      },
+      {
+        "name": "track",
+        "signature": "(eventName: string, properties?: RudderOptions | RudderProperties | undefined, options?: RudderOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "string"
+          },
+          {
+            "name": "properties",
+            "docs": "",
+            "type": "RudderOptions | RudderProperties | undefined"
+          },
+          {
+            "name": "options",
+            "docs": "",
+            "type": "RudderOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Sends a track call for the provided event name.",
+        "complexTypes": [
+          "RudderProperties",
+          "RudderOptions"
+        ],
+        "slug": "track"
+      },
+      {
+        "name": "screen",
+        "signature": "(screenName: string, properties?: RudderOptions | RudderProperties | undefined, options?: RudderOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "screenName",
+            "docs": "",
+            "type": "string"
+          },
+          {
+            "name": "properties",
+            "docs": "",
+            "type": "RudderOptions | RudderProperties | undefined"
+          },
+          {
+            "name": "options",
+            "docs": "",
+            "type": "RudderOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Sends a screen call for the provided screen name.",
+        "complexTypes": [
+          "RudderProperties",
+          "RudderOptions"
+        ],
+        "slug": "screen"
+      },
+      {
+        "name": "alias",
+        "signature": "(newId: string, options?: RudderOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "newId",
+            "docs": "",
+            "type": "string"
+          },
+          {
+            "name": "options",
+            "docs": "",
+            "type": "RudderOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Aliases the current user to a new identifier.",
+        "complexTypes": [
+          "RudderOptions"
+        ],
+        "slug": "alias"
+      },
+      {
+        "name": "reset",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Resets the current RudderStack identity state.",
+        "complexTypes": [],
+        "slug": "reset"
+      },
+      {
+        "name": "flush",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Flushes queued events immediately.",
+        "complexTypes": [],
+        "slug": "flush"
+      },
+      {
+        "name": "putDeviceToken",
+        "signature": "(deviceToken: string) => Promise<void>",
+        "parameters": [
+          {
+            "name": "deviceToken",
+            "docs": "",
+            "type": "string"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Sets the push token that RudderStack forwards to supported destinations.",
+        "complexTypes": [],
+        "slug": "putdevicetoken"
+      },
+      {
+        "name": "setAdvertisingId",
+        "signature": "(advertisingId: string) => Promise<void>",
+        "parameters": [
+          {
+            "name": "advertisingId",
+            "docs": "",
+            "type": "string"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "deprecated",
+            "text": "Use `putAdvertisingId` instead."
+          }
+        ],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "setadvertisingid"
+      },
+      {
+        "name": "putAdvertisingId",
+        "signature": "(advertisingId: string) => Promise<void>",
+        "parameters": [
+          {
+            "name": "advertisingId",
+            "docs": "",
+            "type": "string"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Sets a custom advertising id value.",
+        "complexTypes": [],
+        "slug": "putadvertisingid"
+      },
+      {
+        "name": "setAnonymousId",
+        "signature": "(anonymousId: string) => Promise<void>",
+        "parameters": [
+          {
+            "name": "anonymousId",
+            "docs": "",
+            "type": "string"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "deprecated",
+            "text": "Use `putAnonymousId` instead."
+          }
+        ],
+        "docs": "",
+        "complexTypes": [],
+        "slug": "setanonymousid"
+      },
+      {
+        "name": "putAnonymousId",
+        "signature": "(anonymousId: string) => Promise<void>",
+        "parameters": [
+          {
+            "name": "anonymousId",
+            "docs": "",
+            "type": "string"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Sets a custom anonymous id value.",
+        "complexTypes": [],
+        "slug": "putanonymousid"
+      },
+      {
+        "name": "optOut",
+        "signature": "(optOut: boolean) => Promise<void>",
+        "parameters": [
+          {
+            "name": "optOut",
+            "docs": "",
+            "type": "boolean"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Toggles RudderStack tracking opt-out.",
+        "complexTypes": [],
+        "slug": "optout"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<PluginVersionResult>",
+        "parameters": [],
+        "returns": "Promise<PluginVersionResult>",
+        "tags": [],
+        "docs": "Returns the plugin version marker from the native implementation.",
+        "complexTypes": [
+          "PluginVersionResult"
+        ],
+        "slug": "getpluginversion"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "RudderConfiguration",
+      "slug": "rudderconfiguration",
+      "docs": "Supported configuration keys for the underlying RudderStack native SDKs.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "dataPlaneUrl",
+          "tags": [],
+          "docs": "RudderStack data plane URL.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "flushQueueSize",
+          "tags": [],
+          "docs": "Number of events to batch before a flush.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "dbCountThreshold",
+          "tags": [],
+          "docs": "Database row threshold that triggers pruning on Android and iOS.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "configRefreshInterval",
+          "tags": [],
+          "docs": "Server config refresh interval in hours.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "logLevel",
+          "tags": [],
+          "docs": "RudderStack log verbosity.",
+          "complexTypes": [
+            "RudderLogLevelValue"
+          ],
+          "type": "RudderLogLevelValue"
+        },
+        {
+          "name": "sleepTimeOut",
+          "tags": [],
+          "docs": "Sleep timeout / sleep count used by the native SDK.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "autoCollectAdvertId",
+          "tags": [],
+          "docs": "Android only. Lets the native SDK collect the advertising identifier automatically.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "trackLifecycleEvents",
+          "tags": [],
+          "docs": "Tracks `Application Installed`, `Application Updated`, and `Application Opened` automatically.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "controlPlaneUrl",
+          "tags": [],
+          "docs": "RudderStack control plane URL.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "recordScreenViews",
+          "tags": [],
+          "docs": "Enables automatic screen tracking where supported by the native SDK.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "factories",
+          "tags": [],
+          "docs": "Ignored in this Capacitor port.\n\nThe Cordova SDK uses this field to bootstrap native destination factories from companion plugins.\nThose extension packages are not implemented in this first Capacitor release.",
+          "complexTypes": [],
+          "type": "any[] | undefined"
+        }
+      ]
+    },
+    {
+      "name": "RudderOptions",
+      "slug": "rudderoptions",
+      "docs": "RudderStack per-call options.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "externalIds",
+          "tags": [],
+          "docs": "External identifiers forwarded with the event.",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, string>"
+        },
+        {
+          "name": "integrations",
+          "tags": [],
+          "docs": "Destination enablement flags keyed by integration name.",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, boolean>"
+        }
+      ]
+    },
+    {
+      "name": "PluginVersionResult",
+      "slug": "pluginversionresult",
+      "docs": "Plugin version payload.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "version",
+          "tags": [],
+          "docs": "Version identifier returned by the platform implementation.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "RudderLogLevelValue",
+      "slug": "rudderloglevelvalue",
+      "docs": "RudderStack log level values exposed for migration convenience.",
+      "types": [
+        {
+          "text": "0",
+          "complexTypes": []
+        },
+        {
+          "text": "1",
+          "complexTypes": []
+        },
+        {
+          "text": "2",
+          "complexTypes": []
+        },
+        {
+          "text": "3",
+          "complexTypes": []
+        },
+        {
+          "text": "4",
+          "complexTypes": []
+        },
+        {
+          "text": "5",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "Record",
+      "slug": "record",
+      "docs": "Construct a type with a set of properties K of type T",
+      "types": [
+        {
+          "text": "{\r\n    [P in K]: T;\r\n}",
+          "complexTypes": [
+            "K",
+            "T"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "RudderTraits",
+      "slug": "ruddertraits",
+      "docs": "Traits payload accepted by `identify` and `group`.",
+      "types": [
+        {
+          "text": "Record<string, any>",
+          "complexTypes": [
+            "Record"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "RudderProperties",
+      "slug": "rudderproperties",
+      "docs": "Properties payload accepted by `track` and `screen`.",
+      "types": [
+        {
+          "text": "Record<string, any>",
+          "complexTypes": [
+            "Record"
+          ]
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,154 @@
+/**
+ * Plugin version payload.
+ */
+export interface PluginVersionResult {
+    /**
+     * Version identifier returned by the platform implementation.
+     */
+    version: string;
+}
+/**
+ * Supported configuration keys for the underlying RudderStack native SDKs.
+ */
+export interface RudderConfiguration {
+    /**
+     * RudderStack data plane URL.
+     */
+    dataPlaneUrl?: string;
+    /**
+     * Number of events to batch before a flush.
+     */
+    flushQueueSize?: number;
+    /**
+     * Database row threshold that triggers pruning on Android and iOS.
+     */
+    dbCountThreshold?: number;
+    /**
+     * Server config refresh interval in hours.
+     */
+    configRefreshInterval?: number;
+    /**
+     * RudderStack log verbosity.
+     */
+    logLevel?: RudderLogLevelValue;
+    /**
+     * Sleep timeout / sleep count used by the native SDK.
+     */
+    sleepTimeOut?: number;
+    /**
+     * Android only. Lets the native SDK collect the advertising identifier automatically.
+     */
+    autoCollectAdvertId?: boolean;
+    /**
+     * Tracks `Application Installed`, `Application Updated`, and `Application Opened` automatically.
+     */
+    trackLifecycleEvents?: boolean;
+    /**
+     * RudderStack control plane URL.
+     */
+    controlPlaneUrl?: string;
+    /**
+     * Enables automatic screen tracking where supported by the native SDK.
+     */
+    recordScreenViews?: boolean;
+    /**
+     * Ignored in this Capacitor port.
+     *
+     * The Cordova SDK uses this field to bootstrap native destination factories from companion plugins.
+     * Those extension packages are not implemented in this first Capacitor release.
+     */
+    factories?: any[];
+}
+/**
+ * RudderStack per-call options.
+ */
+export interface RudderOptions {
+    /**
+     * External identifiers forwarded with the event.
+     */
+    externalIds?: Record<string, string>;
+    /**
+     * Destination enablement flags keyed by integration name.
+     */
+    integrations?: Record<string, boolean>;
+}
+/**
+ * Traits payload accepted by `identify` and `group`.
+ */
+export type RudderTraits = Record<string, any>;
+/**
+ * Properties payload accepted by `track` and `screen`.
+ */
+export type RudderProperties = Record<string, any>;
+/**
+ * RudderStack log level values exposed for migration convenience.
+ */
+export type RudderLogLevelValue = 0 | 1 | 2 | 3 | 4 | 5;
+/**
+ * Capacitor API that mirrors the public surface of `rudder-sdk-cordova`.
+ */
+export interface RudderStackPlugin {
+    /**
+     * Initializes the RudderStack client.
+     *
+     * The method keeps the Cordova signature, so the second argument may be either a config object or
+     * a Rudder options object.
+     */
+    initialize(writeKey: string, config?: RudderConfiguration | RudderOptions, options?: RudderOptions): Promise<void>;
+    /**
+     * Sends an identify call for the provided user id.
+     */
+    identify(userId: string, traits?: RudderTraits | RudderOptions, options?: RudderOptions): Promise<void>;
+    /**
+     * Sends a group call for the provided group id.
+     */
+    group(groupId: string, groupTraits?: RudderTraits | RudderOptions, options?: RudderOptions): Promise<void>;
+    /**
+     * Sends a track call for the provided event name.
+     */
+    track(eventName: string, properties?: RudderProperties | RudderOptions, options?: RudderOptions): Promise<void>;
+    /**
+     * Sends a screen call for the provided screen name.
+     */
+    screen(screenName: string, properties?: RudderProperties | RudderOptions, options?: RudderOptions): Promise<void>;
+    /**
+     * Aliases the current user to a new identifier.
+     */
+    alias(newId: string, options?: RudderOptions): Promise<void>;
+    /**
+     * Resets the current RudderStack identity state.
+     */
+    reset(): Promise<void>;
+    /**
+     * Flushes queued events immediately.
+     */
+    flush(): Promise<void>;
+    /**
+     * Sets the push token that RudderStack forwards to supported destinations.
+     */
+    putDeviceToken(deviceToken: string): Promise<void>;
+    /**
+     * @deprecated Use `putAdvertisingId` instead.
+     */
+    setAdvertisingId(advertisingId: string): Promise<void>;
+    /**
+     * Sets a custom advertising id value.
+     */
+    putAdvertisingId(advertisingId: string): Promise<void>;
+    /**
+     * @deprecated Use `putAnonymousId` instead.
+     */
+    setAnonymousId(anonymousId: string): Promise<void>;
+    /**
+     * Sets a custom anonymous id value.
+     */
+    putAnonymousId(anonymousId: string): Promise<void>;
+    /**
+     * Toggles RudderStack tracking opt-out.
+     */
+    optOut(optOut: boolean): Promise<void>;
+    /**
+     * Returns the plugin version marker from the native implementation.
+     */
+    getPluginVersion(): Promise<PluginVersionResult>;
+}

package/dist/esm/definitions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Plugin version payload.\n */\nexport interface PluginVersionResult {\n  /**\n   * Version identifier returned by the platform implementation.\n   */\n  version: string;\n}\n\n/**\n * Supported configuration keys for the underlying RudderStack native SDKs.\n */\nexport interface RudderConfiguration {\n  /**\n   * RudderStack data plane URL.\n   */\n  dataPlaneUrl?: string;\n\n  /**\n   * Number of events to batch before a flush.\n   */\n  flushQueueSize?: number;\n\n  /**\n   * Database row threshold that triggers pruning on Android and iOS.\n   */\n  dbCountThreshold?: number;\n\n  /**\n   * Server config refresh interval in hours.\n   */\n  configRefreshInterval?: number;\n\n  /**\n   * RudderStack log verbosity.\n   */\n  logLevel?: RudderLogLevelValue;\n\n  /**\n   * Sleep timeout / sleep count used by the native SDK.\n   */\n  sleepTimeOut?: number;\n\n  /**\n   * Android only. Lets the native SDK collect the advertising identifier automatically.\n   */\n  autoCollectAdvertId?: boolean;\n\n  /**\n   * Tracks `Application Installed`, `Application Updated`, and `Application Opened` automatically.\n   */\n  trackLifecycleEvents?: boolean;\n\n  /**\n   * RudderStack control plane URL.\n   */\n  controlPlaneUrl?: string;\n\n  /**\n   * Enables automatic screen tracking where supported by the native SDK.\n   */\n  recordScreenViews?: boolean;\n\n  /**\n   * Ignored in this Capacitor port.\n   *\n   * The Cordova SDK uses this field to bootstrap native destination factories from companion plugins.\n   * Those extension packages are not implemented in this first Capacitor release.\n   */\n  factories?: any[];\n}\n\n/**\n * RudderStack per-call options.\n */\nexport interface RudderOptions {\n  /**\n   * External identifiers forwarded with the event.\n   */\n  externalIds?: Record<string, string>;\n\n  /**\n   * Destination enablement flags keyed by integration name.\n   */\n  integrations?: Record<string, boolean>;\n}\n\n/**\n * Traits payload accepted by `identify` and `group`.\n */\nexport type RudderTraits = Record<string, any>;\n\n/**\n * Properties payload accepted by `track` and `screen`.\n */\nexport type RudderProperties = Record<string, any>;\n\n/**\n * RudderStack log level values exposed for migration convenience.\n */\nexport type RudderLogLevelValue = 0 | 1 | 2 | 3 | 4 | 5;\n\n/**\n * Capacitor API that mirrors the public surface of `rudder-sdk-cordova`.\n */\nexport interface RudderStackPlugin {\n  /**\n   * Initializes the RudderStack client.\n   *\n   * The method keeps the Cordova signature, so the second argument may be either a config object or\n   * a Rudder options object.\n   */\n  initialize(writeKey: string, config?: RudderConfiguration | RudderOptions, options?: RudderOptions): Promise<void>;\n\n  /**\n   * Sends an identify call for the provided user id.\n   */\n  identify(userId: string, traits?: RudderTraits | RudderOptions, options?: RudderOptions): Promise<void>;\n\n  /**\n   * Sends a group call for the provided group id.\n   */\n  group(groupId: string, groupTraits?: RudderTraits | RudderOptions, options?: RudderOptions): Promise<void>;\n\n  /**\n   * Sends a track call for the provided event name.\n   */\n  track(eventName: string, properties?: RudderProperties | RudderOptions, options?: RudderOptions): Promise<void>;\n\n  /**\n   * Sends a screen call for the provided screen name.\n   */\n  screen(screenName: string, properties?: RudderProperties | RudderOptions, options?: RudderOptions): Promise<void>;\n\n  /**\n   * Aliases the current user to a new identifier.\n   */\n  alias(newId: string, options?: RudderOptions): Promise<void>;\n\n  /**\n   * Resets the current RudderStack identity state.\n   */\n  reset(): Promise<void>;\n\n  /**\n   * Flushes queued events immediately.\n   */\n  flush(): Promise<void>;\n\n  /**\n   * Sets the push token that RudderStack forwards to supported destinations.\n   */\n  putDeviceToken(deviceToken: string): Promise<void>;\n\n  /**\n   * @deprecated Use `putAdvertisingId` instead.\n   */\n  setAdvertisingId(advertisingId: string): Promise<void>;\n\n  /**\n   * Sets a custom advertising id value.\n   */\n  putAdvertisingId(advertisingId: string): Promise<void>;\n\n  /**\n   * @deprecated Use `putAnonymousId` instead.\n   */\n  setAnonymousId(anonymousId: string): Promise<void>;\n\n  /**\n   * Sets a custom anonymous id value.\n   */\n  putAnonymousId(anonymousId: string): Promise<void>;\n\n  /**\n   * Toggles RudderStack tracking opt-out.\n   */\n  optOut(optOut: boolean): Promise<void>;\n\n  /**\n   * Returns the plugin version marker from the native implementation.\n   */\n  getPluginVersion(): Promise<PluginVersionResult>;\n}\n"]}