@thomasfosterau/effect-richtext 0.0.0 → 0.1.0

package/dist/markdown/schema.d.ts

@@ -0,0 +1,522 @@
+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 Markdown schema.
+ *
+ * @since 0.1.0
+ * @category specs
+ */
+export declare const nodes: {
+  doc: {
+    readonly content: ContentExpr<"block">;
+  };
+  paragraph: {
+    readonly content: ContentExpr<"inline">;
+    readonly group: "block";
+    readonly parseDOM: readonly [{
+      readonly tag: "p";
+    }];
+    readonly toDOM: () => [string, number];
+  };
+  blockquote: {
+    readonly content: ContentExpr<"block">;
+    readonly group: "block";
+    readonly parseDOM: readonly [{
+      readonly tag: "blockquote";
+    }];
+    readonly toDOM: () => [string, number];
+  };
+  horizontal_rule: {
+    readonly group: "block";
+    readonly parseDOM: readonly [{
+      readonly tag: "hr";
+    }];
+    readonly toDOM: () => [string, string[]];
+  };
+  heading: {
+    readonly attrs: {
+      readonly level: {
+        readonly schema: S.Number;
+        readonly default: 1;
+      };
+    };
+    readonly content: ContentExpr<"text" | "image">;
+    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];
+  };
+  code_block: {
+    readonly content: ContentExpr<"text">;
+    readonly group: "block";
+    readonly code: true;
+    readonly defining: true;
+    readonly marks: "";
+    readonly attrs: {
+      readonly params: {
+        readonly schema: S.String;
+        readonly default: "";
+      };
+    };
+    readonly parseDOM: readonly [{
+      readonly tag: "pre";
+      readonly preserveWhitespace: "full";
+      readonly getAttrs: (node: HTMLElement) => {
+        params: string;
+      };
+    }];
+    readonly toDOM: (node: Node<any, any>) => [string, {
+      "data-params": any;
+    } | {
+      "data-params"?: never;
+    }, (string | number)[]];
+  };
+  ordered_list: {
+    readonly content: ContentExpr<"list_item">;
+    readonly group: "block";
+    readonly attrs: {
+      readonly order: {
+        readonly schema: S.Number;
+        readonly default: 1;
+      };
+      readonly tight: {
+        readonly schema: S.Boolean;
+        readonly default: false;
+      };
+    };
+    readonly parseDOM: readonly [{
+      readonly tag: "ol";
+      readonly getAttrs: (dom: HTMLElement) => {
+        order: number;
+        tight: boolean;
+      };
+    }];
+    readonly toDOM: (node: Node<any, any>) => [string, {
+      start: any;
+      "data-tight": string | null;
+    }, number];
+  };
+  bullet_list: {
+    readonly content: ContentExpr<"list_item">;
+    readonly group: "block";
+    readonly attrs: {
+      readonly tight: {
+        readonly schema: S.Boolean;
+        readonly default: false;
+      };
+    };
+    readonly parseDOM: readonly [{
+      readonly tag: "ul";
+      readonly getAttrs: (dom: HTMLElement) => {
+        tight: boolean;
+      };
+    }];
+    readonly toDOM: (node: Node<any, any>) => [string, {
+      "data-tight": string | null;
+    }, number];
+  };
+  list_item: {
+    readonly content: ContentExpr<"block">;
+    readonly defining: true;
+    readonly parseDOM: readonly [{
+      readonly tag: "li";
+    }];
+    readonly toDOM: () => [string, number];
+  };
+  text: {
+    readonly group: "inline";
+  };
+  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;
+    }];
+  };
+  hard_break: {
+    readonly inline: true;
+    readonly group: "inline";
+    readonly selectable: false;
+    readonly parseDOM: readonly [{
+      readonly tag: "br";
+    }];
+    readonly toDOM: () => [string];
+  };
+};
+/**
+ * The mark specs of the Markdown schema.
+ *
+ * @since 0.1.0
+ * @category specs
+ */
+export declare const marks: {
+  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: () => [string];
+  };
+  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: () => [string];
+  };
+  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;
+    }];
+  };
+  code: {
+    readonly code: true;
+    readonly parseDOM: readonly [{
+      readonly tag: "code";
+    }];
+    readonly toDOM: () => [string];
+  };
+};
+/**
+ * Document schema for the data model used by CommonMark.
+ *
+ * @since 0.1.0
+ * @category schemas
+ */
+export declare const schema: DocSchema<{
+  doc: {
+    readonly content: ContentExpr<"block">;
+  };
+  paragraph: {
+    readonly content: ContentExpr<"inline">;
+    readonly group: "block";
+    readonly parseDOM: readonly [{
+      readonly tag: "p";
+    }];
+    readonly toDOM: () => [string, number];
+  };
+  blockquote: {
+    readonly content: ContentExpr<"block">;
+    readonly group: "block";
+    readonly parseDOM: readonly [{
+      readonly tag: "blockquote";
+    }];
+    readonly toDOM: () => [string, number];
+  };
+  horizontal_rule: {
+    readonly group: "block";
+    readonly parseDOM: readonly [{
+      readonly tag: "hr";
+    }];
+    readonly toDOM: () => [string, string[]];
+  };
+  heading: {
+    readonly attrs: {
+      readonly level: {
+        readonly schema: S.Number;
+        readonly default: 1;
+      };
+    };
+    readonly content: ContentExpr<"text" | "image">;
+    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];
+  };
+  code_block: {
+    readonly content: ContentExpr<"text">;
+    readonly group: "block";
+    readonly code: true;
+    readonly defining: true;
+    readonly marks: "";
+    readonly attrs: {
+      readonly params: {
+        readonly schema: S.String;
+        readonly default: "";
+      };
+    };
+    readonly parseDOM: readonly [{
+      readonly tag: "pre";
+      readonly preserveWhitespace: "full";
+      readonly getAttrs: (node: HTMLElement) => {
+        params: string;
+      };
+    }];
+    readonly toDOM: (node: Node<any, any>) => [string, {
+      "data-params": any;
+    } | {
+      "data-params"?: never;
+    }, (string | number)[]];
+  };
+  ordered_list: {
+    readonly content: ContentExpr<"list_item">;
+    readonly group: "block";
+    readonly attrs: {
+      readonly order: {
+        readonly schema: S.Number;
+        readonly default: 1;
+      };
+      readonly tight: {
+        readonly schema: S.Boolean;
+        readonly default: false;
+      };
+    };
+    readonly parseDOM: readonly [{
+      readonly tag: "ol";
+      readonly getAttrs: (dom: HTMLElement) => {
+        order: number;
+        tight: boolean;
+      };
+    }];
+    readonly toDOM: (node: Node<any, any>) => [string, {
+      start: any;
+      "data-tight": string | null;
+    }, number];
+  };
+  bullet_list: {
+    readonly content: ContentExpr<"list_item">;
+    readonly group: "block";
+    readonly attrs: {
+      readonly tight: {
+        readonly schema: S.Boolean;
+        readonly default: false;
+      };
+    };
+    readonly parseDOM: readonly [{
+      readonly tag: "ul";
+      readonly getAttrs: (dom: HTMLElement) => {
+        tight: boolean;
+      };
+    }];
+    readonly toDOM: (node: Node<any, any>) => [string, {
+      "data-tight": string | null;
+    }, number];
+  };
+  list_item: {
+    readonly content: ContentExpr<"block">;
+    readonly defining: true;
+    readonly parseDOM: readonly [{
+      readonly tag: "li";
+    }];
+    readonly toDOM: () => [string, number];
+  };
+  text: {
+    readonly group: "inline";
+  };
+  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;
+    }];
+  };
+  hard_break: {
+    readonly inline: true;
+    readonly group: "inline";
+    readonly selectable: false;
+    readonly parseDOM: readonly [{
+      readonly tag: "br";
+    }];
+    readonly toDOM: () => [string];
+  };
+}, {
+  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: () => [string];
+  };
+  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: () => [string];
+  };
+  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;
+    }];
+  };
+  code: {
+    readonly code: true;
+    readonly parseDOM: readonly [{
+      readonly tag: "code";
+    }];
+    readonly toDOM: () => [string];
+  };
+}>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+export type MarkdownSchema = typeof schema;