@relaymessenger/sdk 0.3.3-staging.4 → 0.3.3-staging.5

package/dist/index.d.ts

@@ -2,7 +2,7 @@ export { Agents, Attachments, BlockedHandles, Chats, ContactCard, Messages, Rela
 export { RelayAPIError, RelayWebhookConfiguredError, type RelayAPIErrorOptions, type RelayWebhookConfiguredErrorOptions, } from "./errors.js";
 export { RELAY_V1_OPERATIONS, RELAY_WEBHOOK_EVENT_TYPES, type RelayV1Operation, } from "./operations.js";
 export { ChatsPage, MessagesPage, RelayPage, type PageBody, } from "./pagination.js";
-export { Webhooks, WebhookVerificationError, verifyWebhookSignature, type WebhookHeaders, } from "./webhooks.js";
+export { Webhooks, WebhookVerificationError, signWebhookHeaders, verifyWebhookSignature, type WebhookHeaders, } from "./webhooks.js";
 export { runWebSocket, type WebSocketEventContext, type WebSocketFullSyncContext, type WebSocketRunOptions, type WebSocketConstructor, type WebSocketLike, } from "./websocket.js";
 export type * from "./types.js";
 export { Relay as default } from "./client.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,WAAW,EACX,cAAc,EACd,KAAK,EACL,WAAW,EACX,QAAQ,EACR,KAAK,EACL,SAAS,EACT,aAAa,EACb,oBAAoB,EACpB,KAAK,YAAY,EACjB,KAAK,kBAAkB,GACxB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,aAAa,EACb,2BAA2B,EAC3B,KAAK,oBAAoB,EACzB,KAAK,kCAAkC,GACxC,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,mBAAmB,EACnB,yBAAyB,EACzB,KAAK,gBAAgB,GACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,SAAS,EACT,YAAY,EACZ,SAAS,EACT,KAAK,QAAQ,GACd,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,QAAQ,EACR,wBAAwB,EACxB,sBAAsB,EACtB,KAAK,cAAc,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,YAAY,EACZ,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,aAAa,GACnB,MAAM,gBAAgB,CAAC;AACxB,mBAAmB,YAAY,CAAC;AAEhC,OAAO,EAAE,KAAK,IAAI,OAAO,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,WAAW,EACX,cAAc,EACd,KAAK,EACL,WAAW,EACX,QAAQ,EACR,KAAK,EACL,SAAS,EACT,aAAa,EACb,oBAAoB,EACpB,KAAK,YAAY,EACjB,KAAK,kBAAkB,GACxB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,aAAa,EACb,2BAA2B,EAC3B,KAAK,oBAAoB,EACzB,KAAK,kCAAkC,GACxC,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,mBAAmB,EACnB,yBAAyB,EACzB,KAAK,gBAAgB,GACtB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,SAAS,EACT,YAAY,EACZ,SAAS,EACT,KAAK,QAAQ,GACd,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,QAAQ,EACR,wBAAwB,EACxB,kBAAkB,EAClB,sBAAsB,EACtB,KAAK,cAAc,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,YAAY,EACZ,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,aAAa,GACnB,MAAM,gBAAgB,CAAC;AACxB,mBAAmB,YAAY,CAAC;AAEhC,OAAO,EAAE,KAAK,IAAI,OAAO,EAAE,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -2,7 +2,7 @@ export { Agents, Attachments, BlockedHandles, Chats, ContactCard, Messages, Rela
 export { RelayAPIError, RelayWebhookConfiguredError, } from "./errors.js";
 export { RELAY_V1_OPERATIONS, RELAY_WEBHOOK_EVENT_TYPES, } from "./operations.js";
 export { ChatsPage, MessagesPage, RelayPage, } from "./pagination.js";
-export { Webhooks, WebhookVerificationError, verifyWebhookSignature, } from "./webhooks.js";
+export { Webhooks, WebhookVerificationError, signWebhookHeaders, verifyWebhookSignature, } from "./webhooks.js";
 export { runWebSocket, } from "./websocket.js";
 export { Relay as default } from "./client.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,WAAW,EACX,cAAc,EACd,KAAK,EACL,WAAW,EACX,QAAQ,EACR,KAAK,EACL,SAAS,EACT,aAAa,EACb,oBAAoB,GAGrB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,aAAa,EACb,2BAA2B,GAG5B,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,mBAAmB,EACnB,yBAAyB,GAE1B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,SAAS,EACT,YAAY,EACZ,SAAS,GAEV,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,QAAQ,EACR,wBAAwB,EACxB,sBAAsB,GAEvB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,YAAY,GAMb,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAAE,KAAK,IAAI,OAAO,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,MAAM,EACN,WAAW,EACX,cAAc,EACd,KAAK,EACL,WAAW,EACX,QAAQ,EACR,KAAK,EACL,SAAS,EACT,aAAa,EACb,oBAAoB,GAGrB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,aAAa,EACb,2BAA2B,GAG5B,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,mBAAmB,EACnB,yBAAyB,GAE1B,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,SAAS,EACT,YAAY,EACZ,SAAS,GAEV,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,QAAQ,EACR,wBAAwB,EACxB,kBAAkB,EAClB,sBAAsB,GAEvB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,YAAY,GAMb,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAAE,KAAK,IAAI,OAAO,EAAE,MAAM,aAAa,CAAC"}

package/dist/webhooks.d.ts

@@ -2,6 +2,16 @@ import { WebhookVerificationError } from "standardwebhooks";
 import type { RelayWebhookEnvelope, RelayWebhookEvent } from "./types.js";
 export { WebhookVerificationError };
 export type WebhookHeaders = Headers | Record<string, string | null | undefined>;
+/** The three Standard Webhooks headers for one delivery: `webhook-id`,
+ * `webhook-timestamp` (unix seconds) and `webhook-signature` (`v1,<base64
+ * HMAC-SHA256 over id.timestamp.body>`), signed with a `whsec_` secret. Relay
+ * signs deliveries this way, and the CLI's local `listen` forwards sign the
+ * same way, so one receiver verifies both with `verifyWebhookSignature`. */
+export declare const signWebhookHeaders: (secret: string, delivery: {
+    id: string;
+    body: string | Buffer;
+    timestamp?: Date;
+}) => Record<"webhook-id" | "webhook-timestamp" | "webhook-signature", string>;
 export declare const verifyWebhookSignature: (secret: string, body: string | Buffer, headers: WebhookHeaders) => void;
 export declare class Webhooks {
     #private;

package/dist/webhooks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../src/webhooks.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,wBAAwB,EACzB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EACV,oBAAoB,EACpB,iBAAiB,EAClB,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,wBAAwB,EAAE,CAAC;AAEpC,MAAM,MAAM,cAAc,GACtB,OAAO,GACP,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;AAsB9C,eAAO,MAAM,sBAAsB,GACjC,QAAQ,MAAM,EACd,MAAM,MAAM,GAAG,MAAM,EACrB,SAAS,cAAc,KACtB,IAEF,CAAC;AAEF,qBAAa,QAAQ;;gBAGP,MAAM,EAAE,MAAM,GAAG,IAAI;IAIjC,MAAM,CACJ,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE;QAAE,OAAO,EAAE,cAAc,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1D,IAAI;IAMP,MAAM,CAAC,CAAC,GAAG,iBAAiB,EAC1B,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,MAAM,EAAE;QAAE,OAAO,EAAE,cAAc,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GAChD,CAAC;CAIL;AAED,YAAY,EAAE,oBAAoB,EAAE,CAAC"}
+{"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../src/webhooks.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,wBAAwB,EACzB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EACV,oBAAoB,EACpB,iBAAiB,EAClB,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,wBAAwB,EAAE,CAAC;AAEpC,MAAM,MAAM,cAAc,GACtB,OAAO,GACP,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;AAsB9C;;;;4EAI4E;AAC5E,eAAO,MAAM,kBAAkB,GAC7B,QAAQ,MAAM,EACd,UAAU;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,IAAI,CAAA;CAAE,KAChE,MAAM,CAAC,YAAY,GAAG,mBAAmB,GAAG,mBAAmB,EAAE,MAAM,CAOzE,CAAC;AAEF,eAAO,MAAM,sBAAsB,GACjC,QAAQ,MAAM,EACd,MAAM,MAAM,GAAG,MAAM,EACrB,SAAS,cAAc,KACtB,IAEF,CAAC;AAEF,qBAAa,QAAQ;;gBAGP,MAAM,EAAE,MAAM,GAAG,IAAI;IAIjC,MAAM,CACJ,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE;QAAE,OAAO,EAAE,cAAc,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GAC1D,IAAI;IAMP,MAAM,CAAC,CAAC,GAAG,iBAAiB,EAC1B,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,MAAM,EAAE;QAAE,OAAO,EAAE,cAAc,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GAChD,CAAC;CAIL;AAED,YAAY,EAAE,oBAAoB,EAAE,CAAC"}

package/dist/webhooks.js

@@ -14,6 +14,19 @@ const requiredHeaders = (headers) => {
         "webhook-signature": signature,
     };
 };
+/** The three Standard Webhooks headers for one delivery: `webhook-id`,
+ * `webhook-timestamp` (unix seconds) and `webhook-signature` (`v1,<base64
+ * HMAC-SHA256 over id.timestamp.body>`), signed with a `whsec_` secret. Relay
+ * signs deliveries this way, and the CLI's local `listen` forwards sign the
+ * same way, so one receiver verifies both with `verifyWebhookSignature`. */
+export const signWebhookHeaders = (secret, delivery) => {
+    const timestamp = delivery.timestamp ?? new Date();
+    return {
+        "webhook-id": delivery.id,
+        "webhook-timestamp": String(Math.floor(timestamp.getTime() / 1_000)),
+        "webhook-signature": new Webhook(secret).sign(delivery.id, timestamp, delivery.body),
+    };
+};
 export const verifyWebhookSignature = (secret, body, headers) => {
     new Webhook(secret).verify(body, requiredHeaders(headers));
 };

package/dist/webhooks.js.map

@@ -1 +1 @@
-{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../src/webhooks.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,wBAAwB,GACzB,MAAM,kBAAkB,CAAC;AAM1B,OAAO,EAAE,wBAAwB,EAAE,CAAC;AAMpC,MAAM,eAAe,GAAG,CACtB,OAAuB,EACC,EAAE;IAC1B,MAAM,GAAG,GAAG,CAAC,IAAY,EAA6B,EAAE,CACtD,OAAO,YAAY,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjE,MAAM,EAAE,GAAG,GAAG,CAAC,YAAY,CAAC,CAAC;IAC7B,MAAM,SAAS,GAAG,GAAG,CAAC,mBAAmB,CAAC,CAAC;IAC3C,MAAM,SAAS,GAAG,GAAG,CAAC,mBAAmB,CAAC,CAAC;IAC3C,IAAI,CAAC,EAAE,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,EAAE,CAAC;QACpC,MAAM,IAAI,wBAAwB,CAChC,8DAA8D,CAC/D,CAAC;IACJ,CAAC;IACD,OAAO;QACL,YAAY,EAAE,EAAE;QAChB,mBAAmB,EAAE,SAAS;QAC9B,mBAAmB,EAAE,SAAS;KAC/B,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,MAAc,EACd,IAAqB,EACrB,OAAuB,EACjB,EAAE;IACR,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;AAC7D,CAAC,CAAC;AAEF,MAAM,OAAO,QAAQ;IACV,OAAO,CAAgB;IAEhC,YAAY,MAAqB;QAC/B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,MAAM,CACJ,IAAqB,EACrB,EAAE,OAAO,EAAE,GAAG,EAA6C;QAE3D,MAAM,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC;QACnC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QACzD,sBAAsB,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,CACJ,IAAqB,EACrB,MAAiD;QAEjD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAM,CAAC;IAC1C,CAAC;CACF"}
+{"version":3,"file":"webhooks.js","sourceRoot":"","sources":["../src/webhooks.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,wBAAwB,GACzB,MAAM,kBAAkB,CAAC;AAM1B,OAAO,EAAE,wBAAwB,EAAE,CAAC;AAMpC,MAAM,eAAe,GAAG,CACtB,OAAuB,EACC,EAAE;IAC1B,MAAM,GAAG,GAAG,CAAC,IAAY,EAA6B,EAAE,CACtD,OAAO,YAAY,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACjE,MAAM,EAAE,GAAG,GAAG,CAAC,YAAY,CAAC,CAAC;IAC7B,MAAM,SAAS,GAAG,GAAG,CAAC,mBAAmB,CAAC,CAAC;IAC3C,MAAM,SAAS,GAAG,GAAG,CAAC,mBAAmB,CAAC,CAAC;IAC3C,IAAI,CAAC,EAAE,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,EAAE,CAAC;QACpC,MAAM,IAAI,wBAAwB,CAChC,8DAA8D,CAC/D,CAAC;IACJ,CAAC;IACD,OAAO;QACL,YAAY,EAAE,EAAE;QAChB,mBAAmB,EAAE,SAAS;QAC9B,mBAAmB,EAAE,SAAS;KAC/B,CAAC;AACJ,CAAC,CAAC;AAEF;;;;4EAI4E;AAC5E,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,MAAc,EACd,QAAiE,EACS,EAAE;IAC5E,MAAM,SAAS,GAAG,QAAQ,CAAC,SAAS,IAAI,IAAI,IAAI,EAAE,CAAC;IACnD,OAAO;QACL,YAAY,EAAE,QAAQ,CAAC,EAAE;QACzB,mBAAmB,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,CAAC;QACpE,mBAAmB,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,IAAI,CAAC;KACrF,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,MAAc,EACd,IAAqB,EACrB,OAAuB,EACjB,EAAE;IACR,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;AAC7D,CAAC,CAAC;AAEF,MAAM,OAAO,QAAQ;IACV,OAAO,CAAgB;IAEhC,YAAY,MAAqB;QAC/B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED,MAAM,CACJ,IAAqB,EACrB,EAAE,OAAO,EAAE,GAAG,EAA6C;QAE3D,MAAM,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC;QACnC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QACzD,sBAAsB,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,CACJ,IAAqB,EACrB,MAAiD;QAEjD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAM,CAAC;IAC1C,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@relaymessenger/sdk",
-  "version": "0.3.3-staging.4",
+  "version": "0.3.3-staging.5",
   "description": "TypeScript SDK for the Relay v1 messaging API and signed webhooks.",
   "type": "module",
   "main": "./dist/index.js",