@thomasfosterau/effect-richtext 0.0.0 → 0.1.0

package/dist/schema-basic.d.ts

@@ -0,0 +1,448 @@
+import { DocSchema } from "./model/schema.js";
+import { Mark } from "./model/mark.js";
+import { Node } from "./model/node.js";
+import { ContentExpr } from "./model/content.js";
+import "./model.js";
+import * as S from "effect/Schema";
+/**
+ * The node specs of the basic schema.
+ *
+ * @since 0.1.0
+ * @category specs
+ */
+export declare const nodes: {
+  /** The top level document node. */
+  doc: {
+    readonly content: ContentExpr<"block">;
+  };
+  /** A plain paragraph textblock. Represented in the DOM as a `<p>` element. */
+  paragraph: {
+    readonly content: ContentExpr<"inline">;
+    readonly group: "block";
+    readonly parseDOM: readonly [{
+      readonly tag: "p";
+    }];
+    readonly toDOM: () => readonly any[] | readonly [string, ...any[]];
+  };
+  /** A blockquote (`<blockquote>`) wrapping one or more blocks. */
+  blockquote: {
+    readonly content: ContentExpr<"block">;
+    readonly group: "block";
+    readonly defining: true;
+    readonly parseDOM: readonly [{
+      readonly tag: "blockquote";
+    }];
+    readonly toDOM: () => readonly any[] | readonly [string, ...any[]];
+  };
+  /** A horizontal rule (`<hr>`). */
+  horizontal_rule: {
+    readonly group: "block";
+    readonly parseDOM: readonly [{
+      readonly tag: "hr";
+    }];
+    readonly toDOM: () => readonly any[] | readonly [string, ...any[]];
+  };
+  /**
+   * A heading textblock, with a `level` attribute that should hold the
+   * number 1 to 6. Parsed and serialized as `<h1>` to `<h6>` elements.
+   */
+  heading: {
+    readonly attrs: {
+      readonly level: {
+        readonly schema: S.Number;
+        readonly default: 1;
+      };
+    };
+    readonly content: ContentExpr<"inline">;
+    readonly group: "block";
+    readonly defining: true;
+    readonly parseDOM: readonly [{
+      readonly tag: "h1";
+      readonly attrs: {
+        readonly level: 1;
+      };
+    }, {
+      readonly tag: "h2";
+      readonly attrs: {
+        readonly level: 2;
+      };
+    }, {
+      readonly tag: "h3";
+      readonly attrs: {
+        readonly level: 3;
+      };
+    }, {
+      readonly tag: "h4";
+      readonly attrs: {
+        readonly level: 4;
+      };
+    }, {
+      readonly tag: "h5";
+      readonly attrs: {
+        readonly level: 5;
+      };
+    }, {
+      readonly tag: "h6";
+      readonly attrs: {
+        readonly level: 6;
+      };
+    }];
+    readonly toDOM: (node: Node<any, any>) => [string, number];
+  };
+  /**
+   * A code listing. Disallows marks or non-text inline nodes by default.
+   * Represented as a `<pre>` element with a `<code>` element inside of
+   * it.
+   */
+  code_block: {
+    readonly content: ContentExpr<"text">;
+    readonly marks: "";
+    readonly group: "block";
+    readonly code: true;
+    readonly defining: true;
+    readonly parseDOM: readonly [{
+      readonly tag: "pre";
+      readonly preserveWhitespace: "full";
+    }];
+    readonly toDOM: () => readonly any[] | readonly [string, ...any[]];
+  };
+  /** The text node. */
+  text: {
+    readonly group: "inline";
+  };
+  /**
+   * An inline image (`<img>`) node. Supports `src`, `alt`, and `title`
+   * attributes. The latter two default to `null`.
+   */
+  image: {
+    readonly inline: true;
+    readonly attrs: {
+      readonly src: S.String;
+      readonly alt: {
+        readonly schema: S.NullOr<S.String>;
+        readonly default: null;
+      };
+      readonly title: {
+        readonly schema: S.NullOr<S.String>;
+        readonly default: null;
+      };
+    };
+    readonly group: "inline";
+    readonly draggable: true;
+    readonly parseDOM: readonly [{
+      readonly tag: "img[src]";
+      readonly getAttrs: (dom: HTMLElement) => {
+        src: string | null;
+        title: string | null;
+        alt: string | null;
+      };
+    }];
+    readonly toDOM: (node: Node<any, any>) => [string, {
+      src: any;
+      alt: any;
+      title: any;
+    }];
+  };
+  /** A hard line break, represented in the DOM as `<br>`. */
+  hard_break: {
+    readonly inline: true;
+    readonly group: "inline";
+    readonly selectable: false;
+    readonly parseDOM: readonly [{
+      readonly tag: "br";
+    }];
+    readonly toDOM: () => readonly any[] | readonly [string, ...any[]];
+  };
+};
+/**
+ * The mark specs of the basic schema.
+ *
+ * @since 0.1.0
+ * @category specs
+ */
+export declare const marks: {
+  /**
+   * A link. Has `href` and `title` attributes. `title` defaults to
+   * `null`. Rendered and parsed as an `<a>` element.
+   */
+  link: {
+    readonly attrs: {
+      readonly href: S.String;
+      readonly title: {
+        readonly schema: S.NullOr<S.String>;
+        readonly default: null;
+      };
+    };
+    readonly inclusive: false;
+    readonly parseDOM: readonly [{
+      readonly tag: "a[href]";
+      readonly getAttrs: (dom: HTMLElement) => {
+        href: string | null;
+        title: string | null;
+      };
+    }];
+    readonly toDOM: (node: Mark<any, any>) => [string, {
+      href: any;
+      title: any;
+    }, number];
+  };
+  /** An emphasis mark. Rendered as an `<em>` element. */
+  em: {
+    readonly parseDOM: readonly [{
+      readonly tag: "i";
+    }, {
+      readonly tag: "em";
+    }, {
+      readonly style: "font-style=italic";
+    }, {
+      readonly style: "font-style=normal";
+      readonly clearMark: (m: Mark<any, any>) => boolean;
+    }];
+    readonly toDOM: () => readonly any[] | readonly [string, ...any[]];
+  };
+  /** A strong mark. Rendered as `<strong>`, parse rules also match `<b>` and `font-weight: bold`. */
+  strong: {
+    readonly parseDOM: readonly [{
+      readonly tag: "strong";
+    }, {
+      readonly tag: "b";
+      readonly getAttrs: (node: HTMLElement) => false | null;
+    }, {
+      readonly style: "font-weight=400";
+      readonly clearMark: (m: Mark<any, any>) => boolean;
+    }, {
+      readonly style: "font-weight";
+      readonly getAttrs: (value: string) => false | null;
+    }];
+    readonly toDOM: () => readonly any[] | readonly [string, ...any[]];
+  };
+  /** Code font mark. Represented as a `<code>` element. */
+  code: {
+    readonly code: true;
+    readonly parseDOM: readonly [{
+      readonly tag: "code";
+    }];
+    readonly toDOM: () => readonly any[] | readonly [string, ...any[]];
+  };
+};
+/**
+ * This schema roughly corresponds to the document schema used by
+ * CommonMark, minus the list elements, which are defined in the
+ * `schema-list` module.
+ *
+ * @since 0.1.0
+ * @category schemas
+ */
+export declare const schema: DocSchema<{
+  /** The top level document node. */
+  doc: {
+    readonly content: ContentExpr<"block">;
+  };
+  /** A plain paragraph textblock. Represented in the DOM as a `<p>` element. */
+  paragraph: {
+    readonly content: ContentExpr<"inline">;
+    readonly group: "block";
+    readonly parseDOM: readonly [{
+      readonly tag: "p";
+    }];
+    readonly toDOM: () => readonly any[] | readonly [string, ...any[]];
+  };
+  /** A blockquote (`<blockquote>`) wrapping one or more blocks. */
+  blockquote: {
+    readonly content: ContentExpr<"block">;
+    readonly group: "block";
+    readonly defining: true;
+    readonly parseDOM: readonly [{
+      readonly tag: "blockquote";
+    }];
+    readonly toDOM: () => readonly any[] | readonly [string, ...any[]];
+  };
+  /** A horizontal rule (`<hr>`). */
+  horizontal_rule: {
+    readonly group: "block";
+    readonly parseDOM: readonly [{
+      readonly tag: "hr";
+    }];
+    readonly toDOM: () => readonly any[] | readonly [string, ...any[]];
+  };
+  /**
+   * A heading textblock, with a `level` attribute that should hold the
+   * number 1 to 6. Parsed and serialized as `<h1>` to `<h6>` elements.
+   */
+  heading: {
+    readonly attrs: {
+      readonly level: {
+        readonly schema: S.Number;
+        readonly default: 1;
+      };
+    };
+    readonly content: ContentExpr<"inline">;
+    readonly group: "block";
+    readonly defining: true;
+    readonly parseDOM: readonly [{
+      readonly tag: "h1";
+      readonly attrs: {
+        readonly level: 1;
+      };
+    }, {
+      readonly tag: "h2";
+      readonly attrs: {
+        readonly level: 2;
+      };
+    }, {
+      readonly tag: "h3";
+      readonly attrs: {
+        readonly level: 3;
+      };
+    }, {
+      readonly tag: "h4";
+      readonly attrs: {
+        readonly level: 4;
+      };
+    }, {
+      readonly tag: "h5";
+      readonly attrs: {
+        readonly level: 5;
+      };
+    }, {
+      readonly tag: "h6";
+      readonly attrs: {
+        readonly level: 6;
+      };
+    }];
+    readonly toDOM: (node: Node<any, any>) => [string, number];
+  };
+  /**
+   * A code listing. Disallows marks or non-text inline nodes by default.
+   * Represented as a `<pre>` element with a `<code>` element inside of
+   * it.
+   */
+  code_block: {
+    readonly content: ContentExpr<"text">;
+    readonly marks: "";
+    readonly group: "block";
+    readonly code: true;
+    readonly defining: true;
+    readonly parseDOM: readonly [{
+      readonly tag: "pre";
+      readonly preserveWhitespace: "full";
+    }];
+    readonly toDOM: () => readonly any[] | readonly [string, ...any[]];
+  };
+  /** The text node. */
+  text: {
+    readonly group: "inline";
+  };
+  /**
+   * An inline image (`<img>`) node. Supports `src`, `alt`, and `title`
+   * attributes. The latter two default to `null`.
+   */
+  image: {
+    readonly inline: true;
+    readonly attrs: {
+      readonly src: S.String;
+      readonly alt: {
+        readonly schema: S.NullOr<S.String>;
+        readonly default: null;
+      };
+      readonly title: {
+        readonly schema: S.NullOr<S.String>;
+        readonly default: null;
+      };
+    };
+    readonly group: "inline";
+    readonly draggable: true;
+    readonly parseDOM: readonly [{
+      readonly tag: "img[src]";
+      readonly getAttrs: (dom: HTMLElement) => {
+        src: string | null;
+        title: string | null;
+        alt: string | null;
+      };
+    }];
+    readonly toDOM: (node: Node<any, any>) => [string, {
+      src: any;
+      alt: any;
+      title: any;
+    }];
+  };
+  /** A hard line break, represented in the DOM as `<br>`. */
+  hard_break: {
+    readonly inline: true;
+    readonly group: "inline";
+    readonly selectable: false;
+    readonly parseDOM: readonly [{
+      readonly tag: "br";
+    }];
+    readonly toDOM: () => readonly any[] | readonly [string, ...any[]];
+  };
+}, {
+  /**
+   * A link. Has `href` and `title` attributes. `title` defaults to
+   * `null`. Rendered and parsed as an `<a>` element.
+   */
+  link: {
+    readonly attrs: {
+      readonly href: S.String;
+      readonly title: {
+        readonly schema: S.NullOr<S.String>;
+        readonly default: null;
+      };
+    };
+    readonly inclusive: false;
+    readonly parseDOM: readonly [{
+      readonly tag: "a[href]";
+      readonly getAttrs: (dom: HTMLElement) => {
+        href: string | null;
+        title: string | null;
+      };
+    }];
+    readonly toDOM: (node: Mark<any, any>) => [string, {
+      href: any;
+      title: any;
+    }, number];
+  };
+  /** An emphasis mark. Rendered as an `<em>` element. */
+  em: {
+    readonly parseDOM: readonly [{
+      readonly tag: "i";
+    }, {
+      readonly tag: "em";
+    }, {
+      readonly style: "font-style=italic";
+    }, {
+      readonly style: "font-style=normal";
+      readonly clearMark: (m: Mark<any, any>) => boolean;
+    }];
+    readonly toDOM: () => readonly any[] | readonly [string, ...any[]];
+  };
+  /** A strong mark. Rendered as `<strong>`, parse rules also match `<b>` and `font-weight: bold`. */
+  strong: {
+    readonly parseDOM: readonly [{
+      readonly tag: "strong";
+    }, {
+      readonly tag: "b";
+      readonly getAttrs: (node: HTMLElement) => false | null;
+    }, {
+      readonly style: "font-weight=400";
+      readonly clearMark: (m: Mark<any, any>) => boolean;
+    }, {
+      readonly style: "font-weight";
+      readonly getAttrs: (value: string) => false | null;
+    }];
+    readonly toDOM: () => readonly any[] | readonly [string, ...any[]];
+  };
+  /** Code font mark. Represented as a `<code>` element. */
+  code: {
+    readonly code: true;
+    readonly parseDOM: readonly [{
+      readonly tag: "code";
+    }];
+    readonly toDOM: () => readonly any[] | readonly [string, ...any[]];
+  };
+}>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+export type BasicSchema = typeof schema;

package/dist/schema-basic.js

@@ -0,0 +1,269 @@
+import { oneOrMore, zeroOrMore } from "./model/content.js";
+import { DocSchema, markSpec, nodeSpec } from "./model/schema.js";
+import * as S from "effect/Schema";
+// src/schema-basic.ts
+/**
+* A basic document schema, ported from `prosemirror-schema-basic`.
+*
+* It supports paragraphs, blockquotes, horizontal rules, headings, code
+* blocks, images, hard breaks, and the `link`, `em`, `strong` and
+* `code` marks. It is mostly useful as an example and a starting point
+* for your own schemas.
+*
+* @since 0.1.0
+*/
+const pDOM = ["p", 0];
+const blockquoteDOM = ["blockquote", 0];
+const hrDOM = ["hr"];
+const preDOM = ["pre", ["code", 0]];
+const brDOM = ["br"];
+/**
+* The node specs of the basic schema.
+*
+* @since 0.1.0
+* @category specs
+*/
+const nodes = {
+	/** The top level document node. */
+	doc: nodeSpec({ content: oneOrMore("block") }),
+	/** A plain paragraph textblock. Represented in the DOM as a `<p>` element. */
+	paragraph: nodeSpec({
+		content: zeroOrMore("inline"),
+		group: "block",
+		parseDOM: [{ tag: "p" }],
+		toDOM() {
+			return pDOM;
+		}
+	}),
+	/** A blockquote (`<blockquote>`) wrapping one or more blocks. */
+	blockquote: nodeSpec({
+		content: oneOrMore("block"),
+		group: "block",
+		defining: true,
+		parseDOM: [{ tag: "blockquote" }],
+		toDOM() {
+			return blockquoteDOM;
+		}
+	}),
+	/** A horizontal rule (`<hr>`). */
+	horizontal_rule: nodeSpec({
+		group: "block",
+		parseDOM: [{ tag: "hr" }],
+		toDOM() {
+			return hrDOM;
+		}
+	}),
+	/**
+	* A heading textblock, with a `level` attribute that should hold the
+	* number 1 to 6. Parsed and serialized as `<h1>` to `<h6>` elements.
+	*/
+	heading: nodeSpec({
+		attrs: { level: {
+			schema: S.Number,
+			default: 1
+		} },
+		content: zeroOrMore("inline"),
+		group: "block",
+		defining: true,
+		parseDOM: [
+			{
+				tag: "h1",
+				attrs: { level: 1 }
+			},
+			{
+				tag: "h2",
+				attrs: { level: 2 }
+			},
+			{
+				tag: "h3",
+				attrs: { level: 3 }
+			},
+			{
+				tag: "h4",
+				attrs: { level: 4 }
+			},
+			{
+				tag: "h5",
+				attrs: { level: 5 }
+			},
+			{
+				tag: "h6",
+				attrs: { level: 6 }
+			}
+		],
+		toDOM(node) {
+			return ["h" + node.attrs.level, 0];
+		}
+	}),
+	/**
+	* A code listing. Disallows marks or non-text inline nodes by default.
+	* Represented as a `<pre>` element with a `<code>` element inside of
+	* it.
+	*/
+	code_block: nodeSpec({
+		content: zeroOrMore("text"),
+		marks: "",
+		group: "block",
+		code: true,
+		defining: true,
+		parseDOM: [{
+			tag: "pre",
+			preserveWhitespace: "full"
+		}],
+		toDOM() {
+			return preDOM;
+		}
+	}),
+	/** The text node. */
+	text: nodeSpec({ group: "inline" }),
+	/**
+	* An inline image (`<img>`) node. Supports `src`, `alt`, and `title`
+	* attributes. The latter two default to `null`.
+	*/
+	image: nodeSpec({
+		inline: true,
+		attrs: {
+			src: S.String,
+			alt: {
+				schema: S.NullOr(S.String),
+				default: null
+			},
+			title: {
+				schema: S.NullOr(S.String),
+				default: null
+			}
+		},
+		group: "inline",
+		draggable: true,
+		parseDOM: [{
+			tag: "img[src]",
+			getAttrs(dom) {
+				return {
+					src: dom.getAttribute("src"),
+					title: dom.getAttribute("title"),
+					alt: dom.getAttribute("alt")
+				};
+			}
+		}],
+		toDOM(node) {
+			const { alt, src, title } = node.attrs;
+			return ["img", {
+				src,
+				alt,
+				title
+			}];
+		}
+	}),
+	/** A hard line break, represented in the DOM as `<br>`. */
+	hard_break: nodeSpec({
+		inline: true,
+		group: "inline",
+		selectable: false,
+		parseDOM: [{ tag: "br" }],
+		toDOM() {
+			return brDOM;
+		}
+	})
+};
+const emDOM = ["em", 0];
+const strongDOM = ["strong", 0];
+const codeDOM = ["code", 0];
+/**
+* The mark specs of the basic schema.
+*
+* @since 0.1.0
+* @category specs
+*/
+const marks = {
+	/**
+	* A link. Has `href` and `title` attributes. `title` defaults to
+	* `null`. Rendered and parsed as an `<a>` element.
+	*/
+	link: markSpec({
+		attrs: {
+			href: S.String,
+			title: {
+				schema: S.NullOr(S.String),
+				default: null
+			}
+		},
+		inclusive: false,
+		parseDOM: [{
+			tag: "a[href]",
+			getAttrs(dom) {
+				return {
+					href: dom.getAttribute("href"),
+					title: dom.getAttribute("title")
+				};
+			}
+		}],
+		toDOM(node) {
+			const { href, title } = node.attrs;
+			return [
+				"a",
+				{
+					href,
+					title
+				},
+				0
+			];
+		}
+	}),
+	/** An emphasis mark. Rendered as an `<em>` element. */
+	em: markSpec({
+		parseDOM: [
+			{ tag: "i" },
+			{ tag: "em" },
+			{ style: "font-style=italic" },
+			{
+				style: "font-style=normal",
+				clearMark: (m) => m.type.name === "em"
+			}
+		],
+		toDOM() {
+			return emDOM;
+		}
+	}),
+	/** A strong mark. Rendered as `<strong>`, parse rules also match `<b>` and `font-weight: bold`. */
+	strong: markSpec({
+		parseDOM: [
+			{ tag: "strong" },
+			{
+				tag: "b",
+				getAttrs: (node) => node.style.fontWeight !== "normal" && null
+			},
+			{
+				style: "font-weight=400",
+				clearMark: (m) => m.type.name === "strong"
+			},
+			{
+				style: "font-weight",
+				getAttrs: (value) => /^(bold(er)?|[5-9]\d{2,})$/.test(value) && null
+			}
+		],
+		toDOM() {
+			return strongDOM;
+		}
+	}),
+	/** Code font mark. Represented as a `<code>` element. */
+	code: markSpec({
+		code: true,
+		parseDOM: [{ tag: "code" }],
+		toDOM() {
+			return codeDOM;
+		}
+	})
+};
+/**
+* This schema roughly corresponds to the document schema used by
+* CommonMark, minus the list elements, which are defined in the
+* `schema-list` module.
+*
+* @since 0.1.0
+* @category schemas
+*/
+const schema = DocSchema.makeUnsafe({
+	nodes,
+	marks
+});
+export { marks, nodes, schema };