@supabase/pg-delta 1.0.0-alpha.1 → 1.0.0-alpha.11

package/src/core/objects/type/range/range.model.ts

@@ -0,0 +1,187 @@
+import { sql } from "@ts-safeql/sql-tag";
+import type { Pool } from "pg";
+import z from "zod";
+import { BasePgModel } from "../../base.model.ts";
+import {
+  type PrivilegeProps,
+  privilegePropsSchema,
+} from "../../base.privilege-diff.ts";
+
+const rangePropsSchema = z.object({
+  schema: z.string(),
+  name: z.string(),
+  owner: z.string(),
+  comment: z.string().nullable(),
+
+  // Subtype information
+  subtype_schema: z.string(),
+  subtype_str: z.string(),
+
+  // Optional, only present when non-default relative to subtype
+  collation: z.string().nullable(),
+
+  // Canonical and diff functions when present (non-default)
+  canonical_function_schema: z.string().nullable(),
+  canonical_function_name: z.string().nullable(),
+  subtype_diff_schema: z.string().nullable(),
+  subtype_diff_name: z.string().nullable(),
+
+  // Optional: print only when non-default (see extractor logic)
+  subtype_opclass_schema: z.string().nullable(),
+  subtype_opclass_name: z.string().nullable(),
+  privileges: z.array(privilegePropsSchema),
+});
+
+type RangePrivilegeProps = PrivilegeProps;
+export type RangeProps = z.infer<typeof rangePropsSchema>;
+
+export class Range extends BasePgModel {
+  public readonly schema: RangeProps["schema"];
+  public readonly name: RangeProps["name"];
+  public readonly owner: RangeProps["owner"];
+  public readonly comment: RangeProps["comment"];
+
+  public readonly subtype_schema: RangeProps["subtype_schema"];
+  public readonly subtype_str: RangeProps["subtype_str"];
+
+  public readonly collation: RangeProps["collation"];
+
+  public readonly canonical_function_schema: RangeProps["canonical_function_schema"];
+  public readonly canonical_function_name: RangeProps["canonical_function_name"];
+  public readonly subtype_diff_schema: RangeProps["subtype_diff_schema"];
+  public readonly subtype_diff_name: RangeProps["subtype_diff_name"];
+
+  public readonly subtype_opclass_schema: RangeProps["subtype_opclass_schema"];
+  public readonly subtype_opclass_name: RangeProps["subtype_opclass_name"];
+  public readonly privileges: RangePrivilegeProps[];
+
+  constructor(props: RangeProps) {
+    super();
+
+    // Identity fields
+    this.schema = props.schema;
+    this.name = props.name;
+
+    // Data fields
+    this.owner = props.owner;
+    this.comment = props.comment;
+    this.subtype_schema = props.subtype_schema;
+    this.subtype_str = props.subtype_str;
+    this.collation = props.collation;
+    this.canonical_function_schema = props.canonical_function_schema;
+    this.canonical_function_name = props.canonical_function_name;
+    this.subtype_diff_schema = props.subtype_diff_schema;
+    this.subtype_diff_name = props.subtype_diff_name;
+    this.subtype_opclass_schema = props.subtype_opclass_schema;
+    this.subtype_opclass_name = props.subtype_opclass_name;
+    this.privileges = props.privileges;
+  }
+
+  get stableId(): `type:${string}` {
+    return `type:${this.schema}.${this.name}`;
+  }
+
+  get identityFields() {
+    return {
+      schema: this.schema,
+      name: this.name,
+    };
+  }
+
+  get dataFields() {
+    return {
+      owner: this.owner,
+      subtype_schema: this.subtype_schema,
+      subtype_str: this.subtype_str,
+      collation: this.collation,
+      canonical_function_schema: this.canonical_function_schema,
+      canonical_function_name: this.canonical_function_name,
+      subtype_diff_schema: this.subtype_diff_schema,
+      subtype_diff_name: this.subtype_diff_name,
+      subtype_opclass_schema: this.subtype_opclass_schema,
+      subtype_opclass_name: this.subtype_opclass_name,
+      comment: this.comment,
+      privileges: this.privileges,
+    };
+  }
+}
+
+/**
+ * Extract all range types from the database.
+ *
+ * We intentionally capture only non-default options for CREATE TYPE AS RANGE:
+ *  - SUBTYPE is required and always present
+ *  - SUBTYPE_OPCLASS is included only when it differs from the default btree opclass
+ *  - COLLATION is included only when it differs from the subtype's typcollation
+ *  - CANONICAL and SUBTYPE_DIFF are included only when set
+ *  - MULTIRANGE_TYPE_NAME is not included (we currently do not attempt to infer
+ *    whether it differs from the default auto-generated name)
+ */
+export async function extractRanges(pool: Pool): Promise<Range[]> {
+  const { rows } = await pool.query<RangeProps>(sql`
+with extension_oids as (
+  select objid from pg_depend d
+  where d.refclassid = 'pg_extension'::regclass and d.classid = 'pg_type'::regclass
+), default_btree_opclass as (
+  -- For each input type, find its default btree operator class
+  select oc2.opcintype as type_oid, oc2.oid as opclass_oid
+  from pg_opclass oc2
+  join pg_am am on am.oid = oc2.opcmethod and am.amname = 'btree'
+  where oc2.opcdefault
+)
+select
+  -- range type identity
+  t.typnamespace::regnamespace::text as schema,
+  quote_ident(t.typname) as name,
+  t.typowner::regrole::text as owner,
+  obj_description(t.oid, 'pg_type') as comment,
+
+  -- subtype info
+  subt.typnamespace::regnamespace::text as subtype_schema,
+  format_type(r.rngsubtype, 0) as subtype_str,
+
+  -- include collation only if not default
+  case when r.rngcollation is not null and r.rngcollation <> 0 and r.rngcollation <> subt.typcollation then quote_ident(c.collname) else null end as collation,
+
+  -- include canonical/subtype_diff when set
+  case when r.rngcanonical <> 0 then pn_subcanon.nspname::regnamespace::text else null end as canonical_function_schema,
+  case when r.rngcanonical <> 0 then quote_ident(p_subcanon.proname) else null end as canonical_function_name,
+  case when r.rngsubdiff <> 0 then pn_subdiff.nspname::regnamespace::text else null end as subtype_diff_schema,
+  case when r.rngsubdiff <> 0 then quote_ident(p_subdiff.proname) else null end as subtype_diff_name,
+
+  -- include opclass only when not default for btree
+  case when r.rngsubopc is not null and r.rngsubopc <> 0 and r.rngsubopc <> dbo.opclass_oid then opc.opcnamespace::regnamespace::text else null end as subtype_opclass_schema,
+  case when r.rngsubopc is not null and r.rngsubopc <> 0 and r.rngsubopc <> dbo.opclass_oid then quote_ident(opc.opcname) else null end as subtype_opclass_name,
+
+  -- privileges
+  coalesce(
+    (
+      select json_agg(
+        json_build_object(
+          'grantee', case when x.grantee = 0 then 'PUBLIC' else x.grantee::regrole::text end,
+          'privilege', x.privilege_type,
+          'grantable', x.is_grantable
+        )
+        order by x.grantee, x.privilege_type
+      )
+      from lateral aclexplode(COALESCE(t.typacl, acldefault('T', t.typowner))) as x(grantor, grantee, privilege_type, is_grantable)
+    ), '[]'
+  ) as privileges
+from pg_catalog.pg_range r
+join pg_catalog.pg_type t on t.oid = r.rngtypid
+join pg_catalog.pg_type subt on subt.oid = r.rngsubtype
+left join default_btree_opclass dbo on dbo.type_oid = r.rngsubtype
+left join pg_catalog.pg_opclass opc on opc.oid = r.rngsubopc
+left join pg_catalog.pg_collation c on c.oid = r.rngcollation
+left join pg_catalog.pg_proc p_subcanon on p_subcanon.oid = r.rngcanonical
+left join pg_catalog.pg_namespace pn_subcanon on pn_subcanon.oid = p_subcanon.pronamespace
+left join pg_catalog.pg_proc p_subdiff on p_subdiff.oid = r.rngsubdiff
+left join pg_catalog.pg_namespace pn_subdiff on pn_subdiff.oid = p_subdiff.pronamespace
+left outer join extension_oids e on t.oid = e.objid
+where not t.typnamespace::regnamespace::text like any(array['pg\_%', 'information\_schema'])
+  and e.objid is null
+order by 1, 2
+  `);
+  const validated = rows.map((row: unknown) => rangePropsSchema.parse(row));
+  return validated.map((row: RangeProps) => new Range(row));
+}

package/src/core/objects/type/type.types.ts

@@ -0,0 +1,6 @@
+import type { CompositeTypeChange } from "./composite-type/changes/composite-type.types.ts";
+import type { EnumChange } from "./enum/changes/enum.types.ts";
+import type { RangeChange } from "./range/changes/range.types.ts";
+
+/** Union of all type-related change variants (`objectType: "composite_type" | "enum" | "range"`). @category Change Types */
+export type TypeChange = CompositeTypeChange | EnumChange | RangeChange;

package/src/core/objects/utils.ts

@@ -0,0 +1,171 @@
+type Comparator<T> = (a: T, b: T) => boolean;
+
+type Indexable<T> = { [P in keyof T]: unknown };
+
+/**
+ * JSON.stringify replacement that safely serializes BigInt values by converting
+ * them to strings. This ensures stable serialization for deep equality checks
+ * without throwing on BigInt instances.
+ */
+export function stringifyWithBigInt(value: unknown, space: number = 2): string {
+  return JSON.stringify(
+    value,
+    (_key, v) => (typeof v === "bigint" ? v.toString() : v),
+    space,
+  );
+}
+
+export function hasNonAlterableChanges<T, K extends keyof T>(
+  main: T,
+  branch: T,
+  keys: ReadonlyArray<K>,
+  comparators?: Partial<Record<K, Comparator<unknown>>>,
+): boolean {
+  const mainIndexable = main as unknown as Indexable<T>;
+  const branchIndexable = branch as unknown as Indexable<T>;
+  for (const key of keys) {
+    // Prefer custom comparator when provided; fallback to strict equality
+    const equals =
+      (comparators?.[key] as Comparator<unknown>) ??
+      ((a: unknown, b: unknown) => a === b);
+    if (!equals(mainIndexable[key], branchIndexable[key])) return true;
+  }
+  return false;
+}
+
+export const deepEqual: Comparator<unknown> = (a: unknown, b: unknown) =>
+  stringifyWithBigInt(a) === stringifyWithBigInt(b);
+
+// Helpers for stableId that aren't encoded in a class, mostly for sub-entities or meta entities.
+export const stableId = {
+  schema(schema: string) {
+    return `schema:${schema}` as const;
+  },
+  table(schema: string, table: string) {
+    return `table:${schema}.${table}` as const;
+  },
+  view(schema: string, view: string) {
+    return `view:${schema}.${view}` as const;
+  },
+  materializedView(schema: string, view: string) {
+    return `materializedView:${schema}.${view}` as const;
+  },
+  acl(objectStableId: string, grantee: string) {
+    return `acl:${objectStableId}::grantee:${grantee}` as const;
+  },
+  /**
+   *
+   * 'defacl:' || grantor || ':' || objtype || ':' || coalesce('schema:' || in_schema, 'global') || ':grantee:' || grantee as dependent_stable_id,
+   */
+  defacl(
+    grantor: string,
+    objtype: string,
+    schema: string | null,
+    grantee: string,
+  ) {
+    return `defacl:${grantor}:${objtype}:${schema ? `schema:${schema}` : "global"}:grantee:${grantee}` as const;
+  },
+  column(schema: string, table: string, column: string) {
+    return `column:${schema}.${table}.${column}` as const;
+  },
+  constraint(schema: string, table: string, constraint: string) {
+    return `constraint:${schema}.${table}.${constraint}` as const;
+  },
+  comment(objectStableId: string) {
+    return `comment:${objectStableId}` as const;
+  },
+  role(role: string) {
+    return `role:${role}` as const;
+  },
+  type(schema: string, name: string) {
+    return `type:${schema}.${name}` as const;
+  },
+  collation(schema: string, name: string) {
+    return `collation:${schema}.${name}` as const;
+  },
+  procedure(schema: string, name: string, args: string = "") {
+    return `procedure:${schema}.${name}(${args})` as const;
+  },
+  membership(role: string, member: string) {
+    return `membership:${role}->${member}` as const;
+  },
+  foreignDataWrapper(name: string) {
+    return `foreignDataWrapper:${name}` as const;
+  },
+  server(name: string) {
+    return `server:${name}` as const;
+  },
+  userMapping(server: string, user: string) {
+    return `userMapping:${server}:${user}` as const;
+  },
+  foreignTable(schema: string, name: string) {
+    return `foreignTable:${schema}.${name}` as const;
+  },
+};
+
+/**
+ * Check if a schema name represents a user-defined type (not pg_catalog or information_schema).
+ * Used to filter out system types when building dependency lists.
+ */
+export function isUserDefinedTypeSchema(
+  schema: string | null | undefined,
+): boolean {
+  return (
+    schema != null && schema !== "pg_catalog" && schema !== "information_schema"
+  );
+}
+
+/**
+ * Parse a procedure reference string (from regprocedure::text) to extract schema and function name.
+ * Format: "schema.function_name(argtypes)" or "function_name(argtypes)"
+ * Returns null if parsing fails or if it's a system procedure.
+ */
+export function parseProcedureReference(
+  procRef: string | null | undefined,
+): { schema: string; name: string } | null {
+  if (!procRef) return null;
+
+  // Format is "schema.function_name(argtypes)" or "function_name(argtypes)"
+  // Extract everything before the opening parenthesis
+  const match = procRef.match(/^([^(]+)\(/);
+  if (!match) return null;
+
+  const qualifiedName = match[1];
+  const parts = qualifiedName.split(".");
+  if (parts.length === 1) {
+    // No schema prefix - assume current schema (we can't determine it here)
+    // For now, skip these as we need schema info
+    return null;
+  }
+  if (parts.length === 2) {
+    const [schema, name] = parts;
+    if (isUserDefinedTypeSchema(schema)) {
+      return { schema, name };
+    }
+  }
+  return null;
+}
+
+/**
+ * Parse a type string (from format_type) to extract schema and type name if it's schema-qualified.
+ * Format: "type_name" or "schema.type_name" or "schema.type_name[]"
+ * Returns null if it's not schema-qualified or if it's a system type.
+ */
+export function parseTypeString(
+  typeStr: string | null | undefined,
+): { schema: string; name: string } | null {
+  if (!typeStr) return null;
+
+  // Remove array brackets for parsing
+  const baseType = typeStr.replace(/\[\]+$/, "");
+
+  // Check if it's schema-qualified (contains a dot)
+  const parts = baseType.split(".");
+  if (parts.length === 2) {
+    const [schema, name] = parts;
+    if (isUserDefinedTypeSchema(schema)) {
+      return { schema, name };
+    }
+  }
+  return null;
+}

package/src/core/objects/view/changes/view.alter.test.ts

@@ -0,0 +1,115 @@
+import { describe, expect, test } from "bun:test";
+import { assertValidSql } from "../../../test-utils/assert-valid-sql.ts";
+import { View, type ViewProps } from "../view.model.ts";
+import {
+  AlterViewChangeOwner,
+  AlterViewResetOptions,
+  AlterViewSetOptions,
+} from "./view.alter.ts";
+
+describe.concurrent("view", () => {
+  describe("alter", () => {
+    test("change owner", async () => {
+      const props: Omit<ViewProps, "owner"> = {
+        schema: "public",
+        name: "test_view",
+        definition: "SELECT * FROM test_table",
+        row_security: false,
+        force_row_security: false,
+        has_indexes: false,
+        has_rules: false,
+        has_triggers: false,
+        has_subclasses: false,
+        is_populated: false,
+        replica_identity: "d",
+        is_partition: false,
+        options: null,
+        partition_bound: null,
+        comment: null,
+        columns: [],
+        privileges: [],
+      };
+      const main = new View({
+        ...props,
+        owner: "old_owner",
+      });
+      // branch no longer needed for constructor; we only pass explicit owner
+
+      const change = new AlterViewChangeOwner({
+        view: main,
+        owner: "new_owner",
+      });
+
+      await assertValidSql(change.serialize());
+
+      expect(change.serialize()).toBe(
+        "ALTER VIEW public.test_view OWNER TO new_owner",
+      );
+    });
+  });
+
+  test("set options", async () => {
+    const props: Omit<ViewProps, "options"> = {
+      schema: "public",
+      name: "test_view",
+      definition: "SELECT * FROM test_table",
+      row_security: false,
+      force_row_security: false,
+      has_indexes: false,
+      has_rules: false,
+      has_triggers: false,
+      has_subclasses: false,
+      is_populated: false,
+      replica_identity: "d",
+      is_partition: false,
+      partition_bound: null,
+      owner: "test",
+      comment: null,
+      columns: [],
+      privileges: [],
+    };
+    const main = new View({ ...props, options: ["security_barrier=true"] });
+    // branch no longer needed; we pass explicit options list
+
+    const change = new AlterViewSetOptions({
+      view: main,
+      options: ["security_barrier=false"],
+    });
+    await assertValidSql(change.serialize());
+    expect(change.serialize()).toBe(
+      "ALTER VIEW public.test_view SET (security_barrier=false)",
+    );
+  });
+
+  test("reset options", async () => {
+    const view = new View({
+      schema: "public",
+      name: "test_view",
+      definition: "SELECT * FROM test_table",
+      row_security: false,
+      force_row_security: false,
+      has_indexes: false,
+      has_rules: false,
+      has_triggers: false,
+      has_subclasses: false,
+      is_populated: false,
+      replica_identity: "d",
+      is_partition: false,
+      options: ["security_barrier=true", "check_option=local"],
+      partition_bound: null,
+      owner: "test",
+      comment: null,
+      columns: [],
+      privileges: [],
+    });
+
+    const change = new AlterViewResetOptions({
+      view,
+      params: ["check_option"],
+    });
+    await assertValidSql(change.serialize());
+    expect(change.serialize()).toBe(
+      "ALTER VIEW public.test_view RESET (check_option)",
+    );
+  });
+});

package/src/core/objects/view/changes/view.alter.ts

@@ -0,0 +1,112 @@
+import type { View } from "../view.model.ts";
+import { AlterViewChange } from "./view.base.ts";
+
+/**
+ * Alter a view.
+ *
+ * @see https://www.postgresql.org/docs/17/sql-alterview.html
+ *
+ * Synopsis
+ * ```sql
+ * ALTER VIEW [ IF EXISTS ] name ALTER [ COLUMN ] column_name SET DEFAULT expression
+ * ALTER VIEW [ IF EXISTS ] name ALTER [ COLUMN ] column_name DROP DEFAULT
+ * ALTER VIEW [ IF EXISTS ] name OWNER TO { new_owner | CURRENT_ROLE | CURRENT_USER | SESSION_USER }
+ * ALTER VIEW [ IF EXISTS ] name RENAME [ COLUMN ] column_name TO new_column_name
+ * ALTER VIEW [ IF EXISTS ] name RENAME TO new_name
+ * ALTER VIEW [ IF EXISTS ] name SET SCHEMA new_schema
+ * ALTER VIEW [ IF EXISTS ] name SET ( view_option_name [= view_option_value] [, ... ] )
+ * ALTER VIEW [ IF EXISTS ] name RESET ( view_option_name [, ... ] )
+ * ```
+ */
+
+export type AlterView =
+  | AlterViewChangeOwner
+  | AlterViewResetOptions
+  | AlterViewSetOptions;
+
+/**
+ * ALTER VIEW ... OWNER TO ...
+ */
+export class AlterViewChangeOwner extends AlterViewChange {
+  public readonly view: View;
+  public readonly owner: string;
+  public readonly scope = "object" as const;
+
+  constructor(props: { view: View; owner: string }) {
+    super();
+    this.view = props.view;
+    this.owner = props.owner;
+  }
+
+  get requires() {
+    return [this.view.stableId];
+  }
+
+  serialize(): string {
+    return [
+      "ALTER VIEW",
+      `${this.view.schema}.${this.view.name}`,
+      "OWNER TO",
+      this.owner,
+    ].join(" ");
+  }
+}
+
+// NOTE: ReplaceView removed. Non-alterable changes are emitted as CREATE OR REPLACE in view.diff.ts.
+
+/**
+ * ALTER VIEW ... SET ( ... )
+ */
+export class AlterViewSetOptions extends AlterViewChange {
+  public readonly view: View;
+  public readonly options: string[];
+  public readonly scope = "object" as const;
+
+  constructor(props: { view: View; options: string[] }) {
+    super();
+    this.view = props.view;
+    this.options = props.options;
+  }
+
+  get requires() {
+    return [this.view.stableId];
+  }
+
+  serialize(): string {
+    const opts = this.options.join(", ");
+    return [
+      "ALTER VIEW",
+      `${this.view.schema}.${this.view.name}`,
+      "SET",
+      `(${opts})`,
+    ].join(" ");
+  }
+}
+
+/**
+ * ALTER VIEW ... RESET ( ... )
+ */
+export class AlterViewResetOptions extends AlterViewChange {
+  public readonly view: View;
+  public readonly params: string[];
+  public readonly scope = "object" as const;
+
+  constructor(props: { view: View; params: string[] }) {
+    super();
+    this.view = props.view;
+    this.params = props.params;
+  }
+
+  get requires() {
+    return [this.view.stableId];
+  }
+
+  serialize(): string {
+    return [
+      "ALTER VIEW",
+      `${this.view.schema}.${this.view.name}`,
+      "RESET",
+      `(${this.params.join(", ")})`,
+    ].join(" ");
+  }
+}

package/src/core/objects/view/changes/view.base.ts

@@ -0,0 +1,20 @@
+import { BaseChange } from "../../base.change.ts";
+import type { View } from "../view.model.ts";
+
+abstract class BaseViewChange extends BaseChange {
+  abstract readonly view: View;
+  abstract readonly scope: "object" | "comment" | "privilege";
+  readonly objectType: "view" = "view";
+}
+
+export abstract class CreateViewChange extends BaseViewChange {
+  readonly operation = "create" as const;
+}
+
+export abstract class AlterViewChange extends BaseViewChange {
+  readonly operation = "alter" as const;
+}
+
+export abstract class DropViewChange extends BaseViewChange {
+  readonly operation = "drop" as const;
+}

package/src/core/objects/view/changes/view.comment.ts

@@ -0,0 +1,59 @@
+import { quoteLiteral } from "../../base.change.ts";
+import { stableId } from "../../utils.ts";
+import type { View } from "../view.model.ts";
+import { CreateViewChange, DropViewChange } from "./view.base.ts";
+
+export type CommentView = CreateCommentOnView | DropCommentOnView;
+
+export class CreateCommentOnView extends CreateViewChange {
+  public readonly view: View;
+  public readonly scope = "comment" as const;
+
+  constructor(props: { view: View }) {
+    super();
+    this.view = props.view;
+  }
+
+  get creates() {
+    return [stableId.comment(this.view.stableId)];
+  }
+
+  get requires() {
+    return [this.view.stableId];
+  }
+
+  serialize(): string {
+    return [
+      "COMMENT ON VIEW",
+      `${this.view.schema}.${this.view.name}`,
+      "IS",
+      quoteLiteral(this.view.comment as string),
+    ].join(" ");
+  }
+}
+
+export class DropCommentOnView extends DropViewChange {
+  public readonly view: View;
+  public readonly scope = "comment" as const;
+
+  constructor(props: { view: View }) {
+    super();
+    this.view = props.view;
+  }
+
+  get drops() {
+    return [stableId.comment(this.view.stableId)];
+  }
+
+  get requires() {
+    return [stableId.comment(this.view.stableId), this.view.stableId];
+  }
+
+  serialize(): string {
+    return [
+      "COMMENT ON VIEW",
+      `${this.view.schema}.${this.view.name}`,
+      "IS NULL",
+    ].join(" ");
+  }
+}