@breadstone/archipel-mcp 0.0.37 → 0.0.39

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

@@ -0,0 +1,211 @@
+---
+title: 'Interface: IPlatformTestApplication'
+generated: true
+editUrl: false
+---
+# Interface: IPlatformTestApplication
+
+Defined in: [testing/IPlatformTestApplication.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/testing/IPlatformTestApplication.ts#L9)
+
+In-memory application contract used by platform bootstrap tests.
+
+## Properties
+
+### calls
+
+```ts
+readonly calls: readonly string[];
+```
+
+Defined in: [testing/IPlatformTestApplication.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/testing/IPlatformTestApplication.ts#L11)
+
+Registered middleware and pipes/filters in execution order.
+
+***
+
+### configService
+
+```ts
+readonly configService: ConfigService;
+```
+
+Defined in: [testing/IPlatformTestApplication.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/testing/IPlatformTestApplication.ts#L14)
+
+Config service used by the test application.
+
+## Methods
+
+### enableCors()
+
+```ts
+enableCors(...args): void;
+```
+
+Defined in: [testing/IPlatformTestApplication.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/testing/IPlatformTestApplication.ts#L17)
+
+Enables CORS on the test application.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`args` | readonly `unknown`[] |
+
+#### Returns
+
+`void`
+
+***
+
+### get()
+
+```ts
+get<TService>(token, ...args): TService;
+```
+
+Defined in: [testing/IPlatformTestApplication.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/testing/IPlatformTestApplication.ts#L20)
+
+Resolves a provider from the test application.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TService` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `token` | `string` \| `symbol` \| `Type`\<`TService`\> |
+| ...`args` | readonly `unknown`[] |
+
+#### Returns
+
+`TService`
+
+***
+
+### init()
+
+```ts
+init(): Promise<void>;
+```
+
+Defined in: [testing/IPlatformTestApplication.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/testing/IPlatformTestApplication.ts#L23)
+
+Initializes the test application.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### listen()
+
+```ts
+listen(...args): Promise<void>;
+```
+
+Defined in: [testing/IPlatformTestApplication.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/testing/IPlatformTestApplication.ts#L26)
+
+Starts the test application listener.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`args` | readonly `unknown`[] |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### setGlobalPrefix()
+
+```ts
+setGlobalPrefix(prefix): void;
+```
+
+Defined in: [testing/IPlatformTestApplication.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/testing/IPlatformTestApplication.ts#L29)
+
+Sets the global test route prefix.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `prefix` | `string` |
+
+#### Returns
+
+`void`
+
+***
+
+### use()
+
+```ts
+use(...args): void;
+```
+
+Defined in: [testing/IPlatformTestApplication.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/testing/IPlatformTestApplication.ts#L32)
+
+Registers middleware on the test application.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`args` | readonly `unknown`[] |
+
+#### Returns
+
+`void`
+
+***
+
+### useGlobalFilters()
+
+```ts
+useGlobalFilters(...args): void;
+```
+
+Defined in: [testing/IPlatformTestApplication.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/testing/IPlatformTestApplication.ts#L35)
+
+Registers global filters on the test application.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`args` | readonly `unknown`[] |
+
+#### Returns
+
+`void`
+
+***
+
+### useGlobalPipes()
+
+```ts
+useGlobalPipes(...args): void;
+```
+
+Defined in: [testing/IPlatformTestApplication.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/testing/IPlatformTestApplication.ts#L38)
+
+Registers global pipes on the test application.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`args` | readonly `unknown`[] |
+
+#### Returns
+
+`void`

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

@@ -0,0 +1,63 @@
+---
+title: 'Interface: ISecurityStepOptions'
+generated: true
+editUrl: false
+---
+# Interface: ISecurityStepOptions
+
+Defined in: [security/ISecurityStepOptions.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/security/ISecurityStepOptions.ts#L11)
+
+Options for the generic security bootstrap step.
+
+## Properties
+
+### contentSecurityPolicy?
+
+```ts
+readonly optional contentSecurityPolicy?: 
+  | boolean
+  | PlatformContentSecurityPolicyMode
+  | ContentSecurityPolicyOptions;
+```
+
+Defined in: [security/ISecurityStepOptions.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/security/ISecurityStepOptions.ts#L19)
+
+Content-security-policy mode used when Helmet is enabled.
+
+***
+
+### cors?
+
+```ts
+readonly optional cors?: boolean | PlatformCorsOptions;
+```
+
+Defined in: [security/ISecurityStepOptions.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/security/ISecurityStepOptions.ts#L13)
+
+CORS options, or `false` to skip CORS setup.
+
+***
+
+### headers?
+
+```ts
+readonly optional headers?: boolean | HelmetOptions;
+```
+
+Defined in: [security/ISecurityStepOptions.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/security/ISecurityStepOptions.ts#L16)
+
+Helmet options, or `false` to skip security headers.
+
+***
+
+### rateLimit?
+
+```ts
+readonly optional rateLimit?: 
+  | boolean
+  | SecurityRateLimitOptions;
+```
+
+Defined in: [security/ISecurityStepOptions.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/security/ISecurityStepOptions.ts#L22)
+
+Rate-limit options, or `false` to skip rate limiting.

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

@@ -0,0 +1,118 @@
+---
+title: 'Interface: ISessionStepOptions'
+generated: true
+editUrl: false
+---
+# Interface: ISessionStepOptions
+
+Defined in: [session/ISessionStepOptions.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/session/ISessionStepOptions.ts#L9)
+
+Options for the Express-compatible session bootstrap step.
+
+## Properties
+
+### cookie?
+
+```ts
+readonly optional cookie?: CookieOptions | ((req) => CookieOptions);
+```
+
+Defined in: [session/ISessionStepOptions.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/session/ISessionStepOptions.ts#L35)
+
+Cookie options merged into the generated session cookie settings.
+
+***
+
+### enabled?
+
+```ts
+readonly optional enabled?: boolean;
+```
+
+Defined in: [session/ISessionStepOptions.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/session/ISessionStepOptions.ts#L11)
+
+Whether the session middleware should be registered.
+
+***
+
+### maxAgeConfigKey?
+
+```ts
+readonly optional maxAgeConfigKey?: IConfigKey<string | number>;
+```
+
+Defined in: [session/ISessionStepOptions.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/session/ISessionStepOptions.ts#L20)
+
+Config key containing the session lifetime.
+
+***
+
+### name?
+
+```ts
+readonly optional name?: string;
+```
+
+Defined in: [session/ISessionStepOptions.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/session/ISessionStepOptions.ts#L23)
+
+Session cookie name.
+
+***
+
+### resave?
+
+```ts
+readonly optional resave?: boolean;
+```
+
+Defined in: [session/ISessionStepOptions.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/session/ISessionStepOptions.ts#L26)
+
+Express-session `resave` option.
+
+***
+
+### saveUninitialized?
+
+```ts
+readonly optional saveUninitialized?: boolean;
+```
+
+Defined in: [session/ISessionStepOptions.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/session/ISessionStepOptions.ts#L29)
+
+Express-session `saveUninitialized` option.
+
+***
+
+### secretConfigKey?
+
+```ts
+readonly optional secretConfigKey?: IConfigKey<string>;
+```
+
+Defined in: [session/ISessionStepOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/session/ISessionStepOptions.ts#L14)
+
+Config key containing the session secret.
+
+***
+
+### secureConfigKey?
+
+```ts
+readonly optional secureConfigKey?: IConfigKey<boolean>;
+```
+
+Defined in: [session/ISessionStepOptions.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/session/ISessionStepOptions.ts#L17)
+
+Config key containing the secure-cookie flag.
+
+***
+
+### store?
+
+```ts
+readonly optional store?: Store;
+```
+
+Defined in: [session/ISessionStepOptions.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/session/ISessionStepOptions.ts#L32)
+
+Optional persistent session store.

package/data/packages/platform-bootstrap/api/TypeAlias.PlatformBootstrapNext.md

@@ -0,0 +1,18 @@
+---
+title: 'Type Alias: PlatformBootstrapNext'
+generated: true
+editUrl: false
+---
+# Type Alias: PlatformBootstrapNext
+
+```ts
+type PlatformBootstrapNext = () => Promise<void>;
+```
+
+Defined in: [types/PlatformBootstrapNext.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/types/PlatformBootstrapNext.ts#L6)
+
+Continues execution with the next platform bootstrap step.
+
+## Returns
+
+`Promise`\<`void`\>

package/data/packages/platform-bootstrap/api/TypeAlias.PlatformBootstrapStep.md

@@ -0,0 +1,31 @@
+---
+title: 'Type Alias: PlatformBootstrapStep\<TApplication\>'
+generated: true
+editUrl: false
+---
+# Type Alias: PlatformBootstrapStep\<TApplication\>
+
+```ts
+type PlatformBootstrapStep<TApplication> = (context, next) => Promise<void> | void;
+```
+
+Defined in: [types/PlatformBootstrapStep.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/types/PlatformBootstrapStep.ts#L10)
+
+A composable bootstrap step in the platform application pipeline.
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TApplication` *extends* `INestApplication` | `INestApplication` |
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `context` | [`PlatformBootstrapContext`](Class.PlatformBootstrapContext)\<`TApplication`\> |
+| `next` | [`PlatformBootstrapNext`](TypeAlias.PlatformBootstrapNext) |
+
+## Returns
+
+`Promise`\<`void`\> \| `void`

package/data/packages/platform-bootstrap/api/TypeAlias.PlatformContentSecurityPolicyMode.md

@@ -0,0 +1,14 @@
+---
+title: 'Type Alias: PlatformContentSecurityPolicyMode'
+generated: true
+editUrl: false
+---
+# Type Alias: PlatformContentSecurityPolicyMode
+
+```ts
+type PlatformContentSecurityPolicyMode = "default" | "swagger-compatible";
+```
+
+Defined in: [security/PlatformContentSecurityPolicyMode.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/security/PlatformContentSecurityPolicyMode.ts#L6)
+
+Named content-security-policy modes supported by `platform-bootstrap/security`.

package/data/packages/platform-bootstrap/api/TypeAlias.PlatformCorsOptions.md

@@ -0,0 +1,14 @@
+---
+title: 'Type Alias: PlatformCorsOptions'
+generated: true
+editUrl: false
+---
+# Type Alias: PlatformCorsOptions
+
+```ts
+type PlatformCorsOptions = CorsOptions | CorsOptionsDelegate<unknown>;
+```
+
+Defined in: [security/PlatformCorsOptions.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/security/PlatformCorsOptions.ts#L8)
+
+CORS options accepted by the security bootstrap step.

package/data/packages/platform-bootstrap/api/TypeAlias.SecurityRateLimitOptions.md

@@ -0,0 +1,28 @@
+---
+title: 'Type Alias: SecurityRateLimitOptions'
+generated: true
+editUrl: false
+---
+# Type Alias: SecurityRateLimitOptions
+
+```ts
+type SecurityRateLimitOptions = Partial<RateLimitOptions> & {
+  fallbackLimit?: number;
+  fallbackWindowMs?: number;
+  limitConfigKey?: IConfigKey<string | number | undefined>;
+  windowMsConfigKey?: IConfigKey<string | number | undefined>;
+};
+```
+
+Defined in: [security/SecurityRateLimitOptions.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/security/SecurityRateLimitOptions.ts#L9)
+
+Rate-limit options accepted by the security bootstrap step.
+
+## Type Declaration
+
+| Name | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| `fallbackLimit?` | `number` | Fallback request limit. | [security/SecurityRateLimitOptions.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/security/SecurityRateLimitOptions.ts#L20) |
+| `fallbackWindowMs?` | `number` | Fallback rate-limit window in milliseconds. | [security/SecurityRateLimitOptions.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/security/SecurityRateLimitOptions.ts#L17) |
+| `limitConfigKey?` | `IConfigKey`\<`string` \| `number` \| `undefined`\> | Config key used for the request limit. | [security/SecurityRateLimitOptions.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/security/SecurityRateLimitOptions.ts#L14) |
+| `windowMsConfigKey?` | `IConfigKey`\<`string` \| `number` \| `undefined`\> | Config key used for the rate-limit window duration. | [security/SecurityRateLimitOptions.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/security/SecurityRateLimitOptions.ts#L11) |

package/data/packages/platform-bootstrap/api/Variable.APP_CORS_ORIGIN.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: APP\_CORS\_ORIGIN'
+generated: true
+editUrl: false
+---
+# Variable: APP\_CORS\_ORIGIN
+
+```ts
+const APP_CORS_ORIGIN: IConfigKey<string>;
+```
+
+Defined in: [env.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/env.ts#L7)
+
+Comma-separated list of allowed CORS origins.

package/data/packages/platform-bootstrap/api/Variable.APP_RATE_LIMIT_MAX_REQUESTS.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: APP\_RATE\_LIMIT\_MAX\_REQUESTS'
+generated: true
+editUrl: false
+---
+# Variable: APP\_RATE\_LIMIT\_MAX\_REQUESTS
+
+```ts
+const APP_RATE_LIMIT_MAX_REQUESTS: IConfigKey<number>;
+```
+
+Defined in: [env.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/env.ts#L13)
+
+Maximum requests accepted within the rate-limit window.

package/data/packages/platform-bootstrap/api/Variable.APP_RATE_LIMIT_WINDOW_MS.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: APP\_RATE\_LIMIT\_WINDOW\_MS'
+generated: true
+editUrl: false
+---
+# Variable: APP\_RATE\_LIMIT\_WINDOW\_MS
+
+```ts
+const APP_RATE_LIMIT_WINDOW_MS: IConfigKey<number>;
+```
+
+Defined in: [env.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/env.ts#L10)
+
+Rate-limit window in milliseconds.

package/data/packages/platform-bootstrap/api/Variable.AUTH_SESSION_MAX_AGE.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: AUTH\_SESSION\_MAX\_AGE'
+generated: true
+editUrl: false
+---
+# Variable: AUTH\_SESSION\_MAX\_AGE
+
+```ts
+const AUTH_SESSION_MAX_AGE: IConfigKey<string>;
+```
+
+Defined in: [env.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/env.ts#L22)
+
+Session cookie lifetime, for example `30d` or `86400000`.

package/data/packages/platform-bootstrap/api/Variable.AUTH_SESSION_SECRET.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: AUTH\_SESSION\_SECRET'
+generated: true
+editUrl: false
+---
+# Variable: AUTH\_SESSION\_SECRET
+
+```ts
+const AUTH_SESSION_SECRET: IConfigKey<string>;
+```
+
+Defined in: [env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/env.ts#L16)
+
+Secret used by Express-compatible session middleware.

package/data/packages/platform-bootstrap/api/Variable.AUTH_SESSION_SECURE.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: AUTH\_SESSION\_SECURE'
+generated: true
+editUrl: false
+---
+# Variable: AUTH\_SESSION\_SECURE
+
+```ts
+const AUTH_SESSION_SECURE: IConfigKey<boolean>;
+```
+
+Defined in: [env.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/env.ts#L19)
+
+Whether session cookies should be marked secure.

package/data/packages/platform-bootstrap/api/Variable.PLATFORM_SECURITY_CONFIG_ENTRIES.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: PLATFORM\_SECURITY\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: PLATFORM\_SECURITY\_CONFIG\_ENTRIES
+
+```ts
+const PLATFORM_SECURITY_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: [env.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/env.ts#L30)
+
+Security step configuration entries provided by `platform-bootstrap/security`.

package/data/packages/platform-bootstrap/api/Variable.PLATFORM_SERVER_CONFIG_ENTRIES.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: PLATFORM\_SERVER\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: PLATFORM\_SERVER\_CONFIG\_ENTRIES
+
+```ts
+const PLATFORM_SERVER_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: [env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/env.ts#L25)
+
+Server bootstrap configuration entries provided by `platform-bootstrap`.

package/data/packages/platform-bootstrap/api/Variable.PLATFORM_SESSION_CONFIG_ENTRIES.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: PLATFORM\_SESSION\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: PLATFORM\_SESSION\_CONFIG\_ENTRIES
+
+```ts
+const PLATFORM_SESSION_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: [env.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/env.ts#L37)
+
+Session step configuration entries provided by `platform-bootstrap/session`.

package/data/packages/platform-bootstrap/api/Variable.PORT.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: PORT'
+generated: true
+editUrl: false
+---
+# Variable: PORT
+
+```ts
+const PORT: IConfigKey<number>;
+```
+
+Defined in: [env.ts:4](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-bootstrap/src/env.ts#L4)
+
+HTTP port exposed by serverless hosts such as Vercel.