@pgpmjs/pglite-adapter 1.8.2 → 1.9.0

package/README.md

@@ -60,6 +60,32 @@ await migrate.verify({ modulePath: './my-module' });
 await close(); // restores the previous factory and closes PGlite
 ```
 
+### As a pgpm CLI engine
+
+The package also exports the pgpm driver-plugin entrypoint (`createPgpmDriver`),
+so the `pgpm` CLI can deploy into PGlite with no server once this package is
+installed in the workspace being deployed:
+
+```sh
+pgpm deploy --engine pglite --package pets --database anything --yes
+pgpm deploy --pglite=./.pglite --package pets --database anything --yes  # persisted
+```
+
+Or make it the workspace default in `pgpm.json`:
+
+```json
+{
+  "packages": ["packages/*"],
+  "engine": "pglite",
+  "engines": { "pglite": { "options": { "dataDir": "./.pglite" } } }
+}
+```
+
+The options are the same `PgliteAdapterOptions` as `registerPglite`. The
+driver reports `createdb`/`dump`/`serverLifecycle`/`multiConnection` as false, so
+pgpm skips `deploy --createdb` and refuses `pgpm dump`, `pgpm docker`, `pgpm kill`,
+`pgpm tune` and `pgpm admin-users` on this engine.
+
 ### Extensions
 
 pgpm's `cleanSql` strips `CREATE EXTENSION` from migrations, so extensions are

package/esm/index.js

@@ -33,3 +33,26 @@ export const registerPglite = async (options = {}) => {
         }
     };
 };
+/**
+ * The pgpm driver-plugin entrypoint (`createPgpmDriver`), which is how the pgpm
+ * CLI activates this backend for `--engine pglite` / `--driver
+ * @pgpmjs/pglite-adapter`. It registers the in-process PGlite instance as the
+ * pool factory — exactly what {@link registerPglite} does — and describes what
+ * PGlite cannot do so the CLI skips server-only steps generically.
+ *
+ * PGlite is one WASM instance with a single superuser session, so: the instance
+ * *is* the database (no `createdb`), there is no `pg_dump` binary and no server
+ * to manage, and a second concurrent connection is not available.
+ */
+export const createPgpmDriver = async (options = {}) => {
+    const handle = await registerPglite(options);
+    return {
+        capabilities: {
+            createdb: false,
+            dump: false,
+            serverLifecycle: false,
+            multiConnection: false
+        },
+        teardown: () => handle.close()
+    };
+};

package/index.d.ts

@@ -1,4 +1,5 @@
 import { PGlite } from '@electric-sql/pglite';
+import type { PgpmDriverSession } from '@pgpmjs/types';
 export { createPgliteClient, type QueryablePgClient } from './client';
 export { createPglitePool } from './pool';
 export type { PgResultLike } from './runner';
@@ -41,3 +42,15 @@ export interface PgliteAdapterHandle {
  * await close();
  */
 export declare const registerPglite: (options?: PgliteAdapterOptions) => Promise<PgliteAdapterHandle>;
+/**
+ * The pgpm driver-plugin entrypoint (`createPgpmDriver`), which is how the pgpm
+ * CLI activates this backend for `--engine pglite` / `--driver
+ * @pgpmjs/pglite-adapter`. It registers the in-process PGlite instance as the
+ * pool factory — exactly what {@link registerPglite} does — and describes what
+ * PGlite cannot do so the CLI skips server-only steps generically.
+ *
+ * PGlite is one WASM instance with a single superuser session, so: the instance
+ * *is* the database (no `createdb`), there is no `pg_dump` binary and no server
+ * to manage, and a second concurrent connection is not available.
+ */
+export declare const createPgpmDriver: (options?: PgliteAdapterOptions) => Promise<PgpmDriverSession>;

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerPglite = exports.createPglitePool = exports.createPgliteClient = void 0;
+exports.createPgpmDriver = exports.registerPglite = exports.createPglitePool = exports.createPgliteClient = void 0;
 const pglite_1 = require("@electric-sql/pglite");
 const pg_cache_1 = require("pg-cache");
 const pool_1 = require("./pool");
@@ -39,3 +39,27 @@ const registerPglite = async (options = {}) => {
     };
 };
 exports.registerPglite = registerPglite;
+/**
+ * The pgpm driver-plugin entrypoint (`createPgpmDriver`), which is how the pgpm
+ * CLI activates this backend for `--engine pglite` / `--driver
+ * @pgpmjs/pglite-adapter`. It registers the in-process PGlite instance as the
+ * pool factory — exactly what {@link registerPglite} does — and describes what
+ * PGlite cannot do so the CLI skips server-only steps generically.
+ *
+ * PGlite is one WASM instance with a single superuser session, so: the instance
+ * *is* the database (no `createdb`), there is no `pg_dump` binary and no server
+ * to manage, and a second concurrent connection is not available.
+ */
+const createPgpmDriver = async (options = {}) => {
+    const handle = await (0, exports.registerPglite)(options);
+    return {
+        capabilities: {
+            createdb: false,
+            dump: false,
+            serverLifecycle: false,
+            multiConnection: false
+        },
+        teardown: () => handle.close()
+    };
+};
+exports.createPgpmDriver = createPgpmDriver;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pgpmjs/pglite-adapter",
-  "version": "1.8.2",
+  "version": "1.9.0",
   "author": "Constructive <developers@constructive.io>",
   "description": "PGlite driver for pgpm — registers an in-process PGlite instance as the pg-cache pool factory so the unmodified pgpm engine deploys into PGlite (WASM Postgres) with no server",
   "main": "index.js",
@@ -41,15 +41,17 @@
   },
   "devDependencies": {
     "@electric-sql/pglite": "0.5.4",
-    "@pgpmjs/core": "^7.15.0",
+    "@pgpmjs/core": "^7.16.0",
+    "@pgpmjs/types": "^2.47.0",
     "@types/pg": "^8.20.0",
-    "makage": "^0.3.0"
+    "makage": "^0.3.0",
+    "pgpm": "^5.15.0"
   },
   "dependencies": {
-    "pg-cache": "^3.23.1"
+    "pg-cache": "^3.23.2"
   },
   "peerDependencies": {
     "@electric-sql/pglite": ">=0.5.0"
   },
-  "gitHead": "5ef8341033a8fbd85841b770e996e468dd15333b"
+  "gitHead": "0286d994d98717cb9b28842233d2db6d1e37c48e"
 }