@breadstone/archipel-mcp 0.0.17 → 0.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/guides/esigning-integration.md +1 -2
- package/data/guides/openapi-and-feature-discovery.md +20 -12
- package/data/packages/platform-caching/index.md +8 -5
- package/data/packages/platform-cryptography/index.md +6 -8
- package/data/packages/platform-esigning/api/Class.AdobeSignEsigningProvider.md +242 -0
- package/data/packages/platform-esigning/api/Class.DocuSignEsigningProvider.md +236 -0
- package/data/packages/platform-esigning/api/Class.DropboxSignEsigningProvider.md +236 -0
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +4 -1
- package/data/packages/platform-esigning/api/Class.EsigningModule.md +28 -2
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleAsyncOptions.md +87 -0
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +5 -5
- package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptionsFactory.md +31 -0
- package/data/packages/platform-esigning/api/index.md +6 -13
- package/data/packages/platform-esigning/index.md +3 -22
- package/data/packages/platform-logging/index.md +18 -46
- package/data/packages/platform-openapi/api/Function.Api.md +3 -14
- package/data/packages/platform-openapi/api/index.md +1 -1
- package/data/packages/platform-openapi/index.md +78 -43
- package/package.json +1 -1
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +0 -14
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +0 -12
- package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +0 -12
- package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +0 -14
- package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +0 -14
- package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +0 -14
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: DropboxSignEsigningProvider'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: DropboxSignEsigningProvider
|
|
7
|
+
|
|
8
|
+
Defined in: [dropbox-sign/DropboxSignEsigningProvider.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/dropbox-sign/DropboxSignEsigningProvider.ts#L70)
|
|
9
|
+
|
|
10
|
+
Dropbox Sign (HelloSign) e-signing provider.
|
|
11
|
+
Integrates with the Dropbox Sign API v3 via the official
|
|
12
|
+
`@dropbox/sign` Node.js SDK.
|
|
13
|
+
|
|
14
|
+
## Extends
|
|
15
|
+
|
|
16
|
+
- [`EsigningClientPort`](Class.EsigningClientPort)
|
|
17
|
+
|
|
18
|
+
## Constructors
|
|
19
|
+
|
|
20
|
+
### Constructor
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
new DropboxSignEsigningProvider(config): DropboxSignEsigningProvider;
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Defined in: [dropbox-sign/DropboxSignEsigningProvider.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/dropbox-sign/DropboxSignEsigningProvider.ts#L82)
|
|
27
|
+
|
|
28
|
+
#### Parameters
|
|
29
|
+
|
|
30
|
+
| Parameter | Type |
|
|
31
|
+
| ------ | ------ |
|
|
32
|
+
| `config` | `ConfigService` |
|
|
33
|
+
|
|
34
|
+
#### Returns
|
|
35
|
+
|
|
36
|
+
`DropboxSignEsigningProvider`
|
|
37
|
+
|
|
38
|
+
#### Overrides
|
|
39
|
+
|
|
40
|
+
[`EsigningClientPort`](Class.EsigningClientPort).[`constructor`](Class.EsigningClientPort#constructor)
|
|
41
|
+
|
|
42
|
+
## Accessors
|
|
43
|
+
|
|
44
|
+
### providerId
|
|
45
|
+
|
|
46
|
+
#### Get Signature
|
|
47
|
+
|
|
48
|
+
```ts
|
|
49
|
+
get providerId(): string;
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Defined in: [dropbox-sign/DropboxSignEsigningProvider.ts:100](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/dropbox-sign/DropboxSignEsigningProvider.ts#L100)
|
|
53
|
+
|
|
54
|
+
Unique identifier of the provider implementation.
|
|
55
|
+
|
|
56
|
+
##### Returns
|
|
57
|
+
|
|
58
|
+
`string`
|
|
59
|
+
|
|
60
|
+
Unique identifier of the provider implementation.
|
|
61
|
+
|
|
62
|
+
#### Overrides
|
|
63
|
+
|
|
64
|
+
[`EsigningClientPort`](Class.EsigningClientPort).[`providerId`](Class.EsigningClientPort#providerid)
|
|
65
|
+
|
|
66
|
+
## Methods
|
|
67
|
+
|
|
68
|
+
### cancelSigningRequest()
|
|
69
|
+
|
|
70
|
+
```ts
|
|
71
|
+
cancelSigningRequest(signingRequestId, _reason?): Promise<void>;
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Defined in: [dropbox-sign/DropboxSignEsigningProvider.ts:218](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/dropbox-sign/DropboxSignEsigningProvider.ts#L218)
|
|
75
|
+
|
|
76
|
+
Cancel an in-progress signing request.
|
|
77
|
+
|
|
78
|
+
#### Parameters
|
|
79
|
+
|
|
80
|
+
| Parameter | Type | Description |
|
|
81
|
+
| ------ | ------ | ------ |
|
|
82
|
+
| `signingRequestId` | `string` | The provider-specific signing request identifier. |
|
|
83
|
+
| `_reason?` | `string` | - |
|
|
84
|
+
|
|
85
|
+
#### Returns
|
|
86
|
+
|
|
87
|
+
`Promise`\<`void`\>
|
|
88
|
+
|
|
89
|
+
#### Overrides
|
|
90
|
+
|
|
91
|
+
[`EsigningClientPort`](Class.EsigningClientPort).[`cancelSigningRequest`](Class.EsigningClientPort#cancelsigningrequest)
|
|
92
|
+
|
|
93
|
+
***
|
|
94
|
+
|
|
95
|
+
### createSigningRequest()
|
|
96
|
+
|
|
97
|
+
```ts
|
|
98
|
+
createSigningRequest(request): Promise<ISigningRequest>;
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
Defined in: [dropbox-sign/DropboxSignEsigningProvider.ts:108](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/dropbox-sign/DropboxSignEsigningProvider.ts#L108)
|
|
102
|
+
|
|
103
|
+
Create a new signing request (envelope/agreement).
|
|
104
|
+
|
|
105
|
+
#### Parameters
|
|
106
|
+
|
|
107
|
+
| Parameter | Type | Description |
|
|
108
|
+
| ------ | ------ | ------ |
|
|
109
|
+
| `request` | [`ICreateSigningRequest`](Interface.ICreateSigningRequest) | The signing request creation input. |
|
|
110
|
+
|
|
111
|
+
#### Returns
|
|
112
|
+
|
|
113
|
+
`Promise`\<[`ISigningRequest`](Interface.ISigningRequest)\>
|
|
114
|
+
|
|
115
|
+
The created signing request with provider-assigned identifiers.
|
|
116
|
+
|
|
117
|
+
#### Overrides
|
|
118
|
+
|
|
119
|
+
[`EsigningClientPort`](Class.EsigningClientPort).[`createSigningRequest`](Class.EsigningClientPort#createsigningrequest)
|
|
120
|
+
|
|
121
|
+
***
|
|
122
|
+
|
|
123
|
+
### createSigningSession()
|
|
124
|
+
|
|
125
|
+
```ts
|
|
126
|
+
createSigningSession(request): Promise<ISigningSession>;
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Defined in: [dropbox-sign/DropboxSignEsigningProvider.ts:153](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/dropbox-sign/DropboxSignEsigningProvider.ts#L153)
|
|
130
|
+
|
|
131
|
+
Generate a signing session (signing link/URL) for a specific signer.
|
|
132
|
+
|
|
133
|
+
#### Parameters
|
|
134
|
+
|
|
135
|
+
| Parameter | Type | Description |
|
|
136
|
+
| ------ | ------ | ------ |
|
|
137
|
+
| `request` | [`ICreateSigningSessionRequest`](Interface.ICreateSigningSessionRequest) | The session creation input. |
|
|
138
|
+
|
|
139
|
+
#### Returns
|
|
140
|
+
|
|
141
|
+
`Promise`\<[`ISigningSession`](Interface.ISigningSession)\>
|
|
142
|
+
|
|
143
|
+
The signing session with the signing URL.
|
|
144
|
+
|
|
145
|
+
#### Overrides
|
|
146
|
+
|
|
147
|
+
[`EsigningClientPort`](Class.EsigningClientPort).[`createSigningSession`](Class.EsigningClientPort#createsigningsession)
|
|
148
|
+
|
|
149
|
+
***
|
|
150
|
+
|
|
151
|
+
### getSignedDocuments()
|
|
152
|
+
|
|
153
|
+
```ts
|
|
154
|
+
getSignedDocuments(signingRequestId): Promise<ISignedDocument[]>;
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
Defined in: [dropbox-sign/DropboxSignEsigningProvider.ts:197](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/dropbox-sign/DropboxSignEsigningProvider.ts#L197)
|
|
158
|
+
|
|
159
|
+
Retrieve the final signed documents for a completed signing request.
|
|
160
|
+
|
|
161
|
+
#### Parameters
|
|
162
|
+
|
|
163
|
+
| Parameter | Type | Description |
|
|
164
|
+
| ------ | ------ | ------ |
|
|
165
|
+
| `signingRequestId` | `string` | The provider-specific signing request identifier. |
|
|
166
|
+
|
|
167
|
+
#### Returns
|
|
168
|
+
|
|
169
|
+
`Promise`\<[`ISignedDocument`](Interface.ISignedDocument)[]\>
|
|
170
|
+
|
|
171
|
+
Array of signed documents with their content.
|
|
172
|
+
|
|
173
|
+
#### Overrides
|
|
174
|
+
|
|
175
|
+
[`EsigningClientPort`](Class.EsigningClientPort).[`getSignedDocuments`](Class.EsigningClientPort#getsigneddocuments)
|
|
176
|
+
|
|
177
|
+
***
|
|
178
|
+
|
|
179
|
+
### getSigningRequest()
|
|
180
|
+
|
|
181
|
+
```ts
|
|
182
|
+
getSigningRequest(signingRequestId): Promise<ISigningRequest>;
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
Defined in: [dropbox-sign/DropboxSignEsigningProvider.ts:185](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/dropbox-sign/DropboxSignEsigningProvider.ts#L185)
|
|
186
|
+
|
|
187
|
+
Retrieve the current status and details of a signing request.
|
|
188
|
+
|
|
189
|
+
#### Parameters
|
|
190
|
+
|
|
191
|
+
| Parameter | Type | Description |
|
|
192
|
+
| ------ | ------ | ------ |
|
|
193
|
+
| `signingRequestId` | `string` | The provider-specific signing request identifier. |
|
|
194
|
+
|
|
195
|
+
#### Returns
|
|
196
|
+
|
|
197
|
+
`Promise`\<[`ISigningRequest`](Interface.ISigningRequest)\>
|
|
198
|
+
|
|
199
|
+
The signing request with current status.
|
|
200
|
+
|
|
201
|
+
#### Overrides
|
|
202
|
+
|
|
203
|
+
[`EsigningClientPort`](Class.EsigningClientPort).[`getSigningRequest`](Class.EsigningClientPort#getsigningrequest)
|
|
204
|
+
|
|
205
|
+
***
|
|
206
|
+
|
|
207
|
+
### verifyWebhook()
|
|
208
|
+
|
|
209
|
+
```ts
|
|
210
|
+
verifyWebhook(
|
|
211
|
+
payload,
|
|
212
|
+
_signature,
|
|
213
|
+
_headers?): Promise<IEsigningWebhookEvent>;
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
Defined in: [dropbox-sign/DropboxSignEsigningProvider.ts:227](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/dropbox-sign/DropboxSignEsigningProvider.ts#L227)
|
|
217
|
+
|
|
218
|
+
Verify a webhook payload signature and return a normalized event.
|
|
219
|
+
|
|
220
|
+
#### Parameters
|
|
221
|
+
|
|
222
|
+
| Parameter | Type | Description |
|
|
223
|
+
| ------ | ------ | ------ |
|
|
224
|
+
| `payload` | `string` \| `Buffer`\<`ArrayBufferLike`\> | Raw webhook body. |
|
|
225
|
+
| `_signature` | `string` | - |
|
|
226
|
+
| `_headers?` | `Record`\<`string`, `string`\> | - |
|
|
227
|
+
|
|
228
|
+
#### Returns
|
|
229
|
+
|
|
230
|
+
`Promise`\<[`IEsigningWebhookEvent`](Interface.IEsigningWebhookEvent)\>
|
|
231
|
+
|
|
232
|
+
Normalized webhook event.
|
|
233
|
+
|
|
234
|
+
#### Overrides
|
|
235
|
+
|
|
236
|
+
[`EsigningClientPort`](Class.EsigningClientPort).[`verifyWebhook`](Class.EsigningClientPort#verifywebhook)
|
|
@@ -8,12 +8,15 @@ editUrl: false
|
|
|
8
8
|
Defined in: [contracts/EsigningClientPort.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/contracts/EsigningClientPort.ts#L19)
|
|
9
9
|
|
|
10
10
|
Abstract port for e-signing provider clients.
|
|
11
|
-
Each provider (DocuSign, Adobe Sign, Dropbox Sign,
|
|
11
|
+
Each provider (DocuSign, Adobe Sign, Dropbox Sign, Internal) must implement
|
|
12
12
|
this contract so that the consuming application can switch providers without changing business logic.
|
|
13
13
|
|
|
14
14
|
## Extended by
|
|
15
15
|
|
|
16
16
|
- [`InternalEsigningProvider`](Class.InternalEsigningProvider)
|
|
17
|
+
- [`DocuSignEsigningProvider`](Class.DocuSignEsigningProvider)
|
|
18
|
+
- [`AdobeSignEsigningProvider`](Class.AdobeSignEsigningProvider)
|
|
19
|
+
- [`DropboxSignEsigningProvider`](Class.DropboxSignEsigningProvider)
|
|
17
20
|
|
|
18
21
|
## Constructors
|
|
19
22
|
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: EsigningModule
|
|
7
7
|
|
|
8
|
-
Defined in: [EsigningModule.ts:
|
|
8
|
+
Defined in: [EsigningModule.ts:106](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L106)
|
|
9
9
|
|
|
10
10
|
NestJS module providing generic e-signing infrastructure.
|
|
11
11
|
Exposes a configurable signing client and optional persistence tracking.
|
|
@@ -31,7 +31,7 @@ new EsigningModule(): EsigningModule;
|
|
|
31
31
|
static register(options): DynamicModule;
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
-
Defined in: [EsigningModule.ts:
|
|
34
|
+
Defined in: [EsigningModule.ts:116](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L116)
|
|
35
35
|
|
|
36
36
|
Configures the module with the specified options.
|
|
37
37
|
|
|
@@ -46,3 +46,29 @@ Configures the module with the specified options.
|
|
|
46
46
|
`DynamicModule`
|
|
47
47
|
|
|
48
48
|
Dynamic module definition.
|
|
49
|
+
|
|
50
|
+
***
|
|
51
|
+
|
|
52
|
+
### registerAsync()
|
|
53
|
+
|
|
54
|
+
```ts
|
|
55
|
+
static registerAsync(options): DynamicModule;
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Defined in: [EsigningModule.ts:151](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L151)
|
|
59
|
+
|
|
60
|
+
Configures the module asynchronously with factory-based options.
|
|
61
|
+
Use this when the provider type or configuration entries need to be resolved
|
|
62
|
+
at runtime (e.g., from environment or a config service).
|
|
63
|
+
|
|
64
|
+
#### Parameters
|
|
65
|
+
|
|
66
|
+
| Parameter | Type | Description |
|
|
67
|
+
| ------ | ------ | ------ |
|
|
68
|
+
| `options` | [`IEsigningModuleAsyncOptions`](Interface.IEsigningModuleAsyncOptions) | The async module configuration options. |
|
|
69
|
+
|
|
70
|
+
#### Returns
|
|
71
|
+
|
|
72
|
+
`DynamicModule`
|
|
73
|
+
|
|
74
|
+
Dynamic module definition.
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IEsigningModuleAsyncOptions'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IEsigningModuleAsyncOptions
|
|
7
|
+
|
|
8
|
+
Defined in: [EsigningModule.ts:55](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L55)
|
|
9
|
+
|
|
10
|
+
Async configuration options for the [EsigningModule](Class.EsigningModule).
|
|
11
|
+
|
|
12
|
+
## Extends
|
|
13
|
+
|
|
14
|
+
- `Pick`\<`ModuleMetadata`, `"imports"`\>
|
|
15
|
+
|
|
16
|
+
## Properties
|
|
17
|
+
|
|
18
|
+
### inject?
|
|
19
|
+
|
|
20
|
+
```ts
|
|
21
|
+
optional inject?: (InjectionToken | OptionalFactoryDependency)[];
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Defined in: [EsigningModule.ts:59](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L59)
|
|
25
|
+
|
|
26
|
+
Injection tokens to make available to the factory.
|
|
27
|
+
|
|
28
|
+
***
|
|
29
|
+
|
|
30
|
+
### isGlobal?
|
|
31
|
+
|
|
32
|
+
```ts
|
|
33
|
+
optional isGlobal?: boolean;
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Defined in: [EsigningModule.ts:79](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L79)
|
|
37
|
+
|
|
38
|
+
When `true` the module is registered globally.
|
|
39
|
+
|
|
40
|
+
***
|
|
41
|
+
|
|
42
|
+
### useClass?
|
|
43
|
+
|
|
44
|
+
```ts
|
|
45
|
+
optional useClass?: Type<IEsigningModuleOptionsFactory>;
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Defined in: [EsigningModule.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L74)
|
|
49
|
+
|
|
50
|
+
Class to instantiate as factory.
|
|
51
|
+
|
|
52
|
+
***
|
|
53
|
+
|
|
54
|
+
### useExisting?
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
optional useExisting?: Type<IEsigningModuleOptionsFactory>;
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Defined in: [EsigningModule.ts:69](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L69)
|
|
61
|
+
|
|
62
|
+
Existing provider that implements [IEsigningModuleOptionsFactory](Interface.IEsigningModuleOptionsFactory).
|
|
63
|
+
|
|
64
|
+
***
|
|
65
|
+
|
|
66
|
+
### useFactory?
|
|
67
|
+
|
|
68
|
+
```ts
|
|
69
|
+
optional useFactory?: (...args) =>
|
|
70
|
+
| IEsigningModuleOptions
|
|
71
|
+
| Promise<IEsigningModuleOptions>;
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Defined in: [EsigningModule.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L64)
|
|
75
|
+
|
|
76
|
+
Factory function that returns module options (or a promise).
|
|
77
|
+
|
|
78
|
+
#### Parameters
|
|
79
|
+
|
|
80
|
+
| Parameter | Type |
|
|
81
|
+
| ------ | ------ |
|
|
82
|
+
| ...`args` | `unknown`[] |
|
|
83
|
+
|
|
84
|
+
#### Returns
|
|
85
|
+
|
|
86
|
+
\| [`IEsigningModuleOptions`](Interface.IEsigningModuleOptions)
|
|
87
|
+
\| `Promise`\<[`IEsigningModuleOptions`](Interface.IEsigningModuleOptions)\>
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IEsigningModuleOptions
|
|
7
7
|
|
|
8
|
-
Defined in: [EsigningModule.ts:
|
|
8
|
+
Defined in: [EsigningModule.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L26)
|
|
9
9
|
|
|
10
10
|
Configuration options for the [EsigningModule](Class.EsigningModule).
|
|
11
11
|
|
|
@@ -17,7 +17,7 @@ Configuration options for the [EsigningModule](Class.EsigningModule).
|
|
|
17
17
|
optional configEntries?: readonly Omit<IConfigRegistryEntry<unknown>, "module">[];
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Defined in: [EsigningModule.ts:
|
|
20
|
+
Defined in: [EsigningModule.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L36)
|
|
21
21
|
|
|
22
22
|
Provider-specific configuration entries to register with the config module.
|
|
23
23
|
|
|
@@ -29,7 +29,7 @@ Provider-specific configuration entries to register with the config module.
|
|
|
29
29
|
optional isGlobal?: boolean;
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
Defined in: [EsigningModule.ts:
|
|
32
|
+
Defined in: [EsigningModule.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L47)
|
|
33
33
|
|
|
34
34
|
When `true` the module is registered globally.
|
|
35
35
|
|
|
@@ -41,7 +41,7 @@ When `true` the module is registered globally.
|
|
|
41
41
|
optional persistence?: Type<EsigningPersistencePort>;
|
|
42
42
|
```
|
|
43
43
|
|
|
44
|
-
Defined in: [EsigningModule.ts:
|
|
44
|
+
Defined in: [EsigningModule.ts:42](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L42)
|
|
45
45
|
|
|
46
46
|
Concrete implementation of the [EsigningPersistencePort](Class.EsigningPersistencePort).
|
|
47
47
|
Required when the application needs to persist signing request state.
|
|
@@ -54,7 +54,7 @@ Required when the application needs to persist signing request state.
|
|
|
54
54
|
provider: Type<EsigningClientPort>;
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
Defined in: [EsigningModule.ts:
|
|
57
|
+
Defined in: [EsigningModule.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L31)
|
|
58
58
|
|
|
59
59
|
Concrete implementation of the [EsigningClientPort](Class.EsigningClientPort).
|
|
60
60
|
For example, `InternalEsigningProvider`, `DocuSignClient`, `AdobeSignClient`, etc.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IEsigningModuleOptionsFactory'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IEsigningModuleOptionsFactory
|
|
7
|
+
|
|
8
|
+
Defined in: [EsigningModule.ts:87](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L87)
|
|
9
|
+
|
|
10
|
+
Factory interface for creating e-signing module options asynchronously.
|
|
11
|
+
|
|
12
|
+
## Methods
|
|
13
|
+
|
|
14
|
+
### createEsigningOptions()
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
createEsigningOptions():
|
|
18
|
+
| IEsigningModuleOptions
|
|
19
|
+
| Promise<IEsigningModuleOptions>;
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Defined in: [EsigningModule.ts:93](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/EsigningModule.ts#L93)
|
|
23
|
+
|
|
24
|
+
Creates the module options.
|
|
25
|
+
|
|
26
|
+
#### Returns
|
|
27
|
+
|
|
28
|
+
\| [`IEsigningModuleOptions`](Interface.IEsigningModuleOptions)
|
|
29
|
+
\| `Promise`\<[`IEsigningModuleOptions`](Interface.IEsigningModuleOptions)\>
|
|
30
|
+
|
|
31
|
+
The module configuration options or a promise resolving to them.
|
|
@@ -9,7 +9,10 @@ editUrl: false
|
|
|
9
9
|
|
|
10
10
|
| Class | Description |
|
|
11
11
|
| ------ | ------ |
|
|
12
|
-
| [
|
|
12
|
+
| [AdobeSignEsigningProvider](Class.AdobeSignEsigningProvider) | Adobe Acrobat Sign e-signing provider. Integrates with the Adobe Sign REST API v6 to manage agreements, signing sessions, and webhook verification. |
|
|
13
|
+
| [DocuSignEsigningProvider](Class.DocuSignEsigningProvider) | DocuSign eSignature provider. Integrates with the DocuSign eSignature REST API v2.1 via the official `docusign-esign` Node.js SDK. |
|
|
14
|
+
| [DropboxSignEsigningProvider](Class.DropboxSignEsigningProvider) | Dropbox Sign (HelloSign) e-signing provider. Integrates with the Dropbox Sign API v3 via the official `@dropbox/sign` Node.js SDK. |
|
|
15
|
+
| [EsigningClientPort](Class.EsigningClientPort) | Abstract port for e-signing provider clients. Each provider (DocuSign, Adobe Sign, Dropbox Sign, Internal) must implement this contract so that the consuming application can switch providers without changing business logic. |
|
|
13
16
|
| [EsigningError](Class.EsigningError) | Base error for all e-signing related failures. |
|
|
14
17
|
| [EsigningModule](Class.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. |
|
|
15
18
|
| [EsigningPersistencePort](Class.EsigningPersistencePort) | Abstract port for persisting signing request state. Implement this port in the consuming application to track signing requests in a database. |
|
|
@@ -27,7 +30,9 @@ editUrl: false
|
|
|
27
30
|
| [ICreateSigningRequestDocument](Interface.ICreateSigningRequestDocument) | A document to include when creating a signing request. |
|
|
28
31
|
| [ICreateSigningRequestSigner](Interface.ICreateSigningRequestSigner) | A signer to include when creating a signing request. |
|
|
29
32
|
| [ICreateSigningSessionRequest](Interface.ICreateSigningSessionRequest) | Input for creating a signing session (signing link) for a specific signer. |
|
|
33
|
+
| [IEsigningModuleAsyncOptions](Interface.IEsigningModuleAsyncOptions) | Async configuration options for the [EsigningModule](Class.EsigningModule). |
|
|
30
34
|
| [IEsigningModuleOptions](Interface.IEsigningModuleOptions) | Configuration options for the [EsigningModule](Class.EsigningModule). |
|
|
35
|
+
| [IEsigningModuleOptionsFactory](Interface.IEsigningModuleOptionsFactory) | Factory interface for creating e-signing module options asynchronously. |
|
|
31
36
|
| [IEsigningWebhookEvent](Interface.IEsigningWebhookEvent) | Normalized representation of a webhook event from an e-signing provider. |
|
|
32
37
|
| [ISignedDocument](Interface.ISignedDocument) | Normalized representation of a signed (completed) document. |
|
|
33
38
|
| [ISigner](Interface.ISigner) | Normalized representation of a signer participating in a signing request. |
|
|
@@ -65,20 +70,8 @@ editUrl: false
|
|
|
65
70
|
| [DROPBOX\_SIGN\_CLIENT\_ID](Variable.DROPBOX_SIGN_CLIENT_ID) | Dropbox Sign client ID. |
|
|
66
71
|
| [DROPBOX\_SIGN\_CONFIG\_ENTRIES](Variable.DROPBOX_SIGN_CONFIG_ENTRIES) | Configuration entries required by the Dropbox Sign e-signing provider. |
|
|
67
72
|
| [DROPBOX\_SIGN\_WEBHOOK\_SECRET](Variable.DROPBOX_SIGN_WEBHOOK_SECRET) | Dropbox Sign webhook secret. |
|
|
68
|
-
| [ESIGNING\_API\_BASE\_URL](Variable.ESIGNING_API_BASE_URL) | Active e-signing provider base URL. |
|
|
69
|
-
| [ESIGNING\_API\_KEY](Variable.ESIGNING_API_KEY) | Active e-signing provider API key. |
|
|
70
|
-
| [ESIGNING\_PROVIDER](Variable.ESIGNING_PROVIDER) | - |
|
|
71
|
-
| [ESIGNING\_PROVIDER\_OPTIONS](Variable.ESIGNING_PROVIDER_OPTIONS) | - |
|
|
72
|
-
| [ESIGNING\_WEBHOOK\_SECRET](Variable.ESIGNING_WEBHOOK_SECRET) | Active e-signing provider webhook signing secret. |
|
|
73
|
-
| [PLATFORM\_ESIGNING\_CONFIG\_ENTRIES](Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES) | All configuration entries required by `platform-esigning`. |
|
|
74
73
|
| [SignerRoles](Variable.SignerRoles) | Represents the role of a signer in a signing request. |
|
|
75
74
|
| [SignerStatuses](Variable.SignerStatuses) | Represents the status of an individual signer within a signing request. |
|
|
76
75
|
| [SigningFieldTypes](Variable.SigningFieldTypes) | Represents the type of a signing field placed on a document. |
|
|
77
76
|
| [SigningRequestStatuses](Variable.SigningRequestStatuses) | Represents the lifecycle status of a signing request. |
|
|
78
|
-
| [SIGNNOW\_API\_KEY](Variable.SIGNNOW_API_KEY) | signNow API key (basic token). |
|
|
79
|
-
| [SIGNNOW\_BASE\_URL](Variable.SIGNNOW_BASE_URL) | signNow base URL. |
|
|
80
|
-
| [SIGNNOW\_CLIENT\_ID](Variable.SIGNNOW_CLIENT_ID) | signNow client ID. |
|
|
81
|
-
| [SIGNNOW\_CLIENT\_SECRET](Variable.SIGNNOW_CLIENT_SECRET) | signNow client secret. |
|
|
82
|
-
| [SIGNNOW\_CONFIG\_ENTRIES](Variable.SIGNNOW_CONFIG_ENTRIES) | Configuration entries required by the signNow e-signing provider. |
|
|
83
|
-
| [SIGNNOW\_WEBHOOK\_SECRET](Variable.SIGNNOW_WEBHOOK_SECRET) | signNow webhook callback secret. |
|
|
84
77
|
| [WebhookEventTypes](Variable.WebhookEventTypes) | Represents the type of webhook event emitted by a signing provider. |
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: platform-esigning
|
|
3
|
-
description: Provider-agnostic e-signing infrastructure with support for DocuSign, Adobe Sign, Dropbox Sign,
|
|
3
|
+
description: Provider-agnostic e-signing infrastructure with support for DocuSign, Adobe Sign, Dropbox Sign, and a built-in internal provider.
|
|
4
4
|
order: 5
|
|
5
|
-
tags: [esigning, docusign, adobe-sign, dropbox-sign,
|
|
5
|
+
tags: [esigning, docusign, adobe-sign, dropbox-sign, digital-signatures, ports-and-adapters, webhooks]
|
|
6
6
|
package: '@breadstone/archipel-platform-esigning'
|
|
7
7
|
---
|
|
8
8
|
|
|
9
9
|
# platform-esigning
|
|
10
10
|
|
|
11
|
-
Provider-agnostic e-signing infrastructure for NestJS. Exposes a unified `EsigningClientPort` abstraction with an internal provider out of the box and prepared entry points for DocuSign, Adobe Sign, Dropbox Sign
|
|
11
|
+
Provider-agnostic e-signing infrastructure for NestJS. Exposes a unified `EsigningClientPort` abstraction with an internal provider out of the box and prepared entry points for DocuSign, Adobe Sign, and Dropbox Sign. Optionally tracks signing request state via the `EsigningPersistencePort`.
|
|
12
12
|
|
|
13
13
|
**Package:** `@breadstone/archipel-platform-esigning`
|
|
14
14
|
|
|
@@ -21,18 +21,15 @@ graph TD
|
|
|
21
21
|
DocuSign["@breadstone/archipel-platform-esigning/docusign<br/><i>DocuSign config</i>"]
|
|
22
22
|
AdobeSign["@breadstone/archipel-platform-esigning/adobe-sign<br/><i>Adobe Sign config</i>"]
|
|
23
23
|
DropboxSign["@breadstone/archipel-platform-esigning/dropbox-sign<br/><i>Dropbox Sign config</i>"]
|
|
24
|
-
SignNow["@breadstone/archipel-platform-esigning/signnow<br/><i>signNow config</i>"]
|
|
25
24
|
|
|
26
25
|
Internal -->|implements| Core
|
|
27
26
|
DocuSign -.->|implements| Core
|
|
28
27
|
AdobeSign -.->|implements| Core
|
|
29
28
|
DropboxSign -.->|implements| Core
|
|
30
|
-
SignNow -.->|implements| Core
|
|
31
29
|
|
|
32
30
|
DocuSign -.-|requires| DS["docusign-esign"]
|
|
33
31
|
AdobeSign -.-|requires| AS["adobe-sign SDK"]
|
|
34
32
|
DropboxSign -.-|requires| DBS["@dropbox/sign"]
|
|
35
|
-
SignNow -.-|requires| SN["@signnow/api-client"]
|
|
36
33
|
```
|
|
37
34
|
|
|
38
35
|
Solid lines indicate shipped implementations. Dashed lines indicate provider entry points prepared for implementation. Each provider SDK is an **optional peer dependency** — install only the one you need.
|
|
@@ -168,22 +165,6 @@ import { ADOBE_SIGN_CONFIG_ENTRIES } from '@breadstone/archipel-platform-esignin
|
|
|
168
165
|
import { DROPBOX_SIGN_CONFIG_ENTRIES } from '@breadstone/archipel-platform-esigning/dropbox-sign';
|
|
169
166
|
```
|
|
170
167
|
|
|
171
|
-
### signNow
|
|
172
|
-
|
|
173
|
-
**Subpath:** `@breadstone/archipel-platform-esigning/signnow`
|
|
174
|
-
|
|
175
|
-
| Variable | Description | Required |
|
|
176
|
-
| ------------------------ | ------------------------------- | -------- |
|
|
177
|
-
| `SIGNNOW_API_KEY` | signNow API key (basic token) | Yes |
|
|
178
|
-
| `SIGNNOW_CLIENT_ID` | signNow client ID | Yes |
|
|
179
|
-
| `SIGNNOW_CLIENT_SECRET` | signNow client secret | Yes |
|
|
180
|
-
| `SIGNNOW_BASE_URL` | signNow base URL | Yes |
|
|
181
|
-
| `SIGNNOW_WEBHOOK_SECRET` | signNow webhook callback secret | No |
|
|
182
|
-
|
|
183
|
-
```typescript
|
|
184
|
-
import { SIGNNOW_CONFIG_ENTRIES } from '@breadstone/archipel-platform-esigning/signnow';
|
|
185
|
-
```
|
|
186
|
-
|
|
187
168
|
---
|
|
188
169
|
|
|
189
170
|
## EsigningClientPort
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: platform-logging
|
|
3
|
-
description:
|
|
3
|
+
description: Configurable logging module for NestJS with log-level management.
|
|
4
4
|
order: 6
|
|
5
|
-
tags: [logging,
|
|
5
|
+
tags: [logging, log-level, nestjs]
|
|
6
6
|
package: '@breadstone/archipel-platform-logging'
|
|
7
7
|
---
|
|
8
8
|
|
|
9
9
|
# platform-logging
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Configurable logging module for NestJS applications with application-wide log-level management. Wraps the built-in NestJS `Logger` and configures it via the central `ConfigModule`.
|
|
12
12
|
|
|
13
13
|
**Package:** `@breadstone/archipel-platform-logging`
|
|
14
14
|
|
|
@@ -24,28 +24,24 @@ import { LoggerModule } from '@breadstone/archipel-platform-logging';
|
|
|
24
24
|
export class AppModule {}
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
+
The module is `@Global()` — once imported, `Logger` is available for injection across the entire application.
|
|
28
|
+
|
|
27
29
|
---
|
|
28
30
|
|
|
29
|
-
##
|
|
31
|
+
## Using the Logger
|
|
30
32
|
|
|
31
|
-
|
|
33
|
+
Inject the standard NestJS `Logger` provided by `LoggerModule`:
|
|
32
34
|
|
|
33
35
|
```typescript
|
|
34
|
-
import {
|
|
36
|
+
import { Injectable, Logger } from '@nestjs/common';
|
|
35
37
|
|
|
36
38
|
@Injectable()
|
|
37
39
|
export class PaymentService {
|
|
38
|
-
constructor(private readonly
|
|
40
|
+
constructor(private readonly _logger: Logger) {}
|
|
39
41
|
|
|
40
42
|
public async processPayment(orderId: string): Promise<void> {
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
} catch (error) {
|
|
44
|
-
this._analytics.captureException(error, {
|
|
45
|
-
tags: { module: 'payments', orderId },
|
|
46
|
-
});
|
|
47
|
-
throw error;
|
|
48
|
-
}
|
|
43
|
+
this._logger.log(`Processing payment for order ${orderId}`);
|
|
44
|
+
// ...
|
|
49
45
|
}
|
|
50
46
|
}
|
|
51
47
|
```
|
|
@@ -54,39 +50,15 @@ export class PaymentService {
|
|
|
54
50
|
|
|
55
51
|
## Environment Variables
|
|
56
52
|
|
|
57
|
-
| Variable
|
|
58
|
-
|
|
|
59
|
-
| `
|
|
60
|
-
| `SENTRY_ENVIRONMENT` | Environment label (e.g. `'production'`, `'staging'`) | No |
|
|
61
|
-
| `SENTRY_TRACES_SAMPLE_RATE` | Sampling rate for performance traces (0.0–1.0) | No |
|
|
62
|
-
|
|
63
|
-
---
|
|
64
|
-
|
|
65
|
-
## Real-World Example: Global Error Filter
|
|
66
|
-
|
|
67
|
-
```typescript
|
|
68
|
-
import { Catch, type ExceptionFilter, type ArgumentsHost } from '@nestjs/common';
|
|
69
|
-
import { AnalyticsService } from '@breadstone/archipel-platform-logging';
|
|
70
|
-
|
|
71
|
-
@Catch()
|
|
72
|
-
export class GlobalExceptionFilter implements ExceptionFilter {
|
|
73
|
-
constructor(private readonly _analytics: AnalyticsService) {}
|
|
74
|
-
|
|
75
|
-
public catch(exception: unknown, host: ArgumentsHost): void {
|
|
76
|
-
this._analytics.captureException(exception);
|
|
77
|
-
|
|
78
|
-
const ctx = host.switchToHttp();
|
|
79
|
-
const response = ctx.getResponse();
|
|
80
|
-
response.status(500).json({ error: 'Internal Server Error' });
|
|
81
|
-
}
|
|
82
|
-
}
|
|
83
|
-
```
|
|
53
|
+
| Variable | Description | Required | Default |
|
|
54
|
+
| --------------- | -------------------------------------------------------------- | -------- | ------- |
|
|
55
|
+
| `APP_LOG_LEVEL` | Application log level (`'debug'`, `'info'`, `'warn'`, `'error'`) | No | `warn` |
|
|
84
56
|
|
|
85
57
|
---
|
|
86
58
|
|
|
87
59
|
## Exports Summary
|
|
88
60
|
|
|
89
|
-
| Export
|
|
90
|
-
|
|
|
91
|
-
| `LoggerModule`
|
|
92
|
-
| `
|
|
61
|
+
| Export | Type | Description |
|
|
62
|
+
| -------------- | ------------- | -------------------------------------------- |
|
|
63
|
+
| `LoggerModule` | NestJS Module | Global logging module with log-level control |
|
|
64
|
+
| `Logger` | Provider | NestJS Logger configured with `APP_LOG_LEVEL`|
|