feat: add optional callZomeTransform (#247)

* added optional callZomeTransform * prettier typescript * switch argument order --------- Co-authored-by: Jost Schulte <jost.schulte@protonmail.com>
holochain · May 10, 2024 · f9f4c0e · f9f4c0e
1 parent a361a19
commit f9f4c0e
Show file tree

Hide file tree

Showing 6 changed files with 79 additions and 3 deletions.
diff --git a/docs/client.appwebsocketconnectionoptions.callzometransform.md b/docs/client.appwebsocketconnectionoptions.callzometransform.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [AppWebsocketConnectionOptions](./client.appwebsocketconnectionoptions.md) &gt; [callZomeTransform](./client.appwebsocketconnectionoptions.callzometransform.md)
+
+## AppWebsocketConnectionOptions.callZomeTransform property
+
+**Signature:**
+
+```typescript
+callZomeTransform?: CallZomeTransform;
+```
diff --git a/docs/client.appwebsocketconnectionoptions.md b/docs/client.appwebsocketconnectionoptions.md
@@ -37,6 +37,25 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[callZomeTransform?](./client.appwebsocketconnectionoptions.callzometransform.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[CallZomeTransform](./client.callzometransform.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
 [token?](./client.appwebsocketconnectionoptions.token.md)
 
 

diff --git a/docs/client.callzometransform.md b/docs/client.callzometransform.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; [CallZomeTransform](./client.callzometransform.md)
+
+## CallZomeTransform type
+
+**Signature:**
+
+```typescript
+export type CallZomeTransform = Transformer<CallZomeRequest | CallZomeRequestSigned, Promise<CallZomeRequestSigned>, CallZomeResponseGeneric<Uint8Array>, CallZomeResponse>;
+```
+**References:** [Transformer](./client.transformer_2.md)<!-- -->, [CallZomeRequest](./client.callzomerequest.md)<!-- -->, [CallZomeRequestSigned](./client.callzomerequestsigned.md)<!-- -->, [CallZomeResponseGeneric](./client.callzomeresponsegeneric.md)<!-- -->, [CallZomeResponse](./client.callzomeresponse.md)
+
diff --git a/docs/client.md b/docs/client.md
@@ -1493,6 +1493,15 @@ This type is meant to be opaque
 
 
 
+</td></tr>
+<tr><td>
+
+[CallZomeTransform](./client.callzometransform.md)
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

diff --git a/src/api/app/types.ts b/src/api/app/types.ts
@@ -15,6 +15,7 @@ import {
   Nonce256Bit,
   RoleName,
   Timestamp,
+  Transformer,
   WebsocketConnectionOptions,
   ZomeName,
 } from "../../index.js";
@@ -291,4 +292,12 @@ export interface AppClient {
 export interface AppWebsocketConnectionOptions
   extends WebsocketConnectionOptions {
   token?: AppAuthenticationToken;
+  callZomeTransform?: CallZomeTransform;
 }
+
+export type CallZomeTransform = Transformer<
+  CallZomeRequest | CallZomeRequestSigned,
+  Promise<CallZomeRequestSigned>,
+  CallZomeResponseGeneric<Uint8Array>,
+  CallZomeResponse
+>;
diff --git a/src/api/app/websocket.ts b/src/api/app/websocket.ts
@@ -38,6 +38,7 @@ import {
   NetworkInfoRequest,
   NetworkInfoResponse,
   AppWebsocketConnectionOptions,
+  CallZomeTransform,
 } from "./types.js";
 import {
   getHostZomeCallSigner,
@@ -66,6 +67,13 @@ export class AppWebsocket implements AppClient {
   readonly installedAppId: InstalledAppId;
   private readonly defaultTimeout: number;
   private readonly emitter: Emittery<AppEvents>;
+  private readonly callZomeTransform: Transformer<
+    CallZomeRequest | CallZomeRequestSigned,
+    Promise<CallZomeRequestSigned>,
+    CallZomeResponseGeneric<Uint8Array>,
+    CallZomeResponse
+  >;
+
   cachedAppInfo?: AppInfo | null;
 
   private readonly appInfoRequester: Requester<null, AppInfoResponse>;
@@ -93,12 +101,14 @@ export class AppWebsocket implements AppClient {
   private constructor(
     client: WsClient,
     appInfo: AppInfo,
+    callZomeTransform?: CallZomeTransform,
     defaultTimeout?: number
   ) {
     this.client = client;
     this.myPubKey = appInfo.agent_pub_key;
     this.installedAppId = appInfo.installed_app_id;
     this.defaultTimeout = defaultTimeout ?? DEFAULT_TIMEOUT;
+    this.callZomeTransform = callZomeTransform ?? defaultCallZomeTransform;
     this.emitter = new Emittery<AppEvents>();
     this.cachedAppInfo = appInfo;
 
@@ -111,7 +121,7 @@ export class AppWebsocket implements AppClient {
       this.client,
       "call_zome",
       this.defaultTimeout,
-      callZomeTransform
+      this.callZomeTransform
     );
     this.createCloneCellRequester = AppWebsocket.requester(
       this.client,
@@ -203,7 +213,12 @@ export class AppWebsocket implements AppClient {
       );
     }
 
-    return new AppWebsocket(client, appInfo, options.defaultTimeout);
+    return new AppWebsocket(
+      client,
+      appInfo,
+      options.callZomeTransform,
+      options.defaultTimeout
+    );
   }
 
   /**
@@ -417,7 +432,7 @@ export class AppWebsocket implements AppClient {
   }
 }
 
-const callZomeTransform: Transformer<
+const defaultCallZomeTransform: Transformer<
   // either an already signed zome call which is returned as is, or a zome call
   // payload to be signed
   CallZomeRequest | CallZomeRequestSigned,