@openapi-qraft/react 1.1.2 → 1.1.4

package/src/ServiceOperation.ts

@@ -1,4 +1,4 @@
-import type {
+import {
   CancelOptions,
   DefaultError,
   FetchStatus,
@@ -12,6 +12,7 @@ import type {
   QueriesPlaceholderDataFunction,
   Query,
   QueryClient,
+  ResetOptions,
   SetDataOptions,
   Updater,
 } from '@tanstack/query-core';
@@ -65,7 +66,8 @@ export interface ServiceOperationQuery<
     ServiceOperationSetQueryData<TSchema, TData, TParams>,
     ServiceOperationSetInfiniteQueryData<TSchema, TData, TParams>,
     ServiceOperationInvalidateQueries<TSchema, TData, TParams, TError>,
-    ServiceOperationCancelQueries<TSchema, TData, TParams, TError> {
+    ServiceOperationCancelQueries<TSchema, TData, TParams, TError>,
+    ServiceOperationResetQueries<TSchema, TData, TParams, TError> {
   schema: TSchema;
   types: {
     parameters: TParams;
@@ -296,6 +298,47 @@ export interface ServiceOperationCancelQueriesCallback<
   ): Promise<void>;
 }
 
+interface ServiceOperationResetQueries<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> {
+  resetQueries(
+    filters:
+      | QueryFiltersByParameters<TSchema, TData, TParams, TError>
+      | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>,
+    options: ResetOptions,
+    queryClient: QueryClient
+  ): Promise<void>;
+  resetQueries(
+    filters:
+      | QueryFiltersByParameters<TSchema, TData, TParams, TError>
+      | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>,
+    queryClient: QueryClient
+  ): Promise<void>;
+  resetQueries(queryClient: QueryClient): Promise<void>;
+}
+
+/**
+ * @internal
+ */
+export interface ServiceOperationResetQueriesCallback<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> extends ServiceOperationResetQueries<TSchema, TData, TParams, TError> {
+  resetQueries(
+    filters:
+      | QueryFiltersByParameters<TSchema, TData, TParams, TError>
+      | QueryFiltersByQueryKey<TSchema, TData, TParams, TError>
+      | QueryClient,
+    options?: ResetOptions | QueryClient,
+    queryClient?: QueryClient
+  ): Promise<void>;
+}
+
 interface ServiceOperationUseSuspenseQueries<
   TSchema extends { url: string; method: string },
   TData,

package/src/callbacks/resetQueries.ts

@@ -0,0 +1,22 @@
+import { callQueryClientMethodWithQueryFilters } from '../lib/callQueryClientMethodWithQueryFilters.js';
+import type { QraftClientOptions } from '../qraftAPIClient.js';
+import type { RequestClientSchema } from '../RequestClient.js';
+import type { ServiceOperationResetQueriesCallback } from '../ServiceOperation.js';
+
+export function resetQueries<TData>(
+  qraftOptions: QraftClientOptions | undefined,
+  schema: RequestClientSchema,
+  args: Parameters<
+    ServiceOperationResetQueriesCallback<
+      RequestClientSchema,
+      unknown,
+      TData
+    >['resetQueries']
+  >
+): Promise<void> {
+  return callQueryClientMethodWithQueryFilters(
+    'resetQueries',
+    schema,
+    args as never
+  ) as never;
+}

package/src/lib/callQueryClientMethodWithQueryFilters.ts

@@ -24,7 +24,10 @@ export function callQueryClientMethodWithQueryFilters<
           : undefined
   ) as QueryClient | undefined;
 
-  const filters = args.length === 1 ? undefined : args[0];
+  const filters = composeFilters(
+    schema,
+    args.length === 1 ? undefined : args[0]
+  );
   const options = args.length === 3 ? args[1] : undefined;
 
   if (!queryClient) throw new Error('queryClient is required');
@@ -33,41 +36,48 @@ export function callQueryClientMethodWithQueryFilters<
       `queryClient is invalid, ${queryFilterMethod} method does not exist`
     );
 
+  if (options)
+    // @ts-expect-error
+    return queryClient[queryFilterMethod](filters, options);
+
+  // @ts-expect-error
+  return queryClient[queryFilterMethod](filters);
+}
+
+/**
+ * Replaces the `parameters` field in the filters with a `queryKey` field based on the schema.
+ * If no filters are provided, a `queryKey` will be composed schema's base query key.
+ * @param schema
+ * @param filters
+ */
+function composeFilters<Filters extends object>(
+  schema: RequestClientSchema,
+  filters: Filters | undefined
+) {
   if (!filters) {
-    return queryClient[queryFilterMethod](
-      {
-        queryKey: composeQueryKey(schema, undefined),
-      },
-      options as never
-    ) as never;
+    return {
+      queryKey: composeQueryKey(schema, undefined),
+    };
   }
 
   if ('queryKey' in filters) {
-    return queryClient[queryFilterMethod](
-      filters as never,
-      options as never
-    ) as never;
+    return filters;
   }
 
   if ('parameters' in filters) {
-    const { parameters, ...filtersRest } = filters;
+    const { parameters, ...filtersWithoutParameters } = filters;
 
-    return queryClient[queryFilterMethod](
-      {
-        ...filtersRest,
-        queryKey: composeQueryKey(schema, parameters),
-      } as never,
-      options as never
-    ) as never;
+    Object.assign(filtersWithoutParameters, {
+      queryKey: composeQueryKey(schema, parameters),
+    });
+
+    return filtersWithoutParameters;
   }
 
-  return queryClient[queryFilterMethod](
-    {
-      ...filters,
-      queryKey: composeQueryKey(schema, undefined),
-    } as never,
-    options as never
-  ) as never;
+  return {
+    ...filters,
+    queryKey: composeQueryKey(schema, undefined),
+  };
 }
 
 type QueryFiltersMethod<QFMethod extends keyof typeof QueryClient.prototype> =