🕷 Fix types warnings (dawsbot#123)

* fix: typedoc types warnings

* chore: merge pre commit check

* chore: merge pre commit check

* 🔧 Migrate typedoc settings to tsconfig.json

* 🔧 Migrate typedoc settings to tsconfig.json

* remove commited typedoc out

* 🚨 🔧 Manually exported missing types, reverted plugin

* bump docusaurus deps

Co-authored-by: Ari Gibson <hi@arimgibson.com>
Co-authored-by: daws.eth <dawsonbotsford@gmail.com>

docusaurus/package.json

@@ -15,19 +15,19 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.18",
-    "@docusaurus/preset-classic": "2.0.0-beta.18",
+    "@docusaurus/core": "^2.0.0-beta.20",
+    "@docusaurus/preset-classic": "^2.0.0-beta.20",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.1.1",
-    "docusaurus-plugin-typedoc": "^0.17.4",
+    "docusaurus-plugin-typedoc": "^0.17.5",
     "prism-react-renderer": "^1.3.1",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "typedoc": "^0.22.15",
     "typedoc-plugin-markdown": "^3.12.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.18",
+    "@docusaurus/module-type-aliases": "^2.0.0-beta.20",
     "@tsconfig/docusaurus": "^1.0.5",
     "typescript": "^4.6.4"
   },

package.json

@@ -30,7 +30,8 @@
     "prepare": "husky install",
     "version": "npx genversion --es6 src/logger/package-version.ts && git add src/logger/package-version.ts",
     "postversion": "git push --follow-tags",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "doc": "typedoc"
   },
   "devDependencies": {
     "@types/body-parser": "^1.19.1",
@@ -59,6 +60,7 @@
     "prettier-plugin-organize-imports": "^2.3.4",
     "ts-jest": "^27.1.4",
     "ts-node": "^10.2.1",
+    "typedoc": "^0.22.15",
     "typescript": "^4.6.4",
     "web3": "^1.7.3"
   },

scripts/markdown-magic/build-readme.sh

@@ -1,4 +1,4 @@
-npx typedoc --json scripts/markdown-magic/typedoc.out.json --pretty src/index.ts
+npm run doc
 npx markdown-magic
 # add a newline above all markdown magic comments
 # This was breaking the docusaurus jsx rendering otherwise

src/index.ts

@@ -1,15 +1,26 @@
-import { Contract } from './classes/Contract';
-import { FallthroughProvider } from './providers/FallthroughProvider';
+import { BaseContract, Contract } from './classes/Contract';
+import {
+  ConstructorOptions,
+  FallthroughProvider,
+} from './providers/FallthroughProvider';
 import { JsonRpcProvider, jsonRpcProvider } from './providers/JsonRpcProvider';
 import { tinyBig, TinyBig } from './shared/tiny-big/tiny-big';
-import { BlockResponse } from './types/Block.types';
+import { BlockResponse, BlockTag, RPCBlock } from './types/Block.types';
 import {
   ContractTypes,
   JSONABI,
   JSONABIArgument,
 } from './types/Contract.types';
 import { Network } from './types/Network.types';
-import { TransactionResponse } from './types/Transaction.types';
+import {
+  BlockTransactionResponse,
+  Log,
+  RPCLog,
+  RPCTransaction,
+  RPCTransactionReceipt,
+  TransactionReceipt,
+  TransactionResponse,
+} from './types/Transaction.types';
 import { computeAddress } from './utils/compute-address';
 import { computePublicKey } from './utils/compute-public-key';
 import { etherToGwei } from './utils/ether-to-gwei';
@@ -46,10 +57,20 @@ export {
   Contract,
   TinyBig,
   /* types */
+  BaseContract,
   BlockResponse,
   ContractTypes,
   JSONABI,
   JSONABIArgument,
   Network,
   TransactionResponse,
+  RPCBlock,
+  RPCTransaction,
+  RPCTransactionReceipt,
+  TransactionReceipt,
+  BlockTag,
+  RPCLog,
+  Log,
+  BlockTransactionResponse,
+  ConstructorOptions,
 };