@breadstone/archipel-mcp 0.0.23 → 0.0.25

package/data/packages/platform-queue/api/Class.BullMqQueue.md

@@ -0,0 +1,220 @@
+---
+title: 'Class: BullMqQueue'
+generated: true
+editUrl: false
+---
+# Class: BullMqQueue
+
+Defined in: [bullmq/BullMqQueue.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/bullmq/BullMqQueue.ts#L56)
+
+BullMQ-backed queue implementation.
+
+Uses Redis via BullMQ for persistent, distributed job processing.
+Supports FIFO ordering, automatic retries, and horizontal scaling.
+
+## Remarks
+
+Each named queue lazily creates its own BullMQ Queue and Worker
+instance. Job tokens are tracked internally so that [markCompleted](#markcompleted)
+and [markFailed](#markfailed) can move jobs to the correct terminal state.
+
+## Implements
+
+- [`IQueue`](Interface.IQueue)
+- `OnModuleDestroy`
+
+## Constructors
+
+### Constructor
+
+```ts
+new BullMqQueue(options): BullMqQueue;
+```
+
+Defined in: [bullmq/BullMqQueue.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/bullmq/BullMqQueue.ts#L75)
+
+Creates a new BullMqQueue instance.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`IBullMqQueueOptions`](Interface.IBullMqQueueOptions) | Redis connection and optional prefix. See [IBullMqQueueOptions](Interface.IBullMqQueueOptions). |
+
+#### Returns
+
+`BullMqQueue`
+
+## Methods
+
+### dequeue()
+
+```ts
+dequeue(queueName): Promise<IQueueJob<unknown> | null>;
+```
+
+Defined in: [bullmq/BullMqQueue.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/bullmq/BullMqQueue.ts#L97)
+
+Dequeues the next pending job from the named queue.
+
+The returned job transitions to `processing` status.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `queueName` | `string` | The name of the queue to dequeue from. |
+
+#### Returns
+
+`Promise`\<[`IQueueJob`](Interface.IQueueJob)\<`unknown`\> \| `null`\>
+
+The next pending job, or `null` if the queue is empty.
+
+#### Implementation of
+
+[`IQueue`](Interface.IQueue).[`dequeue`](Interface.IQueue#dequeue)
+
+***
+
+### enqueue()
+
+```ts
+enqueue<T>(queueName, payload): Promise<IQueueJob<T>>;
+```
+
+Defined in: [bullmq/BullMqQueue.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/bullmq/BullMqQueue.ts#L85)
+
+Enqueues a new job into the named queue.
+
+#### Type Parameters
+
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `T` | `unknown` |  |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `queueName` | `string` | The name of the target queue. |
+| `payload` | `T` | The job payload. |
+
+#### Returns
+
+`Promise`\<[`IQueueJob`](Interface.IQueueJob)\<`T`\>\>
+
+The created job in `pending` status.
+
+#### Implementation of
+
+[`IQueue`](Interface.IQueue).[`enqueue`](Interface.IQueue#enqueue)
+
+***
+
+### getJobs()
+
+```ts
+getJobs(queueName): Promise<readonly IQueueJob<unknown>[]>;
+```
+
+Defined in: [bullmq/BullMqQueue.ts:190](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/bullmq/BullMqQueue.ts#L190)
+
+Returns all jobs for the given queue in insertion order.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `queueName` | `string` | The name of the queue. |
+
+#### Returns
+
+`Promise`\<readonly [`IQueueJob`](Interface.IQueueJob)\<`unknown`\>[]\>
+
+An array of jobs, possibly empty.
+
+#### Implementation of
+
+[`IQueue`](Interface.IQueue).[`getJobs`](Interface.IQueue#getjobs)
+
+***
+
+### markCompleted()
+
+```ts
+markCompleted(jobId): Promise<IQueueJob<unknown>>;
+```
+
+Defined in: [bullmq/BullMqQueue.ts:116](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/bullmq/BullMqQueue.ts#L116)
+
+Marks a processing job as completed.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `jobId` | `string` | The ID of the job to complete. |
+
+#### Returns
+
+`Promise`\<[`IQueueJob`](Interface.IQueueJob)\<`unknown`\>\>
+
+The updated job in `completed` status.
+
+#### Implementation of
+
+[`IQueue`](Interface.IQueue).[`markCompleted`](Interface.IQueue#markcompleted)
+
+***
+
+### markFailed()
+
+```ts
+markFailed(jobId, errorMessage): Promise<IQueueJob<unknown>>;
+```
+
+Defined in: [bullmq/BullMqQueue.ts:150](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/bullmq/BullMqQueue.ts#L150)
+
+Marks a processing job as failed.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `jobId` | `string` | The ID of the job to mark as failed. |
+| `errorMessage` | `string` | A human-readable error message. |
+
+#### Returns
+
+`Promise`\<[`IQueueJob`](Interface.IQueueJob)\<`unknown`\>\>
+
+The updated job in `failed` status.
+
+#### Implementation of
+
+[`IQueue`](Interface.IQueue).[`markFailed`](Interface.IQueue#markfailed)
+
+***
+
+### onModuleDestroy()
+
+```ts
+onModuleDestroy(): Promise<void>;
+```
+
+Defined in: [bullmq/BullMqQueue.ts:208](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/bullmq/BullMqQueue.ts#L208)
+
+Closes all workers and queues, releasing Redis connections.
+
+Called automatically by the NestJS lifecycle when the module is destroyed.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+```ts
+OnModuleDestroy.onModuleDestroy
+```

package/data/packages/platform-queue/api/Class.MemoryQueue.md

@@ -0,0 +1,194 @@
+---
+title: 'Class: MemoryQueue'
+generated: true
+editUrl: false
+---
+# Class: MemoryQueue
+
+Defined in: [memory/MemoryQueue.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/memory/MemoryQueue.ts#L47)
+
+In-memory FIFO queue implementation.
+
+Stores all jobs in process memory. Suitable for development, testing,
+and lightweight single-instance workloads. Data is lost on process restart.
+
+## Remarks
+
+Jobs are organized per named queue. Capacity enforcement evicts the oldest
+completed or failed jobs when [IMemoryQueueOptions.maxJobs](Interface.IMemoryQueueOptions#maxjobs) is reached.
+
+## Implements
+
+- [`IQueue`](Interface.IQueue)
+
+## Constructors
+
+### Constructor
+
+```ts
+new MemoryQueue(options?): MemoryQueue;
+```
+
+Defined in: [memory/MemoryQueue.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/memory/MemoryQueue.ts#L65)
+
+Creates a new MemoryQueue instance.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options?` | [`IMemoryQueueOptions`](Interface.IMemoryQueueOptions) | Optional configuration. See [IMemoryQueueOptions](Interface.IMemoryQueueOptions). |
+
+#### Returns
+
+`MemoryQueue`
+
+## Methods
+
+### dequeue()
+
+```ts
+dequeue(queueName): Promise<IQueueJob<unknown> | null>;
+```
+
+Defined in: [memory/MemoryQueue.ts:103](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/memory/MemoryQueue.ts#L103)
+
+Dequeues the next pending job from the named queue.
+
+The returned job transitions to `processing` status.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `queueName` | `string` | The name of the queue to dequeue from. |
+
+#### Returns
+
+`Promise`\<[`IQueueJob`](Interface.IQueueJob)\<`unknown`\> \| `null`\>
+
+The next pending job, or `null` if the queue is empty.
+
+#### Implementation of
+
+[`IQueue`](Interface.IQueue).[`dequeue`](Interface.IQueue#dequeue)
+
+***
+
+### enqueue()
+
+```ts
+enqueue<T>(queueName, payload): Promise<IQueueJob<T>>;
+```
+
+Defined in: [memory/MemoryQueue.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/memory/MemoryQueue.ts#L74)
+
+Enqueues a new job into the named queue.
+
+#### Type Parameters
+
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `T` | `unknown` |  |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `queueName` | `string` | The name of the target queue. |
+| `payload` | `T` | The job payload. |
+
+#### Returns
+
+`Promise`\<[`IQueueJob`](Interface.IQueueJob)\<`T`\>\>
+
+The created job in `pending` status.
+
+#### Implementation of
+
+[`IQueue`](Interface.IQueue).[`enqueue`](Interface.IQueue#enqueue)
+
+***
+
+### getJobs()
+
+```ts
+getJobs(queueName): Promise<readonly IQueueJob<unknown>[]>;
+```
+
+Defined in: [memory/MemoryQueue.ts:188](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/memory/MemoryQueue.ts#L188)
+
+Returns all jobs for the given queue in insertion order.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `queueName` | `string` | The name of the queue. |
+
+#### Returns
+
+`Promise`\<readonly [`IQueueJob`](Interface.IQueueJob)\<`unknown`\>[]\>
+
+An array of jobs, possibly empty.
+
+#### Implementation of
+
+[`IQueue`](Interface.IQueue).[`getJobs`](Interface.IQueue#getjobs)
+
+***
+
+### markCompleted()
+
+```ts
+markCompleted(jobId): Promise<IQueueJob<unknown>>;
+```
+
+Defined in: [memory/MemoryQueue.ts:138](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/memory/MemoryQueue.ts#L138)
+
+Marks a processing job as completed.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `jobId` | `string` | The ID of the job to complete. |
+
+#### Returns
+
+`Promise`\<[`IQueueJob`](Interface.IQueueJob)\<`unknown`\>\>
+
+The updated job in `completed` status.
+
+#### Implementation of
+
+[`IQueue`](Interface.IQueue).[`markCompleted`](Interface.IQueue#markcompleted)
+
+***
+
+### markFailed()
+
+```ts
+markFailed(jobId, errorMessage): Promise<IQueueJob<unknown>>;
+```
+
+Defined in: [memory/MemoryQueue.ts:160](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/memory/MemoryQueue.ts#L160)
+
+Marks a processing job as failed.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `jobId` | `string` | The ID of the job to mark as failed. |
+| `errorMessage` | `string` | A human-readable error message. |
+
+#### Returns
+
+`Promise`\<[`IQueueJob`](Interface.IQueueJob)\<`unknown`\>\>
+
+The updated job in `failed` status.
+
+#### Implementation of
+
+[`IQueue`](Interface.IQueue).[`markFailed`](Interface.IQueue#markfailed)

package/data/packages/platform-queue/api/Class.QueueError.md

@@ -0,0 +1,51 @@
+---
+title: 'Class: QueueError'
+generated: true
+editUrl: false
+---
+# Class: QueueError
+
+Defined in: [errors/QueueError.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/errors/QueueError.ts#L9)
+
+Base error class for all queue-related errors.
+
+Every domain-specific queue error (validation, not-found, state) extends
+this class so consumers can catch the entire hierarchy with a single type.
+
+## Extends
+
+- `Error`
+
+## Extended by
+
+- [`QueueJobNotFoundError`](Class.QueueJobNotFoundError)
+- [`QueueJobStateError`](Class.QueueJobStateError)
+- [`QueueValidationError`](Class.QueueValidationError)
+
+## Constructors
+
+### Constructor
+
+```ts
+new QueueError(message): QueueError;
+```
+
+Defined in: [errors/QueueError.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/errors/QueueError.ts#L17)
+
+Creates a new QueueError.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `message` | `string` | A human-readable description of the error. |
+
+#### Returns
+
+`QueueError`
+
+#### Overrides
+
+```ts
+Error.constructor
+```

package/data/packages/platform-queue/api/Class.QueueHealthIndicator.md

@@ -0,0 +1,68 @@
+---
+title: 'Class: QueueHealthIndicator'
+generated: true
+editUrl: false
+---
+# Class: QueueHealthIndicator
+
+Defined in: health/QueueHealthIndicator.ts:15
+
+Health indicator for the queue infrastructure.
+
+## Implements
+
+- `IHealthIndicator`
+
+## Constructors
+
+### Constructor
+
+```ts
+new QueueHealthIndicator(): QueueHealthIndicator;
+```
+
+#### Returns
+
+`QueueHealthIndicator`
+
+## Properties
+
+### key
+
+```ts
+readonly key: string = 'queue';
+```
+
+Defined in: health/QueueHealthIndicator.ts:18
+
+Unique key identifying the indicator
+
+#### Implementation of
+
+```ts
+IHealthIndicator.key
+```
+
+## Methods
+
+### check()
+
+```ts
+check(): HealthIndicatorResult<string>;
+```
+
+Defined in: health/QueueHealthIndicator.ts:30
+
+Returns the health status of the queue infrastructure.
+
+#### Returns
+
+`HealthIndicatorResult`\<`string`\>
+
+The health indicator result.
+
+#### Implementation of
+
+```ts
+IHealthIndicator.check
+```

package/data/packages/platform-queue/api/Class.QueueJobNotFoundError.md

@@ -0,0 +1,43 @@
+---
+title: 'Class: QueueJobNotFoundError'
+generated: true
+editUrl: false
+---
+# Class: QueueJobNotFoundError
+
+Defined in: [errors/QueueJobNotFoundError.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/errors/QueueJobNotFoundError.ts#L15)
+
+Thrown when a queue job cannot be found by its ID.
+
+Typically raised by [IQueue.markCompleted](Interface.IQueue#markcompleted) or [IQueue.markFailed](Interface.IQueue#markfailed)
+when the supplied job identifier does not match any tracked job.
+
+## Extends
+
+- [`QueueError`](Class.QueueError)
+
+## Constructors
+
+### Constructor
+
+```ts
+new QueueJobNotFoundError(jobId): QueueJobNotFoundError;
+```
+
+Defined in: [errors/QueueJobNotFoundError.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/errors/QueueJobNotFoundError.ts#L23)
+
+Creates a new QueueJobNotFoundError.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `jobId` | `string` | The identifier of the job that could not be located. |
+
+#### Returns
+
+`QueueJobNotFoundError`
+
+#### Overrides
+
+[`QueueError`](Class.QueueError).[`constructor`](Class.QueueError#constructor)

package/data/packages/platform-queue/api/Class.QueueJobStateError.md

@@ -0,0 +1,48 @@
+---
+title: 'Class: QueueJobStateError'
+generated: true
+editUrl: false
+---
+# Class: QueueJobStateError
+
+Defined in: [errors/QueueJobStateError.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/errors/QueueJobStateError.ts#L15)
+
+Thrown when a queue job is in an invalid state for the requested transition.
+
+For example, calling [IQueue.markCompleted](Interface.IQueue#markcompleted) on a job that is still
+in `pending` status rather than `processing` triggers this error.
+
+## Extends
+
+- [`QueueError`](Class.QueueError)
+
+## Constructors
+
+### Constructor
+
+```ts
+new QueueJobStateError(
+   jobId, 
+   expectedStatus, 
+   actualStatus): QueueJobStateError;
+```
+
+Defined in: [errors/QueueJobStateError.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/errors/QueueJobStateError.ts#L25)
+
+Creates a new QueueJobStateError.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `jobId` | `string` | The identifier of the affected job. |
+| `expectedStatus` | `string` | The status required for the attempted transition. |
+| `actualStatus` | `string` | The current status of the job. |
+
+#### Returns
+
+`QueueJobStateError`
+
+#### Overrides
+
+[`QueueError`](Class.QueueError).[`constructor`](Class.QueueError#constructor)

package/data/packages/platform-queue/api/Class.QueueValidationError.md

@@ -0,0 +1,43 @@
+---
+title: 'Class: QueueValidationError'
+generated: true
+editUrl: false
+---
+# Class: QueueValidationError
+
+Defined in: [errors/QueueValidationError.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/errors/QueueValidationError.ts#L15)
+
+Thrown when a queue operation receives invalid input.
+
+Common triggers include an empty or whitespace-only queue name,
+or an empty error message passed to [IQueue.markFailed](Interface.IQueue#markfailed).
+
+## Extends
+
+- [`QueueError`](Class.QueueError)
+
+## Constructors
+
+### Constructor
+
+```ts
+new QueueValidationError(message): QueueValidationError;
+```
+
+Defined in: [errors/QueueValidationError.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/errors/QueueValidationError.ts#L23)
+
+Creates a new QueueValidationError.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `message` | `string` | A human-readable description of the validation failure. |
+
+#### Returns
+
+`QueueValidationError`
+
+#### Overrides
+
+[`QueueError`](Class.QueueError).[`constructor`](Class.QueueError#constructor)

package/data/packages/platform-queue/api/Interface.IAzureQueueOptions.md

@@ -0,0 +1,48 @@
+---
+title: 'Interface: IAzureQueueOptions'
+generated: true
+editUrl: false
+---
+# Interface: IAzureQueueOptions
+
+Defined in: [azure/AzureQueue.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L19)
+
+Configuration options for [AzureQueue](Class.AzureQueue).
+
+## Properties
+
+### connectionString
+
+```ts
+connectionString: string;
+```
+
+Defined in: [azure/AzureQueue.ts:28](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L28)
+
+Azure Service Bus connection string.
+
+#### Example
+
+```ts
+`Endpoint=sb://my-namespace.servicebus.windows.net/;SharedAccessKeyName=...;SharedAccessKey=...`
+@public
+```
+
+***
+
+### receiveWaitMs?
+
+```ts
+optional receiveWaitMs?: number;
+```
+
+Defined in: [azure/AzureQueue.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L36)
+
+Maximum wait time in milliseconds when receiving messages.
+
+#### Default Value
+
+```ts
+5_000
+@public
+```