leoric 2.8.2 → 2.8.3

package/History.md

@@ -1,3 +1,13 @@
+2.8.3 / 2022-09-15
+==================
+
+## What's Changed
+* fix: AssociationOptions.select? should be supported by @cyjake in https://github.com/cyjake/leoric/pull/343
+* fix: return type of realm.query, realm.transaction, and Bone.transation by @cyjake in https://github.com/cyjake/leoric/pull/344
+
+
+**Full Changelog**: https://github.com/cyjake/leoric/compare/v2.8.2...v2.8.3
+
 2.8.2 / 2022-09-13
 ==================
 

package/index.d.ts

@@ -8,11 +8,11 @@ import {
   Connection, QueryOptions,
   Raw, ColumnMeta, AttributeMeta,
   BeforeHooksType, AfterHooksType, Collection,
+  GeneratorReturnType,
 } from './src/types/common';
 import { SpellMeta, Spell, SpellBookFormatResult } from './src/spell';
 import Bone from './src/bone';
 import { ConnectOptions, AbstractDriver } from './src/drivers';
-import { RawQueryResult } from './src/types/abstract_bone';
 
 export { 
   LENGTH_VARIANTS as LENGTH_VARIANTS,
@@ -43,15 +43,14 @@ interface SyncOptions {
 
 interface RawQueryOptions {
   replacements?: { [key:string]: Literal | Literal[] };
-  model: Bone;
-  connection: Connection;
+  connection?: Connection;
 }
 
 export default class Realm {
   Bone: typeof Bone;
   DataTypes: typeof DataTypes;
   driver: AbstractDriver;
-  models: Record<string, Bone>;
+  models: Record<string, typeof Bone>;
   connected?: boolean;
 
   constructor(options: ConnectOptions);
@@ -75,10 +74,10 @@ export default class Realm {
 
   escape(value: Literal): string;
 
-  query(sql: string, values?: Array<Literal>, options?: RawQueryOptions): RawQueryResult;
+  query<T extends typeof Bone>(sql: string, values?: Array<Literal>, options?: RawQueryOptions & { model?: T }): Promise<{ rows: T extends typeof Bone ? InstanceType<T>[] : Object[], fields?: Object[], affectedRows?: number }>;
 
-  transaction(callback: GeneratorFunction): Promise<RawQueryResult>;
-  transaction(callback: (connection: Connection) => Promise<RawQueryResult>): Promise<RawQueryResult>;
+  transaction<T extends (connection: Connection) => Generator>(callback: T): Promise<GeneratorReturnType<ReturnType<T>>>;
+  transaction<T extends (connection: Connection) => Promise<any>>(callback: T): Promise<ReturnType<T>>;
 
   sync(options?: SyncOptions): Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "leoric",
-  "version": "2.8.2",
+  "version": "2.8.3",
   "description": "JavaScript Object-relational mapping alchemy",
   "main": "index.js",
   "types": "index.d.ts",

package/src/bone.js

@@ -224,6 +224,7 @@ class Bone {
     this.#raw = Object.assign({}, this.getRaw(), target.getRaw());
     this.#rawSaved = Object.assign({}, this.getRawSaved(), target.getRawSaved());
     this.#rawPrevious = Object.assign({}, this.getRawPrevious(), target.getRawPrevious());
+    this.#rawUnset = target._getRawUnset();
   }
 
   /**
@@ -1066,9 +1067,7 @@ class Bone {
    * The primary key of the model, in camelCase.
    * @type {string}
    */
-  static get primaryKey() {
-    return 'id';
-  }
+  static primaryKey = 'id';
 
   /**
    * The primary column of the model, in snake_case, usually.
@@ -1254,7 +1253,7 @@ class Bone {
     }
     const { className } = opts;
     const Model = this.models[className];
-    if (!Model) throw new Error(`unable to find model "${className}"`);
+    if (!Model) throw new Error(`unable to find associated model "${className}" (model ${this.name})`);
     if (opts.foreignKey && Model.attributes[opts.foreignKey] && Model.attributes[opts.foreignKey].virtual) {
       throw new Error(`unable to use virtual attribute ${opts.foreignKey} as foreign key in model ${Model.name}`);
     }
@@ -1589,9 +1588,9 @@ class Bone {
         await this.driver.query('BEGIN', [], {  connection, Model: this, command: 'BEGIN' });
         while (true) {
           const { value: spell, done } = gen.next(result);
-          if (done) break;
           if (spell instanceof Spell) spell.connection = connection;
-          result = typeof spell.then === 'function' ? await spell : spell;
+          result = spell && typeof spell.then === 'function' ? await spell : spell;
+          if (done) break;
         }
         await this.driver.query('COMMIT', [], {  connection, Model: this, command: 'COMMIT' });
       } catch (err) {

package/src/decorators.js

@@ -44,14 +44,12 @@ function findType(tsType) {
             throw new Error(`unknown typescript type ${tsType}`);
     }
 }
-function Column(options) {
+function Column(options = {}) {
     return function (target, propertyKey) {
-        if (options == null) {
-            options = {};
-        }
         // target refers to model prototype, an internal instance of `Bone {}`
-        if (options['prototype'] instanceof data_types_1.DataType || options instanceof data_types_1.DataType)
+        if (options['prototype'] instanceof data_types_1.DataType || options instanceof data_types_1.DataType) {
             options = { type: options };
+        }
         if (!('type' in options)) {
             const tsType = Reflect.getMetadata('design:type', target, propertyKey);
             options['type'] = findType(tsType);
@@ -68,9 +66,10 @@ function Column(options) {
 }
 exports.Column = Column;
 const { hasMany, hasOne, belongsTo } = constants_1.ASSOCIATE_METADATA_MAP;
-function HasMany(options) {
+function HasMany(options = {}) {
     return function (target, propertyKey) {
         const model = target.constructor;
+        // it seems it's not possible to get the type of array element at runtime
         Reflect.defineMetadata(hasMany, {
             ...Reflect.getMetadata(hasMany, model),
             [propertyKey]: options,
@@ -78,9 +77,14 @@ function HasMany(options) {
     };
 }
 exports.HasMany = HasMany;
-function HasOne(options) {
+function HasOne(options = {}) {
     return function (target, propertyKey) {
         const model = target.constructor;
+        if (options.className == null) {
+            const tsType = Reflect.getMetadata('design:type', target, propertyKey);
+            if (tsType.name !== 'Function')
+                options.className = tsType.name;
+        }
         Reflect.defineMetadata(hasOne, {
             ...Reflect.getMetadata(hasOne, model),
             [propertyKey]: options,
@@ -88,9 +92,24 @@ function HasOne(options) {
     };
 }
 exports.HasOne = HasOne;
-function BelongsTo(options) {
+/**
+ * design:type will be `Function { [native code] }` in following example
+ *
+ * @example
+ * import type Foo from './foo';
+ * class Bar extends Bone {
+ *   @BelongsTo()
+ *   foo?: Foo;
+ * }
+ */
+function BelongsTo(options = {}) {
     return function (target, propertyKey) {
         const model = target.constructor;
+        if (options.className == null) {
+            const tsType = Reflect.getMetadata('design:type', target, propertyKey);
+            if (tsType.name !== 'Function')
+                options.className = tsType.name;
+        }
         Reflect.defineMetadata(belongsTo, {
             ...Reflect.getMetadata(belongsTo, model),
             [propertyKey]: options,

package/src/decorators.js.map

@@ -1 +1 @@
-{"version":3,"file":"decorators.js","sourceRoot":"","sources":["decorators.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4BAA0B;AAG1B,2DAA8D;AAC9D,2CAAqD;AAWrD,SAAS,QAAQ,CAAC,MAAM;IACtB,MAAM,EACJ,MAAM,EAAE,OAAO,EACf,IAAI,EACJ,MAAM,EACN,OAAO,GACR,GAAG,oBAAS,CAAC;IAEd,QAAQ,MAAM,EAAE;QACd,KAAK,MAAM;YACT,OAAO,MAAM,CAAC;QAChB,KAAK,MAAM;YACT,OAAO,OAAO,CAAC;QACjB,KAAK,IAAI;YACP,OAAO,IAAI,CAAC;QACd,KAAK,MAAM;YACT,OAAO,MAAM,CAAC;QAChB,KAAK,OAAO;YACV,OAAO,OAAO,CAAC;QACjB;YACE,MAAM,IAAI,KAAK,CAAC,2BAA2B,MAAM,EAAE,CAAC,CAAC;KACxD;AACH,CAAC;AAED,SAAgB,MAAM,CAAC,OAAuD;IAC5E,OAAO,UAAS,MAAY,EAAE,WAAmB;QAC/C,IAAI,OAAO,IAAI,IAAI,EAAE;YACnB,OAAO,GAAG,EAAE,CAAC;SACd;QAED,sEAAsE;QACtE,IAAI,OAAO,CAAC,WAAW,CAAC,YAAY,qBAAQ,IAAI,OAAO,YAAY,qBAAQ;YAAE,OAAO,GAAG,EAAE,IAAI,EAAE,OAA8B,EAAE,CAAC;QAEhI,IAAI,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC,EAAE;YACxB,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;YACvE,OAAO,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;SACpC;QAED,gDAAgD;QAChD,IAAI,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,OAAO,EAAE,CAAC,CAAC;QAE/E,sEAAsE;QACtE,MAAM,KAAK,GAAG,MAAM,CAAC,WAAkB,CAAC;QACxC,MAAM,EAAE,UAAU,GAAG,CAAC,KAAK,CAAC,UAAU,GAAG,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC;QACvD,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC;QACrD,UAAU,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,WAAW,EAAE,UAAU,EAAE,CAAC;IAC3D,CAAC,CAAC;AACJ,CAAC;AAvBD,wBAuBC;AAED,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,kCAAsB,CAAC;AAE9D,SAAgB,OAAO,CAAC,OAA0B;IAChD,OAAO,UAAS,MAAY,EAAE,WAAmB;QAC/C,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC;QACjC,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE;YAC9B,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC;YACtC,CAAC,WAAW,CAAC,EAAE,OAAO;SACvB,EAAE,KAAK,CAAC,CAAC;IACZ,CAAC,CAAA;AACH,CAAC;AARD,0BAQC;AAED,SAAgB,MAAM,CAAC,OAA0B;IAC/C,OAAO,UAAS,MAAY,EAAE,WAAmB;QAC/C,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC;QACjC,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE;YAC7B,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC;YACrC,CAAC,WAAW,CAAC,EAAE,OAAO;SACvB,EAAE,KAAK,CAAC,CAAC;IACZ,CAAC,CAAA;AACH,CAAC;AARD,wBAQC;AAED,SAAgB,SAAS,CAAC,OAA0B;IAClD,OAAO,UAAS,MAAY,EAAE,WAAmB;QAC/C,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC;QACjC,OAAO,CAAC,cAAc,CAAC,SAAS,EAAE;YAChC,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC;YACxC,CAAC,WAAW,CAAC,EAAE,OAAO;SACvB,EAAE,KAAK,CAAC,CAAC;IACZ,CAAC,CAAA;AACH,CAAC;AARD,8BAQC"}
+{"version":3,"file":"decorators.js","sourceRoot":"","sources":["decorators.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4BAA0B;AAG1B,2DAA8D;AAC9D,2CAAqD;AAWrD,SAAS,QAAQ,CAAC,MAAM;IACtB,MAAM,EACJ,MAAM,EAAE,OAAO,EACf,IAAI,EACJ,MAAM,EACN,OAAO,GACR,GAAG,oBAAS,CAAC;IAEd,QAAQ,MAAM,EAAE;QACd,KAAK,MAAM;YACT,OAAO,MAAM,CAAC;QAChB,KAAK,MAAM;YACT,OAAO,OAAO,CAAC;QACjB,KAAK,IAAI;YACP,OAAO,IAAI,CAAC;QACd,KAAK,MAAM;YACT,OAAO,MAAM,CAAC;QAChB,KAAK,OAAO;YACV,OAAO,OAAO,CAAC;QACjB;YACE,MAAM,IAAI,KAAK,CAAC,2BAA2B,MAAM,EAAE,CAAC,CAAC;KACxD;AACH,CAAC;AAED,SAAgB,MAAM,CAAC,UAAyD,EAAE;IAChF,OAAO,UAAS,MAAY,EAAE,WAAmB;QAC/C,sEAAsE;QACtE,IAAI,OAAO,CAAC,WAAW,CAAC,YAAY,qBAAQ,IAAI,OAAO,YAAY,qBAAQ,EAAE;YAC3E,OAAO,GAAG,EAAE,IAAI,EAAE,OAA8B,EAAE,CAAC;SACpD;QAED,IAAI,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC,EAAE;YACxB,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;YACvE,OAAO,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;SACpC;QAED,gDAAgD;QAChD,IAAI,CAAC,CAAC,MAAM,IAAI,OAAO,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,OAAO,EAAE,CAAC,CAAC;QAE/E,sEAAsE;QACtE,MAAM,KAAK,GAAG,MAAM,CAAC,WAAkB,CAAC;QACxC,MAAM,EAAE,UAAU,GAAG,CAAC,KAAK,CAAC,UAAU,GAAG,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC;QACvD,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC;QACrD,UAAU,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,WAAW,EAAE,UAAU,EAAE,CAAC;IAC3D,CAAC,CAAC;AACJ,CAAC;AArBD,wBAqBC;AAED,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,kCAAsB,CAAC;AAE9D,SAAgB,OAAO,CAAC,UAA4B,EAAE;IACpD,OAAO,UAAS,MAAY,EAAE,WAAmB;QAC/C,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC;QACjC,yEAAyE;QACzE,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE;YAC9B,GAAG,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC;YACtC,CAAC,WAAW,CAAC,EAAE,OAAO;SACvB,EAAE,KAAK,CAAC,CAAC;IACZ,CAAC,CAAA;AACH,CAAC;AATD,0BASC;AAED,SAAgB,MAAM,CAAC,UAA4B,EAAE;IACnD,OAAO,UAAS,MAAY,EAAE,WAAmB;QAC/C,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC;QACjC,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,EAAE;YAC7B,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;YACvE,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU;gBAAE,OAAO,CAAC,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC;SACjE;QACD,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE;YAC7B,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC;YACrC,CAAC,WAAW,CAAC,EAAE,OAAO;SACvB,EAAE,KAAK,CAAC,CAAC;IACZ,CAAC,CAAA;AACH,CAAC;AAZD,wBAYC;AAED;;;;;;;;;GASG;AACH,SAAgB,SAAS,CAAC,UAA4B,EAAE;IACtD,OAAO,UAAS,MAAY,EAAE,WAAmB;QAC/C,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC;QACjC,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,EAAE;YAC7B,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,aAAa,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;YACvE,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU;gBAAE,OAAO,CAAC,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC;SACjE;QACD,OAAO,CAAC,cAAc,CAAC,SAAS,EAAE;YAChC,GAAG,OAAO,CAAC,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC;YACxC,CAAC,WAAW,CAAC,EAAE,OAAO;SACvB,EAAE,KAAK,CAAC,CAAC;IACZ,CAAC,CAAA;AACH,CAAC;AAZD,8BAYC"}

package/src/decorators.ts

@@ -37,14 +37,12 @@ function findType(tsType) {
   }
 }
 
-export function Column(options?: ColumnOption | DATA_TYPE<DataType> | DataType) {
+export function Column(options: ColumnOption | DATA_TYPE<DataType> | DataType = {}) {
   return function(target: Bone, propertyKey: string) {
-    if (options == null) {
-      options = {};
-    }
-
     // target refers to model prototype, an internal instance of `Bone {}`
-    if (options['prototype'] instanceof DataType || options instanceof DataType) options = { type: options as DATA_TYPE<DataType> };
+    if (options['prototype'] instanceof DataType || options instanceof DataType) {
+      options = { type: options as DATA_TYPE<DataType> };
+    }
 
     if (!('type' in options)) {
       const tsType = Reflect.getMetadata('design:type', target, propertyKey);
@@ -64,9 +62,10 @@ export function Column(options?: ColumnOption | DATA_TYPE<DataType> | DataType)
 
 const { hasMany, hasOne, belongsTo } = ASSOCIATE_METADATA_MAP;
 
-export function HasMany(options?: AssociateOptions) {
+export function HasMany(options: AssociateOptions = {}) {
   return function(target: Bone, propertyKey: string) {
     const model = target.constructor;
+    // it seems it's not possible to get the type of array element at runtime
     Reflect.defineMetadata(hasMany, {
       ...Reflect.getMetadata(hasMany, model),
       [propertyKey]: options,
@@ -74,9 +73,13 @@ export function HasMany(options?: AssociateOptions) {
   }
 }
 
-export function HasOne(options?: AssociateOptions) {
+export function HasOne(options: AssociateOptions = {}) {
   return function(target: Bone, propertyKey: string) {
     const model = target.constructor;
+    if (options.className == null) {
+      const tsType = Reflect.getMetadata('design:type', target, propertyKey);
+      if (tsType.name !== 'Function') options.className = tsType.name;
+    }
     Reflect.defineMetadata(hasOne, {
       ...Reflect.getMetadata(hasOne, model),
       [propertyKey]: options,
@@ -84,9 +87,23 @@ export function HasOne(options?: AssociateOptions) {
   }
 }
 
-export function BelongsTo(options?: AssociateOptions) {
+/**
+ * design:type will be `Function { [native code] }` in following example
+ * 
+ * @example
+ * import type Foo from './foo';
+ * class Bar extends Bone {
+ *   @BelongsTo()
+ *   foo?: Foo;
+ * }
+ */
+export function BelongsTo(options: AssociateOptions = {}) {
   return function(target: Bone, propertyKey: string) {
     const model = target.constructor;
+    if (options.className == null) {
+      const tsType = Reflect.getMetadata('design:type', target, propertyKey);
+      if (tsType.name !== 'Function') options.className = tsType.name;
+    }
     Reflect.defineMetadata(belongsTo, {
       ...Reflect.getMetadata(belongsTo, model),
       [propertyKey]: options,

package/src/realm.js

@@ -230,8 +230,8 @@ class Realm {
     }
 
     return {
+      ...restRes,
       rows: results.length > 0 ? results : rows,
-      ...restRes
     };
   }
 

package/src/types/abstract_bone.d.ts

@@ -2,13 +2,12 @@ import DataTypes, { AbstractDataType, DataType } from "../data_types";
 import { 
   Pool, Literal, WhereConditions,
   Collection, ResultSet, InstanceValues, OrderOptions,
-  QueryOptions, AttributeMeta, AssociateOptions, Values, Connection, BulkCreateOptions,
+  QueryOptions, AttributeMeta, AssociateOptions, Values, Connection, BulkCreateOptions, 
+  GeneratorReturnType,
 } from './common';
 import { AbstractDriver } from '../drivers';
 import { Spell } from '../spell';
 
-export type RawQueryResult = typeof AbstractBone | ResultSet | boolean | number;
-
 interface SyncOptions {
   force?: boolean;
   alter?: boolean;
@@ -216,9 +215,9 @@ export class AbstractBone {
    *   yield Muscle.create({ boneId: bone.id, bar: 1 })
    * });
    */
-  static transaction(callback: GeneratorFunction): Promise<RawQueryResult>;
-  static transaction(callback: (connection: TransactionOptions) => Promise<RawQueryResult | void>): Promise<RawQueryResult>;
-
+  static transaction<T extends (connection: Connection) => Generator>(callback: T): Promise<GeneratorReturnType<ReturnType<T>>>;
+  static transaction<T extends (connection: Connection) => Promise<any>>(callback: T): Promise<ReturnType<T>>;
+  
   static describe(): Promise<{[key: string]: any[]}>;
 
   /**
@@ -357,4 +356,4 @@ export class AbstractBone {
    * @return {Object}
    */
   toObject(): InstanceValues<this>;
-}
+}

package/src/types/common.d.ts

@@ -68,6 +68,7 @@ export interface AssociateOptions {
   foreignKey?: string;
   through?: string;
   where?: Record<string, Literal>;
+  select?: string[] | ((name: string) => boolean);
 }
 
 export type command = 'select' | 'insert' | 'bulkInsert' | 'update' | 'delete' | 'upsert';
@@ -177,3 +178,6 @@ export type InstanceValues<T> = {
 
 export type BeforeHooksType = 'beforeCreate' | 'beforeBulkCreate' | 'beforeUpdate' | 'beforeSave' |  'beforeUpsert' | 'beforeRemove';
 export type AfterHooksType = 'afterCreate' | 'afterBulkCreate' | 'afterUpdate' | 'afterSave' | 'afterUpsert' | 'afterRemove';
+
+// https://stackoverflow.com/a/67232225/179691
+type GeneratorReturnType<T extends Generator> = T extends Generator<any, infer R, any> ? R: never;