Can't import JSONFile from "lowdb/node" import. #554

Trystan-SA · 2022-10-24T10:40:09Z

When I use import {JSONFile} from 'lowdb/lib/node' it return the following error message.

[ERROR] Could not resolve "lowdb/lib/node"
    src/users.ts:2:23:
      2 │ import {JSONFile} from 'lowdb/lib/node'
        ╵                        ~~~~~~~~~~~~~~~~
  The path "./lib/node" is not exported by package "lowdb":

I'm using Esbuild, I tried to make this package external, or tried find another import path, but I can't make it work without modifying the lowdb source code. This is what I did :

index.js

export * from './adapters/Memory.js';
export * from './adapters/MemorySync.js';
export * from './Low.js';
export * from './LowSync.js';
+ export * from './node.js';

I tried to use the documentation path import {JSONFile} from 'lowdb/node' but typescript can't find the module.

The text was updated successfully, but these errors were encountered:

typicode · 2022-10-24T13:41:16Z

Hi,

Could you please check that you're using latest lowdb version? I have it working with v5.0.5 and TypeScript in a project I'm working on.

nooptr · 2022-10-24T13:59:01Z

@typicode
I also had the same problem.
I use mac m1 pro. Using node 16.14.0, lowdb v5.0.5

Trystan-SA · 2022-10-24T14:46:04Z

I use the latest 5.0.5 version.

ghost · 2022-10-24T15:25:35Z

Issue happens on the lowdb/browser imports too. I can reproduce using a default Next.js project + lowdb: https://github.com/jasonbarone/lowdb-type-error-test.
Node 16.15.0, M1 Pro, pnpm 7.13

typicode · 2022-10-24T21:56:43Z

Can you try setting "type": "module" in your package.json?
Here's also how you can test locally:

package.json

{
  "name": "lowdb-test",
  "version": "1.0.0",
  "type": "module",
  "dependencies": {
    "lowdb": "^5.0.5"
  },
  "devDependencies": {
    "@sindresorhus/tsconfig": "^3.0.1",
    "typescript": "^4.8.4"
  }
}

tsconfig.json

{
  "extends": "@sindresorhus/tsconfig",
  "compilerOptions": {
    "outDir": "./lib"
  }
}

src/index.ts

import { Low } from 'lowdb'
import { JSONFile } from 'lowdb/node'

/tmp/lowdb-test is 📦 v1.0.0 via  v19.0.0 
❯ npm x tsc
src/index.ts:1:1 - error TS6133: 'Low' is declared but its value is never read.

1 import { Low } from 'lowdb'
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~

src/index.ts:2:1 - error TS6133: 'JSONFile' is declared but its value is never read.

2 import { JSONFile } from 'lowdb/node'
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


Found 2 errors in the same file, starting at: src/index.ts:1

Trystan-SA · 2022-10-25T10:38:52Z

Still not working. For import {JSONFile} from 'lowdb/lib/node' I get :

X [ERROR] Could not resolve "lowdb/lib/node"
  The path "./lib/node" is not exported by package "lowdb":
  The file "./lib/node.js" is exported at path "./node":
  Import from "lowdb/node" to get the file "node_modules/lowdb/lib/node.js":
 You can mark the path "lowdb/lib/node" as external to exclude it from the bundle, which will
  remove this error.

If I do import {JSONFile} from 'lowdb/node it says the path is not found. Probably because it resolve lowdb package starting from the basepath and not from lowdb/lib folder.

typicode · 2022-10-25T14:10:29Z

Hmm I don't know why you're still getting this error. You can check https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c#im-having-problems-with-esm-and-typescript

Mapping from lowdb/node to lowdb/lib/node.js is done here btw:
https://github.com/typicode/lowdb/blob/main/package.json#L32

tkafka · 2022-10-25T21:04:05Z

+1 here - typescript project with Next.js.

import { JSONFile } from 'lowdb/node.js':
When running next build, this fails with Type error: Cannot find module 'lowdb/node.js' or its corresponding type declarations. in Linting and checking validity of types phase.

import { JSONFile } from 'lowdb/lib/node.js'
The Linting and checking validity of types phase completes fine, but then Creating an optimized production build fails with Module not found: Package path ./lib/node.js is not exported from package <project-path>/node_modules/lowdb (see exports field in <project-path>/node_modules/lowdb/package.json)

It seems that the assignment "./node": "./lib/node.js", in package.json is something that one of the tools in pipeline cannot handle.

9a-aaaaaaaa · 2022-10-26T06:16:35Z

It's totally unusable. If we don't fix this

typicode · 2022-10-26T08:51:29Z

@tkafka it should be import { JSONFile } from 'lowdb/node' (removed .js)

That said, it seems to be tricky with Next.js for some reasons.

tkafka · 2022-10-26T09:52:32Z

@typicode Yes, it doesn't work with Next.js - next dev runs fine, but next build fails at type checking.

I have made a simplest possible repo to reproduce this: https://github.com/tkafka/lowdb-node-fail

Meanwhile, I keep using "lowdb": "^3.0.0", which works.

Sec-ant · 2022-10-27T08:11:53Z

I believe this has something to do with the ts es module resolution strategy. I ran into the issue too, but I switched my project to pure esm config later and everything works. I suggest using the latest typescript version and setting moduleResolution to NodeNext in your tsconfig.json:

{
  "compilerOptions": {
    "moduleResolution": "NodeNext",
  }
}

I ran a quick test using @tkafka 's repo: https://github.com/tkafka/lowdb-node-fail

The default moduleResolution is node, if you run npx tsc --noEmit --traceResolution | grep -A50 -m1 lowdb/node, the output will be something like this:

======== Resolving module 'lowdb/node' from '/home/secant/lowdb-node-fail/services/db.ts'. ========
Explicitly specified module resolution kind: 'NodeJs'.
...
======== Module name 'lowdb/node' was not resolved. ========
...

If you change moduleResolution to nodenext, and run the trace command again, the output will be:

======== Resolving module 'lowdb/node' from '/home/secant/lowdb-node-fail/services/db.ts'. ========
Explicitly specified module resolution kind: 'NodeNext'.
...
File '/home/secant/lowdb-node-fail/node_modules/lowdb/lib/node.d.ts' exist - use it as a name resolution result.
Resolving real path for '/home/secant/lowdb-node-fail/node_modules/lowdb/lib/node.d.ts', result '/home/secant/lowdb-node-fail/node_modules/lowdb/lib/node.d.ts'.
======== Module name 'lowdb/node' was successfully resolved to '/home/secant/lowdb-node-fail/node_modules/lowdb/lib/node.d.ts' with Package ID 'lowdb/lib/[email protected]'. ========
...

which suggests the module resolution succeeded.

And if someone doesn't add type: "module" in his package.json or doesn't use .mjs file extensions, which means he wants to import an es module in a commonjs module, then he will have to use dynamic import: https://stackoverflow.com/a/70396888/4668057

tkafka · 2022-10-27T09:02:09Z

@Sec-ant Thank you for the research! I am not sure if the case matters, but the documentation says it should be nodenext.

However, the build still seems to fail:

import { Low } from 'lowdb'
import { JSONFile } from 'lowdb/node'

> ./node_modules/.bin/next build

info  - Linting and checking validity of types ..Failed to compile.

./services/db.ts:5:26
Type error: Cannot find module 'lowdb/node' or its corresponding type declarations.

  3 | 
  4 | import { Low } from 'lowdb'
> 5 | import { JSONFile } from 'lowdb/node'
    |                          ^
  6 | 
  7 | const dbFile = join(homedir(), 'db.json')
  8 | const dbAdapter = new JSONFile(dbFile)

Do you think I should report this to Next.js instead?

Sec-ant · 2022-10-27T09:13:53Z

I am not sure if the case matters

Both nodenext and NodeNext are fine :)

However, the build still seems to fail:

That's disappointing. My guess is that there are some inconsistent behaviours.

Do you think I should report this to Next.js instead?

There seems to be already several issue and discussions: vercel/next.js#35572 vercel/next.js#41189

typicode · 2022-10-28T02:32:59Z

I think it would be worth it reporting to Next.js if there's no duplicate issue already.

In any case, AFAICT, lowdb works with Node + TypeScript with the example provided above and package.json config is correct. So I'm not sure what can be done at lowdb's level to make it work with Next.js.

It's fine to stay on v3 meanwhile. v5 is a maintenance update and fixes issues with front-end tools like Vite.

minimusubi · 2022-10-28T07:06:39Z

I'm able to reproduce this with just lowdb + TypeScript. See https://github.com/Smiley43210/cannot-find-lowdb for minimum repro.

[email protected]
[email protected]

Sec-ant · 2022-10-28T10:26:29Z

@Smiley43210 You should use nodenext for moduleResolution in tsconfig.json, like I said here: #554 (comment)

minimusubi · 2022-10-30T03:37:11Z

Sorry, I got confused and thought that was something specific to Next.js

or2008 · 2022-10-31T17:29:40Z

have the same issue, unfoutrnly setting moduleResolution to 'nodenext' is casuing other issues in my application :(

didac-pf · 2022-11-05T23:54:46Z

Same problem in NestJS (not NextJS). Changing moduleResolution breaks all other imports.

jsternadel · 2022-11-06T03:43:18Z

Same problem here. Setting "moduleResolution": "NodeNext" breaks several other imports. Rolled back to v4 and everything is working for now.

vedantroy · 2022-11-06T06:12:23Z

This breaks with V3 as well.

GrinZero · 2022-11-09T07:18:20Z

try this solution:

useage

import { JSONFile } from 'lowdb/node'
import type { JSONFile as JSONFileType } from 'lowdb/lib/node'

type DBData = {
  hosts: string[]
}
const adapter = new JSONFile<DBData>(path.join(USER_DATA_PATH, 'db.json')) as JSONFileType<DBData>

.d.ts

declare module 'lowdb/node' {
  export function JSONFile<T>(path: string): void
}
// you can add more

GrinZero · 2022-11-09T08:22:32Z

try this solution:

useage

import { JSONFile } from 'lowdb/node'
import type { JSONFile as JSONFileType } from 'lowdb/lib/node'

type DBData = {
  hosts: string[]
}
const adapter = new JSONFile<DBData>(path.join(USER_DATA_PATH, 'db.json')) as JSONFileType<DBData>

.d.ts

declare module 'lowdb/node' {
  export function JSONFile<T>(path: string): void
}
// you can add more

I took this plan back, not because I couldn't run. It's because I really don't think it's necessary to insist on using such a bad type system, and the demo can't be opened

bartektartanus · 2022-11-14T16:20:40Z

Same issue with this import:
import {LocalStorage} from 'lowdb/browser';

kumpan-david · 2022-12-02T15:31:42Z

I think this is related to microsoft/TypeScript#50794

Just as @GrinZero did I got it working but with

declare module 'lowdb/node' {
  export * from 'node_modules/lowdb/lib/node';
}

joycollector · 2022-12-10T12:17:04Z

For we works like this

// lowdb.d.ts
declare module "lowdb/node" {
  export * from "lowdb/lib/node";
}

import { LowSync } from "lowdb";
import { JSONFileSync } from "lowdb/node";

const db = new LowSync(new JSONFileSync<{ items: { name: string }[] }>("data.json"));

tkafka · 2022-12-13T08:42:35Z

I can confirm @joycollector's solution works for me as well, thank you!

For the record, I have put lowdb.d.ts file into <project_root>/definitions in my next.js (Next 13) app.

SwapnilSoni1999 · 2022-12-21T15:17:39Z

Same problem

dtroydev · 2023-01-10T13:01:02Z

Another option is to patch up lowdb (and leave everything else alone):

npm i -D patch-package (if you don't already have it)
add export * from './node.js' to the end of node_modules/lowdb/lib/index.js and node_modules/lowdb/lib/index.d.ts
npx patch-package lowdb
add "postinstall": "patch-package" to scripts in package.json (if you don't already have this or something to that effect)

The last step ensures that everytime you reinstall modules you will get that patch reapplied.

You will now be importing JSONFile from lowdb, ie. import { Low, JSONFile } from 'lowdb';

Valexr · 2023-01-30T12:16:33Z

declare module 'lowdb/node' {
  export function JSONFile<T>(path: string): void
}

I think, this declaration mast be in lib d.ts files...🤔

this is strange content in `lowdb/lib/node.d.ts...🤔

tsc will declare types fine🤷🏻‍♂️

true declaration live in lowdb/lib/adapters/JSONFile.d.ts

- typicode/lowdb#554 (comment)

weoreference · 2023-04-08T20:29:20Z

Same issue here with plain Typescript. This is a deal breaker for me. Something so basic (even shown in the official tutorial) should work with absolutely no issues. Abstract this problem away. Too much configuration from the get-go

fransyozef · 2023-04-09T14:27:52Z

yeah I second @weoreference First I thought this package would be very nice to have as mock database on local machine. But just trying to install / fix

import { JSONFile } from 'lowdb/node';

is just breaking everything in my code. to bad :(

typicode · 2023-04-28T09:22:10Z

Could you please retry with lowdb v6.0.1 which contains @Krak798's fix #569

CKGrafico · 2023-05-02T14:24:00Z

it works now @typicode :)

wxfred · 2023-05-22T06:13:07Z

Could you please retry with lowdb v6.0.1 which contains @Krak798's fix #569

Still have some problem in electron

colining · 2023-05-22T09:41:01Z

not work in electron

nulkode · 2023-05-22T13:40:52Z

could you please give more information about the error?

colining · 2023-05-22T16:18:51Z

could you please give more information about the error?

I working in erb project，erb

if I call lowdb in main process of electron ,it will throw error like this require() of es module
if I call lowdb in render process react, it will throw other error.
I think maybe it's cause some thing diff in wepack.config

demo 【https://github.com/colining/erb-lowdb-test】

please see db.ts and

setInstalledGame(["1","2"])

@Krak798 thanks a lot

nulkode · 2023-05-29T15:36:06Z

@colining

Here you are importing JSONFileSync from the wrong path. Check usage here.

- import { JSONFileSync, LowSync } from "lowdb";
+ import { LowSync } from "lowdb";
+ import { JSONFileSync } from "lowdb/node"; // in electron

wxfred · 2023-05-30T12:09:42Z

@colining

Here you are importing JSONFileSync from the wrong path. Check usage here.
- import { JSONFileSync, LowSync } from "lowdb";
+ import { LowSync } from "lowdb";
+ import { JSONFileSync } from "lowdb/node"; // in electron

// background.js
import { LowSync } from "lowdb"
import { JSONFileSync } from "lowdb/node"

This dependency was not found:

* lowdb/node in ./src/background.js

To install it, you can run: npm install --save lowdb/node

jakeershareef · 2023-11-29T16:15:24Z

Error in splitPdfPathHandler: [Error: ENOENT: no such file or directory, rename 'C:\Users\jakee\OneDrive\Desktop\lis-scan-docs\desktop-scan-docs\db.scan.json.tmp' -> 'C:\Users\jakee\OneDrive\Desktop\lis-scan-docs\desktop-scan-docs\db\scan.json'] {
errno: -4058,
code: 'ENOENT',
syscall: 'rename',
path: 'C:\Users\jakee\OneDrive\Desktop\lis-scan-docs\desktop-scan-docs\db\.scan.json.tmp',
dest: 'C:\Users\jakee\OneDrive\Desktop\lis-scan-docs\desktop-scan-docs\db\scan.json'
}

i am getting this error while processing files using electron application, how can i resolve this issue.

kamilmielnik added a commit to kamilmielnik/cv that referenced this issue Apr 5, 2023

Upgrade lowdb

61eba9b

- typicode/lowdb#554 (comment)

This was referenced Apr 22, 2023

Cannot find module 'lowdb/node' or its correspoing type declaractions #568

Closed

fix: imported subpaths types correctly #569

Merged

typicode closed this as completed May 4, 2023

JP-Garcia mentioned this issue Oct 1, 2024

Broken update to lowdb vogler/free-games-claimer#389

Closed

Can't import JSONFile from "lowdb/node" import. #554

Can't import JSONFile from "lowdb/node" import. #554

Comments

Trystan-SA commented Oct 24, 2022

typicode commented Oct 24, 2022

nooptr commented Oct 24, 2022 • edited Loading

Trystan-SA commented Oct 24, 2022

ghost commented Oct 24, 2022 • edited by ghost Loading

typicode commented Oct 24, 2022

Trystan-SA commented Oct 25, 2022

typicode commented Oct 25, 2022 • edited Loading

tkafka commented Oct 25, 2022

9a-aaaaaaaa commented Oct 26, 2022

typicode commented Oct 26, 2022 • edited Loading

tkafka commented Oct 26, 2022 • edited Loading

Sec-ant commented Oct 27, 2022 • edited Loading

tkafka commented Oct 27, 2022 • edited Loading

Sec-ant commented Oct 27, 2022 • edited Loading

typicode commented Oct 28, 2022 • edited Loading

minimusubi commented Oct 28, 2022

Sec-ant commented Oct 28, 2022

minimusubi commented Oct 30, 2022

or2008 commented Oct 31, 2022 • edited Loading

didac-pf commented Nov 5, 2022

jsternadel commented Nov 6, 2022 • edited Loading

vedantroy commented Nov 6, 2022

GrinZero commented Nov 9, 2022

useage

.d.ts

GrinZero commented Nov 9, 2022

useage

.d.ts

bartektartanus commented Nov 14, 2022

kumpan-david commented Dec 2, 2022

joycollector commented Dec 10, 2022 • edited Loading

tkafka commented Dec 13, 2022

SwapnilSoni1999 commented Dec 21, 2022

dtroydev commented Jan 10, 2023 • edited Loading

Valexr commented Jan 30, 2023 • edited Loading

weoreference commented Apr 8, 2023

fransyozef commented Apr 9, 2023

typicode commented Apr 28, 2023

CKGrafico commented May 2, 2023

wxfred commented May 22, 2023

colining commented May 22, 2023

nulkode commented May 22, 2023

colining commented May 22, 2023 • edited Loading

nulkode commented May 29, 2023

wxfred commented May 30, 2023

jakeershareef commented Nov 29, 2023

nooptr commented Oct 24, 2022 •

edited

Loading

ghost commented Oct 24, 2022 •

edited by ghost

Loading

typicode commented Oct 25, 2022 •

edited

Loading

typicode commented Oct 26, 2022 •

edited

Loading

tkafka commented Oct 26, 2022 •

edited

Loading

Sec-ant commented Oct 27, 2022 •

edited

Loading

tkafka commented Oct 27, 2022 •

edited

Loading

Sec-ant commented Oct 27, 2022 •

edited

Loading

typicode commented Oct 28, 2022 •

edited

Loading

or2008 commented Oct 31, 2022 •

edited

Loading

jsternadel commented Nov 6, 2022 •

edited

Loading

joycollector commented Dec 10, 2022 •

edited

Loading

dtroydev commented Jan 10, 2023 •

edited

Loading

Valexr commented Jan 30, 2023 •

edited

Loading

colining commented May 22, 2023 •

edited

Loading