@pgpmjs/types - npm Package Compare versions

Comparing version 2.31.0 to 2.32.0

driver.d.ts

+/**
+ * Pluggable migration-backend ("driver") contract.
+ *
+ * pgpm's engine only needs a node-`pg`-shaped pool/client (see `pg-cache` /
+ * `pgsql-client` seams). A *driver plugin* is a package that registers those
+ * factories against some backend (e.g. in-process PGlite) and tells pgpm which
+ * server-only steps to skip. pgpm core/CLI depend on this contract only — never
+ * on any specific backend or its dependencies. The plugin is resolved from the
+ * *consumer's* project, exactly like ESLint/Babel resolve plugins and presets.
+ */
+/**
+ * What a backend can and cannot do, so the CLI can generically skip server-only
+ * steps instead of hard-coding per-backend branches.
+ */
+export interface PgpmDriverCapabilities {
+    /** `false` → skip `createdb` / `--createdb` (the instance *is* the database). */
+    createdb: boolean;
+    /** `false` → skip `pg_dump` / `pgpm dump` (or the plugin provides its own dump). */
+    dump: boolean;
+    /** `false` → skip docker / server-lifecycle commands. */
+    serverLifecycle: boolean;
+    /**
+     * `false` → single-session backend: skip the two-connection `admin-users`
+     * bootstrap; roles are provisioned in-band instead.
+     */
+    multiConnection: boolean;
+}
+/**
+ * The activated backend session returned by a driver plugin. The plugin has
+ * already registered its pool/client factories by the time this resolves.
+ */
+export interface PgpmDriverSession {
+    /** Backend capabilities used to gate server-only CLI steps. */
+    capabilities: PgpmDriverCapabilities;
+    /** Restore the previously-active factories and release backend resources. */
+    teardown: () => Promise<void>;
+}
+/**
+ * The well-known entrypoint every driver plugin must export as
+ * `createPgpmDriver`. Called by the CLI after it resolves the plugin from the
+ * consumer's `node_modules`. Implementations register their pool/client
+ * factories (via the `pg-cache` / `pgsql-client` seams) and return their
+ * capabilities plus a teardown.
+ */
+export type PgpmDriverFactory = (options?: Record<string, unknown>) => Promise<PgpmDriverSession>;
+/**
+ * Selects and configures a pluggable migration backend. Configured under the
+ * `driver` key of `pgpm.json`; undefined means the built-in `pg` (server) path.
+ */
+export interface PgpmDriverConfig {
+    /**
+     * Package name of the driver plugin, resolved from the consumer's
+     * `node_modules` (e.g. `@pgpmjs/pglite-adapter`).
+     */
+    plugin: string;
+    /** Opaque options forwarded to the plugin's `createPgpmDriver(options)`. */
+    options?: Record<string, unknown>;
+}
+/** Named export a driver plugin module must expose. */
+export declare const PGPM_DRIVER_EXPORT: "createPgpmDriver";

driver.js

+"use strict";
+/**
+ * Pluggable migration-backend ("driver") contract.
+ *
+ * pgpm's engine only needs a node-`pg`-shaped pool/client (see `pg-cache` /
+ * `pgsql-client` seams). A *driver plugin* is a package that registers those
+ * factories against some backend (e.g. in-process PGlite) and tells pgpm which
+ * server-only steps to skip. pgpm core/CLI depend on this contract only — never
+ * on any specific backend or its dependencies. The plugin is resolved from the
+ * *consumer's* project, exactly like ESLint/Babel resolve plugins and presets.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PGPM_DRIVER_EXPORT = void 0;
+/** Named export a driver plugin module must expose. */
+exports.PGPM_DRIVER_EXPORT = 'createPgpmDriver';

esm/driver.js

+/**
+ * Pluggable migration-backend ("driver") contract.
+ *
+ * pgpm's engine only needs a node-`pg`-shaped pool/client (see `pg-cache` /
+ * `pgsql-client` seams). A *driver plugin* is a package that registers those
+ * factories against some backend (e.g. in-process PGlite) and tells pgpm which
+ * server-only steps to skip. pgpm core/CLI depend on this contract only — never
+ * on any specific backend or its dependencies. The plugin is resolved from the
+ * *consumer's* project, exactly like ESLint/Babel resolve plugins and presets.
+ */
+/** Named export a driver plugin module must expose. */
+export const PGPM_DRIVER_EXPORT = 'createPgpmDriver';

esm/index.js

@@ -0,1 +1,2 @@
+export * from './driver';
 export * from './error';
@@ -2,0 +3,0 @@ export * from './error-factory';

index.d.ts

@@ -0,1 +1,2 @@
+export * from './driver';
 export * from './error';
@@ -2,0 +3,0 @@ export * from './error-factory';

index.js

@@ -17,2 +17,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./driver"), exports);
 __exportStar(require("./error"), exports);
@@ -19,0 +20,0 @@ __exportStar(require("./error-factory"), exports);

package.json

 {
   "name": "@pgpmjs/types",
-  "version": "2.31.0",
+  "version": "2.32.0",
   "author": "Constructive <[e-mail]>",
@@ -45,3 +45,3 @@ "description": "PGPM types",
   },
-  "gitHead": "5a7e92e9849aa715367a33fa78a23c5f9adaefa0"
+  "gitHead": "87e65cd31d4e23c367ca4d398416b19ac863c7de"
 }

pgpm.d.ts

 import { PgConfig } from 'pg-env';
+import { PgpmDriverConfig } from './driver';
 import { JobsConfig } from './jobs';
@@ -242,2 +243,8 @@ /**
     smtp?: SmtpOptions;
+    /**
+     * Pluggable migration backend. Undefined = built-in `pg` (server) path.
+     * Set `driver.plugin` to a package (e.g. `@pgpmjs/pglite-adapter`) resolved
+     * from the consumer's `node_modules`.
+     */
+    driver?: PgpmDriverConfig;
 }
@@ -244,0 +251,0 @@ /**

New alerts

AI-detected potential code anomaly

Supply chain risk

AI has identified unusual behaviors that may pose a security risk.

Fixed alerts

AI-detected potential code anomaly

Supply chain risk

AI has identified unusual behaviors that may pose a security risk.

Improved metrics

Total package byte prevSize

57522

8.46%

Number of package files

27

12.5%

Lines of code

1387

7.52%

No dependency changes