@rushdb/javascript-sdk 1.19.1 → 2.0.0

package/dist/types/expressions.d.ts

@@ -1,4 +1,4 @@
-import type { PROPERTY_TYPE_BOOLEAN, PROPERTY_TYPE_DATETIME, PROPERTY_TYPE_NULL, PROPERTY_TYPE_NUMBER, PROPERTY_TYPE_STRING, PROPERTY_TYPE_VECTOR } from '../common/constants.js';
+import type { PROPERTY_TYPE_BOOLEAN, PROPERTY_TYPE_DATETIME, PROPERTY_TYPE_NULL, PROPERTY_TYPE_NUMBER, PROPERTY_TYPE_STRING } from '../common/constants.js';
 import type { MaybeArray, RequireAtLeastOne } from './utils.js';
 import type { BooleanValue, DatetimeObject, DatetimeValue, NullValue, NumberValue, PropertyType, StringValue } from './value.js';
 export type DatetimeExpression = DatetimeValue | RequireAtLeastOne<Record<'$gt' | '$gte' | '$lt' | '$lte' | '$ne', DatetimeObject | DatetimeValue> & Record<'$in' | '$nin', Array<DatetimeObject | DatetimeValue>> & Record<'$exists', BooleanValue>>;
@@ -6,25 +6,16 @@ export type BooleanExpression = BooleanValue | Record<'$ne' | '$exists', Boolean
 export type NullExpression = NullValue | Record<'$ne' | '$exists', NullValue | BooleanValue>;
 export type NumberExpression = NumberValue | RequireAtLeastOne<Record<'$gt' | '$gte' | '$lt' | '$lte' | '$ne', NumberValue> & Record<'$in' | '$nin', Array<NumberValue>> & Record<'$exists', BooleanValue>>;
 export type StringExpression = StringValue | RequireAtLeastOne<Record<'$contains' | '$endsWith' | '$ne' | '$startsWith', StringValue> & Record<'$in' | '$nin', Array<StringValue>> & Record<'$exists', BooleanValue>>;
-export type VectorSearchFn = 'jaccard' | 'overlap' | 'cosine' | 'pearson' | 'euclideanDistance' | 'euclidean';
-export type VectorExpression = {
-    $vector: {
-        fn: `gds.similarity.${VectorSearchFn}`;
-        query: Array<number>;
-        threshold: number | RequireAtLeastOne<Record<'$gt' | '$gte' | '$lt' | '$lte' | '$ne', number>>;
-    };
-};
 export type TypeExpression = {
     $type: PropertyType;
 };
-export type PropertyExpression = BooleanExpression | DatetimeExpression | NullExpression | NumberExpression | StringExpression | TypeExpression | VectorExpression;
+export type PropertyExpression = BooleanExpression | DatetimeExpression | NullExpression | NumberExpression | StringExpression | TypeExpression;
 export type PropertyExpressionByType = {
     [PROPERTY_TYPE_BOOLEAN]: BooleanExpression | TypeExpression;
     [PROPERTY_TYPE_DATETIME]: DatetimeExpression | TypeExpression;
     [PROPERTY_TYPE_NULL]: NullExpression | TypeExpression;
     [PROPERTY_TYPE_NUMBER]: NumberExpression | TypeExpression;
     [PROPERTY_TYPE_STRING]: StringExpression | TypeExpression;
-    [PROPERTY_TYPE_VECTOR]: VectorExpression | TypeExpression;
 };
 export type LogicalGrouping<T> = Partial<{
     $and: MaybeArray<T>;

package/dist/types/query.d.ts

@@ -1,5 +1,5 @@
 import type { Model, RelationOptions } from '../sdk/index.js';
-import type { BooleanExpression, DatetimeExpression, LogicalGrouping, NullExpression, NumberExpression, PropertyExpression, PropertyExpressionByType, StringExpression, VectorSearchFn } from './expressions.js';
+import type { BooleanExpression, DatetimeExpression, LogicalGrouping, NullExpression, NumberExpression, PropertyExpression, PropertyExpressionByType, StringExpression } from './expressions.js';
 import type { Schema } from './schema.js';
 import type { AnyObject, MaybeArray, RequireAtLeastOne } from './utils.js';
 export type Related<M extends Record<string, Model['schema']> = Models> = keyof M extends never ? AnyObject : {
@@ -37,6 +37,9 @@ export type Expression<S extends Schema = Schema> = IdExpression | (S extends Sc
 export type Where<S extends Schema = Schema> = ((Expression<S> & Related) & LogicalGrouping<Expression<S> & Related>) | LogicalGrouping<Expression<S> & Related>;
 export type OrderDirection = 'asc' | 'desc';
 export type Order<S extends Schema = Schema> = OrderDirection | Partial<Record<keyof S, OrderDirection>>;
+/**
+ * @deprecated The aggregate clause is deprecated. Use select/groupBy for all metrics/analytics. Only use aggregate for vector similarity until select supports it.
+ */
 export type AggregateCollectFn = {
     alias: string;
     field?: string;
@@ -46,17 +49,26 @@ export type AggregateCollectFn = {
     skip?: number;
     unique?: boolean;
 };
+/**
+ * @deprecated See AggregateCollectFn.
+ */
 export type AggregateCollectNestedFn = Omit<AggregateCollectFn, 'field'> & {
     aggregate?: {
         [field: string]: AggregateCollectNestedFn;
     };
 };
+/**
+ * @deprecated See AggregateCollectFn.
+ */
 export type AggregateCountFn = {
     field?: string;
     fn: 'count';
     unique?: boolean;
     alias?: string;
 };
+/**
+ * @deprecated See AggregateCollectFn.
+ */
 export type AggregateTimeBucketFn = {
     field: string;
     fn: 'timeBucket';
@@ -64,6 +76,9 @@ export type AggregateTimeBucketFn = {
     granularity: 'day' | 'week' | 'month' | 'quarter' | 'year' | 'months';
     size?: number;
 };
+/**
+ * @deprecated The aggregate clause is deprecated. Use select/groupBy for all metrics/analytics. Only use aggregate for vector similarity until select supports it.
+ */
 export type AggregateFn<S extends Schema = Schema> = {
     field: string;
     fn: 'avg';
@@ -83,10 +98,13 @@ export type AggregateFn<S extends Schema = Schema> = {
     alias?: string;
 } | {
     field: string;
-    fn: `gds.similarity.${VectorSearchFn}`;
+    fn: 'vector.similarity.cosine' | 'vector.similarity.euclidean';
     alias?: string;
     query: number[];
 } | AggregateTimeBucketFn | AggregateCollectFn;
+/**
+ * @deprecated See AggregateCollectFn.
+ */
 export type Aggregate = {
     [field: string]: AggregateCollectNestedFn;
 } | {
@@ -119,7 +137,79 @@ export type AggregateClause = {
 export type GroupByClause = {
     groupBy?: Array<string>;
 };
-export type SearchQuery<S extends Schema = any> = SearchQueryLabelsClause & PaginationClause & OrderClause<S> & WhereClause<S> & AggregateClause & GroupByClause;
+export type CollectExpr = {
+    from: string;
+    select?: SelectExprMap;
+    orderBy?: Order;
+    limit?: number;
+    skip?: number;
+    unique?: boolean;
+};
+export type TimeBucketExpr = {
+    /** Field reference, e.g. "$record.createdAt" */
+    field: string;
+    unit: 'day' | 'week' | 'month' | 'quarter' | 'year' | 'months' | 'hour' | 'minute' | 'second' | 'hours' | 'minutes' | 'seconds' | 'years';
+    /** Required when unit is months/hours/minutes/seconds/years */
+    size?: number;
+};
+export type Expr = string | number | boolean | {
+    $ref: string;
+} | {
+    $sum: Expr;
+} | {
+    $avg: Expr;
+    $precision?: number;
+} | {
+    $count: '*' | Expr;
+} | {
+    $min: Expr;
+} | {
+    $max: Expr;
+} | {
+    $divide: [Expr, Expr];
+} | {
+    $multiply: [Expr, Expr];
+} | {
+    $add: [Expr, Expr];
+} | {
+    $subtract: [Expr, Expr];
+} | {
+    $collect: CollectExpr;
+} | {
+    $timeBucket: TimeBucketExpr;
+};
+/** Canonical output-shaping clause — replaces `aggregate` */
+export type SelectExprMap = Record<string, Expr>;
+type InferExprType<E extends Expr> = E extends string ? any : E extends number ? number : E extends boolean ? boolean : E extends {
+    $sum: any;
+} ? number : E extends {
+    $avg: any;
+} ? number : E extends {
+    $count: any;
+} ? number : E extends {
+    $min: any;
+} ? number : E extends {
+    $max: any;
+} ? number : E extends {
+    $divide: any;
+} ? number : E extends {
+    $multiply: any;
+} ? number : E extends {
+    $add: any;
+} ? number : E extends {
+    $subtract: any;
+} ? number : E extends {
+    $collect: any;
+} ? Array<any> : E extends {
+    $timeBucket: any;
+} ? string : any;
+export type ExtractSelectFields<S extends SelectExprMap> = {
+    [K in keyof S]: InferExprType<S[K]>;
+};
+export type SelectClause = {
+    select?: SelectExprMap;
+};
+export type SearchQuery<S extends Schema = any> = SearchQueryLabelsClause & PaginationClause & OrderClause<S> & WhereClause<S> & SelectClause & AggregateClause & GroupByClause;
 /** Redeclare Models type in order to have suggestions over related records fields **/
 export interface Models {
 }

package/dist/types/schema.d.ts

@@ -15,7 +15,6 @@ type TypeMappingWrite = {
     null: null;
     number: number;
     string: string;
-    vector: Array<number>;
 };
 export type OptionalKeysWrite<S extends Schema = Schema> = {
     [Key in keyof S]: S[Key]['required'] extends false ? Key : S[Key]['default'] extends SchemaDefaultValue ? Key : never;
@@ -34,7 +33,6 @@ type TypeMappingRead = {
     null: null;
     number: number;
     string: string;
-    vector: Array<number>;
 };
 export type OptionalKeysRead<S extends Schema = Schema> = {
     [Key in keyof S]: S[Key]['required'] extends false ? Key : never;

package/dist/types/value.d.ts

@@ -1,4 +1,4 @@
-import type { PROPERTY_TYPE_BOOLEAN, PROPERTY_TYPE_DATETIME, PROPERTY_TYPE_NULL, PROPERTY_TYPE_NUMBER, PROPERTY_TYPE_STRING, PROPERTY_TYPE_VECTOR } from '../common/constants.js';
+import type { PROPERTY_TYPE_BOOLEAN, PROPERTY_TYPE_DATETIME, PROPERTY_TYPE_NULL, PROPERTY_TYPE_NUMBER, PROPERTY_TYPE_STRING } from '../common/constants.js';
 import type { MaybeArray } from './utils.js';
 export type DatetimeObject = {
     $day?: number;
@@ -16,7 +16,7 @@ export type BooleanValue = boolean;
 export type NullValue = null;
 export type NumberValue = number;
 export type StringValue = string;
-export type PropertyType = typeof PROPERTY_TYPE_BOOLEAN | typeof PROPERTY_TYPE_DATETIME | typeof PROPERTY_TYPE_NULL | typeof PROPERTY_TYPE_NUMBER | typeof PROPERTY_TYPE_STRING | typeof PROPERTY_TYPE_VECTOR;
+export type PropertyType = typeof PROPERTY_TYPE_BOOLEAN | typeof PROPERTY_TYPE_DATETIME | typeof PROPERTY_TYPE_NULL | typeof PROPERTY_TYPE_NUMBER | typeof PROPERTY_TYPE_STRING;
 type WithId<T> = T & {
     id: string;
 };
@@ -27,6 +27,7 @@ export type Property = WithId<{
     metadata?: string;
     name: string;
     type: PropertyType;
+    recordsCount?: number;
 }>;
 export type PropertyWithValue = WithValue<Property>;
 export type PropertyValuesData = {
@@ -37,6 +38,6 @@ export type PropertyValuesData = {
 export type PropertyDraft = Omit<PropertyWithValue, 'id'> & {
     valueSeparator?: string;
 };
-export type PropertySingleValue<TType extends PropertyType = PropertyType> = TType extends typeof PROPERTY_TYPE_DATETIME ? DatetimeValue : TType extends typeof PROPERTY_TYPE_NUMBER ? NumberValue : TType extends typeof PROPERTY_TYPE_STRING ? StringValue : TType extends typeof PROPERTY_TYPE_NULL ? NullValue : TType extends typeof PROPERTY_TYPE_BOOLEAN ? BooleanValue : TType extends typeof PROPERTY_TYPE_VECTOR ? Array<number> : StringValue;
-export type PropertyValue<TType extends PropertyType = PropertyType> = TType extends typeof PROPERTY_TYPE_VECTOR ? Array<number> : MaybeArray<PropertySingleValue<TType>>;
+export type PropertySingleValue<TType extends PropertyType = PropertyType> = TType extends typeof PROPERTY_TYPE_DATETIME ? DatetimeValue : TType extends typeof PROPERTY_TYPE_NUMBER ? NumberValue : TType extends typeof PROPERTY_TYPE_STRING ? StringValue : TType extends typeof PROPERTY_TYPE_NULL ? NullValue : TType extends typeof PROPERTY_TYPE_BOOLEAN ? BooleanValue : StringValue;
+export type PropertyValue<TType extends PropertyType = PropertyType> = MaybeArray<PropertySingleValue<TType>>;
 export {};

package/package.json

@@ -1,39 +1,44 @@
 {
   "name": "@rushdb/javascript-sdk",
-  "description": "RushDB Javascript SDK",
+  "description": "RushDB JavaScript SDK — memory layer for AI agents and modern apps",
   "keywords": [
+    "rushdb",
     "database",
     "graph database",
-    "instant database",
-    "instant-database",
-    "instantdatabase",
-    "instant db",
-    "instant-db",
-    "instantdb",
-    "neo4j",
-    "cypher",
-    "ai",
-    "ai database",
-    "etl",
-    "data-pipeline",
-    "data science",
-    "data-science",
-    "data management",
-    "data-management",
-    "machine learning",
-    "machine-learning",
-    "persistence",
-    "db",
-    "graph",
-    "graphs",
     "graph-database",
+    "ai memory",
+    "ai-memory",
+    "agent memory",
+    "agent-memory",
+    "memory layer",
+    "memory-layer",
+    "ai agents",
+    "ai-agents",
+    "llm memory",
+    "llm-memory",
+    "mcp",
+    "vector search",
+    "vector-search",
+    "rag",
+    "embedding",
+    "embeddings",
+    "knowledge graph",
+    "knowledge-graph",
+    "json normalization",
+    "json-normalization",
+    "schema-less",
+    "schemaless",
+    "no-schema",
     "self-hosted",
-    "rush-db",
-    "rush db",
-    "rushdb"
+    "rest api",
+    "rest-api",
+    "graph",
+    "relationships",
+    "persistence",
+    "rush-db"
   ],
   "license": "Apache-2.0",
-  "version": "1.19.1",
+  "version": "2.0.0",
   "type": "module",
   "files": [
     "dist"