leoric 2.3.1 → 2.3.2

package/History.md

@@ -1,3 +1,17 @@
+2.3.2 / 2022-04-15
+==================
+
+## What's Changed
+* fix: order by raw with mix-type array in sequelize mode by @JimmyDaddy in https://github.com/cyjake/leoric/pull/298
+* docs: monthly updates and example about egg-orm usage with TypeScript by @cyjake in https://github.com/cyjake/leoric/pull/299
+* docs: monthly updates in en & docmentation about typescript support by @cyjake in https://github.com/cyjake/leoric/pull/300
+* fix: raw query should format replacements with extra blank by @JimmyDaddy in https://github.com/cyjake/leoric/pull/301
+* docs: elaborate on querying by @cyjake in https://github.com/cyjake/leoric/pull/302
+* feat: transaction should return result by @JimmyDaddy in https://github.com/cyjake/leoric/pull/303
+
+
+**Full Changelog**: https://github.com/cyjake/leoric/compare/v2.3.1...v2.3.2
+
 2.3.1 / 2022-03-22
 ==================
 

package/Readme.md

@@ -74,6 +74,32 @@ await realm.sync();
 
 A more detailed syntax table may be found at the [documentation](https://leoric.js.org/#syntax-table) site.
 
+## TypeScript charged
+
+```ts
+import { Bone, BelongsTo, Column, DataTypes: { TEXT } } from 'leoric';
+import User from './user';
+
+export default class Post extends Bone {
+  @Column({ autoIncrement: true })
+  id: bigint;
+
+  @Column(TEXT)
+  content: string;
+
+  @Column()
+  description: string;
+
+  @Column()
+  userId: bigint;
+
+  @BelongsTo()
+  user: User;
+}
+```
+
+More about TypeScript integration examples can be found at [the TypeScript support documentation](https://leoric.js.org/types)
+
 ## Contributing
 
 There are many ways in which you can participate in the project, for example:
@@ -89,6 +115,6 @@ If you are interested in fixing issues and contributing directly to the code bas
 - Submitting pull requests
 - Contributing to translations
 
-## Related Projects
+## egg-orm
 
-If developing web applications with [egg framework](https://eggjs.org/), it's highly recommended using the [egg-orm](https://github.com/eggjs/egg-orm) plugin.
+If developing web applications with [egg framework](https://eggjs.org/), it's highly recommended using the [egg-orm](https://github.com/eggjs/egg-orm) plugin. More detailed examples about setting up egg-orm with egg framework in either JavaScript or TypeScript can be found at <https://github.com/eggjs/egg-orm/tree/master/examples>

package/package.json

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

package/src/adapters/sequelize.js

@@ -35,6 +35,8 @@ function translateOptions(spell, options) {
       } else if (order.length && order[0]) {
         // ['created_at', 'asc']
         spell.$order(order[0], order[1] || '');
+      } else if (order instanceof Raw) {
+        spell.$order(order);
       }
     }
   }

package/src/bone.js

@@ -1567,11 +1567,12 @@ class Bone {
 
   static async transaction(callback) {
     const connection = await this.driver.getConnection();
+    let result;
     if (callback.constructor.name === 'AsyncFunction') {
       // if callback is an AsyncFunction
       await this.driver.query('BEGIN', [], { connection, Model: this, command: 'BEGIN'  });
       try {
-        await callback({ connection });
+        result = await callback({ connection });
         await this.driver.query('COMMIT', [], { connection, Model: this, command: 'COMMIT'  });
       } catch (err) {
         await this.driver.query('ROLLBACK', [], { connection, Model: this, command: 'ROLLBACK' });
@@ -1581,7 +1582,6 @@ class Bone {
       }
     } else if (callback.constructor.name === 'GeneratorFunction') {
       const gen = callback({ connection });
-      let result;
 
       try {
         await this.driver.query('BEGIN', [], {  connection, Model: this, command: 'BEGIN' });
@@ -1601,6 +1601,7 @@ class Bone {
     } else {
       throw new Error('unexpected transaction function, should be GeneratorFunction or AsyncFunction.');
     }
+    return result;
   }
 
   static init(attributes = {}, opts = {}, overrides = {}) {

package/src/realm.js

@@ -195,7 +195,7 @@ class Realm {
         throw new Error(`unable to replace: ${key}`);
       }
       values.push(replacements[key]);
-      return '?';
+      return ' ?';
     });
 
     const { rows, ...restRes } = await this.driver.query(query, values, opts);