@novu/api 0.0.1-alpha.10 → 0.0.1-alpha.11

package/src/hooks/types.ts

@@ -5,16 +5,16 @@
 import { HTTPClient, RequestInput } from "../lib/http.js";
 
 export type HookContext = {
-    operationID: string;
-    oAuth2Scopes?: string[];
-    securitySource?: any | (() => Promise<any>);
+  operationID: string;
+  oAuth2Scopes?: string[];
+  securitySource?: any | (() => Promise<any>);
 };
 
 export type Awaitable<T> = T | Promise<T>;
 
 export type SDKInitOptions = {
-    baseURL: URL | null;
-    client: HTTPClient;
+  baseURL: URL | null;
+  client: HTTPClient;
 };
 
 export type BeforeCreateRequestContext = HookContext & {};
@@ -27,63 +27,72 @@ export type AfterErrorContext = HookContext & {};
  * hook can return a new baseURL and HTTP client to be used by the SDK.
  */
 export interface SDKInitHook {
-    sdkInit: (opts: SDKInitOptions) => SDKInitOptions;
+  sdkInit: (opts: SDKInitOptions) => SDKInitOptions;
 }
 
 export interface BeforeCreateRequestHook {
-    /**
-     * A hook that is called before the SDK creates a `Request` object. The hook
-     * can modify how a request is constructed since certain modifications, like
-     * changing the request URL, cannot be done on a request object directly.
-     */
-    beforeCreateRequest: (hookCtx: BeforeCreateRequestContext, input: RequestInput) => RequestInput;
+  /**
+   * A hook that is called before the SDK creates a `Request` object. The hook
+   * can modify how a request is constructed since certain modifications, like
+   * changing the request URL, cannot be done on a request object directly.
+   */
+  beforeCreateRequest: (
+    hookCtx: BeforeCreateRequestContext,
+    input: RequestInput,
+  ) => RequestInput;
 }
 
 export interface BeforeRequestHook {
-    /**
-     * A hook that is called before the SDK sends a request. The hook can
-     * introduce instrumentation code such as logging, tracing and metrics or
-     * replace the request before it is sent or throw an error to stop the
-     * request from being sent.
-     */
-    beforeRequest: (hookCtx: BeforeRequestContext, request: Request) => Awaitable<Request>;
+  /**
+   * A hook that is called before the SDK sends a request. The hook can
+   * introduce instrumentation code such as logging, tracing and metrics or
+   * replace the request before it is sent or throw an error to stop the
+   * request from being sent.
+   */
+  beforeRequest: (
+    hookCtx: BeforeRequestContext,
+    request: Request,
+  ) => Awaitable<Request>;
 }
 
 export interface AfterSuccessHook {
-    /**
-     * A hook that is called after the SDK receives a response. The hook can
-     * introduce instrumentation code such as logging, tracing and metrics or
-     * modify the response before it is handled or throw an error to stop the
-     * response from being handled.
-     */
-    afterSuccess: (hookCtx: AfterSuccessContext, response: Response) => Awaitable<Response>;
+  /**
+   * A hook that is called after the SDK receives a response. The hook can
+   * introduce instrumentation code such as logging, tracing and metrics or
+   * modify the response before it is handled or throw an error to stop the
+   * response from being handled.
+   */
+  afterSuccess: (
+    hookCtx: AfterSuccessContext,
+    response: Response,
+  ) => Awaitable<Response>;
 }
 
 export interface AfterErrorHook {
-    /**
-     * A hook that is called after the SDK encounters an error, or a
-     * non-successful response. The hook can introduce instrumentation code such
-     * as logging, tracing and metrics or modify the response or error values.
-     */
-    afterError: (
-        hookCtx: AfterErrorContext,
-        response: Response | null,
-        error: unknown
-    ) => Awaitable<{
-        response: Response | null;
-        error: unknown;
-    }>;
+  /**
+   * A hook that is called after the SDK encounters an error, or a
+   * non-successful response. The hook can introduce instrumentation code such
+   * as logging, tracing and metrics or modify the response or error values.
+   */
+  afterError: (
+    hookCtx: AfterErrorContext,
+    response: Response | null,
+    error: unknown,
+  ) => Awaitable<{
+    response: Response | null;
+    error: unknown;
+  }>;
 }
 
 export interface Hooks {
-    /** Registers a hook to be used by the SDK for initialization event. */
-    registerSDKInitHook(hook: SDKInitHook): void;
-    /** Registers a hook to be used by the SDK for to modify `Request` construction. */
-    registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void;
-    /** Registers a hook to be used by the SDK for the before request event. */
-    registerBeforeRequestHook(hook: BeforeRequestHook): void;
-    /** Registers a hook to be used by the SDK for the after success event. */
-    registerAfterSuccessHook(hook: AfterSuccessHook): void;
-    /** Registers a hook to be used by the SDK for the after error event. */
-    registerAfterErrorHook(hook: AfterErrorHook): void;
+  /** Registers a hook to be used by the SDK for initialization event. */
+  registerSDKInitHook(hook: SDKInitHook): void;
+  /** Registers a hook to be used by the SDK for to modify `Request` construction. */
+  registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook): void;
+  /** Registers a hook to be used by the SDK for the before request event. */
+  registerBeforeRequestHook(hook: BeforeRequestHook): void;
+  /** Registers a hook to be used by the SDK for the after success event. */
+  registerAfterSuccessHook(hook: AfterSuccessHook): void;
+  /** Registers a hook to be used by the SDK for the after error event. */
+  registerAfterErrorHook(hook: AfterErrorHook): void;
 }

package/src/index.ts

@@ -2,5 +2,6 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export * from "./sdk/sdk.js";
 export * from "./lib/config.js";
+export * as files from "./lib/files.js";
+export * from "./sdk/sdk.js";

package/src/lib/config.ts

@@ -10,49 +10,52 @@ import { Params, pathToFunc } from "./url.js";
 /**
  * Contains the list of servers available to the SDK
  */
-export const ServerList = ["https://api.novu.co", "https://eu.api.novu.co"] as const;
+export const ServerList = [
+  "https://api.novu.co",
+  "https://eu.api.novu.co",
+] as const;
 
 export type SDKOptions = {
-    apiKey?: string | (() => Promise<string>);
-
-    httpClient?: HTTPClient;
-    /**
-     * Allows overriding the default server used by the SDK
-     */
-    serverIdx?: number;
-    /**
-     * Allows overriding the default server URL used by the SDK
-     */
-    serverURL?: string;
-    /**
-     * Allows overriding the default retry config used by the SDK
-     */
-    retryConfig?: RetryConfig;
-    timeoutMs?: number;
-    debugLogger?: Logger;
+  apiKey?: string | (() => Promise<string>);
+
+  httpClient?: HTTPClient;
+  /**
+   * Allows overriding the default server used by the SDK
+   */
+  serverIdx?: number;
+  /**
+   * Allows overriding the default server URL used by the SDK
+   */
+  serverURL?: string;
+  /**
+   * Allows overriding the default retry config used by the SDK
+   */
+  retryConfig?: RetryConfig;
+  timeoutMs?: number;
+  debugLogger?: Logger;
 };
 
 export function serverURLFromOptions(options: SDKOptions): URL | null {
-    let serverURL = options.serverURL;
+  let serverURL = options.serverURL;
 
-    const params: Params = {};
+  const params: Params = {};
 
-    if (!serverURL) {
-        const serverIdx = options.serverIdx ?? 0;
-        if (serverIdx < 0 || serverIdx >= ServerList.length) {
-            throw new Error(`Invalid server index ${serverIdx}`);
-        }
-        serverURL = ServerList[serverIdx] || "";
+  if (!serverURL) {
+    const serverIdx = options.serverIdx ?? 0;
+    if (serverIdx < 0 || serverIdx >= ServerList.length) {
+      throw new Error(`Invalid server index ${serverIdx}`);
     }
+    serverURL = ServerList[serverIdx] || "";
+  }
 
-    const u = pathToFunc(serverURL)(params);
-    return new URL(u);
+  const u = pathToFunc(serverURL)(params);
+  return new URL(u);
 }
 
 export const SDK_METADATA = {
-    language: "typescript",
-    openapiDocVersion: "1.0",
-    sdkVersion: "0.0.1-alpha.10",
-    genVersion: "2.407.2",
-    userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.10 2.407.2 1.0 @novu/api",
+  language: "typescript",
+  openapiDocVersion: "1.0",
+  sdkVersion: "0.0.1-alpha.11",
+  genVersion: "2.416.6",
+  userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.11 2.416.6 1.0 @novu/api",
 } as const;

package/src/lib/files.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/**
+ * Consumes a stream and returns a concatenated array buffer. Useful in
+ * situations where we need to read the whole file because it forms part of a
+ * larger payload containing other fields, and we can't modify the underlying
+ * request structure.
+ */
+export async function readableStreamToArrayBuffer(
+  readable: ReadableStream<Uint8Array>,
+): Promise<ArrayBuffer> {
+  const reader = readable.getReader();
+  const chunks: Uint8Array[] = [];
+
+  let totalLength = 0;
+  let done = false;
+
+  while (!done) {
+    const { value, done: doneReading } = await reader.read();
+
+    if (doneReading) {
+      done = true;
+    } else {
+      chunks.push(value);
+      totalLength += value.length;
+    }
+  }
+
+  const concatenatedChunks = new Uint8Array(totalLength);
+  let offset = 0;
+
+  for (const chunk of chunks) {
+    concatenatedChunks.set(chunk, offset);
+    offset += chunk.length;
+  }
+
+  return concatenatedChunks.buffer;
+}