feat(json-crdt-extensions): 🎸 harden registry usage, make it required

Author: streamich

src/json-crdt-extensions/peritext/registry/registry.ts renamed to src/json-crdt-extensions/peritext/registry/registerCommon.ts

@@ -1,24 +1,24 @@
 import {s} from '../../../json-crdt-patch';
 import {SliceBehavior, SliceTypeCon as TAG} from '../slice/constants';
-import {SliceRegistry, SliceRegistryEntry, type TagType} from './SliceRegistry';
+import {SliceRegistry, type TypeTag} from './SliceRegistry';
+import {SliceRegistryEntry} from './SliceRegistryEntry';
 import type {JsonNodeView} from '../../../json-crdt/nodes';
 import type {SchemaToJsonNode} from '../../../json-crdt/schema/types';
 import type {PeritextMlElement} from '../block/types';
 
-export const createRegistry = () => {
-  const registry = new SliceRegistry();
-  const undefSchema = s.con(undefined);
+const undefSchema = s.con(undefined);
 
+export const registerCommon = (registry: SliceRegistry) => {
   // --------------------------------------- Inline elements with "One" behavior
 
-  const i0 = <Tag extends TagType = TagType>(
+  const i0 = <Tag extends TypeTag = TypeTag>(
     tag: Tag,
     fromHtml?: SliceRegistryEntry<SliceBehavior.One, Tag, typeof undefSchema>['fromHtml'],
   ): void => {
     registry.add(new SliceRegistryEntry(SliceBehavior.One, tag, undefSchema, false, void 0, fromHtml));
   };
 
-  const i1 = <Tag extends TagType = TagType>(tag: Tag, htmlTags: string[]): void => {
+  const i1 = <Tag extends TypeTag = TypeTag>(tag: Tag, htmlTags: string[]): void => {
     const fromHtml = {} as Record<any, any>;
     for (const htmlTag of htmlTags) fromHtml[htmlTag] = () => [tag, null];
     i0(tag, fromHtml);
@@ -78,7 +78,7 @@ export const createRegistry = () => {
     },
   );
 
-  const b0 = <Tag extends TagType = TagType>(tag: Tag, container: boolean) => {
+  const b0 = <Tag extends TypeTag = TypeTag>(tag: Tag, container: boolean) => {
     registry.add(new SliceRegistryEntry(SliceBehavior.Marker, tag, commonBlockSchema, container));
   };
 
@@ -114,11 +114,4 @@ export const createRegistry = () => {
   // b0(TAG.collapse, true);
   // b0(TAG.note, true);
   // b0(TAG.mathblock, false);
-
-  return registry;
 };
-
-/**
- * Default annotation type registry.
- */
-export const registry = createRegistry();

src/json-crdt-extensions/peritext/transfer/PeritextDataTransfer.ts

@@ -1,4 +1,3 @@
-import {registry as defaultRegistry} from '../registry/registry';
 import type {Range} from '../rga/Range';
 import type {ViewRange} from '../editor/types';
 import type {SliceRegistry} from '../registry/SliceRegistry';
@@ -15,7 +14,7 @@ export type PeritextDataTransferMarkdownExportTools = typeof import('./export-ma
 export type PeritextDataTransferMarkdownImportTools = typeof import('./import-markdown');
 
 export interface PeritextDataTransferOpts {
-  registry?: SliceRegistry;
+  registry: SliceRegistry;
   htmlExport?: PeritextDataTransferHtmlExportTools;
   htmlImport?: PeritextDataTransferHtmlImportTools;
   mdExport?: PeritextDataTransferMarkdownExportTools;
@@ -41,7 +40,7 @@ export interface ClipboardImport {
 export class PeritextDataTransfer<T = string> {
   constructor(
     public readonly txt: Peritext<T>,
-    public readonly opts: PeritextDataTransferOpts = {},
+    public readonly opts: PeritextDataTransferOpts,
   ) {}
 
   // ------------------------------------------------------------------ exports
@@ -132,7 +131,7 @@ export class PeritextDataTransfer<T = string> {
   }
 
   private _imp<D>(pos: number, data: D, transform: (data: D, registry: SliceRegistry) => PeritextMlNode): number {
-    const registry = this.opts.registry ?? defaultRegistry;
+    const registry = this.opts.registry;
     const json = transform(data, registry);
     return this.fromJson(pos, json);
   }
@@ -191,7 +190,7 @@ export class PeritextDataTransfer<T = string> {
       return range.start.viewPos();
     };
     if (html) {
-      const [view, style] = this.htmlI().importHtml(html);
+      const [view, style] = this.htmlI().importHtml(html, txt.editor.registry);
       if (style) {
         txt.editor.importStyle(range, style);
         return 0;

src/json-crdt-extensions/peritext/transfer/create.ts

@@ -11,6 +11,7 @@ export const create = (txt: Peritext) => {
     htmlImport,
     mdExport,
     mdImport,
+    registry: txt.editor.registry,
   });
   return transfer;
 };

src/json-crdt-extensions/peritext/transfer/import-html.ts

@@ -1,7 +1,6 @@
 import {html as _html} from 'very-small-parser/lib/html';
 import {fromHast as _fromHast} from 'very-small-parser/lib/html/json-ml/fromHast';
 import {SliceTypeName} from '../slice';
-import {registry as defaultRegistry} from '../registry/registry';
 import {SliceBehavior, SliceHeaderShift} from '../slice/constants';
 import {Anchor} from '../rga/constants';
 import {toPlainText} from 'very-small-parser/lib/toPlainText';
@@ -98,7 +97,7 @@ const BLOCK_TAGS_REWRITE = new Map<string, string>([
 // HTML elements to rewrite as different inline elements.
 const INLINE_TAGS_REWRITE = new Map<string, string>([['span', '']]);
 
-export const fromJsonMl = (jsonml: JsonMlNode, registry: SliceRegistry = defaultRegistry): PeritextMlNode => {
+export const fromJsonMl = (jsonml: JsonMlNode, registry: SliceRegistry): PeritextMlNode => {
   if (typeof jsonml === 'string') return jsonml;
   let tag = jsonml[0];
   let inlineHtmlTag = false;
@@ -143,12 +142,12 @@ export const fromJsonMl = (jsonml: JsonMlNode, registry: SliceRegistry = default
   return node;
 };
 
-export const fromHast = (hast: THtmlToken, registry?: SliceRegistry): PeritextMlNode => {
+export const fromHast = (hast: THtmlToken, registry: SliceRegistry): PeritextMlNode => {
   const jsonml = _fromHast(hast);
   return fromJsonMl(jsonml, registry);
 };
 
-export const fromHtml = (html: string, registry?: SliceRegistry): PeritextMlNode => {
+export const fromHtml = (html: string, registry: SliceRegistry): PeritextMlNode => {
   const hast = _html.parsef(html);
   return fromHast(hast, registry);
 };
@@ -184,11 +183,11 @@ const getExportData = (html: string): [jsonml: undefined | JsonMlNode, exportDat
   return [jsonml];
 };
 
-export const importHtml = (html: string): [view?: ViewRange, style?: ViewStyle[]] => {
+export const importHtml = (html: string, registry: SliceRegistry): [view?: ViewRange, style?: ViewStyle[]] => {
   const [jsonml, data] = getExportData(html);
   if (data?.style) return [void 0, data.style];
   if (data?.view) return [data.view];
-  const node = fromJsonMl(jsonml!);
+  const node = fromJsonMl(jsonml!, registry);
   return [toViewRange(node)];
 };
 

src/json-crdt-extensions/peritext/transfer/import-markdown.ts

@@ -1,19 +1,18 @@
 import {toHast} from 'very-small-parser/lib/markdown/block/toHast';
 import {block} from 'very-small-parser/lib/markdown/block';
 import {fromHast as _fromHast} from 'very-small-parser/lib/html/json-ml/fromHast';
-import {registry as defaultRegistry} from '../registry/registry';
 import {fromHast} from './import-html';
 import type {IRoot} from 'very-small-parser/lib/markdown/block/types';
 import type {PeritextMlNode} from '../block/types';
 import type {SliceRegistry} from '../registry/SliceRegistry';
 
-export const fromMdast = (mdast: IRoot, registry: SliceRegistry = defaultRegistry): PeritextMlNode => {
+export const fromMdast = (mdast: IRoot, registry: SliceRegistry): PeritextMlNode => {
   const hast = toHast(mdast);
   const node = fromHast(hast, registry);
   return node;
 };
 
-export const fromMarkdown = (markdown: string, registry?: SliceRegistry): PeritextMlNode => {
+export const fromMarkdown = (markdown: string, registry: SliceRegistry): PeritextMlNode => {
   const mdast = block.parsef(markdown);
   return fromMdast(mdast, registry);
 };