@vercube/di 0.0.1-beta.7 → 0.0.2-beta.0

package/dist/Types/IOCTypes.d.ts

@@ -13,7 +13,7 @@ export declare namespace IOC {
 		enum ServiceFactoryType {
 		CLASS = "CLASS",
 		CLASS_SINGLETON = "CLASS_SINGLETON",
-		INSTANCE = "INSTANCE",
+		INSTANCE = "INSTANCE"
 	}
 	interface Newable<T> {
 		new (...args: unknown[]): T;
@@ -30,7 +30,7 @@ export declare namespace IOC {
 	}
 		enum InjectMethod {
 		LAZY = "LAZY",
-		STATIC = "STATIC",
+		STATIC = "STATIC"
 	}
 	type Identity = symbol;
 	interface ServiceMap {
@@ -43,6 +43,6 @@ export declare namespace IOC {
 	type Stack = (ServiceKey | Instance)[];
 		enum DependencyType {
 		STANDARD = 0,
-		OPTIONAL = 1,
+		OPTIONAL = 1
 	}
 }

package/dist/index.cjs

@@ -1,6 +1,10 @@
 "use strict";
 
 //#region packages/di/src/Common/BaseDecorators.ts
+/**
+* This is base class for all property decorators used in application. Decorator class must extend this one.
+* This class instance is created using IOC container so you can @Inject() things here.
+*/
 var BaseDecorator = class {
 	/** Holds options object that is passed as 2nd argument in createDecorator() factory */
 	options;
@@ -156,6 +160,11 @@ const IOCEngine = {
 
 //#endregion
 //#region packages/di/src/Decorators/Inject.ts
+/**
+* Injects a dependency with particular key to service.
+* @param key key to inject
+* @returns decorator
+*/
 function Inject(key) {
 	return (target, propertyName) => {
 		IOCEngine.registerInject(target, propertyName, key, IOC.DependencyType.STANDARD);
@@ -164,6 +173,11 @@ function Inject(key) {
 
 //#endregion
 //#region packages/di/src/Decorators/InjectOptional.ts
+/**
+* Injects a dependency with particular key to service.
+* @param key key to inject
+* @returns decorator
+*/
 function InjectOptional(key) {
 	return (target, propertyName) => {
 		IOCEngine.registerInject(target, propertyName, key, IOC.DependencyType.OPTIONAL);
@@ -172,6 +186,10 @@ function InjectOptional(key) {
 
 //#endregion
 //#region packages/di/src/Decorators/Init.ts
+/**
+* This decorator fires the decorated function as soon as decorators are injected. You
+* can use this for initialization logic in runtime-loaded container deps.
+*/
 var InitDecorator = class extends BaseDecorator {
 	/**
 	* Called when decorator is initialized.
@@ -180,12 +198,22 @@ var InitDecorator = class extends BaseDecorator {
 		if (typeof this.instance[this.propertyName] === "function") this.instance[this.propertyName]();
 	}
 };
+/**
+* Decorator that automatically executes the decorated method when dependencies are injected.
+* Use this decorator to run initialization logic for runtime-loaded container dependencies.
+* @returns {Function} Decorator function that creates an InitDecorator instance
+*/
 function Init() {
 	return createDecorator(InitDecorator, {});
 }
 
 //#endregion
 //#region packages/di/src/Decorators/Destroy.ts
+/**
+* Decorator that handles cleanup tasks when a service or component is destroyed.
+* This decorator class extends BaseDecorator and executes the decorated method
+* during the destruction phase.
+*/
 var DestroyDecorator = class extends BaseDecorator {
 	/**
 	* Called when decorator is destroyed. Executes the decorated method if it exists
@@ -196,12 +224,31 @@ var DestroyDecorator = class extends BaseDecorator {
 		if (typeof this.instance[this.propertyName] === "function") this.instance[this.propertyName]();
 	}
 };
+/**
+* Decorator that automatically executes the decorated method when the service or component
+* is destroyed. Use this decorator to run cleanup logic like unregistering event listeners
+* or clearing timers.
+* 
+* @example
+* ```typescript
+* class MyService {
+*   @Destroy()
+*   cleanup() {
+*     // Cleanup logic here
+*   }
+* }
+* ```
+* @returns {Function} Decorator function that creates a DestroyDecorator instance
+*/
 function Destroy() {
 	return createDecorator(DestroyDecorator, {});
 }
 
 //#endregion
 //#region packages/di/src/Domain/ContainerEvents.ts
+/**
+* This class allows for container to listen on various IOC events.
+*/
 var ContainerEvents = class {
 	fOnExpanded = [];
 	/**
@@ -222,9 +269,24 @@ var ContainerEvents = class {
 
 //#endregion
 //#region packages/di/src/Utils/Utils.ts
+/**
+* This function generates new service key for particular service. Providing
+* name is mandatory because, unlike classes, those unique symbols do not infer
+* their names from code.
+*
+* @param name name of the service
+* @returns unique service identity
+*/
 function Identity(name) {
 	return Symbol(name);
 }
+/**
+* This function creates ES6 decorator based on class that was passed in argument.
+*
+* @param decoratorClass class of decorator that will be used
+* @param params custom options object that will be availalbe in "options" property of decorator class
+* @return ES6 decorator function
+*/
 function createDecorator(decoratorClass, params) {
 	return function internalDecorator(target, propertyName, descriptor) {
 		if (!target.__decorators) target.__decorators = [];
@@ -252,6 +314,12 @@ function getContainerMetadata(container) {
 	if (!containerMap.has(container)) containerMap.set(container, { decoratedInstances: new Map() });
 	return containerMap.get(container);
 }
+/**
+* This function initializes all registered decorators on particular instance. It must be called in order
+* for decorator code work in particular class.
+* @param target class instance to sue
+* @param container IOC container for context
+*/
 function initializeDecorators(target, container) {
 	const prototype = Object.getPrototypeOf(target);
 	if (prototype.__decorators) for (const entry of prototype.__decorators) {
@@ -271,15 +339,32 @@ function initializeDecorators(target, container) {
 		decoratedInstances.set(target, instanceList);
 	}
 }
+/**
+* This function releases all decorators applied to target instance by calling their .destroyed()
+* method. Its used to provide a way for cleanup for decorators. @see BaseDecorator.destroy()
+*
+* @param target instance of class that should have decorators cleaned up
+* @param container ioc container
+*/
 function destroyDecorators(target, container) {
 	const { decoratedInstances } = getContainerMetadata(container);
 	const instanceList = decoratedInstances.get(target);
 	if (instanceList) for (const instance of instanceList) instance.destroyed();
 	decoratedInstances.delete(target);
 }
+/**
+* This function is responsible for preparing IOC container to work with all decorators. It simply
+* initializes all decorators on all services registered.
+* @param container IOC container
+*/
 function initializeContainer(container) {
 	container.flushQueue();
 }
+/**
+* This function is responsible for preparing IOC container to work with all decorators. It simply
+* initializes all decorators on all services registered.
+* @param container IOC container
+*/
 function destroyContainer(container) {
 	container.getAllServices().forEach((service) => destroyDecorators(service, container));
 	containerMap.delete(container);
@@ -287,6 +372,10 @@ function destroyContainer(container) {
 
 //#endregion
 //#region packages/di/src/Domain/Container.ts
+/**
+* This is new implementation of IOC Container. It mimics Inversify.js container a little bit but its
+* simpler and (probably) more performant on larger scales.
+*/
 var Container = class Container {
 	fLocked = false;
 	fDefaultParams = { createLocked: false };

package/dist/index.mjs

@@ -1,5 +1,8 @@
-
 //#region packages/di/src/Common/BaseDecorators.ts
+/**
+* This is base class for all property decorators used in application. Decorator class must extend this one.
+* This class instance is created using IOC container so you can @Inject() things here.
+*/
 var BaseDecorator = class {
 	/** Holds options object that is passed as 2nd argument in createDecorator() factory */
 	options;
@@ -155,6 +158,11 @@ const IOCEngine = {
 
 //#endregion
 //#region packages/di/src/Decorators/Inject.ts
+/**
+* Injects a dependency with particular key to service.
+* @param key key to inject
+* @returns decorator
+*/
 function Inject(key) {
 	return (target, propertyName) => {
 		IOCEngine.registerInject(target, propertyName, key, IOC.DependencyType.STANDARD);
@@ -163,6 +171,11 @@ function Inject(key) {
 
 //#endregion
 //#region packages/di/src/Decorators/InjectOptional.ts
+/**
+* Injects a dependency with particular key to service.
+* @param key key to inject
+* @returns decorator
+*/
 function InjectOptional(key) {
 	return (target, propertyName) => {
 		IOCEngine.registerInject(target, propertyName, key, IOC.DependencyType.OPTIONAL);
@@ -171,6 +184,10 @@ function InjectOptional(key) {
 
 //#endregion
 //#region packages/di/src/Decorators/Init.ts
+/**
+* This decorator fires the decorated function as soon as decorators are injected. You
+* can use this for initialization logic in runtime-loaded container deps.
+*/
 var InitDecorator = class extends BaseDecorator {
 	/**
 	* Called when decorator is initialized.
@@ -179,12 +196,22 @@ var InitDecorator = class extends BaseDecorator {
 		if (typeof this.instance[this.propertyName] === "function") this.instance[this.propertyName]();
 	}
 };
+/**
+* Decorator that automatically executes the decorated method when dependencies are injected.
+* Use this decorator to run initialization logic for runtime-loaded container dependencies.
+* @returns {Function} Decorator function that creates an InitDecorator instance
+*/
 function Init() {
 	return createDecorator(InitDecorator, {});
 }
 
 //#endregion
 //#region packages/di/src/Decorators/Destroy.ts
+/**
+* Decorator that handles cleanup tasks when a service or component is destroyed.
+* This decorator class extends BaseDecorator and executes the decorated method
+* during the destruction phase.
+*/
 var DestroyDecorator = class extends BaseDecorator {
 	/**
 	* Called when decorator is destroyed. Executes the decorated method if it exists
@@ -195,12 +222,31 @@ var DestroyDecorator = class extends BaseDecorator {
 		if (typeof this.instance[this.propertyName] === "function") this.instance[this.propertyName]();
 	}
 };
+/**
+* Decorator that automatically executes the decorated method when the service or component
+* is destroyed. Use this decorator to run cleanup logic like unregistering event listeners
+* or clearing timers.
+* 
+* @example
+* ```typescript
+* class MyService {
+*   @Destroy()
+*   cleanup() {
+*     // Cleanup logic here
+*   }
+* }
+* ```
+* @returns {Function} Decorator function that creates a DestroyDecorator instance
+*/
 function Destroy() {
 	return createDecorator(DestroyDecorator, {});
 }
 
 //#endregion
 //#region packages/di/src/Domain/ContainerEvents.ts
+/**
+* This class allows for container to listen on various IOC events.
+*/
 var ContainerEvents = class {
 	fOnExpanded = [];
 	/**
@@ -221,9 +267,24 @@ var ContainerEvents = class {
 
 //#endregion
 //#region packages/di/src/Utils/Utils.ts
+/**
+* This function generates new service key for particular service. Providing
+* name is mandatory because, unlike classes, those unique symbols do not infer
+* their names from code.
+*
+* @param name name of the service
+* @returns unique service identity
+*/
 function Identity(name) {
 	return Symbol(name);
 }
+/**
+* This function creates ES6 decorator based on class that was passed in argument.
+*
+* @param decoratorClass class of decorator that will be used
+* @param params custom options object that will be availalbe in "options" property of decorator class
+* @return ES6 decorator function
+*/
 function createDecorator(decoratorClass, params) {
 	return function internalDecorator(target, propertyName, descriptor) {
 		if (!target.__decorators) target.__decorators = [];
@@ -251,6 +312,12 @@ function getContainerMetadata(container) {
 	if (!containerMap.has(container)) containerMap.set(container, { decoratedInstances: new Map() });
 	return containerMap.get(container);
 }
+/**
+* This function initializes all registered decorators on particular instance. It must be called in order
+* for decorator code work in particular class.
+* @param target class instance to sue
+* @param container IOC container for context
+*/
 function initializeDecorators(target, container) {
 	const prototype = Object.getPrototypeOf(target);
 	if (prototype.__decorators) for (const entry of prototype.__decorators) {
@@ -270,15 +337,32 @@ function initializeDecorators(target, container) {
 		decoratedInstances.set(target, instanceList);
 	}
 }
+/**
+* This function releases all decorators applied to target instance by calling their .destroyed()
+* method. Its used to provide a way for cleanup for decorators. @see BaseDecorator.destroy()
+*
+* @param target instance of class that should have decorators cleaned up
+* @param container ioc container
+*/
 function destroyDecorators(target, container) {
 	const { decoratedInstances } = getContainerMetadata(container);
 	const instanceList = decoratedInstances.get(target);
 	if (instanceList) for (const instance of instanceList) instance.destroyed();
 	decoratedInstances.delete(target);
 }
+/**
+* This function is responsible for preparing IOC container to work with all decorators. It simply
+* initializes all decorators on all services registered.
+* @param container IOC container
+*/
 function initializeContainer(container) {
 	container.flushQueue();
 }
+/**
+* This function is responsible for preparing IOC container to work with all decorators. It simply
+* initializes all decorators on all services registered.
+* @param container IOC container
+*/
 function destroyContainer(container) {
 	container.getAllServices().forEach((service) => destroyDecorators(service, container));
 	containerMap.delete(container);
@@ -286,6 +370,10 @@ function destroyContainer(container) {
 
 //#endregion
 //#region packages/di/src/Domain/Container.ts
+/**
+* This is new implementation of IOC Container. It mimics Inversify.js container a little bit but its
+* simpler and (probably) more performant on larger scales.
+*/
 var Container = class Container {
 	fLocked = false;
 	fDefaultParams = { createLocked: false };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercube/di",
-  "version": "0.0.1-beta.7",
+  "version": "0.0.2-beta.0",
   "description": "Dependencie Injection  module for Vercube framework",
   "repository": "@vercube/di",
   "license": "MIT",