@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,93 @@
|
|
|
1
|
+
// =============================================================================
|
|
2
|
+
// Webhook signing and verification (Standard Webhooks, scheme v1)
|
|
3
|
+
// =============================================================================
|
|
4
|
+
//
|
|
5
|
+
// HMAC-SHA256 over `${id}.${timestamp}.${body}` with the base64-decoded key of
|
|
6
|
+
// a `whsec_<base64>` secret. Web Crypto only (`globalThis.crypto.subtle`), so
|
|
7
|
+
// it runs in Node and in a browser. Zod-free.
|
|
8
|
+
// =============================================================================
|
|
9
|
+
import { WEBHOOK_DEFAULT_TOLERANCE_SECONDS, WEBHOOK_SECRET_PREFIX, WEBHOOK_SIGNATURE_VERSION, } from './constants.js';
|
|
10
|
+
const encoder = new TextEncoder();
|
|
11
|
+
function base64ToBytes(value) {
|
|
12
|
+
const binary = atob(value);
|
|
13
|
+
const bytes = new Uint8Array(new ArrayBuffer(binary.length));
|
|
14
|
+
for (let i = 0; i < binary.length; i += 1)
|
|
15
|
+
bytes[i] = binary.charCodeAt(i);
|
|
16
|
+
return bytes;
|
|
17
|
+
}
|
|
18
|
+
function bytesToBase64(bytes) {
|
|
19
|
+
let binary = '';
|
|
20
|
+
for (const byte of bytes)
|
|
21
|
+
binary += String.fromCharCode(byte);
|
|
22
|
+
return btoa(binary);
|
|
23
|
+
}
|
|
24
|
+
async function hmac(secret, message) {
|
|
25
|
+
const raw = secret.startsWith(WEBHOOK_SECRET_PREFIX) ? secret.slice(WEBHOOK_SECRET_PREFIX.length) : secret;
|
|
26
|
+
const key = await globalThis.crypto.subtle.importKey('raw', base64ToBytes(raw), { name: 'HMAC', hash: 'SHA-256' }, false, ['sign']);
|
|
27
|
+
return new Uint8Array(await globalThis.crypto.subtle.sign('HMAC', key, encoder.encode(message)));
|
|
28
|
+
}
|
|
29
|
+
function timingSafeEqual(a, b) {
|
|
30
|
+
if (a.length !== b.length)
|
|
31
|
+
return false;
|
|
32
|
+
let diff = 0;
|
|
33
|
+
for (let i = 0; i < a.length; i += 1)
|
|
34
|
+
diff |= a[i] ^ b[i];
|
|
35
|
+
return diff === 0;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Sign a body. Returns one `webhook-signature` entry, `v1,<base64>`.
|
|
39
|
+
*
|
|
40
|
+
* @stability experimental
|
|
41
|
+
*/
|
|
42
|
+
export async function signWebhookPayload(input) {
|
|
43
|
+
const mac = await hmac(input.secret, `${input.id}.${input.timestamp}.${input.body}`);
|
|
44
|
+
return `${WEBHOOK_SIGNATURE_VERSION},${bytesToBase64(mac)}`;
|
|
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 async function verifyWebhookSignature(input) {
|
|
54
|
+
try {
|
|
55
|
+
const tolerance = input.toleranceSeconds ?? WEBHOOK_DEFAULT_TOLERANCE_SECONDS;
|
|
56
|
+
const ts = Number(input.timestamp);
|
|
57
|
+
if (!Number.isFinite(ts))
|
|
58
|
+
return false;
|
|
59
|
+
const nowSeconds = (input.now ?? Date.now()) / 1000;
|
|
60
|
+
if (Math.abs(nowSeconds - ts) > tolerance)
|
|
61
|
+
return false;
|
|
62
|
+
const secrets = [...(input.secrets ?? []), ...(input.secret ? [input.secret] : [])];
|
|
63
|
+
if (secrets.length === 0)
|
|
64
|
+
return false;
|
|
65
|
+
const presented = [];
|
|
66
|
+
for (const entry of input.signatureHeader.split(' ')) {
|
|
67
|
+
const comma = entry.indexOf(',');
|
|
68
|
+
if (comma < 0 || entry.slice(0, comma) !== WEBHOOK_SIGNATURE_VERSION)
|
|
69
|
+
continue;
|
|
70
|
+
try {
|
|
71
|
+
presented.push(base64ToBytes(entry.slice(comma + 1)));
|
|
72
|
+
}
|
|
73
|
+
catch {
|
|
74
|
+
// ignore a malformed entry
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
if (presented.length === 0)
|
|
78
|
+
return false;
|
|
79
|
+
let ok = false;
|
|
80
|
+
for (const secret of secrets) {
|
|
81
|
+
const expected = await hmac(secret, `${input.id}.${input.timestamp}.${input.body}`);
|
|
82
|
+
for (const candidate of presented) {
|
|
83
|
+
if (timingSafeEqual(expected, candidate))
|
|
84
|
+
ok = true;
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
return ok;
|
|
88
|
+
}
|
|
89
|
+
catch {
|
|
90
|
+
return false;
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
//# sourceMappingURL=signature.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"signature.js","sourceRoot":"","sources":["../../../src/webhooks/signature.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,kEAAkE;AAClE,gFAAgF;AAChF,EAAE;AACF,+EAA+E;AAC/E,8EAA8E;AAC9E,8CAA8C;AAC9C,gFAAgF;AAEhF,OAAO,EACL,iCAAiC,EACjC,qBAAqB,EACrB,yBAAyB,GAC1B,MAAM,gBAAgB,CAAC;AAExB,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC;AAElC,SAAS,aAAa,CAAC,KAAa;IAClC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC;QAAE,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IAC3E,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,aAAa,CAAC,KAAiB;IACtC,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,MAAM,IAAI,IAAI,KAAK;QAAE,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC9D,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;AACtB,CAAC;AAED,KAAK,UAAU,IAAI,CAAC,MAAc,EAAE,OAAe;IACjD,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IAC3G,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAClD,KAAK,EACL,aAAa,CAAC,GAAG,CAAC,EAClB,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,EACjC,KAAK,EACL,CAAC,MAAM,CAAC,CACT,CAAC;IACF,OAAO,IAAI,UAAU,CAAC,MAAM,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AACnG,CAAC;AAED,SAAS,eAAe,CAAC,CAAa,EAAE,CAAa;IACnD,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IACxC,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC;QAAE,IAAI,IAAI,CAAC,CAAC,CAAC,CAAE,GAAG,CAAC,CAAC,CAAC,CAAE,CAAC;IAC5D,OAAO,IAAI,KAAK,CAAC,CAAC;AACpB,CAAC;AAkBD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,KAA8B;IACrE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,EAAE,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;IACrF,OAAO,GAAG,yBAAyB,IAAI,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;AAC9D,CAAC;AA2BD;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,KAAkC;IAC7E,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,KAAK,CAAC,gBAAgB,IAAI,iCAAiC,CAAC;QAC9E,MAAM,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAAE,OAAO,KAAK,CAAC;QACvC,MAAM,UAAU,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC;QACpD,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,EAAE,CAAC,GAAG,SAAS;YAAE,OAAO,KAAK,CAAC;QAExD,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACpF,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;QAEvC,MAAM,SAAS,GAAiB,EAAE,CAAC;QACnC,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;YACrD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,KAAK,yBAAyB;gBAAE,SAAS;YAC/E,IAAI,CAAC;gBACH,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YACxD,CAAC;YAAC,MAAM,CAAC;gBACP,2BAA2B;YAC7B,CAAC;QACH,CAAC;QACD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;QAEzC,IAAI,EAAE,GAAG,KAAK,CAAC;QACf,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,EAAE,IAAI,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;YACpF,KAAK,MAAM,SAAS,IAAI,SAAS,EAAE,CAAC;gBAClC,IAAI,eAAe,CAAC,QAAQ,EAAE,SAAS,CAAC;oBAAE,EAAE,GAAG,IAAI,CAAC;YACtD,CAAC;QACH,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@marinoscar/platform-contract",
|
|
3
|
-
"version": "0.1.0-next.
|
|
3
|
+
"version": "0.1.0-next.21",
|
|
4
4
|
"description": "Zod DTOs and types shared by the platform API and web packages. Dual CommonJS + ESM.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -200,6 +200,26 @@
|
|
|
200
200
|
"default": "./dist/cjs/user-data/index.js"
|
|
201
201
|
}
|
|
202
202
|
},
|
|
203
|
+
"./alerts": {
|
|
204
|
+
"import": {
|
|
205
|
+
"types": "./dist/esm/alerts/index.d.ts",
|
|
206
|
+
"default": "./dist/esm/alerts/index.js"
|
|
207
|
+
},
|
|
208
|
+
"require": {
|
|
209
|
+
"types": "./dist/cjs/alerts/index.d.ts",
|
|
210
|
+
"default": "./dist/cjs/alerts/index.js"
|
|
211
|
+
}
|
|
212
|
+
},
|
|
213
|
+
"./webhooks": {
|
|
214
|
+
"import": {
|
|
215
|
+
"types": "./dist/esm/webhooks/index.d.ts",
|
|
216
|
+
"default": "./dist/esm/webhooks/index.js"
|
|
217
|
+
},
|
|
218
|
+
"require": {
|
|
219
|
+
"types": "./dist/cjs/webhooks/index.d.ts",
|
|
220
|
+
"default": "./dist/cjs/webhooks/index.js"
|
|
221
|
+
}
|
|
222
|
+
},
|
|
203
223
|
"./timezone": {
|
|
204
224
|
"import": {
|
|
205
225
|
"types": "./dist/esm/timezone/index.d.ts",
|