Add createSimplePgClientFromClient. Version bump.

Author: samhuk

package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-pg-client",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Simplified Javascript PostgreSQL client.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/index.ts

@@ -1,7 +1,13 @@
 import { Client } from 'pg'
 import { loop } from './common/function'
 import { createDbService } from './dbService'
-import { SimplePgClientOptions, SimplePgClient, ResolvedMaintenanceDbOptions, SimplePgClientEventHandlers } from './types'
+import {
+  SimplePgClientOptions,
+  SimplePgClient,
+  ResolvedMaintenanceDbOptions,
+  SimplePgClientEventHandlers,
+  SimplePgClientFromClientOptions,
+} from './types'
 
 const createDbUrl = (
   host: string,
@@ -199,7 +205,7 @@ export const createConsoleLogEventHandlers = (): SimplePgClientEventHandlers =>
 })
 
 /**
- * Creates an instance of `SimplePgClient`, connecting to a PostgreSQL database.
+ * Creates an instance of `SimplePgClient`, connecting to a PostgreSQL server.
  */
 export const createSimplePgClient = async (options: SimplePgClientOptions): Promise<SimplePgClient> => {
   // Optionally create db if it does not exist, via a defined maintenance db on the server
@@ -247,3 +253,26 @@ export const createSimplePgClient = async (options: SimplePgClientOptions): Prom
     queryGetRows: dbService.queryGetRows,
   }
 }
+
+/**
+ * Creates an instance of `SimplePgClient` from an already-connected `Client` instance (from `pg`).
+ */
+export const createSimplePgClientFromClient = (options: SimplePgClientFromClientOptions): SimplePgClient => {
+  // Create db service, providing query functions on pg client
+  const dbService = createDbService({
+    client: options.client,
+    sqlLoggingTruncation: options.sqlLoggingTruncation,
+    events: {
+      onError: options.events?.onQueryError,
+      onQuery: options.events?.onQuery,
+    },
+  })
+
+  return {
+    client: options.client,
+    query: dbService.query,
+    queryExists: dbService.queryExists,
+    queryGetFirstRow: dbService.queryGetFirstRow,
+    queryGetRows: dbService.queryGetRows,
+  }
+}

src/types.ts

@@ -43,6 +43,11 @@ export type ResolvedMaintenanceDbOptions = OmitTyped<Required<MaintenanceDbOptio
 
 type VoidOrPromiseVoid = void | Promise<void>
 
+export type SimplePgClientQueryEventHandlers = {
+  onQuery?: DbServiceOptions['events']['onQuery']
+  onQueryError?: DbServiceOptions['events']['onError']
+}
+
 export type SimplePgClientEventHandlers = {
   onTryMaintenanceDbConnect?: (c: Client, retryIndex: number, message: string) => VoidOrPromiseVoid
   onMaintenanceDbConnect?: (c: Client, retryIndex: number, message: string) => VoidOrPromiseVoid
@@ -61,9 +66,26 @@ export type SimplePgClientEventHandlers = {
   onDbConnect?: (c: Client, message: string) => void | VoidOrPromiseVoid
   onDbConnectFail?: (c: Client, retryIndex: number, e: any, message: string) => VoidOrPromiseVoid
   onDbConnectNumRetryExceeded?: (c: Client, retryIndex: number, e: any, message: string) => VoidOrPromiseVoid
+} & SimplePgClientQueryEventHandlers
 
-  onQuery?: DbServiceOptions['events']['onQuery']
-  onQueryError?: DbServiceOptions['events']['onError']
+export type SimplePgClientFromClientOptions = {
+  /**
+   * The `Client` (from `pg`) to use to create the `SimplePgClient` instance from.
+   */
+  client: Client
+  /**
+   * Maximum number of characters in the `sql` parameter of `events.onQuery` and `events.onQueryError`.
+   *
+   * Leave as `undefined` or `-1` to disable truncation.
+   *
+   * @default undefined
+   */
+  sqlLoggingTruncation?: number
+  /**
+   * Events of the client that can be handled. Each one can return a promise, pausing
+   * execution until it resolves.
+   */
+  events?: SimplePgClientQueryEventHandlers
 }
 
 /**