@h3ravel/arquebus 0.4.1 → 0.6.0

package/types/container.ts

@@ -8,77 +8,90 @@ import type Relation from 'src/relations/relation'
 import type { arquebus } from 'src'
 
 export interface TBaseConfig {
-    client: 'mysql' | 'mysql2' | 'sqlite3' | 'oracle' | 'mariadb' | 'pg'
-    connection: {
-        typeCast?(field: TField, next: TFunction): any
-        dateStrings?: boolean
-    }
-    pool?: {
-        afterCreate: (connection: TConfig, callback: (val: any, con: any) => void) => Promise<any>
-    } | undefined
-    connections?: arquebus['connections']
-    migrations?: {
-        table: string
-        path: string
-    },
-    factories?: {
-        path: string
-    },
-    seeders?: {
-        path: string
-    },
-    models?: {
-        path: string
-    }
+  client: 'mysql' | 'mysql2' | 'sqlite3' | 'oracle' | 'mariadb' | 'pg'
+  connection: {
+    typeCast?(field: TField, next: TFunction): any
+    dateStrings?: boolean
+  }
+  pool?:
+    | {
+        afterCreate: (
+          connection: TConfig,
+          callback: (val: any, con: any) => void,
+        ) => Promise<any>
+      }
+    | undefined
+  connections?: arquebus['connections']
+  migrations?: {
+    table: string
+    path: string
+  }
+  factories?: {
+    path: string
+  }
+  seeders?: {
+    path: string
+  }
+  models?: {
+    path: string
+  }
 }
 
-export type TConfig = TBaseConfig & ({
-    client: 'pg'
-    connection: Knex.PgConnectionConfig
-} | {
-    client: 'oracle'
-    connection: Knex.OracleDbConnectionConfig
-} | {
-    client: 'mysql2'
-    connection: Knex.MySql2ConnectionConfig
-} | {
-    client: 'mysql'
-    connection: Knex.MySqlConnectionConfig
-} | {
-    client: 'sqlite3'
-    connection: Knex.Sqlite3ConnectionConfig
-    useNullAsDefault?: boolean
-} | {
-    client: 'mariadb'
-    connection: Knex.MariaSqlConnectionConfig
-    useNullAsDefault?: boolean
-})
+export type TConfig = TBaseConfig &
+  (
+    | {
+        client: 'pg'
+        connection: Knex.PgConnectionConfig
+      }
+    | {
+        client: 'oracle'
+        connection: Knex.OracleDbConnectionConfig
+      }
+    | {
+        client: 'mysql2'
+        connection: Knex.MySql2ConnectionConfig
+      }
+    | {
+        client: 'mysql'
+        connection: Knex.MySqlConnectionConfig
+      }
+    | {
+        client: 'sqlite3'
+        connection: Knex.Sqlite3ConnectionConfig
+        useNullAsDefault?: boolean
+      }
+    | {
+        client: 'mariadb'
+        connection: Knex.MariaSqlConnectionConfig
+        useNullAsDefault?: boolean
+      }
+  )
 
 export interface ModelOptions<M extends Model = Model> {
-    table?: string
-    scopes?: TGeneric<(...args: any[]) => Builder<M>>
-    plugins?: (<X extends MixinConstructor<M>>(Model: X) => MixinConstructor<M>)[]
-    relations?: TGeneric<(...args: any[]) => Relation>
-    attributes?: TGeneric<Attribute>
-    CREATED_AT?: string
-    UPDATED_AT?: string
-    DELETED_AT?: string
-    connection?: TBaseConfig['client']
-    timestamps?: boolean
-    primaryKey?: string
-    incrementing?: boolean
-    keyType?: 'int' | 'string'
-    with?: Model['with']
-    casts?: Model['casts']
+  table?: string
+  scopes?: TGeneric<(...args: any[]) => Builder<M>>
+  plugins?: (<X extends MixinConstructor<M>>(Model: X) => MixinConstructor<M>)[]
+  relations?: TGeneric<(...args: any[]) => Relation>
+  attributes?: TGeneric<Attribute>
+  CREATED_AT?: string
+  UPDATED_AT?: string
+  DELETED_AT?: string
+  connection?: TBaseConfig['client']
+  timestamps?: boolean
+  primaryKey?: string
+  incrementing?: boolean
+  keyType?: 'int' | 'string'
+  with?: Model['with']
+  casts?: Model['casts']
 }
 
 export interface TField {
-    type: 'VAR_STRING' | 'BLOB' | 'DATETIME' | 'TIMESTAMP' | 'LONG' | 'JSON'
-    length: number
-    db: string
-    table: string
-    name: string
-    string: TFunction,
-    buffer: TFunction
-    geometry: TFunction
+  type: 'VAR_STRING' | 'BLOB' | 'DATETIME' | 'TIMESTAMP' | 'LONG' | 'JSON'
+  length: number
+  db: string
+  table: string
+  name: string
+  string: TFunction
+  buffer: TFunction
+  geometry: TFunction
 }

package/types/generics.ts

@@ -2,70 +2,109 @@ import type Model from 'src/model'
 
 export type TGeneric<V = any, K extends string = string> = Record<K, V>
 export type XGeneric<V = TGeneric, T = any> = {
-    [key: string]: T
+  [key: string]: T
 } & V
 
 export interface Plugin {
-    (model: Model, config: TGeneric): void
+  (model: Model, config: TGeneric): void
 }
 
 export type Hook =
-    | 'creating' | 'created' | 'updating' | 'updated' | 'saving' | 'saved' | 'deleting' | 'deleted'
-    | 'restoring' | 'restored' | 'trashed' | 'forceDeleted';
+  | 'creating'
+  | 'created'
+  | 'updating'
+  | 'updated'
+  | 'saving'
+  | 'saved'
+  | 'deleting'
+  | 'deleted'
+  | 'restoring'
+  | 'restored'
+  | 'trashed'
+  | 'forceDeleted'
 
-export type TFunction<TArgs extends any[] = any[], TReturn = any> = (...args: TArgs) => TReturn;
+export type TFunction<TArgs extends any[] = any[], TReturn = any> = (
+  ...args: TArgs
+) => TReturn
 
 export type PrimitiveValue =
-    | string
-    | number
-    | boolean
-    | Date
-    | string[]
-    | number[]
-    | boolean[]
-    | Date[]
-    | null
-    | Buffer;
+  | string
+  | number
+  | boolean
+  | Date
+  | string[]
+  | number[]
+  | boolean[]
+  | Date[]
+  | null
+  | Buffer
 
-export type ReturnTypeOfMethod<T, K extends keyof T> = T[K] extends (...args: any[]) => infer R ? R : never;
+export type ReturnTypeOfMethod<T, K extends keyof T> = T[K] extends (
+  ...args: any[]
+) => infer R
+  ? R
+  : never
 
 export type SnakeToCamelCase<S extends string> =
-    S extends `${infer T}_${infer U}` ? `${T}${Capitalize<SnakeToCamelCase<U>>}` : S;
+  S extends `${infer T}_${infer U}`
+    ? `${T}${Capitalize<SnakeToCamelCase<U>>}`
+    : S
 
 // declare const model: ModelDecorator;
 export type CamelToSnakeCase<S extends string> =
-    S extends `${infer T}${infer U}` ?
-    U extends Uncapitalize<U> ? `${Uncapitalize<T>}${CamelToSnakeCase<U>}` : `${Uncapitalize<T>}_${CamelToSnakeCase<U>}` :
-    S;
+  S extends `${infer T}${infer U}`
+    ? U extends Uncapitalize<U>
+      ? `${Uncapitalize<T>}${CamelToSnakeCase<U>}`
+      : `${Uncapitalize<T>}_${CamelToSnakeCase<U>}`
+    : S
 
 export type FunctionPropertyNames<T> = {
-    [K in keyof T]: T[K] extends (...args: any[]) => any ? K : never;
-}[keyof T];
+  [K in keyof T]: T[K] extends (...args: any[]) => any ? K : never
+}[keyof T]
 
-export type RelationNames<T> = FunctionPropertyNames<T> extends infer R
-    ? R extends `relation${infer P}` ? P extends ('sToData' | 'loaded') ? never : CamelToSnakeCase<P> : never
-    : never;
+export type RelationNames<T> =
+  FunctionPropertyNames<T> extends infer R
+    ? R extends `relation${infer P}`
+      ? P extends 'sToData' | 'loaded'
+        ? never
+        : CamelToSnakeCase<P>
+      : never
+    : never
 
 export type MixinConstructor<T = TGeneric> = new (...args: any[]) => T
+export type AbstractConstructor<T = TGeneric> = abstract new (
+  ...args: any[]
+) => T
 
 // Helper type: combine all mixin instance types into a single intersection
-export type MixinReturn<Base extends MixinConstructor, Mixins extends ((base: any) => any)[]> =
-    Base extends MixinConstructor<infer B>
+export type MixinReturn<
+  Base extends MixinConstructor,
+  Mixins extends ((base: any) => any)[],
+> =
+  Base extends MixinConstructor<infer B>
     ? IntersectionOfInstances<InstanceTypeOfMixins<Mixins>> & B
     : never
 
-export type InstanceTypeOfMixins<T extends ((base: any) => any)[]> =
-    T extends [infer Head, ...infer Tail]
-    ? Head extends (base: any) => infer R
+export type InstanceTypeOfMixins<T extends ((base: any) => any)[]> = T extends [
+  infer Head,
+  ...infer Tail,
+]
+  ? Head extends (base: any) => infer R
     ? Tail extends ((base: any) => any)[]
-    ? R | InstanceTypeOfMixins<Tail>
-    : R
-    : never
+      ? R | InstanceTypeOfMixins<Tail>
+      : R
     : never
+  : never
 
-export type IntersectionOfInstances<U> =
-    (U extends any ? (x: U) => any : never) extends (x: infer I) => any ? I : never
+export type IntersectionOfInstances<U> = (
+  U extends any ? (x: U) => any : never
+) extends (x: infer I) => any
+  ? I
+  : never
 
 export interface DeepMixinFunction {
-    <MC extends MixinConstructor, P extends ((base: any) => any)[]> (Base: MC, ...mixins: P): MixinReturn<MC, P>
+  <MC extends MixinConstructor, P extends ((base: any) => any)[]>(
+    Base: MC,
+    ...mixins: P
+  ): MixinReturn<MC, P>
 }