chore(release): v0.19.0-dev.2

CHANGELOG.md

@@ -5,11 +5,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ## \[Unreleased\]
 
 ### Added
-- AppWebsocket calls to interact with countersigning sessions, i.e. `GetCountersigningSessionState` as well as `AbandonCountersigningSession` and `PublishCountersigningSession` when a session could not be resolved automatically. Countersigning is an unstable feature which must explicitly be enabled in Holochain.
 ### Fixed
 ### Changed
 ### Removed
 
+## 2024-11-12: v0.19.0-dev.2
+### Added
+- AppWebsocket calls to interact with countersigning sessions, i.e. `GetCountersigningSessionState` as well as `AbandonCountersigningSession` and `PublishCountersigningSession` when a session could not be resolved automatically. Countersigning is an unstable feature which must explicitly be enabled in Holochain.
+
 ## 2024-10-28: v0.19.0-dev.1
 ### Added
 - Bring back a websocket reconnection automation for Admin and App websockets. When either of them is closed and a new request made, it will attempt to reconnect using the same app authentication token that was used to initially authenticate the websocket. A specific `InvalidTokenError` is returned if that fails.

docs/client.abandoncountersigningsessionstaterequest.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AbandonCountersigningSessionStateRequest](./client.abandoncountersigningsessionstaterequest.md)
+
+## AbandonCountersigningSessionStateRequest type
+
+Cell id for which the countersigning session should be abandoned.
+
+**Signature:**
+
+```typescript
+export type AbandonCountersigningSessionStateRequest = CellId;
+```
+**References:** [CellId](./client.cellid.md)
+

docs/client.abandoncountersigningsessionstateresponse.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AbandonCountersigningSessionStateResponse](./client.abandoncountersigningsessionstateresponse.md)
+
+## AbandonCountersigningSessionStateResponse type
+
+
+**Signature:**
+
+```typescript
+export type AbandonCountersigningSessionStateResponse = null;
+```

docs/client.appwebsocket.abandoncountersigningsession.md

@@ -0,0 +1,71 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AppWebsocket](./client.appwebsocket.md) &gt; [abandonCountersigningSession](./client.appwebsocket.abandoncountersigningsession.md)
+
+## AppWebsocket.abandonCountersigningSession() method
+
+Abandon an unresolved countersigning session.
+
+If the current session has not been resolved automatically, it can be forcefully abandoned. A condition for this call to succeed is that at least one attempt has been made to resolve it automatically.
+
+\# Returns
+
+\[`AppResponse::CountersigningSessionAbandoned`<!-- -->\]
+
+The session is marked for abandoning and the countersigning workflow was triggered. The session has not been abandoned yet.
+
+Upon successful abandoning the system signal \[`SystemSignal::AbandonedCountersigning`<!-- -->\] will be emitted and the session removed from state, so that \[`AppRequest::GetCountersigningSessionState`<!-- -->\] would return `None`<!-- -->.
+
+In the countersigning workflow it will first be attempted to resolve the session with incoming signatures of the countersigned entries, before force-abandoning the session. In a very rare event it could happen that in just the moment where the \[`AppRequest::AbandonCountersigningSession`<!-- -->\] is made, signatures for this session come in. If they are valid, the session will be resolved and published as usual. Should they be invalid, however, the flag to abandon the session is erased. In such cases this request can be retried until the session has been abandoned successfully.
+
+\# Errors
+
+\[`CountersigningError::WorkspaceDoesNotExist`<!-- -->\] likely indicates that an invalid cell id was passed in to the call.
+
+\[`CountersigningError::SessionNotFound`<!-- -->\] when no ongoing session could be found for the provided cell id.
+
+\[`CountersigningError::SessionNotUnresolved`<!-- -->\] when an attempt to resolve the session automatically has not been made.
+
+**Signature:**
+
+```typescript
+abandonCountersigningSession(args: AbandonCountersigningSessionStateRequest): Promise<null>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+args
+
+
+</td><td>
+
+[AbandonCountersigningSessionStateRequest](./client.abandoncountersigningsessionstaterequest.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Promise&lt;null&gt;
+

docs/client.appwebsocket.callzome.md

@@ -9,7 +9,7 @@ Call a zome.
 **Signature:**
 
 ```typescript
-callZome(request: AppCallZomeRequest, timeout?: number): Promise<CallZomeResponse>;
+callZome<ReturnType>(request: AppCallZomeRequest, timeout?: number): Promise<ReturnType>;
 ```
 
 ## Parameters
@@ -65,7 +65,7 @@ _(Optional)_ A timeout to override the default.
 </tbody></table>
 **Returns:**
 
-Promise&lt;[CallZomeResponse](./client.callzomeresponse.md)<!-- -->&gt;
+Promise&lt;ReturnType&gt;
 
 The zome call's response.
 

docs/client.appwebsocket.createclonecell.md

@@ -9,7 +9,7 @@ Clone an existing provisioned cell.
 **Signature:**
 
 ```typescript
-createCloneCell(args: AppCreateCloneCellRequest): Promise<CreateCloneCellResponse>;
+createCloneCell(args: AppCreateCloneCellRequest): Promise<import("../admin/types.js").ClonedCell>;
 ```
 
 ## Parameters
@@ -49,7 +49,7 @@ Specify the cell to clone.
 </tbody></table>
 **Returns:**
 
-Promise&lt;[CreateCloneCellResponse](./client.createclonecellresponse.md)<!-- -->&gt;
+Promise&lt;import("../admin/types.js").[ClonedCell](./client.clonedcell.md)<!-- -->&gt;
 
 The created clone cell.
 

docs/client.appwebsocket.disableclonecell.md

@@ -9,7 +9,7 @@ Disable an enabled clone cell.
 **Signature:**
 
 ```typescript
-disableCloneCell(args: AppDisableCloneCellRequest): Promise<DisableCloneCellResponse>;
+disableCloneCell(args: AppDisableCloneCellRequest): Promise<void>;
 ```
 
 ## Parameters
@@ -49,5 +49,5 @@ Specify the clone cell to disable.
 </tbody></table>
 **Returns:**
 
-Promise&lt;[DisableCloneCellResponse](./client.disableclonecellresponse.md)<!-- -->&gt;
+Promise&lt;void&gt;
 

docs/client.appwebsocket.enableclonecell.md

@@ -9,7 +9,7 @@ Enable a disabled clone cell.
 **Signature:**
 
 ```typescript
-enableCloneCell(args: AppEnableCloneCellRequest): Promise<EnableCloneCellResponse>;
+enableCloneCell(args: AppEnableCloneCellRequest): Promise<import("../admin/types.js").ClonedCell>;
 ```
 
 ## Parameters
@@ -49,7 +49,7 @@ Specify the clone cell to enable.
 </tbody></table>
 **Returns:**
 
-Promise&lt;[EnableCloneCellResponse](./client.enableclonecellresponse.md)<!-- -->&gt;
+Promise&lt;import("../admin/types.js").[ClonedCell](./client.clonedcell.md)<!-- -->&gt;
 
 The enabled clone cell.
 

docs/client.appwebsocket.getcountersigningsessionstate.md

@@ -0,0 +1,51 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AppWebsocket](./client.appwebsocket.md) &gt; [getCountersigningSessionState](./client.appwebsocket.getcountersigningsessionstate.md)
+
+## AppWebsocket.getCountersigningSessionState() method
+
+Get the state of a countersigning session.
+
+**Signature:**
+
+```typescript
+getCountersigningSessionState(args: GetCountersigningSessionStateRequest): Promise<GetCountersigningSessionStateResponse>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+args
+
+
+</td><td>
+
+[GetCountersigningSessionStateRequest](./client.getcountersigningsessionstaterequest.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Promise&lt;[GetCountersigningSessionStateResponse](./client.getcountersigningsessionstateresponse.md)<!-- -->&gt;
+

docs/client.appwebsocket.md

@@ -134,6 +134,40 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[abandonCountersigningSession(args)](./client.appwebsocket.abandoncountersigningsession.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Abandon an unresolved countersigning session.
+
+If the current session has not been resolved automatically, it can be forcefully abandoned. A condition for this call to succeed is that at least one attempt has been made to resolve it automatically.
+
+\# Returns
+
+\[`AppResponse::CountersigningSessionAbandoned`<!-- -->\]
+
+The session is marked for abandoning and the countersigning workflow was triggered. The session has not been abandoned yet.
+
+Upon successful abandoning the system signal \[`SystemSignal::AbandonedCountersigning`<!-- -->\] will be emitted and the session removed from state, so that \[`AppRequest::GetCountersigningSessionState`<!-- -->\] would return `None`<!-- -->.
+
+In the countersigning workflow it will first be attempted to resolve the session with incoming signatures of the countersigned entries, before force-abandoning the session. In a very rare event it could happen that in just the moment where the \[`AppRequest::AbandonCountersigningSession`<!-- -->\] is made, signatures for this session come in. If they are valid, the session will be resolved and published as usual. Should they be invalid, however, the flag to abandon the session is erased. In such cases this request can be retried until the session has been abandoned successfully.
+
+\# Errors
+
+\[`CountersigningError::WorkspaceDoesNotExist`<!-- -->\] likely indicates that an invalid cell id was passed in to the call.
+
+\[`CountersigningError::SessionNotFound`<!-- -->\] when no ongoing session could be found for the provided cell id.
+
+\[`CountersigningError::SessionNotUnresolved`<!-- -->\] when an attempt to resolve the session automatically has not been made.
+
+
+</td></tr>
+<tr><td>
+
 [appInfo(timeout)](./client.appwebsocket.appinfo.md)
 
 
@@ -245,6 +279,20 @@ Enable a disabled clone cell.
 Get a cell id by its role name or clone id.
 
 
+</td></tr>
+<tr><td>
+
+[getCountersigningSessionState(args)](./client.appwebsocket.getcountersigningsessionstate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Get the state of a countersigning session.
+
+
 </td></tr>
 <tr><td>
 
@@ -287,5 +335,39 @@ Register an event listener for signals.
 Provide membrane proofs for the app.
 
 
+</td></tr>
+<tr><td>
+
+[publishCountersigningSession(args)](./client.appwebsocket.publishcountersigningsession.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Publish an unresolved countersigning session.
+
+If the current session has not been resolved automatically, it can be forcefully published. A condition for this call to succeed is that at least one attempt has been made to resolve it automatically.
+
+\# Returns
+
+\[`AppResponse::PublishCountersigningSessionTriggered`<!-- -->\]
+
+The session is marked for publishing and the countersigning workflow was triggered. The session has not been published yet.
+
+Upon successful publishing the system signal \[`SystemSignal::SuccessfulCountersigning`<!-- -->\] will be emitted and the session removed from state, so that \[`AppRequest::GetCountersigningSessionState`<!-- -->\] would return `None`<!-- -->.
+
+In the countersigning workflow it will first be attempted to resolve the session with incoming signatures of the countersigned entries, before force-publishing the session. In a very rare event it could happen that in just the moment where the \[`AppRequest::PublishCountersigningSession`<!-- -->\] is made, signatures for this session come in. If they are valid, the session will be resolved and published as usual. Should they be invalid, however, the flag to publish the session is erased. In such cases this request can be retried until the session has been published successfully.
+
+\# Errors
+
+\[`CountersigningError::WorkspaceDoesNotExist`<!-- -->\] likely indicates that an invalid cell id was passed in to the call.
+
+\[`CountersigningError::SessionNotFound`<!-- -->\] when no ongoing session could be found for the provided cell id.
+
+\[`CountersigningError::SessionNotUnresolved`<!-- -->\] when an attempt to resolve the session automatically has not been made.
+
+
 </td></tr>
 </tbody></table>