@breadstone/archipel-mcp 0.0.23 → 0.0.25

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

@@ -0,0 +1,45 @@
+---
+title: 'Interface: IBullMqQueueOptions'
+generated: true
+editUrl: false
+---
+# Interface: IBullMqQueueOptions
+
+Defined in: [bullmq/BullMqQueue.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/bullmq/BullMqQueue.ts#L20)
+
+Configuration options for [BullMqQueue](Class.BullMqQueue).
+
+## Properties
+
+### prefix?
+
+```ts
+optional prefix?: string;
+```
+
+Defined in: [bullmq/BullMqQueue.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/bullmq/BullMqQueue.ts#L37)
+
+Optional prefix applied to all BullMQ queue keys in Redis.
+
+#### Default Value
+
+`''`
+
+***
+
+### redisUrl
+
+```ts
+redisUrl: string;
+```
+
+Defined in: [bullmq/BullMqQueue.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/bullmq/BullMqQueue.ts#L29)
+
+Redis connection URL.
+
+#### Example
+
+```ts
+`redis://localhost:6379`
+@public
+```

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

@@ -0,0 +1,32 @@
+---
+title: 'Interface: IMemoryQueueOptions'
+generated: true
+editUrl: false
+---
+# Interface: IMemoryQueueOptions
+
+Defined in: [memory/MemoryQueue.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/memory/MemoryQueue.ts#L17)
+
+Configuration options for [MemoryQueue](Class.MemoryQueue).
+
+## Properties
+
+### maxJobs?
+
+```ts
+optional maxJobs?: number;
+```
+
+Defined in: [memory/MemoryQueue.ts:29](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/memory/MemoryQueue.ts#L29)
+
+Maximum number of jobs retained across all queues.
+
+When the limit is exceeded, the oldest completed or failed jobs
+are evicted first. Defaults to `10_000`.
+
+#### Default Value
+
+```ts
+10_000
+@public
+```

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

@@ -0,0 +1,173 @@
+---
+title: 'Interface: IQueue\<TPayload\>'
+generated: true
+editUrl: false
+---
+# Interface: IQueue\<TPayload\>
+
+Defined in: [interfaces/IQueue.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/interfaces/IQueue.ts#L23)
+
+Contract for queue implementations.
+
+Provides FIFO job enqueue/dequeue, status transitions, and listing.
+Implementations may be in-memory, Redis-backed, or cloud-service-backed.
+
+## Remarks
+
+All methods are asynchronous and return [IQueueJob](Interface.IQueueJob) instances.
+Errors are signalled via domain-specific exceptions:
+- [QueueValidationError](Class.QueueValidationError) for invalid input.
+- [QueueJobNotFoundError](Class.QueueJobNotFoundError) when a job ID cannot be resolved.
+- [QueueJobStateError](Class.QueueJobStateError) when a job is in the wrong state for a transition.
+
+## Type Parameters
+
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `TPayload` | `unknown` | The default payload type for jobs in this queue. Defaults to `unknown`. |
+
+## Methods
+
+### dequeue()
+
+```ts
+dequeue(queueName): Promise<IQueueJob<unknown> | null>;
+```
+
+Defined in: [interfaces/IQueue.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/interfaces/IQueue.ts#L45)
+
+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.
+
+***
+
+### enqueue()
+
+```ts
+enqueue<T>(queueName, payload): Promise<IQueueJob<T>>;
+```
+
+Defined in: [interfaces/IQueue.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/interfaces/IQueue.ts#L34)
+
+Enqueues a new job into the named queue.
+
+#### Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `T` | `TPayload` |
+
+#### 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.
+
+***
+
+### getJobs()
+
+```ts
+getJobs(queueName): Promise<readonly IQueueJob<unknown>[]>;
+```
+
+Defined in: [interfaces/IQueue.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/interfaces/IQueue.ts#L77)
+
+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.
+
+***
+
+### markCompleted()
+
+```ts
+markCompleted(jobId): Promise<IQueueJob<unknown>>;
+```
+
+Defined in: [interfaces/IQueue.ts:56](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/interfaces/IQueue.ts#L56)
+
+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.
+
+#### Throws
+
+[QueueJobNotFoundError](Class.QueueJobNotFoundError) When no job with the given ID exists.
+
+#### Throws
+
+[QueueJobStateError](Class.QueueJobStateError) When the job is not in `processing` status.
+
+***
+
+### markFailed()
+
+```ts
+markFailed(jobId, errorMessage): Promise<IQueueJob<unknown>>;
+```
+
+Defined in: [interfaces/IQueue.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/interfaces/IQueue.ts#L68)
+
+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.
+
+#### Throws
+
+[QueueJobNotFoundError](Class.QueueJobNotFoundError) When no job with the given ID exists.
+
+#### Throws
+
+[QueueJobStateError](Class.QueueJobStateError) When the job is not in `processing` status.

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

@@ -0,0 +1,139 @@
+---
+title: 'Interface: IQueueJob\<TPayload\>'
+generated: true
+editUrl: false
+---
+# Interface: IQueueJob\<TPayload\>
+
+Defined in: [models/IQueueJob.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/models/IQueueJob.ts#L37)
+
+Represents a job in a named queue with tracking metadata.
+
+All queue implementations return objects conforming to this interface,
+making it the unified exchange type between producers and consumers.
+
+## Type Parameters
+
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `TPayload` | `unknown` | The type of the job payload. Defaults to `unknown`. |
+
+## Properties
+
+### attempts
+
+```ts
+readonly attempts: number;
+```
+
+Defined in: [models/IQueueJob.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/models/IQueueJob.ts#L51)
+
+Number of processing attempts.
+
+***
+
+### completedAt
+
+```ts
+readonly completedAt: Date | null;
+```
+
+Defined in: [models/IQueueJob.ts:60](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/models/IQueueJob.ts#L60)
+
+Timestamp when the job completed successfully.
+
+***
+
+### createdAt
+
+```ts
+readonly createdAt: Date;
+```
+
+Defined in: [models/IQueueJob.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/models/IQueueJob.ts#L54)
+
+Timestamp when the job was created.
+
+***
+
+### errorMessage
+
+```ts
+readonly errorMessage: string | null;
+```
+
+Defined in: [models/IQueueJob.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/models/IQueueJob.ts#L66)
+
+Error message from the last failure, if any.
+
+***
+
+### failedAt
+
+```ts
+readonly failedAt: Date | null;
+```
+
+Defined in: [models/IQueueJob.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/models/IQueueJob.ts#L63)
+
+Timestamp when the job last failed.
+
+***
+
+### id
+
+```ts
+readonly id: string;
+```
+
+Defined in: [models/IQueueJob.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/models/IQueueJob.ts#L39)
+
+Unique job identifier.
+
+***
+
+### payload
+
+```ts
+readonly payload: TPayload;
+```
+
+Defined in: [models/IQueueJob.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/models/IQueueJob.ts#L45)
+
+The job payload.
+
+***
+
+### queueName
+
+```ts
+readonly queueName: string;
+```
+
+Defined in: [models/IQueueJob.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/models/IQueueJob.ts#L42)
+
+Name of the queue this job belongs to.
+
+***
+
+### startedAt
+
+```ts
+readonly startedAt: Date | null;
+```
+
+Defined in: [models/IQueueJob.ts:57](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/models/IQueueJob.ts#L57)
+
+Timestamp when the job was last picked up for processing.
+
+***
+
+### status
+
+```ts
+readonly status: QueueJobStatus;
+```
+
+Defined in: [models/IQueueJob.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/models/IQueueJob.ts#L48)
+
+Current status of the job.

package/data/packages/platform-queue/api/TypeAlias.QueueJobStatus.md

@@ -0,0 +1,14 @@
+---
+title: 'Type Alias: QueueJobStatus'
+generated: true
+editUrl: false
+---
+# Type Alias: QueueJobStatus
+
+```ts
+type QueueJobStatus = typeof QUEUE_JOB_STATUS[keyof typeof QUEUE_JOB_STATUS];
+```
+
+Defined in: [models/IQueueJob.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/models/IQueueJob.ts#L26)
+
+Union type derived from [QUEUE\_JOB\_STATUS](Variable.QUEUE_JOB_STATUS).

package/data/packages/platform-queue/api/Variable.AZURE_CONFIG_ENTRIES.md

@@ -0,0 +1,17 @@
+---
+title: 'Variable: AZURE\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: AZURE\_CONFIG\_ENTRIES
+
+```ts
+const AZURE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: [azure/env.ts:38](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/env.ts#L38)
+
+All configuration entries required by the Azure queue provider.
+
+Pass this array to the module's `register()` method so that the
+configuration service validates and provides the values at startup.

package/data/packages/platform-queue/api/Variable.AZURE_CONNECTION_STRING.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: AZURE\_CONNECTION\_STRING'
+generated: true
+editUrl: false
+---
+# Variable: AZURE\_CONNECTION\_STRING
+
+```ts
+const AZURE_CONNECTION_STRING: IConfigKey<string>;
+```
+
+Defined in: [azure/env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/env.ts#L16)
+
+Azure queue connection string.

package/data/packages/platform-queue/api/Variable.AZURE_RECEIVE_WAIT_MS.md

@@ -0,0 +1,21 @@
+---
+title: 'Variable: AZURE\_RECEIVE\_WAIT\_MS'
+generated: true
+editUrl: false
+---
+# Variable: AZURE\_RECEIVE\_WAIT\_MS
+
+```ts
+const AZURE_RECEIVE_WAIT_MS: IConfigKey<number>;
+```
+
+Defined in: [azure/env.ts:24](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/azure/env.ts#L24)
+
+Maximum wait time in milliseconds when receiving messages.
+
+## Default Value
+
+```ts
+5_000
+@public
+```

package/data/packages/platform-queue/api/Variable.BULLMQ_CONFIG_ENTRIES.md

@@ -0,0 +1,17 @@
+---
+title: 'Variable: BULLMQ\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: BULLMQ\_CONFIG\_ENTRIES
+
+```ts
+const BULLMQ_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: [bullmq/env.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/bullmq/env.ts#L39)
+
+All configuration entries required by the BullMQ queue provider.
+
+Pass this array to the module's `register()` method so that the
+configuration service validates and provides the values at startup.

package/data/packages/platform-queue/api/Variable.BULLMQ_PREFIX.md

@@ -0,0 +1,18 @@
+---
+title: 'Variable: BULLMQ\_PREFIX'
+generated: true
+editUrl: false
+---
+# Variable: BULLMQ\_PREFIX
+
+```ts
+const BULLMQ_PREFIX: IConfigKey<string>;
+```
+
+Defined in: [bullmq/env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/bullmq/env.ts#L25)
+
+Optional key prefix applied to all BullMQ queues in Redis.
+
+## Default Value
+
+`''`

package/data/packages/platform-queue/api/Variable.BULLMQ_REDIS_URL.md

@@ -0,0 +1,21 @@
+---
+title: 'Variable: BULLMQ\_REDIS\_URL'
+generated: true
+editUrl: false
+---
+# Variable: BULLMQ\_REDIS\_URL
+
+```ts
+const BULLMQ_REDIS_URL: IConfigKey<string>;
+```
+
+Defined in: [bullmq/env.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/bullmq/env.ts#L17)
+
+Redis connection URL for BullMQ.
+
+## Example
+
+```ts
+`redis://localhost:6379`
+@public
+```

package/data/packages/platform-queue/api/Variable.PLATFORM_QUEUE_CONFIG_ENTRIES.md

@@ -0,0 +1,17 @@
+---
+title: 'Variable: PLATFORM\_QUEUE\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: PLATFORM\_QUEUE\_CONFIG\_ENTRIES
+
+```ts
+const PLATFORM_QUEUE_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: [env.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/env.ts#L31)
+
+All configuration entries required by `platform-queue`.
+
+Pass this array to the module's `register()` method so that the
+configuration service validates and provides the values at startup.

package/data/packages/platform-queue/api/Variable.QUEUE_JOB_STATUS.md

@@ -0,0 +1,30 @@
+---
+title: 'Variable: QUEUE\_JOB\_STATUS'
+generated: true
+editUrl: false
+---
+# Variable: QUEUE\_JOB\_STATUS
+
+```ts
+const QUEUE_JOB_STATUS: {
+  completed: "completed";
+  failed: "failed";
+  pending: "pending";
+  processing: "processing";
+};
+```
+
+Defined in: [models/IQueueJob.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/models/IQueueJob.ts#L10)
+
+Possible statuses of a queue job.
+
+Use as a const object and derive the union type via [QueueJobStatus](TypeAlias.QueueJobStatus).
+
+## Type Declaration
+
+| Name | Type | Default value | Description | Defined in |
+| ------ | ------ | ------ | ------ | ------ |
+| <a id="property-completed"></a> `completed` | `"completed"` | `'completed'` | Job finished successfully. | [models/IQueueJob.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/models/IQueueJob.ts#L16) |
+| <a id="property-failed"></a> `failed` | `"failed"` | `'failed'` | Job finished with an error. | [models/IQueueJob.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/models/IQueueJob.ts#L18) |
+| <a id="property-pending"></a> `pending` | `"pending"` | `'pending'` | Job is waiting to be picked up. | [models/IQueueJob.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/models/IQueueJob.ts#L12) |
+| <a id="property-processing"></a> `processing` | `"processing"` | `'processing'` | Job has been dequeued and is being processed. | [models/IQueueJob.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/models/IQueueJob.ts#L14) |

package/data/packages/platform-queue/api/Variable.QUEUE_MAX_JOBS.md

@@ -0,0 +1,21 @@
+---
+title: 'Variable: QUEUE\_MAX\_JOBS'
+generated: true
+editUrl: false
+---
+# Variable: QUEUE\_MAX\_JOBS
+
+```ts
+const QUEUE_MAX_JOBS: IConfigKey<number>;
+```
+
+Defined in: [env.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/env.ts#L17)
+
+Maximum number of jobs retained in the in-memory queue before eviction.
+
+## Default Value
+
+```ts
+10_000
+@public
+```

package/data/packages/platform-queue/api/index.md

@@ -0,0 +1,49 @@
+---
+title: '@breadstone/archipel-platform-queue'
+generated: true
+editUrl: false
+---
+# @breadstone/archipel-platform-queue
+
+## Classes
+
+| Class | Description |
+| ------ | ------ |
+| [AzureQueue](Class.AzureQueue) | Azure Service Bus queue implementation. |
+| [BullMqQueue](Class.BullMqQueue) | BullMQ-backed queue implementation. |
+| [MemoryQueue](Class.MemoryQueue) | In-memory FIFO queue implementation. |
+| [QueueError](Class.QueueError) | Base error class for all queue-related errors. |
+| [QueueHealthIndicator](Class.QueueHealthIndicator) | Health indicator for the queue infrastructure. |
+| [QueueJobNotFoundError](Class.QueueJobNotFoundError) | Thrown when a queue job cannot be found by its ID. |
+| [QueueJobStateError](Class.QueueJobStateError) | Thrown when a queue job is in an invalid state for the requested transition. |
+| [QueueValidationError](Class.QueueValidationError) | Thrown when a queue operation receives invalid input. |
+
+## Interfaces
+
+| Interface | Description |
+| ------ | ------ |
+| [IAzureQueueOptions](Interface.IAzureQueueOptions) | Configuration options for [AzureQueue](Class.AzureQueue). |
+| [IBullMqQueueOptions](Interface.IBullMqQueueOptions) | Configuration options for [BullMqQueue](Class.BullMqQueue). |
+| [IMemoryQueueOptions](Interface.IMemoryQueueOptions) | Configuration options for [MemoryQueue](Class.MemoryQueue). |
+| [IQueue](Interface.IQueue) | Contract for queue implementations. |
+| [IQueueJob](Interface.IQueueJob) | Represents a job in a named queue with tracking metadata. |
+
+## Type Aliases
+
+| Type Alias | Description |
+| ------ | ------ |
+| [QueueJobStatus](TypeAlias.QueueJobStatus) | Union type derived from [QUEUE\_JOB\_STATUS](Variable.QUEUE_JOB_STATUS). |
+
+## Variables
+
+| Variable | Description |
+| ------ | ------ |
+| [AZURE\_CONFIG\_ENTRIES](Variable.AZURE_CONFIG_ENTRIES) | All configuration entries required by the Azure queue provider. |
+| [AZURE\_CONNECTION\_STRING](Variable.AZURE_CONNECTION_STRING) | Azure queue connection string. |
+| [AZURE\_RECEIVE\_WAIT\_MS](Variable.AZURE_RECEIVE_WAIT_MS) | Maximum wait time in milliseconds when receiving messages. |
+| [BULLMQ\_CONFIG\_ENTRIES](Variable.BULLMQ_CONFIG_ENTRIES) | All configuration entries required by the BullMQ queue provider. |
+| [BULLMQ\_PREFIX](Variable.BULLMQ_PREFIX) | Optional key prefix applied to all BullMQ queues in Redis. |
+| [BULLMQ\_REDIS\_URL](Variable.BULLMQ_REDIS_URL) | Redis connection URL for BullMQ. |
+| [PLATFORM\_QUEUE\_CONFIG\_ENTRIES](Variable.PLATFORM_QUEUE_CONFIG_ENTRIES) | All configuration entries required by `platform-queue`. |
+| [QUEUE\_JOB\_STATUS](Variable.QUEUE_JOB_STATUS) | Possible statuses of a queue job. |
+| [QUEUE\_MAX\_JOBS](Variable.QUEUE_MAX_JOBS) | Maximum number of jobs retained in the in-memory queue before eviction. |