@novu/api 1.2.0 → 1.4.0

package/src/models/errors/novuerror.ts

@@ -0,0 +1,35 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/** The base class for all HTTP error responses */
+export class NovuError extends Error {
+  /** HTTP status code */
+  public readonly statusCode: number;
+  /** HTTP body */
+  public readonly body: string;
+  /** HTTP headers */
+  public readonly headers: Headers;
+  /** HTTP content type */
+  public readonly contentType: string;
+  /** Raw response */
+  public readonly rawResponse: Response;
+
+  constructor(
+    message: string,
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
+  ) {
+    super(message);
+    this.statusCode = httpMeta.response.status;
+    this.body = httpMeta.body;
+    this.headers = httpMeta.response.headers;
+    this.contentType = httpMeta.response.headers.get("content-type") || "";
+    this.rawResponse = httpMeta.response;
+
+    this.name = "NovuError";
+  }
+}

package/src/models/errors/payloadvalidationexceptiondto.ts

@@ -0,0 +1,471 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { NovuError } from "./novuerror.js";
+import { SDKValidationError } from "./sdkvalidationerror.js";
+
+export type MessagePayloadValidationExceptionDto5 =
+  | string
+  | number
+  | boolean
+  | { [k: string]: any };
+
+export type MessagePayloadValidationExceptionDto4 = {};
+
+/**
+ * Value that failed validation
+ */
+export type PayloadValidationExceptionDtoMessage =
+  | MessagePayloadValidationExceptionDto4
+  | string
+  | number
+  | boolean
+  | Array<string | number | boolean | { [k: string]: any } | null>;
+
+/**
+ * The JSON schema that was used for validation
+ */
+export type Schema = {};
+
+export type PayloadValidationExceptionDtoData = {
+  /**
+   * HTTP status code of the error response.
+   */
+  statusCode: number;
+  /**
+   * Timestamp of when the error occurred.
+   */
+  timestamp: string;
+  /**
+   * The path where the error occurred.
+   */
+  path: string;
+  /**
+   * Value that failed validation
+   */
+  message?:
+    | MessagePayloadValidationExceptionDto4
+    | string
+    | number
+    | boolean
+    | Array<string | number | boolean | { [k: string]: any } | null>
+    | null
+    | undefined;
+  /**
+   * Optional context object for additional error details.
+   */
+  ctx?: { [k: string]: any } | undefined;
+  /**
+   * Optional unique identifier for the error, useful for tracking using Sentry and
+   *
+   * @remarks
+   *       New Relic, only available for 500.
+   */
+  errorId?: string | undefined;
+  /**
+   * Type identifier for payload validation errors
+   */
+  type: string;
+  /**
+   * Array of detailed validation errors
+   */
+  errors: Array<components.PayloadValidationErrorDto>;
+  /**
+   * The JSON schema that was used for validation
+   */
+  schema?: Schema | undefined;
+};
+
+export class PayloadValidationExceptionDto extends NovuError {
+  /**
+   * Timestamp of when the error occurred.
+   */
+  timestamp: string;
+  /**
+   * The path where the error occurred.
+   */
+  path: string;
+  /**
+   * Optional context object for additional error details.
+   */
+  ctx?: { [k: string]: any } | undefined;
+  /**
+   * Optional unique identifier for the error, useful for tracking using Sentry and
+   *
+   * @remarks
+   *       New Relic, only available for 500.
+   */
+  errorId?: string | undefined;
+  /**
+   * Type identifier for payload validation errors
+   */
+  type: string;
+  /**
+   * Array of detailed validation errors
+   */
+  errors: Array<components.PayloadValidationErrorDto>;
+  /**
+   * The JSON schema that was used for validation
+   */
+  schema?: Schema | undefined;
+
+  /** The original data that was passed to this error instance. */
+  data$: PayloadValidationExceptionDtoData;
+
+  constructor(
+    err: PayloadValidationExceptionDtoData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
+    const message = "message" in err && typeof err.message === "string"
+      ? err.message
+      : `API error occurred: ${JSON.stringify(err)}`;
+    super(message, httpMeta);
+    this.data$ = err;
+    this.timestamp = err.timestamp;
+    this.path = err.path;
+    if (err.ctx != null) this.ctx = err.ctx;
+    if (err.errorId != null) this.errorId = err.errorId;
+    this.type = err.type;
+    this.errors = err.errors;
+    if (err.schema != null) this.schema = err.schema;
+
+    this.name = "PayloadValidationExceptionDto";
+  }
+}
+
+/** @internal */
+export const MessagePayloadValidationExceptionDto5$inboundSchema: z.ZodType<
+  MessagePayloadValidationExceptionDto5,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.string(), z.number(), z.boolean(), z.record(z.any())]);
+
+/** @internal */
+export type MessagePayloadValidationExceptionDto5$Outbound =
+  | string
+  | number
+  | boolean
+  | { [k: string]: any };
+
+/** @internal */
+export const MessagePayloadValidationExceptionDto5$outboundSchema: z.ZodType<
+  MessagePayloadValidationExceptionDto5$Outbound,
+  z.ZodTypeDef,
+  MessagePayloadValidationExceptionDto5
+> = z.union([z.string(), z.number(), z.boolean(), z.record(z.any())]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MessagePayloadValidationExceptionDto5$ {
+  /** @deprecated use `MessagePayloadValidationExceptionDto5$inboundSchema` instead. */
+  export const inboundSchema =
+    MessagePayloadValidationExceptionDto5$inboundSchema;
+  /** @deprecated use `MessagePayloadValidationExceptionDto5$outboundSchema` instead. */
+  export const outboundSchema =
+    MessagePayloadValidationExceptionDto5$outboundSchema;
+  /** @deprecated use `MessagePayloadValidationExceptionDto5$Outbound` instead. */
+  export type Outbound = MessagePayloadValidationExceptionDto5$Outbound;
+}
+
+export function messagePayloadValidationExceptionDto5ToJSON(
+  messagePayloadValidationExceptionDto5: MessagePayloadValidationExceptionDto5,
+): string {
+  return JSON.stringify(
+    MessagePayloadValidationExceptionDto5$outboundSchema.parse(
+      messagePayloadValidationExceptionDto5,
+    ),
+  );
+}
+
+export function messagePayloadValidationExceptionDto5FromJSON(
+  jsonString: string,
+): SafeParseResult<MessagePayloadValidationExceptionDto5, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      MessagePayloadValidationExceptionDto5$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessagePayloadValidationExceptionDto5' from JSON`,
+  );
+}
+
+/** @internal */
+export const MessagePayloadValidationExceptionDto4$inboundSchema: z.ZodType<
+  MessagePayloadValidationExceptionDto4,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type MessagePayloadValidationExceptionDto4$Outbound = {};
+
+/** @internal */
+export const MessagePayloadValidationExceptionDto4$outboundSchema: z.ZodType<
+  MessagePayloadValidationExceptionDto4$Outbound,
+  z.ZodTypeDef,
+  MessagePayloadValidationExceptionDto4
+> = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MessagePayloadValidationExceptionDto4$ {
+  /** @deprecated use `MessagePayloadValidationExceptionDto4$inboundSchema` instead. */
+  export const inboundSchema =
+    MessagePayloadValidationExceptionDto4$inboundSchema;
+  /** @deprecated use `MessagePayloadValidationExceptionDto4$outboundSchema` instead. */
+  export const outboundSchema =
+    MessagePayloadValidationExceptionDto4$outboundSchema;
+  /** @deprecated use `MessagePayloadValidationExceptionDto4$Outbound` instead. */
+  export type Outbound = MessagePayloadValidationExceptionDto4$Outbound;
+}
+
+export function messagePayloadValidationExceptionDto4ToJSON(
+  messagePayloadValidationExceptionDto4: MessagePayloadValidationExceptionDto4,
+): string {
+  return JSON.stringify(
+    MessagePayloadValidationExceptionDto4$outboundSchema.parse(
+      messagePayloadValidationExceptionDto4,
+    ),
+  );
+}
+
+export function messagePayloadValidationExceptionDto4FromJSON(
+  jsonString: string,
+): SafeParseResult<MessagePayloadValidationExceptionDto4, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      MessagePayloadValidationExceptionDto4$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessagePayloadValidationExceptionDto4' from JSON`,
+  );
+}
+
+/** @internal */
+export const PayloadValidationExceptionDtoMessage$inboundSchema: z.ZodType<
+  PayloadValidationExceptionDtoMessage,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => MessagePayloadValidationExceptionDto4$inboundSchema),
+  z.string(),
+  z.number(),
+  z.boolean(),
+  z.array(
+    z.nullable(
+      z.union([z.string(), z.number(), z.boolean(), z.record(z.any())]),
+    ),
+  ),
+]);
+
+/** @internal */
+export type PayloadValidationExceptionDtoMessage$Outbound =
+  | MessagePayloadValidationExceptionDto4$Outbound
+  | string
+  | number
+  | boolean
+  | Array<string | number | boolean | { [k: string]: any } | null>;
+
+/** @internal */
+export const PayloadValidationExceptionDtoMessage$outboundSchema: z.ZodType<
+  PayloadValidationExceptionDtoMessage$Outbound,
+  z.ZodTypeDef,
+  PayloadValidationExceptionDtoMessage
+> = z.union([
+  z.lazy(() => MessagePayloadValidationExceptionDto4$outboundSchema),
+  z.string(),
+  z.number(),
+  z.boolean(),
+  z.array(
+    z.nullable(
+      z.union([z.string(), z.number(), z.boolean(), z.record(z.any())]),
+    ),
+  ),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PayloadValidationExceptionDtoMessage$ {
+  /** @deprecated use `PayloadValidationExceptionDtoMessage$inboundSchema` instead. */
+  export const inboundSchema =
+    PayloadValidationExceptionDtoMessage$inboundSchema;
+  /** @deprecated use `PayloadValidationExceptionDtoMessage$outboundSchema` instead. */
+  export const outboundSchema =
+    PayloadValidationExceptionDtoMessage$outboundSchema;
+  /** @deprecated use `PayloadValidationExceptionDtoMessage$Outbound` instead. */
+  export type Outbound = PayloadValidationExceptionDtoMessage$Outbound;
+}
+
+export function payloadValidationExceptionDtoMessageToJSON(
+  payloadValidationExceptionDtoMessage: PayloadValidationExceptionDtoMessage,
+): string {
+  return JSON.stringify(
+    PayloadValidationExceptionDtoMessage$outboundSchema.parse(
+      payloadValidationExceptionDtoMessage,
+    ),
+  );
+}
+
+export function payloadValidationExceptionDtoMessageFromJSON(
+  jsonString: string,
+): SafeParseResult<PayloadValidationExceptionDtoMessage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PayloadValidationExceptionDtoMessage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PayloadValidationExceptionDtoMessage' from JSON`,
+  );
+}
+
+/** @internal */
+export const Schema$inboundSchema: z.ZodType<Schema, z.ZodTypeDef, unknown> = z
+  .object({});
+
+/** @internal */
+export type Schema$Outbound = {};
+
+/** @internal */
+export const Schema$outboundSchema: z.ZodType<
+  Schema$Outbound,
+  z.ZodTypeDef,
+  Schema
+> = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Schema$ {
+  /** @deprecated use `Schema$inboundSchema` instead. */
+  export const inboundSchema = Schema$inboundSchema;
+  /** @deprecated use `Schema$outboundSchema` instead. */
+  export const outboundSchema = Schema$outboundSchema;
+  /** @deprecated use `Schema$Outbound` instead. */
+  export type Outbound = Schema$Outbound;
+}
+
+export function schemaToJSON(schema: Schema): string {
+  return JSON.stringify(Schema$outboundSchema.parse(schema));
+}
+
+export function schemaFromJSON(
+  jsonString: string,
+): SafeParseResult<Schema, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Schema$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Schema' from JSON`,
+  );
+}
+
+/** @internal */
+export const PayloadValidationExceptionDto$inboundSchema: z.ZodType<
+  PayloadValidationExceptionDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  statusCode: z.number(),
+  timestamp: z.string(),
+  path: z.string(),
+  message: z.nullable(
+    z.union([
+      z.lazy(() => MessagePayloadValidationExceptionDto4$inboundSchema),
+      z.string(),
+      z.number(),
+      z.boolean(),
+      z.array(
+        z.nullable(
+          z.union([z.string(), z.number(), z.boolean(), z.record(z.any())]),
+        ),
+      ),
+    ]),
+  ).optional(),
+  ctx: z.record(z.any()).optional(),
+  errorId: z.string().optional(),
+  type: z.string(),
+  errors: z.array(components.PayloadValidationErrorDto$inboundSchema),
+  schema: z.lazy(() => Schema$inboundSchema).optional(),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
+})
+  .transform((v) => {
+    return new PayloadValidationExceptionDto(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
+  });
+
+/** @internal */
+export type PayloadValidationExceptionDto$Outbound = {
+  statusCode: number;
+  timestamp: string;
+  path: string;
+  message?:
+    | MessagePayloadValidationExceptionDto4$Outbound
+    | string
+    | number
+    | boolean
+    | Array<string | number | boolean | { [k: string]: any } | null>
+    | null
+    | undefined;
+  ctx?: { [k: string]: any } | undefined;
+  errorId?: string | undefined;
+  type: string;
+  errors: Array<components.PayloadValidationErrorDto$Outbound>;
+  schema?: Schema$Outbound | undefined;
+};
+
+/** @internal */
+export const PayloadValidationExceptionDto$outboundSchema: z.ZodType<
+  PayloadValidationExceptionDto$Outbound,
+  z.ZodTypeDef,
+  PayloadValidationExceptionDto
+> = z.instanceof(PayloadValidationExceptionDto)
+  .transform(v => v.data$)
+  .pipe(z.object({
+    statusCode: z.number(),
+    timestamp: z.string(),
+    path: z.string(),
+    message: z.nullable(
+      z.union([
+        z.lazy(() => MessagePayloadValidationExceptionDto4$outboundSchema),
+        z.string(),
+        z.number(),
+        z.boolean(),
+        z.array(
+          z.nullable(
+            z.union([z.string(), z.number(), z.boolean(), z.record(z.any())]),
+          ),
+        ),
+      ]),
+    ).optional(),
+    ctx: z.record(z.any()).optional(),
+    errorId: z.string().optional(),
+    type: z.string(),
+    errors: z.array(components.PayloadValidationErrorDto$outboundSchema),
+    schema: z.lazy(() => Schema$outboundSchema).optional(),
+  }));
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PayloadValidationExceptionDto$ {
+  /** @deprecated use `PayloadValidationExceptionDto$inboundSchema` instead. */
+  export const inboundSchema = PayloadValidationExceptionDto$inboundSchema;
+  /** @deprecated use `PayloadValidationExceptionDto$outboundSchema` instead. */
+  export const outboundSchema = PayloadValidationExceptionDto$outboundSchema;
+  /** @deprecated use `PayloadValidationExceptionDto$Outbound` instead. */
+  export type Outbound = PayloadValidationExceptionDto$Outbound;
+}

package/src/models/errors/responsevalidationerror.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { NovuError } from "./novuerror.js";
+import { formatZodError } from "./sdkvalidationerror.js";
+
+export class ResponseValidationError extends NovuError {
+  /**
+   * The raw value that failed validation.
+   */
+  public readonly rawValue: unknown;
+
+  /**
+   * The raw message that failed validation.
+   */
+  public readonly rawMessage: unknown;
+
+  constructor(
+    message: string,
+    extra: {
+      response: Response;
+      request: Request;
+      body: string;
+      cause: unknown;
+      rawValue: unknown;
+      rawMessage: unknown;
+    },
+  ) {
+    super(message, extra);
+    this.name = "ResponseValidationError";
+    this.cause = extra.cause;
+    this.rawValue = extra.rawValue;
+    this.rawMessage = extra.rawMessage;
+  }
+
+  /**
+   * Return a pretty-formatted error message if the underlying validation error
+   * is a ZodError or some other recognized error type, otherwise return the
+   * default error message.
+   */
+  public pretty(): string {
+    if (this.cause instanceof z.ZodError) {
+      return `${this.rawMessage}\n${formatZodError(this.cause)}`;
+    } else {
+      return this.toString();
+    }
+  }
+}

package/src/models/errors/sdkerror.ts

@@ -2,26 +2,33 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export class SDKError extends Error {
-  public readonly statusCode: number;
-  public readonly contentType: string;
+import { NovuError } from "./novuerror.js";
 
+/** The fallback error class if no more specific error class is matched */
+export class SDKError extends NovuError {
   constructor(
     message: string,
-    public readonly rawResponse: Response,
-    public readonly body: string = "",
+    httpMeta: {
+      response: Response;
+      request: Request;
+      body: string;
+    },
   ) {
-    const statusCode = rawResponse.status;
-    const contentType = rawResponse.headers.get("content-type") || "";
-    const bodyString = body.length > 0 ? `\n${body}` : "";
-
-    super(
-      `${message}: Status ${statusCode} Content-Type ${contentType} Body ${bodyString}`,
-    );
-
-    this.statusCode = statusCode;
-    this.contentType = contentType;
-
+    if (message) {
+      message += `: `;
+    }
+    message += `Status ${httpMeta.response.status}`;
+    const contentType = httpMeta.response.headers.get("content-type") || `""`;
+    if (contentType !== "application/json") {
+      message += ` Content-Type ${
+        contentType.includes(" ") ? `"${contentType}"` : contentType
+      }`;
+    }
+    const body = httpMeta.body || `""`;
+    message += body.length > 100 ? "\n" : " ";
+    message += `Body ${body}`;
+    message = message.trim();
+    super(message, httpMeta);
     this.name = "SDKError";
   }
 }

package/src/models/errors/sdkvalidationerror.ts

@@ -15,6 +15,18 @@ export class SDKValidationError extends Error {
    */
   public readonly rawMessage: unknown;
 
+  // Allows for backwards compatibility for `instanceof` checks of `ResponseValidationError`
+  static override [Symbol.hasInstance](
+    instance: unknown,
+  ): instance is SDKValidationError {
+    if (!(instance instanceof Error)) return false;
+    if (!("rawValue" in instance)) return false;
+    if (!("rawMessage" in instance)) return false;
+    if (!("pretty" in instance)) return false;
+    if (typeof instance.pretty !== "function") return false;
+    return true;
+  }
+
   constructor(message: string, cause: unknown, rawValue: unknown) {
     super(`${message}: ${cause}`);
     this.name = "SDKValidationError";

package/src/models/errors/validationerrordto.ts

@@ -6,6 +6,7 @@ import * as z from "zod";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
+import { NovuError } from "./novuerror.js";
 import { SDKValidationError } from "./sdkvalidationerror.js";
 
 export type Message5 = string | number | boolean | { [k: string]: any };
@@ -63,11 +64,7 @@ export type ValidationErrorDtoData = {
   errors: { [k: string]: components.ConstraintValidation };
 };
 
-export class ValidationErrorDto extends Error {
-  /**
-   * HTTP status code of the error response.
-   */
-  statusCode: number;
+export class ValidationErrorDto extends NovuError {
   /**
    * Timestamp of when the error occurred.
    */
@@ -95,14 +92,15 @@ export class ValidationErrorDto extends Error {
   /** The original data that was passed to this error instance. */
   data$: ValidationErrorDtoData;
 
-  constructor(err: ValidationErrorDtoData) {
+  constructor(
+    err: ValidationErrorDtoData,
+    httpMeta: { response: Response; request: Request; body: string },
+  ) {
     const message = "message" in err && typeof err.message === "string"
       ? err.message
       : `API error occurred: ${JSON.stringify(err)}`;
-    super(message);
+    super(message, httpMeta);
     this.data$ = err;
-
-    this.statusCode = err.statusCode;
     this.timestamp = err.timestamp;
     this.path = err.path;
     if (err.ctx != null) this.ctx = err.ctx;
@@ -301,9 +299,16 @@ export const ValidationErrorDto$inboundSchema: z.ZodType<
   ctx: z.record(z.any()).optional(),
   errorId: z.string().optional(),
   errors: z.record(components.ConstraintValidation$inboundSchema),
+  request$: z.instanceof(Request),
+  response$: z.instanceof(Response),
+  body$: z.string(),
 })
   .transform((v) => {
-    return new ValidationErrorDto(v);
+    return new ValidationErrorDto(v, {
+      request: v.request$,
+      response: v.response$,
+      body: v.body$,
+    });
   });
 
 /** @internal */