@useinsider/guido 3.4.1-beta.1fc7f53 → 3.4.1-beta.4d7cad6

package/README.md

@@ -8,6 +8,8 @@
 
 # @useinsider/guido
 
+[![Coverus](https://github.com/useinsider/coverus-artifacts/raw/main/badges/github/useinsider/guido/coverage.svg)](http://coverus.internal.dataforce/app/project/github/useinsider/guido)
+
 Guido is a Vue 2 + TypeScript wrapper for the Stripo Email Editor plugin. Easily embed the professional email editor in your Vue applications with a clean, type-safe configuration.
 
 ## Installation

package/dist/composables/useActionsApi.js

@@ -21,9 +21,9 @@ const v = () => {
       resetDataSavedFlag: !1,
       disableLineHeightsReplace: !0
     }, ...t }, s = {
-      callback: (l, p, d, c, u) => {
+      callback: (l, r, d, c, u) => {
         l ? a(l) : e({
-          html: p,
+          html: r,
           ampHtml: d,
           ampErrors: c,
           displayConditions: u
@@ -36,11 +36,11 @@ const v = () => {
   return {
     getCompiledEmail: m,
     getTemplateData: () => new Promise((t) => {
-      const e = ({ html: a, css: i, width: o, height: r, utmParams: s, syncModulesIds: l }) => t({
+      const e = ({ html: a, css: i, width: o, height: p, utmParams: s, syncModulesIds: l }) => t({
         html: a,
         css: i,
         width: o,
-        height: r,
+        height: p,
         utmParams: s,
         syncModulesIds: l
       });
@@ -91,11 +91,7 @@ const v = () => {
     },
     editorSave: () => new Promise((t) => {
       window.StripoEditorApi.actionsApi.save((e) => {
-        if (e) {
-          n(e, "Failed to save template"), t(!1);
-          return;
-        }
-        t(!0);
+        e && n(e, "Failed to save template"), t();
       });
     })
   };

package/dist/composables/useSave.js

@@ -1,31 +1,32 @@
 import { useActionsApi as x } from "./useActionsApi.js";
 import { useConfig as y } from "./useConfig.js";
 import { useSaveStart as w, useSaveComplete as C } from "./useGuidoActions.js";
-import { useSyncModuleExtractor as E } from "./useSyncModuleExtractor.js";
-import { useStripoApi as H } from "../services/stripoApi.js";
-import { useTemplatePreparation as b } from "../utils/templatePreparation.js";
-import { useHtmlValidator as q } from "./useHtmlValidator.js";
-import { useCouponBlockValidator as L } from "./validators/useCouponBlockValidator.js";
-import { useLiquidValidator as P } from "./validators/useLiquidValidator.js";
-const z = () => {
-  const o = w(), s = C(), { validateHtml: r } = q(), { validateLiquidSyntax: n } = P(), { validateCouponBlockTags: l } = L(), { callbacks: a, isFeatureEnabled: d } = y(), { extractSyncModuleData: u } = E(), { setSyncModuleUnsubscriptionPages: c } = H(), { editorSave: m } = x();
+import { useSyncModuleExtractor as H } from "./useSyncModuleExtractor.js";
+import { useStripoApi as b } from "../services/stripoApi.js";
+import { useTemplatePreparation as q } from "../utils/templatePreparation.js";
+import { useHtmlValidator as L } from "./useHtmlValidator.js";
+import { useCouponBlockValidator as P } from "./validators/useCouponBlockValidator.js";
+import { useLiquidValidator as E } from "./validators/useLiquidValidator.js";
+const j = () => {
+  const o = w(), s = C(), { validateHtml: r } = L(), { validateLiquidSyntax: l } = E(), { validateCouponBlockTags: n } = P(), { callbacks: a, isFeatureEnabled: d } = y(), { extractSyncModuleData: u } = H(), { setSyncModuleUnsubscriptionPages: c } = b(), { editorSave: m } = x();
   return { save: async (p = !1, f = !1) => {
     var i;
     o();
-    const { prepareTemplateDetails: v } = b(), t = await v();
-    if (!l(t.compiledHtml))
+    const { prepareTemplateDetails: v } = q(), t = await v();
+    if (!n(t.compiledHtml))
       return;
     if (d("liquidSyntax")) {
-      if (!await n(t.compiledHtml))
+      if (!await l(t.compiledHtml))
         return;
     } else if (!await r(t.compiledHtml, t.dynamicContentList, !0))
       return;
-    if ((i = a.value) != null && i.externalValidation && !await a.value.externalValidation(t) || !await m())
+    if ((i = a.value) != null && i.externalValidation && !await a.value.externalValidation(t))
       return;
+    await m();
     const { unsubscribePayload: S, stripoModules: V } = u(t.rawHtml);
     return await c(S), t.modules = V, p || s({ ...t, silent: f }), t;
   } };
 };
 export {
-  z as useSave
+  j as useSave
 };

package/dist/config/migrator/itemsBlockMigrator.js

@@ -155,6 +155,8 @@ class z {
   }
   migrate(t) {
     try {
+      if (!this.containsItemsBlock(t))
+        return t;
       let o = this.removeJinjaConditionals(t);
       o = this.replaceTemplateVariables(o);
       const l = this.parser.parseFromString(o, "text/html"), a = l.querySelectorAll(
@@ -178,15 +180,15 @@ class z {
           originalPriceStyles: e.originalPriceStyles,
           quantityStyles: e.quantityStyles,
           nodeConfig: R(e.configBlockAttributes)
-        }), d = this.parser.parseFromString(
+        }), u = this.parser.parseFromString(
           `<table><tbody><tr>${c}</tr></tbody></table>`,
           "text/html"
         ).querySelector("td");
-        if (d && i.parentNode) {
+        if (u && i.parentNode) {
           const p = R(e.configBlockAttributes);
-          d.setAttribute("esd-ext-config", JSON.stringify(p));
-          const u = d.querySelector("esd-config-block");
-          u && u.remove(), i.parentNode.replaceChild(d, i);
+          u.setAttribute("esd-ext-config", JSON.stringify(p));
+          const d = u.querySelector("esd-config-block");
+          d && d.remove(), i.parentNode.replaceChild(u, i);
         }
       }), l.documentElement.outerHTML);
     } catch (o) {
@@ -201,22 +203,22 @@ class z {
    */
   extractConfiguration(t) {
     var C, D, P;
-    const o = ((C = t.querySelector("[data-type]")) == null ? void 0 : C.getAttribute("data-type")) || "CART_ITEMS", l = ((D = t.querySelector("[data-number]")) == null ? void 0 : D.getAttribute("data-number")) || "1", a = parseInt(l) - 1, n = T[o], i = ((P = n == null ? void 0 : n[a]) == null ? void 0 : P.value) || n[0].value, e = t.querySelector('[product-attr="price"]'), c = (e == null ? void 0 : e.getAttribute("data-currency_symbol")) || "USD", d = ((e == null ? void 0 : e.getAttribute("data-curency")) || "before") === "after" ? "1" : "0", p = (e == null ? void 0 : e.getAttribute("data-formated")) !== "false", u = this.extractConfigBlockAttributes(t, o, l), S = u["data-card_orientation_control_value"];
+    const o = ((C = t.querySelector("[data-type]")) == null ? void 0 : C.getAttribute("data-type")) || "CART_ITEMS", l = ((D = t.querySelector("[data-number]")) == null ? void 0 : D.getAttribute("data-number")) || "1", a = parseInt(l) - 1, n = T[o], i = ((P = n == null ? void 0 : n[a]) == null ? void 0 : P.value) || n[0].value, e = t.querySelector('[product-attr="price"]'), c = (e == null ? void 0 : e.getAttribute("data-currency_symbol")) || "USD", u = ((e == null ? void 0 : e.getAttribute("data-curency")) || "before") === "after" ? "1" : "0", p = (e == null ? void 0 : e.getAttribute("data-formated")) !== "false", d = this.extractConfigBlockAttributes(t, o, l), S = d["data-card_orientation_control_value"];
     let b;
     S ? b = S === "horizontal" ? "horizontal" : "vertical" : b = t.querySelector('[colspan="2"]') !== null ? "vertical" : "horizontal";
-    const y = t.querySelector('a[product-attr="name"]'), I = (y == null ? void 0 : y.getAttribute("style")) || void 0, f = t.querySelector('a[product-attr="button"]'), m = (f == null ? void 0 : f.getAttribute("style")) || void 0, h = (e == null ? void 0 : e.getAttribute("style")) || void 0, A = t.querySelector("p.original-price"), k = (A == null ? void 0 : A.getAttribute("style")) || void 0, E = t.querySelector('[product-attr="quantity"]'), L = (E == null ? void 0 : E.getAttribute("style")) || void 0;
+    const y = t.querySelector('a[product-attr="name"]'), I = (y == null ? void 0 : y.getAttribute("style")) || void 0, f = t.querySelector('a[product-attr="button"]'), m = (f == null ? void 0 : f.getAttribute("style")) || void 0, k = (e == null ? void 0 : e.getAttribute("style")) || void 0, A = t.querySelector("p.original-price"), h = (A == null ? void 0 : A.getAttribute("style")) || void 0, E = t.querySelector('[product-attr="quantity"]'), L = (E == null ? void 0 : E.getAttribute("style")) || void 0;
     return {
       orientation: b,
       itemsType: o,
       itemId: i,
       currencySymbol: c,
-      currencyLocation: d,
+      currencyLocation: u,
       formattedPrice: p,
-      configBlockAttributes: u,
+      configBlockAttributes: d,
       nameStyles: I,
       buttonStyles: m,
-      priceStyles: h,
-      originalPriceStyles: k,
+      priceStyles: k,
+      originalPriceStyles: h,
       quantityStyles: L
     };
   }
@@ -296,6 +298,14 @@ class z {
       "data-product_button_link": "{{Abandoned Cart Item (1) Url}}"
     };
   }
+  /**
+   * Fast check for the presence of any items block (cart / browsed / purchased)
+   * in the raw HTML. Used to gate the migration pipeline so non-items templates
+   * are returned untouched.
+   */
+  containsItemsBlock(t) {
+    return t.includes("esd-cart-items-block") || t.includes("esd-browsed-items-block") || t.includes("esd-purchased-items-block");
+  }
   /**
    * Removes Jinja2 conditional statements from HTML
    * Handles all items block types:
@@ -337,18 +347,18 @@ class z {
       const [, i, e, c] = n, _ = x[i];
       if (!_)
         return console.warn(`Unknown variable prefix: ${i}`), l;
-      const d = q[e];
-      if (!d)
+      const u = q[e];
+      if (!u)
         return console.warn(`Unknown variable suffix mapping for: ${e}`), l;
-      const { pairsKey: p, defaultKey: u, isArray: S } = d, y = o[p][_];
+      const { pairsKey: p, defaultKey: d, isArray: S } = u, y = o[p][_];
       if (!y)
         return console.warn(`No data found for: ${p}.${_}`), l;
       if (S) {
-        const f = parseInt(c) - 1, m = y[u];
-        return Array.isArray(m) && m[f] ? m[f] : (console.warn(`Array value not found: ${p}.${_}.${u}[${f}]`), l);
+        const f = parseInt(c) - 1, m = y[d];
+        return Array.isArray(m) && m[f] ? m[f] : (console.warn(`Array value not found: ${p}.${_}.${d}[${f}]`), l);
       }
-      const I = y[u];
-      return I !== void 0 ? String(I) : (console.warn(`Default value not found: ${p}.${_}.${u}`), l);
+      const I = y[d];
+      return I !== void 0 ? String(I) : (console.warn(`Default value not found: ${p}.${_}.${d}`), l);
     });
   }
 }

package/dist/src/composables/useActionsApi.d.ts

@@ -7,5 +7,5 @@ export declare const useActionsApi: () => {
     getPreviewData: (options?: CompileEmailOptions) => Promise<CompiledEmailResult>;
     updateTimerInClonedTemplate: () => Promise<string | null>;
     updateHtmlAndCss: (html: string, css: string) => void;
-    editorSave: () => Promise<boolean>;
+    editorSave: () => Promise<void>;
 };

package/dist/src/stores/config.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/stores/config.js

@@ -1,8 +1,8 @@
 import "../@types/config/schemas.js";
 import "../@types/config/defaults.js";
-import { parseConfig as n } from "../@types/config/validator.js";
-import { defineStore as o } from "pinia";
-const s = o("guido-config", {
+import { parseConfig as o } from "../@types/config/validator.js";
+import { defineStore as r } from "pinia";
+const f = r("guido-config", {
   state: () => ({
     initialized: !1,
     config: null
@@ -75,64 +75,65 @@ const s = o("guido-config", {
      * Get the template ID
      */
     templateId: (i) => {
-      var e;
-      return ((e = i.config) == null ? void 0 : e.identity.templateId) ?? "";
+      var e, t;
+      return ((t = (e = i.config) == null ? void 0 : e.identity) == null ? void 0 : t.templateId) ?? "";
     },
     /**
      * Get the user ID
      */
     userId: (i) => {
-      var e;
-      return ((e = i.config) == null ? void 0 : e.identity.userId) ?? "";
+      var e, t;
+      return ((t = (e = i.config) == null ? void 0 : e.identity) == null ? void 0 : t.userId) ?? "";
     },
     /**
      * Get the variation ID
      */
     variationId: (i) => {
-      var e;
-      return ((e = i.config) == null ? void 0 : e.identity.variationId) ?? "";
+      var e, t;
+      return ((t = (e = i.config) == null ? void 0 : e.identity) == null ? void 0 : t.variationId) ?? "";
     },
     /**
      * Get the partner name
      */
     partnerName: (i) => {
-      var e;
-      return ((e = i.config) == null ? void 0 : e.partner.name) ?? "";
+      var e, t;
+      return ((t = (e = i.config) == null ? void 0 : e.partner) == null ? void 0 : t.name) ?? "";
     },
     /**
      * Get the product type
      */
     productType: (i) => {
-      var e;
-      return ((e = i.config) == null ? void 0 : e.partner.productType) ?? 60;
+      var e, t;
+      return ((t = (e = i.config) == null ? void 0 : e.partner) == null ? void 0 : t.productType) ?? 60;
     },
     /**
      * Get the message type
      */
     messageType: (i) => {
-      var e;
-      return ((e = i.config) == null ? void 0 : e.partner.messageType) ?? 1;
+      var e, t;
+      return ((t = (e = i.config) == null ? void 0 : e.partner) == null ? void 0 : t.messageType) ?? 1;
     },
     /**
      * Get the username
      */
     username: (i) => {
-      var e;
-      return ((e = i.config) == null ? void 0 : e.partner.username) ?? "Guido User";
+      var e, t;
+      return ((t = (e = i.config) == null ? void 0 : e.partner) == null ? void 0 : t.username) ?? "Guido User";
     },
     /**
      * Check if header should be shown
      */
     showHeader: (i) => {
-      var e;
-      return ((e = i.config) == null ? void 0 : e.ui.showHeader) ?? !0;
+      var e, t;
+      return ((t = (e = i.config) == null ? void 0 : e.ui) == null ? void 0 : t.showHeader) ?? !0;
     },
     /**
      * Check if a specific feature is enabled
      */
+    // eslint-disable-next-line @stylistic/max-len
     isFeatureEnabled: (i) => (e) => {
-      var t;
-      return ((t = i.config) == null ? void 0 : t.features[e]) ?? !0;
+      var t, n;
+      return ((n = (t = i.config) == null ? void 0 : t.features) == null ? void 0 : n[e]) ?? !0;
     }
   },
   actions: {
@@ -140,7 +141,7 @@ const s = o("guido-config", {
      * Initialize the config store with validated configuration
      */
     init(i) {
-      const e = n(i);
+      const e = o(i);
       this.config = e, this.initialized = !0;
     },
     /**
@@ -152,5 +153,5 @@ const s = o("guido-config", {
   }
 });
 export {
-  s as useConfigStore
+  f as useConfigStore
 };

package/dist/utils/templatePreparation.js

@@ -1,79 +1,87 @@
-import { useActionsApi as T } from "../composables/useActionsApi.js";
-import { useHtmlCompiler as C } from "../composables/useHtmlCompiler.js";
-import { DEFAULT_CURRENCY as l, DEFAULT_NODE_CONFIG as a } from "../extensions/Blocks/Recommendation/constants/defaultConfig.js";
+import { useActionsApi as C } from "../composables/useActionsApi.js";
+import { useHtmlCompiler as T } from "../composables/useHtmlCompiler.js";
+import { DEFAULT_CURRENCY as d, DEFAULT_NODE_CONFIG as s } from "../extensions/Blocks/Recommendation/constants/defaultConfig.js";
 import { useRecommendationExtensionStore as b } from "../extensions/Blocks/Recommendation/store/recommendation.js";
-import { DATA_ATTRIBUTES as y } from "../extensions/Blocks/Unsubscribe/utils/constants.js";
-import { parsePageList as P } from "../extensions/Blocks/Unsubscribe/utils/utils.js";
-import { useDynamicContentStore as D } from "../stores/dynamic-content.js";
-import { useUnsubscribeStore as E } from "../stores/unsubscribe.js";
-function U(i, r) {
-  const s = new DOMParser().parseFromString(i, "text/html").querySelectorAll(`[${y.PAGE_LIST}]`), c = [];
-  return s.forEach((t) => {
-    const o = t.getAttribute(y.PAGE_LIST);
-    o && c.push(...P(o));
-  }), r.filter((t) => c.includes(t));
+import { DATA_ATTRIBUTES as S } from "../extensions/Blocks/Unsubscribe/utils/constants.js";
+import { parsePageList as D } from "../extensions/Blocks/Unsubscribe/utils/utils.js";
+import { useDynamicContentStore as P } from "../stores/dynamic-content.js";
+import { useUnsubscribeStore as w } from "../stores/unsubscribe.js";
+function E(i, o) {
+  const t = new DOMParser().parseFromString(i, "text/html").querySelectorAll(`[${S.PAGE_LIST}]`), c = [];
+  return t.forEach((r) => {
+    const a = r.getAttribute(S.PAGE_LIST);
+    a && c.push(...D(a));
+  }), o.filter((r) => c.includes(r));
 }
-function F(i) {
+async function U(i) {
   const m = new DOMParser().parseFromString(i, "text/html").querySelectorAll(".recommendation-block-v2");
   if (m.length === 0)
     return;
-  const d = b();
-  m.forEach((s) => {
-    var g, f, u, n, S;
-    const c = s.getAttribute("recommendation-id"), t = c ? Number(c) : NaN;
-    if (!Number.isFinite(t))
+  const l = b();
+  m.forEach((t) => {
+    var g, f, u, n, y;
+    const c = t.getAttribute("recommendation-id"), r = c ? Number(c) : NaN;
+    if (!Number.isFinite(r))
       return;
-    const o = s.getAttribute("esd-ext-config");
-    if (!o)
+    const a = t.getAttribute("esd-ext-config");
+    if (!a)
       return;
     let e;
     try {
-      e = JSON.parse(o);
+      e = JSON.parse(a);
     } catch {
       return;
     }
     if (!e || typeof e != "object" || Array.isArray(e))
       return;
     const p = {
-      strategy: e.strategy ?? a.strategy,
-      language: e.language ?? a.language,
-      size: e.size ?? a.size,
+      strategy: e.strategy ?? s.strategy,
+      language: e.language ?? s.language,
+      size: e.size ?? s.size,
       // Spread the default arrays so each block gets a fresh reference
       // instead of sharing the singleton in DEFAULT_NODE_CONFIG.
-      productIds: e.productIds ?? [...a.productIds],
-      filters: e.filters ?? [...a.filters],
-      shuffleProducts: e.shuffleProducts ?? a.shuffleProducts,
-      currencyCode: ((g = e.currency) == null ? void 0 : g.code) ?? l.code,
-      currencyAlignment: ((f = e.currency) == null ? void 0 : f.alignment) ?? l.alignment,
-      currencyDecimalCount: ((u = e.currency) == null ? void 0 : u.decimalCount) ?? l.decimalCount,
-      currencyDecimalSeparator: ((n = e.currency) == null ? void 0 : n.decimalSeparator) ?? l.decimalSeparator,
-      currencyThousandSeparator: ((S = e.currency) == null ? void 0 : S.thousandSeparator) ?? l.thousandSeparator
+      productIds: e.productIds ?? [...s.productIds],
+      filters: e.filters ?? [...s.filters],
+      shuffleProducts: e.shuffleProducts ?? s.shuffleProducts,
+      currencyCode: ((g = e.currency) == null ? void 0 : g.code) ?? d.code,
+      currencyAlignment: ((f = e.currency) == null ? void 0 : f.alignment) ?? d.alignment,
+      currencyDecimalCount: ((u = e.currency) == null ? void 0 : u.decimalCount) ?? d.decimalCount,
+      currencyDecimalSeparator: ((n = e.currency) == null ? void 0 : n.decimalSeparator) ?? d.decimalSeparator,
+      currencyThousandSeparator: ((y = e.currency) == null ? void 0 : y.thousandSeparator) ?? d.thousandSeparator
     };
-    d.seedBlockUrlConfig(t, p);
+    l.seedBlockUrlConfig(r, p);
   });
+  try {
+    await l.fetchRecommendationCreateData();
+  } catch (t) {
+    console.warn(
+      "Recommendation reference data pre-load failed; validator will skip the availability check.",
+      t
+    );
+  }
 }
 const _ = () => {
-  const i = D(), r = E(), { getCompiledEmail: m, getTemplateData: d } = T(), { compileHtml: s } = C();
+  const i = P(), o = w(), { getCompiledEmail: m, getTemplateData: l } = C(), { compileHtml: t } = T();
   return {
     prepareTemplateDetails: async () => {
-      const { html: t, ampHtml: o = "", ampErrors: e = [] } = await m({
+      const { html: r, ampHtml: a = "", ampErrors: e = [] } = await m({
         minimize: !0,
         resetDataSavedFlag: !1
-      }), { html: p, css: g, syncModulesIds: f = [] } = await d();
-      r.selectedUnsubscribePages.length && await r.fetchTemplates(), F(p);
-      const { compiledHtml: u, stats: n, appliedRules: S } = s(t), h = i.getSelectedDynamicContentList, A = b();
+      }), { html: p, css: g, syncModulesIds: f = [] } = await l();
+      o.selectedUnsubscribePages.length && await o.fetchTemplates(), await U(p);
+      const { compiledHtml: u, stats: n, appliedRules: y } = t(r), h = i.getSelectedDynamicContentList, A = b();
       return console.debug("HTML Compilation Stats:", {
         originalSize: n.originalSize,
         compiledSize: n.compiledSize,
         reduction: `${n.reductionPercentage.toFixed(2)}%`,
-        appliedRules: S,
+        appliedRules: y,
         executionTime: `${n.executionTime.toFixed(2)}ms`
       }), {
         dynamicContentList: h,
         compiledHtml: u,
         rawHtml: p,
         css: g,
-        ampHtml: o,
+        ampHtml: a,
         ampErrors: e,
         modules: f.map(Number),
         recommendation: {
@@ -81,8 +89,8 @@ const _ = () => {
           configs: {}
         },
         unsubscribe: {
-          status: r.unsubscribePagesStatus,
-          config: U(u, r.selectedUnsubscribePages)
+          status: o.unsubscribePagesStatus,
+          config: E(u, o.selectedUnsubscribePages)
         }
       };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@useinsider/guido",
-  "version": "3.4.1-beta.1fc7f53",
+  "version": "3.4.1-beta.4d7cad6",
   "description": "Guido is a Vue + TypeScript wrapper for Email Plugin. Easily embed the email editor in your Vue applications.",
   "main": "./dist/guido.umd.cjs",
   "module": "./dist/library.js",
@@ -24,7 +24,7 @@
     "lint": "NODE_OPTIONS=--max-old-space-size=2048 eslint ./ && bun run type-check",
     "lint:fix": "NODE_OPTIONS=--max-old-space-size=2048 eslint --fix ./",
     "type-check": "vue-tsc --noEmit --project tsconfig.config.json && vue-tsc --noEmit --project tsconfig.app.json",
-    "test": "vitest run",
+    "test": "vitest run --coverage",
     "test:watch": "vitest",
     "test:visual-update": "npx playwright test --update-snapshots --reporter html",
     "prepare": "husky",
@@ -61,6 +61,7 @@
     "@typescript-eslint/parser": "7.18.0",
     "@useinsider/eslint-config": "1.5.3",
     "@vitejs/plugin-vue2": "2.3.1",
+    "@vitest/coverage-v8": "2.1.9",
     "eslint": "8.57.1",
     "eslint-config-airbnb-base": "15.0.0",
     "eslint-config-airbnb-typescript": "18.0.0",