@holochain/client 0.12.5 → 0.12.7

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

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Action, DhtOp, Entry, ZomeCallCapGrant } from "../../hdk/index.js";
 import { ActionHash, AgentPubKey, CellId, DnaHash, DnaProperties, Duration, HoloHash, HoloHashB64, InstalledAppId, KitsuneAgent, KitsuneSpace, RoleName, Signature, Timestamp, WasmHash } from "../../types.js";
 import { Requester } from "../common.js";
@@ -6,32 +5,32 @@ import { DisableCloneCellRequest } from "../index.js";
 /**
  * @public
  */
-export declare type AttachAppInterfaceRequest = {
-    port: number;
+export type AttachAppInterfaceRequest = {
+    port?: number;
 };
 /**
  * @public
  */
-export declare type AttachAppInterfaceResponse = {
+export type AttachAppInterfaceResponse = {
     port: number;
 };
 /**
  * @public
  */
-export declare type EnableAppRequest = {
+export type EnableAppRequest = {
     installed_app_id: InstalledAppId;
 };
 /**
  * @public
  */
-export declare type EnableAppResponse = {
+export type EnableAppResponse = {
     app: AppInfo;
     errors: Array<[CellId, string]>;
 };
 /**
  * @public
  */
-export declare type DeactivationReason = {
+export type DeactivationReason = {
     never_activated: null;
 } | {
     normal: null;
@@ -43,13 +42,13 @@ export declare type DeactivationReason = {
 /**
  * @public
  */
-export declare type PausedAppReason = {
+export type PausedAppReason = {
     error: string;
 };
 /**
  * @public
  */
-export declare type DisabledAppReason = {
+export type DisabledAppReason = {
     never_started: null;
 } | {
     user: null;
@@ -59,7 +58,7 @@ export declare type DisabledAppReason = {
 /**
  * @public
  */
-export declare type InstalledAppInfoStatus = {
+export type InstalledAppInfoStatus = {
     paused: {
         reason: PausedAppReason;
     };
@@ -108,7 +107,7 @@ export declare enum CellType {
 /**
  * @public
  */
-export declare type CellInfo = {
+export type CellInfo = {
     [CellType.Provisioned]: ProvisionedCell;
 } | {
     [CellType.Cloned]: ClonedCell;
@@ -118,7 +117,7 @@ export declare type CellInfo = {
 /**
  * @public
  */
-export declare type AppInfo = {
+export type AppInfo = {
     agent_pub_key: AgentPubKey;
     installed_app_id: InstalledAppId;
     cell_info: Record<RoleName, Array<CellInfo>>;
@@ -127,60 +126,60 @@ export declare type AppInfo = {
 /**
  * @public
  */
-export declare type MembraneProof = Buffer;
+export type MembraneProof = Uint8Array;
 /**
  * @public
  */
-export declare type DisableAppRequest = {
+export type DisableAppRequest = {
     installed_app_id: InstalledAppId;
 };
 /**
  * @public
  */
-export declare type DisableAppResponse = null;
+export type DisableAppResponse = null;
 /**
  * @public
  */
-export declare type StartAppRequest = {
+export type StartAppRequest = {
     installed_app_id: InstalledAppId;
 };
 /**
  * @public
  */
-export declare type StartAppResponse = boolean;
+export type StartAppResponse = boolean;
 /**
  * @public
  */
-export declare type DumpStateRequest = {
+export type DumpStateRequest = {
     cell_id: CellId;
 };
 /**
  * @public
  */
-export declare type DumpStateResponse = any;
+export type DumpStateResponse = any;
 /**
  * @public
  */
-export declare type DumpFullStateRequest = {
+export type DumpFullStateRequest = {
     cell_id: CellId;
-    dht_ops_cursor: number | undefined;
+    dht_ops_cursor?: number;
 };
 /**
  * @public
  */
-export declare type DumpFullStateResponse = FullStateDump;
+export type DumpFullStateResponse = FullStateDump;
 /**
  * @public
  */
-export declare type GenerateAgentPubKeyRequest = void;
+export type GenerateAgentPubKeyRequest = void;
 /**
  * @public
  */
-export declare type GenerateAgentPubKeyResponse = AgentPubKey;
+export type GenerateAgentPubKeyResponse = AgentPubKey;
 /**
  * @public
  */
-export declare type RegisterDnaRequest = {
+export type RegisterDnaRequest = {
     modifiers?: {
         network_seed?: string;
         properties?: DnaProperties;
@@ -189,28 +188,28 @@ export declare type RegisterDnaRequest = {
 /**
  * @public
  */
-export declare type RegisterDnaResponse = HoloHash;
+export type RegisterDnaResponse = HoloHash;
 /**
  * @public
  */
-export declare type DnaModifiers = {
+export type DnaModifiers = {
     network_seed: NetworkSeed;
-    properties: DnaProperties;
+    properties: Uint8Array;
     origin_time: Timestamp;
     quantum_time: Duration;
 };
 /**
  * @public
  */
-export declare type FunctionName = string;
+export type FunctionName = string;
 /**
  * @public
  */
-export declare type ZomeName = string;
+export type ZomeName = string;
 /**
  * @public
  */
-export declare type ZomeDefinition = [
+export type ZomeDefinition = [
     ZomeName,
     {
         wasm_hash: WasmHash;
@@ -220,15 +219,15 @@ export declare type ZomeDefinition = [
 /**
  * @public
  */
-export declare type IntegrityZome = ZomeDefinition;
+export type IntegrityZome = ZomeDefinition;
 /**
  * @public
  */
-export declare type CoordinatorZome = ZomeDefinition;
+export type CoordinatorZome = ZomeDefinition;
 /**
  * @public
  */
-export declare type DnaDefinition = {
+export type DnaDefinition = {
     name: string;
     modifiers: DnaModifiers;
     integrity_zomes: IntegrityZome[];
@@ -237,29 +236,39 @@ export declare type DnaDefinition = {
 /**
  * @public
  */
-export declare type GetDnaDefinitionRequest = DnaHash;
+export type GetDnaDefinitionRequest = DnaHash;
 /**
  * @public
  */
-export declare type GetDnaDefinitionResponse = DnaDefinition;
+export type GetDnaDefinitionResponse = DnaDefinition;
 /**
  * @public
  */
-export declare type UninstallAppRequest = {
+export type UninstallAppRequest = {
     installed_app_id: InstalledAppId;
 };
 /**
  * @public
  */
-export declare type UninstallAppResponse = null;
+export type UninstallAppResponse = null;
+/**
+ * @public
+ */
+export type UpdateCoordinatorsRequest = {
+    dna_hash: DnaHash;
+} & CoordinatorSource;
 /**
  * @public
  */
-export declare type ResourceBytes = Uint8Array;
+export type UpdateCoordinatorsResponse = void;
 /**
  * @public
  */
-export declare type ResourceMap = {
+export type ResourceBytes = Uint8Array;
+/**
+ * @public
+ */
+export type ResourceMap = {
     [key: string]: ResourceBytes;
 };
 /**
@@ -297,7 +306,7 @@ export interface CellProvisioning {
 /**
  * @public
  */
-export declare type Location = {
+export type Location = {
     /**
      * Expect file to be part of this bundle
      */
@@ -316,11 +325,11 @@ export declare type Location = {
 /**
  * @public
  */
-export declare type DnaVersionSpec = Array<HoloHashB64>;
+export type DnaVersionSpec = Array<HoloHashB64>;
 /**
  * @public
  */
-export declare type DnaVersionFlexible = {
+export type DnaVersionFlexible = {
     singleton: HoloHashB64;
 } | {
     multiple: DnaVersionSpec;
@@ -328,7 +337,7 @@ export declare type DnaVersionFlexible = {
 /**
  * @public
  */
-export declare type AppRoleDnaManifest = {
+export type AppRoleDnaManifest = {
     clone_limit?: number;
     modifiers?: Partial<DnaModifiers>;
     version?: DnaVersionFlexible;
@@ -336,7 +345,7 @@ export declare type AppRoleDnaManifest = {
 /**
  * @public
  */
-export declare type AppRoleManifest = {
+export type AppRoleManifest = {
     name: RoleName;
     provisioning?: CellProvisioning;
     dna: AppRoleDnaManifest;
@@ -344,7 +353,7 @@ export declare type AppRoleManifest = {
 /**
  * @public
  */
-export declare type AppManifest = {
+export type AppManifest = {
     manifest_version: string;
     name: string;
     description?: string;
@@ -353,14 +362,14 @@ export declare type AppManifest = {
 /**
  * @public
  */
-export declare type AppBundle = {
+export type AppBundle = {
     manifest: AppManifest;
     resources: ResourceMap;
 };
 /**
  * @public
  */
-export declare type AppBundleSource = {
+export type AppBundleSource = {
     bundle: AppBundle;
 } | {
     path: string;
@@ -368,46 +377,67 @@ export declare type AppBundleSource = {
 /**
  * @public
  */
-export declare type NetworkSeed = string;
+export type NetworkSeed = string;
 /**
  * @public
  */
-export declare type InstallAppRequest = {
+export type InstallAppRequest = {
+    /**
+     * The agent to use when creating Cells for this App.
+     */
     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.
+     */
     installed_app_id?: InstalledAppId;
+    /**
+     * Include proof-of-membrane-membership data for cells that require it,
+     * keyed by the CellNick specified in the app bundle manifest.
+     */
     membrane_proofs: {
         [key: string]: MembraneProof;
     };
+    /**
+     * Optional global network seed override.  If set will override the network seed value for all
+     * DNAs in the bundle.
+     */
     network_seed?: NetworkSeed;
+    /**
+     * Optional: If app installation fails due to genesis failure, normally the app will be immediately uninstalled.
+     * When this flag is set, the app is left installed with empty cells intact. This can be useful for
+     * using graft_records_onto_source_chain, or for diagnostics.
+     */
+    ignore_genesis_failure?: boolean;
 } & AppBundleSource;
 /**
  * @public
  */
-export declare type InstallAppResponse = AppInfo;
+export type InstallAppResponse = AppInfo;
 /**
  * @public
  */
-export declare type ListDnasRequest = void;
+export type ListDnasRequest = void;
 /**
  * @public
  */
-export declare type ListDnasResponse = Array<string>;
+export type ListDnasResponse = Array<string>;
 /**
  * @public
  */
-export declare type ListCellIdsRequest = void;
+export type ListCellIdsRequest = void;
 /**
  * @public
  */
-export declare type ListCellIdsResponse = Array<CellId>;
+export type ListCellIdsResponse = Array<CellId>;
 /**
  * @public
  */
-export declare type ListActiveAppsRequest = void;
+export type ListActiveAppsRequest = void;
 /**
  * @public
  */
-export declare type ListActiveAppsResponse = Array<InstalledAppId>;
+export type ListActiveAppsResponse = Array<InstalledAppId>;
 /**
  * @public
  */
@@ -421,55 +451,55 @@ export declare enum AppStatusFilter {
 /**
  * @public
  */
-export declare type ListAppsRequest = {
+export type ListAppsRequest = {
     status_filter?: AppStatusFilter;
 };
 /**
  * @public
  */
-export declare type ListAppsResponse = Array<AppInfo>;
+export type ListAppsResponse = Array<AppInfo>;
 /**
  * @public
  */
-export declare type ListAppInterfacesRequest = void;
+export type ListAppInterfacesRequest = void;
 /**
  * @public
  */
-export declare type ListAppInterfacesResponse = Array<number>;
+export type ListAppInterfacesResponse = Array<number>;
 /**
  * This type is meant to be opaque
  *
  * @public
  */
-export declare type AgentInfoSigned = unknown;
+export type AgentInfoSigned = unknown;
 /**
  * @public
  */
-export declare type AgentInfoRequest = {
+export type AgentInfoRequest = {
     cell_id: CellId | null;
 };
 /**
  * @public
  */
-export declare type AgentInfoResponse = Array<AgentInfoSigned>;
+export type AgentInfoResponse = Array<AgentInfoSigned>;
 /**
  * @public
  */
-export declare type AddAgentInfoRequest = {
+export type AddAgentInfoRequest = {
     agent_infos: Array<AgentInfoSigned>;
 };
 /**
  * @public
  */
-export declare type AddAgentInfoResponse = any;
+export type AddAgentInfoResponse = any;
 /**
  * @public
  */
-export declare type DeleteCloneCellRequest = DisableCloneCellRequest;
+export type DeleteCloneCellRequest = DisableCloneCellRequest;
 /**
  * @public
  */
-export declare type DeleteCloneCellResponse = void;
+export type DeleteCloneCellResponse = void;
 /**
  * @public
  */
@@ -487,11 +517,11 @@ export interface GrantZomeCallCapabilityRequest {
 /**
  * @public
  */
-export declare type GrantZomeCallCapabilityResponse = void;
+export type GrantZomeCallCapabilityResponse = void;
 /**
  * @public
  */
-export declare type InstallAppDnaPayload = {
+export type InstallAppDnaPayload = {
     hash: HoloHash;
     role_name: RoleName;
     membrane_proof?: MembraneProof;
@@ -499,18 +529,46 @@ export declare type InstallAppDnaPayload = {
 /**
  * @public
  */
-export declare type ZomeLocation = Location;
+export type ZomeLocation = Location;
+/**
+ * @public
+ */
+export interface ZomeDependency {
+    name: ZomeName;
+}
 /**
  * @public
  */
-export declare type ZomeManifest = {
+export type ZomeManifest = {
     name: string;
     hash?: string;
+    dependencies?: ZomeDependency[];
 } & ZomeLocation;
 /**
  * @public
  */
-export declare type DnaManifest = {
+export interface CoordinatorManifest {
+    zomes: Array<ZomeManifest>;
+}
+/**
+ * @public
+ */
+export interface CoordinatorBundle {
+    manifest: CoordinatorManifest;
+    resources: ResourceMap;
+}
+/**
+ * @public
+ */
+export type CoordinatorSource = {
+    path: string;
+} | {
+    bundle: CoordinatorBundle;
+};
+/**
+ * @public
+ */
+export type DnaManifest = {
     /**
      * Currently one "1" is supported
      */
@@ -536,14 +594,14 @@ export declare type DnaManifest = {
 /**
  * @public
  */
-export declare type DnaBundle = {
+export type DnaBundle = {
     manifest: DnaManifest;
     resources: ResourceMap;
 };
 /**
  * @public
  */
-export declare type DnaSource = {
+export type DnaSource = {
     hash: HoloHash;
 } | {
     path: string;
@@ -553,13 +611,13 @@ export declare type DnaSource = {
 /**
  * @public
  */
-export declare type Zomes = Array<[string, {
+export type Zomes = Array<[string, {
     wasm_hash: Array<HoloHash>;
 }]>;
 /**
  * @public
  */
-export declare type WasmCode = [HoloHash, {
+export type WasmCode = [HoloHash, {
     code: Array<number>;
 }];
 /**
@@ -624,6 +682,46 @@ export interface FullStateDump {
     source_chain_dump: SourceChainJsonDump;
     integration_dump: FullIntegrationStateDump;
 }
+/**
+ * @public
+ */
+export interface DnaStorageInfo {
+    authored_data_size: number;
+    authored_data_size_on_disk: number;
+    dht_data_size: number;
+    dht_data_size_on_disk: number;
+    cache_data_size: number;
+    cache_data_size_on_disk: number;
+    used_by: Array<InstalledAppId>;
+}
+/**
+ * @public
+ */
+export interface DnaStorageBlob {
+    dna: DnaStorageInfo;
+}
+/**
+ * @public
+ */
+export interface StorageInfo {
+    blobs: Array<DnaStorageBlob>;
+}
+/**
+ * @public
+ */
+export type StorageInfoRequest = void;
+/**
+ * @public
+ */
+export type StorageInfoResponse = StorageInfo;
+/**
+ * @public
+ */
+export type DumpNetworkStatsRequest = void;
+/**
+ * @public
+ */
+export type DumpNetworkStatsResponse = string;
 /**
  * @public
  */
@@ -646,4 +744,6 @@ export interface AdminApi {
     addAgentInfo: Requester<AddAgentInfoRequest, AddAgentInfoResponse>;
     deleteCloneCell: Requester<DeleteCloneCellRequest, DeleteCloneCellResponse>;
     grantZomeCallCapability: Requester<GrantZomeCallCapabilityRequest, GrantZomeCallCapabilityResponse>;
+    storageInfo: Requester<StorageInfoRequest, StorageInfoResponse>;
+    dumpNetworkStats: Requester<DumpNetworkStatsRequest, DumpNetworkStatsResponse>;
 }

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

@@ -2,7 +2,7 @@ import { CapSecret, GrantedFunctions } from "../../hdk/capabilities.js";
 import type { AgentPubKey, CellId } from "../../types.js";
 import { WsClient } from "../client.js";
 import { Requester, Transformer } from "../common.js";
-import { AddAgentInfoRequest, AddAgentInfoResponse, AdminApi, AgentInfoRequest, AgentInfoResponse, AttachAppInterfaceRequest, AttachAppInterfaceResponse, DeleteCloneCellRequest, DeleteCloneCellResponse, DisableAppRequest, DisableAppResponse, DumpFullStateRequest, DumpFullStateResponse, DumpStateRequest, DumpStateResponse, EnableAppRequest, EnableAppResponse, GenerateAgentPubKeyRequest, GenerateAgentPubKeyResponse, GetDnaDefinitionRequest, GetDnaDefinitionResponse, GrantZomeCallCapabilityRequest, GrantZomeCallCapabilityResponse, InstallAppRequest, InstallAppResponse, ListAppInterfacesRequest, ListAppInterfacesResponse, ListAppsRequest, ListAppsResponse, ListCellIdsRequest, ListCellIdsResponse, ListDnasRequest, ListDnasResponse, RegisterDnaRequest, RegisterDnaResponse, UninstallAppRequest, UninstallAppResponse } 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, GetDnaDefinitionRequest, GetDnaDefinitionResponse, GrantZomeCallCapabilityRequest, GrantZomeCallCapabilityResponse, InstallAppRequest, InstallAppResponse, ListAppInterfacesRequest, ListAppInterfacesResponse, ListAppsRequest, ListAppsResponse, ListCellIdsRequest, ListCellIdsResponse, ListDnasRequest, ListDnasResponse, RegisterDnaRequest, RegisterDnaResponse, StorageInfoRequest, StorageInfoResponse, UninstallAppRequest, UninstallAppResponse, UpdateCoordinatorsRequest, UpdateCoordinatorsResponse } from "./types.js";
 /**
  * A class for interacting with a conductor's Admin API.
  *
@@ -25,7 +25,7 @@ export declare class AdminWebsocket implements AdminApi {
      * @param defaultTimeout - The default timeout for any request.
      * @returns A promise for a new connected instance.
      */
-    static connect(url: string, defaultTimeout?: number): Promise<AdminWebsocket>;
+    static connect(url: URL, defaultTimeout?: number): Promise<AdminWebsocket>;
     _requester<ReqI, ReqO, ResI, ResO>(tag: string, transformer?: Transformer<ReqI, ReqO, ResI, ResO>): (req: ReqI, timeout?: number | undefined) => Promise<ResO>;
     /**
      * Send a request to open the given port for {@link AppWebsocket} connections.
@@ -70,6 +70,10 @@ export declare class AdminWebsocket implements AdminApi {
      * Install the specified app into Holochain.
      */
     installApp: Requester<InstallAppRequest, InstallAppResponse>;
+    /**
+     * Update coordinators for an installed app.
+     */
+    updateCoordinators: Requester<UpdateCoordinatorsRequest, UpdateCoordinatorsResponse>;
     /**
      * List all registered DNAs.
      */
@@ -103,6 +107,8 @@ export declare class AdminWebsocket implements AdminApi {
      * calls.
      */
     grantZomeCallCapability: Requester<GrantZomeCallCapabilityRequest, GrantZomeCallCapabilityResponse>;
+    storageInfo: Requester<StorageInfoRequest, StorageInfoResponse>;
+    dumpNetworkStats: Requester<DumpNetworkStatsRequest, DumpNetworkStatsResponse>;
     /**
      * Grant a capability for signing zome calls.
      *

package/lib/api/admin/websocket.js

@@ -34,7 +34,7 @@ export class AdminWebsocket {
         // Check if we are in the launcher's environment, and if so, redirect the url to connect to
         const env = getLauncherEnvironment();
         if (env?.ADMIN_INTERFACE_PORT) {
-            url = `ws://127.0.0.1:${env.ADMIN_INTERFACE_PORT}`;
+            url = new URL(`ws://127.0.0.1:${env.ADMIN_INTERFACE_PORT}`);
         }
         const wsClient = await WsClient.connect(url);
         return new AdminWebsocket(wsClient, defaultTimeout);
@@ -85,6 +85,10 @@ export class AdminWebsocket {
      * Install the specified app into Holochain.
      */
     installApp = this._requester("install_app");
+    /**
+     * Update coordinators for an installed app.
+     */
+    updateCoordinators = this._requester("update_coordinators");
     /**
      * List all registered DNAs.
      */
@@ -118,6 +122,8 @@ export class AdminWebsocket {
      * calls.
      */
     grantZomeCallCapability = this._requester("grant_zome_call_capability");
+    storageInfo = this._requester("storage_info");
+    dumpNetworkStats = this._requester("dump_network_stats");
     // zome call signing related methods
     /**
      * Grant a capability for signing zome calls.
@@ -153,7 +159,7 @@ export class AdminWebsocket {
      * granted for all zomes and functions.
      */
     authorizeSigningCredentials = async (cellId, functions) => {
-        const [keyPair, signingKey] = generateSigningKeyPair();
+        const [keyPair, signingKey] = await generateSigningKeyPair();
         const capSecret = await this.grantSigningKey(cellId, functions || { [GrantedFunctionsType.All]: null }, signingKey);
         setSigningCredentials(cellId, { capSecret, keyPair, signingKey });
     };