fastapi-rtk 2.5.1 → 2.6.0

package/dist/contexts/lib/ApiContext/ApiContext.d.ts

@@ -1,12 +1,13 @@
 import { SafeContextOptions } from 'fastapi-rtk/utils';
 import { ApiContextValue, ApiTypeOverrides, EntryRow, UseApiResult } from './types';
-export declare const ApiContextProvider: import('react').Provider<ApiContextValue<import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow> | null>, useApiProvider: (options?: SafeContextOptions<ApiContextValue<import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow>>) => ApiContextValue<import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow>;
+export declare const ApiContextProvider: import('react').Provider<ApiContextValue<import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow, object> | null>, useApiProvider: (options?: SafeContextOptions<ApiContextValue<import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow, object>>) => ApiContextValue<import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow, import('fastapi-rtk/api-types').ResultRow, object>;
 /**
  * Access the API context.
  *
  * @typeParam TDefault - Uniform row/payload type applied to every operation. Defaults to the dynamic `EntryRow`.
  * @typeParam TOverrides - Per-operation overrides (`list` / `get` / `add` / `edit`); each replaces `TDefault` for that operation only.
+ * @typeParam TQuery - Custom query-param keys forwarded to the backend, surfaced typed on `queryParams` / `setQueryParams`.
  * @param options - Options for the context hook.
  * @returns The API context object, with `data`, `getEntry`, `addEntry`, `updateEntry`, etc. typed per operation.
  */
-export declare const useApi: <TDefault = EntryRow, TOverrides extends ApiTypeOverrides = ApiTypeOverrides>(options?: SafeContextOptions<UseApiResult<TDefault, TOverrides>>) => UseApiResult<TDefault, TOverrides>;
+export declare const useApi: <TDefault = EntryRow, TOverrides extends ApiTypeOverrides = ApiTypeOverrides, TQuery extends object = object>(options?: SafeContextOptions<UseApiResult<TDefault, TOverrides, TQuery>>) => UseApiResult<TDefault, TOverrides, TQuery>;

package/dist/contexts/lib/ApiContext/types.d.ts

@@ -121,8 +121,9 @@ export type OpType<TOverrides extends ApiTypeOverrides, K extends keyof ApiTypeO
  * @typeParam TGet - Shape of a single fetched/affected record (`getEntry`, and the record returned by `addEntry` / `updateEntry`).
  * @typeParam TAdd - Payload accepted by `addEntry`.
  * @typeParam TEdit - Payload accepted by `updateEntry`.
+ * @typeParam TQuery - Custom query-param keys forwarded to the backend, intersected onto `queryParams` and `setQueryParams`.
  */
-export interface ApiContextValue<TList = EntryRow, TGet = EntryRow, TAdd = EntryRow, TEdit = EntryRow> {
+export interface ApiContextValue<TList = EntryRow, TGet = EntryRow, TAdd = EntryRow, TEdit = EntryRow, TQuery extends object = object> {
     /** The API path. */
     path: string;
     /** Information about the API, including schemas, UI schemas, and the normalized add/edit form blocks. */
@@ -130,7 +131,7 @@ export interface ApiContextValue<TList = EntryRow, TGet = EntryRow, TAdd = Entry
     /** The data returned by the API. */
     data?: APIData<TList>;
     /** The query parameters used in the API request. */
-    queryParams?: APIQueryParams;
+    queryParams?: APIQueryParams & TQuery;
     /** Indicates whether the API request is currently loading. */
     loading: boolean;
     /** Indicates whether the API info request is currently loading. */
@@ -154,7 +155,7 @@ export interface ApiContextValue<TList = EntryRow, TGet = EntryRow, TAdd = Entry
     /** An object containing special keys for the API query, such as 'all' and 'actions'. */
     specialKey: APISpecialKey;
     /** A function to update the query parameters. */
-    setQueryParams: (partialQueryParams: Partial<APIQueryParams> | ((prev: APIQueryParams) => Partial<APIQueryParams>)) => void;
+    setQueryParams: (partialQueryParams: Partial<APIQueryParams & TQuery> | ((prev: APIQueryParams & TQuery) => Partial<APIQueryParams & TQuery>)) => void;
     /** A function to refetch the data from the API. */
     refetch: (options?: {
         force?: boolean;
@@ -185,7 +186,7 @@ export interface ApiContextValue<TList = EntryRow, TGet = EntryRow, TAdd = Entry
     resetError: () => void;
 }
 /**
- * The `ApiContextValue` returned by `useApi<TDefault, TOverrides>`: the uniform `TDefault` applied to
- * every operation, with any `TOverrides` keys replacing it per operation.
+ * The `ApiContextValue` returned by `useApi<TDefault, TOverrides, TQuery>`: the uniform `TDefault` applied to
+ * every operation, with any `TOverrides` keys replacing it per operation, and `TQuery` adding custom query-param keys.
  */
-export type UseApiResult<TDefault = EntryRow, TOverrides extends ApiTypeOverrides = ApiTypeOverrides> = ApiContextValue<OpType<TOverrides, 'list', TDefault>, OpType<TOverrides, 'get', TDefault>, OpType<TOverrides, 'add', TDefault>, OpType<TOverrides, 'edit', TDefault>>;
+export type UseApiResult<TDefault = EntryRow, TOverrides extends ApiTypeOverrides = ApiTypeOverrides, TQuery extends object = object> = ApiContextValue<OpType<TOverrides, 'list', TDefault>, OpType<TOverrides, 'get', TDefault>, OpType<TOverrides, 'add', TDefault>, OpType<TOverrides, 'edit', TDefault>, TQuery>;

package/dist/core/lib/Wrappers/ApiProvider/ApiProvider.d.ts

@@ -3,7 +3,7 @@ import { ApiProviderProps, WithApiProviderOptions } from './types';
 /**
  * Provides the API context, bulk actions context, and form contexts to its children.
  */
-export declare function ApiProvider(props: ApiProviderProps): import("react/jsx-runtime").JSX.Element;
+export declare function ApiProvider<TQuery extends object = object>(props: ApiProviderProps<TQuery>): import("react/jsx-runtime").JSX.Element;
 /**
  * Higher-order component to wrap a component with ApiProvider.
  *

package/dist/core/lib/Wrappers/ApiProvider/types.d.ts

@@ -3,12 +3,18 @@ import { InfiniteData, QueryKey, UseInfiniteQueryOptions, UseQueryOptions } from
 import { PropsWithChildren } from 'react';
 import { InfoQueryData, RelationParam } from './hooks/types';
 import { QueryParams } from './utils/types';
-/** Props accepted by the `ApiProvider` component. */
-export type ApiProviderProps = PropsWithChildren<{
+/**
+ * Props accepted by the `ApiProvider` component.
+ *
+ * @typeParam TQuery - Custom query-param keys forwarded to the backend (read off `request.query_params`).
+ *   Surfaced typed on `initialQueryParams`; pass the same shape to `useApi<…, TQuery>()` to type `queryParams` /
+ *   `setQueryParams` (React context cannot carry the Provider's type param to a distant `useApi` call).
+ */
+export type ApiProviderProps<TQuery extends object = object> = PropsWithChildren<{
     /** The name of the resource to be used in the API path. */
     resource_name?: string;
-    /** The initial query parameters to be used in the API requests. */
-    initialQueryParams?: QueryParams;
+    /** The initial query parameters to be used in the API requests. May include custom keys (typed via `TQuery`) forwarded to the backend. */
+    initialQueryParams?: QueryParams & Partial<TQuery>;
     /** The relation to be used in the API requests. */
     relation?: RelationParam;
     /** Whether to fetch the `info` for the API requests when the component mounts. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastapi-rtk",
-  "version": "2.5.1",
+  "version": "2.6.0",
   "private": false,
   "description": "A React component library for FastAPI in combination with FastAPI React Toolkit backend, built with Mantine, JsonForms, and Zustand.",
   "license": "MIT",