@breadstone/archipel-mcp 0.0.1

package/data/packages/platform-core/api/Class.HostService.md

@@ -0,0 +1,150 @@
+---
+title: 'Class: HostService'
+generated: true
+editUrl: false
+---
+
+# Class: HostService
+
+Defined in: [services/HostService.ts:142](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L142)
+
+The `HostService` class.
+
+## Constructors
+
+### Constructor
+
+```ts
+new HostService(
+   configService,
+   contentTemplateEngine,
+   resourceManager): HostService;
+```
+
+Defined in: [services/HostService.ts:159](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L159)
+
+Constructs a new instance of the `HostService` class.
+
+#### Parameters
+
+| Parameter               | Type                                                   |
+| ----------------------- | ------------------------------------------------------ |
+| `configService`         | [`ConfigService`](Class.ConfigService)                 |
+| `contentTemplateEngine` | [`ContentTemplateEngine`](Class.ContentTemplateEngine) |
+| `resourceManager`       | [`ResourceManager`](Class.ResourceManager)             |
+
+#### Returns
+
+`HostService`
+
+## Accessors
+
+### host
+
+#### Get Signature
+
+```ts
+get host(): string;
+```
+
+Defined in: [services/HostService.ts:195](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L195)
+
+The full host (URL + port in development).
+
+##### Returns
+
+`string`
+
+---
+
+### port
+
+#### Get Signature
+
+```ts
+get port(): number;
+```
+
+Defined in: [services/HostService.ts:185](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L185)
+
+The port of the host.
+
+##### Returns
+
+`number`
+
+---
+
+### stage
+
+#### Get Signature
+
+```ts
+get stage(): "unknown" | "local" | "development" | "preview" | "production";
+```
+
+Defined in: [services/HostService.ts:207](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L207)
+
+The current stage of the application.
+
+##### Returns
+
+`"unknown"` \| `"local"` \| `"development"` \| `"preview"` \| `"production"`
+
+---
+
+### url
+
+#### Get Signature
+
+```ts
+get url(): string;
+```
+
+Defined in: [services/HostService.ts:175](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L175)
+
+The URL of the host.
+
+##### Returns
+
+`string`
+
+---
+
+### version
+
+#### Get Signature
+
+```ts
+get version(): string;
+```
+
+Defined in: [services/HostService.ts:228](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L228)
+
+The application version.
+
+##### Returns
+
+`string`
+
+## Methods
+
+### getHostContent()
+
+```ts
+getHostContent(params): Promise<string>;
+```
+
+Defined in: [services/HostService.ts:240](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/HostService.ts#L240)
+
+Retrieves the host content
+
+#### Parameters
+
+| Parameter | Type                                                 |
+| --------- | ---------------------------------------------------- |
+| `params`  | [`IHostContentParams`](Interface.IHostContentParams) |
+
+#### Returns
+
+`Promise`\<`string`\>

package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md

@@ -0,0 +1,60 @@
+---
+title: 'Class: HttpLoggerMiddleware'
+generated: true
+editUrl: false
+---
+
+# Class: HttpLoggerMiddleware
+
+Defined in: [middlewares/HttpLoggerMiddleware.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/middlewares/HttpLoggerMiddleware.ts#L10)
+
+## Implements
+
+- `NestMiddleware`
+
+## Constructors
+
+### Constructor
+
+```ts
+new HttpLoggerMiddleware(): HttpLoggerMiddleware;
+```
+
+Defined in: [middlewares/HttpLoggerMiddleware.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/middlewares/HttpLoggerMiddleware.ts#L25)
+
+Constructs a new instance of the `HttpLoggerMiddleware` class.
+
+#### Returns
+
+`HttpLoggerMiddleware`
+
+## Methods
+
+### use()
+
+```ts
+use(
+   req,
+   _res,
+   next): void;
+```
+
+Defined in: [middlewares/HttpLoggerMiddleware.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/middlewares/HttpLoggerMiddleware.ts#L31)
+
+#### Parameters
+
+| Parameter | Type         |
+| --------- | ------------ |
+| `req`     | `any`        |
+| `_res`    | `any`        |
+| `next`    | () => `void` |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+```ts
+NestMiddleware.use;
+```

package/data/packages/platform-core/api/Class.IdGeneratorBase.md

@@ -0,0 +1,88 @@
+---
+title: 'Abstract Class: IdGeneratorBase'
+generated: true
+editUrl: false
+---
+
+# Abstract Class: IdGeneratorBase
+
+Defined in: [identifiers/generators/abstracts/IdGeneratorBase.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/abstracts/IdGeneratorBase.ts#L15)
+
+Abstract base class for ID Generators
+
+## Extended by
+
+- [`CUIDGenerator`](Class.CUIDGenerator)
+- [`GUIDGenerator`](Class.GUIDGenerator)
+- [`UUIDGenerator`](Class.UUIDGenerator)
+
+## Implements
+
+- [`IIdGenerator`](Interface.IIdGenerator)
+
+## Constructors
+
+### Constructor
+
+```ts
+new IdGeneratorBase(): IdGeneratorBase;
+```
+
+#### Returns
+
+`IdGeneratorBase`
+
+## Methods
+
+### generate()
+
+```ts
+abstract generate(prefix?, postfix?): string;
+```
+
+Defined in: [identifiers/generators/abstracts/IdGeneratorBase.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/abstracts/IdGeneratorBase.ts#L24)
+
+Generates a new ID
+
+#### Parameters
+
+| Parameter  | Type     | Description                          |
+| ---------- | -------- | ------------------------------------ |
+| `prefix?`  | `string` | Optional prefix to prepend to the ID |
+| `postfix?` | `string` | Optional postfix to append to the ID |
+
+#### Returns
+
+`string`
+
+#### Implementation of
+
+[`IIdGenerator`](Interface.IIdGenerator).[`generate`](Interface.IIdGenerator#generate)
+
+---
+
+### isValid()
+
+```ts
+abstract isValid(id): boolean;
+```
+
+Defined in: [identifiers/generators/abstracts/IdGeneratorBase.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/abstracts/IdGeneratorBase.ts#L32)
+
+Validates if the given ID conforms to the expected format
+
+#### Parameters
+
+| Parameter | Type     | Description        |
+| --------- | -------- | ------------------ |
+| `id`      | `string` | The ID to validate |
+
+#### Returns
+
+`boolean`
+
+True if the ID is valid, otherwise false
+
+#### Implementation of
+
+[`IIdGenerator`](Interface.IIdGenerator).[`isValid`](Interface.IIdGenerator#isvalid)

package/data/packages/platform-core/api/Class.IdentifierModule.md

@@ -0,0 +1,41 @@
+---
+title: 'Class: IdentifierModule'
+generated: true
+editUrl: false
+---
+
+# Class: IdentifierModule
+
+Defined in: [identifiers/IdentifierModule.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/IdentifierModule.ts#L28)
+
+## Constructors
+
+### Constructor
+
+```ts
+new IdentifierModule(): IdentifierModule;
+```
+
+#### Returns
+
+`IdentifierModule`
+
+## Methods
+
+### register()
+
+```ts
+static register(type): DynamicModule;
+```
+
+Defined in: [identifiers/IdentifierModule.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/IdentifierModule.ts#L30)
+
+#### Parameters
+
+| Parameter | Type                             |
+| --------- | -------------------------------- |
+| `type`    | `"UUID"` \| `"GUID"` \| `"CUID"` |
+
+#### Returns
+
+`DynamicModule`

package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistrarBase.md

@@ -0,0 +1,39 @@
+---
+title: 'Abstract Class: IntelligenceCapabilityRegistrarBase'
+generated: true
+editUrl: false
+---
+
+# Abstract Class: IntelligenceCapabilityRegistrarBase
+
+Defined in: [intelligence/abstracts/IntelligenceCapabilityRegistrarBase.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/abstracts/IntelligenceCapabilityRegistrarBase.ts#L15)
+
+Provides a reusable registration flow that allows feature modules to contribute
+capabilities to the global intelligence registry while keeping their implementation details private.
+
+## Implements
+
+- `OnModuleInit`
+
+## Methods
+
+### onModuleInit()
+
+```ts
+onModuleInit(): void;
+```
+
+Defined in: [intelligence/abstracts/IntelligenceCapabilityRegistrarBase.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/abstracts/IntelligenceCapabilityRegistrarBase.ts#L50)
+
+Template method invoked by NestJS once the provider has been instantiated.
+Registers all capabilities returned by getCapabilities.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+```ts
+OnModuleInit.onModuleInit;
+```

package/data/packages/platform-core/api/Class.IntelligenceCapabilityRegistry.md

@@ -0,0 +1,103 @@
+---
+title: 'Class: IntelligenceCapabilityRegistry'
+generated: true
+editUrl: false
+---
+
+# Class: IntelligenceCapabilityRegistry
+
+Defined in: [intelligence/IntelligenceCapabilityRegistry.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IntelligenceCapabilityRegistry.ts#L15)
+
+Central registry responsible for resolving intelligence capabilities based on intent metadata.
+
+## Implements
+
+- [`IIntelligenceCapabilityRegistry`](Interface.IIntelligenceCapabilityRegistry)
+
+## Constructors
+
+### Constructor
+
+```ts
+new IntelligenceCapabilityRegistry(): IntelligenceCapabilityRegistry;
+```
+
+#### Returns
+
+`IntelligenceCapabilityRegistry`
+
+## Methods
+
+### list()
+
+```ts
+list(): readonly IIntelligenceCapability[];
+```
+
+Defined in: [intelligence/IntelligenceCapabilityRegistry.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IntelligenceCapabilityRegistry.ts#L37)
+
+#### Returns
+
+readonly [`IIntelligenceCapability`](Interface.IIntelligenceCapability)[]
+
+#### Inherit Doc
+
+#### Implementation of
+
+[`IIntelligenceCapabilityRegistry`](Interface.IIntelligenceCapabilityRegistry).[`list`](Interface.IIntelligenceCapabilityRegistry#list)
+
+---
+
+### register()
+
+```ts
+register(capability): void;
+```
+
+Defined in: [intelligence/IntelligenceCapabilityRegistry.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IntelligenceCapabilityRegistry.ts#L26)
+
+#### Parameters
+
+| Parameter    | Type                                                           |
+| ------------ | -------------------------------------------------------------- |
+| `capability` | [`IIntelligenceCapability`](Interface.IIntelligenceCapability) |
+
+#### Returns
+
+`void`
+
+#### Inherit Doc
+
+#### Implementation of
+
+[`IIntelligenceCapabilityRegistry`](Interface.IIntelligenceCapabilityRegistry).[`register`](Interface.IIntelligenceCapabilityRegistry#register)
+
+---
+
+### resolve()
+
+```ts
+resolve(intent, context):
+  | IIntelligenceCapability
+  | null;
+```
+
+Defined in: [intelligence/IntelligenceCapabilityRegistry.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IntelligenceCapabilityRegistry.ts#L32)
+
+#### Parameters
+
+| Parameter | Type                                                     |
+| --------- | -------------------------------------------------------- |
+| `intent`  | [`IIntelligenceIntent`](Interface.IIntelligenceIntent)   |
+| `context` | [`IIntelligenceContext`](Interface.IIntelligenceContext) |
+
+#### Returns
+
+\| [`IIntelligenceCapability`](Interface.IIntelligenceCapability)
+\| `null`
+
+#### Inherit Doc
+
+#### Implementation of
+
+[`IIntelligenceCapabilityRegistry`](Interface.IIntelligenceCapabilityRegistry).[`resolve`](Interface.IIntelligenceCapabilityRegistry#resolve)

package/data/packages/platform-core/api/Class.IntelligenceModule.md

@@ -0,0 +1,23 @@
+---
+title: 'Class: IntelligenceModule'
+generated: true
+editUrl: false
+---
+
+# Class: IntelligenceModule
+
+Defined in: [intelligence/IntelligenceModule.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IntelligenceModule.ts#L24)
+
+Core module exposing the shared intelligence infrastructure to feature modules.
+
+## Constructors
+
+### Constructor
+
+```ts
+new IntelligenceModule(): IntelligenceModule;
+```
+
+#### Returns
+
+`IntelligenceModule`

package/data/packages/platform-core/api/Class.IntelligenceTextGenerator.md

@@ -0,0 +1,82 @@
+---
+title: 'Class: IntelligenceTextGenerator'
+generated: true
+editUrl: false
+---
+
+# Class: IntelligenceTextGenerator
+
+Defined in: [intelligence/IntelligenceTextGenerator.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IntelligenceTextGenerator.ts#L23)
+
+Executes text completions using the configured intelligence provider.
+
+## Implements
+
+- [`IIntelligenceTextGenerator`](Interface.IIntelligenceTextGenerator)
+
+## Constructors
+
+### Constructor
+
+```ts
+new IntelligenceTextGenerator(configService): IntelligenceTextGenerator;
+```
+
+Defined in: [intelligence/IntelligenceTextGenerator.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IntelligenceTextGenerator.ts#L37)
+
+#### Parameters
+
+| Parameter       | Type                                   |
+| --------------- | -------------------------------------- |
+| `configService` | [`ConfigService`](Class.ConfigService) |
+
+#### Returns
+
+`IntelligenceTextGenerator`
+
+## Methods
+
+### generateText()
+
+```ts
+generateText(prompt, options?): Promise<IIntelligenceTextCompletion>;
+```
+
+Defined in: [intelligence/IntelligenceTextGenerator.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IntelligenceTextGenerator.ts#L57)
+
+Generates a completion using the configured provider.
+
+#### Parameters
+
+| Parameter  | Type                                                                                 | Description                                         |
+| ---------- | ------------------------------------------------------------------------------------ | --------------------------------------------------- |
+| `prompt`   | [`IIntelligencePrompt`](Interface.IIntelligencePrompt)                               | The assembled prompt payload.                       |
+| `options?` | [`IIntelligenceTextGenerationOptions`](Interface.IIntelligenceTextGenerationOptions) | Optional overrides for the text generation request. |
+
+#### Returns
+
+`Promise`\<[`IIntelligenceTextCompletion`](Interface.IIntelligenceTextCompletion)\>
+
+#### Implementation of
+
+[`IIntelligenceTextGenerator`](Interface.IIntelligenceTextGenerator).[`generateText`](Interface.IIntelligenceTextGenerator#generatetext)
+
+---
+
+### getConfiguration()
+
+```ts
+getConfiguration(): IIntelligenceProviderConfiguration;
+```
+
+Defined in: [intelligence/IntelligenceTextGenerator.ts:90](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/intelligence/IntelligenceTextGenerator.ts#L90)
+
+Returns the resolved provider configuration.
+
+#### Returns
+
+[`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration)
+
+#### Implementation of
+
+[`IIntelligenceTextGenerator`](Interface.IIntelligenceTextGenerator).[`getConfiguration`](Interface.IIntelligenceTextGenerator#getconfiguration)

package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md

@@ -0,0 +1,60 @@
+---
+title: 'Class: LimitRequestSizeMiddleware'
+generated: true
+editUrl: false
+---
+
+# Class: LimitRequestSizeMiddleware
+
+Defined in: [middlewares/LimitRequestSizeMiddleware.ts:5](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/middlewares/LimitRequestSizeMiddleware.ts#L5)
+
+## Implements
+
+- `NestMiddleware`
+
+## Constructors
+
+### Constructor
+
+```ts
+new LimitRequestSizeMiddleware(): LimitRequestSizeMiddleware;
+```
+
+Defined in: [middlewares/LimitRequestSizeMiddleware.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/middlewares/LimitRequestSizeMiddleware.ts#L18)
+
+Constructs a new instance of the `LimitRequestSizeMiddleware` class.
+
+#### Returns
+
+`LimitRequestSizeMiddleware`
+
+## Methods
+
+### use()
+
+```ts
+use(
+   request,
+   _response,
+   next): void;
+```
+
+Defined in: [middlewares/LimitRequestSizeMiddleware.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/middlewares/LimitRequestSizeMiddleware.ts#L22)
+
+#### Parameters
+
+| Parameter   | Type           |
+| ----------- | -------------- |
+| `request`   | `Request`      |
+| `_response` | `Response`     |
+| `next`      | `NextFunction` |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+```ts
+NestMiddleware.use;
+```

package/data/packages/platform-core/api/Class.LocalizedTextRequest.md

@@ -0,0 +1,43 @@
+---
+title: 'Class: LocalizedTextRequest'
+generated: true
+editUrl: false
+---
+
+# Class: LocalizedTextRequest
+
+Defined in: [models/requests/LocalizedTextRequest.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/requests/LocalizedTextRequest.ts#L14)
+
+Request DTO for a single localized text entry.
+
+## Constructors
+
+### Constructor
+
+```ts
+new LocalizedTextRequest(): LocalizedTextRequest;
+```
+
+#### Returns
+
+`LocalizedTextRequest`
+
+## Properties
+
+### locale
+
+```ts
+locale: string;
+```
+
+Defined in: [models/requests/LocalizedTextRequest.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/requests/LocalizedTextRequest.ts#L26)
+
+---
+
+### value
+
+```ts
+value: string;
+```
+
+Defined in: [models/requests/LocalizedTextRequest.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/requests/LocalizedTextRequest.ts#L32)