@holochain/client 0.19.1 → 0.20.0-dev.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/lib/api/admin/types.d.ts +1 -1
- package/lib/api/app/types.d.ts +0 -6
- package/lib/api/app/websocket.d.ts +3 -3
- package/lib/tsdoc-metadata.json +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -15,12 +15,12 @@ A JavaScript client for the Holochain Conductor API (works with browsers as well
|
|
|
15
15
|
|
|
16
16
|
## Installation
|
|
17
17
|
|
|
18
|
+
**JS client v0.20.x** is compatible with **Holochain v0.6.x**.
|
|
19
|
+
|
|
18
20
|
**JS client v0.19.x** is compatible with **Holochain v0.5.x**.
|
|
19
21
|
|
|
20
22
|
**JS client v0.18.x** is compatible with **Holochain v0.4.x**.
|
|
21
23
|
|
|
22
|
-
**JS client v0.17.x** is compatible with **Holochain v0.3.x**.
|
|
23
|
-
|
|
24
24
|
To install from NPM, run
|
|
25
25
|
```bash
|
|
26
26
|
npm install --save-exact @holochain/client
|
|
@@ -88,7 +88,7 @@ await adminWs.client.close();
|
|
|
88
88
|
|
|
89
89
|
### Subscribe to signals
|
|
90
90
|
```typescript
|
|
91
|
-
import { AdminWebsocket, AppWebsocket, CellType
|
|
91
|
+
import { AdminWebsocket, AppWebsocket, CellType } from "./lib/index.js";
|
|
92
92
|
|
|
93
93
|
const adminWs = await AdminWebsocket.connect({
|
|
94
94
|
url: new URL("ws://127.0.0.1:65000"),
|
|
@@ -123,7 +123,7 @@ const appWs = await AppWebsocket.connect({
|
|
|
123
123
|
|
|
124
124
|
let signalCb;
|
|
125
125
|
const signalReceived = new Promise<void>((resolve) => {
|
|
126
|
-
signalCb = (signal
|
|
126
|
+
signalCb = (signal) => {
|
|
127
127
|
console.log("signal received", signal);
|
|
128
128
|
// act on signal
|
|
129
129
|
resolve();
|
package/lib/api/admin/types.d.ts
CHANGED
package/lib/api/app/types.d.ts
CHANGED
|
@@ -48,12 +48,6 @@ export type CallZomeResponse = CallZomeResponseGeneric<any>;
|
|
|
48
48
|
* @public
|
|
49
49
|
*/
|
|
50
50
|
export type AppInfoResponse = AppInfo | null;
|
|
51
|
-
/**
|
|
52
|
-
* @public
|
|
53
|
-
*/
|
|
54
|
-
export type AppAgentInfoRequest = {
|
|
55
|
-
dna_hashes: DnaHash[] | null;
|
|
56
|
-
};
|
|
57
51
|
/**
|
|
58
52
|
* @public
|
|
59
53
|
*/
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { UnsubscribeFunction } from "emittery";
|
|
2
2
|
import { AgentPubKey, InstalledAppId, RoleName } from "../../types.js";
|
|
3
|
-
import { AgentInfoResponse, AgentMetaInfoRequest, AppInfo, ClonedCell, DumpNetworkMetricsRequest, DumpNetworkMetricsResponse, DumpNetworkStatsResponse, MemproofMap } from "../admin/index.js";
|
|
3
|
+
import { AgentInfoRequest, AgentInfoResponse, AgentMetaInfoRequest, AppInfo, ClonedCell, DumpNetworkMetricsRequest, DumpNetworkMetricsResponse, DumpNetworkStatsResponse, MemproofMap } from "../admin/index.js";
|
|
4
4
|
import { WsClient } from "../client.js";
|
|
5
|
-
import { AbandonCountersigningSessionStateRequest,
|
|
5
|
+
import { AbandonCountersigningSessionStateRequest, AppClient, AppEvents, AppWebsocketConnectionOptions, CallZomeRequest, CallZomeRequestSigned, CreateCloneCellRequest, DisableCloneCellRequest, EnableCloneCellRequest, GetCountersigningSessionStateRequest, GetCountersigningSessionStateResponse, PublishCountersigningSessionStateRequest, RoleNameCallZomeRequest, SignalCb } from "./types.js";
|
|
6
6
|
/**
|
|
7
7
|
* A class to establish a websocket connection to an App interface, for a
|
|
8
8
|
* specific agent and app.
|
|
@@ -53,7 +53,7 @@ export declare class AppWebsocket implements AppClient {
|
|
|
53
53
|
* @param req - An array of DNA hashes or null
|
|
54
54
|
* @returns The app's agent infos as JSON string.
|
|
55
55
|
*/
|
|
56
|
-
agentInfo(req:
|
|
56
|
+
agentInfo(req: AgentInfoRequest, timeout?: number): Promise<AgentInfoResponse>;
|
|
57
57
|
/**
|
|
58
58
|
* Request agent meta info for an agent by peer Url.
|
|
59
59
|
*
|
package/lib/tsdoc-metadata.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@holochain/client",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.20.0-dev.1",
|
|
4
4
|
"description": "A JavaScript client for the Holochain Conductor API",
|
|
5
5
|
"author": "Holochain Foundation <info@holochain.org> (https://holochain.org)",
|
|
6
6
|
"license": "CAL-1.0",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
},
|
|
19
19
|
"homepage": "https://github.com/holochain/holochain-client-js#readme",
|
|
20
20
|
"engines": {
|
|
21
|
-
"node": ">=18.0.0 || >=20.0.0 || >=22.0.0"
|
|
21
|
+
"node": ">=18.0.0 || >=20.0.0 || >= 22.0.0"
|
|
22
22
|
},
|
|
23
23
|
"main": "lib/index.js",
|
|
24
24
|
"module": "lib/index.js",
|