@openeditor/native 0.0.1

package/README.md

@@ -0,0 +1,37 @@
+# `@openeditor/native`
+
+Component-first React Native SDK for OpenEditor.
+
+## Public surface
+
+- `OpenEditorNative` as the primary editing surface
+- `OpenEditorNativeViewer` for read-only rendering
+- native document bridge helpers where renderer adaptation is required
+
+## Required peers
+
+- `@openeditor/react-native-prose-editor`
+- `react`
+- `react-native`
+- `react-native-keyboard-controller` (optional but recommended for keyboard toolbar placement)
+
+## Quick start
+
+```tsx
+import { OpenEditorNative } from "@openeditor/native";
+
+export function Example() {
+  return (
+    <OpenEditorNative
+      onChange={(document) => {
+        console.log(document);
+      }}
+    />
+  );
+}
+```
+
+## Internal notes
+
+- The native prose editor engine remains an implementation detail behind this package.
+- Shared contracts come from `@openeditor/core`; content definitions come from `@openeditor/schema`.

package/dist/document.d.ts

@@ -0,0 +1,7 @@
+import { type OpenEditorDocument, type OpenEditorDocumentMeta, type ProseMirrorDocument, type ProseMirrorNode } from "@openeditor/core";
+export declare const sanitizeNativeEditorDocument: (document: OpenEditorDocument, meta?: OpenEditorDocumentMeta | undefined) => OpenEditorDocument;
+export declare const toNativeEditorNode: (node: ProseMirrorNode) => ProseMirrorNode;
+export declare const fromNativeEditorNode: (node: ProseMirrorNode) => ProseMirrorNode;
+export declare const toNativeEditorDocument: (document: OpenEditorDocument) => ProseMirrorDocument;
+export declare const fromNativeEditorDocument: (document: ProseMirrorDocument, meta?: OpenEditorDocumentMeta) => OpenEditorDocument;
+export declare const createNativeEditorDocument: (content: ProseMirrorNode[], meta?: OpenEditorDocumentMeta) => ProseMirrorDocument;

package/dist/document.js

@@ -0,0 +1,69 @@
+import { cloneNode, createDocument, findBlockSpecForNode, fromProseMirrorDocument, normalizeDocument, toProseMirrorDocument, } from "@openeditor/core";
+import { defaultBlockRegistry } from "@openeditor/schema";
+const NATIVE_HEADING_PATTERN = /^h([1-6])$/;
+const clampHeadingLevel = (value) => typeof value === "number" ? Math.min(Math.max(value, 1), 6) : 2;
+const cloneAttrsWithoutHeadingLevel = (attrs) => {
+    if (!attrs) {
+        return undefined;
+    }
+    const { level: _level, ...nextAttrs } = attrs;
+    return Object.keys(nextAttrs).length ? nextAttrs : undefined;
+};
+const withMappedContent = (node, mapNode) => {
+    const cloned = cloneNode(node);
+    return {
+        ...cloned,
+        ...(cloned.content ? { content: cloned.content.map(mapNode) } : {}),
+    };
+};
+const sanitizeNativeNode = (node) => {
+    const spec = findBlockSpecForNode(defaultBlockRegistry, node);
+    if (spec?.support?.native === "unsupported") {
+        return null;
+    }
+    const cloned = cloneNode(node);
+    const nextContent = cloned.content
+        ?.map(sanitizeNativeNode)
+        .filter((child) => child !== null);
+    return {
+        ...cloned,
+        ...(nextContent ? { content: nextContent } : {}),
+    };
+};
+export const sanitizeNativeEditorDocument = (document, meta = document.meta) => createDocument(normalizeDocument(document).content
+    .map(sanitizeNativeNode)
+    .filter((node) => node !== null), meta);
+export const toNativeEditorNode = (node) => {
+    if (node.type === "heading") {
+        const cloned = withMappedContent(node, toNativeEditorNode);
+        const attrs = cloneAttrsWithoutHeadingLevel(node.attrs);
+        const { attrs: _attrs, ...headingNode } = cloned;
+        return {
+            ...headingNode,
+            type: `h${clampHeadingLevel(node.attrs?.level)}`,
+            ...(attrs ? { attrs } : {}),
+        };
+    }
+    return withMappedContent(node, toNativeEditorNode);
+};
+export const fromNativeEditorNode = (node) => {
+    const headingMatch = NATIVE_HEADING_PATTERN.exec(node.type);
+    if (headingMatch) {
+        const cloned = withMappedContent(node, fromNativeEditorNode);
+        return {
+            ...cloned,
+            type: "heading",
+            attrs: { ...node.attrs, level: Number(headingMatch[1]) },
+        };
+    }
+    return withMappedContent(node, fromNativeEditorNode);
+};
+export const toNativeEditorDocument = (document) => ({
+    type: "doc",
+    content: toProseMirrorDocument(sanitizeNativeEditorDocument(document)).content.map(toNativeEditorNode),
+});
+export const fromNativeEditorDocument = (document, meta) => normalizeDocument(fromProseMirrorDocument({
+    type: "doc",
+    content: document.content.map(fromNativeEditorNode),
+}, meta));
+export const createNativeEditorDocument = (content, meta) => toNativeEditorDocument(createDocument(content, meta));

package/dist/document.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/document.ts"],"names":[],"mappings":";;;;AAeA,IAAM,sBAAA,GAAyB,YAAA;AAE/B,IAAM,iBAAA,GAAoB,CAAC,KAAA,KACzB,OAAO,UAAU,QAAA,GAAW,IAAA,CAAK,GAAA,CAAI,IAAA,CAAK,GAAA,CAAI,KAAA,EAAO,CAAC,CAAA,EAAG,CAAC,CAAA,GAAI,CAAA;AAEhE,IAAM,6BAAA,GAAgC,CAAC,KAAA,KAA2D;AAChG,EAAA,IAAI,CAAC,KAAA,EAAO;AACV,IAAA,OAAO,MAAA;AAAA,EACT;AAEA,EAAA,MAAM,EAAE,KAAA,EAAO,MAAA,EAAQ,GAAG,WAAU,GAAI,KAAA;AACxC,EAAA,OAAO,MAAA,CAAO,IAAA,CAAK,SAAS,CAAA,CAAE,SAAS,SAAA,GAAY,MAAA;AACrD,CAAA;AAEA,IAAM,iBAAA,GAAoB,CACxB,IAAA,EACA,OAAA,KACoB;AACpB,EAAA,MAAM,MAAA,GAAS,UAAU,IAAI,CAAA;AAC7B,EAAA,OAAO;AAAA,IACL,GAAG,MAAA;AAAA,IACH,GAAI,MAAA,CAAO,OAAA,GAAU,EAAE,OAAA,EAAS,MAAA,CAAO,OAAA,CAAQ,GAAA,CAAI,OAAO,CAAA,EAAE,GAAI;AAAC,GACnE;AACF,CAAA;AAEA,IAAM,kBAAA,GAAqB,CAAC,IAAA,KAAkD;AAC5E,EAAA,MAAM,IAAA,GAAO,oBAAA,CAAqB,oBAAA,EAAsB,IAAI,CAAA;AAC5D,EAAA,IAAI,IAAA,EAAM,OAAA,EAAS,MAAA,KAAW,aAAA,EAAe;AAC3C,IAAA,OAAO,IAAA;AAAA,EACT;AAEA,EAAA,MAAM,MAAA,GAAS,UAAU,IAAI,CAAA;AAC7B,EAAA,MAAM,WAAA,GAAc,MAAA,CAAO,OAAA,EACvB,GAAA,CAAI,kBAAkB,EACvB,MAAA,CAAO,CAAC,KAAA,KAAoC,KAAA,KAAU,IAAI,CAAA;AAE7D,EAAA,OAAO;AAAA,IACL,GAAG,MAAA;AAAA,IACH,GAAI,WAAA,GAAc,EAAE,OAAA,EAAS,WAAA,KAAgB;AAAC,GAChD;AACF,CAAA;AAEO,IAAM,4BAAA,GAA+B,CAC1C,QAAA,EACA,IAAA,GAA2C,SAAS,IAAA,KAEpD,cAAA;AAAA,EACE,iBAAA,CAAkB,QAAQ,CAAA,CAAE,OAAA,CACzB,GAAA,CAAI,kBAAkB,CAAA,CACtB,MAAA,CAAO,CAAC,IAAA,KAAkC,IAAA,KAAS,IAAI,CAAA;AAAA,EAC1D;AACF;AAEK,IAAM,kBAAA,GAAqB,CAAC,IAAA,KAA2C;AAC5E,EAAA,IAAI,IAAA,CAAK,SAAS,SAAA,EAAW;AAC3B,IAAA,MAAM,MAAA,GAAS,iBAAA,CAAkB,IAAA,EAAM,kBAAkB,CAAA;AACzD,IAAA,MAAM,KAAA,GAAQ,6BAAA,CAA8B,IAAA,CAAK,KAAK,CAAA;AACtD,IAAA,MAAM,EAAE,KAAA,EAAO,MAAA,EAAQ,GAAG,aAAY,GAAI,MAAA;AAE1C,IAAA,OAAO;AAAA,MACL,GAAG,WAAA;AAAA,MACH,MAAM,CAAA,CAAA,EAAI,iBAAA,CAAkB,IAAA,CAAK,KAAA,EAAO,KAAK,CAAC,CAAA,CAAA;AAAA,MAC9C,GAAI,KAAA,GAAQ,EAAE,KAAA,KAAU;AAAC,KAC3B;AAAA,EACF;AAEA,EAAA,OAAO,iBAAA,CAAkB,MAAM,kBAAkB,CAAA;AACnD;AAEO,IAAM,oBAAA,GAAuB,CAAC,IAAA,KAA2C;AAC9E,EAAA,MAAM,YAAA,GAAe,sBAAA,CAAuB,IAAA,CAAK,IAAA,CAAK,IAAI,CAAA;AAE1D,EAAA,IAAI,YAAA,EAAc;AAChB,IAAA,MAAM,MAAA,GAAS,iBAAA,CAAkB,IAAA,EAAM,oBAAoB,CAAA;AAC3D,IAAA,OAAO;AAAA,MACL,GAAG,MAAA;AAAA,MACH,IAAA,EAAM,SAAA;AAAA,MACN,KAAA,EAAO,EAAE,GAAG,IAAA,CAAK,KAAA,EAAO,OAAO,MAAA,CAAO,YAAA,CAAa,CAAC,CAAC,CAAA;AAAE,KACzD;AAAA,EACF;AAEA,EAAA,OAAO,iBAAA,CAAkB,MAAM,oBAAoB,CAAA;AACrD;AAEO,IAAM,sBAAA,GAAyB,CAAC,QAAA,MACpC;AAAA,EACC,IAAA,EAAM,KAAA;AAAA,EACN,OAAA,EAAS,sBAAsB,4BAAA,CAA6B,QAAQ,CAAC,CAAA,CAAE,OAAA,CAAQ,IAAI,kBAAkB;AACvG,CAAA;AAEK,IAAM,wBAAA,GAA2B,CACtC,QAAA,EACA,IAAA,KAEA,iBAAA;AAAA,EACE,uBAAA;AAAA,IACE;AAAA,MACE,IAAA,EAAM,KAAA;AAAA,MACN,OAAA,EAAS,QAAA,CAAS,OAAA,CAAQ,GAAA,CAAI,oBAAoB;AAAA,KACpD;AAAA,IACA;AAAA;AAEJ;AAEK,IAAM,0BAAA,GAA6B,CACxC,OAAA,EACA,IAAA,KACwB,uBAAuB,cAAA,CAAe,OAAA,EAAS,IAAI,CAAC","file":"document.js","sourcesContent":["import {\n  cloneNode,\n  createDocument,\n  findBlockSpecForNode,\n  fromProseMirrorDocument,\n  normalizeDocument,\n  toProseMirrorDocument,\n  type OpenEditorDocument,\n  type OpenEditorDocumentMeta,\n  type ProseMirrorAttrs,\n  type ProseMirrorDocument,\n  type ProseMirrorNode,\n} from \"@openeditor/core\";\nimport { defaultBlockRegistry } from \"@openeditor/schema\";\n\nconst NATIVE_HEADING_PATTERN = /^h([1-6])$/;\n\nconst clampHeadingLevel = (value: unknown) =>\n  typeof value === \"number\" ? Math.min(Math.max(value, 1), 6) : 2;\n\nconst cloneAttrsWithoutHeadingLevel = (attrs?: ProseMirrorAttrs): ProseMirrorAttrs | undefined => {\n  if (!attrs) {\n    return undefined;\n  }\n\n  const { level: _level, ...nextAttrs } = attrs;\n  return Object.keys(nextAttrs).length ? nextAttrs : undefined;\n};\n\nconst withMappedContent = (\n  node: ProseMirrorNode,\n  mapNode: (node: ProseMirrorNode) => ProseMirrorNode,\n): ProseMirrorNode => {\n  const cloned = cloneNode(node);\n  return {\n    ...cloned,\n    ...(cloned.content ? { content: cloned.content.map(mapNode) } : {}),\n  };\n};\n\nconst sanitizeNativeNode = (node: ProseMirrorNode): ProseMirrorNode | null => {\n  const spec = findBlockSpecForNode(defaultBlockRegistry, node);\n  if (spec?.support?.native === \"unsupported\") {\n    return null;\n  }\n\n  const cloned = cloneNode(node);\n  const nextContent = cloned.content\n    ?.map(sanitizeNativeNode)\n    .filter((child): child is ProseMirrorNode => child !== null);\n\n  return {\n    ...cloned,\n    ...(nextContent ? { content: nextContent } : {}),\n  };\n};\n\nexport const sanitizeNativeEditorDocument = (\n  document: OpenEditorDocument,\n  meta: OpenEditorDocumentMeta | undefined = document.meta,\n): OpenEditorDocument =>\n  createDocument(\n    normalizeDocument(document).content\n      .map(sanitizeNativeNode)\n      .filter((node): node is ProseMirrorNode => node !== null),\n    meta,\n  );\n\nexport const toNativeEditorNode = (node: ProseMirrorNode): ProseMirrorNode => {\n  if (node.type === \"heading\") {\n    const cloned = withMappedContent(node, toNativeEditorNode);\n    const attrs = cloneAttrsWithoutHeadingLevel(node.attrs);\n    const { attrs: _attrs, ...headingNode } = cloned;\n\n    return {\n      ...headingNode,\n      type: `h${clampHeadingLevel(node.attrs?.level)}`,\n      ...(attrs ? { attrs } : {}),\n    };\n  }\n\n  return withMappedContent(node, toNativeEditorNode);\n};\n\nexport const fromNativeEditorNode = (node: ProseMirrorNode): ProseMirrorNode => {\n  const headingMatch = NATIVE_HEADING_PATTERN.exec(node.type);\n\n  if (headingMatch) {\n    const cloned = withMappedContent(node, fromNativeEditorNode);\n    return {\n      ...cloned,\n      type: \"heading\",\n      attrs: { ...node.attrs, level: Number(headingMatch[1]) },\n    };\n  }\n\n  return withMappedContent(node, fromNativeEditorNode);\n};\n\nexport const toNativeEditorDocument = (document: OpenEditorDocument): ProseMirrorDocument =>\n  ({\n    type: \"doc\",\n    content: toProseMirrorDocument(sanitizeNativeEditorDocument(document)).content.map(toNativeEditorNode),\n  });\n\nexport const fromNativeEditorDocument = (\n  document: ProseMirrorDocument,\n  meta?: OpenEditorDocumentMeta,\n): OpenEditorDocument =>\n  normalizeDocument(\n    fromProseMirrorDocument(\n      {\n        type: \"doc\",\n        content: document.content.map(fromNativeEditorNode),\n      },\n      meta,\n    ),\n  );\n\nexport const createNativeEditorDocument = (\n  content: ProseMirrorNode[],\n  meta?: OpenEditorDocumentMeta,\n): ProseMirrorDocument => toNativeEditorDocument(createDocument(content, meta));\n"]}

package/dist/index.d.ts

@@ -0,0 +1,66 @@
+import { type OpenEditorDocument, type ProseMirrorNode } from "@openeditor/core";
+import { type ReactNode } from "react";
+import type { NativeRichTextEditorToolbarPlacement } from "@openeditor/react-native-prose-editor";
+export type OpenEditorNativeProps = {
+    document?: OpenEditorDocument;
+    editable?: boolean;
+    showToolbar?: boolean;
+    theme?: Partial<OpenEditorNativeTheme>;
+    toolbarPlacement?: NativeRichTextEditorToolbarPlacement;
+    onChange?: (document: OpenEditorDocument) => void;
+};
+export type OpenEditorNativeViewerProps = Omit<OpenEditorNativeProps, "editable" | "showToolbar" | "onChange"> & {
+    showToolbar?: false;
+    renderers?: Partial<Record<string, OpenEditorNativeViewerRenderer>>;
+};
+export type OpenEditorNativeToolbarAction = {
+    key: string;
+    label: string;
+    onPress?: (key: string) => void;
+};
+export type OpenEditorNativeToolbarProps = {
+    actions?: readonly OpenEditorNativeToolbarAction[];
+    onActionPress?: (key: string) => void;
+    theme?: Partial<OpenEditorNativeTheme>;
+};
+export type OpenEditorNativeViewerRenderer = (context: {
+    node: ProseMirrorNode;
+    children: ReactNode;
+    theme: Required<OpenEditorNativeTheme>;
+}) => ReactNode;
+export type OpenEditorNativeToolbarTheme = {
+    height?: number;
+};
+export type OpenEditorNativeTheme = {
+    background: string;
+    surface: string;
+    surfaceMuted: string;
+    text: string;
+    textSoft?: string;
+    muted: string;
+    placeholder?: string;
+    border: string;
+    borderStrong?: string;
+    accent: string;
+    accentText: string;
+    accentStrong?: string;
+    primary: string;
+    primaryText: string;
+    codeBackground?: string;
+    codeText?: string;
+    debugBackground?: string;
+    debugText?: string;
+    debugHeading?: string;
+    debugBorder?: string;
+    debugButtonBackground?: string;
+    success?: string;
+    shadow?: string;
+    backdrop: string;
+    toolbar?: OpenEditorNativeToolbarTheme;
+};
+export declare const OpenEditorNativeToolbar: ({ actions, onActionPress, theme, }: OpenEditorNativeToolbarProps) => import("react").JSX.Element;
+export declare const OpenEditorNative: ({ document, editable, showToolbar, theme, toolbarPlacement, onChange, }: OpenEditorNativeProps) => import("react").JSX.Element;
+export declare const OpenEditorNativeViewer: ({ document, theme, renderers, }: OpenEditorNativeViewerProps) => import("react").JSX.Element;
+export { createNativeEditorDocument, fromNativeEditorDocument, sanitizeNativeEditorDocument, toNativeEditorDocument, } from "./document.js";
+export { createOpenEditorNativeToolbarItems, defaultDocumentForToolbarAction, nativeToolbarParityCoverage, openEditorNativeToolbarActionKeys, openEditorNativeToolbarItems, } from "./toolbar.js";
+export type { OpenEditorNativeToolbarActionKey } from "./toolbar.js";