@netwerk-digitaal-erfgoed/network-of-terms-catalog 5.6.4 → 5.6.7

package/README.md

@@ -1,20 +1,29 @@
 # Network of Terms Catalog
 
-This is the catalog of datasets that you can query through the
+This is the catalog of terminology sources that can be queried through the
 [Network of Terms](https://github.com/netwerk-digitaal-erfgoed/network-of-terms).
 
-The [catalog](catalog/) directory contains all datasets.
-Each is described in the [Schema.org](https://schema.org) ontology.
+## Data model
 
-The [queries](catalog/queries/) directory contains SPARQL queries for retrieving terms from the datasets.
+Each terminology source is modelled as a [Schema.org Dataset](https://schema.org/Dataset). The [catalog](catalog)
+directory contains all datasets.
 
-## Installation
+Most of the dataset’s properties match the
+[NDE Requirements for Datasets](https://netwerk-digitaal-erfgoed.github.io/requirements-datasets), with the following
+additions specific to the Network of Terms:
 
-This package is [available on NPM](https://www.npmjs.com/package/@netwerk-digitaal-erfgoed/network-of-terms-catalog):
+- `schema:url` is used for the HTTP URI prefix of terms in the dataset, e.g. `http://vocab.getty.edu/aat/` for Getty
+  resources. This prefix is needed when clients look up terms by their URI in the Network of Terms: the Network then has 
+  to know which source to consult to retrieve the term.
+- Each distribution has two [`schema:potentialAction`](https://schema.org/potentialAction)s: a
+  [`schema:SearchAction`](https://schema.org/SearchAction) and a [`schema:FindAction`](https://schema.org/FindAction),
+  both with a [`schema:query`](https://schema.org/query) property that points to the queries directory.
 
-```
-npm add @netwerk-digitaal-erfgoed/network-of-terms-catalog
-```
+The [queries](catalog/queries) directory contains SPARQL queries for retrieving terms from the datasets. There are
+two types of queries:
+
+- [search queries](catalog/queries/search) find terms matching a textual string query input;
+- [lookup queries](catalog/queries/lookup) retrieve a single term based on its URI.
 
 ## Contributing
 
@@ -23,17 +32,7 @@ npm add @netwerk-digitaal-erfgoed/network-of-terms-catalog
 * Create a `your-dataset.jsonld` file in the `catalog/` directory and add a description.
 * Create a `your-dataset.rq` file in the `queries/search` directory and add your SPARQL search query. A SPARQL
   lookup goes into the `queries/lookup` directory.
-* Run the tests to make sure your dataset description conforms to the [dataset SHACL](shacl/dataset.jsonld):
-  ```
-  npm install
-  npm run test
-  ```
-
-### Committing changes
-
-This repository follows [Semantic Versioning](https://semver.org). Tags and 
-[releases](https://github.com/netwerk-digitaal-erfgoed/network-of-terms-catalog/releases) are
-[created automatically](https://github.com/netwerk-digitaal-erfgoed/network-of-terms-catalog/blob/master/.github/workflows/release.yml)
-based on commit messages. 
-So please make sure to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/#summary)
-when committing changes.
+* [Run the tests](../../docs/tests.md) to make sure your dataset description conforms to the
+  [dataset SHACL](shacl/dataset.jsonld).
+* To try your queries locally, you can
+  [run the GraphQL API](../network-of-terms-graphql/README.md#for-network-of-terms-developers) with your catalog.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netwerk-digitaal-erfgoed/network-of-terms-catalog",
-  "version": "5.6.4",
+  "version": "5.6.7",
   "type": "module",
   "description": "Catalog of Network of Terms datasets",
   "repository": {
@@ -20,9 +20,7 @@
     "check": "gts check",
     "clean": "rm -rf build/ tsconfig.build.tsbuildinfo",
     "compile": "npm run clean && tsc --build tsconfig.build.json",
-    "fix": "gts fix",
-    "test": "NODE_OPTIONS=--experimental-vm-modules jest ${1} --forceExit",
-    "posttest": "jest-coverage-thresholds-bumper --silent"
+    "fix": "gts fix"
   },
   "keywords": [
     "nde"
@@ -33,7 +31,7 @@
     "@types/n3": "^1.4.3",
     "@types/rdf-ext": "^1.3.11",
     "gts": "^3.1.0",
-    "jsonld-streaming-parser": "^2.1.0",
+    "jsonld-streaming-parser": "^2.4.3",
     "rdf-data-factory": "^1.0.1",
     "rdf-ext": "^2.0.1",
     "rdf-validate-shacl": "^0.4.0"
@@ -45,8 +43,8 @@
   "dependencies": {
     "@comunica/actor-init-sparql-rdfjs": "^1.17.0",
     "@comunica/bus-query-operation": "^1.17.0",
-    "@netwerk-digitaal-erfgoed/network-of-terms-query": "1.0.1",
-    "globby": "<12.0.0",
+    "@netwerk-digitaal-erfgoed/network-of-terms-query": "1.1.0",
+    "globby": "<14.0.0",
     "rdf-js": "^4.0.2",
     "rdf-parse": "^1.5.0",
     "rdf-store-stream": "^1.1.0"