@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,43 @@
+---
+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)
+
+Represents the `SseModule` class.
+
+## Constructors
+
+### Constructor
+
+```ts
+new SseModule(): SseModule;
+```
+
+#### Returns
+
+`SseModule`
+
+## Methods
+
+### register()
+
+```ts
+static register(config): DynamicModule;
+```
+
+Defined in: [sse/SseModule.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/SseModule.ts#L45)
+
+#### Parameters
+
+| Parameter | Type               |
+| --------- | ------------------ |
+| `config`  | `ISseModuleConfig` |
+
+#### Returns
+
+`DynamicModule`

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

@@ -0,0 +1,43 @@
+---
+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)
+
+The base class for all time stamp responses.
+
+## Constructors
+
+### Constructor
+
+```ts
+new TimeStampResponse(): TimeStampResponse;
+```
+
+#### Returns
+
+`TimeStampResponse`
+
+## Properties
+
+### createdAt
+
+```ts
+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
+
+```ts
+updatedAt: Date;
+```
+
+Defined in: [models/response/TimeStampResponse.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/TimeStampResponse.ts#L32)

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

@@ -0,0 +1,58 @@
+---
+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)
+
+Thrown when a type mapping is requested but not registered.
+
+## Extends
+
+- `MappingError`
+
+## Constructors
+
+### Constructor
+
+```ts
+new TypeMappingNotRegisteredError(source, destination): TypeMappingNotRegisteredError;
+```
+
+Defined in: [mapping/errors/TypeMappingNotRegisteredError.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/errors/TypeMappingNotRegisteredError.ts#L16)
+
+#### Parameters
+
+| Parameter     | Type     |
+| ------------- | -------- |
+| `source`      | `string` |
+| `destination` | `string` |
+
+#### Returns
+
+`TypeMappingNotRegisteredError`
+
+#### Overrides
+
+```ts
+MappingError.constructor;
+```
+
+## Properties
+
+### code
+
+```ts
+readonly code: string;
+```
+
+Defined in: [mapping/errors/MappingError.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/errors/MappingError.ts#L11)
+
+#### Inherited from
+
+```ts
+MappingError.code;
+```

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

@@ -0,0 +1,86 @@
+---
+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)
+
+UUID Generator class
+
+## Extends
+
+- [`IdGeneratorBase`](Class.IdGeneratorBase)
+
+## Constructors
+
+### Constructor
+
+```ts
+new UUIDGenerator(): UUIDGenerator;
+```
+
+#### Returns
+
+`UUIDGenerator`
+
+#### Inherited from
+
+[`IdGeneratorBase`](Class.IdGeneratorBase).[`constructor`](Class.IdGeneratorBase#constructor)
+
+## Methods
+
+### generate()
+
+```ts
+generate(prefix?, postfix?): string;
+```
+
+Defined in: [identifiers/generators/UUIDGenerator.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/UUIDGenerator.ts#L23)
+
+Generates a version 4 UUID (random-based)
+
+#### Parameters
+
+| Parameter  | Type     | Description                          |
+| ---------- | -------- | ------------------------------------ |
+| `prefix?`  | `string` | Optional prefix to prepend to the ID |
+| `postfix?` | `string` | Optional postfix to append to the ID |
+
+#### Returns
+
+`string`
+
+#### Overrides
+
+[`IdGeneratorBase`](Class.IdGeneratorBase).[`generate`](Class.IdGeneratorBase#generate)
+
+---
+
+### isValid()
+
+```ts
+isValid(id): boolean;
+```
+
+Defined in: [identifiers/generators/UUIDGenerator.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/UUIDGenerator.ts#L39)
+
+Validates if the provided string is a valid UUID (version 4)
+
+#### Parameters
+
+| Parameter | Type     | Description        |
+| --------- | -------- | ------------------ |
+| `id`      | `string` | The ID to validate |
+
+#### Returns
+
+`boolean`
+
+True if the ID is valid, otherwise false
+
+#### Overrides
+
+[`IdGeneratorBase`](Class.IdGeneratorBase).[`isValid`](Class.IdGeneratorBase#isvalid)

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

@@ -0,0 +1,48 @@
+---
+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)
+
+Service for generating GitHub-style identicon avatars.
+
+## Constructors
+
+### Constructor
+
+```ts
+new UserAvatarGeneratorService(): UserAvatarGeneratorService;
+```
+
+#### Returns
+
+`UserAvatarGeneratorService`
+
+## Methods
+
+### generate()
+
+```ts
+generate(width?, height?): Promise<string>;
+```
+
+Defined in: [services/UserAvatarGenerator.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/UserAvatarGenerator.ts#L32)
+
+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) |
+
+#### Returns
+
+`Promise`\<`string`\>
+
+Base64-encoded PNG image string

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

@@ -0,0 +1,65 @@
+---
+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)
+
+Random user name generator class
+
+## Constructors
+
+### Constructor
+
+```ts
+new UserNameGeneratorService(): UserNameGeneratorService;
+```
+
+#### Returns
+
+`UserNameGeneratorService`
+
+## Methods
+
+### generate()
+
+```ts
+generate(useNumbers?): string;
+```
+
+Defined in: [services/UsernameGeneratorService.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/UsernameGeneratorService.ts#L36)
+
+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 |
+
+#### Returns
+
+`string`
+
+A randomly generated user name
+
+---
+
+### generateSecure()
+
+```ts
+generateSecure(): string;
+```
+
+Defined in: [services/UsernameGeneratorService.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/UsernameGeneratorService.ts#L49)
+
+Generates a random user name using secure random bytes.
+
+#### Returns
+
+`string`
+
+A cryptographically secure random user name

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

@@ -0,0 +1,29 @@
+---
+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)
+
+Configuration for the blob resource strategy.
+
+## Properties
+
+### keyPrefix?
+
+```ts
+optional keyPrefix?: string;
+```
+
+Defined in: [resources/strategies/BlobResourceStrategy.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L42)
+
+Optional key prefix for blob storage.
+
+#### Example
+
+```ts
+('resources/', 'templates/');
+```

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

@@ -0,0 +1,41 @@
+---
+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)
+
+Minimal blob service interface to avoid circular dependencies.
+
+## Methods
+
+### downloadFile()
+
+```ts
+downloadFile(key): Promise<{
+  contentType?: string;
+  data: unknown;
+}>;
+```
+
+Defined in: [resources/strategies/BlobResourceStrategy.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L22)
+
+Downloads a file from blob storage.
+
+#### Parameters
+
+| Parameter | Type     | Description  |
+| --------- | -------- | ------------ |
+| `key`     | `string` | The blob key |
+
+#### Returns
+
+`Promise`\<\{
+`contentType?`: `string`;
+`data`: `unknown`;
+\}\>
+
+The download result

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

@@ -0,0 +1,121 @@
+---
+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)
+
+Metrics recorder for cache operations. Implementations can forward to Prometheus, OpenTelemetry, etc.
+
+## Methods
+
+### recordEviction()?
+
+```ts
+optional recordEviction(cache): void;
+```
+
+Defined in: [cache/ICacheMetricsRecorder.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheMetricsRecorder.ts#L48)
+
+Records a cache eviction.
+
+#### Parameters
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `cache`   | `string` | The cache name/label |
+
+#### Returns
+
+`void`
+
+---
+
+### recordHit()
+
+```ts
+recordHit(cache): void;
+```
+
+Defined in: [cache/ICacheMetricsRecorder.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheMetricsRecorder.ts#L16)
+
+Records a cache hit.
+
+#### Parameters
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `cache`   | `string` | The cache name/label |
+
+#### Returns
+
+`void`
+
+---
+
+### recordLoadError()
+
+```ts
+recordLoadError(cache): void;
+```
+
+Defined in: [cache/ICacheMetricsRecorder.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheMetricsRecorder.ts#L40)
+
+Records a failed cache load.
+
+#### Parameters
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `cache`   | `string` | The cache name/label |
+
+#### Returns
+
+`void`
+
+---
+
+### recordLoadSuccess()
+
+```ts
+recordLoadSuccess(cache): void;
+```
+
+Defined in: [cache/ICacheMetricsRecorder.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheMetricsRecorder.ts#L32)
+
+Records a successful cache load.
+
+#### Parameters
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `cache`   | `string` | The cache name/label |
+
+#### Returns
+
+`void`
+
+---
+
+### recordMiss()
+
+```ts
+recordMiss(cache): void;
+```
+
+Defined in: [cache/ICacheMetricsRecorder.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheMetricsRecorder.ts#L24)
+
+Records a cache miss.
+
+#### Parameters
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `cache`   | `string` | The cache name/label |
+
+#### Returns
+
+`void`

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

@@ -0,0 +1,71 @@
+---
+title: 'Interface: ICacheStats'
+generated: true
+editUrl: false
+---
+
+# Interface: ICacheStats
+
+Defined in: [cache/ICacheStats.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheStats.ts#L6)
+
+Cache statistics.
+
+## Properties
+
+### evictions?
+
+```ts
+optional evictions?: number;
+```
+
+Defined in: [cache/ICacheStats.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheStats.ts#L42)
+
+Number of cache evictions (if supported).
+
+---
+
+### hits
+
+```ts
+hits: number;
+```
+
+Defined in: [cache/ICacheStats.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheStats.ts#L14)
+
+Number of cache hits.
+
+---
+
+### loadErrors
+
+```ts
+loadErrors: number;
+```
+
+Defined in: [cache/ICacheStats.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheStats.ts#L35)
+
+Number of failed cache loads.
+
+---
+
+### loads
+
+```ts
+loads: number;
+```
+
+Defined in: [cache/ICacheStats.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheStats.ts#L28)
+
+Number of successful cache loads.
+
+---
+
+### misses
+
+```ts
+misses: number;
+```
+
+Defined in: [cache/ICacheStats.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ICacheStats.ts#L21)
+
+Number of cache misses.

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

@@ -0,0 +1,64 @@
+---
+title: 'Interface: IConfigKey\<TType\>'
+generated: true
+editUrl: false
+---
+
+# Interface: IConfigKey\<TType\>
+
+Defined in: [config/ConfigKey.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigKey.ts#L27)
+
+A type-safe config key that encodes both the config key and the type of its value.
+
+**Why this exists**: In large codebases it is common for configuration values
+(environment variables, feature flags, constants) to be accessed directly via
+raw strings or via `process.env['SOME_KEY']`. This leads to several issues:
+• scattered literal strings making refactoring and discovery difficult,
+• lack of compile-time checking for correct key names,
+• no guarantee about the type of the value retrieved (string, number, boolean, etc),
+• difficulty enforcing a consistent mechanism for configuration access.
+
+To address these, we introduce a **typed config-key abstraction**:
+– each config key is defined once (via createConfigKey),
+– the `IConfigKey<TType>` carries at compile time the expected type of its value,
+– the runtime shape remains minimal (just a `key: string`),
+– developers are encouraged to use a central `ConfigService` to fetch values,
+rather than scattering `process.env[...]` everywhere.
+
+This improves:
+– discoverability (IDE autocomplete, “find usages” works),
+– safety (correct key names, correct value types),
+– maintainability (single source of truth for config keys),
+– clarity (developers see intent: “this key returns a number”, “this key returns a boolean”).
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| -------------- | ------------ |
+| `TType`        | `unknown`    |
+
+## Properties
+
+### \_type?
+
+```ts
+readonly optional _type?: TType;
+```
+
+Defined in: [config/ConfigKey.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigKey.ts#L33)
+
+Phantom generic to encode the expected value type. This property
+is never intended to be used at runtime.
+
+---
+
+### key
+
+```ts
+readonly key: string;
+```
+
+Defined in: [config/ConfigKey.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigKey.ts#L39)
+
+The unique string identifier for the configuration entry.
+This typically corresponds to an environment variable name or config store key.