No esm build, just common js

[istarkov]

Thank you, incredibly fast lib.

Without esm build i.e.

"build:esm": "tsc --module es2015 --target es5 --outDir dist/esm"

its impossible to use this library if "type": "module", is set in package.json.
i.e having commonjs I need add .default and this breaks typings

import BTree from 'sorted-btree';
var tree = new BTree.default<number, [number, number]>(undefined, (a, b) => a - b);

To have near zero setup of esm+commonjs support I can recoomend https://github.com/developit/microbundle

[qwertie]

What environment are you running in? I don't have a reason to think that CommonJS modules are broken inside apps that use "type": "module". Node.js documentation just says:

Node.js will treat as CommonJS all other forms of input, such as .js files where the nearest parent package.json file contains no top-level "type" field

Perhaps you can use a workaround like this:

import BTree_ from 'sorted-btree';
const BTree = (BTree_ as any).default as typeof BTree_;

[istarkov]

This https://github.com/lukeed/tsm as loader for node i.e. node --loader tsm

[abustany]

Upgrading to vite 8 broke things for me, in a web application that uses sorted-btree. The migration guide from vite 7 to vite 8 mentions how it handles CommonJS interop, and links to the relevant rolldown documentation. In there, we can read that

For files ending with .js, Rolldown parses the file as ESM

so the "ESM compiled to CJS" heuristic doesn't apply.

I patched the package locally to rename b+tree.js to b+tree.cjs (and adapted package.json accordingly), and things seem to work.

Patch:

diff --git a/b+tree.js b/b+tree.cjs
similarity index 100%
rename from b+tree.js
rename to b+tree.cjs
diff --git a/package.json b/package.json
index 27017166e851dc89e67b60d825501dade873b849..3f16303a1ecf7a2871503efcfddf84ab1af61c86 100644
--- a/package.json
+++ b/package.json
@@ -2,7 +2,7 @@
   "name": "sorted-btree",
   "version": "1.8.1",
   "description": "A sorted list of key-value pairs in a fast, typed in-memory B+ tree with a powerful API.",
-  "main": "b+tree.js",
+  "main": "b+tree.cjs",
   "typings": "b+tree",
   "scripts": {
     "test": "tsc && echo //ts-jest-issue-657 >interfaces.js && jest",

[abustany]

Ah nevermind this actually doesn't work, I suppose I was testing with the wrong vite version. Reading the docs again, my module has "type": "module" in package.json, therefore "the default import is the module.exports value of the importee CJS module".

[abustany]

Updated patch, to expose the BTree class as a non-default export (seems to be the easiest solution):

diff --git a/b+tree.d.ts b/b+tree.d.ts
index fece9bbccfa108e0651ac3d5e090f29995f944eb..ba70f6b96d8a5a86cd69f4dfedf5b2166b1392f1 100644
--- a/b+tree.d.ts
+++ b/b+tree.d.ts
@@ -103,7 +103,7 @@ export declare function simpleComparator(a: (number | string)[], b: (number | st
  *
  * @author David Piepgrass
  */
-export default class BTree<K = any, V = any> implements ISortedMapF<K, V>, ISortedMap<K, V> {
+declare class BTree<K = any, V = any> implements ISortedMapF<K, V>, ISortedMap<K, V> {
     private _root;
     _size: number;
     _maxNodeSize: number;
@@ -456,6 +456,8 @@ export default class BTree<K = any, V = any> implements ISortedMapF<K, V>, ISort
      *  does check that maxKey() of the children of internal nodes are sorted. */
     checkValid(): void;
 }
+export { BTree, BTree as default };
+
 /** A TypeScript helper function that simply returns its argument, typed as
  *  `ISortedSet<K>` if the BTree implements it, as it does if `V extends undefined`.
  *  If `V` cannot be `undefined`, it returns `unknown` instead. Or at least, that
diff --git a/b+tree.js b/b+tree.js
index ad6ec71566ca5ae3a5d7c9e554c1ed6e92ec6d8f..a21a28ab75909accaf61fab039bb18cbe9673205 100644
--- a/b+tree.js
+++ b/b+tree.js
@@ -1074,6 +1074,7 @@ var BTree = /** @class */ (function () {
     return BTree;
 }());
 exports.default = BTree;
+exports.BTree = BTree;
 /** A TypeScript helper function that simply returns its argument, typed as
  *  `ISortedSet<K>` if the BTree implements it, as it does if `V extends undefined`.
  *  If `V` cannot be `undefined`, it returns `unknown` instead. Or at least, that

[qwertie]

The .d.ts file is generated and should not be modified, but I tweaked the (ts) source code to export BTree as both default and non-default. However, I found that I was unable to log into npm―even after a password reset! Sorry, I don't know what's wrong.

[abustany]

Yep patch I attached was for people who wanted to apply it downstream while waiting for an upstream fix :) but your patch looks good 👍