@cosmwasm/ts-codegen 0.25.2 → 0.27.0

package/README.md

@@ -36,6 +36,7 @@ The quickest and easiest way to interact with CosmWasm Contracts. `@cosmwasm/ts-
     - [React Query](#react-query)
     - [Recoil](#recoil)
     - [Message Composer](#message-composer)
+    - [Msg Builder](#msg-builder)
     - [Bundles](#bundles)
     - [CLI Usage and Examples](#cli-usage-and-examples)
     - [Advanced Usage](#advanced-usage)
@@ -119,6 +120,9 @@ codegen({
     },
     messageComposer: {
       enabled: false
+    },
+    msgBuilder: { 
+      enabled: false
     }
   }
 }).then(() => {
@@ -252,6 +256,28 @@ cosmwasm-ts-codegen generate \
   | ------------------------------ | ------------------------------------------------------------------- |
   | `messageComposer.enabled`      | enable the messageComposer plugin                                   |
 
+### Msg Builder
+
+Generate raw message jsons for use in your application with the `msg-builder` command.
+
+[see example output code](https://gist.github.com/adairrr/b394e62beb9856b0351883f776650f26)
+
+#### Msg Builder via CLI
+
+```sh
+cosmwasm-ts-codegen generate \
+    --plugin msg-builder \
+    --schema ./schema \
+    --out ./ts \
+    --name MyContractName 
+```
+#### Message Composer Options
+
+| option      | description                                                         |
+-------------| ------------------------------ | ------------------------------------------------------------------- |
+| `msgBuilder.enabled` | enable the msgBilder plugin                                   |
+
+
 ### Bundles
 
 The bundler will make a nice package of all your contracts. For example:

package/main/builder/builder.js

@@ -13,8 +13,6 @@ var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"))
 
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
-var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
-
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
@@ -33,16 +31,6 @@ var _fs = require("fs");
 
 var _mkdirp = require("mkdirp");
 
-var _messageComposer = _interopRequireDefault(require("../generators/message-composer"));
-
-var _types = _interopRequireDefault(require("../generators/types"));
-
-var _reactQuery = _interopRequireDefault(require("../generators/react-query"));
-
-var _recoil = _interopRequireDefault(require("../generators/recoil"));
-
-var _client = _interopRequireDefault(require("../generators/client"));
-
 var _utils = require("../utils");
 
 var _deepmerge = _interopRequireDefault(require("deepmerge"));
@@ -55,16 +43,28 @@ var _generator = _interopRequireDefault(require("@babel/generator"));
 
 var t = _interopRequireWildcard(require("@babel/types"));
 
-var _excluded = ["enabled"],
-    _excluded2 = ["enabled"],
-    _excluded3 = ["enabled"],
-    _excluded4 = ["enabled"],
-    _excluded5 = ["enabled"];
+var _reactQuery = require("../plugins/react-query");
+
+var _recoil = require("../plugins/recoil");
+
+var _msgBuilder = require("../plugins/msg-builder");
+
+var _messageComposer = require("../plugins/message-composer");
+
+var _client = require("../plugins/client");
+
+var _types2 = require("../plugins/types");
 
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
 var defaultOpts = {
   bundle: {
     enabled: true,
@@ -76,75 +76,65 @@ var defaultOpts = {
 ;
 ;
 
+function getContract(contractOpt) {
+  if (typeof contractOpt === 'string') {
+    var name = (0, _path.basename)(contractOpt);
+    var contractName = (0, _case.pascal)(name);
+    return {
+      name: contractName,
+      dir: contractOpt
+    };
+  }
+
+  return {
+    name: (0, _case.pascal)(contractOpt.name),
+    dir: contractOpt.dir
+  };
+}
+
 var TSBuilder = /*#__PURE__*/function () {
   function TSBuilder(_ref) {
     var contracts = _ref.contracts,
         outPath = _ref.outPath,
-        options = _ref.options;
+        options = _ref.options,
+        plugins = _ref.plugins;
     (0, _classCallCheck2["default"])(this, TSBuilder);
     (0, _defineProperty2["default"])(this, "contracts", void 0);
     (0, _defineProperty2["default"])(this, "outPath", void 0);
     (0, _defineProperty2["default"])(this, "options", void 0);
+    (0, _defineProperty2["default"])(this, "plugins", []);
     (0, _defineProperty2["default"])(this, "files", []);
     this.contracts = contracts;
     this.outPath = outPath;
     this.options = (0, _deepmerge["default"])((0, _deepmerge["default"])(_wasmAstTypes.defaultOptions, defaultOpts), options !== null && options !== void 0 ? options : {});
+    this.loadDefaultPlugins();
+
+    if (plugins && plugins.length) {
+      [].push.apply(this.plugins, plugins);
+    }
   }
 
   (0, _createClass2["default"])(TSBuilder, [{
-    key: "getContracts",
-    value: function getContracts() {
-      return this.contracts.map(function (contractOpt) {
-        if (typeof contractOpt === 'string') {
-          var name = (0, _path.basename)(contractOpt);
-          var contractName = (0, _case.pascal)(name);
-          return {
-            name: contractName,
-            dir: contractOpt
-          };
-        }
-
-        return {
-          name: (0, _case.pascal)(contractOpt.name),
-          dir: contractOpt.dir
-        };
-      });
+    key: "loadDefaultPlugins",
+    value: function loadDefaultPlugins() {
+      [].push.apply(this.plugins, [new _types2.TypesPlugin(this.options), new _client.ClientPlugin(this.options), new _messageComposer.MessageComposerPlugin(this.options), new _reactQuery.ReactQueryPlugin(this.options), new _recoil.RecoilPlugin(this.options), new _msgBuilder.MsgBuilderPlugin(this.options)]);
     }
   }, {
-    key: "renderTypes",
+    key: "build",
     value: function () {
-      var _renderTypes = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(contract) {
-        var _this$options$types, enabled, options, contractInfo, files;
-
+      var _build = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee() {
         return _regenerator["default"].wrap(function _callee$(_context) {
           while (1) {
             switch (_context.prev = _context.next) {
               case 0:
-                _this$options$types = this.options.types, enabled = _this$options$types.enabled, options = (0, _objectWithoutProperties2["default"])(_this$options$types, _excluded);
-
-                if (enabled) {
-                  _context.next = 3;
-                  break;
-                }
-
-                return _context.abrupt("return");
-
-              case 3:
-                _context.next = 5;
-                return (0, _utils.readSchemas)({
-                  schemaDir: contract.dir
-                });
-
-              case 5:
-                contractInfo = _context.sent;
-                _context.next = 8;
-                return (0, _types["default"])(contract.name, contractInfo, this.outPath, options);
+                _context.next = 2;
+                return this.process();
 
-              case 8:
-                files = _context.sent;
-                [].push.apply(this.files, files);
+              case 2:
+                _context.next = 4;
+                return this.after();
 
-              case 10:
+              case 4:
               case "end":
                 return _context.stop();
             }
@@ -152,296 +142,217 @@ var TSBuilder = /*#__PURE__*/function () {
         }, _callee, this);
       }));
 
-      function renderTypes(_x) {
-        return _renderTypes.apply(this, arguments);
+      function build() {
+        return _build.apply(this, arguments);
       }
 
-      return renderTypes;
-    }()
+      return build;
+    }() // lifecycle functions
+
   }, {
-    key: "renderClient",
+    key: "process",
     value: function () {
-      var _renderClient = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2(contract) {
-        var _this$options$client, enabled, options, contractInfo, files;
+      var _process = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2() {
+        var _iterator, _step, contractOpt, contract, contractInfo;
 
         return _regenerator["default"].wrap(function _callee2$(_context2) {
           while (1) {
             switch (_context2.prev = _context2.next) {
               case 0:
-                _this$options$client = this.options.client, enabled = _this$options$client.enabled, options = (0, _objectWithoutProperties2["default"])(_this$options$client, _excluded2);
+                _iterator = _createForOfIteratorHelper(this.contracts);
+                _context2.prev = 1;
+
+                _iterator.s();
 
-                if (enabled) {
-                  _context2.next = 3;
+              case 3:
+                if ((_step = _iterator.n()).done) {
+                  _context2.next = 13;
                   break;
                 }
 
-                return _context2.abrupt("return");
+                contractOpt = _step.value;
+                contract = getContract(contractOpt); //resolve contract schema.
 
-              case 3:
-                _context2.next = 5;
+                _context2.next = 8;
                 return (0, _utils.readSchemas)({
                   schemaDir: contract.dir
                 });
 
-              case 5:
-                contractInfo = _context2.sent;
-                _context2.next = 8;
-                return (0, _client["default"])(contract.name, contractInfo, this.outPath, options);
-
               case 8:
-                files = _context2.sent;
-                [].push.apply(this.files, files);
-
-              case 10:
-              case "end":
-                return _context2.stop();
-            }
-          }
-        }, _callee2, this);
-      }));
-
-      function renderClient(_x2) {
-        return _renderClient.apply(this, arguments);
-      }
+                contractInfo = _context2.sent;
+                _context2.next = 11;
+                return this.render(contract.name, contractInfo);
 
-      return renderClient;
-    }()
-  }, {
-    key: "renderRecoil",
-    value: function () {
-      var _renderRecoil = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee3(contract) {
-        var _this$options$recoil, enabled, options, contractInfo, files;
+              case 11:
+                _context2.next = 3;
+                break;
 
-        return _regenerator["default"].wrap(function _callee3$(_context3) {
-          while (1) {
-            switch (_context3.prev = _context3.next) {
-              case 0:
-                _this$options$recoil = this.options.recoil, enabled = _this$options$recoil.enabled, options = (0, _objectWithoutProperties2["default"])(_this$options$recoil, _excluded3);
+              case 13:
+                _context2.next = 18;
+                break;
 
-                if (enabled) {
-                  _context3.next = 3;
-                  break;
-                }
+              case 15:
+                _context2.prev = 15;
+                _context2.t0 = _context2["catch"](1);
 
-                return _context3.abrupt("return");
+                _iterator.e(_context2.t0);
 
-              case 3:
-                _context3.next = 5;
-                return (0, _utils.readSchemas)({
-                  schemaDir: contract.dir
-                });
+              case 18:
+                _context2.prev = 18;
 
-              case 5:
-                contractInfo = _context3.sent;
-                _context3.next = 8;
-                return (0, _recoil["default"])(contract.name, contractInfo, this.outPath, options);
+                _iterator.f();
 
-              case 8:
-                files = _context3.sent;
-                [].push.apply(this.files, files);
+                return _context2.finish(18);
 
-              case 10:
+              case 21:
               case "end":
-                return _context3.stop();
+                return _context2.stop();
             }
           }
-        }, _callee3, this);
+        }, _callee2, this, [[1, 15, 18, 21]]);
       }));
 
-      function renderRecoil(_x3) {
-        return _renderRecoil.apply(this, arguments);
+      function process() {
+        return _process.apply(this, arguments);
       }
 
-      return renderRecoil;
+      return process;
     }()
   }, {
-    key: "renderReactQuery",
+    key: "render",
     value: function () {
-      var _renderReactQuery = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee4(contract) {
-        var _this$options$reactQu, enabled, options, contractInfo, files;
+      var _render = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee3(name, contractInfo) {
+        var _iterator2, _step2, plugin, files;
 
-        return _regenerator["default"].wrap(function _callee4$(_context4) {
+        return _regenerator["default"].wrap(function _callee3$(_context3) {
           while (1) {
-            switch (_context4.prev = _context4.next) {
+            switch (_context3.prev = _context3.next) {
               case 0:
-                _this$options$reactQu = this.options.reactQuery, enabled = _this$options$reactQu.enabled, options = (0, _objectWithoutProperties2["default"])(_this$options$reactQu, _excluded4);
-
-                if (enabled) {
-                  _context4.next = 3;
-                  break;
-                }
+                _iterator2 = _createForOfIteratorHelper(this.plugins);
+                _context3.prev = 1;
 
-                return _context4.abrupt("return");
+                _iterator2.s();
 
               case 3:
-                _context4.next = 5;
-                return (0, _utils.readSchemas)({
-                  schemaDir: contract.dir
-                });
+                if ((_step2 = _iterator2.n()).done) {
+                  _context3.next = 11;
+                  break;
+                }
 
-              case 5:
-                contractInfo = _context4.sent;
-                _context4.next = 8;
-                return (0, _reactQuery["default"])(contract.name, contractInfo, this.outPath, options);
+                plugin = _step2.value;
+                _context3.next = 7;
+                return plugin.render(name, contractInfo, this.outPath);
 
-              case 8:
-                files = _context4.sent;
-                [].push.apply(this.files, files);
-
-              case 10:
-              case "end":
-                return _context4.stop();
-            }
-          }
-        }, _callee4, this);
-      }));
+              case 7:
+                files = _context3.sent;
 
-      function renderReactQuery(_x4) {
-        return _renderReactQuery.apply(this, arguments);
-      }
+                if (files && files.length) {
+                  [].push.apply(this.files, files);
+                }
 
-      return renderReactQuery;
-    }()
-  }, {
-    key: "renderMessageComposer",
-    value: function () {
-      var _renderMessageComposer = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee5(contract) {
-        var _this$options$message, enabled, options, contractInfo, files;
+              case 9:
+                _context3.next = 3;
+                break;
 
-        return _regenerator["default"].wrap(function _callee5$(_context5) {
-          while (1) {
-            switch (_context5.prev = _context5.next) {
-              case 0:
-                _this$options$message = this.options.messageComposer, enabled = _this$options$message.enabled, options = (0, _objectWithoutProperties2["default"])(_this$options$message, _excluded5);
+              case 11:
+                _context3.next = 16;
+                break;
 
-                if (enabled) {
-                  _context5.next = 3;
-                  break;
-                }
+              case 13:
+                _context3.prev = 13;
+                _context3.t0 = _context3["catch"](1);
 
-                return _context5.abrupt("return");
+                _iterator2.e(_context3.t0);
 
-              case 3:
-                _context5.next = 5;
-                return (0, _utils.readSchemas)({
-                  schemaDir: contract.dir
-                });
+              case 16:
+                _context3.prev = 16;
 
-              case 5:
-                contractInfo = _context5.sent;
-                _context5.next = 8;
-                return (0, _messageComposer["default"])(contract.name, contractInfo, this.outPath, options);
+                _iterator2.f();
 
-              case 8:
-                files = _context5.sent;
-                [].push.apply(this.files, files);
+                return _context3.finish(16);
 
-              case 10:
+              case 19:
               case "end":
-                return _context5.stop();
+                return _context3.stop();
             }
           }
-        }, _callee5, this);
+        }, _callee3, this, [[1, 13, 16, 19]]);
       }));
 
-      function renderMessageComposer(_x5) {
-        return _renderMessageComposer.apply(this, arguments);
+      function render(_x, _x2) {
+        return _render.apply(this, arguments);
       }
 
-      return renderMessageComposer;
+      return render;
     }()
   }, {
-    key: "build",
+    key: "after",
     value: function () {
-      var _build = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee6() {
-        var contracts, c, contract;
-        return _regenerator["default"].wrap(function _callee6$(_context6) {
+      var _after = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee4() {
+        return _regenerator["default"].wrap(function _callee4$(_context4) {
           while (1) {
-            switch (_context6.prev = _context6.next) {
+            switch (_context4.prev = _context4.next) {
               case 0:
-                contracts = this.getContracts();
-                c = 0;
-
-              case 2:
-                if (!(c < contracts.length)) {
-                  _context6.next = 17;
-                  break;
-                }
-
-                contract = contracts[c];
-                _context6.next = 6;
-                return this.renderTypes(contract);
-
-              case 6:
-                _context6.next = 8;
-                return this.renderClient(contract);
-
-              case 8:
-                _context6.next = 10;
-                return this.renderMessageComposer(contract);
-
-              case 10:
-                _context6.next = 12;
-                return this.renderReactQuery(contract);
-
-              case 12:
-                _context6.next = 14;
-                return this.renderRecoil(contract);
-
-              case 14:
-                c++;
-                _context6.next = 2;
-                break;
-
-              case 17:
                 if (this.options.bundle.enabled) {
                   this.bundle();
                 }
 
-              case 18:
+              case 1:
               case "end":
-                return _context6.stop();
+                return _context4.stop();
             }
           }
-        }, _callee6, this);
+        }, _callee4, this);
       }));
 
-      function build() {
-        return _build.apply(this, arguments);
+      function after() {
+        return _after.apply(this, arguments);
       }
 
-      return build;
+      return after;
     }()
   }, {
     key: "bundle",
     value: function () {
-      var _bundle = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee7() {
-        var _this = this;
+      var _bundle = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee5() {
+        var _this$options$bundle$,
+            _this$options,
+            _this$options$bundle,
+            _this = this,
+            _this$options2,
+            _this$options2$bundle;
 
-        var allFiles, bundleFile, bundleVariables, importPaths, ast, code;
-        return _regenerator["default"].wrap(function _callee7$(_context7) {
+        var allFiles, bundleFile, bundlePath, bundleVariables, importPaths, ast, code, _this$options3, _this$options3$bundle;
+
+        return _regenerator["default"].wrap(function _callee5$(_context5) {
           while (1) {
-            switch (_context7.prev = _context7.next) {
+            switch (_context5.prev = _context5.next) {
               case 0:
                 allFiles = this.files;
                 bundleFile = this.options.bundle.bundleFile;
+                bundlePath = (0, _path.join)((_this$options$bundle$ = (_this$options = this.options) === null || _this$options === void 0 ? void 0 : (_this$options$bundle = _this$options.bundle) === null || _this$options$bundle === void 0 ? void 0 : _this$options$bundle.bundlePath) !== null && _this$options$bundle$ !== void 0 ? _this$options$bundle$ : this.outPath, bundleFile);
                 bundleVariables = {};
                 importPaths = [];
                 allFiles.forEach(function (file) {
-                  (0, _bundler.createFileBundle)("".concat(_this.options.bundle.scope, ".").concat(file.contract), file.localname, bundleFile, importPaths, bundleVariables);
+                  (0, _bundler.createFileBundle)("".concat(_this.options.bundle.scope, ".").concat(file.contract), file.filename, bundlePath, importPaths, bundleVariables);
                 });
                 ast = (0, _bundler.recursiveModuleBundle)(bundleVariables);
                 code = (0, _generator["default"])(t.program([].concat(importPaths, (0, _toConsumableArray2["default"])(ast)))).code;
+
+                if ((_this$options2 = this.options) !== null && _this$options2 !== void 0 && (_this$options2$bundle = _this$options2.bundle) !== null && _this$options2$bundle !== void 0 && _this$options2$bundle.bundlePath) {
+                  (0, _mkdirp.sync)((_this$options3 = this.options) === null || _this$options3 === void 0 ? void 0 : (_this$options3$bundle = _this$options3.bundle) === null || _this$options3$bundle === void 0 ? void 0 : _this$options3$bundle.bundlePath);
+                }
+
                 (0, _mkdirp.sync)(this.outPath);
                 if (code.trim() === '') code = 'export {};';
-                (0, _fs.writeFileSync)((0, _path.join)(this.outPath, bundleFile), _header.header + code);
+                (0, _fs.writeFileSync)(bundlePath, _header.header + code);
 
-              case 10:
+              case 12:
               case "end":
-                return _context7.stop();
+                return _context5.stop();
             }
           }
-        }, _callee7, this);
+        }, _callee5, this);
       }));
 
       function bundle() {

package/main/commands/generate.js

@@ -185,6 +185,9 @@ var _default = /*#__PURE__*/function () {
               messageComposer: {
                 enabled: plugin.includes('message-composer')
               },
+              msgBuilder: {
+                enabled: plugin.includes('msg-builder')
+              },
               bundle: {
                 enabled: bundle,
                 scope: bundleScope,