@faasjs/knex 1.4.1 → 1.5.0

package/README.md

@@ -1,174 +1,28 @@
 # @faasjs/knex
 
-[![License: MIT](https://img.shields.io/npm/l/@faasjs/knex.svg)](https://github.com/faasjs/faasjs/blob/main/packages/faasjs/knex/LICENSE)
-[![NPM Stable Version](https://img.shields.io/npm/v/@faasjs/knex/stable.svg)](https://www.npmjs.com/package/@faasjs/knex)
-[![NPM Beta Version](https://img.shields.io/npm/v/@faasjs/knex/beta.svg)](https://www.npmjs.com/package/@faasjs/knex)
-
 FaasJS's sql plugin, base on [Knex](https://knexjs.org/).
 
+[![License: MIT](https://img.shields.io/npm/l/@faasjs/knex.svg)](https://github.com/faasjs/faasjs/blob/main/packages/faasjs/knex/LICENSE)
+[![NPM Version](https://img.shields.io/npm/v/@faasjs/knex.svg)](https://www.npmjs.com/package/@faasjs/knex)
+
 ## Install
 
 ```sh
 npm install @faasjs/knex
 ```
 
-## Modules
-
-### Classes
+## Classes
 
 - [Knex](classes/Knex.md)
 
-### Type Aliases
-
-- [KnexConfig](#knexconfig)
-
-### Functions
-
-- [originKnex](#originknex)
-- [query](#query)
-- [raw](#raw)
-- [transaction](#transaction)
-- [useKnex](#useknex)
-
 ## Type Aliases
 
-### KnexConfig
-
-Ƭ **KnexConfig**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `config?` | `OriginKnex.Config` |
-| `name?` | `string` |
+- [KnexConfig](type-aliases/KnexConfig.md)
 
 ## Functions
 
-### originKnex
-
-▸ **originKnex**\<`TRecord`, `TResult`\>(`config`): `Knex`\<`TRecord`, `TResult`\>
-
-Origin [knex](https://knexjs.org/) instance.
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TRecord` | extends `Object` = `any` |
-| `TResult` | `unknown`[] |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `config` | `string` \| `Config`\<`any`\> |
-
-#### Returns
-
-`Knex`\<`TRecord`, `TResult`\>
-
-___
-
-### query
-
-▸ **query**\<`TName`\>(`table`): `OriginKnex.QueryBuilder`\<`OriginKnex.TableType`\<`TName`\>, \{ `_aliases`: {} ; `_base`: `OriginKnex.ResolveTableType`\<`OriginKnex.TableType`\<`TName`\>, ``"base"``\> ; `_hasSelection`: ``false`` ; `_intersectProps`: {} ; `_keys`: `never` ; `_single`: ``false`` ; `_unionProps`: `never`  }[]\>
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TName` | extends ``"test"`` |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `table` | `TName` |
-
-#### Returns
-
-`OriginKnex.QueryBuilder`\<`OriginKnex.TableType`\<`TName`\>, \{ `_aliases`: {} ; `_base`: `OriginKnex.ResolveTableType`\<`OriginKnex.TableType`\<`TName`\>, ``"base"``\> ; `_hasSelection`: ``false`` ; `_intersectProps`: {} ; `_keys`: `never` ; `_single`: ``false`` ; `_unionProps`: `never`  }[]\>
-
-▸ **query**\<`TName`, `TResult`\>(`table`): `OriginKnex.QueryBuilder`\<`TName`, `TResult`\>
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TName` | extends `Object` = `any` |
-| `TResult` | `any`[] |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `table` | `string` |
-
-#### Returns
-
-`OriginKnex.QueryBuilder`\<`TName`, `TResult`\>
-
-___
-
-### raw
-
-▸ **raw**\<`TResult`\>(`sql`, `bindings?`): `Promise`\<`TResult`\>
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TResult` | `any` |
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `sql` | `string` | `undefined` |
-| `bindings` | `ValueDict` \| `RawBinding`[] | `[]` |
-
-#### Returns
-
-`Promise`\<`TResult`\>
-
-___
-
-### transaction
-
-▸ **transaction**\<`TResult`\>(`scope`, `config?`, `options?`): `Promise`\<`TResult` \| `void`\>
-
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `TResult` | `any` |
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `scope` | (`trx`: `Transaction`\<`any`, `any`\>) => `void` \| `Promise`\<`TResult`\> |
-| `config?` | `TransactionConfig` |
-| `options?` | `Object` |
-| `options.trx?` | `Transaction`\<`any`, `any`[]\> |
-
-#### Returns
-
-`Promise`\<`TResult` \| `void`\>
-
-___
-
-### useKnex
-
-▸ **useKnex**(`config?`): `UseifyPlugin`\<[`Knex`](classes/Knex.md)\>
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `config?` | [`KnexConfig`](#knexconfig) |
-
-#### Returns
-
-`UseifyPlugin`\<[`Knex`](classes/Knex.md)\>
+- [originKnex](functions/originKnex.md)
+- [query](functions/query.md)
+- [raw](functions/raw.md)
+- [transaction](functions/transaction.md)
+- [useKnex](functions/useKnex.md)

package/dist/index.d.mts

@@ -3,6 +3,20 @@ import { Logger } from '@faasjs/logger';
 import knex, { Knex as Knex$1 } from 'knex';
 export { Knex as OriginKnex } from 'knex';
 
+/**
+ * FaasJS's sql plugin, base on [Knex](https://knexjs.org/).
+ *
+ * [![License: MIT](https://img.shields.io/npm/l/@faasjs/knex.svg)](https://github.com/faasjs/faasjs/blob/main/packages/faasjs/knex/LICENSE)
+ * [![NPM Version](https://img.shields.io/npm/v/@faasjs/knex.svg)](https://www.npmjs.com/package/@faasjs/knex)
+ *
+ * ## Install
+ *
+ * ```sh
+ * npm install @faasjs/knex
+ * ```
+ * @packageDocumentation
+ */
+
 /**
  * Origin [knex](https://knexjs.org/) instance.
  */
@@ -29,9 +43,9 @@ declare class Knex implements Plugin {
      *
      * - Support 'commit' and 'rollback' event.
      */
-    transaction<TResult = any>(scope: (trx: Knex$1.Transaction<any, any>) => Promise<TResult> | void, config?: Knex$1.TransactionConfig, options?: {
+    transaction<TResult = any>(scope: (trx: Knex$1.Transaction<any, any>) => Promise<TResult>, config?: Knex$1.TransactionConfig, options?: {
         trx?: Knex$1.Transaction;
-    }): Promise<TResult | void>;
+    }): Promise<TResult>;
     schema(): Knex$1.SchemaBuilder;
     quit(): Promise<void>;
 }
@@ -46,9 +60,9 @@ declare function query<TName extends Knex$1.TableNames>(table: TName): Knex$1.Qu
     _unionProps: never;
 }[]>;
 declare function query<TName extends {} = any, TResult = any[]>(table: string): Knex$1.QueryBuilder<TName, TResult>;
-declare function transaction<TResult = any>(scope: (trx: Knex$1.Transaction<any, any>) => Promise<TResult> | void, config?: Knex$1.TransactionConfig, options?: {
+declare function transaction<TResult = any>(scope: (trx: Knex$1.Transaction<any, any>) => Promise<TResult>, config?: Knex$1.TransactionConfig, options?: {
     trx?: Knex$1.Transaction;
-}): Promise<TResult | void>;
-declare function raw<TResult = any>(sql: string, bindings?: Knex$1.RawBinding[] | Knex$1.ValueDict): Promise<TResult>;
+}): Promise<TResult>;
+declare function raw<TResult = any>(sql: string, bindings?: Knex$1.RawBinding[] | Knex$1.ValueDict): Promise<Knex$1.Raw<TResult>>;
 
 export { Knex, type KnexConfig, originKnex, query, raw, transaction, useKnex };

package/dist/index.d.ts

@@ -3,6 +3,20 @@ import { Logger } from '@faasjs/logger';
 import knex, { Knex as Knex$1 } from 'knex';
 export { Knex as OriginKnex } from 'knex';
 
+/**
+ * FaasJS's sql plugin, base on [Knex](https://knexjs.org/).
+ *
+ * [![License: MIT](https://img.shields.io/npm/l/@faasjs/knex.svg)](https://github.com/faasjs/faasjs/blob/main/packages/faasjs/knex/LICENSE)
+ * [![NPM Version](https://img.shields.io/npm/v/@faasjs/knex.svg)](https://www.npmjs.com/package/@faasjs/knex)
+ *
+ * ## Install
+ *
+ * ```sh
+ * npm install @faasjs/knex
+ * ```
+ * @packageDocumentation
+ */
+
 /**
  * Origin [knex](https://knexjs.org/) instance.
  */
@@ -29,9 +43,9 @@ declare class Knex implements Plugin {
      *
      * - Support 'commit' and 'rollback' event.
      */
-    transaction<TResult = any>(scope: (trx: Knex$1.Transaction<any, any>) => Promise<TResult> | void, config?: Knex$1.TransactionConfig, options?: {
+    transaction<TResult = any>(scope: (trx: Knex$1.Transaction<any, any>) => Promise<TResult>, config?: Knex$1.TransactionConfig, options?: {
         trx?: Knex$1.Transaction;
-    }): Promise<TResult | void>;
+    }): Promise<TResult>;
     schema(): Knex$1.SchemaBuilder;
     quit(): Promise<void>;
 }
@@ -46,9 +60,9 @@ declare function query<TName extends Knex$1.TableNames>(table: TName): Knex$1.Qu
     _unionProps: never;
 }[]>;
 declare function query<TName extends {} = any, TResult = any[]>(table: string): Knex$1.QueryBuilder<TName, TResult>;
-declare function transaction<TResult = any>(scope: (trx: Knex$1.Transaction<any, any>) => Promise<TResult> | void, config?: Knex$1.TransactionConfig, options?: {
+declare function transaction<TResult = any>(scope: (trx: Knex$1.Transaction<any, any>) => Promise<TResult>, config?: Knex$1.TransactionConfig, options?: {
     trx?: Knex$1.Transaction;
-}): Promise<TResult | void>;
-declare function raw<TResult = any>(sql: string, bindings?: Knex$1.RawBinding[] | Knex$1.ValueDict): Promise<TResult>;
+}): Promise<TResult>;
+declare function raw<TResult = any>(sql: string, bindings?: Knex$1.RawBinding[] | Knex$1.ValueDict): Promise<Knex$1.Raw<TResult>>;
 
 export { Knex, type KnexConfig, originKnex, query, raw, transaction, useKnex };

package/dist/index.js

@@ -166,37 +166,40 @@ var Knex = class {
       throw Error(`[${this.name}] Client not initialized.`);
     if (options == null ? void 0 : options.trx)
       return scope(options.trx);
-    return this.adapter.transaction(async (trx) => {
-      const trxId = crypto.randomUUID();
-      try {
-        const result = await scope(trx);
-        this.logger.debug(
-          "[%s] [%s] query begin: %s",
-          this.name,
-          trxId,
-          "COMMIT;"
-        );
-        await trx.commit();
+    const trx = await this.adapter.transaction(config);
+    const trxId = crypto.randomUUID();
+    this.logger.debug("[%s] [%s] transaction begin", this.name, trxId);
+    try {
+      const result = await scope(trx);
+      if (trx.isCompleted()) {
         this.logger.debug(
-          "[%s] [%s] query done: %s",
+          "[%s] [%s] transaction has been finished in scope",
           this.name,
-          trxId,
-          "COMMIT;"
+          trxId
         );
-        trx.emit("commit");
         return result;
-      } catch (error) {
-        await trx.rollback(error);
-        this.logger.debug(
-          "[%s] [%s] query failed: %s",
-          this.name,
-          trxId,
-          "ROLLBACK;"
-        );
-        trx.emit("rollback", error);
-        throw error;
       }
-    }, config);
+      this.logger.debug("[%s] [%s] transaction begin commit", this.name, trxId);
+      await trx.commit();
+      this.logger.debug(
+        "[%s] [%s] transaction committed: %j",
+        this.name,
+        trxId,
+        result
+      );
+      trx.emit("commit");
+      return result;
+    } catch (error) {
+      await trx.rollback(error);
+      this.logger.error(
+        "[%s] [%s] transaction rollback: %s",
+        this.name,
+        trxId,
+        error
+      );
+      trx.emit("rollback", error);
+      throw error;
+    }
   }
   schema() {
     if (!this.adapter)

package/dist/index.mjs

@@ -160,37 +160,40 @@ var Knex = class {
       throw Error(`[${this.name}] Client not initialized.`);
     if (options == null ? void 0 : options.trx)
       return scope(options.trx);
-    return this.adapter.transaction(async (trx) => {
-      const trxId = randomUUID();
-      try {
-        const result = await scope(trx);
-        this.logger.debug(
-          "[%s] [%s] query begin: %s",
-          this.name,
-          trxId,
-          "COMMIT;"
-        );
-        await trx.commit();
+    const trx = await this.adapter.transaction(config);
+    const trxId = randomUUID();
+    this.logger.debug("[%s] [%s] transaction begin", this.name, trxId);
+    try {
+      const result = await scope(trx);
+      if (trx.isCompleted()) {
         this.logger.debug(
-          "[%s] [%s] query done: %s",
+          "[%s] [%s] transaction has been finished in scope",
           this.name,
-          trxId,
-          "COMMIT;"
+          trxId
         );
-        trx.emit("commit");
         return result;
-      } catch (error) {
-        await trx.rollback(error);
-        this.logger.debug(
-          "[%s] [%s] query failed: %s",
-          this.name,
-          trxId,
-          "ROLLBACK;"
-        );
-        trx.emit("rollback", error);
-        throw error;
       }
-    }, config);
+      this.logger.debug("[%s] [%s] transaction begin commit", this.name, trxId);
+      await trx.commit();
+      this.logger.debug(
+        "[%s] [%s] transaction committed: %j",
+        this.name,
+        trxId,
+        result
+      );
+      trx.emit("commit");
+      return result;
+    } catch (error) {
+      await trx.rollback(error);
+      this.logger.error(
+        "[%s] [%s] transaction rollback: %s",
+        this.name,
+        trxId,
+        error
+      );
+      trx.emit("rollback", error);
+      throw error;
+    }
   }
   schema() {
     if (!this.adapter)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/knex",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,9 +21,9 @@
     "dist"
   ],
   "dependencies": {
-    "@faasjs/deep_merge": "1.4.1",
-    "@faasjs/func": "1.4.1",
-    "@faasjs/logger": "1.4.1"
+    "@faasjs/deep_merge": "1.5.0",
+    "@faasjs/func": "1.5.0",
+    "@faasjs/logger": "1.5.0"
   },
   "peerDependencies": {
     "knex": "*"