@h3ravel/arquebus 0.3.5 → 0.4.0

package/dist/migrations/index.d.cts

@@ -248,7 +248,7 @@ declare class arquebus<M extends Model = Model> {
   static setConnectorFactory(connectorFactory: typeof Knex$1): void;
   static getConnectorFactory(): typeof Knex$1;
   static addConnection(config: TConfig | TBaseConfig, name?: string): void;
-  static beginTransaction(connection?: null): Promise<Knex$1.Knex.Transaction<any, any[]> | undefined>;
+  static beginTransaction(connection?: null): Promise<Knex$1.Knex.Transaction<any, any[]>>;
   static transaction(callback: TFunction, connection?: null): Promise<Knex$1.Knex.Transaction<any, any[]>> | undefined;
   static table(name: string, connection?: null): IQueryBuilder<Model, Model | Model[]>;
   static schema(connection?: null): SchemaBuilder;
@@ -268,7 +268,7 @@ declare class arquebus<M extends Model = Model> {
    * @returns
    */
   static autoLoad(addConnection?: boolean): Promise<TBaseConfig>;
-  beginTransaction(connection?: null): Promise<Knex$1.Knex.Transaction<any, any[]> | undefined>;
+  beginTransaction(connection?: null): Promise<Knex$1.Knex.Transaction<any, any[]>>;
   transaction(callback: TFunction, connection?: null): Promise<Knex$1.Knex.Transaction<any, any[]>> | undefined;
   table(name: string, connection?: null): IQueryBuilder<M, M | M[]>;
   schema(connection?: null): SchemaBuilder;
@@ -989,9 +989,92 @@ interface JoinMethod<QB extends AnyQueryBuilder> {
   (raw: Raw): QB;
 }
 //#endregion
+//#region src/inspector/types/column.d.ts
+interface Column {
+  name: string;
+  table: string;
+  data_type: string;
+  default_value: string | null;
+  max_length: number | null;
+  numeric_precision: number | null;
+  numeric_scale: number | null;
+  is_nullable: boolean;
+  is_unique: boolean;
+  is_primary_key: boolean;
+  is_generated: boolean;
+  generation_expression?: string | null;
+  has_auto_increment: boolean;
+  foreign_key_table: string | null;
+  foreign_key_column: string | null;
+  comment?: string | null;
+  schema?: string;
+  foreign_key_schema?: string | null;
+  collation?: string | null;
+}
+//#endregion
+//#region src/inspector/types/foreign-key.d.ts
+type ForeignKey = {
+  table: string;
+  column: string;
+  foreign_key_table: string;
+  foreign_key_column: string;
+  foreign_key_schema?: string;
+  constraint_name: null | string;
+  on_update: null | 'NO ACTION' | 'RESTRICT' | 'CASCADE' | 'SET NULL' | 'SET DEFAULT';
+  on_delete: null | 'NO ACTION' | 'RESTRICT' | 'CASCADE' | 'SET NULL' | 'SET DEFAULT';
+};
+//#endregion
+//#region src/inspector/types/table.d.ts
+interface Table {
+  name: string;
+  comment?: string | null;
+  schema?: string;
+  collation?: string;
+  engine?: string;
+  owner?: string;
+  sql?: string;
+  catalog?: string;
+}
+//#endregion
 //#region types/query-builder.d.ts
 interface SchemaBuilder extends Knex.SchemaBuilder {
   [k: string]: any;
+  /**
+   * Retrieve all tables in the current database.
+   */
+  tables(): Promise<string[]>;
+  /**
+   * Retrieve the table info for the given table, or all tables if no table is specified.
+   *
+   * @param table
+   */
+  tableInfo(table?: string): Promise<Table | Table[]>;
+  /**
+   * Retrieve all columns in a given table, or all columns if no table is specified.
+   *
+   * @param table
+   */
+  columns(table?: string): Promise<{
+    table: string;
+    column: string;
+  }[]>;
+  /**
+   * Retrieve all columns from a given table. Returns all columns if table parameter is undefined.
+   *
+   * @param table
+   * @param column
+   */
+  columnInfo(table?: string, column?: string): Promise<Column[] | Column>;
+  /**
+   * Retrieve the primary key column for a given table.
+   *
+   * @param table
+   */
+  primary(table: string): Promise<string>;
+  /**
+   * Retrieve all configured foreign key constraints
+   */
+  foreignKeys(): Promise<ForeignKey>;
 }
 interface AsMethod<QB extends AnyQueryBuilder> {
   (alias: string): QB;
@@ -1122,7 +1205,7 @@ interface IQueryBuilder<M extends Model | Model$1 = Model, R = M[] | M> {
   take(count: number): this;
   limit(count: number): this;
   offset(count: number): this;
-  pluck<X extends Model = any>(column: string): Promise<ICollection<X>>;
+  pluck<X extends Model = any>(column: string): Promise<Array<X>>;
   chunk(count: number, callback: (rows: M[]) => any): Promise<boolean>;
   forPage(page: number, perPage?: number): this;
   paginate<F extends IPaginatorParams>(page?: number, perPage?: number): Promise<IPaginator<M, F>>;
@@ -1135,10 +1218,13 @@ declare const Inference$1: {
 declare class QueryBuilder<M extends Model = Model, R = M[] | M> extends Inference$1<M, R> {
   model: M;
   schema: SchemaBuilder;
-  private connector;
+  connector: IQueryBuilder<M, R> & Knex.QueryBuilder & {
+    _statements: any[];
+    _single: any;
+  } & Knex;
   constructor(config: TConfig | null, connector: TFunction);
   asProxy(): any;
-  beginTransaction(): Promise<Knex.Transaction<any, any[]> | undefined>;
+  beginTransaction(): Promise<Knex.Transaction<any, any[]>>;
   table<X extends M>(table: string): IQueryBuilder<X, R>;
   transaction(callback?: TFunction): Promise<Knex.Transaction> | undefined;
   find(id: string | number, columns?: string[]): Promise<any>;
@@ -1162,7 +1248,7 @@ declare class QueryBuilder<M extends Model = Model, R = M[] | M> extends Inferen
   destroy(...args: Parameters<typeof (void 0).connector.destroy>): Promise<number>;
   get _statements(): IStatement[] & any[];
   get _single(): any;
-  get from(): Knex.Table<any, any>;
+  get from(): Knex.Table<any, any> & Knex.Table<any, any[]>;
 }
 declare namespace migration_d_exports {
   export { IMigration, Migration, Migration as default };
@@ -1181,15 +1267,14 @@ declare class Migration extends Inference {
   withinTransaction: boolean;
   getConnection(): TBaseConfig['client'];
 }
-declare namespace migration_repository_d_exports {
-  export { MigrationRepository, MigrationRepository as default };
-}
+//#endregion
+//#region src/migrations/migration-repository.d.ts
 declare class MigrationRepository {
   resolver: typeof arquebus;
   table: string;
   connection: TBaseConfig['client'] | null;
   constructor(resolver: typeof arquebus, table: string);
-  getRan(): Promise<ICollection<any>>;
+  getRan(): Promise<any[]>;
   getMigrations(steps: number): Promise<any>;
   getMigrationsByBatch(batch: number): Promise<any>;
   getLast(): Promise<any>;
@@ -1206,12 +1291,13 @@ declare class MigrationRepository {
   setSource(name: TBaseConfig['client']): void;
 }
 declare namespace migrator_d_exports {
-  export { MigrationOptions, Migrator as default };
+  export { MigrationOptions, Migrator, Migrator as default };
 }
 interface MigrationOptions {
   pretend?: boolean;
   step?: number;
   batch?: number;
+  quiet?: boolean;
 }
 declare class Migrator {
   events: any;
@@ -1236,7 +1322,14 @@ declare class Migrator {
   rollbackMigrations(migrations: {
     migration: string;
   }[], paths: string[], options: MigrationOptions): Promise<string[]>;
-  reset(_paths?: string[], _pretend?: boolean): Promise<string[]> | string[];
+  reset(paths: string[] | undefined, options: MigrationOptions, pretend?: boolean): Promise<string[]>;
+  /**
+   * Drop all tables and re-run all migrations
+   *
+   * @param paths
+   * @param options
+   */
+  fresh(paths: string[], options: MigrationOptions): Promise<void>;
   resetMigrations(migrations: {
     migration: string;
   }[], paths: string[], pretend?: boolean): Promise<string[]>;
@@ -1256,7 +1349,7 @@ declare class Migrator {
   deleteRepository(): void;
   setOutput(output: boolean): this;
   write(...args: any[]): void;
-  writeTask(description: string, task: () => Promise<any> | any): Promise<void>;
+  taskRunner(description: string, task: (() => Promise<any>) | (() => any)): Promise<void>;
 }
 //#endregion
 //#region src/migrate.d.ts
@@ -1270,6 +1363,7 @@ interface MigrateOptions {
   step?: number;
   pretend?: boolean;
   batch?: number;
+  quiet?: boolean;
 }
 type TXBaseConfig<S = boolean> = (S extends true ? Partial<TBaseConfig> : TBaseConfig) & {
   /**
@@ -1301,6 +1395,30 @@ declare class Migrate {
    * @param destroyAll
    */
   rollback(config: TXBaseConfig, options?: MigrateOptions, destroyAll?: boolean): Promise<void>;
+  /**
+   * Rollback all database migrations
+   *
+   * @param config
+   * @param options
+   * @param destroyAll
+   */
+  reset(config: TXBaseConfig, options?: MigrateOptions, destroyAll?: boolean): Promise<void>;
+  /**
+   * Reset and re-run all migrations
+   *
+   * @param config
+   * @param options
+   * @param destroyAll
+   */
+  refresh(config: TXBaseConfig, options?: MigrateOptions, destroyAll?: boolean): Promise<void>;
+  /**
+   * Drop all tables and re-run all migrations
+   *
+   * @param config
+   * @param options
+   * @param destroyAll
+   */
+  fresh(config: TXBaseConfig, options?: MigrateOptions, destroyAll?: boolean): Promise<void>;
   /**
    * Prepares the database for migration
    *
@@ -1327,9 +1445,8 @@ declare class Migrate {
     migrator: Migrator;
   }>;
 }
-declare namespace migration_creator_d_exports {
-  export { MigrationCreator, MigrationCreator as default };
-}
+//#endregion
+//#region src/migrations/migration-creator.d.ts
 declare class MigrationCreator {
   private customStubPath?;
   private type;
@@ -1363,4 +1480,4 @@ declare class MigrationCreator {
   getDirname(meta: ImportMeta | null): string;
 }
 //#endregion
-export { Migrate, migration_d_exports as Migration, migration_creator_d_exports as MigrationCreator, migration_repository_d_exports as MigrationRepository, migrator_d_exports as Migrator };
+export { Migrate, migration_d_exports as Migration, MigrationCreator, MigrationRepository, migrator_d_exports as Migrator };

package/dist/migrations/index.d.ts

@@ -1,5 +1,5 @@
-import Knex$1, { Knex } from "knex";
 import { Collection } from "collect.js";
+import Knex$1, { Knex } from "knex";
 
 //#region src/collection.d.ts
 declare class Collection$1<I extends Model | Model$1> extends Collection<I> implements ICollection<I> {
@@ -245,7 +245,7 @@ declare class arquebus<M extends Model = Model> {
   static setConnectorFactory(connectorFactory: typeof Knex$1): void;
   static getConnectorFactory(): typeof Knex$1;
   static addConnection(config: TConfig | TBaseConfig, name?: string): void;
-  static beginTransaction(connection?: null): Promise<Knex$1.Knex.Transaction<any, any[]> | undefined>;
+  static beginTransaction(connection?: null): Promise<Knex$1.Knex.Transaction<any, any[]>>;
   static transaction(callback: TFunction, connection?: null): Promise<Knex$1.Knex.Transaction<any, any[]>> | undefined;
   static table(name: string, connection?: null): IQueryBuilder<Model, Model | Model[]>;
   static schema(connection?: null): SchemaBuilder;
@@ -265,7 +265,7 @@ declare class arquebus<M extends Model = Model> {
    * @returns
    */
   static autoLoad(addConnection?: boolean): Promise<TBaseConfig>;
-  beginTransaction(connection?: null): Promise<Knex$1.Knex.Transaction<any, any[]> | undefined>;
+  beginTransaction(connection?: null): Promise<Knex$1.Knex.Transaction<any, any[]>>;
   transaction(callback: TFunction, connection?: null): Promise<Knex$1.Knex.Transaction<any, any[]>> | undefined;
   table(name: string, connection?: null): IQueryBuilder<M, M | M[]>;
   schema(connection?: null): SchemaBuilder;
@@ -986,9 +986,92 @@ interface JoinMethod<QB extends AnyQueryBuilder> {
   (raw: Raw): QB;
 }
 //#endregion
+//#region src/inspector/types/column.d.ts
+interface Column {
+  name: string;
+  table: string;
+  data_type: string;
+  default_value: string | null;
+  max_length: number | null;
+  numeric_precision: number | null;
+  numeric_scale: number | null;
+  is_nullable: boolean;
+  is_unique: boolean;
+  is_primary_key: boolean;
+  is_generated: boolean;
+  generation_expression?: string | null;
+  has_auto_increment: boolean;
+  foreign_key_table: string | null;
+  foreign_key_column: string | null;
+  comment?: string | null;
+  schema?: string;
+  foreign_key_schema?: string | null;
+  collation?: string | null;
+}
+//#endregion
+//#region src/inspector/types/foreign-key.d.ts
+type ForeignKey = {
+  table: string;
+  column: string;
+  foreign_key_table: string;
+  foreign_key_column: string;
+  foreign_key_schema?: string;
+  constraint_name: null | string;
+  on_update: null | 'NO ACTION' | 'RESTRICT' | 'CASCADE' | 'SET NULL' | 'SET DEFAULT';
+  on_delete: null | 'NO ACTION' | 'RESTRICT' | 'CASCADE' | 'SET NULL' | 'SET DEFAULT';
+};
+//#endregion
+//#region src/inspector/types/table.d.ts
+interface Table {
+  name: string;
+  comment?: string | null;
+  schema?: string;
+  collation?: string;
+  engine?: string;
+  owner?: string;
+  sql?: string;
+  catalog?: string;
+}
+//#endregion
 //#region types/query-builder.d.ts
 interface SchemaBuilder extends Knex.SchemaBuilder {
   [k: string]: any;
+  /**
+   * Retrieve all tables in the current database.
+   */
+  tables(): Promise<string[]>;
+  /**
+   * Retrieve the table info for the given table, or all tables if no table is specified.
+   *
+   * @param table
+   */
+  tableInfo(table?: string): Promise<Table | Table[]>;
+  /**
+   * Retrieve all columns in a given table, or all columns if no table is specified.
+   *
+   * @param table
+   */
+  columns(table?: string): Promise<{
+    table: string;
+    column: string;
+  }[]>;
+  /**
+   * Retrieve all columns from a given table. Returns all columns if table parameter is undefined.
+   *
+   * @param table
+   * @param column
+   */
+  columnInfo(table?: string, column?: string): Promise<Column[] | Column>;
+  /**
+   * Retrieve the primary key column for a given table.
+   *
+   * @param table
+   */
+  primary(table: string): Promise<string>;
+  /**
+   * Retrieve all configured foreign key constraints
+   */
+  foreignKeys(): Promise<ForeignKey>;
 }
 interface AsMethod<QB extends AnyQueryBuilder> {
   (alias: string): QB;
@@ -1119,7 +1202,7 @@ interface IQueryBuilder<M extends Model | Model$1 = Model, R = M[] | M> {
   take(count: number): this;
   limit(count: number): this;
   offset(count: number): this;
-  pluck<X extends Model = any>(column: string): Promise<ICollection<X>>;
+  pluck<X extends Model = any>(column: string): Promise<Array<X>>;
   chunk(count: number, callback: (rows: M[]) => any): Promise<boolean>;
   forPage(page: number, perPage?: number): this;
   paginate<F extends IPaginatorParams>(page?: number, perPage?: number): Promise<IPaginator<M, F>>;
@@ -1132,10 +1215,13 @@ declare const Inference$1: {
 declare class QueryBuilder<M extends Model = Model, R = M[] | M> extends Inference$1<M, R> {
   model: M;
   schema: SchemaBuilder;
-  private connector;
+  connector: IQueryBuilder<M, R> & Knex.QueryBuilder & {
+    _statements: any[];
+    _single: any;
+  } & Knex;
   constructor(config: TConfig | null, connector: TFunction);
   asProxy(): any;
-  beginTransaction(): Promise<Knex.Transaction<any, any[]> | undefined>;
+  beginTransaction(): Promise<Knex.Transaction<any, any[]>>;
   table<X extends M>(table: string): IQueryBuilder<X, R>;
   transaction(callback?: TFunction): Promise<Knex.Transaction> | undefined;
   find(id: string | number, columns?: string[]): Promise<any>;
@@ -1159,7 +1245,7 @@ declare class QueryBuilder<M extends Model = Model, R = M[] | M> extends Inferen
   destroy(...args: Parameters<typeof (void 0).connector.destroy>): Promise<number>;
   get _statements(): IStatement[] & any[];
   get _single(): any;
-  get from(): Knex.Table<any, any>;
+  get from(): Knex.Table<any, any> & Knex.Table<any, any[]>;
 }
 declare namespace migration_d_exports {
   export { IMigration, Migration, Migration as default };
@@ -1178,15 +1264,14 @@ declare class Migration extends Inference {
   withinTransaction: boolean;
   getConnection(): TBaseConfig['client'];
 }
-declare namespace migration_repository_d_exports {
-  export { MigrationRepository, MigrationRepository as default };
-}
+//#endregion
+//#region src/migrations/migration-repository.d.ts
 declare class MigrationRepository {
   resolver: typeof arquebus;
   table: string;
   connection: TBaseConfig['client'] | null;
   constructor(resolver: typeof arquebus, table: string);
-  getRan(): Promise<ICollection<any>>;
+  getRan(): Promise<any[]>;
   getMigrations(steps: number): Promise<any>;
   getMigrationsByBatch(batch: number): Promise<any>;
   getLast(): Promise<any>;
@@ -1203,12 +1288,13 @@ declare class MigrationRepository {
   setSource(name: TBaseConfig['client']): void;
 }
 declare namespace migrator_d_exports {
-  export { MigrationOptions, Migrator as default };
+  export { MigrationOptions, Migrator, Migrator as default };
 }
 interface MigrationOptions {
   pretend?: boolean;
   step?: number;
   batch?: number;
+  quiet?: boolean;
 }
 declare class Migrator {
   events: any;
@@ -1233,7 +1319,14 @@ declare class Migrator {
   rollbackMigrations(migrations: {
     migration: string;
   }[], paths: string[], options: MigrationOptions): Promise<string[]>;
-  reset(_paths?: string[], _pretend?: boolean): Promise<string[]> | string[];
+  reset(paths: string[] | undefined, options: MigrationOptions, pretend?: boolean): Promise<string[]>;
+  /**
+   * Drop all tables and re-run all migrations
+   *
+   * @param paths
+   * @param options
+   */
+  fresh(paths: string[], options: MigrationOptions): Promise<void>;
   resetMigrations(migrations: {
     migration: string;
   }[], paths: string[], pretend?: boolean): Promise<string[]>;
@@ -1253,7 +1346,7 @@ declare class Migrator {
   deleteRepository(): void;
   setOutput(output: boolean): this;
   write(...args: any[]): void;
-  writeTask(description: string, task: () => Promise<any> | any): Promise<void>;
+  taskRunner(description: string, task: (() => Promise<any>) | (() => any)): Promise<void>;
 }
 //#endregion
 //#region src/migrate.d.ts
@@ -1267,6 +1360,7 @@ interface MigrateOptions {
   step?: number;
   pretend?: boolean;
   batch?: number;
+  quiet?: boolean;
 }
 type TXBaseConfig<S = boolean> = (S extends true ? Partial<TBaseConfig> : TBaseConfig) & {
   /**
@@ -1298,6 +1392,30 @@ declare class Migrate {
    * @param destroyAll
    */
   rollback(config: TXBaseConfig, options?: MigrateOptions, destroyAll?: boolean): Promise<void>;
+  /**
+   * Rollback all database migrations
+   *
+   * @param config
+   * @param options
+   * @param destroyAll
+   */
+  reset(config: TXBaseConfig, options?: MigrateOptions, destroyAll?: boolean): Promise<void>;
+  /**
+   * Reset and re-run all migrations
+   *
+   * @param config
+   * @param options
+   * @param destroyAll
+   */
+  refresh(config: TXBaseConfig, options?: MigrateOptions, destroyAll?: boolean): Promise<void>;
+  /**
+   * Drop all tables and re-run all migrations
+   *
+   * @param config
+   * @param options
+   * @param destroyAll
+   */
+  fresh(config: TXBaseConfig, options?: MigrateOptions, destroyAll?: boolean): Promise<void>;
   /**
    * Prepares the database for migration
    *
@@ -1324,9 +1442,8 @@ declare class Migrate {
     migrator: Migrator;
   }>;
 }
-declare namespace migration_creator_d_exports {
-  export { MigrationCreator, MigrationCreator as default };
-}
+//#endregion
+//#region src/migrations/migration-creator.d.ts
 declare class MigrationCreator {
   private customStubPath?;
   private type;
@@ -1360,4 +1477,4 @@ declare class MigrationCreator {
   getDirname(meta: ImportMeta | null): string;
 }
 //#endregion
-export { Migrate, migration_d_exports as Migration, migration_creator_d_exports as MigrationCreator, migration_repository_d_exports as MigrationRepository, migrator_d_exports as Migrator };
+export { Migrate, migration_d_exports as Migration, MigrationCreator, MigrationRepository, migrator_d_exports as Migrator };