From cf7cda61034258c425b72f72d3415c6afa8e3be8 Mon Sep 17 00:00:00 2001 From: Matthias Date: Fri, 26 Apr 2024 13:08:55 +0200 Subject: [PATCH] build docs --- ...nt.adminapi.issueappauthenticationtoken.md | 22 +- ...inwebsocket.issueappauthenticationtoken.md | 22 +- docs/client.appauthenticationrequest.md | 108 +++---- docs/client.appauthenticationrequest.token.md | 22 +- docs/client.appauthenticationtoken.md | 24 +- docs/client.appcallzomerequest.md | 28 +- docs/client.appclient.appinfo.md | 30 +- docs/client.appclient.callzome.md | 130 ++++----- docs/client.appclient.createclonecell.md | 98 +++---- docs/client.appclient.disableclonecell.md | 98 +++---- docs/client.appclient.enableclonecell.md | 98 +++---- docs/client.appclient.md | 264 +++++++++--------- docs/client.appclient.mypubkey.md | 22 +- docs/client.appclient.networkinfo.md | 98 +++---- docs/client.appclient.on.md | 126 ++++----- docs/client.appevents.md | 108 +++---- docs/client.appevents.signal.md | 22 +- docs/client.appnetworkinforequest.md | 28 +- docs/client.appwebsocket.cachedappinfo.md | 22 +- docs/client.appwebsocket.connect.md | 20 +- ...ient.appwebsocket.getcellidfromrolename.md | 142 +++++----- docs/client.appwebsocket.md | 2 +- docs/client.appwebsocket.mypubkey.md | 22 +- docs/client.appwebsocket.on.md | 142 +++++----- docs/client.appwebsocketconnectionoptions.md | 56 ++++ ...ent.appwebsocketconnectionoptions.token.md | 11 + docs/client.deleteclonecellrequest.app_id.md | 26 +- ...nt.deleteclonecellrequest.clone_cell_id.md | 26 +- ...thenticationtokenrequest.expiry_seconds.md | 22 +- ...enticationtokenrequest.installed_app_id.md | 22 +- ...ient.issueappauthenticationtokenrequest.md | 184 ++++++------ ...ppauthenticationtokenrequest.single_use.md | 22 +- ...pauthenticationtokenresponse.expires_at.md | 22 +- ...ent.issueappauthenticationtokenresponse.md | 146 +++++----- ...sueappauthenticationtokenresponse.token.md | 22 +- docs/client.md | 9 + docs/client.wsclient.authenticate.md | 110 ++++---- package-lock.json | 19 +- 38 files changed, 1220 insertions(+), 1175 deletions(-) create mode 100644 docs/client.appwebsocketconnectionoptions.md create mode 100644 docs/client.appwebsocketconnectionoptions.token.md diff --git a/docs/client.adminapi.issueappauthenticationtoken.md b/docs/client.adminapi.issueappauthenticationtoken.md index e671f8b7..e0841f83 100644 --- a/docs/client.adminapi.issueappauthenticationtoken.md +++ b/docs/client.adminapi.issueappauthenticationtoken.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AdminApi](./client.adminapi.md) > [issueAppAuthenticationToken](./client.adminapi.issueappauthenticationtoken.md) - -## AdminApi.issueAppAuthenticationToken property - -**Signature:** - -```typescript -issueAppAuthenticationToken: Requester; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [AdminApi](./client.adminapi.md) > [issueAppAuthenticationToken](./client.adminapi.issueappauthenticationtoken.md) + +## AdminApi.issueAppAuthenticationToken property + +**Signature:** + +```typescript +issueAppAuthenticationToken: Requester; +``` diff --git a/docs/client.adminwebsocket.issueappauthenticationtoken.md b/docs/client.adminwebsocket.issueappauthenticationtoken.md index ffe21604..1902a0e0 100644 --- a/docs/client.adminwebsocket.issueappauthenticationtoken.md +++ b/docs/client.adminwebsocket.issueappauthenticationtoken.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AdminWebsocket](./client.adminwebsocket.md) > [issueAppAuthenticationToken](./client.adminwebsocket.issueappauthenticationtoken.md) - -## AdminWebsocket.issueAppAuthenticationToken property - -**Signature:** - -```typescript -issueAppAuthenticationToken: Requester; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [AdminWebsocket](./client.adminwebsocket.md) > [issueAppAuthenticationToken](./client.adminwebsocket.issueappauthenticationtoken.md) + +## AdminWebsocket.issueAppAuthenticationToken property + +**Signature:** + +```typescript +issueAppAuthenticationToken: Requester; +``` diff --git a/docs/client.appauthenticationrequest.md b/docs/client.appauthenticationrequest.md index 649ed1ea..467fec66 100644 --- a/docs/client.appauthenticationrequest.md +++ b/docs/client.appauthenticationrequest.md @@ -1,54 +1,54 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAuthenticationRequest](./client.appauthenticationrequest.md) - -## AppAuthenticationRequest interface - - -**Signature:** - -```typescript -export interface AppAuthenticationRequest -``` - -## Properties - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[token](./client.appauthenticationrequest.token.md) - - - - - - - -[AppAuthenticationToken](./client.appauthenticationtoken.md) - - - - - -
+ + +[Home](./index.md) > [@holochain/client](./client.md) > [AppAuthenticationRequest](./client.appauthenticationrequest.md) + +## AppAuthenticationRequest interface + + +**Signature:** + +```typescript +export interface AppAuthenticationRequest +``` + +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[token](./client.appauthenticationrequest.token.md) + + + + + + + +[AppAuthenticationToken](./client.appauthenticationtoken.md) + + + + + +
diff --git a/docs/client.appauthenticationrequest.token.md b/docs/client.appauthenticationrequest.token.md index f4847b15..f1987e62 100644 --- a/docs/client.appauthenticationrequest.token.md +++ b/docs/client.appauthenticationrequest.token.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAuthenticationRequest](./client.appauthenticationrequest.md) > [token](./client.appauthenticationrequest.token.md) - -## AppAuthenticationRequest.token property - -**Signature:** - -```typescript -token: AppAuthenticationToken; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppAuthenticationRequest](./client.appauthenticationrequest.md) > [token](./client.appauthenticationrequest.token.md) + +## AppAuthenticationRequest.token property + +**Signature:** + +```typescript +token: AppAuthenticationToken; +``` diff --git a/docs/client.appauthenticationtoken.md b/docs/client.appauthenticationtoken.md index c83beef3..8cda8f20 100644 --- a/docs/client.appauthenticationtoken.md +++ b/docs/client.appauthenticationtoken.md @@ -1,12 +1,12 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppAuthenticationToken](./client.appauthenticationtoken.md) - -## AppAuthenticationToken type - - -**Signature:** - -```typescript -export type AppAuthenticationToken = number[]; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppAuthenticationToken](./client.appauthenticationtoken.md) + +## AppAuthenticationToken type + + +**Signature:** + +```typescript +export type AppAuthenticationToken = number[]; +``` diff --git a/docs/client.appcallzomerequest.md b/docs/client.appcallzomerequest.md index e53605a2..e34e930e 100644 --- a/docs/client.appcallzomerequest.md +++ b/docs/client.appcallzomerequest.md @@ -1,14 +1,14 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppCallZomeRequest](./client.appcallzomerequest.md) - -## AppCallZomeRequest type - - -**Signature:** - -```typescript -export type AppCallZomeRequest = NonProvenanceCallZomeRequest | RoleNameCallZomeRequest | CallZomeRequestSigned | RoleNameCallZomeRequestSigned; -``` -**References:** [NonProvenanceCallZomeRequest](./client.nonprovenancecallzomerequest.md), [RoleNameCallZomeRequest](./client.rolenamecallzomerequest.md), [CallZomeRequestSigned](./client.callzomerequestsigned.md), [RoleNameCallZomeRequestSigned](./client.rolenamecallzomerequestsigned.md) - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppCallZomeRequest](./client.appcallzomerequest.md) + +## AppCallZomeRequest type + + +**Signature:** + +```typescript +export type AppCallZomeRequest = NonProvenanceCallZomeRequest | RoleNameCallZomeRequest | CallZomeRequestSigned | RoleNameCallZomeRequestSigned; +``` +**References:** [NonProvenanceCallZomeRequest](./client.nonprovenancecallzomerequest.md), [RoleNameCallZomeRequest](./client.rolenamecallzomerequest.md), [CallZomeRequestSigned](./client.callzomerequestsigned.md), [RoleNameCallZomeRequestSigned](./client.rolenamecallzomerequestsigned.md) + diff --git a/docs/client.appclient.appinfo.md b/docs/client.appclient.appinfo.md index 6c55abf8..c42fb073 100644 --- a/docs/client.appclient.appinfo.md +++ b/docs/client.appclient.appinfo.md @@ -1,15 +1,15 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [appInfo](./client.appclient.appinfo.md) - -## AppClient.appInfo() method - -**Signature:** - -```typescript -appInfo(): Promise; -``` -**Returns:** - -Promise<[AppInfoResponse](./client.appinforesponse.md)> - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [appInfo](./client.appclient.appinfo.md) + +## AppClient.appInfo() method + +**Signature:** + +```typescript +appInfo(): Promise; +``` +**Returns:** + +Promise<[AppInfoResponse](./client.appinforesponse.md)> + diff --git a/docs/client.appclient.callzome.md b/docs/client.appclient.callzome.md index 8fe0d04b..b47dc9fc 100644 --- a/docs/client.appclient.callzome.md +++ b/docs/client.appclient.callzome.md @@ -1,65 +1,65 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [callZome](./client.appclient.callzome.md) - -## AppClient.callZome() method - -**Signature:** - -```typescript -callZome(args: AppCallZomeRequest, timeout?: number): Promise; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -args - - - - -[AppCallZomeRequest](./client.appcallzomerequest.md) - - - - - -
- -timeout - - - - -number - - - - -_(Optional)_ - - -
-**Returns:** - -Promise<any> - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [callZome](./client.appclient.callzome.md) + +## AppClient.callZome() method + +**Signature:** + +```typescript +callZome(args: AppCallZomeRequest, timeout?: number): Promise; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +args + + + + +[AppCallZomeRequest](./client.appcallzomerequest.md) + + + + + +
+ +timeout + + + + +number + + + + +_(Optional)_ + + +
+**Returns:** + +Promise<any> + diff --git a/docs/client.appclient.createclonecell.md b/docs/client.appclient.createclonecell.md index 6453995d..3f014316 100644 --- a/docs/client.appclient.createclonecell.md +++ b/docs/client.appclient.createclonecell.md @@ -1,49 +1,49 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [createCloneCell](./client.appclient.createclonecell.md) - -## AppClient.createCloneCell() method - -**Signature:** - -```typescript -createCloneCell(args: AppCreateCloneCellRequest): Promise; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -args - - - - -[AppCreateCloneCellRequest](./client.appcreateclonecellrequest.md) - - - - - -
-**Returns:** - -Promise<[CreateCloneCellResponse](./client.createclonecellresponse.md)> - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [createCloneCell](./client.appclient.createclonecell.md) + +## AppClient.createCloneCell() method + +**Signature:** + +```typescript +createCloneCell(args: AppCreateCloneCellRequest): Promise; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +args + + + + +[AppCreateCloneCellRequest](./client.appcreateclonecellrequest.md) + + + + + +
+**Returns:** + +Promise<[CreateCloneCellResponse](./client.createclonecellresponse.md)> + diff --git a/docs/client.appclient.disableclonecell.md b/docs/client.appclient.disableclonecell.md index df4166e3..1d92507c 100644 --- a/docs/client.appclient.disableclonecell.md +++ b/docs/client.appclient.disableclonecell.md @@ -1,49 +1,49 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [disableCloneCell](./client.appclient.disableclonecell.md) - -## AppClient.disableCloneCell() method - -**Signature:** - -```typescript -disableCloneCell(args: AppDisableCloneCellRequest): Promise; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -args - - - - -[AppDisableCloneCellRequest](./client.appdisableclonecellrequest.md) - - - - - -
-**Returns:** - -Promise<[DisableCloneCellResponse](./client.disableclonecellresponse.md)> - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [disableCloneCell](./client.appclient.disableclonecell.md) + +## AppClient.disableCloneCell() method + +**Signature:** + +```typescript +disableCloneCell(args: AppDisableCloneCellRequest): Promise; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +args + + + + +[AppDisableCloneCellRequest](./client.appdisableclonecellrequest.md) + + + + + +
+**Returns:** + +Promise<[DisableCloneCellResponse](./client.disableclonecellresponse.md)> + diff --git a/docs/client.appclient.enableclonecell.md b/docs/client.appclient.enableclonecell.md index 5d287236..4bec4230 100644 --- a/docs/client.appclient.enableclonecell.md +++ b/docs/client.appclient.enableclonecell.md @@ -1,49 +1,49 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [enableCloneCell](./client.appclient.enableclonecell.md) - -## AppClient.enableCloneCell() method - -**Signature:** - -```typescript -enableCloneCell(args: AppEnableCloneCellRequest): Promise; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -args - - - - -[AppEnableCloneCellRequest](./client.appenableclonecellrequest.md) - - - - - -
-**Returns:** - -Promise<[EnableCloneCellResponse](./client.enableclonecellresponse.md)> - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [enableCloneCell](./client.appclient.enableclonecell.md) + +## AppClient.enableCloneCell() method + +**Signature:** + +```typescript +enableCloneCell(args: AppEnableCloneCellRequest): Promise; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +args + + + + +[AppEnableCloneCellRequest](./client.appenableclonecellrequest.md) + + + + + +
+**Returns:** + +Promise<[EnableCloneCellResponse](./client.enableclonecellresponse.md)> + diff --git a/docs/client.appclient.md b/docs/client.appclient.md index e3f84486..de2b5464 100644 --- a/docs/client.appclient.md +++ b/docs/client.appclient.md @@ -1,132 +1,132 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) - -## AppClient interface - - -**Signature:** - -```typescript -export interface AppClient -``` - -## Properties - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[myPubKey](./client.appclient.mypubkey.md) - - - - - - - -[AgentPubKey](./client.agentpubkey.md) - - - - - -
- -## Methods - - - - - - - - - -
- -Method - - - - -Description - - -
- -[appInfo()](./client.appclient.appinfo.md) - - - - - -
- -[callZome(args, timeout)](./client.appclient.callzome.md) - - - - - -
- -[createCloneCell(args)](./client.appclient.createclonecell.md) - - - - - -
- -[disableCloneCell(args)](./client.appclient.disableclonecell.md) - - - - - -
- -[enableCloneCell(args)](./client.appclient.enableclonecell.md) - - - - - -
- -[networkInfo(args)](./client.appclient.networkinfo.md) - - - - - -
- -[on(eventName, listener)](./client.appclient.on.md) - - - - - -
+ + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) + +## AppClient interface + + +**Signature:** + +```typescript +export interface AppClient +``` + +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[myPubKey](./client.appclient.mypubkey.md) + + + + + + + +[AgentPubKey](./client.agentpubkey.md) + + + + + +
+ +## Methods + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[appInfo()](./client.appclient.appinfo.md) + + + + + +
+ +[callZome(args, timeout)](./client.appclient.callzome.md) + + + + + +
+ +[createCloneCell(args)](./client.appclient.createclonecell.md) + + + + + +
+ +[disableCloneCell(args)](./client.appclient.disableclonecell.md) + + + + + +
+ +[enableCloneCell(args)](./client.appclient.enableclonecell.md) + + + + + +
+ +[networkInfo(args)](./client.appclient.networkinfo.md) + + + + + +
+ +[on(eventName, listener)](./client.appclient.on.md) + + + + + +
diff --git a/docs/client.appclient.mypubkey.md b/docs/client.appclient.mypubkey.md index e549571b..65d01332 100644 --- a/docs/client.appclient.mypubkey.md +++ b/docs/client.appclient.mypubkey.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [myPubKey](./client.appclient.mypubkey.md) - -## AppClient.myPubKey property - -**Signature:** - -```typescript -myPubKey: AgentPubKey; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [myPubKey](./client.appclient.mypubkey.md) + +## AppClient.myPubKey property + +**Signature:** + +```typescript +myPubKey: AgentPubKey; +``` diff --git a/docs/client.appclient.networkinfo.md b/docs/client.appclient.networkinfo.md index e33e0f9b..a642230a 100644 --- a/docs/client.appclient.networkinfo.md +++ b/docs/client.appclient.networkinfo.md @@ -1,49 +1,49 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [networkInfo](./client.appclient.networkinfo.md) - -## AppClient.networkInfo() method - -**Signature:** - -```typescript -networkInfo(args: AppNetworkInfoRequest): Promise; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -args - - - - -[AppNetworkInfoRequest](./client.appnetworkinforequest.md) - - - - - -
-**Returns:** - -Promise<[NetworkInfoResponse](./client.networkinforesponse.md)> - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [networkInfo](./client.appclient.networkinfo.md) + +## AppClient.networkInfo() method + +**Signature:** + +```typescript +networkInfo(args: AppNetworkInfoRequest): Promise; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +args + + + + +[AppNetworkInfoRequest](./client.appnetworkinforequest.md) + + + + + +
+**Returns:** + +Promise<[NetworkInfoResponse](./client.networkinforesponse.md)> + diff --git a/docs/client.appclient.on.md b/docs/client.appclient.on.md index 52dc2302..ffab24a8 100644 --- a/docs/client.appclient.on.md +++ b/docs/client.appclient.on.md @@ -1,63 +1,63 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [on](./client.appclient.on.md) - -## AppClient.on() method - -**Signature:** - -```typescript -on(eventName: Name | readonly Name[], listener: AppSignalCb): UnsubscribeFunction; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -eventName - - - - -Name \| readonly Name\[\] - - - - - -
- -listener - - - - -[AppSignalCb](./client.appsignalcb.md) - - - - - -
-**Returns:** - -UnsubscribeFunction - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppClient](./client.appclient.md) > [on](./client.appclient.on.md) + +## AppClient.on() method + +**Signature:** + +```typescript +on(eventName: Name | readonly Name[], listener: AppSignalCb): UnsubscribeFunction; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +eventName + + + + +Name \| readonly Name\[\] + + + + + +
+ +listener + + + + +[AppSignalCb](./client.appsignalcb.md) + + + + + +
+**Returns:** + +UnsubscribeFunction + diff --git a/docs/client.appevents.md b/docs/client.appevents.md index 0b6a275f..bc8f1ce9 100644 --- a/docs/client.appevents.md +++ b/docs/client.appevents.md @@ -1,54 +1,54 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppEvents](./client.appevents.md) - -## AppEvents interface - - -**Signature:** - -```typescript -export interface AppEvents -``` - -## Properties - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[signal](./client.appevents.signal.md) - - - - - - - -[AppSignal](./client.appsignal.md) - - - - - -
+ + +[Home](./index.md) > [@holochain/client](./client.md) > [AppEvents](./client.appevents.md) + +## AppEvents interface + + +**Signature:** + +```typescript +export interface AppEvents +``` + +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[signal](./client.appevents.signal.md) + + + + + + + +[AppSignal](./client.appsignal.md) + + + + + +
diff --git a/docs/client.appevents.signal.md b/docs/client.appevents.signal.md index 0361ce4c..8549ae85 100644 --- a/docs/client.appevents.signal.md +++ b/docs/client.appevents.signal.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppEvents](./client.appevents.md) > [signal](./client.appevents.signal.md) - -## AppEvents.signal property - -**Signature:** - -```typescript -signal: AppSignal; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppEvents](./client.appevents.md) > [signal](./client.appevents.signal.md) + +## AppEvents.signal property + +**Signature:** + +```typescript +signal: AppSignal; +``` diff --git a/docs/client.appnetworkinforequest.md b/docs/client.appnetworkinforequest.md index 3d76e861..b64dacd5 100644 --- a/docs/client.appnetworkinforequest.md +++ b/docs/client.appnetworkinforequest.md @@ -1,14 +1,14 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppNetworkInfoRequest](./client.appnetworkinforequest.md) - -## AppNetworkInfoRequest type - - -**Signature:** - -```typescript -export type AppNetworkInfoRequest = Omit; -``` -**References:** [NetworkInfoRequest](./client.networkinforequest.md) - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppNetworkInfoRequest](./client.appnetworkinforequest.md) + +## AppNetworkInfoRequest type + + +**Signature:** + +```typescript +export type AppNetworkInfoRequest = Omit; +``` +**References:** [NetworkInfoRequest](./client.networkinforequest.md) + diff --git a/docs/client.appwebsocket.cachedappinfo.md b/docs/client.appwebsocket.cachedappinfo.md index c8a228a5..4943f280 100644 --- a/docs/client.appwebsocket.cachedappinfo.md +++ b/docs/client.appwebsocket.cachedappinfo.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [cachedAppInfo](./client.appwebsocket.cachedappinfo.md) - -## AppWebsocket.cachedAppInfo property - -**Signature:** - -```typescript -cachedAppInfo?: AppInfo | null; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [cachedAppInfo](./client.appwebsocket.cachedappinfo.md) + +## AppWebsocket.cachedAppInfo property + +**Signature:** + +```typescript +cachedAppInfo?: AppInfo | null; +``` diff --git a/docs/client.appwebsocket.connect.md b/docs/client.appwebsocket.connect.md index 2289dd8f..40703a9b 100644 --- a/docs/client.appwebsocket.connect.md +++ b/docs/client.appwebsocket.connect.md @@ -9,7 +9,7 @@ Instance factory for creating an [AppWebsocket](./client.appwebsocket.md) - -[Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [getCellIdFromRoleName](./client.appwebsocket.getcellidfromrolename.md) - -## AppWebsocket.getCellIdFromRoleName() method - -Get a cell id by its role name or clone id. - -**Signature:** - -```typescript -getCellIdFromRoleName(roleName: RoleName, appInfo: AppInfo): CellId; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -roleName - - - - -[RoleName](./client.rolename.md) - - - - -The role name or clone id of the cell. - - -
- -appInfo - - - - -[AppInfo](./client.appinfo.md) - - - - -The app info containing all cell infos. - - -
-**Returns:** - -[CellId](./client.cellid.md) - -The cell id or throws an error if not found. - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [getCellIdFromRoleName](./client.appwebsocket.getcellidfromrolename.md) + +## AppWebsocket.getCellIdFromRoleName() method + +Get a cell id by its role name or clone id. + +**Signature:** + +```typescript +getCellIdFromRoleName(roleName: RoleName, appInfo: AppInfo): CellId; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +roleName + + + + +[RoleName](./client.rolename.md) + + + + +The role name or clone id of the cell. + + +
+ +appInfo + + + + +[AppInfo](./client.appinfo.md) + + + + +The app info containing all cell infos. + + +
+**Returns:** + +[CellId](./client.cellid.md) + +The cell id or throws an error if not found. + diff --git a/docs/client.appwebsocket.md b/docs/client.appwebsocket.md index 1402277b..27963ddc 100644 --- a/docs/client.appwebsocket.md +++ b/docs/client.appwebsocket.md @@ -143,7 +143,7 @@ Call a zome. -[connect(token, options)](./client.appwebsocket.connect.md) +[connect(options)](./client.appwebsocket.connect.md) diff --git a/docs/client.appwebsocket.mypubkey.md b/docs/client.appwebsocket.mypubkey.md index 4a67aeab..e6852309 100644 --- a/docs/client.appwebsocket.mypubkey.md +++ b/docs/client.appwebsocket.mypubkey.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [myPubKey](./client.appwebsocket.mypubkey.md) - -## AppWebsocket.myPubKey property - -**Signature:** - -```typescript -readonly myPubKey: AgentPubKey; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [myPubKey](./client.appwebsocket.mypubkey.md) + +## AppWebsocket.myPubKey property + +**Signature:** + +```typescript +readonly myPubKey: AgentPubKey; +``` diff --git a/docs/client.appwebsocket.on.md b/docs/client.appwebsocket.on.md index 6cc27a9f..110172e3 100644 --- a/docs/client.appwebsocket.on.md +++ b/docs/client.appwebsocket.on.md @@ -1,71 +1,71 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [on](./client.appwebsocket.on.md) - -## AppWebsocket.on() method - -Register an event listener for signals. - -**Signature:** - -```typescript -on(eventName: Name | readonly Name[], listener: AppSignalCb): UnsubscribeFunction; -``` - -## Parameters - - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -eventName - - - - -Name \| readonly Name\[\] - - - - -Event name to listen to (currently only "signal"). - - -
- -listener - - - - -[AppSignalCb](./client.appsignalcb.md) - - - - -The function to call when event is triggered. - - -
-**Returns:** - -UnsubscribeFunction - -A function to unsubscribe the event listener. - + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocket](./client.appwebsocket.md) > [on](./client.appwebsocket.on.md) + +## AppWebsocket.on() method + +Register an event listener for signals. + +**Signature:** + +```typescript +on(eventName: Name | readonly Name[], listener: AppSignalCb): UnsubscribeFunction; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +eventName + + + + +Name \| readonly Name\[\] + + + + +Event name to listen to (currently only "signal"). + + +
+ +listener + + + + +[AppSignalCb](./client.appsignalcb.md) + + + + +The function to call when event is triggered. + + +
+**Returns:** + +UnsubscribeFunction + +A function to unsubscribe the event listener. + diff --git a/docs/client.appwebsocketconnectionoptions.md b/docs/client.appwebsocketconnectionoptions.md new file mode 100644 index 00000000..d4148674 --- /dev/null +++ b/docs/client.appwebsocketconnectionoptions.md @@ -0,0 +1,56 @@ + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocketConnectionOptions](./client.appwebsocketconnectionoptions.md) + +## AppWebsocketConnectionOptions interface + +**Signature:** + +```typescript +export interface AppWebsocketConnectionOptions extends WebsocketConnectionOptions +``` +**Extends:** [WebsocketConnectionOptions](./client.websocketconnectionoptions.md) + +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[token?](./client.appwebsocketconnectionoptions.token.md) + + + + + + + +[AppAuthenticationToken](./client.appauthenticationtoken.md) + + + + +_(Optional)_ + + +
diff --git a/docs/client.appwebsocketconnectionoptions.token.md b/docs/client.appwebsocketconnectionoptions.token.md new file mode 100644 index 00000000..e52323eb --- /dev/null +++ b/docs/client.appwebsocketconnectionoptions.token.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@holochain/client](./client.md) > [AppWebsocketConnectionOptions](./client.appwebsocketconnectionoptions.md) > [token](./client.appwebsocketconnectionoptions.token.md) + +## AppWebsocketConnectionOptions.token property + +**Signature:** + +```typescript +token?: AppAuthenticationToken; +``` diff --git a/docs/client.deleteclonecellrequest.app_id.md b/docs/client.deleteclonecellrequest.app_id.md index 44301209..00bf6115 100644 --- a/docs/client.deleteclonecellrequest.app_id.md +++ b/docs/client.deleteclonecellrequest.app_id.md @@ -1,13 +1,13 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [DeleteCloneCellRequest](./client.deleteclonecellrequest.md) > [app\_id](./client.deleteclonecellrequest.app_id.md) - -## DeleteCloneCellRequest.app\_id property - -The app id that the clone cell belongs to - -**Signature:** - -```typescript -app_id: InstalledAppId; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [DeleteCloneCellRequest](./client.deleteclonecellrequest.md) > [app\_id](./client.deleteclonecellrequest.app_id.md) + +## DeleteCloneCellRequest.app\_id property + +The app id that the clone cell belongs to + +**Signature:** + +```typescript +app_id: InstalledAppId; +``` diff --git a/docs/client.deleteclonecellrequest.clone_cell_id.md b/docs/client.deleteclonecellrequest.clone_cell_id.md index fb6e6cf5..a365547c 100644 --- a/docs/client.deleteclonecellrequest.clone_cell_id.md +++ b/docs/client.deleteclonecellrequest.clone_cell_id.md @@ -1,13 +1,13 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [DeleteCloneCellRequest](./client.deleteclonecellrequest.md) > [clone\_cell\_id](./client.deleteclonecellrequest.clone_cell_id.md) - -## DeleteCloneCellRequest.clone\_cell\_id property - -The clone id or cell id of the clone cell - -**Signature:** - -```typescript -clone_cell_id: RoleName | CellId; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [DeleteCloneCellRequest](./client.deleteclonecellrequest.md) > [clone\_cell\_id](./client.deleteclonecellrequest.clone_cell_id.md) + +## DeleteCloneCellRequest.clone\_cell\_id property + +The clone id or cell id of the clone cell + +**Signature:** + +```typescript +clone_cell_id: RoleName | CellId; +``` diff --git a/docs/client.issueappauthenticationtokenrequest.expiry_seconds.md b/docs/client.issueappauthenticationtokenrequest.expiry_seconds.md index 515c8313..f01c8f55 100644 --- a/docs/client.issueappauthenticationtokenrequest.expiry_seconds.md +++ b/docs/client.issueappauthenticationtokenrequest.expiry_seconds.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenRequest](./client.issueappauthenticationtokenrequest.md) > [expiry\_seconds](./client.issueappauthenticationtokenrequest.expiry_seconds.md) - -## IssueAppAuthenticationTokenRequest.expiry\_seconds property - -**Signature:** - -```typescript -expiry_seconds?: number; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenRequest](./client.issueappauthenticationtokenrequest.md) > [expiry\_seconds](./client.issueappauthenticationtokenrequest.expiry_seconds.md) + +## IssueAppAuthenticationTokenRequest.expiry\_seconds property + +**Signature:** + +```typescript +expiry_seconds?: number; +``` diff --git a/docs/client.issueappauthenticationtokenrequest.installed_app_id.md b/docs/client.issueappauthenticationtokenrequest.installed_app_id.md index 015f4a27..b1ee5af0 100644 --- a/docs/client.issueappauthenticationtokenrequest.installed_app_id.md +++ b/docs/client.issueappauthenticationtokenrequest.installed_app_id.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenRequest](./client.issueappauthenticationtokenrequest.md) > [installed\_app\_id](./client.issueappauthenticationtokenrequest.installed_app_id.md) - -## IssueAppAuthenticationTokenRequest.installed\_app\_id property - -**Signature:** - -```typescript -installed_app_id: InstalledAppId; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenRequest](./client.issueappauthenticationtokenrequest.md) > [installed\_app\_id](./client.issueappauthenticationtokenrequest.installed_app_id.md) + +## IssueAppAuthenticationTokenRequest.installed\_app\_id property + +**Signature:** + +```typescript +installed_app_id: InstalledAppId; +``` diff --git a/docs/client.issueappauthenticationtokenrequest.md b/docs/client.issueappauthenticationtokenrequest.md index 79a8fc9b..e72c7c7a 100644 --- a/docs/client.issueappauthenticationtokenrequest.md +++ b/docs/client.issueappauthenticationtokenrequest.md @@ -1,92 +1,92 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenRequest](./client.issueappauthenticationtokenrequest.md) - -## IssueAppAuthenticationTokenRequest interface - - -**Signature:** - -```typescript -export interface IssueAppAuthenticationTokenRequest -``` - -## Properties - - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[expiry\_seconds?](./client.issueappauthenticationtokenrequest.expiry_seconds.md) - - - - - - - -number - - - - -_(Optional)_ - - -
- -[installed\_app\_id](./client.issueappauthenticationtokenrequest.installed_app_id.md) - - - - - - - -[InstalledAppId](./client.installedappid.md) - - - - - -
- -[single\_use?](./client.issueappauthenticationtokenrequest.single_use.md) - - - - - - - -boolean - - - - -_(Optional)_ - - -
+ + +[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenRequest](./client.issueappauthenticationtokenrequest.md) + +## IssueAppAuthenticationTokenRequest interface + + +**Signature:** + +```typescript +export interface IssueAppAuthenticationTokenRequest +``` + +## Properties + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[expiry\_seconds?](./client.issueappauthenticationtokenrequest.expiry_seconds.md) + + + + + + + +number + + + + +_(Optional)_ + + +
+ +[installed\_app\_id](./client.issueappauthenticationtokenrequest.installed_app_id.md) + + + + + + + +[InstalledAppId](./client.installedappid.md) + + + + + +
+ +[single\_use?](./client.issueappauthenticationtokenrequest.single_use.md) + + + + + + + +boolean + + + + +_(Optional)_ + + +
diff --git a/docs/client.issueappauthenticationtokenrequest.single_use.md b/docs/client.issueappauthenticationtokenrequest.single_use.md index 9e2dc6f0..745fdf44 100644 --- a/docs/client.issueappauthenticationtokenrequest.single_use.md +++ b/docs/client.issueappauthenticationtokenrequest.single_use.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenRequest](./client.issueappauthenticationtokenrequest.md) > [single\_use](./client.issueappauthenticationtokenrequest.single_use.md) - -## IssueAppAuthenticationTokenRequest.single\_use property - -**Signature:** - -```typescript -single_use?: boolean; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenRequest](./client.issueappauthenticationtokenrequest.md) > [single\_use](./client.issueappauthenticationtokenrequest.single_use.md) + +## IssueAppAuthenticationTokenRequest.single\_use property + +**Signature:** + +```typescript +single_use?: boolean; +``` diff --git a/docs/client.issueappauthenticationtokenresponse.expires_at.md b/docs/client.issueappauthenticationtokenresponse.expires_at.md index b7ab209c..63e3dd1d 100644 --- a/docs/client.issueappauthenticationtokenresponse.expires_at.md +++ b/docs/client.issueappauthenticationtokenresponse.expires_at.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenResponse](./client.issueappauthenticationtokenresponse.md) > [expires\_at](./client.issueappauthenticationtokenresponse.expires_at.md) - -## IssueAppAuthenticationTokenResponse.expires\_at property - -**Signature:** - -```typescript -expires_at?: Timestamp; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenResponse](./client.issueappauthenticationtokenresponse.md) > [expires\_at](./client.issueappauthenticationtokenresponse.expires_at.md) + +## IssueAppAuthenticationTokenResponse.expires\_at property + +**Signature:** + +```typescript +expires_at?: Timestamp; +``` diff --git a/docs/client.issueappauthenticationtokenresponse.md b/docs/client.issueappauthenticationtokenresponse.md index c13289d8..457e46b0 100644 --- a/docs/client.issueappauthenticationtokenresponse.md +++ b/docs/client.issueappauthenticationtokenresponse.md @@ -1,73 +1,73 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenResponse](./client.issueappauthenticationtokenresponse.md) - -## IssueAppAuthenticationTokenResponse interface - - -**Signature:** - -```typescript -export interface IssueAppAuthenticationTokenResponse -``` - -## Properties - - - - -
- -Property - - - - -Modifiers - - - - -Type - - - - -Description - - -
- -[expires\_at?](./client.issueappauthenticationtokenresponse.expires_at.md) - - - - - - - -[Timestamp](./client.timestamp.md) - - - - -_(Optional)_ - - -
- -[token](./client.issueappauthenticationtokenresponse.token.md) - - - - - - - -[AppAuthenticationToken](./client.appauthenticationtoken.md) - - - - - -
+ + +[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenResponse](./client.issueappauthenticationtokenresponse.md) + +## IssueAppAuthenticationTokenResponse interface + + +**Signature:** + +```typescript +export interface IssueAppAuthenticationTokenResponse +``` + +## Properties + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[expires\_at?](./client.issueappauthenticationtokenresponse.expires_at.md) + + + + + + + +[Timestamp](./client.timestamp.md) + + + + +_(Optional)_ + + +
+ +[token](./client.issueappauthenticationtokenresponse.token.md) + + + + + + + +[AppAuthenticationToken](./client.appauthenticationtoken.md) + + + + + +
diff --git a/docs/client.issueappauthenticationtokenresponse.token.md b/docs/client.issueappauthenticationtokenresponse.token.md index 406b1786..ce22e841 100644 --- a/docs/client.issueappauthenticationtokenresponse.token.md +++ b/docs/client.issueappauthenticationtokenresponse.token.md @@ -1,11 +1,11 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenResponse](./client.issueappauthenticationtokenresponse.md) > [token](./client.issueappauthenticationtokenresponse.token.md) - -## IssueAppAuthenticationTokenResponse.token property - -**Signature:** - -```typescript -token: AppAuthenticationToken; -``` + + +[Home](./index.md) > [@holochain/client](./client.md) > [IssueAppAuthenticationTokenResponse](./client.issueappauthenticationtokenresponse.md) > [token](./client.issueappauthenticationtokenresponse.token.md) + +## IssueAppAuthenticationTokenResponse.token property + +**Signature:** + +```typescript +token: AppAuthenticationToken; +``` diff --git a/docs/client.md b/docs/client.md index 1054a6da..923257da 100644 --- a/docs/client.md +++ b/docs/client.md @@ -528,6 +528,15 @@ Description + + + +[AppWebsocketConnectionOptions](./client.appwebsocketconnectionoptions.md) + + + + + diff --git a/docs/client.wsclient.authenticate.md b/docs/client.wsclient.authenticate.md index 8c1af80b..4c548b49 100644 --- a/docs/client.wsclient.authenticate.md +++ b/docs/client.wsclient.authenticate.md @@ -1,55 +1,55 @@ - - -[Home](./index.md) > [@holochain/client](./client.md) > [WsClient](./client.wsclient.md) > [authenticate](./client.wsclient.authenticate.md) - -## WsClient.authenticate() method - -Authenticate the client with the conductor. - -This is only relevant for app websockets. - -**Signature:** - -```typescript -authenticate(request: AppAuthenticationRequest): Promise; -``` - -## Parameters - - - -
- -Parameter - - - - -Type - - - - -Description - - -
- -request - - - - -[AppAuthenticationRequest](./client.appauthenticationrequest.md) - - - - -The authentication request, containing an app authentication token. - - -
-**Returns:** - -Promise<void> - + + +[Home](./index.md) > [@holochain/client](./client.md) > [WsClient](./client.wsclient.md) > [authenticate](./client.wsclient.authenticate.md) + +## WsClient.authenticate() method + +Authenticate the client with the conductor. + +This is only relevant for app websockets. + +**Signature:** + +```typescript +authenticate(request: AppAuthenticationRequest): Promise; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +request + + + + +[AppAuthenticationRequest](./client.appauthenticationrequest.md) + + + + +The authentication request, containing an app authentication token. + + +
+**Returns:** + +Promise<void> + diff --git a/package-lock.json b/package-lock.json index 1ab07ffd..d7674f79 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,18 +1,17 @@ { "name": "@holochain/client", - "version": "0.17.0-dev.9", + "version": "0.17.0-dev.10", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@holochain/client", - "version": "0.17.0-dev.9", + "version": "0.17.0-dev.10", "license": "CAL-1.0", "dependencies": { "@bitgo/blake2b": "^3.2.4", "@holochain/serialization": "^0.1.0-beta-rc.3", "@msgpack/msgpack": "^2.8.0", - "@tauri-apps/api": "^1.4.0", "emittery": "^1.0.1", "isomorphic-ws": "^5.0.0", "js-base64": "^3.7.5", @@ -807,20 +806,6 @@ "string-argv": "~0.3.1" } }, - "node_modules/@tauri-apps/api": { - "version": "1.5.3", - "resolved": "https://registry.npmjs.org/@tauri-apps/api/-/api-1.5.3.tgz", - "integrity": "sha512-zxnDjHHKjOsrIzZm6nO5Xapb/BxqUq1tc7cGkFXsFkGTsSWgCPH1D8mm0XS9weJY2OaR73I3k3S+b7eSzJDfqA==", - "engines": { - "node": ">= 14.6.0", - "npm": ">= 6.6.0", - "yarn": ">= 1.19.1" - }, - "funding": { - "type": "opencollective", - "url": "https://opencollective.com/tauri" - } - }, "node_modules/@types/argparse": { "version": "1.0.38", "resolved": "https://registry.npmjs.org/@types/argparse/-/argparse-1.0.38.tgz",