@deliverd/sdk 0.6.1 → 0.7.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/README.md +67 -2
- package/dist/approvals.d.ts +12 -0
- package/dist/approvals.d.ts.map +1 -1
- package/dist/approvals.js +33 -4
- package/dist/collections.d.ts +10 -0
- package/dist/collections.d.ts.map +1 -1
- package/dist/collections.js +18 -3
- package/dist/dev.d.ts.map +1 -1
- package/dist/dev.js +16 -3
- package/dist/flows.d.ts +10 -0
- package/dist/flows.d.ts.map +1 -1
- package/dist/flows.js +18 -3
- package/dist/index.d.ts +3 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4 -2
- package/dist/messages.d.ts.map +1 -1
- package/dist/messages.js +8 -4
- package/dist/paging.d.ts +43 -0
- package/dist/paging.d.ts.map +1 -0
- package/dist/paging.js +27 -0
- package/dist/released.d.ts +29 -0
- package/dist/released.d.ts.map +1 -0
- package/dist/released.js +402 -0
- package/dist/reports.d.ts +152 -4
- package/dist/reports.d.ts.map +1 -1
- package/dist/reports.js +209 -10
- package/dist/reviews.d.ts +10 -0
- package/dist/reviews.d.ts.map +1 -1
- package/dist/reviews.js +18 -8
- package/dist/types.d.ts +147 -3
- package/dist/types.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/approvals.ts +40 -4
- package/src/collections.ts +25 -3
- package/src/dev.ts +16 -3
- package/src/flows.ts +25 -3
- package/src/index.ts +4 -2
- package/src/messages.ts +8 -4
- package/src/paging.ts +64 -0
- package/src/released.ts +403 -0
- package/src/reports.ts +268 -12
- package/src/reviews.ts +25 -8
- package/src/types.ts +155 -3
package/src/released.ts
ADDED
|
@@ -0,0 +1,403 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* What each published version of `@deliverd/sdk` actually offers.
|
|
3
|
+
*
|
|
4
|
+
* Written after the package drifted **thirteen commits and fifty-four public
|
|
5
|
+
* surface items** ahead of what npm was serving, under a version number that
|
|
6
|
+
* had already been published. Among them `decidedById` — the field the
|
|
7
|
+
* decision-names-the-person correction added — and the whole `Schedules`
|
|
8
|
+
* namespace, so `docs/api.md` and this repository's own readiness notes
|
|
9
|
+
* described an SDK nobody could install.
|
|
10
|
+
*
|
|
11
|
+
* `release.test.ts` already proves what a tarball *contains*; its own header
|
|
12
|
+
* says the one thing it cannot know is the version number, because the
|
|
13
|
+
* registry is not reachable from a test. This is that missing half, and it is
|
|
14
|
+
* the same device the CLI got after 0.3.0 shipped three commands short:
|
|
15
|
+
* a ledger the source is held against, so adding to the surface fails until
|
|
16
|
+
* somebody records which version carries it.
|
|
17
|
+
*
|
|
18
|
+
* **The rule:** every entry in `SURFACE` below is an item a caller can reach —
|
|
19
|
+
* an export, a field of an exported type, or a webhook event name. The guard
|
|
20
|
+
* computes the same set from source and refuses a mismatch. Adding a field
|
|
21
|
+
* therefore forces a version bump, which is correct: a package that describes
|
|
22
|
+
* something new is a package somebody has to install to get.
|
|
23
|
+
*
|
|
24
|
+
* 0.6.2 and earlier predate this ledger and are not recorded. Reconstructing
|
|
25
|
+
* them would mean asserting a surface nobody checked at the time, which is the
|
|
26
|
+
* kind of entry that reads like a fact and is a guess.
|
|
27
|
+
*/
|
|
28
|
+
|
|
29
|
+
export const RELEASED: Record<string, readonly string[]> = {
|
|
30
|
+
/*
|
|
31
|
+
* The first recorded surface, and a minor rather than a patch.
|
|
32
|
+
*
|
|
33
|
+
* Fifty-four additions over the published 0.6.2 and nothing removed, so
|
|
34
|
+
* nothing a caller wrote against 0.6.2 stops compiling. See CHANGELOG.md —
|
|
35
|
+
* and note the `decidedBy` correction there, which changes what an existing
|
|
36
|
+
* field *contains* without changing this list.
|
|
37
|
+
*/
|
|
38
|
+
"0.7.0": [
|
|
39
|
+
"Approval",
|
|
40
|
+
"ApprovalData.approvalsSoFar",
|
|
41
|
+
"ApprovalData.approvers",
|
|
42
|
+
"ApprovalData.createdAt",
|
|
43
|
+
"ApprovalData.decidedAt",
|
|
44
|
+
"ApprovalData.decidedBy",
|
|
45
|
+
"ApprovalData.decidedById",
|
|
46
|
+
"ApprovalData.description",
|
|
47
|
+
"ApprovalData.expiresAt",
|
|
48
|
+
"ApprovalData.externalId",
|
|
49
|
+
"ApprovalData.factors",
|
|
50
|
+
"ApprovalData.id",
|
|
51
|
+
"ApprovalData.links",
|
|
52
|
+
"ApprovalData.metadata",
|
|
53
|
+
"ApprovalData.note",
|
|
54
|
+
"ApprovalData.questions",
|
|
55
|
+
"ApprovalData.reportId",
|
|
56
|
+
"ApprovalData.requestedBy",
|
|
57
|
+
"ApprovalData.requiredApprovals",
|
|
58
|
+
"ApprovalData.risk",
|
|
59
|
+
"ApprovalData.status",
|
|
60
|
+
"ApprovalData.title",
|
|
61
|
+
"ApprovalData.url",
|
|
62
|
+
"ApprovalFactor.detail",
|
|
63
|
+
"ApprovalFactor.label",
|
|
64
|
+
"ApprovalFactor.status",
|
|
65
|
+
"ApprovalLink.label",
|
|
66
|
+
"ApprovalLink.url",
|
|
67
|
+
"ApprovalQuestion.answer",
|
|
68
|
+
"ApprovalQuestion.answeredAt",
|
|
69
|
+
"ApprovalQuestion.askedAt",
|
|
70
|
+
"ApprovalQuestion.id",
|
|
71
|
+
"ApprovalQuestion.question",
|
|
72
|
+
"Approvals",
|
|
73
|
+
"ApproveOptions",
|
|
74
|
+
"ClientOptions",
|
|
75
|
+
"CollectOptions",
|
|
76
|
+
"CollectWaitOptions",
|
|
77
|
+
"CollectedAnswers.answers",
|
|
78
|
+
"CollectedAnswers.collection",
|
|
79
|
+
"CollectedAnswers.complete",
|
|
80
|
+
"CollectedAnswers.id",
|
|
81
|
+
"CollectedAnswers.responses",
|
|
82
|
+
"CollectedAnswers.status",
|
|
83
|
+
"CollectedAnswers.url",
|
|
84
|
+
"Collection",
|
|
85
|
+
"CollectionData.askedCount",
|
|
86
|
+
"CollectionData.createdAt",
|
|
87
|
+
"CollectionData.dueAt",
|
|
88
|
+
"CollectionData.expiresAt",
|
|
89
|
+
"CollectionData.externalId",
|
|
90
|
+
"CollectionData.id",
|
|
91
|
+
"CollectionData.instructions",
|
|
92
|
+
"CollectionData.metadata",
|
|
93
|
+
"CollectionData.questions",
|
|
94
|
+
"CollectionData.reportId",
|
|
95
|
+
"CollectionData.requestedBy",
|
|
96
|
+
"CollectionData.requiredResponses",
|
|
97
|
+
"CollectionData.responses",
|
|
98
|
+
"CollectionData.settledAt",
|
|
99
|
+
"CollectionData.status",
|
|
100
|
+
"CollectionData.submittedCount",
|
|
101
|
+
"CollectionData.title",
|
|
102
|
+
"CollectionData.url",
|
|
103
|
+
"CollectionQuestion.help",
|
|
104
|
+
"CollectionQuestion.id",
|
|
105
|
+
"CollectionQuestion.kind",
|
|
106
|
+
"CollectionQuestion.options",
|
|
107
|
+
"CollectionQuestion.prompt",
|
|
108
|
+
"CollectionQuestion.required",
|
|
109
|
+
"CollectionReply.answers",
|
|
110
|
+
"CollectionReply.respondent",
|
|
111
|
+
"CollectionReply.status",
|
|
112
|
+
"CollectionReply.submittedAt",
|
|
113
|
+
"Collections",
|
|
114
|
+
"CommentThread.messages",
|
|
115
|
+
"CommentThread.quote",
|
|
116
|
+
"CommentThread.status",
|
|
117
|
+
"CommentThread.threadId",
|
|
118
|
+
"Comments",
|
|
119
|
+
"CreateApprovalInput.approvers",
|
|
120
|
+
"CreateApprovalInput.description",
|
|
121
|
+
"CreateApprovalInput.expiresAt",
|
|
122
|
+
"CreateApprovalInput.externalId",
|
|
123
|
+
"CreateApprovalInput.factors",
|
|
124
|
+
"CreateApprovalInput.flowId",
|
|
125
|
+
"CreateApprovalInput.links",
|
|
126
|
+
"CreateApprovalInput.metadata",
|
|
127
|
+
"CreateApprovalInput.reportId",
|
|
128
|
+
"CreateApprovalInput.risk",
|
|
129
|
+
"CreateApprovalInput.title",
|
|
130
|
+
"CreateCollectionInput.dueAt",
|
|
131
|
+
"CreateCollectionInput.expiresAt",
|
|
132
|
+
"CreateCollectionInput.externalId",
|
|
133
|
+
"CreateCollectionInput.flowId",
|
|
134
|
+
"CreateCollectionInput.instructions",
|
|
135
|
+
"CreateCollectionInput.metadata",
|
|
136
|
+
"CreateCollectionInput.questions",
|
|
137
|
+
"CreateCollectionInput.reportId",
|
|
138
|
+
"CreateCollectionInput.requiredResponses",
|
|
139
|
+
"CreateCollectionInput.respondents",
|
|
140
|
+
"CreateCollectionInput.title",
|
|
141
|
+
"CreateFlowInput.description",
|
|
142
|
+
"CreateFlowInput.externalId",
|
|
143
|
+
"CreateFlowInput.metadata",
|
|
144
|
+
"CreateFlowInput.title",
|
|
145
|
+
"CreateFlowInput.workspaceId",
|
|
146
|
+
"CreateReviewInput.expiresAt",
|
|
147
|
+
"CreateReviewInput.externalId",
|
|
148
|
+
"CreateReviewInput.flowId",
|
|
149
|
+
"CreateReviewInput.instructions",
|
|
150
|
+
"CreateReviewInput.metadata",
|
|
151
|
+
"CreateReviewInput.reportId",
|
|
152
|
+
"CreateReviewInput.requiredApprovals",
|
|
153
|
+
"CreateReviewInput.reviewers",
|
|
154
|
+
"CreateReviewInput.title",
|
|
155
|
+
"CreateReviewInput.versionId",
|
|
156
|
+
"DEFAULT_BASE_URL",
|
|
157
|
+
"DEFAULT_EXPIRY",
|
|
158
|
+
"DELIVERY_HEADER",
|
|
159
|
+
"Decision.approval",
|
|
160
|
+
"Decision.approved",
|
|
161
|
+
"Decision.decidedAt",
|
|
162
|
+
"Decision.decidedBy",
|
|
163
|
+
"Decision.decidedById",
|
|
164
|
+
"Decision.id",
|
|
165
|
+
"Decision.note",
|
|
166
|
+
"Decision.status",
|
|
167
|
+
"Decision.url",
|
|
168
|
+
"Deliverd",
|
|
169
|
+
"DeliverdError",
|
|
170
|
+
"DeliverdOptions",
|
|
171
|
+
"DeliverdTimeoutError",
|
|
172
|
+
"Duration",
|
|
173
|
+
"EVENT_HEADER",
|
|
174
|
+
"EvidenceEvent.actor",
|
|
175
|
+
"EvidenceEvent.actorType",
|
|
176
|
+
"EvidenceEvent.at",
|
|
177
|
+
"EvidenceEvent.event",
|
|
178
|
+
"EvidenceEvent.metadata",
|
|
179
|
+
"EvidenceEvent.step",
|
|
180
|
+
"EvidenceOutcome.at",
|
|
181
|
+
"EvidenceOutcome.note",
|
|
182
|
+
"EvidenceOutcome.said",
|
|
183
|
+
"EvidenceOutcome.who",
|
|
184
|
+
"EvidencePack.generatedAt",
|
|
185
|
+
"EvidencePack.generatedBy",
|
|
186
|
+
"EvidencePack.integrity",
|
|
187
|
+
"EvidencePack.organisation",
|
|
188
|
+
"EvidencePack.packVersion",
|
|
189
|
+
"EvidencePack.steps",
|
|
190
|
+
"EvidencePack.subject",
|
|
191
|
+
"EvidencePack.summary",
|
|
192
|
+
"EvidencePack.timeline",
|
|
193
|
+
"EvidenceStep.asked",
|
|
194
|
+
"EvidenceStep.createdAt",
|
|
195
|
+
"EvidenceStep.detail",
|
|
196
|
+
"EvidenceStep.id",
|
|
197
|
+
"EvidenceStep.kind",
|
|
198
|
+
"EvidenceStep.outcomes",
|
|
199
|
+
"EvidenceStep.requestedBy",
|
|
200
|
+
"EvidenceStep.requestedByAgent",
|
|
201
|
+
"EvidenceStep.settledAt",
|
|
202
|
+
"EvidenceStep.status",
|
|
203
|
+
"EvidenceStep.title",
|
|
204
|
+
"EvidenceStep.url",
|
|
205
|
+
"Flow",
|
|
206
|
+
"FlowData.allSettled",
|
|
207
|
+
"FlowData.createdAt",
|
|
208
|
+
"FlowData.description",
|
|
209
|
+
"FlowData.externalId",
|
|
210
|
+
"FlowData.id",
|
|
211
|
+
"FlowData.memberCount",
|
|
212
|
+
"FlowData.members",
|
|
213
|
+
"FlowData.metadata",
|
|
214
|
+
"FlowData.openCount",
|
|
215
|
+
"FlowData.settledAt",
|
|
216
|
+
"FlowData.startedBy",
|
|
217
|
+
"FlowData.status",
|
|
218
|
+
"FlowData.timeline",
|
|
219
|
+
"FlowData.title",
|
|
220
|
+
"FlowData.url",
|
|
221
|
+
"FlowEvent.actor",
|
|
222
|
+
"FlowEvent.actorType",
|
|
223
|
+
"FlowEvent.at",
|
|
224
|
+
"FlowEvent.event",
|
|
225
|
+
"FlowEvent.resourceId",
|
|
226
|
+
"FlowEvent.resourceType",
|
|
227
|
+
"FlowMember.createdAt",
|
|
228
|
+
"FlowMember.id",
|
|
229
|
+
"FlowMember.kind",
|
|
230
|
+
"FlowMember.open",
|
|
231
|
+
"FlowMember.status",
|
|
232
|
+
"FlowMember.title",
|
|
233
|
+
"FlowPrimitives",
|
|
234
|
+
"Flows",
|
|
235
|
+
"InlineFile.content",
|
|
236
|
+
"InlineFile.encoding",
|
|
237
|
+
"InlineFile.path",
|
|
238
|
+
"ListApprovalsInput.cursor",
|
|
239
|
+
"ListApprovalsInput.externalId",
|
|
240
|
+
"ListApprovalsInput.limit",
|
|
241
|
+
"ListApprovalsInput.status",
|
|
242
|
+
"ListCollectionsInput.cursor",
|
|
243
|
+
"ListCollectionsInput.externalId",
|
|
244
|
+
"ListCollectionsInput.limit",
|
|
245
|
+
"ListCollectionsInput.status",
|
|
246
|
+
"ListFlowsInput.cursor",
|
|
247
|
+
"ListFlowsInput.externalId",
|
|
248
|
+
"ListFlowsInput.limit",
|
|
249
|
+
"ListFlowsInput.status",
|
|
250
|
+
"ListReviewsInput.cursor",
|
|
251
|
+
"ListReviewsInput.externalId",
|
|
252
|
+
"ListReviewsInput.limit",
|
|
253
|
+
"ListReviewsInput.reportId",
|
|
254
|
+
"ListReviewsInput.status",
|
|
255
|
+
"OpenThread.author",
|
|
256
|
+
"OpenThread.authorType",
|
|
257
|
+
"OpenThread.lastActivityAt",
|
|
258
|
+
"OpenThread.messages",
|
|
259
|
+
"OpenThread.quote",
|
|
260
|
+
"OpenThread.reportId",
|
|
261
|
+
"OpenThread.reportOwnerId",
|
|
262
|
+
"OpenThread.reportSlug",
|
|
263
|
+
"OpenThread.reportTitle",
|
|
264
|
+
"OpenThread.threadId",
|
|
265
|
+
"OrgAnalytics.activeReports",
|
|
266
|
+
"OrgAnalytics.days",
|
|
267
|
+
"OrgAnalytics.externallySharedReports",
|
|
268
|
+
"OrgAnalytics.inactiveReports",
|
|
269
|
+
"OrgAnalytics.publicReports",
|
|
270
|
+
"OrgAnalytics.publishesInPeriod",
|
|
271
|
+
"OrgAnalytics.topReports",
|
|
272
|
+
"OrgAnalytics.totalViews",
|
|
273
|
+
"OrgAnalytics.uniqueViewers",
|
|
274
|
+
"POLL_SCHEDULE",
|
|
275
|
+
"PublishReportInput.audience",
|
|
276
|
+
"PublishReportInput.changeSummary",
|
|
277
|
+
"PublishReportInput.classification",
|
|
278
|
+
"PublishReportInput.content",
|
|
279
|
+
"PublishReportInput.description",
|
|
280
|
+
"PublishReportInput.expectedVersion",
|
|
281
|
+
"PublishReportInput.files",
|
|
282
|
+
"PublishReportInput.living",
|
|
283
|
+
"PublishReportInput.slug",
|
|
284
|
+
"PublishReportInput.sourceModel",
|
|
285
|
+
"PublishReportInput.sourceTool",
|
|
286
|
+
"PublishReportInput.title",
|
|
287
|
+
"PublishReportInput.uploadId",
|
|
288
|
+
"PublishReportInput.workspaceId",
|
|
289
|
+
"PublishResult.approval",
|
|
290
|
+
"PublishResult.report",
|
|
291
|
+
"PublishResult.status",
|
|
292
|
+
"PublishResult.version",
|
|
293
|
+
"PublishResult.warnings",
|
|
294
|
+
"QuestionInput.help",
|
|
295
|
+
"QuestionInput.kind",
|
|
296
|
+
"QuestionInput.options",
|
|
297
|
+
"QuestionInput.prompt",
|
|
298
|
+
"QuestionInput.required",
|
|
299
|
+
"ReportAnalytics.byDay",
|
|
300
|
+
"ReportAnalytics.byVersion",
|
|
301
|
+
"ReportAnalytics.externalViewers",
|
|
302
|
+
"ReportAnalytics.firstViewedAt",
|
|
303
|
+
"ReportAnalytics.internalViewers",
|
|
304
|
+
"ReportAnalytics.lastViewedAt",
|
|
305
|
+
"ReportAnalytics.recentViewers",
|
|
306
|
+
"ReportAnalytics.reportId",
|
|
307
|
+
"ReportAnalytics.title",
|
|
308
|
+
"ReportAnalytics.totalViews",
|
|
309
|
+
"ReportAnalytics.uniqueViewers",
|
|
310
|
+
"ReportData.currentVersion",
|
|
311
|
+
"ReportData.id",
|
|
312
|
+
"ReportData.slug",
|
|
313
|
+
"ReportData.status",
|
|
314
|
+
"ReportData.title",
|
|
315
|
+
"ReportData.url",
|
|
316
|
+
"Reports",
|
|
317
|
+
"Review",
|
|
318
|
+
"ReviewData.createdAt",
|
|
319
|
+
"ReviewData.expiresAt",
|
|
320
|
+
"ReviewData.externalId",
|
|
321
|
+
"ReviewData.id",
|
|
322
|
+
"ReviewData.instructions",
|
|
323
|
+
"ReviewData.metadata",
|
|
324
|
+
"ReviewData.reportId",
|
|
325
|
+
"ReviewData.requestedBy",
|
|
326
|
+
"ReviewData.requiredApprovals",
|
|
327
|
+
"ReviewData.reviewers",
|
|
328
|
+
"ReviewData.settledAt",
|
|
329
|
+
"ReviewData.status",
|
|
330
|
+
"ReviewData.threadCount",
|
|
331
|
+
"ReviewData.title",
|
|
332
|
+
"ReviewData.url",
|
|
333
|
+
"ReviewData.verdicts",
|
|
334
|
+
"ReviewData.versionId",
|
|
335
|
+
"ReviewOptions",
|
|
336
|
+
"ReviewOutcome.approved",
|
|
337
|
+
"ReviewOutcome.id",
|
|
338
|
+
"ReviewOutcome.review",
|
|
339
|
+
"ReviewOutcome.status",
|
|
340
|
+
"ReviewOutcome.threadCount",
|
|
341
|
+
"ReviewOutcome.url",
|
|
342
|
+
"ReviewOutcome.verdicts",
|
|
343
|
+
"ReviewVerdict.at",
|
|
344
|
+
"ReviewVerdict.by",
|
|
345
|
+
"ReviewVerdict.note",
|
|
346
|
+
"ReviewVerdict.verdict",
|
|
347
|
+
"ReviewWaitOptions",
|
|
348
|
+
"ReviewerRef.id",
|
|
349
|
+
"ReviewerRef.kind",
|
|
350
|
+
"ReviewerRef.label",
|
|
351
|
+
"Reviews",
|
|
352
|
+
"SIGNATURE_HEADER",
|
|
353
|
+
"ScheduleSummary.agentId",
|
|
354
|
+
"ScheduleSummary.agentName",
|
|
355
|
+
"ScheduleSummary.currentVersion",
|
|
356
|
+
"ScheduleSummary.due",
|
|
357
|
+
"ScheduleSummary.dueSince",
|
|
358
|
+
"ScheduleSummary.enabled",
|
|
359
|
+
"ScheduleSummary.id",
|
|
360
|
+
"ScheduleSummary.lastRunAt",
|
|
361
|
+
"ScheduleSummary.nextRunAt",
|
|
362
|
+
"ScheduleSummary.recurrence",
|
|
363
|
+
"ScheduleSummary.reportId",
|
|
364
|
+
"ScheduleSummary.reportSlug",
|
|
365
|
+
"ScheduleSummary.reportTitle",
|
|
366
|
+
"ScheduleSummary.reportUrl",
|
|
367
|
+
"Schedules",
|
|
368
|
+
"SendResult.alreadyHadAccess",
|
|
369
|
+
"SendResult.sent",
|
|
370
|
+
"TOLERANCE_SECONDS",
|
|
371
|
+
"WaitOptions",
|
|
372
|
+
"WebhookEvent.data",
|
|
373
|
+
"WebhookEvent.event",
|
|
374
|
+
"WebhookEvent.sentAt",
|
|
375
|
+
"WebhookEvent.test",
|
|
376
|
+
"Webhooks",
|
|
377
|
+
"constructEvent",
|
|
378
|
+
"deliverd",
|
|
379
|
+
"durationMs",
|
|
380
|
+
"event:access.requested",
|
|
381
|
+
"event:approval.answered",
|
|
382
|
+
"event:approval.approved",
|
|
383
|
+
"event:approval.escalated",
|
|
384
|
+
"event:approval.expired",
|
|
385
|
+
"event:approval.question",
|
|
386
|
+
"event:approval.rejected",
|
|
387
|
+
"event:approval.requested",
|
|
388
|
+
"event:collection.completed",
|
|
389
|
+
"event:collection.requested",
|
|
390
|
+
"event:comment.created",
|
|
391
|
+
"event:flow.completed",
|
|
392
|
+
"event:publish.held",
|
|
393
|
+
"event:report.published",
|
|
394
|
+
"event:report.shared",
|
|
395
|
+
"event:report.updated",
|
|
396
|
+
"event:report.viewed",
|
|
397
|
+
"event:review.approved",
|
|
398
|
+
"event:review.changes_requested",
|
|
399
|
+
"event:review.requested",
|
|
400
|
+
"event:schedule.due",
|
|
401
|
+
"verifySignature",
|
|
402
|
+
],
|
|
403
|
+
};
|