@breadstone/archipel-mcp 0.0.38 → 0.0.40

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

@@ -0,0 +1,130 @@
+---
+title: 'Class: PlatformBootstrapError'
+generated: true
+editUrl: false
+---
+# Class: PlatformBootstrapError
+
+Defined in: [errors/PlatformBootstrapError.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/errors/PlatformBootstrapError.ts#L8)
+
+Error raised when an Archipel platform bootstrap step fails.
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+```ts
+new PlatformBootstrapError(message, options?): PlatformBootstrapError;
+```
+
+Defined in: [errors/PlatformBootstrapError.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/errors/PlatformBootstrapError.ts#L19)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `message` | `string` |
+| `options?` | `IPlatformBootstrapErrorOptions` |
+
+#### Returns
+
+`PlatformBootstrapError`
+
+#### Overrides
+
+```ts
+Error.constructor
+```
+
+## Accessors
+
+### cause
+
+#### Get Signature
+
+```ts
+get cause(): unknown;
+```
+
+Defined in: [errors/PlatformBootstrapError.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/errors/PlatformBootstrapError.ts#L36)
+
+Original error that caused the bootstrap failure.
+
+##### Returns
+
+`unknown`
+
+#### Overrides
+
+```ts
+Error.cause
+```
+
+***
+
+### stepIndex
+
+#### Get Signature
+
+```ts
+get stepIndex(): number | undefined;
+```
+
+Defined in: [errors/PlatformBootstrapError.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/errors/PlatformBootstrapError.ts#L45)
+
+Zero-based index of the failing bootstrap step.
+
+##### Returns
+
+`number` \| `undefined`
+
+***
+
+### stepName
+
+#### Get Signature
+
+```ts
+get stepName(): string | undefined;
+```
+
+Defined in: [errors/PlatformBootstrapError.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/errors/PlatformBootstrapError.ts#L54)
+
+Display name of the failing bootstrap step.
+
+##### Returns
+
+`string` \| `undefined`
+
+## Methods
+
+### wrap()
+
+```ts
+static wrap(
+   cause, 
+   stepName, 
+   stepIndex): PlatformBootstrapError;
+```
+
+Defined in: [errors/PlatformBootstrapError.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/errors/PlatformBootstrapError.ts#L71)
+
+Wraps an unknown thrown value in a platform bootstrap error.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cause` | `unknown` | The thrown value. |
+| `stepName` | `string` | Display name of the failing step. |
+| `stepIndex` | `number` | Zero-based index of the failing step. |
+
+#### Returns
+
+`PlatformBootstrapError`
+
+A platform bootstrap error.

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

@@ -0,0 +1,26 @@
+---
+title: 'Function: createPlatformTestApplication()'
+generated: true
+editUrl: false
+---
+# Function: createPlatformTestApplication()
+
+```ts
+function createPlatformTestApplication(configService?): IPlatformTestApplication;
+```
+
+Defined in: [testing/createPlatformTestApplication.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/testing/createPlatformTestApplication.ts#L13)
+
+Creates a lightweight in-memory NestJS application double for platform bootstrap tests.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `configService?` | `ConfigService` | Optional config service double. |
+
+## Returns
+
+[`IPlatformTestApplication`](Interface.IPlatformTestApplication)
+
+A platform test application.

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

@@ -0,0 +1,32 @@
+---
+title: 'Function: useApi()'
+generated: true
+editUrl: false
+---
+# Function: useApi()
+
+```ts
+function useApi<TApplication>(options?): PlatformBootstrapStep<TApplication>;
+```
+
+Defined in: [steps/useApi.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/steps/useApi.ts#L15)
+
+Creates the generic Archipel API bootstrap step.
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TApplication` *extends* `INestApplication`\<`any`\> | `INestApplication`\<`any`\> |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options?` | [`IApiStepOptions`](Interface.IApiStepOptions) | API bootstrap options. |
+
+## Returns
+
+[`PlatformBootstrapStep`](TypeAlias.PlatformBootstrapStep)\<`TApplication`\>
+
+A platform bootstrap step.

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

@@ -0,0 +1,32 @@
+---
+title: 'Function: useExpressServer()'
+generated: true
+editUrl: false
+---
+# Function: useExpressServer()
+
+```ts
+function useExpressServer<TApplication>(options?): PlatformBootstrapStep<TApplication>;
+```
+
+Defined in: server/express/useExpressServer.ts:14
+
+Creates an Express-compatible server bootstrap step.
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TApplication` *extends* `INestApplication`\<`any`\> | `INestApplication`\<`any`\> |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options?` | [`IExpressServerStepOptions`](Interface.IExpressServerStepOptions) | Express server options. |
+
+## Returns
+
+[`PlatformBootstrapStep`](TypeAlias.PlatformBootstrapStep)\<`TApplication`\>
+
+A platform bootstrap step.

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

@@ -0,0 +1,32 @@
+---
+title: 'Function: useOpenApi()'
+generated: true
+editUrl: false
+---
+# Function: useOpenApi()
+
+```ts
+function useOpenApi<TApplication>(options?): PlatformBootstrapStep<TApplication>;
+```
+
+Defined in: [openapi/useOpenApi.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/openapi/useOpenApi.ts#L16)
+
+Creates the Archipel OpenAPI multi-document bootstrap step.
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TApplication` *extends* `INestApplication`\<`any`\> | `INestApplication`\<`any`\> |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options?` | [`IOpenApiStepOptions`](Interface.IOpenApiStepOptions) | OpenAPI bootstrap options. |
+
+## Returns
+
+[`PlatformBootstrapStep`](TypeAlias.PlatformBootstrapStep)\<`TApplication`\>
+
+A platform bootstrap step.

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

@@ -0,0 +1,32 @@
+---
+title: 'Function: useSecurity()'
+generated: true
+editUrl: false
+---
+# Function: useSecurity()
+
+```ts
+function useSecurity<TApplication>(options?): PlatformBootstrapStep<TApplication>;
+```
+
+Defined in: [security/useSecurity.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/security/useSecurity.ts#L18)
+
+Creates the generic security bootstrap step.
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TApplication` *extends* `INestApplication`\<`any`\> | `INestApplication`\<`any`\> |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options?` | [`ISecurityStepOptions`](Interface.ISecurityStepOptions) | Security bootstrap options. |
+
+## Returns
+
+[`PlatformBootstrapStep`](TypeAlias.PlatformBootstrapStep)\<`TApplication`\>
+
+A platform bootstrap step.

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

@@ -0,0 +1,32 @@
+---
+title: 'Function: useSession()'
+generated: true
+editUrl: false
+---
+# Function: useSession()
+
+```ts
+function useSession<TApplication>(options?): PlatformBootstrapStep<TApplication>;
+```
+
+Defined in: [session/useSession.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/session/useSession.ts#L16)
+
+Creates an Express-compatible session bootstrap step.
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TApplication` *extends* `INestApplication`\<`any`\> | `INestApplication`\<`any`\> |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options?` | [`ISessionStepOptions`](Interface.ISessionStepOptions) | Session middleware options. |
+
+## Returns
+
+[`PlatformBootstrapStep`](TypeAlias.PlatformBootstrapStep)\<`TApplication`\>
+
+A platform bootstrap step.

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

@@ -0,0 +1,58 @@
+---
+title: 'Interface: IApiStepOptions'
+generated: true
+editUrl: false
+---
+# Interface: IApiStepOptions
+
+Defined in: [steps/IApiStepOptions.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/steps/IApiStepOptions.ts#L8)
+
+Options for the generic Archipel API bootstrap step.
+
+## Properties
+
+### prefix?
+
+```ts
+readonly optional prefix?: string;
+```
+
+Defined in: [steps/IApiStepOptions.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/steps/IApiStepOptions.ts#L10)
+
+Global route prefix, for example `api`.
+
+***
+
+### problemDetails?
+
+```ts
+readonly optional problemDetails?: boolean;
+```
+
+Defined in: [steps/IApiStepOptions.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/steps/IApiStepOptions.ts#L13)
+
+Whether to enable RFC 7807 problem-detail error responses.
+
+***
+
+### repositoryErrors?
+
+```ts
+readonly optional repositoryErrors?: boolean;
+```
+
+Defined in: [steps/IApiStepOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/steps/IApiStepOptions.ts#L16)
+
+Whether to enable repository error mapping.
+
+***
+
+### validation?
+
+```ts
+readonly optional validation?: boolean | IApiValidationOptions;
+```
+
+Defined in: [steps/IApiStepOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/steps/IApiStepOptions.ts#L19)
+
+Validation behavior for request DTOs.

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

@@ -0,0 +1,58 @@
+---
+title: 'Interface: IApiValidationOptions'
+generated: true
+editUrl: false
+---
+# Interface: IApiValidationOptions
+
+Defined in: [steps/IApiValidationOptions.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/steps/IApiValidationOptions.ts#L6)
+
+Validation options used by the generic Archipel API bootstrap step.
+
+## Properties
+
+### enableImplicitConversion?
+
+```ts
+readonly optional enableImplicitConversion?: boolean;
+```
+
+Defined in: [steps/IApiValidationOptions.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/steps/IApiValidationOptions.ts#L17)
+
+Whether class-transformer should enable implicit primitive conversion.
+
+***
+
+### forbidNonWhitelisted?
+
+```ts
+readonly optional forbidNonWhitelisted?: boolean;
+```
+
+Defined in: [steps/IApiValidationOptions.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/steps/IApiValidationOptions.ts#L11)
+
+Whether stripped properties should produce validation errors.
+
+***
+
+### transform?
+
+```ts
+readonly optional transform?: boolean;
+```
+
+Defined in: [steps/IApiValidationOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/steps/IApiValidationOptions.ts#L14)
+
+Whether payloads should be transformed into DTO class instances.
+
+***
+
+### whitelist?
+
+```ts
+readonly optional whitelist?: boolean;
+```
+
+Defined in: [steps/IApiValidationOptions.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/steps/IApiValidationOptions.ts#L8)
+
+Whether properties without validation decorators are stripped.

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

@@ -0,0 +1,46 @@
+---
+title: 'Interface: IExpressServerStepOptions'
+generated: true
+editUrl: false
+---
+# Interface: IExpressServerStepOptions
+
+Defined in: server/express/IExpressServerStepOptions.ts:9
+
+Options for the Express-compatible server bootstrap step.
+
+## Properties
+
+### compression?
+
+```ts
+readonly optional compression?: boolean | CompressionOptions;
+```
+
+Defined in: server/express/IExpressServerStepOptions.ts:17
+
+Compression middleware options, or `false` to skip compression.
+
+***
+
+### json?
+
+```ts
+readonly optional json?: boolean | OptionsJson;
+```
+
+Defined in: server/express/IExpressServerStepOptions.ts:11
+
+JSON body parser options, or `false` to skip JSON body parsing.
+
+***
+
+### urlEncoded?
+
+```ts
+readonly optional urlEncoded?: boolean | OptionsUrlencoded;
+```
+
+Defined in: server/express/IExpressServerStepOptions.ts:14
+
+URL-encoded body parser options, or `false` to skip URL-encoded body parsing.

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

@@ -0,0 +1,34 @@
+---
+title: 'Interface: IOpenApiStepOptions'
+generated: true
+editUrl: false
+---
+# Interface: IOpenApiStepOptions
+
+Defined in: [openapi/IOpenApiStepOptions.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/openapi/IOpenApiStepOptions.ts#L8)
+
+Options for the OpenAPI bootstrap step.
+
+## Properties
+
+### enabled?
+
+```ts
+readonly optional enabled?: boolean;
+```
+
+Defined in: [openapi/IOpenApiStepOptions.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/openapi/IOpenApiStepOptions.ts#L10)
+
+Whether OpenAPI setup should run.
+
+***
+
+### theme?
+
+```ts
+readonly optional theme?: ISwaggerThemeConfig;
+```
+
+Defined in: [openapi/IOpenApiStepOptions.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/openapi/IOpenApiStepOptions.ts#L13)
+
+Optional Swagger UI theme configuration.

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

@@ -0,0 +1,22 @@
+---
+title: 'Interface: IPlatformApplicationOptions'
+generated: true
+editUrl: false
+---
+# Interface: IPlatformApplicationOptions
+
+Defined in: [options/IPlatformApplicationOptions.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/options/IPlatformApplicationOptions.ts#L8)
+
+Options for wrapping an existing NestJS application with Archipel platform bootstrap support.
+
+## Properties
+
+### configService?
+
+```ts
+readonly optional configService?: ConfigService;
+```
+
+Defined in: [options/IPlatformApplicationOptions.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/options/IPlatformApplicationOptions.ts#L10)
+
+Explicit configuration service to use instead of resolving it from the NestJS container.

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

@@ -0,0 +1,46 @@
+---
+title: 'Interface: IPlatformListenOptions'
+generated: true
+editUrl: false
+---
+# Interface: IPlatformListenOptions
+
+Defined in: [options/IPlatformListenOptions.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/options/IPlatformListenOptions.ts#L8)
+
+Options for resolving the HTTP listen port from typed configuration keys.
+
+## Properties
+
+### fallbackPort?
+
+```ts
+readonly optional fallbackPort?: number;
+```
+
+Defined in: [options/IPlatformListenOptions.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/options/IPlatformListenOptions.ts#L13)
+
+Fallback port used when none of the configured keys are present.
+
+***
+
+### hostname?
+
+```ts
+readonly optional hostname?: string;
+```
+
+Defined in: [options/IPlatformListenOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/options/IPlatformListenOptions.ts#L16)
+
+Optional hostname/interface binding passed to NestJS `listen`.
+
+***
+
+### portConfigKeys?
+
+```ts
+readonly optional portConfigKeys?: readonly IConfigKey<string | number | undefined>[];
+```
+
+Defined in: [options/IPlatformListenOptions.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/options/IPlatformListenOptions.ts#L10)
+
+Ordered list of port config keys. The first present value wins.