@pgpmjs/types - npm Package Compare versions

Comparing version 2.46.0 to 2.47.0

driver.d.ts

@@ -61,1 +61,20 @@ /**
 export declare const PGPM_DRIVER_EXPORT: "createPgpmDriver";
+/**
+ * A named engine, in the sqitch sense: a short name (`pg`, `pglite`) that
+ * selects a backend, so users say `--engine pglite` instead of naming a plugin
+ * package. `plugin: undefined` marks the built-in server path.
+ */
+export interface PgpmEngineConfig {
+    /** Driver plugin backing the engine; undefined = built-in `pg` (server). */
+    plugin?: string;
+    /** Default options forwarded to the plugin's `createPgpmDriver(options)`. */
+    options?: Record<string, unknown>;
+}
+/** Engine used when nothing selects one: the built-in Postgres server path. */
+export declare const DEFAULT_ENGINE = "pg";
+/**
+ * Engines pgpm knows by name. Anything else must be declared in the `engines`
+ * block of `pgpm.json` (the analogue of sqitch's `[engine "name"]` sections) or
+ * named directly with `--driver <package>`.
+ */
+export declare const BUILTIN_ENGINES: Record<string, PgpmEngineConfig>;

driver.js

@@ -13,4 +13,15 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PGPM_DRIVER_EXPORT = void 0;
+exports.BUILTIN_ENGINES = exports.DEFAULT_ENGINE = exports.PGPM_DRIVER_EXPORT = void 0;
 /** Named export a driver plugin module must expose. */
 exports.PGPM_DRIVER_EXPORT = 'createPgpmDriver';
+/** Engine used when nothing selects one: the built-in Postgres server path. */
+exports.DEFAULT_ENGINE = 'pg';
+/**
+ * Engines pgpm knows by name. Anything else must be declared in the `engines`
+ * block of `pgpm.json` (the analogue of sqitch's `[engine "name"]` sections) or
+ * named directly with `--driver <package>`.
+ */
+exports.BUILTIN_ENGINES = {
+    [exports.DEFAULT_ENGINE]: {},
+    pglite: { plugin: '@pgpmjs/pglite-adapter' }
+};

esm/driver.js

@@ -13,1 +13,12 @@ /**
 export const PGPM_DRIVER_EXPORT = 'createPgpmDriver';
+/** Engine used when nothing selects one: the built-in Postgres server path. */
+export const DEFAULT_ENGINE = 'pg';
+/**
+ * Engines pgpm knows by name. Anything else must be declared in the `engines`
+ * block of `pgpm.json` (the analogue of sqitch's `[engine "name"]` sections) or
+ * named directly with `--driver <package>`.
+ */
+export const BUILTIN_ENGINES = {
+    [DEFAULT_ENGINE]: {},
+    pglite: { plugin: '@pgpmjs/pglite-adapter' }
+};

package.json

 {
   "name": "@pgpmjs/types",
-  "version": "2.46.0",
+  "version": "2.47.0",
   "author": "Constructive <[e-mail]>",
@@ -46,3 +46,3 @@ "description": "PGPM types",
   },
-  "gitHead": "5ef8341033a8fbd85841b770e996e468dd15333b"
+  "gitHead": "0286d994d98717cb9b28842233d2db6d1e37c48e"
 }

pgpm.d.ts

 import { PgConfig } from 'pg-env';
-import { PgpmDriverConfig } from './driver';
+import { PgpmDriverConfig, PgpmEngineConfig } from './driver';
 /**
@@ -281,6 +281,18 @@ * Authentication options for test client sessions
     /**
-     * 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`.
+     * Name of the migration backend to target, like sqitch's `core.engine`.
+     * Defaults to `pg` (the built-in server path); `pglite` is also built in,
+     * and any other name must be declared in {@link engines}.
      */
+    engine?: string;
+    /**
+     * Engine definitions, the analogue of sqitch's `[engine "name"]` sections.
+     * Entries override/extend {@link BUILTIN_ENGINES}, mapping an engine name to
+     * the driver plugin backing it plus that engine's default options.
+     */
+    engines?: Record<string, PgpmEngineConfig>;
+    /**
+     * Pluggable migration backend, named by plugin package rather than by engine
+     * name — the low-level escape hatch behind {@link engine}. Undefined = the
+     * built-in `pg` (server) path. Resolved from the consumer's `node_modules`.
+     */
     driver?: PgpmDriverConfig;
@@ -287,0 +299,0 @@ }

New alerts

AI-detected potential code anomaly

Supply chain risk

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

Found 2 instances

Fixed alerts

AI-detected potential code anomaly

Supply chain risk

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

Found 2 instances

Improved metrics

Total package byte prevSize

47424

5.43%

Lines of code

1122

4.96%

No dependency changes