Compare commits

..

1 Commits

Author SHA1 Message Date
dependabot[bot]
be88170be4 Bump eslint-plugin-jsdoc from 50.2.2 to 50.4.3
Bumps [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) from 50.2.2 to 50.4.3.
- [Release notes](https://github.com/gajus/eslint-plugin-jsdoc/releases)
- [Changelog](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/.releaserc)
- [Commits](https://github.com/gajus/eslint-plugin-jsdoc/compare/v50.2.2...v50.4.3)

---
updated-dependencies:
- dependency-name: eslint-plugin-jsdoc
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-10-21 12:23:43 +00:00
9 changed files with 114 additions and 211 deletions

View File

@@ -9,21 +9,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added ### Added
- feat: Add new `IdentifierRequiredError` class for missing identifiers.
- feat: Add the option to use the decorators without passing the identifier: In this case, the identifier will be the class name (register) or the property name (inject).
- Add pre release building to release workflow on dev/* branches an version changes. - Add pre release building to release workflow on dev/* branches an version changes.
### Deprecated ### Deprecated
### Removed ### Removed
- feat!: Disable `experimentalDecorators` and `emitDecoratorMetadata` in the `tsconfig.json` file to reflect the change to the stable decorators api.
### Fixed ### Fixed
- feat!: Update `Register`, `RegisterInstance` and `Inject` decorators to reflect the change to the stable decorators api.
- feat!: Update `Inject` Decorator typing to reflect the correct property type.
### Security ### Security

25
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{ {
"name": "ts-injex", "name": "ts-injex",
"version": "0.1.0-alpha", "version": "0.1.0",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "ts-injex", "name": "ts-injex",
"version": "0.1.0-alpha", "version": "0.1.0",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"eslint-plugin-prettier": "^5.2.1", "eslint-plugin-prettier": "^5.2.1",
@@ -21,7 +21,7 @@
"axios": "^1.7.2", "axios": "^1.7.2",
"eslint-plugin-deprecation": "^3.0.0", "eslint-plugin-deprecation": "^3.0.0",
"eslint-plugin-import": "^2.29.1", "eslint-plugin-import": "^2.29.1",
"eslint-plugin-jsdoc": "^50.2.2", "eslint-plugin-jsdoc": "^50.4.3",
"eslint-plugin-override": "https://github.com/PxaMMaxP/eslint-plugin-override", "eslint-plugin-override": "https://github.com/PxaMMaxP/eslint-plugin-override",
"istanbul-badges-readme": "^1.9.0", "istanbul-badges-readme": "^1.9.0",
"jest": "^29.7.0", "jest": "^29.7.0",
@@ -612,9 +612,9 @@
"dev": true "dev": true
}, },
"node_modules/@es-joy/jsdoccomment": { "node_modules/@es-joy/jsdoccomment": {
"version": "0.48.0", "version": "0.49.0",
"resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.48.0.tgz", "resolved": "https://registry.npmjs.org/@es-joy/jsdoccomment/-/jsdoccomment-0.49.0.tgz",
"integrity": "sha512-G6QUWIcC+KvSwXNsJyDTHvqUdNoAVJPPgkc3+Uk4WBKqZvoXhlvazOgm9aL0HwihJLQf0l+tOE2UFzXBqCqgDw==", "integrity": "sha512-xjZTSFgECpb9Ohuk5yMX5RhUEbfeQcuOp8IF60e+wyzWEF0M5xeSgqsfLtvPEX8BIyOX9saZqzuGPmZ8oWc+5Q==",
"dev": true, "dev": true,
"dependencies": { "dependencies": {
"comment-parser": "1.4.1", "comment-parser": "1.4.1",
@@ -3218,12 +3218,12 @@
} }
}, },
"node_modules/eslint-plugin-jsdoc": { "node_modules/eslint-plugin-jsdoc": {
"version": "50.2.2", "version": "50.4.3",
"resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-50.2.2.tgz", "resolved": "https://registry.npmjs.org/eslint-plugin-jsdoc/-/eslint-plugin-jsdoc-50.4.3.tgz",
"integrity": "sha512-i0ZMWA199DG7sjxlzXn5AeYZxpRfMJjDPUl7lL9eJJX8TPRoIaxJU4ys/joP5faM5AXE1eqW/dslCj3uj4Nqpg==", "integrity": "sha512-uWtwFxGRv6B8sU63HZM5dAGDhgsatb+LONwmILZJhdRALLOkCX2HFZhdL/Kw2ls8SQMAVEfK+LmnEfxInRN8HA==",
"dev": true, "dev": true,
"dependencies": { "dependencies": {
"@es-joy/jsdoccomment": "~0.48.0", "@es-joy/jsdoccomment": "~0.49.0",
"are-docs-informative": "^0.0.2", "are-docs-informative": "^0.0.2",
"comment-parser": "1.4.1", "comment-parser": "1.4.1",
"debug": "^4.3.6", "debug": "^4.3.6",
@@ -5958,11 +5958,6 @@
"resolved": "https://registry.npmjs.org/react-is/-/react-is-18.3.1.tgz", "resolved": "https://registry.npmjs.org/react-is/-/react-is-18.3.1.tgz",
"integrity": "sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg==" "integrity": "sha512-/LLMVyas0ljjAtoYiPqYiL8VWXzUUdThrmU5+n20DZv+a+ClRoevUzw5JxU+Ieh5/c87ytoTBV9G1FiKfNJdmg=="
}, },
"node_modules/reflect-metadata": {
"version": "0.2.2",
"resolved": "https://registry.npmjs.org/reflect-metadata/-/reflect-metadata-0.2.2.tgz",
"integrity": "sha512-urBwgfrvVP/eAyXx4hluJivBKzuEbSQs9rKWCrCkbSxNv8mxPcUZKeuoF3Uy4mJl3Lwprp6yy5/39VWigZ4K6Q=="
},
"node_modules/regexp.prototype.flags": { "node_modules/regexp.prototype.flags": {
"version": "1.5.2", "version": "1.5.2",
"resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.2.tgz", "resolved": "https://registry.npmjs.org/regexp.prototype.flags/-/regexp.prototype.flags-1.5.2.tgz",

View File

@@ -1,6 +1,6 @@
{ {
"name": "ts-injex", "name": "ts-injex",
"version": "0.1.0-alpha", "version": "0.1.0",
"description": "Simple boilerplate code free dependency injection system for TypeScript.", "description": "Simple boilerplate code free dependency injection system for TypeScript.",
"type": "module", "type": "module",
"main": "./dist/index.js", "main": "./dist/index.js",
@@ -41,7 +41,7 @@
"@typescript-eslint/parser": "^8.1.0", "@typescript-eslint/parser": "^8.1.0",
"eslint-plugin-deprecation": "^3.0.0", "eslint-plugin-deprecation": "^3.0.0",
"eslint-plugin-import": "^2.29.1", "eslint-plugin-import": "^2.29.1",
"eslint-plugin-jsdoc": "^50.2.2", "eslint-plugin-jsdoc": "^50.4.3",
"eslint-plugin-override": "https://github.com/PxaMMaxP/eslint-plugin-override", "eslint-plugin-override": "https://github.com/PxaMMaxP/eslint-plugin-override",
"jest": "^29.7.0", "jest": "^29.7.0",
"ts-jest": "^29.2.3", "ts-jest": "^29.2.3",

View File

@@ -1,9 +1,9 @@
/* istanbul ignore file */ /* istanbul ignore file */
/* eslint-disable @typescript-eslint/no-explicit-any */ /* eslint-disable @typescript-eslint/no-explicit-any */
import { Inject } from 'src/decorators/Inject'; import { Inject } from 'src/decorators/Inject';
import { DependencyResolutionError } from '../interfaces/Exceptions'; import { DependencyResolutionError } from 'src/interfaces/Exceptions';
import { ForceConstructor } from 'src/types/GenericContructor';
import { ITSinjex_, ITSinjex } from '../interfaces/ITSinjex'; import { ITSinjex_, ITSinjex } from '../interfaces/ITSinjex';
import { ForceConstructor } from '../types/GenericContructor';
/** /**
* Test the Inject decorator. * Test the Inject decorator.
@@ -67,29 +67,6 @@ export function test_InjectDecorator(
expect(instance.getDependency().value).toBe('test-value-init'); expect(instance.getDependency().value).toBe('test-value-init');
}); });
it('should inject dependency and run initializer without identifier', () => {
container.register('MockDependencyIdentifier', {
value: 'test-value',
});
class TestClass {
@Inject(undefined, (x: string) => {
(x as unknown as { value: string }).value =
'test-value-init';
return x;
})
MockDependencyIdentifier!: any;
public getDependency() {
return this.MockDependencyIdentifier;
}
}
const instance = new TestClass();
expect(instance.getDependency().value).toBe('test-value-init');
});
it('should throw an error when necessary is true and the initializer throws an error', () => { it('should throw an error when necessary is true and the initializer throws an error', () => {
let _error: Error | undefined = undefined; let _error: Error | undefined = undefined;
@@ -101,7 +78,7 @@ export function test_InjectDecorator(
class TestClass { class TestClass {
@Inject( @Inject(
'InitThrowDependencie', 'InitThrowDependencie',
(): any => { () => {
throw new Error('Initializer error'); throw new Error('Initializer error');
}, },
true, true,
@@ -298,19 +275,6 @@ export function test_RegisterDecorator(
TestClass, TestClass,
); );
}); });
it('should register a dependency without an identifier', () => {
@register()
class TestClass {
private readonly _dependency!: any;
public getDependency() {
return this._dependency;
}
}
expect(container.resolve('TestClass')).toBe(TestClass);
});
}); });
} }
@@ -347,23 +311,6 @@ export function test_RegisterInstanceDecorator(
).toBe('instance'); ).toBe('instance');
}); });
it('should register an instance of a dependency with an identifier', () => {
@registerInstance()
class TestClass {
private readonly _dependency!: any;
public getDependency() {
return this._dependency;
}
public mark: string = 'instance';
}
expect(container.resolve<TestClass>('TestClass').mark).toBe(
'instance',
);
});
it('should register an instance of a dependency an run the init function', () => { it('should register an instance of a dependency an run the init function', () => {
@registerInstance( @registerInstance(
'InstanceIdentifier', 'InstanceIdentifier',

View File

@@ -1,27 +1,26 @@
import { TSinjex } from '../classes/TSinjex';
import { import {
DependencyResolutionError, DependencyResolutionError,
IdentifierRequiredError,
InitializationError, InitializationError,
InjectorError, InjectorError,
NoInstantiationMethodError, NoInstantiationMethodError,
} from '../interfaces/Exceptions'; } from 'src/interfaces/Exceptions';
import { TSinjex } from '../classes/TSinjex';
import { Identifier } from '../types/Identifier'; import { Identifier } from '../types/Identifier';
import { InitDelegate } from '../types/InitDelegate'; import { InitDelegate } from '../types/InitDelegate';
/** /**
* A decorator to inject a dependency from a DI (Dependency Injection) container into a class property. * A decorator to inject a dependency from a DI (Dependency Injection) container into a class property.
* @template TargetType The type of the class to inject the dependency into. * @template T The type of the dependency to be injected.
* @template DependencyType The type of the dependency to be injected. * @template U The type of the property to be injected.
* @template PropertyType The type of the property to be injected. * @param identifier The identifier used to resolve the class in the DI container.
* @param identifier The {@link Identifier|identifier} used to resolve the dependencie in the DI container or the property name if not provided. * @see {@link Identifier} for more information on identifiers.
* @param init An optional initializer {@link InitDelegate|function} to transform the dependency before injection * @param init Optional an initializer function to transform the dependency before injection
* or true to instantiate the dependency if it has a constructor. * or true to instantiate the dependency if it has a constructor.
* @see {@link InitDelegate} for more information on initializer functions.
* @param necessary If true, throws an error if the dependency is not found. * @param necessary If true, throws an error if the dependency is not found.
* @returns The resolved dependency or undefined if the dependency is not necessary * @returns The resolved dependency or undefined if the dependency is not necessary
* and not found, or throws an error if the dependency is necessary and not found. * and not found, or throws an error if the dependency is necessary and not found.
* @throws **Only throws errors if the dependency is necessary.** * @throws **Only throws errors if the dependency is necessary.**
* @throws An {@link IdentifierRequiredError} if the identifier is not provided and the class name is not available.
* @throws A {@link DependencyResolutionError} if the dependency is not found. * @throws A {@link DependencyResolutionError} if the dependency is not found.
* @throws A {@link InjectorError} if an error occurs during the injection process. * @throws A {@link InjectorError} if an error occurs during the injection process.
* @throws A {@link NoInstantiationMethodError} if the dependency does not have a constructor. * @throws A {@link NoInstantiationMethodError} if the dependency does not have a constructor.
@@ -41,83 +40,71 @@ import { InitDelegate } from '../types/InitDelegate';
* } * }
* ``` * ```
*/ */
export function Inject<TargetType, DependencyType, PropertyType>( export function Inject<T, U>(
identifier?: Identifier, identifier: Identifier,
init?: InitDelegate<DependencyType, PropertyType> | true, init?: InitDelegate<T, U> | true,
necessary = true, necessary = true,
) { ) {
return function ( return function (target: unknown, propertyKey: string | symbol): void {
constructor: undefined,
context: ClassFieldDecoratorContext<TargetType>,
): (
this: TargetType,
initialValue: PropertyType | undefined,
) => PropertyType {
const _identifier = identifier ?? context.name;
if (_identifier == null && necessary === true)
throw new IdentifierRequiredError();
/** /**
* Function to evaluate the dependency lazily * Function to evaluate the dependency lazily
* to avoid circular dependencies, not found dependencies, etc. * to avoid circular dependencies, not found dependencies, etc.
* @returns The resolved dependency or undefined if the dependency is not found. * @returns The resolved dependency or undefined if the dependency is not found.
*/ */
const resolve = (): DependencyType | undefined => { const resolve = (): T | undefined => {
return TSinjex.getInstance().resolve<DependencyType>( return TSinjex.getInstance().resolve<T>(identifier, necessary);
_identifier,
necessary,
);
}; };
return function ( Object.defineProperty(target, propertyKey, {
this: TargetType, get() {
initialValue: PropertyType | undefined, let instance: T | U | undefined;
): PropertyType {
let instance: DependencyType | PropertyType | undefined;
const dependency: DependencyType | undefined = tryAndCatch( const dependency: T | undefined = tryAndCatch(
() => resolve(), () => resolve(),
necessary, necessary,
_identifier, identifier,
DependencyResolutionError, DependencyResolutionError,
); );
if (dependency != null) { if (dependency != null) {
const initFunction: (() => PropertyType) | undefined = const initFunction: (() => U) | undefined =
typeof init === 'function' && dependency != null typeof init === 'function' && dependency != null
? (): PropertyType => init(dependency) ? (): U => init(dependency)
: init === true && hasConstructor(dependency) : init === true && hasConstructor(dependency)
? (): PropertyType => new dependency() as PropertyType ? (): U => new dependency() as U
: undefined; : undefined;
if (init == null) instance = dependency; if (init == null) instance = dependency;
else if (initFunction != null) else if (initFunction != null)
instance = tryAndCatch( instance = tryAndCatch(
initFunction, initFunction,
necessary, necessary,
_identifier, identifier,
InitializationError, InitializationError,
); );
else if (necessary) else if (necessary)
throw new NoInstantiationMethodError(_identifier); throw new NoInstantiationMethodError(identifier);
} else if (necessary) } else if (necessary)
throw new DependencyResolutionError(_identifier); throw new DependencyResolutionError(identifier);
/**
* Replace itself with the resolved dependency
* for performance reasons.
*/
Object.defineProperty(this, propertyKey, {
value: instance,
writable: false,
enumerable: false,
configurable: false,
});
return instance;
},
/** /**
* Replace itself with the resolved dependency * Make the property configurable to allow replacing it
* for performance reasons.
*/ */
Object.defineProperty(this, context.name, { configurable: true,
value: instance, });
writable: false,
enumerable: false,
configurable: false,
});
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return instance as any;
};
}; };
} }

View File

@@ -1,14 +1,14 @@
import { TSinjex } from '../classes/TSinjex'; import { TSinjex } from '../classes/TSinjex';
import { IdentifierRequiredError } from '../interfaces/Exceptions';
import { Identifier } from '../types/Identifier'; import { Identifier } from '../types/Identifier';
/** /**
* A decorator to register a class in the **TSinjex** DI (Dependency Injection) container. * A decorator to register a class in the **TSinjex** DI (Dependency Injection) container.
* @template TargetType The type of the class to be registered. * @template TargetType The type of the class to be registered.
* @param identifier The {@link Identifier|identifier} used to register the class in the DI container or the class name if not provided. * @param identifier The identifier used to register the class in the DI container.
* @param deprecated If true, the dependency is deprecated and a warning is logged only once upon the first resolution of the dependency. * @see {@link Identifier} for more information on identifiers.
* @param deprecated If true, the dependency is deprecated and a warning
* is logged only once upon the first resolution of the dependency.
* @returns The decorator function to be applied on the class. * @returns The decorator function to be applied on the class.
* @throws An {@link IdentifierRequiredError} if the identifier is not provided and the class name is not available.
* @example * @example
* ```ts * ```ts
* \@Register('MyClassIdentifier') * \@Register('MyClassIdentifier')
@@ -19,16 +19,12 @@ import { Identifier } from '../types/Identifier';
*/ */
export function Register< export function Register<
TargetType extends new (...args: unknown[]) => InstanceType<TargetType>, TargetType extends new (...args: unknown[]) => InstanceType<TargetType>,
>(identifier?: Identifier, deprecated?: boolean) { >(identifier: Identifier, deprecated?: boolean) {
return function ( return function (constructor: TargetType, ...args: unknown[]): void {
constructor: TargetType, // Get the instance of the DI container
context: ClassDecoratorContext<TargetType>,
) {
const _identifier = identifier ?? context.name;
if (_identifier == null) throw new IdentifierRequiredError();
const diContainer = TSinjex.getInstance(); const diContainer = TSinjex.getInstance();
diContainer.register(_identifier, constructor, deprecated);
// Register the class in the DI container
diContainer.register(identifier, constructor, deprecated);
}; };
} }

View File

@@ -1,16 +1,16 @@
import { TSinjex } from '../classes/TSinjex'; import { TSinjex } from '../classes/TSinjex';
import { IdentifierRequiredError } from '../interfaces/Exceptions';
import { Identifier } from '../types/Identifier'; import { Identifier } from '../types/Identifier';
import { InitDelegate } from '../types/InitDelegate'; import { InitDelegate } from '../types/InitDelegate';
/** /**
* A decorator to register an instance of a class in the DI (Dependency Injection) container. * A decorator to register an instance of a class in the DI (Dependency Injection) container.
* @template TargetType The type of the class whose instance is to be registered. * @template TargetType The type of the class whose instance is to be registered.
* @param identifier The {@link Identifier|identifier} used to register the class in the DI container or the class name if not provided. * @param identifier The identifier used to register the instance in the DI container.
* @param init An optional initializer {@link InitDelegate|function} which get the constructor of the class * @see {@link Identifier} for more information on identifiers.
* @param init An optional initializer function which get the constructor of the class
* as input and returns an instance of the class. * as input and returns an instance of the class.
* @see {@link InitDelegate} for more information on initializer functions.
* @returns The decorator function to be applied on the class. * @returns The decorator function to be applied on the class.
* @throws An {@link IdentifierRequiredError} if the identifier is not provided and the class name is not available.
* @example * @example
* ```ts * ```ts
* \@RegisterInstance('MyClassInstanceIdentifier', (constructor) => new constructor()) * \@RegisterInstance('MyClassInstanceIdentifier', (constructor) => new constructor())
@@ -22,51 +22,43 @@ import { InitDelegate } from '../types/InitDelegate';
export function RegisterInstance< export function RegisterInstance<
TargetType extends new (..._args: unknown[]) => InstanceType<TargetType>, TargetType extends new (..._args: unknown[]) => InstanceType<TargetType>,
>( >(
identifier?: Identifier, identifier: Identifier,
init?: InitDelegate< init?: InitDelegate<
TargetType & { new (..._args: unknown[]): InstanceType<TargetType> }, TargetType & { new (..._args: unknown[]): InstanceType<TargetType> },
InstanceType<TargetType> InstanceType<TargetType>
>, >,
) { ) {
return function ( return function (constructor: TargetType, ...args: unknown[]): void {
constructor: TargetType, // Get the instance of the DI container
context: ClassDecoratorContext<TargetType>,
): void {
const _identifier = identifier ?? context.name;
if (_identifier == null) throw new IdentifierRequiredError();
const diContainer = TSinjex.getInstance(); const diContainer = TSinjex.getInstance();
let instance: InstanceType<TargetType>; let instance: InstanceType<TargetType>;
/**
* Get the instance of the class
* and replace the lazy proxy with the instance
* for performance optimization.
*/
const getAndRegisterInstance = (): void => {
if (instance == null) {
if (init) {
instance = init(constructor);
} else {
instance = new constructor();
}
}
diContainer.register(_identifier, instance);
};
// Create a proxy to instantiate the class when needed (Lazy Initialization) // Create a proxy to instantiate the class when needed (Lazy Initialization)
const lazyProxy: unknown = new Proxy( let lazyProxy: unknown = new Proxy(
{}, {},
{ {
get(_target, prop, _receiver) { get(target, prop, receiver) {
getAndRegisterInstance(); if (instance == null) {
if (init) {
instance = init(constructor);
} else {
instance = new constructor(...args);
}
}
lazyProxy = instance;
// Return the requested property of the instance // Return the requested property of the instance
return instance[prop as keyof InstanceType<TargetType>]; return instance[prop as keyof InstanceType<TargetType>];
}, },
set(_target, prop, value, _receiver) { set(target, prop, value, receiver) {
getAndRegisterInstance(); if (instance == null) {
if (init) {
instance = init(constructor);
} else {
instance = new constructor(...args);
}
}
lazyProxy = instance;
// Set the requested property of the instance // Set the requested property of the instance
return (instance[prop as keyof InstanceType<TargetType>] = return (instance[prop as keyof InstanceType<TargetType>] =
@@ -75,6 +67,7 @@ export function RegisterInstance<
}, },
); );
diContainer.register(_identifier, lazyProxy); // Register the lazy proxy in the DI container
diContainer.register(identifier, lazyProxy);
}; };
} }

View File

@@ -15,19 +15,6 @@ export class TSinjexError extends Error {
} }
} }
/**
* Error class for missing identifiers in {@link ITSinjex} methods.
*/
export class IdentifierRequiredError extends TSinjexError {
/**
* Creates a new instance of {@link IdentifierRequiredError}
*/
constructor() {
super('Identifier is required.');
this.name = 'TSinjexIdentifierRequiredError';
}
}
/** /**
* Error class for dependency resolution errors in {@link ITSinjex}. * Error class for dependency resolution errors in {@link ITSinjex}.
* @see {@link ITSinjex.resolve} * @see {@link ITSinjex.resolve}

View File

@@ -18,6 +18,8 @@
"importHelpers": true, "importHelpers": true,
"isolatedModules": true, "isolatedModules": true,
"resolveJsonModule": true, "resolveJsonModule": true,
"experimentalDecorators": true,
"emitDecoratorMetadata": true,
"strictNullChecks": true, "strictNullChecks": true,
"strictPropertyInitialization": true, "strictPropertyInitialization": true,
"lib": [ "lib": [