@openapi-qraft/react 2.0.0-next.1 → 2.0.0-next.10

package/src/callbacks/useMutation.ts

@@ -1,11 +1,13 @@
 'use client';
 
+import type {
+  OperationSchema,
+  ServiceOperationMutationKey,
+  ServiceOperationUseMutation,
+} from '@openapi-qraft/tanstack-query-react-types';
 import type { DefaultError } from '@tanstack/query-core';
 import type { UseMutationResult } from '@tanstack/react-query';
-import type { OperationSchema } from '../lib/requestFn.js';
 import type { CreateAPIQueryClientOptions } from '../qraftAPIClient.js';
-import type { ServiceOperationMutation } from '../service-operation/ServiceOperation.js';
-import type { ServiceOperationMutationKey } from '../service-operation/ServiceOperationKey.js';
 import { useMutation as useMutationBase } from '@tanstack/react-query';
 import { composeMutationKey } from '../lib/composeMutationKey.js';
 import { requestFnResponseResolver } from '../lib/requestFnResponseResolver.js';
@@ -19,11 +21,12 @@ export const useMutation: <
   qraftOptions: CreateAPIQueryClientOptions,
   schema: OperationSchema,
   args: Parameters<
-    ServiceOperationMutation<
+    ServiceOperationUseMutation<
       OperationSchema,
       object | undefined,
       TVariables,
-      TData
+      TData,
+      DefaultError
     >['useMutation']
   >
 ) => UseMutationResult<TData, TError, TVariables, TContext> = (

package/src/callbacks/useMutationState.ts

@@ -1,10 +1,12 @@
 'use client';
 
+import type {
+  OperationSchema,
+  ServiceOperationUseMutationState,
+} from '@openapi-qraft/tanstack-query-react-types';
 import type { DefaultError } from '@tanstack/query-core';
 import type { UseMutationResult } from '@tanstack/react-query';
-import type { OperationSchema } from '../lib/requestFn.js';
 import type { CreateAPIQueryClientOptions } from '../qraftAPIClient.js';
-import type { ServiceOperationMutation } from '../service-operation/ServiceOperation.js';
 import { useMutationState as useMutationStateTanstack } from '@tanstack/react-query';
 import { composeMutationFilters } from '../lib/composeMutationFilters.js';
 
@@ -17,11 +19,12 @@ export const useMutationState: <
   qraftOptions: CreateAPIQueryClientOptions,
   schema: OperationSchema,
   args: Parameters<
-    ServiceOperationMutation<
+    ServiceOperationUseMutationState<
       OperationSchema,
       object | undefined,
       TVariables,
-      TData
+      TData,
+      DefaultError
     >['useMutationState']
   >
 ) => UseMutationResult<TData, TError, TVariables, TContext> = (

package/src/callbacks/useQueries.ts

@@ -1,9 +1,12 @@
 'use client';
 
+import type {
+  OperationSchema,
+  ServiceOperationUseQueries,
+} from '@openapi-qraft/tanstack-query-react-types';
+import type { DefaultError } from '@tanstack/query-core';
 import type { QueriesResults } from '@tanstack/react-query';
-import type { OperationSchema } from '../lib/requestFn.js';
 import type { CreateAPIQueryClientOptions } from '../qraftAPIClient.js';
-import type { ServiceOperationQuery } from '../service-operation/ServiceOperation.js';
 import { useQueries as useQueriesTanstack } from '@tanstack/react-query';
 import { composeQueryKey } from '../lib/composeQueryKey.js';
 import { requestFnResponseResolver } from '../lib/requestFnResponseResolver.js';
@@ -12,7 +15,12 @@ export const useQueries: (
   qraftOptions: CreateAPIQueryClientOptions,
   schema: OperationSchema,
   args: Parameters<
-    ServiceOperationQuery<OperationSchema, unknown, unknown>['useQueries']
+    ServiceOperationUseQueries<
+      OperationSchema,
+      unknown,
+      unknown,
+      DefaultError
+    >['useQueries']
   >
 ) => QueriesResults<never> = (qraftOptions, schema, args) => {
   const [options] = args;
@@ -20,6 +28,7 @@ export const useQueries: (
   return useQueriesTanstack(
     {
       ...options,
+      // @ts-expect-error - Too complex to type
       queries: options.queries.map((queryOptions) => {
         const optionsWithQueryKey =
           'parameters' in queryOptions

package/src/callbacks/useQuery.ts

@@ -1,10 +1,12 @@
 'use client';
 
+import type {
+  OperationSchema,
+  ServiceOperationUseQuery,
+} from '@openapi-qraft/tanstack-query-react-types';
 import type { DefaultError } from '@tanstack/query-core';
 import type { UseQueryResult } from '@tanstack/react-query';
-import type { OperationSchema } from '../lib/requestFn.js';
 import type { CreateAPIQueryClientOptions } from '../qraftAPIClient.js';
-import type { ServiceOperationQuery } from '../service-operation/ServiceOperation.js';
 import { useQuery as useQueryTanstack } from '@tanstack/react-query';
 import { useComposeUseQueryOptions } from '../lib/useComposeUseQueryOptions.js';
 
@@ -12,7 +14,12 @@ export const useQuery: <TData = unknown, TError = DefaultError>(
   qraftOptions: CreateAPIQueryClientOptions,
   schema: OperationSchema,
   args: Parameters<
-    ServiceOperationQuery<OperationSchema, unknown, unknown>['useQuery']
+    ServiceOperationUseQuery<
+      OperationSchema,
+      unknown,
+      unknown,
+      DefaultError
+    >['useQuery']
   >
 ) => UseQueryResult<TData, TError> = (qraftOptions, schema, args) => {
   return useQueryTanstack(

package/src/callbacks/useSuspenseInfiniteQuery.ts

@@ -1,10 +1,12 @@
 'use client';
 
+import type {
+  OperationSchema,
+  ServiceOperationUseSuspenseInfiniteQuery,
+} from '@openapi-qraft/tanstack-query-react-types';
 import type { DefaultError, InfiniteData } from '@tanstack/query-core';
 import type { UseSuspenseInfiniteQueryResult } from '@tanstack/react-query';
-import type { OperationSchema } from '../lib/requestFn.js';
 import type { CreateAPIQueryClientOptions } from '../qraftAPIClient.js';
-import type { ServiceOperationQuery } from '../service-operation/ServiceOperation.js';
 import { useSuspenseInfiniteQuery as useSuspenseInfiniteQueryTanstack } from '@tanstack/react-query';
 import { useComposeUseQueryOptions } from '../lib/useComposeUseQueryOptions.js';
 
@@ -16,10 +18,11 @@ export const useSuspenseInfiniteQuery: <
   qraftOptions: CreateAPIQueryClientOptions,
   schema: OperationSchema,
   args: Parameters<
-    ServiceOperationQuery<
+    ServiceOperationUseSuspenseInfiniteQuery<
       OperationSchema,
       unknown,
-      unknown
+      unknown,
+      DefaultError
     >['useSuspenseInfiniteQuery']
   >
 ) => UseSuspenseInfiniteQueryResult<TData, TError> = (

package/src/callbacks/useSuspenseQueries.ts

@@ -1,9 +1,12 @@
 'use client';
 
+import type {
+  OperationSchema,
+  ServiceOperationUseSuspenseQueries,
+} from '@openapi-qraft/tanstack-query-react-types';
+import type { DefaultError } from '@tanstack/query-core';
 import type { SuspenseQueriesResults } from '@tanstack/react-query';
-import type { OperationSchema } from '../lib/requestFn.js';
 import type { CreateAPIQueryClientOptions } from '../qraftAPIClient.js';
-import type { ServiceOperationQuery } from '../service-operation/ServiceOperation.js';
 import { useSuspenseQueries as useSuspenseQueriesTanstack } from '@tanstack/react-query';
 import { composeQueryKey } from '../lib/composeQueryKey.js';
 import { requestFnResponseResolver } from '../lib/requestFnResponseResolver.js';
@@ -12,10 +15,11 @@ export const useSuspenseQueries: (
   qraftOptions: CreateAPIQueryClientOptions,
   schema: OperationSchema,
   args: Parameters<
-    ServiceOperationQuery<
+    ServiceOperationUseSuspenseQueries<
       OperationSchema,
       unknown,
-      unknown
+      unknown,
+      DefaultError
     >['useSuspenseQueries']
   >
 ) => SuspenseQueriesResults<never> = (qraftOptions, schema, args) => {
@@ -24,6 +28,7 @@ export const useSuspenseQueries: (
   return useSuspenseQueriesTanstack(
     {
       ...options,
+      // @ts-expect-error - Too complex to type
       queries: options.queries.map((queryOptions) => {
         const optionsWithQueryKey =
           'parameters' in queryOptions

package/src/callbacks/useSuspenseQuery.ts

@@ -1,10 +1,12 @@
 'use client';
 
+import type {
+  OperationSchema,
+  ServiceOperationUseSuspenseQuery,
+} from '@openapi-qraft/tanstack-query-react-types';
 import type { DefaultError } from '@tanstack/query-core';
 import type { UseQueryResult } from '@tanstack/react-query';
-import type { OperationSchema } from '../lib/requestFn.js';
 import type { CreateAPIQueryClientOptions } from '../qraftAPIClient.js';
-import type { ServiceOperationQuery } from '../service-operation/ServiceOperation.js';
 import { useSuspenseQuery as useSuspenseQueryTanstack } from '@tanstack/react-query';
 import { useComposeUseQueryOptions } from '../lib/useComposeUseQueryOptions.js';
 
@@ -16,7 +18,12 @@ export const useSuspenseQuery: <
   qraftOptions: CreateAPIQueryClientOptions,
   schema: OperationSchema,
   args: Parameters<
-    ServiceOperationQuery<OperationSchema, unknown, unknown>['useSuspenseQuery']
+    ServiceOperationUseSuspenseQuery<
+      OperationSchema,
+      unknown,
+      unknown,
+      DefaultError
+    >['useSuspenseQuery']
   >
 ) => UseQueryResult<TData, TError> = (qraftOptions, schema, args) => {
   return useSuspenseQueryTanstack(

package/src/index.ts

@@ -1,10 +1,13 @@
 export {
   qraftAPIClient,
   type CreateAPIClientOptions,
+  type CreateAPIBasicQueryClientOptions,
   type CreateAPIBasicClientOptions,
   type CreateAPIQueryClientOptions,
   type APIQueryClientServices,
+  type APIBasicQueryClientServices,
   type APIBasicClientServices,
+  type APIUtilityClientServices,
   type QraftClientOptions,
 } from './qraftAPIClient.js';
 export {
@@ -13,15 +16,11 @@ export {
   urlSerializer,
   bodySerializer,
   mergeHeaders,
+  type RequestFn,
   type RequestFnResponse,
+  type HeadersOptions,
+  type RequestFnOptions,
+  type RequestFnInfo,
+  type OperationSchema,
+  type RequestFnPayload,
 } from './lib/requestFn.js';
-
-export type {
-  RequestFnPayload,
-  RequestFnOptions,
-  HeadersOptions,
-  OperationSchema,
-  RequestFn,
-} from './lib/requestFn.js';
-
-export type * from './service-operation/index.js';

package/src/lib/callQueryClientFetchMethod.ts

@@ -46,17 +46,19 @@ export function callQueryClientMethodWithQueryKey<
 
   const queryFn =
     queryFnOption ??
-    // @ts-expect-error - Too complex union to type
-    function ({ queryKey: [, queryParams], signal, meta, pageParam }) {
-      return requestFn(schema, {
-        parameters: infinite
-          ? (shelfMerge(2, queryParams, pageParam) as never)
-          : queryParams,
-        baseUrl,
-        signal,
-        meta,
-      }).then(requestFnResponseResolver, requestFnResponseResolver);
-    };
+    (requestFn
+      ? // @ts-expect-error - Too complex union to type
+        function ({ queryKey: [, queryParams], signal, meta, pageParam }) {
+          return requestFn(schema, {
+            parameters: infinite
+              ? (shelfMerge(2, queryParams, pageParam) as never)
+              : queryParams,
+            baseUrl,
+            signal,
+            meta,
+          }).then(requestFnResponseResolver, requestFnResponseResolver);
+        }
+      : undefined);
 
   // @ts-expect-error - Too complex union to type
   return queryClient[queryFilterMethod]({

package/src/lib/composeBaseQueryKey.ts

@@ -1,7 +1,7 @@
 import type {
   ServiceOperationInfiniteQueryKey,
   ServiceOperationQueryKey,
-} from '../service-operation/ServiceOperationKey.js';
+} from '@openapi-qraft/tanstack-query-react-types';
 import type { OperationSchema } from './requestFn.js';
 
 export function composeBaseQueryKey<TSchema extends OperationSchema, TParams>(

package/src/lib/composeInfiniteQueryKey.ts

@@ -1,4 +1,4 @@
-import type { ServiceOperationInfiniteQueryKey } from '../service-operation/ServiceOperationKey.js';
+import type { ServiceOperationInfiniteQueryKey } from '@openapi-qraft/tanstack-query-react-types';
 import type { OperationSchema } from './requestFn.js';
 import { composeBaseQueryKey } from './composeBaseQueryKey.js';
 

package/src/lib/composeMutationKey.ts

@@ -1,4 +1,4 @@
-import type { ServiceOperationMutationKey } from '../service-operation/ServiceOperationKey.js';
+import type { ServiceOperationMutationKey } from '@openapi-qraft/tanstack-query-react-types';
 import type { OperationSchema } from './requestFn.js';
 
 /**

package/src/lib/composeQueryKey.ts

@@ -1,4 +1,4 @@
-import type { ServiceOperationQueryKey } from '../service-operation/ServiceOperationKey.js';
+import type { ServiceOperationQueryKey } from '@openapi-qraft/tanstack-query-react-types';
 import type { OperationSchema } from './requestFn.js';
 import { composeBaseQueryKey } from './composeBaseQueryKey.js';
 

package/src/lib/requestFn.ts

@@ -1,3 +1,11 @@
+import type {
+  HeadersOptions,
+  OperationSchema,
+  RequestFnInfo,
+  RequestFnOptions,
+  RequestFnResponse,
+} from '@openapi-qraft/tanstack-query-react-types';
+
 /**
  * This function is used to make a request to a specified endpoint.
  *
@@ -88,7 +96,7 @@ export async function baseRequestFn<TData, TError>(
  */
 export function urlSerializer(
   schema: OperationSchema,
-  info: RequestFnPayload
+  info: Pick<RequestFnInfo, 'baseUrl' | 'parameters'>
 ): string {
   const path = schema.url.replace(
     /{(.*?)}/g,
@@ -171,10 +179,7 @@ export function mergeHeaders(...allHeaders: (HeadersOptions | undefined)[]) {
   return headers;
 }
 
-export function bodySerializer(
-  schema: OperationSchema,
-  info: RequestFnPayload
-) {
+export function bodySerializer(schema: OperationSchema, info: RequestFnInfo) {
   if (info.body === undefined) return;
 
   if (
@@ -201,7 +206,7 @@ export function bodySerializer(
 
 function getRequestBodyFormData({
   body,
-}: Pick<RequestFnPayload, 'body'>): FormData | undefined {
+}: Pick<RequestFnInfo, 'body'>): FormData | undefined {
   if (body instanceof FormData) return body;
   if (body === null) return;
 
@@ -240,7 +245,7 @@ function getRequestBodyFormData({
   return formData;
 }
 
-function getBodyContentType(body: RequestFnPayload['body']) {
+function getBodyContentType(body: RequestFnInfo['body']) {
   if (!body) return;
   if (body instanceof Blob) return body.type || 'application/octet-stream';
   if (typeof body === 'string') return 'text/plain';
@@ -315,112 +320,20 @@ function resolveResponse<TData, TError>(
     );
 }
 
-// To have definitely typed headers without a conversion to stings
-export type HeadersOptions =
-  | HeadersInit
-  | Record<string, string | number | boolean | null | undefined>;
-
-export interface OperationSchema {
-  /**
-   * Operation path
-   * @example /user/{id}
-   */
-  readonly url: string; //todo::rename to `path`
-
-  /**
-   * Operation method
-   */
-  readonly method:
-    | 'get'
-    | 'put'
-    | 'post'
-    | 'patch'
-    | 'delete'
-    | 'options'
-    | 'head'
-    | 'trace';
-
-  /**
-   * Media type of the request body
-   * @example application/json
-   */
-  readonly mediaType?: string;
-
-  readonly security?: string[];
-}
-
-export interface RequestFnPayload {
-  /**
-   * Base URL to use for the request
-   * @example 'https://api.example.com'
-   */
-  baseUrl?: string;
-
-  /**
-   * OpenAPI parameters
-   * @example
-   * ```ts
-   * { path: {id: 1}, query: {search: 'hello'} }
-   * ```
-   */
-  readonly parameters?: {
-    readonly path?: Record<string, any>;
-    readonly header?: Record<string, any>;
-    readonly query?: Record<string, any>;
-  };
-
-  /**
-   * Request body
-   * @example { name: 'John' }
-   */
-  readonly body?: BodyInit | Record<string, unknown> | null;
-
-  /**
-   * Tanstack Query Meta
-   */
-  meta?: Record<string, unknown>;
-
-  /** An AbortSignal to set request's signal. */
-  signal?: AbortSignal | null;
-}
-
-export interface RequestFnInfo
-  extends RequestFnPayload,
-    Omit<RequestInit, 'headers' | 'method' | 'body' | 'signal'> {
-  /**
-   * Request headers
-   * @example { 'X-Auth': '123' }
-   */
-  readonly headers?: HeadersOptions;
-}
-
-export interface RequestFnOptions {
-  urlSerializer?: typeof urlSerializer;
-  bodySerializer?: typeof bodySerializer;
-  fetch?: typeof fetch;
-}
-
-export type RequestFn<TData, TError> = typeof requestFn<TData, TError>;
-
-export type RequestFnResponse<TData, TError> =
-  | {
-      data?: TData;
-      response: Response;
-      error?: never;
-    }
-  | {
-      // server error
-      error?: TError | Error;
-      response: Response;
-      data?: never;
-    }
-  | {
-      // network error
-      error?: Error;
-      data?: never;
-      response?: never;
-    };
-
 type WithRequired<T, K extends keyof T> = T & {
   [_ in K]: {};
 };
+
+export type {
+  RequestFn,
+  RequestFnResponse,
+  HeadersOptions,
+  RequestFnOptions,
+  RequestFnInfo,
+  OperationSchema,
+} from '@openapi-qraft/tanstack-query-react-types';
+
+/**
+ * @deprecated use `RequestFnInfo` instead
+ */
+export type RequestFnPayload = RequestFnInfo;

package/src/lib/useComposeUseQueryOptions.ts

@@ -1,9 +1,9 @@
 'use client';
 
+import type { ServiceOperationQueryKey } from '@openapi-qraft/tanstack-query-react-types';
 import type { QueryClient } from '@tanstack/query-core';
 import type { UseQueryOptions } from '@tanstack/react-query';
 import type { CreateAPIQueryClientOptions } from '../qraftAPIClient.js';
-import type { ServiceOperationQueryKey } from '../service-operation/ServiceOperationKey.js';
 import type { OperationSchema } from './requestFn.js';
 import { composeInfiniteQueryKey } from './composeInfiniteQueryKey.js';
 import { composeQueryKey } from './composeQueryKey.js';
@@ -24,7 +24,6 @@ export function useComposeUseQueryOptions(
 
   const queryFn =
     options?.queryFn ??
-    // @ts-expect-error - Too complex to type
     function ({ queryKey: [, queryParams], signal, meta, pageParam }) {
       return qraftOptions
         .requestFn(schema, {

package/src/migrate-to-v2-codemod.ts

@@ -0,0 +1,118 @@
+import {
+  API,
+  ASTPath,
+  CallExpression,
+  FileInfo,
+  MemberExpression,
+  Options,
+} from 'jscodeshift';
+
+export default function transformer(
+  file: FileInfo,
+  api: API,
+  options: Options
+) {
+  const j = api.jscodeshift;
+  const root = j(file.source);
+
+  const methodNames = [
+    'fetchQuery',
+    'fetchInfiniteQuery',
+    'prefetchQuery',
+    'prefetchInfiniteQuery',
+    'getQueryData',
+    'getQueriesData',
+    'setQueryData',
+    'getQueryState',
+    'setQueriesData',
+    'invalidateQueries',
+    'refetchQueries',
+    'cancelQueries',
+    'removeQueries',
+    'resetQueries',
+    'isFetching',
+    'isMutating',
+    'setInfiniteQueryData',
+    'getInfiniteQueryData',
+    'getInfiniteQueryState',
+  ];
+
+  const hooksWithTwoArgs = [
+    'useSuspenseQueries',
+    'useIsFetching',
+    'useMutationState',
+    'useIsMutating',
+  ];
+
+  const hooksWithThreeArgs = [
+    'useQuery',
+    'useMutation',
+    'useInfiniteQuery',
+    'useQueries',
+    'useSuspenseQuery',
+    'useSuspenseInfiniteQuery',
+  ];
+
+  const apiClientVariableNames = getAPIClientVariableNames(options);
+
+  return root
+    .find(j.CallExpression)
+    .forEach((path: ASTPath<CallExpression>) => {
+      const callee = path.node.callee;
+      if (callee.type === 'MemberExpression') {
+        const apiClientCallMethodName = getAPIClientCallMethodName(
+          callee,
+          apiClientVariableNames
+        );
+        if (apiClientCallMethodName) {
+          if (methodNames.includes(apiClientCallMethodName)) {
+            // Remove the last argument `queryClient`
+            path.node.arguments = path.node.arguments.slice(0, -1);
+          } else if (
+            hooksWithTwoArgs.includes(apiClientCallMethodName) &&
+            path.node.arguments.length === 2
+          ) {
+            // Remove the second argument for specific hooks if there are exactly two arguments
+            path.node.arguments = path.node.arguments.slice(0, 1);
+          } else if (
+            hooksWithThreeArgs.includes(apiClientCallMethodName) &&
+            path.node.arguments.length === 3
+          ) {
+            // Remove the third argument for specific hooks if there are exactly three arguments
+            path.node.arguments = path.node.arguments.slice(0, 2);
+          }
+        }
+      }
+    })
+    .toSource();
+}
+
+function getAPIClientCallMethodName(
+  node: MemberExpression,
+  apiClientNames: string[]
+): string | undefined {
+  if (
+    node.object.type === 'MemberExpression' &&
+    node.object.object.type === 'MemberExpression' &&
+    node.object.object.object.type === 'Identifier' &&
+    node.object.object.property.type === 'Identifier' &&
+    node.object.property.type === 'Identifier' &&
+    node.property.type === 'Identifier'
+  ) {
+    const apiClientVariableName = node.object.object.object.name;
+
+    if (apiClientNames.includes(apiClientVariableName))
+      return node.property.name;
+  }
+}
+
+function getAPIClientVariableNames(options: Options) {
+  const apiClientVariableNameOption = options['api-client-variable-name'];
+
+  if (!apiClientVariableNameOption) return ['api', 'qraft'];
+
+  return String(apiClientVariableNameOption)
+    .split(',')
+    .map((name) => name.trim())
+    .filter(Boolean);
+}