@openapi-qraft/react 1.0.0-beta.4 → 1.0.0-beta.6

package/dist/lib/shelfMerge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shelfMerge.js","sourceRoot":"","sources":["../../src/lib/shelfMerge.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAI,KAAK,GAAG,CAAC,EAAE,GAAG,IAAS;IACnD,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAC9B,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;YAAE,OAAO,GAAG,CAAC;QAEhD,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC3C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9B,GAAG,CAAC,GAAY,CAAC,GAAG,KAAc,CAAC;gBACnC,OAAO;YACT,CAAC;YAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,GAAG,CAAC,GAAY,CAAC,GAAG,KAAc,CAAC;gBACnC,OAAO;YACT,CAAC;YAED,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACd,GAAG,CAAC,GAAY,CAAC,GAAG,UAAU,CAC5B,KAAK,GAAG,CAAC,EACT,GAAG,CAAC,GAAY,CAAC,EACjB,KAAK,CACG,CAAC;gBACX,OAAO;YACT,CAAC;YAED,GAAG,CAAC,GAAY,CAAC,GAAG,KAAc,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAO,CAAC,CAAC;AACd,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-qraft/react",
-  "version": "1.0.0-beta.4",
+  "version": "1.0.0-beta.6",
   "description": "API client for React, providing type-safe requests and dynamic Tanstack Query React Hooks via a modular, Proxy-based architecture.",
   "scripts": {
     "build": "rimraf dist/ && tsc --project tsconfig.build.json",
@@ -13,7 +13,7 @@
   "type": "module",
   "sideEffects": false,
   "devDependencies": {
-    "@openapi-qraft/cli": "~1.0.0-beta.2",
+    "@openapi-qraft/cli": "~1.0.0-beta.4",
     "@openapi-qraft/openapi-typescript": "^1.0.0-beta.1",
     "@tanstack/react-query": "^5.17.3",
     "@testing-library/jest-dom": "^5.17.0",

package/src/ServiceOperation.ts

@@ -1,13 +1,16 @@
 import {
   DefaultError,
   InfiniteData,
-  QueryClient,
   InfiniteQueryPageParamsOptions,
+  Mutation,
+  MutationState,
+  MutationStatus,
   NoInfer,
+  QueryClient,
   SetDataOptions,
   Updater,
 } from '@tanstack/query-core';
-import type {
+import {
   DefinedInitialDataInfiniteOptions,
   DefinedInitialDataOptions,
   DefinedUseInfiniteQueryResult,
@@ -18,6 +21,10 @@ import type {
   UseMutationOptions,
   UseMutationResult,
   UseQueryResult,
+  UseSuspenseInfiniteQueryOptions,
+  UseSuspenseInfiniteQueryResult,
+  UseSuspenseQueryOptions,
+  UseSuspenseQueryResult,
 } from '@tanstack/react-query';
 
 export type ServiceOperationQueryKey<S extends { url: string }, T> = [
@@ -32,8 +39,10 @@ export type ServiceOperationInfiniteQueryKey<S extends { url: string }, T> = [
 
 export type ServiceOperationMutationKey<
   S extends Record<'url' | 'method', string>,
-  T,
-> = [Pick<S, 'url' | 'method'>, T];
+  T extends unknown,
+> = NonNullable<T> extends never
+  ? [Pick<S, 'url' | 'method'>]
+  : [Pick<S, 'url' | 'method'>, T];
 
 export interface ServiceOperationQuery<
   TSchema extends { url: string; method: string },
@@ -42,6 +51,8 @@ export interface ServiceOperationQuery<
   TError = DefaultError,
 > extends ServiceOperationUseQuery<TSchema, TData, TParams, TError>,
     ServiceOperationUseInfiniteQuery<TSchema, TData, TParams, TError>,
+    ServiceOperationUseSuspenseQueryQuery<TSchema, TData, TParams, TError>,
+    ServiceOperationUseSuspenseInfiniteQuery<TSchema, TData, TParams, TError>,
     ServiceOperationQueryFn<TSchema, TData, TParams>,
     ServiceOperationGetQueryData<TData, TParams>,
     ServiceOperationGetInfiniteQueryData<TData, TParams>,
@@ -144,6 +155,56 @@ interface ServiceOperationUseInfiniteQuery<
   ): DefinedUseInfiniteQueryResult<InfiniteData<TData>, TError | Error>;
 }
 
+interface ServiceOperationUseSuspenseInfiniteQuery<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> {
+  useSuspenseInfiniteQuery<TPageParam extends TParams>(
+    params: TParams,
+    options: Omit<
+      UseSuspenseInfiniteQueryOptions<
+        TData,
+        TError,
+        InfiniteData<TData>,
+        TData,
+        | ServiceOperationInfiniteQueryKey<TSchema, TParams>
+        | readonly [...ServiceOperationInfiniteQueryKey<TSchema, TParams>],
+        PartialParams<TPageParam>
+      >,
+      | 'queryKey'
+      | 'getPreviousPageParam'
+      | 'getNextPageParam'
+      | 'initialPageParam'
+    > &
+      InfiniteQueryPageParamsOptions<TData, PartialParams<TPageParam>>,
+    queryClient?: QueryClient
+  ): UseSuspenseInfiniteQueryResult<InfiniteData<TData>, TError | Error>;
+}
+
+interface ServiceOperationUseSuspenseQueryQuery<
+  TSchema extends { url: string; method: string },
+  TData,
+  TParams = {},
+  TError = DefaultError,
+> {
+  useSuspenseQuery(
+    params: TParams,
+    options?: Omit<
+      UseSuspenseQueryOptions<
+        TData,
+        TError,
+        TData,
+        | ServiceOperationQueryKey<TSchema, TParams>
+        | readonly [...ServiceOperationQueryKey<TSchema, TParams>]
+      >,
+      'queryKey'
+    >,
+    queryClient?: QueryClient
+  ): UseSuspenseQueryResult<TData, TError | Error>;
+}
+
 export interface ServiceOperationMutation<
   TSchema extends { url: string; method: string },
   TBody,
@@ -151,6 +212,7 @@ export interface ServiceOperationMutation<
   TParams,
   TError = DefaultError,
 > extends ServiceOperationUseMutation<TSchema, TBody, TData, TParams, TError>,
+    ServiceOperationUseMutationState<TSchema, TBody, TData, TParams, TError>,
     ServiceOperationMutationFn<TSchema, TBody, TData, TParams>,
     ServiceOperationSetQueryData<TData, TParams> {
   schema: TSchema;
@@ -164,13 +226,11 @@ interface ServiceOperationUseMutation<
   TError = DefaultError,
 > {
   getMutationKey<T extends TParams>(
-    params: T
+    params: T | undefined
   ): ServiceOperationMutationKey<TSchema, T>;
 
   useMutation<
-    TVariables extends { body: TBody } & (NonNullable<TParams> extends never
-      ? {}
-      : TParams),
+    TVariables extends MutationVariables<TBody, TParams>,
     TContext = unknown,
   >(
     params?: undefined,
@@ -196,6 +256,94 @@ interface ServiceOperationUseMutation<
   ): UseMutationResult<TData, TError | Error, TVariables, TContext>;
 }
 
+type MutationFilters<
+  TSchema extends { url: string; method: string },
+  TBody,
+  TData,
+  TParams,
+  TError = DefaultError,
+  TContext = unknown,
+> = {
+  /**
+   * Match mutation key exactly
+   */
+  exact?: boolean;
+  /**
+   * Include mutations matching this predicate function
+   */
+  predicate?: (
+    mutation: Mutation<
+      TData,
+      TError,
+      MutationVariables<TBody, TParams>,
+      TContext
+    >
+  ) => boolean;
+
+  /**
+   * Filter by mutation status
+   */
+  status?: MutationStatus;
+} & (
+  | {
+      /**
+       * Include mutations matching this mutation key
+       */
+      mutationKey?: ServiceOperationMutationKey<
+        TSchema,
+        PartialParams<TParams>
+      >;
+    }
+  | {
+      /**
+       * Include mutations matching these parameters
+       */
+      parameters?: PartialParams<TParams>;
+    }
+);
+
+type MutationVariables<TBody, TParams> = {
+  body: TBody;
+} & (NonNullable<TParams> extends never ? {} : TParams);
+
+interface ServiceOperationUseMutationState<
+  TSchema extends { url: string; method: string },
+  TBody,
+  TData,
+  TParams,
+  TError = DefaultError,
+> {
+  useMutationState<
+    TContext = unknown,
+    TResult = MutationState<
+      TData,
+      TError,
+      MutationVariables<TBody, TParams>,
+      TContext
+    >,
+  >(
+    options?: {
+      filters?: MutationFilters<
+        TSchema,
+        TBody,
+        TData,
+        TParams,
+        TError,
+        TContext
+      >;
+      select?: (
+        mutation: Mutation<
+          TData,
+          TError,
+          MutationVariables<TBody, TParams>,
+          TContext
+        >
+      ) => TResult;
+    },
+    queryClient?: QueryClient
+  ): Array<TResult>;
+}
+
 interface ServiceOperationQueryFn<
   TSchema extends { url: string; method: string },
   TData,

package/src/callbacks/getMutationKey.ts

@@ -1,47 +1,19 @@
+import { composeMutationKey } from '../lib/composeMutationKey.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
 import type { RequestClientSchema } from '../RequestClient.js';
-import {
-  ServiceOperationMutation,
-  ServiceOperationMutationKey,
-} from '../ServiceOperation.js';
+import { ServiceOperationMutation } from '../ServiceOperation.js';
 
 export const getMutationKey = (
   qraftOptions: QraftClientOptions | undefined,
   schema: RequestClientSchema,
-  args: unknown
-) => {
-  const [parameters] = args as Parameters<
+  args: Parameters<
     ServiceOperationMutation<
       RequestClientSchema,
       unknown,
       unknown,
       unknown
     >['getMutationKey']
-  >;
-
-  const key: ServiceOperationMutationKey<RequestClientSchema, unknown> = [
-    {
-      url: schema.url,
-      method: schema.method,
-    },
-    omitMutationPayload(parameters),
-  ];
-
-  return key;
+  >
+) => {
+  return composeMutationKey(schema, args[0]);
 };
-
-function omitMutationPayload<T>(params: T) {
-  if (!params || typeof params !== 'object')
-    throw new Error('`params` must be object');
-
-  if ('body' in params || 'requestBody' in params) {
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const { body, requestBody, ...paramsRest } = params as Record<
-      'body' | 'requestBody',
-      unknown
-    >;
-    return paramsRest;
-  }
-
-  return params as Omit<T, 'body' | 'requestBody'>;
-}

package/src/callbacks/useInfiniteQuery.ts

@@ -8,6 +8,7 @@ import {
   UseInfiniteQueryResult,
 } from '@tanstack/react-query';
 
+import { shelfMerge } from '../lib/shelfMerge.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
 import { QraftContext } from '../QraftContext.js';
 import type { RequestClientSchema } from '../RequestClient.js';
@@ -52,39 +53,3 @@ export const useInfiniteQuery: <
     ...restArgs
   ) as never;
 };
-
-/**
- * Merges objects with provided depth
- * @param depth
- * @param args
- */
-export function shelfMerge<T>(depth = 2, ...args: T[]): T {
-  return args.reduce((acc, arg) => {
-    if (!arg || typeof arg !== 'object') return acc;
-
-    Object.entries(arg).forEach(([key, value]) => {
-      if (typeof value !== 'object') {
-        acc[key as never] = value as never;
-        return;
-      }
-
-      if (Array.isArray(value)) {
-        acc[key as never] = value as never;
-        return;
-      }
-
-      if (depth > 1) {
-        acc[key as never] = shelfMerge(
-          depth - 1,
-          acc[key as never],
-          value
-        ) as never;
-        return;
-      }
-
-      acc[key as never] = value as never;
-    });
-
-    return acc;
-  }, {} as T);
-}

package/src/callbacks/useMutation.ts

@@ -6,6 +6,7 @@ import type { DefaultError } from '@tanstack/query-core';
 import type { UseMutationResult } from '@tanstack/react-query';
 import { useMutation as useMutationBase } from '@tanstack/react-query';
 
+import { composeMutationKey } from '../lib/composeMutationKey.js';
 import type { QraftClientOptions } from '../qraftAPIClient.js';
 import { QraftContext } from '../QraftContext.js';
 import type { RequestClientSchema } from '../RequestClient.js';
@@ -53,25 +54,12 @@ export const useMutation: <
   if (!requestClient) throw new Error(`QraftContext.requestClient not found`);
 
   const mutationKey =
-    parameters && typeof parameters === 'object'
-      ? ([
-          {
-            url: schema.url,
-            method: schema.method,
-          },
-          parameters,
-        ] as const)
-      : options && 'mutationKey' in options
-        ? (options.mutationKey as ServiceOperationMutationKey<
-            typeof schema,
-            unknown
-          >)
-        : ([
-            {
-              url: schema.url,
-              method: schema.method,
-            },
-          ] as const);
+    options && 'mutationKey' in options
+      ? (options.mutationKey as ServiceOperationMutationKey<
+          typeof schema,
+          unknown
+        >)
+      : composeMutationKey(schema, parameters);
 
   return useMutationBase(
     {

package/src/callbacks/useMutationState.ts

@@ -0,0 +1,73 @@
+'use client';
+
+import { useContext } from 'react';
+
+import type { DefaultError } from '@tanstack/query-core';
+import type { UseMutationResult } from '@tanstack/react-query';
+import { useMutationState as useMutationStateTanstack } from '@tanstack/react-query';
+
+import { composeMutationKey } from '../lib/composeMutationKey.js';
+import type { QraftClientOptions } from '../qraftAPIClient.js';
+import { QraftContext } from '../QraftContext.js';
+import type { RequestClientSchema } from '../RequestClient.js';
+import { ServiceOperationMutation } from '../ServiceOperation.js';
+
+export const useMutationState: <
+  TData = unknown,
+  TError = DefaultError,
+  TVariables = unknown,
+  TContext = unknown,
+>(
+  qraftOptions: QraftClientOptions | undefined,
+  schema: RequestClientSchema,
+  args: Parameters<
+    ServiceOperationMutation<
+      RequestClientSchema,
+      object | undefined,
+      TVariables,
+      TData
+    >['useMutationState']
+  >
+) => UseMutationResult<TData, TError, TVariables, TContext> = (
+  qraftOptions,
+  schema,
+  args
+) => {
+  const [options, ...restArgs] = args;
+
+  if (
+    options?.filters &&
+    'parameters' in options.filters &&
+    'mutationKey' in options.filters
+  ) {
+    throw new Error(
+      `'useMutationState': 'parameters' and 'mutationKey' cannot be used together`
+    );
+  }
+
+  const requestClient = useContext(qraftOptions?.context ?? QraftContext)
+    ?.requestClient;
+
+  if (!requestClient) throw new Error(`QraftContext.requestClient not found`);
+
+  const filters = options?.filters;
+
+  return useMutationStateTanstack(
+    {
+      ...options,
+      filters:
+        filters && 'mutationKey' in filters
+          ? filters
+          : {
+              ...filters,
+              mutationKey: composeMutationKey(
+                schema,
+                filters && 'parameters' in filters
+                  ? filters.parameters
+                  : undefined
+              ),
+            },
+    } as never,
+    ...restArgs
+  ) as never;
+};

package/src/callbacks/useSuspenseInfiniteQuery.ts

@@ -0,0 +1,60 @@
+'use client';
+
+import { useContext } from 'react';
+
+import type { DefaultError, InfiniteData } from '@tanstack/query-core';
+import {
+  useSuspenseInfiniteQuery as useSuspenseInfiniteQueryTanstack,
+  UseSuspenseInfiniteQueryResult,
+} from '@tanstack/react-query';
+
+import { shelfMerge } from '../lib/shelfMerge.js';
+import type { QraftClientOptions } from '../qraftAPIClient.js';
+import { QraftContext } from '../QraftContext.js';
+import type { RequestClientSchema } from '../RequestClient.js';
+import {
+  ServiceOperationQuery,
+  ServiceOperationQueryKey,
+} from '../ServiceOperation.js';
+
+export const useSuspenseInfiniteQuery: <
+  TQueryFnData,
+  TError = DefaultError,
+  TData = InfiniteData<TQueryFnData>,
+>(
+  qraftOptions: QraftClientOptions | undefined,
+  schema: RequestClientSchema,
+  args: Parameters<
+    ServiceOperationQuery<
+      RequestClientSchema,
+      unknown,
+      unknown
+    >['useSuspenseInfiniteQuery']
+  >
+) => UseSuspenseInfiniteQueryResult<TData, TError> & {
+  queryKey: ServiceOperationQueryKey<RequestClientSchema, unknown>;
+} = (qraftOptions, schema, args) => {
+  const [params, options, ...restArgs] = args;
+
+  const requestClient = useContext(qraftOptions?.context ?? QraftContext)
+    ?.requestClient;
+
+  if (!requestClient) throw new Error(`QraftContext.requestClient not found`);
+
+  return useSuspenseInfiniteQueryTanstack(
+    {
+      ...options,
+      queryKey: [{ url: schema.url, infinite: true }, params as never] as const,
+      queryFn:
+        options?.queryFn ??
+        function ({ queryKey: [, queryParams], signal, meta, pageParam }) {
+          return requestClient(schema, {
+            parameters: shelfMerge(2, queryParams, pageParam) as never,
+            signal,
+            meta,
+          });
+        },
+    },
+    ...restArgs
+  ) as never;
+};

package/src/callbacks/useSuspenseQuery.ts

@@ -0,0 +1,64 @@
+'use client';
+
+import { useContext } from 'react';
+
+import type { DefaultError } from '@tanstack/query-core';
+import {
+  UseQueryResult,
+  useSuspenseQuery as useSuspenseQueryTanstack,
+} from '@tanstack/react-query';
+
+import type { QraftClientOptions } from '../qraftAPIClient.js';
+import { QraftContext } from '../QraftContext.js';
+import type { RequestClientSchema } from '../RequestClient.js';
+import {
+  ServiceOperationQuery,
+  ServiceOperationQueryKey,
+} from '../ServiceOperation.js';
+
+export const useSuspenseQuery: <
+  TQueryFnData = unknown,
+  TError = DefaultError,
+  TData = TQueryFnData,
+>(
+  qraftOptions: QraftClientOptions | undefined,
+  schema: RequestClientSchema,
+  args: Parameters<
+    ServiceOperationQuery<
+      RequestClientSchema,
+      unknown,
+      unknown
+    >['useSuspenseQuery']
+  >
+) => UseQueryResult<TData, TError> & {
+  queryKey: ServiceOperationQueryKey<RequestClientSchema, unknown>;
+} = (qraftOptions, schema, args) => {
+  const [params, options, ...restArgs] = args;
+
+  const requestClient = useContext(qraftOptions?.context ?? QraftContext)
+    ?.requestClient;
+
+  if (!requestClient) throw new Error(`QraftContext.requestClient not found`);
+
+  const queryKey: ServiceOperationQueryKey<RequestClientSchema, unknown> = [
+    { url: schema.url },
+    params,
+  ];
+
+  return useSuspenseQueryTanstack(
+    {
+      ...options,
+      queryKey,
+      queryFn:
+        options?.queryFn ??
+        function ({ queryKey: [, queryParams], signal, meta }) {
+          return requestClient(schema, {
+            parameters: queryParams as never,
+            signal,
+            meta,
+          });
+        },
+    },
+    ...restArgs
+  ) as never;
+};

package/src/lib/composeMutationKey.test.ts

@@ -0,0 +1,43 @@
+import { composeMutationKey } from './composeMutationKey.js';
+
+describe('composeMutationKey', () => {
+  it('should return mutation key with parameters', () => {
+    const schema = {
+      url: 'https://example.com',
+      method: 'get',
+    } as const;
+
+    const parameters = {
+      body: 'body',
+      requestBody: 'requestBody',
+      other: 'other',
+    };
+    const result = composeMutationKey(schema, parameters);
+
+    expect(result).toEqual([
+      {
+        url: schema.url,
+        method: schema.method,
+      },
+      {
+        other: 'other',
+      },
+    ]);
+  });
+
+  it('should return mutation key without parameters', () => {
+    const schema = {
+      url: 'https://example.com',
+      method: 'get',
+    } as const;
+
+    const result = composeMutationKey(schema, undefined);
+
+    expect(result).toEqual([
+      {
+        url: schema.url,
+        method: schema.method,
+      },
+    ]);
+  });
+});

package/src/lib/composeMutationKey.ts

@@ -0,0 +1,50 @@
+import type { RequestClientSchema } from '../RequestClient.js';
+import { ServiceOperationMutationKey } from '../ServiceOperation.js';
+
+/**
+ * Omit `body` or `requestBody` from mutation parameters if exists
+ * and return the rest of the parameters
+ */
+export function composeMutationKey<
+  TSchema extends RequestClientSchema,
+  TParams = undefined,
+>(
+  schema: TSchema,
+  parameters: undefined
+): ServiceOperationMutationKey<TSchema, undefined>;
+export function composeMutationKey<
+  TSchema extends RequestClientSchema,
+  TParams,
+>(
+  schema: TSchema,
+  parameters: TParams
+): ServiceOperationMutationKey<TSchema, TParams>;
+export function composeMutationKey<
+  TSchema extends RequestClientSchema,
+  TParams = unknown,
+>(schema: TSchema, parameters: TParams | undefined) {
+  return parameters === undefined
+    ? [{ url: schema.url, method: schema.method }]
+    : [
+        {
+          url: schema.url,
+          method: schema.method,
+        },
+        omitMutationPayload(parameters),
+      ];
+}
+
+export function omitMutationPayload<T>(params: T) {
+  if (!params || typeof params !== 'object')
+    throw new Error('`params` must be object');
+
+  if ('body' in params || 'requestBody' in params) {
+    const { body, requestBody, ...paramsRest } = params as Record<
+      'body' | 'requestBody',
+      unknown
+    >;
+    return paramsRest;
+  }
+
+  return params as Omit<T, 'body' | 'requestBody'>;
+}

package/src/{callbacks → lib}/shelfMerge.test.ts

@@ -1,4 +1,4 @@
-import { shelfMerge } from './useInfiniteQuery.js';
+import { shelfMerge } from './shelfMerge.js';
 
 describe('shelfMerge', () => {
   it('merges simple objects', async () => {