@ray-db/core 0.1.5
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/LICENSE +21 -0
- package/README.md +87 -0
- package/browser.js +1 -0
- package/index.d.ts +1376 -0
- package/index.js +610 -0
- package/package.json +126 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2020 N-API for Rust
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# `@napi-rs/package-template`
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
> Template project for writing node packages with napi-rs.
|
|
6
|
+
|
|
7
|
+
# Usage
|
|
8
|
+
|
|
9
|
+
1. Click **Use this template**.
|
|
10
|
+
2. **Clone** your project.
|
|
11
|
+
3. Run `yarn install` to install dependencies.
|
|
12
|
+
4. Run `yarn napi rename -n [@your-scope/package-name] -b [binary-name]` command under the project folder to rename your package.
|
|
13
|
+
|
|
14
|
+
## Install this test package
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
yarn add @napi-rs/package-template
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Ability
|
|
21
|
+
|
|
22
|
+
### Build
|
|
23
|
+
|
|
24
|
+
After `yarn build/npm run build` command, you can see `package-template.[darwin|win32|linux].node` file in project root. This is the native addon built from [lib.rs](./src/lib.rs).
|
|
25
|
+
|
|
26
|
+
### Test
|
|
27
|
+
|
|
28
|
+
With [ava](https://github.com/avajs/ava), run `yarn test/npm run test` to testing native addon. You can also switch to another testing framework if you want.
|
|
29
|
+
|
|
30
|
+
### CI
|
|
31
|
+
|
|
32
|
+
With GitHub Actions, each commit and pull request will be built and tested automatically in [`node@20`, `@node22`] x [`macOS`, `Linux`, `Windows`] matrix. You will never be afraid of the native addon broken in these platforms.
|
|
33
|
+
|
|
34
|
+
### Release
|
|
35
|
+
|
|
36
|
+
Release native package is very difficult in old days. Native packages may ask developers who use it to install `build toolchain` like `gcc/llvm`, `node-gyp` or something more.
|
|
37
|
+
|
|
38
|
+
With `GitHub actions`, we can easily prebuild a `binary` for major platforms. And with `N-API`, we should never be afraid of **ABI Compatible**.
|
|
39
|
+
|
|
40
|
+
The other problem is how to deliver prebuild `binary` to users. Downloading it in `postinstall` script is a common way that most packages do it right now. The problem with this solution is it introduced many other packages to download binary that has not been used by `runtime codes`. The other problem is some users may not easily download the binary from `GitHub/CDN` if they are behind a private network (But in most cases, they have a private NPM mirror).
|
|
41
|
+
|
|
42
|
+
In this package, we choose a better way to solve this problem. We release different `npm packages` for different platforms. And add it to `optionalDependencies` before releasing the `Major` package to npm.
|
|
43
|
+
|
|
44
|
+
`NPM` will choose which native package should download from `registry` automatically. You can see [npm](./npm) dir for details. And you can also run `yarn add @napi-rs/package-template` to see how it works.
|
|
45
|
+
|
|
46
|
+
## Develop requirements
|
|
47
|
+
|
|
48
|
+
- Install the latest `Rust`
|
|
49
|
+
- Install `Node.js@10+` which fully supported `Node-API`
|
|
50
|
+
- Install `yarn@1.x`
|
|
51
|
+
|
|
52
|
+
## Test in local
|
|
53
|
+
|
|
54
|
+
- yarn
|
|
55
|
+
- yarn build
|
|
56
|
+
- yarn test
|
|
57
|
+
|
|
58
|
+
And you will see:
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
$ ava --verbose
|
|
62
|
+
|
|
63
|
+
✔ sync function from native code
|
|
64
|
+
✔ sleep function from native code (201ms)
|
|
65
|
+
─
|
|
66
|
+
|
|
67
|
+
2 tests passed
|
|
68
|
+
✨ Done in 1.12s.
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Release package
|
|
72
|
+
|
|
73
|
+
Ensure you have set your **NPM_TOKEN** in the `GitHub` project setting.
|
|
74
|
+
|
|
75
|
+
In `Settings -> Secrets`, add **NPM_TOKEN** into it.
|
|
76
|
+
|
|
77
|
+
When you want to release the package:
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=<prerelease-id>] | from-git]
|
|
81
|
+
|
|
82
|
+
git push
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
GitHub actions will do the rest job for you.
|
|
86
|
+
|
|
87
|
+
> WARN: Don't run `npm publish` manually.
|
package/browser.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from '@ray-db/core-wasm32-wasi'
|