pgpm 4.34.2 → 4.35.0

package/esm/utils/driver.js

@@ -0,0 +1,78 @@
+import { PGPM_DRIVER_EXPORT, } from '@pgpmjs/types';
+import { createRequire } from 'node:module';
+import { join } from 'node:path';
+/** Package name of the built-in PGlite driver plugin (the `--pglite` alias). */
+export const PGLITE_DRIVER_PLUGIN = '@pgpmjs/pglite-adapter';
+/**
+ * Resolve the effective driver config from `pgpm.json` and CLI overrides.
+ *
+ * Precedence: an explicit override (from `--driver <pkg>` or the `--pglite`
+ * alias) beats the configured `driver` block. `--pglite=<dataDir>` sets
+ * `options.dataDir`. Returns undefined for the built-in `pg` (server) path.
+ */
+export function resolveDriverConfig(configured, override) {
+    if (override) {
+        // Merge override options over configured options when targeting the same plugin.
+        const base = configured && configured.plugin === override.plugin ? configured.options : undefined;
+        return {
+            plugin: override.plugin,
+            options: { ...base, ...override.options },
+        };
+    }
+    return configured;
+}
+/**
+ * Translate the `--pglite` / `--driver` argv into a driver override.
+ *
+ * - `--pglite` (bare)        → PGlite in-memory
+ * - `--pglite=./local.db`    → PGlite persisted to `./local.db`
+ * - `--driver <pkg>`         → arbitrary driver plugin
+ */
+export function driverOverrideFromArgv(argv) {
+    if (argv.pglite !== undefined && argv.pglite !== false) {
+        const options = typeof argv.pglite === 'string' && argv.pglite.length > 0
+            ? { dataDir: argv.pglite }
+            : undefined;
+        return { plugin: PGLITE_DRIVER_PLUGIN, options };
+    }
+    if (argv.driver) {
+        return { plugin: argv.driver };
+    }
+    return undefined;
+}
+/**
+ * Load and activate the configured driver plugin, resolving it from the
+ * *consumer's* project (`cwd`) — the same way ESLint/Babel resolve plugins.
+ * pgpm ships no backend dependencies; the plugin is declared by the user's
+ * project. Returns undefined on the built-in server path.
+ *
+ * Resolution uses `createRequire` from `node:module` (not the ambient
+ * `require`) so it behaves identically in both makage build outputs: the CJS
+ * bundle and the `es2022` ESM bundle, where a bare `require`/`require.resolve`
+ * is undefined at runtime.
+ */
+export async function activateDriver(configured, override, cwd) {
+    const cfg = resolveDriverConfig(configured, override);
+    if (!cfg)
+        return undefined;
+    // A require bound to the consumer's project directory. `createRequire` is the
+    // one primitive available and identical in both CJS and ESM runtimes.
+    const requireFrom = createRequire(join(cwd, 'package.json'));
+    let mod;
+    try {
+        const entry = requireFrom.resolve(cfg.plugin);
+        mod = requireFrom(entry);
+    }
+    catch {
+        const extra = cfg.plugin.includes('pglite') ? ' @electric-sql/pglite' : '';
+        throw new Error(`pgpm driver "${cfg.plugin}" is not installed in this project.\n` +
+            `Run: npm i ${cfg.plugin}${extra}`);
+    }
+    // Support both a direct named export and an interop `default` wrapper.
+    const factory = (mod[PGPM_DRIVER_EXPORT] ??
+        mod.default?.[PGPM_DRIVER_EXPORT]);
+    if (typeof factory !== 'function') {
+        throw new Error(`"${cfg.plugin}" does not export ${PGPM_DRIVER_EXPORT} — it is not a pgpm driver plugin.`);
+    }
+    return factory(cfg.options);
+}

package/esm/utils/index.js

@@ -1,4 +1,5 @@
 export * from './database';
+export * from './driver';
 export * from './display';
 export * from './deployed-changes';
 export * from './module-utils';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pgpm",
-  "version": "4.34.2",
+  "version": "4.35.0",
   "author": "Constructive <developers@constructive.io>",
   "description": "PostgreSQL Package Manager - Database migration and package management CLI",
   "main": "index.js",
@@ -46,18 +46,18 @@
   },
   "dependencies": {
     "@inquirerer/utils": "^3.3.9",
-    "@pgpmjs/core": "^6.27.1",
-    "@pgpmjs/env": "^2.26.1",
-    "@pgpmjs/export": "^0.26.5",
+    "@pgpmjs/core": "^6.27.2",
+    "@pgpmjs/env": "^2.26.2",
+    "@pgpmjs/export": "^0.26.6",
     "@pgpmjs/logger": "^2.13.0",
-    "@pgpmjs/types": "^2.31.0",
+    "@pgpmjs/types": "^2.32.0",
     "@pgsql/quotes": "^17.1.0",
     "appstash": "^0.7.0",
     "find-and-require-package-json": "^0.9.1",
     "genomic": "^5.6.2",
     "inquirerer": "^4.9.1",
     "js-yaml": "^4.1.0",
-    "pg-cache": "^3.14.0",
+    "pg-cache": "^3.14.1",
     "pg-env": "^1.17.0",
     "pgsql-deparser": "^17.18.3",
     "semver": "^7.8.1",
@@ -76,5 +76,5 @@
     "pg",
     "pgsql"
   ],
-  "gitHead": "7cbe15fac21a9345b169203ba9542ba9a50c866c"
+  "gitHead": "87e65cd31d4e23c367ca4d398416b19ac863c7de"
 }

package/utils/driver.d.ts

@@ -0,0 +1,43 @@
+import { PgpmDriverConfig, PgpmDriverSession } from '@pgpmjs/types';
+/** Package name of the built-in PGlite driver plugin (the `--pglite` alias). */
+export declare const PGLITE_DRIVER_PLUGIN = "@pgpmjs/pglite-adapter";
+/**
+ * Resolve the effective driver config from `pgpm.json` and CLI overrides.
+ *
+ * Precedence: an explicit override (from `--driver <pkg>` or the `--pglite`
+ * alias) beats the configured `driver` block. `--pglite=<dataDir>` sets
+ * `options.dataDir`. Returns undefined for the built-in `pg` (server) path.
+ */
+export declare function resolveDriverConfig(configured: PgpmDriverConfig | undefined, override?: {
+    plugin: string;
+    options?: Record<string, unknown>;
+}): PgpmDriverConfig | undefined;
+/**
+ * Translate the `--pglite` / `--driver` argv into a driver override.
+ *
+ * - `--pglite` (bare)        → PGlite in-memory
+ * - `--pglite=./local.db`    → PGlite persisted to `./local.db`
+ * - `--driver <pkg>`         → arbitrary driver plugin
+ */
+export declare function driverOverrideFromArgv(argv: {
+    pglite?: boolean | string;
+    driver?: string;
+}): {
+    plugin: string;
+    options?: Record<string, unknown>;
+} | undefined;
+/**
+ * Load and activate the configured driver plugin, resolving it from the
+ * *consumer's* project (`cwd`) — the same way ESLint/Babel resolve plugins.
+ * pgpm ships no backend dependencies; the plugin is declared by the user's
+ * project. Returns undefined on the built-in server path.
+ *
+ * Resolution uses `createRequire` from `node:module` (not the ambient
+ * `require`) so it behaves identically in both makage build outputs: the CJS
+ * bundle and the `es2022` ESM bundle, where a bare `require`/`require.resolve`
+ * is undefined at runtime.
+ */
+export declare function activateDriver(configured: PgpmDriverConfig | undefined, override: {
+    plugin: string;
+    options?: Record<string, unknown>;
+} | undefined, cwd: string): Promise<PgpmDriverSession | undefined>;

package/utils/driver.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PGLITE_DRIVER_PLUGIN = void 0;
+exports.resolveDriverConfig = resolveDriverConfig;
+exports.driverOverrideFromArgv = driverOverrideFromArgv;
+exports.activateDriver = activateDriver;
+const types_1 = require("@pgpmjs/types");
+const node_module_1 = require("node:module");
+const node_path_1 = require("node:path");
+/** Package name of the built-in PGlite driver plugin (the `--pglite` alias). */
+exports.PGLITE_DRIVER_PLUGIN = '@pgpmjs/pglite-adapter';
+/**
+ * Resolve the effective driver config from `pgpm.json` and CLI overrides.
+ *
+ * Precedence: an explicit override (from `--driver <pkg>` or the `--pglite`
+ * alias) beats the configured `driver` block. `--pglite=<dataDir>` sets
+ * `options.dataDir`. Returns undefined for the built-in `pg` (server) path.
+ */
+function resolveDriverConfig(configured, override) {
+    if (override) {
+        // Merge override options over configured options when targeting the same plugin.
+        const base = configured && configured.plugin === override.plugin ? configured.options : undefined;
+        return {
+            plugin: override.plugin,
+            options: { ...base, ...override.options },
+        };
+    }
+    return configured;
+}
+/**
+ * Translate the `--pglite` / `--driver` argv into a driver override.
+ *
+ * - `--pglite` (bare)        → PGlite in-memory
+ * - `--pglite=./local.db`    → PGlite persisted to `./local.db`
+ * - `--driver <pkg>`         → arbitrary driver plugin
+ */
+function driverOverrideFromArgv(argv) {
+    if (argv.pglite !== undefined && argv.pglite !== false) {
+        const options = typeof argv.pglite === 'string' && argv.pglite.length > 0
+            ? { dataDir: argv.pglite }
+            : undefined;
+        return { plugin: exports.PGLITE_DRIVER_PLUGIN, options };
+    }
+    if (argv.driver) {
+        return { plugin: argv.driver };
+    }
+    return undefined;
+}
+/**
+ * Load and activate the configured driver plugin, resolving it from the
+ * *consumer's* project (`cwd`) — the same way ESLint/Babel resolve plugins.
+ * pgpm ships no backend dependencies; the plugin is declared by the user's
+ * project. Returns undefined on the built-in server path.
+ *
+ * Resolution uses `createRequire` from `node:module` (not the ambient
+ * `require`) so it behaves identically in both makage build outputs: the CJS
+ * bundle and the `es2022` ESM bundle, where a bare `require`/`require.resolve`
+ * is undefined at runtime.
+ */
+async function activateDriver(configured, override, cwd) {
+    const cfg = resolveDriverConfig(configured, override);
+    if (!cfg)
+        return undefined;
+    // A require bound to the consumer's project directory. `createRequire` is the
+    // one primitive available and identical in both CJS and ESM runtimes.
+    const requireFrom = (0, node_module_1.createRequire)((0, node_path_1.join)(cwd, 'package.json'));
+    let mod;
+    try {
+        const entry = requireFrom.resolve(cfg.plugin);
+        mod = requireFrom(entry);
+    }
+    catch {
+        const extra = cfg.plugin.includes('pglite') ? ' @electric-sql/pglite' : '';
+        throw new Error(`pgpm driver "${cfg.plugin}" is not installed in this project.\n` +
+            `Run: npm i ${cfg.plugin}${extra}`);
+    }
+    // Support both a direct named export and an interop `default` wrapper.
+    const factory = (mod[types_1.PGPM_DRIVER_EXPORT] ??
+        mod.default?.[types_1.PGPM_DRIVER_EXPORT]);
+    if (typeof factory !== 'function') {
+        throw new Error(`"${cfg.plugin}" does not export ${types_1.PGPM_DRIVER_EXPORT} — it is not a pgpm driver plugin.`);
+    }
+    return factory(cfg.options);
+}

package/utils/index.d.ts

@@ -1,4 +1,5 @@
 export * from './database';
+export * from './driver';
 export * from './display';
 export * from './deployed-changes';
 export * from './module-utils';

package/utils/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./database"), exports);
+__exportStar(require("./driver"), exports);
 __exportStar(require("./display"), exports);
 __exportStar(require("./deployed-changes"), exports);
 __exportStar(require("./module-utils"), exports);