@asenajs/asena 0.1.18 → 0.2.0

package/README.md

@@ -1,7 +1,7 @@
 # Asena
 
 Asena is a NestJS-like IoC web framework built on top of Hono and Bun. It combines the power of dependency injection
-with the performance of Bun runtime and the flexibility of Hono web framework.
+with the performance of Bun runtime and the flexibility of Adapter design system.
 
 ## Documentation
 
@@ -15,16 +15,49 @@ For detailed documentation, please visit [not ready yet](https://asena.sh). Docu
 - **WebSocket Support**: Built-in WebSocket handling capabilities
 - **Middleware System**: Flexible middleware architecture
 - **HTTP Adapters**: Extensible adapter system with Hono as default
+- **Zero Dependencies**: Only uses reflect-metadata for dependency injection
+- **TypeScript Support**: Full TypeScript support with strict mode
+- **Modular Architecture**: Easy to extend and customize
+
+## Installation
+
+```bash
+bun add @asenajs/asena
+```
 
 ## Quick Start
 
+The easiest way to create a new Asena project is using the CLI:
+
+```bash
+# Create a new project
+bun add -D @asenajs/asena-cli
+asena create
+```
+
+This will create a new project with the following structure:
+```
+├── src/
+│ ├── controllers/
+│ │ └── AsenaController.ts
+│ └── index.ts
+├── package.json
+├── tsconfig.json
+├── .eslintrc.js
+├── .eslintignore
+└── .prettierrc.js
+```
+
+Alternatively, you can create a project manually:
+
 First, create a new project using Bun:
 
 ```bash
 bun init
-````
+```
+
+For decorators working properly, you need to add some settings to your tsconfig. Here is a recommended file:
 
-For decorators working properly, you need to add some settings to your tsconfig. Here is an recommended file:
 ```json
 {
   "compilerOptions": {
@@ -45,7 +78,7 @@ For decorators working properly, you need to add some settings to your tsconfig.
     "noEmit": true,
 
     // Best practices
-    "strict": false,
+    "strict": true,
     "skipLibCheck": true,
     "noFallthroughCasesInSwitch": true,
 
@@ -55,26 +88,23 @@ For decorators working properly, you need to add some settings to your tsconfig.
     "noPropertyAccessFromIndexSignature": true
   }
 }
-
 ```
 
 Then, install the required packages:
-```bash
 
-bun add @asenajs/asena hono winston
+```bash
+bun add @asenajs/asena @asenajs/hono-adapter 
 ```
+
 Add @asenajs/asena-cli to your package. This package provides a CLI for creating and managing Asena projects.
 
 ```bash
 bun add -D @asenajs/asena-cli
-````
-
+```
 
-Then, create a new .asenarc.json file using the CLI:
+Then, create a new asena-config.ts file using the CLI:
 
 ```bash
-
-## Creates a .asenarc.json file with default values (requires manual updates). Source folder is 'src'.
 asena init
 ```
 
@@ -85,23 +115,30 @@ Create index.ts file under your src folder:
 
 ```typescript
 // src/index.ts
-import {AsenaServer, DefaultLogger} from "@asenajs/asena";
-
-await new AsenaServer().logger(new DefaultLogger()).port(3000).start();
+import { AsenaServer } from '@asenajs/asena';
+import { DefaultLogger } from "@asenajs/asena/logger";
+import { createHonoAdapter } from '@asenajs/hono-adapter';
+
+const [adapter, logger] = createHonoAdapter(new DefaultLogger());
+await new AsenaServer(adapter)
+  .logger(logger)
+  .port(3000)
+  .start(true);
 ```
 
 To run asena you need at least one controller. Create a new controller:
 
 ```typescript
 // src/controllers/TestController.ts
-import {type Context, Controller, Get} from "@asenajs/asena";
+import type { Context } from '@asenajs/hono-adapter';
+import { Controller } from '@asenajs/asena/server';
+import { Get } from '@asenajs/asena/web';
 
-@Controller("/hello")
+@Controller('/hello')
 export class TestController {
-
-    @Get("/world")
+    @Get('/world')
     public async getHello(context: Context) {
-        return context.send("Hello World");
+        return context.send('Hello World');
     }
 }
 ```
@@ -109,167 +146,61 @@ export class TestController {
 Finally, run the project:
 
 ```bash
-
 ## only for fast developing purposes
-asena dev start 
-````
+asena dev start
+```
+
 ```bash
 ## or you can simply build then run your bundled project
 asena build
-## then go to dist folder and run the project this way it will consume less memory 
+## then go to dist folder and run the project this way it will consume less memory and it will be faster.
 bun index.asena.js
 ```
 
-## Example
-
-Here is a simple example of a controller with service and middleware:
-
-### Middleware
-This middleware sets a value to the context object.
-```typescript
-// src/middleware/TestMiddleware.ts
-import {type Context, Middleware, MiddlewareService} from "@asenajs/asena";
-
-@Middleware()
-export class TestMiddleware extends MiddlewareService {
-
-    public handle(context: Context, next: Function) {
-        context.setValue("testValue", "test");
-
-        next();
-    }
-}
-```
-
-### Service
-Basic service with a getter and setter.
-
-```typescript
-import {Service} from "@asenajs/asena";
-
-@Service()
-export class HelloService {
-
-    private _foo: string = "bar";
-
-    public get foo(): string {
-        return this._foo;
-    }
-
-    public set foo(value: string) {
-        this._foo = value;
-    }
-}
-
-```
-
-### Controller
-Controller with a GET route that uses the middleware and service.
-
-```typescript
-// src/controller/TestController.ts
-import {type Context, Controller, Get, Inject} from "@asenajs/asena";
-import {HelloService} from "../service/HelloService.ts";
-import {TestMiddleware} from "../middleware/TestMiddleware.ts";
-
-@Controller("/v1")
-export class TestController {
-
-    @Inject(HelloService)
-    private helloService: HelloService
-
-    @Get("foo")
-    public async getFoo(context: Context) {
-        return context.send(this.helloService.foo);
-    }
-
-    @Get({path: "world", middlewares: [TestMiddleware]})
-    public async getHello(context: Context) {
-        const testValue: string = context.getValue("testValue");
-
-        return context.send(testValue);
-    }
-}
-```
+## CLI Commands
 
-### Index
-The main file that starts the server.
+For more information about CLI commands and usage, please visit:
+[Asena CLI Documentation](https://github.com/AsenaJs/Asena-cli/blob/master/README.md)
 
-```typescript
-// src/index.ts
-import {AsenaServer, DefaultLogger} from "@asenajs/asena";
 
-await new AsenaServer().logger(new DefaultLogger()).port(3000).start();
-```
+## Project Structure
 
-then run
-```bash
-asena dev start
 ```
-
-You should see the following output:
-```text
-
-Build completed successfully.  
-2024-11-19 17:58:35 [info]:     
-    ___    _____  ______ _   __ ___ 
-   /   |  / ___/ / ____// | / //   |
-  / /| |  \__ \ / __/  /  |/ // /| |
- / ___ | ___/ // /___ / /|  // ___ |
-/_/  |_|/____//_____//_/ |_//_/  |_|  
-                             
-2024-11-19 17:58:35 [info]:     IoC initialized 
-2024-11-19 17:58:35 [info]:     No server services found 
-2024-11-19 17:58:35 [info]:     Controller: V1 found 
-2024-11-19 17:58:35 [info]:     Successfully registered GET route for PATH: /v1/foo 
-2024-11-19 17:58:35 [info]:     Successfully registered GET route for PATH: /v1/world 
-2024-11-19 17:58:35 [info]:     No websockets found 
-2024-11-19 17:58:35 [info]:     Server started on port 3000 
+lib/
+├── adapter/     # HTTP adapter implementations
+├── server/      # Core server functionality
+├── ioc/         # Dependency injection container
+├── utils/       # Utility functions
+├── test/        # Test utilities
+└── logger/      # Logging system
 ```
 
-and you see the result on your browser [http://localhost:3000/v1/foo](http://localhost:3000/v1/foo) with "bar" message.
-
-`Note`: For more example, you can check this project [Example](https://github.com/LibirSoft/AsenaExample).
-
 ## Core Concepts
 
 - **Controllers**: Handle incoming requests using decorators
 - **Services**: Business logic containers that can be injected
-- **ServerSrvices**: Server-wide services that can be injected (e.g. Database)
 - **Middleware**: Request/Response interceptors
-- **Adapters**: Framework adapters (default: Hono)
-- **WebSocket**: Real-time communication support
-- **Validators**: Request validation system
-
-## Architecture
-
-Asena follows a modular architecture with:
-
-- IoC Container for dependency management
-- Adapter pattern for framework integration
-- Decorator-based routing system
-- Middleware pipeline
-- WebSocket integration
-- Context management
+- **WebSocket**: Built-in WebSocket support
+- **HTTP Status**: Standard HTTP status codes and utilities
 
 ## Performance
 
-Built on Bun runtime and Hono, Asena provides:
+Built on Bun runtime, Asena provides:
 
 - Fast startup time
 - Low memory footprint
 - Quick request processing
 - Efficient WebSocket handling
 
-and here is the benchmark result of Asena with Hono adapter(Basic hello world example) in every test we used bun to run
+Here is the benchmark result of Asena with Hono adapter (Basic hello world example) in every test we used bun to run
 the project:
 
 ### Performance Comparison (Fastest to Slowest)
 
 | Framework                            | Requests/sec | Latency (avg) | Transfer/sec |
-|--------------------------------------|--------------|---------------|--------------|
+| ------------------------------------ | ------------ | ------------- | ------------ |
 | Hono                                 | 147,031.08   | 2.69ms        | 18.09MB      |
-| Asena                                | 137,148.80   | 2.89ms        | 16.74MB      |
+| Asena + Hono-adapter                 | 137,148.80   | 2.89ms        | 16.74MB      |
 | NestJS (Bun + Fastify)               | 81,652.05    | 6.01ms        | 13.78MB      |
 | NestJS (Bun)                         | 64,435.83    | 6.14ms        | 11.80MB      |
 | NestJS (Bun + kiyasov/platform-hono) | 45,082.27    | 8.79ms        | 5.55MB       |
@@ -284,3 +215,15 @@ the project:
 > - Running on same hardware
 
 _Note: Lower latency and higher requests/sec indicate better performance_
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+If you encounter any issues or have questions, please open an issue on the [GitHub repository](https://github.com/AsenaJs/Asena/issues).

package/dist/index.d.ts

@@ -1,10 +1 @@
 export { AsenaServer } from './lib/server';
-export * from './lib/server/web/middleware';
-export * from './lib/services';
-export * from './lib/adapter';
-export * from './lib/adapter/defaultAdapter';
-export { Implements } from './lib/ioc/component/decorators/Implements';
-export { Inject } from './lib/ioc/component/decorators/Inject';
-export * from './lib/server/web/api';
-export * from './lib/server/web/websocket';
-export * from './lib/server/decorators';

package/dist/index.js

@@ -1,11 +1,2 @@
 export { AsenaServer } from './lib/server';
-export * from './lib/server/web/middleware';
-export * from './lib/services';
-export * from './lib/adapter';
-export * from './lib/adapter/defaultAdapter';
-export { Implements } from './lib/ioc/component/decorators/Implements';
-export { Inject } from './lib/ioc/component/decorators/Inject';
-export * from './lib/server/web/api';
-export * from './lib/server/web/websocket';
-export * from './lib/server/decorators';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,8BAA8B,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,2CAA2C,CAAC;AACvE,OAAO,EAAE,MAAM,EAAE,MAAM,uCAAuC,CAAC;AAC/D,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC"}

package/dist/lib/adapter/AsenaAdapter.d.ts

@@ -1,88 +1,80 @@
-import type { RouteParams } from './types';
-import type { BaseMiddleware } from '../server/web/types';
-import type { ValidatorClass } from '../server/types';
+import type { AsenaServeOptions, BaseMiddleware, ErrorHandler, RouteParams } from './types';
 import type { Server } from 'bun';
 import type { AsenaWebsocketAdapter } from './AsenaWebsocketAdapter';
-import type { ServerLogger } from '../services';
+import type { ServerLogger } from '../logger';
+import type { AsenaContext } from './AsenaContext';
 /**
  * Abstract class representing an adapter for the Asena framework.
+ * This adapter serves as a base interface between the framework and different server implementations.
  *
- * @template A - Type for the application instance.
- * @template H - Type for the handler.
- * @template AM - Type for the middleware.
- * @template AH - Type for the handler.
- * @template R - Type for the request.
- * @template S - Type for the response.
- * @template WSA - Type for the WebSocket adapter.
+ * @template A - Type for the application instance (e.g., Express, Bun, etc.)
+ * @template R - Type for the request object
+ * @template S - Type for the response object
+ * @template VS - Type for the validator schema
+ * @template WSA - Type for the WebSocket adapter implementation
  */
-export declare abstract class AsenaAdapter<A = unknown, H = unknown, AM = unknown, AH = unknown, R = unknown, S = unknown, WSA extends AsenaWebsocketAdapter<A, AM> = AsenaWebsocketAdapter<A, AM>> {
+export declare abstract class AsenaAdapter<A, C extends AsenaContext<any, any>, VS, WSA extends AsenaWebsocketAdapter<A, C>> {
     /**
-     * The application instance.
+     * The name identifier of the adapter
+     */
+    readonly name: string;
+    /**
+     * The main application instance
      */
     app: A;
     /**
-     * The WebSocket adapter instance.
+     * WebSocket adapter instance for handling real-time communications
      */
     websocketAdapter: WSA;
     /**
-     * The port number.
+     * Server port number
      */
     protected port: number;
     /**
-     * The logger instance.
+     * Logger instance for server operations
      */
     protected logger: ServerLogger;
-    protected constructor(websocketAdapter: WSA, logger?: ServerLogger);
-    /**
-     * Sets the port number.
-     *
-     * @param {number} port - The port number to set.
-     */
-    abstract setPort(port: number): void;
     /**
-     * Uses a middleware.
-     *
-     * @param {BaseMiddleware<R, S>} middleware - The middleware to use.
-     * @param path - The path to use the middleware on.
+     * Creates a new adapter instance
+     * @param websocketAdapter - WebSocket adapter implementation
+     * @param logger - Optional custom logger implementation
      */
-    abstract use(middleware: BaseMiddleware<R, S>, path?: string): void;
+    protected constructor(websocketAdapter: WSA, logger?: ServerLogger);
     /**
-     * Registers a route.
-     *
-     * @param {RouteParams<AM, AH>} params - The route parameters.
+     * Configures the server port
+     * @param port - Port number to listen on
      */
-    abstract registerRoute(params: RouteParams<AM, AH>): void;
+    abstract setPort(port: number): void;
     /**
-     * Prepares middlewares.
-     *
-     * @param {BaseMiddleware<R, S> | BaseMiddleware<R, S>[]} middlewares - The middlewares to prepare.
-     * @returns {any[]} The prepared middlewares.
+     * Registers middleware to the application
+     * @param middleware - Middleware implementation
+     * @param path - Optional path to apply the middleware to
      */
-    abstract prepareMiddlewares(middlewares: BaseMiddleware<R, S> | BaseMiddleware<R, S>[]): any[];
+    abstract use(middleware: BaseMiddleware<C>, path?: string): Promise<void> | void;
     /**
-     * Prepares a handler.
-     *
-     * @param {H} handler - The handler to prepare.
-     * @returns {any} The prepared handler.
+     * Registers a new route with the application
+     * @param params - Route configuration parameters
      */
-    abstract prepareHandler(handler: H): any;
+    abstract registerRoute(params: RouteParams<C, VS>): Promise<void> | void;
     /**
-     * Starts the server.
-     *
-     * @returns {Promise<Server>} A promise that resolves to the server instance.
+     * Initializes and starts the server
+     * @returns Server instance
      */
-    abstract start(): Promise<Server>;
+    abstract start(): Promise<Server> | Server;
     /**
-     * Sets an error handler.
-     *
-     * @param {any} errorHandler - The error handler to set.
+     * Sets up global error handling
+     * @param errorHandler - Error handler implementation
      */
-    abstract onError(errorHandler: any): void;
+    abstract onError(errorHandler: ErrorHandler<C>): Promise<void> | void;
     /**
-     * Prepares a validator.
+     * Configures server options.
      *
-     * @param {ValidatorClass<AM>} validator - The validator to prepare.
-     * @returns {any} The prepared validator.
+     * @param options - Configuration options for the server, which can include:
+     *   - `ServeOptions`: Basic server options.
+     *   - `TLSServeOptions`: Options for TLS/SSL configuration.
+     *   - `UnixServeOptions`: Options for Unix domain sockets.
+     *   - `UnixTLSServeOptions`: Options for Unix domain sockets with TLS/SSL.
+     * @returns A promise that resolves when the options are set, or void.
      */
-    abstract prepareValidator(validator: ValidatorClass<AM>): any;
+    abstract serveOptions(options: () => Promise<AsenaServeOptions> | AsenaServeOptions): Promise<void> | void;
 }

package/dist/lib/adapter/AsenaAdapter.js

@@ -1,35 +1,46 @@
 /**
  * Abstract class representing an adapter for the Asena framework.
+ * This adapter serves as a base interface between the framework and different server implementations.
  *
- * @template A - Type for the application instance.
- * @template H - Type for the handler.
- * @template AM - Type for the middleware.
- * @template AH - Type for the handler.
- * @template R - Type for the request.
- * @template S - Type for the response.
- * @template WSA - Type for the WebSocket adapter.
+ * @template A - Type for the application instance (e.g., Express, Bun, etc.)
+ * @template R - Type for the request object
+ * @template S - Type for the response object
+ * @template VS - Type for the validator schema
+ * @template WSA - Type for the WebSocket adapter implementation
  */
 export class AsenaAdapter {
     /**
-     * The application instance.
+     * The name identifier of the adapter
+     */
+    name;
+    /**
+     * The main application instance
      */
     app;
     /**
-     * The WebSocket adapter instance.
+     * WebSocket adapter instance for handling real-time communications
      */
     websocketAdapter;
     /**
-     * The port number.
+     * Server port number
      */
     port;
     /**
-     * The logger instance.
+     * Logger instance for server operations
      */
     logger = console;
+    /**
+     * Creates a new adapter instance
+     * @param websocketAdapter - WebSocket adapter implementation
+     * @param logger - Optional custom logger implementation
+     */
     constructor(websocketAdapter, logger) {
         this.websocketAdapter = websocketAdapter;
         if (logger) {
             this.logger = logger;
+            if (!this.websocketAdapter.logger) {
+                this.websocketAdapter.logger = logger;
+            }
         }
     }
 }

package/dist/lib/adapter/AsenaAdapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"AsenaAdapter.js","sourceRoot":"","sources":["../../../lib/adapter/AsenaAdapter.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,YAAY;IAUhC;;OAEG;IACI,GAAG,CAAI;IAEd;;OAEG;IACI,gBAAgB,CAAM;IAE7B;;OAEG;IACO,IAAI,CAAS;IAEvB;;OAEG;IACO,MAAM,GAAiB,OAAO,CAAC;IAEzC,YAAsB,gBAAqB,EAAE,MAAqB;QAChE,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACvB,CAAC;IACH,CAAC;CA8DF"}
+{"version":3,"file":"AsenaAdapter.js","sourceRoot":"","sources":["../../../lib/adapter/AsenaAdapter.ts"],"names":[],"mappings":"AAMA;;;;;;;;;GASG;AACH,MAAM,OAAgB,YAAY;IAEhC;;OAEG;IACa,IAAI,CAAS;IAE7B;;OAEG;IACI,GAAG,CAAI;IAEd;;OAEG;IACI,gBAAgB,CAAM;IAE7B;;OAEG;IACO,IAAI,CAAS;IAEvB;;OAEG;IACO,MAAM,GAAiB,OAAO,CAAC;IAEzC;;;;OAIG;IACH,YAAsB,gBAAqB,EAAE,MAAqB;QAChE,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YAErB,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC;gBAClC,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,MAAM,CAAC;YACxC,CAAC;QACH,CAAC;IACH,CAAC;CA6CF"}