@crvouga/mockingbird-service-postgres 1.3.1 → 1.5.0

package/dist/wire/connection.d.ts

@@ -21,6 +21,11 @@ export type ConnectionOptions = {
     parameters: Record<string, string>;
     faults: ServerFaults;
     onLog?: (entry: ServerLog) => void;
+    /**
+     * When set, a startup packet that names a different database is fatal `3D000`.
+     * Unset accepts any database name.
+     */
+    database?: string;
 };
 /**
  * One client connection: the protocol state machine over the shared {@link Cluster}.

package/dist/wire/index.d.ts

@@ -44,12 +44,27 @@ export type ServeOptions = {
     parameters?: Record<string, string>;
     /** Per-statement log sink, for tests and debugging. */
     onLog?: (entry: ServerLog) => void;
+    /**
+     * `postgres://` or `postgresql://` URL. User, password, host, port, and database name
+     * fill the fields above when those fields are omitted. An omitted port means `5432`;
+     * pass port `0` in the URL (`postgres://postgres@127.0.0.1:0/app`) for an ephemeral port.
+     */
+    url?: string;
+    /**
+     * Database name clients must request in the startup packet. A different name is
+     * SQLSTATE `3D000`. Set from `url` when the path is non-empty. Unset accepts any name.
+     */
+    databaseName?: string;
+    /** Role shown in `connectionString`. A URI's username fills this. Default `postgres`. */
+    user?: string;
 };
 export type PostgresServer = {
     /** The bound port. */
     readonly port: number;
     /** The bound host. */
     readonly host: string;
+    /** `postgres://` URL for the bound address, including the database name. */
+    readonly connectionString: string;
     /** The shared engine, for seeding, snapshotting or asserting from the test process. */
     readonly database: Database;
     /** The underlying `net.Server`. */
@@ -63,7 +78,8 @@ export type PostgresServer = {
     /** Stop listening and close every connection. */
     close(): Promise<void>;
 };
-/** Start a server and resolve once it is listening. */
-export declare const serve: (options?: ServeOptions) => Promise<PostgresServer>;
+export type ServeInput = ServeOptions | string;
+/** Start a server and resolve once it is listening. A string argument is a `postgres://` URI. */
+export declare const serve: (input?: ServeInput) => Promise<PostgresServer>;
 export { Cluster } from "./cluster.js";
 export type { ServerFaults, ServerLog } from "./connection.js";