@open-commune/editor 0.1.2 → 0.1.3

package/README.md

@@ -0,0 +1,32 @@
+# @open-commune/editor
+
+The rich-text editor of [Open Commune](https://github.com/open-commune/open-commune): document schema, TipTap extensions, and the sanitisation that guards them.
+
+Split out from the application so that the same document schema is shared by the editor writing the content and the server storing it — a document accepted by one is valid for the other.
+
+## Install
+
+```bash
+npm install @open-commune/editor
+```
+
+## Use
+
+```ts
+import { Callout, Details, Embed, FileNode, ImageNode, Uid, sanitizeDoc } from '@open-commune/editor';
+
+// client — add the shared nodes to a TipTap editor
+const editor = new Editor({
+  extensions: [StarterKit, Uid, Callout, ImageNode, FileNode, Embed, Details],
+  content: doc,
+});
+
+// server — never trust a document that came over the wire
+const safe = sanitizeDoc(incoming);
+```
+
+`sanitizeDoc` returns a document conforming to the schema, dropping anything the schema does not allow. It is what stands between stored content and injected markup, so run it on every write path.
+
+## Licence
+
+AGPL-3.0-or-later.

package/dist/index.d.mts

@@ -3,10 +3,10 @@ import * as _tiptap_extension_highlight from '@tiptap/extension-highlight';
 import * as _tiptap_extension_text_style from '@tiptap/extension-text-style';
 import * as _tiptap_extension_text_align from '@tiptap/extension-text-align';
 import * as _tiptap_extension_file_handler from '@tiptap/extension-file-handler';
-import * as _tiptap_extension_unique_id from '@tiptap/extension-unique-id';
-import * as _tiptap_extension_details from '@tiptap/extension-details';
 import * as _tiptap_core from '@tiptap/core';
 import { Node } from '@tiptap/core';
+import * as _tiptap_extension_details from '@tiptap/extension-details';
+import * as _tiptap_extension_unique_id from '@tiptap/extension-unique-id';
 import * as _tiptap_extension_list from '@tiptap/extension-list';
 import * as _tiptap_extension_link from '@tiptap/extension-link';
 
@@ -24,6 +24,22 @@ interface UploadPlaceholderOptions {
  */
 declare const UploadPlaceholder: Node<UploadPlaceholderOptions, any>;
 
+interface ImageNodeOptions {
+    upload: ((file: File) => Promise<{
+        id: string;
+        src: string;
+        title: string;
+    }>) | null;
+    fetch: ((attrs: {
+        id: string;
+    }) => Promise<{
+        src?: string;
+        title?: string;
+    }>) | null;
+}
+/** Image node: TipTap Image plus the `id` of the backing media. */
+declare const ImageNode: _tiptap_core.Node<ImageNodeOptions, any>;
+
 /** Markdown-style `![title](src)` input rule, kept from the previous editor. */
 declare const fileInputRegex: RegExp;
 interface FileNodeOptions {
@@ -80,7 +96,7 @@ interface CommunEditorMedia {
  * The parity extension set. UEditor must ALSO receive `:image="false"` and
  * `:mention="false"`: its defaults collide with our node names.
  */
-declare function communSchemaExtensions(media?: Partial<CommunEditorMedia>): (_tiptap_core.Node<UploadPlaceholderOptions, any> | _tiptap_core.Node<_tiptap_extension_details.DetailsOptions, any> | _tiptap_core.Node<_tiptap_extension_details.DetailsSummaryOptions, any> | _tiptap_core.Node<any, any> | _tiptap_core.Mark<_tiptap_extension_link.LinkOptions, any> | _tiptap_core.Node<_tiptap_extension_list.OrderedListOptions, any> | _tiptap_core.Extension<_tiptap_extension_unique_id.UniqueIDOptions, any> | _tiptap_core.Extension<Omit<_tiptap_extension_file_handler.FileHandlePluginOptions, "key" | "editor">, any> | _tiptap_core.Extension<_tiptap_extension_text_align.TextAlignOptions, any> | _tiptap_core.Mark<_tiptap_extension_text_style.TextStyleOptions, any> | _tiptap_core.Mark<_tiptap_extension_highlight.HighlightOptions, any> | _tiptap_core.Extension<_tiptap_extension_typography.TypographyOptions, any> | _tiptap_core.Node<FileNodeOptions, any>)[];
+declare function communSchemaExtensions(media?: Partial<CommunEditorMedia>): (_tiptap_core.Extension<_tiptap_extension_unique_id.UniqueIDOptions, any> | _tiptap_core.Node<_tiptap_extension_details.DetailsOptions, any> | _tiptap_core.Node<_tiptap_extension_details.DetailsSummaryOptions, any> | _tiptap_core.Node<ImageNodeOptions, any> | _tiptap_core.Node<UploadPlaceholderOptions, any> | _tiptap_core.Mark<_tiptap_extension_link.LinkOptions, any> | _tiptap_core.Node<_tiptap_extension_list.OrderedListOptions, any> | _tiptap_core.Extension<Omit<_tiptap_extension_file_handler.FileHandlePluginOptions, "key" | "editor">, any> | _tiptap_core.Extension<_tiptap_extension_text_align.TextAlignOptions, any> | _tiptap_core.Mark<_tiptap_extension_text_style.TextStyleOptions, any> | _tiptap_core.Mark<_tiptap_extension_highlight.HighlightOptions, any> | _tiptap_core.Extension<_tiptap_extension_typography.TypographyOptions, any> | _tiptap_core.Node<any, any>)[];
 
 /**
  * Stable block ids matching stored content: attribute `uid`, UUID v4.
@@ -97,22 +113,6 @@ declare const Uid: _tiptap_core.Extension<_tiptap_extension_unique_id.UniqueIDOp
  */
 declare const Callout: Node<any, any>;
 
-interface ImageNodeOptions {
-    upload: ((file: File) => Promise<{
-        id: string;
-        src: string;
-        title: string;
-    }>) | null;
-    fetch: ((attrs: {
-        id: string;
-    }) => Promise<{
-        src?: string;
-        title?: string;
-    }>) | null;
-}
-/** Image node: TipTap Image plus the `id` of the backing media. */
-declare const ImageNode: _tiptap_core.Node<ImageNodeOptions, any>;
-
 /**
  * External-service iframe. Attrs mirror stored content exactly: embeds carry
  * no uid and `frameborder` is a string.

package/dist/index.d.ts

@@ -3,10 +3,10 @@ import * as _tiptap_extension_highlight from '@tiptap/extension-highlight';
 import * as _tiptap_extension_text_style from '@tiptap/extension-text-style';
 import * as _tiptap_extension_text_align from '@tiptap/extension-text-align';
 import * as _tiptap_extension_file_handler from '@tiptap/extension-file-handler';
-import * as _tiptap_extension_unique_id from '@tiptap/extension-unique-id';
-import * as _tiptap_extension_details from '@tiptap/extension-details';
 import * as _tiptap_core from '@tiptap/core';
 import { Node } from '@tiptap/core';
+import * as _tiptap_extension_details from '@tiptap/extension-details';
+import * as _tiptap_extension_unique_id from '@tiptap/extension-unique-id';
 import * as _tiptap_extension_list from '@tiptap/extension-list';
 import * as _tiptap_extension_link from '@tiptap/extension-link';
 
@@ -24,6 +24,22 @@ interface UploadPlaceholderOptions {
  */
 declare const UploadPlaceholder: Node<UploadPlaceholderOptions, any>;
 
+interface ImageNodeOptions {
+    upload: ((file: File) => Promise<{
+        id: string;
+        src: string;
+        title: string;
+    }>) | null;
+    fetch: ((attrs: {
+        id: string;
+    }) => Promise<{
+        src?: string;
+        title?: string;
+    }>) | null;
+}
+/** Image node: TipTap Image plus the `id` of the backing media. */
+declare const ImageNode: _tiptap_core.Node<ImageNodeOptions, any>;
+
 /** Markdown-style `![title](src)` input rule, kept from the previous editor. */
 declare const fileInputRegex: RegExp;
 interface FileNodeOptions {
@@ -80,7 +96,7 @@ interface CommunEditorMedia {
  * The parity extension set. UEditor must ALSO receive `:image="false"` and
  * `:mention="false"`: its defaults collide with our node names.
  */
-declare function communSchemaExtensions(media?: Partial<CommunEditorMedia>): (_tiptap_core.Node<UploadPlaceholderOptions, any> | _tiptap_core.Node<_tiptap_extension_details.DetailsOptions, any> | _tiptap_core.Node<_tiptap_extension_details.DetailsSummaryOptions, any> | _tiptap_core.Node<any, any> | _tiptap_core.Mark<_tiptap_extension_link.LinkOptions, any> | _tiptap_core.Node<_tiptap_extension_list.OrderedListOptions, any> | _tiptap_core.Extension<_tiptap_extension_unique_id.UniqueIDOptions, any> | _tiptap_core.Extension<Omit<_tiptap_extension_file_handler.FileHandlePluginOptions, "key" | "editor">, any> | _tiptap_core.Extension<_tiptap_extension_text_align.TextAlignOptions, any> | _tiptap_core.Mark<_tiptap_extension_text_style.TextStyleOptions, any> | _tiptap_core.Mark<_tiptap_extension_highlight.HighlightOptions, any> | _tiptap_core.Extension<_tiptap_extension_typography.TypographyOptions, any> | _tiptap_core.Node<FileNodeOptions, any>)[];
+declare function communSchemaExtensions(media?: Partial<CommunEditorMedia>): (_tiptap_core.Extension<_tiptap_extension_unique_id.UniqueIDOptions, any> | _tiptap_core.Node<_tiptap_extension_details.DetailsOptions, any> | _tiptap_core.Node<_tiptap_extension_details.DetailsSummaryOptions, any> | _tiptap_core.Node<ImageNodeOptions, any> | _tiptap_core.Node<UploadPlaceholderOptions, any> | _tiptap_core.Mark<_tiptap_extension_link.LinkOptions, any> | _tiptap_core.Node<_tiptap_extension_list.OrderedListOptions, any> | _tiptap_core.Extension<Omit<_tiptap_extension_file_handler.FileHandlePluginOptions, "key" | "editor">, any> | _tiptap_core.Extension<_tiptap_extension_text_align.TextAlignOptions, any> | _tiptap_core.Mark<_tiptap_extension_text_style.TextStyleOptions, any> | _tiptap_core.Mark<_tiptap_extension_highlight.HighlightOptions, any> | _tiptap_core.Extension<_tiptap_extension_typography.TypographyOptions, any> | _tiptap_core.Node<any, any>)[];
 
 /**
  * Stable block ids matching stored content: attribute `uid`, UUID v4.
@@ -97,22 +113,6 @@ declare const Uid: _tiptap_core.Extension<_tiptap_extension_unique_id.UniqueIDOp
  */
 declare const Callout: Node<any, any>;
 
-interface ImageNodeOptions {
-    upload: ((file: File) => Promise<{
-        id: string;
-        src: string;
-        title: string;
-    }>) | null;
-    fetch: ((attrs: {
-        id: string;
-    }) => Promise<{
-        src?: string;
-        title?: string;
-    }>) | null;
-}
-/** Image node: TipTap Image plus the `id` of the backing media. */
-declare const ImageNode: _tiptap_core.Node<ImageNodeOptions, any>;
-
 /**
  * External-service iframe. Attrs mirror stored content exactly: embeds carry
  * no uid and `frameborder` is a string.

package/package.json

@@ -36,7 +36,7 @@
   },
   "description": "The rich-text editor: document schema, extensions and their sanitisation.",
   "license": "AGPL-3.0-or-later",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "sideEffects": false,
   "files": [
     "dist"