refactor: ESM and CJS transpilation

.changeset/slimy-baboons-itch.md

@@ -0,0 +1,19 @@
+---
+"near-api-js": major
+"@near-js/accounts": patch
+"@near-js/crypto": patch
+"@near-js/keystores": patch
+"@near-js/keystores-browser": patch
+"@near-js/keystores-node": patch
+"@near-js/providers": patch
+"@near-js/signers": patch
+"@near-js/transactions": patch
+"@near-js/types": patch
+"@near-js/utils": patch
+"@near-js/wallet-account": patch
+---
+
+Major functionality in near-api-js has now been broken up into packages under @near-js
+
+Breaking changes:
+ - `KeyPairEd25519` no longer supports the `fromString` static method. This method is now only available on the `KeyPair` class.

.eslintrc.yml → .eslintrc.base.yml

@@ -5,10 +5,12 @@ extends:
   - 'eslint:recommended'
 parserOptions:
   ecmaVersion: 2018
+  sourceType: module
 rules:
   indent:
     - error
     - 4
+    - SwitchCase: 1
   linebreak-style:
     - error
     - unix

.eslintrc.js.yml

@@ -0,0 +1,7 @@
+extends: './.eslintrc.base.yml'
+env:
+    jest: true
+globals:
+    jasmine: true
+    window: false
+    fail: true

.eslintrc.ts.yml

@@ -0,0 +1,5 @@
+extends:
+  - './.eslintrc.base.yml'
+  - 'plugin:@typescript-eslint/eslint-recommended'
+  - 'plugin:@typescript-eslint/recommended'
+parser: '@typescript-eslint/parser'

README.md

@@ -48,6 +48,20 @@ Follow next steps:
 2. Fetch new schema: `node fetch_error_schema.js`
 3. `pnpm build` to update `lib/**.js` files
 
+
+## Packages
+
+- [accounts](https://github.com/near/near-api-js/tree/master/packages/accounts) account creation & management
+- [keypairs](https://github.com/near/near-api-js/tree/master/packages/keypairs) cryptographic key pairs & signing
+- [keystores](https://github.com/near/near-api-js/tree/master/packages/keystores) general-purpose key persistence & management
+- [keystores-browser](https://github.com/near/near-api-js/tree/master/packages/keystores-browser) browser keystores
+- [keystores-node](https://github.com/near/near-api-js/tree/master/packages/keystores-node) NodeJS keystores
+- [providers](https://github.com/near/near-api-js/tree/master/packages/providers) RPC interaction
+- [transactions](https://github.com/near/near-api-js/tree/master/packages/transactions) transaction composition & signing
+- [types](https://github.com/near/near-api-js/tree/master/packages/types) common types
+- [utils](https://github.com/near/near-api-js/tree/master/packages/types) common methods
+- [wallet-account](https://github.com/near/near-api-js/tree/master/packages/wallet-account) accounts in browser-based wallets
+
 ## License
 
 This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

package.json

@@ -9,7 +9,9 @@
     "preinstall": "npx only-allow pnpm",
     "build": "turbo run build",
     "clean": "turbo run clean",
-    "lint": "turbo run lint",
+    "lint": "concurrently \"turbo run lint:ts\" \"turbo run lint:js\"",
+    "lint:fix": "concurrently \"turbo run lint:ts:fix\" \"turbo run lint:js:fix\"",
+    "autoclave": "concurrently \"rimraf packages/**/dist\" \"rimraf packages/**/lib\" \"rimraf packages/**/node_modules\" \"rimraf packages/**/coverage\" \"rimraf packages/**/.turbo\" && rm -rf node_modules",
     "test": "turbo run test",
     "release": "changeset publish",
     "prepare": "husky install"
@@ -19,13 +21,14 @@
     "@changesets/cli": "^2.24.4",
     "@commitlint/cli": "^17.0.3",
     "@commitlint/config-conventional": "^17.0.3",
-    "typescript": "^4.7.4",
     "@typescript-eslint/eslint-plugin": "^5.31.0",
     "@typescript-eslint/parser": "^5.31.0",
     "commitlint": "^17.0.3",
-    "eslint": "^8.20.0",
+    "concurrently": "^7.6.0",
+    "eslint": "^8.32.0",
     "husky": "^7.0.4",
     "rimraf": "^3.0.2",
-    "turbo": "^1.4.5"
+    "turbo": "^1.4.5",
+    "typescript": "^4.9.4"
   }
 }

packages/accounts/README.md

@@ -0,0 +1,19 @@
+# @near-js/accounts
+
+A collection of classes, functions, and types for interacting with accounts and contracts.
+
+## Modules
+
+- [Account](src/account.ts) a class with methods to transfer NEAR, manage account keys, sign transactions, etc.
+- [AccountMultisig](src/account_multisig.ts) a [multisig](https://github.com/near/core-contracts/tree/master/multisig) deployed `Account` requiring multiple keys to sign transactions
+- [Account2FA](src/account_2fa.ts) extension of `AccountMultisig` used in conjunction with 2FA provided by [near-contract-helper](https://github.com/near/near-contract-helper)
+- [AccountCreator](src/account_creator.ts) classes for creating NEAR accounts
+- [Contract](src/contract.ts) represents a deployed smart contract with view and/or change methods
+- [Connection](src/connection.ts) a record containing the information required to connect to NEAR RPC
+- [Constants](src/constants.ts) account-specific constants
+- [Types](src/types.ts) account-specific types
+
+# License
+
+This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
+See [LICENSE](https://github.com/near/near-api-js/blob/master/LICENSE) and [LICENSE-APACHE](https://github.com/near/near-api-js/blob/master/LICENSE-APACHE) for details.

packages/accounts/jest.config.js

@@ -0,0 +1,5 @@
+export default {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    collectCoverage: true
+};

packages/accounts/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@near-js/accounts",
+  "version": "0.0.1",
+  "description": "Classes encapsulating account-specific functionality",
+  "main": "lib/esm/index.js",
+  "type": "module",
+  "browser": "./lib/cjs/index.js",
+  "scripts": {
+    "build": "pnpm compile",
+    "compile": "concurrently \"tsc -p tsconfig.cjs.json\" \"tsc -p tsconfig.esm.json\"",
+    "lint:js": "eslint -c ../../.eslintrc.js.yml test/**/*.js --no-eslintrc",
+    "lint:js:fix": "eslint -c ../../.eslintrc.js.yml test/**/*.js --no-eslintrc --fix",
+    "lint:ts": "eslint -c ../../.eslintrc.ts.yml src/**/*.ts --no-eslintrc",
+    "lint:ts:fix": "eslint -c ../../.eslintrc.ts.yml src/**/*.ts --no-eslintrc --fix",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest test"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@near-js/crypto": "workspace:*",
+    "@near-js/providers": "workspace:*",
+    "@near-js/signers": "workspace:*",
+    "@near-js/transactions": "workspace:*",
+    "@near-js/types": "workspace:*",
+    "@near-js/utils": "workspace:*",
+    "ajv": "^8.11.2",
+    "ajv-formats": "^2.1.1",
+    "bn.js": "5.2.1",
+    "borsh": "^0.7.0",
+    "depd": "^2.0.0",
+    "near-abi": "0.1.1"
+  },
+  "devDependencies": {
+    "@near-js/keystores": "workspace:*",
+    "@types/node": "^18.11.18",
+    "bs58": "^4.0.0",
+    "jest": "^26.0.1",
+    "near-hello": "^0.5.1",
+    "ts-jest": "^26.5.6",
+    "tsconfig": "workspace:*",
+    "typescript": "^4.9.4"
+  },
+  "exports": {
+    "import": "./lib/esm/index.js",
+    "require": "./lib/cjs/index.js"
+  },
+  "files": [
+    "lib"
+  ]
+}