@stone-js/service-container 0.1.3 → 0.8.1

package/dist/models/Binding.d.ts

@@ -0,0 +1,48 @@
+import { BindingValue, IContainer, IBinding } from '../declarations';
+/**
+ * Abstract class representing a Binding.
+ *
+ * This abstract class serves as the base class for all types of bindings in the service container. It holds a value and provides an abstract method
+ * to resolve and return that value, allowing different subclasses to implement their own resolution logic. Bindings are used to manage dependencies
+ * and control how objects are instantiated within the container.
+ *
+ * @template V - The type of value that this binding holds.
+ * @author Mr. Stone <evensstone@gmail.com>
+ */
+export declare abstract class Binding<V extends BindingValue> implements IBinding<V> {
+    /**
+     * The value held by the binding.
+     *
+     * This value is resolved at runtime, either directly or through a resolver function.
+     */
+    protected value?: V;
+    /**
+     * Whether the value has been resolved at least once.
+     *
+     * Tracked explicitly (not inferred from `value !== undefined`) so a binding whose resolved
+     * value is legitimately `undefined` is still considered resolved — preserving the singleton
+     * guarantee and avoiding repeated resolver side effects.
+     */
+    protected resolved: boolean;
+    /**
+     * Create a new instance of Binding.
+     *
+     * @param value - The value to be held by the binding.
+     */
+    constructor(value?: V);
+    /**
+     * Check if the value has been resolved.
+     *
+     * @returns A boolean indicating whether the value has been resolved.
+     */
+    protected isResolved(): boolean;
+    /**
+     * Resolve and return the value of the binding.
+     *
+     * This abstract method must be implemented by subclasses to provide specific resolution logic.
+     *
+     * @param container - The container to resolve dependencies from.
+     * @returns The resolved value of the binding.
+     */
+    abstract resolve(container: IContainer): V | undefined;
+}

package/dist/models/Factory.d.ts

@@ -0,0 +1,24 @@
+import { ResolverBinding } from './ResolverBinding';
+import { BindingValue, IContainer } from '../declarations';
+/**
+ * Class representing a Factory.
+ *
+ * The Factory class extends the ResolverBinding class, providing a mechanism to resolve a new instance each time the binding is resolved.
+ * This ensures that a fresh instance is created with each call to the `resolve` method.
+ *
+ * @template V - The type of value that this binding holds.
+ * @author Mr. Stone <evensstone@gmail.com>
+ */
+export declare class Factory<V extends BindingValue> extends ResolverBinding<V> {
+    /**
+     * Resolve and return the value of the binding.
+     *
+     * Each time this method is called, a new value is resolved using the resolver function.
+     * This is intended for cases where a fresh instance is required for each resolution, such as factories or transient dependencies.
+     *
+     * @param container - The container to resolve dependencies from.
+     * @returns The resolved value of the binding.
+     * @throws ContainerError if the value cannot be resolved.
+     */
+    resolve(container: IContainer): V;
+}

package/dist/models/Instance.d.ts

@@ -0,0 +1,20 @@
+import { Binding } from './Binding';
+import { BindingValue, IContainer } from '../declarations';
+/**
+ * Class representing an Instance.
+ *
+ * This class extends the Binding class and directly holds an instance value.
+ * It provides a straightforward resolution mechanism that simply returns the stored value.
+ *
+ * @template V - The type of value that this binding holds.
+ * @author Mr. Stone <evensstone@gmail.com>
+ */
+export declare class Instance<V extends BindingValue> extends Binding<V> {
+    /**
+     * Resolve and return the value of the binding.
+     *
+     * @param _container - Container to resolve dependencies (not used in this implementation).
+     * @returns The resolved value of the binding.
+     */
+    resolve(_container: IContainer): V | undefined;
+}

package/dist/models/ResolverBinding.d.ts

@@ -0,0 +1,26 @@
+import { Binding } from './Binding';
+import { BindingValue, Resolver } from '../declarations';
+/**
+ * Class representing a ResolverBinding.
+ *
+ * This class extends the Binding class, using a resolver function to lazily resolve the value when needed.
+ *
+ * @template V - The type of value that this binding holds.
+ * @author Mr. Stone <evensstone@gmail.com>
+ */
+export declare abstract class ResolverBinding<V extends BindingValue> extends Binding<V> {
+    /**
+     * The resolver function used to provide the binding value.
+     *
+     * This function will be called when the value is needed, allowing for lazy instantiation
+     * and dependency resolution. It should return an instance of type `V`.
+     */
+    protected readonly resolver: Resolver<V>;
+    /**
+     * Create a new instance of ResolverBinding.
+     *
+     * @param resolver - The resolver function to provide the binding value.
+     * @throws ContainerError if the resolver is not a function.
+     */
+    constructor(resolver: Resolver<V>);
+}

package/dist/models/Singleton.d.ts

@@ -0,0 +1,24 @@
+import { ResolverBinding } from './ResolverBinding';
+import { BindingValue, IContainer } from '../declarations';
+/**
+ * Class representing a Singleton.
+ *
+ * The Singleton class extends the ResolverBinding class, ensuring that the value is only resolved once.
+ * Subsequent calls to the `resolve` method will return the previously resolved value, making it behave as a singleton.
+ *
+ * @template V - The type of value that this binding holds.
+ * @author Mr. Stone <evensstone@gmail.com>
+ */
+export declare class Singleton<V extends BindingValue> extends ResolverBinding<V> {
+    /**
+     * Resolve and return the value of the binding.
+     *
+     * If the value has already been resolved, return the cached value. Otherwise, use the resolver function
+     * to resolve the value, store it, and return it.
+     *
+     * @param container - The container to resolve dependencies from.
+     * @returns The resolved value of the binding.
+     * @throws ContainerError if the value cannot be resolved.
+     */
+    resolve(container: IContainer): V | undefined;
+}

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@stone-js/service-container",
-  "version": "0.1.3",
+  "version": "0.8.1",
   "description": "Javascript/Typescript IoC Service Container with proxy resolver and destructuring injection",
   "author": "Mr. Stone <evensstone@gmail.com>",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+ssh://git@github.com/stone-foundation/stone-js-service-container.git"
+    "url": "git+https://github.com/stone-foundation/stone-js-framework.git",
+    "directory": "stone-js-service-container"
   },
   "homepage": "https://stonejs.dev",
   "bugs": {
-    "url": "https://github.com/stone-foundation/stone-js-service-container/issues"
+    "url": "https://github.com/stone-foundation/stone-js-framework/issues"
   },
   "keywords": [
     "DI",
@@ -38,20 +39,6 @@
   "engines": {
     "node": ">=18.17.0"
   },
-  "scripts": {
-    "lint": "ts-standard src",
-    "lint:fix": "ts-standard --fix src tests",
-    "predoc": "rimraf docs",
-    "doc": "typedoc",
-    "prebuild": "rimraf dist && npm run doc",
-    "build": "rollup -c",
-    "test": "vitest run",
-    "test:cvg": "npm run test -- --coverage",
-    "test:text": "npm run test:cvg -- --coverage.reporter=text",
-    "test:html": "npm run test:cvg -- --coverage.reporter=html",
-    "test:clover": "npm run test:cvg -- --coverage.reporter=clover",
-    "prepare": "husky"
-  },
   "devDependencies": {
     "@commitlint/cli": "^19.8.1",
     "@commitlint/config-conventional": "^19.8.1",
@@ -64,8 +51,6 @@
     "husky": "^9.1.7",
     "rimraf": "^6.0.1",
     "rollup": "^4.44.1",
-    "rollup-plugin-delete": "^3.0.1",
-    "rollup-plugin-dts": "^6.2.1",
     "rollup-plugin-node-externals": "^8.0.1",
     "ts-standard": "^12.0.2",
     "tslib": "^2.8.1",
@@ -82,5 +67,19 @@
       "describe",
       "beforeEach"
     ]
+  },
+  "sideEffects": false,
+  "scripts": {
+    "lint": "ts-standard src",
+    "lint:fix": "ts-standard --fix src tests",
+    "predoc": "rimraf docs",
+    "doc": "typedoc",
+    "clean": "rimraf dist",
+    "build": "rollup -c",
+    "test": "vitest run",
+    "test:cvg": "npm run test -- --coverage",
+    "test:text": "npm run test:cvg -- --coverage.reporter=text",
+    "test:html": "npm run test:cvg -- --coverage.reporter=html",
+    "test:clover": "npm run test:cvg -- --coverage.reporter=clover"
   }
-}
+}