@shipengine/react-api 2.6.0 → 2.7.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/react-api",
-  "version": "2.6.0",
+  "version": "2.7.1",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {

package/utilities/index.d.ts

@@ -2,3 +2,4 @@ export * from "./delay";
 export * from "./error";
 export * from "./logger";
 export * from "./retry";
+export * from "./types";

package/utilities/types.d.ts

@@ -0,0 +1,19 @@
+import { UseMutationOptions, UseQueryOptions } from "@tanstack/react-query";
+import { AxiosResponse } from "axios";
+import { CodedError } from "@shipengine/js-api";
+/**
+ * @category Entities
+ * Generic object type to be used in any useQuery hook
+ * @param TResponseData - The response data type from the query
+ * @param TQueryFnParams - The data type for the queryFnParams
+ */
+export type QueryProps<TResponseData, TQueryFnParams = unknown> = {
+    queryFnParams?: TQueryFnParams;
+} & Pick<UseQueryOptions<AxiosResponse<TResponseData, any>, CodedError[], TResponseData>, "enabled">;
+/**
+ * @category Entities
+ * Generic object type to be used in any useMutation hook
+ * @param TMutationInput - The input data type for the mutation
+ * @param TResponseData - The response data type from the mutation
+ */
+export type MutationProps<TMutationInput, TResponseData, TError = CodedError[], TContext = unknown> = Pick<UseMutationOptions<TResponseData, TError, TMutationInput, TContext>, "retry">;