Added Solid support

.github/workflows/test-and-lint.yml

@@ -4,6 +4,9 @@ on:
     branches: [ master, stable ]
   pull_request:
     branches: [ master, stable ]
+  # Allows you to run this workflow manually from the Actions tab.
+  workflow_dispatch:
+
 jobs:
   build:
     name: node.js

README.md

@@ -6,8 +6,8 @@
 remoteStorage.js is a JavaScript library for storing user data locally in the
 browser, as well as connecting to [remoteStorage](http://remotestorage.io)
 servers and syncing data across devices and applications. It is also capable of
-connecting and syncing data with a person's Dropbox or Google Drive account
-(optional).
+connecting and syncing data with a person's Dropbox, Google Drive or Solid
+account (optional).
 
 The library is well-tested and actively maintained. It is safe to use in
 production.

docs/.vitepress/config.mts

@@ -52,7 +52,7 @@ export default defineConfig({
           { text: 'Usage with Node.js', link: '/nodejs' },
           { text: 'Usage in Cordova apps', link: '/cordova' },
           { text: 'Usage with TypeScript', link: '/typescript' },
-          { text: 'Dropbox and Google Drive', link: '/dropbox-and-google-drive' },
+          { text: 'Dropbox, Google Drive and Solid', link: '/dropbox-googledrive-solid' },
         ]
       },
       {

docs/dropbox-and-google-drive.md → docs/dropbox-googledrive-solid.md

@@ -1,9 +1,9 @@
-# Offering Dropbox and Google Drive storage options
+# Offering Dropbox, Google Drive, and Solid storage options
 
 ![Screenshot of the connect-widget choose-backend screen](./images/screenshot-widget-choose.png){width="50%"}
 
-rs.js has optional support for syncing data with Dropbox and Google
-Drive instead of a RemoteStorage server.
+rs.js has optional support for syncing data with Dropbox, Google
+Drive, and Solid instead of a RemoteStorage server.
 
 There are a few drawbacks, mostly sync performance and the lack of a
 permission model. So apps can usually access all of a user's storage
@@ -29,6 +29,23 @@ only the available storage options, based on the presence of the Dropbox and
 Google Drive API keys. RemoteStorage is always enabled.
 :::
 
+For the Solid backend you have to specify the available authentication URLs
+for the user to choose from on the connect widget's configurations. Once
+configured, it will also show Solid as an available storage option. Like so:
+
+```js
+const config = {
+    solidProviders: {
+        providers: [
+            Widget.SOLID_COMMUNITY,
+            Widget.INRUPT
+        ],
+        allowAnyProvider: true
+    }
+};
+const widget = new Widget(remoteStorage, config);
+```
+
 ## Dropbox
 
 An app key can be obtained by [registering your
@@ -75,3 +92,23 @@ Console](https://console.developers.google.com/flows/enableapi?apiid=drive).
 
 - Sharing public files is not supported yet (see issue 1051)
 - `getItemURL` is not implemented yet (see issue 1054)
+
+## Solid
+
+An authentication URL must always have been set on the Solid backend before
+calling `connect()`. You can do so by calling `setAuthURL()` first.
+
+The connect widget accepts a list of authentication URLs as configuration
+and automatically sets it on the Solid backend when selected.
+
+Each option consists of two keys: `authURL` which is the authentication URL
+to connect to. And a `name` to be displayed on the widget. The
+`allowAnyProvider` option if set to `true`, adds an input box to the widget
+to allow the user to type any authentication URL of their choosing.
+
+::: info
+The Solid backend exposes the connected session. It is the `Session` object
+from the [Inrupt](https://docs.inrupt.com/developer-tools/javascript/client-libraries/)
+Solid library. It can be accessed by calling `remoteStorage.solid.getSession()`
+only after the backend is connected.
+:::

docs/index.md

@@ -12,7 +12,7 @@ Welcome to the remoteStorage.js documentation!
 remoteStorage.js is a JavaScript/TypeScript library for storing user data
 locally in the browser, as well as connecting to [remoteStorage](/) servers and
 syncing data across devices and applications. It is also capable of connecting
-and syncing data with a person\'s Dropbox or Google Drive account (optional).
+and syncing data with a person\'s Dropbox, Google Drive, or Solid account (optional).
 
 > [!NOTE]
 > For brevity\'s sake, we will also use the short name **rs.js** across these docs.

docs/why.md

@@ -56,10 +56,10 @@ critical bug, there\'s a team of people who will help with fixing it.
 
 ## One JS API for multiple storage options
 
-rs.js optionally supports Dropbox and Google Drive as storage backends which
-users can connect. Conveniently, as an app developer you don\'t have to
+rs.js optionally supports Dropbox, Google Drive and Solid as storage backends
+which users can connect. Conveniently, as an app developer you don\'t have to
 implement anything special in order for these backends to work with your code.
-Just [configure OAuth app keys](./dropbox-and-google-drive), and
+Just [configure OAuth app keys](./dropbox-googledrive-solid), and
 your users can choose between 3 different backends to connect. If you're not
 using the [connect widget](./getting-started/connect-widget), you may need to
 create additional UI for these alternate backends.