zenstack-kit 0.1.1

package/dist/migrations.d.ts

@@ -0,0 +1,161 @@
+/**
+ * Migration generation and management
+ *
+ * Creates and manages database migrations based on ZenStack schema changes
+ * using AST-based diffs and Kysely schema builder operations.
+ */
+import { type SchemaTable, type SchemaColumn } from "./schema-snapshot.js";
+export interface MigrationOptions {
+    /** Migration name */
+    name?: string;
+    /** Path to ZenStack schema file */
+    schemaPath: string;
+    /** Output directory for migration files */
+    outputPath: string;
+    /** Optional snapshot file override */
+    snapshotPath?: string;
+    /** Table rename mappings */
+    renameTables?: Array<{
+        from: string;
+        to: string;
+    }>;
+    /** Column rename mappings */
+    renameColumns?: Array<{
+        table: string;
+        from: string;
+        to: string;
+    }>;
+}
+export interface Migration {
+    /** Migration filename */
+    filename: string;
+    /** Kysely schema builder up migration */
+    up: string;
+    /** Kysely schema builder down migration */
+    down: string;
+    /** Timestamp */
+    timestamp: number;
+}
+interface FieldChange {
+    model: SchemaTable;
+    tableName: string;
+    columnName: string;
+    previous: SchemaColumn;
+    current: SchemaColumn;
+    changes: {
+        typeChanged: boolean;
+        requiredChanged: boolean;
+        defaultChanged: boolean;
+        listChanged: boolean;
+    };
+}
+interface DiffResult {
+    addedModels: SchemaTable[];
+    removedModels: SchemaTable[];
+    addedFields: Array<{
+        model: SchemaTable;
+        tableName: string;
+        field: SchemaColumn;
+        columnName: string;
+    }>;
+    removedFields: Array<{
+        model: SchemaTable;
+        tableName: string;
+        field: SchemaColumn;
+        columnName: string;
+    }>;
+    alteredFields: FieldChange[];
+    renamedTables: Array<{
+        from: string;
+        to: string;
+    }>;
+    renamedColumns: Array<{
+        tableName: string;
+        from: string;
+        to: string;
+    }>;
+    addedUniqueConstraints: Array<{
+        tableName: string;
+        constraint: {
+            name: string;
+            columns: string[];
+        };
+    }>;
+    removedUniqueConstraints: Array<{
+        tableName: string;
+        constraint: {
+            name: string;
+            columns: string[];
+        };
+    }>;
+    addedIndexes: Array<{
+        tableName: string;
+        index: {
+            name: string;
+            columns: string[];
+        };
+    }>;
+    removedIndexes: Array<{
+        tableName: string;
+        index: {
+            name: string;
+            columns: string[];
+        };
+    }>;
+    addedForeignKeys: Array<{
+        tableName: string;
+        foreignKey: {
+            name: string;
+            columns: string[];
+            referencedTable: string;
+            referencedColumns: string[];
+        };
+    }>;
+    removedForeignKeys: Array<{
+        tableName: string;
+        foreignKey: {
+            name: string;
+            columns: string[];
+            referencedTable: string;
+            referencedColumns: string[];
+        };
+    }>;
+    primaryKeyChanges: Array<{
+        tableName: string;
+        previous?: {
+            name: string;
+            columns: string[];
+        };
+        current?: {
+            name: string;
+            columns: string[];
+        };
+    }>;
+}
+export declare function getSchemaDiff(options: MigrationOptions): Promise<DiffResult>;
+export declare function hasSchemaChanges(options: MigrationOptions): Promise<boolean>;
+export interface InitSnapshotOptions {
+    /** Path to ZenStack schema file */
+    schemaPath: string;
+    /** Output directory for migrations (snapshot will be in meta subfolder) */
+    outputPath: string;
+    /** Optional snapshot file override */
+    snapshotPath?: string;
+}
+export interface InitSnapshotResult {
+    /** Path to the created snapshot file */
+    snapshotPath: string;
+    /** Number of tables in the snapshot */
+    tableCount: number;
+}
+/**
+ * Initialize a snapshot from the current schema without generating a migration.
+ * Use this to baseline an existing database before starting to track migrations.
+ */
+export declare function initSnapshot(options: InitSnapshotOptions): Promise<InitSnapshotResult>;
+/**
+ * Create a migration file from schema changes
+ */
+export declare function createMigration(options: MigrationOptions): Promise<Migration | null>;
+export {};
+//# sourceMappingURL=migrations.d.ts.map

package/dist/migrations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrations.d.ts","sourceRoot":"","sources":["../src/migrations.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,EAGL,KAAK,WAAW,EAChB,KAAK,YAAY,EAGlB,MAAM,sBAAsB,CAAC;AAE9B,MAAM,WAAW,gBAAgB;IAC/B,qBAAqB;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,2CAA2C;IAC3C,UAAU,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,4BAA4B;IAC5B,YAAY,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACnD,6BAA6B;IAC7B,aAAa,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACpE;AAED,MAAM,WAAW,SAAS;IACxB,yBAAyB;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,yCAAyC;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,UAAU,WAAW;IACnB,KAAK,EAAE,WAAW,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,YAAY,CAAC;IACtB,OAAO,EAAE;QACP,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;QACzB,cAAc,EAAE,OAAO,CAAC;QACxB,WAAW,EAAE,OAAO,CAAC;KACtB,CAAC;CACH;AAED,UAAU,UAAU;IAClB,WAAW,EAAE,WAAW,EAAE,CAAC;IAC3B,aAAa,EAAE,WAAW,EAAE,CAAC;IAC7B,WAAW,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,WAAW,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,YAAY,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACvG,aAAa,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,WAAW,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,YAAY,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACzG,aAAa,EAAE,WAAW,EAAE,CAAC;IAC7B,aAAa,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACnD,cAAc,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACvE,sBAAsB,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,EAAE,CAAA;SAAE,CAAA;KAAE,CAAC,CAAC;IACtG,wBAAwB,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,EAAE,CAAA;SAAE,CAAA;KAAE,CAAC,CAAC;IACxG,YAAY,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,EAAE,CAAA;SAAE,CAAA;KAAE,CAAC,CAAC;IACvF,cAAc,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,EAAE,CAAA;SAAE,CAAA;KAAE,CAAC,CAAC;IACzF,gBAAgB,EAAE,KAAK,CAAC;QACtB,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,EAAE,CAAC;YAAC,eAAe,EAAE,MAAM,CAAC;YAAC,iBAAiB,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC;KACvG,CAAC,CAAC;IACH,kBAAkB,EAAE,KAAK,CAAC;QACxB,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,EAAE,CAAC;YAAC,eAAe,EAAE,MAAM,CAAC;YAAC,iBAAiB,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC;KACvG,CAAC,CAAC;IACH,iBAAiB,EAAE,KAAK,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC;QAC/C,OAAO,CAAC,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,OAAO,EAAE,MAAM,EAAE,CAAA;SAAE,CAAC;KAC/C,CAAC,CAAC;CACJ;AA+sBD,wBAAsB,aAAa,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC,CASlF;AAED,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAmBlF;AAED,MAAM,WAAW,mBAAmB;IAClC,mCAAmC;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,2EAA2E;IAC3E,UAAU,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,wCAAwC;IACxC,YAAY,EAAE,MAAM,CAAC;IACrB,uCAAuC;IACvC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,wBAAsB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAU5F;AAED;;GAEG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,SAAS,GAAG,IAAI,CAAC,CAuD1F"}