@synonymdev/pubky 0.4.0-rc3 → 0.4.2-rc1

package/package.json

@@ -2,14 +2,14 @@
   "name": "@synonymdev/pubky",
   "type": "module",
   "description": "Pubky client",
-  "version": "0.4.0-rc3",
+  "version": "0.4.2-rc1",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/pubky/pubky-core.git"
   },
   "scripts": {
-    "testnet": "cargo run -p pubky-homeserver -- --testnet",
+    "testnet": "cargo run -p pubky-testnet",
     "test": "npm run test-nodejs && npm run test-browser",
     "test-nodejs": "tape test/*.js -cov",
     "test-browser": "browserify test/*.js -p esmify | npx tape-run",

package/pubky.d.ts

@@ -11,34 +11,39 @@ export function createRecoveryFile(keypair: Keypair, passphrase: string): Uint8A
  * using the `passphrase`.
  */
 export function decryptRecoveryFile(recovery_file: Uint8Array, passphrase: string): Keypair;
-/**
- * A client for Pubky homeserver API, as well as generic HTTP requests to Pubky urls.
- */
-export class Client {
+export class AuthRequest {
+  private constructor();
   free(): void;
   /**
-   * Create Client with default Settings including default relays
+   * Returns the Pubky Auth url, which you should show to the user
+   * to request an authentication or authorization token.
+   *
+   * Wait for this token using `this.response()`.
    */
-  constructor();
+  url(): string;
   /**
-   * 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)
+   * Wait for the user to send an authentication or authorization proof.
+   *
+   * If successful, you should expect an instance of [PublicKey]
+   *
+   * Otherwise it will throw an error.
    */
-  static testnet(): Client;
+  response(): Promise<PublicKey>;
+}
+export class Client {
+  free(): void;
   /**
    * 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 sesison for a given Pubky in its homeserver.
+   * Check the current session for a given Pubky in its homeserver.
    *
-   * Returns [Session] or `None` (if recieved `404 NOT_FOUND`),
-   * or throws the recieved error if the response has any other `>=400` status code.
+   * Returns [Session] or `None` (if received `404 NOT_FOUND`),
+   * or throws the received error if the response has any other `>=400` status code.
    */
   session(pubky: PublicKey): Promise<Session | undefined>;
   /**
@@ -54,14 +59,41 @@ export class Client {
    * 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>]
+   * Returns a [AuthRequest]
    */
-  authRequest(relay: string, capabilities: string): Array<any>;
+  authRequest(relay: string, capabilities: string): AuthRequest;
   /**
    * Sign an [pubky_common::auth::AuthToken], encrypt it and send it to the
    * 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: string): 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).
    *
@@ -73,7 +105,6 @@ export class Client {
    * - `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>>;
-  fetch(url: string, request_init?: any | null): Promise<Promise<any>>;
 }
 export class Keypair {
   private constructor();