rake-db 2.27.22 → 2.27.24

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as pqb from 'pqb';
-import { ColumnsShape, Db, TableData, NoPrimaryKeyOption, MaybeArray, ColumnType, RawSQLBase, ColumnDataCheckBase, RecordString, ColumnTypeBase, EnumColumn, EmptyObject, ColumnSchemaConfig, DefaultColumnTypes, DefaultSchemaConfig, QueryLogOptions, AdapterBase, DbResult, MaybePromise, QueryLogObject, TableDataFn, TableDataItem, DbDomainArg, raw, SearchWeight, ColumnsByType, DbStructureDomainsMap, QueryBase } from 'pqb';
+import { ColumnsShape, Db, TableData, NoPrimaryKeyOption, MaybeArray, Column, RawSQLBase, RecordString, EnumColumn, EmptyObject, ColumnSchemaConfig, DefaultColumnTypes, DefaultSchemaConfig, QueryLogOptions, AdapterBase, DbResult, MaybePromise, QueryLogObject, TableDataFn, TableDataItem, DbDomainArg, raw, SearchWeight, ColumnsByType, DbStructureDomainsMap, QueryBase } from 'pqb';
 
 interface CreateTableResult<Table extends string, Shape extends ColumnsShape> {
     table: Db<Table, Shape>;
@@ -33,7 +33,7 @@ declare namespace RakeDbAst {
     namespace ChangeTableItem {
         interface Column {
             type: 'add' | 'drop';
-            item: ColumnType;
+            item: Column;
             dropMode?: DropMode;
         }
         interface Change {
@@ -53,7 +53,7 @@ declare namespace RakeDbAst {
         }
     }
     interface ColumnChange {
-        column?: ColumnType;
+        column?: Column;
         type?: string;
         collate?: string;
         default?: unknown | RawSQLBase;
@@ -61,7 +61,7 @@ declare namespace RakeDbAst {
         comment?: string | null;
         compression?: string;
         primaryKey?: boolean;
-        checks?: ColumnDataCheckBase[];
+        checks?: Column.Data.Check[];
         foreignKeys?: TableData.ColumnReferences[];
         indexes?: TableData.ColumnIndex[];
         excludes?: TableData.ColumnExclude[];
@@ -134,7 +134,7 @@ declare namespace RakeDbAst {
         action: 'create' | 'drop';
         schema?: string;
         name: string;
-        baseType: ColumnType;
+        baseType: Column;
     }
     interface Collation {
         type: 'collation';
@@ -198,11 +198,11 @@ declare namespace RakeDbAst {
     }
 }
 
-declare function add(item: ColumnType, options?: {
+declare function add(item: Column, options?: {
     dropMode?: DropMode;
 }): SpecialChange;
 declare function add(emptyObject: EmptyObject): SpecialChange;
-declare function add(items: Record<string, ColumnType>, options?: {
+declare function add(items: Record<string, Column>, options?: {
     dropMode?: DropMode;
 }): Record<string, RakeDbAst.ChangeTableItem.Column>;
 interface Change extends RakeDbAst.ChangeTableItem.Change, ChangeOptions {
@@ -222,7 +222,7 @@ declare const tableChangeMethods: {
     name(name: string): any;
     add: typeof add;
     drop: typeof add;
-    change(from: ColumnType | OneWayChange, to: ColumnType | OneWayChange, using?: ChangeOptions): Change;
+    change(from: Column | OneWayChange, to: Column | OneWayChange, using?: ChangeOptions): Change;
     default(value: unknown | RawSQLBase): OneWayChange;
     nullable(): OneWayChange;
     nonNullable(): OneWayChange;
@@ -260,13 +260,18 @@ declare const tableChangeMethods: {
     index(columns: (string | TableData.Index.ColumnOrExpressionOptions<string>)[], options?: TableData.Index.OptionsArg | undefined): pqb.NonUniqDataItem;
     searchIndex(columns: (string | TableData.Index.ColumnOrExpressionOptions<string>)[], options?: TableData.Index.TsVectorArg | undefined): pqb.NonUniqDataItem;
     exclude(columns: TableData.Exclude.ColumnOrExpressionOptions<string>[], options?: TableData.Exclude.Options | undefined): pqb.NonUniqDataItem;
-    foreignKey<ForeignTable extends string | (() => pqb.ForeignKeyTable), ForeignColumns extends ForeignTable extends () => pqb.ForeignKeyTable ? [pqb.ColumnNameOfTable<ReturnType<ForeignTable>>, ...pqb.ColumnNameOfTable<ReturnType<ForeignTable>>[]] : [string, ...string[]]>(columns: [string, ...string[]], fnOrTable: ForeignTable, foreignColumns: ForeignColumns, options?: TableData.References.Options | undefined): pqb.NonUniqDataItem;
-    check(check: RawSQLBase<pqb.QueryColumn<unknown, any>, unknown>, name?: string | undefined): pqb.NonUniqDataItem;
+    foreignKey<Shape>(columns: [string, ...string[]], fnOrTable: () => new () => {
+        columns: {
+            shape: Shape;
+        };
+    }, foreignColumns: [keyof Shape, ...(keyof Shape)[]], options?: TableData.References.Options | undefined): pqb.NonUniqDataItem;
+    foreignKey(columns: [string, ...string[]], fnOrTable: string, foreignColumns: [string, ...string[]], options?: TableData.References.Options | undefined): pqb.NonUniqDataItem;
+    check(check: RawSQLBase<Column.Pick.QueryColumn, unknown>, name?: string | undefined): pqb.NonUniqDataItem;
     sql: pqb.SqlFn;
     enum(name: string): EnumColumn<pqb.DefaultSchemaConfig, undefined, [string, ...string[]]>;
 };
 type TableChanger<CT> = MigrationColumnTypes<CT> & TableChangeMethods;
-type TableChangeData = Record<string, RakeDbAst.ChangeTableItem.Column | RakeDbAst.ChangeTableItem.Rename | Change | SpecialChange | ColumnTypeBase>;
+type TableChangeData = Record<string, RakeDbAst.ChangeTableItem.Column | RakeDbAst.ChangeTableItem.Rename | Change | SpecialChange | Column.Pick.Data>;
 
 interface RakeDbCtx {
     migrationsPromise?: Promise<MigrationsSet>;
@@ -492,7 +497,7 @@ interface RakeDbRenameMigrationsInput {
     map: RakeDbRenameMigrationsMap;
 }
 declare const migrationConfigDefaults: RakeDbBaseConfig<ColumnSchemaConfig>;
-declare const processRakeDbConfig: <SchemaConfig extends ColumnSchemaConfig<pqb.ColumnTypeBase<pqb.ColumnTypeSchemaArg, unknown, any, any, unknown, unknown, any, unknown, any, pqb.ColumnDataBase>>, CT>(config: InputRakeDbConfig<SchemaConfig, CT>, args?: string[]) => RakeDbConfig<SchemaConfig, CT>;
+declare const processRakeDbConfig: <SchemaConfig extends ColumnSchemaConfig<pqb.Column.Pick.Data>, CT>(config: InputRakeDbConfig<SchemaConfig, CT>, args?: string[]) => RakeDbConfig<SchemaConfig, CT>;
 
 type DropMode = 'CASCADE' | 'RESTRICT';
 type TableOptions = {
@@ -741,7 +746,7 @@ declare class Migration<CT> {
      * @param columnName - name of the column to add
      * @param fn - function returning a type of the column
      */
-    addColumn(tableName: string, columnName: string, fn: (t: MigrationColumnTypes<CT>) => ColumnType): Promise<void>;
+    addColumn(tableName: string, columnName: string, fn: (t: MigrationColumnTypes<CT>) => Column): Promise<void>;
     /**
      * Drop the schema, create it on rollback. See {@link addColumn}.
      *
@@ -749,7 +754,7 @@ declare class Migration<CT> {
      * @param columnName - name of the column to add
      * @param fn - function returning a type of the column
      */
-    dropColumn(tableName: string, columnName: string, fn: (t: MigrationColumnTypes<CT>) => ColumnType): Promise<void>;
+    dropColumn(tableName: string, columnName: string, fn: (t: MigrationColumnTypes<CT>) => Column): Promise<void>;
     /**
      * Add an index to the table on migrating, and remove it on rollback.
      *
@@ -1497,7 +1502,7 @@ interface RakeDbChangeFnWithPromise<CT> extends RakeDbChangeFn<CT> {
 declare const rakeDbWithAdapters: RakeDbFn<AdapterBase[]>;
 declare const makeChange: (config: RakeDbConfig<ColumnSchemaConfig, unknown>) => (fn: ChangeCallback<unknown>) => MigrationChange;
 
-declare const encodeColumnDefault: (def: unknown, values: unknown[], column?: ColumnTypeBase) => string | null;
+declare const encodeColumnDefault: (def: unknown, values: unknown[], column?: Column.Pick.Data) => string | null;
 declare const getConstraintName: (table: string, constraint: {
     references?: {
         columns: string[];
@@ -1730,14 +1735,14 @@ interface StructureToAstTableData {
 declare const makeStructureToAstCtx: (config: AnyRakeDbConfig, currentSchema: string) => StructureToAstCtx;
 declare const structureToAst: (ctx: StructureToAstCtx, adapter: AdapterBase, config: AnyRakeDbConfig) => Promise<RakeDbAst[]>;
 declare const makeDomainsMap: (ctx: StructureToAstCtx, data: IntrospectedStructure) => DbStructureDomainsMap;
-declare const instantiateDbColumn: (ctx: StructureToAstCtx, data: IntrospectedStructure, domains: DbStructureDomainsMap, dbColumn: DbStructure.Column) => ColumnType<pqb.ColumnTypeSchemaArg, unknown, any, any, unknown, unknown, any, unknown, any>;
+declare const instantiateDbColumn: (ctx: StructureToAstCtx, data: IntrospectedStructure, domains: DbStructureDomainsMap, dbColumn: DbStructure.Column) => Column<pqb.ColumnTypeSchemaArg, unknown, any, any, unknown, unknown, any, unknown, any>;
 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[];
 }
 declare const getDbTableColumnsChecks: (tableData: StructureToAstTableData) => ColumnChecks;
-declare const dbColumnToAst: (ctx: StructureToAstCtx, data: IntrospectedStructure, domains: DbStructureDomainsMap, tableName: string, item: DbStructure.Column, table?: DbStructure.Table, tableData?: StructureToAstTableData, checks?: ColumnChecks) => [key: string, column: ColumnType];
+declare const dbColumnToAst: (ctx: StructureToAstCtx, data: IntrospectedStructure, domains: DbStructureDomainsMap, tableName: string, item: DbStructure.Column, table?: DbStructure.Table, tableData?: StructureToAstTableData, checks?: ColumnChecks) => [key: string, column: Column];
 
 declare const writeMigrationFile: (config: AnyRakeDbConfig, version: string, name: string, migrationCode: string) => Promise<void>;
 declare const makeFileVersion: (ctx: RakeDbCtx, config: AnyRakeDbConfig) => Promise<string>;
@@ -1755,7 +1760,7 @@ declare const makeMigrateAdapter: (config?: Partial<MigrateFnConfig>) => ((adapt
 declare class RakeDbError extends Error {
 }
 
-declare const runCommand: <SchemaConfig extends ColumnSchemaConfig<pqb.ColumnTypeBase<pqb.ColumnTypeSchemaArg, unknown, any, any, unknown, unknown, any, unknown, any, pqb.ColumnDataBase>>, CT>(adapters: AdapterBase[], config: RakeDbConfig<SchemaConfig, CT>, args?: string[]) => Promise<RakeDbResult>;
+declare const runCommand: <SchemaConfig extends ColumnSchemaConfig<pqb.Column.Pick.Data>, CT>(adapters: AdapterBase[], config: RakeDbConfig<SchemaConfig, CT>, args?: string[]) => Promise<RakeDbResult>;
 interface RakeDbCommand {
     run(adapters: AdapterBase[], config: AnyRakeDbConfig, args: string[]): MaybePromise<unknown>;
     help: string;

package/dist/index.js

@@ -623,14 +623,14 @@ const addOrDropChanges = [];
 function add(item, options) {
   pqb.consumeColumnName();
   setName(this, item);
-  if (item instanceof pqb.ColumnType) {
+  if (item instanceof pqb.Column) {
     const result = addOrDrop("add", item, options);
     if (result.type === "change") return result;
     addOrDropChanges.push(result);
     return addOrDropChanges.length - 1;
   }
   for (const key in item) {
-    if (item[key] instanceof pqb.ColumnTypeBase) {
+    if (item[key] instanceof pqb.Column) {
       const result = {};
       for (const key2 in item) {
         result[key2] = {
@@ -649,14 +649,14 @@ function add(item, options) {
 const drop = function(item, options) {
   pqb.consumeColumnName();
   setName(this, item);
-  if (item instanceof pqb.ColumnType) {
+  if (item instanceof pqb.Column) {
     const result = addOrDrop("drop", item, options);
     if (result.type === "change") return result;
     addOrDropChanges.push(result);
     return addOrDropChanges.length - 1;
   }
   for (const key in item) {
-    if (item[key] instanceof pqb.ColumnTypeBase) {
+    if (item[key] instanceof pqb.Column) {
       const result = {};
       for (const key2 in item) {
         result[key2] = {
@@ -698,7 +698,7 @@ const addOrDrop = (type, item, options) => {
   };
 };
 const columnTypeToColumnChange = (item, name) => {
-  if (item instanceof pqb.ColumnType) {
+  if (item instanceof pqb.Column) {
     let column = item;
     const foreignKeys = column.data.foreignKeys;
     if (foreignKeys?.some((it) => "fn" in it)) {
@@ -720,9 +720,9 @@ const setName = (self, item) => {
   var _a, _b;
   const name = self[nameKey];
   if (!name) return;
-  if ("column" in item && item.column instanceof pqb.ColumnType) {
+  if ("column" in item && item.column instanceof pqb.Column) {
     (_a = item.column.data).name ?? (_a.name = name);
-  } else if (item instanceof pqb.ColumnType) {
+  } else if (item instanceof pqb.Column) {
     (_b = item.data).name ?? (_b.name = name);
   } else {
     item.name ?? (item.name = name);
@@ -823,7 +823,7 @@ const makeAst$1 = (up, name, changeData, changeTableData2, options) => {
     if (typeof item === "number") {
       consumedChanges[item] = true;
       item = addOrDropChanges[item];
-    } else if (item instanceof pqb.ColumnType) {
+    } else if (item instanceof pqb.Column) {
       item = addOrDrop("add", item);
     }
     if ("type" in item) {
@@ -3285,7 +3285,7 @@ const ensureMigrationsPath = (config) => {
 };
 const ensureBasePathAndDbScript = (config, intermediateCallers = 0) => {
   if (config.basePath && config.dbScript) return config;
-  let filePath = pqb.getStackTrace()?.[3 + intermediateCallers].getFileName();
+  let filePath = pqb.getStackTrace()?.[3 + intermediateCallers]?.getFileName();
   if (!filePath) {
     throw new Error(
       "Failed to determine path to db script. Please set basePath option of rakeDb"