svix 2.2.0 → 2.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svix",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Svix webhooks API client and webhook verification library",
   "author": "svix",
   "repository": "https://github.com/svix/svix-webhooks",

package/src/autoconfig.test.ts

@@ -42,7 +42,13 @@ test("AutoConfig rejects wrong prefix", () => {
     tok: "t",
   });
   const token = `wrong_${Buffer.from(json, "utf8").toString("base64")}`;
-  assert.throws(() => new AutoConfig(token, { url: "https://x" }), AutoConfigError);
+  assert.throws(
+    () => new AutoConfig(token, { url: "https://x" }),
+    (err: unknown) =>
+      err instanceof AutoConfigError &&
+      err.message ===
+        "Unsupported token version. You might need to update the Svix SDK to use this token"
+  );
 });
 
 test("AutoConfig rejects invalid JSON payload", () => {

package/src/autoconfig.ts

@@ -10,6 +10,8 @@ import {
 } from "./webhook";
 
 const AUTOCONFIG_TOKEN_PREFIX_V1 = "auto_v1_";
+const UNSUPPORTED_TOKEN_VERSION =
+  "Unsupported token version. You might need to update the Svix SDK to use this token";
 
 export interface AutoConfigTokenContentV1 {
   aid: string;
@@ -45,7 +47,7 @@ export function isAutoConfigTokenContentV1(
 
 export function decodeAutoconfigTokenV1(token: string): AutoConfigTokenContentV1 {
   if (!token.startsWith(AUTOCONFIG_TOKEN_PREFIX_V1)) {
-    throw new AutoConfigError();
+    throw new AutoConfigError(UNSUPPORTED_TOKEN_VERSION);
   }
   const b64 = token.slice(AUTOCONFIG_TOKEN_PREFIX_V1.length);
   let json: string;

package/src/models/index.ts

@@ -157,6 +157,9 @@ export { type PollingEndpointMessageOut } from "./pollingEndpointMessageOut";
 export { type PollingEndpointOut } from "./pollingEndpointOut";
 export { type PortIoConfig } from "./portIoConfig";
 export { type PortIoConfigOut } from "./portIoConfigOut";
+export { type PostgresConfigIn } from "./postgresConfigIn";
+export { type PostgresConfigOut } from "./postgresConfigOut";
+export { type PostgresConfigPatch } from "./postgresConfigPatch";
 export { type RabbitMqConfigIn } from "./rabbitMqConfigIn";
 export { type RabbitMqConfigOut } from "./rabbitMqConfigOut";
 export { type RabbitMqConfigPatch } from "./rabbitMqConfigPatch";

package/src/models/postgresConfigIn.ts

@@ -0,0 +1,44 @@
+// this file is @generated
+
+export interface PostgresConfigIn {
+  /**
+   * PostgreSQL connection URL, e.g. `postgres://user@host:5432/dbname?sslmode=require`.
+   *
+   * Do NOT embed a password here; use the `password` field instead.
+   */
+  url: string;
+  /** Password for the connection. */
+  password?: string | null;
+  /**
+   * Table to insert into. May be schema-qualified (e.g. `public.events`).
+   *
+   * Quote characters are not supported. Each dot-separated segment is automatically double-quoted when the query is built, so `public.events` becomes `"public"."events"`.
+   */
+  tableName: string;
+  /**
+   * PEM-encoded CA certificate used to verify the Postgres server's TLS certificate.
+   *
+   * Supply this to trust a private or self-signed CA when connecting with `sslmode=verify-ca` or `sslmode=verify-full`. Without it, only the built-in public roots are trusted.
+   */
+  sslRootCert?: string | null;
+}
+
+export const PostgresConfigInSerializer = {
+  _fromJsonObject(object: any): PostgresConfigIn {
+    return {
+      url: object["url"],
+      password: object["password"],
+      tableName: object["tableName"],
+      sslRootCert: object["sslRootCert"],
+    };
+  },
+
+  _toJsonObject(self: PostgresConfigIn): any {
+    return {
+      url: self.url,
+      password: self.password,
+      tableName: self.tableName,
+      sslRootCert: self.sslRootCert,
+    };
+  },
+};

package/src/models/postgresConfigOut.ts

@@ -0,0 +1,25 @@
+// this file is @generated
+
+export interface PostgresConfigOut {
+  url: string;
+  tableName: string;
+  sslRootCert?: string | null;
+}
+
+export const PostgresConfigOutSerializer = {
+  _fromJsonObject(object: any): PostgresConfigOut {
+    return {
+      url: object["url"],
+      tableName: object["tableName"],
+      sslRootCert: object["sslRootCert"],
+    };
+  },
+
+  _toJsonObject(self: PostgresConfigOut): any {
+    return {
+      url: self.url,
+      tableName: self.tableName,
+      sslRootCert: self.sslRootCert,
+    };
+  },
+};

package/src/models/postgresConfigPatch.ts

@@ -0,0 +1,28 @@
+// this file is @generated
+
+export interface PostgresConfigPatch {
+  url?: string;
+  password?: string;
+  tableName?: string;
+  sslRootCert?: string;
+}
+
+export const PostgresConfigPatchSerializer = {
+  _fromJsonObject(object: any): PostgresConfigPatch {
+    return {
+      url: object["url"],
+      password: object["password"],
+      tableName: object["tableName"],
+      sslRootCert: object["sslRootCert"],
+    };
+  },
+
+  _toJsonObject(self: PostgresConfigPatch): any {
+    return {
+      url: self.url,
+      password: self.password,
+      tableName: self.tableName,
+      sslRootCert: self.sslRootCert,
+    };
+  },
+};

package/src/models/s3ConfigIn.ts

@@ -5,22 +5,30 @@ export interface S3ConfigIn {
   /**
    * Access key ID.
    *
-   * Currently a required field, but marked as optional because we may add different authentication in the future.
+   * Required (along with `secret_access_key`) if `role_arn` is null
    */
   accessKeyId?: string | null;
   /**
    * Secret access key.
    *
-   * Currently a required field, but marked as optional because we may add different authentication in the future.
+   * Required (along with `access_key_id`) if `role_arn` is null
    */
   secretAccessKey?: string | null;
   /**
-   * The region of the EventBridge bus.
+   * The region of the S3 bucket
    *
    * Currently a required field, but marked as optional because we may infer it from other fields in the future.
    */
   region?: string | null;
   endpointUrl?: string | null;
+  /** Role ARN for delegated authentication */
+  roleArn?: string | null;
+  /**
+   * Shared secret passed as the STS ExternalId.
+   *
+   * Required if `role_arn` is not null.
+   */
+  externalId?: string | null;
 }
 
 export const S3ConfigInSerializer = {
@@ -31,6 +39,8 @@ export const S3ConfigInSerializer = {
       secretAccessKey: object["secretAccessKey"],
       region: object["region"],
       endpointUrl: object["endpointUrl"],
+      roleArn: object["roleArn"],
+      externalId: object["externalId"],
     };
   },
 
@@ -41,6 +51,8 @@ export const S3ConfigInSerializer = {
       secretAccessKey: self.secretAccessKey,
       region: self.region,
       endpointUrl: self.endpointUrl,
+      roleArn: self.roleArn,
+      externalId: self.externalId,
     };
   },
 };

package/src/models/s3ConfigOut.ts

@@ -2,9 +2,11 @@
 
 export interface S3ConfigOut {
   bucket: string;
-  accessKeyId: string;
+  accessKeyId?: string | null;
   region: string;
   endpointUrl?: string | null;
+  roleArn?: string | null;
+  externalId?: string | null;
 }
 
 export const S3ConfigOutSerializer = {
@@ -14,6 +16,8 @@ export const S3ConfigOutSerializer = {
       accessKeyId: object["accessKeyId"],
       region: object["region"],
       endpointUrl: object["endpointUrl"],
+      roleArn: object["roleArn"],
+      externalId: object["externalId"],
     };
   },
 
@@ -23,6 +27,8 @@ export const S3ConfigOutSerializer = {
       accessKeyId: self.accessKeyId,
       region: self.region,
       endpointUrl: self.endpointUrl,
+      roleArn: self.roleArn,
+      externalId: self.externalId,
     };
   },
 };

package/src/models/s3ConfigPatch.ts

@@ -4,6 +4,8 @@ export interface S3ConfigPatch {
   bucket?: string;
   accessKeyId?: string;
   secretAccessKey?: string;
+  roleArn?: string;
+  externalId?: string;
   region?: string;
   endpointUrl?: string;
 }
@@ -14,6 +16,8 @@ export const S3ConfigPatchSerializer = {
       bucket: object["bucket"],
       accessKeyId: object["accessKeyId"],
       secretAccessKey: object["secretAccessKey"],
+      roleArn: object["roleArn"],
+      externalId: object["externalId"],
       region: object["region"],
       endpointUrl: object["endpointUrl"],
     };
@@ -24,6 +28,8 @@ export const S3ConfigPatchSerializer = {
       bucket: self.bucket,
       accessKeyId: self.accessKeyId,
       secretAccessKey: self.secretAccessKey,
+      roleArn: self.roleArn,
+      externalId: self.externalId,
       region: self.region,
       endpointUrl: self.endpointUrl,
     };

package/src/models/streamSinkIn.ts

@@ -24,6 +24,7 @@ import {
   type OtelTracingConfigIn,
   OtelTracingConfigInSerializer,
 } from "./otelTracingConfigIn";
+import { type PostgresConfigIn, PostgresConfigInSerializer } from "./postgresConfigIn";
 import { type RabbitMqConfigIn, RabbitMqConfigInSerializer } from "./rabbitMqConfigIn";
 import { type RedshiftConfigIn, RedshiftConfigInSerializer } from "./redshiftConfigIn";
 import { type S3ConfigIn, S3ConfigInSerializer } from "./s3ConfigIn";
@@ -138,6 +139,11 @@ interface StreamSinkInRedshift {
   config: RedshiftConfigIn;
 }
 
+interface StreamSinkInPostgres {
+  type: "postgres";
+  config: PostgresConfigIn;
+}
+
 export type StreamSinkIn = _StreamSinkInFields &
   (
     | StreamSinkInPoller
@@ -155,6 +161,7 @@ export type StreamSinkIn = _StreamSinkInFields &
     | StreamSinkInSnowflake
     | StreamSinkInRabbitMq
     | StreamSinkInRedshift
+    | StreamSinkInPostgres
   );
 
 export const StreamSinkInSerializer = {
@@ -193,6 +200,8 @@ export const StreamSinkInSerializer = {
           return RabbitMqConfigInSerializer._fromJsonObject(object["config"]);
         case "redshift":
           return RedshiftConfigInSerializer._fromJsonObject(object["config"]);
+        case "postgres":
+          return PostgresConfigInSerializer._fromJsonObject(object["config"]);
         default:
           throw new Error(`Unexpected type: ${type}`);
       }
@@ -263,6 +272,9 @@ export const StreamSinkInSerializer = {
       case "redshift":
         config = RedshiftConfigInSerializer._toJsonObject(self.config);
         break;
+      case "postgres":
+        config = PostgresConfigInSerializer._toJsonObject(self.config);
+        break;
     }
 
     return {

package/src/models/streamSinkOut.ts

@@ -24,6 +24,7 @@ import {
   type OtelTracingConfigOut,
   OtelTracingConfigOutSerializer,
 } from "./otelTracingConfigOut";
+import { type PostgresConfigOut, PostgresConfigOutSerializer } from "./postgresConfigOut";
 import { type RabbitMqConfigOut, RabbitMqConfigOutSerializer } from "./rabbitMqConfigOut";
 import { type RedshiftConfigOut, RedshiftConfigOutSerializer } from "./redshiftConfigOut";
 import { type S3ConfigOut, S3ConfigOutSerializer } from "./s3ConfigOut";
@@ -132,6 +133,11 @@ interface StreamSinkOutSns {
   config: SnsConfigOut;
 }
 
+interface StreamSinkOutPostgres {
+  type: "postgres";
+  config: PostgresConfigOut;
+}
+
 export type StreamSinkOut = _StreamSinkOutFields &
   (
     | StreamSinkOutPoller
@@ -149,6 +155,7 @@ export type StreamSinkOut = _StreamSinkOutFields &
     | StreamSinkOutSqs
     | StreamSinkOutEventBridge
     | StreamSinkOutSns
+    | StreamSinkOutPostgres
   );
 
 export const StreamSinkOutSerializer = {
@@ -187,6 +194,8 @@ export const StreamSinkOutSerializer = {
           return EventBridgeConfigOutSerializer._fromJsonObject(object["config"]);
         case "sns":
           return SnsConfigOutSerializer._fromJsonObject(object["config"]);
+        case "postgres":
+          return PostgresConfigOutSerializer._fromJsonObject(object["config"]);
         default:
           throw new Error(`Unexpected type: ${type}`);
       }
@@ -260,6 +269,9 @@ export const StreamSinkOutSerializer = {
       case "sns":
         config = SnsConfigOutSerializer._toJsonObject(self.config);
         break;
+      case "postgres":
+        config = PostgresConfigOutSerializer._toJsonObject(self.config);
+        break;
     }
 
     return {

package/src/models/streamSinkPatch.ts

@@ -27,6 +27,10 @@ import {
   type OtelTracingConfigPatch,
   OtelTracingConfigPatchSerializer,
 } from "./otelTracingConfigPatch";
+import {
+  type PostgresConfigPatch,
+  PostgresConfigPatchSerializer,
+} from "./postgresConfigPatch";
 import {
   type RabbitMqConfigPatch,
   RabbitMqConfigPatchSerializer,
@@ -137,6 +141,11 @@ interface StreamSinkPatchRedshift {
   config: RedshiftConfigPatch;
 }
 
+interface StreamSinkPatchPostgres {
+  type: "postgres";
+  config: PostgresConfigPatch;
+}
+
 export type StreamSinkPatch = _StreamSinkPatchFields &
   (
     | StreamSinkPatchPoller
@@ -154,6 +163,7 @@ export type StreamSinkPatch = _StreamSinkPatchFields &
     | StreamSinkPatchSnowflake
     | StreamSinkPatchRabbitMq
     | StreamSinkPatchRedshift
+    | StreamSinkPatchPostgres
   );
 
 export const StreamSinkPatchSerializer = {
@@ -194,6 +204,8 @@ export const StreamSinkPatchSerializer = {
           return RabbitMqConfigPatchSerializer._fromJsonObject(object["config"]);
         case "redshift":
           return RedshiftConfigPatchSerializer._fromJsonObject(object["config"]);
+        case "postgres":
+          return PostgresConfigPatchSerializer._fromJsonObject(object["config"]);
         default:
           throw new Error(`Unexpected type: ${type}`);
       }
@@ -264,6 +276,9 @@ export const StreamSinkPatchSerializer = {
       case "redshift":
         config = RedshiftConfigPatchSerializer._toJsonObject(self.config);
         break;
+      case "postgres":
+        config = PostgresConfigPatchSerializer._toJsonObject(self.config);
+        break;
     }
 
     return {

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.2.0";
+export const LIB_VERSION = "2.3.0";
 
 function getUserAgent() {
   var fields = [`svix-libs/${LIB_VERSION}/javascript`];