@decaf-ts/transactional-decorators 0.0.4

package/lib/esm/locks/SyncronousLock.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @summary Simple Synchronous Lock implementation
+ * @description for transaction management
+ * adapted from {@link https://www.talkinghightech.com/en/creating-a-js-lock-for-a-resource/}
+ *
+ * @param {number} [counter] the number of simultaneous transactions allowed. defaults to 1
+ * @param {Function} [onBegin] to be called at the start of the transaction
+ * @param {Function} [onEnd] to be called at the conclusion of the transaction
+ *
+ * @class SyncronousLock
+ * @implements TransactionLock
+ *
+ * @category Transactions
+ */ import { Transaction } from "../Transaction";
+import { TransactionLock } from "../interfaces/TransactionLock";
+export declare class SyncronousLock implements TransactionLock {
+    private counter;
+    private pendingTransactions;
+    currentTransaction?: Transaction;
+    private readonly onBegin?;
+    private readonly onEnd?;
+    private readonly lock;
+    constructor(counter?: number, onBegin?: () => Promise<void>, onEnd?: (err?: Error) => Promise<void>);
+    /**
+     * @summary Submits a transaction to be processed
+     * @param {Transaction} transaction
+     */
+    submit(transaction: Transaction): void;
+    /**
+     * @summary Executes a transaction
+     *
+     * @param {Transaction} transaction
+     * @private
+     */
+    private fireTransaction;
+    /**
+     * @summary Releases The lock after the conclusion of a transaction
+     */
+    release(err?: Error): Promise<void>;
+}

package/lib/esm/locks/SyncronousLock.js

@@ -0,0 +1 @@
+import{Lock}from"./Lock";class SyncronousLock{constructor(n=1,e,o){this.currentTransaction=void 0,this.lock=new Lock,this.counter=n,this.pendingTransactions=[],this.onBegin=e,this.onEnd=o}submit(n){let e=this;e.lock.acquire().then(()=>e.currentTransaction&&e.currentTransaction.id===n.id?(e.lock.release(),n.fire()):0<e.counter?(e.counter--,e.lock.release(),e.fireTransaction(n)):(e.pendingTransactions.push(n),void e.lock.release()))}fireTransaction(n){let e=this;e.lock.acquire().then(()=>{e.currentTransaction=n,e.lock.release(),e.onBegin?e.onBegin().then(()=>{n.fire()}):n.fire()})}async release(e){let r=this;return new Promise(o=>{r.lock.acquire().then(()=>{r.currentTransaction||console.warn("Trying to release an unexisting transaction. should never happen..."),r.currentTransaction=void 0,r.lock.release();let n=()=>{r.lock.acquire().then(()=>{if(0<r.pendingTransactions.length){let n=r.pendingTransactions.shift();var e=()=>r.fireTransaction(n);void 0===globalThis.window?globalThis.process.nextTick(e):setTimeout(e,0)}else r.counter++;r.lock.release(),o()})};r.onEnd?r.onEnd(e).then(()=>n()):n()})})}}export{SyncronousLock};

package/lib/esm/locks/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Lock";
+export * from "./SyncronousLock";

package/lib/esm/locks/index.js

@@ -0,0 +1 @@
+export*from"./Lock";export*from"./SyncronousLock";

package/lib/esm/types.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @summary defines a callable as perceived by the lock
+ *
+ * @memberOf module:db-decorators.Transactions
+ */
+export type LockCallable = (value?: void | PromiseLike<void>) => void;
+export type Callback = (err?: Error, result?: any, ...args: any[]) => void;

package/lib/esm/utils.d.ts

@@ -0,0 +1 @@
+export declare function getObjectName(obj: any): string | undefined;

package/lib/esm/utils.js

@@ -0,0 +1 @@
+function getObjectName(t){if(t)return"string"==typeof t?t:t.constructor&&t.constructor.name&&-1===["Function","Object"].indexOf(t.constructor.name)?t.constructor.name:"function"==typeof t&&t.name?t.name:t.toString()}export{getObjectName};

package/lib/index.cjs

@@ -0,0 +1 @@
+var __createBinding=this&&this.__createBinding||(Object.create?function(e,r,t,o){void 0===o&&(o=t);var i=Object.getOwnPropertyDescriptor(r,t);i&&("get"in i?r.__esModule:!i.writable&&!i.configurable)||(i={enumerable:!0,get:function(){return r[t]}}),Object.defineProperty(e,o,i)}:function(e,r,t,o){e[o=void 0===o?t:o]=r[t]}),__exportStar=this&&this.__exportStar||function(e,r){for(var t in e)"default"===t||Object.prototype.hasOwnProperty.call(r,t)||__createBinding(r,e,t)};Object.defineProperty(exports,"__esModule",{value:!0}),exports.VERSION=void 0,__exportStar(require("./interfaces/index.cjs"),exports),__exportStar(require("./locks/index.cjs"),exports),__exportStar(require("./constants.cjs"),exports),__exportStar(require("./decorators.cjs"),exports),__exportStar(require("./Transaction.cjs"),exports),__exportStar(require("./types.cjs"),exports),exports.VERSION="0.0.3";

package/lib/index.d.ts

@@ -0,0 +1,24 @@
+export * from "./interfaces";
+export * from "./locks";
+export * from "./constants";
+export * from "./decorators";
+export * from "./Transaction";
+export * from "./types";
+/**
+ * @summary Module summary
+ * @description Module description
+ * @module ts-workspace
+ */
+/**
+ * @summary Namespace summary
+ * @description Namespace description
+ * @namespace Namespace
+ * @memberOf module:ts-workspace
+ */
+/**
+ * @summary stores the current package version
+ * @description this is how you should document a constant
+ * @const VERSION
+ * @memberOf module:ts-workspace
+ */
+export declare const VERSION = "0.0.3";

package/lib/interfaces/TransactionLock.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports,"__esModule",{value:!0});

package/lib/interfaces/TransactionLock.d.ts

@@ -0,0 +1,26 @@
+import { Transaction } from "../Transaction";
+/**
+ * @summary Transaction lock interface
+ * @interface TransactionLock
+ *
+ * @category Transactions
+ */
+export interface TransactionLock {
+    /**
+     * @summary stores the current transactions
+     * @property currentTransaction
+     */
+    currentTransaction?: Transaction;
+    /**
+     * @summary Submits a transaction to be processed
+     * @param {Transaction} transaction
+     * @method
+     */
+    submit(transaction: Transaction): void;
+    /**
+     * @summary Releases The lock after the conclusion of a transaction
+     * @param {Err} [err] the error (if any) that caused the release
+     * @method
+     */
+    release(err?: Error): Promise<void>;
+}

package/lib/interfaces/index.cjs

@@ -0,0 +1 @@
+var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,i){void 0===i&&(i=r);var n=Object.getOwnPropertyDescriptor(t,r);n&&("get"in n?t.__esModule:!n.writable&&!n.configurable)||(n={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,i,n)}:function(e,t,r,i){e[i=void 0===i?r:i]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./TransactionLock.cjs"),exports);

package/lib/interfaces/index.d.ts

@@ -0,0 +1 @@
+export * from "./TransactionLock";

package/lib/locks/Lock.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports,"__esModule",{value:!0}),exports.Lock=void 0;class Lock{constructor(){this.queue=[],this.locked=!1}async execute(e){await this.acquire();let s;try{s=await Promise.resolve(e())}catch(e){throw this.release(),e}return this.release(),s}async acquire(){let s=this;return s.locked?new Promise(e=>s.queue.push(e)):(s.locked=!0,Promise.resolve())}release(){var e=this.queue.shift();e?void 0===globalThis.window?globalThis.process.nextTick(e):setTimeout(e,0):this.locked=!1}}exports.Lock=Lock;

package/lib/locks/Lock.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @summary Simple Promise based Lock class
+ *
+ * @class Lock
+ * @category Transactions
+ */
+export declare class Lock {
+    private queue;
+    private locked;
+    /**
+     * @summary executes when lock is available
+     * @param {Function} func
+     */
+    execute(func: () => any): Promise<any>;
+    /**
+     * @summary waits to acquire the lock
+     * @param {string} [issuer]
+     */
+    acquire(): Promise<void>;
+    /**
+     * @summary releases the lock
+     */
+    release(): void;
+}

package/lib/locks/SyncronousLock.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports,"__esModule",{value:!0}),exports.SyncronousLock=void 0;let Lock_1=require("./Lock.cjs");class SyncronousLock{constructor(e=1,n,o){this.currentTransaction=void 0,this.lock=new Lock_1.Lock,this.counter=e,this.pendingTransactions=[],this.onBegin=n,this.onEnd=o}submit(e){let n=this;n.lock.acquire().then(()=>n.currentTransaction&&n.currentTransaction.id===e.id?(n.lock.release(),e.fire()):0<n.counter?(n.counter--,n.lock.release(),n.fireTransaction(e)):(n.pendingTransactions.push(e),void n.lock.release()))}fireTransaction(e){let n=this;n.lock.acquire().then(()=>{n.currentTransaction=e,n.lock.release(),n.onBegin?n.onBegin().then(()=>{e.fire()}):e.fire()})}async release(n){let r=this;return new Promise(o=>{r.lock.acquire().then(()=>{r.currentTransaction||console.warn("Trying to release an unexisting transaction. should never happen..."),r.currentTransaction=void 0,r.lock.release();let e=()=>{r.lock.acquire().then(()=>{if(0<r.pendingTransactions.length){let e=r.pendingTransactions.shift();var n=()=>r.fireTransaction(e);void 0===globalThis.window?globalThis.process.nextTick(n):setTimeout(n,0)}else r.counter++;r.lock.release(),o()})};r.onEnd?r.onEnd(n).then(()=>e()):e()})})}}exports.SyncronousLock=SyncronousLock;

package/lib/locks/SyncronousLock.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @summary Simple Synchronous Lock implementation
+ * @description for transaction management
+ * adapted from {@link https://www.talkinghightech.com/en/creating-a-js-lock-for-a-resource/}
+ *
+ * @param {number} [counter] the number of simultaneous transactions allowed. defaults to 1
+ * @param {Function} [onBegin] to be called at the start of the transaction
+ * @param {Function} [onEnd] to be called at the conclusion of the transaction
+ *
+ * @class SyncronousLock
+ * @implements TransactionLock
+ *
+ * @category Transactions
+ */ import { Transaction } from "../Transaction";
+import { TransactionLock } from "../interfaces/TransactionLock";
+export declare class SyncronousLock implements TransactionLock {
+    private counter;
+    private pendingTransactions;
+    currentTransaction?: Transaction;
+    private readonly onBegin?;
+    private readonly onEnd?;
+    private readonly lock;
+    constructor(counter?: number, onBegin?: () => Promise<void>, onEnd?: (err?: Error) => Promise<void>);
+    /**
+     * @summary Submits a transaction to be processed
+     * @param {Transaction} transaction
+     */
+    submit(transaction: Transaction): void;
+    /**
+     * @summary Executes a transaction
+     *
+     * @param {Transaction} transaction
+     * @private
+     */
+    private fireTransaction;
+    /**
+     * @summary Releases The lock after the conclusion of a transaction
+     */
+    release(err?: Error): Promise<void>;
+}

package/lib/locks/index.cjs

@@ -0,0 +1 @@
+var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,o){void 0===o&&(o=r);var i=Object.getOwnPropertyDescriptor(t,r);i&&("get"in i?t.__esModule:!i.writable&&!i.configurable)||(i={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,o,i)}:function(e,t,r,o){e[o=void 0===o?r:o]=t[r]}),__exportStar=this&&this.__exportStar||function(e,t){for(var r in e)"default"===r||Object.prototype.hasOwnProperty.call(t,r)||__createBinding(t,e,r)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./Lock.cjs"),exports),__exportStar(require("./SyncronousLock.cjs"),exports);

package/lib/locks/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Lock";
+export * from "./SyncronousLock";

package/lib/types.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports,"__esModule",{value:!0});

package/lib/types.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @summary defines a callable as perceived by the lock
+ *
+ * @memberOf module:db-decorators.Transactions
+ */
+export type LockCallable = (value?: void | PromiseLike<void>) => void;
+export type Callback = (err?: Error, result?: any, ...args: any[]) => void;

package/lib/utils.cjs

@@ -0,0 +1 @@
+function getObjectName(e){if(e)return"string"==typeof e?e:e.constructor&&e.constructor.name&&-1===["Function","Object"].indexOf(e.constructor.name)?e.constructor.name:"function"==typeof e&&e.name?e.name:e.toString()}Object.defineProperty(exports,"__esModule",{value:!0}),exports.getObjectName=getObjectName;

package/lib/utils.d.ts

@@ -0,0 +1 @@
+export declare function getObjectName(obj: any): string | undefined;

package/package.json

@@ -0,0 +1,107 @@
+{
+  "name": "@decaf-ts/transactional-decorators",
+  "version": "0.0.4",
+  "description": "template for ts projects",
+  "type": "module",
+  "exports": {
+    "require": "./lib/index.cjs",
+    "import": "./lib/esm/index.js"
+  },
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "do-install": "TOKEN=$(cat .token) npm install",
+    "flash-forward": "npx npm-check-updates -u && npm run do-install",
+    "reset": "rm -rf * && git checkout . && git pull && npm run do-install",
+    "build": "rimraf ./lib && rimraf ./dist && gulp dev",
+    "build:prod": "rimraf ./lib && rimraf ./dist && gulp prod",
+    "test": "jest --coverage --testPathPattern=\"/tests/unit\" --passWithNoTests --detectOpenHandles",
+    "test:integration": "jest --coverage --testPathPattern=\"/tests/(integration)\" --passWithNoTests --detectOpenHandles",
+    "test:all": "jest --coverage --testPathPattern=\"/tests/(unit|integration)\" --passWithNoTests --detectOpenHandles",
+    "lint": "eslint .",
+    "lint-fix": "eslint --fix ./src/*",
+    "test:circular": "dpdm -T --no-warning --no-tree ./src/index.ts",
+    "prepare-release": "npm run lint-fix && npm run build:prod && npm run docs",
+    "release": "./bin/tag-release.sh",
+    "clean-publish": "npx clean-publish",
+    "coverage": "npm run test:all && jest-coverage-badges --input \"./workdocs/coverage/coverage-summary.json\" --output \"./workdocs/badges\"",
+    "drawings": "for FILE in workdocs/drawings/*.drawio; do echo \"converting $FILE to image...\" && docker run --rm -v $(pwd):/data rlespinasse/drawio-export --format png $FILE; done && cp -rf workdocs/drawings/export/* workdocs/resources/",
+    "uml": "cd workdocs/uml && for FILE in ./*.puml; do docker run --rm -v $(pwd):/work -w /work miy4/plantuml -DPLANTUML_LIMIT_SIZE=8192 -tpng $FILE; done && cd ../.. && cp -fr workdocs/uml/*.png workdocs/resources/",
+    "docs": "npx rimraf ./docs && mkdir docs && npm run do-install -- better-docs taffydb && gulp docs; npm remove better-docs taffydb"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/decaf-ts/ts-workspace.git"
+  },
+  "engines": {
+    "node": ">=20.0.0",
+    "npm": ">=10.0.0"
+  },
+  "files": [
+    "lib",
+    "dist"
+  ],
+  "keywords": [
+    "plantuml",
+    "mermaid",
+    "uml",
+    "drawio",
+    "mddocs",
+    "md",
+    "jsdoc",
+    "doc",
+    "docs",
+    "documentation",
+    "ci/cd",
+    "ci",
+    "cd",
+    "template",
+    "typescript",
+    "ts"
+  ],
+  "author": "Tiago Venceslau",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/decaf-ts/ts-workspace/issues"
+  },
+  "homepage": "https://github.com/decaf-ts/ts-workspace#readme",
+  "devDependencies": {
+    "@decaf-ts/db-decorators": "latest",
+    "@decaf-ts/decorator-validation": "latest",
+    "@decaf-ts/injectable-decorators": "latest",
+    "@types/jest": "^29.5.12",
+    "@typescript-eslint/eslint-plugin": "^7.1.1",
+    "clean-publish": "^4.3.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "gulp": "^4.0.2",
+    "gulp-if": "^3.0.0",
+    "gulp-rename": "^2.0.0",
+    "gulp-replace": "^1.1.4",
+    "gulp-run-command": "^0.0.10",
+    "gulp-sourcemaps": "^3.0.0",
+    "gulp-typescript": "^6.0.0-alpha.1",
+    "gulp-uglify": "^3.0.2",
+    "jest": "^29.7.0",
+    "jest-coverage-badges": "^1.1.2",
+    "jest-junit": "^16.0.0",
+    "jsdoc": "^4.0.2",
+    "jsdoc-mermaid": "^1.0.0",
+    "markdown-include": "^0.4.3",
+    "merge-stream": "^2.0.0",
+    "nodemon": "^3.1.0",
+    "npm-check-updates": "^16.14.15",
+    "prettier": "^3.2.5",
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.1.2",
+    "ts-loader": "^9.5.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.2",
+    "vinyl-named": "^1.1.0",
+    "webpack-stream": "^7.0.0"
+  },
+  "peerDependencies": {
+    "@decaf-ts/reflection": "latest",
+    "reflect-metadata": "^0.2.1"
+  }
+}