@ray-db/core 0.1.5 → 0.1.6

package/README.md

@@ -1,87 +1,113 @@
-# `@napi-rs/package-template`
+# @ray-db/core
 
-![https://github.com/napi-rs/package-template/actions](https://github.com/napi-rs/package-template/workflows/CI/badge.svg)
+RayDB native bindings for Node.js (and WASI/browser builds), powered by Rust + N-API.
 
-> Template project for writing node packages with napi-rs.
+Docs: https://ray-kwaf.vercel.app/docs
 
-# Usage
-
-1. Click **Use this template**.
-2. **Clone** your project.
-3. Run `yarn install` to install dependencies.
-4. Run `yarn napi rename -n [@your-scope/package-name] -b [binary-name]` command under the project folder to rename your package.
-
-## Install this test package
+## Install
 
 ```bash
-yarn add @napi-rs/package-template
+npm install @ray-db/core
+# or
+pnpm add @ray-db/core
+# or
+yarn add @ray-db/core
 ```
 
-## Ability
+This package ships prebuilt binaries for major platforms. If a prebuild isn't available for your target, you'll need a Rust toolchain to build from source.
 
-### Build
+## Quickstart (graph basics)
 
-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).
+```ts
+import {
+  Database,
+  JsTraversalDirection,
+  PropType,
+  pathConfig,
+  traversalStep,
+} from '@ray-db/core'
 
-### Test
+const db = Database.open('example.raydb', { createIfMissing: true })
 
-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.
+// Transactions are explicit for write operations
+db.begin()
+const alice = db.createNode('user:alice')
+const bob = db.createNode('user:bob')
 
-### CI
+const knows = db.getOrCreateEtype('knows')
+const weight = db.getOrCreatePropkey('weight')
 
-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.
+db.addEdge(alice, knows, bob)
 
-### Release
+// Set a typed edge property
+db.setEdgeProp(alice, knows, bob, weight, {
+  propType: PropType.Int,
+  intValue: 1,
+})
 
-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.
+db.commit()
 
-With `GitHub actions`, we can easily prebuild a `binary` for major platforms. And with `N-API`, we should never be afraid of **ABI Compatible**.
+// Traverse
+const oneHop = db.traverseSingle([alice], JsTraversalDirection.Out, knows)
+console.log(oneHop)
 
-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).
+// Multi-hop traversal
+const steps = [
+  traversalStep(JsTraversalDirection.Out, knows),
+  traversalStep(JsTraversalDirection.Out, knows),
+]
+const twoHop = db.traverse([alice], steps)
+console.log(twoHop)
 
-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.
+// Pathfinding
+const config = pathConfig(alice, bob)
+config.allowedEdgeTypes = [knows]
+const shortest = db.bfs(config)
+console.log(shortest)
 
-`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.
+db.close()
+```
 
-## Develop requirements
+## Backups and health checks
 
-- Install the latest `Rust`
-- Install `Node.js@10+` which fully supported `Node-API`
-- Install `yarn@1.x`
+```ts
+import { createBackup, restoreBackup, healthCheck } from '@ray-db/core'
 
-## Test in local
+const backup = createBackup(db, 'backups/graph')
+const restoredPath = restoreBackup(backup.path, 'restored/graph')
 
-- yarn
-- yarn build
-- yarn test
+const health = healthCheck(db)
+console.log(health.healthy)
+```
 
-And you will see:
+## Vector search
 
-```bash
-$ ava --verbose
+```ts
+import { createVectorIndex } from '@ray-db/core'
 
-  ✔ sync function from native code
-  ✔ sleep function from native code (201ms)
-  ─
+const index = createVectorIndex({ dimensions: 3 })
+index.set(1, [0.1, 0.2, 0.3])
+index.set(2, [0.1, 0.25, 0.35])
+index.buildIndex()
 
-  2 tests passed
-✨  Done in 1.12s.
+const hits = index.search([0.1, 0.2, 0.3], { k: 5 })
+console.log(hits)
 ```
 
-## Release package
+## Browser/WASI builds
 
-Ensure you have set your **NPM_TOKEN** in the `GitHub` project setting.
+This package exposes a WASI-compatible build via the `browser` export for bundlers, backed by `@ray-db/core-wasm32-wasi`. If you need to import it directly:
 
-In `Settings -> Secrets`, add **NPM_TOKEN** into it.
+```ts
+import { Database } from '@ray-db/core-wasm32-wasi'
+```
 
-When you want to release the package:
+## API surface
 
-```bash
-npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=<prerelease-id>] | from-git]
+The Node bindings expose both low-level graph primitives (`Database`) and higher-level APIs (Ray) for schema-driven workflows, plus metrics, backups, traversal, and vector search. For full API details and guides, see the docs:
 
-git push
-```
+https://ray-kwaf.vercel.app/docs
 
-GitHub actions will do the rest job for you.
+## License
 
-> WARN: Don't run `npm publish` manually.
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ray-db/core",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "Template project for writing node package with napi-rs",
   "main": "index.js",
   "repository": {
@@ -117,10 +117,10 @@
   },
   "packageManager": "yarn@4.12.0",
   "optionalDependencies": {
-    "@ray-db/core-win32-x64-msvc": "0.1.5",
-    "@ray-db/core-darwin-x64": "0.1.5",
-    "@ray-db/core-linux-x64-gnu": "0.1.5",
-    "@ray-db/core-darwin-arm64": "0.1.5",
-    "@ray-db/core-wasm32-wasi": "0.1.5"
+    "@ray-db/core-win32-x64-msvc": "0.1.6",
+    "@ray-db/core-darwin-x64": "0.1.6",
+    "@ray-db/core-linux-x64-gnu": "0.1.6",
+    "@ray-db/core-darwin-arm64": "0.1.6",
+    "@ray-db/core-wasm32-wasi": "0.1.6"
   }
 }