@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
@@ -0,0 +1,98 @@
1
+ import { DeliverdTimeoutError } from "../errors.js";
2
+ /**
3
+ * The tool input as the approver sees it: its arguments, shown field by field
4
+ * on the approval page, when it is a plain object of a sensible size. Larger
5
+ * or odd-shaped input is still in the description, just not structured.
6
+ */
7
+ const INPUT_MAX = 8000;
8
+ export function structuredInput(input) {
9
+ if (typeof input !== "object" || input === null || Array.isArray(input))
10
+ return undefined;
11
+ try {
12
+ return JSON.stringify(input).length <= INPUT_MAX ? input : undefined;
13
+ }
14
+ catch {
15
+ return undefined;
16
+ }
17
+ }
18
+ export const DEFAULT_TOOL_EXPIRY = "1h";
19
+ const INPUT_PREVIEW_MAX = 3000;
20
+ /** A plain account of a call, for when the caller did not write one. */
21
+ export function defaultDescription(toolName, input) {
22
+ let rendered;
23
+ try {
24
+ rendered = typeof input === "string" ? input : JSON.stringify(input, null, 2);
25
+ }
26
+ catch {
27
+ rendered = String(input);
28
+ }
29
+ if (rendered && rendered.length > INPUT_PREVIEW_MAX)
30
+ rendered = `${rendered.slice(0, INPUT_PREVIEW_MAX - 1)}…`;
31
+ return {
32
+ title: `Allow the agent to run ${toolName}`,
33
+ description: rendered ? `With this input:\n\n${rendered}` : undefined,
34
+ risk: "medium",
35
+ };
36
+ }
37
+ /**
38
+ * Ask about one call and wait.
39
+ *
40
+ * `externalId` makes the ask idempotent: a framework that retries a step, or
41
+ * a process that restarts mid-wait, finds the request it already made instead
42
+ * of filing a second one (`approve()` reuses by `externalId`).
43
+ *
44
+ * A refusal, an expiry and a wait that ran out are all "not allowed", each
45
+ * with a sentence the model can read and act on — never a thrown error, which
46
+ * most frameworks would turn into a crashed run rather than a declined call.
47
+ */
48
+ export async function askAboutCall(toolName, input, externalId, options, signal,
49
+ /** Fields a person may correct. Only for a framework that can run a corrected call. */
50
+ editableFields) {
51
+ const described = (options.describe ?? defaultDescription)(toolName, input);
52
+ const structured = structuredInput(input);
53
+ let decision;
54
+ try {
55
+ decision = await options.deliverd.approve({
56
+ ...described,
57
+ approvers: options.approvers,
58
+ externalId,
59
+ flowId: options.flowId,
60
+ metadata: { ...options.metadata, tool: toolName },
61
+ ...(structured ? { input: structured } : {}),
62
+ ...(structured && editableFields?.length
63
+ ? { editableFields: editableFields.filter((field) => field in structured) }
64
+ : {}),
65
+ expiresIn: options.expiresIn ?? DEFAULT_TOOL_EXPIRY,
66
+ timeout: options.timeout,
67
+ signal,
68
+ });
69
+ }
70
+ catch (err) {
71
+ if (err instanceof DeliverdTimeoutError) {
72
+ return { allowed: false, reason: `Nobody decided whether to run ${toolName} in time, so it was not run.` };
73
+ }
74
+ throw err;
75
+ }
76
+ if (decision.approved) {
77
+ return {
78
+ allowed: true,
79
+ decidedBy: decision.decidedBy,
80
+ note: decision.note,
81
+ input: decision.input ?? null,
82
+ changes: decision.changes ?? [],
83
+ };
84
+ }
85
+ return { allowed: false, reason: refusalReason(toolName, decision) };
86
+ }
87
+ export function refusalReason(toolName, decision) {
88
+ const who = decision.decidedBy ? ` by ${decision.decidedBy}` : "";
89
+ const why = decision.note ? ` Their reason: ${decision.note}` : "";
90
+ switch (decision.status) {
91
+ case "rejected":
92
+ return `A person declined running ${toolName}${who}.${why} Do not retry it; change course or ask how to proceed.`;
93
+ case "expired":
94
+ return `Nobody decided whether to run ${toolName} before the request expired, so it was not run.`;
95
+ default:
96
+ return `The request to run ${toolName} was withdrawn, so it was not run.`;
97
+ }
98
+ }
@@ -1,6 +1,6 @@
1
1
  import { type PageOf } from "./paging.js";
2
2
  import type { HttpClient } from "./http.js";
3
- import type { ApprovalData, ApprovalQuestion, CreateApprovalInput, Decision, ListApprovalsInput } from "./types.js";
3
+ import type { ApprovalData, ApprovalQuestion, CreateApprovalInput, Decision, FieldChange, ListApprovalsInput } from "./types.js";
4
4
  /**
5
5
  * Ask a person before you act.
6
6
  *
@@ -59,6 +59,14 @@ export declare class Approval {
59
59
  private readonly http;
60
60
  private data;
61
61
  constructor(http: HttpClient, data: ApprovalData);
62
+ /**
63
+ * The secret this request's callbacks are signed with, when you gave a
64
+ * `callbackUrl`. Only on the handle `create()` returned — the API hands it
65
+ * over once and never again — so keep it with whatever will receive the
66
+ * callback, and check each one with
67
+ * `deliverd.webhooks.constructCallback(callbackSecret, rawBody, signature)`.
68
+ */
69
+ callbackSecret: string | null;
62
70
  get id(): string;
63
71
  get status(): ApprovalData["status"];
64
72
  /** The page the approver decides on. Put it in your own UI or logs. */
@@ -70,6 +78,12 @@ export declare class Approval {
70
78
  get decidedBy(): string | null;
71
79
  get decidedById(): string | null;
72
80
  get decidedAt(): string | null;
81
+ /** What you proposed to run with. */
82
+ get input(): Record<string, unknown> | null;
83
+ /** What to run with once approved, with any corrections. Null until then. */
84
+ get approvedInput(): Record<string, unknown> | null;
85
+ /** What the approver changed. */
86
+ get changes(): FieldChange[];
73
87
  get questions(): ApprovalQuestion[];
74
88
  /** Questions the approver is still waiting on you to answer. */
75
89
  get openQuestions(): ApprovalQuestion[];
@@ -1 +1 @@
1
- {"version":3,"file":"approvals.d.ts","sourceRoot":"","sources":["../src/approvals.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,YAAY,EACZ,gBAAgB,EAChB,mBAAmB,EACnB,QAAQ,EACR,kBAAkB,EACnB,MAAM,YAAY,CAAC;AAEpB;;;;;;;;GAQG;AAEH;;;;;;;;;;GAUG;AACH,eAAO,MAAM,aAAa,qDAA2D,CAAC;AAGtF,2EAA2E;AAC3E,eAAO,MAAM,kBAAkB,4BAA6B,CAAC;AAQ7D,MAAM,WAAW,WAAW;IAC1B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,gBAAgB,EAAE,QAAQ,EAAE,YAAY,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC;IAC5G,6DAA6D;IAC7D,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,YAAY,KAAK,IAAI,CAAC;IAC1C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAED;;;;;;GAMG;AACH,qBAAa,QAAQ;IAEjB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,IAAI;gBADK,IAAI,EAAE,UAAU,EACzB,IAAI,EAAE,YAAY;IAG5B,IAAI,EAAE,IAAI,MAAM,CAAyB;IACzC,IAAI,MAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,CAA6B;IACjE,uEAAuE;IACvE,IAAI,GAAG,IAAI,MAAM,CAA0B;IAC3C,IAAI,KAAK,IAAI,MAAM,CAA4B;IAC/C,wCAAwC;IACxC,IAAI,IAAI,IAAI,MAAM,GAAG,IAAI,CAA2B;IACpD,gDAAgD;IAChD,IAAI,SAAS,IAAI,MAAM,GAAG,IAAI,CAAgC;IAC9D,IAAI,WAAW,IAAI,MAAM,GAAG,IAAI,CAAkC;IAClE,IAAI,SAAS,IAAI,MAAM,GAAG,IAAI,CAAgC;IAC9D,IAAI,SAAS,IAAI,gBAAgB,EAAE,CAAgC;IACnE,gEAAgE;IAChE,IAAI,aAAa,IAAI,gBAAgB,EAAE,CAAyD;IAEhG,6EAA6E;IAC7E,IAAI,QAAQ,IAAI,OAAO,CAA4C;IACnE,IAAI,QAAQ,IAAI,OAAO,CAA4C;IACnE,IAAI,OAAO,IAAI,OAAO,CAA2C;IACjE,IAAI,SAAS,IAAI,OAAO,CAA6C;IACrE,IAAI,OAAO,IAAI,OAAO,CAA2C;IAEjE,gFAAgF;IAChF,MAAM,IAAI,YAAY;IAEtB;;;;;;OAMG;IACH,UAAU,IAAI,QAAQ;IAehB,OAAO,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IASlD,oEAAoE;IAC9D,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAUrF,4EAA4E;IACtE,MAAM,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IASjD;;;;;;;OAOG;IACG,IAAI,CAAC,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;CAiDrD;AAmBD,qBAAa,SAAS;IACR,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C;;;;OAIG;IACG,MAAM,CAAC,KAAK,EAAE,mBAAmB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;IAU3E,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;IAS9D;;;;;;OAMG;IACG,IAAI,CAAC,KAAK,GAAE,kBAAuB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAOrF,2EAA2E;IACrE,QAAQ,CACZ,KAAK,GAAE,kBAAuB,EAC9B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAa5B;;;OAGG;IACG,OAAO,CACX,KAAK,EAAE,mBAAmB,EAC1B,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,QAAQ,CAAC;IAKpB;;;;;;;;;;OAUG;IACG,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;CAI3F"}
1
+ {"version":3,"file":"approvals.d.ts","sourceRoot":"","sources":["../src/approvals.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,YAAY,EACZ,gBAAgB,EAChB,mBAAmB,EACnB,QAAQ,EACR,WAAW,EACX,kBAAkB,EACnB,MAAM,YAAY,CAAC;AAEpB;;;;;;;;GAQG;AAEH;;;;;;;;;;GAUG;AACH,eAAO,MAAM,aAAa,qDAA2D,CAAC;AAGtF,2EAA2E;AAC3E,eAAO,MAAM,kBAAkB,4BAA6B,CAAC;AAQ7D,MAAM,WAAW,WAAW;IAC1B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,gBAAgB,EAAE,QAAQ,EAAE,YAAY,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,MAAM,GAAG,IAAI,CAAC;IAC5G,6DAA6D;IAC7D,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,YAAY,KAAK,IAAI,CAAC;IAC1C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAED;;;;;;GAMG;AACH,qBAAa,QAAQ;IAEjB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,IAAI;gBADK,IAAI,EAAE,UAAU,EACzB,IAAI,EAAE,YAAY;IAG5B;;;;;;OAMG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAQ;IAErC,IAAI,EAAE,IAAI,MAAM,CAAyB;IACzC,IAAI,MAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,CAA6B;IACjE,uEAAuE;IACvE,IAAI,GAAG,IAAI,MAAM,CAA0B;IAC3C,IAAI,KAAK,IAAI,MAAM,CAA4B;IAC/C,wCAAwC;IACxC,IAAI,IAAI,IAAI,MAAM,GAAG,IAAI,CAA2B;IACpD,gDAAgD;IAChD,IAAI,SAAS,IAAI,MAAM,GAAG,IAAI,CAAgC;IAC9D,IAAI,WAAW,IAAI,MAAM,GAAG,IAAI,CAAkC;IAClE,IAAI,SAAS,IAAI,MAAM,GAAG,IAAI,CAAgC;IAC9D,qCAAqC;IACrC,IAAI,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAoC;IAC/E,6EAA6E;IAC7E,IAAI,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAA4C;IAC/F,iCAAiC;IACjC,IAAI,OAAO,IAAI,WAAW,EAAE,CAAoC;IAChE,IAAI,SAAS,IAAI,gBAAgB,EAAE,CAAgC;IACnE,gEAAgE;IAChE,IAAI,aAAa,IAAI,gBAAgB,EAAE,CAAyD;IAEhG,6EAA6E;IAC7E,IAAI,QAAQ,IAAI,OAAO,CAA4C;IACnE,IAAI,QAAQ,IAAI,OAAO,CAA4C;IACnE,IAAI,OAAO,IAAI,OAAO,CAA2C;IACjE,IAAI,SAAS,IAAI,OAAO,CAA6C;IACrE,IAAI,OAAO,IAAI,OAAO,CAA2C;IAEjE,gFAAgF;IAChF,MAAM,IAAI,YAAY;IAEtB;;;;;;OAMG;IACH,UAAU,IAAI,QAAQ;IAiBhB,OAAO,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IASlD,oEAAoE;IAC9D,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAUrF,4EAA4E;IACtE,MAAM,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IASjD;;;;;;;OAOG;IACG,IAAI,CAAC,OAAO,GAAE,WAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;CAiDrD;AAmBD,qBAAa,SAAS;IACR,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C;;;;OAIG;IACG,MAAM,CAAC,KAAK,EAAE,mBAAmB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;IAY3E,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;IAS9D;;;;;;OAMG;IACG,IAAI,CAAC,KAAK,GAAE,kBAAuB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAOrF,2EAA2E;IACrE,QAAQ,CACZ,KAAK,GAAE,kBAAuB,EAC9B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAa5B;;;OAGG;IACG,OAAO,CACX,KAAK,EAAE,mBAAmB,EAC1B,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,QAAQ,CAAC;IAKpB;;;;;;;;;;OAUG;IACG,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;CAI3F"}
package/dist/approvals.js CHANGED
@@ -43,6 +43,14 @@ export class Approval {
43
43
  this.http = http;
44
44
  this.data = data;
45
45
  }
46
+ /**
47
+ * The secret this request's callbacks are signed with, when you gave a
48
+ * `callbackUrl`. Only on the handle `create()` returned — the API hands it
49
+ * over once and never again — so keep it with whatever will receive the
50
+ * callback, and check each one with
51
+ * `deliverd.webhooks.constructCallback(callbackSecret, rawBody, signature)`.
52
+ */
53
+ callbackSecret = null;
46
54
  get id() { return this.data.id; }
47
55
  get status() { return this.data.status; }
48
56
  /** The page the approver decides on. Put it in your own UI or logs. */
@@ -54,6 +62,12 @@ export class Approval {
54
62
  get decidedBy() { return this.data.decidedBy; }
55
63
  get decidedById() { return this.data.decidedById; }
56
64
  get decidedAt() { return this.data.decidedAt; }
65
+ /** What you proposed to run with. */
66
+ get input() { return this.data.input ?? null; }
67
+ /** What to run with once approved, with any corrections. Null until then. */
68
+ get approvedInput() { return this.data.approvedInput ?? null; }
69
+ /** What the approver changed. */
70
+ get changes() { return this.data.changes ?? []; }
57
71
  get questions() { return this.data.questions; }
58
72
  /** Questions the approver is still waiting on you to answer. */
59
73
  get openQuestions() { return this.data.questions.filter((q) => !q.answer); }
@@ -83,6 +97,8 @@ export class Approval {
83
97
  decidedAt: this.data.decidedAt,
84
98
  id: this.data.id,
85
99
  url: this.data.url,
100
+ input: this.data.status === "approved" ? (this.data.approvedInput ?? this.data.input) : null,
101
+ changes: this.data.changes ?? [],
86
102
  approval: this,
87
103
  };
88
104
  }
@@ -198,7 +214,9 @@ export class Approvals {
198
214
  body: input,
199
215
  signal,
200
216
  });
201
- return new Approval(this.http, data);
217
+ const created = new Approval(this.http, data);
218
+ created.callbackSecret = data.callbackSecret ?? null;
219
+ return created;
202
220
  }
203
221
  async get(id, signal) {
204
222
  const data = await this.http.request({
@@ -25,6 +25,14 @@ export declare class Collection {
25
25
  private readonly http;
26
26
  private data;
27
27
  constructor(http: HttpClient, data: CollectionData);
28
+ /**
29
+ * The secret this request's callbacks are signed with, when you gave a
30
+ * `callbackUrl`. Only on the handle `create()` returned — the API hands it
31
+ * over once and never again — so keep it with whatever will receive the
32
+ * callback, and check each one with
33
+ * `deliverd.webhooks.constructCallback(callbackSecret, rawBody, signature)`.
34
+ */
35
+ callbackSecret: string | null;
28
36
  get id(): string;
29
37
  get status(): CollectionData["status"];
30
38
  /** The page the people you asked will fill in. */
@@ -1 +1 @@
1
- {"version":3,"file":"collections.d.ts","sourceRoot":"","sources":["../src/collections.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,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EACrB,oBAAoB,EACrB,MAAM,YAAY,CAAC;AAEpB;;;;;;GAMG;AAEH,MAAM,WAAW,kBAAkB;IACjC,6DAA6D;IAC7D,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,cAAc,KAAK,IAAI,CAAC;IAC9C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAOD,0DAA0D;AAC1D,qBAAa,UAAU;IAEnB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,IAAI;gBADK,IAAI,EAAE,UAAU,EACzB,IAAI,EAAE,cAAc;IAG9B,IAAI,EAAE,IAAI,MAAM,CAAyB;IACzC,IAAI,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC,CAA6B;IACnE,kDAAkD;IAClD,IAAI,GAAG,IAAI,MAAM,CAA0B;IAC3C,IAAI,KAAK,IAAI,MAAM,CAA4B;IAC/C,IAAI,SAAS,IAAI,cAAc,CAAC,WAAW,CAAC,CAAgC;IAC5E,IAAI,cAAc,IAAI,MAAM,CAAqC;IACjE,IAAI,UAAU,IAAI,MAAM,CAAiC;IAEzD,6DAA6D;IAC7D,IAAI,QAAQ,IAAI,OAAO,CAA4C;IACnE,IAAI,OAAO,IAAI,OAAO,CAA2C;IACjE,IAAI,SAAS,IAAI,OAAO,CAA6C;IACrE,IAAI,OAAO,IAAI,OAAO,CAA2C;IAEjE,MAAM,IAAI,cAAc;IAExB;;;;;;;;;OASG;IACH,IAAI,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CASzC;IAED,WAAW,IAAI,gBAAgB;IAazB,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,kBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;CAyB5D;AAmBD,qBAAa,WAAW;IACV,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C,wEAAwE;IAClE,MAAM,CAAC,KAAK,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;IAU/E,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;IAShE;;;;;;OAMG;IACG,IAAI,CAAC,KAAK,GAAE,oBAAyB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAOzF,2EAA2E;IACrE,QAAQ,CACZ,KAAK,GAAE,oBAAyB,EAChC,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAa9B,8EAA8E;IACxE,OAAO,CACX,KAAK,EAAE,qBAAqB,EAC5B,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,UAAU,CAAC;IAKtB,wFAAwF;IAClF,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;CAI7F"}
1
+ {"version":3,"file":"collections.d.ts","sourceRoot":"","sources":["../src/collections.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,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EACrB,oBAAoB,EACrB,MAAM,YAAY,CAAC;AAEpB;;;;;;GAMG;AAEH,MAAM,WAAW,kBAAkB;IACjC,6DAA6D;IAC7D,MAAM,CAAC,EAAE,CAAC,UAAU,EAAE,cAAc,KAAK,IAAI,CAAC;IAC9C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAOD,0DAA0D;AAC1D,qBAAa,UAAU;IAEnB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,IAAI;gBADK,IAAI,EAAE,UAAU,EACzB,IAAI,EAAE,cAAc;IAG9B;;;;;;OAMG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAQ;IAErC,IAAI,EAAE,IAAI,MAAM,CAAyB;IACzC,IAAI,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC,CAA6B;IACnE,kDAAkD;IAClD,IAAI,GAAG,IAAI,MAAM,CAA0B;IAC3C,IAAI,KAAK,IAAI,MAAM,CAA4B;IAC/C,IAAI,SAAS,IAAI,cAAc,CAAC,WAAW,CAAC,CAAgC;IAC5E,IAAI,cAAc,IAAI,MAAM,CAAqC;IACjE,IAAI,UAAU,IAAI,MAAM,CAAiC;IAEzD,6DAA6D;IAC7D,IAAI,QAAQ,IAAI,OAAO,CAA4C;IACnE,IAAI,OAAO,IAAI,OAAO,CAA2C;IACjE,IAAI,SAAS,IAAI,OAAO,CAA6C;IACrE,IAAI,OAAO,IAAI,OAAO,CAA2C;IAEjE,MAAM,IAAI,cAAc;IAExB;;;;;;;;;OASG;IACH,IAAI,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CASzC;IAED,WAAW,IAAI,gBAAgB;IAazB,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,kBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;CAyB5D;AAmBD,qBAAa,WAAW;IACV,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C,wEAAwE;IAClE,MAAM,CAAC,KAAK,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;IAY/E,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;IAShE;;;;;;OAMG;IACG,IAAI,CAAC,KAAK,GAAE,oBAAyB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAOzF,2EAA2E;IACrE,QAAQ,CACZ,KAAK,GAAE,oBAAyB,EAChC,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IAa9B,8EAA8E;IACxE,OAAO,CACX,KAAK,EAAE,qBAAqB,EAC5B,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,UAAU,CAAC;IAKtB,wFAAwF;IAClF,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;CAI7F"}
@@ -13,6 +13,14 @@ export class Collection {
13
13
  this.http = http;
14
14
  this.data = data;
15
15
  }
16
+ /**
17
+ * The secret this request's callbacks are signed with, when you gave a
18
+ * `callbackUrl`. Only on the handle `create()` returned — the API hands it
19
+ * over once and never again — so keep it with whatever will receive the
20
+ * callback, and check each one with
21
+ * `deliverd.webhooks.constructCallback(callbackSecret, rawBody, signature)`.
22
+ */
23
+ callbackSecret = null;
16
24
  get id() { return this.data.id; }
17
25
  get status() { return this.data.status; }
18
26
  /** The page the people you asked will fill in. */
@@ -139,7 +147,9 @@ export class Collections {
139
147
  body: input,
140
148
  signal,
141
149
  });
142
- return new Collection(this.http, data);
150
+ const created = new Collection(this.http, data);
151
+ created.callbackSecret = data.callbackSecret ?? null;
152
+ return created;
143
153
  }
144
154
  async get(id, signal) {
145
155
  const data = await this.http.request({
package/dist/dev.d.ts CHANGED
@@ -41,6 +41,12 @@ export interface DevelopmentOptions {
41
41
  delay?: number;
42
42
  /** What they say. Defaults suit the outcome. */
43
43
  note?: string;
44
+ /**
45
+ * Corrections the imaginary approver makes when approving a request that
46
+ * sent an `input`, so the approve-with-changes path can be run offline.
47
+ * Only fields you named in `editableFields` are applied, as in production.
48
+ */
49
+ edits?: Record<string, unknown>;
44
50
  /** What they ask, when the outcome is `question`. */
45
51
  question?: string;
46
52
  /** Print what the approver would have seen. Default true. */
package/dist/dev.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"dev.d.ts","sourceRoot":"","sources":["../src/dev.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EAMb,MAAM,YAAY,CAAC;AAEpB;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;;;;;;GAUG;AACH,MAAM,MAAM,kBAAkB,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAC;AAE7F,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,OAAO,CAAC,EAAE,kBAAkB,GAAG,CAAC,CAAC,OAAO,EAAE,YAAY,KAAK,kBAAkB,CAAC,CAAC;IAC/E,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gDAAgD;IAChD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6DAA6D;IAC7D,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAcD;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,GAAE,kBAAuB,GAAG,OAAO,UAAU,CAAC,KAAK,CAqd1F"}
1
+ {"version":3,"file":"dev.d.ts","sourceRoot":"","sources":["../src/dev.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EAMb,MAAM,YAAY,CAAC;AAEpB;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;;;;;;GAUG;AACH,MAAM,MAAM,kBAAkB,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAC;AAE7F,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,OAAO,CAAC,EAAE,kBAAkB,GAAG,CAAC,CAAC,OAAO,EAAE,YAAY,KAAK,kBAAkB,CAAC,CAAC;IAC/E,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gDAAgD;IAChD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,qDAAqD;IACrD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6DAA6D;IAC7D,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAcD;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,GAAE,kBAAuB,GAAG,OAAO,UAAU,CAAC,KAAK,CA0d1F"}
package/dist/dev.js CHANGED
@@ -37,6 +37,10 @@ export function developmentFetch(options = {}) {
37
37
  reportId: body.reportId ?? null,
38
38
  externalId: body.externalId ?? null,
39
39
  metadata: body.metadata ?? {},
40
+ input: body.input ?? null,
41
+ editableFields: body.editableFields ?? [],
42
+ approvedInput: null,
43
+ changes: [],
40
44
  requestedBy: "You (development mode)",
41
45
  approvers: body.approvers ?? [],
42
46
  /*
@@ -197,6 +201,7 @@ export function developmentFetch(options = {}) {
197
201
  status: byRule ? "denied" : "pending",
198
202
  allowed: false,
199
203
  input: body.input ?? {},
204
+ changes: [],
200
205
  basis: byRule ? "policy" : "human",
201
206
  reason: byRule
202
207
  ? "Development mode refused it. A real rule would say which one and why."
@@ -468,6 +473,12 @@ function settle(stored) {
468
473
  stored.data.note =
469
474
  stored.options.note ??
470
475
  (stored.data.status === "rejected" ? "Not yet — development mode says no." : null);
476
+ if (stored.data.status === "approved" && stored.data.input) {
477
+ const proposed = stored.data.input;
478
+ const edits = Object.entries(stored.options.edits ?? {}).filter(([field, value]) => stored.data.editableFields.includes(field) && !Object.is(proposed[field], value));
479
+ stored.data.approvedInput = { ...proposed, ...Object.fromEntries(edits) };
480
+ stored.data.changes = edits.map(([field, to]) => ({ field, from: proposed[field] ?? null, to }));
481
+ }
471
482
  }
472
483
  /**
473
484
  * What the approver would have seen, in the terminal.
@@ -1 +1 @@
1
- {"version":3,"file":"gates.d.ts","sourceRoot":"","sources":["../src/gates.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AA8B1E,MAAM,WAAW,eAAe;IAC9B,6EAA6E;IAC7E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,iDAAiD;IACjD,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;IAClC,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAED,MAAM,WAAW,WAAY,SAAQ,eAAe;IAClD,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;;;GAMG;AACH,qBAAa,IAAI;IAEb,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,IAAI;gBADK,IAAI,EAAE,UAAU,EACzB,IAAI,EAAE,QAAQ;IAGxB,IAAI,EAAE,IAAI,MAAM,CAAyB;IACzC,IAAI,MAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAA6B;IAC7D;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,CAA8B;IACpD,iCAAiC;IACjC,IAAI,OAAO,IAAI,OAAO,CAA2C;IACjE,0DAA0D;IAC1D,IAAI,MAAM,IAAI,OAAO,CAA0C;IAC/D,2EAA2E;IAC3E,IAAI,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAA4B;IAChE,mDAAmD;IACnD,IAAI,MAAM,IAAI,MAAM,GAAG,IAAI,CAA6B;IACxD,oEAAoE;IACpE,IAAI,IAAI,IAAI,MAAM,GAAG,IAAI,CAA2B;IACpD,kDAAkD;IAClD,IAAI,WAAW,IAAI,MAAM,GAAG,IAAI,CAAkC;IAClE,IAAI,UAAU,IAAI,MAAM,GAAG,IAAI,CAAiC;IAChE,2EAA2E;IAC3E,IAAI,MAAM,IAAI,OAAO,CAA6B;IAElD,gFAAgF;IAChF,MAAM,IAAI,QAAQ;IAElB,wDAAwD;IACxD,UAAU,IAAI,YAAY;IAapB,OAAO,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IASlD;;;;;;;;;;;OAWG;IACG,IAAI,CAAC,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;CAgCzD;AAyBD,qBAAa,KAAK;IACJ,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C;;;;;OAKG;IACG,MAAM,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBzE,8BAA8B;IACxB,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CAQ3D"}
1
+ {"version":3,"file":"gates.d.ts","sourceRoot":"","sources":["../src/gates.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,KAAK,EAAE,eAAe,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AA8B1E,MAAM,WAAW,eAAe;IAC9B,6EAA6E;IAC7E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,iDAAiD;IACjD,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAC;IAClC,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAED,MAAM,WAAW,WAAY,SAAQ,eAAe;IAClD,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;;;GAMG;AACH,qBAAa,IAAI;IAEb,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,IAAI;gBADK,IAAI,EAAE,UAAU,EACzB,IAAI,EAAE,QAAQ;IAGxB,IAAI,EAAE,IAAI,MAAM,CAAyB;IACzC,IAAI,MAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAA6B;IAC7D;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,CAA8B;IACpD,iCAAiC;IACjC,IAAI,OAAO,IAAI,OAAO,CAA2C;IACjE,0DAA0D;IAC1D,IAAI,MAAM,IAAI,OAAO,CAA0C;IAC/D,2EAA2E;IAC3E,IAAI,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAA4B;IAChE,mDAAmD;IACnD,IAAI,MAAM,IAAI,MAAM,GAAG,IAAI,CAA6B;IACxD,oEAAoE;IACpE,IAAI,IAAI,IAAI,MAAM,GAAG,IAAI,CAA2B;IACpD,kDAAkD;IAClD,IAAI,WAAW,IAAI,MAAM,GAAG,IAAI,CAAkC;IAClE,IAAI,UAAU,IAAI,MAAM,GAAG,IAAI,CAAiC;IAChE,2EAA2E;IAC3E,IAAI,MAAM,IAAI,OAAO,CAA6B;IAElD,gFAAgF;IAChF,MAAM,IAAI,QAAQ;IAElB,wDAAwD;IACxD,UAAU,IAAI,YAAY;IAcpB,OAAO,CAAC,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IASlD;;;;;;;;;;;OAWG;IACG,IAAI,CAAC,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;CAgCzD;AAyBD,qBAAa,KAAK;IACJ,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C;;;;;OAKG;IACG,MAAM,CAAC,KAAK,EAAE,eAAe,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBzE,8BAA8B;IACxB,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CAQ3D"}
package/dist/gates.js CHANGED
@@ -72,6 +72,7 @@ export class Gate {
72
72
  reason: this.data.reason,
73
73
  rule: this.data.rule,
74
74
  input: this.data.input,
75
+ changes: this.data.changes ?? [],
75
76
  id: this.data.id,
76
77
  approvalUrl: this.data.approvalUrl,
77
78
  gate: this,
package/dist/index.d.ts CHANGED
@@ -15,7 +15,7 @@ export { Comments, Reports, Schedules } from "./reports.js";
15
15
  export { Review, Reviews, type ReviewWaitOptions } from "./reviews.js";
16
16
  export { Collection, Collections, type CollectWaitOptions } from "./collections.js";
17
17
  export { Flow, Flows, type FlowPrimitives } from "./flows.js";
18
- export { constructEvent, DELIVERY_HEADER, EVENT_HEADER, SIGNATURE_HEADER, TOLERANCE_SECONDS, verifySignature, Webhooks, } from "./webhooks.js";
18
+ export { constructCallback, constructEvent, DELIVERY_HEADER, EVENT_HEADER, SIGNATURE_HEADER, TOLERANCE_SECONDS, verifySignature, Webhooks, } from "./webhooks.js";
19
19
  export { DeliverdError, DeliverdTimeoutError } from "./errors.js";
20
20
  export { DEFAULT_BASE_URL, type ClientOptions } from "./http.js";
21
21
  export { durationMs, type Duration } from "./duration.js";
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,aAAa,EAAE,MAAM,WAAW,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAsB,KAAK,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACjF,OAAO,EAAE,KAAK,EAAE,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAoB,KAAK,kBAAkB,EAAE,MAAM,UAAU,CAAC;AACrE,OAAO,EAAc,KAAK,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE1D,OAAO,KAAK,EACV,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,QAAQ,EACR,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACb,aAAa,EACd,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACtF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,WAAW,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACpF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,cAAc,EAAE,MAAM,YAAY,CAAC;AAC9D,OAAO,EACL,cAAc,EACd,eAAe,EACf,YAAY,EACZ,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,QAAQ,GACT,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,KAAK,aAAa,EAAE,MAAM,WAAW,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,KAAK,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC1D,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AACvE,mBAAmB,YAAY,CAAC;AAEhC,+EAA+E;AAC/E,eAAO,MAAM,cAAc,EAAE,QAAgB,CAAC;AAE9C,MAAM,WAAW,eAAgB,SAAQ,OAAO,CAAC,aAAa,CAAC;IAC7D;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;IAC9B,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED,0EAA0E;AAC1E,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,mBAAmB,EAAE,WAAW,CAAC;IAC5E,kEAAkE;IAClE,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,YAAY,CAAC,CAAC;IACvC,yDAAyD;IACzD,MAAM,CAAC,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC/B,2EAA2E;IAC3E,OAAO,CAAC,EAAE,QAAQ,CAAC;IACnB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,yEAAyE;AACzE,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,iBAAiB,EAAE,WAAW,CAAC;IACzE,kEAAkE;IAClE,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yDAAyD;IACzD,MAAM,CAAC,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACrC,0EAA0E;IAC1E,OAAO,CAAC,EAAE,QAAQ,CAAC;IACnB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,0EAA0E;AAC1E,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,qBAAqB,EAAE,WAAW,CAAC;IAC9E,kEAAkE;IAClE,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yDAAyD;IACzD,MAAM,CAAC,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACtC,2EAA2E;IAC3E,OAAO,CAAC,EAAE,QAAQ,CAAC;IACnB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,QAAQ;IACnB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,uDAAuD;IACvD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;gBAElB,OAAO,GAAE,eAAoB;IA4BzC;;;;;;;;;;OAUG;IACG,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IA0CzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC;IAsBvD;;;;;;OAMG;IACG,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAKxD;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAoC5D;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAkCjE,gFAAgF;IAChF,OAAO,CAAC,KAAK,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC;CAGjF;AAoBD,eAAO,MAAM,QAAQ,EAAE,QAMrB,CAAC;AAEH,eAAe,QAAQ,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,aAAa,EAAE,MAAM,WAAW,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAsB,KAAK,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACjF,OAAO,EAAE,KAAK,EAAE,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACxE,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAoB,KAAK,kBAAkB,EAAE,MAAM,UAAU,CAAC;AACrE,OAAO,EAAc,KAAK,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE1D,OAAO,KAAK,EACV,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,QAAQ,EACR,YAAY,EACZ,kBAAkB,EAClB,aAAa,EACb,aAAa,EACd,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,aAAa,EAAE,KAAK,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACtF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,WAAW,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;AACjF,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACpF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,cAAc,EAAE,MAAM,YAAY,CAAC;AAC9D,OAAO,EACL,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,YAAY,EACZ,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,QAAQ,GACT,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,KAAK,aAAa,EAAE,MAAM,WAAW,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,KAAK,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC1D,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AACvE,mBAAmB,YAAY,CAAC;AAEhC,+EAA+E;AAC/E,eAAO,MAAM,cAAc,EAAE,QAAgB,CAAC;AAE9C,MAAM,WAAW,eAAgB,SAAQ,OAAO,CAAC,aAAa,CAAC;IAC7D;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;IAC9B,WAAW,CAAC,EAAE,kBAAkB,CAAC;CAClC;AAED,0EAA0E;AAC1E,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,mBAAmB,EAAE,WAAW,CAAC;IAC5E,kEAAkE;IAClE,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,YAAY,CAAC,CAAC;IACvC,yDAAyD;IACzD,MAAM,CAAC,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC/B,2EAA2E;IAC3E,OAAO,CAAC,EAAE,QAAQ,CAAC;IACnB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,yEAAyE;AACzE,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,iBAAiB,EAAE,WAAW,CAAC;IACzE,kEAAkE;IAClE,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yDAAyD;IACzD,MAAM,CAAC,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACrC,0EAA0E;IAC1E,OAAO,CAAC,EAAE,QAAQ,CAAC;IACnB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,0EAA0E;AAC1E,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,qBAAqB,EAAE,WAAW,CAAC;IAC9E,kEAAkE;IAClE,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yDAAyD;IACzD,MAAM,CAAC,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACtC,2EAA2E;IAC3E,OAAO,CAAC,EAAE,QAAQ,CAAC;IACnB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,QAAQ;IACnB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAC1B,uDAAuD;IACvD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC;gBAElB,OAAO,GAAE,eAAoB;IA4BzC;;;;;;;;;;OAUG;IACG,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IA0CzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC;IAsBvD;;;;;;OAMG;IACG,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAKxD;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAoC5D;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAkCjE,gFAAgF;IAChF,OAAO,CAAC,KAAK,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,aAAa,CAAC;CAGjF;AAoBD,eAAO,MAAM,QAAQ,EAAE,QAMrB,CAAC;AAEH,eAAe,QAAQ,CAAC"}
package/dist/index.js CHANGED
@@ -14,7 +14,7 @@ export { Comments, Reports, Schedules } from "./reports.js";
14
14
  export { Review, Reviews } from "./reviews.js";
15
15
  export { Collection, Collections } from "./collections.js";
16
16
  export { Flow, Flows } from "./flows.js";
17
- export { constructEvent, DELIVERY_HEADER, EVENT_HEADER, SIGNATURE_HEADER, TOLERANCE_SECONDS, verifySignature, Webhooks, } from "./webhooks.js";
17
+ export { constructCallback, constructEvent, DELIVERY_HEADER, EVENT_HEADER, SIGNATURE_HEADER, TOLERANCE_SECONDS, verifySignature, Webhooks, } from "./webhooks.js";
18
18
  export { DeliverdError, DeliverdTimeoutError } from "./errors.js";
19
19
  export { DEFAULT_BASE_URL } from "./http.js";
20
20
  export { durationMs } from "./duration.js";
@@ -43,7 +43,7 @@
43
43
  * **Add the version here when you publish it, not before.** An entry is a
44
44
  * claim that `npm install @deliverd/sdk@x` works today.
45
45
  */
46
- export declare const PUBLISHED_TO_NPM: readonly ["0.1.0", "0.2.0", "0.3.0", "0.4.0", "0.5.0", "0.6.0", "0.6.1", "0.6.2", "0.7.0", "0.7.1", "0.8.0", "0.8.1"];
46
+ export declare const PUBLISHED_TO_NPM: readonly ["0.1.0", "0.2.0", "0.3.0", "0.4.0", "0.5.0", "0.6.0", "0.6.1", "0.6.2", "0.7.0", "0.7.1", "0.8.0", "0.8.1", "0.8.2"];
47
47
  /**
48
48
  * A fingerprint of what each *published* version recorded.
49
49
  *
@@ -1 +1 @@
1
- {"version":3,"file":"released.d.ts","sourceRoot":"","sources":["../src/released.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,gBAAgB,uHAanB,CAAC;AAEX;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAczC,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAy7DtD,CAAC"}
1
+ {"version":3,"file":"released.d.ts","sourceRoot":"","sources":["../src/released.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,gBAAgB,gIAcnB,CAAC;AAEX;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAqBzC,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAo3EtD,CAAC"}