@breadstone/archipel-mcp 0.0.13 → 0.0.14

package/data/packages/platform-caching/index.md

@@ -1,116 +0,0 @@
----
-title: platform-caching
-description: Layered caching with in-memory LRU and Redis-backed implementations, TTL, stale-while-revalidate, and metrics.
-order: 15
-tags: [caching, lru, redis, ttl, stale-while-revalidate, metrics]
-package: '@breadstone/archipel-platform-caching'
----
-
-# platform-caching
-
-Layered caching library providing both an in-memory LRU cache and a Redis-backed distributed cache. Both implementations share the `ILayeredCache` contract and support TTL expiration, stale-while-revalidate, warm-up, and pluggable metrics recording.
-
-**Package:** `@breadstone/archipel-platform-caching`
-
-## Quick Start
-
-```typescript
-import { MemoryLayeredCache } from '@breadstone/archipel-platform-caching';
-
-const cache = new MemoryLayeredCache<string, IProduct>(async (key) => productRepository.findById(key), {
-  ttlMs: 60_000,
-  maxEntries: 500,
-  staleWhileRevalidate: true,
-});
-
-const product = await cache.getAsync('prod-123');
-```
-
-For Redis-backed caching:
-
-```typescript
-import { RedisLayeredCache } from '@breadstone/archipel-platform-caching/redis';
-
-const cache = new RedisLayeredCache<string, IProduct>(redisClient, async (key) => productRepository.findById(key), {
-  ttlMs: 300_000,
-  cacheName: 'products',
-});
-```
-
----
-
-## ILayeredCache Interface
-
-Both implementations share this contract:
-
-| Method                 | Description                                                       |
-| ---------------------- | ----------------------------------------------------------------- |
-| `get(key)`             | Synchronous cache lookup.                                         |
-| `getAsync(key)`        | Asynchronous cache lookup — triggers the load function on a miss. |
-| `set(key, value)`      | Synchronous write.                                                |
-| `setAsync(key, value)` | Asynchronous write.                                               |
-| `invalidate(key)`      | Synchronous eviction.                                             |
-| `invalidateAsync(key)` | Asynchronous eviction.                                            |
-| `warm(key)`            | Proactively loads and caches a value.                             |
-| `stats()`              | Returns hit/miss/eviction counters as `ICacheStats`.              |
-
----
-
-## Configuration Options
-
-### ILayeredCacheOptions (In-Memory)
-
-| Property               | Type                    | Default    | Description                                             |
-| ---------------------- | ----------------------- | ---------- | ------------------------------------------------------- |
-| `ttlMs`                | `number`                | ∞          | Time-to-live in milliseconds.                           |
-| `staleWhileRevalidate` | `boolean`               | `false`    | Serve stale entries while refreshing in the background. |
-| `maxEntries`           | `number`                | ∞          | LRU eviction threshold.                                 |
-| `metricsRecorder`      | `ICacheMetricsRecorder` | Noop       | Pluggable metrics hook.                                 |
-| `cacheName`            | `string`                | `'memory'` | Label used in metrics and logging.                      |
-
-### IRedisLayeredCacheOptions
-
-| Property               | Type                    | Default          | Description                                             |
-| ---------------------- | ----------------------- | ---------------- | ------------------------------------------------------- |
-| `ttlMs`                | `number`                | ∞                | Time-to-live in milliseconds.                           |
-| `staleWhileRevalidate` | `boolean`               | `false`          | Serve stale entries while refreshing in the background. |
-| `metricsRecorder`      | `ICacheMetricsRecorder` | Noop             | Pluggable metrics hook.                                 |
-| `cacheName`            | `string`                | `'redis'`        | Label used in metrics and logging.                      |
-| `serialize`            | `(value) => string`     | `JSON.stringify` | Custom serializer for cache values.                     |
-| `deserialize`          | `(raw) => value`        | `JSON.parse`     | Custom deserializer for cache entries.                  |
-
----
-
-## Metrics
-
-Implement `ICacheMetricsRecorder` to forward cache statistics to your telemetry system:
-
-```typescript
-import { ICacheMetricsRecorder } from '@breadstone/archipel-platform-caching';
-
-class TelemetryCacheRecorder implements ICacheMetricsRecorder {
-  recordHit(cacheName: string): void {
-    /* increment counter */
-  }
-  recordMiss(cacheName: string): void {
-    /* increment counter */
-  }
-  recordLoadSuccess(cacheName: string, durationMs: number): void {
-    /* histogram */
-  }
-  recordLoadError(cacheName: string): void {
-    /* increment counter */
-  }
-  recordEviction(cacheName: string): void {
-    /* increment counter */
-  }
-}
-```
-
-When no recorder is provided, `NoopCacheMetricsRecorder` is used as a silent fallback.
-
----
-
-## API Reference
-
-See the full [API documentation](./api/) for all exported types and classes.

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

@@ -1,50 +0,0 @@
----
-title: 'Class: AppHealthIndicator'
-generated: true
-editUrl: false
----
-# Class: AppHealthIndicator
-
-Defined in: [terminus/AppHealthIndicator.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/terminus/AppHealthIndicator.ts#L16)
-
-Health indicator for the application.
-
-## Constructors
-
-### Constructor
-
-```ts
-new AppHealthIndicator(configService): AppHealthIndicator;
-```
-
-Defined in: [terminus/AppHealthIndicator.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/terminus/AppHealthIndicator.ts#L30)
-
-Constructs a new instance of the `AppHealthIndicator` class.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `configService` | [`ConfigService`](Class.ConfigService) |
-
-#### Returns
-
-`AppHealthIndicator`
-
-## Methods
-
-### isHealthy()
-
-```ts
-isHealthy(): HealthIndicatorResult<"app">;
-```
-
-Defined in: [terminus/AppHealthIndicator.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/terminus/AppHealthIndicator.ts#L44)
-
-Checks if the Open Food Facts API is reachable.
-
-#### Returns
-
-`HealthIndicatorResult`\<`"app"`\>
-
-The health indicator result.

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

@@ -1,195 +0,0 @@
----
-title: 'Class: BlobResourceStrategy'
-generated: true
-editUrl: false
----
-# Class: BlobResourceStrategy
-
-Defined in: [resources/strategies/BlobResourceStrategy.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L51)
-
-Strategy for loading resources from blob storage.
-
-## Implements
-
-- [`IResourceStrategy`](Interface.IResourceStrategy)
-
-## Constructors
-
-### Constructor
-
-```ts
-new BlobResourceStrategy(blobService, config?): BlobResourceStrategy;
-```
-
-Defined in: [resources/strategies/BlobResourceStrategy.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L68)
-
-Constructs a new instance of the `BlobResourceStrategy` class.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `blobService` | [`IBlobServiceAdapter`](Interface.IBlobServiceAdapter) |
-| `config` | [`IBlobResourceStrategyConfig`](Interface.IBlobResourceStrategyConfig) |
-
-#### Returns
-
-`BlobResourceStrategy`
-
-## Accessors
-
-### name
-
-#### Get Signature
-
-```ts
-get name(): string;
-```
-
-Defined in: [resources/strategies/BlobResourceStrategy.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L77)
-
-The unique name of this strategy.
-
-##### Returns
-
-`string`
-
-The unique name of this strategy.
-
-#### Implementation of
-
-[`IResourceStrategy`](Interface.IResourceStrategy).[`name`](Interface.IResourceStrategy#name)
-
-## Methods
-
-### exists()
-
-```ts
-exists(key): boolean;
-```
-
-Defined in: [resources/strategies/BlobResourceStrategy.ts:143](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L143)
-
-Checks if a resource exists without loading it.
-Note: Blob storage is inherently async, so this delegates to existsAsync internally.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The resource key |
-
-#### Returns
-
-`boolean`
-
-True if the resource exists
-
-#### Implementation of
-
-[`IResourceStrategy`](Interface.IResourceStrategy).[`exists`](Interface.IResourceStrategy#exists)
-
-***
-
-### existsAsync()
-
-```ts
-existsAsync(key): Promise<boolean>;
-```
-
-Defined in: [resources/strategies/BlobResourceStrategy.ts:154](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L154)
-
-Checks if a resource exists without loading it (asynchronous).
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The resource key |
-
-#### Returns
-
-`Promise`\<`boolean`\>
-
-Promise resolving to true if the resource exists
-
-#### Implementation of
-
-[`IResourceStrategy`](Interface.IResourceStrategy).[`existsAsync`](Interface.IResourceStrategy#existsasync)
-
-***
-
-### load()
-
-```ts
-load(key): IResourceResult | undefined;
-```
-
-Defined in: [resources/strategies/BlobResourceStrategy.ts:93](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L93)
-
-Loads a resource by its key.
-Note: Blob storage is inherently async, so this delegates to loadAsync internally.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The resource key |
-
-#### Returns
-
-[`IResourceResult`](Interface.IResourceResult) \| `undefined`
-
-The resource result or undefined if not found
-
-#### Implementation of
-
-[`IResourceStrategy`](Interface.IResourceStrategy).[`load`](Interface.IResourceStrategy#load)
-
-***
-
-### loadAsync()
-
-```ts
-loadAsync(key): Promise<IResourceResult | undefined>;
-```
-
-Defined in: [resources/strategies/BlobResourceStrategy.ts:104](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L104)
-
-Loads a resource by its key (asynchronous).
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The resource key |
-
-#### Returns
-
-`Promise`\<[`IResourceResult`](Interface.IResourceResult) \| `undefined`\>
-
-Promise resolving to the resource result or undefined if not found
-
-#### Implementation of
-
-[`IResourceStrategy`](Interface.IResourceStrategy).[`loadAsync`](Interface.IResourceStrategy#loadasync)
-
-***
-
-### whatDoIHave()
-
-```ts
-whatDoIHave(): void;
-```
-
-Defined in: [resources/strategies/BlobResourceStrategy.ts:170](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L170)
-
-List all files and folders in the base paths for debugging purposes.
-
-#### Returns
-
-`void`
-
-#### Implementation of
-
-[`IResourceStrategy`](Interface.IResourceStrategy).[`whatDoIHave`](Interface.IResourceStrategy#whatdoihave)

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

@@ -1,82 +0,0 @@
----
-title: 'Class: BooleanUtils'
-generated: true
-editUrl: false
----
-# Class: BooleanUtils
-
-Defined in: [utils/BooleanUtils.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/BooleanUtils.ts#L22)
-
-Boolean Utility Class.
-This class provides static methods to parse and format boolean values.
-
-## Constructors
-
-### Constructor
-
-```ts
-new BooleanUtils(): BooleanUtils;
-```
-
-#### Returns
-
-`BooleanUtils`
-
-## Methods
-
-### formatBoolean()
-
-```ts
-static formatBoolean(
-   bool, 
-   trueFormat?, 
-   falseFormat?): string;
-```
-
-Defined in: [utils/BooleanUtils.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/BooleanUtils.ts#L69)
-
-Formats a boolean into a specific string representation.
-
-#### Parameters
-
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `bool` | `boolean` | `undefined` | The boolean to format |
-| `trueFormat` | `string` | `'true'` | The string to return for `true` values (defaults to "true") |
-| `falseFormat` | `string` | `'false'` | The string to return for `false` values (defaults to "false") |
-
-#### Returns
-
-`string`
-
-The formatted string representation of the boolean
-
-***
-
-### parseBoolean()
-
-```ts
-static parseBoolean(value, options?): boolean;
-```
-
-Defined in: [utils/BooleanUtils.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/BooleanUtils.ts#L33)
-
-Parses a given value into a boolean.
-Accepts flexible strings like "yes", "no", "y", "n", "1", "0", "true", "false".
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `string` \| `boolean` | The value to parse into a boolean |
-| `options?` | `BooleanOptions` | Options for strict parsing mode |
-
-#### Returns
-
-`boolean`
-
-The parsed boolean value
-
-#### Throws
-
-Error if the value is not a valid boolean representation

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

@@ -1,120 +0,0 @@
----
-title: 'Class: CUIDGenerator'
-generated: true
-editUrl: false
----
-# Class: CUIDGenerator
-
-Defined in: [identifiers/generators/CUIDGenerator.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/CUIDGenerator.ts#L14)
-
-CUID Generator class
-
-## Extends
-
-- [`IdGeneratorBase`](Class.IdGeneratorBase)
-
-## Constructors
-
-### Constructor
-
-```ts
-new CUIDGenerator(): CUIDGenerator;
-```
-
-#### Returns
-
-`CUIDGenerator`
-
-#### Inherited from
-
-[`IdGeneratorBase`](Class.IdGeneratorBase).[`constructor`](Class.IdGeneratorBase#constructor)
-
-## Methods
-
-### generate()
-
-```ts
-generate(prefix?, postfix?): string;
-```
-
-Defined in: [identifiers/generators/CUIDGenerator.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/CUIDGenerator.ts#L29)
-
-Generates a CUID (Collision-Resistant Unique Identifier).
-
-#### 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/CUIDGenerator.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/CUIDGenerator.ts#L45)
-
-Validates if the provided string is a valid CUID
-
-#### 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)
-
-***
-
-### parse()
-
-```ts
-parse(cuid): 
-  | {
-  counter: string;
-  random: string;
-  timestamp: string;
-}
-  | null;
-```
-
-Defined in: [identifiers/generators/CUIDGenerator.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/CUIDGenerator.ts#L56)
-
-Parses a CUID into its segments
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `cuid` | `string` | The CUID string to parse |
-
-#### Returns
-
-  \| \{
-  `counter`: `string`;
-  `random`: `string`;
-  `timestamp`: `string`;
-\}
-  \| `null`
-
-An object containing the parsed segments

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

@@ -1,83 +0,0 @@
----
-title: 'Class: CasingInterceptor'
-generated: true
-editUrl: false
----
-# Class: CasingInterceptor
-
-Defined in: [interceptors/CasingInterceptor.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/interceptors/CasingInterceptor.ts#L18)
-
-This interceptor is responsible for converting snake_case or other
-casing styles in the request body to camelCase before passing them to controllers.
-It also handles the transformation of the response if needed.
-
-## Implements
-
-- `NestInterceptor`
-
-## Constructors
-
-### Constructor
-
-```ts
-new CasingInterceptor(): CasingInterceptor;
-```
-
-#### Returns
-
-`CasingInterceptor`
-
-## Methods
-
-### intercept()
-
-```ts
-intercept(context, next): Observable<any>;
-```
-
-Defined in: [interceptors/CasingInterceptor.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/interceptors/CasingInterceptor.ts#L19)
-
-Method to implement a custom interceptor.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `context` | `ExecutionContext` | an `ExecutionContext` object providing methods to access the route handler and class about to be invoked. |
-| `next` | `CallHandler` | a reference to the `CallHandler`, which provides access to an `Observable` representing the response stream from the route handler. |
-
-#### Returns
-
-`Observable`\<`any`\>
-
-#### Implementation of
-
-```ts
-NestInterceptor.intercept
-```
-
-***
-
-### process()
-
-```ts
-process<T>(value): T;
-```
-
-Defined in: [interceptors/CasingInterceptor.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/interceptors/CasingInterceptor.ts#L38)
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` |
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `value` | `T` |
-
-#### Returns
-
-`T`