chore(release): v0.16.0-dev.1

holochain · Feb 28, 2024 · a8afeba · a8afeba
1 parent 8a6c0bf
commit a8afeba
Show file tree

Hide file tree

Showing 23 changed files with 254 additions and 56 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ### Changed
 ### Fixed
 
+## 2024-02-28: v0.16.0-dev.1
+### Changed
+- Upgrade JS client.
+
 ## 2024-01-25: v0.16.0-dev.0
 ### Changed
 - Upgrade deps to Holochain v0.3.0

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/docs/tryorama.addallagentstoallconductors.md b/docs/tryorama.addallagentstoallconductors.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@holochain/tryorama](./tryorama.md) &gt; [addAllAgentsToAllConductors](./tryorama.addallagentstoallconductors.md)
 
-## addAllAgentsToAllConductors variable
+## addAllAgentsToAllConductors() function
 
 Add all agents of all conductors to each other. Shortcuts peer discovery through a bootstrap server or gossiping.
 
@@ -11,3 +11,14 @@ Add all agents of all conductors to each other. Shortcuts peer discovery through
 ```typescript
 addAllAgentsToAllConductors: (conductors: IConductor[]) => Promise<void>
 ```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  conductors | [IConductor](./tryorama.iconductor.md)<!-- -->\[\] | Conductors to mutually exchange all agents with. |
+
+**Returns:**
+
+Promise&lt;void&gt;
+
diff --git a/docs/tryorama.areconductorcellsdhtssynced.md b/docs/tryorama.areconductorcellsdhtssynced.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@holochain/tryorama](./tryorama.md) &gt; [areConductorCellsDhtsSynced](./tryorama.areconductorcellsdhtssynced.md)
 
-## areConductorCellsDhtsSynced variable
+## areConductorCellsDhtsSynced() function
 
 A utility function to compare conductors' integrated DhtOps.
 
@@ -11,3 +11,16 @@ A utility function to compare conductors' integrated DhtOps.
 ```typescript
 areConductorCellsDhtsSynced: (conductorCells: IConductorCell[]) => Promise<boolean>
 ```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  conductorCells | [IConductorCell](./tryorama.iconductorcell.md)<!-- -->\[\] | Array of ConductorCells |
+
+**Returns:**
+
+Promise&lt;boolean&gt;
+
+A promise that is resolved after conductors' Integrated DhtOps match.
+
diff --git a/docs/tryorama.aredhtssynced.md b/docs/tryorama.aredhtssynced.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@holochain/tryorama](./tryorama.md) &gt; [areDhtsSynced](./tryorama.aredhtssynced.md)
 
-## areDhtsSynced variable
+## areDhtsSynced() function
 
 A utility function to compare conductors' integrated DhtOps.
 
@@ -11,3 +11,17 @@ A utility function to compare conductors' integrated DhtOps.
 ```typescript
 areDhtsSynced: (players: IPlayer[], dnaHash: DnaHash) => Promise<boolean>
 ```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  players | [IPlayer](./tryorama.iplayer.md)<!-- -->\[\] |  |
+|  dnaHash | DnaHash |  |
+
+**Returns:**
+
+Promise&lt;boolean&gt;
+
+A promise that is resolved after conductors' Integrated DhtOps match.
+
diff --git a/docs/tryorama.cleanallconductors.md b/docs/tryorama.cleanallconductors.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@holochain/tryorama](./tryorama.md) &gt; [cleanAllConductors](./tryorama.cleanallconductors.md)
 
-## cleanAllConductors variable
+## cleanAllConductors() function
 
 Run the `hc` command to delete all conductor data.
 
@@ -11,3 +11,9 @@ Run the `hc` command to delete all conductor data.
 ```typescript
 cleanAllConductors: () => Promise<void>
 ```
+**Returns:**
+
+Promise&lt;void&gt;
+
+A promise that resolves when the command is complete.
+
diff --git a/docs/tryorama.conductorcellsdhtsync.md b/docs/tryorama.conductorcellsdhtsync.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@holochain/tryorama](./tryorama.md) &gt; [conductorCellsDhtSync](./tryorama.conductorcellsdhtsync.md)
 
-## conductorCellsDhtSync variable
+## conductorCellsDhtSync() function
 
 A utility function to wait until all conductors' integrated DhtOps are identical for a DNA.
 
@@ -11,3 +11,18 @@ A utility function to wait until all conductors' integrated DhtOps are identical
 ```typescript
 conductorCellsDhtSync: (conductorCells: IConductorCell[], interval?: number, timeout?: number) => Promise<void>
 ```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  conductorCells | [IConductorCell](./tryorama.iconductorcell.md)<!-- -->\[\] | Array of IConductorCell. |
+|  interval | number | _(Optional)_ Interval to pause between comparisons (defaults to 50 ms). |
+|  timeout | number | _(Optional)_ A timeout for the delay (optional). |
+
+**Returns:**
+
+Promise&lt;void&gt;
+
+A promise that is resolved after all agents' DHT states match.
+
diff --git a/docs/tryorama.createconductor.md b/docs/tryorama.createconductor.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@holochain/tryorama](./tryorama.md) &gt; [createConductor](./tryorama.createconductor.md)
 
-## createConductor variable
+## createConductor() function
 
 The function to create a conductor. It starts a sandbox conductor via the Holochain CLI.
 
@@ -11,3 +11,17 @@ The function to create a conductor. It starts a sandbox conductor via the Holoch
 ```typescript
 createConductor: (signalingServerUrl: URL, options?: ConductorOptions) => Promise<Conductor>
 ```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  signalingServerUrl | URL |  |
+|  options | [ConductorOptions](./tryorama.conductoroptions.md) | _(Optional)_ |
+
+**Returns:**
+
+Promise&lt;[Conductor](./tryorama.conductor.md)<!-- -->&gt;
+
+A conductor instance.
+
diff --git a/docs/tryorama.createtrycpconductor.md b/docs/tryorama.createtrycpconductor.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@holochain/tryorama](./tryorama.md) &gt; [createTryCpConductor](./tryorama.createtrycpconductor.md)
 
-## createTryCpConductor variable
+## createTryCpConductor() function
 
 The function to create a TryCP Conductor. By default configures and starts it.
 
@@ -11,3 +11,17 @@ The function to create a TryCP Conductor. By default configures and starts it.
 ```typescript
 createTryCpConductor: (tryCpClient: TryCpClient, options?: TryCpConductorOptions) => Promise<TryCpConductor>
 ```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  tryCpClient | [TryCpClient](./tryorama.trycpclient.md) | The client connection to the TryCP server on which to create the conductor. |
+|  options | [TryCpConductorOptions](./tryorama.trycpconductoroptions.md) | _(Optional)_ |
+
+**Returns:**
+
+Promise&lt;[TryCpConductor](./tryorama.trycpconductor.md)<!-- -->&gt;
+
+A conductor instance.
+
diff --git a/docs/tryorama.dhtsync.md b/docs/tryorama.dhtsync.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@holochain/tryorama](./tryorama.md) &gt; [dhtSync](./tryorama.dhtsync.md)
 
-## dhtSync variable
+## dhtSync() function
 
 A utility function to wait until all conductors' integrated DhtOps are identical for a DNA.
 
@@ -11,3 +11,19 @@ A utility function to wait until all conductors' integrated DhtOps are identical
 ```typescript
 dhtSync: (players: IPlayer[], dnaHash: DnaHash, interval?: number, timeout?: number) => Promise<void>
 ```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  players | [IPlayer](./tryorama.iplayer.md)<!-- -->\[\] | Array of players. |
+|  dnaHash | DnaHash | DNA hash to compare integrated DhtOps from. |
+|  interval | number | _(Optional)_ Interval to pause between comparisons (defaults to 50 ms). |
+|  timeout | number | _(Optional)_ A timeout for the delay (optional). |
+
+**Returns:**
+
+Promise&lt;void&gt;
+
+A promise that is resolved after all agents' DHT states match.
+
diff --git a/docs/tryorama.enableandgetagentapp.md b/docs/tryorama.enableandgetagentapp.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@holochain/tryorama](./tryorama.md) &gt; [enableAndGetAgentApp](./tryorama.enableandgetagentapp.md)
 
-## enableAndGetAgentApp variable
+## enableAndGetAgentApp() function
 
 Enable an app and build an agent app object.
 
@@ -11,3 +11,18 @@ Enable an app and build an agent app object.
 ```typescript
 enableAndGetAgentApp: (adminWs: IAdminWebsocket, appWs: IAppWebsocket | IAppAgentWebsocket, appInfo: AppInfo) => Promise<AgentApp>
 ```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  adminWs | [IAdminWebsocket](./tryorama.iadminwebsocket.md) | The admin websocket to use for admin requests. |
+|  appWs | [IAppWebsocket](./tryorama.iappwebsocket.md) \| [IAppAgentWebsocket](./tryorama.iappagentwebsocket.md) | The app websocket to use for app requests. |
+|  appInfo | AppInfo | The app info of the app to enable. |
+
+**Returns:**
+
+Promise&lt;[AgentApp](./tryorama.agentapp.md)<!-- -->&gt;
+
+An app agent object.
+
diff --git a/docs/tryorama.getcallablecell.md b/docs/tryorama.getcallablecell.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@holochain/tryorama](./tryorama.md) &gt; [getCallableCell](./tryorama.getcallablecell.md)
 
-## getCallableCell variable
+## getCallableCell() function
 
 Create curried version of `callZome` function for a specific cell.
 
@@ -24,3 +24,17 @@ getCallableCell: (appWs: IAppWebsocket | IAppAgentWebsocket, cell: ClonedCell |
     name: string;
 }
 ```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  appWs | [IAppWebsocket](./tryorama.iappwebsocket.md) \| [IAppAgentWebsocket](./tryorama.iappagentwebsocket.md) | App websocket to use for calling zome. |
+|  cell | ClonedCell \| ProvisionedCell | Cell to bind zome call function to. |
+
+**Returns:**
+
+{ callZome: &lt;T&gt;(request: [CellZomeCallRequest](./tryorama.cellzomecallrequest.md)<!-- -->, timeout?: number) =&gt; Promise&lt;T&gt;; cell\_id: import("@holochain/client").CellId; clone\_id: string; original\_dna\_hash: Uint8Array; dna\_modifiers: import("@holochain/client").DnaModifiers; name: string; enabled: boolean; } \| { callZome: &lt;T&gt;(request: [CellZomeCallRequest](./tryorama.cellzomecallrequest.md)<!-- -->, timeout?: number) =&gt; Promise&lt;T&gt;; cell\_id: import("@holochain/client").CellId; dna\_modifiers: import("@holochain/client").DnaModifiers; name: string; }
+
+A callable cell.
+
diff --git a/docs/tryorama.getzomecaller.md b/docs/tryorama.getzomecaller.md
@@ -2,7 +2,7 @@
 
 [Home](./index.md) &gt; [@holochain/tryorama](./tryorama.md) &gt; [getZomeCaller](./tryorama.getzomecaller.md)
 
-## getZomeCaller variable
+## getZomeCaller() function
 
 Get a shorthand function to call a cell's zome.
 
@@ -11,3 +11,17 @@ Get a shorthand function to call a cell's zome.
 ```typescript
 getZomeCaller: (cell: CallableCell, zomeName: string) => <T>(fnName: string, payload?: unknown, timeout?: number) => Promise<T>
 ```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  cell | [CallableCell](./tryorama.callablecell.md) | The cell to call the zome on. |
+|  zomeName | string | The name of the Zome to call. |
+
+**Returns:**
+
+&lt;T&gt;(fnName: string, payload?: unknown, timeout?: number) =&gt; Promise&lt;T&gt;
+
+A function to call the specified Zome.
+
diff --git a/docs/tryorama.md b/docs/tryorama.md
@@ -29,6 +29,26 @@ TryCP stands for Tryorama Control Protocol (TryCP) and is a protocol to enable r
 |  --- | --- |
 |  [NetworkType](./tryorama.networktype.md) | The network type the conductor should use to communicate with peers. |
 
+## Functions
+
+|  Function | Description |
+|  --- | --- |
+|  [addAllAgentsToAllConductors(conductors)](./tryorama.addallagentstoallconductors.md) | Add all agents of all conductors to each other. Shortcuts peer discovery through a bootstrap server or gossiping. |
+|  [areConductorCellsDhtsSynced(conductorCells)](./tryorama.areconductorcellsdhtssynced.md) | A utility function to compare conductors' integrated DhtOps. |
+|  [areDhtsSynced(players, dnaHash)](./tryorama.aredhtssynced.md) | A utility function to compare conductors' integrated DhtOps. |
+|  [cleanAllConductors()](./tryorama.cleanallconductors.md) | Run the <code>hc</code> command to delete all conductor data. |
+|  [conductorCellsDhtSync(conductorCells, interval, timeout)](./tryorama.conductorcellsdhtsync.md) | A utility function to wait until all conductors' integrated DhtOps are identical for a DNA. |
+|  [createConductor(signalingServerUrl, options)](./tryorama.createconductor.md) | The function to create a conductor. It starts a sandbox conductor via the Holochain CLI. |
+|  [createTryCpConductor(tryCpClient, options)](./tryorama.createtrycpconductor.md) | The function to create a TryCP Conductor. By default configures and starts it. |
+|  [dhtSync(players, dnaHash, interval, timeout)](./tryorama.dhtsync.md) | A utility function to wait until all conductors' integrated DhtOps are identical for a DNA. |
+|  [enableAndGetAgentApp(adminWs, appWs, appInfo)](./tryorama.enableandgetagentapp.md) | Enable an app and build an agent app object. |
+|  [getCallableCell(appWs, cell)](./tryorama.getcallablecell.md) | Create curried version of <code>callZome</code> function for a specific cell. |
+|  [getZomeCaller(cell, zomeName)](./tryorama.getzomecaller.md) | Get a shorthand function to call a cell's zome. |
+|  [pause(milliseconds)](./tryorama.pause.md) | A utility function to wait the given amount of time. |
+|  [runLocalServices()](./tryorama.runlocalservices.md) | Spawn a signalling server to enable connections between conductors. |
+|  [runScenario(testScenario, cleanUp, options)](./tryorama.runscenario.md) | A wrapper function to create and run a scenario. A scenario is created and all involved conductors are shut down and cleaned up after running. |
+|  [stopLocalServices(localServicesProcess)](./tryorama.stoplocalservices.md) | Shutdown signalling server process. |
+
 ## Interfaces
 
 |  Interface | Description |
@@ -100,22 +120,7 @@ TryCP stands for Tryorama Control Protocol (TryCP) and is a protocol to enable r
 
 |  Variable | Description |
 |  --- | --- |
-|  [addAllAgentsToAllConductors](./tryorama.addallagentstoallconductors.md) | Add all agents of all conductors to each other. Shortcuts peer discovery through a bootstrap server or gossiping. |
-|  [areConductorCellsDhtsSynced](./tryorama.areconductorcellsdhtssynced.md) | A utility function to compare conductors' integrated DhtOps. |
-|  [areDhtsSynced](./tryorama.aredhtssynced.md) | A utility function to compare conductors' integrated DhtOps. |
-|  [cleanAllConductors](./tryorama.cleanallconductors.md) | Run the <code>hc</code> command to delete all conductor data. |
-|  [conductorCellsDhtSync](./tryorama.conductorcellsdhtsync.md) | A utility function to wait until all conductors' integrated DhtOps are identical for a DNA. |
-|  [createConductor](./tryorama.createconductor.md) | The function to create a conductor. It starts a sandbox conductor via the Holochain CLI. |
-|  [createTryCpConductor](./tryorama.createtrycpconductor.md) | The function to create a TryCP Conductor. By default configures and starts it. |
 |  [DEFAULT\_PARTIAL\_PLAYER\_CONFIG](./tryorama.default_partial_player_config.md) | The default partial config for a TryCP conductor. |
-|  [dhtSync](./tryorama.dhtsync.md) | A utility function to wait until all conductors' integrated DhtOps are identical for a DNA. |
-|  [enableAndGetAgentApp](./tryorama.enableandgetagentapp.md) | Enable an app and build an agent app object. |
-|  [getCallableCell](./tryorama.getcallablecell.md) | Create curried version of <code>callZome</code> function for a specific cell. |
-|  [getZomeCaller](./tryorama.getzomecaller.md) | Get a shorthand function to call a cell's zome. |
-|  [pause](./tryorama.pause.md) | A utility function to wait the given amount of time. |
-|  [runLocalServices](./tryorama.runlocalservices.md) | Spawn a signalling server to enable connections between conductors. |
-|  [runScenario](./tryorama.runscenario.md) | A wrapper function to create and run a scenario. A scenario is created and all involved conductors are shut down and cleaned up after running. |
-|  [stopLocalServices](./tryorama.stoplocalservices.md) | Shutdown signalling server process. |
 |  [TRYCP\_SERVER\_HOST](./tryorama.trycp_server_host.md) | Default TryCP server host address. |
 |  [TRYCP\_SERVER\_PORT](./tryorama.trycp_server_port.md) | Default TryCP server port. |
 |  [TRYCP\_SUCCESS\_RESPONSE](./tryorama.trycp_success_response.md) | Empty success response. |