dspace-rest

DSpace REST API Client

NodeJs client for DSpace 7+ REST API

Note: This is the successor of dspace7-node

Requirements

• Node.js >= 18.0.0
• DSpace 7.x or newer

Installation

npm install dspace-rest

CLI Usage

The package provides a command-line interface (CLI) for interacting with DSpace servers directly from your terminal.

CLI Setup

The CLI is available as dspace-cli. You can run it in a few ways:

• Using npx without prior installation (recommended for quick use or one-off commands): This command will temporarily download the dspace-rest package (if not already cached) and then execute dspace-cli.

  npx -p dspace-rest dspace-cli --help
  

• If dspace-rest is a dependency in your project: After running npm install dspace-rest or yarn add dspace-rest in your project:

  npx dspace-cli --help
  

• If dspace-rest is installed globally: After running npm install -g dspace-rest:

  dspace-cli --help
  

Configuration

Before using most commands, set your DSpace server URL and login credentials:

dspace-cli -h
dspace-cli config:set https://demo.dspace.org/server
dspace-cli config:verify
dspace-cli config:show
dspace-cli login
dspace-cli login:status

Common Commands

• Reset configuration:

  dspace-cli config:reset
  dspace-cli login:reset
  

• List all items:

  dspace-cli items:list
  

• Show item details:

  dspace-cli items:show <itemId>
  

• Update item metadata:

  dspace-cli items:update <itemId> '[{"op":"add","path":"/metadata/dc.title","value":[{"value":"New Title"}]}]'
  

• List all collections:

  dspace-cli collections:list
  

• Add a bitstream to an item:

  dspace-cli bitstreams:add <itemId> <filename> <filePath>
  

• Delete a bitstream:

  dspace-cli bitstreams:delete <bitstreamId>
  

• Move an item to another collection:

  dspace-cli items:move <itemId> <collectionId>
  

More

Run dspace-cli --help or any subcommand with --help for a full list of available commands and options.

Direct Lib Usage

See the examples directory for practical usage examples of this library.

// Use import for ESM (add "type": "module" to package.json)
import {dspaceApi} from 'dspace-rest'
// Or for CommonJS:
// const { dspaceApi } = require('dspace-rest')

// Initialize client
dspaceApi.init('http://localhost:8080/server')

dspaceApi.core.info().then((info) => {
  console.log(info)
})

dspaceApi.auth.login('[e-mail]', 'password').then((result) => {
  console.log(`Login result: ${result}`)
})

dspaceApi.communities.top().then((communities) => {
  const communityList = topCommunitiesResponse._embedded.communities
  communityList.forEach((community) => {
    console.log(community.name)
  })
})

// More examples:
// https://github.com/semanticlib/dspace-rest/tree/main/examples

Using TypeScript Types

This package exports all DSpace REST API types through a Types namespace. You can use these types in your TypeScript code:

import {dspaceApi, Types} from 'dspace-rest'

async function showCollections() {
  try {
    const res: Types.Communities = await dspaceApi.communities.top()
    const commList: Types.Community[] = res._embedded.communities

    for (const comm of commList) {
      console.log(`${comm.name} (id: ${comm.uuid})`)

      // Using the exported Types.Collections type
      const res2: Types.Collections = await dspaceApi.collections.byComId(comm.uuid)
      const colList: Types.Collection[] = res2._embedded.collections

      if (colList.length) {
        console.log('\t=> Collections')
        colList.forEach(col => {
          console.log(`\t${col.name} (id: ${col.uuid})`)
        })
      }
    }
  } catch (e) {
    console.error('Error in getting collections')
  }
}

Available types include:

• Types.ApiInfo
• Types.Community
• Types.Communities
• Types.SubCommunities
• Types.Collection
• Types.Collections
• Types.Item
• Types.Items
• Types.Bitstream
• Types.Bitstreams
• Types.Bundle
• Types.Bundles
• Types.DspaceEntity
• Types.ListResponse

Features

• Authentication and session management
• Communities and Collections
  • List/search communities and subcommunities
  • Create and delete collections
  • Retrieve collection metadata
• Items
  • Search and retrieve items
  • Update item metadata
  • Move items between collections
• Bundles
  • List bundles by item
  • Get bundle details
• Bitstreams
  • Upload new bitstreams
  • Delete single or multiple bitstreams
  • Delete all bitstreams from an item
  • Support for ORIGINAL and LICENSE bundles