@libsql/client can't be used from CommonJS modules using TypeScript
#182
Labels
bug
Something isn't working
good first issue
Good for newcomers
help wanted
Extra attention is needed
Comments
|
If you still want the package.json snippet"exports": {
".": {
"import": {
"types": "./lib-esm/node.d.ts",
"workerd": "./lib-esm/web.js",
"deno": "./lib-esm/web.js",
"edge-light": "./lib-esm/web.js",
"netlify": "./lib-esm/web.js",
"node": "./lib-esm/node.js",
"browser": "./lib-esm/web.js",
"default": "./lib-esm/node.js"
},
"require": {
"types": "./lib-cjs/node.d.ts",
"default": "./lib-cjs/node.js"
}
},
"./node": {
"import": {
"types": "./lib-esm/node.d.ts",
"default": "./lib-esm/node.js"
},
"require": {
"types": "./lib-cjs/node.d.ts",
"default": "./lib-cjs/node.js"
}
},
"./http": {
"import": {
"types": "./lib-esm/http.d.ts",
"default": "./lib-esm/http.js"
},
"require": {
"types": "./lib-cjs/http.d.ts",
"default": "./lib-cjs/http.js"
}
},
"./ws": {
"import": {
"types": "./lib-esm/ws.d.ts",
"default": "./lib-esm/ws.js"
},
"require": {
"types": "./lib-cjs/ws.d.ts",
"default": "./lib-cjs/ws.js"
}
},
"./sqlite3": {
"import": {
"types": "./lib-esm/sqlite3.d.ts",
"default": "./lib-esm/sqlite3.js"
},
"require": {
"types": "./lib-cjs/sqlite3.d.ts",
"default": "./lib-cjs/sqlite3.js"
}
},
"./web": {
"import": {
"types": "./lib-esm/web.d.ts",
"default": "./lib-esm/web.js"
},
"require": {
"types": "./lib-cjs/web.d.ts",
"default": "./lib-cjs/web.js"
}
}
},tsc --traceResolution |
penberg
added
bug
|
Hello I had the same issue , what did the trick for me was setting those in my |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
@libsql/clientappears intended to be able to support both ESM and CJS modules, but unfortunately, it doesn't appear to work properly with the TypeScript compiler.If one creates a simple NodeJS (v18) package like so:
package.json
{ "name": "nodejs-test", "version": "1.0.0", "description": "", "main": "dist/index.js", "author": "", "license": "ISC", "scripts": { "build": "tsc", "test": "echo \"Error: no test specified\" && exit 1" }, "dependencies": { "@libsql/client": "^0.5.2" }, "devDependencies": { "@tsconfig/node18": "^18.2.2", "typescript": "^5.3.3" } }with a fairly basic tsconfig:
tsconfig.json
{ "extends": "@tsconfig/node18", "compilerOptions": { "outDir": "dist", "resolveJsonModule": true, "noUncheckedIndexedAccess": true, "sourceMap": true, "declaration": true, "declarationMap": true, "stripInternal": true, }, "include": [ "src/**/*", "test/**/*" ] }and then import
@libsql/clientinsrc/index.tssrc/index.ts
You will get the following error:
This appears to be caused by
@libsql/clientsharing the.d.tsfiles across both thelib-esmandlib-cjsfolders.If you ask the TypeScript compiler to explain its module resolution (
tsc --traceResolution), you get this:tsc --traceResolution
We can see the module resolution is using
exports/./typesto find thelib-esm/node.d.ts, which appears to be flipping the compiler into ESM mode (maybe it can see the ESM .js files next to the .d.ts files).However, if we copy all the
.d.tsfiles into thelib-cjsfolder in the package (so that they are duplicated), and remove all thetypesproperties underexports(so the TS compiler will search for .d.ts files next to the .js files instead), we get the correct behaviour and the error goes away. Here's what the module resolution trace output shows for that:tsc --traceResolution
While this does seem like dodgy TypeScript compiler behaviour, I'd suggest just copying the .d.ts files into both
lib-esmandlib-cjsand removing thetypesproperties from theexportsentries to allow the compiler to find them dynamically. That appears to solve the problem.The text was updated successfully, but these errors were encountered: