@breadstone/archipel-mcp 0.0.11 → 0.0.14

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

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

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

@@ -1,90 +0,0 @@
----
-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`\>

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

@@ -1,198 +0,0 @@
----
-title: 'Class: EsigningService'
-generated: true
-editUrl: false
----
-# Class: EsigningService
-
-Defined in: [services/EsigningService.ts:23](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/services/EsigningService.ts#L23)
-
-Application-level service for e-signing operations.
-Delegates to the configured [EsigningClientPort](Class.EsigningClientPort) and optionally invokes
-the [EsigningPersistencePort](Class.EsigningPersistencePort) for state tracking.
-
-## Constructors
-
-### Constructor
-
-```ts
-new EsigningService(client, persistence): EsigningService;
-```
-
-Defined in: [services/EsigningService.ts:40](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/services/EsigningService.ts#L40)
-
-Initializes a new instance of the EsigningService class.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `client` | [`EsigningClientPort`](Class.EsigningClientPort) | The concrete e-signing provider implementation. |
-| `persistence` | [`EsigningPersistencePort`](Class.EsigningPersistencePort) \| `null` | Optional port for persisting signing request state. |
-
-#### Returns
-
-`EsigningService`
-
-## Accessors
-
-### providerId
-
-#### Get Signature
-
-```ts
-get providerId(): string;
-```
-
-Defined in: [services/EsigningService.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/services/EsigningService.ts#L50)
-
-Identifier of the active provider.
-
-##### Returns
-
-`string`
-
-## Methods
-
-### cancelSigningRequest()
-
-```ts
-cancelSigningRequest(signingRequestId, reason?): Promise<void>;
-```
-
-Defined in: [services/EsigningService.ts:113](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/services/EsigningService.ts#L113)
-
-Cancel an in-progress signing request.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `signingRequestId` | `string` | The signing request identifier. |
-| `reason?` | `string` | Optional reason for cancellation. |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### createSigningRequest()
-
-```ts
-createSigningRequest(request): Promise<ISigningRequest>;
-```
-
-Defined in: [services/EsigningService.ts:65](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/services/EsigningService.ts#L65)
-
-Create a new signing request.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`ICreateSigningRequest`](Interface.ICreateSigningRequest) | The signing request creation input. |
-
-#### Returns
-
-`Promise`\<[`ISigningRequest`](Interface.ISigningRequest)\>
-
-The created signing request.
-
-***
-
-### createSigningSession()
-
-```ts
-createSigningSession(request): Promise<ISigningSession>;
-```
-
-Defined in: [services/EsigningService.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/services/EsigningService.ts#L80)
-
-Generate a signing session (signing link) for a specific signer.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `request` | [`ICreateSigningSessionRequest`](Interface.ICreateSigningSessionRequest) | The session creation input. |
-
-#### Returns
-
-`Promise`\<[`ISigningSession`](Interface.ISigningSession)\>
-
-The signing session.
-
-***
-
-### getSignedDocuments()
-
-```ts
-getSignedDocuments(signingRequestId): Promise<ISignedDocument[]>;
-```
-
-Defined in: [services/EsigningService.ts:102](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/services/EsigningService.ts#L102)
-
-Retrieve the final signed documents for a completed signing request.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `signingRequestId` | `string` | The signing request identifier. |
-
-#### Returns
-
-`Promise`\<[`ISignedDocument`](Interface.ISignedDocument)[]\>
-
-Array of signed documents.
-
-***
-
-### getSigningRequest()
-
-```ts
-getSigningRequest(signingRequestId): Promise<ISigningRequest>;
-```
-
-Defined in: [services/EsigningService.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/services/EsigningService.ts#L91)
-
-Retrieve the current status and details of a signing request.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `signingRequestId` | `string` | The signing request identifier. |
-
-#### Returns
-
-`Promise`\<[`ISigningRequest`](Interface.ISigningRequest)\>
-
-The signing request with current status.
-
-***
-
-### verifyWebhook()
-
-```ts
-verifyWebhook(payload, signature): Promise<IEsigningWebhookEvent>;
-```
-
-Defined in: [services/EsigningService.ts:128](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/services/EsigningService.ts#L128)
-
-Verify a webhook payload and return a normalized event.
-Optionally updates persistence if a state change is detected.
-
-#### 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.InternalEsigningProvider.md

@@ -1,249 +0,0 @@
----
-title: 'Class: InternalEsigningProvider'
-generated: true
-editUrl: false
----
-# Class: InternalEsigningProvider
-
-Defined in: [providers/internal/InternalEsigningProvider.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L42)
-
-Built-in e-signing provider that manages signing requests in-memory.
-This provider fulfills the same contract as external providers and can be used
-for development, testing, or simple self-managed signing workflows.
-
-## Extends
-
-- [`EsigningClientPort`](Class.EsigningClientPort)
-
-## Constructors
-
-### Constructor
-
-```ts
-new InternalEsigningProvider(): InternalEsigningProvider;
-```
-
-#### Returns
-
-`InternalEsigningProvider`
-
-#### Inherited from
-
-[`EsigningClientPort`](Class.EsigningClientPort).[`constructor`](Class.EsigningClientPort#constructor)
-
-## Accessors
-
-### providerId
-
-#### Get Signature
-
-```ts
-get providerId(): string;
-```
-
-Defined in: [providers/internal/InternalEsigningProvider.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L51)
-
-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: [providers/internal/InternalEsigningProvider.ts:181](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L181)
-
-Cancel an in-progress signing request.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `signingRequestId` | `string` | The provider-specific signing request identifier. |
-| `_reason?` | `string` | - |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-#### Overrides
-
-[`EsigningClientPort`](Class.EsigningClientPort).[`cancelSigningRequest`](Class.EsigningClientPort#cancelsigningrequest)
-
-***
-
-### completeSigner()
-
-```ts
-completeSigner(signingRequestId, signerId): Promise<void>;
-```
-
-Defined in: [providers/internal/InternalEsigningProvider.ts:204](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L204)
-
-Marks a signer as having completed their signing.
-This is specific to the internal provider and allows the consuming
-application to programmatically complete a signer's step.
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `signingRequestId` | `string` | The signing request identifier. |
-| `signerId` | `string` | The signer identifier. |
-
-#### Returns
-
-`Promise`\<`void`\>
-
-***
-
-### createSigningRequest()
-
-```ts
-createSigningRequest(request): Promise<ISigningRequest>;
-```
-
-Defined in: [providers/internal/InternalEsigningProvider.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L59)
-
-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: [providers/internal/InternalEsigningProvider.ts:121](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L121)
-
-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: [providers/internal/InternalEsigningProvider.ts:164](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L164)
-
-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: [providers/internal/InternalEsigningProvider.ts:150](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L150)
-
-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): Promise<IEsigningWebhookEvent>;
-```
-
-Defined in: [providers/internal/InternalEsigningProvider.ts:191](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/providers/internal/InternalEsigningProvider.ts#L191)
-
-Verify a webhook payload signature and return a normalized event.
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `_payload` | `string` \| `Buffer`\<`ArrayBufferLike`\> |
-| `_signature` | `string` |
-
-#### Returns
-
-`Promise`\<[`IEsigningWebhookEvent`](Interface.IEsigningWebhookEvent)\>
-
-Normalized webhook event.
-
-#### Overrides
-
-[`EsigningClientPort`](Class.EsigningClientPort).[`verifyWebhook`](Class.EsigningClientPort#verifywebhook)