@holochain/client 0.19.0 → 0.19.2

package/README.md

@@ -38,7 +38,7 @@ import {
   CellType,
   type ActionHash,
   type CallZomeRequest,
-} from "@holochain/client";
+} from "./lib/index.js";
 
 const adminWs = await AdminWebsocket.connect({
   url: new URL("ws://127.0.0.1:65000"),
@@ -48,16 +48,18 @@ const agent_key = await adminWs.generateAgentPubKey();
 const role_name = "foo";
 const installed_app_id = "test-app";
 const appInfo = await adminWs.installApp({
+  source: {
+    type: "path",
+    value: "./test/e2e/fixture/test.happ",
+  },
   agent_key,
-  path: "./test/e2e/fixture/test.happ",
   installed_app_id,
-  membrane_proofs: {},
 });
 await adminWs.enableApp({ installed_app_id });
-if (!(CellType.Provisioned in appInfo.cell_info[role_name][0])) {
+if (appInfo.cell_info[role_name][0].type !== CellType.Provisioned) {
   throw new Error(`No cell found under role name ${role_name}`);
 }
-const { cell_id } = appInfo.cell_info[role_name][0][CellType.Provisioned];
+const { cell_id } = appInfo.cell_info[role_name][0].value;
 await adminWs.authorizeSigningCredentials(cell_id);
 await adminWs.attachAppInterface({ port: 65001, allowed_origins: "my-happ" });
 const issuedToken = await adminWs.issueAppAuthenticationToken({
@@ -86,7 +88,7 @@ await adminWs.client.close();
 
 ### Subscribe to signals
 ```typescript
-import { AdminWebsocket, AppWebsocket, CellType } from "@holochain/client";
+import { AdminWebsocket, AppWebsocket, CellType, Signal } from "./lib/index.js";
 
 const adminWs = await AdminWebsocket.connect({
   url: new URL("ws://127.0.0.1:65000"),
@@ -96,16 +98,18 @@ const agent_key = await adminWs.generateAgentPubKey();
 const role_name = "foo";
 const installed_app_id = "test-app";
 const appInfo = await adminWs.installApp({
+  source: {
+    type: "path",
+    value: "./test/e2e/fixture/test.happ",
+  },
   agent_key,
-  path: "./test/e2e/fixture/test.happ",
   installed_app_id,
-  membrane_proofs: {},
 });
 await adminWs.enableApp({ installed_app_id });
-if (!(CellType.Provisioned in appInfo.cell_info[role_name][0])) {
+if (appInfo.cell_info[role_name][0].type !== CellType.Provisioned) {
   throw new Error(`No cell found under role name ${role_name}`);
 }
-const { cell_id } = appInfo.cell_info[role_name][0][CellType.Provisioned];
+const { cell_id } = appInfo.cell_info[role_name][0].value;
 await adminWs.authorizeSigningCredentials(cell_id);
 await adminWs.attachAppInterface({ port: 65001, allowed_origins: "my-happ" });
 const issuedToken = await adminWs.issueAppAuthenticationToken({
@@ -119,7 +123,7 @@ const appWs = await AppWebsocket.connect({
 
 let signalCb;
 const signalReceived = new Promise<void>((resolve) => {
-  signalCb = (signal) => {
+  signalCb = (signal: Signal) => {
     console.log("signal received", signal);
     // act on signal
     resolve();

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

@@ -573,6 +573,24 @@ export type AddAgentInfoRequest = {
  * @public
  */
 export type AddAgentInfoResponse = unknown;
+/**
+ * @public
+ */
+export interface AgentMetaInfoRequest {
+    url: string;
+    dna_hashes?: DnaHash[];
+}
+/**
+ * @public
+ */
+export type AgentMetaInfoResponse = Record<DnaHashB64, Record<string, AgentMetaInfo>>;
+/**
+ * @public
+ */
+export interface AgentMetaInfo {
+    meta_value: string;
+    expires_at: number;
+}
 /**
  * @public
  */
@@ -936,20 +954,15 @@ export interface DumpNetworkMetricsRequest {
  *
  * @public
  */
-export type DhtArc = {
-    /**
-     * No DHT locations are contained within this arc.
-     */
-    type: "empty";
-} | {
-    /**
-     * A specific range of DHT locations are contained within this arc.
-     *
-     * The lower and upper bounds are inclusive.
-     */
-    type: "arc";
-    value: [number, number];
-};
+export type DhtArc = /**
+ * No DHT locations are contained within this arc.
+ */ null
+/**
+ * A specific range of DHT locations are contained within this arc.
+ *
+ * The lower and upper bounds are inclusive.
+ */
+ | [number, number];
 /**
  * Summary of a local agent's network state.
  *

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, AgentMetaInfoResponse, AgentMetaInfoRequest, 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";
 /**
  * A class for interacting with a conductor's Admin API.
  *
@@ -101,6 +101,10 @@ export declare class AdminWebsocket implements AdminApi {
      * Add an existing agent to Holochain.
      */
     addAgentInfo: Requester<AddAgentInfoRequest, AddAgentInfoResponse>;
+    /**
+     * Request agent meta info about an agent.
+     */
+    agentMetaInfo: Requester<AgentMetaInfoRequest, AgentMetaInfoResponse>;
     /**
      * Delete a disabled clone cell.
      */

package/lib/api/admin/websocket.js

@@ -117,6 +117,10 @@ export class AdminWebsocket {
      * Add an existing agent to Holochain.
      */
     addAgentInfo = this._requester("add_agent_info");
+    /**
+     * Request agent meta info about an agent.
+     */
+    agentMetaInfo = this._requester("agent_meta_info");
     /**
      * Delete a disabled clone cell.
      */

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

@@ -48,6 +48,12 @@ export type CallZomeResponse = CallZomeResponseGeneric<any>;
  * @public
  */
 export type AppInfoResponse = AppInfo | null;
+/**
+ * @public
+ */
+export type AppAgentInfoRequest = {
+    dna_hashes: DnaHash[] | null;
+};
 /**
  * @public
  */
@@ -345,6 +351,9 @@ export declare enum SessionCompletionDecisionType {
 export type SessionCompletionDecision = {
     [SessionCompletionDecisionType.Complete]: SignedActionHashed;
 } | SessionCompletionDecisionType.Abandoned | SessionCompletionDecisionType.Indeterminate | SessionCompletionDecisionType.Failed;
+/**
+ * @public
+ */
 export declare enum SignalType {
     App = "app",
     System = "system"

package/lib/api/app/types.js

@@ -45,6 +45,9 @@ export var SessionCompletionDecisionType;
      */
     SessionCompletionDecisionType["Failed"] = "Failed";
 })(SessionCompletionDecisionType || (SessionCompletionDecisionType = {}));
+/**
+ * @public
+ */
 export var SignalType;
 (function (SignalType) {
     SignalType["App"] = "app";

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

@@ -1,8 +1,8 @@
 import { UnsubscribeFunction } from "emittery";
 import { AgentPubKey, InstalledAppId, RoleName } from "../../types.js";
-import { AppInfo, ClonedCell, DumpNetworkMetricsRequest, DumpNetworkMetricsResponse, DumpNetworkStatsResponse, MemproofMap } from "../admin/index.js";
+import { AgentInfoResponse, AgentMetaInfoRequest, AgentMetaInfoResponse, 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";
+import { AbandonCountersigningSessionStateRequest, AppAgentInfoRequest, AppClient, AppEvents, AppWebsocketConnectionOptions, CallZomeRequest, CallZomeRequestSigned, CreateCloneCellRequest, DisableCloneCellRequest, EnableCloneCellRequest, GetCountersigningSessionStateRequest, GetCountersigningSessionStateResponse, PublishCountersigningSessionStateRequest, RoleNameCallZomeRequest, SignalCb } from "./types.js";
 /**
  * A class to establish a websocket connection to an App interface, for a
  * specific agent and app.
@@ -18,6 +18,8 @@ export declare class AppWebsocket implements AppClient {
     private readonly callZomeTransform;
     cachedAppInfo?: AppInfo | null;
     private readonly appInfoRequester;
+    private readonly agentInfoRequester;
+    private readonly agentMetaInfoRequester;
     private readonly callZomeRequester;
     private readonly provideMemproofRequester;
     private readonly enableAppRequester;
@@ -33,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.
      */
@@ -45,6 +46,22 @@ export declare class AppWebsocket implements AppClient {
      * @returns The app's {@link AppInfo}.
      */
     appInfo(timeout?: number): Promise<AppInfo>;
+    /**
+     * 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: AppAgentInfoRequest, timeout?: number): Promise<AgentInfoResponse>;
+    /**
+     * Request agent meta info for an agent by peer 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.
+     */
+    agentMetaInfo(req: AgentMetaInfoRequest, timeout?: number): Promise<AgentMetaInfoResponse>;
     /**
      * Request network stats.
      *
@@ -90,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

@@ -24,6 +24,8 @@ export class AppWebsocket {
     callZomeTransform;
     cachedAppInfo;
     appInfoRequester;
+    agentInfoRequester;
+    agentMetaInfoRequester;
     callZomeRequester;
     provideMemproofRequester;
     enableAppRequester;
@@ -44,6 +46,8 @@ export class AppWebsocket {
         this.emitter = new Emittery();
         this.cachedAppInfo = appInfo;
         this.appInfoRequester = AppWebsocket.requester(this.client, "app_info", this.defaultTimeout);
+        this.agentInfoRequester = AppWebsocket.requester(this.client, "agent_info", this.defaultTimeout);
+        this.agentMetaInfoRequester = AppWebsocket.requester(this.client, "agent_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);
@@ -71,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.
      */
@@ -109,6 +112,26 @@ export class AppWebsocket {
         this.cachedAppInfo = appInfo;
         return appInfo;
     }
+    /**
+     * 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) {
+        return await this.agentInfoRequester(req, timeout);
+    }
+    /**
+     * Request agent meta info for an agent by peer 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 agentMetaInfo(req, timeout) {
+        return await this.agentMetaInfoRequester(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.19.0",
+  "version": "0.19.2",
   "description": "A JavaScript client for the Holochain Conductor API",
   "author": "Holochain Foundation <info@holochain.org> (https://holochain.org)",
   "license": "CAL-1.0",
@@ -18,7 +18,7 @@
   },
   "homepage": "https://github.com/holochain/holochain-client-js#readme",
   "engines": {
-    "node": ">=18.0.0 || >=20.0.0"
+    "node": ">=18.0.0 || >=20.0.0 || >=22.0.0"
   },
   "main": "lib/index.js",
   "module": "lib/index.js",