relay-surfih-sdk 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +38 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/sign.d.ts +5 -2
- package/dist/sign.d.ts.map +1 -1
- package/dist/sign.js +12 -3
- package/dist/sign.js.map +1 -1
- package/dist/webhook.d.ts +7 -5
- package/dist/webhook.d.ts.map +1 -1
- package/dist/webhook.js +31 -5
- package/dist/webhook.js.map +1 -1
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -61,6 +61,42 @@ await relay.events.submit(
|
|
|
61
61
|
{ idempotencyKey: "order-ord_1" },
|
|
62
62
|
);
|
|
63
63
|
|
|
64
|
+
// Throttle: same key can fire again after the previous run closes.
|
|
65
|
+
await relay.events.submit(
|
|
66
|
+
queueId,
|
|
67
|
+
{
|
|
68
|
+
event_type: "notify.user",
|
|
69
|
+
event: { user_id: "42" },
|
|
70
|
+
delay_seconds: 60,
|
|
71
|
+
key_mode: "throttle",
|
|
72
|
+
},
|
|
73
|
+
{ idempotencyKey: "notify-user-42" },
|
|
74
|
+
);
|
|
75
|
+
|
|
76
|
+
// Debounce: while idle, each submit replaces the payload and reschedules.
|
|
77
|
+
await relay.events.submit(
|
|
78
|
+
queueId,
|
|
79
|
+
{
|
|
80
|
+
event_type: "search.index",
|
|
81
|
+
event: { doc_id: "d1", rev: 2 },
|
|
82
|
+
delay_seconds: 5,
|
|
83
|
+
key_mode: "debounce",
|
|
84
|
+
},
|
|
85
|
+
{ idempotencyKey: "index-d1" },
|
|
86
|
+
);
|
|
87
|
+
|
|
88
|
+
// Batch: accumulate payloads; webhook receives `submissions`.
|
|
89
|
+
await relay.events.submit(
|
|
90
|
+
queueId,
|
|
91
|
+
{
|
|
92
|
+
event_type: "search.index",
|
|
93
|
+
event: { doc_id: "d1", rev: 3 },
|
|
94
|
+
delay_seconds: 5,
|
|
95
|
+
key_mode: "batch",
|
|
96
|
+
},
|
|
97
|
+
{ idempotencyKey: "index-d1" },
|
|
98
|
+
);
|
|
99
|
+
|
|
64
100
|
const event = await relay.events.get(accepted.event_id);
|
|
65
101
|
const withAttempts = await relay.events.get(accepted.event_id, { attempts: true });
|
|
66
102
|
// withAttempts.attempts, withAttempts.checkpoints
|
|
@@ -77,7 +113,7 @@ await relay.events.checkpoints(accepted.event_id, [
|
|
|
77
113
|
]);
|
|
78
114
|
```
|
|
79
115
|
|
|
80
|
-
`send_message` events must carry only `{ notification_id }` in `event`.
|
|
116
|
+
`key_mode` is `once` (default), `throttle`, `debounce`, or `batch`. `send_message` events must carry only `{ notification_id }` in `event`.
|
|
81
117
|
|
|
82
118
|
### Schedules
|
|
83
119
|
|
|
@@ -131,7 +167,7 @@ delivery.attempt;
|
|
|
131
167
|
delivery.idempotencyKey;
|
|
132
168
|
```
|
|
133
169
|
|
|
134
|
-
`Idempotency-Key` is unsigned. A request with that header swapped still verifies. Dedupe on the signed pair `(event_id, attempt)` as well as on the idempotency key. When `deliveryPublicKeyPem` is set, the Ed25519 signature covers `v1.{timestamp}.{eventId}.{sha256_hex(body)}` and
|
|
170
|
+
`Idempotency-Key` is unsigned. A request with that header swapped still verifies. Dedupe on the signed pair `(event_id, attempt)` as well as on the idempotency key. Every delivery must include a fresh `X-Timestamp` (±300 s); the HMAC covers `apiKey.timestamp.rawBody`. When `deliveryPublicKeyPem` is set, the Ed25519 signature covers `v1.{timestamp}.{eventId}.{sha256_hex(body)}` and `X-Event-Timestamp` must also be within ±300 seconds.
|
|
135
171
|
|
|
136
172
|
A header value that arrives as a `string[]` must contain exactly one entry.
|
|
137
173
|
|
package/dist/index.d.ts
CHANGED
|
@@ -10,6 +10,6 @@ export type { VerifiedWebhook, VerifyWebhookOptions } from "./webhook.js";
|
|
|
10
10
|
export type { WebhookHeaders } from "./read-header.js";
|
|
11
11
|
export { RelayError, WebhookVerificationError } from "./errors.js";
|
|
12
12
|
export type { WebhookVerificationReason } from "./errors.js";
|
|
13
|
-
export type { AcceptedEventResponse, ApiErrorObject, ApiErrorResponse, Checkpoint, CheckpointInput, ClientResultError, ClientStatus, CodedError, CreateQueueRequest, CreateQueueResponse, CreateScheduleRequest, DeletedScheduleResponse, DeliveryAttempt, DeliveryTiming, Event, EventQuotaExceededResponse, EventResultResponse, EventWithAttempts, GetEventQuery, GetEventResponse, IdempotencyConflictResponse, JsonObject, JsonPrimitive, JsonValue, PostCheckpointsRequest, PostCheckpointsResponse, PostEventResultRequest, Queue, QueueRules, RateLimitResponse, RelayErrorCode, RelayErrorStatus, Rfc3339, Schedule, ScheduleLimitExceededResponse, ScheduleListResponse, ScheduleResponse, SendMessageEvent, ServerStatus, SubmitEventRequest, SubmitSendMessageRequest, SubscriptionRequiredResponse, ValidationErrorResponse, ValidationIssue, WebhookAuthMode, WebhookDeliveryBody, } from "relay-types";
|
|
14
|
-
export { CLIENT_STATUSES, DEFAULT_QUEUE_RULES, MAX_CHECKPOINT_BATCH, MAX_CHECKPOINTS_PER_EVENT, MAX_DELAY_SECONDS, MAX_DELIVERY_DELAY_DAYS, MAX_IDEMPOTENCY_KEY_LENGTH, MAX_SCHEDULES_PER_CLIENT, SERVER_STATUSES, TIMESTAMP_SKEW_SECONDS, } from "relay-types";
|
|
13
|
+
export type { AcceptedEventResponse, ApiErrorObject, ApiErrorResponse, BatchSubmission, Checkpoint, CheckpointInput, ClientResultError, ClientStatus, CodedError, CreateQueueRequest, CreateQueueResponse, CreateScheduleRequest, DeletedScheduleResponse, DeliveryAttempt, DeliveryTiming, Event, EventQuotaExceededResponse, EventResultResponse, EventWithAttempts, GetEventQuery, GetEventResponse, IdempotencyConflictResponse, JsonObject, JsonPrimitive, JsonValue, KeyMode, PostCheckpointsRequest, PostCheckpointsResponse, PostEventResultRequest, Queue, QueueRules, RateLimitResponse, RelayErrorCode, RelayErrorStatus, Rfc3339, Schedule, ScheduleLimitExceededResponse, ScheduleListResponse, ScheduleResponse, SendMessageEvent, ServerStatus, SubmitEventRequest, SubmitSendMessageRequest, SubscriptionRequiredResponse, ValidationErrorResponse, ValidationIssue, WebhookAuthMode, WebhookDeliveryBody, } from "relay-types";
|
|
14
|
+
export { CLIENT_STATUSES, DEFAULT_QUEUE_RULES, KEY_MODES, MAX_BATCH_SUBMISSIONS, MAX_CHECKPOINT_BATCH, MAX_CHECKPOINTS_PER_EVENT, MAX_DELAY_SECONDS, MAX_DELIVERY_DELAY_DAYS, MAX_IDEMPOTENCY_KEY_LENGTH, MAX_SCHEDULES_PER_CLIENT, SERVER_STATUSES, TIMESTAMP_SKEW_SECONDS, } from "relay-types";
|
|
15
15
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC5D,YAAY,EACV,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,KAAK,EACL,WAAW,EACX,UAAU,EACV,WAAW,EACX,cAAc,EACd,cAAc,EACd,MAAM,GACP,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,YAAY,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAC1E,YAAY,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,OAAO,EAAE,UAAU,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AACnE,YAAY,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAE7D,YAAY,EACV,qBAAqB,EACrB,cAAc,EACd,gBAAgB,EAChB,UAAU,EACV,eAAe,EACf,iBAAiB,EACjB,YAAY,EACZ,UAAU,EACV,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,eAAe,EACf,cAAc,EACd,KAAK,EACL,0BAA0B,EAC1B,mBAAmB,EACnB,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,2BAA2B,EAC3B,UAAU,EACV,aAAa,EACb,SAAS,EACT,sBAAsB,EACtB,uBAAuB,EACvB,sBAAsB,EACtB,KAAK,EACL,UAAU,EACV,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,OAAO,EACP,QAAQ,EACR,6BAA6B,EAC7B,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,EACZ,kBAAkB,EAClB,wBAAwB,EACxB,4BAA4B,EAC5B,uBAAuB,EACvB,eAAe,EACf,eAAe,EACf,mBAAmB,GACpB,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,uBAAuB,EACvB,0BAA0B,EAC1B,wBAAwB,EACxB,eAAe,EACf,sBAAsB,GACvB,MAAM,aAAa,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC5D,YAAY,EACV,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,KAAK,EACL,WAAW,EACX,UAAU,EACV,WAAW,EACX,cAAc,EACd,cAAc,EACd,MAAM,GACP,MAAM,aAAa,CAAC;AAErB,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,YAAY,EAAE,eAAe,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAC1E,YAAY,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,OAAO,EAAE,UAAU,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AACnE,YAAY,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAE7D,YAAY,EACV,qBAAqB,EACrB,cAAc,EACd,gBAAgB,EAChB,eAAe,EACf,UAAU,EACV,eAAe,EACf,iBAAiB,EACjB,YAAY,EACZ,UAAU,EACV,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,eAAe,EACf,cAAc,EACd,KAAK,EACL,0BAA0B,EAC1B,mBAAmB,EACnB,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,2BAA2B,EAC3B,UAAU,EACV,aAAa,EACb,SAAS,EACT,OAAO,EACP,sBAAsB,EACtB,uBAAuB,EACvB,sBAAsB,EACtB,KAAK,EACL,UAAU,EACV,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EAChB,OAAO,EACP,QAAQ,EACR,6BAA6B,EAC7B,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,EACZ,kBAAkB,EAClB,wBAAwB,EACxB,4BAA4B,EAC5B,uBAAuB,EACvB,eAAe,EACf,eAAe,EACf,mBAAmB,GACpB,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,SAAS,EACT,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,uBAAuB,EACvB,0BAA0B,EAC1B,wBAAwB,EACxB,eAAe,EACf,sBAAsB,GACvB,MAAM,aAAa,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -6,5 +6,5 @@
|
|
|
6
6
|
export { createRelay, DEFAULT_BASE_URL } from "./client.js";
|
|
7
7
|
export { verifyWebhook } from "./webhook.js";
|
|
8
8
|
export { RelayError, WebhookVerificationError } from "./errors.js";
|
|
9
|
-
export { CLIENT_STATUSES, DEFAULT_QUEUE_RULES, MAX_CHECKPOINT_BATCH, MAX_CHECKPOINTS_PER_EVENT, MAX_DELAY_SECONDS, MAX_DELIVERY_DELAY_DAYS, MAX_IDEMPOTENCY_KEY_LENGTH, MAX_SCHEDULES_PER_CLIENT, SERVER_STATUSES, TIMESTAMP_SKEW_SECONDS, } from "relay-types";
|
|
9
|
+
export { CLIENT_STATUSES, DEFAULT_QUEUE_RULES, KEY_MODES, MAX_BATCH_SUBMISSIONS, MAX_CHECKPOINT_BATCH, MAX_CHECKPOINTS_PER_EVENT, MAX_DELAY_SECONDS, MAX_DELIVERY_DELAY_DAYS, MAX_IDEMPOTENCY_KEY_LENGTH, MAX_SCHEDULES_PER_CLIENT, SERVER_STATUSES, TIMESTAMP_SKEW_SECONDS, } from "relay-types";
|
|
10
10
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAc5D,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAI7C,OAAO,EAAE,UAAU,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAc5D,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAI7C,OAAO,EAAE,UAAU,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAsDnE,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,SAAS,EACT,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,iBAAiB,EACjB,uBAAuB,EACvB,0BAA0B,EAC1B,wBAAwB,EACxB,eAAe,EACf,sBAAsB,GACvB,MAAM,aAAa,CAAC"}
|
package/dist/sign.d.ts
CHANGED
|
@@ -18,8 +18,11 @@ export declare function signingBytes(apiKey: string, timestamp: string, method:
|
|
|
18
18
|
export declare function unixSeconds(now: () => number): string;
|
|
19
19
|
/** `sha256=` + lowercase hex. `message` may be a Uint8Array view. */
|
|
20
20
|
export declare function hmacSha256Header(secret: string, message: Uint8Array): string;
|
|
21
|
-
/**
|
|
22
|
-
|
|
21
|
+
/**
|
|
22
|
+
* Webhook HMAC over `apiKey + "." + timestamp + "." + rawBody` as five updates.
|
|
23
|
+
* `rawBody` may be a view.
|
|
24
|
+
*/
|
|
25
|
+
export declare function webhookHmacHeader(secret: string, apiKey: string, timestamp: string, rawBody: Uint8Array): string;
|
|
23
26
|
/** Lowercase hex SHA-256. `bytes` may be a Uint8Array view. */
|
|
24
27
|
export declare function sha256Hex(bytes: Uint8Array): string;
|
|
25
28
|
export declare function timingSafeEqualText(left: string, right: string): boolean;
|
package/dist/sign.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sign.d.ts","sourceRoot":"","sources":["../src/sign.ts"],"names":[],"mappings":"AAAA,OAAO,EAQL,KAAK,SAAS,EACf,MAAM,aAAa,CAAC;AAGrB,eAAO,MAAM,sBAAsB,0FACsD,CAAC;AAO1F,2FAA2F;AAC3F,MAAM,MAAM,MAAM,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAErE,MAAM,MAAM,MAAM,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAErE,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAMvD;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQnD;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAexD;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAKnD;AAED,4FAA4F;AAC5F,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAKpE;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,UAAU,CAIlE;AAED,wBAAgB,YAAY,CAC1B,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,UAAU,GAClB,UAAU,CAQZ;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,MAAM,GAAG,MAAM,CAUrD;AAED,qEAAqE;AACrE,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,MAAM,CAG5E;AAED
|
|
1
|
+
{"version":3,"file":"sign.d.ts","sourceRoot":"","sources":["../src/sign.ts"],"names":[],"mappings":"AAAA,OAAO,EAQL,KAAK,SAAS,EACf,MAAM,aAAa,CAAC;AAGrB,eAAO,MAAM,sBAAsB,0FACsD,CAAC;AAO1F,2FAA2F;AAC3F,MAAM,MAAM,MAAM,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAErE,MAAM,MAAM,MAAM,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAErE,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAMvD;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAQnD;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAexD;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAKnD;AAED,4FAA4F;AAC5F,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAKpE;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,UAAU,CAIlE;AAED,wBAAgB,YAAY,CAC1B,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,UAAU,GAClB,UAAU,CAQZ;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,MAAM,GAAG,MAAM,CAUrD;AAED,qEAAqE;AACrE,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,MAAM,CAG5E;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,UAAU,GAClB,MAAM,CASR;AAED,+DAA+D;AAC/D,wBAAgB,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAEnD;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAKxE;AAED,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAc5D;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAc3D;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,GAAG,MAAM,CAMvE;AAED,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAU3D;AAED,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAUzG;AAQD,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAGjD;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQjD"}
|
package/dist/sign.js
CHANGED
|
@@ -86,9 +86,18 @@ export function hmacSha256Header(secret, message) {
|
|
|
86
86
|
const hex = createHmac("sha256", secret).update(message).digest("hex");
|
|
87
87
|
return `sha256=${hex}`;
|
|
88
88
|
}
|
|
89
|
-
/**
|
|
90
|
-
|
|
91
|
-
|
|
89
|
+
/**
|
|
90
|
+
* Webhook HMAC over `apiKey + "." + timestamp + "." + rawBody` as five updates.
|
|
91
|
+
* `rawBody` may be a view.
|
|
92
|
+
*/
|
|
93
|
+
export function webhookHmacHeader(secret, apiKey, timestamp, rawBody) {
|
|
94
|
+
const hex = createHmac("sha256", secret)
|
|
95
|
+
.update(apiKey)
|
|
96
|
+
.update(".")
|
|
97
|
+
.update(timestamp)
|
|
98
|
+
.update(".")
|
|
99
|
+
.update(rawBody)
|
|
100
|
+
.digest("hex");
|
|
92
101
|
return `sha256=${hex}`;
|
|
93
102
|
}
|
|
94
103
|
/** Lowercase hex SHA-256. `bytes` may be a Uint8Array view. */
|
package/dist/sign.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sign.js","sourceRoot":"","sources":["../src/sign.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,UAAU,EACV,gBAAgB,EAChB,eAAe,EACf,IAAI,IAAI,UAAU,EAClB,eAAe,EACf,MAAM,IAAI,YAAY,GAEvB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAEzD,MAAM,CAAC,MAAM,sBAAsB,GACjC,uFAAuF,CAAC;AAE1F,MAAM,iBAAiB,GAAG,oDAAoD,CAAC;AAC/E,MAAM,gBAAgB,GAAG,yDAAyD,CAAC;AACnF,MAAM,WAAW,GAAG,uBAAuB,CAAC;AAC5C,MAAM,WAAW,GAAG,uBAAuB,CAAC;AAO5C,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACjC,IAAI,IAAI,GAAG,IAAI,IAAI,IAAI,GAAG,IAAI;YAAE,OAAO,KAAK,CAAC;IAC/C,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,MAAc;IACzC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,SAAS,CAAC,mCAAmC,CAAC,CAAC;IAC3D,CAAC;IACD,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,SAAS,CAAC,gCAAgC,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,GAAW;IAC9C,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,MAAM,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAC;IACzD,CAAC;IACD,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IAC3B,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,SAAS,CAAC,kCAAkC,CAAC,CAAC;IAC1D,CAAC;IACD,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,MAAM,GAAG,0BAA0B,EAAE,CAAC;QACrD,MAAM,IAAI,SAAS,CAAC,+CAA+C,CAAC,CAAC;IACvE,CAAC;IACD,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,SAAS,CAAC,wCAAwC,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,MAAc;IACzC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,SAAS,CAAC,mCAAmC,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,4FAA4F;AAC5F,MAAM,UAAU,sBAAsB,CAAC,GAAuB;IAC5D,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO;IAC9B,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1D,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAC;IACrE,CAAC;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,IAAyB;IACpD,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACpE,IAAI,IAAI,YAAY,UAAU;QAAE,OAAO,IAAI,CAAC;IAC5C,MAAM,IAAI,SAAS,CAAC,wCAAwC,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,MAAc,EACd,SAAiB,EACjB,MAAc,EACd,YAAoB,EACpB,OAAmB;IAEnB,MAAM,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CACrC,GAAG,MAAM,IAAI,SAAS,IAAI,MAAM,CAAC,WAAW,EAAE,IAAI,YAAY,GAAG,CAClE,CAAC;IACF,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3D,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACnB,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAChC,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,GAAiB;IAC3C,MAAM,EAAE,GAAG,GAAG,EAAE,CAAC;IACjB,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;QACnD,MAAM,IAAI,SAAS,CAAC,qDAAqD,CAAC,CAAC;IAC7E,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IACtC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;QAClD,MAAM,IAAI,SAAS,CAAC,qDAAqD,CAAC,CAAC;IAC7E,CAAC;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;AACzB,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,gBAAgB,CAAC,MAAc,EAAE,OAAmB;IAClE,MAAM,GAAG,GAAG,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACvE,OAAO,UAAU,GAAG,EAAE,CAAC;AACzB,CAAC;AAED
|
|
1
|
+
{"version":3,"file":"sign.js","sourceRoot":"","sources":["../src/sign.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,UAAU,EACV,gBAAgB,EAChB,eAAe,EACf,IAAI,IAAI,UAAU,EAClB,eAAe,EACf,MAAM,IAAI,YAAY,GAEvB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAC;AAEzD,MAAM,CAAC,MAAM,sBAAsB,GACjC,uFAAuF,CAAC;AAE1F,MAAM,iBAAiB,GAAG,oDAAoD,CAAC;AAC/E,MAAM,gBAAgB,GAAG,yDAAyD,CAAC;AACnF,MAAM,WAAW,GAAG,uBAAuB,CAAC;AAC5C,MAAM,WAAW,GAAG,uBAAuB,CAAC;AAO5C,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACjC,IAAI,IAAI,GAAG,IAAI,IAAI,IAAI,GAAG,IAAI;YAAE,OAAO,KAAK,CAAC;IAC/C,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,MAAc;IACzC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,SAAS,CAAC,mCAAmC,CAAC,CAAC;IAC3D,CAAC;IACD,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,SAAS,CAAC,gCAAgC,CAAC,CAAC;IACxD,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,GAAW;IAC9C,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5B,MAAM,IAAI,SAAS,CAAC,iCAAiC,CAAC,CAAC;IACzD,CAAC;IACD,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC;IAC3B,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,SAAS,CAAC,kCAAkC,CAAC,CAAC;IAC1D,CAAC;IACD,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,MAAM,GAAG,0BAA0B,EAAE,CAAC;QACrD,MAAM,IAAI,SAAS,CAAC,+CAA+C,CAAC,CAAC;IACvE,CAAC;IACD,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,SAAS,CAAC,wCAAwC,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,MAAc;IACzC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,SAAS,CAAC,mCAAmC,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,4FAA4F;AAC5F,MAAM,UAAU,sBAAsB,CAAC,GAAuB;IAC5D,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO;IAC9B,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC1D,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAC;IACrE,CAAC;AACH,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,IAAyB;IACpD,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACpE,IAAI,IAAI,YAAY,UAAU;QAAE,OAAO,IAAI,CAAC;IAC5C,MAAM,IAAI,SAAS,CAAC,wCAAwC,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,MAAc,EACd,SAAiB,EACjB,MAAc,EACd,YAAoB,EACpB,OAAmB;IAEnB,MAAM,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CACrC,GAAG,MAAM,IAAI,SAAS,IAAI,MAAM,CAAC,WAAW,EAAE,IAAI,YAAY,GAAG,CAClE,CAAC;IACF,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3D,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IACnB,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAChC,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,GAAiB;IAC3C,MAAM,EAAE,GAAG,GAAG,EAAE,CAAC;IACjB,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;QACnD,MAAM,IAAI,SAAS,CAAC,qDAAqD,CAAC,CAAC;IAC7E,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;IACtC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;QAClD,MAAM,IAAI,SAAS,CAAC,qDAAqD,CAAC,CAAC;IAC7E,CAAC;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC;AACzB,CAAC;AAED,qEAAqE;AACrE,MAAM,UAAU,gBAAgB,CAAC,MAAc,EAAE,OAAmB;IAClE,MAAM,GAAG,GAAG,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACvE,OAAO,UAAU,GAAG,EAAE,CAAC;AACzB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAC/B,MAAc,EACd,MAAc,EACd,SAAiB,EACjB,OAAmB;IAEnB,MAAM,GAAG,GAAG,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC;SACrC,MAAM,CAAC,MAAM,CAAC;SACd,MAAM,CAAC,GAAG,CAAC;SACX,MAAM,CAAC,SAAS,CAAC;SACjB,MAAM,CAAC,GAAG,CAAC;SACX,MAAM,CAAC,OAAO,CAAC;SACf,MAAM,CAAC,KAAK,CAAC,CAAC;IACjB,OAAO,UAAU,GAAG,EAAE,CAAC;AACzB,CAAC;AAED,+DAA+D;AAC/D,MAAM,UAAU,SAAS,CAAC,KAAiB;IACzC,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,IAAY,EAAE,KAAa;IAC7D,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7B,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IACxC,OAAO,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,GAAW;IAC/C,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,uBAAuB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACvG,MAAM,IAAI,SAAS,CAAC,iBAAiB,CAAC,CAAC;IACzC,CAAC;IACD,IAAI,GAAc,CAAC;IACnB,IAAI,CAAC;QACH,GAAG,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,SAAS,CAAC,iBAAiB,CAAC,CAAC;IACzC,CAAC;IACD,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;QAClE,MAAM,IAAI,SAAS,CAAC,iBAAiB,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,GAAW;IAC9C,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/F,MAAM,IAAI,SAAS,CAAC,gBAAgB,CAAC,CAAC;IACxC,CAAC;IACD,IAAI,GAAc,CAAC;IACnB,IAAI,CAAC;QACH,GAAG,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,SAAS,CAAC,gBAAgB,CAAC,CAAC;IACxC,CAAC;IACD,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,GAAG,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;QACjE,MAAM,IAAI,SAAS,CAAC,gBAAgB,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,GAAc,EAAE,OAAmB;IAC7D,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IACjD,IAAI,SAAS,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;QAC5B,MAAM,IAAI,SAAS,CAAC,oCAAoC,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,WAAW,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,KAAa;IACjD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,IAAI,SAAS,CAAC,sBAAsB,CAAC,CAAC;IAC9C,CAAC;IACD,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7B,IAAI,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC;QAAE,OAAO,OAAO,CAAC;IAC9C,IAAI,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,sBAAsB,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;QAC/F,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,MAAM,IAAI,SAAS,CAAC,sBAAsB,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,SAAoB,EAAE,OAAmB,EAAE,MAAc;IAC9F,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC;QAAE,OAAO,KAAK,CAAC;IACjD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAChD,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC;QAAE,OAAO,KAAK,CAAC;IACnD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACjD,IAAI,CAAC;QACH,OAAO,YAAY,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IAC3D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,SAAS,sBAAsB,CAAC,OAAe;IAC7C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC;QAAE,OAAO,KAAK,CAAC;IAC7C,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC/C,OAAO,OAAO,CAAC,MAAM,KAAK,EAAE,IAAI,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,OAAO,CAAC;AACzE,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,MAAc;IACvC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,GAAW;IACvC,MAAM,GAAG,GAAG,qBAAqB,CAAC,GAAG,CAAC,CAAC;IACvC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE,CAAC;QAC/B,MAAM,IAAI,SAAS,CAAC,yBAAyB,CAAC,CAAC;IACjD,CAAC;IACD,OAAO,KAAK,EAAE,KAAK,EAAE,EAAE;QACrB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC,OAAO,qBAAqB,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC,CAAC;AACJ,CAAC"}
|
package/dist/webhook.d.ts
CHANGED
|
@@ -7,8 +7,9 @@ import { type WebhookHeaders } from "./read-header.js";
|
|
|
7
7
|
* Treat it as attacker-controlled. Dedupe on the signed pair `(event_id, attempt)` as well
|
|
8
8
|
* as on the idempotency key. A swapped `Idempotency-Key` still verifies.
|
|
9
9
|
*
|
|
10
|
-
* `now` returns milliseconds since the Unix epoch (`Date.now`). It is used
|
|
11
|
-
* `
|
|
10
|
+
* `now` returns milliseconds since the Unix epoch (`Date.now`). It is used for the required
|
|
11
|
+
* `X-Timestamp` skew check (±300 s) and, when `deliveryPublicKeyPem` is set, for
|
|
12
|
+
* `X-Event-Timestamp` as well.
|
|
12
13
|
*/
|
|
13
14
|
export interface VerifyWebhookOptions {
|
|
14
15
|
apiKey: string;
|
|
@@ -31,9 +32,10 @@ export interface VerifiedWebhook<T extends JsonValue = JsonValue> {
|
|
|
31
32
|
/**
|
|
32
33
|
* Verify a relay → webhook delivery.
|
|
33
34
|
*
|
|
34
|
-
* Order: required headers, constant-time API key compare,
|
|
35
|
-
*
|
|
36
|
-
*
|
|
35
|
+
* Order: required headers (including `X-Timestamp`), constant-time API key compare,
|
|
36
|
+
* reject `|now - X-Timestamp| > 300`, HMAC over `apiKey + "." + timestamp + "." + rawBody`
|
|
37
|
+
* (five updates), optional Ed25519 delivery signature and ±300s skew on `X-Event-Timestamp`,
|
|
38
|
+
* then JSON parse, then `event_id` / `queue_id` / `attempt` against the signed headers.
|
|
37
39
|
*
|
|
38
40
|
* `Idempotency-Key` is unsigned. Dedupe on `(event_id, attempt)` too. If a header value is a
|
|
39
41
|
* `string[]` whose length is not 1, verification fails.
|
package/dist/webhook.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"webhook.d.ts","sourceRoot":"","sources":["../src/webhook.ts"],"names":[],"mappings":"AACA,OAAO,EAA0B,KAAK,SAAS,EAAE,KAAK,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAE/F,OAAO,EAAqB,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAY1E
|
|
1
|
+
{"version":3,"file":"webhook.d.ts","sourceRoot":"","sources":["../src/webhook.ts"],"names":[],"mappings":"AACA,OAAO,EAA0B,KAAK,SAAS,EAAE,KAAK,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAE/F,OAAO,EAAqB,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAY1E;;;;;;;;;;GAUG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,kGAAkG;IAClG,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC;IAC7B,OAAO,EAAE,cAAc,CAAC;IACxB,4FAA4F;IAC5F,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,iEAAiE;IACjE,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAC9D,IAAI,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,EAC3D,OAAO,EAAE,oBAAoB,GAC5B,eAAe,CAAC,CAAC,CAAC,CAgDpB"}
|
package/dist/webhook.js
CHANGED
|
@@ -5,9 +5,10 @@ import { assertApiKey, assertSecret, loadEd25519PublicKey, rawBodyBytes, sha256H
|
|
|
5
5
|
/**
|
|
6
6
|
* Verify a relay → webhook delivery.
|
|
7
7
|
*
|
|
8
|
-
* Order: required headers, constant-time API key compare,
|
|
9
|
-
*
|
|
10
|
-
*
|
|
8
|
+
* Order: required headers (including `X-Timestamp`), constant-time API key compare,
|
|
9
|
+
* reject `|now - X-Timestamp| > 300`, HMAC over `apiKey + "." + timestamp + "." + rawBody`
|
|
10
|
+
* (five updates), optional Ed25519 delivery signature and ±300s skew on `X-Event-Timestamp`,
|
|
11
|
+
* then JSON parse, then `event_id` / `queue_id` / `attempt` against the signed headers.
|
|
11
12
|
*
|
|
12
13
|
* `Idempotency-Key` is unsigned. Dedupe on `(event_id, attempt)` too. If a header value is a
|
|
13
14
|
* `string[]` whose length is not 1, verification fails.
|
|
@@ -17,7 +18,9 @@ export function verifyWebhook(options) {
|
|
|
17
18
|
const secret = assertSecret(options.secret);
|
|
18
19
|
const rawBody = rawBodyBytes(options.rawBody);
|
|
19
20
|
const headers = options.headers;
|
|
21
|
+
const now = options.now ?? Date.now;
|
|
20
22
|
const headerApiKey = readWebhookHeader(headers, "x-api-key");
|
|
23
|
+
const timestamp = readWebhookHeader(headers, "x-timestamp");
|
|
21
24
|
const payloadSignature = readWebhookHeader(headers, "x-payload-signature");
|
|
22
25
|
const idempotencyKey = readWebhookHeader(headers, "idempotency-key");
|
|
23
26
|
const eventId = readWebhookHeader(headers, "x-event-id");
|
|
@@ -26,12 +29,13 @@ export function verifyWebhook(options) {
|
|
|
26
29
|
if (!timingSafeEqualText(apiKey, headerApiKey)) {
|
|
27
30
|
throw new WebhookVerificationError("signature");
|
|
28
31
|
}
|
|
29
|
-
|
|
32
|
+
assertFreshUnixTimestamp(timestamp, now);
|
|
33
|
+
const expected = webhookHmacHeader(secret, apiKey, timestamp, rawBody);
|
|
30
34
|
if (!timingSafeEqualText(expected, payloadSignature)) {
|
|
31
35
|
throw new WebhookVerificationError("signature");
|
|
32
36
|
}
|
|
33
37
|
if (options.deliveryPublicKeyPem !== undefined) {
|
|
34
|
-
verifyDelivery(options.deliveryPublicKeyPem, headers, rawBody, eventId,
|
|
38
|
+
verifyDelivery(options.deliveryPublicKeyPem, headers, rawBody, eventId, now);
|
|
35
39
|
}
|
|
36
40
|
let parsed;
|
|
37
41
|
try {
|
|
@@ -53,6 +57,28 @@ export function verifyWebhook(options) {
|
|
|
53
57
|
attempt: parsed.attempt,
|
|
54
58
|
};
|
|
55
59
|
}
|
|
60
|
+
function assertFreshUnixTimestamp(timestamp, now) {
|
|
61
|
+
if (!/^[0-9]+$/.test(timestamp) || timestamp.length > 16) {
|
|
62
|
+
throw new WebhookVerificationError("timestamp");
|
|
63
|
+
}
|
|
64
|
+
const ts = Number(timestamp);
|
|
65
|
+
if (!Number.isSafeInteger(ts))
|
|
66
|
+
throw new WebhookVerificationError("timestamp");
|
|
67
|
+
let nowMs;
|
|
68
|
+
try {
|
|
69
|
+
nowMs = now();
|
|
70
|
+
}
|
|
71
|
+
catch {
|
|
72
|
+
throw new WebhookVerificationError("timestamp");
|
|
73
|
+
}
|
|
74
|
+
if (typeof nowMs !== "number" || !Number.isFinite(nowMs)) {
|
|
75
|
+
throw new WebhookVerificationError("timestamp");
|
|
76
|
+
}
|
|
77
|
+
const nowSeconds = Math.floor(nowMs / 1000);
|
|
78
|
+
if (!Number.isSafeInteger(nowSeconds) || Math.abs(nowSeconds - ts) > TIMESTAMP_SKEW_SECONDS) {
|
|
79
|
+
throw new WebhookVerificationError("timestamp");
|
|
80
|
+
}
|
|
81
|
+
}
|
|
56
82
|
function verifyDelivery(pem, headers, rawBody, eventId, now) {
|
|
57
83
|
const timestamp = readWebhookHeader(headers, "x-event-timestamp");
|
|
58
84
|
readWebhookHeader(headers, "x-event-key-id");
|
package/dist/webhook.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"webhook.js","sourceRoot":"","sources":["../src/webhook.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAA4C,MAAM,aAAa,CAAC;AAC/F,OAAO,EAAE,wBAAwB,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAuB,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,oBAAoB,EACpB,YAAY,EACZ,SAAS,EACT,mBAAmB,EACnB,sBAAsB,EACtB,iBAAiB,GAClB,MAAM,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"webhook.js","sourceRoot":"","sources":["../src/webhook.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAA4C,MAAM,aAAa,CAAC;AAC/F,OAAO,EAAE,wBAAwB,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAuB,MAAM,kBAAkB,CAAC;AAC1E,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,oBAAoB,EACpB,YAAY,EACZ,SAAS,EACT,mBAAmB,EACnB,sBAAsB,EACtB,iBAAiB,GAClB,MAAM,WAAW,CAAC;AAiCnB;;;;;;;;;;GAUG;AACH,MAAM,UAAU,aAAa,CAC3B,OAA6B;IAE7B,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9C,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAChC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC;IAEpC,MAAM,YAAY,GAAG,iBAAiB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC7D,MAAM,SAAS,GAAG,iBAAiB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAC5D,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,OAAO,EAAE,qBAAqB,CAAC,CAAC;IAC3E,MAAM,cAAc,GAAG,iBAAiB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IACrE,MAAM,OAAO,GAAG,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IACzD,MAAM,aAAa,GAAG,iBAAiB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IACpE,MAAM,OAAO,GAAG,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAEzD,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;IAED,wBAAwB,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IAEzC,MAAM,QAAQ,GAAG,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACvE,IAAI,CAAC,mBAAmB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,OAAO,CAAC,oBAAoB,KAAK,SAAS,EAAE,CAAC;QAC/C,cAAc,CAAC,OAAO,CAAC,oBAAoB,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IAC/E,CAAC;IAED,IAAI,MAAe,CAAC;IACpB,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAY,CAAC;IACpE,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,wBAAwB,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IACD,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;QAAE,MAAM,IAAI,wBAAwB,CAAC,MAAM,CAAC,CAAC;IACxE,IAAI,MAAM,CAAC,QAAQ,KAAK,OAAO,IAAI,MAAM,CAAC,QAAQ,KAAK,OAAO,IAAI,aAAa,KAAK,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3G,MAAM,IAAI,wBAAwB,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC;IAED,OAAO;QACL,IAAI,EAAE,MAAgC;QACtC,cAAc;QACd,OAAO;QACP,OAAO;QACP,OAAO,EAAE,MAAM,CAAC,OAAO;KACxB,CAAC;AACJ,CAAC;AAED,SAAS,wBAAwB,CAAC,SAAiB,EAAE,GAAiB;IACpE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QACzD,MAAM,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;IACD,MAAM,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IAC7B,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;QAAE,MAAM,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAE/E,IAAI,KAAa,CAAC;IAClB,IAAI,CAAC;QACH,KAAK,GAAG,GAAG,EAAE,CAAC;IAChB,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACzD,MAAM,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;IACD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IAC5C,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,EAAE,CAAC,GAAG,sBAAsB,EAAE,CAAC;QAC5F,MAAM,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CACrB,GAAW,EACX,OAAuB,EACvB,OAAmB,EACnB,OAAe,EACf,GAAiB;IAEjB,MAAM,SAAS,GAAG,iBAAiB,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;IAClE,iBAAiB,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IAC7C,MAAM,SAAS,GAAG,iBAAiB,CAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;IAElE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QACzD,MAAM,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;IACD,MAAM,EAAE,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;IAC7B,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;QAAE,MAAM,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAE/E,IAAI,GAAc,CAAC;IACnB,IAAI,CAAC;QACH,GAAG,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,wBAAwB,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,MAAM,SAAS,IAAI,OAAO,IAAI,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC7F,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,wBAAwB,CAAC,UAAU,CAAC,CAAC;IACjD,CAAC;IAED,IAAI,KAAa,CAAC;IAClB,IAAI,CAAC;QACH,KAAK,GAAG,GAAG,EAAE,CAAC;IAChB,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACzD,MAAM,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;IACD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IAC5C,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,EAAE,CAAC,GAAG,sBAAsB,EAAE,CAAC;QAC5F,MAAM,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IAQpC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACnC,IAAI,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC3F,IAAI,OAAO,KAAK,CAAC,UAAU,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,UAAU,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC/F,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC;QAAE,OAAO,KAAK,CAAC;IACxE,OAAO,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,IAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAClF,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "relay-surfih-sdk",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "Signed client and webhook verifier for the Relay /api/v1 HTTP API",
|
|
6
6
|
"type": "module",
|
|
@@ -16,16 +16,16 @@
|
|
|
16
16
|
"files": [
|
|
17
17
|
"dist"
|
|
18
18
|
],
|
|
19
|
-
"scripts": {
|
|
20
|
-
"build": "tsc -p tsconfig.json",
|
|
21
|
-
"typecheck": "tsc -p tsconfig.json --noEmit && tsc -p tsconfig.test.json --noEmit",
|
|
22
|
-
"test": "tsc -p tsconfig.test.json && node --test dist-test/test/*.test.js"
|
|
23
|
-
},
|
|
24
19
|
"dependencies": {
|
|
25
20
|
"relay-types": "file:../relay-types/"
|
|
26
21
|
},
|
|
27
22
|
"devDependencies": {
|
|
28
23
|
"@types/node": "^22.19.1",
|
|
29
24
|
"typescript": "^5.9.3"
|
|
25
|
+
},
|
|
26
|
+
"scripts": {
|
|
27
|
+
"build": "tsc -p tsconfig.json",
|
|
28
|
+
"typecheck": "tsc -p tsconfig.json --noEmit && tsc -p tsconfig.test.json --noEmit",
|
|
29
|
+
"test": "tsc -p tsconfig.test.json && node --test dist-test/test/*.test.js"
|
|
30
30
|
}
|
|
31
|
-
}
|
|
31
|
+
}
|