@stone-js/service-container 0.0.41

package/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                    http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+  "License" shall mean the terms and conditions for use, reproduction,
+  and distribution as defined by Sections 1 through 9 of this document.
+
+  "Licensor" shall mean the copyright owner or entity authorized by
+  the copyright owner that is granting the License.
+
+  "Legal Entity" shall mean the union of the acting entity and all
+  other entities that control, are controlled by, or are under common
+  control with that entity. For the purposes of this definition,
+  "control" means (i) the power, direct or indirect, to cause the
+  direction or management of such entity, whether by contract or
+  otherwise, or (ii) ownership of fifty percent (50%) or more of the
+  outstanding shares, or (iii) beneficial ownership of such entity.
+
+  "You" (or "Your") shall mean an individual or Legal Entity
+  exercising permissions granted by this License.
+
+  "Source" form shall mean the preferred form for making modifications,
+  including but not limited to software source code, documentation
+  source, and configuration files.
+
+  "Object" form shall mean any form resulting from mechanical
+  transformation or translation of a Source form, including but
+  not limited to compiled object code, generated documentation,
+  and conversions to other media types.
+
+  "Work" shall mean the work of authorship, whether in Source or
+  Object form, made available under the License, as indicated by a
+  copyright notice that is included in or attached to the work
+  (an example is provided in the Appendix below).
+
+  "Derivative Works" shall mean any work, whether in Source or Object
+  form, that is based on (or derived from) the Work and for which the
+  editorial revisions, annotations, elaborations, or other modifications
+  represent, as a whole, an original work of authorship. For the purposes
+  of this License, Derivative Works shall not include works that remain
+  separable from, or merely link (or bind by name) to the interfaces of,
+  the Work and Derivative Works thereof.
+
+  "Contribution" shall mean any work of authorship, including
+  the original version of the Work and any modifications or additions
+  to that Work or Derivative Works thereof, that is intentionally
+  submitted to Licensor for inclusion in the Work by the copyright owner
+  or by an individual or Legal Entity authorized to submit on behalf of
+  the copyright owner. For the purposes of this definition, "submitted"
+  means any form of electronic, verbal, or written communication sent
+  to the Licensor or its representatives, including but not limited to
+  communication on electronic mailing lists, source code control systems,
+  and issue tracking systems that are managed by, or on behalf of, the
+  Licensor for the purpose of discussing and improving the Work, but
+  excluding communication that is conspicuously marked or otherwise
+  designated in writing by the copyright owner as "Not a Contribution."
+
+  "Contributor" shall mean Licensor and any individual or Legal Entity
+  on behalf of whom a Contribution has been received by Licensor and
+  subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  copyright license to reproduce, prepare Derivative Works of,
+  publicly display, publicly perform, sublicense, and distribute the
+  Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  (except as stated in this section) patent license to make, have made,
+  use, offer to sell, sell, import, and otherwise transfer the Work,
+  where such license applies only to those patent claims licensable
+  by such Contributor that are necessarily infringed by their
+  Contribution(s) alone or by combination of their Contribution(s)
+  with the Work to which such Contribution(s) was submitted. If You
+  institute patent litigation against any entity (including a
+  cross-claim or counterclaim in a lawsuit) alleging that the Work
+  or a Contribution incorporated within the Work constitutes direct
+  or contributory patent infringement, then any patent licenses
+  granted to You under this License for that Work shall terminate
+  as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+  Work or Derivative Works thereof in any medium, with or without
+  modifications, and in Source or Object form, provided that You
+  meet the following conditions:
+
+  (a) You must give any other recipients of the Work or
+      Derivative Works a copy of this License; and
+
+  (b) You must cause any modified files to carry prominent notices
+      stating that You changed the files; and
+
+  (c) You must retain, in the Source form of any Derivative Works
+      that You distribute, all copyright, patent, trademark, and
+      attribution notices from the Source form of the Work,
+      excluding those notices that do not pertain to any part of
+      the Derivative Works; and
+
+  (d) If the Work includes a "NOTICE" text file as part of its
+      distribution, then any Derivative Works that You distribute must
+      include a readable copy of the attribution notices contained
+      within such NOTICE file, excluding those notices that do not
+      pertain to any part of the Derivative Works, in at least one
+      of the following places: within a NOTICE text file distributed
+      as part of the Derivative Works; within the Source form or
+      documentation, if provided along with the Derivative Works; or,
+      within a display generated by the Derivative Works, if and
+      wherever such third-party notices normally appear. The contents
+      of the NOTICE file are for informational purposes only and
+      do not modify the License. You may add Your own attribution
+      notices within Derivative Works that You distribute, alongside
+      or as an addendum to the NOTICE text from the Work, provided
+      that such additional attribution notices cannot be construed
+      as modifying the License.
+
+  You may add Your own copyright statement to Your modifications and
+  may provide additional or different license terms and conditions
+  for use, reproduction, or distribution of Your modifications, or
+  for any such Derivative Works as a whole, provided Your use,
+  reproduction, and distribution of the Work otherwise complies with
+  the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+  any Contribution intentionally submitted for inclusion in the Work
+  by You to the Licensor shall be under the terms and conditions of
+  this License, without any additional terms or conditions.
+  Notwithstanding the above, nothing herein shall supersede or modify
+  the terms of any separate license agreement you may have executed
+  with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+  names, trademarks, service marks, or product names of the Licensor,
+  except as required for reasonable and customary use in describing the
+  origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+  agreed to in writing, Licensor provides the Work (and each
+  Contributor provides its Contributions) on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+  implied, including, without limitation, any warranties or conditions
+  of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+  PARTICULAR PURPOSE. You are solely responsible for determining the
+  appropriateness of using or redistributing the Work and assume any
+  risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+  whether in tort (including negligence), contract, or otherwise,
+  unless required by applicable law (such as deliberate and grossly
+  negligent acts) or agreed to in writing, shall any Contributor be
+  liable to You for damages, including any direct, indirect, special,
+  incidental, or consequential damages of any character arising as a
+  result of this License or out of the use or inability to use the
+  Work (including but not limited to damages for loss of goodwill,
+  work stoppage, computer failure or malfunction, or any and all
+  other commercial damages or losses), even if such Contributor
+  has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+  the Work or Derivative Works thereof, You may choose to offer,
+  and charge a fee for, acceptance of support, warranty, indemnity,
+  or other liability obligations and/or rights consistent with this
+  License. However, in accepting such obligations, You may act only
+  on Your own behalf and on Your sole responsibility, not on behalf
+  of any other Contributor, and only if You agree to indemnify,
+  defend, and hold each Contributor harmless for any liability
+  incurred by, or claims asserted against, such Contributor by reason
+  of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+  To apply the Apache License to your work, attach the following
+  boilerplate notice, with the fields enclosed by brackets "[]"
+  replaced with your own identifying information. (Don't include
+  the brackets!)  The text should be enclosed in the appropriate
+  comment syntax for the file format. We also recommend that a
+  file or class name and description of purpose be included on the
+  same "printed page" as the copyright notice for easier
+  identification within third-party archives.
+
+Copyright [2024] [Stone.js]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,340 @@
+# Stone.js: Service Container
+
+[![npm](https://img.shields.io/npm/l/@stone-js/service-container)](https://opensource.org/licenses/Apache-2.0)
+[![npm](https://img.shields.io/npm/v/@stone-js/service-container)](https://www.npmjs.com/package/@stone-js/service-container)
+[![npm](https://img.shields.io/npm/dm/@stone-js/service-container)](https://www.npmjs.com/package/@stone-js/service-container)
+![Maintenance](https://img.shields.io/maintenance/yes/2024)
+[![Publish Package to npmjs](https://github.com/stonemjs/service-container/actions/workflows/release.yml/badge.svg)](https://github.com/stonemjs/service-container/actions/workflows/release.yml)
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
+
+IoC Service Container with proposal decorator, proxy resolver and destructuring injection provides a very simple, centralized container that stores and resolves libraries, objects, and values to better organize code, manage dependencies, and enhance testability.
+
+---
+
+## Synopsis
+
+The **Service Container** is an advanced JavaScript/TypeScript library that helps you manage dependencies effectively in your applications. It utilizes the Inversion of Control (IoC) pattern to simplify dependency injection, allowing you to create highly decoupled and maintainable codebases.
+
+By using Dependency Injection (DI), the service container ensures that objects are provided with their dependencies from an external source, rather than creating them internally. This approach improves testability, minimizes code duplication, and promotes the Single Responsibility Principle by allowing objects to focus only on their primary functions.
+
+In addition to DI, the **Service Container** implements the Proxy pattern, which lets you access dependencies as properties of the container itself. This feature, combined with destructuring, enables a streamlined approach to dependency injection, making it easy to use dependencies without the need for extra boilerplate code.
+
+With the **Service Container**, you can easily register, resolve, and manage dependencies, making it suitable for projects of any scale. It supports binding instances, singletons, and factories, as well as providing auto and conditional binding options. This flexibility makes your application more modular, scalable, and maintainable, while ensuring efficient dependency management throughout the development process.
+
+## Installation
+
+To install the `Service container` utility, you need to add it to your project. Assuming it’s part of a package you manage.
+
+NPM:
+
+```bash
+npm i @stone-js/service-container
+```
+
+Yarn:
+
+```bash
+yarn add @stone-js/service-container
+```
+
+PNPM:
+
+```bash
+pnpm add @stone-js/service-container
+```
+
+The `Container` module can only be imported via ESM import syntax:
+
+```typescript
+import { Container } from '@stone-js/service-container';
+```
+
+## Getting Started
+
+To get started with the `Service Container`, you need to import the `Container` class and create an instance of it. This instance will act as the central registry for all your dependencies in your application.
+
+Let's begin with a simple example to discover the power of the service container by logging a message.
+
+### 1. Create the `Logger` Class
+
+First, create a simple `Logger` class to log messages:
+
+```typescript
+// Your Logger class
+class Logger {
+  log(message: string) {
+    console.log(message);
+  }
+}
+```
+
+### 2. Create the Class that Provides the Message
+
+Next, create a class `A` that provides a message to be logged:
+
+```typescript
+// Your class A
+class A {
+  getMessage(): string {
+    return 'Hello World!';
+  }
+}
+```
+
+### 3. Create the Class that Logs the Message Using the Logger
+
+Now, create a class `B` that depends on `Logger` and `A` to log the message:
+
+```typescript
+import { Binding } from '@stone-js/service-container';
+
+// Your class B
+class B {
+  private readonly a: A;
+  private readonly logger: Logger;
+
+  constructor({ a, logger }: Binding<A | Logger>) { // Dependency injection by destructuring
+    this.a = a as A;
+    this.logger = logger as Logger;
+  }
+
+  logMessage() {
+    this.logger.log(this.a.getMessage());
+  }
+}
+```
+
+### 4. Use the Container to Manage Dependencies
+
+Finally, create an instance of the `Container` class and use it to manage these dependencies:
+
+```typescript
+import { Container } from '@stone-js/service-container';
+
+// Create a container instance
+const container = new Container();
+
+// Auto-register components
+container
+  .autoBinding(A)
+  .autoBinding(B)
+  .autoBinding(Logger)
+  .alias(A, 'a')
+  .alias(B, 'b')
+  .alias(Logger, 'logger');
+
+// Make B instance
+const b = container.make(B);
+
+// Call logMessage method
+b.logMessage(); // Output: Hello World!
+```
+
+In this guide, we covered how to define and register dependencies using the `Container` class, and how to leverage dependency injection through destructuring and the Proxy pattern.
+
+By following these steps, you can effectively manage dependencies in your applications, making them more modular, testable, and maintainable.
+
+## Usage
+
+The true power of Stone Service Container lies in its ability to simplify and enhance the management of dependencies within your application. By leveraging the Inversion of Control (IoC) and Proxy patterns, the library offers a highly flexible and intuitive way to bind, resolve, and inject dependencies. Whether you're working with simple instances, complex singletons, or dynamic factories, the Service Container provides a robust foundation for building scalable and maintainable applications.
+
+### Binding
+
+You can bind instances, singletons, and factories to the container using various methods provided by the `Container` class.
+
+#### Instance
+
+To bind a single instance or value to the container:
+
+```typescript
+// Bind value
+container.instance('config', { apiUrl: 'https://api.example.com' });
+
+// Bind instance
+container.instance('ApiUrl', new URL('https://api.example.com'));
+```
+
+#### Singleton
+
+To bind a resolver function that returns a singleton instance:
+
+```typescript
+// Bind a singleton using a resolver function
+container.singleton('logger', () => new Logger());
+
+// Resolve the singleton (same instance every time)
+const logger1 = container.make('logger');
+const logger2 = container.make('logger');
+console.log(logger1 === logger2); // Should output: true
+```
+
+#### Factory
+
+To bind a resolver function that returns a new instance each time:
+
+```typescript
+// To bind a resolver function that returns a new instance each time
+container.binding('userService', () => new UserService());
+```
+
+### Auto Binding
+
+The `autoBinding` method in the service container simplifies the process of binding dependencies by ensuring they are only bound if not already present in the container. This method can be used implicitly or explicitly, providing flexibility in how dependencies are registered and resolved.
+
+#### Implicit Auto Binding
+
+Implicit auto binding allows you to automatically register and bind a class to the container using the class's own name. This approach simplifies dependency management by using the class name as the key for resolution.
+
+```typescript
+// Auto binding Logger
+container.autoBinding(Logger);
+
+// Resolve Logger (it will be registered implicitly if not found)
+const logger = container.make('Logger'); // Prefer to use a string key for clarity.
+```
+
+#### Explicit Auto Binding
+
+Explicit auto binding allows you to register and bind a class to the container with a specified key, as a singleton or factory, and with optional aliases. This method offers greater flexibility in naming and accessing dependencies.
+
+```typescript
+// Auto binding Logger with specified key and aliases
+container.autoBinding('logger', Logger, true, ['logging', 'log']);
+
+// Resolve Logger using different aliases
+const logger = container.make('logger');
+const loggerByAlias = container.make('logging');
+```
+
+### Conditional Binding
+
+You can bind instances, singletons, and factories to the container conditionally using various methods provided by the `Container` class.
+
+#### Instance
+
+To bind a single instance or value to the container, if it is not already bound:
+
+```typescript
+// Bind value conditionally
+container.instanceIf('config', { apiUrl: 'https://api.example.com' });
+
+// Bind instance conditionally
+container.instanceIf('ApiUrl', new URL('https://api.example.com'));
+```
+
+#### Singleton
+
+To bind a resolver function that returns a singleton instance, if it is not already bound:
+
+```typescript
+container.singletonIf('logger', () => new Logger());
+```
+
+#### Factory
+
+To bind a resolver function that returns a new instance each time, if it is not already bound:
+
+```typescript
+container.bindingIf('userService', () => new UserService());
+```
+
+### Resolving Dependencies
+
+You can resolve dependencies from the container using the `make` method:
+
+```typescript
+const config = container.make('config');
+const logger = container.make('logger');
+const userService = container.make('userService');
+```
+
+### On-Demand Resolving
+
+This method provides a convenient way to resolve a value from the container by its key and return it wrapped in a factory function. This approach is useful when you need to create multiple instances of a dependency on demand.
+
+```typescript
+// Get the logger factory function
+const loggerFactory = container.factory('logger');
+
+// Resolve logger on demand
+const logger = loggerFactory();
+```
+
+### Conditional Resolving
+
+This method checks if the dependency is already bound in the container. If it is, the dependency is resolved. If not, the method binds the dependency and then resolves it. This ensures that dependencies are always available when needed, without redundant bindings.
+
+```typescript
+// Assuming Logger is a class that we want to ensure is bound and resolved
+container.resolve('Logger', true);
+
+// Resolve the logger instance
+const logger = container.make('Logger');
+```
+
+### Using Aliases
+
+Aliases allow you to reference bindings by alternative names.
+
+#### Setting Aliases
+
+To set an alias for a binding:
+
+```typescript
+// Set an alias for Logger
+container.alias(Logger, ['logger', 'logging', 'log']);
+```
+
+#### Retrieving Aliases
+
+To retrieve a binding by its alias:
+
+```typescript
+const logger = container.make('logging');
+```
+
+### Checking Bindings
+
+You can check if a binding or alias exists in the container:
+
+```typescript
+// With bound method
+const hasLogger = container.bound(Logger); // true
+
+// Can be used with alias
+const hasLoggerAlias = container.bound('logging'); // true
+
+// An alias of bound method
+const hasLoggerAliasUsingHas = container.has(Logger); // true
+
+// Check if this alias exists
+const isAlias = container.isAlias('logging'); // true
+```
+
+### Clearing the Container
+
+To remove all bindings and reset the container:
+
+```typescript
+// Clear all bindings and aliases
+container.clear();
+```
+
+With this library, managing dependencies in your application becomes much simpler and more efficient. By adhering to the principles of Inversion of Control and Dependency Injection, you can create more modular, testable, and maintainable code.
+
+
+## Summary
+
+The Stone Service Container simplifies dependency management in your applications, making them more modular, testable, and maintainable. It provides tools for binding instances, singletons, and factories, as well as auto and conditional binding. By leveraging Inversion of Control and dependency injection, the service container ensures efficient, flexible, and scalable management of dependencies, fitting projects of any size.
+
+## API documentation
+
+- [API](https://github.com/stonemjs/service-container/blob/main/docs/modules.md)
+
+## Contributing
+
+See [Contributing Guide](https://github.com/stonemjs/service-container/blob/main/CONTRIBUTING.md).
+
+## Credits
+- [Laravel Service Container](https://github.com/illuminate/container)
+- [Halligan JS: Service Container](https://github.com/halliganjs/service-container)