@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,194 @@
+---
+title: 'Interface: ILayeredCache\<TKey, TValue\>'
+generated: true
+editUrl: false
+---
+
+# Interface: ILayeredCache\<TKey, TValue\>
+
+Defined in: [cache/ILayeredCache.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L14)
+
+Generic layered cache contract (DB first, then memory, then external fetcher).
+
+## Type Parameters
+
+| Type Parameter | Description                   |
+| -------------- | ----------------------------- |
+| `TKey`         | The type of the cache keys.   |
+| `TValue`       | The type of the cache values. |
+
+## Methods
+
+### get()
+
+```ts
+get(key): TValue | undefined;
+```
+
+Defined in: [cache/ILayeredCache.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L24)
+
+Retrieves a value from the cache.
+
+#### Parameters
+
+| Parameter | Type   | Description          |
+| --------- | ------ | -------------------- |
+| `key`     | `TKey` | The key to retrieve. |
+
+#### Returns
+
+`TValue` \| `undefined`
+
+---
+
+### getAsync()
+
+```ts
+getAsync(key): Promise<TValue | undefined>;
+```
+
+Defined in: [cache/ILayeredCache.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L32)
+
+Retrieves a value from the cache (asynchronous).
+
+#### Parameters
+
+| Parameter | Type   | Description          |
+| --------- | ------ | -------------------- |
+| `key`     | `TKey` | The key to retrieve. |
+
+#### Returns
+
+`Promise`\<`TValue` \| `undefined`\>
+
+---
+
+### invalidate()
+
+```ts
+invalidate(key): void;
+```
+
+Defined in: [cache/ILayeredCache.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L67)
+
+Invalidates a key in the cache.
+
+#### Parameters
+
+| Parameter | Type   | Description            |
+| --------- | ------ | ---------------------- |
+| `key`     | `TKey` | The key to invalidate. |
+
+#### Returns
+
+`void`
+
+---
+
+### invalidateAsync()
+
+```ts
+invalidateAsync(key): Promise<void>;
+```
+
+Defined in: [cache/ILayeredCache.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L75)
+
+Invalidates a key in the cache (asynchronous).
+
+#### Parameters
+
+| Parameter | Type   | Description            |
+| --------- | ------ | ---------------------- |
+| `key`     | `TKey` | The key to invalidate. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+---
+
+### set()
+
+```ts
+set(key, value): void;
+```
+
+Defined in: [cache/ILayeredCache.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L41)
+
+Sets a value in the cache.
+
+#### Parameters
+
+| Parameter | Type     | Description       |
+| --------- | -------- | ----------------- |
+| `key`     | `TKey`   | The key to set.   |
+| `value`   | `TValue` | The value to set. |
+
+#### Returns
+
+`void`
+
+---
+
+### setAsync()
+
+```ts
+setAsync(key, value): Promise<void>;
+```
+
+Defined in: [cache/ILayeredCache.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L50)
+
+Sets a value in the cache (asynchronous).
+
+#### Parameters
+
+| Parameter | Type     | Description       |
+| --------- | -------- | ----------------- |
+| `key`     | `TKey`   | The key to set.   |
+| `value`   | `TValue` | The value to set. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+---
+
+### stats()?
+
+```ts
+optional stats(): ICacheStats;
+```
+
+Defined in: [cache/ILayeredCache.ts:83](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L83)
+
+Retrieves cache statistics.
+
+#### Returns
+
+[`ICacheStats`](Interface.ICacheStats)
+
+The cache statistics.
+
+---
+
+### warm()?
+
+```ts
+optional warm(key): Promise<TValue | undefined>;
+```
+
+Defined in: [cache/ILayeredCache.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/ILayeredCache.ts#L59)
+
+Proactively warms the cache for a given key (optional).
+
+#### Parameters
+
+| Parameter | Type   | Description      |
+| --------- | ------ | ---------------- |
+| `key`     | `TKey` | The key to warm. |
+
+#### Returns
+
+`Promise`\<`TValue` \| `undefined`\>
+
+The value that was loaded and cached, or undefined if not found.

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

@@ -0,0 +1,71 @@
+---
+title: 'Interface: ILayeredCacheOptions'
+generated: true
+editUrl: false
+---
+
+# Interface: ILayeredCacheOptions
+
+Defined in: [cache/MemoryLayeredCache.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L16)
+
+In-memory layered cache: memory (LRU+TTL+SWR) + async loader fallback.
+
+## Properties
+
+### cacheName?
+
+```ts
+optional cacheName?: string;
+```
+
+Defined in: [cache/MemoryLayeredCache.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L53)
+
+An optional name/label for the cache, used in metrics (default: 'memory').
+
+---
+
+### maxEntries?
+
+```ts
+optional maxEntries?: number;
+```
+
+Defined in: [cache/MemoryLayeredCache.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L39)
+
+Maximum number of entries in the cache (optional, default: infinite).
+
+---
+
+### metricsRecorder?
+
+```ts
+optional metricsRecorder?: ICacheMetricsRecorder;
+```
+
+Defined in: [cache/MemoryLayeredCache.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L46)
+
+Metrics recorder for cache statistics (optional, default: NoopCacheMetricsRecorder).
+
+---
+
+### staleWhileRevalidate?
+
+```ts
+optional staleWhileRevalidate?: boolean;
+```
+
+Defined in: [cache/MemoryLayeredCache.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L32)
+
+Whether to serve stale content while revalidating (optional, default: false).
+
+---
+
+### ttlMs?
+
+```ts
+optional ttlMs?: number;
+```
+
+Defined in: [cache/MemoryLayeredCache.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L25)
+
+Time to live in milliseconds (optional, default: infinite).

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

@@ -0,0 +1,77 @@
+---
+title: 'Interface: IMappingBuilder'
+generated: true
+editUrl: false
+---
+
+# Interface: IMappingBuilder
+
+Defined in: [mapping/builder/interfaces/IMappingBuilder.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/builder/interfaces/IMappingBuilder.ts#L18)
+
+Defines the interface for a mapping builder.
+
+## Methods
+
+### createKeyedMap()
+
+```ts
+createKeyedMap<TInput, TOutput>(key, fn): this;
+```
+
+Defined in: [mapping/builder/interfaces/IMappingBuilder.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/builder/interfaces/IMappingBuilder.ts#L45)
+
+Creates a keyed mapping between two types with full type safety.
+The mapping key encodes both input and output types at compile time.
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `TInput`       |
+| `TOutput`      |
+
+#### Parameters
+
+| Parameter | Type                                                                 | Description                                                |
+| --------- | -------------------------------------------------------------------- | ---------------------------------------------------------- |
+| `key`     | [`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\>        | The type-safe mapping key.                                 |
+| `fn`      | (`source`) => `MappingCompatible`\<`TInput`, `TOutput`\> & `TOutput` | The mapping function that must return a valid destination. |
+
+#### Returns
+
+`this`
+
+---
+
+### createMap()
+
+```ts
+createMap<TSource, TDestination>(
+   source,
+   destination,
+   fn): this;
+```
+
+Defined in: [mapping/builder/interfaces/IMappingBuilder.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/builder/interfaces/IMappingBuilder.ts#L31)
+
+Creates a mapping between two types.
+Ensures compile-time type compatibility between source and destination.
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `TSource`      |
+| `TDestination` |
+
+#### Parameters
+
+| Parameter     | Type                                                                            | Description                                                |
+| ------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------- |
+| `source`      | `Constructor`\<`TSource`\>                                                      | The source type.                                           |
+| `destination` | `Constructor`\<`TDestination`\>                                                 | The destination type.                                      |
+| `fn`          | (`source`) => `MappingCompatible`\<`TSource`, `TDestination`\> & `TDestination` | The mapping function that must return a valid destination. |
+
+#### Returns
+
+`this`

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

@@ -0,0 +1,59 @@
+---
+title: 'Interface: IMappingKey\<TInput, TOutput\>'
+generated: true
+editUrl: false
+---
+
+# Interface: IMappingKey\<TInput, TOutput\>
+
+Defined in: [mapping/types/MappingKey.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L9)
+
+Type-safe mapping key that encodes both input and output types.
+This ensures compile-time type safety when using the mapping service.
+
+## Type Parameters
+
+| Type Parameter | Description                      |
+| -------------- | -------------------------------- |
+| `TInput`       | The input type for the mapping.  |
+| `TOutput`      | The output type for the mapping. |
+
+## Properties
+
+### \_brand
+
+```ts
+readonly _brand: "MappingKey";
+```
+
+Defined in: [mapping/types/MappingKey.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L10)
+
+---
+
+### \_input
+
+```ts
+readonly _input: TInput;
+```
+
+Defined in: [mapping/types/MappingKey.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L11)
+
+---
+
+### \_output
+
+```ts
+readonly _output: TOutput;
+```
+
+Defined in: [mapping/types/MappingKey.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L12)
+
+---
+
+### key
+
+```ts
+readonly key: string;
+```
+
+Defined in: [mapping/types/MappingKey.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L13)

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

@@ -0,0 +1,33 @@
+---
+title: 'Interface: IMappingProfile'
+generated: true
+editUrl: false
+---
+
+# Interface: IMappingProfile
+
+Defined in: [mapping/profile/interfaces/IMappingProfile.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/profile/interfaces/IMappingProfile.ts#L12)
+
+Defines the interface for a mapping profile.
+
+## Methods
+
+### configure()
+
+```ts
+configure(builder): void;
+```
+
+Defined in: [mapping/profile/interfaces/IMappingProfile.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/profile/interfaces/IMappingProfile.ts#L22)
+
+Configures the mapping profile.
+
+#### Parameters
+
+| Parameter | Type                                           | Description          |
+| --------- | ---------------------------------------------- | -------------------- |
+| `builder` | [`IMappingBuilder`](Interface.IMappingBuilder) | The mapping builder. |
+
+#### Returns
+
+`void`

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

@@ -0,0 +1,78 @@
+---
+title: 'Interface: IOtpService'
+generated: true
+editUrl: false
+---
+
+# Interface: IOtpService
+
+Defined in: [services/IOtpService.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/IOtpService.ts#L33)
+
+Abstraction over OTP (One-Time Password) operations.
+
+Decouples consumers from any specific OTP library, making it easy
+to swap implementations (e.g. upgrading from otplib v12 to v13)
+without changing consumer code.
+
+## Methods
+
+### generateSecret()
+
+```ts
+generateSecret(): string;
+```
+
+Defined in: [services/IOtpService.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/IOtpService.ts#L38)
+
+Generates a cryptographically random secret suitable for TOTP.
+
+#### Returns
+
+`string`
+
+---
+
+### generateUri()
+
+```ts
+generateUri(options): string;
+```
+
+Defined in: [services/IOtpService.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/IOtpService.ts#L45)
+
+Generates an `otpauth://` URI for QR code enrollment.
+
+#### Parameters
+
+| Parameter | Type                                         | Description                 |
+| --------- | -------------------------------------------- | --------------------------- |
+| `options` | [`IOtpUriOptions`](Interface.IOtpUriOptions) | The URI generation options. |
+
+#### Returns
+
+`string`
+
+---
+
+### verify()
+
+```ts
+verify(token, secret): boolean;
+```
+
+Defined in: [services/IOtpService.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/IOtpService.ts#L54)
+
+Verifies a TOTP token against the given secret.
+
+#### Parameters
+
+| Parameter | Type     | Description                      |
+| --------- | -------- | -------------------------------- |
+| `token`   | `string` | The one-time password to verify. |
+| `secret`  | `string` | The shared secret.               |
+
+#### Returns
+
+`boolean`
+
+`true` if the token is valid within the configured tolerance window.

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

@@ -0,0 +1,47 @@
+---
+title: 'Interface: IOtpUriOptions'
+generated: true
+editUrl: false
+---
+
+# Interface: IOtpUriOptions
+
+Defined in: [services/IOtpService.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/IOtpService.ts#L6)
+
+Options for generating an OTP authentication URI (otpauth://).
+
+## Properties
+
+### issuer
+
+```ts
+readonly issuer: string;
+```
+
+Defined in: [services/IOtpService.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/IOtpService.ts#L11)
+
+The issuer name displayed in the authenticator app.
+
+---
+
+### label
+
+```ts
+readonly label: string;
+```
+
+Defined in: [services/IOtpService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/IOtpService.ts#L16)
+
+The account label (e.g. email or username) shown in the authenticator app.
+
+---
+
+### secret
+
+```ts
+readonly secret: string;
+```
+
+Defined in: [services/IOtpService.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/IOtpService.ts#L21)
+
+The shared secret used for TOTP generation.

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

@@ -0,0 +1,108 @@
+---
+title: 'Interface: IRedisLayeredCacheOptions\<TValue\>'
+generated: true
+editUrl: false
+---
+
+# Interface: IRedisLayeredCacheOptions\<TValue\>
+
+Defined in: [cache/RedisLayeredCache.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L16)
+
+Skeleton Redis-backed cache (placeholder; implement ioredis logic later).
+Provides same contract as in-memory layered cache; currently delegates to provided loader only.
+
+## Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `TValue`       |
+
+## Properties
+
+### cacheName?
+
+```ts
+optional cacheName?: string;
+```
+
+Defined in: [cache/RedisLayeredCache.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L23)
+
+---
+
+### deserialize?
+
+```ts
+optional deserialize?: (raw) => TValue;
+```
+
+Defined in: [cache/RedisLayeredCache.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L21)
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `raw`     | `string` |
+
+#### Returns
+
+`TValue`
+
+---
+
+### keyPrefix
+
+```ts
+keyPrefix: string;
+```
+
+Defined in: [cache/RedisLayeredCache.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L18)
+
+---
+
+### metricsRecorder?
+
+```ts
+optional metricsRecorder?: ICacheMetricsRecorder;
+```
+
+Defined in: [cache/RedisLayeredCache.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L22)
+
+---
+
+### serialize?
+
+```ts
+optional serialize?: (value) => string;
+```
+
+Defined in: [cache/RedisLayeredCache.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L20)
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `value`   | `TValue` |
+
+#### Returns
+
+`string`
+
+---
+
+### ttlSeconds?
+
+```ts
+optional ttlSeconds?: number;
+```
+
+Defined in: [cache/RedisLayeredCache.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L19)
+
+---
+
+### url
+
+```ts
+url: string;
+```
+
+Defined in: [cache/RedisLayeredCache.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L17)