proxydi 0.0.10 → 0.0.11

package/CHANGELOG.md

@@ -0,0 +1,85 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [[0.0.10](https://www.npmjs.com/package/proxydi/v/0.0.11)] - 2025-03-03
+
+### Added
+
+- resolveInjectables() method [#12](https://github.com/proxy-di/proxydi/pull/13)
+
+## [[0.0.10](https://www.npmjs.com/package/proxydi/v/0.0.10)] - 2025-03-02
+
+### Changed
+
+- Renamed @autoInjectable to @injectable
+
+### Added
+
+- Experimental constructor injections via @injectable decorator [#12](https://github.com/proxy-di/proxydi/pull/12)
+
+## [[0.0.9](https://www.npmjs.com/package/proxydi/v/0.0.9)] - 2025-02-27
+
+### Added
+
+- resolveAll() function to find all dependencies of a given kind [#11](https://github.com/proxy-di/proxydi/pull/11)
+
+## [[0.0.8](https://www.npmjs.com/package/proxydi/v/0.0.8)] - 2025-02-26
+
+### Changed
+
+- API improvements [#10](https://github.com/proxy-di/proxydi/pull/10)
+
+### Added
+
+- Added access to child containers
+- PROXYDI_CONTAINER and DEPENDENCY_ID now public
+- Enhanced hierarchy documentation
+
+## [[0.0.7](https://www.npmjs.com/package/proxydi/v/0.0.7)] - 2025-02-21
+
+### Added
+
+- TypeDoc integration [#7](https://github.com/proxy-di/proxydi/pull/7)
+- Action to publish documentation on GitHub Pages
+
+## [[0.0.6](https://www.npmjs.com/package/proxydi/v/0.0.6)] - 2025-02-21
+
+### Changed
+
+- Improved API [#6](https://github.com/proxy-di/proxydi/pull/6)
+
+## [[0.0.5](https://www.npmjs.com/package/proxydi/v/0.0.5)] - 2025-02-20
+
+### Changed
+
+- Baking dependencies [#5](https://github.com/proxy-di/proxydi/pull/5)
+- 100% test coverage
+- Changed API with new terminology
+
+## [[0.0.4](https://www.npmjs.com/package/proxydi/v/0.0.4)] - 2025-02-11
+
+### Changed
+
+- Implemented proxy per instance instead of per container [#2](https://github.com/proxy-di/proxydi/pull/2)
+- Ability to register anything as an instance
+- Changed settings to object format
+- Added settings presets
+
+### Fixed
+
+- Made injectables known
+
+## [[0.0.3](https://www.npmjs.com/package/proxydi/v/0.0.3)] - 2025-02-07
+
+### Added
+
+- Draft DI-container implementation
+- @injectable decorator
+- Basic project setup with CI/CD
+- Testing framework integration
+- Basic package configuration
+- Repository initialization

package/README.md

@@ -15,6 +15,7 @@ Core features:
 - Currently under active development, the API may change until version 0.1.0
 
 Eperimemntal features:
+
 - Construtor injections (see unit tests for examples)
 - Matches dependencies by unique identifiers or automatically using class names and property names
 
@@ -242,10 +243,67 @@ In this example, the character activates all its perks, which are registered in
 
 ### Reference to the container
 
-Here you should be wondering, how [resolveAll()](https://proxy-di.github.io/proxydi/functions/resolveAll.html.html) function knows about the container, to which character belongs. The answer - each time when dependency is registered in the ProxyDiContainer, it saves a reference to itself in this dependency instance. So, when you call resolveAll() function, it just takes this reference from the instance and then recursively resolves all asked dependencies from this container and all its children and children of children and so on.
+Here you should be wondering, how [resolveAll()](https://proxy-di.github.io/proxydi/functions/resolveAll.html) function knows about the container, to which character belongs. The answer - each time when dependency is registered in the ProxyDiContainer, it saves a reference to itself in this dependency instance. So, when you call resolveAll() function, it just takes this reference from the instance and then recursively resolves all asked dependencies from this container and all its children and children of children and so on.
 
 Despite this explanation is a little bit complicated, the example is still simple, the character just activates all its perks.
 
+## Injectable classes
+
+Look at the following example:
+
+```typescript
+@injectable()
+class GameEngine {
+    start = () => console.log('Game started');
+}
+
+const container = new ProxyDiContainer();
+
+const gameEngine = container.resolve(GameEngine);
+gameEngine.start();
+```
+
+```shell
+> Game started
+```
+
+Two things happen here:
+
+1. We use the [@injectable()](https://proxy-di.github.io/proxydi/functions/injectable.html) decorator to mark the class as injectable. This allows us to resolve the dependency without registering it in the container.
+
+2. To resolve the dependency instance, we pass the injectable class itself as the dependency identifier. This is possible because ProxyDi automatically uses the class name as the dependency identifier when none is explicitly provided. As an additional bonus, the `gameEngine` has a type `GameEngine`.
+
+### Implicitly resolving injectable() dependencies
+
+There are a few important nuances about the `@injectable()` decorator to keep in mind. The first is how these dependencies are resolved. Consider this example:
+
+```typescript
+const parent = new ProxyDiContainer();
+const child = parent.createChildContainer();
+
+const engine1 = child.resolve(GameEngine);
+const engine2 = parent.resolve(GameEngine);
+
+engine1 === engine2; // false
+```
+
+Here we create a hierarchy of containers and resolve the same dependency from the child container first and then from the parent container. The result is two different instances of the GameEngine class. This happens because during the first resolution, the child container doesn't find GameEngine in either itself or its parent container, so it creates a new instance and stores it in itself. When the parent container resolves GameEngine, it creates another instance since he knowns nothing about child depenencies
+
+There are two ways to avoid this behavior:
+
+1. Don't use the `@injectable()` decorator and always register dependencies explicitly
+2. Use the `registerInjectables()` method to create instances for all injectable dependencies in the container. In this case every time when you resolve injectable dependency, you will get the same instance:
+
+```typescript
+const parent = new ProxyDiContainer().registerInjectables();
+const child = parent.createChildContainer();
+
+const engine1 = child.resolve(GameEngine);
+const engine2 = parent.resolve(GameEngine);
+
+engine1 === engine2; // true now
+```
+
 ## Rewriting dependencies
 
 By default, ProxyDi doesn't allow rewriting dependencies in the container. After a dependency becomes known to the container, any attempt to register a new dependency with the same dependency ID will throw an Error:

package/dist/ProxyDiContainer.d.ts

@@ -72,6 +72,11 @@ export declare class ProxyDiContainer implements IProxyDiContainer {
      * @param injectionsOwner The object to inject dependencies into.
      */
     injectDependenciesTo(injectionsOwner: any): void;
+    /**
+     * Creates instances for all injectable classes and registers them in this container.
+     * @returns This container to allow use along with constructor.
+     */
+    registerInjectables(): this;
     /**
      * Finalizes dependency injections, prevents further rewriting of dependencies,
      * and recursively bakes injections for child containers.

package/dist/index.cjs

@@ -12,7 +12,7 @@ const DEPENDENCY_ID = Symbol('DependencyId');
  * This property is present in each dependency instance that was registered in ProxyDiContainer.
  * The property stores a reference to the ProxyDiContainer in which the dependency was registered.
  */
-const PROXYDY_CONTAINER = Symbol('proxyDiContainer');
+const PROXYDI_CONTAINER = Symbol('proxyDiContainer');
 const IS_INJECTION_PROXY = Symbol('isInjectionProxy');
 const INJECTION_OWNER = Symbol('injectionOwner');
 const IS_INSTANCE_PROXY = Symbol('isInstanceProxy');
@@ -93,7 +93,7 @@ class InjectionProxy {
     constructor(onwer, container) {
         this[_a] = true;
         this[INJECTION_OWNER] = onwer;
-        this[PROXYDY_CONTAINER] = container;
+        this[PROXYDI_CONTAINER] = container;
     }
 }
 _a = IS_INJECTION_PROXY;
@@ -235,7 +235,7 @@ class ProxyDiContainer {
             }
         }
         if (typeof dependencyInstance === 'object') {
-            dependencyInstance[PROXYDY_CONTAINER] = this;
+            dependencyInstance[PROXYDI_CONTAINER] = this;
         }
         this.registerImpl(dependencyInstance, dependencyId);
         return dependencyInstance;
@@ -286,7 +286,7 @@ class ProxyDiContainer {
         }
         const instance = this.findDependency(dependency);
         if (instance) {
-            if (instance[PROXYDY_CONTAINER] !== this &&
+            if (instance[PROXYDI_CONTAINER] !== this &&
                 typeof instance === 'object' &&
                 this.settings.resolveInContainerContext) {
                 const proxy = makeDependencyProxy(instance);
@@ -310,6 +310,16 @@ class ProxyDiContainer {
             injection.set(injectionsOwner, dependencyProxy);
         });
     }
+    /**
+     * Creates instances for all injectable classes and registers them in this container.
+     * @returns This container to allow use along with constructor.
+     */
+    registerInjectables() {
+        for (const [dependencyId, InjectableClass] of Object.entries(injectableClasses)) {
+            this.register(InjectableClass, dependencyId);
+        }
+        return this;
+    }
     /**
      * Finalizes dependency injections, prevents further rewriting of dependencies,
      * and recursively bakes injections for child containers.
@@ -445,7 +455,7 @@ function resolveAll(instance, dependencyId) {
         const id = findInjectableId(dependencyId);
         return resolveAll(instance, id);
     }
-    const container = instance[PROXYDY_CONTAINER];
+    const container = instance[PROXYDI_CONTAINER];
     if (!container) {
         throw new Error('Instance is not registered in any container');
     }
@@ -463,7 +473,7 @@ function recursiveResolveAll(container, dependencyId) {
 }
 
 exports.DEPENDENCY_ID = DEPENDENCY_ID;
-exports.PROXYDY_CONTAINER = PROXYDY_CONTAINER;
+exports.PROXYDI_CONTAINER = PROXYDI_CONTAINER;
 exports.ProxyDiContainer = ProxyDiContainer;
 exports.inject = inject;
 exports.injectable = injectable;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { inject } from './inject';
 export { ProxyDiContainer } from './ProxyDiContainer';
 export { injectable } from './injectable';
-export { Injection, DependencyId, DependencyClass, ContainerSettings, PROXYDY_CONTAINER, DEPENDENCY_ID, } from './types';
+export { Injection, DependencyId, DependencyClass, ContainerSettings, PROXYDI_CONTAINER, DEPENDENCY_ID, } from './types';
 export { resolveAll } from './resolveAll';

package/dist/index.js

@@ -10,7 +10,7 @@ const DEPENDENCY_ID = Symbol('DependencyId');
  * This property is present in each dependency instance that was registered in ProxyDiContainer.
  * The property stores a reference to the ProxyDiContainer in which the dependency was registered.
  */
-const PROXYDY_CONTAINER = Symbol('proxyDiContainer');
+const PROXYDI_CONTAINER = Symbol('proxyDiContainer');
 const IS_INJECTION_PROXY = Symbol('isInjectionProxy');
 const INJECTION_OWNER = Symbol('injectionOwner');
 const IS_INSTANCE_PROXY = Symbol('isInstanceProxy');
@@ -91,7 +91,7 @@ class InjectionProxy {
     constructor(onwer, container) {
         this[_a] = true;
         this[INJECTION_OWNER] = onwer;
-        this[PROXYDY_CONTAINER] = container;
+        this[PROXYDI_CONTAINER] = container;
     }
 }
 _a = IS_INJECTION_PROXY;
@@ -233,7 +233,7 @@ class ProxyDiContainer {
             }
         }
         if (typeof dependencyInstance === 'object') {
-            dependencyInstance[PROXYDY_CONTAINER] = this;
+            dependencyInstance[PROXYDI_CONTAINER] = this;
         }
         this.registerImpl(dependencyInstance, dependencyId);
         return dependencyInstance;
@@ -284,7 +284,7 @@ class ProxyDiContainer {
         }
         const instance = this.findDependency(dependency);
         if (instance) {
-            if (instance[PROXYDY_CONTAINER] !== this &&
+            if (instance[PROXYDI_CONTAINER] !== this &&
                 typeof instance === 'object' &&
                 this.settings.resolveInContainerContext) {
                 const proxy = makeDependencyProxy(instance);
@@ -308,6 +308,16 @@ class ProxyDiContainer {
             injection.set(injectionsOwner, dependencyProxy);
         });
     }
+    /**
+     * Creates instances for all injectable classes and registers them in this container.
+     * @returns This container to allow use along with constructor.
+     */
+    registerInjectables() {
+        for (const [dependencyId, InjectableClass] of Object.entries(injectableClasses)) {
+            this.register(InjectableClass, dependencyId);
+        }
+        return this;
+    }
     /**
      * Finalizes dependency injections, prevents further rewriting of dependencies,
      * and recursively bakes injections for child containers.
@@ -443,7 +453,7 @@ function resolveAll(instance, dependencyId) {
         const id = findInjectableId(dependencyId);
         return resolveAll(instance, id);
     }
-    const container = instance[PROXYDY_CONTAINER];
+    const container = instance[PROXYDI_CONTAINER];
     if (!container) {
         throw new Error('Instance is not registered in any container');
     }
@@ -460,4 +470,4 @@ function recursiveResolveAll(container, dependencyId) {
     return all;
 }
 
-export { DEPENDENCY_ID, PROXYDY_CONTAINER, ProxyDiContainer, inject, injectable, resolveAll };
+export { DEPENDENCY_ID, PROXYDI_CONTAINER, ProxyDiContainer, inject, injectable, resolveAll };

package/dist/index.umd.js

@@ -16,7 +16,7 @@
      * This property is present in each dependency instance that was registered in ProxyDiContainer.
      * The property stores a reference to the ProxyDiContainer in which the dependency was registered.
      */
-    const PROXYDY_CONTAINER = Symbol('proxyDiContainer');
+    const PROXYDI_CONTAINER = Symbol('proxyDiContainer');
     const IS_INJECTION_PROXY = Symbol('isInjectionProxy');
     const INJECTION_OWNER = Symbol('injectionOwner');
     const IS_INSTANCE_PROXY = Symbol('isInstanceProxy');
@@ -97,7 +97,7 @@
         constructor(onwer, container) {
             this[_a] = true;
             this[INJECTION_OWNER] = onwer;
-            this[PROXYDY_CONTAINER] = container;
+            this[PROXYDI_CONTAINER] = container;
         }
     }
     _a = IS_INJECTION_PROXY;
@@ -239,7 +239,7 @@
                 }
             }
             if (typeof dependencyInstance === 'object') {
-                dependencyInstance[PROXYDY_CONTAINER] = this;
+                dependencyInstance[PROXYDI_CONTAINER] = this;
             }
             this.registerImpl(dependencyInstance, dependencyId);
             return dependencyInstance;
@@ -290,7 +290,7 @@
             }
             const instance = this.findDependency(dependency);
             if (instance) {
-                if (instance[PROXYDY_CONTAINER] !== this &&
+                if (instance[PROXYDI_CONTAINER] !== this &&
                     typeof instance === 'object' &&
                     this.settings.resolveInContainerContext) {
                     const proxy = makeDependencyProxy(instance);
@@ -314,6 +314,16 @@
                 injection.set(injectionsOwner, dependencyProxy);
             });
         }
+        /**
+         * Creates instances for all injectable classes and registers them in this container.
+         * @returns This container to allow use along with constructor.
+         */
+        registerInjectables() {
+            for (const [dependencyId, InjectableClass] of Object.entries(injectableClasses)) {
+                this.register(InjectableClass, dependencyId);
+            }
+            return this;
+        }
         /**
          * Finalizes dependency injections, prevents further rewriting of dependencies,
          * and recursively bakes injections for child containers.
@@ -449,7 +459,7 @@
             const id = findInjectableId(dependencyId);
             return resolveAll(instance, id);
         }
-        const container = instance[PROXYDY_CONTAINER];
+        const container = instance[PROXYDI_CONTAINER];
         if (!container) {
             throw new Error('Instance is not registered in any container');
         }
@@ -467,7 +477,7 @@
     }
 
     exports.DEPENDENCY_ID = DEPENDENCY_ID;
-    exports.PROXYDY_CONTAINER = PROXYDY_CONTAINER;
+    exports.PROXYDI_CONTAINER = PROXYDI_CONTAINER;
     exports.ProxyDiContainer = ProxyDiContainer;
     exports.inject = inject;
     exports.injectable = injectable;

package/dist/types.d.ts

@@ -12,7 +12,7 @@ export type IProxyDiContainer = {
     isKnown: (dependencyId: DependencyId) => boolean;
     injectDependenciesTo: (dependency: any) => void;
     register: (dependency: any, dependencyId: DependencyId) => any;
-    resolve: <T>(dependencyId: DependencyId) => T & ContainerizedDependency;
+    resolve: <T>(dependencyId: DependencyId | DependencyClass<any>) => T & ContainerizedDependency;
     createChildContainer: () => IProxyDiContainer;
     children: IProxyDiContainer[];
     getChild(id: number): IProxyDiContainer;
@@ -32,7 +32,7 @@ export declare const DEPENDENCY_ID: unique symbol;
  * This property is present in each dependency instance that was registered in ProxyDiContainer.
  * The property stores a reference to the ProxyDiContainer in which the dependency was registered.
  */
-export declare const PROXYDY_CONTAINER: unique symbol;
+export declare const PROXYDI_CONTAINER: unique symbol;
 export type Injections = Record<string | symbol, Injection>;
 export type Dependency = {
     [INJECTIONS]: Injections;
@@ -48,7 +48,7 @@ export type ContainerizedDependency = Dependency & {
     /**
      * ProxyDi container in which this instance was registered
      */
-    [PROXYDY_CONTAINER]: IProxyDiContainer;
+    [PROXYDI_CONTAINER]: IProxyDiContainer;
 };
 export type ContainerSettings = {
     allowRegisterAnything?: boolean;
@@ -61,5 +61,5 @@ export declare const IS_INSTANCE_PROXY: unique symbol;
 export type InjectionProxy = {
     [IS_INJECTION_PROXY]: true;
     [INJECTION_OWNER]: ContainerizedDependency;
-    [PROXYDY_CONTAINER]: IProxyDiContainer;
+    [PROXYDI_CONTAINER]: IProxyDiContainer;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "proxydi",
-    "version": "0.0.10",
+    "version": "0.0.11",
     "description": "A typed hierarchical DI container that resolves circular dependencies via Proxy",
     "type": "module",
     "main": "./dist/index.cjs",