@owlmeans/postgres-resource 0.1.18-rc.42 → 0.1.18-rc.43

package/build/utils/diff/types.d.ts

@@ -0,0 +1,40 @@
+import type { BasicContext } from '@owlmeans/context';
+import type { DdlPlan, DdlStatement, LiveTable, TableSpec } from '../../types.js';
+/** Structure reconciliation: the DDL that converges a live table onto its compiled spec. */
+export interface PgDiffHelper {
+    /**
+     * The form an index or constraint definition is compared in, so the statement this package emits
+     * and the text Postgres reports for the object it created compare equal.
+     *
+     * Postgres deparses what it stores: it leaves an identifier unquoted when it can, casts every
+     * literal (`''::text`), casts a `varchar` column inside an expression, wraps a partial predicate and
+     * each of its operator expressions in parentheses, and rewrites `x IN (…)` as `x = ANY (ARRAY[…])`.
+     * Comparing the raw texts made every boot drop and recreate every declared index and every enum
+     * `CHECK`. So both sides lose case, quotes, casts, whitespace and parentheses, and `= ANY (ARRAY[…])`
+     * reads as `IN (…)`. What that cannot tell apart — two definitions differing only in how their
+     * operators group — is a change to make under a new name.
+     */
+    canonicalDefinition: (definition: string) => string;
+    /**
+     * Foreign keys are planned separately from the rest of the table, and applied only once
+     * every resource has initialized: a key points at a table another resource owns, and that
+     * resource's own `init()` may not have run yet.
+     *
+     * @throws {PostgresPlaceholderError} when a target can't be resolved.
+     */
+    planForeignKeys: (spec: TableSpec, context?: BasicContext<any>) => DdlStatement[];
+    /**
+     * Compare the compiled specification against the live table and produce the ordered DDL
+     * that converges one onto the other.
+     *
+     * Statement order is load bearing:
+     *  - `DROP COLUMN` is last, because a `USING` cast or a backfill may legitimately read a
+     *    column that is about to disappear.
+     *  - A primary key constraint is never dropped: it cascades into every referencing key and
+     *    can't be undone inside the same transaction once dependents exist.
+     *
+     * Foreign keys are not part of the plan at all — see {@link PgDiffHelper.planForeignKeys}.
+     */
+    planSync: (spec: TableSpec, live: LiveTable, additive?: boolean) => DdlPlan;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/utils/diff/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/utils/diff/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAEjF,4FAA4F;AAC5F,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;;;OAWG;IACH,mBAAmB,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,MAAM,CAAA;IACnD;;;;;;OAMG;IACH,eAAe,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,GAAG,CAAC,KAAK,YAAY,EAAE,CAAA;IACjF;;;;;;;;;;;OAWG;IACH,QAAQ,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,CAAC,EAAE,OAAO,KAAK,OAAO,CAAA;CAC5E"}

package/build/utils/diff/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/utils/diff/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/utils/diff/types.ts"],"names":[],"mappings":""}

package/build/utils/diff.d.ts

@@ -1,37 +1,7 @@
-import type { BasicContext } from '@owlmeans/context';
-import type { DdlPlan, DdlStatement, LiveTable, TableSpec } from '../types.js';
-/**
- * The form an index or constraint definition is compared in, so the statement this package emits
- * and the text Postgres reports for the object it created compare equal.
- *
- * Postgres deparses what it stores: it leaves an identifier unquoted when it can, casts every
- * literal (`''::text`), casts a `varchar` column inside an expression, wraps a partial predicate and
- * each of its operator expressions in parentheses, and rewrites `x IN (…)` as `x = ANY (ARRAY[…])`.
- * Comparing the raw texts made every boot drop and recreate every declared index and every enum
- * `CHECK`. So both sides lose case, quotes, casts, whitespace and parentheses, and `= ANY (ARRAY[…])`
- * reads as `IN (…)`. What that cannot tell apart — two definitions differing only in how their
- * operators group — is a change to make under a new name.
- */
-export declare const canonicalDefinition: (definition: string) => string;
-/**
- * Foreign keys are planned separately from the rest of the table, and applied only once
- * every resource has initialized: a key points at a table another resource owns, and that
- * resource's own `init()` may not have run yet.
- *
- * @throws {PostgresPlaceholderError} when a target can't be resolved.
- */
-export declare const planForeignKeys: (spec: TableSpec, context?: BasicContext<any>) => DdlStatement[];
-/**
- * Compare the compiled specification against the live table and produce the ordered DDL
- * that converges one onto the other.
- *
- * Statement order is load bearing:
- *  - `DROP COLUMN` is last, because a `USING` cast or a backfill may legitimately read a
- *    column that is about to disappear.
- *  - A primary key constraint is never dropped: it cascades into every referencing key and
- *    can't be undone inside the same transaction once dependents exist.
- *
- * Foreign keys are not part of the plan at all — see {@link planForeignKeys}.
- */
+import type { DdlPlan, LiveTable, TableSpec } from '../types.js';
+import type { PgDiffHelper } from './diff/types.js';
+export declare const createPgDiffHelper: () => PgDiffHelper;
+export declare const pgDiffHelper: PgDiffHelper;
+/** @deprecated compat:factory-refactor — use `pgDiffHelper.planSync(…)` */
 export declare const planSync: (spec: TableSpec, live: LiveTable, additive?: boolean) => DdlPlan;
 //# sourceMappingURL=diff.d.ts.map

package/build/utils/diff.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"diff.d.ts","sourceRoot":"","sources":["../../src/utils/diff.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAKrD,OAAO,KAAK,EACE,OAAO,EAAE,YAAY,EAAE,SAAS,EAAiC,SAAS,EACvF,MAAM,aAAa,CAAA;AAkCpB;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,mBAAmB,eAAgB,MAAM,KAAG,MAKb,CAAA;AAyB5C;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,SACpB,SAAS,YAAY,YAAY,CAAC,GAAG,CAAC,KAC3C,YAAY,EAwCb,CAAA;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,QAAQ,SACb,SAAS,QAAQ,SAAS,aAAY,OAAO,KAClD,OAwPF,CAAA"}
+{"version":3,"file":"diff.d.ts","sourceRoot":"","sources":["../../src/utils/diff.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACE,OAAO,EAAgB,SAAS,EAAiC,SAAS,EACvF,MAAM,aAAa,CAAA;AAGpB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAEnD,eAAO,MAAM,kBAAkB,QAAO,YA8XrC,CAAA;AAED,eAAO,MAAM,YAAY,cAAuB,CAAA;AAEhD,2EAA2E;AAC3E,eAAO,MAAM,QAAQ,SAAU,SAAS,QAAQ,SAAS,aAAY,OAAO,KAAW,OAC1C,CAAA"}