react-query-lightbase-codegen 0.1.6 → 0.1.9
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.
|
@@ -140,7 +140,7 @@ const getObject = (item) => {
|
|
|
140
140
|
if (item.properties) {
|
|
141
141
|
output += '\n';
|
|
142
142
|
}
|
|
143
|
-
output += `
|
|
143
|
+
output += `} & { [key: string]: ${item.additionalProperties === true ? 'any' : (0, exports.resolveValue)(item.additionalProperties)}`;
|
|
144
144
|
}
|
|
145
145
|
if (item.properties || item.additionalProperties) {
|
|
146
146
|
if (output === '{\n') {
|
|
@@ -205,7 +205,7 @@ const generateInterface = (name, schema) => {
|
|
|
205
205
|
const scalar = (0, exports.getScalar)(schema);
|
|
206
206
|
return `
|
|
207
207
|
${(0, exports.formatDescription)(schema.description)}
|
|
208
|
-
export
|
|
208
|
+
export type ${(0, case_1.pascal)(name)} = ${scalar}
|
|
209
209
|
`;
|
|
210
210
|
};
|
|
211
211
|
exports.generateInterface = generateInterface;
|
|
@@ -264,10 +264,10 @@ const generateRequestBodiesDefinition = (requestBodies = {}) => {
|
|
|
264
264
|
const type = (0, exports.getResReqTypes)([['', requestBody]]);
|
|
265
265
|
const isEmptyInterface = type === '{}';
|
|
266
266
|
if (isEmptyInterface) {
|
|
267
|
-
return `export
|
|
267
|
+
return `export type ${(0, case_1.pascal)(name)}RequestBody = ${type}`;
|
|
268
268
|
}
|
|
269
269
|
else if (type.includes('{') && !type.includes('|') && !type.includes('&')) {
|
|
270
|
-
return `${doc}export
|
|
270
|
+
return `${doc}export type ${(0, case_1.pascal)(name)}RequestBody = ${type}`;
|
|
271
271
|
}
|
|
272
272
|
else {
|
|
273
273
|
return `${doc}export type ${(0, case_1.pascal)(name)}RequestBody = ${type};`;
|
|
@@ -291,10 +291,10 @@ const generateResponsesDefinition = (responses = {}) => {
|
|
|
291
291
|
const type = (0, exports.getResReqTypes)([['', response]]);
|
|
292
292
|
const isEmptyInterface = type === '{}';
|
|
293
293
|
if (isEmptyInterface) {
|
|
294
|
-
return `export
|
|
294
|
+
return `export type RQ${(0, case_1.pascal)(name)}Response = ${type}`;
|
|
295
295
|
}
|
|
296
296
|
else if (type.includes('{') && !type.includes('|') && !type.includes('&')) {
|
|
297
|
-
return `${doc}export
|
|
297
|
+
return `${doc}export type RQ${(0, case_1.pascal)(name)}Response = ${type}`;
|
|
298
298
|
}
|
|
299
299
|
else {
|
|
300
300
|
return `${doc}export type RQ${(0, case_1.pascal)(name)}Response = ${type};`;
|
|
@@ -422,13 +422,14 @@ const generateRestfulComponent = ({ operation, verb, route, operationIds, parame
|
|
|
422
422
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
423
423
|
|
|
424
424
|
use${componentName}Query.updateCache = (
|
|
425
|
-
params
|
|
425
|
+
{params, updater, options}:
|
|
426
|
+
{params: ${componentName}Variables,
|
|
426
427
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
427
|
-
options?: SetDataOptions | undefined
|
|
428
|
+
options?: SetDataOptions | undefined}
|
|
428
429
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
429
430
|
|
|
430
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
431
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
431
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
432
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
432
433
|
|
|
433
434
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
434
435
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -472,13 +473,14 @@ const generateRestfulComponent = ({ operation, verb, route, operationIds, parame
|
|
|
472
473
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
473
474
|
|
|
474
475
|
use${componentName}Query.updateCache = (
|
|
475
|
-
params
|
|
476
|
+
{params, updater, options}:
|
|
477
|
+
{params: ${componentName}Variables,
|
|
476
478
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
477
|
-
options?: SetDataOptions | undefined
|
|
479
|
+
options?: SetDataOptions | undefined}
|
|
478
480
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
479
481
|
|
|
480
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
481
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
482
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
483
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
482
484
|
|
|
483
485
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
484
486
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -513,14 +515,13 @@ const generateRestfulComponent = ({ operation, verb, route, operationIds, parame
|
|
|
513
515
|
use${componentName}Query.baseKey = (): QueryKey => ["${componentName.toLowerCase()}"];
|
|
514
516
|
use${componentName}Query.queryKey = (): QueryKey => use${componentName}Query.baseKey()
|
|
515
517
|
|
|
516
|
-
use${componentName}Query.updateCache = (
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
options?: SetDataOptions | undefined
|
|
518
|
+
use${componentName}Query.updateCache = ({updater, options}:
|
|
519
|
+
{updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
520
|
+
options?: SetDataOptions | undefined}
|
|
520
521
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(), updater, options);
|
|
521
522
|
|
|
522
|
-
use${componentName}Query.getQueryState = (
|
|
523
|
-
use${componentName}Query.getQueryData = (
|
|
523
|
+
use${componentName}Query.getQueryState = (props?: {filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(), props?.filters);
|
|
524
|
+
use${componentName}Query.getQueryData = (props?: {filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(), props?.filters);
|
|
524
525
|
|
|
525
526
|
use${componentName}Query.prefetch = () =>
|
|
526
527
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(), ()=> use${componentName}Query.fetch());
|
|
@@ -565,13 +566,14 @@ const generateRestfulComponent = ({ operation, verb, route, operationIds, parame
|
|
|
565
566
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
566
567
|
|
|
567
568
|
use${componentName}Query.updateCache = (
|
|
568
|
-
params
|
|
569
|
+
{params, updater, options}:
|
|
570
|
+
{params: ${componentName}Variables,
|
|
569
571
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
570
|
-
options?: SetDataOptions | undefined
|
|
572
|
+
options?: SetDataOptions | undefined}
|
|
571
573
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
572
574
|
|
|
573
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
574
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
575
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
576
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
575
577
|
|
|
576
578
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
577
579
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -605,13 +607,14 @@ const generateRestfulComponent = ({ operation, verb, route, operationIds, parame
|
|
|
605
607
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
606
608
|
|
|
607
609
|
use${componentName}Query.updateCache = (
|
|
608
|
-
params
|
|
610
|
+
{params, updater, options}:
|
|
611
|
+
{params: ${componentName}Variables,
|
|
609
612
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
610
|
-
options?: SetDataOptions | undefined
|
|
613
|
+
options?: SetDataOptions | undefined}
|
|
611
614
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
612
615
|
|
|
613
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
614
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
616
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
617
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
615
618
|
|
|
616
619
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
617
620
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -657,13 +660,14 @@ const generateRestfulComponent = ({ operation, verb, route, operationIds, parame
|
|
|
657
660
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
658
661
|
|
|
659
662
|
use${componentName}Query.updateCache = (
|
|
660
|
-
params
|
|
663
|
+
{params, updater, options}:
|
|
664
|
+
{params: ${componentName}Variables,
|
|
661
665
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
662
|
-
options?: SetDataOptions | undefined
|
|
666
|
+
options?: SetDataOptions | undefined}
|
|
663
667
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
664
668
|
|
|
665
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
666
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
669
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
670
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
667
671
|
|
|
668
672
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
669
673
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -709,13 +713,14 @@ const generateRestfulComponent = ({ operation, verb, route, operationIds, parame
|
|
|
709
713
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
710
714
|
|
|
711
715
|
use${componentName}Query.updateCache = (
|
|
712
|
-
params
|
|
716
|
+
{params, updater, options}:
|
|
717
|
+
{params: ${componentName}Variables,
|
|
713
718
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
714
|
-
options?: SetDataOptions | undefined
|
|
719
|
+
options?: SetDataOptions | undefined}
|
|
715
720
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
716
721
|
|
|
717
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
718
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
722
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
723
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
719
724
|
|
|
720
725
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
721
726
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -770,13 +775,14 @@ const generateRestfulComponent = ({ operation, verb, route, operationIds, parame
|
|
|
770
775
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
771
776
|
|
|
772
777
|
use${componentName}Query.updateCache = (
|
|
773
|
-
params
|
|
778
|
+
{params, updater, options}:
|
|
779
|
+
{params: ${componentName}Variables,
|
|
774
780
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
775
|
-
options?: SetDataOptions | undefined
|
|
781
|
+
options?: SetDataOptions | undefined}
|
|
776
782
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
777
783
|
|
|
778
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
779
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
784
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
785
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
780
786
|
|
|
781
787
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
782
788
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -825,13 +831,14 @@ const generateRestfulComponent = ({ operation, verb, route, operationIds, parame
|
|
|
825
831
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
826
832
|
|
|
827
833
|
use${componentName}Query.updateCache = (
|
|
828
|
-
params
|
|
834
|
+
{params, updater, options}:
|
|
835
|
+
{params: ${componentName}Variables,
|
|
829
836
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
830
|
-
options?: SetDataOptions | undefined
|
|
837
|
+
options?: SetDataOptions | undefined}
|
|
831
838
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
832
839
|
|
|
833
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
834
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
840
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
841
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
835
842
|
|
|
836
843
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
837
844
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -878,13 +885,14 @@ const generateRestfulComponent = ({ operation, verb, route, operationIds, parame
|
|
|
878
885
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
879
886
|
|
|
880
887
|
use${componentName}Query.updateCache = (
|
|
881
|
-
params
|
|
888
|
+
{params, updater, options}:
|
|
889
|
+
{params: ${componentName}Variables,
|
|
882
890
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
883
|
-
options?: SetDataOptions | undefined
|
|
891
|
+
options?: SetDataOptions | undefined}
|
|
884
892
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
885
893
|
|
|
886
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
887
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
894
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
895
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
888
896
|
|
|
889
897
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
890
898
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -896,8 +904,8 @@ const generateRestfulComponent = ({ operation, verb, route, operationIds, parame
|
|
|
896
904
|
type ${componentName}QueryProps<T = ${componentName}Return> = ${componentName}Variables & {
|
|
897
905
|
options?: UseQueryOptions<${componentName}Return, AxiosError, T, any>
|
|
898
906
|
}
|
|
899
|
-
export function use${componentName}Query<T = ${componentName}Return>({ options = {}, ...
|
|
900
|
-
return useQuery(use${componentName}Query.queryKey(
|
|
907
|
+
export function use${componentName}Query<T = ${componentName}Return>({ options = {}, ...props }: ${componentName}QueryProps<T>) {
|
|
908
|
+
return useQuery(use${componentName}Query.queryKey(props), async () => use${componentName}Query.fetch(props),
|
|
901
909
|
{ enabled: ${enabledParam}, ...options }
|
|
902
910
|
);}
|
|
903
911
|
|
|
@@ -952,9 +960,8 @@ const importOpenApi = async ({ data, format, apiDirectory, queryClientDir, heade
|
|
|
952
960
|
UseMutationOptions,
|
|
953
961
|
QueryKey,
|
|
954
962
|
SetDataOptions,
|
|
955
|
-
QueryFilters
|
|
956
963
|
} from 'react-query';
|
|
957
|
-
import { Updater } from 'react-query/types/core/utils';
|
|
964
|
+
import { Updater, QueryFilters } from 'react-query/types/core/utils';
|
|
958
965
|
|
|
959
966
|
import queryString from 'query-string';
|
|
960
967
|
import { AxiosError } from 'axios';
|
|
@@ -130,7 +130,7 @@ export const getObject = (item) => {
|
|
|
130
130
|
if (item.properties) {
|
|
131
131
|
output += '\n';
|
|
132
132
|
}
|
|
133
|
-
output += `
|
|
133
|
+
output += `} & { [key: string]: ${item.additionalProperties === true ? 'any' : resolveValue(item.additionalProperties)}`;
|
|
134
134
|
}
|
|
135
135
|
if (item.properties || item.additionalProperties) {
|
|
136
136
|
if (output === '{\n') {
|
|
@@ -191,7 +191,7 @@ export const generateInterface = (name, schema) => {
|
|
|
191
191
|
const scalar = getScalar(schema);
|
|
192
192
|
return `
|
|
193
193
|
${formatDescription(schema.description)}
|
|
194
|
-
export
|
|
194
|
+
export type ${pascal(name)} = ${scalar}
|
|
195
195
|
`;
|
|
196
196
|
};
|
|
197
197
|
/**
|
|
@@ -247,10 +247,10 @@ export const generateRequestBodiesDefinition = (requestBodies = {}) => {
|
|
|
247
247
|
const type = getResReqTypes([['', requestBody]]);
|
|
248
248
|
const isEmptyInterface = type === '{}';
|
|
249
249
|
if (isEmptyInterface) {
|
|
250
|
-
return `export
|
|
250
|
+
return `export type ${pascal(name)}RequestBody = ${type}`;
|
|
251
251
|
}
|
|
252
252
|
else if (type.includes('{') && !type.includes('|') && !type.includes('&')) {
|
|
253
|
-
return `${doc}export
|
|
253
|
+
return `${doc}export type ${pascal(name)}RequestBody = ${type}`;
|
|
254
254
|
}
|
|
255
255
|
else {
|
|
256
256
|
return `${doc}export type ${pascal(name)}RequestBody = ${type};`;
|
|
@@ -273,10 +273,10 @@ export const generateResponsesDefinition = (responses = {}) => {
|
|
|
273
273
|
const type = getResReqTypes([['', response]]);
|
|
274
274
|
const isEmptyInterface = type === '{}';
|
|
275
275
|
if (isEmptyInterface) {
|
|
276
|
-
return `export
|
|
276
|
+
return `export type RQ${pascal(name)}Response = ${type}`;
|
|
277
277
|
}
|
|
278
278
|
else if (type.includes('{') && !type.includes('|') && !type.includes('&')) {
|
|
279
|
-
return `${doc}export
|
|
279
|
+
return `${doc}export type RQ${pascal(name)}Response = ${type}`;
|
|
280
280
|
}
|
|
281
281
|
else {
|
|
282
282
|
return `${doc}export type RQ${pascal(name)}Response = ${type};`;
|
|
@@ -402,13 +402,14 @@ export const generateRestfulComponent = ({ operation, verb, route, operationIds,
|
|
|
402
402
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
403
403
|
|
|
404
404
|
use${componentName}Query.updateCache = (
|
|
405
|
-
params
|
|
405
|
+
{params, updater, options}:
|
|
406
|
+
{params: ${componentName}Variables,
|
|
406
407
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
407
|
-
options?: SetDataOptions | undefined
|
|
408
|
+
options?: SetDataOptions | undefined}
|
|
408
409
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
409
410
|
|
|
410
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
411
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
411
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
412
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
412
413
|
|
|
413
414
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
414
415
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -452,13 +453,14 @@ export const generateRestfulComponent = ({ operation, verb, route, operationIds,
|
|
|
452
453
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
453
454
|
|
|
454
455
|
use${componentName}Query.updateCache = (
|
|
455
|
-
params
|
|
456
|
+
{params, updater, options}:
|
|
457
|
+
{params: ${componentName}Variables,
|
|
456
458
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
457
|
-
options?: SetDataOptions | undefined
|
|
459
|
+
options?: SetDataOptions | undefined}
|
|
458
460
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
459
461
|
|
|
460
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
461
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
462
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
463
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
462
464
|
|
|
463
465
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
464
466
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -493,14 +495,13 @@ export const generateRestfulComponent = ({ operation, verb, route, operationIds,
|
|
|
493
495
|
use${componentName}Query.baseKey = (): QueryKey => ["${componentName.toLowerCase()}"];
|
|
494
496
|
use${componentName}Query.queryKey = (): QueryKey => use${componentName}Query.baseKey()
|
|
495
497
|
|
|
496
|
-
use${componentName}Query.updateCache = (
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
options?: SetDataOptions | undefined
|
|
498
|
+
use${componentName}Query.updateCache = ({updater, options}:
|
|
499
|
+
{updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
500
|
+
options?: SetDataOptions | undefined}
|
|
500
501
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(), updater, options);
|
|
501
502
|
|
|
502
|
-
use${componentName}Query.getQueryState = (
|
|
503
|
-
use${componentName}Query.getQueryData = (
|
|
503
|
+
use${componentName}Query.getQueryState = (props?: {filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(), props?.filters);
|
|
504
|
+
use${componentName}Query.getQueryData = (props?: {filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(), props?.filters);
|
|
504
505
|
|
|
505
506
|
use${componentName}Query.prefetch = () =>
|
|
506
507
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(), ()=> use${componentName}Query.fetch());
|
|
@@ -545,13 +546,14 @@ export const generateRestfulComponent = ({ operation, verb, route, operationIds,
|
|
|
545
546
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
546
547
|
|
|
547
548
|
use${componentName}Query.updateCache = (
|
|
548
|
-
params
|
|
549
|
+
{params, updater, options}:
|
|
550
|
+
{params: ${componentName}Variables,
|
|
549
551
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
550
|
-
options?: SetDataOptions | undefined
|
|
552
|
+
options?: SetDataOptions | undefined}
|
|
551
553
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
552
554
|
|
|
553
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
554
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
555
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
556
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
555
557
|
|
|
556
558
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
557
559
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -585,13 +587,14 @@ export const generateRestfulComponent = ({ operation, verb, route, operationIds,
|
|
|
585
587
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
586
588
|
|
|
587
589
|
use${componentName}Query.updateCache = (
|
|
588
|
-
params
|
|
590
|
+
{params, updater, options}:
|
|
591
|
+
{params: ${componentName}Variables,
|
|
589
592
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
590
|
-
options?: SetDataOptions | undefined
|
|
593
|
+
options?: SetDataOptions | undefined}
|
|
591
594
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
592
595
|
|
|
593
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
594
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
596
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
597
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
595
598
|
|
|
596
599
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
597
600
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -637,13 +640,14 @@ export const generateRestfulComponent = ({ operation, verb, route, operationIds,
|
|
|
637
640
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
638
641
|
|
|
639
642
|
use${componentName}Query.updateCache = (
|
|
640
|
-
params
|
|
643
|
+
{params, updater, options}:
|
|
644
|
+
{params: ${componentName}Variables,
|
|
641
645
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
642
|
-
options?: SetDataOptions | undefined
|
|
646
|
+
options?: SetDataOptions | undefined}
|
|
643
647
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
644
648
|
|
|
645
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
646
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
649
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
650
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
647
651
|
|
|
648
652
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
649
653
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -689,13 +693,14 @@ export const generateRestfulComponent = ({ operation, verb, route, operationIds,
|
|
|
689
693
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
690
694
|
|
|
691
695
|
use${componentName}Query.updateCache = (
|
|
692
|
-
params
|
|
696
|
+
{params, updater, options}:
|
|
697
|
+
{params: ${componentName}Variables,
|
|
693
698
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
694
|
-
options?: SetDataOptions | undefined
|
|
699
|
+
options?: SetDataOptions | undefined}
|
|
695
700
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
696
701
|
|
|
697
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
698
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
702
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
703
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
699
704
|
|
|
700
705
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
701
706
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -750,13 +755,14 @@ export const generateRestfulComponent = ({ operation, verb, route, operationIds,
|
|
|
750
755
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
751
756
|
|
|
752
757
|
use${componentName}Query.updateCache = (
|
|
753
|
-
params
|
|
758
|
+
{params, updater, options}:
|
|
759
|
+
{params: ${componentName}Variables,
|
|
754
760
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
755
|
-
options?: SetDataOptions | undefined
|
|
761
|
+
options?: SetDataOptions | undefined}
|
|
756
762
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
757
763
|
|
|
758
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
759
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
764
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
765
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
760
766
|
|
|
761
767
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
762
768
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -805,13 +811,14 @@ export const generateRestfulComponent = ({ operation, verb, route, operationIds,
|
|
|
805
811
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
806
812
|
|
|
807
813
|
use${componentName}Query.updateCache = (
|
|
808
|
-
params
|
|
814
|
+
{params, updater, options}:
|
|
815
|
+
{params: ${componentName}Variables,
|
|
809
816
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
810
|
-
options?: SetDataOptions | undefined
|
|
817
|
+
options?: SetDataOptions | undefined}
|
|
811
818
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
812
819
|
|
|
813
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
814
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
820
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
821
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
815
822
|
|
|
816
823
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
817
824
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -858,13 +865,14 @@ export const generateRestfulComponent = ({ operation, verb, route, operationIds,
|
|
|
858
865
|
use${componentName}Query.queryKey = (params: ${componentName}Variables ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
859
866
|
|
|
860
867
|
use${componentName}Query.updateCache = (
|
|
861
|
-
params
|
|
868
|
+
{params, updater, options}:
|
|
869
|
+
{params: ${componentName}Variables,
|
|
862
870
|
updater: Updater<${componentName}Return | undefined, ${componentName}Return>,
|
|
863
|
-
options?: SetDataOptions | undefined
|
|
871
|
+
options?: SetDataOptions | undefined}
|
|
864
872
|
) => queryClient.setQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), updater, options);
|
|
865
873
|
|
|
866
|
-
use${componentName}Query.getQueryState = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
867
|
-
use${componentName}Query.getQueryData = (params: ${componentName}Variables, filters?: QueryFilters)=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
874
|
+
use${componentName}Query.getQueryState = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryState<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
875
|
+
use${componentName}Query.getQueryData = ({params, filters}:{params: ${componentName}Variables, filters?: QueryFilters})=> queryClient.getQueryData<${componentName}Return>(use${componentName}Query.queryKey(params), filters);
|
|
868
876
|
|
|
869
877
|
use${componentName}Query.prefetch = (params: ${componentName}Variables) =>
|
|
870
878
|
queryClient.prefetchQuery<${componentName}Return>(use${componentName}Query.queryKey(params), ()=> use${componentName}Query.fetch(params));
|
|
@@ -876,8 +884,8 @@ export const generateRestfulComponent = ({ operation, verb, route, operationIds,
|
|
|
876
884
|
type ${componentName}QueryProps<T = ${componentName}Return> = ${componentName}Variables & {
|
|
877
885
|
options?: UseQueryOptions<${componentName}Return, AxiosError, T, any>
|
|
878
886
|
}
|
|
879
|
-
export function use${componentName}Query<T = ${componentName}Return>({ options = {}, ...
|
|
880
|
-
return useQuery(use${componentName}Query.queryKey(
|
|
887
|
+
export function use${componentName}Query<T = ${componentName}Return>({ options = {}, ...props }: ${componentName}QueryProps<T>) {
|
|
888
|
+
return useQuery(use${componentName}Query.queryKey(props), async () => use${componentName}Query.fetch(props),
|
|
881
889
|
{ enabled: ${enabledParam}, ...options }
|
|
882
890
|
);}
|
|
883
891
|
|
|
@@ -931,9 +939,8 @@ export const importOpenApi = async ({ data, format, apiDirectory, queryClientDir
|
|
|
931
939
|
UseMutationOptions,
|
|
932
940
|
QueryKey,
|
|
933
941
|
SetDataOptions,
|
|
934
|
-
QueryFilters
|
|
935
942
|
} from 'react-query';
|
|
936
|
-
import { Updater } from 'react-query/types/core/utils';
|
|
943
|
+
import { Updater, QueryFilters } from 'react-query/types/core/utils';
|
|
937
944
|
|
|
938
945
|
import queryString from 'query-string';
|
|
939
946
|
import { AxiosError } from 'axios';
|
package/package.json
CHANGED
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
import chalk from 'chalk';
|
|
2
|
-
import program from 'commander';
|
|
3
|
-
import { readFileSync, writeFileSync } from 'fs';
|
|
4
|
-
import { join, parse } from 'path';
|
|
5
|
-
import importOpenApi from '../scripts/import-open-api';
|
|
6
|
-
const log = console.log; // tslint:disable-line:no-console
|
|
7
|
-
program.option('-o, --output [value]', 'output file destination');
|
|
8
|
-
program.option('-f, --file [value]', 'input file (yaml or json openapi specs)');
|
|
9
|
-
program.parse(process.argv);
|
|
10
|
-
const createSuccessMessage = (backend) => chalk.green(`${backend ? `[${backend}] ` : ''}🎉 Your OpenAPI spec has been converted into react query hooks`);
|
|
11
|
-
const successWithoutOutputMessage = chalk.yellow('Success! No output path specified; printed to standard output.');
|
|
12
|
-
const importSpecs = async (options) => {
|
|
13
|
-
if (!options.file) {
|
|
14
|
-
throw new Error("You need to provide an input specification with `--file`, '--url', or `--github`");
|
|
15
|
-
}
|
|
16
|
-
const data = readFileSync(join(process.cwd(), options.file), 'utf-8');
|
|
17
|
-
const { ext } = parse(options.file);
|
|
18
|
-
const format = ['.yaml', '.yml'].includes(ext.toLowerCase()) ? 'yaml' : 'json';
|
|
19
|
-
return importOpenApi({
|
|
20
|
-
data,
|
|
21
|
-
format,
|
|
22
|
-
});
|
|
23
|
-
};
|
|
24
|
-
// Use flags as configuration
|
|
25
|
-
importSpecs(program)
|
|
26
|
-
.then((data) => {
|
|
27
|
-
if (program.output) {
|
|
28
|
-
writeFileSync(join(process.cwd(), program.output), data);
|
|
29
|
-
log(createSuccessMessage());
|
|
30
|
-
}
|
|
31
|
-
else {
|
|
32
|
-
log(data);
|
|
33
|
-
log(successWithoutOutputMessage);
|
|
34
|
-
}
|
|
35
|
-
})
|
|
36
|
-
.catch((err) => {
|
|
37
|
-
log(chalk.red(err));
|
|
38
|
-
process.exit(1);
|
|
39
|
-
});
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import program from 'commander';
|
|
2
|
-
import { readFileSync } from 'fs';
|
|
3
|
-
import { join } from 'path';
|
|
4
|
-
const { version } = JSON.parse(readFileSync(join(__dirname, '../../package.json'), 'utf-8'));
|
|
5
|
-
program
|
|
6
|
-
.version(version)
|
|
7
|
-
.command('import [open-api-file]', 'generate react-query hooks from OpenAPI specs')
|
|
8
|
-
.parse(process.argv);
|
|
@@ -1,605 +0,0 @@
|
|
|
1
|
-
import { pascal } from 'case';
|
|
2
|
-
import get from 'lodash/get';
|
|
3
|
-
import groupBy from 'lodash/groupBy';
|
|
4
|
-
import isEmpty from 'lodash/isEmpty';
|
|
5
|
-
import set from 'lodash/set';
|
|
6
|
-
import uniq from 'lodash/uniq';
|
|
7
|
-
import swagger2openapi from 'swagger2openapi';
|
|
8
|
-
const yaml = require('js-yaml');
|
|
9
|
-
const IdentifierRegexp = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/;
|
|
10
|
-
/**
|
|
11
|
-
* Import and parse the openapi spec from a yaml/json
|
|
12
|
-
*/
|
|
13
|
-
const importSpecs = (data, extension) => {
|
|
14
|
-
const schema = extension === 'yaml' ? yaml.load(data) : JSON.parse(data);
|
|
15
|
-
return new Promise((resolve, reject) => {
|
|
16
|
-
if (!schema.openapi || !schema.openapi.startsWith('3.')) {
|
|
17
|
-
swagger2openapi.convertObj(schema, {}, (err, convertedObj) => {
|
|
18
|
-
if (err) {
|
|
19
|
-
reject(err);
|
|
20
|
-
}
|
|
21
|
-
else {
|
|
22
|
-
resolve(convertedObj.openapi);
|
|
23
|
-
}
|
|
24
|
-
});
|
|
25
|
-
}
|
|
26
|
-
else {
|
|
27
|
-
resolve(schema);
|
|
28
|
-
}
|
|
29
|
-
});
|
|
30
|
-
};
|
|
31
|
-
/**
|
|
32
|
-
* Discriminator helper for `ReferenceObject`
|
|
33
|
-
*/
|
|
34
|
-
export const isReference = (property) => {
|
|
35
|
-
return Boolean(property.$ref);
|
|
36
|
-
};
|
|
37
|
-
/**
|
|
38
|
-
* Return the typescript equivalent of open-api data type
|
|
39
|
-
*/
|
|
40
|
-
export const getScalar = (item) => {
|
|
41
|
-
const nullable = item.nullable ? ' | null' : '';
|
|
42
|
-
switch (item.type) {
|
|
43
|
-
case 'number':
|
|
44
|
-
case 'integer':
|
|
45
|
-
return 'number' + nullable;
|
|
46
|
-
case 'boolean':
|
|
47
|
-
return 'boolean' + nullable;
|
|
48
|
-
case 'array':
|
|
49
|
-
return getArray(item) + nullable;
|
|
50
|
-
case 'string':
|
|
51
|
-
return (item.enum ? `"${item.enum.join(`" | "`)}"` : 'string') + nullable;
|
|
52
|
-
case 'object':
|
|
53
|
-
default:
|
|
54
|
-
return getObject(item) + nullable;
|
|
55
|
-
}
|
|
56
|
-
};
|
|
57
|
-
/**
|
|
58
|
-
* Return the output type from the $ref
|
|
59
|
-
*/
|
|
60
|
-
export const getRef = ($ref) => {
|
|
61
|
-
if ($ref.startsWith('#/components/schemas')) {
|
|
62
|
-
return pascal($ref.replace('#/components/schemas/', ''));
|
|
63
|
-
}
|
|
64
|
-
else if ($ref.startsWith('#/components/responses')) {
|
|
65
|
-
return pascal($ref.replace('#/components/responses/', '')) + 'Response';
|
|
66
|
-
}
|
|
67
|
-
else if ($ref.startsWith('#/components/parameters')) {
|
|
68
|
-
return pascal($ref.replace('#/components/parameters/', '')) + 'Parameter';
|
|
69
|
-
}
|
|
70
|
-
else if ($ref.startsWith('#/components/requestBodies')) {
|
|
71
|
-
return pascal($ref.replace('#/components/requestBodies/', '')) + 'RequestBody';
|
|
72
|
-
}
|
|
73
|
-
else {
|
|
74
|
-
throw new Error('This library only resolve $ref that are include into `#/components/*` for now');
|
|
75
|
-
}
|
|
76
|
-
};
|
|
77
|
-
/**
|
|
78
|
-
* Return the output type from an array
|
|
79
|
-
*/
|
|
80
|
-
export const getArray = (item) => {
|
|
81
|
-
if (item.items) {
|
|
82
|
-
if (!isReference(item.items) && (item.items.oneOf || item.items.allOf || item.items.enum)) {
|
|
83
|
-
return `(${resolveValue(item.items)})[]`;
|
|
84
|
-
}
|
|
85
|
-
else {
|
|
86
|
-
return `${resolveValue(item.items)}[]`;
|
|
87
|
-
}
|
|
88
|
-
}
|
|
89
|
-
else {
|
|
90
|
-
throw new Error('All arrays must have an `items` key define');
|
|
91
|
-
}
|
|
92
|
-
};
|
|
93
|
-
/**
|
|
94
|
-
* Return the output type from an object
|
|
95
|
-
*/
|
|
96
|
-
export const getObject = (item) => {
|
|
97
|
-
if (isReference(item)) {
|
|
98
|
-
return getRef(item.$ref);
|
|
99
|
-
}
|
|
100
|
-
if (item.allOf) {
|
|
101
|
-
return item.allOf.map(resolveValue).join(' & ');
|
|
102
|
-
}
|
|
103
|
-
if (item.oneOf) {
|
|
104
|
-
return item.oneOf.map(resolveValue).join(' | ');
|
|
105
|
-
}
|
|
106
|
-
if (!item.type && !item.properties && !item.additionalProperties) {
|
|
107
|
-
return '{}';
|
|
108
|
-
}
|
|
109
|
-
// Free form object (https://swagger.io/docs/specification/data-models/data-types/#free-form)
|
|
110
|
-
if (item.type === 'object' &&
|
|
111
|
-
!item.properties &&
|
|
112
|
-
(!item.additionalProperties || item.additionalProperties === true || isEmpty(item.additionalProperties))) {
|
|
113
|
-
return '{[key: string]: any}';
|
|
114
|
-
}
|
|
115
|
-
// Consolidation of item.properties & item.additionalProperties
|
|
116
|
-
let output = '{\n';
|
|
117
|
-
if (item.properties) {
|
|
118
|
-
output += Object.entries(item.properties)
|
|
119
|
-
.map(([key, prop]) => {
|
|
120
|
-
const doc = isReference(prop) ? '' : formatDescription(prop.description, 2);
|
|
121
|
-
const isRequired = (item.required || []).includes(key);
|
|
122
|
-
const processedKey = IdentifierRegexp.test(key) ? key : `"${key}"`;
|
|
123
|
-
return ` ${doc}${processedKey}${isRequired ? '' : '?'}: ${resolveValue(prop)};`;
|
|
124
|
-
})
|
|
125
|
-
.join('\n');
|
|
126
|
-
}
|
|
127
|
-
if (item.additionalProperties) {
|
|
128
|
-
if (item.properties) {
|
|
129
|
-
output += '\n';
|
|
130
|
-
}
|
|
131
|
-
output += ` [key: string]: ${item.additionalProperties === true ? 'any' : resolveValue(item.additionalProperties)};`;
|
|
132
|
-
}
|
|
133
|
-
if (item.properties || item.additionalProperties) {
|
|
134
|
-
if (output === '{\n') {
|
|
135
|
-
return '{}';
|
|
136
|
-
}
|
|
137
|
-
return output + '\n}';
|
|
138
|
-
}
|
|
139
|
-
return item.type === 'object' ? '{[key: string]: any}' : 'any';
|
|
140
|
-
};
|
|
141
|
-
/**
|
|
142
|
-
* Resolve the value of a schema object to a proper type definition.
|
|
143
|
-
*/
|
|
144
|
-
export const resolveValue = (schema) => isReference(schema) ? getRef(schema.$ref) : getScalar(schema);
|
|
145
|
-
/**
|
|
146
|
-
* Extract responses / request types from open-api specs
|
|
147
|
-
*/
|
|
148
|
-
export const getResReqTypes = (responsesOrRequests) => uniq(responsesOrRequests.map(([_, res]) => {
|
|
149
|
-
if (!res) {
|
|
150
|
-
return 'void';
|
|
151
|
-
}
|
|
152
|
-
if (isReference(res)) {
|
|
153
|
-
return getRef(res.$ref);
|
|
154
|
-
}
|
|
155
|
-
if (res.content) {
|
|
156
|
-
for (let contentType of Object.keys(res.content)) {
|
|
157
|
-
if (contentType.startsWith('application/json') ||
|
|
158
|
-
contentType.startsWith('application/octet-stream')) {
|
|
159
|
-
const schema = res.content[contentType].schema;
|
|
160
|
-
return resolveValue(schema);
|
|
161
|
-
}
|
|
162
|
-
}
|
|
163
|
-
return 'void';
|
|
164
|
-
}
|
|
165
|
-
return 'void';
|
|
166
|
-
})).join(' | ');
|
|
167
|
-
/**
|
|
168
|
-
* Return every params in a path
|
|
169
|
-
*
|
|
170
|
-
* @example
|
|
171
|
-
* ```
|
|
172
|
-
* getParamsInPath("/pet/{category}/{name}/");
|
|
173
|
-
* // => ["category", "name"]
|
|
174
|
-
* ```
|
|
175
|
-
*/
|
|
176
|
-
export const getParamsInPath = (path) => {
|
|
177
|
-
let n;
|
|
178
|
-
const output = [];
|
|
179
|
-
const templatePathRegex = /\{(\w+)}/g;
|
|
180
|
-
while ((n = templatePathRegex.exec(path)) !== null) {
|
|
181
|
-
output.push(n[1]);
|
|
182
|
-
}
|
|
183
|
-
return output;
|
|
184
|
-
};
|
|
185
|
-
/**
|
|
186
|
-
* Generate the interface string
|
|
187
|
-
*/
|
|
188
|
-
export const generateInterface = (name, schema) => {
|
|
189
|
-
const scalar = getScalar(schema);
|
|
190
|
-
return `${formatDescription(schema.description)}export interface ${pascal(name)} ${scalar}`;
|
|
191
|
-
};
|
|
192
|
-
/**
|
|
193
|
-
* Propagate every `discriminator.propertyName` mapping to the original ref
|
|
194
|
-
*
|
|
195
|
-
* Note: This method directly mutate the `specs` object.
|
|
196
|
-
*/
|
|
197
|
-
export const resolveDiscriminator = (specs) => {
|
|
198
|
-
if (specs.components && specs.components.schemas) {
|
|
199
|
-
Object.values(specs.components.schemas).forEach((schema) => {
|
|
200
|
-
if (isReference(schema) || !schema.discriminator || !schema.discriminator.mapping) {
|
|
201
|
-
return;
|
|
202
|
-
}
|
|
203
|
-
const { mapping, propertyName } = schema.discriminator;
|
|
204
|
-
Object.entries(mapping).forEach(([name, ref]) => {
|
|
205
|
-
if (!ref.startsWith('#/components/schemas/')) {
|
|
206
|
-
throw new Error('Discriminator mapping outside of `#/components/schemas` is not supported');
|
|
207
|
-
}
|
|
208
|
-
set(specs, `components.schemas.${ref.slice('#/components/schemas/'.length)}.properties.${propertyName}.enum`, [name]);
|
|
209
|
-
});
|
|
210
|
-
});
|
|
211
|
-
}
|
|
212
|
-
};
|
|
213
|
-
/**
|
|
214
|
-
* Extract all types from #/components/schemas
|
|
215
|
-
*/
|
|
216
|
-
export const generateSchemasDefinition = (schemas = {}) => {
|
|
217
|
-
if (isEmpty(schemas)) {
|
|
218
|
-
return '';
|
|
219
|
-
}
|
|
220
|
-
return (Object.entries(schemas)
|
|
221
|
-
.map(([name, schema]) => !isReference(schema) &&
|
|
222
|
-
(!schema.type || schema.type === 'object') &&
|
|
223
|
-
!schema.allOf &&
|
|
224
|
-
!schema.oneOf &&
|
|
225
|
-
!isReference(schema) &&
|
|
226
|
-
!schema.nullable
|
|
227
|
-
? generateInterface(name, schema)
|
|
228
|
-
: `${formatDescription(isReference(schema) ? undefined : schema.description)}export type ${pascal(name)} = ${resolveValue(schema)};`)
|
|
229
|
-
.join('\n\n') + '\n');
|
|
230
|
-
};
|
|
231
|
-
/**
|
|
232
|
-
* Extract all types from #/components/requestBodies
|
|
233
|
-
*/
|
|
234
|
-
export const generateRequestBodiesDefinition = (requestBodies = {}) => {
|
|
235
|
-
if (isEmpty(requestBodies)) {
|
|
236
|
-
return '';
|
|
237
|
-
}
|
|
238
|
-
return ('\n' +
|
|
239
|
-
Object.entries(requestBodies)
|
|
240
|
-
.map(([name, requestBody]) => {
|
|
241
|
-
const doc = isReference(requestBody) ? '' : formatDescription(requestBody.description);
|
|
242
|
-
const type = getResReqTypes([['', requestBody]]);
|
|
243
|
-
const isEmptyInterface = type === '{}';
|
|
244
|
-
if (isEmptyInterface) {
|
|
245
|
-
return `export interface ${pascal(name)}RequestBody ${type}`;
|
|
246
|
-
}
|
|
247
|
-
else if (type.includes('{') && !type.includes('|') && !type.includes('&')) {
|
|
248
|
-
return `${doc}export interface ${pascal(name)}RequestBody ${type}`;
|
|
249
|
-
}
|
|
250
|
-
else {
|
|
251
|
-
return `${doc}export type ${pascal(name)}RequestBody = ${type};`;
|
|
252
|
-
}
|
|
253
|
-
})
|
|
254
|
-
.join('\n\n') +
|
|
255
|
-
'\n');
|
|
256
|
-
};
|
|
257
|
-
/**
|
|
258
|
-
* Extract all types from #/components/responses
|
|
259
|
-
*/
|
|
260
|
-
export const generateResponsesDefinition = (responses = {}) => {
|
|
261
|
-
if (isEmpty(responses)) {
|
|
262
|
-
return '';
|
|
263
|
-
}
|
|
264
|
-
return ('\n' +
|
|
265
|
-
Object.entries(responses)
|
|
266
|
-
.map(([name, response]) => {
|
|
267
|
-
const doc = isReference(response) ? '' : formatDescription(response.description);
|
|
268
|
-
const type = getResReqTypes([['', response]]);
|
|
269
|
-
const isEmptyInterface = type === '{}';
|
|
270
|
-
if (isEmptyInterface) {
|
|
271
|
-
return `export interface RQ${pascal(name)}Response ${type}`;
|
|
272
|
-
}
|
|
273
|
-
else if (type.includes('{') && !type.includes('|') && !type.includes('&')) {
|
|
274
|
-
return `${doc}export interface RQ${pascal(name)}Response ${type}`;
|
|
275
|
-
}
|
|
276
|
-
else {
|
|
277
|
-
return `${doc}export type RQ${pascal(name)}Response = ${type};`;
|
|
278
|
-
}
|
|
279
|
-
})
|
|
280
|
-
.join('\n\n') +
|
|
281
|
-
'\n');
|
|
282
|
-
};
|
|
283
|
-
/**
|
|
284
|
-
* Format a description to code documentation.
|
|
285
|
-
*/
|
|
286
|
-
export const formatDescription = (description, tabSize = 0) => description
|
|
287
|
-
? `/**\n${description
|
|
288
|
-
.split('\n')
|
|
289
|
-
.map((i) => `${' '.repeat(tabSize)} * ${i}`)
|
|
290
|
-
.join('\n')}\n${' '.repeat(tabSize)} */\n${' '.repeat(tabSize)}`
|
|
291
|
-
: '';
|
|
292
|
-
/**
|
|
293
|
-
* Generate a react-query component from openapi operation specs
|
|
294
|
-
*/
|
|
295
|
-
export const generateRestfulComponent = (operation, verb, route, operationIds, parameters = [], schemasComponents) => {
|
|
296
|
-
if (!operation.operationId) {
|
|
297
|
-
throw new Error(`Every path must have a operationId - No operationId set for ${verb} ${route}`);
|
|
298
|
-
}
|
|
299
|
-
if (operationIds.includes(operation.operationId)) {
|
|
300
|
-
throw new Error(`"${operation.operationId}" is duplicated in your schema definition!`);
|
|
301
|
-
}
|
|
302
|
-
operationIds.push(operation.operationId);
|
|
303
|
-
route = route.replace(/\{/g, '${'); // `/pet/{id}` => `/pet/${id}`
|
|
304
|
-
// Remove the last param of the route if we are in the DELETE case
|
|
305
|
-
let lastParamInTheRoute = null;
|
|
306
|
-
const componentName = pascal(operation.operationId);
|
|
307
|
-
const isOk = ([statusCode]) => statusCode.toString().startsWith('2');
|
|
308
|
-
const responseTypes = getResReqTypes(Object.entries(operation.responses).filter(isOk)) || 'void';
|
|
309
|
-
const requestBodyTypes = getResReqTypes([['body', operation.requestBody]]);
|
|
310
|
-
const needAResponseComponent = true;
|
|
311
|
-
const paramsInPath = getParamsInPath(route).filter((param) => !(verb === 'delete' && param === lastParamInTheRoute));
|
|
312
|
-
const { query: queryParams = [], path: pathParams = [] } = groupBy([...parameters, ...(operation.parameters || [])].map((p) => {
|
|
313
|
-
if (isReference(p)) {
|
|
314
|
-
return get(schemasComponents, p.$ref.replace('#/components/', '').replace('/', '.'));
|
|
315
|
-
}
|
|
316
|
-
else {
|
|
317
|
-
return p;
|
|
318
|
-
}
|
|
319
|
-
}), 'in');
|
|
320
|
-
const paramsTypes = paramsInPath
|
|
321
|
-
.map((p) => {
|
|
322
|
-
try {
|
|
323
|
-
const { name, required, schema } = pathParams.find((i) => i.name === p);
|
|
324
|
-
return `${name}${required ? '' : '?'}: ${resolveValue(schema)}`;
|
|
325
|
-
}
|
|
326
|
-
catch (err) {
|
|
327
|
-
throw new Error(`The path params ${p} can't be found in parameters (${operation.operationId})`);
|
|
328
|
-
}
|
|
329
|
-
})
|
|
330
|
-
.join('; ');
|
|
331
|
-
const queryParamsType = queryParams
|
|
332
|
-
.map((p) => {
|
|
333
|
-
const processedName = IdentifierRegexp.test(p.name) ? p.name : `"${p.name}"`;
|
|
334
|
-
return `${formatDescription(p.description, 2)}${processedName}${p.required ? '' : '?'}: ${resolveValue(p.schema)}`;
|
|
335
|
-
})
|
|
336
|
-
.join(';\n ');
|
|
337
|
-
// Retrieve the type of the param for delete verb
|
|
338
|
-
const lastParamInTheRouteDefinition = operation.parameters && lastParamInTheRoute
|
|
339
|
-
? operation.parameters.find((p) => {
|
|
340
|
-
if (isReference(p)) {
|
|
341
|
-
return false;
|
|
342
|
-
}
|
|
343
|
-
return p.name === lastParamInTheRoute;
|
|
344
|
-
}) // Reference is not possible
|
|
345
|
-
: { schema: { type: 'string' } };
|
|
346
|
-
if (!lastParamInTheRouteDefinition) {
|
|
347
|
-
throw new Error(`The path params ${lastParamInTheRoute} can't be found in parameters (${operation.operationId})`);
|
|
348
|
-
}
|
|
349
|
-
let genericsTypes = `${needAResponseComponent ? componentName + 'Res' : responseTypes}`;
|
|
350
|
-
if (verb !== 'get') {
|
|
351
|
-
genericsTypes = `${needAResponseComponent ? componentName + 'Res' : responseTypes}`;
|
|
352
|
-
}
|
|
353
|
-
const description = formatDescription(operation.summary && operation.description
|
|
354
|
-
? `${operation.summary}\n\n${operation.description}`
|
|
355
|
-
: `${operation.summary || ''}${operation.description || ''}`);
|
|
356
|
-
let output = `\n\n${description}`;
|
|
357
|
-
const typeOrInterface = `type ${componentName}Res =`;
|
|
358
|
-
output += `
|
|
359
|
-
${needAResponseComponent ? `export ${typeOrInterface} ${responseTypes}` : ''}
|
|
360
|
-
`;
|
|
361
|
-
const queryParam = queryParamsType && queryParamsType !== 'void' ? `${queryParamsType}` : '';
|
|
362
|
-
const requestBodyComponent = requestBodyTypes && requestBodyTypes !== 'void' ? `${requestBodyTypes}` : '';
|
|
363
|
-
// QUERIES
|
|
364
|
-
if (!requestBodyComponent && paramsInPath.length && !queryParam) {
|
|
365
|
-
output += `
|
|
366
|
-
type ${componentName}Params = {${paramsTypes}};
|
|
367
|
-
use${componentName}Query.fetch = async (props: ${componentName}Params ) => {
|
|
368
|
-
const result = await api.${verb}<${genericsTypes}>(\`${route.replace(/\{/g, '{props.')}\`);
|
|
369
|
-
return result.data;
|
|
370
|
-
}
|
|
371
|
-
|
|
372
|
-
use${componentName}Query.baseKey = (): QueryKey => ["${componentName.toLowerCase()}"];
|
|
373
|
-
use${componentName}Query.queryKey = (params: ${componentName}Params ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
374
|
-
|
|
375
|
-
type ${componentName}QueryProps<T = ${genericsTypes}> = {
|
|
376
|
-
options?: UseQueryOptions<${genericsTypes}, AxiosError, T, any>
|
|
377
|
-
} & ${componentName}Params
|
|
378
|
-
|
|
379
|
-
export function use${componentName}Query<T = ${genericsTypes}>({ options = {}, ...props }: ${componentName}QueryProps<T>) {
|
|
380
|
-
return useQuery(use${componentName}Query.queryKey(props), async () => use${componentName}Query.fetch(props),
|
|
381
|
-
{ enabled: !!props.${paramsInPath.join(' && !!props.')}, ...options }
|
|
382
|
-
);}
|
|
383
|
-
|
|
384
|
-
type ${componentName}MutationProps<T> = {
|
|
385
|
-
options?: UseMutationOptions<${genericsTypes}, AxiosError, ${componentName}Params, T>
|
|
386
|
-
}
|
|
387
|
-
export function use${componentName}Mutation<T = ${genericsTypes}>(props?: ${componentName}MutationProps<T>) {
|
|
388
|
-
return useMutation(async ({${paramsInPath.join(', ')}}) => {
|
|
389
|
-
const result = await api.${verb}<${genericsTypes}>(\`${route}\`)
|
|
390
|
-
return result.data
|
|
391
|
-
},
|
|
392
|
-
props?.options
|
|
393
|
-
)};`;
|
|
394
|
-
}
|
|
395
|
-
if (!requestBodyComponent && paramsInPath.length && queryParam) {
|
|
396
|
-
output += `
|
|
397
|
-
type ${componentName}Params = {
|
|
398
|
-
${paramsTypes}
|
|
399
|
-
${queryParamsType}
|
|
400
|
-
}
|
|
401
|
-
|
|
402
|
-
use${componentName}Query.fetch = async (props: ${componentName}Params) => {
|
|
403
|
-
const {${paramsInPath.join(', ')}, ...queryParams} = props
|
|
404
|
-
const params = queryString.stringify(queryParams);
|
|
405
|
-
const result = await api.${verb}<${genericsTypes}>(\`${route}?\${params}\`)
|
|
406
|
-
return result.data;
|
|
407
|
-
}
|
|
408
|
-
|
|
409
|
-
use${componentName}Query.baseKey = (): QueryKey => ["${componentName.toLowerCase()}"];
|
|
410
|
-
|
|
411
|
-
use${componentName}Query.queryKey = (params: ${componentName}Params): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
412
|
-
|
|
413
|
-
type ${componentName}QueryProps<T = ${genericsTypes}> = {
|
|
414
|
-
options?: UseQueryOptions<${genericsTypes}, AxiosError, T, any>
|
|
415
|
-
} & ${componentName}Params
|
|
416
|
-
|
|
417
|
-
export function use${componentName}Query<T = ${genericsTypes}>({ options = {}, ...props }: ${componentName}QueryProps<T>) {
|
|
418
|
-
return useQuery(use${componentName}Query.queryKey(props), async () => use${componentName}Query.fetch(props), { enabled: !!props.${paramsInPath.join(' && !!props.')}, ...options }
|
|
419
|
-
);}
|
|
420
|
-
|
|
421
|
-
type ${componentName}MutationProps<T> = {
|
|
422
|
-
options?: UseMutationOptions<${genericsTypes}, AxiosError, ${componentName}Params, T>
|
|
423
|
-
}
|
|
424
|
-
|
|
425
|
-
export function use${componentName}Mutation<T = ${genericsTypes}>(props?: ${componentName}MutationProps<T>) {
|
|
426
|
-
return useMutation(async (data) => {
|
|
427
|
-
const {${paramsInPath.join(', ')}, ...queryParams} = data
|
|
428
|
-
const params = queryString.stringify(queryParams);
|
|
429
|
-
const result = await api.${verb}<${genericsTypes}>(\`${route}?\${params}\`)
|
|
430
|
-
return result.data
|
|
431
|
-
},
|
|
432
|
-
props?.options
|
|
433
|
-
)};`;
|
|
434
|
-
}
|
|
435
|
-
if (!requestBodyComponent && !paramsInPath.length && !queryParam) {
|
|
436
|
-
output += `
|
|
437
|
-
use${componentName}Query.baseKey = (): QueryKey => ["${componentName.toLowerCase()}"];
|
|
438
|
-
use${componentName}Query.queryKey = (): QueryKey => use${componentName}Query.baseKey()
|
|
439
|
-
|
|
440
|
-
use${componentName}Query.fetch = async () => {
|
|
441
|
-
const result = await api.${verb}<${genericsTypes}>(\`${route}\`);
|
|
442
|
-
return result.data;
|
|
443
|
-
}
|
|
444
|
-
|
|
445
|
-
type ${componentName}QueryProps<T = ${genericsTypes}> = {
|
|
446
|
-
options?: UseQueryOptions<${genericsTypes}, AxiosError, T, any>
|
|
447
|
-
}
|
|
448
|
-
|
|
449
|
-
export function use${componentName}Query<T = ${genericsTypes}>(props?: ${componentName}QueryProps<T>) {
|
|
450
|
-
return useQuery(use${componentName}Query.queryKey(), use${componentName}Query.fetch, props?.options
|
|
451
|
-
);}
|
|
452
|
-
|
|
453
|
-
type ${componentName}MutationProps<T> = {
|
|
454
|
-
options?: UseMutationOptions<${genericsTypes}, AxiosError, void, T>
|
|
455
|
-
}
|
|
456
|
-
export function use${componentName}Mutation<T = ${genericsTypes}>(props?: ${componentName}MutationProps<T>) {
|
|
457
|
-
return useMutation(async () => {
|
|
458
|
-
const result = await api.${verb}<${genericsTypes}>(\`${route}\`);
|
|
459
|
-
return result.data;
|
|
460
|
-
},
|
|
461
|
-
props?.options
|
|
462
|
-
)};
|
|
463
|
-
`;
|
|
464
|
-
}
|
|
465
|
-
if (!requestBodyComponent && !paramsInPath.length && queryParam) {
|
|
466
|
-
output += `
|
|
467
|
-
type ${componentName}Params = {
|
|
468
|
-
${queryParamsType}
|
|
469
|
-
}
|
|
470
|
-
|
|
471
|
-
use${componentName}Query.fetch = async (props: ${componentName}Params) => {
|
|
472
|
-
const params = queryString.stringify({${queryParams
|
|
473
|
-
.map((param) => `${param.name}: props.${param.name}`)
|
|
474
|
-
.join(',')}});
|
|
475
|
-
const result = await api.${verb}<${genericsTypes}>(\`${route}?\${params}\`)
|
|
476
|
-
return result.data;
|
|
477
|
-
}
|
|
478
|
-
|
|
479
|
-
use${componentName}Query.baseKey = (): QueryKey => ["${componentName.toLowerCase()}"];
|
|
480
|
-
use${componentName}Query.queryKey = (params: ${componentName}Params ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
type ${componentName}QueryProps<T = ${genericsTypes}> = {
|
|
484
|
-
options?: UseQueryOptions<${genericsTypes}, AxiosError, T, any>
|
|
485
|
-
} & ${componentName}Params
|
|
486
|
-
|
|
487
|
-
export function use${componentName}Query<T = ${genericsTypes}>({ options = {}, ...props }: ${componentName}QueryProps<T>) {
|
|
488
|
-
return useQuery(use${componentName}Query.queryKey(props), async () => use${componentName}Query.fetch(props),
|
|
489
|
-
{
|
|
490
|
-
enabled: !!props.${queryParams.map((param) => param.name).join(' && !!props.')},
|
|
491
|
-
...options
|
|
492
|
-
}
|
|
493
|
-
);}
|
|
494
|
-
|
|
495
|
-
type ${componentName}MutationProps<T> = {
|
|
496
|
-
options?: UseMutationOptions<${genericsTypes}, AxiosError, ${componentName}Params, T>
|
|
497
|
-
}
|
|
498
|
-
|
|
499
|
-
export function use${componentName}Mutation<T = ${genericsTypes}>(props?: ${componentName}MutationProps<T>) {
|
|
500
|
-
return useMutation(async (data) => {
|
|
501
|
-
const params = queryString.stringify({${queryParams
|
|
502
|
-
.map((param) => `${param.name}: data.${param.name}`)
|
|
503
|
-
.join(',')}});
|
|
504
|
-
const result = await api.${verb}<${genericsTypes}>(\`${route}?\${params}\`)
|
|
505
|
-
return result.data;
|
|
506
|
-
},
|
|
507
|
-
props?.options
|
|
508
|
-
)};`;
|
|
509
|
-
}
|
|
510
|
-
if (requestBodyComponent && !paramsInPath.length && !queryParam) {
|
|
511
|
-
output += `
|
|
512
|
-
use${componentName}Query.fetch = async (body:${requestBodyComponent}) => {
|
|
513
|
-
const result = await api.${verb}<${genericsTypes}>(\`${route}\`, body)
|
|
514
|
-
return result.data
|
|
515
|
-
}
|
|
516
|
-
|
|
517
|
-
use${componentName}Query.baseKey = (): QueryKey => ["${componentName.toLowerCase()}"];
|
|
518
|
-
use${componentName}Query.queryKey = (params:${requestBodyComponent}): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
type ${componentName}QueryProps<T = ${genericsTypes}> = {
|
|
522
|
-
options?: UseQueryOptions<${genericsTypes}, AxiosError, T, any>
|
|
523
|
-
} & ${requestBodyComponent}
|
|
524
|
-
|
|
525
|
-
export function use${componentName}Query<T = ${genericsTypes}>({ options = {}, ...body }: ${componentName}QueryProps<T>) {
|
|
526
|
-
return useQuery(use${componentName}Query.queryKey(body), async () => use${componentName}Query.fetch(body), options
|
|
527
|
-
);}
|
|
528
|
-
|
|
529
|
-
type ${componentName}MutationProps<T> = {
|
|
530
|
-
options?: UseMutationOptions<${genericsTypes}, AxiosError, ${requestBodyComponent}, T>
|
|
531
|
-
}
|
|
532
|
-
export function use${componentName}Mutation<T = ${genericsTypes}>(props?: ${componentName}MutationProps<T>) {
|
|
533
|
-
return useMutation(async (body) => {
|
|
534
|
-
const result = await api.${verb}<${genericsTypes}>(\`${route}\`, body)
|
|
535
|
-
return result.data
|
|
536
|
-
},
|
|
537
|
-
props?.options
|
|
538
|
-
)};`;
|
|
539
|
-
}
|
|
540
|
-
if (requestBodyComponent && paramsInPath.length && !queryParam) {
|
|
541
|
-
output += `
|
|
542
|
-
// HDHD
|
|
543
|
-
type ${componentName}Params = {${paramsTypes}} & ${requestBodyComponent}
|
|
544
|
-
|
|
545
|
-
use${componentName}Query.fetch = async (props: ${componentName}Params) => {
|
|
546
|
-
const {${paramsInPath.join(', ')}, ...body} = props
|
|
547
|
-
const result = await api.${verb}<${genericsTypes}>(\`${route}\`, body)
|
|
548
|
-
return result.data
|
|
549
|
-
}
|
|
550
|
-
|
|
551
|
-
use${componentName}Query.baseKey = (): QueryKey => ["${componentName.toLowerCase()}"];
|
|
552
|
-
use${componentName}Query.queryKey = (params: ${componentName}Params ): QueryKey => [...use${componentName}Query.baseKey(), params];
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
type ${componentName}QueryProps<T = ${genericsTypes}> = {
|
|
556
|
-
options?: UseQueryOptions<${genericsTypes}, AxiosError, T, any>
|
|
557
|
-
} & ${componentName}Params
|
|
558
|
-
|
|
559
|
-
export function use${componentName}Query<T = ${genericsTypes}>({ options = {}, ...props }: ${componentName}QueryProps<T>) {
|
|
560
|
-
return useQuery(use${componentName}Query.queryKey(props), async () => use${componentName}Query.fetch(props), { enabled: !!props.${paramsInPath.join(' && !!props.')}, ...options }
|
|
561
|
-
);}
|
|
562
|
-
|
|
563
|
-
type ${componentName}MutationProps<T> = {
|
|
564
|
-
options?: UseMutationOptions<${genericsTypes}, AxiosError,${componentName}Params, T>
|
|
565
|
-
}
|
|
566
|
-
export function use${componentName}Mutation<T = ${genericsTypes}>(props?: ${componentName}MutationProps<T>) {
|
|
567
|
-
return useMutation(async (body) => use${componentName}Query.fetch(body),
|
|
568
|
-
props?.options
|
|
569
|
-
)};`;
|
|
570
|
-
}
|
|
571
|
-
if (requestBodyComponent && queryParam) {
|
|
572
|
-
output += `// TODO: CODEGEN DOES NOT SUPPORT QUERYPARAM AND REQUESTBODY`;
|
|
573
|
-
}
|
|
574
|
-
return output;
|
|
575
|
-
};
|
|
576
|
-
/**
|
|
577
|
-
* Main entry of the generator. Generate react-query component from openAPI.
|
|
578
|
-
*/
|
|
579
|
-
const importOpenApi = async ({ data, format }) => {
|
|
580
|
-
const operationIds = [];
|
|
581
|
-
let specs = await importSpecs(data, format);
|
|
582
|
-
resolveDiscriminator(specs);
|
|
583
|
-
let output = `
|
|
584
|
-
import { useQuery, useMutation, UseQueryOptions, UseMutationOptions, QueryKey } from 'react-query';
|
|
585
|
-
import queryString from 'query-string';
|
|
586
|
-
import {AxiosError} from 'axios';
|
|
587
|
-
import { api } from 'api';
|
|
588
|
-
`;
|
|
589
|
-
output += '\n\n// SCEHMAS\n';
|
|
590
|
-
output += generateSchemasDefinition(specs.components && specs.components.schemas);
|
|
591
|
-
output += '\n\n// RESPONSES\n';
|
|
592
|
-
output += generateResponsesDefinition(specs.components && specs.components.responses);
|
|
593
|
-
output += '\n\n// REQUEST BODIES\n';
|
|
594
|
-
output += generateRequestBodiesDefinition(specs.components && specs.components.requestBodies);
|
|
595
|
-
output += '\n\n// HOOKS\n';
|
|
596
|
-
Object.entries(specs.paths).forEach(([route, verbs]) => {
|
|
597
|
-
Object.entries(verbs).forEach(([verb, operation]) => {
|
|
598
|
-
if (['get', 'post', 'patch', 'put', 'delete'].includes(verb) && !operation.deprecated) {
|
|
599
|
-
output += generateRestfulComponent(operation, verb, route, operationIds, verbs.parameters, specs.components);
|
|
600
|
-
}
|
|
601
|
-
});
|
|
602
|
-
});
|
|
603
|
-
return output;
|
|
604
|
-
};
|
|
605
|
-
export default importOpenApi;
|
package/lib/types.js
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|