@nanopub/utils is a JavaScript library providing utility functions and objects to work with Nanopublications: search, fetch, parse...
You can easily import @nanopub/utils from a npm CDN and use it in your HTML page, or JavaScript project:
<html lang="en">
<head>
<script type="module" src="https://unpkg.com/@nanopub/utils"></script>
</head>
<body>
<h1>Check the console</h1>
</body>
<script type="module">
const {getUpdateStatus, Nanopub} = NanopubUtils
const np = await Nanopub.fetch('https://w3id.org/np/RAHtkscyyyJDLvWRuINckQrn5rbHzQKvwakNVC3fmRzGU')
console.log('Parsed nanopub:', np)
const status = await getUpdateStatus('https://w3id.org/np/RAHtkscyyyJDLvWRuINckQrn5rbHzQKvwakNVC3fmRzGU')
console.log(status)
</script>
</html>
You can instantiate the Nanopub object using various approaches:
Fetch from a URI using an async function:
import {Nanopub} from '@nanopub/utils'
const np = await Nanopub.fetch('https://w3id.org/np/RAHtkscyyyJDLvWRuINckQrn5rbHzQKvwakNVC3fmRzGU')
Parse a RDF string in TRiG format:
import {Nanopub} from '@nanopub/utils'
const rdfString = `@prefix this: <http://purl.org/np/RAHtkscyyyJDLvWRuINckQrn5rbHzQKvwakNVC3fmRzGX> .
@prefix sub: <http://purl.org/np/RAHtkscyyyJDLvWRuINckQrn5rbHzQKvwakNVC3fmRzGX#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix np: <http://www.nanopub.org/nschema#> .
@prefix npx: <http://purl.org/nanopub/x/> .
@prefix orcid: <https://orcid.org/> .
@prefix prov: <http://www.w3.org/ns/prov#> .
sub:Head {
this: np:hasAssertion sub:assertion ;
np:hasProvenance sub:provenance ;
np:hasPublicationInfo sub:pubinfo ;
a np:Nanopublication .
}
sub:assertion {
<http://identifiers.org/umls/C0355800> rdfs:label "Naltrexone hydrochloride" .
}
sub:provenance {
sub:assertion prov:generatedAtTime "2023-02-21T11:15:07.732162"^^xsd:dateTime ;
prov:wasAttributedTo orcid:0000-0002-1501-1082 .
}
sub:pubinfo {
sub:sig npx:hasAlgorithm "RSA" ;
npx:hasPublicKey "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCR9fz0fKCdWOWC+pxhkQhEM/ppbdIYe5TLSdj+lJzSlv9mYBaPgrzVezSwwbmhlHBPDZa4/vHycU315BdmUGq+pXllp9+rWFfrb+kBJwhZjpG6BeyyXBsRFz4jmQVxl/ZYHilQTh/XalYzKkEAyTiEMPee4Kz61PaWOKH24CsnOQIDAQAB" ;
npx:hasSignature "jjrkdlQ340JSloOmL24tOZkKnMuDl6ztapHOi/2tlnabownWOKUPtilPVMvFd4Hsz6bLfB+bk59rlDz3Qb02H7lhJAH6C75LiFKiddbvPA+8VYXYOZmBJNwmsC45ScB1gm3yJlJRPMKm1/uIFYXg7Wfx4+ukoSInbZ/wgzff0vg=" ;
npx:hasSignatureTarget this: .
this: prov:generatedAtTime "2023-02-21T11:15:07.732162"^^xsd:dateTime ;
prov:wasAttributedTo orcid:0000-0002-1501-1082 .
}`
const np = await Nanopub.parse(rdfString)
Provide an already parsed RDF/JS store:
import {Nanopub} from '@nanopub/utils'
import {Parser, Store} from 'n3'
const parser = new Parser()
const store = new Store(parser.parse(rdfString))
const np = await Nanopub.parse(store)
You can also directly use the constructor synchronously:
import {Nanopub} from '@nanopub/utils'
const np = new Nanopub(rdfString) // string or Store
You can then easily reuse the instantiated object to work with the Nanopub:
// Get the Nanopub URI
np.uri
// Get creation date and author of the nanopub
np.dateCreated
np.author
// Generate an object built to easily display the nanopub visually
np.display()
// Get the namedNode (URI) for a specific graph
np.graphs.assertion
np.graphs.provenance
np.graphs.pubinfo
// Get the Nanopub RDF string
np.rdfString
// Browse the nanopub RDF using the RDF/JS store
for (const quad of np.store.match(null, null, null)) {
console.log(quad.subject.value.toString())
}
// Iterate the triples in the assertion graph
for (const quad of np.store.match(null, null, null, np.graphs.assertion)) {
console.log(quad.subject.value)
}
// Iterate the nanopub prefixes
for (const [prefix, namespace] of Object.entries(np.prefixes)) {
console.log(prefix, namespace)
}
@nanopub/utils is distributed on npm, so you can install it in your project, or use it via npm CDNs like unpkg.com.
If you want to improve this library, please refer to the contribute page which details how to use the library in development.
The most convenient way to install a package in your project, using either npm or yarn:
npm i --save @nanopub/utils
# or
yarn add @nanopub/utils
# or
pnpm add @nanopub/utils
Then import it in your JavaScript/TypeScript:
import {Nanopub} from '@nanopub/utils'
const np = await Nanopub.fetch('https://w3id.org/np/RAHtkscyyyJDLvWRuINckQrn5rbHzQKvwakNVC3fmRzGU')
npm CDNs like unpkg.com or jsdelivr.com can directly serve files that have been published to npm. This works great for standard JavaScript modules that the browser can load natively, or minified bundles.
<script type="module" src="https://unpkg.com/@nanopub/utils"></script>
We also distribute Nanopub Display as a minified bundle with all dependencies pre-included, to import the latest version:
<script type="module" src="https://cdn.jsdelivr.net/npm/@nanopub/utils/dist/index.min.js"></script>
In production we recommend to use a specific version:
<script type="module" src="https://cdn.jsdelivr.net/npm/@nanopub/utils@1.0.7/dist/index.min.js"></script>
Generated using TypeDoc