@holochain/client 0.3.0

package/lib/websocket/client.js

@@ -0,0 +1,129 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WsClient = void 0;
+const isomorphic_ws_1 = __importDefault(require("isomorphic-ws"));
+const msgpack_1 = require("@msgpack/msgpack");
+/**
+ * A Websocket client which can make requests and receive responses,
+ * as well as send and receive signals
+ *
+ * Uses Holochain's websocket WireMessage for communication.
+ */
+class WsClient {
+    constructor(socket, signalCb) {
+        this.socket = socket;
+        this.pendingRequests = {};
+        this.index = 0;
+        // TODO: allow adding signal handlers later
+        this.alreadyWarnedNoSignalCb = false;
+        socket.onmessage = async (encodedMsg) => {
+            let data = encodedMsg.data;
+            // If data is not a buffer (nodejs), it will be a blob (browser)
+            if (typeof Buffer === "undefined" || !Buffer.isBuffer(data)) {
+                data = await data.arrayBuffer();
+            }
+            const msg = (0, msgpack_1.decode)(data);
+            if (msg.type === "Signal") {
+                if (signalCb) {
+                    const decodedMessage = (0, msgpack_1.decode)(msg.data);
+                    if (!decodedMessage.App) {
+                        // We have received a system signal, do nothing
+                        return;
+                    }
+                    // Note: holochain currently returns signals as an array of two values: cellId and the serialized signal payload
+                    // and this array is nested within the App key within the returned message.
+                    const decodedCellId = decodedMessage.App[0];
+                    // Note:In order to return readible content to the UI, the signal payload must also be decoded.
+                    const decodedPayload = signalTransform(decodedMessage.App[1]);
+                    // Return a uniform format to UI (ie: { type, data } - the same format as with callZome and appInfo...)
+                    const signal = {
+                        type: msg.type,
+                        data: { cellId: decodedCellId, payload: decodedPayload },
+                    };
+                    signalCb(signal);
+                }
+                else {
+                    if (!this.alreadyWarnedNoSignalCb)
+                        console.log('Received signal but no signal callback was set in constructor');
+                    this.alreadyWarnedNoSignalCb = true;
+                }
+            }
+            else if (msg.type === 'Response') {
+                this.handleResponse(msg);
+            }
+            else {
+                console.error(`Got unrecognized Websocket message type: ${msg.type}`);
+            }
+        };
+    }
+    emitSignal(data) {
+        const encodedMsg = (0, msgpack_1.encode)({
+            type: 'Signal',
+            data: (0, msgpack_1.encode)(data),
+        });
+        this.socket.send(encodedMsg);
+    }
+    request(data) {
+        const id = this.index;
+        this.index += 1;
+        const encodedMsg = (0, msgpack_1.encode)({
+            id,
+            type: 'Request',
+            data: (0, msgpack_1.encode)(data),
+        });
+        const promise = new Promise((fulfill, reject) => {
+            this.pendingRequests[id] = { fulfill, reject };
+        });
+        if (this.socket.readyState === this.socket.OPEN) {
+            this.socket.send(encodedMsg);
+        }
+        else {
+            return Promise.reject(new Error('Socket is not open'));
+        }
+        return promise;
+    }
+    handleResponse(msg) {
+        const id = msg.id;
+        if (this.pendingRequests[id]) {
+            // resolve response
+            if (msg.data === null || msg.data === undefined) {
+                this.pendingRequests[id].reject(new Error('Response canceled by responder'));
+            }
+            else {
+                this.pendingRequests[id].fulfill((0, msgpack_1.decode)(msg.data));
+            }
+        }
+        else {
+            console.error(`Got response with no matching request. id=${id}`);
+        }
+    }
+    close() {
+        this.socket.close();
+        return this.awaitClose();
+    }
+    awaitClose() {
+        return new Promise((resolve) => this.socket.on('close', resolve));
+    }
+    static connect(url, signalCb) {
+        return new Promise((resolve, reject) => {
+            const socket = new isomorphic_ws_1.default(url);
+            // make sure that there are no uncaught connection
+            // errors because that causes nodejs thread to crash
+            // with uncaught exception
+            socket.onerror = () => {
+                reject(new Error(`could not connect to holochain conductor, please check that a conductor service is running and available at ${url}`));
+            };
+            socket.onopen = () => {
+                resolve(new WsClient(socket, signalCb));
+            };
+        });
+    }
+}
+exports.WsClient = WsClient;
+const signalTransform = (res) => {
+    return (0, msgpack_1.decode)(res);
+};
+//# sourceMappingURL=client.js.map

package/lib/websocket/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/websocket/client.ts"],"names":[],"mappings":";;;;;;AAAA,kEAAqC;AACrC,8CAAiD;AAGjD;;;;;GAKG;AACH,MAAa,QAAQ;IAMnB,YAAY,MAAW,EAAE,QAAsB;QAC7C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,eAAe,GAAG,EAAE,CAAA;QACzB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAA;QACd,2CAA2C;QAC3C,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAA;QACpC,MAAM,CAAC,SAAS,GAAG,KAAK,EAAE,UAAe,EAAE,EAAE;YAC3C,IAAI,IAAI,GAAG,UAAU,CAAC,IAAI,CAAA;YAE1B,gEAAgE;YAChE,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;gBAC3D,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;aAChC;YAED,MAAM,GAAG,GAAQ,IAAA,gBAAM,EAAC,IAAI,CAAC,CAAA;YAC7B,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE;gBACzB,IAAI,QAAQ,EAAE;oBACZ,MAAM,cAAc,GAA+B,IAAA,gBAAM,EACvD,GAAG,CAAC,IAAI,CACT,CAAA;oBAED,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE;wBACvB,+CAA+C;wBAC/C,OAAM;qBACP;oBAED,gHAAgH;oBAChH,2EAA2E;oBAC3E,MAAM,aAAa,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;oBAC3C,+FAA+F;oBAC/F,MAAM,cAAc,GAAG,eAAe,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;oBAE7D,uGAAuG;oBACvG,MAAM,MAAM,GAAc;wBACxB,IAAI,EAAE,GAAG,CAAC,IAAI;wBACd,IAAI,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,cAAc,EAAE;qBACzD,CAAA;oBACD,QAAQ,CAAC,MAAM,CAAC,CAAA;iBACjB;qBAAM;oBACL,IAAI,CAAC,IAAI,CAAC,uBAAuB;wBAC/B,OAAO,CAAC,GAAG,CACT,+DAA+D,CAChE,CAAA;oBACH,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAA;iBACpC;aACF;iBAAM,IAAI,GAAG,CAAC,IAAI,KAAK,UAAU,EAAE;gBAClC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAA;aACzB;iBAAM;gBACL,OAAO,CAAC,KAAK,CAAC,4CAA4C,GAAG,CAAC,IAAI,EAAE,CAAC,CAAA;aACtE;QACH,CAAC,CAAA;IACH,CAAC;IAED,UAAU,CAAC,IAAS;QAClB,MAAM,UAAU,GAAG,IAAA,gBAAM,EAAC;YACxB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,IAAA,gBAAM,EAAC,IAAI,CAAC;SACnB,CAAC,CAAA;QACF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IAC9B,CAAC;IAED,OAAO,CAAW,IAAS;QACzB,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAA;QACrB,IAAI,CAAC,KAAK,IAAI,CAAC,CAAA;QACf,MAAM,UAAU,GAAG,IAAA,gBAAM,EAAC;YACxB,EAAE;YACF,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,IAAA,gBAAM,EAAC,IAAI,CAAC;SACnB,CAAC,CAAA;QACF,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC9C,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,CAAA;QAChD,CAAC,CAAC,CAAA;QACF,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YAC/C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;SAC7B;aAAM;YACL,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAA;SACvD;QACD,OAAO,OAAuB,CAAA;IAChC,CAAC;IAED,cAAc,CAAC,GAAQ;QACrB,MAAM,EAAE,GAAG,GAAG,CAAC,EAAE,CAAA;QACjB,IAAI,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,EAAE;YAC5B,mBAAmB;YACnB,IAAI,GAAG,CAAC,IAAI,KAAK,IAAI,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE;gBAC/C,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,MAAM,CAC7B,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAC5C,CAAA;aACF;iBAAM;gBACL,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,IAAA,gBAAM,EAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;aACnD;SACF;aAAM;YACL,OAAO,CAAC,KAAK,CAAC,6CAA6C,EAAE,EAAE,CAAC,CAAA;SACjE;IACH,CAAC;IAED,KAAK;QACH,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;QACnB,OAAO,IAAI,CAAC,UAAU,EAAE,CAAA;IAC1B,CAAC;IAED,UAAU;QACR,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAA;IACnE,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,GAAW,EAAE,QAAsB;QAChD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,MAAM,GAAG,IAAI,uBAAS,CAAC,GAAG,CAAC,CAAA;YACjC,kDAAkD;YAClD,oDAAoD;YACpD,0BAA0B;YAC1B,MAAM,CAAC,OAAO,GAAG,GAAG,EAAE;gBACpB,MAAM,CACJ,IAAI,KAAK,CACP,+GAA+G,GAAG,EAAE,CACrH,CACF,CAAA;YACH,CAAC,CAAA;YACD,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE;gBACnB,OAAO,CAAC,IAAI,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAA;YACzC,CAAC,CAAA;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;CACF;AAjID,4BAiIC;AAED,MAAM,eAAe,GAAG,CACtB,GAAkC,EACN,EAAE;IAC9B,OAAO,IAAA,gBAAM,EAAC,GAAG,CAAC,CAAA;AACpB,CAAC,CAAA"}

package/lib/websocket/common.d.ts

@@ -0,0 +1,3 @@
+export declare const DEFAULT_TIMEOUT = 15000;
+export declare const catchError: (res: any) => Promise<any>;
+export declare const promiseTimeout: (promise: Promise<any>, tag: string, ms: number) => Promise<unknown>;

package/lib/websocket/common.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promiseTimeout = exports.catchError = exports.DEFAULT_TIMEOUT = void 0;
+const ERROR_TYPE = 'error';
+exports.DEFAULT_TIMEOUT = 15000;
+const catchError = (res) => {
+    return res.type === ERROR_TYPE
+        ? Promise.reject(res)
+        : Promise.resolve(res);
+};
+exports.catchError = catchError;
+const promiseTimeout = (promise, tag, ms) => {
+    let id;
+    const timeout = new Promise((_, reject) => {
+        id = setTimeout(() => {
+            clearTimeout(id);
+            reject(new Error(`Timed out in ${ms}ms: ${tag}`));
+        }, ms);
+    });
+    return new Promise((res, rej) => {
+        Promise.race([
+            promise,
+            timeout
+        ]).then((a) => {
+            clearTimeout(id);
+            return res(a);
+        })
+            .catch(e => {
+            return rej(e);
+        });
+    });
+};
+exports.promiseTimeout = promiseTimeout;
+//# sourceMappingURL=common.js.map

package/lib/websocket/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/websocket/common.ts"],"names":[],"mappings":";;;AAAA,MAAM,UAAU,GAAG,OAAO,CAAA;AACb,QAAA,eAAe,GAAG,KAAK,CAAA;AAE7B,MAAM,UAAU,GAAG,CAAC,GAAQ,EAAE,EAAE;IACrC,OAAO,GAAG,CAAC,IAAI,KAAK,UAAU;QAC5B,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC;QACrB,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;AAC1B,CAAC,CAAA;AAJY,QAAA,UAAU,cAItB;AAEM,MAAM,cAAc,GAAG,CAAC,OAAqB,EAAE,GAAW,EAAE,EAAU,EAAE,EAAE;IAC/E,IAAI,EAAkB,CAAA;IAEtB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;QACxC,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE;YACnB,YAAY,CAAC,EAAE,CAAC,CAAA;YAChB,MAAM,CAAC,IAAI,KAAK,CAAC,gBAAgB,EAAE,OAAO,GAAG,EAAE,CAAC,CAAC,CAAA;QACnD,CAAC,EAAE,EAAE,CAAC,CAAA;IACR,CAAC,CAAC,CAAA;IAEF,OAAO,IAAI,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAC9B,OAAO,CAAC,IAAI,CAAC;YACX,OAAO;YACP,OAAO;SACR,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE;YACZ,YAAY,CAAC,EAAE,CAAC,CAAA;YAChB,OAAO,GAAG,CAAC,CAAC,CAAC,CAAA;QACf,CAAC,CAAC;aACC,KAAK,CAAC,CAAC,CAAC,EAAE;YACT,OAAO,GAAG,CAAC,CAAC,CAAC,CAAA;QACf,CAAC,CAAC,CAAA;IACN,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAtBY,QAAA,cAAc,kBAsB1B"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@holochain/client",
+  "version": "0.3.0",
+  "description": "A Nodejs client for the Holochain conductor API",
+  "author": "Holochain Foundation <info@holochain.org> (http://holochain.org)",
+  "license": "CAL 1.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/holochain/holochain-client-js.git"
+  },
+  "keywords": [
+    "holochain",
+    "client",
+    "conductor api"
+  ],
+  "bugs": {
+    "url": "https://github.com/holochain/holochain-client-js/issues"
+  },
+  "homepage": "https://github.com/holochain/holochain-client-js#readme",
+
+  "files": [
+    "lib"
+  ],
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+
+  "scripts": {
+    "lint": "eslint src/**/*.ts test/**/*.ts --fix",
+    "test": "RUST_LOG=error RUST_BACKTRACE=1 ts-node test",
+    "build": "tsc -b"
+  },
+
+  "dependencies": {
+    "@msgpack/msgpack": "^2.7.1",
+    "cross-fetch": "^3.1.4",
+    "isomorphic-ws": "^4.0.1"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^3.12.7",
+    "@types/tape": "^4.13.2",
+    "@typescript-eslint/eslint-plugin": "^5.9.0",
+    "@typescript-eslint/parser": "^5.9.0",
+    "eslint": "^8.6.0",
+    "js-yaml": "^3.14.1",
+    "tape": "^5.4.0",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.5.4"
+  }
+}