@breadstone/archipel-mcp 0.0.17 → 0.0.19

package/data/guides/esigning-integration.md

@@ -1,6 +1,6 @@
 ---
 title: E-Signing Integration
-description: Integrate electronic signature workflows with DocuSign, Adobe Sign, Dropbox Sign, SignNow, or an internal provider.
+description: Integrate electronic signature workflows with DocuSign, Adobe Sign, Dropbox Sign, or an internal provider.
 order: 12
 ---
 
@@ -27,7 +27,6 @@ yarn add @breadstone/archipel-platform-esigning
 | **DocuSign**     | Industry-standard e-signature platform   |
 | **Adobe Sign**   | Adobe Acrobat Sign integration           |
 | **Dropbox Sign** | Dropbox (formerly HelloSign) integration |
-| **SignNow**      | SignNow e-signature platform             |
 | **Internal**     | Custom/self-managed signing              |
 
 ---

package/data/guides/openapi-and-feature-discovery.md

@@ -149,18 +149,26 @@ export class TipController {
 
 ### `@Api()` Options Reference
 
-| Option       | Type                                          | Description                                          |
-| ------------ | --------------------------------------------- | ---------------------------------------------------- |
-| `auth`       | `'bearer' \| 'basic' \| 'oauth2' \| 'cookie'` | Adds the corresponding auth decorator.               |
-| `tags`       | `string \| string[]`                          | OpenAPI tag(s) for the operation.                    |
-| `operation`  | `ApiOperationOptions`                         | Summary, description, deprecation flag, etc.         |
-| `responses`  | `ApiResponseOptions \| ApiResponseOptions[]`  | One or more response definitions.                    |
-| `headers`    | `ApiHeaderOptions[]`                          | Expected request headers.                            |
-| `params`     | `ApiParamOptions \| ApiParamOptions[]`        | Path parameter definitions.                          |
-| `query`      | `ApiQueryOptions \| ApiQueryOptions[]`        | Query parameter definitions.                         |
-| `body`       | `ApiBodyOptions`                              | Request body definition.                             |
-| `scopes`     | `string[]`                                    | OAuth2 scopes (only relevant when `auth: 'oauth2'`). |
-| `extensions` | `Record<string, string \| number \| boolean>` | Custom OpenAPI extension properties (`x-*`).         |
+| Option       | Type                                                              | Description                                                          |
+| ------------ | ----------------------------------------------------------------- | -------------------------------------------------------------------- |
+| `auth`       | `ApiAuthOption \| ApiAuthOption[]`                                | Auth scheme(s). Simple string (`'bearer'`) or named (`{ type: 'bearer', name: 'jwt' }`). Supports multiple simultaneous schemes. |
+| `tags`       | `string \| string[]`                                              | OpenAPI tag(s) for the operation.                                    |
+| `operation`  | `ApiOperationOptions`                                             | Summary, description, operationId, deprecation flag, etc.            |
+| `summary`    | `string`                                                          | Shorthand for `operation.summary`. Takes precedence when both are set. |
+| `deprecated` | `boolean`                                                         | Shorthand to mark the endpoint as deprecated. Merged into `operation`. |
+| `responses`  | `ApiResponseOptions \| ApiResponseOptions[]`                      | One or more response definitions.                                    |
+| `headers`    | `ApiHeaderOptions[]`                                              | Expected request headers.                                            |
+| `params`     | `ApiParamOptions \| ApiParamOptions[]`                            | Path parameter definitions.                                          |
+| `query`      | `ApiQueryOptions \| ApiQueryOptions[]`                            | Query parameter definitions.                                         |
+| `body`       | `ApiBodyOptions`                                                  | Request body definition.                                             |
+| `scopes`     | `string[]`                                                        | OAuth2 scopes (only relevant when `auth` includes `'oauth2'`).       |
+| `extensions` | `Record<string, unknown>`                                         | Custom OpenAPI extension properties (`x-*`).                         |
+| `consumes`   | `string \| string[]`                                              | MIME type(s) the endpoint consumes (e.g. `'multipart/form-data'`).   |
+| `produces`   | `string \| string[]`                                              | MIME type(s) the endpoint produces (e.g. `'application/pdf'`).       |
+| `extraModels`| `Function \| Function[]`                                          | Extra model classes for polymorphic / discriminated-union schemas.    |
+| `security`   | `IApiSecurityOption \| IApiSecurityOption[]`                      | Generic security scheme(s) for custom API keys or non-standard auth. |
+| `exclude`    | `boolean`                                                         | Excludes this endpoint from the Swagger documentation when `true`.   |
+| `callbacks`  | `ApiCallbacksOptions`                                             | OpenAPI callback / webhook definitions.                              |
 
 ---
 

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

@@ -32,7 +32,9 @@ For Redis-backed caching:
 import { RedisLayeredCache } from '@breadstone/archipel-platform-caching/redis';
 
 const cache = new RedisLayeredCache<string, IProduct>(redisClient, async (key) => productRepository.findById(key), {
-  ttlMs: 300_000,
+  url: 'redis://localhost:6379',
+  keyPrefix: 'products:',
+  ttlSeconds: 300,
   cacheName: 'products',
 });
 ```
@@ -72,12 +74,13 @@ Both implementations share this contract:
 
 | Property               | Type                    | Default          | Description                                             |
 | ---------------------- | ----------------------- | ---------------- | ------------------------------------------------------- |
-| `ttlMs`                | `number`                | ∞                | Time-to-live in milliseconds.                           |
-| `staleWhileRevalidate` | `boolean`               | `false`          | Serve stale entries while refreshing in the background. |
-| `metricsRecorder`      | `ICacheMetricsRecorder` | Noop             | Pluggable metrics hook.                                 |
-| `cacheName`            | `string`                | `'redis'`        | Label used in metrics and logging.                      |
+| `url`                  | `string`                | —                | Redis connection URL (e.g. `redis://localhost:6379`).   |
+| `keyPrefix`            | `string`                | —                | Key prefix applied to all Redis keys.                   |
+| `ttlSeconds`           | `number`                | ∞                | Time-to-live in seconds.                                |
 | `serialize`            | `(value) => string`     | `JSON.stringify` | Custom serializer for cache values.                     |
 | `deserialize`          | `(raw) => value`        | `JSON.parse`     | Custom deserializer for cache entries.                  |
+| `metricsRecorder`      | `ICacheMetricsRecorder` | Noop             | Pluggable metrics hook.                                 |
+| `cacheName`            | `string`                | `'redis'`        | Label used in metrics and logging.                      |
 
 ---
 

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

@@ -15,12 +15,10 @@ Cryptographic building blocks for NestJS applications: bcrypt password hashing,
 ## Quick Start
 
 ```typescript
-import {
-  BcryptService,
-  CryptoService,
-  OtpService,
-  OTP_SERVICE_TOKEN,
-} from '@breadstone/archipel-platform-cryptography';
+import { BcryptService, CryptoService } from '@breadstone/archipel-platform-cryptography';
+
+// OTP is a tree-shakable sub-export
+import { OtpService, OTP_SERVICE_TOKEN } from '@breadstone/archipel-platform-cryptography/otp';
 ```
 
 ---
@@ -83,7 +81,7 @@ TOTP enrollment and verification backed by otplib v13, injected via the `OTP_SER
 
 ```typescript
 import { Module } from '@nestjs/common';
-import { OtpService, OTP_SERVICE_TOKEN } from '@breadstone/archipel-platform-cryptography';
+import { OtpService, OTP_SERVICE_TOKEN } from '@breadstone/archipel-platform-cryptography/otp';
 
 @Module({
   providers: [{ provide: OTP_SERVICE_TOKEN, useClass: OtpService }],
@@ -96,7 +94,7 @@ export class SecurityModule {}
 
 ```typescript
 import { Inject, Injectable } from '@nestjs/common';
-import { OTP_SERVICE_TOKEN, IOtpService } from '@breadstone/archipel-platform-cryptography';
+import { OTP_SERVICE_TOKEN, IOtpService } from '@breadstone/archipel-platform-cryptography/otp';
 
 @Injectable()
 export class MfaService {

package/data/packages/platform-esigning/api/Class.AdobeSignEsigningProvider.md

@@ -0,0 +1,242 @@
+---
+title: 'Class: AdobeSignEsigningProvider'
+generated: true
+editUrl: false
+---
+# Class: AdobeSignEsigningProvider
+
+Defined in: [adobe-sign/AdobeSignEsigningProvider.ts:114](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/adobe-sign/AdobeSignEsigningProvider.ts#L114)
+
+Adobe Acrobat Sign e-signing provider.
+Integrates with the Adobe Sign REST API v6 to manage agreements,
+signing sessions, and webhook verification.
+
+## Remarks
+
+Adobe Sign does not provide a maintained Node.js SDK.
+This provider communicates with the REST API directly using the
+built-in `fetch` API available in Node.js 18+.
+
+## Extends
+
+- [`EsigningClientPort`](Class.EsigningClientPort)
+
+## Constructors
+
+### Constructor
+
+```ts
+new AdobeSignEsigningProvider(config): AdobeSignEsigningProvider;
+```
+
+Defined in: [adobe-sign/AdobeSignEsigningProvider.ts:124](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/adobe-sign/AdobeSignEsigningProvider.ts#L124)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `config` | `ConfigService` |
+
+#### Returns
+
+`AdobeSignEsigningProvider`
+
+#### Overrides
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`constructor`](Class.EsigningClientPort#constructor)
+
+## Accessors
+
+### providerId
+
+#### Get Signature
+
+```ts
+get providerId(): string;
+```
+
+Defined in: [adobe-sign/AdobeSignEsigningProvider.ts:133](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/adobe-sign/AdobeSignEsigningProvider.ts#L133)
+
+Unique identifier of the provider implementation.
+
+##### Returns
+
+`string`
+
+Unique identifier of the provider implementation.
+
+#### Overrides
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`providerId`](Class.EsigningClientPort#providerid)
+
+## Methods
+
+### cancelSigningRequest()
+
+```ts
+cancelSigningRequest(signingRequestId, reason?): Promise<void>;
+```
+
+Defined in: [adobe-sign/AdobeSignEsigningProvider.ts:310](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/adobe-sign/AdobeSignEsigningProvider.ts#L310)
+
+Cancel an in-progress signing request.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `signingRequestId` | `string` | The provider-specific signing request identifier. |
+| `reason?` | `string` | Optional reason for cancellation. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Overrides
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`cancelSigningRequest`](Class.EsigningClientPort#cancelsigningrequest)
+
+***
+
+### createSigningRequest()
+
+```ts
+createSigningRequest(request): Promise<ISigningRequest>;
+```
+
+Defined in: [adobe-sign/AdobeSignEsigningProvider.ts:141](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/adobe-sign/AdobeSignEsigningProvider.ts#L141)
+
+Create a new signing request (envelope/agreement).
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `request` | [`ICreateSigningRequest`](Interface.ICreateSigningRequest) | The signing request creation input. |
+
+#### Returns
+
+`Promise`\<[`ISigningRequest`](Interface.ISigningRequest)\>
+
+The created signing request with provider-assigned identifiers.
+
+#### Overrides
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`createSigningRequest`](Class.EsigningClientPort#createsigningrequest)
+
+***
+
+### createSigningSession()
+
+```ts
+createSigningSession(request): Promise<ISigningSession>;
+```
+
+Defined in: [adobe-sign/AdobeSignEsigningProvider.ts:216](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/adobe-sign/AdobeSignEsigningProvider.ts#L216)
+
+Generate a signing session (signing link/URL) for a specific signer.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `request` | [`ICreateSigningSessionRequest`](Interface.ICreateSigningSessionRequest) | The session creation input. |
+
+#### Returns
+
+`Promise`\<[`ISigningSession`](Interface.ISigningSession)\>
+
+The signing session with the signing URL.
+
+#### Overrides
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`createSigningSession`](Class.EsigningClientPort#createsigningsession)
+
+***
+
+### getSignedDocuments()
+
+```ts
+getSignedDocuments(signingRequestId): Promise<ISignedDocument[]>;
+```
+
+Defined in: [adobe-sign/AdobeSignEsigningProvider.ts:286](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/adobe-sign/AdobeSignEsigningProvider.ts#L286)
+
+Retrieve the final signed documents for a completed signing request.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `signingRequestId` | `string` | The provider-specific signing request identifier. |
+
+#### Returns
+
+`Promise`\<[`ISignedDocument`](Interface.ISignedDocument)[]\>
+
+Array of signed documents with their content.
+
+#### Overrides
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`getSignedDocuments`](Class.EsigningClientPort#getsigneddocuments)
+
+***
+
+### getSigningRequest()
+
+```ts
+getSigningRequest(signingRequestId): Promise<ISigningRequest>;
+```
+
+Defined in: [adobe-sign/AdobeSignEsigningProvider.ts:253](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/adobe-sign/AdobeSignEsigningProvider.ts#L253)
+
+Retrieve the current status and details of a signing request.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `signingRequestId` | `string` | The provider-specific signing request identifier. |
+
+#### Returns
+
+`Promise`\<[`ISigningRequest`](Interface.ISigningRequest)\>
+
+The signing request with current status.
+
+#### Overrides
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`getSigningRequest`](Class.EsigningClientPort#getsigningrequest)
+
+***
+
+### verifyWebhook()
+
+```ts
+verifyWebhook(
+   payload, 
+   _signature, 
+headers?): Promise<IEsigningWebhookEvent>;
+```
+
+Defined in: [adobe-sign/AdobeSignEsigningProvider.ts:320](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/adobe-sign/AdobeSignEsigningProvider.ts#L320)
+
+Verify a webhook payload signature and return a normalized event.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | `string` \| `Buffer`\<`ArrayBufferLike`\> | Raw webhook body. |
+| `_signature` | `string` | - |
+| `headers?` | `Record`\<`string`, `string`\> | Optional webhook request headers (for timestamp/nonce validation). |
+
+#### Returns
+
+`Promise`\<[`IEsigningWebhookEvent`](Interface.IEsigningWebhookEvent)\>
+
+Normalized webhook event.
+
+#### Overrides
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`verifyWebhook`](Class.EsigningClientPort#verifywebhook)

package/data/packages/platform-esigning/api/Class.DocuSignEsigningProvider.md

@@ -0,0 +1,236 @@
+---
+title: 'Class: DocuSignEsigningProvider'
+generated: true
+editUrl: false
+---
+# Class: DocuSignEsigningProvider
+
+Defined in: [docusign/DocuSignEsigningProvider.ts:93](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/docusign/DocuSignEsigningProvider.ts#L93)
+
+DocuSign eSignature provider.
+Integrates with the DocuSign eSignature REST API v2.1 via the official
+`docusign-esign` Node.js SDK.
+
+## Extends
+
+- [`EsigningClientPort`](Class.EsigningClientPort)
+
+## Constructors
+
+### Constructor
+
+```ts
+new DocuSignEsigningProvider(config): DocuSignEsigningProvider;
+```
+
+Defined in: [docusign/DocuSignEsigningProvider.ts:105](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/docusign/DocuSignEsigningProvider.ts#L105)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `config` | `ConfigService` |
+
+#### Returns
+
+`DocuSignEsigningProvider`
+
+#### Overrides
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`constructor`](Class.EsigningClientPort#constructor)
+
+## Accessors
+
+### providerId
+
+#### Get Signature
+
+```ts
+get providerId(): string;
+```
+
+Defined in: [docusign/DocuSignEsigningProvider.ts:123](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/docusign/DocuSignEsigningProvider.ts#L123)
+
+Unique identifier of the provider implementation.
+
+##### Returns
+
+`string`
+
+Unique identifier of the provider implementation.
+
+#### Overrides
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`providerId`](Class.EsigningClientPort#providerid)
+
+## Methods
+
+### cancelSigningRequest()
+
+```ts
+cancelSigningRequest(signingRequestId, reason?): Promise<void>;
+```
+
+Defined in: [docusign/DocuSignEsigningProvider.ts:290](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/docusign/DocuSignEsigningProvider.ts#L290)
+
+Cancel an in-progress signing request.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `signingRequestId` | `string` | The provider-specific signing request identifier. |
+| `reason?` | `string` | Optional reason for cancellation. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Overrides
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`cancelSigningRequest`](Class.EsigningClientPort#cancelsigningrequest)
+
+***
+
+### createSigningRequest()
+
+```ts
+createSigningRequest(request): Promise<ISigningRequest>;
+```
+
+Defined in: [docusign/DocuSignEsigningProvider.ts:131](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/docusign/DocuSignEsigningProvider.ts#L131)
+
+Create a new signing request (envelope/agreement).
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `request` | [`ICreateSigningRequest`](Interface.ICreateSigningRequest) | The signing request creation input. |
+
+#### Returns
+
+`Promise`\<[`ISigningRequest`](Interface.ISigningRequest)\>
+
+The created signing request with provider-assigned identifiers.
+
+#### Overrides
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`createSigningRequest`](Class.EsigningClientPort#createsigningrequest)
+
+***
+
+### createSigningSession()
+
+```ts
+createSigningSession(request): Promise<ISigningSession>;
+```
+
+Defined in: [docusign/DocuSignEsigningProvider.ts:204](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/docusign/DocuSignEsigningProvider.ts#L204)
+
+Generate a signing session (signing link/URL) for a specific signer.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `request` | [`ICreateSigningSessionRequest`](Interface.ICreateSigningSessionRequest) | The session creation input. |
+
+#### Returns
+
+`Promise`\<[`ISigningSession`](Interface.ISigningSession)\>
+
+The signing session with the signing URL.
+
+#### Overrides
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`createSigningSession`](Class.EsigningClientPort#createsigningsession)
+
+***
+
+### getSignedDocuments()
+
+```ts
+getSignedDocuments(signingRequestId): Promise<ISignedDocument[]>;
+```
+
+Defined in: [docusign/DocuSignEsigningProvider.ts:261](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/docusign/DocuSignEsigningProvider.ts#L261)
+
+Retrieve the final signed documents for a completed signing request.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `signingRequestId` | `string` | The provider-specific signing request identifier. |
+
+#### Returns
+
+`Promise`\<[`ISignedDocument`](Interface.ISignedDocument)[]\>
+
+Array of signed documents with their content.
+
+#### Overrides
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`getSignedDocuments`](Class.EsigningClientPort#getsigneddocuments)
+
+***
+
+### getSigningRequest()
+
+```ts
+getSigningRequest(signingRequestId): Promise<ISigningRequest>;
+```
+
+Defined in: [docusign/DocuSignEsigningProvider.ts:246](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/docusign/DocuSignEsigningProvider.ts#L246)
+
+Retrieve the current status and details of a signing request.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `signingRequestId` | `string` | The provider-specific signing request identifier. |
+
+#### Returns
+
+`Promise`\<[`ISigningRequest`](Interface.ISigningRequest)\>
+
+The signing request with current status.
+
+#### Overrides
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`getSigningRequest`](Class.EsigningClientPort#getsigningrequest)
+
+***
+
+### verifyWebhook()
+
+```ts
+verifyWebhook(
+   payload, 
+   signature, 
+_headers?): Promise<IEsigningWebhookEvent>;
+```
+
+Defined in: [docusign/DocuSignEsigningProvider.ts:306](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/docusign/DocuSignEsigningProvider.ts#L306)
+
+Verify a webhook payload signature and return a normalized event.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `payload` | `string` \| `Buffer`\<`ArrayBufferLike`\> | Raw webhook body. |
+| `signature` | `string` | Webhook signature header value. |
+| `_headers?` | `Record`\<`string`, `string`\> | - |
+
+#### Returns
+
+`Promise`\<[`IEsigningWebhookEvent`](Interface.IEsigningWebhookEvent)\>
+
+Normalized webhook event.
+
+#### Overrides
+
+[`EsigningClientPort`](Class.EsigningClientPort).[`verifyWebhook`](Class.EsigningClientPort#verifywebhook)