@volter/world-platform 2.0.0

package/dist/src/db/migrations/meta/_journal.json

@@ -0,0 +1,13 @@
+{
+  "version": "7",
+  "dialect": "sqlite",
+  "entries": [
+    {
+      "idx": 0,
+      "version": "6",
+      "when": 1790550512216,
+      "tag": "0000_init",
+      "breakpoints": true
+    }
+  ]
+}

package/dist/src/db/migrations.d.ts

@@ -0,0 +1,4 @@
+export declare const MIGRATIONS: ReadonlyArray<{
+    tag: string;
+    statements: readonly string[];
+}>;

package/dist/src/db/migrations.js

@@ -0,0 +1,33 @@
+// GENERATED by `bun src/db/pack-migrations.ts --write` from ./migrations/*.sql (drizzle-kit's): do not edit.
+export const MIGRATIONS = [
+    {
+        "tag": "0000_init",
+        "statements": [
+            "CREATE TABLE `audit` (\n\t`seq` integer PRIMARY KEY AUTOINCREMENT NOT NULL,\n\t`org` text NOT NULL,\n\t`at` text NOT NULL,\n\t`event` text NOT NULL,\n\t`actor` text NOT NULL,\n\t`target` text,\n\t`data` text\n);",
+            "CREATE INDEX `audit_org` ON `audit` (`org`,`seq`);",
+            "CREATE TABLE `biller_records` (\n\t`key` text PRIMARY KEY NOT NULL,\n\t`value` text NOT NULL\n);",
+            "CREATE TABLE `deliveries` (\n\t`id` text PRIMARY KEY NOT NULL,\n\t`org_id` text NOT NULL,\n\t`endpoint_id` text NOT NULL,\n\t`event_id` text NOT NULL,\n\t`event` text NOT NULL,\n\t`body` text NOT NULL,\n\t`attempt` integer NOT NULL,\n\t`next_at` text NOT NULL,\n\t`attempts` text NOT NULL,\n\t`state` text NOT NULL,\n\t`seq` integer NOT NULL\n);",
+            "CREATE INDEX `deliveries_state` ON `deliveries` (`state`,`next_at`);",
+            "CREATE INDEX `deliveries_endpoint` ON `deliveries` (`endpoint_id`);",
+            "CREATE TABLE `dir_members` (\n\t`org_id` text NOT NULL,\n\t`user_id` text NOT NULL,\n\t`role` text NOT NULL,\n\tPRIMARY KEY(`org_id`, `user_id`)\n);",
+            "CREATE INDEX `dir_members_user` ON `dir_members` (`user_id`);",
+            "CREATE TABLE `dir_orgs` (\n\t`id` text PRIMARY KEY NOT NULL,\n\t`slug` text NOT NULL,\n\t`name` text NOT NULL,\n\t`created_at` text NOT NULL\n);",
+            "CREATE UNIQUE INDEX `dir_orgs_slug_unique` ON `dir_orgs` (`slug`);",
+            "CREATE TABLE `invitations` (\n\t`id` text PRIMARY KEY NOT NULL,\n\t`org_id` text NOT NULL,\n\t`email` text NOT NULL,\n\t`role` text NOT NULL,\n\t`inviter_id` text NOT NULL,\n\t`created_at` text NOT NULL,\n\t`expires_at` text NOT NULL\n);",
+            "CREATE INDEX `invitations_org` ON `invitations` (`org_id`);",
+            "CREATE INDEX `invitations_email` ON `invitations` (`email`);",
+            "CREATE TABLE `meta` (\n\t`key` text PRIMARY KEY NOT NULL,\n\t`value` text\n);",
+            "CREATE TABLE `org_settings` (\n\t`org_id` text PRIMARY KEY NOT NULL,\n\t`security` text,\n\t`flags` text,\n\t`early_adopter` integer,\n\t`support_access` text\n);",
+            "CREATE TABLE `org_worlds` (\n\t`org_id` text NOT NULL,\n\t`name` text NOT NULL,\n\t`host` text NOT NULL,\n\t`base` text NOT NULL,\n\t`provisioned_at` text NOT NULL,\n\tPRIMARY KEY(`org_id`, `name`)\n);",
+            "CREATE TABLE `people` (\n\t`id` text PRIMARY KEY NOT NULL,\n\t`email` text,\n\t`email_verified` integer NOT NULL,\n\t`name` text,\n\t`first_seen_at` text NOT NULL,\n\t`last_seen_at` text NOT NULL\n);",
+            "CREATE INDEX `people_email` ON `people` (`email`);",
+            "CREATE TABLE `sessions` (\n\t`id_hash` text PRIMARY KEY NOT NULL,\n\t`subject` text NOT NULL,\n\t`email` text,\n\t`name` text,\n\t`expires_at` text NOT NULL\n);",
+            "CREATE TABLE `support_requests` (\n\t`id` text PRIMARY KEY NOT NULL,\n\t`at` text NOT NULL,\n\t`person` text NOT NULL,\n\t`org` text,\n\t`world` text,\n\t`category` text NOT NULL,\n\t`severity` text NOT NULL,\n\t`subject` text NOT NULL,\n\t`message` text NOT NULL,\n\t`status` text NOT NULL\n);",
+            "CREATE TABLE `tokens` (\n\t`hash` text PRIMARY KEY NOT NULL,\n\t`user_id` text NOT NULL,\n\t`name` text NOT NULL,\n\t`created_at` text NOT NULL,\n\t`last4` text NOT NULL,\n\t`last_used_at` text,\n\t`expires_at` text,\n\t`scopes` text,\n\t`org_id` text,\n\t`support` text,\n\t`world_keys` text\n);",
+            "CREATE INDEX `tokens_user` ON `tokens` (`user_id`);",
+            "CREATE INDEX `tokens_org` ON `tokens` (`org_id`);",
+            "CREATE TABLE `webhooks` (\n\t`id` text PRIMARY KEY NOT NULL,\n\t`org_id` text NOT NULL,\n\t`url` text NOT NULL,\n\t`secret` text NOT NULL,\n\t`events` text NOT NULL,\n\t`description` text NOT NULL,\n\t`created_at` text NOT NULL,\n\t`consecutive_failures` integer NOT NULL,\n\t`last_failed_at` text,\n\t`disabled_at` text\n);",
+            "CREATE INDEX `webhooks_org` ON `webhooks` (`org_id`);"
+        ]
+    }
+];

package/dist/src/db/open.d.ts

@@ -0,0 +1,11 @@
+import { BaseSQLiteDatabase } from 'drizzle-orm/sqlite-core';
+export type PlatformDb = BaseSQLiteDatabase<'sync', any>;
+/** The database's file in the state directory, and a restored one staged beside it (backup.ts). */
+export declare const DB_FILE = "platform.db";
+export declare const RESTORE_FILE = "platform.db.restore";
+/** The platform's database at `<stateDir>/platform.db` (`:memory:` with no state directory), opened once per process.
+ *  A restore staged since the last start (`platform.db.restore`) is put in place first. */
+export declare function openDatabase(stateDir?: string): PlatformDb;
+/** Close the state directory's database in this process (its file can then be moved or removed); the next
+ *  openDatabase opens it again. */
+export declare function closeDatabase(stateDir: string): void;

package/dist/src/db/open.js

@@ -0,0 +1,114 @@
+// OPENING THE PLATFORM'S DATABASE (docs/contributing/architecture.md, "The platform's state is SQLite"): one Drizzle
+// database, synchronous on every driver the platform runs on — Bun's `bun:sqlite`, Node's built-in `node:sqlite` (behind
+// Drizzle's better-sqlite3 session, which it answers like), and a Durable Object's SQLite (`openDurableDatabase`). The
+// migrations (./migrations.ts) are applied once, in order, and recorded.
+import { createRequire } from 'node:module';
+import { chmodSync, existsSync, mkdirSync, renameSync, rmSync, writeFileSync } from 'node:fs';
+import { dirname, join, resolve } from 'node:path';
+import { BaseSQLiteDatabase, SQLiteSyncDialect } from 'drizzle-orm/sqlite-core';
+import { BetterSQLiteSession } from 'drizzle-orm/better-sqlite3/session';
+import { MIGRATIONS } from "./migrations.js";
+/** Node's DatabaseSync, answering as better-sqlite3 does where Drizzle's session reads it. */
+function nodeClient(path) {
+    const { DatabaseSync } = createRequire(import.meta.url)('node:sqlite');
+    const raw = new DatabaseSync(path);
+    const prepare = (sql) => {
+        const st = raw.prepare(sql);
+        const arrays = (fn) => { st.setReturnArrays(true); try {
+            return fn();
+        }
+        finally {
+            st.setReturnArrays(false);
+        } };
+        return {
+            run: (...p) => { const r = st.run(...p); return { changes: Number(r.changes), lastInsertRowid: r.lastInsertRowid }; },
+            all: (...p) => st.all(...p),
+            get: (...p) => st.get(...p),
+            raw: () => ({ all: (...p) => arrays(() => st.all(...p)), get: (...p) => arrays(() => st.get(...p)) }),
+        };
+    };
+    // better-sqlite3's transaction(fn): a function that runs fn between BEGIN and COMMIT, rolling back on a throw
+    const transaction = (fn) => {
+        const run = (mode) => (...a) => { raw.exec(`BEGIN ${mode}`); try {
+            const r = fn(...a);
+            raw.exec('COMMIT');
+            return r;
+        }
+        catch (e) {
+            raw.exec('ROLLBACK');
+            throw e;
+        } };
+        return Object.assign(run('DEFERRED'), { deferred: run('DEFERRED'), immediate: run('IMMEDIATE'), exclusive: run('EXCLUSIVE') });
+    };
+    return { prepare, transaction, exec: (sql) => raw.exec(sql), close: () => raw.close() };
+}
+/** Apply what has not been applied, each migration in one transaction, and record it. */
+function migrate(exec, applied, inTransaction) {
+    exec('CREATE TABLE IF NOT EXISTS _migrations (tag TEXT PRIMARY KEY, applied_at TEXT NOT NULL)');
+    const done = new Set(applied());
+    for (const m of MIGRATIONS) {
+        if (done.has(m.tag))
+            continue;
+        inTransaction(() => { for (const s of m.statements)
+            exec(s); exec(`INSERT INTO _migrations (tag, applied_at) VALUES ('${m.tag.replace(/'/g, "''")}', '${new Date().toISOString()}')`); });
+    }
+}
+/** The database's file in the state directory, and a restored one staged beside it (backup.ts). */
+export const DB_FILE = 'platform.db';
+export const RESTORE_FILE = 'platform.db.restore';
+const opened = new Map();
+const closers = new Map();
+/** The platform's database at `<stateDir>/platform.db` (`:memory:` with no state directory), opened once per process.
+ *  A restore staged since the last start (`platform.db.restore`) is put in place first. */
+export function openDatabase(stateDir) {
+    const path = stateDir ? join(resolve(stateDir), DB_FILE) : ':memory:';
+    const known = opened.get(path);
+    if (known)
+        return known;
+    if (stateDir) {
+        mkdirSync(dirname(path), { recursive: true });
+        const staged = join(resolve(stateDir), RESTORE_FILE);
+        if (existsSync(staged)) {
+            for (const f of [`${path}-wal`, `${path}-shm`])
+                rmSync(f, { force: true });
+            renameSync(staged, path);
+        }
+        // owner-only, like the platform's other state; SQLite gives its write-ahead log and index the database's mode
+        if (!existsSync(path))
+            writeFileSync(path, '', { mode: 0o600 });
+        chmodSync(path, 0o600);
+    }
+    const req = createRequire(import.meta.url);
+    let db;
+    if (globalThis.Bun) {
+        const { Database } = req('bun:sqlite');
+        const { drizzle } = req('drizzle-orm/bun-sqlite');
+        const raw = new Database(path, { create: true });
+        raw.run('PRAGMA journal_mode = WAL');
+        raw.run('PRAGMA busy_timeout = 5000');
+        raw.run('PRAGMA foreign_keys = ON');
+        migrate((s) => raw.run(s), () => raw.query('SELECT tag FROM _migrations').all().map((r) => r.tag), (fn) => raw.transaction(fn)());
+        db = drizzle(raw);
+        closers.set(path, () => raw.close());
+    }
+    else {
+        const client = nodeClient(path);
+        client.exec('PRAGMA journal_mode = WAL');
+        client.exec('PRAGMA busy_timeout = 5000');
+        client.exec('PRAGMA foreign_keys = ON');
+        migrate((s) => client.exec(s), () => client.prepare('SELECT tag FROM _migrations').all().map((r) => r.tag), (fn) => client.transaction(fn)());
+        const dialect = new SQLiteSyncDialect();
+        db = new BaseSQLiteDatabase('sync', dialect, new BetterSQLiteSession(client, dialect, undefined, {}), undefined);
+        closers.set(path, client.close);
+    }
+    opened.set(path, db);
+    return db;
+}
+/** Close the state directory's database in this process (its file can then be moved or removed); the next
+ *  openDatabase opens it again. */
+export function closeDatabase(stateDir) {
+    const path = join(resolve(stateDir), DB_FILE);
+    closers.get(path)?.();
+    closers.delete(path);
+    opened.delete(path);
+}

package/dist/src/db/pack-migrations.d.ts

@@ -0,0 +1 @@
+export declare function packed(): string;

package/dist/src/db/pack-migrations.js

@@ -0,0 +1,33 @@
+// The migrations as a module (./migrations.ts): what `drizzle-kit generate` wrote under ./migrations, split into
+// statements, so every driver (a Durable Object reads no files) applies the same SQL.
+//   bun src/db/pack-migrations.ts --write    after `drizzle-kit generate --dialect sqlite --schema ./src/db/schema.ts --out ./src/db/migrations`
+//   bun src/db/pack-migrations.ts --check    exits 1 when migrations.ts is behind the .sql files
+import { readdirSync, readFileSync, writeFileSync } from 'node:fs';
+import { join } from 'node:path';
+const dir = join(import.meta.dir, 'migrations');
+const target = join(import.meta.dir, 'migrations.ts');
+export function packed() {
+    const files = readdirSync(dir).filter((f) => /^\d{4}_.+\.sql$/.test(f)).sort();
+    const list = files.map((f) => ({ tag: f.replace(/\.sql$/, ''), statements: readFileSync(join(dir, f), 'utf8').split('--> statement-breakpoint').map((s) => s.trim()).filter(Boolean) }));
+    return `// GENERATED by \`bun src/db/pack-migrations.ts --write\` from ./migrations/*.sql (drizzle-kit's): do not edit.\nexport const MIGRATIONS: ReadonlyArray<{ tag: string; statements: readonly string[] }> = ${JSON.stringify(list, null, 2)};\n`;
+}
+if (import.meta.main) {
+    if (process.argv.includes('--write')) {
+        writeFileSync(target, packed());
+        console.log(`wrote ${target}`);
+    }
+    else if (process.argv.includes('--check')) {
+        let current = '';
+        try {
+            current = readFileSync(target, 'utf8');
+        }
+        catch { /* none */ }
+        if (current.replace(/\r\n/g, '\n') !== packed()) {
+            console.error('src/db/migrations.ts is behind src/db/migrations/*.sql — run: bun src/db/pack-migrations.ts --write');
+            process.exit(1);
+        }
+        console.log('migrations.ts is current');
+    }
+    else
+        process.stdout.write(packed());
+}