fix test & update docs (#270)

* Optional agent key * update test with hc-client-js signal changes * updated docs --------- Co-authored-by: Michael Dougherty <maackle.d@gmail.com>
holochain · Aug 26, 2024 · 16aa191 · 16aa191
1 parent 9657d3f
commit 16aa191
Show file tree

Hide file tree

Showing 9 changed files with 185 additions and 185 deletions.
diff --git a/docs/client.installapprequest.md b/docs/client.installapprequest.md
@@ -9,7 +9,7 @@
 
 ```typescript
 export type InstallAppRequest = {
-    agent_key: AgentPubKey;
+    agent_key?: AgentPubKey;
     installed_app_id?: InstalledAppId;
     membrane_proofs: MemproofMap;
     network_seed?: NetworkSeed;

diff --git a/docs/client.preflightresponse.agent_state.md b/docs/client.preflightresponse.agent_state.md
@@ -1,13 +1,13 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [PreflightResponse](./client.preflightresponse.md) &gt; [agent\_state](./client.preflightresponse.agent_state.md)
-
-## PreflightResponse.agent\_state property
-
-The chain state declaration for the agent that produced this response.
-
-**Signature:**
-
-```typescript
-agent_state: CountersigningAgentState;
-```
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [PreflightResponse](./client.preflightresponse.md) &gt; [agent\_state](./client.preflightresponse.agent_state.md)
+
+## PreflightResponse.agent\_state property
+
+The chain state declaration for the agent that produced this response.
+
+**Signature:**
+
+```typescript
+agent_state: CountersigningAgentState;
+```
diff --git a/docs/client.preflightresponse.md b/docs/client.preflightresponse.md
@@ -1,94 +1,94 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [PreflightResponse](./client.preflightresponse.md)
-
-## PreflightResponse interface
-
-
-**Signature:**
-
-```typescript
-export interface PreflightResponse 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[agent\_state](./client.preflightresponse.agent_state.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[CountersigningAgentState](./client.countersigningagentstate.md)
-
-
-</td><td>
-
-The chain state declaration for the agent that produced this response.
-
-
-</td></tr>
-<tr><td>
-
-[request](./client.preflightresponse.request.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[PreflightRequest](./client.preflightrequest.md)
-
-
-</td><td>
-
-The request associated with this response.
-
-
-</td></tr>
-<tr><td>
-
-[signature](./client.preflightresponse.signature.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[Signature](./client.signature.md)
-
-
-</td><td>
-
-The signature of this response, by the agent that created it.
-
-
-</td></tr>
-</tbody></table>
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [PreflightResponse](./client.preflightresponse.md)
+
+## PreflightResponse interface
+
+
+**Signature:**
+
+```typescript
+export interface PreflightResponse 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[agent\_state](./client.preflightresponse.agent_state.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[CountersigningAgentState](./client.countersigningagentstate.md)
+
+
+</td><td>
+
+The chain state declaration for the agent that produced this response.
+
+
+</td></tr>
+<tr><td>
+
+[request](./client.preflightresponse.request.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[PreflightRequest](./client.preflightrequest.md)
+
+
+</td><td>
+
+The request associated with this response.
+
+
+</td></tr>
+<tr><td>
+
+[signature](./client.preflightresponse.signature.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Signature](./client.signature.md)
+
+
+</td><td>
+
+The signature of this response, by the agent that created it.
+
+
+</td></tr>
+</tbody></table>
diff --git a/docs/client.preflightresponse.request.md b/docs/client.preflightresponse.request.md
@@ -1,13 +1,13 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [PreflightResponse](./client.preflightresponse.md) &gt; [request](./client.preflightresponse.request.md)
-
-## PreflightResponse.request property
-
-The request associated with this response.
-
-**Signature:**
-
-```typescript
-request: PreflightRequest;
-```
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [PreflightResponse](./client.preflightresponse.md) &gt; [request](./client.preflightresponse.request.md)
+
+## PreflightResponse.request property
+
+The request associated with this response.
+
+**Signature:**
+
+```typescript
+request: PreflightRequest;
+```
diff --git a/docs/client.preflightresponse.signature.md b/docs/client.preflightresponse.signature.md
@@ -1,13 +1,13 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [PreflightResponse](./client.preflightresponse.md) &gt; [signature](./client.preflightresponse.signature.md)
-
-## PreflightResponse.signature property
-
-The signature of this response, by the agent that created it.
-
-**Signature:**
-
-```typescript
-signature: Signature;
-```
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [PreflightResponse](./client.preflightresponse.md) &gt; [signature](./client.preflightresponse.signature.md)
+
+## PreflightResponse.signature property
+
+The signature of this response, by the agent that created it.
+
+**Signature:**
+
+```typescript
+signature: Signature;
+```
diff --git a/docs/client.rawsignal.md b/docs/client.rawsignal.md
@@ -1,18 +1,18 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [RawSignal](./client.rawsignal.md)
-
-## RawSignal type
-
-
-**Signature:**
-
-```typescript
-export type RawSignal = {
-    [SignalType.App]: EncodedAppSignal;
-} | {
-    [SignalType.System]: SystemSignal;
-};
-```
-**References:** [EncodedAppSignal](./client.encodedappsignal.md)<!-- -->, [SystemSignal](./client.systemsignal.md)
-
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [RawSignal](./client.rawsignal.md)
+
+## RawSignal type
+
+
+**Signature:**
+
+```typescript
+export type RawSignal = {
+    [SignalType.App]: EncodedAppSignal;
+} | {
+    [SignalType.System]: SystemSignal;
+};
+```
+**References:** [EncodedAppSignal](./client.encodedappsignal.md)<!-- -->, [SystemSignal](./client.systemsignal.md)
+
diff --git a/docs/client.signalcb.md b/docs/client.signalcb.md
@@ -1,14 +1,14 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [SignalCb](./client.signalcb.md)
-
-## SignalCb type
-
-
-**Signature:**
-
-```typescript
-export type SignalCb = (signal: Signal) => void;
-```
-**References:** [Signal](./client.signal.md)
-
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [SignalCb](./client.signalcb.md)
+
+## SignalCb type
+
+
+**Signature:**
+
+```typescript
+export type SignalCb = (signal: Signal) => void;
+```
+**References:** [Signal](./client.signal.md)
+
diff --git a/docs/client.systemsignal.md b/docs/client.systemsignal.md
@@ -1,16 +1,16 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [SystemSignal](./client.systemsignal.md)
-
-## SystemSignal type
-
-
-**Signature:**
-
-```typescript
-export type SystemSignal = {
-    SuccessfulCountersigning: EntryHash;
-};
-```
-**References:** [EntryHash](./client.entryhash.md)
-
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [SystemSignal](./client.systemsignal.md)
+
+## SystemSignal type
+
+
+**Signature:**
+
+```typescript
+export type SystemSignal = {
+    SuccessfulCountersigning: EntryHash;
+};
+```
+**References:** [EntryHash](./client.entryhash.md)
+