@voxpelli/pg-utils 2.1.0 → 2.3.0

package/README.md

@@ -20,7 +20,8 @@ import {
 const pgHelpers = new PgTestHelpers({
   connectionString: 'postgres://user:pass@localhost/example',
   fixtureFolder: new URL('./fixtures', import.meta.url),
-  schema: new URL('./create-tables.sql', import.meta.url),,
+  ignoreTables: ['xyz'],
+  schema: new URL('./create-tables.sql', import.meta.url),
   tablesWithDependencies: [
     'abc',
     ['foo', 'bar'],
@@ -38,7 +39,10 @@ Class that creates a helpers instance
 new PgTestHelpers({
   connectionString: 'postgres://user:pass@localhost/example',
   fixtureFolder: new URL('./fixtures', import.meta.url),
-  schema: new URL('./create-tables.sql', import.meta.url),,
+  ignoreTables: [
+    // ...
+  ],
+  schema: new URL('./create-tables.sql', import.meta.url),
   tablesWithDependencies: [
     // ...
   ]
@@ -53,6 +57,7 @@ new PgTestHelpers({
 
 * `connectionString` – _`string | _ – a connection string for the postgres database
 * `fixtureFolder` – _`[string | URL]`_ – _optional_ – the path to a folder of `.csv`-file fixtures named by their respective table
+* `ignoreTables` – _`[string[]]`_ – _optional_ – names of tables to ignore when dropping
 * `schema` – _`string | URL | Umzug`_ – an umzug instance that can be used to initialize tables or the schema itself or a `URL` to a text file containing the schema
 * `tablesWithDependencies` – _`[Array<string[] | string>]`_ – _optional_ – names of tables that depend on other tables. If some of these tables depend on each other, then use nested arrays to ensure that within the same array no two tables depend on each other
 

package/lib/test-helpers.d.ts

@@ -10,7 +10,8 @@ export class PgTestHelpers {
 export type PgTestHelpersOptions = {
     connectionString: string;
     fixtureFolder?: string | URL;
-    schema: string | URL | (() => import("umzug").Umzug<import("umzeption").UmzeptionContext<"pg", import("umzeption").FastifyPostgresStyleDb>>);
+    ignoreTables?: string[];
+    schema: string | URL | ((pool: Pool) => import("umzug").Umzug<import("umzeption").UmzeptionContext<"pg", import("umzeption").FastifyPostgresStyleDb>>);
     tablesWithDependencies?: Array<string[] | string>;
 };
 import type { Pool } from 'pg';

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

@@ -1 +1 @@
-{"version":3,"file":"test-helpers.d.ts","sourceRoot":"","sources":["test-helpers.js"],"names":[],"mappings":"AAoBA;IAaE,qBADY,oBAAoB,EAiC/B;IAnCD,cADW,IAAI,CAAC,OAAO,CAAC,CACX;IAoEb,cADc,OAAO,CAAC,IAAI,CAAC,CAiB1B;IAGD,kBADc,OAAO,CAAC,IAAI,CAAC,CAM1B;IAGD,gBADc,OAAO,CAAC,IAAI,CAAC,CAM1B;IAGD,OADc,OAAO,CAAC,IAAI,CAAC,CAG1B;;CACF;;sBA1Ha,MAAM;oBACN,MAAM,GAAG,GAAG;YACZ,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,OAAO,OAAO,EAAE,KAAK,CAAC,OAAO,WAAW,EAAE,gBAAgB,CAAC,IAAI,EAAE,OAAO,WAAW,EAAE,sBAAsB,CAAC,CAAC,CAAC;6BACpI,KAAK,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC;;0BAPZ,IAAI"}
+{"version":3,"file":"test-helpers.d.ts","sourceRoot":"","sources":["test-helpers.js"],"names":[],"mappings":"AAqBA;IAeE,qBADY,oBAAoB,EAsC/B;IAxCD,cADW,IAAI,CAAC,OAAO,CAAC,CACX;IAyEb,cADc,OAAO,CAAC,IAAI,CAAC,CAiB1B;IAGD,kBADc,OAAO,CAAC,IAAI,CAAC,CAM1B;IAGD,gBADc,OAAO,CAAC,IAAI,CAAC,CAc1B;IAGD,OADc,OAAO,CAAC,IAAI,CAAC,CAG1B;;CACF;;sBA1Ia,MAAM;oBACN,MAAM,GAAG,GAAG;mBACZ,MAAM,EAAE;YACR,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;6BAC9I,KAAK,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC;;0BARZ,IAAI"}

package/lib/test-helpers.js

@@ -14,13 +14,16 @@ import { createPgPool, isStringArray, TypeNeverError } from './utils.js';
  * @typedef PgTestHelpersOptions
  * @property {string} connectionString
  * @property {string | URL} [fixtureFolder]
- * @property {string | URL | (() => import('umzug').Umzug<import('umzeption').UmzeptionContext<'pg', import('umzeption').FastifyPostgresStyleDb>>)} schema
+ * @property {string[]} [ignoreTables]
+ * @property {string | URL | ((pool: Pool) => import('umzug').Umzug<import('umzeption').UmzeptionContext<'pg', import('umzeption').FastifyPostgresStyleDb>>)} schema
  * @property {Array<string[] | string>} [tablesWithDependencies]
  */
 
 export class PgTestHelpers {
   /** @type {string | URL | undefined} */
   #fixtureFolder;
+  /** @type {string[] | undefined} */
+  #ignoreTables;
   /** @type {Pool} */
   #pool;
   /** @type {PgTestHelpersOptions['schema']} */
@@ -39,6 +42,7 @@ export class PgTestHelpers {
     const {
       connectionString,
       fixtureFolder,
+      ignoreTables,
       schema,
       tablesWithDependencies,
     } = options;
@@ -49,6 +53,9 @@ export class PgTestHelpers {
     if (fixtureFolder && typeof fixtureFolder !== 'string' && !(fixtureFolder instanceof URL)) {
       throw new TypeNeverError(fixtureFolder, 'Invalid fixtureFolder, expected a string');
     }
+    if (ignoreTables && !Array.isArray(ignoreTables)) {
+      throw new TypeNeverError(ignoreTables, 'Invalid ignoreTables, expected an array');
+    }
     if (typeof schema !== 'string' && typeof schema !== 'object' && typeof schema !== 'function') {
       throw new TypeNeverError(schema, 'Invalid schema, expected a string, object or function');
     }
@@ -59,6 +66,7 @@ export class PgTestHelpers {
     const pool = createPgPool(connectionString);
 
     this.#fixtureFolder = fixtureFolder;
+    this.#ignoreTables = ignoreTables;
     this.#tablesWithDependencies = tablesWithDependencies;
     this.#pool = pool;
     this.#schema = schema;
@@ -88,8 +96,8 @@ export class PgTestHelpers {
           Array.isArray(name)
             ? this.#removeTablesByName(name)
             : this.queryPromise('DROP TABLE IF EXISTS ' + name + ' CASCADE').catch(cause => {
-                throw new Error(`Failed to drop table: ${name}`, { cause });
-              })
+              throw new Error(`Failed to drop table: ${name}`, { cause });
+            })
         );
       }
     }
@@ -99,7 +107,7 @@ export class PgTestHelpers {
   async initTables () {
     try {
       if (typeof this.#schema === 'function') {
-        await this.#schema().up();
+        await this.#schema(this.#pool).up();
         return;
       }
 
@@ -127,7 +135,15 @@ export class PgTestHelpers {
     if (this.#tablesWithDependencies) {
       await this.#removeTablesByName(this.#tablesWithDependencies);
     }
-    await this.#removeTablesByName(await this.#getTableNames());
+
+    let tableNames = await this.#getTableNames();
+    const ignoreTables = this.#ignoreTables;
+
+    if (ignoreTables) {
+      tableNames = tableNames.filter(name => !ignoreTables.includes(name));
+    }
+
+    await this.#removeTablesByName(tableNames);
   }
 
   /** @returns {Promise<void>} */

package/lib/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AAMA,+CAHW,MAAM,GACJ,OAAO,IAAI,EAAE,IAAI,CAO7B;AA2BD,qCAHW,OAAO,GACL,KAAK,IAAI,MAAM,EAAE,CAK7B;AA5BD;IAME,mBAJW,KAAK,WACL,MAAM,YACN,YAAY,EAItB;CACF"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AAMA,+CAHW,MAAM,GACJ,OAAO,IAAI,EAAE,IAAI,CAO7B;AA4BD,qCAHW,OAAO,GACL,KAAK,IAAI,MAAM,EAAE,CAK7B;AA5BD;IAME,mBAJW,KAAK,WACL,MAAM,YACN,YAAY,EAItB;CACF"}

package/lib/utils.js

@@ -11,6 +11,7 @@ export function createPgPool (connectionString) {
   });
 }
 
+// TODO: Export to typed-utils maybe?
 export class TypeNeverError extends TypeError {
   /**
    * @param {never} value

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voxpelli/pg-utils",
-  "version": "2.1.0",
+  "version": "2.3.0",
   "description": " My personal database utils / helpers for Postgres",
   "homepage": "http://github.com/voxpelli/pg-utils",
   "repository": {
@@ -47,22 +47,22 @@
     "@types/chai": "^4.3.20",
     "@types/chai-as-promised": "^7.1.8",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^20.17.17",
+    "@types/node": "^20.17.31",
     "@types/pg-copy-streams": "^1.2.5",
-    "@voxpelli/eslint-config": "^22.2.0",
-    "@voxpelli/tsconfig": "^15.1.1",
+    "@voxpelli/eslint-config": "^23.0.0",
+    "@voxpelli/tsconfig": "^15.1.2",
     "c8": "^10.1.3",
     "chai": "^4.5.0",
     "chai-as-promised": "^7.1.2",
-    "dotenv": "^16.4.7",
-    "eslint": "^9.19.0",
+    "dotenv": "^16.5.0",
+    "eslint": "^9.25.1",
     "husky": "^9.1.7",
     "installed-check": "^9.3.0",
-    "knip": "^5.43.6",
+    "knip": "^5.50.5",
     "mocha": "^11.1.0",
     "npm-run-all2": "^7.0.2",
     "type-coverage": "^2.29.7",
-    "typescript": "~5.7.3",
+    "typescript": "~5.8.3",
     "validate-conventional-commit": "^1.0.4"
   },
   "dependencies": {