@holochain/hc-spin 0.400.0-dev.3 → 0.400.0

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## \[Unreleased\]
+
+### Added
+
+### Fixed
+
+### Changed
+
+### Removed

package/README.md

@@ -4,31 +4,23 @@ CLI to run Holochain apps in development mode.
 
 ## Installation
 
-To install the latest version compatible with **holochain 0.1.x**:
-
-⚠️ Requires `@holochain/client 0.12.6` or newer ⚠️
-
-```
-npm install --save-dev @holochain/hc-spin@">=0.100.0 <0.200.0"
-```
-
-To install the latest version compatible with **holochain 0.2.x**:
+To install the latest version compatible with **holochain 0.3.x**:
 
-⚠️ Requires `@holochain/client 0.16.2` or newer ⚠️
+⚠️ Requires `@holochain/client 0.17.0-dev.5` or newer ⚠️
 
 ```
-npm install --save-dev @holochain/hc-spin@">=0.200.0 <0.300.0"
+npm install --save-dev @holochain/hc-spin@">=0.300.0 <0.400.0"
 ```
 
-To install the latest version compatible with **holochain 0.3.x**:
+To install the latest version compatible with **holochain 0.4.x**:
 
-⚠️ Requires `@holochain/client 0.17.0-dev.5` or newer ⚠️
+⚠️ Requires `@holochain/client 0.18.0-rc.1` or newer ⚠️
 
 ```
-npm install --save-dev @holochain/hc-spin@">=0.300.0 <0.400.0"
+npm install --save-dev @holochain/hc-spin@">=0.400.0 <0.500.0"
 ```
 
-## Usage (holochain 0.2)
+## Usage (holochain 0.4)
 
 ```
 Usage: hc-spin [options] <path>
@@ -52,6 +44,7 @@ Options:
   --ui-port <number>         Port pointing to a localhost dev server that serves your UI assets.
   --signaling-url <url>      Url of the signaling server to use. By default, hc spin spins up a local development signaling server for you
                              but this argument allows you to specify a custom one.
+  --open-devtools            Automatically open the devtools on startup.
   -h, --help                 display help for command
 ```
 

package/dist/main/index.js

@@ -786,18 +786,18 @@ var CapAccessType;
   CapAccessType2["Transferable"] = "Transferable";
   CapAccessType2["Assigned"] = "Assigned";
 })(CapAccessType || (CapAccessType = {}));
-var DhtOpType;
-(function(DhtOpType2) {
-  DhtOpType2["StoreRecord"] = "StoreRecord";
-  DhtOpType2["StoreEntry"] = "StoreEntry";
-  DhtOpType2["RegisterAgentActivity"] = "RegisterAgentActivity";
-  DhtOpType2["RegisterUpdatedContent"] = "RegisterUpdatedContent";
-  DhtOpType2["RegisterUpdatedRecord"] = "RegisterUpdatedRecord";
-  DhtOpType2["RegisterDeletedBy"] = "RegisterDeletedBy";
-  DhtOpType2["RegisterDeletedEntryAction"] = "RegisterDeletedEntryAction";
-  DhtOpType2["RegisterAddLink"] = "RegisterAddLink";
-  DhtOpType2["RegisterRemoveLink"] = "RegisterRemoveLink";
-})(DhtOpType || (DhtOpType = {}));
+var ChainOpType;
+(function(ChainOpType2) {
+  ChainOpType2["StoreRecord"] = "StoreRecord";
+  ChainOpType2["StoreEntry"] = "StoreEntry";
+  ChainOpType2["RegisterAgentActivity"] = "RegisterAgentActivity";
+  ChainOpType2["RegisterUpdatedContent"] = "RegisterUpdatedContent";
+  ChainOpType2["RegisterUpdatedRecord"] = "RegisterUpdatedRecord";
+  ChainOpType2["RegisterDeletedBy"] = "RegisterDeletedBy";
+  ChainOpType2["RegisterDeletedEntryAction"] = "RegisterDeletedEntryAction";
+  ChainOpType2["RegisterAddLink"] = "RegisterAddLink";
+  ChainOpType2["RegisterRemoveLink"] = "RegisterRemoveLink";
+})(ChainOpType || (ChainOpType = {}));
 const anyMap = /* @__PURE__ */ new WeakMap();
 const eventsMap = /* @__PURE__ */ new WeakMap();
 const producersMap = /* @__PURE__ */ new WeakMap();
@@ -5026,6 +5026,7 @@ const promiseTimeout = (promise2, tag, ms) => {
     clearTimeout(id);
     return res(a);
   }).catch((e) => {
+    clearTimeout(id);
     return rej(e);
   }));
 };
@@ -12333,23 +12334,33 @@ b2wasm.ready(function(err) {
 class AppWebsocket {
   client;
   myPubKey;
+  installedAppId;
   defaultTimeout;
   emitter;
+  callZomeTransform;
+  appAuthenticationToken;
   cachedAppInfo;
   appInfoRequester;
   callZomeRequester;
+  provideMemproofRequester;
+  enableAppRequester;
   createCloneCellRequester;
   enableCloneCellRequester;
   disableCloneCellRequester;
   networkInfoRequester;
-  constructor(client, appInfo, defaultTimeout) {
+  constructor(client, appInfo, token, callZomeTransform, defaultTimeout) {
     this.client = client;
     this.myPubKey = appInfo.agent_pub_key;
+    this.installedAppId = appInfo.installed_app_id;
     this.defaultTimeout = defaultTimeout ?? DEFAULT_TIMEOUT;
+    this.callZomeTransform = callZomeTransform ?? defaultCallZomeTransform;
+    this.appAuthenticationToken = token;
     this.emitter = new Emittery();
     this.cachedAppInfo = appInfo;
     this.appInfoRequester = AppWebsocket.requester(this.client, "app_info", this.defaultTimeout);
-    this.callZomeRequester = AppWebsocket.requester(this.client, "call_zome", this.defaultTimeout, callZomeTransform);
+    this.callZomeRequester = AppWebsocket.requester(this.client, "call_zome", this.defaultTimeout, this.callZomeTransform);
+    this.provideMemproofRequester = AppWebsocket.requester(this.client, "provide_memproofs", this.defaultTimeout);
+    this.enableAppRequester = AppWebsocket.requester(this.client, "enable_app", this.defaultTimeout);
     this.createCloneCellRequester = AppWebsocket.requester(this.client, "create_clone_cell", this.defaultTimeout);
     this.enableCloneCellRequester = AppWebsocket.requester(this.client, "enable_clone_cell", this.defaultTimeout);
     this.disableCloneCellRequester = AppWebsocket.requester(this.client, "disable_clone_cell", this.defaultTimeout);
@@ -12361,9 +12372,7 @@ class AppWebsocket {
       }
     });
     this.client.on("signal", (signal) => {
-      if (this.containsCell(signal.cell_id)) {
-        this.emitter.emit("signal", signal).catch(console.error);
-      }
+      this.emitter.emit("signal", signal).catch(console.error);
     });
   }
   /**
@@ -12382,19 +12391,15 @@ class AppWebsocket {
       throw new HolochainError("ConnectionUrlMissing", `unable to connect to Conductor API - no url provided and not in a launcher environment.`);
     }
     const client = await WsClient.connect(options.url, options.wsClientOptions);
-    if (env?.APP_INTERFACE_TOKEN) {
-      await client.authenticate({ token: env.APP_INTERFACE_TOKEN });
-    } else {
-      if (!options.token) {
-        throw new HolochainError("AppAuthenticationTokenMissing", `unable to connect to Conductor API - no app authentication token provided.`);
-      }
-      await client.authenticate({ token: options.token });
-    }
-    const appInfo = await this.requester(client, "app_info", DEFAULT_TIMEOUT)(null);
+    const token = options.token ?? env?.APP_INTERFACE_TOKEN;
+    if (!token)
+      throw new HolochainError("AppAuthenticationTokenMissing", `unable to connect to Conductor API - no app authentication token provided.`);
+    await client.authenticate({ token });
+    const appInfo = await AppWebsocket.requester(client, "app_info", DEFAULT_TIMEOUT)(null);
     if (!appInfo) {
       throw new HolochainError("AppNotFound", `The app your connection token was issued for was not found. The app needs to be installed and enabled.`);
     }
-    return new AppWebsocket(client, appInfo, options.defaultTimeout);
+    return new AppWebsocket(client, appInfo, token, options.callZomeTransform, options.defaultTimeout);
   }
   /**
    * Request the app's info, including all cell infos.
@@ -12410,6 +12415,21 @@ class AppWebsocket {
     this.cachedAppInfo = appInfo;
     return appInfo;
   }
+  /**
+   * Provide membrane proofs for the app.
+   *
+   * @param memproofs - A map of {@link MembraneProof}s.
+   */
+  async provideMemproofs(memproofs) {
+    await this.provideMemproofRequester(memproofs);
+  }
+  /**
+   * Enablie an app only if the app is in the `AppStatus::Disabled(DisabledAppReason::NotStartedAfterProvidingMemproofs)`
+   * state. Attempting to enable the app from other states (other than Running) will fail.
+   */
+  async enableApp() {
+    await this.enableAppRequester();
+  }
   /**
    * Get a cell id by its role name or clone id.
    *
@@ -12524,23 +12544,8 @@ class AppWebsocket {
   static requester(client, tag, defaultTimeout, transformer) {
     return requesterTransformer((req, timeout2) => promiseTimeout(client.request(req), tag, timeout2 || defaultTimeout).then(catchError), tag, transformer);
   }
-  containsCell(cellId) {
-    const appInfo = this.cachedAppInfo;
-    if (!appInfo) {
-      return false;
-    }
-    for (const roleName of Object.keys(appInfo.cell_info)) {
-      for (const cellInfo of appInfo.cell_info[roleName]) {
-        const currentCellId = CellType.Provisioned in cellInfo ? cellInfo[CellType.Provisioned].cell_id : CellType.Cloned in cellInfo ? cellInfo[CellType.Cloned].cell_id : void 0;
-        if (currentCellId && isSameCell(currentCellId, cellId)) {
-          return true;
-        }
-      }
-    }
-    return false;
-  }
 }
-const callZomeTransform = {
+const defaultCallZomeTransform = {
   input: async (request) => {
     if ("signature" in request) {
       return request;
@@ -12554,7 +12559,6 @@ const callZomeTransform = {
   },
   output: (response) => msgpack.decode(response)
 };
-const isSameCell = (cellId1, cellId2) => cellId1[0].every((byte, index) => byte === cellId2[0][index]) && cellId1[1].every((byte, index) => byte === cellId2[1][index]);
 const signZomeCall = async (request) => {
   const signingCredentialsForCell = getSigningCredentials(request.cell_id);
   if (!signingCredentialsForCell) {
@@ -12586,62 +12590,16 @@ class WsClient extends Emittery {
   options;
   pendingRequests;
   index;
+  authenticationToken;
   constructor(socket, url2, options) {
     super();
+    this.registerMessageListener(socket);
+    this.registerCloseListener(socket);
     this.socket = socket;
     this.url = url2;
     this.options = options || {};
     this.pendingRequests = {};
     this.index = 0;
-    this.setupSocket();
-  }
-  setupSocket() {
-    this.socket.onmessage = async (serializedMessage) => {
-      let deserializedData;
-      if (globalThis.window && serializedMessage.data instanceof globalThis.window.Blob) {
-        deserializedData = await serializedMessage.data.arrayBuffer();
-      } else {
-        if (typeof Buffer !== "undefined" && Buffer.isBuffer(serializedMessage.data)) {
-          deserializedData = serializedMessage.data;
-        } else {
-          throw new HolochainError("UnknownMessageFormat", `incoming message has unknown message format - ${deserializedData}`);
-        }
-      }
-      const message = msgpack.decode(deserializedData);
-      assertHolochainMessage(message);
-      if (message.type === "signal") {
-        if (message.data === null) {
-          throw new HolochainError("UnknownSignalFormat", "incoming signal has no data");
-        }
-        const deserializedSignal = msgpack.decode(message.data);
-        assertHolochainSignal(deserializedSignal);
-        if (SignalType.System in deserializedSignal) {
-          return;
-        }
-        const encodedAppSignal = deserializedSignal[SignalType.App];
-        const payload = msgpack.decode(encodedAppSignal.signal);
-        const signal = {
-          cell_id: encodedAppSignal.cell_id,
-          zome_name: encodedAppSignal.zome_name,
-          payload
-        };
-        this.emit("signal", signal);
-      } else if (message.type === "response") {
-        this.handleResponse(message);
-      } else {
-        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 HolochainError("ClientClosedWithPendingRequests", `client closed with pending requests - close event code: ${event.code}, request id: ${id}`);
-          this.pendingRequests[id].reject(error);
-          delete this.pendingRequests[id];
-        });
-      }
-    };
   }
   /**
    * Instance factory for creating WsClients.
@@ -12653,13 +12611,13 @@ class WsClient extends Emittery {
   static connect(url2, options) {
     return new Promise((resolve, reject) => {
       const socket = new IsoWebSocket(url2, options);
-      socket.onerror = (errorEvent) => {
+      socket.addEventListener("error", (errorEvent) => {
         reject(new HolochainError("ConnectionError", `could not connect to Holochain Conductor API at ${url2} - ${errorEvent.error}`));
-      };
-      socket.onopen = () => {
+      });
+      socket.addEventListener("open", (_) => {
         const client = new WsClient(socket, url2, options);
         resolve(client);
-      };
+      }, { once: true });
     });
   }
   /**
@@ -12682,15 +12640,34 @@ class WsClient extends Emittery {
    * @param request - The authentication request, containing an app authentication token.
    */
   async authenticate(request) {
-    return this.exchange(request, (request2, resolve) => {
+    this.authenticationToken = request.token;
+    return this.exchange(request, (request2, resolve, reject) => {
+      const invalidTokenCloseListener = (closeEvent) => {
+        this.authenticationToken = void 0;
+        reject(new HolochainError("InvalidTokenError", `could not connect to ${this.url} due to an invalid app authentication token - close code ${closeEvent.code}`));
+      };
+      this.socket.addEventListener("close", invalidTokenCloseListener, {
+        once: true
+      });
       const encodedMsg = msgpack.encode({
         type: "authenticate",
         data: msgpack.encode(request2)
       });
       this.socket.send(encodedMsg);
-      resolve(null);
+      setTimeout(() => {
+        this.socket.removeEventListener("close", invalidTokenCloseListener);
+        resolve(null);
+      }, 10);
     });
   }
+  /**
+   * Close the websocket connection.
+   */
+  close(code = 1e3) {
+    const closedPromise = new Promise((resolve) => this.socket.addEventListener("close", (closeEvent) => resolve(closeEvent), { once: true }));
+    this.socket.close(code);
+    return closedPromise;
+  }
   /**
    * Send requests to the connected websocket.
    *
@@ -12700,14 +12677,20 @@ class WsClient extends Emittery {
   async request(request) {
     return this.exchange(request, this.sendMessage.bind(this));
   }
-  exchange(request, sendHandler) {
+  async exchange(request, sendHandler) {
     if (this.socket.readyState === this.socket.OPEN) {
       const promise2 = new Promise((resolve, reject) => {
         sendHandler(request, resolve, reject);
       });
       return promise2;
+    } else if (this.url && this.authenticationToken) {
+      await this.reconnectWebsocket(this.url, this.authenticationToken);
+      this.registerMessageListener(this.socket);
+      this.registerCloseListener(this.socket);
+      const promise2 = new Promise((resolve, reject) => sendHandler(request, resolve, reject));
+      return promise2;
     } else {
-      return Promise.reject(new Error("Socket is not open"));
+      return Promise.reject(new HolochainError("WebsocketClosedError", "Websocket is not open"));
     }
   }
   sendMessage(request, resolve, reject) {
@@ -12721,6 +12704,86 @@ class WsClient extends Emittery {
     this.pendingRequests[id] = { resolve, reject };
     this.index += 1;
   }
+  registerMessageListener(socket) {
+    socket.onmessage = async (serializedMessage) => {
+      let deserializedData;
+      if (globalThis.window && serializedMessage.data instanceof globalThis.window.Blob) {
+        deserializedData = await serializedMessage.data.arrayBuffer();
+      } else {
+        if (typeof Buffer !== "undefined" && Buffer.isBuffer(serializedMessage.data)) {
+          deserializedData = serializedMessage.data;
+        } else {
+          throw new HolochainError("UnknownMessageFormat", `incoming message has unknown message format - ${deserializedData}`);
+        }
+      }
+      const message = msgpack.decode(deserializedData);
+      assertHolochainMessage(message);
+      if (message.type === "signal") {
+        if (message.data === null) {
+          throw new HolochainError("UnknownSignalFormat", "incoming signal has no data");
+        }
+        const deserializedSignal = msgpack.decode(message.data);
+        assertHolochainSignal(deserializedSignal);
+        if (SignalType.System in deserializedSignal) {
+          this.emit("signal", {
+            System: deserializedSignal[SignalType.System]
+          });
+        } else {
+          const encodedAppSignal = deserializedSignal[SignalType.App];
+          const payload = msgpack.decode(encodedAppSignal.signal);
+          const signal = {
+            cell_id: encodedAppSignal.cell_id,
+            zome_name: encodedAppSignal.zome_name,
+            payload
+          };
+          this.emit("signal", { App: signal });
+        }
+      } else if (message.type === "response") {
+        this.handleResponse(message);
+      } else {
+        throw new HolochainError("UnknownMessageType", `incoming message has unknown type - ${message.type}`);
+      }
+    };
+  }
+  registerCloseListener(socket) {
+    socket.addEventListener("close", (closeEvent) => {
+      const pendingRequestIds = Object.keys(this.pendingRequests).map((id) => parseInt(id));
+      if (pendingRequestIds.length) {
+        pendingRequestIds.forEach((id) => {
+          const error = new HolochainError("ClientClosedWithPendingRequests", `client closed with pending requests - close event code: ${closeEvent.code}, request id: ${id}`);
+          this.pendingRequests[id].reject(error);
+          delete this.pendingRequests[id];
+        });
+      }
+    }, { once: true });
+  }
+  async reconnectWebsocket(url2, token) {
+    return new Promise((resolve, reject) => {
+      this.socket = new IsoWebSocket(url2, this.options);
+      this.socket.addEventListener("error", (errorEvent) => {
+        this.authenticationToken = void 0;
+        reject(new HolochainError("ConnectionError", `could not connect to Holochain Conductor API at ${url2} - ${errorEvent.message}`));
+      }, { once: true });
+      const invalidTokenCloseListener = (closeEvent) => {
+        this.authenticationToken = void 0;
+        reject(new HolochainError("InvalidTokenError", `could not connect to ${this.url} due to an invalid app authentication token - close code ${closeEvent.code}`));
+      };
+      this.socket.addEventListener("close", invalidTokenCloseListener, {
+        once: true
+      });
+      this.socket.addEventListener("open", async (_) => {
+        const encodedMsg = msgpack.encode({
+          type: "authenticate",
+          data: msgpack.encode({ token })
+        });
+        this.socket.send(encodedMsg);
+        setTimeout(() => {
+          this.socket.removeEventListener("close", invalidTokenCloseListener);
+          resolve();
+        }, 10);
+      }, { once: true });
+    });
+  }
   handleResponse(msg) {
     const id = msg.id;
     if (this.pendingRequests[id]) {
@@ -12734,22 +12797,6 @@ class WsClient extends Emittery {
       console.error(`got response with no matching request. id = ${id} msg = ${msg}`);
     }
   }
-  /**
-   * Close the websocket connection.
-   */
-  close(code = 1e3) {
-    const closedPromise = new Promise(
-      (resolve) => (
-        // for an unknown reason "addEventListener" is seen as a non-callable
-        // property and gives a ts2349 error
-        // type assertion as workaround
-        this.socket.addEventListener("close", (event) => resolve(event))
-      )
-      // }
-    );
-    this.socket.close(code);
-    return closedPromise;
-  }
 }
 function assertHolochainMessage(message) {
   if (typeof message === "object" && message !== null && "type" in message && "data" in message) {
@@ -12821,6 +12868,10 @@ class AdminWebsocket {
    * Generate a new agent pub key.
    */
   generateAgentPubKey = this._requester("generate_agent_pub_key");
+  /**
+   * Generate a new agent pub key.
+   */
+  revokeAgentKey = this._requester("revoke_agent_key");
   /**
    * Register a DNA for later app installation.
    *
@@ -12831,6 +12882,9 @@ class AdminWebsocket {
    * Get the DNA definition for the specified DNA hash.
    */
   getDnaDefinition = this._requester("get_dna_definition");
+  /// Find installed cells which use a DNA that's forward-compatible with the given DNA hash.
+  /// Namely, this finds cells with DNAs whose manifest lists the given DNA hash in its `lineage` field.
+  getCompatibleCells = this._requester("get_compatible_cells");
   /**
    * Uninstall the specified app from Holochain.
    */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@holochain/hc-spin",
-  "version": "0.400.0-dev.3",
-  "holochainVersion": "0.4.0-dev.16",
+  "version": "0.400.0",
+  "holochainVersion": "0.4.0-rc.2",
   "description": "CLI to run Holochain aps during development.",
   "author": "matthme",
   "homepage": "https://developer.holochain.org",
@@ -35,8 +35,8 @@
   "dependencies": {
     "@electron-toolkit/preload": "^3.0.0",
     "@electron-toolkit/utils": "^3.0.0",
-    "@holochain/client": "0.18.0-dev.0",
-    "@holochain/hc-spin-rust-utils": "^0.300.1",
+    "@holochain/client": "0.18.0",
+    "@holochain/hc-spin-rust-utils": "0.400.0",
     "@msgpack/msgpack": "^2.8.0",
     "bufferutil": "4.0.8",
     "commander": "11.1.0",