@useinsider/guido 1.0.0-beta.e096204 → 1.0.0-beta.e239762

package/README.md

@@ -1,33 +1,25 @@
-<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">
-  </a>
-</p>
+# @useinsider/guido-plugin
 
-
-# @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, customizable interface.
+Guido is a Vue + TypeScript wrapper for Email Plugin. Easily embed the email editor in your Vue applications.
 
 ## 📦 Install
-
 ```bash
 npm install @useinsider/guido
 ```
 
-## 🚀 Usage
-
-### Basic Usage
-
-```html
+## 🚀 Usage (Vue 2)
+```vue
 <template>
-  <div>
-    <Guido
-      :email-id="emailId"
-      :user-id="userId"
-      :guido-config="guidoConfig"
-    />
-  </div>
+  <Guido
+    email-id="abc123"
+    :api="apiEndpoints"
+    :extensions="extensions"
+    :insider-stripo-config="insiderStripoConfig"
+    @save="handleSave"
+    @export:requested="onExportRequested"
+    @export:ready="handleHtml"
+    @close="onClose"
+  />
 </template>
 
 <script lang="ts">
@@ -39,369 +31,99 @@ export default {
   },
   data() {
     return {
-      emailId: 'abc123',
-      userId: '12345',
-      guidoConfig: {
-        translationsPath: 'window.trans.en'
-        htmlCompilerRules: [],
-        ignoreDefaultHtmlCompilerRules: false,
+      apiEndpoints: {
+        dynamicContent: '/api/dynamic-content',
+        unsubPages: '/api/unsub-pages',
+        header: '/api/header',
+        footer: '/api/footer',
+        productName: '/api/product-name',
+        productVersion: '/api/product-version',
+        token: '/api/stripo-token'
+      },
+      extensions: {
+        dynamicContent: true,
+        unsubPages: true,
+        header: false,
+        footer: false
       }
     };
-  }
-};
-</script>
-```
-
-## 📚 API
-
-### Guido Component Props
-
-| 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 |
-| `guidoConfig` | `GuidoConfig` | ✅ | - | Configuration object for the editor |
-
-### GuidoConfig Interface
-
-```typescript
-interface GuidoConfig {
-  translationsPath: string;
-  htmlCompilerRules: CompilerRule[];
-  ignoreDefaultHtmlCompilerRules: boolean;
-}
-```
-
-| Property | Type | Default | Description |
-|----------|------|---------|-------------|
-| `translationsPath` | `string` | `'window.trans.en'` | JavaScript path to the translations object |
-| `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 Types
-
-The library exports the following TypeScript types:
-
-```typescript
-// Main component
-import { Guido } from '@useinsider/guido';
-
-// Types
-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.
-
-### Rule Types
-
-There are 4 types of compiler rules:
-
-#### 1. Replace Rule
-Replace specific strings in HTML content.
-
-```typescript
-{
-  id: 'fix-encoding',
-  description: 'Fix URL encoding issues',
-  type: 'replace',
-  search: '{%22',           // String to find
-  replacement: '%7B%22',    // String to replace with
-  replaceAll: true,         // Replace all occurrences (default: true)
-  priority: 10              // Execution priority (lower = earlier)
-}
-```
-
-#### 2. Regex Rule
-Use regular expressions for complex pattern matching and replacement.
-
-```typescript
-{
-  id: 'remove-comments',
-  description: 'Remove HTML comments',
-  type: 'regex',
-  pattern: '<!--.*?-->',    // Regex pattern
-  replacement: '',          // Replacement string
-  flags: 'g',              // Regex flags (default: 'g')
-  priority: 20
-}
-```
-
-#### 3. Remove Rule
-Remove specific strings or patterns from HTML content.
-
-```typescript
-{
-  id: 'cleanup-scripts',
-  description: 'Remove unwanted script tags',
-  type: 'remove',
-  targets: [                              // Array of strings or RegExp objects
-    '<script src="unwanted.js"></script>',
-    /onclick="[^"]*"/g
-  ],
-  priority: 30
-}
-```
-
-#### 4. Custom Rule
-Define complex transformation logic with a custom processor function.
-
-```typescript
-{
-  id: 'add-meta-tags',
-  description: 'Add custom meta tags to head',
-  type: 'custom',
-  processor: (html: string): string => {
-    // Custom transformation logic
-    const metaTags = '<meta name="custom" content="value">';
-    return html.replace('</head>', `${metaTags}</head>`);
   },
-  priority: 40
-}
-```
-
-### Using HTML Compiler Rules
-
-#### Basic Usage with Custom Rules
-
-```typescript
-const guidoConfig = {
-  translationsPath: 'window.trans.en',
-  htmlCompilerRules: [
-    {
-      id: 'replace-domain',
-      description: 'Replace old domain with new one',
-      type: 'replace',
-      search: 'old-domain.com',
-      replacement: 'new-domain.com',
-      replaceAll: true,
-      priority: 10
+  methods: {
+    handleSave(data: any) {
+      console.log('Saved:', data);
     },
-    {
-      id: 'remove-tracking',
-      description: 'Remove tracking pixels',
-      type: 'regex',
-      pattern: '<img[^>]*tracking[^>]*>',
-      replacement: '',
-      flags: 'gi',
-      priority: 20
-    }
-  ]
-};
-```
-
-#### Ignoring Default Rules
-
-```typescript
-const guidoConfig = {
-  translationsPath: 'window.trans.en',
-  ignoreDefaultHtmlCompilerRules: true, // Skip all default rules
-  htmlCompilerRules: [
-    // Only your custom rules will be applied
-    {
-      id: 'custom-transformation',
-      type: 'replace',
-      search: 'old-text',
-      replacement: 'new-text',
-      priority: 1
+    handleHtml({ html }: { html: string }) {
+      console.log('HTML ready:', html);
+    },
+    onExportRequested() {
+      console.log('Export started');
+    },
+    onClose() {
+      console.log('Closed');
     }
-  ]
+  }
 };
+</script>
 ```
 
-### Rule Execution Order
-
-Rules are executed in priority order (lower numbers first). Rules with the same priority are executed in array order.
-
-- **Priority 1-99**: Reserved for critical transformations
-- **Priority 100-999**: Standard transformations  
-- **Priority 1000+**: Additional custom rules (automatically assigned)
-
-### Default Rules
-
-Guido includes several default rules for common email HTML optimizations:
-
-- **URL encoding fixes**: Fixes malformed URL encoding in dynamic content
-- **Template tag restoration**: Restores `{{}}` template tags that got URL encoded
-- **HTML entity decoding**: Converts `&lt;` and `&gt;` back to `<` and `>`
-- **Cleanup rules**: Removes unwanted iframe and style elements
-- **MSO conditions**: Manages Outlook-specific conditional comments
-- **Domain replacement**: Updates old image domains to current ones
-
-You can view all default rules in: `src/config/compiler/htmlCompilerRules.ts`
-
-### CompilerRule Interface
-
-```typescript
-type CompilerRuleType = 'replace' | 'regex' | 'remove' | 'custom';
-
-interface BaseCompilerRule {
-  id: string;
-  description?: string;
-  priority: number;
-}
-
-interface ReplaceRule extends BaseCompilerRule {
-  type: 'replace';
-  search: string;
-  replacement: string;
-  replaceAll?: boolean; // Default: true
-}
-
-interface RegexRule extends BaseCompilerRule {
-  type: 'regex';
-  pattern: string;
-  replacement: string;
-  flags?: string; // Default: 'g'
-}
-
-interface RemoveRule extends BaseCompilerRule {
-  type: 'remove';
-  targets: (string | RegExp)[]; // Array of strings or RegExp objects
-}
-
-interface CustomRule extends BaseCompilerRule {
-  type: 'custom';
-  processor: (html: string) => string;
-}
+## 📚 API
+### `<StripoEditor />` Props
+| Prop        | Type     | Required | Description                |
+|-------------|----------|----------|----------------------------|
+| emailId     | string   | ✅       | Stripo email draft ID     |
+| iframeId    | string   | ❌       | Custom iframe ID          |
+| api         | object   | ❌       | Custom API endpoints      |
+| extensions  | object   | ❌       | Enable/disable extensions |
+| insiderStripoConfig | object | ❌ | Insider Stripo configuration |
+
+### Extensions
+| Extension       | Type      | Default | Description                    |
+|----------------|-----------|---------|--------------------------------|
+| dynamicContent | boolean   | true    | Dynamic content functionality  |
+| unsubPages     | boolean   | true    | Unsubscribe pages feature      |
+| header         | boolean   | true    | Header customization           |
+| footer         | boolean   | true    | Footer customization           |
+
+### Insider Stripo Configuration
+| Property          | Type     | Default | Description                    |
+|-------------------|----------|---------|--------------------------------|
+| translationsPath  |  string  | 'window.trans.en | JS Path to translations file |
+
+### API Endpoints
+| Endpoint           | Default Path           | Description                    |
+|-------------------|------------------------|--------------------------------|
+| dynamicContent    | /api/dynamic-content   | Dynamic content endpoint       |
+| unsubPages        | /api/unsub-pages       | Unsubscribe pages endpoint     |
+| header            | /api/header            | Header endpoint                |
+| footer            | /api/footer            | Footer endpoint                |
+| productName       | /api/product-name      | Product name endpoint          |
+| productVersion    | /api/product-version   | Product version endpoint       |
+| token             | /api/stripo-token      | Authentication token endpoint  |
+
+### Events
+| Event             | Payload                | Description                    |
+|-------------------|------------------------|--------------------------------|
+| `save`            | any                    | Triggered on save              |
+| `export:requested`| void                   | Triggered when export starts   |
+| `export:ready`    | { html: string }       | Triggered when HTML is ready   |
+| `close`           | void                   | Triggered when editor closes   |
 
-type CompilerRule = ReplaceRule | RegexRule | RemoveRule | CustomRule;
-```
 
 ---
 
-## 🔧 Development
-
-### Prerequisites
-
-- 🧄 `Bun` (strongly recommended)
-or
-- NodeJS 18+ & `npm`
-
-### Setup
-
+## 🛠 Development
 ```bash
-# Install dependencies
 bun install
-
-# Start development server
 bun start
-
-# Build for production
-bun run build
-
-# Type checking
-bun run type-check
-
-# Linting
-bun run lint
 ```
 
-### Environment Variables
-
-Create a `.env` file with the following variables: (You can get env variables from your senior)
-
-```env
-VITE_STRIPO_PLUGIN_ID=your_plugin_id
-VITE_STRIPO_SECRET_KEY=your_secret_key
-VITE_STRIPO_ROLE=your_role
-```
-
-### Project Structure
-
-```
-src/
-├── components/         # Vue components
-├── composables/        # Vue composables & business logic
-├── services/           # API layer
-├── stores/             # State management
-├── @types/             # TypeScript definitions
-├── static/             # Static assets & templates
-├── utils/              # Utility functions
-├── enums/              # Constants & enums
-├── mock/               # Mock data for development
-├── plugins/            # Vue plugins
-└── library.ts          # Main export
-```
-
-## 🌐 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. 🚀
-Example usage: 
-```js
-import { useTranslations } from '@@/Composables/useTranslations';
-
-const trans = useTranslations();
-
-// use everywhere like this:
-trans('foo.bar')
-```
-
-## 📦 Build Output
-
-The library builds to multiple formats:
-
-- **ES Module**: `dist/library.js` (recommended)
-- **CSS**: `dist/guido.css` (custom styles)
-
-### Package Exports
-
-```json
-{
-  "exports": {
-    ".": {
-      "import": "./dist/library.js",
-      "types": "./dist/components/Guido.vue.d.ts",
-      "require": "./dist/components/Guido.vue.js"
-    },
-    "./style": "./dist/guido.css"
-  }
-}
+Build & types:
+```bash
+bun run build
 ```
 
-## 🤝 Contributing
-- PR Titles should be structured like `TASK-ID | 🔥 | Some Clear Task Descriptions`
-- PR Labels should be filled.
-- PR Assignee required.
-- Tests should be covered.
-- All required checks should be passed before sending review request.
-
-## 📄 License
-
-ISC License
-
 ---
 
-## 🔗 Related
-
-- [Stripo Email Editor](https://stripo.email/) - The underlying email editor
-- [@useinsider/design-system-vue](https://github.com/useinsider/design-system-vue) - Insider's Vue design system
-
-## 🎯 TODO:
-- 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
+TODO: 
+[ ] - Default Template @edugencioglu
+[ ] - Using CSS variables into [editor.css](./src/static/editor.css) @berkansezer-useinsider

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

@@ -1,6 +1,6 @@
-import type { CompilerRule } from './html-compiler';
-export type GuidoConfig = {
+export type Translations = {
+    [key: string]: string;
+};
+export type InsiderStripoConfig = {
     translationsPath: string;
-    htmlCompilerRules?: CompilerRule[];
-    ignoreDefaultHtmlCompilerRules?: boolean;
 };

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

@@ -1,11 +1,5 @@
-import type { GuidoConfig } from '@@/Types/generic';
 type __VLS_Props = {
     emailId: string;
-    userId: string;
-    partnerName?: string;
-    productType?: string;
-    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>>>, {}>;
 export default _default;

package/dist/components/Guido.vue.js

@@ -2,17 +2,17 @@ import o from "./Guido.vue2.js";
 /* empty css           */
 import i 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 t = this, r = t._self._c, e = t._self._setupProxy;
+  return r("div", { staticClass: "guido-editor-wrapper" }, [r(e.Header), r("div", { staticClass: "guido-editor-container", attrs: { id: "guido-editor" } })], 1);
+}, a = [], n = /* @__PURE__ */ i(
   o,
   s,
-  _,
+  a,
   !1,
   null,
-  "8e229594"
+  "c14163ad"
 );
-const f = a.exports;
+const f = n.exports;
 export {
   f as default
 };

package/dist/components/Guido.vue2.js

@@ -1,43 +1,24 @@
-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 a, onMounted as n } from "vue";
+import { useStripo as m } from "../composables/useStripo.js";
+import { useTemplates as p } from "../composables/useTemplates.js";
+import s from "./organisms/top-bar/Header.vue.js";
+const f = /* @__PURE__ */ a({
   __name: "Guido",
   props: {
-    emailId: null,
-    userId: null,
-    partnerName: null,
-    productType: null,
-    username: null,
-    guidoConfig: null
+    emailId: 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;
-    window.GuidoConfig = {
-      ...T,
-      ...a
-    };
-    const { initPlugin: l } = _({ emailId: n, userId: i, username: m, partnerName: u, productType: p }), { getDefaultTemplate: s } = y();
-    return c(async () => {
+  setup(i) {
+    const e = i, { initPlugin: o } = m(e.emailId), { getDefaultTemplate: r } = p();
+    return n(async () => {
       try {
-        const e = await s();
-        await l(e);
-      } catch (e) {
-        console.error("Failed to initialize Stripo editor:", e);
+        const t = await r();
+        await o(t);
+      } catch (t) {
+        console.error("Failed to initialize Stripo editor:", t);
       }
-    }), { __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 };
+    }), { __sfc: !0, props: e, initPlugin: o, getDefaultTemplate: r, Header: s };
   }
 });
 export {
-  h as default
+  f as default
 };

package/dist/components/organisms/{header/HeaderWrapper.vue.js → top-bar/Header.vue.js}

@@ -1,17 +1,17 @@
-import t from "./HeaderWrapper.vue2.js";
+import t from "./Header.vue2.js";
 import s from "../../../_virtual/_plugin-vue2_normalizer.js";
-var n = function() {
+var a = function() {
   var o = this, r = o._self._c, e = o._self._setupProxy;
-  return r(e.InContainer, { attrs: { border: "bor-w-0 bor-b-w-1 bor-s-s bor-c-6", "border-radius": "bor-r-0" } }, [r("div", { staticClass: "w-1 d-f a-i-c j-c-s-b p-3" }, [r(e.LeftSlot), r(e.MiddleSlot), r(e.RightSlot)], 1)]);
-}, a = [], _ = /* @__PURE__ */ s(
+  return r(e.InContainer, { attrs: { border: "bor-w-0 bor-b-w-1 bor-s-s bor-c-6", "border-radius": "bor-r-0" } }, [r("div", { staticClass: "w-1 d-f a-i-c j-c-s-b p-3" }, [r(e.HeaderLeftSlot), r(e.HeaderMiddleSlot), r(e.HeaderRightSlot)], 1)]);
+}, n = [], _ = /* @__PURE__ */ s(
   t,
-  n,
   a,
+  n,
   !1,
   null,
   null
 );
-const d = _.exports;
+const c = _.exports;
 export {
-  d as default
+  c as default
 };

package/dist/components/organisms/top-bar/Header.vue2.js

@@ -0,0 +1,14 @@
+import { defineComponent as e } from "vue";
+import { InContainer as r } from "@useinsider/design-system-vue";
+import o from "./HeaderLeftSlot.vue.js";
+import t from "./HeaderMiddleSlot.vue.js";
+import m from "./HeaderRightSlot.vue.js";
+const _ = /* @__PURE__ */ e({
+  __name: "Header",
+  setup(f) {
+    return { __sfc: !0, InContainer: r, HeaderLeftSlot: o, HeaderMiddleSlot: t, HeaderRightSlot: m };
+  }
+});
+export {
+  _ as default
+};

package/dist/components/organisms/top-bar/HeaderLeftSlot.vue.js

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

package/dist/components/organisms/top-bar/HeaderLeftSlot.vue2.js

@@ -0,0 +1,11 @@
+import { defineComponent as t } from "vue";
+import { InButtonV2 as e } from "@useinsider/design-system-vue";
+const _ = /* @__PURE__ */ t({
+  __name: "HeaderLeftSlot",
+  setup(o) {
+    return { __sfc: !0, InButtonV2: e };
+  }
+});
+export {
+  _ as default
+};