@breadstone/archipel-mcp 0.0.28 → 0.0.31

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 (52) hide show
  1. package/data/guides/queue-infrastructure.md +62 -0
  2. package/data/packages/platform-analytics/index.md +2 -0
  3. package/data/packages/platform-authentication/api/Class.AuthModule.md +3 -3
  4. package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +37 -5
  5. package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +12 -12
  6. package/data/packages/platform-authentication/api/index.md +1 -2
  7. package/data/packages/platform-authentication/index.md +2 -0
  8. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +1 -1
  9. package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +1 -1
  10. package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +1 -1
  11. package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +1 -1
  12. package/data/packages/platform-blob-storage/index.md +2 -0
  13. package/data/packages/platform-caching/index.md +2 -0
  14. package/data/packages/platform-configuration/index.md +2 -0
  15. package/data/packages/platform-core/index.md +2 -0
  16. package/data/packages/platform-cryptography/index.md +2 -0
  17. package/data/packages/platform-database/index.md +2 -0
  18. package/data/packages/platform-documents/index.md +2 -0
  19. package/data/packages/platform-esigning/index.md +2 -0
  20. package/data/packages/platform-health/index.md +2 -0
  21. package/data/packages/platform-intelligence/index.md +2 -0
  22. package/data/packages/platform-logging/index.md +2 -0
  23. package/data/packages/platform-mailing/index.md +2 -0
  24. package/data/packages/platform-mapping/index.md +2 -0
  25. package/data/packages/platform-mcp/index.md +2 -0
  26. package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +54 -3
  27. package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +7 -5
  28. package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +24 -7
  29. package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +18 -6
  30. package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +9 -2
  31. package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +8 -5
  32. package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +33 -7
  33. package/data/packages/platform-openapi/api/Interface.ISwaggerThemeConfig.md +59 -0
  34. package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +4 -1
  35. package/data/packages/platform-openapi/api/index.md +6 -5
  36. package/data/packages/platform-openapi/index.md +2 -0
  37. package/data/packages/platform-payments/index.md +2 -0
  38. package/data/packages/platform-queue/api/Class.VercelQueue.md +234 -0
  39. package/data/packages/platform-queue/api/Interface.IVercelQueueOptions.md +91 -0
  40. package/data/packages/platform-queue/api/Variable.VERCEL_CONFIG_ENTRIES.md +17 -0
  41. package/data/packages/platform-queue/api/Variable.VERCEL_QUEUE_CONSUMER_GROUP.md +14 -0
  42. package/data/packages/platform-queue/api/Variable.VERCEL_QUEUE_DEPLOYMENT_ID.md +14 -0
  43. package/data/packages/platform-queue/api/Variable.VERCEL_QUEUE_REGION.md +14 -0
  44. package/data/packages/platform-queue/api/Variable.VERCEL_QUEUE_TOKEN.md +16 -0
  45. package/data/packages/platform-queue/api/Variable.VERCEL_QUEUE_VISIBILITY_TIMEOUT_SECONDS.md +23 -0
  46. package/data/packages/platform-queue/api/index.md +8 -0
  47. package/data/packages/platform-queue/index.md +27 -3
  48. package/data/packages/platform-reporting/index.md +2 -0
  49. package/data/packages/platform-resources/index.md +2 -0
  50. package/data/packages/platform-telemetry/index.md +2 -0
  51. package/package.json +1 -1
  52. package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +0 -40
@@ -0,0 +1,91 @@
1
+ ---
2
+ title: 'Interface: IVercelQueueOptions'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Interface: IVercelQueueOptions
7
+
8
+ Defined in: [vercel/VercelQueue.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L35)
9
+
10
+ Configuration options for [VercelQueue](Class.VercelQueue).
11
+
12
+ ## Properties
13
+
14
+ ### consumerGroup
15
+
16
+ ```ts
17
+ consumerGroup: string;
18
+ ```
19
+
20
+ Defined in: [vercel/VercelQueue.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L55)
21
+
22
+ Consumer group name used when receiving messages.
23
+
24
+ Each consumer group independently tracks its position in the topic.
25
+
26
+ ***
27
+
28
+ ### deploymentId?
29
+
30
+ ```ts
31
+ optional deploymentId?: string | null;
32
+ ```
33
+
34
+ Defined in: [vercel/VercelQueue.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L75)
35
+
36
+ Deployment ID for per-deployment message isolation.
37
+
38
+ - `undefined` — auto-detected from `VERCEL_DEPLOYMENT_ID` (pinned).
39
+ - `null` — unpinned (messages shared across deployments).
40
+ - Explicit string — pinned to the given deployment.
41
+
42
+ ***
43
+
44
+ ### region
45
+
46
+ ```ts
47
+ region: string;
48
+ ```
49
+
50
+ Defined in: [vercel/VercelQueue.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L46)
51
+
52
+ Vercel region code (e.g. `iad1`, `fra1`, `sfo1`).
53
+
54
+ Required — messages can only be consumed from the region they were
55
+ sent to. Use a fixed region for both sending and receiving.
56
+
57
+ ***
58
+
59
+ ### token?
60
+
61
+ ```ts
62
+ optional token?: string;
63
+ ```
64
+
65
+ Defined in: [vercel/VercelQueue.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L64)
66
+
67
+ Vercel OIDC bearer token for authentication.
68
+
69
+ When omitted the SDK auto-fetches a token via OIDC.
70
+
71
+ ***
72
+
73
+ ### visibilityTimeoutSeconds?
74
+
75
+ ```ts
76
+ optional visibilityTimeoutSeconds?: number;
77
+ ```
78
+
79
+ Defined in: [vercel/VercelQueue.ts:86](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L86)
80
+
81
+ Visibility timeout in seconds for received messages.
82
+
83
+ The SDK automatically re-extends the lease while the handler is
84
+ running, so the default of 300 s is suitable for most workloads.
85
+
86
+ #### Default Value
87
+
88
+ ```ts
89
+ 300
90
+ @public
91
+ ```
@@ -0,0 +1,17 @@
1
+ ---
2
+ title: 'Variable: VERCEL\_CONFIG\_ENTRIES'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: VERCEL\_CONFIG\_ENTRIES
7
+
8
+ ```ts
9
+ const VERCEL_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
10
+ ```
11
+
12
+ Defined in: [vercel/env.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/env.ts#L65)
13
+
14
+ All configuration entries required by the Vercel queue provider.
15
+
16
+ Pass this array to the module's `register()` method so that the
17
+ configuration service validates and provides the values at startup.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: VERCEL\_QUEUE\_CONSUMER\_GROUP'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: VERCEL\_QUEUE\_CONSUMER\_GROUP
7
+
8
+ ```ts
9
+ const VERCEL_QUEUE_CONSUMER_GROUP: IConfigKey<string>;
10
+ ```
11
+
12
+ Defined in: [vercel/env.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/env.ts#L32)
13
+
14
+ Consumer group name for receiving messages.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: VERCEL\_QUEUE\_DEPLOYMENT\_ID'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: VERCEL\_QUEUE\_DEPLOYMENT\_ID
7
+
8
+ ```ts
9
+ const VERCEL_QUEUE_DEPLOYMENT_ID: IConfigKey<string>;
10
+ ```
11
+
12
+ Defined in: [vercel/env.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/env.ts#L51)
13
+
14
+ Optional Vercel deployment ID for per-deployment message isolation.
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: 'Variable: VERCEL\_QUEUE\_REGION'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: VERCEL\_QUEUE\_REGION
7
+
8
+ ```ts
9
+ const VERCEL_QUEUE_REGION: IConfigKey<string>;
10
+ ```
11
+
12
+ Defined in: [vercel/env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/env.ts#L16)
13
+
14
+ Vercel region code (e.g. `iad1`, `fra1`, `sfo1`).
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: 'Variable: VERCEL\_QUEUE\_TOKEN'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: VERCEL\_QUEUE\_TOKEN
7
+
8
+ ```ts
9
+ const VERCEL_QUEUE_TOKEN: IConfigKey<string>;
10
+ ```
11
+
12
+ Defined in: [vercel/env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/env.ts#L25)
13
+
14
+ Vercel OIDC bearer token for queue authentication.
15
+
16
+ When omitted the SDK auto-fetches a token via OIDC.
@@ -0,0 +1,23 @@
1
+ ---
2
+ title: 'Variable: VERCEL\_QUEUE\_VISIBILITY\_TIMEOUT\_SECONDS'
3
+ generated: true
4
+ editUrl: false
5
+ ---
6
+ # Variable: VERCEL\_QUEUE\_VISIBILITY\_TIMEOUT\_SECONDS
7
+
8
+ ```ts
9
+ const VERCEL_QUEUE_VISIBILITY_TIMEOUT_SECONDS: IConfigKey<number>;
10
+ ```
11
+
12
+ Defined in: [vercel/env.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/env.ts#L42)
13
+
14
+ Visibility timeout in seconds for received messages.
15
+
16
+ The SDK automatically re-extends the lease while the handler runs.
17
+
18
+ ## Default Value
19
+
20
+ ```ts
21
+ 300
22
+ @public
23
+ ```
@@ -17,6 +17,7 @@ editUrl: false
17
17
  | [QueueJobNotFoundError](Class.QueueJobNotFoundError) | Thrown when a queue job cannot be found by its ID. |
18
18
  | [QueueJobStateError](Class.QueueJobStateError) | Thrown when a queue job is in an invalid state for the requested transition. |
19
19
  | [QueueValidationError](Class.QueueValidationError) | Thrown when a queue operation receives invalid input. |
20
+ | [VercelQueue](Class.VercelQueue) | Vercel Queues implementation of the [IQueue](Interface.IQueue) contract. |
20
21
 
21
22
  ## Interfaces
22
23
 
@@ -27,6 +28,7 @@ editUrl: false
27
28
  | [IMemoryQueueOptions](Interface.IMemoryQueueOptions) | Configuration options for [MemoryQueue](Class.MemoryQueue). |
28
29
  | [IQueue](Interface.IQueue) | Contract for queue implementations. |
29
30
  | [IQueueJob](Interface.IQueueJob) | Represents a job in a named queue with tracking metadata. |
31
+ | [IVercelQueueOptions](Interface.IVercelQueueOptions) | Configuration options for [VercelQueue](Class.VercelQueue). |
30
32
 
31
33
  ## Type Aliases
32
34
 
@@ -47,3 +49,9 @@ editUrl: false
47
49
  | [PLATFORM\_QUEUE\_CONFIG\_ENTRIES](Variable.PLATFORM_QUEUE_CONFIG_ENTRIES) | All configuration entries required by `platform-queue`. |
48
50
  | [QUEUE\_JOB\_STATUS](Variable.QUEUE_JOB_STATUS) | Possible statuses of a queue job. |
49
51
  | [QUEUE\_MAX\_JOBS](Variable.QUEUE_MAX_JOBS) | Maximum number of jobs retained in the in-memory queue before eviction. |
52
+ | [VERCEL\_CONFIG\_ENTRIES](Variable.VERCEL_CONFIG_ENTRIES) | All configuration entries required by the Vercel queue provider. |
53
+ | [VERCEL\_QUEUE\_CONSUMER\_GROUP](Variable.VERCEL_QUEUE_CONSUMER_GROUP) | Consumer group name for receiving messages. |
54
+ | [VERCEL\_QUEUE\_DEPLOYMENT\_ID](Variable.VERCEL_QUEUE_DEPLOYMENT_ID) | Optional Vercel deployment ID for per-deployment message isolation. |
55
+ | [VERCEL\_QUEUE\_REGION](Variable.VERCEL_QUEUE_REGION) | Vercel region code (e.g. `iad1`, `fra1`, `sfo1`). |
56
+ | [VERCEL\_QUEUE\_TOKEN](Variable.VERCEL_QUEUE_TOKEN) | Vercel OIDC bearer token for queue authentication. |
57
+ | [VERCEL\_QUEUE\_VISIBILITY\_TIMEOUT\_SECONDS](Variable.VERCEL_QUEUE_VISIBILITY_TIMEOUT_SECONDS) | Visibility timeout in seconds for received messages. |
@@ -1,17 +1,19 @@
1
1
  ---
2
2
  title: platform-queue
3
- description: Provider-agnostic queue infrastructure with support for in-memory FIFO, BullMQ (Redis), and Azure Service Bus.
3
+ description: Provider-agnostic queue infrastructure with support for in-memory FIFO, BullMQ (Redis), Azure Service Bus, and Vercel Queues.
4
4
  order: 19
5
- tags: [queue, job-queue, fifo, memory-queue, bullmq, redis, azure-service-bus, ports-and-adapters, health]
5
+ tags: [queue, job-queue, fifo, memory-queue, bullmq, redis, azure-service-bus, vercel-queues, ports-and-adapters, health]
6
6
  package: '@breadstone/archipel-platform-queue'
7
7
  ---
8
8
 
9
9
  # platform-queue
10
10
 
11
- Provider-agnostic queue infrastructure for NestJS. Exposes a unified `IQueue` contract with three ready-made implementations: in-memory FIFO (`MemoryQueue`), BullMQ/Redis (`BullMqQueue`), and Azure Service Bus (`AzureQueue`). Jobs follow a lifecycle from pending through processing to completed or failed, with full metadata tracking.
11
+ Provider-agnostic queue infrastructure for NestJS. Exposes a unified `IQueue` contract with four ready-made implementations: in-memory FIFO (`MemoryQueue`), BullMQ/Redis (`BullMqQueue`), Azure Service Bus (`AzureQueue`), and Vercel Queues (`VercelQueue`). Jobs follow a lifecycle from pending through processing to completed or failed, with full metadata tracking.
12
12
 
13
13
  **Package:** `@breadstone/archipel-platform-queue`
14
14
 
15
+ <InstallTabs />
16
+
15
17
  ## Architecture
16
18
 
17
19
  ```mermaid
@@ -19,12 +21,15 @@ graph TD
19
21
  Core["@breadstone/archipel-platform-queue<br/><i>IQueue, models, errors, MemoryQueue</i>"]
20
22
  BullMQ["@breadstone/archipel-platform-queue/bullmq<br/><i>BullMqQueue</i>"]
21
23
  Azure["@breadstone/archipel-platform-queue/azure<br/><i>AzureQueue</i>"]
24
+ Vercel["@breadstone/archipel-platform-queue/vercel<br/><i>VercelQueue</i>"]
22
25
 
23
26
  BullMQ -->|implements| Core
24
27
  Azure -->|implements| Core
28
+ Vercel -->|implements| Core
25
29
 
26
30
  BullMQ -.-|requires| R["bullmq"]
27
31
  Azure -.-|requires| S["@azure/service-bus"]
32
+ Vercel -.-|requires| V["@vercel/queue"]
28
33
  ```
29
34
 
30
35
  Each provider SDK is an **optional peer dependency**. Install only the one you need. `MemoryQueue` ships with the core entry point and requires no additional dependencies.
@@ -39,6 +44,7 @@ Each provider SDK is an **optional peer dependency**. Install only the one you n
39
44
  # Pick one (or use MemoryQueue without any extra SDK):
40
45
  yarn add bullmq
41
46
  yarn add @azure/service-bus
47
+ yarn add @vercel/queue
42
48
  ```
43
49
 
44
50
  ### 2. Register the queue
@@ -112,6 +118,23 @@ import { BullMqQueue, BULLMQ_CONFIG_ENTRIES } from '@breadstone/archipel-platfor
112
118
  import { AzureQueue, AZURE_CONFIG_ENTRIES } from '@breadstone/archipel-platform-queue/azure';
113
119
  ```
114
120
 
121
+ ### Vercel Queues
122
+
123
+ **Subpath:** `@breadstone/archipel-platform-queue/vercel`
124
+ **SDK:** `@vercel/queue` ≥ 0.1.0
125
+
126
+ | Variable | Required | Default | Description |
127
+ | --------------------------------------- | -------- | ------- | ----------------------------------------------------- |
128
+ | `VERCEL_QUEUE_REGION` | Yes | — | Vercel region code (e.g. `iad1`, `fra1`, `sfo1`) |
129
+ | `VERCEL_QUEUE_CONSUMER_GROUP` | Yes | — | Consumer group name for receiving messages |
130
+ | `VERCEL_QUEUE_TOKEN` | No | — | OIDC bearer token (auto-fetched when omitted) |
131
+ | `VERCEL_QUEUE_DEPLOYMENT_ID` | No | — | Deployment ID for per-deployment message isolation |
132
+ | `VERCEL_QUEUE_VISIBILITY_TIMEOUT_SECONDS`| No | `300` | Visibility timeout in seconds for received messages |
133
+
134
+ ```typescript
135
+ import { VercelQueue, VERCEL_CONFIG_ENTRIES } from '@breadstone/archipel-platform-queue/vercel';
136
+ ```
137
+
115
138
  ---
116
139
 
117
140
  ## Job Lifecycle
@@ -166,3 +189,4 @@ export class AppModule {}
166
189
  | `@nestjs/common` | Yes | NestJS core |
167
190
  | `bullmq` | Optional | Required for BullMQ provider |
168
191
  | `@azure/service-bus` | Optional | Required for Azure Service Bus |
192
+ | `@vercel/queue` | Optional | Required for Vercel Queues |
@@ -12,6 +12,8 @@ Extensible business reporting framework using a contributor registry pattern. Fe
12
12
 
13
13
  **Package:** `@breadstone/archipel-platform-reporting`
14
14
 
15
+ <InstallTabs />
16
+
15
17
  ## Quick Start
16
18
 
17
19
  ```typescript
@@ -12,6 +12,8 @@ Multi-strategy resource management for NestJS applications. Loads files from the
12
12
 
13
13
  **Package:** `@breadstone/archipel-platform-resources`
14
14
 
15
+ <InstallTabs />
16
+
15
17
  ## Installation
16
18
 
17
19
  ```typescript
@@ -12,6 +12,8 @@ OpenTelemetry integration providing distributed tracing, metrics collection, and
12
12
 
13
13
  **Package:** `@breadstone/archipel-platform-telemetry`
14
14
 
15
+ <InstallTabs />
16
+
15
17
  ## Quick Start
16
18
 
17
19
  ```typescript
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@breadstone/archipel-mcp",
3
- "version": "0.0.28",
3
+ "version": "0.0.31",
4
4
  "description": "MCP server providing Archipel platform knowledge - documentation, query patterns, and coding conventions - to AI development tools.",
5
5
  "type": "commonjs",
6
6
  "main": "./src/main.js",
@@ -1,40 +0,0 @@
1
- ---
2
- title: 'Class: GithubAuthGuard'
3
- generated: true
4
- editUrl: false
5
- ---
6
- # Class: GithubAuthGuard
7
-
8
- Defined in: [libs/platform-authentication/src/guards/GithubAuthGuard.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/guards/GithubAuthGuard.ts#L14)
9
-
10
- The `GithubAuthGuard` protects routes using GitHub authentication.
11
-
12
- ## Extends
13
-
14
- - `IAuthGuard`
15
-
16
- ## Constructors
17
-
18
- ### Constructor
19
-
20
- ```ts
21
- new GithubAuthGuard(...args): GithubAuthGuard;
22
- ```
23
-
24
- Defined in: node\_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
25
-
26
- #### Parameters
27
-
28
- | Parameter | Type |
29
- | ------ | ------ |
30
- | ...`args` | `any`[] |
31
-
32
- #### Returns
33
-
34
- `GithubAuthGuard`
35
-
36
- #### Inherited from
37
-
38
- ```ts
39
- AuthGuard('github').constructor
40
- ```