@octane-xplat/tiptap 0.0.1 → 0.10.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Alec Larson
+
+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,79 @@
-# @octane-xplat/tiptap
+# `@octane-xplat/tiptap`
 
-Version 0.0.1 is a reservation stub so the automated release can publish this package name. It has no supported API. Use a later release for the implementation.
+The unified rich-text facade: one `TiptapEditor` component across web and
+native. Web renders a real tiptap `Editor` through `@octanejs/tiptap`'s
+`EditorContent`; Android renders the `@octane-xplat/richtext` leaf (WordPress
+Aztec on Android, iOS stub) and layers tiptap document JSON on top through
+the DOM-free ProseMirror slices (`@tiptap/pm`, `@tiptap/static-renderer`)
+with a `zeed-dom` parse shim. No DOM-bound tiptap code (`EditorView`) ever
+enters a native bundle — divergence lives at the file-suffix boundary.
+
+```tsx
+import { useState } from 'octane'
+import { TiptapEditor, supported } from '@octane-xplat/tiptap'
+import { Text } from '@octane-xplat/ui'
+
+export function Notes() {
+	const [html, setHtml] = useState('<p>Trip notes</p>')
+	return supported ? (
+		<TiptapEditor value={html} onChange={setHtml} />
+	) : (
+		<Text>Editing is unavailable on this target</Text>
+	)
+}
+```
+
+`value`/`onChange` exchange document HTML. `getJSON`/`setJSON` exchange
+tiptap document JSON: synchronous on web, bridged on native after
+`onJSONReady(true)` — the lazy bridge reports `false` (and `getJSON()`
+returns `null`) on runtimes that cannot host the schema modules. On native,
+HTML is the canonical interchange format; JSON output is a best-effort
+mapping of Aztec's flat span list onto ProseMirror's tree.
+
+```tsx
+import { useRef, useState } from 'octane'
+import { TiptapEditor, type TiptapEditorHandle } from '@octane-xplat/tiptap'
+import { Button } from '@octane-xplat/ui'
+
+export function DocumentCopy() {
+	const editor = useRef<TiptapEditorHandle | null>(null)
+	const [html, setHtml] = useState('<p>Trip notes</p>')
+	const [jsonReady, setJsonReady] = useState(false)
+	return (
+		<>
+			<TiptapEditor
+				value={html}
+				onChange={setHtml}
+				ref={(handle) => {
+					editor.current = handle
+				}}
+				onReady={() => setJsonReady(editor.current?.getJSON() != null)}
+				onJSONReady={setJsonReady}
+			/>
+			<Button
+				isDisabled={!jsonReady}
+				onPress={() => {
+					const document = editor.current?.getJSON()
+					if (document) editor.current?.setJSON(document)
+				}}
+			>
+				Round-trip document
+			</Button>
+		</>
+	)
+}
+```
+
+The tiptap family pins to `3.28.0` to match `@octanejs/tiptap@0.0.51` —
+extension `^` ranges float ahead of core and break (`getPreviousBlockSibling`),
+so consumers should keep the workspace override. See
+[`docs/app/rich-text.md`](../../docs/app/rich-text.md) for the shared contract,
+format vocabulary, and known limits.
+
+## macOS AppKit
+
+The macOS export mounts a bundled local editor document in WKWebView.
+RichText uses StarterKit; Tiptap and Lexical use their existing web facades.
+Wait for `onReady`; synchronous getters return the latest received snapshot
+and commands cross WebKit asynchronously. The `native` handle is the Swift
+host transport. See [AppKit setup and engine limits](../../docs/rich-text.md#macos-appkit-editing).

package/dist/macos/browser.d.ts

@@ -0,0 +1 @@
+declare const html: string; export default html