@geekmidas/db 10.0.0-alpha.16 → 10.0.0-alpha.161

package/dist/introspect/handler.mjs

@@ -0,0 +1,158 @@
+import { InvalidCursor } from "../pagination.mjs";
+import { ColumnNotFound, TableNotFound, UnsupportedFilterOperator } from "./errors.mjs";
+import { FilterOperator } from "./types.mjs";
+import { DataBrowser } from "./DataBrowser.mjs";
+//#region src/introspect/handler.ts
+const OPERATORS = new Set(Object.values(FilterOperator));
+/**
+* A read-only JSON API over a Postgres database's structure and rows.
+*
+* A plain `(Request) => Promise<Response>` rather than a router, so it mounts
+* in anything that speaks web `Request`s — Hono, Bun, Deno, a Node adapter —
+* and `@geekmidas/db` takes on no HTTP framework to provide it.
+*
+* | Route                         | Returns                                         |
+* | ----------------------------- | ----------------------------------------------- |
+* | `GET /schemas`                | `{ schemas, browsable }`                        |
+* | `GET /tables?schema=&refresh=`| `{ tables }` with columns and foreign keys      |
+* | `GET /tables/:name?schema=`   | one table                                       |
+* | `GET /tables/:name/rows`      | a page of rows: `{ rows, hasMore, nextCursor }` |
+*
+* Rows take `pageSize` (≤ 100), `cursor`, `sort=col:asc,col2:desc` and filters
+* as `filter[column][operator]=value` — `in`/`nin` take a comma-separated
+* list, `is_null`/`is_not_null` take no value.
+*
+* It exposes every row of every browsable table to whoever can reach it. Mount
+* it only where that is the developer: `gkm dev` serves it at `/__gkm/db` and
+* nothing in a production build does.
+*
+* @example
+* ```typescript
+* const handler = createIntrospectionHandler({ db, basePath: '/__gkm/db' });
+* app.all('/__gkm/db/*', (c) => handler(c.req.raw));
+* ```
+*/
+function createIntrospectionHandler(options) {
+	const browser = new DataBrowser(options);
+	const basePath = (options.basePath ?? "").replace(/\/+$/, "");
+	return async (request) => {
+		if (request.method !== "GET") return json({
+			error: "MethodNotAllowed",
+			message: "The database API is read-only; only GET is served."
+		}, 405, { allow: "GET" });
+		const url = new URL(request.url);
+		const path = url.pathname.startsWith(basePath) ? url.pathname.slice(basePath.length) : url.pathname;
+		const segments = path.split("/").filter(Boolean).map(decodeURIComponent);
+		const schema = url.searchParams.get("schema") ?? void 0;
+		try {
+			if (segments.length === 1 && segments[0] === "schemas") return json({
+				schemas: await browser.listSchemas(),
+				browsable: browser.schemas
+			});
+			if (segments.length === 1 && segments[0] === "tables") {
+				const refresh = url.searchParams.get("refresh") === "true";
+				const { tables, updatedAt } = await browser.getSchema(refresh);
+				return json({
+					tables: schema ? tables.filter((t) => t.schema === schema) : tables,
+					updatedAt
+				});
+			}
+			if (segments[0] === "tables" && segments[1] && segments.length === 2) {
+				const table = await browser.getTableInfo(segments[1], schema);
+				if (!table) throw new TableNotFound(segments[1], schema ?? browser.schemas[0] ?? "public");
+				return json(table);
+			}
+			if (segments[0] === "tables" && segments[1] && segments[2] === "rows" && segments.length === 3) {
+				const pageSize = Number.parseInt(url.searchParams.get("pageSize") ?? "", 10);
+				const filters = parseFilters(url.searchParams);
+				const sort = parseSort(url.searchParams.get("sort"));
+				return json(await browser.query({
+					table: segments[1],
+					schema,
+					pageSize: Number.isNaN(pageSize) ? void 0 : pageSize,
+					cursor: url.searchParams.get("cursor") || void 0,
+					filters: filters.length > 0 ? filters : void 0,
+					sort: sort.length > 0 ? sort : void 0
+				}));
+			}
+			return json({
+				error: "NotFound",
+				message: `No database route at '${path || "/"}'. Routes: /schemas, /tables, /tables/:name, /tables/:name/rows.`
+			}, 404);
+		} catch (error) {
+			const status = statusFor(error);
+			if (status === void 0) throw error;
+			return json({
+				error: error.name,
+				message: error.message
+			}, status);
+		}
+	};
+}
+/** The caller's mistakes, answered; anything else is the server's and thrown. */
+function statusFor(error) {
+	if (error instanceof TableNotFound) return 404;
+	if (error instanceof ColumnNotFound || error instanceof UnsupportedFilterOperator || error instanceof InvalidCursor) return 400;
+}
+/**
+* `filter[column][operator]=value`. An unknown operator is ignored rather than
+* rejected, as a misspelt one in a hand-typed URL is easier to see in the
+* results than to debug from an error.
+*/
+function parseFilters(params) {
+	const filters = [];
+	for (const [key, value] of params) {
+		const match = key.match(/^filter\[(\w+)\]\[(\w+)\]$/);
+		const column = match?.[1];
+		const operator = match?.[2];
+		if (!column || !operator || !OPERATORS.has(operator)) continue;
+		const op = operator;
+		if (op === "in" || op === "nin") filters.push({
+			column,
+			operator: op,
+			value: value.split(",")
+		});
+		else if (op === "is_null" || op === "is_not_null") filters.push({
+			column,
+			operator: op
+		});
+		else filters.push({
+			column,
+			operator: op,
+			value: parseScalar(value)
+		});
+	}
+	return filters;
+}
+function parseScalar(value) {
+	if (value === "true") return true;
+	if (value === "false") return false;
+	if (value !== "" && !Number.isNaN(Number(value))) return Number(value);
+	return value;
+}
+/** `sort=name:asc,created_at:desc`; a column with no direction is ascending. */
+function parseSort(param) {
+	if (!param) return [];
+	return param.split(",").flatMap((part) => {
+		const [column, direction] = part.split(":");
+		if (!column) return [];
+		return [{
+			column,
+			direction: direction === "desc" ? "desc" : "asc"
+		}];
+	});
+}
+function json(body, status = 200, headers = {}) {
+	const text = JSON.stringify(body, (_key, value) => typeof value === "bigint" ? value.toString() : value);
+	return new Response(text, {
+		status,
+		headers: {
+			"content-type": "application/json; charset=utf-8",
+			...headers
+		}
+	});
+}
+//#endregion
+export { createIntrospectionHandler };
+
+//# sourceMappingURL=handler.mjs.map

package/dist/introspect/handler.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"handler.mjs","names":[],"sources":["../../src/introspect/handler.ts"],"sourcesContent":["import { Direction, InvalidCursor } from '../pagination';\nimport { DataBrowser } from './DataBrowser';\nimport {\n\tColumnNotFound,\n\tTableNotFound,\n\tUnsupportedFilterOperator,\n} from './errors';\nimport {\n\ttype DataBrowserOptions,\n\ttype FilterCondition,\n\tFilterOperator,\n\ttype SortConfig,\n} from './types';\n\nexport interface IntrospectionHandlerOptions<DB = unknown>\n\textends DataBrowserOptions<DB> {\n\t/**\n\t * The path the handler is mounted under, e.g. `/__gkm/db`. Stripped from\n\t * each request's path before routing, so the handler can be mounted\n\t * anywhere without a router of its own.\n\t */\n\tbasePath?: string;\n}\n\n/** A fetch-style handler: a web `Request` in, a JSON `Response` out. */\nexport type IntrospectionHandler = (request: Request) => Promise<Response>;\n\nconst OPERATORS = new Set<string>(Object.values(FilterOperator));\n\n/**\n * A read-only JSON API over a Postgres database's structure and rows.\n *\n * A plain `(Request) => Promise<Response>` rather than a router, so it mounts\n * in anything that speaks web `Request`s — Hono, Bun, Deno, a Node adapter —\n * and `@geekmidas/db` takes on no HTTP framework to provide it.\n *\n * | Route                         | Returns                                         |\n * | ----------------------------- | ----------------------------------------------- |\n * | `GET /schemas`                | `{ schemas, browsable }`                        |\n * | `GET /tables?schema=&refresh=`| `{ tables }` with columns and foreign keys      |\n * | `GET /tables/:name?schema=`   | one table                                       |\n * | `GET /tables/:name/rows`      | a page of rows: `{ rows, hasMore, nextCursor }` |\n *\n * Rows take `pageSize` (≤ 100), `cursor`, `sort=col:asc,col2:desc` and filters\n * as `filter[column][operator]=value` — `in`/`nin` take a comma-separated\n * list, `is_null`/`is_not_null` take no value.\n *\n * It exposes every row of every browsable table to whoever can reach it. Mount\n * it only where that is the developer: `gkm dev` serves it at `/__gkm/db` and\n * nothing in a production build does.\n *\n * @example\n * ```typescript\n * const handler = createIntrospectionHandler({ db, basePath: '/__gkm/db' });\n * app.all('/__gkm/db/*', (c) => handler(c.req.raw));\n * ```\n */\nexport function createIntrospectionHandler<DB>(\n\toptions: IntrospectionHandlerOptions<DB>,\n): IntrospectionHandler {\n\tconst browser = new DataBrowser(options);\n\tconst basePath = (options.basePath ?? '').replace(/\\/+$/, '');\n\n\treturn async (request) => {\n\t\tif (request.method !== 'GET') {\n\t\t\treturn json(\n\t\t\t\t{\n\t\t\t\t\terror: 'MethodNotAllowed',\n\t\t\t\t\tmessage: 'The database API is read-only; only GET is served.',\n\t\t\t\t},\n\t\t\t\t405,\n\t\t\t\t{ allow: 'GET' },\n\t\t\t);\n\t\t}\n\n\t\tconst url = new URL(request.url);\n\t\tconst path = url.pathname.startsWith(basePath)\n\t\t\t? url.pathname.slice(basePath.length)\n\t\t\t: url.pathname;\n\t\tconst segments = path.split('/').filter(Boolean).map(decodeURIComponent);\n\t\tconst schema = url.searchParams.get('schema') ?? undefined;\n\n\t\ttry {\n\t\t\tif (segments.length === 1 && segments[0] === 'schemas') {\n\t\t\t\treturn json({\n\t\t\t\t\tschemas: await browser.listSchemas(),\n\t\t\t\t\tbrowsable: browser.schemas,\n\t\t\t\t});\n\t\t\t}\n\n\t\t\tif (segments.length === 1 && segments[0] === 'tables') {\n\t\t\t\tconst refresh = url.searchParams.get('refresh') === 'true';\n\t\t\t\tconst { tables, updatedAt } = await browser.getSchema(refresh);\n\t\t\t\treturn json({\n\t\t\t\t\ttables: schema ? tables.filter((t) => t.schema === schema) : tables,\n\t\t\t\t\tupdatedAt,\n\t\t\t\t});\n\t\t\t}\n\n\t\t\tif (segments[0] === 'tables' && segments[1] && segments.length === 2) {\n\t\t\t\tconst table = await browser.getTableInfo(segments[1], schema);\n\t\t\t\tif (!table) {\n\t\t\t\t\tthrow new TableNotFound(\n\t\t\t\t\t\tsegments[1],\n\t\t\t\t\t\tschema ?? browser.schemas[0] ?? 'public',\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t\treturn json(table);\n\t\t\t}\n\n\t\t\tif (\n\t\t\t\tsegments[0] === 'tables' &&\n\t\t\t\tsegments[1] &&\n\t\t\t\tsegments[2] === 'rows' &&\n\t\t\t\tsegments.length === 3\n\t\t\t) {\n\t\t\t\tconst pageSize = Number.parseInt(\n\t\t\t\t\turl.searchParams.get('pageSize') ?? '',\n\t\t\t\t\t10,\n\t\t\t\t);\n\t\t\t\tconst filters = parseFilters(url.searchParams);\n\t\t\t\tconst sort = parseSort(url.searchParams.get('sort'));\n\n\t\t\t\treturn json(\n\t\t\t\t\tawait browser.query({\n\t\t\t\t\t\ttable: segments[1],\n\t\t\t\t\t\tschema,\n\t\t\t\t\t\tpageSize: Number.isNaN(pageSize) ? undefined : pageSize,\n\t\t\t\t\t\tcursor: url.searchParams.get('cursor') || undefined,\n\t\t\t\t\t\tfilters: filters.length > 0 ? filters : undefined,\n\t\t\t\t\t\tsort: sort.length > 0 ? sort : undefined,\n\t\t\t\t\t}),\n\t\t\t\t);\n\t\t\t}\n\n\t\t\treturn json(\n\t\t\t\t{\n\t\t\t\t\terror: 'NotFound',\n\t\t\t\t\tmessage: `No database route at '${path || '/'}'. Routes: /schemas, /tables, /tables/:name, /tables/:name/rows.`,\n\t\t\t\t},\n\t\t\t\t404,\n\t\t\t);\n\t\t} catch (error) {\n\t\t\tconst status = statusFor(error);\n\t\t\tif (status === undefined) throw error;\n\t\t\treturn json(\n\t\t\t\t{ error: (error as Error).name, message: (error as Error).message },\n\t\t\t\tstatus,\n\t\t\t);\n\t\t}\n\t};\n}\n\n/** The caller's mistakes, answered; anything else is the server's and thrown. */\nfunction statusFor(error: unknown): number | undefined {\n\tif (error instanceof TableNotFound) return 404;\n\tif (\n\t\terror instanceof ColumnNotFound ||\n\t\terror instanceof UnsupportedFilterOperator ||\n\t\terror instanceof InvalidCursor\n\t) {\n\t\treturn 400;\n\t}\n\treturn undefined;\n}\n\n/**\n * `filter[column][operator]=value`. An unknown operator is ignored rather than\n * rejected, as a misspelt one in a hand-typed URL is easier to see in the\n * results than to debug from an error.\n */\nfunction parseFilters(params: URLSearchParams): FilterCondition[] {\n\tconst filters: FilterCondition[] = [];\n\n\tfor (const [key, value] of params) {\n\t\tconst match = key.match(/^filter\\[(\\w+)\\]\\[(\\w+)\\]$/);\n\t\tconst column = match?.[1];\n\t\tconst operator = match?.[2];\n\t\tif (!column || !operator || !OPERATORS.has(operator)) continue;\n\n\t\tconst op = operator as FilterOperator;\n\t\tif (op === FilterOperator.In || op === FilterOperator.Nin) {\n\t\t\tfilters.push({ column, operator: op, value: value.split(',') });\n\t\t} else if (\n\t\t\top === FilterOperator.IsNull ||\n\t\t\top === FilterOperator.IsNotNull\n\t\t) {\n\t\t\tfilters.push({ column, operator: op });\n\t\t} else {\n\t\t\tfilters.push({ column, operator: op, value: parseScalar(value) });\n\t\t}\n\t}\n\n\treturn filters;\n}\n\nfunction parseScalar(value: string): unknown {\n\tif (value === 'true') return true;\n\tif (value === 'false') return false;\n\tif (value !== '' && !Number.isNaN(Number(value))) return Number(value);\n\treturn value;\n}\n\n/** `sort=name:asc,created_at:desc`; a column with no direction is ascending. */\nfunction parseSort(param: string | null): SortConfig[] {\n\tif (!param) return [];\n\n\treturn param.split(',').flatMap((part) => {\n\t\tconst [column, direction] = part.split(':');\n\t\tif (!column) return [];\n\t\treturn [\n\t\t\t{\n\t\t\t\tcolumn,\n\t\t\t\tdirection: direction === 'desc' ? Direction.Desc : Direction.Asc,\n\t\t\t},\n\t\t];\n\t});\n}\n\nfunction json(\n\tbody: unknown,\n\tstatus = 200,\n\theaders: Record<string, string> = {},\n): Response {\n\t// A row can hold a bigint when the pg client is configured to parse int8,\n\t// and JSON.stringify throws on one.\n\tconst text = JSON.stringify(body, (_key, value) =>\n\t\ttypeof value === 'bigint' ? value.toString() : value,\n\t);\n\treturn new Response(text, {\n\t\tstatus,\n\t\theaders: { 'content-type': 'application/json; charset=utf-8', ...headers },\n\t});\n}\n"],"mappings":";;;;;AA2BA,MAAM,YAAY,IAAI,IAAY,OAAO,OAAO,cAAc,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8B/D,SAAgB,2BACf,SACuB;CACvB,MAAM,UAAU,IAAI,YAAY,OAAO;CACvC,MAAM,YAAY,QAAQ,YAAY,GAAA,CAAI,QAAQ,QAAQ,EAAE;CAE5D,OAAO,OAAO,YAAY;EACzB,IAAI,QAAQ,WAAW,OACtB,OAAO,KACN;GACC,OAAO;GACP,SAAS;EACV,GACA,KACA,EAAE,OAAO,MAAM,CAChB;EAGD,MAAM,MAAM,IAAI,IAAI,QAAQ,GAAG;EAC/B,MAAM,OAAO,IAAI,SAAS,WAAW,QAAQ,IAC1C,IAAI,SAAS,MAAM,SAAS,MAAM,IAClC,IAAI;EACP,MAAM,WAAW,KAAK,MAAM,GAAG,CAAC,CAAC,OAAO,OAAO,CAAC,CAAC,IAAI,kBAAkB;EACvE,MAAM,SAAS,IAAI,aAAa,IAAI,QAAQ,KAAK,KAAA;EAEjD,IAAI;GACH,IAAI,SAAS,WAAW,KAAK,SAAS,OAAO,WAC5C,OAAO,KAAK;IACX,SAAS,MAAM,QAAQ,YAAY;IACnC,WAAW,QAAQ;GACpB,CAAC;GAGF,IAAI,SAAS,WAAW,KAAK,SAAS,OAAO,UAAU;IACtD,MAAM,UAAU,IAAI,aAAa,IAAI,SAAS,MAAM;IACpD,MAAM,EAAE,QAAQ,cAAc,MAAM,QAAQ,UAAU,OAAO;IAC7D,OAAO,KAAK;KACX,QAAQ,SAAS,OAAO,QAAQ,MAAM,EAAE,WAAW,MAAM,IAAI;KAC7D;IACD,CAAC;GACF;GAEA,IAAI,SAAS,OAAO,YAAY,SAAS,MAAM,SAAS,WAAW,GAAG;IACrE,MAAM,QAAQ,MAAM,QAAQ,aAAa,SAAS,IAAI,MAAM;IAC5D,IAAI,CAAC,OACJ,MAAM,IAAI,cACT,SAAS,IACT,UAAU,QAAQ,QAAQ,MAAM,QACjC;IAED,OAAO,KAAK,KAAK;GAClB;GAEA,IACC,SAAS,OAAO,YAChB,SAAS,MACT,SAAS,OAAO,UAChB,SAAS,WAAW,GACnB;IACD,MAAM,WAAW,OAAO,SACvB,IAAI,aAAa,IAAI,UAAU,KAAK,IACpC,EACD;IACA,MAAM,UAAU,aAAa,IAAI,YAAY;IAC7C,MAAM,OAAO,UAAU,IAAI,aAAa,IAAI,MAAM,CAAC;IAEnD,OAAO,KACN,MAAM,QAAQ,MAAM;KACnB,OAAO,SAAS;KAChB;KACA,UAAU,OAAO,MAAM,QAAQ,IAAI,KAAA,IAAY;KAC/C,QAAQ,IAAI,aAAa,IAAI,QAAQ,KAAK,KAAA;KAC1C,SAAS,QAAQ,SAAS,IAAI,UAAU,KAAA;KACxC,MAAM,KAAK,SAAS,IAAI,OAAO,KAAA;IAChC,CAAC,CACF;GACD;GAEA,OAAO,KACN;IACC,OAAO;IACP,SAAS,yBAAyB,QAAQ,IAAI;GAC/C,GACA,GACD;EACD,SAAS,OAAO;GACf,MAAM,SAAS,UAAU,KAAK;GAC9B,IAAI,WAAW,KAAA,GAAW,MAAM;GAChC,OAAO,KACN;IAAE,OAAQ,MAAgB;IAAM,SAAU,MAAgB;GAAQ,GAClE,MACD;EACD;CACD;AACD;;AAGA,SAAS,UAAU,OAAoC;CACtD,IAAI,iBAAiB,eAAe,OAAO;CAC3C,IACC,iBAAiB,kBACjB,iBAAiB,6BACjB,iBAAiB,eAEjB,OAAO;AAGT;;;;;;AAOA,SAAS,aAAa,QAA4C;CACjE,MAAM,UAA6B,CAAC;CAEpC,KAAK,MAAM,CAAC,KAAK,UAAU,QAAQ;EAClC,MAAM,QAAQ,IAAI,MAAM,4BAA4B;EACpD,MAAM,SAAS,QAAQ;EACvB,MAAM,WAAW,QAAQ;EACzB,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,UAAU,IAAI,QAAQ,GAAG;EAEtD,MAAM,KAAK;EACX,IAAI,OAAA,QAA4B,OAAA,OAC/B,QAAQ,KAAK;GAAE;GAAQ,UAAU;GAAI,OAAO,MAAM,MAAM,GAAG;EAAE,CAAC;OACxD,IACN,OAAA,aACA,OAAA,eAEA,QAAQ,KAAK;GAAE;GAAQ,UAAU;EAAG,CAAC;OAErC,QAAQ,KAAK;GAAE;GAAQ,UAAU;GAAI,OAAO,YAAY,KAAK;EAAE,CAAC;CAElE;CAEA,OAAO;AACR;AAEA,SAAS,YAAY,OAAwB;CAC5C,IAAI,UAAU,QAAQ,OAAO;CAC7B,IAAI,UAAU,SAAS,OAAO;CAC9B,IAAI,UAAU,MAAM,CAAC,OAAO,MAAM,OAAO,KAAK,CAAC,GAAG,OAAO,OAAO,KAAK;CACrE,OAAO;AACR;;AAGA,SAAS,UAAU,OAAoC;CACtD,IAAI,CAAC,OAAO,OAAO,CAAC;CAEpB,OAAO,MAAM,MAAM,GAAG,CAAC,CAAC,SAAS,SAAS;EACzC,MAAM,CAAC,QAAQ,aAAa,KAAK,MAAM,GAAG;EAC1C,IAAI,CAAC,QAAQ,OAAO,CAAC;EACrB,OAAO,CACN;GACC;GACA,WAAW,cAAc,SAAA,SAAA;EAC1B,CACD;CACD,CAAC;AACF;AAEA,SAAS,KACR,MACA,SAAS,KACT,UAAkC,CAAC,GACxB;CAGX,MAAM,OAAO,KAAK,UAAU,OAAO,MAAM,UACxC,OAAO,UAAU,WAAW,MAAM,SAAS,IAAI,KAChD;CACA,OAAO,IAAI,SAAS,MAAM;EACzB;EACA,SAAS;GAAE,gBAAgB;GAAmC,GAAG;EAAQ;CAC1E,CAAC;AACF"}

package/dist/introspect/index.cjs

@@ -0,0 +1,22 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_pagination = require("../pagination.cjs");
+const require_introspect_errors = require("./errors.cjs");
+const require_introspect_types = require("./types.cjs");
+const require_introspect_filtering = require("./filtering.cjs");
+const require_introspect_introspection = require("./introspection.cjs");
+const require_introspect_DataBrowser = require("./DataBrowser.cjs");
+const require_introspect_handler = require("./handler.cjs");
+exports.ColumnNotFound = require_introspect_errors.ColumnNotFound;
+exports.DataBrowser = require_introspect_DataBrowser.DataBrowser;
+exports.Direction = require_pagination.Direction;
+exports.FilterOperator = require_introspect_types.FilterOperator;
+exports.InvalidCursor = require_pagination.InvalidCursor;
+exports.TableNotFound = require_introspect_errors.TableNotFound;
+exports.UnsupportedFilterOperator = require_introspect_errors.UnsupportedFilterOperator;
+exports.applyFilters = require_introspect_filtering.applyFilters;
+exports.applySorting = require_introspect_filtering.applySorting;
+exports.createIntrospectionHandler = require_introspect_handler.createIntrospectionHandler;
+exports.introspectSchema = require_introspect_introspection.introspectSchema;
+exports.introspectTable = require_introspect_introspection.introspectTable;
+exports.listSchemas = require_introspect_introspection.listSchemas;
+exports.validateFilter = require_introspect_filtering.validateFilter;

package/dist/introspect/index.d.cts

@@ -0,0 +1,8 @@
+import { n as InvalidCursor, t as Direction } from "../pagination-CrU89125.cjs";
+import { ColumnInfo, ColumnType, CursorConfig, DataBrowserOptions, FilterCondition, FilterOperator, QueryOptions, QueryResult, SchemaInfo, SortConfig, TableInfo } from "./types.cjs";
+import { DataBrowser } from "./DataBrowser.cjs";
+import { ColumnNotFound, TableNotFound, UnsupportedFilterOperator } from "./errors.cjs";
+import { applyFilters, applySorting, validateFilter } from "./filtering.cjs";
+import { IntrospectionHandler, IntrospectionHandlerOptions, createIntrospectionHandler } from "./handler.cjs";
+import { IntrospectSchemaOptions, introspectSchema, introspectTable, listSchemas } from "./introspection.cjs";
+export { type ColumnInfo, ColumnNotFound, type ColumnType, type CursorConfig, DataBrowser, type DataBrowserOptions, Direction, type FilterCondition, FilterOperator, type IntrospectSchemaOptions, type IntrospectionHandler, type IntrospectionHandlerOptions, InvalidCursor, type QueryOptions, type QueryResult, type SchemaInfo, type SortConfig, type TableInfo, TableNotFound, UnsupportedFilterOperator, applyFilters, applySorting, createIntrospectionHandler, introspectSchema, introspectTable, listSchemas, validateFilter };

package/dist/introspect/index.d.mts

@@ -0,0 +1,8 @@
+import { n as InvalidCursor, t as Direction } from "../pagination-CrU89125.mjs";
+import { ColumnInfo, ColumnType, CursorConfig, DataBrowserOptions, FilterCondition, FilterOperator, QueryOptions, QueryResult, SchemaInfo, SortConfig, TableInfo } from "./types.mjs";
+import { DataBrowser } from "./DataBrowser.mjs";
+import { ColumnNotFound, TableNotFound, UnsupportedFilterOperator } from "./errors.mjs";
+import { applyFilters, applySorting, validateFilter } from "./filtering.mjs";
+import { IntrospectionHandler, IntrospectionHandlerOptions, createIntrospectionHandler } from "./handler.mjs";
+import { IntrospectSchemaOptions, introspectSchema, introspectTable, listSchemas } from "./introspection.mjs";
+export { type ColumnInfo, ColumnNotFound, type ColumnType, type CursorConfig, DataBrowser, type DataBrowserOptions, Direction, type FilterCondition, FilterOperator, type IntrospectSchemaOptions, type IntrospectionHandler, type IntrospectionHandlerOptions, InvalidCursor, type QueryOptions, type QueryResult, type SchemaInfo, type SortConfig, type TableInfo, TableNotFound, UnsupportedFilterOperator, applyFilters, applySorting, createIntrospectionHandler, introspectSchema, introspectTable, listSchemas, validateFilter };

package/dist/introspect/index.mjs

@@ -0,0 +1,8 @@
+import { Direction, InvalidCursor } from "../pagination.mjs";
+import { ColumnNotFound, TableNotFound, UnsupportedFilterOperator } from "./errors.mjs";
+import { FilterOperator } from "./types.mjs";
+import { applyFilters, applySorting, validateFilter } from "./filtering.mjs";
+import { introspectSchema, introspectTable, listSchemas } from "./introspection.mjs";
+import { DataBrowser } from "./DataBrowser.mjs";
+import { createIntrospectionHandler } from "./handler.mjs";
+export { ColumnNotFound, DataBrowser, Direction, FilterOperator, InvalidCursor, TableNotFound, UnsupportedFilterOperator, applyFilters, applySorting, createIntrospectionHandler, introspectSchema, introspectTable, listSchemas, validateFilter };

package/dist/introspect/introspection.cjs

@@ -0,0 +1,149 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+let kysely = require("kysely");
+//#region src/introspect/introspection.ts
+/**
+* The schemas the database has, without Postgres's own (`pg_catalog`,
+* `pg_toast`, `information_schema`, …).
+*/
+async function listSchemas(db) {
+	const { rows } = await kysely.sql`
+		SELECT nspname AS name
+		FROM pg_catalog.pg_namespace
+		WHERE nspname <> 'information_schema'
+			AND nspname NOT LIKE 'pg\\_%'
+		ORDER BY nspname
+	`.execute(db);
+	return rows.map((row) => row.name);
+}
+/**
+* Every base table in the given schemas, with its columns, primary key and
+* foreign keys. Views are left out: they have no key to page by.
+*/
+async function introspectSchema(db, options = {}) {
+	const schemas = options.schemas ?? ["public"];
+	const excluded = options.excludeTables ?? [];
+	const { rows } = await kysely.sql`
+		SELECT table_name AS name, table_schema AS schema
+		FROM information_schema.tables
+		WHERE table_schema = ANY(${schemas})
+			AND table_type = 'BASE TABLE'
+			AND NOT (table_name = ANY(${excluded}))
+		ORDER BY table_schema, table_name
+	`.execute(db);
+	return {
+		tables: await Promise.all(rows.map((row) => introspectTable(db, row.name, row.schema))),
+		updatedAt: /* @__PURE__ */ new Date()
+	};
+}
+/**
+* One table's columns, primary key, foreign keys and estimated row count.
+*/
+async function introspectTable(db, tableName, schema = "public") {
+	const [columns, foreignKeys, estimate] = await Promise.all([
+		kysely.sql`
+			SELECT
+				c.column_name AS name,
+				c.udt_name AS udt,
+				c.is_nullable AS nullable,
+				c.column_default AS fallback,
+				EXISTS (
+					SELECT 1
+					FROM information_schema.table_constraints tc
+					JOIN information_schema.key_column_usage ku
+						ON tc.constraint_name = ku.constraint_name
+						AND tc.table_schema = ku.table_schema
+					WHERE tc.table_name = c.table_name
+						AND tc.table_schema = c.table_schema
+						AND tc.constraint_type = 'PRIMARY KEY'
+						AND ku.column_name = c.column_name
+				) AS pk
+			FROM information_schema.columns c
+			WHERE c.table_name = ${tableName}
+				AND c.table_schema = ${schema}
+			ORDER BY c.ordinal_position
+		`.execute(db),
+		kysely.sql`
+			SELECT
+				kcu.column_name AS name,
+				ccu.table_name AS target,
+				ccu.column_name AS referenced
+			FROM information_schema.table_constraints tc
+			JOIN information_schema.key_column_usage kcu
+				ON tc.constraint_name = kcu.constraint_name
+				AND tc.table_schema = kcu.table_schema
+			JOIN information_schema.constraint_column_usage ccu
+				ON tc.constraint_name = ccu.constraint_name
+				AND tc.table_schema = ccu.table_schema
+			WHERE tc.table_name = ${tableName}
+				AND tc.table_schema = ${schema}
+				AND tc.constraint_type = 'FOREIGN KEY'
+		`.execute(db),
+		kysely.sql`
+			SELECT c.reltuples::bigint AS estimate
+			FROM pg_catalog.pg_class c
+			JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
+			WHERE c.relname = ${tableName}
+				AND n.nspname = ${schema}
+		`.execute(db)
+	]);
+	const references = new Map(foreignKeys.rows.map((row) => [row.name, {
+		table: row.target,
+		column: row.referenced
+	}]));
+	const columnInfo = columns.rows.map((row) => {
+		const reference = references.get(row.name);
+		return {
+			name: row.name,
+			type: mapPostgresType(row.udt),
+			rawType: row.udt,
+			nullable: row.nullable === "YES",
+			isPrimaryKey: row.pk,
+			isForeignKey: !!reference,
+			foreignKeyTable: reference?.table,
+			foreignKeyColumn: reference?.column,
+			defaultValue: row.fallback ?? void 0
+		};
+	});
+	const rowEstimate = Number(estimate.rows[0]?.estimate ?? 0);
+	return {
+		name: tableName,
+		schema,
+		columns: columnInfo,
+		primaryKey: columnInfo.filter((c) => c.isPrimaryKey).map((c) => c.name),
+		estimatedRowCount: rowEstimate > 0 ? rowEstimate : void 0
+	};
+}
+const POSTGRES_TYPES = {
+	varchar: "string",
+	char: "string",
+	text: "string",
+	name: "string",
+	bpchar: "string",
+	citext: "string",
+	int2: "number",
+	int4: "number",
+	int8: "number",
+	float4: "number",
+	float8: "number",
+	numeric: "number",
+	money: "number",
+	bool: "boolean",
+	date: "date",
+	timestamp: "datetime",
+	timestamptz: "datetime",
+	time: "datetime",
+	timetz: "datetime",
+	json: "json",
+	jsonb: "json",
+	bytea: "binary",
+	uuid: "uuid"
+};
+function mapPostgresType(udtName) {
+	return POSTGRES_TYPES[udtName] ?? "unknown";
+}
+//#endregion
+exports.introspectSchema = introspectSchema;
+exports.introspectTable = introspectTable;
+exports.listSchemas = listSchemas;
+
+//# sourceMappingURL=introspection.cjs.map

package/dist/introspect/introspection.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"introspection.cjs","names":[],"sources":["../../src/introspect/introspection.ts"],"sourcesContent":["import { type Kysely, sql } from 'kysely';\nimport type { ColumnInfo, ColumnType, SchemaInfo, TableInfo } from './types';\n\n// Every query aliases its columns to a single lower-case word. A `Kysely` built\n// with `CamelCasePlugin` rewrites result keys, so `column_name` would come back\n// as `columnName` from one client and `column_name` from another; a one-word\n// alias reads the same through both.\n\n/**\n * The schemas the database has, without Postgres's own (`pg_catalog`,\n * `pg_toast`, `information_schema`, …).\n */\nexport async function listSchemas<DB>(db: Kysely<DB>): Promise<string[]> {\n\tconst { rows } = await sql<{ name: string }>`\n\t\tSELECT nspname AS name\n\t\tFROM pg_catalog.pg_namespace\n\t\tWHERE nspname <> 'information_schema'\n\t\t\tAND nspname NOT LIKE 'pg\\\\_%'\n\t\tORDER BY nspname\n\t`.execute(db);\n\n\treturn rows.map((row) => row.name);\n}\n\nexport interface IntrospectSchemaOptions {\n\t/** The schemas to read tables from (default: `['public']`). */\n\tschemas?: string[];\n\t/** Tables to leave out, by name. */\n\texcludeTables?: string[];\n}\n\n/**\n * Every base table in the given schemas, with its columns, primary key and\n * foreign keys. Views are left out: they have no key to page by.\n */\nexport async function introspectSchema<DB>(\n\tdb: Kysely<DB>,\n\toptions: IntrospectSchemaOptions = {},\n): Promise<SchemaInfo> {\n\tconst schemas = options.schemas ?? ['public'];\n\tconst excluded = options.excludeTables ?? [];\n\n\tconst { rows } = await sql<{ name: string; schema: string }>`\n\t\tSELECT table_name AS name, table_schema AS schema\n\t\tFROM information_schema.tables\n\t\tWHERE table_schema = ANY(${schemas})\n\t\t\tAND table_type = 'BASE TABLE'\n\t\t\tAND NOT (table_name = ANY(${excluded}))\n\t\tORDER BY table_schema, table_name\n\t`.execute(db);\n\n\tconst tables = await Promise.all(\n\t\trows.map((row) => introspectTable(db, row.name, row.schema)),\n\t);\n\n\treturn { tables, updatedAt: new Date() };\n}\n\n/**\n * One table's columns, primary key, foreign keys and estimated row count.\n */\nexport async function introspectTable<DB>(\n\tdb: Kysely<DB>,\n\ttableName: string,\n\tschema = 'public',\n): Promise<TableInfo> {\n\tconst [columns, foreignKeys, estimate] = await Promise.all([\n\t\tsql<{\n\t\t\tname: string;\n\t\t\tudt: string;\n\t\t\tnullable: string;\n\t\t\tfallback: string | null;\n\t\t\tpk: boolean;\n\t\t}>`\n\t\t\tSELECT\n\t\t\t\tc.column_name AS name,\n\t\t\t\tc.udt_name AS udt,\n\t\t\t\tc.is_nullable AS nullable,\n\t\t\t\tc.column_default AS fallback,\n\t\t\t\tEXISTS (\n\t\t\t\t\tSELECT 1\n\t\t\t\t\tFROM information_schema.table_constraints tc\n\t\t\t\t\tJOIN information_schema.key_column_usage ku\n\t\t\t\t\t\tON tc.constraint_name = ku.constraint_name\n\t\t\t\t\t\tAND tc.table_schema = ku.table_schema\n\t\t\t\t\tWHERE tc.table_name = c.table_name\n\t\t\t\t\t\tAND tc.table_schema = c.table_schema\n\t\t\t\t\t\tAND tc.constraint_type = 'PRIMARY KEY'\n\t\t\t\t\t\tAND ku.column_name = c.column_name\n\t\t\t\t) AS pk\n\t\t\tFROM information_schema.columns c\n\t\t\tWHERE c.table_name = ${tableName}\n\t\t\t\tAND c.table_schema = ${schema}\n\t\t\tORDER BY c.ordinal_position\n\t\t`.execute(db),\n\t\tsql<{ name: string; target: string; referenced: string }>`\n\t\t\tSELECT\n\t\t\t\tkcu.column_name AS name,\n\t\t\t\tccu.table_name AS target,\n\t\t\t\tccu.column_name AS referenced\n\t\t\tFROM information_schema.table_constraints tc\n\t\t\tJOIN information_schema.key_column_usage kcu\n\t\t\t\tON tc.constraint_name = kcu.constraint_name\n\t\t\t\tAND tc.table_schema = kcu.table_schema\n\t\t\tJOIN information_schema.constraint_column_usage ccu\n\t\t\t\tON tc.constraint_name = ccu.constraint_name\n\t\t\t\tAND tc.table_schema = ccu.table_schema\n\t\t\tWHERE tc.table_name = ${tableName}\n\t\t\t\tAND tc.table_schema = ${schema}\n\t\t\t\tAND tc.constraint_type = 'FOREIGN KEY'\n\t\t`.execute(db),\n\t\t// The planner's estimate rather than `count(*)`, which scans the table.\n\t\t// It is -1 for a table never analysed, which is \"unknown\", not empty.\n\t\tsql<{ estimate: string | number }>`\n\t\t\tSELECT c.reltuples::bigint AS estimate\n\t\t\tFROM pg_catalog.pg_class c\n\t\t\tJOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace\n\t\t\tWHERE c.relname = ${tableName}\n\t\t\t\tAND n.nspname = ${schema}\n\t\t`.execute(db),\n\t]);\n\n\tconst references = new Map(\n\t\tforeignKeys.rows.map((row) => [\n\t\t\trow.name,\n\t\t\t{ table: row.target, column: row.referenced },\n\t\t]),\n\t);\n\n\tconst columnInfo: ColumnInfo[] = columns.rows.map((row) => {\n\t\tconst reference = references.get(row.name);\n\t\treturn {\n\t\t\tname: row.name,\n\t\t\ttype: mapPostgresType(row.udt),\n\t\t\trawType: row.udt,\n\t\t\tnullable: row.nullable === 'YES',\n\t\t\tisPrimaryKey: row.pk,\n\t\t\tisForeignKey: !!reference,\n\t\t\tforeignKeyTable: reference?.table,\n\t\t\tforeignKeyColumn: reference?.column,\n\t\t\tdefaultValue: row.fallback ?? undefined,\n\t\t};\n\t});\n\n\tconst rowEstimate = Number(estimate.rows[0]?.estimate ?? 0);\n\n\treturn {\n\t\tname: tableName,\n\t\tschema,\n\t\tcolumns: columnInfo,\n\t\tprimaryKey: columnInfo.filter((c) => c.isPrimaryKey).map((c) => c.name),\n\t\testimatedRowCount: rowEstimate > 0 ? rowEstimate : undefined,\n\t};\n}\n\nconst POSTGRES_TYPES: Record<string, ColumnType> = {\n\tvarchar: 'string',\n\tchar: 'string',\n\ttext: 'string',\n\tname: 'string',\n\tbpchar: 'string',\n\tcitext: 'string',\n\n\tint2: 'number',\n\tint4: 'number',\n\tint8: 'number',\n\tfloat4: 'number',\n\tfloat8: 'number',\n\tnumeric: 'number',\n\tmoney: 'number',\n\n\tbool: 'boolean',\n\n\tdate: 'date',\n\ttimestamp: 'datetime',\n\ttimestamptz: 'datetime',\n\ttime: 'datetime',\n\ttimetz: 'datetime',\n\n\tjson: 'json',\n\tjsonb: 'json',\n\n\tbytea: 'binary',\n\n\tuuid: 'uuid',\n};\n\nfunction mapPostgresType(udtName: string): ColumnType {\n\treturn POSTGRES_TYPES[udtName] ?? 'unknown';\n}\n"],"mappings":";;;;;;;AAYA,eAAsB,YAAgB,IAAmC;CACxE,MAAM,EAAE,SAAS,MAAM,OAAA,GAAqB;;;;;;GAM1C,QAAQ,EAAE;CAEZ,OAAO,KAAK,KAAK,QAAQ,IAAI,IAAI;AAClC;;;;;AAaA,eAAsB,iBACrB,IACA,UAAmC,CAAC,GACd;CACtB,MAAM,UAAU,QAAQ,WAAW,CAAC,QAAQ;CAC5C,MAAM,WAAW,QAAQ,iBAAiB,CAAC;CAE3C,MAAM,EAAE,SAAS,MAAM,OAAA,GAAqC;;;6BAGhC,QAAQ;;+BAEN,SAAS;;GAErC,QAAQ,EAAE;CAMZ,OAAO;EAAE,QAAA,MAJY,QAAQ,IAC5B,KAAK,KAAK,QAAQ,gBAAgB,IAAI,IAAI,MAAM,IAAI,MAAM,CAAC,CAC5D;EAEiB,2BAAW,IAAI,KAAK;CAAE;AACxC;;;;AAKA,eAAsB,gBACrB,IACA,WACA,SAAS,UACY;CACrB,MAAM,CAAC,SAAS,aAAa,YAAY,MAAM,QAAQ,IAAI;EAC1D,OAAA,GAME;;;;;;;;;;;;;;;;;;0BAkBsB,UAAU;2BACT,OAAO;;IAE9B,QAAQ,EAAE;EACZ,OAAA,GAAyD;;;;;;;;;;;;2BAYhC,UAAU;4BACT,OAAO;;IAE/B,QAAQ,EAAE;EAGZ,OAAA,GAAkC;;;;uBAIb,UAAU;sBACX,OAAO;IACzB,QAAQ,EAAE;CACb,CAAC;CAED,MAAM,aAAa,IAAI,IACtB,YAAY,KAAK,KAAK,QAAQ,CAC7B,IAAI,MACJ;EAAE,OAAO,IAAI;EAAQ,QAAQ,IAAI;CAAW,CAC7C,CAAC,CACF;CAEA,MAAM,aAA2B,QAAQ,KAAK,KAAK,QAAQ;EAC1D,MAAM,YAAY,WAAW,IAAI,IAAI,IAAI;EACzC,OAAO;GACN,MAAM,IAAI;GACV,MAAM,gBAAgB,IAAI,GAAG;GAC7B,SAAS,IAAI;GACb,UAAU,IAAI,aAAa;GAC3B,cAAc,IAAI;GAClB,cAAc,CAAC,CAAC;GAChB,iBAAiB,WAAW;GAC5B,kBAAkB,WAAW;GAC7B,cAAc,IAAI,YAAY,KAAA;EAC/B;CACD,CAAC;CAED,MAAM,cAAc,OAAO,SAAS,KAAK,EAAE,EAAE,YAAY,CAAC;CAE1D,OAAO;EACN,MAAM;EACN;EACA,SAAS;EACT,YAAY,WAAW,QAAQ,MAAM,EAAE,YAAY,CAAC,CAAC,KAAK,MAAM,EAAE,IAAI;EACtE,mBAAmB,cAAc,IAAI,cAAc,KAAA;CACpD;AACD;AAEA,MAAM,iBAA6C;CAClD,SAAS;CACT,MAAM;CACN,MAAM;CACN,MAAM;CACN,QAAQ;CACR,QAAQ;CAER,MAAM;CACN,MAAM;CACN,MAAM;CACN,QAAQ;CACR,QAAQ;CACR,SAAS;CACT,OAAO;CAEP,MAAM;CAEN,MAAM;CACN,WAAW;CACX,aAAa;CACb,MAAM;CACN,QAAQ;CAER,MAAM;CACN,OAAO;CAEP,OAAO;CAEP,MAAM;AACP;AAEA,SAAS,gBAAgB,SAA6B;CACrD,OAAO,eAAe,YAAY;AACnC"}

package/dist/introspect/introspection.d.cts

@@ -0,0 +1,25 @@
+import { SchemaInfo, TableInfo } from "./types.cjs";
+import { Kysely } from "kysely";
+//#region src/introspect/introspection.d.ts
+/**
+ * The schemas the database has, without Postgres's own (`pg_catalog`,
+ * `pg_toast`, `information_schema`, …).
+ */
+export declare function listSchemas<DB>(db: Kysely<DB>): Promise<string[]>;
+export interface IntrospectSchemaOptions {
+  /** The schemas to read tables from (default: `['public']`). */
+  schemas?: string[];
+  /** Tables to leave out, by name. */
+  excludeTables?: string[];
+}
+/**
+ * Every base table in the given schemas, with its columns, primary key and
+ * foreign keys. Views are left out: they have no key to page by.
+ */
+export declare function introspectSchema<DB>(db: Kysely<DB>, options?: IntrospectSchemaOptions): Promise<SchemaInfo>;
+/**
+ * One table's columns, primary key, foreign keys and estimated row count.
+ */
+export declare function introspectTable<DB>(db: Kysely<DB>, tableName: string, schema?: string): Promise<TableInfo>;
+//#endregion
+//# sourceMappingURL=introspection.d.cts.map

package/dist/introspect/introspection.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"introspection.d.cts","names":[],"sources":["../../src/introspect/introspection.ts"],"mappings":";;;;;;;wBAYsB,YAAY,IAAI,IAAI,OAAO,MAAM;iBAYtC;;EAEhB;;EAEA;;;;;;wBAOqB,iBAAiB,IACtC,IAAI,OAAO,KACX,UAAS,0BACP,QAAQ;;;;wBAuBW,gBAAgB,IACrC,IAAI,OAAO,KACX,mBACA,kBACE,QAAQ"}

package/dist/introspect/introspection.d.mts

@@ -0,0 +1,25 @@
+import { SchemaInfo, TableInfo } from "./types.mjs";
+import { Kysely } from "kysely";
+//#region src/introspect/introspection.d.ts
+/**
+ * The schemas the database has, without Postgres's own (`pg_catalog`,
+ * `pg_toast`, `information_schema`, …).
+ */
+export declare function listSchemas<DB>(db: Kysely<DB>): Promise<string[]>;
+export interface IntrospectSchemaOptions {
+  /** The schemas to read tables from (default: `['public']`). */
+  schemas?: string[];
+  /** Tables to leave out, by name. */
+  excludeTables?: string[];
+}
+/**
+ * Every base table in the given schemas, with its columns, primary key and
+ * foreign keys. Views are left out: they have no key to page by.
+ */
+export declare function introspectSchema<DB>(db: Kysely<DB>, options?: IntrospectSchemaOptions): Promise<SchemaInfo>;
+/**
+ * One table's columns, primary key, foreign keys and estimated row count.
+ */
+export declare function introspectTable<DB>(db: Kysely<DB>, tableName: string, schema?: string): Promise<TableInfo>;
+//#endregion
+//# sourceMappingURL=introspection.d.mts.map

package/dist/introspect/introspection.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"introspection.d.mts","names":[],"sources":["../../src/introspect/introspection.ts"],"mappings":";;;;;;;wBAYsB,YAAY,IAAI,IAAI,OAAO,MAAM;iBAYtC;;EAEhB;;EAEA;;;;;;wBAOqB,iBAAiB,IACtC,IAAI,OAAO,KACX,UAAS,0BACP,QAAQ;;;;wBAuBW,gBAAgB,IACrC,IAAI,OAAO,KACX,mBACA,kBACE,QAAQ"}

package/dist/introspect/introspection.mjs

@@ -0,0 +1,146 @@
+import { sql } from "kysely";
+//#region src/introspect/introspection.ts
+/**
+* The schemas the database has, without Postgres's own (`pg_catalog`,
+* `pg_toast`, `information_schema`, …).
+*/
+async function listSchemas(db) {
+	const { rows } = await sql`
+		SELECT nspname AS name
+		FROM pg_catalog.pg_namespace
+		WHERE nspname <> 'information_schema'
+			AND nspname NOT LIKE 'pg\\_%'
+		ORDER BY nspname
+	`.execute(db);
+	return rows.map((row) => row.name);
+}
+/**
+* Every base table in the given schemas, with its columns, primary key and
+* foreign keys. Views are left out: they have no key to page by.
+*/
+async function introspectSchema(db, options = {}) {
+	const schemas = options.schemas ?? ["public"];
+	const excluded = options.excludeTables ?? [];
+	const { rows } = await sql`
+		SELECT table_name AS name, table_schema AS schema
+		FROM information_schema.tables
+		WHERE table_schema = ANY(${schemas})
+			AND table_type = 'BASE TABLE'
+			AND NOT (table_name = ANY(${excluded}))
+		ORDER BY table_schema, table_name
+	`.execute(db);
+	return {
+		tables: await Promise.all(rows.map((row) => introspectTable(db, row.name, row.schema))),
+		updatedAt: /* @__PURE__ */ new Date()
+	};
+}
+/**
+* One table's columns, primary key, foreign keys and estimated row count.
+*/
+async function introspectTable(db, tableName, schema = "public") {
+	const [columns, foreignKeys, estimate] = await Promise.all([
+		sql`
+			SELECT
+				c.column_name AS name,
+				c.udt_name AS udt,
+				c.is_nullable AS nullable,
+				c.column_default AS fallback,
+				EXISTS (
+					SELECT 1
+					FROM information_schema.table_constraints tc
+					JOIN information_schema.key_column_usage ku
+						ON tc.constraint_name = ku.constraint_name
+						AND tc.table_schema = ku.table_schema
+					WHERE tc.table_name = c.table_name
+						AND tc.table_schema = c.table_schema
+						AND tc.constraint_type = 'PRIMARY KEY'
+						AND ku.column_name = c.column_name
+				) AS pk
+			FROM information_schema.columns c
+			WHERE c.table_name = ${tableName}
+				AND c.table_schema = ${schema}
+			ORDER BY c.ordinal_position
+		`.execute(db),
+		sql`
+			SELECT
+				kcu.column_name AS name,
+				ccu.table_name AS target,
+				ccu.column_name AS referenced
+			FROM information_schema.table_constraints tc
+			JOIN information_schema.key_column_usage kcu
+				ON tc.constraint_name = kcu.constraint_name
+				AND tc.table_schema = kcu.table_schema
+			JOIN information_schema.constraint_column_usage ccu
+				ON tc.constraint_name = ccu.constraint_name
+				AND tc.table_schema = ccu.table_schema
+			WHERE tc.table_name = ${tableName}
+				AND tc.table_schema = ${schema}
+				AND tc.constraint_type = 'FOREIGN KEY'
+		`.execute(db),
+		sql`
+			SELECT c.reltuples::bigint AS estimate
+			FROM pg_catalog.pg_class c
+			JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
+			WHERE c.relname = ${tableName}
+				AND n.nspname = ${schema}
+		`.execute(db)
+	]);
+	const references = new Map(foreignKeys.rows.map((row) => [row.name, {
+		table: row.target,
+		column: row.referenced
+	}]));
+	const columnInfo = columns.rows.map((row) => {
+		const reference = references.get(row.name);
+		return {
+			name: row.name,
+			type: mapPostgresType(row.udt),
+			rawType: row.udt,
+			nullable: row.nullable === "YES",
+			isPrimaryKey: row.pk,
+			isForeignKey: !!reference,
+			foreignKeyTable: reference?.table,
+			foreignKeyColumn: reference?.column,
+			defaultValue: row.fallback ?? void 0
+		};
+	});
+	const rowEstimate = Number(estimate.rows[0]?.estimate ?? 0);
+	return {
+		name: tableName,
+		schema,
+		columns: columnInfo,
+		primaryKey: columnInfo.filter((c) => c.isPrimaryKey).map((c) => c.name),
+		estimatedRowCount: rowEstimate > 0 ? rowEstimate : void 0
+	};
+}
+const POSTGRES_TYPES = {
+	varchar: "string",
+	char: "string",
+	text: "string",
+	name: "string",
+	bpchar: "string",
+	citext: "string",
+	int2: "number",
+	int4: "number",
+	int8: "number",
+	float4: "number",
+	float8: "number",
+	numeric: "number",
+	money: "number",
+	bool: "boolean",
+	date: "date",
+	timestamp: "datetime",
+	timestamptz: "datetime",
+	time: "datetime",
+	timetz: "datetime",
+	json: "json",
+	jsonb: "json",
+	bytea: "binary",
+	uuid: "uuid"
+};
+function mapPostgresType(udtName) {
+	return POSTGRES_TYPES[udtName] ?? "unknown";
+}
+//#endregion
+export { introspectSchema, introspectTable, listSchemas };
+
+//# sourceMappingURL=introspection.mjs.map

package/dist/introspect/introspection.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"introspection.mjs","names":[],"sources":["../../src/introspect/introspection.ts"],"sourcesContent":["import { type Kysely, sql } from 'kysely';\nimport type { ColumnInfo, ColumnType, SchemaInfo, TableInfo } from './types';\n\n// Every query aliases its columns to a single lower-case word. A `Kysely` built\n// with `CamelCasePlugin` rewrites result keys, so `column_name` would come back\n// as `columnName` from one client and `column_name` from another; a one-word\n// alias reads the same through both.\n\n/**\n * The schemas the database has, without Postgres's own (`pg_catalog`,\n * `pg_toast`, `information_schema`, …).\n */\nexport async function listSchemas<DB>(db: Kysely<DB>): Promise<string[]> {\n\tconst { rows } = await sql<{ name: string }>`\n\t\tSELECT nspname AS name\n\t\tFROM pg_catalog.pg_namespace\n\t\tWHERE nspname <> 'information_schema'\n\t\t\tAND nspname NOT LIKE 'pg\\\\_%'\n\t\tORDER BY nspname\n\t`.execute(db);\n\n\treturn rows.map((row) => row.name);\n}\n\nexport interface IntrospectSchemaOptions {\n\t/** The schemas to read tables from (default: `['public']`). */\n\tschemas?: string[];\n\t/** Tables to leave out, by name. */\n\texcludeTables?: string[];\n}\n\n/**\n * Every base table in the given schemas, with its columns, primary key and\n * foreign keys. Views are left out: they have no key to page by.\n */\nexport async function introspectSchema<DB>(\n\tdb: Kysely<DB>,\n\toptions: IntrospectSchemaOptions = {},\n): Promise<SchemaInfo> {\n\tconst schemas = options.schemas ?? ['public'];\n\tconst excluded = options.excludeTables ?? [];\n\n\tconst { rows } = await sql<{ name: string; schema: string }>`\n\t\tSELECT table_name AS name, table_schema AS schema\n\t\tFROM information_schema.tables\n\t\tWHERE table_schema = ANY(${schemas})\n\t\t\tAND table_type = 'BASE TABLE'\n\t\t\tAND NOT (table_name = ANY(${excluded}))\n\t\tORDER BY table_schema, table_name\n\t`.execute(db);\n\n\tconst tables = await Promise.all(\n\t\trows.map((row) => introspectTable(db, row.name, row.schema)),\n\t);\n\n\treturn { tables, updatedAt: new Date() };\n}\n\n/**\n * One table's columns, primary key, foreign keys and estimated row count.\n */\nexport async function introspectTable<DB>(\n\tdb: Kysely<DB>,\n\ttableName: string,\n\tschema = 'public',\n): Promise<TableInfo> {\n\tconst [columns, foreignKeys, estimate] = await Promise.all([\n\t\tsql<{\n\t\t\tname: string;\n\t\t\tudt: string;\n\t\t\tnullable: string;\n\t\t\tfallback: string | null;\n\t\t\tpk: boolean;\n\t\t}>`\n\t\t\tSELECT\n\t\t\t\tc.column_name AS name,\n\t\t\t\tc.udt_name AS udt,\n\t\t\t\tc.is_nullable AS nullable,\n\t\t\t\tc.column_default AS fallback,\n\t\t\t\tEXISTS (\n\t\t\t\t\tSELECT 1\n\t\t\t\t\tFROM information_schema.table_constraints tc\n\t\t\t\t\tJOIN information_schema.key_column_usage ku\n\t\t\t\t\t\tON tc.constraint_name = ku.constraint_name\n\t\t\t\t\t\tAND tc.table_schema = ku.table_schema\n\t\t\t\t\tWHERE tc.table_name = c.table_name\n\t\t\t\t\t\tAND tc.table_schema = c.table_schema\n\t\t\t\t\t\tAND tc.constraint_type = 'PRIMARY KEY'\n\t\t\t\t\t\tAND ku.column_name = c.column_name\n\t\t\t\t) AS pk\n\t\t\tFROM information_schema.columns c\n\t\t\tWHERE c.table_name = ${tableName}\n\t\t\t\tAND c.table_schema = ${schema}\n\t\t\tORDER BY c.ordinal_position\n\t\t`.execute(db),\n\t\tsql<{ name: string; target: string; referenced: string }>`\n\t\t\tSELECT\n\t\t\t\tkcu.column_name AS name,\n\t\t\t\tccu.table_name AS target,\n\t\t\t\tccu.column_name AS referenced\n\t\t\tFROM information_schema.table_constraints tc\n\t\t\tJOIN information_schema.key_column_usage kcu\n\t\t\t\tON tc.constraint_name = kcu.constraint_name\n\t\t\t\tAND tc.table_schema = kcu.table_schema\n\t\t\tJOIN information_schema.constraint_column_usage ccu\n\t\t\t\tON tc.constraint_name = ccu.constraint_name\n\t\t\t\tAND tc.table_schema = ccu.table_schema\n\t\t\tWHERE tc.table_name = ${tableName}\n\t\t\t\tAND tc.table_schema = ${schema}\n\t\t\t\tAND tc.constraint_type = 'FOREIGN KEY'\n\t\t`.execute(db),\n\t\t// The planner's estimate rather than `count(*)`, which scans the table.\n\t\t// It is -1 for a table never analysed, which is \"unknown\", not empty.\n\t\tsql<{ estimate: string | number }>`\n\t\t\tSELECT c.reltuples::bigint AS estimate\n\t\t\tFROM pg_catalog.pg_class c\n\t\t\tJOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace\n\t\t\tWHERE c.relname = ${tableName}\n\t\t\t\tAND n.nspname = ${schema}\n\t\t`.execute(db),\n\t]);\n\n\tconst references = new Map(\n\t\tforeignKeys.rows.map((row) => [\n\t\t\trow.name,\n\t\t\t{ table: row.target, column: row.referenced },\n\t\t]),\n\t);\n\n\tconst columnInfo: ColumnInfo[] = columns.rows.map((row) => {\n\t\tconst reference = references.get(row.name);\n\t\treturn {\n\t\t\tname: row.name,\n\t\t\ttype: mapPostgresType(row.udt),\n\t\t\trawType: row.udt,\n\t\t\tnullable: row.nullable === 'YES',\n\t\t\tisPrimaryKey: row.pk,\n\t\t\tisForeignKey: !!reference,\n\t\t\tforeignKeyTable: reference?.table,\n\t\t\tforeignKeyColumn: reference?.column,\n\t\t\tdefaultValue: row.fallback ?? undefined,\n\t\t};\n\t});\n\n\tconst rowEstimate = Number(estimate.rows[0]?.estimate ?? 0);\n\n\treturn {\n\t\tname: tableName,\n\t\tschema,\n\t\tcolumns: columnInfo,\n\t\tprimaryKey: columnInfo.filter((c) => c.isPrimaryKey).map((c) => c.name),\n\t\testimatedRowCount: rowEstimate > 0 ? rowEstimate : undefined,\n\t};\n}\n\nconst POSTGRES_TYPES: Record<string, ColumnType> = {\n\tvarchar: 'string',\n\tchar: 'string',\n\ttext: 'string',\n\tname: 'string',\n\tbpchar: 'string',\n\tcitext: 'string',\n\n\tint2: 'number',\n\tint4: 'number',\n\tint8: 'number',\n\tfloat4: 'number',\n\tfloat8: 'number',\n\tnumeric: 'number',\n\tmoney: 'number',\n\n\tbool: 'boolean',\n\n\tdate: 'date',\n\ttimestamp: 'datetime',\n\ttimestamptz: 'datetime',\n\ttime: 'datetime',\n\ttimetz: 'datetime',\n\n\tjson: 'json',\n\tjsonb: 'json',\n\n\tbytea: 'binary',\n\n\tuuid: 'uuid',\n};\n\nfunction mapPostgresType(udtName: string): ColumnType {\n\treturn POSTGRES_TYPES[udtName] ?? 'unknown';\n}\n"],"mappings":";;;;;;AAYA,eAAsB,YAAgB,IAAmC;CACxE,MAAM,EAAE,SAAS,MAAM,GAAqB;;;;;;GAM1C,QAAQ,EAAE;CAEZ,OAAO,KAAK,KAAK,QAAQ,IAAI,IAAI;AAClC;;;;;AAaA,eAAsB,iBACrB,IACA,UAAmC,CAAC,GACd;CACtB,MAAM,UAAU,QAAQ,WAAW,CAAC,QAAQ;CAC5C,MAAM,WAAW,QAAQ,iBAAiB,CAAC;CAE3C,MAAM,EAAE,SAAS,MAAM,GAAqC;;;6BAGhC,QAAQ;;+BAEN,SAAS;;GAErC,QAAQ,EAAE;CAMZ,OAAO;EAAE,QAAA,MAJY,QAAQ,IAC5B,KAAK,KAAK,QAAQ,gBAAgB,IAAI,IAAI,MAAM,IAAI,MAAM,CAAC,CAC5D;EAEiB,2BAAW,IAAI,KAAK;CAAE;AACxC;;;;AAKA,eAAsB,gBACrB,IACA,WACA,SAAS,UACY;CACrB,MAAM,CAAC,SAAS,aAAa,YAAY,MAAM,QAAQ,IAAI;EAC1D,GAME;;;;;;;;;;;;;;;;;;0BAkBsB,UAAU;2BACT,OAAO;;IAE9B,QAAQ,EAAE;EACZ,GAAyD;;;;;;;;;;;;2BAYhC,UAAU;4BACT,OAAO;;IAE/B,QAAQ,EAAE;EAGZ,GAAkC;;;;uBAIb,UAAU;sBACX,OAAO;IACzB,QAAQ,EAAE;CACb,CAAC;CAED,MAAM,aAAa,IAAI,IACtB,YAAY,KAAK,KAAK,QAAQ,CAC7B,IAAI,MACJ;EAAE,OAAO,IAAI;EAAQ,QAAQ,IAAI;CAAW,CAC7C,CAAC,CACF;CAEA,MAAM,aAA2B,QAAQ,KAAK,KAAK,QAAQ;EAC1D,MAAM,YAAY,WAAW,IAAI,IAAI,IAAI;EACzC,OAAO;GACN,MAAM,IAAI;GACV,MAAM,gBAAgB,IAAI,GAAG;GAC7B,SAAS,IAAI;GACb,UAAU,IAAI,aAAa;GAC3B,cAAc,IAAI;GAClB,cAAc,CAAC,CAAC;GAChB,iBAAiB,WAAW;GAC5B,kBAAkB,WAAW;GAC7B,cAAc,IAAI,YAAY,KAAA;EAC/B;CACD,CAAC;CAED,MAAM,cAAc,OAAO,SAAS,KAAK,EAAE,EAAE,YAAY,CAAC;CAE1D,OAAO;EACN,MAAM;EACN;EACA,SAAS;EACT,YAAY,WAAW,QAAQ,MAAM,EAAE,YAAY,CAAC,CAAC,KAAK,MAAM,EAAE,IAAI;EACtE,mBAAmB,cAAc,IAAI,cAAc,KAAA;CACpD;AACD;AAEA,MAAM,iBAA6C;CAClD,SAAS;CACT,MAAM;CACN,MAAM;CACN,MAAM;CACN,QAAQ;CACR,QAAQ;CAER,MAAM;CACN,MAAM;CACN,MAAM;CACN,QAAQ;CACR,QAAQ;CACR,SAAS;CACT,OAAO;CAEP,MAAM;CAEN,MAAM;CACN,WAAW;CACX,aAAa;CACb,MAAM;CACN,QAAQ;CAER,MAAM;CACN,OAAO;CAEP,OAAO;CAEP,MAAM;AACP;AAEA,SAAS,gBAAgB,SAA6B;CACrD,OAAO,eAAe,YAAY;AACnC"}

package/dist/introspect/types.cjs

@@ -0,0 +1,24 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/introspect/types.ts
+/**
+* Filter operators a row query accepts.
+*/
+let FilterOperator = /* @__PURE__ */ function(FilterOperator) {
+	FilterOperator["Eq"] = "eq";
+	FilterOperator["Neq"] = "neq";
+	FilterOperator["Gt"] = "gt";
+	FilterOperator["Gte"] = "gte";
+	FilterOperator["Lt"] = "lt";
+	FilterOperator["Lte"] = "lte";
+	FilterOperator["Like"] = "like";
+	FilterOperator["Ilike"] = "ilike";
+	FilterOperator["In"] = "in";
+	FilterOperator["Nin"] = "nin";
+	FilterOperator["IsNull"] = "is_null";
+	FilterOperator["IsNotNull"] = "is_not_null";
+	return FilterOperator;
+}({});
+//#endregion
+exports.FilterOperator = FilterOperator;
+
+//# sourceMappingURL=types.cjs.map