@voxpelli/pg-utils 1.0.0 → 1.1.0

package/README.md

@@ -17,15 +17,14 @@ import {
   PgTestHelpers,
 } from '@voxpelli/pg-utils';
 
-import pg from 'pg';
-
 const pgHelpers = new PgTestHelpers({
   connectionString: 'postgres://user:pass@localhost/example',
-  fixtureFolder: new URL('./fixtures', ),
-  pg,
-  umzug: new Umzug({
-    // ...
-  }),
+  fixtureFolder: new URL('./fixtures', import.meta.url),
+  schema: new URL('./create-tables.sql', import.meta.url),,
+  tablesWithDependencies: [
+    'abc',
+    ['foo', 'bar'],
+  ]
 });
 ```
 
@@ -38,10 +37,11 @@ Class that creates a helpers instance
 ```ts
 new PgTestHelpers({
   connectionString: 'postgres://user:pass@localhost/example',
-  fixtureFolder: new URL('./fixtures', ),
-  umzugInstall: new Umzug({
+  fixtureFolder: new URL('./fixtures', import.meta.url),
+  schema: new URL('./create-tables.sql', import.meta.url),,
+  tablesWithDependencies: [
     // ...
-  }),
+  ]
 });
 ```
 
@@ -51,10 +51,10 @@ new PgTestHelpers({
 
 ### PgTestHelpersOptions
 
-* `connectionString` – _`string`_ – a connection string for the postgres database
-* `fixtureFolder` – _`[string]`_ – _optional_ – the path to a folder of `.csv`-file fixtures named by their respective table
-* `tablesWithDependencies` – _`[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
-* `umzugInstall` – _`Umzug`_ – an umzug instance that can be used to initialize tables
+* `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
+* `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
 
 ### Methods
 

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

@@ -1,4 +1,3 @@
-export function csvFromFolderToDb(connection: ConnectionConfig | Pool, path: string | URL, tablesWithDependencies?: string[] | undefined): Promise<void>;
-import type { ConnectionConfig } from './utils.js';
+export function csvFromFolderToDb(connection: string | Pool, path: string | URL, tablesWithDependencies?: string[] | undefined): Promise<void>;
 import type { Pool } from 'pg';
 //# sourceMappingURL=csv-folder-to-db.d.ts.map

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":"AAmEA,8CALW,gBAAgB,GAAG,IAAI,QACvB,MAAM,GAAG,GAAG,2BACZ,MAAM,EAAE,GAAG,SAAS,GAClB,OAAO,CAAC,IAAI,CAAC,CAwBzB;sCA7EqC,YAAY;0BAFxB,IAAI"}
+{"version":3,"file":"csv-folder-to-db.d.ts","sourceRoot":"","sources":["csv-folder-to-db.js"],"names":[],"mappings":"AAiEA,8CALW,MAAM,GAAG,IAAI,QACb,MAAM,GAAG,GAAG,2BACZ,MAAM,EAAE,GAAG,SAAS,GAClB,OAAO,CAAC,IAAI,CAAC,CAwBzB;0BA7EyB,IAAI"}

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

@@ -10,8 +10,6 @@ import { createPgPool } from './utils.js';
 
 /** @import { Pool } from 'pg' */
 
-/** @import { ConnectionConfig } from './utils.js' */
-
 /**
  * @param {string | URL} path
  * @param {string} [extension]
@@ -60,7 +58,7 @@ async function getFilesOrderedByDependencies (path, tablesWithDependencies) {
 }
 
 /**
- * @param {ConnectionConfig | Pool} connection
+ * @param {string | Pool} connection
  * @param {string | URL} path
  * @param {string[] | undefined} [tablesWithDependencies]
  * @returns {Promise<void>}

package/lib/test-helpers.d.ts

@@ -7,11 +7,10 @@ export class PgTestHelpers {
     #private;
 }
 export type PgTestHelpersOptions = {
-    connectionConfig: ConnectionConfig;
+    connectionString: string;
     fixtureFolder?: string | URL;
     schema: string | URL | import("umzug").Umzug;
     tablesWithDependencies?: Array<string[] | string>;
 };
 import type { Pool } from 'pg';
-import type { ConnectionConfig } from './utils.js';
 //# 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":"AAsBA;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;;CACF;;sBArHa,gBAAgB;oBAChB,MAAM,GAAG,GAAG;YACZ,MAAM,GAAG,GAAG,GAAG,OAAO,OAAO,EAAE,KAAK;6BACpC,KAAK,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC;;0BATZ,IAAI;sCAEQ,YAAY"}
+{"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;;CACF;;sBArHa,MAAM;oBACN,MAAM,GAAG,GAAG;YACZ,MAAM,GAAG,GAAG,GAAG,OAAO,OAAO,EAAE,KAAK;6BACpC,KAAK,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC;;0BAPZ,IAAI"}

package/lib/test-helpers.js

@@ -10,11 +10,9 @@ import { createPgPool, isStringArray, TypeNeverError } from './utils.js';
 
 /** @import { Pool } from 'pg' */
 
-/** @import { ConnectionConfig } from './utils.js' */
-
 /**
  * @typedef PgTestHelpersOptions
- * @property {ConnectionConfig} connectionConfig
+ * @property {string} connectionString
  * @property {string | URL} [fixtureFolder]
  * @property {string | URL | import('umzug').Umzug} schema
  * @property {Array<string[] | string>} [tablesWithDependencies]
@@ -39,14 +37,14 @@ export class PgTestHelpers {
     }
 
     const {
-      connectionConfig,
+      connectionString,
       fixtureFolder,
       schema,
       tablesWithDependencies,
     } = options;
 
-    if (typeof connectionConfig !== 'string' && typeof connectionConfig !== 'object') {
-      throw new TypeNeverError(connectionConfig, 'Invalid connectionConfig, expected a string or an object');
+    if (typeof connectionString !== 'string') {
+      throw new TypeNeverError(connectionString, 'Invalid connectionString, expected a string');
     }
     if (fixtureFolder && typeof fixtureFolder !== 'string' && !(fixtureFolder instanceof URL)) {
       throw new TypeNeverError(fixtureFolder, 'Invalid fixtureFolder, expected a string');
@@ -58,7 +56,7 @@ export class PgTestHelpers {
       throw new TypeNeverError(tablesWithDependencies, 'Invalid tablesWithDependencies, expected an array');
     }
 
-    const pool = createPgPool(connectionConfig);
+    const pool = createPgPool(connectionString);
 
     this.#fixtureFolder = fixtureFolder;
     this.#tablesWithDependencies = tablesWithDependencies;

package/lib/utils.d.ts

@@ -1,8 +1,6 @@
-export function createPgPool(connectionString: ConnectionConfig): import("pg").Pool;
+export function createPgPool(connectionString: string): import("pg").Pool;
 export function isStringArray(value: unknown): value is string[];
 export class TypeNeverError extends TypeError {
     constructor(value: never, message: string, options?: ErrorOptions);
 }
-export type ConnectionConfigObject = Pick<import("pg").ClientConfig, "host" | "port" | "user" | "password" | "stream">;
-export type ConnectionConfig = string | ConnectionConfigObject;
 //# sourceMappingURL=utils.d.ts.map

package/lib/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AASA,+CAHW,gBAAgB,GACd,OAAO,IAAI,EAAE,IAAI,CAO7B;AA2BD,qCAHW,OAAO,GACL,KAAK,IAAI,MAAM,EAAE,CAK7B;AA5BD;IAME,mBAJW,KAAK,WACL,MAAM,YACN,YAAY,EAItB;CACF;qCAvBa,IAAI,CAAC,OAAO,IAAI,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,QAAQ,CAAC;+BACjF,MAAM,GAAG,sBAAsB"}
+{"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"}

package/lib/utils.js

@@ -1,16 +1,13 @@
 import pg from 'pg';
 
-/** @typedef {Pick<import('pg').ClientConfig, 'host' | 'port' | 'user' | 'password' | 'stream'>} ConnectionConfigObject */
-/** @typedef {string | ConnectionConfigObject} ConnectionConfig */
-
 /**
- * @param {ConnectionConfig} connectionString
+ * @param {string} connectionString
  * @returns {import('pg').Pool}
  */
 export function createPgPool (connectionString) {
   return new pg.Pool({
-    ...(typeof connectionString === 'object' ? connectionString : { connectionString }),
     allowExitOnIdle: true,
+    connectionString,
   });
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voxpelli/pg-utils",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": " My personal database utils / helpers for Postgres",
   "homepage": "http://github.com/voxpelli/pg-utils",
   "repository": {
@@ -62,7 +62,8 @@
     "mocha": "^10.8.2",
     "npm-run-all2": "^7.0.1",
     "type-coverage": "^2.29.7",
-    "typescript": "~5.7.2"
+    "typescript": "~5.7.2",
+    "validate-conventional-commit": "^1.0.4"
   },
   "dependencies": {
     "@types/pg": "^8.11.10",