@typesql/pg 0.0.3 → 0.1.0

package/dist/introspect/emit.d.ts

@@ -0,0 +1,30 @@
+import type { IntrospectedColumn, IntrospectedDatabase, IntrospectedRelation } from "./introspect.js";
+export interface GenerateOptions {
+    /** Name of the exported schema interface. Default `"DB"`. */
+    readonly typeName?: string;
+    /** Module the column helpers are imported from. Default `"@typesql/core"`. */
+    readonly importFrom?: string;
+    /** Extra lines after the helper import, e.g. `import type { HistoryItem } from "./json.js";`. */
+    readonly imports?: readonly string[];
+    /**
+     * TypeScript types of `json` / `jsonb` columns: a map keyed `"table.column"` (public) or
+     * `"schema.table.column"`, or a function returning the TS type source for a column (or
+     * `undefined`). Such a column is declared as `Json<T>`: still jsonb to the SQL, read as `T`,
+     * written with `sql.json(value)`. Other columns are an error (use `column` for those).
+     */
+    readonly columnTypes?: Readonly<Record<string, string>> | ((column: IntrospectedColumn, relation: IntrospectedRelation) => string | undefined);
+    /**
+     * Full control over one column: return the TypeScript source of its descriptor
+     * (`Col<"jsonb">`, a helper of your own, ...) or `undefined` to keep the default.
+     */
+    readonly column?: (column: IntrospectedColumn, relation: IntrospectedRelation) => string | undefined;
+    /** Emit table and column comments and notes as JSDoc. Default `true`. */
+    readonly comments?: boolean;
+}
+/**
+ * TypeScript source declaring the typesql schema of an introspected database: `public`
+ * relations at the top level, other schemas nested (`DB["auth"]["sessions"]`), views and
+ * materialized views as `View<…>`, enums under `$types`.
+ */
+export declare function generateSource(db: IntrospectedDatabase, options?: GenerateOptions): string;
+//# sourceMappingURL=emit.d.ts.map

package/dist/introspect/emit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"emit.d.ts","sourceRoot":"","sources":["../../src/introspect/emit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAEtG,MAAM,WAAW,eAAe;IAC9B,6DAA6D;IAC7D,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,8EAA8E;IAC9E,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,iGAAiG;IACjG,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,CAAC,EACjB,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAChC,CAAC,CAAC,MAAM,EAAE,kBAAkB,EAAE,QAAQ,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS,CAAC,CAAC;IACzF;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,EAAE,QAAQ,EAAE,oBAAoB,KAAK,MAAM,GAAG,SAAS,CAAC;IACrG,yEAAyE;IACzE,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;CAC7B;AA2BD;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,EAAE,EAAE,oBAAoB,EAAE,OAAO,GAAE,eAAoB,GAAG,MAAM,CA8G9F"}

package/dist/introspect/emit.js

@@ -0,0 +1,144 @@
+const IDENT = /^[A-Za-z_$][A-Za-z0-9_$]*$/;
+const key = (name) => (IDENT.test(name) ? name : JSON.stringify(name));
+const str = (s) => JSON.stringify(s);
+function doc(lines, indent) {
+    const text = lines.flatMap((l) => l.split("\n")).map((l) => l.replace(/\*\//g, "*\\/").trimEnd());
+    if (text.length === 0)
+        return "";
+    if (text.length === 1)
+        return `${indent}/** ${text[0]} */\n`;
+    return `${indent}/**\n${text.map((l) => `${indent} *${l ? ` ${l}` : ""}`).join("\n")}\n${indent} */\n`;
+}
+const helperFor = (nullable, hasDefault) => nullable ? (hasDefault ? "NullableGenerated" : "Nullable") : hasDefault ? "Generated" : "Col";
+function columnNotes(c) {
+    const notes = [];
+    if (c.comment)
+        notes.push(c.comment);
+    if (c.domain)
+        notes.push(`Domain \`${c.domain}\`.`);
+    else if (c.declaredType === "citext")
+        notes.push("`citext`: typed as `text`.");
+    if (c.generated !== null)
+        notes.push(`\`GENERATED ALWAYS AS (${c.generated}) STORED\`: cannot be written.`);
+    if (c.identity === "always")
+        notes.push("`GENERATED ALWAYS AS IDENTITY`: written only with `OVERRIDING SYSTEM VALUE`.");
+    return notes;
+}
+/**
+ * TypeScript source declaring the typesql schema of an introspected database: `public`
+ * relations at the top level, other schemas nested (`DB["auth"]["sessions"]`), views and
+ * materialized views as `View<…>`, enums under `$types`.
+ */
+export function generateSource(db, options = {}) {
+    const typeName = options.typeName ?? "DB";
+    const comments = options.comments ?? true;
+    const columnTypes = options.columnTypes ?? {};
+    const used = new Set();
+    const usedKeys = new Set();
+    /** The TS type `columnTypes` gives a column, if any. */
+    const customType = (rel, col) => {
+        const qualified = `${rel.schema}.${rel.name}.${col.name}`;
+        const short = `${rel.name}.${col.name}`;
+        let ts;
+        if (typeof columnTypes === "function")
+            ts = columnTypes(col, rel);
+        else {
+            const k = qualified in columnTypes ? qualified : rel.schema === "public" && short in columnTypes ? short : undefined;
+            if (k !== undefined) {
+                usedKeys.add(k);
+                ts = columnTypes[k];
+            }
+        }
+        if (ts !== undefined && col.type !== "json" && col.type !== "jsonb") {
+            throw new Error(`columnTypes: ${JSON.stringify(rel.schema === "public" ? short : qualified)} has type ${col.type}; columnTypes only types json / jsonb columns (use the column hook for others)`);
+        }
+        return ts;
+    };
+    /** `Json<T>`, `Json<T, { nullable: true }>`, `Json<T, {}, "json">`, … */
+    const jsonDescriptor = (col, ts) => {
+        const flags = [...(col.nullable ? ["nullable: true"] : []), ...(col.hasDefault ? ["hasDefault: true"] : [])];
+        const flagSource = flags.length > 0 ? `{ ${flags.join("; ")} }` : "{}";
+        used.add("Json");
+        if (col.type === "json")
+            return `Json<${ts}, ${flagSource}, "json">`;
+        return flags.length > 0 ? `Json<${ts}, ${flagSource}>` : `Json<${ts}>`;
+    };
+    const relation = (rel, indent) => {
+        const isView = rel.kind === "view" || rel.kind === "materialized view";
+        const cols = rel.columns.map((c) => {
+            let descriptor = options.column?.(c, rel);
+            if (descriptor === undefined) {
+                const custom = customType(rel, c);
+                if (custom !== undefined)
+                    descriptor = jsonDescriptor(c, custom);
+                else {
+                    const helper = helperFor(c.nullable, c.hasDefault);
+                    used.add(helper);
+                    descriptor = `${helper}<${str(c.type)}>`;
+                }
+            }
+            return `${comments ? doc(columnNotes(c), `${indent}  `) : ""}${indent}  ${key(c.name)}: ${descriptor};`;
+        });
+        const body = `{\n${cols.join("\n")}\n${indent}}`;
+        if (!isView)
+            return body;
+        used.add("View");
+        return `View<${body}>`;
+    };
+    const relDoc = (rel, indent) => {
+        if (!comments)
+            return "";
+        const kind = rel.kind === "table" ? [] : [`${rel.kind[0].toUpperCase()}${rel.kind.slice(1)}.`];
+        return doc([...(rel.comment ? [rel.comment] : []), ...kind], indent);
+    };
+    const topLevel = new Set(db.relations.filter((r) => r.schema === "public").map((r) => r.name));
+    const lines = [];
+    const namespaces = new Map();
+    for (const rel of db.relations) {
+        if (rel.schema === "public")
+            lines.push(`${relDoc(rel, "  ")}  ${key(rel.name)}: ${relation(rel, "  ")};`);
+        else
+            namespaces.set(rel.schema, [...(namespaces.get(rel.schema) ?? []), rel]);
+    }
+    for (const [schema, rels] of namespaces) {
+        if (topLevel.has(schema)) {
+            throw new Error(`schema "${schema}" has the same name as the table "public.${schema}": typesql keeps public relations and schemas in one object`);
+        }
+        const body = rels.map((r) => `${relDoc(r, "    ")}    ${key(r.name)}: ${relation(r, "    ")};`);
+        lines.push(`  ${key(schema)}: {\n${body.join("\n")}\n  };`);
+    }
+    if (db.enums.length > 0) {
+        // typesql's enum registry is flat (`Col<"mood">`, schema qualifiers are dropped), so enums
+        // of the same name in different schemas share an entry.
+        const byName = new Map();
+        for (const e of db.enums) {
+            const entry = byName.get(e.name) ?? { values: new Set(), schemas: [] };
+            for (const v of e.values)
+                entry.values.add(v);
+            entry.schemas.push(e.schema);
+            byName.set(e.name, entry);
+        }
+        const entries = [...byName].map(([name, { values, schemas }]) => {
+            const notes = comments && schemas.length > 1 ? doc([`Enums of the same name in ${schemas.map((s) => `\`${s}\``).join(", ")}.`], "    ") : "";
+            return `${notes}    ${key(name)}: ${[...values].map(str).join(" | ") || "never"};`;
+        });
+        lines.push(`  $types: {\n${entries.join("\n")}\n  };`);
+    }
+    const helpers = ["Col", "Generated", "Json", "Nullable", "NullableGenerated", "View"].filter((h) => used.has(h));
+    const out = [
+        `// Generated by \`typesql introspect\` (@typesql/pg) from PostgreSQL ${db.version.split(/[.\s]/)[0]}. Do not edit.`,
+        ...(helpers.length > 0 ? [`import type { ${helpers.join(", ")} } from ${str(options.importFrom ?? "@typesql/core")};`] : []),
+        ...(options.imports ?? []),
+        "",
+        `export interface ${key(typeName)} {`,
+        ...lines,
+        "}",
+        "",
+    ];
+    const unknownKeys = typeof columnTypes === "function" ? [] : Object.keys(columnTypes).filter((k) => !usedKeys.has(k));
+    if (unknownKeys.length > 0 && options.column === undefined) {
+        throw new Error(`columnTypes: no column ${unknownKeys.map((k) => JSON.stringify(k)).join(", ")} (keys are "table.column" for public tables, else "schema.table.column")`);
+    }
+    return out.join("\n");
+}
+//# sourceMappingURL=emit.js.map

package/dist/introspect/emit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"emit.js","sourceRoot":"","sources":["../../src/introspect/emit.ts"],"names":[],"mappings":"AA2BA,MAAM,KAAK,GAAG,4BAA4B,CAAC;AAC3C,MAAM,GAAG,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;AACvF,MAAM,GAAG,GAAG,CAAC,CAAS,EAAU,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AAErD,SAAS,GAAG,CAAC,KAAwB,EAAE,MAAc;IACnD,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IAClG,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACjC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,GAAG,MAAM,OAAO,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC;IAC7D,OAAO,GAAG,MAAM,QAAQ,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,MAAM,OAAO,CAAC;AACzG,CAAC;AAGD,MAAM,SAAS,GAAG,CAAC,QAAiB,EAAE,UAAmB,EAAU,EAAE,CACnE,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC;AAEhG,SAAS,WAAW,CAAC,CAAqB;IACxC,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,CAAC,CAAC,OAAO;QAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;IACrC,IAAI,CAAC,CAAC,MAAM;QAAE,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;SAC/C,IAAI,CAAC,CAAC,YAAY,KAAK,QAAQ;QAAE,KAAK,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;IAC/E,IAAI,CAAC,CAAC,SAAS,KAAK,IAAI;QAAE,KAAK,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC,SAAS,gCAAgC,CAAC,CAAC;IAC5G,IAAI,CAAC,CAAC,QAAQ,KAAK,QAAQ;QAAE,KAAK,CAAC,IAAI,CAAC,8EAA8E,CAAC,CAAC;IACxH,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,EAAwB,EAAE,OAAO,GAAoB,EAAE;IACpF,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC;IAC1C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC;IAC1C,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,EAAE,CAAC;IAC9C,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;IAEnC,wDAAwD;IACxD,MAAM,UAAU,GAAG,CAAC,GAAyB,EAAE,GAAuB,EAAsB,EAAE;QAC5F,MAAM,SAAS,GAAG,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;QAC1D,MAAM,KAAK,GAAG,GAAG,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;QACxC,IAAI,EAAsB,CAAC;QAC3B,IAAI,OAAO,WAAW,KAAK,UAAU;YAAE,EAAE,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;aAC7D,CAAC;YACJ,MAAM,CAAC,GAAG,SAAS,IAAI,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,KAAK,QAAQ,IAAI,KAAK,IAAI,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACrH,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;gBACpB,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;gBAChB,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YACtB,CAAC;QACH,CAAC;QACD,IAAI,EAAE,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YACpE,MAAM,IAAI,KAAK,CAAC,gBAAgB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,aAAa,GAAG,CAAC,IAAI,gFAAgF,CAAC,CAAC;QACpM,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC;IAEF,yEAAyE;IACzE,MAAM,cAAc,GAAG,CAAC,GAAuB,EAAE,EAAU,EAAU,EAAE;QACrE,MAAM,KAAK,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC7G,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QACvE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACjB,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM;YAAE,OAAO,QAAQ,EAAE,KAAK,UAAU,WAAW,CAAC;QACrE,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,UAAU,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,GAAG,CAAC;IACzE,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,CAAC,GAAyB,EAAE,MAAc,EAAU,EAAE;QACrE,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,KAAK,MAAM,IAAI,GAAG,CAAC,IAAI,KAAK,mBAAmB,CAAC;QACvE,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACjC,IAAI,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;YAC1C,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC7B,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;gBAClC,IAAI,MAAM,KAAK,SAAS;oBAAE,UAAU,GAAG,cAAc,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;qBAC5D,CAAC;oBACJ,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC;oBACnD,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;oBACjB,UAAU,GAAG,GAAG,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;gBAC3C,CAAC;YACH,CAAC;YACD,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,UAAU,GAAG,CAAC;QAC1G,CAAC,CAAC,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,MAAM,GAAG,CAAC;QACjD,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QACzB,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACjB,OAAO,QAAQ,IAAI,GAAG,CAAC;IACzB,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,CAAC,GAAyB,EAAE,MAAc,EAAU,EAAE;QACnE,IAAI,CAAC,QAAQ;YAAE,OAAO,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAE,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAChG,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC,CAAC;IAEF,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/F,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,UAAU,GAAG,IAAI,GAAG,EAAkC,CAAC;IAC7D,KAAK,MAAM,GAAG,IAAI,EAAE,CAAC,SAAS,EAAE,CAAC;QAC/B,IAAI,GAAG,CAAC,MAAM,KAAK,QAAQ;YAAE,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;;YACtG,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAChF,CAAC;IACD,KAAK,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,UAAU,EAAE,CAAC;QACxC,IAAI,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,WAAW,MAAM,4CAA4C,MAAM,6DAA6D,CAAC,CAAC;QACpJ,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;QAChG,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,EAAE,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,2FAA2F;QAC3F,wDAAwD;QACxD,MAAM,MAAM,GAAG,IAAI,GAAG,EAAsD,CAAC;QAC7E,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC;YACzB,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAG,EAAU,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;YAC/E,KAAK,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM;gBAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC9C,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;YAC7B,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC5B,CAAC;QACD,MAAM,OAAO,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE;YAC9D,MAAM,KAAK,GAAG,QAAQ,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,6BAA6B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7I,OAAO,GAAG,KAAK,OAAO,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,OAAO,GAAG,CAAC;QACrF,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,IAAI,CAAC,gBAAgB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzD,CAAC;IAED,MAAM,OAAO,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACjH,MAAM,GAAG,GAAG;QACV,wEAAwE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,gBAAgB;QACpH,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,GAAG,CAAC,OAAO,CAAC,UAAU,IAAI,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5H,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;QAC1B,EAAE;QACF,oBAAoB,GAAG,CAAC,QAAQ,CAAC,IAAI;QACrC,GAAG,KAAK;QACR,GAAG;QACH,EAAE;KACH,CAAC;IACF,MAAM,WAAW,GAAG,OAAO,WAAW,KAAK,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACtH,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC3D,MAAM,IAAI,KAAK,CAAC,0BAA0B,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,0EAA0E,CAAC,CAAC;IAC5K,CAAC;IACD,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACxB,CAAC"}

package/dist/introspect/index.d.ts

@@ -0,0 +1,5 @@
+export { introspect, type IntrospectOptions, type IntrospectedDatabase, type IntrospectedRelation, type IntrospectedColumn, type IntrospectedEnum, type RelationKind, } from "./introspect.js";
+export { generateSource, type GenerateOptions } from "./emit.js";
+export { ViewNullability, parseNodeTree, type NullabilityOptions, type QueryFn } from "./nullability.js";
+export { main, type IntrospectConfig } from "./cli.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/introspect/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/introspect/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACvB,KAAK,gBAAgB,EACrB,KAAK,YAAY,GAClB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,cAAc,EAAE,KAAK,eAAe,EAAE,MAAM,WAAW,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,KAAK,kBAAkB,EAAE,KAAK,OAAO,EAAE,MAAM,kBAAkB,CAAC;AACzG,OAAO,EAAE,IAAI,EAAE,KAAK,gBAAgB,EAAE,MAAM,UAAU,CAAC"}

package/dist/introspect/index.js

@@ -0,0 +1,5 @@
+export { introspect, } from "./introspect.js";
+export { generateSource } from "./emit.js";
+export { ViewNullability, parseNodeTree } from "./nullability.js";
+export { main } from "./cli.js";
+//# sourceMappingURL=index.js.map

package/dist/introspect/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/introspect/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,GAOX,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,cAAc,EAAwB,MAAM,WAAW,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,aAAa,EAAyC,MAAM,kBAAkB,CAAC;AACzG,OAAO,EAAE,IAAI,EAAyB,MAAM,UAAU,CAAC"}

package/dist/introspect/introspect.d.ts

@@ -0,0 +1,67 @@
+import type { PgQueryable } from "../client.js";
+import { type NullabilityOptions } from "./nullability.js";
+export type RelationKind = "table" | "partitioned table" | "view" | "materialized view" | "foreign table";
+export interface IntrospectedColumn {
+    readonly name: string;
+    /**
+     * Canonical Postgres type name as typesql spells it: `int4`, `timestamptz`, `varchar`, an enum
+     * name, `${T}[]` for arrays. Domains are replaced by their base type; `citext` is `text`.
+     */
+    readonly type: string;
+    /** The column's type as Postgres prints it (`character varying(40)`, a domain name, ...). */
+    readonly declaredType: string;
+    /** The domain the column is declared with, if any (`public.positive`). */
+    readonly domain: string | null;
+    readonly nullable: boolean;
+    /** Optional on INSERT: a DEFAULT, serial, identity or generated column. Always false for views. */
+    readonly hasDefault: boolean;
+    /** `GENERATED ALWAYS AS IDENTITY` / `GENERATED BY DEFAULT AS IDENTITY`. */
+    readonly identity: "always" | "by default" | null;
+    /** The expression of a `GENERATED ALWAYS AS (…) STORED` column. */
+    readonly generated: string | null;
+    /** The DEFAULT expression. */
+    readonly default: string | null;
+    readonly comment: string | null;
+}
+export interface IntrospectedRelation {
+    readonly schema: string;
+    readonly name: string;
+    readonly kind: RelationKind;
+    readonly comment: string | null;
+    readonly columns: readonly IntrospectedColumn[];
+}
+export interface IntrospectedEnum {
+    readonly schema: string;
+    readonly name: string;
+    /** Labels in sort order. */
+    readonly values: readonly string[];
+}
+export interface IntrospectedDatabase {
+    /** `server_version`, e.g. `17.2`. */
+    readonly version: string;
+    /** Schemas that were read, in order. */
+    readonly schemas: readonly string[];
+    readonly relations: readonly IntrospectedRelation[];
+    /** Enums of the read schemas and enums their columns use. */
+    readonly enums: readonly IntrospectedEnum[];
+}
+export interface IntrospectOptions {
+    /** Schemas to read. Default: every schema except `pg_catalog`, `information_schema` and `pg_*`. */
+    readonly schemas?: readonly string[];
+    /**
+     * Relations to leave out: names (`kysely_migration`) or `schema.name`, with `*` matching any
+     * run of characters (`kysely_migration*`, `audit.*`).
+     */
+    readonly exclude?: readonly string[];
+    /**
+     * View columns to treat as NOT NULL when the analysis cannot prove it, called with the view's
+     * name and the column's name.
+     */
+    readonly viewNotNull?: NullabilityOptions["notNull"];
+}
+/**
+ * Read tables, views, materialized views, foreign tables and enums of a live database through
+ * any node-postgres-style client (`Client`, `Pool`, `PoolClient`).
+ */
+export declare function introspect(client: PgQueryable, options?: IntrospectOptions): Promise<IntrospectedDatabase>;
+//# sourceMappingURL=introspect.d.ts.map

package/dist/introspect/introspect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"introspect.d.ts","sourceRoot":"","sources":["../../src/introspect/introspect.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAmB,KAAK,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE5E,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,mBAAmB,GAAG,MAAM,GAAG,mBAAmB,GAAG,eAAe,CAAC;AAE1G,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,6FAA6F;IAC7F,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,0EAA0E;IAC1E,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,mGAAmG;IACnG,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,2EAA2E;IAC3E,QAAQ,CAAC,QAAQ,EAAE,QAAQ,GAAG,YAAY,GAAG,IAAI,CAAC;IAClD,mEAAmE;IACnE,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,8BAA8B;IAC9B,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE,SAAS,kBAAkB,EAAE,CAAC;CACjD;AAED,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,4BAA4B;IAC5B,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,oBAAoB;IACnC,qCAAqC;IACrC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,wCAAwC;IACxC,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC,QAAQ,CAAC,SAAS,EAAE,SAAS,oBAAoB,EAAE,CAAC;IACpD,6DAA6D;IAC7D,QAAQ,CAAC,KAAK,EAAE,SAAS,gBAAgB,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,iBAAiB;IAChC,mGAAmG;IACnG,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC;;;OAGG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC;CACtD;AAuDD;;;GAGG;AACH,wBAAsB,UAAU,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA+FpH"}

package/dist/introspect/introspect.js

@@ -0,0 +1,109 @@
+import { ViewNullability } from "./nullability.js";
+const globToRegExp = (glob) => new RegExp(`^${glob.split("*").map((part) => part.replace(/[.+?^${}()|[\]\\]/g, "\\$&")).join(".*")}$`);
+const KINDS = {
+    r: "table",
+    p: "partitioned table",
+    v: "view",
+    m: "materialized view",
+    f: "foreign table",
+};
+/** Postgres type names typesql spells differently. */
+const TYPE_ALIASES = { citext: "text" };
+function resolver(types) {
+    const resolve = (oid) => {
+        const t = types.get(oid);
+        if (!t)
+            return { type: "unknown", notnull: false, enumOid: null, domain: null };
+        if (t.typtype === "d") {
+            const base = resolve(t.basetype);
+            return { ...base, notnull: base.notnull || t.notnull, domain: `${t.schema}.${t.name}` };
+        }
+        const elem = t.elem !== "0" ? types.get(t.elem) : undefined;
+        if (elem && elem.array === t.oid) {
+            const inner = resolve(elem.oid);
+            return { type: inner.type.endsWith("[]") ? inner.type : `${inner.type}[]`, notnull: false, enumOid: inner.enumOid, domain: null };
+        }
+        return { type: TYPE_ALIASES[t.name] ?? t.name, notnull: false, enumOid: t.typtype === "e" ? t.oid : null, domain: null };
+    };
+    return resolve;
+}
+/** Default schema filter: everything but the system schemas. */
+const USER_SCHEMAS = `n.nspname NOT IN ('pg_catalog', 'information_schema') AND n.nspname NOT LIKE 'pg\\_%'`;
+/**
+ * Read tables, views, materialized views, foreign tables and enums of a live database through
+ * any node-postgres-style client (`Client`, `Pool`, `PoolClient`).
+ */
+export async function introspect(client, options = {}) {
+    const q = async (text, values) => (await client.query(text, values)).rows;
+    const [{ version }] = (await q(`SELECT current_setting('server_version') AS version`));
+    const schemaRows = options.schemas
+        ? await q(`SELECT n.nspname AS name FROM unnest($1::text[]) WITH ORDINALITY AS s(name, i)
+           JOIN pg_namespace n ON n.nspname = s.name ORDER BY s.i`, [[...options.schemas]])
+        : await q(`SELECT n.nspname AS name FROM pg_namespace n WHERE ${USER_SCHEMAS}
+          ORDER BY n.nspname <> 'public', n.nspname`);
+    const schemas = schemaRows.map((r) => r.name);
+    const missing = (options.schemas ?? []).filter((s) => !schemas.includes(s));
+    if (missing.length > 0)
+        throw new Error(`schema ${missing.map((s) => JSON.stringify(s)).join(", ")} does not exist`);
+    const types = new Map((await q(`SELECT t.oid::int8::text AS oid, t.typname AS name, n.nspname AS schema, t.typtype,
+              t.typbasetype::int8::text AS basetype, t.typelem::int8::text AS elem,
+              t.typarray::int8::text AS array, t.typnotnull AS notnull
+         FROM pg_type t JOIN pg_namespace n ON n.oid = t.typnamespace`)).map((t) => [t.oid, t]));
+    const resolve = resolver(types);
+    const excluded = (options.exclude ?? []).map(globToRegExp);
+    const relRows = (await q(`SELECT c.oid::int8::text AS oid, n.nspname AS schema, c.relname AS name, c.relkind,
+            obj_description(c.oid, 'pg_class') AS comment
+       FROM pg_class c JOIN pg_namespace n ON n.oid = c.relnamespace
+      WHERE c.relkind IN ('r', 'p', 'v', 'm', 'f') AND n.nspname = ANY($1::text[])
+      ORDER BY array_position($1::text[], n.nspname::text), c.relname`, [schemas])).filter((r) => !excluded.some((re) => re.test(r.name) || re.test(`${r.schema}.${r.name}`)));
+    const colRows = await q(`SELECT a.attrelid::int8::text AS relid, a.attname AS name, a.atttypid::int8::text AS typid,
+            format_type(a.atttypid, a.atttypmod) AS declared, a.attnotnull AS notnull,
+            a.attidentity AS identity, a.attgenerated AS generated,
+            pg_get_expr(d.adbin, d.adrelid) AS default, col_description(a.attrelid, a.attnum) AS comment
+       FROM pg_attribute a
+       LEFT JOIN pg_attrdef d ON d.adrelid = a.attrelid AND d.adnum = a.attnum
+      WHERE a.attrelid = ANY($1::oid[]) AND a.attnum > 0 AND NOT a.attisdropped
+      ORDER BY a.attrelid, a.attnum`, [relRows.map((r) => r.oid)]);
+    const colsByRel = new Map();
+    for (const c of colRows)
+        colsByRel.set(c.relid, [...(colsByRel.get(c.relid) ?? []), c]);
+    const views = new ViewNullability((text, values) => client.query(text, values), {
+        ...(options.viewNotNull && { notNull: options.viewNotNull }),
+    });
+    const usedEnums = new Set();
+    const relations = [];
+    for (const rel of relRows) {
+        const kind = KINDS[rel.relkind];
+        const isView = kind === "view" || kind === "materialized view";
+        const viewNotNull = isView ? await views.notNull(rel.oid) : [];
+        const columns = (colsByRel.get(rel.oid) ?? []).map((c, i) => {
+            const t = resolve(c.typid);
+            if (t.enumOid)
+                usedEnums.add(t.enumOid);
+            const generated = c.generated !== "" ? c.default : null;
+            const identity = c.identity === "a" ? "always" : c.identity === "d" ? "by default" : null;
+            return {
+                name: c.name,
+                type: t.type,
+                declaredType: c.declared,
+                domain: t.domain,
+                nullable: isView ? !viewNotNull[i] : !(c.notnull || t.notnull),
+                hasDefault: !isView && (c.default !== null || identity !== null || generated !== null),
+                identity,
+                generated,
+                default: generated === null ? c.default : null,
+                comment: c.comment,
+            };
+        });
+        relations.push({ schema: rel.schema, name: rel.name, kind, comment: rel.comment, columns });
+    }
+    const enumRows = await q(`SELECT t.oid::int8::text AS oid, n.nspname AS schema, t.typname AS name,
+            array_agg(e.enumlabel::text ORDER BY e.enumsortorder) AS values
+       FROM pg_type t JOIN pg_namespace n ON n.oid = t.typnamespace JOIN pg_enum e ON e.enumtypid = t.oid
+      WHERE n.nspname = ANY($1::text[]) OR t.oid = ANY($2::oid[])
+      GROUP BY t.oid, n.nspname, t.typname
+      ORDER BY t.typname, n.nspname`, [schemas, [...usedEnums]]);
+    const enums = enumRows.map(({ schema, name, values }) => ({ schema, name, values }));
+    return { version, schemas, relations, enums };
+}
+//# sourceMappingURL=introspect.js.map

package/dist/introspect/introspect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"introspect.js","sourceRoot":"","sources":["../../src/introspect/introspect.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAA2B,MAAM,kBAAkB,CAAC;AAmE5E,MAAM,YAAY,GAAG,CAAC,IAAY,EAAU,EAAE,CAC5C,IAAI,MAAM,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAE1G,MAAM,KAAK,GAA2C;IACpD,CAAC,EAAE,OAAO;IACV,CAAC,EAAE,mBAAmB;IACtB,CAAC,EAAE,MAAM;IACT,CAAC,EAAE,mBAAmB;IACtB,CAAC,EAAE,eAAe;CACnB,CAAC;AAEF,sDAAsD;AACtD,MAAM,YAAY,GAAqC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AAoB1E,SAAS,QAAQ,CAAC,KAAmC;IACnD,MAAM,OAAO,GAAG,CAAC,GAAW,EAAgB,EAAE;QAC5C,MAAM,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACzB,IAAI,CAAC,CAAC;YAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QAChF,IAAI,CAAC,CAAC,OAAO,KAAK,GAAG,EAAE,CAAC;YACtB,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;YACjC,OAAO,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QAC1F,CAAC;QACD,MAAM,IAAI,GAAG,CAAC,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC5D,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC;YACjC,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAChC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QACpI,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAC3H,CAAC,CAAC;IACF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,gEAAgE;AAChE,MAAM,YAAY,GAAG,uFAAuF,CAAC;AAE7G;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,MAAmB,EAAE,OAAO,GAAsB,EAAE;IACnF,MAAM,CAAC,GAAG,KAAK,EAAK,IAAY,EAAE,MAAkB,EAAgB,EAAE,CAAC,CAAC,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,IAAW,CAAC;IAEtH,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAsB,qDAAqD,CAAC,CAA0B,CAAC;IACrI,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO;QAChC,CAAC,CAAC,MAAM,CAAC,CACL;kEAC0D,EAC1D,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CACvB;QACH,CAAC,CAAC,MAAM,CAAC,CACL,sDAAsD,YAAY;oDACtB,CAC7C,CAAC;IACN,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC9C,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC5E,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,UAAU,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAErH,MAAM,KAAK,GAAG,IAAI,GAAG,CACnB,CAAC,MAAM,CAAC,CACN;;;sEAGgE,CACjE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAC1B,CAAC;IACF,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAEhC,MAAM,QAAQ,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC3D,MAAM,OAAO,GAAG,CAAC,MAAM,CAAC,CACtB;;;;sEAIkE,EAClE,CAAC,OAAO,CAAC,CACV,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IAC9F,MAAM,OAAO,GAAG,MAAM,CAAC,CAIrB;;;;;;;oCAOgC,EAChC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAC5B,CAAC;IACF,MAAM,SAAS,GAAG,IAAI,GAAG,EAA0B,CAAC;IACpD,KAAK,MAAM,CAAC,IAAI,OAAO;QAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAExF,MAAM,KAAK,GAAG,IAAI,eAAe,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE;QAC9E,GAAG,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC;KAC7D,CAAC,CAAC;IACH,MAAM,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;IACpC,MAAM,SAAS,GAA2B,EAAE,CAAC;IAC7C,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAE,CAAC;QACjC,MAAM,MAAM,GAAG,IAAI,KAAK,MAAM,IAAI,IAAI,KAAK,mBAAmB,CAAC;QAC/D,MAAM,WAAW,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/D,MAAM,OAAO,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAsB,EAAE;YAC9E,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,CAAC,OAAO;gBAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YACxC,MAAM,SAAS,GAAG,CAAC,CAAC,SAAS,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;YACxD,MAAM,QAAQ,GAAG,CAAC,CAAC,QAAQ,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC;YAC1F,OAAO;gBACL,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,YAAY,EAAE,CAAC,CAAC,QAAQ;gBACxB,MAAM,EAAE,CAAC,CAAC,MAAM;gBAChB,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC;gBAC9D,UAAU,EAAE,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,OAAO,KAAK,IAAI,IAAI,QAAQ,KAAK,IAAI,IAAI,SAAS,KAAK,IAAI,CAAC;gBACtF,QAAQ;gBACR,SAAS;gBACT,OAAO,EAAE,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;gBAC9C,OAAO,EAAE,CAAC,CAAC,OAAO;aACnB,CAAC;QACJ,CAAC,CAAC,CAAC;QACH,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,CAAC,CACtB;;;;;oCAKgC,EAChC,CAAC,OAAO,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAC1B,CAAC;IACF,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IACrF,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;AAChD,CAAC"}

package/dist/introspect/nullability.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Nullability of view columns, derived from the view's query tree.
+ *
+ * Postgres records no NOT NULL information for view (or materialized view) columns. Its rewrite
+ * rule (`pg_rewrite.ev_action`, the `_RETURN` rule) holds the parsed query, though, and from
+ * PostgreSQL 16 every column reference in it carries `varnullingrels`, the outer joins that can
+ * null it. A view column is NOT NULL here only when its expression provably cannot be NULL: a
+ * NOT NULL table column that no outer join nulls, a non-NULL constant, a cast or a strict
+ * operator over such values, a CASE whose every branch is NOT NULL, `count(*)`, ... Anything
+ * else (function calls outside a short list, scalar subqueries, set-returning function columns)
+ * is nullable. On PostgreSQL 15 and older every column reference counts as nullable.
+ *
+ * This module has no imports so that scripts/pg-catalog-from-pg.mjs can load it with Node's
+ * type stripping.
+ */
+/** Runs a query: node-postgres' `client.query(text, values)` fits. */
+export type QueryFn = (text: string, values?: unknown[]) => Promise<{
+    readonly rows: readonly any[];
+}>;
+export interface NullabilityOptions {
+    /**
+     * Columns known never to be NULL that the analysis cannot prove (typically columns of a
+     * set-returning function). Called with the view's name and the column's name.
+     */
+    readonly notNull?: (view: string, column: string) => boolean;
+}
+/** A node of a parsed `pg_node_tree`: `{ _: "VAR", varno: "1", … }`. */
+export interface Node {
+    readonly _: string;
+    readonly [field: string]: NodeValue;
+}
+export type NodeValue = Node | readonly NodeValue[] | string | null;
+/** Parse a node tree into plain values: nodes as objects, lists as arrays, `<>` as null. */
+export declare function parseNodeTree(text: string): NodeValue;
+/** Per-column NOT NULL of views and materialized views; caches what it reads. */
+export declare class ViewNullability {
+    private readonly query;
+    private readonly options;
+    private readonly views;
+    private readonly atts;
+    private procs;
+    private operators;
+    constructor(query: QueryFn, options?: NullabilityOptions);
+    /** NOT NULL flags of the view's columns, in column order. `relid` is the view's `pg_class.oid`. */
+    notNull(relid: string | number): Promise<boolean[]>;
+    private analyze;
+    private loadProcs;
+    private loadOperators;
+    /** A built-in operator that returns a value for non-NULL operands. */
+    private strictOperator;
+    private columns;
+    /** Is output column `attno` (1-based) of a (sub)query NOT NULL? */
+    private queryColumn;
+    private variable;
+    /** Column `attno` of a single set-returning function in FROM (`WITH ORDINALITY` adds a NOT NULL counter). */
+    private functionColumn;
+    private all;
+    private expr;
+}
+//# sourceMappingURL=nullability.d.ts.map

package/dist/introspect/nullability.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nullability.d.ts","sourceRoot":"","sources":["../../src/introspect/nullability.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,sEAAsE;AACtE,MAAM,MAAM,OAAO,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC;IAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,CAAA;CAAE,CAAC,CAAC;AAEvG,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC;CAC9D;AAED,wEAAwE;AACxE,MAAM,WAAW,IAAI;IACnB,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;CACrC;AACD,MAAM,MAAM,SAAS,GAAG,IAAI,GAAG,SAAS,SAAS,EAAE,GAAG,MAAM,GAAG,IAAI,CAAC;AA8BpE,4FAA4F;AAC5F,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CA2BrD;AAwDD,iFAAiF;AACjF,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAU;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;IAC7C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAyC;IAC/D,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAqC;IAC1D,OAAO,CAAC,KAAK,CAA2C;IACxD,OAAO,CAAC,SAAS,CAA2C;IAE5D,YAAY,KAAK,EAAE,OAAO,EAAE,OAAO,GAAE,kBAAuB,EAG3D;IAED,mGAAmG;IACnG,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAQlD;YAEa,OAAO;IAoBrB,OAAO,CAAC,SAAS;IAQjB,OAAO,CAAC,aAAa;IAQrB,sEAAsE;YACxD,cAAc;IAK5B,OAAO,CAAC,OAAO;IAsBf,mEAAmE;YACrD,WAAW;YAeX,QAAQ;IAgCtB,6GAA6G;YAC/F,cAAc;YAYd,GAAG;YAKH,IAAI;CAsDnB"}