@synonymdev/pubky 0.1.13 → 0.1.15

package/package.json

@@ -2,7 +2,7 @@
   "name": "@synonymdev/pubky",
   "type": "module",
   "description": "Pubky client",
-  "version": "0.1.13",
+  "version": "0.1.15",
   "license": "MIT",
   "repository": {
     "type": "git",

package/pubky.d.ts

@@ -1,6 +1,22 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
+* Create a recovery file of the `keypair`, containing the secret key encrypted
+* using the `passphrase`.
+* @param {Keypair} keypair
+* @param {string} passphrase
+* @returns {Uint8Array}
+*/
+export function createRecoveryFile(keypair: Keypair, passphrase: string): Uint8Array;
+/**
+* Create a recovery file of the `keypair`, containing the secret key encrypted
+* using the `passphrase`.
+* @param {Uint8Array} recovery_file
+* @param {string} passphrase
+* @returns {Keypair}
+*/
+export function decryptRecoveryFile(recovery_file: Uint8Array, passphrase: string): Keypair;
+/**
 */
 export class Keypair {
   free(): void;
@@ -40,22 +56,6 @@ export class PubkyClient {
 */
   static testnet(): PubkyClient;
 /**
-* Create a recovery file of the `keypair`, containing the secret key encrypted
-* using the `passphrase`.
-* @param {Keypair} keypair
-* @param {string} passphrase
-* @returns {Uint8Array}
-*/
-  static createRecoveryFile(keypair: Keypair, passphrase: string): Uint8Array;
-/**
-* Create a recovery file of the `keypair`, containing the secret key encrypted
-* using the `passphrase`.
-* @param {Uint8Array} recovery_file
-* @param {string} passphrase
-* @returns {Keypair}
-*/
-  static decryptRecoveryFile(recovery_file: Uint8Array, passphrase: string): Keypair;
-/**
 * Set Pkarr relays used for publishing and resolving Pkarr packets.
 *
 * By default, [PubkyClient] will use `["https://relay.pkarr.org"]`
@@ -74,9 +74,9 @@ export class PubkyClient {
 * for example "pubky.o4dksfbqk85ogzdb5osziw6befigbuxmuxkuxq8434q89uj56uyy"
 * @param {Keypair} keypair
 * @param {PublicKey} homeserver
-* @returns {Promise<void>}
+* @returns {Promise<Session>}
 */
-  signup(keypair: Keypair, homeserver: PublicKey): Promise<void>;
+  signup(keypair: Keypair, homeserver: PublicKey): Promise<Session>;
 /**
 * Check the current sesison for a given Pubky in its homeserver.
 *
@@ -93,12 +93,31 @@ export class PubkyClient {
 */
   signout(pubky: PublicKey): Promise<void>;
 /**
-* Signin to a homeserver.
+* Signin to a homeserver using the root Keypair.
 * @param {Keypair} keypair
 * @returns {Promise<void>}
 */
   signin(keypair: Keypair): Promise<void>;
 /**
+* Return `pubkyauth://` url and wait for the incoming [AuthToken]
+* verifying that AuthToken, and if capabilities were requested, signing in to
+* the Pubky's homeserver and returning the [Session] information.
+*
+* Returns a tuple of [pubkyAuthUrl, Promise<Session>]
+* @param {string} relay
+* @param {string} capabilities
+* @returns {Array<any>}
+*/
+  authRequest(relay: string, capabilities: string): Array<any>;
+/**
+* Sign an [pubky_common::auth::AuthToken], encrypt it and send it to the
+* source of the pubkyauth request url.
+* @param {Keypair} keypair
+* @param {string} pubkyauth_url
+* @returns {Promise<void>}
+*/
+  sendAuthToken(keypair: Keypair, pubkyauth_url: string): Promise<void>;
+/**
 * Upload a small payload to a given path.
 * @param {string} url
 * @param {Uint8Array} content
@@ -118,10 +137,14 @@ export class PubkyClient {
 */
   delete(url: string): Promise<void>;
 /**
-* Returns a list of Pubky URLs of the files within the `url` path,
-* respecting the `cursor`, `reverse` and `limit` options.
+* Returns a list of Pubky urls (as strings).
 *
-* `cursor` is usually the last url from previous responses.
+* - `url`:     The Pubky url (string) to the directory you want to list its content.
+* - `cursor`:  Either a full `pubky://` Url (from previous list response),
+*                 or a path (to a file or directory) relative to the `url`
+* - `reverse`: List in reverse order
+* - `limit`    Limit the number of urls in the response
+* - `shallow`: List directories and files, instead of flat list of files.
 * @param {string} url
 * @param {string | undefined} [cursor]
 * @param {boolean | undefined} [reverse]
@@ -156,4 +179,14 @@ export class PublicKey {
 */
 export class Session {
   free(): void;
+/**
+* Return the [PublicKey] of this session
+* @returns {PublicKey}
+*/
+  pubky(): PublicKey;
+/**
+* Return the capabilities that this session has.
+* @returns {(string)[]}
+*/
+  capabilities(): (string)[];
 }