@weavour/editor 0.1.1 → 0.1.2

package/README.md

@@ -1,8 +1,7 @@
 # Weavour editor SDKs
 
 Embed the hosted Weavour email editor in your application. Your application owns
-its users and sends the exported emails. The SDKs are MIT licensed; the hosted
-editor, rendering implementation and services are proprietary.
+its users and sends the exported emails.
 
 - `@weavour/editor`: JavaScript/TypeScript and classic script-tag integrations.
 - `@weavour/react`: React component using the same core and hosted iframe.
@@ -73,6 +72,14 @@ to switch identity or initial documents, after preserving current work. Callback
 changes do not recreate the iframe. Imports are SSR-safe; mounting runs on the
 client. Next.js examples use a client component boundary.
 
+## Email audit
+
+Email-content quality checks are enabled by default. Set `enableEmailAudit: false`
+at mount, in `editorConfig`, or through `editor.updateConfig(...)` to turn them
+off. The React wrapper also accepts `enableEmailAudit` as a live prop. A saved
+dashboard disable takes precedence over SDK preferences. Toggling preserves the
+email and undo history. This requires the matching hosted iframe support.
+
 ## Identity and permissions
 
 `editorKey` is public. `userId` and optional `organizationId` are declarative
@@ -102,4 +109,3 @@ npm run verify
 npx playwright install chromium firefox webkit
 npm run test:browser
 ```
-

package/dist/editor.js

@@ -1,4 +1,4 @@
-/*! Weavour embedding SDK v0.1.1 | MIT | https://github.com/weavour/editor-sdk */
+/*! Weavour embedding SDK v0.1.2 | MIT | https://github.com/weavour/editor-sdk */
 "use strict";
 (() => {
   // packages/editor/src/merge-tags.ts
@@ -153,6 +153,9 @@
       for (const value of [options.enableTemplates, options.editorConfig?.enableTemplates]) {
         if (value !== void 0 && typeof value !== "boolean") throw new TypeError("enableTemplates must be a boolean.");
       }
+      for (const value of [options.enableEmailAudit, options.editorConfig?.enableEmailAudit]) {
+        if (value !== void 0 && typeof value !== "boolean") throw new TypeError("enableEmailAudit must be a boolean.");
+      }
       for (const [name, limit] of [["subject", 200], ["preheader", 500]]) {
         if (options[name] !== void 0 && (typeof options[name] !== "string" || options[name].length > limit)) throw new TypeError(name + " must be a string within its length limit.");
       }
@@ -183,6 +186,7 @@
         editorKey: options.editorKey,
         draftId: options.draftId,
         enableAutosave: options.enableAutosave ?? options.editorConfig?.enableAutosave,
+        enableEmailAudit: options.enableEmailAudit ?? options.editorConfig?.enableEmailAudit,
         userId: options.userId,
         organizationId: options.organizationId,
         locale: options.locale || "en",
@@ -408,7 +412,7 @@
           ready = true;
           iframe.style.visibility = "visible";
           clearTimeout(timer);
-          if (config.allowedBlocks !== void 0) post({ type: "weavour:update-config", version: 1, config: { allowedBlocks: config.allowedBlocks } }, origin);
+          if (config.allowedBlocks !== void 0 || config.enableEmailAudit !== void 0) post({ type: "weavour:update-config", version: 1, config: { allowedBlocks: config.allowedBlocks, enableEmailAudit: config.enableEmailAudit } }, origin);
           resolveReady();
           if (typeof options.onReady === "function") options.onReady();
         }
@@ -593,6 +597,8 @@
             }
           }
         }
+        if (next.enableEmailAudit !== void 0 && typeof next.enableEmailAudit !== "boolean") throw new TypeError("enableEmailAudit must be a boolean.");
+        if (next.enableEmailAudit !== void 0) config.enableEmailAudit = next.enableEmailAudit;
         if (next.enableAi !== void 0 && typeof next.enableAi !== "boolean") throw new TypeError("enableAi must be a boolean.");
         if (next.enableAi !== void 0) config.enableAi = next.enableAi;
         if (Object.hasOwn(next, "aiPaidOrigin")) {
@@ -612,7 +618,7 @@
           config.theme = { ...config.theme, ...structuredClone(next.theme) };
         }
         if (next.locale) config.locale = next.locale;
-        if (ready) post({ type: "weavour:update-config", version: 1, config: { mergeTags: config.mergeTags, theme: config.theme, locale: config.locale, enableAi: config.enableAi, enableTemplates: config.enableTemplates, enableAutosave: config.enableAutosave, allowedBlocks: config.allowedBlocks } }, origin);
+        if (ready) post({ type: "weavour:update-config", version: 1, config: { mergeTags: config.mergeTags, theme: config.theme, locale: config.locale, enableAi: config.enableAi, enableTemplates: config.enableTemplates, enableAutosave: config.enableAutosave, enableEmailAudit: config.enableEmailAudit, allowedBlocks: config.allowedBlocks } }, origin);
       }
       function exportHTML(previewOnly = false) {
         if (demo) return Promise.reject(new EditorError("demo_restricted", "Export is disabled in demo mode."));

package/dist/index.js

@@ -150,6 +150,9 @@ function createSDK(settings = {}) {
     for (const value of [options.enableTemplates, options.editorConfig?.enableTemplates]) {
       if (value !== void 0 && typeof value !== "boolean") throw new TypeError("enableTemplates must be a boolean.");
     }
+    for (const value of [options.enableEmailAudit, options.editorConfig?.enableEmailAudit]) {
+      if (value !== void 0 && typeof value !== "boolean") throw new TypeError("enableEmailAudit must be a boolean.");
+    }
     for (const [name, limit] of [["subject", 200], ["preheader", 500]]) {
       if (options[name] !== void 0 && (typeof options[name] !== "string" || options[name].length > limit)) throw new TypeError(name + " must be a string within its length limit.");
     }
@@ -180,6 +183,7 @@ function createSDK(settings = {}) {
       editorKey: options.editorKey,
       draftId: options.draftId,
       enableAutosave: options.enableAutosave ?? options.editorConfig?.enableAutosave,
+      enableEmailAudit: options.enableEmailAudit ?? options.editorConfig?.enableEmailAudit,
       userId: options.userId,
       organizationId: options.organizationId,
       locale: options.locale || "en",
@@ -405,7 +409,7 @@ function createSDK(settings = {}) {
         ready = true;
         iframe.style.visibility = "visible";
         clearTimeout(timer);
-        if (config.allowedBlocks !== void 0) post({ type: "weavour:update-config", version: 1, config: { allowedBlocks: config.allowedBlocks } }, origin);
+        if (config.allowedBlocks !== void 0 || config.enableEmailAudit !== void 0) post({ type: "weavour:update-config", version: 1, config: { allowedBlocks: config.allowedBlocks, enableEmailAudit: config.enableEmailAudit } }, origin);
         resolveReady();
         if (typeof options.onReady === "function") options.onReady();
       }
@@ -590,6 +594,8 @@ function createSDK(settings = {}) {
           }
         }
       }
+      if (next.enableEmailAudit !== void 0 && typeof next.enableEmailAudit !== "boolean") throw new TypeError("enableEmailAudit must be a boolean.");
+      if (next.enableEmailAudit !== void 0) config.enableEmailAudit = next.enableEmailAudit;
       if (next.enableAi !== void 0 && typeof next.enableAi !== "boolean") throw new TypeError("enableAi must be a boolean.");
       if (next.enableAi !== void 0) config.enableAi = next.enableAi;
       if (Object.hasOwn(next, "aiPaidOrigin")) {
@@ -609,7 +615,7 @@ function createSDK(settings = {}) {
         config.theme = { ...config.theme, ...structuredClone(next.theme) };
       }
       if (next.locale) config.locale = next.locale;
-      if (ready) post({ type: "weavour:update-config", version: 1, config: { mergeTags: config.mergeTags, theme: config.theme, locale: config.locale, enableAi: config.enableAi, enableTemplates: config.enableTemplates, enableAutosave: config.enableAutosave, allowedBlocks: config.allowedBlocks } }, origin);
+      if (ready) post({ type: "weavour:update-config", version: 1, config: { mergeTags: config.mergeTags, theme: config.theme, locale: config.locale, enableAi: config.enableAi, enableTemplates: config.enableTemplates, enableAutosave: config.enableAutosave, enableEmailAudit: config.enableEmailAudit, allowedBlocks: config.allowedBlocks } }, origin);
     }
     function exportHTML(previewOnly = false) {
       if (demo) return Promise.reject(new EditorError("demo_restricted", "Export is disabled in demo mode."));

package/dist/legacy.js

@@ -1,4 +1,4 @@
-/*! Weavour embedding SDK v0.1.1 | MIT | https://github.com/weavour/editor-sdk */
+/*! Weavour embedding SDK v0.1.2 | MIT | https://github.com/weavour/editor-sdk */
 "use strict";
 (() => {
   // packages/editor/src/merge-tags.ts
@@ -153,6 +153,9 @@
       for (const value of [options.enableTemplates, options.editorConfig?.enableTemplates]) {
         if (value !== void 0 && typeof value !== "boolean") throw new TypeError("enableTemplates must be a boolean.");
       }
+      for (const value of [options.enableEmailAudit, options.editorConfig?.enableEmailAudit]) {
+        if (value !== void 0 && typeof value !== "boolean") throw new TypeError("enableEmailAudit must be a boolean.");
+      }
       for (const [name, limit] of [["subject", 200], ["preheader", 500]]) {
         if (options[name] !== void 0 && (typeof options[name] !== "string" || options[name].length > limit)) throw new TypeError(name + " must be a string within its length limit.");
       }
@@ -183,6 +186,7 @@
         editorKey: options.editorKey,
         draftId: options.draftId,
         enableAutosave: options.enableAutosave ?? options.editorConfig?.enableAutosave,
+        enableEmailAudit: options.enableEmailAudit ?? options.editorConfig?.enableEmailAudit,
         userId: options.userId,
         organizationId: options.organizationId,
         locale: options.locale || "en",
@@ -408,7 +412,7 @@
           ready = true;
           iframe.style.visibility = "visible";
           clearTimeout(timer);
-          if (config.allowedBlocks !== void 0) post({ type: "weavour:update-config", version: 1, config: { allowedBlocks: config.allowedBlocks } }, origin);
+          if (config.allowedBlocks !== void 0 || config.enableEmailAudit !== void 0) post({ type: "weavour:update-config", version: 1, config: { allowedBlocks: config.allowedBlocks, enableEmailAudit: config.enableEmailAudit } }, origin);
           resolveReady();
           if (typeof options.onReady === "function") options.onReady();
         }
@@ -593,6 +597,8 @@
             }
           }
         }
+        if (next.enableEmailAudit !== void 0 && typeof next.enableEmailAudit !== "boolean") throw new TypeError("enableEmailAudit must be a boolean.");
+        if (next.enableEmailAudit !== void 0) config.enableEmailAudit = next.enableEmailAudit;
         if (next.enableAi !== void 0 && typeof next.enableAi !== "boolean") throw new TypeError("enableAi must be a boolean.");
         if (next.enableAi !== void 0) config.enableAi = next.enableAi;
         if (Object.hasOwn(next, "aiPaidOrigin")) {
@@ -612,7 +618,7 @@
           config.theme = { ...config.theme, ...structuredClone(next.theme) };
         }
         if (next.locale) config.locale = next.locale;
-        if (ready) post({ type: "weavour:update-config", version: 1, config: { mergeTags: config.mergeTags, theme: config.theme, locale: config.locale, enableAi: config.enableAi, enableTemplates: config.enableTemplates, enableAutosave: config.enableAutosave, allowedBlocks: config.allowedBlocks } }, origin);
+        if (ready) post({ type: "weavour:update-config", version: 1, config: { mergeTags: config.mergeTags, theme: config.theme, locale: config.locale, enableAi: config.enableAi, enableTemplates: config.enableTemplates, enableAutosave: config.enableAutosave, enableEmailAudit: config.enableEmailAudit, allowedBlocks: config.allowedBlocks } }, origin);
       }
       function exportHTML(previewOnly = false) {
         if (demo) return Promise.reject(new EditorError("demo_restricted", "Export is disabled in demo mode."));

package/dist/types.d.ts

@@ -51,6 +51,7 @@ export type EditorConfig = {
     aiPaidOrigin?: string;
     enableTemplates?: boolean;
     enableAutosave?: boolean;
+    enableEmailAudit?: boolean;
 };
 export type EditorCallbacks = {
     onReady?(): void;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.1.1",
+  "version": "0.1.2",
   "type": "module",
   "license": "MIT",
   "repository": {