Native ESM

[PhearZero]

❌ Problem

The following errors due to node.js resolving the commonjs bundle while using native esm modules.

Reproduction: https://github.com/PhearZero/js-algorand-sdk-node-18-module/tree/main

import { Indexer } from 'algosdk'

🤔Reasoning:

While modern bundlers have robust resolvers, it would be good to have first class support for esm without third party tools. This will also improve third party bundlers ability to tree shake.

✅ Solution

Convert package to esm.

• Package type "commonjs" loads the ./dist/cjs/index.js entrypoint. (fixed example using fork)
• Package type "module" loads the ./dist/esm/index.js entrypoint. (fixed example using fork)

📦Dependencies

This requires moving to tsx and slight refactoring of the codebase.

‼️ Urgency

Very low priority

[jasonpaulos]

Hi @PhearZero, I am under the impression that having this line in our package.json is enough to provide ESM support:

js-algorand-sdk/package.json

Line 6 in 7469c41

"module": "dist/esm/index.js",

Can you please share more details about your environment (e.g. operating system, node version) and the exact error you're receiving?

[PhearZero]

Hello @jasonpaulos !

Hi @PhearZero, I am under the impression that having this line in our package.json is enough to provide ESM support:

This is true for most bundlers but it's actually not standardized, just a widely adopted key. The actual package.json standard does not include module but exports. The previous ESM bundles where an attempt at "future proofing" but not compliant with the current specification.

• Node.js Exports Documentation
• Typescript ESM
• Browser Support

Can you please share more details about your environment (e.g. operating system, node version) and the exact error you're receiving?

Should be any node/os combination that supports esm. Node >= v16

Here is the reproduction repo using Node v18: https://github.com/PhearZero/js-algorand-sdk-node-18-module

Steps:

npm init
npm install algosdk

Set package.json type to module

{
 "type": "module"
}

Import module

import {Indexer} from 'algosdk'

// Error does not provide named export since it's using the cjs bundle

[jasonpaulos]

Addressed in #836