@noxfly/noxus 1.0.4 → 1.0.5

package/.editorconfig

@@ -0,0 +1,16 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.ts]
+quote_type = single
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

package/README.md

@@ -62,10 +62,15 @@ However, you can feel free to keep both merged, this won't change anything, but
 // main/index.ts
 
 import { bootstrapApplication } from '@noxfly/noxus';
+import { AppModule } from './modules/app.module.ts';
 import { Application } from './modules/app.service.ts';
 
-async function main() {
-    const application = await bootstrapApplication(Application, AppModule);
+async function main(): Promise<void> {
+    const noxApp = await bootstrapApplication(AppModule);
+
+    noxApp.configure(Application);
+
+    noxApp.start();
 }
 
 main();
@@ -205,9 +210,9 @@ type fn = (...args: any[]) => void;
 contextBridge.exposeInMainWorld('ipcRenderer', {
     requestPort: () => ipcRenderer.send('gimme-my-port'),
     
-    hereIsMyPort: () => ipcRenderer.once('port', (e) => {
+    hereIsMyPort: () => ipcRenderer.once('port', (e, message) => {
         e.ports[0]?.start();
-        window.postMessage({ type: 'init-port' }, '*', [e.ports[0]!]);
+        window.postMessage({ type: 'init-port', senderId: message.senderId }, '*', [e.ports[0]!]);
     }),
 });
 ```
@@ -240,6 +245,7 @@ class ElectronService {
     private readonly ipcRenderer: any; // if you know how to get a type, tell me
 
     private port: MessagePort | undefined;
+    private senderId: number | undefined;
     private readonly pendingRequests = new Map<string, PendingRequestsHandlers<any>>();
 
     constructor() {
@@ -250,6 +256,7 @@ class ElectronService {
         window.addEventListener('message', (event: MessageEvent) => {
             if(event.data?.type === 'init-port' && event.ports.length > 0) {
                 this.port = event.ports[0]!;
+                this.senderId = event.data.senderId;
                 this.port.onmessage = onResponse;
             }
         });
@@ -297,14 +304,15 @@ class ElectronService {
     /**
      * Initiate a request to the main process
      */
-    public request<T>(request: Omit<IRequest, 'requestId'>): Promise<T> {
+    public request<T>(request: Omit<IRequest, 'requestId' | 'senderId'>): Promise<T> {
         return new Promise<T>((resolve, reject) => {
-            if(!this.port) {
+            if(!this.port || !this.senderId) {
                 return reject(new Error("MessagePort is not available"));
             }
         
             const req: IRequest = {
                 requestId: /* Create a random ID with the function of your choice */,
+                senderId: this.senderId,
                 ...request,
             };
         
@@ -379,6 +387,23 @@ throw new UnavailableException();
 | 599         | NetworkConnectTimeoutException         |
 
 
+## Advanced
+
+### Injection
+
+You can decide to inject an Injectable without passing by the constructor, as follow :
+
+```ts
+import { inject } from '@noxfly/noxus';
+import { MyClass } from 'src/myclass';
+
+const instance: MyClass = inject(MyClass);
+```
+
+### Middlewares
+
+§ TODO
+
 ## Contributing
 
 1. Clone the repo

package/dist/noxus.d.mts

@@ -1,8 +1,14 @@
+/**
+ * @copyright 2025 NoxFly
+ * @license MIT
+ * @author NoxFly
+ */
 interface Type<T> extends Function {
     new (...args: any[]): T;
 }
 type MaybeAsync<T> = T | Promise<T>;
 
+
 type Lifetime = 'singleton' | 'scope' | 'transient';
 interface IBinding {
     lifetime: Lifetime;
@@ -31,11 +37,8 @@ declare class AppInjector {
     private instantiate;
 }
 declare const RootInjector: AppInjector;
+declare function inject<T>(t: Type<T>): T;
 
-interface IApp {
-    dispose(): Promise<void>;
-    onReady(): Promise<void>;
-}
 
 interface IRouteMetadata {
     method: HttpMethod;
@@ -52,8 +55,8 @@ declare const Delete: (path: string) => MethodDecorator;
 declare const ROUTE_METADATA_KEY: unique symbol;
 declare function getRouteMetadata(target: Type<unknown>): IRouteMetadata[];
 
+
 declare class Request {
-    readonly app: IApp;
     readonly event: Electron.MessageEvent;
     readonly id: string;
     readonly method: HttpMethod;
@@ -61,9 +64,10 @@ declare class Request {
     readonly body: any;
     readonly context: any;
     readonly params: Record<string, string>;
-    constructor(app: IApp, event: Electron.MessageEvent, id: string, method: HttpMethod, path: string, body: any);
+    constructor(event: Electron.MessageEvent, id: string, method: HttpMethod, path: string, body: any);
 }
 interface IRequest<T = any> {
+    senderId: number;
     requestId: string;
     path: string;
     method: HttpMethod;
@@ -76,6 +80,7 @@ interface IResponse<T = any> {
     error?: string;
 }
 
+
 interface IGuard {
     canActivate(request: Request): MaybeAsync<boolean>;
 }
@@ -87,6 +92,7 @@ declare function Authorize(...guardClasses: Type<IGuard>[]): MethodDecorator & C
 declare function getGuardForController(controllerName: string): Type<IGuard>[];
 declare function getGuardForControllerAction(controllerName: string, actionName: string): Type<IGuard>[];
 
+
 interface IRouteDefinition {
     method: string;
     path: string;
@@ -105,10 +111,51 @@ declare class Router {
     private extractParams;
 }
 
+
+interface IApp {
+    dispose(): Promise<void>;
+    onReady(): Promise<void>;
+    onActivated(): Promise<void>;
+}
+declare class NoxApp {
+    private readonly router;
+    private readonly messagePorts;
+    private app;
+    constructor(router: Router);
+    /**
+     *
+     */
+    init(): Promise<NoxApp>;
+    /**
+     *
+     */
+    private giveTheRendererAPort;
+    /**
+     * Electron specific message handling.
+     * Replaces HTTP calls by using Electron's IPC mechanism.
+     */
+    private onRendererMessage;
+    /**
+     * MacOS specific behavior.
+     */
+    private onAppActivated;
+    private shutdownChannel;
+    /**
+     *
+     */
+    private onAllWindowsClosed;
+    configure(app: Type<IApp>): NoxApp;
+    /**
+     * Should be called after the bootstrapApplication function is called.
+     */
+    start(): NoxApp;
+}
+
+
 /**
  *
  */
-declare function bootstrapApplication(root: Type<IApp>, rootModule: Type<any>): Promise<IApp>;
+declare function bootstrapApplication(rootModule: Type<any>): Promise<NoxApp>;
 
 declare abstract class ResponseException extends Error {
     abstract readonly status: number;
@@ -120,6 +167,9 @@ declare class BadRequestException extends ResponseException {
 declare class UnauthorizedException extends ResponseException {
     readonly status = 401;
 }
+declare class PaymentRequiredException extends ResponseException {
+    readonly status = 402;
+}
 declare class ForbiddenException extends ResponseException {
     readonly status = 403;
 }
@@ -181,6 +231,7 @@ declare class NetworkConnectTimeoutException extends ResponseException {
     readonly status = 599;
 }
 
+
 interface IControllerMetadata {
     path: string;
     guards: Type<IGuard>[];
@@ -189,10 +240,12 @@ declare function Controller(path: string): ClassDecorator;
 declare const CONTROLLER_METADATA_KEY: unique symbol;
 declare function getControllerMetadata(target: Type<unknown>): IControllerMetadata | undefined;
 
+
 declare function Injectable(lifetime?: Lifetime): ClassDecorator;
 declare const INJECTABLE_METADATA_KEY: unique symbol;
 declare function getInjectableMetadata(target: Type<unknown>): Lifetime | undefined;
 
+
 declare function Module(metadata: IModuleMetadata): ClassDecorator;
 declare const MODULE_METADATA_KEY: unique symbol;
 interface IModuleMetadata {
@@ -231,4 +284,4 @@ declare namespace Logger {
     function debug(...args: any[]): void;
 }
 
-export { Authorize, BadGatewayException, BadRequestException, CONTROLLER_METADATA_KEY, ConflictException, Controller, type ControllerAction, Delete, ForbiddenException, GatewayTimeoutException, Get, type HttpMethod, HttpVersionNotSupportedException, type IApp, type IBinding, type IControllerMetadata, type IGuard, type IModuleMetadata, INJECTABLE_METADATA_KEY, type IRequest, type IResponse, type IRouteDefinition, type IRouteMetadata, Injectable, InsufficientStorageException, InternalServerException, type Lifetime, type LogLevel, Logger, LoopDetectedException, MODULE_METADATA_KEY, type MaybeAsync, MethodNotAllowedException, Module, NetworkAuthenticationRequiredException, NetworkConnectTimeoutException, NotAcceptableException, NotExtendedException, NotFoundException, NotImplementedException, Patch, Post, Put, ROUTE_METADATA_KEY, Request, RequestTimeoutException, ResponseException, RootInjector, Router, ServiceUnavailableException, TooManyRequestsException, type Type, UnauthorizedException, UpgradeRequiredException, VariantAlsoNegotiatesException, bootstrapApplication, getControllerMetadata, getGuardForController, getGuardForControllerAction, getInjectableMetadata, getModuleMetadata, getRouteMetadata };
+export { Authorize, BadGatewayException, BadRequestException, CONTROLLER_METADATA_KEY, ConflictException, Controller, type ControllerAction, Delete, ForbiddenException, GatewayTimeoutException, Get, type HttpMethod, HttpVersionNotSupportedException, type IApp, type IBinding, type IControllerMetadata, type IGuard, type IModuleMetadata, INJECTABLE_METADATA_KEY, type IRequest, type IResponse, type IRouteDefinition, type IRouteMetadata, Injectable, InsufficientStorageException, InternalServerException, type Lifetime, type LogLevel, Logger, LoopDetectedException, MODULE_METADATA_KEY, type MaybeAsync, MethodNotAllowedException, Module, NetworkAuthenticationRequiredException, NetworkConnectTimeoutException, NotAcceptableException, NotExtendedException, NotFoundException, NotImplementedException, NoxApp, Patch, PaymentRequiredException, Post, Put, ROUTE_METADATA_KEY, Request, RequestTimeoutException, ResponseException, RootInjector, Router, ServiceUnavailableException, TooManyRequestsException, type Type, UnauthorizedException, UpgradeRequiredException, VariantAlsoNegotiatesException, bootstrapApplication, getControllerMetadata, getGuardForController, getGuardForControllerAction, getInjectableMetadata, getModuleMetadata, getRouteMetadata, inject };

package/dist/noxus.d.ts

@@ -1,8 +1,14 @@
+/**
+ * @copyright 2025 NoxFly
+ * @license MIT
+ * @author NoxFly
+ */
 interface Type<T> extends Function {
     new (...args: any[]): T;
 }
 type MaybeAsync<T> = T | Promise<T>;
 
+
 type Lifetime = 'singleton' | 'scope' | 'transient';
 interface IBinding {
     lifetime: Lifetime;
@@ -31,11 +37,8 @@ declare class AppInjector {
     private instantiate;
 }
 declare const RootInjector: AppInjector;
+declare function inject<T>(t: Type<T>): T;
 
-interface IApp {
-    dispose(): Promise<void>;
-    onReady(): Promise<void>;
-}
 
 interface IRouteMetadata {
     method: HttpMethod;
@@ -52,8 +55,8 @@ declare const Delete: (path: string) => MethodDecorator;
 declare const ROUTE_METADATA_KEY: unique symbol;
 declare function getRouteMetadata(target: Type<unknown>): IRouteMetadata[];
 
+
 declare class Request {
-    readonly app: IApp;
     readonly event: Electron.MessageEvent;
     readonly id: string;
     readonly method: HttpMethod;
@@ -61,9 +64,10 @@ declare class Request {
     readonly body: any;
     readonly context: any;
     readonly params: Record<string, string>;
-    constructor(app: IApp, event: Electron.MessageEvent, id: string, method: HttpMethod, path: string, body: any);
+    constructor(event: Electron.MessageEvent, id: string, method: HttpMethod, path: string, body: any);
 }
 interface IRequest<T = any> {
+    senderId: number;
     requestId: string;
     path: string;
     method: HttpMethod;
@@ -76,6 +80,7 @@ interface IResponse<T = any> {
     error?: string;
 }
 
+
 interface IGuard {
     canActivate(request: Request): MaybeAsync<boolean>;
 }
@@ -87,6 +92,7 @@ declare function Authorize(...guardClasses: Type<IGuard>[]): MethodDecorator & C
 declare function getGuardForController(controllerName: string): Type<IGuard>[];
 declare function getGuardForControllerAction(controllerName: string, actionName: string): Type<IGuard>[];
 
+
 interface IRouteDefinition {
     method: string;
     path: string;
@@ -105,10 +111,51 @@ declare class Router {
     private extractParams;
 }
 
+
+interface IApp {
+    dispose(): Promise<void>;
+    onReady(): Promise<void>;
+    onActivated(): Promise<void>;
+}
+declare class NoxApp {
+    private readonly router;
+    private readonly messagePorts;
+    private app;
+    constructor(router: Router);
+    /**
+     *
+     */
+    init(): Promise<NoxApp>;
+    /**
+     *
+     */
+    private giveTheRendererAPort;
+    /**
+     * Electron specific message handling.
+     * Replaces HTTP calls by using Electron's IPC mechanism.
+     */
+    private onRendererMessage;
+    /**
+     * MacOS specific behavior.
+     */
+    private onAppActivated;
+    private shutdownChannel;
+    /**
+     *
+     */
+    private onAllWindowsClosed;
+    configure(app: Type<IApp>): NoxApp;
+    /**
+     * Should be called after the bootstrapApplication function is called.
+     */
+    start(): NoxApp;
+}
+
+
 /**
  *
  */
-declare function bootstrapApplication(root: Type<IApp>, rootModule: Type<any>): Promise<IApp>;
+declare function bootstrapApplication(rootModule: Type<any>): Promise<NoxApp>;
 
 declare abstract class ResponseException extends Error {
     abstract readonly status: number;
@@ -120,6 +167,9 @@ declare class BadRequestException extends ResponseException {
 declare class UnauthorizedException extends ResponseException {
     readonly status = 401;
 }
+declare class PaymentRequiredException extends ResponseException {
+    readonly status = 402;
+}
 declare class ForbiddenException extends ResponseException {
     readonly status = 403;
 }
@@ -181,6 +231,7 @@ declare class NetworkConnectTimeoutException extends ResponseException {
     readonly status = 599;
 }
 
+
 interface IControllerMetadata {
     path: string;
     guards: Type<IGuard>[];
@@ -189,10 +240,12 @@ declare function Controller(path: string): ClassDecorator;
 declare const CONTROLLER_METADATA_KEY: unique symbol;
 declare function getControllerMetadata(target: Type<unknown>): IControllerMetadata | undefined;
 
+
 declare function Injectable(lifetime?: Lifetime): ClassDecorator;
 declare const INJECTABLE_METADATA_KEY: unique symbol;
 declare function getInjectableMetadata(target: Type<unknown>): Lifetime | undefined;
 
+
 declare function Module(metadata: IModuleMetadata): ClassDecorator;
 declare const MODULE_METADATA_KEY: unique symbol;
 interface IModuleMetadata {
@@ -231,4 +284,4 @@ declare namespace Logger {
     function debug(...args: any[]): void;
 }
 
-export { Authorize, BadGatewayException, BadRequestException, CONTROLLER_METADATA_KEY, ConflictException, Controller, type ControllerAction, Delete, ForbiddenException, GatewayTimeoutException, Get, type HttpMethod, HttpVersionNotSupportedException, type IApp, type IBinding, type IControllerMetadata, type IGuard, type IModuleMetadata, INJECTABLE_METADATA_KEY, type IRequest, type IResponse, type IRouteDefinition, type IRouteMetadata, Injectable, InsufficientStorageException, InternalServerException, type Lifetime, type LogLevel, Logger, LoopDetectedException, MODULE_METADATA_KEY, type MaybeAsync, MethodNotAllowedException, Module, NetworkAuthenticationRequiredException, NetworkConnectTimeoutException, NotAcceptableException, NotExtendedException, NotFoundException, NotImplementedException, Patch, Post, Put, ROUTE_METADATA_KEY, Request, RequestTimeoutException, ResponseException, RootInjector, Router, ServiceUnavailableException, TooManyRequestsException, type Type, UnauthorizedException, UpgradeRequiredException, VariantAlsoNegotiatesException, bootstrapApplication, getControllerMetadata, getGuardForController, getGuardForControllerAction, getInjectableMetadata, getModuleMetadata, getRouteMetadata };
+export { Authorize, BadGatewayException, BadRequestException, CONTROLLER_METADATA_KEY, ConflictException, Controller, type ControllerAction, Delete, ForbiddenException, GatewayTimeoutException, Get, type HttpMethod, HttpVersionNotSupportedException, type IApp, type IBinding, type IControllerMetadata, type IGuard, type IModuleMetadata, INJECTABLE_METADATA_KEY, type IRequest, type IResponse, type IRouteDefinition, type IRouteMetadata, Injectable, InsufficientStorageException, InternalServerException, type Lifetime, type LogLevel, Logger, LoopDetectedException, MODULE_METADATA_KEY, type MaybeAsync, MethodNotAllowedException, Module, NetworkAuthenticationRequiredException, NetworkConnectTimeoutException, NotAcceptableException, NotExtendedException, NotFoundException, NotImplementedException, NoxApp, Patch, PaymentRequiredException, Post, Put, ROUTE_METADATA_KEY, Request, RequestTimeoutException, ResponseException, RootInjector, Router, ServiceUnavailableException, TooManyRequestsException, type Type, UnauthorizedException, UpgradeRequiredException, VariantAlsoNegotiatesException, bootstrapApplication, getControllerMetadata, getGuardForController, getGuardForControllerAction, getInjectableMetadata, getModuleMetadata, getRouteMetadata, inject };