rake-db 2.36.19 → 2.37.1

package/dist/bun.js.map

@@ -1 +1 @@
-{"version":3,"file":"bun.js","names":["AdapterClass","BunAdapter"],"sources":["../src/adapters/bun.ts"],"sourcesContent":["import { BunAdapter, BunAdapterOptions } from 'pqb/bun';\nimport { AdapterClass, MaybeArray, toArray } from 'pqb/internal';\nimport {\n  rakeDbCliWithAdapter,\n  RakeDbFn,\n  setRakeDbCliRunFn,\n  incrementIntermediateCaller,\n} from 'rake-db';\n\nexport const rakeDb = ((inputConfig, args = process.argv.slice(2)) => {\n  if (!('__rakeDbConfig' in inputConfig)) {\n    incrementIntermediateCaller();\n  }\n\n  const rakeDb = rakeDbCliWithAdapter(inputConfig, args);\n  return {\n    ...rakeDb,\n    run(options) {\n      const adapters = toArray(options).map((config) => {\n        return new AdapterClass({\n          driverAdapter: BunAdapter,\n          config,\n        });\n      });\n      return rakeDb.run(adapters);\n    },\n  };\n}) as RakeDbFn<MaybeArray<BunAdapterOptions>>;\n\nsetRakeDbCliRunFn(rakeDb);\n"],"mappings":";;;;AASA,MAAa,WAAW,aAAa,OAAO,QAAQ,KAAK,MAAM,EAAE,KAAK;AACpE,KAAI,EAAE,oBAAoB,aACxB,EAAA,GAAA,QAAA,8BAA6B;CAG/B,MAAM,UAAA,GAAA,QAAA,sBAA8B,aAAa,KAAK;AACtD,QAAO;EACL,GAAG;EACH,IAAI,SAAS;GACX,MAAM,YAAA,GAAA,aAAA,SAAmB,QAAQ,CAAC,KAAK,WAAW;AAChD,WAAO,IAAIA,aAAAA,aAAa;KACtB,eAAeC,QAAAA;KACf;KACD,CAAC;KACF;AACF,UAAO,OAAO,IAAI,SAAS;;EAE9B;;+BAGe,OAAO"}
+{"version":3,"file":"bun.js","names":["rakeDbCliWithAdapter","toArray","AdapterClass","BunAdapter","setRakeDbCliRunFn"],"sources":["../src/adapters/bun.ts"],"sourcesContent":["import { BunAdapter, BunAdapterOptions } from 'pqb/bun';\nimport { AdapterClass, MaybeArray, toArray } from 'pqb/internal';\nimport {\n  rakeDbCliWithAdapter,\n  RakeDbFn,\n  setRakeDbCliRunFn,\n  incrementIntermediateCaller,\n} from 'rake-db';\n\nexport const rakeDb = ((inputConfig, args = process.argv.slice(2)) => {\n  if (!('__rakeDbConfig' in inputConfig)) {\n    incrementIntermediateCaller();\n  }\n\n  const rakeDb = rakeDbCliWithAdapter(inputConfig, args);\n  return {\n    ...rakeDb,\n    run(options) {\n      const adapters = toArray(options).map((config) => {\n        return new AdapterClass({\n          driverAdapter: BunAdapter,\n          config,\n        });\n      });\n      return rakeDb.run(adapters);\n    },\n  };\n}) as RakeDbFn<MaybeArray<BunAdapterOptions>>;\n\nsetRakeDbCliRunFn(rakeDb);\n"],"mappings":";;;;AASA,MAAa,WAAW,aAAa,OAAO,QAAQ,KAAK,MAAM,CAAC,MAAM;CACpE,IAAI,EAAE,oBAAoB,cACxB,CAAA,GAAA,QAAA,4BAAA,CAA4B;CAG9B,MAAM,UAAA,GAASA,QAAAA,qBAAAA,CAAqB,aAAa,IAAI;CACrD,OAAO;EACL,GAAG;EACH,IAAI,SAAS;GACX,MAAM,YAAA,GAAWC,aAAAA,QAAAA,CAAQ,OAAO,CAAC,CAAC,KAAK,WAAW;IAChD,OAAO,IAAIC,aAAAA,aAAa;KACtB,eAAeC,QAAAA;KACf;IACF,CAAC;GACH,CAAC;GACD,OAAO,OAAO,IAAI,QAAQ;EAC5B;CACF;AACF;CAEAC,GAAAA,QAAAA,kBAAAA,CAAkB,MAAM"}

package/dist/bun.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"bun.mjs","names":[],"sources":["../src/adapters/bun.ts"],"sourcesContent":["import { BunAdapter, BunAdapterOptions } from 'pqb/bun';\nimport { AdapterClass, MaybeArray, toArray } from 'pqb/internal';\nimport {\n  rakeDbCliWithAdapter,\n  RakeDbFn,\n  setRakeDbCliRunFn,\n  incrementIntermediateCaller,\n} from 'rake-db';\n\nexport const rakeDb = ((inputConfig, args = process.argv.slice(2)) => {\n  if (!('__rakeDbConfig' in inputConfig)) {\n    incrementIntermediateCaller();\n  }\n\n  const rakeDb = rakeDbCliWithAdapter(inputConfig, args);\n  return {\n    ...rakeDb,\n    run(options) {\n      const adapters = toArray(options).map((config) => {\n        return new AdapterClass({\n          driverAdapter: BunAdapter,\n          config,\n        });\n      });\n      return rakeDb.run(adapters);\n    },\n  };\n}) as RakeDbFn<MaybeArray<BunAdapterOptions>>;\n\nsetRakeDbCliRunFn(rakeDb);\n"],"mappings":";;;AASA,MAAa,WAAW,aAAa,OAAO,QAAQ,KAAK,MAAM,EAAE,KAAK;AACpE,KAAI,EAAE,oBAAoB,aACxB,8BAA6B;CAG/B,MAAM,SAAS,qBAAqB,aAAa,KAAK;AACtD,QAAO;EACL,GAAG;EACH,IAAI,SAAS;GACX,MAAM,WAAW,QAAQ,QAAQ,CAAC,KAAK,WAAW;AAChD,WAAO,IAAI,aAAa;KACtB,eAAe;KACf;KACD,CAAC;KACF;AACF,UAAO,OAAO,IAAI,SAAS;;EAE9B;;AAGH,kBAAkB,OAAO"}
+{"version":3,"file":"bun.mjs","names":[],"sources":["../src/adapters/bun.ts"],"sourcesContent":["import { BunAdapter, BunAdapterOptions } from 'pqb/bun';\nimport { AdapterClass, MaybeArray, toArray } from 'pqb/internal';\nimport {\n  rakeDbCliWithAdapter,\n  RakeDbFn,\n  setRakeDbCliRunFn,\n  incrementIntermediateCaller,\n} from 'rake-db';\n\nexport const rakeDb = ((inputConfig, args = process.argv.slice(2)) => {\n  if (!('__rakeDbConfig' in inputConfig)) {\n    incrementIntermediateCaller();\n  }\n\n  const rakeDb = rakeDbCliWithAdapter(inputConfig, args);\n  return {\n    ...rakeDb,\n    run(options) {\n      const adapters = toArray(options).map((config) => {\n        return new AdapterClass({\n          driverAdapter: BunAdapter,\n          config,\n        });\n      });\n      return rakeDb.run(adapters);\n    },\n  };\n}) as RakeDbFn<MaybeArray<BunAdapterOptions>>;\n\nsetRakeDbCliRunFn(rakeDb);\n"],"mappings":";;;AASA,MAAa,WAAW,aAAa,OAAO,QAAQ,KAAK,MAAM,CAAC,MAAM;CACpE,IAAI,EAAE,oBAAoB,cACxB,4BAA4B;CAG9B,MAAM,SAAS,qBAAqB,aAAa,IAAI;CACrD,OAAO;EACL,GAAG;EACH,IAAI,SAAS;GACX,MAAM,WAAW,QAAQ,OAAO,CAAC,CAAC,KAAK,WAAW;IAChD,OAAO,IAAI,aAAa;KACtB,eAAe;KACf;IACF,CAAC;GACH,CAAC;GACD,OAAO,OAAO,IAAI,QAAQ;EAC5B;CACF;AACF;AAEA,kBAAkB,MAAM"}

package/dist/index.d.ts

@@ -628,16 +628,21 @@ interface TableChangeMethods extends TableMethods, TableDataMethods<string> {
   index(options?: TableData.Index.ColumnArg): ColumnIndexChangeInput;
   unique<Columns extends [string | TableData.Index.ColumnOrExpressionOptions, ...(string | TableData.Index.ColumnOrExpressionOptions)[]], Name extends string>(columns: Columns, options?: TableData.Index.UniqueOptionsArg<Name>): {
     tableDataItem: true;
-    columns: Columns extends (string | TableData.Index.ColumnOptionsForColumn<string>)[] ? { [I in keyof Columns]: 'column' extends keyof Columns[I] ? Columns[I]['column'] : Columns[I] } : never;
+    columns: Columns extends (string | TableData.Index.ColumnOptionsForColumn<string>)[] ? { [I in keyof Columns]: 'column' extends keyof Columns[I] ? Columns[I]['column'] : Columns[I]; } : never;
     name: string extends Name ? never : Name;
   };
   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;
@@ -756,7 +761,7 @@ interface MigrationInterfaceResult {
  * @param up - migrate or rollback
  * @param config - config of `rakeDb`
  */
-declare const createMigrationInterface: (tx: Adapter, up: boolean, config: Pick<RakeDbConfig, "log" | "logger">) => MigrationInterfaceResult;
+declare const createMigrationInterface: (tx: Adapter, up: boolean, config: Pick<RakeDbConfig, 'log' | 'logger'>) => MigrationInterfaceResult;
 type MigrationAdapter = Adapter;
 declare class Migration<CT = unknown> {
   adapter: MigrationAdapter;
@@ -1729,10 +1734,7 @@ interface RakeDbCtx {
   migrationsPromise?: Promise<MigrationsSet>;
 }
 declare const getSchemaAndTableFromName: (schema: QuerySchema | undefined, name: string) => [string | undefined, string];
-declare const concatSchemaAndName: ({
-  schema,
-  name
-}: {
+declare const concatSchemaAndName: ({ schema, name }: {
   schema?: string;
   name: string;
 }, excludeCurrentSchema?: string) => string;
@@ -1759,7 +1761,7 @@ interface OrmParam {
   $getAdapter(): Adapter;
 }
 type DbParam = OrmParam | Adapter;
-declare const saveMigratedVersion: (db: SilentQueries, version: string, name: string, config: Pick<RakeDbConfig, "migrationsTable">) => Promise<void>;
+declare const saveMigratedVersion: (db: SilentQueries, version: string, name: string, config: Pick<RakeDbConfig, 'migrationsTable'>) => Promise<void>;
 declare const createMigrationsSchemaAndTable: (db: DbParam, config: {
   migrationsTable: string;
   logger?: QueryLogger;
@@ -1786,6 +1788,7 @@ interface MigrateConfigBase extends QueryLogOptions {
   snakeCase?: boolean;
   language?: string;
   noPrimaryKey?: NoPrimaryKeyOption;
+  defineTable?: RakeDbDefineTable<unknown>;
   baseTable?: RakeDbBaseTable<unknown>;
 }
 interface MigrateConfigFileBased extends MigrateConfigBase {
@@ -1881,6 +1884,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,21 +2011,22 @@ interface RakeDbConfig<ColumnTypes = unknown> extends QueryLogOptions {
   renameMigrations?: RakeDbRenameMigrationsInput;
   language?: string;
   noPrimaryKey?: NoPrimaryKeyOption;
+  defineTable?: RakeDbDefineTable<unknown>;
   baseTable?: RakeDbBaseTable<unknown>;
   commands: RakeDbCommands;
 }
 declare const rakeDbConfigDefaults: {
+  migrationId: {
+    serial: number;
+  };
+  migrationsTable: string;
+  transaction: string;
   schemaConfig: DefaultSchemaConfig;
   snakeCase: boolean;
   commands: {};
   log: boolean;
   logger: Console;
   import(): never;
-  migrationId: {
-    serial: number;
-  };
-  migrationsTable: string;
-  transaction: string;
 };
 interface RakeDbCommandFn {
   (adapters: Adapter[], config: RakeDbConfig, args: string[]): MaybePromise<unknown>;
@@ -2066,6 +2071,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>;
 }
@@ -2118,12 +2175,7 @@ declare const getMigrationsSchemaAndTable: (adapter: Adapter, config: {
   schema?: string;
   table: string;
 };
-declare const promptSelect: ({
-  message,
-  options,
-  active,
-  inactive
-}: {
+declare const promptSelect: ({ message, options, active, inactive }: {
   message: string;
   options: string[];
   active?: (s: string) => string;
@@ -2144,15 +2196,12 @@ interface StructureToAstTableData {
   constraints: DbStructure.Constraint[];
   roles?: DbStructure.Role[];
 }
-declare const makeStructureToAstCtx: (config: Pick<RakeDbConfig, "snakeCase" | "schemaConfig">, currentSchema: string) => StructureToAstCtx;
-declare const structureToAst: (ctx: StructureToAstCtx, adapter: Adapter, config: Pick<RakeDbConfig, "migrationsTable">) => Promise<RakeDbAst[]>;
+declare const makeStructureToAstCtx: (config: Pick<RakeDbConfig, 'snakeCase' | 'schemaConfig'>, currentSchema: string) => StructureToAstCtx;
+declare const structureToAst: (ctx: StructureToAstCtx, adapter: Adapter, config: Pick<RakeDbConfig, 'migrationsTable'>) => Promise<RakeDbAst[]>;
 declare const makeDomainsMap: (ctx: StructureToAstCtx, data: IntrospectedStructure) => DbStructureDomainsMap;
 declare const instantiateDbColumn: (ctx: StructureToAstCtx, data: IntrospectedStructure, domains: DbStructureDomainsMap, dbColumn: DbStructure.Column) => Column$1;
-declare const tableToAst: (ctx: StructureToAstCtx, data: IntrospectedStructure, table: DbStructure.Table, action: "create" | "drop", domains: DbStructureDomainsMap) => RakeDbAst.Table;
-declare const getDbStructureTableData: (data: IntrospectedStructure, {
-  name,
-  schemaName
-}: DbStructure.Table) => StructureToAstTableData;
+declare const tableToAst: (ctx: StructureToAstCtx, data: IntrospectedStructure, table: DbStructure.Table, action: 'create' | 'drop', domains: DbStructureDomainsMap) => RakeDbAst.Table;
+declare const getDbStructureTableData: (data: IntrospectedStructure, { name, schemaName }: DbStructure.Table) => StructureToAstTableData;
 interface ColumnChecks {
   [K: string]: string[];
 }
@@ -2178,10 +2227,7 @@ type CreateOrDropOk = 'done' | 'already';
  * });
  * ```
  */
-declare const createDatabase: (db: DbParam, {
-  database,
-  owner
-}: {
+declare const createDatabase: (db: DbParam, { database, owner }: {
   database: string;
   owner?: string;
 }) => Promise<CreateOrDropOk>;
@@ -2204,9 +2250,7 @@ declare const createDatabase: (db: DbParam, {
  * });
  * ```
  */
-declare const dropDatabase: (db: DbParam, {
-  database
-}: {
+declare const dropDatabase: (db: DbParam, { database }: {
   database: string;
 }) => Promise<CreateOrDropOk>;
 /**
@@ -2220,7 +2264,7 @@ declare const dropDatabase: (db: DbParam, {
  * const result: 'done' | 'already' = await createSchema(db, '"schema"');
  * ```
  */
-declare const createSchema: (db: DbParam, sql: string) => Promise<"done" | "already">;
+declare const createSchema: (db: DbParam, sql: string) => Promise<'done' | 'already'>;
 /**
  * `dropSchema` uses a savepoint when it is called in a transaction to not break it if the schema does not exist.
  *
@@ -2232,7 +2276,7 @@ declare const createSchema: (db: DbParam, sql: string) => Promise<"done" | "alre
  * const result: 'done' | 'already' = await dropSchema(db, '"schema"');
  * ```
  */
-declare const dropSchema: (db: DbParam, sql: string) => Promise<"done" | "already">;
+declare const dropSchema: (db: DbParam, sql: string) => Promise<'done' | 'already'>;
 /**
  * `createTable` uses a savepoint when it is called in a transaction to not break it if the table already exists.
  *
@@ -2244,7 +2288,7 @@ declare const dropSchema: (db: DbParam, sql: string) => Promise<"done" | "alread
  * const result: 'done' | 'already' = await createTable(db, '"table"');
  * ```
  */
-declare const createTable: (db: DbParam, sql: string) => Promise<"done" | "already">;
+declare const createTable: (db: DbParam, sql: string) => Promise<'done' | 'already'>;
 /**
  * `dropTable` uses a savepoint when it is called in a transaction to not break it if the table does not exist.
  *
@@ -2256,6 +2300,17 @@ declare const createTable: (db: DbParam, sql: string) => Promise<"done" | "alrea
  * const result: 'done' | 'already' = await dropTable(db, '"table"');
  * ```
  */
-declare const dropTable: (db: DbParam, sql: string) => Promise<"done" | "already">;
+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 };