@holochain/client 0.20.0-dev.0 → 0.20.0-dev.2

package/README.md

@@ -182,6 +182,7 @@ You need a version (`stable` toolchain) of Rust available.
 You need `holochain` and `hc` on your path, best to get them from nix with `nix-shell`.
 
 To perform the pre-requisite DNA compilation steps, and run the Nodejs test, run:
+
 ```bash
 nix develop
 ./build-fixture.sh

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

@@ -32,10 +32,7 @@ export type EnableAppRequest = {
 /**
  * @public
  */
-export type EnableAppResponse = {
-    app: AppInfo;
-    errors: Array<[CellId, string]>;
-};
+export type EnableAppResponse = AppInfo;
 /**
  * @public
  */
@@ -59,20 +56,13 @@ export type DisabledAppReason = {
 /**
  * @public
  */
-export type AppInfoStatus = {
-    type: "paused";
-    value: {
-        reason: PausedAppReason;
-    };
-} | {
+export type AppStatus = {
     type: "disabled";
-    value: {
-        reason: DisabledAppReason;
-    };
+    value: DisabledAppReason;
 } | {
-    type: "awaiting_memproofs";
+    type: "enabled";
 } | {
-    type: "running";
+    type: "awaiting_memproofs";
 };
 /**
  * @public
@@ -129,7 +119,7 @@ export type AppInfo = {
     agent_pub_key: AgentPubKey;
     installed_app_id: InstalledAppId;
     cell_info: Record<RoleName, Array<CellInfo>>;
-    status: AppInfoStatus;
+    status: AppStatus;
     installed_at: Timestamp;
 };
 /**
@@ -240,20 +230,6 @@ export type RevokeAgentKeyRequest = {
  * @public
  */
 export type RevokeAgentKeyResponse = [CellId, string][];
-/**
- * @public
- */
-export type RegisterDnaRequest = {
-    source: DnaSource;
-    modifiers?: {
-        network_seed?: string;
-        properties?: DnaProperties;
-    };
-};
-/**
- * @public
- */
-export type RegisterDnaResponse = HoloHash;
 /**
  * @public
  */
@@ -300,7 +276,7 @@ export type DnaDefinition = {
 /**
  * @public
  */
-export type GetDnaDefinitionRequest = DnaHash;
+export type GetDnaDefinitionRequest = CellId;
 /**
  * @public
  */
@@ -320,7 +296,7 @@ export type UninstallAppResponse = null;
  */
 export type UpdateCoordinatorsRequest = {
     source: CoordinatorSource;
-    dna_hash: DnaHash;
+    cell_id: CellId;
 };
 /**
  * @public
@@ -516,10 +492,7 @@ export type ListActiveAppsResponse = Array<InstalledAppId>;
  */
 export declare enum AppStatusFilter {
     Enabled = "enabled",
-    Disabled = "disabled",
-    Running = "running",
-    Stopped = "stopped",
-    Paused = "paused"
+    Disabled = "disabled"
 }
 /**
  * @public
@@ -573,6 +546,24 @@ export type AddAgentInfoRequest = {
  * @public
  */
 export type AddAgentInfoResponse = unknown;
+/**
+ * @public
+ */
+export interface PeerMetaInfoRequest {
+    url: string;
+    dna_hashes?: DnaHash[];
+}
+/**
+ * @public
+ */
+export type PeerMetaInfoResponse = Record<DnaHashB64, Record<string, PeerMetaInfo>>;
+/**
+ * @public
+ */
+export interface PeerMetaInfo {
+    meta_value: string;
+    expires_at: Timestamp | null;
+}
 /**
  * @public
  */
@@ -607,7 +598,62 @@ export interface GrantZomeCallCapabilityRequest {
 /**
  * @public
  */
-export type GrantZomeCallCapabilityResponse = void;
+export type GrantZomeCallCapabilityResponse = ActionHash;
+/**
+ * @public
+ */
+export interface RevokeZomeCallCapabilityRequest {
+    /**
+     * The action hash of the capability to revoke.
+     */
+    action_hash: ActionHash;
+    /**
+     * Cell ID of the cell for which to revoke the capability.
+     */
+    cell_id: CellId;
+}
+/**
+ * @public
+ */
+export type RevokeZomeCallCapabilityResponse = void;
+/**
+ * @public
+ */
+export interface ListCapabilityGrantsRequest {
+    /**
+     * The app id for which to list the capability grants.
+     */
+    installed_app_id: InstalledAppId;
+    /**
+     * Whether to include also revoked grants in the response.
+     */
+    include_revoked: boolean;
+}
+/**
+ * @public
+ */
+export type ListCapabilityGrantsResponse = Array<[CellId, CapGrantInfo[]]>;
+/**
+ * @public
+ */
+export interface CapGrantInfo {
+    /**
+     * The cap grant data.
+     */
+    cap_grant: ZomeCallCapGrant;
+    /**
+     * The action hash of the cap grant.
+     */
+    action_hash: ActionHash;
+    /**
+     * The timestamp when the cap grant was created.
+     */
+    created_at: Timestamp;
+    /**
+     * The timestamp when the cap grant was revoked, if it was revoked.
+     */
+    revoked_at?: Timestamp;
+}
 /**
  * @public
  */
@@ -924,7 +970,7 @@ export interface DumpNetworkMetricsRequest {
     /**
      * The DNA hash of the app network to dump.
      */
-    dna?: DnaHash;
+    dna_hash?: DnaHash;
     /**
      * Include DHT summary in the response.
      */
@@ -1124,7 +1170,6 @@ export interface AdminApi {
     dumpState: Requester<DumpStateRequest, DumpStateResponse>;
     dumpFullState: Requester<DumpFullStateRequest, DumpFullStateResponse>;
     generateAgentPubKey: Requester<GenerateAgentPubKeyRequest, GenerateAgentPubKeyResponse>;
-    registerDna: Requester<RegisterDnaRequest, RegisterDnaResponse>;
     getDnaDefinition: Requester<GetDnaDefinitionRequest, GetDnaDefinitionResponse>;
     uninstallApp: Requester<UninstallAppRequest, UninstallAppResponse>;
     installApp: Requester<InstallAppRequest, InstallAppResponse>;
@@ -1134,8 +1179,11 @@ export interface AdminApi {
     listAppInterfaces: Requester<ListAppInterfacesRequest, ListAppInterfacesResponse>;
     agentInfo: Requester<AgentInfoRequest, AgentInfoResponse>;
     addAgentInfo: Requester<AddAgentInfoRequest, AddAgentInfoResponse>;
+    peerMetaInfo: Requester<PeerMetaInfoRequest, PeerMetaInfoResponse>;
     deleteCloneCell: Requester<DeleteCloneCellRequest, DeleteCloneCellResponse>;
     grantZomeCallCapability: Requester<GrantZomeCallCapabilityRequest, GrantZomeCallCapabilityResponse>;
+    revokeZomeCallCapability: Requester<RevokeZomeCallCapabilityRequest, RevokeZomeCallCapabilityResponse>;
+    listCapabilityGrants: Requester<ListCapabilityGrantsRequest, ListCapabilityGrantsResponse>;
     storageInfo: Requester<StorageInfoRequest, StorageInfoResponse>;
     issueAppAuthenticationToken: Requester<IssueAppAuthenticationTokenRequest, IssueAppAuthenticationTokenResponse>;
     dumpNetworkStats: Requester<DumpNetworkStatsRequest, DumpNetworkStatsResponse>;

package/lib/api/admin/types.js

@@ -48,7 +48,4 @@ export var AppStatusFilter;
 (function (AppStatusFilter) {
     AppStatusFilter["Enabled"] = "enabled";
     AppStatusFilter["Disabled"] = "disabled";
-    AppStatusFilter["Running"] = "running";
-    AppStatusFilter["Stopped"] = "stopped";
-    AppStatusFilter["Paused"] = "paused";
 })(AppStatusFilter || (AppStatusFilter = {}));

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, DumpNetworkMetricsRequest, DumpNetworkMetricsResponse, DumpNetworkStatsRequest, DumpNetworkStatsResponse, DumpStateRequest, DumpStateResponse, EnableAppRequest, EnableAppResponse, GenerateAgentPubKeyRequest, GenerateAgentPubKeyResponse, 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";
+import { AddAgentInfoRequest, AddAgentInfoResponse, AdminApi, AgentInfoRequest, AgentInfoResponse, PeerMetaInfoResponse, PeerMetaInfoRequest, AttachAppInterfaceRequest, AttachAppInterfaceResponse, DeleteCloneCellRequest, DeleteCloneCellResponse, DisableAppRequest, DisableAppResponse, DumpFullStateRequest, DumpFullStateResponse, DumpNetworkMetricsRequest, DumpNetworkMetricsResponse, DumpNetworkStatsRequest, DumpNetworkStatsResponse, DumpStateRequest, DumpStateResponse, EnableAppRequest, EnableAppResponse, GenerateAgentPubKeyRequest, GenerateAgentPubKeyResponse, GetDnaDefinitionRequest, GetDnaDefinitionResponse, GrantZomeCallCapabilityRequest, GrantZomeCallCapabilityResponse, InstallAppRequest, InstallAppResponse, IssueAppAuthenticationTokenRequest, IssueAppAuthenticationTokenResponse, ListAppInterfacesRequest, ListAppInterfacesResponse, ListAppsRequest, ListAppsResponse, ListCellIdsRequest, ListCellIdsResponse, ListDnasRequest, ListDnasResponse, RevokeZomeCallCapabilityRequest, RevokeZomeCallCapabilityResponse, RevokeAgentKeyRequest, RevokeAgentKeyResponse, StorageInfoRequest, StorageInfoResponse, UninstallAppRequest, UninstallAppResponse, UpdateCoordinatorsRequest, UpdateCoordinatorsResponse, ListCapabilityGrantsRequest, ListCapabilityGrantsResponse } from "./types.js";
 /**
  * A class for interacting with a conductor's Admin API.
  *
@@ -55,12 +55,6 @@ export declare class AdminWebsocket implements AdminApi {
      * Generate a new agent pub key.
      */
     revokeAgentKey: Requester<RevokeAgentKeyRequest, RevokeAgentKeyResponse>;
-    /**
-     * Register a DNA for later app installation.
-     *
-     * Stores the given DNA into the Holochain DNA database and returns the hash of it.
-     */
-    registerDna: Requester<RegisterDnaRequest, RegisterDnaResponse>;
     /**
      * Get the DNA definition for the specified DNA hash.
      */
@@ -101,6 +95,10 @@ export declare class AdminWebsocket implements AdminApi {
      * Add an existing agent to Holochain.
      */
     addAgentInfo: Requester<AddAgentInfoRequest, AddAgentInfoResponse>;
+    /**
+     * Request peer meta info for a peer.
+     */
+    peerMetaInfo: Requester<PeerMetaInfoRequest, PeerMetaInfoResponse>;
     /**
      * Delete a disabled clone cell.
      */
@@ -110,6 +108,15 @@ export declare class AdminWebsocket implements AdminApi {
      * calls.
      */
     grantZomeCallCapability: Requester<GrantZomeCallCapabilityRequest, GrantZomeCallCapabilityResponse>;
+    /**
+     * Revoke a zome call capability for an agent, which was previously granted
+     * using {@link AdminWebsocket.grantZomeCallCapability}.
+     */
+    revokeZomeCallCapability: Requester<RevokeZomeCallCapabilityRequest, RevokeZomeCallCapabilityResponse>;
+    /**
+     * List all capability grants for all cells.
+     */
+    listCapabilityGrants: Requester<ListCapabilityGrantsRequest, ListCapabilityGrantsResponse>;
     storageInfo: Requester<StorageInfoRequest, StorageInfoResponse>;
     issueAppAuthenticationToken: Requester<IssueAppAuthenticationTokenRequest, IssueAppAuthenticationTokenResponse>;
     dumpNetworkStats: Requester<DumpNetworkStatsRequest, DumpNetworkStatsResponse>;

package/lib/api/admin/websocket.js

@@ -71,12 +71,6 @@ export class AdminWebsocket {
      * Generate a new agent pub key.
      */
     revokeAgentKey = this._requester("revoke_agent_key");
-    /**
-     * Register a DNA for later app installation.
-     *
-     * Stores the given DNA into the Holochain DNA database and returns the hash of it.
-     */
-    registerDna = this._requester("register_dna");
     /**
      * Get the DNA definition for the specified DNA hash.
      */
@@ -117,6 +111,10 @@ export class AdminWebsocket {
      * Add an existing agent to Holochain.
      */
     addAgentInfo = this._requester("add_agent_info");
+    /**
+     * Request peer meta info for a peer.
+     */
+    peerMetaInfo = this._requester("peer_meta_info");
     /**
      * Delete a disabled clone cell.
      */
@@ -126,6 +124,15 @@ export class AdminWebsocket {
      * calls.
      */
     grantZomeCallCapability = this._requester("grant_zome_call_capability");
+    /**
+     * Revoke a zome call capability for an agent, which was previously granted
+     * using {@link AdminWebsocket.grantZomeCallCapability}.
+     */
+    revokeZomeCallCapability = this._requester("revoke_zome_call_capability");
+    /**
+     * List all capability grants for all cells.
+     */
+    listCapabilityGrants = this._requester("list_capability_grants");
     storageInfo = this._requester("storage_info");
     issueAppAuthenticationToken = this._requester("issue_app_authentication_token");
     dumpNetworkStats = this._requester("dump_network_stats");

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

@@ -1,6 +1,6 @@
 import { UnsubscribeFunction } from "emittery";
 import { AgentPubKey, InstalledAppId, RoleName } from "../../types.js";
-import { AgentInfoRequest, AgentInfoResponse, AppInfo, ClonedCell, DumpNetworkMetricsRequest, DumpNetworkMetricsResponse, DumpNetworkStatsResponse, MemproofMap } from "../admin/index.js";
+import { AgentInfoRequest, AgentInfoResponse, PeerMetaInfoRequest, PeerMetaInfoResponse, AppInfo, DumpNetworkMetricsRequest, DumpNetworkMetricsResponse, DumpNetworkStatsResponse, MemproofMap } from "../admin/index.js";
 import { WsClient } from "../client.js";
 import { AbandonCountersigningSessionStateRequest, AppClient, AppEvents, AppWebsocketConnectionOptions, CallZomeRequest, CallZomeRequestSigned, CreateCloneCellRequest, DisableCloneCellRequest, EnableCloneCellRequest, GetCountersigningSessionStateRequest, GetCountersigningSessionStateResponse, PublishCountersigningSessionStateRequest, RoleNameCallZomeRequest, SignalCb } from "./types.js";
 /**
@@ -19,6 +19,7 @@ export declare class AppWebsocket implements AppClient {
     cachedAppInfo?: AppInfo | null;
     private readonly appInfoRequester;
     private readonly agentInfoRequester;
+    private readonly peerMetaInfoRequester;
     private readonly callZomeRequester;
     private readonly provideMemproofRequester;
     private readonly enableAppRequester;
@@ -34,7 +35,6 @@ export declare class AppWebsocket implements AppClient {
     /**
      * Instance factory for creating an {@link AppWebsocket}.
      *
-     * @param token - A token to authenticate the websocket connection. Get a token using AdminWebsocket#issueAppAuthenticationToken.
      * @param options - {@link (WebsocketConnectionOptions:interface)}
      * @returns A new instance of an AppWebsocket.
      */
@@ -50,9 +50,18 @@ export declare class AppWebsocket implements AppClient {
      * Request the currently known agents of the app.
      *
      * @param req - An array of DNA hashes or null
+     * @param timeout - A timeout to override the default.
      * @returns The app's agent infos as JSON string.
      */
     agentInfo(req: AgentInfoRequest, timeout?: number): Promise<AgentInfoResponse>;
+    /**
+     * Request peer meta info for a peer by Url.
+     *
+     * @param req - The peer Url of the agent and an optional array of DNA hashes
+     * @param timeout - A timeout to override the default.
+     * @returns The meta info stored for this peer URL.
+     */
+    peerMetaInfo(req: PeerMetaInfoRequest, timeout?: number): Promise<PeerMetaInfoResponse>;
     /**
      * Request network stats.
      *
@@ -98,14 +107,14 @@ export declare class AppWebsocket implements AppClient {
      * @param args - Specify the cell to clone.
      * @returns The created clone cell.
      */
-    createCloneCell(args: CreateCloneCellRequest): Promise<ClonedCell>;
+    createCloneCell(args: CreateCloneCellRequest): Promise<import("../admin/types.js").ClonedCell>;
     /**
      * Enable a disabled clone cell.
      *
      * @param args - Specify the clone cell to enable.
      * @returns The enabled clone cell.
      */
-    enableCloneCell(args: EnableCloneCellRequest): Promise<ClonedCell>;
+    enableCloneCell(args: EnableCloneCellRequest): Promise<import("../admin/types.js").ClonedCell>;
     /**
      * Disable an enabled clone cell.
      *

package/lib/api/app/websocket.js

@@ -25,6 +25,7 @@ export class AppWebsocket {
     cachedAppInfo;
     appInfoRequester;
     agentInfoRequester;
+    peerMetaInfoRequester;
     callZomeRequester;
     provideMemproofRequester;
     enableAppRequester;
@@ -46,6 +47,7 @@ export class AppWebsocket {
         this.cachedAppInfo = appInfo;
         this.appInfoRequester = AppWebsocket.requester(this.client, "app_info", this.defaultTimeout);
         this.agentInfoRequester = AppWebsocket.requester(this.client, "agent_info", this.defaultTimeout);
+        this.peerMetaInfoRequester = AppWebsocket.requester(this.client, "peer_meta_info", this.defaultTimeout);
         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);
@@ -73,7 +75,6 @@ export class AppWebsocket {
     /**
      * Instance factory for creating an {@link AppWebsocket}.
      *
-     * @param token - A token to authenticate the websocket connection. Get a token using AdminWebsocket#issueAppAuthenticationToken.
      * @param options - {@link (WebsocketConnectionOptions:interface)}
      * @returns A new instance of an AppWebsocket.
      */
@@ -115,11 +116,21 @@ export class AppWebsocket {
      * Request the currently known agents of the app.
      *
      * @param req - An array of DNA hashes or null
+     * @param timeout - A timeout to override the default.
      * @returns The app's agent infos as JSON string.
      */
     async agentInfo(req, timeout) {
-        const agentInfos = await this.agentInfoRequester(req, timeout);
-        return agentInfos;
+        return await this.agentInfoRequester(req, timeout);
+    }
+    /**
+     * Request peer meta info for a peer by Url.
+     *
+     * @param req - The peer Url of the agent and an optional array of DNA hashes
+     * @param timeout - A timeout to override the default.
+     * @returns The meta info stored for this peer URL.
+     */
+    async peerMetaInfo(req, timeout) {
+        return await this.peerMetaInfoRequester(req, timeout);
     }
     /**
      * Request network stats.

package/lib/api/client.d.ts

@@ -20,7 +20,7 @@ export interface AppAuthenticationRequest {
 export declare class WsClient extends Emittery {
     socket: IsoWebSocket;
     url: URL | undefined;
-    options: WsClientOptions;
+    options: WsClientOptions | undefined;
     private pendingRequests;
     private index;
     private authenticationToken;

package/lib/api/client.js

@@ -25,7 +25,7 @@ export class WsClient extends Emittery {
         this.registerCloseListener(socket);
         this.socket = socket;
         this.url = url;
-        this.options = options || {};
+        this.options = options;
         this.pendingRequests = {};
         this.index = 0;
     }

package/lib/tsdoc-metadata.json

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

package/package.json

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