@signature-kit/documenso 0.1.0 → 0.2.0
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/CHANGELOG.md +7 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +91 -42
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.2.0
|
|
4
|
+
|
|
5
|
+
- Download signed documents via the envelope item id (previously passed the envelope id and
|
|
6
|
+
404'd).
|
|
7
|
+
- Paginate list results.
|
|
8
|
+
- Drop the redundant 404 retry that repeated the identical failing request.
|
|
9
|
+
|
|
3
10
|
## 0.1.0
|
|
4
11
|
|
|
5
12
|
- Initial npm-ready release for `@signature-kit/documenso`.
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EAMlB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAEV,sBAAsB,EAEtB,2BAA2B,EAC5B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,mBAAmB,EAAqB,MAAM,0BAA0B,CAAC;AAElF,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,KAAK,QAAQ,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EAMlB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAEV,sBAAsB,EAEtB,2BAA2B,EAC5B,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,mBAAmB,EAAqB,MAAM,0BAA0B,CAAC;AAElF,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,KAAK,QAAQ,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAU,QAAQ,EAAE,MAAM,EAAU,MAAM,QAAQ,CAAC;AASlF,QAAA,MAAM,kCAAkC,6CAAqC,CAAC;AAC9E,MAAM,MAAM,4BAA4B,GAAG,CAAC,OAAO,kCAAkC,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/F,eAAO,MAAM,8BAA8B;;;;EAIzC,CAAC;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,OAAO,8BAA8B,CAAC,CAAC,MAAM,CAAC,CAAC;AAqDvF,MAAM,MAAM,yBAAyB,GAAG,QAAQ,CAC9C,wCAAwC,EACxC,2BAA2B,EAC3B,sBAAsB,CACvB,CAAC;AAEF,eAAO,MAAM,yBAAyB,4DAGrC,CAAC;;;;;;AACF,qBAAa,oBAAqB,SAAQ,yBAGC;CAAG;AAE9C,eAAO,MAAM,yBAAyB,GACpC,SAAS,wBAAwB,KAChC,KAAK,CAAC,KAAK,CAAC,oBAAoB,EAAE,iBAAiB,CAgBnD,CAAC;AAwWJ,eAAO,MAAM,iCAAiC,oHA4B3C,CAAC;;AAEJ,qBAAa,kBAAmB,SAAQ,uBAEvC;CAAG;AAEJ,eAAO,MAAM,SAAS,GAAI,SAAS,wBAAwB,4EAIxD,CAAC;AAEJ,eAAO,MAAM,4BAA4B,GACvC,SAAS,wBAAwB,EACjC,IAAI,MAAM,KACT,MAAM,CAAC,MAAM,CAAC,sBAAsB,EAAE,iBAAiB,EAAE,mBAAmB,CAiB3E,CAAC;AAEL,eAAO,MAAM,8BAA8B,GACzC,SAAS,wBAAwB,KAChC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,sBAAsB,CAAC,EAAE,iBAAiB,EAAE,mBAAmB,CAiB1F,CAAC;AAEL,eAAO,MAAM,+BAA+B,GAC1C,SAAS,wBAAwB,EACjC,IAAI,MAAM,KACT,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,mBAAmB,CAiBzD,CAAC;AAEL,eAAO,MAAM,+BAA+B,GAC1C,SAAS,wBAAwB,EACjC,IAAI,MAAM,KACT,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,mBAAmB,CAiBzD,CAAC;AAEL,eAAO,MAAM,+BAA+B,GAC1C,SAAS,wBAAwB,EACjC,YAAY,MAAM,KACjB,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,iBAAiB,EAAE,mBAAmB,CAiB/D,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -2,10 +2,13 @@ import { SignatureKitError, SignatureKitErrorCodeValue, SignatureKitOperationVal
|
|
|
2
2
|
import { SignatureHttpClient, normalizedBaseUrl } from "@signature-kit/core/http";
|
|
3
3
|
import { Resource } from "alchemy";
|
|
4
4
|
import * as Provider from "alchemy/Provider";
|
|
5
|
-
import { Context, Effect, Layer, Redacted, Schema } from "effect";
|
|
5
|
+
import { Context, Effect, Layer, Option, Redacted, Schema, Stream } from "effect";
|
|
6
6
|
const PROVIDER = "documenso";
|
|
7
7
|
const DOCUMENSO_PROVIDER_COLLECTION_ID = "@signature-kit/documenso/Providers";
|
|
8
8
|
const DEFAULT_BASE_URL = "https://app.documenso.com/api/v2";
|
|
9
|
+
const DOCUMENSO_LIST_FIRST_PAGE = 1;
|
|
10
|
+
const DOCUMENSO_LIST_PER_PAGE = 100;
|
|
11
|
+
const documensoPathId = (pathParam) => encodeURIComponent(pathParam);
|
|
9
12
|
const DocumensoAuthorizationSchemeSchema = Schema.Literals(["raw", "bearer"]);
|
|
10
13
|
export const DocumensoProviderOptionsSchema = Schema.Struct({
|
|
11
14
|
apiKey: redactedStringSchema,
|
|
@@ -44,9 +47,15 @@ const DocumensoEnvelopeResultSchema = Schema.Struct({
|
|
|
44
47
|
recipients: Schema.optional(Schema.Array(DocumensoEnvelopeRecipientResultSchema)),
|
|
45
48
|
envelopeItems: Schema.optional(Schema.Array(DocumensoEnvelopeItemResultSchema)),
|
|
46
49
|
});
|
|
50
|
+
const DocumensoEnvelopeListPaginationSchema = Schema.Struct({
|
|
51
|
+
page: Schema.Number,
|
|
52
|
+
perPage: Schema.Number,
|
|
53
|
+
totalPages: Schema.Number,
|
|
54
|
+
totalItems: Schema.Number,
|
|
55
|
+
});
|
|
47
56
|
const DocumensoEnvelopeListResultSchema = Schema.Struct({
|
|
48
57
|
data: Schema.Array(DocumensoEnvelopeResultSchema),
|
|
49
|
-
pagination:
|
|
58
|
+
pagination: DocumensoEnvelopeListPaginationSchema,
|
|
50
59
|
});
|
|
51
60
|
export const DocumensoSignatureRequest = Resource("SignatureKit.DocumensoSignatureRequest", { defaultRemovalPolicy: "retain" });
|
|
52
61
|
export class DocumensoCredentials extends Context.Service()("@signature-kit/documenso/Credentials") {
|
|
@@ -69,6 +78,29 @@ const requestMeta = (input) => ({
|
|
|
69
78
|
...(input.message === undefined ? {} : { message: input.message }),
|
|
70
79
|
...(input.redirectUrl === undefined ? {} : { redirectUrl: input.redirectUrl }),
|
|
71
80
|
});
|
|
81
|
+
const documensoNextPage = (pagination, currentPage) => currentPage >= pagination.totalPages ? Option.none() : Option.some(currentPage + 1);
|
|
82
|
+
const shouldSendAuthorizationToUrl = (url, baseUrl) => {
|
|
83
|
+
if (!URL.canParse(url, `${baseUrl}/`) || !URL.canParse(baseUrl))
|
|
84
|
+
return false;
|
|
85
|
+
const next = new URL(url, `${baseUrl}/`);
|
|
86
|
+
const base = new URL(baseUrl);
|
|
87
|
+
return next.origin === base.origin;
|
|
88
|
+
};
|
|
89
|
+
const requestEnvelopeSignedBytes = (http, options, baseUrl, url) => {
|
|
90
|
+
if (shouldSendAuthorizationToUrl(url, baseUrl)) {
|
|
91
|
+
return http.requestBytes({
|
|
92
|
+
provider: PROVIDER,
|
|
93
|
+
method: "GET",
|
|
94
|
+
url,
|
|
95
|
+
headers: { Authorization: documensoAuthorization(options) },
|
|
96
|
+
});
|
|
97
|
+
}
|
|
98
|
+
return http.requestBytes({
|
|
99
|
+
provider: PROVIDER,
|
|
100
|
+
method: "GET",
|
|
101
|
+
url,
|
|
102
|
+
});
|
|
103
|
+
};
|
|
72
104
|
const createEnvelopeBody = (input) => {
|
|
73
105
|
const formData = new FormData();
|
|
74
106
|
formData.append("payload", JSON.stringify({
|
|
@@ -108,7 +140,7 @@ const distributeEnvelope = (http, options, baseUrl, input, envelope) => http
|
|
|
108
140
|
id: result.id,
|
|
109
141
|
state: "sent",
|
|
110
142
|
providerStatus: result.success ? "distributed" : "not_distributed",
|
|
111
|
-
detailsUrl: `${baseUrl}/envelope/${result.id}`,
|
|
143
|
+
detailsUrl: `${baseUrl}/envelope/${documensoPathId(result.id)}`,
|
|
112
144
|
...(result.recipients[0]?.signingUrl === undefined
|
|
113
145
|
? {}
|
|
114
146
|
: { signingUrl: result.recipients[0].signingUrl }),
|
|
@@ -121,7 +153,9 @@ const mapEnvelopeStatus = (status) => {
|
|
|
121
153
|
case "PROCESSING":
|
|
122
154
|
case "SENT":
|
|
123
155
|
return "sent";
|
|
156
|
+
case "SIGNED":
|
|
124
157
|
case "COMPLETED":
|
|
158
|
+
case "CLOSED":
|
|
125
159
|
return "completed";
|
|
126
160
|
case "REJECTED":
|
|
127
161
|
case "DECLINED":
|
|
@@ -138,7 +172,8 @@ const mapEnvelopeStatus = (status) => {
|
|
|
138
172
|
}
|
|
139
173
|
};
|
|
140
174
|
const envelopeSignedDownloadUrl = (baseUrl, envelopeItemId) => {
|
|
141
|
-
const
|
|
175
|
+
const encodedItemId = documensoPathId(envelopeItemId);
|
|
176
|
+
const url = new URL(`${baseUrl}/envelope/item/${encodedItemId}/download`);
|
|
142
177
|
url.searchParams.set("version", "signed");
|
|
143
178
|
return url.toString();
|
|
144
179
|
};
|
|
@@ -156,27 +191,36 @@ const mapEnvelopeToRemoteRequest = (baseUrl, envelope) => {
|
|
|
156
191
|
id: envelope.id,
|
|
157
192
|
state: mapEnvelopeStatus(envelope.status),
|
|
158
193
|
providerStatus: envelope.status,
|
|
159
|
-
detailsUrl: `${baseUrl}/envelope/${envelope.id}`,
|
|
194
|
+
detailsUrl: `${baseUrl}/envelope/${documensoPathId(envelope.id)}`,
|
|
160
195
|
...(signingUrl === undefined ? {} : { signingUrl }),
|
|
161
196
|
...(downloadUrl === undefined ? {} : { downloadUrl }),
|
|
162
197
|
};
|
|
163
198
|
};
|
|
164
|
-
const
|
|
165
|
-
.requestJson({
|
|
199
|
+
const fetchEnvelopeResult = (http, options, baseUrl, id) => http.requestJson({
|
|
166
200
|
provider: PROVIDER,
|
|
167
201
|
method: "GET",
|
|
168
|
-
url: `${baseUrl}/envelope/${id}`,
|
|
202
|
+
url: `${baseUrl}/envelope/${documensoPathId(id)}`,
|
|
169
203
|
headers: { Authorization: documensoAuthorization(options) },
|
|
170
|
-
}, DocumensoEnvelopeResultSchema, SignatureKitSchemaNameValue.documensoEnvelopeResult)
|
|
171
|
-
|
|
172
|
-
const listEnvelopes = (http, options, baseUrl) =>
|
|
173
|
-
.
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
204
|
+
}, DocumensoEnvelopeResultSchema, SignatureKitSchemaNameValue.documensoEnvelopeResult);
|
|
205
|
+
const getEnvelope = (http, options, baseUrl, id) => fetchEnvelopeResult(http, options, baseUrl, id).pipe(Effect.map((result) => mapEnvelopeToRemoteRequest(baseUrl, result)));
|
|
206
|
+
const listEnvelopes = (http, options, baseUrl) => {
|
|
207
|
+
return Stream.paginate(DOCUMENSO_LIST_FIRST_PAGE, (page) => {
|
|
208
|
+
const url = new URL(`${baseUrl}/envelope`);
|
|
209
|
+
url.searchParams.set("page", String(page));
|
|
210
|
+
url.searchParams.set("perPage", String(DOCUMENSO_LIST_PER_PAGE));
|
|
211
|
+
return http
|
|
212
|
+
.requestJson({
|
|
213
|
+
provider: PROVIDER,
|
|
214
|
+
method: "GET",
|
|
215
|
+
url: url.toString(),
|
|
216
|
+
headers: { Authorization: documensoAuthorization(options) },
|
|
217
|
+
}, DocumensoEnvelopeListResultSchema, SignatureKitSchemaNameValue.documensoEnvelopeListResult)
|
|
218
|
+
.pipe(Effect.map((result) => [
|
|
219
|
+
result.data.map((envelope) => mapEnvelopeToRemoteRequest(baseUrl, envelope)),
|
|
220
|
+
documensoNextPage(result.pagination, page),
|
|
221
|
+
]));
|
|
222
|
+
}).pipe(Stream.runCollect, Effect.map((requests) => requests.flat()));
|
|
223
|
+
};
|
|
180
224
|
const cancelEnvelope = (http, options, baseUrl, envelopeId) => http.requestVoid({
|
|
181
225
|
provider: PROVIDER,
|
|
182
226
|
method: "POST",
|
|
@@ -200,33 +244,38 @@ const deleteEnvelope = (http, options, baseUrl, envelopeId) => http
|
|
|
200
244
|
})
|
|
201
245
|
.pipe(Effect.catchIf((error) => error.code === SignatureKitErrorCodeValue.http && error.status === 404, () => Effect.void));
|
|
202
246
|
const downloadSignedEnvelopeItem = (http, options, baseUrl, envelopeItemId) => {
|
|
203
|
-
const
|
|
247
|
+
const encodedItemId = documensoPathId(envelopeItemId);
|
|
248
|
+
const url = new URL(`${baseUrl}/envelope/item/${encodedItemId}/download`);
|
|
204
249
|
url.searchParams.set("version", "signed");
|
|
205
|
-
return http.
|
|
206
|
-
provider: PROVIDER,
|
|
207
|
-
method: "GET",
|
|
208
|
-
url: url.toString(),
|
|
209
|
-
headers: { Authorization: documensoAuthorization(options) },
|
|
210
|
-
});
|
|
250
|
+
return requestEnvelopeSignedBytes(http, options, baseUrl, url.toString());
|
|
211
251
|
};
|
|
212
|
-
const downloadSignedEnvelopeDocument = (http, options, baseUrl, envelopeId) =>
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
252
|
+
const downloadSignedEnvelopeDocument = (http, options, baseUrl, envelopeId) => fetchEnvelopeResult(http, options, baseUrl, envelopeId).pipe(Effect.flatMap((envelope) => {
|
|
253
|
+
const downloadUrl = envelopeSignedDownloadUrlFromEnvelope(baseUrl, envelope);
|
|
254
|
+
if (downloadUrl !== undefined) {
|
|
255
|
+
return requestEnvelopeSignedBytes(http, options, baseUrl, downloadUrl);
|
|
256
|
+
}
|
|
257
|
+
if (envelope.envelopeItems?.[0]?.id === undefined) {
|
|
258
|
+
return Effect.fail(new SignatureKitError({
|
|
259
|
+
code: SignatureKitErrorCodeValue.responseShape,
|
|
260
|
+
retryable: false,
|
|
261
|
+
provider: PROVIDER,
|
|
262
|
+
operation: SignatureKitOperationValue.remoteDownload,
|
|
263
|
+
reason: `Documenso envelope ${envelopeId} has no downloadable item ID.`,
|
|
264
|
+
}));
|
|
265
|
+
}
|
|
266
|
+
return downloadSignedEnvelopeItem(http, options, baseUrl, envelope.envelopeItems[0].id);
|
|
267
|
+
}));
|
|
220
268
|
const createRemoteRequest = (http, options, baseUrl, input) => createEnvelope(http, options, baseUrl, input).pipe(Effect.flatMap((envelope) => {
|
|
221
|
-
if (input.send
|
|
222
|
-
return
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
}
|
|
269
|
+
if (input.send === false) {
|
|
270
|
+
return Effect.succeed({
|
|
271
|
+
provider: PROVIDER,
|
|
272
|
+
id: envelope.id,
|
|
273
|
+
state: "draft",
|
|
274
|
+
providerStatus: "DRAFT",
|
|
275
|
+
detailsUrl: `${baseUrl}/envelope/${documensoPathId(envelope.id)}`,
|
|
276
|
+
});
|
|
277
|
+
}
|
|
278
|
+
return distributeEnvelope(http, options, baseUrl, input, envelope).pipe(Effect.catch((error) => deleteEnvelope(http, options, baseUrl, envelope.id).pipe(Effect.catch(() => Effect.void), Effect.flatMap(() => Effect.fail(error)))));
|
|
230
279
|
}));
|
|
231
280
|
export const DocumensoSignatureRequestProvider = () => Provider.effect(DocumensoSignatureRequest, Effect.gen(function* () {
|
|
232
281
|
const options = yield* DocumensoCredentials;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@signature-kit/documenso",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"files": [
|
|
6
6
|
"dist",
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
"test": "vitest run"
|
|
28
28
|
},
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@signature-kit/core": "^0.
|
|
30
|
+
"@signature-kit/core": "^0.2.0",
|
|
31
31
|
"alchemy": "2.0.0-beta.57",
|
|
32
32
|
"effect": "4.0.0-beta.86"
|
|
33
33
|
},
|