Merge pull request #268 from holochain/support-system-signals

Support system signals

CHANGELOG.md

@@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### Added
 ### Changed
+- Signal listeners changed from only returning an `AppSignal` to a `Signal` which can be either an app or system signal.
 ### Fixed
 ### Removed
 

docs/client.appclient.on.md

@@ -7,7 +7,7 @@
 **Signature:**
 
 ```typescript
-on<Name extends keyof AppEvents>(eventName: Name | readonly Name[], listener: AppSignalCb): UnsubscribeFunction;
+on<Name extends keyof AppEvents>(eventName: Name | readonly Name[], listener: SignalCb): UnsubscribeFunction;
 ```
 
 ## Parameters
@@ -49,7 +49,7 @@ listener
 
 </td><td>
 
-[AppSignalCb](./client.appsignalcb.md)
+[SignalCb](./client.signalcb.md)
 
 
 </td><td>

docs/client.appevents.md

@@ -44,7 +44,7 @@ Description
 
 </td><td>
 
-[AppSignal](./client.appsignal.md)
+[Signal](./client.signal.md)
 
 
 </td><td>

docs/client.appevents.signal.md

@@ -7,5 +7,5 @@
 **Signature:**
 
 ```typescript
-signal: AppSignal;
+signal: Signal;
 ```

docs/client.appwebsocket.on.md

@@ -9,7 +9,7 @@ Register an event listener for signals.
 **Signature:**
 
 ```typescript
-on<Name extends keyof AppEvents>(eventName: Name | readonly Name[], listener: AppSignalCb): UnsubscribeFunction;
+on<Name extends keyof AppEvents>(eventName: Name | readonly Name[], listener: SignalCb): UnsubscribeFunction;
 ```
 
 ## Parameters
@@ -53,7 +53,7 @@ listener
 
 </td><td>
 
-[AppSignalCb](./client.appsignalcb.md)
+[SignalCb](./client.signalcb.md)
 
 
 </td><td>

docs/client.md

@@ -928,6 +928,16 @@ Description
 
 
 
+</td></tr>
+<tr><td>
+
+[PreflightResponse](./client.preflightresponse.md)
+
+
+</td><td>
+
+
+
 </td></tr>
 <tr><td>
 
@@ -1454,16 +1464,6 @@ This type is meant to be opaque
 
 
 
-</td></tr>
-<tr><td>
-
-[AppSignalCb](./client.appsignalcb.md)
-
-
-</td><td>
-
-
-
 </td></tr>
 <tr><td>
 
@@ -2465,6 +2465,16 @@ An internal link type index within the DNA, from 0 to 255.
 
 
 
+</td></tr>
+<tr><td>
+
+[RawSignal](./client.rawsignal.md)
+
+
+</td><td>
+
+
+
 </td></tr>
 <tr><td>
 
@@ -2585,6 +2595,16 @@ An internal link type index within the DNA, from 0 to 255.
 
 
 
+</td></tr>
+<tr><td>
+
+[SignalCb](./client.signalcb.md)
+
+
+</td><td>
+
+
+
 </td></tr>
 <tr><td>
 
@@ -2635,6 +2655,16 @@ An internal link type index within the DNA, from 0 to 255.
 
 
 
+</td></tr>
+<tr><td>
+
+[SystemSignal](./client.systemsignal.md)
+
+
+</td><td>
+
+
+
 </td></tr>
 <tr><td>
 

docs/client.preflightresponse.agent_state.md

@@ -0,0 +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;
+```

docs/client.preflightresponse.md

@@ -0,0 +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>

docs/client.preflightresponse.request.md

@@ -0,0 +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;
+```

docs/client.preflightresponse.signature.md

@@ -0,0 +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;
+```

docs/client.rawsignal.md

@@ -0,0 +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)
+

docs/client.signal.md

@@ -9,10 +9,10 @@
 
 ```typescript
 export type Signal = {
-    [SignalType.App]: EncodedAppSignal;
+    [SignalType.App]: AppSignal;
 } | {
-    [SignalType.System]: unknown;
+    [SignalType.System]: SystemSignal;
 };
 ```
-**References:** [EncodedAppSignal](./client.encodedappsignal.md)
+**References:** [AppSignal](./client.appsignal.md)<!-- -->, [SystemSignal](./client.systemsignal.md)
 

docs/client.signalcb.md

@@ -0,0 +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)
+

docs/client.systemsignal.md

@@ -0,0 +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)
+