@heyramzi/ui 2.11.0 → 2.11.2

package/dist/work/docs/menu.js

@@ -1,121 +1,128 @@
+/**
+* The `…` menu as data: which items exist, which show, how a filter reads them and
+* which keys fire them. The component only draws what this returns.
+*/
 import { tiptapToMarkdown } from "../../editor/markdown.js";
 export const SHORTCUTS = {
-    move: {
-        key: "P",
-        shift: true
-    },
-    rename: {
-        key: "R",
-        shift: true
-    },
-    favorite: {
-        key: "F",
-        alt: true
-    },
-    remind: {
-        key: "H",
-        shift: true
-    }
+	move: {
+		key: "P",
+		shift: true
+	},
+	rename: {
+		key: "R",
+		shift: true
+	},
+	favorite: {
+		key: "F",
+		alt: true
+	},
+	remind: {
+		key: "H",
+		shift: true
+	}
 };
+/** "⇧P", "⌥F". */
 export function shortcutLabel(shortcut) {
-    return `${shortcut.shift ? "⇧" : ""}${shortcut.alt ? "⌥" : ""}${shortcut.key.toUpperCase()}`;
+	return `${shortcut.shift ? "⇧" : ""}${shortcut.alt ? "⌥" : ""}${shortcut.key.toUpperCase()}`;
 }
 export function menuItems(available, labels, options = {}) {
-    const all = [
-        {
-            id: "move",
-            label: labels.moveTo,
-            group: 0
-        },
-        {
-            id: "duplicate",
-            label: labels.duplicate,
-            group: 0
-        },
-        {
-            id: "rename",
-            label: labels.rename,
-            group: 0
-        },
-        {
-            id: "template",
-            label: labels.template,
-            group: 0
-        },
-        {
-            id: "favorite",
-            label: options.favorited ? labels.unfavorite : labels.favorite,
-            group: 1
-        },
-        {
-            id: "copy",
-            label: labels.copy,
-            submenu: true,
-            group: 1
-        },
-        {
-            id: "remind",
-            label: labels.remind,
-            group: 1
-        },
-        {
-            id: "history",
-            label: labels.history,
-            group: 2
-        },
-        {
-            id: "delete",
-            label: labels.delete,
-            danger: true,
-            group: 2
-        }
-    ];
-    return all.filter((item)=>available[item.id]).map((item)=>Object.assign(item, {
-            shortcut: SHORTCUTS[item.id]
-        }));
+	const all = [
+		{
+			id: "move",
+			label: labels.moveTo,
+			group: 0
+		},
+		{
+			id: "duplicate",
+			label: labels.duplicate,
+			group: 0
+		},
+		{
+			id: "rename",
+			label: labels.rename,
+			group: 0
+		},
+		{
+			id: "template",
+			label: labels.template,
+			group: 0
+		},
+		{
+			id: "favorite",
+			label: options.favorited ? labels.unfavorite : labels.favorite,
+			group: 1
+		},
+		{
+			id: "copy",
+			label: labels.copy,
+			submenu: true,
+			group: 1
+		},
+		{
+			id: "remind",
+			label: labels.remind,
+			group: 1
+		},
+		{
+			id: "history",
+			label: labels.history,
+			group: 2
+		},
+		{
+			id: "delete",
+			label: labels.delete,
+			danger: true,
+			group: 2
+		}
+	];
+	return all.filter((item) => available[item.id]).map((item) => Object.assign(item, { shortcut: SHORTCUTS[item.id] }));
 }
+/** Case-insensitive, every typed word must appear. An empty query keeps everything. */
 export function filterMenu(items, query) {
-    const words = query.toLowerCase().split(/\s+/).filter(Boolean);
-    if (words.length === 0) return items;
-    return items.filter((item)=>{
-        const label = item.label.toLowerCase();
-        return words.every((word)=>label.includes(word));
-    });
+	const words = query.toLowerCase().split(/\s+/).filter(Boolean);
+	if (words.length === 0) return items;
+	return items.filter((item) => {
+		const label = item.label.toLowerCase();
+		return words.every((word) => label.includes(word));
+	});
 }
+/** The item a key press fires, or null. `code` is the physical key, since Option+F types "ƒ". */
 export function shortcutTarget(event, items) {
-    if (event.metaKey || event.ctrlKey) return null;
-    const hit = items.find((item)=>item.shortcut && event.code === `Key${item.shortcut.key.toUpperCase()}` && !!item.shortcut.shift === event.shiftKey && !!item.shortcut.alt === event.altKey);
-    return hit?.id ?? null;
+	if (event.metaKey || event.ctrlKey) return null;
+	const hit = items.find((item) => item.shortcut && event.code === `Key${item.shortcut.key.toUpperCase()}` && !!item.shortcut.shift === event.shiftKey && !!item.shortcut.alt === event.altKey);
+	return hit?.id ?? null;
 }
+/** The Copy submenu. A kind with nothing to copy is left out: no URL, no content. */
 export function copyOptions(source, labels) {
-    const title = source.title.trim() || labels.untitled;
-    const options = [];
-    if (source.url) options.push({
-        kind: "url",
-        label: labels.copyUrl,
-        text: source.url
-    });
-    options.push({
-        kind: "title",
-        label: labels.copyTitle,
-        text: title
-    });
-    if (source.url) {
-        options.push({
-            kind: "link",
-            label: labels.copyTitleAsLink,
-            text: `[${title.replace(/([[\]\\])/g, "\\$1")}](${source.url})`
-        });
-    }
-    if (source.content) {
-        options.push({
-            kind: "markdown",
-            label: labels.copyMarkdown,
-            text: tiptapToMarkdown(source.content)
-        });
-    }
-    return options;
+	const title = source.title.trim() || labels.untitled;
+	const options = [];
+	if (source.url) options.push({
+		kind: "url",
+		label: labels.copyUrl,
+		text: source.url
+	});
+	options.push({
+		kind: "title",
+		label: labels.copyTitle,
+		text: title
+	});
+	if (source.url) {
+		options.push({
+			kind: "link",
+			label: labels.copyTitleAsLink,
+			text: `[${title.replace(/([[\]\\])/g, "\\$1")}](${source.url})`
+		});
+	}
+	if (source.content) {
+		options.push({
+			kind: "markdown",
+			label: labels.copyMarkdown,
+			text: tiptapToMarkdown(source.content)
+		});
+	}
+	return options;
 }
+/** What the delete confirm calls the doc. */
 export function deleteName(title, labels) {
-    return title.trim() || labels.untitled;
+	return title.trim() || labels.untitled;
 }

package/dist/work/docs/outline.js

@@ -1,39 +1,49 @@
+/**
+* The outline of a document: which headings it lists, and the anchor each one gets.
+* Pure, so the editor's anchors and the outline's ids can never disagree.
+*/
 import { anchorIds } from "../../editor/anchors.js";
 export { anchorIds, slugify } from "../../editor/anchors.js";
 function textOf(node) {
-    if (node.type === "text") return node.text ?? "";
-    return (node.content ?? []).map(textOf).join("");
+	if (node.type === "text") return node.text ?? "";
+	return (node.content ?? []).map(textOf).join("");
 }
+/** Every heading in document order, at any depth, with its anchor. */
 export function headingsOf(doc) {
-    const found = [];
-    const walk = (node)=>{
-        if (node.type === "heading") {
-            const level = typeof node.attrs?.level === "number" ? node.attrs.level : 1;
-            found.push({
-                label: textOf(node).trim(),
-                level
-            });
-            return;
-        }
-        for (const child of node.content ?? [])walk(child);
-    };
-    if (doc && typeof doc === "object") walk(doc);
-    const ids = anchorIds(found.map((heading)=>heading.label));
-    return found.map((heading, i)=>({
-            id: ids[i],
-            label: heading.label,
-            level: heading.level
-        }));
+	const found = [];
+	const walk = (node) => {
+		if (node.type === "heading") {
+			const level = typeof node.attrs?.level === "number" ? node.attrs.level : 1;
+			found.push({
+				label: textOf(node).trim(),
+				level
+			});
+			return;
+		}
+		for (const child of node.content ?? []) walk(child);
+	};
+	if (doc && typeof doc === "object") walk(doc);
+	const ids = anchorIds(found.map((heading) => heading.label));
+	return found.map((heading, i) => ({
+		id: ids[i],
+		label: heading.label,
+		level: heading.level
+	}));
 }
+/**
+* What the outline lists: H2 and H3 with a label. H1 and H4 are ignored, and a
+* document with fewer than two entries gets no outline at all.
+*/
 export function outlineOf(headings) {
-    const items = headings.filter((heading)=>(heading.level === 2 || heading.level === 3) && heading.label !== "");
-    if (items.length < 2) return [];
-    return items.map(({ id, label, level })=>({
-            id,
-            label,
-            level
-        }));
+	const items = headings.filter((heading) => (heading.level === 2 || heading.level === 3) && heading.label !== "");
+	if (items.length < 2) return [];
+	return items.map(({ id, label, level }) => ({
+		id,
+		label,
+		level
+	}));
 }
+/** The outline of a Tiptap document. */
 export function outlineOfDoc(doc) {
-    return outlineOf(headingsOf(doc));
+	return outlineOf(headingsOf(doc));
 }