svix 2.0.0 → 2.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svix",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "Svix webhooks API client and webhook verification library",
   "author": "svix",
   "repository": "https://github.com/svix/svix-webhooks",
@@ -35,7 +35,7 @@
     "fmt": "biome format --write"
   },
   "dependencies": {
-    "standardwebhooks": "1.0.0"
+    "standardwebhooks": "^1.1.1"
   },
   "devDependencies": {
     "@biomejs/biome": "2.2.4",

package/src/api/message.ts

@@ -1,5 +1,13 @@
 // this file is @generated
 
+import {
+  type BulkExpungeContentsIn,
+  BulkExpungeContentsInSerializer,
+} from "../models/bulkExpungeContentsIn";
+import {
+  type BulkExpungeContentsOut,
+  BulkExpungeContentsOutSerializer,
+} from "../models/bulkExpungeContentsOut";
 import {
   type ExpungeAllContentsOut,
   ExpungeAllContentsOutSerializer,
@@ -67,6 +75,10 @@ export interface MessageGetOptions {
   withContent?: boolean;
 }
 
+export interface MessageBulkExpungeContentOptions {
+  idempotencyKey?: string;
+}
+
 export interface MessageExpungeAllContentsOptions {
   idempotencyKey?: string;
 }
@@ -190,7 +202,8 @@ export class Message {
    * Delete the given message's payload.
    *
    * Useful in cases when a message was accidentally sent with sensitive content.
-   * The message can't be replayed or resent once its payload has been deleted or expired.
+   * The message can't be replayed or resent once its payload has been deleted
+   * (or has expired).
    */
   public async expungeContent(appId: string, msgId: string): Promise<void> {
     const request = new SvixRequest(
@@ -204,6 +217,33 @@ export class Message {
     return await request.sendNoResponseBody(this.requestCtx);
   }
 
+  /**
+   * Delete the payloads from the given messages under the current application
+   *
+   * Useful in cases when a message was accidentally sent with sensitive content.
+   * A message can't be replayed or resent once its payload has been deleted
+   * (or has expired).
+   */
+  public async bulkExpungeContent(
+    appId: string,
+    bulkExpungeContentsIn: BulkExpungeContentsIn = {},
+    options?: MessageBulkExpungeContentOptions
+  ): Promise<BulkExpungeContentsOut> {
+    const request = new SvixRequest(
+      HttpMethod.POST,
+      "/api/v1/app/{app_id}/msg/bulk-expunge"
+    );
+
+    request.setPathParam("app_id", appId);
+    request.setHeaderParam("idempotency-key", options?.idempotencyKey);
+    request.setBody(BulkExpungeContentsInSerializer._toJsonObject(bulkExpungeContentsIn));
+
+    return await request.send(
+      this.requestCtx,
+      BulkExpungeContentsOutSerializer._fromJsonObject
+    );
+  }
+
   /**
    * Delete all message payloads for the application.
    *

package/src/models/bulkExpungeContentsIn.ts

@@ -0,0 +1,20 @@
+// this file is @generated
+
+export interface BulkExpungeContentsIn {
+  /** Message ID or UID to delete */
+  ids?: string[];
+}
+
+export const BulkExpungeContentsInSerializer = {
+  _fromJsonObject(object: any): BulkExpungeContentsIn {
+    return {
+      ids: object["ids"],
+    };
+  },
+
+  _toJsonObject(self: BulkExpungeContentsIn): any {
+    return {
+      ids: self.ids,
+    };
+  },
+};

package/src/models/bulkExpungeContentsOut.ts

@@ -0,0 +1,33 @@
+// this file is @generated
+import { type BulkExpungeStatus, BulkExpungeStatusSerializer } from "./bulkExpungeStatus";
+
+export interface BulkExpungeContentsOut {
+  /** Results of expunging (by ID) */
+  results: { [key: string]: BulkExpungeStatus };
+}
+
+export const BulkExpungeContentsOutSerializer = {
+  _fromJsonObject(object: any): BulkExpungeContentsOut {
+    return {
+      results: Object.fromEntries(
+        Object.entries<BulkExpungeStatus>(object["results"]).map(
+          (item: [string, BulkExpungeStatus]) => [
+            item[0],
+            BulkExpungeStatusSerializer._fromJsonObject(item[1]),
+          ]
+        )
+      ),
+    };
+  },
+
+  _toJsonObject(self: BulkExpungeContentsOut): any {
+    return {
+      results: Object.fromEntries(
+        Object.entries(self.results).map((item) => [
+          item[0],
+          BulkExpungeStatusSerializer._toJsonObject(item[1]),
+        ])
+      ),
+    };
+  },
+};

package/src/models/bulkExpungeStatus.ts

@@ -0,0 +1,16 @@
+// this file is @generated
+
+export enum BulkExpungeStatus {
+  Expunged = "expunged",
+  NotFound = "not-found",
+}
+
+export const BulkExpungeStatusSerializer = {
+  _fromJsonObject(object: any): BulkExpungeStatus {
+    return object;
+  },
+
+  _toJsonObject(self: BulkExpungeStatus): any {
+    return self;
+  },
+};

package/src/models/index.ts

@@ -23,6 +23,9 @@ export { BackgroundTaskType } from "./backgroundTaskType";
 export { type BigQueryConfigIn } from "./bigQueryConfigIn";
 export { type BigQueryConfigOut } from "./bigQueryConfigOut";
 export { type BigQueryConfigPatch } from "./bigQueryConfigPatch";
+export { type BulkExpungeContentsIn } from "./bulkExpungeContentsIn";
+export { type BulkExpungeContentsOut } from "./bulkExpungeContentsOut";
+export { BulkExpungeStatus } from "./bulkExpungeStatus";
 export { type BulkReplayIn } from "./bulkReplayIn";
 export { type CheckbookConfig } from "./checkbookConfig";
 export { type CheckbookConfigOut } from "./checkbookConfigOut";

package/src/request.ts

@@ -1,7 +1,7 @@
 import { ApiException, type XOR } from "./util";
 import type { HttpErrorOut, HTTPValidationError } from "./HttpErrors";
 
-export const LIB_VERSION = "2.0.0";
+export const LIB_VERSION = "2.2.0";
 
 function getUserAgent() {
   var fields = [`svix-libs/${LIB_VERSION}/javascript`];

package/src/webhook.test.ts

@@ -124,7 +124,7 @@ test("partial signature throws error", () => {
   }, WebhookVerificationError);
 });
 
-test("valid signature is valid and returns valid json", () => {
+test("valid signature is valid", () => {
   const wh = new Webhook("MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw");
 
   const testPayload = new TestPayload();
@@ -132,7 +132,7 @@ test("valid signature is valid and returns valid json", () => {
   wh.verify(testPayload.payload, testPayload.header);
 });
 
-test("valid unbranded signature is valid and returns valid json", () => {
+test("valid unbranded signature is valid", () => {
   const wh = new Webhook("MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw");
 
   const testPayload = new TestPayload();

package/src/webhook.ts

@@ -30,7 +30,7 @@ export class Webhook {
       | WebhookRequiredHeaders
       | WebhookUnbrandedRequiredHeaders
       | Record<string, string>
-  ): unknown {
+  ): undefined {
     const headers: Record<string, string> = {};
     for (const key of Object.keys(headers_)) {
       headers[key.toLowerCase()] = (headers_ as Record<string, string>)[key];
@@ -42,7 +42,7 @@ export class Webhook {
     headers["webhook-timestamp"] =
       headers["svix-timestamp"] ?? headers["webhook-timestamp"] ?? "";
 
-    return this.inner.verify(payload, headers);
+    this.inner.verify(payload, headers, { jsonParse: false });
   }
 
   public sign(msgId: string, timestamp: Date, payload: string | Buffer): string {