@breadstone/archipel-mcp 0.0.1 → 0.0.3

package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Interface: IDocumentPlaceholderDetail
 
 Defined in: [types/DocumentTypes.ts:41](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L41)

package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Interface: IDocumentProbeReport
 
 Defined in: [types/DocumentTypes.ts:73](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L73)

package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Interface: IDocumentRenderer
 
 Defined in: [renderer/interfaces/IDocumentRenderer.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/renderer/interfaces/IDocumentRenderer.ts#L10)

package/data/packages/platform-documents/api/Interface.IImagePayload.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Interface: IImagePayload
 
 Defined in: [interfaces/IImagePayload.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/interfaces/IImagePayload.ts#L8)

package/data/packages/platform-documents/api/Interface.IImageProcessor.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Interface: IImageProcessor
 
 Defined in: [processor/interfaces/IImageProcessor.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/processor/interfaces/IImageProcessor.ts#L9)

package/data/packages/platform-documents/api/Interface.IRenderOptions.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Interface: IRenderOptions
 
 Defined in: [interfaces/IRenderOptions.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/interfaces/IRenderOptions.ts#L8)

package/data/packages/platform-documents/api/Interface.IRenderResult.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Interface: IRenderResult
 
 Defined in: [types/DocumentTypes.ts:125](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L125)

package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Type Alias: DocumentFormat
 
 ```ts

package/data/packages/platform-documents/api/TypeAlias.EngineType.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Type Alias: EngineType
 
 ```ts

package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Type Alias: ImageMimeType
 
 ```ts

package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Type Alias: TemplateFormat
 
 ```ts

package/data/packages/platform-documents/api/TypeAlias.TemplateType.md

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Type Alias: TemplateType
 
 ```ts

package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: DOCUMENT\_MODULE\_OPTIONS'
+generated: true
+editUrl: false
+---
+
+# Variable: DOCUMENT_MODULE_OPTIONS
+
+```ts
+const DOCUMENT_MODULE_OPTIONS: typeof DOCUMENT_MODULE_OPTIONS;
+```
+
+Defined in: [DocumentTokens.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentTokens.ts#L6)
+
+Injection token for DocumentModule options.

package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: DOCUMENT\_PARSER\_TOKEN'
+generated: true
+editUrl: false
+---
+
+# Variable: DOCUMENT_PARSER_TOKEN
+
+```ts
+const DOCUMENT_PARSER_TOKEN: typeof DOCUMENT_PARSER_TOKEN;
+```
+
+Defined in: [DocumentTokens.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentTokens.ts#L20)
+
+Injection token for IDocumentParser.

package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: DOCUMENT\_RENDERER\_TOKEN'
+generated: true
+editUrl: false
+---
+
+# Variable: DOCUMENT_RENDERER_TOKEN
+
+```ts
+const DOCUMENT_RENDERER_TOKEN: typeof DOCUMENT_RENDERER_TOKEN;
+```
+
+Defined in: [DocumentTokens.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentTokens.ts#L27)
+
+Injection token for IDocumentRenderer (multi-provider).

package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md

@@ -0,0 +1,15 @@
+---
+title: 'Variable: IMAGE\_PROCESSOR\_TOKEN'
+generated: true
+editUrl: false
+---
+
+# Variable: IMAGE_PROCESSOR_TOKEN
+
+```ts
+const IMAGE_PROCESSOR_TOKEN: typeof IMAGE_PROCESSOR_TOKEN;
+```
+
+Defined in: [DocumentTokens.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentTokens.ts#L13)
+
+Injection token for IImageProcessor.

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

@@ -4,10 +4,6 @@ generated: true
 editUrl: false
 ---
 
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # @breadstone/archipel-platform-documents
 
 ## Classes
@@ -44,48 +40,9 @@ editUrl: false
 
 ## Variables
 
-### DOCUMENT_MODULE_OPTIONS
-
-```ts
-const DOCUMENT_MODULE_OPTIONS: typeof DOCUMENT_MODULE_OPTIONS;
-```
-
-Defined in: [DocumentTokens.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentTokens.ts#L6)
-
-Injection token for DocumentModule options.
-
----
-
-### DOCUMENT_PARSER_TOKEN
-
-```ts
-const DOCUMENT_PARSER_TOKEN: typeof DOCUMENT_PARSER_TOKEN;
-```
-
-Defined in: [DocumentTokens.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentTokens.ts#L20)
-
-Injection token for IDocumentParser.
-
----
-
-### DOCUMENT_RENDERER_TOKEN
-
-```ts
-const DOCUMENT_RENDERER_TOKEN: typeof DOCUMENT_RENDERER_TOKEN;
-```
-
-Defined in: [DocumentTokens.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentTokens.ts#L27)
-
-Injection token for IDocumentRenderer (multi-provider).
-
----
-
-### IMAGE_PROCESSOR_TOKEN
-
-```ts
-const IMAGE_PROCESSOR_TOKEN: typeof IMAGE_PROCESSOR_TOKEN;
-```
-
-Defined in: [DocumentTokens.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/DocumentTokens.ts#L13)
-
-Injection token for IImageProcessor.
+| Variable                                                    | Description                                             |
+| ----------------------------------------------------------- | ------------------------------------------------------- |
+| [DOCUMENT_MODULE_OPTIONS](Variable.DOCUMENT_MODULE_OPTIONS) | Injection token for DocumentModule options.             |
+| [DOCUMENT_PARSER_TOKEN](Variable.DOCUMENT_PARSER_TOKEN)     | Injection token for IDocumentParser.                    |
+| [DOCUMENT_RENDERER_TOKEN](Variable.DOCUMENT_RENDERER_TOKEN) | Injection token for IDocumentRenderer (multi-provider). |
+| [IMAGE_PROCESSOR_TOKEN](Variable.IMAGE_PROCESSOR_TOKEN)     | Injection token for IImageProcessor.                    |

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

@@ -0,0 +1,185 @@
+---
+title: 'Abstract Class: EsigningClientPort'
+generated: true
+editUrl: false
+---
+
+# Abstract Class: EsigningClientPort
+
+Defined in: [contracts/EsigningClientPort.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L19)
+
+Abstract port for e-signing provider clients.
+Each provider (DocuSign, Adobe Sign, Dropbox Sign, signNow, Internal) must implement
+this contract so that the consuming application can switch providers without changing business logic.
+
+## Extended by
+
+- [`InternalEsigningProvider`](Class.InternalEsigningProvider)
+
+## Constructors
+
+### Constructor
+
+```ts
+new EsigningClientPort(): EsigningClientPort;
+```
+
+#### Returns
+
+`EsigningClientPort`
+
+## Properties
+
+### providerId
+
+```ts
+abstract readonly providerId: string;
+```
+
+Defined in: [contracts/EsigningClientPort.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L23)
+
+Unique identifier of the provider implementation.
+
+## Methods
+
+### cancelSigningRequest()
+
+```ts
+abstract cancelSigningRequest(signingRequestId, reason?): Promise<void>;
+```
+
+Defined in: [contracts/EsigningClientPort.ts:72](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L72)
+
+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`\>
+
+---
+
+### createSigningRequest()
+
+```ts
+abstract createSigningRequest(request): Promise<ISigningRequest>;
+```
+
+Defined in: [contracts/EsigningClientPort.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L36)
+
+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.
+
+---
+
+### createSigningSession()
+
+```ts
+abstract createSigningSession(request): Promise<ISigningSession>;
+```
+
+Defined in: [contracts/EsigningClientPort.ts:45](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L45)
+
+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.
+
+---
+
+### getSignedDocuments()
+
+```ts
+abstract getSignedDocuments(signingRequestId): Promise<ISignedDocument[]>;
+```
+
+Defined in: [contracts/EsigningClientPort.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L63)
+
+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.
+
+---
+
+### getSigningRequest()
+
+```ts
+abstract getSigningRequest(signingRequestId): Promise<ISigningRequest>;
+```
+
+Defined in: [contracts/EsigningClientPort.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L54)
+
+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.
+
+---
+
+### verifyWebhook()
+
+```ts
+abstract verifyWebhook(payload, signature): Promise<IEsigningWebhookEvent>;
+```
+
+Defined in: [contracts/EsigningClientPort.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L82)
+
+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. |
+
+#### Returns
+
+`Promise`\<[`IEsigningWebhookEvent`](Interface.IEsigningWebhookEvent)\>
+
+Normalized webhook event.

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

@@ -0,0 +1,66 @@
+---
+title: 'Class: EsigningError'
+generated: true
+editUrl: false
+---
+
+# Class: EsigningError
+
+Defined in: [errors/EsigningError.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/EsigningError.ts#L6)
+
+Base error for all e-signing related failures.
+
+## Extends
+
+- `Error`
+
+## Extended by
+
+- [`SigningProviderError`](Class.SigningProviderError)
+- [`SigningRequestNotFoundError`](Class.SigningRequestNotFoundError)
+- [`WebhookVerificationError`](Class.WebhookVerificationError)
+
+## Constructors
+
+### Constructor
+
+```ts
+new EsigningError(message, code): EsigningError;
+```
+
+Defined in: [errors/EsigningError.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/EsigningError.ts#L15)
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `message` | `string` |
+| `code`    | `string` |
+
+#### Returns
+
+`EsigningError`
+
+#### Overrides
+
+```ts
+Error.constructor;
+```
+
+## Accessors
+
+### code
+
+#### Get Signature
+
+```ts
+get code(): string;
+```
+
+Defined in: [errors/EsigningError.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/errors/EsigningError.ts#L26)
+
+Machine-readable error code.
+
+##### Returns
+
+`string`

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

@@ -0,0 +1,49 @@
+---
+title: 'Class: EsigningModule'
+generated: true
+editUrl: false
+---
+
+# Class: EsigningModule
+
+Defined in: [EsigningModule.ts:52](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L52)
+
+NestJS module providing generic e-signing infrastructure.
+Exposes a configurable signing client and optional persistence tracking.
+The specific e-signing provider is selected via the options.
+
+## Constructors
+
+### Constructor
+
+```ts
+new EsigningModule(): EsigningModule;
+```
+
+#### Returns
+
+`EsigningModule`
+
+## Methods
+
+### register()
+
+```ts
+static register(options): DynamicModule;
+```
+
+Defined in: [EsigningModule.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L62)
+
+Configures the module with the specified options.
+
+#### Parameters
+
+| Parameter | Type                                                         | Description                       |
+| --------- | ------------------------------------------------------------ | --------------------------------- |
+| `options` | [`IEsigningModuleOptions`](Interface.IEsigningModuleOptions) | The module configuration options. |
+
+#### Returns
+
+`DynamicModule`
+
+Dynamic module definition.

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

@@ -0,0 +1,91 @@
+---
+title: 'Abstract Class: EsigningPersistencePort'
+generated: true
+editUrl: false
+---
+
+# Abstract Class: EsigningPersistencePort
+
+Defined in: [contracts/EsigningPersistencePort.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningPersistencePort.ts#L13)
+
+Abstract port for persisting signing request state.
+Implement this port in the consuming application to track signing requests in a database.
+
+## Constructors
+
+### Constructor
+
+```ts
+new EsigningPersistencePort(): EsigningPersistencePort;
+```
+
+#### Returns
+
+`EsigningPersistencePort`
+
+## Methods
+
+### onSigningRequestCancelled()
+
+```ts
+abstract onSigningRequestCancelled(signingRequestId): Promise<void>;
+```
+
+Defined in: [contracts/EsigningPersistencePort.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningPersistencePort.ts#L39)
+
+Update persisted state when a signing request is cancelled.
+
+#### Parameters
+
+| Parameter          | Type     | Description                                       |
+| ------------------ | -------- | ------------------------------------------------- |
+| `signingRequestId` | `string` | The provider-specific signing request identifier. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+---
+
+### onSigningRequestCreated()
+
+```ts
+abstract onSigningRequestCreated(signingRequest): Promise<void>;
+```
+
+Defined in: [contracts/EsigningPersistencePort.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningPersistencePort.ts#L22)
+
+Persist a newly created signing request.
+
+#### Parameters
+
+| Parameter        | Type                                           | Description                     |
+| ---------------- | ---------------------------------------------- | ------------------------------- |
+| `signingRequest` | [`ISigningRequest`](Interface.ISigningRequest) | The signing request to persist. |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+---
+
+### onSigningRequestStatusChanged()
+
+```ts
+abstract onSigningRequestStatusChanged(signingRequestId, status): Promise<void>;
+```
+
+Defined in: [contracts/EsigningPersistencePort.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningPersistencePort.ts#L31)
+
+Update persisted state when a signing request status changes.
+
+#### Parameters
+
+| Parameter          | Type     | Description                                       |
+| ------------------ | -------- | ------------------------------------------------- |
+| `signingRequestId` | `string` | The provider-specific signing request identifier. |
+| `status`           | `string` | The new status of the signing request.            |
+
+#### Returns
+
+`Promise`\<`void`\>