@blotoutio/providers-shop-gpt-sdk 1.31.2 → 1.31.4

package/index.cjs.js

@@ -473,6 +473,50 @@ new Set([
     'orderPlaced',
 ]);
 
+const checkBotVisibility = ({ botVisibilityConditions, currentUrl, }) => {
+    const result = {
+        shouldHideBot: false,
+    };
+    if (!(botVisibilityConditions === null || botVisibilityConditions === void 0 ? void 0 : botVisibilityConditions.hideBot)) {
+        return result;
+    }
+    if (botVisibilityConditions.urlSearchParamExclusion &&
+        botVisibilityConditions.urlSearchParamExclusion.length > 0) {
+        const urlSearchParamExclusionResult = checkURLSearchParamExclusion(botVisibilityConditions.urlSearchParamExclusion, currentUrl);
+        if (urlSearchParamExclusionResult.isExcluded) {
+            return {
+                shouldHideBot: true,
+                reason: 'URL search parameters matched exclusion criteria',
+                matchedParams: urlSearchParamExclusionResult.matchedParams,
+            };
+        }
+    }
+    return result;
+};
+const checkURLSearchParamExclusion = (excludeParams, currentUrl) => {
+    const result = {
+        isExcluded: false,
+        matchedParams: [],
+    };
+    if (!excludeParams || excludeParams.length === 0) {
+        return result;
+    }
+    try {
+        const url = new URL(currentUrl);
+        const urlParams = new URLSearchParams(url.search);
+        const matchedParams = excludeParams.filter((param) => {
+            return urlParams.has(param);
+        });
+        return {
+            isExcluded: matchedParams.length > 0,
+            matchedParams,
+        };
+    }
+    catch (error) {
+        return result;
+    }
+};
+
 const packageName = 'shopGPT';
 const DEFAULT_MAX_THREAD_AGE = 14; // in days
 const DEFAULT_NUDGE_TIMEOUT = 10; // in seconds
@@ -1018,7 +1062,20 @@ const init = (params) => {
             error('Error in setting the sessionStorage for previewShopGPT');
         }
     }
-    const { enabled, mode, devMode, merchantUrl, profiles, productHandles, targetPath, view, brandName, quickPrompts, supportPrompts, searchSuggestions, merchantImage, latestThreadLoad, botIconUrl, css, nudge, loadUIManually, metafieldDisplayName, showClassicChatbot, chatbotIconType, } = (_c = params.manifest.variables) !== null && _c !== void 0 ? _c : {};
+    const { enabled, mode, devMode, merchantUrl, profiles, productHandles, targetPath, view, brandName, quickPrompts, supportPrompts, searchSuggestions, merchantImage, latestThreadLoad, botIconUrl, css, nudge, loadUIManually, metafieldDisplayName, showClassicChatbot, chatbotIconType, botVisibilityConditions, } = (_c = params.manifest.variables) !== null && _c !== void 0 ? _c : {};
+    let shouldHideBot = false;
+    if (botVisibilityConditions) {
+        const visibilityResult = checkBotVisibility({
+            botVisibilityConditions,
+            currentUrl: window.location.href,
+        });
+        if (visibilityResult.shouldHideBot) {
+            logger.log(`ShopGPT disabled: ${visibilityResult.reason}${visibilityResult.matchedParams
+                ? ` (${visibilityResult.matchedParams.join(', ')})`
+                : ''}`);
+            shouldHideBot = true;
+        }
+    }
     const experiment = createExperiment({
         name: getExperimentName(mode),
         userId: params.userId,
@@ -1027,7 +1084,7 @@ const init = (params) => {
             ? (_d = params.manifest.variables) === null || _d === void 0 ? void 0 : _d.rolloutPercentage
             : undefined,
     });
-    const shouldShowUI = enabled || experiment.isEnabled;
+    const shouldShowUI = (enabled || experiment.isEnabled) && !shouldHideBot;
     if (experiment.name === 'preview' && shouldShowUI) {
         logger.log('Enabling UI in preview mode');
     }
@@ -11114,8 +11171,12 @@ class ShopGPT extends i$1 {
             const hasSource = searchParams.get('utm_source') === 'shopgpt';
             const isDesktop = window.innerWidth > 768;
             const wasModalOpen = isModalOpen(this.destination);
-            // If the url has `utm_source` open the popup when reloaded
-            if ((hasSource && isDesktop) || wasModalOpen) {
+            // If user came from ShopGPT product recommendation, don't open modal
+            if (hasSource) {
+                return;
+            }
+            // For non-product pages, check session storage to restore modal state
+            if (wasModalOpen && isDesktop) {
                 this.modalState = 'open';
                 setUserInteracted(this.destination);
             }

package/index.js

@@ -474,6 +474,50 @@ var ProvidersShopGptSdk = (function () {
         'orderPlaced',
     ]);
 
+    const checkBotVisibility = ({ botVisibilityConditions, currentUrl, }) => {
+        const result = {
+            shouldHideBot: false,
+        };
+        if (!(botVisibilityConditions === null || botVisibilityConditions === void 0 ? void 0 : botVisibilityConditions.hideBot)) {
+            return result;
+        }
+        if (botVisibilityConditions.urlSearchParamExclusion &&
+            botVisibilityConditions.urlSearchParamExclusion.length > 0) {
+            const urlSearchParamExclusionResult = checkURLSearchParamExclusion(botVisibilityConditions.urlSearchParamExclusion, currentUrl);
+            if (urlSearchParamExclusionResult.isExcluded) {
+                return {
+                    shouldHideBot: true,
+                    reason: 'URL search parameters matched exclusion criteria',
+                    matchedParams: urlSearchParamExclusionResult.matchedParams,
+                };
+            }
+        }
+        return result;
+    };
+    const checkURLSearchParamExclusion = (excludeParams, currentUrl) => {
+        const result = {
+            isExcluded: false,
+            matchedParams: [],
+        };
+        if (!excludeParams || excludeParams.length === 0) {
+            return result;
+        }
+        try {
+            const url = new URL(currentUrl);
+            const urlParams = new URLSearchParams(url.search);
+            const matchedParams = excludeParams.filter((param) => {
+                return urlParams.has(param);
+            });
+            return {
+                isExcluded: matchedParams.length > 0,
+                matchedParams,
+            };
+        }
+        catch (error) {
+            return result;
+        }
+    };
+
     const packageName = 'shopGPT';
     const DEFAULT_MAX_THREAD_AGE = 14; // in days
     const DEFAULT_NUDGE_TIMEOUT = 10; // in seconds
@@ -1019,7 +1063,20 @@ var ProvidersShopGptSdk = (function () {
                 error('Error in setting the sessionStorage for previewShopGPT');
             }
         }
-        const { enabled, mode, devMode, merchantUrl, profiles, productHandles, targetPath, view, brandName, quickPrompts, supportPrompts, searchSuggestions, merchantImage, latestThreadLoad, botIconUrl, css, nudge, loadUIManually, metafieldDisplayName, showClassicChatbot, chatbotIconType, } = (_c = params.manifest.variables) !== null && _c !== void 0 ? _c : {};
+        const { enabled, mode, devMode, merchantUrl, profiles, productHandles, targetPath, view, brandName, quickPrompts, supportPrompts, searchSuggestions, merchantImage, latestThreadLoad, botIconUrl, css, nudge, loadUIManually, metafieldDisplayName, showClassicChatbot, chatbotIconType, botVisibilityConditions, } = (_c = params.manifest.variables) !== null && _c !== void 0 ? _c : {};
+        let shouldHideBot = false;
+        if (botVisibilityConditions) {
+            const visibilityResult = checkBotVisibility({
+                botVisibilityConditions,
+                currentUrl: window.location.href,
+            });
+            if (visibilityResult.shouldHideBot) {
+                logger.log(`ShopGPT disabled: ${visibilityResult.reason}${visibilityResult.matchedParams
+                ? ` (${visibilityResult.matchedParams.join(', ')})`
+                : ''}`);
+                shouldHideBot = true;
+            }
+        }
         const experiment = createExperiment({
             name: getExperimentName(mode),
             userId: params.userId,
@@ -1028,7 +1085,7 @@ var ProvidersShopGptSdk = (function () {
                 ? (_d = params.manifest.variables) === null || _d === void 0 ? void 0 : _d.rolloutPercentage
                 : undefined,
         });
-        const shouldShowUI = enabled || experiment.isEnabled;
+        const shouldShowUI = (enabled || experiment.isEnabled) && !shouldHideBot;
         if (experiment.name === 'preview' && shouldShowUI) {
             logger.log('Enabling UI in preview mode');
         }
@@ -11115,8 +11172,12 @@ ${this.comment ? this.comment : E}</textarea
                 const hasSource = searchParams.get('utm_source') === 'shopgpt';
                 const isDesktop = window.innerWidth > 768;
                 const wasModalOpen = isModalOpen(this.destination);
-                // If the url has `utm_source` open the popup when reloaded
-                if ((hasSource && isDesktop) || wasModalOpen) {
+                // If user came from ShopGPT product recommendation, don't open modal
+                if (hasSource) {
+                    return;
+                }
+                // For non-product pages, check session storage to restore modal state
+                if (wasModalOpen && isDesktop) {
                     this.modalState = 'open';
                     setUserInteracted(this.destination);
                 }

package/index.mjs

@@ -471,6 +471,50 @@ new Set([
     'orderPlaced',
 ]);
 
+const checkBotVisibility = ({ botVisibilityConditions, currentUrl, }) => {
+    const result = {
+        shouldHideBot: false,
+    };
+    if (!(botVisibilityConditions === null || botVisibilityConditions === void 0 ? void 0 : botVisibilityConditions.hideBot)) {
+        return result;
+    }
+    if (botVisibilityConditions.urlSearchParamExclusion &&
+        botVisibilityConditions.urlSearchParamExclusion.length > 0) {
+        const urlSearchParamExclusionResult = checkURLSearchParamExclusion(botVisibilityConditions.urlSearchParamExclusion, currentUrl);
+        if (urlSearchParamExclusionResult.isExcluded) {
+            return {
+                shouldHideBot: true,
+                reason: 'URL search parameters matched exclusion criteria',
+                matchedParams: urlSearchParamExclusionResult.matchedParams,
+            };
+        }
+    }
+    return result;
+};
+const checkURLSearchParamExclusion = (excludeParams, currentUrl) => {
+    const result = {
+        isExcluded: false,
+        matchedParams: [],
+    };
+    if (!excludeParams || excludeParams.length === 0) {
+        return result;
+    }
+    try {
+        const url = new URL(currentUrl);
+        const urlParams = new URLSearchParams(url.search);
+        const matchedParams = excludeParams.filter((param) => {
+            return urlParams.has(param);
+        });
+        return {
+            isExcluded: matchedParams.length > 0,
+            matchedParams,
+        };
+    }
+    catch (error) {
+        return result;
+    }
+};
+
 const packageName = 'shopGPT';
 const DEFAULT_MAX_THREAD_AGE = 14; // in days
 const DEFAULT_NUDGE_TIMEOUT = 10; // in seconds
@@ -1016,7 +1060,20 @@ const init = (params) => {
             error('Error in setting the sessionStorage for previewShopGPT');
         }
     }
-    const { enabled, mode, devMode, merchantUrl, profiles, productHandles, targetPath, view, brandName, quickPrompts, supportPrompts, searchSuggestions, merchantImage, latestThreadLoad, botIconUrl, css, nudge, loadUIManually, metafieldDisplayName, showClassicChatbot, chatbotIconType, } = (_c = params.manifest.variables) !== null && _c !== void 0 ? _c : {};
+    const { enabled, mode, devMode, merchantUrl, profiles, productHandles, targetPath, view, brandName, quickPrompts, supportPrompts, searchSuggestions, merchantImage, latestThreadLoad, botIconUrl, css, nudge, loadUIManually, metafieldDisplayName, showClassicChatbot, chatbotIconType, botVisibilityConditions, } = (_c = params.manifest.variables) !== null && _c !== void 0 ? _c : {};
+    let shouldHideBot = false;
+    if (botVisibilityConditions) {
+        const visibilityResult = checkBotVisibility({
+            botVisibilityConditions,
+            currentUrl: window.location.href,
+        });
+        if (visibilityResult.shouldHideBot) {
+            logger.log(`ShopGPT disabled: ${visibilityResult.reason}${visibilityResult.matchedParams
+                ? ` (${visibilityResult.matchedParams.join(', ')})`
+                : ''}`);
+            shouldHideBot = true;
+        }
+    }
     const experiment = createExperiment({
         name: getExperimentName(mode),
         userId: params.userId,
@@ -1025,7 +1082,7 @@ const init = (params) => {
             ? (_d = params.manifest.variables) === null || _d === void 0 ? void 0 : _d.rolloutPercentage
             : undefined,
     });
-    const shouldShowUI = enabled || experiment.isEnabled;
+    const shouldShowUI = (enabled || experiment.isEnabled) && !shouldHideBot;
     if (experiment.name === 'preview' && shouldShowUI) {
         logger.log('Enabling UI in preview mode');
     }
@@ -11112,8 +11169,12 @@ class ShopGPT extends i$1 {
             const hasSource = searchParams.get('utm_source') === 'shopgpt';
             const isDesktop = window.innerWidth > 768;
             const wasModalOpen = isModalOpen(this.destination);
-            // If the url has `utm_source` open the popup when reloaded
-            if ((hasSource && isDesktop) || wasModalOpen) {
+            // If user came from ShopGPT product recommendation, don't open modal
+            if (hasSource) {
+                return;
+            }
+            // For non-product pages, check session storage to restore modal state
+            if (wasModalOpen && isDesktop) {
                 this.modalState = 'open';
                 setUserInteracted(this.destination);
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blotoutio/providers-shop-gpt-sdk",
-  "version": "1.31.2",
+  "version": "1.31.4",
   "description": "Shop GPT SDK for EdgeTag",
   "author": "Blotout",
   "license": "MIT",