rake-db 2.36.18 → 2.37.0

package/dist/index.d.ts

@@ -634,10 +634,15 @@ interface TableChangeMethods extends TableMethods, TableDataMethods<string> {
   unique(options?: TableData.Index.UniqueColumnArg): ColumnIndexChangeInput;
   exclude(columns: TableData.Exclude.ColumnOrExpressionOptions[], options?: TableData.Exclude.Options): NonUniqDataItem;
   exclude(with_: string, options?: TableData.Exclude.ColumnArg): ColumnExcludeChangeInput;
-  foreignKey<Shape>(columns: [string, ...string[]], fnOrTable: () => new () => {
-    columns: {
+  foreignKey<Shape>(columns: [string, ...string[]], fnOrTable: () => Column$1.ForeignKey.TableParam & {
+    columns?: {
       shape: Shape;
     };
+    instance?: () => {
+      columns: {
+        shape: Shape;
+      };
+    };
   }, foreignColumns: [keyof Shape, ...(keyof Shape)[]], options?: TableData.References.Options): NonUniqDataItem;
   foreignKey(columns: [string, ...string[]], fnOrTable: string, foreignColumns: [string, ...string[]], options?: TableData.References.Options): NonUniqDataItem;
   foreignKey(fnOrTable: string, foreignColumn: string, options?: TableData.References.Options): ColumnForeignKeyChangeInput;
@@ -1786,6 +1791,7 @@ interface MigrateConfigBase extends QueryLogOptions {
   snakeCase?: boolean;
   language?: string;
   noPrimaryKey?: NoPrimaryKeyOption;
+  defineTable?: RakeDbDefineTable<unknown>;
   baseTable?: RakeDbBaseTable<unknown>;
 }
 interface MigrateConfigFileBased extends MigrateConfigBase {
@@ -1881,6 +1887,7 @@ interface MigrationsSet {
 type SearchPath = (() => string) | string;
 interface RakeDbCliConfigInputBase<SchemaConfig extends ColumnSchemaConfig, CT = DefaultColumnTypes<DefaultSchemaConfig>> extends QueryLogOptions {
   columnTypes?: CT | ((t: DefaultColumnTypes<DefaultSchemaConfig>) => CT);
+  defineTable?: RakeDbDefineTable<CT>;
   baseTable?: RakeDbBaseTable<CT>;
   schemaConfig?: SchemaConfig;
   basePath?: string;
@@ -2007,6 +2014,7 @@ interface RakeDbConfig<ColumnTypes = unknown> extends QueryLogOptions {
   renameMigrations?: RakeDbRenameMigrationsInput;
   language?: string;
   noPrimaryKey?: NoPrimaryKeyOption;
+  defineTable?: RakeDbDefineTable<unknown>;
   baseTable?: RakeDbBaseTable<unknown>;
   commands: RakeDbCommands;
 }
@@ -2066,6 +2074,58 @@ interface RakeDbBaseTable<CT> {
     language?: string;
   };
 }
+interface RakeDbDefineTable<CT> {
+  /**
+   * Export name configured for this table factory.
+   */
+  exportAs: string;
+  /**
+   * Returns the source file path for imports generated by rake-db.
+   */
+  getFilePath(): string;
+  /**
+   * Column types configured for this table factory.
+   */
+  types: CT;
+  /**
+   * Custom timestamp SQL configured for this table factory.
+   */
+  nowSQL?: string;
+  /**
+   * Whether this table factory maps columns and table names to snake case.
+   */
+  snakeCase?: boolean;
+  /**
+   * Default full text search language configured for this table factory.
+   */
+  language?: string;
+}
+interface RakeDbTableFactoryConfig<CT> {
+  /**
+   * Export name configured for this table factory.
+   */
+  exportAs: string;
+  /**
+   * Returns the source file path for imports generated by rake-db.
+   */
+  getFilePath(): string;
+  /**
+   * Column types configured for this table factory.
+   */
+  columnTypes: CT;
+  /**
+   * Custom timestamp SQL configured for this table factory.
+   */
+  nowSQL?: string;
+  /**
+   * Whether this table factory maps columns and table names to snake case.
+   */
+  snakeCase?: boolean;
+  /**
+   * Default full text search language configured for this table factory.
+   */
+  language?: string;
+}
 interface ModuleExportsRecord {
   [fileName: string]: () => Promise<unknown>;
 }
@@ -2257,5 +2317,19 @@ declare const createTable: (db: DbParam, sql: string) => Promise<"done" | "alrea
  * ```
  */
 declare const dropTable: (db: DbParam, sql: string) => Promise<"done" | "already">;
+interface RakeDbTableFactoryConfigInput<CT> {
+  /**
+   * Function-style table factory metadata.
+   */
+  defineTable?: RakeDbDefineTable<CT>;
+  /**
+   * Class-style base table metadata.
+   */
+  baseTable?: RakeDbBaseTable<CT>;
+}
+declare const getTableFactoryConfig: <CT>({
+  baseTable,
+  defineTable
+}: RakeDbTableFactoryConfigInput<CT>) => RakeDbTableFactoryConfig<CT> | undefined;
 declare class RakeDbError extends Error {}
-export { type ChangeCallback, type DbMigration, type DbStructure, type IntrospectedStructure, type MigrateConfig, type MigrateFn, type MigrationChangeFn, type RakeDbAst, type RakeDbChangeFnConfig, type RakeDbCliConfigInput, type RakeDbCliResult, type RakeDbConfig, RakeDbError, type RakeDbFn, type SilentQueries, type StructureToAstCtx, type StructureToAstTableData, astToMigration, concatSchemaAndName, createDatabase, createMigrationChangeFn, createMigrationInterface, createMigrationsSchemaAndTable, createSchema, createTable, dbColumnToAst, dropDatabase, dropSchema, dropTable, encodeColumnDefault, getConstraintName, getDbStructureTableData, getDbTableColumnsChecks, getDbVersion, getExcludeName, getIndexName, getMigrationsSchemaAndTable, getSchemaAndTableFromName, incrementIntermediateCaller, instantiateDbColumn, introspectDbSchema, makeDomainsMap, makeFileVersion, makeStructureToAstCtx, migrate, migrateAndClose, promptSelect, rakeDbCliWithAdapter, rakeDbCommands, rakeDbConfigDefaults, redo, rollback, runMigration, saveMigratedVersion, setRakeDbCliRunFn, structureToAst, tableToAst, writeMigrationFile };
+export { type ChangeCallback, type DbMigration, type DbStructure, type IntrospectedStructure, type MigrateConfig, type MigrateFn, type MigrationChangeFn, type RakeDbAst, type RakeDbBaseTable, type RakeDbChangeFnConfig, type RakeDbCliConfigInput, type RakeDbCliResult, type RakeDbConfig, type RakeDbDefineTable, RakeDbError, type RakeDbFn, type SilentQueries, type StructureToAstCtx, type StructureToAstTableData, astToMigration, concatSchemaAndName, createDatabase, createMigrationChangeFn, createMigrationInterface, createMigrationsSchemaAndTable, createSchema, createTable, dbColumnToAst, dropDatabase, dropSchema, dropTable, encodeColumnDefault, getConstraintName, getDbStructureTableData, getDbTableColumnsChecks, getDbVersion, getExcludeName, getIndexName, getMigrationsSchemaAndTable, getSchemaAndTableFromName, getTableFactoryConfig, incrementIntermediateCaller, instantiateDbColumn, introspectDbSchema, makeDomainsMap, makeFileVersion, makeStructureToAstCtx, migrate, migrateAndClose, promptSelect, rakeDbCliWithAdapter, rakeDbCommands, rakeDbConfigDefaults, redo, rollback, runMigration, saveMigratedVersion, setRakeDbCliRunFn, structureToAst, tableToAst, writeMigrationFile };

package/dist/index.js

@@ -205,7 +205,7 @@ const addColumnComment = (comments, name, item) => {
 };
 const getForeignKeyTable = (schema, fnOrTable) => {
 	if (typeof fnOrTable === "string") return getSchemaAndTableFromName(schema, fnOrTable);
-	const item = new (fnOrTable())();
+	const item = (0, pqb_internal.getForeignKeyTableInstance)(fnOrTable());
 	return [item.schema, item.table];
 };
 const getConstraintName = (table, constraint, snakeCase) => {
@@ -432,6 +432,33 @@ const migrationsSchemaTableSql = (adapter, config) => {
 };
 var RakeDbError = class extends Error {};
 var NoPrimaryKey = class extends RakeDbError {};
+const getTableFactoryConfig = ({ baseTable, defineTable }) => {
+	if (baseTable && defineTable) throw new Error("Configure either baseTable or defineTable, not both");
+	if (defineTable) {
+		if (!defineTable.types) throw new Error("defineTable is missing types");
+		if (!defineTable.exportAs) throw new Error("defineTable is missing exportAs");
+		if (typeof defineTable.getFilePath !== "function") throw new Error("defineTable is missing getFilePath");
+		return {
+			columnTypes: defineTable.types,
+			exportAs: defineTable.exportAs,
+			getFilePath: defineTable.getFilePath,
+			nowSQL: defineTable.nowSQL,
+			snakeCase: defineTable.snakeCase,
+			language: defineTable.language
+		};
+	}
+	if (baseTable) {
+		const { types, snakeCase, language } = baseTable.prototype || {};
+		return {
+			columnTypes: types,
+			exportAs: baseTable.exportAs,
+			getFilePath: baseTable.getFilePath,
+			nowSQL: baseTable.nowSQL,
+			snakeCase,
+			language
+		};
+	}
+};
 const createTable$1 = async (migration, tableMethods, up, tableName, first, second, third) => {
 	let options;
 	let fn;
@@ -451,7 +478,8 @@ const createTable$1 = async (migration, tableMethods, up, tableName, first, seco
 	let shape;
 	let tableData;
 	if (fn) {
-		shape = (0, pqb_internal.getColumnTypes)(types, fn, migration.options.baseTable?.nowSQL, language);
+		const tableFactory = getTableFactoryConfig(migration.options);
+		shape = (0, pqb_internal.getColumnTypes)(types, fn, tableFactory?.nowSQL, language);
 		tableData = (0, pqb_internal.parseTableData)(dataFn);
 		tableData.constraints?.forEach((x, i) => {
 			if (x.name || !x.check) return;
@@ -3290,10 +3318,10 @@ const processMigrateConfig = (config, db) => {
 		migrationsPath,
 		...handleConfigLogger(config, db)
 	};
-	if ("baseTable" in config && config.baseTable) {
-		const { snakeCase, language } = config.baseTable.prototype;
-		if (snakeCase) result.snakeCase = true;
-		if (language) result.language = language;
+	const tableFactory = getTableFactoryConfig(config);
+	if (tableFactory) {
+		if (tableFactory.snakeCase) result.snakeCase = true;
+		if (tableFactory.language) result.language = tableFactory.language;
 	}
 	return result;
 };
@@ -6148,6 +6176,7 @@ const ensureBasePathAndDbScript = (config, intermediateCallers = 0) => {
 const makeRakeDbConfig = (config, args) => {
 	const ic = intermediateCallers;
 	intermediateCallers = 0;
+	const tableFactory = getTableFactoryConfig(config);
 	const result = {
 		...rakeDbConfigDefaults,
 		...config,
@@ -6157,10 +6186,8 @@ const makeRakeDbConfig = (config, args) => {
 	Object.assign(result, processMigrateConfig(result));
 	if (!result.recurrentPath && result.migrationsPath) result.recurrentPath = node_path.default.join(result.migrationsPath, "recurrent");
 	if (result.recurrentPath && !node_path.default.isAbsolute(result.recurrentPath)) result.recurrentPath = node_path.default.resolve(result.basePath, result.recurrentPath);
-	if ("baseTable" in config && config.baseTable) {
-		const { types } = config.baseTable.prototype;
-		result.columnTypes = types || (0, pqb_internal.makeColumnTypes)((0, pqb_internal.defaultSchemaConfig)());
-	} else {
+	if (tableFactory) result.columnTypes = tableFactory.columnTypes || (0, pqb_internal.makeColumnTypes)((0, pqb_internal.defaultSchemaConfig)());
+	else {
 		const ct = "columnTypes" in config && config.columnTypes;
 		result.columnTypes = (typeof ct === "function" ? ct((0, pqb_internal.makeColumnTypes)((0, pqb_internal.defaultSchemaConfig)())) : ct) || (0, pqb_internal.makeColumnTypes)((0, pqb_internal.defaultSchemaConfig)());
 	}
@@ -6290,6 +6317,7 @@ exports.getExcludeName = getExcludeName;
 exports.getIndexName = getIndexName;
 exports.getMigrationsSchemaAndTable = getMigrationsSchemaAndTable;
 exports.getSchemaAndTableFromName = getSchemaAndTableFromName;
+exports.getTableFactoryConfig = getTableFactoryConfig;
 exports.incrementIntermediateCaller = incrementIntermediateCaller;
 exports.instantiateDbColumn = instantiateDbColumn;
 exports.introspectDbSchema = introspectDbSchema;