@supabase/postgrest-typegen 0.5.0 → 0.6.0

package/README.md

@@ -89,8 +89,10 @@ A type reference carries `type_id`, `format` (the type's name, spelled like
 `PostgresColumn.format`) and `type_schema`, so a generator maps it with the
 same table it uses for columns. An overload's `error` is the message the
 TypeScript generator emits as the `Returns` type of an unresolvable overload:
-two overloads PostgREST cannot tell apart, or a computed field that returns no
-rows. Overloads are ordered by argument list, then by return type; the
+two overloads PostgREST cannot tell apart, or a sole unnamed row parameter,
+which PostgREST never matches under `/rpc` (such a function is a computed
+field or computed relationship, reached by embedding it from its relation).
+Overloads are ordered by argument list, then by return type; the
 TypeScript generator emits them in that order.
 
 `resolveRpcFunctions` is pure and deterministic, so a custom producer attaches
@@ -98,6 +100,38 @@ it the same way, and a document without the collection (produced before it
 existed) still generates: the TypeScript generator falls back to running the
 pass itself.
 
+### View column nullability
+
+PostgreSQL never marks view columns `NOT NULL`, so `introspect()` works out
+`is_nullable` for view and materialized view columns from the view's query
+tree. A column is not nullable when it is a plain reference to a `NOT NULL`
+column (directly, through another view, a subquery, a non-recursive CTE, a
+join alias or a `GROUP BY` key) and nothing on the way puts it on the nullable
+side of an outer join, in a set operation such as `UNION` or under
+`GROUPING SETS`/`ROLLUP`/`CUBE`. This works the same on every supported
+PostgreSQL version. Expressions stay nullable, even ones that cannot return
+null.
+
+For a column the catalog cannot prove non-null, such as `coalesce(x, 0)` or
+`count(*)`, add a line containing only `@notNull` to its comment:
+
+```sql
+comment on column my_view.total is '@notNull';
+```
+
+The directive is honored on view and materialized view columns only, and the
+comment is passed through unchanged.
+
+The inference describes the rows a query reads, so a few values can still be
+null where the type says otherwise:
+
+- Rows returned by a write through an `INSTEAD OF` trigger are the trigger's
+  `NEW`, so a column the trigger leaves unset comes back null.
+- PostgreSQL does not enforce `NOT NULL` inside composite values, so a column
+  whose type is a view's row type can hold a row with null fields.
+- A materialized view keeps the rows of its last refresh, including nulls from
+  before its source column became `NOT NULL`.
+
 ### Runtime validation (opt-in)
 
 `GeneratorMetadata` is backed by an [ArkType](https://arktype.io) schema, so a

package/dist/generation/typescript.js

@@ -29,7 +29,6 @@ const defaultFormat = async (code) => {
  */
 export const generateTypescript = async (metadata, opts = {}) => {
     const { schemas, tables, foreignTables, views, materializedViews, columns, relationships, types, } = metadata;
-    // Documents predating the collection (still valid version 1) resolve it here.
     const rpcFunctions = metadata.rpcFunctions ?? resolveRpcFunctions(metadata);
     const { detectOneToOneRelationships = false, postgrestVersion, defaultSchema = "public", format = defaultFormat, } = opts;
     const resolvedDefaultSchema = schemas.some(({ name }) => name === defaultSchema) || !schemas[0]
@@ -177,7 +176,10 @@ export const generateTypescript = async (metadata, opts = {}) => {
         // Without that metadata PostgREST still returns an array, so the collapse would make
         // the type diverge from the actual response.
         const collapsibleSingleRow = setof_options?.is_one_to_one === true;
-        return `${returnType}${overload.is_set_returning && !collapsibleSingleRow ? "[]" : ""}
+        const isArray = overload.error === null &&
+            overload.is_set_returning &&
+            !collapsibleSingleRow;
+        return `${returnType}${isArray ? "[]" : ""}
                           ${setofOptionsInfo}`;
     };
     const getFunctionReturnType = (schema, { returns }) => {

package/dist/introspection/index.js

@@ -11,7 +11,9 @@ import { PRIMARY_KEYS_SQL } from "./sql/primary_keys.sql.js";
 import { SCHEMAS_SQL } from "./sql/schemas.sql.js";
 import { TABLES_SQL } from "./sql/table.sql.js";
 import { TYPES_SQL } from "./sql/types.sql.js";
+import { VIEW_DEFINITIONS_SQL } from "./sql/view_definitions.sql.js";
 import { VIEWS_SQL } from "./sql/views.sql.js";
+import { applyViewColumnNullability } from "./view-nullability.js";
 /**
  * Introspect a database into the `GeneratorMetadata` contract.
  *
@@ -32,7 +34,7 @@ export async function introspect(db, opts = {}) {
     // introspection queries under Promise.all. A pooled Queryable runs them in
     // parallel; a single-connection one pipelines them, which is no worse than
     // awaiting each in turn.
-    const [schemas, tables, foreignTables, views, materializedViews, columns, primaryKeys, relationships, functions, types,] = await Promise.all([
+    const [schemas, tables, foreignTables, views, materializedViews, columns, primaryKeys, relationships, functions, types, viewDefinitions,] = await Promise.all([
         queryRows(SCHEMAS_SQL({ schemaFilter: systemExcludingFilter })),
         queryRows(TABLES_SQL({ schemaFilter: systemExcludingFilter })),
         queryRows(FOREIGN_TABLES_SQL({ schemaFilter: plainFilter })),
@@ -43,6 +45,7 @@ export async function introspect(db, opts = {}) {
         listRelationships(db, systemExcludingFilter),
         queryRows(FUNCTIONS_SQL({ schemaFilter: systemExcludingFilter })),
         queryRows(TYPES_SQL),
+        queryRows(VIEW_DEFINITIONS_SQL({ schemaFilter: systemExcludingFilter })),
     ]);
     const metadata = {
         version: GENERATOR_METADATA_VERSION,
@@ -51,7 +54,7 @@ export async function introspect(db, opts = {}) {
         foreignTables,
         views,
         materializedViews,
-        columns,
+        columns: applyViewColumnNullability(columns, viewDefinitions),
         primaryKeys,
         relationships,
         functions: functions.filter(({ return_type }) => !["trigger", "event_trigger"].includes(return_type)),

package/dist/introspection/node-tree.d.ts

@@ -0,0 +1,18 @@
+/**
+ * A value in the text form of a `pg_node_tree`: a scalar token, `null` for
+ * `<>`, a list, or a node. Integer, OID and bitmapset lists (`(i 1 2)`,
+ * `(o 23)`, `(b 3)`) lose their marker and become lists of scalar tokens.
+ */
+export type NodeTreeValue = string | null | NodeTreeValue[] | NodeTreeNode;
+export interface NodeTreeNode {
+    type: string;
+    fields: Record<string, NodeTreeValue>;
+}
+/**
+ * Parse the text form of a `pg_node_tree` (for example
+ * `pg_rewrite.ev_action::text`), following the tokenizer of PostgreSQL's
+ * `read.c`: tokens are separated by whitespace, `(`, `)`, `{` and `}` are
+ * tokens of their own, and a backslash escapes the next character.
+ */
+export declare function parseNodeTree(text: string): NodeTreeValue;
+export declare function isNode(value: NodeTreeValue | undefined, type?: string): value is NodeTreeNode;

package/dist/introspection/node-tree.js

@@ -0,0 +1,100 @@
+const LIST_MARKERS = new Set(["i", "o", "b", "x"]);
+const WHITESPACE = " \t\n";
+const PUNCTUATION = "(){}";
+/**
+ * Parse the text form of a `pg_node_tree` (for example
+ * `pg_rewrite.ev_action::text`), following the tokenizer of PostgreSQL's
+ * `read.c`: tokens are separated by whitespace, `(`, `)`, `{` and `}` are
+ * tokens of their own, and a backslash escapes the next character.
+ */
+export function parseNodeTree(text) {
+    const tokens = tokenize(text);
+    let position = 0;
+    const peek = () => tokens[position];
+    const next = () => {
+        const token = tokens[position++];
+        if (token === undefined) {
+            throw new Error("Unexpected end of pg_node_tree");
+        }
+        return token;
+    };
+    const isFieldEnd = (token) => token === undefined || token.raw === "}" || token.raw.startsWith(":");
+    const parseValue = () => {
+        const token = next();
+        if (token.raw === "{") {
+            const type = next().text;
+            const fields = {};
+            while (peek()?.raw !== "}") {
+                const name = next().raw.slice(1);
+                fields[name] = isFieldEnd(peek()) ? null : parseValue();
+                // Some fields span several tokens, such as a constant's
+                // `:constvalue 4 [ 1 0 0 0 ]`; only the first one is kept.
+                while (!isFieldEnd(peek())) {
+                    parseValue();
+                }
+            }
+            next();
+            return { type, fields };
+        }
+        if (token.raw === "(") {
+            const items = [];
+            const first = peek();
+            if (first !== undefined && LIST_MARKERS.has(first.raw)) {
+                next();
+            }
+            while (peek()?.raw !== ")") {
+                items.push(parseValue());
+            }
+            next();
+            return items;
+        }
+        if (token.raw === "<>") {
+            return null;
+        }
+        return token.text;
+    };
+    const value = parseValue();
+    if (position !== tokens.length) {
+        throw new Error("Trailing tokens after pg_node_tree");
+    }
+    return value;
+}
+function tokenize(text) {
+    const tokens = [];
+    let index = 0;
+    while (index < text.length) {
+        const character = text.charAt(index);
+        if (WHITESPACE.includes(character)) {
+            index++;
+            continue;
+        }
+        if (PUNCTUATION.includes(character)) {
+            tokens.push({ raw: character, text: character });
+            index++;
+            continue;
+        }
+        const start = index;
+        let unescaped = "";
+        while (index < text.length) {
+            const current = text.charAt(index);
+            if (current === "\\" && index + 1 < text.length) {
+                unescaped += text.charAt(index + 1);
+                index += 2;
+                continue;
+            }
+            if (WHITESPACE.includes(current) || PUNCTUATION.includes(current)) {
+                break;
+            }
+            unescaped += current;
+            index++;
+        }
+        tokens.push({ raw: text.slice(start, index), text: unescaped });
+    }
+    return tokens;
+}
+export function isNode(value, type) {
+    return (typeof value === "object" &&
+        value !== null &&
+        !Array.isArray(value) &&
+        (type === undefined || value.type === type));
+}

package/dist/introspection/sql/view_definitions.sql.d.ts

@@ -0,0 +1,8 @@
+import type { SchemaFilterProps } from "./common.ts";
+/**
+ * The query tree of every view and materialized view in the filtered schemas,
+ * plus every view they read from in any schema, with the `NOT NULL` columns
+ * each one references. `inferNonNullViewColumns` resolves view column
+ * nullability from it.
+ */
+export declare const VIEW_DEFINITIONS_SQL: (props: SchemaFilterProps) => string;

package/dist/introspection/sql/view_definitions.sql.js

@@ -0,0 +1,43 @@
+/**
+ * The query tree of every view and materialized view in the filtered schemas,
+ * plus every view they read from in any schema, with the `NOT NULL` columns
+ * each one references. `inferNonNullViewColumns` resolves view column
+ * nullability from it.
+ */
+export const VIEW_DEFINITIONS_SQL = (props) => /* SQL */ `
+WITH RECURSIVE view_closure(oid) AS (
+  SELECT c.oid
+  FROM pg_class c
+  JOIN pg_namespace n ON n.oid = c.relnamespace
+  WHERE
+    ${props.schemaFilter ? `n.nspname ${props.schemaFilter} AND` : ""}
+    c.relkind IN ('v', 'm')
+  UNION
+  SELECT dep.refobjid
+  FROM view_closure vc
+  JOIN pg_rewrite r ON r.ev_class = vc.oid AND r.rulename = '_RETURN'
+  JOIN pg_depend dep ON dep.classid = 'pg_rewrite' :: regclass
+    AND dep.objid = r.oid
+    AND dep.refclassid = 'pg_class' :: regclass
+  JOIN pg_class rc ON rc.oid = dep.refobjid AND rc.relkind IN ('v', 'm')
+)
+SELECT
+  r.ev_class :: int8 AS view_id,
+  r.ev_action :: text AS definition,
+  COALESCE(
+    (
+      SELECT json_agg(json_build_array(dep.refobjid :: int8, dep.refobjsubid))
+      FROM pg_depend dep
+      JOIN pg_attribute a ON a.attrelid = dep.refobjid AND a.attnum = dep.refobjsubid
+      JOIN pg_type t ON t.oid = a.atttypid
+      WHERE dep.classid = 'pg_rewrite' :: regclass
+        AND dep.objid = r.oid
+        AND dep.refclassid = 'pg_class' :: regclass
+        AND dep.refobjsubid > 0
+        AND (a.attnotnull OR t.typtype = 'd' AND t.typnotnull)
+    ),
+    '[]'
+  ) AS non_null_columns
+FROM view_closure vc
+JOIN pg_rewrite r ON r.ev_class = vc.oid AND r.rulename = '_RETURN'
+`;

package/dist/introspection/view-nullability.d.ts

@@ -0,0 +1,14 @@
+import type { PostgresColumn } from "../types.ts";
+/** A row of `VIEW_DEFINITIONS_SQL`. */
+export interface ViewDefinitionRow {
+    view_id: number | string;
+    definition: string;
+    non_null_columns: [number | string, number | string][];
+}
+/**
+ * Mark view and materialized view columns as not nullable when PostgreSQL can
+ * prove it from the view's query tree (see {@link inferNonNullViewColumns}) or
+ * when the column comment has an `@notNull` line. PostgreSQL never sets
+ * `attnotnull` on view columns, so without this every one of them is nullable.
+ */
+export declare function applyViewColumnNullability<T extends PostgresColumn>(columns: T[], rows: ViewDefinitionRow[]): T[];

package/dist/introspection/view-nullability.js

@@ -0,0 +1,167 @@
+import { isNode, parseNodeTree, } from "./node-tree.js";
+const RTE_RELATION = "0";
+const RTE_SUBQUERY = "1";
+const RTE_JOIN = "2";
+const RTE_CTE = "6";
+const RTE_GROUP = "9";
+const JOIN_INNER = "0";
+const JOIN_LEFT = "1";
+const JOIN_RIGHT = "3";
+const NOT_NULL_DIRECTIVE = /^\s*@notNull\s*$/m;
+/**
+ * Mark view and materialized view columns as not nullable when PostgreSQL can
+ * prove it from the view's query tree (see {@link inferNonNullViewColumns}) or
+ * when the column comment has an `@notNull` line. PostgreSQL never sets
+ * `attnotnull` on view columns, so without this every one of them is nullable.
+ */
+export function applyViewColumnNullability(columns, rows) {
+    const viewIds = new Set(rows.map((row) => String(row.view_id)));
+    const nonNull = inferNonNullViewColumns(rows);
+    return columns.map((column) => column.is_nullable &&
+        viewIds.has(String(column.table_id)) &&
+        (nonNull.has(column.id) || NOT_NULL_DIRECTIVE.test(column.comment ?? ""))
+        ? { ...column, is_nullable: false }
+        : column);
+}
+/**
+ * The ids (`<view oid>.<attnum>`) of the view columns that can never be null.
+ * A column qualifies when it is a plain reference to a `NOT NULL` column, or
+ * to a view column that qualifies, followed through joins, subqueries,
+ * non-recursive CTEs and `GROUP BY`, and nothing on the way puts it on the
+ * nullable side of an outer join, in a set operation or under grouping sets.
+ * The outer-join check walks the join tree instead of reading
+ * `varnullingrels`, which PostgreSQL 15 does not have.
+ */
+function inferNonNullViewColumns(rows) {
+    const definitions = new Map(rows.map((row) => [String(row.view_id), row.definition]));
+    const nonNullBaseColumns = new Set(rows.flatMap((row) => row.non_null_columns.map(([relation, attnum]) => `${relation}.${attnum}`)));
+    const resolved = new Map();
+    const nullableIndexesByQuery = new Map();
+    const nullableIndexesOf = (query) => {
+        let indexes = nullableIndexesByQuery.get(query);
+        if (indexes === undefined) {
+            indexes = nullableRangeTableIndexes(query);
+            nullableIndexesByQuery.set(query, indexes);
+        }
+        return indexes;
+    };
+    const nonNullColumnsOfView = (viewId) => {
+        const cached = resolved.get(viewId);
+        if (cached !== undefined) {
+            return cached;
+        }
+        const columns = new Set();
+        resolved.set(viewId, columns);
+        try {
+            const tree = parseNodeTree(definitions.get(viewId) ?? "");
+            const query = Array.isArray(tree) ? tree[0] : tree;
+            if (isNode(query, "QUERY") && allowsNonNull(query)) {
+                for (const entry of list(query.fields.targetList)) {
+                    if (isNode(entry, "TARGETENTRY") &&
+                        entry.fields.resjunk !== "true" &&
+                        isNonNullExpression(entry.fields.expr, [query])) {
+                        columns.add(Number(entry.fields.resno));
+                    }
+                }
+            }
+        }
+        catch {
+            columns.clear();
+        }
+        return columns;
+    };
+    const isNonNullColumn = (relation, attnum) => definitions.has(relation)
+        ? nonNullColumnsOfView(relation).has(attnum)
+        : nonNullBaseColumns.has(`${relation}.${attnum}`);
+    const isNonNullExpression = (expression, queries) => {
+        const query = queries.at(-1);
+        if (query === undefined ||
+            !isNode(expression, "VAR") ||
+            expression.fields.varlevelsup !== "0") {
+            return false;
+        }
+        const varno = Number(expression.fields.varno);
+        const attnum = Number(expression.fields.varattno);
+        if (attnum <= 0 || nullableIndexesOf(query).has(varno)) {
+            return false;
+        }
+        const entry = list(query.fields.rtable)[varno - 1];
+        if (!isNode(entry, "RANGETBLENTRY")) {
+            return false;
+        }
+        switch (entry.fields.rtekind) {
+            case RTE_RELATION:
+                return (typeof entry.fields.relid === "string" &&
+                    isNonNullColumn(entry.fields.relid, attnum));
+            case RTE_SUBQUERY:
+                return isNonNullOutput(entry.fields.subquery, attnum, queries);
+            case RTE_JOIN:
+                return isNonNullExpression(list(entry.fields.joinaliasvars)[attnum - 1], queries);
+            case RTE_GROUP:
+                return isNonNullExpression(list(entry.fields.groupexprs)[attnum - 1], queries);
+            case RTE_CTE: {
+                const levelsUp = Number(entry.fields.ctelevelsup);
+                const owner = queries.at(-1 - levelsUp);
+                const cte = list(owner?.fields.cteList).find((candidate) => isNode(candidate, "COMMONTABLEEXPR") &&
+                    candidate.fields.ctename === entry.fields.ctename);
+                return (isNode(cte) &&
+                    cte.fields.cterecursive !== "true" &&
+                    isNonNullOutput(cte.fields.ctequery, attnum, queries.slice(0, queries.length - levelsUp)));
+            }
+            default:
+                return false;
+        }
+    };
+    const isNonNullOutput = (subquery, resno, queries) => {
+        if (!isNode(subquery, "QUERY") || !allowsNonNull(subquery)) {
+            return false;
+        }
+        const entry = list(subquery.fields.targetList).find((candidate) => isNode(candidate, "TARGETENTRY") &&
+            Number(candidate.fields.resno) === resno);
+        return (isNode(entry) &&
+            isNonNullExpression(entry.fields.expr, [...queries, subquery]));
+    };
+    const result = new Set();
+    for (const viewId of definitions.keys()) {
+        for (const attnum of nonNullColumnsOfView(viewId)) {
+            result.add(`${viewId}.${attnum}`);
+        }
+    }
+    return result;
+}
+function allowsNonNull(query) {
+    return (query.fields.setOperations === null &&
+        list(query.fields.groupingSets).length === 0);
+}
+/**
+ * The range table indexes that sit on the nullable side of an outer join in
+ * the query's join tree, including the indexes of nested joins themselves.
+ */
+function nullableRangeTableIndexes(query) {
+    const nullable = new Set();
+    const visit = (node, isNullable) => {
+        if (isNode(node, "RANGETBLREF")) {
+            if (isNullable) {
+                nullable.add(Number(node.fields.rtindex));
+            }
+        }
+        else if (isNode(node, "FROMEXPR")) {
+            for (const item of list(node.fields.fromlist)) {
+                visit(item, isNullable);
+            }
+        }
+        else if (isNode(node, "JOINEXPR")) {
+            const joinType = node.fields.jointype;
+            if (isNullable) {
+                nullable.add(Number(node.fields.rtindex));
+            }
+            visit(node.fields.larg, isNullable || (joinType !== JOIN_INNER && joinType !== JOIN_LEFT));
+            visit(node.fields.rarg, isNullable || (joinType !== JOIN_INNER && joinType !== JOIN_RIGHT));
+        }
+    };
+    visit(query.fields.jointree, false);
+    return nullable;
+}
+function list(value) {
+    return Array.isArray(value) ? value : [];
+}

package/dist/rpc.js

@@ -18,18 +18,25 @@ import { compareStrings } from "./collation.js";
 /** json, jsonb and text: the types PostgREST accepts for a single unnamed parameter. */
 const UNNAMED_ARG_TYPE_IDS = new Set([114, 3802, 25]);
 const INPUT_ARG_MODES = new Set(["in", "inout", "variadic"]);
+/** A NUL separator cannot occur in an identifier, so names with dots never collide. */
+const qualifiedKey = (schema, name) => `${schema}\0${name}`;
 export function resolveRpcFunctions(metadata) {
     const schemaNames = new Set(metadata.schemas.map(({ name }) => name));
     const typesById = new Map(metadata.types.map((type) => [type.id, type]));
     const relationTypesById = new Map(metadata.types
         .filter((type) => type.type_relation_id !== null)
         .map((type) => [type.id, type]));
-    const relationsById = new Map([
+    const relations = [
         ...metadata.tables,
         ...metadata.foreignTables,
         ...metadata.views,
         ...metadata.materializedViews,
-    ].map((relation) => [relation.id, relation]));
+    ];
+    const relationsById = new Map(relations.map((relation) => [relation.id, relation]));
+    const relationsBySchemaName = new Map(relations.map((relation) => [
+        qualifiedKey(relation.schema, relation.name),
+        relation,
+    ]));
     const columnNamesByRelationId = new Map();
     for (const column of metadata.columns) {
         let names = columnNamesByRelationId.get(column.table_id);
@@ -66,11 +73,14 @@ export function resolveRpcFunctions(metadata) {
     // the rendered argument list may still name the relation.
     const computedFieldOf = ({ fn, inArgs }) => {
         const soleInArg = inArgs.length === 1 ? inArgs[0] : undefined;
-        const argType = soleInArg && relationTypesById.get(soleInArg.type_id);
+        if (!soleInArg)
+            return null;
+        const argType = relationTypesById.get(soleInArg.type_id);
         const relation = argType
             ? relationsById.get(argType.type_relation_id)
-            : [...relationsById.values()].find((relation) => relation.schema === fn.schema &&
-                relation.name === fn.argument_types);
+            : typesById.has(soleInArg.type_id)
+                ? undefined
+                : relationsBySchemaName.get(qualifiedKey(fn.schema, fn.argument_types));
         if (!relation || relation.schema !== fn.schema)
             return null;
         if (columnNamesByRelationId.get(relation.id)?.has(fn.name))
@@ -125,12 +135,13 @@ export function resolveRpcFunctions(metadata) {
                 }
             }
         }
-        // A sole unnamed row parameter makes the function a computed field, which
-        // PostgREST only exposes under `/rpc` when it also returns rows.
+        // PostgREST passes a sole unnamed parameter only when it is json, jsonb or
+        // text, so a function taking a row this way is a computed field or a
+        // computed relationship, reachable by embedding it from its relation and
+        // never through `/rpc`, whatever it returns.
         if (soleInArg &&
             soleInArg.name === "" &&
-            relationTypesById.has(soleInArg.type_id) &&
-            returnRelationName(fn) === null) {
+            relationTypesById.has(soleInArg.type_id)) {
             return `the function ${fn.schema}.${fn.name} with parameter or with a single unnamed json/jsonb parameter, but no matches were found in the schema cache`;
         }
         return null;
@@ -145,9 +156,7 @@ export function resolveRpcFunctions(metadata) {
                 mode: arg.mode,
                 ...typeReference(arg.type_id),
                 has_default: arg.has_default === true,
-                relation_id: relationId !== undefined &&
-                    relationId !== null &&
-                    relationsById.has(relationId)
+                relation_id: relationId !== undefined && relationsById.has(relationId)
                     ? relationId
                     : null,
             };
@@ -199,7 +208,7 @@ export function resolveRpcFunctions(metadata) {
         const candidate = { fn, inArgs };
         if (!isCallable(candidate))
             continue;
-        const key = `${fn.schema}.${fn.name}`;
+        const key = qualifiedKey(fn.schema, fn.name);
         let group = groups.get(key);
         if (!group) {
             group = [];

package/dist/types.js

@@ -179,8 +179,8 @@ const rpcFunctionReturnsSchema = rpcTypeReferenceSchema.merge({
      */
     relation_id: "number | null",
     /**
-     * The columns of a `RETURNS TABLE (…)` or `OUT` parameter result, in name
-     * order; `null` for every other return type.
+     * The columns of a `RETURNS TABLE (…)` result, in name order; `null` for
+     * every other return type, including a record built from `OUT` parameters.
      */
     columns: rpcTypeReferenceSchema.merge({ name: "string" }).array().or("null"),
 });
@@ -217,9 +217,10 @@ const rpcFunctionOverloadSchema = type({
     computed_field_of: "number | null",
     /**
      * Why PostgREST cannot resolve a call to this overload, when it cannot: the
-     * function conflicts with another overload, or it is a computed field that
-     * returns no rows. Generators surface the message instead of a callable
-     * signature.
+     * function conflicts with another overload, or its sole parameter is an
+     * unnamed row, which PostgREST never matches under `/rpc` (the function is
+     * a computed field or computed relationship, reached by embedding).
+     * Generators surface the message instead of a callable signature.
      */
     error: "string | null",
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supabase/postgrest-typegen",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Type generation for PostgREST from PostgreSQL schemas",
   "keywords": [
     "codegen",

package/src/generation/typescript.ts

@@ -121,7 +121,6 @@ export const generateTypescript = async (
     relationships,
     types,
   } = metadata;
-  // Documents predating the collection (still valid version 1) resolve it here.
   const rpcFunctions = metadata.rpcFunctions ?? resolveRpcFunctions(metadata);
   const {
     detectOneToOneRelationships = false,
@@ -334,7 +333,11 @@ export const generateTypescript = async (
     // Without that metadata PostgREST still returns an array, so the collapse would make
     // the type diverge from the actual response.
     const collapsibleSingleRow = setof_options?.is_one_to_one === true;
-    return `${returnType}${overload.is_set_returning && !collapsibleSingleRow ? "[]" : ""}
+    const isArray =
+      overload.error === null &&
+      overload.is_set_returning &&
+      !collapsibleSingleRow;
+    return `${returnType}${isArray ? "[]" : ""}
                           ${setofOptionsInfo}`;
   };
 

package/src/introspection/index.ts

@@ -14,7 +14,9 @@ import { PRIMARY_KEYS_SQL } from "./sql/primary_keys.sql.ts";
 import { SCHEMAS_SQL } from "./sql/schemas.sql.ts";
 import { TABLES_SQL } from "./sql/table.sql.ts";
 import { TYPES_SQL } from "./sql/types.sql.ts";
+import { VIEW_DEFINITIONS_SQL } from "./sql/view_definitions.sql.ts";
 import { VIEWS_SQL } from "./sql/views.sql.ts";
+import { applyViewColumnNullability } from "./view-nullability.ts";
 
 /**
  * Minimal structural database interface. `pg.Pool` / `pg.Client` satisfy it,
@@ -72,6 +74,7 @@ export async function introspect(
     relationships,
     functions,
     types,
+    viewDefinitions,
   ] = await Promise.all([
     queryRows(SCHEMAS_SQL({ schemaFilter: systemExcludingFilter })),
     queryRows(TABLES_SQL({ schemaFilter: systemExcludingFilter })),
@@ -83,6 +86,7 @@ export async function introspect(
     listRelationships(db, systemExcludingFilter),
     queryRows(FUNCTIONS_SQL({ schemaFilter: systemExcludingFilter })),
     queryRows(TYPES_SQL),
+    queryRows(VIEW_DEFINITIONS_SQL({ schemaFilter: systemExcludingFilter })),
   ]);
 
   const metadata = {
@@ -92,7 +96,7 @@ export async function introspect(
     foreignTables,
     views,
     materializedViews,
-    columns,
+    columns: applyViewColumnNullability(columns, viewDefinitions),
     primaryKeys,
     relationships,
     functions: functions.filter(

package/src/introspection/node-tree.ts

@@ -0,0 +1,129 @@
+/**
+ * A value in the text form of a `pg_node_tree`: a scalar token, `null` for
+ * `<>`, a list, or a node. Integer, OID and bitmapset lists (`(i 1 2)`,
+ * `(o 23)`, `(b 3)`) lose their marker and become lists of scalar tokens.
+ */
+export type NodeTreeValue = string | null | NodeTreeValue[] | NodeTreeNode;
+
+export interface NodeTreeNode {
+  type: string;
+  fields: Record<string, NodeTreeValue>;
+}
+
+interface Token {
+  raw: string;
+  text: string;
+}
+
+const LIST_MARKERS = new Set(["i", "o", "b", "x"]);
+const WHITESPACE = " \t\n";
+const PUNCTUATION = "(){}";
+
+/**
+ * Parse the text form of a `pg_node_tree` (for example
+ * `pg_rewrite.ev_action::text`), following the tokenizer of PostgreSQL's
+ * `read.c`: tokens are separated by whitespace, `(`, `)`, `{` and `}` are
+ * tokens of their own, and a backslash escapes the next character.
+ */
+export function parseNodeTree(text: string): NodeTreeValue {
+  const tokens = tokenize(text);
+  let position = 0;
+
+  const peek = (): Token | undefined => tokens[position];
+  const next = (): Token => {
+    const token = tokens[position++];
+    if (token === undefined) {
+      throw new Error("Unexpected end of pg_node_tree");
+    }
+    return token;
+  };
+  const isFieldEnd = (token: Token | undefined) =>
+    token === undefined || token.raw === "}" || token.raw.startsWith(":");
+
+  const parseValue = (): NodeTreeValue => {
+    const token = next();
+    if (token.raw === "{") {
+      const type = next().text;
+      const fields: Record<string, NodeTreeValue> = {};
+      while (peek()?.raw !== "}") {
+        const name = next().raw.slice(1);
+        fields[name] = isFieldEnd(peek()) ? null : parseValue();
+        // Some fields span several tokens, such as a constant's
+        // `:constvalue 4 [ 1 0 0 0 ]`; only the first one is kept.
+        while (!isFieldEnd(peek())) {
+          parseValue();
+        }
+      }
+      next();
+      return { type, fields };
+    }
+    if (token.raw === "(") {
+      const items: NodeTreeValue[] = [];
+      const first = peek();
+      if (first !== undefined && LIST_MARKERS.has(first.raw)) {
+        next();
+      }
+      while (peek()?.raw !== ")") {
+        items.push(parseValue());
+      }
+      next();
+      return items;
+    }
+    if (token.raw === "<>") {
+      return null;
+    }
+    return token.text;
+  };
+
+  const value = parseValue();
+  if (position !== tokens.length) {
+    throw new Error("Trailing tokens after pg_node_tree");
+  }
+  return value;
+}
+
+function tokenize(text: string): Token[] {
+  const tokens: Token[] = [];
+  let index = 0;
+  while (index < text.length) {
+    const character = text.charAt(index);
+    if (WHITESPACE.includes(character)) {
+      index++;
+      continue;
+    }
+    if (PUNCTUATION.includes(character)) {
+      tokens.push({ raw: character, text: character });
+      index++;
+      continue;
+    }
+    const start = index;
+    let unescaped = "";
+    while (index < text.length) {
+      const current = text.charAt(index);
+      if (current === "\\" && index + 1 < text.length) {
+        unescaped += text.charAt(index + 1);
+        index += 2;
+        continue;
+      }
+      if (WHITESPACE.includes(current) || PUNCTUATION.includes(current)) {
+        break;
+      }
+      unescaped += current;
+      index++;
+    }
+    tokens.push({ raw: text.slice(start, index), text: unescaped });
+  }
+  return tokens;
+}
+
+export function isNode(
+  value: NodeTreeValue | undefined,
+  type?: string,
+): value is NodeTreeNode {
+  return (
+    typeof value === "object" &&
+    value !== null &&
+    !Array.isArray(value) &&
+    (type === undefined || value.type === type)
+  );
+}

package/src/introspection/sql/view_definitions.sql.ts

@@ -0,0 +1,45 @@
+import type { SchemaFilterProps } from "./common.ts";
+
+/**
+ * The query tree of every view and materialized view in the filtered schemas,
+ * plus every view they read from in any schema, with the `NOT NULL` columns
+ * each one references. `inferNonNullViewColumns` resolves view column
+ * nullability from it.
+ */
+export const VIEW_DEFINITIONS_SQL = (props: SchemaFilterProps) => /* SQL */ `
+WITH RECURSIVE view_closure(oid) AS (
+  SELECT c.oid
+  FROM pg_class c
+  JOIN pg_namespace n ON n.oid = c.relnamespace
+  WHERE
+    ${props.schemaFilter ? `n.nspname ${props.schemaFilter} AND` : ""}
+    c.relkind IN ('v', 'm')
+  UNION
+  SELECT dep.refobjid
+  FROM view_closure vc
+  JOIN pg_rewrite r ON r.ev_class = vc.oid AND r.rulename = '_RETURN'
+  JOIN pg_depend dep ON dep.classid = 'pg_rewrite' :: regclass
+    AND dep.objid = r.oid
+    AND dep.refclassid = 'pg_class' :: regclass
+  JOIN pg_class rc ON rc.oid = dep.refobjid AND rc.relkind IN ('v', 'm')
+)
+SELECT
+  r.ev_class :: int8 AS view_id,
+  r.ev_action :: text AS definition,
+  COALESCE(
+    (
+      SELECT json_agg(json_build_array(dep.refobjid :: int8, dep.refobjsubid))
+      FROM pg_depend dep
+      JOIN pg_attribute a ON a.attrelid = dep.refobjid AND a.attnum = dep.refobjsubid
+      JOIN pg_type t ON t.oid = a.atttypid
+      WHERE dep.classid = 'pg_rewrite' :: regclass
+        AND dep.objid = r.oid
+        AND dep.refclassid = 'pg_class' :: regclass
+        AND dep.refobjsubid > 0
+        AND (a.attnotnull OR t.typtype = 'd' AND t.typnotnull)
+    ),
+    '[]'
+  ) AS non_null_columns
+FROM view_closure vc
+JOIN pg_rewrite r ON r.ev_class = vc.oid AND r.rulename = '_RETURN'
+`;

package/src/introspection/view-nullability.ts

@@ -0,0 +1,243 @@
+import type { PostgresColumn } from "../types.ts";
+import {
+  isNode,
+  type NodeTreeNode,
+  type NodeTreeValue,
+  parseNodeTree,
+} from "./node-tree.ts";
+
+/** A row of `VIEW_DEFINITIONS_SQL`. */
+export interface ViewDefinitionRow {
+  view_id: number | string;
+  definition: string;
+  non_null_columns: [number | string, number | string][];
+}
+
+const RTE_RELATION = "0";
+const RTE_SUBQUERY = "1";
+const RTE_JOIN = "2";
+const RTE_CTE = "6";
+const RTE_GROUP = "9";
+
+const JOIN_INNER = "0";
+const JOIN_LEFT = "1";
+const JOIN_RIGHT = "3";
+
+const NOT_NULL_DIRECTIVE = /^\s*@notNull\s*$/m;
+
+/**
+ * Mark view and materialized view columns as not nullable when PostgreSQL can
+ * prove it from the view's query tree (see {@link inferNonNullViewColumns}) or
+ * when the column comment has an `@notNull` line. PostgreSQL never sets
+ * `attnotnull` on view columns, so without this every one of them is nullable.
+ */
+export function applyViewColumnNullability<T extends PostgresColumn>(
+  columns: T[],
+  rows: ViewDefinitionRow[],
+): T[] {
+  const viewIds = new Set(rows.map((row) => String(row.view_id)));
+  const nonNull = inferNonNullViewColumns(rows);
+  return columns.map((column) =>
+    column.is_nullable &&
+    viewIds.has(String(column.table_id)) &&
+    (nonNull.has(column.id) || NOT_NULL_DIRECTIVE.test(column.comment ?? ""))
+      ? { ...column, is_nullable: false }
+      : column,
+  );
+}
+
+/**
+ * The ids (`<view oid>.<attnum>`) of the view columns that can never be null.
+ * A column qualifies when it is a plain reference to a `NOT NULL` column, or
+ * to a view column that qualifies, followed through joins, subqueries,
+ * non-recursive CTEs and `GROUP BY`, and nothing on the way puts it on the
+ * nullable side of an outer join, in a set operation or under grouping sets.
+ * The outer-join check walks the join tree instead of reading
+ * `varnullingrels`, which PostgreSQL 15 does not have.
+ */
+function inferNonNullViewColumns(rows: ViewDefinitionRow[]): Set<string> {
+  const definitions = new Map(
+    rows.map((row) => [String(row.view_id), row.definition]),
+  );
+  const nonNullBaseColumns = new Set(
+    rows.flatMap((row) =>
+      row.non_null_columns.map(([relation, attnum]) => `${relation}.${attnum}`),
+    ),
+  );
+  const resolved = new Map<string, Set<number>>();
+  const nullableIndexesByQuery = new Map<NodeTreeNode, Set<number>>();
+  const nullableIndexesOf = (query: NodeTreeNode): Set<number> => {
+    let indexes = nullableIndexesByQuery.get(query);
+    if (indexes === undefined) {
+      indexes = nullableRangeTableIndexes(query);
+      nullableIndexesByQuery.set(query, indexes);
+    }
+    return indexes;
+  };
+
+  const nonNullColumnsOfView = (viewId: string): Set<number> => {
+    const cached = resolved.get(viewId);
+    if (cached !== undefined) {
+      return cached;
+    }
+    const columns = new Set<number>();
+    resolved.set(viewId, columns);
+    try {
+      const tree = parseNodeTree(definitions.get(viewId) ?? "");
+      const query = Array.isArray(tree) ? tree[0] : tree;
+      if (isNode(query, "QUERY") && allowsNonNull(query)) {
+        for (const entry of list(query.fields.targetList)) {
+          if (
+            isNode(entry, "TARGETENTRY") &&
+            entry.fields.resjunk !== "true" &&
+            isNonNullExpression(entry.fields.expr, [query])
+          ) {
+            columns.add(Number(entry.fields.resno));
+          }
+        }
+      }
+    } catch {
+      columns.clear();
+    }
+    return columns;
+  };
+
+  const isNonNullColumn = (relation: string, attnum: number): boolean =>
+    definitions.has(relation)
+      ? nonNullColumnsOfView(relation).has(attnum)
+      : nonNullBaseColumns.has(`${relation}.${attnum}`);
+
+  const isNonNullExpression = (
+    expression: NodeTreeValue | undefined,
+    queries: NodeTreeNode[],
+  ): boolean => {
+    const query = queries.at(-1);
+    if (
+      query === undefined ||
+      !isNode(expression, "VAR") ||
+      expression.fields.varlevelsup !== "0"
+    ) {
+      return false;
+    }
+    const varno = Number(expression.fields.varno);
+    const attnum = Number(expression.fields.varattno);
+    if (attnum <= 0 || nullableIndexesOf(query).has(varno)) {
+      return false;
+    }
+    const entry = list(query.fields.rtable)[varno - 1];
+    if (!isNode(entry, "RANGETBLENTRY")) {
+      return false;
+    }
+    switch (entry.fields.rtekind) {
+      case RTE_RELATION:
+        return (
+          typeof entry.fields.relid === "string" &&
+          isNonNullColumn(entry.fields.relid, attnum)
+        );
+      case RTE_SUBQUERY:
+        return isNonNullOutput(entry.fields.subquery, attnum, queries);
+      case RTE_JOIN:
+        return isNonNullExpression(
+          list(entry.fields.joinaliasvars)[attnum - 1],
+          queries,
+        );
+      case RTE_GROUP:
+        return isNonNullExpression(
+          list(entry.fields.groupexprs)[attnum - 1],
+          queries,
+        );
+      case RTE_CTE: {
+        const levelsUp = Number(entry.fields.ctelevelsup);
+        const owner = queries.at(-1 - levelsUp);
+        const cte = list(owner?.fields.cteList).find(
+          (candidate) =>
+            isNode(candidate, "COMMONTABLEEXPR") &&
+            candidate.fields.ctename === entry.fields.ctename,
+        );
+        return (
+          isNode(cte) &&
+          cte.fields.cterecursive !== "true" &&
+          isNonNullOutput(
+            cte.fields.ctequery,
+            attnum,
+            queries.slice(0, queries.length - levelsUp),
+          )
+        );
+      }
+      default:
+        return false;
+    }
+  };
+
+  const isNonNullOutput = (
+    subquery: NodeTreeValue | undefined,
+    resno: number,
+    queries: NodeTreeNode[],
+  ): boolean => {
+    if (!isNode(subquery, "QUERY") || !allowsNonNull(subquery)) {
+      return false;
+    }
+    const entry = list(subquery.fields.targetList).find(
+      (candidate) =>
+        isNode(candidate, "TARGETENTRY") &&
+        Number(candidate.fields.resno) === resno,
+    );
+    return (
+      isNode(entry) &&
+      isNonNullExpression(entry.fields.expr, [...queries, subquery])
+    );
+  };
+
+  const result = new Set<string>();
+  for (const viewId of definitions.keys()) {
+    for (const attnum of nonNullColumnsOfView(viewId)) {
+      result.add(`${viewId}.${attnum}`);
+    }
+  }
+  return result;
+}
+
+function allowsNonNull(query: NodeTreeNode): boolean {
+  return (
+    query.fields.setOperations === null &&
+    list(query.fields.groupingSets).length === 0
+  );
+}
+
+/**
+ * The range table indexes that sit on the nullable side of an outer join in
+ * the query's join tree, including the indexes of nested joins themselves.
+ */
+function nullableRangeTableIndexes(query: NodeTreeNode): Set<number> {
+  const nullable = new Set<number>();
+  const visit = (node: NodeTreeValue | undefined, isNullable: boolean) => {
+    if (isNode(node, "RANGETBLREF")) {
+      if (isNullable) {
+        nullable.add(Number(node.fields.rtindex));
+      }
+    } else if (isNode(node, "FROMEXPR")) {
+      for (const item of list(node.fields.fromlist)) {
+        visit(item, isNullable);
+      }
+    } else if (isNode(node, "JOINEXPR")) {
+      const joinType = node.fields.jointype;
+      if (isNullable) {
+        nullable.add(Number(node.fields.rtindex));
+      }
+      visit(
+        node.fields.larg,
+        isNullable || (joinType !== JOIN_INNER && joinType !== JOIN_LEFT),
+      );
+      visit(
+        node.fields.rarg,
+        isNullable || (joinType !== JOIN_INNER && joinType !== JOIN_RIGHT),
+      );
+    }
+  };
+  visit(query.fields.jointree, false);
+  return nullable;
+}
+
+function list(value: NodeTreeValue | undefined): NodeTreeValue[] {
+  return Array.isArray(value) ? value : [];
+}

package/src/rpc.ts

@@ -35,6 +35,9 @@ type InputArg = PostgresFunction["args"][number] & {
 
 type Candidate = { fn: PostgresFunction; inArgs: InputArg[] };
 
+/** A NUL separator cannot occur in an identifier, so names with dots never collide. */
+const qualifiedKey = (schema: string, name: string) => `${schema}\0${name}`;
+
 export function resolveRpcFunctions(
   metadata: GeneratorMetadata,
 ): RpcFunction[] {
@@ -48,13 +51,20 @@ export function resolveRpcFunctions(
       )
       .map((type) => [type.id, type]),
   );
+  const relations = [
+    ...metadata.tables,
+    ...metadata.foreignTables,
+    ...metadata.views,
+    ...metadata.materializedViews,
+  ];
   const relationsById = new Map(
-    [
-      ...metadata.tables,
-      ...metadata.foreignTables,
-      ...metadata.views,
-      ...metadata.materializedViews,
-    ].map((relation) => [relation.id, relation]),
+    relations.map((relation) => [relation.id, relation]),
+  );
+  const relationsBySchemaName = new Map(
+    relations.map((relation) => [
+      qualifiedKey(relation.schema, relation.name),
+      relation,
+    ]),
   );
   const columnNamesByRelationId = new Map<number, Set<string>>();
   for (const column of metadata.columns) {
@@ -96,14 +106,13 @@ export function resolveRpcFunctions(
   // the rendered argument list may still name the relation.
   const computedFieldOf = ({ fn, inArgs }: Candidate): number | null => {
     const soleInArg = inArgs.length === 1 ? inArgs[0] : undefined;
-    const argType = soleInArg && relationTypesById.get(soleInArg.type_id);
+    if (!soleInArg) return null;
+    const argType = relationTypesById.get(soleInArg.type_id);
     const relation = argType
       ? relationsById.get(argType.type_relation_id)
-      : [...relationsById.values()].find(
-          (relation) =>
-            relation.schema === fn.schema &&
-            relation.name === fn.argument_types,
-        );
+      : typesById.has(soleInArg.type_id)
+        ? undefined
+        : relationsBySchemaName.get(qualifiedKey(fn.schema, fn.argument_types));
     if (!relation || relation.schema !== fn.schema) return null;
     if (columnNamesByRelationId.get(relation.id)?.has(fn.name)) return null;
     return relation.id;
@@ -178,13 +187,14 @@ export function resolveRpcFunctions(
         }
       }
     }
-    // A sole unnamed row parameter makes the function a computed field, which
-    // PostgREST only exposes under `/rpc` when it also returns rows.
+    // PostgREST passes a sole unnamed parameter only when it is json, jsonb or
+    // text, so a function taking a row this way is a computed field or a
+    // computed relationship, reachable by embedding it from its relation and
+    // never through `/rpc`, whatever it returns.
     if (
       soleInArg &&
       soleInArg.name === "" &&
-      relationTypesById.has(soleInArg.type_id) &&
-      returnRelationName(fn) === null
+      relationTypesById.has(soleInArg.type_id)
     ) {
       return `the function ${fn.schema}.${fn.name} with parameter or with a single unnamed json/jsonb parameter, but no matches were found in the schema cache`;
     }
@@ -205,9 +215,7 @@ export function resolveRpcFunctions(
           ...typeReference(arg.type_id),
           has_default: arg.has_default === true,
           relation_id:
-            relationId !== undefined &&
-            relationId !== null &&
-            relationsById.has(relationId)
+            relationId !== undefined && relationsById.has(relationId)
               ? relationId
               : null,
         };
@@ -266,7 +274,7 @@ export function resolveRpcFunctions(
     );
     const candidate = { fn, inArgs };
     if (!isCallable(candidate)) continue;
-    const key = `${fn.schema}.${fn.name}`;
+    const key = qualifiedKey(fn.schema, fn.name);
     let group = groups.get(key);
     if (!group) {
       group = [];

package/src/types.ts

@@ -205,8 +205,8 @@ const rpcFunctionReturnsSchema = rpcTypeReferenceSchema.merge({
    */
   relation_id: "number | null",
   /**
-   * The columns of a `RETURNS TABLE (…)` or `OUT` parameter result, in name
-   * order; `null` for every other return type.
+   * The columns of a `RETURNS TABLE (…)` result, in name order; `null` for
+   * every other return type, including a record built from `OUT` parameters.
    */
   columns: rpcTypeReferenceSchema.merge({ name: "string" }).array().or("null"),
 });
@@ -245,9 +245,10 @@ const rpcFunctionOverloadSchema = type({
   computed_field_of: "number | null",
   /**
    * Why PostgREST cannot resolve a call to this overload, when it cannot: the
-   * function conflicts with another overload, or it is a computed field that
-   * returns no rows. Generators surface the message instead of a callable
-   * signature.
+   * function conflicts with another overload, or its sole parameter is an
+   * unnamed row, which PostgREST never matches under `/rpc` (the function is
+   * a computed field or computed relationship, reached by embedding).
+   * Generators surface the message instead of a callable signature.
    */
   error: "string | null",
 });