@marinoscar/platform-contract 0.1.0-next.19 → 0.1.0-next.21
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 +10 -0
- package/README.md +4 -0
- package/dist/cjs/alerts/constants.d.ts +195 -0
- package/dist/cjs/alerts/constants.d.ts.map +1 -0
- package/dist/cjs/alerts/constants.js +165 -0
- package/dist/cjs/alerts/constants.js.map +1 -0
- package/dist/cjs/alerts/enum.d.ts +5 -0
- package/dist/cjs/alerts/enum.d.ts.map +1 -0
- package/dist/cjs/alerts/enum.js +9 -0
- package/dist/cjs/alerts/enum.js.map +1 -0
- package/dist/cjs/alerts/index.d.ts +5 -0
- package/dist/cjs/alerts/index.d.ts.map +1 -0
- package/dist/cjs/alerts/index.js +68 -0
- package/dist/cjs/alerts/index.js.map +1 -0
- package/dist/cjs/alerts/schemas.d.ts +351 -0
- package/dist/cjs/alerts/schemas.d.ts.map +1 -0
- package/dist/cjs/alerts/schemas.js +432 -0
- package/dist/cjs/alerts/schemas.js.map +1 -0
- package/dist/cjs/nodes/admin-schemas.d.ts +85 -1
- package/dist/cjs/nodes/admin-schemas.d.ts.map +1 -1
- package/dist/cjs/nodes/admin-schemas.js +55 -1
- package/dist/cjs/nodes/admin-schemas.js.map +1 -1
- package/dist/cjs/nodes/constants.d.ts +12 -0
- package/dist/cjs/nodes/constants.d.ts.map +1 -1
- package/dist/cjs/nodes/constants.js +13 -1
- package/dist/cjs/nodes/constants.js.map +1 -1
- package/dist/cjs/nodes/index.d.ts +5 -5
- package/dist/cjs/nodes/index.d.ts.map +1 -1
- package/dist/cjs/nodes/index.js +14 -1
- package/dist/cjs/nodes/index.js.map +1 -1
- package/dist/cjs/nodes/schemas.d.ts +178 -0
- package/dist/cjs/nodes/schemas.d.ts.map +1 -1
- package/dist/cjs/nodes/schemas.js +149 -1
- package/dist/cjs/nodes/schemas.js.map +1 -1
- package/dist/cjs/telemetry/constants.d.ts.map +1 -1
- package/dist/cjs/telemetry/constants.js +6 -0
- package/dist/cjs/telemetry/constants.js.map +1 -1
- package/dist/cjs/telemetry/dashboard.d.ts +5 -5
- package/dist/cjs/telemetry/presentation.d.ts +5 -5
- package/dist/cjs/telemetry/stack.d.ts +2 -2
- package/dist/cjs/webhooks/constants.d.ts +154 -0
- package/dist/cjs/webhooks/constants.d.ts.map +1 -0
- package/dist/cjs/webhooks/constants.js +136 -0
- package/dist/cjs/webhooks/constants.js.map +1 -0
- package/dist/cjs/webhooks/enum.d.ts +5 -0
- package/dist/cjs/webhooks/enum.d.ts.map +1 -0
- package/dist/cjs/webhooks/enum.js +9 -0
- package/dist/cjs/webhooks/enum.js.map +1 -0
- package/dist/cjs/webhooks/index.d.ts +7 -0
- package/dist/cjs/webhooks/index.d.ts.map +1 -0
- package/dist/cjs/webhooks/index.js +48 -0
- package/dist/cjs/webhooks/index.js.map +1 -0
- package/dist/cjs/webhooks/schemas.d.ts +288 -0
- package/dist/cjs/webhooks/schemas.d.ts.map +1 -0
- package/dist/cjs/webhooks/schemas.js +295 -0
- package/dist/cjs/webhooks/schemas.js.map +1 -0
- package/dist/cjs/webhooks/signature.d.ts +54 -0
- package/dist/cjs/webhooks/signature.d.ts.map +1 -0
- package/dist/cjs/webhooks/signature.js +97 -0
- package/dist/cjs/webhooks/signature.js.map +1 -0
- package/dist/esm/alerts/constants.d.ts +195 -0
- package/dist/esm/alerts/constants.d.ts.map +1 -0
- package/dist/esm/alerts/constants.js +162 -0
- package/dist/esm/alerts/constants.js.map +1 -0
- package/dist/esm/alerts/enum.d.ts +5 -0
- package/dist/esm/alerts/enum.d.ts.map +1 -0
- package/dist/esm/alerts/enum.js +6 -0
- package/dist/esm/alerts/enum.js.map +1 -0
- package/dist/esm/alerts/index.d.ts +5 -0
- package/dist/esm/alerts/index.d.ts.map +1 -0
- package/dist/esm/alerts/index.js +8 -0
- package/dist/esm/alerts/index.js.map +1 -0
- package/dist/esm/alerts/schemas.d.ts +351 -0
- package/dist/esm/alerts/schemas.d.ts.map +1 -0
- package/dist/esm/alerts/schemas.js +429 -0
- package/dist/esm/alerts/schemas.js.map +1 -0
- package/dist/esm/nodes/admin-schemas.d.ts +85 -1
- package/dist/esm/nodes/admin-schemas.d.ts.map +1 -1
- package/dist/esm/nodes/admin-schemas.js +55 -1
- package/dist/esm/nodes/admin-schemas.js.map +1 -1
- package/dist/esm/nodes/constants.d.ts +12 -0
- package/dist/esm/nodes/constants.d.ts.map +1 -1
- package/dist/esm/nodes/constants.js +12 -0
- package/dist/esm/nodes/constants.js.map +1 -1
- package/dist/esm/nodes/index.d.ts +5 -5
- package/dist/esm/nodes/index.d.ts.map +1 -1
- package/dist/esm/nodes/index.js +3 -3
- package/dist/esm/nodes/index.js.map +1 -1
- package/dist/esm/nodes/schemas.d.ts +178 -0
- package/dist/esm/nodes/schemas.d.ts.map +1 -1
- package/dist/esm/nodes/schemas.js +149 -1
- package/dist/esm/nodes/schemas.js.map +1 -1
- package/dist/esm/telemetry/constants.d.ts.map +1 -1
- package/dist/esm/telemetry/constants.js +6 -0
- package/dist/esm/telemetry/constants.js.map +1 -1
- package/dist/esm/telemetry/dashboard.d.ts +5 -5
- package/dist/esm/telemetry/presentation.d.ts +5 -5
- package/dist/esm/telemetry/stack.d.ts +2 -2
- package/dist/esm/webhooks/constants.d.ts +154 -0
- package/dist/esm/webhooks/constants.d.ts.map +1 -0
- package/dist/esm/webhooks/constants.js +133 -0
- package/dist/esm/webhooks/constants.js.map +1 -0
- package/dist/esm/webhooks/enum.d.ts +5 -0
- package/dist/esm/webhooks/enum.d.ts.map +1 -0
- package/dist/esm/webhooks/enum.js +6 -0
- package/dist/esm/webhooks/enum.js.map +1 -0
- package/dist/esm/webhooks/index.d.ts +7 -0
- package/dist/esm/webhooks/index.d.ts.map +1 -0
- package/dist/esm/webhooks/index.js +8 -0
- package/dist/esm/webhooks/index.js.map +1 -0
- package/dist/esm/webhooks/schemas.d.ts +288 -0
- package/dist/esm/webhooks/schemas.d.ts.map +1 -0
- package/dist/esm/webhooks/schemas.js +292 -0
- package/dist/esm/webhooks/schemas.js.map +1 -0
- package/dist/esm/webhooks/signature.d.ts +54 -0
- package/dist/esm/webhooks/signature.d.ts.map +1 -0
- package/dist/esm/webhooks/signature.js +93 -0
- package/dist/esm/webhooks/signature.js.map +1 -0
- package/package.json +21 -1
|
@@ -0,0 +1,288 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/**
|
|
3
|
+
* One subscription entry: an exact key, `group.*` or `*`.
|
|
4
|
+
*
|
|
5
|
+
* @stability experimental
|
|
6
|
+
*/
|
|
7
|
+
export declare const webhookEventKeySchema: z.ZodString;
|
|
8
|
+
/** One of `user`, `org`, `system`. @stability experimental */
|
|
9
|
+
export declare const webhookScopeSchema: z.ZodEnum<import("./constants.js").WebhookEnumEntries<"system" | "org" | "user">>;
|
|
10
|
+
/** One delivery status. @stability experimental */
|
|
11
|
+
export declare const webhookDeliveryStatusSchema: z.ZodEnum<import("./constants.js").WebhookEnumEntries<"pending" | "failed" | "succeeded" | "dead" | "delivering">>;
|
|
12
|
+
/**
|
|
13
|
+
* A webhook endpoint as the API returns it. Never carries the secret.
|
|
14
|
+
*
|
|
15
|
+
* @stability experimental
|
|
16
|
+
*/
|
|
17
|
+
export declare const webhookEndpointSchema: z.ZodObject<{
|
|
18
|
+
id: z.ZodString;
|
|
19
|
+
scope: z.ZodEnum<import("./constants.js").WebhookEnumEntries<"system" | "org" | "user">>;
|
|
20
|
+
orgId: z.ZodNullable<z.ZodString>;
|
|
21
|
+
ownerUserId: z.ZodNullable<z.ZodString>;
|
|
22
|
+
name: z.ZodString;
|
|
23
|
+
description: z.ZodNullable<z.ZodString>;
|
|
24
|
+
url: z.ZodString;
|
|
25
|
+
eventKeys: z.ZodArray<z.ZodString>;
|
|
26
|
+
enabled: z.ZodBoolean;
|
|
27
|
+
disabledReason: z.ZodNullable<z.ZodString>;
|
|
28
|
+
consecutiveFailures: z.ZodNumber;
|
|
29
|
+
secretVersion: z.ZodNumber;
|
|
30
|
+
previousSecretUntil: z.ZodNullable<z.ZodString>;
|
|
31
|
+
lastDeliveryAt: z.ZodNullable<z.ZodString>;
|
|
32
|
+
lastSuccessAt: z.ZodNullable<z.ZodString>;
|
|
33
|
+
createdAt: z.ZodString;
|
|
34
|
+
updatedAt: z.ZodString;
|
|
35
|
+
}, z.core.$strip>;
|
|
36
|
+
/** A webhook endpoint. @stability experimental */
|
|
37
|
+
export type WebhookEndpoint = z.infer<typeof webhookEndpointSchema>;
|
|
38
|
+
/**
|
|
39
|
+
* `POST` body to create an endpoint.
|
|
40
|
+
*
|
|
41
|
+
* @stability experimental
|
|
42
|
+
*/
|
|
43
|
+
export declare const createWebhookEndpointSchema: z.ZodObject<{
|
|
44
|
+
name: z.ZodString;
|
|
45
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
46
|
+
url: z.ZodString;
|
|
47
|
+
eventKeys: z.ZodArray<z.ZodString>;
|
|
48
|
+
enabled: z.ZodDefault<z.ZodBoolean>;
|
|
49
|
+
}, z.core.$strip>;
|
|
50
|
+
/** Input of the create body (before defaults). @stability experimental */
|
|
51
|
+
export type CreateWebhookEndpointInput = z.input<typeof createWebhookEndpointSchema>;
|
|
52
|
+
/** The parsed create body. @stability experimental */
|
|
53
|
+
export type CreateWebhookEndpoint = z.output<typeof createWebhookEndpointSchema>;
|
|
54
|
+
/**
|
|
55
|
+
* `PATCH` body: every create field is optional. `enabled: true` also clears a
|
|
56
|
+
* platform-set `disabledReason` and the failure streak.
|
|
57
|
+
*
|
|
58
|
+
* @stability experimental
|
|
59
|
+
*/
|
|
60
|
+
export declare const updateWebhookEndpointSchema: z.ZodObject<{
|
|
61
|
+
name: z.ZodOptional<z.ZodString>;
|
|
62
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
63
|
+
url: z.ZodOptional<z.ZodString>;
|
|
64
|
+
eventKeys: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
65
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
66
|
+
}, z.core.$strip>;
|
|
67
|
+
/** The update body. @stability experimental */
|
|
68
|
+
export type UpdateWebhookEndpoint = z.infer<typeof updateWebhookEndpointSchema>;
|
|
69
|
+
/**
|
|
70
|
+
* The endpoint list.
|
|
71
|
+
*
|
|
72
|
+
* @stability experimental
|
|
73
|
+
*/
|
|
74
|
+
export declare const webhookEndpointListSchema: z.ZodObject<{
|
|
75
|
+
items: z.ZodArray<z.ZodObject<{
|
|
76
|
+
id: z.ZodString;
|
|
77
|
+
scope: z.ZodEnum<import("./constants.js").WebhookEnumEntries<"system" | "org" | "user">>;
|
|
78
|
+
orgId: z.ZodNullable<z.ZodString>;
|
|
79
|
+
ownerUserId: z.ZodNullable<z.ZodString>;
|
|
80
|
+
name: z.ZodString;
|
|
81
|
+
description: z.ZodNullable<z.ZodString>;
|
|
82
|
+
url: z.ZodString;
|
|
83
|
+
eventKeys: z.ZodArray<z.ZodString>;
|
|
84
|
+
enabled: z.ZodBoolean;
|
|
85
|
+
disabledReason: z.ZodNullable<z.ZodString>;
|
|
86
|
+
consecutiveFailures: z.ZodNumber;
|
|
87
|
+
secretVersion: z.ZodNumber;
|
|
88
|
+
previousSecretUntil: z.ZodNullable<z.ZodString>;
|
|
89
|
+
lastDeliveryAt: z.ZodNullable<z.ZodString>;
|
|
90
|
+
lastSuccessAt: z.ZodNullable<z.ZodString>;
|
|
91
|
+
createdAt: z.ZodString;
|
|
92
|
+
updatedAt: z.ZodString;
|
|
93
|
+
}, z.core.$strip>>;
|
|
94
|
+
}, z.core.$strip>;
|
|
95
|
+
/** The endpoint list. @stability experimental */
|
|
96
|
+
export type WebhookEndpointList = z.infer<typeof webhookEndpointListSchema>;
|
|
97
|
+
/**
|
|
98
|
+
* The create response: the endpoint and its signing secret, shown once.
|
|
99
|
+
*
|
|
100
|
+
* @stability experimental
|
|
101
|
+
*/
|
|
102
|
+
export declare const webhookEndpointCreatedSchema: z.ZodObject<{
|
|
103
|
+
endpoint: z.ZodObject<{
|
|
104
|
+
id: z.ZodString;
|
|
105
|
+
scope: z.ZodEnum<import("./constants.js").WebhookEnumEntries<"system" | "org" | "user">>;
|
|
106
|
+
orgId: z.ZodNullable<z.ZodString>;
|
|
107
|
+
ownerUserId: z.ZodNullable<z.ZodString>;
|
|
108
|
+
name: z.ZodString;
|
|
109
|
+
description: z.ZodNullable<z.ZodString>;
|
|
110
|
+
url: z.ZodString;
|
|
111
|
+
eventKeys: z.ZodArray<z.ZodString>;
|
|
112
|
+
enabled: z.ZodBoolean;
|
|
113
|
+
disabledReason: z.ZodNullable<z.ZodString>;
|
|
114
|
+
consecutiveFailures: z.ZodNumber;
|
|
115
|
+
secretVersion: z.ZodNumber;
|
|
116
|
+
previousSecretUntil: z.ZodNullable<z.ZodString>;
|
|
117
|
+
lastDeliveryAt: z.ZodNullable<z.ZodString>;
|
|
118
|
+
lastSuccessAt: z.ZodNullable<z.ZodString>;
|
|
119
|
+
createdAt: z.ZodString;
|
|
120
|
+
updatedAt: z.ZodString;
|
|
121
|
+
}, z.core.$strip>;
|
|
122
|
+
secret: z.ZodString;
|
|
123
|
+
}, z.core.$strip>;
|
|
124
|
+
/** The create response. @stability experimental */
|
|
125
|
+
export type WebhookEndpointCreated = z.infer<typeof webhookEndpointCreatedSchema>;
|
|
126
|
+
/**
|
|
127
|
+
* The rotate response: the new secret, shown once, and when the previous one
|
|
128
|
+
* stops being accepted.
|
|
129
|
+
*
|
|
130
|
+
* @stability experimental
|
|
131
|
+
*/
|
|
132
|
+
export declare const rotateWebhookSecretResponseSchema: z.ZodObject<{
|
|
133
|
+
secret: z.ZodString;
|
|
134
|
+
secretVersion: z.ZodNumber;
|
|
135
|
+
previousSecretValidUntil: z.ZodNullable<z.ZodString>;
|
|
136
|
+
}, z.core.$strip>;
|
|
137
|
+
/** The rotate response. @stability experimental */
|
|
138
|
+
export type RotateWebhookSecretResponse = z.infer<typeof rotateWebhookSecretResponseSchema>;
|
|
139
|
+
/**
|
|
140
|
+
* One delivery row (no body).
|
|
141
|
+
*
|
|
142
|
+
* @stability experimental
|
|
143
|
+
*/
|
|
144
|
+
export declare const webhookDeliverySchema: z.ZodObject<{
|
|
145
|
+
id: z.ZodString;
|
|
146
|
+
endpointId: z.ZodString;
|
|
147
|
+
eventKey: z.ZodString;
|
|
148
|
+
eventId: z.ZodString;
|
|
149
|
+
status: z.ZodEnum<import("./constants.js").WebhookEnumEntries<"pending" | "failed" | "succeeded" | "dead" | "delivering">>;
|
|
150
|
+
attempt: z.ZodNumber;
|
|
151
|
+
responseStatus: z.ZodNullable<z.ZodNumber>;
|
|
152
|
+
responseSnippet: z.ZodNullable<z.ZodString>;
|
|
153
|
+
errorCode: z.ZodNullable<z.ZodString>;
|
|
154
|
+
durationMs: z.ZodNullable<z.ZodNumber>;
|
|
155
|
+
nextAttemptAt: z.ZodNullable<z.ZodString>;
|
|
156
|
+
deliveredAt: z.ZodNullable<z.ZodString>;
|
|
157
|
+
createdAt: z.ZodString;
|
|
158
|
+
}, z.core.$strip>;
|
|
159
|
+
/** One delivery. @stability experimental */
|
|
160
|
+
export type WebhookDelivery = z.infer<typeof webhookDeliverySchema>;
|
|
161
|
+
/**
|
|
162
|
+
* One delivery with the body sent and the request headers (the signature is
|
|
163
|
+
* never included).
|
|
164
|
+
*
|
|
165
|
+
* @stability experimental
|
|
166
|
+
*/
|
|
167
|
+
export declare const webhookDeliveryDetailSchema: z.ZodObject<{
|
|
168
|
+
id: z.ZodString;
|
|
169
|
+
endpointId: z.ZodString;
|
|
170
|
+
eventKey: z.ZodString;
|
|
171
|
+
eventId: z.ZodString;
|
|
172
|
+
status: z.ZodEnum<import("./constants.js").WebhookEnumEntries<"pending" | "failed" | "succeeded" | "dead" | "delivering">>;
|
|
173
|
+
attempt: z.ZodNumber;
|
|
174
|
+
responseStatus: z.ZodNullable<z.ZodNumber>;
|
|
175
|
+
responseSnippet: z.ZodNullable<z.ZodString>;
|
|
176
|
+
errorCode: z.ZodNullable<z.ZodString>;
|
|
177
|
+
durationMs: z.ZodNullable<z.ZodNumber>;
|
|
178
|
+
nextAttemptAt: z.ZodNullable<z.ZodString>;
|
|
179
|
+
deliveredAt: z.ZodNullable<z.ZodString>;
|
|
180
|
+
createdAt: z.ZodString;
|
|
181
|
+
payload: z.ZodUnknown;
|
|
182
|
+
requestHeaders: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
183
|
+
}, z.core.$strip>;
|
|
184
|
+
/** A delivery with its payload. @stability experimental */
|
|
185
|
+
export type WebhookDeliveryDetail = z.infer<typeof webhookDeliveryDetailSchema>;
|
|
186
|
+
/**
|
|
187
|
+
* A page of deliveries.
|
|
188
|
+
*
|
|
189
|
+
* @stability experimental
|
|
190
|
+
*/
|
|
191
|
+
export declare const webhookDeliveryListSchema: z.ZodObject<{
|
|
192
|
+
items: z.ZodArray<z.ZodObject<{
|
|
193
|
+
id: z.ZodString;
|
|
194
|
+
endpointId: z.ZodString;
|
|
195
|
+
eventKey: z.ZodString;
|
|
196
|
+
eventId: z.ZodString;
|
|
197
|
+
status: z.ZodEnum<import("./constants.js").WebhookEnumEntries<"pending" | "failed" | "succeeded" | "dead" | "delivering">>;
|
|
198
|
+
attempt: z.ZodNumber;
|
|
199
|
+
responseStatus: z.ZodNullable<z.ZodNumber>;
|
|
200
|
+
responseSnippet: z.ZodNullable<z.ZodString>;
|
|
201
|
+
errorCode: z.ZodNullable<z.ZodString>;
|
|
202
|
+
durationMs: z.ZodNullable<z.ZodNumber>;
|
|
203
|
+
nextAttemptAt: z.ZodNullable<z.ZodString>;
|
|
204
|
+
deliveredAt: z.ZodNullable<z.ZodString>;
|
|
205
|
+
createdAt: z.ZodString;
|
|
206
|
+
}, z.core.$strip>>;
|
|
207
|
+
total: z.ZodNumber;
|
|
208
|
+
page: z.ZodNumber;
|
|
209
|
+
pageSize: z.ZodNumber;
|
|
210
|
+
totalPages: z.ZodNumber;
|
|
211
|
+
}, z.core.$strip>;
|
|
212
|
+
/** A page of deliveries. @stability experimental */
|
|
213
|
+
export type WebhookDeliveryList = z.infer<typeof webhookDeliveryListSchema>;
|
|
214
|
+
/**
|
|
215
|
+
* `GET .../deliveries` query.
|
|
216
|
+
*
|
|
217
|
+
* @stability experimental
|
|
218
|
+
*/
|
|
219
|
+
export declare const webhookDeliveryListQuerySchema: z.ZodObject<{
|
|
220
|
+
page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
221
|
+
pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
222
|
+
status: z.ZodOptional<z.ZodEnum<import("./constants.js").WebhookEnumEntries<"pending" | "failed" | "succeeded" | "dead" | "delivering">>>;
|
|
223
|
+
eventKey: z.ZodOptional<z.ZodString>;
|
|
224
|
+
}, z.core.$strip>;
|
|
225
|
+
/** The parsed delivery list query. @stability experimental */
|
|
226
|
+
export type WebhookDeliveryListQuery = z.infer<typeof webhookDeliveryListQuerySchema>;
|
|
227
|
+
/**
|
|
228
|
+
* `POST .../test` response: the id of the queued ping delivery.
|
|
229
|
+
*
|
|
230
|
+
* @stability experimental
|
|
231
|
+
*/
|
|
232
|
+
export declare const webhookTestResponseSchema: z.ZodObject<{
|
|
233
|
+
deliveryId: z.ZodString;
|
|
234
|
+
}, z.core.$strip>;
|
|
235
|
+
/** The test response. @stability experimental */
|
|
236
|
+
export type WebhookTestResponse = z.infer<typeof webhookTestResponseSchema>;
|
|
237
|
+
/**
|
|
238
|
+
* One event a caller may subscribe to.
|
|
239
|
+
*
|
|
240
|
+
* @stability experimental
|
|
241
|
+
*/
|
|
242
|
+
export declare const webhookEventCatalogEntrySchema: z.ZodObject<{
|
|
243
|
+
key: z.ZodString;
|
|
244
|
+
label: z.ZodString;
|
|
245
|
+
description: z.ZodString;
|
|
246
|
+
group: z.ZodString;
|
|
247
|
+
audience: z.ZodEnum<import("./constants.js").WebhookEnumEntries<"system" | "org" | "user">>;
|
|
248
|
+
jsonSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
249
|
+
example: z.ZodOptional<z.ZodUnknown>;
|
|
250
|
+
}, z.core.$strip>;
|
|
251
|
+
/** One catalog entry. @stability experimental */
|
|
252
|
+
export type WebhookEventCatalogEntry = z.infer<typeof webhookEventCatalogEntrySchema>;
|
|
253
|
+
/**
|
|
254
|
+
* `GET .../events`: the catalog, filtered to what the caller may subscribe to.
|
|
255
|
+
*
|
|
256
|
+
* @stability experimental
|
|
257
|
+
*/
|
|
258
|
+
export declare const webhookEventCatalogSchema: z.ZodObject<{
|
|
259
|
+
items: z.ZodArray<z.ZodObject<{
|
|
260
|
+
key: z.ZodString;
|
|
261
|
+
label: z.ZodString;
|
|
262
|
+
description: z.ZodString;
|
|
263
|
+
group: z.ZodString;
|
|
264
|
+
audience: z.ZodEnum<import("./constants.js").WebhookEnumEntries<"system" | "org" | "user">>;
|
|
265
|
+
jsonSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
266
|
+
example: z.ZodOptional<z.ZodUnknown>;
|
|
267
|
+
}, z.core.$strip>>;
|
|
268
|
+
}, z.core.$strip>;
|
|
269
|
+
/** The event catalog. @stability experimental */
|
|
270
|
+
export type WebhookEventCatalog = z.infer<typeof webhookEventCatalogSchema>;
|
|
271
|
+
/**
|
|
272
|
+
* The JSON body a receiver gets.
|
|
273
|
+
*
|
|
274
|
+
* @stability experimental
|
|
275
|
+
*/
|
|
276
|
+
export declare const webhookEnvelopeSchema: z.ZodObject<{
|
|
277
|
+
id: z.ZodString;
|
|
278
|
+
type: z.ZodString;
|
|
279
|
+
createdAt: z.ZodString;
|
|
280
|
+
apiVersion: z.ZodString;
|
|
281
|
+
org: z.ZodNullable<z.ZodObject<{
|
|
282
|
+
id: z.ZodString;
|
|
283
|
+
}, z.core.$strip>>;
|
|
284
|
+
data: z.ZodUnknown;
|
|
285
|
+
}, z.core.$strip>;
|
|
286
|
+
/** The delivered body. @stability experimental */
|
|
287
|
+
export type WebhookEnvelope = z.infer<typeof webhookEnvelopeSchema>;
|
|
288
|
+
//# sourceMappingURL=schemas.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../src/webhooks/schemas.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAmBxB;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,aAAyE,CAAC;AAgB5G,8DAA8D;AAC9D,eAAO,MAAM,kBAAkB,mFAA2B,CAAC;AAE3D,mDAAmD;AACnD,eAAO,MAAM,2BAA2B,oHAAsC,CAAC;AAE/E;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;iBAmChC,CAAC;AAEH,kDAAkD;AAClD,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;;;GAIG;AACH,eAAO,MAAM,2BAA2B;;;;;;iBAWtC,CAAC;AAEH,0EAA0E;AAC1E,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AACrF,sDAAsD;AACtD,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEjF;;;;;GAKG;AACH,eAAO,MAAM,2BAA2B;;;;;;iBAWtC,CAAC;AAEH,+CAA+C;AAC/C,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF;;;;GAIG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;iBAGpC,CAAC;AAEH,iDAAiD;AACjD,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E;;;;GAIG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;iBAKvC,CAAC;AAEH,mDAAmD;AACnD,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;AAElF;;;;;GAKG;AACH,eAAO,MAAM,iCAAiC;;;;iBAO5C,CAAC;AAEH,mDAAmD;AACnD,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAE5F;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;iBA2BhC,CAAC;AAEH,4CAA4C;AAC5C,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;;;;GAKG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;iBAKtC,CAAC;AAEH,2DAA2D;AAC3D,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC;AAEhF;;;;GAIG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;iBAWpC,CAAC;AAEH,oDAAoD;AACpD,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E;;;;GAIG;AACH,eAAO,MAAM,8BAA8B;;;;;iBAczC,CAAC;AAEH,8DAA8D;AAC9D,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAEtF;;;;GAIG;AACH,eAAO,MAAM,yBAAyB;;iBAGpC,CAAC;AAEH,iDAAiD;AACjD,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E;;;;GAIG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;iBAezC,CAAC;AAEH,iDAAiD;AACjD,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAEtF;;;;GAIG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;iBAGpC,CAAC;AAEH,iDAAiD;AACjD,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;iBAkBhC,CAAC;AAEH,kDAAkD;AAClD,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC"}
|
|
@@ -0,0 +1,292 @@
|
|
|
1
|
+
// =============================================================================
|
|
2
|
+
// The webhooks slice's wire shapes (issue #1046)
|
|
3
|
+
// =============================================================================
|
|
4
|
+
//
|
|
5
|
+
// Endpoints, deliveries, the event catalog and the envelope a receiver gets.
|
|
6
|
+
// No schema here carries a signing secret except the two responses that show
|
|
7
|
+
// it once (`webhookEndpointCreatedSchema`, `rotateWebhookSecretResponseSchema`).
|
|
8
|
+
// Dates are ISO 8601 strings.
|
|
9
|
+
// =============================================================================
|
|
10
|
+
import { z } from 'zod';
|
|
11
|
+
import { wireEnum } from './enum.js';
|
|
12
|
+
import { WEBHOOK_DELIVERIES_PAGE_SIZE_DEFAULT, WEBHOOK_DELIVERIES_PAGE_SIZE_MAX, WEBHOOK_DELIVERY_STATUSES, WEBHOOK_DESCRIPTION_MAX, WEBHOOK_EVENT_KEY_MAX, WEBHOOK_EVENT_KEY_PATTERN, WEBHOOK_EVENT_KEYS_MAX, WEBHOOK_NAME_MAX, WEBHOOK_SCOPES, WEBHOOK_URL_MAX, } from './constants.js';
|
|
13
|
+
const isoDate = z.string();
|
|
14
|
+
/**
|
|
15
|
+
* One subscription entry: an exact key, `group.*` or `*`.
|
|
16
|
+
*
|
|
17
|
+
* @stability experimental
|
|
18
|
+
*/
|
|
19
|
+
export const webhookEventKeySchema = z.string().max(WEBHOOK_EVENT_KEY_MAX).regex(WEBHOOK_EVENT_KEY_PATTERN);
|
|
20
|
+
const eventKeysSchema = z.array(webhookEventKeySchema).min(1).max(WEBHOOK_EVENT_KEYS_MAX);
|
|
21
|
+
const httpUrlSchema = z
|
|
22
|
+
.string()
|
|
23
|
+
.max(WEBHOOK_URL_MAX)
|
|
24
|
+
.refine((value) => {
|
|
25
|
+
try {
|
|
26
|
+
const url = new URL(value);
|
|
27
|
+
return url.protocol === 'https:' || url.protocol === 'http:';
|
|
28
|
+
}
|
|
29
|
+
catch {
|
|
30
|
+
return false;
|
|
31
|
+
}
|
|
32
|
+
}, 'Must be an http(s) URL');
|
|
33
|
+
/** One of `user`, `org`, `system`. @stability experimental */
|
|
34
|
+
export const webhookScopeSchema = wireEnum(WEBHOOK_SCOPES);
|
|
35
|
+
/** One delivery status. @stability experimental */
|
|
36
|
+
export const webhookDeliveryStatusSchema = wireEnum(WEBHOOK_DELIVERY_STATUSES);
|
|
37
|
+
/**
|
|
38
|
+
* A webhook endpoint as the API returns it. Never carries the secret.
|
|
39
|
+
*
|
|
40
|
+
* @stability experimental
|
|
41
|
+
*/
|
|
42
|
+
export const webhookEndpointSchema = z.object({
|
|
43
|
+
/** The id. */
|
|
44
|
+
id: z.string(),
|
|
45
|
+
/** Who owns it. */
|
|
46
|
+
scope: webhookScopeSchema,
|
|
47
|
+
/** The organization; `null` for a system endpoint. */
|
|
48
|
+
orgId: z.string().nullable(),
|
|
49
|
+
/** The owning user (user scope); `null` otherwise. */
|
|
50
|
+
ownerUserId: z.string().nullable(),
|
|
51
|
+
/** The display name. */
|
|
52
|
+
name: z.string(),
|
|
53
|
+
/** A free-text note, or `null`. */
|
|
54
|
+
description: z.string().nullable(),
|
|
55
|
+
/** The receiver URL. */
|
|
56
|
+
url: z.string(),
|
|
57
|
+
/** The subscription entries: exact keys, `group.*` or `*`. */
|
|
58
|
+
eventKeys: z.array(z.string()),
|
|
59
|
+
/** Whether deliveries are sent. */
|
|
60
|
+
enabled: z.boolean(),
|
|
61
|
+
/** Why the endpoint was switched off by the platform (`circuit_open`, `owner_lost_access`, `gone`), else `null`. */
|
|
62
|
+
disabledReason: z.string().nullable(),
|
|
63
|
+
/** Failed deliveries in a row; the circuit opens at the configured limit. */
|
|
64
|
+
consecutiveFailures: z.number().int().min(0),
|
|
65
|
+
/** Increments on every rotation. */
|
|
66
|
+
secretVersion: z.number().int().min(1),
|
|
67
|
+
/** While set and in the future, deliveries are signed with the previous secret too. */
|
|
68
|
+
previousSecretUntil: isoDate.nullable(),
|
|
69
|
+
/** When the last attempt finished, or `null`. */
|
|
70
|
+
lastDeliveryAt: isoDate.nullable(),
|
|
71
|
+
/** When the last 2xx answer arrived, or `null`. */
|
|
72
|
+
lastSuccessAt: isoDate.nullable(),
|
|
73
|
+
/** Creation time. */
|
|
74
|
+
createdAt: isoDate,
|
|
75
|
+
/** Last change. */
|
|
76
|
+
updatedAt: isoDate,
|
|
77
|
+
});
|
|
78
|
+
/**
|
|
79
|
+
* `POST` body to create an endpoint.
|
|
80
|
+
*
|
|
81
|
+
* @stability experimental
|
|
82
|
+
*/
|
|
83
|
+
export const createWebhookEndpointSchema = z.object({
|
|
84
|
+
/** The display name. */
|
|
85
|
+
name: z.string().min(1).max(WEBHOOK_NAME_MAX),
|
|
86
|
+
/** A free-text note, or `null`. */
|
|
87
|
+
description: z.string().max(WEBHOOK_DESCRIPTION_MAX).nullish(),
|
|
88
|
+
/** The receiver URL. */
|
|
89
|
+
url: httpUrlSchema,
|
|
90
|
+
/** The subscription entries: exact keys, `group.*` or `*`. */
|
|
91
|
+
eventKeys: eventKeysSchema,
|
|
92
|
+
/** Whether deliveries are sent. */
|
|
93
|
+
enabled: z.boolean().default(true),
|
|
94
|
+
});
|
|
95
|
+
/**
|
|
96
|
+
* `PATCH` body: every create field is optional. `enabled: true` also clears a
|
|
97
|
+
* platform-set `disabledReason` and the failure streak.
|
|
98
|
+
*
|
|
99
|
+
* @stability experimental
|
|
100
|
+
*/
|
|
101
|
+
export const updateWebhookEndpointSchema = z.object({
|
|
102
|
+
/** The display name. */
|
|
103
|
+
name: z.string().min(1).max(WEBHOOK_NAME_MAX).optional(),
|
|
104
|
+
/** A free-text note, or `null`. */
|
|
105
|
+
description: z.string().max(WEBHOOK_DESCRIPTION_MAX).nullish(),
|
|
106
|
+
/** The receiver URL. */
|
|
107
|
+
url: httpUrlSchema.optional(),
|
|
108
|
+
/** The subscription entries: exact keys, `group.*` or `*`. */
|
|
109
|
+
eventKeys: eventKeysSchema.optional(),
|
|
110
|
+
/** Whether deliveries are sent. */
|
|
111
|
+
enabled: z.boolean().optional(),
|
|
112
|
+
});
|
|
113
|
+
/**
|
|
114
|
+
* The endpoint list.
|
|
115
|
+
*
|
|
116
|
+
* @stability experimental
|
|
117
|
+
*/
|
|
118
|
+
export const webhookEndpointListSchema = z.object({
|
|
119
|
+
/** The page of entries. */
|
|
120
|
+
items: z.array(webhookEndpointSchema),
|
|
121
|
+
});
|
|
122
|
+
/**
|
|
123
|
+
* The create response: the endpoint and its signing secret, shown once.
|
|
124
|
+
*
|
|
125
|
+
* @stability experimental
|
|
126
|
+
*/
|
|
127
|
+
export const webhookEndpointCreatedSchema = z.object({
|
|
128
|
+
/** The endpoint. */
|
|
129
|
+
endpoint: webhookEndpointSchema,
|
|
130
|
+
/** `whsec_<base64>`. Never returned again. */
|
|
131
|
+
secret: z.string(),
|
|
132
|
+
});
|
|
133
|
+
/**
|
|
134
|
+
* The rotate response: the new secret, shown once, and when the previous one
|
|
135
|
+
* stops being accepted.
|
|
136
|
+
*
|
|
137
|
+
* @stability experimental
|
|
138
|
+
*/
|
|
139
|
+
export const rotateWebhookSecretResponseSchema = z.object({
|
|
140
|
+
/** `whsec_<base64>`; shown once. */
|
|
141
|
+
secret: z.string(),
|
|
142
|
+
/** Increments on every rotation. */
|
|
143
|
+
secretVersion: z.number().int().min(1),
|
|
144
|
+
/** When the previous secret stops being accepted, or `null`. */
|
|
145
|
+
previousSecretValidUntil: isoDate.nullable(),
|
|
146
|
+
});
|
|
147
|
+
/**
|
|
148
|
+
* One delivery row (no body).
|
|
149
|
+
*
|
|
150
|
+
* @stability experimental
|
|
151
|
+
*/
|
|
152
|
+
export const webhookDeliverySchema = z.object({
|
|
153
|
+
/** The id. */
|
|
154
|
+
id: z.string(),
|
|
155
|
+
/** The endpoint. */
|
|
156
|
+
endpointId: z.string(),
|
|
157
|
+
/** The event key. */
|
|
158
|
+
eventKey: z.string(),
|
|
159
|
+
/** The event id; identical across retries. */
|
|
160
|
+
eventId: z.string(),
|
|
161
|
+
/** The lifecycle state. */
|
|
162
|
+
status: webhookDeliveryStatusSchema,
|
|
163
|
+
/** How many attempts were made. */
|
|
164
|
+
attempt: z.number().int().min(0),
|
|
165
|
+
/** The receiver's HTTP status, or `null`. */
|
|
166
|
+
responseStatus: z.number().int().nullable(),
|
|
167
|
+
/** The start of the receiver's answer, or `null`. */
|
|
168
|
+
responseSnippet: z.string().nullable(),
|
|
169
|
+
/** A short failure code, or `null`. */
|
|
170
|
+
errorCode: z.string().nullable(),
|
|
171
|
+
/** How long the last attempt took, or `null`. */
|
|
172
|
+
durationMs: z.number().int().nullable(),
|
|
173
|
+
/** When the next retry is due, or `null`. */
|
|
174
|
+
nextAttemptAt: isoDate.nullable(),
|
|
175
|
+
/** When the delivery succeeded, or `null`. */
|
|
176
|
+
deliveredAt: isoDate.nullable(),
|
|
177
|
+
/** Creation time. */
|
|
178
|
+
createdAt: isoDate,
|
|
179
|
+
});
|
|
180
|
+
/**
|
|
181
|
+
* One delivery with the body sent and the request headers (the signature is
|
|
182
|
+
* never included).
|
|
183
|
+
*
|
|
184
|
+
* @stability experimental
|
|
185
|
+
*/
|
|
186
|
+
export const webhookDeliveryDetailSchema = webhookDeliverySchema.extend({
|
|
187
|
+
/** The envelope that was sent. */
|
|
188
|
+
payload: z.unknown(),
|
|
189
|
+
/** The headers sent, without the signature. */
|
|
190
|
+
requestHeaders: z.record(z.string(), z.string()),
|
|
191
|
+
});
|
|
192
|
+
/**
|
|
193
|
+
* A page of deliveries.
|
|
194
|
+
*
|
|
195
|
+
* @stability experimental
|
|
196
|
+
*/
|
|
197
|
+
export const webhookDeliveryListSchema = z.object({
|
|
198
|
+
/** The page of entries. */
|
|
199
|
+
items: z.array(webhookDeliverySchema),
|
|
200
|
+
/** All matching entries. */
|
|
201
|
+
total: z.number().int().min(0),
|
|
202
|
+
/** The 1-based page. */
|
|
203
|
+
page: z.number().int().min(1),
|
|
204
|
+
/** Entries per page. */
|
|
205
|
+
pageSize: z.number().int().min(1),
|
|
206
|
+
/** How many pages there are. */
|
|
207
|
+
totalPages: z.number().int().min(0),
|
|
208
|
+
});
|
|
209
|
+
/**
|
|
210
|
+
* `GET .../deliveries` query.
|
|
211
|
+
*
|
|
212
|
+
* @stability experimental
|
|
213
|
+
*/
|
|
214
|
+
export const webhookDeliveryListQuerySchema = z.object({
|
|
215
|
+
/** The 1-based page. */
|
|
216
|
+
page: z.coerce.number().int().min(1).default(1),
|
|
217
|
+
/** Entries per page. */
|
|
218
|
+
pageSize: z.coerce
|
|
219
|
+
.number()
|
|
220
|
+
.int()
|
|
221
|
+
.min(1)
|
|
222
|
+
.max(WEBHOOK_DELIVERIES_PAGE_SIZE_MAX)
|
|
223
|
+
.default(WEBHOOK_DELIVERIES_PAGE_SIZE_DEFAULT),
|
|
224
|
+
/** The lifecycle state. */
|
|
225
|
+
status: webhookDeliveryStatusSchema.optional(),
|
|
226
|
+
/** The event key. */
|
|
227
|
+
eventKey: z.string().max(WEBHOOK_EVENT_KEY_MAX).optional(),
|
|
228
|
+
});
|
|
229
|
+
/**
|
|
230
|
+
* `POST .../test` response: the id of the queued ping delivery.
|
|
231
|
+
*
|
|
232
|
+
* @stability experimental
|
|
233
|
+
*/
|
|
234
|
+
export const webhookTestResponseSchema = z.object({
|
|
235
|
+
/** The queued ping delivery. */
|
|
236
|
+
deliveryId: z.string(),
|
|
237
|
+
});
|
|
238
|
+
/**
|
|
239
|
+
* One event a caller may subscribe to.
|
|
240
|
+
*
|
|
241
|
+
* @stability experimental
|
|
242
|
+
*/
|
|
243
|
+
export const webhookEventCatalogEntrySchema = z.object({
|
|
244
|
+
/** The event key. */
|
|
245
|
+
key: z.string(),
|
|
246
|
+
/** A short name. */
|
|
247
|
+
label: z.string(),
|
|
248
|
+
/** A free-text note, or `null`. */
|
|
249
|
+
description: z.string(),
|
|
250
|
+
/** The picker group heading. */
|
|
251
|
+
group: z.string(),
|
|
252
|
+
/** Who may subscribe. */
|
|
253
|
+
audience: webhookScopeSchema,
|
|
254
|
+
/** JSON Schema of the envelope's `data`. */
|
|
255
|
+
jsonSchema: z.record(z.string(), z.unknown()),
|
|
256
|
+
/** A sample `data`. */
|
|
257
|
+
example: z.unknown().optional(),
|
|
258
|
+
});
|
|
259
|
+
/**
|
|
260
|
+
* `GET .../events`: the catalog, filtered to what the caller may subscribe to.
|
|
261
|
+
*
|
|
262
|
+
* @stability experimental
|
|
263
|
+
*/
|
|
264
|
+
export const webhookEventCatalogSchema = z.object({
|
|
265
|
+
/** The page of entries. */
|
|
266
|
+
items: z.array(webhookEventCatalogEntrySchema),
|
|
267
|
+
});
|
|
268
|
+
/**
|
|
269
|
+
* The JSON body a receiver gets.
|
|
270
|
+
*
|
|
271
|
+
* @stability experimental
|
|
272
|
+
*/
|
|
273
|
+
export const webhookEnvelopeSchema = z.object({
|
|
274
|
+
/** The event id (also the `webhook-id` header). */
|
|
275
|
+
id: z.string(),
|
|
276
|
+
/** The event key. */
|
|
277
|
+
type: z.string(),
|
|
278
|
+
/** Creation time. */
|
|
279
|
+
createdAt: isoDate,
|
|
280
|
+
/** The envelope version. */
|
|
281
|
+
apiVersion: z.string(),
|
|
282
|
+
/** The organization, or `null` for a system event. */
|
|
283
|
+
org: z
|
|
284
|
+
.object({
|
|
285
|
+
/** The organization id. */
|
|
286
|
+
id: z.string(),
|
|
287
|
+
})
|
|
288
|
+
.nullable(),
|
|
289
|
+
/** The event data. */
|
|
290
|
+
data: z.unknown(),
|
|
291
|
+
});
|
|
292
|
+
//# sourceMappingURL=schemas.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/webhooks/schemas.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,iDAAiD;AACjD,gFAAgF;AAChF,EAAE;AACF,6EAA6E;AAC7E,6EAA6E;AAC7E,iFAAiF;AACjF,8BAA8B;AAC9B,gFAAgF;AAEhF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC,OAAO,EACL,oCAAoC,EACpC,gCAAgC,EAChC,yBAAyB,EACzB,uBAAuB,EACvB,qBAAqB,EACrB,yBAAyB,EACzB,sBAAsB,EACtB,gBAAgB,EAChB,cAAc,EACd,eAAe,GAChB,MAAM,gBAAgB,CAAC;AAExB,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;AAE3B;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC;AAE5G,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;AAE1F,MAAM,aAAa,GAAG,CAAC;KACpB,MAAM,EAAE;KACR,GAAG,CAAC,eAAe,CAAC;KACpB,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;IAChB,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3B,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,CAAC;IAC/D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,EAAE,wBAAwB,CAAC,CAAC;AAE/B,8DAA8D;AAC9D,MAAM,CAAC,MAAM,kBAAkB,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;AAE3D,mDAAmD;AACnD,MAAM,CAAC,MAAM,2BAA2B,GAAG,QAAQ,CAAC,yBAAyB,CAAC,CAAC;AAE/E;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,cAAc;IACd,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,mBAAmB;IACnB,KAAK,EAAE,kBAAkB;IACzB,sDAAsD;IACtD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,sDAAsD;IACtD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,wBAAwB;IACxB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,mCAAmC;IACnC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,wBAAwB;IACxB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,8DAA8D;IAC9D,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC9B,mCAAmC;IACnC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,oHAAoH;IACpH,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,6EAA6E;IAC7E,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5C,oCAAoC;IACpC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACtC,uFAAuF;IACvF,mBAAmB,EAAE,OAAO,CAAC,QAAQ,EAAE;IACvC,iDAAiD;IACjD,cAAc,EAAE,OAAO,CAAC,QAAQ,EAAE;IAClC,mDAAmD;IACnD,aAAa,EAAE,OAAO,CAAC,QAAQ,EAAE;IACjC,qBAAqB;IACrB,SAAS,EAAE,OAAO;IAClB,mBAAmB;IACnB,SAAS,EAAE,OAAO;CACnB,CAAC,CAAC;AAKH;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,wBAAwB;IACxB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC;IAC7C,mCAAmC;IACnC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,OAAO,EAAE;IAC9D,wBAAwB;IACxB,GAAG,EAAE,aAAa;IAClB,8DAA8D;IAC9D,SAAS,EAAE,eAAe;IAC1B,mCAAmC;IACnC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC;CACnC,CAAC,CAAC;AAOH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,wBAAwB;IACxB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE;IACxD,mCAAmC;IACnC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,OAAO,EAAE;IAC9D,wBAAwB;IACxB,GAAG,EAAE,aAAa,CAAC,QAAQ,EAAE;IAC7B,8DAA8D;IAC9D,SAAS,EAAE,eAAe,CAAC,QAAQ,EAAE;IACrC,mCAAmC;IACnC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAKH;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,2BAA2B;IAC3B,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC;CACtC,CAAC,CAAC;AAKH;;;;GAIG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IACnD,oBAAoB;IACpB,QAAQ,EAAE,qBAAqB;IAC/B,8CAA8C;IAC9C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;CACnB,CAAC,CAAC;AAKH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,CAAC,MAAM,CAAC;IACxD,oCAAoC;IACpC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,oCAAoC;IACpC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACtC,gEAAgE;IAChE,wBAAwB,EAAE,OAAO,CAAC,QAAQ,EAAE;CAC7C,CAAC,CAAC;AAKH;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,cAAc;IACd,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,oBAAoB;IACpB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,qBAAqB;IACrB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,8CAA8C;IAC9C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,2BAA2B;IAC3B,MAAM,EAAE,2BAA2B;IACnC,mCAAmC;IACnC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAChC,6CAA6C;IAC7C,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAC3C,qDAAqD;IACrD,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtC,uCAAuC;IACvC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,iDAAiD;IACjD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACvC,6CAA6C;IAC7C,aAAa,EAAE,OAAO,CAAC,QAAQ,EAAE;IACjC,8CAA8C;IAC9C,WAAW,EAAE,OAAO,CAAC,QAAQ,EAAE;IAC/B,qBAAqB;IACrB,SAAS,EAAE,OAAO;CACnB,CAAC,CAAC;AAKH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,qBAAqB,CAAC,MAAM,CAAC;IACtE,kCAAkC;IAClC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,+CAA+C;IAC/C,cAAc,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;CACjD,CAAC,CAAC;AAKH;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,2BAA2B;IAC3B,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC;IACrC,4BAA4B;IAC5B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC9B,wBAAwB;IACxB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC7B,wBAAwB;IACxB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACjC,gCAAgC;IAChC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CACpC,CAAC,CAAC;AAKH;;;;GAIG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,wBAAwB;IACxB,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/C,wBAAwB;IACxB,QAAQ,EAAE,CAAC,CAAC,MAAM;SACf,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,gCAAgC,CAAC;SACrC,OAAO,CAAC,oCAAoC,CAAC;IAChD,2BAA2B;IAC3B,MAAM,EAAE,2BAA2B,CAAC,QAAQ,EAAE;IAC9C,qBAAqB;IACrB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,QAAQ,EAAE;CAC3D,CAAC,CAAC;AAKH;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,gCAAgC;IAChC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;CACvB,CAAC,CAAC;AAKH;;;;GAIG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,qBAAqB;IACrB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,oBAAoB;IACpB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,mCAAmC;IACnC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,gCAAgC;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,yBAAyB;IACzB,QAAQ,EAAE,kBAAkB;IAC5B,4CAA4C;IAC5C,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;IAC7C,uBAAuB;IACvB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAChC,CAAC,CAAC;AAKH;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,2BAA2B;IAC3B,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,8BAA8B,CAAC;CAC/C,CAAC,CAAC;AAKH;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,mDAAmD;IACnD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,qBAAqB;IACrB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,qBAAqB;IACrB,SAAS,EAAE,OAAO;IAClB,4BAA4B;IAC5B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,sDAAsD;IACtD,GAAG,EAAE,CAAC;SACH,MAAM,CAAC;QACN,2BAA2B;QAC3B,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;KACf,CAAC;SACD,QAAQ,EAAE;IACb,sBAAsB;IACtB,IAAI,EAAE,CAAC,CAAC,OAAO,EAAE;CAClB,CAAC,CAAC"}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Input of {@link signWebhookPayload}.
|
|
3
|
+
*
|
|
4
|
+
* @stability experimental
|
|
5
|
+
*/
|
|
6
|
+
export interface SignWebhookPayloadInput {
|
|
7
|
+
/** The signing secret, `whsec_<base64>`. */
|
|
8
|
+
secret: string;
|
|
9
|
+
/** The `webhook-id` header value. */
|
|
10
|
+
id: string;
|
|
11
|
+
/** The `webhook-timestamp` header value (unix seconds). */
|
|
12
|
+
timestamp: number | string;
|
|
13
|
+
/** The exact request body. */
|
|
14
|
+
body: string;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Sign a body. Returns one `webhook-signature` entry, `v1,<base64>`.
|
|
18
|
+
*
|
|
19
|
+
* @stability experimental
|
|
20
|
+
*/
|
|
21
|
+
export declare function signWebhookPayload(input: SignWebhookPayloadInput): Promise<string>;
|
|
22
|
+
/**
|
|
23
|
+
* Input of {@link verifyWebhookSignature}. Give `secret`, or `secrets` to
|
|
24
|
+
* accept several (a rotation overlap).
|
|
25
|
+
*
|
|
26
|
+
* @stability experimental
|
|
27
|
+
*/
|
|
28
|
+
export interface VerifyWebhookSignatureInput {
|
|
29
|
+
/** One signing secret (`whsec_...`). */
|
|
30
|
+
secret?: string;
|
|
31
|
+
/** Several secrets, for a rotation overlap. */
|
|
32
|
+
secrets?: readonly string[];
|
|
33
|
+
/** The `webhook-id` header value. */
|
|
34
|
+
id: string;
|
|
35
|
+
/** The `webhook-timestamp` header value. */
|
|
36
|
+
timestamp: number | string;
|
|
37
|
+
/** The exact, unparsed request body. */
|
|
38
|
+
body: string;
|
|
39
|
+
/** The `webhook-signature` header: space separated `v1,<base64>` entries. */
|
|
40
|
+
signatureHeader: string;
|
|
41
|
+
/** Allowed clock difference in seconds (default 300). */
|
|
42
|
+
toleranceSeconds?: number;
|
|
43
|
+
/** The current time in milliseconds (tests). */
|
|
44
|
+
now?: number;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Verify a delivery. True when the timestamp is within the tolerance and any
|
|
48
|
+
* `v1` entry of the header matches a signature made with any given secret.
|
|
49
|
+
* Comparison is constant time. Never throws on malformed input.
|
|
50
|
+
*
|
|
51
|
+
* @stability experimental
|
|
52
|
+
*/
|
|
53
|
+
export declare function verifyWebhookSignature(input: VerifyWebhookSignatureInput): Promise<boolean>;
|
|
54
|
+
//# sourceMappingURL=signature.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"signature.d.ts","sourceRoot":"","sources":["../../../src/webhooks/signature.ts"],"names":[],"mappings":"AAiDA;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,4CAA4C;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,2DAA2D;IAC3D,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,MAAM,CAAC,CAGxF;AAED;;;;;GAKG;AACH,MAAM,WAAW,2BAA2B;IAC1C,wCAAwC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,+CAA+C;IAC/C,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,qCAAqC;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,4CAA4C;IAC5C,SAAS,EAAE,MAAM,GAAG,MAAM,CAAC;IAC3B,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,6EAA6E;IAC7E,eAAe,EAAE,MAAM,CAAC;IACxB,yDAAyD;IACzD,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gDAAgD;IAChD,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;;;;GAMG;AACH,wBAAsB,sBAAsB,CAAC,KAAK,EAAE,2BAA2B,GAAG,OAAO,CAAC,OAAO,CAAC,CAkCjG"}
|