@breadstone/archipel-mcp 0.0.1 → 0.0.2

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

@@ -3,11 +3,6 @@ title: 'Interface: IImageProcessor'
 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)
@@ -29,8 +24,8 @@ Process image payload (resize, format conversion).
 
 #### Parameters
 
-| Parameter | Type                                       | Description   |
-| --------- | ------------------------------------------ | ------------- |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
 | `payload` | [`IImagePayload`](Interface.IImagePayload) | Image payload |
 
 #### Returns
@@ -39,15 +34,15 @@ Process image payload (resize, format conversion).
 
 Processed image payload
 
----
+***
 
 ### toJpeg()
 
 ```ts
 toJpeg(
-   buffer,
-   width?,
-   height?,
+   buffer, 
+   width?, 
+   height?, 
 quality?): Promise<Buffer<ArrayBufferLike>>;
 ```
 
@@ -57,11 +52,11 @@ Convert image to JPEG format.
 
 #### Parameters
 
-| Parameter  | Type     | Description          |
-| ---------- | -------- | -------------------- |
-| `buffer`   | `Buffer` | Image buffer         |
-| `width?`   | `number` | Target width         |
-| `height?`  | `number` | Target height        |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `buffer` | `Buffer` | Image buffer |
+| `width?` | `number` | Target width |
+| `height?` | `number` | Target height |
 | `quality?` | `number` | JPEG quality (0-100) |
 
 #### Returns
@@ -70,14 +65,14 @@ Convert image to JPEG format.
 
 JPEG buffer
 
----
+***
 
 ### toPng()
 
 ```ts
 toPng(
-   buffer,
-   width?,
+   buffer, 
+   width?, 
 height?): Promise<Buffer<ArrayBufferLike>>;
 ```
 
@@ -87,10 +82,10 @@ Convert image to PNG format.
 
 #### Parameters
 
-| Parameter | Type     | Description   |
-| --------- | -------- | ------------- |
-| `buffer`  | `Buffer` | Image buffer  |
-| `width?`  | `number` | Target width  |
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `buffer` | `Buffer` | Image buffer |
+| `width?` | `number` | Target width |
 | `height?` | `number` | Target height |
 
 #### Returns

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

@@ -3,11 +3,6 @@ title: 'Interface: IRenderOptions'
 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)
@@ -26,7 +21,7 @@ Defined in: [interfaces/IRenderOptions.ts:33](https://github.com/RueDeRennes/arc
 
 Data payload for template placeholders.
 
----
+***
 
 ### template?
 
@@ -42,7 +37,7 @@ Either templateId or templateBuffer must be provided.
 - Buffer: Binary document content (DOCX, PDF)
 - string: Raw XML document content (for DOCX only)
 
----
+***
 
 ### templateFormat?
 
@@ -55,7 +50,7 @@ Defined in: [interfaces/IRenderOptions.ts:19](https://github.com/RueDeRennes/arc
 Template format type (encodian or mustache).
 Defaults to 'encodian' if not specified.
 
----
+***
 
 ### templateId?
 

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

@@ -3,11 +3,6 @@ title: 'Interface: IRenderResult'
 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)
@@ -26,7 +21,7 @@ Defined in: [types/DocumentTypes.ts:130](https://github.com/RueDeRennes/archipel
 
 Document buffer.
 
----
+***
 
 ### format
 
@@ -38,7 +33,7 @@ Defined in: [types/DocumentTypes.ts:135](https://github.com/RueDeRennes/archipel
 
 Document format.
 
----
+***
 
 ### mimeType
 
@@ -50,7 +45,7 @@ Defined in: [types/DocumentTypes.ts:140](https://github.com/RueDeRennes/archipel
 
 MIME type.
 
----
+***
 
 ### report
 

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

@@ -3,15 +3,10 @@ title: 'Type Alias: DocumentFormat'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Type Alias: DocumentFormat
 
 ```ts
-type DocumentFormat = 'pdf' | 'docx';
+type DocumentFormat = "pdf" | "docx";
 ```
 
 Defined in: [types/DocumentTypes.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L6)

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

@@ -3,15 +3,10 @@ title: 'Type Alias: EngineType'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Type Alias: EngineType
 
 ```ts
-type EngineType = 'docx' | 'pdf';
+type EngineType = "docx" | "pdf";
 ```
 
 Defined in: [types/DocumentTypes.ts:27](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L27)

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

@@ -3,15 +3,10 @@ title: 'Type Alias: ImageMimeType'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Type Alias: ImageMimeType
 
 ```ts
-type ImageMimeType = 'image/png' | 'image/jpeg' | 'image/jpg' | 'image/webp';
+type ImageMimeType = "image/png" | "image/jpeg" | "image/jpg" | "image/webp";
 ```
 
 Defined in: [types/DocumentTypes.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L34)

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

@@ -3,15 +3,10 @@ title: 'Type Alias: TemplateFormat'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Type Alias: TemplateFormat
 
 ```ts
-type TemplateFormat = 'encodian' | 'mustache';
+type TemplateFormat = "encodian" | "mustache";
 ```
 
 Defined in: [types/DocumentTypes.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L13)

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

@@ -3,15 +3,10 @@ title: 'Type Alias: TemplateType'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # Type Alias: TemplateType
 
 ```ts
-type TemplateType = 'docx' | 'pdf';
+type TemplateType = "docx" | "pdf";
 ```
 
 Defined in: [types/DocumentTypes.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-documents/src/types/DocumentTypes.ts#L20)

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

@@ -0,0 +1,14 @@
+---
+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,14 @@
+---
+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,14 @@
+---
+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,14 @@
+---
+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

@@ -3,89 +3,45 @@ title: '@breadstone/archipel-platform-documents'
 generated: true
 editUrl: false
 ---
-
-[**@breadstone/archipel-platform-documents**](../)
-
----
-
 # @breadstone/archipel-platform-documents
 
 ## Classes
 
-| Class                                              | Description                                                                                                                                 |
-| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
-| [BaseDocumentRenderer](Class.BaseDocumentRenderer) | Base class for document renderers. Provides common functionality for template loading, parsing, and image processing.                       |
-| [DocumentEngine](Class.DocumentEngine)             | DocumentEngine orchestrates document generation workflow. Coordinates resource loading and renderer components.                             |
-| [DocumentModule](Class.DocumentModule)             | DocumentModule provides services for document generation and image processing. Uses abstract base classes and interfaces for extensibility. |
-| [SharpImageProcessor](Class.SharpImageProcessor)   | Sharp-based image processor. Handles image resizing and format conversion.                                                                  |
+| Class | Description |
+| ------ | ------ |
+| [BaseDocumentRenderer](Class.BaseDocumentRenderer) | Base class for document renderers. Provides common functionality for template loading, parsing, and image processing. |
+| [DocumentEngine](Class.DocumentEngine) | DocumentEngine orchestrates document generation workflow. Coordinates resource loading and renderer components. |
+| [DocumentModule](Class.DocumentModule) | DocumentModule provides services for document generation and image processing. Uses abstract base classes and interfaces for extensibility. |
+| [SharpImageProcessor](Class.SharpImageProcessor) | Sharp-based image processor. Handles image resizing and format conversion. |
 
 ## Interfaces
 
-| Interface                                                          | Description                                                                             |
-| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------- |
-| [IDocumentModuleOptions](Interface.IDocumentModuleOptions)         | Configuration options for the DocumentModule.                                           |
-| [IDocumentPlaceholderDetail](Interface.IDocumentPlaceholderDetail) | Placeholder detail for document probe report.                                           |
-| [IDocumentProbeReport](Interface.IDocumentProbeReport)             | Document probe report.                                                                  |
-| [IDocumentRenderer](Interface.IDocumentRenderer)                   | Base interface for document renderers. Each renderer handles specific document formats. |
-| [IImagePayload](Interface.IImagePayload)                           | Image payload for templates.                                                            |
-| [IImageProcessor](Interface.IImageProcessor)                       | Base interface for image processors. Handles image manipulation and format conversion.  |
-| [IRenderOptions](Interface.IRenderOptions)                         | Options for rendering a document.                                                       |
-| [IRenderResult](Interface.IRenderResult)                           | Document render result.                                                                 |
+| Interface | Description |
+| ------ | ------ |
+| [IDocumentModuleOptions](Interface.IDocumentModuleOptions) | Configuration options for the DocumentModule. |
+| [IDocumentPlaceholderDetail](Interface.IDocumentPlaceholderDetail) | Placeholder detail for document probe report. |
+| [IDocumentProbeReport](Interface.IDocumentProbeReport) | Document probe report. |
+| [IDocumentRenderer](Interface.IDocumentRenderer) | Base interface for document renderers. Each renderer handles specific document formats. |
+| [IImagePayload](Interface.IImagePayload) | Image payload for templates. |
+| [IImageProcessor](Interface.IImageProcessor) | Base interface for image processors. Handles image manipulation and format conversion. |
+| [IRenderOptions](Interface.IRenderOptions) | Options for rendering a document. |
+| [IRenderResult](Interface.IRenderResult) | Document render result. |
 
 ## Type Aliases
 
-| Type Alias                                 | Description                           |
-| ------------------------------------------ | ------------------------------------- |
-| [DocumentFormat](TypeAlias.DocumentFormat) | Document output format types.         |
-| [EngineType](TypeAlias.EngineType)         | Template engine type.                 |
-| [ImageMimeType](TypeAlias.ImageMimeType)   | Image MIME type.                      |
+| Type Alias | Description |
+| ------ | ------ |
+| [DocumentFormat](TypeAlias.DocumentFormat) | Document output format types. |
+| [EngineType](TypeAlias.EngineType) | Template engine type. |
+| [ImageMimeType](TypeAlias.ImageMimeType) | Image MIME type. |
 | [TemplateFormat](TypeAlias.TemplateFormat) | Template format type (parser syntax). |
-| [TemplateType](TypeAlias.TemplateType)     | Template type.                        |
+| [TemplateType](TypeAlias.TemplateType) | Template type. |
 
 ## 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,184 @@
+---
+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.