@fhss-web-team/frontend-utils 1.6.1 → 1.6.3

package/lib/signals/fetch-signal/fetch-signal.d.ts

@@ -1,352 +1,4 @@
-import { Signal } from '@angular/core';
-type JsonValue = string | number | boolean | null | JsonArray | JsonObject;
-export type JsonObject = {
-    [key: string]: JsonValue;
-};
-type JsonArray = JsonValue[];
-export type Json = JsonObject | JsonArray;
-export type Maybe<T> = T | undefined | null;
-type DefaultError = {
-    code?: string;
-    message?: string;
-    details?: Json;
-};
-type KnownHeaderKeys = 'Accept' | 'Accept-Encoding' | 'Accept-Language' | 'Access-Control-Request-Headers' | 'Access-Control-Request-Method' | 'Authorization' | 'Cache-Control' | 'Connection' | 'Content-Encoding' | 'Content-Length' | 'Content-Type' | 'Cookie' | 'Date' | 'Expect' | 'Forwarded' | 'From' | 'Host' | 'If-Match' | 'If-Modified-Since' | 'If-None-Match' | 'If-Range' | 'If-Unmodified-Since' | 'Keep-Alive' | 'Max-Forwards' | 'Origin' | 'Prefer' | 'Priority' | 'Proxy-Authorization' | 'Range' | 'Referer' | 'TE' | 'Transfer-Encoding' | 'Upgrade' | 'User-Agent' | 'Via';
-/**
- * A value that may be a plain value of type `T` or a reactive `Signal<T>`.
- *
- * This is useful in APIs that accept either static or reactive values,
- * allowing flexibility while maintaining type safety.
- *
- * Use `unwrapSignal` to extract the underlying value in a uniform way.
- *
- * @template T The underlying value type.
- */
-export type MaybeSignal<T> = T | Signal<T>;
-/**
- * Reads the underlying value from a MaybeSignal.
- *
- * This function is designed for use with reactive APIs (like fetchSignal) where it's important
- * that Angular's computed methods register the dependency. If the input is a Signal, invoking it
- * not only returns its current value but also tracks the signal for reactivity. If the input is
- * a plain value, it simply returns that value.
- *
- * @template T The type of the value.
- * @param value A plain value or a Signal that yields the value.
- * @returns The current value, with dependency tracking enabled if the input is a Signal.
- */
-export declare function readMaybeSignal<T>(value: MaybeSignal<T>): T;
-type FetchSignalRequest = {
-    url: string;
-    body?: unknown;
-    params?: Record<string, string | number | boolean | undefined>;
-    headers?: Partial<Record<KnownHeaderKeys, string>> & Record<string, string>;
-};
-/**
- * Represents the reactive result of an HTTP fetch request.
- */
-export type FetchSignal<Response, Error = DefaultError> = {
-    value: Signal<Maybe<Response>>;
-    persistentValue: Signal<Maybe<Response>>;
-    isLoading: Signal<boolean>;
-    error: Signal<Maybe<Error>>;
-    statusCode: Signal<Maybe<number>>;
-    headers: Signal<Maybe<Record<string, string>>>;
-    refresh: (abortSignal?: AbortSignal) => void;
-};
-type FetchSignalFactory = {
-    /**
-     * Initiates a reactive HTTP GET request using the provided request configuration.
-     *
-     * @template Response - The expected response type.
-     * @template Error - The expected error shape (defaults to `DefaultError`).
-     * @param request - The configuration object for the HTTP GET request.
-     * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-     * @returns A `FetchSignal` object containing reactive signals for the response data, loading state, status code, error, headers, and a refresh method.
-     */
-    <Response extends Json, Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean): FetchSignal<Response, Error>;
-    /**
-     * Initiates a reactive HTTP GET request using the provided request configuration and parses the response as JSON.
-     *
-     * @template Response - The expected response type.
-     * @template Error - The expected error shape (defaults to `DefaultError`).
-     * @param request - The configuration object for the HTTP GET request.
-     * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-     * @returns A `FetchSignal` object with the JSON-parsed response.
-     */
-    json: <Response extends Json, Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<Response, Error>;
-    /**
-     * Initiates a reactive HTTP GET request using the provided request configuration and parses the response as plain text.
-     *
-     * @template Error - The expected error shape (defaults to `DefaultError`).
-     * @param request - The configuration object for the HTTP GET request.
-     * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-     * @returns A `FetchSignal` object with the text response.
-     */
-    text: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<string, Error>;
-    /**
-     * Initiates a reactive HTTP GET request using the provided request configuration and parses the response as a Blob.
-     *
-     * @template Error - The expected error shape (defaults to `DefaultError`).
-     * @param request - The configuration object for the HTTP GET request.
-     * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-     * @returns A `FetchSignal` object with the Blob response.
-     */
-    blob: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<Blob, Error>;
-    /**
-     * Initiates a reactive HTTP GET request using the provided request configuration and parses the response as an ArrayBuffer.
-     *
-     * @template Error - The expected error shape (defaults to `DefaultError`).
-     * @param request - The configuration object for the HTTP GET request.
-     * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-     * @returns A `FetchSignal` object with the ArrayBuffer response.
-     */
-    arrayBuffer: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<ArrayBuffer, Error>;
-    get: {
-        /**
-         * Initiates a reactive HTTP GET request using the provided request configuration.
-         *
-         * @template Response - The expected response type.
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP GET request.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object containing reactive signals for the response data, loading state, status code, error, headers, and a refresh method.
-         */
-        <Response extends Json, Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean): FetchSignal<Response, Error>;
-        /**
-         * Initiates a reactive HTTP GET request using the provided request configuration and parses the response as JSON.
-         *
-         * @template Response - The expected response type.
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP GET request.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the JSON-parsed response.
-         */
-        json: <Response extends Json, Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<Response, Error>;
-        /**
-         * Initiates a reactive HTTP GET request using the provided request configuration and parses the response as plain text.
-         *
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP GET request.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the text response.
-         */
-        text: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<string, Error>;
-        /**
-         * Initiates a reactive HTTP GET request using the provided request configuration and parses the response as a Blob.
-         *
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP GET request.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the Blob response.
-         */
-        blob: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<Blob, Error>;
-        /**
-         * Initiates a reactive HTTP GET request using the provided request configuration and parses the response as an ArrayBuffer.
-         *
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP GET request.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the ArrayBuffer response.
-         */
-        arrayBuffer: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<ArrayBuffer, Error>;
-    };
-    post: {
-        /**
-         * Initiates a reactive HTTP POST request using the provided request configuration.
-         *
-         * @template Response - The expected response type.
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP POST request, which must include a body.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object containing reactive signals for the response data, loading state, status code, error, headers, and a refresh method.
-         */
-        <Response extends Json, Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean): FetchSignal<Response, Error>;
-        /**
-         * Initiates a reactive HTTP POST request using the provided request configuration and parses the response as JSON.
-         *
-         * @template Response - The expected response type.
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP POST request, which must include a body.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the JSON-parsed response.
-         */
-        json: <Response extends Json, Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<Response, Error>;
-        /**
-         * Initiates a reactive HTTP POST request using the provided request configuration and parses the response as plain text.
-         *
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP POST request, which must include a body.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the text response.
-         */
-        text: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<string, Error>;
-        /**
-         * Initiates a reactive HTTP POST request using the provided request configuration and parses the response as a Blob.
-         *
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP POST request, which must include a body.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the Blob response.
-         */
-        blob: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<Blob, Error>;
-        /**
-         * Initiates a reactive HTTP POST request using the provided request configuration and parses the response as an ArrayBuffer.
-         *
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP POST request, which must include a body.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the ArrayBuffer response.
-         */
-        arrayBuffer: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<ArrayBuffer, Error>;
-    };
-    put: {
-        /**
-         * Initiates a reactive HTTP PUT request using the provided request configuration.
-         *
-         * @template Response - The expected response type.
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP PUT request, which must include a body.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object containing reactive signals for the response data, loading state, status code, error, headers, and a refresh method.
-         */
-        <Response extends Json, Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean): FetchSignal<Response, Error>;
-        /**
-         * Initiates a reactive HTTP PUT request using the provided request configuration and parses the response as JSON.
-         *
-         * @template Response - The expected response type.
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP PUT request, which must include a body.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the JSON-parsed response.
-         */
-        json: <Response extends Json, Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<Response, Error>;
-        /**
-         * Initiates a reactive HTTP PUT request using the provided request configuration and parses the response as plain text.
-         *
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP PUT request, which must include a body.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the text response.
-         */
-        text: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<string, Error>;
-        /**
-         * Initiates a reactive HTTP PUT request using the provided request configuration and parses the response as a Blob.
-         *
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP PUT request, which must include a body.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the Blob response.
-         */
-        blob: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<Blob, Error>;
-        /**
-         * Initiates a reactive HTTP PUT request using the provided request configuration and parses the response as an ArrayBuffer.
-         *
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP PUT request, which must include a body.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the ArrayBuffer response.
-         */
-        arrayBuffer: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<ArrayBuffer, Error>;
-    };
-    patch: {
-        /**
-         * Initiates a reactive HTTP PATCH request using the provided request configuration.
-         *
-         * @template Response - The expected response type.
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP PATCH request, which must include a body.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object containing reactive signals for the response data, loading state, status code, error, headers, and a refresh method.
-         */
-        <Response extends Json, Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean): FetchSignal<Response, Error>;
-        /**
-         * Initiates a reactive HTTP PATCH request using the provided request configuration and parses the response as JSON.
-         *
-         * @template Response - The expected response type.
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP PATCH request, which must include a body.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the JSON-parsed response.
-         */
-        json: <Response extends Json, Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<Response, Error>;
-        /**
-         * Initiates a reactive HTTP PATCH request using the provided request configuration and parses the response as plain text.
-         *
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP PATCH request, which must include a body.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the text response.
-         */
-        text: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<string, Error>;
-        /**
-         * Initiates a reactive HTTP PATCH request using the provided request configuration and parses the response as a Blob.
-         *
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP PATCH request, which must include a body.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the Blob response.
-         */
-        blob: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<Blob, Error>;
-        /**
-         * Initiates a reactive HTTP PATCH request using the provided request configuration and parses the response as an ArrayBuffer.
-         *
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP PATCH request, which must include a body.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the ArrayBuffer response.
-         */
-        arrayBuffer: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<ArrayBuffer, Error>;
-    };
-    delete: {
-        /**
-         * Initiates a reactive HTTP DELETE request using the provided request configuration.
-         *
-         * @template Response - The expected response type.
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP DELETE request.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object containing reactive signals for the response data, loading state, status code, error, headers, and a refresh method.
-         */
-        <Response extends Json, Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean): FetchSignal<Response, Error>;
-        /**
-         * Initiates a reactive HTTP DELETE request using the provided request configuration and parses the response as JSON.
-         *
-         * @template Response - The expected response type.
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP DELETE request.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the JSON-parsed response.
-         */
-        json: <Response extends Json, Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<Response, Error>;
-        /**
-         * Initiates a reactive HTTP DELETE request using the provided request configuration and parses the response as plain text.
-         *
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP DELETE request.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the text response.
-         */
-        text: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<string, Error>;
-        /**
-         * Initiates a reactive HTTP DELETE request using the provided request configuration and parses the response as a Blob.
-         *
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP DELETE request.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the Blob response.
-         */
-        blob: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<Blob, Error>;
-        /**
-         * Initiates a reactive HTTP DELETE request using the provided request configuration and parses the response as an ArrayBuffer.
-         *
-         * @template Error - The expected error shape (defaults to `DefaultError`).
-         * @param request - The configuration object for the HTTP DELETE request.
-         * @param autoRefresh - whether or not the request should be automatically refreshed when the request input signals have changed value
-         * @returns A `FetchSignal` object with the ArrayBuffer response.
-         */
-        arrayBuffer: <Error extends Json = DefaultError>(request: () => FetchSignalRequest, autoRefresh?: boolean) => FetchSignal<ArrayBuffer, Error>;
-    };
-};
+import { FetchSignalFactory, Json } from './fetch-signal.types';
 declare const fetchSignal: FetchSignalFactory;
 export { fetchSignal };
+export type { Json };