capacitor-gleap-plugin 8.2.5 → 8.4.1

package/dist/docs.json

@@ -28,12 +28,12 @@
       },
       {
         "name": "identify",
-        "signature": "(options: { userId: string; userHash?: string; name?: string; email?: string; phone?: string; value?: number; }) => Promise<{ identify: boolean; }>",
+        "signature": "(options: { userId: string; userHash?: string; name?: string; email?: string; phone?: string; value?: number; customData?: Object; }) => Promise<{ identify: boolean; }>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "{ userId: string; userHash?: string | undefined; name?: string | undefined; email?: string | undefined; phone?: string | undefined; value?: number | undefined; }"
+            "type": "{ userId: string; userHash?: string | undefined; name?: string | undefined; email?: string | undefined; phone?: string | undefined; value?: number | undefined; customData?: Object | undefined; }"
           }
         ],
         "returns": "Promise<{ identify: boolean; }>",
@@ -44,7 +44,9 @@
           }
         ],
         "docs": "Set user identity",
-        "complexTypes": [],
+        "complexTypes": [
+          "Object"
+        ],
         "slug": "identify"
       },
       {
@@ -212,6 +214,27 @@
         "complexTypes": [],
         "slug": "trackevent"
       },
+      {
+        "name": "trackPage",
+        "signature": "(options: { pageName: string; }) => Promise<{ trackedPage: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ pageName: string; }"
+          }
+        ],
+        "returns": "Promise<{ trackedPage: boolean; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.4.1"
+          }
+        ],
+        "docs": "Track a page view",
+        "complexTypes": [],
+        "slug": "trackpage"
+      },
       {
         "name": "setEventCallback",
         "signature": "(callback: GleapEventCallback) => Promise<CallbackID>",
@@ -333,28 +356,145 @@
       },
       {
         "name": "openNews",
-        "signature": "() => Promise<{ openedNews: boolean; }>",
-        "parameters": [],
+        "signature": "(options: { showBackButton?: boolean; }) => Promise<{ openedNews: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ showBackButton?: boolean | undefined; }"
+          }
+        ],
         "returns": "Promise<{ openedNews: boolean; }>",
         "tags": [
           {
             "name": "since",
-            "text": "8.0.4"
+            "text": "8.4.0"
           }
         ],
         "docs": "Open news",
         "complexTypes": [],
         "slug": "opennews"
       },
+      {
+        "name": "openNewsArticle",
+        "signature": "(options: { articleId: string; showBackButton?: boolean; }) => Promise<{ opened: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ articleId: string; showBackButton?: boolean | undefined; }"
+          }
+        ],
+        "returns": "Promise<{ opened: boolean; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.4.0"
+          }
+        ],
+        "docs": "Open news article",
+        "complexTypes": [],
+        "slug": "opennewsarticle"
+      },
+      {
+        "name": "openHelpCenter",
+        "signature": "(options: { showBackButton?: boolean; }) => Promise<{ opened: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ showBackButton?: boolean | undefined; }"
+          }
+        ],
+        "returns": "Promise<{ opened: boolean; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.4.0"
+          }
+        ],
+        "docs": "Open help center",
+        "complexTypes": [],
+        "slug": "openhelpcenter"
+      },
+      {
+        "name": "openHelpCenterArticle",
+        "signature": "(options: { articleId: string; showBackButton?: boolean; }) => Promise<{ opened: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ articleId: string; showBackButton?: boolean | undefined; }"
+          }
+        ],
+        "returns": "Promise<{ opened: boolean; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.4.0"
+          }
+        ],
+        "docs": "Open help center article",
+        "complexTypes": [],
+        "slug": "openhelpcenterarticle"
+      },
+      {
+        "name": "openHelpCenterCollection",
+        "signature": "(options: { collectionId: string; showBackButton?: boolean; }) => Promise<{ opened: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ collectionId: string; showBackButton?: boolean | undefined; }"
+          }
+        ],
+        "returns": "Promise<{ opened: boolean; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.4.0"
+          }
+        ],
+        "docs": "Open help center collection",
+        "complexTypes": [],
+        "slug": "openhelpcentercollection"
+      },
+      {
+        "name": "searchHelpCenter",
+        "signature": "(options: { term: string; showBackButton?: boolean; }) => Promise<{ opened: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ term: string; showBackButton?: boolean | undefined; }"
+          }
+        ],
+        "returns": "Promise<{ opened: boolean; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.4.0"
+          }
+        ],
+        "docs": "Search help center",
+        "complexTypes": [],
+        "slug": "searchhelpcenter"
+      },
       {
         "name": "openFeatureRequests",
-        "signature": "() => Promise<{ openedFeatureRequests: boolean; }>",
-        "parameters": [],
+        "signature": "(options: { showBackButton?: boolean; }) => Promise<{ openedFeatureRequests: boolean; }>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "{ showBackButton?: boolean | undefined; }"
+          }
+        ],
         "returns": "Promise<{ openedFeatureRequests: boolean; }>",
         "tags": [
           {
             "name": "since",
-            "text": "8.0.5"
+            "text": "8.4.0"
           }
         ],
         "docs": "Open feature requests",
@@ -488,6 +628,272 @@
     "properties": []
   },
   "interfaces": [
+    {
+      "name": "Object",
+      "slug": "object",
+      "docs": "Provides functionality common to all JavaScript objects.",
+      "tags": [],
+      "methods": [
+        {
+          "name": "toString",
+          "signature": "() => string",
+          "parameters": [],
+          "returns": "string",
+          "tags": [],
+          "docs": "Returns a string representation of an object.",
+          "complexTypes": [],
+          "slug": "tostring"
+        },
+        {
+          "name": "toLocaleString",
+          "signature": "() => string",
+          "parameters": [],
+          "returns": "string",
+          "tags": [],
+          "docs": "Returns a date converted to a string using the current locale.",
+          "complexTypes": [],
+          "slug": "tolocalestring"
+        },
+        {
+          "name": "valueOf",
+          "signature": "() => Object",
+          "parameters": [],
+          "returns": "Object",
+          "tags": [],
+          "docs": "Returns the primitive value of the specified object.",
+          "complexTypes": [
+            "Object"
+          ],
+          "slug": "valueof"
+        },
+        {
+          "name": "hasOwnProperty",
+          "signature": "(v: PropertyKey) => boolean",
+          "parameters": [
+            {
+              "name": "v",
+              "docs": "A property name.",
+              "type": "string | number | symbol"
+            }
+          ],
+          "returns": "boolean",
+          "tags": [
+            {
+              "name": "param",
+              "text": "v A property name."
+            }
+          ],
+          "docs": "Determines whether an object has a property with the specified name.",
+          "complexTypes": [
+            "PropertyKey"
+          ],
+          "slug": "hasownproperty"
+        },
+        {
+          "name": "isPrototypeOf",
+          "signature": "(v: Object) => boolean",
+          "parameters": [
+            {
+              "name": "v",
+              "docs": "Another object whose prototype chain is to be checked.",
+              "type": "Object"
+            }
+          ],
+          "returns": "boolean",
+          "tags": [
+            {
+              "name": "param",
+              "text": "v Another object whose prototype chain is to be checked."
+            }
+          ],
+          "docs": "Determines whether an object exists in another object's prototype chain.",
+          "complexTypes": [
+            "Object"
+          ],
+          "slug": "isprototypeof"
+        },
+        {
+          "name": "propertyIsEnumerable",
+          "signature": "(v: PropertyKey) => boolean",
+          "parameters": [
+            {
+              "name": "v",
+              "docs": "A property name.",
+              "type": "string | number | symbol"
+            }
+          ],
+          "returns": "boolean",
+          "tags": [
+            {
+              "name": "param",
+              "text": "v A property name."
+            }
+          ],
+          "docs": "Determines whether a specified property is enumerable.",
+          "complexTypes": [
+            "PropertyKey"
+          ],
+          "slug": "propertyisenumerable"
+        }
+      ],
+      "properties": [
+        {
+          "name": "constructor",
+          "tags": [],
+          "docs": "The initial value of Object.prototype.constructor is the standard built-in Object constructor.",
+          "complexTypes": [
+            "Function"
+          ],
+          "type": "Function"
+        }
+      ]
+    },
+    {
+      "name": "Function",
+      "slug": "function",
+      "docs": "Creates a new function.",
+      "tags": [],
+      "methods": [
+        {
+          "name": "apply",
+          "signature": "(this: Function, thisArg: any, argArray?: any) => any",
+          "parameters": [
+            {
+              "name": "thisArg",
+              "docs": "The object to be used as the this object.",
+              "type": "any"
+            },
+            {
+              "name": "argArray",
+              "docs": "A set of arguments to be passed to the function.",
+              "type": "any"
+            }
+          ],
+          "returns": "any",
+          "tags": [
+            {
+              "name": "param",
+              "text": "thisArg The object to be used as the this object."
+            },
+            {
+              "name": "param",
+              "text": "argArray A set of arguments to be passed to the function."
+            }
+          ],
+          "docs": "Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.",
+          "complexTypes": [
+            "Function"
+          ],
+          "slug": "apply"
+        },
+        {
+          "name": "call",
+          "signature": "(this: Function, thisArg: any, ...argArray: any[]) => any",
+          "parameters": [
+            {
+              "name": "thisArg",
+              "docs": "The object to be used as the current object.",
+              "type": "any"
+            },
+            {
+              "name": "argArray",
+              "docs": "A list of arguments to be passed to the method.",
+              "type": "any[]"
+            }
+          ],
+          "returns": "any",
+          "tags": [
+            {
+              "name": "param",
+              "text": "thisArg The object to be used as the current object."
+            },
+            {
+              "name": "param",
+              "text": "argArray A list of arguments to be passed to the method."
+            }
+          ],
+          "docs": "Calls a method of an object, substituting another object for the current object.",
+          "complexTypes": [
+            "Function"
+          ],
+          "slug": "call"
+        },
+        {
+          "name": "bind",
+          "signature": "(this: Function, thisArg: any, ...argArray: any[]) => any",
+          "parameters": [
+            {
+              "name": "thisArg",
+              "docs": "An object to which the this keyword can refer inside the new function.",
+              "type": "any"
+            },
+            {
+              "name": "argArray",
+              "docs": "A list of arguments to be passed to the new function.",
+              "type": "any[]"
+            }
+          ],
+          "returns": "any",
+          "tags": [
+            {
+              "name": "param",
+              "text": "thisArg An object to which the this keyword can refer inside the new function."
+            },
+            {
+              "name": "param",
+              "text": "argArray A list of arguments to be passed to the new function."
+            }
+          ],
+          "docs": "For a given function, creates a bound function that has the same body as the original function.\r\nThe this object of the bound function is associated with the specified object, and has the specified initial parameters.",
+          "complexTypes": [
+            "Function"
+          ],
+          "slug": "bind"
+        },
+        {
+          "name": "toString",
+          "signature": "() => string",
+          "parameters": [],
+          "returns": "string",
+          "tags": [],
+          "docs": "Returns a string representation of a function.",
+          "complexTypes": [],
+          "slug": "tostring"
+        }
+      ],
+      "properties": [
+        {
+          "name": "prototype",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "any"
+        },
+        {
+          "name": "length",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "arguments",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "any"
+        },
+        {
+          "name": "caller",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "Function"
+          ],
+          "type": "Function"
+        }
+      ]
+    },
     {
       "name": "Boolean",
       "slug": "boolean",

package/dist/esm/definitions.d.ts

@@ -23,6 +23,7 @@ export interface GleapPlugin {
         email?: string;
         phone?: string;
         value?: number;
+        customData?: Object;
     }): Promise<{
         identify: boolean;
     }>;
@@ -117,6 +118,16 @@ export interface GleapPlugin {
     }): Promise<{
         loggedEvent: boolean;
     }>;
+    /**
+    * Track a page view
+    *
+    * @since 8.4.1
+    */
+    trackPage(options: {
+        pageName: string;
+    }): Promise<{
+        trackedPage: boolean;
+    }>;
     /**
      *
      *
@@ -184,17 +195,75 @@ export interface GleapPlugin {
     /**
     * Open news
     *
-    * @since 8.0.4
+    * @since 8.4.0
     */
-    openNews(): Promise<{
+    openNews(options: {
+        showBackButton?: boolean;
+    }): Promise<{
         openedNews: boolean;
     }>;
     /**
+    * Open news article
+    *
+    * @since 8.4.0
+    */
+    openNewsArticle(options: {
+        articleId: string;
+        showBackButton?: boolean;
+    }): Promise<{
+        opened: boolean;
+    }>;
+    /**
+    * Open help center
+    *
+    * @since 8.4.0
+    */
+    openHelpCenter(options: {
+        showBackButton?: boolean;
+    }): Promise<{
+        opened: boolean;
+    }>;
+    /**
+    * Open help center article
+    *
+    * @since 8.4.0
+    */
+    openHelpCenterArticle(options: {
+        articleId: string;
+        showBackButton?: boolean;
+    }): Promise<{
+        opened: boolean;
+    }>;
+    /**
+    * Open help center collection
+    *
+    * @since 8.4.0
+    */
+    openHelpCenterCollection(options: {
+        collectionId: string;
+        showBackButton?: boolean;
+    }): Promise<{
+        opened: boolean;
+    }>;
+    /**
+    * Search help center
+    *
+    * @since 8.4.0
+    */
+    searchHelpCenter(options: {
+        term: string;
+        showBackButton?: boolean;
+    }): Promise<{
+        opened: boolean;
+    }>;
+    /**
     * Open feature requests
     *
-    * @since 8.0.5
+    * @since 8.4.0
     */
-    openFeatureRequests(): Promise<{
+    openFeatureRequests(options: {
+        showBackButton?: boolean;
+    }): Promise<{
         openedFeatureRequests: boolean;
     }>;
     /**

package/dist/esm/web.d.ts

@@ -20,6 +20,7 @@ export declare class GleapWeb extends WebPlugin implements GleapPlugin {
     identify(options: {
         userId: string;
         userHash?: string | undefined;
+        customData?: Object | undefined;
         name?: string | undefined;
         email?: string | undefined;
         phone?: string | undefined;
@@ -67,6 +68,11 @@ export declare class GleapWeb extends WebPlugin implements GleapPlugin {
     }): Promise<{
         loggedEvent: boolean;
     }>;
+    trackPage(options: {
+        pageName: string;
+    }): Promise<{
+        trackedPage: boolean;
+    }>;
     startFeedbackFlow(options: {
         feedbackFlow?: string | undefined;
         showBackButton?: boolean | undefined;
@@ -104,12 +110,45 @@ export declare class GleapWeb extends WebPlugin implements GleapPlugin {
     open(): Promise<{
         openedWidget: boolean;
     }>;
-    openFeatureRequests(): Promise<{
+    openFeatureRequests(options: {
+        showBackButton?: boolean | undefined;
+    }): Promise<{
         openedFeatureRequests: boolean;
     }>;
-    openNews(): Promise<{
+    openNews(options: {
+        showBackButton?: boolean | undefined;
+    }): Promise<{
         openedNews: boolean;
     }>;
+    openNewsArticle(options: {
+        articleId: string;
+        showBackButton?: boolean | undefined;
+    }): Promise<{
+        opened: boolean;
+    }>;
+    openHelpCenter(options: {
+        showBackButton?: boolean | undefined;
+    }): Promise<{
+        opened: boolean;
+    }>;
+    openHelpCenterArticle(options: {
+        articleId: string;
+        showBackButton?: boolean | undefined;
+    }): Promise<{
+        opened: boolean;
+    }>;
+    openHelpCenterCollection(options: {
+        collectionId: string;
+        showBackButton?: boolean | undefined;
+    }): Promise<{
+        opened: boolean;
+    }>;
+    searchHelpCenter(options: {
+        term: string;
+        showBackButton?: boolean | undefined;
+    }): Promise<{
+        opened: boolean;
+    }>;
     close(): Promise<{
         closedWidget: boolean;
     }>;