@breadstone/archipel-mcp 0.0.14 → 0.0.16

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

@@ -0,0 +1,93 @@
+---
+title: 'Class: CasingInterceptor'
+generated: true
+editUrl: false
+---
+# Class: CasingInterceptor
+
+Defined in: [interceptors/CasingInterceptor.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/interceptors/CasingInterceptor.ts#L27)
+
+Global NestJS interceptor that normalizes property casing across the HTTP boundary.
+
+**Request (inbound):** Converts `snake_case` (or other casing styles) keys in the
+request body to `camelCase` before they reach controllers.
+
+**Response (outbound):** Currently passes data through unchanged. If outbound
+transformation is needed in the future, it can be added in the `map` operator.
+
+## Remarks
+
+Because this interceptor is applied globally, **all JSON request bodies are
+camelCase-normalized** and **all JSON responses use camelCase property names**.
+OpenAPI / Swagger schemas therefore always reflect camelCase keys.
+
+## Implements
+
+- `NestInterceptor`
+
+## Constructors
+
+### Constructor
+
+```ts
+new CasingInterceptor(): CasingInterceptor;
+```
+
+#### Returns
+
+`CasingInterceptor`
+
+## Methods
+
+### intercept()
+
+```ts
+intercept(context, next): Observable<unknown>;
+```
+
+Defined in: [interceptors/CasingInterceptor.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/interceptors/CasingInterceptor.ts#L28)
+
+Method to implement a custom interceptor.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `context` | `ExecutionContext` | an `ExecutionContext` object providing methods to access the route handler and class about to be invoked. |
+| `next` | `CallHandler` | a reference to the `CallHandler`, which provides access to an `Observable` representing the response stream from the route handler. |
+
+#### Returns
+
+`Observable`\<`unknown`\>
+
+#### Implementation of
+
+```ts
+NestInterceptor.intercept
+```
+
+***
+
+### process()
+
+```ts
+process<T>(value): T;
+```
+
+Defined in: [interceptors/CasingInterceptor.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/interceptors/CasingInterceptor.ts#L47)
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `T` |
+
+#### Returns
+
+`T`

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

@@ -0,0 +1,93 @@
+---
+title: 'Class: CatchUtils'
+generated: true
+editUrl: false
+---
+# Class: CatchUtils
+
+Defined in: [utils/CatchUtils.ts:2](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/CatchUtils.ts#L2)
+
+## Constructors
+
+### Constructor
+
+```ts
+new CatchUtils(): CatchUtils;
+```
+
+#### Returns
+
+`CatchUtils`
+
+## Methods
+
+### catch()
+
+```ts
+static catch<T>(input, handler): void;
+```
+
+Defined in: [utils/CatchUtils.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/CatchUtils.ts#L6)
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` *extends* `Error` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `input` | `unknown` |
+| `handler` | (`error`) => `Error` |
+
+#### Returns
+
+`void`
+
+***
+
+### catchError()
+
+```ts
+static catchError<T>(promise): Promise<[undefined, T] | [Error]>;
+```
+
+Defined in: [utils/CatchUtils.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/CatchUtils.ts#L12)
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `promise` | `Promise`\<`T`\> |
+
+#### Returns
+
+`Promise`\<\[`undefined`, `T`\] \| \[`Error`\]\>
+
+***
+
+### isError()
+
+```ts
+static isError(value): value is Error;
+```
+
+Defined in: [utils/CatchUtils.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/CatchUtils.ts#L18)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `value` | `unknown` |
+
+#### Returns
+
+`value is Error`

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

@@ -0,0 +1,63 @@
+---
+title: 'Class: ContentTemplateEngine'
+generated: true
+editUrl: false
+---
+# Class: ContentTemplateEngine
+
+Defined in: [templates/ContentTemplateEngine.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/templates/ContentTemplateEngine.ts#L17)
+
+The `ContentTemplateEngine` class.
+
+## Constructors
+
+### Constructor
+
+```ts
+new ContentTemplateEngine(): ContentTemplateEngine;
+```
+
+Defined in: [templates/ContentTemplateEngine.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/templates/ContentTemplateEngine.ts#L25)
+
+Constructs a new instance of the `ContentTemplateEngine` class.
+
+#### Returns
+
+`ContentTemplateEngine`
+
+## Methods
+
+### compileTemplate()
+
+```ts
+compileTemplate(content, params): string;
+```
+
+Defined in: [templates/ContentTemplateEngine.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/templates/ContentTemplateEngine.ts#L44)
+
+Compiles a template by replacing placeholders with the provided parameters.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `content` | `string` | The content of the template to compile. |
+| `params` | `Record`\<`string`, `unknown`\> | The parameters to insert into the template. |
+
+#### Returns
+
+`string`
+
+The compiled template as a string.
+
+#### Throws
+
+GeneralTemplateValidationError if the template validation fails.
+
+#### Throws
+
+UnmatchedBlockError if template blocks are unmatched.
+
+#### Throws
+
+MissingPlaceholderError if placeholders are missing.

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

@@ -0,0 +1,101 @@
+---
+title: 'Class: DateTimeUtils'
+generated: true
+editUrl: false
+---
+# Class: DateTimeUtils
+
+Defined in: [utils/DateTimeUtils.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/DateTimeUtils.ts#L28)
+
+TimeSpan Utility Class.
+Provides methods to parse and format time span values.
+
+## Constructors
+
+### Constructor
+
+```ts
+new DateTimeUtils(): DateTimeUtils;
+```
+
+#### Returns
+
+`DateTimeUtils`
+
+## Methods
+
+### convert()
+
+```ts
+static convert(value, options?): string | number;
+```
+
+Defined in: [utils/DateTimeUtils.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/DateTimeUtils.ts#L37)
+
+Converts a time span value (string or number) to milliseconds or a formatted string.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | `number` \| [`StringValue`](TypeAlias.StringValue) | The time span value to convert |
+| `options?` | `Options` | Options for formatting the output |
+
+#### Returns
+
+`string` \| `number`
+
+The parsed time in milliseconds or formatted time string
+
+***
+
+### format()
+
+```ts
+static format(ms, options?): string;
+```
+
+Defined in: [utils/DateTimeUtils.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/DateTimeUtils.ts#L79)
+
+Formats a number of milliseconds into a string representation.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `ms` | `number` | The milliseconds to format |
+| `options?` | `Options` | Options for formatting the output |
+
+#### Returns
+
+`string`
+
+The formatted time span string
+
+***
+
+### parse()
+
+```ts
+static parse(value): number;
+```
+
+Defined in: [utils/DateTimeUtils.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/DateTimeUtils.ts#L53)
+
+Parses a time span string to milliseconds.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `value` | [`StringValue`](TypeAlias.StringValue) | The time span string to parse |
+
+#### Returns
+
+`number`
+
+The time span in milliseconds
+
+#### Throws
+
+Error if the string is invalid

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

@@ -0,0 +1,52 @@
+---
+title: 'Class: DeviceParserService'
+generated: true
+editUrl: false
+---
+# Class: DeviceParserService
+
+Defined in: [services/DeviceParserService.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L31)
+
+The `DeviceParserService` class.
+
+Service responsible for parsing User-Agent strings and extracting device information.
+
+## Constructors
+
+### Constructor
+
+```ts
+new DeviceParserService(): DeviceParserService;
+```
+
+Defined in: [services/DeviceParserService.ts:43](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L43)
+
+Constructs a new instance of the `DeviceParserService` class.
+
+#### Returns
+
+`DeviceParserService`
+
+## Methods
+
+### parse()
+
+```ts
+parse(userAgent): IDeviceInfo;
+```
+
+Defined in: [services/DeviceParserService.ts:58](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L58)
+
+Parse User-Agent string and extract device information
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `userAgent` | `string` | The User-Agent header string |
+
+#### Returns
+
+[`IDeviceInfo`](Interface.IDeviceInfo)
+
+Parsed device information

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

@@ -0,0 +1,215 @@
+---
+title: 'Class: EmbeddedResourceStrategy'
+generated: true
+editUrl: false
+---
+# Class: EmbeddedResourceStrategy
+
+Defined in: [resources/strategies/EmbeddedResourceStrategy.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L14)
+
+Strategy for loading embedded resources from memory.
+
+## Implements
+
+- [`IResourceStrategy`](Interface.IResourceStrategy)
+
+## Constructors
+
+### Constructor
+
+```ts
+new EmbeddedResourceStrategy(resources?): EmbeddedResourceStrategy;
+```
+
+Defined in: [resources/strategies/EmbeddedResourceStrategy.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L30)
+
+Constructs a new instance of the `EmbeddedResourceStrategy` class.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `resources` | `Record`\<`string`, `string`\> |
+
+#### Returns
+
+`EmbeddedResourceStrategy`
+
+## Accessors
+
+### name
+
+#### Get Signature
+
+```ts
+get name(): string;
+```
+
+Defined in: [resources/strategies/EmbeddedResourceStrategy.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L38)
+
+The unique name of this strategy.
+
+##### Returns
+
+`string`
+
+The unique name of this strategy.
+
+#### Implementation of
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`name`](Interface.IResourceStrategy#name)
+
+## Methods
+
+### exists()
+
+```ts
+exists(key): boolean;
+```
+
+Defined in: [resources/strategies/EmbeddedResourceStrategy.ts:94](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L94)
+
+Checks if a resource exists without loading it.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The resource key |
+
+#### Returns
+
+`boolean`
+
+True if the resource exists
+
+#### Implementation of
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`exists`](Interface.IResourceStrategy#exists)
+
+***
+
+### existsAsync()
+
+```ts
+existsAsync(key): Promise<boolean>;
+```
+
+Defined in: [resources/strategies/EmbeddedResourceStrategy.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L105)
+
+Checks if a resource exists without loading it (asynchronous).
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The resource key |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+Promise resolving to true if the resource exists
+
+#### Implementation of
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`existsAsync`](Interface.IResourceStrategy#existsasync)
+
+***
+
+### load()
+
+```ts
+load(key): IResourceResult | undefined;
+```
+
+Defined in: [resources/strategies/EmbeddedResourceStrategy.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L53)
+
+Loads 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
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`load`](Interface.IResourceStrategy#load)
+
+***
+
+### loadAsync()
+
+```ts
+loadAsync(key): Promise<IResourceResult | undefined>;
+```
+
+Defined in: [resources/strategies/EmbeddedResourceStrategy.ts:83](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L83)
+
+Loads 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
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`loadAsync`](Interface.IResourceStrategy#loadasync)
+
+***
+
+### register()
+
+```ts
+register(key, content): void;
+```
+
+Defined in: [resources/strategies/EmbeddedResourceStrategy.ts:116](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L116)
+
+Registers a new embedded resource.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The resource key |
+| `content` | `string` | The resource content |
+
+#### Returns
+
+`void`
+
+***
+
+### whatDoIHave()
+
+```ts
+whatDoIHave(): void;
+```
+
+Defined in: [resources/strategies/EmbeddedResourceStrategy.ts:125](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/EmbeddedResourceStrategy.ts#L125)
+
+List all files and folders in the base paths for debugging purposes.
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`IResourceStrategy`](Interface.IResourceStrategy).[`whatDoIHave`](Interface.IResourceStrategy#whatdoihave)