@prisma/dev 0.20.0 → 0.22.0

package/dist/index.d.ts

@@ -1,9 +1,55 @@
 import { Exports, ServerOptions } from './state.js';
 export { ServerAlreadyRunningError } from './state.js';
-import { DBServerPurpose } from './db.js';
+import { WalEvent, DBServerPurpose } from './db.js';
 import 'valibot';
 import '@electric-sql/pglite';
 
+/**
+ * A readonly batch of WAL events emitted together.
+ *
+ * @experimental This API may change without notice.
+ */
+type ExperimentalWalEventBatch = readonly WalEvent[];
+/**
+ * Callback invoked when a batch of WAL events is available.
+ *
+ * @experimental This API may change without notice.
+ */
+type ExperimentalWalEventCallback = (events: ExperimentalWalEventBatch) => void;
+/**
+ * The experimental public WAL event API returned from `startPrismaDevServer()`.
+ *
+ * @experimental This API may change without notice.
+ */
+interface ExperimentalWalEvents {
+    /**
+     * Subscribe to WAL event batches. The returned function unsubscribes the callback.
+     */
+    subscribe(callback: ExperimentalWalEventCallback): () => void;
+    /**
+     * Create an async iterator that yields WAL event batches as they arrive.
+     */
+    stream(): AsyncIterableIterator<ExperimentalWalEventBatch>;
+}
+/**
+ * Experimental capabilities exposed on the public programmatic server.
+ *
+ * @experimental This API may change without notice.
+ */
+interface ExperimentalServerFeatures {
+    readonly wal: ExperimentalWalEvents;
+}
+interface ProgrammaticServer extends Exports {
+    close(): Promise<void>;
+    /**
+     * Experimental capabilities that may change without notice.
+     *
+     * @experimental
+     */
+    experimental: ExperimentalServerFeatures;
+    name: string;
+}
+
 declare const DEFAULT_DATABASE_PORT = 51214;
 declare const DEFAULT_SERVER_PORT = 51213;
 declare const DEFAULT_SHADOW_DATABASE_PORT = 51215;
@@ -14,20 +60,19 @@ declare class PortNotAvailableError extends Error {
     constructor(port: number);
 }
 
-interface Server extends Exports {
-    close(): Promise<void>;
-    name: string;
-}
-type ReadonlyServer = Omit<Server, "close">;
+type ReadonlyServer = Omit<ProgrammaticServer, "close">;
 /**
  * Starts a `prisma dev` server instance programmatically.
  *
  * DO NOT USE IN PRODUCTION. This is only intended for development and testing purposes.
+ *
+ * The returned server also includes experimental capabilities under `server.experimental`,
+ * including WAL event subscriptions at `server.experimental.wal`.
  */
-declare function startPrismaDevServer(options?: ServerOptions): Promise<Server>;
+declare function startPrismaDevServer(options?: ServerOptions): Promise<ProgrammaticServer>;
 /**
  * @deprecated use {@link startPrismaDevServer} instead.
  */
-declare function unstable_startServer(options?: ServerOptions): Promise<Server>;
+declare function unstable_startServer(options?: ServerOptions): Promise<ProgrammaticServer>;
 
-export { DEFAULT_DATABASE_PORT, DEFAULT_SERVER_PORT, DEFAULT_SHADOW_DATABASE_PORT, type PortAssignableService, PortNotAvailableError, type ReadonlyServer, type Server, ServerOptions, startPrismaDevServer, unstable_startServer };
+export { DEFAULT_DATABASE_PORT, DEFAULT_SERVER_PORT, DEFAULT_SHADOW_DATABASE_PORT, type ExperimentalServerFeatures, WalEvent as ExperimentalWalEvent, type ExperimentalWalEventBatch, type ExperimentalWalEvents, type PortAssignableService, PortNotAvailableError, type ReadonlyServer, type ProgrammaticServer as Server, ServerOptions, startPrismaDevServer, unstable_startServer };

package/dist/index.js

@@ -1 +1 @@
-import{a as f,b as g}from"./chunk-RJ42AYBU.js";import"./chunk-XMKRRRGB.js";import{g as e}from"./chunk-LKYVOPH3.js";import{a,b,c,g as d}from"./chunk-OTI5SWIV.js";import"./chunk-7NDL3ECU.js";import"./chunk-ITQ6ILGR.js";export{a as DEFAULT_DATABASE_PORT,b as DEFAULT_SERVER_PORT,c as DEFAULT_SHADOW_DATABASE_PORT,d as PortNotAvailableError,e as ServerAlreadyRunningError,f as startPrismaDevServer,g as unstable_startServer};
+import{a as f,b as g}from"./chunk-UZK2DL6R.js";import"./chunk-DZGCLGSX.js";import{g as e}from"./chunk-FIY24ARL.js";import{a,b,c,g as d}from"./chunk-OTI5SWIV.js";import"./chunk-6ORCLJD5.js";import"./chunk-DGKV2DPF.js";export{a as DEFAULT_DATABASE_PORT,b as DEFAULT_SERVER_PORT,c as DEFAULT_SHADOW_DATABASE_PORT,d as PortNotAvailableError,e as ServerAlreadyRunningError,f as startPrismaDevServer,g as unstable_startServer};

package/dist/state.d.cts

@@ -51,21 +51,19 @@ interface ServerOptions {
     /**
      * Connection timeout in milliseconds for pending database connections.
      *
-     * Starts ticking for every new client that attempts to connect. When exceeded,
-     * the pending client connection is evicted and closed.
+     * This option is currently not enforced by the multiplexed
+     * `@electric-sql/pglite-socket` server used by `@prisma/dev`.
+     * It is kept for API compatibility until upstream exposes a queue-timeout
+     * equivalent again.
      *
      * Default is 1 minute (60,000 milliseconds).
-     *
-     * Use it with caution, as it may lead to unexpected behavior. Best used with
-     * a pool client that retries connections.
      */
     databaseConnectTimeoutMillis?: number;
     /**
-     * Idle timeout in milliseconds for active database connections.
+     * Idle timeout in milliseconds for open database connections.
      *
-     * Re-starts ticking after each message received on the active connection. When
-     * exceeded - meaning there hasn't been any activity for a while, the active
-     * client connection is closed, and a pending connection is promoted to active.
+     * Re-starts ticking after each message received on a connection. When exceeded,
+     * that client connection is closed by the socket server.
      *
      * Is not applied by default.
      *

package/dist/state.d.ts

@@ -51,21 +51,19 @@ interface ServerOptions {
     /**
      * Connection timeout in milliseconds for pending database connections.
      *
-     * Starts ticking for every new client that attempts to connect. When exceeded,
-     * the pending client connection is evicted and closed.
+     * This option is currently not enforced by the multiplexed
+     * `@electric-sql/pglite-socket` server used by `@prisma/dev`.
+     * It is kept for API compatibility until upstream exposes a queue-timeout
+     * equivalent again.
      *
      * Default is 1 minute (60,000 milliseconds).
-     *
-     * Use it with caution, as it may lead to unexpected behavior. Best used with
-     * a pool client that retries connections.
      */
     databaseConnectTimeoutMillis?: number;
     /**
-     * Idle timeout in milliseconds for active database connections.
+     * Idle timeout in milliseconds for open database connections.
      *
-     * Re-starts ticking after each message received on the active connection. When
-     * exceeded - meaning there hasn't been any activity for a while, the active
-     * client connection is closed, and a pending connection is promoted to active.
+     * Re-starts ticking after each message received on a connection. When exceeded,
+     * that client connection is closed by the socket server.
      *
      * Is not applied by default.
      *

package/dist/state.js

@@ -1 +1 @@
-import{a,b,c,d,e,f,g}from"./chunk-LKYVOPH3.js";import"./chunk-OTI5SWIV.js";import"./chunk-ITQ6ILGR.js";export{g as ServerAlreadyRunningError,a as ServerState,f as ServerStateAlreadyExistsError,b as deleteServer,c as getServerStatus,d as isServerRunning,e as killServer};
+import{a,b,c,d,e,f,g}from"./chunk-FIY24ARL.js";import"./chunk-OTI5SWIV.js";import"./chunk-DGKV2DPF.js";export{g as ServerAlreadyRunningError,a as ServerState,f as ServerStateAlreadyExistsError,b as deleteServer,c as getServerStatus,d as isServerRunning,e as killServer};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prisma/dev",
-  "version": "0.20.0",
+  "version": "0.22.0",
   "description": "A local Prisma Postgres server for development and testing",
   "type": "module",
   "author": "Igal Klebanov <igalklebanov@gmail.com> (https://github.com/igalklebanov)",
@@ -66,8 +66,10 @@
     "@arethetypeswrong/cli": "0.18.2",
     "@types/node": "25.0.9",
     "@types/pako": "2.0.4",
+    "@types/pg": "8.15.6",
     "@types/proper-lockfile": "4.1.4",
     "env-paths": "3.0.0",
+    "pg": "8.16.0",
     "pkg-types": "2.3.0",
     "tsup": "8.5.1",
     "typescript": "5.9.3",
@@ -75,9 +77,9 @@
     "common-stuff": "^0.0.0"
   },
   "dependencies": {
-    "@electric-sql/pglite": "0.3.15",
-    "@electric-sql/pglite-socket": "0.0.20",
-    "@electric-sql/pglite-tools": "0.2.20",
+    "@electric-sql/pglite": "0.3.16",
+    "@electric-sql/pglite-socket": "0.0.22",
+    "@electric-sql/pglite-tools": "0.2.21",
     "@hono/node-server": "1.19.9",
     "@mrleebo/prisma-ast": "0.13.1",
     "@prisma/get-platform": "7.2.0",
@@ -98,7 +100,7 @@
     "check:exports": "attw . --pack --profile node16",
     "dev": "tsup --watch",
     "lint": "eslint --fix .",
-    "test": "",
+    "test": "vitest run",
     "typecheck": "tsc --noEmit"
   }
 }

package/dist/chunk-RJ42AYBU.js

@@ -1 +0,0 @@
-import{a as d}from"./chunk-XMKRRRGB.js";import{a as P}from"./chunk-LKYVOPH3.js";import{g as u}from"./chunk-OTI5SWIV.js";import{a as f,c as v,d as g}from"./chunk-7NDL3ECU.js";import{createServer as A}from"http";import{promisify as R}from"util";import T from"@prisma/get-platform";async function y(o,e){let{port:r}=e;if(e.dryRun)return w(r,null);let n=await D(o,e),{promise:m,reject:l,resolve:a}=v(),{serve:c}=await import("@hono/node-server"),i=c({createServer:A,fetch:n.fetch,overrideGlobalObjects:!1,port:r},a);i.on("error",s=>{if(typeof s=="object"&&"code"in s&&s.code==="EADDRINUSE")return l(new u(r));console.error("[Accelerate]",s)});let{port:t}=await m;return e.port=t,w(t,i)}function w(o,e){return{async close(){e&&await Promise.allSettled([R(e.close.bind(e))(),g.stopAll()])},port:o,url:`http://localhost:${o}`}}async function D(o,e){let{debug:r}=e,[{Hono:n},{accelerateRoute:m},{utilityRoute:l}]=await Promise.all([import("hono/tiny"),import("./accelerate-EEKAFGN3.js"),import("./utility-Q5A254LJ.js")]),a=new n,c=await T.getPlatformInfo();if(r&&console.debug("[Accelerate] platform info: %s",JSON.stringify(c)),r){let{logger:t}=await import("hono/logger");a.use("*",t((...s)=>console.log("[Accelerate]",...s)))}a.use("*",async(t,s)=>(t.set("databaseDumpPath",e.databaseDumpPath),t.set("db",o),t.set("debug",!!r),t.set("name",e.name),t.set("platform",c),t.set("shadowDBPort",e.shadowDatabasePort),await s()));let i=new n;return i.route("/",m),i.route("/",l),a.route("/",i),a}async function E(o){let e=await P.createExclusively(o),[r,n]=await Promise.all([d("database",e),d("shadow_database",e)]),m=await y(r,e),l=`prisma+postgres://localhost:${m.port}/?${new URLSearchParams({api_key:f({databaseUrl:r.prismaORMConnectionString,name:e.name,shadowDatabaseUrl:n.prismaORMConnectionString})}).toString()}`,a={database:{connectionString:r.connectionString,prismaORMConnectionString:r.prismaORMConnectionString,terminalCommand:r.terminalCommand},http:{url:m.url},ppg:{url:l},shadowDatabase:{connectionString:n.prismaORMConnectionString,prismaORMConnectionString:n.prismaORMConnectionString,terminalCommand:n.terminalCommand}};return await e.writeServerDump(a),{...a,close:()=>c(e,[m,r,n]),name:e.name};async function c(i,t){let S=(await Promise.allSettled(t.map(p=>p.close()))).filter(p=>p.status==="rejected").map(p=>new Error(p.reason));try{await i.close()}catch(p){S.push(p)}if(S.length>0)throw new AggregateError(S,"Failed to close some servers")}}async function J(o){return await E(o)}export{E as a,J as b};

package/dist/chunk-XMKRRRGB.js

@@ -1 +0,0 @@
-import{g as b}from"./chunk-OTI5SWIV.js";import{e as g}from"./chunk-ITQ6ILGR.js";import{filename as S}from"pathe/utils";var o={connectionLimit:1,connectTimeout:0,database:"template1",maxIdleConnectionLifetime:0,password:"postgres",poolTimeout:0,socketTimeout:0,sslMode:"disable",username:"postgres"},h=`postgres://${o.username}:${o.password}@localhost`,y=new URLSearchParams({sslmode:o.sslMode}),T=new URLSearchParams({...Object.fromEntries(y.entries()),connection_limit:String(o.connectionLimit),connect_timeout:String(o.connectTimeout),max_idle_connection_lifetime:String(o.maxIdleConnectionLifetime),pool_timeout:String(o.poolTimeout),single_use_connections:"true",socket_timeout:String(o.socketTimeout)});async function x(e,t){let r=e==="database"?t.databasePort:t.shadowDatabasePort;if(t.dryRun)return f(e,t,{db:null,port:r,server:null});let{debug:n}=t,a=await(e==="shadow_database"?v:_)(t.pgliteDataDirPath,n);n&&a.onNotification((d,l)=>{console.debug(`[${e}][${d}] ${l}`)});let{PGLiteSocketHandler:m,PGLiteSocketServer:s}=await import("@electric-sql/pglite-socket"),c=e==="shadow_database"?t.shadowDatabaseIdleTimeoutMillis:t.databaseIdleTimeoutMillis;E(c,a,m);let u=new s({connectionQueueTimeout:e==="shadow_database"?t.shadowDatabaseConnectTimeoutMillis:t.databaseConnectTimeoutMillis,db:a,debug:n,inspect:n,port:r});n&&(u.addEventListener("listening",d=>{let{detail:l}=d;console.debug(`[${e}] server listening on ${JSON.stringify(l)}`)}),u.addEventListener("connection",d=>{let{clientAddress:l,clientPort:P}=d.detail;console.debug(`[${e}] client connected from ${l}:${P}`)}),u.addEventListener("error",d=>{let{detail:l}=d;console.error(`[${e}] server error:`,l)}));try{await u.start()}catch(d){throw d instanceof Error&&"code"in d&&d.code==="EADDRINUSE"?new b(r):d}let p=Number(u.getServerConn().split(":").at(1));return t[e==="database"?"databasePort":"shadowDatabasePort"]=p,f(e,t,{db:a,port:p,server:u})}function f(e,t,r){let{debug:n}=t,{db:i,port:a,server:m}=r||{};return n&&console.debug(`[${e}] server started on port ${a}`),{...o,close:async()=>{let s=[];try{await m?.stop(),n&&console.debug(`[${e}] server stopped on port ${a}`)}catch(c){console.error(`[${e}] server stop error`,c),s.push(c)}if(e==="database")try{await i?.syncToFs(),n&&console.debug(`[${e}] synced to filesystem`)}catch(c){console.error(`[${e}] sync error`,c),s.push(c)}try{await i?.close(),n&&console.debug(`[${e}] closed`)}catch(c){console.error(`[${e}] close error`,c),s.push(c)}if(s.length>0)throw new AggregateError(s,`Failed to close ${e} properly`)},connectionString:D(a,y),dump:async s=>{e==="shadow_database"||!i||await $({db:i,debug:n,destinationPath:s})},port:a,prismaORMConnectionString:D(a,T),terminalCommand:`PGPASSWORD=${o.password} PGSSLMODE=${o.sslMode} psql -h localhost -p ${a} -U ${o.username} -d ${o.database}`}}function D(e,t){return`${h}:${e}/${o.database}?${t.toString()}`}async function _(e,t){let{PGlite:r}=await import("@electric-sql/pglite");return await r.create({database:o.database,dataDir:e,debug:t?5:void 0,extensions:await w(),relaxedDurability:!1,username:o.username})}async function v(e,t){let{PGlite:r}=await import("@electric-sql/pglite");return await r.create({database:o.database,dataDir:"memory://",debug:t?5:void 0,extensions:await w(),relaxedDurability:!1,username:o.username})}async function w(){let e=await Promise.all([import("@electric-sql/pglite/contrib/amcheck"),import("@electric-sql/pglite/contrib/bloom"),import("@electric-sql/pglite/contrib/btree_gin"),import("@electric-sql/pglite/contrib/btree_gist"),import("@electric-sql/pglite/contrib/citext"),import("@electric-sql/pglite/contrib/cube"),import("@electric-sql/pglite/contrib/dict_int"),import("@electric-sql/pglite/contrib/dict_xsyn"),import("@electric-sql/pglite/contrib/earthdistance"),import("@electric-sql/pglite/contrib/file_fdw"),import("@electric-sql/pglite/contrib/fuzzystrmatch"),import("@electric-sql/pglite/contrib/hstore"),import("@electric-sql/pglite/contrib/intarray"),import("@electric-sql/pglite/contrib/isn"),import("@electric-sql/pglite/contrib/lo"),import("@electric-sql/pglite/contrib/ltree"),import("@electric-sql/pglite/contrib/pageinspect"),import("@electric-sql/pglite/contrib/pg_buffercache"),import("@electric-sql/pglite/contrib/pg_freespacemap"),import("@electric-sql/pglite/contrib/pg_surgery"),import("@electric-sql/pglite/contrib/pg_trgm"),import("@electric-sql/pglite/contrib/pg_visibility"),import("@electric-sql/pglite/contrib/pg_walinspect"),import("@electric-sql/pglite/contrib/seg"),import("@electric-sql/pglite/contrib/tablefunc"),import("@electric-sql/pglite/contrib/tcn"),import("@electric-sql/pglite/contrib/tsm_system_rows"),import("@electric-sql/pglite/contrib/tsm_system_time"),import("@electric-sql/pglite/contrib/unaccent"),import("@electric-sql/pglite/contrib/uuid_ossp"),import("@electric-sql/pglite/vector")]);return Object.assign({},...e)}function E(e,t,r){if(t.__IDLE_TIMEOUT__=e,r.prototype.__ATTACH_OVERRIDDEN__)return;r.prototype.__ATTACH_OVERRIDDEN__=!0;let n=r.prototype.attach;r.prototype.attach=async function(i){let a=await n.call(this,i);if(!Number.isFinite(this.db.__IDLE_TIMEOUT__))return a;let m=null,s=()=>{m!=null&&(clearTimeout(m),m=null)},c=()=>{s(),m=setTimeout(()=>{this.dispatchEvent(new CustomEvent("close")),this.detach(!1)},this.db.__IDLE_TIMEOUT__)};return i.on("error",()=>{s()}),i.on("data",()=>{c()}),i.on("close",()=>{s()}),c(),a}}async function $(e){let{dataDir:t,db:r,debug:n,destinationPath:i}=e,a=r||await _(t,n),{pgDump:m}=await import("@electric-sql/pglite-tools/pg_dump"),s=await m({args:["--schema-only","--no-owner"],fileName:i?S(i):void 0,pg:await a.clone()});return i?(n&&console.debug(`[DB] Dumping database to ${i}`),await g(s,i)):(n&&console.debug("[DB] Dumping database to memory"),await s.text())}export{x as a,$ as b};