typedapi-client-helpers 0.1.2 → 0.1.4

package/dist/index.d.cts

@@ -1,50 +1,3 @@
-import * as react from 'react';
-
-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"
-}
-
-type ExtractResponse<T> = T extends Promise<HttpResponse$1<infer R, any>> ? R : never;
-type UnwrapArray<T> = T extends (infer U)[] ? U : T;
-type ExtractDataIfPaginated<T> = T extends {
-    data?: (infer U)[] | null;
-} ? U : T;
-type SortableKeys<T> = keyof UnwrapArray<ExtractDataIfPaginated<T>>;
-type WithoutRequestParams<T extends any[]> = T extends [
-    infer First,
-    ...infer Rest
-] ? First extends RequestParams ? Rest : [First, ...WithoutRequestParams<Rest>] : [];
-
 /**
  * Standard result wrapper for API calls.
  *
@@ -100,25 +53,62 @@ interface FilterFormValues<TQuery> {
  */
 type SortType = "Default" | "Neutral" | "Ascending" | "Descending";
 
-/**
- * Toast helper for showing consistent success, error, warning, and info messages.
- *
- * Wraps `react-toastify` with a shared title/message layout.
- */
-declare const toast: {
-    success(message: string, title?: string): void;
-    error(message: string, title?: string): void;
-    warning(message: string, title?: string): void;
-    info(message: string, title?: string): void;
-    errorResponse(error: Response | unknown): Promise<void>;
-};
+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"
+}
 
+type ExtractResponse<T> = T extends Promise<HttpResponse$1<infer Response, unknown>> ? Response : never;
+type UnwrapArray<T> = T extends readonly (infer Item)[] ? Item : T;
+type ExtractDataIfPaginated<T> = T extends {
+    data?: readonly (infer Item)[] | null;
+} ? Item : T;
+type SortableKeys<T> = keyof UnwrapArray<ExtractDataIfPaginated<T>>;
 /**
- * Shared toast container for TypedApi UI notifications.
+ * Removes the optional RequestParams argument from the end
+ * of a generated API method parameter tuple.
+ *
+ * Example:
  *
- * Add this once near the root of the app to enable toast messages.
+ * [data: CreateSupplierParams, params?: RequestParams]
+ *
+ * becomes:
+ *
+ * [data: CreateSupplierParams]
  */
-declare function TypedApiToastProvider(): react.JSX.Element;
+type WithoutRequestParams<T extends readonly unknown[]> = T extends readonly [
+    ...infer Arguments,
+    RequestParams?
+] ? Arguments : T;
 
 /**
  * Extended fetch response returned by the generated HTTP client.
@@ -136,23 +126,12 @@ interface HttpResponse<D extends unknown, E extends unknown = unknown> extends R
  */
 type RuntimeRequestParams = Record<string, unknown>;
 
-/**
- * Toast message shown after an API action.
- *
- * `title` is optional and `message` contains the main notification text.
- */
-type ToastMessage = {
-    title?: string;
-    message: string;
-};
-/**
- * Optional toast messages for API success and error states.
- *
- * Use this to show consistent notifications after typed API requests.
- */
-type ToastOptions = {
-    toastSuccess?: ToastMessage;
-    toastError?: ToastMessage;
+type ApiSuccessHandler<TResponse> = (response: TResponse) => void | Promise<void>;
+type ApiErrorHandler<TError = unknown> = (error: TError) => void | Promise<void>;
+type ApiMethodCallbacks<TResponse, TError = unknown> = {
+    onSuccess?: ApiSuccessHandler<TResponse>;
+    onError?: ApiErrorHandler<TError>;
+    params?: RequestParams;
 };
 
 type SortDirection = number | string;
@@ -166,32 +145,26 @@ type SortDirection = number | string;
 declare function buildQuery<TQuery, TSortModel = keyof TQuery>(filters: FilterFormValues<TQuery>[], page?: number, pageSize?: number, sortBy?: keyof TSortModel | null, sortDirection?: SortDirection): Partial<TQuery>;
 
 /**
- * Splits API wrapper arguments into actual API arguments, optional toast options,
- * and optional runtime request params.
- *
- * This allows generated wrapper methods to accept toast and request options
- * without changing the original API method arguments.
+ * Extracts wrapper-only arguments in this order:
+ * original API arguments, onSuccess, onError, request params.
  */
-declare function extractArgsToastsAndParams<TArgs extends unknown[]>(argsWithToast: [...TArgs, ToastOptions?, RuntimeRequestParams?]): {
+declare function extractArgsCallbacksAndParams<TArgs extends readonly unknown[], TSuccess, TError = unknown>(argsWithCallbacks: [
+    ...TArgs,
+    ApiSuccessHandler<TSuccess>?,
+    ApiErrorHandler<TError>?,
+    RuntimeRequestParams?
+]): {
     args: TArgs;
-    toastOptions?: ToastOptions;
+    onSuccess?: ApiSuccessHandler<TSuccess>;
+    onError?: ApiErrorHandler<TError>;
     params?: RuntimeRequestParams;
 };
 
-/**
- * Resets the unauthorized handling lock.
- *
- * This allows future `401 Unauthorized` responses to trigger the shared handling again.
- */
-declare function resetUnauthorizedHandling(): void;
-/**
- * Executes an API call and converts the response into an `ApiResult`.
- *
- * Successful responses return `{ ok: true }`.
- * Failed responses return `{ ok: false }` and show either a custom error toast
- * or the response error message.
- */
-declare function handleApiResponse<T>(call: () => Promise<HttpResponse<T, unknown>>, toastOptions?: ToastOptions): Promise<ApiResult<T>>;
+type HandleApiResponseOptions<TResponse, TError = unknown> = {
+    onSuccess?: ApiSuccessHandler<TResponse>;
+    onError?: ApiErrorHandler<TError>;
+};
+declare function handleApiResponse<TResponse, TError = unknown>(call: () => Promise<HttpResponse<TResponse, TError>>, options?: HandleApiResponseOptions<TResponse, TError>): Promise<ApiResult<TResponse>>;
 
 /** Values supported by the generated API SortDirection enum. */
 type ApiSortDirection = "Default" | "Ascending" | "Descending";
@@ -222,4 +195,4 @@ declare function getSortDirectionFromSortType(sortType: SortType | null | undefi
  */
 declare function toFormData<T extends object>(payload: T): FormData;
 
-export { type ApiResult, type ApiSortDirection, type ExtractDataIfPaginated, type ExtractResponse, type FilterFormValues, type FilterType, type HttpResponse, type OptionValue, type RuntimeRequestParams, type SortDirection, type SortType, type SortableKeys, type ToastMessage, type ToastOptions, TypedApiToastProvider, type UnwrapArray, type WithoutRequestParams, buildQuery, extractArgsToastsAndParams, getSortDirectionFromSortType, getSortTypeFromSortDirection, handleApiResponse, resetUnauthorizedHandling, sortTypes, toFormData, toast };
+export { type ApiErrorHandler, type ApiMethodCallbacks, type ApiResult, type ApiSortDirection, type ApiSuccessHandler, type ExtractDataIfPaginated, 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, getSortDirectionFromSortType, getSortTypeFromSortDirection, handleApiResponse, sortTypes, toFormData };

package/dist/index.d.ts

@@ -1,50 +1,3 @@
-import * as react from 'react';
-
-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"
-}
-
-type ExtractResponse<T> = T extends Promise<HttpResponse$1<infer R, any>> ? R : never;
-type UnwrapArray<T> = T extends (infer U)[] ? U : T;
-type ExtractDataIfPaginated<T> = T extends {
-    data?: (infer U)[] | null;
-} ? U : T;
-type SortableKeys<T> = keyof UnwrapArray<ExtractDataIfPaginated<T>>;
-type WithoutRequestParams<T extends any[]> = T extends [
-    infer First,
-    ...infer Rest
-] ? First extends RequestParams ? Rest : [First, ...WithoutRequestParams<Rest>] : [];
-
 /**
  * Standard result wrapper for API calls.
  *
@@ -100,25 +53,62 @@ interface FilterFormValues<TQuery> {
  */
 type SortType = "Default" | "Neutral" | "Ascending" | "Descending";
 
-/**
- * Toast helper for showing consistent success, error, warning, and info messages.
- *
- * Wraps `react-toastify` with a shared title/message layout.
- */
-declare const toast: {
-    success(message: string, title?: string): void;
-    error(message: string, title?: string): void;
-    warning(message: string, title?: string): void;
-    info(message: string, title?: string): void;
-    errorResponse(error: Response | unknown): Promise<void>;
-};
+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"
+}
 
+type ExtractResponse<T> = T extends Promise<HttpResponse$1<infer Response, unknown>> ? Response : never;
+type UnwrapArray<T> = T extends readonly (infer Item)[] ? Item : T;
+type ExtractDataIfPaginated<T> = T extends {
+    data?: readonly (infer Item)[] | null;
+} ? Item : T;
+type SortableKeys<T> = keyof UnwrapArray<ExtractDataIfPaginated<T>>;
 /**
- * Shared toast container for TypedApi UI notifications.
+ * Removes the optional RequestParams argument from the end
+ * of a generated API method parameter tuple.
+ *
+ * Example:
  *
- * Add this once near the root of the app to enable toast messages.
+ * [data: CreateSupplierParams, params?: RequestParams]
+ *
+ * becomes:
+ *
+ * [data: CreateSupplierParams]
  */
-declare function TypedApiToastProvider(): react.JSX.Element;
+type WithoutRequestParams<T extends readonly unknown[]> = T extends readonly [
+    ...infer Arguments,
+    RequestParams?
+] ? Arguments : T;
 
 /**
  * Extended fetch response returned by the generated HTTP client.
@@ -136,23 +126,12 @@ interface HttpResponse<D extends unknown, E extends unknown = unknown> extends R
  */
 type RuntimeRequestParams = Record<string, unknown>;
 
-/**
- * Toast message shown after an API action.
- *
- * `title` is optional and `message` contains the main notification text.
- */
-type ToastMessage = {
-    title?: string;
-    message: string;
-};
-/**
- * Optional toast messages for API success and error states.
- *
- * Use this to show consistent notifications after typed API requests.
- */
-type ToastOptions = {
-    toastSuccess?: ToastMessage;
-    toastError?: ToastMessage;
+type ApiSuccessHandler<TResponse> = (response: TResponse) => void | Promise<void>;
+type ApiErrorHandler<TError = unknown> = (error: TError) => void | Promise<void>;
+type ApiMethodCallbacks<TResponse, TError = unknown> = {
+    onSuccess?: ApiSuccessHandler<TResponse>;
+    onError?: ApiErrorHandler<TError>;
+    params?: RequestParams;
 };
 
 type SortDirection = number | string;
@@ -166,32 +145,26 @@ type SortDirection = number | string;
 declare function buildQuery<TQuery, TSortModel = keyof TQuery>(filters: FilterFormValues<TQuery>[], page?: number, pageSize?: number, sortBy?: keyof TSortModel | null, sortDirection?: SortDirection): Partial<TQuery>;
 
 /**
- * Splits API wrapper arguments into actual API arguments, optional toast options,
- * and optional runtime request params.
- *
- * This allows generated wrapper methods to accept toast and request options
- * without changing the original API method arguments.
+ * Extracts wrapper-only arguments in this order:
+ * original API arguments, onSuccess, onError, request params.
  */
-declare function extractArgsToastsAndParams<TArgs extends unknown[]>(argsWithToast: [...TArgs, ToastOptions?, RuntimeRequestParams?]): {
+declare function extractArgsCallbacksAndParams<TArgs extends readonly unknown[], TSuccess, TError = unknown>(argsWithCallbacks: [
+    ...TArgs,
+    ApiSuccessHandler<TSuccess>?,
+    ApiErrorHandler<TError>?,
+    RuntimeRequestParams?
+]): {
     args: TArgs;
-    toastOptions?: ToastOptions;
+    onSuccess?: ApiSuccessHandler<TSuccess>;
+    onError?: ApiErrorHandler<TError>;
     params?: RuntimeRequestParams;
 };
 
-/**
- * Resets the unauthorized handling lock.
- *
- * This allows future `401 Unauthorized` responses to trigger the shared handling again.
- */
-declare function resetUnauthorizedHandling(): void;
-/**
- * Executes an API call and converts the response into an `ApiResult`.
- *
- * Successful responses return `{ ok: true }`.
- * Failed responses return `{ ok: false }` and show either a custom error toast
- * or the response error message.
- */
-declare function handleApiResponse<T>(call: () => Promise<HttpResponse<T, unknown>>, toastOptions?: ToastOptions): Promise<ApiResult<T>>;
+type HandleApiResponseOptions<TResponse, TError = unknown> = {
+    onSuccess?: ApiSuccessHandler<TResponse>;
+    onError?: ApiErrorHandler<TError>;
+};
+declare function handleApiResponse<TResponse, TError = unknown>(call: () => Promise<HttpResponse<TResponse, TError>>, options?: HandleApiResponseOptions<TResponse, TError>): Promise<ApiResult<TResponse>>;
 
 /** Values supported by the generated API SortDirection enum. */
 type ApiSortDirection = "Default" | "Ascending" | "Descending";
@@ -222,4 +195,4 @@ declare function getSortDirectionFromSortType(sortType: SortType | null | undefi
  */
 declare function toFormData<T extends object>(payload: T): FormData;
 
-export { type ApiResult, type ApiSortDirection, type ExtractDataIfPaginated, type ExtractResponse, type FilterFormValues, type FilterType, type HttpResponse, type OptionValue, type RuntimeRequestParams, type SortDirection, type SortType, type SortableKeys, type ToastMessage, type ToastOptions, TypedApiToastProvider, type UnwrapArray, type WithoutRequestParams, buildQuery, extractArgsToastsAndParams, getSortDirectionFromSortType, getSortTypeFromSortDirection, handleApiResponse, resetUnauthorizedHandling, sortTypes, toFormData, toast };
+export { type ApiErrorHandler, type ApiMethodCallbacks, type ApiResult, type ApiSortDirection, type ApiSuccessHandler, type ExtractDataIfPaginated, 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, getSortDirectionFromSortType, getSortTypeFromSortDirection, handleApiResponse, sortTypes, toFormData };