@octane-xplat/richtext 0.9.0 → 0.10.0

package/src/index.macos.ts

@@ -1,10 +1,4 @@
-import type { RichTextEditorProps } from './types'
-
-export const supported = false
-
-/** The macOS editor is deferred; the tiptap facade covers desktop needs. */
-export function RichTextEditor(_props: RichTextEditorProps): null {
-	return null
-}
-
+export { RichTextEditor } from './Editor.macos'
+/** The AppKit/WKWebView backend is implemented. */
+export const supported = true
 export type * from './types'

package/src/types.ts

@@ -1,6 +1,7 @@
-/** Supported on Android today (WordPress Aztec); iOS is stubbed until the
- *  Swift-facade bring-up. Web/macOS/Windows route through the tiptap facade
- *  instead of this leaf. */
+import type { Octane } from 'octane/jsx-runtime'
+
+/** Android uses WordPress Aztec; AppKit uses StarterKit in WKWebView.
+ * iOS is stubbed. Web/Windows use the tiptap facade instead of this leaf. */
 export type RichTextFormat =
 	| 'bold'
 	| 'italic'
@@ -31,8 +32,9 @@ export type RichTextFormat =
 export interface RichTextEditorHandle {
 	/** Serialized document HTML (Aztec's "plain" HTML — no contenteditable
 	 *  markup). */
+	/** AppKit: returns the latest WebKit snapshot; commands are asynchronous. */
 	getHTML(): string
-	/** Replace the document; resets Aztec's undo history. */
+	/** Replace the document. Android resets Aztec history; AppKit uses engine history. */
 	setHTML(html: string): void
 	/** Toggle a format at the current selection. `link` needs
 	 *  `linkTo(url, anchor)` instead. */
@@ -50,6 +52,7 @@ export interface RichTextEditorHandle {
 	blur(): void
 	isFocused(): boolean
 	/** The platform surface — `AztecText` on Android. */
+	/** AppKit: the XplatEditorHost transport, not the browser engine instance. */
 	native: any
 }
 
@@ -77,7 +80,7 @@ export interface RichTextEditorProps {
 	onFocus?: () => void
 	onBlur?: () => void
 	/** Imperative handle — fires once when the native editor exists. */
-	bind?: (handle: RichTextEditorHandle) => void
+	ref?: Octane.Ref<RichTextEditorHandle>
 	/** Per-platform escape bag — properties are assigned onto the native
 	 *  `AztecText` after the leaf's own props. */
 	android?: Record<string, any>

package/types/browser-transport.d.ts

@@ -0,0 +1,2 @@
+/** Internal WebKit document transport installer. */
+export declare function installEditorDocument(render: (props: any) => void): void

package/types/index.macos.d.ts

@@ -0,0 +1,5 @@
+import type { UniversalComponent } from 'octane/universal'
+import type { RichTextEditorProps } from '../src/types'
+export declare const RichTextEditor: UniversalComponent<RichTextEditorProps>
+export declare const supported: boolean
+export type * from '../src/types'

package/types/macos-host.d.ts

@@ -0,0 +1,11 @@
+import type { UniversalComponent } from 'octane/universal'
+import type { RichTextEditorProps } from '../src/types'
+/** Internal shared editor host. */
+export declare const NativeEditor: UniversalComponent<
+	RichTextEditorProps & {
+		browser: string
+		json?: any
+		onJSONReady?: (ok: boolean) => void
+		onJSONChange?: (doc: any) => void
+	}
+>

package/types/types.d.ts

@@ -1,12 +1,13 @@
-/** Supported on Android today (WordPress Aztec); iOS is stubbed until the
- *  Swift-facade bring-up. Web/macOS/Windows route through the tiptap facade
- *  instead of this leaf. */
+import type { Octane } from 'octane/jsx-runtime';
+/** Android uses WordPress Aztec; AppKit uses StarterKit in WKWebView.
+ * iOS is stubbed. Web/Windows use the tiptap facade instead of this leaf. */
 export type RichTextFormat = 'bold' | 'italic' | 'underline' | 'strikethrough' | 'code' | 'blockquote' | 'bulletList' | 'orderedList' | 'taskList' | 'codeBlock' | 'horizontalRule' | 'highlight' | 'subscript' | 'superscript' | 'paragraph' | 'heading1' | 'heading2' | 'heading3' | 'heading4' | 'heading5' | 'heading6' | 'alignLeft' | 'alignCenter' | 'alignRight' | 'link';
 export interface RichTextEditorHandle {
     /** Serialized document HTML (Aztec's "plain" HTML — no contenteditable
      *  markup). */
+    /** AppKit: returns the latest WebKit snapshot; commands are asynchronous. */
     getHTML(): string;
-    /** Replace the document; resets Aztec's undo history. */
+    /** Replace the document. Android resets Aztec history; AppKit uses engine history. */
     setHTML(html: string): void;
     /** Toggle a format at the current selection. `link` needs
      *  `linkTo(url, anchor)` instead. */
@@ -24,6 +25,7 @@ export interface RichTextEditorHandle {
     blur(): void;
     isFocused(): boolean;
     /** The platform surface — `AztecText` on Android. */
+    /** AppKit: the XplatEditorHost transport, not the browser engine instance. */
     native: any;
 }
 export interface RichTextSelectionChange {
@@ -49,7 +51,7 @@ export interface RichTextEditorProps {
     onFocus?: () => void;
     onBlur?: () => void;
     /** Imperative handle — fires once when the native editor exists. */
-    bind?: (handle: RichTextEditorHandle) => void;
+    ref?: Octane.Ref<RichTextEditorHandle>;
     /** Per-platform escape bag — properties are assigned onto the native
      *  `AztecText` after the leaf's own props. */
     android?: Record<string, any>;