docs(pubky): small docs improvements

pubky/src/lib.rs

@@ -21,6 +21,9 @@ use ::pkarr::PkarrClientAsync;
 
 pub use error::Error;
 
+#[cfg(not(target_arch = "wasm32"))]
+pub use crate::shared::list_builder::ListBuilder;
+
 #[derive(Debug, Clone)]
 #[wasm_bindgen]
 pub struct PubkyClient {

pubky/src/shared/auth.rs

@@ -74,7 +74,7 @@ impl PubkyClient {
     }
 
     /// Signout from a homeserver.
-    pub async fn inner_signout(&self, pubky: &PublicKey) -> Result<()> {
+    pub(crate) async fn inner_signout(&self, pubky: &PublicKey) -> Result<()> {
         let Endpoint {
             public_key,
             mut url,
@@ -90,7 +90,7 @@ impl PubkyClient {
     }
 
     /// Signin to a homeserver.
-    pub async fn inner_signin(&self, keypair: &Keypair) -> Result<()> {
+    pub(crate) async fn inner_signin(&self, keypair: &Keypair) -> Result<()> {
         let pubky = keypair.public_key();
 
         let Endpoint {

pubky/src/shared/list_builder.rs

@@ -15,7 +15,7 @@ pub struct ListBuilder<'a> {
 
 impl<'a> ListBuilder<'a> {
     /// Create a new List request builder
-    pub fn new(client: &'a PubkyClient, url: Url) -> Self {
+    pub(crate) fn new(client: &'a PubkyClient, url: Url) -> Self {
         Self {
             client,
             url,
@@ -40,7 +40,8 @@ impl<'a> ListBuilder<'a> {
 
     /// Set the `cursor` value.
     ///
-    /// usually the last url from previous responses.
+    /// Either a full `pubky://` Url (from previous list response),
+    /// or a path (to a file or directory) relative to the `url`
     pub fn cursor(mut self, cursor: &'a str) -> Self {
         self.cursor = cursor.into();
         self

pubky/src/shared/public.rs

@@ -12,7 +12,7 @@ use crate::{
 use super::{list_builder::ListBuilder, pkarr::Endpoint};
 
 impl PubkyClient {
-    pub async fn inner_put<T: TryInto<Url>>(&self, url: T, content: &[u8]) -> Result<()> {
+    pub(crate) async fn inner_put<T: TryInto<Url>>(&self, url: T, content: &[u8]) -> Result<()> {
         let url = self.pubky_to_http(url).await?;
 
         let response = self
@@ -26,7 +26,7 @@ impl PubkyClient {
         Ok(())
     }
 
-    pub async fn inner_get<T: TryInto<Url>>(&self, url: T) -> Result<Option<Bytes>> {
+    pub(crate) async fn inner_get<T: TryInto<Url>>(&self, url: T) -> Result<Option<Bytes>> {
         let url = self.pubky_to_http(url).await?;
 
         let response = self.request(Method::GET, url).send().await?;
@@ -43,7 +43,7 @@ impl PubkyClient {
         Ok(Some(bytes))
     }
 
-    pub async fn inner_delete<T: TryInto<Url>>(&self, url: T) -> Result<()> {
+    pub(crate) async fn inner_delete<T: TryInto<Url>>(&self, url: T) -> Result<()> {
         let url = self.pubky_to_http(url).await?;
 
         let response = self.request(Method::DELETE, url).send().await?;
@@ -53,7 +53,7 @@ impl PubkyClient {
         Ok(())
     }
 
-    pub fn inner_list<T: TryInto<Url>>(&self, url: T) -> Result<ListBuilder> {
+    pub(crate) fn inner_list<T: TryInto<Url>>(&self, url: T) -> Result<ListBuilder> {
         Ok(ListBuilder::new(
             self,
             url.try_into().map_err(|_| Error::InvalidUrl)?,

pubky/src/wasm.rs

@@ -154,10 +154,14 @@ impl PubkyClient {
         self.inner_delete(url).await.map_err(|e| e.into())
     }
 
-    /// Returns a list of Pubky URLs of the files within the `url` path,
-    /// respecting the `cursor`, `reverse` and `limit` options.
+    /// Returns a list of Pubky urls (as strings).
     ///
-    /// `cursor` is usually the last url from previous responses.
+    /// - `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.
     #[wasm_bindgen]
     pub async fn list(
         &self,