@spinajs/orm 1.0.60 → 1.2.32

package/README.md

@@ -1,2 +1,11 @@
-# spinajs-orm
-Spinajs orm module
+# `@spinajs/orm`
+
+> TODO: description
+
+## Usage
+
+```
+const orm = require('@spinajs/orm');
+
+// TODO: DEMONSTRATE API
+```

package/lib/builders.d.ts

@@ -1,20 +1,35 @@
-import { Container } from '@spinajs/di';
+import { Container, Constructor } from '@spinajs/di';
 import { QueryMethod, SORT_ORDER, WhereBoolean, WhereOperators } from './enums';
-import { IColumnsBuilder, ICompilerOutput, ILimitBuilder, IOrderByBuilder, IQueryBuilder, IQueryLimit, ISelectQueryBuilder, ISort, IWhereBuilder, QueryContext, IJoinBuilder, IBuilderMiddleware, IWithRecursiveBuilder, ReferentialAction, IGroupByBuilder } from './interfaces';
+import { IColumnsBuilder, ICompilerOutput, ILimitBuilder, IOrderByBuilder, IQueryBuilder, IQueryLimit, ISort, IWhereBuilder, QueryContext, IJoinBuilder, IBuilderMiddleware, IWithRecursiveBuilder, ReferentialAction, IGroupByBuilder } from './interfaces';
 import { ColumnStatement, IQueryStatement, WrapStatement } from './statements';
 import { WhereFunction } from './types';
 import { OrmDriver } from './driver';
 import { ModelBase } from './model';
 import { OrmRelation, IOrmRelation } from './relations';
+/**
+ *  Trick typescript by using the inbuilt interface inheritance and declaration merging
+ *  for builder classes.
+ *
+ *  We use mixins to extend functionality of builder eg. insert query builder uses function from columns builder
+ *  and so on...
+ */
+export interface InsertQueryBuilder extends IColumnsBuilder {
+}
+export interface DeleteQueryBuilder extends IWhereBuilder, ILimitBuilder {
+}
+export interface UpdateQueryBuilder extends IColumnsBuilder, IWhereBuilder {
+}
+export interface SelectQueryBuilder extends IColumnsBuilder, IOrderByBuilder, ILimitBuilder, IWhereBuilder, IJoinBuilder, IWithRecursiveBuilder, IGroupByBuilder {
+}
 export declare class Builder<T = any> {
     protected _driver: OrmDriver;
     protected _container: Container;
-    protected _model?: Constructor<ModelBase<any>>;
+    protected _model?: Constructor<ModelBase>;
     protected _nonSelect: boolean;
     protected _queryContext: QueryContext;
     protected _middlewares: IBuilderMiddleware[];
     protected _asRaw: boolean;
-    constructor(container: Container, driver: OrmDriver, model?: Constructor<ModelBase<any>>);
+    constructor(container: Container, driver: OrmDriver, model?: Constructor<ModelBase>);
     middleware(middleware: IBuilderMiddleware): this;
     /**
      * Builds query that is ready to use in DB
@@ -31,7 +46,7 @@ export declare class QueryBuilder<T = any> extends Builder<T> implements IQueryB
     protected _table: string;
     protected _tableAlias: string;
     protected _schema: string;
-    constructor(container: Container, driver: OrmDriver, model?: Constructor<ModelBase<any>>);
+    constructor(container: Container, driver: OrmDriver, model?: Constructor<ModelBase>);
     /**
      * SQL table name that query is executed on
      *
@@ -71,7 +86,7 @@ export declare class QueryBuilder<T = any> extends Builder<T> implements IQueryB
     /**
      * Sets table alias for query
      *
-     * @param alias sql table alias
+     * @param alias - sql table alias
      */
     setAlias(alias: string): this;
     from(table: string, alias?: string): this;
@@ -99,7 +114,7 @@ export declare class ColumnsBuilder implements IColumnsBuilder {
     protected _container: Container;
     protected _columns: IQueryStatement[];
     protected _tableAlias: string;
-    protected _model?: Constructor<ModelBase<any>>;
+    protected _model?: Constructor<ModelBase>;
     constructor();
     /**
      * Clears all select clauses from the query.
@@ -183,8 +198,6 @@ export declare class WhereBuilder implements IWhereBuilder {
     whereNotInSet(column: string, val: any[]): this;
     clearWhere(): this;
 }
-export interface SelectQueryBuilder extends ISelectQueryBuilder {
-}
 export declare class SelectQueryBuilder<T = any> extends QueryBuilder<T> {
     /**
      * column query props
@@ -211,7 +224,7 @@ export declare class SelectQueryBuilder<T = any> extends QueryBuilder<T> {
     protected _cteStatement: IQueryStatement;
     protected _owner: IOrmRelation;
     protected _relations: IOrmRelation[];
-    private this;
+    this: this;
     get IsDistinct(): boolean;
     get Owner(): IOrmRelation;
     get Relations(): IOrmRelation[];
@@ -231,8 +244,6 @@ export declare class SelectQueryBuilder<T = any> extends QueryBuilder<T> {
     then(resolve: (rows: any[]) => void, reject: (err: Error) => void): Promise<T>;
     execute(): Promise<T>;
 }
-export interface DeleteQueryBuilder extends IWhereBuilder, ILimitBuilder {
-}
 export declare class DeleteQueryBuilder extends QueryBuilder {
     /**
      * where query props
@@ -260,8 +271,6 @@ export declare class OnDuplicateQueryBuilder {
     then(resolve: (rows: any[]) => void, reject: (err: Error) => void): Promise<any>;
     toDB(): ICompilerOutput;
 }
-export interface UpdateQueryBuilder extends IWhereBuilder {
-}
 export declare class UpdateQueryBuilder extends QueryBuilder {
     /**
      * where query props
@@ -270,20 +279,18 @@ export declare class UpdateQueryBuilder extends QueryBuilder {
     protected _boolean: WhereBoolean;
     protected _value: {};
     get Value(): {};
-    private this;
+    this: this;
     constructor(container: Container, driver: OrmDriver, model: Constructor<any>);
     in(name: string): this;
     update(value: {}): this;
     toDB(): ICompilerOutput;
 }
-export interface InsertQueryBuilder extends IColumnsBuilder {
-}
 export declare class InsertQueryBuilder extends QueryBuilder {
     DuplicateQueryBuilder: OnDuplicateQueryBuilder;
     protected _values: any[][];
     protected _columns: ColumnStatement[];
     protected _ignore: boolean;
-    private this;
+    this: this;
     get Values(): any[][];
     get Ignore(): boolean;
     constructor(container: Container, driver: OrmDriver, model: Constructor<any>);
@@ -319,29 +326,29 @@ export declare class ForeignKeyBuilder {
      *
      * Referenced field in child table
      *
-     * @param fkName name of foreign field in child table
+     * @param fkName - name of foreign field in child table
      */
     foreignKey(fkName: string): this;
     /**
      *
      * Referenced parent table & key
      *
-     * @param table parent table
-     * @param pKey parant table key field
+     * @param table - parent table
+     * @param pKey - parant table key field
      */
     references(table: string, pKey: string): this;
     /**
      *
      * On delete action
      *
-     * @param action action to take on delete
+     * @param action - action to take on delete
      */
     onDelete(action: ReferentialAction): this;
     /**
      *
      * On update action
      *
-     * @param action action to take on update
+     * @param action - action to take on update
      */
     onUpdate(action: ReferentialAction): this;
     /**