frg-data-diff 2.0.0 → 2.1.0

package/dist/cli/root.js

@@ -49,6 +49,7 @@ const commandFiles = {
     apply: "apply.js",
     sql: "sql.js",
     "pg-triggers": "pg-triggers.js",
+    "pg-views": "pg-views.js",
 };
 const helpText = `frg-data-diff
 
@@ -62,6 +63,7 @@ Commands:
   apply        Read a JSON diff file and safely apply it to a destination PostgreSQL database.
   sql          Read a JSON diff file and write a plain SQL script for manual review and execution.
   pg-triggers  Compare PostgreSQL triggers and functions and write a SQL diff script.
+  pg-views     Compare PostgreSQL view definitions and write a SQL diff script.
   version      Print the package version.
 
 Basic usage:
@@ -71,12 +73,14 @@ Basic usage:
   npx frg-data-diff apply --execute
   npx frg-data-diff sql --yes
   npx frg-data-diff pg-triggers
+  npx frg-data-diff pg-views
   npx frg-data-diff version
 
 Config file:
   .frg-data-diff.config.json
 
   Commands look for .frg-data-diff.config.json in the current directory.
+  The config file accepts // line comments and /* block comments */.
   Create it by running a command with --config or with CLI args on first run.
 
 How to generate a diff:
@@ -149,6 +153,8 @@ Config file example (.frg-data-diff.config.json):
       "schemaDiffOutput": "frg-schema-diff.json",
       "pgTriggersTables": ["my_table"],
       "pgTriggersOutput": "frg-triggers-diff.sql",
+      "pgViews": ["*"],
+      "pgViewsOutput": "frg-views-diff.sql",
       "includeDeletes": true,
       "pretty": true
     },

package/dist/config/config-schema.d.ts

@@ -19,6 +19,8 @@ export declare const generatorConfigSchema: z.ZodObject<{
     schemaDiffExcludeTables: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>>;
     pgTriggersTables: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
     pgTriggersExcludeTables: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>>;
+    pgViews: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
+    pgViewsExclude: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>>;
     ignoreColumns: z.ZodDefault<z.ZodNullable<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>>;
     tablesWhereDataFilters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodString, string, string>>>;
     includeDeletes: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodString]>>;
@@ -26,9 +28,11 @@ export declare const generatorConfigSchema: z.ZodObject<{
     output: z.ZodDefault<z.ZodEffects<z.ZodString, string, string>>;
     schemaDiffOutput: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
     pgTriggersOutput: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    pgViewsOutput: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
     pretty: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodString]>>;
     generateSql: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodString]>>;
     generatePgTriggers: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodString]>>;
+    generatePgViews: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodString]>>;
 }, "strip", z.ZodTypeAny, {
     schema: string;
     includeDeletes: string | boolean;
@@ -54,11 +58,15 @@ export declare const generatorConfigSchema: z.ZodObject<{
     schemaDiffExcludeTables?: string[] | null | undefined;
     pgTriggersTables?: string[] | undefined;
     pgTriggersExcludeTables?: string[] | null | undefined;
+    pgViews?: string[] | undefined;
+    pgViewsExclude?: string[] | null | undefined;
     tablesWhereDataFilters?: Record<string, string> | undefined;
     schemaDiffOutput?: string | undefined;
     pgTriggersOutput?: string | undefined;
+    pgViewsOutput?: string | undefined;
     generateSql?: string | boolean | undefined;
     generatePgTriggers?: string | boolean | undefined;
+    generatePgViews?: string | boolean | undefined;
 }, {
     tables: string[];
     sourcePgHost: string;
@@ -80,15 +88,19 @@ export declare const generatorConfigSchema: z.ZodObject<{
     schemaDiffExcludeTables?: string[] | null | undefined;
     pgTriggersTables?: string[] | undefined;
     pgTriggersExcludeTables?: string[] | null | undefined;
+    pgViews?: string[] | undefined;
+    pgViewsExclude?: string[] | null | undefined;
     ignoreColumns?: string[] | null | undefined;
     tablesWhereDataFilters?: Record<string, string> | undefined;
     skipMissingPk?: string | boolean | undefined;
     output?: string | undefined;
     schemaDiffOutput?: string | undefined;
     pgTriggersOutput?: string | undefined;
+    pgViewsOutput?: string | undefined;
     pretty?: string | boolean | undefined;
     generateSql?: string | boolean | undefined;
     generatePgTriggers?: string | boolean | undefined;
+    generatePgViews?: string | boolean | undefined;
 }>;
 export declare const applyConfigSchema: z.ZodObject<{
     destPgHost: z.ZodEffects<z.ZodString, string, string>;
@@ -158,6 +170,8 @@ export declare const configSchema: z.ZodObject<{
         schemaDiffExcludeTables: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>>;
         pgTriggersTables: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
         pgTriggersExcludeTables: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>>;
+        pgViews: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>;
+        pgViewsExclude: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>>;
         ignoreColumns: z.ZodDefault<z.ZodNullable<z.ZodArray<z.ZodEffects<z.ZodString, string, string>, "many">>>;
         tablesWhereDataFilters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEffects<z.ZodString, string, string>>>;
         includeDeletes: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodString]>>;
@@ -165,9 +179,11 @@ export declare const configSchema: z.ZodObject<{
         output: z.ZodDefault<z.ZodEffects<z.ZodString, string, string>>;
         schemaDiffOutput: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
         pgTriggersOutput: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+        pgViewsOutput: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
         pretty: z.ZodDefault<z.ZodUnion<[z.ZodBoolean, z.ZodString]>>;
         generateSql: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodString]>>;
         generatePgTriggers: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodString]>>;
+        generatePgViews: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodString]>>;
     }, "strip", z.ZodTypeAny, {
         schema: string;
         includeDeletes: string | boolean;
@@ -193,11 +209,15 @@ export declare const configSchema: z.ZodObject<{
         schemaDiffExcludeTables?: string[] | null | undefined;
         pgTriggersTables?: string[] | undefined;
         pgTriggersExcludeTables?: string[] | null | undefined;
+        pgViews?: string[] | undefined;
+        pgViewsExclude?: string[] | null | undefined;
         tablesWhereDataFilters?: Record<string, string> | undefined;
         schemaDiffOutput?: string | undefined;
         pgTriggersOutput?: string | undefined;
+        pgViewsOutput?: string | undefined;
         generateSql?: string | boolean | undefined;
         generatePgTriggers?: string | boolean | undefined;
+        generatePgViews?: string | boolean | undefined;
     }, {
         tables: string[];
         sourcePgHost: string;
@@ -219,15 +239,19 @@ export declare const configSchema: z.ZodObject<{
         schemaDiffExcludeTables?: string[] | null | undefined;
         pgTriggersTables?: string[] | undefined;
         pgTriggersExcludeTables?: string[] | null | undefined;
+        pgViews?: string[] | undefined;
+        pgViewsExclude?: string[] | null | undefined;
         ignoreColumns?: string[] | null | undefined;
         tablesWhereDataFilters?: Record<string, string> | undefined;
         skipMissingPk?: string | boolean | undefined;
         output?: string | undefined;
         schemaDiffOutput?: string | undefined;
         pgTriggersOutput?: string | undefined;
+        pgViewsOutput?: string | undefined;
         pretty?: string | boolean | undefined;
         generateSql?: string | boolean | undefined;
         generatePgTriggers?: string | boolean | undefined;
+        generatePgViews?: string | boolean | undefined;
     }>;
     apply: z.ZodObject<{
         destPgHost: z.ZodEffects<z.ZodString, string, string>;
@@ -302,11 +326,15 @@ export declare const configSchema: z.ZodObject<{
         schemaDiffExcludeTables?: string[] | null | undefined;
         pgTriggersTables?: string[] | undefined;
         pgTriggersExcludeTables?: string[] | null | undefined;
+        pgViews?: string[] | undefined;
+        pgViewsExclude?: string[] | null | undefined;
         tablesWhereDataFilters?: Record<string, string> | undefined;
         schemaDiffOutput?: string | undefined;
         pgTriggersOutput?: string | undefined;
+        pgViewsOutput?: string | undefined;
         generateSql?: string | boolean | undefined;
         generatePgTriggers?: string | boolean | undefined;
+        generatePgViews?: string | boolean | undefined;
     };
     apply: {
         destPgHost: string;
@@ -347,15 +375,19 @@ export declare const configSchema: z.ZodObject<{
         schemaDiffExcludeTables?: string[] | null | undefined;
         pgTriggersTables?: string[] | undefined;
         pgTriggersExcludeTables?: string[] | null | undefined;
+        pgViews?: string[] | undefined;
+        pgViewsExclude?: string[] | null | undefined;
         ignoreColumns?: string[] | null | undefined;
         tablesWhereDataFilters?: Record<string, string> | undefined;
         skipMissingPk?: string | boolean | undefined;
         output?: string | undefined;
         schemaDiffOutput?: string | undefined;
         pgTriggersOutput?: string | undefined;
+        pgViewsOutput?: string | undefined;
         pretty?: string | boolean | undefined;
         generateSql?: string | boolean | undefined;
         generatePgTriggers?: string | boolean | undefined;
+        generatePgViews?: string | boolean | undefined;
     };
     apply: {
         destPgHost: string;

package/dist/config/config-schema.js

@@ -46,6 +46,8 @@ exports.generatorConfigSchema = zod_1.z.object({
     schemaDiffExcludeTables: zod_1.z.array(envCapableListItem).nullable().optional(),
     pgTriggersTables: zod_1.z.array(envCapableListItem).optional(),
     pgTriggersExcludeTables: zod_1.z.array(envCapableListItem).nullable().optional(),
+    pgViews: zod_1.z.array(envCapableListItem).optional(),
+    pgViewsExclude: zod_1.z.array(envCapableListItem).nullable().optional(),
     ignoreColumns: zod_1.z.array(envCapableListItem).nullable().default([]),
     tablesWhereDataFilters: tableWhereDataFilters.optional(),
     includeDeletes: envCapableBoolean.default(true),
@@ -53,9 +55,11 @@ exports.generatorConfigSchema = zod_1.z.object({
     output: envCapableString.default("frg-data-diff.json"),
     schemaDiffOutput: envCapableString.optional(),
     pgTriggersOutput: envCapableString.optional(),
+    pgViewsOutput: envCapableString.optional(),
     pretty: envCapableBoolean.default(true),
     generateSql: envCapableBoolean.optional(),
     generatePgTriggers: envCapableBoolean.optional(),
+    generatePgViews: envCapableBoolean.optional(),
 });
 exports.applyConfigSchema = zod_1.z.object({
     destPgHost: envCapableString,

package/dist/config/load-config.d.ts

@@ -9,4 +9,5 @@ export declare function findConfigFile(cwd?: string): string | null;
  * Exits with a clear error if validation fails.
  */
 export declare function loadConfig(configPath: string): Config;
+export declare function stripJsonComments(input: string): string;
 //# sourceMappingURL=load-config.d.ts.map

package/dist/config/load-config.js

@@ -36,6 +36,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DEFAULT_CONFIG_FILENAME = void 0;
 exports.findConfigFile = findConfigFile;
 exports.loadConfig = loadConfig;
+exports.stripJsonComments = stripJsonComments;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const config_schema_1 = require("./config-schema");
@@ -67,7 +68,7 @@ function loadConfig(configPath) {
     }
     let parsed;
     try {
-        parsed = JSON.parse(raw);
+        parsed = JSON.parse(stripJsonComments(raw));
     }
     catch (err) {
         console.error(`Failed to parse config file as JSON: ${configPath}`);
@@ -84,4 +85,80 @@ function loadConfig(configPath) {
     }
     return result.data;
 }
+function stripJsonComments(input) {
+    let output = "";
+    let inString = false;
+    let escaped = false;
+    let inLineComment = false;
+    let inBlockComment = false;
+    for (let index = 0; index < input.length; index++) {
+        const char = input[index];
+        const next = input[index + 1];
+        if (inLineComment) {
+            if (isLineBreak(char)) {
+                inLineComment = false;
+                output += char;
+            }
+            else {
+                output += " ";
+            }
+            continue;
+        }
+        if (inBlockComment) {
+            if (char === "*" && next === "/") {
+                output += "  ";
+                index++;
+                inBlockComment = false;
+                continue;
+            }
+            if (isLineBreak(char)) {
+                output += char;
+            }
+            else {
+                output += " ";
+            }
+            continue;
+        }
+        if (inString) {
+            output += char;
+            if (escaped) {
+                escaped = false;
+                continue;
+            }
+            if (char === "\\") {
+                escaped = true;
+                continue;
+            }
+            if (char === '"') {
+                inString = false;
+            }
+            continue;
+        }
+        if (char === '"') {
+            inString = true;
+            output += char;
+            continue;
+        }
+        if (char === "/" && next === "/") {
+            output += "  ";
+            index++;
+            inLineComment = true;
+            continue;
+        }
+        if (char === "/" && next === "*") {
+            output += "  ";
+            index++;
+            inBlockComment = true;
+            continue;
+        }
+        output += char;
+    }
+    return output;
+}
+function isLineBreak(char) {
+    if (char === "\n") {
+        return true;
+    }
+    return char === "\r";
+}
 //# sourceMappingURL=load-config.js.map

package/dist/config/resolve-options.d.ts

@@ -22,6 +22,8 @@ export interface ResolvedGeneratorOptions {
     schemaDiffExcludeTables: string[];
     pgTriggersTables: string[];
     pgTriggersExcludeTables: string[];
+    pgViews: string[];
+    pgViewsExclude: string[];
     ignoreColumns: string[];
     tablesWhereDataFilters?: Record<string, string>;
     includeDeletes: boolean | string;
@@ -29,12 +31,14 @@ export interface ResolvedGeneratorOptions {
     output: string;
     schemaDiffOutput: string;
     pgTriggersOutput: string;
+    pgViewsOutput: string;
     pretty: boolean | string;
     generateSql?: boolean | string;
     generatePgTriggers?: boolean | string;
+    generatePgViews?: boolean | string;
     verbose: boolean;
 }
-export interface RuntimeGeneratorOptions extends Omit<ResolvedGeneratorOptions, "sourcePgSsl" | "destPgSsl" | "includeDeletes" | "skipMissingPk" | "pretty" | "generateSql" | "generatePgTriggers"> {
+export interface RuntimeGeneratorOptions extends Omit<ResolvedGeneratorOptions, "sourcePgSsl" | "destPgSsl" | "includeDeletes" | "skipMissingPk" | "pretty" | "generateSql" | "generatePgTriggers" | "generatePgViews"> {
     sourcePgSsl: boolean;
     destPgSsl: boolean;
     includeDeletes: boolean;
@@ -42,12 +46,14 @@ export interface RuntimeGeneratorOptions extends Omit<ResolvedGeneratorOptions,
     pretty: boolean;
     generateSql?: boolean;
     generatePgTriggers?: boolean;
+    generatePgViews?: boolean;
 }
 export type OptionalListInput = string[] | null;
-export type GeneratorOptionInput = Partial<Omit<ResolvedGeneratorOptions, "excludeTables" | "schemaDiffExcludeTables" | "pgTriggersExcludeTables" | "ignoreColumns"> & {
+export type GeneratorOptionInput = Partial<Omit<ResolvedGeneratorOptions, "excludeTables" | "schemaDiffExcludeTables" | "pgTriggersExcludeTables" | "pgViewsExclude" | "ignoreColumns"> & {
     excludeTables: OptionalListInput;
     schemaDiffExcludeTables: OptionalListInput;
     pgTriggersExcludeTables: OptionalListInput;
+    pgViewsExclude: OptionalListInput;
     ignoreColumns: OptionalListInput;
 }>;
 /**

package/dist/config/resolve-options.js

@@ -18,6 +18,8 @@ function resolveGeneratorOptions(config, cliArgs) {
         schemaDiffExcludeTables: [],
         pgTriggersTables: [],
         pgTriggersExcludeTables: [],
+        pgViews: [],
+        pgViewsExclude: [],
         ignoreColumns: [],
         tablesWhereDataFilters: {},
         includeDeletes: true,
@@ -25,6 +27,7 @@ function resolveGeneratorOptions(config, cliArgs) {
         output: "frg-data-diff.json",
         schemaDiffOutput: "frg-schema-diff.json",
         pgTriggersOutput: "frg-triggers-diff.sql",
+        pgViewsOutput: "frg-views-diff.sql",
         pretty: true,
         verbose: false,
     };
@@ -34,6 +37,8 @@ function resolveGeneratorOptions(config, cliArgs) {
     const schemaDiffExcludeTables = resolveOptionalListOption(cliArgs.schemaDiffExcludeTables, config?.schemaDiffExcludeTables, excludeTables);
     const pgTriggersTables = resolveInheritedTableListOption(cliArgs.pgTriggersTables, config?.pgTriggersTables, tables);
     const pgTriggersExcludeTables = resolveOptionalListOption(cliArgs.pgTriggersExcludeTables, config?.pgTriggersExcludeTables, excludeTables);
+    const pgViews = resolveListOption(cliArgs.pgViews, config?.pgViews, defaults.pgViews);
+    const pgViewsExclude = resolveOptionalListOption(cliArgs.pgViewsExclude, config?.pgViewsExclude, defaults.pgViewsExclude);
     const ignoreColumns = resolveOptionalListOption(cliArgs.ignoreColumns, config?.ignoreColumns, defaults.ignoreColumns);
     return {
         sourcePgHost: cliArgs.sourcePgHost ?? config?.sourcePgHost ?? "",
@@ -55,6 +60,8 @@ function resolveGeneratorOptions(config, cliArgs) {
         schemaDiffExcludeTables,
         pgTriggersTables,
         pgTriggersExcludeTables,
+        pgViews,
+        pgViewsExclude,
         ignoreColumns,
         tablesWhereDataFilters: cliArgs.tablesWhereDataFilters ??
             config?.tablesWhereDataFilters ??
@@ -70,12 +77,25 @@ function resolveGeneratorOptions(config, cliArgs) {
         pgTriggersOutput: cliArgs.pgTriggersOutput ??
             config?.pgTriggersOutput ??
             defaults.pgTriggersOutput,
+        pgViewsOutput: cliArgs.pgViewsOutput ??
+            config?.pgViewsOutput ??
+            defaults.pgViewsOutput,
         pretty: cliArgs.pretty ?? config?.pretty ?? defaults.pretty,
         generateSql: cliArgs.generateSql ?? config?.generateSql,
         generatePgTriggers: cliArgs.generatePgTriggers ?? config?.generatePgTriggers,
+        generatePgViews: cliArgs.generatePgViews ?? config?.generatePgViews,
         verbose: cliArgs.verbose ?? defaults.verbose,
     };
 }
+function resolveListOption(cliValue, configValue, fallback) {
+    if (cliValue !== undefined) {
+        return cliValue;
+    }
+    if (configValue !== undefined) {
+        return configValue;
+    }
+    return fallback;
+}
 function resolveOptionalListOption(cliValue, configValue, fallback) {
     if (cliValue !== undefined) {
         return cliValue ?? [];
@@ -137,6 +157,10 @@ function resolveRuntimeGeneratorOptions(options) {
     if (options.generatePgTriggers !== undefined) {
         generatePgTriggers = (0, env_values_1.resolveBooleanValue)(options.generatePgTriggers, "generate pg triggers");
     }
+    let generatePgViews;
+    if (options.generatePgViews !== undefined) {
+        generatePgViews = (0, env_values_1.resolveBooleanValue)(options.generatePgViews, "generate pg views");
+    }
     return {
         ...options,
         schema: (0, env_values_1.resolveStringValue)(options.schema, "schema"),
@@ -146,6 +170,8 @@ function resolveRuntimeGeneratorOptions(options) {
         schemaDiffExcludeTables: (0, env_values_1.resolveListValues)(options.schemaDiffExcludeTables, "schema diff exclude tables"),
         pgTriggersTables: (0, env_values_1.resolveListValues)(options.pgTriggersTables, "pg triggers tables"),
         pgTriggersExcludeTables: (0, env_values_1.resolveListValues)(options.pgTriggersExcludeTables, "pg triggers exclude tables"),
+        pgViews: (0, env_values_1.resolveListValues)(options.pgViews, "pg views"),
+        pgViewsExclude: (0, env_values_1.resolveListValues)(options.pgViewsExclude, "pg views exclude"),
         ignoreColumns: (0, env_values_1.resolveListValues)(options.ignoreColumns, "ignored columns"),
         sourcePgSsl: (0, env_values_1.resolveBooleanValue)(options.sourcePgSsl, "source ssl"),
         destPgSsl: (0, env_values_1.resolveBooleanValue)(options.destPgSsl, "destination ssl"),
@@ -154,9 +180,11 @@ function resolveRuntimeGeneratorOptions(options) {
         output: (0, env_values_1.resolveStringValue)(options.output, "output file"),
         schemaDiffOutput: (0, env_values_1.resolveStringValue)(options.schemaDiffOutput, "schema diff output file"),
         pgTriggersOutput: (0, env_values_1.resolveStringValue)(options.pgTriggersOutput, "pg triggers output file"),
+        pgViewsOutput: (0, env_values_1.resolveStringValue)(options.pgViewsOutput, "pg views output file"),
         pretty: (0, env_values_1.resolveBooleanValue)(options.pretty, "pretty-print json"),
         generateSql,
         generatePgTriggers,
+        generatePgViews,
     };
 }
 function resolveRuntimeApplyOptions(options) {

package/dist/config/write-config.d.ts

@@ -1,8 +1,9 @@
 import { type ResolvedGeneratorOptions, type ResolvedApplyOptions, type OptionalListInput } from "./resolve-options";
-type WritableGeneratorOptions = Omit<ResolvedGeneratorOptions, "excludeTables" | "schemaDiffExcludeTables" | "pgTriggersExcludeTables" | "ignoreColumns"> & {
+type WritableGeneratorOptions = Omit<ResolvedGeneratorOptions, "excludeTables" | "schemaDiffExcludeTables" | "pgTriggersExcludeTables" | "pgViewsExclude" | "ignoreColumns"> & {
     excludeTables: OptionalListInput;
     schemaDiffExcludeTables: OptionalListInput;
     pgTriggersExcludeTables: OptionalListInput;
+    pgViewsExclude: OptionalListInput;
     ignoreColumns: OptionalListInput;
 };
 /**

package/dist/config/write-config.js

@@ -62,15 +62,19 @@ function buildConfigFile(generatorOptions, applyOptions) {
         schemaDiffExcludeTables: generatorOptions.schemaDiffExcludeTables ?? [],
         pgTriggersTables: generatorOptions.pgTriggersTables,
         pgTriggersExcludeTables: generatorOptions.pgTriggersExcludeTables ?? [],
+        pgViews: generatorOptions.pgViews,
+        pgViewsExclude: generatorOptions.pgViewsExclude ?? [],
         ignoreColumns: generatorOptions.ignoreColumns ?? [],
         includeDeletes: generatorOptions.includeDeletes,
         skipMissingPk: generatorOptions.skipMissingPk,
         output: generatorOptions.output,
         schemaDiffOutput: generatorOptions.schemaDiffOutput,
         pgTriggersOutput: generatorOptions.pgTriggersOutput,
+        pgViewsOutput: generatorOptions.pgViewsOutput,
         pretty: generatorOptions.pretty,
         generateSql: generatorOptions.generateSql,
         generatePgTriggers: generatorOptions.generatePgTriggers,
+        generatePgViews: generatorOptions.generatePgViews,
     };
     return {
         format: "frg-data-diff-config/v1",

package/dist/db/pg-views.d.ts

@@ -0,0 +1,24 @@
+import { type Pool, type PoolClient } from "pg";
+export type PgViewType = "view" | "materialized_view";
+export interface PgViewInfo {
+    viewSchema: string;
+    viewName: string;
+    viewType: PgViewType;
+    viewDefinition: string;
+}
+export interface FetchPgViewsOptions {
+    onViewStart?: (viewName: string, viewPosition: number, totalViews: number) => void;
+}
+export interface ResolvedPgViewPatterns {
+    views: string[];
+    excludedViews: string[];
+}
+/**
+ * Lists regular and materialized views in the given schema.
+ */
+export declare function listPgViews(client: PoolClient, schema: string): Promise<string[]>;
+export declare function fetchPgView(client: PoolClient, schema: string, viewName: string): Promise<PgViewInfo | undefined>;
+export declare function fetchPgViews(client: PoolClient, schema: string, views: string[], options?: FetchPgViewsOptions): Promise<PgViewInfo[]>;
+export declare function resolvePgViewPatterns(sourcePool: Pool, destPool: Pool, schema: string, includePatterns: string[], excludePatterns: string[]): Promise<ResolvedPgViewPatterns>;
+export declare function resolvePgViewPatternsFromViewLists(sourceViews: string[], destViews: string[], includePatterns: string[], excludePatterns: string[]): ResolvedPgViewPatterns;
+//# sourceMappingURL=pg-views.d.ts.map

package/dist/db/pg-views.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listPgViews = listPgViews;
+exports.fetchPgView = fetchPgView;
+exports.fetchPgViews = fetchPgViews;
+exports.resolvePgViewPatterns = resolvePgViewPatterns;
+exports.resolvePgViewPatternsFromViewLists = resolvePgViewPatternsFromViewLists;
+/**
+ * Lists regular and materialized views in the given schema.
+ */
+async function listPgViews(client, schema) {
+    const result = await client.query(`
+    SELECT cls.relname AS view_name
+    FROM pg_class cls
+    JOIN pg_namespace ns ON ns.oid = cls.relnamespace
+    WHERE ns.nspname = $1
+      AND cls.relkind IN ('v', 'm')
+    ORDER BY cls.relname
+    `, [schema]);
+    return result.rows.map((row) => row.view_name);
+}
+async function fetchPgView(client, schema, viewName) {
+    const result = await client.query(`
+    SELECT
+      ns.nspname AS view_schema,
+      cls.relname AS view_name,
+      CASE cls.relkind
+        WHEN 'm' THEN 'materialized_view'
+        ELSE 'view'
+      END AS view_type,
+      pg_get_viewdef(cls.oid, true) AS view_definition
+    FROM pg_class cls
+    JOIN pg_namespace ns ON ns.oid = cls.relnamespace
+    WHERE ns.nspname = $1
+      AND cls.relname = $2
+      AND cls.relkind IN ('v', 'm')
+    `, [schema, viewName]);
+    const row = result.rows[0];
+    if (!row) {
+        return undefined;
+    }
+    return {
+        viewSchema: row.view_schema,
+        viewName: row.view_name,
+        viewType: row.view_type,
+        viewDefinition: row.view_definition,
+    };
+}
+async function fetchPgViews(client, schema, views, options = {}) {
+    const results = [];
+    for (const [viewIndex, viewName] of views.entries()) {
+        if (options.onViewStart) {
+            options.onViewStart(viewName, viewIndex + 1, views.length);
+        }
+        const view = await fetchPgView(client, schema, viewName);
+        if (view) {
+            results.push(view);
+        }
+    }
+    return results;
+}
+async function resolvePgViewPatterns(sourcePool, destPool, schema, includePatterns, excludePatterns) {
+    const [sourceClient, destClient] = await Promise.all([
+        sourcePool.connect(),
+        destPool.connect(),
+    ]);
+    try {
+        const [sourceViews, destViews] = await Promise.all([
+            listPgViews(sourceClient, schema),
+            listPgViews(destClient, schema),
+        ]);
+        return resolvePgViewPatternsFromViewLists(sourceViews, destViews, includePatterns, excludePatterns);
+    }
+    finally {
+        sourceClient.release();
+        destClient.release();
+    }
+}
+function resolvePgViewPatternsFromViewLists(sourceViews, destViews, includePatterns, excludePatterns) {
+    const sourceSet = new Set(sourceViews);
+    const destSet = new Set(destViews);
+    const availableViews = Array.from(new Set([...sourceViews, ...destViews])).sort();
+    let requestedPatterns = includePatterns;
+    if (requestedPatterns.length === 0) {
+        requestedPatterns = ["*"];
+    }
+    const resolvedViews = [];
+    for (const pattern of requestedPatterns) {
+        const matches = resolvePattern(pattern, availableViews);
+        if (matches.length > 0) {
+            addUniqueMatches(resolvedViews, matches);
+            continue;
+        }
+        if (hasWildcard(pattern)) {
+            if (availableViews.length === 0 || pattern === "*") {
+                continue;
+            }
+            throw new Error(`View pattern "${pattern}" matched no views.`);
+        }
+        const missingFrom = [];
+        if (!sourceSet.has(pattern)) {
+            missingFrom.push("source");
+        }
+        if (!destSet.has(pattern)) {
+            missingFrom.push("destination");
+        }
+        throw new Error(`View "${pattern}" was not found in the ${missingFrom.join(" and ")} database.`);
+    }
+    const excludedViews = Array.from(new Set(excludePatterns.flatMap((pattern) => resolvePattern(pattern, resolvedViews))));
+    const views = resolvedViews.filter((view) => !excludedViews.includes(view));
+    return { views, excludedViews };
+}
+function addUniqueMatches(values, matches) {
+    for (const match of matches) {
+        if (!values.includes(match)) {
+            values.push(match);
+        }
+    }
+}
+function resolvePattern(pattern, availableViews) {
+    if (!hasWildcard(pattern)) {
+        if (availableViews.includes(pattern)) {
+            return [pattern];
+        }
+        return [];
+    }
+    const matcher = buildWildcardRegex(pattern);
+    return availableViews.filter((view) => matcher.test(view));
+}
+function hasWildcard(pattern) {
+    return pattern.includes("*");
+}
+function buildWildcardRegex(pattern) {
+    const escaped = pattern.replace(/[|\\{}()[\]^$+?.]/g, "\\$&");
+    return new RegExp(`^${escaped.replace(/\*/g, ".*")}$`);
+}
+//# sourceMappingURL=pg-views.js.map

package/dist/diff/pg-views-diff.d.ts

@@ -0,0 +1,11 @@
+import { type Pool } from "pg";
+export interface GeneratePgViewsDiffOptions {
+    schema: string;
+    views: string[];
+    excludeViews: string[];
+    verbose: boolean;
+    onProgress?: (message: string) => void;
+    onVerboseProgress?: (message: string) => void;
+}
+export declare function generatePgViewsDiffSql(sourcePool: Pool, destPool: Pool, options: GeneratePgViewsDiffOptions): Promise<string>;
+//# sourceMappingURL=pg-views-diff.d.ts.map