Introduction#

The JavaScript Client Libraries provide a suite of JavaScript Application Programming Interfaces (APIs) to build Solid applications. Solid applications refer to applications that conform to the Solid specifications .

Inrupt’s 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: `solid-client-authn-browser` for use in a browser. `solid-client-authn-node` for use in Node.js.
`solid-client-access-grants`	A client library for managing access requests and grants.
`solid-client-notifications`	A client library for subscribing to change notifications.
`vocab-common-rdf`	A library that provides convenience objects for many RDF-related identifiers from various existing vocabularies.
`vocab-solid`	A library that provides convenience objects for many Solid-related identifiers. Previously released as `vocab-solid-common`.
`vocab-inrupt-core`	A library that provides convenience objects for Inrupt-related identifiers. Previously released as `vocab-inrupt-common`.

Getting Started#

To get started using these libraries, see:

Getting Started	Create an application that uses the libraries to login, read data from your Solid Pod, and write data to your Solid Pod.
Examination of the Code	Brief explanation of the Getting Started code.

Using the Libraries#

The following pages provides usage examples for the JavaScript libraries:

Library	Usage
`solid-client-authn`	Authenticate (Browser) Session Restore upon Browser Refresh Authenticate (Node.js Web Server) Authenticate (Node.js: Single-User App) Appendix: Client ID Registration (Browser & Node.JS)
`solid-client`	Read/Write Structured Data Read/Write Files (Non-RDF Resources) Access Policies: Universal API
`solid-client-access-grants`	Access Requests and Grants
`solid-client-notifications`	Subscribe to WebSocket Notifications
`vocab-common-rdf`	Vocabulary

Browser Support#

The JavaScript Client Libraries support the latest 2 stable releases of the following browsers:

Desktop	Google Chrome Mozilla Firefox Microsoft Edge Apple Safari
Mobile	iOS/Safari Android/Chrome Android/Samsung Internet

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

Node.js Support#

Inrupt’s Javascript Client libraries support Node.js 14 and 16.