npm - @breadstone/archipel-mcp - Versions diffs - 0.0.9 → 0.0.10 - Mend

@breadstone/archipel-mcp 0.0.9 → 0.0.10

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 (565) hide show

package/data/packages/platform-core/api/Class.UUIDGenerator.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Class: UUIDGenerator'
 generated: true
 editUrl: false
 ---
 # Class: UUIDGenerator
 Defined in: [identifiers/generators/UUIDGenerator.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/UUIDGenerator.ts#L14)
@@ -44,9 +43,9 @@ Generates a version 4 UUID (random-based)
 #### Parameters
-| Parameter  | Type     | Description                          |
-| ---------- | -------- | ------------------------------------ |
-| `prefix?`  | `string` | Optional prefix to prepend to the ID |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `prefix?` | `string` | Optional prefix to prepend to the ID |
 | `postfix?` | `string` | Optional postfix to append to the ID |
 #### Returns
@@ -57,7 +56,7 @@ Generates a version 4 UUID (random-based)
 [`IdGeneratorBase`](Class.IdGeneratorBase).[`generate`](Class.IdGeneratorBase#generate)
----
+***
 ### isValid()
@@ -71,9 +70,9 @@ Validates if the provided string is a valid UUID (version 4)
 #### Parameters
-| Parameter | Type     | Description        |
-| --------- | -------- | ------------------ |
-| `id`      | `string` | The ID to validate |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The ID to validate |
 #### Returns

package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Class: UserAvatarGeneratorService'
 generated: true
 editUrl: false
 ---
 # Class: UserAvatarGeneratorService
 Defined in: [services/UserAvatarGenerator.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/UserAvatarGenerator.ts#L14)
@@ -36,10 +35,10 @@ Generates a random avatar as a base64-encoded PNG string.
 #### Parameters
-| Parameter | Type     | Default value | Description                                   |
-| --------- | -------- | ------------- | --------------------------------------------- |
-| `width`   | `number` | `128`         | Width of the avatar in pixels (default: 128)  |
-| `height`  | `number` | `128`         | Height of the avatar in pixels (default: 128) |
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `width` | `number` | `128` | Width of the avatar in pixels (default: 128) |
+| `height` | `number` | `128` | Height of the avatar in pixels (default: 128) |
 #### Returns

package/data/packages/platform-core/api/Class.UserNameGeneratorService.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Class: UserNameGeneratorService'
 generated: true
 editUrl: false
 ---
 # Class: UserNameGeneratorService
 Defined in: [services/UsernameGeneratorService.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/UsernameGeneratorService.ts#L14)
@@ -36,9 +35,9 @@ Generates a random user name.
 #### Parameters
-| Parameter    | Type      | Default value | Description                                              |
-| ------------ | --------- | ------------- | -------------------------------------------------------- |
-| `useNumbers` | `boolean` | `true`        | If true, adds random numbers at the end of the user name |
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `useNumbers` | `boolean` | `true` | If true, adds random numbers at the end of the user name |
 #### Returns
@@ -46,7 +45,7 @@ Generates a random user name.
 A randomly generated user name
----
+***
 ### generateSecure()

package/data/packages/platform-core/api/Function.Public.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Function: Public()'
 generated: true
 editUrl: false
 ---
 # Function: Public()
 ```ts

package/data/packages/platform-core/api/Function.createConfigKey.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Function: createConfigKey()'
 generated: true
 editUrl: false
 ---
 # Function: createConfigKey()
 ```ts
@@ -20,21 +19,21 @@ This ensures you don’t scatter raw strings and you assign a type to each key.
 ## Type Parameters
 | Type Parameter | Default type |
-| -------------- | ------------ |
-| `TType`        | `unknown`    |
+| ------ | ------ |
+| `TType` | `unknown` |
 ## Parameters
-| Parameter | Type     | Description                                                                                                               |
-| --------- | -------- | ------------------------------------------------------------------------------------------------------------------------- |
-| `key`     | `string` | – The unique string identifier for the config entry. For example: `'DATABASE_URL'`, `'featureX.enabled'`, `'timeout.ms'`. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | – The unique string identifier for the config entry. For example: `'DATABASE_URL'`, `'featureX.enabled'`, `'timeout.ms'`. |
 ## Returns
 [`IConfigKey`](Interface.IConfigKey)\<`TType`\>
 A branded config key of type `IConfigKey<TType>` where `TType` is
-inferred (or specified) as the expected type of the value.
+         inferred (or specified) as the expected type of the value.
 ## Example
@@ -46,9 +45,8 @@ export const FEATURE_X_ENABLED = createConfigKey<boolean>('FEATURE_X_ENABLED');
 ```
 Then, when fetching:
 ```ts
-const url = configService.get(DATABASE_URL); // typed as string
+const url = configService.get(DATABASE_URL);       // typed as string
 const timeout = configService.get(MAX_TIMEOUT_MS); // typed as number
 const enabled = configService.get(FEATURE_X_ENABLED); // typed as boolean
 ```

package/data/packages/platform-core/api/Function.createEventKey.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Function: createEventKey()'
 generated: true
 editUrl: false
 ---
 # Function: createEventKey()
 ```ts
@@ -16,15 +15,15 @@ Creates a branded event key for the [EventHub](Class.EventHub).
 ## Type Parameters
-| Type Parameter                                         |
-| ------------------------------------------------------ |
-| `TEvents` _extends_ [`IEventMap`](Interface.IEventMap) |
-| `TKey` _extends_ `string` \| `number` \| `symbol`      |
+| Type Parameter |
+| ------ |
+| `TEvents` *extends* [`IEventMap`](Interface.IEventMap) |
+| `TKey` *extends* `string` \| `number` \| `symbol` |
 ## Parameters
-| Parameter   | Type   | Description                   |
-| ----------- | ------ | ----------------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `eventName` | `TKey` | The unique name of the event. |
 ## Returns

package/data/packages/platform-core/api/Function.createMappingKey.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Function: createMappingKey()'
 generated: true
 editUrl: false
 ---
 # Function: createMappingKey()
 ```ts
@@ -17,15 +16,15 @@ Creates a type-safe mapping key.
 ## Type Parameters
 | Type Parameter |
-| -------------- |
-| `TInput`       |
-| `TOutput`      |
+| ------ |
+| `TInput` |
+| `TOutput` |
 ## Parameters
-| Parameter | Type     | Description                                   |
-| --------- | -------- | --------------------------------------------- |
-| `key`     | `string` | The unique string identifier for the mapping. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The unique string identifier for the mapping. |
 ## Returns

package/data/packages/platform-core/api/Function.env.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Function: env()'
 generated: true
 editUrl: false
 ---
 # Function: env()
 ```ts
@@ -19,10 +18,10 @@ later search/grep all `env` usages in the codebase.
 ## Parameters
-| Parameter   | Type                   |
-| ----------- | ---------------------- |
-| `strings`   | `TemplateStringsArray` |
-| ...`values` | `unknown`[]            |
+| Parameter | Type |
+| ------ | ------ |
+| `strings` | `TemplateStringsArray` |
+| ...`values` | `unknown`[] |
 ## Returns

package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Function: getMimeTypeByFileNameOrExtension()'
 generated: true
 editUrl: false
 ---
 # Function: getMimeTypeByFileNameOrExtension()
 ```ts
@@ -16,8 +15,8 @@ Get MIME type by file name or extension.
 ## Parameters
-| Parameter | Type         | Description                     |
-| --------- | ------------ | ------------------------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | ...`args` | \[`string`\] | Arguments for mime-types lookup |
 ## Returns

package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Function: isActionId()'
 generated: true
 editUrl: false
 ---
 # Function: isActionId()
 ```ts
@@ -16,10 +15,10 @@ Checks if the action id is valid.
 ## Parameters
-| Parameter | Type     | Description          |
-| --------- | -------- | -------------------- |
-| `key`     | `string` | The key to check.    |
-| `action`  | `string` | The action to check. |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The key to check. |
+| `action` | `string` | The action to check. |
 ## Returns

package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Interface: IBlobResourceStrategyConfig'
 generated: true
 editUrl: false
 ---
 # Interface: IBlobResourceStrategyConfig
 Defined in: [resources/strategies/BlobResourceStrategy.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L36)
@@ -25,5 +24,5 @@ Optional key prefix for blob storage.
 #### Example
 ```ts
-('resources/', 'templates/');
+'resources/', 'templates/'
 ```

package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Interface: IBlobServiceAdapter'
 generated: true
 editUrl: false
 ---
 # Interface: IBlobServiceAdapter
 Defined in: [resources/strategies/BlobResourceStrategy.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L14)
@@ -27,15 +26,15 @@ Downloads a file from blob storage.
 #### Parameters
-| Parameter | Type     | Description  |
-| --------- | -------- | ------------ |
-| `key`     | `string` | The blob key |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The blob key |
 #### Returns
 `Promise`\<\{
-`contentType?`: `string`;
-`data`: `unknown`;
+  `contentType?`: `string`;
+  `data`: `unknown`;
 \}\>
 The download result

package/data/packages/platform-core/api/Interface.IConfigKey.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Interface: IConfigKey\<TType\>'
 generated: true
 editUrl: false
 ---
 # Interface: IConfigKey\<TType\>
 Defined in: [config/ConfigKey.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigKey.ts#L27)
@@ -13,29 +12,29 @@ A type-safe config key that encodes both the config key and the type of its valu
 **Why this exists**: In large codebases it is common for configuration values
 (environment variables, feature flags, constants) to be accessed directly via
 raw strings or via `process.env['SOME_KEY']`. This leads to several issues:
-• scattered literal strings making refactoring and discovery difficult,
-• lack of compile-time checking for correct key names,
-• no guarantee about the type of the value retrieved (string, number, boolean, etc),
-• difficulty enforcing a consistent mechanism for configuration access.
+  • scattered literal strings making refactoring and discovery difficult,
+  • lack of compile-time checking for correct key names,
+  • no guarantee about the type of the value retrieved (string, number, boolean, etc),
+  • difficulty enforcing a consistent mechanism for configuration access.
 To address these, we introduce a **typed config-key abstraction**:
-– each config key is defined once (via createConfigKey),
-– the `IConfigKey<TType>` carries at compile time the expected type of its value,
-– the runtime shape remains minimal (just a `key: string`),
-– developers are encouraged to use a central `ConfigService` to fetch values,
-rather than scattering `process.env[...]` everywhere.
+  – each config key is defined once (via createConfigKey),
+  – the `IConfigKey<TType>` carries at compile time the expected type of its value,
+  – the runtime shape remains minimal (just a `key: string`),
+  – developers are encouraged to use a central `ConfigService` to fetch values,
+    rather than scattering `process.env[...]` everywhere.
 This improves:
-– discoverability (IDE autocomplete, “find usages” works),
-– safety (correct key names, correct value types),
-– maintainability (single source of truth for config keys),
-– clarity (developers see intent: “this key returns a number”, “this key returns a boolean”).
+  – discoverability (IDE autocomplete, “find usages” works),
+  – safety (correct key names, correct value types),
+  – maintainability (single source of truth for config keys),
+  – clarity (developers see intent: “this key returns a number”, “this key returns a boolean”).
 ## Type Parameters
 | Type Parameter | Default type |
-| -------------- | ------------ |
-| `TType`        | `unknown`    |
+| ------ | ------ |
+| `TType` | `unknown` |
 ## Properties
@@ -50,7 +49,7 @@ Defined in: [config/ConfigKey.ts:33](https://github.com/RueDeRennes/archipel/blo
 Phantom generic to encode the expected value type. This property
 is never intended to be used at runtime.
----
+***
 ### key

package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Interface: IConfigModuleOptions'
 generated: true
 editUrl: false
 ---
 # Interface: IConfigModuleOptions
 Defined in: [config/ConfigModule.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigModule.ts#L15)
@@ -20,7 +19,7 @@ optional statics?: Record<string, string>;
 Defined in: [config/ConfigModule.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigModule.ts#L17)
----
+***
 ### strategyFactory?
@@ -32,8 +31,8 @@ Defined in: [config/ConfigModule.ts:16](https://github.com/RueDeRennes/archipel/
 #### Parameters
-| Parameter | Type    |
-| --------- | ------- |
+| Parameter | Type |
+| ------ | ------ |
 | ...`args` | `any`[] |
 #### Returns

package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Interface: IConfigRegistryEntry\<TType\>'
 generated: true
 editUrl: false
 ---
 # Interface: IConfigRegistryEntry\<TType\>
 Defined in: [config/ConfigRegistry.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigRegistry.ts#L13)
@@ -14,8 +13,8 @@ whether the entry is required or optional (with a default value).
 ## Type Parameters
 | Type Parameter | Default type |
-| -------------- | ------------ |
-| `TType`        | `unknown`    |
+| ------ | ------ |
+| `TType` | `unknown` |
 ## Properties
@@ -30,7 +29,7 @@ Defined in: [config/ConfigRegistry.ts:34](https://github.com/RueDeRennes/archipe
 An optional default value used when the key is not set.
 Only meaningful when `required` is `false`.
----
+***
 ### description?
@@ -42,7 +41,7 @@ Defined in: [config/ConfigRegistry.ts:39](https://github.com/RueDeRennes/archipe
 An optional human-readable description of the configuration entry.
----
+***
 ### key
@@ -54,7 +53,7 @@ Defined in: [config/ConfigRegistry.ts:17](https://github.com/RueDeRennes/archipe
 The typed configuration key.
----
+***
 ### module
@@ -66,7 +65,7 @@ Defined in: [config/ConfigRegistry.ts:22](https://github.com/RueDeRennes/archipe
 The name of the module that registered this key (e.g. `'platform-authentication'`).
----
+***
 ### required

package/data/packages/platform-core/api/Interface.IDeviceInfo.md CHANGED Viewed

@@ -3,7 +3,6 @@ title: 'Interface: IDeviceInfo'
 generated: true
 editUrl: false
 ---
 # Interface: IDeviceInfo
 Defined in: [services/DeviceParserService.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L13)
@@ -20,7 +19,7 @@ browserName: string;
 Defined in: [services/DeviceParserService.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L17)
----
+***
 ### browserVersion
@@ -30,7 +29,7 @@ browserVersion: string | null;
 Defined in: [services/DeviceParserService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L18)
----
+***
 ### deviceName
@@ -40,7 +39,7 @@ deviceName: string;
 Defined in: [services/DeviceParserService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L16)
----
+***
 ### deviceType
@@ -50,7 +49,7 @@ deviceType: string;
 Defined in: [services/DeviceParserService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L15)
----
+***
 ### osName
@@ -60,7 +59,7 @@ osName: string;
 Defined in: [services/DeviceParserService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L19)
----
+***
 ### osVersion
@@ -70,7 +69,7 @@ osVersion: string | null;
 Defined in: [services/DeviceParserService.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/DeviceParserService.ts#L20)
----
+***
 ### userAgent