@avleon/core 0.0.26 → 0.0.28

package/src/icore.ts

@@ -57,7 +57,6 @@ import { MultipartFile } from "./multipart";
 import { validateOrThrow } from "./validation";
 import { optionalRequire } from "./utils";
 
-
 export type FuncRoute = {
   handler: any;
   middlewares?: any[];
@@ -73,11 +72,9 @@ export interface IRequest extends FastifyRequest {
   user?: any;
 }
 
-
-
-export interface DoneFunction extends HookHandlerDoneFunction { }
+export interface DoneFunction extends HookHandlerDoneFunction {}
 // IResponse
-export interface IResponse extends FastifyReply { }
+export interface IResponse extends FastifyReply {}
 
 export type TestResponseType = LightMyRequestResponse;
 export type TestResponse = TestResponseType | Promise<TestResponseType>;
@@ -103,13 +100,13 @@ export interface ParamMetaOptions {
   validatorClass: boolean;
   schema?: any;
   type:
-  | "route:param"
-  | "route:query"
-  | "route:body"
-  | "route:header"
-  | "route:user"
-  | "route:file"
-  | "route:files";
+    | "route:param"
+    | "route:query"
+    | "route:body"
+    | "route:header"
+    | "route:user"
+    | "route:file"
+    | "route:files";
 }
 
 export interface ParamMetaFilesOptions {
@@ -159,7 +156,7 @@ type AvleonApp = FastifyInstance;
 
 export type TestAppOptions = {
   controllers: Constructor[];
-  dataSource?: DataSource
+  dataSource?: DataSource;
 };
 
 export interface AvleonTestAppliction {
@@ -169,9 +166,9 @@ export interface AvleonTestAppliction {
 }
 
 export type AutoControllerOptions = {
-  auto: true,
-  path?: string
-}
+  auto: true;
+  path?: string;
+};
 export interface IAvleonApplication {
   isDevelopment(): boolean;
   useCors(corsOptions?: FastifyCorsOptions): void;
@@ -191,7 +188,7 @@ export interface IAvleonApplication {
   ): void;
 
   useMultipart(options: MultipartOptions): void;
-  useCache(options: any): void
+  useCache(options: any): void;
 
   useMiddlewares<T extends AppMiddleware>(mclasses: Constructor<T>[]): void;
   useAuthoriztion<T extends any>(middleware: Constructor<T>): void;
@@ -235,7 +232,7 @@ export class AvleonApplication {
   private dataSource?: DataSource = undefined;
   private isMapFeatures = false;
   private registerControllerAuto = false;
-  private registerControllerPath = './src';
+  private registerControllerPath = "./src";
 
   private metaCache = new Map<string, MethodParamMeta>();
   private multipartOptions: FastifyMultipartOptions | undefined;
@@ -244,7 +241,6 @@ export class AvleonApplication {
     this.appConfig = new AppConfig();
   }
 
-
   static getApp(): AvleonApplication {
     let isTestEnv = process.env.NODE_ENV == "test";
     if (!AvleonApplication.instance) {
@@ -267,9 +263,7 @@ export class AvleonApplication {
         buildOptions.dataSourceOptions,
       ) as DataSource;
 
-      Container.set<DataSource>("idatasource",
-        datasource,
-      );
+      Container.set<DataSource>("idatasource", datasource);
       AvleonApplication.instance.dataSource = datasource;
     }
     return AvleonApplication.instance;
@@ -280,7 +274,6 @@ export class AvleonApplication {
     return env.get("NODE_ENV") == "development";
   }
 
-
   private async initSwagger(options: OpenApiUiOptions) {
     const { routePrefix, logo, ui, theme, configuration, ...restOptions } =
       options;
@@ -296,26 +289,27 @@ export class AvleonApplication {
     if (options.ui && options.ui == "scalar") {
       const scalarPlugin = optionalRequire("@scalar/fastify-api-reference", {
         failOnMissing: true,
-        customMessage: 'Install "@scalar/fastify-api-reference" to enable API docs.\n\n  npm install @scalar/fastify-api-reference',
+        customMessage:
+          "Install \"@scalar/fastify-api-reference\" to enable API docs.\n\n  npm install @scalar/fastify-api-reference",
       });
       await this.app.register(scalarPlugin, {
         routePrefix: rPrefix as any,
         configuration: configuration
           ? configuration
           : {
-            metaData: {
-              title: "Avleon Api",
-              ogTitle: "Avleon",
+              metaData: {
+                title: "Avleon Api",
+                ogTitle: "Avleon",
+              },
+              theme: options.theme ? options.theme : "kepler",
+              favicon: "/static/favicon.png",
             },
-            theme: options.theme ? options.theme : "kepler",
-            favicon: "/static/favicon.png",
-          },
       });
     } else {
-
       const fastifySwaggerUi = optionalRequire("@fastify/swagger-ui", {
         failOnMissing: true,
-        customMessage: 'Install "@fastify/swagger-ui" to enable API docs.\n\n  npm install @fastify/swagger-ui',
+        customMessage:
+          "Install \"@fastify/swagger-ui\" to enable API docs.\n\n  npm install @fastify/swagger-ui",
       });
       await this.app.register(fastifySwaggerUi, {
         logo: logo ? logo : null,
@@ -327,8 +321,8 @@ export class AvleonApplication {
 
   private _isConfigClass<T>(input: any): input is ConfigClass<T> {
     return (
-      typeof input === 'function' &&
-      typeof input.prototype === 'object' &&
+      typeof input === "function" &&
+      typeof input.prototype === "object" &&
       input.prototype?.constructor === input
     );
   }
@@ -344,9 +338,7 @@ export class AvleonApplication {
     this.app.register(cors, coptions);
   }
 
-  useOpenApi<T = OpenApiUiOptions>(
-    configOrClass: OpenApiConfigInput<T>
-  ) {
+  useOpenApi<T = OpenApiUiOptions>(configOrClass: OpenApiConfigInput<T>) {
     let openApiConfig: T;
     if (this._isConfigClass(configOrClass)) {
       openApiConfig = this.appConfig.get(configOrClass);
@@ -373,9 +365,7 @@ export class AvleonApplication {
     }
   }
 
-
   useDataSource<T extends DataSourceOptions>(options: ConfigInput<T>) {
-
     let dataSourceOptions: T;
     if (this._isConfigClass(options)) {
       dataSourceOptions = this.appConfig.get(options);
@@ -383,28 +373,19 @@ export class AvleonApplication {
       dataSourceOptions = options as T;
     }
 
-    if (!dataSourceOptions) throw new SystemUseError("Invlaid datasource options.")
+    if (!dataSourceOptions)
+      throw new SystemUseError("Invlaid datasource options.");
 
     this.dataSourceOptions = dataSourceOptions;
     const typeorm = require("typeorm");
-    const datasource = new typeorm.DataSource(
-      dataSourceOptions,
-    ) as DataSource;
+    const datasource = new typeorm.DataSource(dataSourceOptions) as DataSource;
 
     this.dataSource = datasource;
 
-    Container.set<DataSource>("idatasource",
-      datasource,
-    );
-
-
+    Container.set<DataSource>("idatasource", datasource);
   }
 
-  private _useCache(options: any) {
-
-  }
-
-
+  private _useCache(options: any) {}
 
   useMiddlewares<T extends AppMiddleware>(mclasses: Constructor<T>[]) {
     for (const mclass of mclasses) {
@@ -414,12 +395,10 @@ export class AvleonApplication {
     }
   }
 
-
   useAuthoriztion<T extends any>(middleware: Constructor<T>) {
     this.authorizeMiddleware = middleware as any;
   }
 
-
   useStaticFiles(
     options: StaticFileOptions = { path: undefined, prefix: undefined },
   ) {
@@ -519,7 +498,6 @@ export class AvleonApplication {
         handler: async (req, res) => {
           let reqClone = req as IRequest;
 
-
           // class level authrization
           if (authClsMeata.authorize && this.authorizeMiddleware) {
             const cls = container.get(this.authorizeMiddleware) as any;
@@ -544,7 +522,11 @@ export class AvleonApplication {
 
           for (let paramMeta of allMeta.params) {
             if (paramMeta.required) {
-              validateOrThrow({ [paramMeta.key]: args[paramMeta.index] }, { [paramMeta.key]: { type: paramMeta.dataType } }, { location: 'param' })
+              validateOrThrow(
+                { [paramMeta.key]: args[paramMeta.index] },
+                { [paramMeta.key]: { type: paramMeta.dataType } },
+                { location: "param" },
+              );
             }
           }
 
@@ -564,7 +546,11 @@ export class AvleonApplication {
               }
             }
             if (queryMeta.required) {
-              validateOrThrow({ [queryMeta.key]: args[queryMeta.index] }, { [queryMeta.key]: { type: queryMeta.dataType } }, { location: 'queryparam' })
+              validateOrThrow(
+                { [queryMeta.key]: args[queryMeta.index] },
+                { [queryMeta.key]: { type: queryMeta.dataType } },
+                { location: "queryparam" },
+              );
             }
           }
 
@@ -622,8 +608,8 @@ export class AvleonApplication {
     meta.currentUser.forEach((user) => (args[user.index] = req.user));
     meta.headers.forEach(
       (header) =>
-      (args[header.index] =
-        header.key === "all" ? req.headers : req.headers[header.key]),
+        (args[header.index] =
+          header.key === "all" ? req.headers : req.headers[header.key]),
     );
 
     if (meta.file) {
@@ -703,12 +689,9 @@ export class AvleonApplication {
       process.env.TS_NODE_DEV ||
       process.env.TS_NODE_PROJECT ||
       (process as any)[Symbol.for("ts-node.register.instance")];
-    const controllerDir = path.join(
-      process.cwd(),
-      this.registerControllerPath
-    );
+    const controllerDir = path.join(process.cwd(), this.registerControllerPath);
 
-    return isTsNode ? controllerDir : controllerDir.replace('src', 'dist')
+    return isTsNode ? controllerDir : controllerDir.replace("src", "dist");
   }
 
   private async autoControllers(controllersPath?: string) {
@@ -723,9 +706,9 @@ export class AvleonApplication {
         const module = await import(filePath);
         for (const exported of Object.values(module)) {
           if (typeof exported === "function" && isApiController(exported)) {
-            console.log('adding', exported.name)
-            if (!this.controllers.some(con => exported.name == con.name)) {
-              this.controllers.push(exported)
+            console.log("adding", exported.name);
+            if (!this.controllers.some((con) => exported.name == con.name)) {
+              this.controllers.push(exported);
             }
 
             //this.buildController(exported);
@@ -736,22 +719,20 @@ export class AvleonApplication {
   }
 
   useControllers(controllers: Constructor[] | AutoControllerOptions) {
-
     if (Array.isArray(controllers)) {
       this.controllers = controllers;
 
-      controllers.forEach(controller => {
+      controllers.forEach((controller) => {
         if (!this.controllers.includes(controller)) {
-          this.controllers.push(controller)
+          this.controllers.push(controller);
         }
-      })
+      });
     } else {
       this.registerControllerAuto = true;
       if (controllers.path) {
         this.registerControllerPath = controllers.path;
       }
     }
-
   }
 
   // addFeature(feature:{controllers:Function[]}){
@@ -765,7 +746,6 @@ export class AvleonApplication {
   // }
 
   private async _mapControllers() {
-
     if (this.controllers.length > 0) {
       for (let controller of this.controllers) {
         if (isApiController(controller)) {
@@ -782,14 +762,12 @@ export class AvleonApplication {
   //     //this.autoControllers();
   // }
 
-
   private async mapFn(fn: Function) {
     const original = fn;
-    fn = function () { };
+    fn = function () {};
     return fn;
   }
 
-
   private _handleError(error: any): {
     code: number;
     error: string;
@@ -877,7 +855,6 @@ export class AvleonApplication {
     return route;
   }
 
-
   mapGet<T extends (...args: any[]) => any>(path: string = "", fn: T) {
     return this._routeHandler(path, "GET", fn);
   }
@@ -894,10 +871,9 @@ export class AvleonApplication {
     return this._routeHandler(path, "DELETE", fn);
   }
 
-
   private _mapFeatures() {
-    const features = Container.get('features');
-    console.log('Features', features);
+    const features = Container.get("features");
+    console.log("Features", features);
   }
 
   async initializeDatabase() {
@@ -938,7 +914,10 @@ export class AvleonApplication {
     });
     this.app.setErrorHandler(async (error, req, res) => {
       const handledErr = this._handleError(error);
-      if (error instanceof ValidationErrorException || error instanceof BadRequestException) {
+      if (
+        error instanceof ValidationErrorException ||
+        error instanceof BadRequestException
+      ) {
         return res.status(handledErr.code).send({
           code: handledErr.code,
           error: handledErr.error,
@@ -997,14 +976,14 @@ export class AvleonApplication {
         options: async (url: string, options?: InjectOptions) =>
           this.app.inject({ method: "OPTIONS", url, ...options }),
         getController: <T>(controller: Constructor<T>, deps: any[] = []) => {
-          const paramTypes = Reflect.getMetadata('design:paramtypes', controller) || [];
+          const paramTypes =
+            Reflect.getMetadata("design:paramtypes", controller) || [];
 
           deps.forEach((dep, i) => {
             Container.set(paramTypes[i], dep);
           });
 
           return Container.get(controller);
-
         },
       };
     } catch (error) {
@@ -1042,7 +1021,8 @@ export class AvleonTest {
     process.env.NODE_ENV = "test";
   }
   static getController<T>(controller: Constructor<T>, deps: any[] = []) {
-    const paramTypes = Reflect.getMetadata('design:paramtypes', controller) || [];
+    const paramTypes =
+      Reflect.getMetadata("design:paramtypes", controller) || [];
 
     deps.forEach((dep, i) => {
       Container.set(paramTypes[i], dep);
@@ -1055,7 +1035,6 @@ export class AvleonTest {
     return Container.get(service);
   }
 
-
   static createTestApplication(options: TestAppOptions) {
     const app = AvleonApplication.getInternalApp({
       dataSourceOptions: options.dataSource ? options.dataSource : null,
@@ -1074,11 +1053,8 @@ export class AvleonTest {
 }
 
 export class Avleon {
-
   static createApplication() {
     const app = AvleonApplication.getApp();
-    return app
+    return app;
   }
-
-
 }

package/src/index.ts

@@ -1,30 +1,30 @@
-/**
- * @copyright 2024
- * @author Tareq Hossain
- * @email xtrinsic96@gmail.com
- * @url https://github.com/xtareq
- */
-import * as sw from "./swagger-schema";
-export * from "./icore";
-export * from "./testing";
-export { inject, validateRequestBody,pick, exclude } from "./helpers";
-export * from "./decorators";
-export * from "./middleware";
-export * from "./config";
-export * from "./openapi";
-export * from "./map-types";
-export * from "./response";
-export * from "./exceptions";
-export * from "./validator-extend";
-export * from "./validation";
-export * from "./environment-variables";
-export * from "./collection";
-export * from "./queue";
-export * from "./utils/hash";
-export * from "./multipart";
-export * from "./file-storage";
-export * from "./logger";
-
-export const GetSchema = sw.generateSwaggerSchema;
-
-export { default as Container } from "./container";
+/**
+ * @copyright 2024
+ * @author Tareq Hossain
+ * @email xtrinsic96@gmail.com
+ * @url https://github.com/xtareq
+ */
+import * as sw from "./swagger-schema";
+export * from "./icore";
+export * from "./testing";
+export { inject, validateRequestBody, pick, exclude } from "./helpers";
+export * from "./decorators";
+export * from "./middleware";
+export * from "./config";
+export * from "./openapi";
+export * from "./map-types";
+export * from "./response";
+export * from "./exceptions";
+export * from "./validator-extend";
+export * from "./validation";
+export * from "./environment-variables";
+export * from "./collection";
+export * from "./queue";
+export * from "./utils/hash";
+export * from "./multipart";
+export * from "./file-storage";
+export * from "./logger";
+
+export const GetSchema = sw.generateSwaggerSchema;
+
+export { default as Container } from "./container";

package/src/interfaces/avleon-application.ts

@@ -1,40 +1,32 @@
-
-
-interface AvleonApplication {
-
-  // all use
-  useCors: () => void;
-  /**
-   * function for register database 
-   * @param options datasource options. options can be plain object or avleon config class 
-   * */
-  useDatasource: () => void;
-  useMultipart: () => void;
-  useOpenApi: () => void;
-  useMiddlewares: () => void;
-  useAuthorization: () => void;
-  useSerialization: () => void;
-  useControllers: () => void;
-  useStaticFiles: () => void;
-  /**
-   * @experimental
-   * use https as defalut http protocol
-   * */
-  useHttps: () => void;
-
-
-  // all map 
-  mapGet: () => void;
-  mapPost: () => void;
-  mapPut: () => void;
-  mapPatch: () => void;
-  mapOptions: () => void;
-  mapGroup: () => void;
-  // all others 
-  // run 
-  run: () => void;
-}
-
-
-
-
+interface AvleonApplication {
+  // all use
+  useCors: () => void;
+  /**
+   * function for register database
+   * @param options datasource options. options can be plain object or avleon config class
+   * */
+  useDatasource: () => void;
+  useMultipart: () => void;
+  useOpenApi: () => void;
+  useMiddlewares: () => void;
+  useAuthorization: () => void;
+  useSerialization: () => void;
+  useControllers: () => void;
+  useStaticFiles: () => void;
+  /**
+   * @experimental
+   * use https as defalut http protocol
+   * */
+  useHttps: () => void;
+
+  // all map
+  mapGet: () => void;
+  mapPost: () => void;
+  mapPut: () => void;
+  mapPatch: () => void;
+  mapOptions: () => void;
+  mapGroup: () => void;
+  // all others
+  // run
+  run: () => void;
+}