@synonymdev/pubky 0.5.1 → 0.5.4

package/package.json

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

package/pubky.d.ts

@@ -1,6 +1,5 @@
 /* tslint:disable */
 /* eslint-disable */
-export function setLogLevel(level: string): void;
 /**
  * Create a recovery file of the `keypair`, containing the secret key encrypted
  * using the `passphrase`.
@@ -11,6 +10,7 @@ export function createRecoveryFile(keypair: Keypair, passphrase: string): Uint8A
  * using the `passphrase`.
  */
 export function decryptRecoveryFile(recovery_file: Uint8Array, passphrase: string): Keypair;
+export function setLogLevel(level: string): void;
 /**
  * Pkarr Config
  */
@@ -18,12 +18,12 @@ export interface PkarrConfig {
     /**
      * The list of relays to access the DHT with.
      */
-    relays: string[] | null;
+    relays?: string[];
     /**
      * The timeout for DHT requests in milliseconds.
      * Default is 2000ms.
      */
-    requestTimeout: NonZeroU64 | null;
+    requestTimeout?: NonZeroU64;
 }
 
 /**
@@ -33,12 +33,12 @@ export interface PubkyClientConfig {
     /**
      * Configuration on how to access pkarr packets on the mainline DHT.
      */
-    pkarr: PkarrConfig | null;
+    pkarr?: PkarrConfig;
     /**
      * The maximum age of a record in seconds.
      * If the user pkarr record is older than this, it will be automatically refreshed.
      */
-    userMaxRecordAge: NonZeroU64 | null;
+    userMaxRecordAge?: NonZeroU64;
 }
 
 export class AuthRequest {
@@ -62,17 +62,6 @@ export class AuthRequest {
 }
 export class Client {
   free(): void;
-  /**
-   * 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.
    *
@@ -129,18 +118,29 @@ export class Client {
    * manager should always attempt to republish the last known homeserver.
    */
   republishHomeserver(keypair: Keypair, host: PublicKey): Promise<void>;
-  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>>;
+  fetch(url: string, init?: any | null): Promise<Promise<any>>;
   /**
    * Create a new Pubky Client with an optional configuration.
    */
   constructor(config_opt?: PubkyClientConfig | null);
   /**
    * 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)
+   * - set Pkarr relays to `http://<host>:15411` (defaults to `localhost`).
+   * - transform `pubky://<pkarr public key>` to `http://<host>` instead of `https:`
+   *   and read the homeserver HTTP port from the PKarr record.
    */
-  static testnet(): Client;
+  static testnet(host?: string | null): Client;
 }
 export class Keypair {
   private constructor();