@useinsider/guido 3.4.1-beta.545fc76 → 3.4.1-beta.6a8f00a

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/useRecommendation.js

@@ -1,21 +1,22 @@
-import { getRecommendationFeedSourceMaps as I, URLS as C } from "../enums/extensions/recommendationBlock.js";
-import { MinDeviceViewport as R, DefaultPadding as b } from "../enums/recommendation.js";
-import { useRecommendationExtensionStore as m } from "../extensions/Blocks/Recommendation/store/recommendation.js";
+import { getRecommendationFeedSourceMaps as I, URLS as R } from "../enums/extensions/recommendationBlock.js";
+import { MinDeviceViewport as C, DefaultPadding as b } from "../enums/recommendation.js";
+import { useRecommendationExtensionStore as l } from "../extensions/Blocks/Recommendation/store/recommendation.js";
 import { generateCompleteFilterQuery as h } from "../extensions/Blocks/Recommendation/utils/filterUtil.js";
+import { getPartnerRecommendationParams as y } from "../extensions/Blocks/Recommendation/utils/partnerCustomizations.js";
 import { useConfigStore as x } from "../stores/config.js";
-const w = () => ({
+const A = () => ({
   calculateCardWidth: ({
     mobileLeftPadding: s,
     mobileRightPadding: a,
     cardsInRow: c,
-    unresponsive: n
+    unresponsive: o
   }) => {
-    const r = n ? c : 1, e = s + a + (r - 1) * b;
-    return (R - e) / r;
+    const n = o ? c : 1, e = s + a + (n - 1) * b;
+    return (C - e) / n;
   },
   getRecommendationCampaignData: (s) => {
-    const a = m(), c = Number(s), n = a.blockStates[c];
-    if (!n)
+    const a = l(), c = Number(s), o = a.blockStates[c];
+    if (!o)
       return {
         textTrimming: !1,
         orientation: "vertical",
@@ -28,14 +29,14 @@ const w = () => ({
         discountBeforeTextValue: "",
         discountAfterTextValue: ""
       };
-    const { recommendationConfigs: r } = n, e = r.orientation === "grid" ? "vertical" : "horizontal";
+    const { recommendationConfigs: n } = o, e = n.orientation === "grid" ? "vertical" : "horizontal";
     return {
-      textTrimming: r.textTrimming,
+      textTrimming: n.textTrimming,
       orientation: e,
       mobileLeftPadding: 0,
       mobileRightPadding: 0,
-      cardsInRow: r.cardsInRow,
-      unresponsive: r.unresponsive,
+      cardsInRow: n.cardsInRow,
+      unresponsive: n.unresponsive,
       priceBeforeTextValue: "",
       priceAfterTextValue: "",
       discountBeforeTextValue: "",
@@ -43,38 +44,38 @@ const w = () => ({
     };
   },
   buildCampaignUrl: (s, a) => {
-    var l;
-    const c = m(), n = x(), r = Number(s);
+    var m;
+    const c = l(), o = x(), n = Number(s);
     let e;
     if (a)
       e = a;
     else {
-      const i = c.blockStates[r];
-      if (!i)
+      const r = c.blockStates[n];
+      if (!r)
         return "";
-      const { recommendationConfigs: o } = i;
+      const { recommendationConfigs: i } = r;
       e = {
-        strategy: o.strategy,
-        language: o.language,
-        currencyCode: o.currencySettings.value,
-        size: o.size,
-        productIds: o.productIds,
-        filters: o.filters,
-        shuffleProducts: o.shuffleProducts
+        strategy: i.strategy,
+        language: i.language,
+        currencyCode: i.currencySettings.value,
+        size: i.size,
+        productIds: i.productIds,
+        filters: i.filters,
+        shuffleProducts: i.shuffleProducts
       };
     }
-    const f = ((l = I().find((i) => i.key === e.strategy)) == null ? void 0 : l.path) || "", t = new URLSearchParams();
-    if (t.set("locale", e.language), t.set("currency", e.currencyCode), t.set("partnerName", n.partnerName), t.set("size", e.size), t.set("details", "true"), t.set("campaignId", n.variationId), e.strategy === "manualMerchandising") {
-      const i = parseInt(e.size) || 6;
-      t.set("productId", e.productIds.slice(0, i).join(","));
+    const f = ((m = I().find((r) => r.key === e.strategy)) == null ? void 0 : m.path) || "", t = new URLSearchParams();
+    if (t.set("locale", e.language), t.set("currency", e.currencyCode), t.set("partnerName", o.partnerName), t.set("size", e.size), t.set("details", "true"), t.set("campaignId", o.variationId), e.strategy === "manualMerchandising") {
+      const r = parseInt(e.size) || 6;
+      t.set("productId", e.productIds.slice(0, r).join(","));
     } else e.strategy === "similarViewed" && t.set("productId", "{itemId}");
     e.strategy === "userBased" && t.set("userId", "{user_id}");
-    const g = e.filters.filter((i) => i.isValid), d = h(g);
-    d && t.set("filter", d), e.shuffleProducts && t.set("shuffle", "true");
-    const p = decodeURIComponent(t.toString()), u = `${C.RECOMMENDATION_API_URL}/v2/${f}?${p}`;
+    const g = e.filters.filter((r) => r.isValid), d = h(g);
+    d && t.set("filter", d), e.shuffleProducts && t.set("shuffle", "true"), Object.entries(y(o.partnerName, e.strategy)).forEach(([r, i]) => t.set(r, i));
+    const p = decodeURIComponent(t.toString()), u = `${R.RECOMMENDATION_API_URL}/v2/${f}?${p}`;
     return c.recommendationCampaignUrls[s] = u, u;
   }
 });
 export {
-  w as useRecommendation
+  A as useRecommendation
 };

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/extensions/Blocks/Recommendation/store/recommendation.js

@@ -6,8 +6,9 @@ import { DEFAULT_CARDS_IN_ROW as F } from "../constants/layout.js";
 import { EXCLUDED_ALGORITHM_IDS as D } from "../constants/defaultConfig.js";
 import { getDefaultProducts as S } from "../templates/utils.js";
 import { generateCompleteFilterQuery as b } from "../utils/filterUtil.js";
-import { isFilterValid as w } from "../validation/filterSchema.js";
-import { isConfigValid as v } from "../validation/requiredFields.js";
+import { getPartnerRecommendationParams as w } from "../utils/partnerCustomizations.js";
+import { isFilterValid as v } from "../validation/filterSchema.js";
+import { isConfigValid as N } from "../validation/requiredFields.js";
 const h = C();
 let m = null, u = null, d = null;
 function k() {
@@ -49,7 +50,7 @@ function I() {
     filterSnapshot: null
   };
 }
-const N = () => ({
+const x = () => ({
   recommendationCampaignUrls: {},
   activePredictiveAlgorithms: [],
   languages: {},
@@ -58,8 +59,8 @@ const N = () => ({
   blockStates: {},
   currentRecommendationId: null,
   configVersion: 0
-}), M = P("guidoRecommendationExtension", {
-  state: () => N(),
+}), T = P("guidoRecommendationExtension", {
+  state: () => x(),
   getters: {
     // ====================================================================
     // Proxy Getters — Backward Compatible Access to Current Block State
@@ -359,7 +360,7 @@ const N = () => ({
         const n = [...e.recommendationConfigs.filters];
         n[r] = {
           ...t,
-          isValid: w(t)
+          isValid: v(t)
         }, e.recommendationConfigs.filters = n;
       }
     },
@@ -405,7 +406,7 @@ const N = () => ({
      * every block's recommendationConfigs across user edits.
      */
     hasInvalidBlock() {
-      return Object.values(this.blockStates).some((t) => !v(t.recommendationConfigs, this));
+      return Object.values(this.blockStates).some((t) => !N(t.recommendationConfigs, this));
     },
     // ====================================================================
     // Per-Block Product Fetching
@@ -434,7 +435,10 @@ const N = () => ({
         details: !0,
         campaignId: o.variationId
       };
-      r.strategy === "manualMerchandising" ? a.productId = r.productIds.slice(0, s).join(",") : r.strategy === "similarViewed" && (a.productId = "{itemId}"), r.strategy === "userBased" && (a.userId = "{user_id}"), c && (a.filter = c), r.shuffleProducts && (a.shuffle = !0);
+      r.strategy === "manualMerchandising" ? a.productId = r.productIds.slice(0, s).join(",") : r.strategy === "similarViewed" && (a.productId = "{itemId}"), r.strategy === "userBased" && (a.userId = "{user_id}"), c && (a.filter = c), r.shuffleProducts && (a.shuffle = !0), Object.assign(
+        a,
+        w(o.partnerName, r.strategy)
+      );
       let f;
       try {
         f = await h.fetchRecommendationProducts(i, a);
@@ -452,5 +456,5 @@ const N = () => ({
   }
 });
 export {
-  M as useRecommendationExtensionStore
+  T as useRecommendationExtensionStore
 };

package/dist/extensions/Blocks/Recommendation/utils/partnerCustomizations.js

@@ -0,0 +1,21 @@
+const i = [
+  "ozonebg",
+  "ozonehr",
+  "ozonero",
+  "ozoneinfo",
+  "babybg",
+  "ozongr",
+  "iboodat",
+  "iboodbe",
+  "iboodde",
+  "iboodfr",
+  "iboodnl",
+  "iboodpl"
+], r = ["interencheres", "interencherespreprod"], d = ["lodenfrey", "lodenfreyuat"], c = "manualMerchandising";
+function s(e, n) {
+  const o = {};
+  return i.includes(e) && (o.excludePurchaseDay = "30", o.userId = "{user_id}"), r.includes(e) && (o.hp = "1"), d.includes(e) && n === c && (o.includeOutOfStockItems = "true"), o;
+}
+export {
+  s as getPartnerRecommendationParams
+};

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/extensions/Blocks/Recommendation/utils/partnerCustomizations.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Returns the extra recommendation feed query params for an account, if any.
+ * Accounts without customizations get an empty object.
+ * @param partnerName Account subdomain (`config.partner.name`)
+ * @param strategy    Recommendation strategy key of the block
+ */
+export declare function getPartnerRecommendationParams(partnerName: string, strategy: string): Record<string, string>;

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@useinsider/guido",
-  "version": "3.4.1-beta.545fc76",
+  "version": "3.4.1-beta.6a8f00a",
   "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",