@novu/api 0.0.1-alpha.10

package/src/lib/primitives.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export type Remap<Inp, Mapping extends { [k in keyof Inp]?: string | null }> = {
+  [k in keyof Inp as Mapping[k] extends string /* if we have a string mapping for this key then use it */
+    ? Mapping[k]
+    : Mapping[k] extends null /* if the mapping is to `null` then drop the key */
+    ? never
+    : k /* otherwise keep the key as-is */]: Inp[k];
+};
+
+/**
+ * Converts or omits an object's keys according to a mapping.
+ *
+ * @param inp An object whose keys will be remapped
+ * @param mappings A mapping of original keys to new keys. If a key is not present in the mapping, it will be left as is. If a key is mapped to `null`, it will be removed in the resulting object.
+ * @returns A new object with keys remapped or omitted according to the mappings
+ */
+export function remap<
+  Inp extends Record<string, unknown>,
+  const Mapping extends { [k in keyof Inp]?: string | null },
+>(inp: Inp, mappings: Mapping): Remap<Inp, Mapping> {
+  let out: any = {};
+
+  if (!Object.keys(mappings).length) {
+    out = inp;
+    return out;
+  }
+
+  for (const [k, v] of Object.entries(inp)) {
+    const j = mappings[k];
+    if (j === null) {
+      continue;
+    }
+    out[j ?? k] = v;
+  }
+
+  return out;
+}

package/src/lib/retries.ts

@@ -0,0 +1,187 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { isConnectionError, isTimeoutError } from "./http.js";
+
+export type BackoffStrategy = {
+  initialInterval: number;
+  maxInterval: number;
+  exponent: number;
+  maxElapsedTime: number;
+};
+
+const defaultBackoff: BackoffStrategy = {
+  initialInterval: 500,
+  maxInterval: 60000,
+  exponent: 1.5,
+  maxElapsedTime: 3600000,
+};
+
+export type RetryConfig =
+  | { strategy: "none" }
+  | {
+      strategy: "backoff";
+      backoff?: BackoffStrategy;
+      retryConnectionErrors?: boolean;
+    };
+
+class PermanentError extends Error {
+  inner: unknown;
+
+  constructor(inner: unknown) {
+    super("Permanent error");
+    this.inner = inner;
+
+    Object.setPrototypeOf(this, PermanentError.prototype);
+  }
+}
+
+class TemporaryError extends Error {
+  res: Response;
+
+  constructor(res: Response) {
+    super("Temporary error");
+    this.res = res;
+
+    Object.setPrototypeOf(this, TemporaryError.prototype);
+  }
+}
+
+export async function retry(
+  fetchFn: () => Promise<Response>,
+  options: {
+    config: RetryConfig;
+    statusCodes: string[];
+  },
+): Promise<Response> {
+  switch (options.config.strategy) {
+    case "backoff":
+      return retryBackoff(
+        wrapFetcher(fetchFn, {
+          statusCodes: options.statusCodes,
+          retryConnectionErrors: !!options.config.retryConnectionErrors,
+        }),
+        options.config.backoff ?? defaultBackoff,
+      );
+    default:
+      return await fetchFn();
+  }
+}
+
+function wrapFetcher(
+  fn: () => Promise<Response>,
+  options: {
+    statusCodes: string[];
+    retryConnectionErrors: boolean;
+  },
+): () => Promise<Response> {
+  return async () => {
+    try {
+      const res = await fn();
+      if (isRetryableResponse(res, options.statusCodes)) {
+        throw new TemporaryError(res);
+      }
+
+      return res;
+    } catch (err) {
+      if (err instanceof TemporaryError) {
+        throw err;
+      }
+
+      if (
+        options.retryConnectionErrors &&
+        (isTimeoutError(err) || isConnectionError(err))
+      ) {
+        throw err;
+      }
+
+      throw new PermanentError(err);
+    }
+  };
+}
+
+const codeRangeRE = new RegExp("^[0-9]xx$", "i");
+
+function isRetryableResponse(res: Response, statusCodes: string[]): boolean {
+  const actual = `${res.status}`;
+
+  return statusCodes.some((code) => {
+    if (!codeRangeRE.test(code)) {
+      return code === actual;
+    }
+
+    const expectFamily = code.charAt(0);
+    if (!expectFamily) {
+      throw new Error("Invalid status code range");
+    }
+
+    const actualFamily = actual.charAt(0);
+    if (!actualFamily) {
+      throw new Error(`Invalid response status code: ${actual}`);
+    }
+
+    return actualFamily === expectFamily;
+  });
+}
+
+async function retryBackoff(
+  fn: () => Promise<Response>,
+  strategy: BackoffStrategy,
+): Promise<Response> {
+  const { maxElapsedTime, initialInterval, exponent, maxInterval } = strategy;
+
+  const start = Date.now();
+  let x = 0;
+
+  // eslint-disable-next-line no-constant-condition
+  while (true) {
+    try {
+      const res = await fn();
+      return res;
+    } catch (err) {
+      if (err instanceof PermanentError) {
+        throw err.inner;
+      }
+      const elapsed = Date.now() - start;
+      if (elapsed > maxElapsedTime) {
+        if (err instanceof TemporaryError) {
+          return err.res;
+        }
+
+        throw err;
+      }
+
+      let retryInterval = 0;
+      if (err instanceof TemporaryError && err.res && err.res.headers) {
+        const retryVal = err.res.headers.get("retry-after") || "";
+        if (retryVal != "") {
+          const parsedNumber = Number(retryVal);
+          if (!isNaN(parsedNumber) && Number.isInteger(parsedNumber)) {
+            retryInterval = parsedNumber * 1000;
+          } else {
+            const parsedDate = Date.parse(retryVal);
+            if (!isNaN(parsedDate)) {
+              const deltaMS = parsedDate - Date.now();
+              retryInterval = deltaMS > 0 ? Math.ceil(deltaMS) : 0;
+            }
+          }
+        }
+      }
+
+      if (retryInterval == 0) {
+        retryInterval =
+          initialInterval * Math.pow(x, exponent) + Math.random() * 1000;
+      }
+
+      const d = Math.min(retryInterval, maxInterval);
+
+      await delay(d);
+      x++;
+    }
+  }
+}
+
+async function delay(delay: number): Promise<void> {
+  return new Promise((resolve) => setTimeout(resolve, delay));
+}

package/src/lib/schemas.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { output, ZodEffects, ZodError, ZodObject, ZodRawShape, ZodTypeAny } from "zod";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { ERR, OK, Result } from "../types/fp.js";
+
+/**
+ * Utility function that executes some code which may throw a ZodError. It
+ * intercepts this error and converts it to an SDKValidationError so as to not
+ * leak Zod implementation details to user code.
+ */
+export function parse<Inp, Out>(rawValue: Inp, fn: (value: Inp) => Out, errorMessage: string): Out {
+    try {
+        return fn(rawValue);
+    } catch (err) {
+        if (err instanceof ZodError) {
+            throw new SDKValidationError(errorMessage, err, rawValue);
+        }
+        throw err;
+    }
+}
+
+/**
+ * Utility function that executes some code which may result in a ZodError. It
+ * intercepts this error and converts it to an SDKValidationError so as to not
+ * leak Zod implementation details to user code.
+ */
+export function safeParse<Inp, Out>(
+    rawValue: Inp,
+    fn: (value: Inp) => Out,
+    errorMessage: string
+): Result<Out, SDKValidationError> {
+    try {
+        return OK(fn(rawValue));
+    } catch (err) {
+        return ERR(new SDKValidationError(errorMessage, err, rawValue));
+    }
+}
+
+export function collectExtraKeys<
+    Shape extends ZodRawShape,
+    Catchall extends ZodTypeAny,
+    K extends string
+>(
+    obj: ZodObject<Shape, "strip", Catchall>,
+    extrasKey: K
+): ZodEffects<
+    typeof obj,
+    output<ZodObject<Shape, "strict">> & {
+        [k in K]: Record<string, output<Catchall>>;
+    }
+> {
+    return obj.transform((val) => {
+        const extras: Record<string, output<Catchall>> = {};
+        const { shape } = obj;
+        for (const [key] of Object.entries(val)) {
+            if (key in shape) {
+                continue;
+            }
+
+            const v = val[key];
+            if (typeof v === "undefined") {
+                continue;
+            }
+
+            extras[key] = v;
+            delete val[key];
+        }
+
+        return { ...val, [extrasKey]: extras };
+    });
+}

package/src/lib/sdks.ts

@@ -0,0 +1,357 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+    HTTPClient,
+    matchContentType,
+    matchStatusCode,
+    isAbortError,
+    isTimeoutError,
+    isConnectionError,
+} from "./http.js";
+import { SecurityState } from "./security.js";
+import { retry, RetryConfig } from "./retries.js";
+import { Logger } from "./logger.js";
+import { encodeForm } from "./encodings.js";
+import { stringToBase64 } from "./base64.js";
+import { SDKOptions, SDK_METADATA, serverURLFromOptions } from "./config.js";
+import { SDKHooks } from "../hooks/hooks.js";
+import { HookContext } from "../hooks/types.js";
+import {
+    ConnectionError,
+    InvalidRequestError,
+    RequestAbortedError,
+    RequestTimeoutError,
+    UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { ERR, OK, Result } from "../types/fp.js";
+
+export type RequestOptions = {
+    /**
+     * Sets a timeout, in milliseconds, on HTTP requests made by an SDK method. If
+     * `fetchOptions.signal` is set then it will take precedence over this option.
+     */
+    timeoutMs?: number;
+    /**
+     * Set or override a retry policy on HTTP calls.
+     */
+    retries?: RetryConfig;
+    /**
+     * Specifies the status codes which should be retried using the given retry policy.
+     */
+    retryCodes?: string[];
+    /**
+     * Sets various request options on the `fetch` call made by an SDK method.
+     *
+     * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options|Request}
+     */
+    fetchOptions?: Omit<RequestInit, "method" | "body">;
+};
+
+type RequestConfig = {
+    method: string;
+    path: string;
+    baseURL?: string | URL;
+    query?: string;
+    body?: RequestInit["body"];
+    headers?: HeadersInit;
+    security?: SecurityState | null;
+    uaHeader?: string;
+    timeoutMs?: number;
+};
+
+const gt: unknown = typeof globalThis === "undefined" ? null : globalThis;
+const webWorkerLike =
+    typeof gt === "object" &&
+    gt != null &&
+    "importScripts" in gt &&
+    typeof gt["importScripts"] === "function";
+const isBrowserLike =
+    webWorkerLike ||
+    (typeof navigator !== "undefined" && "serviceWorker" in navigator) ||
+    (typeof window === "object" && typeof window.document !== "undefined");
+
+export class ClientSDK {
+    private readonly httpClient: HTTPClient;
+    protected readonly baseURL: URL | null;
+    protected readonly hooks$: SDKHooks;
+    protected readonly logger?: Logger | undefined;
+    public readonly options$: SDKOptions & { hooks?: SDKHooks };
+
+    constructor(options: SDKOptions = {}) {
+        const opt = options as unknown;
+        if (
+            typeof opt === "object" &&
+            opt != null &&
+            "hooks" in opt &&
+            opt.hooks instanceof SDKHooks
+        ) {
+            this.hooks$ = opt.hooks;
+        } else {
+            this.hooks$ = new SDKHooks();
+        }
+        this.options$ = { ...options, hooks: this.hooks$ };
+
+        const url = serverURLFromOptions(options);
+        if (url) {
+            url.pathname = url.pathname.replace(/\/+$/, "") + "/";
+        }
+        const { baseURL, client } = this.hooks$.sdkInit({
+            baseURL: url,
+            client: options.httpClient || new HTTPClient(),
+        });
+        this.baseURL = baseURL;
+        this.httpClient = client;
+        this.logger = options.debugLogger;
+    }
+
+    public createRequest$(
+        context: HookContext,
+        conf: RequestConfig,
+        options?: RequestOptions
+    ): Result<Request, InvalidRequestError | UnexpectedClientError> {
+        const { method, path, query, headers: opHeaders, security } = conf;
+
+        const base = conf.baseURL ?? this.baseURL;
+        if (!base) {
+            return ERR(new InvalidRequestError("No base URL provided for operation"));
+        }
+        const reqURL = new URL(base);
+        const inputURL = new URL(path, reqURL);
+
+        if (path) {
+            reqURL.pathname += inputURL.pathname.replace(/^\/+/, "");
+        }
+
+        let finalQuery = query || "";
+
+        const secQuery: string[] = [];
+        for (const [k, v] of Object.entries(security?.queryParams || {})) {
+            secQuery.push(encodeForm(k, v, { charEncoding: "percent" }));
+        }
+        if (secQuery.length) {
+            finalQuery += `&${secQuery.join("&")}`;
+        }
+
+        if (finalQuery) {
+            const q = finalQuery.startsWith("&") ? finalQuery.slice(1) : finalQuery;
+            reqURL.search = `?${q}`;
+        }
+
+        const headers = new Headers(opHeaders);
+
+        const username = security?.basic.username;
+        const password = security?.basic.password;
+        if (username != null || password != null) {
+            const encoded = stringToBase64([username || "", password || ""].join(":"));
+            headers.set("Authorization", `Basic ${encoded}`);
+        }
+
+        const securityHeaders = new Headers(security?.headers || {});
+        for (const [k, v] of securityHeaders) {
+            headers.set(k, v);
+        }
+
+        let cookie = headers.get("cookie") || "";
+        for (const [k, v] of Object.entries(security?.cookies || {})) {
+            cookie += `; ${k}=${v}`;
+        }
+        cookie = cookie.startsWith("; ") ? cookie.slice(2) : cookie;
+        headers.set("cookie", cookie);
+
+        const userHeaders = new Headers(options?.fetchOptions?.headers);
+        for (const [k, v] of userHeaders) {
+            headers.set(k, v);
+        }
+
+        // Only set user agent header in non-browser-like environments since CORS
+        // policy disallows setting it in browsers e.g. Chrome throws an error.
+        if (!isBrowserLike) {
+            headers.set(conf.uaHeader ?? "user-agent", SDK_METADATA.userAgent);
+        }
+
+        let fetchOptions = options?.fetchOptions;
+        if (!fetchOptions?.signal && conf.timeoutMs && conf.timeoutMs > 0) {
+            const timeoutSignal = AbortSignal.timeout(conf.timeoutMs);
+            if (!fetchOptions) {
+                fetchOptions = { signal: timeoutSignal };
+            } else {
+                fetchOptions.signal = timeoutSignal;
+            }
+        }
+
+        let input;
+        try {
+            input = this.hooks$.beforeCreateRequest(context, {
+                url: reqURL,
+                options: {
+                    ...fetchOptions,
+                    body: conf.body ?? null,
+                    headers,
+                    method,
+                },
+            });
+        } catch (err: unknown) {
+            return ERR(
+                new UnexpectedClientError("Create request hook failed to execute", { cause: err })
+            );
+        }
+
+        return OK(new Request(input.url, input.options));
+    }
+
+    public async do$(
+        request: Request,
+        options: {
+            context: HookContext;
+            errorCodes: number | string | (number | string)[];
+            retryConfig?: RetryConfig | undefined;
+            retryCodes?: string[] | undefined;
+        }
+    ): Promise<
+        Result<
+            Response,
+            RequestAbortedError | RequestTimeoutError | ConnectionError | UnexpectedClientError
+        >
+    > {
+        const { context, errorCodes } = options;
+        const retryConfig = options.retryConfig || { strategy: "none" };
+        const retryCodes = options.retryCodes || [];
+
+        return retry(
+            async () => {
+                const req = await this.hooks$.beforeRequest(context, request.clone());
+                await logRequest(this.logger, req).catch((e) =>
+                    this.logger?.log("Failed to log request:", e)
+                );
+
+                let response = await this.httpClient.request(req);
+
+                if (matchStatusCode(response, errorCodes)) {
+                    const result = await this.hooks$.afterError(context, response, null);
+                    if (result.error) {
+                        throw result.error;
+                    }
+                    response = result.response || response;
+                } else {
+                    response = await this.hooks$.afterSuccess(context, response);
+                }
+
+                await logResponse(this.logger, response, req).catch((e) =>
+                    this.logger?.log("Failed to log response:", e)
+                );
+
+                return response;
+            },
+            { config: retryConfig, statusCodes: retryCodes }
+        ).then(
+            (r) => OK(r),
+            (err) => {
+                switch (true) {
+                    case isAbortError(err):
+                        return ERR(
+                            new RequestAbortedError("Request aborted by client", { cause: err })
+                        );
+                    case isTimeoutError(err):
+                        return ERR(new RequestTimeoutError("Request timed out", { cause: err }));
+                    case isConnectionError(err):
+                        return ERR(new ConnectionError("Unable to make request", { cause: err }));
+                    default:
+                        return ERR(
+                            new UnexpectedClientError("Unexpected HTTP client error", {
+                                cause: err,
+                            })
+                        );
+                }
+            }
+        );
+    }
+}
+
+const jsonLikeContentTypeRE = /^application\/(?:.{0,100}\+)?json/;
+async function logRequest(logger: Logger | undefined, req: Request) {
+    if (!logger) {
+        return;
+    }
+
+    const contentType = req.headers.get("content-type");
+    const ct = contentType?.split(";")[0] || "";
+
+    logger.group(`> Request: ${req.method} ${req.url}`);
+
+    logger.group("Headers:");
+    for (const [k, v] of req.headers.entries()) {
+        logger.log(`${k}: ${v}`);
+    }
+    logger.groupEnd();
+
+    logger.group("Body:");
+    switch (true) {
+        case jsonLikeContentTypeRE.test(ct):
+            logger.log(await req.clone().json());
+            break;
+        case ct.startsWith("text/"):
+            logger.log(await req.clone().text());
+            break;
+        case ct === "multipart/form-data": {
+            const body = await req.clone().formData();
+            for (const [k, v] of body) {
+                const vlabel = v instanceof Blob ? "<Blob>" : v;
+                logger.log(`${k}: ${vlabel}`);
+            }
+            break;
+        }
+        default:
+            logger.log(`<${contentType}>`);
+            break;
+    }
+    logger.groupEnd();
+
+    logger.groupEnd();
+}
+
+async function logResponse(logger: Logger | undefined, res: Response, req: Request) {
+    if (!logger) {
+        return;
+    }
+
+    const contentType = res.headers.get("content-type");
+    const ct = contentType?.split(";")[0] || "";
+
+    logger.group(`< Response: ${req.method} ${req.url}`);
+    logger.log("Status Code:", res.status, res.statusText);
+
+    logger.group("Headers:");
+    for (const [k, v] of res.headers.entries()) {
+        logger.log(`${k}: ${v}`);
+    }
+    logger.groupEnd();
+
+    logger.group("Body:");
+    switch (true) {
+        case matchContentType(res, "application/json") || jsonLikeContentTypeRE.test(ct):
+            logger.log(await res.clone().json());
+            break;
+        case matchContentType(res, "text/event-stream"):
+            logger.log(`<${contentType}>`);
+            break;
+        case matchContentType(res, "text/*"):
+            logger.log(await res.clone().text());
+            break;
+        case matchContentType(res, "multipart/form-data"): {
+            const body = await res.clone().formData();
+            for (const [k, v] of body) {
+                const vlabel = v instanceof Blob ? "<Blob>" : v;
+                logger.log(`${k}: ${vlabel}`);
+            }
+            break;
+        }
+        default:
+            logger.log(`<${contentType}>`);
+            break;
+    }
+    logger.groupEnd();
+
+    logger.groupEnd();
+}