@breadstone/archipel-mcp 0.0.13 → 0.0.15

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

@@ -1,42 +0,0 @@
----
-title: 'Abstract Class: TimeStampResponse'
-generated: true
-editUrl: false
----
-# Abstract Class: TimeStampResponse
-
-Defined in: [models/response/TimeStampResponse.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/TimeStampResponse.ts#L15)
-
-The base class for all time stamp responses.
-
-## Constructors
-
-### Constructor
-
-```ts
-new TimeStampResponse(): TimeStampResponse;
-```
-
-#### Returns
-
-`TimeStampResponse`
-
-## Properties
-
-### createdAt
-
-```ts
-createdAt: Date;
-```
-
-Defined in: [models/response/TimeStampResponse.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/TimeStampResponse.ts#L25)
-
-***
-
-### updatedAt
-
-```ts
-updatedAt: Date;
-```
-
-Defined in: [models/response/TimeStampResponse.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/TimeStampResponse.ts#L32)

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

@@ -1,57 +0,0 @@
----
-title: 'Class: TypeMappingNotRegisteredError'
-generated: true
-editUrl: false
----
-# Class: TypeMappingNotRegisteredError
-
-Defined in: [mapping/errors/TypeMappingNotRegisteredError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/errors/TypeMappingNotRegisteredError.ts#L12)
-
-Thrown when a type mapping is requested but not registered.
-
-## Extends
-
-- `MappingError`
-
-## Constructors
-
-### Constructor
-
-```ts
-new TypeMappingNotRegisteredError(source, destination): TypeMappingNotRegisteredError;
-```
-
-Defined in: [mapping/errors/TypeMappingNotRegisteredError.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/errors/TypeMappingNotRegisteredError.ts#L16)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `source` | `string` |
-| `destination` | `string` |
-
-#### Returns
-
-`TypeMappingNotRegisteredError`
-
-#### Overrides
-
-```ts
-MappingError.constructor
-```
-
-## Properties
-
-### code
-
-```ts
-readonly code: string;
-```
-
-Defined in: [mapping/errors/MappingError.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/errors/MappingError.ts#L11)
-
-#### Inherited from
-
-```ts
-MappingError.code
-```

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

@@ -1,85 +0,0 @@
----
-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)
-
-UUID Generator class
-
-## Extends
-
-- [`IdGeneratorBase`](Class.IdGeneratorBase)
-
-## Constructors
-
-### Constructor
-
-```ts
-new UUIDGenerator(): UUIDGenerator;
-```
-
-#### Returns
-
-`UUIDGenerator`
-
-#### Inherited from
-
-[`IdGeneratorBase`](Class.IdGeneratorBase).[`constructor`](Class.IdGeneratorBase#constructor)
-
-## Methods
-
-### generate()
-
-```ts
-generate(prefix?, postfix?): string;
-```
-
-Defined in: [identifiers/generators/UUIDGenerator.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/UUIDGenerator.ts#L23)
-
-Generates a version 4 UUID (random-based)
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `prefix?` | `string` | Optional prefix to prepend to the ID |
-| `postfix?` | `string` | Optional postfix to append to the ID |
-
-#### Returns
-
-`string`
-
-#### Overrides
-
-[`IdGeneratorBase`](Class.IdGeneratorBase).[`generate`](Class.IdGeneratorBase#generate)
-
-***
-
-### isValid()
-
-```ts
-isValid(id): boolean;
-```
-
-Defined in: [identifiers/generators/UUIDGenerator.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/identifiers/generators/UUIDGenerator.ts#L39)
-
-Validates if the provided string is a valid UUID (version 4)
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `id` | `string` | The ID to validate |
-
-#### Returns
-
-`boolean`
-
-True if the ID is valid, otherwise false
-
-#### Overrides
-
-[`IdGeneratorBase`](Class.IdGeneratorBase).[`isValid`](Class.IdGeneratorBase#isvalid)

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

@@ -1,47 +0,0 @@
----
-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)
-
-Service for generating GitHub-style identicon avatars.
-
-## Constructors
-
-### Constructor
-
-```ts
-new UserAvatarGeneratorService(): UserAvatarGeneratorService;
-```
-
-#### Returns
-
-`UserAvatarGeneratorService`
-
-## Methods
-
-### generate()
-
-```ts
-generate(width?, height?): Promise<string>;
-```
-
-Defined in: [services/UserAvatarGenerator.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/UserAvatarGenerator.ts#L32)
-
-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) |
-
-#### Returns
-
-`Promise`\<`string`\>
-
-Base64-encoded PNG image string

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

@@ -1,64 +0,0 @@
----
-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)
-
-Random user name generator class
-
-## Constructors
-
-### Constructor
-
-```ts
-new UserNameGeneratorService(): UserNameGeneratorService;
-```
-
-#### Returns
-
-`UserNameGeneratorService`
-
-## Methods
-
-### generate()
-
-```ts
-generate(useNumbers?): string;
-```
-
-Defined in: [services/UsernameGeneratorService.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/UsernameGeneratorService.ts#L36)
-
-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 |
-
-#### Returns
-
-`string`
-
-A randomly generated user name
-
-***
-
-### generateSecure()
-
-```ts
-generateSecure(): string;
-```
-
-Defined in: [services/UsernameGeneratorService.ts:49](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/services/UsernameGeneratorService.ts#L49)
-
-Generates a random user name using secure random bytes.
-
-#### Returns
-
-`string`
-
-A cryptographically secure random user name

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

@@ -1,18 +0,0 @@
----
-title: 'Function: Public()'
-generated: true
-editUrl: false
----
-# Function: Public()
-
-```ts
-function Public(): CustomDecorator;
-```
-
-Defined in: [decorators/Public.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/decorators/Public.ts#L14)
-
-The `Public` decorator.
-
-## Returns
-
-`CustomDecorator`

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

@@ -1,58 +0,0 @@
----
-title: 'Function: createConfigKey()'
-generated: true
-editUrl: false
----
-# Function: createConfigKey()
-
-```ts
-function createConfigKey<TType>(key): IConfigKey<TType>;
-```
-
-Defined in: [config/ConfigKey.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigKey.ts#L74)
-
-Creates a type-safe config key.
-
-Use this factory function to define all configuration keys in your application.
-This ensures you don’t scatter raw strings and you assign a type to each key.
-
-## Type Parameters
-
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TType` | `unknown` |
-
-## Parameters
-
-| 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.
-
-## Example
-
-```typescript
-// In some config-keys file
-export const DATABASE_URL = createConfigKey<string>('DATABASE_URL');
-export const MAX_TIMEOUT_MS = createConfigKey<number>('MAX_TIMEOUT_MS');
-export const FEATURE_X_ENABLED = createConfigKey<boolean>('FEATURE_X_ENABLED');
-```
-
-Then, when fetching:
-```ts
-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
-```
-
-## Remarks
-
-At runtime the returned object is minimal (just `{ key: string }`) so there is
-virtually no overhead. The generic `TType` is only used by TypeScript for stronger
-compile-time checking — enabling you to avoid magic strings and untyped fetches.

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

@@ -1,33 +0,0 @@
----
-title: 'Function: createEventKey()'
-generated: true
-editUrl: false
----
-# Function: createEventKey()
-
-```ts
-function createEventKey<TEvents, TKey>(eventName): IEventKey<TEvents, TKey>;
-```
-
-Defined in: [events/EventKey.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/events/EventKey.ts#L26)
-
-Creates a branded event key for the [EventHub](Class.EventHub).
-
-## Type Parameters
-
-| Type Parameter |
-| ------ |
-| `TEvents` *extends* [`IEventMap`](Interface.IEventMap) |
-| `TKey` *extends* `string` \| `number` \| `symbol` |
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `eventName` | `TKey` | The unique name of the event. |
-
-## Returns
-
-[`IEventKey`](Interface.IEventKey)\<`TEvents`, `TKey`\>
-
-The branded event key encoding the payload type.

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

@@ -1,39 +0,0 @@
----
-title: 'Function: createMappingKey()'
-generated: true
-editUrl: false
----
-# Function: createMappingKey()
-
-```ts
-function createMappingKey<TInput, TOutput>(key): IMappingKey<TInput, TOutput>;
-```
-
-Defined in: [mapping/types/MappingKey.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/types/MappingKey.ts#L28)
-
-Creates a type-safe mapping key.
-
-## Type Parameters
-
-| Type Parameter |
-| ------ |
-| `TInput` |
-| `TOutput` |
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The unique string identifier for the mapping. |
-
-## Returns
-
-[`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\>
-
-A branded mapping key that encodes the input and output types.
-
-## Example
-
-```typescript
-export const PRODUCT_MAPPING_KEY = createMappingKey<IProductMappingInput, ProductResponse>('food.product');
-```

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

@@ -1,28 +0,0 @@
----
-title: 'Function: env()'
-generated: true
-editUrl: false
----
-# Function: env()
-
-```ts
-function env(strings, ...values): string;
-```
-
-Defined in: [utils/EnvUtils.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/EnvUtils.ts#L7)
-
-Marker function for environment strings.
-
-It behaves like a normal template literal but allows you to
-later search/grep all `env` usages in the codebase.
-
-## Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `strings` | `TemplateStringsArray` |
-| ...`values` | `unknown`[] |
-
-## Returns
-
-`string`

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

@@ -1,26 +0,0 @@
----
-title: 'Function: getMimeTypeByFileNameOrExtension()'
-generated: true
-editUrl: false
----
-# Function: getMimeTypeByFileNameOrExtension()
-
-```ts
-function getMimeTypeByFileNameOrExtension(...args): string | false;
-```
-
-Defined in: [mime/mimeTypes.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mime/mimeTypes.ts#L14)
-
-Get MIME type by file name or extension.
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| ...`args` | \[`string`\] | Arguments for mime-types lookup |
-
-## Returns
-
-`string` \| `false`
-
-MIME type or false if not found

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

@@ -1,27 +0,0 @@
----
-title: 'Function: isActionId()'
-generated: true
-editUrl: false
----
-# Function: isActionId()
-
-```ts
-function isActionId(key, action): boolean;
-```
-
-Defined in: [sse/services/interfaces/ISseEventData.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/interfaces/ISseEventData.ts#L34)
-
-Checks if the action id is valid.
-
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The key to check. |
-| `action` | `string` | The action to check. |
-
-## Returns
-
-`boolean`
-
-- Returns true if the action id is valid, false otherwise.

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

@@ -1,28 +0,0 @@
----
-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)
-
-Configuration for the blob resource strategy.
-
-## Properties
-
-### keyPrefix?
-
-```ts
-optional keyPrefix?: string;
-```
-
-Defined in: [resources/strategies/BlobResourceStrategy.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L42)
-
-Optional key prefix for blob storage.
-
-#### Example
-
-```ts
-'resources/', 'templates/'
-```

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

@@ -1,40 +0,0 @@
----
-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)
-
-Minimal blob service interface to avoid circular dependencies.
-
-## Methods
-
-### downloadFile()
-
-```ts
-downloadFile(key): Promise<{
-  contentType?: string;
-  data: unknown;
-}>;
-```
-
-Defined in: [resources/strategies/BlobResourceStrategy.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/resources/strategies/BlobResourceStrategy.ts#L22)
-
-Downloads a file from blob storage.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `key` | `string` | The blob key |
-
-#### Returns
-
-`Promise`\<\{
-  `contentType?`: `string`;
-  `data`: `unknown`;
-\}\>
-
-The download result

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

@@ -1,63 +0,0 @@
----
-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)
-
-A type-safe config key that encodes both the config key and the type of its value.
-
-**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.
-
-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.
-
-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”).
-
-## Type Parameters
-
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TType` | `unknown` |
-
-## Properties
-
-### \_type?
-
-```ts
-readonly optional _type?: TType;
-```
-
-Defined in: [config/ConfigKey.ts:33](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigKey.ts#L33)
-
-Phantom generic to encode the expected value type. This property
-is never intended to be used at runtime.
-
-***
-
-### key
-
-```ts
-readonly key: string;
-```
-
-Defined in: [config/ConfigKey.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/config/ConfigKey.ts#L39)
-
-The unique string identifier for the configuration entry.
-This typically corresponds to an environment variable name or config store key.