@novu/api 0.0.1-alpha.9 → 0.0.1-alpha.92

package/src/hooks/hooks.ts

@@ -1,103 +1,132 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import { RequestInput } from "../lib/http.js";
 import {
-    AfterErrorContext,
-    AfterErrorHook,
-    AfterSuccessContext,
-    AfterSuccessHook,
-    BeforeRequestContext,
-    BeforeRequestHook,
-    BeforeCreateRequestHook,
-    BeforeCreateRequestContext,
-    Hooks,
-    SDKInitHook,
-    SDKInitOptions,
+  AfterErrorContext,
+  AfterErrorHook,
+  AfterSuccessContext,
+  AfterSuccessHook,
+  BeforeCreateRequestContext,
+  BeforeCreateRequestHook,
+  BeforeRequestContext,
+  BeforeRequestHook,
+  Hook,
+  Hooks,
+  SDKInitHook,
+  SDKInitOptions,
 } from "./types.js";
 
 import { initHooks } from "./registration.js";
 
 export class SDKHooks implements Hooks {
-    sdkInitHooks: SDKInitHook[] = [];
-    beforeCreateRequestHooks: BeforeCreateRequestHook[] = [];
-    beforeRequestHooks: BeforeRequestHook[] = [];
-    afterSuccessHooks: AfterSuccessHook[] = [];
-    afterErrorHooks: AfterErrorHook[] = [];
-
-    constructor() {
-        initHooks(this);
+  sdkInitHooks: SDKInitHook[] = [];
+  beforeCreateRequestHooks: BeforeCreateRequestHook[] = [];
+  beforeRequestHooks: BeforeRequestHook[] = [];
+  afterSuccessHooks: AfterSuccessHook[] = [];
+  afterErrorHooks: AfterErrorHook[] = [];
+
+  constructor() {
+    const presetHooks: Array<Hook> = [];
+
+    for (const hook of presetHooks) {
+      if ("sdkInit" in hook) {
+        this.registerSDKInitHook(hook);
+      }
+      if ("beforeCreateRequest" in hook) {
+        this.registerBeforeCreateRequestHook(hook);
+      }
+      if ("beforeRequest" in hook) {
+        this.registerBeforeRequestHook(hook);
+      }
+      if ("afterSuccess" in hook) {
+        this.registerAfterSuccessHook(hook);
+      }
+      if ("afterError" in hook) {
+        this.registerAfterErrorHook(hook);
+      }
     }
+    initHooks(this);
+  }
 
-    registerSDKInitHook(hook: SDKInitHook) {
-        this.sdkInitHooks.push(hook);
-    }
-
-    registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook) {
-        this.beforeCreateRequestHooks.push(hook);
-    }
+  registerSDKInitHook(hook: SDKInitHook) {
+    this.sdkInitHooks.push(hook);
+  }
 
-    registerBeforeRequestHook(hook: BeforeRequestHook) {
-        this.beforeRequestHooks.push(hook);
-    }
+  registerBeforeCreateRequestHook(hook: BeforeCreateRequestHook) {
+    this.beforeCreateRequestHooks.push(hook);
+  }
 
-    registerAfterSuccessHook(hook: AfterSuccessHook) {
-        this.afterSuccessHooks.push(hook);
-    }
+  registerBeforeRequestHook(hook: BeforeRequestHook) {
+    this.beforeRequestHooks.push(hook);
+  }
 
-    registerAfterErrorHook(hook: AfterErrorHook) {
-        this.afterErrorHooks.push(hook);
-    }
+  registerAfterSuccessHook(hook: AfterSuccessHook) {
+    this.afterSuccessHooks.push(hook);
+  }
 
-    sdkInit(opts: SDKInitOptions): SDKInitOptions {
-        return this.sdkInitHooks.reduce((opts, hook) => hook.sdkInit(opts), opts);
-    }
+  registerAfterErrorHook(hook: AfterErrorHook) {
+    this.afterErrorHooks.push(hook);
+  }
 
-    beforeCreateRequest(hookCtx: BeforeCreateRequestContext, input: RequestInput): RequestInput {
-        let inp = input;
+  sdkInit(opts: SDKInitOptions): SDKInitOptions {
+    return this.sdkInitHooks.reduce((opts, hook) => hook.sdkInit(opts), opts);
+  }
 
-        for (const hook of this.beforeCreateRequestHooks) {
-            inp = hook.beforeCreateRequest(hookCtx, inp);
-        }
+  beforeCreateRequest(
+    hookCtx: BeforeCreateRequestContext,
+    input: RequestInput,
+  ): RequestInput {
+    let inp = input;
 
-        return inp;
+    for (const hook of this.beforeCreateRequestHooks) {
+      inp = hook.beforeCreateRequest(hookCtx, inp);
     }
 
-    async beforeRequest(hookCtx: BeforeRequestContext, request: Request): Promise<Request> {
-        let req = request;
+    return inp;
+  }
 
-        for (const hook of this.beforeRequestHooks) {
-            req = await hook.beforeRequest(hookCtx, req);
-        }
+  async beforeRequest(
+    hookCtx: BeforeRequestContext,
+    request: Request,
+  ): Promise<Request> {
+    let req = request;
 
-        return req;
+    for (const hook of this.beforeRequestHooks) {
+      req = await hook.beforeRequest(hookCtx, req);
     }
 
-    async afterSuccess(hookCtx: AfterSuccessContext, response: Response): Promise<Response> {
-        let res = response;
+    return req;
+  }
 
-        for (const hook of this.afterSuccessHooks) {
-            res = await hook.afterSuccess(hookCtx, res);
-        }
+  async afterSuccess(
+    hookCtx: AfterSuccessContext,
+    response: Response,
+  ): Promise<Response> {
+    let res = response;
 
-        return res;
+    for (const hook of this.afterSuccessHooks) {
+      res = await hook.afterSuccess(hookCtx, res);
     }
 
-    async afterError(
-        hookCtx: AfterErrorContext,
-        response: Response | null,
-        error: unknown
-    ): Promise<{ response: Response | null; error: unknown }> {
-        let res = response;
-        let err = error;
-
-        for (const hook of this.afterErrorHooks) {
-            const result = await hook.afterError(hookCtx, res, err);
-            res = result.response;
-            err = result.error;
-        }
-
-        return { response: res, error: err };
+    return res;
+  }
+
+  async afterError(
+    hookCtx: AfterErrorContext,
+    response: Response | null,
+    error: unknown,
+  ): Promise<{ response: Response | null; error: unknown }> {
+    let res = response;
+    let err = error;
+
+    for (const hook of this.afterErrorHooks) {
+      const result = await hook.afterError(hookCtx, res, err);
+      res = result.response;
+      err = result.error;
     }
+
+    return { response: res, error: err };
+  }
 }

package/src/hooks/index.ts

@@ -1,6 +1,6 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-export * from "./types.js";
 export * from "./hooks.js";
+export * from "./types.js";

package/src/hooks/novu-custom-hook.ts

@@ -0,0 +1,37 @@
+import {AfterSuccessContext, AfterSuccessHook, BeforeRequestContext, BeforeRequestHook} from "./types";
+
+export class NovuCustomHook
+    implements  BeforeRequestHook, AfterSuccessHook
+{
+    beforeRequest(_hookCtx: BeforeRequestContext, request: Request): Request {
+        const authKey = 'authorization';
+        const hasAuthorization = request.headers.has(authKey);
+        const apiKeyPrefix = 'ApiKey';
+        if (hasAuthorization) {
+            const key = request.headers.get(authKey);
+
+            if (key && !key.includes(apiKeyPrefix)) {
+                request.headers.set(authKey,`${apiKeyPrefix} ${key}`)
+            }
+        }
+        return request;
+    }
+
+    async afterSuccess(_hookCtx: AfterSuccessContext, response: Response): Promise<Response> {
+        const responseAsText = await response.clone().text();
+        if (!responseAsText || responseAsText =='') {
+            return response;
+        }
+        const jsonResponse = await response.clone().json();
+
+        if (jsonResponse && Object.keys(jsonResponse).length === 1 && 'data' in jsonResponse) {
+            return new Response(JSON.stringify(jsonResponse.data), {
+                status: response.status,
+                statusText: response.statusText,
+                headers: response.headers,
+            }); // Return the new Response object
+        }
+
+        return response;
+    }
+}

package/src/hooks/registration.ts

@@ -1,28 +1,13 @@
-import { isPlainObject } from "../lib/is-plain-object";
-import {AfterSuccessContext, AfterSuccessHook, Hooks} from "./types";
+import { Hooks } from "./types.js";
+import {NovuCustomHook} from "./novu-custom-hook";
 
-export function initHooks(hooks: Hooks) {
-    hooks.registerAfterSuccessHook(new TransformResponse());
-}
+/*
+ * This file is only ever generated once on the first generation and then is free to be modified.
+ * Any hooks you wish to add should be registered in the initHooks function. Feel free to define them
+ * in this file or in separate files in the hooks folder.
+ */
 
-function isResponseEnveloped(body: unknown): body is { data: unknown } {
-    return isPlainObject(body) && "data" in body && Object.keys(body).every(key => key === "data") && isPlainObject(body.data);
+export function initHooks(hooks: Hooks) {
+    hooks.registerAfterSuccessHook(new NovuCustomHook())
+    hooks.registerBeforeRequestHook(new NovuCustomHook())
 }
-
-class TransformResponse implements AfterSuccessHook {
-
-    async afterSuccess(_context: AfterSuccessContext, response: Response) {
-        if (!response.ok) {
-            return response;
-        }
-
-        const body: unknown = await response.json();
-        const validBody =
-            isResponseEnveloped(body);
-        if (!validBody) {
-            return new Response(JSON.stringify(body), response);
-        }
-        return new Response(JSON.stringify(body.data), response);
-    }
-
-}

package/src/hooks/types.ts

@@ -1,20 +1,24 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import { HTTPClient, RequestInput } from "../lib/http.js";
+import { RetryConfig } from "../lib/retries.js";
+import { SecurityState } from "../lib/security.js";
 
 export type HookContext = {
-    operationID: string;
-    oAuth2Scopes?: string[];
-    securitySource?: any | (() => Promise<any>);
+  operationID: string;
+  oAuth2Scopes?: string[];
+  securitySource?: any | (() => Promise<any>);
+  retryConfig: RetryConfig;
+  resolvedSecurity: SecurityState | null;
 };
 
 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 +31,79 @@ 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;
 }
+
+export type Hook =
+  | SDKInitHook
+  | BeforeCreateRequestHook
+  | BeforeRequestHook
+  | AfterSuccessHook
+  | AfterErrorHook;

package/src/index.ts

@@ -1,6 +1,7 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * 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/base64.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import * as z from "zod";

package/src/lib/config.ts

@@ -1,55 +1,61 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import { HTTPClient } from "./http.js";
+import { Logger } from "./logger.js";
 import { RetryConfig } from "./retries.js";
 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;
+  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.9",
-    genVersion: "2.354.2",
-    userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.9 2.354.2 1.0 @novu/api",
+  language: "typescript",
+  openapiDocVersion: "1.0",
+  sdkVersion: "0.0.1-alpha.92",
+  genVersion: "2.477.0",
+  userAgent: "speakeasy-sdk/typescript 0.0.1-alpha.92 2.477.0 1.0 @novu/api",
 } as const;

package/src/lib/dlv.ts

@@ -0,0 +1,53 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/*
+MIT License
+
+Copyright (c) 2024 Jason Miller <jason@developit.ca> (http://jasonformat.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+/**
+ * @param obj The object to walk
+ * @param key The key path to walk the object with
+ * @param def A default value to return if the result is undefined
+ *
+ * @example
+ * dlv(obj, "a.b.c.d")
+ * @example
+ * dlv(object, ["a", "b", "c", "d"])
+ * @example
+ * dlv(object, "foo.bar.baz", "Hello, default value!")
+ */
+export function dlv<T = any>(
+  obj: any,
+  key: string | string[],
+  def?: T,
+  p?: number,
+  undef?: never,
+): T | undefined {
+  key = Array.isArray(key) ? key : key.split(".");
+  for (p = 0; p < key.length; p++) {
+    const k = key[p];
+    obj = k != null && obj ? obj[k] : undef;
+  }
+  return obj === undef ? def : obj;
+}

package/src/lib/encodings.ts

@@ -1,5 +1,5 @@
 /*
- * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
 import { bytesToBase64 } from "./base64.js";
@@ -212,6 +212,24 @@ export function encodeDeepObject(
     return "";
   }
 
+  if (!isPlainObject(value)) {
+    throw new EncodingError(
+      `Value of parameter '${key}' which uses deepObject encoding must be an object`,
+    );
+  }
+
+  return encodeDeepObjectObject(key, value, options);
+}
+
+export function encodeDeepObjectObject(
+  key: string,
+  value: unknown,
+  options?: { charEncoding?: "percent" | "none" },
+): string {
+  if (value == null) {
+    return "";
+  }
+
   let out = "";
 
   const encodeString = (v: string) => {
@@ -219,9 +237,7 @@ export function encodeDeepObject(
   };
 
   if (!isPlainObject(value)) {
-    throw new EncodingError(
-      `Value of parameter '${key}' which uses deepObject encoding must be an object`,
-    );
+    throw new EncodingError(`Expected parameter '${key}' to be an object.`);
   }
 
   Object.entries(value).forEach(([ck, cv]) => {
@@ -232,9 +248,11 @@ export function encodeDeepObject(
     const pk = `${key}[${ck}]`;
 
     if (isPlainObject(cv)) {
-      throw new EncodingError(
-        `Value of parameter field '${pk}' cannot be an array or object.`,
-      );
+      const objOut = encodeDeepObjectObject(pk, cv, options);
+
+      out += `&${objOut}`;
+
+      return;
     }
 
     const pairs: unknown[] = Array.isArray(cv) ? cv : [cv];