@orval/query 6.11.0-alpha → 6.11.0-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +3 -3
- package/dist/index.js +24 -24
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -7,8 +7,8 @@ declare const generateQueryTitle: ClientTitleBuilder;
|
|
|
7
7
|
declare const generateQueryHeader: ClientHeaderBuilder;
|
|
8
8
|
declare const generateQueryFooter: ClientFooterBuilder;
|
|
9
9
|
declare const generateQuery: ClientBuilder;
|
|
10
|
-
declare const builder: ({ type, }
|
|
11
|
-
type
|
|
12
|
-
}) => ClientGeneratorsBuilder;
|
|
10
|
+
declare const builder: ({ type, }?: {
|
|
11
|
+
type?: "react-query" | "vue-query" | "svelte-query" | undefined;
|
|
12
|
+
}) => () => ClientGeneratorsBuilder;
|
|
13
13
|
|
|
14
14
|
export { builder, builder as default, generateQuery, generateQueryFooter, generateQueryHeader, generateQueryTitle, getReactQueryDependencies, getSvelteQueryDependencies, getVueQueryDependencies };
|
package/dist/index.js
CHANGED
|
@@ -1,31 +1,31 @@
|
|
|
1
|
-
"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }var _core = require('@orval/core');var _lodashomitby = require('lodash.omitby'); var _lodashomitby2 = _interopRequireDefault(_lodashomitby);var
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }var _core = require('@orval/core');var _lodashomitby = require('lodash.omitby'); var _lodashomitby2 = _interopRequireDefault(_lodashomitby);var w=[{exports:[{name:"axios",default:!0,values:!0,syntheticDefaultImport:!0},{name:"AxiosRequestConfig"},{name:"AxiosResponse"},{name:"AxiosError"}],dependency:"axios"}],ne=[{exports:[{name:"useQuery",values:!0},{name:"useInfiniteQuery",values:!0},{name:"useMutation",values:!0},{name:"UseQueryOptions"},{name:"UseInfiniteQueryOptions"},{name:"UseMutationOptions"},{name:"QueryFunction"},{name:"MutationFunction"},{name:"UseQueryStoreResult"},{name:"UseInfiniteQueryStoreResult"},{name:"QueryKey"}],dependency:"@sveltestack/svelte-query"}],te= exports.getSvelteQueryDependencies =n=>[...n?[]:w,...ne],re=[{exports:[{name:"useQuery",values:!0},{name:"useInfiniteQuery",values:!0},{name:"useMutation",values:!0},{name:"UseQueryOptions"},{name:"UseInfiniteQueryOptions"},{name:"UseMutationOptions"},{name:"QueryFunction"},{name:"MutationFunction"},{name:"UseQueryResult"},{name:"UseInfiniteQueryResult"},{name:"QueryKey"}],dependency:"react-query"}],se=[{exports:[{name:"useQuery",values:!0},{name:"useInfiniteQuery",values:!0},{name:"useMutation",values:!0},{name:"UseQueryOptions"},{name:"UseInfiniteQueryOptions"},{name:"UseMutationOptions"},{name:"QueryFunction"},{name:"MutationFunction"},{name:"UseQueryResult"},{name:"UseInfiniteQueryResult"},{name:"QueryKey"}],dependency:"@tanstack/react-query"}],ie= exports.getReactQueryDependencies =(n,e)=>{var t,y,a,s,f,Q;let r=(a=(t=e==null?void 0:e.dependencies)==null?void 0:t["react-query"])!=null?a:(y=e==null?void 0:e.devDependencies)==null?void 0:y["react-query"],i=(Q=(s=e==null?void 0:e.dependencies)==null?void 0:s["@tanstack/react-query"])!=null?Q:(f=e==null?void 0:e.devDependencies)==null?void 0:f["@tanstack/react-query"];return[...n?[]:w,...r&&!i?re:se]},oe=[{exports:[{name:"useQuery",values:!0},{name:"useInfiniteQuery",values:!0},{name:"useMutation",values:!0}],dependency:"vue-query"},{exports:[{name:"UseQueryOptions"},{name:"UseInfiniteQueryOptions"},{name:"UseMutationOptions"},{name:"QueryFunction"},{name:"MutationFunction"},{name:"UseQueryResult"},{name:"UseInfiniteQueryResult"},{name:"QueryKey"}],dependency:"vue-query/types"},{exports:[{name:"UseQueryReturnType"}],dependency:"vue-query/lib/vue/useBaseQuery"}],ue= exports.getVueQueryDependencies =n=>[...n?[]:w,...oe],ye=({isRequestOptions:n,hasSignal:e})=>n?`options?: AxiosRequestConfig
|
|
2
2
|
`:e?`signal?: AbortSignal
|
|
3
|
-
`:"",pe=({headers:n,queryParams:e,operationName:
|
|
4
|
-
const ${
|
|
3
|
+
`:"",pe=({headers:n,queryParams:e,operationName:r,response:i,mutator:t,body:y,props:a,verb:s,formData:f,formUrlEncoded:Q,override:o},{route:q,context:R})=>{var A,C;let g=o.requestOptions!==!1,u=o.formData!==!1,T=o.formUrlEncoded!==!1,l=!!o.query.signal,I=_core.isSyntheticDefaultImportsAllow.call(void 0, R.tsconfig),d=!!((C=(A=R.tsconfig)==null?void 0:A.compilerOptions)!=null&&C.exactOptionalPropertyTypes),c=_core.VERBS_WITH_BODY.includes(s),O=_core.generateFormDataAndUrlEncodedFunction.call(void 0, {formData:f,formUrlEncoded:Q,body:y,isFormData:u,isFormUrlEncoded:T});if(t){let $=_core.generateMutatorConfig.call(void 0, {route:q,body:y,headers:n,queryParams:e,response:i,verb:s,isFormData:u,isFormUrlEncoded:T,isBodyVerb:c,hasSignal:l,isExactOptionalPropertyTypes:d}),x=(t==null?void 0:t.bodyTypeName)&&y.definition?_core.toObjectString.call(void 0, a,"implementation").replace(new RegExp(`(\\w*):\\s?${y.definition}`),`$1: ${t.bodyTypeName}<${y.definition}>`):_core.toObjectString.call(void 0, a,"implementation"),H=g?_core.generateMutatorRequestOptions.call(void 0, o.requestOptions,t.hasSecondArg):"";return t.isHook?`export const use${_core.pascal.call(void 0, r)}Hook = () => {
|
|
4
|
+
const ${r} = ${t.name}<${i.definition.success||"unknown"}>();
|
|
5
5
|
|
|
6
6
|
return (
|
|
7
7
|
${x}
|
|
8
8
|
${g&&t.hasSecondArg?`options?: SecondParameter<ReturnType<typeof ${t.name}>>,`:""}${!c&&l?`signal?: AbortSignal
|
|
9
9
|
`:""}) => {${O}
|
|
10
|
-
return ${
|
|
10
|
+
return ${r}(
|
|
11
11
|
${$},
|
|
12
|
-
${
|
|
12
|
+
${H});
|
|
13
13
|
}
|
|
14
14
|
}
|
|
15
|
-
`:`export const ${
|
|
15
|
+
`:`export const ${r} = (
|
|
16
16
|
${x}
|
|
17
17
|
${g&&t.hasSecondArg?`options?: SecondParameter<typeof ${t.name}>,`:""}${!c&&l?`signal?: AbortSignal
|
|
18
18
|
`:""}) => {${O}
|
|
19
19
|
return ${t.name}<${i.definition.success||"unknown"}>(
|
|
20
20
|
${$},
|
|
21
|
-
${
|
|
21
|
+
${H});
|
|
22
22
|
}
|
|
23
|
-
`}let P=_core.generateOptions.call(void 0, {route:
|
|
23
|
+
`}let P=_core.generateOptions.call(void 0, {route:q,body:y,headers:n,queryParams:e,response:i,verb:s,requestOptions:o==null?void 0:o.requestOptions,isFormData:u,isFormUrlEncoded:T,isExactOptionalPropertyTypes:d,hasSignal:l}),D=ye({isRequestOptions:g,hasSignal:l});return`export const ${r} = (
|
|
24
24
|
${_core.toObjectString.call(void 0, a,"implementation")} ${D} ): Promise<AxiosResponse<${i.definition.success||"unknown"}>> => {${O}
|
|
25
|
-
return axios${I?"":".default"}.${
|
|
25
|
+
return axios${I?"":".default"}.${s}(${P});
|
|
26
26
|
}
|
|
27
|
-
`},
|
|
28
|
-
`},$e=({outputClient:n,type:e,isMutatorHook:
|
|
27
|
+
`},B={INFINITE:"infiniteQuery",QUERY:"query"},ae=["getNextPageParam","getPreviousPageParam"],le=({params:n,options:e,type:r})=>{var t;if(e===!1)return"";let i=_core.isObject.call(void 0, e)?` ${(t=_core.stringify.call(void 0, _lodashomitby2.default.call(void 0, e,(y,a)=>!!(r!==B.INFINITE&&ae.includes(a)))))==null?void 0:t.slice(1,-1)}`:"";return n.length?`{${!_core.isObject.call(void 0, e)||!e.hasOwnProperty("enabled")?`enabled: !!(${n.map(({name:y})=>y).join(" && ")}),`:""}${i} ...queryOptions}`:e?`{${i} ...queryOptions}`:"queryOptions"},ce=n=>n?n.hasSecondArg&&!n.isHook?`request?: SecondParameter<typeof ${n.name}>`:n.hasSecondArg&&n.isHook?`request?: SecondParameter<ReturnType<typeof ${n.name}>>`:"":"axios?: AxiosRequestConfig",_=({operationName:n,definitions:e,mutator:r,isRequestOptions:i,type:t})=>{let y=r==null?void 0:r.isHook,a=t?`Use${_core.pascal.call(void 0, t)}Options<Awaited<ReturnType<${y?`ReturnType<typeof use${_core.pascal.call(void 0, n)}Hook>`:`typeof ${n}`}>>, TError, TData>`:`UseMutationOptions<Awaited<ReturnType<${y?`ReturnType<typeof use${_core.pascal.call(void 0, n)}Hook>`:`typeof ${n}`}>>, TError,${e?`{${e}}`:"TVariables"}, TContext>`;if(!i)return`${t?"queryOptions":"mutationOptions"}?: ${a}`;let s=ce(r);return`options?: { ${t?"query":"mutation"}?:${a}, ${s}}
|
|
28
|
+
`},$e=({outputClient:n,type:e,isMutatorHook:r,operationName:i})=>{switch(n){case _core.OutputClient.SVELTE_QUERY:return`Use${_core.pascal.call(void 0, e)}StoreResult<Awaited<ReturnType<${r?`ReturnType<typeof use${_core.pascal.call(void 0, i)}Hook>`:`typeof ${i}`}>>, TError, TData, QueryKey>`;case _core.OutputClient.VUE_QUERY:return` UseQueryReturnType<TData, TError, Use${_core.pascal.call(void 0, e)}Result<TData, TError>>`;case _core.OutputClient.REACT_QUERY:default:return` Use${_core.pascal.call(void 0, e)}Result<TData, TError>`}},de=({isRequestOptions:n,mutator:e,isExactOptionalPropertyTypes:r,hasSignal:i})=>!e&&n?i?`{ ${r?"...(signal ? { signal } : {})":"signal"}, ...axiosOptions }`:"axiosOptions":(e==null?void 0:e.hasSecondArg)&&n?i?"requestOptions, signal":"requestOptions":i?"signal":"",fe=({isRequestOptions:n,mutator:e})=>{if(!n)return"";let r="const {query: queryOptions";return e||(r+=", axios: axiosOptions"),e!=null&&e.hasSecondArg&&(r+=", request: requestOptions"),r+="} = options ?? {};",r},Te=({hasQueryParam:n,hasSignal:e})=>!n&&!e?"":n?e?"{ signal, pageParam }":"{ pageParam }":"{ signal }",Qe=({queryOption:{name:n,queryParam:e,options:r,type:i},operationName:t,queryKeyFnName:y,queryProperties:a,queryKeyProperties:s,params:f,props:Q,mutator:o,isRequestOptions:q,response:R,outputClient:g,isExactOptionalPropertyTypes:u,hasSignal:T})=>{let l=_core.toObjectString.call(void 0, Q,"implementation"),I=e?Q.map(({name:$})=>$==="params"?`{ ${e}: pageParam, ...params }`:$).join(","):a,d=$e({outputClient:g,type:i,isMutatorHook:o==null?void 0:o.isHook,operationName:t}),c=`AxiosError<${R.definition.errors||"unknown"}>`;o&&(c=o.hasErrorType?`${o.default?_core.pascal.call(void 0, t):""}ErrorType<${R.definition.errors||"unknown"}>`:R.definition.errors||"unknown");let O=o!=null&&o.isHook?`ReturnType<typeof use${_core.pascal.call(void 0, t)}Hook>`:`typeof ${t}`,P=_({operationName:t,definitions:"",mutator:o,isRequestOptions:q,type:i}),D=de({isRequestOptions:q,isExactOptionalPropertyTypes:u,mutator:o,hasSignal:T}),A=fe({isRequestOptions:q,mutator:o}),C=Te({hasQueryParam:!!e&&Q.some(({type:$})=>$==="queryParam"),hasSignal:T});return`
|
|
29
29
|
export type ${_core.pascal.call(void 0, n)}QueryResult = NonNullable<Awaited<ReturnType<${O}>>>
|
|
30
30
|
export type ${_core.pascal.call(void 0, n)}QueryError = ${c}
|
|
31
31
|
|
|
@@ -35,43 +35,43 @@ export const ${_core.camel.call(void 0, `use-${n}`)} = <TData = Awaited<ReturnTy
|
|
|
35
35
|
|
|
36
36
|
${A}
|
|
37
37
|
|
|
38
|
-
const queryKey = queryOptions?.queryKey ?? ${y}(${
|
|
38
|
+
const queryKey = queryOptions?.queryKey ?? ${y}(${s});
|
|
39
39
|
|
|
40
40
|
${o!=null&&o.isHook?`const ${t} = use${_core.pascal.call(void 0, t)}Hook();`:""}
|
|
41
41
|
|
|
42
42
|
const queryFn: QueryFunction<Awaited<ReturnType<${o!=null&&o.isHook?`ReturnType<typeof use${_core.pascal.call(void 0, t)}Hook>`:`typeof ${t}`}>>> = (${C}) => ${t}(${I}${I?", ":""}${D});
|
|
43
43
|
|
|
44
|
-
const query = ${_core.camel.call(void 0, `use-${i}`)}<Awaited<ReturnType<${o!=null&&o.isHook?`ReturnType<typeof use${_core.pascal.call(void 0, t)}Hook>`:`typeof ${t}`}>>, TError, TData>(queryKey, queryFn, ${le({params:f,options:
|
|
44
|
+
const query = ${_core.camel.call(void 0, `use-${i}`)}<Awaited<ReturnType<${o!=null&&o.isHook?`ReturnType<typeof use${_core.pascal.call(void 0, t)}Hook>`:`typeof ${t}`}>>, TError, TData>(queryKey, queryFn, ${le({params:f,options:r,type:i})}) as ${d} & { queryKey: QueryKey };
|
|
45
45
|
|
|
46
46
|
query.queryKey = queryKey;
|
|
47
47
|
|
|
48
48
|
return query;
|
|
49
49
|
}
|
|
50
|
-
`},Oe=({queryParams:n,operationName:e,body:
|
|
50
|
+
`},Oe=({queryParams:n,operationName:e,body:r,props:i,verb:t,params:y,override:a,mutator:s,response:f,operationId:Q},{route:o,override:{operations:q={}},context:R},g)=>{var D,A,C;let u=a==null?void 0:a.query,T=(a==null?void 0:a.requestOptions)!==!1,l=(D=q[Q])==null?void 0:D.query,I=!!((C=(A=R.tsconfig)==null?void 0:A.compilerOptions)!=null&&C.exactOptionalPropertyTypes);if(t===_core.Verbs.GET||(l==null?void 0:l.useInfinite)||(l==null?void 0:l.useQuery)){let $=i.map(({name:E,type:F})=>F===_core.GetterPropType.BODY?r.implementation:E).join(","),x=i.filter(E=>E.type!==_core.GetterPropType.HEADER).map(({name:E,type:F})=>F===_core.GetterPropType.BODY?r.implementation:E).join(","),H=[...u!=null&&u.useInfinite?[{name:_core.camel.call(void 0, `${e}-infinite`),options:u==null?void 0:u.options,type:B.INFINITE,queryParam:u==null?void 0:u.useInfiniteQueryParam}]:[],...!(u!=null&&u.useQuery)&&!(u!=null&&u.useInfinite)||(u==null?void 0:u.useQuery)?[{name:e,options:u==null?void 0:u.options,type:B.QUERY}]:[]],K=_core.camel.call(void 0, `get-${e}-queryKey`),Y=_core.toObjectString.call(void 0, i.filter(E=>E.type!==_core.GetterPropType.HEADER),"implementation");return`export const ${K} = (${Y}) => [\`${o}\`${n?", ...(params ? [params]: [])":""}${r.implementation?`, ${r.implementation}`:""}];
|
|
51
51
|
|
|
52
|
-
${
|
|
53
|
-
`}let d=i.map(({definition:$,type:x})=>x===_core.GetterPropType.BODY?
|
|
52
|
+
${H.reduce((E,F)=>E+Qe({queryOption:F,operationName:e,queryKeyFnName:K,queryProperties:$,queryKeyProperties:x,params:y,props:i,mutator:s,isRequestOptions:T,response:f,outputClient:g,isExactOptionalPropertyTypes:I,hasSignal:!!u.signal}),"")}
|
|
53
|
+
`}let d=i.map(({definition:$,type:x})=>x===_core.GetterPropType.BODY?s!=null&&s.bodyTypeName?`data: ${s.bodyTypeName}<${r.definition}>`:`data: ${r.definition}`:$).join(";"),c=i.map(({name:$,type:x})=>x===_core.GetterPropType.BODY?"data":$).join(","),O=`AxiosError<${f.definition.errors||"unknown"}>`;s&&(O=s.hasErrorType?`${s.default?_core.pascal.call(void 0, e):""}ErrorType<${f.definition.errors||"unknown"}>`:f.definition.errors||"unknown");let P=s!=null&&s.isHook?`ReturnType<typeof use${_core.pascal.call(void 0, e)}Hook>`:`typeof ${e}`;return`
|
|
54
54
|
export type ${_core.pascal.call(void 0, e)}MutationResult = NonNullable<Awaited<ReturnType<${P}>>>
|
|
55
|
-
${
|
|
55
|
+
${r.definition?`export type ${_core.pascal.call(void 0, e)}MutationBody = ${s!=null&&s.bodyTypeName?`${s.bodyTypeName}<${r.definition}>`:r.definition}`:""}
|
|
56
56
|
export type ${_core.pascal.call(void 0, e)}MutationError = ${O}
|
|
57
57
|
|
|
58
58
|
export const ${_core.camel.call(void 0, `use-${e}`)} = <TError = ${O},
|
|
59
59
|
${d?"":"TVariables = void,"}
|
|
60
|
-
TContext = unknown>(${_({operationName:e,definitions:d,mutator:
|
|
61
|
-
${T?`const {mutation: mutationOptions${
|
|
60
|
+
TContext = unknown>(${_({operationName:e,definitions:d,mutator:s,isRequestOptions:T})}) => {
|
|
61
|
+
${T?`const {mutation: mutationOptions${s?s!=null&&s.hasSecondArg?", request: requestOptions":"":", axios: axiosOptions"}} = options ?? {};`:""}
|
|
62
62
|
|
|
63
|
-
${
|
|
63
|
+
${s!=null&&s.isHook?`const ${e} = use${_core.pascal.call(void 0, e)}Hook()`:""}
|
|
64
64
|
|
|
65
65
|
|
|
66
66
|
const mutationFn: MutationFunction<Awaited<ReturnType<${P}>>, ${d?`{${d}}`:"TVariables"}> = (${c?"props":""}) => {
|
|
67
67
|
${c?`const {${c}} = props ?? {};`:""}
|
|
68
68
|
|
|
69
|
-
return ${e}(${c}${c?",":""}${T?
|
|
69
|
+
return ${e}(${c}${c?",":""}${T?s?s!=null&&s.hasSecondArg?"requestOptions":"":"axiosOptions":""})
|
|
70
70
|
}
|
|
71
71
|
|
|
72
72
|
return useMutation<Awaited<ReturnType<typeof ${e}>>, TError, ${d?`{${d}}`:"TVariables"}, TContext>(mutationFn, mutationOptions)
|
|
73
73
|
}
|
|
74
|
-
`},M= exports.generateQueryTitle =()=>"",h= exports.generateQueryHeader =({isRequestOptions:n,isMutator:e,hasAwaitedType:
|
|
74
|
+
`},M= exports.generateQueryTitle =()=>"",h= exports.generateQueryHeader =({isRequestOptions:n,isMutator:e,hasAwaitedType:r})=>`${r?"":`type AwaitedInput<T> = PromiseLike<T> | T;
|
|
75
75
|
|
|
76
76
|
type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;
|
|
77
77
|
|
|
@@ -84,6 +84,6 @@ ${n&&e?`// eslint-disable-next-line
|
|
|
84
84
|
? P
|
|
85
85
|
: never;
|
|
86
86
|
|
|
87
|
-
`:""}`,k= exports.generateQueryFooter =()=>"",m= exports.generateQuery =(n,e,
|
|
87
|
+
`:""}`,k= exports.generateQueryFooter =()=>"",m= exports.generateQuery =(n,e,r)=>{let i=_core.generateVerbImports.call(void 0, n),t=pe(n,e),y=Oe(n,e,r);return{implementation:`${t}
|
|
88
88
|
|
|
89
|
-
${y}`,imports:i}},Ee={client:m,header:h,dependencies:ie,footer:k,title:M},
|
|
89
|
+
${y}`,imports:i}},Ee={client:m,header:h,dependencies:ie,footer:k,title:M},qe={client:m,header:h,dependencies:te,footer:k,title:M},Re={client:m,header:h,dependencies:ue,footer:k,title:M},ge={"react-query":Ee,"vue-query":Re,"svelte-query":qe},xe= exports.builder =({type:n="react-query"}={})=>()=>ge[n],me= exports.default =xe;exports.builder = xe; exports.default = me; exports.generateQuery = m; exports.generateQueryFooter = k; exports.generateQueryHeader = h; exports.generateQueryTitle = M; exports.getReactQueryDependencies = ie; exports.getSvelteQueryDependencies = te; exports.getVueQueryDependencies = ue;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orval/query",
|
|
3
|
-
"version": "6.11.0-alpha",
|
|
3
|
+
"version": "6.11.0-alpha.2",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
"lint": "eslint src/**/*.ts"
|
|
14
14
|
},
|
|
15
15
|
"dependencies": {
|
|
16
|
-
"@orval/core": "
|
|
16
|
+
"@orval/core": "6.11.0-alpha.2",
|
|
17
17
|
"lodash.omitby": "^4.6.0"
|
|
18
18
|
},
|
|
19
19
|
"devDependencies": {
|