@ubhd/authorities-client

authorities-client

A library for searching/presenting authorities data in Javascript

• Usage
• API
  • AuthoritiesClient.data
  • AuthoritiesClient.utils
  • AuthoritiesClient.plugins
  • AuthoritiesClient.plugin(pluginName, pluginOpts)
• API ubhd/gnd
  • AuthoritiesClient.plugin('ubhd/gnd', opts)
  • infoBox(id)
  • get(id)
  • search(term, opts)
  • suggest(term, opts)
• API - gbv/gnd
  • AuthoritiesClient.plugin('gbv/gnd', opts)
  • infoBox(id)
  • get(id)
  • search()
  • suggest(term, opts)
• Development
• License

Usage

<script src="https://unpkg.com/@ubhd/authorities-client"><script>

const gndClient = AuthoritiesClient.plugin('ubhd/gnd')

gndClient.get('118540238').then(goethe => {
  console.log(`Goethe was born`, goethe.dateOfBirth['@value'])
})

API

The library is exported as AuthoritiesClient.

It has a static factory method plugin to get instances of plugins.

AuthoritiesClient.data

Static data bundled with the client

AuthoritiesClient.utils

Utilities

AuthoritiesClient.plugins

Map of the plugins available.

AuthoritiesClient.plugin(pluginName, pluginOpts)

• @param {string} pluginName Name of the plugin. See AuthoritiesClient.plugins for a list
• @param {object} pluginOpts Options passed to the plugin
• @return {object} Instance of the plugin

API ubhd/gnd

AuthoritiesClient.plugin('ubhd/gnd', opts)

• @param {object} opts Options for constructor
• @param {object} opts.endpoint URL of the authorities-backend server. Default: https://digi.ub.uni-heidelberg.de/normdaten/gnd
• @param {number} opts.width Width of the infoBox. Default: 500

infoBox(id)

Promise a Wikipedia-Style Infobox about id as HTML.

• @param {string} id: GND of the entity to infoBox
• @param {object} opts:
  • @param {string} opts.type: Type restriction. Format infoBox for this one type.
  • @param {string} opts.format: Return format. Either html (for the formatted HTML) or json for both formatted HTML and entity.
  • @param {boolean} opts.heading: Whether to show the headline
• @return {Promise(string)} A promise that resolves to the formatted HTML

get(id)

Return all the data about entity with GND id

search(term, opts)

• @param {string} term: Search term
• @param {object} opts:
  • @param {number} opts.count: Number of results to return. Default: 10
  • @param {string} opts.withSubTypes: Also include subtypes of entities in search
  • @param {string} opts.type: Type restrictions. Results must be of one of these types. space-separated string. Default: no restriction
  • @param {string} opts.format: Can be opensearch to return results in a opensearch-like structure

suggest(term, opts)

Much faster than search but less information per result.

• opts: See search

API - gbv/gnd

AuthoritiesClient.plugin('gbv/gnd', opts)

• @param {object} opts Options for constructor
• @param {object} opts.endpointGet URL of the entityFacts endpoint. Default: http://hub.culturegraph.org/entityfacts
• @param {number} opts.endpointSuggest URL of the suggestions service. Default: https://ws.gbv.de/suggest/gnd/

infoBox(id)

Promise a Wikipedia-Style Infobox about id as HTML.

• @param {string} id: GND of the entity to infoBox
• @param {object} opts:
  • @param {string} opts.type: Type restriction. Format infoBox for this one type. Must be 'DifferentiatedPerson' or 'CorporateBody'.
• @return {Promise(string)} A promise that resolves to the formatted HTML

get(id)

Return all the data about entity with GND id

search()

Not implemented for this plugin

suggest(term, opts)

• @param {string} term: Search term
• @param {object} opts:
  • @param {number} opts.count: Number of results to return. Default: 10
  • @param {string} opts.type: Type restrictions. Results must be of one of these types. space-separated string. Default: no restriction
  • @param {string} opts.format: Must be opensearch

Development

Install dependencies:

npm install

Build a development bundle:

npm run dev

To watch for changes in dev mode:

npm run watch

To rebuild dist:

npm run build

We are using rollup to bundle the authorities-client, see rollup.dev.config.js and rollup.prod.config.js for the build configuration.s

License

Copyright (c) 2017 - 2022 Universitätsbibliothek Heidelberg

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.