@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,63 @@
+---
+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)
+
+Base class describing pagination metadata returned alongside list payloads.
+
+## Constructors
+
+### Constructor
+
+```ts
+new PageableResponse(): PageableResponse;
+```
+
+#### Returns
+
+`PageableResponse`
+
+## Properties
+
+### items
+
+```ts
+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?
+
+```ts
+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?
+
+```ts
+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
+
+```ts
+total: number;
+```
+
+Defined in: [models/response/PageableResponse.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/PageableResponse.ts#L26)

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

@@ -0,0 +1,62 @@
+---
+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)
+
+A NestJS HttpException that represents a Problem Detail as per RFC 7807.
+
+## Extends
+
+- `HttpException`
+
+## Constructors
+
+### Constructor
+
+```ts
+new ProblemDetailException(responseCode, args): ProblemDetailException;
+```
+
+Defined in: [filters/ProblemDetailExceptionFilter.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L28)
+
+#### Parameters
+
+| Parameter      | Type                                       |
+| -------------- | ------------------------------------------ |
+| `responseCode` | `number`                                   |
+| `args`         | [`ProblemDetail`](TypeAlias.ProblemDetail) |
+
+#### Returns
+
+`ProblemDetailException`
+
+#### Overrides
+
+```ts
+HttpException.constructor;
+```
+
+## Methods
+
+### getResponse()
+
+```ts
+getResponse(): ProblemDetail;
+```
+
+Defined in: [filters/ProblemDetailExceptionFilter.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L32)
+
+#### Returns
+
+[`ProblemDetail`](TypeAlias.ProblemDetail)
+
+#### Overrides
+
+```ts
+HttpException.getResponse;
+```

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

@@ -0,0 +1,85 @@
+---
+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)
+
+A NestJS exception filter that transforms exceptions into Problem Details
+compliant responses as per RFC 7807.
+
+## Implements
+
+- `ExceptionFilter`\<`HttpException`\>
+
+## Constructors
+
+### Constructor
+
+```ts
+new ProblemDetailExceptionFilter(urlResolver?): ProblemDetailExceptionFilter;
+```
+
+Defined in: [filters/ProblemDetailExceptionFilter.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L54)
+
+#### Parameters
+
+| Parameter      | Type                                                                     |
+| -------------- | ------------------------------------------------------------------------ |
+| `urlResolver?` | [`ProblemDetailTypeUrlResolver`](TypeAlias.ProblemDetailTypeUrlResolver) |
+
+#### Returns
+
+`ProblemDetailExceptionFilter`
+
+## Methods
+
+### catch()
+
+```ts
+catch(exception, host): any;
+```
+
+Defined in: [filters/ProblemDetailExceptionFilter.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L63)
+
+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 |
+
+#### Returns
+
+`any`
+
+#### Implementation of
+
+```ts
+ExceptionFilter.catch;
+```
+
+---
+
+### setLogger()
+
+```ts
+setLogger(logger): void;
+```
+
+Defined in: [filters/ProblemDetailExceptionFilter.ts:76](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/filters/ProblemDetailExceptionFilter.ts#L76)
+
+#### Parameters
+
+| Parameter | Type            |
+| --------- | --------------- |
+| `logger`  | `LoggerService` |
+
+#### Returns
+
+`void`

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

@@ -0,0 +1,43 @@
+---
+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)
+
+Base class for quantity responses.
+
+## Constructors
+
+### Constructor
+
+```ts
+new QuantityResponse(): QuantityResponse;
+```
+
+#### Returns
+
+`QuantityResponse`
+
+## Properties
+
+### unit
+
+```ts
+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
+
+```ts
+value: number;
+```
+
+Defined in: [models/response/QuantityResponse.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/QuantityResponse.ts#L29)

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

@@ -0,0 +1,275 @@
+---
+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)
+
+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. |
+
+## Implements
+
+- [`ILayeredCache`](Interface.ILayeredCache)\<`TKey`, `TValue`\>
+- `OnModuleDestroy`
+
+## Constructors
+
+### Constructor
+
+```ts
+new RedisLayeredCache<TKey, TValue>(loadFn, options): RedisLayeredCache<TKey, TValue>;
+```
+
+Defined in: [cache/RedisLayeredCache.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L46)
+
+#### Parameters
+
+| Parameter | Type                                                                           |
+| --------- | ------------------------------------------------------------------------------ |
+| `loadFn`  | (`key`) => `Promise`\<`TValue` \| `undefined`\>                                |
+| `options` | [`IRedisLayeredCacheOptions`](Interface.IRedisLayeredCacheOptions)\<`TValue`\> |
+
+#### Returns
+
+`RedisLayeredCache`\<`TKey`, `TValue`\>
+
+## Methods
+
+### get()
+
+```ts
+get(key): TValue | undefined;
+```
+
+Defined in: [cache/RedisLayeredCache.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L65)
+
+Retrieves a value from the cache.
+Note: Redis is inherently async, so this throws an error.
+
+#### 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/RedisLayeredCache.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L75)
+
+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/RedisLayeredCache.ts:142](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L142)
+
+Invalidates a key in the cache.
+Note: Redis is inherently async, so this throws an error.
+
+#### 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/RedisLayeredCache.ts:152](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L152)
+
+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)
+
+---
+
+### onModuleDestroy()
+
+```ts
+onModuleDestroy(): Promise<void>;
+```
+
+Defined in: [cache/RedisLayeredCache.ts:169](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L169)
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+```ts
+OnModuleDestroy.onModuleDestroy;
+```
+
+---
+
+### set()
+
+```ts
+set(key, value): void;
+```
+
+Defined in: [cache/RedisLayeredCache.ts:109](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L109)
+
+Sets a value in the cache.
+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. |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`ILayeredCache`](Interface.ILayeredCache).[`set`](Interface.ILayeredCache#set)
+
+---
+
+### setAsync()
+
+```ts
+setAsync(key, value): Promise<void>;
+```
+
+Defined in: [cache/RedisLayeredCache.ts:120](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L120)
+
+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/RedisLayeredCache.ts:160](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L160)
+
+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/RedisLayeredCache.ts:131](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/cache/RedisLayeredCache.ts#L131)
+
+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)