@holochain/client 0.18.0-dev.8 → 0.19.0-dev.0

package/README.md

@@ -15,12 +15,12 @@ A JavaScript client for the Holochain Conductor API (works with browsers as well
 
 ## Installation
 
+**JS client v0.19.x** is compatible with **Holochain v0.5.x**.
+
 **JS client v0.18.x** is compatible with **Holochain v0.4.x**.
 
 **JS client v0.17.x** is compatible with **Holochain v0.3.x**.
 
-**JS client v0.16.x** is compatible with **Holochain v0.2.x**.
-
 To install from NPM, run
 ```bash
 npm install --save-exact @holochain/client

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

@@ -180,6 +180,22 @@ export type GenerateAgentPubKeyRequest = void;
  * @public
  */
 export type GenerateAgentPubKeyResponse = AgentPubKey;
+/**
+ * @public
+ */
+export type RevokeAgentKeyRequest = {
+    agent_key: AgentPubKey;
+    app_id: InstalledAppId;
+};
+/**
+ * Contains a list of errors of the cells where deletion was unsuccessful.
+ *
+ * If the key could not be deleted from all cells, the call
+ * {@link RevokeAgentKeyRequest} can be re-attempted to delete the key from the remaining cells.
+ *
+ * @public
+ */
+export type RevokeAgentKeyResponse = [CellId, string][];
 /**
  * @public
  */
@@ -398,8 +414,11 @@ export type NetworkSeed = string;
 export type InstallAppRequest = {
     /**
      * The agent to use when creating Cells for this App.
+     * If not specified, a new agent will be generated by Holochain.
+     * If DPKI is enabled (default), and the agent key is not specified here,
+     * a new agent key will be derived from the DPKI device seed and registered with DPKI.
      */
-    agent_key: AgentPubKey;
+    agent_key?: AgentPubKey;
     /**
      * The unique identifier for an installed app in this conductor.
      * If not specified, it will be derived from the app name in the bundle manifest.
@@ -523,7 +542,7 @@ export interface DeleteCloneCellRequest {
     /**
      * The clone id or cell id of the clone cell
      */
-    clone_cell_id: RoleName | CellId;
+    clone_cell_id: RoleName | DnaHash;
 }
 /**
  * @public

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

@@ -2,7 +2,7 @@ import { CapSecret, GrantedFunctions } from "../../hdk/index.js";
 import type { AgentPubKey, CellId } from "../../types.js";
 import { WsClient } from "../client.js";
 import { Requester, Transformer, WebsocketConnectionOptions } from "../common.js";
-import { AddAgentInfoRequest, AddAgentInfoResponse, AdminApi, AgentInfoRequest, AgentInfoResponse, AttachAppInterfaceRequest, AttachAppInterfaceResponse, DeleteCloneCellRequest, DeleteCloneCellResponse, DisableAppRequest, DisableAppResponse, DumpFullStateRequest, DumpFullStateResponse, DumpNetworkStatsRequest, DumpNetworkStatsResponse, DumpStateRequest, DumpStateResponse, EnableAppRequest, EnableAppResponse, GenerateAgentPubKeyRequest, GenerateAgentPubKeyResponse, GetCompatibleCellsRequest, GetCompatibleCellsResponse, GetDnaDefinitionRequest, GetDnaDefinitionResponse, GrantZomeCallCapabilityRequest, GrantZomeCallCapabilityResponse, InstallAppRequest, InstallAppResponse, IssueAppAuthenticationTokenRequest, IssueAppAuthenticationTokenResponse, ListAppInterfacesRequest, ListAppInterfacesResponse, ListAppsRequest, ListAppsResponse, ListCellIdsRequest, ListCellIdsResponse, ListDnasRequest, ListDnasResponse, RegisterDnaRequest, RegisterDnaResponse, StorageInfoRequest, StorageInfoResponse, UninstallAppRequest, UninstallAppResponse, UpdateCoordinatorsRequest, UpdateCoordinatorsResponse } from "./types.js";
+import { AddAgentInfoRequest, AddAgentInfoResponse, AdminApi, AgentInfoRequest, AgentInfoResponse, AttachAppInterfaceRequest, AttachAppInterfaceResponse, DeleteCloneCellRequest, DeleteCloneCellResponse, DisableAppRequest, DisableAppResponse, DumpFullStateRequest, DumpFullStateResponse, DumpNetworkStatsRequest, DumpNetworkStatsResponse, DumpStateRequest, DumpStateResponse, EnableAppRequest, EnableAppResponse, GenerateAgentPubKeyRequest, GenerateAgentPubKeyResponse, GetCompatibleCellsRequest, GetCompatibleCellsResponse, GetDnaDefinitionRequest, GetDnaDefinitionResponse, GrantZomeCallCapabilityRequest, GrantZomeCallCapabilityResponse, InstallAppRequest, InstallAppResponse, IssueAppAuthenticationTokenRequest, IssueAppAuthenticationTokenResponse, ListAppInterfacesRequest, ListAppInterfacesResponse, ListAppsRequest, ListAppsResponse, ListCellIdsRequest, ListCellIdsResponse, ListDnasRequest, ListDnasResponse, RegisterDnaRequest, RegisterDnaResponse, RevokeAgentKeyRequest, RevokeAgentKeyResponse, StorageInfoRequest, StorageInfoResponse, UninstallAppRequest, UninstallAppResponse, UpdateCoordinatorsRequest, UpdateCoordinatorsResponse } from "./types.js";
 /**
  * A class for interacting with a conductor's Admin API.
  *
@@ -51,6 +51,10 @@ export declare class AdminWebsocket implements AdminApi {
      * Generate a new agent pub key.
      */
     generateAgentPubKey: Requester<GenerateAgentPubKeyRequest, GenerateAgentPubKeyResponse>;
+    /**
+     * Generate a new agent pub key.
+     */
+    revokeAgentKey: Requester<RevokeAgentKeyRequest, RevokeAgentKeyResponse>;
     /**
      * Register a DNA for later app installation.
      *

package/lib/api/admin/websocket.js

@@ -68,6 +68,10 @@ export 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.
      *

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

@@ -1,5 +1,5 @@
 import { UnsubscribeFunction } from "emittery";
-import { AgentPubKey, AppAuthenticationToken, AppInfo, CapSecret, CellId, ClonedCell, DnaHash, DnaProperties, FunctionName, InstalledAppId, MembraneProof, MemproofMap, NetworkInfo, NetworkSeed, Nonce256Bit, RoleName, Timestamp, Transformer, WebsocketConnectionOptions, ZomeName } from "../../index.js";
+import { AgentPubKey, AppAuthenticationToken, AppInfo, CapSecret, CellId, ClonedCell, DnaHash, DnaProperties, EntryHash, FunctionName, InstalledAppId, MembraneProof, MemproofMap, NetworkInfo, NetworkSeed, Nonce256Bit, RoleName, Timestamp, Transformer, WebsocketConnectionOptions, ZomeName } from "../../index.js";
 /**
  * @public
  */
@@ -40,7 +40,7 @@ export type AppNetworkInfoRequest = Omit<NetworkInfoRequest, "agent_pub_key">;
  * @public
  */
 export interface AppEvents {
-    signal: AppSignal;
+    signal: Signal;
 }
 /**
  * @public
@@ -152,7 +152,7 @@ export interface DisableCloneCellRequest {
     /**
      * The clone id or cell id of the clone cell
      */
-    clone_cell_id: RoleName | CellId;
+    clone_cell_id: RoleName | DnaHash;
 }
 /**
  * @public
@@ -193,10 +193,18 @@ export declare const SignalType: {
 /**
  * @public
  */
-export type Signal = {
+export type RawSignal = {
     [SignalType.App]: EncodedAppSignal;
 } | {
-    [SignalType.System]: unknown;
+    [SignalType.System]: SystemSignal;
+};
+/**
+ * @public
+ */
+export type Signal = {
+    [SignalType.App]: AppSignal;
+} | {
+    [SignalType.System]: SystemSignal;
 };
 /**
  * @public
@@ -217,7 +225,13 @@ export type AppSignal = {
 /**
  * @public
  */
-export type AppSignalCb = (signal: AppSignal) => void;
+export type SystemSignal = {
+    SuccessfulCountersigning: EntryHash;
+};
+/**
+ * @public
+ */
+export type SignalCb = (signal: Signal) => void;
 /**
  * @public
  */
@@ -227,7 +241,7 @@ export type NetworkInfoResponse = NetworkInfo[];
  */
 export interface AppClient {
     callZome(args: AppCallZomeRequest, timeout?: number): Promise<any>;
-    on<Name extends keyof AppEvents>(eventName: Name | readonly Name[], listener: AppSignalCb): UnsubscribeFunction;
+    on<Name extends keyof AppEvents>(eventName: Name | readonly Name[], listener: SignalCb): UnsubscribeFunction;
     appInfo(): Promise<AppInfoResponse>;
     myPubKey: AgentPubKey;
     installedAppId: InstalledAppId;

package/lib/api/app/websocket.d.ts

@@ -1,7 +1,7 @@
 import { UnsubscribeFunction } from "emittery";
 import { AgentPubKey, CellId, InstalledAppId, RoleName } from "../../types.js";
 import { AppInfo, MemproofMap } from "../admin/index.js";
-import { AppCallZomeRequest, AppClient, AppEvents, AppNetworkInfoRequest, AppCreateCloneCellRequest, AppDisableCloneCellRequest, AppEnableCloneCellRequest, AppSignalCb, CallZomeRequest, CallZomeRequestSigned, CallZomeResponse, CreateCloneCellResponse, DisableCloneCellResponse, EnableCloneCellResponse, NetworkInfoResponse, AppWebsocketConnectionOptions } from "./types.js";
+import { AppCallZomeRequest, AppClient, AppEvents, AppNetworkInfoRequest, AppCreateCloneCellRequest, AppDisableCloneCellRequest, AppEnableCloneCellRequest, SignalCb, CallZomeRequest, CallZomeRequestSigned, CallZomeResponse, CreateCloneCellResponse, DisableCloneCellResponse, EnableCloneCellResponse, NetworkInfoResponse, AppWebsocketConnectionOptions } from "./types.js";
 import { WsClient } from "../client.js";
 /**
  * A class to establish a websocket connection to an App interface, for a
@@ -101,7 +101,7 @@ export declare class AppWebsocket implements AppClient {
      * @param listener - The function to call when event is triggered.
      * @returns A function to unsubscribe the event listener.
      */
-    on<Name extends keyof AppEvents>(eventName: Name | readonly Name[], listener: AppSignalCb): UnsubscribeFunction;
+    on<Name extends keyof AppEvents>(eventName: Name | readonly Name[], listener: SignalCb): UnsubscribeFunction;
     private static requester;
     private containsCell;
 }

package/lib/api/app/websocket.js

@@ -57,9 +57,7 @@ export 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);
         });
     }
     /**

package/lib/api/client.js

@@ -52,18 +52,21 @@ export class WsClient extends Emittery {
                 const deserializedSignal = decode(message.data);
                 assertHolochainSignal(deserializedSignal);
                 if (SignalType.System in deserializedSignal) {
-                    // We have received a system signal, do nothing
-                    return;
+                    this.emit("signal", {
+                        System: deserializedSignal[SignalType.System],
+                    });
+                }
+                else {
+                    const encodedAppSignal = deserializedSignal[SignalType.App];
+                    // In order to return readable content to the UI, the signal payload must also be deserialized.
+                    const payload = decode(encodedAppSignal.signal);
+                    const signal = {
+                        cell_id: encodedAppSignal.cell_id,
+                        zome_name: encodedAppSignal.zome_name,
+                        payload,
+                    };
+                    this.emit("signal", { App: signal });
                 }
-                const encodedAppSignal = deserializedSignal[SignalType.App];
-                // In order to return readable content to the UI, the signal payload must also be deserialized.
-                const payload = 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);

package/lib/hdk/countersigning.d.ts

@@ -18,6 +18,23 @@ export interface PreflightRequest {
     action_base: ActionBase;
     preflight_bytes: PreflightBytes;
 }
+/**
+ * @public
+ */
+export interface PreflightResponse {
+    /**
+     * The request associated with this response.
+     */
+    request: PreflightRequest;
+    /**
+     * The chain state declaration for the agent that produced this response.
+     */
+    agent_state: CountersigningAgentState;
+    /**
+     * The signature of this response, by the agent that created it.
+     */
+    signature: Signature;
+}
 /**
  * @public
  */

package/lib/tsdoc-metadata.json

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

package/lib/utils/cell.d.ts

@@ -0,0 +1,11 @@
+import { CellId } from "../types.js";
+/**
+ * Check if two cell ids are identical.
+ *
+ * @param cellId1 - Cell id 1 to compare.
+ * @param cellId2 - Cell id 1 to compare.
+ * @returns True if the cell ids are identical.
+ *
+ * @public
+ */
+export declare const isSameCell: (cellId1: CellId, cellId2: CellId) => boolean;

package/lib/utils/cell.js

@@ -0,0 +1,17 @@
+import { encodeHashToBase64 } from "./base64.js";
+/**
+ * Check if two cell ids are identical.
+ *
+ * @param cellId1 - Cell id 1 to compare.
+ * @param cellId2 - Cell id 1 to compare.
+ * @returns True if the cell ids are identical.
+ *
+ * @public
+ */
+export const isSameCell = (cellId1, cellId2) => {
+    const dnaHashB64_1 = encodeHashToBase64(cellId1[0]);
+    const agentPubKeyB64_1 = encodeHashToBase64(cellId1[1]);
+    const dnaHashB64_2 = encodeHashToBase64(cellId2[0]);
+    const agentPubKeyB64_2 = encodeHashToBase64(cellId2[1]);
+    return dnaHashB64_1 === dnaHashB64_2 && agentPubKeyB64_1 === agentPubKeyB64_2;
+};

package/lib/utils/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./base64.js";
 export * from "./fake-hash.js";
 export * from "./hash-parts.js";
+export * from "./cell.js";

package/lib/utils/index.js

@@ -1,3 +1,4 @@
 export * from "./base64.js";
 export * from "./fake-hash.js";
 export * from "./hash-parts.js";
+export * from "./cell.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holochain/client",
-  "version": "0.18.0-dev.8",
+  "version": "0.19.0-dev.0",
   "description": "A JavaScript client for the Holochain Conductor API",
   "author": "Holochain Foundation <info@holochain.org> (https://holochain.org)",
   "license": "CAL-1.0",