@ddd-qc/cell-proxy 0.9.4 → 0.9.6

package/README.md

@@ -1,6 +1,6 @@
 # cell-proxy
 
-Proxy classes and helpers for managing a Holochain AppWebsocket and calling zome functions on cells.
+Proxy classes and helpers for managing a [Holochain](https://www.npmjs.com/package/@holochain/client) AppWebsocket and calling zome functions on cells.
 The intent is to make the development of web UI of Holochain apps in javascript / typescript faster & easier by providing a straightforward API for communicating with a Conductor, and some basic logging features.
 
 
@@ -59,20 +59,64 @@ A `ConductorAppProxy` can be created by providing an already existing `AppWebSoc
 A subclass is expected to provide all the zome functions of a zome as directly callable methods.
 Example: `profilesProxy.fetchAllProfiles()`
 
+A `ZomeProxy` subclass must define the static field `DEFAULT_ZOME_NAME` which is the way to know at runtime for what zome this subclass is for.
 
-## Example use
+
+# Example
+
+Imagine you have a happ that has a dna that uses a profile zome.
+
+## Example without subclassing ZomeProxy
+```typescript
+/** HCL of the role we want to use */
+const hcl = new HCL("myHapp", "myRole");
+/** Create AppProxy from provided local port */
+const appProxy = await ConductorAppProxy.new(Number(process.env.HC_PORT));
+/** Map out all the runnings cells for a Role in a happ. Required before calling createCellProxy */
+await appProxy.fetchCells(hcl);
+/** Create a CellProxy for the "myRole" role */
+const profilesCellProxy = appProxy.createCellProxy(hcl);
+/** Call zome function on the "profiles" zome  */
+const handles = await profilesCellProxy.callZome("profiles", "fetch_all_handles", null);
+/** Dump all logs to console */
+appProxy.dumpLogs();
+```
+
+
+## Example with ZomeProxy subclass
+
+#### ZomeProxy subclass
+
+```typescript
+export class ProfileZomeProxy extends ZomeProxy {
+
+  static readonly DEFAULT_ZOME_NAME: string = "profiles";
+
+  async getMyHandle(): Promise<string> {
+    return this.call('get_my_handle', null);
+  }
+  async setMyHandle(value: string): Promise<EntryHash> {
+    return this.callBlocking('set_my_handle', value);
+  }
+  async fetchAllHandles(): Promise<string[]> {
+    return this.call('fetch_all_handles', null);
+  }
+}
+```
+
+#### Use
 
 ```typescript
 /** HCL of the cell we want to use */
-const profilesHcl = new HCL("where", "profiles");
+const hcl = new HCL("myHapp", "myRole");
 /** Create AppProxy from provided local port */
 const appProxy = await ConductorAppProxy.new(Number(process.env.HC_PORT));
 /** Map out all the runnings cells for a Role in a happ. Required before calling createCellProxy */
-await appProxy.fetchCells(profilesHcl);
+await appProxy.fetchCells(hcl);
 /** Create a CellProxy for the "profiles" role */
-const profilesCellProxy = appProxy.createCellProxy(profilesHcl);
+const cellProxy = appProxy.createCellProxy(hcl);
+/** Create ZomeProxy */
+const zomeProxy = ProfileZomeProxy(cellProxy);
 /** Call zome function on the "profiles" zome */
-const profiles = await profilesCellProxy.callZome("profiles", "fetchAllProfiles", null);
-/** Dump all logs to console */
-appProxy.dumpLogs();
+const handles = await zomeProxy.fetchAllHandles();
 ```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ddd-qc/cell-proxy",
-  "version": "0.9.4",
-  "description": "Wrapper for AppWebsocket",
+  "version": "0.9.6",
+  "description": "Proxy classes and helpers for managing a Holochain AppWebsocket",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "type": "module",