@avleon/core 0.0.38 → 0.0.40

package/README.md

@@ -1,20 +1,9 @@
-# AvleonJs
+# Avleon 
 
-## ⚠️ WARNING: NOT FOR PRODUCTION USE
+![npm version](https://img.shields.io/npm/v/@avleon/core.svg) ![Build](https://github.com/avleonjs/avleon-core/actions/workflows/release.yml/badge.svg)
+## ⚠️ WARNING
 
 > **🚧 This project is in active development.**
->
-> It is **not stable** and **not ready** for live environments.  
-> Use **only for testing, experimentation, or internal evaluation**.
->
-> ####❗ Risks of using this in production:
->
-> - 🔄 Breaking changes may be introduced at any time
-> - 🧪 Features are experimental and may be unstable
-> - 🔐 Security has not been audited
-> - 💥 Potential for data loss or critical errors
->
-> **Please do not deploy this in production environments.**
 
 ## Overview
 
@@ -69,11 +58,11 @@ Avleon is a powerful, TypeScript-based web framework built on top of Fastify, de
 ## Installation
 
 ```bash
-npm install @avleon/core
+npx @avleon/cli new myapp
 # or
-yarn add @avleon/core
+yarn dlx @avleon/cli new myapp
 # or
-pnpm add @avleon/core
+pnpm dlx @avleon/cli new myapp
 ```
 
 ## Quick Start
@@ -81,7 +70,7 @@ pnpm add @avleon/core
 ### Minimal
 
 ```typescript
-import { Avleon, ApiController, Get, Results } from "@avleon/core";
+import { Avleon } from "@avleon/core";
 
 const app = Avleon.createApplication();
 app.mapGet("/", () => "Hello, Avleon");
@@ -123,7 +112,9 @@ const app = Avleon.createApplication();
 // Configure and run the application
 app.useCors();
 app.useControllers([UserController]);
-app.run(3000);
+// For auto register controller `app.useControllers({auto:true});`
+
+app.run(); // or app.run(port)
 ```
 
 ### Controllers
@@ -253,7 +244,9 @@ class UserController {
 Secure your API with authentication and authorization:
 
 ```typescript
-@Authorize
+import { CanAuthorize } from "@avleon/core";
+
+@CanAuthorize
 class JwtAuthorization extends AuthorizeMiddleware {
   authorize(roles: string[]) {
     return async (req: IRequest) => {
@@ -382,6 +375,66 @@ app.useOpenApi(OpenApiConfig, (config) => {
 
 ### Database Integration
 
+## 1. Knex
+
+```typescript
+const app = Avleon.createApplication();
+app.useKnex({
+  client: 'mysql',
+  connection: {
+    host: '127.0.0.1',
+    port: 3306,
+    user: 'your_database_user',
+    password: 'your_database_password',
+    database: 'myapp_test',
+  },
+})
+```
+or using config class 
+
+```typescript
+@AppConfig
+export class KnexConfig implements IConfig {
+  // config method is mendatory
+  // config method has access to environment variables by default
+  config(env: Environment) {
+    return {
+      client: 'mysql',
+      connection: {
+        host: env.get("DB_HOST") || '127.0.0.1',
+        port: env.get("DB_PORT") || 3306,
+        user: env.get("DB_USER")|| 'your_database_user',
+        password: env.get("DB_PASS") || 'your_database_password',
+        database: env.get("DB_NAME") || 'myapp_test',
+      },
+    };
+  }
+}
+
+// now we can register it with our app
+
+app.useKenx(KnexConfig)
+```
+
+### Exmaple uses
+
+```typescript
+import { DB, AppService } from "@avleon/core";
+
+@AppService
+export class UsersService{
+  constructor(
+    private readonly db: DB
+  ){}
+
+  async findAll(){
+    const result = await this.db.client.select("*").from("users");
+    return result;
+  }
+}
+```
+
+## 2. Typeorm
 Connect to databases using TypeORM:
 
 ```typescript
@@ -402,9 +455,9 @@ Or use the config class:
 
 ```typescript
 // datasource.config.ts
-import { Config, IConfig } from "@avleon/core";
+import { AppConfig, IConfig } from "@avleon/core";
 
-@Config
+@AppConfig
 export class DataSourceConfig implements IConfig {
   // config method is mendatory
   // config method has access to environment variables by default
@@ -552,7 +605,7 @@ app
     // Handler function
   })
   .useMiddleware([AuthMiddleware])
-  .useSwagger({
+  .useOpenApi({
     summary: "Get all users",
     description: "Retrieves a list of all users",
     tags: ["users"],

package/dist/environment-variables.js

@@ -54,7 +54,7 @@ const path_1 = __importDefault(require("path"));
 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") });
+dotenv_1.default.config({ path: path_1.default.join(process.cwd(), ".env"), quiet: true });
 /**
  * @class Environment
  * @description A service class to manage access to environment variables.

package/dist/event-dispatcher.js

@@ -60,7 +60,6 @@ let EventDispatcher = class EventDispatcher {
         for (const transport of transports) {
             if (transport === "socket") {
                 const io = typedi_1.Container.get(socket_io_1.Server);
-                //console.log('SOckert', Container.get(SocketContextService));
                 const context = typedi_1.Container.get(SocketContextService);
                 const socket = context.getSocket();
                 if (options.broadcast && socket) {

package/dist/icore.d.ts

@@ -208,15 +208,6 @@ export declare class AvleonApplication {
     getTestApp(buildOptions?: any): TestApplication;
 }
 export type Application = typeof AvleonApplication;
-export interface ITestBuilder {
-    getTestApplication(): AvleonTestAppliction;
-    createTestApplication(options: any): AvleonTestAppliction;
-}
-export interface IAppBuilder {
-    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 AvleonTest {
     private constructor();
     static getController<T>(controller: Constructor<T>, deps?: any[]): T;

package/dist/icore.js

@@ -528,7 +528,6 @@ class AvleonApplication {
                 const module = await Promise.resolve(`${filePath}`).then(s => __importStar(require(s)));
                 for (const exported of Object.values(module)) {
                     if (typeof exported === "function" && (0, container_1.isApiController)(exported)) {
-                        console.log("adding", exported.name);
                         if (!this.controllers.some((con) => exported.name == con.name)) {
                             this.controllers.push(exported);
                         }
@@ -651,7 +650,6 @@ class AvleonApplication {
     }
     _mapFeatures() {
         const features = typedi_1.default.get("features");
-        console.log("Features", features);
     }
     async initializeDatabase() {
         if (this.dataSourceOptions && this.dataSource) {
@@ -707,7 +705,6 @@ class AvleonApplication {
             await this.app.io.use((socket, next) => {
                 const token = socket.handshake.auth.token;
                 try {
-                    console.log("token", token);
                     const user = { id: 1, name: "tareq" };
                     socket.data.user = user; // this powers @AuthUser()
                     next();
@@ -766,13 +763,31 @@ class AvleonApplication {
             };
         }
         catch (error) {
-            console.log(error);
             throw new system_exception_1.SystemUseError("Can't get test appliction");
         }
     }
 }
 exports.AvleonApplication = AvleonApplication;
 AvleonApplication.buildOptions = {};
+// Applciation Builder
+// export interface ITestBuilder {
+//   getTestApplication(): AvleonTestAppliction;
+//   createTestApplication(options: any): AvleonTestAppliction;
+// }
+// export interface IAppBuilder {
+//   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;
+// }
 class AvleonTest {
     constructor() {
         process.env.NODE_ENV = "test";

package/dist/middleware.d.ts

@@ -14,6 +14,9 @@ export type AuthReturnTypes = IRequest | Promise<IRequest>;
 interface AuthorizeClass {
     authorize(req: IRequest, options?: any): AuthReturnTypes;
 }
+export declare function CanAuthorize(target: {
+    new (...args: any[]): AuthorizeClass;
+}): void;
 export declare function AppAuthorization(target: {
     new (...args: any[]): AuthorizeClass;
 }): void;

package/dist/middleware.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuthorizeMiddleware = exports.AvleonMiddleware = void 0;
+exports.CanAuthorize = CanAuthorize;
 exports.AppAuthorization = AppAuthorization;
 exports.Authorized = Authorized;
 exports.AppMiddleware = AppMiddleware;
@@ -19,6 +20,12 @@ exports.AvleonMiddleware = AvleonMiddleware;
 class AuthorizeMiddleware {
 }
 exports.AuthorizeMiddleware = AuthorizeMiddleware;
+function CanAuthorize(target) {
+    if (typeof target.prototype.authorize !== "function") {
+        throw new Error(`Class "${target.name}" must implement an "authorize" method.`);
+    }
+    (0, typedi_1.Service)()(target);
+}
 function AppAuthorization(target) {
     if (typeof target.prototype.authorize !== "function") {
         throw new Error(`Class "${target.name}" must implement an "authorize" method.`);

package/dist/route-methods.d.ts

@@ -6,51 +6,20 @@
  */
 import { OpenApiOptions } from "./openapi";
 export type RouteMethods = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "ALL";
-/**
- * Options for defining a route's method and metadata.
- */
 export type RouteMethodOptions = {
-    /**
-     * HTTP method for the route (e.g., GET, POST, PUT, DELETE).
-     */
     method?: RouteMethods;
-    /**
-     * The path or endpoint for the route (e.g., "/users/:id").
-     */
     path?: string;
-    /**
-     * OpenAPI metadata for the route, including summary and description.
-     */
     openapi?: OpenApiOptions;
-    /**
-     * Name of the route.
-     *
-     * @description If Swagger is enabled in the project, this will appear as a tag in the generated documentation.
-     */
     name?: string;
 };
-export declare function createRouteDecorator(method?: RouteMethods): (pathOrOptions: string | RouteMethodOptions, maybeOptions?: RouteMethodOptions) => MethodDecorator;
-/**
- * @description HTTP Get method
- * @param {string} path
- */
-export declare function Get(path?: string): MethodDecorator;
-export declare function Get(path: string | RouteMethodOptions): MethodDecorator;
 /**
- * @description HTTP Get method
- * @param {string} path
- * @param {RouteMethodOptions} options
+ * Generic Route decorator factory
  */
-export declare function Get(path: string, options: RouteMethodOptions): MethodDecorator;
-export declare function Post(path?: string): MethodDecorator;
-export declare function Post(path: string | RouteMethodOptions): MethodDecorator;
-export declare function Post(path: string, options: RouteMethodOptions): MethodDecorator;
-export declare function Put(path?: string): MethodDecorator;
-export declare function Put(path: string | RouteMethodOptions): MethodDecorator;
-export declare function Put(path: string, options: RouteMethodOptions): MethodDecorator;
-export declare function Delete(path?: string): MethodDecorator;
-export declare function Delete(path: string | RouteMethodOptions): MethodDecorator;
-export declare function Delete(path: string, options: RouteMethodOptions): MethodDecorator;
-export declare const Patch: (pathOrOptions: string | RouteMethodOptions, maybeOptions?: RouteMethodOptions) => MethodDecorator;
-export declare const Options: (pathOrOptions: string | RouteMethodOptions, maybeOptions?: RouteMethodOptions) => MethodDecorator;
-export declare const All: (pathOrOptions: string | RouteMethodOptions, maybeOptions?: RouteMethodOptions) => MethodDecorator;
+export declare function Route(method: RouteMethods, pathOrOptions?: string | RouteMethodOptions, maybeOptions?: RouteMethodOptions): MethodDecorator;
+export declare const Get: (pathOrOptions?: string | RouteMethodOptions, maybeOptions?: RouteMethodOptions) => MethodDecorator;
+export declare const Post: (pathOrOptions?: string | RouteMethodOptions, maybeOptions?: RouteMethodOptions) => MethodDecorator;
+export declare const Put: (pathOrOptions?: string | RouteMethodOptions, maybeOptions?: RouteMethodOptions) => MethodDecorator;
+export declare const Delete: (pathOrOptions?: string | RouteMethodOptions, maybeOptions?: RouteMethodOptions) => MethodDecorator;
+export declare const Patch: (pathOrOptions?: string | RouteMethodOptions, maybeOptions?: RouteMethodOptions) => MethodDecorator;
+export declare const Options: (pathOrOptions?: string | RouteMethodOptions, maybeOptions?: RouteMethodOptions) => MethodDecorator;
+export declare const All: (pathOrOptions?: string | RouteMethodOptions, maybeOptions?: RouteMethodOptions) => MethodDecorator;

package/dist/route-methods.js

@@ -6,78 +6,44 @@
  * @url https://github.com/xtareq
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.All = exports.Options = exports.Patch = void 0;
-exports.createRouteDecorator = createRouteDecorator;
+exports.All = exports.Options = exports.Patch = exports.Delete = exports.Put = exports.Post = exports.Get = void 0;
+exports.Route = Route;
+const container_1 = require("./container");
+/**
+ * Generic Route decorator factory
+ */
+function Route(method, pathOrOptions, maybeOptions) {
+    return function (target, propertyKey, descriptor) {
+        let path = "/";
+        let options = {};
+        if (typeof pathOrOptions === "string") {
+            path = pathOrOptions;
+            options = maybeOptions || {};
+        }
+        else if (typeof pathOrOptions === "object") {
+            options = pathOrOptions;
+            path = options.name || "/";
+        }
+        // Define metadata
+        Reflect.defineMetadata("route:path", path, target, propertyKey);
+        Reflect.defineMetadata("route:method", method, target, propertyKey);
+        Reflect.defineMetadata(container_1.ROUTE_META_KEY, { ...options, method, path, controller: target.constructor.name }, target, propertyKey);
+        if (options) {
+            Reflect.defineMetadata("route:options", options, target, propertyKey);
+        }
+    };
+}
+const Get = (pathOrOptions, maybeOptions) => Route("GET", pathOrOptions, maybeOptions);
 exports.Get = Get;
+const Post = (pathOrOptions, maybeOptions) => Route("POST", pathOrOptions, maybeOptions);
 exports.Post = Post;
+const Put = (pathOrOptions, maybeOptions) => Route("PUT", pathOrOptions, maybeOptions);
 exports.Put = Put;
+const Delete = (pathOrOptions, maybeOptions) => Route("DELETE", pathOrOptions, maybeOptions);
 exports.Delete = Delete;
-const container_1 = require("./container");
-const schema = {
-    tags: ["hello"],
-};
-// Overloads
-// Implementation
-function createRouteDecorator(method = "GET") {
-    return function (pathOrOptions, maybeOptions) {
-        return function (target, propertyKey, descriptor) {
-            let path = "/";
-            let options = {};
-            if (typeof pathOrOptions === "string") {
-                path = pathOrOptions;
-                options = maybeOptions || {};
-            }
-            else if (typeof pathOrOptions === "object") {
-                options = pathOrOptions;
-                path = options.name || "/";
-            }
-            // Define metadata
-            Reflect.defineMetadata("route:path", path, target, propertyKey);
-            Reflect.defineMetadata("route:method", method || "GET", target, propertyKey);
-            Reflect.getMetadata(container_1.CONTROLLER_META_KEY, target.constructor);
-            Reflect.defineMetadata(container_1.ROUTE_META_KEY, { ...options, method, path, controller: target.constructor.name }, target, propertyKey);
-            if (options) {
-                Reflect.defineMetadata("route:options", options, target, propertyKey);
-            }
-        };
-    };
-}
-function Get(path, options) {
-    const parsedPath = !path && !options ? "/" : path;
-    if (options) {
-        return createRouteDecorator("GET")(parsedPath, options);
-    }
-    else {
-        return createRouteDecorator("GET")(parsedPath);
-    }
-}
-function Post(path, options) {
-    const parsedPath = !path && !options ? "/" : path;
-    if (options) {
-        return createRouteDecorator("POST")(parsedPath, options);
-    }
-    else {
-        return createRouteDecorator("POST")(parsedPath);
-    }
-}
-function Put(path, options) {
-    const parsedPath = !path && !options ? "/" : path;
-    if (options) {
-        return createRouteDecorator("PUT")(parsedPath, options);
-    }
-    else {
-        return createRouteDecorator("PUT")(parsedPath);
-    }
-}
-function Delete(path, options) {
-    const parsedPath = !path && !options ? "/" : path;
-    if (options) {
-        return createRouteDecorator("DELETE")(parsedPath, options);
-    }
-    else {
-        return createRouteDecorator("DELETE")(parsedPath);
-    }
-}
-exports.Patch = createRouteDecorator("PATCH");
-exports.Options = createRouteDecorator("OPTIONS");
-exports.All = createRouteDecorator("ALL");
+const Patch = (pathOrOptions, maybeOptions) => Route("PATCH", pathOrOptions, maybeOptions);
+exports.Patch = Patch;
+const Options = (pathOrOptions, maybeOptions) => Route("OPTIONS", pathOrOptions, maybeOptions);
+exports.Options = Options;
+const All = (pathOrOptions, maybeOptions) => Route("ALL", pathOrOptions, maybeOptions);
+exports.All = All;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avleon/core",
-  "version": "0.0.38",
+  "version": "0.0.40",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "keywords": [
@@ -11,64 +11,69 @@
   ],
   "author": "Tareq Hossain",
   "license": "ISC",
-  "devDependencies": {
-    "@types/jest": "^29.5.14",
-    "@types/node": "^20.17.25",
-    "@types/pg": "^8.15.2",
-    "@typescript-eslint/eslint-plugin": "^8.32.0",
-    "@typescript-eslint/parser": "^8.32.0",
-    "class-transformer": "^0.5.1",
-    "class-validator": "^0.14.1",
-    "eslint": "^9.26.0",
-    "eslint-config-prettier": "^10.1.5",
-    "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",
-    "nodemon": "^3.1.7",
-    "pg": "^8.16.0",
-    "prettier": "^3.5.3",
-    "sharp": "^0.33.5",
-    "sqlite": "^5.1.1",
-    "sqlite3": "^5.1.7",
-    "ts-jest": "^29.2.5",
-    "ts-node": "^10.9.2",
-    "tsc-watch": "^6.2.1",
-    "typeorm": "^0.3.20",
-    "typescript": "^5.7.2"
+  "description": "avleon core",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/avleonjs/avleon-core"
+  },
+  "files": [
+    "dist"
+  ],
+  "directories": {
+    "test": "."
   },
   "dependencies": {
-    "@fastify/cors": "^11.0.0",
-    "@fastify/multipart": "^9.0.3",
-    "@fastify/static": "^8.1.1",
-    "@fastify/swagger": "^9.4.0",
-    "@fastify/swagger-ui": "^5.1.0",
-    "@fastify/view": "^11.0.0",
-    "@types/mssql": "^9.1.7",
-    "bcryptjs": "^3.0.2",
-    "cross-env": "^7.0.3",
-    "dotenv": "^16.4.7",
-    "fastify": "^5.1.0",
-    "fastify-socket.io": "^5.1.0",
-    "highlight.js": "^11.9.0",
-    "pino": "^9.6.0",
-    "pino-pretty": "^13.0.0",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.2",
+    "fastify": "^5.6.0",
+    "pino": "^9.10.0",
     "reflect-metadata": "^0.2.2",
-    "rimraf": "^6.0.1",
-    "socket.io": "^4.8.1",
     "typedi": "^0.10.0"
   },
   "peerDependencies": {
+    "@fastify/cors": "*",
+    "@fastify/multipart": "*",
+    "@fastify/static": "*",
+    "@fastify/swagger": "*",
+    "@fastify/swagger-ui": "*",
+    "@fastify/view": "*",
     "@scalar/fastify-api-reference": "*",
+    "bcryptjs": "3.0.2",
+    "dotenv": "*",
+    "fastify-socket.io": "*",
+    "highlight.js": "*",
     "ioredis": "*",
+    "knex": "*",
+    "mssql": "*",
+    "mysql2": "*",
+    "pg": "*",
     "sharp": "*",
-    "typeorm": "*",
-    "knex": "*"
+    "socket.io": "*",
+    "sqlite3": "*",
+    "typeorm": "*"
   },
   "peerDependenciesMeta": {
+    "bcryptjs": {
+      "optional": true
+    },
+    "@fastify/cors": {
+      "optional": true
+    },
+    "@fastify/multipart": {
+      "optional": true
+    },
+    "@fastify/static": {
+      "optional": true
+    },
+    "@fastify/swagger": {
+      "optional": true
+    },
+    "@fastify/swagger-ui": {
+      "optional": true
+    },
+    "@fastify/view": {
+      "optional": true
+    },
     "@scalar/fastify-api-reference": {
       "optional": true
     },
@@ -83,8 +88,49 @@
     },
     "knex": {
       "optional": true
+    },
+    "mssql": {
+      "optional": true
+    },
+    "mysql2": {
+      "optional": true
+    },
+    "pg": {
+      "optional": true
+    },
+    "sqlite3": {
+      "optional": true
+    },
+    "fastify-socket.io": {
+      "optional": true
+    },
+    "socket.io": {
+      "optional": true
+    },
+    "dotenv": {
+      "optional": true
+    },
+    "highlight.js": {
+      "optional": true
     }
   },
+  "devDependencies": {
+    "@types/bcryptjs": "^3.0.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.19.17",
+    "@typescript-eslint/eslint-plugin": "^8.44.0",
+    "@typescript-eslint/parser": "^8.44.0",
+    "eslint": "^9.36.0",
+    "eslint-config-prettier": "^10.1.8",
+    "husky": "^8.0.3",
+    "jest": "^29.7.0",
+    "lint-staged": "^16.1.6",
+    "prettier": "^3.6.2",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.4.4",
+    "tsc-watch": "^6.3.1",
+    "typescript": "^5.7.2"
+  },
   "lint-staged": {
     "*.{js,ts,json,md}": "pnpm format",
     "*.{js,ts}": [
@@ -92,20 +138,6 @@
       "cross-env CI=true jest --bail --findRelatedTests --passWithNoTests --config=jest.config.js"
     ]
   },
-  "optionalDependencies": {
-    "typeorm": "*"
-  },
-  "directories": {
-    "test": "."
-  },
-  "description": "avleon core",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/avleonjs/avleon-core"
-  },
-  "files": [
-    "dist"
-  ],
   "scripts": {
     "build": "npm run clean && tsc",
     "clean": "rimraf dist",