@capgo/capacitor-persona 8.0.0

package/dist/docs.json

@@ -0,0 +1,380 @@
+{
+  "api": {
+    "name": "PersonaPlugin",
+    "slug": "personaplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "startInquiry",
+        "signature": "(options: StartInquiryOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "StartInquiryOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Launch a Persona Inquiry flow.",
+        "complexTypes": [
+          "StartInquiryOptions"
+        ],
+        "slug": "startinquiry"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'inquiryComplete', listenerFunc: (info: InquiryCompleteInfo) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'inquiryComplete'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(info: InquiryCompleteInfo) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "Listen for successful completion.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "InquiryCompleteInfo"
+        ],
+        "slug": "addlistenerinquirycomplete-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'inquiryCanceled', listenerFunc: (info: InquiryCanceledInfo) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'inquiryCanceled'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(info: InquiryCanceledInfo) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "Listen for cancellation.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "InquiryCanceledInfo"
+        ],
+        "slug": "addlistenerinquirycanceled-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'inquiryError', listenerFunc: (info: InquiryErrorInfo) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'inquiryError'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(info: InquiryErrorInfo) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "Listen for unrecoverable errors.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "InquiryErrorInfo"
+        ],
+        "slug": "addlistenerinquiryerror-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Remove all registered listeners for this plugin instance.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "StartInquiryOptions",
+      "slug": "startinquiryoptions",
+      "docs": "Input payload used to launch an Inquiry.\n\nProvide at least one of:\n- `templateId`\n- `templateVersion`\n- `inquiryId`",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "inquiryId",
+          "tags": [],
+          "docs": "Existing Inquiry ID created on your backend.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "sessionToken",
+          "tags": [],
+          "docs": "Session token required when resuming an existing Inquiry.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "templateId",
+          "tags": [],
+          "docs": "Inquiry template ID from Persona Dashboard (recommended).",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "templateVersion",
+          "tags": [],
+          "docs": "Inquiry template version ID from Persona Dashboard.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "referenceId",
+          "tags": [],
+          "docs": "Your internal user reference.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "accountId",
+          "tags": [],
+          "docs": "Persona account ID.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "environment",
+          "tags": [
+            {
+              "text": "'production'",
+              "name": "default"
+            }
+          ],
+          "docs": "Persona environment.",
+          "complexTypes": [
+            "PersonaEnvironment"
+          ],
+          "type": "PersonaEnvironment"
+        },
+        {
+          "name": "locale",
+          "tags": [],
+          "docs": "Locale override, for example `en`, `fr`, `es`.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "fields",
+          "tags": [],
+          "docs": "Optional fields pre-written into the Inquiry.",
+          "complexTypes": [
+            "Record",
+            "PersonaFieldValue"
+          ],
+          "type": "Record<string, PersonaFieldValue>"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "InquiryCompleteInfo",
+      "slug": "inquirycompleteinfo",
+      "docs": "Payload emitted when an Inquiry is completed.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "inquiryId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "status",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "fields",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "Record",
+            "PersonaResultFieldValue"
+          ],
+          "type": "Record<string, PersonaResultFieldValue>"
+        }
+      ]
+    },
+    {
+      "name": "InquiryCanceledInfo",
+      "slug": "inquirycanceledinfo",
+      "docs": "Payload emitted when an Inquiry is canceled.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "inquiryId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "sessionToken",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "InquiryErrorInfo",
+      "slug": "inquiryerrorinfo",
+      "docs": "Payload emitted when an Inquiry errors.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "error",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "errorCode",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "cause",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "PersonaEnvironment",
+      "slug": "personaenvironment",
+      "docs": "Environment where Persona should run.",
+      "types": [
+        {
+          "text": "'production'",
+          "complexTypes": []
+        },
+        {
+          "text": "'sandbox'",
+          "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": "PersonaFieldValue",
+      "slug": "personafieldvalue",
+      "docs": "Supported field value types for pre-writing Inquiry fields.",
+      "types": [
+        {
+          "text": "string",
+          "complexTypes": []
+        },
+        {
+          "text": "number",
+          "complexTypes": []
+        },
+        {
+          "text": "boolean",
+          "complexTypes": []
+        },
+        {
+          "text": "string[]",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "PersonaResultFieldValue",
+      "slug": "personaresultfieldvalue",
+      "docs": "Serialized field value returned in Inquiry result callbacks.",
+      "types": [
+        {
+          "text": "string",
+          "complexTypes": []
+        },
+        {
+          "text": "number",
+          "complexTypes": []
+        },
+        {
+          "text": "boolean",
+          "complexTypes": []
+        },
+        {
+          "text": "string[]",
+          "complexTypes": []
+        },
+        {
+          "text": "null",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,106 @@
+import type { PluginListenerHandle } from '@capacitor/core';
+/**
+ * Environment where Persona should run.
+ */
+export type PersonaEnvironment = 'production' | 'sandbox';
+/**
+ * Supported field value types for pre-writing Inquiry fields.
+ */
+export type PersonaFieldValue = string | number | boolean | string[];
+/**
+ * Serialized field value returned in Inquiry result callbacks.
+ */
+export type PersonaResultFieldValue = string | number | boolean | string[] | null;
+/**
+ * Input payload used to launch an Inquiry.
+ *
+ * Provide at least one of:
+ * - `templateId`
+ * - `templateVersion`
+ * - `inquiryId`
+ */
+export interface StartInquiryOptions {
+    /**
+     * Existing Inquiry ID created on your backend.
+     */
+    inquiryId?: string;
+    /**
+     * Session token required when resuming an existing Inquiry.
+     */
+    sessionToken?: string;
+    /**
+     * Inquiry template ID from Persona Dashboard (recommended).
+     */
+    templateId?: string;
+    /**
+     * Inquiry template version ID from Persona Dashboard.
+     */
+    templateVersion?: string;
+    /**
+     * Your internal user reference.
+     */
+    referenceId?: string;
+    /**
+     * Persona account ID.
+     */
+    accountId?: string;
+    /**
+     * Persona environment.
+     *
+     * @default 'production'
+     */
+    environment?: PersonaEnvironment;
+    /**
+     * Locale override, for example `en`, `fr`, `es`.
+     */
+    locale?: string;
+    /**
+     * Optional fields pre-written into the Inquiry.
+     */
+    fields?: Record<string, PersonaFieldValue>;
+}
+/**
+ * Payload emitted when an Inquiry is completed.
+ */
+export interface InquiryCompleteInfo {
+    inquiryId: string;
+    status: string;
+    fields: Record<string, PersonaResultFieldValue>;
+}
+/**
+ * Payload emitted when an Inquiry is canceled.
+ */
+export interface InquiryCanceledInfo {
+    inquiryId?: string;
+    sessionToken?: string;
+}
+/**
+ * Payload emitted when an Inquiry errors.
+ */
+export interface InquiryErrorInfo {
+    error: string;
+    errorCode?: string;
+    cause?: string;
+}
+export interface PersonaPlugin {
+    /**
+     * Launch a Persona Inquiry flow.
+     */
+    startInquiry(options: StartInquiryOptions): Promise<void>;
+    /**
+     * Listen for successful completion.
+     */
+    addListener(eventName: 'inquiryComplete', listenerFunc: (info: InquiryCompleteInfo) => void): Promise<PluginListenerHandle>;
+    /**
+     * Listen for cancellation.
+     */
+    addListener(eventName: 'inquiryCanceled', listenerFunc: (info: InquiryCanceledInfo) => void): Promise<PluginListenerHandle>;
+    /**
+     * Listen for unrecoverable errors.
+     */
+    addListener(eventName: 'inquiryError', listenerFunc: (info: InquiryErrorInfo) => void): Promise<PluginListenerHandle>;
+    /**
+     * Remove all registered listeners for this plugin instance.
+     */
+    removeAllListeners(): Promise<void>;
+}

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":["import type { PluginListenerHandle } from '@capacitor/core';\n\n/**\n * Environment where Persona should run.\n */\nexport type PersonaEnvironment = 'production' | 'sandbox';\n\n/**\n * Supported field value types for pre-writing Inquiry fields.\n */\nexport type PersonaFieldValue = string | number | boolean | string[];\n\n/**\n * Serialized field value returned in Inquiry result callbacks.\n */\nexport type PersonaResultFieldValue = string | number | boolean | string[] | null;\n\n/**\n * Input payload used to launch an Inquiry.\n *\n * Provide at least one of:\n * - `templateId`\n * - `templateVersion`\n * - `inquiryId`\n */\nexport interface StartInquiryOptions {\n  /**\n   * Existing Inquiry ID created on your backend.\n   */\n  inquiryId?: string;\n\n  /**\n   * Session token required when resuming an existing Inquiry.\n   */\n  sessionToken?: string;\n\n  /**\n   * Inquiry template ID from Persona Dashboard (recommended).\n   */\n  templateId?: string;\n\n  /**\n   * Inquiry template version ID from Persona Dashboard.\n   */\n  templateVersion?: string;\n\n  /**\n   * Your internal user reference.\n   */\n  referenceId?: string;\n\n  /**\n   * Persona account ID.\n   */\n  accountId?: string;\n\n  /**\n   * Persona environment.\n   *\n   * @default 'production'\n   */\n  environment?: PersonaEnvironment;\n\n  /**\n   * Locale override, for example `en`, `fr`, `es`.\n   */\n  locale?: string;\n\n  /**\n   * Optional fields pre-written into the Inquiry.\n   */\n  fields?: Record<string, PersonaFieldValue>;\n}\n\n/**\n * Payload emitted when an Inquiry is completed.\n */\nexport interface InquiryCompleteInfo {\n  inquiryId: string;\n  status: string;\n  fields: Record<string, PersonaResultFieldValue>;\n}\n\n/**\n * Payload emitted when an Inquiry is canceled.\n */\nexport interface InquiryCanceledInfo {\n  inquiryId?: string;\n  sessionToken?: string;\n}\n\n/**\n * Payload emitted when an Inquiry errors.\n */\nexport interface InquiryErrorInfo {\n  error: string;\n  errorCode?: string;\n  cause?: string;\n}\n\nexport interface PersonaPlugin {\n  /**\n   * Launch a Persona Inquiry flow.\n   */\n  startInquiry(options: StartInquiryOptions): Promise<void>;\n\n  /**\n   * Listen for successful completion.\n   */\n  addListener(\n    eventName: 'inquiryComplete',\n    listenerFunc: (info: InquiryCompleteInfo) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Listen for cancellation.\n   */\n  addListener(\n    eventName: 'inquiryCanceled',\n    listenerFunc: (info: InquiryCanceledInfo) => void,\n  ): Promise<PluginListenerHandle>;\n\n  /**\n   * Listen for unrecoverable errors.\n   */\n  addListener(eventName: 'inquiryError', listenerFunc: (info: InquiryErrorInfo) => void): Promise<PluginListenerHandle>;\n\n  /**\n   * Remove all registered listeners for this plugin instance.\n   */\n  removeAllListeners(): Promise<void>;\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { PersonaPlugin } from './definitions';
+declare const Persona: PersonaPlugin;
+export * from './definitions';
+export { Persona };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const Persona = registerPlugin('Persona', {
+    web: () => import('./web').then((m) => new m.PersonaWeb()),
+});
+export * from './definitions';
+export { Persona };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,OAAO,GAAG,cAAc,CAAgB,SAAS,EAAE;IACvD,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;CAC3D,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { PersonaPlugin } from './definitions';\n\nconst Persona = registerPlugin<PersonaPlugin>('Persona', {\n  web: () => import('./web').then((m) => new m.PersonaWeb()),\n});\n\nexport * from './definitions';\nexport { Persona };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,5 @@
+import { WebPlugin } from '@capacitor/core';
+import type { PersonaPlugin, StartInquiryOptions } from './definitions';
+export declare class PersonaWeb extends WebPlugin implements PersonaPlugin {
+    startInquiry(_options: StartInquiryOptions): Promise<void>;
+}

package/dist/esm/web.js

@@ -0,0 +1,7 @@
+import { WebPlugin } from '@capacitor/core';
+export class PersonaWeb extends WebPlugin {
+    async startInquiry(_options) {
+        throw this.unavailable('Persona Inquiry is only available on iOS and Android.');
+    }
+}
+//# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,MAAM,OAAO,UAAW,SAAQ,SAAS;IACvC,KAAK,CAAC,YAAY,CAAC,QAA6B;QAC9C,MAAM,IAAI,CAAC,WAAW,CAAC,uDAAuD,CAAC,CAAC;IAClF,CAAC;CACF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type { PersonaPlugin, StartInquiryOptions } from './definitions';\n\nexport class PersonaWeb extends WebPlugin implements PersonaPlugin {\n  async startInquiry(_options: StartInquiryOptions): Promise<void> {\n    throw this.unavailable('Persona Inquiry is only available on iOS and Android.');\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -0,0 +1,21 @@
+'use strict';
+
+var core = require('@capacitor/core');
+
+const Persona = core.registerPlugin('Persona', {
+    web: () => Promise.resolve().then(function () { return web; }).then((m) => new m.PersonaWeb()),
+});
+
+class PersonaWeb extends core.WebPlugin {
+    async startInquiry(_options) {
+        throw this.unavailable('Persona Inquiry is only available on iOS and Android.');
+    }
+}
+
+var web = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    PersonaWeb: PersonaWeb
+});
+
+exports.Persona = Persona;
+//# sourceMappingURL=plugin.cjs.js.map

package/dist/plugin.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst Persona = registerPlugin('Persona', {\n    web: () => import('./web').then((m) => new m.PersonaWeb()),\n});\nexport * from './definitions';\nexport { Persona };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class PersonaWeb extends WebPlugin {\n    async startInquiry(_options) {\n        throw this.unavailable('Persona Inquiry is only available on iOS and Android.');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;AACK,MAAC,OAAO,GAAGA,mBAAc,CAAC,SAAS,EAAE;AAC1C,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;AAC9D,CAAC;;ACFM,MAAM,UAAU,SAASC,cAAS,CAAC;AAC1C,IAAI,MAAM,YAAY,CAAC,QAAQ,EAAE;AACjC,QAAQ,MAAM,IAAI,CAAC,WAAW,CAAC,uDAAuD,CAAC;AACvF,IAAI;AACJ;;;;;;;;;"}

package/dist/plugin.js

@@ -0,0 +1,24 @@
+var capacitorPersona = (function (exports, core) {
+    'use strict';
+
+    const Persona = core.registerPlugin('Persona', {
+        web: () => Promise.resolve().then(function () { return web; }).then((m) => new m.PersonaWeb()),
+    });
+
+    class PersonaWeb extends core.WebPlugin {
+        async startInquiry(_options) {
+            throw this.unavailable('Persona Inquiry is only available on iOS and Android.');
+        }
+    }
+
+    var web = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        PersonaWeb: PersonaWeb
+    });
+
+    exports.Persona = Persona;
+
+    return exports;
+
+})({}, capacitorExports);
+//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst Persona = registerPlugin('Persona', {\n    web: () => import('./web').then((m) => new m.PersonaWeb()),\n});\nexport * from './definitions';\nexport { Persona };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class PersonaWeb extends WebPlugin {\n    async startInquiry(_options) {\n        throw this.unavailable('Persona Inquiry is only available on iOS and Android.');\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,OAAO,GAAGA,mBAAc,CAAC,SAAS,EAAE;IAC1C,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;IAC9D,CAAC;;ICFM,MAAM,UAAU,SAASC,cAAS,CAAC;IAC1C,IAAI,MAAM,YAAY,CAAC,QAAQ,EAAE;IACjC,QAAQ,MAAM,IAAI,CAAC,WAAW,CAAC,uDAAuD,CAAC;IACvF,IAAI;IACJ;;;;;;;;;;;;;;;"}