Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/gbv/jskos-tools

Tools for working with the JSKOS data format.
https://github.com/gbv/jskos-tools
coli-conc library
Last synced: about 1 month ago
JSON representation
Tools for working with the JSKOS data format.
Host: GitHub
URL: https://github.com/gbv/jskos-tools
Owner: gbv
License: mit
Created: 2018-08-01T08:33:58.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-02-16T10:42:39.000Z (10 months ago)
Last Synced: 2024-04-14T12:58:41.689Z (8 months ago)
Topics: coli-conc, library
Language: JavaScript
Homepage: https://gbv.github.io/jskos-tools/
Size: 3.51 MB
Stars: 2
Watchers: 5
Forks: 0
Open Issues: 19
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        # JSKOS Tools

[![Test](https://github.com/gbv/jskos-tools/actions/workflows/test-and-build.yml/badge.svg)](https://github.com/gbv/jskos-tools/actions/workflows/test-and-build.yml)

[![GitHub package version](https://img.shields.io/github/package-json/v/gbv/jskos-tools.svg?label=version)](https://github.com/gbv/jskos-tools)

[![NPM package name](https://img.shields.io/badge/npm-jskos--tools-blue.svg)](https://www.npmjs.com/package/jskos-tools)

[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg)](https://github.com/RichardLitt/standard-readme)

> Tools for working with the JSKOS data format.

This repository contains tools for working with the [JSKOS data format for knowledge organization systems](http://gbv.github.io/jskos/).

## Table of Contents

- [Install](#install)

- [Usage](#usage)

  - [Mapping Identifiers](#mapping-identifiers)

    - [mappingContentIdentifier](#mappingcontentidentifier)

    - [mappingMembersIdentifier](#mappingmembersidentifier)

    - [addMappingIdentifiers](#addmappingidentifiers)

    - [compareMappings](#comparemappings)

    - [compareMappingMembers](#comparemappingmembers)

  - [ConceptScheme](#conceptscheme)

  - [languagePreference](#languagepreference)

    - [How to Configure](#how-to-configure)

    - [getLanguages](#getlanguages)

    - [selectLanguage](#selectlanguage)

  - [Tools](#tools)

    - [addContext](#addcontext)

    - [clean](#clean)

    - [copyDeep](#copydeep)

    - [getAllUris](#getalluris)

    - [compare](#compare)

    - [isConcept](#isconcept)

    - [isScheme](#isscheme)

    - [isContainedIn](#iscontainedin)

    - [sortConcepts](#sortconcepts)

    - [sortSchemes](#sortschemes)

    - [minifyMapping](#minifymapping)

    - [mappingTypes](#mappingtypes)

    - [mappingTypeByUri](#mappingtypebyuri)

    - [mappingTypeByType](#mappingtypebytype)

    - [defaultMappingType](#defaultmappingtype)

    - [flattenMapping](#flattenmapping)

    - [mappingCSV](#mappingcsv)

    - [serializeCSV](#serializecsv)

    - [conceptsOfMapping](#conceptsofmapping)

    - [compareMappingsDeep](#comparemappingsdeep)

    - [matchObjectTypes](#matchobjecttypes)

    - [mergeUris](#mergeuris)

    - [merge](#merge)

    - [normalize](#normalize)

    - [isValidUri](#isvaliduri)

    - [objectTypes](#objecttypes)

    - [guessObjectType](#guessobjecttype)

    - [guessSchemeFromNotation](#guessschemefromnotation)

    - [compareFunctions](#comparefunctions)

    - [userOwnsMapping](#userownsmapping)

    - [notation](#notation)

    - [languageMapContent](#languagemapcontent)

    - [prefLabel](#preflabel)

    - [definition](#definition)

    - [mappingRegistryIsStored](#mappingregistryisstored)

    - [annotationCreatorUri](#annotationcreatoruri)

    - [annotationCreatorName](#annotationcreatorname)

    - [annotationCreatorMatches](#annotationcreatormatches)

- [Build](#build)

- [Test](#test)

- [Maintainers](#maintainers)

- [Publish](#publish)

- [Contribute](#contribute)

- [License](#license)

## Install

```bash

npm i jskos-tools

```

jskos-tools requires Node.js 18 or later.

We are also providing browser bundles:

- Development (not minified, ~19K gzipped, ~68K not gzipped): https://cdn.jsdelivr.net/npm/jskos-tools/dist/jskos-tools.js

- **Production** (minified, ~10K gzipped, ~26K not gzipped): https://cdn.jsdelivr.net/npm/jskos-tools@1/dist/jskos-tools.min.js

[![](https://data.jsdelivr.com/v1/package/npm/jskos-tools/badge?style=rounded)](https://www.jsdelivr.com/package/npm/jskos-tools)

## Usage

If you installed jskos-tools via npm, use it like this:

```js

const jskos = require("jskos-tools")

```

Or as an ES module:

```js

import * as jskos from "jskos-tools"

```

Using the browser bundles will provide you with the `jskos` global variable.

See  for full API documentation of

[module jskos-tools](https://gbv.github.io/jskos-tools/module-jskos-tools.html).

### Mapping Identifiers

```js

let mapping = {

  ...

}

```

#### mappingContentIdentifier

`mappingContentIdentifier` starts with urn:jskos:mapping:content: and takes concepts and type into consideration. It uses the `mappingContent` function to get relevant properties from the mapping.

```js

let contentIdentifier = jskos.mappingContentIdentifier(mapping)

```

#### mappingMembersIdentifier

`mappingMembersIdentifier` starts with urn:jskos:mapping:members: and only takes concepts into consideration. It uses the `mappingMembers` function to get relevant properties from the mapping.

```js

let membersIdentifier = jskos.mappingMembersIdentifier(mapping)

```

#### addMappingIdentifiers

`addMappingIdentifiers` creates a new mapping with property "identifiers", containing mappingContentIdentifier and mappingMembersIdentifier.

```js

let mappingWithIdentifiers = jskos.addMappingIdentifiers(mapping)

```

#### compareMappings

`compareMappings` compares two mappings based on their `mappingContentIdentifier`.

```js

if (jskos.compareMappings(mapping1, mapping2)) { ... }

```

Aliases: `compareMappingContent`

#### compareMappingMembers

`compareMappingMembers` compares two mappings based on their `mappingMembersIdentifier`.

```js

if (jskos.compareMappingMembers(mapping1, mapping2)) { ... }

```

### ConceptScheme

See [class ConceptScheme](https://gbv.github.io/jskos-tools/module-jskos-tools.ConceptScheme.html).

### languagePreference

Used to provide access to a preference list of language tags.

#### How to Configure

If this is used inside a web application that allows multiple interface languages and depends on reactivity, it is necessary to properly configure this at the start of the application. There are two ways to do this:

1. Provide a reference to the Vuex store and path where the language preference list of the application resides:

```javascript

const store = require("./store") // import the Vuex store

jskos.languagePreference.store = store

jskos.languagePreference.path = "state.languages" // or wherever your languages array resides

```

Note: In theory, `store` doesn't HAVE to be a Vuex store. It could be any kind of object which contains the `languages` array somewhere. (See also: [Tests](https://github.com/gbv/jskos-tools/blob/master/test/language-preference.js#L34-L39))

2. Provide a reference to a preference list array of languages tags directly via `defaults`. Note: Make sure that this array only gets modified in-place, otherwise you will override the previous reference to the array. (Example using [array.prototype.move](https://www.npmjs.com/package/array.prototype.move).)

```javascript

const languages = ["en", "de"]

jskos.languagePreference.defaults = languages

languages.move(1, 0) // moves "de" to the front of the preference list

```

#### getLanguages

Returns the current preference list of language tags (either from `store` or `defaults`).

#### selectLanguage

Selects a language tag from a language map according to the current preference list or `null` if no language was found.

### Tools

#### addContext

Add `@context` URI to a JSKOS object or to an array of JSKOS objects.

```js

jskos.addContext(object)

```

#### clean

Removes properties starting with `_` or containing only uppercase letters from a JSKOS object.

```js

jskos.clean(object)

```

Aliases: `cleanJSKOS`

#### copyDeep

Creates a deep copy of a JSKOS object, replacing possibly circular structures with open world `[null]` statements. As the second argument it is possible to add additional properties that should be replaced with open world `[null]` statements. The third argument determines whether all properties starting with `_` should be ignored (`true` by default).

```js

jskos.copyDeep(object)

jskos.copyDeep(object, ["someCircularProperty"])

jskos.copyDeep(object, null, false)

```

Aliases: `deepCopy`

#### getAllUris

Returns all possible URIs for a JSKOS object. Takes into consideration both the uri and identifier properties, as well as different variants of those identifiers. Returns an empty array if object is `null`.

```js

jskos.getAllUris(object)

```

#### compare

Compares two objects based on their URIs, using `getAllUris`. Returns `true` if both objects are `null`.

```js

jskos.compare(object1, object2)

```

Aliases: `compareObjects`, `compareSchemes`, `compareConcepts`

#### isConcept

Checks whether JSKOS object is a concept based on type property.

```js

jskos.isConcept(object)

```

#### isScheme

Checks whether JSKOS object is a concept scheme based on type property.

```js

jskos.isScheme(object)

```

#### isContainedIn

// Checks whether an object is contained in a list of objects using `compare`.

```js

jskos.isContainedIn(object, listOfObjects)

```

Aliases: `isSchemeInList`

#### sortConcepts

Sorts a list of concepts by their notation, then URI. Returns a copy of the list. If the second parameter is `true`, it will try to sort by numerical notations.

```js

jskos.sortConcepts(concepts)

```

#### sortSchemes

Sorts a list of schemes by their prefLabel (de or en), then notation, then URI. Returns a copy of the list.

```js

jskos.sortSchemes(schemes)

```

#### minifyMapping

Removes unnecessary properties from mapping before export or saving. In particular, all properties except for `to`, `from`, `toScheme`, `fromScheme`, `type`, `creator`, `contributor`, `created`, `modified`, `note`, and `identifier` on the mapping will be removed, and all properties except for `uri` and `notation` on concepts and schemes will be removed.

```js

let newMapping = jskos.minifyMapping(mapping)

```

#### mappingTypes

An array of mapping types in form of objects. Objects can have the following properties:

- `notation` - an array of notations (in this case symbols)

- `uri` - the URI of the mapping type

- `prefLabel` - a language maps of labels

- `broader` - array of broader mapping types for this type

- `related` - array of related mapping types

- `RELEVANCE` - relevance label for GND terms (low, medium, high, very high)

- `SHORT` - a short name for the type, used for CSV import/export

The labels are taken from Wikidata (see script `bin/localize-mapping-types`).

Example object:

```json

{

  "notation": ["≈"],

  "uri": "http://www.w3.org/2004/02/skos/core#closeMatch",

  "prefLabel": { "en": "close match" },

  "broader": [ { "uri": "http://www.w3.org/2004/02/skos/core#mappingRelation" } ],

  "RELEVANCE": "high",

  "SHORT": "close"

}

```

#### mappingTypeByUri

Returns a mapping type object for an URI.

```js

jskos.mappingTypeByUri("http://www.w3.org/2004/02/skos/core#closeMatch")

```

#### mappingTypeByType

Returns a mapping type for a JSKOS type property. This is usually an array where the first type is taken, but a workaround for string types is included as well.

```js

jskos.mappingTypeByType(mapping.type)

```

#### defaultMappingType

The default mapping type (currently `mapping relation`).

#### flattenMapping

Converts a mapping into a flat object with for serialization as CSV. Returns an object with fields `fromNotation`, `toNotation`, `type`, and (if option `language` has been provided) `fromLabel`, `toLabel`, and `creator`.

#### mappingCSV

Returns an object of preconfigured conversion functions to convert mappings into CSV. Supports 1-to-1, 1-to-n, and n-to-n mappings.

```js

// Initialize converter with default options

const csv = jskos.mappingCSV({

  delimiter: ",",

  quoteChar: "\"",

  lineTerminator: "\n",

  type: true,

  schemes: false,

  labels: false,

  creator: false,

  language: "en",

})

// Header line for an array of mappings (assuming 1-to-1 mappings if no array is given)

csv.header(mappings)

// Single CSV line for a mapping (uses fromCount and toCount from the mapping by default)

csv.fromMapping(mapping, { fromCount: null, toCount: null })

// Multiline CSV from array of mappings (includes header by default)

csv.fromMappings(mappings, { header: true })

```

The order of the CSV fields is fromScheme, fromNotation, (fromLabel,) (fromNotation2, fromLabel2, ...) toNotation, (toLabel,) (toNotation2, toLabel2, ...) type, creator.

#### serializeCSV

Returns a function to serialize an array as CSV row as configured with [CSV Dialect]().

#### conceptsOfMapping

Returns an array of concepts contained in a mapping. `side` can either be `from` or `to`. If `side` is left out, concepts from both sides will be returned. `null` values will be omitted.

```js

jskos.conceptsOfMapping(mapping)

```

#### compareMappingsDeep

`compareMappingsDeep` compares two mappings based on their properties. Concept sets and schemes are compared by URI.

```js

if (jskos.compareMappingsDeep(mapping1, mapping2)) { ... }

```

#### matchObjectTypes

Compares two JSKOS objects based on their types. Returns `false` only if both types could be guessed using [`guessObjectType`](#guessobjecttype) and they did not match, otherwise it will assume that the types match.

#### mergeUris

Merge URIs of two objects `a` and `b` into `a` by adding/removing URIs from identifier property.

#### merge

Merges two JSKOS objects. See [documentation](https://gbv.github.io/jskos-tools/module-jskos-tools.html#.merge) for more information.

#### normalize

Applies recursive unicode normalization to data.

#### isValidUri

Checks whether a string is a valid URI.

#### objectTypes

An object that maps JSKOS object type names to their description.

#### guessObjectType

Guess the JSKOS object type of an object, URI or name and return its canonical name.

```js

type = guessObjectType(objectOrString)        // get full name such as `ConceptScheme`

type = guessObjectType(objectOrString, true)  // get short name such as `scheme`

```

#### guessSchemeFromNotation

Filter a list of concept schemes with a given notation to guess which scheme(s) the notation origins from. Schemes without `notationPattern` or default pattern `.+` are ignored. Returns a (posssibly empty) array of concept schemes.

```js

matchingSchemes = guessSchemeFromNotation(notation, schemes)

```

#### compareFunctions

An object containing compare functions that can be used with `array.sort()` etc.

Available functions:

- `compareFunctions.mappingsByConcepts` - compares mappings by the notations of their first concepts

#### userOwnsMapping

Determines whether a ([login-server](https://github.com/gbv/login-server)-compatible) user owns a mapping (i.e. is the first `creator`) or not.

#### notation

Returns the primary notation for a JSKOS Item. If there is no notation, it will return an empty string. Scheme notations will be uppercased.

#### languageMapContent

Returns the content of a language map for a JSKOS Item.

#### prefLabel

Returns the prefLabel of a JSKOS Item. If there is no label, it will return the URI. If there is no URI, it will return an empty string.

#### definition

Returns the definition of a JSKOS Item as an array. If there is no definition, an empty array will be returned.

#### mappingRegistryIsStored

Returns whether a mapping registry has stored mappings (`true` = database) or not (`false` = recommendations).

#### annotationCreatorUri

Returns the creator URI for an annotation.

#### annotationCreatorName

Returns the craetor name for an annotation.

#### annotationCreatorMatches

Matches an annotation's creator URI against a list of URIs (e.g. from a user).

## Build

```bash

git clone --recursive https://github.com/gbv/jskos-tools.git

cd jskos-tools/

npm install

```

API documentation can be generated in directory `jsdoc/build`:

```bash

npm run docs

```

## Test

```bash

npm test

```

## Maintainers

- [@stefandesu](https://github.com/stefandesu)

- [@nichtich](https://github.com/nichtich)

## Publish

Please work on the `dev` branch during development (or better yet, develop in a feature branch and merge into `dev` when ready).

When a new release is ready (i.e. the features are finished, merged into `dev`, and all tests succeed), run the included release script (replace "patch" with "minor" or "major" if necessary):

```bash

npm run release:patch

```

This will:

- Run tests and build to make sure everything works

- Switch to `dev`

- Make sure `dev` is up-to-date

- Run `npm version patch` (or "minor"/"major")

- Push changes to `dev`

- Switch to `master`

- Merge changes from `dev`

- Push `master` with tags

- Switch back to `dev`

After running this, GitHub Actions will automatically publish the new version to npm. It will also create a new GitHub Release draft. Please edit and publish the release manually.

## Contribute

PRs accepted.

Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.

## License

MIT © 2018 Verbundzentrale des GBV (VZG)