@synonymdev/pubky 0.2.0 → 0.4.0-rc.4

package/package.json

@@ -2,14 +2,14 @@
   "name": "@synonymdev/pubky",
   "type": "module",
   "description": "Pubky client",
-  "version": "0.2.0",
+  "version": "0.4.0-rc.4",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/pubky/pubky"
+    "url": "git+https://github.com/pubky/pubky-core.git"
   },
   "scripts": {
-    "testnet": "cargo run -p pubky_homeserver -- --testnet",
+    "testnet": "cargo run -p pubky-homeserver -- --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",
@@ -18,12 +18,12 @@
   },
   "files": [
     "index.cjs",
-    "browser.js",
+    "index.js",
     "pubky.d.ts",
     "pubky_bg.wasm"
   ],
   "main": "index.cjs",
-  "browser": "browser.js",
+  "browser": "index.js",
   "types": "pubky.d.ts",
   "keywords": [
     "web",

package/pubky.d.ts

@@ -3,75 +3,24 @@
 /**
  * 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;
-  /**
-   * Generate a random [Keypair]
-   * @returns {Keypair}
-   */
-  static random(): Keypair;
-  /**
-   * Generate a [Keypair] from a secret key.
-   * @param {Uint8Array} secret_key
-   * @returns {Keypair}
-   */
-  static fromSecretKey(secret_key: Uint8Array): Keypair;
-  /**
-   * Returns the secret key of this keypair.
-   * @returns {Uint8Array}
-   */
-  secretKey(): Uint8Array;
-  /**
-   * Returns the [PublicKey] of this keypair.
-   * @returns {PublicKey}
-   */
-  publicKey(): PublicKey;
-}
+export function setLogLevel(level: string): void;
 /**
  * A client for Pubky homeserver API, as well as generic HTTP requests to Pubky urls.
  */
-export class PubkyClient {
+export class Client {
   free(): void;
-  constructor();
-  /**
-   * Create a client with with configurations appropriate for local testing:
-   * - set Pkarr relays to `["http://localhost:15411/pkarr"]` instead of default relay.
-   * @returns {PubkyClient}
-   */
-  static testnet(): PubkyClient;
-  /**
-   * Set Pkarr relays used for publishing and resolving Pkarr packets.
-   *
-   * By default, [PubkyClient] will use `["https://relay.pkarr.org"]`
-   * @param {(string)[]} relays
-   * @returns {PubkyClient}
-   */
-  setPkarrRelays(relays: (string)[]): PubkyClient;
-  /**
-   * @returns {(string)[]}
-   */
-  getPkarrRelays(): (string)[];
   /**
    * 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"
-   * @param {Keypair} keypair
-   * @param {PublicKey} homeserver
-   * @returns {Promise<Session>}
    */
   signup(keypair: Keypair, homeserver: PublicKey): Promise<Session>;
   /**
@@ -79,20 +28,14 @@ export class PubkyClient {
    *
    * Returns [Session] or `None` (if recieved `404 NOT_FOUND`),
    * or throws the recieved error if the response has any other `>=400` status code.
-   * @param {PublicKey} pubky
-   * @returns {Promise<Session | undefined>}
    */
   session(pubky: PublicKey): Promise<Session | undefined>;
   /**
    * Signout from a homeserver.
-   * @param {PublicKey} pubky
-   * @returns {Promise<void>}
    */
   signout(pubky: PublicKey): Promise<void>;
   /**
    * Signin to a homeserver using the root Keypair.
-   * @param {Keypair} keypair
-   * @returns {Promise<void>}
    */
   signin(keypair: Keypair): Promise<void>;
   /**
@@ -101,38 +44,24 @@ export class PubkyClient {
    * 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
-   * @returns {Promise<void>}
-   */
-  put(url: string, content: Uint8Array): Promise<void>;
-  /**
-   * Download a small payload from a given path relative to a pubky author.
-   * @param {string} url
-   * @returns {Promise<Uint8Array | undefined>}
+   * Create Client with default Settings including default relays
    */
-  get(url: string): Promise<Uint8Array | undefined>;
+  constructor();
   /**
-   * Delete a file at a path relative to a pubky author.
-   * @param {string} url
-   * @returns {Promise<void>}
+   * 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)
    */
-  delete(url: string): Promise<void>;
+  static testnet(): Client;
   /**
    * Returns a list of Pubky urls (as strings).
    *
@@ -142,44 +71,55 @@ export class PubkyClient {
    * - `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]
-   * @param {number | undefined} [limit]
-   * @param {boolean | undefined} [shallow]
-   * @returns {Promise<Array<any>>}
-   */
-  list(url: string, cursor?: string, reverse?: boolean, limit?: number, shallow?: boolean): Promise<Array<any>>;
+   */
+  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();
+  free(): void;
+  /**
+   * Generate a random [Keypair]
+   */
+  static random(): Keypair;
+  /**
+   * Generate a [Keypair] from a secret key.
+   */
+  static fromSecretKey(secret_key: Uint8Array): Keypair;
+  /**
+   * Returns the secret key of this keypair.
+   */
+  secretKey(): Uint8Array;
+  /**
+   * Returns the [PublicKey] of this keypair.
+   */
+  publicKey(): PublicKey;
 }
 export class PublicKey {
+  private constructor();
   free(): void;
   /**
    * Convert the PublicKey to Uint8Array
-   * @returns {Uint8Array}
    */
   to_uint8array(): Uint8Array;
   /**
    * Returns the z-base32 encoding of this public key
-   * @returns {string}
    */
   z32(): string;
   /**
    * @throws
-   * @param {any} value
-   * @returns {PublicKey}
    */
   static from(value: any): PublicKey;
 }
 export class Session {
+  private constructor();
   free(): void;
   /**
    * Return the [PublicKey] of this session
-   * @returns {PublicKey}
    */
   pubky(): PublicKey;
   /**
    * Return the capabilities that this session has.
-   * @returns {(string)[]}
    */
-  capabilities(): (string)[];
+  capabilities(): string[];
 }