@useinsider/guido 2.1.0-beta.7d0f92a → 2.1.0-beta.84a7014

package/README.md

@@ -1,6 +1,8 @@
 <p align="center">
   <a href="https://www.youtube.com/shorts/Y0RwBeMezL4" target="_blank" rel="noopener noreferrer">
-    <img width="180" src="./public/guido.png" alt="Guido logo">
+    <img width="180" 
+      src="https://web-image.useinsider.com/guido/defaultImageLibrary/iUH0liTK0d2YDsVB5LDN1770169173.jpg"  
+      alt="Guido logo">
   </a>
 </p>
 
@@ -122,6 +124,8 @@ const config: GuidoConfigInput = {
       senderName?: string,
       subject?: string,
     },
+    savedModulesFolderName?: string,    // Default: 'savedModules' - folder name for user-saved modules
+    defaultModulesFolderName?: string,  // Default: 'defaultModules' - folder name for default/prebuilt modules
   },
 
   // Optional: UI settings
@@ -141,6 +145,11 @@ const config: GuidoConfigInput = {
     modulesDisabled?: boolean,    // Default: false - Disable modules panel
   },
 
+  // Optional: Callbacks
+  callbacks?: {
+    externalValidation?: (data: SavedTemplateDetails) => Promise<boolean>,  // Return false to cancel save
+  },
+
   // Optional: Block configuration
   blocks?: {
     excludeDefaults?: DefaultBlockType[],
@@ -165,11 +174,48 @@ const config: GuidoConfigInput = {
 | `dynamic-content:open` | `DynamicContent \| null` | User wants to insert dynamic content |
 | `back` | - | Back button clicked |
 | `save:start` | - | Save process started |
-| `save:complete` | `Template` | Save completed successfully |
+| `save:complete` | `SavedTemplateDetails` | Save completed successfully (includes `metadata`) |
 | `on-change` | - | Template was modified |
 | `test-email:click` | - | Test email button clicked |
 | `onboarding-finished` | - | Onboarding popup dismissed |
 
+### `save:complete` Payload
+
+The `save:complete` event emits a `SavedTemplateDetails` object containing the compiled template data along with editor `metadata`:
+
+```typescript
+interface SavedTemplateDetails {
+  dynamicContentList: DynamicContent[];
+  compiledHtml: string;
+  rawHtml: string;
+  css: string;
+  ampHtml: string;
+  ampErrors: string[];
+  modules: number[];
+  recommendation: {
+    campaignUrls: Record<string, string>;
+    configs: Record<string, string>;
+  };
+  unsubscribe: {
+    status: boolean;
+    config: number[];
+  };
+  metadata: Metadata;
+}
+
+interface Metadata {
+  emailId: string;
+  partnerName?: string;
+  productType?: number;
+  userId: string;
+  username?: string;
+  savedModulesFolderName?: string;
+  defaultModulesFolderName?: string;
+}
+```
+
+> ⚠️ **Important:** The `metadata` object in the `save:complete` payload must be passed directly into your `templateConfig` / `stripoConfig` object while saving. This ensures the email-service receives the correct version of sync modules features
+
 ---
 
 ## Exposed Methods
@@ -251,6 +297,35 @@ const config: GuidoConfigInput = {
 
 ---
 
+## Module Folder Configuration
+
+Customize the Stripo module folder names for saved and default modules. These values are passed to Stripo metadata and the dynamic folder paths are constructed in the Stripo plugin panel configuration.
+
+```typescript
+const config: GuidoConfigInput = {
+  identity: { templateId: 'tpl-123', userId: 'user-456' },
+  partner: { name: 'acme' },
+  editor: {
+    // Folder name for user-saved modules
+    savedModulesFolderName: 'savedModules',
+
+    // Folder name for default/prebuilt modules
+    defaultModulesFolderName: 'defaultModules',
+  },
+};
+```
+
+### Default Values
+
+| Config Option | Default Value |
+|--------------|---------------|
+| `savedModulesFolderName` | `'savedModules'` |
+| `defaultModulesFolderName` | `'defaultModules'` |
+
+> **Note:** The actual folder paths (e.g., `guido_acme_savedModules`) are configured in the Stripo plugin panel using variable substitution like `${savedModulesFolderName}`.
+
+---
+
 ## HTML Compiler Rules
 
 Add custom rules to transform HTML during export:

package/dist/@types/config/schemas.js

@@ -1,4 +1,5 @@
-import { object as o, number as b, optional as e, string as t, pipe as u, picklist as n, custom as d, boolean as c, array as a, minLength as p, literal as r, variant as k } from "../../node_modules/valibot/dist/index.js";
+import { ModuleFolderDefaults as b } from "../../enums/defaults.js";
+import { object as o, number as p, optional as e, string as t, pipe as u, picklist as n, custom as S, boolean as a, array as c, minLength as d, literal as r, variant as k } from "../../node_modules/valibot/dist/index.js";
 const m = {
   /** Promotional/marketing emails */
   PROMOTIONAL: 1,
@@ -11,24 +12,24 @@ const m = {
   ARCHITECT: 49,
   /** Unsubscribe page builder */
   UNSUBSCRIBE_PAGES: 97
-}, S = o({
+}, h = o({
   /** Unique identifier for the template being edited */
   templateId: u(
     t(),
-    p(1, "templateId is required")
+    d(1, "templateId is required")
   ),
   /** Unique identifier for the user editing the template */
   userId: u(
     t(),
-    p(1, "userId is required")
+    d(1, "userId is required")
   ),
   /** Optional variation ID for A/B testing */
   variationId: e(t())
-}), h = o({
+}), y = o({
   /** Partner/organization name (required) */
   name: u(
     t(),
-    p(1, "partner.name is required")
+    d(1, "partner.name is required")
   ),
   /** Product type identifier */
   productType: e(
@@ -46,7 +47,7 @@ const m = {
   ),
   /** Display name for the current user */
   username: e(t(), "Guido User")
-}), y = o({
+}), f = o({
   /** Display text for the dynamic content */
   text: t(),
   /** Template variable value (e.g., {{username}}) */
@@ -67,14 +68,14 @@ const m = {
   css: e(t(), ""),
   /** Preselected dynamic content items */
   preselectedDynamicContent: e(
-    a(y),
+    c(f),
     []
   ),
   /** Selected unsubscribe page IDs */
-  selectedUnsubscribePages: e(a(b()), []),
+  selectedUnsubscribePages: e(c(p()), []),
   /** Force recreate template in Stripo storage (use true when updating externally modified templates) */
-  forceRecreate: e(c(), !1)
-}), f = o({
+  forceRecreate: e(a(), !1)
+}), A = o({
   /** Sender display name */
   senderName: e(t(), ""),
   /** Email subject line */
@@ -85,30 +86,34 @@ const m = {
   /** Path to translations object */
   translationsPath: e(t(), "window.trans[Object.keys(window.trans)[0]]"),
   /** Migration date for template compatibility */
-  migrationDate: e(b(), 1759696858),
+  migrationDate: e(p(), 1759696858),
   /** Email header settings */
-  emailHeader: e(f, { senderName: "", subject: "" })
-}), I = o({
+  emailHeader: e(A, { senderName: "", subject: "" }),
+  /** Folder name for user-saved modules (used by Stripo plugin panel for path construction) */
+  savedModulesFolderName: e(t(), b.SAVED_MODULES),
+  /** Folder name for default/prebuilt modules (used by Stripo plugin panel for path construction) */
+  defaultModulesFolderName: e(t(), b.DEFAULT_MODULES)
+}), T = o({
   /** Whether to show the header bar */
-  showHeader: e(c(), !0),
+  showHeader: e(a(), !0),
   /** Custom label for back button (if shown) */
   backButtonLabel: e(t())
-}), T = o({
+}), I = o({
   /** Enable dynamic content insertion */
-  dynamicContent: e(c(), !0),
+  dynamicContent: e(a(), !0),
   /** Enable save as template functionality */
-  saveAsTemplate: e(c(), !0),
+  saveAsTemplate: e(a(), !0),
   /** Enable version history */
-  versionHistory: e(c(), !0),
+  versionHistory: e(a(), !0),
   /** Enable test message sending */
-  testMessage: e(c(), !0),
+  testMessage: e(a(), !0),
   /** Enable display conditions */
-  displayConditions: e(c(), !0),
+  displayConditions: e(a(), !0),
   /** Enable unsubscribe block */
-  unsubscribe: e(c(), !0),
+  unsubscribe: e(a(), !0),
   /** Disable modules panel in the editor */
-  modulesDisabled: e(c(), !1)
-}), A = n([
+  modulesDisabled: e(a(), !1)
+}), E = n([
   "amp-accordion",
   "amp-carousel",
   "amp-form-controls",
@@ -133,12 +138,12 @@ const m = {
 ]), O = o({
   /** Default blocks to exclude from the editor */
   excludeDefaults: e(
-    a(A),
+    c(E),
     []
   ),
   /** Custom blocks to include in the editor */
   includeCustoms: e(
-    a(g),
+    c(g),
     []
   )
 }), l = o({
@@ -147,8 +152,8 @@ const m = {
   /** Human-readable description */
   description: e(t()),
   /** Priority for rule ordering (lower = earlier) */
-  priority: b()
-}), E = o({
+  priority: p()
+}), L = o({
   ...l.entries,
   type: r("replace"),
   /** String to search for */
@@ -156,8 +161,8 @@ const m = {
   /** Replacement string */
   replacement: t(),
   /** Replace all occurrences (default: false) */
-  replaceAll: e(c())
-}), N = o({
+  replaceAll: e(a())
+}), M = o({
   ...l.entries,
   type: r("regex"),
   /** Regex pattern string */
@@ -166,82 +171,82 @@ const m = {
   replacement: t(),
   /** Regex flags (e.g., 'gi') */
   flags: e(t())
-}), L = o({
+}), N = o({
   ...l.entries,
   type: r("remove"),
   /** Strings or patterns to remove */
-  targets: a(t())
-}), v = o({
+  targets: c(t())
+}), D = o({
   ...l.entries,
   type: r("custom"),
   /** Custom processor function */
-  processor: d(
+  processor: S(
     (i) => typeof i == "function",
     "processor must be a function"
   )
-}), x = k("type", [
-  E,
-  N,
+}), v = k("type", [
   L,
-  v
-]), B = o({
+  M,
+  N,
+  D
+]), U = o({
   /** Custom compiler rules to apply */
-  customRules: e(a(x), []),
+  customRules: e(c(v), []),
   /** Skip default compiler rules */
-  ignoreDefaultRules: e(c(), !1)
-}), P = o({
+  ignoreDefaultRules: e(a(), !1)
+}), x = o({
   /**
    * External validation handler called before save completes.
    * Return false to cancel the save operation.
    */
   externalValidation: e(
-    d(
+    S(
       (i) => typeof i == "function",
       "externalValidation must be a function"
     )
   )
-}), D = o({
+}), H = o({
   // Required sections
   /** Identity configuration (required) */
-  identity: S,
+  identity: h,
   /** Partner configuration (required) */
-  partner: h,
+  partner: y,
   // Optional sections (with defaults)
   /** Template content and presets */
   template: e(R, {}),
   /** Editor settings */
   editor: e(C, {}),
   /** UI configuration */
-  ui: e(I, {}),
+  ui: e(T, {}),
   /** Feature toggles */
-  features: e(T, {}),
+  features: e(I, {}),
   /** Block configuration */
   blocks: e(O, {}),
   /** Compiler configuration */
-  compiler: e(B, {}),
+  compiler: e(U, {}),
   /** Callbacks and event handlers */
-  callbacks: e(P, {})
+  callbacks: e(x, {})
 });
 export {
   O as BlocksSchema,
-  P as CallbacksSchema,
-  x as CompilerRuleSchema,
-  B as CompilerSchema,
+  x as CallbacksSchema,
+  v as CompilerRuleSchema,
+  U as CompilerSchema,
   g as CustomBlockTypeSchema,
-  v as CustomRuleSchema,
-  A as DefaultBlockTypeSchema,
-  y as DynamicContentSchema,
+  D as CustomRuleSchema,
+  E as DefaultBlockTypeSchema,
+  f as DynamicContentSchema,
   C as EditorSchema,
-  f as EmailHeaderSchema,
-  T as FeaturesSchema,
-  D as GuidoConfigSchema,
-  S as IdentitySchema,
+  A as EmailHeaderSchema,
+  I as FeaturesSchema,
+  H as GuidoConfigSchema,
+  h as IdentitySchema,
   m as MessageType,
-  h as PartnerSchema,
+  y as PartnerSchema,
   s as ProductType,
-  N as RegexRuleSchema,
-  L as RemoveRuleSchema,
-  E as ReplaceRuleSchema,
+  M as RegexRuleSchema,
+  N as RemoveRuleSchema,
+  L as ReplaceRuleSchema,
   R as TemplateSchema,
-  I as UISchema
+  T as UISchema
 };

package/dist/components/Guido.vue.js

@@ -12,7 +12,7 @@ var t = function() {
   n,
   !1,
   null,
-  "890b5336"
+  "a26d7792"
 );
 const v = s.exports;
 export {

package/dist/components/Guido.vue2.js

@@ -1,54 +1,64 @@
-import { defineComponent as B, defineAsyncComponent as P, ref as N, computed as U, watch as R, onMounted as z, onUnmounted as K } from "vue";
-import { provideGuidoActions as M } from "../composables/useGuidoActions.js";
-import { usePartner as j } from "../composables/usePartner.js";
-import { useStripo as q } from "../composables/useStripo.js";
-import { useTimerClone as J } from "../composables/useTimerClone.js";
-import { migrate as W } from "../config/migrator/index.js";
-import Q from "./organisms/base/Toaster.vue.js";
-import V from "./organisms/extensions/recommendation/FilterSelectionDrawer.vue.js";
-import X from "./organisms/header/HeaderWrapper.vue.js";
-import Y from "./organisms/LoadingWrapper.vue.js";
-import Z from "./organisms/save-as-template/SaveAsTemplateDrawer.vue.js";
-import $ from "./organisms/unsubscribe/UnsubscribeWrapper.vue.js";
-import { useStripoApi as ee } from "../services/stripoApi.js";
-import { useConfigStore as oe } from "../stores/config.js";
-import { useDynamicContentStore as te } from "../stores/dynamic-content.js";
-import { useEditorStore as ne } from "../stores/editor.js";
-import { usePreviewStore as re } from "../stores/preview.js";
-import { useUnsubscribeStore as se } from "../stores/unsubscribe.js";
-const Ee = /* @__PURE__ */ B({
+import { defineComponent as K, defineAsyncComponent as _, ref as V, computed as P, watch as j, onMounted as q, onUnmounted as J } from "vue";
+import { provideGuidoActions as Q } from "../composables/useGuidoActions.js";
+import { usePartner as X } from "../composables/usePartner.js";
+import { useStripo as Y } from "../composables/useStripo.js";
+import { useTimerClone as Z } from "../composables/useTimerClone.js";
+import { migrate as A } from "../config/migrator/index.js";
+import { ModuleFolderDefaults as N } from "../enums/defaults.js";
+import $ from "./organisms/base/Toaster.vue.js";
+import ee from "./organisms/extensions/recommendation/FilterSelectionDrawer.vue.js";
+import oe from "./organisms/header/HeaderWrapper.vue.js";
+import te from "./organisms/LoadingWrapper.vue.js";
+import ne from "./organisms/save-as-template/SaveAsTemplateDrawer.vue.js";
+import se from "./organisms/unsubscribe/UnsubscribeWrapper.vue.js";
+import { useStripoApi as re } from "../services/stripoApi.js";
+import { useConfigStore as ce } from "../stores/config.js";
+import { useDynamicContentStore as ae } from "../stores/dynamic-content.js";
+import { useEditorStore as ie } from "../stores/editor.js";
+import { usePreviewStore as me } from "../stores/preview.js";
+import { useUnsubscribeStore as de } from "../stores/unsubscribe.js";
+const Me = /* @__PURE__ */ K({
   __name: "Guido",
   props: {
     config: null
   },
   emits: ["dynamic-content:open", "back", "save:start", "save:complete", "on-change", "ready", "onboarding:finished", "test-email:click"],
-  setup(_, { expose: I, emit: t }) {
-    const l = _, L = P(
+  setup(W, { expose: I, emit: t }) {
+    const v = W, O = _(
       () => import("./organisms/email-preview/PreviewContainer.vue.js")
-    ), A = P(
+    ), G = _(
       () => import("./organisms/onboarding/OnboardingWrapper.vue.js")
-    ), p = N(), c = te(), u = se(), n = oe();
-    n.init(l.config);
-    const i = ne(), F = re(), r = U(() => i.hasChanges), { isTestPartner: G } = j(), v = () => {
+    ), h = V(), i = ae(), y = de(), s = ce();
+    s.init(v.config);
+    const m = ie(), H = me(), c = P(() => m.hasChanges), { isTestPartner: x } = X(), f = () => {
       var e;
-      return (e = p.value) == null ? void 0 : e.handleSave(!0);
-    }, { templateId: a, userId: y, partnerName: h, productType: b, username: f, template: o } = n, s = (o == null ? void 0 : o.html) || "", g = (o == null ? void 0 : o.css) || "", m = (o == null ? void 0 : o.preselectedDynamicContent) || [];
-    i.templateId = a;
-    const { initPlugin: S } = q({
-      emailId: a,
-      userId: y,
-      username: f,
-      partnerName: h,
-      productType: b,
-      preselectedDynamicContentList: m,
+      return (e = h.value) == null ? void 0 : e.handleSave(!0);
+    }, {
+      templateId: d,
+      userId: b,
+      partnerName: S,
+      username: g,
+      template: o,
+      editor: n
+    } = s, a = (o == null ? void 0 : o.html) || "", D = (o == null ? void 0 : o.css) || "", l = (o == null ? void 0 : o.preselectedDynamicContent) || [], w = (n == null ? void 0 : n.savedModulesFolderName) || N.SAVED_MODULES, E = (n == null ? void 0 : n.defaultModulesFolderName) || N.DEFAULT_MODULES;
+    m.templateId = d;
+    const u = {
+      emailId: d,
+      userId: b,
+      username: g,
+      partnerName: S,
+      savedModulesFolderName: w,
+      defaultModulesFolderName: E
+    }, C = {
+      preselectedDynamicContentList: l,
       onReady: () => {
         console.debug("guido:ready"), t("ready");
       }
-    }), { getDefaultTemplate: w } = ee(), { cloneTimersOnSave: C, hasTimerBlocks: D } = J(), H = U(() => {
+    }, { initPlugin: T } = Y(u, C), { getDefaultTemplate: k } = re(), { cloneTimersOnSave: F, hasTimerBlocks: U } = Z(), B = P(() => {
       var e;
-      return !((e = n.ui) != null && e.showHeader);
+      return !((e = s.ui) != null && e.showHeader);
     });
-    M({
+    Q({
       onBack: () => {
         console.debug("guido:back"), t("back");
       },
@@ -56,55 +66,56 @@ const Ee = /* @__PURE__ */ B({
         console.debug("guido:save:start"), t("save:start");
       },
       onSaveComplete: (e) => {
-        console.debug("guido:save:complete", e), t("save:complete", e);
+        const r = { ...e, metadata: u };
+        console.debug("guido:save:complete", r), t("save:complete", r);
       },
       onTestEmailClick: () => {
         console.debug("guido:test-email:click"), t("test-email:click");
       }
     });
-    const E = (e) => {
-      console.debug("dynamic-content:close", e), c.setSelectedDynamicContent(e), document.dispatchEvent(new CustomEvent("dynamic-content:close", { detail: e }));
-    }, k = () => {
+    const L = (e) => {
+      console.debug("dynamic-content:close", e), i.setSelectedDynamicContent(e), document.dispatchEvent(new CustomEvent("dynamic-content:close", { detail: e }));
+    }, M = () => {
       console.debug("dynamic-content:close", "Without Data"), document.dispatchEvent(new CustomEvent("dynamic-content:close", { detail: { text: "", value: "" } }));
     };
-    R(() => r.value, () => {
-      t("on-change", r.value);
+    j(() => c.value, () => {
+      t("on-change", c.value);
     });
-    const d = (e) => {
-      const T = e, { attribute: O, position: x } = T.detail;
-      console.debug("dynamic-content:open", T.detail), t("dynamic-content:open", O, x);
+    const p = (e) => {
+      const r = e, { attribute: R, position: z } = r.detail;
+      console.debug("dynamic-content:open", r.detail), t("dynamic-content:open", R, z);
     };
-    return z(async () => {
+    return q(async () => {
       console.debug("Guido says happy coding 🎉"), console.debug("🚗 Ka-Chow");
       try {
-        u.selectedUnsubscribePages = (o == null ? void 0 : o.selectedUnsubscribePages) || [];
+        y.selectedUnsubscribePages = (o == null ? void 0 : o.selectedUnsubscribePages) || [];
         let e = {
-          html: s && await W(s),
-          css: g
+          html: a && await A(a),
+          css: D
         };
-        e.html || (e = await w(), e.html = await W(e.html)), D(e.html) && (e.html = await C(e.html)), await S(e), c.selectedDynamicContentList = m;
+        e.html || (e = await k(), e.html = await A(e.html)), U(e.html) && (e.html = await F(e.html)), await T(e), i.selectedDynamicContentList = l;
       } catch (e) {
         console.error("Failed to initialize Stripo editor:", e);
       }
-      document.addEventListener("dynamic-content:open", d);
-    }), K(() => {
-      document.removeEventListener("dynamic-content:open", d);
+      document.addEventListener("dynamic-content:open", p);
+    }), J(() => {
+      document.removeEventListener("dynamic-content:open", p);
       try {
         window.UIEditor.removeEditor();
       } catch {
         console.debug("Failed to remove Stripo editor: No editor found");
       }
-      n.reset();
+      s.reset();
     }), I({
       dynamicContent: {
-        insert: E,
-        close: k
+        insert: L,
+        close: M
       },
-      hasChanges: r,
-      saveSilent: v
-    }), { __sfc: !0, PreviewContainer: L, OnboardingWrapper: A, headerWrapperRef: p, dynamicContentStore: c, unsubscribeStore: u, props: l, configStore: n, editorStore: i, previewStore: F, hasChanges: r, isTestPartner: G, saveSilent: v, templateId: a, userId: y, partnerName: h, productType: b, username: f, templateConfig: o, html: s, css: g, preselectedDynamicContentList: m, emit: t, initPlugin: S, getDefaultTemplate: w, cloneTimersOnSave: C, hasTimerBlocks: D, noHeader: H, insertDynamicContent: E, closeDynamicContent: k, handleDynamicContentOpen: d, Toaster: Q, FilterSelectionDrawer: V, HeaderWrapper: X, LoadingWrapper: Y, SaveAsTemplateDrawer: Z, UnsubscribeWrapper: $ };
+      hasChanges: c,
+      saveSilent: f
+    }), { __sfc: !0, PreviewContainer: O, OnboardingWrapper: G, headerWrapperRef: h, dynamicContentStore: i, unsubscribeStore: y, props: v, configStore: s, editorStore: m, previewStore: H, hasChanges: c, isTestPartner: x, saveSilent: f, templateId: d, userId: b, partnerName: S, username: g, templateConfig: o, editorConfig: n, html: a, css: D, preselectedDynamicContentList: l, savedModulesFolderName: w, defaultModulesFolderName: E, emit: t, metadata: u, options: C, initPlugin: T, getDefaultTemplate: k, cloneTimersOnSave: F, hasTimerBlocks: U, noHeader: B, insertDynamicContent: L, closeDynamicContent: M, handleDynamicContentOpen: p, Toaster: $, FilterSelectionDrawer: ee, HeaderWrapper: oe, LoadingWrapper: te, SaveAsTemplateDrawer: ne, UnsubscribeWrapper: se };
   }
 });
 export {
-  Ee as default
+  Me as default
 };

package/dist/components/organisms/unsubscribe/UnsubscribePageSelection.vue.js

@@ -16,7 +16,7 @@ var o = function() {
   i,
   !1,
   null,
-  "a86fc486"
+  "df672485"
 );
 const _ = c.exports;
 export {