@voxpelli/pg-utils 4.0.0 → 4.1.0

package/index.d.ts

@@ -1,4 +1,5 @@
 export { csvFromFolderToDb } from "./lib/csv-folder-to-db.js";
 export { dbToCsvFolder } from "./lib/db-to-csv-folder.js";
+export type PgTestHelpersOptions = import("./lib/test-helpers.js").PgTestHelpersOptions;
 export { PgTestHelpers, pgTestSetup, pgTestSetupFor } from "./lib/test-helpers.js";
 //# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":""}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":";;mCAIc,OAAO,uBAAuB,EAAE,oBAAoB"}

package/index.js

@@ -1,3 +1,5 @@
 export { csvFromFolderToDb } from './lib/csv-folder-to-db.js';
 export { dbToCsvFolder } from './lib/db-to-csv-folder.js';
 export { PgTestHelpers, pgTestSetup, pgTestSetupFor } from './lib/test-helpers.js';
+
+/** @typedef {import('./lib/test-helpers.js').PgTestHelpersOptions} PgTestHelpersOptions */

package/lib/csv-folder-to-db.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"csv-folder-to-db.d.ts","sourceRoot":"","sources":["csv-folder-to-db.js"],"names":[],"mappings":"AAkHA,8CALW,MAAM,GAAG,IAAI,QACb,MAAM,GAAG,GAAG,YACZ,MAAM,EAAE,GAAG,wBAAwB,GACjC,OAAO,CAAC,IAAI,CAAC,CAgCzB;;qBA/Ea,MAAM,EAAE;6BACR,MAAM,EAAE;;0BAvDI,IAAI"}
+{"version":3,"file":"csv-folder-to-db.d.ts","sourceRoot":"","sources":["csv-folder-to-db.js"],"names":[],"mappings":"AAmHA,8CALW,MAAM,GAAG,IAAI,QACb,MAAM,GAAG,GAAG,YACZ,MAAM,EAAE,GAAG,wBAAwB,GACjC,OAAO,CAAC,IAAI,CAAC,CAgCzB;;qBA/Ea,MAAM,EAAE;6BACR,MAAM,EAAE;;0BAvDI,IAAI"}

package/lib/csv-folder-to-db.js

@@ -4,6 +4,7 @@ import pathModule from 'node:path';
 import { pipeline as promisedPipeline } from 'node:stream/promises';
 import { fileURLToPath } from 'node:url';
 
+import { isObjectWithKey } from '@voxpelli/typed-utils';
 import { from as copyFrom } from 'pg-copy-streams';
 import pg from 'pg';
 
@@ -116,7 +117,7 @@ export async function csvFromFolderToDb (connection, path, options) {
   const tablesWithDependencies = resolveTableOrder(options);
   const files = await getFilesOrderedByDependencies(path, tablesWithDependencies);
 
-  const ownPool = typeof connection !== 'object' || !('connect' in connection);
+  const ownPool = !isObjectWithKey(connection, 'connect');
   const pool = ownPool ? createPgPool(connection) : connection;
 
   try {

package/lib/db-to-csv-folder.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"db-to-csv-folder.d.ts","sourceRoot":"","sources":["db-to-csv-folder.js"],"names":[],"mappings":"AA8BA,0CANW,MAAM,GAAG,IAAI,cACb,MAAM,GAAG,GAAG,UACZ,MAAM,EAAE,YACR,oBAAoB,GAClB,OAAO,CAAC,IAAI,CAAC,CAgDzB;;cA7Da,MAAM;;0BAJM,IAAI"}
+{"version":3,"file":"db-to-csv-folder.d.ts","sourceRoot":"","sources":["db-to-csv-folder.js"],"names":[],"mappings":"AA+BA,0CANW,MAAM,GAAG,IAAI,cACb,MAAM,GAAG,GAAG,UACZ,MAAM,EAAE,YACR,oBAAoB,GAClB,OAAO,CAAC,IAAI,CAAC,CAgDzB;;cA7Da,MAAM;;0BAJM,IAAI"}

package/lib/db-to-csv-folder.js

@@ -4,6 +4,7 @@ import pathModule from 'node:path';
 import { pipeline } from 'node:stream/promises';
 import { fileURLToPath } from 'node:url';
 
+import { isObjectWithKey } from '@voxpelli/typed-utils';
 import pg from 'pg';
 import { to as copyTo } from 'pg-copy-streams';
 
@@ -49,7 +50,7 @@ export async function dbToCsvFolder (connection, outputPath, tables, options = {
 
   const escapedOrderBy = isColumnIndex ? orderBy : pg.escapeIdentifier(orderBy);
 
-  const ownPool = typeof connection !== 'object' || !('connect' in connection);
+  const ownPool = !isObjectWithKey(connection, 'connect');
   const pool = ownPool ? createPgPool(connection) : connection;
 
   try {

package/lib/test-helpers.d.ts

@@ -1,5 +1,5 @@
 export function pgTestSetup(options: PgTestHelpersOptions): Promise<PgTestHelpers>;
-export function pgTestSetupFor(options: PgTestHelpersOptions, t: {
+export function pgTestSetupFor(options: PgTestHelpersOptions, t: TestContext | SuiteContext | {
     after?: (fn: () => Promise<void>) => void;
 }): Promise<PgTestHelpers>;
 export class PgTestHelpers {
@@ -25,5 +25,7 @@ export type PgTestHelpersOptions = {
     tableLoadOrder?: Array<string[] | string>;
     tablesWithDependencies?: Array<string[] | string>;
 };
+import type { TestContext } from 'node:test';
+import type { SuiteContext } from 'node:test';
 import type { Pool } from 'pg';
 //# sourceMappingURL=test-helpers.d.ts.map

package/lib/test-helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"test-helpers.d.ts","sourceRoot":"","sources":["test-helpers.js"],"names":[],"mappings":"AA8UA,qCAHW,oBAAoB,GAClB,OAAO,CAAC,aAAa,CAAC,CAIlC;AAgBD,wCAJW,oBAAoB,KACpB;IAAE,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,CAAA;CAAE,GAC3C,OAAO,CAAC,aAAa,CAAC,CAUlC;AA7UD;IA2BE,qBADY,oBAAoB,EAsF/B;IAxFD,cADW,IAAI,CAAC,OAAO,CAAC,CACX;IAqKb,cADc,OAAO,CAAC,IAAI,CAAC,CAoB1B;IAGD,kBADc,OAAO,CAAC,IAAI,CAAC,CAuB1B;IASD,SAFa,OAAO,CAAC,IAAI,CAAC,CAgBzB;IAGD,gBADc,OAAO,CAAC,IAAI,CAAC,CAqB1B;IAGD,OADc,OAAO,CAAC,IAAI,CAAC,CAW1B;IAGD,yBADc,OAAO,CAAC,IAAI,CAAC,CAG1B;;CACF;;sBAtTa,MAAM;oBACN,MAAM,GAAG,GAAG;mBACZ,MAAM,EAAE;aACR,MAAM;oBACN,MAAM;yBACN,MAAM;iCACN,MAAM;YACN,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,OAAO,EAAE,KAAK,CAAC,OAAO,WAAW,EAAE,gBAAgB,CAAC,IAAI,EAAE,OAAO,WAAW,EAAE,sBAAsB,CAAC,CAAC,CAAC;qBAC9I,KAAK,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC;6BACxB,KAAK,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC;;0BAbJ,IAAI"}
+{"version":3,"file":"test-helpers.d.ts","sourceRoot":"","sources":["test-helpers.js"],"names":[],"mappings":"AAgVA,qCAHW,oBAAoB,GAClB,OAAO,CAAC,aAAa,CAAC,CAIlC;AAgBD,wCAJW,oBAAoB,KACpB,WAAW,GAAG,YAAY,GAAG;IAAE,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,CAAA;CAAE,GACxE,OAAO,CAAC,aAAa,CAAC,CAUlC;AA7UD;IA2BE,qBADY,oBAAoB,EAsF/B;IAxFD,cADW,IAAI,CAAC,OAAO,CAAC,CACX;IAqKb,cADc,OAAO,CAAC,IAAI,CAAC,CAoB1B;IAGD,kBADc,OAAO,CAAC,IAAI,CAAC,CAuB1B;IASD,SAFa,OAAO,CAAC,IAAI,CAAC,CAgBzB;IAGD,gBADc,OAAO,CAAC,IAAI,CAAC,CAqB1B;IAGD,OADc,OAAO,CAAC,IAAI,CAAC,CAW1B;IAGD,yBADc,OAAO,CAAC,IAAI,CAAC,CAG1B;;CACF;;sBAtTa,MAAM;oBACN,MAAM,GAAG,GAAG;mBACZ,MAAM,EAAE;aACR,MAAM;oBACN,MAAM;yBACN,MAAM;iCACN,MAAM;YACN,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,OAAO,EAAE,KAAK,CAAC,OAAO,WAAW,EAAE,gBAAgB,CAAC,IAAI,EAAE,OAAO,WAAW,EAAE,sBAAsB,CAAC,CAAC,CAAC;qBAC9I,KAAK,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC;6BACxB,KAAK,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC;;iCAbS,WAAW;kCAAX,WAAW;0BADxB,IAAI"}

package/lib/test-helpers.js

@@ -1,5 +1,6 @@
 import { readFile } from 'node:fs/promises';
 
+import { isKeyWithType, isStringArray } from '@voxpelli/typed-utils';
 import pg from 'pg';
 import {
   createUmzeptionPgContext,
@@ -7,9 +8,10 @@ import {
 } from 'umzeption';
 
 import { csvFromFolderToDb } from './csv-folder-to-db.js';
-import { createPgPool, createAndLockConnection, releaseLock, isStringArray, TypeNeverError } from './utils.js';
+import { createPgPool, createAndLockConnection, releaseLock, TypeNeverError } from './utils.js';
 
 /** @import { Pool, Client } from 'pg' */
+/** @import { TestContext, SuiteContext } from 'node:test' */
 
 /**
  * @typedef PgTestHelpersOptions
@@ -347,11 +349,11 @@ export async function pgTestSetup (options) {
  * (which has `after`). A clear error is thrown if `after` is missing.
  *
  * @param {PgTestHelpersOptions} options
- * @param {{ after?: (fn: () => Promise<void>) => void }} t Test context.
+ * @param {TestContext | SuiteContext | { after?: (fn: () => Promise<void>) => void }} t Test context.
  * @returns {Promise<PgTestHelpers>}
  */
 export async function pgTestSetupFor (options, t) {
-  if (typeof t?.after !== 'function') {
+  if (!isKeyWithType(t, 'after', 'function')) {
     throw new TypeError('pgTestSetupFor requires a test context with an after() method');
   }
 

package/lib/utils.d.ts

@@ -4,7 +4,6 @@ export function createAndLockConnection(connectionString: string, options?: {
     lockTimeoutMs?: number;
 }): Promise<Client>;
 export function releaseLock(lockClient: Client | Promise<Client>, lockId?: number): Promise<void>;
-export function isStringArray(value: unknown): value is string[];
 export class TypeNeverError extends TypeError {
     constructor(value: never, message: string, options?: ErrorOptions);
 }

package/lib/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AAuBA,+CAHW,MAAM,GACJ,IAAI,CAOhB;AAOD,0DAJW,MAAM,YACN;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,aAAa,CAAC,EAAE,MAAM,CAAA;CAAE,GACzC,OAAO,CAAC,MAAM,CAAC,CAwC3B;AAOD,wCAJW,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,WACxB,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAUzB;AA4BD,qCAHW,OAAO,GACL,KAAK,IAAI,MAAM,EAAE,CAK7B;AA5BD;IAME,mBAJW,KAAK,WACL,MAAM,YACN,YAAY,EAItB;CACF;0BAlGiC,IAAI;4BAAJ,IAAI"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AAuBA,+CAHW,MAAM,GACJ,IAAI,CAOhB;AAOD,0DAJW,MAAM,YACN;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,aAAa,CAAC,EAAE,MAAM,CAAA;CAAE,GACzC,OAAO,CAAC,MAAM,CAAC,CAwC3B;AAOD,wCAJW,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,WACxB,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAUzB;AAGD;IAME,mBAJW,KAAK,WACL,MAAM,YACN,YAAY,EAItB;CACF;0BAlGiC,IAAI;4BAAJ,IAAI"}

package/lib/utils.js

@@ -99,22 +99,3 @@ export class TypeNeverError extends TypeError {
     super(`${message}. Got: ${typeof value}`, options);
   }
 }
-
-/**
- * Array.isArray() on its own give type any[]
- *
- * @param {unknown} value
- * @returns {value is unknown[]}
- */
-function typesafeIsArray (value) {
-  return Array.isArray(value);
-}
-
-/**
- * @param {unknown} value
- * @returns {value is string[]}
- */
-export function isStringArray (value) {
-  if (!typesafeIsArray(value)) return false;
-  return value.every(item => typeof item === 'string');
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voxpelli/pg-utils",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": " My personal database utils / helpers for Postgres",
   "homepage": "http://github.com/voxpelli/pg-utils",
   "repository": {
@@ -71,6 +71,7 @@
   },
   "dependencies": {
     "@types/pg": "^8.16.0",
+    "@voxpelli/typed-utils": "^4.1.0",
     "pg": "^8.18.0",
     "pg-copy-streams": "^7.0.0",
     "umzeption": "^0.4.1",