@navios/core 0.5.0 → 0.5.1

package/docs/modules.md

@@ -113,6 +113,132 @@ Modules in Navios follow a specific lifecycle:
 4. **Guard Application**: Module-level guards are applied to all controllers
 5. **Initialization**: Module initialization hooks are called
 
+## Module Lifecycle Methods
+
+### `onModuleInit`
+
+The `onModuleInit` lifecycle method is called after the module has been initialized and all its dependencies have been resolved. This is useful for performing setup tasks, initializing connections, or running startup logic.
+
+#### Interface
+
+```typescript
+interface NaviosModule {
+  onModuleInit(): void | Promise<void>
+}
+```
+
+#### Usage
+
+To use the `onModuleInit` lifecycle method, implement the `NaviosModule` interface in your module class:
+
+```typescript
+import { Module, NaviosModule } from '@navios/core'
+
+@Module({
+  controllers: [UserController],
+})
+export class UserModule implements NaviosModule {
+  onModuleInit() {
+    console.log('UserModule has been initialized')
+    // Perform initialization logic here
+  }
+}
+```
+
+#### Async Initialization
+
+The `onModuleInit` method can be asynchronous, allowing you to perform async setup tasks:
+
+```typescript
+import { Module, NaviosModule } from '@navios/core'
+
+@Module({
+  controllers: [DatabaseController],
+})
+export class DatabaseModule implements NaviosModule {
+  async onModuleInit() {
+    console.log('Initializing database connection...')
+    await this.connectToDatabase()
+    console.log('Database connection established')
+  }
+
+  private async connectToDatabase() {
+    // Database connection logic
+    return new Promise((resolve) => setTimeout(resolve, 1000))
+  }
+}
+```
+
+#### Common Use Cases
+
+- **Database Connections**: Initialize database connections or verify connectivity
+- **Cache Warming**: Pre-populate caches with frequently accessed data
+- **External Service Setup**: Initialize connections to external APIs or services
+- **Configuration Validation**: Validate required configuration settings
+- **Background Tasks**: Start background processes or scheduled tasks
+
+```typescript
+import { Module, NaviosModule } from '@navios/core'
+
+@Module({
+  controllers: [CacheController],
+})
+export class CacheModule implements NaviosModule {
+  private cache = new Map<string, any>()
+
+  async onModuleInit() {
+    // Warm up the cache with initial data
+    await this.warmUpCache()
+
+    // Validate configuration
+    this.validateConfiguration()
+
+    console.log('CacheModule initialized successfully')
+  }
+
+  private async warmUpCache() {
+    // Pre-populate cache with frequently accessed data
+    this.cache.set('app:config', await this.loadAppConfig())
+    this.cache.set('user:defaults', await this.loadUserDefaults())
+  }
+
+  private validateConfiguration() {
+    if (!process.env.CACHE_TTL) {
+      throw new Error('CACHE_TTL environment variable is required')
+    }
+  }
+
+  private async loadAppConfig() {
+    // Load application configuration
+    return { theme: 'dark', language: 'en' }
+  }
+
+  private async loadUserDefaults() {
+    // Load default user settings
+    return { notifications: true, theme: 'auto' }
+  }
+}
+```
+
+#### Execution Order
+
+The `onModuleInit` methods are called in dependency order:
+
+1. **Imported modules first**: All imported modules' `onModuleInit` methods are called before the current module
+2. **Current module last**: The current module's `onModuleInit` method is called after all its dependencies
+
+```typescript
+@Module({
+  imports: [DatabaseModule, CacheModule], // These initialize first
+})
+export class AppModule implements NaviosModule {
+  onModuleInit() {
+    // This runs after DatabaseModule and CacheModule have been initialized
+    console.log('AppModule initialized - all dependencies are ready')
+  }
+}
+```
+
 ## Module Metadata
 
 Each module decorated with `@Module()` has associated metadata that Navios uses internally:

package/docs/services.md

@@ -260,11 +260,10 @@ export class EmailProviderFactory {
 
 @Injectable()
 export class EmailService {
-  private emailProviderFactory = inject(EmailProviderFactory)
+  private emailProvider = inject(EmailProviderFactory)
 
   async sendWelcomeEmail(user: User) {
-    const provider = this.emailProviderFactory.create()
-    await provider.send(
+    await this.emailProvider.send(
       user.email,
       'Welcome!',
       `Hello ${user.name}, welcome to our platform!`,

package/lib/_tsup-dts-rollup.d.mts

@@ -12,12 +12,13 @@ import { ClassTypeWithInstance } from '@navios/di';
 import { ClassTypeWithInstanceAndArgument } from '@navios/di';
 import { ClassTypeWithInstanceAndOptionalArgument } from '@navios/di';
 import { ClassTypeWithOptionalArgument } from '@navios/di';
+import { ClassTypeWithoutArguments } from '@navios/di';
 import { Container } from '@navios/di';
-import { createDeferred } from '@navios/di';
 import { createRequestContextHolder } from '@navios/di';
 import { defaultInjectors } from '@navios/di';
 import { DefaultRequestContextHolder } from '@navios/di';
-import { Deferred } from '@navios/di';
+import { DIError } from '@navios/di';
+import { DIErrorCode } from '@navios/di';
 import type { EndpointFunctionArgs } from '@navios/builder';
 import { ErrorsEnum } from '@navios/di';
 import { EventEmitter } from '@navios/di';
@@ -48,15 +49,16 @@ import { InjectionToken } from '@navios/di';
 import { InjectionTokenSchemaType } from '@navios/di';
 import { InjectionTokenType } from '@navios/di';
 import { Injectors } from '@navios/di';
+import { InjectRequest } from '@navios/di';
 import { InjectState } from '@navios/di';
 import type { InspectOptions } from 'util';
 import { InstanceDestroying } from '@navios/di';
-import { InstanceExpired } from '@navios/di';
 import { InstanceNotFound } from '@navios/di';
 import { IsUnion } from '@navios/di';
 import { Join } from '@navios/di';
 import { OnServiceDestroy } from '@navios/di';
 import { OnServiceInit } from '@navios/di';
+import { optional } from '@navios/di';
 import { OptionalInjectionTokenSchemaType } from '@navios/di';
 import type { OutgoingHttpHeaders } from 'http';
 import { PopUnion } from '@navios/di';
@@ -258,6 +260,8 @@ export { ClassTypeWithInstanceAndOptionalArgument }
 
 export { ClassTypeWithOptionalArgument }
 
+export { ClassTypeWithoutArguments }
+
 declare const clc: {
     bold: (text: string) => string;
     green: (text: string) => string;
@@ -546,15 +550,15 @@ export { ControllerOptions }
 export { ControllerOptions as ControllerOptions_alias_1 }
 export { ControllerOptions as ControllerOptions_alias_2 }
 
-export { createDeferred }
-
 export { createRequestContextHolder }
 
 export { defaultInjectors }
 
 export { DefaultRequestContextHolder }
 
-export { Deferred }
+export { DIError }
+
+export { DIErrorCode }
 
 declare function Endpoint<Method extends HttpMethod = HttpMethod, Url extends string = string, QuerySchema = undefined, ResponseSchema extends ZodType = ZodType, RequestSchema = ZodType>(endpoint: {
     config: BaseEndpointConfig<Method, Url, QuerySchema, ResponseSchema, RequestSchema>;
@@ -804,12 +808,12 @@ export { InjectionTokenType }
 
 export { Injectors }
 
+export { InjectRequest }
+
 export { InjectState }
 
 export { InstanceDestroying }
 
-export { InstanceExpired }
-
 export { InstanceNotFound }
 
 declare class InternalServerErrorException extends HttpException {
@@ -1097,7 +1101,7 @@ export { MultipartParams as MultipartParams_alias_2 }
 
 declare type MultipartResult<EndpointDeclaration extends {
     config: BaseEndpointConfig<any, any, any, any, any>;
-}> = EndpointDeclaration['config']['responseSchema'] extends ZodDiscriminatedUnion<any, infer Options> ? Promise<z.input<Options[number]>> : Promise<z.input<EndpointDeclaration['config']['responseSchema']>>;
+}> = EndpointDeclaration['config']['responseSchema'] extends ZodDiscriminatedUnion<infer Options> ? Promise<z.input<Options[number]>> : Promise<z.input<EndpointDeclaration['config']['responseSchema']>>;
 export { MultipartResult }
 export { MultipartResult as MultipartResult_alias_1 }
 export { MultipartResult as MultipartResult_alias_2 }
@@ -1193,6 +1197,8 @@ export { OnServiceDestroy }
 
 export { OnServiceInit }
 
+export { optional }
+
 export { OptionalInjectionTokenSchemaType }
 
 declare type OriginType = string | boolean | RegExp;

package/lib/_tsup-dts-rollup.d.ts

@@ -12,12 +12,13 @@ import { ClassTypeWithInstance } from '@navios/di';
 import { ClassTypeWithInstanceAndArgument } from '@navios/di';
 import { ClassTypeWithInstanceAndOptionalArgument } from '@navios/di';
 import { ClassTypeWithOptionalArgument } from '@navios/di';
+import { ClassTypeWithoutArguments } from '@navios/di';
 import { Container } from '@navios/di';
-import { createDeferred } from '@navios/di';
 import { createRequestContextHolder } from '@navios/di';
 import { defaultInjectors } from '@navios/di';
 import { DefaultRequestContextHolder } from '@navios/di';
-import { Deferred } from '@navios/di';
+import { DIError } from '@navios/di';
+import { DIErrorCode } from '@navios/di';
 import type { EndpointFunctionArgs } from '@navios/builder';
 import { ErrorsEnum } from '@navios/di';
 import { EventEmitter } from '@navios/di';
@@ -48,15 +49,16 @@ import { InjectionToken } from '@navios/di';
 import { InjectionTokenSchemaType } from '@navios/di';
 import { InjectionTokenType } from '@navios/di';
 import { Injectors } from '@navios/di';
+import { InjectRequest } from '@navios/di';
 import { InjectState } from '@navios/di';
 import type { InspectOptions } from 'util';
 import { InstanceDestroying } from '@navios/di';
-import { InstanceExpired } from '@navios/di';
 import { InstanceNotFound } from '@navios/di';
 import { IsUnion } from '@navios/di';
 import { Join } from '@navios/di';
 import { OnServiceDestroy } from '@navios/di';
 import { OnServiceInit } from '@navios/di';
+import { optional } from '@navios/di';
 import { OptionalInjectionTokenSchemaType } from '@navios/di';
 import type { OutgoingHttpHeaders } from 'http';
 import { PopUnion } from '@navios/di';
@@ -258,6 +260,8 @@ export { ClassTypeWithInstanceAndOptionalArgument }
 
 export { ClassTypeWithOptionalArgument }
 
+export { ClassTypeWithoutArguments }
+
 declare const clc: {
     bold: (text: string) => string;
     green: (text: string) => string;
@@ -546,15 +550,15 @@ export { ControllerOptions }
 export { ControllerOptions as ControllerOptions_alias_1 }
 export { ControllerOptions as ControllerOptions_alias_2 }
 
-export { createDeferred }
-
 export { createRequestContextHolder }
 
 export { defaultInjectors }
 
 export { DefaultRequestContextHolder }
 
-export { Deferred }
+export { DIError }
+
+export { DIErrorCode }
 
 declare function Endpoint<Method extends HttpMethod = HttpMethod, Url extends string = string, QuerySchema = undefined, ResponseSchema extends ZodType = ZodType, RequestSchema = ZodType>(endpoint: {
     config: BaseEndpointConfig<Method, Url, QuerySchema, ResponseSchema, RequestSchema>;
@@ -804,12 +808,12 @@ export { InjectionTokenType }
 
 export { Injectors }
 
+export { InjectRequest }
+
 export { InjectState }
 
 export { InstanceDestroying }
 
-export { InstanceExpired }
-
 export { InstanceNotFound }
 
 declare class InternalServerErrorException extends HttpException {
@@ -1097,7 +1101,7 @@ export { MultipartParams as MultipartParams_alias_2 }
 
 declare type MultipartResult<EndpointDeclaration extends {
     config: BaseEndpointConfig<any, any, any, any, any>;
-}> = EndpointDeclaration['config']['responseSchema'] extends ZodDiscriminatedUnion<any, infer Options> ? Promise<z.input<Options[number]>> : Promise<z.input<EndpointDeclaration['config']['responseSchema']>>;
+}> = EndpointDeclaration['config']['responseSchema'] extends ZodDiscriminatedUnion<infer Options> ? Promise<z.input<Options[number]>> : Promise<z.input<EndpointDeclaration['config']['responseSchema']>>;
 export { MultipartResult }
 export { MultipartResult as MultipartResult_alias_1 }
 export { MultipartResult as MultipartResult_alias_2 }
@@ -1193,6 +1197,8 @@ export { OnServiceDestroy }
 
 export { OnServiceInit }
 
+export { optional }
+
 export { OptionalInjectionTokenSchemaType }
 
 declare type OriginType = string | boolean | RegExp;

package/lib/index.d.mts

@@ -4,13 +4,14 @@ export { Injectable } from './_tsup-dts-rollup.mjs';
 export { InjectableOptions } from './_tsup-dts-rollup.mjs';
 export { InjectableScope } from './_tsup-dts-rollup.mjs';
 export { InjectableType } from './_tsup-dts-rollup.mjs';
-export { ErrorsEnum } from './_tsup-dts-rollup.mjs';
 export { FactoryNotFound } from './_tsup-dts-rollup.mjs';
 export { FactoryTokenNotResolved } from './_tsup-dts-rollup.mjs';
 export { InstanceDestroying } from './_tsup-dts-rollup.mjs';
-export { InstanceExpired } from './_tsup-dts-rollup.mjs';
 export { InstanceNotFound } from './_tsup-dts-rollup.mjs';
 export { UnknownError } from './_tsup-dts-rollup.mjs';
+export { ErrorsEnum } from './_tsup-dts-rollup.mjs';
+export { DIErrorCode } from './_tsup-dts-rollup.mjs';
+export { DIError } from './_tsup-dts-rollup.mjs';
 export { Factorable } from './_tsup-dts-rollup.mjs';
 export { FactorableWithArgs } from './_tsup-dts-rollup.mjs';
 export { OnServiceInit } from './_tsup-dts-rollup.mjs';
@@ -18,14 +19,13 @@ export { OnServiceDestroy } from './_tsup-dts-rollup.mjs';
 export { getInjectors } from './_tsup-dts-rollup.mjs';
 export { Injectors } from './_tsup-dts-rollup.mjs';
 export { getInjectableToken } from './_tsup-dts-rollup.mjs';
-export { createDeferred } from './_tsup-dts-rollup.mjs';
-export { Deferred } from './_tsup-dts-rollup.mjs';
 export { Join } from './_tsup-dts-rollup.mjs';
 export { UnionToIntersection } from './_tsup-dts-rollup.mjs';
 export { UnionToOvlds } from './_tsup-dts-rollup.mjs';
 export { PopUnion } from './_tsup-dts-rollup.mjs';
 export { IsUnion } from './_tsup-dts-rollup.mjs';
 export { UnionToArray } from './_tsup-dts-rollup.mjs';
+export { InjectRequest } from './_tsup-dts-rollup.mjs';
 export { InjectState } from './_tsup-dts-rollup.mjs';
 export { BaseInstanceHolderManager } from './_tsup-dts-rollup.mjs';
 export { EventsConfig } from './_tsup-dts-rollup.mjs';
@@ -36,6 +36,7 @@ export { EventEmitterInterface } from './_tsup-dts-rollup.mjs';
 export { EventEmitter } from './_tsup-dts-rollup.mjs';
 export { FactoryContext } from './_tsup-dts-rollup.mjs';
 export { ClassType } from './_tsup-dts-rollup.mjs';
+export { ClassTypeWithoutArguments } from './_tsup-dts-rollup.mjs';
 export { ClassTypeWithArgument } from './_tsup-dts-rollup.mjs';
 export { ClassTypeWithOptionalArgument } from './_tsup-dts-rollup.mjs';
 export { ClassTypeWithInstance } from './_tsup-dts-rollup.mjs';
@@ -52,6 +53,7 @@ export { InjectionTokenType } from './_tsup-dts-rollup.mjs';
 export { defaultInjectors } from './_tsup-dts-rollup.mjs';
 export { asyncInject } from './_tsup-dts-rollup.mjs';
 export { inject } from './_tsup-dts-rollup.mjs';
+export { optional } from './_tsup-dts-rollup.mjs';
 export { wrapSyncInit } from './_tsup-dts-rollup.mjs';
 export { provideFactoryContext } from './_tsup-dts-rollup.mjs';
 export { FactoryRecord } from './_tsup-dts-rollup.mjs';

package/lib/index.d.ts

@@ -4,13 +4,14 @@ export { Injectable } from './_tsup-dts-rollup.js';
 export { InjectableOptions } from './_tsup-dts-rollup.js';
 export { InjectableScope } from './_tsup-dts-rollup.js';
 export { InjectableType } from './_tsup-dts-rollup.js';
-export { ErrorsEnum } from './_tsup-dts-rollup.js';
 export { FactoryNotFound } from './_tsup-dts-rollup.js';
 export { FactoryTokenNotResolved } from './_tsup-dts-rollup.js';
 export { InstanceDestroying } from './_tsup-dts-rollup.js';
-export { InstanceExpired } from './_tsup-dts-rollup.js';
 export { InstanceNotFound } from './_tsup-dts-rollup.js';
 export { UnknownError } from './_tsup-dts-rollup.js';
+export { ErrorsEnum } from './_tsup-dts-rollup.js';
+export { DIErrorCode } from './_tsup-dts-rollup.js';
+export { DIError } from './_tsup-dts-rollup.js';
 export { Factorable } from './_tsup-dts-rollup.js';
 export { FactorableWithArgs } from './_tsup-dts-rollup.js';
 export { OnServiceInit } from './_tsup-dts-rollup.js';
@@ -18,14 +19,13 @@ export { OnServiceDestroy } from './_tsup-dts-rollup.js';
 export { getInjectors } from './_tsup-dts-rollup.js';
 export { Injectors } from './_tsup-dts-rollup.js';
 export { getInjectableToken } from './_tsup-dts-rollup.js';
-export { createDeferred } from './_tsup-dts-rollup.js';
-export { Deferred } from './_tsup-dts-rollup.js';
 export { Join } from './_tsup-dts-rollup.js';
 export { UnionToIntersection } from './_tsup-dts-rollup.js';
 export { UnionToOvlds } from './_tsup-dts-rollup.js';
 export { PopUnion } from './_tsup-dts-rollup.js';
 export { IsUnion } from './_tsup-dts-rollup.js';
 export { UnionToArray } from './_tsup-dts-rollup.js';
+export { InjectRequest } from './_tsup-dts-rollup.js';
 export { InjectState } from './_tsup-dts-rollup.js';
 export { BaseInstanceHolderManager } from './_tsup-dts-rollup.js';
 export { EventsConfig } from './_tsup-dts-rollup.js';
@@ -36,6 +36,7 @@ export { EventEmitterInterface } from './_tsup-dts-rollup.js';
 export { EventEmitter } from './_tsup-dts-rollup.js';
 export { FactoryContext } from './_tsup-dts-rollup.js';
 export { ClassType } from './_tsup-dts-rollup.js';
+export { ClassTypeWithoutArguments } from './_tsup-dts-rollup.js';
 export { ClassTypeWithArgument } from './_tsup-dts-rollup.js';
 export { ClassTypeWithOptionalArgument } from './_tsup-dts-rollup.js';
 export { ClassTypeWithInstance } from './_tsup-dts-rollup.js';
@@ -52,6 +53,7 @@ export { InjectionTokenType } from './_tsup-dts-rollup.js';
 export { defaultInjectors } from './_tsup-dts-rollup.js';
 export { asyncInject } from './_tsup-dts-rollup.js';
 export { inject } from './_tsup-dts-rollup.js';
+export { optional } from './_tsup-dts-rollup.js';
 export { wrapSyncInit } from './_tsup-dts-rollup.js';
 export { provideFactoryContext } from './_tsup-dts-rollup.js';
 export { FactoryRecord } from './_tsup-dts-rollup.js';