Merge branch 'development'

3 files changed, 32 insertions, 22 deletions

diff --git a/packages/react-docs/src/utils/doxity_utils.ts b/packages/react-docs/src/utils/doxity_utils.ts
index 1b91690e0..6815daa0c 100644
--- a/packages/react-docs/src/utils/doxity_utils.ts
+++ b/packages/react-docs/src/utils/doxity_utils.ts
@@ -31,8 +31,8 @@ export const doxityUtils = {
                     comment: doxityConstructor.details,
                     returnComment: doxityConstructor.return,
                     callPath: '',
-                    parameters: this._convertParameters(doxityConstructor.inputs),
-                    returnType: this._convertType(doxityContractObj.name),
+                    parameters: doxityUtils._convertParameters(doxityConstructor.inputs),
+                    returnType: doxityUtils._convertType(doxityContractObj.name),
                 };
                 constructors.push(constructor);
             }
@@ -40,7 +40,7 @@ export const doxityUtils = {
             const doxityMethods: DoxityAbiDoc[] = _.filter<DoxityAbiDoc>(
                 doxityContractObj.abiDocs,
                 (abiDoc: DoxityAbiDoc) => {
-                    return this._isMethod(abiDoc);
+                    return doxityUtils._isMethod(abiDoc);
                 },
             );
             const methods: SolidityMethod[] = _.map<DoxityAbiDoc, SolidityMethod>(
@@ -52,10 +52,10 @@ export const doxityUtils = {
                         // no-op. It's already undefined
                     } else if (outputs.length === 1) {
                         const outputsType = outputs[0].type;
-                        returnTypeIfExists = this._convertType(outputsType);
+                        returnTypeIfExists = doxityUtils._convertType(outputsType);
                     } else {
                         const outputsType = `[${_.map(outputs, output => output.type).join(', ')}]`;
-                        returnTypeIfExists = this._convertType(outputsType);
+                        returnTypeIfExists = doxityUtils._convertType(outputsType);
                     }
                     // For ZRXToken, we want to convert it to zrxToken, rather then simply zRXToken
                     const callPath =
@@ -70,7 +70,7 @@ export const doxityUtils = {
                         comment: doxityMethod.details,
                         returnComment: doxityMethod.return,
                         callPath,
-                        parameters: this._convertParameters(doxityMethod.inputs),
+                        parameters: doxityUtils._convertParameters(doxityMethod.inputs),
                         returnType: returnTypeIfExists,
                     };
                     return method;
@@ -80,7 +80,7 @@ export const doxityUtils = {
             const doxityProperties: DoxityAbiDoc[] = _.filter<DoxityAbiDoc>(
                 doxityContractObj.abiDocs,
                 (abiDoc: DoxityAbiDoc) => {
-                    return this._isProperty(abiDoc);
+                    return doxityUtils._isProperty(abiDoc);
                 },
             );
             const properties = _.map<DoxityAbiDoc, Property>(doxityProperties, (doxityProperty: DoxityAbiDoc) => {
@@ -92,7 +92,7 @@ export const doxityUtils = {
                 }
                 const property = {
                     name: doxityProperty.name,
-                    type: this._convertType(typeName),
+                    type: doxityUtils._convertType(typeName),
                     comment: doxityProperty.details,
                 };
                 return property;
@@ -105,7 +105,7 @@ export const doxityUtils = {
             const events = _.map(doxityEvents, doxityEvent => {
                 const event = {
                     name: doxityEvent.name,
-                    eventArgs: this._convertEventArgs(doxityEvent.inputs),
+                    eventArgs: doxityUtils._convertEventArgs(doxityEvent.inputs),
                 };
                 return event;
             });
@@ -129,7 +129,7 @@ export const doxityUtils = {
                 name: input.name,
                 comment: input.description,
                 isOptional: false,
-                type: this._convertType(input.type),
+                type: doxityUtils._convertType(input.type),
             };
             return parameter;
         });
@@ -142,7 +142,7 @@ export const doxityUtils = {
         };
         return type;
     },
-    _isMethod(abiDoc: DoxityAbiDoc) {
+    _isMethod(abiDoc: DoxityAbiDoc): boolean {
         if (abiDoc.type !== AbiTypes.Function) {
             return false;
         }
@@ -152,7 +152,7 @@ export const doxityUtils = {
         const isMethod = hasNamedOutputIfExists && !isNameAllCaps;
         return isMethod;
     },
-    _isProperty(abiDoc: DoxityAbiDoc) {
+    _isProperty(abiDoc: DoxityAbiDoc): boolean {
         if (abiDoc.type !== AbiTypes.Function) {
             return false;
         }
@@ -167,7 +167,7 @@ export const doxityUtils = {
             const eventArg = {
                 isIndexed: input.indexed,
                 name: input.name,
-                type: this._convertType(input.type),
+                type: doxityUtils._convertType(input.type),
             };
             return eventArg;
         });
diff --git a/packages/react-docs/src/utils/typedoc_utils.ts b/packages/react-docs/src/utils/typedoc_utils.ts
index 02f5b4049..a6d938e94 100644
--- a/packages/react-docs/src/utils/typedoc_utils.ts
+++ b/packages/react-docs/src/utils/typedoc_utils.ts
@@ -1,3 +1,4 @@
+import { errorUtils } from '@0xproject/utils';
 import * as _ from 'lodash';
 
 import { DocsInfo } from '../docs_info';
@@ -14,11 +15,11 @@ import {
     Type,
     TypeDocNode,
     TypeDocType,
+    TypeDocTypes,
     TypeParameter,
     TypescriptFunction,
     TypescriptMethod,
 } from '../types';
-import { utils } from '../utils/utils';
 
 export const typeDocUtils = {
     isType(entity: TypeDocNode): boolean {
@@ -92,10 +93,16 @@ export const typeDocUtils = {
                 throw new Error('`react-docs` only supports projects with 1 exported class per file');
             }
             const isClassExport = packageDefinitionWithMergedChildren.children[0].kindString === KindString.Class;
+            const isObjectLiteralExport =
+                packageDefinitionWithMergedChildren.children[0].kindString === KindString.ObjectLiteral;
             if (isClassExport) {
                 entities = packageDefinitionWithMergedChildren.children[0].children;
                 const commentObj = packageDefinitionWithMergedChildren.children[0].comment;
                 packageComment = !_.isUndefined(commentObj) ? commentObj.shortText : packageComment;
+            } else if (isObjectLiteralExport) {
+                entities = packageDefinitionWithMergedChildren.children[0].children;
+                const commentObj = packageDefinitionWithMergedChildren.children[0].comment;
+                packageComment = !_.isUndefined(commentObj) ? commentObj.shortText : packageComment;
             } else {
                 entities = packageDefinitionWithMergedChildren.children;
             }
@@ -106,7 +113,7 @@ export const typeDocUtils = {
         });
         return docAgnosticFormat;
     },
-    _convertEntitiesToDocSection(entities: TypeDocNode[], docsInfo: DocsInfo, sectionName: string) {
+    _convertEntitiesToDocSection(entities: TypeDocNode[], docsInfo: DocsInfo, sectionName: string): DocSection {
         const docSection: DocSection = {
             comment: '',
             constructors: [],
@@ -190,7 +197,7 @@ export const typeDocUtils = {
                     break;
 
                 default:
-                    throw utils.spawnSwitchErr('kindString', entity.kindString);
+                    throw errorUtils.spawnSwitchErr('kindString', entity.kindString);
             }
         });
         return docSection;
@@ -221,9 +228,16 @@ export const typeDocUtils = {
 
         const childrenIfExist = !_.isUndefined(entity.children)
             ? _.map(entity.children, (child: TypeDocNode) => {
-                  const childTypeIfExists = !_.isUndefined(child.type)
+                  let childTypeIfExists = !_.isUndefined(child.type)
                       ? typeDocUtils._convertType(child.type, sections, sectionName, docId)
                       : undefined;
+                  if (child.kindString === KindString.Method) {
+                      childTypeIfExists = {
+                          name: child.name,
+                          typeDocType: TypeDocTypes.Reflection,
+                          method: typeDocUtils._convertMethod(child, isConstructor, sections, sectionName, docId),
+                      };
+                  }
                   const c: CustomTypeChild = {
                       name: child.name,
                       type: childTypeIfExists,
@@ -387,6 +401,7 @@ export const typeDocUtils = {
             name: entity.name,
             comment,
             isOptional,
+            defaultValue: entity.defaultValue,
             type,
         };
         return parameter;
diff --git a/packages/react-docs/src/utils/utils.ts b/packages/react-docs/src/utils/utils.ts
deleted file mode 100644
index f8c1fefff..000000000
--- a/packages/react-docs/src/utils/utils.ts
+++ /dev/null
@@ -1,5 +0,0 @@
-export const utils = {
-    spawnSwitchErr(name: string, value: any) {
-        return new Error(`Unexpected switch value: ${value} encountered for ${name}`);
-    },
-};