@weavour/react 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Weavour contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,19 @@
-# Temporary Holding Version
+# @weavour/react
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+MIT-licensed React 18.3/19 wrapper for the hosted Weavour email editor.
+Install with `npm install @weavour/react`; React is a peer dependency.
+
+```tsx
+import { WeavourEditor } from '@weavour/react';
+
+<WeavourEditor editorKey="YOUR_PUBLIC_EDITOR_KEY" userId="user-123" style={{ height: 700 }} />
+```
+
+The wrapper uses `@weavour/editor`, mounts in a client effect, cleans up on unmount,
+and updates live configuration without replacing email content. Callback props
+always use the latest handlers. Identity and initial content require an explicit
+keyed remount. Imports are SSR safe; the bundle preserves its `use client` boundary.
+
+The hosted editor and services remain private. Your application handles delivery.
+Full API, identity/scoping rules, examples and release compatibility:
+<https://github.com/weavour/editor-sdk>

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import { type HTMLAttributes } from 'react';
+import { type EditorInstance, type MountOptions, type EditorConfig } from '@weavour/editor';
+export type WeavourEditorProps = MountOptions & Omit<HTMLAttributes<HTMLDivElement>, keyof MountOptions | 'children'>;
+export type WeavourEditorRef = Omit<EditorInstance, 'destroy'>;
+/** Mount-only props require an explicit React key change to replace the session. */
+export declare const WeavourEditor: import("react").ForwardRefExoticComponent<EditorConfig & import("@weavour/editor").EditorCallbacks & {
+    editorKey: string;
+    userId?: string;
+    organizationId?: string;
+    document?: Record<string, unknown>;
+    emailDocument?: import("@weavour/editor").EmailDocument;
+    subject?: string;
+    preheader?: string;
+    draftId?: string;
+    editorConfig?: EditorConfig;
+    editorUrl?: string;
+    apiUrl?: string;
+    demo?: boolean;
+} & Omit<HTMLAttributes<HTMLDivElement>, "subject" | "preheader" | "demo" | "editorKey" | "userId" | "draftId" | "organizationId" | "document" | "emailDocument" | keyof EditorConfig | keyof import("@weavour/editor").EditorCallbacks | "editorConfig" | "editorUrl" | "apiUrl" | "children"> & import("react").RefAttributes<WeavourEditorRef>>;

package/dist/index.js

@@ -0,0 +1,81 @@
+"use client";
+
+// packages/react/src/index.tsx
+import { forwardRef, createElement, useEffect, useImperativeHandle, useRef } from "react";
+import { mount, EditorError } from "@weavour/editor";
+var liveKeys = ["theme", "locale", "mergeTags", "allowedBlocks", "enableAi", "aiPaidOrigin", "enableTemplates", "enableAutosave"];
+var mountKeys = ["editorKey", "userId", "organizationId", "document", "emailDocument", "subject", "preheader", "draftId", "editorUrl", "apiUrl", "editorConfig", "demo"];
+var WeavourEditor = forwardRef(function WeavourEditor2(props, ref) {
+  const container = useRef(null);
+  const editor = useRef(null);
+  const latest = useRef(props);
+  latest.current = props;
+  const initial = useRef(null);
+  const previousLive = useRef("");
+  const active = () => {
+    if (!editor.current) throw new EditorError("not_ready", "Editor is not mounted.");
+    return editor.current;
+  };
+  useImperativeHandle(ref, () => ({
+    get ready() {
+      return active().ready;
+    },
+    exportHTML: () => active().exportHTML(),
+    previewTemplate: () => active().previewTemplate(),
+    flushAutosave: () => active().flushAutosave(),
+    updateConfig: (next) => active().updateConfig(next)
+  }), []);
+  useEffect(() => {
+    initial.current = latest.current;
+    const value = latest.current;
+    let instance;
+    try {
+      instance = mount(container.current, {
+        ...value,
+        onReady: () => latest.current.onReady?.(),
+        onError: (error) => latest.current.onError?.(error),
+        onChange: (document) => latest.current.onChange?.(document),
+        onDocumentChange: (document) => latest.current.onDocumentChange?.(document),
+        onSaveStatusChange: (status) => latest.current.onSaveStatusChange?.(status),
+        onDraftChange: (draft) => latest.current.onDraftChange?.(draft),
+        onTestEmail: value.onTestEmail ? (request) => {
+          if (!latest.current.onTestEmail) throw new Error("Test email delivery is unavailable.");
+          return latest.current.onTestEmail(request);
+        } : void 0
+      });
+      editor.current = instance;
+    } catch (error) {
+      latest.current.onError?.(error instanceof Error ? error : new Error(String(error)));
+      return;
+    }
+    return () => {
+      instance.destroy();
+      if (editor.current === instance) editor.current = null;
+    };
+  }, []);
+  useEffect(() => {
+    const config = { mergeTags: props.mergeTags };
+    for (const key of liveKeys) if (Object.hasOwn(props, key)) Object.assign(config, { [key]: props[key] });
+    const serialized = JSON.stringify(config);
+    if (serialized !== previousLive.current) {
+      try {
+        editor.current?.updateConfig(config);
+        previousLive.current = serialized;
+      } catch (error) {
+        latest.current.onError?.(error instanceof Error ? error : new Error(String(error)));
+      }
+    }
+    const first = initial.current;
+    if (first && mountKeys.some((key) => JSON.stringify(props[key]) !== JSON.stringify(first[key]))) {
+      latest.current.onError?.(new EditorError("invalid_config", "Mount-only props changed. Use a new React key after saving current work."));
+    }
+  });
+  const attributes = {};
+  for (const [key, value] of Object.entries(props)) {
+    if (key === "id" || key === "className" || key === "style" || key === "title" || key === "role" || key === "tabIndex" || key.startsWith("aria-") || key.startsWith("data-")) attributes[key] = value;
+  }
+  return createElement("div", { ...attributes, ref: container });
+});
+export {
+  WeavourEditor
+};

package/package.json

@@ -1,6 +1,38 @@
 {
+  "version": "0.1.1",
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/weavour/editor-sdk.git"
+  },
+  "homepage": "https://github.com/weavour/editor-sdk#readme",
+  "bugs": "https://github.com/weavour/editor-sdk/issues",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=22.12"
+  },
   "name": "@weavour/react",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "description": "React bindings for the hosted Weavour email editor.",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@weavour/editor": "0.1.1"
+  },
+  "peerDependencies": {
+    "react": "^18.3.1 || ^19.0.0"
+  }
+}