@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,566 @@
+---
+title: 'Class: ResourceManager'
+generated: true
+editUrl: false
+---
+
+# Class: ResourceManager
+
+Defined in: [resources/ResourceManager.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L70)
+
+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: [resources/ResourceManager.ts:88](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L88)
+
+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: [resources/ResourceManager.ts:357](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L357)
+
+Checks if a resource exists.
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+`boolean`
+
+True if the resource exists in any strategy
+
+#### Implementation of
+
+```ts
+IResourceManager.exists;
+```
+
+---
+
+### existsAsync()
+
+```ts
+existsAsync(key): Promise<boolean>;
+```
+
+Defined in: [resources/ResourceManager.ts:374](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L374)
+
+Checks if a resource exists (asynchronous).
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+Promise resolving to true if the resource exists in any strategy
+
+#### Implementation of
+
+```ts
+IResourceManager.existsAsync;
+```
+
+---
+
+### invalidate()
+
+```ts
+invalidate(key): void;
+```
+
+Defined in: [resources/ResourceManager.ts:390](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L390)
+
+Invalidates cached resource.
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+```ts
+IResourceManager.invalidate;
+```
+
+---
+
+### invalidateAsync()
+
+```ts
+invalidateAsync(key): Promise<void>;
+```
+
+Defined in: [resources/ResourceManager.ts:404](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L404)
+
+Invalidates cached resource (asynchronous).
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise that resolves when the cache is invalidated
+
+#### Implementation of
+
+```ts
+IResourceManager.invalidateAsync;
+```
+
+---
+
+### load()
+
+```ts
+load(key): IResourceResult;
+```
+
+Defined in: [resources/ResourceManager.ts:108](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L108)
+
+Loads a resource by its key.
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+[`IResourceResult`](Interface.IResourceResult)
+
+The resource result
+
+#### Throws
+
+Error if resource not found
+
+#### Implementation of
+
+```ts
+IResourceManager.load;
+```
+
+---
+
+### loadAsBuffer()
+
+```ts
+loadAsBuffer(key): Buffer;
+```
+
+Defined in: [resources/ResourceManager.ts:298](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L298)
+
+Loads a resource as a Buffer.
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+`Buffer`
+
+The resource content as a Buffer
+
+#### Throws
+
+Error if resource not found
+
+#### Implementation of
+
+```ts
+IResourceManager.loadAsBuffer;
+```
+
+---
+
+### loadAsBufferAsync()
+
+```ts
+loadAsBufferAsync(key): Promise<Buffer<ArrayBufferLike>>;
+```
+
+Defined in: [resources/ResourceManager.ts:328](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L328)
+
+Loads a resource as a Buffer (asynchronous).
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+`Promise`\<`Buffer`\<`ArrayBufferLike`\>\>
+
+Promise resolving to the resource content as a Buffer
+
+#### Throws
+
+Error if resource not found
+
+#### Implementation of
+
+```ts
+IResourceManager.loadAsBufferAsync;
+```
+
+---
+
+### loadAsString()
+
+```ts
+loadAsString(key, encoding?): string;
+```
+
+Defined in: [resources/ResourceManager.ts:225](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L225)
+
+Loads a resource as a string.
+
+#### Parameters
+
+| Parameter  | Type             | Default value | Description                            |
+| ---------- | ---------------- | ------------- | -------------------------------------- |
+| `key`      | `string`         | `undefined`   | The resource key                       |
+| `encoding` | `BufferEncoding` | `'utf-8'`     | The encoding to use (default: 'utf-8') |
+
+#### Returns
+
+`string`
+
+The resource content as a string
+
+#### Throws
+
+Error if resource not found
+
+#### Implementation of
+
+```ts
+IResourceManager.loadAsString;
+```
+
+---
+
+### loadAsStringAsync()
+
+```ts
+loadAsStringAsync(key, encoding?): Promise<string>;
+```
+
+Defined in: [resources/ResourceManager.ts:262](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L262)
+
+Loads a resource as a string (asynchronous).
+
+#### Parameters
+
+| Parameter  | Type             | Default value | Description                            |
+| ---------- | ---------------- | ------------- | -------------------------------------- |
+| `key`      | `string`         | `undefined`   | The resource key                       |
+| `encoding` | `BufferEncoding` | `'utf-8'`     | The encoding to use (default: 'utf-8') |
+
+#### Returns
+
+`Promise`\<`string`\>
+
+Promise resolving to the resource content as a string
+
+#### Throws
+
+Error if resource not found
+
+#### Implementation of
+
+```ts
+IResourceManager.loadAsStringAsync;
+```
+
+---
+
+### loadAsync()
+
+```ts
+loadAsync(key): Promise<IResourceResult>;
+```
+
+Defined in: [resources/ResourceManager.ts:166](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L166)
+
+Loads a resource by its key (asynchronous).
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+`Promise`\<[`IResourceResult`](Interface.IResourceResult)\>
+
+Promise resolving to the resource result
+
+#### Throws
+
+Error if resource not found
+
+#### Implementation of
+
+```ts
+IResourceManager.loadAsync;
+```
+
+---
+
+### tryLoad()
+
+```ts
+tryLoad(key): IResourceResult | undefined;
+```
+
+Defined in: [resources/ResourceManager.ts:125](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L125)
+
+Tries to load a resource by its key.
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+[`IResourceResult`](Interface.IResourceResult) \| `undefined`
+
+The resource result or undefined if not found
+
+#### Implementation of
+
+```ts
+IResourceManager.tryLoad;
+```
+
+---
+
+### tryLoadAsBuffer()
+
+```ts
+tryLoadAsBuffer(key): Buffer<ArrayBufferLike> | undefined;
+```
+
+Defined in: [resources/ResourceManager.ts:315](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L315)
+
+Tries to load a resource as a Buffer.
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+`Buffer`\<`ArrayBufferLike`\> \| `undefined`
+
+The resource content as a Buffer or undefined if not found
+
+#### Implementation of
+
+```ts
+IResourceManager.tryLoadAsBuffer;
+```
+
+---
+
+### tryLoadAsBufferAsync()
+
+```ts
+tryLoadAsBufferAsync(key): Promise<Buffer<ArrayBufferLike> | undefined>;
+```
+
+Defined in: [resources/ResourceManager.ts:345](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L345)
+
+Tries to load a resource as a Buffer (asynchronous).
+
+#### Parameters
+
+| Parameter | Type     | Description      |
+| --------- | -------- | ---------------- |
+| `key`     | `string` | The resource key |
+
+#### Returns
+
+`Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `undefined`\>
+
+Promise resolving to the resource content as a Buffer or undefined if not found
+
+#### Implementation of
+
+```ts
+IResourceManager.tryLoadAsBufferAsync;
+```
+
+---
+
+### tryLoadAsString()
+
+```ts
+tryLoadAsString(key, encoding?): string | undefined;
+```
+
+Defined in: [resources/ResourceManager.ts:243](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L243)
+
+Tries to load a resource as a string.
+
+#### Parameters
+
+| Parameter  | Type             | Default value | Description                            |
+| ---------- | ---------------- | ------------- | -------------------------------------- |
+| `key`      | `string`         | `undefined`   | The resource key                       |
+| `encoding` | `BufferEncoding` | `'utf-8'`     | The encoding to use (default: 'utf-8') |
+
+#### Returns
+
+`string` \| `undefined`
+
+The resource content as a string or undefined if not found
+
+#### Implementation of
+
+```ts
+IResourceManager.tryLoadAsString;
+```
+
+---
+
+### tryLoadAsStringAsync()
+
+```ts
+tryLoadAsStringAsync(key, encoding?): Promise<string | undefined>;
+```
+
+Defined in: [resources/ResourceManager.ts:280](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L280)
+
+Tries to load a resource as a string (asynchronous).
+
+#### Parameters
+
+| Parameter  | Type             | Default value | Description                            |
+| ---------- | ---------------- | ------------- | -------------------------------------- |
+| `key`      | `string`         | `undefined`   | The resource key                       |
+| `encoding` | `BufferEncoding` | `'utf-8'`     | The encoding to use (default: 'utf-8') |
+
+#### Returns
+
+`Promise`\<`string` \| `undefined`\>
+
+Promise resolving to the resource content as a string or undefined if not found
+
+#### Implementation of
+
+```ts
+IResourceManager.tryLoadAsStringAsync;
+```
+
+---
+
+### tryLoadAsync()
+
+```ts
+tryLoadAsync(key): Promise<IResourceResult | undefined>;
+```
+
+Defined in: [resources/ResourceManager.ts:183](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L183)
+
+Tries to load 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
+
+```ts
+IResourceManager.tryLoadAsync;
+```
+
+---
+
+### whatDoIHave()
+
+```ts
+whatDoIHave(): void;
+```
+
+Defined in: [resources/ResourceManager.ts:416](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L416)
+
+List all files and folders in the base paths for debugging purposes.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+```ts
+IResourceManager.whatDoIHave;
+```

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

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