@rushdb/javascript-sdk 3.1.0 → 3.1.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.
Files changed (2) hide show
  1. package/README.md +17 -8
  2. package/package.json +11 -31
package/README.md CHANGED
@@ -4,16 +4,15 @@
4
4
 
5
5
  # RushDB — JavaScript & TypeScript SDK
6
6
 
7
- ### The memory layer for AI agents and apps.
7
+ ### RushDB — the database for AI
8
8
 
9
- Push any JSON. Get graph relationships and vector search — automatically.
10
- No schema. No pipeline. No glue code.
9
+ One database for your records, their relationships, and search over them.
11
10
 
12
11
  [![NPM Version](https://img.shields.io/npm/v/%40rushdb%2Fjavascript-sdk)](https://www.npmjs.com/package/@rushdb/javascript-sdk)
13
12
  [![NPM Downloads](https://img.shields.io/npm/dw/%40rushdb%2Fjavascript-sdk)](https://www.npmjs.com/package/@rushdb/javascript-sdk)
14
13
  [![Bundle size](https://img.shields.io/bundlephobia/minzip/%40rushdb%2Fjavascript-sdk)](https://bundlephobia.com/package/@rushdb/javascript-sdk)
15
14
  [![License](https://img.shields.io/npm/l/%40rushdb%2Fjavascript-sdk)](#license)
16
- [![Made with Node](https://img.shields.io/badge/dynamic/json?label=node&query=%24.engines%5B%22node%22%5D&url=https%3A%2F%2Fraw.githubusercontent.com%2Frush-db%2Frushdb%2Fmain%2Fpackage.json)](https://nodejs.org)
15
+ [![Made with Node](https://img.shields.io/badge/dynamic/json?label=node&query=%24.engines%5B%22node%22%5D&url=https%3A%2F%2Fraw.githubusercontent.com%2Frush-db%2Fjavascript-sdk%2Fmain%2Fpackage.json)](https://nodejs.org)
17
16
 
18
17
  [🌐 Website](https://rushdb.com) • [📖 Documentation](https://docs.rushdb.com) • [☁️ Cloud](https://app.rushdb.com) • [🔍 Examples](https://github.com/rush-db/examples)
19
18
 
@@ -46,6 +45,16 @@ npm install @rushdb/javascript-sdk
46
45
 
47
46
  ---
48
47
 
48
+ ## Compatibility
49
+
50
+ | Package | RushDB 3.x and RushDB Cloud | RushDB 2.x (legacy) |
51
+ |---|---|---|
52
+ | `@rushdb/javascript-sdk` | 3.x | 2.11.0: `npm i @rushdb/javascript-sdk@2` |
53
+ | `rushdb` (PyPI) | 3.x | 2.10.0: `pip install "rushdb<3"` |
54
+ | `@rushdb/mcp-server` | 3.x | 2.13.0: `npx @rushdb/mcp-server@2` |
55
+
56
+ ---
57
+
49
58
  ## Agent memory in 3 lines
50
59
 
51
60
  Get an API key at [app.rushdb.com](https://app.rushdb.com). Keys come in two levels: **full access** (server-side only) and **read-only** — read-only keys can't modify data, so they're safe to ship in browser code for public demos and dashboards.
@@ -187,10 +196,10 @@ which exist only in RushDB Cloud.
187
196
 
188
197
  ```typescript
189
198
  // RushDB Cloud
190
- const db = new RushDB('RUSHDB_API_KEY')
199
+ const cloud = new RushDB('RUSHDB_API_KEY')
191
200
 
192
201
  // A self-hosted engine
193
- const db = new RushDB('ENGINE_TOKEN', {
202
+ const selfHosted = new RushDB('ENGINE_TOKEN', {
194
203
  direct: true,
195
204
  engineUrl: 'http://127.0.0.1:3000',
196
205
  scope: 'tenant-1' // only for an engine started with --multitenant
@@ -247,13 +256,13 @@ Key options:
247
256
  - `options.allowForceDelete` — allow deleting all records without criteria (default: false)
248
257
  - `direct`, `engineUrl`, `scope` — direct mode against a standalone engine (see above)
249
258
 
250
- Full config reference: [docs.rushdb.com/typescript-sdk/introduction#sdk-configuration-options](https://docs.rushdb.com/typescript-sdk/introduction#sdk-configuration-options)
259
+ Full config reference: [docs.rushdb.com/3.x/learn/reference/typescript/RushDB](https://docs.rushdb.com/3.x/learn/reference/typescript/RushDB/#sdkconfig-options)
251
260
 
252
261
  ---
253
262
 
254
263
  ## Documentation
255
264
 
256
- [docs.rushdb.com/typescript-sdk](https://docs.rushdb.com/typescript-sdk/introduction) — full API reference, examples, transactions, CSV import, and more.
265
+ [docs.rushdb.com/3.x/connect/sdks](https://docs.rushdb.com/3.x/connect/sdks/) and the [TypeScript reference](https://docs.rushdb.com/3.x/learn/reference/typescript/) — full API reference, examples, transactions, CSV import, and more.
257
266
 
258
267
  ---
259
268
 
package/package.json CHANGED
@@ -1,44 +1,24 @@
1
1
  {
2
2
  "name": "@rushdb/javascript-sdk",
3
- "description": "RushDB JavaScript SDK — memory layer for AI agents and modern apps",
3
+ "description": "RushDB SDK for JavaScript and TypeScript: the client for RushDB, the database for AI (RushDB Cloud or self-hosted)",
4
4
  "keywords": [
5
5
  "rushdb",
6
6
  "database",
7
- "graph database",
8
- "graph-database",
9
- "ai memory",
10
- "ai-memory",
11
- "agent memory",
12
- "agent-memory",
13
- "memory layer",
14
- "memory-layer",
15
- "ai agents",
7
+ "database-for-ai",
16
8
  "ai-agents",
17
- "llm memory",
18
- "llm-memory",
19
- "mcp",
20
- "vector search",
9
+ "graph-database",
10
+ "sql",
11
+ "cypher",
21
12
  "vector-search",
22
- "rag",
23
- "embedding",
24
- "embeddings",
25
- "knowledge graph",
26
- "knowledge-graph",
27
- "json normalization",
28
- "json-normalization",
29
- "schema-less",
30
- "schemaless",
31
- "no-schema",
13
+ "full-text-search",
14
+ "hybrid-search",
15
+ "mcp",
32
16
  "self-hosted",
33
- "rest api",
34
- "rest-api",
35
- "graph",
36
- "relationships",
37
- "persistence",
38
- "rush-db"
17
+ "rag",
18
+ "agent-memory"
39
19
  ],
40
20
  "license": "Apache-2.0",
41
- "version": "3.1.0",
21
+ "version": "3.1.1",
42
22
  "type": "module",
43
23
  "files": [
44
24
  "dist"