@carlonicora/nextjs-jsonapi 6.20.4 → 6.20.6

package/dist/client/JsonApiClient.d.ts

@@ -0,0 +1,80 @@
+import { ApiRequestDataTypeInterface } from "../core/interfaces/ApiRequestDataTypeInterface";
+import { ApiResponseInterface } from "../core/interfaces/ApiResponseInterface";
+import { ModuleWithPermissions } from "../permissions/types";
+/**
+ * Configure the JSON:API client for browser contexts.
+ * Call this in your client-side initialization or use JsonApiProvider.
+ */
+export declare function configureClientJsonApi(config: {
+    apiUrl: string;
+    appUrl?: string;
+    trackablePages?: ModuleWithPermissions[];
+    bootstrapper?: () => void;
+    additionalHeaders?: Record<string, string>;
+}): void;
+export declare function getClientApiUrl(): string;
+export declare function getClientAppUrl(): string;
+export declare function getClientTrackablePages(): ModuleWithPermissions[];
+/**
+ * Resolve the final request URL for an endpoint (client-side variant of `buildUrl`
+ * in `unified/JsonApiRequest.ts` — kept in lockstep with it).
+ *
+ * - `endpoint` starting with "http" is always passed through unchanged (existing behaviour).
+ * - Otherwise, an explicit `baseUrl` (per-call override) takes precedence over the global
+ *   `getClientApiUrl()` resolution. Omitting `baseUrl` preserves today's behaviour exactly.
+ */
+export declare function buildClientUrl(endpoint: string, baseUrl?: string): string;
+export declare function ClientJsonApiGet(params: {
+    classKey: ApiRequestDataTypeInterface;
+    endpoint: string;
+    companyId?: string;
+    language: string;
+    baseUrl?: string;
+}): Promise<ApiResponseInterface>;
+export declare function ClientJsonApiPost(params: {
+    classKey: ApiRequestDataTypeInterface;
+    endpoint: string;
+    companyId?: string;
+    body?: any;
+    overridesJsonApiCreation?: boolean;
+    files?: {
+        [key: string]: File | Blob;
+    } | File | Blob;
+    language: string;
+    responseType?: ApiRequestDataTypeInterface;
+    baseUrl?: string;
+}): Promise<ApiResponseInterface>;
+export declare function ClientJsonApiPut(params: {
+    classKey: ApiRequestDataTypeInterface;
+    endpoint: string;
+    companyId?: string;
+    body?: any;
+    files?: {
+        [key: string]: File | Blob;
+    } | File | Blob;
+    language: string;
+    responseType?: ApiRequestDataTypeInterface;
+    baseUrl?: string;
+}): Promise<ApiResponseInterface>;
+export declare function ClientJsonApiPatch(params: {
+    classKey: ApiRequestDataTypeInterface;
+    endpoint: string;
+    companyId?: string;
+    body?: any;
+    files?: {
+        [key: string]: File | Blob;
+    } | File | Blob;
+    overridesJsonApiCreation?: boolean;
+    responseType?: ApiRequestDataTypeInterface;
+    language: string;
+    baseUrl?: string;
+}): Promise<ApiResponseInterface>;
+export declare function ClientJsonApiDelete(params: {
+    classKey: ApiRequestDataTypeInterface;
+    endpoint: string;
+    companyId?: string;
+    language: string;
+    responseType?: ApiRequestDataTypeInterface;
+    baseUrl?: string;
+}): Promise<ApiResponseInterface>;
+//# sourceMappingURL=JsonApiClient.d.ts.map

package/dist/client/JsonApiClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"JsonApiClient.d.ts","sourceRoot":"","sources":["../../src/client/JsonApiClient.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,2BAA2B,EAAE,MAAM,gDAAgD,CAAC;AAC7F,OAAO,EAAE,oBAAoB,EAAE,MAAM,yCAAyC,CAAC;AAG/E,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAa7D;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE;IAC7C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,qBAAqB,EAAE,CAAC;IACzC,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC5C,GAAG,IAAI,CAMP;AAED,wBAAgB,eAAe,IAAI,MAAM,CAWxC;AAED,wBAAgB,eAAe,IAAI,MAAM,CAWxC;AAED,wBAAgB,uBAAuB,IAAI,qBAAqB,EAAE,CAEjE;AAQD;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAIzE;AAED,wBAAsB,gBAAgB,CAAC,MAAM,EAAE;IAC7C,QAAQ,EAAE,2BAA2B,CAAC;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA2BhC;AAED,wBAAsB,iBAAiB,CAAC,MAAM,EAAE;IAC9C,QAAQ,EAAE,2BAA2B,CAAC;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,GAAG,IAAI,CAAC;IACrD,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,2BAA2B,CAAC;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA4BhC;AAED,wBAAsB,gBAAgB,CAAC,MAAM,EAAE;IAC7C,QAAQ,EAAE,2BAA2B,CAAC;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,GAAG,IAAI,CAAC;IACrD,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,2BAA2B,CAAC;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA4BhC;AAED,wBAAsB,kBAAkB,CAAC,MAAM,EAAE;IAC/C,QAAQ,EAAE,2BAA2B,CAAC;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,GAAG,IAAI,CAAC;IACrD,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,YAAY,CAAC,EAAE,2BAA2B,CAAC;IAC3C,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CA4BhC;AAED,wBAAsB,mBAAmB,CAAC,MAAM,EAAE;IAChD,QAAQ,EAAE,2BAA2B,CAAC;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,2BAA2B,CAAC;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAmBhC"}

package/dist/client/config.d.ts

@@ -0,0 +1,56 @@
+import { ModuleWithPermissions } from "../permissions/types";
+import type { HelpContentConfig } from "../features/help/interfaces/help-content-config.interface";
+/**
+ * Configure the JSON:API client. This is the main configuration function.
+ * This is typically called during app initialization.
+ * @param config.helpContent - Optional help-content config (brand only). Forwarded to the help feature's globalThis-backed store; not stored on the client config.
+ */
+export declare function configureJsonApi(config: {
+    apiUrl: string;
+    appUrl?: string;
+    trackablePages?: ModuleWithPermissions[];
+    bootstrapper?: () => void;
+    additionalHeaders?: Record<string, string>;
+    stripePublishableKey?: string;
+    helpContent?: HelpContentConfig;
+}): void;
+/**
+ * Configure the client config. This is typically called during app initialization.
+ * @deprecated Use configureJsonApi instead
+ */
+export declare function configureClientConfig(config: {
+    apiUrl: string;
+    appUrl?: string;
+    trackablePages?: ModuleWithPermissions[];
+}): void;
+/**
+ * Get the configured API URL.
+ *
+ * This may resolve to an internal/private host (e.g. a docker-network
+ * hostname) when configured to do so for SSR fetches. Do NOT use this for
+ * URLs that are rendered into HTML and followed by the browser — use
+ * `getPublicApiUrl()` instead.
+ */
+export declare function getApiUrl(): string;
+/**
+ * Get the public-facing API URL.
+ *
+ * Always sourced from `NEXT_PUBLIC_API_URL` so it is identical on server
+ * and client, and reachable from the user's browser. Use for any URL that
+ * gets rendered into HTML the browser will navigate to (links, redirects,
+ * OAuth hrefs).
+ */
+export declare function getPublicApiUrl(): string;
+/**
+ * Get the configured app URL.
+ */
+export declare function getAppUrl(): string;
+/**
+ * Get the configured trackable pages.
+ */
+export declare function getTrackablePages(): ModuleWithPermissions[];
+/**
+ * Get the configured Stripe publishable key.
+ */
+export declare function getStripePublishableKey(): string | undefined;
+//# sourceMappingURL=config.d.ts.map

package/dist/client/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/client/config.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAI7D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2DAA2D,CAAC;AAYnG;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,qBAAqB,EAAE,CAAC;IACzC,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3C,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,WAAW,CAAC,EAAE,iBAAiB,CAAC;CACjC,GAAG,IAAI,CAWP;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,qBAAqB,EAAE,CAAC;CAC1C,GAAG,IAAI,CAEP;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAKlC;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,IAAI,MAAM,CAExC;AAED;;GAEG;AACH,wBAAgB,SAAS,IAAI,MAAM,CAWlC;AAED;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,qBAAqB,EAAE,CAE3D;AAED;;GAEG;AACH,wBAAgB,uBAAuB,IAAI,MAAM,GAAG,SAAS,CAE5D"}

package/dist/client/context/JsonApiContext.d.ts

@@ -0,0 +1,39 @@
+export type CacheProfile = "seconds" | "minutes" | "hours" | "days" | "weeks" | "max" | "default";
+export interface JsonApiConfig {
+    /**
+     * The base URL for API requests (e.g., https://api.example.com)
+     */
+    apiUrl: string;
+    /**
+     * Custom token getter function. If not provided, will use default cookie-based token retrieval.
+     */
+    tokenGetter?: () => Promise<string | undefined>;
+    /**
+     * Custom language getter function. If not provided, will use browser locale or next-intl.
+     */
+    languageGetter?: () => Promise<string>;
+    /**
+     * Default headers to include in all requests
+     */
+    defaultHeaders?: Record<string, string>;
+    /**
+     * Global error handler for failed requests (client-side only)
+     */
+    onError?: (status: number, message: string) => void;
+    /**
+     * Cache configuration
+     */
+    cacheConfig?: {
+        defaultProfile: CacheProfile;
+    };
+    /**
+     * Function to bootstrap the data class registry.
+     * Will be called automatically when needed.
+     */
+    bootstrapper?: () => void;
+}
+declare const JsonApiContext: import("react").Context<JsonApiConfig | null>;
+export declare function useJsonApiConfig(): JsonApiConfig;
+export declare function useJsonApiConfigOptional(): JsonApiConfig | null;
+export { JsonApiContext };
+//# sourceMappingURL=JsonApiContext.d.ts.map

package/dist/client/context/JsonApiContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"JsonApiContext.d.ts","sourceRoot":"","sources":["../../../src/client/context/JsonApiContext.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC;AAElG,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAEhD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;IAEvC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAExC;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAEpD;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ,cAAc,EAAE,YAAY,CAAC;KAC9B,CAAC;IAEF;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC;CAC3B;AAED,QAAA,MAAM,cAAc,+CAA4C,CAAC;AAEjE,wBAAgB,gBAAgB,IAAI,aAAa,CAMhD;AAED,wBAAgB,wBAAwB,IAAI,aAAa,GAAG,IAAI,CAE/D;AAED,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/dist/client/context/JsonApiProvider.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+import { JsonApiConfig } from "./JsonApiContext";
+export interface JsonApiProviderProps {
+    config: JsonApiConfig;
+    children: React.ReactNode;
+}
+export declare function JsonApiProvider({ config, children }: JsonApiProviderProps): React.JSX.Element;
+//# sourceMappingURL=JsonApiProvider.d.ts.map

package/dist/client/context/JsonApiProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"JsonApiProvider.d.ts","sourceRoot":"","sources":["../../../src/client/context/JsonApiProvider.tsx"],"names":[],"mappings":"AAEA,OAAO,KAA6B,MAAM,OAAO,CAAC;AAClD,OAAO,EAAE,aAAa,EAAkB,MAAM,kBAAkB,CAAC;AAEjE,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,aAAa,CAAC;IACtB,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAED,wBAAgB,eAAe,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,oBAAoB,qBAYzE"}

package/dist/client/context/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./JsonApiContext";
+export * from "./JsonApiProvider";
+//# sourceMappingURL=index.d.ts.map

package/dist/client/context/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/context/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC"}

package/dist/client/hooks/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./useJsonApiGet";
+export * from "./useJsonApiMutation";
+export * from "./useRehydration";
+//# sourceMappingURL=index.d.ts.map

package/dist/client/hooks/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC"}

package/dist/client/hooks/useJsonApiGet.d.ts

@@ -0,0 +1,73 @@
+import { ApiDataInterface } from "../../core/interfaces/ApiDataInterface";
+import { ApiRequestDataTypeInterface } from "../../core/interfaces/ApiRequestDataTypeInterface";
+import { ApiResponseInterface } from "../../core/interfaces/ApiResponseInterface";
+export interface UseJsonApiGetOptions {
+    /**
+     * Whether to enable the query. If false, the query won't run.
+     */
+    enabled?: boolean;
+    /**
+     * Dependencies that trigger a refetch when changed.
+     */
+    deps?: any[];
+}
+export interface UseJsonApiGetResult<T> {
+    /**
+     * The fetched data, or null if not yet fetched.
+     */
+    data: T | null;
+    /**
+     * Whether the query is currently loading.
+     */
+    loading: boolean;
+    /**
+     * Error message if the query failed.
+     */
+    error: string | null;
+    /**
+     * The full API response (includes raw data, pagination, etc.)
+     */
+    response: ApiResponseInterface | null;
+    /**
+     * Function to manually refetch the data.
+     */
+    refetch: () => Promise<void>;
+    /**
+     * Whether there is a next page available.
+     */
+    hasNextPage: boolean;
+    /**
+     * Whether there is a previous page available.
+     */
+    hasPreviousPage: boolean;
+    /**
+     * Function to fetch the next page.
+     */
+    fetchNextPage: () => Promise<void>;
+    /**
+     * Function to fetch the previous page.
+     */
+    fetchPreviousPage: () => Promise<void>;
+}
+/**
+ * Hook for fetching data from a JSON:API endpoint.
+ *
+ * @example
+ * ```tsx
+ * const { data, loading, error, refetch } = useJsonApiGet<Article>({
+ *   classKey: Modules.Article,
+ *   endpoint: `/articles/${id}`,
+ * });
+ *
+ * if (loading) return <Loading />;
+ * if (error) return <Error message={error} />;
+ * return <ArticleView article={data} />;
+ * ```
+ */
+export declare function useJsonApiGet<T extends ApiDataInterface>(params: {
+    classKey: ApiRequestDataTypeInterface;
+    endpoint: string;
+    companyId?: string;
+    options?: UseJsonApiGetOptions;
+}): UseJsonApiGetResult<T>;
+//# sourceMappingURL=useJsonApiGet.d.ts.map

package/dist/client/hooks/useJsonApiGet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useJsonApiGet.d.ts","sourceRoot":"","sources":["../../../src/client/hooks/useJsonApiGet.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAC1E,OAAO,EAAE,2BAA2B,EAAE,MAAM,mDAAmD,CAAC;AAChG,OAAO,EAAE,oBAAoB,EAAE,MAAM,4CAA4C,CAAC;AAElF,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;CACd;AAED,MAAM,WAAW,mBAAmB,CAAC,CAAC;IACpC;;OAEG;IACH,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB;;OAEG;IACH,QAAQ,EAAE,oBAAoB,GAAG,IAAI,CAAC;IACtC;;OAEG;IACH,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,aAAa,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC;;OAEG;IACH,iBAAiB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CACxC;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,gBAAgB,EAAE,MAAM,EAAE;IAChE,QAAQ,EAAE,2BAA2B,CAAC;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,oBAAoB,CAAC;CAChC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CA8GzB"}

package/dist/client/hooks/useJsonApiMutation.d.ts

@@ -0,0 +1,86 @@
+import { ApiDataInterface } from "../../core/interfaces/ApiDataInterface";
+import { ApiRequestDataTypeInterface } from "../../core/interfaces/ApiRequestDataTypeInterface";
+import { ApiResponseInterface } from "../../core/interfaces/ApiResponseInterface";
+export type MutationMethod = "POST" | "PUT" | "PATCH" | "DELETE";
+export interface UseJsonApiMutationResult<T> {
+    /**
+     * The result data from the mutation, or null if not yet executed.
+     */
+    data: T | null;
+    /**
+     * Whether the mutation is currently in progress.
+     */
+    loading: boolean;
+    /**
+     * Error message if the mutation failed.
+     */
+    error: string | null;
+    /**
+     * The full API response.
+     */
+    response: ApiResponseInterface | null;
+    /**
+     * Execute the mutation.
+     */
+    mutate: (params: MutationParams) => Promise<T | null>;
+    /**
+     * Reset the mutation state.
+     */
+    reset: () => void;
+}
+export interface MutationParams {
+    /**
+     * The endpoint to call.
+     */
+    endpoint: string;
+    /**
+     * The request body.
+     */
+    body?: any;
+    /**
+     * Files to upload.
+     */
+    files?: {
+        [key: string]: File | Blob;
+    } | File | Blob;
+    /**
+     * Company ID for multi-tenant requests.
+     */
+    companyId?: string;
+    /**
+     * Override the default JSON:API body creation.
+     */
+    overridesJsonApiCreation?: boolean;
+    /**
+     * Response type if different from the request type.
+     */
+    responseType?: ApiRequestDataTypeInterface;
+}
+/**
+ * Hook for making mutations (POST, PUT, PATCH, DELETE) to a JSON:API endpoint.
+ *
+ * @example
+ * ```tsx
+ * const { mutate, loading, error } = useJsonApiMutation<Article>({
+ *   method: "POST",
+ *   classKey: Modules.Article,
+ * });
+ *
+ * const handleSubmit = async (data: ArticleInput) => {
+ *   const result = await mutate({
+ *     endpoint: "/articles",
+ *     body: data,
+ *   });
+ *   if (result) {
+ *     // Success!
+ *   }
+ * };
+ * ```
+ */
+export declare function useJsonApiMutation<T extends ApiDataInterface>(config: {
+    method: MutationMethod;
+    classKey: ApiRequestDataTypeInterface;
+    onSuccess?: (data: T) => void;
+    onError?: (error: string) => void;
+}): UseJsonApiMutationResult<T>;
+//# sourceMappingURL=useJsonApiMutation.d.ts.map

package/dist/client/hooks/useJsonApiMutation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useJsonApiMutation.d.ts","sourceRoot":"","sources":["../../../src/client/hooks/useJsonApiMutation.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAC1E,OAAO,EAAE,2BAA2B,EAAE,MAAM,mDAAmD,CAAC;AAChG,OAAO,EAAE,oBAAoB,EAAE,MAAM,4CAA4C,CAAC;AAElF,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAEjE,MAAM,WAAW,wBAAwB,CAAC,CAAC;IACzC;;OAEG;IACH,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB;;OAEG;IACH,QAAQ,EAAE,oBAAoB,GAAG,IAAI,CAAC;IACtC;;OAEG;IACH,MAAM,EAAE,CAAC,MAAM,EAAE,cAAc,KAAK,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACtD;;OAEG;IACH,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,GAAG,CAAC;IACX;;OAEG;IACH,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI,GAAG,IAAI,CAAC;IACrD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC;;OAEG;IACH,YAAY,CAAC,EAAE,2BAA2B,CAAC;CAC5C;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,gBAAgB,EAAE,MAAM,EAAE;IACrE,MAAM,EAAE,cAAc,CAAC;IACvB,QAAQ,EAAE,2BAA2B,CAAC;IACtC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC;IAC9B,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;CACnC,GAAG,wBAAwB,CAAC,CAAC,CAAC,CAuG9B"}

package/dist/client/hooks/useRehydration.d.ts

@@ -0,0 +1,26 @@
+import { ApiDataInterface } from "../../core/interfaces/ApiDataInterface";
+import { ApiRequestDataTypeInterface } from "../../core/interfaces/ApiRequestDataTypeInterface";
+import { JsonApiHydratedDataInterface } from "../../core/interfaces/JsonApiHydratedDataInterface";
+/**
+ * Hook to rehydrate server-passed data into typed objects.
+ * Use this when passing data from server components to client components.
+ *
+ * @example
+ * ```tsx
+ * // In server component
+ * const article = await ArticleService.findOne(id);
+ * return <ArticleDetails data={article.dehydrate()} />;
+ *
+ * // In client component
+ * function ArticleDetails({ data }: { data: JsonApiHydratedDataInterface }) {
+ *   const article = useRehydration<Article>(Modules.Article, data);
+ *   return <div>{article.title}</div>;
+ * }
+ * ```
+ */
+export declare function useRehydration<T extends ApiDataInterface>(classKey: ApiRequestDataTypeInterface, data: JsonApiHydratedDataInterface | null | undefined): T | null;
+/**
+ * Hook to rehydrate a list of server-passed data into typed objects.
+ */
+export declare function useRehydrationList<T extends ApiDataInterface>(classKey: ApiRequestDataTypeInterface, data: JsonApiHydratedDataInterface[] | null | undefined): T[];
+//# sourceMappingURL=useRehydration.d.ts.map

package/dist/client/hooks/useRehydration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRehydration.d.ts","sourceRoot":"","sources":["../../../src/client/hooks/useRehydration.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAC1E,OAAO,EAAE,2BAA2B,EAAE,MAAM,mDAAmD,CAAC;AAChG,OAAO,EAAE,4BAA4B,EAAE,MAAM,oDAAoD,CAAC;AAGlG;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS,gBAAgB,EACvD,QAAQ,EAAE,2BAA2B,EACrC,IAAI,EAAE,4BAA4B,GAAG,IAAI,GAAG,SAAS,GACpD,CAAC,GAAG,IAAI,CAKV;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,gBAAgB,EAC3D,QAAQ,EAAE,2BAA2B,EACrC,IAAI,EAAE,4BAA4B,EAAE,GAAG,IAAI,GAAG,SAAS,GACtD,CAAC,EAAE,CAKL"}