@parlor/data 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 cychien
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,16 @@
-# Temporary Holding Version
+# @parlor/data
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The app's PostgreSQL database through Drizzle: embedded PGlite in development, `DATABASE_URL` in production, migrations applied on start.
+
+```sh
+pnpm add @parlor/data drizzle-orm
+```
+
+```ts
+import { createDatabase } from "@parlor/data";
+
+const database = await createDatabase({ migrationsFolder: "migrations" });
+const rows = await database.db.execute("select 1");
+```
+
+Docs: https://cychien.github.io/parlor/guides/data/

package/dist/database.d.ts

@@ -0,0 +1,24 @@
+import type { DataProvider, ListenOptions, Unlisten } from "@parlor/core";
+import type { PgDatabase, PgQueryResultHKT } from "drizzle-orm/pg-core";
+export type Database = PgDatabase<PgQueryResultHKT>;
+declare module "@parlor/core" {
+    interface DataRegister {
+        database: Database;
+    }
+}
+export interface DatabaseOptions {
+    readonly url?: string | undefined;
+    readonly dataDir?: string | undefined;
+    readonly migrationsFolder?: string | undefined;
+}
+export interface DatabaseHandle extends DataProvider<Database> {
+    readonly db: Database;
+    readonly driver: "pglite" | "node-postgres";
+    listen(channel: string, handler: (payload: string) => void, options?: ListenOptions): Promise<Unlisten>;
+    migrate(folder: string): Promise<void>;
+    close(): Promise<void>;
+}
+export declare const DEFAULT_PGLITE_DIR = ".parlor/pglite";
+export declare function resolveDatabaseUrl(env?: NodeJS.ProcessEnv): string | undefined;
+export declare function createDatabase(options?: DatabaseOptions): Promise<DatabaseHandle>;
+//# sourceMappingURL=database.d.ts.map

package/dist/database.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"database.d.ts","sourceRoot":"","sources":["../src/database.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAG1E,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAKxE,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,gBAAgB,CAAC,CAAC;AAEpD,OAAO,QAAQ,cAAc,CAAC;IAC5B,UAAU,YAAY;QACpB,QAAQ,EAAE,QAAQ,CAAC;KACpB;CACF;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChD;AAED,MAAM,WAAW,cAAe,SAAQ,YAAY,CAAC,QAAQ,CAAC;IAC5D,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC;IACtB,QAAQ,CAAC,MAAM,EAAE,QAAQ,GAAG,eAAe,CAAC;IAC5C,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,EAClC,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,QAAQ,CAAC,CAAC;IACrB,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAED,eAAO,MAAM,kBAAkB,mBAAmB,CAAC;AAEnD,wBAAgB,kBAAkB,CAChC,GAAG,GAAE,MAAM,CAAC,UAAwB,GACnC,MAAM,GAAG,SAAS,CAEpB;AAqFD,wBAAsB,cAAc,CAClC,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC,cAAc,CAAC,CAOzB"}

package/dist/database.js

@@ -0,0 +1,107 @@
+import { mkdir } from "node:fs/promises";
+import { dirname } from "node:path";
+import { PGlite } from "@electric-sql/pglite";
+import { drizzle as drizzlePg } from "drizzle-orm/node-postgres";
+import { migrate as migratePg } from "drizzle-orm/node-postgres/migrator";
+import { drizzle as drizzlePglite } from "drizzle-orm/pglite";
+import { migrate as migratePglite } from "drizzle-orm/pglite/migrator";
+import pg from "pg";
+export const DEFAULT_PGLITE_DIR = ".parlor/pglite";
+export function resolveDatabaseUrl(env = process.env) {
+    return env.DATABASE_URL || undefined;
+}
+function once(run) {
+    let result;
+    return () => (result ??= run());
+}
+function pgliteHandle(dataDir) {
+    const client = new PGlite(dataDir);
+    const db = drizzlePglite(client);
+    return {
+        db,
+        driver: "pglite",
+        read: () => db,
+        transaction: (run) => db.transaction((tx) => run(tx)),
+        listen: async (channel, handler) => {
+            const unlisten = await client.listen(channel, handler);
+            return () => unlisten();
+        },
+        migrate: (folder) => migratePglite(db, { migrationsFolder: folder }),
+        close: once(() => client.close()),
+    };
+}
+function nodePostgresHandle(url) {
+    const pool = new pg.Pool({ connectionString: url });
+    pool.on("error", (error) => {
+        console.warn("[parlor] an idle database connection dropped:", error.message);
+    });
+    const db = drizzlePg(pool);
+    const listeners = new Set();
+    return {
+        db,
+        driver: "node-postgres",
+        read: () => db,
+        transaction: (run) => db.transaction((tx) => run(tx)),
+        listen: async (channel, handler, options = {}) => {
+            const client = new pg.Client({ connectionString: url });
+            let state = "listening";
+            const current = () => state;
+            const lose = () => {
+                if (state !== "listening")
+                    return;
+                state = "lost";
+                listeners.delete(client);
+                client.end().catch(() => { });
+                options.onLost?.();
+            };
+            client.on("error", lose);
+            client.on("end", lose);
+            client.on("notification", (message) => {
+                if (message.channel === channel)
+                    handler(message.payload ?? "");
+            });
+            const identifier = pg.escapeIdentifier(channel);
+            try {
+                await client.connect();
+                await client.query(`LISTEN ${identifier}`);
+            }
+            catch (error) {
+                state = "closed";
+                await client.end().catch(() => { });
+                throw error;
+            }
+            if (current() === "lost")
+                throw new Error(`LISTEN ${identifier} lost its connection`);
+            listeners.add(client);
+            return async () => {
+                if (state !== "listening")
+                    return;
+                state = "closed";
+                listeners.delete(client);
+                await client.query(`UNLISTEN ${identifier}`).catch(() => { });
+                await client.end();
+            };
+        },
+        migrate: (folder) => migratePg(db, { migrationsFolder: folder }),
+        close: once(async () => {
+            await Promise.all([...listeners].map((client) => client.end()));
+            await pool.end();
+        }),
+    };
+}
+async function preparePgliteDir(dataDir) {
+    if (/^[a-z]+:\/\//i.test(dataDir))
+        return;
+    await mkdir(dirname(dataDir), { recursive: true });
+}
+export async function createDatabase(options = {}) {
+    const url = options.url ?? resolveDatabaseUrl();
+    const dataDir = options.dataDir ?? DEFAULT_PGLITE_DIR;
+    if (!url)
+        await preparePgliteDir(dataDir);
+    const handle = url ? nodePostgresHandle(url) : pgliteHandle(dataDir);
+    if (options.migrationsFolder)
+        await handle.migrate(options.migrationsFolder);
+    return handle;
+}
+//# sourceMappingURL=database.js.map

package/dist/database.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"database.js","sourceRoot":"","sources":["../src/database.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAE9C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,oCAAoC,CAAC;AAE1E,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,EAAE,MAAM,IAAI,CAAC;AA4BpB,MAAM,CAAC,MAAM,kBAAkB,GAAG,gBAAgB,CAAC;AAEnD,MAAM,UAAU,kBAAkB,CAChC,GAAG,GAAsB,OAAO,CAAC,GAAG;IAEpC,OAAO,GAAG,CAAC,YAAY,IAAI,SAAS,CAAC;AACvC,CAAC;AAED,SAAS,IAAI,CAAC,GAAwB;IACpC,IAAI,MAAiC,CAAC;IACtC,OAAO,GAAG,EAAE,CAAC,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC,CAAC;AAClC,CAAC;AAED,SAAS,YAAY,CAAC,OAAe;IACnC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;IACnC,MAAM,EAAE,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACjC,OAAO;QACL,EAAE;QACF,MAAM,EAAE,QAAQ;QAChB,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE;QACd,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACrD,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;YACjC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACvD,OAAO,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC1B,CAAC;QACD,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,aAAa,CAAC,EAAE,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE,CAAC;QACpE,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;KAClC,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAC,GAAW;IACrC,MAAM,IAAI,GAAG,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,gBAAgB,EAAE,GAAG,EAAE,CAAC,CAAC;IACpD,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;QACzB,OAAO,CAAC,IAAI,CAAC,+CAA+C,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAC/E,CAAC,CAAC,CAAC;IACH,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAC3B,MAAM,SAAS,GAAG,IAAI,GAAG,EAAa,CAAC;IACvC,OAAO;QACL,EAAE;QACF,MAAM,EAAE,eAAe;QACvB,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE;QACd,WAAW,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACrD,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,EAAE,EAAE,EAAE;YAC/C,MAAM,MAAM,GAAG,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,gBAAgB,EAAE,GAAG,EAAE,CAAC,CAAC;YACxD,IAAI,KAAK,GAAoC,WAAW,CAAC;YACzD,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC;YAC5B,MAAM,IAAI,GAAG,GAAG,EAAE;gBAChB,IAAI,KAAK,KAAK,WAAW;oBAAE,OAAO;gBAClC,KAAK,GAAG,MAAM,CAAC;gBACf,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBACzB,MAAM,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;gBAC7B,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;YACrB,CAAC,CAAC;YACF,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YACzB,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;YACvB,MAAM,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,OAAO,EAAE,EAAE;gBACpC,IAAI,OAAO,CAAC,OAAO,KAAK,OAAO;oBAAE,OAAO,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;YAClE,CAAC,CAAC,CAAC;YACH,MAAM,UAAU,GAAG,EAAE,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAChD,IAAI,CAAC;gBACH,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;gBACvB,MAAM,MAAM,CAAC,KAAK,CAAC,UAAU,UAAU,EAAE,CAAC,CAAC;YAC7C,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,KAAK,GAAG,QAAQ,CAAC;gBACjB,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;gBACnC,MAAM,KAAK,CAAC;YACd,CAAC;YACD,IAAI,OAAO,EAAE,KAAK,MAAM;gBACtB,MAAM,IAAI,KAAK,CAAC,UAAU,UAAU,sBAAsB,CAAC,CAAC;YAC9D,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACtB,OAAO,KAAK,IAAI,EAAE;gBAChB,IAAI,KAAK,KAAK,WAAW;oBAAE,OAAO;gBAClC,KAAK,GAAG,QAAQ,CAAC;gBACjB,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBACzB,MAAM,MAAM,CAAC,KAAK,CAAC,YAAY,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;gBAC7D,MAAM,MAAM,CAAC,GAAG,EAAE,CAAC;YACrB,CAAC,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,gBAAgB,EAAE,MAAM,EAAE,CAAC;QAChE,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE;YACrB,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAChE,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;QACnB,CAAC,CAAC;KACH,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,OAAe;IAC7C,IAAI,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC;QAAE,OAAO;IAC1C,MAAM,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,OAAO,GAAoB,EAAE;IAE7B,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,kBAAkB,EAAE,CAAC;IAChD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,kBAAkB,CAAC;IACtD,IAAI,CAAC,GAAG;QAAE,MAAM,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACrE,IAAI,OAAO,CAAC,gBAAgB;QAAE,MAAM,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC7E,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { createDatabase, type Database, type DatabaseHandle, type DatabaseOptions, DEFAULT_PGLITE_DIR, resolveDatabaseUrl, } from "./database.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,KAAK,QAAQ,EACb,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { createDatabase, DEFAULT_PGLITE_DIR, resolveDatabaseUrl, } from "./database.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EAId,kBAAkB,EAClB,kBAAkB,GACnB,MAAM,eAAe,CAAC"}

package/package.json

@@ -1,6 +1,39 @@
 {
   "name": "@parlor/data",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "homepage": "https://cychien.github.io/parlor",
+  "bugs": "https://github.com/cychien/parlor/issues",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cychien/parlor.git",
+    "directory": "packages/data"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@electric-sql/pglite": "^0.5.9",
+    "drizzle-orm": "^0.45.4",
+    "pg": "^8.23.1",
+    "@parlor/core": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.14.0",
+    "@types/pg": "^8.23.1",
+    "typescript": "^7.0.2",
+    "vitest": "^5.0.3"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run"
+  }
 }