@synonymdev/pubky 0.1.14 → 0.1.15

package/README.md

@@ -67,35 +67,65 @@ await client.delete(url);
 let client = new PubkyClient()
 ```
 
-#### createRecoveryFile
+#### signup
 ```js
-let recoveryFile = PubkyClient.createRecoveryFile(keypair, passphrase)
+await client.signup(keypair, homeserver)
 ```
 - keypair: An instance of [Keypair](#keypair).
-- passphrase: A utf-8 string [passphrase](https://www.useapassphrase.com/).
-- Returns: A recovery file with a spec line and an encrypted secret key.
+- homeserver: An instance of [PublicKey](#publickey) representing the homeserver.
 
-#### createRecoveryFile
+Returns:
+- session: An instance of [Session](#session).
+
+#### signin
 ```js
-let keypair = PubkyClient.decryptRecoveryfile(recoveryFile, passphrase)
+let session = await client.signin(keypair)
 ```
-- recoveryFile: An instance of Uint8Array containing the recovery file blob.
-- passphrase: A utf-8 string [passphrase](https://www.useapassphrase.com/).
-- Returns: An instance of [Keypair](#keypair).
+- keypair: An instance of [Keypair](#keypair).
 
-#### signup
+Returns:
+- An instance of [Session](#session).
+
+#### signout
 ```js
-await client.signup(keypair, homeserver)
+await client.signout(publicKey)
 ```
-- keypair: An instance of [Keypair](#keypair).
-- homeserver: An instance of [PublicKey](#publickey) representing the homeserver.
+- publicKey: An instance of [PublicKey](#publicKey).
 
-#### session
+#### authRequest
+```js
+let [pubkyauthUrl, sessionPromise] = client.authRequest(relay, capabilities);
+
+showQr(pubkyauthUrl);
+
+let session = await sessionPromise;
+```
+
+Sign in to a user's Homeserver, without access to their [Keypair](#keypair), nor even [PublicKey](#publickey),
+instead request permissions (showing the user pubkyauthUrl), and await a Session after the user consenting to that request.
+
+- relay: A URL to an [HTTP relay](https://httprelay.io/features/link/) endpoint.
+- capabilities: A list of capabilities required for the app for example `/pub/pubky.app/:rw,/pub/example.com/:r`.
+
+Returns: 
+- pubkyauthUrl: A url to show to the user to scan or paste into an Authenticator app holding the user [Keypair](#keypair)
+- sessionPromise: A promise that resolves into a [Session](#session) on success.
+
+#### sendAuthToken
+```js
+await client.sendAuthToken(keypair, pubkyauthUrl);
+```
+Consenting to authentication or authorization according to the required capabilities in the `pubkyauthUrl` , and sign and send an auth token to the requester.
+
+- keypair: An instance of [KeyPair](#keypair)
+- pubkyauthUrl: A string `pubkyauth://` url
+
+#### session {#session-method}
 ```js
 let session = await client.session(publicKey)
 ```
 - publicKey: An instance of [PublicKey](#publickey).
-- Returns: A session object if signed in, or undefined if not.
+- Returns: A [Session](#session) object if signed in, or undefined if not.
 
 #### put
 ```js
@@ -144,7 +174,7 @@ let keypair = Keypair.fromSecretKey(secretKey)
 - Returns: A new Keypair.
 
 
-#### publicKey
+#### publicKey {#publickey-method}
 ```js
 let publicKey = keypair.publicKey()
 ```
@@ -172,6 +202,38 @@ let pubky = publicKey.z32();
 ```
 Returns: The z-base-32 encoded string representation of the PublicKey.
 
+### Session 
+
+#### pubky
+```js
+let pubky = session.pubky();
+```
+Returns an instance of [PublicKey](#publickey)
+
+#### capabilities
+```js
+let capabilities = session.capabilities();
+```
+Returns an array of capabilities, for example `["/pub/pubky.app/:rw"]`
+
+### Helper functions
+
+#### createRecoveryFile
+```js
+let recoveryFile = createRecoveryFile(keypair, passphrase)
+```
+- keypair: An instance of [Keypair](#keypair).
+- passphrase: A utf-8 string [passphrase](https://www.useapassphrase.com/).
+- Returns: A recovery file with a spec line and an encrypted secret key.
+
+#### createRecoveryFile
+```js
+let keypair = decryptRecoveryfile(recoveryFile, passphrase)
+```
+- recoveryFile: An instance of Uint8Array containing the recovery file blob.
+- passphrase: A utf-8 string [passphrase](https://www.useapassphrase.com/).
+- Returns: An instance of [Keypair](#keypair).
+
 ## Test and Development
 
 For test and development, you can run a local homeserver in a test network.