bookmarks-rdflib: documentation / changelog

bookmarks/rdflib/CHANGELOG.md

@@ -2,7 +2,14 @@
 
 All notable changes to this module will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
+to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+### Added
+
+- [discoverStorage](https://solid-contrib.github.io/data-modules/bookmarks-rdflib-api/interfaces/BookmarksModule.html#discoverStorage)
 
 ## 0.1.0
 

bookmarks/rdflib/src/index.ts

@@ -20,23 +20,51 @@ export interface CreateBookmarkCommand {
   url: string;
 }
 
+/**
+ * URLs of potential bookmark storages (documents and/or containers)
+ */
+export interface StorageLocations {
+  /**
+   * List of URLs pointing to documents containing bookmarks
+   */
+  documentUrls: string[];
+  /**
+   * List of URLs pointing to containers containing bookmarks
+   */
+  containerUrls: string[];
+}
+
+/**
+ * Object describing potential storage locations for bookmarks.
+ *
+ */
+export interface BookmarkStorage {
+  /**
+   * locations for personal use, not listed publicly
+   */
+  private: StorageLocations;
+  /**
+   * Locations that can be discovered by the public
+   */
+  public: StorageLocations;
+}
+
 export interface BookmarksModule {
+  /**
+   * Discover configured storages for Bookmarks (containers and/or documents) from private and public type indexes of the given WebID
+   * @param webId - The WebID whose indexes to search
+   */
   discoverStorage(webId: string): Promise<BookmarkStorage>;
 
+  /**
+   * Create a new bookmark at the given storage. Potential storage URLs can be discovered using {@link discoverStorage}.
+   * @param storageUrl
+   * @param title
+   * @param url
+   */
   createBookmark({
-                   storageUrl,
-                   title,
-                   url
-                 }: CreateBookmarkCommand): Promise<string>;
+    storageUrl,
+    title,
+    url,
+  }: CreateBookmarkCommand): Promise<string>;
 }
-
-export interface BookmarkStorage {
-  private: {
-    documentUrls: string[],
-    containerUrls: string[]
-  },
-  public: {
-    documentUrls: string[],
-    containerUrls: string[]
-  }
-}