@holochain/client 0.11.13 → 0.11.15

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.
Files changed (75) hide show
  1. package/README.md +4 -13
  2. package/lib/api/admin/index.js +0 -1
  3. package/lib/api/admin/types.d.ts +372 -49
  4. package/lib/api/admin/types.js +43 -4
  5. package/lib/api/admin/websocket.d.ts +78 -3
  6. package/lib/api/admin/websocket.js +79 -5
  7. package/lib/api/app/index.js +0 -1
  8. package/lib/api/app/types.d.ts +81 -6
  9. package/lib/api/app/types.js +3 -1
  10. package/lib/api/app/websocket.d.ts +54 -0
  11. package/lib/api/app/websocket.js +48 -1
  12. package/lib/api/app-agent/index.js +0 -1
  13. package/lib/api/app-agent/types.d.ts +27 -0
  14. package/lib/api/app-agent/types.js +0 -1
  15. package/lib/api/app-agent/websocket.d.ts +57 -0
  16. package/lib/api/app-agent/websocket.js +61 -5
  17. package/lib/api/client.d.ts +25 -9
  18. package/lib/api/client.js +35 -13
  19. package/lib/api/common.d.ts +30 -1
  20. package/lib/api/common.js +18 -2
  21. package/lib/api/index.d.ts +2 -1
  22. package/lib/api/index.js +1 -1
  23. package/lib/api/zome-call-signing.d.ts +24 -1
  24. package/lib/api/zome-call-signing.js +18 -2
  25. package/lib/environments/launcher.js +0 -1
  26. package/lib/hdk/action.d.ts +45 -0
  27. package/lib/hdk/action.js +3 -1
  28. package/lib/hdk/capabilities.d.ts +21 -0
  29. package/lib/hdk/capabilities.js +3 -1
  30. package/lib/hdk/countersigning.d.ts +30 -0
  31. package/lib/hdk/countersigning.js +0 -1
  32. package/lib/hdk/dht-ops.d.ts +18 -0
  33. package/lib/hdk/dht-ops.js +15 -1
  34. package/lib/hdk/entry.d.ts +15 -0
  35. package/lib/hdk/entry.js +0 -1
  36. package/lib/hdk/index.d.ts +1 -0
  37. package/lib/hdk/index.js +1 -1
  38. package/lib/hdk/record.d.ts +6 -0
  39. package/lib/hdk/record.js +0 -1
  40. package/lib/index.js +0 -1
  41. package/lib/tsdoc-metadata.json +11 -0
  42. package/lib/types.d.ts +81 -0
  43. package/lib/types.js +0 -1
  44. package/lib/utils/base64.d.ts +16 -0
  45. package/lib/utils/base64.js +16 -1
  46. package/lib/utils/fake-hash.d.ts +23 -1
  47. package/lib/utils/fake-hash.js +23 -2
  48. package/lib/utils/index.js +0 -1
  49. package/package.json +5 -2
  50. package/lib/api/admin/index.js.map +0 -1
  51. package/lib/api/admin/types.js.map +0 -1
  52. package/lib/api/admin/websocket.js.map +0 -1
  53. package/lib/api/app/index.js.map +0 -1
  54. package/lib/api/app/types.js.map +0 -1
  55. package/lib/api/app/websocket.js.map +0 -1
  56. package/lib/api/app-agent/index.js.map +0 -1
  57. package/lib/api/app-agent/types.js.map +0 -1
  58. package/lib/api/app-agent/websocket.js.map +0 -1
  59. package/lib/api/client.js.map +0 -1
  60. package/lib/api/common.js.map +0 -1
  61. package/lib/api/index.js.map +0 -1
  62. package/lib/api/zome-call-signing.js.map +0 -1
  63. package/lib/environments/launcher.js.map +0 -1
  64. package/lib/hdk/action.js.map +0 -1
  65. package/lib/hdk/capabilities.js.map +0 -1
  66. package/lib/hdk/countersigning.js.map +0 -1
  67. package/lib/hdk/dht-ops.js.map +0 -1
  68. package/lib/hdk/entry.js.map +0 -1
  69. package/lib/hdk/index.js.map +0 -1
  70. package/lib/hdk/record.js.map +0 -1
  71. package/lib/index.js.map +0 -1
  72. package/lib/types.js.map +0 -1
  73. package/lib/utils/base64.js.map +0 -1
  74. package/lib/utils/fake-hash.js.map +0 -1
  75. package/lib/utils/index.js.map +0 -1
package/README.md CHANGED
@@ -8,7 +8,9 @@
8
8
 
9
9
  A JavaScript client for the Holochain Conductor API (works with browsers as well as Nodejs).
10
10
 
11
- > Holochain's Conductor API is under active development. This client package tracks that development fairly closely but sometimes gets behind.
11
+ ## API Reference
12
+
13
+ [Complete API reference](./docs/client.md)
12
14
 
13
15
  ## Installation
14
16
 
@@ -21,12 +23,6 @@ npm install --save-exact @holochain/client
21
23
 
22
24
  ## Sample usage
23
25
 
24
- ### Use AdminWebsocket
25
- ```typescript
26
- const admin = await AdminWebsocket.connect(`ws://127.0.0.1:8000`, TIMEOUT)
27
- const agentPubKey = await admin.generateAgentPubKey()
28
- ```
29
-
30
26
  ### Use AppAgentWebsocket with implicit zome call signing
31
27
  ```typescript
32
28
  const signalCb = (signal: AppSignal) => {
@@ -100,17 +96,12 @@ setSigningCredentials(cell_id, signingCredentials);
100
96
  localStorage.setItem(cellIdB64, JSON.stringify(signingCredentials));
101
97
  ```
102
98
 
103
- ## API Reference
104
-
105
- See [docs/API.md](docs/API.md)
106
-
107
-
108
99
  # Holochain Compatibility
109
100
 
110
101
  See [default.nix](./default.nix) for the Holochain version this package is compatible with.
111
102
 
112
103
  If updating the Holochain version included in holonix, please use `niv update` as explained in the
113
- [Holochain Installation Guide](https://developer.holochain.org/install/#upgrading-the-holochain-version).
104
+ [Holochain Installation Guide](https://developer.holochain.org/install-advanced/#upgrading-the-holochain-version).
114
105
 
115
106
  ## Running tests
116
107
 
@@ -1,3 +1,2 @@
1
1
  export * from "./types.js";
2
2
  export * from "./websocket.js";
3
- //# sourceMappingURL=index.js.map