@cosmwasm/ts-codegen 0.13.3 → 0.14.1

package/README.md

@@ -106,7 +106,8 @@ codegen({
       enabled: true,
       optionalClient: true,
       version: 'v4',
-      mutations: true
+      mutations: true,
+      queryKeys: true,
     },
     recoil: {
       enabled: false
@@ -161,13 +162,14 @@ Generate [react-query v3](https://react-query-v3.tanstack.com/) or [react-query
 
 #### React Query Options
 
-  | option                         | description                                                         |
-  | ------------------------------ | ------------------------------------------------------------------- |
-  | `reactQuery.enabled`           | enable the react-query plugin                                       |
-  | `reactQuery.optionalClient`    | allows contract client to be undefined as the component renders     |
-  | `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                              |
+  | option                      | description                                                                  |
+  | ----------------------------| ---------------------------------------------------------------------------- |
+  | `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.version`        | `v4` uses `@tanstack/react-query` and `v3` uses `react-query`                |
+  | `reactQuery.mutations`      | also generate mutations                                                      |
+  | `reactQuery.camelize`       | use camelCase style for property names                                       |
 
 
 #### React Query via CLI 

package/main/builder/builder.js

@@ -114,7 +114,7 @@ var TSBuilder = /*#__PURE__*/function () {
     key: "renderTypes",
     value: function () {
       var _renderTypes = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(contract) {
-        var _this$options$types, enabled, options, schemas, files;
+        var _this$options$types, enabled, options, _yield$readSchemas, schemas, files;
 
         return _regenerator["default"].wrap(function _callee$(_context) {
           while (1) {
@@ -136,15 +136,16 @@ var TSBuilder = /*#__PURE__*/function () {
                 });
 
               case 5:
-                schemas = _context.sent;
-                _context.next = 8;
+                _yield$readSchemas = _context.sent;
+                schemas = _yield$readSchemas.schemas;
+                _context.next = 9;
                 return (0, _types["default"])(contract.name, schemas, this.outPath, options);
 
-              case 8:
+              case 9:
                 files = _context.sent;
                 [].push.apply(this.files, files);
 
-              case 10:
+              case 11:
               case "end":
                 return _context.stop();
             }
@@ -162,7 +163,7 @@ var TSBuilder = /*#__PURE__*/function () {
     key: "renderClient",
     value: function () {
       var _renderClient = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2(contract) {
-        var _this$options$client, enabled, options, schemas, files;
+        var _this$options$client, enabled, options, _yield$readSchemas2, schemas, files;
 
         return _regenerator["default"].wrap(function _callee2$(_context2) {
           while (1) {
@@ -184,15 +185,16 @@ var TSBuilder = /*#__PURE__*/function () {
                 });
 
               case 5:
-                schemas = _context2.sent;
-                _context2.next = 8;
+                _yield$readSchemas2 = _context2.sent;
+                schemas = _yield$readSchemas2.schemas;
+                _context2.next = 9;
                 return (0, _client["default"])(contract.name, schemas, this.outPath, options);
 
-              case 8:
+              case 9:
                 files = _context2.sent;
                 [].push.apply(this.files, files);
 
-              case 10:
+              case 11:
               case "end":
                 return _context2.stop();
             }
@@ -210,7 +212,7 @@ var TSBuilder = /*#__PURE__*/function () {
     key: "renderRecoil",
     value: function () {
       var _renderRecoil = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee3(contract) {
-        var _this$options$recoil, enabled, options, schemas, files;
+        var _this$options$recoil, enabled, options, _yield$readSchemas3, schemas, files;
 
         return _regenerator["default"].wrap(function _callee3$(_context3) {
           while (1) {
@@ -232,15 +234,16 @@ var TSBuilder = /*#__PURE__*/function () {
                 });
 
               case 5:
-                schemas = _context3.sent;
-                _context3.next = 8;
+                _yield$readSchemas3 = _context3.sent;
+                schemas = _yield$readSchemas3.schemas;
+                _context3.next = 9;
                 return (0, _recoil["default"])(contract.name, schemas, this.outPath, options);
 
-              case 8:
+              case 9:
                 files = _context3.sent;
                 [].push.apply(this.files, files);
 
-              case 10:
+              case 11:
               case "end":
                 return _context3.stop();
             }
@@ -258,7 +261,7 @@ var TSBuilder = /*#__PURE__*/function () {
     key: "renderReactQuery",
     value: function () {
       var _renderReactQuery = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee4(contract) {
-        var _this$options$reactQu, enabled, options, schemas, files;
+        var _this$options$reactQu, enabled, options, _yield$readSchemas4, schemas, files;
 
         return _regenerator["default"].wrap(function _callee4$(_context4) {
           while (1) {
@@ -280,15 +283,16 @@ var TSBuilder = /*#__PURE__*/function () {
                 });
 
               case 5:
-                schemas = _context4.sent;
-                _context4.next = 8;
+                _yield$readSchemas4 = _context4.sent;
+                schemas = _yield$readSchemas4.schemas;
+                _context4.next = 9;
                 return (0, _reactQuery["default"])(contract.name, schemas, this.outPath, options);
 
-              case 8:
+              case 9:
                 files = _context4.sent;
                 [].push.apply(this.files, files);
 
-              case 10:
+              case 11:
               case "end":
                 return _context4.stop();
             }
@@ -306,7 +310,7 @@ var TSBuilder = /*#__PURE__*/function () {
     key: "renderMessageComposer",
     value: function () {
       var _renderMessageComposer = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee5(contract) {
-        var _this$options$message, enabled, options, schemas, files;
+        var _this$options$message, enabled, options, _yield$readSchemas5, schemas, files;
 
         return _regenerator["default"].wrap(function _callee5$(_context5) {
           while (1) {
@@ -328,15 +332,16 @@ var TSBuilder = /*#__PURE__*/function () {
                 });
 
               case 5:
-                schemas = _context5.sent;
-                _context5.next = 8;
+                _yield$readSchemas5 = _context5.sent;
+                schemas = _yield$readSchemas5.schemas;
+                _context5.next = 9;
                 return (0, _messageComposer["default"])(contract.name, schemas, this.outPath, options);
 
-              case 8:
+              case 9:
                 files = _context5.sent;
                 [].push.apply(this.files, files);
 
-              case 10:
+              case 11:
               case "end":
                 return _context5.stop();
             }

package/main/utils/schemas.js

@@ -27,17 +27,18 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 
+;
 ;
 
 var readSchemas = /*#__PURE__*/function () {
   var _ref2 = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(_ref) {
-    var schemaDir, schemaOptions, _ref$clean, clean, fn, files, schemas;
+    var schemaDir, _ref$clean, clean, fn, files, schemas, idlObject, contract_name, contract_version, idl_version, responses, instantiate, execute, query, migrate, sudo;
 
     return _regenerator["default"].wrap(function _callee$(_context) {
       while (1) {
         switch (_context.prev = _context.next) {
           case 0:
-            schemaDir = _ref.schemaDir, schemaOptions = _ref.schemaOptions, _ref$clean = _ref.clean, clean = _ref$clean === void 0 ? true : _ref$clean;
+            schemaDir = _ref.schemaDir, _ref$clean = _ref.clean, clean = _ref$clean === void 0 ? true : _ref$clean;
             fn = clean ? _cleanse.cleanse : function (str) {
               return str;
             };
@@ -46,25 +47,57 @@ var readSchemas = /*#__PURE__*/function () {
               return JSON.parse((0, _fs.readFileSync)(file, 'utf-8'));
             });
 
-            if (!(schemaOptions !== null && schemaOptions !== void 0 && schemaOptions.packed)) {
+            if (!(schemas.length > 1)) {
+              _context.next = 6;
+              break;
+            }
+
+            return _context.abrupt("return", {
+              schemas: fn(schemas)
+            });
+
+          case 6:
+            if (!(schemas.length === 0)) {
               _context.next = 8;
               break;
             }
 
+            throw new Error('Error [too few files]: requires one schema file per contract');
+
+          case 8:
             if (!(schemas.length !== 1)) {
-              _context.next = 7;
+              _context.next = 10;
               break;
             }
 
-            throw new Error('packed option only supports one file');
+            throw new Error('Error [too many files]: CosmWasm v1.1 schemas supports one file');
 
-          case 7:
-            return _context.abrupt("return", Object.values(fn(schemas[0])));
+          case 10:
+            idlObject = schemas[0];
+            contract_name = idlObject.contract_name, contract_version = idlObject.contract_version, idl_version = idlObject.idl_version, responses = idlObject.responses, instantiate = idlObject.instantiate, execute = idlObject.execute, query = idlObject.query, migrate = idlObject.migrate, sudo = idlObject.sudo;
 
-          case 8:
-            return _context.abrupt("return", fn(schemas));
+            if (!(typeof idl_version !== 'string')) {
+              _context.next = 14;
+              break;
+            }
+
+            return _context.abrupt("return", {
+              schemas: fn(schemas)
+            });
+
+          case 14:
+            return _context.abrupt("return", {
+              schemas: Object.values(fn({
+                instantiate: instantiate,
+                execute: execute,
+                query: query,
+                migrate: migrate,
+                sudo: sudo
+              })).filter(Boolean),
+              idlObject: idlObject
+            });
 
-          case 9:
+          case 15:
           case "end":
             return _context.stop();
         }

package/module/builder/builder.js

@@ -77,7 +77,9 @@ export class TSBuilder {
           options = _objectWithoutProperties(_this$options$types, _excluded);
 
     if (!enabled) return;
-    const schemas = await readSchemas({
+    const {
+      schemas
+    } = await readSchemas({
       schemaDir: contract.dir
     });
     const files = await generateTypes(contract.name, schemas, this.outPath, options);
@@ -92,7 +94,9 @@ export class TSBuilder {
           options = _objectWithoutProperties(_this$options$client, _excluded2);
 
     if (!enabled) return;
-    const schemas = await readSchemas({
+    const {
+      schemas
+    } = await readSchemas({
       schemaDir: contract.dir
     });
     const files = await generateClient(contract.name, schemas, this.outPath, options);
@@ -107,7 +111,9 @@ export class TSBuilder {
           options = _objectWithoutProperties(_this$options$recoil, _excluded3);
 
     if (!enabled) return;
-    const schemas = await readSchemas({
+    const {
+      schemas
+    } = await readSchemas({
       schemaDir: contract.dir
     });
     const files = await generateRecoil(contract.name, schemas, this.outPath, options);
@@ -122,7 +128,9 @@ export class TSBuilder {
           options = _objectWithoutProperties(_this$options$reactQu, _excluded4);
 
     if (!enabled) return;
-    const schemas = await readSchemas({
+    const {
+      schemas
+    } = await readSchemas({
       schemaDir: contract.dir
     });
     const files = await generateReactQuery(contract.name, schemas, this.outPath, options);
@@ -137,7 +145,9 @@ export class TSBuilder {
           options = _objectWithoutProperties(_this$options$message, _excluded5);
 
     if (!enabled) return;
-    const schemas = await readSchemas({
+    const {
+      schemas
+    } = await readSchemas({
       schemaDir: contract.dir
     });
     const files = await generateMessageComposer(contract.name, schemas, this.outPath, options);

package/module/utils/schemas.js

@@ -10,24 +10,62 @@ import { cleanse } from './cleanse';
 import { compile } from '@pyramation/json-schema-to-typescript';
 import { parser } from './parse';
 ;
+;
 export const readSchemas = async ({
   schemaDir,
-  schemaOptions,
   clean = true
 }) => {
   const fn = clean ? cleanse : str => str;
   const files = glob(schemaDir + '/**/*.json');
   const schemas = files.map(file => JSON.parse(readFileSync(file, 'utf-8')));
 
-  if (schemaOptions?.packed) {
-    if (schemas.length !== 1) {
-      throw new Error('packed option only supports one file');
-    }
+  if (schemas.length > 1) {
+    // legacy
+    // TODO add console.warn here
+    return {
+      schemas: fn(schemas)
+    };
+  }
+
+  if (schemas.length === 0) {
+    throw new Error('Error [too few files]: requires one schema file per contract');
+  }
 
-    return Object.values(fn(schemas[0]));
+  if (schemas.length !== 1) {
+    throw new Error('Error [too many files]: CosmWasm v1.1 schemas supports one file');
   }
 
-  return fn(schemas);
+  const idlObject = schemas[0];
+  const {
+    contract_name,
+    contract_version,
+    idl_version,
+    responses,
+    instantiate,
+    execute,
+    query,
+    migrate,
+    sudo
+  } = idlObject;
+
+  if (typeof idl_version !== 'string') {
+    // legacy
+    return {
+      schemas: fn(schemas)
+    };
+  } // TODO use contract_name, etc.
+
+
+  return {
+    schemas: Object.values(fn({
+      instantiate,
+      execute,
+      query,
+      migrate,
+      sudo
+    })).filter(Boolean),
+    idlObject
+  };
 };
 export const findQueryMsg = schemas => {
   const QueryMsg = schemas.find(schema => schema.title === 'QueryMsg');

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@cosmwasm/ts-codegen",
-  "version": "0.13.3",
+  "version": "0.14.1",
   "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",
   "license": "SEE LICENSE IN LICENSE",
   "main": "main/index.js",
   "module": "module/index.js",
-  "typings": "types/index.d.ts",
+  "typings": "types/src/index.d.ts",
   "bin": {
     "cosmwasm-ts-codegen": "main/ts-codegen.js"
   },
@@ -96,5 +96,5 @@
     "shelljs": "0.8.5",
     "wasm-ast-types": "^0.9.0"
   },
-  "gitHead": "50046a43a3c9464fb8f8f84522d6433f25b1dc50"
+  "gitHead": "4aad0373cb937e7dce0798f7cda0c935ecde9cd8"
 }

package/types/src/types.d.ts

@@ -1 +1,16 @@
+import { JSONSchema } from "wasm-ast-types";
+interface KeyedSchema {
+    [key: string]: JSONSchema;
+}
+export interface IDLObject {
+    contract_name: string;
+    contract_version: string;
+    idl_version: string;
+    instantiate: JSONSchema;
+    execute: JSONSchema;
+    query: JSONSchema;
+    migrate: JSONSchema;
+    sudo: JSONSchema;
+    responses: KeyedSchema;
+}
 export {};

package/types/src/utils/schemas.d.ts

@@ -1,12 +1,14 @@
 import { JSONSchema } from 'wasm-ast-types';
+import { IDLObject } from '../types';
 interface ReadSchemaOpts {
     schemaDir: string;
-    schemaOptions?: {
-        packed?: boolean;
-    };
     clean?: boolean;
 }
-export declare const readSchemas: ({ schemaDir, schemaOptions, clean }: ReadSchemaOpts) => Promise<any>;
+interface ReadSchemasValue {
+    schemas: JSONSchema[];
+    idlObject?: IDLObject;
+}
+export declare const readSchemas: ({ schemaDir, clean }: ReadSchemaOpts) => Promise<ReadSchemasValue>;
 export declare const findQueryMsg: (schemas: any) => any;
 export declare const findExecuteMsg: (schemas: any) => any;
 export declare const findAndParseTypes: (schemas: any) => Promise<{}>;