@cosmwasm/ts-codegen 0.34.2 → 0.35.0

package/module/plugins/plugin-base.js

@@ -6,41 +6,36 @@ import { header } from "../utils/header";
 import generate from "@babel/generator";
 import * as t from "@babel/types";
 
+/**
+ * IBuilderPlugin is a common plugin that render generated code.
+ */
+
 /**
  * BuilderPluginBase enable ts-codegen users implement their own plugins by only implement a few functions.
  */
 export class BuilderPluginBase {
   constructor(opt, builder) {
     _defineProperty(this, "builder", void 0);
-
     _defineProperty(this, "option", void 0);
-
     _defineProperty(this, "utils", void 0);
-
     this.option = opt;
     this.builder = builder;
   }
-
   setBuilder(builder) {
     this.builder = builder;
   }
-
   async render(name, contractInfo, outPath) {
     const {
       enabled
     } = this.option;
-
     if (!enabled) {
       return;
     }
-
     const context = this.initContext(contractInfo, this.option);
     const results = await this.doRender(name, context);
-
     if (!results || !results.length) {
       return [];
     }
-
     return results.map(result => {
       const imports = context.getImports(this.utils, result.localname);
       const code = header + generate(t.program([...imports, ...result.body])).code;
@@ -56,11 +51,16 @@ export class BuilderPluginBase {
       };
     });
   }
+
   /**
    * init context here
    * @param contract
    * @param options
    */
 
-
+  /**
+   * render generated code here.
+   * @param name
+   * @param context
+   */
 }

package/module/plugins/provider-bundle.js

@@ -14,22 +14,17 @@ export class ContractsProviderBundlePlugin extends BuilderPluginBase {
       IMessageComposerProvider: "__contractContextBase__"
     };
   }
-
   initContext(contract, options) {
     return new RenderContext(contract, options, this.builder.builderContext);
   }
-
   async doRender(name, context) {
     if (!this.option?.useContractsHooks?.enabled) {
       return;
     }
-
     const providerInfos = context.getProviderInfos();
-
     if (!Object.keys(providerInfos)?.length) {
       return;
     }
-
     const localname = "contractContextProviders.ts";
     const body = [];
     context.addUtil("CosmWasmClient");
@@ -37,22 +32,18 @@ export class ContractsProviderBundlePlugin extends BuilderPluginBase {
     context.addUtil("IQueryClientProvider");
     context.addUtil("ISigningClientProvider");
     context.addUtil("IMessageComposerProvider");
-
     for (const name in providerInfos) {
       if (Object.prototype.hasOwnProperty.call(providerInfos, name)) {
         const providerInfo = providerInfos[name];
-
         for (const key in providerInfo) {
           if (Object.prototype.hasOwnProperty.call(providerInfo, key)) {
             const info = providerInfo[key];
             body.push(w.importStmt([info.classname], `./${info.basename}`));
           }
         }
-
         body.push(w.importStmt([pascal(name)], `./${GetLocalBaseNameByContractName(name)}`));
       }
     }
-
     body.push(w.createIContractsContext(providerInfos));
     body.push(w.createGettingProviders(providerInfos));
     return [{
@@ -62,5 +53,4 @@ export class ContractsProviderBundlePlugin extends BuilderPluginBase {
       body
     }];
   }
-
 }

package/module/plugins/provider.js

@@ -13,22 +13,17 @@ export class ContractsContextProviderPlugin extends BuilderPluginBase {
       IEmptyClient: "__contractContextBase__"
     };
   }
-
   initContext(contract, options) {
     return new RenderContext(contract, options, this.builder.builderContext);
   }
-
   async doRender(name, context) {
     if (!this.option?.useContractsHooks?.enabled) {
       return;
     }
-
     const providerInfo = context.getProviderInfos()[name];
-
     if (!Object.keys(providerInfo)?.length) {
       return;
     }
-
     context.addUtil("ContractBase");
     context.addUtil("IContractConstructor");
     const localname = GetLocalNameByContractName(name);
@@ -37,39 +32,31 @@ export class ContractsContextProviderPlugin extends BuilderPluginBase {
     let clientClasses = [];
     const body = [];
     const signClientProviderInfo = providerInfo[w.PROVIDER_TYPES.SIGNING_CLIENT_TYPE];
-
     if (signClientProviderInfo) {
       clientFile = `./${signClientProviderInfo.basename}`;
       clientClasses.push(signClientProviderInfo.classname);
     } else {
       needEmptyClientType = true;
     }
-
     const queryClientProviderInfo = providerInfo[w.PROVIDER_TYPES.QUERY_CLIENT_TYPE];
-
     if (queryClientProviderInfo) {
       clientFile = `./${queryClientProviderInfo.basename}`;
       clientClasses.push(queryClientProviderInfo.classname);
     } else {
       needEmptyClientType = true;
     }
-
     if (clientFile) {
       body.push(w.importStmt(clientClasses, clientFile));
     }
-
     const messageComposerProviderInfo = providerInfo[w.PROVIDER_TYPES.MESSAGE_COMPOSER_TYPE];
-
     if (messageComposerProviderInfo) {
       body.push(w.importStmt([messageComposerProviderInfo.classname], `./${messageComposerProviderInfo.basename}`));
     } else {
       needEmptyClientType = true;
     }
-
     if (needEmptyClientType) {
       context.addUtil("IEmptyClient");
     }
-
     body.push(w.createProvider(name, providerInfo));
     return [{
       type: "plugin",
@@ -78,5 +65,4 @@ export class ContractsContextProviderPlugin extends BuilderPluginBase {
       body
     }];
   }
-
 }

package/module/plugins/react-query.js

@@ -7,17 +7,14 @@ export class ReactQueryPlugin extends BuilderPluginBase {
   initContext(contract, options) {
     return new RenderContext(contract, options, this.builder.builderContext);
   }
-
   async doRender(name, context) {
     const options = this.option.reactQuery;
     const {
       enabled
     } = options;
-
     if (!enabled) {
       return;
     }
-
     const {
       schemas
     } = context.contract;
@@ -31,19 +28,21 @@ export class ReactQueryPlugin extends BuilderPluginBase {
     const QueryClient = pascal(`${name}QueryClient`);
     const body = [];
     const clientImports = [];
-    QueryMsg && clientImports.push(QueryClient); // check that there are commands within the exec msg
+    QueryMsg && clientImports.push(QueryClient);
 
+    // check that there are commands within the exec msg
     const shouldGenerateMutationHooks = ExecuteMsg && options?.version === 'v4' && options?.mutations && getMessageProperties(ExecuteMsg).length > 0;
-
     if (shouldGenerateMutationHooks) {
       clientImports.push(ExecuteClient);
-    } // general contract imports
-
+    }
 
-    body.push(w.importStmt(Object.keys(typeHash), `./${TypesFile}`)); // client imports
+    // general contract imports
+    body.push(w.importStmt(Object.keys(typeHash), `./${TypesFile}`));
 
-    body.push(w.importStmt(clientImports, `./${ContractFile}`)); // query messages
+    // client imports
+    body.push(w.importStmt(clientImports, `./${ContractFile}`));
 
+    // query messages
     if (QueryMsg) {
       [].push.apply(body, w.createReactQueryHooks({
         context,
@@ -52,7 +51,6 @@ export class ReactQueryPlugin extends BuilderPluginBase {
         QueryClient
       }));
     }
-
     if (shouldGenerateMutationHooks) {
       [].push.apply(body, w.createReactQueryMutationHooks({
         context,
@@ -61,17 +59,14 @@ export class ReactQueryPlugin extends BuilderPluginBase {
         ExecuteClient
       }));
     }
-
     if (typeHash.hasOwnProperty('Coin')) {
       // @ts-ignore
       delete context.utils.Coin;
     }
-
     return [{
       type: 'react-query',
       localname,
       body
     }];
   }
-
 }

package/module/plugins/recoil.js

@@ -7,25 +7,20 @@ import { BuilderPluginBase } from './plugin-base';
 export class RecoilPlugin extends BuilderPluginBase {
   constructor(...args) {
     super(...args);
-
     _defineProperty(this, "utils", {
       selectorFamily: 'recoil'
     });
   }
-
   initContext(contract, options) {
     return new RenderContext(contract, options, this.builder.builderContext);
   }
-
   async doRender(name, context) {
     const {
       enabled
     } = this.option.recoil;
-
     if (!enabled) {
       return;
     }
-
     const {
       schemas
     } = context.contract;
@@ -38,8 +33,9 @@ export class RecoilPlugin extends BuilderPluginBase {
     let ReadOnlyInstance = null;
     const body = [];
     body.push(w.importStmt(['cosmWasmClient'], './chain'));
-    body.push(w.importStmt(Object.keys(typeHash), `./${TypesFile}`)); // query messages
+    body.push(w.importStmt(Object.keys(typeHash), `./${TypesFile}`));
 
+    // query messages
     if (QueryMsg) {
       QueryClient = pascal(`${name}QueryClient`);
       ReadOnlyInstance = pascal(`${name}ReadOnlyInterface`);
@@ -48,17 +44,14 @@ export class RecoilPlugin extends BuilderPluginBase {
       body.push(w.createRecoilQueryClient(context, name, QueryClient));
       [].push.apply(body, w.createRecoilSelectors(context, name, QueryClient, QueryMsg));
     }
-
     if (typeHash.hasOwnProperty('Coin')) {
       // @ts-ignore
       delete context.utils.Coin;
     }
-
     return [{
       type: 'recoil',
       localname,
       body
     }];
   }
-
 }

package/module/plugins/types.js

@@ -8,16 +8,13 @@ export class TypesPlugin extends BuilderPluginBase {
   initContext(contract, options) {
     return new RenderContext(contract, options, this.builder.builderContext);
   }
-
   async doRender(name, context) {
     const {
       enabled
     } = this.option.types;
-
     if (!enabled) {
       return;
     }
-
     const {
       schemas
     } = context.contract;
@@ -25,21 +22,21 @@ export class TypesPlugin extends BuilderPluginBase {
     const localname = pascal(name) + '.types.ts';
     const ExecuteMsg = findExecuteMsg(schemas);
     const typeHash = await findAndParseTypes(schemas);
-    const body = []; // TYPES
+    const body = [];
 
+    // TYPES
     Object.values(typeHash).forEach(type => {
       body.push(clean(type));
-    }); // alias the ExecuteMsg
+    });
 
+    // alias the ExecuteMsg
     if (options.aliasExecuteMsg && ExecuteMsg) {
       body.push(t.exportNamedDeclaration(t.tsTypeAliasDeclaration(t.identifier(`${name}ExecuteMsg`), null, t.tsTypeReference(t.identifier('ExecuteMsg')))));
     }
-
     return [{
       type: 'type',
       localname,
       body
     }];
   }
-
 }

package/module/ts-codegen.js

@@ -1,8 +1,6 @@
 #!/usr/bin/env node
 import { cli } from './cli';
-
 var argv = require('minimist')(process.argv.slice(2));
-
 (async () => {
   await cli(argv);
 })();

package/module/utils/clean.js

@@ -1,29 +1,27 @@
 export const clean = obj => {
-  var copy; // Handle the 3 simple types, and null or undefined
-
-  if (null == obj || 'object' != typeof obj) return obj; // Handle Date
+  var copy;
+  // Handle the 3 simple types, and null or undefined
+  if (null == obj || 'object' != typeof obj) return obj;
 
+  // Handle Date
   if (obj instanceof Date) {
     copy = new Date();
     copy.setTime(obj.getTime());
     return copy;
-  } // Handle Array
-
+  }
 
+  // Handle Array
   if (obj instanceof Array) {
     copy = [];
-
     for (var i = 0, len = obj.length; i < len; i++) {
       copy[i] = clean(obj[i]);
     }
-
     return copy;
-  } // Handle Object
-
+  }
 
+  // Handle Object
   if (obj instanceof Object || typeof obj === 'object') {
     copy = {};
-
     for (var attr in obj) {
       if (obj.hasOwnProperty(attr)) {
         switch (attr) {
@@ -33,7 +31,6 @@ export const clean = obj => {
           case 'start':
           case 'end':
             break;
-
           default:
             copy[attr] = clean(obj[attr]);
         }
@@ -41,9 +38,7 @@ export const clean = obj => {
         copy[attr] = clean(obj[attr]);
       }
     }
-
     return copy;
   }
-
   throw new Error("Unable to copy obj! Its type isn't supported.");
 };

package/module/utils/cleanse.js

@@ -1,5 +1,4 @@
 import { pascal } from "case";
-
 const cleanFor = str => {
   /*
       1. look at first char after _for_
@@ -9,52 +8,46 @@ const cleanFor = str => {
     const m = str.match(/(_[a-z]+_)[A-Z]/);
     str = str.replace(m[1], pascal(m[1]));
   }
-
   return str;
 };
-
 const cleanNullable = str => {
   if (/^Nullable_/.test(str)) {
     str = str.replace(/^Nullable_/, 'Nullable');
   }
-
   return str;
 };
-
 export const cleanse = obj => {
-  var copy; // Handle the 3 simple types, and null or undefined
-
-  if (null == obj || 'object' != typeof obj) return obj; // Handle Date
+  var copy;
+  // Handle the 3 simple types, and null or undefined
+  if (null == obj || 'object' != typeof obj) return obj;
 
+  // Handle Date
   if (obj instanceof Date) {
     copy = new Date();
     copy.setTime(obj.getTime());
     return copy;
-  } // Handle Array
-
+  }
 
+  // Handle Array
   if (obj instanceof Array) {
     copy = [];
-
     for (var i = 0, len = obj.length; i < len; i++) {
       copy[i] = cleanse(obj[i]);
     }
-
     return copy;
-  } // Handle Object
-
+  }
 
+  // Handle Object
   if (obj instanceof Object || typeof obj === 'object') {
-    copy = {}; // https://github.com/CosmWasm/cosmwasm-typescript-gen/issues/27
+    copy = {};
 
+    // https://github.com/CosmWasm/cosmwasm-typescript-gen/issues/27
     if (Array.isArray(obj.enum) && obj.enum.length === 0) {
       delete obj.enum;
-
       if (!obj.type) {
         obj.type = 'string';
       }
     }
-
     for (var attr in obj) {
       if (obj.hasOwnProperty(attr)) {
         if (/_for_/.test(attr)) {
@@ -70,9 +63,7 @@ export const cleanse = obj => {
               } else {
                 copy[attr] = cleanse(obj[attr]);
               }
-
               break;
-
             default:
               copy[attr] = cleanse(obj[attr]);
           }
@@ -81,9 +72,7 @@ export const cleanse = obj => {
         copy[attr] = cleanse(obj[attr]);
       }
     }
-
     return copy;
   }
-
   throw new Error("Unable to copy obj! Its type isn't supported.");
 };

package/module/utils/files.js

@@ -9,7 +9,6 @@ import traverse from "@babel/traverse";
 export const writeAstToFile = (outPath, program, filename, removeUnusedImports = false, isTsDisable = false, isEslintDisable = false) => {
   const ast = t.program(program);
   const content = generate(ast).code;
-
   if (removeUnusedImports) {
     const plugins = ["typescript"];
     const newAst = parse(content, {
@@ -26,18 +25,15 @@ export const writeAstToFile = (outPath, program, filename, removeUnusedImports =
 export const writeContentToFile = (outPath, content, filename, isTsDisable = false, isEslintDisable = false) => {
   let esLintPrefix = "";
   let tsLintPrefix = "";
-  let nameWithoutPath = filename.replace(outPath, ""); // strip off leading slash
-
+  let nameWithoutPath = filename.replace(outPath, "");
+  // strip off leading slash
   if (nameWithoutPath.startsWith("/")) nameWithoutPath = nameWithoutPath.replace(/^\//, "");
-
   if (isTsDisable) {
     tsLintPrefix = `//@ts-nocheck\n`;
   }
-
   if (isEslintDisable) {
     esLintPrefix = `/* eslint-disable */\n`;
   }
-
   const text = tsLintPrefix + esLintPrefix + content;
   mkdirp(dirname(filename));
   writeFileSync(filename, text);

package/module/utils/parse.js

@@ -12,16 +12,15 @@ export const parser = codes => {
       addType(key, node) {
         hash[key] = node;
       }
-
     });
     babelTraverse(ast, visitor);
   });
   return hash;
 };
-
 const visitorFn = parser => ({
   TSTypeAliasDeclaration(path) {
-    parser.addType(path.node.id.name, path.parentPath.node); // if (path.node.id.name.endsWith('For_Empty')) {
+    parser.addType(path.node.id.name, path.parentPath.node);
+    // if (path.node.id.name.endsWith('For_Empty')) {
     //     const newName = path.node.id.name.replace(/For_Empty$/, '_for_Empty');
     //     path.parentPath.node.declaration.id.name = newName;
     //     parser.addType(newName, path.parentPath.node);
@@ -33,5 +32,4 @@ const visitorFn = parser => ({
   TSInterfaceDeclaration(path) {
     parser.addType(path.node.id.name, path.parentPath.node);
   }
-
 });

package/module/utils/prompt.js

@@ -1,9 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
-
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
 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) { _defineProperty(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; }
-
 import { filter } from 'fuzzy';
 import { prompt as inquirerer } from 'inquirerer';
 export const getFuzzySearch = list => {
@@ -39,7 +36,6 @@ export const getFuzzySearchNames = nameValueItemList => {
     });
   };
 };
-
 const transform = questions => {
   return questions.map(q => {
     if (q.type === 'fuzzy') {
@@ -61,7 +57,6 @@ const transform = questions => {
     }
   });
 };
-
 export const prompt = async (questions = [], argv = {}) => {
   questions = transform(questions);
   return await inquirerer(questions, argv);

package/module/utils/schemas.js

@@ -1,9 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
-
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
 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) { _defineProperty(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; }
-
 import { sync as glob } from 'glob';
 import { readFileSync } from 'fs';
 import { cleanse } from './cleanse';
@@ -17,7 +14,6 @@ export const readSchemas = async ({
   const fn = clean ? cleanse : str => str;
   const files = glob(schemaDir + '/**/*.json').filter(file => !file.match(/\/raw\//));
   const schemas = files.map(file => JSON.parse(readFileSync(file, 'utf-8')));
-
   if (schemas.length > 1) {
     // legacy
     // TODO add console.warn here
@@ -25,15 +21,12 @@ export const readSchemas = async ({
       schemas: fn(schemas)
     };
   }
-
   if (schemas.length === 0) {
     throw new Error('Error [too few files]: requires one schema file per contract');
   }
-
   if (schemas.length !== 1) {
     throw new Error('Error [too many files]: CosmWasm v1.1 schemas supports one file');
   }
-
   const idlObject = schemas[0];
   const {
     contract_name,
@@ -46,15 +39,14 @@ export const readSchemas = async ({
     migrate,
     sudo
   } = idlObject;
-
   if (typeof idl_version !== 'string') {
     // legacy
     return {
       schemas: fn(schemas)
     };
-  } // TODO use contract_name, etc.
-
+  }
 
+  // TODO use contract_name, etc.
   return {
     schemas: [...Object.values(fn({
       instantiate,
@@ -78,7 +70,6 @@ export const findExecuteMsg = schemas => {
 export const findAndParseTypes = async schemas => {
   const Types = schemas;
   const allTypes = [];
-
   for (const typ in Types) {
     if (Types[typ].definitions) {
       for (const key of Object.keys(Types[typ].definitions)) {
@@ -86,11 +77,9 @@ export const findAndParseTypes = async schemas => {
         Types[typ].definitions[key].title = key;
       }
     }
-
     const result = await compile(Types[typ], Types[typ].title);
     allTypes.push(result);
   }
-
   const typeHash = parser(allTypes);
   return typeHash;
 };