@ultipa-graph/ultipa-driver 5.0.0-s5.0

package/dist/utils/uql.parse.js

@@ -0,0 +1,206 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EasyUqlParse = exports.EasyUqlItem = void 0;
+const uql_maker_1 = require("./uql-maker");
+let { CommandList } = uql_maker_1.UQLMAKER;
+const WriteCommands = [
+    "alter",
+    "create",
+    "drop",
+    "grant",
+    "revoke",
+    "LTE",
+    "UFE",
+    "truncate",
+    "compact",
+    "insert",
+    "upsert",
+    "update",
+    "delete",
+    "clear",
+    "stop",
+    "pause",
+    "resume",
+    "top",
+    "kill",
+    CommandList.unmount,
+    CommandList.mount,
+];
+const GLOBALCommands = [
+    CommandList.showUser,
+    CommandList.getUser,
+    CommandList.createUser,
+    CommandList.alterUser,
+    CommandList.dropUser,
+    CommandList.grantUser,
+    CommandList.revokeUser,
+    CommandList.showPolicy,
+    CommandList.getPolicy,
+    CommandList.createPolicy,
+    CommandList.alterPolicy,
+    CommandList.dropPolicy,
+    CommandList.showPrivilege,
+    CommandList.stats,
+    CommandList.showGraph,
+    CommandList.getGraph,
+    CommandList.createGraph,
+    CommandList.dropGraph,
+    CommandList.updateGraph,
+    CommandList.top,
+    CommandList.kill,
+    // CommandList.unmount,
+    // CommandList.mount,
+];
+const ExtraCommands = [
+    CommandList.top,
+    CommandList.kill,
+    CommandList.showTask,
+    CommandList.stopTask,
+    CommandList.clearTask,
+    CommandList.stats,
+    CommandList.showGraph,
+    CommandList.listAlgo,
+    CommandList.getGraph,
+    CommandList.createPolicy,
+    CommandList.alterPolicy,
+    CommandList.showPolicy,
+    CommandList.getPolicy,
+    CommandList.grantUser,
+    CommandList.revokeUser,
+    CommandList.showPrivilege,
+    CommandList.getUser,
+    CommandList.getSelfInfo,
+    CommandList.createUser,
+    CommandList.alterUser,
+    CommandList.dropUser,
+    CommandList.showIndex,
+];
+class EasyUqlItem {
+    constructor(name, params) {
+        this.name = name;
+        this.params = params;
+    }
+    getListParams() {
+        let ps = [];
+        let str = this.params.trim();
+        if (str === "") {
+            return ps;
+        }
+        if (!str.startsWith("}")) {
+            let ss = str.split(",");
+            ss.forEach((p) => {
+                ps.push(p.replace(/^[ |"|']+/g, "").replace(/[ |"|']+$/g, ""));
+            });
+        }
+        else {
+            ps.push(str);
+        }
+        return ps;
+    }
+    safelyGetFirstParams() {
+        let ps = this.getListParams();
+        if (ps.length > 0) {
+            return ps[0];
+        }
+        return "";
+    }
+    isEmptyParams() {
+        return this.params.trim() === "";
+    }
+}
+exports.EasyUqlItem = EasyUqlItem;
+class EasyUqlParse {
+    constructor(uql) {
+        this.uql = uql;
+        this.commands = [];
+        this.parse(this.uql);
+    }
+    parse(uqlStr) {
+        var _a;
+        if (!uqlStr) {
+            return;
+        }
+        let commandReg = /([a-z_A-Z]*)\(([^\(|^\)]*)\)/g;
+        let matchAll = uqlStr.matchAll(commandReg);
+        for (const m of matchAll) {
+            // console.log(m)
+            let name = m[1];
+            let value = m[2] || "";
+            value = value.trim();
+            this.commands.push(new EasyUqlItem(name, value));
+        }
+        let limits = uqlStr.split("limit ");
+        this.limit = (_a = limits === null || limits === void 0 ? void 0 : limits[1]) === null || _a === void 0 ? void 0 : _a.trim();
+    }
+    commandsEqual(commands) {
+        var parseCommands = [];
+        commands.forEach((_, i) => {
+            let name = "";
+            let c = this.getCommand(i);
+            if (c) {
+                name = c.name;
+            }
+            parseCommands.push(name);
+        });
+        return commands.join("|") == parseCommands.join("|");
+    }
+    getCommand(index) {
+        if (this.commands.length > index) {
+            return this.commands[index];
+        }
+        return null;
+    }
+    getLimit() {
+        var _a, _b;
+        let limit = this.limit || ((_b = (_a = this.getCommandFirstOneWithName("limit")) === null || _a === void 0 ? void 0 : _a.getListParams()) === null || _b === void 0 ? void 0 : _b[0]);
+        return limit;
+    }
+    getCommandFirstOneWithName(name) {
+        for (let index = 0; index < this.commands.length; index++) {
+            const element = this.commands[index];
+            if (element.name == name) {
+                return element;
+            }
+        }
+        return null;
+    }
+    firstCommandName() {
+        var _a;
+        return (_a = this.getCommand(0)) === null || _a === void 0 ? void 0 : _a.name;
+    }
+    secondCommandName() {
+        var _a;
+        return (_a = this.getCommand(1)) === null || _a === void 0 ? void 0 : _a.name;
+    }
+    hasWith() {
+        var _a;
+        return ((_a = this.uql) === null || _a === void 0 ? void 0 : _a.toLowerCase().split("with").length) > 1;
+    }
+    hasWrite() {
+        for (const c of this.commands) {
+            if (WriteCommands.includes(c.name)) {
+                return true;
+            }
+        }
+        return false;
+    }
+    hasAlgo() {
+        return this.firstCommandName() == "algo";
+    }
+    hasExecTask() {
+        var _a;
+        return (_a = this.uql) === null || _a === void 0 ? void 0 : _a.toLowerCase().includes("exec task");
+    }
+    isGlobal() {
+        let c1 = this.firstCommandName();
+        let c2 = `${this.firstCommandName()}().${this.secondCommandName()}`;
+        return GLOBALCommands.includes(c1) || GLOBALCommands.includes(c2);
+    }
+    isExtra() {
+        let c1 = this.firstCommandName();
+        let c2 = `${this.firstCommandName()}().${this.secondCommandName()}`;
+        return ExtraCommands.includes(c1) || ExtraCommands.includes(c2);
+    }
+}
+exports.EasyUqlParse = EasyUqlParse;
+//# sourceMappingURL=uql.parse.js.map

package/dist/utils/uql.parse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uql.parse.js","sourceRoot":"","sources":["../../src/utils/uql.parse.ts"],"names":[],"mappings":";;;AAAA,2CAAuC;AACvC,IAAI,EAAE,WAAW,EAAE,GAAG,oBAAQ,CAAC;AAE/B,MAAM,aAAa,GAAG;IACpB,OAAO;IACP,QAAQ;IACR,MAAM;IACN,OAAO;IACP,QAAQ;IACR,KAAK;IACL,KAAK;IACL,UAAU;IACV,SAAS;IACT,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,OAAO;IACP,MAAM;IACN,OAAO;IACP,QAAQ;IACR,KAAK;IACL,MAAM;IACN,WAAW,CAAC,OAAO;IACnB,WAAW,CAAC,KAAK;CAClB,CAAC;AACF,MAAM,cAAc,GAAG;IACrB,WAAW,CAAC,QAAQ;IACpB,WAAW,CAAC,OAAO;IACnB,WAAW,CAAC,UAAU;IACtB,WAAW,CAAC,SAAS;IACrB,WAAW,CAAC,QAAQ;IACpB,WAAW,CAAC,SAAS;IACrB,WAAW,CAAC,UAAU;IACtB,WAAW,CAAC,UAAU;IACtB,WAAW,CAAC,SAAS;IACrB,WAAW,CAAC,YAAY;IACxB,WAAW,CAAC,WAAW;IACvB,WAAW,CAAC,UAAU;IACtB,WAAW,CAAC,aAAa;IACzB,WAAW,CAAC,KAAK;IACjB,WAAW,CAAC,SAAS;IACrB,WAAW,CAAC,QAAQ;IACpB,WAAW,CAAC,WAAW;IACvB,WAAW,CAAC,SAAS;IACrB,WAAW,CAAC,WAAW;IACvB,WAAW,CAAC,GAAG;IACf,WAAW,CAAC,IAAI;IAChB,uBAAuB;IACvB,qBAAqB;CACtB,CAAC;AACF,MAAM,aAAa,GAAG;IACpB,WAAW,CAAC,GAAG;IACf,WAAW,CAAC,IAAI;IAChB,WAAW,CAAC,QAAQ;IACpB,WAAW,CAAC,QAAQ;IACpB,WAAW,CAAC,SAAS;IACrB,WAAW,CAAC,KAAK;IACjB,WAAW,CAAC,SAAS;IACrB,WAAW,CAAC,QAAQ;IACpB,WAAW,CAAC,QAAQ;IACpB,WAAW,CAAC,YAAY;IACxB,WAAW,CAAC,WAAW;IACvB,WAAW,CAAC,UAAU;IACtB,WAAW,CAAC,SAAS;IACrB,WAAW,CAAC,SAAS;IACrB,WAAW,CAAC,UAAU;IACtB,WAAW,CAAC,aAAa;IACzB,WAAW,CAAC,OAAO;IACnB,WAAW,CAAC,WAAW;IACvB,WAAW,CAAC,UAAU;IACtB,WAAW,CAAC,SAAS;IACrB,WAAW,CAAC,QAAQ;IACpB,WAAW,CAAC,SAAS;CACtB,CAAC;AAEF,MAAa,WAAW;IAGtB,YAAY,IAAY,EAAE,MAAc;QACtC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IACD,aAAa;QACX,IAAI,EAAE,GAAG,EAAE,CAAC;QACZ,IAAI,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAC7B,IAAI,GAAG,KAAK,EAAE,EAAE;YACd,OAAO,EAAE,CAAC;SACX;QACD,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;YACxB,IAAI,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACxB,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;gBACf,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,CAAC;YACjE,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SACd;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,oBAAoB;QAClB,IAAI,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,CAAA;QAC7B,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE;YACjB,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;SACb;QACD,OAAO,EAAE,CAAA;IACX,CAAC;IACD,aAAa;QACX,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;IACnC,CAAC;CACF;AAjCD,kCAiCC;AACD,MAAa,YAAY;IAKvB,YAAY,GAAW;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QAEnB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IACD,KAAK,CAAC,MAAM;;QACV,IAAI,CAAC,MAAM,EAAE;YACX,OAAO;SACR;QACD,IAAI,UAAU,GAAG,+BAA+B,CAAC;QACjD,IAAI,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC3C,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE;YACxB,iBAAiB;YACjB,IAAI,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YAChB,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YACvB,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;YACrB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;SAClD;QACD,IAAI,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;QACnC,IAAI,CAAC,KAAK,GAAG,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAG,CAAC,CAAC,0CAAE,IAAI,EAAE,CAAA;IAClC,CAAC;IACD,aAAa,CAAC,QAAkB;QAC9B,IAAI,aAAa,GAAa,EAAE,CAAA;QAChC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YACxB,IAAI,IAAI,GAAG,EAAE,CAAA;YACb,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;YAC1B,IAAI,CAAC,EAAE;gBACL,IAAI,GAAG,CAAC,CAAC,IAAI,CAAA;aACd;YACD,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC1B,CAAC,CAAC,CAAA;QACF,OAAO,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACtD,CAAC;IACD,UAAU,CAAC,KAAa;QACtB,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,KAAK,EAAE;YAChC,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;SAC7B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,QAAQ;;QACN,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,KAAI,MAAA,MAAA,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,0CAAE,aAAa,EAAE,0CAAG,CAAC,CAAC,CAAA,CAAA;QACxF,OAAO,KAAK,CAAA;IACd,CAAC;IACD,0BAA0B,CAAC,IAAY;QACrC,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YACzD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACrC,IAAI,OAAO,CAAC,IAAI,IAAI,IAAI,EAAE;gBACxB,OAAO,OAAO,CAAA;aACf;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACD,gBAAgB;;QACd,OAAO,MAAA,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,0CAAE,IAAI,CAAC;IAClC,CAAC;IACD,iBAAiB;;QACf,OAAO,MAAA,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,0CAAE,IAAI,CAAC;IAClC,CAAC;IACD,OAAO;;QACL,OAAO,CAAA,MAAA,IAAI,CAAC,GAAG,0CAAE,WAAW,GAAG,KAAK,CAAC,MAAM,EAAE,MAAM,IAAG,CAAC,CAAC;IAC1D,CAAC;IACD,QAAQ;QACN,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE;YAC7B,IAAI,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE;gBAClC,OAAO,IAAI,CAAC;aACb;SACF;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO;QACL,OAAO,IAAI,CAAC,gBAAgB,EAAE,IAAI,MAAM,CAAC;IAC3C,CAAC;IACD,WAAW;;QACT,OAAO,MAAA,IAAI,CAAC,GAAG,0CAAE,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAA;IACtD,CAAC;IACD,QAAQ;QACN,IAAI,EAAE,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACjC,IAAI,EAAE,GAAG,GAAG,IAAI,CAAC,gBAAgB,EAAE,MAAM,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;QACpE,OAAO,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IACpE,CAAC;IACD,OAAO;QACL,IAAI,EAAE,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACjC,IAAI,EAAE,GAAG,GAAG,IAAI,CAAC,gBAAgB,EAAE,MAAM,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;QACpE,OAAO,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AA3FD,oCA2FC"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@ultipa-graph/ultipa-driver",
+  "version": "5.0.0-s5.0",
+  "description": "NodeJS SDK for ultipa-server 5.0",
+  "keywords": [
+    "ultipa",
+    "graph database",
+    "UQL",
+    "GQL",
+    "SDK",
+    "driver"
+  ],
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "sh bin/tsc.sh",
+    "build_doc": "typedoc",
+    "node_version": "bash bin/node_version.sh",
+    "publish_online": "bash bin/publish.sh",
+    "test": "mocha -r ts-node/register -t 10000000 --exit",
+    "test_autotest": "mocha -r ts-node/register --t 600000 'test/autotest/**/*.@(js|ts)'",
+    "test_autotest_with_report": "npm test -- --reporter mochawesome; open ./mochawesome-report/mochawesome.html",
+    "proto": "sh src/proto/build.sh",
+    "proto_windows": "sh src/proto/build_windows.sh"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@repo.ultipa.com:SDKS/ultipa-node-sdk.git"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "author": "jiansong ZHANG",
+  "license": "ISC",
+  "dependencies": {
+    "@grpc/grpc-js": "1.10.1",
+    "bluebird": "^3.7.2",
+    "chalk": "^3.0.0",
+    "fs-extra": "^9.1.0",
+    "grpc-tools": "1.11.3",
+    "lodash": "^4.17.15",
+    "md5": "^2.3.0",
+    "moment-timezone": "^0.5.33",
+    "print-tree": "^0.1.5",
+    "ts-protoc-gen": "^0.15.0",
+    "typescript": "^4.8.4"
+  },
+  "devDependencies": {
+    "@types/bluebird": "^3.5.30",
+    "@types/chai": "^4.2.9",
+    "@types/fs-extra": "^9.0.13",
+    "@types/lodash": "^4.14.150",
+    "@types/mocha": "^10.0.7",
+    "@types/moment-timezone": "^0.5.30",
+    "@types/node": "^13.13.2",
+    "chai": "^4.2.0",
+    "grpc_tools_node_protoc_ts": "^5.3.2",
+    "mocha": "^7.2.0",
+    "mochawesome": "^6.1.1",
+    "nyc": "^15.0.0",
+    "ts-node": "^8.6.2"
+  }
+}

package/readme.md

@@ -0,0 +1,63 @@
+# Ultipa NodeJS SDK
+
+## Introduction
+
+This Nodejs SDK is a part of Ultipa Drivers, a set of specifications for developing software and applications using Java, Python, Go and NodeJs. This SDK provides instructions on introducing query and management operations of Ultipa Graph Database into Nodejs programs, both by calling command through interfaces and sending assembled UQLs to an Ultipa server. A basic understanding of UQL query commands and the returned data structures is needed to guarantee a proper usage of the SDK.
+
+## Installation
+
+```bash
+npm install @ultipa-graph/ultipa-driver
+```
+
+## Document
+
+Please refer to https://www.ultipa.com/document/ultipa-drivers/nodejs-installation/v5.0 for details.
+
+If you have any questions please contact: [Ultipa Support](mailto:support@ultipa.com)
+
+## Usage
+
+### ConnectionPool
+
+`ConnectionPool` defines the information of connection pool needed when connecting to an Ultipa graph database.
+
+```ts
+import { ConnectionPool } from "@ultipa-graph/ultipa-driver";
+
+let sdkUsage = async () => {
+
+  let hosts = [
+    "192.168.1.1:60061", 
+    "192.168.1.2:60061", 
+    "192.168.1.3:60061"
+  ];
+  let username = "***";
+  let password = "***";
+  
+  let connPool = new ConnectionPool(hosts, username, password);
+  
+  let conn = await connPool.getActive();
+  let isSuccess = await conn.test();
+  console.log(isSuccess);
+  
+};
+
+sdkUsage().then(console.log).catch(console.log);
+
+```
+### Send UQL
+
+```ts
+import { ConnectionPool } from "@ultipa-graph/ultipa-driver";
+
+let sdkUsage = async () => {
+
+  // omit code of establishing server connection 'conn'
+  
+  let resp = await conn.uql("show().graph()");
+  console.log(resp);
+};
+
+sdkUsage();
+```