@avleon/core 0.0.32 → 0.0.37

package/License

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tareq Hossain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -48,6 +48,7 @@ Avleon is a powerful, TypeScript-based web framework built on top of Fastify, de
   - [mapPost](#mappost)
   - [mapPut](#mapput)
   - [mapDelete](#mapdelete)
+- [Testing](#testing)
 
 ## Features
 
@@ -77,7 +78,7 @@ pnpm add @avleon/core
 
 ## Quick Start
 
-### Route Based
+### Minimal
 
 ```typescript
 import { Avleon, ApiController, Get, Results } from "@avleon/core";
@@ -349,10 +350,9 @@ class UserDto {
 
 Generate API documentation automatically:
 
-```typescript
-const app = new Avleon({
-  controllers: [UserController],
-  openapi: {
+```typescript 
+
+app.useOpenApi({
     info: {
       title: "User API",
       version: "1.0.0",
@@ -364,9 +364,9 @@ const app = new Avleon({
         description: "Development server",
       },
     ],
-  },
-});
-```
+  });
+
+  ```
 
 You can also customize the OpenAPI UI:
 
@@ -430,6 +430,27 @@ app.useDataSource(DataSourceConfig);
 // ... other impments
 ```
 
+Now in your Controller or Injected service use can use like this
+
+```typescript
+import { AppService, InjectRepository } from "@avleon/core";
+import { Repository } from "typeorm";
+import { User } from "model_path";
+
+@AppService
+export class UserService {
+  constructor(
+    @InjectRepository(User)
+    private readonly _userRepository: Repository<User>,
+  ) {}
+
+  async findAll() {
+    const users = await this._userRepository.find();
+    return users;
+  }
+}
+```
+
 ### File Uploads
 
 Handle file uploads with multipart support:
@@ -445,7 +466,7 @@ app.useMultipart({
 
 // In your controller
 @Post('/upload')
-async uploadFile(@File() file: any) {
+async uploadFile(@MultipartFile() file: any) {
   // Process uploaded file
   return HttpResponse.Ok({ filename: file.filename });
 }
@@ -462,46 +483,9 @@ app.useStaticFiles({
 });
 ```
 
-### Testing
-
-Test your API endpoints with the built-in testing utilities:
-
-```typescript
-import { TestBuilder } from "@avleon/core";
-
-const testBuilder = TestBuilder.createBuilder();
-const app = testBuilder.getTestApplication({
-  controllers: [UserController],
-});
-
-// Test your API endpoints
-const response = await app.get("/users");
-expect(response.statusCode).toBe(200);
-```
-
 ## Configuration
 
-Configure your application with environment variables:
-
-```typescript
-// .env
-PORT=3000
-DATABASE_URL=postgres://user:password@localhost:5432/db
-
-// app.ts
-import { Environment } from '@avleon/core';
-
-const env = new Environment();
-env.load();
-
-const app = new Avleon({
-  controllers: [UserController],
-  env: {
-    port: 'PORT',
-    databaseUrl: 'DATABASE_URL',
-  },
-});
-```
+Coming soon...
 
 ## Route Mapping
 
@@ -558,6 +542,8 @@ app.mapDelete("/users/:id", async (req, res) => {
 });
 ```
 
+### Add openapi and middleware support for inline route
+
 Each of these methods returns a route object that can be used to add middleware or Swagger documentation to the route.
 
 ```typescript
@@ -592,6 +578,12 @@ app
   });
 ```
 
+### Testing
+
+Test your API endpoints with the built-in testing utilities:
+
+Coming soon...
+
 ## License
 
 ISC

package/dist/collection.js

@@ -223,7 +223,6 @@ function InjectRepository(model) {
             });
         }
         catch (error) {
-            console.log(error);
             if (error.name && error.name == "ServiceNotFoundError") {
                 console.log("Database didn't initialized.");
             }

package/dist/container.d.ts

@@ -4,6 +4,7 @@
  * @email xtrinsic96@gmail.com
  * @url https://github.com/xtareq
  */
+import { Knex } from "knex";
 import TypediContainer from "typedi";
 export declare const FEATURE_KEY: unique symbol;
 export declare const ROUTE_META_KEY: unique symbol;
@@ -25,4 +26,5 @@ export declare function getRegisteredControllers(): Function[];
 export declare const API_CONTROLLER_METADATA_KEY: unique symbol;
 export declare function isApiController(target: Function): boolean;
 export declare function registerDataSource(dataSource: any): void;
+export declare function registerKnex(dataSource: Knex.Config): void;
 export default Container;

package/dist/container.js

@@ -10,12 +10,7 @@ exports.getRegisteredServices = getRegisteredServices;
 exports.getRegisteredControllers = getRegisteredControllers;
 exports.isApiController = isApiController;
 exports.registerDataSource = registerDataSource;
-/**
- * @copyright 2024
- * @author Tareq Hossain
- * @email xtrinsic96@gmail.com
- * @url https://github.com/xtareq
- */
+exports.registerKnex = registerKnex;
 const typedi_1 = __importDefault(require("typedi"));
 exports.FEATURE_KEY = Symbol.for("features");
 exports.ROUTE_META_KEY = Symbol("iroute:options");
@@ -54,4 +49,7 @@ Container.set("appName", "Iqra");
 function registerDataSource(dataSource) {
     Container.set("idatasource", dataSource);
 }
+function registerKnex(dataSource) {
+    Container.set("KnexConnection", dataSource);
+}
 exports.default = Container;

package/dist/environment-variables.d.ts

@@ -4,9 +4,46 @@
  * @email xtrinsic96@gmail.com
  * @url https://github.com/xtareq
  */
+/**
+ * @class Environment
+ * @description A service class to manage access to environment variables.
+ * It loads variables from `.env` file and merges them with `process.env`,
+ * giving precedence to `process.env` values.
+ */
 export declare class Environment {
+    /**
+   * Parses the given `.env` file and merges it with `process.env`.
+   * Values from `process.env` take precedence.
+   *
+   * @private
+   * @param filePath - Absolute path to the `.env` file.
+   * @returns A dictionary of merged environment variables.
+   */
     private parseEnvFile;
+    /**
+   * Retrieves the value of the specified environment variable.
+   *
+   * @template T
+   * @param key - The name of the environment variable.
+   * @returns The value of the variable, or `undefined` if not found.
+   */
     get<T = any>(key: string): T;
+    /**
+   * Retrieves the value of the specified environment variable.
+   * Throws an error if the variable is not found.
+   *
+   * @template T
+   * @param key - The name of the environment variable.
+   * @throws {EnvironmentVariableNotFound} If the variable does not exist.
+   * @returns The value of the variable.
+   */
     getOrThrow<T = any>(key: string): T;
+    /**
+   * Retrieves all available environment variables,
+   * with `process.env` values taking precedence over `.env` values.
+   *
+   * @template T
+   * @returns An object containing all environment variables.
+   */
     getAll<T = any>(): T;
 }

package/dist/environment-variables.js

@@ -55,7 +55,21 @@ const fs_1 = __importStar(require("fs"));
 const typedi_1 = require("typedi");
 const system_exception_1 = require("./exceptions/system-exception");
 dotenv_1.default.config({ path: path_1.default.join(process.cwd(), ".env") });
+/**
+ * @class Environment
+ * @description A service class to manage access to environment variables.
+ * It loads variables from `.env` file and merges them with `process.env`,
+ * giving precedence to `process.env` values.
+ */
 let Environment = class Environment {
+    /**
+   * Parses the given `.env` file and merges it with `process.env`.
+   * Values from `process.env` take precedence.
+   *
+   * @private
+   * @param filePath - Absolute path to the `.env` file.
+   * @returns A dictionary of merged environment variables.
+   */
     parseEnvFile(filePath) {
         try {
             const isExis = (0, fs_1.existsSync)(filePath);
@@ -71,10 +85,26 @@ let Environment = class Environment {
             return {};
         }
     }
+    /**
+   * Retrieves the value of the specified environment variable.
+   *
+   * @template T
+   * @param key - The name of the environment variable.
+   * @returns The value of the variable, or `undefined` if not found.
+   */
     get(key) {
         const parsedEnv = this.parseEnvFile(path_1.default.join(process.cwd(), ".env"));
         return parsedEnv[key];
     }
+    /**
+   * Retrieves the value of the specified environment variable.
+   * Throws an error if the variable is not found.
+   *
+   * @template T
+   * @param key - The name of the environment variable.
+   * @throws {EnvironmentVariableNotFound} If the variable does not exist.
+   * @returns The value of the variable.
+   */
     getOrThrow(key) {
         const parsedEnv = this.parseEnvFile(path_1.default.join(process.cwd(), ".env"));
         if (!Object(parsedEnv).hasOwnProperty(key)) {
@@ -82,6 +112,13 @@ let Environment = class Environment {
         }
         return parsedEnv[key];
     }
+    /**
+   * Retrieves all available environment variables,
+   * with `process.env` values taking precedence over `.env` values.
+   *
+   * @template T
+   * @returns An object containing all environment variables.
+   */
     getAll() {
         const parsedEnv = this.parseEnvFile(path_1.default.join(process.cwd(), ".env"));
         return parsedEnv;

package/dist/icore.d.ts

@@ -16,6 +16,7 @@ import { FastifyCorsOptions } from "@fastify/cors";
 import { FastifyMultipartOptions } from "@fastify/multipart";
 import { MultipartFile } from "./multipart";
 import { ServerOptions } from "socket.io";
+import { Knex } from "knex";
 export type FuncRoute = {
     handler: any;
     middlewares?: any[];
@@ -149,6 +150,7 @@ export declare class AvleonApplication {
     useOpenApi<T = OpenApiUiOptions>(configOrClass: OpenApiConfigInput<T>): void;
     useMultipart<T extends MultipartOptions>(options: ConfigInput<T>): void;
     useDataSource<T extends DataSourceOptions>(options: ConfigInput<T>): void;
+    useKnex<T extends Knex.Config>(options: ConfigInput<T>): void;
     private _useCache;
     useMiddlewares<T extends AvleonMiddleware>(mclasses: Constructor<T>[]): void;
     useAuthoriztion<T extends any>(middleware: Constructor<T>): void;
@@ -218,12 +220,13 @@ export interface IAppBuilder {
 export declare class AvleonTest {
     private constructor();
     static getController<T>(controller: Constructor<T>, deps?: any[]): T;
-    private getService;
+    static getProvider<T>(service: Constructor<T>, deps?: any[]): T;
     static createTestApplication(options: TestAppOptions): TestApplication;
     static from(app: AvleonApplication): TestApplication;
     static clean(): void;
 }
 export declare class Avleon {
     static createApplication(): AvleonApplication;
+    static createTestApplication(options: TestAppOptions): TestApplication;
 }
 export {};

package/dist/icore.js

@@ -229,6 +229,18 @@ class AvleonApplication {
         this.dataSource = datasource;
         typedi_1.default.set("idatasource", datasource);
     }
+    useKnex(options) {
+        let dataSourceOptions;
+        if (this._isConfigClass(options)) {
+            dataSourceOptions = this.appConfig.get(options);
+        }
+        else {
+            dataSourceOptions = options;
+        }
+        if (!dataSourceOptions)
+            throw new system_exception_1.SystemUseError("Invlaid datasource options.");
+        (0, container_1.registerKnex)(dataSourceOptions);
+    }
     _useCache(options) { }
     useMiddlewares(mclasses) {
         for (const mclass of mclasses) {
@@ -308,7 +320,6 @@ class AvleonApplication {
                 method: methodmetaOptions.method.toUpperCase(),
                 schema: { ...schema },
                 handler: async (req, res) => {
-                    var _a;
                     let reqClone = req;
                     // class level authrization
                     if (authClsMeata.authorize && this.authorizeMiddleware) {
@@ -368,18 +379,44 @@ class AvleonApplication {
                         }
                     }
                     const result = await prototype[method].apply(ctrl, args);
-                    if (result instanceof stream_1.default || (result === null || result === void 0 ? void 0 : result.pipe)) {
-                        if (!res.sent && ((_a = result.options) === null || _a === void 0 ? void 0 : _a.downloadName)) {
-                            res.header('Content-Type', 'application/octet-stream');
-                            res.header('Content-Disposition', `attachment; filename="${result.options.downloadName}"`);
+                    // Custom wrapped file download
+                    if (result === null || result === void 0 ? void 0 : result.__isFileDownload) {
+                        const { stream, filename, contentType = "application/octet-stream", } = result;
+                        if (!stream || typeof stream.pipe !== "function") {
+                            return res.code(500).send({
+                                code: 500,
+                                error: "INTERNAL_ERROR",
+                                message: "Invalid stream object",
+                            });
                         }
-                        return result.pipe(res.raw);
+                        res.header("Content-Type", contentType);
+                        res.header("Content-Disposition", `attachment; filename="${filename}"`);
+                        stream.on("error", (err) => {
+                            console.error("Stream error:", err);
+                            if (!res.sent) {
+                                res.code(500).send({
+                                    code: 500,
+                                    error: "StreamError",
+                                    message: "Error while streaming file.",
+                                });
+                            }
+                        });
+                        return res.send(stream);
                     }
-                    if (result && result.__isFileDownload) {
-                        const { stream, filename, contentType = 'application/octet-stream' } = result;
-                        res.header('Content-Type', contentType);
-                        res.header('Content-Disposition', `attachment; filename="${filename}"`);
-                        return stream.pipe(res.raw);
+                    // Native stream (not wrapped)
+                    if (result instanceof stream_1.default || typeof (result === null || result === void 0 ? void 0 : result.pipe) === "function") {
+                        result.on("error", (err) => {
+                            console.error("Stream error:", err);
+                            if (!res.sent) {
+                                res.code(500).send({
+                                    code: 500,
+                                    error: "StreamError",
+                                    message: "Error while streaming file.",
+                                });
+                            }
+                        });
+                        res.header("Content-Type", "application/octet-stream");
+                        return res.send(result);
                     }
                     return res.send(result);
                 },
@@ -514,14 +551,6 @@ class AvleonApplication {
             }
         }
     }
-    // addFeature(feature:{controllers:Function[]}){
-    //   feature.controllers.forEach(c=> this.controllers.push(c))
-    // }
-    // mapFeature(){
-    //   if(!this.isMapFeatures){
-    //     this.isMapFeatures = true;
-    //   }
-    // }
     async _mapControllers() {
         if (this.controllers.length > 0) {
             for (let controller of this.controllers) {
@@ -534,10 +563,6 @@ class AvleonApplication {
             }
         }
     }
-    // useControllersAuto(controllerPath?:string) {
-    //     this.registerControllerAuto = true;
-    //     //this.autoControllers();
-    // }
     async mapFn(fn) {
         const original = fn;
         fn = function () { };
@@ -694,8 +719,6 @@ class AvleonApplication {
     }
     getTestApp(buildOptions) {
         try {
-            // }
-            // this.initializeDatabase();
             this._mapControllers();
             this.rMap.forEach((value, key) => {
                 const [m, r] = key.split(":");
@@ -758,7 +781,11 @@ class AvleonTest {
         });
         return typedi_1.default.get(controller);
     }
-    getService(service) {
+    static getProvider(service, deps = []) {
+        const paramTypes = Reflect.getMetadata("design:paramtypes", service) || [];
+        deps.forEach((dep, i) => {
+            typedi_1.default.set(paramTypes[i], dep);
+        });
         return typedi_1.default.get(service);
     }
     static createTestApplication(options) {
@@ -781,5 +808,9 @@ class Avleon {
         const app = AvleonApplication.getApp();
         return app;
     }
+    static createTestApplication(options) {
+        const app = AvleonTest.createTestApplication(options);
+        return app;
+    }
 }
 exports.Avleon = Avleon;

package/dist/index.d.ts

@@ -25,6 +25,7 @@ export * from "./multipart";
 export * from "./file-storage";
 export * from "./logger";
 export * from "./event-dispatcher";
+export * from "./kenx-provider";
 export { Subscribe, Private } from "./event-subscriber";
 export declare const GetSchema: typeof sw.generateSwaggerSchema;
 export { default as AvleonContainer } from "./container";

package/dist/index.js

@@ -71,6 +71,7 @@ __exportStar(require("./multipart"), exports);
 __exportStar(require("./file-storage"), exports);
 __exportStar(require("./logger"), exports);
 __exportStar(require("./event-dispatcher"), exports);
+__exportStar(require("./kenx-provider"), exports);
 var event_subscriber_1 = require("./event-subscriber");
 Object.defineProperty(exports, "Subscribe", { enumerable: true, get: function () { return event_subscriber_1.Subscribe; } });
 Object.defineProperty(exports, "Private", { enumerable: true, get: function () { return event_subscriber_1.Private; } });

package/dist/kenx-provider.d.ts

@@ -0,0 +1,7 @@
+import type { Knex } from "knex";
+export declare class DB {
+    private connection;
+    constructor();
+    init(config: Knex.Config): Knex<any, any[]>;
+    get client(): Knex;
+}

package/dist/kenx-provider.js

@@ -0,0 +1,44 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DB = void 0;
+const typedi_1 = require("typedi");
+const typedi_2 = require("typedi");
+let DB = class DB {
+    constructor() {
+        const existing = typedi_2.Container.has("KnexConnection")
+            ? typedi_2.Container.get("KnexConnection")
+            : null;
+        if (existing) {
+            this.connection = existing;
+        }
+    }
+    // Initialize manually (call this in main if you want)
+    init(config) {
+        if (!this.connection) {
+            const knex = require("knex");
+            this.connection = knex(config);
+            typedi_2.Container.set("KnexConnection", this.connection);
+        }
+        return this.connection;
+    }
+    get client() {
+        if (!this.connection) {
+            throw new Error("Knex is not initialized. Call DB.init(config) first.");
+        }
+        return this.connection;
+    }
+};
+exports.DB = DB;
+exports.DB = DB = __decorate([
+    (0, typedi_1.Service)(),
+    __metadata("design:paramtypes", [])
+], DB);

package/package.json

@@ -1,19 +1,8 @@
 {
   "name": "@avleon/core",
-  "version": "0.0.32",
+  "version": "0.0.37",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
-  "scripts": {
-    "build": "npm run clean && tsc",
-    "clean": "rimraf dist",
-    "watch": "tsc-watch",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "format": "prettier --write .",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "prepare": "husky install"
-  },
   "keywords": [
     "restapi",
     "avleon",
@@ -35,6 +24,7 @@
     "husky": "^8.0.0",
     "ioredis": "^5.6.1",
     "jest": "^29.7.0",
+    "knex": "^3.1.0",
     "lint-staged": "^16.0.0",
     "mssql": "^11.0.1",
     "mysql2": "^3.14.1",
@@ -75,7 +65,8 @@
     "@scalar/fastify-api-reference": "*",
     "ioredis": "*",
     "sharp": "*",
-    "typeorm": "*"
+    "typeorm": "*",
+    "knex": "*"
   },
   "peerDependenciesMeta": {
     "@scalar/fastify-api-reference": {
@@ -89,6 +80,9 @@
     },
     "typeorm": {
       "optional": true
+    },
+    "knex": {
+      "optional": true
     }
   },
   "lint-staged": {
@@ -111,5 +105,16 @@
   },
   "files": [
     "dist"
-  ]
-}
+  ],
+  "scripts": {
+    "build": "npm run clean && tsc",
+    "clean": "rimraf dist",
+    "watch": "tsc-watch",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write .",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "husky:init": "husky install"
+  }
+}