Remove legacy schema option and support type argument (#208)

Author: inokawa

src/doc/edit.ts

@@ -1,11 +1,12 @@
 import { is, isString, keys } from "../utils.js";
 import { compareLine, comparePosition } from "./position.js";
 import type {
-  Doc,
+  DocBase,
   Fragment,
   DocNode,
   Position,
   SelectionSnapshot,
+  TextNode,
 } from "./types.js";
 import { docToString, stringToFragment } from "./utils.js";
 
@@ -99,14 +100,14 @@ export class Transaction {
 /**
  * @internal
  */
-export const isDocEqual = (docA: Doc, docB: Doc): boolean =>
+export const isDocEqual = (docA: DocBase, docB: DocBase): boolean =>
   // TODO improve
   docA.length === docB.length && docA.every((l, i) => l === docB[i]);
 
 /**
  * @internal
  */
-export const isTextNode = (node: DocNode) => "text" in node;
+export const isTextNode = (node: DocNode): node is TextNode => "text" in node;
 
 const isSameNode = (a: DocNode, b: DocNode): boolean => {
   const aKeys = keys(a);
@@ -128,7 +129,7 @@ const getNodeSize = (node: DocNode): number =>
  * @internal
  */
 export const getLineSize = (line: readonly DocNode[]): number =>
-  line.reduce((acc, n) => acc + getNodeSize(n), 0);
+  line.reduce((acc: number, n) => acc + getNodeSize(n), 0);
 
 const normalize = <T extends DocNode>(
   array: T[],
@@ -202,12 +203,12 @@ const split = <T extends DocNode>(
   return [nodes, []];
 };
 
-const replaceRange = (
-  doc: Doc,
+const replaceRange = <T extends DocBase>(
+  doc: T,
   inserted: Fragment | string,
   start: Position,
   end?: Position,
-): Doc => {
+): T => {
   const [startLine] = start;
   const [endLine] = end || start;
 
@@ -217,10 +218,14 @@ const replaceRange = (
   if (isString(inserted)) {
     // inherit style from previous text node
     const beforeLength = before.length;
-    inserted = stringToFragment(
-      inserted,
-      beforeLength ? before[beforeLength - 1]! : undefined,
-    );
+    let anchorNode: TextNode | undefined;
+    if (beforeLength) {
+      const maybeAnchor = before[beforeLength - 1]!;
+      if (isTextNode(maybeAnchor)) {
+        anchorNode = maybeAnchor;
+      }
+    }
+    inserted = stringToFragment(inserted, anchorNode);
   }
 
   let lines: (readonly DocNode[])[];
@@ -234,14 +239,14 @@ const replaceRange = (
 
   const newDoc = doc.slice();
   newDoc.splice(startLine, endLine - startLine + 1, ...lines);
-  return newDoc;
+  return newDoc as DocBase as T; // TODO improve
 };
 
 /**
  * @internal
  */
 export const sliceDoc = (
-  doc: Doc,
+  doc: DocBase,
   start: Position,
   end: Position,
 ): Fragment => {
@@ -255,7 +260,7 @@ export const sliceDoc = (
   ];
 };
 
-const isValidPosition = (doc: Doc, [line, offset]: Position): boolean => {
+const isValidPosition = (doc: DocBase, [line, offset]: Position): boolean => {
   if (line >= 0 && line < doc.length) {
     if (offset >= 0 && offset <= getLineSize(doc[line]!)) {
       return true;
@@ -264,7 +269,7 @@ const isValidPosition = (doc: Doc, [line, offset]: Position): boolean => {
   return false;
 };
 
-const isValidOperation = (doc: Doc, op: Operation): boolean => {
+const isValidOperation = (doc: DocBase, op: Operation): boolean => {
   switch (op._type) {
     case TYPE_DELETE: {
       const { _start: start, _end: end } = op;
@@ -350,12 +355,12 @@ const rebasePosition = (position: Position, op: EditOperation): Position => {
 /**
  * @internal
  */
-export const applyTransaction = (
-  doc: Doc,
+export const applyTransaction = <T extends DocBase>(
+  doc: T,
   selection: SelectionSnapshot,
   tr: Transaction,
   onError?: (message: string) => void,
-): [Doc, SelectionSnapshot] | undefined => {
+): [T, SelectionSnapshot] | undefined => {
   try {
     for (const op of tr.ops) {
       if (isValidOperation(doc, op)) {

src/doc/types.ts

@@ -1,13 +1,16 @@
-export type TextNode = Readonly<{
-  text: string;
-}>;
-export type VoidNode = Readonly<{
-  data: Record<string, unknown>;
-}>;
+export interface TextNode {
+  readonly text: string;
+}
+
+export interface VoidNode {}
+
 export type DocNode = TextNode | VoidNode;
-export type Doc = readonly (readonly DocNode[])[];
+
+export type DocBase = readonly (readonly DocNode[])[];
 export type Fragment = readonly (readonly DocNode[])[];
 
+export type InferNode<T extends DocBase> = T[number][number];
+
 export type Position = readonly [line: number, offset: number];
 export type PositionRange = readonly [start: Position, end: Position];
 

src/doc/utils.ts

@@ -1,11 +1,16 @@
 import { isTextNode } from "./edit.js";
-import { type Doc, type DocNode, type Fragment } from "./types.js";
+import {
+  type DocBase,
+  type DocNode,
+  type Fragment,
+  type TextNode,
+} from "./types.js";
 
 /**
  * @internal
  */
 export const docToString = (
-  doc: Doc,
+  doc: DocBase,
   serializer: (node: DocNode) => string = (n) => (isTextNode(n) ? n.text : ""),
 ): string => {
   return doc.reduce((acc, r, i) => {
@@ -19,9 +24,6 @@ export const docToString = (
 /**
  * @internal
  */
-export const stringToFragment = (
-  text: string,
-  attrs?: Record<string, any>,
-): Fragment => {
-  return text.split("\n").map((l) => (l ? [{ ...attrs, text: l }] : []));
+export const stringToFragment = (text: string, node?: TextNode): Fragment => {
+  return text.split("\n").map((l) => (l ? [{ ...node, text: l }] : []));
 };

src/editor.ts

@@ -9,7 +9,7 @@ import {
   serializeRange,
 } from "./dom/index.js";
 import { createMutationObserver } from "./mutation.js";
-import type { Doc, Fragment, SelectionSnapshot } from "./doc/types.js";
+import type { DocBase, Fragment, SelectionSnapshot } from "./doc/types.js";
 import { isString, microtask } from "./utils.js";
 import type { EditorCommand } from "./commands.js";
 import {
@@ -19,7 +19,6 @@ import {
   isDocEqual,
 } from "./doc/edit.js";
 import { singlelinePlugin } from "./plugins/singleline.js";
-import type { DocSchema } from "./schema/index.js";
 import type { ParserConfig } from "./dom/parser.js";
 import { comparePosition, toRange } from "./doc/position.js";
 import type { PluginObject } from "./plugins/types.js";
@@ -95,15 +94,15 @@ type KeydownCallback = (keyboard: KeyboardPayload) => boolean | void;
 /**
  * Options of {@link createEditor}.
  */
-export interface EditorOptions<T> {
-  /**
-   * TODO
-   */
-  schema: DocSchema<T>;
+export interface EditorOptions<T extends DocBase> {
   /**
    * Initial document state.
    */
   doc: T;
+  /**
+   * TODO
+   */
+  singleline?: boolean;
   /**
    * Functions to handle copy events
    * @default [plainCopy()]
@@ -140,7 +139,7 @@ export interface EditorOptions<T> {
  * Methods of editor instance.
  */
 export interface Editor {
-  readonly doc: Doc;
+  readonly doc: DocBase;
   readonly selection: SelectionSnapshot;
   /**
    * The getter/setter for the editor's read-only state.
@@ -164,9 +163,9 @@ export interface Editor {
 /**
  * A function to initialize editor.
  */
-export const createEditor = <T>({
-  schema: { single: isSingleline, js: docToJS, doc: jsToDoc },
+export const createEditor = <T extends DocBase>({
   doc: initialDoc,
+  singleline: isSingleline,
   copy: copyExtensions = [plainCopy()],
   paste: pasteExtensions = [plainPaste()],
   isBlock = defaultIsBlockNode,
@@ -178,11 +177,11 @@ export const createEditor = <T>({
   let readonly = false;
   let setContentEditable: () => void = noop;
 
-  const doc = (): Doc => history.get()[0];
+  const doc = (): T => history.get()[0];
 
   const history = createHistory<
-    readonly [doc: Doc, selection: SelectionSnapshot]
-  >([jsToDoc(initialDoc), selection]);
+    readonly [doc: T, selection: SelectionSnapshot]
+  >([initialDoc, selection]);
 
   const plugins: PluginObject[] = [];
   if (isSingleline) {
@@ -196,7 +195,7 @@ export const createEditor = <T>({
           const nextHistory = e.shiftKey ? history.redo() : history.undo();
 
           if (nextHistory) {
-            onChange(docToJS(nextHistory[0]));
+            onChange(nextHistory[0]);
             selection = nextHistory[1];
           }
           return true;
@@ -209,13 +208,17 @@ export const createEditor = <T>({
     keydownHandlers.push(onKeyDownHandler);
   }
 
-  const applyTransaction = plugins.reduceRight(
+  const applyTransaction = plugins.reduceRight<
+    (
+      doc: T,
+      sel: SelectionSnapshot,
+      tr: Transaction,
+    ) => ReturnType<typeof _applyTransaction>
+  >(
     (acc, { apply: fn }) => {
       return fn ? (doc, sel, tr) => fn((tr) => acc(doc, sel, tr), tr) : acc;
     },
-    (doc: Doc, sel: SelectionSnapshot, tr: Transaction) => {
-      return _applyTransaction(doc, sel, tr, onError);
-    },
+    (doc, sel, tr) => _applyTransaction(doc, sel, tr, onError),
   );
 
   const transactions: Transaction[] = [];
@@ -241,14 +244,14 @@ export const createEditor = <T>({
 
   const commit = () => {
     if (transactions.length) {
-      let nextDoc: Doc = doc();
+      let nextDoc: T = doc();
       let nextSelection: SelectionSnapshot = selection;
 
       let tr: Transaction | undefined;
       while ((tr = transactions.pop())) {
         const res = applyTransaction(nextDoc, nextSelection, tr);
         if (res) {
-          nextDoc = res[0];
+          nextDoc = res[0] as T; // TODO improve
           nextSelection = res[1];
         }
       }
@@ -258,7 +261,7 @@ export const createEditor = <T>({
       if (!isDocEqual(nextDoc, currentDoc)) {
         history.set([currentDoc, selection]);
         history.push([nextDoc, nextSelection]);
-        onChange(docToJS(nextDoc));
+        onChange(nextDoc);
       }
 
       selection = nextSelection;

src/extensions/copy/plain.ts

@@ -1,11 +1,9 @@
-import type { DocNode } from "../../doc/types.js";
+import type { DocBase, DocNode, InferNode } from "../../doc/types.js";
 import { docToString } from "../../doc/utils.js";
 import type { CopyExtension } from "./types.js";
 
-export const plainCopy = <T extends DocNode>(
-  serializer?: (
-    node: Extract<T, { data: any }> | { text: string } /* TODO */,
-  ) => string,
+export const plainCopy = <T extends DocBase>(
+  serializer?: (node: InferNode<T>) => string,
 ): CopyExtension => {
   return (dataTransfer, data) => {
     dataTransfer.setData(

src/extensions/paste/html.ts

@@ -1,11 +1,13 @@
-import type { DocNode, TextNode } from "../../doc/types.js";
+import type { DocBase, InferNode, TextNode } from "../../doc/types.js";
 import { readDom } from "../../dom/index.js";
 import { isCommentNode } from "../../dom/parser.js";
 import type { PasteExtension } from "./types.js";
 
-export const htmlPaste = <T extends DocNode>(
-  serializeText: (t: string) => Extract<T, TextNode>,
-  serializers: ((node: HTMLElement) => Exclude<T, TextNode> | void)[] = [],
+export const htmlPaste = <T extends DocBase>(
+  serializeText: (t: string) => Extract<InferNode<T>, TextNode>,
+  serializers: ((
+    node: HTMLElement,
+  ) => Exclude<InferNode<T>, TextNode> | void)[] = [],
 ): PasteExtension => {
   return (dataTransfer, config) => {
     const html = dataTransfer.getData("text/html");

src/index.ts

@@ -1,6 +1,5 @@
 export type { EditorCommand } from "./commands.js";
 export { Delete, InsertText, ReplaceAll } from "./commands.js";
 export * from "./editor.js";
-export * from "./schema/index.js";
 export * from "./extensions/index.js";
 export * from "./presets/index.js";

src/plugins/types.ts

@@ -1,14 +1,14 @@
 import { Transaction } from "../doc/edit.js";
-import type { Doc, SelectionSnapshot } from "../doc/types.js";
+import type { DocBase, SelectionSnapshot } from "../doc/types.js";
 
 /**
  * @internal
  */
 export interface PluginObject {
   apply?: (
-    next: (tr: Transaction) => [Doc, SelectionSnapshot] | undefined,
+    next: (tr: Transaction) => [DocBase, SelectionSnapshot] | undefined,
     tr: Transaction,
-  ) => [Doc, SelectionSnapshot] | undefined;
+  ) => [DocBase, SelectionSnapshot] | undefined;
   mount?: (element: HTMLElement) => void;
 }