@steadybrew/postgresjs 4.4.0 → 4.5.0-rc1

package/src/types.js

@@ -248,6 +248,11 @@ export const inferType = function inferType(x) {
   )
 }
 
+export function clientSerialize(x) {
+  const proto = typeof x === 'object' && Object.getPrototypeOf(x)
+  return proto === Object.prototype || proto === null ? JSON.stringify(x) : '' + x
+}
+
 const escapeBackslash = /\\/g
 const escapeQuote = /"/g
 

package/types/index.d.ts

@@ -110,6 +110,10 @@ interface BaseOptions<T extends Record<string, postgres.PostgresType>> {
    * @default true
    */
   fetch_types: boolean;
+  /** How values whose type cannot be told from the JavaScript value are serialized: 'server' (default) asks PostgreSQL for the placeholder's type first, 'client' sends their text for PostgreSQL to parse, 'warn' does the same as 'server' and reports values 'client' would send differently */
+  parameter_types: 'server' | 'client' | 'warn';
+  /** Called in parameter_types: 'warn' mode with each query whose values would be sent differently, console.warn by default; if it throws, the error is rethrown as an uncaught exception */
+  ontypemismatch: (report: postgres.TypeMismatchReport) => void;
   /**
    * Publications to subscribe to (only relevant when calling `sql.subscribe()`)
    * @default 'alltables'
@@ -411,6 +415,23 @@ declare namespace postgres {
     };
   }
 
+  interface TypeMismatchReport {
+    query: string;
+    parameters: TypeMismatch[];
+  }
+
+  interface TypeMismatch {
+    /** The `$n` number of the placeholder */
+    position: number;
+    /** The type OID PostgreSQL inferred for the placeholder */
+    oid: number;
+    typeof: string;
+    /** Only set when debug is enabled */
+    serverText?: string;
+    /** Only set when debug is enabled; the error is what the 'client' mode would throw */
+    clientText?: string | globalThis.Error;
+  }
+
   interface Notice {
     [field: string]: string;
   }
@@ -742,6 +763,9 @@ declare namespace postgres {
 
     end(options?: { timeout?: number | undefined } | undefined): Promise<void>;
 
+    /** Calls `end()` with no timeout when an `await using` scope exits */
+    [Symbol.asyncDispose](): Promise<void>;
+
     listen(channel: string, onnotify: (value: string) => void, onlisten?: (() => void) | undefined): ListenRequest;
 
     /** `onerror` receives replication connection errors and errors thrown while a change is decoded; such a change is skipped. */
@@ -767,6 +791,12 @@ declare namespace postgres {
 
   interface ReservedSql<TTypes extends Record<string, unknown> = {}> extends Sql<TTypes> {
     release(): void;
+
+    /** Calls `release()` when a `using` scope exits */
+    [Symbol.dispose](): void;
+
+    /** Calls `release()` when an `await using` scope exits */
+    [Symbol.asyncDispose](): Promise<void>;
   }
 }
 

package/types/package.json

@@ -1,5 +1,5 @@
 {
   "devDependencies": {
-    "@types/node": "^16"
+    "@types/node": "^22"
   }
 }