@synonymdev/pubky 0.4.0 → 0.4.2-rc2

package/package.json

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

package/pubky.d.ts

@@ -32,36 +32,13 @@ export class AuthRequest {
 }
 export class Client {
   free(): void;
-  /**
-   * Create Client with default Settings including default relays
-   */
-  constructor();
-  /**
-   * Create a client with with configurations appropriate for local testing:
-   * - set Pkarr relays to `["http://localhost:15411"]` instead of default relay.
-   * - transform `pubky://<pkarr public key>` to `http://<pkarr public key` instead of `https:`
-   *     and read the homeserver HTTP port from the [reserved service parameter key](pubky_common::constants::reserved_param_keys::HTTP_PORT)
-   */
-  static testnet(): Client;
-  fetch(url: string, request_init?: any | null): Promise<Promise<any>>;
-  /**
-   * Returns a list of Pubky urls (as strings).
-   *
-   * - `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.
-   */
-  list(url: string, cursor?: string | null, reverse?: boolean | null, limit?: number | null, shallow?: boolean | null): Promise<Array<any>>;
   /**
    * Signup to a homeserver and update Pkarr accordingly.
    *
    * The homeserver is a Pkarr domain name, where the TLD is a Pkarr public key
    * for example "pubky.o4dksfbqk85ogzdb5osziw6befigbuxmuxkuxq8434q89uj56uyy"
    */
-  signup(keypair: Keypair, homeserver: PublicKey): Promise<Session>;
+  signup(keypair: Keypair, homeserver: PublicKey, signup_token?: string | null): Promise<Session>;
   /**
    * Check the current session for a given Pubky in its homeserver.
    *
@@ -90,6 +67,44 @@ export class Client {
    * source of the pubkyauth request url.
    */
   sendAuthToken(keypair: Keypair, pubkyauth_url: string): Promise<void>;
+  /**
+   * Republish the user's PKarr record pointing to their homeserver.
+   *
+   * This method will republish the record if no record exists or if the existing record
+   * is older than 6 hours.
+   *
+   * The method is intended for clients and key managers (e.g., pubky-ring) to
+   * keep the records of active users fresh and available in the DHT and relays.
+   * It is intended to be used only after failed signin due to homeserver resolution
+   * failure. This method is lighter than performing a re-signup into the last known
+   * homeserver, but does not return a session token, so a signin must be done after
+   * republishing. On a failed signin due to homeserver resolution failure, a key
+   * manager should always attempt to republish the last known homeserver.
+   */
+  republishHomeserver(keypair: Keypair, host: PublicKey): Promise<void>;
+  /**
+   * Create Client with default Settings including default relays
+   */
+  constructor();
+  /**
+   * Create a client with with configurations appropriate for local testing:
+   * - set Pkarr relays to `["http://localhost:15411"]` instead of default relay.
+   * - transform `pubky://<pkarr public key>` to `http://<pkarr public key` instead of `https:`
+   *     and read the homeserver HTTP port from the [reserved service parameter key](pubky_common::constants::reserved_param_keys::HTTP_PORT)
+   */
+  static testnet(): Client;
+  fetch(url: string, request_init?: any | null): Promise<Promise<any>>;
+  /**
+   * Returns a list of Pubky urls (as strings).
+   *
+   * - `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.
+   */
+  list(url: string, cursor?: string | null, reverse?: boolean | null, limit?: number | null, shallow?: boolean | null): Promise<Array<any>>;
 }
 export class Keypair {
   private constructor();