@deliverd/sdk 0.8.2 → 0.9.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.
Files changed (68) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +654 -562
  3. package/dist/adapters/ai-sdk.d.ts +48 -0
  4. package/dist/adapters/ai-sdk.d.ts.map +1 -0
  5. package/dist/adapters/ai-sdk.js +12 -0
  6. package/dist/adapters/claude-agent-sdk.d.ts +55 -0
  7. package/dist/adapters/claude-agent-sdk.d.ts.map +1 -0
  8. package/dist/adapters/claude-agent-sdk.js +24 -0
  9. package/dist/adapters/index.d.ts +19 -0
  10. package/dist/adapters/index.d.ts.map +1 -0
  11. package/dist/adapters/index.js +13 -0
  12. package/dist/adapters/langgraph.d.ts +145 -0
  13. package/dist/adapters/langgraph.d.ts.map +1 -0
  14. package/dist/adapters/langgraph.js +69 -0
  15. package/dist/adapters/openai-agents.d.ts +68 -0
  16. package/dist/adapters/openai-agents.d.ts.map +1 -0
  17. package/dist/adapters/openai-agents.js +55 -0
  18. package/dist/adapters/shared.d.ts +91 -0
  19. package/dist/adapters/shared.d.ts.map +1 -0
  20. package/dist/adapters/shared.js +98 -0
  21. package/dist/approvals.d.ts +15 -1
  22. package/dist/approvals.d.ts.map +1 -1
  23. package/dist/approvals.js +19 -1
  24. package/dist/collections.d.ts +8 -0
  25. package/dist/collections.d.ts.map +1 -1
  26. package/dist/collections.js +11 -1
  27. package/dist/dev.d.ts +6 -0
  28. package/dist/dev.d.ts.map +1 -1
  29. package/dist/dev.js +11 -0
  30. package/dist/gates.d.ts.map +1 -1
  31. package/dist/gates.js +1 -0
  32. package/dist/index.d.ts +1 -1
  33. package/dist/index.d.ts.map +1 -1
  34. package/dist/index.js +1 -1
  35. package/dist/released.d.ts +1 -1
  36. package/dist/released.d.ts.map +1 -1
  37. package/dist/released.js +451 -0
  38. package/dist/reviews.d.ts +8 -0
  39. package/dist/reviews.d.ts.map +1 -1
  40. package/dist/reviews.js +11 -1
  41. package/dist/types.d.ts +73 -1
  42. package/dist/types.d.ts.map +1 -1
  43. package/dist/webhooks.d.ts +15 -1
  44. package/dist/webhooks.d.ts.map +1 -1
  45. package/dist/webhooks.js +13 -0
  46. package/package.json +59 -55
  47. package/src/adapters/ai-sdk.ts +59 -0
  48. package/src/adapters/claude-agent-sdk.ts +90 -0
  49. package/src/adapters/index.ts +23 -0
  50. package/src/adapters/langgraph.ts +202 -0
  51. package/src/adapters/openai-agents.ts +112 -0
  52. package/src/adapters/shared.ts +179 -0
  53. package/src/approvals.ts +342 -322
  54. package/src/collections.ts +247 -236
  55. package/src/dev.ts +780 -761
  56. package/src/duration.ts +21 -21
  57. package/src/errors.ts +62 -62
  58. package/src/flows.ts +222 -222
  59. package/src/gates.ts +231 -230
  60. package/src/http.ts +217 -217
  61. package/src/index.ts +444 -443
  62. package/src/messages.ts +161 -161
  63. package/src/paging.ts +64 -64
  64. package/src/released.ts +2523 -2072
  65. package/src/reports.ts +490 -490
  66. package/src/reviews.ts +236 -225
  67. package/src/types.ts +921 -838
  68. package/src/webhooks.ts +117 -98
package/dist/released.js CHANGED
@@ -56,6 +56,7 @@ export const PUBLISHED_TO_NPM = [
56
56
  "0.7.1",
57
57
  "0.8.0",
58
58
  "0.8.1",
59
+ "0.8.2",
59
60
  ];
60
61
  /**
61
62
  * A fingerprint of what each *published* version recorded.
@@ -88,6 +89,13 @@ export const FROZEN = {
88
89
  * behaviour and no surface moved, which is why the digest repeats.
89
90
  */
90
91
  "0.8.1": "823add1135c7a4b5a9245e3019c28d95c6010071f6c38bed0fa27b37f7def4ec",
92
+ /*
93
+ * The third in a row, and for the plainest reason yet: 0.8.2 changed what
94
+ * ten errors *say* and added no export, which is exactly what the digest
95
+ * is computed over. 395 items, the same 395. The changelog is where a
96
+ * reader finds out anything moved at all.
97
+ */
98
+ "0.8.2": "823add1135c7a4b5a9245e3019c28d95c6010071f6c38bed0fa27b37f7def4ec",
91
99
  };
92
100
  export const RELEASED = {
93
101
  /*
@@ -2064,4 +2072,447 @@ export const RELEASED = {
2064
2072
  "event:schedule.due",
2065
2073
  "verifySignature",
2066
2074
  ],
2075
+ "0.9.0": [
2076
+ "adapters:ClaudeToolApprovalOptions",
2077
+ "adapters:GraphApprovalRecord",
2078
+ "ApprovalData.approvedInput",
2079
+ "ApprovalData.changes",
2080
+ "ApprovalData.editableFields",
2081
+ "ApprovalData.input",
2082
+ "CreateApprovalInput.editableFields",
2083
+ "CreateApprovalInput.input",
2084
+ "Decision.changes",
2085
+ "Decision.input",
2086
+ "FieldChange.field",
2087
+ "FieldChange.from",
2088
+ "FieldChange.to",
2089
+ "GateData.changes",
2090
+ "GateDecision.changes",
2091
+ "adapters:AiSdkApprovalCall",
2092
+ "adapters:AiSdkApprovalStatus",
2093
+ "adapters:Approver",
2094
+ "adapters:CallDescription",
2095
+ "adapters:CallOutcome",
2096
+ "adapters:ClaudeCanUseTool",
2097
+ "adapters:ClaudeCanUseToolContext",
2098
+ "adapters:ClaudePermissionResult",
2099
+ "adapters:DEFAULT_TOOL_EXPIRY",
2100
+ "adapters:DeliverdInterruptValue",
2101
+ "adapters:GraphApprover",
2102
+ "adapters:GraphDecision",
2103
+ "adapters:OpenAiApprovalItem",
2104
+ "adapters:OpenAiInterruptedResult",
2105
+ "adapters:ToolApprovalOptions",
2106
+ "adapters:approveInGraph",
2107
+ "adapters:defaultDescription",
2108
+ "adapters:deliverdCanUseTool",
2109
+ "adapters:deliverdToolApproval",
2110
+ "adapters:resolveInterruptions",
2111
+ "adapters:resumeFromCallback",
2112
+ "adapters:runWithDeliverdApprovals",
2113
+ "Approval",
2114
+ "ApprovalData.approvalsSoFar",
2115
+ "ApprovalData.approvers",
2116
+ "ApprovalData.createdAt",
2117
+ "ApprovalData.decidedAt",
2118
+ "ApprovalData.decidedBy",
2119
+ "ApprovalData.decidedById",
2120
+ "ApprovalData.description",
2121
+ "ApprovalData.expiresAt",
2122
+ "ApprovalData.externalId",
2123
+ "ApprovalData.factors",
2124
+ "ApprovalData.id",
2125
+ "ApprovalData.links",
2126
+ "ApprovalData.metadata",
2127
+ "ApprovalData.note",
2128
+ "ApprovalData.questions",
2129
+ "ApprovalData.reportId",
2130
+ "ApprovalData.requestedBy",
2131
+ "ApprovalData.requiredApprovals",
2132
+ "ApprovalData.risk",
2133
+ "ApprovalData.status",
2134
+ "ApprovalData.title",
2135
+ "ApprovalData.url",
2136
+ "ApprovalFactor.detail",
2137
+ "ApprovalFactor.label",
2138
+ "ApprovalFactor.status",
2139
+ "ApprovalLink.label",
2140
+ "ApprovalLink.url",
2141
+ "ApprovalQuestion.answer",
2142
+ "ApprovalQuestion.answeredAt",
2143
+ "ApprovalQuestion.askedAt",
2144
+ "ApprovalQuestion.id",
2145
+ "ApprovalQuestion.question",
2146
+ "Approvals",
2147
+ "ApproveOptions",
2148
+ "CallbackEnvelope.data",
2149
+ "CallbackEnvelope.event",
2150
+ "CallbackEnvelope.requestId",
2151
+ "CallbackEnvelope.requestType",
2152
+ "CallbackEnvelope.sentAt",
2153
+ "ClientOptions",
2154
+ "CollectOptions",
2155
+ "CollectWaitOptions",
2156
+ "CollectedAnswers.answers",
2157
+ "CollectedAnswers.collection",
2158
+ "CollectedAnswers.complete",
2159
+ "CollectedAnswers.id",
2160
+ "CollectedAnswers.responses",
2161
+ "CollectedAnswers.status",
2162
+ "CollectedAnswers.url",
2163
+ "Collection",
2164
+ "CollectionData.askedCount",
2165
+ "CollectionData.createdAt",
2166
+ "CollectionData.dueAt",
2167
+ "CollectionData.expiresAt",
2168
+ "CollectionData.externalId",
2169
+ "CollectionData.id",
2170
+ "CollectionData.instructions",
2171
+ "CollectionData.metadata",
2172
+ "CollectionData.questions",
2173
+ "CollectionData.reportId",
2174
+ "CollectionData.requestedBy",
2175
+ "CollectionData.requiredResponses",
2176
+ "CollectionData.responses",
2177
+ "CollectionData.settledAt",
2178
+ "CollectionData.status",
2179
+ "CollectionData.submittedCount",
2180
+ "CollectionData.title",
2181
+ "CollectionData.url",
2182
+ "CollectionQuestion.help",
2183
+ "CollectionQuestion.id",
2184
+ "CollectionQuestion.kind",
2185
+ "CollectionQuestion.options",
2186
+ "CollectionQuestion.prompt",
2187
+ "CollectionQuestion.required",
2188
+ "CollectionReply.answers",
2189
+ "CollectionReply.respondent",
2190
+ "CollectionReply.status",
2191
+ "CollectionReply.submittedAt",
2192
+ "Collections",
2193
+ "CommentThread.messages",
2194
+ "CommentThread.quote",
2195
+ "CommentThread.status",
2196
+ "CommentThread.threadId",
2197
+ "Comments",
2198
+ "CreateApprovalInput.approvers",
2199
+ "CreateApprovalInput.callbackUrl",
2200
+ "CreateApprovalInput.description",
2201
+ "CreateApprovalInput.expiresAt",
2202
+ "CreateApprovalInput.externalId",
2203
+ "CreateApprovalInput.factors",
2204
+ "CreateApprovalInput.flowId",
2205
+ "CreateApprovalInput.links",
2206
+ "CreateApprovalInput.metadata",
2207
+ "CreateApprovalInput.reportId",
2208
+ "CreateApprovalInput.risk",
2209
+ "CreateApprovalInput.title",
2210
+ "CreateCollectionInput.callbackUrl",
2211
+ "CreateCollectionInput.dueAt",
2212
+ "CreateCollectionInput.expiresAt",
2213
+ "CreateCollectionInput.externalId",
2214
+ "CreateCollectionInput.flowId",
2215
+ "CreateCollectionInput.instructions",
2216
+ "CreateCollectionInput.metadata",
2217
+ "CreateCollectionInput.questions",
2218
+ "CreateCollectionInput.reportId",
2219
+ "CreateCollectionInput.requiredResponses",
2220
+ "CreateCollectionInput.respondents",
2221
+ "CreateCollectionInput.title",
2222
+ "CreateFlowInput.description",
2223
+ "CreateFlowInput.externalId",
2224
+ "CreateFlowInput.metadata",
2225
+ "CreateFlowInput.title",
2226
+ "CreateFlowInput.workspaceId",
2227
+ "CreateGateInput.actionId",
2228
+ "CreateGateInput.environment",
2229
+ "CreateGateInput.externalId",
2230
+ "CreateGateInput.flowId",
2231
+ "CreateGateInput.input",
2232
+ "CreateGateInput.reason",
2233
+ "CreateReviewInput.callbackUrl",
2234
+ "CreateReviewInput.expiresAt",
2235
+ "CreateReviewInput.externalId",
2236
+ "CreateReviewInput.flowId",
2237
+ "CreateReviewInput.instructions",
2238
+ "CreateReviewInput.metadata",
2239
+ "CreateReviewInput.reportId",
2240
+ "CreateReviewInput.requiredApprovals",
2241
+ "CreateReviewInput.reviewers",
2242
+ "CreateReviewInput.title",
2243
+ "CreateReviewInput.versionId",
2244
+ "DEFAULT_BASE_URL",
2245
+ "DEFAULT_EXPIRY",
2246
+ "DELIVERY_HEADER",
2247
+ "Decision.approval",
2248
+ "Decision.approved",
2249
+ "Decision.decidedAt",
2250
+ "Decision.decidedBy",
2251
+ "Decision.decidedById",
2252
+ "Decision.id",
2253
+ "Decision.note",
2254
+ "Decision.status",
2255
+ "Decision.url",
2256
+ "Deliverd",
2257
+ "DeliverdError",
2258
+ "DeliverdOptions",
2259
+ "DeliverdTimeoutError",
2260
+ "Duration",
2261
+ "EVENT_HEADER",
2262
+ "EvidenceEvent.actor",
2263
+ "EvidenceEvent.actorType",
2264
+ "EvidenceEvent.at",
2265
+ "EvidenceEvent.event",
2266
+ "EvidenceEvent.metadata",
2267
+ "EvidenceEvent.step",
2268
+ "EvidenceOutcome.at",
2269
+ "EvidenceOutcome.note",
2270
+ "EvidenceOutcome.said",
2271
+ "EvidenceOutcome.who",
2272
+ "EvidencePack.generatedAt",
2273
+ "EvidencePack.generatedBy",
2274
+ "EvidencePack.integrity",
2275
+ "EvidencePack.organisation",
2276
+ "EvidencePack.packVersion",
2277
+ "EvidencePack.steps",
2278
+ "EvidencePack.subject",
2279
+ "EvidencePack.summary",
2280
+ "EvidencePack.timeline",
2281
+ "EvidenceStep.asked",
2282
+ "EvidenceStep.createdAt",
2283
+ "EvidenceStep.detail",
2284
+ "EvidenceStep.id",
2285
+ "EvidenceStep.kind",
2286
+ "EvidenceStep.outcomes",
2287
+ "EvidenceStep.requestedBy",
2288
+ "EvidenceStep.requestedByAgent",
2289
+ "EvidenceStep.settledAt",
2290
+ "EvidenceStep.status",
2291
+ "EvidenceStep.title",
2292
+ "EvidenceStep.url",
2293
+ "Flow",
2294
+ "FlowData.allSettled",
2295
+ "FlowData.createdAt",
2296
+ "FlowData.description",
2297
+ "FlowData.externalId",
2298
+ "FlowData.id",
2299
+ "FlowData.memberCount",
2300
+ "FlowData.members",
2301
+ "FlowData.metadata",
2302
+ "FlowData.openCount",
2303
+ "FlowData.settledAt",
2304
+ "FlowData.startedBy",
2305
+ "FlowData.status",
2306
+ "FlowData.timeline",
2307
+ "FlowData.title",
2308
+ "FlowData.url",
2309
+ "FlowEvent.actor",
2310
+ "FlowEvent.actorType",
2311
+ "FlowEvent.at",
2312
+ "FlowEvent.event",
2313
+ "FlowEvent.resourceId",
2314
+ "FlowEvent.resourceType",
2315
+ "FlowMember.createdAt",
2316
+ "FlowMember.id",
2317
+ "FlowMember.kind",
2318
+ "FlowMember.open",
2319
+ "FlowMember.status",
2320
+ "FlowMember.title",
2321
+ "FlowPrimitives",
2322
+ "Flows",
2323
+ "Gate",
2324
+ "GateData.allowed",
2325
+ "GateData.approvalId",
2326
+ "GateData.approvalUrl",
2327
+ "GateData.basis",
2328
+ "GateData.id",
2329
+ "GateData.input",
2330
+ "GateData.outcome",
2331
+ "GateData.policyVersionId",
2332
+ "GateData.reason",
2333
+ "GateData.reused",
2334
+ "GateData.rule",
2335
+ "GateData.settledAt",
2336
+ "GateData.status",
2337
+ "GateDecision.allowed",
2338
+ "GateDecision.approvalUrl",
2339
+ "GateDecision.gate",
2340
+ "GateDecision.id",
2341
+ "GateDecision.input",
2342
+ "GateDecision.reason",
2343
+ "GateDecision.rule",
2344
+ "GateDecision.status",
2345
+ "GateOptions",
2346
+ "GateWaitOptions",
2347
+ "Gates",
2348
+ "InlineFile.content",
2349
+ "InlineFile.encoding",
2350
+ "InlineFile.path",
2351
+ "ListApprovalsInput.cursor",
2352
+ "ListApprovalsInput.externalId",
2353
+ "ListApprovalsInput.limit",
2354
+ "ListApprovalsInput.status",
2355
+ "ListCollectionsInput.cursor",
2356
+ "ListCollectionsInput.externalId",
2357
+ "ListCollectionsInput.limit",
2358
+ "ListCollectionsInput.status",
2359
+ "ListFlowsInput.cursor",
2360
+ "ListFlowsInput.externalId",
2361
+ "ListFlowsInput.limit",
2362
+ "ListFlowsInput.status",
2363
+ "ListReviewsInput.cursor",
2364
+ "ListReviewsInput.externalId",
2365
+ "ListReviewsInput.limit",
2366
+ "ListReviewsInput.reportId",
2367
+ "ListReviewsInput.status",
2368
+ "OpenThread.author",
2369
+ "OpenThread.authorType",
2370
+ "OpenThread.lastActivityAt",
2371
+ "OpenThread.messages",
2372
+ "OpenThread.quote",
2373
+ "OpenThread.reportId",
2374
+ "OpenThread.reportOwnerId",
2375
+ "OpenThread.reportSlug",
2376
+ "OpenThread.reportTitle",
2377
+ "OpenThread.threadId",
2378
+ "OrgAnalytics.activeReports",
2379
+ "OrgAnalytics.days",
2380
+ "OrgAnalytics.externallySharedReports",
2381
+ "OrgAnalytics.inactiveReports",
2382
+ "OrgAnalytics.publicReports",
2383
+ "OrgAnalytics.publishesInPeriod",
2384
+ "OrgAnalytics.topReports",
2385
+ "OrgAnalytics.totalViews",
2386
+ "OrgAnalytics.uniqueViewers",
2387
+ "POLL_SCHEDULE",
2388
+ "PublishReportInput.audience",
2389
+ "PublishReportInput.changeSummary",
2390
+ "PublishReportInput.classification",
2391
+ "PublishReportInput.content",
2392
+ "PublishReportInput.description",
2393
+ "PublishReportInput.expectedVersion",
2394
+ "PublishReportInput.files",
2395
+ "PublishReportInput.living",
2396
+ "PublishReportInput.slug",
2397
+ "PublishReportInput.sourceModel",
2398
+ "PublishReportInput.sourceTool",
2399
+ "PublishReportInput.title",
2400
+ "PublishReportInput.uploadId",
2401
+ "PublishReportInput.workspaceId",
2402
+ "PublishResult.approval",
2403
+ "PublishResult.report",
2404
+ "PublishResult.status",
2405
+ "PublishResult.version",
2406
+ "PublishResult.warnings",
2407
+ "QuestionInput.help",
2408
+ "QuestionInput.kind",
2409
+ "QuestionInput.options",
2410
+ "QuestionInput.prompt",
2411
+ "QuestionInput.required",
2412
+ "ReportAnalytics.byDay",
2413
+ "ReportAnalytics.byVersion",
2414
+ "ReportAnalytics.externalViewers",
2415
+ "ReportAnalytics.firstViewedAt",
2416
+ "ReportAnalytics.internalViewers",
2417
+ "ReportAnalytics.lastViewedAt",
2418
+ "ReportAnalytics.recentViewers",
2419
+ "ReportAnalytics.reportId",
2420
+ "ReportAnalytics.title",
2421
+ "ReportAnalytics.totalViews",
2422
+ "ReportAnalytics.uniqueViewers",
2423
+ "ReportData.currentVersion",
2424
+ "ReportData.id",
2425
+ "ReportData.slug",
2426
+ "ReportData.status",
2427
+ "ReportData.title",
2428
+ "ReportData.url",
2429
+ "Reports",
2430
+ "Review",
2431
+ "ReviewData.createdAt",
2432
+ "ReviewData.expiresAt",
2433
+ "ReviewData.externalId",
2434
+ "ReviewData.id",
2435
+ "ReviewData.instructions",
2436
+ "ReviewData.metadata",
2437
+ "ReviewData.reportId",
2438
+ "ReviewData.requestedBy",
2439
+ "ReviewData.requiredApprovals",
2440
+ "ReviewData.reviewers",
2441
+ "ReviewData.settledAt",
2442
+ "ReviewData.status",
2443
+ "ReviewData.threadCount",
2444
+ "ReviewData.title",
2445
+ "ReviewData.url",
2446
+ "ReviewData.verdicts",
2447
+ "ReviewData.versionId",
2448
+ "ReviewOptions",
2449
+ "ReviewOutcome.approved",
2450
+ "ReviewOutcome.id",
2451
+ "ReviewOutcome.review",
2452
+ "ReviewOutcome.status",
2453
+ "ReviewOutcome.threadCount",
2454
+ "ReviewOutcome.url",
2455
+ "ReviewOutcome.verdicts",
2456
+ "ReviewVerdict.at",
2457
+ "ReviewVerdict.by",
2458
+ "ReviewVerdict.note",
2459
+ "ReviewVerdict.verdict",
2460
+ "ReviewWaitOptions",
2461
+ "ReviewerRef.id",
2462
+ "ReviewerRef.kind",
2463
+ "ReviewerRef.label",
2464
+ "Reviews",
2465
+ "SIGNATURE_HEADER",
2466
+ "ScheduleSummary.agentId",
2467
+ "ScheduleSummary.agentName",
2468
+ "ScheduleSummary.currentVersion",
2469
+ "ScheduleSummary.due",
2470
+ "ScheduleSummary.dueSince",
2471
+ "ScheduleSummary.enabled",
2472
+ "ScheduleSummary.id",
2473
+ "ScheduleSummary.lastRunAt",
2474
+ "ScheduleSummary.nextRunAt",
2475
+ "ScheduleSummary.recurrence",
2476
+ "ScheduleSummary.reportId",
2477
+ "ScheduleSummary.reportSlug",
2478
+ "ScheduleSummary.reportTitle",
2479
+ "ScheduleSummary.reportUrl",
2480
+ "Schedules",
2481
+ "SendResult.alreadyHadAccess",
2482
+ "SendResult.sent",
2483
+ "TOLERANCE_SECONDS",
2484
+ "WaitOptions",
2485
+ "WebhookEvent.data",
2486
+ "WebhookEvent.event",
2487
+ "WebhookEvent.sentAt",
2488
+ "WebhookEvent.test",
2489
+ "Webhooks",
2490
+ "constructCallback",
2491
+ "constructEvent",
2492
+ "deliverd",
2493
+ "durationMs",
2494
+ "event:access.requested",
2495
+ "event:approval.answered",
2496
+ "event:approval.approved",
2497
+ "event:approval.escalated",
2498
+ "event:approval.expired",
2499
+ "event:approval.question",
2500
+ "event:approval.rejected",
2501
+ "event:approval.requested",
2502
+ "event:collection.completed",
2503
+ "event:collection.requested",
2504
+ "event:comment.created",
2505
+ "event:flow.completed",
2506
+ "event:gate.denied",
2507
+ "event:publish.held",
2508
+ "event:report.published",
2509
+ "event:report.shared",
2510
+ "event:report.updated",
2511
+ "event:report.viewed",
2512
+ "event:review.approved",
2513
+ "event:review.changes_requested",
2514
+ "event:review.requested",
2515
+ "event:schedule.due",
2516
+ "verifySignature",
2517
+ ],
2067
2518
  };
package/dist/reviews.d.ts CHANGED
@@ -27,6 +27,14 @@ export declare class Review {
27
27
  private readonly http;
28
28
  private data;
29
29
  constructor(http: HttpClient, data: ReviewData);
30
+ /**
31
+ * The secret this request's callbacks are signed with, when you gave a
32
+ * `callbackUrl`. Only on the handle `create()` returned — the API hands it
33
+ * over once and never again — so keep it with whatever will receive the
34
+ * callback, and check each one with
35
+ * `deliverd.webhooks.constructCallback(callbackSecret, rawBody, signature)`.
36
+ */
37
+ callbackSecret: string | null;
30
38
  get id(): string;
31
39
  get status(): ReviewData["status"];
32
40
  /** The page the reviewer reads and decides on. */
@@ -1 +1 @@
1
- {"version":3,"file":"reviews.d.ts","sourceRoot":"","sources":["../src/reviews.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AAEzD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAE5C,OAAO,KAAK,EACV,iBAAiB,EACjB,gBAAgB,EAChB,UAAU,EACV,aAAa,EACd,MAAM,YAAY,CAAC;AAEpB;;;;;;;GAOG;AAEH,MAAM,WAAW,iBAAiB;IAChC,6DAA6D;IAC7D,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAC;IACtC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,4EAA4E;IAC5E,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAQD,6CAA6C;AAC7C,qBAAa,MAAM;IAEf,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,IAAI;gBADK,IAAI,EAAE,UAAU,EACzB,IAAI,EAAE,UAAU;IAG1B,IAAI,EAAE,IAAI,MAAM,CAAyB;IACzC,IAAI,MAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,CAA6B;IAC/D,kDAAkD;IAClD,IAAI,GAAG,IAAI,MAAM,CAA0B;IAC3C,IAAI,KAAK,IAAI,MAAM,CAA4B;IAC/C,IAAI,QAAQ,IAAI,UAAU,CAAC,UAAU,CAAC,CAA+B;IACrE,mEAAmE;IACnE,IAAI,WAAW,IAAI,MAAM,CAAkC;IAE3D,gFAAgF;IAChF,IAAI,QAAQ,IAAI,OAAO,CAA4C;IACnE,IAAI,gBAAgB,IAAI,OAAO,CAAqD;IACpF,IAAI,OAAO,IAAI,OAAO,CAA2C;IACjE,IAAI,SAAS,IAAI,OAAO,CAA6C;IACrE,IAAI,OAAO,IAAI,OAAO,CAA2C;IAEjE,gFAAgF;IAChF,MAAM,IAAI,UAAU;IAEpB,SAAS,IAAI,aAAa;IAapB,OAAO,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IASlD,4EAA4E;IACtE,MAAM,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IASjD;;;;;;;OAOG;IACG,IAAI,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;CAyB3D;AAmBD,qBAAa,OAAO;IACN,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C;;;;OAIG;IACG,MAAM,CAAC,KAAK,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAUvE,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAS5D;;;;;;OAMG;IACG,IAAI,CAAC,KAAK,GAAE,gBAAqB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAOjF,2EAA2E;IACrE,QAAQ,CACZ,KAAK,GAAE,gBAAqB,EAC5B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAa1B,8EAA8E;IACxE,OAAO,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,MAAM,CAAC;IAKzF;;;;;OAKG;IACG,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;CAIzF"}
1
+ {"version":3,"file":"reviews.d.ts","sourceRoot":"","sources":["../src/reviews.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AAEzD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAE5C,OAAO,KAAK,EACV,iBAAiB,EACjB,gBAAgB,EAChB,UAAU,EACV,aAAa,EACd,MAAM,YAAY,CAAC;AAEpB;;;;;;;GAOG;AAEH,MAAM,WAAW,iBAAiB;IAChC,6DAA6D;IAC7D,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAC;IACtC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,4EAA4E;IAC5E,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAQD,6CAA6C;AAC7C,qBAAa,MAAM;IAEf,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,IAAI;gBADK,IAAI,EAAE,UAAU,EACzB,IAAI,EAAE,UAAU;IAG1B;;;;;;OAMG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAQ;IAErC,IAAI,EAAE,IAAI,MAAM,CAAyB;IACzC,IAAI,MAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,CAA6B;IAC/D,kDAAkD;IAClD,IAAI,GAAG,IAAI,MAAM,CAA0B;IAC3C,IAAI,KAAK,IAAI,MAAM,CAA4B;IAC/C,IAAI,QAAQ,IAAI,UAAU,CAAC,UAAU,CAAC,CAA+B;IACrE,mEAAmE;IACnE,IAAI,WAAW,IAAI,MAAM,CAAkC;IAE3D,gFAAgF;IAChF,IAAI,QAAQ,IAAI,OAAO,CAA4C;IACnE,IAAI,gBAAgB,IAAI,OAAO,CAAqD;IACpF,IAAI,OAAO,IAAI,OAAO,CAA2C;IACjE,IAAI,SAAS,IAAI,OAAO,CAA6C;IACrE,IAAI,OAAO,IAAI,OAAO,CAA2C;IAEjE,gFAAgF;IAChF,MAAM,IAAI,UAAU;IAEpB,SAAS,IAAI,aAAa;IAapB,OAAO,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IASlD,4EAA4E;IACtE,MAAM,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IASjD;;;;;;;OAOG;IACG,IAAI,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;CAyB3D;AAmBD,qBAAa,OAAO;IACN,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C;;;;OAIG;IACG,MAAM,CAAC,KAAK,EAAE,iBAAiB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAYvE,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAS5D;;;;;;OAMG;IACG,IAAI,CAAC,KAAK,GAAE,gBAAqB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAOjF,2EAA2E;IACrE,QAAQ,CACZ,KAAK,GAAE,gBAAqB,EAC5B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAa1B,8EAA8E;IACxE,OAAO,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,MAAM,CAAC;IAKzF;;;;;OAKG;IACG,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;CAIzF"}
package/dist/reviews.js CHANGED
@@ -14,6 +14,14 @@ export class Review {
14
14
  this.http = http;
15
15
  this.data = data;
16
16
  }
17
+ /**
18
+ * The secret this request's callbacks are signed with, when you gave a
19
+ * `callbackUrl`. Only on the handle `create()` returned — the API hands it
20
+ * over once and never again — so keep it with whatever will receive the
21
+ * callback, and check each one with
22
+ * `deliverd.webhooks.constructCallback(callbackSecret, rawBody, signature)`.
23
+ */
24
+ callbackSecret = null;
17
25
  get id() { return this.data.id; }
18
26
  get status() { return this.data.status; }
19
27
  /** The page the reviewer reads and decides on. */
@@ -124,7 +132,9 @@ export class Reviews {
124
132
  body: input,
125
133
  signal,
126
134
  });
127
- return new Review(this.http, data);
135
+ const created = new Review(this.http, data);
136
+ created.callbackSecret = data.callbackSecret ?? null;
137
+ return created;
128
138
  }
129
139
  async get(id, signal) {
130
140
  const data = await this.http.request({
package/dist/types.d.ts CHANGED
@@ -51,8 +51,13 @@ export interface GateData {
51
51
  status: GateStatus;
52
52
  /** The one to branch on: a rule permitted it, or a person agreed to it. */
53
53
  allowed: boolean;
54
- /** The input as the action's schema validated it — what to execute with. */
54
+ /**
55
+ * What to execute with: the input as the action's schema validated it, or
56
+ * the approver's correction of it when they approved with changes.
57
+ */
55
58
  input: Record<string, unknown>;
59
+ /** What the approver changed in it. Empty unless they did. */
60
+ changes: FieldChange[];
56
61
  /** Whether a rule decided this or a person did. */
57
62
  basis: "policy" | "human";
58
63
  reason: string | null;
@@ -78,11 +83,20 @@ export interface GateDecision {
78
83
  status: GateStatus;
79
84
  reason: string | null;
80
85
  rule: string | null;
86
+ /** What to execute with, corrections included. */
81
87
  input: Record<string, unknown>;
88
+ /** What the approver changed. Empty unless they did. */
89
+ changes: FieldChange[];
82
90
  id: string;
83
91
  approvalUrl: string | null;
84
92
  gate: unknown;
85
93
  }
94
+ /** One field an approver corrected before approving. */
95
+ export interface FieldChange {
96
+ field: string;
97
+ from: unknown;
98
+ to: unknown;
99
+ }
86
100
  /** One line of evidence, as the approval page shows it. */
87
101
  export interface ApprovalFactor {
88
102
  label: string;
@@ -113,6 +127,14 @@ export interface ApprovalData {
113
127
  reportId: string | null;
114
128
  externalId: string | null;
115
129
  metadata: Record<string, unknown>;
130
+ /** What you proposed to run with, unchanged. */
131
+ input: Record<string, unknown> | null;
132
+ /** Which fields of it the approver may correct. */
133
+ editableFields: string[];
134
+ /** What to run with once approved: `input` with any corrections. Null until then. */
135
+ approvedInput: Record<string, unknown> | null;
136
+ /** What the approver changed. */
137
+ changes: FieldChange[];
116
138
  requestedBy: string;
117
139
  approvers: string[];
118
140
  /**
@@ -170,7 +192,23 @@ export interface CreateApprovalInput {
170
192
  * siblings set this for you.
171
193
  */
172
194
  flowId?: string;
195
+ /**
196
+ * Where to POST the outcome when a person answers, instead of polling:
197
+ * HTTPS, and a public address. The call that makes the request returns the
198
+ * secret its callbacks are signed with (`callbackSecret` on the handle).
199
+ */
200
+ callbackUrl?: string;
173
201
  metadata?: Record<string, unknown>;
202
+ /**
203
+ * The arguments you will run with if this is approved, shown to the
204
+ * approver. The decision's `input` is what to actually run with.
205
+ */
206
+ input?: Record<string, unknown>;
207
+ /**
208
+ * Fields of `input` the approver may correct before approving: strings,
209
+ * numbers and true/false. Omitted, it is approve or reject only.
210
+ */
211
+ editableFields?: string[];
174
212
  }
175
213
  /**
176
214
  * The answer to `approve()`.
@@ -195,6 +233,14 @@ export type Decision = {
195
233
  id: string;
196
234
  /** The page they decided on. Worth logging. */
197
235
  url: string;
236
+ /**
237
+ * What to run with, when you sent an `input` and it was approved: yours,
238
+ * with any corrections the approver made. Null otherwise — never run the
239
+ * proposal when this is null.
240
+ */
241
+ input: Record<string, unknown> | null;
242
+ /** What the approver changed. Empty when they approved it as proposed. */
243
+ changes: FieldChange[];
198
244
  /** The request itself, for anything the fields above do not name. */
199
245
  approval: unknown;
200
246
  };
@@ -436,6 +482,12 @@ export interface CreateReviewInput {
436
482
  * siblings set this for you.
437
483
  */
438
484
  flowId?: string;
485
+ /**
486
+ * Where to POST the outcome when a person answers, instead of polling:
487
+ * HTTPS, and a public address. The call that makes the request returns the
488
+ * secret its callbacks are signed with (`callbackSecret` on the handle).
489
+ */
490
+ callbackUrl?: string;
439
491
  metadata?: Record<string, unknown>;
440
492
  }
441
493
  export interface ReviewerRef {
@@ -534,6 +586,12 @@ export interface CreateCollectionInput {
534
586
  * siblings set this for you.
535
587
  */
536
588
  flowId?: string;
589
+ /**
590
+ * Where to POST the outcome when a person answers, instead of polling:
591
+ * HTTPS, and a public address. The call that makes the request returns the
592
+ * secret its callbacks are signed with (`callbackSecret` on the handle).
593
+ */
594
+ callbackUrl?: string;
537
595
  metadata?: Record<string, unknown>;
538
596
  }
539
597
  export interface CollectionQuestion {
@@ -734,4 +792,18 @@ export interface EvidencePack {
734
792
  recordsAreInsertOnly: boolean;
735
793
  };
736
794
  }
795
+ /**
796
+ * What arrives at a request's `callbackUrl`.
797
+ *
798
+ * `data` is the same object an organisation webhook carries for the event.
799
+ * `approval.question` means the approver asked something and is waiting on
800
+ * your answer (`answerQuestion`); every other event is the request settling.
801
+ */
802
+ export interface CallbackEnvelope {
803
+ event: "approval.approved" | "approval.rejected" | "approval.expired" | "approval.question" | "review.approved" | "review.changes_requested" | "review.expired" | "collection.completed" | "collection.expired";
804
+ sentAt: string;
805
+ requestType: "approval" | "review" | "collection";
806
+ requestId: string;
807
+ data: Record<string, unknown>;
808
+ }
737
809
  //# sourceMappingURL=types.d.ts.map