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

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @openapi-qraft/react
 
+## 2.0.0-next.2
+
+### Patch Changes
+
+- 56191e1: Updated the `getQueryState(...)` function to support being invoked without parameters if they are not required. This enhancement simplifies the usage in scenarios where the parameters are optional, providing a more flexible API.
+- bbcac65: Refined all types related to value in the `qraftPredefinedParametersRequestFn(...)` function.
+
 ## 2.0.0-next.1
 
 ### Minor Changes

package/dist/types/migrate-to-v2-codemod.d.ts

@@ -0,0 +1,3 @@
+import { API, FileInfo, Options } from 'jscodeshift';
+export default function transformer(file: FileInfo, api: API, options: Options): string;
+//# sourceMappingURL=migrate-to-v2-codemod.d.ts.map

package/dist/types/migrate-to-v2-codemod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrate-to-v2-codemod.d.ts","sourceRoot":"","sources":["../../src/migrate-to-v2-codemod.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,GAAG,EAGH,QAAQ,EAER,OAAO,EACR,MAAM,aAAa,CAAC;AAErB,MAAM,CAAC,OAAO,UAAU,WAAW,CACjC,IAAI,EAAE,QAAQ,EACd,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,OAAO,UA2EjB"}

package/dist/types/qraftPredefinedParametersRequestFn.d.ts

@@ -1,5 +1,5 @@
 import type { RequestFn } from './lib/requestFn.js';
-export type QraftPredefinedParameterValue<T> = T extends () => Promise<infer R> ? R | undefined : T | undefined;
+export type QraftPredefinedParameterValue<TValue> = TValue | (() => Promise<TValue | undefined>) | undefined;
 export type InputPredefinedParametersItem<TValue> = {
     requestPattern: string;
     parameters: Array<{

package/dist/types/qraftPredefinedParametersRequestFn.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"qraftPredefinedParametersRequestFn.d.ts","sourceRoot":"","sources":["../../src/qraftPredefinedParametersRequestFn.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,SAAS,EAIV,MAAM,oBAAoB,CAAC;AAG5B,MAAM,MAAM,6BAA6B,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,GAC3E,CAAC,GAAG,SAAS,GACb,CAAC,GAAG,SAAS,CAAC;AAElB,MAAM,MAAM,6BAA6B,CAAC,MAAM,IAAI;IAClD,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,KAAK,CAAC;QAChB,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;QAClC,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,6BAA6B,CAAC,MAAM,CAAC,CAAC;KAC9C,CAAC,CAAC;CACJ,CAAC;AAEF,KAAK,iCAAiC,GAClC,KAAK,GACL,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,CAAC;AAEZ,MAAM,MAAM,8BAA8B,GAAG;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EACH,KAAK,CAAC,iCAAiC,CAAC,GACxC,aAAa,CAAC,QAAQ,CAAC,iCAAiC,CAAC,CAAC,CAAC;IAC/D,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;CACxD,CAAC;AAEF,wBAAgB,kCAAkC,CAChD,8BAA8B,SAAS,6BAA6B,CAAC,GAAG,CAAC,EACzE,KAAK,EACL,MAAM,EAEN,yBAAyB,EACrB,KAAK,CAAC,8BAA8B,CAAC,GACrC,aAAa,CAAC,QAAQ,CAAC,8BAA8B,CAAC,CAAC,EAC3D,0BAA0B,EACtB,KAAK,CAAC,8BAA8B,CAAC,GACrC,aAAa,CAAC,QAAQ,CAAC,8BAA8B,CAAC,CAAC,EAC3D,SAAS,EAAE,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,GAClC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CA6C1B"}
+{"version":3,"file":"qraftPredefinedParametersRequestFn.d.ts","sourceRoot":"","sources":["../../src/qraftPredefinedParametersRequestFn.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,SAAS,EAIV,MAAM,oBAAoB,CAAC;AAG5B,MAAM,MAAM,6BAA6B,CAAC,MAAM,IAC5C,MAAM,GACN,CAAC,MAAM,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC,GACnC,SAAS,CAAC;AAEd,MAAM,MAAM,6BAA6B,CAAC,MAAM,IAAI;IAClD,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,KAAK,CAAC;QAChB,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAC;QAClC,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,6BAA6B,CAAC,MAAM,CAAC,CAAC;KAC9C,CAAC,CAAC;CACJ,CAAC;AAEF,KAAK,iCAAiC,GAClC,KAAK,GACL,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,CAAC;AAEZ,MAAM,MAAM,8BAA8B,GAAG;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,OAAO,EACH,KAAK,CAAC,iCAAiC,CAAC,GACxC,aAAa,CAAC,QAAQ,CAAC,iCAAiC,CAAC,CAAC,CAAC;IAC/D,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;CACxD,CAAC;AAEF,wBAAgB,kCAAkC,CAChD,8BAA8B,SAAS,6BAA6B,CAAC,GAAG,CAAC,EACzE,KAAK,EACL,MAAM,EAEN,yBAAyB,EACrB,KAAK,CAAC,8BAA8B,CAAC,GACrC,aAAa,CAAC,QAAQ,CAAC,8BAA8B,CAAC,CAAC,EAC3D,0BAA0B,EACtB,KAAK,CAAC,8BAA8B,CAAC,GACrC,aAAa,CAAC,QAAQ,CAAC,8BAA8B,CAAC,CAAC,EAC3D,SAAS,EAAE,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,GAClC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CA6C1B"}

package/dist/types/service-operation/ServiceOperationGetQueryState.d.ts

@@ -1,11 +1,12 @@
 import type { DefaultError, QueryState } from '@tanstack/query-core';
 import type { OperationInfiniteData } from './OperationInfiniteData.js';
 import type { ServiceOperationInfiniteQueryKey, ServiceOperationQueryKey } from './ServiceOperationKey.js';
+import { AreAllOptional } from '../lib/AreAllOptional.js';
 export interface ServiceOperationGetQueryState<TSchema extends {
     url: string;
     method: string;
-}, TData, TParams = {}, TError = DefaultError> {
-    getQueryState(parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>): QueryState<TData, TError> | undefined;
-    getInfiniteQueryState(parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>): QueryState<OperationInfiniteData<TData, TParams>, TError> | undefined;
+}, TData, TParams, TError = DefaultError> {
+    getQueryState(parameters: AreAllOptional<TParams> extends true ? TParams | ServiceOperationQueryKey<TSchema, TParams> | void : TParams | ServiceOperationQueryKey<TSchema, TParams>): QueryState<TData, TError> | undefined;
+    getInfiniteQueryState(parameters: AreAllOptional<TParams> extends true ? TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams> | void : TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>): QueryState<OperationInfiniteData<TData, TParams>, TError> | undefined;
 }
 //# sourceMappingURL=ServiceOperationGetQueryState.d.ts.map

package/dist/types/service-operation/ServiceOperationGetQueryState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ServiceOperationGetQueryState.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationGetQueryState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EACV,gCAAgC,EAChC,wBAAwB,EACzB,MAAM,0BAA0B,CAAC;AAElC,MAAM,WAAW,6BAA6B,CAC5C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,KAAK,EACL,OAAO,GAAG,EAAE,EACZ,MAAM,GAAG,YAAY;IAErB,aAAa,CACX,UAAU,EAAE,OAAO,GAAG,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,GAC/D,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IAEzC,qBAAqB,CACnB,UAAU,EAAE,OAAO,GAAG,gCAAgC,CAAC,OAAO,EAAE,OAAO,CAAC,GACvE,UAAU,CAAC,qBAAqB,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;CAC1E"}
+{"version":3,"file":"ServiceOperationGetQueryState.d.ts","sourceRoot":"","sources":["../../../src/service-operation/ServiceOperationGetQueryState.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AACrE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACxE,OAAO,KAAK,EACV,gCAAgC,EAChC,wBAAwB,EACzB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1D,MAAM,WAAW,6BAA6B,CAC5C,OAAO,SAAS;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAC/C,KAAK,EACL,OAAO,EACP,MAAM,GAAG,YAAY;IAErB,aAAa,CACX,UAAU,EAAE,cAAc,CAAC,OAAO,CAAC,SAAS,IAAI,GAC5C,OAAO,GAAG,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,IAAI,GAC3D,OAAO,GAAG,wBAAwB,CAAC,OAAO,EAAE,OAAO,CAAC,GACvD,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;IAEzC,qBAAqB,CACnB,UAAU,EAAE,cAAc,CAAC,OAAO,CAAC,SAAS,IAAI,GAC5C,OAAO,GAAG,gCAAgC,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,IAAI,GACnE,OAAO,GAAG,gCAAgC,CAAC,OAAO,EAAE,OAAO,CAAC,GAC/D,UAAU,CAAC,qBAAqB,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;CAC1E"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openapi-qraft/react",
-  "version": "2.0.0-next.1",
+  "version": "2.0.0-next.2",
   "description": "API client for React, providing type-safe requests and dynamic Tanstack Query React Hooks via a modular, Proxy-based architecture.",
   "scripts": {
     "build": "NODE_ENV=production rollup --config rollup.config.mjs && tsc --project tsconfig.build.json --emitDeclarationOnly",
@@ -15,20 +15,22 @@
   },
   "sideEffects": false,
   "devDependencies": {
-    "@openapi-qraft/cli": "2.0.0-next.1",
+    "@openapi-qraft/cli": "2.0.0-next.2",
     "@openapi-qraft/eslint-config": "1.0.0",
-    "@openapi-qraft/openapi-typescript-plugin": "^1.2.0-next.1",
+    "@openapi-qraft/openapi-typescript-plugin": "^1.2.0-next.2",
     "@openapi-qraft/rollup-config": "1.1.0-next.0",
     "@openapi-qraft/test-fixtures": "1.0.0",
     "@tanstack/react-query": "^5.17.3",
     "@testing-library/jest-dom": "^5.17.0",
     "@testing-library/react": "^13.4.0",
     "@testing-library/user-event": "^14.5.2",
+    "@types/jscodeshift": "^0.11.11",
     "@types/react": "^18.2.47",
     "@vitejs/plugin-react": "latest",
     "@vitest/coverage-v8": "^1.1.3",
     "eslint": "^9.0.0",
     "globals": "^15.0.0",
+    "jscodeshift": "^17.0.0",
     "jsdom": "latest",
     "msw": "^2.0.12",
     "prettier": "^3.3.3",

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);
+}

package/src/qraftPredefinedParametersRequestFn.ts

@@ -7,9 +7,10 @@ import type {
 } from './lib/requestFn.js';
 import { shelfMerge } from './lib/shelfMerge.js';
 
-export type QraftPredefinedParameterValue<T> = T extends () => Promise<infer R>
-  ? R | undefined
-  : T | undefined;
+export type QraftPredefinedParameterValue<TValue> =
+  | TValue
+  | (() => Promise<TValue | undefined>)
+  | undefined;
 
 export type InputPredefinedParametersItem<TValue> = {
   requestPattern: string;
@@ -131,10 +132,18 @@ async function resolveQraftPredefinedParameters<T>(
   );
 }
 
-async function resolveQraftPredefinedParameterValue<T>(
-  value: QraftPredefinedParameterValue<T>
-): Promise<T | undefined> {
+type QraftPredefinedParameterResolvedValue<TData> = TData extends () => Promise<
+  infer TAsyncData
+>
+  ? TAsyncData
+  : TData;
+
+async function resolveQraftPredefinedParameterValue<TData>(
+  value: QraftPredefinedParameterValue<TData>
+): Promise<QraftPredefinedParameterResolvedValue<TData>> {
   if (value && typeof value === 'function')
-    return (await value()) as T | undefined;
-  return value as T | undefined;
+    return (await (
+      value as () => Promise<TData | undefined>
+    )()) as QraftPredefinedParameterResolvedValue<TData>;
+  return value as QraftPredefinedParameterResolvedValue<TData>;
 }

package/src/service-operation/ServiceOperationGetQueryState.ts

@@ -4,18 +4,23 @@ import type {
   ServiceOperationInfiniteQueryKey,
   ServiceOperationQueryKey,
 } from './ServiceOperationKey.js';
+import { AreAllOptional } from '../lib/AreAllOptional.js';
 
 export interface ServiceOperationGetQueryState<
   TSchema extends { url: string; method: string },
   TData,
-  TParams = {},
+  TParams,
   TError = DefaultError,
 > {
   getQueryState(
-    parameters: TParams | ServiceOperationQueryKey<TSchema, TParams>
+    parameters: AreAllOptional<TParams> extends true
+      ? TParams | ServiceOperationQueryKey<TSchema, TParams> | void
+      : TParams | ServiceOperationQueryKey<TSchema, TParams>
   ): QueryState<TData, TError> | undefined;
 
   getInfiniteQueryState(
-    parameters: TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>
+    parameters: AreAllOptional<TParams> extends true
+      ? TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams> | void
+      : TParams | ServiceOperationInfiniteQueryKey<TSchema, TParams>
   ): QueryState<OperationInfiniteData<TData, TParams>, TError> | undefined;
 }