falkordb 6.7.0 → 6.9.0

package/dist/src/types/falkordb-options.d.ts

@@ -0,0 +1,65 @@
+import type { SocketOptions } from './socket-options';
+export interface FalkorDBOptions {
+    /**
+     * `falkor[s]://[[username][:password]@][host][:port][/db-number]`
+     */
+    url?: string;
+    /**
+     * Socket connection properties
+     */
+    socket?: SocketOptions;
+    /**
+     * Server hostname, shorthand for `socket.host`.
+     * Ignored when `url` or `socket.host` is provided.
+     */
+    host?: string;
+    /**
+     * Server port, shorthand for `socket.port`.
+     * Ignored when `url` or `socket.port` is provided.
+     */
+    port?: number;
+    /**
+     * Sentinel only. Resend write commands to the new master when the
+     * connection is lost while waiting for their reply, e.g. during a master
+     * hand-over. The old master may have already run them, so a write can be
+     * applied twice. Read-only commands, and commands the server certainly did
+     * not run (such as ones rejected with `READONLY`), are always resent.
+     * @default false
+     */
+    retryWritesOnConnectionLoss?: boolean;
+    /**
+     * ACL username ([see ACL guide](https://redis.io/topics/acl))
+     */
+    username?: string;
+    /**
+     * ACL password or the old "--requirepass" password
+     */
+    password?: string;
+    /**
+     * Client name ([see `CLIENT SETNAME`](https://redis.io/commands/client-setname))
+     */
+    name?: string;
+    /**
+     * Connect in [`READONLY`](https://redis.io/commands/readonly) mode
+     */
+    readonly?: boolean;
+    /**
+     * Send `PING` command at interval (in ms).
+     * Useful with Redis deployments that do not use TCP Keep-Alive.
+     */
+    pingInterval?: number;
+    /**
+     * If set to true, disables sending client identifier (user-agent like message) to the redis server
+     */
+    disableClientInfo?: boolean;
+    /**
+     * Tag to append to library name that is sent to the Redis server
+     */
+    clientInfoTag?: string;
+    /**
+     * RESP protocol version. Only RESP 2 is supported: under RESP 3 node-redis rewrites
+     * module map replies into objects, which does not match the reply shapes this client
+     * parses and publishes types for. Passing anything else throws.
+     */
+    RESP?: 2;
+}

package/dist/src/types/falkordb-options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/graph-metadata.d.ts

@@ -0,0 +1,5 @@
+export interface GraphMetadata {
+    labels: Array<string>;
+    relationshipTypes: Array<string>;
+    propertyKeys: Array<string>;
+}

package/dist/src/types/graph-metadata.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/graph-raw-value.d.ts

@@ -0,0 +1,29 @@
+import type { GraphValueTypes } from '../enums';
+export type GraphEntityRawProperties = Array<[id: number, ...value: GraphRawValue]>;
+export type GraphEdgeRawValue = [
+    GraphValueTypes.EDGE,
+    [
+        id: number,
+        relationshipTypeId: number,
+        sourceId: number,
+        destinationId: number,
+        properties: GraphEntityRawProperties
+    ]
+];
+export type GraphNodeRawValue = [
+    GraphValueTypes.NODE,
+    [
+        id: number,
+        labelIds: Array<number>,
+        properties: GraphEntityRawProperties
+    ]
+];
+export type GraphPathRawValue = [
+    GraphValueTypes.PATH,
+    [
+        nodes: [GraphValueTypes.ARRAY, Array<GraphNodeRawValue>],
+        edges: [GraphValueTypes.ARRAY, Array<GraphEdgeRawValue>]
+    ]
+];
+export type GraphMapRawValue = [GraphValueTypes.MAP, Array<string | GraphRawValue>];
+export type GraphRawValue = [GraphValueTypes.NULL, null] | [GraphValueTypes.STRING, string] | [GraphValueTypes.INTEGER, number] | [GraphValueTypes.BOOLEAN, string] | [GraphValueTypes.DOUBLE, string] | [GraphValueTypes.ARRAY, Array<GraphRawValue>] | GraphEdgeRawValue | GraphNodeRawValue | GraphPathRawValue | GraphMapRawValue | [GraphValueTypes.POINT, [latitude: string, longitude: string]] | [GraphValueTypes.VECTORF32, number[]] | [GraphValueTypes.DATETIME, number] | [GraphValueTypes.DATE, number] | [GraphValueTypes.TIME, number] | [GraphValueTypes.DURATION, number];

package/dist/src/types/graph-raw-value.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/graph-value.d.ts

@@ -0,0 +1,29 @@
+import type { Temporal } from '@js-temporal/polyfill';
+import type { QueryReply } from './query-reply';
+export type GraphEntityProperties = Record<string, GraphValue>;
+export interface GraphEdge {
+    id: number;
+    relationshipType: string;
+    sourceId: number;
+    destinationId: number;
+    properties: GraphEntityProperties;
+}
+export interface GraphNode {
+    id: number;
+    labels: Array<string>;
+    properties: GraphEntityProperties;
+}
+export interface GraphPath {
+    nodes: Array<GraphNode>;
+    edges: Array<GraphEdge>;
+}
+export type GraphMap = {
+    [key: string]: GraphValue;
+};
+export type GraphValue = null | string | number | boolean | Array<GraphValue> | GraphEdge | GraphNode | GraphPath | GraphMap | {
+    latitude: string;
+    longitude: string;
+} | number[] | Temporal.PlainDateTime | Temporal.PlainDate | Temporal.PlainTime | Temporal.Duration;
+export type GraphReply<T> = Omit<QueryReply, "headers" | "data"> & {
+    data?: Array<T>;
+};

package/dist/src/types/graph-value.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/index.d.ts

@@ -0,0 +1,16 @@
+export * from './cluster-graph-connection';
+export * from './config-item';
+export * from './falkordb-options';
+export * from './graph-metadata';
+export * from './graph-raw-value';
+export * from './graph-value';
+export * from './memory-usage';
+export * from './net-socket-options';
+export * from './query-options';
+export * from './query-reply';
+export * from './single-graph-connection';
+export * from './slow-log';
+export * from './socket-options';
+export * from './tls-socket-options';
+export * from './typed-redis-client-options';
+export * from './udf-list';

package/dist/src/types/index.js

@@ -0,0 +1,32 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./cluster-graph-connection"), exports);
+__exportStar(require("./config-item"), exports);
+__exportStar(require("./falkordb-options"), exports);
+__exportStar(require("./graph-metadata"), exports);
+__exportStar(require("./graph-raw-value"), exports);
+__exportStar(require("./graph-value"), exports);
+__exportStar(require("./memory-usage"), exports);
+__exportStar(require("./net-socket-options"), exports);
+__exportStar(require("./query-options"), exports);
+__exportStar(require("./query-reply"), exports);
+__exportStar(require("./single-graph-connection"), exports);
+__exportStar(require("./slow-log"), exports);
+__exportStar(require("./socket-options"), exports);
+__exportStar(require("./tls-socket-options"), exports);
+__exportStar(require("./typed-redis-client-options"), exports);
+__exportStar(require("./udf-list"), exports);

package/dist/src/types/memory-usage.d.ts

@@ -0,0 +1,4 @@
+export interface MemoryUsageOptions {
+    SAMPLES?: number;
+}
+export type MemoryUsageReply = Array<string | number | MemoryUsageReply>;

package/dist/src/types/memory-usage.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/net-socket-options.d.ts

@@ -0,0 +1,4 @@
+import type * as net from 'net';
+export type NetSocketOptions = Partial<net.SocketConnectOpts> & {
+    tls?: false;
+};

package/dist/src/types/net-socket-options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/query-options.d.ts

@@ -0,0 +1,9 @@
+export type QueryParam = null | string | number | boolean | QueryParams | Array<QueryParam>;
+export type QueryParams = {
+    [key: string]: QueryParam;
+};
+export interface QueryOptions {
+    params?: QueryParams;
+    TIMEOUT?: number;
+}
+export type QueryOptionsBackwardCompatible = QueryOptions | number;

package/dist/src/types/query-options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/query-reply.d.ts

@@ -0,0 +1,20 @@
+type Headers = Array<string>;
+type Data = Array<string | number | null | Data>;
+type Metadata = Array<string>;
+export type QueryRawReply = [
+    headers: Headers,
+    data: Data,
+    metadata: Metadata
+] | [
+    metadata: Metadata
+];
+export type QueryReply = {
+    headers: undefined;
+    data: undefined;
+    metadata: Metadata;
+} | {
+    headers: Headers;
+    data: Data;
+    metadata: Metadata;
+};
+export {};

package/dist/src/types/query-reply.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/single-graph-connection.d.ts

@@ -0,0 +1,5 @@
+import type { RedisClientType, RedisFunctions, RedisScripts } from '@redis/client';
+import type commands from '../commands';
+export type SingleGraphConnection = RedisClientType<{
+    falkordb: typeof commands;
+}, RedisFunctions, RedisScripts, 2>;

package/dist/src/types/single-graph-connection.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/slow-log.d.ts

@@ -0,0 +1,12 @@
+export type SlowLogRawReply = Array<[
+    timestamp: string,
+    command: string,
+    query: string,
+    took: string
+]>;
+export type SlowLogReply = Array<{
+    timestamp: Date;
+    command: string;
+    query: string;
+    took: number;
+}>;

package/dist/src/types/slow-log.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/socket-options.d.ts

@@ -0,0 +1,40 @@
+import type { NetSocketOptions } from './net-socket-options';
+import type { TlsSocketOptions } from './tls-socket-options';
+export interface SocketCommonOptions {
+    /**
+     * Connection Timeout (in milliseconds)
+     */
+    connectTimeout?: number;
+    /**
+     * Toggle [`Nagle's algorithm`](https://nodejs.org/api/net.html#net_socket_setnodelay_nodelay)
+     */
+    noDelay?: boolean;
+    /**
+     * Toggle [`keep-alive`](https://nodejs.org/api/net.html#net_socket_setkeepalive_enable_initialdelay)
+     */
+    keepAlive?: number | false;
+    /**
+     * When the socket closes unexpectedly (without calling `.close()`), the client uses `reconnectStrategy` to decide what to do:
+     * 1. `false` -> do not reconnect, close the client and flush the command queue.
+     * 2. `number` -> wait for `X` milliseconds before reconnecting.
+     * 3. `(retries, cause) => false | number | Error` -> `number` is the same as configuring a `number` directly, `Error` is the same as `false`, but with a custom error.
+     *
+     * By default the initial connection is retried 3 times before `FalkorDB.connect()` rejects.
+     * After that, reconnects back off exponentially up to 2 seconds between attempts, with no
+     * limit on the number of attempts. A socket timeout (see `socketTimeout`) is never retried:
+     * the client closes instead.
+     */
+    reconnectStrategy?: false | number | ((retries: number, cause: Error) => false | Error | number);
+    /**
+     * Timeout (in milliseconds) after which an idle socket is closed. `undefined` means no timeout.
+     * With the default `reconnectStrategy` a timed-out client is not reconnected.
+     */
+    socketTimeout?: number;
+    /**
+     * Whether to use TLS for this socket connection.
+     * When `true`, TLS-specific options from {@link TlsSocketOptions} are expected;
+     * when `false` or omitted, {@link NetSocketOptions} are used.
+     */
+    tls?: boolean;
+}
+export type SocketOptions = SocketCommonOptions & (NetSocketOptions | TlsSocketOptions);

package/dist/src/types/socket-options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/tls-socket-options.d.ts

@@ -0,0 +1,4 @@
+import type * as tls from 'tls';
+export interface TlsSocketOptions extends tls.ConnectionOptions {
+    tls: true;
+}

package/dist/src/types/tls-socket-options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/typed-redis-client-options.d.ts

@@ -0,0 +1,9 @@
+import type { RedisClientOptions, RedisFunctions, RedisScripts } from 'redis';
+import type { RedisClusterOptions } from '@redis/client';
+import type commands from '../commands';
+export type TypedRedisClientOptions = RedisClientOptions<{
+    falkordb: typeof commands;
+}, RedisFunctions, RedisScripts, 2>;
+export type TypedRedisClusterClientOptions = RedisClusterOptions<{
+    falkordb: typeof commands;
+}, RedisFunctions, RedisScripts, 2>;

package/dist/src/types/typed-redis-client-options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/types/udf-list.d.ts

@@ -0,0 +1,2 @@
+export type UdfLibraryEntry = [string, string[]] | [string, string[], string];
+export type UdfListReply = UdfLibraryEntry[];

package/dist/src/types/udf-list.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "falkordb",
-  "version": "6.7.0",
+  "version": "6.9.0",
   "description": "A FalkorDB javascript library",
   "license": "MIT",
   "main": "./dist/index.js",
@@ -39,22 +39,23 @@
     "@tsconfig/node20": "^20.1.4",
     "@types/jest": "^30.0.0",
     "@types/lodash": "^4.17.13",
-    "@types/node": "^25.0.2",
-    "@typescript-eslint/eslint-plugin": "^8.18.2",
-    "@typescript-eslint/parser": "^8.18.2",
+    "@types/node": "^26.2.0",
+    "@typescript-eslint/eslint-plugin": "^8.70.0",
+    "@typescript-eslint/parser": "^8.70.0",
+    "@typescript/native": "npm:typescript@^7.0.2",
     "eslint": "^10.0.1",
     "gh-pages": "^6.2.0",
     "jest": "^30.2.0",
-    "release-it": "^19.0.3",
+    "release-it": "^21.0.2",
     "ts-jest": "^29.4.6",
-    "typescript": "^5.9.3"
+    "typescript": "npm:@typescript/typescript6@^6.0.2"
   },
   "dependencies": {
     "@js-temporal/polyfill": "^0.5.1",
-    "@redis/client": "^5.10.0",
+    "@redis/client": "^6.2.1",
     "cluster-key-slot": "1.1.2",
     "generic-pool": "^3.9.0",
     "lodash": "^4.17.21",
-    "redis": "^5.10.0"
+    "redis": "^6.2.0"
   }
 }