arikajs 0.0.4 → 0.0.6

package/CHANGELOG.md

@@ -0,0 +1,66 @@
+# arikajs
+
+## 0.0.6
+
+### Patch Changes
+
+- fix: ensure CLI templates use semantic version dependencies instead of local file paths when published to npm
+- Updated dependencies
+  - @arikajs/cli@0.0.6
+  - @arikajs/auth@0.0.6
+  - @arikajs/authorization@0.0.6
+  - @arikajs/cache@0.0.6
+  - @arikajs/console@0.0.6
+  - @arikajs/database@0.0.6
+  - @arikajs/dispatcher@0.0.6
+  - @arikajs/encryption@0.0.6
+  - @arikajs/events@0.0.6
+  - @arikajs/foundation@0.0.6
+  - @arikajs/http@0.0.6
+  - @arikajs/localization@0.0.6
+  - @arikajs/logging@0.0.6
+  - @arikajs/mail@0.0.6
+  - @arikajs/middleware@0.0.6
+  - @arikajs/queue@0.0.6
+  - @arikajs/router@0.0.6
+  - @arikajs/scheduler@0.0.6
+  - @arikajs/session@0.0.6
+  - @arikajs/storage@0.0.6
+  - @arikajs/validation@0.0.6
+  - @arikajs/view@0.0.6
+
+## 0.0.5
+
+### Patch Changes
+
+- feat: implement CSRF protection and standardized middleware architecture
+
+  - Added session-based CSRF protection middleware.
+  - Refactored middleware into project-level stubs for better customization.
+  - Standardized auth controller stubs.
+  - Enhanced CLI project scaffolding.
+  - Added session and localization packages.
+
+- Updated dependencies
+  - @arikajs/auth@0.0.5
+  - @arikajs/authorization@0.0.5
+  - @arikajs/cache@0.0.5
+  - @arikajs/cli@0.0.5
+  - @arikajs/console@0.0.5
+  - @arikajs/database@0.0.5
+  - @arikajs/dispatcher@0.0.5
+  - @arikajs/encryption@0.0.5
+  - @arikajs/events@0.0.5
+  - @arikajs/foundation@0.0.5
+  - @arikajs/http@0.0.5
+  - @arikajs/localization@0.0.5
+  - @arikajs/logging@0.0.5
+  - @arikajs/mail@0.0.5
+  - @arikajs/middleware@0.0.5
+  - @arikajs/queue@0.0.5
+  - @arikajs/router@0.0.5
+  - @arikajs/scheduler@0.0.5
+  - @arikajs/session@0.0.5
+  - @arikajs/storage@0.0.5
+  - @arikajs/validation@0.0.5
+  - @arikajs/view@0.0.5

package/README.md

@@ -2,7 +2,7 @@
 
 <div align="center">
 
-![ArikaJS Logo](https://via.placeholder.com/200x200?text=ArikaJS)
+<img src="../cli/templates/app/public/assets/img/logo.png" alt="ArikaJS Logo" width="400">
 
 **A Modern, Elegant Web Framework for Node.js**
 
@@ -38,7 +38,9 @@ ArikaJS is a **modern, elegant, and powerful** Node.js framework that brings ent
 - 🔄 **Queue System** - Background job processing
 - 📦 **Service Providers** - Modular application architecture
 - 🎨 **Template Engine** - Flexible view rendering
+- ⚡ **Event System** - Decouple your application with powerful events and listeners
 - 🧪 **Testing Ready** - Built with testing in mind
+- 🛠️ **Global Helpers** - Intuitive functions like `app()`, `config()`, and `route()`
 
 ---
 
@@ -267,6 +269,23 @@ export class PaymentServiceProvider extends ServiceProvider {
 }
 ```
 
+### 🛠️ Global Helpers
+
+ArikaJS provides several global helper functions to make your code more concise:
+
+```typescript
+import { app, config, route } from 'arikajs';
+
+// Access the application container
+const userService = app().make(UserService);
+
+// Get configuration values with defaults
+const debug = config('app.debug', false);
+
+// Generate URLs for named routes
+const profileUrl = route('users.show', { id: 1 });
+```
+
 ### Database Migrations
 
 Manage your database schema with migrations:
@@ -382,6 +401,40 @@ For guides and examples, check out:
 
 ---
 
+## 🏗 Architecture
+
+```text
+arikajs/
+├── src/
+│   ├── Contracts
+│   │   └── Application.ts
+│   ├── http
+│   │   ├── Middleware
+│   │   │   ├── RequestLoggingMiddleware.ts
+│   │   │   ├── ValidateRequestMiddleware.ts
+│   │   │   └── ViewMiddleware.ts
+│   │   ├── Handler.ts
+│   │   └── Kernel.ts
+│   ├── providers
+│   │   ├── AuthServiceProvider.ts
+│   │   ├── DatabaseServiceProvider.ts
+│   │   ├── EventsServiceProvider.ts
+│   │   ├── FrameworkServiceProvider.ts
+│   │   ├── HttpServiceProvider.ts
+│   │   ├── LoggingServiceProvider.ts
+│   │   ├── SchedulerServiceProvider.ts
+│   │   ├── ValidationServiceProvider.ts
+│   │   └── ViewServiceProvider.ts
+│   ├── Application.ts
+│   ├── createApp.ts
+│   ├── helpers.ts
+│   └── index.ts
+├── tests/
+├── package.json
+├── tsconfig.json
+└── README.md
+```
+
 ## 🤝 Contributing
 
 We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
@@ -430,3 +483,4 @@ ArikaJS draws inspiration from the best practices and patterns of modern web fra
 [GitHub](https://github.com/arikajs) • [npm](https://www.npmjs.com/package/arikajs)
 
 </div>
+

package/dist/Application.d.ts

@@ -2,8 +2,13 @@ import { Application as FoundationApplication } from '@arikajs/foundation';
 import { Router } from '@arikajs/router';
 import { Application as ApplicationContract } from './Contracts/Application';
 export declare class Application extends FoundationApplication implements ApplicationContract {
+    static readonly VERSION = "0.0.5";
     protected router: Router;
+    protected server?: any;
+    protected isTerminating: boolean;
     constructor(basePath?: string);
+    boot(): Promise<void>;
+    version(): string;
     /**
      * Map a GET route.
      */
@@ -16,14 +21,26 @@ export declare class Application extends FoundationApplication implements Applic
      * Map a PUT route.
      */
     put(path: string, handler: any): import("@arikajs/router").RouteEntry;
+    patch(path: string, handler: any): import("@arikajs/router").RouteEntry;
     /**
      * Map a DELETE route.
      */
     delete(path: string, handler: any): import("@arikajs/router").RouteEntry;
+    options(path: string, handler: any): import("@arikajs/router").RouteEntry;
+    match(methods: string[], path: string, handler: any): import("@arikajs/router").RouteEntry[];
     /**
      * Start the HTTP server.
      */
     listen(port?: number): Promise<void>;
+    protected displayBanner(port: number): void;
+    /**
+     * Get the HTTP server callback for raw http.createServer() usage.
+     */
+    getCallback(): (req: any, res: any) => void;
+    /**
+     * Gracefully terminate the application.
+     */
+    terminate(): Promise<void>;
     /**
      * Get the router instance.
      */

package/dist/Application.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Application.d.ts","sourceRoot":"","sources":["../src/Application.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,IAAI,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAE,MAAM,EAAS,MAAM,iBAAiB,CAAC;AAGhD,OAAO,EAAE,WAAW,IAAI,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAE7E,qBAAa,WAAY,SAAQ,qBAAsB,YAAW,mBAAmB;IACjF,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;gBAEb,QAAQ,GAAE,MAAsB;IAa5C;;OAEG;IACI,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG;IAIrC;;OAEG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG;IAItC;;OAEG;IACI,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG;IAIrC;;OAEG;IACI,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG;IAIxC;;OAEG;IACU,MAAM,CAAC,IAAI,GAAE,MAAa;IAyCvC;;OAEG;IACI,SAAS,IAAI,MAAM;CAG7B"}
+{"version":3,"file":"Application.d.ts","sourceRoot":"","sources":["../src/Application.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,IAAI,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAE,MAAM,EAAS,MAAM,iBAAiB,CAAC;AAGhD,OAAO,EAAE,WAAW,IAAI,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAG7E,qBAAa,WAAY,SAAQ,qBAAsB,YAAW,mBAAmB;IACjF,gBAAuB,OAAO,WAAW;IAEzC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC;IACvB,SAAS,CAAC,aAAa,EAAE,OAAO,CAAS;gBAE7B,QAAQ,GAAE,MAAsB;IAc/B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAM3B,OAAO,IAAI,MAAM;IAIxB;;OAEG;IACI,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG;IAIrC;;OAEG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG;IAItC;;OAEG;IACI,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG;IAI9B,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG;IAIvC;;OAEG;IACI,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG;IAIjC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG;IAIlC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG;IAI1D;;OAEG;IACU,MAAM,CAAC,IAAI,GAAE,MAAa;IA4BvC,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE,MAAM;IAgBpC;;OAEG;IACI,WAAW,KAmBN,KAAK,GAAG,EAAE,KAAK,GAAG;IAwB9B;;OAEG;IACU,SAAS;IAuDtB;;OAEG;IACI,SAAS,IAAI,MAAM;CAG7B"}

package/dist/Application.js

@@ -38,9 +38,12 @@ const foundation_1 = require("@arikajs/foundation");
 const router_1 = require("@arikajs/router");
 const FrameworkServiceProvider_1 = require("./providers/FrameworkServiceProvider");
 const logging_1 = require("@arikajs/logging");
+const helpers_1 = require("./helpers");
 class Application extends foundation_1.Application {
     constructor(basePath = process.cwd()) {
         super(basePath);
+        this.isTerminating = false;
+        (0, helpers_1.setApp)(this);
         // Initialize Core Components
         this.router = new router_1.Router(this.getContainer());
         // Register within container
@@ -48,6 +51,15 @@ class Application extends foundation_1.Application {
         // Register Core Framework Provider
         this.register(FrameworkServiceProvider_1.FrameworkServiceProvider);
     }
+    async boot() {
+        if (this.isBooted())
+            return;
+        await super.boot();
+        this.router.sync();
+    }
+    version() {
+        return Application.VERSION;
+    }
     /**
      * Map a GET route.
      */
@@ -66,12 +78,21 @@ class Application extends foundation_1.Application {
     put(path, handler) {
         return router_1.Route.put(path, handler);
     }
+    patch(path, handler) {
+        return router_1.Route.patch(path, handler);
+    }
     /**
      * Map a DELETE route.
      */
     delete(path, handler) {
         return router_1.Route.delete(path, handler);
     }
+    options(path, handler) {
+        return router_1.Route.options(path, handler);
+    }
+    match(methods, path, handler) {
+        return router_1.Route.match(methods, path, handler);
+    }
     /**
      * Start the HTTP server.
      */
@@ -84,33 +105,121 @@ class Application extends foundation_1.Application {
         const { Kernel } = await Promise.resolve().then(() => __importStar(require('./http/Kernel')));
         // Resolve Kernel from the container
         const kernel = this.make(Kernel);
-        const server = http.createServer(async (req, res) => {
-            // Instantiate Request and Response
-            // In a future refactor, these could also be resolved from factories
-            const request = new Request(this, req);
-            const response = new Response(res);
-            try {
-                const finalResponse = await kernel.handle(request, response);
-                kernel.terminate(request, finalResponse);
-            }
-            catch (error) {
-                if (!res.headersSent) {
-                    res.writeHead(500, { 'Content-Type': 'application/json' });
-                    res.end(JSON.stringify({
-                        error: 'Internal Server Error',
-                        message: error.message,
-                        stack: process.env.NODE_ENV === 'development' ? error.stack : undefined
-                    }));
-                }
-            }
-        });
+        const callback = this.getCallback();
+        this.server = http.createServer(callback);
+        // Graceful shutdown
+        const shutdown = () => this.terminate();
+        process.on('SIGINT', shutdown);
+        process.on('SIGTERM', shutdown);
         return new Promise((resolve) => {
-            server.listen(port, () => {
-                logging_1.Log.info(`ArikaJS application listening on http://localhost:${port}`);
+            this.server.listen(port, () => {
+                this.displayBanner(port);
                 resolve();
             });
         });
     }
+    displayBanner(port) {
+        const env = this.config().get('app.env', 'development');
+        console.log(`\x1b[38;5;99m
+     _         _ _              _ ____  
+    / \\   _ __(_) | ____ _     | / ___| 
+   / _ \\ | '__| | |/ / _\` |    | \\___ \\ 
+  / ___ \\| |  | |   < (_| |  __| |___) |
+ /_/   \\_\\_|  |_|_|\\_\\__,_| |____|____/ 
+\x1b[0m`);
+        console.log(` \x1b[1mArikaJS Framework\x1b[0m \x1b[38;5;99mv${this.version()}\x1b[0m`);
+        console.log(` \x1b[90mEnvironment:\x1b[0m \x1b[33m${env}\x1b[0m`);
+        console.log(` \x1b[90mLocal URL:\x1b[0m   \x1b[36mhttp://localhost:${port}\x1b[0m`);
+        console.log('');
+    }
+    /**
+     * Get the HTTP server callback for raw http.createServer() usage.
+     */
+    getCallback() {
+        if (!this.isBooted()) {
+            throw new Error('Application must be booted before calling getCallback()');
+        }
+        const { Kernel } = require('./http/Kernel');
+        const kernel = this.make(Kernel);
+        const { ObjectPool } = require('@arikajs/foundation');
+        const { Request: ArikaRequest, Response: ArikaResponse, RawResponse } = require('@arikajs/http');
+        const requestPool = new ObjectPool(() => new ArikaRequest(this, null), (obj) => obj.reset(null));
+        const responsePool = new ObjectPool(() => new ArikaResponse(null), (obj) => obj.reset(null));
+        return (req, res) => {
+            const request = requestPool.acquire();
+            const response = responsePool.acquire();
+            request.reset(req);
+            response.reset(res);
+            const handleRequest = async () => {
+                try {
+                    const finalResponse = await kernel.handle(request, response);
+                    kernel.terminate(request, finalResponse);
+                }
+                catch (error) {
+                    if (!res.headersSent) {
+                        res.writeHead(500, { 'Content-Type': 'application/json' });
+                        res.end(JSON.stringify({ error: 'Internal Server Error', message: error.message }));
+                    }
+                }
+                finally {
+                    requestPool.release(request);
+                    responsePool.release(response);
+                }
+            };
+            handleRequest();
+        };
+    }
+    /**
+     * Gracefully terminate the application.
+     */
+    async terminate() {
+        if (this.isTerminating)
+            return;
+        this.isTerminating = true;
+        if (this.server) {
+            // Close all active connections to speed up shutdown (Node 18.2+)
+            if (typeof this.server.closeAllConnections === 'function') {
+                this.server.closeAllConnections();
+            }
+            // Force close idle connections
+            if (typeof this.server.closeIdleConnections === 'function') {
+                this.server.closeIdleConnections();
+            }
+            await new Promise((resolve) => {
+                // Set a timeout to force resolve if server doesn't close in time
+                const timeout = setTimeout(() => {
+                    logging_1.Log.warning('HTTP server forced to close due to timeout.');
+                    resolve();
+                }, 1000);
+                this.server.close(() => {
+                    clearTimeout(timeout);
+                    logging_1.Log.info('HTTP server closed.');
+                    resolve();
+                });
+            });
+        }
+        // Close database connections
+        if (this.has('db')) {
+            try {
+                const db = this.make('db');
+                if (typeof db.closeAll === 'function') {
+                    await db.closeAll();
+                }
+            }
+            catch (e) { }
+        }
+        // Potential for other service termination (Queues, etc.)
+        // Remove signal listeners to prevent double triggers during exit
+        process.removeAllListeners('SIGINT');
+        process.removeAllListeners('SIGTERM');
+        // If we are in a testing or specific environment, we might not want to exit
+        if (process.env.NODE_ENV !== 'test') {
+            // Give a short delay for logs to flush before exiting
+            setTimeout(() => {
+                process.exit(0);
+            }, 50);
+        }
+    }
     /**
      * Get the router instance.
      */
@@ -119,4 +228,5 @@ class Application extends foundation_1.Application {
     }
 }
 exports.Application = Application;
+Application.VERSION = '0.0.5';
 //# sourceMappingURL=Application.js.map