@avleon/core 0.0.19 → 0.0.24

package/dist/file-storage.js

@@ -112,134 +112,6 @@ let FileStorage = class FileStorage {
             throw new system_exception_1.SystemUseError("Can't upload file");
         }
     }
-    /*   private async saveSingleFile(
-      f: MultipartFile,
-      options: any
-    ): Promise<MultipartFile | null> {
-      if (f && f.type == "file") {
-        let fname = f.filename;
-        if (options) {
-          if (options.dest) {
-            fname = options.saveAs
-              ? options.dest + "/" + options.saveAs
-              : options.dest + "/" + f.filename;
-          } else {
-            fname = path.join(
-              process.cwd(),
-              `public/${options.saveAs ? options.saveAs : f.filename}`
-            );
-          }
-        } else {
-          fname = path.join(process.cwd(), `public/${f.filename}`);
-        }
-        await this.ensureDirectoryExists(fname); // Ensure directory exists
-  
-        if (fs.existsSync(fname) && !options.overwrite) {
-          throw new InternalErrorException("File already exists.");
-        }
-  
-        if (this.transformOptions) {
-          if (f.type == "file") {
-            const tempFilePath = path.join(
-              os.tmpdir(),
-              `temp-${Date.now()}-${f.filename}`
-            );
-            await pipeline(f.file!, fs.createWriteStream(tempFilePath));
-            await this.processImage(fs.createReadStream(tempFilePath), fname);
-            fs.unlinkSync(tempFilePath);
-          } else if (f.type == "fil") {
-            await this.processImage(fs.createReadStream(f.filepath), fname);
-          }
-        } else {
-          if (f.file) {
-            await pipeline(f.file!, fs.createWriteStream(fname));
-          } else if (f.filepath) {
-            fs.copyFileSync(f.filepath, fname);
-          }
-        }
-        return {
-          ...f,
-          filename: options?.saveAs ? options.saveAs : f.filename,
-        } as MultipartFile;
-      }
-      return null;
-    }
-  
-    async saveAs(
-      f: MultipartFile | MultipartFile[],
-      filename: string | string[],
-      options: any
-    ) {
-      if (
-        Array.isArray(f) &&
-        Array.isArray(filename) &&
-        f.length === filename.length
-      ) {
-        const savedFiles: MultipartFile[] = [];
-        for (let i = 0; i < f.length; i++) {
-          const savedFile = await this.saveSingleFileAs(
-            f[i],
-            filename[i],
-            options
-          );
-          if (savedFile) {
-            savedFiles.push(savedFile);
-          }
-        }
-        return savedFiles;
-      } else if (!Array.isArray(f) && !Array.isArray(filename)) {
-        return await this.saveSingleFileAs(f, filename as string, options);
-      } else {
-        throw new InternalErrorException(
-          "File and filename array lengths do not match."
-        );
-      }
-    }
-  
-    private async saveSingleFileAs(
-      f: MultipartFile,
-      filename: string,
-      options: any
-    ): Promise<MultipartFile | null> {
-      if (f) {
-        let fname = filename;
-  
-        if (options && options.dest) {
-          fname = options.dest + "/" + filename;
-        } else {
-          fname = path.join(process.cwd(), `public/${filename}`);
-        }
-        await this.ensureDirectoryExists(fname);
-  
-        if (fs.existsSync(fname) && !options.overwrite) {
-          throw new InternalErrorException("File already exists.");
-        }
-  
-        if (this.transformOptions) {
-          if (f.file) {
-            const tempFilePath = path.join(
-              os.tmpdir(),
-              `temp-${Date.now()}-${f.filename}`
-            );
-            await pipeline(f.file!, fs.createWriteStream(tempFilePath));
-            await this.processImage(fs.createReadStream(tempFilePath), fname);
-            fs.unlinkSync(tempFilePath);
-          } else if (f.filepath) {
-            await this.processImage(fs.createReadStream(f.filepath), fname);
-          }
-        } else {
-          if (f.file) {
-            await pipeline(f.file!, fs.createWriteStream(fname));
-          } else if (f.filepath) {
-            fs.copyFileSync(f.filepath, fname);
-          }
-        }
-  
-        return { ...f, filename: filename } as MultipartFile;
-      }
-      return null;
-    }
-   */
     async processImage(fileStream, outputPath) {
         var _a, _b;
         try {

package/dist/helpers.d.ts

@@ -29,4 +29,6 @@ type ValidationError = {
     errors: any;
 };
 export declare function validateRequestBody(target: Constructor, value: object, options?: "object" | "array"): ValidationError;
+export declare function pick<T extends object>(obj: T, paths: string[]): Partial<T>;
+export declare function exclude<T extends object>(obj: T | T[], paths: string[]): Partial<T> | Partial<T>[];
 export {};

package/dist/helpers.js

@@ -19,6 +19,8 @@ exports.jsonToInstance = jsonToInstance;
 exports.transformObjectByInstanceToObject = transformObjectByInstanceToObject;
 exports.validateObjectByInstance = validateObjectByInstance;
 exports.validateRequestBody = validateRequestBody;
+exports.pick = pick;
+exports.exclude = exclude;
 /**
  * @copyright 2024
  * @author Tareq Hossain
@@ -42,19 +44,15 @@ function inject(cls) {
     }
 }
 function isConstructor(func) {
-    // Check if the func is a function
     if (typeof func !== "function") {
         return false;
     }
-    // Check if it's an arrow function or a built-in JavaScript function
     if (func === Function.prototype.bind || func instanceof RegExp) {
         return false;
     }
-    // Check if it has a `prototype` property
     if (func.prototype && typeof func.prototype === "object") {
         return true;
     }
-    // If it's not a constructor, check if it can be called with the new keyword
     try {
         const instance = new func();
         return typeof instance === "object";
@@ -253,3 +251,42 @@ function validateRequestBody(target, value, options = "array") {
         : error.map((x) => ({ path: x.property, constraints: x.constraints }));
     return { count: error.length, errors };
 }
+function pick(obj, paths) {
+    const result = {};
+    for (const path of paths) {
+        const keys = path.split(".");
+        let source = obj;
+        let target = result;
+        for (let i = 0; i < keys.length; i++) {
+            const key = keys[i];
+            if (!(key in source))
+                break;
+            if (i === keys.length - 1) {
+                target[key] = source[key];
+            }
+            else {
+                source = source[key];
+                target[key] = target[key] || {};
+                target = target[key];
+            }
+        }
+    }
+    return result;
+}
+function exclude(obj, paths) {
+    if (Array.isArray(obj)) {
+        return obj.map((item) => exclude(item, paths));
+    }
+    const clone = structuredClone(obj); // Or use lodash.cloneDeep
+    for (const path of paths) {
+        const keys = path.split(".");
+        let target = clone;
+        for (let i = 0; i < keys.length - 1; i++) {
+            if (!(keys[i] in target))
+                break;
+            target = target[keys[i]];
+        }
+        target === null || target === void 0 ? true : delete target[keys[keys.length - 1]];
+    }
+    return clone;
+}

package/dist/icore.d.ts

@@ -87,6 +87,7 @@ export interface AvleonTestAppliction {
 export interface IAvleonApplication {
     isDevelopment(): boolean;
     useCors(corsOptions?: FastifyCorsOptions): void;
+    useDataSource<T extends IConfig<R>, R = ReturnType<InstanceType<Constructable<T>>["config"]>>(ConfigClass: Constructable<T>, modifyConfig?: (config: R) => R): void;
     useOpenApi<T extends IConfig<R>, R = ReturnType<InstanceType<Constructable<T>>["config"]>>(ConfigClass: Constructable<T>, modifyConfig?: (config: R) => R): void;
     useSwagger(options: OpenApiUiOptions): Promise<void>;
     useMultipart(options: MultipartOptions): void;
@@ -102,7 +103,7 @@ export interface IAvleonApplication {
     run(port?: number): Promise<void>;
     getTestApp(): TestApplication;
 }
-export declare class AvleonApplication implements IAvleonApplication {
+export declare class AvleonApplication {
     private static instance;
     private static buildOptions;
     private app;
@@ -118,21 +119,75 @@ export declare class AvleonApplication implements IAvleonApplication {
     private authorizeMiddleware?;
     private appConfig;
     private dataSource?;
+    private isMapFeatures;
     private metaCache;
     private multipartOptions;
     private constructor();
     private isTest;
+    static getApp(): AvleonApplication;
     static getInternalApp(buildOptions: any): AvleonApplication;
     isDevelopment(): boolean;
     private initSwagger;
     useCors(corsOptions?: FastifyCorsOptions): void;
     useOpenApi<T extends IConfig<R>, R = ReturnType<InstanceType<Constructable<T>>["config"]>>(ConfigClass: Constructable<T>, modifyConfig?: (config: R) => R): void;
     /**
-     * @deprecated
-     * Will remove in next major version
+     * Registers the fastify-multipart plugin with the Fastify instance.
+     * This enables handling of multipart/form-data requests, typically used for file uploads.
+     *
+     * @param {MultipartOptions} options - Options to configure the fastify-multipart plugin.
+     * @param {FastifyInstance} this.app - The Fastify instance to register the plugin with.
+     * @property {MultipartOptions} this.multipartOptions - Stores the provided multipart options.
+     * @see {@link https://github.com/fastify/fastify-multipart} for more details on available options.
      */
-    useSwagger(options: OpenApiUiOptions): Promise<void>;
     useMultipart(options: MultipartOptions): void;
+    /**
+     * Configures and initializes a TypeORM DataSource based on the provided configuration class.
+     * It retrieves the configuration from the application's configuration service and allows for optional modification.
+     * The initialized DataSource is then stored and registered within a dependency injection container.
+     *
+     * @template T - A generic type extending the `IConfig` interface, representing the configuration class.
+     * @template R - A generic type representing the return type of the configuration method of the `ConfigClass`.
+     * @param {Constructable<T>} ConfigClass - The constructor of the configuration class to be used for creating the DataSource.
+     * @param {(config: R) => R} [modifyConfig] - An optional function that takes the initial configuration and returns a modified configuration.
+     * @returns {void}
+     * @property {DataSourceOptions} this.dataSourceOptions - Stores the final DataSource options after potential modification.
+     * @property {DataSource} this.dataSource - Stores the initialized TypeORM DataSource instance.
+     * @see {@link https://typeorm.io/} for more information about TypeORM.
+     */
+    useDataSource<T extends IConfig<R>, R = ReturnType<InstanceType<Constructable<T>>["config"]>>(ConfigClass: Constructable<T>, modifyConfig?: (config: R) => R): void;
+    /**
+     * Registers an array of middleware classes to be executed before request handlers.
+     * It retrieves instances of the middleware classes from the dependency injection container
+     * and adds them as 'preHandler' hooks to the Fastify application.
+     *
+     * @template T - A generic type extending the `AppMiddleware` interface, representing the middleware class.
+     * @param {Constructor<T>[]} mclasses - An array of middleware class constructors to be registered.
+     * @returns {void}
+     * @property {Map<string, T>} this.middlewares - Stores the registered middleware instances, keyed by their class names.
+     * @see {@link https://www.fastify.io/docs/latest/Reference/Hooks/#prehandler} for more information about Fastify preHandler hooks.
+     */
+    useMiddlewares<T extends AppMiddleware>(mclasses: Constructor<T>[]): void;
+    /**
+     * Registers a middleware constructor to be used for authorization purposes.
+     * The specific implementation and usage of this middleware will depend on the application's authorization logic.
+     *
+     * @template T - A generic type representing the constructor of the authorization middleware.
+     * @param {Constructor<T>} middleware - The constructor of the middleware to be used for authorization.
+     * @returns {void}
+     * @property {any} this.authorizeMiddleware - Stores the constructor of the authorization middleware.
+     */
+    useAuthoriztion<T extends any>(middleware: Constructor<T>): void;
+    /**
+     * Registers the `@fastify/static` plugin to serve static files.
+     * It configures the root directory and URL prefix for serving static assets.
+     *
+     * @param {StaticFileOptions} [options={ path: undefined, prefix: undefined }] - Optional configuration for serving static files.
+     * @param {string} [options.path] - The absolute path to the static files directory. Defaults to 'process.cwd()/public'.
+     * @param {string} [options.prefix] - The URL prefix for serving static files. Defaults to '/static/'.
+     * @returns {void}
+     * @see {@link https://github.com/fastify/fastify-static} for more details on available options.
+     */
+    useStaticFiles(options?: StaticFileOptions): void;
     private handleMiddlewares;
     private executeMiddlewares;
     /**
@@ -157,34 +212,33 @@ export declare class AvleonApplication implements IAvleonApplication {
     private _processMeta;
     autoControllers(): Promise<void>;
     mapControllers(controllers: Function[]): void;
+    mapFeature(): void;
     private _mapControllers;
     mapControllersAuto(): void;
     handleRoute(args: any): Promise<void>;
     private mapFn;
-    useMiddlewares<T extends AppMiddleware>(mclasses: Constructor<T>[]): void;
-    useAuthoriztion<T extends any>(middleware: Constructor<T>): void;
     private _handleError;
     mapRoute<T extends (...args: any[]) => any>(method: "get" | "post" | "put" | "delete", path: string | undefined, fn: T): Promise<void>;
     private _routeHandler;
     mapGet<T extends (...args: any[]) => any>(path: string | undefined, fn: T): {
         useMiddleware: <M extends AppMiddleware>(middlewares: Constructor<AppMiddleware>[]) => /*elided*/ any;
-        useSwagger: (options: OpenApiOptions) => /*elided*/ any;
+        useOpenApi: (options: OpenApiOptions) => /*elided*/ any;
     };
     mapPost<T extends (...args: any[]) => any>(path: string | undefined, fn: T): {
         useMiddleware: <M extends AppMiddleware>(middlewares: Constructor<AppMiddleware>[]) => /*elided*/ any;
-        useSwagger: (options: OpenApiOptions) => /*elided*/ any;
+        useOpenApi: (options: OpenApiOptions) => /*elided*/ any;
     };
     mapPut<T extends (...args: any[]) => any>(path: string | undefined, fn: T): {
         useMiddleware: <M extends AppMiddleware>(middlewares: Constructor<AppMiddleware>[]) => /*elided*/ any;
-        useSwagger: (options: OpenApiOptions) => /*elided*/ any;
+        useOpenApi: (options: OpenApiOptions) => /*elided*/ any;
     };
     mapDelete<T extends (...args: any[]) => any>(path: string | undefined, fn: T): {
         useMiddleware: <M extends AppMiddleware>(middlewares: Constructor<AppMiddleware>[]) => /*elided*/ any;
-        useSwagger: (options: OpenApiOptions) => /*elided*/ any;
+        useOpenApi: (options: OpenApiOptions) => /*elided*/ any;
     };
-    useStaticFiles(options?: StaticFileOptions): void;
+    private _mapFeatures;
     initializeDatabase(): Promise<void>;
-    run(port?: number): Promise<void>;
+    run(port?: number, fn?: CallableFunction): Promise<void>;
     getTestApp(buildOptions?: any): TestApplication;
 }
 export type Application = typeof AvleonApplication;
@@ -210,19 +264,7 @@ export declare class TestBuilder {
     build(app: IAvleonApplication): TestApplication;
     fromApplication(app: IAvleonApplication): TestApplication;
 }
-export declare class Builder implements IAppBuilder {
-    private static instance;
-    private alreadyBuilt;
-    private database;
-    private dataSource?;
-    private multipartOptions;
-    private dataSourceOptions?;
-    private testBuilder;
-    private appConfig;
-    private constructor();
-    static createAppBuilder(): Builder;
-    registerPlugin<T extends Function, S extends {}>(plugin: T, options: S): Promise<void>;
-    addDataSource<T extends IConfig<R>, R = ReturnType<InstanceType<Constructable<T>>["config"]>>(ConfigClass: Constructable<T>, modifyConfig?: (config: R) => R): void;
-    build<T extends IAvleonApplication>(): T;
+export declare class Builder {
+    static createApplication(): AvleonApplication;
 }
 export {};