@breadstone/archipel-mcp 0.0.1 → 0.0.2

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

@@ -3,7 +3,6 @@ title: 'Class: SseHub'
 generated: true
 editUrl: false
 ---
-
 # Class: SseHub
 
 Defined in: [sse/services/SseHub.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L16)
@@ -44,9 +43,9 @@ Clears the event with the specified ID.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `id`      | `string` | The ID of the event. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The ID of the event. |
 
 #### Returns
 
@@ -56,7 +55,7 @@ Clears the event with the specified ID.
 
 [`ISseHub`](Interface.ISseHub).[`clearEvent`](Interface.ISseHub#clearevent)
 
----
+***
 
 ### emitEvent()
 
@@ -70,10 +69,10 @@ Emits an event with the specified ID and data.
 
 #### Parameters
 
-| Parameter | Type                                       | Description            |
-| --------- | ------------------------------------------ | ---------------------- |
-| `id`      | `string`                                   | The ID of the event.   |
-| `data`    | [`ISseEventData`](Interface.ISseEventData) | The data of the event. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The ID of the event. |
+| `data` | [`ISseEventData`](Interface.ISseEventData) | The data of the event. |
 
 #### Returns
 
@@ -83,7 +82,7 @@ Emits an event with the specified ID and data.
 
 [`ISseHub`](Interface.ISseHub).[`emitEvent`](Interface.ISseHub#emitevent)
 
----
+***
 
 ### getObservable()
 
@@ -97,8 +96,8 @@ Gets an observable for the event with the specified ID.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `eventId` | `string` | The ID of the event. |
 
 #### Returns
@@ -111,7 +110,7 @@ An observable for the event.
 
 [`ISseHub`](Interface.ISseHub).[`getObservable`](Interface.ISseHub#getobservable)
 
----
+***
 
 ### isEventActive()
 
@@ -125,9 +124,9 @@ Determines whether the event with the specified ID is active.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `id`      | `string` | The ID of the event. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The ID of the event. |
 
 #### Returns
 
@@ -139,7 +138,7 @@ Determines whether the event with the specified ID is active.
 
 [`ISseHub`](Interface.ISseHub).[`isEventActive`](Interface.ISseHub#iseventactive)
 
----
+***
 
 ### registerEvent()
 
@@ -153,15 +152,15 @@ Registers an event with the specified ID.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `id`      | `string` | The ID of the event. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The ID of the event. |
 
 #### Returns
 
 `void`
 
----
+***
 
 ### unregisterEvent()
 
@@ -175,9 +174,9 @@ Unregisters an event with the specified ID.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `id`      | `string` | The ID of the event. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The ID of the event. |
 
 #### Returns
 

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

@@ -3,7 +3,6 @@ title: 'Class: SseModule'
 generated: true
 editUrl: false
 ---
-
 # Class: SseModule
 
 Defined in: [sse/SseModule.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/SseModule.ts#L41)
@@ -34,9 +33,9 @@ Defined in: [sse/SseModule.ts:45](https://github.com/RueDeRennes/archipel/blob/m
 
 #### Parameters
 
-| Parameter | Type               |
-| --------- | ------------------ |
-| `config`  | `ISseModuleConfig` |
+| Parameter | Type |
+| ------ | ------ |
+| `config` | `ISseModuleConfig` |
 
 #### Returns
 

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

@@ -3,7 +3,6 @@ title: 'Abstract Class: TimeStampResponse'
 generated: true
 editUrl: false
 ---
-
 # Abstract Class: TimeStampResponse
 
 Defined in: [models/response/TimeStampResponse.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/TimeStampResponse.ts#L15)
@@ -32,7 +31,7 @@ createdAt: Date;
 
 Defined in: [models/response/TimeStampResponse.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/TimeStampResponse.ts#L25)
 
----
+***
 
 ### updatedAt
 

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

@@ -3,7 +3,6 @@ title: 'Class: TypeMappingNotRegisteredError'
 generated: true
 editUrl: false
 ---
-
 # Class: TypeMappingNotRegisteredError
 
 Defined in: [mapping/errors/TypeMappingNotRegisteredError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/errors/TypeMappingNotRegisteredError.ts#L12)
@@ -26,9 +25,9 @@ Defined in: [mapping/errors/TypeMappingNotRegisteredError.ts:16](https://github.
 
 #### Parameters
 
-| Parameter     | Type     |
-| ------------- | -------- |
-| `source`      | `string` |
+| Parameter | Type |
+| ------ | ------ |
+| `source` | `string` |
 | `destination` | `string` |
 
 #### Returns
@@ -38,7 +37,7 @@ Defined in: [mapping/errors/TypeMappingNotRegisteredError.ts:16](https://github.
 #### Overrides
 
 ```ts
-MappingError.constructor;
+MappingError.constructor
 ```
 
 ## Properties
@@ -54,5 +53,5 @@ Defined in: [mapping/errors/MappingError.ts:11](https://github.com/RueDeRennes/a
 #### Inherited from
 
 ```ts
-MappingError.code;
+MappingError.code
 ```

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

@@ -3,7 +3,6 @@ title: 'Class: UUIDGenerator'
 generated: true
 editUrl: false
 ---
-
 # Class: UUIDGenerator
 
 Defined in: [identifiers/generators/UUIDGenerator.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/UUIDGenerator.ts#L14)
@@ -44,9 +43,9 @@ Generates a version 4 UUID (random-based)
 
 #### Parameters
 
-| Parameter  | Type     | Description                          |
-| ---------- | -------- | ------------------------------------ |
-| `prefix?`  | `string` | Optional prefix to prepend to the ID |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `prefix?` | `string` | Optional prefix to prepend to the ID |
 | `postfix?` | `string` | Optional postfix to append to the ID |
 
 #### Returns
@@ -57,7 +56,7 @@ Generates a version 4 UUID (random-based)
 
 [`IdGeneratorBase`](Class.IdGeneratorBase).[`generate`](Class.IdGeneratorBase#generate)
 
----
+***
 
 ### isValid()
 
@@ -71,9 +70,9 @@ Validates if the provided string is a valid UUID (version 4)
 
 #### Parameters
 
-| Parameter | Type     | Description        |
-| --------- | -------- | ------------------ |
-| `id`      | `string` | The ID to validate |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The ID to validate |
 
 #### Returns
 

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

@@ -3,7 +3,6 @@ title: 'Class: UserAvatarGeneratorService'
 generated: true
 editUrl: false
 ---
-
 # Class: UserAvatarGeneratorService
 
 Defined in: [services/UserAvatarGenerator.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/UserAvatarGenerator.ts#L14)
@@ -36,10 +35,10 @@ Generates a random avatar as a base64-encoded PNG string.
 
 #### Parameters
 
-| Parameter | Type     | Default value | Description                                   |
-| --------- | -------- | ------------- | --------------------------------------------- |
-| `width`   | `number` | `128`         | Width of the avatar in pixels (default: 128)  |
-| `height`  | `number` | `128`         | Height of the avatar in pixels (default: 128) |
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `width` | `number` | `128` | Width of the avatar in pixels (default: 128) |
+| `height` | `number` | `128` | Height of the avatar in pixels (default: 128) |
 
 #### Returns
 

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

@@ -3,7 +3,6 @@ title: 'Class: UserNameGeneratorService'
 generated: true
 editUrl: false
 ---
-
 # Class: UserNameGeneratorService
 
 Defined in: [services/UsernameGeneratorService.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/UsernameGeneratorService.ts#L14)
@@ -36,9 +35,9 @@ Generates a random user name.
 
 #### Parameters
 
-| Parameter    | Type      | Default value | Description                                              |
-| ------------ | --------- | ------------- | -------------------------------------------------------- |
-| `useNumbers` | `boolean` | `true`        | If true, adds random numbers at the end of the user name |
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `useNumbers` | `boolean` | `true` | If true, adds random numbers at the end of the user name |
 
 #### Returns
 
@@ -46,7 +45,7 @@ Generates a random user name.
 
 A randomly generated user name
 
----
+***
 
 ### generateSecure()
 

package/data/packages/platform-core/api/Function.Public.md

@@ -0,0 +1,18 @@
+---
+title: 'Function: Public()'
+generated: true
+editUrl: false
+---
+# Function: Public()
+
+```ts
+function Public(): CustomDecorator;
+```
+
+Defined in: [decorators/Public.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/Public.ts#L14)
+
+The `Public` decorator.
+
+## Returns
+
+`CustomDecorator`

package/data/packages/platform-core/api/Function.createConfigKey.md

@@ -0,0 +1,58 @@
+---
+title: 'Function: createConfigKey()'
+generated: true
+editUrl: false
+---
+# Function: createConfigKey()
+
+```ts
+function createConfigKey<TType>(key): IConfigKey<TType>;
+```
+
+Defined in: [config/ConfigKey.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigKey.ts#L74)
+
+Creates a type-safe config key.
+
+Use this factory function to define all configuration keys in your application.
+This ensures you don’t scatter raw strings and you assign a type to each key.
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TType` | `unknown` |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | – The unique string identifier for the config entry. For example: `'DATABASE_URL'`, `'featureX.enabled'`, `'timeout.ms'`. |
+
+## Returns
+
+[`IConfigKey`](Interface.IConfigKey)\<`TType`\>
+
+A branded config key of type `IConfigKey<TType>` where `TType` is
+         inferred (or specified) as the expected type of the value.
+
+## Example
+
+```typescript
+// In some config-keys file
+export const DATABASE_URL = createConfigKey<string>('DATABASE_URL');
+export const MAX_TIMEOUT_MS = createConfigKey<number>('MAX_TIMEOUT_MS');
+export const FEATURE_X_ENABLED = createConfigKey<boolean>('FEATURE_X_ENABLED');
+```
+
+Then, when fetching:
+```ts
+const url = configService.get(DATABASE_URL);       // typed as string
+const timeout = configService.get(MAX_TIMEOUT_MS); // typed as number
+const enabled = configService.get(FEATURE_X_ENABLED); // typed as boolean
+```
+
+## Remarks
+
+At runtime the returned object is minimal (just `{ key: string }`) so there is
+virtually no overhead. The generic `TType` is only used by TypeScript for stronger
+compile-time checking — enabling you to avoid magic strings and untyped fetches.

package/data/packages/platform-core/api/Function.createEventKey.md

@@ -0,0 +1,33 @@
+---
+title: 'Function: createEventKey()'
+generated: true
+editUrl: false
+---
+# Function: createEventKey()
+
+```ts
+function createEventKey<TEvents, TKey>(eventName): IEventKey<TEvents, TKey>;
+```
+
+Defined in: [events/EventKey.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventKey.ts#L26)
+
+Creates a branded event key for the [EventHub](Class.EventHub).
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TEvents` *extends* [`IEventMap`](Interface.IEventMap) |
+| `TKey` *extends* `string` \| `number` \| `symbol` |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `eventName` | `TKey` | The unique name of the event. |
+
+## Returns
+
+[`IEventKey`](Interface.IEventKey)\<`TEvents`, `TKey`\>
+
+The branded event key encoding the payload type.

package/data/packages/platform-core/api/Function.createMappingKey.md

@@ -0,0 +1,39 @@
+---
+title: 'Function: createMappingKey()'
+generated: true
+editUrl: false
+---
+# Function: createMappingKey()
+
+```ts
+function createMappingKey<TInput, TOutput>(key): IMappingKey<TInput, TOutput>;
+```
+
+Defined in: [mapping/types/MappingKey.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L28)
+
+Creates a type-safe mapping key.
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TInput` |
+| `TOutput` |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The unique string identifier for the mapping. |
+
+## Returns
+
+[`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\>
+
+A branded mapping key that encodes the input and output types.
+
+## Example
+
+```typescript
+export const PRODUCT_MAPPING_KEY = createMappingKey<IProductMappingInput, ProductResponse>('food.product');
+```

package/data/packages/platform-core/api/Function.env.md

@@ -0,0 +1,28 @@
+---
+title: 'Function: env()'
+generated: true
+editUrl: false
+---
+# Function: env()
+
+```ts
+function env(strings, ...values): string;
+```
+
+Defined in: [utils/EnvUtils.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/EnvUtils.ts#L7)
+
+Marker function for environment strings.
+
+It behaves like a normal template literal but allows you to
+later search/grep all `env` usages in the codebase.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `strings` | `TemplateStringsArray` |
+| ...`values` | `unknown`[] |
+
+## Returns
+
+`string`

package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md

@@ -0,0 +1,26 @@
+---
+title: 'Function: getMimeTypeByFileNameOrExtension()'
+generated: true
+editUrl: false
+---
+# Function: getMimeTypeByFileNameOrExtension()
+
+```ts
+function getMimeTypeByFileNameOrExtension(...args): string | false;
+```
+
+Defined in: [mime/mimeTypes.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mime/mimeTypes.ts#L14)
+
+Get MIME type by file name or extension.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| ...`args` | \[`string`\] | Arguments for mime-types lookup |
+
+## Returns
+
+`string` \| `false`
+
+MIME type or false if not found

package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md

@@ -0,0 +1,27 @@
+---
+title: 'Function: isActionId()'
+generated: true
+editUrl: false
+---
+# Function: isActionId()
+
+```ts
+function isActionId(key, action): boolean;
+```
+
+Defined in: [sse/services/interfaces/ISseEventData.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/interfaces/ISseEventData.ts#L34)
+
+Checks if the action id is valid.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The key to check. |
+| `action` | `string` | The action to check. |
+
+## Returns
+
+`boolean`
+
+- Returns true if the action id is valid, false otherwise.

package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md

@@ -3,7 +3,6 @@ title: 'Interface: IBlobResourceStrategyConfig'
 generated: true
 editUrl: false
 ---
-
 # Interface: IBlobResourceStrategyConfig
 
 Defined in: [resources/strategies/BlobResourceStrategy.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L36)
@@ -25,5 +24,5 @@ Optional key prefix for blob storage.
 #### Example
 
 ```ts
-('resources/', 'templates/');
+'resources/', 'templates/'
 ```

package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md

@@ -3,7 +3,6 @@ title: 'Interface: IBlobServiceAdapter'
 generated: true
 editUrl: false
 ---
-
 # Interface: IBlobServiceAdapter
 
 Defined in: [resources/strategies/BlobResourceStrategy.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L14)
@@ -27,15 +26,15 @@ Downloads a file from blob storage.
 
 #### Parameters
 
-| Parameter | Type     | Description  |
-| --------- | -------- | ------------ |
-| `key`     | `string` | The blob key |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The blob key |
 
 #### Returns
 
 `Promise`\<\{
-`contentType?`: `string`;
-`data`: `unknown`;
+  `contentType?`: `string`;
+  `data`: `unknown`;
 \}\>
 
 The download result

package/data/packages/platform-core/api/Interface.ICacheMetricsRecorder.md

@@ -3,7 +3,6 @@ title: 'Interface: ICacheMetricsRecorder'
 generated: true
 editUrl: false
 ---
-
 # Interface: ICacheMetricsRecorder
 
 Defined in: [cache/ICacheMetricsRecorder.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheMetricsRecorder.ts#L6)
@@ -24,15 +23,15 @@ Records a cache eviction.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cache` | `string` | The cache name/label |
 
 #### Returns
 
 `void`
 
----
+***
 
 ### recordHit()
 
@@ -46,15 +45,15 @@ Records a cache hit.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cache` | `string` | The cache name/label |
 
 #### Returns
 
 `void`
 
----
+***
 
 ### recordLoadError()
 
@@ -68,15 +67,15 @@ Records a failed cache load.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cache` | `string` | The cache name/label |
 
 #### Returns
 
 `void`
 
----
+***
 
 ### recordLoadSuccess()
 
@@ -90,15 +89,15 @@ Records a successful cache load.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cache` | `string` | The cache name/label |
 
 #### Returns
 
 `void`
 
----
+***
 
 ### recordMiss()
 
@@ -112,9 +111,9 @@ Records a cache miss.
 
 #### Parameters
 
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `cache`   | `string` | The cache name/label |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `cache` | `string` | The cache name/label |
 
 #### Returns