@7nohe/openapi-react-query-codegen 0.2.0 → 0.2.1
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/README.md +7 -1
- package/dist/package.json +2 -2
- package/dist/src/createUseQuery.js +37 -32
- package/package.json +2 -2
- package/dist/node_modules/.bin/openapi +0 -17
- package/dist/node_modules/.bin/tsc +0 -17
- package/dist/node_modules/.bin/tsserver +0 -17
package/README.md
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
## Features
|
|
6
6
|
|
|
7
7
|
- Supports generation of custom react hooks that use React Query's `useQuery` and `useMutation` hooks
|
|
8
|
+
- Supports generation of query keys for query caching
|
|
8
9
|
- Supports the option to use pure TypeScript clients generated by [OpenAPI Typescript Codegen](https://github.com/ferdikoomen/openapi-typescript-codegen)
|
|
9
10
|
|
|
10
11
|
## Install
|
|
@@ -81,8 +82,13 @@ You can also use pure TS clients.
|
|
|
81
82
|
```tsx
|
|
82
83
|
import { useQuery } from "@tanstack/react-query";
|
|
83
84
|
import { PetService } from '../openapi/requests/services/PetService';
|
|
85
|
+
import {
|
|
86
|
+
usePetServiceFindPetsByStatusKey,
|
|
87
|
+
} from "../openapi/queries";
|
|
88
|
+
|
|
84
89
|
function App() {
|
|
85
|
-
|
|
90
|
+
// You can still use the auto-generated query key
|
|
91
|
+
const { data } = useQuery([usePetServiceFindPetsByStatusKey], () => {
|
|
86
92
|
// Do something here
|
|
87
93
|
|
|
88
94
|
return PetService.findPetsByStatus(['available']);
|
package/dist/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@7nohe/openapi-react-query-codegen",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "OpenAPI React Query Codegen",
|
|
5
5
|
"bin": {
|
|
6
6
|
"openapi-rq": "dist/src/cli.js"
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
},
|
|
14
14
|
"repository": {
|
|
15
15
|
"type": "git",
|
|
16
|
-
"url": "https://github.com/7nohe/openapi-react-query-codegen.git"
|
|
16
|
+
"url": "git+https://github.com/7nohe/openapi-react-query-codegen.git"
|
|
17
17
|
},
|
|
18
18
|
"homepage": "https://github.com/7nohe/openapi-react-query-codegen",
|
|
19
19
|
"bugs": "https://github.com/7nohe/openapi-react-query-codegen/issues",
|
|
@@ -42,40 +42,45 @@ var createUseQuery = function (node, className, method) {
|
|
|
42
42
|
return typescript_1["default"].factory.createPropertySignature(undefined, typescript_1["default"].factory.createIdentifier(param.name.getText(node)), undefined, param.type);
|
|
43
43
|
})), undefined));
|
|
44
44
|
}
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
45
|
+
var customHookName = "use".concat(className).concat((0, common_1.capitalizeFirstLetter)(methodName));
|
|
46
|
+
var queryKey = "".concat(customHookName, "Key");
|
|
47
|
+
return [
|
|
48
|
+
typescript_1["default"].factory.createVariableStatement([typescript_1["default"].factory.createModifier(typescript_1["default"].SyntaxKind.ExportKeyword)], typescript_1["default"].factory.createVariableDeclarationList([typescript_1["default"].factory.createVariableDeclaration(typescript_1["default"].factory.createIdentifier(queryKey), undefined, undefined, typescript_1["default"].factory.createStringLiteral("".concat(className).concat((0, common_1.capitalizeFirstLetter)(methodName))))], typescript_1["default"].NodeFlags.Const)),
|
|
49
|
+
typescript_1["default"].factory.createVariableStatement([typescript_1["default"].factory.createModifier(typescript_1["default"].SyntaxKind.ExportKeyword)], typescript_1["default"].factory.createVariableDeclarationList([
|
|
50
|
+
typescript_1["default"].factory.createVariableDeclaration(typescript_1["default"].factory.createIdentifier(customHookName), undefined, undefined, typescript_1["default"].factory.createArrowFunction(undefined, undefined, __spreadArray(__spreadArray([], __read(requestParam), false), [
|
|
51
|
+
typescript_1["default"].factory.createParameterDeclaration(undefined, undefined, undefined, typescript_1["default"].factory.createIdentifier("queryKey"), undefined, typescript_1["default"].factory.createArrayTypeNode(typescript_1["default"].factory.createKeywordTypeNode(typescript_1["default"].SyntaxKind.StringKeyword)), typescript_1["default"].factory.createArrayLiteralExpression([], false)),
|
|
52
|
+
typescript_1["default"].factory.createParameterDeclaration(undefined, undefined, undefined, typescript_1["default"].factory.createIdentifier("options"), typescript_1["default"].factory.createToken(typescript_1["default"].SyntaxKind.QuestionToken), typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("Omit"), [
|
|
53
|
+
typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("UseQueryOptions"), [
|
|
54
|
+
typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("Awaited"), [
|
|
55
|
+
typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("ReturnType"), [
|
|
56
|
+
typescript_1["default"].factory.createTypeQueryNode(typescript_1["default"].factory.createQualifiedName(typescript_1["default"].factory.createIdentifier(className), typescript_1["default"].factory.createIdentifier(methodName)), undefined),
|
|
57
|
+
]),
|
|
53
58
|
]),
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
+
typescript_1["default"].factory.createKeywordTypeNode(typescript_1["default"].SyntaxKind.UnknownKeyword),
|
|
60
|
+
typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("Awaited"), [
|
|
61
|
+
typescript_1["default"].factory.createTypeReferenceNode(typescript_1["default"].factory.createIdentifier("ReturnType"), [
|
|
62
|
+
typescript_1["default"].factory.createTypeQueryNode(typescript_1["default"].factory.createQualifiedName(typescript_1["default"].factory.createIdentifier(className), typescript_1["default"].factory.createIdentifier(methodName)), undefined),
|
|
63
|
+
]),
|
|
59
64
|
]),
|
|
65
|
+
typescript_1["default"].factory.createArrayTypeNode(typescript_1["default"].factory.createKeywordTypeNode(typescript_1["default"].SyntaxKind.StringKeyword)),
|
|
66
|
+
]),
|
|
67
|
+
typescript_1["default"].factory.createUnionTypeNode([
|
|
68
|
+
typescript_1["default"].factory.createLiteralTypeNode(typescript_1["default"].factory.createStringLiteral("queryKey")),
|
|
69
|
+
typescript_1["default"].factory.createLiteralTypeNode(typescript_1["default"].factory.createStringLiteral("queryFn")),
|
|
70
|
+
typescript_1["default"].factory.createLiteralTypeNode(typescript_1["default"].factory.createStringLiteral("initialData")),
|
|
60
71
|
]),
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
typescript_1["default"].factory.
|
|
64
|
-
typescript_1["default"].factory.
|
|
65
|
-
typescript_1["default"].factory.
|
|
66
|
-
|
|
67
|
-
]),
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
typescript_1["default"].factory.createArrowFunction(undefined, undefined, [], undefined, typescript_1["default"].factory.createToken(typescript_1["default"].SyntaxKind.EqualsGreaterThanToken), typescript_1["default"].factory.createCallExpression(typescript_1["default"].factory.createPropertyAccessExpression(typescript_1["default"].factory.createIdentifier(className), typescript_1["default"].factory.createIdentifier(methodName)), undefined, method.parameters.map(function (param) {
|
|
75
|
-
return typescript_1["default"].factory.createIdentifier(param.name.getText(node));
|
|
76
|
-
}))),
|
|
77
|
-
typescript_1["default"].factory.createIdentifier("options"),
|
|
78
|
-
]))),
|
|
79
|
-
], typescript_1["default"].NodeFlags.Const));
|
|
72
|
+
]), undefined),
|
|
73
|
+
], false), undefined, typescript_1["default"].factory.createToken(typescript_1["default"].SyntaxKind.EqualsGreaterThanToken), typescript_1["default"].factory.createCallExpression(typescript_1["default"].factory.createIdentifier("useQuery"), undefined, [
|
|
74
|
+
typescript_1["default"].factory.createArrayLiteralExpression([
|
|
75
|
+
typescript_1["default"].factory.createIdentifier(queryKey),
|
|
76
|
+
typescript_1["default"].factory.createSpreadElement(typescript_1["default"].factory.createIdentifier("queryKey"))
|
|
77
|
+
], false),
|
|
78
|
+
typescript_1["default"].factory.createArrowFunction(undefined, undefined, [], undefined, typescript_1["default"].factory.createToken(typescript_1["default"].SyntaxKind.EqualsGreaterThanToken), typescript_1["default"].factory.createCallExpression(typescript_1["default"].factory.createPropertyAccessExpression(typescript_1["default"].factory.createIdentifier(className), typescript_1["default"].factory.createIdentifier(methodName)), undefined, method.parameters.map(function (param) {
|
|
79
|
+
return typescript_1["default"].factory.createIdentifier(param.name.getText(node));
|
|
80
|
+
}))),
|
|
81
|
+
typescript_1["default"].factory.createIdentifier("options"),
|
|
82
|
+
]))),
|
|
83
|
+
], typescript_1["default"].NodeFlags.Const))
|
|
84
|
+
];
|
|
80
85
|
};
|
|
81
86
|
exports.createUseQuery = createUseQuery;
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@7nohe/openapi-react-query-codegen",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "OpenAPI React Query Codegen",
|
|
5
5
|
"bin": {
|
|
6
6
|
"openapi-rq": "dist/src/cli.js"
|
|
7
7
|
},
|
|
8
8
|
"repository": {
|
|
9
9
|
"type": "git",
|
|
10
|
-
"url": "https://github.com/7nohe/openapi-react-query-codegen.git"
|
|
10
|
+
"url": "git+https://github.com/7nohe/openapi-react-query-codegen.git"
|
|
11
11
|
},
|
|
12
12
|
"homepage": "https://github.com/7nohe/openapi-react-query-codegen",
|
|
13
13
|
"bugs": "https://github.com/7nohe/openapi-react-query-codegen/issues",
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
#!/bin/sh
|
|
2
|
-
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
3
|
-
|
|
4
|
-
case `uname` in
|
|
5
|
-
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
|
6
|
-
esac
|
|
7
|
-
|
|
8
|
-
if [ -z "$NODE_PATH" ]; then
|
|
9
|
-
export NODE_PATH="/Users/daiki/Documents/openapi-react-query-codegen/node_modules/.pnpm/node_modules"
|
|
10
|
-
else
|
|
11
|
-
export NODE_PATH="$NODE_PATH:/Users/daiki/Documents/openapi-react-query-codegen/node_modules/.pnpm/node_modules"
|
|
12
|
-
fi
|
|
13
|
-
if [ -x "$basedir/node" ]; then
|
|
14
|
-
exec "$basedir/node" "$basedir/../../../node_modules/.pnpm/openapi-typescript-codegen@0.23.0/node_modules/openapi-typescript-codegen/bin/index.js" "$@"
|
|
15
|
-
else
|
|
16
|
-
exec node "$basedir/../../../node_modules/.pnpm/openapi-typescript-codegen@0.23.0/node_modules/openapi-typescript-codegen/bin/index.js" "$@"
|
|
17
|
-
fi
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
#!/bin/sh
|
|
2
|
-
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
3
|
-
|
|
4
|
-
case `uname` in
|
|
5
|
-
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
|
6
|
-
esac
|
|
7
|
-
|
|
8
|
-
if [ -z "$NODE_PATH" ]; then
|
|
9
|
-
export NODE_PATH="/Users/daiki/Documents/openapi-react-query-codegen/node_modules/.pnpm/node_modules"
|
|
10
|
-
else
|
|
11
|
-
export NODE_PATH="$NODE_PATH:/Users/daiki/Documents/openapi-react-query-codegen/node_modules/.pnpm/node_modules"
|
|
12
|
-
fi
|
|
13
|
-
if [ -x "$basedir/node" ]; then
|
|
14
|
-
exec "$basedir/node" "$basedir/../../../node_modules/.pnpm/typescript@4.7.4/node_modules/typescript/bin/tsc" "$@"
|
|
15
|
-
else
|
|
16
|
-
exec node "$basedir/../../../node_modules/.pnpm/typescript@4.7.4/node_modules/typescript/bin/tsc" "$@"
|
|
17
|
-
fi
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
#!/bin/sh
|
|
2
|
-
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
3
|
-
|
|
4
|
-
case `uname` in
|
|
5
|
-
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
|
6
|
-
esac
|
|
7
|
-
|
|
8
|
-
if [ -z "$NODE_PATH" ]; then
|
|
9
|
-
export NODE_PATH="/Users/daiki/Documents/openapi-react-query-codegen/node_modules/.pnpm/node_modules"
|
|
10
|
-
else
|
|
11
|
-
export NODE_PATH="$NODE_PATH:/Users/daiki/Documents/openapi-react-query-codegen/node_modules/.pnpm/node_modules"
|
|
12
|
-
fi
|
|
13
|
-
if [ -x "$basedir/node" ]; then
|
|
14
|
-
exec "$basedir/node" "$basedir/../../../node_modules/.pnpm/typescript@4.7.4/node_modules/typescript/bin/tsserver" "$@"
|
|
15
|
-
else
|
|
16
|
-
exec node "$basedir/../../../node_modules/.pnpm/typescript@4.7.4/node_modules/typescript/bin/tsserver" "$@"
|
|
17
|
-
fi
|