@powersync/node 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -0
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -26,6 +26,27 @@ npm install @powersync/node
|
|
|
26
26
|
Both `@powersync/node` and the `better-sqlite3` packages have install scripts that need to run to compile
|
|
27
27
|
or download sqlite3 and PowerSync binaries.
|
|
28
28
|
|
|
29
|
+
### Common Installation Issues
|
|
30
|
+
|
|
31
|
+
The `better-sqlite` package requires native compilation, which depends on certain system tools. This compilation process is handled by `node-gyp` and may fail if required dependencies are missing or misconfigured.
|
|
32
|
+
|
|
33
|
+
#### Node-gyp Version Conflicts
|
|
34
|
+
|
|
35
|
+
`better-sqlite` depends on `node-gyp@^11`, but some project configurations may introduce multiple versions of `node-gyp`, potentially causing build issues.
|
|
36
|
+
|
|
37
|
+
#### Python Dependency Issues
|
|
38
|
+
|
|
39
|
+
`node-gyp` requires Python for compilation. If your project uses `node-gyp` below version `10` and your system has Python `3.12` or later, you may encounter the following error:
|
|
40
|
+
|
|
41
|
+
```python
|
|
42
|
+
ModuleNotFoundError: No module named 'distutils'
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
To resolve this, either:
|
|
46
|
+
|
|
47
|
+
- Upgrade `node-gyp` to version 10 or later.
|
|
48
|
+
- Install Python [setuptools](https://pypi.org/project/setuptools/), which includes `distutils`.
|
|
49
|
+
|
|
29
50
|
# Getting Started
|
|
30
51
|
|
|
31
52
|
The [Node.js SDK reference](https://docs.powersync.com/client-sdk-references/node)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@powersync/node",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -36,14 +36,14 @@
|
|
|
36
36
|
},
|
|
37
37
|
"homepage": "https://docs.powersync.com/",
|
|
38
38
|
"peerDependencies": {
|
|
39
|
-
"@powersync/common": "^1.
|
|
39
|
+
"@powersync/common": "^1.27.0"
|
|
40
40
|
},
|
|
41
41
|
"dependencies": {
|
|
42
42
|
"@powersync/better-sqlite3": "^0.1.1",
|
|
43
43
|
"async-lock": "^1.4.0",
|
|
44
44
|
"bson": "^6.6.0",
|
|
45
45
|
"comlink": "^4.4.2",
|
|
46
|
-
"@powersync/common": "1.
|
|
46
|
+
"@powersync/common": "1.27.0"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
49
|
"@types/async-lock": "^1.4.0",
|