feat(json-crdt-extensions): 🎸 update inline registry entries

Author: streamich

src/json-crdt-extensions/peritext/registry/SliceRegistry.ts

@@ -3,7 +3,7 @@ import {CommonSliceType} from '../slice';
 import type {PeritextMlElement} from '../block/types';
 import type {NodeBuilder} from '../../../json-crdt-patch';
 import type {JsonMlElement} from 'very-small-parser/lib/html/json-ml/types';
-import type {FromHtmlConverter, SliceTypeDefinition, ToHtmlConverter} from './types';
+import type {FromHtmlConverter, ToHtmlConverter} from './types';
 import type {JsonNodeView} from '../../../json-crdt/nodes';
 import type {SchemaToJsonNode} from '../../../json-crdt/schema/types';
 
@@ -88,7 +88,7 @@ export class SliceRegistry {
   private _fromHtml: Map<string, [entry: SliceRegistryEntry, converter: FromHtmlConverter][]> =
     new Map();
 
-  public add(entry: SliceRegistryEntry): void {
+  public add(entry: SliceRegistryEntry<any, any, any>): void {
     const {tag, fromHtml} = entry;
     const _fromHtml = this._fromHtml;
     if (fromHtml) {
@@ -113,12 +113,12 @@ export class SliceRegistry {
     const tag = el[0] + '';
     const converters = this._fromHtml.get(tag);
     if (converters) {
-      for (const [def, converter] of converters) {
+      for (const [entry, converter] of converters) {
         const result = converter(el);
         if (result) {
           const attr = result[1] ?? (result[1] = {});
-          attr.inline = def.inline ?? def.type < 0;
-          attr.behavior = !attr.inline ? SliceBehavior.Marker : (def.behavior ?? SliceBehavior.Many);
+          attr.inline = entry.isInline();
+          attr.behavior = !attr.inline ? SliceBehavior.Marker : (entry.behavior ?? SliceBehavior.Many);
           return result;
         }
       }

src/json-crdt-extensions/peritext/registry/registry.ts

@@ -1,66 +1,80 @@
 import {s} from '../../../json-crdt-patch';
+import {SliceBehavior, SliceTypeCon} from '../slice/constants';
+import {SliceRegistry, SliceRegistryEntry, TagType} from './SliceRegistry';
 import type {JsonNodeView} from '../../../json-crdt/nodes';
 import type {SchemaToJsonNode} from '../../../json-crdt/schema/types';
-import {CommonSliceType} from '../slice';
-import {SliceBehavior} from '../slice/constants';
-import {SliceRegistry} from './SliceRegistry';
-
-const undefSchema = s.con(undefined);
 
 /**
  * Default annotation type registry.
- */
+*/
 export const registry = new SliceRegistry();
 
-registry.def(CommonSliceType.i, undefSchema, SliceBehavior.One, true, {
-  fromHtml: {
-    i: () => [CommonSliceType.i, null],
-    em: () => [CommonSliceType.i, null],
-  },
-});
+const undefSchema = s.con(undefined);
 
-registry.def(CommonSliceType.b, undefSchema, SliceBehavior.One, true, {
-  fromHtml: {
-    b: () => [CommonSliceType.b, null],
-    strong: () => [CommonSliceType.b, null],
-  },
-});
+// ----------------------------------------- Inline elements with "One" behavior
 
-registry.def(CommonSliceType.s, undefSchema, SliceBehavior.One, true, {
-  fromHtml: {
-    s: () => [CommonSliceType.s, null],
-    strike: () => [CommonSliceType.s, null],
-  },
-});
+const inlineOne = <Tag extends TagType = TagType>(
+  tag: Tag,
+  fromHtml?: SliceRegistryEntry<SliceBehavior.One, Tag, typeof undefSchema>['fromHtml'],
+): void => {
+  registry.add(
+    new SliceRegistryEntry(
+      SliceBehavior.One,
+      tag,
+      undefSchema,
+      false,
+      void 0,
+      fromHtml,
+    )
+  );
+};
+
+const inlineOne2 = <Tag extends TagType = TagType>(tag: Tag, htmlTags: string[]): void => {
+  const fromHtml = {} as Record<any, any>;
+  for (const htmlTag of htmlTags) fromHtml[htmlTag] = () => [tag, null];
+  inlineOne(tag, fromHtml);
+};
+
+inlineOne2(SliceTypeCon.i, ['i', 'em']);
+inlineOne2(SliceTypeCon.b, ['b', 'strong']);
+inlineOne2(SliceTypeCon.s, ['s', 'strike']);
+inlineOne(SliceTypeCon.u);
+inlineOne(SliceTypeCon.code);
+inlineOne(SliceTypeCon.mark);
+inlineOne(SliceTypeCon.kbd);
+inlineOne(SliceTypeCon.del);
+inlineOne(SliceTypeCon.ins);
+inlineOne(SliceTypeCon.sup);
+inlineOne(SliceTypeCon.sub);
+inlineOne(SliceTypeCon.math);
 
-registry.def(CommonSliceType.u, undefSchema, SliceBehavior.One, true);
-registry.def(CommonSliceType.code, undefSchema, SliceBehavior.One, true);
-registry.def(CommonSliceType.mark, undefSchema, SliceBehavior.One, true);
-registry.def(CommonSliceType.kbd, undefSchema, SliceBehavior.One, true);
-registry.def(CommonSliceType.del, undefSchema, SliceBehavior.One, true);
-registry.def(CommonSliceType.ins, undefSchema, SliceBehavior.One, true);
-registry.def(CommonSliceType.sup, undefSchema, SliceBehavior.One, true);
-registry.def(CommonSliceType.sub, undefSchema, SliceBehavior.One, true);
-registry.def(CommonSliceType.math, undefSchema, SliceBehavior.One, true);
+// ---------------------------------------- Inline elements with "Many" behavior
 
 const aSchema = s.obj({
   href: s.str<string>(''),
   title: s.str<string>(''),
 });
-registry.def(CommonSliceType.a, aSchema, SliceBehavior.Many, true, {
-  fromHtml: {
-    a: (jsonml) => {
-      const attr = jsonml[1] || {};
-      const data: JsonNodeView<SchemaToJsonNode<typeof aSchema>> = {
-        href: attr.href ?? '',
-        title: attr.title ?? '',
-      };
-      return [CommonSliceType.a, {data, inline: true}];
+registry.add(
+  new SliceRegistryEntry(
+    SliceBehavior.Many,
+    SliceTypeCon.a,
+    aSchema,
+    false,
+    void 0,
+    {
+      a: (jsonml) => {
+        const attr = jsonml[1] || {};
+        const data: JsonNodeView<SchemaToJsonNode<typeof aSchema>> = {
+          href: attr.href ?? '',
+          title: attr.title ?? '',
+        };
+        return [SliceTypeCon.a, {data, inline: true}];
+      },
     },
-  },
-});
+  )
+);
 
-// TODO: add more default annotations
+// TODO: add more default annotations with "Many" behavior
 // comment = SliceTypeCon.comment,
 // font = SliceTypeCon.font,
 // col = SliceTypeCon.col,
@@ -72,4 +86,6 @@ registry.def(CommonSliceType.a, aSchema, SliceBehavior.Many, true, {
 // iembed = SliceTypeCon.iembed,
 // bookmark = SliceTypeCon.bookmark,
 
-registry.def(CommonSliceType.blockquote, undefSchema, SliceBehavior.Marker, false);
+// --------------------------------------- Block elements with "Marker" behavior
+
+// registry.def(CommonSliceType.blockquote, undefSchema, SliceBehavior.Marker, false);

src/json-crdt-extensions/peritext/registry/types.ts

@@ -1,33 +1,5 @@
-import type {NodeBuilder} from '../../../json-crdt-patch';
-import type {JsonNodeView} from '../../../json-crdt/nodes';
-import type {SchemaToJsonNode} from '../../../json-crdt/schema/types';
 import type {PeritextMlElement} from '../block/types';
 import type {JsonMlElement} from 'very-small-parser/lib/html/json-ml/types';
-import type {SliceBehavior} from '../slice/constants';
-
-export interface SliceTypeDefinition<
-  Type extends number | string = number | string,
-  Schema extends NodeBuilder = NodeBuilder,
-  Inline extends boolean = true,
-> {
-  type: Type;
-  schema: Schema;
-  behavior?: SliceBehavior;
-  inline?: boolean;
-
-  /**
-   * For block element slices (block splits), the `container` property specifies
-   * whether the type is a container for other block elements. For example, a
-   * `blockquote` is a container for `paragraph` elements, however, a `paragraph`
-   * is not a container (it can only contain inline elements).
-   */
-  container?: boolean;
-
-  toHtml?: ToHtmlConverter<PeritextMlElement<Type, JsonNodeView<SchemaToJsonNode<Schema>>, Inline>>;
-  fromHtml?: {
-    [htmlTag: string]: FromHtmlConverter<PeritextMlElement<Type, JsonNodeView<SchemaToJsonNode<Schema>>, Inline>>;
-  };
-}
 
 export type ToHtmlConverter<
   El extends PeritextMlElement<any, any, any> = PeritextMlElement<string | number, unknown, boolean>,