allow specifying alias to override all of type e.g bytes or uint int

Author: matmar10

README.md

@@ -25,6 +25,10 @@ const mapper = new Mapper();
 ```JavaScript
 const mapper = new Mapper({
   types: {
+    // convert ALL int types to string
+    int: function (val) {
+      return Web3.utils.BN(val).toString();
+    },
     // convert all uint256 to string; default is BN
     uint256: function(val) {
       return Web3.utils.BN(val).toString();

example.js

@@ -1,7 +1,9 @@
 'use strict';
 
-const Mapper = require('./');
 const Web3 = require('web3');
+const moment = require('moment');
+
+const Mapper = require('./');
 
 function bNToString(val) {
   return Web3.utils.BN(val).toString();
@@ -11,19 +13,28 @@ const mapper = new Mapper({
   mapping: {
     state: [
       {
-        key: 'state',
+        key: 'stateName',
         transform: function (val) {
           const index = Number(val.toString());
           const states = ['Funding', 'Active', 'Matured'];
           return states[index];
         },
       },
-      'stateName',
+      {
+        key: 'state',
+        transform: val => val.toNumber(),
+      },
     ],
+    maturityDeadline: {
+      transform: function (val) {
+        return moment.unix(val.toNumber());
+      },
+    },
   },
   types: {
-    int8: bNToString,
-    uint256: bNToString,
+    bytes: Web3.utils.hexToUtf8,
+    int: bNToString,
+    uint: bNToString,
   },
   workingDirectory: __dirname,
 });

lib/object-mapper.js

@@ -66,8 +66,29 @@ class TruffleObjectMapper {
       && !node.inputs.length);
   }
 
-  getDefaultTransformation(type) {
-    return this._types[type] || noop;
+  getAliasForType(type) {
+    const aliases = Object.keys(TruffleObjectMapper.typeAliasesRegex);
+    for (let i = 0; i < aliases.length; i++) {
+      const alias = aliases[i];
+      const regex = TruffleObjectMapper.typeAliasesRegex[alias];
+      if (regex.test(type)) {
+        return alias;
+      }
+    }
+    return false;
+  }
+
+  getDefaultTransformationForAlias(type) {
+    const alias = this.getAliasForType(type);
+    if (!alias) {
+      return false;
+    }
+    return this._types[alias];
+  }
+
+  getDefaultTransformationForType(type) {
+    const defaultForAlias = this.getDefaultTransformationForAlias(type);
+    return this._types[type] ? this._types[type] : defaultForAlias || noop;
   }
 
   async map(contractName, at, mapping = {}) {
@@ -100,7 +121,11 @@ class TruffleObjectMapper {
   }
 
   buildOutputMapping(key, type, customMapping) {
-    const transform = this.getDefaultTransformation(type);
+    // order:
+    // - exact match on type, ex: bytes32
+    // - general match on alias, ex: uint8 matches uint
+    // - noop
+    const transform = this.getDefaultTransformationForType(type);
     const defaultMapping = { key, transform };
     if (!customMapping) {
       return defaultMapping;
@@ -119,6 +144,12 @@ class TruffleObjectMapper {
   }
 }
 
+TruffleObjectMapper.typeAliasesRegex = {
+  bytes: /^bytes/,
+  int: /^int/,
+  uint: /^uint/,
+};
+
 TruffleObjectMapper.types = types;
 
 module.exports = TruffleObjectMapper;

package-lock.json

@@ -28,6 +28,7 @@
     "camel-case": "^4.1.0",
     "deepmerge": "^4.2.2",
     "glob": "^7.1.6",
+    "moment": "^2.24.0",
     "object-mapper": "^6.0.1",
     "truffle-hdwallet-provider-privkey": "^0.3.0",
     "web3": "^1.2.4"