@earendil-works/chord 1.5.0 → 1.5.1

package/dist/node/app/ephemeral.js

@@ -0,0 +1,34 @@
+// The ephemeral login plugin (slice 13 §3, decision "The app kit, point 2"): an IRC-like "pick a name and you're in".
+// `POST /_chord/login` (public: `{ name }`) issues an ephemeral session for `{ kind: "user", id: <fresh>, name }`
+// (the app's principal type must allow it) and answers with its cookie. No account is stored. The session ends with
+// the browser (its cookie has no lifetime) or the server (ephemeral sessions are dropped whenever it starts); ending it
+// with the client's last link waits for slice 11's clients (carry-over). An exported facet, as `defineUsers`.
+import { defineFacet } from "../../host/index.js";
+import { Http } from "../http/index.js";
+import { newToken } from "./secrets.js";
+import { Sessions } from "./sessions.js";
+/** The longest name taken. */
+const MAX_NAME = 40;
+/** The ephemeral login plugin's server facet; a type error unless the app's principal type holds `EphemeralUser`. */
+export function ephemeralLoginFacet(..._fits) {
+    return defineFacet((_host, self) => self.contribute(Http, {
+        routes: {
+            "POST /_chord/login": {
+                public: true,
+                handler: async (request, ctx) => {
+                    // A trust boundary: anyone may log in under a name.
+                    const body = (await request.json(4096));
+                    const name = typeof body?.name === "string" ? body.name.trim().slice(0, MAX_NAME) : "";
+                    if (name === "")
+                        return { kind: "error", status: 400 };
+                    const principal = { kind: "user", id: newToken(12), name };
+                    const sessions = await ctx.get(Sessions, {});
+                    const secure = request.provenance.kind !== "local";
+                    const issued = await sessions.issue({ principal, label: name, kind: "ephemeral", secure }, ctx);
+                    return { kind: "json", value: principal, headers: { "Set-Cookie": issued.cookie } };
+                },
+            },
+        },
+    }));
+}
+//# sourceMappingURL=ephemeral.js.map

package/dist/node/app/ephemeral.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ephemeral.js","sourceRoot":"","sources":["../../../src/node/app/ephemeral.ts"],"names":[],"mappings":"AAAA,sHAAsH;AACtH,kHAAkH;AAClH,oHAAoH;AACpH,wHAAwH;AACxH,8GAA8G;AAG9G,OAAO,EAAE,WAAW,EAAc,MAAM,qBAAqB,CAAC;AAC9D,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAKzC,8BAA8B;AAC9B,MAAM,QAAQ,GAAG,EAAE,CAAC;AAEpB,qHAAqH;AACrH,MAAM,UAAU,mBAAmB,CAClC,GAAG,KAAuG;IAE1G,OAAO,WAAW,CAAI,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CACrC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;QACrB,MAAM,EAAE;YACP,oBAAoB,EAAE;gBACrB,MAAM,EAAE,IAAI;gBACZ,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE;oBAC/B,oDAAoD;oBACpD,MAAM,IAAI,GAAG,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAuC,CAAC;oBAC9E,MAAM,IAAI,GAAG,OAAO,IAAI,EAAE,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBACvF,IAAI,IAAI,KAAK,EAAE;wBAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;oBACvD,MAAM,SAAS,GAAkB,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC;oBAC1E,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;oBAC7C,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,KAAK,OAAO,CAAC;oBACnD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,GAAG,CAAC,CAAC;oBAChG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;gBACrF,CAAC;aACD;SACD;KACD,CAAC,CACF,CAAC;AACH,CAAC","sourcesContent":["// The ephemeral login plugin (slice 13 §3, decision \"The app kit, point 2\"): an IRC-like \"pick a name and you're in\".\n// `POST /_chord/login` (public: `{ name }`) issues an ephemeral session for `{ kind: \"user\", id: <fresh>, name }`\n// (the app's principal type must allow it) and answers with its cookie. No account is stored. The session ends with\n// the browser (its cookie has no lifetime) or the server (ephemeral sessions are dropped whenever it starts); ending it\n// with the client's last link waits for slice 11's clients (carry-over). An exported facet, as `defineUsers`.\n\nimport type { Principal } from \"../../data/index.ts\";\nimport { defineFacet, type Facet } from \"../../host/index.ts\";\nimport { Http } from \"../http/index.ts\";\nimport { newToken } from \"./secrets.ts\";\nimport { Sessions } from \"./sessions.ts\";\n\n/** The principal an ephemeral login gives. */\nexport type EphemeralUser = { readonly kind: \"user\"; readonly id: string; readonly name: string };\n\n/** The longest name taken. */\nconst MAX_NAME = 40;\n\n/** The ephemeral login plugin's server facet; a type error unless the app's principal type holds `EphemeralUser`. */\nexport function ephemeralLoginFacet<P extends Principal>(\n\t..._fits: EphemeralUser extends P ? [] : [\"the app's principal type must hold { kind: 'user', id, name }\"]\n): Facet<P> {\n\treturn defineFacet<P>((_host, self) =>\n\t\tself.contribute(Http, {\n\t\t\troutes: {\n\t\t\t\t\"POST /_chord/login\": {\n\t\t\t\t\tpublic: true,\n\t\t\t\t\thandler: async (request, ctx) => {\n\t\t\t\t\t\t// A trust boundary: anyone may log in under a name.\n\t\t\t\t\t\tconst body = (await request.json(4096)) as { readonly name?: unknown } | null;\n\t\t\t\t\t\tconst name = typeof body?.name === \"string\" ? body.name.trim().slice(0, MAX_NAME) : \"\";\n\t\t\t\t\t\tif (name === \"\") return { kind: \"error\", status: 400 };\n\t\t\t\t\t\tconst principal: EphemeralUser = { kind: \"user\", id: newToken(12), name };\n\t\t\t\t\t\tconst sessions = await ctx.get(Sessions, {});\n\t\t\t\t\t\tconst secure = request.provenance.kind !== \"local\";\n\t\t\t\t\t\tconst issued = await sessions.issue({ principal, label: name, kind: \"ephemeral\", secure }, ctx);\n\t\t\t\t\t\treturn { kind: \"json\", value: principal, headers: { \"Set-Cookie\": issued.cookie } };\n\t\t\t\t\t},\n\t\t\t\t},\n\t\t\t},\n\t\t}),\n\t);\n}\n"]}

package/dist/node/app/files-copy.d.ts

@@ -0,0 +1,13 @@
+import type { Context } from "../../context/index.ts";
+import { type Store } from "../../store/index.ts";
+/**
+ * Copies the files of the host whose open store is `source.store` and whose files directory is `source.files` into
+ * the new host directory `target` (refused when it exists): `target/store.sqlite` holding only the `Files` index,
+ * `target/files/blobs/` its blobs. Staged beside `target` and renamed into place, so a failed copy leaves nothing.
+ * Runs where the source store is open (its worker, or whoever holds its lock); the source may go on meanwhile.
+ */
+export declare function copyFiles(source: {
+    readonly store: Store;
+    readonly files: string;
+}, target: string, context: Context): Promise<void>;
+//# sourceMappingURL=files-copy.d.ts.map

package/dist/node/app/files-copy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files-copy.d.ts","sourceRoot":"","sources":["../../../src/node/app/files-copy.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEtD,OAAO,EAAiC,KAAK,KAAK,EAAiB,MAAM,sBAAsB,CAAC;AAKhG;;;;;GAKG;AACH,wBAAsB,SAAS,CAC9B,MAAM,EAAE;IAAE,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CAAE,EACzD,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,GACd,OAAO,CAAC,IAAI,CAAC,CAiBf"}

package/dist/node/app/files-copy.js

@@ -0,0 +1,86 @@
+// Copying a host's files (decision "Files v2"): one host's `Files` (its index and its blobs) into a new host
+// directory, for an app that makes a new address from an existing one (p2's clone and fork). The index is the part of
+// the source store's export that is `Files`' own (its tables and documents), imported as the new directory's store;
+// each blob is linked (blobs never change, so two hosts may share the file) or copied while the export holds the
+// source's commit queue, so no removal can take a blob the copied index still names.
+import { mkdir, mkdtemp, rename, rm, stat } from "node:fs/promises";
+import { dirname, join } from "node:path";
+import { openNodeSqliteDatabase } from "../../sqlite/node.js";
+import { importStore, sqliteBackend } from "../../store/index.js";
+import { Blobs } from "./blobs.js";
+import { Files } from "./files.js";
+import { privateDirectory, privateStore } from "./layout.js";
+/**
+ * Copies the files of the host whose open store is `source.store` and whose files directory is `source.files` into
+ * the new host directory `target` (refused when it exists): `target/store.sqlite` holding only the `Files` index,
+ * `target/files/blobs/` its blobs. Staged beside `target` and renamed into place, so a failed copy leaves nothing.
+ * Runs where the source store is open (its worker, or whoever holds its lock); the source may go on meanwhile.
+ */
+export async function copyFiles(source, target, context) {
+    if (await exists(target))
+        throw new Error(`copyFiles: ${target} exists already`);
+    await privateDirectory(dirname(target));
+    const staging = await mkdtemp(join(dirname(target), ".chord-files-copy-"));
+    try {
+        const blobs = new Blobs(join(source.files, "blobs"));
+        const into = join(staging, "files", "blobs");
+        await mkdir(into, { recursive: true, mode: 0o700 });
+        await privateStore(join(staging, "store.sqlite"));
+        const backend = sqliteBackend(await openNodeSqliteDatabase(join(staging, "store.sqlite")));
+        const store = await importStore(backend, filesParts(source.store, blobs, into, context), context);
+        await store.close(context);
+        await rename(staging, target);
+    }
+    catch (error) {
+        await rm(staging, { recursive: true, force: true });
+        throw error;
+    }
+}
+/** Who owns `Files`' tables (`<owner>:<table>`) and documents in a store: its contract. */
+const OWNER = Files.name;
+/**
+ * The parts of `store`'s export that are `Files`' own: the manifest, its tables' parts, its documents' parts, and an
+ * `end` counting them. Each blob row's file is put into `into` before its part is passed on.
+ */
+async function* filesParts(store, blobs, into, context) {
+    const documents = new Set();
+    let writes = 0;
+    for await (const part of store.export(context)) {
+        const kept = keeps(part, documents);
+        if (part.kind === "end")
+            yield { kind: "end", writes };
+        if (!kept)
+            continue;
+        if (part.kind === "put" && part.table === `${OWNER}:blobs`) {
+            // A blob row's key: the kit's own column, a string.
+            await blobs.linkInto(part.row.id, into);
+        }
+        if (part.kind !== "manifest")
+            writes++;
+        yield part;
+    }
+}
+/** Whether `part` belongs to `Files` (the manifest does too); its documents' ids are remembered in `documents`. */
+function keeps(part, documents) {
+    switch (part.kind) {
+        case "manifest":
+            return true;
+        case "table":
+        case "put":
+        case "index":
+            return part.table.startsWith(`${OWNER}:`);
+        case "document.create":
+            if (part.record.owner === OWNER)
+                documents.add(part.record.id);
+            return part.record.owner === OWNER;
+        case "document.revision":
+            return documents.has(part.id);
+        case "end":
+            return false;
+    }
+}
+/** Whether `path` exists. */
+async function exists(path) {
+    return stat(path).then(() => true, () => false);
+}
+//# sourceMappingURL=files-copy.js.map

package/dist/node/app/files-copy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"files-copy.js","sourceRoot":"","sources":["../../../src/node/app/files-copy.ts"],"names":[],"mappings":"AAAA,6GAA6G;AAC7G,sHAAsH;AACtH,oHAAoH;AACpH,iHAAiH;AACjH,qFAAqF;AAErF,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACpE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAE1C,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC;AAC9D,OAAO,EAAoB,WAAW,EAAc,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAChG,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE7D;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC9B,MAAyD,EACzD,MAAc,EACd,OAAgB;IAEhB,IAAI,MAAM,MAAM,CAAC,MAAM,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,cAAc,MAAM,iBAAiB,CAAC,CAAC;IACjF,MAAM,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IACxC,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAC3E,IAAI,CAAC;QACJ,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;QACrD,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAC7C,MAAM,KAAK,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QACpD,MAAM,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC;QAClD,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,sBAAsB,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC;QAC3F,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;QAClG,MAAM,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC3B,MAAM,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC/B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACpD,MAAM,KAAK,CAAC;IACb,CAAC;AACF,CAAC;AAED,2FAA2F;AAC3F,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;AAEzB;;;GAGG;AACH,KAAK,SAAS,CAAC,CAAC,UAAU,CAAC,KAAY,EAAE,KAAY,EAAE,IAAY,EAAE,OAAgB;IACpF,MAAM,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;IACpC,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACpC,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK;YAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QACvD,IAAI,CAAC,IAAI;YAAE,SAAS;QACpB,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,KAAK,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5D,oDAAoD;YACpD,MAAM,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAY,EAAE,IAAI,CAAC,CAAC;QACnD,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU;YAAE,MAAM,EAAE,CAAC;QACvC,MAAM,IAAI,CAAC;IACZ,CAAC;AACF,CAAC;AAED,mHAAmH;AACnH,SAAS,KAAK,CAAC,IAAiB,EAAE,SAAsB;IACvD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,UAAU;YACd,OAAO,IAAI,CAAC;QACb,KAAK,OAAO,CAAC;QACb,KAAK,KAAK,CAAC;QACX,KAAK,OAAO;YACX,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;QAC3C,KAAK,iBAAiB;YACrB,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK;gBAAE,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;YAC/D,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC;QACpC,KAAK,mBAAmB;YACvB,OAAO,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC/B,KAAK,KAAK;YACT,OAAO,KAAK,CAAC;IACf,CAAC;AACF,CAAC;AAED,6BAA6B;AAC7B,KAAK,UAAU,MAAM,CAAC,IAAY;IACjC,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CACrB,GAAG,EAAE,CAAC,IAAI,EACV,GAAG,EAAE,CAAC,KAAK,CACX,CAAC;AACH,CAAC","sourcesContent":["// Copying a host's files (decision \"Files v2\"): one host's `Files` (its index and its blobs) into a new host\n// directory, for an app that makes a new address from an existing one (p2's clone and fork). The index is the part of\n// the source store's export that is `Files`' own (its tables and documents), imported as the new directory's store;\n// each blob is linked (blobs never change, so two hosts may share the file) or copied while the export holds the\n// source's commit queue, so no removal can take a blob the copied index still names.\n\nimport { mkdir, mkdtemp, rename, rm, stat } from \"node:fs/promises\";\nimport { dirname, join } from \"node:path\";\nimport type { Context } from \"../../context/index.ts\";\nimport { openNodeSqliteDatabase } from \"../../sqlite/node.ts\";\nimport { type ArchivePart, importStore, type Store, sqliteBackend } from \"../../store/index.ts\";\nimport { Blobs } from \"./blobs.ts\";\nimport { Files } from \"./files.ts\";\nimport { privateDirectory, privateStore } from \"./layout.ts\";\n\n/**\n * Copies the files of the host whose open store is `source.store` and whose files directory is `source.files` into\n * the new host directory `target` (refused when it exists): `target/store.sqlite` holding only the `Files` index,\n * `target/files/blobs/` its blobs. Staged beside `target` and renamed into place, so a failed copy leaves nothing.\n * Runs where the source store is open (its worker, or whoever holds its lock); the source may go on meanwhile.\n */\nexport async function copyFiles(\n\tsource: { readonly store: Store; readonly files: string },\n\ttarget: string,\n\tcontext: Context,\n): Promise<void> {\n\tif (await exists(target)) throw new Error(`copyFiles: ${target} exists already`);\n\tawait privateDirectory(dirname(target));\n\tconst staging = await mkdtemp(join(dirname(target), \".chord-files-copy-\"));\n\ttry {\n\t\tconst blobs = new Blobs(join(source.files, \"blobs\"));\n\t\tconst into = join(staging, \"files\", \"blobs\");\n\t\tawait mkdir(into, { recursive: true, mode: 0o700 });\n\t\tawait privateStore(join(staging, \"store.sqlite\"));\n\t\tconst backend = sqliteBackend(await openNodeSqliteDatabase(join(staging, \"store.sqlite\")));\n\t\tconst store = await importStore(backend, filesParts(source.store, blobs, into, context), context);\n\t\tawait store.close(context);\n\t\tawait rename(staging, target);\n\t} catch (error) {\n\t\tawait rm(staging, { recursive: true, force: true });\n\t\tthrow error;\n\t}\n}\n\n/** Who owns `Files`' tables (`<owner>:<table>`) and documents in a store: its contract. */\nconst OWNER = Files.name;\n\n/**\n * The parts of `store`'s export that are `Files`' own: the manifest, its tables' parts, its documents' parts, and an\n * `end` counting them. Each blob row's file is put into `into` before its part is passed on.\n */\nasync function* filesParts(store: Store, blobs: Blobs, into: string, context: Context): AsyncGenerator<ArchivePart> {\n\tconst documents = new Set<number>();\n\tlet writes = 0;\n\tfor await (const part of store.export(context)) {\n\t\tconst kept = keeps(part, documents);\n\t\tif (part.kind === \"end\") yield { kind: \"end\", writes };\n\t\tif (!kept) continue;\n\t\tif (part.kind === \"put\" && part.table === `${OWNER}:blobs`) {\n\t\t\t// A blob row's key: the kit's own column, a string.\n\t\t\tawait blobs.linkInto(part.row.id as string, into);\n\t\t}\n\t\tif (part.kind !== \"manifest\") writes++;\n\t\tyield part;\n\t}\n}\n\n/** Whether `part` belongs to `Files` (the manifest does too); its documents' ids are remembered in `documents`. */\nfunction keeps(part: ArchivePart, documents: Set<number>): boolean {\n\tswitch (part.kind) {\n\t\tcase \"manifest\":\n\t\t\treturn true;\n\t\tcase \"table\":\n\t\tcase \"put\":\n\t\tcase \"index\":\n\t\t\treturn part.table.startsWith(`${OWNER}:`);\n\t\tcase \"document.create\":\n\t\t\tif (part.record.owner === OWNER) documents.add(part.record.id);\n\t\t\treturn part.record.owner === OWNER;\n\t\tcase \"document.revision\":\n\t\t\treturn documents.has(part.id);\n\t\tcase \"end\":\n\t\t\treturn false;\n\t}\n}\n\n/** Whether `path` exists. */\nasync function exists(path: string): Promise<boolean> {\n\treturn stat(path).then(\n\t\t() => true,\n\t\t() => false,\n\t);\n}\n"]}

package/dist/node/app/files-entry.d.ts

@@ -0,0 +1,4 @@
+export { type FileInfo, Files, type FilesCaps, FilesFolder, type FileWrite, type FolderEntry, type FolderInfo, type FolderListing, filesFacet, type SpaceSummary, } from "./files.ts";
+export { copyFiles } from "./files-copy.ts";
+export { privateDirectory, privateStore } from "./layout.ts";
+//# sourceMappingURL=files-entry.d.ts.map

package/dist/node/app/files-entry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files-entry.d.ts","sourceRoot":"","sources":["../../../src/node/app/files-entry.ts"],"names":[],"mappings":"AAIA,OAAO,EACN,KAAK,QAAQ,EACb,KAAK,EACL,KAAK,SAAS,EACd,WAAW,EACX,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,KAAK,aAAa,EAClB,UAAU,EACV,KAAK,YAAY,GACjB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC"}

package/dist/node/app/files-entry.js

@@ -0,0 +1,7 @@
+// The app kit's files on their own (`@earendil-works/chord/app/files`): `Files`, `FilesFolder`, their facet, copying a
+// host's files and the kit's private directories and stores, for an app that hosts its own hosts without the rest of
+// the kit (a worker process that must load neither esbuild nor the server's components).
+export { Files, FilesFolder, filesFacet, } from "./files.js";
+export { copyFiles } from "./files-copy.js";
+export { privateDirectory, privateStore } from "./layout.js";
+//# sourceMappingURL=files-entry.js.map

package/dist/node/app/files-entry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"files-entry.js","sourceRoot":"","sources":["../../../src/node/app/files-entry.ts"],"names":[],"mappings":"AAAA,uHAAuH;AACvH,qHAAqH;AACrH,yFAAyF;AAEzF,OAAO,EAEN,KAAK,EAEL,WAAW,EAKX,UAAU,GAEV,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC","sourcesContent":["// The app kit's files on their own (`@earendil-works/chord/app/files`): `Files`, `FilesFolder`, their facet, copying a\n// host's files and the kit's private directories and stores, for an app that hosts its own hosts without the rest of\n// the kit (a worker process that must load neither esbuild nor the server's components).\n\nexport {\n\ttype FileInfo,\n\tFiles,\n\ttype FilesCaps,\n\tFilesFolder,\n\ttype FileWrite,\n\ttype FolderEntry,\n\ttype FolderInfo,\n\ttype FolderListing,\n\tfilesFacet,\n\ttype SpaceSummary,\n} from \"./files.ts\";\nexport { copyFiles } from \"./files-copy.ts\";\nexport { privateDirectory, privateStore } from \"./layout.ts\";\n"]}

package/dist/node/app/files-index.d.ts

@@ -0,0 +1,180 @@
+import type { Context } from "../../context/index.ts";
+import { type Schema } from "../../contracts/index.ts";
+import type { Principal } from "../../data/index.ts";
+import { type KeyedHandle, type SingletonHandle } from "../../documents/index.ts";
+import type { StoreSelf } from "../../host/index.ts";
+import type { JsonValue } from "../../json.ts";
+import { type Page } from "../../store/index.ts";
+/** One version of a file as the index gives it. */
+export type FileInfo = {
+    readonly id: string;
+    readonly space: string;
+    readonly path: string;
+    readonly version: number;
+    readonly size: number;
+    readonly mime: string;
+    readonly source: string;
+    readonly ref?: string;
+    readonly key?: string;
+    readonly created: number;
+    readonly meta?: JsonValue;
+};
+/** A folder as the index gives it. */
+export type FolderInfo = {
+    readonly space: string;
+    readonly path: string;
+    readonly created: number;
+};
+/** One entry of a folder's listing: a folder, or a file's newest version. */
+export type FolderEntry = {
+    readonly kind: "folder";
+    readonly folder: FolderInfo;
+} | {
+    readonly kind: "file";
+    readonly file: FileInfo;
+};
+/** What a space holds: its files (paths), their versions, their bytes (every version's) and the newest versions. */
+export type SpaceSummary = {
+    readonly files: number;
+    readonly versions: number;
+    readonly bytes: number;
+    readonly newest: FileInfo[];
+};
+/**
+ * What a write stores besides its bytes: where, its type, who wrote it, its producer's reference, its key, `meta`, and
+ * for an import the time the file was made elsewhere (`created`, ms since the epoch; the write's time otherwise).
+ */
+export type FileWrite = {
+    readonly space: string;
+    readonly path: string;
+    readonly mime: string;
+    readonly source: string;
+    readonly ref?: string;
+    readonly key?: string;
+    readonly created?: number;
+    readonly meta?: JsonValue;
+};
+/** `meta`'s schema: any JSON (stored as one JSON cell, so what is written is JSON; the schema cannot say so). */
+export declare const MetaSchema: Schema<JsonValue>;
+/** A file version's schema (`FileInfo`). */
+export declare const FileSchema: Schema<{
+    id: string;
+    space: string;
+    path: string;
+    version: number;
+    size: number;
+    mime: string;
+    source: string;
+    ref?: string | undefined;
+    key?: string | undefined;
+    created: number;
+    meta?: string | number | boolean | JsonValue[] | {
+        [key: string]: JsonValue;
+    } | null | undefined;
+}>;
+/** A folder's schema (`FolderInfo`). */
+export declare const FolderSchema: Schema<{
+    space: string;
+    path: string;
+    created: number;
+}>;
+/** A space summary's schema (`SpaceSummary`). */
+export declare const SummarySchema: Schema<{
+    files: number;
+    versions: number;
+    bytes: number;
+    newest: {
+        id: string;
+        space: string;
+        path: string;
+        version: number;
+        size: number;
+        mime: string;
+        source: string;
+        ref?: string | undefined;
+        key?: string | undefined;
+        created: number;
+        meta?: string | number | boolean | JsonValue[] | {
+            [key: string]: JsonValue;
+        } | null | undefined;
+    }[];
+}>;
+/** How many of a space's newest versions its summary keeps. */
+export declare const NEWEST = 20;
+/** The most a page holds. */
+export declare const MAX_PAGE = 1000;
+/** A blob a new version references: a fresh one (just written) or one other versions share. */
+export type BlobUse = {
+    readonly id: string;
+    readonly size: number;
+    readonly fresh: boolean;
+};
+/**
+ * One host's index of files, over its object's tables and documents. Reads see committed state; each change is one
+ * transaction and returns the blobs no version references any more (for the caller to delete).
+ */
+export declare class FilesIndex {
+    #private;
+    readonly summary: KeyedHandle<SpaceSummary>;
+    readonly usage: SingletonHandle<{
+        bytes: number;
+    }>;
+    /** The index of the object `self` declares it in (its factory's). */
+    constructor(self: StoreSelf<Principal>);
+    /** The version `id`, or `undefined`. */
+    file(id: string, context: Context): Promise<FileInfo | undefined>;
+    /** The blob of version `id` and its size, or `undefined`. */
+    blobOf(id: string, context: Context): Promise<{
+        blob: string;
+        size: number;
+    } | undefined>;
+    /** Version `version` of the file at `path` (its newest without one), or `undefined`. */
+    get(space: string, path: string, version: number | undefined, context: Context): Promise<FileInfo | undefined>;
+    /** The version written with `key` in `space`, or `undefined`. */
+    byKey(space: string, key: string, context: Context): Promise<FileInfo | undefined>;
+    /** A page of the versions with `ref` in `space`, oldest first. */
+    byRef(space: string, ref: string, limit: number, after: string | undefined, context: Context): Promise<Page<FileInfo>>;
+    /** A page of the versions of the file at `path`, newest first. */
+    versions(space: string, path: string, limit: number, after: string | undefined, context: Context): Promise<Page<FileInfo>>;
+    /**
+     * A page of folder `folder`'s entries (`""` is the root): its folders, then its files' newest versions, each by
+     * path. The cursor names the part it continues.
+     */
+    list(space: string, folder: string, limit: number, after: string | undefined, context: Context): Promise<Page<FolderEntry>>;
+    /** Whether the file or folder `path` exists in `space`. */
+    exists(space: string, path: string, context: Context): Promise<"file" | "folder" | undefined>;
+    /** Adds a version at `write.path` referencing `blob`: version 1, or one past the newest; its folders made. */
+    add(id: string, write: FileWrite, blob: BlobUse, context: Context): Promise<FileInfo>;
+    /** Makes folder `path` and its missing parents; refused where a file is. */
+    mkdir(space: string, path: string, context: Context): Promise<FolderInfo>;
+    /**
+     * Moves the file or folder `from` to `to` (in `space`), changing only the index: every version of a file, everything
+     * under a folder. Refused when `from` does not exist, `to` exists or lies inside `from`. Versions keep their numbers;
+     * the paths left keep their marks, and each path moved to takes the higher of its own mark and the moved one's.
+     */
+    move(space: string, from: string, to: string, context: Context): Promise<void>;
+    /**
+     * Removes version `id` (an unknown one: nothing, `undefined`); the next older version becomes the path's newest.
+     * Its space and the blobs no version references any more.
+     */
+    remove(id: string, context: Context): Promise<{
+        space: string;
+        gone: string[];
+    } | undefined>;
+    /** Removes the file at `path` (every version) or the folder at `path` and everything under it. */
+    removePath(space: string, path: string, context: Context): Promise<string[]>;
+    /** Removes everything in `space`, its summary included. */
+    removeSpace(space: string, context: Context): Promise<string[]>;
+    /** Whether blob `id` is referenced (a blob file without a row is a leftover of a write that never committed). */
+    hasBlob(id: string, context: Context): Promise<boolean>;
+}
+/** Refuses a space name outside the rule (a trust boundary: the caller's). */
+export declare function checkSpace(space: string): void;
+/**
+ * Refuses a path that is not `name/name/…` (a trust boundary: the caller's): no empty segment, no `.` or `..`, no NUL,
+ * at most 1024 characters. `folder` allows `""`, the root.
+ */
+export declare function checkPath(path: string, folder: "folder" | "file"): void;
+/** The folder `path` is in (`""`: the root). */
+export declare function parentOf(path: string): string;
+//# sourceMappingURL=files-index.d.ts.map

package/dist/node/app/files-index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"files-index.d.ts","sourceRoot":"","sources":["../../../src/node/app/files-index.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAsB,KAAK,MAAM,EAAgB,MAAM,0BAA0B,CAAC;AACzF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAErD,OAAO,EAAe,KAAK,WAAW,EAAE,KAAK,eAAe,EAAW,MAAM,0BAA0B,CAAC;AACxG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAYN,KAAK,IAAI,EAOT,MAAM,sBAAsB,CAAC;AAE9B,mDAAmD;AACnD,MAAM,MAAM,QAAQ,GAAG;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;CAC1B,CAAC;AAEF,sCAAsC;AACtC,MAAM,MAAM,UAAU,GAAG;IAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC;AAErG,6EAA6E;AAC7E,MAAM,MAAM,WAAW,GACpB;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAA;CAAE,GACxD;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;CAAE,CAAC;AAEtD,oHAAoH;AACpH,MAAM,MAAM,YAAY,GAAG;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC;CAC5B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC;CAC1B,CAAC;AAEF,iHAAiH;AACjH,eAAO,MAAM,UAAU,EAAgB,MAAM,CAAC,SAAS,CAAC,CAAC;AAEzD,4CAA4C;AAC5C,eAAO,MAAM,UAAU;;;;;;;;;;;;;;EAYrB,CAAC;AAEH,wCAAwC;AACxC,eAAO,MAAM,YAAY;;;;EAAqD,CAAC;AAE/E,iDAAiD;AACjD,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;EAAgF,CAAC;AAuF3G,+DAA+D;AAC/D,eAAO,MAAM,MAAM,KAAK,CAAC;AAEzB,6BAA6B;AAC7B,eAAO,MAAM,QAAQ,OAAO,CAAC;AAE7B,+FAA+F;AAC/F,MAAM,MAAM,OAAO,GAAG;IAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAC;AAE9F;;;GAGG;AACH,qBAAa,UAAU;;IACtB,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,YAAY,CAAC,CAAC;IAC5C,QAAQ,CAAC,KAAK,EAAE,eAAe,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAOnD,qEAAqE;IACrE,YAAY,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC,EAQrC;IAED,wCAAwC;IAClC,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAGtE;IAED,6DAA6D;IACvD,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC,CAG9F;IAED,wFAAwF;IAClF,GAAG,CACR,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,OAAO,EAAE,OAAO,GACd,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAG/B;IAED,iEAAiE;IAC3D,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAIvF;IAED,kEAAkE;IAC5D,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,OAAO,2BAKjG;IAED,kEAAkE;IAC5D,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,OAAO,EAAE,OAAO,2BAKrG;IAED;;;OAGG;IACG,IAAI,CACT,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GAAG,SAAS,EACzB,OAAO,EAAE,OAAO,GACd,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAuB5B;IAED,2DAA2D;IACrD,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC,CAGlG;IAED,8GAA8G;IACxG,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAuC1F;IAED,4EAA4E;IACtE,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAQ9E;IAED;;;;OAIG;IACG,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAyCnF;IAcD;;;OAGG;IACG,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,EAAE,CAAA;KAAE,GAAG,SAAS,CAAC,CA4BjG;IAED,kGAAkG;IAC5F,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAsBjF;IAED,2DAA2D;IACrD,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAgBpE;IAED,iHAAiH;IAC3G,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAE5D;CAuFD;AA4ED,8EAA8E;AAC9E,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAE9C;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAG,MAAM,GAAG,IAAI,CAOvE;AAED,gDAAgD;AAChD,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAG7C"}