[3.0.2] ESM issues: no type:module and wrong import paths

[jlowcs]

The library is currently not working with node.js, for 2 reasons:

1. the package.json is missing type: module, resulting in this kind of error:

          Error [ERR_MODULE_NOT_FOUND]: Cannot find module '.../node_modules/.pnpm/typesense-instantsearch-adapter@3.0.2_@babel+runtime@7.29.2/node_modules/typesense-instantsearch-adapter/lib/Configuration' imported from .../node_modules/.pnpm/typesense-instantsearch-adapter@3.0.2_@babel+runtime@7.29.2/node_modules/typesense-instantsearch-adapter/lib/TypesenseInstantsearchAdapter.js
              at finalizeResolution (node:internal/modules/esm/resolve:274:11)
              at moduleResolve (node:internal/modules/esm/resolve:864:10)
              at defaultResolve (node:internal/modules/esm/resolve:990:11)
              at #cachedDefaultResolve (node:internal/modules/esm/loader:757:20)
              at #resolveAndMaybeBlockOnLoaderThread (node:internal/modules/esm/loader:793:38)
              at ModuleLoader.resolveSync (node:internal/modules/esm/loader:816:52)
              at #cachedResolveSync (node:internal/modules/esm/loader:776:25)
              at ModuleLoader.getModuleJobForRequire (node:internal/modules/esm/loader:474:50)
              at #link (node:internal/modules/esm/module_job:447:34)
              at new ModuleJobSync (node:internal/modules/esm/module_job:420:17)

That is because the library is using import statements but is not flagged as ESM in package.json.

I tried adding type: module, and it fixed that error, but revealed a second issue.

2. ESM imports should include the extension and the library uses paths without extension, resulting in this kind of error:

ERROR in ../../node_modules/.pnpm/typesense-instantsearch-adapter@3.0.2_@babel+runtime@7.29.2/node_modules/typesense-instantsearch-adapter/lib/TypesenseInstantsearchAdapter.js 7:1-48
  × Module not found: Can't resolve './Configuration' in '.../node_modules/.pnpm/typesense-instantsearch-adapter@3.0.2_@babel+runtime@7.29.2/node_modules/typesense-instantsearch-adapter/lib'
   ╭─[7:0]
 5 │ import _createClass from "@babel/runtime/helpers/createClass";
 6 │ import _regeneratorRuntime from "@babel/runtime/regenerator";
 7 │ import { Configuration } from "./Configuration";
   · �[35;1m────────────────────────────────────────────────
 8 │ import { SearchClient as TypesenseSearchClient } from "typesense";
 9 │ import { SearchRequestAdapter } from "./SearchRequestAdapter";
   ╰────
  help: Did you mean './Configuration.js'?
        
        The request './Configuration' failed to resolve only because it was resolved as fully specified,
        probably because the origin is strict EcmaScript Module,
        e. g. a module with javascript mimetype, a '*.mjs' file, or a '*.js' file where the package.json contains '"type": "module"'.
        
        The extension in the request is mandatory for it to be fully specified.
        Add the extension to the request.

I also tried adding the extensions to all relative imports, and it did fix the issue.

[tharropoulos]

Hey @jlowcs ,

Could you share a reproducible example so I can make the appropriate changes for node compatibility?

[jlowcs]

In a new folder, install typesense-instantsearch-adapter v3

Create this file:

// test.mjs
import TypesenseInstantsearchAdapter from 'typesense-instantsearch-adapter';

console.log(TypesenseInstantsearchAdapter);

Run node test.mjs

Output:

[tharropoulos]

While I will address this, any reason for using this under Node? Is Instantsearch able to run under node as well?

[jlowcs]

While I will address this, any reason for using this under Node? Is Instantsearch able to run under node as well?

With SSR, the dependency can be imported, even if it's only used client-side.

On top of that, yes, it can make sense to run it under node. I actually just built a GET API that uses it to compile some search results using the v2 library.

[tharropoulos]

@jlowcs SSR already works: https://typesense.org/docs/guide/reference-implementations/nextjs-app-router-ssr.html
Apart from that, what's the v2 library referring to?

The reason for me asking about is that this will be a major change to the bundling of the repo, and there may be breaking changes to support both ESM and CJS in current setups.

[jlowcs]

@jlowcs SSR already works: https://typesense.org/docs/guide/reference-implementations/nextjs-app-router-ssr.html Apart from that, what's the v2 library referring to?

Right, but the issue is not SSR itself. It's that the SSR server is ESM.

Note that tools like webpack don't seem to have issues bundling the library. It's when importing the library directly that the issue occurs.

The reason for me asking about is that this will be a major change to the bundling of the repo, and there may be breaking changes to support both ESM and CJS in current setups.

You don't need to support both ESM and CJS. The issue with the current build is that it's neither.

Options:

1. you build CJS files (which can be imported by ESM) by replacing imports with requires
2. you fix the ESM files by adding extensions and you fix the package.json - btw the latest node versions can require ESM libraries from CJS
3. you build both, but that might be a bigger lift

I had a similar issue a while ago and I just had to switch from building my library with tsc to something like tsup.