Merge pull request #1139 from 0xProject/feature/website/asset-buyer-docs

[asset-buyer][monorepo-scripts][website] Add asset-buyer documentation

3 files changed, 13 insertions, 2 deletions

diff --git a/packages/monorepo-scripts/CHANGELOG.json b/packages/monorepo-scripts/CHANGELOG.json
index cf7a22bb7..4797fd929 100644
--- a/packages/monorepo-scripts/CHANGELOG.json
+++ b/packages/monorepo-scripts/CHANGELOG.json
@@ -5,6 +5,10 @@
             {
                 "note": "Render date formats in UTC to prevent conflicts when publishing in different timezones.",
                 "pr": 1143
+            },
+            {
+                "note": "Add AssetBuyerError to the IGNORED_EXCESSIVE_TYPES array",
+                "pr": 1139
             }
         ]
     },
diff --git a/packages/monorepo-scripts/src/doc_gen_configs.ts b/packages/monorepo-scripts/src/doc_gen_configs.ts
index e3ddeddc9..b5a36376a 100644
--- a/packages/monorepo-scripts/src/doc_gen_configs.ts
+++ b/packages/monorepo-scripts/src/doc_gen_configs.ts
@@ -30,6 +30,7 @@ export const docGenConfigs: DocGenConfigs = {
     // factory method which instantiates an instance of a class, but we don't want users instantiating it themselves
     // and getting confused. Any class name in this list will not have it's constructor rendered in our docs.
     CLASSES_WITH_HIDDEN_CONSTRUCTORS: [
+        'AssetBuyer',
         'ERC20ProxyWrapper',
         'ERC20TokenWrapper',
         'ERC721ProxyWrapper',
@@ -43,7 +44,13 @@ export const docGenConfigs: DocGenConfigs = {
     // Some types are not explicitly part of the public interface like params, return values, etc... But we still
     // want them exported. E.g error enum types that can be thrown by methods. These must be manually added to this
     // config
-    IGNORED_EXCESSIVE_TYPES: ['NonceSubproviderErrors', 'Web3WrapperErrors', 'ContractWrappersError', 'OrderError'],
+    IGNORED_EXCESSIVE_TYPES: [
+        'NonceSubproviderErrors',
+        'Web3WrapperErrors',
+        'ContractWrappersError',
+        'OrderError',
+        'AssetBuyerError',
+    ],
     // Some libraries only export types. In those cases, we cannot check if the exported types are part of the
     // "exported public interface". Thus we add them here and skip those checks.
     TYPES_ONLY_LIBRARIES: ['ethereum-types', 'types'],
diff --git a/packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts b/packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts
index 4fea94414..547b65eeb 100644
--- a/packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts
+++ b/packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts
@@ -331,7 +331,7 @@ export class DocGenerateAndUploadUtils {
             throw new Error(
                 `${this._packageName} package exports BUT does not need: \n${excessiveReferencesExceptIgnored.join(
                     '\n',
-                )} \nin it\'s index.ts. Remove them then try again.`,
+                )} \nin it\'s index.ts. Remove them then try again OR if we still want them exported (e.g error enum types), then add them to the IGNORED_EXCESSIVE_TYPES array.`,
             );
         }
     }