@breadstone/archipel-mcp 0.0.14 → 0.0.16

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

@@ -0,0 +1,565 @@
+---
+title: 'Class: ResourceManager'
+generated: true
+editUrl: false
+---
+# Class: ResourceManager
+
+Defined in: [resources/ResourceManager.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/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: [resources/ResourceManager.ts:92](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/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: [resources/ResourceManager.ts:383](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L383)
+
+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:400](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L400)
+
+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:416](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L416)
+
+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:430](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L430)
+
+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:115](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L115)
+
+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:324](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L324)
+
+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:354](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L354)
+
+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:248](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L248)
+
+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:285](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L285)
+
+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:173](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L173)
+
+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:132](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L132)
+
+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:341](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L341)
+
+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:371](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L371)
+
+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:266](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L266)
+
+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:303](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L303)
+
+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:190](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L190)
+
+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:442](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L442)
+
+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,46 @@
+---
+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