@rushdb/javascript-sdk 3.0.0 → 3.0.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 +1 -1
- package/dist/api/api.d.ts +1 -1
- package/dist/direct/capabilities.d.ts +1 -1
- package/dist/direct/engine.d.ts +1 -1
- package/dist/sdk/types.d.ts +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -178,7 +178,7 @@ The SDK works with RushDB in one of two ways:
|
|
|
178
178
|
|
|
179
179
|
| | RushDB Cloud | Self-hosted RushDB engine (direct mode) |
|
|
180
180
|
| --- | --- | --- |
|
|
181
|
-
| What you run | nothing: the managed service at [app.rushdb.com](https://app.rushdb.com) | one `
|
|
181
|
+
| What you run | nothing: the managed service at [app.rushdb.com](https://app.rushdb.com) | one `rushdb` binary, on your own infrastructure |
|
|
182
182
|
| Connect with | an API key | the engine URL and the engine token |
|
|
183
183
|
|
|
184
184
|
The engine is what you can self-host. RushDB Cloud runs that engine for you and adds the dashboard,
|
package/dist/api/api.d.ts
CHANGED
|
@@ -13,7 +13,7 @@ export declare class RestAPI {
|
|
|
13
13
|
options: SDKConfig['options'];
|
|
14
14
|
logger: SDKConfig['logger'];
|
|
15
15
|
/**
|
|
16
|
-
* Direct engine transport (standalone `
|
|
16
|
+
* Direct engine transport (standalone `rushdb`) when `direct` mode is set.
|
|
17
17
|
* In direct mode every request is answered from the engine; nothing is sent
|
|
18
18
|
* to RushDB Cloud.
|
|
19
19
|
*/
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* the direct-mode router refuses these with `CloudOnlyError`, the MCP server
|
|
4
4
|
* hides the tools built on them, and the docs mark them.
|
|
5
5
|
*
|
|
6
|
-
* Everything else the SDK offers runs against a standalone `
|
|
6
|
+
* Everything else the SDK offers runs against a standalone `rushdb` too.
|
|
7
7
|
*/
|
|
8
8
|
export declare const CLOUD_ONLY_METHODS: {
|
|
9
9
|
readonly 'ai.search': "natural-language search turns the prompt into a query with an LLM";
|
package/dist/direct/engine.d.ts
CHANGED
|
@@ -21,7 +21,7 @@ export type ProtocolResponse = {
|
|
|
21
21
|
};
|
|
22
22
|
/**
|
|
23
23
|
* Direct engine transport: executes protocol operations against a standalone
|
|
24
|
-
* `
|
|
24
|
+
* `rushdb` (`/protocol/v1/execute`) over HTTP. This is the SDK's "direct
|
|
25
25
|
* mode" — no RushDB Cloud. `scope` is the tenant on a multitenant engine
|
|
26
26
|
* (`X-RushDB-Tenant`); auth is the engine token.
|
|
27
27
|
*/
|
package/dist/sdk/types.d.ts
CHANGED
|
@@ -23,7 +23,7 @@ export type SDKConfig = {
|
|
|
23
23
|
timeout?: number;
|
|
24
24
|
logger?: Logger;
|
|
25
25
|
/**
|
|
26
|
-
* Direct mode: talk to a standalone RushDB engine (`
|
|
26
|
+
* Direct mode: talk to a standalone RushDB engine (`rushdb`) instead of
|
|
27
27
|
* RushDB Cloud. Requires `engineUrl`; the token is the engine token. The
|
|
28
28
|
* methods listed in `CLOUD_ONLY_METHODS` throw `CloudOnlyError`, and no
|
|
29
29
|
* request is ever sent to RushDB Cloud.
|
|
@@ -32,7 +32,7 @@ export type SDKConfig = {
|
|
|
32
32
|
/** Standalone engine base URL when `direct` is enabled (e.g. `http://127.0.0.1:3000`). */
|
|
33
33
|
engineUrl?: string;
|
|
34
34
|
/**
|
|
35
|
-
* Tenant on a multitenant engine (`
|
|
35
|
+
* Tenant on a multitenant engine (`rushdb serve --multitenant`), sent as
|
|
36
36
|
* `X-RushDB-Tenant`. Omit for a single-tenant engine.
|
|
37
37
|
*/
|
|
38
38
|
scope?: string;
|