@orval/swr 6.19.1 → 6.21.0

package/dist/index.js

@@ -1,50 +1,291 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _core = require('@orval/core');var _=[{exports:[{name:"axios",default:!0,values:!0,syntheticDefaultImport:!0},{name:"AxiosRequestConfig"},{name:"AxiosResponse"},{name:"AxiosError"}],dependency:"axios"}],N=[{exports:[{name:"useSwr",values:!0,default:!0},{name:"SWRConfiguration"},{name:"Key"}],dependency:"swr"}],V= exports.getSwrDependencies =e=>[...e?[]:_,...N],j=({headers:e,queryParams:s,operationName:i,response:o,mutator:r,body:n,props:a,verb:c,formData:f,formUrlEncoded:m,override:t},{route:w,context:$})=>{var E,S;let y=(t==null?void 0:t.requestOptions)!==!1,l=(t==null?void 0:t.formData)!==!1,u=(t==null?void 0:t.formUrlEncoded)!==!1,g=!!((S=(E=$.tsconfig)==null?void 0:E.compilerOptions)!=null&&S.exactOptionalPropertyTypes),x=_core.VERBS_WITH_BODY.includes(c),p=_core.isSyntheticDefaultImportsAllow.call(void 0, $.tsconfig),A=_core.generateFormDataAndUrlEncodedFunction.call(void 0, {formData:f,formUrlEncoded:m,body:n,isFormData:l,isFormUrlEncoded:u});if(r){let R=_core.generateMutatorConfig.call(void 0, {route:w,body:n,headers:e,queryParams:s,response:o,verb:c,isFormData:l,isFormUrlEncoded:u,hasSignal:!1,isBodyVerb:x,isExactOptionalPropertyTypes:g}),G=(r==null?void 0:r.bodyTypeName)&&n.definition?_core.toObjectString.call(void 0, a,"implementation").replace(new RegExp(`(\\w*):\\s?${n.definition}`),`$1: ${r.bodyTypeName}<${n.definition}>`):_core.toObjectString.call(void 0, a,"implementation"),q=y?_core.generateMutatorRequestOptions.call(void 0, t==null?void 0:t.requestOptions,r.hasSecondArg):"";return`export const ${i} = (
-    ${G}
- ${y&&r.hasSecondArg?`options?: SecondParameter<typeof ${r.name}>`:""}) => {${A}
-      return ${r.name}<${o.definition.success||"unknown"}>(
-      ${R},
-      ${q});
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  builder: () => builder,
+  default: () => src_default,
+  generateSwr: () => generateSwr,
+  generateSwrHeader: () => generateSwrHeader,
+  getSwrDependencies: () => getSwrDependencies
+});
+module.exports = __toCommonJS(src_exports);
+var import_core = require("@orval/core");
+var AXIOS_DEPENDENCIES = [
+  {
+    exports: [
+      {
+        name: "axios",
+        default: true,
+        values: true,
+        syntheticDefaultImport: true
+      },
+      { name: "AxiosRequestConfig" },
+      { name: "AxiosResponse" },
+      { name: "AxiosError" }
+    ],
+    dependency: "axios"
+  }
+];
+var PARAMS_SERIALIZER_DEPENDENCIES = [
+  {
+    exports: [
+      {
+        name: "qs",
+        default: true,
+        values: true,
+        syntheticDefaultImport: true
+      }
+    ],
+    dependency: "qs"
+  }
+];
+var SWR_DEPENDENCIES = [
+  {
+    exports: [
+      { name: "useSwr", values: true, default: true },
+      { name: "SWRConfiguration" },
+      { name: "Key" }
+    ],
+    dependency: "swr"
+  }
+];
+var getSwrDependencies = (hasGlobalMutator, hasParamsSerializerOptions) => [
+  ...!hasGlobalMutator ? AXIOS_DEPENDENCIES : [],
+  ...hasParamsSerializerOptions ? PARAMS_SERIALIZER_DEPENDENCIES : [],
+  ...SWR_DEPENDENCIES
+];
+var generateSwrRequestFunction = ({
+  headers,
+  queryParams,
+  operationName,
+  response,
+  mutator,
+  body,
+  props,
+  verb,
+  formData,
+  formUrlEncoded,
+  override,
+  paramsSerializer
+}, { route, context }) => {
+  var _a, _b;
+  const isRequestOptions = (override == null ? void 0 : override.requestOptions) !== false;
+  const isFormData = (override == null ? void 0 : override.formData) !== false;
+  const isFormUrlEncoded = (override == null ? void 0 : override.formUrlEncoded) !== false;
+  const isExactOptionalPropertyTypes = !!((_b = (_a = context.tsconfig) == null ? void 0 : _a.compilerOptions) == null ? void 0 : _b.exactOptionalPropertyTypes);
+  const isBodyVerb = import_core.VERBS_WITH_BODY.includes(verb);
+  const isSyntheticDefaultImportsAllowed = (0, import_core.isSyntheticDefaultImportsAllow)(
+    context.tsconfig
+  );
+  const bodyForm = (0, import_core.generateFormDataAndUrlEncodedFunction)({
+    formData,
+    formUrlEncoded,
+    body,
+    isFormData,
+    isFormUrlEncoded
+  });
+  if (mutator) {
+    const mutatorConfig = (0, import_core.generateMutatorConfig)({
+      route,
+      body,
+      headers,
+      queryParams,
+      response,
+      verb,
+      isFormData,
+      isFormUrlEncoded,
+      hasSignal: false,
+      isBodyVerb,
+      isExactOptionalPropertyTypes
+    });
+    const propsImplementation = (mutator == null ? void 0 : mutator.bodyTypeName) && body.definition ? (0, import_core.toObjectString)(props, "implementation").replace(
+      new RegExp(`(\\w*):\\s?${body.definition}`),
+      `$1: ${mutator.bodyTypeName}<${body.definition}>`
+    ) : (0, import_core.toObjectString)(props, "implementation");
+    const requestOptions = isRequestOptions ? (0, import_core.generateMutatorRequestOptions)(
+      override == null ? void 0 : override.requestOptions,
+      mutator.hasSecondArg
+    ) : "";
+    return `export const ${operationName} = (
+    ${propsImplementation}
+ ${isRequestOptions && mutator.hasSecondArg ? `options?: SecondParameter<typeof ${mutator.name}>` : ""}) => {${bodyForm}
+      return ${mutator.name}<${response.definition.success || "unknown"}>(
+      ${mutatorConfig},
+      ${requestOptions});
     }
-  `}let D=_core.generateOptions.call(void 0, {route:w,body:n,headers:e,queryParams:s,response:o,verb:c,requestOptions:t==null?void 0:t.requestOptions,isFormData:l,isFormUrlEncoded:u,isExactOptionalPropertyTypes:g,hasSignal:!1});return`export const ${i} = (
-    ${_core.toObjectString.call(void 0, a,"implementation")} ${y?`options?: AxiosRequestConfig
-`:""} ): Promise<AxiosResponse<${o.definition.success||"unknown"}>> => {${A}
-    return axios${p?"":".default"}.${c}(${D});
-  }
-`},W=({operationName:e,mutator:s,isRequestOptions:i})=>{let o=`SWRConfiguration<Awaited<ReturnType<typeof ${e}>>, TError> & { swrKey?: Key, enabled?: boolean }`;return i?`options?: { swr?:${o}, ${s?s!=null&&s.hasSecondArg?`request?: SecondParameter<typeof ${s.name}>`:"":"axios?: AxiosRequestConfig"} }
-`:`swrOptions?: ${o}`},U=({operationName:e,swrKeyFnName:s,swrProperties:i,swrKeyProperties:o,params:r,mutator:n,isRequestOptions:a,response:c,swrOptions:f,props:m,doc:t})=>{var u;let w=_core.toObjectString.call(void 0, m,"implementation"),$=i,y=`const isEnabled = swrOptions?.enabled !== false${r.length?` && !!(${r.map(({name:g})=>g).join(" && ")})`:""}
-    const swrKey = swrOptions?.swrKey ?? (() => isEnabled ? ${s}(${o}) : null);`,l=`AxiosError<${c.definition.errors||"unknown"}>`;return n&&(l=n.hasErrorType?`ErrorType<${c.definition.errors||"unknown"}>`:c.definition.errors||"unknown"),`
-export type ${_core.pascal.call(void 0, e)}QueryResult = NonNullable<Awaited<ReturnType<typeof ${e}>>>
-export type ${_core.pascal.call(void 0, e)}QueryError = ${l}
-
-${t}export const ${_core.camel.call(void 0, `use-${e}`)} = <TError = ${l}>(
- ${w} ${W({operationName:e,mutator:n,isRequestOptions:a})}
+  `;
+  }
+  const options = (0, import_core.generateOptions)({
+    route,
+    body,
+    headers,
+    queryParams,
+    response,
+    verb,
+    requestOptions: override == null ? void 0 : override.requestOptions,
+    isFormData,
+    isFormUrlEncoded,
+    paramsSerializer,
+    paramsSerializerOptions: override == null ? void 0 : override.paramsSerializerOptions,
+    isExactOptionalPropertyTypes,
+    hasSignal: false
+  });
+  return `export const ${operationName} = (
+    ${(0, import_core.toObjectString)(
+    props,
+    "implementation"
+  )} ${isRequestOptions ? `options?: AxiosRequestConfig
+` : ""} ): Promise<AxiosResponse<${response.definition.success || "unknown"}>> => {${bodyForm}
+    return axios${!isSyntheticDefaultImportsAllowed ? ".default" : ""}.${verb}(${options});
+  }
+`;
+};
+var generateSwrArguments = ({
+  operationName,
+  mutator,
+  isRequestOptions
+}) => {
+  const definition = `SWRConfiguration<Awaited<ReturnType<typeof ${operationName}>>, TError> & { swrKey?: Key, enabled?: boolean }`;
+  if (!isRequestOptions) {
+    return `swrOptions?: ${definition}`;
+  }
+  return `options?: { swr?:${definition}, ${!mutator ? `axios?: AxiosRequestConfig` : (mutator == null ? void 0 : mutator.hasSecondArg) ? `request?: SecondParameter<typeof ${mutator.name}>` : ""} }
+`;
+};
+var generateSwrImplementation = ({
+  operationName,
+  swrKeyFnName,
+  swrProperties,
+  swrKeyProperties,
+  params,
+  mutator,
+  isRequestOptions,
+  response,
+  swrOptions,
+  props,
+  doc
+}) => {
+  var _a;
+  const swrProps = (0, import_core.toObjectString)(props, "implementation");
+  const httpFunctionProps = swrProperties;
+  const swrKeyImplementation = `const isEnabled = swrOptions?.enabled !== false${params.length ? ` && !!(${params.map(({ name }) => name).join(" && ")})` : ""}
+    const swrKey = swrOptions?.swrKey ?? (() => isEnabled ? ${swrKeyFnName}(${swrKeyProperties}) : null);`;
+  let errorType = `AxiosError<${response.definition.errors || "unknown"}>`;
+  if (mutator) {
+    errorType = mutator.hasErrorType ? `ErrorType<${response.definition.errors || "unknown"}>` : response.definition.errors || "unknown";
+  }
+  return `
+export type ${(0, import_core.pascal)(
+    operationName
+  )}QueryResult = NonNullable<Awaited<ReturnType<typeof ${operationName}>>>
+export type ${(0, import_core.pascal)(operationName)}QueryError = ${errorType}
+
+${doc}export const ${(0, import_core.camel)(
+    `use-${operationName}`
+  )} = <TError = ${errorType}>(
+ ${swrProps} ${generateSwrArguments({
+    operationName,
+    mutator,
+    isRequestOptions
+  })}
   ) => {
 
-  ${a?`const {swr: swrOptions${n?n!=null&&n.hasSecondArg?", request: requestOptions":"":", axios: axiosOptions"}} = options ?? {}`:""}
+  ${isRequestOptions ? `const {swr: swrOptions${!mutator ? `, axios: axiosOptions` : (mutator == null ? void 0 : mutator.hasSecondArg) ? ", request: requestOptions" : ""}} = options ?? {}` : ""}
 
-  ${y}
-  const swrFn = () => ${e}(${$}${$?", ":""}${a?n?n!=null&&n.hasSecondArg?"requestOptions":"":"axiosOptions":""});
+  ${swrKeyImplementation}
+  const swrFn = () => ${operationName}(${httpFunctionProps}${httpFunctionProps ? ", " : ""}${isRequestOptions ? !mutator ? `axiosOptions` : (mutator == null ? void 0 : mutator.hasSecondArg) ? "requestOptions" : "" : ""});
 
-  const query = useSwr<Awaited<ReturnType<typeof swrFn>>, TError>(swrKey, swrFn, ${f.options?`{
-    ${(u=_core.stringify.call(void 0, f.options))==null?void 0:u.slice(1,-1)}
+  const query = useSwr<Awaited<ReturnType<typeof swrFn>>, TError>(swrKey, swrFn, ${swrOptions.options ? `{
+    ${(_a = (0, import_core.stringify)(swrOptions.options)) == null ? void 0 : _a.slice(1, -1)}
     ...swrOptions
-  }`:"swrOptions"})
+  }` : "swrOptions"})
 
   return {
     swrKey,
     ...query
   }
 }
-`},Y=({queryParams:e,operationName:s,body:i,props:o,verb:r,params:n,override:a,mutator:c,response:f,summary:m,deprecated:t},{route:w})=>{let $=(a==null?void 0:a.requestOptions)!==!1;if(r!==_core.Verbs.GET)return"";let y=o.map(p=>p.type===_core.GetterPropType.NAMED_PATH_PARAMS?p.destructured:p.type===_core.GetterPropType.BODY?i.implementation:p.name).join(","),l=o.filter(p=>p.type!==_core.GetterPropType.HEADER).map(p=>p.type===_core.GetterPropType.NAMED_PATH_PARAMS?p.destructured:p.type===_core.GetterPropType.BODY?i.implementation:p.name).join(","),u=_core.camel.call(void 0, `get-${s}-key`),g=_core.toObjectString.call(void 0, o.filter(p=>p.type!==_core.GetterPropType.HEADER),"implementation"),x=_core.jsDoc.call(void 0, {summary:m,deprecated:t});return`export const ${u} = (${g}) => [\`${w}\`${e?", ...(params ? [params]: [])":""}${i.implementation?`, ${i.implementation}`:""}] as const;
+`;
+};
+var generateSwrHook = ({
+  queryParams,
+  operationName,
+  body,
+  props,
+  verb,
+  params,
+  override,
+  mutator,
+  response,
+  summary,
+  deprecated
+}, { route }) => {
+  const isRequestOptions = (override == null ? void 0 : override.requestOptions) !== false;
+  if (verb !== import_core.Verbs.GET) {
+    return "";
+  }
+  const swrProperties = props.map((param) => {
+    if (param.type === import_core.GetterPropType.NAMED_PATH_PARAMS)
+      return param.destructured;
+    return param.type === import_core.GetterPropType.BODY ? body.implementation : param.name;
+  }).join(",");
+  const swrKeyProperties = props.filter((prop) => prop.type !== import_core.GetterPropType.HEADER).map((param) => {
+    if (param.type === import_core.GetterPropType.NAMED_PATH_PARAMS)
+      return param.destructured;
+    return param.type === import_core.GetterPropType.BODY ? body.implementation : param.name;
+  }).join(",");
+  const swrKeyFnName = (0, import_core.camel)(`get-${operationName}-key`);
+  const queryKeyProps = (0, import_core.toObjectString)(
+    props.filter((prop) => prop.type !== import_core.GetterPropType.HEADER),
+    "implementation"
+  );
+  const doc = (0, import_core.jsDoc)({ summary, deprecated });
+  return `export const ${swrKeyFnName} = (${queryKeyProps}) => [\`${route}\`${queryParams ? ", ...(params ? [params]: [])" : ""}${body.implementation ? `, ${body.implementation}` : ""}] as const;
 
-    ${U({operationName:s,swrKeyFnName:u,swrProperties:y,swrKeyProperties:l,params:n,props:o,mutator:c,isRequestOptions:$,response:f,swrOptions:a.swr,doc:x})}
-`},Q= exports.generateSwrHeader =({isRequestOptions:e,isMutator:s,hasAwaitedType:i})=>`
-  ${i?"":`type AwaitedInput<T> = PromiseLike<T> | T;
+    ${generateSwrImplementation({
+    operationName,
+    swrKeyFnName,
+    swrProperties,
+    swrKeyProperties,
+    params,
+    props,
+    mutator,
+    isRequestOptions,
+    response,
+    swrOptions: override.swr,
+    doc
+  })}
+`;
+};
+var generateSwrHeader = ({
+  isRequestOptions,
+  isMutator,
+  hasAwaitedType
+}) => `
+  ${!hasAwaitedType ? `type AwaitedInput<T> = PromiseLike<T> | T;
 
       type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;
 
-`}
-  ${e&&s?`// eslint-disable-next-line
+` : ""}
+  ${isRequestOptions && isMutator ? `// eslint-disable-next-line
   type SecondParameter<T extends (...args: any) => any> = T extends (
   config: any,
   args: infer P,
@@ -52,6 +293,32 @@ ${t}export const ${_core.camel.call(void 0, `use-${e}`)} = <TError = ${l}>(
   ? P
   : never;
 
-`:""}`,L= exports.generateSwr =(e,s)=>{let i=_core.generateVerbImports.call(void 0, e),o=j(e,s),r=Y(e,s);return{implementation:`${o}
+` : ""}`;
+var generateSwr = (verbOptions, options) => {
+  const imports = (0, import_core.generateVerbImports)(verbOptions);
+  const functionImplementation = generateSwrRequestFunction(
+    verbOptions,
+    options
+  );
+  const hookImplementation = generateSwrHook(verbOptions, options);
+  return {
+    implementation: `${functionImplementation}
 
-${r}`,imports:i}},X={client:L,header:Q,dependencies:V},z= exports.builder =()=>()=>X,ce= exports.default =z;exports.builder = z; exports.default = ce; exports.generateSwr = L; exports.generateSwrHeader = Q; exports.getSwrDependencies = V;
+${hookImplementation}`,
+    imports
+  };
+};
+var swrClientBuilder = {
+  client: generateSwr,
+  header: generateSwrHeader,
+  dependencies: getSwrDependencies
+};
+var builder = () => () => swrClientBuilder;
+var src_default = builder;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  builder,
+  generateSwr,
+  generateSwrHeader,
+  getSwrDependencies
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orval/swr",
-  "version": "6.19.1",
+  "version": "6.21.0",
   "license": "MIT",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -8,11 +8,11 @@
     "dist"
   ],
   "scripts": {
-    "build": "tsup ./src/index.ts --target node12 --minify --clean --dts --splitting",
+    "build": "tsup ./src/index.ts --target node12 --clean --dts",
     "dev": "tsup ./src/index.ts --target node12 --clean --watch src",
     "lint": "eslint src/**/*.ts"
   },
   "dependencies": {
-    "@orval/core": "6.19.1"
+    "@orval/core": "6.21.0"
   }
 }