@openapi-qraft/tanstack-query-react-plugin 2.0.0-next.8 → 2.0.0
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/CHANGELOG.md +124 -0
- package/dist/generateCode.d.ts +3 -3
- package/dist/generateCode.d.ts.map +1 -1
- package/dist/generateCode.js +3 -3
- package/dist/generateCode.js.map +1 -1
- package/dist/lib/createOperationCommonTSDoc.d.ts +3 -0
- package/dist/lib/createOperationCommonTSDoc.d.ts.map +1 -0
- package/dist/lib/createOperationCommonTSDoc.js +8 -0
- package/dist/lib/createOperationCommonTSDoc.js.map +1 -0
- package/dist/plugin.d.ts.map +1 -1
- package/dist/plugin.js +4 -1
- package/dist/plugin.js.map +1 -1
- package/dist/ts-factory/filterUnusedTypes.d.ts +9 -0
- package/dist/ts-factory/filterUnusedTypes.d.ts.map +1 -0
- package/dist/ts-factory/filterUnusedTypes.js +34 -0
- package/dist/ts-factory/filterUnusedTypes.js.map +1 -0
- package/dist/ts-factory/getClientFactory.d.ts +1 -1
- package/dist/ts-factory/getClientFactory.d.ts.map +1 -1
- package/dist/ts-factory/getClientFactory.js +1 -1
- package/dist/ts-factory/getClientFactory.js.map +1 -1
- package/dist/ts-factory/getIndexFactory.d.ts +1 -1
- package/dist/ts-factory/getIndexFactory.d.ts.map +1 -1
- package/dist/ts-factory/getIndexFactory.js +2 -2
- package/dist/ts-factory/getIndexFactory.js.map +1 -1
- package/dist/ts-factory/getServiceFactory.d.ts +5 -3
- package/dist/ts-factory/getServiceFactory.d.ts.map +1 -1
- package/dist/ts-factory/getServiceFactory.js +124 -72
- package/dist/ts-factory/getServiceFactory.js.map +1 -1
- package/dist/ts-factory/getServiceIndexFactory.d.ts +3 -3
- package/dist/ts-factory/getServiceIndexFactory.d.ts.map +1 -1
- package/dist/ts-factory/getServiceIndexFactory.js +1 -1
- package/dist/ts-factory/getServiceIndexFactory.js.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationFetchInfiniteQuery.d.ts.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationFetchInfiniteQuery.js +26 -67
- package/dist/ts-factory/service-operation.generated/ServiceOperationFetchInfiniteQuery.js.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationFetchQuery.d.ts.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationFetchQuery.js +16 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationFetchQuery.js.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationGetInfiniteQueryData.d.ts.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationGetInfiniteQueryData.js +6 -10
- package/dist/ts-factory/service-operation.generated/ServiceOperationGetInfiniteQueryData.js.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationGetQueryData.d.ts.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationGetQueryData.js +6 -10
- package/dist/ts-factory/service-operation.generated/ServiceOperationGetQueryData.js.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationGetQueryState.d.ts.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationGetQueryState.js +6 -10
- package/dist/ts-factory/service-operation.generated/ServiceOperationGetQueryState.js.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationMutationFn.d.ts.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationMutationFn.js +7 -4
- package/dist/ts-factory/service-operation.generated/ServiceOperationMutationFn.js.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationQueryFn.d.ts.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationQueryFn.js +11 -17
- package/dist/ts-factory/service-operation.generated/ServiceOperationQueryFn.js.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationSetQueryData.d.ts.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationSetQueryData.js +9 -3
- package/dist/ts-factory/service-operation.generated/ServiceOperationSetQueryData.js.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationUseMutation.d.ts.map +1 -1
- package/dist/ts-factory/service-operation.generated/ServiceOperationUseMutation.js +12 -15
- package/dist/ts-factory/service-operation.generated/ServiceOperationUseMutation.js.map +1 -1
- package/dist/ts-factory/tsdoc/createOperationMethodTSDocExample.d.ts +6 -0
- package/dist/ts-factory/tsdoc/createOperationMethodTSDocExample.d.ts.map +1 -0
- package/dist/ts-factory/tsdoc/createOperationMethodTSDocExample.js +31 -0
- package/dist/ts-factory/tsdoc/createOperationMethodTSDocExample.js.map +1 -0
- package/dist/ts-factory/tsdoc/createUseInfiniteQueryOperationTSDocExample.d.ts +5 -0
- package/dist/ts-factory/tsdoc/createUseInfiniteQueryOperationTSDocExample.d.ts.map +1 -0
- package/dist/ts-factory/tsdoc/createUseInfiniteQueryOperationTSDocExample.js +53 -0
- package/dist/ts-factory/tsdoc/createUseInfiniteQueryOperationTSDocExample.js.map +1 -0
- package/dist/ts-factory/tsdoc/createUseIsFetchingOperationTSDocExample.d.ts +3 -0
- package/dist/ts-factory/tsdoc/createUseIsFetchingOperationTSDocExample.d.ts.map +1 -0
- package/dist/ts-factory/tsdoc/createUseIsFetchingOperationTSDocExample.js +41 -0
- package/dist/ts-factory/tsdoc/createUseIsFetchingOperationTSDocExample.js.map +1 -0
- package/dist/ts-factory/tsdoc/createUseIsMutatingOperationTSDocExample.d.ts +3 -0
- package/dist/ts-factory/tsdoc/createUseIsMutatingOperationTSDocExample.d.ts.map +1 -0
- package/dist/ts-factory/tsdoc/createUseIsMutatingOperationTSDocExample.js +41 -0
- package/dist/ts-factory/tsdoc/createUseIsMutatingOperationTSDocExample.js.map +1 -0
- package/dist/ts-factory/tsdoc/createUseMutationOperationTSDocExample.d.ts +3 -0
- package/dist/ts-factory/tsdoc/createUseMutationOperationTSDocExample.d.ts.map +1 -0
- package/dist/ts-factory/tsdoc/createUseMutationOperationTSDocExample.js +44 -0
- package/dist/ts-factory/tsdoc/createUseMutationOperationTSDocExample.js.map +1 -0
- package/dist/ts-factory/tsdoc/createUseMutationStateOperationTSDocExample.d.ts +3 -0
- package/dist/ts-factory/tsdoc/createUseMutationStateOperationTSDocExample.d.ts.map +1 -0
- package/dist/ts-factory/tsdoc/createUseMutationStateOperationTSDocExample.js +55 -0
- package/dist/ts-factory/tsdoc/createUseMutationStateOperationTSDocExample.js.map +1 -0
- package/dist/ts-factory/tsdoc/createUseQueriesOperationTSDocExample.d.ts +3 -0
- package/dist/ts-factory/tsdoc/createUseQueriesOperationTSDocExample.d.ts.map +1 -0
- package/dist/ts-factory/tsdoc/createUseQueriesOperationTSDocExample.js +88 -0
- package/dist/ts-factory/tsdoc/createUseQueriesOperationTSDocExample.js.map +1 -0
- package/dist/ts-factory/tsdoc/createUseQueryOperationTSDocExample.d.ts +3 -0
- package/dist/ts-factory/tsdoc/createUseQueryOperationTSDocExample.d.ts.map +1 -0
- package/dist/ts-factory/tsdoc/createUseQueryOperationTSDocExample.js +37 -0
- package/dist/ts-factory/tsdoc/createUseQueryOperationTSDocExample.js.map +1 -0
- package/dist/ts-factory/tsdoc/createUseSuspenseInfiniteQueryOperationTSDocExample.d.ts +3 -0
- package/dist/ts-factory/tsdoc/createUseSuspenseInfiniteQueryOperationTSDocExample.d.ts.map +1 -0
- package/dist/ts-factory/tsdoc/createUseSuspenseInfiniteQueryOperationTSDocExample.js +39 -0
- package/dist/ts-factory/tsdoc/createUseSuspenseInfiniteQueryOperationTSDocExample.js.map +1 -0
- package/dist/ts-factory/tsdoc/lib/createOperationMethodCallExpressionExampleNode.d.ts +7 -0
- package/dist/ts-factory/tsdoc/lib/createOperationMethodCallExpressionExampleNode.d.ts.map +1 -0
- package/dist/ts-factory/tsdoc/lib/createOperationMethodCallExpressionExampleNode.js +6 -0
- package/dist/ts-factory/tsdoc/lib/createOperationMethodCallExpressionExampleNode.js.map +1 -0
- package/dist/ts-factory/tsdoc/lib/createOperationMethodParametersExampleNodes.d.ts +4 -0
- package/dist/ts-factory/tsdoc/lib/createOperationMethodParametersExampleNodes.d.ts.map +1 -0
- package/dist/ts-factory/tsdoc/lib/createOperationMethodParametersExampleNodes.js +47 -0
- package/dist/ts-factory/tsdoc/lib/createOperationMethodParametersExampleNodes.js.map +1 -0
- package/package.json +6 -6
- package/src/generateCode.ts +8 -8
- package/src/lib/createOperationCommonTSDoc.ts +11 -0
- package/src/plugin.ts +8 -3
- package/src/ts-factory/filterUnusedTypes.ts +49 -0
- package/src/ts-factory/getClientFactory.ts +2 -2
- package/src/ts-factory/getIndexFactory.ts +13 -4
- package/src/ts-factory/getServiceFactory.ts +213 -139
- package/src/ts-factory/getServiceIndexFactory.ts +7 -7
- package/src/ts-factory/service-operation.generated/ServiceOperationFetchInfiniteQuery.ts +101 -190
- package/src/ts-factory/service-operation.generated/ServiceOperationFetchQuery.ts +80 -0
- package/src/ts-factory/service-operation.generated/ServiceOperationGetInfiniteQueryData.ts +28 -41
- package/src/ts-factory/service-operation.generated/ServiceOperationGetQueryData.ts +28 -41
- package/src/ts-factory/service-operation.generated/ServiceOperationGetQueryState.ts +28 -41
- package/src/ts-factory/service-operation.generated/ServiceOperationMutationFn.ts +23 -22
- package/src/ts-factory/service-operation.generated/ServiceOperationQueryFn.ts +49 -70
- package/src/ts-factory/service-operation.generated/ServiceOperationSetQueryData.ts +34 -10
- package/src/ts-factory/service-operation.generated/ServiceOperationUseMutation.ts +42 -59
- package/src/ts-factory/tsdoc/createOperationMethodTSDocExample.ts +65 -0
- package/src/ts-factory/tsdoc/createUseInfiniteQueryOperationTSDocExample.ts +135 -0
- package/src/ts-factory/tsdoc/createUseIsFetchingOperationTSDocExample.ts +81 -0
- package/src/ts-factory/tsdoc/createUseIsMutatingOperationTSDocExample.ts +74 -0
- package/src/ts-factory/tsdoc/createUseMutationOperationTSDocExample.ts +88 -0
- package/src/ts-factory/tsdoc/createUseMutationStateOperationTSDocExample.ts +154 -0
- package/src/ts-factory/tsdoc/createUseQueriesOperationTSDocExample.ts +292 -0
- package/src/ts-factory/tsdoc/createUseQueryOperationTSDocExample.ts +76 -0
- package/src/ts-factory/tsdoc/createUseSuspenseInfiniteQueryOperationTSDocExample.ts +63 -0
- package/src/ts-factory/tsdoc/lib/createOperationMethodCallExpressionExampleNode.ts +28 -0
- package/src/ts-factory/tsdoc/lib/createOperationMethodParametersExampleNodes.ts +83 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createOperationMethodTSDocExample.js","sourceRoot":"","sources":["../../../src/ts-factory/tsdoc/createOperationMethodTSDocExample.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,2CAA2C,EAAE,MAAM,kDAAkD,CAAC;AAC/G,OAAO,EAAE,wCAAwC,EAAE,MAAM,+CAA+C,CAAC;AACzG,OAAO,EAAE,wCAAwC,EAAE,MAAM,+CAA+C,CAAC;AACzG,OAAO,EAAE,sCAAsC,EAAE,MAAM,6CAA6C,CAAC;AACrG,OAAO,EAAE,2CAA2C,EAAE,MAAM,kDAAkD,CAAC;AAC/G,OAAO,EAAE,qCAAqC,EAAE,MAAM,4CAA4C,CAAC;AACnG,OAAO,EAAE,mCAAmC,EAAE,MAAM,0CAA0C,CAAC;AAC/F,OAAO,EAAE,mDAAmD,EAAE,MAAM,0DAA0D,CAAC;AAE/H,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAC/C,SAA2B,EAC3B,EACE,mBAAmB,EACnB,mBAAmB,GAIpB,EACD,EAAE;IACF,QAAQ,mBAAmB,EAAE,CAAC;QAC5B,KAAK,UAAU;YACb,OAAO,mCAAmC,CACxC,SAAS,EACT,mBAAmB,CACpB,CAAC;QACJ,KAAK,aAAa;YAChB,OAAO,sCAAsC,CAC3C,SAAS,EACT,mBAAmB,CACpB,CAAC;QACJ,KAAK,kBAAkB;YACrB,OAAO,2CAA2C,CAChD,SAAS,EACT,mBAAmB,CACpB,CAAC;QACJ,KAAK,eAAe;YAClB,OAAO,wCAAwC,CAC7C,SAAS,EACT,mBAAmB,CACpB,CAAC;QACJ,KAAK,eAAe;YAClB,OAAO,wCAAwC,CAC7C,SAAS,EACT,mBAAmB,CACpB,CAAC;QACJ,KAAK,kBAAkB;YACrB,OAAO,2CAA2C,CAChD,SAAS,EACT,mBAAmB,CACpB,CAAC;QACJ,KAAK,YAAY;YACf,OAAO,qCAAqC,CAC1C,SAAS,EACT,mBAAmB,CACpB,CAAC;QACJ,KAAK,0BAA0B;YAC7B,OAAO,mDAAmD,CACxD,SAAS,EACT,mBAAmB,CACpB,CAAC;QACJ;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC,CAAC"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
|
|
2
|
+
import ts from 'typescript';
|
|
3
|
+
export declare const createUseInfiniteQueryOperationTSDocExample: (operation: ServiceOperation, serviceVariableName: string) => string[];
|
|
4
|
+
export declare function createInfiniteQueryOptionsArgumentExamplePropertyAssignmentNodes(operation: ServiceOperation): ts.PropertyAssignment[];
|
|
5
|
+
//# sourceMappingURL=createUseInfiniteQueryOperationTSDocExample.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createUseInfiniteQueryOperationTSDocExample.d.ts","sourceRoot":"","sources":["../../../src/ts-factory/tsdoc/createUseInfiniteQueryOperationTSDocExample.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAC;AAErF,OAAO,EAAE,MAAM,YAAY,CAAC;AAK5B,eAAO,MAAM,2CAA2C,cAC3C,gBAAgB,uBACN,MAAM,KAC1B,MAAM,EAmDR,CAAC;AAEF,wBAAgB,gEAAgE,CAC9E,SAAS,EAAE,gBAAgB,GAC1B,EAAE,CAAC,kBAAkB,EAAE,CAqEzB"}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import camelcase from 'camelcase';
|
|
2
|
+
import ts from 'typescript';
|
|
3
|
+
import { astToString } from '../astToString.js';
|
|
4
|
+
import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
|
|
5
|
+
import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
|
|
6
|
+
export const createUseInfiniteQueryOperationTSDocExample = (operation, serviceVariableName) => {
|
|
7
|
+
const factory = ts.factory;
|
|
8
|
+
const commonTSDoc = [
|
|
9
|
+
'Performs asynchronous data fetching with support for infinite scrolling scenarios.',
|
|
10
|
+
'Manages paginated data and provides utilities for fetching additional pages.',
|
|
11
|
+
'',
|
|
12
|
+
'@see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useInfiniteQuery|`useInfiniteQuery(...)` documentation}',
|
|
13
|
+
'',
|
|
14
|
+
];
|
|
15
|
+
return [
|
|
16
|
+
...commonTSDoc,
|
|
17
|
+
'@example Infinite Query',
|
|
18
|
+
'```ts',
|
|
19
|
+
...('const { data, isLoading, fetchNextPage } = ' +
|
|
20
|
+
astToString(createOperationMethodCallExpressionExampleNode(operation, {
|
|
21
|
+
serviceVariableName,
|
|
22
|
+
operationMethodName: 'useInfiniteQuery',
|
|
23
|
+
}, [
|
|
24
|
+
factory.createObjectLiteralExpression(createOperationMethodParametersExampleNodes({
|
|
25
|
+
...operation,
|
|
26
|
+
parameters: operation.parameters?.filter((parameter) => parameter.in === 'query' ? parameter.required : true),
|
|
27
|
+
}), true),
|
|
28
|
+
factory.createObjectLiteralExpression(createInfiniteQueryOptionsArgumentExamplePropertyAssignmentNodes(operation), true),
|
|
29
|
+
])))
|
|
30
|
+
.trim()
|
|
31
|
+
.split('\n'),
|
|
32
|
+
'',
|
|
33
|
+
'console.log(data);',
|
|
34
|
+
'fetchNextPage(); // Fetch the next page',
|
|
35
|
+
'```',
|
|
36
|
+
];
|
|
37
|
+
};
|
|
38
|
+
export function createInfiniteQueryOptionsArgumentExamplePropertyAssignmentNodes(operation) {
|
|
39
|
+
const factory = ts.factory;
|
|
40
|
+
return [
|
|
41
|
+
factory.createPropertyAssignment(factory.createIdentifier('initialPageParam'), factory.createObjectLiteralExpression(createOperationMethodParametersExampleNodes({
|
|
42
|
+
...operation,
|
|
43
|
+
parameters: operation.parameters?.filter((parameter) => parameter.in === 'query'),
|
|
44
|
+
}, (operationParameter) => camelcase(`initial-${operationParameter.name}`)), true)),
|
|
45
|
+
factory.createPropertyAssignment(factory.createIdentifier('getNextPageParam'), factory.createArrowFunction(undefined, undefined, [
|
|
46
|
+
factory.createParameterDeclaration(undefined, undefined, factory.createIdentifier('lastPage'), undefined, undefined, undefined),
|
|
47
|
+
factory.createParameterDeclaration(undefined, undefined, factory.createIdentifier('allPages'), undefined, undefined, undefined),
|
|
48
|
+
factory.createParameterDeclaration(undefined, undefined, factory.createIdentifier('lastPageParam'), undefined, undefined, undefined),
|
|
49
|
+
factory.createParameterDeclaration(undefined, undefined, factory.createIdentifier('allPageParams'), undefined, undefined, undefined),
|
|
50
|
+
], undefined, factory.createToken(ts.SyntaxKind.EqualsGreaterThanToken), factory.createCallExpression(factory.createIdentifier('getNextPageParams'), undefined, [factory.createIdentifier('lastPage')]))),
|
|
51
|
+
];
|
|
52
|
+
}
|
|
53
|
+
//# sourceMappingURL=createUseInfiniteQueryOperationTSDocExample.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createUseInfiniteQueryOperationTSDocExample.js","sourceRoot":"","sources":["../../../src/ts-factory/tsdoc/createUseInfiniteQueryOperationTSDocExample.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,8CAA8C,EAAE,MAAM,yDAAyD,CAAC;AACzH,OAAO,EAAE,2CAA2C,EAAE,MAAM,sDAAsD,CAAC;AAEnH,MAAM,CAAC,MAAM,2CAA2C,GAAG,CACzD,SAA2B,EAC3B,mBAA2B,EACjB,EAAE;IACZ,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC;IAE3B,MAAM,WAAW,GAAG;QAClB,oFAAoF;QACpF,8EAA8E;QAC9E,EAAE;QACF,8HAA8H;QAC9H,EAAE;KACH,CAAC;IAEF,OAAO;QACL,GAAG,WAAW;QACd,yBAAyB;QACzB,OAAO;QACP,GAAG,CACD,6CAA6C;YAC7C,WAAW,CACT,8CAA8C,CAC5C,SAAS,EACT;gBACE,mBAAmB;gBACnB,mBAAmB,EAAE,kBAAkB;aACxC,EACD;gBACE,OAAO,CAAC,6BAA6B,CACnC,2CAA2C,CAAC;oBAC1C,GAAG,SAAS;oBACZ,UAAU,EAAE,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CACrD,SAAS,CAAC,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CACrD;iBACF,CAAC,EACF,IAAI,CACL;gBACD,OAAO,CAAC,6BAA6B,CACnC,gEAAgE,CAC9D,SAAS,CACV,EACD,IAAI,CACL;aACF,CACF,CACF,CACF;aACE,IAAI,EAAE;aACN,KAAK,CAAC,IAAI,CAAC;QACd,EAAE;QACF,oBAAoB;QACpB,yCAAyC;QACzC,KAAK;KACN,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,UAAU,gEAAgE,CAC9E,SAA2B;IAE3B,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC;IAE3B,OAAO;QACL,OAAO,CAAC,wBAAwB,CAC9B,OAAO,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,EAC5C,OAAO,CAAC,6BAA6B,CACnC,2CAA2C,CACzC;YACE,GAAG,SAAS;YACZ,UAAU,EAAE,SAAS,CAAC,UAAU,EAAE,MAAM,CACtC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,OAAO,CACxC;SACF,EACD,CAAC,kBAAkB,EAAE,EAAE,CACrB,SAAS,CAAC,WAAW,kBAAkB,CAAC,IAAI,EAAE,CAAC,CAClD,EACD,IAAI,CACL,CACF;QACD,OAAO,CAAC,wBAAwB,CAC9B,OAAO,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,EAC5C,OAAO,CAAC,mBAAmB,CACzB,SAAS,EACT,SAAS,EACT;YACE,OAAO,CAAC,0BAA0B,CAChC,SAAS,EACT,SAAS,EACT,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,EACpC,SAAS,EACT,SAAS,EACT,SAAS,CACV;YACD,OAAO,CAAC,0BAA0B,CAChC,SAAS,EACT,SAAS,EACT,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,EACpC,SAAS,EACT,SAAS,EACT,SAAS,CACV;YACD,OAAO,CAAC,0BAA0B,CAChC,SAAS,EACT,SAAS,EACT,OAAO,CAAC,gBAAgB,CAAC,eAAe,CAAC,EACzC,SAAS,EACT,SAAS,EACT,SAAS,CACV;YACD,OAAO,CAAC,0BAA0B,CAChC,SAAS,EACT,SAAS,EACT,OAAO,CAAC,gBAAgB,CAAC,eAAe,CAAC,EACzC,SAAS,EACT,SAAS,EACT,SAAS,CACV;SACF,EACD,SAAS,EACT,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,UAAU,CAAC,sBAAsB,CAAC,EACzD,OAAO,CAAC,oBAAoB,CAC1B,OAAO,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,EAC7C,SAAS,EACT,CAAC,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CACvC,CACF,CACF;KACF,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
|
|
2
|
+
export declare const createUseIsFetchingOperationTSDocExample: (operation: ServiceOperation, serviceVariableName: string) => string[];
|
|
3
|
+
//# sourceMappingURL=createUseIsFetchingOperationTSDocExample.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createUseIsFetchingOperationTSDocExample.d.ts","sourceRoot":"","sources":["../../../src/ts-factory/tsdoc/createUseIsFetchingOperationTSDocExample.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAC;AAOrF,eAAO,MAAM,wCAAwC,cACxC,gBAAgB,uBACN,MAAM,aAuE5B,CAAC"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import camelcase from 'camelcase';
|
|
2
|
+
import ts from 'typescript';
|
|
3
|
+
import { astToString } from '../astToString.js';
|
|
4
|
+
import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
|
|
5
|
+
import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
|
|
6
|
+
export const createUseIsFetchingOperationTSDocExample = (operation, serviceVariableName) => {
|
|
7
|
+
const example = [
|
|
8
|
+
'Monitors the number of queries currently fetching, matching the provided filters.',
|
|
9
|
+
'Useful for creating loading indicators or performing actions based on active requests.',
|
|
10
|
+
'',
|
|
11
|
+
'@see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsFetching|`useIsFetching(...)` documentation}',
|
|
12
|
+
'@example Checks the total number of queries fetching from the specified service method,',
|
|
13
|
+
'both normal and infinite. If no parameters are provided, no filtering is applied.',
|
|
14
|
+
'```ts',
|
|
15
|
+
...(`const ${camelcase(operation.name + '-total')} = ` +
|
|
16
|
+
astToString(createOperationMethodCallExpressionExampleNode(operation, {
|
|
17
|
+
serviceVariableName,
|
|
18
|
+
operationMethodName: 'useIsFetching',
|
|
19
|
+
}, undefined)))
|
|
20
|
+
.trim()
|
|
21
|
+
.split('\n'),
|
|
22
|
+
'```',
|
|
23
|
+
];
|
|
24
|
+
if (operation.parameters?.length) {
|
|
25
|
+
const factory = ts.factory;
|
|
26
|
+
example.push('@example Checks the number of normal queries fetching with the specified parameters.', '```ts', ...(`const ${camelcase(operation.name + '-by-parameters-total')} = ` +
|
|
27
|
+
astToString(createOperationMethodCallExpressionExampleNode(operation, {
|
|
28
|
+
serviceVariableName,
|
|
29
|
+
operationMethodName: 'useIsFetching',
|
|
30
|
+
}, [
|
|
31
|
+
factory.createObjectLiteralExpression([
|
|
32
|
+
factory.createPropertyAssignment(factory.createIdentifier('infinite'), factory.createFalse()),
|
|
33
|
+
factory.createPropertyAssignment(factory.createIdentifier('parameters'), factory.createObjectLiteralExpression(createOperationMethodParametersExampleNodes(operation), true)),
|
|
34
|
+
], true),
|
|
35
|
+
])))
|
|
36
|
+
.trim()
|
|
37
|
+
.split('\n'), '```');
|
|
38
|
+
}
|
|
39
|
+
return example;
|
|
40
|
+
};
|
|
41
|
+
//# sourceMappingURL=createUseIsFetchingOperationTSDocExample.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createUseIsFetchingOperationTSDocExample.js","sourceRoot":"","sources":["../../../src/ts-factory/tsdoc/createUseIsFetchingOperationTSDocExample.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,8CAA8C,EAAE,MAAM,yDAAyD,CAAC;AACzH,OAAO,EAAE,2CAA2C,EAAE,MAAM,sDAAsD,CAAC;AAEnH,MAAM,CAAC,MAAM,wCAAwC,GAAG,CACtD,SAA2B,EAC3B,mBAA2B,EAC3B,EAAE;IACF,MAAM,OAAO,GAAa;QACxB,mFAAmF;QACnF,wFAAwF;QACxF,EAAE;QACF,wHAAwH;QACxH,yFAAyF;QACzF,mFAAmF;QACnF,OAAO;QACP,GAAG,CACD,SAAS,SAAS,CAAC,SAAS,CAAC,IAAI,GAAG,QAAQ,CAAC,KAAK;YAClD,WAAW,CACT,8CAA8C,CAC5C,SAAS,EACT;gBACE,mBAAmB;gBACnB,mBAAmB,EAAE,eAAe;aACrC,EACD,SAAS,CACV,CACF,CACF;aACE,IAAI,EAAE;aACN,KAAK,CAAC,IAAI,CAAC;QACd,KAAK;KACN,CAAC;IAEF,IAAI,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QACjC,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC;QAE3B,OAAO,CAAC,IAAI,CACV,sFAAsF,EACtF,OAAO,EACP,GAAG,CACD,SAAS,SAAS,CAAC,SAAS,CAAC,IAAI,GAAG,sBAAsB,CAAC,KAAK;YAChE,WAAW,CACT,8CAA8C,CAC5C,SAAS,EACT;gBACE,mBAAmB;gBACnB,mBAAmB,EAAE,eAAe;aACrC,EACD;gBACE,OAAO,CAAC,6BAA6B,CACnC;oBACE,OAAO,CAAC,wBAAwB,CAC9B,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,EACpC,OAAO,CAAC,WAAW,EAAE,CACtB;oBACD,OAAO,CAAC,wBAAwB,CAC9B,OAAO,CAAC,gBAAgB,CAAC,YAAY,CAAC,EACtC,OAAO,CAAC,6BAA6B,CACnC,2CAA2C,CAAC,SAAS,CAAC,EACtD,IAAI,CACL,CACF;iBACF,EACD,IAAI,CACL;aACF,CACF,CACF,CACF;aACE,IAAI,EAAE;aACN,KAAK,CAAC,IAAI,CAAC,EACd,KAAK,CACN,CAAC;IACJ,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC"}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import type { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
|
|
2
|
+
export declare const createUseIsMutatingOperationTSDocExample: (operation: ServiceOperation, serviceVariableName: string) => string[];
|
|
3
|
+
//# sourceMappingURL=createUseIsMutatingOperationTSDocExample.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createUseIsMutatingOperationTSDocExample.d.ts","sourceRoot":"","sources":["../../../src/ts-factory/tsdoc/createUseIsMutatingOperationTSDocExample.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAC;AAQ1F,eAAO,MAAM,wCAAwC,cACxC,gBAAgB,uBACN,MAAM,aA+D5B,CAAC"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import camelcase from 'camelcase';
|
|
2
|
+
import ts from 'typescript';
|
|
3
|
+
import { createOperationCommonTSDoc } from '../../lib/createOperationCommonTSDoc.js';
|
|
4
|
+
import { astToString } from '../astToString.js';
|
|
5
|
+
import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
|
|
6
|
+
import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
|
|
7
|
+
export const createUseIsMutatingOperationTSDocExample = (operation, serviceVariableName) => {
|
|
8
|
+
const factory = ts.factory;
|
|
9
|
+
const example = [
|
|
10
|
+
'Returns the count of currently in-progress mutations.',
|
|
11
|
+
'',
|
|
12
|
+
...createOperationCommonTSDoc(operation),
|
|
13
|
+
'@see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useIsMutating|`useIsMutating(...)` documentation}',
|
|
14
|
+
'@example Check how many mutations are currently in progress for the specified service method.',
|
|
15
|
+
'```ts',
|
|
16
|
+
...(`const ${camelcase(operation.name + '-total')} = ` +
|
|
17
|
+
astToString(createOperationMethodCallExpressionExampleNode(operation, {
|
|
18
|
+
serviceVariableName,
|
|
19
|
+
operationMethodName: 'useIsMutating',
|
|
20
|
+
}, undefined)))
|
|
21
|
+
.trim()
|
|
22
|
+
.split('\n'),
|
|
23
|
+
'```',
|
|
24
|
+
'@example Check how many mutations are currently in progress with the specified parameters.',
|
|
25
|
+
'```ts',
|
|
26
|
+
...(`const ${camelcase(operation.name + '-total')} = ` +
|
|
27
|
+
astToString(createOperationMethodCallExpressionExampleNode(operation, {
|
|
28
|
+
serviceVariableName,
|
|
29
|
+
operationMethodName: 'useIsMutating',
|
|
30
|
+
}, [
|
|
31
|
+
factory.createObjectLiteralExpression([
|
|
32
|
+
factory.createPropertyAssignment(factory.createIdentifier('parameters'), factory.createObjectLiteralExpression(createOperationMethodParametersExampleNodes(operation), true)),
|
|
33
|
+
], true),
|
|
34
|
+
])))
|
|
35
|
+
.trim()
|
|
36
|
+
.split('\n'),
|
|
37
|
+
'```',
|
|
38
|
+
];
|
|
39
|
+
return example;
|
|
40
|
+
};
|
|
41
|
+
//# sourceMappingURL=createUseIsMutatingOperationTSDocExample.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createUseIsMutatingOperationTSDocExample.js","sourceRoot":"","sources":["../../../src/ts-factory/tsdoc/createUseIsMutatingOperationTSDocExample.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,0BAA0B,EAAE,MAAM,yCAAyC,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,8CAA8C,EAAE,MAAM,yDAAyD,CAAC;AACzH,OAAO,EAAE,2CAA2C,EAAE,MAAM,sDAAsD,CAAC;AAEnH,MAAM,CAAC,MAAM,wCAAwC,GAAG,CACtD,SAA2B,EAC3B,mBAA2B,EAC3B,EAAE;IACF,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC;IAE3B,MAAM,OAAO,GAAa;QACxB,uDAAuD;QACvD,EAAE;QACF,GAAG,0BAA0B,CAAC,SAAS,CAAC;QACxC,wHAAwH;QAExH,+FAA+F;QAC/F,OAAO;QACP,GAAG,CACD,SAAS,SAAS,CAAC,SAAS,CAAC,IAAI,GAAG,QAAQ,CAAC,KAAK;YAClD,WAAW,CACT,8CAA8C,CAC5C,SAAS,EACT;gBACE,mBAAmB;gBACnB,mBAAmB,EAAE,eAAe;aACrC,EACD,SAAS,CACV,CACF,CACF;aACE,IAAI,EAAE;aACN,KAAK,CAAC,IAAI,CAAC;QACd,KAAK;QAEL,4FAA4F;QAC5F,OAAO;QACP,GAAG,CACD,SAAS,SAAS,CAAC,SAAS,CAAC,IAAI,GAAG,QAAQ,CAAC,KAAK;YAClD,WAAW,CACT,8CAA8C,CAC5C,SAAS,EACT;gBACE,mBAAmB;gBACnB,mBAAmB,EAAE,eAAe;aACrC,EACD;gBACE,OAAO,CAAC,6BAA6B,CACnC;oBACE,OAAO,CAAC,wBAAwB,CAC9B,OAAO,CAAC,gBAAgB,CAAC,YAAY,CAAC,EACtC,OAAO,CAAC,6BAA6B,CACnC,2CAA2C,CAAC,SAAS,CAAC,EACtD,IAAI,CACL,CACF;iBACF,EACD,IAAI,CACL;aACF,CACF,CACF,CACF;aACE,IAAI,EAAE;aACN,KAAK,CAAC,IAAI,CAAC;QACd,KAAK;KACN,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC"}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import type { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
|
|
2
|
+
export declare const createUseMutationOperationTSDocExample: (operation: ServiceOperation, serviceVariableName: string) => string[];
|
|
3
|
+
//# sourceMappingURL=createUseMutationOperationTSDocExample.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createUseMutationOperationTSDocExample.d.ts","sourceRoot":"","sources":["../../../src/ts-factory/tsdoc/createUseMutationOperationTSDocExample.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAC;AAM1F,eAAO,MAAM,sCAAsC,cACtC,gBAAgB,uBACN,MAAM,aA+E5B,CAAC"}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import ts from 'typescript';
|
|
2
|
+
import { astToString } from '../astToString.js';
|
|
3
|
+
import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
|
|
4
|
+
import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
|
|
5
|
+
export const createUseMutationOperationTSDocExample = (operation, serviceVariableName) => {
|
|
6
|
+
const factory = ts.factory;
|
|
7
|
+
const example = [
|
|
8
|
+
'Enables performing asynchronous data mutation operations such as POST, PUT, PATCH, or DELETE requests.',
|
|
9
|
+
'Handles loading state, optimistic updates, and error handling.',
|
|
10
|
+
'',
|
|
11
|
+
'@see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutation|`useMutation(...)` documentation}',
|
|
12
|
+
'@example Mutation with predefined parameters, e.g., for updating',
|
|
13
|
+
'```ts',
|
|
14
|
+
...('const { mutate, isPending } = ' +
|
|
15
|
+
astToString(createOperationMethodCallExpressionExampleNode(operation, {
|
|
16
|
+
serviceVariableName,
|
|
17
|
+
operationMethodName: 'useMutation',
|
|
18
|
+
}, [
|
|
19
|
+
factory.createObjectLiteralExpression(createOperationMethodParametersExampleNodes(operation), true),
|
|
20
|
+
])))
|
|
21
|
+
.trim()
|
|
22
|
+
.split('\n'),
|
|
23
|
+
'mutate(body);',
|
|
24
|
+
'```',
|
|
25
|
+
];
|
|
26
|
+
example.push('@example Mutation without predefined parameters, e.g., for creating', '```ts', ...('const { mutate, isPending } = ' +
|
|
27
|
+
astToString(createOperationMethodCallExpressionExampleNode(operation, {
|
|
28
|
+
serviceVariableName,
|
|
29
|
+
operationMethodName: 'useMutation',
|
|
30
|
+
}, undefined)))
|
|
31
|
+
.trim()
|
|
32
|
+
.split('\n'), ...astToString([
|
|
33
|
+
factory.createExpressionStatement(factory.createCallExpression(factory.createIdentifier('mutate'), undefined, [
|
|
34
|
+
factory.createObjectLiteralExpression([
|
|
35
|
+
factory.createPropertyAssignment(factory.createIdentifier('body'), factory.createIdentifier('bodyPayload')),
|
|
36
|
+
...createOperationMethodParametersExampleNodes(operation),
|
|
37
|
+
], true),
|
|
38
|
+
])),
|
|
39
|
+
])
|
|
40
|
+
.trim()
|
|
41
|
+
.split('\n'), '```');
|
|
42
|
+
return example;
|
|
43
|
+
};
|
|
44
|
+
//# sourceMappingURL=createUseMutationOperationTSDocExample.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createUseMutationOperationTSDocExample.js","sourceRoot":"","sources":["../../../src/ts-factory/tsdoc/createUseMutationOperationTSDocExample.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,8CAA8C,EAAE,MAAM,yDAAyD,CAAC;AACzH,OAAO,EAAE,2CAA2C,EAAE,MAAM,sDAAsD,CAAC;AAEnH,MAAM,CAAC,MAAM,sCAAsC,GAAG,CACpD,SAA2B,EAC3B,mBAA2B,EAC3B,EAAE;IACF,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC;IAE3B,MAAM,OAAO,GAAa;QACxB,wGAAwG;QACxG,gEAAgE;QAChE,EAAE;QACF,oHAAoH;QACpH,kEAAkE;QAClE,OAAO;QACP,GAAG,CACD,gCAAgC;YAChC,WAAW,CACT,8CAA8C,CAC5C,SAAS,EACT;gBACE,mBAAmB;gBACnB,mBAAmB,EAAE,aAAa;aACnC,EACD;gBACE,OAAO,CAAC,6BAA6B,CACnC,2CAA2C,CAAC,SAAS,CAAC,EACtD,IAAI,CACL;aACF,CACF,CACF,CACF;aACE,IAAI,EAAE;aACN,KAAK,CAAC,IAAI,CAAC;QACd,eAAe;QACf,KAAK;KACN,CAAC;IAEF,OAAO,CAAC,IAAI,CACV,qEAAqE,EACrE,OAAO,EACP,GAAG,CACD,gCAAgC;QAChC,WAAW,CACT,8CAA8C,CAC5C,SAAS,EACT;YACE,mBAAmB;YACnB,mBAAmB,EAAE,aAAa;SACnC,EACD,SAAS,CACV,CACF,CACF;SACE,IAAI,EAAE;SACN,KAAK,CAAC,IAAI,CAAC,EACd,GAAG,WAAW,CAAC;QACb,OAAO,CAAC,yBAAyB,CAC/B,OAAO,CAAC,oBAAoB,CAC1B,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAClC,SAAS,EACT;YACE,OAAO,CAAC,6BAA6B,CACnC;gBACE,OAAO,CAAC,wBAAwB,CAC9B,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAChC,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CACxC;gBACD,GAAG,2CAA2C,CAAC,SAAS,CAAC;aAC1D,EACD,IAAI,CACL;SACF,CACF,CACF;KACF,CAAC;SACC,IAAI,EAAE;SACN,KAAK,CAAC,IAAI,CAAC,EACd,KAAK,CACN,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC"}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import type { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
|
|
2
|
+
export declare const createUseMutationStateOperationTSDocExample: (operation: ServiceOperation, serviceVariableName: string) => string[];
|
|
3
|
+
//# sourceMappingURL=createUseMutationStateOperationTSDocExample.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createUseMutationStateOperationTSDocExample.d.ts","sourceRoot":"","sources":["../../../src/ts-factory/tsdoc/createUseMutationStateOperationTSDocExample.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAC;AAQ1F,eAAO,MAAM,2CAA2C,cAC3C,gBAAgB,uBACN,MAAM,aA+I5B,CAAC"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import camelcase from 'camelcase';
|
|
2
|
+
import ts from 'typescript';
|
|
3
|
+
import { createOperationCommonTSDoc } from '../../lib/createOperationCommonTSDoc.js';
|
|
4
|
+
import { astToString } from '../astToString.js';
|
|
5
|
+
import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
|
|
6
|
+
import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
|
|
7
|
+
export const createUseMutationStateOperationTSDocExample = (operation, serviceVariableName) => {
|
|
8
|
+
const factory = ts.factory;
|
|
9
|
+
const example = [
|
|
10
|
+
'Provides access to the current state of a mutation, including its status, any resulting data, and associated errors.',
|
|
11
|
+
'',
|
|
12
|
+
...createOperationCommonTSDoc(operation),
|
|
13
|
+
'@see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useMutationState|`useMutationState(...)` documentation}',
|
|
14
|
+
'@example Get all variables of all running mutations.',
|
|
15
|
+
'```ts',
|
|
16
|
+
...(`const ${camelcase(operation.name + '-pending-mutation-variables')} = ` +
|
|
17
|
+
astToString(createOperationMethodCallExpressionExampleNode(operation, {
|
|
18
|
+
serviceVariableName,
|
|
19
|
+
operationMethodName: 'useMutationState',
|
|
20
|
+
}, [
|
|
21
|
+
factory.createObjectLiteralExpression([
|
|
22
|
+
factory.createPropertyAssignment(factory.createIdentifier('filters'), factory.createObjectLiteralExpression([
|
|
23
|
+
factory.createPropertyAssignment(factory.createIdentifier('status'), factory.createStringLiteral('pending')),
|
|
24
|
+
], true)),
|
|
25
|
+
factory.createPropertyAssignment(factory.createIdentifier('select'), factory.createArrowFunction(undefined, undefined, [
|
|
26
|
+
factory.createParameterDeclaration(undefined, undefined, factory.createIdentifier('mutation'), undefined, undefined, undefined),
|
|
27
|
+
], undefined, factory.createToken(ts.SyntaxKind.EqualsGreaterThanToken), factory.createPropertyAccessExpression(factory.createPropertyAccessExpression(factory.createIdentifier('mutation'), factory.createIdentifier('state')), factory.createIdentifier('variables')))),
|
|
28
|
+
], true),
|
|
29
|
+
])))
|
|
30
|
+
.trim()
|
|
31
|
+
.split('\n'),
|
|
32
|
+
'```',
|
|
33
|
+
'@example Get all data for specific mutations via the `parameters`.',
|
|
34
|
+
'```ts',
|
|
35
|
+
...(`const ${camelcase(operation.name + '-mutation-data')} = ` +
|
|
36
|
+
astToString(createOperationMethodCallExpressionExampleNode(operation, {
|
|
37
|
+
serviceVariableName,
|
|
38
|
+
operationMethodName: 'useMutationState',
|
|
39
|
+
}, [
|
|
40
|
+
factory.createObjectLiteralExpression([
|
|
41
|
+
factory.createPropertyAssignment(factory.createIdentifier('filters'), factory.createObjectLiteralExpression([
|
|
42
|
+
factory.createPropertyAssignment(factory.createIdentifier('parameters'), factory.createObjectLiteralExpression(createOperationMethodParametersExampleNodes(operation), true)),
|
|
43
|
+
], true)),
|
|
44
|
+
factory.createPropertyAssignment(factory.createIdentifier('select'), factory.createArrowFunction(undefined, undefined, [
|
|
45
|
+
factory.createParameterDeclaration(undefined, undefined, factory.createIdentifier('mutation'), undefined, undefined, undefined),
|
|
46
|
+
], undefined, factory.createToken(ts.SyntaxKind.EqualsGreaterThanToken), factory.createPropertyAccessExpression(factory.createPropertyAccessExpression(factory.createIdentifier('mutation'), factory.createIdentifier('state')), factory.createIdentifier('data')))),
|
|
47
|
+
], true),
|
|
48
|
+
])))
|
|
49
|
+
.trim()
|
|
50
|
+
.split('\n'),
|
|
51
|
+
'```',
|
|
52
|
+
];
|
|
53
|
+
return example;
|
|
54
|
+
};
|
|
55
|
+
//# sourceMappingURL=createUseMutationStateOperationTSDocExample.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createUseMutationStateOperationTSDocExample.js","sourceRoot":"","sources":["../../../src/ts-factory/tsdoc/createUseMutationStateOperationTSDocExample.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,0BAA0B,EAAE,MAAM,yCAAyC,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,8CAA8C,EAAE,MAAM,yDAAyD,CAAC;AACzH,OAAO,EAAE,2CAA2C,EAAE,MAAM,sDAAsD,CAAC;AAEnH,MAAM,CAAC,MAAM,2CAA2C,GAAG,CACzD,SAA2B,EAC3B,mBAA2B,EAC3B,EAAE;IACF,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC;IAE3B,MAAM,OAAO,GAAa;QACxB,sHAAsH;QACtH,EAAE;QACF,GAAG,0BAA0B,CAAC,SAAS,CAAC;QACxC,8HAA8H;QAE9H,sDAAsD;QACtD,OAAO;QACP,GAAG,CACD,SAAS,SAAS,CAAC,SAAS,CAAC,IAAI,GAAG,6BAA6B,CAAC,KAAK;YACvE,WAAW,CACT,8CAA8C,CAC5C,SAAS,EACT;gBACE,mBAAmB;gBACnB,mBAAmB,EAAE,kBAAkB;aACxC,EACD;gBACE,OAAO,CAAC,6BAA6B,CACnC;oBACE,OAAO,CAAC,wBAAwB,CAC9B,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,EACnC,OAAO,CAAC,6BAA6B,CACnC;wBACE,OAAO,CAAC,wBAAwB,CAC9B,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAClC,OAAO,CAAC,mBAAmB,CAAC,SAAS,CAAC,CACvC;qBACF,EACD,IAAI,CACL,CACF;oBACD,OAAO,CAAC,wBAAwB,CAC9B,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAClC,OAAO,CAAC,mBAAmB,CACzB,SAAS,EACT,SAAS,EACT;wBACE,OAAO,CAAC,0BAA0B,CAChC,SAAS,EACT,SAAS,EACT,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,EACpC,SAAS,EACT,SAAS,EACT,SAAS,CACV;qBACF,EACD,SAAS,EACT,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,UAAU,CAAC,sBAAsB,CAAC,EACzD,OAAO,CAAC,8BAA8B,CACpC,OAAO,CAAC,8BAA8B,CACpC,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,EACpC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAClC,EACD,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,CACtC,CACF,CACF;iBACF,EACD,IAAI,CACL;aACF,CACF,CACF,CACF;aACE,IAAI,EAAE;aACN,KAAK,CAAC,IAAI,CAAC;QACd,KAAK;QAEL,oEAAoE;QACpE,OAAO;QACP,GAAG,CACD,SAAS,SAAS,CAAC,SAAS,CAAC,IAAI,GAAG,gBAAgB,CAAC,KAAK;YAC1D,WAAW,CACT,8CAA8C,CAC5C,SAAS,EACT;gBACE,mBAAmB;gBACnB,mBAAmB,EAAE,kBAAkB;aACxC,EACD;gBACE,OAAO,CAAC,6BAA6B,CACnC;oBACE,OAAO,CAAC,wBAAwB,CAC9B,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,EACnC,OAAO,CAAC,6BAA6B,CACnC;wBACE,OAAO,CAAC,wBAAwB,CAC9B,OAAO,CAAC,gBAAgB,CAAC,YAAY,CAAC,EACtC,OAAO,CAAC,6BAA6B,CACnC,2CAA2C,CACzC,SAAS,CACV,EACD,IAAI,CACL,CACF;qBACF,EACD,IAAI,CACL,CACF;oBACD,OAAO,CAAC,wBAAwB,CAC9B,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAClC,OAAO,CAAC,mBAAmB,CACzB,SAAS,EACT,SAAS,EACT;wBACE,OAAO,CAAC,0BAA0B,CAChC,SAAS,EACT,SAAS,EACT,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,EACpC,SAAS,EACT,SAAS,EACT,SAAS,CACV;qBACF,EACD,SAAS,EACT,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,UAAU,CAAC,sBAAsB,CAAC,EACzD,OAAO,CAAC,8BAA8B,CACpC,OAAO,CAAC,8BAA8B,CACpC,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,EACpC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAClC,EACD,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CACjC,CACF,CACF;iBACF,EACD,IAAI,CACL;aACF,CACF,CACF,CACF;aACE,IAAI,EAAE;aACN,KAAK,CAAC,IAAI,CAAC;QACd,KAAK;KACN,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC"}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import type { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
|
|
2
|
+
export declare const createUseQueriesOperationTSDocExample: (operation: ServiceOperation, serviceVariableName: string) => string[];
|
|
3
|
+
//# sourceMappingURL=createUseQueriesOperationTSDocExample.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createUseQueriesOperationTSDocExample.d.ts","sourceRoot":"","sources":["../../../src/ts-factory/tsdoc/createUseQueriesOperationTSDocExample.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAC;AAQ1F,eAAO,MAAM,qCAAqC,cACrC,gBAAgB,uBACN,MAAM,aAyR5B,CAAC"}
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import camelcase from 'camelcase';
|
|
2
|
+
import ts from 'typescript';
|
|
3
|
+
import { createOperationCommonTSDoc } from '../../lib/createOperationCommonTSDoc.js';
|
|
4
|
+
import { astToString } from '../astToString.js';
|
|
5
|
+
import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
|
|
6
|
+
import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
|
|
7
|
+
export const createUseQueriesOperationTSDocExample = (operation, serviceVariableName) => {
|
|
8
|
+
const factory = ts.factory;
|
|
9
|
+
const example = [
|
|
10
|
+
'Allows you to execute multiple asynchronous data fetching operations concurrently. This is especially useful for managing complex data dependencies in parallel.',
|
|
11
|
+
'',
|
|
12
|
+
...createOperationCommonTSDoc(operation),
|
|
13
|
+
'@see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQueries|`useQueries(...)` documentation}',
|
|
14
|
+
'@example Multiple queries. Returns `data`, `error`, `isSuccess` and other properties.',
|
|
15
|
+
'```ts',
|
|
16
|
+
...astToString([
|
|
17
|
+
factory.createVariableStatement(undefined, factory.createVariableDeclarationList([
|
|
18
|
+
factory.createVariableDeclaration(factory.createIdentifier(camelcase(operation.name + '-results')), undefined, undefined, createOperationMethodCallExpressionExampleNode(operation, {
|
|
19
|
+
serviceVariableName,
|
|
20
|
+
operationMethodName: 'useQueries',
|
|
21
|
+
}, [
|
|
22
|
+
factory.createObjectLiteralExpression([
|
|
23
|
+
factory.createPropertyAssignment(factory.createIdentifier('queries'), factory.createArrayLiteralExpression([
|
|
24
|
+
factory.createObjectLiteralExpression(createOperationMethodParametersExampleNodes(operation, (parameter) => camelcase(`${parameter.name}-1`)), true),
|
|
25
|
+
factory.createObjectLiteralExpression(createOperationMethodParametersExampleNodes(operation, (parameter) => camelcase(`${parameter.name}-2`)), true),
|
|
26
|
+
], true)),
|
|
27
|
+
], true),
|
|
28
|
+
])),
|
|
29
|
+
], ts.NodeFlags.Const)),
|
|
30
|
+
factory.createExpressionStatement(factory.createCallExpression(factory.createPropertyAccessExpression(factory.createIdentifier(camelcase(operation.name + '-results')), factory.createIdentifier('forEach')), undefined, [
|
|
31
|
+
factory.createArrowFunction(undefined, undefined, [
|
|
32
|
+
factory.createParameterDeclaration(undefined, undefined, factory.createObjectBindingPattern([
|
|
33
|
+
factory.createBindingElement(undefined, undefined, factory.createIdentifier('isSuccess')),
|
|
34
|
+
factory.createBindingElement(undefined, undefined, factory.createIdentifier('data')),
|
|
35
|
+
factory.createBindingElement(undefined, undefined, factory.createIdentifier('error')),
|
|
36
|
+
])),
|
|
37
|
+
], undefined, factory.createToken(ts.SyntaxKind.EqualsGreaterThanToken), factory.createCallExpression(factory.createPropertyAccessExpression(factory.createIdentifier('console'), factory.createIdentifier('log')), undefined, [
|
|
38
|
+
factory.createObjectLiteralExpression([
|
|
39
|
+
factory.createShorthandPropertyAssignment(factory.createIdentifier('isSuccess')),
|
|
40
|
+
factory.createShorthandPropertyAssignment(factory.createIdentifier('data')),
|
|
41
|
+
factory.createShorthandPropertyAssignment(factory.createIdentifier('error')),
|
|
42
|
+
], false),
|
|
43
|
+
])),
|
|
44
|
+
])),
|
|
45
|
+
])
|
|
46
|
+
.trim()
|
|
47
|
+
.split('\n'),
|
|
48
|
+
'```',
|
|
49
|
+
'@example Combined results. Only the data will be returned.',
|
|
50
|
+
'```ts',
|
|
51
|
+
...astToString([
|
|
52
|
+
factory.createVariableStatement(undefined, factory.createVariableDeclarationList([
|
|
53
|
+
factory.createVariableDeclaration(factory.createIdentifier(camelcase(operation.name + '-combined-results')), undefined, undefined, createOperationMethodCallExpressionExampleNode(operation, {
|
|
54
|
+
serviceVariableName,
|
|
55
|
+
operationMethodName: 'useQueries',
|
|
56
|
+
}, [
|
|
57
|
+
factory.createObjectLiteralExpression([
|
|
58
|
+
factory.createPropertyAssignment(factory.createIdentifier('combine'), factory.createArrowFunction(undefined, undefined, [
|
|
59
|
+
factory.createParameterDeclaration(undefined, undefined, factory.createIdentifier('results')),
|
|
60
|
+
], undefined, factory.createToken(ts.SyntaxKind.EqualsGreaterThanToken), factory.createCallExpression(factory.createPropertyAccessExpression(factory.createIdentifier('results'), factory.createIdentifier('map')), undefined, [
|
|
61
|
+
factory.createArrowFunction(undefined, undefined, [
|
|
62
|
+
factory.createParameterDeclaration(undefined, undefined, factory.createIdentifier('result')),
|
|
63
|
+
], undefined, factory.createToken(ts.SyntaxKind.EqualsGreaterThanToken), factory.createPropertyAccessExpression(factory.createIdentifier('result'), factory.createIdentifier('data'))),
|
|
64
|
+
]))),
|
|
65
|
+
factory.createPropertyAssignment(factory.createIdentifier('queries'), factory.createArrayLiteralExpression([
|
|
66
|
+
factory.createObjectLiteralExpression(createOperationMethodParametersExampleNodes(operation, (parameter) => camelcase(`${parameter.name}-1`)), true),
|
|
67
|
+
factory.createObjectLiteralExpression(createOperationMethodParametersExampleNodes(operation, (parameter) => camelcase(`${parameter.name}-2`)), true),
|
|
68
|
+
], true)),
|
|
69
|
+
], true),
|
|
70
|
+
])),
|
|
71
|
+
], ts.NodeFlags.Const)),
|
|
72
|
+
factory.createExpressionStatement(factory.createCallExpression(factory.createPropertyAccessExpression(factory.createIdentifier(camelcase(operation.name + '-combined-results')), factory.createIdentifier('forEach')), undefined, [
|
|
73
|
+
factory.createArrowFunction(undefined, undefined, [
|
|
74
|
+
factory.createParameterDeclaration(undefined, undefined, factory.createIdentifier('data')),
|
|
75
|
+
], undefined, factory.createToken(ts.SyntaxKind.EqualsGreaterThanToken), factory.createCallExpression(factory.createPropertyAccessExpression(factory.createIdentifier('console'), factory.createIdentifier('log')), undefined, [
|
|
76
|
+
factory.createObjectLiteralExpression([
|
|
77
|
+
factory.createShorthandPropertyAssignment(factory.createIdentifier('data'), undefined),
|
|
78
|
+
], false),
|
|
79
|
+
])),
|
|
80
|
+
])),
|
|
81
|
+
])
|
|
82
|
+
.trim()
|
|
83
|
+
.split('\n'),
|
|
84
|
+
'```',
|
|
85
|
+
];
|
|
86
|
+
return example;
|
|
87
|
+
};
|
|
88
|
+
//# sourceMappingURL=createUseQueriesOperationTSDocExample.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createUseQueriesOperationTSDocExample.js","sourceRoot":"","sources":["../../../src/ts-factory/tsdoc/createUseQueriesOperationTSDocExample.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,0BAA0B,EAAE,MAAM,yCAAyC,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,8CAA8C,EAAE,MAAM,yDAAyD,CAAC;AACzH,OAAO,EAAE,2CAA2C,EAAE,MAAM,sDAAsD,CAAC;AAEnH,MAAM,CAAC,MAAM,qCAAqC,GAAG,CACnD,SAA2B,EAC3B,mBAA2B,EAC3B,EAAE;IACF,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC;IAE3B,MAAM,OAAO,GAAa;QACxB,kKAAkK;QAClK,EAAE;QACF,GAAG,0BAA0B,CAAC,SAAS,CAAC;QACxC,kHAAkH;QAElH,uFAAuF;QACvF,OAAO;QACP,GAAG,WAAW,CAAC;YACb,OAAO,CAAC,uBAAuB,CAC7B,SAAS,EACT,OAAO,CAAC,6BAA6B,CACnC;gBACE,OAAO,CAAC,yBAAyB,CAC/B,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,GAAG,UAAU,CAAC,CAAC,EAChE,SAAS,EACT,SAAS,EACT,8CAA8C,CAC5C,SAAS,EACT;oBACE,mBAAmB;oBACnB,mBAAmB,EAAE,YAAY;iBAClC,EACD;oBACE,OAAO,CAAC,6BAA6B,CACnC;wBACE,OAAO,CAAC,wBAAwB,CAC9B,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,EACnC,OAAO,CAAC,4BAA4B,CAClC;4BACE,OAAO,CAAC,6BAA6B,CACnC,2CAA2C,CACzC,SAAS,EACT,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,IAAI,IAAI,CAAC,CAChD,EACD,IAAI,CACL;4BACD,OAAO,CAAC,6BAA6B,CACnC,2CAA2C,CACzC,SAAS,EACT,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,IAAI,IAAI,CAAC,CAChD,EACD,IAAI,CACL;yBACF,EACD,IAAI,CACL,CACF;qBACF,EACD,IAAI,CACL;iBACF,CACF,CACF;aACF,EACD,EAAE,CAAC,SAAS,CAAC,KAAK,CACnB,CACF;YACD,OAAO,CAAC,yBAAyB,CAC/B,OAAO,CAAC,oBAAoB,CAC1B,OAAO,CAAC,8BAA8B,CACpC,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,GAAG,UAAU,CAAC,CAAC,EAChE,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,CACpC,EACD,SAAS,EACT;gBACE,OAAO,CAAC,mBAAmB,CACzB,SAAS,EACT,SAAS,EACT;oBACE,OAAO,CAAC,0BAA0B,CAChC,SAAS,EACT,SAAS,EACT,OAAO,CAAC,0BAA0B,CAAC;wBACjC,OAAO,CAAC,oBAAoB,CAC1B,SAAS,EACT,SAAS,EACT,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,CACtC;wBACD,OAAO,CAAC,oBAAoB,CAC1B,SAAS,EACT,SAAS,EACT,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CACjC;wBACD,OAAO,CAAC,oBAAoB,CAC1B,SAAS,EACT,SAAS,EACT,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAClC;qBACF,CAAC,CACH;iBACF,EACD,SAAS,EACT,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,UAAU,CAAC,sBAAsB,CAAC,EACzD,OAAO,CAAC,oBAAoB,CAC1B,OAAO,CAAC,8BAA8B,CACpC,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,EACnC,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAChC,EACD,SAAS,EACT;oBACE,OAAO,CAAC,6BAA6B,CACnC;wBACE,OAAO,CAAC,iCAAiC,CACvC,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,CACtC;wBACD,OAAO,CAAC,iCAAiC,CACvC,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CACjC;wBACD,OAAO,CAAC,iCAAiC,CACvC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAClC;qBACF,EACD,KAAK,CACN;iBACF,CACF,CACF;aACF,CACF,CACF;SACF,CAAC;aACC,IAAI,EAAE;aACN,KAAK,CAAC,IAAI,CAAC;QACd,KAAK;QAEL,4DAA4D;QAC5D,OAAO;QACP,GAAG,WAAW,CAAC;YACb,OAAO,CAAC,uBAAuB,CAC7B,SAAS,EACT,OAAO,CAAC,6BAA6B,CACnC;gBACE,OAAO,CAAC,yBAAyB,CAC/B,OAAO,CAAC,gBAAgB,CACtB,SAAS,CAAC,SAAS,CAAC,IAAI,GAAG,mBAAmB,CAAC,CAChD,EACD,SAAS,EACT,SAAS,EACT,8CAA8C,CAC5C,SAAS,EACT;oBACE,mBAAmB;oBACnB,mBAAmB,EAAE,YAAY;iBAClC,EACD;oBACE,OAAO,CAAC,6BAA6B,CACnC;wBACE,OAAO,CAAC,wBAAwB,CAC9B,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,EACnC,OAAO,CAAC,mBAAmB,CACzB,SAAS,EACT,SAAS,EACT;4BACE,OAAO,CAAC,0BAA0B,CAChC,SAAS,EACT,SAAS,EACT,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,CACpC;yBACF,EACD,SAAS,EACT,OAAO,CAAC,WAAW,CACjB,EAAE,CAAC,UAAU,CAAC,sBAAsB,CACrC,EACD,OAAO,CAAC,oBAAoB,CAC1B,OAAO,CAAC,8BAA8B,CACpC,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,EACnC,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAChC,EACD,SAAS,EACT;4BACE,OAAO,CAAC,mBAAmB,CACzB,SAAS,EACT,SAAS,EACT;gCACE,OAAO,CAAC,0BAA0B,CAChC,SAAS,EACT,SAAS,EACT,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CACnC;6BACF,EACD,SAAS,EACT,OAAO,CAAC,WAAW,CACjB,EAAE,CAAC,UAAU,CAAC,sBAAsB,CACrC,EACD,OAAO,CAAC,8BAA8B,CACpC,OAAO,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAClC,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CACjC,CACF;yBACF,CACF,CACF,CACF;wBACD,OAAO,CAAC,wBAAwB,CAC9B,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,EACnC,OAAO,CAAC,4BAA4B,CAClC;4BACE,OAAO,CAAC,6BAA6B,CACnC,2CAA2C,CACzC,SAAS,EACT,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,IAAI,IAAI,CAAC,CAChD,EACD,IAAI,CACL;4BACD,OAAO,CAAC,6BAA6B,CACnC,2CAA2C,CACzC,SAAS,EACT,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,IAAI,IAAI,CAAC,CAChD,EACD,IAAI,CACL;yBACF,EACD,IAAI,CACL,CACF;qBACF,EACD,IAAI,CACL;iBACF,CACF,CACF;aACF,EACD,EAAE,CAAC,SAAS,CAAC,KAAK,CACnB,CACF;YACD,OAAO,CAAC,yBAAyB,CAC/B,OAAO,CAAC,oBAAoB,CAC1B,OAAO,CAAC,8BAA8B,CACpC,OAAO,CAAC,gBAAgB,CACtB,SAAS,CAAC,SAAS,CAAC,IAAI,GAAG,mBAAmB,CAAC,CAChD,EACD,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,CACpC,EACD,SAAS,EACT;gBACE,OAAO,CAAC,mBAAmB,CACzB,SAAS,EACT,SAAS,EACT;oBACE,OAAO,CAAC,0BAA0B,CAChC,SAAS,EACT,SAAS,EACT,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CACjC;iBACF,EACD,SAAS,EACT,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,UAAU,CAAC,sBAAsB,CAAC,EACzD,OAAO,CAAC,oBAAoB,CAC1B,OAAO,CAAC,8BAA8B,CACpC,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,EACnC,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAChC,EACD,SAAS,EACT;oBACE,OAAO,CAAC,6BAA6B,CACnC;wBACE,OAAO,CAAC,iCAAiC,CACvC,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAChC,SAAS,CACV;qBACF,EACD,KAAK,CACN;iBACF,CACF,CACF;aACF,CACF,CACF;SACF,CAAC;aACC,IAAI,EAAE;aACN,KAAK,CAAC,IAAI,CAAC;QACd,KAAK;KACN,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC"}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
|
|
2
|
+
export declare const createUseQueryOperationTSDocExample: (operation: ServiceOperation, serviceVariableName: string) => string[];
|
|
3
|
+
//# sourceMappingURL=createUseQueryOperationTSDocExample.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createUseQueryOperationTSDocExample.d.ts","sourceRoot":"","sources":["../../../src/ts-factory/tsdoc/createUseQueryOperationTSDocExample.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAC;AAOrF,eAAO,MAAM,mCAAmC,cACnC,gBAAgB,uBACN,MAAM,aAkE5B,CAAC"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import ts from 'typescript';
|
|
2
|
+
import { createOperationCommonTSDoc } from '../../lib/createOperationCommonTSDoc.js';
|
|
3
|
+
import { astToString } from '../astToString.js';
|
|
4
|
+
import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
|
|
5
|
+
import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
|
|
6
|
+
export const createUseQueryOperationTSDocExample = (operation, serviceVariableName) => {
|
|
7
|
+
const example = [
|
|
8
|
+
'Performs asynchronous data fetching, manages loading states and error handling.',
|
|
9
|
+
'',
|
|
10
|
+
...createOperationCommonTSDoc(operation),
|
|
11
|
+
'@see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useQuery|`useQuery(...)` documentation}',
|
|
12
|
+
];
|
|
13
|
+
if (!operation.parameters?.length ||
|
|
14
|
+
operation.parameters.every((parameter) => !parameter.required)) {
|
|
15
|
+
example.push('@example Query without parameters', '```ts', ...('const { data, isLoading } = ' +
|
|
16
|
+
astToString(createOperationMethodCallExpressionExampleNode(operation, {
|
|
17
|
+
serviceVariableName,
|
|
18
|
+
operationMethodName: 'useQuery',
|
|
19
|
+
}, undefined)))
|
|
20
|
+
.trim()
|
|
21
|
+
.split('\n'), '```');
|
|
22
|
+
}
|
|
23
|
+
if (operation.parameters?.length) {
|
|
24
|
+
const factory = ts.factory;
|
|
25
|
+
example.push('@example Query with parameters', '```ts', ...('const { data, isLoading } = ' +
|
|
26
|
+
astToString(createOperationMethodCallExpressionExampleNode(operation, {
|
|
27
|
+
serviceVariableName,
|
|
28
|
+
operationMethodName: 'useQuery',
|
|
29
|
+
}, [
|
|
30
|
+
factory.createObjectLiteralExpression(createOperationMethodParametersExampleNodes(operation), true),
|
|
31
|
+
])))
|
|
32
|
+
.trim()
|
|
33
|
+
.split('\n'), '```');
|
|
34
|
+
}
|
|
35
|
+
return example;
|
|
36
|
+
};
|
|
37
|
+
//# sourceMappingURL=createUseQueryOperationTSDocExample.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createUseQueryOperationTSDocExample.js","sourceRoot":"","sources":["../../../src/ts-factory/tsdoc/createUseQueryOperationTSDocExample.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,0BAA0B,EAAE,MAAM,yCAAyC,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,8CAA8C,EAAE,MAAM,yDAAyD,CAAC;AACzH,OAAO,EAAE,2CAA2C,EAAE,MAAM,sDAAsD,CAAC;AAEnH,MAAM,CAAC,MAAM,mCAAmC,GAAG,CACjD,SAA2B,EAC3B,mBAA2B,EAC3B,EAAE;IACF,MAAM,OAAO,GAAa;QACxB,iFAAiF;QACjF,EAAE;QACF,GAAG,0BAA0B,CAAC,SAAS,CAAC;QACxC,8GAA8G;KAC/G,CAAC;IAEF,IACE,CAAC,SAAS,CAAC,UAAU,EAAE,MAAM;QAC7B,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,EAC9D,CAAC;QACD,OAAO,CAAC,IAAI,CACV,mCAAmC,EACnC,OAAO,EACP,GAAG,CACD,8BAA8B;YAC9B,WAAW,CACT,8CAA8C,CAC5C,SAAS,EACT;gBACE,mBAAmB;gBACnB,mBAAmB,EAAE,UAAU;aAChC,EACD,SAAS,CACV,CACF,CACF;aACE,IAAI,EAAE;aACN,KAAK,CAAC,IAAI,CAAC,EACd,KAAK,CACN,CAAC;IACJ,CAAC;IAED,IAAI,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QACjC,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC;QAE3B,OAAO,CAAC,IAAI,CACV,gCAAgC,EAChC,OAAO,EACP,GAAG,CACD,8BAA8B;YAC9B,WAAW,CACT,8CAA8C,CAC5C,SAAS,EACT;gBACE,mBAAmB;gBACnB,mBAAmB,EAAE,UAAU;aAChC,EACD;gBACE,OAAO,CAAC,6BAA6B,CACnC,2CAA2C,CAAC,SAAS,CAAC,EACtD,IAAI,CACL;aACF,CACF,CACF,CACF;aACE,IAAI,EAAE;aACN,KAAK,CAAC,IAAI,CAAC,EACd,KAAK,CACN,CAAC;IACJ,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC"}
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
|
|
2
|
+
export declare const createUseSuspenseInfiniteQueryOperationTSDocExample: (operation: ServiceOperation, serviceVariableName: string) => string[];
|
|
3
|
+
//# sourceMappingURL=createUseSuspenseInfiniteQueryOperationTSDocExample.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createUseSuspenseInfiniteQueryOperationTSDocExample.d.ts","sourceRoot":"","sources":["../../../src/ts-factory/tsdoc/createUseSuspenseInfiniteQueryOperationTSDocExample.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAC;AAOrF,eAAO,MAAM,mDAAmD,cACnD,gBAAgB,uBACN,MAAM,KAC1B,MAAM,EAoDR,CAAC"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import ts from 'typescript';
|
|
2
|
+
import { astToString } from '../astToString.js';
|
|
3
|
+
import { createInfiniteQueryOptionsArgumentExamplePropertyAssignmentNodes } from './createUseInfiniteQueryOperationTSDocExample.js';
|
|
4
|
+
import { createOperationMethodCallExpressionExampleNode } from './lib/createOperationMethodCallExpressionExampleNode.js';
|
|
5
|
+
import { createOperationMethodParametersExampleNodes } from './lib/createOperationMethodParametersExampleNodes.js';
|
|
6
|
+
export const createUseSuspenseInfiniteQueryOperationTSDocExample = (operation, serviceVariableName) => {
|
|
7
|
+
const factory = ts.factory;
|
|
8
|
+
const commonTSDoc = [
|
|
9
|
+
'Performs asynchronous data fetching with support for infinite scrolling scenarios.',
|
|
10
|
+
'Manages paginated data and provides utilities for fetching additional pages.',
|
|
11
|
+
'It functions similarly to `useInfiniteQuery`, but with added support for React Suspense.',
|
|
12
|
+
'',
|
|
13
|
+
'@see {@link https://openapi-qraft.github.io/openapi-qraft/docs/hooks/useSuspenseInfiniteQuery|`useSuspenseInfiniteQuery(...)` documentation}',
|
|
14
|
+
'',
|
|
15
|
+
];
|
|
16
|
+
return [
|
|
17
|
+
...commonTSDoc,
|
|
18
|
+
'@example Suspense Infinite Query',
|
|
19
|
+
'```ts',
|
|
20
|
+
...('const { data, isLoading, fetchNextPage } = ' +
|
|
21
|
+
astToString(createOperationMethodCallExpressionExampleNode(operation, {
|
|
22
|
+
serviceVariableName,
|
|
23
|
+
operationMethodName: 'useSuspenseInfiniteQuery',
|
|
24
|
+
}, [
|
|
25
|
+
factory.createObjectLiteralExpression(createOperationMethodParametersExampleNodes({
|
|
26
|
+
...operation,
|
|
27
|
+
parameters: operation.parameters?.filter((parameter) => parameter.in === 'query' ? parameter.required : true),
|
|
28
|
+
}), true),
|
|
29
|
+
factory.createObjectLiteralExpression(createInfiniteQueryOptionsArgumentExamplePropertyAssignmentNodes(operation), true),
|
|
30
|
+
])))
|
|
31
|
+
.trim()
|
|
32
|
+
.split('\n'),
|
|
33
|
+
'',
|
|
34
|
+
'console.log(data);',
|
|
35
|
+
'fetchNextPage(); // Fetch the next page',
|
|
36
|
+
'```',
|
|
37
|
+
];
|
|
38
|
+
};
|
|
39
|
+
//# sourceMappingURL=createUseSuspenseInfiniteQueryOperationTSDocExample.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createUseSuspenseInfiniteQueryOperationTSDocExample.js","sourceRoot":"","sources":["../../../src/ts-factory/tsdoc/createUseSuspenseInfiniteQueryOperationTSDocExample.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,gEAAgE,EAAE,MAAM,kDAAkD,CAAC;AACpI,OAAO,EAAE,8CAA8C,EAAE,MAAM,yDAAyD,CAAC;AACzH,OAAO,EAAE,2CAA2C,EAAE,MAAM,sDAAsD,CAAC;AAEnH,MAAM,CAAC,MAAM,mDAAmD,GAAG,CACjE,SAA2B,EAC3B,mBAA2B,EACjB,EAAE;IACZ,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC;IAE3B,MAAM,WAAW,GAAG;QAClB,oFAAoF;QACpF,8EAA8E;QAC9E,0FAA0F;QAC1F,EAAE;QACF,8IAA8I;QAC9I,EAAE;KACH,CAAC;IAEF,OAAO;QACL,GAAG,WAAW;QACd,kCAAkC;QAClC,OAAO;QACP,GAAG,CACD,6CAA6C;YAC7C,WAAW,CACT,8CAA8C,CAC5C,SAAS,EACT;gBACE,mBAAmB;gBACnB,mBAAmB,EAAE,0BAA0B;aAChD,EACD;gBACE,OAAO,CAAC,6BAA6B,CACnC,2CAA2C,CAAC;oBAC1C,GAAG,SAAS;oBACZ,UAAU,EAAE,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CACrD,SAAS,CAAC,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CACrD;iBACF,CAAC,EACF,IAAI,CACL;gBACD,OAAO,CAAC,6BAA6B,CACnC,gEAAgE,CAC9D,SAAS,CACV,EACD,IAAI,CACL;aACF,CACF,CACF,CACF;aACE,IAAI,EAAE;aACN,KAAK,CAAC,IAAI,CAAC;QACd,EAAE;QACF,oBAAoB;QACpB,yCAAyC;QACzC,KAAK;KACN,CAAC;AACJ,CAAC,CAAC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
|
|
2
|
+
import ts from 'typescript';
|
|
3
|
+
export declare const createOperationMethodCallExpressionExampleNode: (operation: ServiceOperation, { serviceVariableName, operationMethodName, }: {
|
|
4
|
+
serviceVariableName: string;
|
|
5
|
+
operationMethodName: string;
|
|
6
|
+
}, nodes: ts.Expression[] | undefined) => ts.CallExpression;
|
|
7
|
+
//# sourceMappingURL=createOperationMethodCallExpressionExampleNode.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createOperationMethodCallExpressionExampleNode.d.ts","sourceRoot":"","sources":["../../../../src/ts-factory/tsdoc/lib/createOperationMethodCallExpressionExampleNode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAC;AACrF,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,eAAO,MAAM,8CAA8C,cAC9C,gBAAgB,iDAIxB;IAAE,mBAAmB,EAAE,MAAM,CAAC;IAAC,mBAAmB,EAAE,MAAM,CAAA;CAAE,SACxD,EAAE,CAAC,UAAU,EAAE,GAAG,SAAS,sBAkBnC,CAAC"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import ts from 'typescript';
|
|
2
|
+
export const createOperationMethodCallExpressionExampleNode = (operation, { serviceVariableName, operationMethodName, }, nodes) => {
|
|
3
|
+
const factory = ts.factory;
|
|
4
|
+
return factory.createCallExpression(factory.createPropertyAccessExpression(factory.createPropertyAccessExpression(factory.createPropertyAccessExpression(factory.createIdentifier('qraft'), factory.createIdentifier(serviceVariableName)), factory.createIdentifier(operation.name)), factory.createIdentifier(operationMethodName)), undefined, nodes);
|
|
5
|
+
};
|
|
6
|
+
//# sourceMappingURL=createOperationMethodCallExpressionExampleNode.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createOperationMethodCallExpressionExampleNode.js","sourceRoot":"","sources":["../../../../src/ts-factory/tsdoc/lib/createOperationMethodCallExpressionExampleNode.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,MAAM,CAAC,MAAM,8CAA8C,GAAG,CAC5D,SAA2B,EAC3B,EACE,mBAAmB,EACnB,mBAAmB,GAC0C,EAC/D,KAAkC,EAClC,EAAE;IACF,MAAM,OAAO,GAAG,EAAE,CAAC,OAAO,CAAC;IAE3B,OAAO,OAAO,CAAC,oBAAoB,CACjC,OAAO,CAAC,8BAA8B,CACpC,OAAO,CAAC,8BAA8B,CACpC,OAAO,CAAC,8BAA8B,CACpC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,EACjC,OAAO,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAC9C,EACD,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,CACzC,EACD,OAAO,CAAC,gBAAgB,CAAC,mBAAmB,CAAC,CAC9C,EACD,SAAS,EACT,KAAK,CACN,CAAC;AACJ,CAAC,CAAC"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { ServiceOperation } from '@openapi-qraft/plugin/lib/open-api/OpenAPIService';
|
|
2
|
+
import ts from 'typescript';
|
|
3
|
+
export declare const createOperationMethodParametersExampleNodes: (operation: ServiceOperation, transformOperationParameterIdentifier?: (operationParameter: NonNullable<ServiceOperation["parameters"]>[number]) => string) => ts.PropertyAssignment[];
|
|
4
|
+
//# sourceMappingURL=createOperationMethodParametersExampleNodes.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createOperationMethodParametersExampleNodes.d.ts","sourceRoot":"","sources":["../../../../src/ts-factory/tsdoc/lib/createOperationMethodParametersExampleNodes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mDAAmD,CAAC;AAErF,OAAO,EAAE,MAAM,YAAY,CAAC;AAE5B,eAAO,MAAM,2CAA2C,cAC3C,gBAAgB,0CACa,CACtC,kBAAkB,EAAE,WAAW,CAAC,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,KACpE,MAAM,KACV,EAAE,CAAC,kBAAkB,EA0DvB,CAAC"}
|