@breadstone/archipel-mcp 0.0.1

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

@@ -0,0 +1,116 @@
+---
+title: 'Class: ConfigRegistry'
+generated: true
+editUrl: false
+---
+
+# Class: ConfigRegistry
+
+Defined in: [config/ConfigRegistry.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigRegistry.ts#L53)
+
+A static, global registry that collects all configuration keys registered by
+platform libraries. This enables a central overview of every environment
+variable the application depends on, grouped by source module.
+
+Libraries register their keys during module initialisation via
+[ConfigModule.register](Class.ConfigModule#register) or by calling [ConfigRegistry.register](#register)
+directly.
+
+## Constructors
+
+### Constructor
+
+```ts
+new ConfigRegistry(): ConfigRegistry;
+```
+
+#### Returns
+
+`ConfigRegistry`
+
+## Methods
+
+### getAll()
+
+```ts
+static getAll(): readonly IConfigRegistryEntry<unknown>[];
+```
+
+Defined in: [config/ConfigRegistry.ts:78](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigRegistry.ts#L78)
+
+Returns all registered configuration entries as a flat array.
+
+#### Returns
+
+readonly [`IConfigRegistryEntry`](Interface.IConfigRegistryEntry)\<`unknown`\>[]
+
+---
+
+### getByModule()
+
+```ts
+static getByModule(): ReadonlyMap<string, readonly IConfigRegistryEntry<unknown>[]>;
+```
+
+Defined in: [config/ConfigRegistry.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigRegistry.ts#L85)
+
+Returns all registered entries grouped by their source module.
+
+#### Returns
+
+`ReadonlyMap`\<`string`, readonly [`IConfigRegistryEntry`](Interface.IConfigRegistryEntry)\<`unknown`\>[]\>
+
+---
+
+### getModules()
+
+```ts
+static getModules(): readonly string[];
+```
+
+Defined in: [config/ConfigRegistry.ts:110](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigRegistry.ts#L110)
+
+Returns all unique module names that have registered keys.
+
+#### Returns
+
+readonly `string`[]
+
+---
+
+### getRequired()
+
+```ts
+static getRequired(): readonly IConfigRegistryEntry<unknown>[];
+```
+
+Defined in: [config/ConfigRegistry.ts:103](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigRegistry.ts#L103)
+
+Returns all registered entries whose `required` flag is `true`.
+
+#### Returns
+
+readonly [`IConfigRegistryEntry`](Interface.IConfigRegistryEntry)\<`unknown`\>[]
+
+---
+
+### register()
+
+```ts
+static register(module, entries): void;
+```
+
+Defined in: [config/ConfigRegistry.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigRegistry.ts#L68)
+
+Registers one or more configuration entries.
+
+#### Parameters
+
+| Parameter | Type                                                                                                   | Description                                          |
+| --------- | ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------- |
+| `module`  | `string`                                                                                               | The logical module name (e.g. `'platform-mailing'`). |
+| `entries` | readonly `Omit`\<[`IConfigRegistryEntry`](Interface.IConfigRegistryEntry)\<`unknown`\>, `"module"`\>[] | The configuration entries to register.               |
+
+#### Returns
+
+`void`

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

@@ -0,0 +1,139 @@
+---
+title: 'Class: ConfigService'
+generated: true
+editUrl: false
+---
+
+# Class: ConfigService
+
+Defined in: [config/services/ConfigService.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/services/ConfigService.ts#L9)
+
+## Constructors
+
+### Constructor
+
+```ts
+new ConfigService(strategy, statics): ConfigService;
+```
+
+Defined in: [config/services/ConfigService.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/services/ConfigService.ts#L20)
+
+#### Parameters
+
+| Parameter  | Type                                             |
+| ---------- | ------------------------------------------------ |
+| `strategy` | [`ConfigStrategyBase`](Class.ConfigStrategyBase) |
+| `statics`  | `Record`\<`string`, `string`\>                   |
+
+#### Returns
+
+`ConfigService`
+
+## Methods
+
+### compare()
+
+```ts
+compare<T>(key, value): boolean;
+```
+
+Defined in: [config/services/ConfigService.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/services/ConfigService.ts#L81)
+
+Compares the value of the specified configuration key with the given value.
+
+#### Type Parameters
+
+| Type Parameter | Default type | Description                            |
+| -------------- | ------------ | -------------------------------------- |
+| `T`            | `string`     | Expected type of the comparison value. |
+
+#### Parameters
+
+| Parameter | Type     | Description                       |
+| --------- | -------- | --------------------------------- |
+| `key`     | `string` | The configuration key to compare. |
+| `value`   | `T`      | The value to compare against.     |
+
+#### Returns
+
+`boolean`
+
+True if the resolved value matches; otherwise, false.
+
+---
+
+### get()
+
+```ts
+get<T>(key): T;
+```
+
+Defined in: [config/services/ConfigService.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/services/ConfigService.ts#L45)
+
+Retrieves the parsed value of the specified configuration key.
+
+Automatically parses strings into numbers, booleans, or null if applicable.
+
+#### Type Parameters
+
+| Type Parameter | Default type | Description                          |
+| -------------- | ------------ | ------------------------------------ |
+| `T`            | `string`     | Expected type of the returned value. |
+
+#### Parameters
+
+| Parameter | Type     | Description                        |
+| --------- | -------- | ---------------------------------- |
+| `key`     | `string` | The configuration key to retrieve. |
+
+#### Returns
+
+`T`
+
+The parsed configuration value.
+
+---
+
+### initialize()
+
+```ts
+initialize(): void;
+```
+
+Defined in: [config/services/ConfigService.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/services/ConfigService.ts#L32)
+
+#### Returns
+
+`void`
+
+---
+
+### tryGet()
+
+```ts
+tryGet<T>(key, fallback): T;
+```
+
+Defined in: [config/services/ConfigService.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/services/ConfigService.ts#L65)
+
+Attempts to retrieve the value of the specified configuration key.
+If the key does not exist, returns the provided fallback value.
+
+#### Type Parameters
+
+| Type Parameter | Default type | Description                          |
+| -------------- | ------------ | ------------------------------------ |
+| `T`            | `string`     | Expected type of the returned value. |
+
+#### Parameters
+
+| Parameter  | Type     | Description                                           |
+| ---------- | -------- | ----------------------------------------------------- |
+| `key`      | `string` | The configuration key to retrieve.                    |
+| `fallback` | `T`      | The fallback value to return if the key is not found. |
+
+#### Returns
+
+`T`
+
+The resolved configuration value or the fallback value.

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

@@ -0,0 +1,110 @@
+---
+title: 'Abstract Class: ConfigStrategyBase'
+generated: true
+editUrl: false
+---
+
+# Abstract Class: ConfigStrategyBase
+
+Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/Abstracts/ConfigStrategyBase.ts#L8)
+
+The `ConfigStrategyBase` class.
+Represents the base class for configuration strategies.
+
+## Extended by
+
+- [`EnvironmentConfigStrategy`](Class.EnvironmentConfigStrategy)
+- [`FileConfigStrategy`](Class.FileConfigStrategy)
+
+## Methods
+
+### has()
+
+```ts
+abstract has(key): boolean;
+```
+
+Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/Abstracts/ConfigStrategyBase.ts#L38)
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `key`     | `string` |
+
+#### Returns
+
+`boolean`
+
+---
+
+### initialize()
+
+```ts
+abstract initialize(): void;
+```
+
+Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/Abstracts/ConfigStrategyBase.ts#L26)
+
+`initialize` - Initializes the configuration.
+
+#### Returns
+
+`void`
+
+---
+
+### resolve()
+
+```ts
+abstract resolve<T>(key): T;
+```
+
+Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/Abstracts/ConfigStrategyBase.ts#L34)
+
+`resolve` - Resolves the configuration.
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+
+#### Parameters
+
+| Parameter | Type     | Description         |
+| --------- | -------- | ------------------- |
+| `key`     | `string` | The key to resolve. |
+
+#### Returns
+
+`T`
+
+The resolved configuration value.
+
+---
+
+### tryResolve()
+
+```ts
+abstract tryResolve<T>(key, fallback): T;
+```
+
+Defined in: [config/strategies/Abstracts/ConfigStrategyBase.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/strategies/Abstracts/ConfigStrategyBase.ts#L36)
+
+#### Type Parameters
+
+| Type Parameter |
+| -------------- |
+| `T`            |
+
+#### Parameters
+
+| Parameter  | Type     |
+| ---------- | -------- |
+| `key`      | `string` |
+| `fallback` | `T`      |
+
+#### Returns
+
+`T`

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

@@ -0,0 +1,64 @@
+---
+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:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/templates/ContentTemplateEngine.ts#L26)
+
+Constructs a new instance of the `ContentTemplateEngine` class.
+
+#### Returns
+
+`ContentTemplateEngine`
+
+## Methods
+
+### compileTemplate()
+
+```ts
+compileTemplate(content, params): string;
+```
+
+Defined in: [templates/ContentTemplateEngine.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/templates/ContentTemplateEngine.ts#L45)
+
+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.CryptoService.md

@@ -0,0 +1,50 @@
+---
+title: 'Class: CryptoService'
+generated: true
+editUrl: false
+---
+
+# Class: CryptoService
+
+Defined in: [services/CryptoService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/CryptoService.ts#L15)
+
+The `CryptoService` class.
+Represents the service that provides cryptographic operations.
+
+## Constructors
+
+### Constructor
+
+```ts
+new CryptoService(): CryptoService;
+```
+
+Defined in: [services/CryptoService.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/CryptoService.ts#L22)
+
+Initializes a new instance of the `CryptoService` class.
+
+#### Returns
+
+`CryptoService`
+
+## Methods
+
+### getRandomGuid()
+
+```ts
+getRandomGuid(prefix): string;
+```
+
+Defined in: [services/CryptoService.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/CryptoService.ts#L36)
+
+Hashes the given data.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `prefix`  | `string` |
+
+#### Returns
+
+`string`

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

@@ -0,0 +1,102 @@
+---
+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,53 @@
+---
+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:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L44)
+
+Constructs a new instance of the `DeviceParserService` class.
+
+#### Returns
+
+`DeviceParserService`
+
+## Methods
+
+### parse()
+
+```ts
+parse(userAgent): IDeviceInfo;
+```
+
+Defined in: [services/DeviceParserService.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L59)
+
+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