sqlmorpheus 0.2.0 → 0.2.1

package/dist/index.d.mts

@@ -8,7 +8,7 @@ type Class<T> = new (...args: never[]) => T;
 /**
  * This does nothing. It mainly exists in case we want to filter class types in the future
  */
-type BackendTable = {
+type TableClassInterface = {
     [key: string]: any;
 };
 
@@ -31,7 +31,6 @@ interface MigrationInstructions {
     recreate: boolean;
     /**
      * Stores changes to column. One entry per column.
-     * Each entry is an array (0: name in the database, last: current name in code)
      */
     renamedColumns: RenameData[];
     allowedMigrations: AllowedMigrations;
@@ -63,29 +62,32 @@ interface TableStructure {
 }
 
 declare class Migrations {
-    private toVersion;
-    private alwaysAllowed;
     private fromVersion;
+    private toVersion;
+    private lastUsedVersion;
     private migrationData;
     private migrationDataForOldTableNames;
+    private alwaysAllowed;
     private notAllowedChanges;
     reset(dbInstructions: DatabaseInstructions, fromVersion: number): void;
     private getEntry;
+    private getEntryFromTableName;
     private getTableName;
+    private versionIsRelevant;
     verifyRenamingTasks(newTables: Record<string, TableStructure>): Error | void;
     verifyAllowedMigrations(): Error | void;
     compareWithAllowedMigration(tableName: string, type: keyof AllowedMigrations): void;
-    allowMigration(version: number, table: string | Class<BackendTable>, ...allowedMigrations: (keyof AllowedMigrations)[]): void;
-    renameTable(version: number, oldTableName: string, newTableName: string | Class<BackendTable>): void;
-    renameColumn(version: number, table: string | Class<BackendTable>, oldColumn: string, newColumn: string): void;
-    recreateTableImp(table: Class<BackendTable> | string): void;
-    recreateTable(version: number, table: Class<BackendTable> | string): void;
     getMigrationData(): Record<string, MigrationInstructions>;
     loopRenamedColumns(tableName: string, callback: (oldColumnName: string, newColumnName: string) => void): void;
     getNewestTableName(tableName: string): string;
     getOldTableName(tableName: string): string;
     getNewestColumnName(tableName: string, oldColumnName: string): string;
     willBeRecreated(tableName: string): boolean;
+    internalRecreate(tableName: string, reason: string): void;
+    allowMigration(version: number, table: TableInput, ...allowedMigrations: (keyof AllowedMigrations)[]): void;
+    renameTable(version: number, oldTableName: string, newTableName: TableInput): void;
+    renameColumn(version: number, table: TableInput, oldColumn: string, newColumn: string): void;
+    recreateTable(version: number, table: TableInput): void;
 }
 type PublicMigrations = Pick<Migrations, "recreateTable" | "renameTable" | "renameColumn" | "allowMigration">;
 
@@ -94,19 +96,45 @@ interface SqlChanges {
     down: string;
 }
 
+type NativeDataTypeOptions = "boolean" | "number" | "bigint" | "string";
+type AddedDataTypeOptions = "date" | "time" | "dateTime";
+type DataTypeOptions = NativeDataTypeOptions | AddedDataTypeOptions;
+
 interface TableInfo {
     primaryKey?: string;
     foreignKeys?: ForeignKeyInfo[];
+    dataTypes?: Record<string, DataTypeOptions>;
 }
 
-type TableObjects = Record<string, {
-    columns: BackendTable;
-    tableInfo?: TableInfo;
-}>;
+type DataFormat = Record<string, unknown>;
+type GetColumns<T> = T extends TableObjBuilder<infer Item, any> ? Item : never;
+type TableObjBuilder<T extends DataFormat, TPick extends keyof TableObj<T>> = Pick<TableObj<T>, TPick>;
+type TableObjInput = TableObjBuilder<any, any>;
+/**
+ * Use this class to define tables for DatabaseInstructions
+ * (as an alternative for Class decorators)
+ *
+ */
+declare class TableObj<T extends DataFormat> {
+    readonly IS_TABLE_OBJ = true;
+    readonly tableName: string;
+    readonly columns: T;
+    tableInfo: TableInfo;
+    private constructor();
+    primaryKey(key: keyof T): TableObjBuilder<T, "foreignKey" | "dataType">;
+    foreignKey<TOther extends TableObjBuilder<DataFormat, any>>(fromColumn: keyof T, toTable: TOther, toColumn: keyof GetColumns<TOther>, options?: {
+        onUpdate?: ForeignKeyActions;
+        onDelete?: ForeignKeyActions;
+    }): TableObjBuilder<T, "foreignKey" | "dataType">;
+    dataType(column: keyof T, type: DataTypeOptions): TableObjBuilder<T, "foreignKey" | "dataType">;
+    static create<T extends Record<string, unknown>>(tableName: string, columns: T): TableObjBuilder<T, "primaryKey" | "foreignKey" | "dataType">;
+    static isDbTable(obj: unknown): obj is TableObj<any>;
+}
 
+type TableInput = TableObjInput | Class<TableClassInterface>;
 interface DatabaseInstructions {
     dialect: "Sqlite" | "MsSql" | "MySql" | "Postgres";
-    tables: Class<BackendTable>[] | TableObjects;
+    tables: TableInput[];
     version: number;
     configPath: string;
     throwIfNotAllowed: boolean;
@@ -130,24 +158,33 @@ interface DatabaseInstructions {
 }
 
 /**
- * Decorator function to configure a database table with its name and primary key
- * and to add missing "fromTable" properties to foreign keys.
+ * Decorator function to configure a database table with its name and primary key.
  *
  * @param tableName - The name of the database table used in SQL.
  * @param primaryKey - The property name representing the primary property of the table.
  */
-declare function DbTable<T extends BackendTable>(tableName: string, primaryKey?: keyof T): (table: Class<T>, context?: any) => void;
+declare function TableClass<T extends TableClassInterface>(tableName: string, primaryKey?: keyof T): (table: Class<T>, context?: any) => void;
 
 /**
- * Decorator function to define a foreign key constraint for a database table. It defines a relationship
- * between a column on the current table and a column on another table.
+ * Decorator function to assign a specific data type to a column.
+ * Should be used if you want to use a data type that does not exist in JavaScript or
+ * if the default value should be NULL
+ *
+ * @param type - The data type to be assigned.
+ */
+declare function DataType(type: DataTypeOptions): (table: any, context: any) => void;
+
+/**
+ * Decorator function to define a foreign key relationship for a database table.
  *
  * @param toTable - The target table class to which the foreign key points.
  * @param toColumn - The column name in the target table to which the foreign key points.
- * @param [onDelete] - Optional. The action to perform when a row in the target table is deleted.
- * @param [onUpdate] - Optional. The action to perform when a related row in the target table is updated.
+ * @param options - Additional options.
  */
-declare function ForeignKey<TOther extends BackendTable>(toTable: Class<TOther>, toColumn: keyof TOther, onDelete?: ForeignKeyActions, onUpdate?: ForeignKeyActions): (table: any, context: any) => void;
+declare function ForeignKey<TOther extends TableClassInterface>(toTable: Class<TOther>, toColumn: keyof TOther, options?: {
+    onDelete?: ForeignKeyActions;
+    onUpdate?: ForeignKeyActions;
+}): (table: any, context: any) => void;
 
 declare function prepareMigration(db: DatabaseAccess, dbInstructions: DatabaseInstructions, overwriteExisting?: boolean): Promise<void>;
 declare function runPreparedMigrations(db: DatabaseAccess, dbInstructions: DatabaseInstructions): Promise<void>;
@@ -155,4 +192,4 @@ declare function prepareAndRunMigration(db: DatabaseAccess, instructions: Databa
 declare function runMigrationWithoutHistory(db: DatabaseAccess, dbInstructions: DatabaseInstructions): Promise<void>;
 declare function rollback(db: DatabaseAccess, dbInstructions: DatabaseInstructions, toVersion: number): Promise<void>;
 
-export { type DatabaseAccess, type DatabaseInstructions, DbTable, ForeignKey, type PublicMigrations, type SqlChanges, prepareAndRunMigration, prepareMigration, rollback, runMigrationWithoutHistory, runPreparedMigrations };
+export { DataType, type DatabaseAccess, type DatabaseInstructions, ForeignKey, type PublicMigrations, type SqlChanges, TableClass, TableObj, prepareAndRunMigration, prepareMigration, rollback, runMigrationWithoutHistory, runPreparedMigrations };

package/dist/index.d.ts

@@ -8,7 +8,7 @@ type Class<T> = new (...args: never[]) => T;
 /**
  * This does nothing. It mainly exists in case we want to filter class types in the future
  */
-type BackendTable = {
+type TableClassInterface = {
     [key: string]: any;
 };
 
@@ -31,7 +31,6 @@ interface MigrationInstructions {
     recreate: boolean;
     /**
      * Stores changes to column. One entry per column.
-     * Each entry is an array (0: name in the database, last: current name in code)
      */
     renamedColumns: RenameData[];
     allowedMigrations: AllowedMigrations;
@@ -63,29 +62,32 @@ interface TableStructure {
 }
 
 declare class Migrations {
-    private toVersion;
-    private alwaysAllowed;
     private fromVersion;
+    private toVersion;
+    private lastUsedVersion;
     private migrationData;
     private migrationDataForOldTableNames;
+    private alwaysAllowed;
     private notAllowedChanges;
     reset(dbInstructions: DatabaseInstructions, fromVersion: number): void;
     private getEntry;
+    private getEntryFromTableName;
     private getTableName;
+    private versionIsRelevant;
     verifyRenamingTasks(newTables: Record<string, TableStructure>): Error | void;
     verifyAllowedMigrations(): Error | void;
     compareWithAllowedMigration(tableName: string, type: keyof AllowedMigrations): void;
-    allowMigration(version: number, table: string | Class<BackendTable>, ...allowedMigrations: (keyof AllowedMigrations)[]): void;
-    renameTable(version: number, oldTableName: string, newTableName: string | Class<BackendTable>): void;
-    renameColumn(version: number, table: string | Class<BackendTable>, oldColumn: string, newColumn: string): void;
-    recreateTableImp(table: Class<BackendTable> | string): void;
-    recreateTable(version: number, table: Class<BackendTable> | string): void;
     getMigrationData(): Record<string, MigrationInstructions>;
     loopRenamedColumns(tableName: string, callback: (oldColumnName: string, newColumnName: string) => void): void;
     getNewestTableName(tableName: string): string;
     getOldTableName(tableName: string): string;
     getNewestColumnName(tableName: string, oldColumnName: string): string;
     willBeRecreated(tableName: string): boolean;
+    internalRecreate(tableName: string, reason: string): void;
+    allowMigration(version: number, table: TableInput, ...allowedMigrations: (keyof AllowedMigrations)[]): void;
+    renameTable(version: number, oldTableName: string, newTableName: TableInput): void;
+    renameColumn(version: number, table: TableInput, oldColumn: string, newColumn: string): void;
+    recreateTable(version: number, table: TableInput): void;
 }
 type PublicMigrations = Pick<Migrations, "recreateTable" | "renameTable" | "renameColumn" | "allowMigration">;
 
@@ -94,19 +96,45 @@ interface SqlChanges {
     down: string;
 }
 
+type NativeDataTypeOptions = "boolean" | "number" | "bigint" | "string";
+type AddedDataTypeOptions = "date" | "time" | "dateTime";
+type DataTypeOptions = NativeDataTypeOptions | AddedDataTypeOptions;
+
 interface TableInfo {
     primaryKey?: string;
     foreignKeys?: ForeignKeyInfo[];
+    dataTypes?: Record<string, DataTypeOptions>;
 }
 
-type TableObjects = Record<string, {
-    columns: BackendTable;
-    tableInfo?: TableInfo;
-}>;
+type DataFormat = Record<string, unknown>;
+type GetColumns<T> = T extends TableObjBuilder<infer Item, any> ? Item : never;
+type TableObjBuilder<T extends DataFormat, TPick extends keyof TableObj<T>> = Pick<TableObj<T>, TPick>;
+type TableObjInput = TableObjBuilder<any, any>;
+/**
+ * Use this class to define tables for DatabaseInstructions
+ * (as an alternative for Class decorators)
+ *
+ */
+declare class TableObj<T extends DataFormat> {
+    readonly IS_TABLE_OBJ = true;
+    readonly tableName: string;
+    readonly columns: T;
+    tableInfo: TableInfo;
+    private constructor();
+    primaryKey(key: keyof T): TableObjBuilder<T, "foreignKey" | "dataType">;
+    foreignKey<TOther extends TableObjBuilder<DataFormat, any>>(fromColumn: keyof T, toTable: TOther, toColumn: keyof GetColumns<TOther>, options?: {
+        onUpdate?: ForeignKeyActions;
+        onDelete?: ForeignKeyActions;
+    }): TableObjBuilder<T, "foreignKey" | "dataType">;
+    dataType(column: keyof T, type: DataTypeOptions): TableObjBuilder<T, "foreignKey" | "dataType">;
+    static create<T extends Record<string, unknown>>(tableName: string, columns: T): TableObjBuilder<T, "primaryKey" | "foreignKey" | "dataType">;
+    static isDbTable(obj: unknown): obj is TableObj<any>;
+}
 
+type TableInput = TableObjInput | Class<TableClassInterface>;
 interface DatabaseInstructions {
     dialect: "Sqlite" | "MsSql" | "MySql" | "Postgres";
-    tables: Class<BackendTable>[] | TableObjects;
+    tables: TableInput[];
     version: number;
     configPath: string;
     throwIfNotAllowed: boolean;
@@ -130,24 +158,33 @@ interface DatabaseInstructions {
 }
 
 /**
- * Decorator function to configure a database table with its name and primary key
- * and to add missing "fromTable" properties to foreign keys.
+ * Decorator function to configure a database table with its name and primary key.
  *
  * @param tableName - The name of the database table used in SQL.
  * @param primaryKey - The property name representing the primary property of the table.
  */
-declare function DbTable<T extends BackendTable>(tableName: string, primaryKey?: keyof T): (table: Class<T>, context?: any) => void;
+declare function TableClass<T extends TableClassInterface>(tableName: string, primaryKey?: keyof T): (table: Class<T>, context?: any) => void;
 
 /**
- * Decorator function to define a foreign key constraint for a database table. It defines a relationship
- * between a column on the current table and a column on another table.
+ * Decorator function to assign a specific data type to a column.
+ * Should be used if you want to use a data type that does not exist in JavaScript or
+ * if the default value should be NULL
+ *
+ * @param type - The data type to be assigned.
+ */
+declare function DataType(type: DataTypeOptions): (table: any, context: any) => void;
+
+/**
+ * Decorator function to define a foreign key relationship for a database table.
  *
  * @param toTable - The target table class to which the foreign key points.
  * @param toColumn - The column name in the target table to which the foreign key points.
- * @param [onDelete] - Optional. The action to perform when a row in the target table is deleted.
- * @param [onUpdate] - Optional. The action to perform when a related row in the target table is updated.
+ * @param options - Additional options.
  */
-declare function ForeignKey<TOther extends BackendTable>(toTable: Class<TOther>, toColumn: keyof TOther, onDelete?: ForeignKeyActions, onUpdate?: ForeignKeyActions): (table: any, context: any) => void;
+declare function ForeignKey<TOther extends TableClassInterface>(toTable: Class<TOther>, toColumn: keyof TOther, options?: {
+    onDelete?: ForeignKeyActions;
+    onUpdate?: ForeignKeyActions;
+}): (table: any, context: any) => void;
 
 declare function prepareMigration(db: DatabaseAccess, dbInstructions: DatabaseInstructions, overwriteExisting?: boolean): Promise<void>;
 declare function runPreparedMigrations(db: DatabaseAccess, dbInstructions: DatabaseInstructions): Promise<void>;
@@ -155,4 +192,4 @@ declare function prepareAndRunMigration(db: DatabaseAccess, instructions: Databa
 declare function runMigrationWithoutHistory(db: DatabaseAccess, dbInstructions: DatabaseInstructions): Promise<void>;
 declare function rollback(db: DatabaseAccess, dbInstructions: DatabaseInstructions, toVersion: number): Promise<void>;
 
-export { type DatabaseAccess, type DatabaseInstructions, DbTable, ForeignKey, type PublicMigrations, type SqlChanges, prepareAndRunMigration, prepareMigration, rollback, runMigrationWithoutHistory, runPreparedMigrations };
+export { DataType, type DatabaseAccess, type DatabaseInstructions, ForeignKey, type PublicMigrations, type SqlChanges, TableClass, TableObj, prepareAndRunMigration, prepareMigration, rollback, runMigrationWithoutHistory, runPreparedMigrations };