@rushdb/javascript-sdk 0.17.1 → 1.0.1

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 } from '../common/constants.js';
+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 { MaybeArray, RequireAtLeastOne } from './utils.js';
 import type { BooleanValue, DatetimeObject, DatetimeValue, NullValue, NumberValue, StringValue } from './value.js';
 export type DatetimeExpression = DatetimeValue | RequireAtLeastOne<Record<'$gt' | '$gte' | '$lt' | '$lte' | '$ne', DatetimeObject | DatetimeValue> & Record<'$in' | '$nin', Array<DatetimeObject | DatetimeValue>>>;
@@ -6,13 +6,22 @@ export type BooleanExpression = BooleanValue | Record<'$ne', BooleanValue>;
 export type NullExpression = NullValue | Record<'$ne', NullValue>;
 export type NumberExpression = NumberValue | RequireAtLeastOne<Record<'$gt' | '$gte' | '$lt' | '$lte' | '$ne', NumberValue> & Record<'$in' | '$nin', Array<NumberValue>>>;
 export type StringExpression = StringValue | RequireAtLeastOne<Record<'$contains' | '$endsWith' | '$ne' | '$startsWith', StringValue> & Record<'$in' | '$nin', Array<StringValue>>>;
-export type PropertyExpression = BooleanExpression | DatetimeExpression | NullExpression | NumberExpression | StringExpression;
+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 PropertyExpression = BooleanExpression | DatetimeExpression | NullExpression | NumberExpression | StringExpression | VectorExpression;
 export type PropertyExpressionByType = {
     [PROPERTY_TYPE_BOOLEAN]: BooleanExpression;
     [PROPERTY_TYPE_DATETIME]: DatetimeExpression;
     [PROPERTY_TYPE_NULL]: NullExpression;
     [PROPERTY_TYPE_NUMBER]: NumberExpression;
     [PROPERTY_TYPE_STRING]: StringExpression;
+    [PROPERTY_TYPE_VECTOR]: VectorExpression;
 };
 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 } from './expressions.js';
+import type { BooleanExpression, DatetimeExpression, LogicalGrouping, NullExpression, NumberExpression, PropertyExpression, PropertyExpressionByType, StringExpression, VectorSearchFn } 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 : {
@@ -73,6 +73,11 @@ export type AggregateFn<S extends Schema = Schema> = {
     field?: string;
     fn: 'count';
     uniq?: boolean;
+} | {
+    field: string;
+    fn: `gds.similarity.${VectorSearchFn}`;
+    alias: string;
+    query: number[];
 } | AggregateCollectFn;
 export type Aggregate = {
     [field: string]: AggregateCollectNestedFn;
@@ -83,7 +88,7 @@ type InferAggregateType<T extends AggregateFn | string> = T extends string ? any
     fn: 'sum' | 'avg' | 'min' | 'max' | 'count';
 } ? number : T extends {
     fn: 'collect';
-} ? any[] : never;
+} ? Array<any> : never;
 export type ExtractAggregateFields<A extends Record<string, AggregateFn>> = {
     [K in keyof A]: InferAggregateType<A[K]>;
 };
@@ -95,7 +100,7 @@ export type PaginationClause = {
     skip?: number;
 };
 export type SearchQueryLabelsClause = {
-    labels?: string[];
+    labels?: Array<string>;
 };
 export type OrderClause<S extends Schema = Schema> = {
     orderBy?: Order<S>;

package/dist/types/schema.d.ts

@@ -15,6 +15,7 @@ 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;
@@ -23,9 +24,9 @@ export type RequiredKeysWrite<S extends Schema = Schema> = {
     [Key in keyof S]: S[Key]['required'] extends false ? never : S[Key]['default'] extends SchemaDefaultValue ? never : Key;
 }[keyof S];
 export type InferSchemaTypesWrite<S extends Schema = Schema> = FlattenTypes<{
-    [Key in RequiredKeysWrite<S>]: S[Key]['multiple'] extends true ? TypeMappingWrite[S[Key]['type']][] : TypeMappingWrite[S[Key]['type']];
+    [Key in RequiredKeysWrite<S>]: S[Key]['multiple'] extends true ? Array<TypeMappingWrite[S[Key]['type']]> : TypeMappingWrite[S[Key]['type']];
 } & {
-    [Key in OptionalKeysWrite<S>]?: S[Key]['multiple'] extends true ? TypeMappingWrite[S[Key]['type']][] : TypeMappingWrite[S[Key]['type']];
+    [Key in OptionalKeysWrite<S>]?: S[Key]['multiple'] extends true ? Array<TypeMappingWrite[S[Key]['type']]> : TypeMappingWrite[S[Key]['type']];
 }>;
 type TypeMappingRead = {
     boolean: boolean;
@@ -33,6 +34,7 @@ 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;
@@ -41,8 +43,8 @@ export type RequiredKeysRead<S extends Schema = Schema> = {
     [Key in keyof S]: S[Key]['required'] extends false ? never : Key;
 }[keyof S];
 export type InferSchemaTypesRead<S extends Schema = Schema> = FlattenTypes<{
-    [Key in RequiredKeysRead<S>]: S[Key]['multiple'] extends true ? TypeMappingRead[S[Key]['type']][] : TypeMappingRead[S[Key]['type']];
+    [Key in RequiredKeysRead<S>]: S[Key]['multiple'] extends true ? Array<TypeMappingRead[S[Key]['type']]> : TypeMappingRead[S[Key]['type']];
 } & {
-    [Key in OptionalKeysRead<S>]?: S[Key]['multiple'] extends true ? TypeMappingRead[S[Key]['type']][] : TypeMappingRead[S[Key]['type']];
+    [Key in OptionalKeysRead<S>]?: S[Key]['multiple'] extends true ? Array<TypeMappingRead[S[Key]['type']]> : TypeMappingRead[S[Key]['type']];
 }>;
 export {};

package/dist/types/utils.d.ts

@@ -1,3 +1,4 @@
+import type { PropertyValue } from './value';
 export type MaybePromise<T = any> = () => Promise<T> | T;
 export type RequireAtLeastOne<T> = {
     [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
@@ -7,3 +8,4 @@ export type FlattenTypes<T> = T extends object ? {
     [K in keyof T]: FlattenTypes<T[K]>;
 } : T;
 export type AnyObject = Record<string, any>;
+export type FlatObject = Record<PropertyKey, PropertyValue>;

package/dist/types/value.d.ts

@@ -1,6 +1,6 @@
-import type { PROPERTY_TYPE_BOOLEAN, PROPERTY_TYPE_DATETIME, PROPERTY_TYPE_NULL, PROPERTY_TYPE_NUMBER, PROPERTY_TYPE_STRING } from '../common/constants.js';
+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 { MaybeArray } from './utils.js';
-import type { OrderDirection } from './query';
+import type { OrderDirection } from './query.js';
 export type DatetimeObject = {
     $day?: number;
     $hour?: number;
@@ -17,20 +17,26 @@ 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;
-export type Property = {
+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;
+type WithId<T> = T & {
     id: string;
-    metadata?: string;
-    name: string;
-    type: PropertyType;
 };
-export type PropertyWithValue = Property & {
+type WithValue<T> = T & {
     value: PropertyValue;
 };
+export type Property = WithId<{
+    metadata?: string;
+    name: string;
+    type: PropertyType;
+}>;
+export type PropertyWithValue = WithValue<Property>;
 export type PropertyValuesData = {
     max?: number;
     min?: number;
-    values: PropertyValue[];
+    values: Array<PropertyValue>;
+};
+export type PropertyDraft = Omit<PropertyWithValue, 'id'> & {
+    valueSeparator?: string;
 };
 export type PropertyValuesOptions = {
     sort?: OrderDirection;
@@ -38,5 +44,6 @@ export type PropertyValuesOptions = {
     limit?: number;
     query?: 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 : StringValue;
-export type PropertyValue<TType extends PropertyType = PropertyType> = 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 : 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 {};

package/package.json

@@ -33,7 +33,7 @@
     "rushdb"
   ],
   "license": "Apache-2.0",
-  "version": "0.17.1",
+  "version": "1.0.1",
   "type": "module",
   "files": [
     "dist"

package/dist/api/create-api.d.ts

@@ -1,66 +0,0 @@
-import type { createFetcher } from '../network/index.js';
-import type { DBRecord, DBRecordInferred, DBRecordTarget, Relation, RelationDetachOptions, RelationOptions } from '../sdk/record.js';
-import type { Transaction } from '../sdk/transaction.js';
-import type { Property, PropertyValuesData, SearchQuery, Schema, MaybeArray, PropertyValuesOptions } from '../types/index.js';
-import type { ApiResponse } from './types.js';
-import { DBRecordsBatchDraft, DBRecordDraft } from '../sdk/record.js';
-import type { Logger } from '../sdk/types.js';
-export declare const createApi: (fetcher: ReturnType<typeof createFetcher>, logger?: Logger) => {
-    labels: {
-        find<S extends Schema = any>(searchParams: SearchQuery<S>, transaction?: Transaction | string): Promise<ApiResponse<Record<string, number>>>;
-    };
-    properties: {
-        delete: (id: string, transaction?: Transaction | string) => Promise<ApiResponse<Property>>;
-        find: <S extends Schema = any>(searchParams: SearchQuery<S>, transaction?: Transaction | string) => Promise<ApiResponse<Property[]>>;
-        findById: (id: string, transaction?: Transaction | string) => Promise<ApiResponse<Property>>;
-        values: (id: string, options?: PropertyValuesOptions, transaction?: Transaction | string) => Promise<ApiResponse<Property & PropertyValuesData>>;
-    };
-    records: {
-        attach(source: DBRecordTarget, idOrIds: MaybeArray<string>, options?: RelationOptions, transaction?: Transaction | string): Promise<ApiResponse<{
-            message: string;
-        }>>;
-        create<S extends Schema = any>(data: DBRecordDraft | S, transaction?: Transaction | string): Promise<ApiResponse<DBRecord<S> | undefined>>;
-        createMany<S extends Schema = any>(data: DBRecordsBatchDraft | S[], transaction?: Transaction | string): Promise<ApiResponse<DBRecord<S>[]>>;
-        delete<S extends Schema = any>(searchParams: SearchQuery<S>, transaction?: Transaction | string): Promise<ApiResponse<{
-            message: string;
-        }>>;
-        deleteById(idOrIds: MaybeArray<string>, transaction?: Transaction | string): Promise<ApiResponse<{
-            message: string;
-        }>>;
-        detach(source: DBRecordTarget, idOrIds: MaybeArray<string>, options?: RelationDetachOptions, transaction?: Transaction | string): Promise<ApiResponse<{
-            message: string;
-        }>>;
-        export<S extends Schema = any>(searchParams: SearchQuery<S>, transaction?: Transaction | string): Promise<ApiResponse<{
-            dateTime: string;
-            fileContent: string;
-        }>>;
-        find<S extends Schema = any, Q extends SearchQuery<S> = SearchQuery<S>>(params?: {
-            id?: string;
-            searchParams: Q;
-        }, transaction?: Transaction | string): Promise<ApiResponse<DBRecordInferred<S, Q>[]>>;
-        findById<S extends Schema = any>(idOrIds: MaybeArray<string>, transaction?: Transaction | string): Promise<ApiResponse<DBRecord<S> | DBRecord<S>[]>>;
-        findOne<S extends Schema = any, Q extends SearchQuery<S> = SearchQuery<S>>(searchParams: Q, transaction?: Transaction | string): Promise<ApiResponse<DBRecordInferred<S, Q>>>;
-        findUniq<S extends Schema = any, Q extends SearchQuery<S> = SearchQuery<S>>(searchParams: Q, transaction?: Transaction | string): Promise<ApiResponse<DBRecordInferred<S, Q>>>;
-        properties(target: string, transaction?: Transaction | string): Promise<ApiResponse<Property[]>>;
-        relations(target: DBRecordTarget, transaction?: Transaction | string): Promise<ApiResponse<Relation[]>>;
-        set<S extends Schema = any>(target: DBRecordTarget, data: DBRecordDraft | S, transaction?: Transaction | string): Promise<ApiResponse<DBRecord<S>>>;
-        update<S extends Schema = any>(target: DBRecordTarget, data: DBRecordDraft | S, transaction?: Transaction | string): Promise<ApiResponse<DBRecord<S>>>;
-    };
-    relations: {
-        find<S extends Schema = any>(searchParams: SearchQuery<S>, pagination?: Pick<SearchQuery, "limit" | "skip">, transaction?: Transaction | string): Promise<ApiResponse<Relation[]>>;
-    };
-    tx: {
-        begin(config?: Partial<{
-            ttl: number;
-        }>): Promise<ApiResponse<{
-            id: string;
-        }>>;
-        commit(id: string): Promise<ApiResponse<{
-            message: string;
-        }>>;
-        get(id: string): Promise<ApiResponse<{
-            id: string;
-        }>>;
-        rollback(id: string): Promise<void>;
-    };
-};