@breadstone/archipel-mcp 0.0.13 → 0.0.14

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

@@ -1,46 +0,0 @@
----
-title: 'Class: MappingModule'
-generated: true
-editUrl: false
----
-# Class: MappingModule
-
-Defined in: [mapping/MappingModule.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/MappingModule.ts#L23)
-
-Module that provides mapping services and allows registration of mapping profiles.
-
-## Constructors
-
-### Constructor
-
-```ts
-new MappingModule(): MappingModule;
-```
-
-#### Returns
-
-`MappingModule`
-
-## Methods
-
-### withProfiles()
-
-```ts
-static withProfiles(profiles): DynamicModule;
-```
-
-Defined in: [mapping/MappingModule.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/MappingModule.ts#L32)
-
-Configures the module with the given mapping profiles.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `profiles` | `Type`\<[`IMappingProfile`](Interface.IMappingProfile)\>[] | An array of mapping profile types to register. |
-
-#### Returns
-
-`DynamicModule`
-
-A dynamic module with the specified profiles registered.

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

@@ -1,56 +0,0 @@
----
-title: 'Class: MappingNotRegisteredError'
-generated: true
-editUrl: false
----
-# Class: MappingNotRegisteredError
-
-Defined in: [mapping/errors/MappingNotRegisteredError.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/errors/MappingNotRegisteredError.ts#L12)
-
-Thrown when a keyed mapping is requested but not registered.
-
-## Extends
-
-- `MappingError`
-
-## Constructors
-
-### Constructor
-
-```ts
-new MappingNotRegisteredError(key): MappingNotRegisteredError;
-```
-
-Defined in: [mapping/errors/MappingNotRegisteredError.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/errors/MappingNotRegisteredError.ts#L16)
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `key` | `string` |
-
-#### Returns
-
-`MappingNotRegisteredError`
-
-#### 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.MappingProfileBase.md

@@ -1,52 +0,0 @@
----
-title: 'Abstract Class: MappingProfileBase'
-generated: true
-editUrl: false
----
-# Abstract Class: MappingProfileBase
-
-Defined in: [mapping/profile/MappingProfileBase.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/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: [mapping/profile/MappingProfileBase.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/mapping/profile/MappingProfileBase.ts#L25)
-
-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-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`

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

@@ -1,148 +0,0 @@
----
-title: 'Class: NormalizedUtils'
-generated: true
-editUrl: false
----
-# Class: NormalizedUtils
-
-Defined in: [utils/NormalizedUtils.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/NormalizedUtils.ts#L7)
-
-Utility functions for normalizing data.
-
-## Constructors
-
-### Constructor
-
-```ts
-new NormalizedUtils(): NormalizedUtils;
-```
-
-#### Returns
-
-`NormalizedUtils`
-
-## Methods
-
-### normalizeArray()
-
-```ts
-static normalizeArray<T>(values?): T[] | undefined;
-```
-
-Defined in: [utils/NormalizedUtils.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/NormalizedUtils.ts#L25)
-
-Normalize an array by removing duplicates.
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` |
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `values?` | `T`[] | The array to normalize. |
-
-#### Returns
-
-`T`[] \| `undefined`
-
-The normalized array.
-
-***
-
-### normalizeBoolean()
-
-```ts
-static normalizeBoolean(value?): boolean | undefined;
-```
-
-Defined in: [utils/NormalizedUtils.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/NormalizedUtils.ts#L69)
-
-Normalize a boolean value.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value?` | `boolean` | The boolean value to normalize. |
-
-#### Returns
-
-`boolean` \| `undefined`
-
-The normalized boolean value.
-
-***
-
-### normalizeDate()
-
-```ts
-static normalizeDate(value?): Date | undefined;
-```
-
-Defined in: [utils/NormalizedUtils.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/NormalizedUtils.ts#L55)
-
-Normalize a date by ensuring it is a valid date object.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value?` | `Date` | The date to normalize. |
-
-#### Returns
-
-`Date` \| `undefined`
-
-The normalized date.
-
-***
-
-### normalizeNumber()
-
-```ts
-static normalizeNumber(value?): number | undefined;
-```
-
-Defined in: [utils/NormalizedUtils.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/NormalizedUtils.ts#L41)
-
-Normalize a number by ensuring it is non-negative.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value?` | `number` | The number to normalize. |
-
-#### Returns
-
-`number` \| `undefined`
-
-The normalized number.
-
-***
-
-### normalizeString()
-
-```ts
-static normalizeString(value?): string | undefined;
-```
-
-Defined in: [utils/NormalizedUtils.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/NormalizedUtils.ts#L15)
-
-Normalize a search query by trimming whitespace and converting to lowercase.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value?` | `string` | The search query to normalize. |
-
-#### Returns
-
-`string` \| `undefined`
-
-The normalized search query.

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

@@ -1,42 +0,0 @@
----
-title: 'Abstract Class: PageableRequest'
-generated: true
-editUrl: false
----
-# Abstract Class: PageableRequest
-
-Defined in: [models/requests/PageableRequest.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/requests/PageableRequest.ts#L15)
-
-Base class describing pagination query parameters shared across endpoints.
-
-## Constructors
-
-### Constructor
-
-```ts
-new PageableRequest(): PageableRequest;
-```
-
-#### Returns
-
-`PageableRequest`
-
-## Properties
-
-### skip?
-
-```ts
-optional skip?: number;
-```
-
-Defined in: [models/requests/PageableRequest.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/requests/PageableRequest.ts#L26)
-
-***
-
-### take?
-
-```ts
-optional take?: number;
-```
-
-Defined in: [models/requests/PageableRequest.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/requests/PageableRequest.ts#L34)

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

@@ -1,62 +0,0 @@
----
-title: 'Abstract Class: PageableResponse'
-generated: true
-editUrl: false
----
-# Abstract Class: PageableResponse
-
-Defined in: [models/response/PageableResponse.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/PageableResponse.ts#L15)
-
-Base class describing pagination metadata returned alongside list payloads.
-
-## Constructors
-
-### Constructor
-
-```ts
-new PageableResponse(): PageableResponse;
-```
-
-#### Returns
-
-`PageableResponse`
-
-## Properties
-
-### items
-
-```ts
-abstract items: unknown[];
-```
-
-Defined in: [models/response/PageableResponse.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/PageableResponse.ts#L53)
-
-***
-
-### skip?
-
-```ts
-optional skip?: number;
-```
-
-Defined in: [models/response/PageableResponse.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/PageableResponse.ts#L35)
-
-***
-
-### take?
-
-```ts
-optional take?: number;
-```
-
-Defined in: [models/response/PageableResponse.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/PageableResponse.ts#L44)
-
-***
-
-### total
-
-```ts
-total: number;
-```
-
-Defined in: [models/response/PageableResponse.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/response/PageableResponse.ts#L26)