@breadstone/archipel-mcp 0.0.14 → 0.0.16

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

@@ -0,0 +1,502 @@
+---
+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)
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Constructors
+
+### Constructor
+
+```ts
+new ResponseReturn<T>(): ResponseReturn<T>;
+```
+
+#### Returns
+
+`ResponseReturn`\<`T`\>
+
+## Properties
+
+### data?
+
+```ts
+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?
+
+```ts
+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?
+
+```ts
+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
+
+```ts
+status: number;
+```
+
+Defined in: [models/ResponseReturn.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L29)
+
+***
+
+### success
+
+```ts
+success: boolean;
+```
+
+Defined in: [models/ResponseReturn.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L22)
+
+***
+
+### timestamp
+
+```ts
+timestamp: string;
+```
+
+Defined in: [models/ResponseReturn.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L51)
+
+## Methods
+
+### accepted()
+
+#### Call Signature
+
+```ts
+static accepted<TReturn, TIn>(type, data): ResponseReturn<TReturn>;
+```
+
+Defined in: [models/ResponseReturn.ts:96](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L96)
+
+Creates an accepted response.
+
+##### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TReturn` |
+| `TIn` |
+
+##### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data` | `TIn` | The response data |
+
+##### Returns
+
+`ResponseReturn`\<`TReturn`\>
+
+#### Call Signature
+
+```ts
+static accepted<TReturn, TIn>(type, data): ResponseReturn<TReturn[]>;
+```
+
+Defined in: [models/ResponseReturn.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L97)
+
+Creates an accepted response.
+
+##### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TReturn` |
+| `TIn` |
+
+##### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data` | `TIn`[] | The response data |
+
+##### Returns
+
+`ResponseReturn`\<`TReturn`[]\>
+
+***
+
+### badRequest()
+
+```ts
+static badRequest<TReturn>(message?, details?): ResponseReturn<TReturn>;
+```
+
+Defined in: [models/ResponseReturn.ts:128](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L128)
+
+Creates a bad request response.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TReturn` |
+
+#### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `message` | `string` | `'Bad Request'` | Human-readable error message |
+| `details?` | `unknown` | `undefined` | Optional error details |
+
+#### Returns
+
+`ResponseReturn`\<`TReturn`\>
+
+Bad request response
+
+***
+
+### conflict()
+
+```ts
+static conflict<TReturn>(message?, details?): ResponseReturn<TReturn>;
+```
+
+Defined in: [models/ResponseReturn.ts:176](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L176)
+
+Creates a conflict response.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TReturn` |
+
+#### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `message` | `string` | `'Conflict'` | Human-readable error message |
+| `details?` | `unknown` | `undefined` | Optional error details |
+
+#### Returns
+
+`ResponseReturn`\<`TReturn`\>
+
+Conflict response
+
+***
+
+### created()
+
+#### Call Signature
+
+```ts
+static created<TReturn, TIn>(type, data): ResponseReturn<TReturn>;
+```
+
+Defined in: [models/ResponseReturn.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L80)
+
+Creates a resource created response.
+
+##### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TReturn` |
+| `TIn` |
+
+##### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data` | `TIn` | The response data |
+
+##### Returns
+
+`ResponseReturn`\<`TReturn`\>
+
+#### Call Signature
+
+```ts
+static created<TReturn, TIn>(type, data): ResponseReturn<TReturn[]>;
+```
+
+Defined in: [models/ResponseReturn.ts:81](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L81)
+
+Creates a resource created response.
+
+##### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TReturn` |
+| `TIn` |
+
+##### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data` | `TIn`[] | The response data |
+
+##### Returns
+
+`ResponseReturn`\<`TReturn`[]\>
+
+***
+
+### error()
+
+```ts
+static error<TReturn>(message?, details?): ResponseReturn<TReturn>;
+```
+
+Defined in: [models/ResponseReturn.ts:183](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L183)
+
+Generic server error (500). Prefer attaching a safe `details` object (no stack traces in prod).
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TReturn` |
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `message` | `string` | `'Internal Server Error'` |
+| `details?` | `unknown` | `undefined` |
+
+#### Returns
+
+`ResponseReturn`\<`TReturn`\>
+
+***
+
+### forbidden()
+
+```ts
+static forbidden<TReturn>(message?, details?): ResponseReturn<TReturn>;
+```
+
+Defined in: [models/ResponseReturn.ts:152](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L152)
+
+Creates a forbidden response.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TReturn` |
+
+#### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `message` | `string` | `'Forbidden'` | Human-readable error message |
+| `details?` | `unknown` | `undefined` | Optional error details |
+
+#### Returns
+
+`ResponseReturn`\<`TReturn`\>
+
+Forbidden response
+
+***
+
+### fromError()
+
+```ts
+static fromError<TReturn>(err, defaultStatus?): ResponseReturn<TReturn>;
+```
+
+Defined in: [models/ResponseReturn.ts:191](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L191)
+
+Converts an arbitrary error into a ResponseReturn.
+- If you pass a Nest `HttpException`, consider extracting status/message first.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TReturn` |
+
+#### Parameters
+
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `err` | `unknown` | `undefined` |
+| `defaultStatus` | `HttpStatus` | `HttpStatus.INTERNAL_SERVER_ERROR` |
+
+#### Returns
+
+`ResponseReturn`\<`TReturn`\>
+
+***
+
+### noContent()
+
+```ts
+static noContent<TReturn>(): ResponseReturn<TReturn>;
+```
+
+Defined in: [models/ResponseReturn.ts:110](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L110)
+
+No content variant (204). `data` is undefined by contract.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TReturn` |
+
+#### Returns
+
+`ResponseReturn`\<`TReturn`\>
+
+***
+
+### notFound()
+
+```ts
+static notFound<TReturn>(message?, details?): ResponseReturn<TReturn>;
+```
+
+Defined in: [models/ResponseReturn.ts:164](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L164)
+
+Creates a not found response.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TReturn` |
+
+#### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `message` | `string` | `'Not Found'` | Human-readable error message |
+| `details?` | `unknown` | `undefined` | Optional error details |
+
+#### Returns
+
+`ResponseReturn`\<`TReturn`\>
+
+Not found response
+
+***
+
+### ok()
+
+#### Call Signature
+
+```ts
+static ok<TReturn, TIn>(type, data): ResponseReturn<TReturn>;
+```
+
+Defined in: [models/ResponseReturn.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L64)
+
+Creates a successful response.
+
+##### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TReturn` |
+| `TIn` |
+
+##### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data` | `TIn` | The response data |
+
+##### Returns
+
+`ResponseReturn`\<`TReturn`\>
+
+#### Call Signature
+
+```ts
+static ok<TReturn, TIn>(type, data): ResponseReturn<TReturn[]>;
+```
+
+Defined in: [models/ResponseReturn.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L65)
+
+Creates a successful response.
+
+##### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TReturn` |
+| `TIn` |
+
+##### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `type` | `ClassConstructor`\<`TReturn`\> | Class type to transform to |
+| `data` | `TIn`[] | The response data |
+
+##### Returns
+
+`ResponseReturn`\<`TReturn`[]\>
+
+***
+
+### unauthorized()
+
+```ts
+static unauthorized<TReturn>(message?, details?): ResponseReturn<TReturn>;
+```
+
+Defined in: [models/ResponseReturn.ts:140](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/models/ResponseReturn.ts#L140)
+
+Creates an unauthorized response.
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TReturn` |
+
+#### Parameters
+
+| Parameter | Type | Default value | Description |
+| ------ | ------ | ------ | ------ |
+| `message` | `string` | `'Unauthorized'` | Human-readable error message |
+| `details?` | `unknown` | `undefined` | Optional error details |
+
+#### Returns
+
+`ResponseReturn`\<`TReturn`\>
+
+Unauthorized response

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

@@ -0,0 +1,183 @@
+---
+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)
+
+Represents a server-sent event service.
+
+## Implements
+
+- [`ISseHub`](Interface.ISseHub)
+
+## Constructors
+
+### Constructor
+
+```ts
+new SseHub(): SseHub;
+```
+
+Defined in: [sse/services/SseHub.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L31)
+
+Constructs a new instance of the `SseService` class.
+
+#### Returns
+
+`SseHub`
+
+## Methods
+
+### clearEvent()
+
+```ts
+clearEvent(id): void;
+```
+
+Defined in: [sse/services/SseHub.ts:98](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L98)
+
+Clears the event with the specified ID.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The ID of the event. |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`ISseHub`](Interface.ISseHub).[`clearEvent`](Interface.ISseHub#clearevent)
+
+***
+
+### emitEvent()
+
+```ts
+emitEvent(id, data): void;
+```
+
+Defined in: [sse/services/SseHub.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L77)
+
+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. |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`ISseHub`](Interface.ISseHub).[`emitEvent`](Interface.ISseHub#emitevent)
+
+***
+
+### getObservable()
+
+```ts
+getObservable(eventId): Observable<ISseEventData<unknown>>;
+```
+
+Defined in: [sse/services/SseHub.ts:128](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L128)
+
+Gets an observable for the event with the specified ID.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `eventId` | `string` | The ID of the event. |
+
+#### Returns
+
+`Observable`\<[`ISseEventData`](Interface.ISseEventData)\<`unknown`\>\>
+
+An observable for the event.
+
+#### Implementation of
+
+[`ISseHub`](Interface.ISseHub).[`getObservable`](Interface.ISseHub#getobservable)
+
+***
+
+### isEventActive()
+
+```ts
+isEventActive(id): boolean;
+```
+
+Defined in: [sse/services/SseHub.ts:115](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L115)
+
+Determines whether the event with the specified ID is active.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The ID of the event. |
+
+#### Returns
+
+`boolean`
+
+`true` if the event is active; otherwise, `false`.
+
+#### Implementation of
+
+[`ISseHub`](Interface.ISseHub).[`isEventActive`](Interface.ISseHub#iseventactive)
+
+***
+
+### registerEvent()
+
+```ts
+registerEvent(id): void;
+```
+
+Defined in: [sse/services/SseHub.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L45)
+
+Registers an event with the specified ID.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The ID of the event. |
+
+#### Returns
+
+`void`
+
+***
+
+### unregisterEvent()
+
+```ts
+unregisterEvent(id): void;
+```
+
+Defined in: [sse/services/SseHub.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/services/SseHub.ts#L60)
+
+Unregisters an event with the specified ID.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `id` | `string` | The ID of the event. |
+
+#### Returns
+
+`void`

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

@@ -0,0 +1,42 @@
+---
+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)
+
+Represents the `SseModule` class.
+
+## Constructors
+
+### Constructor
+
+```ts
+new SseModule(): SseModule;
+```
+
+#### Returns
+
+`SseModule`
+
+## Methods
+
+### register()
+
+```ts
+static register(config): DynamicModule;
+```
+
+Defined in: [sse/SseModule.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/sse/SseModule.ts#L45)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `config` | `ISseModuleConfig` |
+
+#### Returns
+
+`DynamicModule`