@useinsider/guido 1.0.0-beta.30f3236 → 1.0.0-beta.35d2ac4

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,16 @@ npm install @useinsider/guido
 <template>
   <div>
     <Guido
-      :email-id="emailId"
+      ref="guidoEditor"
+      :template-id="templateId"
       :user-id="userId"
       :guido-config="guidoConfig"
+      :html="initialHtml"
+      :css="initialCss"
+      @dynamic-content:open="handleDynamicContentOpen"
+      @back="handleBack"
+      @save:start="handleSaveStart"
+      @save:complete="handleSaveComplete"
     />
   </div>
 </template>
@@ -39,14 +49,55 @@ export default {
   },
   data() {
     return {
-      emailId: 'abc123',
-      userId: '12345',
+      templateId: 'template-123',
+      userId: 'user-456',
+      initialHtml: '<p>Initial HTML content</p>',
+      initialCss: 'p { color: #333; }',
       guidoConfig: {
-        translationsPath: 'window.trans.en'
+        translationsPath: 'window.trans.en',
         htmlCompilerRules: [],
         ignoreDefaultHtmlCompilerRules: false,
-      }
+      },
+      dynamicContentModalVisible: false
     };
+  },
+
+  methods: {
+    handleDynamicContentOpen(detail) {
+      console.log('Dynamic content requested:', detail);
+      this.dynamicContentModalVisible = true;
+    },
+    
+    handleBack() {
+      console.log('User clicked back button');
+      // Handle navigation back
+    },
+    
+    handleSaveStart() {
+      console.log('Save process started');
+      // Show loading indicator
+    },
+    
+    handleSaveComplete(template) {
+      console.log('Save completed:', template);
+      // Handle saved template data
+    },
+    
+    // ⚠️ Your own Dynamic Content Modal should have this id: #guido-dynamic-content-modal
+    handleDynamicContentInsert() {
+      this.$refs.guidoEditor?.dynamicContent.insert({
+        text: 'Display Text', 
+        value: 'actual-value', 
+        fallback: 'Fallback Text'
+      });
+
+      this.dynamicContentModalVisible = false;
+    },
+    
+    // ⚠️ It's mandatory. There is no way to understand if user closes the modal without selection.
+    handleDynamicContentClose() {
+      this.$refs.guidoEditor?.dynamicContent.close();
+    }
   }
 };
 </script>
@@ -58,14 +109,31 @@ export default {
 
 | Prop | Type | Required | Default | Description |
 |------|------|----------|---------|-------------|
-| `emailId` | `string` | ✅ | - | Unique identifier for the email draft |
-| `userId` | `string` | ✅ | - | Unique identifier for the user draft |
-| `username` | `string` | ⚪ | Guido User | User name |
-| `partnerName` | `string` | ⚪ | Getting from URL host | Unique identifier for the partner draft |
-| `productType` | `string` | ⚪ | Getting from URL path | Unique identifier for the product draft |
+| `templateId` | `string` | ✅ | - | Unique identifier for the email template |
+| `userId` | `string` | ✅ | - | Unique identifier for the user |
 | `guidoConfig` | `GuidoConfig` | ✅ | - | Configuration object for the editor |
+| `partnerName` | `string` | ⚪ | From URL host | Partner identifier |
+| `productType` | `string` | ⚪ | From URL path | Product type identifier |
+| `username` | `string` | ⚪ | `'Guido User'` | Display name for the user |
+| `html` | `string` | ⚪ | `''` | Initial HTML content for the template |
+| `css` | `string` | ⚪ | `''` | Initial CSS styles for the template |
+
+### Guido Component Events
+
+| Event | Payload | Description |
+|-------|---------|-------------|
+| `dynamic-content:open` | `DynamicContent \| null` | Fired when user requests to insert dynamic content |
+| `back` | - | Fired when user clicks the back button |
+| `save:start` | - | Fired when the save process begins |
+| `save:complete` | `Omit<Template, 'forceRecreate'>` | Fired when template is successfully saved |
+
+### Guido Exposed Methods
+```typescript
+dynamicContent.insert(DynamicContent);
+dynamicContent.close();
+```
 
-### GuidoConfig Interface
+### Guido Interfaces
 
 ```typescript
 interface GuidoConfig {
@@ -81,6 +149,21 @@ interface GuidoConfig {
 | `htmlCompilerRules` | `CompilerRule[]` | `[]` | Additional compiler rules to apply to HTML content. See [HTML Compiler Rules](#-html-compiler-rules) section below |
 | `ignoreDefaultHtmlCompilerRules` | `boolean` | `false` | Skip default compiler rules and only use custom rules. Default rules: `src/config/compiler/htmlCompilerRules.ts` |
 
+```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:
@@ -94,19 +177,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';
-```
-
 ## 🔨 HTML Compiler Rules
 
 Guido includes a powerful HTML compiler system that allows you to transform HTML content with custom rules. You can define additional rules and optionally ignore the default rules.
@@ -342,6 +412,87 @@ src/
 └── library.ts          # Main export
 ```
 
+## 🔌 Provide/Inject Utilities
+
+Guido includes type-safe utilities for Vue's provide/inject system to facilitate dependency injection between components.
+
+### useProvideInject
+
+The `useProvideInject` composable provides two helper functions for type-safe dependency injection:
+
+#### Basic Usage
+
+```typescript
+// Parent component
+import { provideValue } from '@useinsider/guido';
+import { InjectionKey } from 'vue';
+
+// Define a typed injection key
+const MyServiceKey: InjectionKey<MyService> = Symbol('MyService');
+
+// Provide the value
+const myService = new MyService();
+provideValue(MyServiceKey, myService);
+
+// Child component
+import { useInjectedValue } from '@useinsider/guido';
+
+// Inject the value with type safety
+const myService = useInjectedValue(MyServiceKey);
+```
+
+#### With Default Value
+
+```typescript
+// Inject with a fallback value
+const myService = useInjectedValue(MyServiceKey, new DefaultService());
+```
+
+#### Error Handling
+
+The `useInjectedValue` function will throw a descriptive error if no provider is found and no default value is provided:
+
+```typescript
+// This will throw an error if no provider exists
+try {
+  const myService = useInjectedValue(MyServiceKey);
+} catch (error) {
+  console.error('No provider found for MyService');
+}
+```
+
+### API Reference
+
+#### `provideValue`
+
+```typescript
+provideValue<T>(key: InjectionKey<T>, value: T): void
+```
+
+Provides a value using Vue's provide system with type safety.
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `key` | `InjectionKey<T>` | The typed injection key |
+| `value` | `T` | The value to provide |
+
+#### `useInjectedValue`
+
+```typescript
+useInjectedValue<T>(key: InjectionKey<T>, defaultValue?: T): T
+```
+
+Injects a value using Vue's inject system with type safety and error handling.
+
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `key` | `InjectionKey<T>` | ✅ | The typed injection key |
+| `defaultValue` | `T` | ⚪ | Optional fallback value |
+
+**Returns:** `T` - The injected value
+
+**Throws:** `Error` - When no provider is found and no default value is provided
+
 ## 🌐 i18n
 Before running the project, it sends to request to inone.useinsider.com/translations and writes the JSON file into - [trans.json](src/mock/responses/trans.json). 
 It allows to use production or local translations on your code. 🚀
@@ -355,6 +506,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:
@@ -400,8 +579,4 @@ ISC License
 - 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

@@ -4,3 +4,12 @@ export type GuidoConfig = {
     htmlCompilerRules?: CompilerRule[];
     ignoreDefaultHtmlCompilerRules?: boolean;
 };
+export type DynamicContent = {
+    value: string;
+    text: string;
+    fallback?: string;
+};
+export interface EmailData {
+    senderName: string;
+    subject: 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,13 +1,27 @@
-import type { GuidoConfig } from '@@/Types/generic';
+import type { DynamicContent, GuidoConfig, EmailData } from '@@/Types/generic';
+import type { Template } from '@@/Types/stripo';
 type __VLS_Props = {
-    emailId: string;
+    templateId: string;
     userId: string;
     partnerName?: string;
     productType?: string;
     username?: string;
+    html?: string;
+    css?: string;
     guidoConfig: GuidoConfig;
+    emailData?: EmailData;
 };
-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;
+    back: () => void;
+    "save:start": () => void;
+    "save:complete": (template: Omit<Template, "forceRecreate">) => 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

@@ -1,18 +1,18 @@
 import o from "./Guido.vue2.js";
 /* empty css           */
-import i from "../_virtual/_plugin-vue2_normalizer.js";
+import t from "../_virtual/_plugin-vue2_normalizer.js";
 var s = function() {
-  var e = this, r = e._self._c, t = e._self._setupProxy;
-  return r("div", { staticClass: "guido-editor__wrapper" }, [r(t.HeaderWrapper), r("div", { staticClass: "guido-editor__container", attrs: { id: "guido-editor" } })], 1);
-}, _ = [], a = /* @__PURE__ */ i(
+  var i = this, r = i._self._c, e = i._self._setupProxy;
+  return r("div", { staticClass: "guido-editor__wrapper" }, [r(e.HeaderWrapper), r(e.EmailPreview, { directives: [{ name: "show", rawName: "v-show", value: e.editorStore.isPreviewModeOpen, expression: "editorStore.isPreviewModeOpen" }], attrs: { "email-data": i.emailData, "is-visible": e.editorStore.isPreviewModeOpen } }), r("div", { directives: [{ name: "show", rawName: "v-show", value: !e.editorStore.isPreviewModeOpen, expression: "!editorStore.isPreviewModeOpen" }], staticClass: "guido-editor__container", attrs: { id: "guido-editor" } })], 1);
+}, a = [], d = /* @__PURE__ */ t(
   o,
   s,
-  _,
+  a,
   !1,
   null,
-  "8e229594"
+  "7836f831"
 );
-const f = a.exports;
+const m = d.exports;
 export {
-  f as default
+  m as default
 };