@dou-ui/editor 0.0.0-stage → 0.1.0-alpha.0

package/dist/document.js

@@ -0,0 +1,157 @@
+import { editorKit } from "./extensions/editor-kit.js";
+import { kitOf } from "./core/convert.js";
+// src/document.ts
+/** A document with no blocks, to start from when nothing is saved yet. */
+var emptyDocument = () => ({
+	version: 1,
+	blocks: []
+});
+var defaultKit;
+/**
+* What is wrong with the shape itself: the document is not an object, or a
+* list in it is not an array. Nothing else can be checked until it is fixed.
+*/
+function shapeProblems(value, lists) {
+	if (!value || typeof value !== "object" || Array.isArray(value)) return [{
+		code: "shape",
+		path: "",
+		text: "",
+		message: "The document is not an object"
+	}];
+	return lists.filter((key) => !Array.isArray(value[key])).map((key) => ({
+		code: "shape",
+		path: key,
+		text: "",
+		message: `"${key}" is not a list`
+	}));
+}
+/**
+* The problems of an editor document, before it is saved or shown: an
+* unknown version, blocks or table rows sharing an id, and block types,
+* marks and inline nodes the extensions don't define, which the editor
+* would show as a paragraph or leave out.
+*/
+function checkDocument(document, options = {}) {
+	const shape = shapeProblems(document, ["blocks"]);
+	if (shape.length) return shape;
+	const problems = [];
+	if (document.version !== 1) problems.push({
+		code: "version",
+		path: "version",
+		text: String(document.version),
+		message: `Version ${String(document.version)} is not known`
+	});
+	const { schema } = kitOf(options.extensions ?? (defaultKit ??= [editorKit()]));
+	const ids = /* @__PURE__ */ new Set();
+	const walk = (blocks, at) => blocks.forEach((block, i) => {
+		const path = `${at}[${i}]`;
+		checkBlock(block, path, schema, ids, problems);
+		if (block.children) walk(block.children, `${path}.children`);
+	});
+	walk(document.blocks, "blocks");
+	return problems;
+}
+function checkBlock(block, path, schema, ids, problems) {
+	const blockId = block.id;
+	if (blockId !== void 0) {
+		if (ids.has(blockId)) problems.push({
+			code: "duplicate-id",
+			blockId,
+			path,
+			text: blockId,
+			message: `The block id "${blockId}" is used more than once`
+		});
+		ids.add(blockId);
+	}
+	const type = block.type ?? "paragraph";
+	if (!schema.nodes[type]?.isInGroup("blockContent")) problems.push({
+		code: "unknown-type",
+		blockId,
+		path,
+		text: type,
+		message: `No block type "${type}" is defined; it would show as a paragraph`
+	});
+	if (Array.isArray(block.content)) block.content.forEach((item, i) => {
+		const at = `${path}.content[${i}]`;
+		if (item.type === "inline" && !schema.nodes[item.name]?.isInline) problems.push({
+			code: "unknown-inline",
+			blockId,
+			path: at,
+			text: item.name,
+			message: `No inline node "${item.name}" is defined; it would be left out`
+		});
+		if (item.type === "text") {
+			for (const mark of item.marks ?? []) if (!schema.marks[mark]) problems.push({
+				code: "unknown-mark",
+				blockId,
+				path: at,
+				text: mark,
+				message: `No mark "${mark}" is defined; it would be left out`
+			});
+		}
+	});
+	if (block.rows) checkRows(block.rows, `${path}.rows`, blockId, problems);
+}
+function checkRows(rows, path, blockId, problems) {
+	const ids = /* @__PURE__ */ new Set();
+	rows.forEach((row, i) => {
+		if (row.id === void 0) return;
+		if (ids.has(row.id)) problems.push({
+			code: "duplicate-id",
+			blockId,
+			path: `${path}[${i}]`,
+			text: row.id,
+			message: `The row id "${row.id}" is used more than once in a table`
+		});
+		ids.add(row.id);
+	});
+}
+var objects = (value) => (Array.isArray(value) ? value : []).filter((item) => !!item && typeof item === "object");
+/** The saved data as an object of version 1, or an error saying why it can't be. */
+function sourceOf(input) {
+	if (!input || typeof input !== "object" || Array.isArray(input)) throw new Error(`[@dou-ui/editor] an editor document must be an object, not ${Array.isArray(input) ? "an array" : JSON.stringify(input) ?? String(input)}`);
+	const source = input;
+	const version = source.version ?? 1;
+	if (version !== 1) throw new Error(`[@dou-ui/editor] unknown document version ${JSON.stringify(version) ?? String(version)} (expected 1); data saved by a newer @dou-ui/editor needs that version to open`);
+	return source;
+}
+/**
+* Brings a saved document up to the current version, and fills what an
+* older or hand-written one may lack (`version`, `blocks`). Blocks that are
+* not objects are dropped; anything else is kept as it is, for the editor
+* to read as it reads partial blocks. Throws for data that is not an object (an array,
+* `null`, a string) and for a version it does not know.
+*/
+function migrateDocument(input) {
+	const source = sourceOf(input);
+	return {
+		...source,
+		version: 1,
+		blocks: objects(source.blocks)
+	};
+}
+var warned = /* @__PURE__ */ new Set();
+/**
+* The blocks of the `v-model`, as the editor reads them. A document of the
+* wrong shape (not an object, a bare list of blocks, without `blocks` or a
+* known `version`) gets a warning in development and is read as well as it
+* can be: a list as the blocks, anything else missing as no blocks. What
+* the editor writes back always carries `version: 1`. `undefined`, no
+* `v-model` bound, is fine.
+*/
+function readBlocks(value) {
+	if (value === void 0) return void 0;
+	const plain = !!value && typeof value === "object" && !Array.isArray(value);
+	const source = plain ? value : {};
+	const blocks = Array.isArray(source.blocks);
+	const problem = Array.isArray(value) ? "is a list of blocks" : !plain ? `is ${JSON.stringify(value) ?? String(value)}` : !blocks ? "has no blocks array" : source.version === void 0 ? "has no version" : source.version !== 1 ? `has version ${JSON.stringify(source.version)}` : "";
+	if (problem && process.env.NODE_ENV !== "production" && !warned.has(problem)) {
+		warned.add(problem);
+		console.warn(`[@dou-ui/editor] the v-model ${problem}; expected { version: 1, blocks: [...] }. It is read as well as it can be and the version as 1; read saved data with migrateDocument().`);
+	}
+	if (Array.isArray(value)) return value;
+	return blocks ? source.blocks : [];
+}
+export { checkDocument, emptyDocument, migrateDocument, readBlocks };
+
+//# sourceMappingURL=document.js.map

package/dist/document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document.js","names":[],"sources":["../src/document.ts"],"sourcesContent":["import type { Schema } from 'prosemirror-model'\nimport { kitOf, type EditorExtensionList } from './core/convert'\nimport type { Block, EditorDocument, PartialBlock, PartialTableRow } from './core/model'\nimport { editorKit } from './extensions/editor-kit'\n\n/** A document with no blocks, to start from when nothing is saved yet. */\nexport const emptyDocument = (): EditorDocument<Block> => ({ version: 1, blocks: [] })\n\nexport interface DocumentProblem {\n  code: 'version' | 'shape' | 'duplicate-id' | 'unknown-type' | 'unknown-mark' | 'unknown-inline'\n  /** The block at fault, when it has an id. */\n  blockId?: string\n  /**\n   * Where the problem is, as a path into the document, e.g.\n   * `blocks[0].children[2]` or `blocks[1].content[0]`; `version` for the version.\n   */\n  path: string\n  /** The id, type, mark or inline node at fault, for the editor's message. */\n  text: string\n  /** An English description, for logs. */\n  message: string\n}\n\nexport interface CheckDocumentOptions {\n  /** The editor's `extensions`, for the blocks, marks and inline nodes they add; `[editorKit()]` by default, as in the editor. */\n  extensions?: EditorExtensionList\n}\n\nlet defaultKit: EditorExtensionList | undefined\n\n/**\n * What is wrong with the shape itself: the document is not an object, or a\n * list in it is not an array. Nothing else can be checked until it is fixed.\n */\nfunction shapeProblems(value: unknown, lists: string[]): DocumentProblem[] {\n  if (!value || typeof value !== 'object' || Array.isArray(value))\n    return [{ code: 'shape', path: '', text: '', message: 'The document is not an object' }]\n  return lists\n    .filter((key) => !Array.isArray((value as Record<string, unknown>)[key]))\n    .map((key) => ({ code: 'shape', path: key, text: '', message: `\"${key}\" is not a list` }))\n}\n\n/**\n * The problems of an editor document, before it is saved or shown: an\n * unknown version, blocks or table rows sharing an id, and block types,\n * marks and inline nodes the extensions don't define, which the editor\n * would show as a paragraph or leave out.\n */\nexport function checkDocument(\n  document: EditorDocument<PartialBlock>,\n  options: CheckDocumentOptions = {},\n): DocumentProblem[] {\n  const shape = shapeProblems(document, ['blocks'])\n  if (shape.length) return shape\n  const problems: DocumentProblem[] = []\n  if (document.version !== 1)\n    problems.push({\n      code: 'version',\n      path: 'version',\n      text: String(document.version),\n      message: `Version ${String(document.version)} is not known`,\n    })\n  const { schema } = kitOf(options.extensions ?? (defaultKit ??= [editorKit()]))\n  const ids = new Set<string>()\n  const walk = (blocks: readonly PartialBlock[], at: string) =>\n    blocks.forEach((block, i) => {\n      const path = `${at}[${i}]`\n      checkBlock(block, path, schema, ids, problems)\n      if (block.children) walk(block.children, `${path}.children`)\n    })\n  walk(document.blocks, 'blocks')\n  return problems\n}\n\nfunction checkBlock(\n  block: PartialBlock,\n  path: string,\n  schema: Schema,\n  ids: Set<string>,\n  problems: DocumentProblem[],\n) {\n  const blockId = block.id\n  if (blockId !== undefined) {\n    if (ids.has(blockId))\n      problems.push({\n        code: 'duplicate-id',\n        blockId,\n        path,\n        text: blockId,\n        message: `The block id \"${blockId}\" is used more than once`,\n      })\n    ids.add(blockId)\n  }\n  const type = block.type ?? 'paragraph'\n  if (!schema.nodes[type]?.isInGroup('blockContent'))\n    problems.push({\n      code: 'unknown-type',\n      blockId,\n      path,\n      text: type,\n      message: `No block type \"${type}\" is defined; it would show as a paragraph`,\n    })\n  if (Array.isArray(block.content))\n    block.content.forEach((item, i) => {\n      const at = `${path}.content[${i}]`\n      if (item.type === 'inline' && !schema.nodes[item.name]?.isInline)\n        problems.push({\n          code: 'unknown-inline',\n          blockId,\n          path: at,\n          text: item.name,\n          message: `No inline node \"${item.name}\" is defined; it would be left out`,\n        })\n      if (item.type === 'text')\n        for (const mark of item.marks ?? [])\n          if (!schema.marks[mark])\n            problems.push({\n              code: 'unknown-mark',\n              blockId,\n              path: at,\n              text: mark,\n              message: `No mark \"${mark}\" is defined; it would be left out`,\n            })\n    })\n  if (block.rows) checkRows(block.rows, `${path}.rows`, blockId, problems)\n}\n\nfunction checkRows(\n  rows: readonly PartialTableRow[],\n  path: string,\n  blockId: string | undefined,\n  problems: DocumentProblem[],\n) {\n  const ids = new Set<string>()\n  rows.forEach((row, i) => {\n    if (row.id === undefined) return\n    if (ids.has(row.id))\n      problems.push({\n        code: 'duplicate-id',\n        blockId,\n        path: `${path}[${i}]`,\n        text: row.id,\n        message: `The row id \"${row.id}\" is used more than once in a table`,\n      })\n    ids.add(row.id)\n  })\n}\n\nconst objects = <T>(value: unknown) =>\n  (Array.isArray(value) ? value : []).filter(\n    (item): item is T => !!item && typeof item === 'object',\n  )\n\n/** The saved data as an object of version 1, or an error saying why it can't be. */\nfunction sourceOf(input: unknown): Record<string, unknown> {\n  if (!input || typeof input !== 'object' || Array.isArray(input))\n    throw new Error(\n      `[@dou-ui/editor] an editor document must be an object, not ${Array.isArray(input) ? 'an array' : (JSON.stringify(input) ?? String(input))}`,\n    )\n  const source = input as Record<string, unknown>\n  const version = source.version ?? 1\n  if (version !== 1)\n    throw new Error(\n      `[@dou-ui/editor] unknown document version ${JSON.stringify(version) ?? String(version)} (expected 1); data saved by a newer @dou-ui/editor needs that version to open`,\n    )\n  return source\n}\n\n/**\n * Brings a saved document up to the current version, and fills what an\n * older or hand-written one may lack (`version`, `blocks`). Blocks that are\n * not objects are dropped; anything else is kept as it is, for the editor\n * to read as it reads partial blocks. Throws for data that is not an object (an array,\n * `null`, a string) and for a version it does not know.\n */\nexport function migrateDocument(input: unknown): EditorDocument<PartialBlock> {\n  const source = sourceOf(input)\n  return { ...source, version: 1, blocks: objects<PartialBlock>(source.blocks) }\n}\n\nconst warned = new Set<string>()\n\n/**\n * The blocks of the `v-model`, as the editor reads them. A document of the\n * wrong shape (not an object, a bare list of blocks, without `blocks` or a\n * known `version`) gets a warning in development and is read as well as it\n * can be: a list as the blocks, anything else missing as no blocks. What\n * the editor writes back always carries `version: 1`. `undefined`, no\n * `v-model` bound, is fine.\n */\nexport function readBlocks(value: unknown): PartialBlock[] | undefined {\n  if (value === undefined) return undefined\n  const plain = !!value && typeof value === 'object' && !Array.isArray(value)\n  const source = (plain ? value : {}) as Partial<EditorDocument<PartialBlock>>\n  const blocks = Array.isArray(source.blocks)\n  const problem = Array.isArray(value)\n    ? 'is a list of blocks'\n    : !plain\n      ? `is ${JSON.stringify(value) ?? String(value)}`\n      : !blocks\n        ? 'has no blocks array'\n        : source.version === undefined\n          ? 'has no version'\n          : source.version !== 1\n            ? `has version ${JSON.stringify(source.version)}`\n            : ''\n  if (problem && process.env.NODE_ENV !== 'production' && !warned.has(problem)) {\n    warned.add(problem)\n    console.warn(\n      `[@dou-ui/editor] the v-model ${problem}; expected { version: 1, blocks: [...] }. It is read as well as it can be and the version as 1; read saved data with migrateDocument().`,\n    )\n  }\n  if (Array.isArray(value)) return value as PartialBlock[]\n  return blocks ? source.blocks : []\n}\n"],"mappings":";;;;AAMA,IAAa,uBAA8C;CAAE,SAAS;CAAG,QAAQ,CAAC;AAAE;AAsBpF,IAAI;;;;;AAMJ,SAAS,cAAc,OAAgB,OAAoC;CACzE,IAAI,CAAC,SAAS,OAAO,UAAU,YAAY,MAAM,QAAQ,KAAK,GAC5D,OAAO,CAAC;EAAE,MAAM;EAAS,MAAM;EAAI,MAAM;EAAI,SAAS;CAAgC,CAAC;CACzF,OAAO,MACJ,QAAQ,QAAQ,CAAC,MAAM,QAAS,MAAkC,IAAI,CAAC,CAAC,CACxE,KAAK,SAAS;EAAE,MAAM;EAAS,MAAM;EAAK,MAAM;EAAI,SAAS,IAAI,IAAI;CAAiB,EAAE;AAC7F;;;;;;;AAQA,SAAgB,cACd,UACA,UAAgC,CAAC,GACd;CACnB,MAAM,QAAQ,cAAc,UAAU,CAAC,QAAQ,CAAC;CAChD,IAAI,MAAM,QAAQ,OAAO;CACzB,MAAM,WAA8B,CAAC;CACrC,IAAI,SAAS,YAAY,GACvB,SAAS,KAAK;EACZ,MAAM;EACN,MAAM;EACN,MAAM,OAAO,SAAS,OAAO;EAC7B,SAAS,WAAW,OAAO,SAAS,OAAO,EAAE;CAC/C,CAAC;CACH,MAAM,EAAE,WAAW,MAAM,QAAQ,eAAe,eAAe,CAAC,UAAU,CAAC,EAAE;CAC7E,MAAM,sBAAM,IAAI,IAAY;CAC5B,MAAM,QAAQ,QAAiC,OAC7C,OAAO,SAAS,OAAO,MAAM;EAC3B,MAAM,OAAO,GAAG,GAAG,GAAG,EAAE;EACxB,WAAW,OAAO,MAAM,QAAQ,KAAK,QAAQ;EAC7C,IAAI,MAAM,UAAU,KAAK,MAAM,UAAU,GAAG,KAAK,UAAU;CAC7D,CAAC;CACH,KAAK,SAAS,QAAQ,QAAQ;CAC9B,OAAO;AACT;AAEA,SAAS,WACP,OACA,MACA,QACA,KACA,UACA;CACA,MAAM,UAAU,MAAM;CACtB,IAAI,YAAY,KAAA,GAAW;EACzB,IAAI,IAAI,IAAI,OAAO,GACjB,SAAS,KAAK;GACZ,MAAM;GACN;GACA;GACA,MAAM;GACN,SAAS,iBAAiB,QAAQ;EACpC,CAAC;EACH,IAAI,IAAI,OAAO;CACjB;CACA,MAAM,OAAO,MAAM,QAAQ;CAC3B,IAAI,CAAC,OAAO,MAAM,KAAK,EAAE,UAAU,cAAc,GAC/C,SAAS,KAAK;EACZ,MAAM;EACN;EACA;EACA,MAAM;EACN,SAAS,kBAAkB,KAAK;CAClC,CAAC;CACH,IAAI,MAAM,QAAQ,MAAM,OAAO,GAC7B,MAAM,QAAQ,SAAS,MAAM,MAAM;EACjC,MAAM,KAAK,GAAG,KAAK,WAAW,EAAE;EAChC,IAAI,KAAK,SAAS,YAAY,CAAC,OAAO,MAAM,KAAK,KAAK,EAAE,UACtD,SAAS,KAAK;GACZ,MAAM;GACN;GACA,MAAM;GACN,MAAM,KAAK;GACX,SAAS,mBAAmB,KAAK,KAAK;EACxC,CAAC;EACH,IAAI,KAAK,SAAS,QACX;QAAA,MAAM,QAAQ,KAAK,SAAS,CAAC,GAChC,IAAI,CAAC,OAAO,MAAM,OAChB,SAAS,KAAK;IACZ,MAAM;IACN;IACA,MAAM;IACN,MAAM;IACN,SAAS,YAAY,KAAK;GAC5B,CAAC;EAAA;CACT,CAAC;CACH,IAAI,MAAM,MAAM,UAAU,MAAM,MAAM,GAAG,KAAK,QAAQ,SAAS,QAAQ;AACzE;AAEA,SAAS,UACP,MACA,MACA,SACA,UACA;CACA,MAAM,sBAAM,IAAI,IAAY;CAC5B,KAAK,SAAS,KAAK,MAAM;EACvB,IAAI,IAAI,OAAO,KAAA,GAAW;EAC1B,IAAI,IAAI,IAAI,IAAI,EAAE,GAChB,SAAS,KAAK;GACZ,MAAM;GACN;GACA,MAAM,GAAG,KAAK,GAAG,EAAE;GACnB,MAAM,IAAI;GACV,SAAS,eAAe,IAAI,GAAG;EACjC,CAAC;EACH,IAAI,IAAI,IAAI,EAAE;CAChB,CAAC;AACH;AAEA,IAAM,WAAc,WACjB,MAAM,QAAQ,KAAK,IAAI,QAAQ,CAAC,EAAA,CAAG,QACjC,SAAoB,CAAC,CAAC,QAAQ,OAAO,SAAS,QACjD;;AAGF,SAAS,SAAS,OAAyC;CACzD,IAAI,CAAC,SAAS,OAAO,UAAU,YAAY,MAAM,QAAQ,KAAK,GAC5D,MAAM,IAAI,MACR,8DAA8D,MAAM,QAAQ,KAAK,IAAI,aAAc,KAAK,UAAU,KAAK,KAAK,OAAO,KAAK,GAC1I;CACF,MAAM,SAAS;CACf,MAAM,UAAU,OAAO,WAAW;CAClC,IAAI,YAAY,GACd,MAAM,IAAI,MACR,6CAA6C,KAAK,UAAU,OAAO,KAAK,OAAO,OAAO,EAAE,+EAC1F;CACF,OAAO;AACT;;;;;;;;AASA,SAAgB,gBAAgB,OAA8C;CAC5E,MAAM,SAAS,SAAS,KAAK;CAC7B,OAAO;EAAE,GAAG;EAAQ,SAAS;EAAG,QAAQ,QAAsB,OAAO,MAAM;CAAE;AAC/E;AAEA,IAAM,yBAAS,IAAI,IAAY;;;;;;;;;AAU/B,SAAgB,WAAW,OAA4C;CACrE,IAAI,UAAU,KAAA,GAAW,OAAO,KAAA;CAChC,MAAM,QAAQ,CAAC,CAAC,SAAS,OAAO,UAAU,YAAY,CAAC,MAAM,QAAQ,KAAK;CAC1E,MAAM,SAAU,QAAQ,QAAQ,CAAC;CACjC,MAAM,SAAS,MAAM,QAAQ,OAAO,MAAM;CAC1C,MAAM,UAAU,MAAM,QAAQ,KAAK,IAC/B,wBACA,CAAC,QACC,MAAM,KAAK,UAAU,KAAK,KAAK,OAAO,KAAK,MAC3C,CAAC,SACC,wBACA,OAAO,YAAY,KAAA,IACjB,mBACA,OAAO,YAAY,IACjB,eAAe,KAAK,UAAU,OAAO,OAAO,MAC5C;CACZ,IAAI,WAAA,QAAA,IAAA,aAAoC,gBAAgB,CAAC,OAAO,IAAI,OAAO,GAAG;EAC5E,OAAO,IAAI,OAAO;EAClB,QAAQ,KACN,gCAAgC,QAAQ,wIAC1C;CACF;CACA,IAAI,MAAM,QAAQ,KAAK,GAAG,OAAO;CACjC,OAAO,SAAS,OAAO,SAAS,CAAC;AACnC"}

package/dist/dom.js

@@ -0,0 +1,48 @@
+// src/dom.ts
+/**
+* The content element (paragraph, heading, …) at height `y` in viewport
+* coordinates: the last one whose top is above it. Contents follow each
+* other from top to bottom in document order, nested ones included, so
+* a binary search does.
+*/
+function contentAt(view, y) {
+	const list = view.dom.querySelectorAll(".dou-editor__content");
+	let low = 0;
+	let high = list.length - 1;
+	let found = -1;
+	while (low <= high) {
+		const middle = low + high >> 1;
+		if (list[middle].getBoundingClientRect().top <= y) {
+			found = middle;
+			low = middle + 1;
+		} else high = middle - 1;
+	}
+	return list[Math.max(found, 0)] ?? null;
+}
+/** The block element around a content element. */
+function blockElementOf(content) {
+	return content.closest(".dou-editor__block");
+}
+/** The nearest ancestor that scrolls vertically, or `null` for the page. */
+function scrollParent(element) {
+	for (let node = element.parentElement; node; node = node.parentElement) {
+		const { overflowY } = getComputedStyle(node);
+		if ((overflowY === "auto" || overflowY === "scroll") && node.scrollHeight > node.clientHeight) return node;
+	}
+	return null;
+}
+/** Where the first line of a content element sits: its top and height. */
+function firstLine(content) {
+	const rect = content.getBoundingClientRect();
+	const style = getComputedStyle(content);
+	const lineHeight = Number.parseFloat(style.lineHeight);
+	const padding = Number.parseFloat(style.paddingTop) || 0;
+	const height = Number.isFinite(lineHeight) ? Math.min(lineHeight, rect.height) : rect.height;
+	return {
+		top: rect.top + (height < rect.height ? padding : 0),
+		height
+	};
+}
+export { blockElementOf, contentAt, firstLine, scrollParent };
+
+//# sourceMappingURL=dom.js.map

package/dist/dom.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dom.js","names":[],"sources":["../src/dom.ts"],"sourcesContent":["import type { EditorView } from 'prosemirror-view'\n\n/**\n * The content element (paragraph, heading, …) at height `y` in viewport\n * coordinates: the last one whose top is above it. Contents follow each\n * other from top to bottom in document order, nested ones included, so\n * a binary search does.\n */\nexport function contentAt(view: EditorView, y: number): HTMLElement | null {\n  const list = view.dom.querySelectorAll<HTMLElement>('.dou-editor__content')\n  let low = 0\n  let high = list.length - 1\n  let found = -1\n  while (low <= high) {\n    const middle = (low + high) >> 1\n    if (list[middle]!.getBoundingClientRect().top <= y) {\n      found = middle\n      low = middle + 1\n    } else high = middle - 1\n  }\n  return list[Math.max(found, 0)] ?? null\n}\n\n/** The block element around a content element. */\nexport function blockElementOf(content: HTMLElement): HTMLElement | null {\n  return content.closest<HTMLElement>('.dou-editor__block')\n}\n\n/** The nearest ancestor that scrolls vertically, or `null` for the page. */\nexport function scrollParent(element: HTMLElement): HTMLElement | null {\n  for (let node = element.parentElement; node; node = node.parentElement) {\n    const { overflowY } = getComputedStyle(node)\n    if ((overflowY === 'auto' || overflowY === 'scroll') && node.scrollHeight > node.clientHeight)\n      return node\n  }\n  return null\n}\n\n/** Where the first line of a content element sits: its top and height. */\nexport function firstLine(content: HTMLElement): { top: number; height: number } {\n  const rect = content.getBoundingClientRect()\n  const style = getComputedStyle(content)\n  const lineHeight = Number.parseFloat(style.lineHeight)\n  const padding = Number.parseFloat(style.paddingTop) || 0\n  const height = Number.isFinite(lineHeight) ? Math.min(lineHeight, rect.height) : rect.height\n  return { top: rect.top + (height < rect.height ? padding : 0), height }\n}\n"],"mappings":";;;;;;;AAQA,SAAgB,UAAU,MAAkB,GAA+B;CACzE,MAAM,OAAO,KAAK,IAAI,iBAA8B,sBAAsB;CAC1E,IAAI,MAAM;CACV,IAAI,OAAO,KAAK,SAAS;CACzB,IAAI,QAAQ;CACZ,OAAO,OAAO,MAAM;EAClB,MAAM,SAAU,MAAM,QAAS;EAC/B,IAAI,KAAK,OAAO,CAAE,sBAAsB,CAAC,CAAC,OAAO,GAAG;GAClD,QAAQ;GACR,MAAM,SAAS;EACjB,OAAO,OAAO,SAAS;CACzB;CACA,OAAO,KAAK,KAAK,IAAI,OAAO,CAAC,MAAM;AACrC;;AAGA,SAAgB,eAAe,SAA0C;CACvE,OAAO,QAAQ,QAAqB,oBAAoB;AAC1D;;AAGA,SAAgB,aAAa,SAA0C;CACrE,KAAK,IAAI,OAAO,QAAQ,eAAe,MAAM,OAAO,KAAK,eAAe;EACtE,MAAM,EAAE,cAAc,iBAAiB,IAAI;EAC3C,KAAK,cAAc,UAAU,cAAc,aAAa,KAAK,eAAe,KAAK,cAC/E,OAAO;CACX;CACA,OAAO;AACT;;AAGA,SAAgB,UAAU,SAAuD;CAC/E,MAAM,OAAO,QAAQ,sBAAsB;CAC3C,MAAM,QAAQ,iBAAiB,OAAO;CACtC,MAAM,aAAa,OAAO,WAAW,MAAM,UAAU;CACrD,MAAM,UAAU,OAAO,WAAW,MAAM,UAAU,KAAK;CACvD,MAAM,SAAS,OAAO,SAAS,UAAU,IAAI,KAAK,IAAI,YAAY,KAAK,MAAM,IAAI,KAAK;CACtF,OAAO;EAAE,KAAK,KAAK,OAAO,SAAS,KAAK,SAAS,UAAU;EAAI;CAAO;AACxE"}

package/dist/editor.js

@@ -0,0 +1,33 @@
+import { inject, onBeforeUnmount, provide, shallowReactive, shallowRef } from "vue";
+// src/editor.ts
+var editorKey = Symbol("DouEditor");
+var toolbarMenusKey = Symbol("DouEditorToolbarMenus");
+/** For the formatting toolbar: the open state of the menus in it. */
+function provideToolbarMenus() {
+	const menus = shallowReactive(/* @__PURE__ */ new Set());
+	provide(toolbarMenusKey, menus);
+	return menus;
+}
+/**
+* The open state for a menu in the formatting toolbar (an extension's
+* `toolbar` component), to bind with `v-model:open`: the toolbar stays
+* while the menu is open, though the focus has left the editor.
+*/
+function useToolbarMenu() {
+	const open = shallowRef(false);
+	const menus = inject(toolbarMenusKey, null);
+	if (menus) {
+		menus.add(open);
+		onBeforeUnmount(() => menus.delete(open));
+	}
+	return open;
+}
+/** The editor around a block component, for its messages, state and view. */
+function useEditor() {
+	const context = inject(editorKey, null);
+	if (!context) throw new Error("[@dou-ui/editor] useEditor() must be called inside <DouEditor>");
+	return context;
+}
+export { editorKey, provideToolbarMenus, useEditor, useToolbarMenu };
+
+//# sourceMappingURL=editor.js.map

package/dist/editor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"editor.js","names":[],"sources":["../src/editor.ts"],"sourcesContent":["import type { EditorState, Command, Plugin } from 'prosemirror-state'\nimport type { EditorView } from 'prosemirror-view'\nimport type { CommentAction, CommentAuthor, CommentThread } from 'dou-ui'\nimport {\n  inject,\n  onBeforeUnmount,\n  provide,\n  shallowReactive,\n  shallowRef,\n  type ComputedRef,\n  type InjectionKey,\n  type ShallowRef,\n} from 'vue'\nimport type { CommentAnchor, CommentRange } from './core/comments'\nimport type { EditorExtension, ResolvedEditorExtensions } from './core/extension'\nimport type { BlockChanges } from './core/changes'\nimport type { Block, EditorDocument, PartialBlock } from './core/model'\nimport type { EditorSearchQuery } from './core/search'\nimport type {\n  BlockEdge,\n  BlockPatch,\n  BlockPlacement,\n  EditorTransaction,\n  EditorTransactionMeta,\n} from './core/transaction'\nimport type { EditorMessages, EditorMessagesOverride } from './locale'\n\nexport interface EditorProps {\n  /**\n   * The document, bound with `v-model`. With collaboration the shared\n   * document is the source of truth: leave `v-model` out and read changes\n   * from the `change` event.\n   */\n  modelValue?: EditorDocument<PartialBlock>\n  /**\n   * Blocks, marks, shortcuts and menu entries. Defaults to `[editorKit()]`;\n   * read once, when the editor mounts.\n   */\n  extensions?: (EditorExtension | EditorExtension[])[]\n  /** Show the document without editing it. Links stay clickable. */\n  readonly?: boolean\n  /** The built-in find panel (`Ctrl/⌘+F`). Off, the keys are left to the browser. On by default. */\n  searchable?: boolean\n  /** The hint in the empty block under the cursor. */\n  placeholder?: string\n  /** Replace any of the built-in texts. */\n  messages?: EditorMessagesOverride\n  /** The accessible name of the editing area. */\n  ariaLabel?: string\n  /** Focus the editor once it is mounted. */\n  autofocus?: boolean\n  /**\n   * Extra ProseMirror plugins, e.g. for collaboration. They run before\n   * the built-in ones, so their keys win.\n   */\n  plugins?: Plugin[]\n  /** Leave out the built-in undo history (collaboration brings its own). */\n  history?: boolean\n  /** Undo and redo commands to replace the built-in ones. */\n  undo?: Command\n  redo?: Command\n  /**\n   * The comment threads, bound with `v-model:comments`. The text a thread\n   * is about carries its id in the document; leave this out to turn\n   * comments off.\n   */\n  comments?: CommentThread[]\n  /** Who is commenting. Without it comments can be read but not written. */\n  author?: CommentAuthor\n  /** The id of the thread shown beside its text, bound with `v-model:activeComment`. */\n  activeComment?: string | null\n  /** Whether threads can be started and answered; also while `readonly`. Defaults to `true`. */\n  commentable?: boolean\n  /**\n   * An older version of the document, e.g. one the app saved. The editor\n   * then shows the document read-only, with what changed since marked:\n   * blocks added and removed, and in each changed block the text added\n   * and removed. Blocks are matched by `id`; a block without one shows as\n   * removed.\n   */\n  compare?: EditorDocument<PartialBlock> | null\n  /**\n   * The block with the cursor and the selected blocks, bound with\n   * `v-model:selection`. Setting it puts the cursor at the end of `block`,\n   * or selects `blocks` when there are several siblings, without focusing.\n   */\n  selection?: EditorSelection\n}\n\n/**\n * Who made a change: `'external'` for a new `v-model` value or\n * `setBlocks`, `'remote'` for a collaborator's, `'restore'` for `restore`,\n * `'undo'` and `'redo'`, or\n * the `origin` given to `transact`. Typing and the editor's own commands\n * leave it out.\n */\nexport type EditorOrigin = 'external' | 'remote' | 'restore' | 'undo' | 'redo' | (string & {})\n\n/** What a change to the document did, as the `transaction` event hands it over. */\nexport interface EditorTransactionResult {\n  /** The document after the change, as `update:modelValue` gets it next. */\n  blocks: Block[]\n  /** The blocks the change touched, by id. */\n  changes: BlockChanges\n  meta: {\n    origin?: EditorOrigin\n    /** Whether undo can take the change back: not for others' changes, nor for undo and redo themselves. */\n    history: boolean\n  }\n}\n\n/** Where the selection is, by block. */\nexport interface EditorSelection {\n  /** The innermost block at the cursor (the moving end of a selection); `null` while none is. */\n  block: string | null\n  /**\n   * The blocks the selection covers: the selected blocks, or the blocks a\n   * text selection runs across, at the level they share.\n   */\n  blocks: string[]\n}\n\nexport interface EditorEmits {\n  'update:modelValue': [document: EditorDocument]\n  /** The document changed: typing, formatting, moving blocks. */\n  change: [document: EditorDocument]\n  /** Every change to the document, with what it touched; `update:modelValue` follows. */\n  transaction: [result: EditorTransactionResult]\n  /** The cursor moved to another block, or other blocks were selected. */\n  'update:selection': [selection: EditorSelection]\n  /** Before a link opens (Ctrl / ⌘ + click, or a click while read-only); `preventDefault()` keeps it from opening in a new tab. */\n  linkOpen: [event: EditorLinkOpenEvent]\n  focus: [event: FocusEvent]\n  blur: [event: FocusEvent]\n  'update:comments': [threads: CommentThread[]]\n  'update:activeComment': [id: string | null]\n  /** A change to the comments made here: to send to a server, notify people, keep a log. */\n  commentAction: [action: CommentAction]\n}\n\n/**\n * Before a link is followed. `preventDefault()` stops the editor from\n * opening it in a new tab, e.g. to use the app's router or ask first.\n */\nexport interface EditorLinkOpenEvent {\n  /** The address as the text's `link` holds it. */\n  link: string\n  /** The id of the block the link is in. */\n  block: string\n  defaultPrevented: boolean\n  preventDefault: () => void\n}\n\nexport interface EditorExpose {\n  /** The ProseMirror view, once mounted. */\n  readonly view: EditorView | null\n  focus: () => void\n  blur: () => void\n  /** The current document. */\n  getBlocks: () => Block[]\n  /** Replace the document. The change does not go into the undo history. */\n  setBlocks: (blocks: PartialBlock[]) => void\n  /** The current document as HTML, written by the extensions (see `blocksToHTML`). */\n  getHTML: () => string\n  /** Replace the document with HTML, read like pasted HTML. */\n  setHTML: (html: string) => void\n  /** Run a ProseMirror command, e.g. one of the exported ones. */\n  run: (command: Command) => boolean\n  /**\n   * Opens the find panel (`Ctrl/⌘+F`), with a query put in; with `replace`\n   * in it, the replace box opens too. `false` when `searchable` is off or\n   * the editor is not mounted.\n   */\n  openSearch: (query?: Partial<EditorSearchQuery>) => boolean\n  /** Closes the find panel; `false` when it was not open. */\n  closeSearch: () => boolean\n  /**\n   * Make changes by blocks and ids, applied together as one undo step.\n   * Returns what happened, or `null` when nothing changed. Works while\n   * read-only too.\n   */\n  transact: (\n    fn: (tr: EditorTransaction) => void,\n    meta?: EditorTransactionMeta,\n  ) => EditorTransactionResult | null\n  /** One block, or `null` when there is none with that id. */\n  getBlock: (id: string) => Block | null\n  /**\n   * Insert blocks, by default after the block with the cursor. Returns the\n   * new blocks' ids (an id already in use is replaced). One undo step.\n   */\n  insertBlocks: (blocks: PartialBlock[], placement?: BlockPlacement) => string[]\n  /** Change a block's type, props (merged), content or children. One undo step. */\n  updateBlock: (id: string, patch: BlockPatch) => boolean\n  /** Remove blocks with their children. One undo step. */\n  removeBlocks: (ids: string[]) => boolean\n  /** Move blocks, in the order given, before, after or into another block. One undo step. */\n  moveBlocks: (ids: string[], placement: BlockPlacement) => boolean\n  /** Focus the editor with the cursor at the start or end (the default) of a block, scrolled into view. */\n  focusBlock: (id: string, edge?: BlockEdge) => boolean\n  /** The selection by block, as `v-model:selection` has it. */\n  getSelection: () => EditorSelection\n  undo: () => boolean\n  redo: () => boolean\n  readonly canUndo: boolean\n  readonly canRedo: boolean\n  /**\n   * Start a thread on the selected text and open the box for its first\n   * comment; with the cursor on commented text, open that thread to reply.\n   */\n  comment: () => boolean\n  /** Where each thread is anchored; `null` for a thread whose text was deleted. */\n  getCommentAnchors: () => Record<string, CommentAnchor | null>\n  /**\n   * Replace the document with `doc`, e.g. an older version, as one\n   * change undo takes back. With collaboration only the blocks that differ\n   * are written, and everyone sees it. The `transaction` event has origin\n   * `'restore'`. Like the other methods it works while `readonly`; it is\n   * the one change allowed while comparing. Returns `false` when nothing\n   * differs.\n   */\n  restore: (doc: EditorDocument<PartialBlock>) => boolean\n  /** With `compare`: scroll to the next change after the one last shown; `false` when there is none. */\n  nextChange: () => boolean\n  /** With `compare`: scroll to the change before the one last shown. */\n  previousChange: () => boolean\n}\n\n/** The comments, as the parts around the editing area see them. */\nexport interface EditorComments {\n  /** Comments are on: there are threads to show. */\n  enabled: ComputedRef<boolean>\n  /** Threads can be started and answered. */\n  writable: ComputedRef<boolean>\n  threads: ComputedRef<readonly CommentThread[]>\n  author: ComputedRef<CommentAuthor | undefined>\n  /** The thread shown beside its text. */\n  active: ComputedRef<string | null>\n  /** The text a new thread is being started on. */\n  pending: ShallowRef<CommentRange | null>\n  /** Goes up when the open thread's reply box should take focus. */\n  focusRequest: ShallowRef<number>\n  /** The selected text, also in a read-only editor; `null` when there is none. */\n  selection: () => CommentRange | null\n  /** Start a thread on the selected text, or open the one the cursor is in. */\n  start: () => boolean\n  apply: (action: CommentAction) => void\n  open: (id: string | null) => void\n  /** Close the card, dropping a thread not yet started. */\n  close: () => void\n}\n\n/** What the parts around the editing area (menus, handle, toolbar) share. */\nexport interface EditorContext {\n  view: ShallowRef<EditorView | null>\n  /** Updated on every transaction, so computeds follow the selection too. */\n  state: ShallowRef<EditorState | null>\n  focused: ShallowRef<boolean>\n  /** Blocks are being dragged by the handle. */\n  dragging: ShallowRef<boolean>\n  editable: ComputedRef<boolean>\n  messages: ComputedRef<EditorMessages>\n  /** What the extensions contribute: schema, menu entries, toolbar toggles. */\n  kit: ResolvedEditorExtensions\n  /** The element the overlays are positioned against. */\n  root: ShallowRef<HTMLElement | null>\n  comments: EditorComments\n}\n\nexport const editorKey: InjectionKey<EditorContext> = Symbol('DouEditor')\n\nconst toolbarMenusKey: InjectionKey<Set<ShallowRef<boolean>>> = Symbol('DouEditorToolbarMenus')\n\n/** For the formatting toolbar: the open state of the menus in it. */\nexport function provideToolbarMenus(): Set<ShallowRef<boolean>> {\n  const menus = shallowReactive(new Set<ShallowRef<boolean>>())\n  provide(toolbarMenusKey, menus)\n  return menus\n}\n\n/**\n * The open state for a menu in the formatting toolbar (an extension's\n * `toolbar` component), to bind with `v-model:open`: the toolbar stays\n * while the menu is open, though the focus has left the editor.\n */\nexport function useToolbarMenu(): ShallowRef<boolean> {\n  const open = shallowRef(false)\n  const menus = inject(toolbarMenusKey, null)\n  if (menus) {\n    menus.add(open)\n    onBeforeUnmount(() => menus.delete(open))\n  }\n  return open\n}\n\n/** The editor around a block component, for its messages, state and view. */\nexport function useEditor(): EditorContext {\n  const context = inject(editorKey, null)\n  if (!context) throw new Error('[@dou-ui/editor] useEditor() must be called inside <DouEditor>')\n  return context\n}\n"],"mappings":";;AA6QA,IAAa,YAAyC,OAAO,WAAW;AAExE,IAAM,kBAA0D,OAAO,uBAAuB;;AAG9F,SAAgB,sBAAgD;CAC9D,MAAM,QAAQ,gCAAgB,IAAI,IAAyB,CAAC;CAC5D,QAAQ,iBAAiB,KAAK;CAC9B,OAAO;AACT;;;;;;AAOA,SAAgB,iBAAsC;CACpD,MAAM,OAAO,WAAW,KAAK;CAC7B,MAAM,QAAQ,OAAO,iBAAiB,IAAI;CAC1C,IAAI,OAAO;EACT,MAAM,IAAI,IAAI;EACd,sBAAsB,MAAM,OAAO,IAAI,CAAC;CAC1C;CACA,OAAO;AACT;;AAGA,SAAgB,YAA2B;CACzC,MAAM,UAAU,OAAO,WAAW,IAAI;CACtC,IAAI,CAAC,SAAS,MAAM,IAAI,MAAM,gEAAgE;CAC9F,OAAO;AACT"}