@decaf-ts/injectable-decorators 1.6.0 → 1.6.2

package/LICENSE.md

@@ -1,157 +1,21 @@
-# GNU LESSER GENERAL PUBLIC LICENSE
-
-Version 3, 29 June 2007
-
-Copyright (C) 2025 Tiago Venceslau
-<https:/github.com/TiagoVenceslau>
-
-Everyone is permitted to copy and distribute verbatim copies of this
-license document, but changing it is not allowed.
-
-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.
-
-## 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.
+# MIT License
+
+Copyright (c) 2025 Tiago Venceslau
+
+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

@@ -1,7 +1,8 @@
 ![Banner](./workdocs/assets/Banner.png)
 ## Simple Injectables engine
 
-Simple implementation of injectables
+A lightweight TypeScript dependency injection library that provides decorators for marking classes as injectable singletons and injecting dependencies into class properties. It features a centralized registry for managing dependencies, lazy loading of injected properties, and support for custom transformations of injected instances.
+
 
 ![Licence](https://img.shields.io/github/license/decaf-ts/injectable-decorators.svg?style=plastic)
 ![GitHub language count](https://img.shields.io/github/languages/count/decaf-ts/injectable-decorators?style=plastic)
@@ -34,14 +35,283 @@ Documentation available [here](https://decaf-ts.github.io/injectable-decorators/
 
 ### Description
 
-Simple implementation of a Typescript decorator based injectable system.
+The `injectable-decorators` library is a standalone module that provides a lightweight and flexible dependency injection system for TypeScript applications. It is designed to simplify the management of dependencies between components in your application through the use of TypeScript decorators.
+
+#### Core Components
+
+1. **Injectables Registry**
+   - The central component that manages all injectable objects
+   - Maintains a cache of singleton instances
+   - Provides methods for registering, retrieving, and building injectable objects
+   - Can be customized with a different implementation if needed
+
+2. **Decorators**
+   - `@injectable()`: Class decorator that marks a class as available for dependency injection
+     - Transforms the class into a singleton that can be retrieved from the registry
+     - Supports optional category naming for minification safety
+     - Allows for custom callbacks after instance creation
+   - `@inject()`: Property decorator that injects a dependency into a class property
+     - Automatically resolves the dependency type from TypeScript's type system
+     - Supports custom transformers to modify the injected instance
+     - Implements lazy loading - dependencies are only instantiated when accessed
+
+3. **Reflection Utilities**
+   - Uses TypeScript's reflection metadata to determine property types
+   - Provides utilities for working with type information in decorators
+
+#### Key Features
+
+- **Singleton Management**: Injectables are typically managed as singletons, ensuring consistent state across your application.
+- **Lazy Loading**: Dependencies are only instantiated when they are actually accessed, simplifying the injection order and improving performance.
+- **Type Safety**: Leverages TypeScript's type system to ensure type safety in injected dependencies.
+- **Minification Support**: Provides options to specify explicit names for injectables to handle minification scenarios.
+- **Custom Transformations**: Supports transforming injectable instances before they're injected into target objects.
+- **Selective Reset**: Ability to selectively reset specific injectables in the registry based on name patterns.
+
+#### Design Philosophy
+
+The library follows a minimalist approach, focusing on providing essential dependency injection capabilities without unnecessary complexity. It's designed to be:
+
+- **Lightweight**: Small footprint with minimal dependencies
+- **Flexible**: Adaptable to different application architectures
+- **Intuitive**: Simple API that follows natural TypeScript patterns
+- **Non-intrusive**: Minimal impact on your existing code structure
+
+Unlike more complex DI frameworks, this library doesn't require extensive configuration or setup. The developer is responsible for initially decorating classes and properties, but the library handles the instantiation and injection process automatically.
+
 
 ### How to Use
 
 - [Initial Setup](./tutorials/For%20Developers.md#_initial-setup_)
 - [Installation](./tutorials/For%20Developers.md#installation)
 
+## Basic Usage Examples
+
+### Creating an Injectable Service
+
+**Use Case**: You want to create a service that can be injected into other components of your application.
+
+```typescript
+import { injectable } from 'injectable-decorators';
+
+@injectable()
+class LoggerService {
+  log(message: string): void {
+    console.log(`[LOG]: ${message}`);
+  }
+
+  error(message: string): void {
+    console.error(`[ERROR]: ${message}`);
+  }
+}
+
+// The service is automatically registered in the Injectables registry
+// and will be available for injection
+```
+
+### Injecting a Service into a Component
+
+**Use Case**: You want to use a service in a component without manually creating an instance.
+
+```typescript
+import { inject } from 'injectable-decorators';
+import { LoggerService } from './logger.service';
+
+class UserComponent {
+  @inject()
+  private logger!: LoggerService;
+
+  createUser(username: string): void {
+    this.logger.log(`Creating user: ${username}`);
+    // User creation logic...
+    this.logger.log(`User ${username} created successfully`);
+  }
+}
+
+// When the logger property is accessed, the LoggerService instance
+// will be automatically injected
+```
+
+### Using a Custom Category Name
+
+**Use Case**: You want to ensure your injectables work correctly even after code minification, or you want to use a different name for the injectable.
+
+```typescript
+import { injectable } from 'injectable-decorators';
+
+@injectable('AuthService')
+class AuthenticationService {
+  authenticate(username: string, password: string): boolean {
+    // Authentication logic...
+    return true;
+  }
+}
+
+class LoginComponent {
+  @inject('AuthService')
+  private auth!: AuthenticationService;
+
+  login(username: string, password: string): void {
+    if (this.auth.authenticate(username, password)) {
+      console.log('Login successful');
+    } else {
+      console.log('Login failed');
+    }
+  }
+}
+```
+
+### Using a Transformer with Inject
+
+**Use Case**: You want to transform or configure an injectable instance before it's used.
+
+```typescript
+import { inject, InstanceTransformer } from 'injectable-decorators';
+
+@injectable()
+class ConfigService {
+  private config: Record<string, any> = {
+    apiUrl: 'https://api.example.com',
+    timeout: 5000
+  };
+
+  get(key: string): any {
+    return this.config[key];
+  }
+}
+
+// Transformer function that adds environment-specific configuration
+const configTransformer: InstanceTransformer = (config: ConfigService, target: any) => {
+  // You could customize the config based on the target or environment
+  return config;
+};
+
+class ApiClient {
+  @inject(undefined, configTransformer)
+  private config!: ConfigService;
+
+  fetchData(): Promise<any> {
+    const apiUrl = this.config.get('apiUrl');
+    const timeout = this.config.get('timeout');
+
+    // Use the configured values...
+    return Promise.resolve({ data: 'example' });
+  }
+}
+```
+
+### Manually Registering and Retrieving Injectables
+
+**Use Case**: You want to manually register an existing instance or retrieve an injectable instance directly.
+
+```typescript
+import { Injectables } from 'injectable-decorators';
+
+// Register an existing instance
+const databaseConnection = {
+  query: (sql: string) => Promise.resolve([]),
+  close: () => Promise.resolve()
+};
+
+Injectables.register(databaseConnection, 'DatabaseConnection');
+
+// Retrieve the instance elsewhere in your code
+class QueryService {
+  private db = Injectables.get<typeof databaseConnection>('DatabaseConnection');
+
+  async executeQuery(sql: string): Promise<any[]> {
+    if (!this.db) {
+      throw new Error('Database connection not available');
+    }
+    return this.db.query(sql);
+  }
+}
+```
+
+### Creating a Custom Injectable Registry
+
+**Use Case**: You want to customize how injectables are stored and retrieved, perhaps for testing or to add additional functionality.
+
+```typescript
+import { Injectables, InjectablesRegistry } from 'injectable-decorators';
+
+// Create a custom registry implementation
+class LoggingRegistry implements InjectablesRegistry {
+  private defaultRegistry: InjectablesRegistry;
+
+  constructor(defaultRegistry: InjectablesRegistry) {
+    this.defaultRegistry = defaultRegistry;
+  }
+
+  get<T>(name: string, ...args: any[]): T | undefined {
+    console.log(`Getting injectable: ${name}`);
+    return this.defaultRegistry.get<T>(name, ...args);
+  }
+
+  register<T>(constructor: any, ...args: any[]): void {
+    console.log(`Registering injectable: ${args[0] || constructor.name}`);
+    return this.defaultRegistry.register(constructor, ...args);
+  }
+
+  build<T>(obj: Record<string, any>, ...args: any[]): T {
+    console.log(`Building injectable: ${obj.name}`);
+    return this.defaultRegistry.build<T>(obj, ...args);
+  }
+}
+
+// Use the custom registry
+import { InjectableRegistryImp } from 'injectable-decorators';
+const customRegistry = new LoggingRegistry(new InjectableRegistryImp());
+Injectables.setRegistry(customRegistry);
+```
+
+### Resetting the Registry
+
+**Use Case**: You want to clear all registered injectables, perhaps for testing or when switching application contexts.
+
+```typescript
+import { Injectables } from 'injectable-decorators';
+
+// Reset all injectables
+Injectables.reset();
+
+// Selectively reset injectables matching a pattern
+Injectables.selectiveReset(/^Auth/); // Resets all injectables whose names start with "Auth"
+```
+
+### Using Callback with Injectable
+
+**Use Case**: You want to perform additional setup on an injectable instance after it's created.
+
+```typescript
+import { injectable } from 'injectable-decorators';
+
+const setupLogger = (instance: LoggerService) => {
+  // Configure the logger after instantiation
+  instance.setLogLevel('debug');
+  instance.enableConsoleOutput(true);
+};
+
+@injectable(undefined, false, setupLogger)
+class LoggerService {
+  private logLevel: string = 'info';
+  private consoleOutput: boolean = false;
+
+  setLogLevel(level: string): void {
+    this.logLevel = level;
+  }
 
+  enableConsoleOutput(enabled: boolean): void {
+    this.consoleOutput = enabled;
+  }
+
+  log(message: string): void {
+    if (this.consoleOutput) {
+      console.log(`[${this.logLevel.toUpperCase()}]: ${message}`);
+    }
+  }
+}
+```
 
 
 ### Related