refactor(app-ws)!: simplify zome call parameters (#297)

* refactor(app-ws)!: simplify zome call parameters * fix: delete missing export * docs: rebuild --------- Co-authored-by: Jost Schulte <[email protected]>
holochain · Nov 21, 2024 · 23e2553 · 23e2553
1 parent de866af
commit 23e2553
Show file tree

Hide file tree

Showing 17 changed files with 53 additions and 292 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Added
 ### Fixed
 ### Changed
+- Simplify zome call parameters. `cap_secret`, `provenance` and `payload` are optional parameters of a `CallZomeRequest`. If implicit zome call signing is used, which happens when calling a zome with a `CallZomeRequest`, `provenance` and `cap_secret` are automatically set with the authorized signing credentials. It is still possible to call a cell by its role name instead of its cell id. Alternatively to passing in a `CallZomeRequest`, `callZome` can be invoked with a signed request `CallZomeRequestSigned`, where the zome call parameters have already been serialized and signed.
 ### Removed
 
 ## 2024-11-21: v0.19.0-dev.4

diff --git a/docs/client.appcallzomerequest.md b/docs/client.appcallzomerequest.md
diff --git a/docs/client.appclient.callzome.md b/docs/client.appclient.callzome.md
@@ -7,7 +7,7 @@
 **Signature:**
 
 ```typescript
-callZome(args: AppCallZomeRequest, timeout?: number): Promise<any>;
+callZome(args: CallZomeRequest | RoleNameCallZomeRequest, timeout?: number): Promise<any>;
 ```
 
 ## Parameters
@@ -35,7 +35,7 @@ args
 
 </td><td>
 
-[AppCallZomeRequest](./client.appcallzomerequest.md)
+[CallZomeRequest](./client.callzomerequest.md) \| [RoleNameCallZomeRequest](./client.rolenamecallzomerequest.md)
 
 
 </td><td>

diff --git a/docs/client.appwebsocket.callzome.md b/docs/client.appwebsocket.callzome.md
@@ -9,7 +9,7 @@ Call a zome.
 **Signature:**
 
 ```typescript
-callZome<ReturnType>(request: AppCallZomeRequest, timeout?: number): Promise<ReturnType>;
+callZome<ReturnType>(request: CallZomeRequest | RoleNameCallZomeRequest, timeout?: number): Promise<ReturnType>;
 ```
 
 ## Parameters
@@ -37,7 +37,7 @@ request
 
 </td><td>
 
-[AppCallZomeRequest](./client.appcallzomerequest.md)
+[CallZomeRequest](./client.callzomerequest.md) \| [RoleNameCallZomeRequest](./client.rolenamecallzomerequest.md)
 
 
 </td><td>

diff --git a/docs/client.callzomerequestallparams.cap_secret.md b/docs/client.callzomerequestallparams.cap_secret.md
diff --git a/docs/client.callzomerequestallparams.expires_at.md b/docs/client.callzomerequestallparams.expires_at.md
diff --git a/docs/client.callzomerequestallparams.md b/docs/client.callzomerequestallparams.md
diff --git a/docs/client.callzomerequestallparams.nonce.md b/docs/client.callzomerequestallparams.nonce.md
diff --git a/docs/client.callzomerequestgeneric.md b/docs/client.callzomerequestgeneric.md
@@ -12,9 +12,12 @@ export type CallZomeRequestGeneric<Payload> = {
     cell_id: CellId;
     zome_name: ZomeName;
     fn_name: FunctionName;
-    payload: Payload;
-    provenance: AgentPubKey;
+    provenance?: AgentPubKey;
+    payload?: Payload;
+    cap_secret?: CapSecret;
+    nonce?: Nonce256Bit;
+    expires_at?: number;
 };
 ```
-**References:** [CellId](./client.cellid.md)<!-- -->, [ZomeName](./client.zomename.md)<!-- -->, [FunctionName](./client.functionname.md)<!-- -->, [AgentPubKey](./client.agentpubkey.md)
+**References:** [CellId](./client.cellid.md)<!-- -->, [ZomeName](./client.zomename.md)<!-- -->, [FunctionName](./client.functionname.md)<!-- -->, [AgentPubKey](./client.agentpubkey.md)<!-- -->, [CapSecret](./client.capsecret.md)<!-- -->, [Nonce256Bit](./client.nonce256bit.md)
 
diff --git a/docs/client.md b/docs/client.md
@@ -591,16 +591,6 @@ Description
 
 
 
-</td></tr>
-<tr><td>
-
-[CallZomeRequestAllParams](./client.callzomerequestallparams.md)
-
-
-</td><td>
-
-
-
 </td></tr>
 <tr><td>
 
@@ -1442,16 +1432,6 @@ This type is meant to be opaque
 
 
 
-</td></tr>
-<tr><td>
-
-[AppCallZomeRequest](./client.appcallzomerequest.md)
-
-
-</td><td>
-
-
-
 </td></tr>
 <tr><td>
 
@@ -2524,16 +2504,6 @@ An internal link type index within the DNA, from 0 to 255.
 
 
 
-</td></tr>
-<tr><td>
-
-[NonProvenanceCallZomeRequest](./client.nonprovenancecallzomerequest.md)
-
-
-</td><td>
-
-
-
 </td></tr>
 <tr><td>
 
@@ -2748,16 +2718,6 @@ If the key could not be deleted from all cells, the call [RevokeAgentKeyRequest]
 
 
 
-</td></tr>
-<tr><td>
-
-[RoleNameCallZomeRequestSigned](./client.rolenamecallzomerequestsigned.md)
-
-
-</td><td>
-
-
-
 </td></tr>
 <tr><td>
 

diff --git a/docs/client.nonprovenancecallzomerequest.md b/docs/client.nonprovenancecallzomerequest.md
diff --git a/docs/client.rolenamecallzomerequest.md b/docs/client.rolenamecallzomerequest.md
@@ -8,9 +8,9 @@
 **Signature:**
 
 ```typescript
-export type RoleNameCallZomeRequest = Omit<NonProvenanceCallZomeRequest, "cell_id"> & {
+export type RoleNameCallZomeRequest = Omit<CallZomeRequest, "cell_id"> & {
     role_name: RoleName;
 };
 ```
-**References:** [NonProvenanceCallZomeRequest](./client.nonprovenancecallzomerequest.md)<!-- -->, [RoleName](./client.rolename.md)
+**References:** [CallZomeRequest](./client.callzomerequest.md)<!-- -->, [RoleName](./client.rolename.md)
 
diff --git a/docs/client.rolenamecallzomerequestsigned.md b/docs/client.rolenamecallzomerequestsigned.md