@holochain/client 0.17.0-dev.7 → 0.17.0-dev.8

package/lib/api/admin/types.d.ts

@@ -7,6 +7,11 @@ import { DisableCloneCellRequest } from "../index.js";
  */
 export type AttachAppInterfaceRequest = {
     port?: number;
+    /**
+     * Comma separated list of origins, or `*` to allow any origin.
+     * For example: `http://localhost:3000,http://localhost:3001`
+     */
+    allowed_origins: string;
 };
 /**
  * @public

package/lib/api/admin/websocket.js

@@ -1,7 +1,7 @@
 import { getLauncherEnvironment } from "../../environments/launcher.js";
 import { GrantedFunctionsType, } from "../../hdk/capabilities.js";
 import { WsClient } from "../client.js";
-import { catchError, DEFAULT_TIMEOUT, promiseTimeout, requesterTransformer, } from "../common.js";
+import { catchError, DEFAULT_TIMEOUT, promiseTimeout, requesterTransformer, HolochainError, } from "../common.js";
 import { generateSigningKeyPair, randomCapSecret, setSigningCredentials, } from "../zome-call-signing.js";
 import { AppStatusFilter, } from "./types.js";
 /**
@@ -36,9 +36,9 @@ export class AdminWebsocket {
             options.url = new URL(`ws://127.0.0.1:${env.ADMIN_INTERFACE_PORT}`);
         }
         if (!options.url) {
-            throw new Error("Unable to connect to Admin Websocket: No url provided and not in a Launcher environment.");
+            throw new HolochainError("ConnectionUrlMissing", `unable to connect to Conductor API - no url provided and not in a launcher environment.`);
         }
-        const wsClient = await WsClient.connect(options.url);
+        const wsClient = await WsClient.connect(options.url, options.wsClientOptions);
         return new AdminWebsocket(wsClient, options.defaultTimeout);
     }
     _requester(tag, transformer) {

package/lib/api/app/websocket.js

@@ -5,7 +5,7 @@ import Emittery from "emittery";
 import { getLauncherEnvironment, signZomeCallTauri, signZomeCallElectron, getHostZomeCallSigner, } from "../../environments/launcher.js";
 import { encodeHashToBase64 } from "../../utils/base64.js";
 import { WsClient } from "../client.js";
-import { DEFAULT_TIMEOUT, catchError, promiseTimeout, requesterTransformer, } from "../common.js";
+import { DEFAULT_TIMEOUT, catchError, promiseTimeout, requesterTransformer, HolochainError, } from "../common.js";
 import { getNonceExpiration, getSigningCredentials, randomNonce, } from "../zome-call-signing.js";
 /**
  * A class to establish a websocket connection to an App interface of a
@@ -46,9 +46,9 @@ export class AppWebsocket extends Emittery {
             options.url = new URL(`ws://127.0.0.1:${env.APP_INTERFACE_PORT}`);
         }
         if (!options.url) {
-            throw new Error("Unable to connect to App Websocket: No url provided and not in a Launcher environment.");
+            throw new HolochainError("ConnectionUrlMissing", `unable to connect to Conductor API - no url provided and not in a launcher environment.`);
         }
-        const wsClient = await WsClient.connect(options.url);
+        const wsClient = await WsClient.connect(options.url, options.wsClientOptions);
         const appWebsocket = new AppWebsocket(wsClient, options.defaultTimeout, env?.INSTALLED_APP_ID);
         wsClient.on("signal", (signal) => appWebsocket.emit("signal", signal));
         return appWebsocket;
@@ -134,7 +134,7 @@ const appInfoTransform = (appWs) => ({
 export const signZomeCall = async (request) => {
     const signingCredentialsForCell = getSigningCredentials(request.cell_id);
     if (!signingCredentialsForCell) {
-        throw new Error(`cannot sign zome call: no signing credentials have been authorized for cell [${encodeHashToBase64(request.cell_id[0])}, ${encodeHashToBase64(request.cell_id[1])}]`);
+        throw new HolochainError("NoSigningCredentialsForCell", `no signing credentials have been authorized for cell [${encodeHashToBase64(request.cell_id[0])}, ${encodeHashToBase64(request.cell_id[1])}]`);
     }
     const unsignedZomeCallPayload = {
         cap_secret: signingCredentialsForCell.capSecret,

package/lib/api/app-agent/websocket.js

@@ -81,20 +81,20 @@ export class AppAgentWebsocket {
         if (isCloneId(roleName)) {
             const baseRoleName = getBaseRoleNameFromCloneId(roleName);
             if (!(baseRoleName in appInfo.cell_info)) {
-                throw new Error(`No cell found with role_name ${roleName}`);
+                throw new HolochainError("NoCellForRoleName", `no cell found with role_name ${roleName}`);
             }
             const cloneCell = appInfo.cell_info[baseRoleName].find((c) => CellType.Cloned in c && c[CellType.Cloned].clone_id === roleName);
             if (!cloneCell || !(CellType.Cloned in cloneCell)) {
-                throw new Error(`No clone cell found with clone id ${roleName}`);
+                throw new HolochainError("NoCellForCloneId", `no clone cell found with clone id ${roleName}`);
             }
             return cloneCell[CellType.Cloned].cell_id;
         }
         if (!(roleName in appInfo.cell_info)) {
-            throw new Error(`No cell found with role_name ${roleName}`);
+            throw new HolochainError("NoCellForRoleName", `no cell found with role_name ${roleName}`);
         }
         const cell = appInfo.cell_info[roleName].find((c) => CellType.Provisioned in c);
         if (!cell || !(CellType.Provisioned in cell)) {
-            throw new Error(`No provisioned cell found with role_name ${roleName}`);
+            throw new HolochainError("NoProvisionedCellForRoleName", `no provisioned cell found with role_name ${roleName}`);
         }
         return cell[CellType.Provisioned].cell_id;
     }
@@ -125,7 +125,7 @@ export class AppAgentWebsocket {
         else if ("cell_id" in request && request.cell_id) {
             return this.appWebsocket.callZome(request, timeout);
         }
-        throw new Error("callZome requires a role_name or cell_id arg");
+        throw new HolochainError("MissingRoleNameOrCellId", "callZome requires a role_name or cell_id argument");
     }
     /**
      * Clone an existing provisioned cell.

package/lib/api/client.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="ws" />
 import Emittery from "emittery";
 import IsoWebSocket from "isomorphic-ws";
+import { WsClientOptions } from "./common.js";
 /**
  * A WebSocket client which can make requests and receive responses,
  * as well as send and receive signals.
@@ -12,9 +13,10 @@ import IsoWebSocket from "isomorphic-ws";
 export declare class WsClient extends Emittery {
     socket: IsoWebSocket;
     url: URL | undefined;
+    options: WsClientOptions;
     private pendingRequests;
     private index;
-    constructor(socket: IsoWebSocket, url?: URL);
+    constructor(socket: IsoWebSocket, url?: URL, options?: WsClientOptions);
     private setupSocket;
     /**
      * Instance factory for creating WsClients.
@@ -22,7 +24,7 @@ export declare class WsClient extends Emittery {
      * @param url - The WebSocket URL to connect to.
      * @returns An new instance of the WsClient.
      */
-    static connect(url: URL): Promise<WsClient>;
+    static connect(url: URL, options?: WsClientOptions): Promise<WsClient>;
     /**
      * Sends data as a signal.
      *

package/lib/api/client.js

@@ -2,6 +2,7 @@ import { decode, encode } from "@msgpack/msgpack";
 import Emittery from "emittery";
 import IsoWebSocket from "isomorphic-ws";
 import { SignalType } from "./app/types.js";
+import { HolochainError } from "./common.js";
 /**
  * A WebSocket client which can make requests and receive responses,
  * as well as send and receive signals.
@@ -13,12 +14,14 @@ import { SignalType } from "./app/types.js";
 export class WsClient extends Emittery {
     socket;
     url;
+    options;
     pendingRequests;
     index;
-    constructor(socket, url) {
+    constructor(socket, url, options) {
         super();
         this.socket = socket;
         this.url = url;
+        this.options = options || {};
         this.pendingRequests = {};
         this.index = 0;
         this.setupSocket();
@@ -37,14 +40,14 @@ export class WsClient extends Emittery {
                     deserializedData = serializedMessage.data;
                 }
                 else {
-                    throw new Error("websocket client: unknown message format");
+                    throw new HolochainError("UnknownMessageFormat", `incoming message has unknown message format - ${deserializedData}`);
                 }
             }
             const message = decode(deserializedData);
             assertHolochainMessage(message);
             if (message.type === "signal") {
                 if (message.data === null) {
-                    throw new Error("received a signal without data");
+                    throw new HolochainError("UnknownSignalFormat", "incoming signal has no data");
                 }
                 const deserializedSignal = decode(message.data);
                 assertHolochainSignal(deserializedSignal);
@@ -66,14 +69,14 @@ export class WsClient extends Emittery {
                 this.handleResponse(message);
             }
             else {
-                console.error(`Got unrecognized Websocket message type: ${message.type}`);
+                throw new HolochainError("UnknownMessageType", `incoming message has unknown type - ${message.type}`);
             }
         };
         this.socket.onclose = (event) => {
             const pendingRequestIds = Object.keys(this.pendingRequests).map((id) => parseInt(id));
             if (pendingRequestIds.length) {
                 pendingRequestIds.forEach((id) => {
-                    const error = new Error(`Websocket closed with pending requests. Close event code: ${event.code}, request id: ${id}`);
+                    const error = new HolochainError("ClientClosedWithPendingRequests", `client closed with pending requests - close event code: ${event.code}, request id: ${id}`);
                     this.pendingRequests[id].reject(error);
                     delete this.pendingRequests[id];
                 });
@@ -86,14 +89,14 @@ export class WsClient extends Emittery {
      * @param url - The WebSocket URL to connect to.
      * @returns An new instance of the WsClient.
      */
-    static connect(url) {
+    static connect(url, options) {
         return new Promise((resolve, reject) => {
-            const socket = new IsoWebSocket(url);
-            socket.onerror = () => {
-                reject(new Error(`could not connect to holochain conductor, please check that a conductor service is running and available at ${url}`));
+            const socket = new IsoWebSocket(url, options);
+            socket.onerror = (errorEvent) => {
+                reject(new HolochainError("ConnectionError", `could not connect to Holochain Conductor API at ${url} - ${errorEvent.error}`));
             };
             socket.onopen = () => {
-                const client = new WsClient(socket, url);
+                const client = new WsClient(socket, url, options);
                 resolve(client);
             };
         });
@@ -126,10 +129,10 @@ export class WsClient extends Emittery {
         else if (this.url) {
             const response = new Promise((resolve, reject) => {
                 // typescript forgets in this promise scope that this.url is not undefined
-                const socket = new IsoWebSocket(this.url);
+                const socket = new IsoWebSocket(this.url, this.options);
                 this.socket = socket;
-                socket.onerror = () => {
-                    reject(new Error(`could not connect to Holochain conductor, please check that a conductor service is running and available at ${this.url}`));
+                socket.onerror = (errorEvent) => {
+                    reject(new HolochainError("ConnectionError", `could not connect to Holochain Conductor API at ${this.url} - ${errorEvent.error}`));
                 };
                 socket.onopen = () => {
                     this.sendMessage(request, resolve, reject);
@@ -165,7 +168,7 @@ export class WsClient extends Emittery {
             delete this.pendingRequests[id];
         }
         else {
-            console.error(`Got response with no matching request. id=${id}`);
+            console.error(`got response with no matching request. id = ${id} msg = ${msg}`);
         }
     }
     /**
@@ -190,7 +193,7 @@ function assertHolochainMessage(message) {
         "data" in message) {
         return;
     }
-    throw new Error(`unknown message format ${JSON.stringify(message, null, 4)}`);
+    throw new HolochainError("UnknownMessageFormat", `incoming message has unknown message format ${JSON.stringify(message, null, 4)}`);
 }
 function assertHolochainSignal(signal) {
     if (typeof signal === "object" &&
@@ -198,6 +201,6 @@ function assertHolochainSignal(signal) {
         Object.values(SignalType).some((type) => type in signal)) {
         return;
     }
-    throw new Error(`unknown signal format ${JSON.stringify(signal, null, 4)}`);
+    throw new HolochainError("UnknownSignalFormat", `incoming signal has unknown signal format ${JSON.stringify(signal, null, 4)}`);
 }
 export { IsoWebSocket };

package/lib/api/common.d.ts

@@ -1,4 +1,6 @@
+/// <reference types="ws" />
 import { RoleName } from "../types.js";
+import { IsoWebSocket } from "./client.js";
 export declare const DEFAULT_TIMEOUT = 60000;
 /**
  * @public
@@ -78,6 +80,10 @@ export declare class CloneId {
     toString(): string;
     getBaseRoleName(): string;
 }
+/**
+ * @public
+ */
+export type WsClientOptions = Pick<IsoWebSocket.ClientOptions, "origin">;
 /**
  * Options for a Websocket connection.
  *
@@ -88,6 +94,10 @@ export interface WebsocketConnectionOptions {
      * The `ws://` URL of the Websocket server to connect to. Not required when connecting to App API from a Launcher or Kangaroo environment.
      */
     url?: URL;
+    /**
+     * Options to pass to the underlying websocket connection.
+     */
+    wsClientOptions?: WsClientOptions;
     /**
      * Timeout to default to for all operations.
      */

package/lib/api/common.js

@@ -75,7 +75,7 @@ export const isCloneId = (roleName) => roleName.includes(CLONE_ID_DELIMITER);
  */
 export const getBaseRoleNameFromCloneId = (roleName) => {
     if (!isCloneId(roleName)) {
-        throw new Error("invalid clone id: no clone id delimiter found in role name");
+        throw new HolochainError("MissingCloneIdDelimiter", `invalid clone id - no clone id delimiter found in role name ${roleName}`);
     }
     return roleName.split(CLONE_ID_DELIMITER)[0];
 };
@@ -102,7 +102,7 @@ export class CloneId {
     static fromRoleName(roleName) {
         const parts = roleName.split(CLONE_ID_DELIMITER);
         if (parts.length !== 2) {
-            throw new Error("Malformed clone id: must consist of {role id.clone index}");
+            throw new HolochainError("MalformedCloneId", `clone id must consist of 'role_id.clone_index', but got ${roleName}`);
         }
         return new CloneId(parts[0], parseInt(parts[1]));
     }

package/lib/api/index.d.ts

@@ -3,5 +3,5 @@ export * from "./admin/index.js";
 export * from "./app-agent/index.js";
 export * from "./app/index.js";
 export { IsoWebSocket, WsClient } from "./client.js";
-export { CloneId, HolochainError, Requester, Transformer, WebsocketConnectionOptions, getBaseRoleNameFromCloneId, isCloneId, } from "./common.js";
+export { CloneId, HolochainError, Requester, Transformer, WebsocketConnectionOptions, WsClientOptions, getBaseRoleNameFromCloneId, isCloneId, } from "./common.js";
 export * from "./zome-call-signing.js";

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.41.0"
+      "packageVersion": "7.43.0"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holochain/client",
-  "version": "0.17.0-dev.7",
+  "version": "0.17.0-dev.8",
   "description": "A JavaScript client for the Holochain Conductor API",
   "author": "Holochain Foundation <info@holochain.org> (http://holochain.org)",
   "license": "CAL-1.0",
@@ -37,7 +37,8 @@
     "test": "RUST_LOG=error RUST_BACKTRACE=1 node --loader ts-node/esm test/index.ts",
     "build:lib": "rimraf ./lib && tsc -p tsconfig.build.json",
     "build:docs": "api-extractor run --local && api-documenter markdown -i docs/temp -o docs",
-    "build": "npm run build:lib && npm run build:docs"
+    "build": "npm run build:lib && npm run build:docs",
+    "prepublishOnly": "npm run lint && npm run build"
   },
   "dependencies": {
     "@bitgo/blake2b": "^3.2.4",