@supabase/postgrest-typegen 0.2.0 → 0.2.2

package/src/introspection/sql/columns.sql.ts

@@ -1,14 +1,6 @@
-import { literal } from "pg-format";
-import type { SQLQueryPropsWithSchemaFilter } from "./common.ts";
+import type { SchemaFilterProps } from "./common.ts";
 
-export const COLUMNS_SQL = (
-  props: SQLQueryPropsWithSchemaFilter & {
-    tableIdFilter?: string;
-    tableIdentifierFilter?: string;
-    columnNameFilter?: string;
-    idsFilter?: string;
-  },
-) => /* SQL */ `
+export const COLUMNS_SQL = (props: SchemaFilterProps) => /* SQL */ `
 -- Adapted from information_schema.columns
 
 SELECT
@@ -45,14 +37,44 @@ SELECT
     WHEN 'd' THEN 'BY DEFAULT'
     ELSE NULL
   END AS identity_generation,
-  a.attgenerated IN ('s') AS is_generated,
+  -- 's' = stored, 'v' = virtual (PostgreSQL 18+); neither accepts writes.
+  a.attgenerated IN ('s', 'v') AS is_generated,
   NOT (
     a.attnotnull
     OR t.typtype = 'd' AND t.typnotnull
   ) AS is_nullable,
   (
     c.relkind IN ('r', 'p')
-    OR c.relkind IN ('v', 'f') AND pg_column_is_updatable(c.oid, a.attnum, FALSE)
+    -- Columns of views made writable by INSTEAD OF triggers or unconditional
+    -- INSTEAD rules can be written through PostgREST even though the view is
+    -- not auto-updatable, so they must not degrade to \`?: never\` in generated
+    -- Insert/Update types. pg_column_is_updatable cannot express this: it
+    -- requires the relation to support both UPDATE and DELETE, so a view with
+    -- only an INSTEAD OF INSERT or only an INSTEAD OF UPDATE trigger reports
+    -- every column as non-updatable regardless of include_triggers. Triggers
+    -- and rules rewrite whole rows, so their presence makes every column
+    -- writable (tgtype bits: 64 = INSTEAD, 4 = INSERT, 16 = UPDATE;
+    -- pg_rewrite ev_type: '2' = UPDATE, '3' = INSERT; ev_qual is '<>' for
+    -- unconditional rules, and only unconditional INSTEAD rules make a view
+    -- writable). Which events a view accepts is gated per view via
+    -- is_insert_enabled / is_update_enabled.
+    OR c.relkind IN ('v', 'f') AND (
+      pg_column_is_updatable(c.oid, a.attnum, FALSE)
+      OR EXISTS (
+        SELECT 1 FROM pg_trigger tg
+        WHERE tg.tgrelid = c.oid
+          AND tg.tgtype & 64 <> 0
+          AND tg.tgtype & 20 <> 0
+          AND NOT tg.tgisinternal
+      )
+      OR EXISTS (
+        SELECT 1 FROM pg_rewrite rw
+        WHERE rw.ev_class = c.oid
+          AND rw.is_instead
+          AND rw.ev_type IN ('2', '3')
+          AND rw.ev_qual :: text = '<>'
+      )
+    )
   ) AS is_updatable,
   uniques.table_id IS NOT NULL AS is_unique,
   check_constraints.definition AS "check",
@@ -110,10 +132,6 @@ FROM
   ) AS check_constraints ON check_constraints.table_id = c.oid AND check_constraints.ordinal_position = a.attnum
 WHERE
   ${props.schemaFilter ? `nc.nspname ${props.schemaFilter} AND` : ""}
-  ${props.idsFilter ? `(c.oid || '.' || a.attnum) ${props.idsFilter} AND` : ""}
-  ${props.columnNameFilter ? `(c.relname || '.' || a.attname) ${props.columnNameFilter} AND` : ""}
-  ${props.tableIdFilter ? `c.oid ${props.tableIdFilter} AND` : ""}
-  ${props.tableIdentifierFilter ? `nc.nspname || '.' || c.relname ${props.tableIdentifierFilter} AND` : ""}
   NOT pg_is_other_temp_schema(nc.oid)
   AND a.attnum > 0
   AND NOT a.attisdropped
@@ -126,6 +144,4 @@ WHERE
       'SELECT, INSERT, UPDATE, REFERENCES'
     )
   )
-${props.limit ? `limit ${literal(props.limit)}` : ""}
-${props.offset ? `offset ${literal(props.offset)}` : ""}
 `;

package/src/introspection/sql/common.ts

@@ -1,18 +1,8 @@
-/**
- * Shared prop shapes for the SQL builders, ported from
- * `postgres-meta/src/lib/sql/common.ts`. Only the variants used by the
- * typegen introspection path are kept.
- */
-export type SQLQueryProps = {
-  limit?: number;
-  offset?: number;
-};
-
-export type SQLQueryPropsWithSchemaFilter = SQLQueryProps & {
-  schemaFilter?: string;
-};
-
-export type SQLQueryPropsWithSchemaFilterAndIdsFilter = SQLQueryProps & {
-  schemaFilter?: string;
-  idsFilter?: string;
+/** The only option the introspection passes to its SQL builders. */
+export type SchemaFilterProps = {
+  /**
+   * An `IN (…)` or `NOT IN (…)` fragment from `filterByList`, or the empty
+   * string for no filter.
+   */
+  schemaFilter: string;
 };

package/src/introspection/sql/foreign_tables.sql.ts

@@ -1,13 +1,6 @@
-import { literal } from "pg-format";
-import type { SQLQueryProps } from "./common.ts";
+import type { SchemaFilterProps } from "./common.ts";
 
-export const FOREIGN_TABLES_SQL = (
-  props: SQLQueryProps & {
-    schemaFilter?: string;
-    idsFilter?: string;
-    tableIdentifierFilter?: string;
-  },
-) => /* SQL */ `
+export const FOREIGN_TABLES_SQL = (props: SchemaFilterProps) => /* SQL */ `
 SELECT
   c.oid :: int8 AS id,
   n.nspname AS schema,
@@ -18,9 +11,5 @@ FROM
   JOIN pg_namespace n ON n.oid = c.relnamespace
 WHERE
   ${props.schemaFilter ? `n.nspname ${props.schemaFilter} AND` : ""}
-  ${props.idsFilter ? `c.oid ${props.idsFilter} AND` : ""}
-  ${props.tableIdentifierFilter ? `(n.nspname || '.' || c.relname) ${props.tableIdentifierFilter} AND` : ""}
   c.relkind = 'f'
-${props.limit ? `limit ${literal(props.limit)}` : ""}
-${props.offset ? `offset ${literal(props.offset)}` : ""}
 `;

package/src/introspection/sql/functions.sql.ts

@@ -1,15 +1,6 @@
-// oxlint-disable typescript/restrict-template-expressions -- verbatim port of postgres-meta's
-// builder, which interpolates the `args` string[] into the SQL (relying on Array#toString). The
-// expression sits inside a template literal where a targeted disable comment would corrupt the SQL.
-import { literal } from "pg-format";
-import type { SQLQueryPropsWithSchemaFilterAndIdsFilter } from "./common.ts";
+import type { SchemaFilterProps } from "./common.ts";
 
-export const FUNCTIONS_SQL = (
-  props: SQLQueryPropsWithSchemaFilterAndIdsFilter & {
-    nameFilter?: string;
-    args?: string[];
-  },
-) => /* SQL */ `
+export const FUNCTIONS_SQL = (props: SchemaFilterProps) => /* SQL */ `
 -- CTE with sane arg_modes, arg_names, and arg_types.
 -- All three are always of the same length.
 -- All three include all args, including OUT and TABLE args.
@@ -36,37 +27,6 @@ with functions as (
     ${props.schemaFilter ? `join pg_namespace n on p.pronamespace = n.oid` : ""}
   where
     ${props.schemaFilter ? `n.nspname ${props.schemaFilter} AND` : ""}
-    ${props.idsFilter ? `p.oid ${props.idsFilter} AND` : ""}
-    ${props.nameFilter ? `p.proname ${props.nameFilter} AND` : ""}
-    ${
-      props.args === undefined
-        ? ""
-        : props.args.length > 0
-          ? `p.proargtypes::text = ${
-              props.args.length
-                ? `(
-          SELECT STRING_AGG(type_oid::text, ' ') FROM (
-            SELECT (
-              split_args.arr[
-                array_length(
-                  split_args.arr,
-                  1
-                )
-              ]::regtype::oid
-            ) AS type_oid FROM (
-              SELECT STRING_TO_ARRAY(
-                UNNEST(
-                  ARRAY[${props.args}]
-                ),
-                ' '
-              ) AS arr
-            ) AS split_args
-          ) args
-    )`
-                : "''"
-            } AND`
-          : ""
-    }
     p.prokind = 'f'
 )
 select
@@ -154,6 +114,4 @@ from
     group by
       t1.oid
   ) f_args on f_args.oid = f.oid
-${props.limit ? `limit ${literal(props.limit)}` : ""}
-${props.offset ? `offset ${literal(props.offset)}` : ""}
 `;

package/src/introspection/sql/helpers.ts

@@ -1,4 +1,4 @@
-import { literal } from "pg-format";
+import { literal } from "./pg-format.ts";
 
 /**
  * Schemas that postgres-meta excludes by default when `includeSystemSchemas`
@@ -13,7 +13,7 @@ export const DEFAULT_SYSTEM_SCHEMAS = [
 /**
  * Build a SQL `IN (...)` / `NOT IN (...)` fragment for an include/exclude list,
  * ported verbatim from `postgres-meta/src/lib/helpers.ts`. Values are escaped
- * with pg-format's `literal`. Returns an empty string when there is nothing to
+ * with the inlined pg-format `literal`. Returns an empty string when there is nothing to
  * filter, so callers interpolate it conditionally.
  */
 export const filterByList = (

package/src/introspection/sql/materialized_views.sql.ts

@@ -1,11 +1,6 @@
-import { literal } from "pg-format";
-import type { SQLQueryPropsWithSchemaFilterAndIdsFilter } from "./common.ts";
+import type { SchemaFilterProps } from "./common.ts";
 
-export const MATERIALIZED_VIEWS_SQL = (
-  props: SQLQueryPropsWithSchemaFilterAndIdsFilter & {
-    materializedViewIdentifierFilter?: string;
-  },
-) => /* SQL */ `
+export const MATERIALIZED_VIEWS_SQL = (props: SchemaFilterProps) => /* SQL */ `
 select
   c.oid::int8 as id,
   n.nspname as schema,
@@ -17,9 +12,5 @@ from
   join pg_namespace n on n.oid = c.relnamespace
 where
   ${props.schemaFilter ? `n.nspname ${props.schemaFilter} AND` : ""}
-  ${props.idsFilter ? `c.oid ${props.idsFilter} AND` : ""}
-  ${props.materializedViewIdentifierFilter ? `(n.nspname || '.' || c.relname) ${props.materializedViewIdentifierFilter} AND` : ""}
   c.relkind = 'm'
-${props.limit ? `limit ${literal(props.limit)}` : ""}
-${props.offset ? `offset ${literal(props.offset)}` : ""}
 `;

package/src/introspection/sql/pg-format.ts

@@ -0,0 +1,101 @@
+/**
+ * Minimal inline port of the `pg-format` helpers this package uses, so the
+ * package carries no runtime dependency for them (the CommonJS-only
+ * `pg-format` package is awkward to consume from ESM/bundled CLIs).
+ *
+ * Mirrors `pg-format@1.0.4` byte-for-byte for the inputs postgres-meta feeds
+ * it — in particular numbers are quoted (`literal(10)` is `'10'`), because
+ * that is what postgres-meta's SQL emits and this package is byte-parity
+ * constrained against it. The `supabase/supabase` `packages/pg-meta` port
+ * deliberately diverges here (unquoted numbers); do not "fix" this to match it.
+ *
+ * Originally ported from PostgreSQL's `src/interfaces/libpq/fe-exec.c`.
+ */
+
+/** Convert a JS ISO string to Postgres' default ISO 8601 form. */
+function formatDate(date: string): string {
+  return date.replace("T", " ").replace("Z", "+00");
+}
+
+function arrayToList(
+  useSpace: boolean,
+  array: unknown[],
+  formatter: (value: unknown) => string,
+): string {
+  let sql = useSpace ? " (" : "(";
+  for (const [index, element] of array.entries()) {
+    sql += (index === 0 ? "" : ", ") + formatter(element);
+  }
+  sql += ")";
+  return sql;
+}
+
+/**
+ * Quote a value as a SQL literal. `null`/`undefined` become `NULL`, booleans
+ * `'t'`/`'f'`, dates ISO 8601 strings, arrays comma-separated lists (nested
+ * arrays become parenthesised groups), plain objects `'…'::jsonb`, and
+ * everything else — including numbers — a single-quoted string with embedded
+ * quotes doubled. Strings containing a backslash use the `E'…'` form.
+ */
+export function literal(value?: unknown): string {
+  let text: string;
+  let explicitCast: string | undefined;
+
+  if (value === undefined || value === null) {
+    return "NULL";
+  }
+  if (value === false) {
+    return "'f'";
+  }
+  if (value === true) {
+    return "'t'";
+  }
+  if (value instanceof Date) {
+    return `'${formatDate(value.toISOString())}'`;
+  }
+  if (Array.isArray(value)) {
+    const parts: string[] = [];
+    for (const [index, element] of value.entries()) {
+      if (Array.isArray(element)) {
+        parts.push(arrayToList(index !== 0, element, literal));
+      } else {
+        parts.push(literal(element));
+      }
+    }
+    return parts.toString();
+  }
+  if (typeof value === "string") {
+    text = value;
+  } else if (typeof value === "number" || typeof value === "bigint") {
+    text = value.toString();
+  } else {
+    explicitCast = "jsonb";
+    text = JSON.stringify(value);
+  }
+
+  let hasBackslash = false;
+  let quoted = "'";
+
+  for (const c of text) {
+    if (c === "'") {
+      quoted += c + c;
+    } else if (c === "\\") {
+      quoted += c + c;
+      hasBackslash = true;
+    } else {
+      quoted += c;
+    }
+  }
+
+  quoted += "'";
+
+  if (hasBackslash) {
+    quoted = `E${quoted}`;
+  }
+
+  if (explicitCast) {
+    quoted += `::${explicitCast}`;
+  }
+
+  return quoted;
+}

package/src/introspection/sql/primary_keys.sql.ts

@@ -1,11 +1,6 @@
-import { literal } from "pg-format";
-import type { SQLQueryPropsWithSchemaFilter } from "./common.ts";
+import type { SchemaFilterProps } from "./common.ts";
 
-export const PRIMARY_KEYS_SQL = (
-  props: SQLQueryPropsWithSchemaFilter & {
-    tableIdentifierFilter?: string;
-  },
-) => /* SQL */ `
+export const PRIMARY_KEYS_SQL = (props: SchemaFilterProps) => /* SQL */ `
 SELECT
   c.oid :: int8 AS table_id,
   n.nspname AS schema,
@@ -18,7 +13,6 @@ FROM
   JOIN pg_attribute a ON a.attrelid = c.oid AND a.attnum = ANY(i.indkey)
 WHERE
   ${props.schemaFilter ? `n.nspname ${props.schemaFilter} AND` : ""}
-  ${props.tableIdentifierFilter ? `n.nspname || '.' || c.relname ${props.tableIdentifierFilter} AND` : ""}
   i.indisprimary
   AND c.relkind IN ('r', 'p')
   AND NOT pg_is_other_temp_schema(n.oid)
@@ -33,6 +27,4 @@ WHERE
 ORDER BY
   c.oid,
   array_position(i.indkey, a.attnum)
-${props.limit ? `limit ${literal(props.limit)}` : ""}
-${props.offset ? `offset ${literal(props.offset)}` : ""}
 `;

package/src/introspection/sql/schemas.sql.ts

@@ -1,13 +1,6 @@
-import { literal } from "pg-format";
-import type { SQLQueryProps } from "./common.ts";
+import type { SchemaFilterProps } from "./common.ts";
 
-export const SCHEMAS_SQL = (
-  props: SQLQueryProps & {
-    nameFilter?: string;
-    idsFilter?: string;
-    includeSystemSchemas?: boolean;
-  },
-) => /* SQL */ `
+export const SCHEMAS_SQL = (props: SchemaFilterProps) => /* SQL */ `
 -- Adapted from information_schema.schemata
 select
   n.oid::int8 as id,
@@ -18,15 +11,12 @@ from
   pg_roles u
 where
   n.nspowner = u.oid
-  ${props.idsFilter ? `and n.oid ${props.idsFilter}` : ""}
-  ${props.nameFilter ? `and n.nspname ${props.nameFilter}` : ""}
-  ${!props.includeSystemSchemas ? `and not pg_catalog.starts_with(n.nspname, 'pg_')` : ""}
+  ${props.schemaFilter ? `and n.nspname ${props.schemaFilter}` : ""}
+  and not pg_catalog.starts_with(n.nspname, 'pg_')
   and (
     pg_has_role(n.nspowner, 'USAGE')
     or has_schema_privilege(n.oid, 'CREATE, USAGE')
   )
   and not pg_catalog.starts_with(n.nspname, 'pg_temp_')
   and not pg_catalog.starts_with(n.nspname, 'pg_toast_temp_')
-${props.limit ? `limit ${literal(props.limit)}` : ""}
-${props.offset ? `offset ${literal(props.offset)}` : ""}
 `;

package/src/introspection/sql/table.sql.ts

@@ -1,11 +1,6 @@
-import { literal } from "pg-format";
-import type { SQLQueryPropsWithSchemaFilterAndIdsFilter } from "./common.ts";
+import type { SchemaFilterProps } from "./common.ts";
 
-export const TABLES_SQL = (
-  props: SQLQueryPropsWithSchemaFilterAndIdsFilter & {
-    tableIdentifierFilter?: string;
-  },
-) => /* SQL */ `
+export const TABLES_SQL = (props: SchemaFilterProps) => /* SQL */ `
 SELECT
   c.oid :: int8 AS id,
   nc.nspname AS schema,
@@ -30,8 +25,6 @@ FROM
   JOIN pg_class c ON nc.oid = c.relnamespace
 WHERE
   ${props.schemaFilter ? `nc.nspname ${props.schemaFilter} AND` : ""}
-  ${props.idsFilter ? `c.oid ${props.idsFilter} AND` : ""}
-  ${props.tableIdentifierFilter ? `nc.nspname || '.' || c.relname ${props.tableIdentifierFilter} AND` : ""}
   c.relkind IN ('r', 'p')
   AND NOT pg_is_other_temp_schema(nc.oid)
   AND (
@@ -42,6 +35,4 @@ WHERE
     )
     OR has_any_column_privilege(c.oid, 'SELECT, INSERT, UPDATE, REFERENCES')
   )
-${props.limit ? `limit ${literal(props.limit)}` : ""}
-${props.offset ? `offset ${literal(props.offset)}` : ""}
 `;

package/src/introspection/sql/table_relationships.sql.ts

@@ -1,8 +1,6 @@
-import type { SQLQueryPropsWithSchemaFilter } from "./common.ts";
+import type { SchemaFilterProps } from "./common.ts";
 
-export const TABLE_RELATIONSHIPS_SQL = (
-  props: SQLQueryPropsWithSchemaFilter,
-) => /* SQL */ `
+export const TABLE_RELATIONSHIPS_SQL = (props: SchemaFilterProps) => /* SQL */ `
 -- Adapted from
 -- https://github.com/PostgREST/postgrest/blob/f9f0f79fa914ac00c11fbf7f4c558e14821e67e2/src/PostgREST/SchemaCache.hs#L722
 WITH

package/src/introspection/sql/types.sql.ts

@@ -1,12 +1,8 @@
-import { literal } from "pg-format";
-import type { SQLQueryPropsWithSchemaFilterAndIdsFilter } from "./common.ts";
-
-export const TYPES_SQL = (
-  props: SQLQueryPropsWithSchemaFilterAndIdsFilter & {
-    includeTableTypes?: boolean;
-    includeArrayTypes?: boolean;
-  },
-) => /* SQL */ `
+/**
+ * Every type of every schema, including the row types of tables and views
+ * and the array types, since a column of any schema may use them.
+ */
+export const TYPES_SQL = /* SQL */ `
 select
   t.oid::int8 as id,
   t.typname as name,
@@ -48,27 +44,11 @@ from
         t.typrelid = 0
         or (
           select
-            c.relkind ${props.includeTableTypes ? `in ('c', 'r', 'v', 'm', 'p')` : `= 'c'`}
+            c.relkind in ('c', 'r', 'v', 'm', 'p', 'f')
           from
             pg_class c
           where
             c.oid = t.typrelid
         )
       )
-      ${
-        !props.includeArrayTypes
-          ? `and not exists (
-                 select
-                 from
-                   pg_type el
-                 where
-                   el.oid = t.typelem
-                   and el.typarray = t.oid
-               )`
-          : ""
-      }
-      ${props.schemaFilter ? `and n.nspname ${props.schemaFilter}` : ""}
-      ${props.idsFilter ? `and t.oid ${props.idsFilter}` : ""}
-${props.limit ? `limit ${literal(props.limit)}` : ""}
-${props.offset ? `offset ${literal(props.offset)}` : ""}
 `;

package/src/introspection/sql/views.sql.ts

@@ -1,26 +1,23 @@
-import { literal } from "pg-format";
-import type { SQLQueryPropsWithSchemaFilterAndIdsFilter } from "./common.ts";
+import type { SchemaFilterProps } from "./common.ts";
 
-export const VIEWS_SQL = (
-  props: SQLQueryPropsWithSchemaFilterAndIdsFilter & {
-    viewIdentifierFilter?: string;
-  },
-) => /* SQL */ `
+export const VIEWS_SQL = (props: SchemaFilterProps) => /* SQL */ `
 SELECT
   c.oid :: int8 AS id,
   n.nspname AS schema,
   c.relname AS name,
   -- See definition of information_schema.views
   (pg_relation_is_updatable(c.oid, false) & 20) = 20 AS is_updatable,
+  -- Passing include_triggers => true also counts views made writable by
+  -- INSTEAD OF triggers (and INSTEAD rules), which PostgREST can write
+  -- through even when the view is not auto-updatable. Bit 8 is INSERT,
+  -- bit 4 is UPDATE (see information_schema.views).
+  (pg_relation_is_updatable(c.oid, true) & 8) = 8 AS is_insert_enabled,
+  (pg_relation_is_updatable(c.oid, true) & 4) = 4 AS is_update_enabled,
   obj_description(c.oid) AS comment
 FROM
   pg_class c
   JOIN pg_namespace n ON n.oid = c.relnamespace
 WHERE
   ${props.schemaFilter ? `n.nspname ${props.schemaFilter} AND` : ""}
-  ${props.idsFilter ? `c.oid ${props.idsFilter} AND` : ""}
-  ${props.viewIdentifierFilter ? `(n.nspname || '.' || c.relname) ${props.viewIdentifierFilter} AND` : ""}
   c.relkind = 'v'
-${props.limit ? `limit ${literal(props.limit)}` : ""}
-${props.offset ? `offset ${literal(props.offset)}` : ""}
 `;