@breadstone/archipel-mcp 0.0.23 → 0.0.26

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

@@ -0,0 +1,477 @@
+---
+title: 'Class: ResourceManager'
+generated: true
+editUrl: false
+---
+# Class: ResourceManager
+
+Defined in: [ResourceManager.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L74)
+
+Central manager for loading resources from various sources.
+Supports multiple strategies (file, blob, embedded) with caching.
+
+## Implements
+
+- `IResourceManager`
+
+## Constructors
+
+### Constructor
+
+```ts
+new ResourceManager(config): ResourceManager;
+```
+
+Defined in: [ResourceManager.ts:92](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L92)
+
+Constructs a new instance of the `ResourceManager` class.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `config` | [`IResourceManagerConfig`](Interface.IResourceManagerConfig) |
+
+#### Returns
+
+`ResourceManager`
+
+## Methods
+
+### exists()
+
+```ts
+exists(key): boolean;
+```
+
+Defined in: [ResourceManager.ts:246](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L246)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+`boolean`
+
+#### Implementation of
+
+```ts
+IResourceManager.exists
+```
+
+***
+
+### existsAsync()
+
+```ts
+existsAsync(key): Promise<boolean>;
+```
+
+Defined in: [ResourceManager.ts:255](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L255)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+#### Implementation of
+
+```ts
+IResourceManager.existsAsync
+```
+
+***
+
+### invalidate()
+
+```ts
+invalidate(key): void;
+```
+
+Defined in: [ResourceManager.ts:264](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L264)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+```ts
+IResourceManager.invalidate
+```
+
+***
+
+### invalidateAsync()
+
+```ts
+invalidateAsync(key): Promise<void>;
+```
+
+Defined in: [ResourceManager.ts:271](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L271)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+```ts
+IResourceManager.invalidateAsync
+```
+
+***
+
+### load()
+
+```ts
+load(key): IResourceResult;
+```
+
+Defined in: [ResourceManager.ts:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L107)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+[`IResourceResult`](Interface.IResourceResult)
+
+#### Implementation of
+
+```ts
+IResourceManager.load
+```
+
+***
+
+### loadAsBuffer()
+
+```ts
+loadAsBuffer(key): Buffer;
+```
+
+Defined in: [ResourceManager.ts:220](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L220)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+`Buffer`
+
+#### Implementation of
+
+```ts
+IResourceManager.loadAsBuffer
+```
+
+***
+
+### loadAsBufferAsync()
+
+```ts
+loadAsBufferAsync(key): Promise<Buffer<ArrayBufferLike>>;
+```
+
+Defined in: [ResourceManager.ts:233](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L233)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+`Promise`\<`Buffer`\<`ArrayBufferLike`\>\>
+
+#### Implementation of
+
+```ts
+IResourceManager.loadAsBufferAsync
+```
+
+***
+
+### loadAsString()
+
+```ts
+loadAsString(key, encoding?): string;
+```
+
+Defined in: [ResourceManager.ts:185](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L185)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `key` | `string` | `undefined` |
+| `encoding` | `BufferEncoding` | `'utf-8'` |
+
+#### Returns
+
+`string`
+
+#### Implementation of
+
+```ts
+IResourceManager.loadAsString
+```
+
+***
+
+### loadAsStringAsync()
+
+```ts
+loadAsStringAsync(key, encoding?): Promise<string>;
+```
+
+Defined in: [ResourceManager.ts:201](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L201)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `key` | `string` | `undefined` |
+| `encoding` | `BufferEncoding` | `'utf-8'` |
+
+#### Returns
+
+`Promise`\<`string`\>
+
+#### Implementation of
+
+```ts
+IResourceManager.loadAsStringAsync
+```
+
+***
+
+### loadAsync()
+
+```ts
+loadAsync(key): Promise<IResourceResult>;
+```
+
+Defined in: [ResourceManager.ts:138](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L138)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+`Promise`\<[`IResourceResult`](Interface.IResourceResult)\>
+
+#### Implementation of
+
+```ts
+IResourceManager.loadAsync
+```
+
+***
+
+### tryLoad()
+
+```ts
+tryLoad(key): IResourceResult | undefined;
+```
+
+Defined in: [ResourceManager.ts:115](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L115)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+[`IResourceResult`](Interface.IResourceResult) \| `undefined`
+
+#### Implementation of
+
+```ts
+IResourceManager.tryLoad
+```
+
+***
+
+### tryLoadAsBuffer()
+
+```ts
+tryLoadAsBuffer(key): Buffer<ArrayBufferLike> | undefined;
+```
+
+Defined in: [ResourceManager.ts:228](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L228)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+`Buffer`\<`ArrayBufferLike`\> \| `undefined`
+
+#### Implementation of
+
+```ts
+IResourceManager.tryLoadAsBuffer
+```
+
+***
+
+### tryLoadAsBufferAsync()
+
+```ts
+tryLoadAsBufferAsync(key): Promise<Buffer<ArrayBufferLike> | undefined>;
+```
+
+Defined in: [ResourceManager.ts:241](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L241)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+`Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `undefined`\>
+
+#### Implementation of
+
+```ts
+IResourceManager.tryLoadAsBufferAsync
+```
+
+***
+
+### tryLoadAsString()
+
+```ts
+tryLoadAsString(key, encoding?): string | undefined;
+```
+
+Defined in: [ResourceManager.ts:193](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L193)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `key` | `string` | `undefined` |
+| `encoding` | `BufferEncoding` | `'utf-8'` |
+
+#### Returns
+
+`string` \| `undefined`
+
+#### Implementation of
+
+```ts
+IResourceManager.tryLoadAsString
+```
+
+***
+
+### tryLoadAsStringAsync()
+
+```ts
+tryLoadAsStringAsync(key, encoding?): Promise<string | undefined>;
+```
+
+Defined in: [ResourceManager.ts:209](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L209)
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `key` | `string` | `undefined` |
+| `encoding` | `BufferEncoding` | `'utf-8'` |
+
+#### Returns
+
+`Promise`\<`string` \| `undefined`\>
+
+#### Implementation of
+
+```ts
+IResourceManager.tryLoadAsStringAsync
+```
+
+***
+
+### tryLoadAsync()
+
+```ts
+tryLoadAsync(key): Promise<IResourceResult | undefined>;
+```
+
+Defined in: [ResourceManager.ts:146](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L146)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `key` | `string` |
+
+#### Returns
+
+`Promise`\<[`IResourceResult`](Interface.IResourceResult) \| `undefined`\>
+
+#### Implementation of
+
+```ts
+IResourceManager.tryLoadAsync
+```
+
+***
+
+### whatDoIHave()
+
+```ts
+whatDoIHave(): void;
+```
+
+Defined in: [ResourceManager.ts:278](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceManager.ts#L278)
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+```ts
+IResourceManager.whatDoIHave
+```

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

@@ -0,0 +1,46 @@
+---
+title: 'Class: ResourceModule'
+generated: true
+editUrl: false
+---
+# Class: ResourceModule
+
+Defined in: [ResourceModule.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceModule.ts#L15)
+
+Module providing the ResourceManager.
+
+## Constructors
+
+### Constructor
+
+```ts
+new ResourceModule(): ResourceModule;
+```
+
+#### Returns
+
+`ResourceModule`
+
+## Methods
+
+### forRoot()
+
+```ts
+static forRoot(config): DynamicModule;
+```
+
+Defined in: [ResourceModule.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-resources/src/ResourceModule.ts#L25)
+
+Registers the ResourceManager with the provided configuration.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `config` | [`IResourceManagerConfig`](Interface.IResourceManagerConfig) | The resource manager configuration |
+
+#### Returns
+
+`DynamicModule`
+
+A dynamic module

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
+```