@breadstone/archipel-mcp 0.0.27 → 0.0.30

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

@@ -5,7 +5,7 @@ editUrl: false
 ---
 # Class: QueueHealthIndicator
 
-Defined in: health/QueueHealthIndicator.ts:15
+Defined in: [health/QueueHealthIndicator.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/health/QueueHealthIndicator.ts#L15)
 
 Health indicator for the queue infrastructure.
 
@@ -33,7 +33,7 @@ new QueueHealthIndicator(): QueueHealthIndicator;
 readonly key: string = 'queue';
 ```
 
-Defined in: health/QueueHealthIndicator.ts:18
+Defined in: [health/QueueHealthIndicator.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/health/QueueHealthIndicator.ts#L18)
 
 Unique key identifying the indicator
 
@@ -51,7 +51,7 @@ IHealthIndicator.key
 check(): HealthIndicatorResult<string>;
 ```
 
-Defined in: health/QueueHealthIndicator.ts:30
+Defined in: [health/QueueHealthIndicator.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/health/QueueHealthIndicator.ts#L30)
 
 Returns the health status of the queue infrastructure.
 

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

@@ -0,0 +1,234 @@
+---
+title: 'Class: VercelQueue'
+generated: true
+editUrl: false
+---
+# Class: VercelQueue
+
+Defined in: [vercel/VercelQueue.ts:117](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L117)
+
+Vercel Queues implementation of the [IQueue](Interface.IQueue) contract.
+
+Uses the official `@vercel/queue` SDK (`PollingQueueClient`) for
+durable, serverless message streaming. Messages are published to
+topics and consumed via poll-based consumer groups.
+
+## Remarks
+
+This adapter maps the topic/consumer-group model to the
+[IQueue](Interface.IQueue) interface by treating topic names as queue names.
+
+[dequeue](#dequeue) calls `receive()` on the SDK. The handler callback
+is suspended via an internal gate promise until
+[markCompleted](#markcompleted) or [markFailed](#markfailed) is invoked, at which
+point the handler completes and the SDK auto-acknowledges the
+message. This gives callers explicit control over the job lifecycle
+while relying on the SDK for authentication, serialisation, and
+visibility-timeout extension.
+
+Both [markCompleted](#markcompleted) and [markFailed](#markfailed) acknowledge
+(remove) the message. If retry behaviour is desired, re-enqueue
+the job explicitly.
+
+## Implements
+
+- [`IQueue`](Interface.IQueue)
+- `OnModuleDestroy`
+
+## Constructors
+
+### Constructor
+
+```ts
+new VercelQueue(options): VercelQueue;
+```
+
+Defined in: [vercel/VercelQueue.ts:160](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L160)
+
+Creates a new VercelQueue instance.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | [`IVercelQueueOptions`](Interface.IVercelQueueOptions) | Region, consumer group, and optional SDK configuration. See [IVercelQueueOptions](Interface.IVercelQueueOptions). |
+
+#### Returns
+
+`VercelQueue`
+
+## Methods
+
+### dequeue()
+
+```ts
+dequeue(queueName): Promise<IQueueJob<unknown> | null>;
+```
+
+Defined in: [vercel/VercelQueue.ts:202](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L202)
+
+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: [vercel/VercelQueue.ts:175](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L175)
+
+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: [vercel/VercelQueue.ts:326](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L326)
+
+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: [vercel/VercelQueue.ts:250](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L250)
+
+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: [vercel/VercelQueue.ts:285](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L285)
+
+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: [vercel/VercelQueue.ts:341](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L341)
+
+Releases all pending gates and clears internal tracking maps.
+
+Releasing the gates causes pending SDK handlers to complete
+normally, acknowledging in-flight messages. This prevents
+dangling handlers during graceful shutdown.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+```ts
+OnModuleDestroy.onModuleDestroy
+```

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

@@ -0,0 +1,91 @@
+---
+title: 'Interface: IVercelQueueOptions'
+generated: true
+editUrl: false
+---
+# Interface: IVercelQueueOptions
+
+Defined in: [vercel/VercelQueue.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L35)
+
+Configuration options for [VercelQueue](Class.VercelQueue).
+
+## Properties
+
+### consumerGroup
+
+```ts
+consumerGroup: string;
+```
+
+Defined in: [vercel/VercelQueue.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L55)
+
+Consumer group name used when receiving messages.
+
+Each consumer group independently tracks its position in the topic.
+
+***
+
+### deploymentId?
+
+```ts
+optional deploymentId?: string | null;
+```
+
+Defined in: [vercel/VercelQueue.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L75)
+
+Deployment ID for per-deployment message isolation.
+
+- `undefined` — auto-detected from `VERCEL_DEPLOYMENT_ID` (pinned).
+- `null` — unpinned (messages shared across deployments).
+- Explicit string — pinned to the given deployment.
+
+***
+
+### region
+
+```ts
+region: string;
+```
+
+Defined in: [vercel/VercelQueue.ts:46](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L46)
+
+Vercel region code (e.g. `iad1`, `fra1`, `sfo1`).
+
+Required — messages can only be consumed from the region they were
+sent to. Use a fixed region for both sending and receiving.
+
+***
+
+### token?
+
+```ts
+optional token?: string;
+```
+
+Defined in: [vercel/VercelQueue.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L64)
+
+Vercel OIDC bearer token for authentication.
+
+When omitted the SDK auto-fetches a token via OIDC.
+
+***
+
+### visibilityTimeoutSeconds?
+
+```ts
+optional visibilityTimeoutSeconds?: number;
+```
+
+Defined in: [vercel/VercelQueue.ts:86](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/VercelQueue.ts#L86)
+
+Visibility timeout in seconds for received messages.
+
+The SDK automatically re-extends the lease while the handler is
+running, so the default of 300 s is suitable for most workloads.
+
+#### Default Value
+
+```ts
+300
+@public
+```

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

@@ -0,0 +1,17 @@
+---
+title: 'Variable: VERCEL\_CONFIG\_ENTRIES'
+generated: true
+editUrl: false
+---
+# Variable: VERCEL\_CONFIG\_ENTRIES
+
+```ts
+const VERCEL_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, "module">>;
+```
+
+Defined in: [vercel/env.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/env.ts#L65)
+
+All configuration entries required by the Vercel 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.VERCEL_QUEUE_CONSUMER_GROUP.md

@@ -0,0 +1,14 @@
+---
+title: 'Variable: VERCEL\_QUEUE\_CONSUMER\_GROUP'
+generated: true
+editUrl: false
+---
+# Variable: VERCEL\_QUEUE\_CONSUMER\_GROUP
+
+```ts
+const VERCEL_QUEUE_CONSUMER_GROUP: IConfigKey<string>;
+```
+
+Defined in: [vercel/env.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/env.ts#L32)
+
+Consumer group name for receiving messages.

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

@@ -0,0 +1,14 @@
+---
+title: 'Variable: VERCEL\_QUEUE\_DEPLOYMENT\_ID'
+generated: true
+editUrl: false
+---
+# Variable: VERCEL\_QUEUE\_DEPLOYMENT\_ID
+
+```ts
+const VERCEL_QUEUE_DEPLOYMENT_ID: IConfigKey<string>;
+```
+
+Defined in: [vercel/env.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/env.ts#L51)
+
+Optional Vercel deployment ID for per-deployment message isolation.

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

@@ -0,0 +1,14 @@
+---
+title: 'Variable: VERCEL\_QUEUE\_REGION'
+generated: true
+editUrl: false
+---
+# Variable: VERCEL\_QUEUE\_REGION
+
+```ts
+const VERCEL_QUEUE_REGION: IConfigKey<string>;
+```
+
+Defined in: [vercel/env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/env.ts#L16)
+
+Vercel region code (e.g. `iad1`, `fra1`, `sfo1`).

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

@@ -0,0 +1,16 @@
+---
+title: 'Variable: VERCEL\_QUEUE\_TOKEN'
+generated: true
+editUrl: false
+---
+# Variable: VERCEL\_QUEUE\_TOKEN
+
+```ts
+const VERCEL_QUEUE_TOKEN: IConfigKey<string>;
+```
+
+Defined in: [vercel/env.ts:25](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/env.ts#L25)
+
+Vercel OIDC bearer token for queue authentication.
+
+When omitted the SDK auto-fetches a token via OIDC.

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

@@ -0,0 +1,23 @@
+---
+title: 'Variable: VERCEL\_QUEUE\_VISIBILITY\_TIMEOUT\_SECONDS'
+generated: true
+editUrl: false
+---
+# Variable: VERCEL\_QUEUE\_VISIBILITY\_TIMEOUT\_SECONDS
+
+```ts
+const VERCEL_QUEUE_VISIBILITY_TIMEOUT_SECONDS: IConfigKey<number>;
+```
+
+Defined in: [vercel/env.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-queue/src/vercel/env.ts#L42)
+
+Visibility timeout in seconds for received messages.
+
+The SDK automatically re-extends the lease while the handler runs.
+
+## Default Value
+
+```ts
+300
+@public
+```

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

@@ -17,6 +17,7 @@ editUrl: false
 | [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. |
+| [VercelQueue](Class.VercelQueue) | Vercel Queues implementation of the [IQueue](Interface.IQueue) contract. |
 
 ## Interfaces
 
@@ -27,6 +28,7 @@ editUrl: false
 | [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. |
+| [IVercelQueueOptions](Interface.IVercelQueueOptions) | Configuration options for [VercelQueue](Class.VercelQueue). |
 
 ## Type Aliases
 
@@ -47,3 +49,9 @@ editUrl: false
 | [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. |
+| [VERCEL\_CONFIG\_ENTRIES](Variable.VERCEL_CONFIG_ENTRIES) | All configuration entries required by the Vercel queue provider. |
+| [VERCEL\_QUEUE\_CONSUMER\_GROUP](Variable.VERCEL_QUEUE_CONSUMER_GROUP) | Consumer group name for receiving messages. |
+| [VERCEL\_QUEUE\_DEPLOYMENT\_ID](Variable.VERCEL_QUEUE_DEPLOYMENT_ID) | Optional Vercel deployment ID for per-deployment message isolation. |
+| [VERCEL\_QUEUE\_REGION](Variable.VERCEL_QUEUE_REGION) | Vercel region code (e.g. `iad1`, `fra1`, `sfo1`). |
+| [VERCEL\_QUEUE\_TOKEN](Variable.VERCEL_QUEUE_TOKEN) | Vercel OIDC bearer token for queue authentication. |
+| [VERCEL\_QUEUE\_VISIBILITY\_TIMEOUT\_SECONDS](Variable.VERCEL_QUEUE_VISIBILITY_TIMEOUT_SECONDS) | Visibility timeout in seconds for received messages. |

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

@@ -1,17 +1,19 @@
 ---
 title: platform-queue
-description: Provider-agnostic queue infrastructure with support for in-memory FIFO, BullMQ (Redis), and Azure Service Bus.
+description: Provider-agnostic queue infrastructure with support for in-memory FIFO, BullMQ (Redis), Azure Service Bus, and Vercel Queues.
 order: 19
-tags: [queue, job-queue, fifo, memory-queue, bullmq, redis, azure-service-bus, ports-and-adapters, health]
+tags: [queue, job-queue, fifo, memory-queue, bullmq, redis, azure-service-bus, vercel-queues, ports-and-adapters, health]
 package: '@breadstone/archipel-platform-queue'
 ---
 
 # platform-queue
 
-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.
+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.
 
 **Package:** `@breadstone/archipel-platform-queue`
 
+<InstallTabs />
+
 ## Architecture
 
 ```mermaid
@@ -19,12 +21,15 @@ graph TD
     Core["@breadstone/archipel-platform-queue<br/><i>IQueue, models, errors, MemoryQueue</i>"]
     BullMQ["@breadstone/archipel-platform-queue/bullmq<br/><i>BullMqQueue</i>"]
     Azure["@breadstone/archipel-platform-queue/azure<br/><i>AzureQueue</i>"]
+    Vercel["@breadstone/archipel-platform-queue/vercel<br/><i>VercelQueue</i>"]
 
     BullMQ -->|implements| Core
     Azure -->|implements| Core
+    Vercel -->|implements| Core
 
     BullMQ -.-|requires| R["bullmq"]
     Azure -.-|requires| S["@azure/service-bus"]
+    Vercel -.-|requires| V["@vercel/queue"]
 ```
 
 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
 # Pick one (or use MemoryQueue without any extra SDK):
 yarn add bullmq
 yarn add @azure/service-bus
+yarn add @vercel/queue
 ```
 
 ### 2. Register the queue
@@ -112,6 +118,23 @@ import { BullMqQueue, BULLMQ_CONFIG_ENTRIES } from '@breadstone/archipel-platfor
 import { AzureQueue, AZURE_CONFIG_ENTRIES } from '@breadstone/archipel-platform-queue/azure';
 ```
 
+### Vercel Queues
+
+**Subpath:** `@breadstone/archipel-platform-queue/vercel`
+**SDK:** `@vercel/queue` ≥ 0.1.0
+
+| Variable                                | Required | Default | Description                                           |
+| --------------------------------------- | -------- | ------- | ----------------------------------------------------- |
+| `VERCEL_QUEUE_REGION`                   | Yes      | —       | Vercel region code (e.g. `iad1`, `fra1`, `sfo1`)      |
+| `VERCEL_QUEUE_CONSUMER_GROUP`           | Yes      | —       | Consumer group name for receiving messages             |
+| `VERCEL_QUEUE_TOKEN`                    | No       | —       | OIDC bearer token (auto-fetched when omitted)          |
+| `VERCEL_QUEUE_DEPLOYMENT_ID`            | No       | —       | Deployment ID for per-deployment message isolation     |
+| `VERCEL_QUEUE_VISIBILITY_TIMEOUT_SECONDS`| No      | `300`   | Visibility timeout in seconds for received messages    |
+
+```typescript
+import { VercelQueue, VERCEL_CONFIG_ENTRIES } from '@breadstone/archipel-platform-queue/vercel';
+```
+
 ---
 
 ## Job Lifecycle
@@ -166,3 +189,4 @@ export class AppModule {}
 | `@nestjs/common`    | Yes      | NestJS core                      |
 | `bullmq`            | Optional | Required for BullMQ provider     |
 | `@azure/service-bus` | Optional | Required for Azure Service Bus   |
+| `@vercel/queue`     | Optional | Required for Vercel Queues       |

package/data/packages/platform-reporting/index.md

@@ -12,6 +12,8 @@ Extensible business reporting framework using a contributor registry pattern. Fe
 
 **Package:** `@breadstone/archipel-platform-reporting`
 
+<InstallTabs />
+
 ## Quick Start
 
 ```typescript

package/data/packages/platform-resources/index.md

@@ -12,6 +12,8 @@ Multi-strategy resource management for NestJS applications. Loads files from the
 
 **Package:** `@breadstone/archipel-platform-resources`
 
+<InstallTabs />
+
 ## Installation
 
 ```typescript

package/data/packages/platform-telemetry/index.md

@@ -12,6 +12,8 @@ OpenTelemetry integration providing distributed tracing, metrics collection, and
 
 **Package:** `@breadstone/archipel-platform-telemetry`
 
+<InstallTabs />
+
 ## Quick Start
 
 ```typescript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breadstone/archipel-mcp",
-  "version": "0.0.27",
+  "version": "0.0.30",
   "description": "MCP server providing Archipel platform knowledge - documentation, query patterns, and coding conventions - to AI development tools.",
   "type": "commonjs",
   "main": "./src/main.js",

package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md

@@ -1,40 +0,0 @@
----
-title: 'Class: GithubAuthGuard'
-generated: true
-editUrl: false
----
-# Class: GithubAuthGuard
-
-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)
-
-The `GithubAuthGuard` protects routes using GitHub authentication.
-
-## Extends
-
-- `IAuthGuard`
-
-## Constructors
-
-### Constructor
-
-```ts
-new GithubAuthGuard(...args): GithubAuthGuard;
-```
-
-Defined in: node\_modules/@nestjs/passport/dist/interfaces/type.interface.d.ts:2
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| ...`args` | `any`[] |
-
-#### Returns
-
-`GithubAuthGuard`
-
-#### Inherited from
-
-```ts
-AuthGuard('github').constructor
-```