mythix-orm 1.5.6 → 1.6.1

package/lib/types/virtual/relational-type-base.js

@@ -42,19 +42,19 @@ class RelationalTypeBase extends Type {
     Object.defineProperties(this, {
       'targetModelName': {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        targetModelName,
       },
       'queryFactory': {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        queryFactory,
       },
       'options': {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        options,
       },
@@ -274,32 +274,24 @@ class RelationalTypeBase extends Type {
   }
 
   getTargetModel(_connection) {
-    let connection    = _connection || this.getModel().getConnection();
+    let connection = _connection || this.getModel().getConnection();
     return connection.getModel(this.targetModelName);
   }
 
-  async prepareQuery({ connection: _connection, self, field, options: _options, userQuery: _userQuery }, args) {
+  async prepareQuery({ connection: _connection, self, field, options: _options }, args) {
     let options       = _options || {};
     let queryFactory  = this.queryFactory;
     let connection    = _connection || self.getConnection(options.connection);
-    let userQuery     = _userQuery;
     let TargetModel   = this.getTargetModel(connection);
-
-    if (!QueryEngine.isQuery(userQuery) && Nife.instanceOf(userQuery, 'array', 'object', 'map', 'set'))
-      userQuery = Utils.generateQueryFromFilter(connection, TargetModel, userQuery);
-
     let rootQuery     = await queryFactory.call(
       self,
-      Object.assign(
-        {
-          userQuery:  userQuery || undefined,
-          type:       this,
-          self,
-          connection,
-          field,
-        },
-        connection.getModels() || {},
-      ),
+      {
+        type: this,
+        self,
+        connection,
+        field,
+      },
+      connection.getModels() || {},
       ...(args || []),
     );
 

package/lib/utils/index.d.ts

@@ -0,0 +1,6 @@
+export * from './misc-utils';
+export * as MiscUtils from './misc-utils';
+export * from './model-utils';
+export * as ModelUtils from './model-utils';
+export * from './query-utils';
+export * as QueryUtils from './query-utils';

package/lib/utils/index.js

@@ -6,9 +6,7 @@ const QueryUtils  = require('./query-utils');
 
 const {
   collect,
-  copyStaticProps,
   objectAssignSpecial,
-  iterateStaticProps,
 } = MiscUtils;
 
 const {
@@ -36,12 +34,11 @@ const {
 module.exports = {
   MiscUtils,
   ModelUtils,
+  QueryUtils,
 
   // MiscUtils
   collect,
-  copyStaticProps,
   objectAssignSpecial,
-  iterateStaticProps,
 
   // ModelUtils
   assignRelatedModels,

package/lib/utils/misc-utils.d.ts

@@ -0,0 +1,4 @@
+import { GenericObject } from '../interfaces/common';
+
+declare function collect(iterator: AsyncIterator<any>): Promise<Array<any>>;
+declare function objectAssignSpecial(obj: GenericObject, proto?: GenericObject | null, skipKeys?: Array<string> | GenericObject): GenericObject;

package/lib/utils/misc-utils.js

@@ -1,38 +1,5 @@
 'use strict';
 
-function iterateStaticProps(Klass, callback) {
-  if (typeof Klass !== 'function')
-    throw new TypeError('Utils::iterateStaticProps: "Klass" argument must be a function.');
-
-  let prototype = Klass.prototype;
-  let keys = Object.getOwnPropertyNames(Klass);
-
-  for (let i = 0, il = keys.length; i < il; i++) {
-    let key = keys[i];
-    if (key === 'length' || key === 'name' || key === 'prototype')
-      continue;
-
-    let value = Klass[key];
-    callback({ value, key, Klass, prototype });
-  }
-}
-
-function copyStaticProps(Klass, destination) {
-  if (typeof Klass !== 'function')
-    throw new TypeError('Utils::copyStaticProps: "Klass" argument must be a function.');
-
-  iterateStaticProps(Klass, ({ value, key }) => {
-    Object.defineProperties(destination, {
-      [key]: {
-        writable:     true,
-        enumberable:  false,
-        configurable: true,
-        value:        value,
-      },
-    });
-  });
-}
-
 async function collect(iterator) {
   let items = [];
 
@@ -67,7 +34,5 @@ function objectAssignSpecial(obj, proto, skipKeys) {
 
 module.exports = {
   collect,
-  copyStaticProps,
   objectAssignSpecial,
-  iterateStaticProps,
 };

package/lib/utils/model-utils.d.ts

@@ -0,0 +1,90 @@
+import ConnectionBase from '../connection/connection-base';
+import Field from '../field';
+import { GenericObject } from '../interfaces/common';
+import { Model, ModelClass } from '../model';
+import { QueryEngine } from '../query-engine';
+
+export declare interface FullyQualifiedFieldDefinition {
+  modelName: string;
+  fieldNames: Array<string>;
+}
+
+export declare interface RelationStatus {
+  create?: boolean;
+  instance?: Model | GenericObject;
+  modelName: string;
+  Model: ModelClass;
+  fields: Map<string, string>;
+}
+
+export declare interface ModelsRelationStatuses {
+  [ key: string ]: RelationStatus
+}
+
+export declare function isUUID(value: any): boolean;
+export declare function sanitizeFieldString(value: string): string;
+export declare function parseQualifiedName(value: string): FullyQualifiedFieldDefinition;
+export declare function injectModelMethod(self: any, method: Function, methodName: string, fullMethodName: string): void;
+export declare function fieldToFullyQualifiedName(field: Field | string, Model: ModelClass): string;
+
+export declare function sortModelNamesByDependencyOrder(
+  connection: ConnectionBase,
+  modelNames: Array<string>,
+  dependencyHelper: (Model: ModelClass, modelName: string) => Array<string>,
+): Array<string>;
+
+export declare function sortModelNamesByCreationOrder(connection: ConnectionBase, modelNames: Array<string>): Array<string>;
+
+export declare function getRelationalModelStatusForField(
+  connection: ConnectionBase,
+  self: Model,
+  field: Field,
+  ...args: Array<any>,
+): Promise<{
+  relationalMap: ModelsRelationStatuses,
+  TargetModel?: ModelClass,
+  TargetField?: Field,
+}>;
+
+export declare function constructModelsForCreationFromOriginField(
+  connection: ConnectionBase,
+  self: Model,
+  field: Field,
+  attributes: Model | GenericObject,
+): Promise<{
+  relationalMap: ModelsRelationStatuses,
+  sortedModelNames: Array<string>
+} | undefined>;
+
+export declare function createAndSaveAllRelatedModels(
+  connection: ConnectionBase,
+  self: Model,
+  field: Field,
+  allModelAttributes: Array<Model | GenericObject>,
+  options?: GenericObject,
+): Promise<Array<Model> | undefined>;
+
+export declare function setRelationalValues<T = Model>(
+  connection: ConnectionBase,
+  TargetModel: ModelClass,
+  targetModelInstance: T,
+  SourceModel: ModelClass,
+  sourceModelInstance: Model,
+): T;
+
+export declare function assignRelatedModels(model: Model, relatedModels: Model | Array<Model>): void;
+export declare function getPrimaryKeysForModels(
+  connection: ConnectionBase,
+  Model: ModelClass,
+  models: Model | Array<Model>,
+  options?: {
+    includeRelations?: boolean | Array<string>,
+    skipRelations?: Array<string>,
+  },
+): Array<any> | { [ key: string ]: Array<any> };
+
+export declare function buildQueryFromModelsAttributes(
+  connection: ConnectionBase,
+  Model: ModelClass,
+  models: Model | GenericObject | Array<Model | GenericObject>
+): QueryEngine;

package/lib/utils/model-utils.js

@@ -41,7 +41,7 @@ function injectModelMethod(self, method, methodName, fullMethodName) {
   Object.defineProperties(self, {
     [fullMethodName]: {
       writable:     true,
-      enumberable:  false,
+      enumerable:   false,
       configurable: true,
       value:        method,
     },
@@ -51,7 +51,7 @@ function injectModelMethod(self, method, methodName, fullMethodName) {
     Object.defineProperties(self, {
       [methodName]: {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        function(...args) {
           return method.apply(this, args);
@@ -574,7 +574,7 @@ function assignRelatedModels(model, _relatedModels) {
 
       Object.defineProperty(relatedScope, 'Model', {
         writable:     true,
-        enumberable:  false,
+        enumerable:   false,
         configurable: true,
         value:        RelatedModel,
       });
@@ -589,7 +589,7 @@ function assignRelatedModels(model, _relatedModels) {
       if (Nife.isNotEmpty(pkValue)) {
         Object.defineProperty(relatedScope, pkValue, {
           writable:     true,
-          enumberable:  false,
+          enumerable:   false,
           configurable: true,
           value:        relatedModel,
         });

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

@@ -0,0 +1,11 @@
+import ConnectionBase from '../connection/connection-base';
+import { GenericObject } from '../interfaces/common';
+import { Model, ModelClass } from '../model';
+import { QueryEngine } from '../query-engine';
+
+export declare function parseFilterFieldAndOperator(fieldName: string): { field: string, operator: string };
+export declare function generateQueryFromFilter(
+  connection: ConnectionBase,
+  Model: ModelClass,
+  filter: Array<GenericObject | Model> | GenericObject | Model,
+): QueryEngine;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "mythix-orm",
-  "version": "1.5.6",
+  "version": "1.6.1",
   "description": "ORM for Mythix framework",
-  "main": "lib/index.js",
+  "main": "lib/index",
   "type": "commonjs",
   "scripts": {
     "coverage": "clear ; node ./node_modules/.bin/nyc ./node_modules/.bin/jasmine",
@@ -34,6 +34,7 @@
   "homepage": "https://github.com/th317erd/mythix-orm#readme",
   "devDependencies": {
     "@spothero/eslint-plugin-spothero": "github:spothero/eslint-plugin-spothero",
+    "@types/node": "^18.7.16",
     "better-sqlite3": "^7.6.2",
     "colors": "^1.4.0",
     "diff": "^5.1.0",

package/.biblorc.js

@@ -1,29 +0,0 @@
-'use strict';
-
-/* global __dirname */
-
-const Path = require('path');
-
-module.exports = {
-  rootDir:    __dirname,
-  inputDir:   Path.resolve(__dirname),
-  outputDir:  Path.resolve(__dirname, '..', 'mythix-orm.wiki'),
-  files: [
-    {
-      include:  /\/lib\/.*\.js$/,
-      parser:   'typescript',
-      compiler: 'typescript',
-    },
-    {
-      include:  /\/docs\/.*\.md$/,
-      parser:   'markdown',
-      compiler: 'markdown',
-    },
-  ],
-  exclude: [
-    /node_modules|\/spec\//
-  ],
-  generatorOptions: {
-    baseURL: './',
-  },
-};