@h3ravel/arquebus 0.3.6 → 0.4.0

package/dist/index.d.cts

@@ -251,9 +251,92 @@ declare class Builder<M extends Model$1 = Model$1, R = IModel | ICollection<M>>
   hydrate(items: any[]): Collection<any>;
 }
 //#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;
@@ -384,7 +467,7 @@ interface IQueryBuilder<M extends Model$1 | Model$2 = Model$1, R = M[] | M> {
   take(count: number): this;
   limit(count: number): this;
   offset(count: number): this;
-  pluck<X extends Model$1 = any>(column: string): Promise<ICollection<X>>;
+  pluck<X extends Model$1 = 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>>;
@@ -577,10 +660,13 @@ declare const Inference$1: {
 declare class QueryBuilder<M extends Model$1 = Model$1, 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>;
@@ -604,7 +690,7 @@ declare class QueryBuilder<M extends Model$1 = Model$1, R = M[] | M> extends Inf
   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[]>;
 }
 //#endregion
 //#region src/relations/relation.d.ts
@@ -913,7 +999,7 @@ declare class arquebus<M extends Model$1 = Model$1> {
   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$1, Model$1 | Model$1[]>;
   static schema(connection?: null): SchemaBuilder;
@@ -933,7 +1019,7 @@ declare class arquebus<M extends Model$1 = Model$1> {
    * @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;
@@ -1234,7 +1320,7 @@ declare class MigrationRepository {
   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>;
@@ -1256,6 +1342,7 @@ interface MigrationOptions {
   pretend?: boolean;
   step?: number;
   batch?: number;
+  quiet?: boolean;
 }
 declare class Migrator {
   events: any;
@@ -1280,7 +1367,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[]>;
@@ -1300,7 +1394,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
@@ -1314,6 +1408,7 @@ interface MigrateOptions {
   step?: number;
   pretend?: boolean;
   batch?: number;
+  quiet?: boolean;
 }
 type TXBaseConfig<S = boolean> = (S extends true ? Partial<TBaseConfig> : TBaseConfig) & {
   /**
@@ -1345,6 +1440,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
    *
@@ -1492,6 +1611,7 @@ declare const getAttrName: (attrMethod: string) => string;
  */
 declare const tap: <I>(instance: I, callback: (ins: I) => Promise<I> | I) => Promise<I> | I;
 declare const compose: typeof compose$1;
+declare const flatten: <A = any>(arr: A[]) => (A extends readonly (infer InnerArr)[] ? InnerArr : A)[];
 declare const flattenDeep: (arr: any) => any;
 declare const kebabCase: (str: string) => string;
 declare const snakeCase: (str: string) => string;
@@ -1504,4 +1624,4 @@ declare const make: (model: Model$1, data: TGeneric, options?: {
 declare const makeCollection: (model: Model$1, data: TGeneric) => Collection<Model$1 | Model$2>;
 declare const makePaginator: (model: Model$1, data: TGeneric) => Paginator<Model$1, IPaginatorParams>;
 //#endregion
-export { Attribute, Builder, CastsAttributes, Collection, HasUniqueIds, InvalidArgumentError, Migrate, Migration, Model$1 as Model, ModelNotFoundError, Paginator, Pivot, QueryBuilder, RelationNotFoundError, Scope, softDeletes as SoftDeletes, arquebus, compose, defineConfig, flattenDeep, getAttrMethod, getAttrName, getGetterMethod, getRelationMethod, getRelationName, getScopeMethod, getScopeName, getSetterMethod, kebabCase, make, makeCollection, makePaginator, now, snakeCase, tap };
+export { Attribute, Builder, CastsAttributes, Collection, HasUniqueIds, InvalidArgumentError, Migrate, Migration, Model$1 as Model, ModelNotFoundError, Paginator, Pivot, QueryBuilder, RelationNotFoundError, Scope, softDeletes as SoftDeletes, arquebus, compose, defineConfig, flatten, flattenDeep, getAttrMethod, getAttrName, getGetterMethod, getRelationMethod, getRelationName, getScopeMethod, getScopeName, getSetterMethod, kebabCase, make, makeCollection, makePaginator, now, snakeCase, tap };

package/dist/index.d.ts

@@ -251,9 +251,92 @@ declare class Builder<M extends Model$1 = Model$1, R = IModel | ICollection<M>>
   hydrate(items: any[]): Collection<any>;
 }
 //#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;
@@ -384,7 +467,7 @@ interface IQueryBuilder<M extends Model$1 | Model$2 = Model$1, R = M[] | M> {
   take(count: number): this;
   limit(count: number): this;
   offset(count: number): this;
-  pluck<X extends Model$1 = any>(column: string): Promise<ICollection<X>>;
+  pluck<X extends Model$1 = 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>>;
@@ -577,10 +660,13 @@ declare const Inference$1: {
 declare class QueryBuilder<M extends Model$1 = Model$1, 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>;
@@ -604,7 +690,7 @@ declare class QueryBuilder<M extends Model$1 = Model$1, R = M[] | M> extends Inf
   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[]>;
 }
 //#endregion
 //#region src/relations/relation.d.ts
@@ -913,7 +999,7 @@ declare class arquebus<M extends Model$1 = Model$1> {
   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$1, Model$1 | Model$1[]>;
   static schema(connection?: null): SchemaBuilder;
@@ -933,7 +1019,7 @@ declare class arquebus<M extends Model$1 = Model$1> {
    * @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;
@@ -1234,7 +1320,7 @@ declare class MigrationRepository {
   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>;
@@ -1256,6 +1342,7 @@ interface MigrationOptions {
   pretend?: boolean;
   step?: number;
   batch?: number;
+  quiet?: boolean;
 }
 declare class Migrator {
   events: any;
@@ -1280,7 +1367,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[]>;
@@ -1300,7 +1394,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
@@ -1314,6 +1408,7 @@ interface MigrateOptions {
   step?: number;
   pretend?: boolean;
   batch?: number;
+  quiet?: boolean;
 }
 type TXBaseConfig<S = boolean> = (S extends true ? Partial<TBaseConfig> : TBaseConfig) & {
   /**
@@ -1345,6 +1440,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
    *
@@ -1492,6 +1611,7 @@ declare const getAttrName: (attrMethod: string) => string;
  */
 declare const tap: <I>(instance: I, callback: (ins: I) => Promise<I> | I) => Promise<I> | I;
 declare const compose: typeof compose$1;
+declare const flatten: <A = any>(arr: A[]) => (A extends readonly (infer InnerArr)[] ? InnerArr : A)[];
 declare const flattenDeep: (arr: any) => any;
 declare const kebabCase: (str: string) => string;
 declare const snakeCase: (str: string) => string;
@@ -1504,4 +1624,4 @@ declare const make: (model: Model$1, data: TGeneric, options?: {
 declare const makeCollection: (model: Model$1, data: TGeneric) => Collection<Model$1 | Model$2>;
 declare const makePaginator: (model: Model$1, data: TGeneric) => Paginator<Model$1, IPaginatorParams>;
 //#endregion
-export { Attribute, Builder, CastsAttributes, Collection, HasUniqueIds, InvalidArgumentError, Migrate, Migration, Model$1 as Model, ModelNotFoundError, Paginator, Pivot, QueryBuilder, RelationNotFoundError, Scope, softDeletes as SoftDeletes, arquebus, compose, defineConfig, flattenDeep, getAttrMethod, getAttrName, getGetterMethod, getRelationMethod, getRelationName, getScopeMethod, getScopeName, getSetterMethod, kebabCase, make, makeCollection, makePaginator, now, snakeCase, tap };
+export { Attribute, Builder, CastsAttributes, Collection, HasUniqueIds, InvalidArgumentError, Migrate, Migration, Model$1 as Model, ModelNotFoundError, Paginator, Pivot, QueryBuilder, RelationNotFoundError, Scope, softDeletes as SoftDeletes, arquebus, compose, defineConfig, flatten, flattenDeep, getAttrMethod, getAttrName, getGetterMethod, getRelationMethod, getRelationName, getScopeMethod, getScopeName, getSetterMethod, kebabCase, make, makeCollection, makePaginator, now, snakeCase, tap };