@breadstone/archipel-mcp 0.0.2 → 0.0.4

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

@@ -3,6 +3,7 @@ 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)
@@ -49,7 +50,7 @@ Generates a cryptographically random secret suitable for TOTP.
 
 [`IOtpService`](Interface.IOtpService).[`generateSecret`](Interface.IOtpService#generatesecret)
 
-***
+---
 
 ### generateUri()
 
@@ -63,8 +64,8 @@ Generates an `otpauth://` URI for QR code enrollment.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
+| Parameter | Type                                         | Description                 |
+| --------- | -------------------------------------------- | --------------------------- |
 | `options` | [`IOtpUriOptions`](Interface.IOtpUriOptions) | The URI generation options. |
 
 #### Returns
@@ -75,7 +76,7 @@ Generates an `otpauth://` URI for QR code enrollment.
 
 [`IOtpService`](Interface.IOtpService).[`generateUri`](Interface.IOtpService#generateuri)
 
-***
+---
 
 ### verify()
 
@@ -89,10 +90,10 @@ 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. |
+| Parameter | Type     | Description                      |
+| --------- | -------- | -------------------------------- |
+| `token`   | `string` | The one-time password to verify. |
+| `secret`  | `string` | The shared secret.               |
 
 #### Returns
 

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

@@ -3,6 +3,7 @@ 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)
@@ -31,7 +32,7 @@ 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?
 

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

@@ -3,6 +3,7 @@ title: 'Abstract Class: PageableResponse'
 generated: true
 editUrl: false
 ---
+
 # Abstract Class: PageableResponse
 
 Defined in: [models/response/PageableResponse.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/PageableResponse.ts#L15)
@@ -31,7 +32,7 @@ abstract items: unknown[];
 
 Defined in: [models/response/PageableResponse.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/PageableResponse.ts#L53)
 
-***
+---
 
 ### skip?
 
@@ -41,7 +42,7 @@ optional skip?: number;
 
 Defined in: [models/response/PageableResponse.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/PageableResponse.ts#L35)
 
-***
+---
 
 ### take?
 
@@ -51,7 +52,7 @@ optional take?: number;
 
 Defined in: [models/response/PageableResponse.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/PageableResponse.ts#L44)
 
-***
+---
 
 ### total
 

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

@@ -3,6 +3,7 @@ title: 'Class: ProblemDetailException'
 generated: true
 editUrl: false
 ---
+
 # Class: ProblemDetailException
 
 Defined in: [filters/ProblemDetailExceptionFilter.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L27)
@@ -25,10 +26,10 @@ Defined in: [filters/ProblemDetailExceptionFilter.ts:28](https://github.com/RueD
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `responseCode` | `number` |
-| `args` | [`ProblemDetail`](TypeAlias.ProblemDetail) |
+| Parameter      | Type                                       |
+| -------------- | ------------------------------------------ |
+| `responseCode` | `number`                                   |
+| `args`         | [`ProblemDetail`](TypeAlias.ProblemDetail) |
 
 #### Returns
 
@@ -37,7 +38,7 @@ Defined in: [filters/ProblemDetailExceptionFilter.ts:28](https://github.com/RueD
 #### Overrides
 
 ```ts
-HttpException.constructor
+HttpException.constructor;
 ```
 
 ## Methods
@@ -57,5 +58,5 @@ Defined in: [filters/ProblemDetailExceptionFilter.ts:32](https://github.com/RueD
 #### Overrides
 
 ```ts
-HttpException.getResponse
+HttpException.getResponse;
 ```

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

@@ -3,6 +3,7 @@ title: 'Class: ProblemDetailExceptionFilter'
 generated: true
 editUrl: false
 ---
+
 # Class: ProblemDetailExceptionFilter
 
 Defined in: [filters/ProblemDetailExceptionFilter.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L44)
@@ -26,8 +27,8 @@ Defined in: [filters/ProblemDetailExceptionFilter.ts:54](https://github.com/RueD
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
+| Parameter      | Type                                                                     |
+| -------------- | ------------------------------------------------------------------------ |
 | `urlResolver?` | [`ProblemDetailTypeUrlResolver`](TypeAlias.ProblemDetailTypeUrlResolver) |
 
 #### Returns
@@ -58,10 +59,10 @@ Method to implement a custom exception filter.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `exception` | `Error` | the class of the exception being handled |
-| `host` | `ArgumentsHost` | used to access an array of arguments for the in-flight request |
+| Parameter   | Type            | Description                                                    |
+| ----------- | --------------- | -------------------------------------------------------------- |
+| `exception` | `Error`         | the class of the exception being handled                       |
+| `host`      | `ArgumentsHost` | used to access an array of arguments for the in-flight request |
 
 #### Returns
 
@@ -70,10 +71,10 @@ Method to implement a custom exception filter.
 #### Implementation of
 
 ```ts
-ExceptionFilter.catch
+ExceptionFilter.catch;
 ```
 
-***
+---
 
 ### setLogger()
 
@@ -85,9 +86,9 @@ Defined in: [filters/ProblemDetailExceptionFilter.ts:76](https://github.com/RueD
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `logger` | `LoggerService` |
+| Parameter | Type            |
+| --------- | --------------- |
+| `logger`  | `LoggerService` |
 
 #### Returns
 

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

@@ -3,6 +3,7 @@ title: 'Class: QuantityResponse'
 generated: true
 editUrl: false
 ---
+
 # Class: QuantityResponse
 
 Defined in: [models/response/QuantityResponse.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/QuantityResponse.ts#L14)
@@ -31,7 +32,7 @@ unit: string;
 
 Defined in: [models/response/QuantityResponse.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/QuantityResponse.ts#L22)
 
-***
+---
 
 ### value
 

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

@@ -3,6 +3,7 @@ title: 'Class: RedisLayeredCache\<TKey, TValue\>'
 generated: true
 editUrl: false
 ---
+
 # Class: RedisLayeredCache\<TKey, TValue\>
 
 Defined in: [cache/RedisLayeredCache.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L27)
@@ -11,10 +12,10 @@ 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. |
+| Type Parameter | Description                   |
+| -------------- | ----------------------------- |
+| `TKey`         | The type of the cache keys.   |
+| `TValue`       | The type of the cache values. |
 
 ## Implements
 
@@ -33,9 +34,9 @@ Defined in: [cache/RedisLayeredCache.ts:46](https://github.com/RueDeRennes/archi
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `loadFn` | (`key`) => `Promise`\<`TValue` \| `undefined`\> |
+| Parameter | Type                                                                           |
+| --------- | ------------------------------------------------------------------------------ |
+| `loadFn`  | (`key`) => `Promise`\<`TValue` \| `undefined`\>                                |
 | `options` | [`IRedisLayeredCacheOptions`](Interface.IRedisLayeredCacheOptions)\<`TValue`\> |
 
 #### Returns
@@ -57,9 +58,9 @@ Note: Redis is inherently async, so this throws an error.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `TKey` | The key to retrieve. |
+| Parameter | Type   | Description          |
+| --------- | ------ | -------------------- |
+| `key`     | `TKey` | The key to retrieve. |
 
 #### Returns
 
@@ -69,7 +70,7 @@ Note: Redis is inherently async, so this throws an error.
 
 [`ILayeredCache`](Interface.ILayeredCache).[`get`](Interface.ILayeredCache#get)
 
-***
+---
 
 ### getAsync()
 
@@ -83,9 +84,9 @@ Retrieves a value from the cache (asynchronous).
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `TKey` | The key to retrieve. |
+| Parameter | Type   | Description          |
+| --------- | ------ | -------------------- |
+| `key`     | `TKey` | The key to retrieve. |
 
 #### Returns
 
@@ -95,7 +96,7 @@ Retrieves a value from the cache (asynchronous).
 
 [`ILayeredCache`](Interface.ILayeredCache).[`getAsync`](Interface.ILayeredCache#getasync)
 
-***
+---
 
 ### invalidate()
 
@@ -110,9 +111,9 @@ Note: Redis is inherently async, so this throws an error.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `TKey` | The key to invalidate. |
+| Parameter | Type   | Description            |
+| --------- | ------ | ---------------------- |
+| `key`     | `TKey` | The key to invalidate. |
 
 #### Returns
 
@@ -122,7 +123,7 @@ Note: Redis is inherently async, so this throws an error.
 
 [`ILayeredCache`](Interface.ILayeredCache).[`invalidate`](Interface.ILayeredCache#invalidate)
 
-***
+---
 
 ### invalidateAsync()
 
@@ -136,9 +137,9 @@ Invalidates a key in the cache (asynchronous).
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `TKey` | The key to invalidate. |
+| Parameter | Type   | Description            |
+| --------- | ------ | ---------------------- |
+| `key`     | `TKey` | The key to invalidate. |
 
 #### Returns
 
@@ -148,7 +149,7 @@ Invalidates a key in the cache (asynchronous).
 
 [`ILayeredCache`](Interface.ILayeredCache).[`invalidateAsync`](Interface.ILayeredCache#invalidateasync)
 
-***
+---
 
 ### onModuleDestroy()
 
@@ -165,10 +166,10 @@ Defined in: [cache/RedisLayeredCache.ts:169](https://github.com/RueDeRennes/arch
 #### Implementation of
 
 ```ts
-OnModuleDestroy.onModuleDestroy
+OnModuleDestroy.onModuleDestroy;
 ```
 
-***
+---
 
 ### set()
 
@@ -183,10 +184,10 @@ Note: Redis is inherently async, so this throws an error.
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `TKey` | The key to set. |
-| `value` | `TValue` | The value to set. |
+| Parameter | Type     | Description       |
+| --------- | -------- | ----------------- |
+| `key`     | `TKey`   | The key to set.   |
+| `value`   | `TValue` | The value to set. |
 
 #### Returns
 
@@ -196,7 +197,7 @@ Note: Redis is inherently async, so this throws an error.
 
 [`ILayeredCache`](Interface.ILayeredCache).[`set`](Interface.ILayeredCache#set)
 
-***
+---
 
 ### setAsync()
 
@@ -210,10 +211,10 @@ Sets a value in the cache (asynchronous).
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `TKey` | The key to set. |
-| `value` | `TValue` | The value to set. |
+| Parameter | Type     | Description       |
+| --------- | -------- | ----------------- |
+| `key`     | `TKey`   | The key to set.   |
+| `value`   | `TValue` | The value to set. |
 
 #### Returns
 
@@ -223,7 +224,7 @@ Sets a value in the cache (asynchronous).
 
 [`ILayeredCache`](Interface.ILayeredCache).[`setAsync`](Interface.ILayeredCache#setasync)
 
-***
+---
 
 ### stats()
 
@@ -245,7 +246,7 @@ The cache statistics.
 
 [`ILayeredCache`](Interface.ILayeredCache).[`stats`](Interface.ILayeredCache#stats)
 
-***
+---
 
 ### warm()
 
@@ -259,9 +260,9 @@ Proactively warms the cache for a given key (optional).
 
 #### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `TKey` | The key to warm. |
+| Parameter | Type   | Description      |
+| --------- | ------ | ---------------- |
+| `key`     | `TKey` | The key to warm. |
 
 #### Returns