@eggjs/tegg-transaction-decorator 3.11.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-present Alibaba Group Holding Limited and other contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+# @eggjs/tegg-transaction-decorator
+
+事务注解
+
+## Usage
+```ts
+export class Foo {
+
+  @Transactional({ propagation: PropagationType.ALWAYS_NEW })
+  async bar() {
+    await this.foo();
+  }
+
+  @Transactional({ propagation: PropagationType.REQUIRED })
+  async foo(msg) {
+    console.log('has msg: ', msg);
+  }
+
+}
+
+```
+
+Foo.bar 始终会在一个独立的事务中执行，而 Foo.foo 会在 Foo.bar 的事务中执行

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './src/decorator/Transactional';
+export * from './src/Common';
+export * from './src/model/TransactionMetadata';
+export * from './src/builder/TransactionMetaBuilder';
+export * from './src/util/TransactionMetadataUtil';

package/dist/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/decorator/Transactional"), exports);
+__exportStar(require("./src/Common"), exports);
+__exportStar(require("./src/model/TransactionMetadata"), exports);
+__exportStar(require("./src/builder/TransactionMetaBuilder"), exports);
+__exportStar(require("./src/util/TransactionMetadataUtil"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsZ0VBQThDO0FBQzlDLCtDQUE2QjtBQUM3QixrRUFBZ0Q7QUFDaEQsdUVBQXFEO0FBQ3JELHFFQUFtRCJ9

package/dist/src/Common.d.ts

@@ -0,0 +1,10 @@
+export declare enum PropagationType {
+    /** 不管是当前调用栈是否存在事务，始终让当前函数在新的事务中执行 */
+    ALWAYS_NEW = "ALWAYS_NEW",
+    /** 如果当前调用栈存在事务则复用，否则创建一个 */
+    REQUIRED = "REQUIRED"
+}
+export interface TransactionalParams {
+    /** 事务传播方式，默认 REQUIRED */
+    propagation?: PropagationType;
+}

package/dist/src/Common.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropagationType = void 0;
+var PropagationType;
+(function (PropagationType) {
+    /** 不管是当前调用栈是否存在事务，始终让当前函数在新的事务中执行 */
+    PropagationType["ALWAYS_NEW"] = "ALWAYS_NEW";
+    /** 如果当前调用栈存在事务则复用，否则创建一个 */
+    PropagationType["REQUIRED"] = "REQUIRED";
+})(PropagationType || (exports.PropagationType = PropagationType = {}));
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ29tbW9uLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL0NvbW1vbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSxJQUFZLGVBS1g7QUFMRCxXQUFZLGVBQWU7SUFDekIscUNBQXFDO0lBQ3JDLDRDQUF5QixDQUFBO0lBQ3pCLDRCQUE0QjtJQUM1Qix3Q0FBcUIsQ0FBQTtBQUN2QixDQUFDLEVBTFcsZUFBZSwrQkFBZixlQUFlLFFBSzFCIn0=

package/dist/src/builder/TransactionMetaBuilder.d.ts

@@ -0,0 +1,7 @@
+import { EggProtoImplClass } from '@eggjs/tegg';
+import { TransactionMetadata } from '../model/TransactionMetadata';
+export declare class TransactionMetaBuilder {
+    private readonly clazz;
+    constructor(clazz: EggProtoImplClass);
+    build(): TransactionMetadata[];
+}

package/dist/src/builder/TransactionMetaBuilder.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionMetaBuilder = void 0;
+const TransactionMetadataUtil_1 = require("../util/TransactionMetadataUtil");
+class TransactionMetaBuilder {
+    constructor(clazz) {
+        this.clazz = clazz;
+    }
+    build() {
+        if (!TransactionMetadataUtil_1.TransactionMetadataUtil.isTransactionClazz(this.clazz)) {
+            return [];
+        }
+        return TransactionMetadataUtil_1.TransactionMetadataUtil.getTransactionMetadataList(this.clazz);
+    }
+}
+exports.TransactionMetaBuilder = TransactionMetaBuilder;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVHJhbnNhY3Rpb25NZXRhQnVpbGRlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9idWlsZGVyL1RyYW5zYWN0aW9uTWV0YUJ1aWxkZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBRUEsNkVBQTBFO0FBRTFFLE1BQWEsc0JBQXNCO0lBR2pDLFlBQVksS0FBd0I7UUFDbEMsSUFBSSxDQUFDLEtBQUssR0FBRyxLQUFLLENBQUM7SUFDckIsQ0FBQztJQUVELEtBQUs7UUFDSCxJQUFJLENBQUMsaURBQXVCLENBQUMsa0JBQWtCLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxFQUFFO1lBQzNELE9BQU8sRUFBRSxDQUFDO1NBQ1g7UUFDRCxPQUFPLGlEQUF1QixDQUFDLDBCQUEwQixDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsQ0FBQztJQUN4RSxDQUFDO0NBQ0Y7QUFiRCx3REFhQyJ9

package/dist/src/decorator/Transactional.d.ts

@@ -0,0 +1,2 @@
+import { TransactionalParams } from '../Common';
+export declare function Transactional(params?: TransactionalParams): (target: any, propertyKey: PropertyKey) => void;

package/dist/src/decorator/Transactional.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Transactional = void 0;
+const Common_1 = require("../Common");
+const TransactionMetadataUtil_1 = require("../util/TransactionMetadataUtil");
+function Transactional(params) {
+    const propagation = (params === null || params === void 0 ? void 0 : params.propagation) || Common_1.PropagationType.REQUIRED;
+    if (!Object.values(Common_1.PropagationType).includes(propagation)) {
+        throw new Error(`unknown propagation type ${propagation}`);
+    }
+    return function (target, propertyKey) {
+        const constructor = target.constructor;
+        TransactionMetadataUtil_1.TransactionMetadataUtil.setIsTransactionClazz(constructor);
+        TransactionMetadataUtil_1.TransactionMetadataUtil.addTransactionMetadata(constructor, {
+            propagation,
+            method: propertyKey,
+        });
+    };
+}
+exports.Transactional = Transactional;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVHJhbnNhY3Rpb25hbC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9kZWNvcmF0b3IvVHJhbnNhY3Rpb25hbC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFDQSxzQ0FBaUU7QUFDakUsNkVBQTBFO0FBRTFFLFNBQWdCLGFBQWEsQ0FBQyxNQUE0QjtJQUN4RCxNQUFNLFdBQVcsR0FBRyxDQUFBLE1BQU0sYUFBTixNQUFNLHVCQUFOLE1BQU0sQ0FBRSxXQUFXLEtBQUksd0JBQWUsQ0FBQyxRQUFRLENBQUM7SUFDcEUsSUFBSSxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsd0JBQWUsQ0FBQyxDQUFDLFFBQVEsQ0FBQyxXQUFXLENBQUMsRUFBRTtRQUN6RCxNQUFNLElBQUksS0FBSyxDQUFDLDRCQUE0QixXQUFXLEVBQUUsQ0FBQyxDQUFDO0tBQzVEO0lBRUQsT0FBTyxVQUFTLE1BQVcsRUFBRSxXQUF3QjtRQUNuRCxNQUFNLFdBQVcsR0FBc0IsTUFBTSxDQUFDLFdBQVcsQ0FBQztRQUMxRCxpREFBdUIsQ0FBQyxxQkFBcUIsQ0FBQyxXQUFXLENBQUMsQ0FBQztRQUMzRCxpREFBdUIsQ0FBQyxzQkFBc0IsQ0FBQyxXQUFXLEVBQUU7WUFDMUQsV0FBVztZQUNYLE1BQU0sRUFBRSxXQUFXO1NBQ3BCLENBQUMsQ0FBQztJQUNMLENBQUMsQ0FBQztBQUNKLENBQUM7QUFkRCxzQ0FjQyJ9

package/dist/src/model/TransactionMetadata.d.ts

@@ -0,0 +1,5 @@
+import { PropagationType } from '../Common';
+export interface TransactionMetadata {
+    propagation: PropagationType;
+    method: PropertyKey;
+}

package/dist/src/model/TransactionMetadata.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVHJhbnNhY3Rpb25NZXRhZGF0YS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9tb2RlbC9UcmFuc2FjdGlvbk1ldGFkYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==

package/dist/src/util/TransactionMetadataUtil.d.ts

@@ -0,0 +1,10 @@
+import { EggProtoImplClass } from '@eggjs/tegg';
+import { TransactionMetadata } from '../model/TransactionMetadata';
+export declare const TRANSACTION_META_DATA: unique symbol;
+export declare const IS_TRANSACTION_CLAZZ: unique symbol;
+export declare class TransactionMetadataUtil {
+    static setIsTransactionClazz(clazz: EggProtoImplClass): void;
+    static isTransactionClazz(clazz: EggProtoImplClass): boolean;
+    static addTransactionMetadata(clazz: EggProtoImplClass, data: TransactionMetadata): void;
+    static getTransactionMetadataList(clazz: EggProtoImplClass): TransactionMetadata[];
+}

package/dist/src/util/TransactionMetadataUtil.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionMetadataUtil = exports.IS_TRANSACTION_CLAZZ = exports.TRANSACTION_META_DATA = void 0;
+const tegg_1 = require("@eggjs/tegg");
+exports.TRANSACTION_META_DATA = Symbol.for('EggPrototype#transaction#metaData');
+exports.IS_TRANSACTION_CLAZZ = Symbol.for('EggPrototype#IS_TRANSACTION_CLAZZ');
+class TransactionMetadataUtil {
+    static setIsTransactionClazz(clazz) {
+        tegg_1.MetadataUtil.defineMetaData(exports.IS_TRANSACTION_CLAZZ, true, clazz);
+    }
+    static isTransactionClazz(clazz) {
+        return tegg_1.MetadataUtil.getBooleanMetaData(exports.IS_TRANSACTION_CLAZZ, clazz);
+    }
+    static addTransactionMetadata(clazz, data) {
+        const list = tegg_1.MetadataUtil.initOwnArrayMetaData(exports.TRANSACTION_META_DATA, clazz, []);
+        list.push(data);
+    }
+    static getTransactionMetadataList(clazz) {
+        return tegg_1.MetadataUtil.getArrayMetaData(exports.TRANSACTION_META_DATA, clazz);
+    }
+}
+exports.TransactionMetadataUtil = TransactionMetadataUtil;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiVHJhbnNhY3Rpb25NZXRhZGF0YVV0aWwuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdXRpbC9UcmFuc2FjdGlvbk1ldGFkYXRhVXRpbC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSxzQ0FBOEQ7QUFHakQsUUFBQSxxQkFBcUIsR0FBRyxNQUFNLENBQUMsR0FBRyxDQUFDLG1DQUFtQyxDQUFDLENBQUM7QUFDeEUsUUFBQSxvQkFBb0IsR0FBRyxNQUFNLENBQUMsR0FBRyxDQUFDLG1DQUFtQyxDQUFDLENBQUM7QUFFcEYsTUFBYSx1QkFBdUI7SUFFbEMsTUFBTSxDQUFDLHFCQUFxQixDQUFDLEtBQXdCO1FBQ25ELG1CQUFZLENBQUMsY0FBYyxDQUFDLDRCQUFvQixFQUFFLElBQUksRUFBRSxLQUFLLENBQUMsQ0FBQztJQUNqRSxDQUFDO0lBRUQsTUFBTSxDQUFDLGtCQUFrQixDQUFDLEtBQXdCO1FBQ2hELE9BQU8sbUJBQVksQ0FBQyxrQkFBa0IsQ0FBQyw0QkFBb0IsRUFBRSxLQUFLLENBQUMsQ0FBQztJQUN0RSxDQUFDO0lBRUQsTUFBTSxDQUFDLHNCQUFzQixDQUFDLEtBQXdCLEVBQUUsSUFBeUI7UUFDL0UsTUFBTSxJQUFJLEdBQUcsbUJBQVksQ0FBQyxvQkFBb0IsQ0FBc0IsNkJBQXFCLEVBQUUsS0FBSyxFQUFFLEVBQUUsQ0FBQyxDQUFDO1FBQ3RHLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDbEIsQ0FBQztJQUVELE1BQU0sQ0FBQywwQkFBMEIsQ0FBQyxLQUF3QjtRQUN4RCxPQUFPLG1CQUFZLENBQUMsZ0JBQWdCLENBQXNCLDZCQUFxQixFQUFFLEtBQUssQ0FBQyxDQUFDO0lBQzFGLENBQUM7Q0FFRjtBQW5CRCwwREFtQkMifQ==

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@eggjs/tegg-transaction-decorator",
+  "version": "3.11.0",
+  "description": "tegg transaction decorator",
+  "keywords": [
+    "egg",
+    "typescript",
+    "decorator",
+    "transaction",
+    "tegg"
+  ],
+  "author": "qile222 <chhxxc@gmail.com>",
+  "homepage": "https://github.com/eggjs/tegg",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:eggjs/tegg.git",
+    "directory": "core/transaction-decorator"
+  },
+  "dependencies": {
+    "@eggjs/core-decorator": "^3.11.0",
+    "@eggjs/tegg-common-util": "^3.11.0",
+    "@eggjs/tegg-metadata": "^3.11.0"
+  },
+  "scripts": {
+    "test": "cross-env NODE_ENV=test NODE_OPTIONS='--no-deprecation' mocha",
+    "clean": "tsc -b --clean",
+    "tsc": "npm run clean && tsc -p ./tsconfig.json",
+    "tsc:pub": "npm run clean && tsc -p ./tsconfig.pub.json",
+    "prepublishOnly": "npm run tsc:pub"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "license": "MIT",
+  "main": "dist/index.js",
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts"
+  ],
+  "bugs": {
+    "url": "https://github.com/eggjs/tegg/issues"
+  },
+  "devDependencies": {
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^20.2.4",
+    "cross-env": "^7.0.3",
+    "mocha": "^10.2.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.4"
+  },
+  "gitHead": "f636d88eff9bb9d4567808e91229182d36ef03c6"
+}