ESM CJS builds (#5904)

* base tsconfig

* build specific tsconfig

* build scripts for esm and cjs

* tsconfig fix for tests

* integration test fix

* webpack custom tsconf to ts-loader

* doc pointing to conf

* linter ts config

* docs config

* explicitly override module type in build outputs

* tsconf update

* fix ethereumjs/tx import issue for pure ESM

* changelog andpackage.json updates

* types at first

* updated build script

* change log sync

.eslintrc.js

@@ -6,7 +6,7 @@ module.exports = {
 	},
 	parserOptions: {
 		ecmaVersion: 2016,
-		project: './tsconfig.json',
+		project: './tsconfig.base.json',
 		tsconfigRootDir: __dirname,
 		sourceType: 'module',
 	},

.eslintrc.test.js

@@ -1,6 +1,6 @@
 module.exports = {
 	parserOptions: {
-		project: './tsconfig.json',
+		project: './tsconfig.base.json',
 		tsconfigRootDir: __dirname,
 	},
 	extends: ['web3-base/ts-jest'],

CHANGELOG.md

@@ -1319,10 +1319,79 @@ should use 4.0.1-alpha.0 for testing.
 
 ### Added
 
+#### web3
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
+#### web3-core
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
+#### web3-errors
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
+#### web3-eth
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
+#### web3-eth-abi
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
+#### web3-eth-accounts
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
 #### web3-eth-contract
 
+-   Added hybrid build (ESM and CJS) of library (#5904)
 -   `input` is now an acceptable property for `ContractInitOptions` in place of `data` (either can be used, but `input` is used withing the
 
+#### web3-eth-ens
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
+#### web3-eth-iban
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
+#### web3-eth-personal
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
+#### web3-net
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
+#### web3-providers-http
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
+#### web3-providers-ipc
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
+#### web3-providers-ws
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
+#### web3-rpc-methods
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
+#### web3-types
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
+#### web3-utils
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
+#### web3-validator
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
 ### Removed
 
 #### web3-core

docs/tsconfig.docs.json

@@ -1,8 +1,10 @@
 {
-	"extends": "../tsconfig.json",
+	"extends": "../tsconfig.base.json",
 	"compilerOptions": {
 		"declarationDir": "dts",
-		"outDir": "dts"
+		"outDir": "dts",
+		"declaration": true,
+		"declarationMap": true
 	},
 	"include": ["../packages/*/src/**/*", "../packages/*/types/**/*"]
 }

package.json

@@ -38,7 +38,7 @@
 		"build:web": "lerna run build:web --stream",
 		"build:web:analyze": "lerna run build:web:analyze --stream",
 		"build:docs": "cd docs && yarn install && yarn build",
-		"changelog": "ts-node scripts/changelog/src/index.ts",
+		"changelog": "ts-node -P scripts/changelog/tsconfig.json scripts/changelog/src/index.ts",
 		"clean": "lerna run clean --stream --parallel",
 		"ganache:start": "WEB3_SYSTEM_TEST_BACKEND=ganache && ./scripts/ganache.sh start",
 		"ganache:start:background": "WEB3_SYSTEM_TEST_BACKEND=ganache && ./scripts/ganache.sh start 1",

packages/web3-core/.eslintrc.js

@@ -1,7 +1,7 @@
 module.exports = {
 	extends: '../../.eslintrc.js',
 	parserOptions: {
-		project: './tsconfig.json',
+		project: './tsconfig.esm.json',
 		tsconfigRootDir: __dirname,
 	},
 };

packages/web3-core/CHANGELOG.md

@@ -85,6 +85,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
 ### Changed
 
 -   If a transaction object with a `data` property is passed to `txInputOptionsFormatter`, it will now be replaced with `input` (#5915)

packages/web3-core/package.json

@@ -2,7 +2,15 @@
 	"name": "web3-core",
 	"version": "4.0.1-rc.0",
 	"description": "Web3 core tools for sub-packages. This is an internal package.",
-	"main": "lib/index.js",
+	"main": "./lib/commonjs/index.js",
+	"module": "./lib/esm/index.js",
+	"exports": {
+		".": {
+			"types": "./lib/types/index.d.ts",
+			"import": "./lib/esm/index.js",
+			"require": "./lib/commonjs/index.js"
+		}
+	},
 	"repository": "https://github.com/ChainSafe/web3.js",
 	"author": "ChainSafe Systems",
 	"license": "LGPL-3.0",
@@ -16,7 +24,10 @@
 	"scripts": {
 		"clean": "rimraf dist && rimraf lib",
 		"prebuild": "yarn clean",
-		"build": "tsc --build",
+		"build": "yarn build:cjs & yarn build:esm & yarn build:types",
+		"build:cjs": "tsc --build tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > ./lib/commonjs/package.json",
+		"build:esm": "tsc --build tsconfig.esm.json && echo '{\"type\": \"module\"}' > ./lib/esm/package.json",
+		"build:types": "tsc --build tsconfig.types.json",
 		"build:check": "node -e \"require('./lib')\"",
 		"lint": "eslint --ext .js,.ts .",
 		"lint:fix": "eslint --fix --ext .js,.ts .",

packages/web3-core/test/tsconfig.json

@@ -1,5 +1,5 @@
 {
-	"extends": "../tsconfig",
+	"extends": "../tsconfig.cjs.json",
 	"compilerOptions": {
 		"declaration": false,
 		"declarationMap": false

packages/web3-core/tsconfig.cjs.json

@@ -0,0 +1,9 @@
+{
+	"extends": "../../tsconfig.base.json",
+	"compilerOptions": {
+		"outDir": "./lib/commonjs",
+		"declaration": true,
+		"module": "commonjs"
+	},
+	"include": ["src/**/*"]
+}

packages/web3-core/tsconfig.esm.json

@@ -0,0 +1,8 @@
+{
+	"extends": "../../tsconfig.base.json",
+	"compilerOptions": {
+		"outDir": "./lib/esm",
+		"module": "es2020"
+	},
+	"include": ["src/**/*"]
+}

packages/web3-core/tsconfig.types.json

@@ -0,0 +1,10 @@
+{
+	"extends": "../../tsconfig.base.json",
+	"compilerOptions": {
+		"declarationDir": "./lib/types",
+		"declaration": true,
+		"declarationMap": true,
+		"emitDeclarationOnly": true
+	},
+	"include": ["src/**/*"]
+}

packages/web3-errors/.eslintrc.js

@@ -1,7 +1,7 @@
 module.exports = {
 	extends: '../../.eslintrc.js',
 	parserOptions: {
-		project: './tsconfig.json',
+		project: './tsconfig.esm.json',
 		tsconfigRootDir: __dirname,
 	},
 };

packages/web3-errors/CHANGELOG.md

@@ -88,6 +88,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
 ### Changed
 
 -   `gasLimit` is no longer accepted as a parameter for `MissingGasError` and `TransactionGasMismatchError, and is also no longer included in error message (#5915)

packages/web3-errors/package.json

@@ -2,7 +2,15 @@
 	"name": "web3-errors",
 	"version": "1.0.0-rc.0",
 	"description": "This package has web3 error classes",
-	"main": "lib/index.js",
+	"main": "./lib/commonjs/index.js",
+	"module": "./lib/esm/index.js",
+	"exports": {
+		".": {
+			"types": "./lib/types/index.d.ts",
+			"import": "./lib/esm/index.js",
+			"require": "./lib/commonjs/index.js"
+		}
+	},
 	"repository": "https://github.com/ChainSafe/web3.js",
 	"author": "ChainSafe Systems",
 	"license": "LGPL-3.0",
@@ -16,7 +24,10 @@
 	"scripts": {
 		"clean": "rimraf dist && rimraf lib",
 		"prebuild": "yarn clean",
-		"build": "tsc --build",
+		"build": "yarn build:cjs & yarn build:esm & yarn build:types",
+		"build:cjs": "tsc --build tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > ./lib/commonjs/package.json",
+		"build:esm": "tsc --build tsconfig.esm.json && echo '{\"type\": \"module\"}' > ./lib/esm/package.json",
+		"build:types": "tsc --build tsconfig.types.json",
 		"build:check": "node -e \"require('./lib')\"",
 		"lint": "eslint --ext .js,.ts .",
 		"lint:fix": "eslint --fix --ext .js,.ts .",

packages/web3-errors/tsconfig.cjs.json

@@ -0,0 +1,10 @@
+{
+	"extends": "../../tsconfig.base.json",
+	"compilerOptions": {
+		"outDir": "./lib/commonjs",
+		"esModuleInterop": true,
+		"declaration": true,
+		"module": "commonjs"
+	},
+	"include": ["src/**/*"]
+}

packages/web3-errors/tsconfig.esm.json

@@ -0,0 +1,9 @@
+{
+	"extends": "../../tsconfig.base.json",
+	"compilerOptions": {
+		"outDir": "./lib/esm",
+		"esModuleInterop": true,
+		"module": "es2020"
+	},
+	"include": ["src/**/*"]
+}

packages/web3-errors/tsconfig.types.json

@@ -0,0 +1,10 @@
+{
+	"extends": "../../tsconfig.base.json",
+	"compilerOptions": {
+		"declarationDir": "./lib/types",
+		"declaration": true,
+		"declarationMap": true,
+		"emitDeclarationOnly": true
+	},
+	"include": ["src/**/*"]
+}

packages/web3-eth-abi/.eslintrc.js

@@ -1,7 +1,7 @@
 module.exports = {
 	extends: '../../.eslintrc.js',
 	parserOptions: {
-		project: './tsconfig.json',
+		project: './tsconfig.esm.json',
 		tsconfigRootDir: __dirname,
 	},
 };

packages/web3-eth-abi/CHANGELOG.md

@@ -90,6 +90,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+-   Added hybrid build (ESM and CJS) of library (#5904)
+
 ### Removed
 
 -   Removed `formatDecodedObject` function (#5934)

packages/web3-eth-abi/package.json

@@ -2,7 +2,15 @@
 	"name": "web3-eth-abi",
 	"version": "4.0.1-rc.0",
 	"description": "Web3 module encode and decode EVM in/output.",
-	"main": "lib/index.js",
+	"main": "./lib/commonjs/index.js",
+	"module": "./lib/esm/index.js",
+	"exports": {
+		".": {
+			"types": "./lib/types/index.d.ts",
+			"import": "./lib/esm/index.js",
+			"require": "./lib/commonjs/index.js"
+		}
+	},
 	"repository": "https://github.com/ethereum/web3.js/tree/4.x/packages/web3-eth-abi",
 	"author": "ChainSafe Systems",
 	"license": "LGPL-3.0",
@@ -16,7 +24,10 @@
 	"scripts": {
 		"clean": "rimraf dist && rimraf lib",
 		"prebuild": "yarn clean",
-		"build": "tsc --build",
+		"build": "yarn build:cjs & yarn build:esm & yarn build:types",
+		"build:cjs": "tsc --build tsconfig.cjs.json && echo '{\"type\": \"commonjs\"}' > ./lib/commonjs/package.json",
+		"build:esm": "tsc --build tsconfig.esm.json && echo '{\"type\": \"module\"}' > ./lib/esm/package.json",
+		"build:types": "tsc --build tsconfig.types.json",
 		"build:check": "node -e \"require('./lib')\"",
 		"lint": "eslint --ext .js,.ts .",
 		"lint:fix": "eslint --fix --ext .js,.ts .",

packages/web3-eth-abi/test/tsconfig.json

@@ -1,5 +1,5 @@
 {
-	"extends": "../tsconfig",
+	"extends": "../tsconfig.cjs.json",
 	"compilerOptions": {
 		"declaration": false,
 		"declarationMap": false

packages/web3-eth-abi/tsconfig.cjs.json

@@ -0,0 +1,10 @@
+{
+	"extends": "../../tsconfig.base.json",
+	"compilerOptions": {
+		"outDir": "./lib/commonjs",
+		"esModuleInterop": true,
+		"declaration": true,
+		"module": "commonjs"
+	},
+	"include": ["src/**/*"]
+}

packages/web3-eth-abi/tsconfig.esm.json

@@ -0,0 +1,9 @@
+{
+	"extends": "../../tsconfig.base.json",
+	"compilerOptions": {
+		"outDir": "./lib/esm",
+		"esModuleInterop": true,
+		"module": "es2020"
+	},
+	"include": ["src/**/*"]
+}

packages/web3-eth-abi/tsconfig.types.json

@@ -0,0 +1,10 @@
+{
+	"extends": "../../tsconfig.base.json",
+	"compilerOptions": {
+		"declarationDir": "./lib/types",
+		"declaration": true,
+		"declarationMap": true,
+		"emitDeclarationOnly": true
+	},
+	"include": ["src/**/*"]
+}