npm - @breadstone/archipel-mcp - Versions diffs - 0.0.11 → 0.0.14 - Mend

@breadstone/archipel-mcp 0.0.11 → 0.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (604) hide show

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

@@ -1,565 +0,0 @@
----
-title: 'Class: ResourceManager'
-generated: true
-editUrl: false
----
-# Class: ResourceManager
-Defined in: [resources/ResourceManager.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L68)
-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:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L85)
-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:359](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L359)
-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:376](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L376)
-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:392](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L392)
-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:406](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L406)
-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:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L107)
-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:300](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L300)
-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:330](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L330)
-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:224](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L224)
-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:261](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L261)
-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:165](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L165)
-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:124](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L124)
-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:317](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L317)
-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:347](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L347)
-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:242](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L242)
-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:279](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L279)
-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:182](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L182)
-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:418](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/ResourceManager.ts#L418)
-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 DELETED Viewed

@@ -1,46 +0,0 @@
----
-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