tsondb 0.8.4 → 0.9.0

package/dist/src/shared/utils/markdown.js

@@ -24,7 +24,7 @@ const boldWithItalicRule = {
     }),
 };
 const italicWithBoldRule = {
-    pattern: /(?<![\\*]|[\\*]\*.*)\*(?=\*\*|[^*])([^*]*?\*\*[^*]*?\*\*[^*]*?)(?<=[^\\*]|[^\\]\*\*)\*(?!\*)/,
+    pattern: /(?<![\\*]|[^\\]\*.*)\*(?=\*\*|[^*])([^*]*?\*\*[^*]*?\*\*[^*]*?)(?<=[^\\*]|[^\\]\*\*)\*(?!\*)/,
     map: (result, parseInside) => ({
         kind: "italic",
         content: parseInside(result[1] ?? ""),
@@ -494,7 +494,7 @@ const addIndentationToSyntax = (nodes, nextUpperNode) => nodes.reduce((accNodes,
     }
 }, []);
 const footnoteRule = {
-    pattern: /^\[\^([a-zA-Z0-9*]+?)\]: (.+?(?:\n(?: {2}.+)?)*)(\n{2,}|\s*$)/,
+    pattern: /^\[\^([a-zA-Z0-9]+?)\]: (.+?(?:\n(?: {2}.+)?)*)(\n{2,}|\s*$)/,
     map: ([_match, label = "", content = "", _trailingWhitespace]) => ({
         kind: "footnote",
         label: label,

package/dist/src/web/components/InstanceRouteSkeleton.d.ts

@@ -12,6 +12,21 @@ export type InstanceRouteSkeletonInitializer = (values: {
     setInstanceContent: Dispatch<SetStateAction<unknown>>;
     getDeclFromDeclName: GetDeclFromDeclName;
 }) => Promise<void>;
+export type InstanceRouteSkeletonSubmitHandler<A extends string = string> = (values: {
+    locales: string[];
+    entity: SerializedEntityDecl;
+    instanceId: string | undefined;
+    instanceContent: unknown;
+    action: A;
+    customId: string;
+    isLocaleEntity: boolean | undefined;
+    childInstances: UnsafeEntityTaggedInstanceContainerWithChildInstances[];
+    route: LocationHook["route"];
+    setInstanceContent: Dispatch<SetStateAction<unknown>>;
+    setCustomId: Dispatch<SetStateAction<string>>;
+    getDeclFromDeclName: GetDeclFromDeclName;
+    updateLocalGitState?: () => Promise<void>;
+}) => Promise<void>;
 export type InstanceRouteSkeletonOnSubmitHandler = (values: {
     locales: string[];
     entity: SerializedEntityDecl;
@@ -27,6 +42,20 @@ export type InstanceRouteSkeletonOnSubmitHandler = (values: {
     getDeclFromDeclName: GetDeclFromDeclName;
     updateLocalGitState?: () => Promise<void>;
 }) => Promise<void>;
+export type InstanceRouteSkeletonOnSaveHandler = (values: {
+    locales: string[];
+    entity: SerializedEntityDecl;
+    instanceId: string | undefined;
+    instanceContent: unknown;
+    customId: string;
+    isLocaleEntity: boolean | undefined;
+    childInstances: UnsafeEntityTaggedInstanceContainerWithChildInstances[];
+    route: LocationHook["route"];
+    setInstanceContent: Dispatch<SetStateAction<unknown>>;
+    setCustomId: Dispatch<SetStateAction<string>>;
+    getDeclFromDeclName: GetDeclFromDeclName;
+    updateLocalGitState?: () => Promise<void>;
+}) => Promise<void>;
 export type InstanceRouteSkeletonTitleBuilder = (values: {
     locales: string[];
     entity: SerializedEntityDecl;
@@ -43,6 +72,7 @@ type Props = {
     init: InstanceRouteSkeletonInitializer;
     titleBuilder: InstanceRouteSkeletonTitleBuilder;
     onSubmit: InstanceRouteSkeletonOnSubmitHandler;
+    onSave: InstanceRouteSkeletonOnSaveHandler;
 };
 export declare const InstanceRouteSkeleton: FunctionalComponent<Props>;
 export {};

package/dist/src/web/components/InstanceRouteSkeleton.js

@@ -24,7 +24,11 @@ const onBeforeUnload = (event) => {
     // eslint-disable-next-line @typescript-eslint/no-deprecated -- best practice according to MDN
     event.returnValue = "unsaved changes";
 };
-export const InstanceRouteSkeleton = ({ mode, buttons, init, titleBuilder, onSubmit, }) => {
+const applePlatformPattern = /(Mac|iPhone|iPod|iPad)/i;
+// eslint-disable-next-line @typescript-eslint/no-deprecated
+const isApplePlatform = () => applePlatformPattern.test(window.navigator.platform);
+const checkCmdOrCtrl = (event) => (isApplePlatform() ? event.metaKey : event.ctrlKey);
+export const InstanceRouteSkeleton = ({ mode, buttons, init, titleBuilder, onSubmit, onSave, }) => {
     const { params: { name, id }, } = useRoute();
     const [locales] = useSetting("displayedLocales");
     const [getDeclFromDeclName, declsLoaded] = useGetDeclFromDeclName();
@@ -38,6 +42,42 @@ export const InstanceRouteSkeleton = ({ mode, buttons, init, titleBuilder, onSub
     const client = useContext(GitClientContext);
     const { route } = useLocation();
     const hasUnsavedChanges = useMemo(() => !deepEqual(instanceContent, savedInstanceContent), [instanceContent, savedInstanceContent]);
+    const saveHandler = useCallback((event) => {
+        if (checkCmdOrCtrl(event) && event.key === "s" && entity && instanceContent !== undefined) {
+            event.preventDefault();
+            runWithLoading(() => onSave({
+                locales,
+                entity,
+                instanceId: id,
+                instanceContent,
+                route,
+                customId,
+                getDeclFromDeclName,
+                isLocaleEntity,
+                setCustomId,
+                setInstanceContent: value => {
+                    setInstanceContent(value);
+                    setSavedInstanceContent(value);
+                },
+                childInstances,
+                updateLocalGitState: client?.updateLocalState,
+            })).catch((error) => {
+                console.error("Error submitting instance data:", error);
+            });
+        }
+    }, [
+        childInstances,
+        client?.updateLocalState,
+        customId,
+        entity,
+        getDeclFromDeclName,
+        id,
+        instanceContent,
+        isLocaleEntity,
+        locales,
+        onSave,
+        route,
+    ]);
     useEffect(() => {
         if (hasUnsavedChanges) {
             window.addEventListener("beforeunload", onBeforeUnload);
@@ -49,6 +89,17 @@ export const InstanceRouteSkeleton = ({ mode, buttons, init, titleBuilder, onSub
             window.removeEventListener("beforeunload", onBeforeUnload);
         };
     }, [hasUnsavedChanges]);
+    useEffect(() => {
+        if (hasUnsavedChanges) {
+            window.addEventListener("keydown", saveHandler);
+        }
+        else {
+            window.removeEventListener("keydown", saveHandler);
+        }
+        return () => {
+            window.removeEventListener("keydown", saveHandler);
+        };
+    }, [hasUnsavedChanges, saveHandler]);
     useEffect(() => {
         document.title =
             (entity && titleBuilder({ locales, entity, instanceContent, instanceId: id })) ??

package/dist/src/web/routes/CreateInstance.js

@@ -11,32 +11,30 @@ const titleBuilder = ({ entity }) => {
     const entityName = entity.name;
     return "New " + toTitleCase(entityName) + " — TSONDB";
 };
-const onSubmit = async ({ locales, entity, buttonName, instanceContent, isLocaleEntity, customId, childInstances, setInstanceContent, setCustomId, route, getDeclFromDeclName, updateLocalGitState, }) => {
+const submit = async ({ locales, entity, action, instanceContent, isLocaleEntity, customId, childInstances, setInstanceContent, setCustomId, route, getDeclFromDeclName, updateLocalGitState, }) => {
     try {
-        if (buttonName) {
-            const createdInstance = await createInstanceByEntityNameAndId(locales, entity.name, {
-                childInstances,
-                entityName: entity.name,
-                content: instanceContent,
-                id: undefined,
-            }, isLocaleEntity ? customId : undefined);
-            await updateLocalGitState?.();
-            switch (buttonName) {
-                case "saveandcontinue": {
-                    route(`/entities/${entity.name}/instances/${createdInstance.instance.id}`);
-                    setInstanceContent(createdInstance.instance.content);
-                    break;
-                }
-                case "saveandaddanother": {
-                    setInstanceContent(createTypeSkeleton(getDeclFromDeclName, entity.type));
-                    setCustomId("");
-                    alert(`Instance of entity ${entity.name} created successfully with identifier ${createdInstance.instance.id}. You can add another instance now.`);
-                    break;
-                }
-                case "save": {
-                    route(`/entities/${entity.name}?created=${encodeURIComponent(createdInstance.instance.id)}`);
-                    break;
-                }
+        const createdInstance = await createInstanceByEntityNameAndId(locales, entity.name, {
+            childInstances,
+            entityName: entity.name,
+            content: instanceContent,
+            id: undefined,
+        }, isLocaleEntity ? customId : undefined);
+        await updateLocalGitState?.();
+        switch (action) {
+            case "saveandcontinue": {
+                route(`/entities/${entity.name}/instances/${createdInstance.instance.id}`);
+                setInstanceContent(createdInstance.instance.content);
+                break;
+            }
+            case "saveandaddanother": {
+                setInstanceContent(createTypeSkeleton(getDeclFromDeclName, entity.type));
+                setCustomId("");
+                alert(`Instance of entity ${entity.name} created successfully with identifier ${createdInstance.instance.id}. You can add another instance now.`);
+                break;
+            }
+            case "save": {
+                route(`/entities/${entity.name}?created=${encodeURIComponent(createdInstance.instance.id)}`);
+                break;
             }
         }
     }
@@ -46,8 +44,16 @@ const onSubmit = async ({ locales, entity, buttonName, instanceContent, isLocale
         }
     }
 };
+const onSubmit = async ({ buttonName, ...other }) => {
+    if (buttonName === "save" ||
+        buttonName === "saveandcontinue" ||
+        buttonName === "saveandaddanother") {
+        await submit({ ...other, action: buttonName });
+    }
+};
+const onSave = other => submit({ ...other, action: "saveandcontinue" });
 export const CreateInstance = () => (_jsx(InstanceRouteSkeleton, { mode: "create", buttons: [
         { label: "Save", name: "save", primary: true },
         { label: "Save and continue", name: "saveandcontinue" },
         { label: "Save and add another", name: "saveandaddanother" },
-    ], init: init, titleBuilder: titleBuilder, onSubmit: onSubmit }));
+    ], init: init, titleBuilder: titleBuilder, onSubmit: onSubmit, onSave: onSave }));

package/dist/src/web/routes/Instance.js

@@ -21,9 +21,9 @@ const titleBuilder = ({ locales, entity, instanceId, instanceContent, }) => {
     }
     return undefined;
 };
-const onSubmit = async ({ locales, entity, instanceId, instanceContent, buttonName, childInstances, route, updateLocalGitState, setInstanceContent, }) => {
+const submit = async ({ action, locales, entity, instanceId, instanceContent, childInstances, route, updateLocalGitState, setInstanceContent, }) => {
     try {
-        if (instanceId && buttonName) {
+        if (instanceId) {
             await updateInstanceByEntityNameAndId(locales, entity.name, instanceId, {
                 childInstances,
                 entityName: entity.name,
@@ -31,7 +31,7 @@ const onSubmit = async ({ locales, entity, instanceId, instanceContent, buttonNa
                 id: instanceId,
             });
             await updateLocalGitState?.();
-            switch (buttonName) {
+            switch (action) {
                 case "saveandcontinue": {
                     setInstanceContent(instanceContent);
                     break;
@@ -49,9 +49,15 @@ const onSubmit = async ({ locales, entity, instanceId, instanceContent, buttonNa
         }
     }
 };
+const onSubmit = async ({ buttonName, ...other }) => {
+    if (buttonName === "save" || buttonName === "saveandcontinue") {
+        await submit({ ...other, action: buttonName });
+    }
+};
+const onSave = other => submit({ ...other, action: "saveandcontinue" });
 export const Instance = () => {
     return (_jsx(InstanceRouteSkeleton, { mode: "edit", buttons: [
             { label: "Save", name: "save", primary: true },
             { label: "Save and continue", name: "saveandcontinue" },
-        ], init: init, titleBuilder: titleBuilder, onSubmit: onSubmit }));
+        ], init: init, titleBuilder: titleBuilder, onSubmit: onSubmit, onSave: onSave }));
 };

package/dist/src/web/utils/BlockMarkdown.d.ts

@@ -4,6 +4,7 @@ type Props = {
     node: BlockMarkdownNode;
     outerHeadingLevel?: number;
     insertBefore?: preact.ComponentChildren;
+    footnoteLabelSuffix?: string;
 };
 export declare const BlockMarkdown: FunctionalComponent<Props>;
 export {};

package/dist/src/web/utils/BlockMarkdown.js

@@ -1,8 +1,10 @@
+import { createElement as _createElement } from "preact";
 import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "preact/jsx-runtime";
 import { checkTableRowsAreSections, } from "../../shared/utils/markdown.js";
 import { assertExhaustive } from "../../shared/utils/typeSafety.js";
 import { InlineMarkdown } from "./InlineMarkdown.js";
-export const BlockMarkdown = ({ node, outerHeadingLevel = 0, insertBefore, }) => {
+export const BlockMarkdown = ({ node, outerHeadingLevel = 0, insertBefore, footnoteLabelSuffix = ")", }) => {
+    const inheritableProps = { outerHeadingLevel, footnoteLabelSuffix };
     switch (node.kind) {
         case "paragraph":
             return (_jsxs("p", { children: [insertBefore, node.content.map((inline, ii) => (_jsx(InlineMarkdown, { node: inline }, ii)))] }));
@@ -19,13 +21,14 @@ export const BlockMarkdown = ({ node, outerHeadingLevel = 0, insertBefore, }) =>
         case "table":
             return (_jsxs(_Fragment, { children: [insertBefore, _jsxs("table", { children: [node.caption !== undefined && (_jsx("caption", { children: node.caption.map((inline, ci) => (_jsx(InlineMarkdown, { node: inline }, ci))) })), _jsx("thead", { children: _jsx(TableRow, { columns: node.columns, cells: node.header, cellType: "th" }) }), checkTableRowsAreSections(node.rows) ? (node.rows.map((section, si) => (_jsxs("tbody", { children: [section.header && (_jsx(TableRow, { columns: node.columns, cells: section.header, cellType: "th" })), section.rows.map((row, ri) => (_jsx(TableRow, { columns: node.columns, cells: row.cells }, ri)))] }, si)))) : (_jsx("tbody", { children: node.rows.map((row, ri) => (_jsx(TableRow, { columns: node.columns, cells: row.cells }, ri))) }))] })] }));
         case "container":
-            return (_jsxs("div", { class: node.name, children: [insertBefore, node.content.map((childNode, i) => (_jsx(BlockMarkdown, { node: childNode, outerHeadingLevel: outerHeadingLevel }, i)))] }));
+            return (_jsxs("div", { class: node.name, children: [insertBefore, node.content.map((childNode, i) => (_createElement(BlockMarkdown, { ...inheritableProps, key: i, node: childNode })))] }));
         case "footnote": {
-            const label = (_jsxs(_Fragment, { children: [_jsxs("span", { class: "footnote-label", children: [node.label, /^\*+$/.test(node.label) ? ")" : ":"] }), " "] }));
-            return (_jsxs("div", { role: "note", children: [insertBefore, node.content.map((n, i) => (_jsx(BlockMarkdown, { node: n, outerHeadingLevel: outerHeadingLevel, insertBefore: label }, i)))] }));
+            const isNumeric = /^\d+$/.test(node.label);
+            const label = (_jsxs(_Fragment, { children: [_jsxs("span", { class: "footnote-label" + (isNumeric ? " footnote-label--numeric" : ""), "data-reference": node.label, children: [node.label, footnoteLabelSuffix] }), " "] }));
+            return (_jsxs("div", { role: "note", children: [insertBefore, node.content.map((n, i) => (_createElement(BlockMarkdown, { ...inheritableProps, key: i, node: n, insertBefore: label })))] }));
         }
         case "definitionList":
-            return (_jsxs(_Fragment, { children: [insertBefore, _jsx("dl", { children: node.content.map((item, ii) => (_jsxs("div", { children: [item.terms.map((term, ti) => (_jsx("dt", { children: term.map((inline, iii) => (_jsx(InlineMarkdown, { node: inline }, iii))) }, ti))), item.definitions.map((definition, di) => (_jsx("dd", { children: definition.map((n, i) => (_jsx(BlockMarkdown, { node: n, outerHeadingLevel: outerHeadingLevel }, i))) }, di)))] }, ii))) })] }));
+            return (_jsxs(_Fragment, { children: [insertBefore, _jsx("dl", { children: node.content.map((item, ii) => (_jsxs("div", { children: [item.terms.map((term, ti) => (_jsx("dt", { children: term.map((inline, iii) => (_jsx(InlineMarkdown, { node: inline }, iii))) }, ti))), item.definitions.map((definition, di) => (_jsx("dd", { children: definition.map((n, i) => (_createElement(BlockMarkdown, { ...inheritableProps, key: i, node: n }))) }, di)))] }, ii))) })] }));
         default:
             return assertExhaustive(node);
     }

package/dist/src/web/utils/InlineMarkdown.js

@@ -22,8 +22,10 @@ export const InlineMarkdown = ({ node }) => {
             const trailingNodes = node.content.slice(attributesEnd);
             return (_jsxs("span", { class: "attributed", ...Object.fromEntries(Object.entries(node.attributes).map(([k, v]) => [`data-${k}`, v.toString()])), children: [leadingNodes.map((inline, i) => (_jsx(InlineMarkdown, { node: inline }, i))), Array.from({ length: count }, (_, i) => (_jsxs(Fragment, { children: [_jsx("span", { class: "attributed__name", children: _jsx(InlineMarkdown, { node: attributes[i * 4] ?? emptyNode }) }), _jsx("span", { class: "attributed__separator", children: _jsx(InlineMarkdown, { node: attributes[i * 4 + 1] ?? emptyNode }) }), _jsx("span", { class: "attributed__value", children: _jsx(InlineMarkdown, { node: attributes[i * 4 + 2] ?? emptyNode }) }), i < count - 1 && (_jsx("span", { class: "attributed__separator", children: _jsx(InlineMarkdown, { node: attributes[i * 4 + 3] ?? emptyNode }) }))] }, `attr-${(i + 1).toString()}`))), trailingNodes.map((inline, i) => (_jsx(InlineMarkdown, { node: inline }, i)))] }));
         }
-        case "footnoteRef":
-            return /^\*+$/.test(node.label) ? (_jsx("span", { class: "footnote-ref", children: node.label })) : (_jsx("sup", { class: "footnote-ref", children: node.label }));
+        case "footnoteRef": {
+            const isNumeric = /^\d+$/.test(node.label);
+            return (_jsx("sup", { class: "footnote-ref" + (isNumeric ? " footnote-ref--numeric" : ""), "data-reference": node.label, children: node.label }));
+        }
         case "text":
             return node.content;
         default:

package/dist/src/web/utils/Markdown.d.ts

@@ -3,6 +3,7 @@ type Props = {
     class?: string;
     string: string;
     outerHeadingLevel?: number;
+    footnoteLabelSuffix?: string;
 };
 export declare const Markdown: FunctionalComponent<Props>;
 export {};

package/dist/src/web/utils/Markdown.js

@@ -1,9 +1,9 @@
 import { jsx as _jsx, Fragment as _Fragment } from "preact/jsx-runtime";
 import { parseBlockMarkdown } from "../../shared/utils/markdown.js";
 import { BlockMarkdown } from "./BlockMarkdown.js";
-export const Markdown = ({ class: className, string, outerHeadingLevel, }) => {
+export const Markdown = ({ class: className, string, outerHeadingLevel, footnoteLabelSuffix, }) => {
     const blocks = parseBlockMarkdown(string);
-    const blockElements = blocks.map((block, i) => (_jsx(BlockMarkdown, { node: block, outerHeadingLevel: outerHeadingLevel }, `md-block-${i.toString()}`)));
+    const blockElements = blocks.map((block, i) => (_jsx(BlockMarkdown, { node: block, outerHeadingLevel: outerHeadingLevel, footnoteLabelSuffix: footnoteLabelSuffix }, `md-block-${i.toString()}`)));
     if (className) {
         return _jsx("div", { class: className, children: blockElements });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tsondb",
-  "version": "0.8.4",
+  "version": "0.9.0",
   "description": "",
   "license": "ISC",
   "author": "Lukas Obermann",