feat(pubky): rename PubkyClient to Client

examples/authn/signup.rs

@@ -1,6 +1,6 @@
 use anyhow::Result;
 use clap::Parser;
-use pubky::PubkyClient;
+use pubky::Client;
 use std::path::PathBuf;
 
 use pubky_common::crypto::PublicKey;
@@ -24,7 +24,7 @@ async fn main() -> Result<()> {
 
     let homeserver = cli.homeserver;
 
-    let client = PubkyClient::new()?;
+    let client = Client::new()?;
 
     println!("Enter your recovery_file's passphrase to signup:");
     let passphrase = rpassword::read_password()?;

examples/authz/3rd-party-app/src/pubky-auth-widget.js

@@ -56,8 +56,8 @@ export class PubkyAuthWidget extends LitElement {
     this.testnet = false;
     this.open = false;
 
-    /** @type {import("@synonymdev/pubky").PubkyClient} */
-    this.pubkyClient = new window.pubky.PubkyClient();
+    /** @type {import("@synonymdev/pubky").Client} */
+    this.pubkyClient = new window.pubky.Client();
 
     this.caps = this.caps || ""
   }
@@ -74,9 +74,9 @@ export class PubkyAuthWidget extends LitElement {
     console.debug("Switching testnet");
 
     if (this.testnet) {
-      this.pubkyClient = window.pubky.PubkyClient.testnet()
+      this.pubkyClient = window.pubky.Client.testnet()
     } else {
-      this.pubkyClient = new window.pubky.PubkyClient();
+      this.pubkyClient = new window.pubky.Client();
     }
 
     console.debug("Pkarr Relays: " + this.pubkyClient.getPkarrRelays())

examples/authz/authenticator.rs

@@ -1,6 +1,6 @@
 use anyhow::Result;
 use clap::Parser;
-use pubky::PubkyClient;
+use pubky::Client;
 use std::path::PathBuf;
 use url::Url;
 
@@ -66,7 +66,7 @@ async fn main() -> Result<()> {
     println!("PublicKey: {}", keypair.public_key());
 
     let client = if cli.testnet.unwrap_or_default() {
-        let client = PubkyClient::testnet()?;
+        let client = Client::testnet()?;
 
         // For the purposes of this demo, we need to make sure
         // the user has an account on the local homeserver.
@@ -78,7 +78,7 @@ async fn main() -> Result<()> {
 
         client
     } else {
-        PubkyClient::new()?
+        Client::new()?
     };
 
     println!("Sending AuthToken to the 3rd party app...");

examples/request/main.rs

@@ -3,7 +3,7 @@ use clap::Parser;
 use reqwest::Method;
 use url::Url;
 
-use pubky::PubkyClient;
+use pubky::Client;
 
 #[derive(Parser, Debug)]
 #[command(version, about, long_about = None)]
@@ -18,7 +18,7 @@ struct Cli {
 async fn main() -> Result<()> {
     let cli = Cli::parse();
 
-    let client = PubkyClient::new()?;
+    let client = Client::new()?;
 
     match cli.url.scheme() {
         "https" => {

pubky/README.md

@@ -8,18 +8,18 @@ Rust implementation implementation of [Pubky](https://github.com/pubky/pubky-cor
 use pkarr::mainline::Testnet;
 use pkarr::Keypair;
 use pubky_homeserver::Homeserver;
-use pubky::PubkyClient;
+use pubky::Client;
 
 #[tokio::main]
 async fn main () {
   // Mainline Dht testnet and a temporary homeserver for unit testing.
   let testnet = Testnet::new(10);
   let server = Homeserver::start_test(&testnet).await.unwrap();
 
-  let client = PubkyClient::test(&testnet);
+  let client = Client::test(&testnet);
 
   // Uncomment the following line instead if you are not just testing.
-  // let client PubkyClient::new().unwrap(); 
+  // let client Client::new().unwrap(); 
 
   // Generate a keypair
   let keypair = Keypair::random();

pubky/pkg/README.md

@@ -21,10 +21,10 @@ For Nodejs, you need Node v20 or later.
 ## Getting started
 
 ```js
-import { PubkyClient, Keypair, PublicKey } from '../index.js'
+import { Client, Keypair, PublicKey } from '../index.js'
 
-// Initialize PubkyClient with Pkarr relay(s).
-let client = new PubkyClient();
+// Initialize Client with Pkarr relay(s).
+let client = new Client();
 
 // Generate a keypair
 let keypair = Keypair.random();
@@ -49,7 +49,7 @@ await client.put(url, body);
 
 // GET public data without signup or signin
 {
-    const client = new PubkyClient();
+    const client = new Client();
 
     let response = await client.get(url);
 }
@@ -60,11 +60,11 @@ await client.delete(url);
 
 ## API
 
-### PubkyClient
+### Client
 
 #### constructor
 ```js
-let client = new PubkyClient()
+let client = new Client()
 ```
 
 #### signup
@@ -257,10 +257,10 @@ Run the local testnet server
 npm run testnet
 ```
 
-Use the logged addresses as inputs to `PubkyClient`
+Use the logged addresses as inputs to `Client`
 
 ```js
-import { PubkyClient } from '../index.js'
+import { Client } from '../index.js'
 
-const client = PubkyClient().testnet();
+const client = Client().testnet();
 ```

pubky/pkg/package.json

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

pubky/pkg/test/auth.js

@@ -1,11 +1,11 @@
 import test from 'tape'
 
-import { PubkyClient, Keypair, PublicKey } from '../index.cjs'
+import { Client, Keypair, PublicKey } from '../index.cjs'
 
 const Homeserver = PublicKey.from('8pinxxgqs41n4aididenw5apqp1urfmzdztr8jt4abrkdn435ewo')
 
 test('auth', async (t) => {
-  const client = PubkyClient.testnet();
+  const client = Client.testnet();
 
   const keypair = Keypair.random()
   const publicKey = keypair.publicKey()
@@ -36,7 +36,7 @@ test("3rd party signin", async (t) => {
 
   // Third party app side
   let capabilities = "/pub/pubky.app/:rw,/pub/foo.bar/file:r";
-  let client = PubkyClient.testnet();
+  let client = Client.testnet();
   let [pubkyauth_url, pubkyauthResponse] = client
     .authRequest("https://demo.httprelay.io/link", capabilities);
 
@@ -49,7 +49,7 @@ test("3rd party signin", async (t) => {
 
   // Authenticator side
   {
-    let client = PubkyClient.testnet();
+    let client = Client.testnet();
 
     await client.signup(keypair, Homeserver);
 

pubky/pkg/test/http.js

@@ -1,13 +1,13 @@
 import test from 'tape'
 
-import { PubkyClient, Keypair, PublicKey } from '../index.cjs'
+import { Client, Keypair, PublicKey } from '../index.cjs'
 
 const TLD = '8pinxxgqs41n4aididenw5apqp1urfmzdztr8jt4abrkdn435ewo';
 
 // TODO: test HTTPs too somehow.
 
 test.skip("basic fetch", async (t) => {
-  let client = PubkyClient.testnet();
+  let client = Client.testnet();
 
   // Normal TLD
   {

pubky/pkg/test/public.js

@@ -1,11 +1,11 @@
 import test from 'tape'
 
-import { PubkyClient, Keypair, PublicKey } from '../index.cjs'
+import { Client, Keypair, PublicKey } from '../index.cjs'
 
 const Homeserver = PublicKey.from('8pinxxgqs41n4aididenw5apqp1urfmzdztr8jt4abrkdn435ewo');
 
 test('public: put/get', async (t) => {
-  const client = PubkyClient.testnet();
+  const client = Client.testnet();
 
   const keypair = Keypair.random();
 
@@ -20,7 +20,7 @@ test('public: put/get', async (t) => {
   // PUT public data, by authorized client
   await client.put(url, body);
 
-  const otherClient = PubkyClient.testnet();
+  const otherClient = Client.testnet();
 
   // GET public data without signup or signin
   {
@@ -42,7 +42,7 @@ test('public: put/get', async (t) => {
 })
 
 test("not found", async (t) => {
-  const client = PubkyClient.testnet();
+  const client = Client.testnet();
 
 
   const keypair = Keypair.random();
@@ -59,7 +59,7 @@ test("not found", async (t) => {
 })
 
 test("unauthorized", async (t) => {
-  const client = PubkyClient.testnet();
+  const client = Client.testnet();
 
   const keypair = Keypair.random()
   const publicKey = keypair.publicKey()
@@ -86,7 +86,7 @@ test("unauthorized", async (t) => {
 })
 
 test("forbidden", async (t) => {
-  const client = PubkyClient.testnet();
+  const client = Client.testnet();
 
   const keypair = Keypair.random()
   const publicKey = keypair.publicKey()
@@ -111,7 +111,7 @@ test("forbidden", async (t) => {
 })
 
 test("list", async (t) => {
-  const client = PubkyClient.testnet();
+  const client = Client.testnet();
 
   const keypair = Keypair.random()
   const publicKey = keypair.publicKey()
@@ -242,7 +242,7 @@ test("list", async (t) => {
 })
 
 test('list shallow', async (t) => {
-  const client = PubkyClient.testnet();
+  const client = Client.testnet();
 
   const keypair = Keypair.random()
   const publicKey = keypair.publicKey()

pubky/src/lib.rs

@@ -20,7 +20,7 @@ pub use crate::shared::list_builder::ListBuilder;
 /// A client for Pubky homeserver API, as well as generic HTTP requests to Pubky urls.
 #[derive(Debug, Clone)]
 #[wasm_bindgen]
-pub struct PubkyClient {
+pub struct Client {
     http: reqwest::Client,
     pub(crate) pkarr: pkarr::Client,
 }

pubky/src/native.rs

@@ -2,7 +2,7 @@ use std::time::Duration;
 
 use pkarr::mainline::Testnet;
 
-use crate::PubkyClient;
+use crate::Client;
 
 mod api;
 mod internals;
@@ -42,13 +42,11 @@ impl Settings {
         self
     }
 
-    /// Build [PubkyClient]
-    pub fn build(self) -> Result<PubkyClient, std::io::Error> {
-        // TODO: convert to Result<PubkyClient>
-
+    /// Build [Client]
+    pub fn build(self) -> Result<Client, std::io::Error> {
         let pkarr = pkarr::Client::new(self.pkarr_settings)?;
 
-        Ok(PubkyClient {
+        Ok(Client {
             http: reqwest::Client::builder()
                 .cookie_store(true)
                 // .dns_resolver(Arc::new(dns_resolver))
@@ -60,13 +58,13 @@ impl Settings {
     }
 }
 
-impl PubkyClient {
-    /// Create a new [PubkyClient] with default [Settings]
+impl Client {
+    /// Create a new [Client] with default [Settings]
     pub fn new() -> Result<Self, std::io::Error> {
         Self::builder().build()
     }
 
-    /// Returns a builder to edit settings before creating [PubkyClient].
+    /// Returns a builder to edit settings before creating [Client].
     pub fn builder() -> Settings {
         Settings::default()
     }
@@ -83,8 +81,8 @@ impl PubkyClient {
     }
 
     #[cfg(test)]
-    /// Alias to `PubkyClient::builder().testnet(testnet).build().unwrap()`
-    pub(crate) fn test(testnet: &Testnet) -> PubkyClient {
-        PubkyClient::builder().testnet(testnet).build().unwrap()
+    /// Alias to `pubky::Client::builder().testnet(testnet).build().unwrap()`
+    pub(crate) fn test(testnet: &Testnet) -> Client {
+        Client::builder().testnet(testnet).build().unwrap()
     }
 }

pubky/src/native/api/auth.rs

@@ -8,9 +8,9 @@ use pkarr::PublicKey;
 use pubky_common::capabilities::Capabilities;
 
 use crate::error::{Error, Result};
-use crate::PubkyClient;
+use crate::Client;
 
-impl PubkyClient {
+impl Client {
     /// Signup to a homeserver and update Pkarr accordingly.
     ///
     /// The homeserver is a Pkarr domain name, where the TLD is a Pkarr public key