inertiajs-use-api 0.0.0

package/dist/index.js

@@ -0,0 +1,4 @@
+export { configureUseApi, getUseApiConfig, resetUseApiConfig, } from "./configure.js";
+export { ApiError } from "./errors.js";
+export { useApi } from "./use-api.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACN,eAAe,EACf,eAAe,EACf,iBAAiB,GACjB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AASvC,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,59 @@
+import type { ReloadOptions } from "@inertiajs/core";
+export type Method = "get" | "post" | "put" | "patch" | "delete";
+export type FieldErrors<TForm> = Partial<Record<keyof TForm | string, string>>;
+export type QueryParams = Record<string, string | number | boolean | null | undefined>;
+export type IntoProp<TResponse> = string | ((response: TResponse) => Record<string, unknown>);
+export interface SubmitOptions<TResponse, TForm> {
+    /** Override the request body. If omitted, the hook's `data` is sent. */
+    data?: Partial<TForm>;
+    /** Query string params. `null`/`undefined` values are skipped. */
+    params?: QueryParams;
+    /** Extra headers merged on top of the defaults. */
+    headers?: Record<string, string>;
+    /** External abort signal. Aborting either this or `cancel()` cancels the request. */
+    signal?: AbortSignal;
+    /**
+     * After success, pipe the response into Inertia page props client-side via
+     * `router.replaceProp`. Pass a string to set `page.props[name] = response`,
+     * or a function to map the response into a partial props object.
+     */
+    intoProp?: IntoProp<TResponse>;
+    /**
+     * After success, trigger an Inertia partial reload for these prop names
+     * (`router.reload({ only: [...] })`). Server is source of truth.
+     */
+    reloadProps?: string | string[];
+    /** Extra options forwarded to `router.reload` (merged with `only`). */
+    reloadOptions?: Omit<ReloadOptions, "only">;
+    /** Value forwarded to the configured `onSuccessToast` handler. */
+    successToast?: unknown;
+    /**
+     * Value forwarded to the configured `onErrorToast` handler. Pass `false` to
+     * suppress the default error toast for this call.
+     */
+    errorToast?: unknown | false;
+    onBefore?: () => void;
+    onSuccess?: (response: TResponse) => void;
+    onError?: (errors: FieldErrors<TForm>, raw: unknown, status: number) => void;
+    onFinish?: () => void;
+}
+export interface UseApi<TForm extends object, TResponse = unknown> {
+    data: TForm;
+    setData: <K extends keyof TForm>(field: K | Partial<TForm>, value?: TForm[K]) => void;
+    errors: FieldErrors<TForm>;
+    hasErrors: boolean;
+    processing: boolean;
+    response: TResponse | null;
+    wasSuccessful: boolean;
+    status: number | null;
+    reset: () => void;
+    clearErrors: () => void;
+    cancel: () => void;
+    submit: (method: Method, url: string, options?: SubmitOptions<TResponse, TForm>) => Promise<TResponse>;
+    get: (url: string, options?: SubmitOptions<TResponse, TForm>) => Promise<TResponse>;
+    post: (url: string, options?: SubmitOptions<TResponse, TForm>) => Promise<TResponse>;
+    put: (url: string, options?: SubmitOptions<TResponse, TForm>) => Promise<TResponse>;
+    patch: (url: string, options?: SubmitOptions<TResponse, TForm>) => Promise<TResponse>;
+    delete: (url: string, options?: SubmitOptions<TResponse, TForm>) => Promise<TResponse>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEjE,MAAM,MAAM,WAAW,CAAC,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAE/E,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;AAEvF,MAAM,MAAM,QAAQ,CAAC,SAAS,IAAI,MAAM,GAAG,CAAC,CAAC,QAAQ,EAAE,SAAS,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAE9F,MAAM,WAAW,aAAa,CAAC,SAAS,EAAE,KAAK;IAC9C,wEAAwE;IACxE,IAAI,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACtB,kEAAkE;IAClE,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,qFAAqF;IACrF,MAAM,CAAC,EAAE,WAAW,CAAC;IAErB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC;IAC/B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAChC,uEAAuE;IACvE,aAAa,CAAC,EAAE,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;IAE5C,kEAAkE;IAClE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,KAAK,CAAC;IAE7B,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,KAAK,IAAI,CAAC;IAC1C,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7E,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,MAAM,CAAC,KAAK,SAAS,MAAM,EAAE,SAAS,GAAG,OAAO;IAChE,IAAI,EAAE,KAAK,CAAC;IACZ,OAAO,EAAE,CAAC,CAAC,SAAS,MAAM,KAAK,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IACtF,MAAM,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;IAC3B,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,SAAS,GAAG,IAAI,CAAC;IAC3B,aAAa,EAAE,OAAO,CAAC;IACvB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,WAAW,EAAE,MAAM,IAAI,CAAC;IACxB,MAAM,EAAE,MAAM,IAAI,CAAC;IACnB,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,SAAS,EAAE,KAAK,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;IACvG,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,SAAS,EAAE,KAAK,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;IACpF,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,SAAS,EAAE,KAAK,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;IACrF,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,SAAS,EAAE,KAAK,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;IACpF,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,SAAS,EAAE,KAAK,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;IACtF,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,SAAS,EAAE,KAAK,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC;CACvF"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/dist/use-api.d.ts

@@ -0,0 +1,3 @@
+import type { UseApi } from "./types.js";
+export declare function useApi<TForm extends object = Record<string, unknown>, TResponse = unknown>(initialData?: TForm): UseApi<TForm, TResponse>;
+//# sourceMappingURL=use-api.d.ts.map

package/dist/use-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-api.d.ts","sourceRoot":"","sources":["../src/use-api.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAmD,MAAM,EAAE,MAAM,YAAY,CAAC;AAyB1F,wBAAgB,MAAM,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,SAAS,GAAG,OAAO,EACzF,WAAW,GAAE,KAAmB,GAC9B,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,CA0K1B"}

package/dist/use-api.js

@@ -0,0 +1,176 @@
+import { router } from "@inertiajs/core";
+import { useCallback, useRef, useState } from "react";
+import { getUseApiConfig, readXsrfToken } from "./configure.js";
+import { ApiError } from "./errors.js";
+function appendQuery(url, params) {
+    if (!params)
+        return url;
+    const usp = new URLSearchParams();
+    for (const [key, value] of Object.entries(params)) {
+        if (value === null || value === undefined)
+            continue;
+        usp.append(key, String(value));
+    }
+    const qs = usp.toString();
+    if (!qs)
+        return url;
+    return url + (url.includes("?") ? "&" : "?") + qs;
+}
+function resolveUrl(url, baseUrl) {
+    if (!baseUrl)
+        return url;
+    if (/^https?:\/\//i.test(url))
+        return url;
+    return `${baseUrl.replace(/\/+$/, "")}/${url.replace(/^\/+/, "")}`;
+}
+function hasHeader(headers, name) {
+    const lower = name.toLowerCase();
+    return Object.keys(headers).some((k) => k.toLowerCase() === lower);
+}
+export function useApi(initialData = {}) {
+    const initialRef = useRef(initialData);
+    const [data, setDataState] = useState(initialData);
+    const [errors, setErrors] = useState({});
+    const [processing, setProcessing] = useState(false);
+    const [response, setResponse] = useState(null);
+    const [wasSuccessful, setWasSuccessful] = useState(false);
+    const [status, setStatus] = useState(null);
+    const inFlightRef = useRef(new Set());
+    const setData = useCallback((field, value) => {
+        setDataState((prev) => typeof field === "object" ? { ...prev, ...field } : { ...prev, [field]: value });
+    }, []);
+    const reset = useCallback(() => {
+        setDataState(initialRef.current);
+        setErrors({});
+        setResponse(null);
+        setWasSuccessful(false);
+        setStatus(null);
+    }, []);
+    const clearErrors = useCallback(() => setErrors({}), []);
+    const cancel = useCallback(() => {
+        for (const controller of inFlightRef.current) {
+            controller.abort();
+        }
+        inFlightRef.current.clear();
+    }, []);
+    const submit = useCallback(async (method, url, options = {}) => {
+        const config = getUseApiConfig();
+        const controller = new AbortController();
+        inFlightRef.current.add(controller);
+        if (options.signal) {
+            if (options.signal.aborted) {
+                controller.abort();
+            }
+            else {
+                options.signal.addEventListener("abort", () => controller.abort(), {
+                    once: true,
+                });
+            }
+        }
+        options.onBefore?.();
+        setProcessing(true);
+        setErrors({});
+        setWasSuccessful(false);
+        setStatus(null);
+        const fullUrl = appendQuery(resolveUrl(url, config.baseUrl), options.params);
+        const xsrf = readXsrfToken();
+        const xsrfHeaderName = config.xsrfHeaderName ?? "X-XSRF-TOKEN";
+        const headers = {
+            Accept: "application/json",
+            "X-Requested-With": "XMLHttpRequest",
+            ...(config.defaultHeaders ?? {}),
+            ...(xsrf ? { [xsrfHeaderName]: xsrf } : {}),
+            ...options.headers,
+        };
+        const body = options.data === undefined ? data : { ...data, ...options.data };
+        const hasBody = method !== "get" && body !== undefined && Object.keys(body).length > 0;
+        if (hasBody && !hasHeader(headers, "content-type")) {
+            headers["Content-Type"] = "application/json";
+        }
+        let res;
+        try {
+            try {
+                res = await fetch(fullUrl, {
+                    method: method.toUpperCase(),
+                    credentials: "include",
+                    headers,
+                    body: hasBody ? JSON.stringify(body) : undefined,
+                    signal: controller.signal,
+                });
+            }
+            catch (networkErr) {
+                if (networkErr.name === "AbortError")
+                    throw networkErr;
+                if (options.errorToast !== false && config.onErrorToast) {
+                    config.onErrorToast(options.errorToast ?? "Network error. Please try again.");
+                }
+                throw networkErr;
+            }
+            const contentType = res.headers.get("content-type") ?? "";
+            const json = contentType.includes("application/json") ? await res.json() : null;
+            setStatus(res.status);
+            config.onResponse?.(json, res.status, res.ok);
+            if (!res.ok) {
+                const flat = (config.parseErrors?.(json, res.status) ?? {});
+                setErrors(flat);
+                const message = config.parseMessage?.(json, res.status) ?? `Request failed (${res.status})`;
+                if (options.errorToast !== false && config.onErrorToast) {
+                    config.onErrorToast(options.errorToast ?? message);
+                }
+                options.onError?.(flat, json, res.status);
+                throw new ApiError(res.status, message, json);
+            }
+            const typedResponse = json;
+            setResponse(typedResponse);
+            setWasSuccessful(true);
+            if (options.intoProp) {
+                if (typeof options.intoProp === "string") {
+                    router.replaceProp(options.intoProp, () => typedResponse);
+                }
+                else {
+                    const partial = options.intoProp(typedResponse);
+                    for (const [name, value] of Object.entries(partial)) {
+                        router.replaceProp(name, () => value);
+                    }
+                }
+            }
+            if (options.reloadProps) {
+                const only = Array.isArray(options.reloadProps) ? options.reloadProps : [options.reloadProps];
+                router.reload({ ...(options.reloadOptions ?? {}), only });
+            }
+            if (options.successToast !== undefined && config.onSuccessToast) {
+                config.onSuccessToast(options.successToast);
+            }
+            options.onSuccess?.(typedResponse);
+            return typedResponse;
+        }
+        finally {
+            inFlightRef.current.delete(controller);
+            if (inFlightRef.current.size === 0) {
+                setProcessing(false);
+            }
+            options.onFinish?.();
+        }
+    }, [data]);
+    const verb = (method) => (url, options) => submit(method, url, options);
+    return {
+        data,
+        setData,
+        errors,
+        hasErrors: Object.keys(errors).length > 0,
+        processing,
+        response,
+        wasSuccessful,
+        status,
+        reset,
+        clearErrors,
+        cancel,
+        submit,
+        get: verb("get"),
+        post: verb("post"),
+        put: verb("put"),
+        patch: verb("patch"),
+        delete: verb("delete"),
+    };
+}
+//# sourceMappingURL=use-api.js.map

package/dist/use-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-api.js","sourceRoot":"","sources":["../src/use-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEtD,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGvC,SAAS,WAAW,CAAC,GAAW,EAAE,MAAoB;IACrD,IAAI,CAAC,MAAM;QAAE,OAAO,GAAG,CAAC;IACxB,MAAM,GAAG,GAAG,IAAI,eAAe,EAAE,CAAC;IAClC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACnD,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QACpD,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAChC,CAAC;IACD,MAAM,EAAE,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;IAC1B,IAAI,CAAC,EAAE;QAAE,OAAO,GAAG,CAAC;IACpB,OAAO,GAAG,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;AACnD,CAAC;AAED,SAAS,UAAU,CAAC,GAAW,EAAE,OAAgB;IAChD,IAAI,CAAC,OAAO;QAAE,OAAO,GAAG,CAAC;IACzB,IAAI,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,GAAG,CAAC;IAC1C,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;AACpE,CAAC;AAED,SAAS,SAAS,CAAC,OAA+B,EAAE,IAAY;IAC/D,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACjC,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,CAAC;AACpE,CAAC;AAED,MAAM,UAAU,MAAM,CACrB,cAAqB,EAAW;IAEhC,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;IACvC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAQ,WAAW,CAAC,CAAC;IAC1D,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAqB,EAAE,CAAC,CAAC;IAC7D,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IACpD,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,GAAG,QAAQ,CAAmB,IAAI,CAAC,CAAC;IACjE,MAAM,CAAC,aAAa,EAAE,gBAAgB,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1D,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAgB,IAAI,CAAC,CAAC;IAC1D,MAAM,WAAW,GAAG,MAAM,CAAuB,IAAI,GAAG,EAAE,CAAC,CAAC;IAE5D,MAAM,OAAO,GAAG,WAAW,CAAsC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACjF,YAAY,CAAC,CAAC,IAAI,EAAE,EAAE,CACrB,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,GAAI,KAAwB,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CACnG,CAAC;IACH,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE;QAC9B,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QACjC,SAAS,CAAC,EAAE,CAAC,CAAC;QACd,WAAW,CAAC,IAAI,CAAC,CAAC;QAClB,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACxB,SAAS,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,WAAW,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAEzD,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,EAAE;QAC/B,KAAK,MAAM,UAAU,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;YAC9C,UAAU,CAAC,KAAK,EAAE,CAAC;QACpB,CAAC;QACD,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;IAC7B,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,MAAM,MAAM,GAAG,WAAW,CACzB,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,GAAG,EAAE,EAAE,EAAE;QACnC,MAAM,MAAM,GAAG,eAAe,EAAE,CAAC;QACjC,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAEpC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACpB,IAAI,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBAC5B,UAAU,CAAC,KAAK,EAAE,CAAC;YACpB,CAAC;iBAAM,CAAC;gBACP,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAAE;oBAClE,IAAI,EAAE,IAAI;iBACV,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;QAED,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;QACrB,aAAa,CAAC,IAAI,CAAC,CAAC;QACpB,SAAS,CAAC,EAAE,CAAC,CAAC;QACd,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACxB,SAAS,CAAC,IAAI,CAAC,CAAC;QAEhB,MAAM,OAAO,GAAG,WAAW,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QAC7E,MAAM,IAAI,GAAG,aAAa,EAAE,CAAC;QAC7B,MAAM,cAAc,GAAG,MAAM,CAAC,cAAc,IAAI,cAAc,CAAC;QAE/D,MAAM,OAAO,GAA2B;YACvC,MAAM,EAAE,kBAAkB;YAC1B,kBAAkB,EAAE,gBAAgB;YACpC,GAAG,CAAC,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC;YAChC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3C,GAAG,OAAO,CAAC,OAAO;SAClB,CAAC;QAEF,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,GAAI,OAAO,CAAC,IAAuB,EAAE,CAAC;QAClG,MAAM,OAAO,GAAG,MAAM,KAAK,KAAK,IAAI,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;QACvF,IAAI,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,cAAc,CAAC,EAAE,CAAC;YACpD,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QAC9C,CAAC;QAED,IAAI,GAAa,CAAC;QAClB,IAAI,CAAC;YACJ,IAAI,CAAC;gBACJ,GAAG,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE;oBAC1B,MAAM,EAAE,MAAM,CAAC,WAAW,EAAE;oBAC5B,WAAW,EAAE,SAAS;oBACtB,OAAO;oBACP,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;oBAChD,MAAM,EAAE,UAAU,CAAC,MAAM;iBACzB,CAAC,CAAC;YACJ,CAAC;YAAC,OAAO,UAAU,EAAE,CAAC;gBACrB,IAAK,UAAoB,CAAC,IAAI,KAAK,YAAY;oBAAE,MAAM,UAAU,CAAC;gBAClE,IAAI,OAAO,CAAC,UAAU,KAAK,KAAK,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;oBACzD,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,IAAI,kCAAkC,CAAC,CAAC;gBAC/E,CAAC;gBACD,MAAM,UAAU,CAAC;YAClB,CAAC;YAED,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;YAC1D,MAAM,IAAI,GAAY,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YAEzF,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACtB,MAAM,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;YAE9C,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACb,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAuB,CAAC;gBAClF,SAAS,CAAC,IAAI,CAAC,CAAC;gBAEhB,MAAM,OAAO,GAAG,MAAM,CAAC,YAAY,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,mBAAmB,GAAG,CAAC,MAAM,GAAG,CAAC;gBAE5F,IAAI,OAAO,CAAC,UAAU,KAAK,KAAK,IAAI,MAAM,CAAC,YAAY,EAAE,CAAC;oBACzD,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,CAAC;gBACpD,CAAC;gBAED,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;gBAC1C,MAAM,IAAI,QAAQ,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;YAC/C,CAAC;YAED,MAAM,aAAa,GAAG,IAAiB,CAAC;YACxC,WAAW,CAAC,aAAa,CAAC,CAAC;YAC3B,gBAAgB,CAAC,IAAI,CAAC,CAAC;YAEvB,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;gBACtB,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;oBAC1C,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,aAAwB,CAAC,CAAC;gBACtE,CAAC;qBAAM,CAAC;oBACP,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;oBAChD,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;wBACrD,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;oBACvC,CAAC;gBACF,CAAC;YACF,CAAC;YAED,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;gBACzB,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;gBAC9F,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3D,CAAC;YAED,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;gBACjE,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YAC7C,CAAC;YAED,OAAO,CAAC,SAAS,EAAE,CAAC,aAAa,CAAC,CAAC;YACnC,OAAO,aAAa,CAAC;QACtB,CAAC;gBAAS,CAAC;YACV,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YACvC,IAAI,WAAW,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;gBACpC,aAAa,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;YACD,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;QACtB,CAAC;IACF,CAAC,EACD,CAAC,IAAI,CAAC,CACN,CAAC;IAEF,MAAM,IAAI,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,CAAC,GAAW,EAAE,OAAyC,EAAE,EAAE,CAC3F,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAE9B,OAAO;QACN,IAAI;QACJ,OAAO;QACP,MAAM;QACN,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC;QACzC,UAAU;QACV,QAAQ;QACR,aAAa;QACb,MAAM;QACN,KAAK;QACL,WAAW;QACX,MAAM;QACN,MAAM;QACN,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC;QAChB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC;QAChB,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC;QACpB,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC;KACtB,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "inertiajs-use-api",
+  "version": "0.0.0",
+  "description": "A React hook for calling JSON API endpoints from Inertia.js apps, with optional piping of responses into Inertia page props.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "SKILL.md",
+    "AGENTS.md"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run clean && npm run build",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest",
+    "test:run": "vitest run",
+    "format": "biome format --write",
+    "format:check": "biome format",
+    "lint": "biome lint --write",
+    "lint:check": "biome lint",
+    "apply": "biome check --write"
+  },
+  "keywords": [
+    "inertia",
+    "inertiajs",
+    "react",
+    "hook",
+    "api",
+    "fetch",
+    "laravel"
+  ],
+  "peerDependencies": {
+    "@inertiajs/core": "^2.0.0 || ^3.0.0",
+    "react": "^18.0.0 || ^19.0.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.16",
+    "@inertiajs/core": "^3.3.1",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/react": "^16.3.2",
+    "@types/react": "^19.2.17",
+    "@types/react-dom": "^19.2.3",
+    "jsdom": "^29.1.1",
+    "react": "^19.2.7",
+    "react-dom": "^19.2.7",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.8"
+  }
+}

package/src/configure.ts

@@ -0,0 +1,57 @@
+export interface UseApiConfig {
+	/** Prepended to relative URLs (e.g. "/api"). Absolute URLs pass through. */
+	baseUrl?: string;
+	/** Merged onto every request before per-call headers. */
+	defaultHeaders?: Record<string, string>;
+	/**
+	 * Reads the CSRF token. Defaults to decoding the `XSRF-TOKEN` cookie.
+	 * Return `null` for no token.
+	 */
+	getXsrfToken?: () => string | null;
+	/** Header name for the CSRF token. Defaults to `X-XSRF-TOKEN`. */
+	xsrfHeaderName?: string;
+	/**
+	 * Parses the response body into a flat `{ field: message }` map on a non-2xx response.
+	 * If unset, no field errors are populated.
+	 */
+	parseErrors?: (body: unknown, status: number) => Record<string, string>;
+	/**
+	 * Extracts a human-readable error message from the body (used as the default error toast).
+	 */
+	parseMessage?: (body: unknown, status: number) => string | null;
+	/** Invoked with the `successToast` value the caller passed. */
+	onSuccessToast?: (toast: unknown) => void;
+	/** Invoked with the resolved error toast value (caller's or the fallback message). */
+	onErrorToast?: (toast: unknown) => void;
+	/**
+	 * Inspect every response body (after JSON parse) regardless of status.
+	 * Useful for pulling out server-side toast envelopes.
+	 */
+	onResponse?: (body: unknown, status: number, ok: boolean) => void;
+}
+
+const config: UseApiConfig = {};
+
+export function configureUseApi(next: UseApiConfig): void {
+	Object.assign(config, next);
+}
+
+export function getUseApiConfig(): UseApiConfig {
+	return config;
+}
+
+export function resetUseApiConfig(): void {
+	for (const key of Object.keys(config) as (keyof UseApiConfig)[]) {
+		delete config[key];
+	}
+}
+
+function defaultXsrfReader(): string | null {
+	if (typeof document === "undefined") return null;
+	const match = document.cookie.match(/(?:^|; )XSRF-TOKEN=([^;]*)/);
+	return match && match[1] !== undefined ? decodeURIComponent(match[1]) : null;
+}
+
+export function readXsrfToken(): string | null {
+	return (config.getXsrfToken ?? defaultXsrfReader)();
+}

package/src/errors.ts

@@ -0,0 +1,10 @@
+export class ApiError extends Error {
+	constructor(
+		public readonly status: number,
+		message: string,
+		public readonly body: unknown,
+	) {
+		super(message);
+		this.name = "ApiError";
+	}
+}

package/src/index.ts

@@ -0,0 +1,16 @@
+export type { UseApiConfig } from "./configure.js";
+export {
+	configureUseApi,
+	getUseApiConfig,
+	resetUseApiConfig,
+} from "./configure.js";
+export { ApiError } from "./errors.js";
+export type {
+	FieldErrors,
+	IntoProp,
+	Method,
+	QueryParams,
+	SubmitOptions,
+	UseApi,
+} from "./types.js";
+export { useApi } from "./use-api.js";

package/src/types.ts

@@ -0,0 +1,67 @@
+import type { ReloadOptions } from "@inertiajs/core";
+
+export type Method = "get" | "post" | "put" | "patch" | "delete";
+
+export type FieldErrors<TForm> = Partial<Record<keyof TForm | string, string>>;
+
+export type QueryParams = Record<string, string | number | boolean | null | undefined>;
+
+export type IntoProp<TResponse> = string | ((response: TResponse) => Record<string, unknown>);
+
+export interface SubmitOptions<TResponse, TForm> {
+	/** Override the request body. If omitted, the hook's `data` is sent. */
+	data?: Partial<TForm>;
+	/** Query string params. `null`/`undefined` values are skipped. */
+	params?: QueryParams;
+	/** Extra headers merged on top of the defaults. */
+	headers?: Record<string, string>;
+	/** External abort signal. Aborting either this or `cancel()` cancels the request. */
+	signal?: AbortSignal;
+
+	/**
+	 * After success, pipe the response into Inertia page props client-side via
+	 * `router.replaceProp`. Pass a string to set `page.props[name] = response`,
+	 * or a function to map the response into a partial props object.
+	 */
+	intoProp?: IntoProp<TResponse>;
+	/**
+	 * After success, trigger an Inertia partial reload for these prop names
+	 * (`router.reload({ only: [...] })`). Server is source of truth.
+	 */
+	reloadProps?: string | string[];
+	/** Extra options forwarded to `router.reload` (merged with `only`). */
+	reloadOptions?: Omit<ReloadOptions, "only">;
+
+	/** Value forwarded to the configured `onSuccessToast` handler. */
+	successToast?: unknown;
+	/**
+	 * Value forwarded to the configured `onErrorToast` handler. Pass `false` to
+	 * suppress the default error toast for this call.
+	 */
+	errorToast?: unknown | false;
+
+	onBefore?: () => void;
+	onSuccess?: (response: TResponse) => void;
+	onError?: (errors: FieldErrors<TForm>, raw: unknown, status: number) => void;
+	onFinish?: () => void;
+}
+
+export interface UseApi<TForm extends object, TResponse = unknown> {
+	data: TForm;
+	setData: <K extends keyof TForm>(field: K | Partial<TForm>, value?: TForm[K]) => void;
+	errors: FieldErrors<TForm>;
+	hasErrors: boolean;
+	processing: boolean;
+	response: TResponse | null;
+	wasSuccessful: boolean;
+	status: number | null;
+	reset: () => void;
+	clearErrors: () => void;
+	cancel: () => void;
+	submit: (method: Method, url: string, options?: SubmitOptions<TResponse, TForm>) => Promise<TResponse>;
+	get: (url: string, options?: SubmitOptions<TResponse, TForm>) => Promise<TResponse>;
+	post: (url: string, options?: SubmitOptions<TResponse, TForm>) => Promise<TResponse>;
+	put: (url: string, options?: SubmitOptions<TResponse, TForm>) => Promise<TResponse>;
+	patch: (url: string, options?: SubmitOptions<TResponse, TForm>) => Promise<TResponse>;
+	delete: (url: string, options?: SubmitOptions<TResponse, TForm>) => Promise<TResponse>;
+}