rake-db 2.10.35 → 2.10.36

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 import * as orchid_core from 'orchid-core';
 import { ColumnTypesBase, EmptyObject, RawSQLBase, MaybeArray } from 'orchid-core';
-import * as pqb from 'pqb';
 import { ColumnsShape, Db as Db$1, ColumnType, EnumColumn, raw, Adapter, DefaultColumnTypes, DbResult, TransactionAdapter, QueryLogObject, IndexColumnOptions, IndexOptions, ForeignKeyOptions, TextColumn, NoPrimaryKeyOption, TableData, SingleColumnIndexOptions, AdapterOptions, QueryLogOptions } from 'pqb';
 
 type CreateTableResult<Table extends string, Shape extends ColumnsShape> = {
@@ -973,11 +972,12 @@ type RakeDbConfig<CT extends ColumnTypesBase = DefaultColumnTypes> = {
     migrationsTable: string;
     snakeCase: boolean;
     language?: string;
-    commands: Record<string, (options: AdapterOptions[], config: RakeDbConfig<CT>, args: string[]) => Promise<void>>;
+    commands: Record<string, (options: AdapterOptions[], config: RakeDbConfig<CT>, args: string[]) => void | Promise<void>>;
     noPrimaryKey?: NoPrimaryKeyOption;
     baseTable?: BaseTable<CT>;
     appCodeUpdater?: AppCodeUpdater;
     useCodeUpdater?: boolean;
+    forceDefaultExports?: boolean;
     import(path: string): Promise<unknown>;
     beforeMigrate?(db: Db): Promise<void>;
     afterMigrate?(db: Db): Promise<void>;
@@ -1038,142 +1038,43 @@ declare const rollback: <CT extends Record<string, orchid_core.AnyColumnTypeCrea
  */
 declare const redo: <CT extends Record<string, orchid_core.AnyColumnTypeCreator>>(options: MaybeArray<AdapterOptions>, config: RakeDbConfig<CT>, args?: string[]) => Promise<void>;
 
-declare const rakeDb: <CT extends Record<string, orchid_core.AnyColumnTypeCreator> = {
-    timestamps<T extends orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>>(this: {
-        name(name: string): {
-            timestamp(): T;
-        };
-        timestamp(): T;
-        timestampsSnakeCase(): {
-            createdAt: orchid_core.ColumnWithDefault<T, orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}>>;
-            updatedAt: orchid_core.ColumnWithDefault<T, orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}>>;
-        };
-    }): {
-        createdAt: orchid_core.ColumnWithDefault<T, orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}>>;
-        updatedAt: orchid_core.ColumnWithDefault<T, orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}>>;
-    };
-    timestampsSnakeCase<T_1 extends orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>>(this: {
-        name(name: string): {
-            timestamp(): T_1;
-        };
-        timestamp(): T_1;
-    }): {
-        createdAt: orchid_core.ColumnWithDefault<T_1, orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}>>;
-        updatedAt: orchid_core.ColumnWithDefault<T_1, orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}>>;
-    };
-    timestampsNoTZ<T_2 extends orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>>(this: {
-        name(name: string): {
-            timestampNoTZ(): T_2;
-        };
-        timestampNoTZ(): T_2;
-        timestampsNoTZSnakeCase(): {
-            createdAt: orchid_core.ColumnWithDefault<T_2, orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}>>;
-            updatedAt: orchid_core.ColumnWithDefault<T_2, orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}>>;
-        };
-    }): {
-        createdAt: orchid_core.ColumnWithDefault<T_2, orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}>>;
-        updatedAt: orchid_core.ColumnWithDefault<T_2, orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}>>;
-    };
-    timestampsNoTZSnakeCase<T_3 extends orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>>(this: {
-        name(name: string): {
-            timestampNoTZ(): T_3;
-        };
-        timestampNoTZ(): T_3;
-    }): {
-        createdAt: orchid_core.ColumnWithDefault<T_3, orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}>>;
-        updatedAt: orchid_core.ColumnWithDefault<T_3, orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}>>;
-    };
-    name: typeof orchid_core.name;
-    sql: {
-        (sql: TemplateStringsArray, ...values: unknown[]): orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}>;
-        (sql: string): orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}>;
-        (values: Record<string, unknown>, sql: string): orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}>;
-        (values: Record<string, unknown>): (strings: TemplateStringsArray, ...values: unknown[]) => orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}>;
-    };
-    smallint(): pqb.SmallIntColumn;
-    integer(): pqb.IntegerColumn;
-    bigint(): pqb.BigIntColumn;
-    numeric<Precision extends number | undefined = undefined, Scale extends number | undefined = undefined>(precision?: Precision | undefined, scale?: Scale | undefined): pqb.DecimalColumn<Precision, Scale>;
-    decimal<Precision_1 extends number | undefined = undefined, Scale_1 extends number | undefined = undefined>(precision?: Precision_1 | undefined, scale?: Scale_1 | undefined): pqb.DecimalColumn<Precision_1, Scale_1>;
-    real(): pqb.RealColumn;
-    doublePrecision(): pqb.DoublePrecisionColumn;
-    identity(options?: pqb.TableData.Identity | undefined): orchid_core.ColumnWithDefault<pqb.IntegerColumn, orchid_core.Expression<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>>>;
-    smallSerial(): pqb.SmallSerialColumn;
-    serial(): pqb.SerialColumn;
-    bigSerial(): pqb.BigSerialColumn;
-    money(): pqb.MoneyColumn;
-    varchar<Limit extends number | undefined = undefined>(limit?: Limit | undefined): pqb.VarCharColumn<Limit>;
-    char<Limit_1 extends number | undefined = undefined>(limit?: Limit_1 | undefined): pqb.CharColumn<Limit_1>;
-    text: (min: number, max: number) => pqb.TextColumn;
-    string: (min: number, max: number) => pqb.TextColumn;
-    citext(min: number, max: number): pqb.CitextColumn;
-    bytea(): pqb.ByteaColumn;
-    date(): pqb.DateColumn;
-    timestampNoTZ<Precision_2 extends number>(precision?: Precision_2 | undefined): pqb.TimestampColumn<Precision_2>;
-    timestamp<Precision_3 extends number | undefined = undefined>(precision?: Precision_3 | undefined): pqb.TimestampTZColumn<number>;
-    time<Precision_4 extends number | undefined = undefined>(precision?: Precision_4 | undefined): pqb.TimeColumn<Precision_4>;
-    interval<Fields extends string | undefined = undefined, Precision_5 extends number | undefined = undefined>(fields?: Fields | undefined, precision?: Precision_5 | undefined): pqb.IntervalColumn<Fields, Precision_5>;
-    boolean(): pqb.BooleanColumn;
-    enum<U extends string, T_4 extends [U, ...U[]]>(dataType: string, type: T_4): pqb.EnumColumn<U, T_4>;
-    point(): pqb.PointColumn;
-    line(): pqb.LineColumn;
-    lseg(): pqb.LsegColumn;
-    box(): pqb.BoxColumn;
-    path(): pqb.PathColumn;
-    polygon(): pqb.PolygonColumn;
-    circle(): pqb.CircleColumn;
-    cidr(): pqb.CidrColumn;
-    inet(): pqb.InetColumn;
-    macaddr(): pqb.MacAddrColumn;
-    macaddr8(): pqb.MacAddr8Column;
-    bit<Length extends number>(length: Length): pqb.BitColumn<Length>;
-    bitVarying<Length_1 extends number | undefined = undefined>(length?: Length_1 | undefined): pqb.BitVaryingColumn<Length_1>;
-    tsvector(): pqb.TsVectorColumn;
-    tsquery(): pqb.TsQueryColumn;
-    uuid(): pqb.UUIDColumn;
-    xml(): pqb.XMLColumn;
-    json<Type extends orchid_core.JSONType<unknown, {}> = orchid_core.JSONUnknown>(schemaOrFn?: Type | ((j: {
-        unknown: () => orchid_core.JSONUnknown;
-        boolean: () => orchid_core.JSONBoolean;
-        null: () => orchid_core.JSONNull;
-        number: <T_5 extends number = number>() => orchid_core.JSONNumber<T_5>;
-        string: <T_6 extends string = string>() => orchid_core.JSONString<T_6>;
-        array: <T_7 extends orchid_core.JSONType<unknown, {}>>(item: T_7) => orchid_core.JSONArray<T_7, "many">;
-        object: <Shape extends orchid_core.JSONObjectShape>(shape: Shape) => orchid_core.JSONObject<Shape, "strip", orchid_core.JSONType<unknown, {}>>;
-        literal: <T_8 extends orchid_core.JSONPrimitive>(value: T_8) => orchid_core.JSONLiteral<T_8>;
-        discriminatedUnion: <Discriminator extends string, Types extends orchid_core.JSONDiscriminatedUnionArg<Discriminator>>(discriminator: Discriminator, types: Types) => orchid_core.JSONDiscriminatedUnion<Discriminator, Types>;
-        enum: <U_1 extends string, T_9 extends [U_1, ...U_1[]]>(options: T_9) => orchid_core.JSONEnum<string, T_9>;
-        intersection: <Left extends orchid_core.JSONType<unknown, {}>, Right extends orchid_core.JSONType<unknown, {}>>(left: Left, right: Right) => orchid_core.JSONIntersection<Left, Right>;
-        lazy: <T_10 extends orchid_core.JSONType<unknown, {}>>(fn: () => T_10) => orchid_core.JSONLazy<T_10>;
-        nativeEnum: <T_11 extends orchid_core.EnumLike>(type: T_11) => orchid_core.JSONNativeEnum<T_11>;
-        record: <Key extends orchid_core.JSONString<string> | orchid_core.JSONNumber<number>, Value extends orchid_core.JSONType<unknown, {}>>(...args: [value: Value] | [key: Key, value: Value]) => orchid_core.JSONRecord<Key, Value>;
-        tuple: <T_12 extends orchid_core.JSONTupleItems, Rest extends orchid_core.JSONType<unknown, {}> | undefined = undefined>(items: T_12, rest?: Rest | undefined) => orchid_core.JSONTuple<T_12, Rest>;
-        union: <T_13 extends orchid_core.JSONUnionArgs>(...types: T_13) => orchid_core.JSONUnion<T_13>;
-    }) => Type) | undefined): pqb.JSONColumn<Type>;
-    jsonText(): pqb.JSONTextColumn;
-    array<Item extends pqb.ColumnType<unknown, pqb.BaseOperators, unknown, unknown, unknown>>(item: Item): pqb.ArrayColumn<Item>;
-    type(dataType: string): pqb.CustomTypeColumn;
-    domain(dataType: string): pqb.DomainColumn;
-    primaryKey(columns: string[], options?: {
-        name?: string | undefined;
-    } | undefined): {};
-    index(columns: MaybeArray<string | pqb.IndexColumnOptions>, options?: pqb.IndexOptions): {};
-    unique(columns: MaybeArray<string | pqb.IndexColumnOptions>, options?: pqb.IndexOptions | undefined): {};
-    searchIndex(columns: MaybeArray<string | pqb.IndexColumnOptions>, options?: pqb.IndexOptions | undefined): {};
-    constraint<Table extends string | (() => orchid_core.ForeignKeyTable), Columns extends Table extends () => orchid_core.ForeignKeyTable ? [orchid_core.ColumnNameOfTable<ReturnType<Table>>, ...orchid_core.ColumnNameOfTable<ReturnType<Table>>[]] : [string, ...string[]]>({ name, references, check, dropMode, }: {
-        name?: string | undefined;
-        references?: [columns: string[], fnOrTable: Table, foreignColumns: Columns, options?: pqb.ForeignKeyOptions | undefined] | undefined;
-        check?: orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}> | undefined;
-        dropMode?: pqb.DropMode | undefined;
-    }): {};
-    foreignKey<Table_1 extends string | (() => orchid_core.ForeignKeyTable), Columns_1 extends Table_1 extends () => orchid_core.ForeignKeyTable ? [orchid_core.ColumnNameOfTable<ReturnType<Table_1>>, ...orchid_core.ColumnNameOfTable<ReturnType<Table_1>>[]] : [string, ...string[]]>(columns: string[], fnOrTable: Table_1, foreignColumns: Columns_1, options?: (pqb.ForeignKeyOptions & {
-        name?: string | undefined;
-        dropMode?: pqb.DropMode | undefined;
-    }) | undefined): {};
-    check(check: orchid_core.RawSQLBase<orchid_core.ColumnTypeBase<unknown, orchid_core.BaseOperators, unknown, unknown, unknown, orchid_core.ColumnDataBase>, {}>): {};
-}>(options: MaybeArray<AdapterOptions>, partialConfig?: InputRakeDbConfig<CT>, args?: string[]) => ((fn: ChangeCallback<CT>) => void) & {
+/**
+ * Type of {@link rakeDb} function
+ */
+type RakeDbFn = (<C extends ColumnTypesBase = DefaultColumnTypes>(options: MaybeArray<AdapterOptions>, partialConfig?: InputRakeDbConfig<C>, args?: string[]) => RakeDbChangeFn<C> & {
     promise: Promise<void>;
+}) & {
+    /**
+     * Unlike the original `rakeDb` that executes immediately,
+     * `rakeDb.lazy` returns the `run` function to be later called programmatically.
+     *
+     * @param options - {@link AdapterOptions} or an array of such options to migrate multiple dbs
+     * @param config - {@link RakeDbConfig}
+     * @returns `change` is to be used in migrations, `run` takes an array cli args to execute a command
+     */
+    lazy: RakeDbLazyFn;
+};
+/**
+ * Type of {@link rakeDb.lazy} function
+ */
+type RakeDbLazyFn = <C extends ColumnTypesBase = DefaultColumnTypes>(options: MaybeArray<AdapterOptions>, partialConfig?: InputRakeDbConfig<C>) => {
+    change: RakeDbChangeFn<C>;
+    run(args: string[]): Promise<void>;
 };
+/**
+ * Function to use in migrations to wrap database changes
+ * Saves the given callback to an internal queue,
+ * and also returns the callback in case you want to export it from migration.
+ */
+type RakeDbChangeFn<C extends ColumnTypesBase> = (fn: ChangeCallback<C>) => ChangeCallback<C>;
+/**
+ * Function to configure and run `rakeDb`.
+ *
+ * @param options - {@link AdapterOptions} or an array of such options to migrate multiple dbs
+ * @param config - {@link RakeDbConfig}
+ * @param args - optionally provide an array of cli args. Default is `process.argv.slice(2)`.
+ */
+declare const rakeDb: RakeDbFn;
 
 declare const saveMigratedVersion: <CT extends Record<string, orchid_core.AnyColumnTypeCreator>>(db: SilentQueries, version: string, config: RakeDbConfig<CT>) => Promise<void>;
 declare const removeMigratedVersion: <CT extends Record<string, orchid_core.AnyColumnTypeCreator>>(db: SilentQueries, version: string, config: RakeDbConfig<CT>) => Promise<void>;

package/dist/index.js

@@ -238,7 +238,7 @@ function getMigrationsFromConfig(config, up) {
     result.push({
       path: path.resolve(basePath, key),
       version: getVersion(path.basename(key)),
-      change: migrations[key]
+      load: migrations[key]
     });
   }
   if (!up)
@@ -261,7 +261,7 @@ async function getMigrationsFromFiles(config, up) {
     return {
       path: filePath,
       version: getVersion(file),
-      async change() {
+      async load() {
         try {
           await imp(filePath);
         } catch (err) {
@@ -2302,8 +2302,14 @@ const processMigration = async (db, up, file, config, options, appCodeUpdaterCac
     clearChanges();
     let changes = changeCache[file.path];
     if (!changes) {
-      await file.change();
-      changes = getCurrentChanges();
+      const module = await file.load();
+      const exported = (module == null ? void 0 : module.default) && orchidCore.toArray(module.default);
+      if (config.forceDefaultExports && !exported) {
+        throw new RakeDbError(
+          `Missing a default export in ${file.path} migration`
+        );
+      }
+      changes = exported || getCurrentChanges();
       changeCache[file.path] = changes;
     }
     const db2 = createMigrationInterface(tx, up, config);
@@ -3746,50 +3752,57 @@ const readdirRecursive = async (dirPath, cb) => {
 
 const rakeDb = (options, partialConfig = {}, args = process.argv.slice(2)) => {
   const config = processRakeDbConfig(partialConfig);
-  const promise = runCommand(options, config, args);
-  return Object.assign(
-    (fn) => {
-      pushChange(fn);
-    },
-    {
-      promise
-    }
-  );
-};
-const runCommand = async (options, config, args = process.argv.slice(2)) => {
-  var _a, _b, _c;
-  const arg = (_a = args[0]) == null ? void 0 : _a.split(":")[0];
-  try {
-    if (arg === "create") {
-      await createDb(options, config);
-    } else if (arg === "drop") {
-      await dropDb(options, config);
-    } else if (arg === "reset") {
-      await resetDb(options, config);
-    } else if (arg === "up" || arg === "migrate") {
-      await migrate(options, config, args.slice(1));
-    } else if (arg === "down" || arg === "rollback") {
-      await rollback(options, config, args.slice(1));
-    } else if (arg === "redo") {
-      await redo(options, config, args.slice(1));
-    } else if (arg === "new") {
-      await generate(config, args.slice(1));
-    } else if (arg === "pull") {
-      await pullDbStructure(orchidCore.toArray(options)[0], config);
-    } else if (config.commands[arg]) {
-      await config.commands[arg](orchidCore.toArray(options), config, args.slice(1));
-    } else if (arg !== "rec" && arg !== "recurrent") {
-      (_b = config.logger) == null ? void 0 : _b.log(help);
-    }
-    if (arg === "migrate" || arg === "rec" || arg === "recurrent" || arg === "redo") {
-      await runRecurrentMigrations(options, config);
-    }
-  } catch (err) {
+  const promise = runCommand(options, config, args).catch((err) => {
+    var _a;
     if (err instanceof RakeDbError) {
-      (_c = config.logger) == null ? void 0 : _c.error(err.message);
+      (_a = config.logger) == null ? void 0 : _a.error(err.message);
       process.exit(1);
     }
     throw err;
+  });
+  return Object.assign(change, {
+    promise
+  });
+};
+rakeDb.lazy = (options, partialConfig = {}) => {
+  const config = processRakeDbConfig(partialConfig);
+  return {
+    change,
+    run(args) {
+      return runCommand(options, config, args);
+    }
+  };
+};
+function change(fn) {
+  pushChange(fn);
+  return fn;
+}
+const runCommand = async (options, config, args = process.argv.slice(2)) => {
+  var _a, _b;
+  const arg = (_a = args[0]) == null ? void 0 : _a.split(":")[0];
+  if (arg === "create") {
+    await createDb(options, config);
+  } else if (arg === "drop") {
+    await dropDb(options, config);
+  } else if (arg === "reset") {
+    await resetDb(options, config);
+  } else if (arg === "up" || arg === "migrate") {
+    await migrate(options, config, args.slice(1));
+  } else if (arg === "down" || arg === "rollback") {
+    await rollback(options, config, args.slice(1));
+  } else if (arg === "redo") {
+    await redo(options, config, args.slice(1));
+  } else if (arg === "new") {
+    await generate(config, args.slice(1));
+  } else if (arg === "pull") {
+    await pullDbStructure(orchidCore.toArray(options)[0], config);
+  } else if (config.commands[arg]) {
+    await config.commands[arg](orchidCore.toArray(options), config, args.slice(1));
+  } else if (arg !== "rec" && arg !== "recurrent") {
+    (_b = config.logger) == null ? void 0 : _b.log(help);
+  }
+  if (arg === "migrate" || arg === "rec" || arg === "recurrent" || arg === "redo") {
+    await runRecurrentMigrations(options, config);
   }
 };
 const help = `Usage: rake-db [command] [arguments]