npm - @breadstone/archipel-mcp - Versions diffs - 0.0.2 → 0.0.3 - Mend

@breadstone/archipel-mcp 0.0.2 → 0.0.3

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

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

@@ -3,6 +3,7 @@ title: 'Abstract Class: ResponseReturn\<T\>'
 generated: true
 editUrl: false
 ---
 # Abstract Class: ResponseReturn\<T\>
 Defined in: [models/ResponseReturn.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L14)
@@ -10,8 +11,8 @@ Defined in: [models/ResponseReturn.ts:14](https://github.com/RueDeRennes/archipe
 ## Type Parameters
 | Type Parameter |
-| ------ |
-| `T` |
+| -------------- |
+| `T`            |
 ## Constructors
@@ -35,7 +36,7 @@ optional data?: T;
 Defined in: [models/ResponseReturn.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L34)
-***
+---
 ### details?
@@ -45,7 +46,7 @@ optional details?: unknown;
 Defined in: [models/ResponseReturn.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L44)
-***
+---
 ### error?
@@ -55,7 +56,7 @@ optional error?: string;
 Defined in: [models/ResponseReturn.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L39)
-***
+---
 ### status
@@ -65,7 +66,7 @@ status: number;
 Defined in: [models/ResponseReturn.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L29)
-***
+---
 ### success
@@ -75,7 +76,7 @@ success: boolean;
 Defined in: [models/ResponseReturn.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L22)
-***
+---
 ### timestamp
@@ -102,16 +103,16 @@ Creates an accepted response.
 ##### Type Parameters
 | Type Parameter |
-| ------ |
-| `TReturn` |
-| `TIn` |
+| -------------- |
+| `TReturn`      |
+| `TIn`          |
 ##### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
-| `data` | `TIn` | The response data |
+| Parameter | Type                            | Description                |
+| --------- | ------------------------------- | -------------------------- |
+| `type`    | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data`    | `TIn`                           | The response data          |
 ##### Returns
@@ -130,22 +131,22 @@ Creates an accepted response.
 ##### Type Parameters
 | Type Parameter |
-| ------ |
-| `TReturn` |
-| `TIn` |
+| -------------- |
+| `TReturn`      |
+| `TIn`          |
 ##### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
-| `data` | `TIn`[] | The response data |
+| Parameter | Type                            | Description                |
+| --------- | ------------------------------- | -------------------------- |
+| `type`    | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data`    | `TIn`[]                         | The response data          |
 ##### Returns
 `ResponseReturn`\<`TReturn`[]\>
-***
+---
 ### badRequest()
@@ -160,15 +161,15 @@ Creates a bad request response.
 #### Type Parameters
 | Type Parameter |
-| ------ |
-| `TReturn` |
+| -------------- |
+| `TReturn`      |
 #### Parameters
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `message` | `string` | `'Bad Request'` | Human-readable error message |
-| `details?` | `unknown` | `undefined` | Optional error details |
+| Parameter  | Type      | Default value   | Description                  |
+| ---------- | --------- | --------------- | ---------------------------- |
+| `message`  | `string`  | `'Bad Request'` | Human-readable error message |
+| `details?` | `unknown` | `undefined`     | Optional error details       |
 #### Returns
@@ -176,7 +177,7 @@ Creates a bad request response.
 Bad request response
-***
+---
 ### conflict()
@@ -191,15 +192,15 @@ Creates a conflict response.
 #### Type Parameters
 | Type Parameter |
-| ------ |
-| `TReturn` |
+| -------------- |
+| `TReturn`      |
 #### Parameters
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `message` | `string` | `'Conflict'` | Human-readable error message |
-| `details?` | `unknown` | `undefined` | Optional error details |
+| Parameter  | Type      | Default value | Description                  |
+| ---------- | --------- | ------------- | ---------------------------- |
+| `message`  | `string`  | `'Conflict'`  | Human-readable error message |
+| `details?` | `unknown` | `undefined`   | Optional error details       |
 #### Returns
@@ -207,7 +208,7 @@ Creates a conflict response.
 Conflict response
-***
+---
 ### created()
@@ -224,16 +225,16 @@ Creates a resource created response.
 ##### Type Parameters
 | Type Parameter |
-| ------ |
-| `TReturn` |
-| `TIn` |
+| -------------- |
+| `TReturn`      |
+| `TIn`          |
 ##### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
-| `data` | `TIn` | The response data |
+| Parameter | Type                            | Description                |
+| --------- | ------------------------------- | -------------------------- |
+| `type`    | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data`    | `TIn`                           | The response data          |
 ##### Returns
@@ -252,22 +253,22 @@ Creates a resource created response.
 ##### Type Parameters
 | Type Parameter |
-| ------ |
-| `TReturn` |
-| `TIn` |
+| -------------- |
+| `TReturn`      |
+| `TIn`          |
 ##### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
-| `data` | `TIn`[] | The response data |
+| Parameter | Type                            | Description                |
+| --------- | ------------------------------- | -------------------------- |
+| `type`    | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data`    | `TIn`[]                         | The response data          |
 ##### Returns
 `ResponseReturn`\<`TReturn`[]\>
-***
+---
 ### error()
@@ -282,21 +283,21 @@ Generic server error (500). Prefer attaching a safe `details` object (no stack t
 #### Type Parameters
 | Type Parameter |
-| ------ |
-| `TReturn` |
+| -------------- |
+| `TReturn`      |
 #### Parameters
-| Parameter | Type | Default value |
-| ------ | ------ | ------ |
-| `message` | `string` | `'Internal Server Error'` |
-| `details?` | `unknown` | `undefined` |
+| Parameter  | Type      | Default value             |
+| ---------- | --------- | ------------------------- |
+| `message`  | `string`  | `'Internal Server Error'` |
+| `details?` | `unknown` | `undefined`               |
 #### Returns
 `ResponseReturn`\<`TReturn`\>
-***
+---
 ### forbidden()
@@ -311,15 +312,15 @@ Creates a forbidden response.
 #### Type Parameters
 | Type Parameter |
-| ------ |
-| `TReturn` |
+| -------------- |
+| `TReturn`      |
 #### Parameters
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `message` | `string` | `'Forbidden'` | Human-readable error message |
-| `details?` | `unknown` | `undefined` | Optional error details |
+| Parameter  | Type      | Default value | Description                  |
+| ---------- | --------- | ------------- | ---------------------------- |
+| `message`  | `string`  | `'Forbidden'` | Human-readable error message |
+| `details?` | `unknown` | `undefined`   | Optional error details       |
 #### Returns
@@ -327,7 +328,7 @@ Creates a forbidden response.
 Forbidden response
-***
+---
 ### fromError()
@@ -338,26 +339,27 @@ static fromError<TReturn>(err, defaultStatus?): ResponseReturn<TReturn>;
 Defined in: [models/ResponseReturn.ts:190](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L190)
 Converts an arbitrary error into a ResponseReturn.
 - If you pass a Nest `HttpException`, consider extracting status/message first.
 #### Type Parameters
 | Type Parameter |
-| ------ |
-| `TReturn` |
+| -------------- |
+| `TReturn`      |
 #### Parameters
-| Parameter | Type | Default value |
-| ------ | ------ | ------ |
-| `err` | `unknown` | `undefined` |
+| Parameter       | Type         | Default value                      |
+| --------------- | ------------ | ---------------------------------- |
+| `err`           | `unknown`    | `undefined`                        |
 | `defaultStatus` | `HttpStatus` | `HttpStatus.INTERNAL_SERVER_ERROR` |
 #### Returns
 `ResponseReturn`\<`TReturn`\>
-***
+---
 ### noContent()
@@ -372,14 +374,14 @@ No content variant (204). `data` is undefined by contract.
 #### Type Parameters
 | Type Parameter |
-| ------ |
-| `TReturn` |
+| -------------- |
+| `TReturn`      |
 #### Returns
 `ResponseReturn`\<`TReturn`\>
-***
+---
 ### notFound()
@@ -394,15 +396,15 @@ Creates a not found response.
 #### Type Parameters
 | Type Parameter |
-| ------ |
-| `TReturn` |
+| -------------- |
+| `TReturn`      |
 #### Parameters
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `message` | `string` | `'Not Found'` | Human-readable error message |
-| `details?` | `unknown` | `undefined` | Optional error details |
+| Parameter  | Type      | Default value | Description                  |
+| ---------- | --------- | ------------- | ---------------------------- |
+| `message`  | `string`  | `'Not Found'` | Human-readable error message |
+| `details?` | `unknown` | `undefined`   | Optional error details       |
 #### Returns
@@ -410,7 +412,7 @@ Creates a not found response.
 Not found response
-***
+---
 ### ok()
@@ -427,16 +429,16 @@ Creates a successful response.
 ##### Type Parameters
 | Type Parameter |
-| ------ |
-| `TReturn` |
-| `TIn` |
+| -------------- |
+| `TReturn`      |
+| `TIn`          |
 ##### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
-| `data` | `TIn` | The response data |
+| Parameter | Type                            | Description                |
+| --------- | ------------------------------- | -------------------------- |
+| `type`    | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data`    | `TIn`                           | The response data          |
 ##### Returns
@@ -455,22 +457,22 @@ Creates a successful response.
 ##### Type Parameters
 | Type Parameter |
-| ------ |
-| `TReturn` |
-| `TIn` |
+| -------------- |
+| `TReturn`      |
+| `TIn`          |
 ##### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
-| `data` | `TIn`[] | The response data |
+| Parameter | Type                            | Description                |
+| --------- | ------------------------------- | -------------------------- |
+| `type`    | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data`    | `TIn`[]                         | The response data          |
 ##### Returns
 `ResponseReturn`\<`TReturn`[]\>
-***
+---
 ### unauthorized()
@@ -485,15 +487,15 @@ Creates an unauthorized response.
 #### Type Parameters
 | Type Parameter |
-| ------ |
-| `TReturn` |
+| -------------- |
+| `TReturn`      |
 #### Parameters
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `message` | `string` | `'Unauthorized'` | Human-readable error message |
-| `details?` | `unknown` | `undefined` | Optional error details |
+| Parameter  | Type      | Default value    | Description                  |
+| ---------- | --------- | ---------------- | ---------------------------- |
+| `message`  | `string`  | `'Unauthorized'` | Human-readable error message |
+| `details?` | `unknown` | `undefined`      | Optional error details       |
 #### Returns

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

@@ -3,6 +3,7 @@ title: 'Class: SseHub'
 generated: true
 editUrl: false
 ---
 # Class: SseHub
 Defined in: [sse/services/SseHub.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L16)
@@ -43,9 +44,9 @@ Clears the event with the specified ID.
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `id` | `string` | The ID of the event. |
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `id`      | `string` | The ID of the event. |
 #### Returns
@@ -55,7 +56,7 @@ Clears the event with the specified ID.
 [`ISseHub`](Interface.ISseHub).[`clearEvent`](Interface.ISseHub#clearevent)
-***
+---
 ### emitEvent()
@@ -69,10 +70,10 @@ Emits an event with the specified ID and data.
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `id` | `string` | The ID of the event. |
-| `data` | [`ISseEventData`](Interface.ISseEventData) | The data of the event. |
+| Parameter | Type                                       | Description            |
+| --------- | ------------------------------------------ | ---------------------- |
+| `id`      | `string`                                   | The ID of the event.   |
+| `data`    | [`ISseEventData`](Interface.ISseEventData) | The data of the event. |
 #### Returns
@@ -82,7 +83,7 @@ Emits an event with the specified ID and data.
 [`ISseHub`](Interface.ISseHub).[`emitEvent`](Interface.ISseHub#emitevent)
-***
+---
 ### getObservable()
@@ -96,8 +97,8 @@ Gets an observable for the event with the specified ID.
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
 | `eventId` | `string` | The ID of the event. |
 #### Returns
@@ -110,7 +111,7 @@ An observable for the event.
 [`ISseHub`](Interface.ISseHub).[`getObservable`](Interface.ISseHub#getobservable)
-***
+---
 ### isEventActive()
@@ -124,9 +125,9 @@ Determines whether the event with the specified ID is active.
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `id` | `string` | The ID of the event. |
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `id`      | `string` | The ID of the event. |
 #### Returns
@@ -138,7 +139,7 @@ Determines whether the event with the specified ID is active.
 [`ISseHub`](Interface.ISseHub).[`isEventActive`](Interface.ISseHub#iseventactive)
-***
+---
 ### registerEvent()
@@ -152,15 +153,15 @@ Registers an event with the specified ID.
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `id` | `string` | The ID of the event. |
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `id`      | `string` | The ID of the event. |
 #### Returns
 `void`
-***
+---
 ### unregisterEvent()
@@ -174,9 +175,9 @@ Unregisters an event with the specified ID.
 #### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `id` | `string` | The ID of the event. |
+| Parameter | Type     | Description          |
+| --------- | -------- | -------------------- |
+| `id`      | `string` | The ID of the event. |
 #### Returns

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

@@ -3,6 +3,7 @@ title: 'Class: SseModule'
 generated: true
 editUrl: false
 ---
 # Class: SseModule
 Defined in: [sse/SseModule.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/SseModule.ts#L41)
@@ -33,9 +34,9 @@ Defined in: [sse/SseModule.ts:45](https://github.com/RueDeRennes/archipel/blob/m
 #### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `config` | `ISseModuleConfig` |
+| Parameter | Type               |
+| --------- | ------------------ |
+| `config`  | `ISseModuleConfig` |
 #### Returns

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

@@ -3,6 +3,7 @@ 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)
@@ -31,7 +32,7 @@ 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

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

@@ -3,6 +3,7 @@ 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)
@@ -25,9 +26,9 @@ Defined in: [mapping/errors/TypeMappingNotRegisteredError.ts:16](https://github.
 #### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `source` | `string` |
+| Parameter     | Type     |
+| ------------- | -------- |
+| `source`      | `string` |
 | `destination` | `string` |
 #### Returns
@@ -37,7 +38,7 @@ Defined in: [mapping/errors/TypeMappingNotRegisteredError.ts:16](https://github.
 #### Overrides
 ```ts
-MappingError.constructor
+MappingError.constructor;
 ```
 ## Properties
@@ -53,5 +54,5 @@ Defined in: [mapping/errors/MappingError.ts:11](https://github.com/RueDeRennes/a
 #### Inherited from
 ```ts
-MappingError.code
+MappingError.code;
 ```