@onreza/sqlx-js 0.1.0 → 0.2.0

package/dist/src/commands/migrate.d.ts

@@ -3,9 +3,22 @@ export type MigrateOptions = {
     databaseUrl: string;
     migrationsDir: string;
 };
+export type MigrationWorkflowOptions = MigrateOptions & {
+    root: string;
+    cacheDir: string;
+    dtsPath: string;
+    prune?: boolean;
+    shadowUrl?: string;
+    shadowAdminUrl?: string;
+    lockKey?: number | bigint;
+    lockTimeoutMs?: number;
+};
+export type MigrationStore = {
+    table: string;
+};
 export declare const DEFAULT_MIGRATE_LOCK_KEY = 18750938867203960n;
-export declare function ensureTable(c: PgClient): Promise<void>;
-export declare function listApplied(c: PgClient): Promise<Map<number, {
+export declare function ensureTable(c: PgClient): Promise<MigrationStore>;
+export declare function listApplied(c: PgClient, store?: MigrationStore): Promise<Map<number, {
     name: string;
     hash: string;
 }>>;
@@ -13,6 +26,11 @@ export type ApplyOutcome = {
     kind: "applied";
     version: number;
     name: string;
+} | {
+    kind: "adopted";
+    version: number;
+    name: string;
+    replaced: number;
 } | {
     kind: "tampered";
     version: number;
@@ -25,6 +43,123 @@ export type ApplyOutcome = {
     name: string;
     error: string;
 };
+export type PlanOutcome = {
+    kind: "pending";
+    version: number;
+    name: string;
+} | {
+    kind: "adoptable";
+    version: number;
+    name: string;
+    replaced: number;
+} | {
+    kind: "tampered";
+    version: number;
+    name: string;
+    applied: string;
+    current: string;
+} | {
+    kind: "failed";
+    version: number;
+    name: string;
+    error: string;
+};
+export type MigrationPlanItem = {
+    kind: "apply";
+    version: number;
+    name: string;
+} | {
+    kind: "adopt";
+    version: number;
+    name: string;
+    replaced: number;
+};
+export type MigrationPlanDiagnostic = Extract<PlanOutcome, {
+    kind: "tampered" | "failed";
+}>;
+export type MigrationPlanSnapshot = {
+    ok: boolean;
+    pending: number;
+    adoptable: number;
+    tampered: number;
+    failed: number;
+    steps: MigrationPlanItem[];
+    diagnostics: MigrationPlanDiagnostic[];
+};
+export type MigrationInfoStatus = "applied" | "pending" | "adoptable" | "superseded" | "tampered" | "failed";
+export type MigrationInfoItem = {
+    version: number;
+    name: string;
+    status: MigrationInfoStatus;
+    detail?: string;
+};
+export type MigrationInfoSnapshot = {
+    historyTable: string | null;
+    summary: Record<MigrationInfoStatus, number>;
+    items: MigrationInfoItem[];
+};
+export type MigrationArchive = {
+    name: string;
+    path: string;
+    files: string[];
+};
+export type MigrationCheckIssue = {
+    severity: "error";
+    code: "invalid-file-name" | "invalid-version" | "duplicate-version" | "orphan-down" | "invalid-squash-metadata" | "invalid-squash-replacement" | "tampered-squash-replacement";
+    message: string;
+    file?: string;
+    version?: number;
+    name?: string;
+};
+export type MigrationCheckReport = {
+    ok: boolean;
+    migrations: number;
+    archives: number;
+    issues: MigrationCheckIssue[];
+};
+export type SchemaObjectDiff = {
+    added: string[];
+    removed: string[];
+    changed: string[];
+};
+export type SchemaDiffSummary = {
+    relations: SchemaObjectDiff;
+    types: SchemaObjectDiff;
+    functions: SchemaObjectDiff;
+};
+export type RevertDryRunPhase = "validate" | "begin" | "isolate" | "previous-up" | "snapshot-before" | "target-up" | "down" | "snapshot-after" | "rollback";
+export type RevertDryRunOutcome = {
+    kind: "noop";
+} | {
+    kind: "no-down";
+    version: number;
+    name: string;
+} | {
+    kind: "passed";
+    version: number;
+    name: string;
+} | {
+    kind: "schema-mismatch";
+    version: number;
+    name: string;
+    diff: SchemaDiffSummary;
+} | {
+    kind: "failed";
+    version?: number;
+    name?: string;
+    phase: RevertDryRunPhase;
+    error: string;
+};
+export declare function checkMigrationFiles(migrationsDir: string): MigrationCheckReport;
+export declare function planPending(c: PgClient, migrationsDir: string, onEvent?: (e: PlanOutcome) => void): Promise<{
+    pending: number;
+    adoptable: number;
+    tampered: number;
+    failed: number;
+    steps: MigrationPlanItem[];
+}>;
+export declare function inspectMigrationPlan(c: PgClient, migrationsDir: string): Promise<MigrationPlanSnapshot>;
+export declare function inspectMigrations(c: PgClient, migrationsDir: string): Promise<MigrationInfoSnapshot>;
 export declare function applyPending(c: PgClient, migrationsDir: string, onEvent?: (e: ApplyOutcome) => void): Promise<{
     applied: number;
     tampered: number;
@@ -32,11 +167,53 @@ export declare function applyPending(c: PgClient, migrationsDir: string, onEvent
 }>;
 export declare function acquireMigrateLock(c: PgClient, lockKey?: number | bigint, timeoutMs?: number): Promise<void>;
 export declare function releaseMigrateLock(c: PgClient, lockKey?: number | bigint): Promise<void>;
+export declare function sanitizePgDumpSchema(sql: string): string;
+export declare function listMigrationArchives(migrationsDir: string): MigrationArchive[];
+export declare function restoreMigrationArchive(migrationsDir: string, archiveName: string, opts?: {
+    force?: boolean;
+}): {
+    archiveName: string;
+    restored: string[];
+};
+export declare function createSquashMigration(opts: {
+    migrationsDir: string;
+    name: string;
+    schemaSql: string;
+    replace?: boolean;
+}): {
+    version: number;
+    name: string;
+    upPath: string;
+    replaced: number;
+    archiveDir?: string;
+};
+export declare function dumpSchema(databaseUrl: string, pgDumpPath?: string): string;
+export declare function migrateSquash(opts: {
+    databaseUrl?: string;
+    migrationsDir: string;
+    name: string;
+    shadowUrl?: string;
+    shadowAdminUrl?: string;
+    replace?: boolean;
+    pgDumpPath?: string;
+    lockKey?: number | bigint;
+    lockTimeoutMs?: number;
+}): Promise<void>;
 export declare function migrateRun(opts: MigrateOptions & {
     lockKey?: number | bigint;
     lockTimeoutMs?: number;
+    dryRun?: boolean;
+    json?: boolean;
+}): Promise<void>;
+export declare function migrateInfo(opts: MigrateOptions & {
+    json?: boolean;
 }): Promise<void>;
-export declare function migrateInfo(opts: MigrateOptions): Promise<void>;
+export declare function migrateCheck(opts: {
+    migrationsDir: string;
+    json?: boolean;
+}): void;
+export declare function migrateDev(opts: MigrationWorkflowOptions): Promise<void>;
+export declare function migrateVerify(opts: MigrationWorkflowOptions): Promise<void>;
 export type RevertOutcome = {
     kind: "noop";
 } | {
@@ -54,10 +231,20 @@ export type RevertOutcome = {
     error: string;
 };
 export declare function revertLast(c: PgClient, migrationsDir: string): Promise<RevertOutcome>;
+export declare function checkLastDownMigration(c: PgClient, migrationsDir: string): Promise<RevertDryRunOutcome>;
 export declare function migrateRevert(opts: MigrateOptions & {
     lockKey?: number | bigint;
     lockTimeoutMs?: number;
+    dryRun?: boolean;
+    shadowUrl?: string;
+    shadowAdminUrl?: string;
+    json?: boolean;
 }): Promise<void>;
+export declare function migrateArchiveList(opts: Pick<MigrateOptions, "migrationsDir">): void;
+export declare function migrateArchiveRestore(opts: Pick<MigrateOptions, "migrationsDir"> & {
+    name: string;
+    force?: boolean;
+}): void;
 export declare function migrateAdd(opts: MigrateOptions & {
     name: string;
 }): void;