@cosmwasm/ts-codegen 0.18.0 → 0.20.0

package/README.md

@@ -10,6 +10,7 @@ Generate TypeScript SDKs for your CosmWasm smart contracts
   <a href="https://github.com/CosmWasm/ts-codegen/actions/workflows/run-tests.yaml">
     <img height="20" src="https://github.com/CosmWasm/ts-codegen/actions/workflows/run-tests.yaml/badge.svg" />
   </a>
+   <a href="https://www.npmjs.com/package/@cosmwasm/ts-codegen"><img height="20" src="https://img.shields.io/npm/dt/@cosmwasm/ts-codegen"></a>
    <a href="https://github.com/CosmWasm/ts-codegen/blob/main/LICENSE-MIT"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"></a>
    <a href="https://github.com/CosmWasm/ts-codegen/blob/main/LICENSE-Apache"><img height="20" src="https://img.shields.io/badge/license-Apache-blue.svg"></a>
    <a href="https://www.npmjs.com/package/@cosmwasm/ts-codegen"><img height="20" src="https://img.shields.io/github/package-json/v/CosmWasm/ts-codegen?filename=packages%2Fts-codegen%2Fpackage.json"></a>
@@ -110,6 +111,7 @@ codegen({
       version: 'v4',
       mutations: true,
       queryKeys: true,
+      queryFactory: true,
     },
     recoil: {
       enabled: false
@@ -146,6 +148,7 @@ The `client` plugin will generate TS client classes for your contracts. This opt
   | option                        | description                                          |
   | ----------------------------- | ---------------------------------------------------  |
   | `client.enabled`              | generate TS client classes for your contracts        |
+  | `client.execExtendsQuery`     | execute should extend query message clients          |
 
 #### Client via CLI
 
@@ -169,6 +172,7 @@ Generate [react-query v3](https://react-query-v3.tanstack.com/) or [react-query
   | `reactQuery.enabled`        | enable the react-query plugin                                                |
   | `reactQuery.optionalClient` | allows contract client to be undefined as the component renders              |
   | `reactQuery.queryKeys`      | generates a const queryKeys object for use with invalidations and set values |
+  | `reactQuery.queryFactory`   | generates a const queryFactory object for useQueries and prefetchQueries use |
   | `reactQuery.version`        | `v4` uses `@tanstack/react-query` and `v3` uses `react-query`                |
   | `reactQuery.mutations`      | also generate mutations                                                      |
   | `reactQuery.camelize`       | use camelCase style for property names                                       |

package/main/commands/generate.js

@@ -17,7 +17,7 @@ var _index = _interopRequireDefault(require("../index"));
 
 var _default = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(argv) {
-    var questions, _yield$prompt, schema, out, name, plugin, bundle, questions2, _yield$prompt2, optionalClient, version, queryKeys, questions3, _yield$prompt3, mutations, questions4, _yield$prompt4, bundleFile, bundleScope, options;
+    var questions, _yield$prompt, schema, out, name, plugin, bundle, questions2, _yield$prompt2, optionalClient, version, queryKeys, questions3, _yield$prompt3, mutations, queryFactoryQuestions, _yield$prompt4, queryFactory, questions4, _yield$prompt5, bundleFile, bundleScope, options;
 
     return _regenerator["default"].wrap(function _callee$(_context) {
       while (1) {
@@ -118,6 +118,25 @@ var _default = /*#__PURE__*/function () {
           case 25:
             _yield$prompt3 = _context.sent;
             mutations = _yield$prompt3.mutations;
+            queryFactoryQuestions = [];
+
+            if (queryKeys) {
+              [].push.apply(queryFactoryQuestions, [// Only can use queryFactory if queryKeys is enabled
+              {
+                type: 'confirm',
+                name: 'queryFactory',
+                message: 'queryFactory? ',
+                "default": false
+              }]);
+            }
+
+            ;
+            _context.next = 32;
+            return (0, _prompt.prompt)(queryFactoryQuestions, argv);
+
+          case 32:
+            _yield$prompt4 = _context.sent;
+            queryFactory = _yield$prompt4.queryFactory;
             ///////// END REACT QUERY
             ///////// BUNDLE
             questions4 = [];
@@ -137,13 +156,13 @@ var _default = /*#__PURE__*/function () {
             }
 
             ;
-            _context.next = 32;
+            _context.next = 39;
             return (0, _prompt.prompt)(questions4, argv);
 
-          case 32:
-            _yield$prompt4 = _context.sent;
-            bundleFile = _yield$prompt4.bundleFile;
-            bundleScope = _yield$prompt4.bundleScope;
+          case 39:
+            _yield$prompt5 = _context.sent;
+            bundleFile = _yield$prompt5.bundleFile;
+            bundleScope = _yield$prompt5.bundleScope;
             ///////// END BUNDLE
             options = {
               types: {
@@ -157,7 +176,8 @@ var _default = /*#__PURE__*/function () {
                 optionalClient: optionalClient,
                 queryKeys: queryKeys,
                 version: version,
-                mutations: mutations
+                mutations: mutations,
+                queryFactory: queryFactory
               },
               recoil: {
                 enabled: plugin.includes('recoil')
@@ -171,7 +191,7 @@ var _default = /*#__PURE__*/function () {
                 bundleFile: bundleFile
               }
             };
-            _context.next = 38;
+            _context.next = 45;
             return (0, _index["default"])({
               contracts: [{
                 name: name,
@@ -181,7 +201,7 @@ var _default = /*#__PURE__*/function () {
               options: options
             });
 
-          case 38:
+          case 45:
           case "end":
             return _context.stop();
         }

package/main/generators/client.js

@@ -79,8 +79,8 @@ var _default = /*#__PURE__*/function () {
               if (children.length > 0) {
                 Client = (0, _case.pascal)("".concat(name, "Client"));
                 Instance = (0, _case.pascal)("".concat(name, "Interface"));
-                body.push(w.createExecuteInterface(context, Instance, ReadOnlyInstance, ExecuteMsg));
-                body.push(w.createExecuteClass(context, Client, Instance, QueryClient, ExecuteMsg));
+                body.push(w.createExecuteInterface(context, Instance, context.options.client.execExtendsQuery ? ReadOnlyInstance : null, ExecuteMsg));
+                body.push(w.createExecuteClass(context, Client, Instance, context.options.client.execExtendsQuery ? QueryClient : null, ExecuteMsg));
               }
             }
 

package/module/commands/generate.js

@@ -86,7 +86,23 @@ export default (async argv => {
   ;
   const {
     mutations
-  } = await prompt(questions3, argv); ///////// END REACT QUERY
+  } = await prompt(questions3, argv);
+  const queryFactoryQuestions = [];
+
+  if (queryKeys) {
+    [].push.apply(queryFactoryQuestions, [// Only can use queryFactory if queryKeys is enabled
+    {
+      type: 'confirm',
+      name: 'queryFactory',
+      message: 'queryFactory? ',
+      default: false
+    }]);
+  }
+
+  ;
+  const {
+    queryFactory
+  } = await prompt(queryFactoryQuestions, argv); ///////// END REACT QUERY
   ///////// BUNDLE
 
   const questions4 = [];
@@ -123,7 +139,8 @@ export default (async argv => {
       optionalClient,
       queryKeys,
       version,
-      mutations
+      mutations,
+      queryFactory
     },
     recoil: {
       enabled: plugin.includes('recoil')

package/module/generators/client.js

@@ -43,8 +43,8 @@ export default (async (name, contractInfo, outPath, tsClientOptions) => {
     if (children.length > 0) {
       Client = pascal(`${name}Client`);
       Instance = pascal(`${name}Interface`);
-      body.push(w.createExecuteInterface(context, Instance, ReadOnlyInstance, ExecuteMsg));
-      body.push(w.createExecuteClass(context, Client, Instance, QueryClient, ExecuteMsg));
+      body.push(w.createExecuteInterface(context, Instance, context.options.client.execExtendsQuery ? ReadOnlyInstance : null, ExecuteMsg));
+      body.push(w.createExecuteClass(context, Client, Instance, context.options.client.execExtendsQuery ? QueryClient : null, ExecuteMsg));
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cosmwasm/ts-codegen",
-  "version": "0.18.0",
+  "version": "0.20.0",
   "description": "@cosmwasm/ts-codegen converts your CosmWasm smart contracts into dev-friendly TypeScript classes so you can focus on shipping code.",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "homepage": "https://github.com/cosmwasm/ts-codegen",
@@ -96,7 +96,7 @@
     "parse-package-name": "1.0.0",
     "rimraf": "3.0.2",
     "shelljs": "0.8.5",
-    "wasm-ast-types": "^0.12.0"
+    "wasm-ast-types": "^0.14.0"
   },
-  "gitHead": "59dcc054d241c6bf43d5a617b31c3cd5c4ecff6e"
+  "gitHead": "e58a660b6265fc94bdd11f311afe9fac11708c51"
 }

package/src/commands/generate.ts

@@ -90,6 +90,20 @@ export default async (argv) => {
         ])
     };
     const { mutations } = await prompt(questions3, argv);
+
+    const queryFactoryQuestions  = [];
+    if (queryKeys) {
+      [].push.apply(queryFactoryQuestions, [
+        // Only can use queryFactory if queryKeys is enabled
+        {
+          type: 'confirm',
+          name: 'queryFactory',
+          message: 'queryFactory? ',
+          default: false
+        }
+      ])
+    };
+    const { queryFactory } = await prompt(queryFactoryQuestions, argv);
     ///////// END REACT QUERY
 
     ///////// BUNDLE
@@ -128,7 +142,8 @@ export default async (argv) => {
             optionalClient,
             queryKeys,
             version,
-            mutations
+            mutations,
+            queryFactory
         },
         recoil: {
             enabled: plugin.includes('recoil'),

package/src/generators/client.ts

@@ -66,16 +66,17 @@ export default async (
         w.createExecuteInterface(
           context,
           Instance,
-          ReadOnlyInstance,
+          context.options.client.execExtendsQuery ? ReadOnlyInstance : null,
           ExecuteMsg
         )
       );
+
       body.push(
         w.createExecuteClass(
           context,
           Client,
           Instance,
-          QueryClient,
+          context.options.client.execExtendsQuery ? QueryClient : null,
           ExecuteMsg
         )
       );