@torthu/jacketui-bring 0.2.4 → 1.0.0

package/src/fetch.ts

@@ -1,34 +0,0 @@
-import { bring } from "./bring";
-import { BringInit } from "./types/BringInit";
-
-/** fetch(url: string, init?: Omit<BringInit, "url">): AbortablePromise<Result<Response, BringError>>
- *
- * Wraps bring in a fetch-like API.
- * This is a convenience function for bring.
- *
- * Some caveats:
- * - BringInit expects and AbortController instead of a signal.
- * - The first argument cannot be a Request object.
- *
- * @note This is not a drop-in replacement for the Fetch API.
- *
- * @note bring does not throw errors, but will return a Result.
- *
- * @example
- *   const result = await fetch("https://example.com", { method: "GET" });
- *   if (result.ok) {
- *     const data = await result.value.json();
- *     console.log(data);
- *   } else {
- *     console.error(result.error);
- *   }
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
- *
- * @param url string | URL - The URL to fetch.
- * @param init BringInit - extends RequestInit from the Fetch API.
- * @returns AbortablePromise<Result<Response, BringError>> - A promise that resolves to a Result object containing either a Response or a BringError.
- */
-export const fetch = (url: string | URL, init?: Omit<BringInit, "url">) => {
-  return bring({ url, ...init });
-};

package/src/helpers/exponentialBackoff.ts

@@ -1,28 +0,0 @@
-export interface BackoffOptions {
-  base?: number;
-  factor?: number;
-  max?: number;
-  min?: number;
-}
-
-/** backoff(retryNum: number): number
- *
- * Backoff is the time to wait before retrying a request. It is calculated using an exponential backoff algorithm.
- *
- *  The formula is: base * factor^(retryNum - 1)
- *
- * @param retryNum The number of times the request has been retried
- * @param options
- * @param options.base Base backoff time in milliseconds
- * @param options.factor Multiplier for the backoff time
- * @param options.max Maximum backoff time in milliseconds
- * @param options.min Minimum backoff time in milliseconds
- * @returns number
- */
-export const exponentialBackoff = (
-  retryNum: number,
-  { base = 500, factor = 1.5, max = 10000, min = 500 }: BackoffOptions = {}
-): number => {
-  const calculatedBackoff = base * Math.pow(factor, retryNum - 1);
-  return Math.min(Math.max(calculatedBackoff, min), max);
-};

package/src/helpers/extractCallbacks.ts

@@ -1,23 +0,0 @@
-import { BringCallbacks, BringInit } from "../types/BringInit";
-
-export const extractCallbacks = (init: BringInit): BringCallbacks => {
-  const {
-    onSuccess,
-    onError,
-    onAbort,
-    onRetry,
-    onTimeout,
-    onClientError,
-    onServerError,
-  } = init;
-
-  return {
-    onSuccess,
-    onError,
-    onAbort,
-    onRetry,
-    onTimeout,
-    onClientError,
-    onServerError,
-  };
-};

package/src/helpers/extractRequestInit.ts

@@ -1,30 +0,0 @@
-import { BringInit, RequestInit } from "../types/BringInit";
-
-export const extractRequestInit = (init: BringInit): RequestInit => {
-  const {
-    method,
-    headers,
-    body,
-    mode,
-    credentials,
-    cache,
-    redirect,
-    referrer,
-    referrerPolicy,
-    integrity,
-    keepalive,
-  } = init;
-  return {
-    method,
-    headers,
-    body,
-    mode,
-    credentials,
-    cache,
-    redirect,
-    referrer,
-    referrerPolicy,
-    integrity,
-    keepalive,
-  };
-};

package/src/helpers/randomJitter.ts

@@ -1,22 +0,0 @@
-export interface JitterOptions {
-  min?: number;
-  max?: number;
-}
-
-/** jitter(backoff: number): number
- *
- *  Jitter is a random value added to the backoff time to prevent a thundering herd problem (when multiple clients retry at the same time).
- *
- * @param backoff The backoff time in milliseconds
- * @param options
- * @param options.min (default 0) Minimum jitter time in milliseconds
- * @param options.max (default 100) Maximum jitter time in milliseconds
- * @returns number
- */
-export const randomJitter = ({
-  min = 0,
-  max = 100,
-}: JitterOptions = {}): number => {
-  const jitter = Math.random() * max;
-  return jitter < min ? min : jitter;
-};

package/src/helpers/shouldRetry.ts

@@ -1,40 +0,0 @@
-import { Failure } from "@torthu/jacketui-core";
-import { BringError } from "../errors";
-
-const defaultRetryStatuses = [0, 408, 425, 429, 500, 502, 503, 504];
-
-interface RetryOptions {
-  retryStatuses?: number[];
-}
-
-/** shouldRetry(failure: Failure<BringError>, options?: RetryOptions): boolean
- *
- * Determines if a request should be retried based on the failure and options.
- * By default, it retries on 0, 408, 425, 429, 500, 502, 503, and 504 status codes.
- *
- * Additionally if there is no response (i.e the request failed before a response was received),
- * it will retry.
- *
- * You can override this behavior by passing a custom `retryStatuses` array.
- *
- * @param failure Failure<BringError>
- * @param options RetryOptions
- * @param options.retryStatuses Array of status codes to retry on
- * @returns boolean
- */
-export const shouldRetry = (
-  failure: Failure<BringError>,
-  { retryStatuses = defaultRetryStatuses }: RetryOptions = {}
-): boolean => {
-  const error = failure.error;
-
-  if (error.response) {
-    if (retryStatuses.includes(error.response.status)) {
-      return true;
-    } else {
-      return false;
-    }
-  }
-
-  return true;
-};

package/src/index.ts

@@ -1,7 +0,0 @@
-export * from "./bring";
-export * from "./tryFetch";
-export * from "./errors";
-export * from "./request-builder-pipe";
-export * from "./response-pipe";
-
-export type { BringInit } from "./types/BringInit";

package/src/request-builder-pipe/backoff.ts

@@ -1,22 +0,0 @@
-import {
-  BackoffOptions,
-  exponentialBackoff,
-} from "../helpers/exponentialBackoff";
-import { BringInitDecorator } from "../types/BringDecorator";
-
-/** backoff(options?: BackoffOptions): BringInitDecorator
- *
- * Sets a exponential backoff function for retrying requests.
- *
- * @param options (optional) Backoff options
- * @param options.base Base backoff time in milliseconds
- * @param options.factor Multiplier for the backoff time
- * @param options.max Maximum backoff time in milliseconds
- * @param options.min Minimum backoff time in milliseconds
- * @returns BringInitDecorator
- */
-export const backoff = (options?: BackoffOptions): BringInitDecorator => {
-  const backoffFun = (retryNum: number) =>
-    exponentialBackoff(retryNum, options);
-  return (init) => ({ ...init, backoff: backoffFun });
-};

package/src/request-builder-pipe/body.ts

@@ -1,17 +0,0 @@
-import { BringInitDecorator } from "../types/BringDecorator";
-import { BringInit } from "../types/BringInit";
-
-/** body(body): BringInitDecorator
- *
- * Sets the body of the request.
- *
- * @note This is a low-level helper. For JSON bodies, use `jsonBody` instead or manually JSON.stringify first.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/RequestInit#body
- *
- * @param body
- * @returns BringInitDecorator
- */
-export const body =
-  (body: BringInit["body"]): BringInitDecorator =>
-  (init) => ({ ...init, body });

package/src/request-builder-pipe/cache.ts

@@ -1,23 +0,0 @@
-import { BringInitDecorator } from "../types/BringDecorator";
-import { BringInit } from "../types/BringInit";
-
-/** cache(cacheMode): BringInitDecorator
- *
- * Sets the cache mode for the request.
- * Possible values are "default", "no-store", "reload", "no-cache", "force-cache", and "only-if-cached".
- * The default value is "default".
- *
- * @example
- *   const customGet = (url: string) => pipe(cache("no-cache"), method("GET"), bring)({ url })
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Request/cache
- *
- * @param cacheMode - The cache mode to use for the request. "default", "no-store", "reload", "no-cache", "force-cache", and "only-if-cached"
- * @returns BringInitDecorator
- */
-export const cache =
-  (cacheMode: BringInit["cache"] = "default"): BringInitDecorator =>
-  (init) => {
-    init.cache = cacheMode;
-    return init;
-  };

package/src/request-builder-pipe/cors.ts

@@ -1,39 +0,0 @@
-import { BringInitDecorator } from "../types/BringDecorator";
-import { BringInit } from "../types/BringInit";
-
-/** cors(corsMode): BringInitDecorator
- *
- * Sets the CORS mode for the request.
- *
- * The default value is "cors".
- *
- * Possible values are: "cors", "no-cors", "same-origin".
- * - "cors": CORS mode is enabled. This is the default value.
- * - "no-cors": CORS mode is disabled.
- * - "same-origin": CORS mode is enabled only for same-origin requests.
- *
- * An origin is the combination of protocol, host, and port.
- * The path is not included in the origin.
- *
- * For example,
- * - https://example.com is an origin.
- * - https://example.com/path is the same origin.
- * - https://example.com:8080 is a different origin.
- * - https://sub.example.com/path is a different origin.
- * - http://example.com is a different origin.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Request/mode
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS
- *
- * @example
- *   const customGet = (url: string) => pipe(cors("no-cors"), method("GET"), bring)({ url }
- *
- * @param corsMode - The mode to use for the request. "cors", "no-cors", "same-origin" (default: "cors").
- * @returns BringInitDecorator
- */
-export const cors =
-  (corsMode: BringInit["mode"] = "cors"): BringInitDecorator =>
-  (init) => {
-    init.mode = corsMode;
-    return init;
-  };

package/src/request-builder-pipe/credentials.ts

@@ -1,33 +0,0 @@
-import { BringInitDecorator } from "../types/BringDecorator";
-import { BringInit } from "../types/BringInit";
-
-/** credentials(credentialsMode): BringInitDecorator
- *
- * Sets the credentials mode for the request.
- *
- * Credentials are cookies, TLS client certificates, or authentication headers containing a username and password.
- *
- * Possible values are:
- * - "omit": Never send cookies.
- * - "same-origin": Send cookies only if the URL is on the same origin as the calling script. This is the default value.
- * - "include": Always send cookies, even for cross-origin calls.
- *
- * The default value is "same-origin".
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#including_credentials
- *
- * @example
- *   const customGet = (url: string) => pipe(credentials("include"), method("GET"), bring)({ url })
- *
- * @param credentialsMode
- * @returns
- */
-export const credentials =
-  (
-    credentialsMode: BringInit["credentials"] = "same-origin"
-  ): BringInitDecorator =>
-  (init) => {
-    init.credentials = credentialsMode;
-    return init;
-  };

package/src/request-builder-pipe/header.ts

@@ -1,28 +0,0 @@
-import { BringInitDecorator } from "../types/BringDecorator";
-
-/** header(key: string, val: string): BringInitDecorator
- *
- * Sets a header on the request.
- * If the header already exists, it will be overwritten.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Headers
- *
- * @param key The name of the header to set.
- * @param val The value of the header to set.
- * @returns BringDecorator
- */
-export const header = (key: string, val: string): BringInitDecorator => {
-  return (init) => {
-    init.headers ??= new Headers();
-
-    if (init.headers instanceof Headers) {
-      !init.headers.has(key)
-        ? init.headers.append(key, val)
-        : init.headers.set(key, val);
-    } else {
-      init.headers[key] = val;
-    }
-
-    return init;
-  };
-};

package/src/request-builder-pipe/headers.ts

@@ -1,34 +0,0 @@
-import { BringInitDecorator } from "../types/BringDecorator";
-
-/** headers(Record<string, string> | Headers): BringInitDecorator
- *
- * Sets multiple headers on the request
- * If a header already exists, it will be overwritten.
- * If a header does not exist, it will be appended.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Headers
- *
- * @param headers A record of headers to set or a Headers object.
- * @returns BringDecorator
- */
-export const headers = (
-  headers: Record<string, string | number> | Headers
-): BringInitDecorator => {
-  return (init) => {
-    init.headers ??= new Headers();
-
-    if (init.headers instanceof Headers) {
-      for (const [key, val] of Object.entries(headers)) {
-        !init.headers.has(key)
-          ? init.headers.append(key, val)
-          : init.headers.set(key, val);
-      }
-    } else {
-      for (const [key, val] of Object.entries(headers)) {
-        init.headers[key] = val;
-      }
-    }
-
-    return init;
-  };
-};

package/src/request-builder-pipe/index.ts

@@ -1,20 +0,0 @@
-export * from "./cache";
-export * from "./cors";
-export * from "./credentials";
-export * from "./header";
-export * from "./headers";
-export * from "./integrity";
-export * from "./keepalive";
-export * from "./method";
-export * from "./redirect";
-export * from "./referrer";
-export * from "./referrerPolicy";
-export * from "./retry";
-export * from "./body";
-export * from "./jsonBody";
-export * from "./priority";
-export * from "./url";
-
-export * from "./backoff";
-export * from "./jitter";
-export * from "./timeout";

package/src/request-builder-pipe/integrity.ts

@@ -1,23 +0,0 @@
-import { BringInitDecorator } from "../types/BringDecorator";
-import { BringInit } from "../types/BringInit";
-
-/** integrity(integrityMode): BringInitDecorator
- *
- * Sets the integrity mode of the request.
- *
- * The format of this option is <hash-algo>-<hash-source> where:
- * - <hash-algo> is one of the following values: sha256, sha384, or sha512
- * - <hash-source> is the Base64-encoding of the result of hashing the resource with the specified hash algorithm.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/RequestInit#integrity
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Request/integrity
- *
- * @param integrityMode
- * @returns BringDecorator
- */
-export const integrity =
-  (integrityMode: BringInit["integrity"] = ""): BringInitDecorator =>
-  (init) => {
-    init.integrity = integrityMode;
-    return init;
-  };

package/src/request-builder-pipe/jitter.ts

@@ -1,17 +0,0 @@
-import { JitterOptions, randomJitter } from "../helpers/randomJitter";
-import { BringInitDecorator } from "../types/BringDecorator";
-
-/** jitter(options?: JitterOptions): BringInitDecorator
- *
- * Sets a jitter function for retrying requests.
- * Jitter is a random value added to the backoff time to prevent a thundering herd problem (when multiple clients retry at the same time).
- *
- * @param options (optional) Jitter options
- * @param options.max (default 100) Maximum jitter time in milliseconds
- * @param options.min (default 0) Minimum jitter time in milliseconds
- * @returns BringInitDecorator
- */
-export const jitter = (options?: JitterOptions): BringInitDecorator => {
-  const jitterFun = () => randomJitter(options);
-  return (init) => ({ ...init, backoff: jitterFun });
-};

package/src/request-builder-pipe/jsonBody.ts

@@ -1,12 +0,0 @@
-import { BringInitDecorator } from "../types/BringDecorator";
-
-/** jsonBody(body: any): BringInitDecorator
- *
- * Sets the body of the request to a JSON string.
- *
- * @param body Any JSON serializable value
- * @returns BringInitDecorator
- */
-export const jsonBody =
-  <BodyType = any>(body: BodyType): BringInitDecorator =>
-  (init) => ({ ...init, body: JSON.stringify(body) });

package/src/request-builder-pipe/keepalive.ts

@@ -1,21 +0,0 @@
-import { BringInitDecorator } from "../types/BringDecorator";
-import { BringInit } from "../types/BringInit";
-
-/** keepalive(boolean): BringInitDecorator
- *
- * Sets the keepalive mode of the request.
- *
- * If set to true, the request will be kept alive until the browser is closed.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Request/keepalive
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch#keepalive
- *
- * @param keepaliveMode
- * @returns
- */
-export const keepalive =
-  (keepaliveMode: BringInit["keepalive"] = false): BringInitDecorator =>
-  (init) => {
-    init.keepalive = keepaliveMode;
-    return init;
-  };

package/src/request-builder-pipe/method.ts

@@ -1,18 +0,0 @@
-import { BringInitDecorator } from "../types/BringDecorator";
-import { BringInit } from "../types/BringInit";
-
-/** method(string): BringInitDecorator
- *
- * Sets the HTTP method of the request.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Request/method
- *
- * @param method - The HTTP method to use for the request.
- * @returns BringDecorator
- */
-export const method =
-  (method: BringInit["method"] = "GET"): BringInitDecorator =>
-  (init) => ({
-    ...init,
-    method,
-  });

package/src/request-builder-pipe/priority.ts

@@ -1,20 +0,0 @@
-import { BringInitDecorator } from "../types/BringDecorator";
-import { BringInit } from "../types/BringInit";
-
-/** priority("auto" | "high" | "low"): BringInitDecorator
- *
- * The priority of the request relative to other requests of the same type.
- *
- * Possible values are:
- * - "auto" (default) No user preference for the fetch priority
- * - "high" A high priority fetch request relative to other requests of the same type.
- * - "low" A low priority fetch request relative to other requests of the same type.
- *
- * @param priorityMode "auto" | "high" | "low
- * @returns BringInitDecorator
- */
-export const priority = (
-  priorityMode: BringInit["priority"] = "auto"
-): BringInitDecorator => {
-  return (init) => ({ ...init, priority: priorityMode });
-};

package/src/request-builder-pipe/redirect.ts

@@ -1,23 +0,0 @@
-import { BringInitDecorator } from "../types/BringDecorator";
-import { BringInit } from "../types/BringInit";
-
-/** redirect(string): BringInitDecorator
- *
- * Sets the redirect mode of the request.
- *
- * Possible values are:
- * - "follow": Automatically follow redirects. This is the default value.
- * - "error": Abort with an error if a redirect occurs.
- * - "manual": Handle redirects manually.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Request/redirect
- *
- * @param redirectMode - The redirect mode to use. "follow" | "error" | "manual". Defaults to "follow".
- * @returns BringIntDecorator
- */
-export const redirect =
-  (redirectMode: BringInit["redirect"] = "follow"): BringInitDecorator =>
-  (init) => {
-    init.redirect = redirectMode;
-    return init;
-  };

package/src/request-builder-pipe/referrer.ts

@@ -1,21 +0,0 @@
-import { BringInitDecorator } from "../types/BringDecorator";
-import { BringInit } from "../types/BringInit";
-
-/** referrer(string): BringInitDecorator
- *
- * A string specifying the value to use for the request's Referer header. One of the following:
- * - A same-origin relative or absolute URL
- * - An empty string, which indicates that no Referer header should be sent
- * - "about:client" (default) set the Referer header to the default value for the context of the request (for example, the URL of the page that made the request).
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/RequestInit#referrer
- *
- * @param referrerMode
- * @returns
- */
-export const referrer =
-  (referrerMode: BringInit["referrer"] = "about:client"): BringInitDecorator =>
-  (init) => {
-    init.referrer = referrerMode;
-    return init;
-  };

package/src/request-builder-pipe/referrerPolicy.ts

@@ -1,33 +0,0 @@
-import { BringInitDecorator } from "../types/BringDecorator";
-import { BringInit } from "../types/BringInit";
-
-/** referrerPolicy(string): BringInitDecorator
- *
- * A string specifying the value of the referrer-policy header to use for the request.
- *
- * Possible values are:
- * - "no-referrer" The Referer header will not be sent.
- * - "no-referrer-when-downgrade" Send the origin, path, and query string in Referer when the protocol security level stays the same or improves
- * - "origin" Send only the origin in the Referer header. For example, a document at https://example.com/page.html will send the referrer https://example.com/.
- * - "origin-when-cross-origin" When performing a same-origin request to the same protocol level (HTTP→HTTP, HTTPS→HTTPS), send the origin, path, and query string. Send only the origin for cross origin requests and requests to less secure destinations (HTTPS→HTTP).
- * - "same-origin" Send the origin, path, and query string for same-origin requests. Don't send the Referer header for cross-origin requests.
- * - "strict-origin" Send only the origin when the protocol security level stays the same (HTTPS→HTTPS). Don't send the Referer header to less secure destinations (HTTPS→HTTP).
- * - "strict-origin-when-cross-origin" (default) Send the origin, path, and query string when performing a same-origin request. For cross-origin requests send the origin (only) when the protocol security level stays same (HTTPS→HTTPS). Don't send the Referer header to less secure destinations (HTTPS→HTTP).
- * - "unsafe-url" Send the origin, path, and query string when performing any request, regardless of security.
- *
- * Default is "strict-origin-when-cross-origin"
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/RequestInit#referrerpolicy
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Referrer-Policy
- *
- * @param referrerPolicyMode
- * @returns BringInitDecorator
- */
-export const referrerPolicy =
-  (
-    referrerPolicyMode: BringInit["referrerPolicy"] = "strict-origin-when-cross-origin"
-  ): BringInitDecorator =>
-  (init) => {
-    init.referrerPolicy = referrerPolicyMode;
-    return init;
-  };

package/src/request-builder-pipe/retry.ts

@@ -1,13 +0,0 @@
-import { BringInitDecorator } from "../types/BringDecorator";
-import { BringInit } from "../types/BringInit";
-
-/** retry(number): BringInitDecorator
- *
- * Sets the number of times to retry the request.
- *
- * @param retry The number of times to retry the request.
- * @returns BringInitDecorator
- */
-export const retry =
-  (retry: BringInit["retry"]): BringInitDecorator =>
-  (init) => ({ ...init, retry });

package/src/request-builder-pipe/shouldRetry.ts

@@ -1,11 +0,0 @@
-import { BringInitDecorator } from "../types/BringDecorator";
-import { BringInit } from "../types/BringInit";
-
-/** shouldRetry((response: Response, retryNum: number) => boolean)): BringInitDecorator
- *
- * @param shouldRetry ((response: Response, retryNum: number) => boolean)
- * @returns BringInitDecorator
- */
-export const shouldRetry =
-  (shouldRetry: BringInit["shouldRetry"]): BringInitDecorator =>
-  (init) => ({ ...init, shouldRetry });

package/src/request-builder-pipe/timeout.ts

@@ -1,19 +0,0 @@
-import { BringInitDecorator } from "../types/BringDecorator";
-import { BringInit } from "../types/BringInit";
-
-/** timeout(number): BringInitDecorator
- *
- * Sets in-flight timeout for request.
- * Used to configure AbortSignal.timeout().
- *
- * If retry is set, timeout will be applied to each retry.
- * Total time for request will be (timeout + jitter + backoff) * retry.
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/timeout_static
- *
- * @param timeout The time to wait before aborting the request.
- * @returns BringInitDecorator
- */
-export const timeout =
-  (timeout: BringInit["timeout"]): BringInitDecorator =>
-  (init) => ({ ...init, timeout });