@juit/pgproxy-utils 1.0.0

package/README.md

@@ -0,0 +1,119 @@
+# PostgreSQL Proxy Utilities
+
+This package provides a number of different utilities for developing and testing
+with `PGProxy`.
+
+* [Test Databases](#test-databases)
+* [Database Migrations](#database-migrations)
+* [Persister Schema Generation](#persister-schema-generation)
+* [PGProxy](https://github.com/juitnow/juit-pgproxy/blob/main/README.md)
+* [Copyright Notice](https://github.com/juitnow/juit-pgproxy/blob/main/NOTICE.md)
+* [License](https://github.com/juitnow/juit-pgproxy/blob/main/NOTICE.md)
+
+### Test Databases
+
+Few helpers are available to create and drop test databases while developing:
+
+* `testdb(...)`: return a test database _name_. An optional parameter can be
+  used to specify the database name _prefix_ (defaults to `test`).
+* `createdb(name, url)`: actually _create_ a new database, and return its name.
+  * `name`: the name of the database to create, defaults to the value returned
+    by calling `testdb()`.
+  * `url`: the URL to connect to for creating the database, defaults to
+    `psql:///postgres` (the local PostgreSQL instance via `libpq`)
+* `dropdb(name, url)`: drop the specified database.
+  * `name`: the name of the database to drop, _required_.
+  * `url`: the URL to connect to for dropping the database, defaults to
+    `psql:///postgres` (the local PostgreSQL instance via `libpq`)
+
+Normally, those methods are used when running tests, in a pattern similar to
+the following:
+
+```ts
+let databaseName: string
+
+beforeAll(async () => {
+  databaseName = await createdb()
+})
+
+afterAll(async () => {
+  await dropdb(databasename)
+})
+
+it('should run a test', async () => {
+  const client = new PGClient(databaseName)
+  /// ... use the client to test
+})
+```
+
+
+### Database Migrations
+
+The `migrate(...)` function provides an extremely simplistic way to migrate
+databases.
+
+Migration files should have names like `001-initial.sql`, `002-second.sql`,
+basically stating the migration _order_ followed by a simple name describing it.
+
+All migrations will be recorded in the database using the `$migrations` table.
+
+The `migrate(...)` function requires two arguments:
+
+* `url`: the URL of the database to migrate, _required_.
+* `options`: an optional set of options including:
+  * `migrations`: the _directory_ where migration files reside, relative to the
+    current working directory, defaults to `./sql`.
+  * `additional`: an additional set of migrations to be run (for example)
+    migrations required to run unit tests, defaults to _undefined_.
+  * `group`: a logical name grouping migrations together, when multiple sources
+    of database migrations exist in the same database, defaults to `default`.
+
+In unit tests, for example, migrations can be applied in the following way:
+
+```ts
+let databaseName: string
+
+beforeAll(async () => {
+  databaseName = await createdb()
+  await migrate(databaseName, {
+    migrations: './migrations',
+    additional: './test/migrations',
+  })
+})
+
+// run your tests, all migrations will be applied beforehand
+```
+
+
+### Persister Schema Genration
+
+Schema definitions for our `Persister` models (see `@juit/pgproxy-persister`)
+can be generated using a couple of functions:
+
+* `extractSchema(...)`: extract the `Schema` definition from a database.
+* `serializeSchema(...)`: serialize the extracted `Schema` as a Typescript DTS.
+
+The `extractSchema(...)` function takes a couple of arguments:
+
+* `url`: the URL of the database whose schemas are to be extracted, _required_.
+* `schemas`: an array of _database schema names_ to extract, defaulting to the
+  single `['public']` schema.
+
+The `serializeSchema(...)` takes the following arguments:
+
+* `schema`: the `Schema` for which the DTS should be generated, _required_.
+* `id`: the exported identifier of the schema, optional, defaults to `Schema`.
+* `overrides`: A `Record` mapping OID numbers to TypeScript types, in case
+  the registry used by the client is capable of handling them. All known OIDs
+  from the `@juit/pgproxy-types` library are already covered.
+
+An extra couple of utilities are available for the schema extractor:
+
+* `types`: a collection of TypeScript types representing the common, well known
+  types converted by `PGProxy` (e.g. _strings_, _numbers_, _arrays_, ...).
+* `helpers`: helper functions to generate extra types for `serializeSchema`:
+  * `makePostgresArrayType(...)`: given a type `T`, it'll return a type
+    representing a postgres array, that is `(T | null)[]`.
+  * `makeImportType(module, name, args)`: generate a type imported from the
+    specified module, using the specified type arguments, for example:
+    `import('myModule').MyType<MyArg1, MyArg2>`

package/dist/database.cjs

@@ -0,0 +1,60 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// database.ts
+var database_exports = {};
+__export(database_exports, {
+  createdb: () => createdb,
+  dropdb: () => dropdb,
+  testdb: () => testdb
+});
+module.exports = __toCommonJS(database_exports);
+var import_pgproxy_persister = require("@juit/pgproxy-persister");
+var import_plug = require("@plugjs/plug");
+var NAME_EXPR = /^[-\w]{4,}$/;
+function testdb(prefix = "test") {
+  if (!NAME_EXPR.test(prefix))
+    throw new Error(`Invalid database name prefix "${prefix}"`);
+  const random = String(Math.floor(Math.random() * 1e4)).padStart(4, "0");
+  return `${prefix}-${(/* @__PURE__ */ new Date()).toISOString().replace(/[^\d]/g, "")}-${random}`;
+}
+async function createdb(name = testdb(), url = "psql:///postgres") {
+  if (!NAME_EXPR.test(name))
+    throw new Error(`Invalid database name "${name}"`);
+  import_plug.log.notice(`Creating database ${(0, import_plug.$ylw)(name)}`);
+  const persister = new import_pgproxy_persister.Persister(url);
+  await persister.query(`CREATE DATABASE ${(0, import_pgproxy_persister.escape)(name)}`);
+  await persister.destroy();
+  return name;
+}
+async function dropdb(name, url = "psql:///postgres") {
+  if (!NAME_EXPR.test(name))
+    throw new Error(`Invalid database name "${name}"`);
+  import_plug.log.notice(`Dropping database ${(0, import_plug.$ylw)(name)}`);
+  const persister = new import_pgproxy_persister.Persister(url);
+  await persister.query(`DROP DATABASE IF EXISTS ${(0, import_pgproxy_persister.escape)(name)}`);
+  await persister.destroy();
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createdb,
+  dropdb,
+  testdb
+});
+//# sourceMappingURL=database.cjs.map

package/dist/database.cjs.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../src/database.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,+BAAkC;AAClC,kBAA0B;AAE1B,IAAM,YAAY;AAGX,SAAS,OAAO,SAAS,QAAgB;AAC9C,MAAI,CAAE,UAAU,KAAK,MAAM;AAAG,UAAM,IAAI,MAAM,iCAAiC,MAAM,GAAG;AACxF,QAAM,SAAS,OAAO,KAAK,MAAM,KAAK,OAAO,IAAI,GAAK,CAAC,EAAE,SAAS,GAAG,GAAG;AACxE,SAAO,GAAG,MAAM,KAAI,oBAAI,KAAK,GAAE,YAAY,EAAE,QAAQ,UAAU,EAAE,CAAC,IAAI,MAAM;AAC9E;AASA,eAAsB,SAClB,OAAO,OAAO,GACd,MAAoB,oBACL;AACjB,MAAI,CAAE,UAAU,KAAK,IAAI;AAAG,UAAM,IAAI,MAAM,0BAA0B,IAAI,GAAG;AAC7E,kBAAI,OAAO,yBAAqB,kBAAK,IAAI,CAAC,EAAE;AAE5C,QAAM,YAAY,IAAI,mCAAU,GAAG;AACnC,QAAM,UAAU,MAAM,uBAAmB,iCAAO,IAAI,CAAC,EAAE;AACvD,QAAM,UAAU,QAAQ;AACxB,SAAO;AACT;AAOA,eAAsB,OAClB,MACA,MAAoB,oBACP;AACf,MAAI,CAAE,UAAU,KAAK,IAAI;AAAG,UAAM,IAAI,MAAM,0BAA0B,IAAI,GAAG;AAC7E,kBAAI,OAAO,yBAAqB,kBAAK,IAAI,CAAC,EAAE;AAE5C,QAAM,YAAY,IAAI,mCAAU,GAAG;AACnC,QAAM,UAAU,MAAM,+BAA2B,iCAAO,IAAI,CAAC,EAAE;AAC/D,QAAM,UAAU,QAAQ;AAC1B;",
+  "names": []
+}

package/dist/database.d.ts

@@ -0,0 +1,17 @@
+/// <reference types="node" />
+/** Create a test database name from a prefix and some randomness */
+export declare function testdb(prefix?: string): string;
+/**
+ * Create a database with the specified name (or a test database).
+ *
+ * The default database name to use is the result of calling {@link testdb()}.
+ *
+ * The default URL to use when creating the database is `psql:///postgres`.
+ */
+export declare function createdb(name?: string, url?: string | URL): Promise<string>;
+/**
+ * Drop the database with the specified name.
+ *
+ * The default URL to use when creating the database is `psql:///postgres`.
+ */
+export declare function dropdb(name: string, url?: string | URL): Promise<void>;

package/dist/database.mjs

@@ -0,0 +1,33 @@
+// database.ts
+import { Persister, escape } from "@juit/pgproxy-persister";
+import { $ylw, log } from "@plugjs/plug";
+var NAME_EXPR = /^[-\w]{4,}$/;
+function testdb(prefix = "test") {
+  if (!NAME_EXPR.test(prefix))
+    throw new Error(`Invalid database name prefix "${prefix}"`);
+  const random = String(Math.floor(Math.random() * 1e4)).padStart(4, "0");
+  return `${prefix}-${(/* @__PURE__ */ new Date()).toISOString().replace(/[^\d]/g, "")}-${random}`;
+}
+async function createdb(name = testdb(), url = "psql:///postgres") {
+  if (!NAME_EXPR.test(name))
+    throw new Error(`Invalid database name "${name}"`);
+  log.notice(`Creating database ${$ylw(name)}`);
+  const persister = new Persister(url);
+  await persister.query(`CREATE DATABASE ${escape(name)}`);
+  await persister.destroy();
+  return name;
+}
+async function dropdb(name, url = "psql:///postgres") {
+  if (!NAME_EXPR.test(name))
+    throw new Error(`Invalid database name "${name}"`);
+  log.notice(`Dropping database ${$ylw(name)}`);
+  const persister = new Persister(url);
+  await persister.query(`DROP DATABASE IF EXISTS ${escape(name)}`);
+  await persister.destroy();
+}
+export {
+  createdb,
+  dropdb,
+  testdb
+};
+//# sourceMappingURL=database.mjs.map

package/dist/database.mjs.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../src/database.ts"],
+  "mappings": ";AAAA,SAAS,WAAW,cAAc;AAClC,SAAS,MAAM,WAAW;AAE1B,IAAM,YAAY;AAGX,SAAS,OAAO,SAAS,QAAgB;AAC9C,MAAI,CAAE,UAAU,KAAK,MAAM;AAAG,UAAM,IAAI,MAAM,iCAAiC,MAAM,GAAG;AACxF,QAAM,SAAS,OAAO,KAAK,MAAM,KAAK,OAAO,IAAI,GAAK,CAAC,EAAE,SAAS,GAAG,GAAG;AACxE,SAAO,GAAG,MAAM,KAAI,oBAAI,KAAK,GAAE,YAAY,EAAE,QAAQ,UAAU,EAAE,CAAC,IAAI,MAAM;AAC9E;AASA,eAAsB,SAClB,OAAO,OAAO,GACd,MAAoB,oBACL;AACjB,MAAI,CAAE,UAAU,KAAK,IAAI;AAAG,UAAM,IAAI,MAAM,0BAA0B,IAAI,GAAG;AAC7E,MAAI,OAAO,qBAAqB,KAAK,IAAI,CAAC,EAAE;AAE5C,QAAM,YAAY,IAAI,UAAU,GAAG;AACnC,QAAM,UAAU,MAAM,mBAAmB,OAAO,IAAI,CAAC,EAAE;AACvD,QAAM,UAAU,QAAQ;AACxB,SAAO;AACT;AAOA,eAAsB,OAClB,MACA,MAAoB,oBACP;AACf,MAAI,CAAE,UAAU,KAAK,IAAI;AAAG,UAAM,IAAI,MAAM,0BAA0B,IAAI,GAAG;AAC7E,MAAI,OAAO,qBAAqB,KAAK,IAAI,CAAC,EAAE;AAE5C,QAAM,YAAY,IAAI,UAAU,GAAG;AACnC,QAAM,UAAU,MAAM,2BAA2B,OAAO,IAAI,CAAC,EAAE;AAC/D,QAAM,UAAU,QAAQ;AAC1B;",
+  "names": []
+}

package/dist/extract.cjs

@@ -0,0 +1,119 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// extract.ts
+var extract_exports = {};
+__export(extract_exports, {
+  extractSchema: () => extractSchema
+});
+module.exports = __toCommonJS(extract_exports);
+var import_pgproxy_client = require("@juit/pgproxy-client");
+var import_pgproxy_client_psql = require("@juit/pgproxy-client-psql");
+var query = `
+  SELECT
+    "c"."table_schema" AS "schema",
+    "c"."table_name" AS "table",
+    "c"."column_name" AS "column",
+    "c"."is_nullable"::bool AS "isNullable",
+    CASE WHEN "c"."column_default" IS NULL
+      THEN false
+      ELSE true
+    END AS "hasDefault",
+    "t"."oid" AS "oid",
+    "e"."enumValues" AS "enumValues",
+    "d"."description" AS "description"
+  FROM
+    "information_schema"."columns" AS "c"
+  -- join the pg_catalog.pg_type to bring in the OIDs
+  INNER JOIN
+    "pg_catalog"."pg_type" AS "t"
+  ON
+    "c"."udt_name" = "t"."typname"
+  -- join the pg_catalog.pg_statio_all_tables to bring in the OBJIDs
+  INNER JOIN
+    "pg_catalog"."pg_statio_all_tables" AS "s"
+  ON
+    "c"."table_schema" = "s"."schemaname" AND
+    "c"."table_name"   = "s"."relname"
+  -- join the pg_catalog.pg_enum to bring in the ENUM VALUESs
+  LEFT JOIN (
+    SELECT
+      "enumtypid",
+      "array_agg"("enumlabel")::varchar[] AS "enumValues"
+    FROM
+      "pg_catalog"."pg_enum"
+    GROUP BY
+      "enumtypid"
+  ) "e"
+  ON
+    "t"."oid" = "e"."enumtypid"
+  -- join the pg_catalog.pg_description to bring in the column DESCRIPTIONs
+  LEFT JOIN
+    "pg_catalog"."pg_description" AS "d"
+  ON
+    "d"."objoid" = "s"."relid" AND
+    "d"."objsubid" = "c"."ordinal_position"
+  -- restrict to our schemas
+  WHERE
+    "c"."table_schema" = ANY($1)
+  -- sanity in ordering
+  ORDER BY
+    "c"."table_schema",
+    "c"."table_name",
+    "c"."ordinal_position"`;
+function stripUndefined(object) {
+  for (const key of Object.keys(object)) {
+    if (object[key] === void 0)
+      delete object[key];
+  }
+  return object;
+}
+async function extractSchema(url, schemas = [], extractAll = false) {
+  if (schemas.length === 0)
+    schemas.push("public");
+  const client = new import_pgproxy_client.PGClient(url);
+  let rows;
+  try {
+    const result = await client.query(query, [schemas]);
+    rows = result.rows;
+  } finally {
+    await client.destroy();
+  }
+  const schemaDef = {};
+  for (const row of rows) {
+    const { schema, table, column, description, enumValues, ...def } = row;
+    if (!extractAll) {
+      if (table.match(/^[^a-z]/i) || column.match(/^[^a-z]/i))
+        continue;
+    }
+    const name = schema === "public" ? `${table}` : `${schema}.${table}`;
+    const tableDef = schemaDef[name] || (schemaDef[name] = {});
+    tableDef[column] = stripUndefined({
+      ...def,
+      description: description?.trim() ? description.trim() : void 0,
+      enumValues: enumValues && enumValues.length ? enumValues : void 0
+    });
+  }
+  return schemaDef;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  extractSchema
+});
+//# sourceMappingURL=extract.cjs.map

package/dist/extract.cjs.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../src/extract.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,4BAAyB;AACzB,iCAAO;AASP,IAAM,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAkEd,SAAS,eAA8C,QAAc;AACnE,aAAW,OAAO,OAAO,KAAK,MAAM,GAAG;AACrC,QAAI,OAAO,GAAG,MAAM;AAAW,aAAO,OAAO,GAAG;AAAA,EAClD;AACA,SAAO;AACT;AAoBA,eAAsB,cAClB,KACA,UAAoB,CAAC,GACrB,aAAsB,OACP;AACjB,MAAI,QAAQ,WAAW;AAAG,YAAQ,KAAK,QAAQ;AAE/C,QAAM,SAAS,IAAI,+BAAS,GAAG;AAC/B,MAAI;AACJ,MAAI;AACF,UAAM,SAAS,MAAM,OAAO,MAAiB,OAAO,CAAE,OAAQ,CAAC;AAC/D,WAAO,OAAO;AAAA,EAChB,UAAE;AACA,UAAM,OAAO,QAAQ;AAAA,EACvB;AAEA,QAAM,YAAoB,CAAC;AAE3B,aAAW,OAAO,MAAM;AACtB,UAAM,EAAE,QAAQ,OAAO,QAAQ,aAAa,YAAY,GAAG,IAAI,IAAI;AAEnE,QAAI,CAAE,YAAY;AAChB,UAAK,MAAM,MAAM,UAAU,KAAO,OAAO,MAAM,UAAU;AAAI;AAAA,IAC/D;AAEA,UAAM,OAAO,WAAW,WAAW,GAAG,KAAK,KAAK,GAAG,MAAM,IAAI,KAAK;AAClE,UAAM,WAAW,UAAU,IAAI,MAAM,UAAU,IAAI,IAAI,CAAC;AAExD,aAAS,MAAM,IAAI,eAAe;AAAA,MAAE,GAAG;AAAA,MACrC,aAAa,aAAa,KAAK,IAAI,YAAY,KAAK,IAAI;AAAA,MACxD,YAAa,cAAc,WAAW,SAAU,aAAoB;AAAA,IACtE,CAAC;AAAA,EACH;AAEA,SAAO;AACT;",
+  "names": []
+}

package/dist/extract.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="node" />
+import '@juit/pgproxy-client-psql';
+import type { Schema } from './index';
+/**
+ * Extract a {@link Schema} from an array of PosgreSQL schema names.
+ *
+ * When the `schemas` parameter is undefined (or an empty array), then the
+ * single `public` schema will be targeted for extraction.
+ *
+ * Furthermore, unless the `extractAll` flag is set to `true`, only tables and
+ * columns starting with a _latin letter_ (a...z) will be included in the
+ * resulting {@link Schema}.
+ *
+ * @param url - The URL of the database to connect to.
+ * @param schemas - The array of schema names to target for extraction.
+ * @param extractAll - Extract all tables and column definitions.
+ */
+export declare function extractSchema(url: URL | string, schemas?: string[], extractAll?: boolean): Promise<Schema>;

package/dist/extract.mjs

@@ -0,0 +1,94 @@
+// extract.ts
+import { PGClient } from "@juit/pgproxy-client";
+import "@juit/pgproxy-client-psql";
+var query = `
+  SELECT
+    "c"."table_schema" AS "schema",
+    "c"."table_name" AS "table",
+    "c"."column_name" AS "column",
+    "c"."is_nullable"::bool AS "isNullable",
+    CASE WHEN "c"."column_default" IS NULL
+      THEN false
+      ELSE true
+    END AS "hasDefault",
+    "t"."oid" AS "oid",
+    "e"."enumValues" AS "enumValues",
+    "d"."description" AS "description"
+  FROM
+    "information_schema"."columns" AS "c"
+  -- join the pg_catalog.pg_type to bring in the OIDs
+  INNER JOIN
+    "pg_catalog"."pg_type" AS "t"
+  ON
+    "c"."udt_name" = "t"."typname"
+  -- join the pg_catalog.pg_statio_all_tables to bring in the OBJIDs
+  INNER JOIN
+    "pg_catalog"."pg_statio_all_tables" AS "s"
+  ON
+    "c"."table_schema" = "s"."schemaname" AND
+    "c"."table_name"   = "s"."relname"
+  -- join the pg_catalog.pg_enum to bring in the ENUM VALUESs
+  LEFT JOIN (
+    SELECT
+      "enumtypid",
+      "array_agg"("enumlabel")::varchar[] AS "enumValues"
+    FROM
+      "pg_catalog"."pg_enum"
+    GROUP BY
+      "enumtypid"
+  ) "e"
+  ON
+    "t"."oid" = "e"."enumtypid"
+  -- join the pg_catalog.pg_description to bring in the column DESCRIPTIONs
+  LEFT JOIN
+    "pg_catalog"."pg_description" AS "d"
+  ON
+    "d"."objoid" = "s"."relid" AND
+    "d"."objsubid" = "c"."ordinal_position"
+  -- restrict to our schemas
+  WHERE
+    "c"."table_schema" = ANY($1)
+  -- sanity in ordering
+  ORDER BY
+    "c"."table_schema",
+    "c"."table_name",
+    "c"."ordinal_position"`;
+function stripUndefined(object) {
+  for (const key of Object.keys(object)) {
+    if (object[key] === void 0)
+      delete object[key];
+  }
+  return object;
+}
+async function extractSchema(url, schemas = [], extractAll = false) {
+  if (schemas.length === 0)
+    schemas.push("public");
+  const client = new PGClient(url);
+  let rows;
+  try {
+    const result = await client.query(query, [schemas]);
+    rows = result.rows;
+  } finally {
+    await client.destroy();
+  }
+  const schemaDef = {};
+  for (const row of rows) {
+    const { schema, table, column, description, enumValues, ...def } = row;
+    if (!extractAll) {
+      if (table.match(/^[^a-z]/i) || column.match(/^[^a-z]/i))
+        continue;
+    }
+    const name = schema === "public" ? `${table}` : `${schema}.${table}`;
+    const tableDef = schemaDef[name] || (schemaDef[name] = {});
+    tableDef[column] = stripUndefined({
+      ...def,
+      description: description?.trim() ? description.trim() : void 0,
+      enumValues: enumValues && enumValues.length ? enumValues : void 0
+    });
+  }
+  return schemaDef;
+}
+export {
+  extractSchema
+};
+//# sourceMappingURL=extract.mjs.map

package/dist/extract.mjs.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../src/extract.ts"],
+  "mappings": ";AAAA,SAAS,gBAAgB;AACzB,OAAO;AASP,IAAM,QAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAkEd,SAAS,eAA8C,QAAc;AACnE,aAAW,OAAO,OAAO,KAAK,MAAM,GAAG;AACrC,QAAI,OAAO,GAAG,MAAM;AAAW,aAAO,OAAO,GAAG;AAAA,EAClD;AACA,SAAO;AACT;AAoBA,eAAsB,cAClB,KACA,UAAoB,CAAC,GACrB,aAAsB,OACP;AACjB,MAAI,QAAQ,WAAW;AAAG,YAAQ,KAAK,QAAQ;AAE/C,QAAM,SAAS,IAAI,SAAS,GAAG;AAC/B,MAAI;AACJ,MAAI;AACF,UAAM,SAAS,MAAM,OAAO,MAAiB,OAAO,CAAE,OAAQ,CAAC;AAC/D,WAAO,OAAO;AAAA,EAChB,UAAE;AACA,UAAM,OAAO,QAAQ;AAAA,EACvB;AAEA,QAAM,YAAoB,CAAC;AAE3B,aAAW,OAAO,MAAM;AACtB,UAAM,EAAE,QAAQ,OAAO,QAAQ,aAAa,YAAY,GAAG,IAAI,IAAI;AAEnE,QAAI,CAAE,YAAY;AAChB,UAAK,MAAM,MAAM,UAAU,KAAO,OAAO,MAAM,UAAU;AAAI;AAAA,IAC/D;AAEA,UAAM,OAAO,WAAW,WAAW,GAAG,KAAK,KAAK,GAAG,MAAM,IAAI,KAAK;AAClE,UAAM,WAAW,UAAU,IAAI,MAAM,UAAU,IAAI,IAAI,CAAC;AAExD,aAAS,MAAM,IAAI,eAAe;AAAA,MAAE,GAAG;AAAA,MACrC,aAAa,aAAa,KAAK,IAAI,YAAY,KAAK,IAAI;AAAA,MACxD,YAAa,cAAc,WAAW,SAAU,aAAoB;AAAA,IACtE,CAAC;AAAA,EACH;AAEA,SAAO;AACT;",
+  "names": []
+}

package/dist/helpers.cjs

@@ -0,0 +1,65 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// helpers.ts
+var helpers_exports = {};
+__export(helpers_exports, {
+  makeImportType: () => makeImportType,
+  makePostgresArrayType: () => makePostgresArrayType
+});
+module.exports = __toCommonJS(helpers_exports);
+var import_typescript = __toESM(require("typescript"));
+function makePostgresArrayType(type) {
+  const nullable = import_typescript.default.factory.createLiteralTypeNode(import_typescript.default.factory.createNull());
+  const union = import_typescript.default.factory.createUnionTypeNode([type, nullable]);
+  const array = import_typescript.default.factory.createArrayTypeNode(union);
+  return array;
+}
+function makeImportType(module2, name, args = []) {
+  if (!Array.isArray(args))
+    args = [args];
+  return import_typescript.default.factory.createImportTypeNode(
+    // ..................... "import"
+    import_typescript.default.factory.createLiteralTypeNode(
+      import_typescript.default.factory.createStringLiteral(module2)
+    ),
+    // ............ "('module')"
+    void 0,
+    // import assertions
+    import_typescript.default.factory.createIdentifier(name),
+    // ........................ ".Type"
+    args
+  );
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  makeImportType,
+  makePostgresArrayType
+});
+//# sourceMappingURL=helpers.cjs.map

package/dist/helpers.cjs.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../src/helpers.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAAe;AAMR,SAAS,sBAAsB,MAAqC;AACzE,QAAM,WAAW,kBAAAA,QAAG,QAAQ,sBAAsB,kBAAAA,QAAG,QAAQ,WAAW,CAAC;AACzE,QAAM,QAAQ,kBAAAA,QAAG,QAAQ,oBAAoB,CAAE,MAAM,QAAS,CAAC;AAC/D,QAAM,QAAQ,kBAAAA,QAAG,QAAQ,oBAAoB,KAAK;AAClD,SAAO;AACT;AAKO,SAAS,eACZC,SACA,MACA,OAAoC,CAAC,GACpB;AACnB,MAAI,CAAE,MAAM,QAAQ,IAAI;AAAG,WAAO,CAAE,IAAK;AAEzC,SAAO,kBAAAD,QAAG,QAAQ;AAAA;AAAA,IACd,kBAAAA,QAAG,QAAQ;AAAA,MACP,kBAAAA,QAAG,QAAQ,oBAAoBC,OAAM;AAAA,IAAC;AAAA;AAAA,IAC1C;AAAA;AAAA,IACA,kBAAAD,QAAG,QAAQ,iBAAiB,IAAI;AAAA;AAAA,IAChC;AAAA,EAAI;AACV;",
+  "names": ["ts", "module"]
+}

package/dist/helpers.d.ts

@@ -0,0 +1,10 @@
+import ts from 'typescript';
+/**
+ * Create a PosgreSQL array type for the given type, that is, given the type
+ * `T`, return `(T | null)[]`
+ */
+export declare function makePostgresArrayType(type: ts.TypeNode): ts.ArrayTypeNode;
+/**
+ * Create an _import_ type, like `import('module').Name<arg0, arg1, ...>`.
+ */
+export declare function makeImportType(module: string, name: string, args?: ts.TypeNode | ts.TypeNode[]): ts.ImportTypeNode;

package/dist/helpers.mjs

@@ -0,0 +1,29 @@
+// helpers.ts
+import ts from "typescript";
+function makePostgresArrayType(type) {
+  const nullable = ts.factory.createLiteralTypeNode(ts.factory.createNull());
+  const union = ts.factory.createUnionTypeNode([type, nullable]);
+  const array = ts.factory.createArrayTypeNode(union);
+  return array;
+}
+function makeImportType(module, name, args = []) {
+  if (!Array.isArray(args))
+    args = [args];
+  return ts.factory.createImportTypeNode(
+    // ..................... "import"
+    ts.factory.createLiteralTypeNode(
+      ts.factory.createStringLiteral(module)
+    ),
+    // ............ "('module')"
+    void 0,
+    // import assertions
+    ts.factory.createIdentifier(name),
+    // ........................ ".Type"
+    args
+  );
+}
+export {
+  makeImportType,
+  makePostgresArrayType
+};
+//# sourceMappingURL=helpers.mjs.map

package/dist/helpers.mjs.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../src/helpers.ts"],
+  "mappings": ";AAAA,OAAO,QAAQ;AAMR,SAAS,sBAAsB,MAAqC;AACzE,QAAM,WAAW,GAAG,QAAQ,sBAAsB,GAAG,QAAQ,WAAW,CAAC;AACzE,QAAM,QAAQ,GAAG,QAAQ,oBAAoB,CAAE,MAAM,QAAS,CAAC;AAC/D,QAAM,QAAQ,GAAG,QAAQ,oBAAoB,KAAK;AAClD,SAAO;AACT;AAKO,SAAS,eACZ,QACA,MACA,OAAoC,CAAC,GACpB;AACnB,MAAI,CAAE,MAAM,QAAQ,IAAI;AAAG,WAAO,CAAE,IAAK;AAEzC,SAAO,GAAG,QAAQ;AAAA;AAAA,IACd,GAAG,QAAQ;AAAA,MACP,GAAG,QAAQ,oBAAoB,MAAM;AAAA,IAAC;AAAA;AAAA,IAC1C;AAAA;AAAA,IACA,GAAG,QAAQ,iBAAiB,IAAI;AAAA;AAAA,IAChC;AAAA,EAAI;AACV;",
+  "names": []
+}