@nihiliad/janus-uri-factory-plugins v3.1.0

janus-uri-factory-plugins

Plugins for the Janus URI factory.

Contents

• Scopes and Formats - ArchiveSpace - GoogleCustomSearch - MncatDiscovery - Primo - PrimoNews - PubMed - UMedia - Conservancy - WorldCat & WorldCat Discovery
• Install
• Use
• Test - Lint - Integration Tests - Unit Tests

Scopes and Formats

Except for Conservancy, PubMed, and WorldCat, each plugin defines a list of valid scope values.

Plugins may also define a list of valid format values, implemented only by Primo.

ArchiveSpace

We use ArchiveSpace repositories for scopes.

Conservancy

UDC scopes can be either a single slash (/), for all or the UDC, or id/collectionId, where id and collectionId are both integers. id always seems to be 1129, and Conservancy scope handling depends on that being true. We require users to pass in only the collectionId. A list can be found at:

https://conservancy.umn.edu/community-list

The URLs listed there are all of the form: https://conservancy.umn.edu/handle/11299/collectionId

Examples:

Google Custom Search

Performs a search via the Google Custom Search endpoint configured at https://www.lib.umn.edu/search or https://hsl.lib.umn.edu/search

Base site URLs are available as scopes

Google Custom Search has no fields.

MncatDiscovery

Alias of Primo.

Primo

Primo Scopes

Primo Formats

Primonews

Newspaper searches within Primo. Does not use scopes or formats.

PubMed

The PubMed search engine does not use scopes.

UMedia

Alias of umediaorganization

UMedia Organization

Scope UMedia search results by Contributing Organization facet. Contributing Organizations are valiated against this list, and provided with an abbreviated name for convenience. Currently available Contributing Organizations are listed at https://umedia.lib.umn.edu/facets?facet_field=contributing_organization_name_s&facet_limit=500&facet_sort=index

Sample Usage:

# Search for "maps" within United States Geological Survey contributions
/janus?target=umediaorganization&scope=usgs&search=maps

UMedia Collection

Scope UMedia search results by Collection name. Hundreds of collections are available and the list is too fluid to validate. Scope values will be accepted and passed to UMedia as a facet. Currently available collections usable as scope values are listed at https://umedia.lib.umn.edu/facets?facet_field=collection_name_s&facet_limit=500&facet_sort=index

Sample Usage:

# Search for "arboretum" within the Cloquet Forestry Center Records collection
/janus?target=umediacollection&scope=Cloquet+Forestry+Center+Records&search=arboretum

WorldCat

The WorldCat search engine does not use scopes.

Install

Install with npm. In package.json, include something like...

  "dependencies": {
    "@nihiliad/janus-uri-factory-plugins": "^2.0.0"
  }

...where version based on the version value in this project's package.json. Then npm install.

Missing Dependencies of Dev Dependencies

Sometimes npm install has not installed dependencies of packages in devDependencies, e.g., eslint, in package.json. If this happens, running npm install --save-dev should fix it.

Use

const janus = require('@nihiliad/janus');
const plugins = require('@nihiliad/janus-uri-factory-plugins');
const app = janus({
  uriFactoryPlugins: plugins,
});

Test

To run the linter and all unit tests:

npm test

Lint

We use standardjs for linting. To lint all files:

npx standard

To automatically fix any errors that can be fixed automatically:

npx standard --fix

To lint a single file, e.g., index.js:

npx standard index.js

Integration Tests

Some unit tests make HTTP requests to real web services. To run those tests, set the RUN_INTEGRATION_TESTS environment variable to a true value. The default value is false. This works for npm test and all commands described below.

Unit Tests

We use tape for unit tests. To run all unit tests:

npx tape test/*.js

To run a single unit test file, e.g., test/factory.js:

npx tape test/factory.js