@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,251 @@
+---
+title: 'Class: MemoryLayeredCache\<TKey, TValue\>'
+generated: true
+editUrl: false
+---
+
+# Class: MemoryLayeredCache\<TKey, TValue\>
+
+Defined in: [cache/MemoryLayeredCache.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L66)
+
+In-memory layered cache implementation.
+
+## Type Parameters
+
+| Type Parameter | Description                   |
+| -------------- | ----------------------------- |
+| `TKey`         | The type of the cache keys.   |
+| `TValue`       | The type of the cache values. |
+
+## Implements
+
+- [`ILayeredCache`](Interface.ILayeredCache)\<`TKey`, `TValue`\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new MemoryLayeredCache<TKey, TValue>(loadFn, options?): MemoryLayeredCache<TKey, TValue>;
+```
+
+Defined in: [cache/MemoryLayeredCache.ts:87](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L87)
+
+#### Parameters
+
+| Parameter  | Type                                                     |
+| ---------- | -------------------------------------------------------- |
+| `loadFn`   | (`key`) => `Promise`\<`TValue` \| `undefined`\>          |
+| `options?` | [`ILayeredCacheOptions`](Interface.ILayeredCacheOptions) |
+
+#### Returns
+
+`MemoryLayeredCache`\<`TKey`, `TValue`\>
+
+## Methods
+
+### get()
+
+```ts
+get(key): TValue | undefined;
+```
+
+Defined in: [cache/MemoryLayeredCache.ts:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L107)
+
+Retrieves a value from the cache.
+
+#### Parameters
+
+| Parameter | Type   | Description          |
+| --------- | ------ | -------------------- |
+| `key`     | `TKey` | The key to retrieve. |
+
+#### Returns
+
+`TValue` \| `undefined`
+
+#### Implementation of
+
+[`ILayeredCache`](Interface.ILayeredCache).[`get`](Interface.ILayeredCache#get)
+
+---
+
+### getAsync()
+
+```ts
+getAsync(key): Promise<TValue | undefined>;
+```
+
+Defined in: [cache/MemoryLayeredCache.ts:133](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L133)
+
+Retrieves a value from the cache (asynchronous).
+
+#### Parameters
+
+| Parameter | Type   | Description          |
+| --------- | ------ | -------------------- |
+| `key`     | `TKey` | The key to retrieve. |
+
+#### Returns
+
+`Promise`\<`TValue` \| `undefined`\>
+
+#### Implementation of
+
+[`ILayeredCache`](Interface.ILayeredCache).[`getAsync`](Interface.ILayeredCache#getasync)
+
+---
+
+### invalidate()
+
+```ts
+invalidate(key): void;
+```
+
+Defined in: [cache/MemoryLayeredCache.ts:193](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L193)
+
+Invalidates a key in the cache.
+
+#### Parameters
+
+| Parameter | Type   | Description            |
+| --------- | ------ | ---------------------- |
+| `key`     | `TKey` | The key to invalidate. |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`ILayeredCache`](Interface.ILayeredCache).[`invalidate`](Interface.ILayeredCache#invalidate)
+
+---
+
+### invalidateAsync()
+
+```ts
+invalidateAsync(key): Promise<void>;
+```
+
+Defined in: [cache/MemoryLayeredCache.ts:203](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L203)
+
+Invalidates a key in the cache (asynchronous).
+
+#### Parameters
+
+| Parameter | Type   | Description            |
+| --------- | ------ | ---------------------- |
+| `key`     | `TKey` | The key to invalidate. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+[`ILayeredCache`](Interface.ILayeredCache).[`invalidateAsync`](Interface.ILayeredCache#invalidateasync)
+
+---
+
+### set()
+
+```ts
+set(key, value): void;
+```
+
+Defined in: [cache/MemoryLayeredCache.ts:161](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L161)
+
+Sets a value in the cache.
+
+#### Parameters
+
+| Parameter | Type     | Description       |
+| --------- | -------- | ----------------- |
+| `key`     | `TKey`   | The key to set.   |
+| `value`   | `TValue` | The value to set. |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`ILayeredCache`](Interface.ILayeredCache).[`set`](Interface.ILayeredCache#set)
+
+---
+
+### setAsync()
+
+```ts
+setAsync(key, value): Promise<void>;
+```
+
+Defined in: [cache/MemoryLayeredCache.ts:175](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L175)
+
+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`\>
+
+#### Implementation of
+
+[`ILayeredCache`](Interface.ILayeredCache).[`setAsync`](Interface.ILayeredCache#setasync)
+
+---
+
+### stats()
+
+```ts
+stats(): ICacheStats;
+```
+
+Defined in: [cache/MemoryLayeredCache.ts:207](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L207)
+
+Retrieves cache statistics.
+
+#### Returns
+
+[`ICacheStats`](Interface.ICacheStats)
+
+The cache statistics.
+
+#### Implementation of
+
+[`ILayeredCache`](Interface.ILayeredCache).[`stats`](Interface.ILayeredCache#stats)
+
+---
+
+### warm()
+
+```ts
+warm(key): Promise<TValue | undefined>;
+```
+
+Defined in: [cache/MemoryLayeredCache.ts:182](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/MemoryLayeredCache.ts#L182)
+
+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.
+
+#### Implementation of
+
+[`ILayeredCache`](Interface.ILayeredCache).[`warm`](Interface.ILayeredCache#warm)

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

@@ -0,0 +1,157 @@
+---
+title: 'Class: NoopCacheMetricsRecorder'
+generated: true
+editUrl: false
+---
+
+# Class: NoopCacheMetricsRecorder
+
+Defined in: [cache/NoopCacheMetricsRecorder.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/NoopCacheMetricsRecorder.ts#L12)
+
+No-op implementation used when no metrics backend is configured.
+
+## Implements
+
+- [`ICacheMetricsRecorder`](Interface.ICacheMetricsRecorder)
+
+## Constructors
+
+### Constructor
+
+```ts
+new NoopCacheMetricsRecorder(): NoopCacheMetricsRecorder;
+```
+
+#### Returns
+
+`NoopCacheMetricsRecorder`
+
+## Methods
+
+### recordEviction()?
+
+```ts
+optional recordEviction(_cache): void;
+```
+
+Defined in: [cache/NoopCacheMetricsRecorder.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/NoopCacheMetricsRecorder.ts#L62)
+
+Records a cache eviction.
+
+#### Parameters
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `_cache`  | `string` | The cache name/label |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`ICacheMetricsRecorder`](Interface.ICacheMetricsRecorder).[`recordEviction`](Interface.ICacheMetricsRecorder#recordeviction)
+
+---
+
+### recordHit()
+
+```ts
+recordHit(_cache): void;
+```
+
+Defined in: [cache/NoopCacheMetricsRecorder.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/NoopCacheMetricsRecorder.ts#L22)
+
+Records a cache hit.
+
+#### Parameters
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `_cache`  | `string` | The cache name/label |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`ICacheMetricsRecorder`](Interface.ICacheMetricsRecorder).[`recordHit`](Interface.ICacheMetricsRecorder#recordhit)
+
+---
+
+### recordLoadError()
+
+```ts
+recordLoadError(_cache): void;
+```
+
+Defined in: [cache/NoopCacheMetricsRecorder.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/NoopCacheMetricsRecorder.ts#L52)
+
+Records a failed cache load.
+
+#### Parameters
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `_cache`  | `string` | The cache name/label |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`ICacheMetricsRecorder`](Interface.ICacheMetricsRecorder).[`recordLoadError`](Interface.ICacheMetricsRecorder#recordloaderror)
+
+---
+
+### recordLoadSuccess()
+
+```ts
+recordLoadSuccess(_cache): void;
+```
+
+Defined in: [cache/NoopCacheMetricsRecorder.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/NoopCacheMetricsRecorder.ts#L42)
+
+Records a successful cache load.
+
+#### Parameters
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `_cache`  | `string` | The cache name/label |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`ICacheMetricsRecorder`](Interface.ICacheMetricsRecorder).[`recordLoadSuccess`](Interface.ICacheMetricsRecorder#recordloadsuccess)
+
+---
+
+### recordMiss()
+
+```ts
+recordMiss(_cache): void;
+```
+
+Defined in: [cache/NoopCacheMetricsRecorder.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/NoopCacheMetricsRecorder.ts#L32)
+
+Records a cache miss.
+
+#### Parameters
+
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `_cache`  | `string` | The cache name/label |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`ICacheMetricsRecorder`](Interface.ICacheMetricsRecorder).[`recordMiss`](Interface.ICacheMetricsRecorder#recordmiss)

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

@@ -0,0 +1,149 @@
+---
+title: 'Class: NormalizedUtils'
+generated: true
+editUrl: false
+---
+
+# Class: NormalizedUtils
+
+Defined in: [utils/NormalizedUtils.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/NormalizedUtils.ts#L7)
+
+Utility functions for normalizing data.
+
+## Constructors
+
+### Constructor
+
+```ts
+new NormalizedUtils(): NormalizedUtils;
+```
+
+#### Returns
+
+`NormalizedUtils`
+
+## Methods
+
+### normalizeArray()
+
+```ts
+static normalizeArray<T>(values?): T[] | undefined;
+```
+
+Defined in: [utils/NormalizedUtils.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/NormalizedUtils.ts#L25)
+
+Normalize an array by removing duplicates.
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+
+#### Parameters
+
+| Parameter | Type  | Description             |
+| --------- | ----- | ----------------------- |
+| `values?` | `T`[] | The array to normalize. |
+
+#### Returns
+
+`T`[] \| `undefined`
+
+The normalized array.
+
+---
+
+### normalizeBoolean()
+
+```ts
+static normalizeBoolean(value?): boolean | undefined;
+```
+
+Defined in: [utils/NormalizedUtils.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/NormalizedUtils.ts#L69)
+
+Normalize a boolean value.
+
+#### Parameters
+
+| Parameter | Type      | Description                     |
+| --------- | --------- | ------------------------------- |
+| `value?`  | `boolean` | The boolean value to normalize. |
+
+#### Returns
+
+`boolean` \| `undefined`
+
+The normalized boolean value.
+
+---
+
+### normalizeDate()
+
+```ts
+static normalizeDate(value?): Date | undefined;
+```
+
+Defined in: [utils/NormalizedUtils.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/NormalizedUtils.ts#L55)
+
+Normalize a date by ensuring it is a valid date object.
+
+#### Parameters
+
+| Parameter | Type   | Description            |
+| --------- | ------ | ---------------------- |
+| `value?`  | `Date` | The date to normalize. |
+
+#### Returns
+
+`Date` \| `undefined`
+
+The normalized date.
+
+---
+
+### normalizeNumber()
+
+```ts
+static normalizeNumber(value?): number | undefined;
+```
+
+Defined in: [utils/NormalizedUtils.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/NormalizedUtils.ts#L41)
+
+Normalize a number by ensuring it is non-negative.
+
+#### Parameters
+
+| Parameter | Type     | Description              |
+| --------- | -------- | ------------------------ |
+| `value?`  | `number` | The number to normalize. |
+
+#### Returns
+
+`number` \| `undefined`
+
+The normalized number.
+
+---
+
+### normalizeString()
+
+```ts
+static normalizeString(value?): string | undefined;
+```
+
+Defined in: [utils/NormalizedUtils.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/NormalizedUtils.ts#L15)
+
+Normalize a search query by trimming whitespace and converting to lowercase.
+
+#### Parameters
+
+| Parameter | Type     | Description                    |
+| --------- | -------- | ------------------------------ |
+| `value?`  | `string` | The search query to normalize. |
+
+#### Returns
+
+`string` \| `undefined`
+
+The normalized search query.

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

@@ -0,0 +1,106 @@
+---
+title: 'Class: OtpService'
+generated: true
+editUrl: false
+---
+
+# Class: OtpService
+
+Defined in: [services/OtpService.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/OtpService.ts#L42)
+
+OTP service implementation backed by otplib v13.
+
+Wraps the otplib standalone functions behind the generic
+[IOtpService](Interface.IOtpService) interface so consumers are decoupled from
+the library version.
+
+## Implements
+
+- [`IOtpService`](Interface.IOtpService)
+
+## Constructors
+
+### Constructor
+
+```ts
+new OtpService(): OtpService;
+```
+
+#### Returns
+
+`OtpService`
+
+## Methods
+
+### generateSecret()
+
+```ts
+generateSecret(): string;
+```
+
+Defined in: [services/OtpService.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/OtpService.ts#L46)
+
+Generates a cryptographically random secret suitable for TOTP.
+
+#### Returns
+
+`string`
+
+#### Implementation of
+
+[`IOtpService`](Interface.IOtpService).[`generateSecret`](Interface.IOtpService#generatesecret)
+
+---
+
+### generateUri()
+
+```ts
+generateUri(options): string;
+```
+
+Defined in: [services/OtpService.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/OtpService.ts#L51)
+
+Generates an `otpauth://` URI for QR code enrollment.
+
+#### Parameters
+
+| Parameter | Type                                         | Description                 |
+| --------- | -------------------------------------------- | --------------------------- |
+| `options` | [`IOtpUriOptions`](Interface.IOtpUriOptions) | The URI generation options. |
+
+#### Returns
+
+`string`
+
+#### Implementation of
+
+[`IOtpService`](Interface.IOtpService).[`generateUri`](Interface.IOtpService#generateuri)
+
+---
+
+### verify()
+
+```ts
+verify(token, secret): boolean;
+```
+
+Defined in: [services/OtpService.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/OtpService.ts#L56)
+
+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.
+
+#### Implementation of
+
+[`IOtpService`](Interface.IOtpService).[`verify`](Interface.IOtpService#verify)

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

@@ -0,0 +1,43 @@
+---
+title: 'Abstract Class: PageableRequest'
+generated: true
+editUrl: false
+---
+
+# Abstract Class: PageableRequest
+
+Defined in: [models/requests/PageableRequest.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/requests/PageableRequest.ts#L15)
+
+Base class describing pagination query parameters shared across endpoints.
+
+## Constructors
+
+### Constructor
+
+```ts
+new PageableRequest(): PageableRequest;
+```
+
+#### Returns
+
+`PageableRequest`
+
+## Properties
+
+### skip?
+
+```ts
+optional skip?: number;
+```
+
+Defined in: [models/requests/PageableRequest.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/requests/PageableRequest.ts#L26)
+
+---
+
+### take?
+
+```ts
+optional take?: number;
+```
+
+Defined in: [models/requests/PageableRequest.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/requests/PageableRequest.ts#L34)