@edmissioncrm/editor 0.0.0-stage → 0.1.1

package/index.d.ts

@@ -0,0 +1,144 @@
+// Public type surface for @edmissioncrm/editor.
+//
+// Hand-written and self-contained (the editor engine is bundled into this package, so its
+// generated types are not available for consumers to resolve). The `typecheck` script (tsc against the
+// real src) fails the build if this surface drifts from the implementation.
+
+import type { CSSProperties, ForwardRefExoticComponent, PropsWithoutRef, RefAttributes } from "react";
+
+/** An opaque design document (the editor's saved/loaded JSON). */
+export type Design = Record<string, unknown>;
+
+/** Backend wiring: your API base URL and the headers sent with every request. No secret belongs here. */
+export interface EdmissionApiOptions {
+  /** Base URL of your API, e.g. "https://api.example.com". Defaults to the page origin. */
+  apiBaseUrl: string;
+  /** Organization id, sent as the `organization-id` header. Defaults to the first UUID found in the page URL path. */
+  orgId: string;
+  /** Bearer token. Defaults to `localStorage.token`; omit both to rely on the session cookie. */
+  authToken?: string;
+  /** Image upload endpoint. Default `/buzz-communication/upload/template-assets`. */
+  uploadPath?: string;
+  /** AI "generate email" endpoint. Default `/mail-templates/ai-generate`. */
+  aiGeneratePath?: string;
+  /** Google OAuth Web client id. When set, the image library shows a Google Drive tab. */
+  googleClientId?: string;
+  /** Full URL of the S3 asset-list endpoint. Default `${apiBaseUrl}/buzz-communication/upload/template-assets`. */
+  s3ListEndpoint?: string;
+}
+
+/** Google Drive mode. Default "off". */
+export type DriveMode = "off" | "client-id";
+
+/** What the editor builds. "email" = mail, "document" = PDF. */
+export type EdmissionBuilderMode = "email" | "page" | "document" | "popup";
+
+/** Merge-tag map for the picker and the preview. */
+export type EdmissionMergeTags = Record<string, { label: string; value: string; sample?: string }>;
+
+export interface EdmissionEmailEditorProps {
+  edmission: EdmissionApiOptions;
+  /** "email" (mail) or "document" (PDF); also "page"/"popup". Default "email". */
+  builder?: EdmissionBuilderMode;
+  mergeTags?: EdmissionMergeTags;
+  logoUrl?: string;
+  logoAlt?: string;
+  driveMode?: DriveMode;
+  googleClientId?: string;
+  initialDesign?: Design;
+  onDesignChange?: (design: Design) => void;
+  className?: string;
+  style?: CSSProperties;
+}
+
+/** Imperative handle for the editor. */
+export interface EdmEditorRef {
+  getDesign: () => Design;
+  exportHtml: (mergeTags?: Record<string, string>) => string;
+  exportAmp: (mergeTags?: Record<string, string>) => string;
+  /** Export a print-optimized document (document builder → print to PDF). */
+  exportDocument: (mergeTags?: Record<string, string>) => string;
+  exportZip: (mergeTags?: Record<string, string>) => Uint8Array;
+  loadDesign: (design: Design) => void;
+  saveSnapshot: (label?: string) => void;
+  getSnapshots: () => Array<{ id: string; label: string; createdAt: string }>;
+  restoreSnapshot: (snapshotId: string) => void;
+}
+
+/** The bring-your-own AI adapter shape (what createEdmissionAiAdapter returns). */
+export interface EdmAiAdapter {
+  generateDesignFromPrompt: (input: { prompt: string; design: Design; mergeTags?: Record<string, string> }) => Promise<{ design?: Design; summary?: string }>;
+  rewriteText: (input: { prompt: string; block: unknown; design: Design; mergeTags?: Record<string, string>; selectedText?: string }) => Promise<{ text?: string; html?: string }>;
+  generateSubjectLines: (input: { prompt: string; design: Design; count?: number }) => Promise<{ subjects: string[] }>;
+  generateAltText: (input: { assetUrl: string; assetKind: "image" | "gif" | "video"; title?: string; currentAlt?: string; design: Design }) => Promise<{ alt: string }>;
+}
+
+export declare const EdmissionEmailEditor: ForwardRefExoticComponent<
+  PropsWithoutRef<EdmissionEmailEditorProps> & RefAttributes<EdmEditorRef>
+>;
+
+// ---- react-email-editor (Unlayer) DROP-IN (default export) ----------------------------------------
+
+/** Unlayer `options` (only the fields the editor reads). */
+export interface EmailEditorOptions {
+  mergeTags?: unknown;
+  displayMode?: "email" | "web" | "page" | "document" | "popup";
+  [key: string]: unknown;
+}
+
+/** The Unlayer-shaped imperative editor API (`ref.current.editor.*`). */
+export interface UnlayerEditorApi {
+  loadDesign: (design: Design) => void;
+  saveDesign: (cb: (design: Design) => void) => void;
+  exportHtml: (cb: (data: { design: Design; html: string }) => void) => void;
+  exportPlainText?: (cb: (data: { design: Design; text: string }) => void) => void;
+  setMergeTags: (tags: unknown) => void;
+  addEventListener: (event: string, handler: (data?: unknown) => void) => void;
+  removeEventListener: (event: string, handler: (data?: unknown) => void) => void;
+  registerCallback: (type: string, cb: (...args: unknown[]) => void) => void;
+}
+
+export interface EmailEditorRef {
+  editor: UnlayerEditorApi;
+}
+
+export interface EmailEditorProps {
+  /** Backend wiring. Optional: apiBaseUrl defaults to the page origin, orgId to the UUID in the URL, bearer to localStorage.token. */
+  edmission?: Partial<EdmissionApiOptions>;
+  options?: EmailEditorOptions;
+  onReady?: (editor: UnlayerEditorApi) => void;
+  onLoad?: (data?: unknown) => void;
+  logoUrl?: string;
+  logoAlt?: string;
+  style?: CSSProperties;
+  minHeight?: string | number;
+  className?: string;
+}
+
+/** react-email-editor DROP-IN. `import EmailEditor from "@edmissioncrm/editor"`. */
+export declare const EmailEditor: ForwardRefExoticComponent<
+  PropsWithoutRef<EmailEditorProps> & RefAttributes<EmailEditorRef>
+>;
+export default EmailEditor;
+
+/** Build the editor's `onImageUpload` handler (POSTs the file to your upload endpoint). */
+export declare function createEdmissionUploadHandler(
+  options: EdmissionApiOptions
+): (
+  file: File, context: { kind: "image" | "gif" | "video" | "pdf"; onProgress?: (percent: number) => void }
+) => Promise<{ url: string; alt?: string }>;
+
+/** Build an AI adapter wired to your AI endpoint (provider keys stay on your server). */
+export declare function createEdmissionAiAdapter(options: EdmissionApiOptions): EdmAiAdapter;
+
+/** Headers (organization-id + optional bearer) sent with every request. */
+export declare function edmissionConnectorHeaders(options: EdmissionApiOptions): Record<string, string>;
+
+/** Build the `googleDrive` config value for the chosen mode. */
+export declare function buildEdmissionGoogleDrive(
+  mode?: DriveMode, clientId?: string
+): boolean | { clientId: string };
+
+export declare const DEFAULT_EDMISSION_UPLOAD_PATH: string;
+export declare const DEFAULT_EDMISSION_AI_GENERATE_PATH: string;
+export declare const DEFAULT_EDMISSION_S3_LIST_PATH: string;

package/package.json

@@ -1,6 +1,51 @@
 {
   "name": "@edmissioncrm/editor",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "Embeddable drag-and-drop email and document builder for React, a drop-in react-email-editor replacement.",
+  "keywords": [
+    "email",
+    "editor",
+    "email-builder",
+    "react-email-editor",
+    "react",
+    "newsletter",
+    "pdf",
+    "template-builder"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "index.d.ts",
+    "README.md",
+    "LICENSE",
+    "THIRD_PARTY_LICENSES.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "vite build",
+    "prepublishOnly": "pnpm --filter \"edm-react...\" build && pnpm run build",
+    "typecheck": "tsc --noEmit -p tsconfig.json"
+  },
+  "peerDependencies": {
+    "react": ">=18",
+    "react-dom": ">=18"
+  },
+  "devDependencies": {
+    "edm-core": "workspace:*",
+    "edm-react": "workspace:*",
+    "edm-renderer": "workspace:*"
+  }
+}