@zanobijs/core 1.0.0-beta.2 → 1.0.0-beta.4

package/CHANGELOG.md

@@ -3,6 +3,6 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [1.0.0-beta.2](https://github.com/devdroide/ZanobiJS/compare/v1.0.0-beta.1...v1.0.0-beta.2) (2023-11-08)
+# [1.0.0-beta.4](https://github.com/devdroide/ZanobiJS/compare/v1.0.0-beta.3...v1.0.0-beta.4) (2024-04-12)
 
 **Note:** Version bump only for package @zanobijs/core

package/README.md

@@ -1,11 +1,205 @@
-# `core`
+<p align="center">
+  <a href="https://zanobijs.vercel.app/" target="blank"><img src="https://zanobijs.vercel.app/_astro/ZanobiHero.__7I9OCQ_ZkaY1J.webp" width="120" alt="ZanobiJS Logo" /></a>
+</p>
 
-> TODO: description
+<H1 align="center">Welcome to ZanobiJS</H1>
 
-## Usage
+[![npm](https://img.shields.io/badge/npm-v1.0.0-darkorange.svg)](https://www.npmjs.com/package/@zanobijs/cli)
+[![coverage](https://img.shields.io/badge/coverage-98-green.svg)](https://mochajs.org/)
+[![test](https://img.shields.io/badge/test-mocha-CC0000.svg)](https://mochajs.org/)
+[![nodejs](https://img.shields.io/badge/nodejs->=16.0.0-darkgreen.svg)](https://nodejs.org)
+[![typescrit](https://img.shields.io/badge/TS->=5.2.2-darkblue.svg)](https://www.typescriptlang.org/)
+[![licence](https://img.shields.io/badge/licence-MIT-purple.svg)](https://en.wikipedia.org/wiki/MIT_License)
+[![Doc](https://img.shields.io/badge/ZNB-Documentation-blue.svg)](https://zanobijs.vercel.app/)
 
+It is a mini-framework for Node.js that allows you to build server-side microservices in an efficient and scalable way. It is designed to be small and efficient, but powerful enough for enterprise applications. ZanobiJS is written in TypeScript and JavaScript, giving you the flexibility to choose the language you prefer.
+## Features
+
+- Small and efficient.
+- Written in TypeScript/JavaScript.
+- Ideal for building server-side microservices.
+- Optimized scalability and performance.
+
+## Getting started
+
+If you want to consult the [guide](https://zanobijs.vercel.app/en/) and learn about the project, visit [zanobijs.vercel.app](https://zanobijs.vercel.app/en/)
+
+## Installation
+
+Install my-project with npm
+
+```bash
+  npm install @zanobijs/common @zanobijs/core
 ```
-const core = require('core');
+    
+## Directories
+
+    ├── ...
+    ├── example                   # Feature example
+    │   ├── example.controller.ts # Controller
+    |   ├── example.service.ts    # Service
+    ├── app.module.ts             # Main Module
+    ├── index.ts                  # Handler or bootstrap
+    └── ...
+## Usage/Examples
+
+### example.service.ts
+
+```javascript
+import { Inject, Injectable } from "@zanobijs/common";
+
+@Injectable()
+export class ServiceExample {
+  constructor(
+    @Inject("API_CLIENT") private apiClient: string,
+    @Inject("API_KEY") private apiKey: string
+  ) {}
+  getHello() {
+    return "Hello ServiceExample";
+  }
+  getApiClient(){
+    return this.apiClient
+  }
+  getApiKey(){
+    return this.apiKey
+  }
+}
 
-// TODO: DEMONSTRATE API
 ```
+### example.controller.ts
+
+```javascript
+import { Controller, Inject } from "@zanobijs/common";
+import { ServiceExample } from "./example.service";
+
+@Controller()
+export class ControllerExample {
+  constructor(
+    private sExample: ServiceExample,
+    @Inject("API_URL") private apiUrl: string
+  ) {
+    this.apiUrl = apiUrl;
+  }
+
+  getApiUrl() {
+    return this.apiUrl;
+  }
+  getHelloService() {
+    return this.sExample.getHello();
+  }
+  getClienteService() {
+    return this.sExample.getApiClient();
+  }
+  getKeyService() {
+    return this.sExample.getApiKey();
+  }
+}
+```
+### AppModule.ts
+
+```javascript
+import { Module } from "@zanobijs/common";
+import { ControllerExample } from "./example/example.controller";
+import { ServiceExample } from "./example/example.service";
+
+@Module({
+  imports: [],
+  controllers: [ControllerExample],
+  services: [
+    ServiceExample,
+    {
+      provider: "API_URL",
+      useValue: "https://url.com",
+    },
+    {
+      provider: "API_KEY",
+      useValue: "myKey12345API",
+    },
+    {
+      provider: "API_CLIENT",
+      useValue: "thisClientAPI",
+    },
+  ],
+  exports: [],
+})
+export class AppModule {}
+
+```
+
+### Index.ts
+
+```javascript
+import { Factory } from "@zanobijs/core";
+import { AppModule } from "./app.module";
+import { ControllerExample } from "./example/example.controller";
+
+
+const bootstrap = () => {
+  const factory = new Factory(AppModule);
+  const app = factory.create();
+  const controllerExample = app.get<ControllerExample>(
+    "controllerExample"
+  );
+  console.log(controllerExample.getHelloService());
+  console.log(controllerExample.getApiUrl());
+  console.log(controllerExample.getClienteService());
+  console.log(controllerExample.getKeyService());
+}
+bootstrap();
+// Hello ServiceExample
+// https://url.com
+// thisClientAPI
+// myKey12345API
+```
+> [!Note]
+> It can also be used in [AWS lambda](https://zanobijs.vercel.app/en/01-getting-started/first-step/#setting), see how to do it in the [guide](https://zanobijs.vercel.app/en/01-getting-started/first-step/#setting)
+
+## Use Logger
+
+- Import logger service of @zanobij/common/utils.
+- Define whether the record is visible. [Default is false]
+- Get the service.
+- Use the different events (success, info, warn, error, debug).
+
+```javascript
+// Index.ts - This is important for the operation
+const factory = new Factory(AppModule, {
+  activeLoggerUser: true
+});
+
+// use en services controllers, etc
+
+import { LoggerUser } from "@zanobijs/common/utils";
+
+const logUser = LoggerUser();
+
+logUser.success("Lorem ipsum success");
+logUser.info("Lorem ipsum info");
+logUser.warn("Lorem ipsum warn");
+logUser.error("Lorem ipsum error");
+logUser.debug("Lorem ipsum debug");
+
+// ***** PRINT *****
+// [SUCCESS]: Lorem ipsum success     <green print>
+// [INFO]: Lorem ipsum info           <blue print>
+// [WARN]: Lorem ipsum warn           <yellow print>
+// [ERROR]: Lorem ipsum error         <red print>
+// [DEBUG]: Lorem ipsum debug         <white print>
+
+```
+## Authors
+
+- [@devdroide](https://www.github.com/devdroide)
+
+
+## Credits
+
+ZanobiJS is heavily inspired by [NestJS](https://nestjs.com/) and [AngularJS](https://angularjs.org/).
+
+Additionally, it is used [Awilix](https://github.com/jeffijoe/awilix#readme) which is a container for Extremely powerful and effective dependency injection.
+
+Finally, it is an effort that we make and that we hope can help in the construction of projects.
+
+## License
+
+Private - Read License

package/exceptions/constant.message.d.ts

@@ -1 +1,2 @@
 export declare const MODULE_INVALID_ANNOTATION_ERROR: () => string;
+export declare const CONTAINER_RESOLUTION_ERROR: (entity: string) => string;

package/exceptions/constant.message.js

@@ -1,5 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MODULE_INVALID_ANNOTATION_ERROR = void 0;
+exports.CONTAINER_RESOLUTION_ERROR = exports.MODULE_INVALID_ANNOTATION_ERROR = void 0;
 const MODULE_INVALID_ANNOTATION_ERROR = () => `The class must have an annotation @Module()`;
 exports.MODULE_INVALID_ANNOTATION_ERROR = MODULE_INVALID_ANNOTATION_ERROR;
+const CONTAINER_RESOLUTION_ERROR = (entity) => `'${entity}' is not registered in any @module.`;
+exports.CONTAINER_RESOLUTION_ERROR = CONTAINER_RESOLUTION_ERROR;
+// export const CONTAINER_RESOLUTION_INJECT_ERROR = (
+//   entity: string,
+//   targetName: any,
+// ) =>
+//   `'@Inject(${entity})' was not found in any loaded @module. Check the "${targetName}" file`;

package/exceptions/resolution.exception.d.ts

@@ -0,0 +1,13 @@
+import { RuntimeException } from "@zanobijs/common/exceptions/runtime.exception";
+/**
+ * Excepción lanzada cuando se intenta obtener una entidad
+ * (importar, controlador, servicio o exportar) que no fue
+ * declarada en `@Module` de @zanobijs/common
+ *
+ * @remarks
+ * Esta clase extiende la base `RuntimeException`de @zanobijs/core
+ * para proporcionar detalles adicionales del error.
+ */
+export declare class ContainerResolutionException extends RuntimeException {
+    constructor(entity: string, detail: any);
+}

package/exceptions/resolution.exception.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContainerResolutionException = void 0;
+const runtime_exception_1 = require("@zanobijs/common/exceptions/runtime.exception");
+const constant_message_1 = require("./constant.message");
+/**
+ * Excepción lanzada cuando se intenta obtener una entidad
+ * (importar, controlador, servicio o exportar) que no fue
+ * declarada en `@Module` de @zanobijs/common
+ *
+ * @remarks
+ * Esta clase extiende la base `RuntimeException`de @zanobijs/core
+ * para proporcionar detalles adicionales del error.
+ */
+class ContainerResolutionException extends runtime_exception_1.RuntimeException {
+    constructor(entity, detail) {
+        super((0, constant_message_1.CONTAINER_RESOLUTION_ERROR)(entity), detail);
+    }
+}
+exports.ContainerResolutionException = ContainerResolutionException;
+// export class ContainerInjectResolutionException extends RuntimeException {
+//   constructor(entity: string, targetName: any, detail: any = ``) {
+//     super(CONTAINER_RESOLUTION_INJECT_ERROR(entity, targetName), detail);
+//   }
+// }

package/factory.d.ts

@@ -1,4 +1,5 @@
 import "reflect-metadata";
+import { IFactoryOptions } from "./interfaces";
 /**
  * Factory es una clase que facilita la creación y configuración de
  * contenedores de inyección de dependencias utilizando metadatos y
@@ -9,7 +10,9 @@ export declare class Factory {
     private moduleHandler;
     private registeredClasses;
     private container;
-    constructor(appModule: any);
+    private logger;
+    private options;
+    constructor(appModule: any, options?: IFactoryOptions);
     /**
      * Este método registra clases desde el módulo proporcionado
      * y recorre sus importaciones de forma recursiva para registrar
@@ -34,4 +37,5 @@ export declare class Factory {
      * @returns {any} - Instancia resuelta.
      */
     get<T>(entity: string): T;
+    evaluateOptions(): void;
 }

package/factory.js

@@ -4,6 +4,8 @@ exports.Factory = void 0;
 require("reflect-metadata");
 const awilix_1 = require("awilix");
 const module_1 = require("./injector/module");
+const resolution_exception_1 = require("./exceptions/resolution.exception");
+const utils_1 = require("@zanobijs/common/utils");
 /**
  * Factory es una clase que facilita la creación y configuración de
  * contenedores de inyección de dependencias utilizando metadatos y
@@ -14,7 +16,12 @@ class Factory {
     moduleHandler;
     registeredClasses = {};
     container;
-    constructor(appModule) {
+    logger;
+    options;
+    constructor(appModule, options = {}) {
+        this.options = options;
+        this.evaluateOptions();
+        this.logger = (0, utils_1.Logger)();
         this.moduleHandler = new module_1.Module();
         this.registerClassesFromModule(appModule);
     }
@@ -50,6 +57,7 @@ class Factory {
     create() {
         this.container = (0, awilix_1.createContainer)({ injectionMode: awilix_1.InjectionMode.CLASSIC });
         this.container.register(this.registeredClasses);
+        this.logger.info("Registered Classes", this.registeredClasses);
         return this;
     }
     /**
@@ -58,7 +66,19 @@ class Factory {
      * @returns {any} - Instancia resuelta.
      */
     get(entity) {
-        return this.container.resolve(entity);
+        try {
+            return this.container.resolve(entity);
+        }
+        catch (error) {
+            this.logger.info("Error resolving entity: ", error.message + "\n");
+            throw new resolution_exception_1.ContainerResolutionException(entity, error.message);
+        }
+    }
+    evaluateOptions() {
+        if (this.options.activeLoggerSystem)
+            process.env.ZANOBIJS_LOGGER = "true";
+        if (this.options.activeLoggerUser)
+            process.env.ZANOBIJS_LOGGER = "true";
     }
 }
 exports.Factory = Factory;

package/index.d.ts

@@ -1,2 +1,3 @@
 export { Factory } from './factory';
 export * from "./injector";
+export * from "./interfaces";

package/index.js

@@ -5,3 +5,4 @@ const tslib_1 = require("tslib");
 var factory_1 = require("./factory");
 Object.defineProperty(exports, "Factory", { enumerable: true, get: function () { return factory_1.Factory; } });
 tslib_1.__exportStar(require("./injector"), exports);
+tslib_1.__exportStar(require("./interfaces"), exports);

package/injector/injector.d.ts

@@ -10,6 +10,8 @@ export declare class Injector {
     private listProviders;
     private metadata;
     private logger;
+    private registeredClassParentModule;
+    private moduleName;
     /**
      * En Constructor de la clase Injector obtenermos las instancias
      * de Metadata y Logger e inciamos el escaneo de proveedores.
@@ -24,6 +26,7 @@ export declare class Injector {
      * @private
      */
     private scanProviders;
+    setRegisteredClassParentModule(registerClass: any): void;
     /**
      * Método para obtener un objeto con los parámetros y valores
      * que se inyectarán en la clase (target).
@@ -54,7 +57,10 @@ export declare class Injector {
         name?: string;
         lifetime?: import("awilix").LifetimeType;
         register?: (...args: any[]) => import("awilix").Resolver<object>;
+        isLeakSafe?: boolean;
         dispose?: import("awilix").Disposer<object>;
         disposer(dispose: import("awilix").Disposer<object>): import("awilix").BuildResolver<object> & import("awilix").DisposableResolver<object>;
     };
+    getAllProvider(): Map<any, any>;
+    getInjectProvider(provider: any): import("awilix").Resolver<any>;
 }

package/injector/injector.js

@@ -14,6 +14,8 @@ class Injector {
     listProviders = new Map();
     metadata;
     logger;
+    registeredClassParentModule = {};
+    moduleName = "";
     /**
      * En Constructor de la clase Injector obtenermos las instancias
      * de Metadata y Logger e inciamos el escaneo de proveedores.
@@ -23,6 +25,7 @@ class Injector {
     constructor(module) {
         this.metadata = metadata_1.Metadata.getInstance();
         this.logger = (0, utils_1.Logger)();
+        this.moduleName = module.name;
         this.module = module;
         this.scanProviders();
     }
@@ -40,6 +43,9 @@ class Injector {
         });
         this.logger.debug("Injector - list provider", this.listProviders);
     }
+    setRegisteredClassParentModule(registerClass) {
+        this.registeredClassParentModule = registerClass;
+    }
     /**
      * Método para obtener un objeto con los parámetros y valores
      * que se inyectarán en la clase (target).
@@ -58,6 +64,17 @@ class Injector {
                     const useValue = this.listProviders.get(key);
                     injectData[paramName] = useValue;
                 }
+                else {
+                    if (key in this.registeredClassParentModule) {
+                        this.logger.info(`"${key}" is on registered Class in Parent Module.`);
+                        const paramName = dInject.get(key);
+                        injectData[paramName] = (0, awilix_1.aliasTo)(key);
+                    }
+                    else {
+                        this.logger.important(`It is injecting @INJECT('${key}') provider in '${target.name}' but is not registered in '${this.moduleName}' or in previously loaded @modules`);
+                        // throw new ContainerInjectResolutionException(key, target.name);
+                    }
+                }
             }
         }
         return injectData;
@@ -79,5 +96,13 @@ class Injector {
             interface: target,
         };
     }
+    getAllProvider() {
+        return this.listProviders;
+    }
+    getInjectProvider(provider) {
+        return typeof provider.value === "function"
+            ? (0, awilix_1.asFunction)(provider.value).scoped()
+            : (0, awilix_1.asValue)(provider.value);
+    }
 }
 exports.Injector = Injector;

package/injector/module.d.ts

@@ -63,6 +63,7 @@ export declare class Module {
      * contructor(private sA: ServiceA) // parametro con nombre diferente
      */
     private registerDependenciesToAlias;
+    private registerAllProviders;
     /**
      * Devuelve las importaciones del módulo.
      * @returns {any[] | undefined} - Importaciones del módulo.

package/injector/module.js

@@ -45,6 +45,8 @@ class Module {
      */
     initialize() {
         this.getMetadataModule();
+        this.registerAllProviders();
+        this.injector.setRegisteredClassParentModule(this.registerClass);
         this.registerDependencies();
         this.registerDependenciesToAlias();
     }
@@ -72,12 +74,17 @@ class Module {
         const entities = this.config[entityType];
         if (entities && entities.length > 0) {
             const registeredEntities = entities
-                .filter((target) => (0, shared_utils_1.isClass)(target) &&
-                this.types.includes(this.metadata.determineType(target)))
+                .filter((target) => {
+                return ((0, shared_utils_1.isClass)(target) &&
+                    this.types.includes(this.metadata.determineType(target)));
+            })
                 .map((target) => {
                 this.groupDependenciesForAlias(target);
                 const targetName = (0, shared_utils_1.unCapitalize)(target.name);
-                return { [targetName]: this.injector.getInjector(target) };
+                return {
+                    [target.name]: this.injector.getInjector(target),
+                    [targetName]: (0, awilix_1.aliasTo)(target.name),
+                };
             });
             Object.assign(this.registerClass, ...registeredEntities);
         }
@@ -116,6 +123,17 @@ class Module {
             }
         });
     }
+    registerAllProviders() {
+        const listProviders = this.injector.getAllProvider();
+        listProviders.forEach((value, key) => {
+            const providerInject = this.injector.getInjectProvider({
+                key,
+                value,
+            });
+            this.registerClass[key] = providerInject;
+            this.registerClass[(0, shared_utils_1.snakeToCamel)(key)] = (0, awilix_1.aliasTo)(key);
+        });
+    }
     /**
      * Devuelve las importaciones del módulo.
      * @returns {any[] | undefined} - Importaciones del módulo.

package/interfaces/factory.interface.d.ts

@@ -0,0 +1,4 @@
+export interface IFactoryOptions {
+    activeLoggerSystem?: boolean;
+    activeLoggerUser?: boolean;
+}

package/interfaces/factory.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/interfaces/index.d.ts

@@ -0,0 +1 @@
+export * from "./factory.interface";

package/{__test__/mocks → interfaces}/index.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./classModule.mock"), exports);
+tslib_1.__exportStar(require("./factory.interface"), exports);

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "@zanobijs/core",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0-beta.4",
   "description": "Zanobi - modern, small, powerful node.js lambda framework (@core)",
   "keywords": [],
   "author": "John Edison Cortes Rivera [Devdroide] <johne.aplicativos@gmail.com>",
   "license": "ZanobiJS Usage License \n\n Review the LICENSE file.\n\n Revise el archivo de LICENCIA.",
-  "main": "index.js",
   "typings": "index.d.ts",
   "repository": {
     "type": "git",
@@ -24,11 +23,11 @@
   },
   "homepage": "https://github.com/devdroide/ZanobiJS#readme",
   "dependencies": {
-    "awilix": "^9.0.0",
+    "awilix": "10.0.2",
     "reflect-metadata": "^0.1.13"
   },
   "peerDependencies": {
     "@zanobijs/common": "*"
   },
-  "gitHead": "ad80511a5c3d7151aa4e722435df24a616bc1504"
+  "gitHead": "fd630539d6115c6aa87037f5839011c9e6e42384"
 }

package/tsconfig.build.json

@@ -8,7 +8,7 @@
       "@zanobijs/common/*": ["../common/*"]
     }
   },
-  "exclude": ["node_modules", "dist", "test/**/*", "*.spec.ts"],
+  "exclude": ["node_modules", "dist", "__test__/**/*", "*.spec.ts"],
   "references": [
     {
       "path": "../common/tsconfig.build.json"

package/__test__/factory.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/__test__/factory.spec.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const chai_1 = require("chai");
-// import { Module } from "@zanobijs/common";
-const index_1 = require("../index");
-const classModule_mock_1 = require("./mocks/classModule.mock");
-describe("Core - factory", () => {
-    const factory = new index_1.Factory(classModule_mock_1.ModuleTestAll);
-    describe("Create Factory App", () => {
-        it("should respond error to create factory by error @Module", () => {
-            class ModuleWithoutDecorator {
-            }
-            try {
-                new index_1.Factory(ModuleWithoutDecorator);
-            }
-            catch (error) {
-                (0, chai_1.expect)(error.message).to.be.equal("The class must have an annotation @Module()");
-            }
-        });
-        it("should respond create factory", () => {
-            const app = factory.create();
-            (0, chai_1.expect)(app).to.be.instanceOf(index_1.Factory);
-        });
-    });
-    describe("Get Entities", () => {
-        it("should respond apiKey to controller the app", () => {
-            const app = factory.create();
-            const controllerWithDepen2 = app.get("controllerWithDepen2");
-            (0, chai_1.expect)(controllerWithDepen2.getApiKey()).to.be.equal("isApiKey_qwerty12345");
-        });
-    });
-    // it("", () => {});
-});

package/__test__/factory.spec.ts

@@ -1,37 +0,0 @@
-import { expect } from "chai";
-// import { Module } from "@zanobijs/common";
-import { Factory } from "../index";
-import { ModuleTestAll } from "./mocks/classModule.mock";
-import { ControllerWithDepen2 } from "./mocks/classWithDependeciesInject.mock";
-
-describe("Core - factory", () => {
-  const factory = new Factory(ModuleTestAll);
-  describe("Create Factory App", () => {
-    it("should respond error to create factory by error @Module", () => {
-      class ModuleWithoutDecorator {}
-      try {
-        new Factory(ModuleWithoutDecorator);
-      } catch (error) {
-        expect(error.message).to.be.equal(
-          "The class must have an annotation @Module()",
-        );
-      }
-    });
-    it("should respond create factory", () => {
-      const app = factory.create();
-      expect(app).to.be.instanceOf(Factory);
-    });
-  });
-  describe("Get Entities", () => {
-    it("should respond apiKey to controller the app", () => {
-      const app = factory.create();
-      const controllerWithDepen2 = app.get<ControllerWithDepen2>(
-        "controllerWithDepen2",
-      );
-      expect(controllerWithDepen2.getApiKey()).to.be.equal(
-        "isApiKey_qwerty12345",
-      );
-    });
-  });
-  // it("", () => {});
-});

package/__test__/injector/injector.spec.d.ts

@@ -1 +0,0 @@
-export {};