@breadstone/archipel-mcp 0.0.20 → 0.0.22

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

@@ -1,284 +0,0 @@
----
-title: 'Class: MappingService'
-generated: true
-editUrl: false
----
-# Class: MappingService
-
-Defined in: [mapping/MappingService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/MappingService.ts#L19)
-
-Central mapping registry supporting keyed & type-based mappings.
-
-## Constructors
-
-### Constructor
-
-```ts
-new MappingService(): MappingService;
-```
-
-Defined in: [mapping/MappingService.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/MappingService.ts#L37)
-
-Constructs a new instance of the `MappingService` class.
-
-#### Returns
-
-`MappingService`
-
-## Methods
-
-### map()
-
-```ts
-map<TInput, TOutput>(key, source): TOutput;
-```
-
-Defined in: [mapping/MappingService.ts:96](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/MappingService.ts#L96)
-
-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: [mapping/MappingService.ts:126](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/MappingService.ts#L126)
-
-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`\<`TDestination`\> | The constructor of the destination type. |
-
-#### Returns
-
-`TDestination`
-
-The mapped destination object.
-
-***
-
-### mapTypesArray()
-
-```ts
-mapTypesArray<TSource, TDestination>(sources, destination): TDestination[];
-```
-
-Defined in: [mapping/MappingService.ts:155](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/MappingService.ts#L155)
-
-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`\<`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: [mapping/MappingService.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/MappingService.ts#L55)
-
-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: [mapping/MappingService.ts:72](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/MappingService.ts#L72)
-
-Registers a mapping function for a specific source and destination type.
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `TSource` |
-| `TDestination` |
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `source` | `Constructor`\<`TSource`\> | The constructor of the source type. |
-| `destination` | `Constructor`\<`TDestination`\> | The constructor of the destination type. |
-| `fn` | (`source`) => `TDestination` | The mapping function. |
-
-#### Returns
-
-`void`
-
-void
-
-***
-
-### registerProfile()
-
-```ts
-registerProfile(profile): void;
-```
-
-Defined in: [mapping/MappingService.ts:166](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/MappingService.ts#L166)
-
-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: [mapping/MappingService.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/MappingService.ts#L112)
-
-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: [mapping/MappingService.ts:139](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/MappingService.ts#L139)
-
-Safe variant of [mapTypes](#maptypes) that returns undefined if not registered.
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `TSource` |
-| `TDestination` |
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `source` | `TSource` |
-| `destination` | `Constructor`\<`TDestination`\> |
-
-#### Returns
-
-`TDestination` \| `undefined`