@useinsider/guido 1.0.0-beta.b4126b3 → 1.0.0-beta.b79463f

package/README.md

@@ -14,7 +14,10 @@ Guido is a Vue 2 + TypeScript wrapper for the Stripo Email Editor plugin. Easily
 ```bash
 npm install @useinsider/guido
 ```
+### Prerequisites
+  🍍 Your project should have `pinia`
 
+---
 ## 🚀 Usage
 
 ### Basic Usage
@@ -23,9 +26,11 @@ npm install @useinsider/guido
 <template>
   <div>
     <Guido
+      ref="guidoEditor"
       :email-id="emailId"
       :user-id="userId"
       :guido-config="guidoConfig"
+      @dynamic-content:open="handleDynamicContentOpen"
     />
   </div>
 </template>
@@ -44,7 +49,29 @@ export default {
       guidoConfig: {
         translationsPath: 'window.trans.en'
       }
+      dynamicContentModalVisible: false
     };
+  },
+
+  methods: {
+    handleDynamicContentOpen() {
+      this.dynamicContentModalVisible = true;
+    }
+    // ⚠️ Your own Dynamic Content Modal should have this id: #guido-dynamic-content-modal
+    handleDynamicContentInsert() {
+      this.$ref.guidoEditor?.dynamicContent.insert({
+        text: 'Text', 
+        value: 'Value', 
+        fallback: 'Fallback'
+      });
+
+      this.dynamicContentModalVisible = false;
+    },
+    // ⚠️ It's mandatory. There is no way to understand if user closes the modal without selection.
+    handleDynamicContentClose() {
+      this.$ref.guidoEditor?.dynamicContent.close();
+    }
+
   }
 };
 </script>
@@ -63,7 +90,13 @@ export default {
 | `productType` | `string` | ⚪ | Getting from URL path | Unique identifier for the product draft |
 | `guidoConfig` | `GuidoConfig` | ✅ | - | Configuration object for the editor |
 
-### GuidoConfig Interface
+### Guido Exposed Methods
+```typescript
+dynamicContent.insert(DynamicContent);
+dynamicContent.close();
+```
+
+### Guido Interfaces
 
 ```typescript
 interface GuidoConfig {
@@ -75,6 +108,20 @@ interface GuidoConfig {
 |----------|------|---------|-------------|
 | `translationsPath` | `string` | `'window.trans.en'` | JavaScript path to the translations object |
 
+```typescript
+interface DynamicContent {
+  value: string;
+  text: string;
+  fallback?: string;
+}
+```
+
+| Property | Type | Default | Description |
+|----------|------|---------|-------------|
+| `value` | `string` | '' | Value of the dynamic content |
+| `text` | `string` | '' | Visible value of the dynamic content |
+| `fallback?` | `string` | '' | Fallback value of the dynamic content. Optional |
+
 ### TypeScript Types
 
 The library exports the following TypeScript types:
@@ -88,19 +135,6 @@ import type { GuidoConfig } from '@useinsider/guido';
 import type { StripoEventType } from '@useinsider/guido';
 ```
 
-### StripoEventType
-
-```typescript
-type StripoEventType = 
-  | 'save'
-  | 'export'
-  | 'close'
-  | 'autosave'
-  | 'publish'
-  | 'export:requested'
-  | 'export:ready';
-```
-
 ---
 
 ## 🔧 Development
@@ -170,6 +204,34 @@ const trans = useTranslations();
 trans('foo.bar')
 ```
 
+## 📦 Local Building (Recommended)
+
+Run this commands if you want to test the package on your local before sending to NPM.
+```sh
+bun run build
+```
+
+Since bun does not have packaging yet, use npm here: 🥲
+```sh
+npm pack
+```
+
+It'll crate like `useinsider-guido-1.0.0.tgz` file.
+
+Move this file to your project path like: `email-fe` via:
+```sh
+cp useinsider-guido-1.0.0.tgz ../email-fe
+```
+
+Install the file to your project: 
+```sh
+npm i ./useinsider-guido-1.0.0.tgz
+```
+
+Then you just need to rebuild to your project or restart the Container. 🎉
+
+For Future, we can create a shell script for it. Feel free to help 🙃
+
 ## 📦 Build Output
 
 The library builds to multiple formats:
@@ -211,7 +273,12 @@ ISC License
 - [@useinsider/design-system-vue](https://github.com/useinsider/design-system-vue) - Insider's Vue design system
 
 ## 🎯 TODO:
-- [editor.css](src/static/editor.css) should be optimized with variables & `sass-loader`.
+- CSS part should be optimized with variables & `sass-loader`.
 - Master Version Generator should be fixed.
 - Playwright integration
 - Commitlint & Precommit Hooks integration
+- We need to emit save event and we should return template config to it
+- Default template should be same with production
+- Open Guido with saved template
+- Get User ID, Email and Unique Template ID as dynamic from props
+- Get Pre-built display conditions from API

package/dist/@types/generic.d.ts

@@ -1,23 +1,8 @@
 export type GuidoConfig = {
     translationsPath: string;
 };
-export interface User {
-    id: number;
-    name: string;
-    email: string;
-}
-export interface ApiResponse<T> {
-    data: T;
-    message: string;
-    success: boolean;
-}
-export type ToasterType = 'success' | 'error' | 'info' | 'warning';
-export interface ToasterActionButton {
+export type DynamicContent = {
+    value: string;
     text: string;
-    onClick: () => void;
-}
-export interface ToasterOptions {
-    type?: ToasterType;
-    message: string;
-    actionButton?: ToasterActionButton;
-}
+    fallback?: string;
+};

package/dist/App.vue.d.ts

@@ -1,3 +1,3 @@
 import '../node_modules/@useinsider/design-system-vue/dist/design-system-vue.css';
-declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue/types/v3-component-options.js").ComponentOptionsMixin, import("vue/types/v3-component-options.js").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
 export default _default;

package/dist/_virtual/AddCustomFont.js

@@ -0,0 +1,4 @@
+var o = {};
+export {
+  o as __exports
+};

package/dist/_virtual/AiAssistantValueType.js

@@ -0,0 +1,4 @@
+var s = {};
+export {
+  s as __exports
+};

package/dist/_virtual/BackgroundColorBuiltInControl.js

@@ -0,0 +1,4 @@
+var o = {};
+export {
+  o as __exports
+};

package/dist/_virtual/BackgroundImageBuiltInControl.js

@@ -0,0 +1,4 @@
+var o = {};
+export {
+  o as __exports
+};

package/dist/_virtual/Block.js

@@ -0,0 +1,4 @@
+var o = {};
+export {
+  o as __exports
+};

package/dist/_virtual/BlockAttributes.js

@@ -0,0 +1,4 @@
+var t = {};
+export {
+  t as __exports
+};

package/dist/_virtual/BlockCompositionType.js

@@ -0,0 +1,4 @@
+var o = {};
+export {
+  o as __exports
+};

package/dist/_virtual/BlockPaddingsBuiltInControl.js

@@ -0,0 +1,4 @@
+var o = {};
+export {
+  o as __exports
+};

package/dist/_virtual/BlockRenderer.js

@@ -0,0 +1,4 @@
+var e = {};
+export {
+  e as __exports
+};

package/dist/_virtual/BlockType.js

@@ -0,0 +1,4 @@
+var e = {};
+export {
+  e as __exports
+};

package/dist/_virtual/BlocksPanel.js

@@ -0,0 +1,4 @@
+var a = {};
+export {
+  a as __exports
+};

package/dist/_virtual/BuiltInControl.js

@@ -0,0 +1,4 @@
+var o = {};
+export {
+  o as __exports
+};

package/dist/_virtual/BuiltInControlTypes.js

@@ -0,0 +1,4 @@
+var o = {};
+export {
+  o as __exports
+};

package/dist/_virtual/ButtonBorderBuiltInControl.js

@@ -0,0 +1,4 @@
+var o = {};
+export {
+  o as __exports
+};

package/dist/_virtual/ButtonColorBuiltInControl.js

@@ -0,0 +1,4 @@
+var o = {};
+export {
+  o as __exports
+};

package/dist/_virtual/ButtonFontColorBuiltInControl.js

@@ -0,0 +1,4 @@
+var o = {};
+export {
+  o as __exports
+};

package/dist/_virtual/ButtonInternalIndentsBuiltInControl.js

@@ -0,0 +1,4 @@
+var t = {};
+export {
+  t as __exports
+};

package/dist/_virtual/ButtonTextBuiltInControl.js

@@ -0,0 +1,4 @@
+var t = {};
+export {
+  t as __exports
+};

package/dist/_virtual/ContextAction.js

@@ -0,0 +1,4 @@
+var t = {};
+export {
+  t as __exports
+};

package/dist/_virtual/ContextActionType.js

@@ -0,0 +1,4 @@
+var t = {};
+export {
+  t as __exports
+};

package/dist/_virtual/Control.js

@@ -0,0 +1,4 @@
+var o = {};
+export {
+  o as __exports
+};

package/dist/_virtual/EditorStatePropertyType.js

@@ -0,0 +1,4 @@
+var r = {};
+export {
+  r as __exports
+};

package/dist/_virtual/Extension.js

@@ -0,0 +1,4 @@
+var e = {};
+export {
+  e as __exports
+};

package/dist/_virtual/ExtensionBuilder.js

@@ -0,0 +1,4 @@
+var e = {};
+export {
+  e as __exports
+};

package/dist/_virtual/FontFamilyBuiltInControl.js

@@ -0,0 +1,4 @@
+var o = {};
+export {
+  o as __exports
+};

package/dist/_virtual/LinkColorBuiltInControl.js

@@ -0,0 +1,4 @@
+var o = {};
+export {
+  o as __exports
+};

package/dist/_virtual/ModificationDescription.js

@@ -0,0 +1,4 @@
+var i = {};
+export {
+  i as __exports
+};

package/dist/_virtual/PanelPosition.js

@@ -0,0 +1,4 @@
+var o = {};
+export {
+  o as __exports
+};

package/dist/_virtual/PreviewDeviceMode.js

@@ -0,0 +1,4 @@
+var e = {};
+export {
+  e as __exports
+};

package/dist/_virtual/SettingsPanelRegistry.js

@@ -0,0 +1,4 @@
+var e = {};
+export {
+  e as __exports
+};

package/dist/_virtual/SettingsPanelTab.js

@@ -0,0 +1,4 @@
+var a = {};
+export {
+  a as __exports
+};

package/dist/_virtual/SettingsTab.js

@@ -0,0 +1,4 @@
+var t = {};
+export {
+  t as __exports
+};

package/dist/_virtual/StructureBorderBuiltInControl.js

@@ -0,0 +1,4 @@
+var r = {};
+export {
+  r as __exports
+};

package/dist/_virtual/StructurePaddingsBuiltInControl.js

@@ -0,0 +1,4 @@
+var r = {};
+export {
+  r as __exports
+};

package/dist/_virtual/TextColorBuiltInControl.js

@@ -0,0 +1,4 @@
+var o = {};
+export {
+  o as __exports
+};

package/dist/_virtual/TextLineSpacingBuiltInControl.js

@@ -0,0 +1,4 @@
+var t = {};
+export {
+  t as __exports
+};

package/dist/_virtual/TextSizeBuiltInControl.js

@@ -0,0 +1,4 @@
+var t = {};
+export {
+  t as __exports
+};

package/dist/_virtual/TextStyleBuiltInControl.js

@@ -0,0 +1,4 @@
+var t = {};
+export {
+  t as __exports
+};

package/dist/_virtual/UIElement.js

@@ -0,0 +1,4 @@
+var e = {};
+export {
+  e as __exports
+};

package/dist/_virtual/UIElementTagRegistry.js

@@ -0,0 +1,4 @@
+var e = {};
+export {
+  e as __exports
+};

package/dist/_virtual/UIElementType.js

@@ -0,0 +1,4 @@
+var e = {};
+export {
+  e as __exports
+};

package/dist/_virtual/UIElementsAttributes.js

@@ -0,0 +1,4 @@
+var t = {};
+export {
+  t as __exports
+};

package/dist/_virtual/index.js

@@ -0,0 +1,5 @@
+import { __require as r } from "../node_modules/@stripoinc/ui-editor-extensions/dist/index.js";
+var i = r();
+export {
+  i as d
+};

package/dist/_virtual/index2.js

@@ -0,0 +1,4 @@
+var r = {};
+export {
+  r as __exports
+};

package/dist/components/Guido.vue.d.ts

@@ -1,4 +1,4 @@
-import type { GuidoConfig } from '@@/Types/generic';
+import type { DynamicContent, GuidoConfig } from '@@/Types/generic';
 type __VLS_Props = {
     emailId: string;
     userId: string;
@@ -7,7 +7,14 @@ type __VLS_Props = {
     username?: string;
     guidoConfig: GuidoConfig;
 };
-declare const _default: import("vue").DefineComponent<__VLS_TypePropsToOption<__VLS_Props>, {}, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToOption<__VLS_Props>>>, {}>;
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToOption<__VLS_Props>, {
+    dynamicContent: {
+        insert: (data: DynamicContent) => void;
+        close: () => void;
+    };
+}, {}, {}, {}, import("vue/types/v3-component-options.js").ComponentOptionsMixin, import("vue/types/v3-component-options.js").ComponentOptionsMixin, {
+    "dynamic-content:open": (detail: DynamicContent | null) => void;
+}, string, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToOption<__VLS_Props>>>, {}>;
 export default _default;
 type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
 type __VLS_TypePropsToOption<T> = {

package/dist/components/Guido.vue.js

@@ -10,7 +10,7 @@ var s = function() {
   _,
   !1,
   null,
-  "d4a5c957"
+  "89423288"
 );
 const f = a.exports;
 export {

package/dist/components/Guido.vue2.js

@@ -1,10 +1,10 @@
-import { defineComponent as f, onMounted as c } from "vue";
-import { usePartner as g } from "../composables/usePartner.js";
-import { useStripo as _ } from "../composables/useStripo.js";
-import { useTemplates as y } from "../composables/useTemplates.js";
-import { DefaultUsername as C, DefaultGuidoConfig as T } from "../enums/defaults.js";
-import w from "./organisms/header/HeaderWrapper.vue.js";
-const h = /* @__PURE__ */ f({
+import { defineComponent as v, onMounted as w } from "vue";
+import { usePartner as h } from "../composables/usePartner.js";
+import { useStripo as D } from "../composables/useStripo.js";
+import { useTemplates as E } from "../composables/useTemplates.js";
+import { DefaultUsername as _, DefaultGuidoConfig as b } from "../enums/defaults.js";
+import T from "./organisms/header/HeaderWrapper.vue.js";
+const W = /* @__PURE__ */ v({
   __name: "Guido",
   props: {
     emailId: null,
@@ -14,30 +14,45 @@ const h = /* @__PURE__ */ f({
     username: null,
     guidoConfig: null
   },
-  setup(d) {
-    const o = d, { getPartnerName: r, getProductType: t } = g(), {
-      emailId: n,
-      userId: i,
-      guidoConfig: a,
-      partnerName: u = r(),
-      productType: p = t(),
-      username: m = C
-    } = o;
+  emits: ["dynamic-content:open"],
+  setup(g, { expose: C, emit: n }) {
+    const t = g, { getPartnerName: o, getProductType: c } = h(), {
+      emailId: i,
+      userId: a,
+      guidoConfig: r,
+      partnerName: s = o(),
+      productType: d = c(),
+      username: u = _
+    } = t;
     window.GuidoConfig = {
-      ...T,
-      ...a
+      ...b,
+      ...r
     };
-    const { initPlugin: l } = _({ emailId: n, userId: i, username: m, partnerName: u, productType: p }), { getDefaultTemplate: s } = y();
-    return c(async () => {
+    const { initPlugin: m } = D({ emailId: i, userId: a, username: u, partnerName: s, productType: d }), { getDefaultTemplate: l } = E(), p = (e) => {
+      console.debug("dynamic-content:close", e), document.dispatchEvent(new CustomEvent("dynamic-content:close", { detail: e }));
+    }, y = () => {
+      console.debug("dynamic-content:close", "Without Data"), document.dispatchEvent(new CustomEvent("dynamic-content:close", { detail: { text: "", value: "" } }));
+    };
+    return w(async () => {
+      console.debug("Guido says happy coding 🎉"), console.debug("🚗 Ka-Chow");
       try {
-        const e = await s();
-        await l(e);
+        const e = await l();
+        await m(e);
       } catch (e) {
         console.error("Failed to initialize Stripo editor:", e);
       }
-    }), { __sfc: !0, props: o, getPartnerName: r, getProductType: t, emailId: n, userId: i, guidoConfig: a, partnerName: u, productType: p, username: m, initPlugin: l, getDefaultTemplate: s, HeaderWrapper: w };
+      document.addEventListener("dynamic-content:open", (e) => {
+        const f = e;
+        console.debug("dynamic-content:open", f.detail), n("dynamic-content:open", f.detail);
+      });
+    }), C({
+      dynamicContent: {
+        insert: p,
+        close: y
+      }
+    }), { __sfc: !0, props: t, getPartnerName: o, getProductType: c, emailId: i, userId: a, guidoConfig: r, partnerName: s, productType: d, username: u, emit: n, initPlugin: m, getDefaultTemplate: l, insertDynamicContent: p, closeDynamicContent: y, HeaderWrapper: T };
   }
 });
 export {
-  h as default
+  W as default
 };

package/dist/components/organisms/header/LeftSlot.vue.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue/types/v3-component-options.js").ComponentOptionsMixin, import("vue/types/v3-component-options.js").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
 export default _default;

package/dist/components/organisms/header/LeftSlot.vue.js

@@ -1,17 +1,17 @@
 import r from "./LeftSlot.vue2.js";
 import o from "../../../_virtual/_plugin-vue2_normalizer.js";
-var _ = function() {
-  var t = this, e = t._self._c, n = t._self._setupProxy;
-  return e("div", [e(n.InButtonV2, { attrs: { id: "guido__back-button", "label-text": "Back", "left-icon": "line-arrow-left", styling: "text", type: "secondary" } })], 1);
-}, s = [], a = /* @__PURE__ */ o(
+var n = function() {
+  var t = this, e = t._self._c, s = t._self._setupProxy;
+  return e("div", { staticClass: "d-f a-i-c" }, [e(s.InButtonV2, { staticClass: "p-2", attrs: { id: "guido__back-button", "label-text": "Back", "left-icon": "line-arrow-left", styling: "text", type: "secondary" } }), s.editorStore.isVersionHistoryOpen ? e(s.RestoreButton, { staticClass: "ml-3" }) : t._e()], 1);
+}, a = [], i = /* @__PURE__ */ o(
   r,
-  _,
-  s,
+  n,
+  a,
   !1,
   null,
   null
 );
-const i = a.exports;
+const f = i.exports;
 export {
-  i as default
+  f as default
 };

package/dist/components/organisms/header/LeftSlot.vue2.js

@@ -1,9 +1,11 @@
 import { defineComponent as t } from "vue";
-import { InButtonV2 as o } from "@useinsider/design-system-vue";
+import { useEditorStore as o } from "../../../stores/editor.js";
+import { InButtonV2 as r } from "@useinsider/design-system-vue";
+import e from "./version-history/RestoreButton.vue.js";
 const _ = /* @__PURE__ */ t({
   __name: "LeftSlot",
-  setup(e) {
-    return { __sfc: !0, InButtonV2: o };
+  setup(m) {
+    return { __sfc: !0, editorStore: o(), InButtonV2: r, RestoreButton: e };
   }
 });
 export {

package/dist/components/organisms/header/MiddleSlot.vue.js

@@ -1,17 +1,17 @@
 import s from "./MiddleSlot.vue2.js";
-import n from "../../../_virtual/_plugin-vue2_normalizer.js";
-var i = function() {
+import i from "../../../_virtual/_plugin-vue2_normalizer.js";
+var n = function() {
   var e = this, o = e._self._c, t = e._self._setupProxy;
-  return t.editorStore.isVersionHistoryOpen ? o(t.VersionHistory) : o("div", { staticClass: "d-f" }, [o(t.InButtonV2, { attrs: { id: "guido__undo-button", "left-icon": "line-undo", styling: "ghost", type: "secondary", "label-text-status": !1 } }), o(t.InButtonV2, { attrs: { id: "guido__redo-button", "left-icon": "line-redo", styling: "ghost", type: "secondary", "label-text-status": !1 } }), o(t.InButtonV2, { attrs: { id: "guido__code-button", "left-icon": "line-code", styling: "ghost", "tooltip-text": "Code Editor", type: "secondary", "label-text-status": !1, "selected-status": t.editorStore.isCodeEditorOpen, "tooltip-options": t.getTooltipOptions("guido__code-button") } }), o(t.InButtonV2, { attrs: { id: "guido__preview-button", "left-icon": "line-show-on", styling: "ghost", type: "secondary", "label-text-status": !1, "tooltip-options": t.getTooltipOptions("guido__preview-button"), "tooltip-text": t.trans("newsletter.email-preview") } })], 1);
-}, l = [], r = /* @__PURE__ */ n(
+  return t.editorStore.isVersionHistoryOpen ? o("div", { staticClass: "d-f" }, [o(t.VersionHistory), o(t.VersionHistoryViewOptions)], 1) : o("div", { staticClass: "d-f" }, [o(t.InButtonV2, { attrs: { id: "guido__undo-button", "left-icon": "line-undo", styling: "ghost", type: "secondary", "label-text-status": !1 } }), o(t.InButtonV2, { attrs: { id: "guido__redo-button", "left-icon": "line-redo", styling: "ghost", type: "secondary", "label-text-status": !1 } }), o(t.InButtonV2, { attrs: { id: "guido__code-button", "left-icon": "line-code", styling: "ghost", "tooltip-text": "Code Editor", type: "secondary", "label-text-status": !1, "selected-status": t.editorStore.isCodeEditorOpen, "tooltip-options": t.getTooltipOptions("guido__code-button") } }), o(t.InButtonV2, { attrs: { id: "guido__preview-button", "left-icon": "line-show-on", styling: "ghost", type: "secondary", "label-text-status": !1, "tooltip-options": t.getTooltipOptions("guido__preview-button"), "tooltip-text": t.trans("newsletter.email-preview") } }), o(t.ViewOptions, { staticClass: "ml-3" })], 1);
+}, l = [], r = /* @__PURE__ */ i(
   s,
-  i,
+  n,
   l,
   !1,
   null,
   null
 );
-const _ = r.exports;
+const p = r.exports;
 export {
-  _ as default
+  p as default
 };