npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

getty-entity-lookup

v2.3.2

Published

Find entities (people, places) in getty.

Downloads

27

Readme

getty-entity-lookup

Picture

Travis Codecov version downloads GPL-3.0 semantic-release Commitizen friendly experimental

  1. Overview
  2. Installation
  3. Use
  4. API
  5. Development

Overview

Finds entities (people, places) in getty. Meant to be used with cwrc-public-entity-dialogs where it runs in the browser.

Although it will not work in node.js as-is, it does use the Fetch API for http requests, and so could likely therefore use a browser/node.js compatible fetch implementation like: isomorphic-fetch.

SPARQL

getty supports sparql, but SPARQL has limited support for full text search. The expectation with SPARQL mostly seems to be that you know exactly what you are matching on. So, a query that exactly details the label works fine:

SELECT DISTINCT ?s WHERE {
  ?s ?label "The Rolling Stones"@en .
  ?s ?p ?o
}

We'd like, however, to match with full text search, so we can match on partial strings, variant spellings, etc. Just in the simple case above, for example, someone searching for The Rolling Stones would have to fully specify 'The Rolling Stones' and not just 'Rolling Stones'. If they left out 'The' then their query won't return the result.

There is a SPARQL CONTAINS operator that can be used within a FILTER, and that matches substrings, which is better, and CONTAINS seems to work with getty, e.g.

http://vocab.getty.edu/sparql.json?query=SELECT DISTINCT ?s ?label WHERE {
  ?s rdfs:label ?label .
  FILTER (CONTAINS (?label,"Rolling Stones"))

but again, CONTAINS only matches substrings.

There is at least one alternative to CONTAINS - REGEX - but as described here: https://www.cray.com/blog/dont-use-hammer-screw-nail-alternatives-regex-sparql/ REGEX has even worse performance than CONTAINS.

A further alternative, which we've adopted, is the custom full text SPARQL search function through which Getty exposes it's underlying lucene index, as described here: http://vocab.getty.edu/doc/queries/#Full_Text_Search_Query and here: http://serials.infomotions.com/code4lib/archive/2014/201402/0596.html

The endpoint does not, however, support HTTPS. And so, we proxy our calls to the lookup through own server: https://lookup.services.cwrc.ca/getty to thereby allow the CWRC-Writer to make HTTPS calls to the lookup. We can’t make plain HTTP calls from the CWRC-Writer because the CWRC-Writer may only be loaded over HTTPS, and any page loaded with HTTPS is not allowed (by many browsers) to make HTTP calls.

We also proxy calls to retrieve the full page description of an entity, again to allow calls out from a page that was itself loaded with https. The proxy:https://getty.lookup.services.cwrc.ca which in turn calls http://vocab.getty.edu

Update v.2.3.0 GETTY supports HTTPS now, so we are no longer using the proxy server. Instead we acess https://vocab.getty.edu directly.

Installation

npm i getty-entity-lookup

Use

import gettyLookup from 'getty-entity-lookup';

API

findPerson(query)

findPlace(query)

where the query argument is an object:

{
    entity:  'The name of the thing the user wants to find.',
    options: 'TBD'
}

and all find methods return promises that resolve to an object like the following:

{
  "id": "http://vocab.getty.edu/ulan/500311165",
  "name": "University of Pennsylvania, Lloyd P. Jones Gallery",
  "nameType": "Corporate",
  "originalQueryString": "jones",
  "repository": "getty",
  "uri": "http://vocab.getty.edu/ulan/500311165",
  "uriForDisplay": "https://getty.lookup.services.cwrc.ca/ulan/500311165"
}

There are a further four methods that are mainly made available to facilitate testing (to make it easier to mock calls to the getty service):

getPersonLookupURI(query)

getPlaceLookupURI(query)

where the query argument is the entity name to find and the methods return the getty URL that in turn returns results for the query.

Development

CWRC-Writer-Dev-Docs describes general development practices for CWRC-Writer GitHub repositories, including this one.

Mocking

We use fetch-mock to mock http calls (which we make using the Fetch API rather than XMLHttpRequest).

Continuous Integration

We use Travis.

Release

We follow SemVer, which Semantic Release makes easy.
Semantic Release also writes our commit messages, sets the version number, publishes to NPM, and finally generates a changelog and a release (including a git tag) on GitHub.