@synonymdev/pubky 0.2.1 → 0.4.0-rc2

package/package.json

@@ -2,14 +2,14 @@
   "name": "@synonymdev/pubky",
   "type": "module",
   "description": "Pubky client",
-  "version": "0.2.1",
+  "version": "0.4.0-rc2",
   "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",

package/pubky.d.ts

@@ -1,187 +1,125 @@
 /* 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`.
-* @param {Keypair} keypair
-* @param {string} passphrase
-* @returns {Uint8Array}
-*/
+ * Create a recovery file of the `keypair`, containing the secret key encrypted
+ * using the `passphrase`.
+ */
 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}
-*/
+ * Create a recovery file of the `keypair`, containing the secret key encrypted
+ * using the `passphrase`.
+ */
 export function decryptRecoveryFile(recovery_file: Uint8Array, passphrase: string): Keypair;
 /**
-*/
-export class Keypair {
+ * A client for Pubky homeserver API, as well as generic HTTP requests to Pubky urls.
+ */
+export class Client {
   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 class PubkyClient {
-  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"
-* @param {Keypair} keypair
-* @param {PublicKey} homeserver
-* @returns {Promise<Session>}
-*/
+  /**
+   * 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;
+  /**
+   * 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>;
-/**
-* Check the current sesison 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.
-* @param {PublicKey} pubky
-* @returns {Promise<Session | undefined>}
-*/
+  /**
+   * Check the current sesison 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.
+   */
   session(pubky: PublicKey): Promise<Session | undefined>;
-/**
-* Signout from a homeserver.
-* @param {PublicKey} pubky
-* @returns {Promise<void>}
-*/
+  /**
+   * Signout from a homeserver.
+   */
   signout(pubky: PublicKey): Promise<void>;
-/**
-* Signin to a homeserver using the root Keypair.
-* @param {Keypair} keypair
-* @returns {Promise<void>}
-*/
+  /**
+   * Signin to a homeserver using the root Keypair.
+   */
   signin(keypair: Keypair): Promise<void>;
-/**
-* Return `pubkyauth://` url and wait for the incoming [AuthToken]
-* 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>]
-* @param {string} relay
-* @param {string} capabilities
-* @returns {Array<any>}
-*/
+  /**
+   * Return `pubkyauth://` url and wait for the incoming [AuthToken]
+   * 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>]
+   */
   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>}
-*/
+  /**
+   * 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>;
-/**
-* 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>}
-*/
-  get(url: string): Promise<Uint8Array | undefined>;
-/**
-* Delete a file at a path relative to a pubky author.
-* @param {string} url
-* @returns {Promise<void>}
-*/
-  delete(url: string): Promise<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.
-* @param {string} url
-* @param {string | undefined} [cursor]
-* @param {boolean | undefined} [reverse]
-* @param {number | undefined} [limit]
-* @param {boolean | undefined} [shallow]
-* @returns {Promise<Array<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, reverse?: boolean, limit?: number, shallow?: boolean): Promise<Array<any>>;
-/**
-* Create PubkyClient with default Settings including default relays
-*/
-  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;
-/**
-* @param {string} url
-* @param {any} init
-* @returns {Promise<Promise<any>>}
-*/
-  fetch(url: string, init: any): Promise<Promise<any>>;
+  fetch(url: string, request_init?: any): 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}
-*/
+  /**
+   * Convert the PublicKey to Uint8Array
+   */
   to_uint8array(): Uint8Array;
-/**
-* Returns the z-base32 encoding of this public key
-* @returns {string}
-*/
+  /**
+   * Returns the z-base32 encoding of this public key
+   */
   z32(): string;
-/**
-* @throws
-* @param {any} value
-* @returns {PublicKey}
-*/
+  /**
+   * @throws
+   */
   static from(value: any): PublicKey;
 }
-/**
-*/
 export class Session {
+  private constructor();
   free(): void;
-/**
-* Return the [PublicKey] of this session
-* @returns {PublicKey}
-*/
+  /**
+   * Return the [PublicKey] of this session
+   */
   pubky(): PublicKey;
-/**
-* Return the capabilities that this session has.
-* @returns {(string)[]}
-*/
+  /**
+   * Return the capabilities that this session has.
+   */
   capabilities(): (string)[];
 }