@breadstone/archipel-mcp 0.0.23 → 0.0.25

package/data/packages/platform-resources/api/Class.ResourceNotFoundError.md

@@ -0,0 +1,60 @@
+---
+title: 'Class: ResourceNotFoundError'
+generated: true
+editUrl: false
+---
+# Class: ResourceNotFoundError
+
+Defined in: [errors/ResourceNotFoundError.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/errors/ResourceNotFoundError.ts#L6)
+
+Error thrown when a Resource with a specified ID is not found.
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+```ts
+new ResourceNotFoundError(key): ResourceNotFoundError;
+```
+
+Defined in: [errors/ResourceNotFoundError.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/errors/ResourceNotFoundError.ts#L7)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+`ResourceNotFoundError`
+
+#### Overrides
+
+```ts
+Error.constructor
+```
+
+## Properties
+
+### code
+
+```ts
+readonly code: "RESOURCE_NOT_FOUND" = 'RESOURCE_NOT_FOUND';
+```
+
+Defined in: [errors/ResourceNotFoundError.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/errors/ResourceNotFoundError.ts#L11)
+
+***
+
+### key
+
+```ts
+readonly key: string;
+```
+
+Defined in: [errors/ResourceNotFoundError.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/errors/ResourceNotFoundError.ts#L7)

package/data/packages/platform-resources/api/Interface.IBlobResourceStrategyConfig.md

@@ -0,0 +1,28 @@
+---
+title: 'Interface: IBlobResourceStrategyConfig'
+generated: true
+editUrl: false
+---
+# Interface: IBlobResourceStrategyConfig
+
+Defined in: [strategies/BlobResourceStrategy.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/BlobResourceStrategy.ts#L34)
+
+Configuration for the blob resource strategy.
+
+## Properties
+
+### keyPrefix?
+
+```ts
+optional keyPrefix?: string;
+```
+
+Defined in: [strategies/BlobResourceStrategy.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/BlobResourceStrategy.ts#L39)
+
+Optional key prefix for blob storage.
+
+#### Example
+
+```ts
+'resources/', 'templates/'
+```

package/data/packages/platform-resources/api/Interface.IBlobServiceAdapter.md

@@ -0,0 +1,40 @@
+---
+title: 'Interface: IBlobServiceAdapter'
+generated: true
+editUrl: false
+---
+# Interface: IBlobServiceAdapter
+
+Defined in: [strategies/BlobResourceStrategy.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/BlobResourceStrategy.ts#L14)
+
+Minimal blob service interface to avoid circular dependencies.
+
+## Methods
+
+### downloadFile()
+
+```ts
+downloadFile(key): Promise<{
+  contentType?: string;
+  data: unknown;
+}>;
+```
+
+Defined in: [strategies/BlobResourceStrategy.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/BlobResourceStrategy.ts#L21)
+
+Downloads a file from blob storage.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The blob key |
+
+#### Returns
+
+`Promise`\<\{
+  `contentType?`: `string`;
+  `data`: `unknown`;
+\}\>
+
+The download result

package/data/packages/platform-resources/api/Interface.IFileResourceStrategyConfig.md

@@ -0,0 +1,72 @@
+---
+title: 'Interface: IFileResourceStrategyConfig'
+generated: true
+editUrl: false
+---
+# Interface: IFileResourceStrategyConfig
+
+Defined in: [strategies/FileResourceStrategy.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/FileResourceStrategy.ts#L18)
+
+Configuration for the file resource strategy.
+
+## Properties
+
+### basePaths
+
+```ts
+basePaths: string[];
+```
+
+Defined in: [strategies/FileResourceStrategy.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/FileResourceStrategy.ts#L23)
+
+Base paths to search for resources.
+Paths are tried in order until the resource is found.
+
+***
+
+### defaultEncoding?
+
+```ts
+optional defaultEncoding?: 
+  | "ascii"
+  | "utf8"
+  | "utf-8"
+  | "utf16le"
+  | "ucs2"
+  | "ucs-2"
+  | "base64"
+  | "base64url"
+  | "latin1"
+  | "binary"
+  | "hex";
+```
+
+Defined in: [strategies/FileResourceStrategy.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/FileResourceStrategy.ts#L29)
+
+Optional default encoding for text files.
+
+#### Default
+
+```ts
+'utf-8'
+```
+
+***
+
+### includeSubfolders?
+
+```ts
+optional includeSubfolders?: boolean;
+```
+
+Defined in: [strategies/FileResourceStrategy.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/FileResourceStrategy.ts#L48)
+
+Enable recursive search in subdirectories.
+When enabled, the strategy will search for files in all subdirectories
+of the base paths using glob patterns.
+
+#### Default
+
+```ts
+false
+```

package/data/packages/platform-resources/api/Interface.IResourceManagerConfig.md

@@ -0,0 +1,89 @@
+---
+title: 'Interface: IResourceManagerConfig'
+generated: true
+editUrl: false
+---
+# Interface: IResourceManagerConfig
+
+Defined in: [ResourceManager.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L16)
+
+Configuration for the ResourceManager.
+
+## Properties
+
+### cache?
+
+```ts
+optional cache?: ILayeredCache<string, IResourceResult>;
+```
+
+Defined in: [ResourceManager.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L26)
+
+Optional cache for loaded resources.
+
+***
+
+### cacheTtl?
+
+```ts
+optional cacheTtl?: number;
+```
+
+Defined in: [ResourceManager.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L32)
+
+Cache TTL in seconds.
+
+#### Default
+
+```ts
+3600 (1 hour)
+```
+
+***
+
+### debug?
+
+```ts
+optional debug?: boolean;
+```
+
+Defined in: [ResourceManager.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L38)
+
+Enable debug logging.
+
+#### Default
+
+```ts
+false
+```
+
+***
+
+### strategies
+
+```ts
+strategies: IResourceStrategy[];
+```
+
+Defined in: [ResourceManager.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L21)
+
+Resource loading strategies in priority order.
+First strategy that finds the resource wins.
+
+***
+
+### strategyTimeoutMs?
+
+```ts
+optional strategyTimeoutMs?: number;
+```
+
+Defined in: [ResourceManager.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L44)
+
+Timeout in milliseconds for a single async strategy load.
+
+#### Default
+
+```ts
+30000 (30 seconds)
+```

package/data/packages/platform-resources/api/Interface.IResourceMetadata.md

@@ -0,0 +1,94 @@
+---
+title: 'Interface: IResourceMetadata'
+generated: true
+editUrl: false
+---
+# Interface: IResourceMetadata
+
+Defined in: [types/IResourceMetadata.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceMetadata.ts#L6)
+
+Metadata about a resource.
+
+## Properties
+
+### cachedAt?
+
+```ts
+optional cachedAt?: Date;
+```
+
+Defined in: [types/IResourceMetadata.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceMetadata.ts#L40)
+
+When this resource was cached (if applicable).
+
+***
+
+### encoding?
+
+```ts
+optional encoding?: BufferEncoding;
+```
+
+Defined in: [types/IResourceMetadata.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceMetadata.ts#L30)
+
+The encoding of the resource (if applicable).
+
+***
+
+### key
+
+```ts
+key: string;
+```
+
+Defined in: [types/IResourceMetadata.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceMetadata.ts#L10)
+
+The resource key/identifier.
+
+***
+
+### mimeType
+
+```ts
+mimeType: string;
+```
+
+Defined in: [types/IResourceMetadata.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceMetadata.ts#L20)
+
+The MIME type of the resource.
+
+***
+
+### path
+
+```ts
+path: string;
+```
+
+Defined in: [types/IResourceMetadata.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceMetadata.ts#L15)
+
+The full path of the resource.
+
+***
+
+### size
+
+```ts
+size: number;
+```
+
+Defined in: [types/IResourceMetadata.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceMetadata.ts#L25)
+
+The size of the resource in bytes.
+
+***
+
+### source
+
+```ts
+source: string;
+```
+
+Defined in: [types/IResourceMetadata.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceMetadata.ts#L35)
+
+The source strategy that resolved this resource.

package/data/packages/platform-resources/api/Interface.IResourceResult.md

@@ -0,0 +1,34 @@
+---
+title: 'Interface: IResourceResult'
+generated: true
+editUrl: false
+---
+# Interface: IResourceResult
+
+Defined in: [types/IResourceResult.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceResult.ts#L8)
+
+Result of loading a resource.
+
+## Properties
+
+### content
+
+```ts
+content: Buffer;
+```
+
+Defined in: [types/IResourceResult.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceResult.ts#L12)
+
+The resource content as a Buffer.
+
+***
+
+### metadata
+
+```ts
+metadata: IResourceMetadata;
+```
+
+Defined in: [types/IResourceResult.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/types/IResourceResult.ts#L17)
+
+Metadata about the resource.

package/data/packages/platform-resources/api/Interface.IResourceStrategy.md

@@ -0,0 +1,134 @@
+---
+title: 'Interface: IResourceStrategy'
+generated: true
+editUrl: false
+---
+# Interface: IResourceStrategy
+
+Defined in: [strategies/abstracts/IResourceStrategy.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/abstracts/IResourceStrategy.ts#L8)
+
+Strategy for loading resources from a specific source.
+
+## Properties
+
+### name
+
+```ts
+readonly name: string;
+```
+
+Defined in: [strategies/abstracts/IResourceStrategy.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/abstracts/IResourceStrategy.ts#L12)
+
+The unique name of this strategy.
+
+## Methods
+
+### exists()
+
+```ts
+exists(key): boolean;
+```
+
+Defined in: [strategies/abstracts/IResourceStrategy.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/abstracts/IResourceStrategy.ts#L36)
+
+Checks if a resource exists without loading it.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The resource key/identifier |
+
+#### Returns
+
+`boolean`
+
+True if the resource exists
+
+***
+
+### existsAsync()
+
+```ts
+existsAsync(key): Promise<boolean>;
+```
+
+Defined in: [strategies/abstracts/IResourceStrategy.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/abstracts/IResourceStrategy.ts#L44)
+
+Checks if a resource exists without loading it (asynchronous).
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The resource key/identifier |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+Promise resolving to true if the resource exists
+
+***
+
+### load()
+
+```ts
+load(key): IResourceResult | undefined;
+```
+
+Defined in: [strategies/abstracts/IResourceStrategy.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/abstracts/IResourceStrategy.ts#L20)
+
+Loads a resource by its key.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The resource key/identifier |
+
+#### Returns
+
+[`IResourceResult`](Interface.IResourceResult) \| `undefined`
+
+The resource result or undefined if not found
+
+***
+
+### loadAsync()
+
+```ts
+loadAsync(key): Promise<IResourceResult | undefined>;
+```
+
+Defined in: [strategies/abstracts/IResourceStrategy.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/abstracts/IResourceStrategy.ts#L28)
+
+Loads a resource by its key (asynchronous).
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The resource key/identifier |
+
+#### Returns
+
+`Promise`\<[`IResourceResult`](Interface.IResourceResult) \| `undefined`\>
+
+Promise resolving to the resource result or undefined if not found
+
+***
+
+### whatDoIHave()
+
+```ts
+whatDoIHave(): void;
+```
+
+Defined in: [strategies/abstracts/IResourceStrategy.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/strategies/abstracts/IResourceStrategy.ts#L49)
+
+List all files and folders in the base paths for debugging purposes.
+
+#### Returns
+
+`void`

package/data/packages/platform-resources/api/index.md

@@ -0,0 +1,29 @@
+---
+title: '@breadstone/archipel-platform-resources'
+generated: true
+editUrl: false
+---
+# @breadstone/archipel-platform-resources
+
+## Classes
+
+| Class | Description |
+| ------ | ------ |
+| [BlobResourceStrategy](Class.BlobResourceStrategy) | Strategy for loading resources from blob storage. |
+| [EmbeddedResourceStrategy](Class.EmbeddedResourceStrategy) | Strategy for loading embedded resources from memory. |
+| [FileResourceStrategy](Class.FileResourceStrategy) | Strategy for loading resources from the local file system. |
+| [ResourceManager](Class.ResourceManager) | Central manager for loading resources from various sources. Supports multiple strategies (file, blob, embedded) with caching. |
+| [ResourceModule](Class.ResourceModule) | Module providing the ResourceManager. |
+| [ResourceNotFoundError](Class.ResourceNotFoundError) | Error thrown when a Resource with a specified ID is not found. |
+
+## Interfaces
+
+| Interface | Description |
+| ------ | ------ |
+| [IBlobResourceStrategyConfig](Interface.IBlobResourceStrategyConfig) | Configuration for the blob resource strategy. |
+| [IBlobServiceAdapter](Interface.IBlobServiceAdapter) | Minimal blob service interface to avoid circular dependencies. |
+| [IFileResourceStrategyConfig](Interface.IFileResourceStrategyConfig) | Configuration for the file resource strategy. |
+| [IResourceManagerConfig](Interface.IResourceManagerConfig) | Configuration for the ResourceManager. |
+| [IResourceMetadata](Interface.IResourceMetadata) | Metadata about a resource. |
+| [IResourceResult](Interface.IResourceResult) | Result of loading a resource. |
+| [IResourceStrategy](Interface.IResourceStrategy) | Strategy for loading resources from a specific source. |

package/data/packages/platform-telemetry/api/Class.OtelSdkHolder.md

@@ -28,6 +28,24 @@ new OtelSdkHolder(): OtelSdkHolder;
 
 `OtelSdkHolder`
 
+## Accessors
+
+### isInitialized
+
+#### Get Signature
+
+```ts
+get isInitialized(): boolean;
+```
+
+Defined in: [OtelSdkHolder.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/OtelSdkHolder.ts#L31)
+
+Whether the OpenTelemetry SDK has been initialized.
+
+##### Returns
+
+`boolean`
+
 ## Methods
 
 ### onApplicationShutdown()
@@ -36,7 +54,7 @@ new OtelSdkHolder(): OtelSdkHolder;
 onApplicationShutdown(): Promise<void>;
 ```
 
-Defined in: [OtelSdkHolder.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/OtelSdkHolder.ts#L39)
+Defined in: [OtelSdkHolder.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/OtelSdkHolder.ts#L52)
 
 #### Returns
 
@@ -58,7 +76,7 @@ OnApplicationShutdown.onApplicationShutdown
 setSdk(sdk): void;
 ```
 
-Defined in: [OtelSdkHolder.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/OtelSdkHolder.ts#L30)
+Defined in: [OtelSdkHolder.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-telemetry/src/OtelSdkHolder.ts#L43)
 
 Stores the SDK reference so it can be shut down later.
 Can only be called once - subsequent calls are ignored.

package/data/packages/platform-telemetry/api/Class.TelemetryHealthIndicator.md

@@ -0,0 +1,78 @@
+---
+title: 'Class: TelemetryHealthIndicator'
+generated: true
+editUrl: false
+---
+# Class: TelemetryHealthIndicator
+
+Defined in: health/TelemetryHealthIndicator.ts:17
+
+Health indicator for the telemetry infrastructure.
+Checks whether the OpenTelemetry SDK has been initialized via [OtelSdkHolder](Class.OtelSdkHolder).
+
+## Implements
+
+- `IHealthIndicator`
+
+## Constructors
+
+### Constructor
+
+```ts
+new TelemetryHealthIndicator(sdkHolder?): TelemetryHealthIndicator;
+```
+
+Defined in: health/TelemetryHealthIndicator.ts:26
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `sdkHolder?` | [`OtelSdkHolder`](Class.OtelSdkHolder) |
+
+#### Returns
+
+`TelemetryHealthIndicator`
+
+## Properties
+
+### key
+
+```ts
+readonly key: string = 'telemetry';
+```
+
+Defined in: health/TelemetryHealthIndicator.ts:34
+
+Unique key identifying the indicator
+
+#### Implementation of
+
+```ts
+IHealthIndicator.key
+```
+
+## Methods
+
+### check()
+
+```ts
+check(): HealthIndicatorResult<string>;
+```
+
+Defined in: health/TelemetryHealthIndicator.ts:47
+
+Checks whether the OpenTelemetry SDK has been initialized.
+Returns disabled status when no SDK holder is configured.
+
+#### Returns
+
+`HealthIndicatorResult`\<`string`\>
+
+The health indicator result.
+
+#### Implementation of
+
+```ts
+IHealthIndicator.check
+```