feat(json-crdt-extensions): 🎸 improve slice type def types

Author: streamich

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

@@ -1,4 +1,5 @@
 import {PeritextMlElement} from '../block/types';
+import {NodeBuilder} from '../../../json-crdt-patch';
 import type {JsonMlNode} from 'very-small-parser/lib/html/json-ml/types';
 import type {FromHtmlConverter, SliceTypeDefinition, ToHtmlConverter} from './types';
 
@@ -7,7 +8,7 @@ export class SliceRegistry {
   private toHtmlMap: Map<string | number, ToHtmlConverter> = new Map();
   private fromHtmlMap: Map<string, FromHtmlConverter[]> = new Map();
 
-  public add(def: SliceTypeDefinition<PeritextMlElement<any, any, any>>): this {
+  public add<Type extends number | string, Schema extends NodeBuilder>(def: SliceTypeDefinition<Type, Schema>): void {
     const {type, toHtml, fromHtml} = def;
     this.map.set(type, def);
     if (toHtml) this.toHtmlMap.set(type, toHtml);
@@ -18,7 +19,6 @@ export class SliceRegistry {
         converters.push(converter);
         this.fromHtmlMap.set(htmlTag, converters);
       }
-    return this;
   }
 
   public toHtml(el: PeritextMlElement): JsonMlNode | undefined {

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

@@ -1,7 +1,8 @@
+import {s} from "../../../json-crdt-patch";
+import {JsonNodeView} from "../../../json-crdt/nodes";
 import {PeritextMlElement} from "../block/types";
 import {CommonSliceType} from "../slice";
 import {SliceRegistry} from "./SliceRegistry";
-import {SliceTypeDefinition} from "./types";
 
 /**
  * Default annotation type registry.
@@ -10,5 +11,11 @@ export const registry = new SliceRegistry();
 
 registry.add({
   type: CommonSliceType.a,
-  toHtml: (element: PeritextMlElement<CommonSliceType.a, {}, true>) => ['a', element[1], element[2]],
-} as SliceTypeDefinition<PeritextMlElement<CommonSliceType.a, {href?: string, title?: string}, true>>);
+  schema: s.obj({
+    href: s.str(''),
+    title: s.str(''),
+  }),
+  toHtml: (el) => {
+    throw new Error('Not implemented');
+  },
+});

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

@@ -1,16 +1,20 @@
+import type {NodeBuilder} from '../../../json-crdt-patch';
+import type {JsonNodeView} from '../../../json-crdt/nodes';
+import {SchemaToJsonNode} from '../../../json-crdt/schema/types';
 import type {PeritextMlElement} from '../block/types';
 import type {JsonMlNode} from 'very-small-parser/lib/html/json-ml/types';
 
-export interface SliceTypeDefinition<El extends PeritextMlElement<any, any, any> = PeritextMlElement> {
-  type: El[0];
-  toHtml?: ToHtmlConverter<El>;
+export interface SliceTypeDefinition<Type extends number | string, Schema extends NodeBuilder> {
+  type: Type;
+  schema: Schema;
+  toHtml?: ToHtmlConverter<PeritextMlElement<Type, JsonNodeView<SchemaToJsonNode<Schema>>, true>>;
   fromHtml?: {
-    [htmlTag: string]: FromHtmlConverter<El>;
+    [htmlTag: string]: FromHtmlConverter<PeritextMlElement<Type, JsonNodeView<SchemaToJsonNode<Schema>>, true>>;
   };
 }
 
-export type ToHtmlConverter<El extends PeritextMlElement<any, any, any> = PeritextMlElement> =
+export type ToHtmlConverter<El extends PeritextMlElement<any, any, any>> =
   (element: El) => JsonMlNode;
 
-export type FromHtmlConverter<El extends PeritextMlElement<any, any, any> = PeritextMlElement> =
+export type FromHtmlConverter<El extends PeritextMlElement<any, any, any>> =
   (jsonml: JsonMlNode) => El | undefined;

src/json-crdt-patch/builder/schema.ts

@@ -132,6 +132,30 @@ export namespace nodes {
    *   age: s.con(0),
    * });
    * ```
+   * 
+   * Specify optional keys as the second argument:
+   * 
+   * ```ts
+   * s.obj(
+   *   {
+   *     href: s.str('https://example.com'),
+   *   },
+   *   {
+   *     title: s.str(''),
+   *   },
+   * )
+   * ```
+   * 
+   * Or, specify only the type, using the `optional` method:
+   * 
+   * ```ts
+   * s.obj({
+   *   href: s.str('https://example.com'),
+   * })
+   *  .optional<nodes.obj({
+   *     title: nodes.str,
+   *   })>()
+   * ```
    */
   export class obj<
     T extends Record<string, NodeBuilder>,