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

package/src/core/integrations/serialize/dsl.test.ts

@@ -20,7 +20,7 @@ describe("compileSerializeDSL", () => {
   test("matching rule applies its options", () => {
     const serializer = compileSerializeDSL([
       {
-        when: { type: "schema" as const, operation: "create" as const },
+        when: { objectType: "schema", operation: "create" },
         options: { skipAuthorization: true },
       },
     ]);
@@ -37,7 +37,7 @@ describe("compileSerializeDSL", () => {
   test("no matching rule uses default serialization", () => {
     const serializer = compileSerializeDSL([
       {
-        when: { type: "table" as const },
+        when: { objectType: "table" },
         options: { skipAuthorization: true },
       },
     ]);
@@ -54,11 +54,11 @@ describe("compileSerializeDSL", () => {
   test("first matching rule wins", () => {
     const serializer = compileSerializeDSL([
       {
-        when: { type: "schema" as const },
+        when: { objectType: "schema" },
         options: { skipAuthorization: true },
       },
       {
-        when: { type: "schema" as const },
+        when: { objectType: "schema" },
         options: { skipAuthorization: false },
       },
     ]);
@@ -73,11 +73,11 @@ describe("compileSerializeDSL", () => {
   test("skips non-matching first rule and applies second", () => {
     const serializer = compileSerializeDSL([
       {
-        when: { type: "table" as const },
+        when: { objectType: "table" },
         options: { skipAuthorization: true },
       },
       {
-        when: { type: "schema" as const },
+        when: { objectType: "schema" },
         options: { skipAuthorization: false },
       },
     ]);

package/src/core/integrations/serialize/dsl.ts

@@ -33,8 +33,11 @@ type SerializeRule = {
 };
 
 /**
- * Serialization DSL - array of rules evaluated in order.
- * First matching rule's options are applied.
+ * Array of serialization rules evaluated in order. The first matching rule's
+ * options are passed to `change.serialize()`. If no rule matches, default
+ * serialization is used.
+ *
+ * @category Integration
  */
 export type SerializeDSL = SerializeRule[];
 
@@ -52,9 +55,9 @@ export type SerializeDSL = SerializeRule[];
  * const serializer = compileSerializeDSL([
  *   {
  *     when: {
- *       type: "schema",
+ *       objectType: "schema",
  *       operation: "create",
- *       owner: ["service_role"]
+ *       "schema/owner": ["service_role"]
  *     },
  *     options: { skipAuthorization: true }
  *   }

package/src/core/integrations/supabase.ts

@@ -70,38 +70,53 @@ export const supabase: IntegrationDSL = {
   // TODO: emptyCatalog: undefined -- populate by running catalog-export on a clean Supabase container
   filter: {
     or: [
+      // Include user schema CREATE operations (only schemas not in system list)
       {
         and: [
           {
-            type: "schema",
+            objectType: "schema",
             operation: "create",
             scope: "object",
           },
           {
             not: {
-              schema: [...SUPABASE_SYSTEM_SCHEMAS],
+              // Schema objects have name, not schema — use schema/name
+              "schema/name": [...SUPABASE_SYSTEM_SCHEMAS],
             },
           },
         ],
       },
+      // Include extension CREATEs
       {
-        type: "extension",
+        objectType: "extension",
         operation: "create",
         scope: "object",
       },
+      // Exclude system objects
       {
         not: {
           or: [
+            // Objects in system schemas (*/schema matches table/schema, view/schema, etc.)
             {
-              schema: [...SUPABASE_SYSTEM_SCHEMAS],
+              "*/schema": [...SUPABASE_SYSTEM_SCHEMAS],
             },
+            // Schema objects whose own name is a system schema
             {
-              owner: [...SUPABASE_SYSTEM_ROLES],
+              "schema/name": [...SUPABASE_SYSTEM_SCHEMAS],
             },
+            // Objects owned by system roles (*/owner matches table/owner, schema/owner, etc.)
+            {
+              "*/owner": [...SUPABASE_SYSTEM_ROLES],
+            },
+            // Role objects whose own name is a system role
+            {
+              "role/name": [...SUPABASE_SYSTEM_ROLES],
+            },
+            // Membership changes for system roles
             {
               and: [
                 {
-                  type: "role",
+                  objectType: "role",
                   scope: "membership",
                 },
                 {
@@ -117,10 +132,10 @@ export const supabase: IntegrationDSL = {
   serialize: [
     {
       when: {
-        type: "schema",
+        objectType: "schema",
         operation: "create",
         scope: "object",
-        owner: [...SUPABASE_SYSTEM_ROLES],
+        "schema/owner": [...SUPABASE_SYSTEM_ROLES],
       },
       options: {
         skipAuthorization: true,

package/src/core/objects/aggregate/changes/aggregate.types.ts

@@ -4,6 +4,7 @@ import type { CreateAggregate } from "./aggregate.create.ts";
 import type { DropAggregate } from "./aggregate.drop.ts";
 import type { AggregatePrivilege } from "./aggregate.privilege.ts";
 
+/** Union of all aggregate-related change variants (`objectType: "aggregate"`). @category Change Types */
 export type AggregateChange =
   | AlterAggregate
   | CommentAggregate

package/src/core/objects/base.change.ts

@@ -1,5 +1,15 @@
 type ChangeOperation = "create" | "alter" | "drop";
 
+/**
+ * Abstract base class for all change objects.
+ *
+ * Every concrete change (e.g. `CreateTable`, `AlterView`) extends this class and
+ * provides an `operation`, `objectType`, and `scope`. The filter DSL flattens
+ * these properties — along with the model sub-object — into path/value pairs
+ * for pattern matching.
+ *
+ * @category Base
+ */
 export abstract class BaseChange {
   /**
    * The operation of the change.

package/src/core/objects/base.model.test.ts

@@ -0,0 +1,43 @@
+import { describe, expect, test } from "bun:test";
+import { BasePgModel } from "./base.model.ts";
+
+class NormalizedTestModel extends BasePgModel {
+  private readonly id: string;
+  private readonly values: string[];
+
+  constructor(id: string, values: string[]) {
+    super();
+    this.id = id;
+    this.values = values;
+  }
+
+  get stableId() {
+    return this.id;
+  }
+
+  get identityFields() {
+    return { id: this.id };
+  }
+
+  get dataFields() {
+    return { values: this.values };
+  }
+
+  override stableSnapshot() {
+    return {
+      identity: this.identityFields,
+      data: {
+        values: [...this.values].sort(),
+      },
+    };
+  }
+}
+
+describe("BasePgModel.equals", () => {
+  test("uses stable snapshots for normalized equality", () => {
+    const main = new NormalizedTestModel("same", ["b", "a"]);
+    const branch = new NormalizedTestModel("same", ["a", "b"]);
+
+    expect(main.equals(branch)).toBe(true);
+  });
+});

package/src/core/objects/base.model.ts

@@ -60,12 +60,15 @@ export abstract class BasePgModel {
   abstract get dataFields(): Record<string, unknown>;
 
   /**
-   * Compare this object with another BasePgModel for equality based on stableId and dataFields.
+   * Compare this object with another BasePgModel for equality based on the stableId and
+   * the data portion of the stable snapshot. By default, the snapshot's `data` comes
+   * from {@link dataFields}, but subclasses may override {@link stableSnapshot} to
+   * normalize or otherwise transform the data used for equality.
    */
   equals(other: BasePgModel): boolean {
     return (
       this.stableId === other.stableId &&
-      deepEqual(this.dataFields, other.dataFields)
+      deepEqual(this.stableSnapshot().data, other.stableSnapshot().data)
     );
   }
 

package/src/core/objects/collation/changes/collation.types.ts

@@ -3,6 +3,7 @@ import type { CommentCollation } from "./collation.comment.ts";
 import type { CreateCollation } from "./collation.create.ts";
 import type { DropCollation } from "./collation.drop.ts";
 
+/** Union of all collation-related change variants (`objectType: "collation"`). @category Change Types */
 export type CollationChange =
   | AlterCollation
   | CommentCollation

package/src/core/objects/domain/changes/domain.create.ts

@@ -34,7 +34,23 @@ export class CreateDomain extends CreateDomainChange {
   }
 
   get creates() {
-    return [this.domain.stableId];
+    const creates: Array<
+      `domain:${string}` | `constraint:${string}.${string}.${string}`
+    > = [this.domain.stableId];
+
+    for (const constraint of this.domain.constraints) {
+      if (constraint.check_expression && constraint.validated) {
+        creates.push(
+          stableId.constraint(
+            this.domain.schema,
+            this.domain.name,
+            constraint.name,
+          ),
+        );
+      }
+    }
+
+    return creates;
   }
 
   get requires() {

package/src/core/objects/domain/changes/domain.types.ts

@@ -4,6 +4,7 @@ import type { CreateDomain } from "./domain.create.ts";
 import type { DropDomain } from "./domain.drop.ts";
 import type { DomainPrivilege } from "./domain.privilege.ts";
 
+/** Union of all domain-related change variants (`objectType: "domain"`). @category Change Types */
 export type DomainChange =
   | AlterDomain
   | CommentDomain

package/src/core/objects/event-trigger/changes/event-trigger.types.ts

@@ -3,6 +3,7 @@ import type { CommentEventTrigger } from "./event-trigger.comment.ts";
 import type { CreateEventTrigger } from "./event-trigger.create.ts";
 import type { DropEventTrigger } from "./event-trigger.drop.ts";
 
+/** Union of all event-trigger-related change variants (`objectType: "event_trigger"`). @category Change Types */
 export type EventTriggerChange =
   | AlterEventTrigger
   | CommentEventTrigger

package/src/core/objects/extension/changes/extension.types.ts

@@ -3,6 +3,7 @@ import type { CommentExtension } from "./extension.comment.ts";
 import type { CreateExtension } from "./extension.create.ts";
 import type { DropExtension } from "./extension.drop.ts";
 
+/** Union of all extension-related change variants (`objectType: "extension"`). @category Change Types */
 export type ExtensionChange =
   | AlterExtension
   | CommentExtension

package/src/core/objects/foreign-data-wrapper/foreign-data-wrapper/changes/foreign-data-wrapper.types.ts

@@ -4,6 +4,7 @@ import type { CreateForeignDataWrapper } from "./foreign-data-wrapper.create.ts"
 import type { DropForeignDataWrapper } from "./foreign-data-wrapper.drop.ts";
 import type { ForeignDataWrapperPrivilege } from "./foreign-data-wrapper.privilege.ts";
 
+/** Union of all FDW wrapper-level change variants (`objectType: "foreign_data_wrapper"`). @category Change Types */
 export type ForeignDataWrapperChange =
   | AlterForeignDataWrapper
   | CommentForeignDataWrapper

package/src/core/objects/foreign-data-wrapper/foreign-data-wrapper.types.ts

@@ -3,6 +3,7 @@ import type { ForeignTableChange } from "./foreign-table/changes/foreign-table.t
 import type { ServerChange } from "./server/changes/server.types.ts";
 import type { UserMappingChange } from "./user-mapping/changes/user-mapping.types.ts";
 
+/** Union of all foreign-data-wrapper-related change variants (`objectType: "foreign_data_wrapper" | "server" | "foreign_table" | "user_mapping"`). @category Change Types */
 export type ForeignDataWrapperChange =
   | FDWChange
   | ServerChange

package/src/core/objects/foreign-data-wrapper/foreign-table/changes/foreign-table.types.ts

@@ -4,6 +4,7 @@ import type { CreateForeignTable } from "./foreign-table.create.ts";
 import type { DropForeignTable } from "./foreign-table.drop.ts";
 import type { ForeignTablePrivilege } from "./foreign-table.privilege.ts";
 
+/** Union of all foreign-table-related change variants (`objectType: "foreign_table"`). @category Change Types */
 export type ForeignTableChange =
   | AlterForeignTable
   | CommentForeignTable

package/src/core/objects/foreign-data-wrapper/server/changes/server.types.ts

@@ -4,6 +4,7 @@ import type { CreateServer } from "./server.create.ts";
 import type { DropServer } from "./server.drop.ts";
 import type { ServerPrivilege } from "./server.privilege.ts";
 
+/** Union of all server-related change variants (`objectType: "server"`). @category Change Types */
 export type ServerChange =
   | AlterServer
   | CommentServer

package/src/core/objects/foreign-data-wrapper/user-mapping/changes/user-mapping.types.ts

@@ -2,6 +2,7 @@ import type { AlterUserMapping } from "./user-mapping.alter.ts";
 import type { CreateUserMapping } from "./user-mapping.create.ts";
 import type { DropUserMapping } from "./user-mapping.drop.ts";
 
+/** Union of all user-mapping-related change variants (`objectType: "user_mapping"`). @category Change Types */
 export type UserMappingChange =
   | AlterUserMapping
   | CreateUserMapping

package/src/core/objects/index/changes/index.types.ts

@@ -3,4 +3,5 @@ import type { CommentIndex } from "./index.comment.ts";
 import type { CreateIndex } from "./index.create.ts";
 import type { DropIndex } from "./index.drop.ts";
 
+/** Union of all index-related change variants (`objectType: "index"`). @category Change Types */
 export type IndexChange = AlterIndex | CommentIndex | CreateIndex | DropIndex;

package/src/core/objects/language/changes/language.types.ts

@@ -4,6 +4,7 @@ import type { CreateLanguage } from "./language.create.ts";
 import type { DropLanguage } from "./language.drop.ts";
 import type { LanguagePrivilege } from "./language.privilege.ts";
 
+/** Union of all language-related change variants (`objectType: "language"`). @category Change Types */
 export type LanguageChange =
   | AlterLanguage
   | CommentLanguage

package/src/core/objects/materialized-view/changes/materialized-view.types.ts

@@ -4,6 +4,7 @@ import type { CreateMaterializedView } from "./materialized-view.create.ts";
 import type { DropMaterializedView } from "./materialized-view.drop.ts";
 import type { MaterializedViewPrivilege } from "./materialized-view.privilege.ts";
 
+/** Union of all materialized-view-related change variants (`objectType: "materialized_view"`). @category Change Types */
 export type MaterializedViewChange =
   | AlterMaterializedView
   | CommentMaterializedView

package/src/core/objects/procedure/changes/procedure.types.ts

@@ -4,6 +4,7 @@ import type { CreateProcedure } from "./procedure.create.ts";
 import type { DropProcedure } from "./procedure.drop.ts";
 import type { ProcedurePrivilege } from "./procedure.privilege.ts";
 
+/** Union of all procedure-related change variants (`objectType: "procedure"`). @category Change Types */
 export type ProcedureChange =
   | AlterProcedure
   | CommentProcedure

package/src/core/objects/publication/changes/publication.types.ts

@@ -11,6 +11,7 @@ import type { CommentPublication } from "./publication.comment.ts";
 import type { CreatePublication } from "./publication.create.ts";
 import type { DropPublication } from "./publication.drop.ts";
 
+/** Union of all publication-related change variants (`objectType: "publication"`). @category Change Types */
 export type PublicationChange =
   | AlterPublicationAddSchemas
   | AlterPublicationAddTables

package/src/core/objects/rls-policy/changes/rls-policy.types.ts

@@ -3,6 +3,7 @@ import type { CommentRlsPolicy } from "./rls-policy.comment.ts";
 import type { CreateRlsPolicy } from "./rls-policy.create.ts";
 import type { DropRlsPolicy } from "./rls-policy.drop.ts";
 
+/** Union of all RLS policy-related change variants (`objectType: "rls_policy"`). @category Change Types */
 export type RlsPolicyChange =
   | AlterRlsPolicy
   | CommentRlsPolicy

package/src/core/objects/role/changes/role.types.ts

@@ -4,6 +4,7 @@ import type { CreateRole } from "./role.create.ts";
 import type { DropRole } from "./role.drop.ts";
 import type { RolePrivilege } from "./role.privilege.ts";
 
+/** Union of all role-related change variants (`objectType: "role"`). @category Change Types */
 export type RoleChange =
   | AlterRole
   | CommentRole

package/src/core/objects/rule/changes/rule.types.ts

@@ -3,6 +3,7 @@ import type { CreateCommentOnRule, DropCommentOnRule } from "./rule.comment.ts";
 import type { CreateRule } from "./rule.create.ts";
 import type { DropRule } from "./rule.drop.ts";
 
+/** Union of all rule-related change variants (`objectType: "rule"`). @category Change Types */
 export type RuleChange =
   | CreateRule
   | DropRule

package/src/core/objects/schema/changes/schema.types.ts

@@ -4,6 +4,7 @@ import type { CreateSchema } from "./schema.create.ts";
 import type { DropSchema } from "./schema.drop.ts";
 import type { SchemaPrivilege } from "./schema.privilege.ts";
 
+/** Union of all schema-related change variants (`objectType: "schema"`). @category Change Types */
 export type SchemaChange =
   | AlterSchema
   | CommentSchema

package/src/core/objects/sequence/changes/sequence.types.ts

@@ -4,6 +4,7 @@ import type { CreateSequence } from "./sequence.create.ts";
 import type { DropSequence } from "./sequence.drop.ts";
 import type { SequencePrivilege } from "./sequence.privilege.ts";
 
+/** Union of all sequence-related change variants (`objectType: "sequence"`). @category Change Types */
 export type SequenceChange =
   | AlterSequence
   | CommentSequence

package/src/core/objects/subscription/changes/subscription.types.ts

@@ -10,6 +10,7 @@ import type { CommentSubscription } from "./subscription.comment.ts";
 import type { CreateSubscription } from "./subscription.create.ts";
 import type { DropSubscription } from "./subscription.drop.ts";
 
+/** Union of all subscription-related change variants (`objectType: "subscription"`). @category Change Types */
 export type SubscriptionChange =
   | CreateSubscription
   | DropSubscription

package/src/core/objects/table/changes/table.types.ts

@@ -4,6 +4,7 @@ import type { CreateTable } from "./table.create.ts";
 import type { DropTable } from "./table.drop.ts";
 import type { TablePrivilege } from "./table.privilege.ts";
 
+/** Union of all table-related change variants (`objectType: "table"`). @category Change Types */
 export type TableChange =
   | AlterTable
   | CommentTable

package/src/core/objects/trigger/changes/trigger.types.ts

@@ -3,6 +3,7 @@ import type { CommentTrigger } from "./trigger.comment.ts";
 import type { CreateTrigger } from "./trigger.create.ts";
 import type { DropTrigger } from "./trigger.drop.ts";
 
+/** Union of all trigger-related change variants (`objectType: "trigger"`). @category Change Types */
 export type TriggerChange =
   | AlterTrigger
   | CommentTrigger

package/src/core/objects/type/composite-type/changes/composite-type.types.ts

@@ -4,6 +4,7 @@ import type { CreateCompositeType } from "./composite-type.create.ts";
 import type { DropCompositeType } from "./composite-type.drop.ts";
 import type { CompositeTypePrivilege } from "./composite-type.privilege.ts";
 
+/** Union of all composite-type-related change variants (`objectType: "composite_type"`). @category Change Types */
 export type CompositeTypeChange =
   | AlterCompositeType
   | CommentCompositeType

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

@@ -4,6 +4,7 @@ import type { CreateEnum } from "./enum.create.ts";
 import type { DropEnum } from "./enum.drop.ts";
 import type { EnumPrivilege } from "./enum.privilege.ts";
 
+/** Union of all enum-related change variants (`objectType: "enum"`). @category Change Types */
 export type EnumChange =
   | AlterEnum
   | CommentEnum

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

@@ -4,6 +4,7 @@ import type { CreateRange } from "./range.create.ts";
 import type { DropRange } from "./range.drop.ts";
 import type { RangePrivilege } from "./range.privilege.ts";
 
+/** Union of all range-related change variants (`objectType: "range"`). @category Change Types */
 export type RangeChange =
   | AlterRange
   | CommentRange

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

@@ -2,4 +2,5 @@ import type { CompositeTypeChange } from "./composite-type/changes/composite-typ
 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/view/changes/view.types.ts

@@ -4,6 +4,7 @@ import type { CreateView } from "./view.create.ts";
 import type { DropView } from "./view.drop.ts";
 import type { ViewPrivilege } from "./view.privilege.ts";
 
+/** Union of all view-related change variants (`objectType: "view"`). @category Change Types */
 export type ViewChange =
   | AlterView
   | CommentView

package/src/core/objects/view/view.diff.test.ts

@@ -105,6 +105,102 @@ describe.concurrent("view.diff", () => {
     expect(changes[0]).toBeInstanceOf(CreateView);
   });
 
+  test("drop and recreate when view columns change", () => {
+    const main = makeView({
+      owner: "postgres",
+      columns: [
+        {
+          name: "id",
+          position: 1,
+          data_type: "integer",
+          data_type_str: "integer",
+          is_custom_type: false,
+          custom_type_type: null,
+          custom_type_category: null,
+          custom_type_schema: null,
+          custom_type_name: null,
+          not_null: false,
+          is_identity: false,
+          is_identity_always: false,
+          is_generated: false,
+          collation: null,
+          default: null,
+          comment: null,
+        },
+      ],
+    });
+    const branch = makeView({
+      owner: "postgres",
+      columns: [
+        ...main.columns,
+        {
+          name: "priority",
+          position: 2,
+          data_type: "integer",
+          data_type_str: "integer",
+          is_custom_type: false,
+          custom_type_type: null,
+          custom_type_category: null,
+          custom_type_schema: null,
+          custom_type_name: null,
+          not_null: false,
+          is_identity: false,
+          is_identity_always: false,
+          is_generated: false,
+          collation: null,
+          default: null,
+          comment: null,
+        },
+      ],
+    });
+    const changes = diffViews(
+      testContext,
+      { [main.stableId]: main },
+      { [branch.stableId]: branch },
+    );
+    expect(changes).toHaveLength(2);
+    expect(changes[0]).toBeInstanceOf(DropView);
+    expect(changes[1]).toBeInstanceOf(CreateView);
+  });
+
+  test("column position-only change does not trigger drop+create", () => {
+    const col = {
+      name: "id",
+      position: 1,
+      data_type: "integer",
+      data_type_str: "integer",
+      is_custom_type: false,
+      custom_type_type: null,
+      custom_type_category: null,
+      custom_type_schema: null,
+      custom_type_name: null,
+      not_null: false,
+      is_identity: false,
+      is_identity_always: false,
+      is_generated: false,
+      collation: null,
+      default: null,
+      comment: "my column",
+    };
+    const main = makeView({
+      owner: "postgres",
+      comment: "old comment",
+      columns: [{ ...col, position: 1 }],
+    });
+    const branch = makeView({
+      owner: "postgres",
+      comment: "new comment",
+      columns: [{ ...col, position: 2 }],
+    });
+    const changes = diffViews(
+      testContext,
+      { [main.stableId]: main },
+      { [branch.stableId]: branch },
+    );
+    expect(changes.some((c) => c instanceof DropView)).toBe(false);
+    expect(changes.some((c) => c instanceof CreateCommentOnView)).toBe(true);
+  });
+
   test("create with privileges emits grant changes", () => {
     const v = makeView({
       privileges: [