falkordb 6.4.0 → 6.5.0

package/README.md

@@ -69,6 +69,11 @@ Forcibly close a client's connection to FalkorDB immediately. Calling `close` wi
 ```typescript
 await client.close();
 ```
+
+## Contributing
+
+For information on how to release a new version to npm, see [RELEASE.md](RELEASE.md).
+
 ## License
 
 This repository is licensed under the "MIT" license. See [LICENSE](LICENSE).

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export { default as Graph } from './src/graph';
 export { ConstraintType, EntityType } from './src/graph';
-export { default as FalkorDB } from './src/falkordb';
+export { default as FalkorDB, FalkorDBOptions } from './src/falkordb';

package/dist/src/clients/client.d.ts

@@ -4,6 +4,7 @@ import { ConstraintType, EntityType } from "../graph";
 import FalkorDB from "../falkordb";
 import { SingleGraphConnection } from "./single";
 import { MemoryUsageOptions, MemoryUsageReply } from "../commands/MEMORY_USAGE";
+import { UdfListReply } from "../commands/UDF_LIST";
 export interface Client {
     init(falkordb: FalkorDB): Promise<void>;
     list(): Promise<Array<string>>;
@@ -25,6 +26,10 @@ export interface Client {
     }[]>;
     constraintCreate(graph: string, constraintType: ConstraintType, entityType: EntityType, label: string, ...properties: string[]): Promise<void>;
     constraintDrop(graph: string, constraintType: ConstraintType, entityType: EntityType, label: string, ...properties: string[]): Promise<void>;
+    udfLoad(name: string, script: string | Function, replace?: boolean): Promise<string>;
+    udfList(lib?: string, withCode?: boolean): Promise<UdfListReply>;
+    udfFlush(): Promise<string>;
+    udfDelete(lib: string): Promise<string>;
     /**
      * @deprecated Use `disconnect` instead
      */

package/dist/src/clients/cluster.d.ts

@@ -6,6 +6,7 @@ import { RedisClusterType } from "@redis/client";
 import FalkorDB from "../falkordb";
 import { SingleGraphConnection } from "./single";
 import { MemoryUsageOptions, MemoryUsageReply } from "../commands/MEMORY_USAGE";
+import { UdfListReply } from "../commands/UDF_LIST";
 export type ClusterGraphConnection = RedisClusterType<{
     falkordb: typeof commands;
 }, RedisFunctions, RedisScripts>;
@@ -53,6 +54,10 @@ export declare class Cluster implements Client {
     memoryUsage(graph: string, options?: MemoryUsageOptions): Promise<MemoryUsageReply>;
     constraintCreate(graph: string, constraintType: ConstraintType, entityType: EntityType, label: string, ...properties: string[]): Promise<void>;
     constraintDrop(graph: string, constraintType: ConstraintType, entityType: EntityType, label: string, ...properties: string[]): Promise<void>;
+    udfLoad(name: string, script: string | Function, replace?: boolean): Promise<string>;
+    udfList(lib?: string, withCode?: boolean): Promise<UdfListReply>;
+    udfFlush(): Promise<string>;
+    udfDelete(lib: string): Promise<string>;
     profile<_T>(graph: string, query: string): Promise<string | number | (string | number | (string | number | (string | number | (string | number | (string | number | (string | number | (string | number | (string | number | (string | number | (string | number | (string | number | /*elided*/ any | null | undefined)[] | null | undefined)[] | null | undefined)[] | null | undefined)[] | null | undefined)[] | null | undefined)[] | null | undefined)[] | null | undefined)[] | null | undefined)[] | null | undefined)[] | null | undefined)[] | null | undefined>;
     quit(): Promise<void>;
     disconnect(): Promise<void>;

package/dist/src/clients/cluster.js

@@ -86,6 +86,18 @@ class Cluster {
         const reply = this.#client.falkordb.constraintDrop(graph, constraintType, entityType, label, ...properties);
         return reply.then(() => { });
     }
+    async udfLoad(name, script, replace = false) {
+        return this.#client.falkordb.udfLoad(name, script, replace);
+    }
+    async udfList(lib, withCode = false) {
+        return this.#client.falkordb.udfList(lib, withCode);
+    }
+    async udfFlush() {
+        return this.#client.falkordb.udfFlush();
+    }
+    async udfDelete(lib) {
+        return this.#client.falkordb.udfDelete(lib);
+    }
     async profile(graph, query) {
         return this.#client.falkordb.profile(graph, query);
     }

package/dist/src/clients/nullClient.d.ts

@@ -5,6 +5,7 @@ import { ConstraintType, EntityType } from "../graph";
 import { Client } from "./client";
 import { SingleGraphConnection } from "./single";
 import { MemoryUsageOptions, MemoryUsageReply } from "../commands/MEMORY_USAGE";
+import { UdfListReply } from "../commands/UDF_LIST";
 /**
  * The `NullClient` class is a placeholder implementation of the `Client` interface.
  *
@@ -38,6 +39,10 @@ export declare class NullClient implements Client {
     memoryUsage(_graph: string, _options?: MemoryUsageOptions): Promise<MemoryUsageReply>;
     constraintCreate(_graph: string, _constraintType: ConstraintType, _entityType: EntityType, _label: string, ..._properties: string[]): Promise<void>;
     constraintDrop(_graph: string, _constraintType: ConstraintType, _entityType: EntityType, _label: string, ..._properties: string[]): Promise<void>;
+    udfLoad(_name: string, _script: string | Function, _replace?: boolean): Promise<string>;
+    udfList(_lib?: string, _withCode?: boolean): Promise<UdfListReply>;
+    udfFlush(): Promise<string>;
+    udfDelete(_lib: string): Promise<string>;
     quit(): Promise<void>;
     disconnect(): Promise<void>;
 }

package/dist/src/clients/nullClient.js

@@ -61,6 +61,18 @@ class NullClient {
     constraintDrop(_graph, _constraintType, _entityType, _label, ..._properties) {
         throw new Error("Method not implemented.");
     }
+    udfLoad(_name, _script, _replace) {
+        throw new Error("Method not implemented.");
+    }
+    udfList(_lib, _withCode) {
+        throw new Error("Method not implemented.");
+    }
+    udfFlush() {
+        throw new Error("Method not implemented.");
+    }
+    udfDelete(_lib) {
+        throw new Error("Method not implemented.");
+    }
     quit() {
         throw new Error("Method not implemented.");
     }

package/dist/src/clients/single.d.ts

@@ -5,6 +5,7 @@ import commands, { QueryOptions } from "../commands";
 import { RedisClientType } from "@redis/client";
 import FalkorDB from "../falkordb";
 import { MemoryUsageOptions, MemoryUsageReply } from "../commands/MEMORY_USAGE";
+import { UdfListReply } from "../commands/UDF_LIST";
 export type SingleGraphConnection = RedisClientType<{
     falkordb: typeof commands;
 }, RedisFunctions, RedisScripts>;
@@ -47,6 +48,10 @@ export declare class Single implements Client {
     memoryUsage(graph: string, options?: MemoryUsageOptions): Promise<MemoryUsageReply>;
     constraintCreate(graph: string, constraintType: ConstraintType, entityType: EntityType, label: string, ...properties: string[]): Promise<void>;
     constraintDrop(graph: string, constraintType: ConstraintType, entityType: EntityType, label: string, ...properties: string[]): Promise<void>;
+    udfLoad(name: string, script: string | Function, replace?: boolean): Promise<string>;
+    udfList(lib?: string, withCode?: boolean): Promise<UdfListReply>;
+    udfFlush(): Promise<string>;
+    udfDelete(lib: string): Promise<string>;
     copy<_T>(srcGraph: string, destGraph: string): Promise<"OK">;
     quit(): Promise<void>;
     disconnect(): Promise<void>;

package/dist/src/clients/single.js

@@ -90,6 +90,18 @@ class Single {
         const reply = this.client.falkordb.constraintDrop(graph, constraintType, entityType, label, ...properties);
         return reply.then(() => { });
     }
+    async udfLoad(name, script, replace = false) {
+        return this.client.falkordb.udfLoad(name, script, replace);
+    }
+    async udfList(lib, withCode = false) {
+        return this.client.falkordb.udfList(lib, withCode);
+    }
+    async udfFlush() {
+        return this.client.falkordb.udfFlush();
+    }
+    async udfDelete(lib) {
+        return this.client.falkordb.udfDelete(lib);
+    }
     async copy(srcGraph, destGraph) {
         return this.client.falkordb.copy(srcGraph, destGraph);
     }

package/dist/src/commands/UDF_DELETE.d.ts

@@ -0,0 +1,2 @@
+export declare function transformArguments(lib: string): Array<string>;
+export declare function transformReply(): string;

package/dist/src/commands/UDF_DELETE.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformArguments = transformArguments;
+function transformArguments(lib) {
+    return ['GRAPH.UDF', 'DELETE', lib];
+}

package/dist/src/commands/UDF_FLUSH.d.ts

@@ -0,0 +1,2 @@
+export declare function transformArguments(): Array<string>;
+export declare function transformReply(): string;

package/dist/src/commands/UDF_FLUSH.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformArguments = transformArguments;
+function transformArguments() {
+    return ['GRAPH.UDF', 'FLUSH'];
+}

package/dist/src/commands/UDF_LIST.d.ts

@@ -0,0 +1,5 @@
+export declare const IS_READ_ONLY = true;
+export type UdfLibraryEntry = [string, string[]] | [string, string[], string];
+export type UdfListReply = UdfLibraryEntry[];
+export declare function transformArguments(lib?: string, withCode?: boolean): Array<string>;
+export declare function transformReply(): UdfListReply;

package/dist/src/commands/UDF_LIST.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IS_READ_ONLY = void 0;
+exports.transformArguments = transformArguments;
+exports.IS_READ_ONLY = true;
+function transformArguments(lib, withCode = false) {
+    const args = ['GRAPH.UDF', 'LIST'];
+    if (lib !== undefined) {
+        args.push(lib);
+    }
+    if (withCode) {
+        args.push('WITHCODE');
+    }
+    return args;
+}

package/dist/src/commands/UDF_LOAD.d.ts

@@ -0,0 +1,2 @@
+export declare function transformArguments(name: string, script: string | Function, replace?: boolean): Array<string>;
+export declare function transformReply(): string;

package/dist/src/commands/UDF_LOAD.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformArguments = transformArguments;
+function transformArguments(name, script, replace = false) {
+    const args = ['GRAPH.UDF', 'LOAD'];
+    if (replace) {
+        args.push('REPLACE');
+    }
+    args.push(name);
+    // If script is a function, convert it to string
+    const scriptStr = typeof script === 'function' ? script.toString() : script;
+    args.push(scriptStr);
+    return args;
+}

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

@@ -14,6 +14,10 @@ import * as COPY from './COPY';
 import * as SENTINEL_MASTER from './SENTINEL_MASTER';
 import * as SENTINEL_MASTERS from './SENTINEL_MASTERS';
 import * as MEMORY_USAGE from './MEMORY_USAGE';
+import * as UDF_LOAD from './UDF_LOAD';
+import * as UDF_LIST from './UDF_LIST';
+import * as UDF_FLUSH from './UDF_FLUSH';
+import * as UDF_DELETE from './UDF_DELETE';
 import { RedisCommandArgument, RedisCommandArguments } from '@redis/client/dist/lib/commands';
 declare const _default: {
     CONFIG_GET: typeof CONFIG_GET;
@@ -48,6 +52,14 @@ declare const _default: {
     sentinelMasters: typeof SENTINEL_MASTERS;
     MEMORY_USAGE: typeof MEMORY_USAGE;
     memoryUsage: typeof MEMORY_USAGE;
+    UDF_LOAD: typeof UDF_LOAD;
+    udfLoad: typeof UDF_LOAD;
+    UDF_LIST: typeof UDF_LIST;
+    udfList: typeof UDF_LIST;
+    UDF_FLUSH: typeof UDF_FLUSH;
+    udfFlush: typeof UDF_FLUSH;
+    UDF_DELETE: typeof UDF_DELETE;
+    udfDelete: typeof UDF_DELETE;
 };
 export default _default;
 type QueryParam = null | string | number | boolean | QueryParams | Array<QueryParam>;
@@ -60,3 +72,4 @@ export interface QueryOptions {
 }
 export type QueryOptionsBackwardCompatible = QueryOptions | number;
 export declare function pushQueryArguments(args: RedisCommandArguments, graph: RedisCommandArgument, query: RedisCommandArgument, options?: QueryOptionsBackwardCompatible, compact?: boolean): RedisCommandArguments;
+export { UdfListReply, UdfLibraryEntry } from './UDF_LIST';

package/dist/src/commands/index.js

@@ -17,6 +17,10 @@ const COPY = require("./COPY");
 const SENTINEL_MASTER = require("./SENTINEL_MASTER");
 const SENTINEL_MASTERS = require("./SENTINEL_MASTERS");
 const MEMORY_USAGE = require("./MEMORY_USAGE");
+const UDF_LOAD = require("./UDF_LOAD");
+const UDF_LIST = require("./UDF_LIST");
+const UDF_FLUSH = require("./UDF_FLUSH");
+const UDF_DELETE = require("./UDF_DELETE");
 exports.default = {
     CONFIG_GET,
     configGet: CONFIG_GET,
@@ -50,6 +54,14 @@ exports.default = {
     sentinelMasters: SENTINEL_MASTERS,
     MEMORY_USAGE,
     memoryUsage: MEMORY_USAGE,
+    UDF_LOAD,
+    udfLoad: UDF_LOAD,
+    UDF_LIST,
+    udfList: UDF_LIST,
+    UDF_FLUSH,
+    udfFlush: UDF_FLUSH,
+    UDF_DELETE,
+    udfDelete: UDF_DELETE,
 };
 function pushQueryArguments(args, graph, query, options, compact) {
     args.push(graph);

package/dist/src/falkordb.d.ts

@@ -90,6 +90,10 @@ export default class FalkorDB extends EventEmitter {
     configGet(configKey: string): Promise<(string | number)[] | (string | number)[][]>;
     configSet(configKey: string, value: number | string): Promise<void>;
     info(section?: string): Promise<(string | string[])[]>;
+    udfLoad(name: string, script: string | Function, replace?: boolean): Promise<string>;
+    udfList(lib?: string, withCode?: boolean): Promise<import("./commands").UdfListReply>;
+    udfFlush(): Promise<string>;
+    udfDelete(lib: string): Promise<string>;
     /**
      * Closes the client.
      */

package/dist/src/falkordb.js

@@ -66,6 +66,18 @@ class FalkorDB extends events_1.EventEmitter {
     async info(section) {
         return this.#client.info(section);
     }
+    async udfLoad(name, script, replace = false) {
+        return this.#client.udfLoad(name, script, replace);
+    }
+    async udfList(lib, withCode = false) {
+        return this.#client.udfList(lib, withCode);
+    }
+    async udfFlush() {
+        return this.#client.udfFlush();
+    }
+    async udfDelete(lib) {
+        return this.#client.udfDelete(lib);
+    }
     /**
      * Closes the client.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "falkordb",
-  "version": "6.4.0",
+  "version": "6.5.0",
   "description": "A FalkorDB javascript library",
   "license": "MIT",
   "main": "./dist/index.js",
@@ -23,12 +23,12 @@
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/falkordb/falkordb-ts.git"
+    "url": "https://github.com/FalkorDB/falkordb-ts"
   },
   "bugs": {
-    "url": "https://github.com/falkordb/falkordb-ts/issues"
+    "url": "https://github.com/FalkorDB/falkordb-ts/issues"
   },
-  "homepage": "https://github.com/falkordb/falkordb-ts",
+  "homepage": "https://github.com/FalkorDB/falkordb-ts",
   "keywords": [
     "falkordb"
   ],
@@ -39,7 +39,7 @@
     "@tsconfig/node20": "^20.1.4",
     "@types/jest": "^29.5.14",
     "@types/lodash": "^4.17.13",
-    "@types/node": "^24.0.3",
+    "@types/node": "^25.0.2",
     "@typescript-eslint/eslint-plugin": "^8.18.2",
     "@typescript-eslint/parser": "^8.18.2",
     "eslint": "^9.17.0",