Introduction

The JavaScript Client Libraries provide a suite of JavaScript Application Programming Interfaces (APIs) to build Solid applications.

Solid Applications

Solid applications access data stored in Solid Pods (Solid Pod is the storage location for data). Solid applications refer to applications that conform to the Solid specifications (similarly for Solid servers and Solid Pods).

The specification defines various Solid application behaviors, including those for:

JavaScript Client Libraries

Inrupt’s JavaScript Client Libraries provide APIs, such as for read/ write/authenticate/access management operations, that conform to the Solid specifications.

Library

Description

solid-client

A client library for accessing data stored in Solid Pods.

solid-client-authn

A set of libraries for authenticating to Solid identity servers.

vocab-common-rdf

A library that provides convenience objects for many RDF-related identifiers, such as the Person and familyName identifiers from the Schema.org vocabulary from Google, Microsoft and Yahoo!

vocab-solid-common

A library that provides convenience objects for many Solid-related identifiers.

vocab-inrupt-common

A library that provides convenience objects for Inrupt-related identifiers.

Browser Support

The JavaScript Client Libraries support all modern web browsers on the latest 2 stable releases, including the following minimum versions:

Desktop

Browser

Version

Google Chrome

Latest 2 stable releases

Mozilla Firefox

Latest 2 stable releases

Microsoft Edge

Latest 2 stable releases

Apple Safari

Latest 2 stable releases

Mobile

Browser

Version

iOS/Safari

Latest 2 stable releases

Android/Chrome

Latest 2 stable releases

Android / Samsung Internet

Latest 2 stable releases

You can use the libraries in the browser with a bundler like Webpack, Rollup, or Parcel.

Getting Started

To get started using these libraries, see the following pages in the documentation:

Getting Started: Part 1

Create an application that uses the libraries to read data from your Solid Pod.

Getting Started: Part 2

Creating an application that uses the libraries to write data to your Solid Pod.