@rushdb/javascript-sdk 2.10.2 → 3.0.0

package/dist/sdk/record.d.ts

@@ -1,4 +1,5 @@
 import type { ExtractAggregateFields, FlattenTypes, InferSchemaTypesRead, InferSchemaTypesWrite, MaybeArray, OptionalKeysRead, PropertyDraft, RequiredKeysRead, Schema, SearchQuery } from '../types/index.js';
+import type { TextSearchReport, VectorSearchReport } from '../api/types.js';
 import type { Transaction } from './transaction.js';
 /**
  * Internal properties that are present on all database records.
@@ -93,6 +94,12 @@ export type DBRecordCreationOptions = {
     relationshipType?: string;
     mergeStrategy?: 'append' | 'rewrite';
     mergeBy?: string[];
+    /**
+     * Shorthand for `mergeBy: []` + `mergeStrategy: 'append'`: match existing
+     * records on all incoming keys and merge (upsert) instead of creating
+     * duplicates on re-import.
+     */
+    merge?: boolean;
 };
 export declare class DBRecordInstance<S extends Schema = Schema, Q extends SearchQuery<S> = SearchQuery<S>> {
     data: DBRecordInferred<S, Q>;
@@ -133,6 +140,13 @@ export declare class DBRecordInstance<S extends Schema = Schema, Q extends Searc
      * @throws Error if the ID is missing or invalid
      */
     get timestamp(): number;
+    /**
+     * The similarity score from the most recent vector search.
+     * Only present on records returned by `records.vectorSearch()`.
+     * Returns `undefined` for records from regular `find`/`search` queries.
+     * Equivalent to `data.__score`.
+     */
+    get score(): number | undefined;
     /**
      * Deletes this record from the database.
      *
@@ -140,7 +154,7 @@ export declare class DBRecordInstance<S extends Schema = Schema, Q extends Searc
      * @returns Promise resolving to the result of the delete operation
      * @throws Error if the record data is undefined
      */
-    delete(transaction?: Transaction | string): Promise<import("../index.node.js").ApiResponse<{
+    delete(transaction?: Transaction | string): Promise<import("../api/types.js").ApiResponse<{
         message: string;
     }>>;
     /**
@@ -171,7 +185,7 @@ export declare class DBRecordInstance<S extends Schema = Schema, Q extends Searc
      * @returns Promise resolving to the result of the attach operation
      * @throws Error if the record data is undefined
      */
-    attach(target: RelationTarget, options?: RelationOptions, transaction?: Transaction | string): Promise<import("../index.node.js").ApiResponse<{
+    attach(target: RelationTarget, options?: RelationOptions, transaction?: Transaction | string): Promise<import("../api/types.js").ApiResponse<{
         message: string;
     }>>;
     /**
@@ -183,7 +197,7 @@ export declare class DBRecordInstance<S extends Schema = Schema, Q extends Searc
      * @returns Promise resolving to the result of the detach operation
      * @throws Error if the record data is undefined
      */
-    detach(target: RelationTarget, options?: RelationDetachOptions, transaction?: Transaction | string): Promise<import("../index.node.js").ApiResponse<{
+    detach(target: RelationTarget, options?: RelationDetachOptions, transaction?: Transaction | string): Promise<import("../api/types.js").ApiResponse<{
         message: string;
     }>>;
 }
@@ -203,6 +217,12 @@ export declare class DBRecordsArrayInstance<S extends Schema = Schema, Q extends
     searchQuery?: SearchQuery<S>;
     /** Warnings returned by AI-assisted query generation, when applicable. */
     warnings?: string[];
+    /** For a vector search: how the engine ran it. */
+    vectorSearch?: VectorSearchReport;
+    /** For a keyword or hybrid search: how the engine ran its keyword leg. */
+    textSearch?: TextSearchReport;
+    /** For a hybrid search: how its legs were combined. */
+    fusion?: 'rrf' | 'dbsf';
     /**
      * Creates a new DBRecordsArrayInstance.
      * Typically, you don't create these directly but receive them from query results.

package/dist/sdk/types.d.ts

@@ -10,11 +10,11 @@ export type State = {
     debug: boolean;
     timeout: number;
     token?: string;
+    direct?: boolean;
+    engineUrl?: string;
     initialized: boolean;
     serverSettings?: {
         selfHosted: boolean;
-        customDB?: boolean;
-        managedDB?: boolean;
     };
 } & Partial<ApiConnectionConfig>;
 export type Logger = (payload: any) => void;
@@ -22,6 +22,20 @@ export type SDKConfig = {
     httpClient?: HttpClientInterface;
     timeout?: number;
     logger?: Logger;
+    /**
+     * Direct mode: talk to a standalone RushDB engine (`rushdbd`) instead of
+     * RushDB Cloud. Requires `engineUrl`; the token is the engine token. The
+     * methods listed in `CLOUD_ONLY_METHODS` throw `CloudOnlyError`, and no
+     * request is ever sent to RushDB Cloud.
+     */
+    direct?: boolean;
+    /** Standalone engine base URL when `direct` is enabled (e.g. `http://127.0.0.1:3000`). */
+    engineUrl?: string;
+    /**
+     * Tenant on a multitenant engine (`rushdbd --multitenant`), sent as
+     * `X-RushDB-Tenant`. Omit for a single-tenant engine.
+     */
+    scope?: string;
     options?: {
         /**
          * @description

package/dist/types/query.d.ts

@@ -5,9 +5,8 @@ import type { AnyObject, MaybeArray, RequireAtLeastOne } from './utils.js';
 /**
  * Variable-length traversal depth for `$relation.hops` and `$cycle.hops`.
  * A number matches exactly that many hops; `{ min?, max? }` matches a range
- * (`min` defaults to 1, or 2 for `$cycle`). Omitting `max` requests
- * unbounded traversal, which is only allowed on self-hosted deployments and
- * projects with a custom Neo4j instance.
+ * (`min` defaults to 1, or 2 for `$cycle`). Omitting `max` means up to 10
+ * hops (the engine default); RushDB Cloud also caps `max` per deployment.
  */
 export type TraversalHops = number | {
     min?: number;

package/package.json

@@ -38,7 +38,7 @@
     "rush-db"
   ],
   "license": "Apache-2.0",
-  "version": "2.10.2",
+  "version": "3.0.0",
   "type": "module",
   "files": [
     "dist"
@@ -47,18 +47,40 @@
   "module": "./dist/index.mjs",
   "types": "./dist/index.worker.d.ts",
   "devDependencies": {
+    "@changesets/cli": "^2.27.10",
+    "@types/node": "^20.17.23",
     "dotenv": "^16.0.3",
+    "esbuild": "0.21.5",
     "typedoc": "^0.28.19",
-    "typedoc-plugin-markdown": "^4.12.0"
+    "typedoc-plugin-markdown": "^4.12.0",
+    "typescript": "5.7.2",
+    "vitest": "^1.6.1"
   },
   "sideEffects": false,
   "publishConfig": {
     "access": "public"
   },
-  "bugs": "https://github.com/rush-db/rushdb/issues",
+  "bugs": "https://github.com/rush-db/javascript-sdk/issues",
   "repository": {
-    "type": "https",
-    "url": "https://github.com/rush-db/rushdb"
+    "type": "git",
+    "url": "git+https://github.com/rush-db/javascript-sdk.git"
+  },
+  "homepage": "https://github.com/rush-db/javascript-sdk#readme",
+  "engines": {
+    "node": ">=18.0.0",
+    "pnpm": ">=10.0.0"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.node.d.ts",
+      "node": {
+        "import": "./dist/index.node.mjs",
+        "require": "./dist/index.cjs"
+      },
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
   },
   "scripts": {
     "build": "pnpm clean && pnpm build:package && pnpm build:types",
@@ -69,6 +91,8 @@
     "clean": "rm -rf ./dist ./node_modules/.cache ./coverage ./esm ./cjs ./types",
     "flush": "rm -rf node_modules",
     "lint:circularDeps": "madge --circular ./src/*",
-    "lint:circularDepsWithImage": "madge --image graph.svg --circular ./src/*"
+    "lint:circularDepsWithImage": "madge --image graph.svg --circular ./src/*",
+    "test": "vitest run",
+    "release": "pnpm build && changeset publish"
   }
 }