@breadstone/archipel-mcp 0.0.45 → 0.0.47

package/data/packages/platform-bootstrap/api/Class.CompositionResolver.md

@@ -0,0 +1,206 @@
+---
+title: 'Abstract Class: CompositionResolver'
+generated: true
+editUrl: false
+---
+# Abstract Class: CompositionResolver
+
+Defined in: composition/services/CompositionResolver.ts:46
+
+Abstract base class for composition-time feature resolution.
+
+Applications extend this class to define their own composition logic,
+determining which modules and providers should be imported based on
+configuration, stage, or other criteria.
+
+## Remarks
+
+The resolver is instantiated within a lightweight composition context
+before the main application module graph is built. It should only
+depend on configuration and other composition-safe services.
+
+Do not inject heavy infrastructure services (database, queues, etc.)
+into the resolver as they are not available during composition.
+
+## Example
+
+```typescript
+@Injectable()
+export class AppCompositionResolver extends CompositionResolver {
+    public constructor(configService: ConfigService) {
+        super(configService);
+    }
+
+    public shouldImportSmtpMail(): boolean {
+        const driver = this.tryGetConfigValue(MAIL_DRIVER, 'log');
+        return driver === 'smtp' || this.isProductionLike();
+    }
+
+    public isProductionLike(): boolean {
+        const stage = this.tryGetConfigValue(NODE_ENV, 'development');
+        return stage === 'production' || stage === 'staging';
+    }
+}
+```
+
+## Constructors
+
+### Constructor
+
+```ts
+protected new CompositionResolver(configService): CompositionResolver;
+```
+
+Defined in: composition/services/CompositionResolver.ts:62
+
+Constructs a new composition resolver.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `configService` | `ConfigService` | The configuration service for reading environment values. |
+
+#### Returns
+
+`CompositionResolver`
+
+## Accessors
+
+### configService
+
+#### Get Signature
+
+```ts
+get protected configService(): ConfigService;
+```
+
+Defined in: composition/services/CompositionResolver.ts:75
+
+The underlying configuration service.
+
+##### Returns
+
+`ConfigService`
+
+## Methods
+
+### compareConfigValue()
+
+```ts
+protected compareConfigValue<T>(key, value): boolean;
+```
+
+Defined in: composition/services/CompositionResolver.ts:133
+
+Compares a configuration value against an expected value.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The expected type of the configuration value. |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `IConfigKey`\<`T`\> | The typed configuration key. |
+| `value` | `T` | The value to compare against. |
+
+#### Returns
+
+`boolean`
+
+`true` if the configuration value matches; otherwise, `false`.
+
+***
+
+### getConfigValue()
+
+```ts
+protected getConfigValue<T>(key): T;
+```
+
+Defined in: composition/services/CompositionResolver.ts:105
+
+Gets a required configuration value.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The expected type of the configuration value. |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `IConfigKey`\<`T`\> | The typed configuration key. |
+
+#### Returns
+
+`T`
+
+The typed configuration value.
+
+#### Throws
+
+When the configuration key is not found.
+
+***
+
+### shouldImportProvider()
+
+```ts
+abstract shouldImportProvider(providerKey): boolean;
+```
+
+Defined in: composition/services/CompositionResolver.ts:93
+
+Determines whether a specific provider should be imported.
+
+Override this method to implement custom provider resolution logic.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `providerKey` | `string` | A unique key identifying the provider (e.g., `'mail'`, `'blob-storage'`). |
+
+#### Returns
+
+`boolean`
+
+`true` if the provider should be imported; otherwise, `false`.
+
+***
+
+### tryGetConfigValue()
+
+```ts
+protected tryGetConfigValue<T>(key, fallback): T;
+```
+
+Defined in: composition/services/CompositionResolver.ts:119
+
+Gets an optional configuration value with a fallback.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The expected type of the configuration value. |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `IConfigKey`\<`T`\> | The typed configuration key. |
+| `fallback` | `T` | The fallback value when the key is absent. |
+
+#### Returns
+
+`T`
+
+The typed configuration value or the fallback.

package/data/packages/platform-bootstrap/api/Class.PlatformApplicationBuilder.md

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Class: PlatformApplicationBuilder\<TApplication\>
 
-Defined in: [application/PlatformApplicationBuilder.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/application/PlatformApplicationBuilder.ts#L16)
+Defined in: [application/PlatformApplicationBuilder.ts:99](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/application/PlatformApplicationBuilder.ts#L99)
 
 Fluent builder that composes NestJS bootstrap steps and executes them once.
 
@@ -23,7 +23,7 @@ Fluent builder that composes NestJS bootstrap steps and executes them once.
 new PlatformApplicationBuilder<TApplication>(app, options?): PlatformApplicationBuilder<TApplication>;
 ```
 
-Defined in: [application/PlatformApplicationBuilder.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/application/PlatformApplicationBuilder.ts#L28)
+Defined in: [application/PlatformApplicationBuilder.ts:111](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/application/PlatformApplicationBuilder.ts#L111)
 
 #### Parameters
 
@@ -46,7 +46,7 @@ Defined in: [application/PlatformApplicationBuilder.ts:28](https://github.com/Ru
 get app(): TApplication;
 ```
 
-Defined in: [application/PlatformApplicationBuilder.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/application/PlatformApplicationBuilder.ts#L44)
+Defined in: [application/PlatformApplicationBuilder.ts:205](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/application/PlatformApplicationBuilder.ts#L205)
 
 The wrapped NestJS application.
 
@@ -56,13 +56,80 @@ The wrapped NestJS application.
 
 ## Methods
 
+### createWithComposition()
+
+```ts
+static createWithComposition<TApp>(composer, options?): Promise<PlatformApplicationBuilder<TApp>>;
+```
+
+Defined in: [application/PlatformApplicationBuilder.ts:163](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/application/PlatformApplicationBuilder.ts#L163)
+
+Creates a new application builder using composition-based module assembly.
+
+This factory bootstraps a lightweight composition context to read configuration
+values, then invokes the provided composer function to determine which modules
+to import. The resulting modules are assembled into a dynamic root module
+and a NestJS application is created from it.
+
+The composition context is automatically closed after the composer function completes.
+
+#### Type Parameters
+
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `TApp` *extends* `INestApplication`\<`any`\> | `INestApplication`\<`any`\> | The NestJS application type. Defaults to INestApplication. |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `composer` | (`context`) => \| [`CompositionImport`](TypeAlias.CompositionImport)[] \| `Promise`\<[`CompositionImport`](TypeAlias.CompositionImport)[]\> | A function that receives the composition context and returns an array of modules to import. |
+| `options?` | [`ICreateWithCompositionOptions`](Interface.ICreateWithCompositionOptions)\<`TApp`\> | Options for creating the composed application. |
+
+#### Returns
+
+`Promise`\<`PlatformApplicationBuilder`\<`TApp`\>\>
+
+A promise that resolves to a configured PlatformApplicationBuilder.
+
+#### Example
+
+```typescript
+import { PlatformApplicationBuilder } from '@breadstone/archipel-platform-bootstrap';
+import { ExpressAdapter, NestExpressApplication } from '@nestjs/platform-express';
+
+const builder = await PlatformApplicationBuilder.createWithComposition<NestExpressApplication>(
+    async (context) => {
+        const imports: CompositionImport[] = [AppModule];
+
+        const driver = context.tryGetConfigValue({ key: 'MAIL_DRIVER' }, 'log');
+        if (driver === 'smtp') {
+            const { MailModule } = await import('@breadstone/archipel-platform-mailing');
+            const { SmtpDeliveryStrategy } = await import('@breadstone/archipel-platform-mailing/delivering/smtp');
+            imports.push(MailModule.register({ deliveryStrategy: SmtpDeliveryStrategy }));
+        }
+
+        return imports;
+    },
+    {
+        appFactory: (module) => NestFactory.create<NestExpressApplication>(module, new ExpressAdapter()),
+    }
+);
+
+await builder
+    .use(useApi({ prefix: 'api' }))
+    .listenFromConfig({ fallbackPort: 3000 });
+```
+
+***
+
 ### initialize()
 
 ```ts
 initialize(): Promise<TApplication>;
 ```
 
-Defined in: [application/PlatformApplicationBuilder.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/application/PlatformApplicationBuilder.ts#L70)
+Defined in: [application/PlatformApplicationBuilder.ts:231](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/application/PlatformApplicationBuilder.ts#L231)
 
 Executes the configured bootstrap pipeline and initializes the NestJS application.
 
@@ -80,7 +147,7 @@ The wrapped NestJS application.
 listen(port, hostname?): Promise<TApplication>;
 ```
 
-Defined in: [application/PlatformApplicationBuilder.ts:94](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/application/PlatformApplicationBuilder.ts#L94)
+Defined in: [application/PlatformApplicationBuilder.ts:255](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/application/PlatformApplicationBuilder.ts#L255)
 
 Executes the pipeline and starts the NestJS listener on the given port.
 
@@ -105,7 +172,7 @@ The wrapped NestJS application.
 listenFromConfig(options?): Promise<TApplication>;
 ```
 
-Defined in: [application/PlatformApplicationBuilder.ts:113](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/application/PlatformApplicationBuilder.ts#L113)
+Defined in: [application/PlatformApplicationBuilder.ts:274](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/application/PlatformApplicationBuilder.ts#L274)
 
 Executes the pipeline and starts the listener using typed configuration keys.
 
@@ -129,7 +196,7 @@ The wrapped NestJS application.
 run(): Promise<PlatformBootstrapContext<TApplication>>;
 ```
 
-Defined in: [application/PlatformApplicationBuilder.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/application/PlatformApplicationBuilder.ts#L82)
+Defined in: [application/PlatformApplicationBuilder.ts:243](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/application/PlatformApplicationBuilder.ts#L243)
 
 Executes the configured bootstrap pipeline without starting a listener.
 
@@ -147,7 +214,7 @@ The bootstrap context used for the execution.
 use(step): this;
 ```
 
-Defined in: [application/PlatformApplicationBuilder.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/application/PlatformApplicationBuilder.ts#L59)
+Defined in: [application/PlatformApplicationBuilder.ts:220](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/application/PlatformApplicationBuilder.ts#L220)
 
 Adds a bootstrap step to the application pipeline.
 

package/data/packages/platform-bootstrap/api/Function.createCompositionContext.md

@@ -0,0 +1,56 @@
+---
+title: 'Function: createCompositionContext()'
+generated: true
+editUrl: false
+---
+# Function: createCompositionContext()
+
+```ts
+function createCompositionContext(options?): Promise<ICompositionContext>;
+```
+
+Defined in: composition/factory/createCompositionContext.ts:88
+
+Creates a temporary NestJS context for stage-aware module composition.
+
+This function bootstraps a minimal NestJS application context that provides
+access to configuration. Use this context to make decisions about which
+modules should be dynamically imported into the real application.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options?` | [`ICreateCompositionContextOptions`](Interface.ICreateCompositionContextOptions) | Optional configuration for the composition context. |
+
+## Returns
+
+`Promise`\<[`ICompositionContext`](Interface.ICompositionContext)\>
+
+A promise that resolves to the composition context.
+
+## Remarks
+
+The composition context must be closed after the real application has been
+created by calling [ICompositionContext.close](Interface.ICompositionContext#close). Use a try/finally block
+to ensure proper cleanup.
+
+## Example
+
+```typescript
+async function bootstrap(): Promise<void> {
+    const composition = await createCompositionContext();
+
+    try {
+        const appModule = await createAppModule(composition);
+        const app = await NestFactory.create(appModule);
+
+        await PlatformApplicationBuilder
+            .from(app)
+            .use(useApi({ ... }))
+            .listenFromConfig();
+    } finally {
+        await composition.close();
+    }
+}
+```

package/data/packages/platform-bootstrap/api/Interface.ICompositionContext.md

@@ -0,0 +1,179 @@
+---
+title: 'Interface: ICompositionContext'
+generated: true
+editUrl: false
+---
+# Interface: ICompositionContext
+
+Defined in: composition/context/ICompositionContext.ts:35
+
+Pre-bootstrap context for stage-aware module composition.
+
+This context is created before the main application module graph is built.
+It provides access to configuration and lightweight composition services
+that help determine which modules should be dynamically imported.
+
+## Remarks
+
+The composition context uses a temporary NestJS application context internally.
+This context must be closed after the real application has been created by
+calling [ICompositionContext.close](#close).
+
+## Example
+
+```typescript
+const composition = await createCompositionContext();
+
+try {
+    const appModule = await createAppModule(composition);
+    const app = await NestFactory.create(appModule);
+    await app.listen(3000);
+} finally {
+    await composition.close();
+}
+```
+
+## Properties
+
+### config
+
+```ts
+readonly config: ConfigService;
+```
+
+Defined in: composition/context/ICompositionContext.ts:53
+
+The Archipel configuration service.
+
+Provides typed access to environment configuration values.
+
+***
+
+### context
+
+```ts
+readonly context: INestApplicationContext;
+```
+
+Defined in: composition/context/ICompositionContext.ts:44
+
+The temporary NestJS application context.
+
+Used only for dependency injection resolution during composition.
+Do not use this context for runtime services.
+
+## Methods
+
+### close()
+
+```ts
+close(): Promise<void>;
+```
+
+Defined in: composition/context/ICompositionContext.ts:100
+
+Closes the temporary composition context.
+
+Must be called after the real application has been created to release
+resources held by the composition context.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the context is closed.
+
+***
+
+### getConfigValue()
+
+```ts
+getConfigValue<T>(key): T;
+```
+
+Defined in: composition/context/ICompositionContext.ts:65
+
+Reads a required configuration value.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The expected type of the configuration value. |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `IConfigKey`\<`T`\> | The typed configuration key. |
+
+#### Returns
+
+`T`
+
+The typed configuration value.
+
+#### Throws
+
+When the configuration key is not found.
+
+***
+
+### getService()
+
+```ts
+getService<T>(token): T;
+```
+
+Defined in: composition/context/ICompositionContext.ts:88
+
+Resolves a provider from the composition context.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The type of the provider. |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `token` | (...`args`) => `T` | The provider token (class, string, or symbol). |
+
+#### Returns
+
+`T`
+
+The resolved provider instance.
+
+***
+
+### tryGetConfigValue()
+
+```ts
+tryGetConfigValue<T>(key, fallback): T;
+```
+
+Defined in: composition/context/ICompositionContext.ts:77
+
+Reads an optional configuration value with a fallback.
+
+#### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `T` | The expected type of the configuration value. |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `IConfigKey`\<`T`\> | The typed configuration key. |
+| `fallback` | `T` | The fallback value when the key is absent. |
+
+#### Returns
+
+`T`
+
+The typed configuration value or the fallback.

package/data/packages/platform-bootstrap/api/Interface.ICreateCompositionContextOptions.md

@@ -0,0 +1,54 @@
+---
+title: 'Interface: ICreateCompositionContextOptions'
+generated: true
+editUrl: false
+---
+# Interface: ICreateCompositionContextOptions
+
+Defined in: composition/factory/createCompositionContext.ts:17
+
+Options for creating the composition context.
+
+## Properties
+
+### enableLogging?
+
+```ts
+readonly optional enableLogging?: boolean;
+```
+
+Defined in: composition/factory/createCompositionContext.ts:49
+
+Whether to enable logging for the composition context.
+
+Defaults to `false` to keep composition silent.
+
+***
+
+### module?
+
+```ts
+readonly optional module?: Type<unknown>;
+```
+
+Defined in: composition/factory/createCompositionContext.ts:40
+
+Custom composition module to use instead of the default [CompositionModule](Class.CompositionModule).
+
+Use this to provide application-specific composition services such as
+custom [CompositionResolver](Class.CompositionResolver) implementations.
+
+#### Example
+
+```typescript
+@Module({
+    imports: [ConfigModule.forRoot({ strategyFactory: () => new EnvironmentConfigStrategy() })],
+    providers: [AppCompositionResolver],
+    exports: [ConfigModule, AppCompositionResolver]
+})
+export class AppCompositionModule {}
+
+const context = await createCompositionContext({
+    module: AppCompositionModule
+});
+```