hafez 2.1.0 → 2.3.0

package/dist/graph/copy-fonts.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/graph/copy-fonts.js

@@ -0,0 +1,13 @@
+// src/graph/copy-fonts.ts
+// Build step (#272), run as `node dist/graph/copy-fonts.js` after tsc: copy
+// the page's fonts and their licences from the devDependencies into
+// dist/graph/fonts/, where the server's `/fonts/` route reads them.
+import { copyFileSync, mkdirSync } from 'fs';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import { FONT_FILES } from './fonts.js';
+const root = join(dirname(fileURLToPath(import.meta.url)), '..', '..');
+const out = join(root, 'dist', 'graph', 'fonts');
+mkdirSync(out, { recursive: true });
+for (const [file, from] of FONT_FILES)
+    copyFileSync(join(root, 'node_modules', from), join(out, file));

package/dist/graph/fields.d.ts

@@ -0,0 +1,8 @@
+/** The optional Graph node fields queryGraph copies from an index row when set. */
+export declare const GRAPH_ROW_FIELDS: readonly ["type", "status", "subtype", "confidence", "last_touched", "description"];
+/** The optional Graph node fields queryGraph derives (#271): an Entity's signals
+ * and an Unlinked note's mark and placing slug. */
+export declare const GRAPH_SIGNAL_FIELDS: readonly ["open_actions", "stale", "stale_actions", "staleness_days", "unlinked", "best"];
+/** Every optional Graph node field: what the page's merge drops from a node a
+ * refresh no longer gives it. */
+export declare const GRAPH_NODE_FIELDS: readonly ["type", "status", "subtype", "confidence", "last_touched", "description", "open_actions", "stale", "stale_actions", "staleness_days", "unlinked", "best"];

package/dist/graph/fields.js

@@ -0,0 +1,12 @@
+// src/graph/fields.ts
+// Plain data shared by the index (db.ts) and the graph page's bundle. Kept
+// out of contracts.ts, whose contract objects esbuild cannot drop from the
+// bundle once it imports anything there.
+/** The optional Graph node fields queryGraph copies from an index row when set. */
+export const GRAPH_ROW_FIELDS = ['type', 'status', 'subtype', 'confidence', 'last_touched', 'description'];
+/** The optional Graph node fields queryGraph derives (#271): an Entity's signals
+ * and an Unlinked note's mark and placing slug. */
+export const GRAPH_SIGNAL_FIELDS = ['open_actions', 'stale', 'stale_actions', 'staleness_days', 'unlinked', 'best'];
+/** Every optional Graph node field: what the page's merge drops from a node a
+ * refresh no longer gives it. */
+export const GRAPH_NODE_FIELDS = [...GRAPH_ROW_FIELDS, ...GRAPH_SIGNAL_FIELDS];

package/dist/graph/fonts/geist-OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2024 The Geist Project Authors (https://github.com/vercel/geist-font) Geist-Italic[wght].ttf: Copyright 2024 The Geist Project Authors (https://github.com/vercel/geist-font)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/dist/graph/fonts/geist-mono-OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2024 The Geist Project Authors (https://github.com/vercel/geist-font.git) GeistMono-Italic[wght].ttf: Copyright 2024 The Geist Project Authors (https://github.com/vercel/geist-font.git)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/dist/graph/fonts/outfit-OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2021 The Outfit Project Authors (https://github.com/Outfitio/Outfit-Fonts)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

package/dist/graph/fonts.d.ts

@@ -0,0 +1,14 @@
+export interface Font {
+    /** The CSS family the token sheet's stacks name. */
+    family: string;
+    /** The served name under `/fonts/`; the licence is `<file stem>-OFL.txt`. */
+    file: string;
+    /** The devDependency it is copied from, and the woff2 inside it. */
+    pkg: string;
+    src: string;
+}
+export declare const FONTS: readonly Font[];
+/** The served name of a font's licence. */
+export declare const licenceFile: (font: Font) => string;
+/** Every file `/fonts/` serves, by served name: what the build copies, from where in node_modules. */
+export declare const FONT_FILES: ReadonlyMap<string, string>;

package/dist/graph/fonts.js

@@ -0,0 +1,17 @@
+// src/graph/fonts.ts
+// The page's bundled fonts (#272), plain data shared by the build, the
+// server's `/fonts/` allowlist and the page's stylesheet. Each is a latin
+// variable-weight woff2 from a devDependency, copied into dist/graph/fonts/ at
+// build with its OFL licence beside it: the package gains no runtime dependency.
+export const FONTS = [
+    { family: 'Geist', file: 'geist.woff2', pkg: '@fontsource-variable/geist', src: 'files/geist-latin-wght-normal.woff2' },
+    { family: 'Geist Mono', file: 'geist-mono.woff2', pkg: '@fontsource-variable/geist-mono', src: 'files/geist-mono-latin-wght-normal.woff2' },
+    { family: 'Outfit', file: 'outfit.woff2', pkg: '@fontsource-variable/outfit', src: 'files/outfit-latin-wght-normal.woff2' },
+];
+/** The served name of a font's licence. */
+export const licenceFile = (font) => font.file.replace(/\.woff2$/, '-OFL.txt');
+/** Every file `/fonts/` serves, by served name: what the build copies, from where in node_modules. */
+export const FONT_FILES = new Map(FONTS.flatMap(f => [
+    [f.file, `${f.pkg}/${f.src}`],
+    [licenceFile(f), `${f.pkg}/LICENSE`],
+]));

package/dist/graph/live.d.ts

@@ -0,0 +1,16 @@
+import type { IncomingMessage, ServerResponse } from 'http';
+import type { Hafez } from '../types.js';
+/** How often the Vault's history is checked when no interval is given, in ms. */
+export declare const DEFAULT_POLL_MS = 2000;
+export interface Live {
+    /** Hold `res` open as an SSE stream until the client goes away; a
+     * `Last-Event-ID` on `req` is replayed the changes since it first. */
+    subscribe(req: IncomingMessage, res: ServerResponse): void;
+    /** Stop polling and wait out a poll in flight, so nothing touches the Hafez
+     * instance afterwards (its index is closed next). */
+    stop(): Promise<void>;
+}
+/** Start following the Vault from its current cursor; `rebuild` refreshes the
+ * cached Graph before an event goes out, so a client refetching on the event
+ * reads the new one. */
+export declare function startLive(os: Hafez, pollMs: number, rebuild: () => Promise<void>): Promise<Live>;

package/dist/graph/live.js

@@ -0,0 +1,99 @@
+/** How often the Vault's history is checked when no interval is given, in ms. */
+export const DEFAULT_POLL_MS = 2000;
+/** Start following the Vault from its current cursor; `rebuild` refreshes the
+ * cached Graph before an event goes out, so a client refetching on the event
+ * reads the new one. */
+export async function startLive(os, pollMs, rebuild) {
+    const clients = new Set();
+    let cursor = (await os.changesSince()).cursor;
+    let stopped = false;
+    /** Polls and replays run one at a time, in order. */
+    let chain = Promise.resolve();
+    const serial = (task) => (chain = chain.then(task));
+    let timer;
+    async function poll() {
+        let found;
+        try {
+            found = await os.changesSince(cursor);
+            if (found.changes.length === 0) {
+                cursor = found.cursor;
+                return;
+            }
+        }
+        catch {
+            // A cursor history no longer knows (rewritten), or a transient read
+            // failure. Follow from where history is now: what changed in between is
+            // unknown, so a moved cursor goes out as a commit naming no note, and
+            // the page refetches the Graph on it as on any commit.
+            try {
+                found = { ...await os.changesSince(), changes: [] };
+            }
+            catch {
+                return; // the cursor stays: the next poll asks again
+            }
+            if (found.cursor === cursor)
+                return;
+        }
+        if (stopped)
+            return;
+        try {
+            await rebuild();
+        }
+        catch {
+            // The cursor stays where it was: the next poll finds these changes again.
+            return;
+        }
+        const frame = commitFrame(found);
+        for (const res of clients)
+            res.write(frame);
+        cursor = found.cursor;
+    }
+    /** What changed since `lastId`, to one stream. A cursor history no longer
+     * knows replays nothing: the page refetches the Graph on reconnect anyway.
+     * A change the next poll also finds reaches this stream twice, which the
+     * page takes as one more refetch. */
+    async function replay(res, lastId) {
+        let found;
+        try {
+            found = await os.changesSince(lastId);
+        }
+        catch {
+            found = { cursor: cursor ?? '', changes: [] };
+        }
+        if (!res.writableEnded)
+            res.write(found.changes.length > 0 ? commitFrame(found) : idFrame(found.cursor));
+    }
+    function schedule() {
+        if (stopped)
+            return;
+        timer = setTimeout(() => { void serial(poll).finally(schedule); }, pollMs);
+        timer.unref();
+    }
+    schedule();
+    return {
+        subscribe(req, res) {
+            res.writeHead(200, { 'Content-Type': 'text/event-stream; charset=utf-8', 'Cache-Control': 'no-cache', Connection: 'keep-alive' });
+            res.write(': live\n\n');
+            const lastId = req.headers['last-event-id'];
+            if (typeof lastId === 'string' && lastId !== cursor && !stopped)
+                void serial(() => replay(res, lastId));
+            else
+                res.write(idFrame(cursor ?? ''));
+            clients.add(res);
+            res.on('close', () => clients.delete(res));
+        },
+        async stop() {
+            stopped = true;
+            clearTimeout(timer);
+            await chain;
+        },
+    };
+}
+/** An event with an id and no data: it sets the browser's last event id and dispatches nothing. */
+function idFrame(cursor) {
+    return `id: ${cursor}\n\n`;
+}
+function commitFrame({ cursor, changes }) {
+    const event = { type: 'commit', changes };
+    return `id: ${cursor}\ndata: ${JSON.stringify(event)}\n\n`;
+}

package/dist/graph/open.d.ts

@@ -0,0 +1 @@
+export declare function openBrowser(url: string): void;

package/dist/graph/open.js

@@ -0,0 +1,20 @@
+// src/graph/open.ts
+// Open a URL in the user's browser, best-effort: any failure is silent,
+// because the URL is printed either way.
+import { spawn } from 'child_process';
+import { release } from 'os';
+export function openBrowser(url) {
+    const wsl = process.platform === 'linux' && release().toLowerCase().includes('microsoft');
+    const [cmd, args] = process.platform === 'darwin' ? ['open', [url]]
+        // cmd.exe splits a command at `&`: a focused URL (`?focus=…&depth=2`) needs it escaped.
+        : process.platform === 'win32' || wsl ? ['cmd.exe', ['/c', 'start', url.replace(/&/g, '^&')]]
+            : ['xdg-open', [url]];
+    try {
+        const child = spawn(cmd, args, { detached: true, stdio: 'ignore' });
+        child.on('error', () => { });
+        child.unref();
+    }
+    catch {
+        // No opener on this machine: the printed URL is the way in.
+    }
+}

package/dist/graph/server.d.ts

@@ -0,0 +1,17 @@
+import type { InternalHafez } from '../internal.js';
+/** Where the port search starts when no port is asked for. */
+export declare const DEFAULT_PORT = 4747;
+export interface GraphServerOpts {
+    /** An instance from createInternalHafez (src/internal.ts): the server syncs its index itself. */
+    os: InternalHafez;
+    /** The port to bind; 0 lets the OS pick. Unset: the first free port from DEFAULT_PORT. */
+    port?: number;
+    /** How often to look for Vault changes, in ms (default DEFAULT_POLL_MS). */
+    pollMs?: number;
+}
+export interface GraphServer {
+    url: string;
+    /** Stop the server, drop open connections and close the Hafez instance's index. */
+    close(): Promise<void>;
+}
+export declare function startGraphServer({ os, port, pollMs }: GraphServerOpts): Promise<GraphServer>;