mythix-orm 1.5.6 → 1.6.1

package/lib/proxy-class/proxy-class.js

@@ -65,7 +65,7 @@ class ProxyClass {
     Object.defineProperties(func, {
       [AUTO_CALL]: {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        true,
       },
@@ -151,19 +151,19 @@ class ProxyClass {
     Object.defineProperties(me, {
       [PROXY]: {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        proxy,
       },
       [TARGET]: {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        proxyTarget,
       },
       [SELF]: {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        me,
       },
@@ -176,13 +176,13 @@ class ProxyClass {
     Object.defineProperties(this, {
       [AUTO_CALL_CALLER]: {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        null,
       },
       [AUTO_CALL_CALLED]: {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        false,
       },

package/lib/query-engine/index.d.ts

@@ -0,0 +1 @@
+export * from './query-engine';

package/lib/query-engine/model-scope.js

@@ -180,8 +180,8 @@ class ModelScope extends QueryEngineBase {
   });
 
   JOIN(type) {
-    if (Nife.isEmpty(type) || !Nife.instanceOf(type, 'string'))
-      throw new Error('QueryEngine::ModelScope::JOIN: Invalid value provided. Value must be a valid string specifying JOIN type.');
+    if (!(Nife.instanceOf(type, 'string') || LiteralBase.isLiteral(type)))
+      throw new Error('QueryEngine::ModelScope::JOIN: Invalid value provided. Value must be a valid string or Literal specifying JOIN type.');
 
     this._addToQuery({ control: true, operator: 'JOIN', value: type, joinType: type, joinOuter: false });
     return this._fetchScope('model');

package/lib/query-engine/query-engine-base.js

@@ -208,12 +208,12 @@ class QueryEngineBase extends ProxyClass {
     Object.defineProperties(this, {
       queryRoot: {
         writable:     false,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        queryRoot,
       },
       currentContext: {
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         get:          () => {
           let currentContext = queryRoot[queryRoot.length - 1];

package/lib/query-engine/query-engine.d.ts

@@ -0,0 +1,144 @@
+import ConnectionBase from '../connection/connection-base';
+import { LiteralBase } from '../connection/literals';
+import { GenericObject } from '../interfaces/common';
+import { Model, ModelClass } from '../model';
+import Field from '../field';
+
+export declare interface QueryEngineOptions {
+  connection: ConnectionBase;
+  [ key: string ]: any;
+}
+
+export declare type QueryEngineClass = typeof QueryEngine;
+
+export declare interface CallableInterface {
+  (...args: Array<any>): QueryEngine;
+  [ key: string ]: QueryEngine;
+}
+
+export declare class QueryEngine<T = ConnectionBase> {
+  // QueryEngineBase
+  static generateID(): number;
+  static isQueryContext(value: any): boolean;
+  static isQuery(value: any): boolean;
+  static queryContextType(queryContext: GenericObject): { hasCondition: boolean; hasField: boolean; hasModel: boolean; };
+
+  public getModelScopeClass(): QueryEngine;
+  public getFieldScopeClass(): QueryEngine;
+  public _inheritContext(context: GenericObject, name: string, ...args: Array<GenericObject>): GenericObject;
+  public _fetchScope(...scopeNames: Array<string>): QueryEngine;
+  public _newQueryEngineScope(): QueryEngine;
+  public _newModelScope(Model: ModelClass): QueryEngine;
+  public _newFieldScope(Field: Field): QueryEngine;
+  public constructor(context: QueryEngineOptions);
+  public _getTopContextID(): number;
+  public _getRawQueryContext(): GenericObject;
+  public _getRawQuery(): Array<GenericObject>;
+  public _isLastPartControl(): boolean;
+  public _isLastPartCondition(): boolean;
+  public _queryHasConditions(): boolean;
+  public _queryHasJoins(): boolean;
+  public _debugQuery(): void;
+  public _addToQuery(queryPart: GenericObject, context: GenericObject): void;
+  public getConnection(): ConnectionBase;
+  public getModel(modelName: string): ModelClass | undefined;
+  public getQueryEngineScope(): QueryEngine;
+  public getQueryEngineClass(): QueryEngineClass;
+  public clone(): QueryEngine;
+
+  // QueryEngine
+  public getModelScopeClass(): QueryEngineClass;
+  public getFieldScopeClass(): QueryEngineClass;
+  public Model(modelName: string): QueryEngine;
+  public unscoped(context?: GenericObject): QueryEngine;
+  public toString(options?: GenericObject): string;
+  public MERGE(queryEngine: QueryEngine): QueryEngine;
+  public all(options?: GenericObject): Promise<Array<Model>>;
+  public fetchAll(options?: GenericObject): AsyncGenerator<Model>;
+  public first(limit?: number | null | undefined, options?: GenericObject): Promise<Model | undefined>;
+  public last(limit?: number | null | undefined, options?: GenericObject): Promise<Model | undefined>;
+  public update(attributes: Model | GenericObject, options?: GenericObject): Promise<number>;
+  public destroy(options?: GenericObject): Promise<number>;
+  public average(field: Field | string, options?: GenericObject): Promise<number>;
+  public count(field: Field | string, options?: GenericObject): Promise<number>;
+  public min(field: Field | string, options?: GenericObject): Promise<number>;
+  public max(field: Field | string, options?: GenericObject): Promise<number>;
+  public sum(field: Field | string, options?: GenericObject): Promise<number>;
+  public pluck(fields: string | Array<string>, options?: GenericObject): Promise<Array<any>>;
+  public exists(options?: GenericObject): Promise<boolean>;
+
+  // ModelScope
+  public _getField(fieldName: string): Field | undefined;
+  public _getQueryEngineClass(): QueryEngineClass;
+  public Field(fieldName: string): QueryEngine;
+  public LIMIT(value: number): QueryEngine;
+  public OFFSET(value: number): QueryEngine;
+  public ORDER(...args: Array<string | Array<string>>): QueryEngine;
+  public PROJECT(...args: Array<string | ModelClass | LiteralBase | Field>): QueryEngine;
+
+  declare public NOT: {
+    (): QueryEngine;
+    [ key: string ]: QueryEngine;
+  };
+
+  declare public AND: {
+    (query: QueryEngine): QueryEngine;
+    [ key: string ]: QueryEngine;
+  };
+
+  declare public OR: {
+    (query: QueryEngine): QueryEngine;
+    [ key: string ]: QueryEngine;
+  };
+
+  declare public DISTINCT: {
+    (fullyQualifiedName: string | Field): QueryEngine;
+    [ key: string ]: QueryEngine;
+  };
+
+  declare public INNER_JOIN: {
+    (): QueryEngine;
+    [ key: string ]: QueryEngine;
+  };
+
+  declare public LEFT_JOIN: {
+    (): QueryEngine;
+    [ key: string ]: QueryEngine;
+  };
+
+  declare public RIGHT_JOIN: {
+    (): QueryEngine;
+    [ key: string ]: QueryEngine;
+  };
+
+  declare public FULL_JOIN: {
+    (): QueryEngine;
+    [ key: string ]: QueryEngine;
+  };
+
+  declare public CROSS_JOIN: {
+    (): QueryEngine;
+    [ key: string ]: QueryEngine;
+  };
+
+  declare public JOIN: {
+    (type: string | LiteralBase): QueryEngine;
+    [ key: string ]: QueryEngine;
+  };
+
+  // FieldScope
+  public _fetchOperatorValue(value: any): any;
+  public EQ(value: any): QueryEngine;
+  public NEQ(value: any): QueryEngine;
+  public GT(value: any): QueryEngine;
+  public GTE(value: any): QueryEngine;
+  public LT(value: any): QueryEngine;
+  public LTE(value: any): QueryEngine;
+  public LIKE(value: string, options?: { caseSensitive: boolean }): QueryEngine;
+  public NOT_LIKE(value: string, options?: { caseSensitive: boolean }): QueryEngine;
+
+  [ key: string ]: any;
+}
+
+export class ModelScope extends QueryEngine { }
+export class FieldScope extends QueryEngine { }

package/lib/query-engine/query-engine.js

@@ -134,6 +134,10 @@ class QueryEngine extends QueryEngineBase {
       return Utils.collect(connection.select(this, options));
   }
 
+  fetchAll(options) {
+    return this.all({ ...(options || {}), stream: true });
+  }
+
   async first(_limit, options) {
     let limit       = (_limit == null) ? 1 : _limit;
     let connection  = this.getConnection(options && options.connection);

package/lib/types/concrete/bigint-type.d.ts

@@ -0,0 +1,16 @@
+import { AutoIncrementDefaultValueProvider } from '../helpers/default-helpers';
+import Type, { TypeWrapper } from '../type';
+
+export declare interface BigIntTypeWrapper extends TypeWrapper<BigIntType> {
+  (length?: number, options?: { strict: boolean }): BigIntType;
+}
+
+export declare class BigIntType extends Type {
+  declare public static Default: {
+    AUTO_INCREMENT: AutoIncrementDefaultValueProvider;
+  };
+
+  public constructor(length?: number, options?: { strict: boolean });
+}
+
+export const BIGINT: BigIntTypeWrapper;

package/lib/types/concrete/bigint-type.js

@@ -39,10 +39,12 @@ const { AUTO_INCREMENT }  = require('../helpers/default-helpers');
 ///   Mythix ORM supports emulation of BIGINT auto-incrementing
 ///   IDs in its [mythix-orm-sqlite](https://www.npmjs.com/package/mythix-orm-sqlite)
 ///   driver. You can read more about it in the documentation.
+///
 /// Properties:
 ///   Default: object = { AUTO_INCREMENT }
 ///     `AUTO_INCREMENT` is a method that can be used as the `defaultValue` of a <see>Field</see>
 ///     to have this field auto-increment in the underlying database.
+///
 /// See: Type
 class BigIntType extends Type {
   static Default = {
@@ -57,16 +59,13 @@ class BigIntType extends Type {
   /// Note:
   ///   This is also an instance method that can be called from
   ///   an instance of the type.
+  ///
   /// Return: string
   ///   Return the string value `'BIGINT'`
   static getDisplayName() {
     return 'BIGINT';
   }
 
-  getDisplayName() {
-    return this.constructor.getDisplayName();
-  }
-
   /// Construct a new `BIGINT` type.
   ///
   /// The `length` argument--as on all
@@ -85,6 +84,7 @@ class BigIntType extends Type {
   /// as a `number` primitive.
   ///
   /// Return: BigIntType
+  ///
   /// Arguments:
   ///   length?: number = 8
   ///     How many bytes to use in the underlying database to store the value.
@@ -102,7 +102,7 @@ class BigIntType extends Type {
     Object.defineProperties(this, {
       '_options': {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        options,
       },
@@ -124,6 +124,7 @@ class BigIntType extends Type {
   ///   Return the incoming `value`, cast to this
   ///   type. `null` and `undefined` are simply
   ///   returned without casting.
+  ///
   /// Arguments:
   ///   context: <see name="CastToTypeContext">Type.castToType</see>
   castToType({ value }) {
@@ -145,6 +146,7 @@ class BigIntType extends Type {
   /// then it will return `true`.
   ///
   /// Return: boolean
+  ///
   /// Arguments:
   ///   value: any
   ///     The value to check.
@@ -164,6 +166,7 @@ class BigIntType extends Type {
   /// the type.
   ///
   /// Return: string
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection. If provided, send this

package/lib/types/concrete/blob-type.d.ts

@@ -0,0 +1,11 @@
+import Type, { TypeWrapper } from '../type';
+
+export declare interface BlobTypeWrapper extends TypeWrapper<BlobType> {
+  (length: number): BlobType;
+}
+
+export declare class BlobType extends Type {
+  public constructor(length: number);
+}
+
+export const BLOB: BlobTypeWrapper;

package/lib/types/concrete/blob-type.js

@@ -32,16 +32,13 @@ class BlobType extends Type {
   /// Note:
   ///   This is also an instance method that can be called from
   ///   an instance of the type.
+  ///
   /// Return: string
   ///   Return the string value `'BLOB'`
   static getDisplayName() {
     return 'BLOB';
   }
 
-  getDisplayName() {
-    return this.constructor.getDisplayName();
-  }
-
   /// Construct a new `BLOB` type.
   ///
   /// The `length` argument is the number
@@ -49,6 +46,7 @@ class BlobType extends Type {
   /// store the data.
   ///
   /// Return: BlobType
+  ///
   /// Arguments:
   ///   length?: number
   ///     How many bytes to use in the underlying database to store the value.
@@ -74,6 +72,7 @@ class BlobType extends Type {
   ///   Return the incoming `value`, cast to this
   ///   type. `null` and `undefined` are simply
   ///   returned without casting.
+  ///
   /// Arguments:
   ///   context: <see name="CastToTypeContext">Type.castToType</see>
   castToType({ value }) {
@@ -93,6 +92,7 @@ class BlobType extends Type {
   /// otherwise it will return `false`.
   ///
   /// Return: boolean
+  ///
   /// Arguments:
   ///   value: any
   ///     The value to check.
@@ -110,6 +110,7 @@ class BlobType extends Type {
   /// when no `connection` is provided is `'BLOB'`.
   ///
   /// Return: string
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection. If provided, send this

package/lib/types/concrete/boolean-type.d.ts

@@ -0,0 +1,11 @@
+import Type, { TypeWrapper } from '../type';
+
+export declare interface BooleanTypeWrapper extends TypeWrapper<BooleanType> {
+  (): BooleanType;
+}
+
+export declare class BooleanType extends Type {
+  public constructor();
+}
+
+export const BOOLEAN: BooleanTypeWrapper;

package/lib/types/concrete/boolean-type.js

@@ -24,16 +24,13 @@ class BooleanType extends Type {
   /// Note:
   ///   This is also an instance method that can be called from
   ///   an instance of the type.
+  ///
   /// Return: string
   ///   Return the string value `'BOOLEAN'`
   static getDisplayName() {
     return 'BOOLEAN';
   }
 
-  getDisplayName() {
-    return this.constructor.getDisplayName();
-  }
-
   /// Cast provided value to underlying type.
   ///
   /// This will cast the incoming value to the
@@ -53,6 +50,7 @@ class BooleanType extends Type {
   ///   Return the incoming `value`, cast to this
   ///   type. `null` and `undefined` are simply
   ///   returned without casting.
+  ///
   /// Arguments:
   ///   context: <see name="CastToTypeContext">Type.castToType</see>
   castToType({ value }) {
@@ -76,6 +74,7 @@ class BooleanType extends Type {
   /// will return `true`, otherwise it will return `false`.
   ///
   /// Return: boolean
+  ///
   /// Arguments:
   ///   value: any
   ///     The value to check.
@@ -93,6 +92,7 @@ class BooleanType extends Type {
   /// when no `connection` is provided is `'BOOLEAN'`.
   ///
   /// Return: string
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection. If provided, send this

package/lib/types/concrete/char-type.d.ts

@@ -0,0 +1,11 @@
+import Type, { TypeWrapper } from '../type';
+
+export declare interface CharTypeWrapper extends TypeWrapper<CharType> {
+  (): CharType;
+}
+
+export declare class CharType extends Type {
+  public constructor();
+}
+
+export const CHAR: CharTypeWrapper;

package/lib/types/concrete/char-type.js

@@ -26,16 +26,13 @@ class CharType extends Type {
   /// Note:
   ///   This is also an instance method that can be called from
   ///   an instance of the type.
+  ///
   /// Return: string
   ///   Return the string value `'CHAR'`
   static getDisplayName() {
     return 'CHAR';
   }
 
-  getDisplayName() {
-    return this.constructor.getDisplayName();
-  }
-
   /// Cast provided value to underlying type.
   ///
   /// This will cast the incoming value to the
@@ -53,6 +50,7 @@ class CharType extends Type {
   ///   Return the incoming `value`, cast to this
   ///   type. `null` and `undefined` are simply
   ///   returned without casting.
+  ///
   /// Arguments:
   ///   context: <see name="CastToTypeContext">Type.castToType</see>
   castToType({ value }) {
@@ -73,6 +71,7 @@ class CharType extends Type {
   /// return `true`, otherwise it will return `false`.
   ///
   /// Return: boolean
+  ///
   /// Arguments:
   ///   value: any
   ///     The value to check.
@@ -90,6 +89,7 @@ class CharType extends Type {
   /// when no `connection` is provided is `'CHAR'`.
   ///
   /// Return: string
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection. If provided, send this

package/lib/types/concrete/date-type.d.ts

@@ -0,0 +1,16 @@
+import { UpdateDefaultValueProvider } from '../helpers/default-helpers';
+import Type, { TypeWrapper } from '../type';
+
+export declare interface DateTypeWrapper extends TypeWrapper<DateType, UpdateDefaultValueProvider> {
+  (format?: string): DateType;
+}
+
+export declare class DateType extends Type {
+  declare public static Default: {
+    NOW: UpdateDefaultValueProvider;
+  };
+
+  public constructor(format?: string);
+}
+
+export const DATE: DateTypeWrapper;

package/lib/types/concrete/date-type.js

@@ -41,6 +41,7 @@ moment.suppressDeprecationWarnings = true;
 ///     3. `Types.DATE.Default.NOW.LOCAL` = Local (client-side) 'NOW' time, set on insert only.<br>
 ///     4. `Types.DATE.Default.NOW.LOCAL.UPDATE` = Local (client-side) 'NOW' time, set on insert and update.<br>
 ///     *Note: It is highly recommended that you **do not** use `LOCAL` time unless you know exactly what you are doing, as clock-drift between machines may become an issue.*
+///
 /// See: Type
 class DateType extends Type {
   static Default = {
@@ -55,16 +56,13 @@ class DateType extends Type {
   /// Note:
   ///   This is also an instance method that can be called from
   ///   an instance of the type.
+  ///
   /// Return: string
   ///   Return the string value `'DATE'`
   static getDisplayName() {
     return 'DATE';
   }
 
-  getDisplayName() {
-    return this.constructor.getDisplayName();
-  }
-
   /// Construct a new `DATE` type.
   ///
   /// The `format` argument will specify the
@@ -79,6 +77,7 @@ class DateType extends Type {
   /// when calling <see>Model.toJSON</see>.
   ///
   /// Return: DateType
+  ///
   /// Arguments:
   ///   format?: string
   ///     Specify the client-side formatting for this date field.
@@ -109,6 +108,7 @@ class DateType extends Type {
   ///   Return the incoming `value`, cast to this
   ///   type. `null` and `undefined` are simply
   ///   returned without casting.
+  ///
   /// Arguments:
   ///   context: <see name="CastToTypeContext">Type.castToType</see>
   castToType({ value, connection }) {
@@ -133,6 +133,7 @@ class DateType extends Type {
   /// See the [moment](https://momentjs.com/docs/) library documentation for more information.
   ///
   /// Return: boolean
+  ///
   /// Arguments:
   ///   value: any
   ///     The value to check.
@@ -150,6 +151,7 @@ class DateType extends Type {
   /// when no `connection` is provided is `'DATE'`.
   ///
   /// Return: string
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection. If provided, send this
@@ -180,6 +182,7 @@ class DateType extends Type {
   /// to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
   ///
   /// Return: string | null | undefined
+  ///
   /// Arguments:
   ///   value: moment
   ///     The date value to serialize.
@@ -218,7 +221,9 @@ class DateType extends Type {
   /// Note:
   ///   This method is called by `castToType` to cast
   ///   incoming values into `moment` instances.
+  ///
   /// Return: moment
+  ///
   /// Arguments:
   ///   value: string | moment | null | undefined
   ///     The value to deserialize.

package/lib/types/concrete/datetime-type.d.ts

@@ -0,0 +1,16 @@
+import { UpdateDefaultValueProvider } from '../helpers/default-helpers';
+import Type, { TypeWrapper } from '../type';
+
+export declare interface DateTimeTypeWrapper extends TypeWrapper<DateTimeType, UpdateDefaultValueProvider> {
+  (format?: string, length?: number): DateTimeType;
+}
+
+export declare class DateTimeType extends Type {
+  declare public static Default: {
+    NOW: UpdateDefaultValueProvider;
+  };
+
+  public constructor(format?: string, length?: number);
+}
+
+export const DATETIME: DateTimeTypeWrapper;

package/lib/types/concrete/datetime-type.js

@@ -41,6 +41,7 @@ moment.suppressDeprecationWarnings = true;
 ///     3. `Types.DATETIME.Default.NOW.LOCAL` = Local (client-side) 'NOW' time, set on insert only.<br>
 ///     4. `Types.DATETIME.Default.NOW.LOCAL.UPDATE` = Local (client-side) 'NOW' time, set on insert and update.<br>
 ///     *Note: It is highly recommended that you **do not** use `LOCAL` time unless you know exactly what you are doing, as clock-drift between machines may become an issue.*
+///
 /// See: Type
 class DateTimeType extends Type {
   static Default = {
@@ -55,16 +56,13 @@ class DateTimeType extends Type {
   /// Note:
   ///   This is also an instance method that can be called from
   ///   an instance of the type.
+  ///
   /// Return: string
   ///   Return the string value `'DATETIME'`
   static getDisplayName() {
     return 'DATETIME';
   }
 
-  getDisplayName() {
-    return this.constructor.getDisplayName();
-  }
-
   /// Construct a new `DATETIME` type.
   ///
   /// The `format` argument will specify the
@@ -82,6 +80,7 @@ class DateTimeType extends Type {
   /// to modify the precision of the underlying timestamp/datetime value.
   ///
   /// Return: DateTimeType
+  ///
   /// Arguments:
   ///   format?: string
   ///     Specify the client-side formatting for this date field.
@@ -111,6 +110,7 @@ class DateTimeType extends Type {
   ///   Return the incoming `value`, cast to this
   ///   type. `null` and `undefined` are simply
   ///   returned without casting.
+  ///
   /// Arguments:
   ///   context: <see name="CastToTypeContext">Type.castToType</see>
   castToType({ value, connection }) {
@@ -135,6 +135,7 @@ class DateTimeType extends Type {
   /// See the [moment](https://momentjs.com/docs/) library documentation for more information.
   ///
   /// Return: boolean
+  ///
   /// Arguments:
   ///   value: any
   ///     The value to check.
@@ -152,6 +153,7 @@ class DateTimeType extends Type {
   /// when no `connection` is provided is `'DATETIME'`.
   ///
   /// Return: string
+  ///
   /// Arguments:
   ///   connection?: <see>Connection</see>
   ///     An optional connection. If provided, send this
@@ -182,6 +184,7 @@ class DateTimeType extends Type {
   /// to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
   ///
   /// Return: string | null | undefined
+  ///
   /// Arguments:
   ///   value: moment
   ///     The date value to serialize.
@@ -224,7 +227,9 @@ class DateTimeType extends Type {
   /// Note:
   ///   This method is called by `castToType` to cast
   ///   incoming values into `moment` instances.
+  ///
   /// Return: moment
+  ///
   /// Arguments:
   ///   value: string | moment | null | undefined
   ///     The value to deserialize.