@breadstone/archipel-platform-esigning
Classes
| Class | Description |
|---|---|
| EsigningClientPort | 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. |
| EsigningError | Base error for all e-signing related failures. |
| EsigningModule | 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. |
| EsigningPersistencePort | Abstract port for persisting signing request state. Implement this port in the consuming application to track signing requests in a database. |
| EsigningService | Application-level service for e-signing operations. Delegates to the configured EsigningClientPort and optionally invokes the EsigningPersistencePort for state tracking. |
| InternalEsigningProvider | 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. |
| SigningProviderError | Thrown when a provider-level operation fails. |
| SigningRequestNotFoundError | Thrown when a signing request cannot be found by the provider. |
| WebhookVerificationError | Thrown when a webhook signature verification fails. |
Interfaces
| Interface | Description |
|---|---|
| ICreateSigningRequest | Input for creating a new signing request. |
| ICreateSigningRequestDocument | A document to include when creating a signing request. |
| ICreateSigningRequestSigner | A signer to include when creating a signing request. |
| ICreateSigningSessionRequest | Input for creating a signing session (signing link) for a specific signer. |
| IEsigningModuleOptions | Configuration options for the EsigningModule. |
| IEsigningWebhookEvent | Normalized representation of a webhook event from an e-signing provider. |
| ISignedDocument | Normalized representation of a signed (completed) document. |
| ISigner | Normalized representation of a signer participating in a signing request. |
| ISigningDocument | Normalized representation of a document within a signing request. |
| ISigningField | Normalized representation of a signing field placed on a document. |
| ISigningRequest | Normalized representation of a signing request (envelope/agreement). |
| ISigningSession | Normalized representation of a signing session or signing link. |
Type Aliases
| Type Alias | Description |
|---|---|
| SignerRole | Union type derived from SignerRoles. |
| SignerStatus | Union type derived from SignerStatuses. |
| SigningFieldType | Union type derived from SigningFieldTypes. |
| SigningRequestStatus | Union type derived from SigningRequestStatuses. |
| WebhookEventType | Union type derived from WebhookEventTypes. |
Variables
| Variable | Description |
|---|---|
| ADOBE_SIGN_BASE_URL | Adobe Sign base URL. |
| ADOBE_SIGN_CLIENT_SECRET | Adobe Sign client secret. |
| ADOBE_SIGN_CONFIG_ENTRIES | Configuration entries required by the Adobe Sign e-signing provider. |
| ADOBE_SIGN_INTEGRATION_KEY | Adobe Sign integration key. |
| ADOBE_SIGN_WEBHOOK_CLIENT_ID | Adobe Sign webhook client ID for verification. |
| DOCUSIGN_ACCOUNT_ID | DocuSign account ID. |
| DOCUSIGN_BASE_URL | DocuSign base URL (e.g. https://demo.docusign.net for sandbox). |
| DOCUSIGN_CONFIG_ENTRIES | Configuration entries required by the DocuSign e-signing provider. |
| DOCUSIGN_INTEGRATION_KEY | DocuSign integration key (client ID). |
| DOCUSIGN_SECRET_KEY | DocuSign secret key (client secret). |
| DOCUSIGN_WEBHOOK_HMAC_KEY | DocuSign webhook HMAC key. |
| DROPBOX_SIGN_API_KEY | Dropbox Sign API key. |
| DROPBOX_SIGN_CLIENT_ID | Dropbox Sign client ID. |
| DROPBOX_SIGN_CONFIG_ENTRIES | Configuration entries required by the Dropbox Sign e-signing provider. |
| DROPBOX_SIGN_WEBHOOK_SECRET | Dropbox Sign webhook secret. |
| ESIGNING_API_BASE_URL | Active e-signing provider base URL. |
| ESIGNING_API_KEY | Active e-signing provider API key. |
| ESIGNING_PROVIDER | - |
| ESIGNING_PROVIDER_OPTIONS | - |
| ESIGNING_WEBHOOK_SECRET | Active e-signing provider webhook signing secret. |
| PLATFORM_ESIGNING_CONFIG_ENTRIES | All configuration entries required by platform-esigning. |
| SignerRoles | Represents the role of a signer in a signing request. |
| SignerStatuses | Represents the status of an individual signer within a signing request. |
| SigningFieldTypes | Represents the type of a signing field placed on a document. |
| SigningRequestStatuses | Represents the lifecycle status of a signing request. |
| SIGNNOW_API_KEY | signNow API key (basic token). |
| SIGNNOW_BASE_URL | signNow base URL. |
| SIGNNOW_CLIENT_ID | signNow client ID. |
| SIGNNOW_CLIENT_SECRET | signNow client secret. |
| SIGNNOW_CONFIG_ENTRIES | Configuration entries required by the signNow e-signing provider. |
| SIGNNOW_WEBHOOK_SECRET | signNow webhook callback secret. |
| WebhookEventTypes | Represents the type of webhook event emitted by a signing provider. |