Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

cspace-client

collectionspace311ECL-2.02.0.0

CollectionSpace client for browsers and Node.js

collectionspace, cspace, client

readme

cspace-client

npm package continuous integration codecov

A CollectionSpace client, built on the cspace-api library.

Release 4.5 of the CollectionSpace services API is required. This library is not compatible with releases 4.4 and earlier.

Features

  • Supports browsers and Node.js
  • Promise based
  • Session-oriented API
  • Transparent authentication token management

Installation

Using npm:

$ npm install cspace-client

Using git:

$ git clone https://github.com/collectionspace/cspace-client.js.git
$ cd cspace-client.js
$ npm install

Usage

See the examples and integration tests for examples of usage.

About CollectionSpace

CollectionSpace is a free, open-source collections management application for museums, historical societies, natural science collections, and more.

changelog

Change Log

v2.0.0

v2.0.0 adds support for the OAuth 2 authorization code grant, used by CollectionSpace 8.0.

Breaking Changes

  • The session login method now issues a request for a token using the OAuth 2 authorization code grant, instead of the password grant. This requires a CollectionSpace 8.0 server. A login attempt to an older CollectionSpace server will fail.