@breadstone/archipel-mcp 0.0.23 → 0.0.26

package/data/packages/platform-mapping/api/Class.MappingProfileBase.md

@@ -0,0 +1,52 @@
+---
+title: 'Abstract Class: MappingProfileBase'
+generated: true
+editUrl: false
+---
+# Abstract Class: MappingProfileBase
+
+Defined in: [profile/MappingProfileBase.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/profile/MappingProfileBase.ts#L13)
+
+Base class for mapping profiles to simplify implementation.
+
+## Implements
+
+- [`IMappingProfile`](Interface.IMappingProfile)
+
+## Constructors
+
+### Constructor
+
+```ts
+new MappingProfileBase(): MappingProfileBase;
+```
+
+#### Returns
+
+`MappingProfileBase`
+
+## Methods
+
+### configure()
+
+```ts
+abstract configure(builder): void;
+```
+
+Defined in: [profile/MappingProfileBase.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/profile/MappingProfileBase.ts#L23)
+
+Configures the mapping profile.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `builder` | [`IMappingBuilder`](Interface.IMappingBuilder) | The mapping builder. |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`IMappingProfile`](Interface.IMappingProfile).[`configure`](Interface.IMappingProfile#configure)

package/data/packages/platform-mapping/api/Class.MappingService.md

@@ -0,0 +1,284 @@
+---
+title: 'Class: MappingService'
+generated: true
+editUrl: false
+---
+# Class: MappingService
+
+Defined in: [MappingService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L19)
+
+Central mapping registry supporting keyed & type-based mappings.
+
+## Constructors
+
+### Constructor
+
+```ts
+new MappingService(): MappingService;
+```
+
+Defined in: [MappingService.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L36)
+
+Constructs a new instance of the `MappingService` class.
+
+#### Returns
+
+`MappingService`
+
+## Methods
+
+### map()
+
+```ts
+map<TInput, TOutput>(key, source): TOutput;
+```
+
+Defined in: [MappingService.ts:99](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L99)
+
+Maps a source object to a destination type using a type-safe mapping key.
+The key encodes both input and output types, ensuring compile-time type safety.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TInput` |
+| `TOutput` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | [`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\> | The type-safe mapping key. |
+| `source` | `TInput` | The source object to map. |
+
+#### Returns
+
+`TOutput`
+
+The mapped destination object.
+
+#### Example
+
+```typescript
+const response = this._mappingService.map(PRODUCT_MAPPING_KEY, productInput);
+// response is automatically typed as ProductResponse
+```
+
+***
+
+### mapTypes()
+
+```ts
+mapTypes<TSource, TDestination>(source, destination): TDestination;
+```
+
+Defined in: [MappingService.ts:129](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L129)
+
+Maps a source object to a destination type using a registered mapping function.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TSource` |
+| `TDestination` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `source` | `TSource` | The source object to map. |
+| `destination` | [`Constructor`](TypeAlias.Constructor)\<`TDestination`\> | The constructor of the destination type. |
+
+#### Returns
+
+`TDestination`
+
+The mapped destination object.
+
+***
+
+### mapTypesArray()
+
+```ts
+mapTypesArray<TSource, TDestination>(sources, destination): TDestination[];
+```
+
+Defined in: [MappingService.ts:161](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L161)
+
+Maps an array of source objects to an array of destination types using a registered mapping function.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TSource` |
+| `TDestination` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `sources` | `TSource`[] | The array of source objects to map. |
+| `destination` | [`Constructor`](TypeAlias.Constructor)\<`TDestination`\> | The constructor of the destination type. |
+
+#### Returns
+
+`TDestination`[]
+
+The array of mapped destination objects.
+
+***
+
+### register()
+
+```ts
+register<TSource, TDestination>(key, fn): void;
+```
+
+Defined in: [MappingService.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L54)
+
+Registers a mapping function for a specific key.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TSource` |
+| `TDestination` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The unique key for the mapping. |
+| `fn` | (`source`) => `TDestination` | The mapping function. |
+
+#### Returns
+
+`void`
+
+void
+
+***
+
+### registerMap()
+
+```ts
+registerMap<TSource, TDestination>(
+   source, 
+   destination, 
+   fn): void;
+```
+
+Defined in: [MappingService.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L71)
+
+Registers a mapping function for a specific source and destination type.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TSource` |
+| `TDestination` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `source` | [`Constructor`](TypeAlias.Constructor)\<`TSource`\> | The constructor of the source type. |
+| `destination` | [`Constructor`](TypeAlias.Constructor)\<`TDestination`\> | The constructor of the destination type. |
+| `fn` | (`source`) => `TDestination` | The mapping function. |
+
+#### Returns
+
+`void`
+
+void
+
+***
+
+### registerProfile()
+
+```ts
+registerProfile(profile): void;
+```
+
+Defined in: [MappingService.ts:175](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L175)
+
+Registers a mapping profile containing multiple mappings.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `profile` | [`IMappingProfile`](Interface.IMappingProfile) | The mapping profile to register. |
+
+#### Returns
+
+`void`
+
+void
+
+***
+
+### tryMap()
+
+```ts
+tryMap<TInput, TOutput>(key, source): TOutput | undefined;
+```
+
+Defined in: [MappingService.ts:115](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L115)
+
+Attempts to map returning undefined instead of throwing when mapping is absent.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TInput` |
+| `TOutput` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | [`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\> | The type-safe mapping key. |
+| `source` | `TInput` | The source object to map. |
+
+#### Returns
+
+`TOutput` \| `undefined`
+
+The mapped destination object or undefined if no mapping exists.
+
+***
+
+### tryMapTypes()
+
+```ts
+tryMapTypes<TSource, TDestination>(source, destination): TDestination | undefined;
+```
+
+Defined in: [MappingService.ts:142](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/MappingService.ts#L142)
+
+Safe variant of [mapTypes](#maptypes) that returns undefined if not registered.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TSource` |
+| `TDestination` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `source` | `TSource` |
+| `destination` | [`Constructor`](TypeAlias.Constructor)\<`TDestination`\> |
+
+#### Returns
+
+`TDestination` \| `undefined`

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

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

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

@@ -0,0 +1,39 @@
+---
+title: 'Function: createMappingKey()'
+generated: true
+editUrl: false
+---
+# Function: createMappingKey()
+
+```ts
+function createMappingKey<TInput, TOutput>(key): IMappingKey<TInput, TOutput>;
+```
+
+Defined in: [types/MappingKey.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/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-mapping/api/Interface.IMappingBuilder.md

@@ -0,0 +1,76 @@
+---
+title: 'Interface: IMappingBuilder'
+generated: true
+editUrl: false
+---
+# Interface: IMappingBuilder
+
+Defined in: [builder/interfaces/IMappingBuilder.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/builder/interfaces/IMappingBuilder.ts#L24)
+
+Defines the interface for a mapping builder.
+
+## Methods
+
+### createKeyedMap()
+
+```ts
+createKeyedMap<TInput, TOutput>(key, fn): this;
+```
+
+Defined in: [builder/interfaces/IMappingBuilder.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/builder/interfaces/IMappingBuilder.ts#L50)
+
+Creates a keyed mapping between two types with full type safety.
+The mapping key encodes both input and output types at compile time.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TInput` |
+| `TOutput` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | [`IMappingKey`](Interface.IMappingKey)\<`TInput`, `TOutput`\> | The type-safe mapping key. |
+| `fn` | (`source`) => `MappingCompatible`\<`TInput`, `TOutput`\> & `TOutput` | The mapping function that must return a valid destination. |
+
+#### Returns
+
+`this`
+
+***
+
+### createMap()
+
+```ts
+createMap<TSource, TDestination>(
+   source, 
+   destination, 
+   fn): this;
+```
+
+Defined in: [builder/interfaces/IMappingBuilder.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/builder/interfaces/IMappingBuilder.ts#L36)
+
+Creates a mapping between two types.
+Ensures compile-time type compatibility between source and destination.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TSource` |
+| `TDestination` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `source` | [`Constructor`](TypeAlias.Constructor)\<`TSource`\> | The source type. |
+| `destination` | [`Constructor`](TypeAlias.Constructor)\<`TDestination`\> | The destination type. |
+| `fn` | (`source`) => `MappingCompatible`\<`TSource`, `TDestination`\> & `TDestination` | The mapping function that must return a valid destination. |
+
+#### Returns
+
+`this`

package/data/packages/platform-mapping/api/Interface.IMappingKey.md

@@ -0,0 +1,58 @@
+---
+title: 'Interface: IMappingKey\<TInput, TOutput\>'
+generated: true
+editUrl: false
+---
+# Interface: IMappingKey\<TInput, TOutput\>
+
+Defined in: [types/MappingKey.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/types/MappingKey.ts#L9)
+
+Type-safe mapping key that encodes both input and output types.
+This ensures compile-time type safety when using the mapping service.
+
+## Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `TInput` | The input type for the mapping. |
+| `TOutput` | The output type for the mapping. |
+
+## Properties
+
+### \_brand
+
+```ts
+readonly _brand: "MappingKey";
+```
+
+Defined in: [types/MappingKey.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/types/MappingKey.ts#L10)
+
+***
+
+### \_input
+
+```ts
+readonly _input: TInput;
+```
+
+Defined in: [types/MappingKey.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/types/MappingKey.ts#L11)
+
+***
+
+### \_output
+
+```ts
+readonly _output: TOutput;
+```
+
+Defined in: [types/MappingKey.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/types/MappingKey.ts#L12)
+
+***
+
+### key
+
+```ts
+readonly key: string;
+```
+
+Defined in: [types/MappingKey.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/types/MappingKey.ts#L13)

package/data/packages/platform-mapping/api/Interface.IMappingProfile.md

@@ -0,0 +1,32 @@
+---
+title: 'Interface: IMappingProfile'
+generated: true
+editUrl: false
+---
+# Interface: IMappingProfile
+
+Defined in: [profile/interfaces/IMappingProfile.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/profile/interfaces/IMappingProfile.ts#L12)
+
+Defines the interface for a mapping profile.
+
+## Methods
+
+### configure()
+
+```ts
+configure(builder): void;
+```
+
+Defined in: [profile/interfaces/IMappingProfile.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/profile/interfaces/IMappingProfile.ts#L21)
+
+Configures the mapping profile.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `builder` | [`IMappingBuilder`](Interface.IMappingBuilder) | The mapping builder. |
+
+#### Returns
+
+`void`

package/data/packages/platform-mapping/api/TypeAlias.Constructor.md

@@ -0,0 +1,28 @@
+---
+title: 'Type Alias: Constructor\<T\>'
+generated: true
+editUrl: false
+---
+# Type Alias: Constructor\<T\>
+
+```ts
+type Constructor<T> = (...args) => T;
+```
+
+Defined in: [types/Constructor.ts:1](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-mapping/src/types/Constructor.ts#L1)
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`args` | `unknown`[] |
+
+## Returns
+
+`T`

package/data/packages/platform-mapping/api/index.md

@@ -0,0 +1,38 @@
+---
+title: '@breadstone/archipel-platform-mapping'
+generated: true
+editUrl: false
+---
+# @breadstone/archipel-platform-mapping
+
+## Classes
+
+| Class | Description |
+| ------ | ------ |
+| [MappingBuilder](Class.MappingBuilder) | A mapping builder that uses the mapping service to register maps. |
+| [MappingError](Class.MappingError) | Base class for mapping related domain errors. |
+| [MappingModule](Class.MappingModule) | Module that provides mapping services and allows registration of mapping profiles. |
+| [MappingNotRegisteredError](Class.MappingNotRegisteredError) | Thrown when a keyed mapping is requested but not registered. |
+| [MappingProfileBase](Class.MappingProfileBase) | Base class for mapping profiles to simplify implementation. |
+| [MappingService](Class.MappingService) | Central mapping registry supporting keyed & type-based mappings. |
+| [TypeMappingNotRegisteredError](Class.TypeMappingNotRegisteredError) | Thrown when a type mapping is requested but not registered. |
+
+## Interfaces
+
+| Interface | Description |
+| ------ | ------ |
+| [IMappingBuilder](Interface.IMappingBuilder) | Defines the interface for a mapping builder. |
+| [IMappingKey](Interface.IMappingKey) | Type-safe mapping key that encodes both input and output types. This ensures compile-time type safety when using the mapping service. |
+| [IMappingProfile](Interface.IMappingProfile) | Defines the interface for a mapping profile. |
+
+## Type Aliases
+
+| Type Alias | Description |
+| ------ | ------ |
+| [Constructor](TypeAlias.Constructor) | - |
+
+## Functions
+
+| Function | Description |
+| ------ | ------ |
+| [createMappingKey](Function.createMappingKey) | Creates a type-safe mapping key. |