@decaf-ts/transactional-decorators 0.1.2 → 0.1.4

package/LICENSE.md

@@ -1,157 +1,22 @@
-# GNU LESSER GENERAL PUBLIC LICENSE
+MIT License
 
-Version 3, 29 June 2007
+Copyright (c) 2025 Tiago Venceslau and Contributors
 
-Copyright (C) 2025 Tiago Venceslau
-<https:/github.com/TiagoVenceslau>
+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:
 
-Everyone is permitted to copy and distribute verbatim copies of this
-license document, but changing it is not allowed.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-This version of the GNU Lesser General Public License incorporates the
-terms and conditions of version 3 of the GNU General Public License,
-supplemented by the additional permissions listed below.
+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.
 
-## 0. Additional Definitions.
-
-As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the
-GNU General Public License.
-
-"The Library" refers to a covered work governed by this License, other
-than an Application or a Combined Work as defined below.
-
-An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
-
-A "Combined Work" is a work produced by combining or linking an
-Application with the Library. The particular version of the Library
-with which the Combined Work was made is also called the "Linked
-Version".
-
-The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
-
-The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
-
-## 1. Exception to Section 3 of the GNU GPL.
-
-You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
-
-## 2. Conveying Modified Versions.
-
-If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
-
--   a) under this License, provided that you make a good faith effort
-    to ensure that, in the event an Application does not supply the
-    function or data, the facility still operates, and performs
-    whatever part of its purpose remains meaningful, or
--   b) under the GNU GPL, with none of the additional permissions of
-    this License applicable to that copy.
-
-## 3. Object Code Incorporating Material from Library Header Files.
-
-The object code form of an Application may incorporate material from a
-header file that is part of the Library. You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
-
--   a) Give prominent notice with each copy of the object code that
-    the Library is used in it and that the Library and its use are
-    covered by this License.
--   b) Accompany the object code with a copy of the GNU GPL and this
-    license document.
-
-## 4. Combined Works.
-
-You may convey a Combined Work under terms of your choice that, taken
-together, effectively do not restrict modification of the portions of
-the Library contained in the Combined Work and reverse engineering for
-debugging such modifications, if you also do each of the following:
-
--   a) Give prominent notice with each copy of the Combined Work that
-    the Library is used in it and that the Library and its use are
-    covered by this License.
--   b) Accompany the Combined Work with a copy of the GNU GPL and this
-    license document.
--   c) For a Combined Work that displays copyright notices during
-    execution, include the copyright notice for the Library among
-    these notices, as well as a reference directing the user to the
-    copies of the GNU GPL and this license document.
--   d) Do one of the following:
-    -   0) Convey the Minimal Corresponding Source under the terms of
-           this License, and the Corresponding Application Code in a form
-           suitable for, and under terms that permit, the user to
-           recombine or relink the Application with a modified version of
-           the Linked Version to produce a modified Combined Work, in the
-           manner specified by section 6 of the GNU GPL for conveying
-           Corresponding Source.
-    -   1) Use a suitable shared library mechanism for linking with
-           the Library. A suitable mechanism is one that (a) uses at run
-           time a copy of the Library already present on the user's
-           computer system, and (b) will operate properly with a modified
-           version of the Library that is interface-compatible with the
-           Linked Version.
--   e) Provide Installation Information, but only if you would
-    otherwise be required to provide such information under section 6
-    of the GNU GPL, and only to the extent that such information is
-    necessary to install and execute a modified version of the
-    Combined Work produced by recombining or relinking the Application
-    with a modified version of the Linked Version. (If you use option
-    4d0, the Installation Information must accompany the Minimal
-    Corresponding Source and Corresponding Application Code. If you
-    use option 4d1, you must provide the Installation Information in
-    the manner specified by section 6 of the GNU GPL for conveying
-    Corresponding Source.)
-
-## 5. Combined Libraries.
-
-You may place library facilities that are a work based on the Library
-side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
-
--   a) Accompany the combined library with a copy of the same work
-    based on the Library, uncombined with any other library
-    facilities, conveyed under the terms of this License.
--   b) Give prominent notice with the combined library that part of it
-    is a work based on the Library, and explaining where to find the
-    accompanying uncombined form of the same work.
-
-## 6. Revised Versions of the GNU Lesser General Public License.
-
-The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser General Public License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Library
-as you received it specifies that a certain numbered version of the
-GNU Lesser General Public License "or any later version" applies to
-it, you have the option of following the terms and conditions either
-of that published version or of any later version published by the
-Free Software Foundation. If the Library as you received it does not
-specify a version number of the GNU Lesser General Public License, you
-may choose any version of the GNU Lesser General Public License ever
-published by the Free Software Foundation.
-
-If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.

package/README.md

@@ -1,9 +1,8 @@
-![Banner](./workdocs/assets/Banner.png)
+![Banner](./workdocs/assets/decaf-logo.svg)
 
 ## Transactional Decorators
 
-Simple locking and transaction systems
-
+A comprehensive TypeScript library providing transaction management capabilities through decorators, locks, and utilities. This library enables atomic operations, concurrency control, and error handling in your TypeScript applications, ensuring data integrity and thread safety.
 
 
 ![Licence](https://img.shields.io/github/license/decaf-ts/transactional-decorators.svg?style=plastic)
@@ -20,12 +19,6 @@ Simple locking and transaction systems
 ![Pull Requests](https://img.shields.io/github/issues-pr-closed/decaf-ts/transactional-decorators.svg)
 ![Maintained](https://img.shields.io/badge/Maintained%3F-yes-green.svg)
 
-![Line Coverage](workdocs/reports/coverage/badge-lines.svg)
-![Function Coverage](workdocs/reports/coverage/badge-functions.svg)
-![Statement Coverage](workdocs/reports/coverage/badge-statements.svg)
-![Branch Coverage](workdocs/reports/coverage/badge-branches.svg)
-
-
 ![Forks](https://img.shields.io/github/forks/decaf-ts/transactional-decorators.svg)
 ![Stars](https://img.shields.io/github/stars/decaf-ts/transactional-decorators.svg)
 ![Watchers](https://img.shields.io/github/watchers/decaf-ts/transactional-decorators.svg)
@@ -37,19 +30,251 @@ Documentation available [here](https://decaf-ts.github.io/transactional-decorato
 
 ### Description
 
-Standalone module, exposes a simple implementation to handle concurrency:
-- Simple yet powerful locking;
-- decorate methods as `@transactional()` for control;
-- decorate classes as `@Transactional()`, enabling Instance proxying and keeping transactions across different classes/method calls (grouping several calls in a sing transaction)l
-- Customizable Transaction Lock;
-- Seamless integration with `db-decorators`;
+The Transactional Decorators library is a standalone module that provides a robust implementation for handling concurrency and transaction management in TypeScript applications. It offers a comprehensive set of tools for ensuring data integrity and thread safety in your code.
+
+#### Core Components
+
+- **Transaction Class**: The central class that manages the lifecycle of transactions, including creation, execution, and cleanup. It provides mechanisms for binding transactions to objects and methods, ensuring proper transaction context propagation.
+
+- **Lock System**: A flexible locking mechanism for controlling access to shared resources:
+  - `Lock`: A base class providing fundamental locking capabilities with support for queuing and executing functions when the lock is available.
+  - `TransactionLock`: An interface defining the contract for transaction lock implementations that manage transaction execution order and concurrency.
+  - `SyncronousLock`: A default implementation of TransactionLock that processes transactions one at a time in the order they are submitted.
+
+- **Decorators**:
+  - `@transactional()`: A method decorator that enables transactional behavior by wrapping the original method in a transaction context that handles transaction creation, binding, and error handling.
+  - `transactionalSuperCall()`: A utility function for handling super calls in transactional methods, ensuring transaction continuity through the inheritance chain.
+
+#### Key Features
+
+- **Simple yet powerful locking**: The library provides a flexible locking system that can be customized to suit your application's needs.
+- **Method decoration with `@transactional()`**: Easily add transactional behavior to your methods with a simple decorator.
+- **Instance proxying**: The Transaction class can bind to objects, creating proxies that maintain transaction context across method calls.
+- **Transaction chaining**: Transactions can be linked together, allowing you to group multiple operations into a single atomic transaction.
+- **Customizable Transaction Lock**: You can implement your own TransactionLock to customize how transactions are processed.
+- **Error handling**: The library includes built-in error handling to ensure transactions are properly released even when errors occur.
+- **Seamless integration with `db-decorators`**: The library works well with the db-decorators package for database operations.
+
+This library is ideal for applications that need to ensure data consistency and handle concurrent operations safely, such as database applications, financial systems, or any application where atomic operations are important.
+
 
 ### How to Use
 
 - [Initial Setup](./tutorials/For%20Developers.md#_initial-setup_)
 - [Installation](./tutorials/For%20Developers.md#installation)
 
-
+#### Using the @transactional Decorator
+
+The `@transactional` decorator is the simplest way to add transactional behavior to your methods.
+
+**Description**: Add transactional behavior to a class method, ensuring that the method executes within a transaction context.
+
+```typescript
+import { transactional } from '@decaf-ts/transactional-decorators';
+
+class UserService {
+  @transactional()
+  async createUser(userData: any): Promise<any> {
+    // This method will be executed within a transaction
+    // If an error occurs, the transaction will be released with the error
+    const user = await this.userRepository.save(userData);
+    return user;
+  }
+
+  @transactional(['custom', 'metadata'])
+  async updateUser(userId: string, userData: any): Promise<any> {
+    // You can pass custom metadata to the transaction
+    const user = await this.userRepository.findById(userId);
+    Object.assign(user, userData);
+    return await this.userRepository.save(user);
+  }
+}
+
+// Using the transactional method
+const userService = new UserService();
+const newUser = await userService.createUser({ name: 'John Doe' });
+```
+
+#### Using the Transaction Class Directly
+
+For more control over the transaction lifecycle, you can use the Transaction class directly.
+
+**Description**: Create and manage transactions manually for complex scenarios or when you need fine-grained control.
+
+```typescript
+import { Transaction } from '@decaf-ts/transactional-decorators';
+
+// Creating a transaction
+const transaction = new Transaction(
+  'UserService', // Source
+  'createUser',  // Method name
+  async () => {
+    // Transaction logic here
+    const user = await userRepository.save({ name: 'John Doe' });
+    return user;
+  }
+);
+
+// Submitting the transaction for execution
+Transaction.submit(transaction);
+
+// Using the Transaction.push method for callback-style APIs
+Transaction.push(
+  userService, // The object instance
+  userService.createUserWithCallback, // The method to call
+  { name: 'John Doe' }, // Arguments
+  (err, user) => {
+    if (err) {
+      console.error('Error creating user:', err);
+      return;
+    }
+    console.log('User created:', user);
+  }
+);
+```
+
+#### Handling Super Calls in Transactional Methods
+
+When extending a class with transactional methods, you can use the `transactionalSuperCall` utility to ensure transaction continuity.
+
+**Description**: Maintain transaction context when calling a superclass method that is also transactional.
+
+```typescript
+import { transactional, transactionalSuperCall } from '@decaf-ts/transactional-decorators';
+
+class BaseRepository {
+  @transactional()
+  async save(entity: any): Promise<any> {
+    // Base save implementation
+    return entity;
+  }
+}
+
+class UserRepository extends BaseRepository {
+  @transactional()
+  async save(user: any): Promise<any> {
+    // Pre-processing
+    user.updatedAt = new Date();
+
+    // Call the super method with transaction context
+    const result = await transactionalSuperCall(super.save.bind(this), user);
+
+    // Post-processing
+    console.log('User saved:', result);
+    return result;
+  }
+}
+```
+
+#### Customizing the Transaction Lock
+
+You can implement your own TransactionLock to customize how transactions are processed.
+
+**Description**: Create a custom transaction lock implementation for specialized concurrency control.
+
+```typescript
+import { TransactionLock, Transaction } from '@decaf-ts/transactional-decorators';
+
+// Custom transaction lock that logs transactions
+class LoggingTransactionLock implements TransactionLock {
+  currentTransaction?: Transaction;
+  private pendingTransactions: Transaction[] = [];
+
+  submit(transaction: Transaction): void {
+    console.log(`Submitting transaction: ${transaction.toString()}`);
+
+    if (this.currentTransaction) {
+      this.pendingTransactions.push(transaction);
+      console.log(`Transaction queued. Queue length: ${this.pendingTransactions.length}`);
+    } else {
+      this.currentTransaction = transaction;
+      console.log(`Executing transaction immediately`);
+      transaction.fire();
+    }
+  }
+
+  async release(err?: Error): Promise<void> {
+    if (err) {
+      console.error(`Transaction error: ${err.message}`);
+    } else {
+      console.log(`Transaction completed successfully`);
+    }
+
+    this.currentTransaction = undefined;
+
+    if (this.pendingTransactions.length > 0) {
+      const nextTransaction = this.pendingTransactions.shift()!;
+      console.log(`Processing next transaction: ${nextTransaction.toString()}`);
+      this.currentTransaction = nextTransaction;
+      nextTransaction.fire();
+    }
+
+    return Promise.resolve();
+  }
+}
+
+// Set the custom lock as the default
+Transaction.setLock(new LoggingTransactionLock());
+```
+
+#### Using the Lock Class
+
+The Lock class provides a basic locking mechanism that you can use independently of the transaction system.
+
+**Description**: Use the Lock class for simple concurrency control in non-transactional contexts.
+
+```typescript
+import { Lock } from '@decaf-ts/transactional-decorators';
+
+// Create a lock for a shared resource
+const resourceLock = new Lock();
+
+// Execute a function with exclusive access to the resource
+async function accessSharedResource() {
+  const result = await resourceLock.execute(async () => {
+    // This code will run with exclusive access to the resource
+    const data = await fetchDataFromDatabase();
+    const processedData = processData(data);
+    await saveDataToDatabase(processedData);
+    return processedData;
+  });
+
+  return result;
+}
+
+// Alternatively, you can manually acquire and release the lock
+async function manualLockHandling() {
+  await resourceLock.acquire();
+  try {
+    // Critical section with exclusive access
+    const data = await fetchDataFromDatabase();
+    const processedData = processData(data);
+    await saveDataToDatabase(processedData);
+    return processedData;
+  } finally {
+    // Always release the lock, even if an error occurs
+    resourceLock.release();
+  }
+}
+```
+
+
+## Coding Principles
+
+- group similar functionality in folders (analog to namespaces but without any namespace declaration)
+- one class per file;
+- one interface per file (unless interface is just used as a type);
+- group types as other interfaces in a types.ts file per folder;
+- group constants or enums in a constants.ts file per folder;
+- group decorators in a decorators.ts file per folder;
+- always import from the specific file, never from a folder or index file (exceptions for dependencies on other packages);
+- prefer the usage of established design patters where applicable:
+  - Singleton (can be an anti-pattern. use with care);
+  - factory;
+  - observer;
+  - strategy;
+  - builder;
+  - etc;
 
 
 ### Related
@@ -94,4 +319,4 @@ So if you can, if this project in any way. either by learning something or simpl
 
 This project is released under the [MIT License](./LICENSE.md).
 
-By developers, for developers...
+By developers, for developers...