@avleon/core 0.0.26 → 0.0.28

package/src/config.ts

@@ -1,42 +1,85 @@
-/**
- * @copyright 2024
- * @author Tareq Hossain
- * @email xtrinsic96@gmail.com
- * @url https://github.com/xtareq
- */
-import { Container, Service, Constructable } from "typedi";
-import { Environment } from "./environment-variables";
-
-
-
-
-export interface IConfig<T = any> {
-  config(env: Environment): T;
-}
-
-export function Config<T extends IConfig>(target: Constructable<T>) {
-  Container.set({ id: target, type: target });
-}
-
-export class AppConfig {
-  get<T extends IConfig<R>, R>(configClass: Constructable<T>): R {
-    const instance = Container.get(configClass);
-    if (!instance) {
-      throw new Error(`Configuration for ${configClass.name} not found.`);
-    }
-    return instance.config(new Environment());
-  }
-}
-
-export function GetConfig<
-  T extends IConfig<R>,
-  R = ReturnType<InstanceType<Constructable<T>>["config"]>,
->(ConfigClass: Constructable<T>): R {
-  const instance = Container.get(ConfigClass);
-  if (!instance) {
-    throw new Error(
-      `Class "${ConfigClass.name}" is not registered as a config.`,
-    );
-  }
-  return instance.config(new Environment());
-}
+/**
+ * @copyright 2024
+ * @author Tareq Hossain
+ * @email xtrinsic96@gmail.com
+ * @url https://github.com/xtareq
+ */
+import { Container, Service, Constructable, Token } from "typedi";
+import { Environment } from "./environment-variables";
+import { inject } from "./helpers";
+
+export interface IConfig<T = any> {
+  config(env: Environment): T;
+}
+
+export function Config<T extends IConfig>(target: Constructable<T>) {
+  Container.set({ id: target, type: target });
+}
+
+export class AppConfig {
+  get<T extends IConfig<R>, R>(configClass: Constructable<T>): R {
+    const instance = Container.get(configClass);
+    if (!instance) {
+      throw new Error(`Configuration for ${configClass.name} not found.`);
+    }
+    return instance.config(new Environment());
+  }
+}
+
+// export function GetConfig<
+//   T extends IConfig<R>,
+//   R = ReturnType<InstanceType<Constructable<T>>["config"]>,
+// >(ConfigClass: Constructable<T>): R {
+//   const instance = Container.get(ConfigClass);
+//   if (!instance) {
+//     throw new Error(
+//       `Class "${ConfigClass.name}" is not registered as a config.`,
+//     );
+//   }
+//   return instance.config(new Environment());
+// }
+
+export function GetConfig<
+  T extends IConfig<R>,
+  R = ReturnType<InstanceType<Constructable<T>>["config"]>,
+>(ConfigClass: Constructable<T>): R;
+
+export function GetConfig<T = any>(config: string | symbol): T;
+
+// Implementation
+export function GetConfig<R>(token: any): R {
+  // 1. Class‐based: token.prototype.config is a function
+  if (
+    typeof token === "function" &&
+    token.prototype != null &&
+    typeof token.prototype.config === "function"
+  ) {
+    const instance = Container.get(token as Constructable<any>);
+    if (!instance) {
+      throw new Error(`Class "${token.name}" is not registered as a config.`);
+    }
+    return instance.config(inject(Environment));
+  }
+
+  // 2. Functional: token is the callback itself
+  const stored = Container.get(token);
+  if (!stored) {
+    throw new Error("Config object is not registered.");
+  }
+  return stored as R;
+}
+
+export function CreateConfig<T>(
+  token: string | symbol,
+  callback: (env: Environment) => T,
+) {
+  let env!: Environment;
+  try {
+    env = Container.get(Environment);
+  } catch (error) {
+    env = new Environment();
+  }
+
+  let config: T = callback(env);
+  Container.set<T>(token as Token<T>, config);
+}

package/src/constants.ts

@@ -1 +1 @@
-export const TEST_DATASOURCE_OPTIONS_KEY = Symbol("itestdatasource");
+export const TEST_DATASOURCE_OPTIONS_KEY = Symbol("itestdatasource");

package/src/container.ts

@@ -1,54 +1,54 @@
-/**
- * @copyright 2024
- * @author Tareq Hossain
- * @email xtrinsic96@gmail.com
- * @url https://github.com/xtareq
- */
-import TypediContainer, { ContainerInstance, Token } from "typedi";
-import { DataSource } from "typeorm";
-
-export const FEATURE_KEY = Symbol.for("features");
-export const ROUTE_META_KEY = Symbol("iroute:options");
-export const CONTROLLER_META_KEY = Symbol("icontroller:options");
-export const PARAM_META_KEY = Symbol("iparam:options");
-export const QUERY_META_KEY = Symbol("iparam:options");
-export const REQUEST_BODY_META_KEY = Symbol("iparam:options");
-export const REQUEST_BODY_FILE_KEY = Symbol("iparam:options");
-export const REQUEST_BODY_FILES_KEY = Symbol("iparam:options");
-export const REQUEST_USER_META_KEY = Symbol("iparam:options");
-export const REQUEST_HEADER_META_KEY = Symbol("iheader:options");
-export const DATASOURCE_META_KEY = Symbol("idatasource:options");
-export const AUTHORIZATION_META_KEY = Symbol("idatasource:authorization");
-
-const controllerRegistry = new Set<Function>();
-const serviceRegistry = new Set<Function>();
-const optionsRegistry = new Map<string, any>();
-
-const Container = TypediContainer;
-
-export function registerController(controller: Function) {
-  controllerRegistry.add(controller);
-}
-export function registerService(service: Function) {
-  Container.set(service, service);
-  serviceRegistry.add(service);
-}
-
-export function getRegisteredServices(): Function[] {
-  return Array.from(serviceRegistry);
-}
-export function getRegisteredControllers(): Function[] {
-  return Array.from(controllerRegistry);
-}
-
-export const API_CONTROLLER_METADATA_KEY = Symbol("apiController");
-
-export function isApiController(target: Function): boolean {
-  return Reflect.getMetadata(API_CONTROLLER_METADATA_KEY, target) === true;
-}
-Container.set<string>("appName", "Iqra");
-
-export function registerDataSource(dataSource: any) {
-  Container.set<DataSource>("idatasource", dataSource);
-}
-export default Container;
+/**
+ * @copyright 2024
+ * @author Tareq Hossain
+ * @email xtrinsic96@gmail.com
+ * @url https://github.com/xtareq
+ */
+import TypediContainer, { ContainerInstance, Token } from "typedi";
+import { DataSource } from "typeorm";
+
+export const FEATURE_KEY = Symbol.for("features");
+export const ROUTE_META_KEY = Symbol("iroute:options");
+export const CONTROLLER_META_KEY = Symbol("icontroller:options");
+export const PARAM_META_KEY = Symbol("iparam:options");
+export const QUERY_META_KEY = Symbol("iparam:options");
+export const REQUEST_BODY_META_KEY = Symbol("iparam:options");
+export const REQUEST_BODY_FILE_KEY = Symbol("iparam:options");
+export const REQUEST_BODY_FILES_KEY = Symbol("iparam:options");
+export const REQUEST_USER_META_KEY = Symbol("iparam:options");
+export const REQUEST_HEADER_META_KEY = Symbol("iheader:options");
+export const DATASOURCE_META_KEY = Symbol("idatasource:options");
+export const AUTHORIZATION_META_KEY = Symbol("idatasource:authorization");
+
+const controllerRegistry = new Set<Function>();
+const serviceRegistry = new Set<Function>();
+const optionsRegistry = new Map<string, any>();
+
+const Container = TypediContainer;
+
+export function registerController(controller: Function) {
+  controllerRegistry.add(controller);
+}
+export function registerService(service: Function) {
+  Container.set(service, service);
+  serviceRegistry.add(service);
+}
+
+export function getRegisteredServices(): Function[] {
+  return Array.from(serviceRegistry);
+}
+export function getRegisteredControllers(): Function[] {
+  return Array.from(controllerRegistry);
+}
+
+export const API_CONTROLLER_METADATA_KEY = Symbol("apiController");
+
+export function isApiController(target: Function): boolean {
+  return Reflect.getMetadata(API_CONTROLLER_METADATA_KEY, target) === true;
+}
+Container.set<string>("appName", "Iqra");
+
+export function registerDataSource(dataSource: any) {
+  Container.set<DataSource>("idatasource", dataSource);
+}
+export default Container;

package/src/controller.ts

@@ -1,127 +1,125 @@
-/**
- * @copyright 2024
- * @author Tareq Hossain
- * @email xtrinsic96@gmail.com
- * @url https://github.com/xtareq
- */
-
-import Container, { Service } from "typedi";
-import container, {
-  API_CONTROLLER_METADATA_KEY,
-  CONTROLLER_META_KEY,
-  registerController,
-} from "./container";
-
-/**
- * Options for configuring a controller.
- * @remarks
- * Controller default options
- * @type {Object} ControllerOptions
- * @property {string} [name] - The name of the controller.
- * @property {string} [path] - The base path for the controller's routes.
- * @property {string} [version] - The version of the controller. If not provided, it will default to the version from `package.json`.
- * @property {string} [since] - The date or version since the controller was introduced.
- * @property {any} [meta] - Additional metadata associated with the controller.
- */
-export type ControllerOptions = {
-  /**
-   *@property {string} name
-   *@description Name of the controller. If specified it'll used as  swagger tags
-   *@default Contorller class name
-   * */
-  name?: string;
-  path?: string;
-  version?: string; // Will look at package.json if not set
-  since?: string;
-  meta?: any;
-};
-
-export function createControllerDecorator(
-  type: "api" | "web" = "web",
-): (
-  pathOrOptions?: string | ControllerOptions,
-  maybeOptions?: ControllerOptions,
-) => ClassDecorator {
-  return function (
-    pathOrOptions?: string | ControllerOptions,
-    maybeOptions?: ControllerOptions,
-  ): ClassDecorator {
-    return function (target: Function) {
-      let path = "/";
-      let options: ControllerOptions = {};
-
-      if (typeof pathOrOptions === "string") {
-        path = pathOrOptions;
-        options = maybeOptions || {};
-      } else if (typeof pathOrOptions === "object") {
-        options = pathOrOptions;
-        path = options.path || "/";
-      }
-      Reflect.defineMetadata(API_CONTROLLER_METADATA_KEY, true, target);
-      // Ensure Service is applied as a ClassDecorator
-      if (typeof Service === "function") {
-        registerController(target); // Add to custom registry
-        Service()(target); // Apply DI decorator
-        Reflect.defineMetadata(
-          CONTROLLER_META_KEY,
-          { type, path, options },
-          target,
-        );
-      } else {
-        throw new Error("Service decorator is not a function");
-      }
-    };
-  };
-}
-
-// Predefined Controller Decorators
-//export const Controller = createControllerDecorator("web");
-/**
- *@description Api controller's are used for rest . It will populate
- * json on return and all it http methods {get} {post} etc must return
- *Results.*
- * @param path {string} this will used as route prefix
- *
- **/
-
-export function ApiController(target: Function): void;
-export function ApiController(path: string): ClassDecorator;
-/**
- *@description Api controller's are used for rest . It will populate
- * json on return and all it http methods {get} {post} etc must return
- * Results.*
- * @param {ControllerOptions} options this will used as route prefix
- *
- **/
-export function ApiController(options: ControllerOptions): ClassDecorator;
-export function ApiController(
-  path: string,
-  options?: ControllerOptions,
-): ClassDecorator;
-export function ApiController(
-  pathOrOptions: Function | string | ControllerOptions = "/",
-  mayBeOptions?: ControllerOptions,
-): any {
-  if (typeof pathOrOptions == 'function') {
-    Reflect.defineMetadata(API_CONTROLLER_METADATA_KEY, true, pathOrOptions);
-    // Ensure Service is applied as a ClassDecorator
-    if (typeof Service === "function") {
-      registerController(pathOrOptions); // Add to custom registry
-      Service()(pathOrOptions); // Apply DI decorator
-      Reflect.defineMetadata(
-        CONTROLLER_META_KEY,
-        { type: 'api', path: "/", options: {} },
-        pathOrOptions,
-      );
-    } else {
-      throw new Error("Service decorator is not a function");
-    }
-  } else {
-    if (mayBeOptions) {
-      return createControllerDecorator("api")(pathOrOptions, mayBeOptions);
-    }
-    return createControllerDecorator("api")(pathOrOptions);
-  }
-
-}
-
+/**
+ * @copyright 2024
+ * @author Tareq Hossain
+ * @email xtrinsic96@gmail.com
+ * @url https://github.com/xtareq
+ */
+
+import Container, { Service } from "typedi";
+import container, {
+  API_CONTROLLER_METADATA_KEY,
+  CONTROLLER_META_KEY,
+  registerController,
+} from "./container";
+
+/**
+ * Options for configuring a controller.
+ * @remarks
+ * Controller default options
+ * @type {Object} ControllerOptions
+ * @property {string} [name] - The name of the controller.
+ * @property {string} [path] - The base path for the controller's routes.
+ * @property {string} [version] - The version of the controller. If not provided, it will default to the version from `package.json`.
+ * @property {string} [since] - The date or version since the controller was introduced.
+ * @property {any} [meta] - Additional metadata associated with the controller.
+ */
+export type ControllerOptions = {
+  /**
+   *@property {string} name
+   *@description Name of the controller. If specified it'll used as  swagger tags
+   *@default Contorller class name
+   * */
+  name?: string;
+  path?: string;
+  version?: string; // Will look at package.json if not set
+  since?: string;
+  meta?: any;
+};
+
+export function createControllerDecorator(
+  type: "api" | "web" = "web",
+): (
+  pathOrOptions?: string | ControllerOptions,
+  maybeOptions?: ControllerOptions,
+) => ClassDecorator {
+  return function (
+    pathOrOptions?: string | ControllerOptions,
+    maybeOptions?: ControllerOptions,
+  ): ClassDecorator {
+    return function (target: Function) {
+      let path = "/";
+      let options: ControllerOptions = {};
+
+      if (typeof pathOrOptions === "string") {
+        path = pathOrOptions;
+        options = maybeOptions || {};
+      } else if (typeof pathOrOptions === "object") {
+        options = pathOrOptions;
+        path = options.path || "/";
+      }
+      Reflect.defineMetadata(API_CONTROLLER_METADATA_KEY, true, target);
+      // Ensure Service is applied as a ClassDecorator
+      if (typeof Service === "function") {
+        registerController(target); // Add to custom registry
+        Service()(target); // Apply DI decorator
+        Reflect.defineMetadata(
+          CONTROLLER_META_KEY,
+          { type, path, options },
+          target,
+        );
+      } else {
+        throw new Error("Service decorator is not a function");
+      }
+    };
+  };
+}
+
+// Predefined Controller Decorators
+//export const Controller = createControllerDecorator("web");
+/**
+ *@description Api controller's are used for rest . It will populate
+ * json on return and all it http methods {get} {post} etc must return
+ *Results.*
+ * @param path {string} this will used as route prefix
+ *
+ **/
+
+export function ApiController(target: Function): void;
+export function ApiController(path: string): ClassDecorator;
+/**
+ *@description Api controller's are used for rest . It will populate
+ * json on return and all it http methods {get} {post} etc must return
+ * Results.*
+ * @param {ControllerOptions} options this will used as route prefix
+ *
+ **/
+export function ApiController(options: ControllerOptions): ClassDecorator;
+export function ApiController(
+  path: string,
+  options?: ControllerOptions,
+): ClassDecorator;
+export function ApiController(
+  pathOrOptions: Function | string | ControllerOptions = "/",
+  mayBeOptions?: ControllerOptions,
+): any {
+  if (typeof pathOrOptions == "function") {
+    Reflect.defineMetadata(API_CONTROLLER_METADATA_KEY, true, pathOrOptions);
+    // Ensure Service is applied as a ClassDecorator
+    if (typeof Service === "function") {
+      registerController(pathOrOptions); // Add to custom registry
+      Service()(pathOrOptions); // Apply DI decorator
+      Reflect.defineMetadata(
+        CONTROLLER_META_KEY,
+        { type: "api", path: "/", options: {} },
+        pathOrOptions,
+      );
+    } else {
+      throw new Error("Service decorator is not a function");
+    }
+  } else {
+    if (mayBeOptions) {
+      return createControllerDecorator("api")(pathOrOptions, mayBeOptions);
+    }
+    return createControllerDecorator("api")(pathOrOptions);
+  }
+}

package/src/decorators.ts

@@ -1,27 +1,27 @@
-/**
- * @copyright 2024
- * @author Tareq Hossain
- * @email xtrinsic96@gmail.com
- * @url https://github.com/xtareq
- */
-
-import { Service as _service } from "typedi";
-import container, { registerService } from "./container";
-export function AppService(target: any): void;
-export function AppService(): any;
-export function AppService(target?: any) {
-  if (target) {
-    _service()(target);
-  } else {
-    return function (tg: any) {
-      _service()(tg);
-    };
-  }
-}
-
-export * from "./controller";
-export * from "./route-methods";
-export * from "./openapi";
-export const Utility = _service;
-export const Helper = _service;
-export * from "./params";
+/**
+ * @copyright 2024
+ * @author Tareq Hossain
+ * @email xtrinsic96@gmail.com
+ * @url https://github.com/xtareq
+ */
+
+import { Service as _service } from "typedi";
+import container, { registerService } from "./container";
+export function AppService(target: any): void;
+export function AppService(): any;
+export function AppService(target?: any) {
+  if (target) {
+    _service()(target);
+  } else {
+    return function (tg: any) {
+      _service()(tg);
+    };
+  }
+}
+
+export * from "./controller";
+export * from "./route-methods";
+export * from "./openapi";
+export const Utility = _service;
+export const Helper = _service;
+export * from "./params";

package/src/environment-variables.ts

@@ -1,46 +1,53 @@
-/**
- * @copyright 2024
- * @author Tareq Hossain
- * @email xtrinsic96@gmail.com
- * @url https://github.com/xtareq
- */
-
-import dotenv from "dotenv";
-import path from "path";
-import fs from "fs";
-import { Service } from "typedi";
-import { EnvironmentVariableNotFound, SystemUseError } from "./exceptions/system-exception";
-
-dotenv.config({ path: path.join(process.cwd(), ".env") });
-
-@Service()
-export class Environment {
-  private parseEnvFile(filePath: string): any {
-    try {
-      const fileContent = fs.readFileSync(filePath, 'utf8');
-      const parsedEnv = dotenv.parse(fileContent);
-      return { ...parsedEnv, ...process.env };
-    } catch (error) {
-      console.error(`Error parsing .env file: ${error}`);
-      return {};
-    }
-  }
-
-  get<T = any>(key: string): T {
-    const parsedEnv = this.parseEnvFile(path.join(process.cwd(), '.env'));
-    return parsedEnv[key] as T;
-  }
-
-  getOrThrow<T = any>(key: string): T {
-    const parsedEnv = this.parseEnvFile(path.join(process.cwd(), '.env'));
-    if (!Object(parsedEnv).hasOwnProperty(key)) {
-      throw new EnvironmentVariableNotFound(key)
-    }
-    return parsedEnv[key] as T;
-  }
-
-  getAll<T = any>(): T {
-    const parsedEnv = this.parseEnvFile(path.join(process.cwd(), '.env'));
-    return parsedEnv as T;
-  }
-}
+/**
+ * @copyright 2024
+ * @author Tareq Hossain
+ * @email xtrinsic96@gmail.com
+ * @url https://github.com/xtareq
+ */
+
+import dotenv from "dotenv";
+import path from "path";
+import fs, { existsSync } from "fs";
+import { Service } from "typedi";
+import {
+  EnvironmentVariableNotFound,
+  SystemUseError,
+} from "./exceptions/system-exception";
+
+dotenv.config({ path: path.join(process.cwd(), ".env") });
+
+@Service()
+export class Environment {
+  private parseEnvFile(filePath: string): any {
+    try {
+      const isExis = existsSync(filePath);
+      if (!isExis) {
+        return { ...process.env };
+      }
+      const fileContent = fs.readFileSync(filePath, "utf8");
+      const parsedEnv = dotenv.parse(fileContent);
+      return { ...parsedEnv, ...process.env };
+    } catch (error) {
+      console.error(`Error parsing .env file: ${error}`);
+      return {};
+    }
+  }
+
+  get<T = any>(key: string): T {
+    const parsedEnv = this.parseEnvFile(path.join(process.cwd(), ".env"));
+    return parsedEnv[key] as T;
+  }
+
+  getOrThrow<T = any>(key: string): T {
+    const parsedEnv = this.parseEnvFile(path.join(process.cwd(), ".env"));
+    if (!Object(parsedEnv).hasOwnProperty(key)) {
+      throw new EnvironmentVariableNotFound(key);
+    }
+    return parsedEnv[key] as T;
+  }
+
+  getAll<T = any>(): T {
+    const parsedEnv = this.parseEnvFile(path.join(process.cwd(), ".env"));
+    return parsedEnv as T;
+  }
+}