Merge pull request #67 from AthennaIO/develop

chore(module): export Annotation helper

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/ioc",
-  "version": "4.3.0",
+  "version": "4.4.0",
   "description": "Global Ioc helper for Athenna ecosystem. Built on top of awilix.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",

src/annotations/Service.ts

@@ -36,6 +36,6 @@ export function Service(options?: ServiceOptions): ClassDecorator {
       return
     }
 
-    Annotation.defineServiceMeta(target, options)
+    Annotation.defineMeta(target, options)
   }
 }

src/container/Ioc.ts

@@ -245,6 +245,10 @@ export class Ioc {
       this.alias(String.toCamelCase(subAlias), meta.alias)
     }
 
+    if (meta.name) {
+      this.alias(meta.name, meta.alias)
+    }
+
     if (meta.camelAlias) {
       this.alias(meta.camelAlias, meta.alias)
     }

src/helpers/Annotation.ts

@@ -7,78 +7,67 @@
  * file that was distributed with this source code.
  */
 
-import {
-  IOC_TYPE,
-  IOC_ALIAS,
-  IOC_REGISTERED,
-  IOC_CAMEL_ALIAS
-} from '#src/constants/MetadataKeys'
 import { Options } from '@athenna/common'
 import type { ServiceOptions } from '#src'
 
 export type ServiceMeta = {
   type: string
   alias: string
   camelAlias?: string
-  isRegistered: boolean
+  registered: boolean
+  [key: string]: any
 }
 
 export class Annotation {
   /**
    * Verify if provider is decorated or not.
    */
   public static isAnnotated(target: any): boolean {
-    return Reflect.hasMetadata(IOC_REGISTERED, target)
+    return Reflect.hasMetadata('ioc:registered', target)
   }
 
   /**
    * Define all metadata for a service.
    */
-  public static defineServiceMeta(target: any, options: ServiceOptions) {
-    Options.whenDefined(options.type, type => {
-      Reflect.defineMetadata(IOC_TYPE, type, target)
-    })
-
-    Options.whenDefined(options.alias, alias => {
-      Reflect.defineMetadata(IOC_ALIAS, alias, target)
-    })
+  public static defineMeta(target: any, options: ServiceOptions) {
+    Object.keys(options).forEach(key => {
+      const value = options[key]
 
-    Options.whenDefined(options.camelAlias, camelAlias => {
-      Reflect.defineMetadata(IOC_CAMEL_ALIAS, camelAlias, target)
+      Options.whenDefined(value, value => {
+        Reflect.defineMetadata(`ioc:${key}`, value, target)
+      })
     })
 
-    if (Annotation.hasAllMetaDefined(target)) {
-      Reflect.defineMetadata(IOC_REGISTERED, false, target)
-    }
+    Reflect.defineMetadata('ioc:registered', false, target)
   }
 
   /**
    * Define the service as registered.
    */
   public static defineAsRegistered(target: any) {
-    Reflect.defineMetadata(IOC_REGISTERED, true, target)
-  }
-
-  /**
-   * Verify if all metadata is defined in the service.
-   */
-  public static hasAllMetaDefined(target: any) {
-    const hasType = Reflect.hasMetadata(IOC_TYPE, target)
-    const hasAlias = Reflect.hasMetadata(IOC_ALIAS, target)
-
-    return hasType && hasAlias
+    Reflect.defineMetadata('ioc:registered', true, target)
   }
 
   /**
    * Get all the metadata from the service.
    */
   public static getMeta(target: any): ServiceMeta {
-    return {
-      type: Reflect.getMetadata(IOC_TYPE, target) || 'transient',
-      alias:
-        Reflect.getMetadata(IOC_ALIAS, target) || `App/Services/${target.name}`,
-      camelAlias: Reflect.getMetadata(IOC_CAMEL_ALIAS, target),
-      isRegistered: Reflect.getMetadata(IOC_REGISTERED, target)
+    const meta: any = {}
+
+    Reflect.getMetadataKeys(target).forEach(key => {
+      const value = Reflect.getMetadata(key, target)
+
+      meta[key.replace('ioc:', '')] = value
+    })
+
+    if (!meta.type) {
+      meta.type = 'transient'
+    }
+
+    if (!meta.alias) {
+      meta.alias = `App/Services/${target.name}`
     }
+
+    return meta
   }
 }

src/index.ts

@@ -13,6 +13,7 @@ export * from '#src/globals/Ioc'
 
 export * from '#src/container/Ioc'
 export * from '#src/facades/Facade'
+export * from '#src/helpers/Annotation'
 export * from '#src/annotations/Inject'
 export * from '#src/annotations/Service'
 export * from '#src/annotations/InjectStub'

src/types/ServiceOptions.ts

@@ -32,4 +32,6 @@ export type ServiceOptions = {
    * @default 'transient'
    */
   type?: 'fake' | 'scoped' | 'singleton' | 'transient'
+
+  [key: string]: any
 }

tests/fixtures/ClientService.ts

@@ -14,7 +14,9 @@ export interface Client {
   name: string
 }
 
-@Service()
+@Service({
+  name: 'App/Services/Names/ClientService'
+})
 export class ClientService {
   private signature = Math.random()
 

tests/unit/annotations/ServiceAnnotationTest.ts

@@ -22,7 +22,7 @@ export default class ServiceAnnotationTest extends BaseTest {
     assert.equal(metadata.type, 'transient')
     assert.equal(metadata.camelAlias, 'productService')
     assert.equal(metadata.alias, 'App/Services/ProductService')
-    assert.equal(metadata.isRegistered, false)
+    assert.equal(metadata.registered, false)
   }
 
   @Test()

tests/unit/container/IocTest.ts

@@ -208,6 +208,7 @@ export default class IocTest extends BaseTest {
 
     assert.isTrue(container.has('clientService'))
     assert.isTrue(container.has('App/Services/ClientService'))
+    assert.isTrue(container.has('App/Services/Names/ClientService'))
   }
 
   @Test()
@@ -218,5 +219,6 @@ export default class IocTest extends BaseTest {
     assert.isTrue(container.has('App/Services/StringHelper'))
     assert.isTrue(container.has('clientService'))
     assert.isTrue(container.has('App/Services/ClientService'))
+    assert.isTrue(container.has('App/Services/Names/ClientService'))
   }
 }