@orval/query 6.21.0 → 6.22.1

package/dist/index.d.ts

@@ -1,13 +1,14 @@
-import { ClientDependenciesBuilder, ClientHeaderBuilder, ClientBuilder, QueryOptions } from '@orval/core';
+import { ClientDependenciesBuilder, ClientHeaderBuilder, ClientBuilder, QueryOptions, NormalizedOutputOptions } from '@orval/core';
 
 declare const getSvelteQueryDependencies: ClientDependenciesBuilder;
 declare const getReactQueryDependencies: ClientDependenciesBuilder;
 declare const getVueQueryDependencies: ClientDependenciesBuilder;
 declare const generateQueryHeader: ClientHeaderBuilder;
 declare const generateQuery: ClientBuilder;
-declare const builder: ({ type, options: queryOptions, }?: {
+declare const builder: ({ type, options: queryOptions, output, }?: {
     type?: "react-query" | "vue-query" | "svelte-query" | undefined;
     options?: QueryOptions | undefined;
+    output?: NormalizedOutputOptions | undefined;
 }) => () => {
     client: ClientBuilder;
     header: ClientHeaderBuilder;

package/dist/index.js

@@ -1665,6 +1665,8 @@ var vueUnRefParams = (props) => {
     return `${prop.name} = unref(${prop.name});`;
   }).join("\n");
 };
+var wrapRouteParameters = (route, prepend, append) => route.replaceAll(/\${(.+?)}/g, `\${${prepend}$1${append}}`);
+var makeRouteSafe = (route) => wrapRouteParameters(route, "encodeURIComponent(String(", "))");
 var isVue = (client) => import_core.OutputClient.VUE_QUERY === client;
 
 // src/index.ts
@@ -1732,7 +1734,8 @@ var SVELTE_QUERY_DEPENDENCIES = [
       { name: "MutationFunction" },
       { name: "CreateQueryResult" },
       { name: "CreateInfiniteQueryResult" },
-      { name: "QueryKey" }
+      { name: "QueryKey" },
+      { name: "InfiniteData" }
     ],
     dependency: "@tanstack/svelte-query"
   }
@@ -1829,7 +1832,10 @@ var VUE_QUERY_DEPENDENCIES_V3 = [
     dependency: "vue-query/types"
   },
   {
-    exports: [{ name: "unref", values: true }],
+    exports: [
+      { name: "unref", values: true },
+      { name: "computed", values: true }
+    ],
     dependency: "vue"
   },
   {
@@ -1850,17 +1856,18 @@ var VUE_QUERY_DEPENDENCIES = [
       { name: "MutationFunction" },
       { name: "QueryKey" },
       { name: "UseQueryReturnType" },
-      { name: "UseInfiniteQueryReturnType" }
+      { name: "UseInfiniteQueryReturnType" },
+      { name: "InfiniteData" }
     ],
     dependency: "@tanstack/vue-query"
   },
   {
-    exports: [{ name: "unref", values: true }],
+    exports: [
+      { name: "unref", values: true },
+      { name: "MaybeRef" },
+      { name: "computed", values: true }
+    ],
     dependency: "vue"
-  },
-  {
-    exports: [{ name: "MaybeRef" }],
-    dependency: "@tanstack/vue-query/build/lib/types"
   }
 ];
 var isVueQueryV3 = (packageJson) => {
@@ -1892,7 +1899,7 @@ var getPackageByQueryClient = (packageJson, queryClient) => {
       return (_c = (_a = packageJson == null ? void 0 : packageJson.dependencies) == null ? void 0 : _a["@tanstack/react-query"]) != null ? _c : (_b = packageJson == null ? void 0 : packageJson.devDependencies) == null ? void 0 : _b["@tanstack/react-query"];
     }
     case "svelte-query": {
-      return (_f = (_d = packageJson == null ? void 0 : packageJson.dependencies) == null ? void 0 : _d["@sveltestack/svelte-query"]) != null ? _f : (_e = packageJson == null ? void 0 : packageJson.devDependencies) == null ? void 0 : _e["@sveltestack/svelte-query"];
+      return (_f = (_d = packageJson == null ? void 0 : packageJson.dependencies) == null ? void 0 : _d["@tanstack/svelte-query"]) != null ? _f : (_e = packageJson == null ? void 0 : packageJson.devDependencies) == null ? void 0 : _e["@tanstack/svelte-query"];
     }
     case "vue-query": {
       return (_i = (_g = packageJson == null ? void 0 : packageJson.dependencies) == null ? void 0 : _g["@tanstack/vue-query"]) != null ? _i : (_h = packageJson == null ? void 0 : packageJson.devDependencies) == null ? void 0 : _h["@tanstack/vue-query"];
@@ -1921,12 +1928,16 @@ var generateQueryRequestFunction = ({
   formUrlEncoded,
   paramsSerializer,
   override
-}, { route, context }, outputClient) => {
+}, { route: _route, context }, outputClient, output) => {
   var _a, _b;
   let props = _props;
+  let route = _route;
   if (isVue(outputClient)) {
     props = vueWrapTypeWithMaybeRef(_props);
   }
+  if (output == null ? void 0 : output.urlEncodeParameters) {
+    route = makeRouteSafe(route);
+  }
   const isRequestOptions = override.requestOptions !== false;
   const isFormData = override.formData !== false;
   const isFormUrlEncoded = override.formUrlEncoded !== false;
@@ -1955,7 +1966,8 @@ var generateQueryRequestFunction = ({
       isFormUrlEncoded,
       isBodyVerb,
       hasSignal,
-      isExactOptionalPropertyTypes
+      isExactOptionalPropertyTypes,
+      isVue: isVue(outputClient)
     });
     let bodyDefinition = body.definition.replace("[]", "\\[\\]");
     let propsImplementation = (mutator == null ? void 0 : mutator.bodyTypeName) && body.definition ? (0, import_core2.toObjectString)(props, "implementation").replace(
@@ -2004,7 +2016,8 @@ var generateQueryRequestFunction = ({
     paramsSerializer,
     paramsSerializerOptions: override == null ? void 0 : override.paramsSerializerOptions,
     isExactOptionalPropertyTypes,
-    hasSignal
+    hasSignal,
+    isVue: isVue(outputClient)
   });
   const optionsArgs = generateRequestOptionsArguments({
     isRequestOptions,
@@ -2028,7 +2041,8 @@ var INFINITE_QUERY_PROPERTIES = ["getNextPageParam", "getPreviousPageParam"];
 var generateQueryOptions = ({
   params,
   options,
-  type
+  type,
+  outputClient
 }) => {
   var _a;
   if (options === false) {
@@ -2046,7 +2060,7 @@ var generateQueryOptions = ({
     }
     return "...queryOptions";
   }
-  return `${!(0, import_core2.isObject)(options) || !options.hasOwnProperty("enabled") ? `enabled: !!(${params.map(({ name }) => name).join(" && ")}),` : ""}${queryConfig} ...queryOptions`;
+  return `${!(0, import_core2.isObject)(options) || !options.hasOwnProperty("enabled") ? isVue(outputClient) ? `enabled: computed(() => !!(${params.map(({ name }) => `unref(${name})`).join(" && ")})),` : `enabled: !!(${params.map(({ name }) => name).join(" && ")}),` : ""}${queryConfig} ...queryOptions`;
 };
 var getQueryArgumentsRequestType = (mutator) => {
   if (!mutator) {
@@ -2080,7 +2094,7 @@ var getQueryOptionsDefinition = ({
       type
     )}Options<${funcReturnType}, TError, TData${hasQueryV5 && (type === QueryType.INFINITE || type === QueryType.SUSPENSE_INFINITE) && queryParam && queryParams ? `, ${funcReturnType}, QueryKey, ${queryParams == null ? void 0 : queryParams.schema.name}['${queryParam}']` : ""}>${partialOptions ? ">" : ""}`;
   }
-  return `${prefix}MutationOptions<Awaited<ReturnType<${isMutatorHook ? `ReturnType<typeof use${(0, import_core2.pascal)(operationName)}Hook>` : `typeof ${operationName}`}>>, TError,${definitions ? `{${definitions}}` : "TVariables"}, TContext>`;
+  return `${prefix}MutationOptions<Awaited<ReturnType<${isMutatorHook ? `ReturnType<typeof use${(0, import_core2.pascal)(operationName)}Hook>` : `typeof ${operationName}`}>>, TError,${definitions ? `{${definitions}}` : "void"}, TContext>`;
 };
 var generateQueryArguments = ({
   operationName,
@@ -2285,7 +2299,8 @@ var generateQueryImplementation = ({
   const queryOptionsImp = generateQueryOptions({
     params,
     options,
-    type
+    type,
+    outputClient
   });
   const queryOptionsFnName = (0, import_core2.camel)(
     queryKeyMutator || queryOptionsMutator || (mutator == null ? void 0 : mutator.isHook) ? `use-${name}-queryOptions` : `get-${name}-queryOptions`
@@ -2386,7 +2401,7 @@ var generateQueryHook = async ({
   const doc = (0, import_core2.jsDoc)({ summary, deprecated });
   let implementation = "";
   let mutators = void 0;
-  const isQuery = import_core2.Verbs.GET === verb && (override.query.useQuery || override.query.useInfinite) || (operationQueryOptions == null ? void 0 : operationQueryOptions.useInfinite) || (operationQueryOptions == null ? void 0 : operationQueryOptions.useQuery);
+  const isQuery = import_core2.Verbs.GET === verb && (override.query.useQuery || override.query.useSuspenseQuery || override.query.useInfinite || override.query.useSuspenseInfiniteQuery) || (operationQueryOptions == null ? void 0 : operationQueryOptions.useInfinite) || (operationQueryOptions == null ? void 0 : operationQueryOptions.useSuspenseInfiniteQuery) || (operationQueryOptions == null ? void 0 : operationQueryOptions.useQuery) || (operationQueryOptions == null ? void 0 : operationQueryOptions.useSuspenseQuery);
   if (isQuery) {
     const queryKeyMutator = query.queryKey ? await (0, import_core2.generateMutator)({
       output,
@@ -2421,7 +2436,7 @@ var generateQueryHook = async ({
           queryParam: query == null ? void 0 : query.useInfiniteQueryParam
         }
       ] : [],
-      ...!(query == null ? void 0 : query.useQuery) && !(query == null ? void 0 : query.useInfinite) || (query == null ? void 0 : query.useQuery) ? [
+      ...(query == null ? void 0 : query.useQuery) ? [
         {
           name: operationName,
           options: query == null ? void 0 : query.options,
@@ -2449,9 +2464,8 @@ var generateQueryHook = async ({
       props.filter((prop) => prop.type !== import_core2.GetterPropType.HEADER),
       "implementation"
     );
-    const routeString = `\`${route}\``;
+    const routeString = isVue(outputClient) ? (0, import_core2.getRouteAsArray)(route) : `\`${route}\``;
     const queryKeyFn = `export const ${queryKeyFnName} = (${queryKeyProps}) => {
-    ${isVue(outputClient) ? vueUnRefParams(props) : ""}
     return [${routeString}${queryParams ? ", ...(params ? [params]: [])" : ""}${body.implementation ? `, ${body.implementation}` : ""}] as const;
     }`;
     implementation += `${!queryKeyMutator ? queryKeyFn : ""}
@@ -2528,14 +2542,13 @@ var generateQueryHook = async ({
     );
     const mutationOptionsVarName = isRequestOptions ? "mutationOptions" : "options";
     const mutationOptionsFn = `export const ${mutationOptionsFnName} = <TError = ${errorType},
-    ${!definitions ? `TVariables = void,` : ""}
     TContext = unknown>(${mutationArguments}): ${mutationOptionFnReturnType} => {
  ${isRequestOptions ? `const {mutation: mutationOptions${!mutator ? `, axios: axiosOptions` : (mutator == null ? void 0 : mutator.hasSecondArg) ? ", request: requestOptions" : ""}} = options ?? {};` : ""}
 
       ${(mutator == null ? void 0 : mutator.isHook) ? `const ${operationName} =  use${(0, import_core2.pascal)(operationName)}Hook()` : ""}
 
 
-      const mutationFn: MutationFunction<Awaited<ReturnType<${dataType}>>, ${definitions ? `{${definitions}}` : "TVariables"}> = (${properties ? "props" : ""}) => {
+      const mutationFn: MutationFunction<Awaited<ReturnType<${dataType}>>, ${definitions ? `{${definitions}}` : "void"}> = (${properties ? "props" : ""}) => {
           ${properties ? `const {${properties}} = props ?? {};` : ""}
 
           return  ${operationName}(${properties}${properties ? "," : ""}${isRequestOptions ? !mutator ? `axiosOptions` : (mutator == null ? void 0 : mutator.hasSecondArg) ? "requestOptions" : "" : ""})
@@ -2558,7 +2571,6 @@ ${mutationOptionsFn}
     ${doc}export const ${(0, import_core2.camel)(
       `${operationPrefix}-${operationName}`
     )} = <TError = ${errorType},
-    ${!definitions ? `TVariables = void,` : ""}
     TContext = unknown>(${mutationArguments}) => {
 
       const ${mutationOptionsVarName} = ${mutationOptionsFnName}(${isRequestOptions ? "options" : "mutationOptions"});
@@ -2594,12 +2606,13 @@ ${isRequestOptions && isMutator ? `// eslint-disable-next-line
 ` : ""}
 `;
 };
-var generateQuery = async (verbOptions, options, outputClient) => {
+var generateQuery = async (verbOptions, options, outputClient, output) => {
   const imports = (0, import_core2.generateVerbImports)(verbOptions);
   const functionImplementation = generateQueryRequestFunction(
     verbOptions,
     options,
-    outputClient
+    outputClient,
+    output
   );
   const { implementation: hookImplementation, mutators } = await generateQueryHook(verbOptions, options, outputClient);
   return {
@@ -2617,9 +2630,15 @@ var dependenciesBuilder = {
 };
 var builder = ({
   type = "react-query",
-  options: queryOptions
+  options: queryOptions,
+  output
 } = {}) => () => {
   const client = (verbOptions, options, outputClient) => {
+    if (options.override.useNamedParameters && (type === "vue-query" || outputClient === "vue-query")) {
+      throw new Error(
+        `vue-query client does not support named parameters, and had broken reactivity previously, please set useNamedParameters to false; See for context: https://github.com/anymaniax/orval/pull/931#issuecomment-1752355686`
+      );
+    }
     if (queryOptions) {
       const normalizedQueryOptions = normalizeQueryOptions(
         queryOptions,
@@ -2634,7 +2653,7 @@ var builder = ({
         verbOptions.override.query
       );
     }
-    return generateQuery(verbOptions, options, outputClient);
+    return generateQuery(verbOptions, options, outputClient, output);
   };
   return {
     client,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orval/query",
-  "version": "6.21.0",
+  "version": "6.22.1",
   "license": "MIT",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -10,11 +10,13 @@
   "scripts": {
     "build": "tsup ./src/index.ts --target node12 --clean --dts",
     "dev": "tsup ./src/index.ts --target node12 --clean --watch src",
-    "lint": "eslint src/**/*.ts"
+    "lint": "eslint src/**/*.ts",
+    "test": "vitest"
   },
   "dependencies": {
-    "@orval/core": "6.21.0",
-    "lodash.omitby": "^4.6.0"
+    "@orval/core": "6.22.1",
+    "lodash.omitby": "^4.6.0",
+    "vitest": "^0.34.6"
   },
   "devDependencies": {
     "@types/lodash.omitby": "^4.6.7"