@h3ravel/arquebus 0.3.5 → 0.4.0

package/dist/browser/index.cjs

@@ -205,6 +205,7 @@ const tap = (instance, callback) => {
 	return result instanceof Promise ? result.then(() => instance) : instance;
 };
 const { compose } = mixin_exports;
+const flatten = (arr) => arr.flat();
 const flattenDeep = (arr) => Array.isArray(arr) ? arr.reduce((a, b) => a.concat(flattenDeep(b)), []) : [arr];
 const kebabCase = (str) => (0, radashi.trim)((0, radashi.dash)(str.replace(/[^a-zA-Z0-9_-]/g, "-")), "_-");
 const snakeCase = (str) => (0, radashi.trim)((0, radashi.snake)(str.replace(/[^a-zA-Z0-9_-]/g, "-")), "_-");
@@ -1251,6 +1252,7 @@ exports.RelationNotFoundError = RelationNotFoundError;
 exports.compose = compose;
 exports.default = browser_default;
 exports.defineConfig = defineConfig;
+exports.flatten = flatten;
 exports.flattenDeep = flattenDeep;
 exports.getAttrMethod = getAttrMethod;
 exports.getAttrName = getAttrName;

package/dist/browser/index.d.cts

@@ -213,9 +213,92 @@ declare class Builder<M extends Model$1 = Model$1, R = IModel | ICollection<M>>
   hydrate(items: any[]): Collection$2<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;
@@ -346,7 +429,7 @@ interface IQueryBuilder<M extends Model$1 | Model = 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>>;
@@ -359,10 +442,13 @@ declare const Inference: {
 declare class QueryBuilder<M extends Model$1 = Model$1, R = M[] | M> extends Inference<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>;
@@ -386,7 +472,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
@@ -496,7 +582,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;
@@ -516,7 +602,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;
@@ -618,6 +704,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;
@@ -1370,4 +1457,4 @@ declare const _default: {
   makePaginator: (model: Model, data: TGeneric) => Paginator<Model, IPaginatorParams>;
 };
 //#endregion
-export { Attribute, CastsAttributes, Collection, HasUniqueIds, InvalidArgumentError, Model, ModelNotFoundError, Paginator, Pivot, RelationNotFoundError, compose, _default as default, defineConfig, flattenDeep, getAttrMethod, getAttrName, getGetterMethod, getRelationMethod, getRelationName, getScopeMethod, getScopeName, getSetterMethod, isBrowser, kebabCase, make, makeCollection, now, snakeCase, tap };
+export { Attribute, CastsAttributes, Collection, HasUniqueIds, InvalidArgumentError, Model, ModelNotFoundError, Paginator, Pivot, RelationNotFoundError, compose, _default as default, defineConfig, flatten, flattenDeep, getAttrMethod, getAttrName, getGetterMethod, getRelationMethod, getRelationName, getScopeMethod, getScopeName, getSetterMethod, isBrowser, kebabCase, make, makeCollection, now, snakeCase, tap };

package/dist/browser/index.d.ts

@@ -213,9 +213,92 @@ declare class Builder<M extends Model$1 = Model$1, R = IModel | ICollection<M>>
   hydrate(items: any[]): Collection$2<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;
@@ -346,7 +429,7 @@ interface IQueryBuilder<M extends Model$1 | Model = 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>>;
@@ -359,10 +442,13 @@ declare const Inference: {
 declare class QueryBuilder<M extends Model$1 = Model$1, R = M[] | M> extends Inference<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>;
@@ -386,7 +472,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
@@ -496,7 +582,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;
@@ -516,7 +602,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;
@@ -618,6 +704,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;
@@ -1370,4 +1457,4 @@ declare const _default: {
   makePaginator: (model: Model, data: TGeneric) => Paginator<Model, IPaginatorParams>;
 };
 //#endregion
-export { Attribute, CastsAttributes, Collection, HasUniqueIds, InvalidArgumentError, Model, ModelNotFoundError, Paginator, Pivot, RelationNotFoundError, compose, _default as default, defineConfig, flattenDeep, getAttrMethod, getAttrName, getGetterMethod, getRelationMethod, getRelationName, getScopeMethod, getScopeName, getSetterMethod, isBrowser, kebabCase, make, makeCollection, now, snakeCase, tap };
+export { Attribute, CastsAttributes, Collection, HasUniqueIds, InvalidArgumentError, Model, ModelNotFoundError, Paginator, Pivot, RelationNotFoundError, compose, _default as default, defineConfig, flatten, flattenDeep, getAttrMethod, getAttrName, getGetterMethod, getRelationMethod, getRelationName, getScopeMethod, getScopeName, getSetterMethod, isBrowser, kebabCase, make, makeCollection, now, snakeCase, tap };

package/dist/browser/index.js

@@ -181,6 +181,7 @@ const tap = (instance, callback) => {
 	return result instanceof Promise ? result.then(() => instance) : instance;
 };
 const { compose } = mixin_exports;
+const flatten = (arr) => arr.flat();
 const flattenDeep = (arr) => Array.isArray(arr) ? arr.reduce((a, b) => a.concat(flattenDeep(b)), []) : [arr];
 const kebabCase = (str) => trim(dash(str.replace(/[^a-zA-Z0-9_-]/g, "-")), "_-");
 const snakeCase = (str) => trim(snake(str.replace(/[^a-zA-Z0-9_-]/g, "-")), "_-");
@@ -1214,4 +1215,4 @@ var browser_default = {
 };
 
 //#endregion
-export { attribute_default as Attribute, casts_attributes_default as CastsAttributes, collection_default as Collection, has_unique_ids_default as HasUniqueIds, InvalidArgumentError, model_default as Model, ModelNotFoundError, paginator_default as Paginator, pivot_default as Pivot, RelationNotFoundError, compose, browser_default as default, defineConfig, flattenDeep, getAttrMethod, getAttrName, getGetterMethod, getRelationMethod, getRelationName, getScopeMethod, getScopeName, getSetterMethod, isBrowser, kebabCase, make, makeCollection, now, snakeCase, tap };
+export { attribute_default as Attribute, casts_attributes_default as CastsAttributes, collection_default as Collection, has_unique_ids_default as HasUniqueIds, InvalidArgumentError, model_default as Model, ModelNotFoundError, paginator_default as Paginator, pivot_default as Pivot, RelationNotFoundError, compose, browser_default as default, defineConfig, flatten, flattenDeep, getAttrMethod, getAttrName, getGetterMethod, getRelationMethod, getRelationName, getScopeMethod, getScopeName, getSetterMethod, isBrowser, kebabCase, make, makeCollection, now, snakeCase, tap };