@marlinjai/email-editor 0.2.0

package/dist/types-G7Ak2dWQ.d.mts

@@ -0,0 +1,117 @@
+import { EmailTemplate, BlockDefinition } from '@marlinjai/email-editor-core';
+import { OnRequestImage } from '@marlinjai/email-editor-ui';
+
+/**
+ * Editor theme: brand colors and the UI font of the editor chrome. Each value
+ * sets one design token on the editor's root element; anything left out keeps
+ * the default. Every token (`--ee-*`) can also be overridden in the host's CSS
+ * on `.ee-root`, outside any cascade layer.
+ */
+interface EditorTheme {
+    colors?: {
+        /** Accent: primary buttons, selection, focus rings (`--ee-accent`) */
+        primary?: string;
+        /** Accent on hover (`--ee-accent-hover`) */
+        primaryHover?: string;
+        /** Light panel surfaces (`--ee-canvas-2`) */
+        surface?: string;
+        /** Text on light surfaces (`--ee-text-dark`) */
+        text?: string;
+        /** Borders on light surfaces (`--ee-border-light`) */
+        border?: string;
+    };
+    fonts?: {
+        /** Font stack of the editor chrome (`--ee-font-sans`) */
+        body?: string;
+    };
+}
+/**
+ * Editor configuration options
+ */
+interface EditorOptions {
+    container: HTMLElement;
+    initialValue?: EmailTemplate;
+    theme?: EditorTheme;
+    /** Redefine standard block types (label, icon, category, default props). New types are refused. */
+    blocks?: BlockDefinition[];
+    onChange?: (template: EmailTemplate) => void;
+    onSave?: (template: EmailTemplate) => void;
+    /**
+     * Supply images from your own picker or uploader. Resolve with
+     * `{ url, alt? }`, or `null` when the user cancels (the block is left
+     * unchanged). A rejected promise is shown inline in the image inspector.
+     * Without it, the image inspector shows a plain URL field.
+     */
+    onRequestImage?: OnRequestImage;
+    /**
+     * The sections this workspace has saved, offered in the section picker
+     * beside the built-in ones, under their own group.
+     *
+     * Optional: a host that passes none gets exactly the built-in library, which
+     * is what a standalone consumer of this package gets today.
+     */
+    savedSections?: SavedSectionInput[];
+    /**
+     * Whether to offer the 35 sections that ship with this package (a hero, a
+     * few content and feature layouts, events, coupons, products, signatures and
+     * footers). True by default, which is what a workspace with nothing saved
+     * yet needs: an empty picker is a worse first run than a generic one.
+     *
+     * Pass false to offer only `savedSections`, which is what a host with its own
+     * library wants. The built-in set is brand neutral by construction (grey
+     * palette, fonts every mail client has, placeholder copy naming nobody, and
+     * `data:` URI images, so a workspace whose `asset_policy` is `service_only`
+     * can send them); turning them off is about whose library it is, not about
+     * whether they are safe to show.
+     */
+    builtInSections?: boolean;
+    /**
+     * The origin the editor's placeholder images are served from, with no
+     * trailing slash, e.g. `https://mail.example.com`. Each becomes
+     * `<base>/p/<width>x<height>.png`.
+     *
+     * Give it whenever the documents this editor produces are going to be sent.
+     * Without it every placeholder is a `data:` URI, which renders in the canvas
+     * but which Gmail and Outlook.com do not render at all, and which a workspace
+     * that only allows its own service's addresses may not be able to replace.
+     */
+    placeholderBase?: string;
+    /**
+     * Keep a section for reuse. When set, a section's controls on the canvas
+     * carry a "Save as a section" action, which asks for a name (refusing one
+     * already in `savedSections`) and calls this with the section as plain data.
+     *
+     * Resolve when it is stored; a rejection is shown in the dialog with the
+     * error's message and the dialog stays open. Without it no action appears,
+     * rather than one that fails.
+     *
+     * The editor does not reload `savedSections` afterwards: the host owns that
+     * list and passes a new one when it has stored the section.
+     */
+    onSaveSection?: (section: Record<string, unknown>, name: string) => Promise<void>;
+}
+/**
+ * One saved section as the host holds it. The `section` is a snapshot of a
+ * single section of a document; inserting it rebuilds every id, so the same
+ * saved section can go into one document twice.
+ */
+interface SavedSectionInput {
+    id: string;
+    name: string;
+    description?: string;
+    section: Record<string, unknown>;
+}
+/**
+ * Editor instance API
+ */
+interface EditorInstance {
+    getValue(): EmailTemplate;
+    setValue(template: EmailTemplate): void;
+    getHTML(): string;
+    getMJML(): string;
+    undo(): void;
+    redo(): void;
+    destroy(): void;
+}
+
+export type { EditorOptions as E, SavedSectionInput as S, EditorInstance as a, EditorTheme as b };

package/dist/types-G7Ak2dWQ.d.ts

@@ -0,0 +1,117 @@
+import { EmailTemplate, BlockDefinition } from '@marlinjai/email-editor-core';
+import { OnRequestImage } from '@marlinjai/email-editor-ui';
+
+/**
+ * Editor theme: brand colors and the UI font of the editor chrome. Each value
+ * sets one design token on the editor's root element; anything left out keeps
+ * the default. Every token (`--ee-*`) can also be overridden in the host's CSS
+ * on `.ee-root`, outside any cascade layer.
+ */
+interface EditorTheme {
+    colors?: {
+        /** Accent: primary buttons, selection, focus rings (`--ee-accent`) */
+        primary?: string;
+        /** Accent on hover (`--ee-accent-hover`) */
+        primaryHover?: string;
+        /** Light panel surfaces (`--ee-canvas-2`) */
+        surface?: string;
+        /** Text on light surfaces (`--ee-text-dark`) */
+        text?: string;
+        /** Borders on light surfaces (`--ee-border-light`) */
+        border?: string;
+    };
+    fonts?: {
+        /** Font stack of the editor chrome (`--ee-font-sans`) */
+        body?: string;
+    };
+}
+/**
+ * Editor configuration options
+ */
+interface EditorOptions {
+    container: HTMLElement;
+    initialValue?: EmailTemplate;
+    theme?: EditorTheme;
+    /** Redefine standard block types (label, icon, category, default props). New types are refused. */
+    blocks?: BlockDefinition[];
+    onChange?: (template: EmailTemplate) => void;
+    onSave?: (template: EmailTemplate) => void;
+    /**
+     * Supply images from your own picker or uploader. Resolve with
+     * `{ url, alt? }`, or `null` when the user cancels (the block is left
+     * unchanged). A rejected promise is shown inline in the image inspector.
+     * Without it, the image inspector shows a plain URL field.
+     */
+    onRequestImage?: OnRequestImage;
+    /**
+     * The sections this workspace has saved, offered in the section picker
+     * beside the built-in ones, under their own group.
+     *
+     * Optional: a host that passes none gets exactly the built-in library, which
+     * is what a standalone consumer of this package gets today.
+     */
+    savedSections?: SavedSectionInput[];
+    /**
+     * Whether to offer the 35 sections that ship with this package (a hero, a
+     * few content and feature layouts, events, coupons, products, signatures and
+     * footers). True by default, which is what a workspace with nothing saved
+     * yet needs: an empty picker is a worse first run than a generic one.
+     *
+     * Pass false to offer only `savedSections`, which is what a host with its own
+     * library wants. The built-in set is brand neutral by construction (grey
+     * palette, fonts every mail client has, placeholder copy naming nobody, and
+     * `data:` URI images, so a workspace whose `asset_policy` is `service_only`
+     * can send them); turning them off is about whose library it is, not about
+     * whether they are safe to show.
+     */
+    builtInSections?: boolean;
+    /**
+     * The origin the editor's placeholder images are served from, with no
+     * trailing slash, e.g. `https://mail.example.com`. Each becomes
+     * `<base>/p/<width>x<height>.png`.
+     *
+     * Give it whenever the documents this editor produces are going to be sent.
+     * Without it every placeholder is a `data:` URI, which renders in the canvas
+     * but which Gmail and Outlook.com do not render at all, and which a workspace
+     * that only allows its own service's addresses may not be able to replace.
+     */
+    placeholderBase?: string;
+    /**
+     * Keep a section for reuse. When set, a section's controls on the canvas
+     * carry a "Save as a section" action, which asks for a name (refusing one
+     * already in `savedSections`) and calls this with the section as plain data.
+     *
+     * Resolve when it is stored; a rejection is shown in the dialog with the
+     * error's message and the dialog stays open. Without it no action appears,
+     * rather than one that fails.
+     *
+     * The editor does not reload `savedSections` afterwards: the host owns that
+     * list and passes a new one when it has stored the section.
+     */
+    onSaveSection?: (section: Record<string, unknown>, name: string) => Promise<void>;
+}
+/**
+ * One saved section as the host holds it. The `section` is a snapshot of a
+ * single section of a document; inserting it rebuilds every id, so the same
+ * saved section can go into one document twice.
+ */
+interface SavedSectionInput {
+    id: string;
+    name: string;
+    description?: string;
+    section: Record<string, unknown>;
+}
+/**
+ * Editor instance API
+ */
+interface EditorInstance {
+    getValue(): EmailTemplate;
+    setValue(template: EmailTemplate): void;
+    getHTML(): string;
+    getMJML(): string;
+    undo(): void;
+    redo(): void;
+    destroy(): void;
+}
+
+export type { EditorOptions as E, SavedSectionInput as S, EditorInstance as a, EditorTheme as b };

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@marlinjai/email-editor",
+  "version": "0.2.0",
+  "description": "Embeddable visual email editor (React component and vanilla factory) that produces an MJML-compilable document",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/marlinjai/email-editor.git",
+    "directory": "packages/editor"
+  },
+  "homepage": "https://github.com/marlinjai/email-editor/tree/main/packages/editor#readme",
+  "bugs": {
+    "url": "https://github.com/marlinjai/email-editor/issues"
+  },
+  "keywords": [
+    "email",
+    "mjml",
+    "email-editor",
+    "react",
+    "newsletter"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": [
+    "*.css"
+  ],
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "import": "./dist/react.mjs",
+      "require": "./dist/react.js"
+    },
+    "./styles.css": "./dist/styles.css"
+  },
+  "dependencies": {
+    "@marlinjai/email-editor-blocks": "^0.2.0",
+    "@marlinjai/email-editor-ui": "^0.2.0",
+    "@marlinjai/email-editor-core": "^0.2.0"
+  },
+  "peerDependencies": {
+    "react": "^18.2.0 || ^19.0.0",
+    "react-dom": "^18.2.0 || ^19.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.3.0",
+    "@types/react-dom": "^19.3.0",
+    "jsdom": "^24",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.0",
+    "vitest": "^1.0.4"
+  },
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts src/react.tsx --format cjs,esm --dts --clean && cp ../ui/dist/styles.css ./dist/styles.css",
+    "dev": "tsup src/index.ts src/react.tsx --format cjs,esm --dts --watch",
+    "lint": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "clean": "rm -rf dist"
+  }
+}