v14.5.4

Author: boehlerlukas

index.d.ts

@@ -137,7 +137,7 @@ export namespace Gleap {
   function open(): void;
   function openChecklists(showBackButton?: boolean): void;
   function openChecklist(checklistId: string, showBackButton?: boolean): void;
-  function startChecklist(outboundId: string, showBackButton?: boolean): void;
+  function startChecklist(outboundId: string, showBackButton?: boolean, sharedKey?: string): void;
   function openNews(showBackButton?: boolean): void;
   function openNewsArticle(id: string, showBackButton?: boolean): void;
   function openConversations(showBackButton?: boolean): void;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gleap",
-  "version": "14.5.3",
+  "version": "14.5.4",
   "main": "build/cjs/index.js",
   "module": "build/esm/index.mjs",
   "exports": {

src/Gleap.js

@@ -1035,7 +1035,11 @@ class Gleap {
   /**
    * Starts a new checklist and opens it.
    */
-  static startChecklist(outboundId, showBackButton = true) {
+  static startChecklist(
+    outboundId,
+    showBackButton = true,
+    sharedKey = undefined
+  ) {
     if (!outboundId) {
       return false;
     }
@@ -1046,6 +1050,8 @@ class Gleap {
         name: "start-checklist",
         data: {
           outboundId: outboundId,
+          hideBackButton: !showBackButton,
+          ...(sharedKey ? { sharedKey: sharedKey } : {}),
         },
       },
       true
@@ -1296,7 +1302,7 @@ const handleGleapLink = (href) => {
 
     if (type === "checklist") {
       const identifier = urlParts[3];
-      Gleap.startChecklist(identifier, true);
+      Gleap.startChecklist(identifier, true, urlParts[4]);
     }
 
     if (type === "tour") {

src/GleapBannerManager.js

@@ -72,7 +72,7 @@ export default class GleapBannerManager {
           Gleap.openHelpCenterArticle(data.data?.articleId);
         }
         if (data.name === "show-checklist") {
-          Gleap.startChecklist(data.data?.checklistId);
+          Gleap.startChecklist(data.data?.checklistId, true, data.data?.sharedKey);
         }
       } catch (exp) {}
     });

src/GleapChecklist.js

@@ -1156,7 +1156,7 @@ export const registerGleapChecklist = () => {
                 else if (step.action === "HELP_ARTICLE")
                   Gleap.openHelpCenterArticle(step.articleId);
                 else if (step.action === "CHECKLIST")
-                  Gleap.startChecklist(step.checklistId);
+                  Gleap.startChecklist(step.checklistId, true, step?.sharedKey);
               } catch (gleapError) {}
             });
           }