@synonymdev/pubky 0.5.0-rc.1 → 0.5.1

package/package.json

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

package/pubky.d.ts

@@ -1,5 +1,6 @@
 /* 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`.
@@ -10,7 +11,36 @@ 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
+ */
+export interface PkarrConfig {
+    /**
+     * The list of relays to access the DHT with.
+     */
+    relays: string[] | null;
+    /**
+     * The timeout for DHT requests in milliseconds.
+     * Default is 2000ms.
+     */
+    requestTimeout: NonZeroU64 | null;
+}
+
+/**
+ * Pubky Client Config
+ */
+export interface PubkyClientConfig {
+    /**
+     * Configuration on how to access pkarr packets on the mainline DHT.
+     */
+    pkarr: PkarrConfig | null;
+    /**
+     * 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;
+}
+
 export class AuthRequest {
   private constructor();
   free(): void;
@@ -32,6 +62,17 @@ 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.
    *
@@ -88,10 +129,11 @@ 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>>;
   /**
-   * Create Client with default Settings including default relays
+   * Create a new Pubky Client with an optional configuration.
    */
-  constructor();
+  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.
@@ -99,18 +141,6 @@ export class Client {
    *     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();
@@ -137,8 +167,13 @@ export class PublicKey {
   free(): void;
   /**
    * Convert the PublicKey to Uint8Array
+   * @deprecated Use `toUint8Array` instead
    */
   to_uint8array(): Uint8Array;
+  /**
+   * Convert the PublicKey to Uint8Array
+   */
+  toUint8Array(): Uint8Array;
   /**
    * Returns the z-base32 encoding of this public key
    */
@@ -146,7 +181,7 @@ export class PublicKey {
   /**
    * @throws
    */
-  static from(value: any): PublicKey;
+  static from(value: string): PublicKey;
 }
 export class Session {
   private constructor();