typedapi-client-helpers 0.1.16 → 0.2.1

package/dist/index.d.cts

@@ -1,25 +1,78 @@
+type QueryParamsType = object;
+type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
+type CancelToken = symbol | string | number;
+declare const ContentType: {
+    readonly Json: "application/json";
+    readonly JsonApi: "application/vnd.api+json";
+    readonly FormData: "multipart/form-data";
+    readonly UrlEncoded: "application/x-www-form-urlencoded";
+    readonly Text: "text/plain";
+};
+type ContentType = (typeof ContentType)[keyof typeof ContentType];
+interface FullRequestParams extends Omit<RequestInit, "body"> {
+    secure?: boolean;
+    path: string;
+    type?: ContentType;
+    query?: QueryParamsType;
+    format?: ResponseFormat;
+    body?: unknown;
+    baseUrl?: string;
+    cancelToken?: CancelToken;
+}
+type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
+type RuntimeRequestParams = RequestParams;
+interface ApiConfig<SecurityDataType = unknown> {
+    baseUrl?: string;
+    baseApiParams?: Omit<RequestParams, "baseUrl" | "cancelToken" | "signal">;
+    securityWorker?: (securityData: SecurityDataType | null) => Promise<RequestParams | void> | RequestParams | void;
+    customFetch?: typeof fetch;
+}
+interface HttpResponse<D extends unknown, E extends unknown = unknown> extends Response {
+    data: D;
+    error: E;
+}
+declare function createApiClient<SecurityDataType = unknown>(apiConfig?: ApiConfig<SecurityDataType>): {
+    configureApiClient: (nextConfig?: ApiConfig<SecurityDataType>) => void;
+    setSecurityData: (data: SecurityDataType | null) => void;
+    abortRequest: (cancelToken: CancelToken) => void;
+    request: <T = unknown, E = unknown>({ body, secure, path, type, query, baseUrl, cancelToken, ...params }: FullRequestParams) => Promise<HttpResponse<T, E>>;
+    toQueryString: (rawQuery?: QueryParamsType) => string;
+};
+declare const defaultApiClient: {
+    configureApiClient: (nextConfig?: ApiConfig<unknown>) => void;
+    setSecurityData: (data: unknown) => void;
+    abortRequest: (cancelToken: CancelToken) => void;
+    request: <T = unknown, E = unknown>({ body, secure, path, type, query, baseUrl, cancelToken, ...params }: FullRequestParams) => Promise<HttpResponse<T, E>>;
+    toQueryString: (rawQuery?: QueryParamsType) => string;
+};
+declare const configureApiClient: (nextConfig?: ApiConfig<unknown>) => void;
+declare const setSecurityData: (data: unknown) => void;
+declare const abortRequest: (cancelToken: CancelToken) => void;
+declare const request: <T = unknown, E = unknown>({ body, secure, path, type, query, baseUrl, cancelToken, ...params }: FullRequestParams) => Promise<HttpResponse<T, E>>;
+
 /**
  * Standard result wrapper returned by generated API wrapper methods.
  *
  * When `ok` is true, the request succeeded and `response` contains the expected data.
  * When `ok` is false, the request failed and `error` contains the thrown or returned error value.
  */
-type ApiResult<T> = {
+type ApiResult<TResponse, TError = unknown> = {
     ok: true;
     status: number;
-    response: T;
+    response: TResponse;
+    error?: never;
 } | {
     ok: false;
     status: number;
-    response?: T;
-    error: unknown;
+    response?: undefined;
+    error: TError;
 };
 /**
  * Narrowed success branch of `ApiResult<T>`.
  *
  * Use this type for success callbacks or helper functions that should only receive successful API results.
  */
-type ApiSuccessResult<T> = Extract<ApiResult<T>, {
+type ApiSuccessResult<TResponse, TError = unknown> = Extract<ApiResult<TResponse, TError>, {
     ok: true;
 }>;
 /**
@@ -27,7 +80,7 @@ type ApiSuccessResult<T> = Extract<ApiResult<T>, {
  *
  * Use this type for error callbacks or helper functions that should only receive failed API results.
  */
-type ApiErrorResult<T> = Extract<ApiResult<T>, {
+type ApiErrorResult<TResponse, TError = unknown> = Extract<ApiResult<TResponse, TError>, {
     ok: false;
 }>;
 
@@ -65,56 +118,22 @@ interface FilterFormValues<TQuery> {
 /**
  * Sort state used by UI components.
  *
- * `Neutral` represents a UI-only state and is sent to the API as `Default`.
+ * `Neutral` represents an explicit neutral sorting state.
  */
 type SortType = "Default" | "Neutral" | "Ascending" | "Descending";
 
-type QueryParamsType = Record<string | number, any>;
-type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
-interface FullRequestParams extends Omit<RequestInit, "body"> {
-    /** set parameter to `true` for call `securityWorker` for this request */
-    secure?: boolean;
-    /** request path */
-    path: string;
-    /** content type of request body */
-    type?: ContentType;
-    /** query params */
-    query?: QueryParamsType;
-    /** format of response (i.e. response.json() -> format: "json") */
-    format?: ResponseFormat;
-    /** request body */
-    body?: unknown;
-    /** base url */
-    baseUrl?: string;
-    /** request cancellation token */
-    cancelToken?: CancelToken;
-}
-type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
-interface HttpResponse$1<D extends unknown, E extends unknown = unknown> extends Response {
-    data: D;
-    error: E;
-}
-type CancelToken = Symbol | string | number;
-declare enum ContentType {
-    Json = "application/json",
-    JsonApi = "application/vnd.api+json",
-    FormData = "multipart/form-data",
-    UrlEncoded = "application/x-www-form-urlencoded",
-    Text = "text/plain"
-}
-
 /**
  * Extracts the successful response body type from a generated API method promise.
  *
  * Example: `Promise<HttpResponse<Product, Error>>` becomes `Product`.
  */
-type ExtractResponse<T> = T extends Promise<HttpResponse$1<infer Response, unknown>> ? Response : never;
+type ExtractResponse<T> = T extends Promise<HttpResponse<infer Response, unknown>> ? Response : never;
 /**
  * Extracts the error response body type from a generated API method promise.
  *
  * Example: `Promise<HttpResponse<Product, ApiError>>` becomes `ApiError`.
  */
-type ExtractError<T> = T extends Promise<HttpResponse$1<unknown, infer Error>> ? Error : never;
+type ExtractError<T> = T extends Promise<HttpResponse<unknown, infer Error>> ? Error : never;
 /**
  * Extracts the item type from an array, otherwise returns the original type.
  *
@@ -149,22 +168,6 @@ type SortableKeys<T> = keyof UnwrapArray<ExtractDataIfPaginated<T>>;
  */
 type WithoutRequestParams<T extends readonly unknown[]> = T extends readonly [...infer Arguments, RequestParams?] ? Arguments : T;
 
-/**
- * Extended fetch response returned by the generated HTTP client.
- *
- * `data` contains the successful response body and `error` contains the error body when available.
- */
-interface HttpResponse<D extends unknown, E extends unknown = unknown> extends Response {
-    data: D;
-    error: E;
-}
-/**
- * Runtime request options that can be passed to generated API methods.
- *
- * Used for extra request configuration such as headers, query values, or fetch options.
- */
-type RuntimeRequestParams = Record<string, unknown>;
-
 /**
  * Function called after a generated wrapper method receives a successful API result.
  *
@@ -176,22 +179,22 @@ type ApiSuccessHandler<TResponse> = (result: ApiSuccessResult<TResponse>) => voi
  *
  * The callback receives the error-only branch of `ApiResult<TResponse>`.
  */
-type ApiErrorHandler<TResponse> = (result: ApiErrorResult<TResponse>) => void | Promise<void>;
+type ApiErrorHandler<TResponse, TError = unknown> = (result: ApiErrorResult<TResponse, TError>) => void | Promise<void>;
 /**
  * Optional callback and request-parameter object accepted by generated API wrapper methods.
  *
  * `onSuccess` runs for successful responses, `onError` runs for failed responses,
  * and `params` is forwarded to the generated HTTP client.
  */
-type ApiMethodCallbacks<TResponse> = {
+type ApiMethodCallbacks<TResponse, TError = unknown, TRequestParams = RequestParams> = {
     onSuccess?: ApiSuccessHandler<TResponse>;
-    onError?: ApiErrorHandler<TResponse>;
-    params?: RequestParams;
+    onError?: ApiErrorHandler<TResponse, TError>;
+    params?: TRequestParams;
 };
 
 type ApiMethodOptions<TResponse, TError = unknown, TRequestParams = RuntimeRequestParams> = {
     onSuccess?: ApiSuccessHandler<TResponse>;
-    onError?: ApiErrorHandler<TError>;
+    onError?: ApiErrorHandler<TResponse, TError>;
     params?: TRequestParams;
 };
 
@@ -213,7 +216,7 @@ type SortDirection = number | string;
  * List filters are converted item by item.
  * `OptionValue` lists send their `value` fields instead of the display names.
  */
-declare function buildQuery<TQuery, TSortModel = keyof TQuery>(filters: FilterFormValues<TQuery>[], page?: number, pageSize?: number, sortBy?: keyof TSortModel | null, sortDirection?: SortDirection): Partial<TQuery>;
+declare function buildQuery<TQuery, TSortModel = TQuery>(filters: FilterFormValues<TQuery>[], page?: number, pageSize?: number, sortBy?: keyof TSortModel | null, sortDirection?: SortDirection): Partial<TQuery>;
 
 /**
  * Extracts wrapper-only arguments in this order:
@@ -253,42 +256,23 @@ declare function extractArgsCallbacksAndParams<TArgs extends unknown[], TRespons
     params?: RuntimeRequestParams;
 };
 
-/**
- * Optional callbacks used while converting a generated HTTP response into `ApiResult<TResponse>`.
- *
- * `onSuccess` is called with `ApiSuccessResult<TResponse>` and `onError` is called with `ApiErrorResult<TResponse>`.
- */
-type HandleApiResponseOptions<TResponse> = {
+type HandleApiResponseOptions<TResponse, TError = unknown> = {
     onSuccess?: ApiSuccessHandler<TResponse>;
-    onError?: ApiErrorHandler<TResponse>;
+    onError?: ApiErrorHandler<TResponse, TError>;
 };
-/**
- * Executes a generated API request and converts the result into `ApiResult<TResponse>`.
- *
- * Successful responses return `{ ok: true, status, response }`. Failed responses and thrown errors return `{ ok: false, status, error }`.
- */
-declare function handleApiResponse<TResponse, TError = unknown>(call: () => Promise<HttpResponse<TResponse, TError>>, options?: HandleApiResponseOptions<TResponse>): Promise<ApiResult<TResponse>>;
+declare function handleApiResponse<TResponse, TError = unknown>(call: () => Promise<HttpResponse<TResponse, TError>>, options?: HandleApiResponseOptions<TResponse, TError>): Promise<ApiResult<TResponse, TError>>;
 
-/** Values supported by the generated API SortDirection enum. */
-type ApiSortDirection = "Default" | "Ascending" | "Descending";
 /**
- * Sort states supported by TypedApi UI components.
- *
- * Includes `Neutral`, which is a UI-only state and is sent to the API as `Default`.
+ * Values supported by the current TypedApi .NET SortDirection enum.
+ * The legacy long names remain accepted when reading older APIs.
  */
+type ApiSortDirection = "Default" | "Neutral" | "Asc" | "Desc" | "Ascending" | "Descending";
+/** Sort states supported by TypedApi UI components. */
 declare const sortTypes: readonly ["Default", "Neutral", "Ascending", "Descending"];
-/**
- * Converts an API sort direction to the sort state used by UI components.
- *
- * Unknown or missing values safely fall back to `Default`.
- */
+/** Converts API sort direction values to the sort state used by UI components. */
 declare function getSortTypeFromSortDirection(sortDirection: ApiSortDirection | null | undefined): SortType;
-/**
- * Converts a UI sort state to a value accepted by the generated API.
- *
- * `Neutral` means no explicit sorting is active, so it maps to `Default`.
- */
-declare function getSortDirectionFromSortType(sortType: SortType | null | undefined): ApiSortDirection;
+/** Converts a UI sort state to a value accepted by the current .NET API. */
+declare function getSortDirectionFromSortType(sortType: SortType | null | undefined): Extract<ApiSortDirection, "Default" | "Neutral" | "Asc" | "Desc">;
 
 /**
  * Converts an object payload into `FormData`.
@@ -298,4 +282,4 @@ declare function getSortDirectionFromSortType(sortType: SortType | null | undefi
  */
 declare function toFormData<T extends object>(payload: T): FormData;
 
-export { type ApiErrorHandler, type ApiErrorResult, type ApiMethodArguments, type ApiMethodCallbacks, type ApiMethodOptions, type ApiResult, type ApiSortDirection, type ApiSuccessHandler, type ApiSuccessResult, type ExtractDataIfPaginated, type ExtractError, type ExtractResponse, type FilterFormValues, type FilterType, type HandleApiResponseOptions, type HttpResponse, type OptionValue, type RuntimeRequestParams, type SortDirection, type SortType, type SortableKeys, type UnwrapArray, type WithoutRequestParams, buildQuery, extractArgsCallbacksAndParams, extractArgsToastsAndParams, getSortDirectionFromSortType, getSortTypeFromSortDirection, handleApiResponse, sortTypes, toFormData };
+export { type ApiConfig, type ApiErrorHandler, type ApiErrorResult, type ApiMethodArguments, type ApiMethodCallbacks, type ApiMethodOptions, type ApiResult, type ApiSortDirection, type ApiSuccessHandler, type ApiSuccessResult, type CancelToken, ContentType, type ExtractDataIfPaginated, type ExtractError, type ExtractResponse, type FilterFormValues, type FilterType, type FullRequestParams, type HandleApiResponseOptions, type HttpResponse, type OptionValue, type QueryParamsType, type RequestParams, type ResponseFormat, type RuntimeRequestParams, type SortDirection, type SortType, type SortableKeys, type UnwrapArray, type WithoutRequestParams, abortRequest, buildQuery, configureApiClient, createApiClient, defaultApiClient, extractArgsCallbacksAndParams, extractArgsToastsAndParams, getSortDirectionFromSortType, getSortTypeFromSortDirection, handleApiResponse, request, setSecurityData, sortTypes, toFormData };

package/dist/index.d.ts

@@ -1,25 +1,78 @@
+type QueryParamsType = object;
+type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
+type CancelToken = symbol | string | number;
+declare const ContentType: {
+    readonly Json: "application/json";
+    readonly JsonApi: "application/vnd.api+json";
+    readonly FormData: "multipart/form-data";
+    readonly UrlEncoded: "application/x-www-form-urlencoded";
+    readonly Text: "text/plain";
+};
+type ContentType = (typeof ContentType)[keyof typeof ContentType];
+interface FullRequestParams extends Omit<RequestInit, "body"> {
+    secure?: boolean;
+    path: string;
+    type?: ContentType;
+    query?: QueryParamsType;
+    format?: ResponseFormat;
+    body?: unknown;
+    baseUrl?: string;
+    cancelToken?: CancelToken;
+}
+type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
+type RuntimeRequestParams = RequestParams;
+interface ApiConfig<SecurityDataType = unknown> {
+    baseUrl?: string;
+    baseApiParams?: Omit<RequestParams, "baseUrl" | "cancelToken" | "signal">;
+    securityWorker?: (securityData: SecurityDataType | null) => Promise<RequestParams | void> | RequestParams | void;
+    customFetch?: typeof fetch;
+}
+interface HttpResponse<D extends unknown, E extends unknown = unknown> extends Response {
+    data: D;
+    error: E;
+}
+declare function createApiClient<SecurityDataType = unknown>(apiConfig?: ApiConfig<SecurityDataType>): {
+    configureApiClient: (nextConfig?: ApiConfig<SecurityDataType>) => void;
+    setSecurityData: (data: SecurityDataType | null) => void;
+    abortRequest: (cancelToken: CancelToken) => void;
+    request: <T = unknown, E = unknown>({ body, secure, path, type, query, baseUrl, cancelToken, ...params }: FullRequestParams) => Promise<HttpResponse<T, E>>;
+    toQueryString: (rawQuery?: QueryParamsType) => string;
+};
+declare const defaultApiClient: {
+    configureApiClient: (nextConfig?: ApiConfig<unknown>) => void;
+    setSecurityData: (data: unknown) => void;
+    abortRequest: (cancelToken: CancelToken) => void;
+    request: <T = unknown, E = unknown>({ body, secure, path, type, query, baseUrl, cancelToken, ...params }: FullRequestParams) => Promise<HttpResponse<T, E>>;
+    toQueryString: (rawQuery?: QueryParamsType) => string;
+};
+declare const configureApiClient: (nextConfig?: ApiConfig<unknown>) => void;
+declare const setSecurityData: (data: unknown) => void;
+declare const abortRequest: (cancelToken: CancelToken) => void;
+declare const request: <T = unknown, E = unknown>({ body, secure, path, type, query, baseUrl, cancelToken, ...params }: FullRequestParams) => Promise<HttpResponse<T, E>>;
+
 /**
  * Standard result wrapper returned by generated API wrapper methods.
  *
  * When `ok` is true, the request succeeded and `response` contains the expected data.
  * When `ok` is false, the request failed and `error` contains the thrown or returned error value.
  */
-type ApiResult<T> = {
+type ApiResult<TResponse, TError = unknown> = {
     ok: true;
     status: number;
-    response: T;
+    response: TResponse;
+    error?: never;
 } | {
     ok: false;
     status: number;
-    response?: T;
-    error: unknown;
+    response?: undefined;
+    error: TError;
 };
 /**
  * Narrowed success branch of `ApiResult<T>`.
  *
  * Use this type for success callbacks or helper functions that should only receive successful API results.
  */
-type ApiSuccessResult<T> = Extract<ApiResult<T>, {
+type ApiSuccessResult<TResponse, TError = unknown> = Extract<ApiResult<TResponse, TError>, {
     ok: true;
 }>;
 /**
@@ -27,7 +80,7 @@ type ApiSuccessResult<T> = Extract<ApiResult<T>, {
  *
  * Use this type for error callbacks or helper functions that should only receive failed API results.
  */
-type ApiErrorResult<T> = Extract<ApiResult<T>, {
+type ApiErrorResult<TResponse, TError = unknown> = Extract<ApiResult<TResponse, TError>, {
     ok: false;
 }>;
 
@@ -65,56 +118,22 @@ interface FilterFormValues<TQuery> {
 /**
  * Sort state used by UI components.
  *
- * `Neutral` represents a UI-only state and is sent to the API as `Default`.
+ * `Neutral` represents an explicit neutral sorting state.
  */
 type SortType = "Default" | "Neutral" | "Ascending" | "Descending";
 
-type QueryParamsType = Record<string | number, any>;
-type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
-interface FullRequestParams extends Omit<RequestInit, "body"> {
-    /** set parameter to `true` for call `securityWorker` for this request */
-    secure?: boolean;
-    /** request path */
-    path: string;
-    /** content type of request body */
-    type?: ContentType;
-    /** query params */
-    query?: QueryParamsType;
-    /** format of response (i.e. response.json() -> format: "json") */
-    format?: ResponseFormat;
-    /** request body */
-    body?: unknown;
-    /** base url */
-    baseUrl?: string;
-    /** request cancellation token */
-    cancelToken?: CancelToken;
-}
-type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
-interface HttpResponse$1<D extends unknown, E extends unknown = unknown> extends Response {
-    data: D;
-    error: E;
-}
-type CancelToken = Symbol | string | number;
-declare enum ContentType {
-    Json = "application/json",
-    JsonApi = "application/vnd.api+json",
-    FormData = "multipart/form-data",
-    UrlEncoded = "application/x-www-form-urlencoded",
-    Text = "text/plain"
-}
-
 /**
  * Extracts the successful response body type from a generated API method promise.
  *
  * Example: `Promise<HttpResponse<Product, Error>>` becomes `Product`.
  */
-type ExtractResponse<T> = T extends Promise<HttpResponse$1<infer Response, unknown>> ? Response : never;
+type ExtractResponse<T> = T extends Promise<HttpResponse<infer Response, unknown>> ? Response : never;
 /**
  * Extracts the error response body type from a generated API method promise.
  *
  * Example: `Promise<HttpResponse<Product, ApiError>>` becomes `ApiError`.
  */
-type ExtractError<T> = T extends Promise<HttpResponse$1<unknown, infer Error>> ? Error : never;
+type ExtractError<T> = T extends Promise<HttpResponse<unknown, infer Error>> ? Error : never;
 /**
  * Extracts the item type from an array, otherwise returns the original type.
  *
@@ -149,22 +168,6 @@ type SortableKeys<T> = keyof UnwrapArray<ExtractDataIfPaginated<T>>;
  */
 type WithoutRequestParams<T extends readonly unknown[]> = T extends readonly [...infer Arguments, RequestParams?] ? Arguments : T;
 
-/**
- * Extended fetch response returned by the generated HTTP client.
- *
- * `data` contains the successful response body and `error` contains the error body when available.
- */
-interface HttpResponse<D extends unknown, E extends unknown = unknown> extends Response {
-    data: D;
-    error: E;
-}
-/**
- * Runtime request options that can be passed to generated API methods.
- *
- * Used for extra request configuration such as headers, query values, or fetch options.
- */
-type RuntimeRequestParams = Record<string, unknown>;
-
 /**
  * Function called after a generated wrapper method receives a successful API result.
  *
@@ -176,22 +179,22 @@ type ApiSuccessHandler<TResponse> = (result: ApiSuccessResult<TResponse>) => voi
  *
  * The callback receives the error-only branch of `ApiResult<TResponse>`.
  */
-type ApiErrorHandler<TResponse> = (result: ApiErrorResult<TResponse>) => void | Promise<void>;
+type ApiErrorHandler<TResponse, TError = unknown> = (result: ApiErrorResult<TResponse, TError>) => void | Promise<void>;
 /**
  * Optional callback and request-parameter object accepted by generated API wrapper methods.
  *
  * `onSuccess` runs for successful responses, `onError` runs for failed responses,
  * and `params` is forwarded to the generated HTTP client.
  */
-type ApiMethodCallbacks<TResponse> = {
+type ApiMethodCallbacks<TResponse, TError = unknown, TRequestParams = RequestParams> = {
     onSuccess?: ApiSuccessHandler<TResponse>;
-    onError?: ApiErrorHandler<TResponse>;
-    params?: RequestParams;
+    onError?: ApiErrorHandler<TResponse, TError>;
+    params?: TRequestParams;
 };
 
 type ApiMethodOptions<TResponse, TError = unknown, TRequestParams = RuntimeRequestParams> = {
     onSuccess?: ApiSuccessHandler<TResponse>;
-    onError?: ApiErrorHandler<TError>;
+    onError?: ApiErrorHandler<TResponse, TError>;
     params?: TRequestParams;
 };
 
@@ -213,7 +216,7 @@ type SortDirection = number | string;
  * List filters are converted item by item.
  * `OptionValue` lists send their `value` fields instead of the display names.
  */
-declare function buildQuery<TQuery, TSortModel = keyof TQuery>(filters: FilterFormValues<TQuery>[], page?: number, pageSize?: number, sortBy?: keyof TSortModel | null, sortDirection?: SortDirection): Partial<TQuery>;
+declare function buildQuery<TQuery, TSortModel = TQuery>(filters: FilterFormValues<TQuery>[], page?: number, pageSize?: number, sortBy?: keyof TSortModel | null, sortDirection?: SortDirection): Partial<TQuery>;
 
 /**
  * Extracts wrapper-only arguments in this order:
@@ -253,42 +256,23 @@ declare function extractArgsCallbacksAndParams<TArgs extends unknown[], TRespons
     params?: RuntimeRequestParams;
 };
 
-/**
- * Optional callbacks used while converting a generated HTTP response into `ApiResult<TResponse>`.
- *
- * `onSuccess` is called with `ApiSuccessResult<TResponse>` and `onError` is called with `ApiErrorResult<TResponse>`.
- */
-type HandleApiResponseOptions<TResponse> = {
+type HandleApiResponseOptions<TResponse, TError = unknown> = {
     onSuccess?: ApiSuccessHandler<TResponse>;
-    onError?: ApiErrorHandler<TResponse>;
+    onError?: ApiErrorHandler<TResponse, TError>;
 };
-/**
- * Executes a generated API request and converts the result into `ApiResult<TResponse>`.
- *
- * Successful responses return `{ ok: true, status, response }`. Failed responses and thrown errors return `{ ok: false, status, error }`.
- */
-declare function handleApiResponse<TResponse, TError = unknown>(call: () => Promise<HttpResponse<TResponse, TError>>, options?: HandleApiResponseOptions<TResponse>): Promise<ApiResult<TResponse>>;
+declare function handleApiResponse<TResponse, TError = unknown>(call: () => Promise<HttpResponse<TResponse, TError>>, options?: HandleApiResponseOptions<TResponse, TError>): Promise<ApiResult<TResponse, TError>>;
 
-/** Values supported by the generated API SortDirection enum. */
-type ApiSortDirection = "Default" | "Ascending" | "Descending";
 /**
- * Sort states supported by TypedApi UI components.
- *
- * Includes `Neutral`, which is a UI-only state and is sent to the API as `Default`.
+ * Values supported by the current TypedApi .NET SortDirection enum.
+ * The legacy long names remain accepted when reading older APIs.
  */
+type ApiSortDirection = "Default" | "Neutral" | "Asc" | "Desc" | "Ascending" | "Descending";
+/** Sort states supported by TypedApi UI components. */
 declare const sortTypes: readonly ["Default", "Neutral", "Ascending", "Descending"];
-/**
- * Converts an API sort direction to the sort state used by UI components.
- *
- * Unknown or missing values safely fall back to `Default`.
- */
+/** Converts API sort direction values to the sort state used by UI components. */
 declare function getSortTypeFromSortDirection(sortDirection: ApiSortDirection | null | undefined): SortType;
-/**
- * Converts a UI sort state to a value accepted by the generated API.
- *
- * `Neutral` means no explicit sorting is active, so it maps to `Default`.
- */
-declare function getSortDirectionFromSortType(sortType: SortType | null | undefined): ApiSortDirection;
+/** Converts a UI sort state to a value accepted by the current .NET API. */
+declare function getSortDirectionFromSortType(sortType: SortType | null | undefined): Extract<ApiSortDirection, "Default" | "Neutral" | "Asc" | "Desc">;
 
 /**
  * Converts an object payload into `FormData`.
@@ -298,4 +282,4 @@ declare function getSortDirectionFromSortType(sortType: SortType | null | undefi
  */
 declare function toFormData<T extends object>(payload: T): FormData;
 
-export { type ApiErrorHandler, type ApiErrorResult, type ApiMethodArguments, type ApiMethodCallbacks, type ApiMethodOptions, type ApiResult, type ApiSortDirection, type ApiSuccessHandler, type ApiSuccessResult, type ExtractDataIfPaginated, type ExtractError, type ExtractResponse, type FilterFormValues, type FilterType, type HandleApiResponseOptions, type HttpResponse, type OptionValue, type RuntimeRequestParams, type SortDirection, type SortType, type SortableKeys, type UnwrapArray, type WithoutRequestParams, buildQuery, extractArgsCallbacksAndParams, extractArgsToastsAndParams, getSortDirectionFromSortType, getSortTypeFromSortDirection, handleApiResponse, sortTypes, toFormData };
+export { type ApiConfig, type ApiErrorHandler, type ApiErrorResult, type ApiMethodArguments, type ApiMethodCallbacks, type ApiMethodOptions, type ApiResult, type ApiSortDirection, type ApiSuccessHandler, type ApiSuccessResult, type CancelToken, ContentType, type ExtractDataIfPaginated, type ExtractError, type ExtractResponse, type FilterFormValues, type FilterType, type FullRequestParams, type HandleApiResponseOptions, type HttpResponse, type OptionValue, type QueryParamsType, type RequestParams, type ResponseFormat, type RuntimeRequestParams, type SortDirection, type SortType, type SortableKeys, type UnwrapArray, type WithoutRequestParams, abortRequest, buildQuery, configureApiClient, createApiClient, defaultApiClient, extractArgsCallbacksAndParams, extractArgsToastsAndParams, getSortDirectionFromSortType, getSortTypeFromSortDirection, handleApiResponse, request, setSecurityData, sortTypes, toFormData };