refactor: re-sturcture project and update file naming

NoNameProvided · NoNameProvided · commit a39a8de61b9e · 2021-01-09T14:08:23.000+01:00
diff --git a/src/container-instance.class.ts b/src/container-instance.class.ts
@@ -1,10 +1,10 @@
-import { Container } from './Container';
-import { MissingProvidedServiceTypeError } from './error/MissingProvidedServiceTypeError';
-import { ServiceNotFoundError } from './error/ServiceNotFoundError';
-import { Token } from './Token';
-import { ObjectType } from './types/ObjectType';
-import { ServiceIdentifier } from './types/ServiceIdentifier';
-import { ServiceMetadata } from './types/ServiceMetadata';
+import { Container } from './container.class';
+import { MissingProvidedServiceTypeError } from './error/missing-provided-service-type.error';
+import { ServiceNotFoundError } from './error/service-not-found.error';
+import { Token } from './token.class';
+import { Constructable } from './types/constructable.type';
+import { ServiceIdentifier } from './types/service-identifier.type';
+import { ServiceMetadata } from './interfaces/service-metadata.interface.';
 
 /**
  * TypeDI can have multiple containers.
@@ -45,7 +45,7 @@ export class ContainerInstance {
    * Checks if the service with given name or type is registered service container.
    * Optionally, parameters can be passed in case if instance is initialized in the container for the first time.
    */
-  has<T>(type: ObjectType<T>): boolean;
+  has<T>(type: Constructable<T>): boolean;
 
   /**
    * Checks if the service with given name or type is registered service container.
@@ -71,7 +71,7 @@ export class ContainerInstance {
    * Retrieves the service with given name or type from the service container.
    * Optionally, parameters can be passed in case if instance is initialized in the container for the first time.
    */
-  get<T>(type: ObjectType<T>): T;
+  get<T>(type: Constructable<T>): T;
 
   /**
    * Retrieves the service with given name or type from the service container.
diff --git a/src/container.class.ts b/src/container.class.ts
@@ -1,9 +1,9 @@
-import { ContainerInstance } from './ContainerInstance';
-import { Token } from './Token';
-import { Handler } from './types/Handler';
-import { ObjectType } from './types/ObjectType';
-import { ServiceIdentifier } from './types/ServiceIdentifier';
-import { ServiceMetadata } from './types/ServiceMetadata';
+import { ContainerInstance } from './container-instance.class';
+import { Token } from './token.class';
+import { Handler } from './interfaces/handler.interface';
+import { Constructable } from './types/constructable.type';
+import { ServiceIdentifier } from './types/service-identifier.type';
+import { ServiceMetadata } from './interfaces/service-metadata.interface.';
 
 /**
  * Service container.
@@ -51,7 +51,7 @@ export class Container {
    * Checks if the service with given name or type is registered service container.
    * Optionally, parameters can be passed in case if instance is initialized in the container for the first time.
    */
-  static has<T>(type: ObjectType<T>): boolean;
+  static has<T>(type: Constructable<T>): boolean;
 
   /**
    * Checks if the service with given name or type is registered service container.
@@ -77,7 +77,7 @@ export class Container {
    * Retrieves the service with given name or type from the service container.
    * Optionally, parameters can be passed in case if instance is initialized in the container for the first time.
    */
-  static get<T>(type: ObjectType<T>): T;
+  static get<T>(type: Constructable<T>): T;
 
   /**
    * Retrieves the service with given name or type from the service container.
diff --git a/src/decorators/inject-many.decorator.ts b/src/decorators/inject-many.decorator.ts
@@ -1,6 +1,6 @@
-import { Container } from '../Container';
-import { Token } from '../Token';
-import { CannotInjectError } from '../error/CannotInjectError';
+import { Container } from '../container.class';
+import { Token } from '../token.class';
+import { CannotInjectValueError } from '../error/cannot-inject-value.error';
 
 /**
  * Injects a service into a class property or constructor parameter.
@@ -38,7 +38,7 @@ export function InjectMany(typeOrName?: ((type?: any) => Function) | string | To
           identifier = typeOrName();
         }
 
-        if (identifier === Object) throw new CannotInjectError(target, propertyName);
+        if (identifier === Object) throw new CannotInjectValueError(target, propertyName);
 
         return containerInstance.getMany<any>(identifier);
       },
diff --git a/src/decorators/inject.decorator.ts b/src/decorators/inject.decorator.ts
@@ -1,6 +1,6 @@
-import { Container } from '../Container';
-import { Token } from '../Token';
-import { CannotInjectError } from '../error/CannotInjectError';
+import { Container } from '../container.class';
+import { Token } from '../token.class';
+import { CannotInjectValueError } from '../error/cannot-inject-value.error';
 
 /**
  * Injects a service into a class property or constructor parameter.
@@ -38,7 +38,7 @@ export function Inject(typeOrName?: ((type?: any) => Function) | string | Token<
           identifier = typeOrName();
         }
 
-        if (identifier === Object) throw new CannotInjectError(target, propertyName);
+        if (identifier === Object) throw new CannotInjectValueError(target, propertyName);
 
         return containerInstance.get<any>(identifier);
       },
diff --git a/src/decorators/service.decorator.ts b/src/decorators/service.decorator.ts
@@ -1,8 +1,8 @@
-import { Container } from '../Container';
-import { ContainerInstance } from '../ContainerInstance';
-import { Token } from '../Token';
-import { ServiceMetadata } from '../types/ServiceMetadata';
-import { ServiceOptions } from '../types/ServiceOptions';
+import { Container } from '../container.class';
+import { ContainerInstance } from '../container-instance.class';
+import { Token } from '../token.class';
+import { ServiceMetadata } from '../interfaces/service-metadata.interface.';
+import { ServiceOptions } from '../interfaces/service-options.interface';
 
 export type ObjectType<T1> = { new (...args: any[]): T1 } | { service: T1 } | Token<T1>;
 
diff --git a/src/error/cannot-inject-value.error.ts b/src/error/cannot-inject-value.error.ts
@@ -1,14 +1,14 @@
 /**
  * Thrown when DI cannot inject value into property decorated by @Inject decorator.
  */
-export class CannotInjectError extends Error {
-  name = 'ServiceNotFoundError';
+export class CannotInjectValueError extends Error {
+  name = 'CannotInjectValueError';
 
   constructor(target: Object, propertyName: string) {
     super(
       `Cannot inject value into "${target.constructor.name}.${propertyName}". ` +
         `Please make sure you setup reflect-metadata properly and you don't use interfaces without service tokens as injection value.`
     );
-    Object.setPrototypeOf(this, CannotInjectError.prototype);
+    Object.setPrototypeOf(this, CannotInjectValueError.prototype);
   }
 }
diff --git a/src/error/missing-provided-service-type.error.ts b/src/error/missing-provided-service-type.error.ts
@@ -2,7 +2,7 @@
  * Thrown when service is registered without type.
  */
 export class MissingProvidedServiceTypeError extends Error {
-  name = 'ServiceNotFoundError';
+  name = 'MissingProvidedServiceTypeError';
 
   constructor(identifier: any) {
     // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
diff --git a/src/error/service-not-found.error.ts b/src/error/service-not-found.error.ts
@@ -1,5 +1,5 @@
-import { ServiceIdentifier } from '../types/ServiceIdentifier';
-import { Token } from '../Token';
+import { ServiceIdentifier } from '../types/service-identifier.type';
+import { Token } from '../token.class';
 
 /**
  * Thrown when requested service was not found.
diff --git a/src/index.ts b/src/index.ts
@@ -1,15 +1,15 @@
-import { Container } from './Container';
+import { Container } from './container.class';
 
-export * from './decorators/Service';
-export * from './decorators/Inject';
-export * from './decorators/InjectMany';
-export { Container } from './Container';
-export { ContainerInstance } from './ContainerInstance';
-export { Token } from './Token';
-export { Handler } from './types/Handler';
-export { ServiceOptions } from './types/ServiceOptions';
-export { ServiceIdentifier } from './types/ServiceIdentifier';
-export { ServiceMetadata } from './types/ServiceMetadata';
-export { ObjectType } from './types/ObjectType';
+export * from './decorators/service.decorator';
+export * from './decorators/inject.decorator';
+export * from './decorators/inject-many.decorator';
+export { Container } from './container.class';
+export { ContainerInstance } from './container-instance.class';
+export { Token } from './token.class';
+export { Handler } from './interfaces/handler.interface';
+export { ServiceOptions } from './interfaces/service-options.interface';
+export { ServiceIdentifier } from './types/service-identifier.type';
+export { ServiceMetadata } from './interfaces/service-metadata.interface.';
+export { Constructable as ObjectType } from './types/constructable.type';
 
 export default Container;
diff --git a/src/interfaces/handler.interface.ts b/src/interfaces/handler.interface.ts
@@ -1,4 +1,4 @@
-import { ContainerInstance } from '../ContainerInstance';
+import { ContainerInstance } from '../container-instance.class';
 
 /**
  * Used to register special "handler" which will be executed on a service class during its initialization.
diff --git a/src/interfaces/service-metadata.interface..ts b/src/interfaces/service-metadata.interface..ts
@@ -1,5 +1,5 @@
-import { ObjectType } from './ObjectType';
-import { ServiceIdentifier } from './ServiceIdentifier';
+import { Constructable } from '../types/constructable.type';
+import { ServiceIdentifier } from '../types/service-identifier.type';
 
 /**
  * Service metadata is used to initialize service and store its state.
@@ -38,7 +38,7 @@ export interface ServiceMetadata<T, K extends keyof T> {
    * Can be regular function ("createCar" for example),
    * or other service which produces this instance ([CarFactory, "createCar"] for example).
    */
-  factory?: [ObjectType<T>, K] | ((...params: any[]) => any);
+  factory?: [Constructable<T>, K] | ((...params: any[]) => any);
 
   /**
    * Instance of the target class.
diff --git a/src/interfaces/service-options.interface.ts b/src/interfaces/service-options.interface.ts
@@ -1,5 +1,5 @@
-import { ObjectType } from './ObjectType';
-import { Token } from '../Token';
+import { Constructable } from '../types/constructable.type';
+import { Token } from '../token.class';
 
 /**
  * Service options passed to the @Service() decorator.
@@ -30,5 +30,5 @@ export interface ServiceOptions<T, K extends keyof T> {
   /**
    * Factory used to produce this service.
    */
-  factory?: [ObjectType<T>, K] | ((...params: any[]) => any);
+  factory?: [Constructable<T>, K] | ((...params: any[]) => any);
 }
diff --git a/src/token.class.ts b/src/token.class.ts
diff --git a/src/types/ObjectType.ts b/src/types/ObjectType.ts
diff --git a/src/types/constructable.type.ts b/src/types/constructable.type.ts
@@ -0,0 +1,10 @@
+/**
+ * Generic type for class definitions.
+ * Example usage:
+ * ```
+ * function createSomeInstance(myClassDefinition: Constructable<MyClass>) {
+ *   return new myClassDefinition()
+ * }
+ * ```
+ */
+export type Constructable<T> = new (...args: any[]) => T;
diff --git a/src/types/service-identifier.type.ts b/src/types/service-identifier.type.ts
@@ -1,4 +1,4 @@
-import { Token } from '../Token';
+import { Token } from '../token.class';
 
 /**
  * Unique service identifier.
diff --git a/test/Container.spec.ts b/test/Container.spec.ts
@@ -1,8 +1,8 @@
 import 'reflect-metadata';
-import { Container } from '../src/Container';
-import { Service } from '../src/decorators/Service';
-import { Token } from '../src/Token';
-import { ServiceNotFoundError } from '../src/error/ServiceNotFoundError';
+import { Container } from '../src/container.class';
+import { Service } from '../src/decorators/service.decorator';
+import { Token } from '../src/token.class';
+import { ServiceNotFoundError } from '../src/error/service-not-found.error';
 
 describe('Container', function () {
   beforeEach(() => Container.reset());
diff --git a/test/decorators/Inject.spec.ts b/test/decorators/Inject.spec.ts
@@ -1,9 +1,9 @@
 import 'reflect-metadata';
-import { Container } from '../../src/Container';
-import { Service } from '../../src/decorators/Service';
-import { Inject } from '../../src/decorators/Inject';
-import { Token } from '../../src/Token';
-import { InjectMany } from '../../src/decorators/InjectMany';
+import { Container } from '../../src/container.class';
+import { Service } from '../../src/decorators/service.decorator';
+import { Inject } from '../../src/decorators/inject.decorator';
+import { Token } from '../../src/token.class';
+import { InjectMany } from '../../src/decorators/inject-many.decorator';
 
 describe('Inject Decorator', function () {
   beforeEach(() => Container.reset());
diff --git a/test/decorators/Service.spec.ts b/test/decorators/Service.spec.ts
@@ -1,7 +1,7 @@
 import 'reflect-metadata';
-import { Container } from '../../src/Container';
-import { Service } from '../../src/decorators/Service';
-import { Token } from '../../src/Token';
+import { Container } from '../../src/container.class';
+import { Service } from '../../src/decorators/service.decorator';
+import { Token } from '../../src/token.class';
 
 describe('Service Decorator', function () {
   beforeEach(() => Container.reset());
diff --git a/test/github-issues/40/issue-40.spec.ts b/test/github-issues/40/issue-40.spec.ts
@@ -1,7 +1,7 @@
 import 'reflect-metadata';
-import { Container } from '../../../src/Container';
-import { Service } from '../../../src/decorators/Service';
-import { Inject } from '../../../src/decorators/Inject';
+import { Container } from '../../../src/container.class';
+import { Service } from '../../../src/decorators/service.decorator';
+import { Inject } from '../../../src/decorators/inject.decorator';
 
 describe('github issues > #40 Constructor inject not working', function () {
   beforeEach(() => Container.reset());
diff --git a/test/github-issues/41/issue-41.spec.ts b/test/github-issues/41/issue-41.spec.ts
@@ -1,7 +1,7 @@
 import 'reflect-metadata';
-import { Container } from '../../../src/Container';
-import { Service } from '../../../src/decorators/Service';
-import { Token } from '../../../src/Token';
+import { Container } from '../../../src/container.class';
+import { Service } from '../../../src/decorators/service.decorator';
+import { Token } from '../../../src/token.class';
 
 describe('github issues > #41 Token as service id in combination with factory', function () {
   beforeEach(() => Container.reset());
diff --git a/test/github-issues/42/issue-42.spec.ts b/test/github-issues/42/issue-42.spec.ts
@@ -1,7 +1,7 @@
 import 'reflect-metadata';
-import { Container } from '../../../src/Container';
-import { Service } from '../../../src/decorators/Service';
-import { Inject } from '../../../src/decorators/Inject';
+import { Container } from '../../../src/container.class';
+import { Service } from '../../../src/decorators/service.decorator';
+import { Inject } from '../../../src/decorators/inject.decorator';
 
 describe('github issues > #42 Exception not thrown on missing binding', function () {
   beforeEach(() => Container.reset());
diff --git a/test/github-issues/48/issue-48.spec.ts b/test/github-issues/48/issue-48.spec.ts
@@ -1,7 +1,7 @@
 import 'reflect-metadata';
-import { Container } from '../../../src/Container';
-import { Service } from '../../../src/decorators/Service';
-import { Token } from '../../../src';
+import { Container } from '../../../src/container.class';
+import { Service } from '../../../src/decorators/service.decorator';
+import { Token } from '../../../src/token.class';
 
 describe("github issues > #48 Token service iDs in global container aren't inherited by scoped containers", function () {
   beforeEach(() => Container.reset());
diff --git a/test/github-issues/53/issue-53.spec.ts b/test/github-issues/53/issue-53.spec.ts
@@ -1,7 +1,7 @@
 import 'reflect-metadata';
-import { Container } from '../../../src/Container';
-import { Service } from '../../../src/decorators/Service';
-import { Token } from '../../../src';
+import { Container } from '../../../src/container.class';
+import { Service } from '../../../src/decorators/service.decorator';
+import { Token } from '../../../src/token.class';
 
 describe('github issues > #53 Token-based services are cached in the Global container even when fetched via a subcontainer', function () {
   beforeEach(() => Container.reset());
diff --git a/test/github-issues/56/issue-56.spec.ts b/test/github-issues/56/issue-56.spec.ts
@@ -1,6 +1,6 @@
 import 'reflect-metadata';
-import { Container } from '../../../src/Container';
-import { Service } from '../../../src/decorators/Service';
+import { Container } from '../../../src/container.class';
+import { Service } from '../../../src/decorators/service.decorator';
 
 describe('github issues > #56 extended class is being overwritten', function () {
   beforeEach(() => Container.reset());
diff --git a/test/github-issues/61/issue-61.spec.ts b/test/github-issues/61/issue-61.spec.ts
@@ -1,6 +1,6 @@
 import 'reflect-metadata';
-import { Container } from '../../../src/Container';
-import { Service } from '../../../src/decorators/Service';
+import { Container } from '../../../src/container.class';
+import { Service } from '../../../src/decorators/service.decorator';
 
 describe('github issues > #61 Scoped container creates new instance of service every time', function () {
   beforeEach(() => Container.reset());

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { ContainerInstance } from '../ContainerInstance';`
	`1`	`+import { ContainerInstance } from '../container-instance.class';`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`* Used to register special "handler" which will be executed on a service class during its initialization.`