@breadstone/archipel-mcp 0.0.23 → 0.0.26

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

@@ -0,0 +1,221 @@
+---
+title: 'Class: AzureQueue'
+generated: true
+editUrl: false
+---
+# Class: AzureQueue
+
+Defined in: [azure/AzureQueue.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L56)
+
+Azure Service Bus queue implementation.
+
+Uses Azure Service Bus for cloud-native, enterprise-grade messaging.
+Operates in peek-lock mode: dequeued messages remain locked until
+explicitly completed or dead-lettered.
+
+## Remarks
+
+Senders and receivers are lazily created per queue name and cached for
+the lifetime of the instance. Call [onModuleDestroy](#onmoduledestroy) (handled
+automatically by NestJS) to release all underlying connections.
+
+## Implements
+
+- [`IQueue`](Interface.IQueue)
+- `OnModuleDestroy`
+
+## Constructors
+
+### Constructor
+
+```ts
+new AzureQueue(options): AzureQueue;
+```
+
+Defined in: [azure/AzureQueue.ts:76](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L76)
+
+Creates a new AzureQueue instance.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`IAzureQueueOptions`](Interface.IAzureQueueOptions) | Connection and receive configuration. See [IAzureQueueOptions](Interface.IAzureQueueOptions). |
+
+#### Returns
+
+`AzureQueue`
+
+## Methods
+
+### dequeue()
+
+```ts
+dequeue(queueName): Promise<IQueueJob<unknown> | null>;
+```
+
+Defined in: [azure/AzureQueue.ts:115](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L115)
+
+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: [azure/AzureQueue.ts:86](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L86)
+
+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: [azure/AzureQueue.ts:222](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L222)
+
+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: [azure/AzureQueue.ts:147](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L147)
+
+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: [azure/AzureQueue.ts:180](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L180)
+
+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: [azure/AzureQueue.ts:247](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/AzureQueue.ts#L247)
+
+Closes all senders, receivers, and the underlying Service Bus client.
+
+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.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
+```