capacitor-gleap-plugin 7.0.0

package/dist/docs.json

@@ -0,0 +1,411 @@
+{
+  "api": {
+    "name": "GleapPlugin",
+    "slug": "gleapplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "initialize",
+        "signature": "(options: { API_KEY: string; }) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ API_KEY: string; }"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Initialize Gleap with an API key",
+        "complexTypes": [],
+        "slug": "initialize"
+      },
+      {
+        "name": "identify",
+        "signature": "(options: { userId: string; userHash?: string; name?: string; email?: string; phone?: string; value?: number; }) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ userId: string; userHash?: string | undefined; name?: string | undefined; email?: string | undefined; phone?: string | undefined; value?: number | undefined; }"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Set user identity",
+        "complexTypes": [],
+        "slug": "identify"
+      },
+      {
+        "name": "clearIdentity",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Clear user identity",
+        "complexTypes": [],
+        "slug": "clearidentity"
+      },
+      {
+        "name": "log",
+        "signature": "(options: { message: string; logLevel?: \"ERROR\" | \"WARNING\" | \"INFO\"; }) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ message: string; logLevel?: \"ERROR\" | \"WARNING\" | \"INFO\" | undefined; }"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Submit a custom log message with the given level",
+        "complexTypes": [],
+        "slug": "log"
+      },
+      {
+        "name": "attachCustomData",
+        "signature": "(options: { data: any; }) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ data: any; }"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Add custom data",
+        "complexTypes": [],
+        "slug": "attachcustomdata"
+      },
+      {
+        "name": "setCustomData",
+        "signature": "(options: { key: string; value: string; }) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ key: string; value: string; }"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Set custom data",
+        "complexTypes": [],
+        "slug": "setcustomdata"
+      },
+      {
+        "name": "removeCustomData",
+        "signature": "(options: { key: string; }) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ key: string; }"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Remove custom data by key",
+        "complexTypes": [],
+        "slug": "removecustomdata"
+      },
+      {
+        "name": "clearCustomData",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Clear custom data",
+        "complexTypes": [],
+        "slug": "clearcustomdata"
+      },
+      {
+        "name": "logEvent",
+        "signature": "(options: { name: string; data?: any; }) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ name: string; data?: any; }"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Log event to Gleap",
+        "complexTypes": [],
+        "slug": "logevent"
+      },
+      {
+        "name": "setEventCallback",
+        "signature": "(callback: GleapEventCallback) => any",
+        "parameters": [
+          {
+            "name": "callback",
+            "docs": "",
+            "type": "(name: string, data?: any) => void"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "",
+        "complexTypes": [
+          "GleapEventCallback",
+          "CallbackID"
+        ],
+        "slug": "seteventcallback"
+      },
+      {
+        "name": "sendSilentCrashReport",
+        "signature": "(options: { description: string; severity?: \"LOW\" | \"MEDIUM\" | \"HIGH\"; dataExclusion?: { customData: Boolean; metaData: Boolean; attachments: Boolean; consoleLog: Boolean; networkLogs: Boolean; customEventLog: Boolean; screenshot: Boolean; replays: Boolean; }; }) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ description: string; severity?: \"LOW\" | \"MEDIUM\" | \"HIGH\" | undefined; dataExclusion?: { customData: any; metaData: any; attachments: any; consoleLog: any; networkLogs: any; customEventLog: any; screenshot: any; replays: any; } | undefined; }"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Log event to Gleap",
+        "complexTypes": [
+          "Boolean"
+        ],
+        "slug": "sendsilentcrashreport"
+      },
+      {
+        "name": "preFillForm",
+        "signature": "(options: { data: any; }) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ data: any; }"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Prefills the widget's form data",
+        "complexTypes": [],
+        "slug": "prefillform"
+      },
+      {
+        "name": "addAttachment",
+        "signature": "(options: { base64data: string; name: string; }) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ base64data: string; name: string; }"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Add attachment as bas64 string",
+        "complexTypes": [],
+        "slug": "addattachment"
+      },
+      {
+        "name": "removeAllAttachments",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "All attachments removed",
+        "complexTypes": [],
+        "slug": "removeallattachments"
+      },
+      {
+        "name": "open",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Open widget",
+        "complexTypes": [],
+        "slug": "open"
+      },
+      {
+        "name": "close",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Close widget",
+        "complexTypes": [],
+        "slug": "close"
+      },
+      {
+        "name": "isOpened",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Check widget status code",
+        "complexTypes": [],
+        "slug": "isopened"
+      },
+      {
+        "name": "startFeedbackFlow",
+        "signature": "(options: { feedbackFlow?: string; showBackButton?: boolean; }) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ feedbackFlow?: string | undefined; showBackButton?: boolean | undefined; }"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Start Feedback flow",
+        "complexTypes": [],
+        "slug": "startfeedbackflow"
+      },
+      {
+        "name": "setLanguage",
+        "signature": "(options: { languageCode: string; }) => any",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ languageCode: string; }"
+          }
+        ],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Set Language",
+        "complexTypes": [],
+        "slug": "setlanguage"
+      },
+      {
+        "name": "disableConsoleLogOverwrite",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Disable console log overwrite",
+        "complexTypes": [],
+        "slug": "disableconsolelogoverwrite"
+      },
+      {
+        "name": "enableDebugConsoleLog",
+        "signature": "() => any",
+        "parameters": [],
+        "returns": "any",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.0.0"
+          }
+        ],
+        "docs": "Enable debug console log",
+        "complexTypes": [],
+        "slug": "enabledebugconsolelog"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [],
+  "enums": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,215 @@
+export declare type CallbackID = string;
+export declare type GleapEventCallback = (name: string, data?: any) => void;
+export interface GleapPlugin {
+    /**
+    * Initialize Gleap with an API key
+    *
+    * @since 7.0.0
+    */
+    initialize(options: {
+        API_KEY: string;
+    }): Promise<{
+        initialized: boolean;
+    }>;
+    /**
+    * Set user identity
+    *
+    * @since 7.0.0
+    */
+    identify(options: {
+        userId: string;
+        userHash?: string;
+        name?: string;
+        email?: string;
+        phone?: string;
+        value?: number;
+    }): Promise<{
+        identify: boolean;
+    }>;
+    /**
+    * Clear user identity
+    *
+    * @since 7.0.0
+    */
+    clearIdentity(): Promise<{
+        clearIdentity: boolean;
+    }>;
+    /**
+    * Submit a custom log message with the given level
+    *
+    * @since 7.0.0
+    */
+    log(options: {
+        message: string;
+        logLevel?: "ERROR" | "WARNING" | "INFO";
+    }): Promise<{
+        logged: boolean;
+    }>;
+    /**
+    * Add custom data
+    *
+    * @since 7.0.0
+    */
+    attachCustomData(options: {
+        data: any;
+    }): Promise<{
+        attachedCustomData: boolean;
+    }>;
+    /**
+    * Set custom data
+    *
+    * @since 7.0.0
+    */
+    setCustomData(options: {
+        key: string;
+        value: string;
+    }): Promise<{
+        setCustomData: boolean;
+    }>;
+    /**
+    * Remove custom data by key
+    *
+    * @since 7.0.0
+    */
+    removeCustomData(options: {
+        key: string;
+    }): Promise<{
+        removedCustomData: boolean;
+    }>;
+    /**
+    * Clear custom data
+    *
+    * @since 7.0.0
+    */
+    clearCustomData(): Promise<{
+        clearedCustomData: boolean;
+    }>;
+    /**
+    * Log event to Gleap
+    *
+    * @since 7.0.0
+    */
+    logEvent(options: {
+        name: string;
+        data?: any;
+    }): Promise<{
+        loggedEvent: boolean;
+    }>;
+    /**
+     *
+     *
+     * @since 7.0.0
+     */
+    setEventCallback(callback: GleapEventCallback): Promise<CallbackID>;
+    /**
+   * Log event to Gleap
+   *
+   * @since 7.0.0
+   */
+    sendSilentCrashReport(options: {
+        description: string;
+        severity?: "LOW" | "MEDIUM" | "HIGH";
+        dataExclusion?: {
+            customData: Boolean;
+            metaData: Boolean;
+            attachments: Boolean;
+            consoleLog: Boolean;
+            networkLogs: Boolean;
+            customEventLog: Boolean;
+            screenshot: Boolean;
+            replays: Boolean;
+        };
+    }): Promise<{
+        sentSilentBugReport: boolean;
+    }>;
+    /**
+    * Prefills the widget's form data
+    *
+    * @since 7.0.0
+    */
+    preFillForm(options: {
+        data: any;
+    }): Promise<{
+        preFilledForm: boolean;
+    }>;
+    /**
+    * Add attachment as bas64 string
+    *
+    * @since 7.0.0
+    */
+    addAttachment(options: {
+        base64data: string;
+        name: string;
+    }): Promise<{
+        attachmentAdded: boolean;
+    }>;
+    /**
+    * All attachments removed
+    *
+    * @since 7.0.0
+    */
+    removeAllAttachments(): Promise<{
+        allAttachmentsRemoved: boolean;
+    }>;
+    /**
+    * Open widget
+    *
+    * @since 7.0.0
+    */
+    open(): Promise<{
+        openedWidget: boolean;
+    }>;
+    /**
+    * Close widget
+    *
+    * @since 7.0.0
+    */
+    close(): Promise<{
+        closedWidget: boolean;
+    }>;
+    /**
+    * Check widget status code
+    *
+    * @since 7.0.0
+    */
+    isOpened(): Promise<{
+        isOpened: boolean;
+    }>;
+    /**
+   * Start Feedback flow
+   *
+   * @since 7.0.0
+   */
+    startFeedbackFlow(options: {
+        feedbackFlow?: string;
+        showBackButton?: boolean;
+    }): Promise<{
+        startedFeedbackFlow: boolean;
+    }>;
+    /**
+   * Set Language
+   *
+   * @since 7.0.0
+   */
+    setLanguage(options: {
+        languageCode: string;
+    }): Promise<{
+        setLanguage: string;
+    }>;
+    /**
+   * Disable console log overwrite
+   *
+   * @since 7.0.0
+   */
+    disableConsoleLogOverwrite(): Promise<{
+        consoleLogDisabled: boolean;
+    }>;
+    /**
+   * Enable debug console log
+   *
+   * @since 7.0.0
+   */
+    enableDebugConsoleLog(): Promise<{
+        debugConsoleLogEnabled: boolean;
+    }>;
+}

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":""}

package/dist/esm/index.d.ts

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

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const Gleap = registerPlugin('Gleap', {
+    web: () => import('./web').then(m => new m.GleapWeb()),
+});
+export * from './definitions';
+export { Gleap };
+//# 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,KAAK,GAAG,cAAc,CAAc,OAAO,EAAE;IACjD,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;CACvD,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,KAAK,EAAE,CAAC"}