cocoda-sdk 1.0.13 → 2.0.0

package/providers/mappings-api-provider.js

@@ -1,396 +0,0 @@
-const BaseProvider = require("./base-provider")
-const jskos = require("jskos-tools")
-const _ = require("../utils/lodash")
-const errors = require("../errors")
-const utils = require("../utils")
-
-// TODO: Check capabilities (`this.has`) and authorization (`this.isAuthorizedFor`) before actions.
-
-/**
- * JSKOS Mappings API.
- *
- * This class provides access to concept mappings via JSKOS API in [JSKOS format](https://gbv.github.io/jskos/).
- * See [jskos-server](https://github.com/gbv/jskos-server) for a JSKOS API reference implementation
- *
- * To use it in a registry, specify `provider` as "MappingsApi" and provide the API base URL as `api`:
- * ```json
- * {
- *  "uri": "http://coli-conc.gbv.de/registry/coli-conc-mappings",
- *  "provider": "MappingsApi",
- *  "api": "https://coli-conc.gbv.de/api/"
- * }
- * ```
- *
- * If the `/status` endpoint can be queried, the remaining API methods will be taken from that. As a fallback, the default endpoints will be appended to `api`.
- *
- * Alternatively, you can provide the endpoints separately: `status`, `mappings`, `concordances`, `annotations`
- *
- * Additionally, the following JSKOS properties can be provided: `prefLabel`, `notation`, `definition`
- *
- * @extends BaseProvider
- * @category Providers
- */
-class MappingsApiProvider extends BaseProvider {
-
-  /**
-   * @private
-   */
-  _prepare() {
-    // Set status endpoint only
-    if (this._api.api && this._api.status === undefined) {
-      this._api.status = utils.concatUrl(this._api.api, "/status")
-    }
-  }
-
-  /**
-   * @private
-   */
-  _setup() {
-    // Fill `this._api` if necessary
-    if (this._api.api) {
-      const endpoints = {
-        mappings: "/mappings",
-        concordances: "/concordances",
-        annotations: "/annotations",
-      }
-      for (let key of Object.keys(endpoints)) {
-        if (this._api[key] === undefined) {
-          this._api[key] = utils.concatUrl(this._api.api, endpoints[key])
-        }
-      }
-    }
-    this.has.mappings = this._api.mappings ? {} : false
-    if (this.has.mappings) {
-      this.has.mappings.read = !!_.get(this._config, "mappings.read", true)
-      this.has.mappings.create = !!_.get(this._config, "mappings.create")
-      this.has.mappings.update = !!_.get(this._config, "mappings.update")
-      this.has.mappings.delete = !!_.get(this._config, "mappings.delete")
-      this.has.mappings.anonymous = !!_.get(this._config, "mappings.anonymous")
-    }
-    this.has.concordances = !!this._api.concordances
-    this.has.annotations = this._api.annotations ? {} : false
-    if (this.has.annotations) {
-      this.has.annotations.read = !!_.get(this._config, "annotations.read")
-      this.has.annotations.create = !!_.get(this._config, "annotations.create")
-      this.has.annotations.update = !!_.get(this._config, "annotations.update")
-      this.has.annotations.delete = !!_.get(this._config, "annotations.delete")
-    }
-    this.has.auth = _.get(this._config, "auth.key") != null
-    this._defaultParams = {
-      properties: "annotations",
-    }
-  }
-
-  /**
-   * Returns a single mapping.
-   *
-   * @param {Object} config
-   * @param {Object} config.mapping JSKOS mapping
-   * @returns {Object} JSKOS mapping object
-   */
-  async getMapping({ mapping, ...config }) {
-    if (!mapping) {
-      throw new errors.InvalidOrMissingParameterError({ parameter: "mapping" })
-    }
-    if (!mapping.uri || !mapping.uri.startsWith(this._api.mappings)) {
-      throw new errors.InvalidOrMissingParameterError({ parameter: "mapping", message: "URI doesn't seem to be part of this registry." })
-    }
-    try {
-      return await this.axios({
-        ...config,
-        url: mapping.uri,
-        params: {
-          ...this._defaultParams,
-          ...(config.params || {}),
-        },
-      })
-    } catch (error) {
-      if (_.get(error, "response.status") == 404) {
-        return null
-      }
-      throw error
-    }
-  }
-
-  /**
-   * Returns a list of mappings.
-   *
-   * @param {Object} config request config with parameters
-   * @returns {Object[]} array of JSKOS mapping objects
-   */
-  async getMappings({ from, fromScheme, to, toScheme, creator, type, partOf, offset, limit, direction, mode, identifier, sort, order, ...config }) {
-    let params = {}, url = this._api.mappings
-    if (from) {
-      params.from = _.isString(from) ? from : from.uri
-    }
-    if (fromScheme) {
-      params.fromScheme = _.isString(fromScheme) ? fromScheme : fromScheme.uri
-    }
-    if (to) {
-      params.to = _.isString(to) ? to : to.uri
-    }
-    if (toScheme) {
-      params.toScheme = _.isString(toScheme) ? toScheme : toScheme.uri
-    }
-    if (creator) {
-      params.creator = _.isString(creator) ? creator : jskos.prefLabel(creator)
-    }
-    if (type) {
-      params.type = _.isString(type) ? type : type.uri
-    }
-    if (partOf) {
-      params.partOf = _.isString(partOf) ? partOf : partOf.uri
-    }
-    if (offset) {
-      params.offset = offset
-    }
-    if (limit) {
-      params.limit = limit
-    }
-    if (direction) {
-      params.direction = direction
-    }
-    if (mode) {
-      params.mode = mode
-    }
-    if (identifier) {
-      params.identifier = identifier
-    }
-    if (sort) {
-      params.sort = sort
-    }
-    if (order) {
-      params.order = order
-    }
-    return this.axios({
-      ...config,
-      method: "get",
-      url,
-      params: {
-        ...this._defaultParams,
-        ...(config.params || {}),
-        ...params,
-      },
-    })
-  }
-
-  /**
-   * Creates a mapping.
-   *
-   * @param {Object} config
-   * @param {Object} config.mapping JSKOS mapping
-   * @returns {Object} JSKOS mapping object
-   */
-  async postMapping({ mapping, ...config }) {
-    if (!mapping) {
-      throw new errors.InvalidOrMissingParameterError({ parameter: "mapping" })
-    }
-    mapping = jskos.minifyMapping(mapping)
-    mapping = jskos.addMappingIdentifiers(mapping)
-    return this.axios({
-      ...config,
-      method: "post",
-      url: this._api.mappings,
-      data: mapping,
-      params: {
-        ...this._defaultParams,
-        ...(config.params || {}),
-      },
-    })
-  }
-
-  /**
-   * Overwrites a mapping.
-   *
-   * @param {Object} config
-   * @param {Object} config.mapping JSKOS mapping
-   * @returns {Object} JSKOS mapping object
-   */
-  async putMapping({ mapping, ...config }) {
-    if (!mapping) {
-      throw new errors.InvalidOrMissingParameterError({ parameter: "mapping" })
-    }
-    mapping = jskos.minifyMapping(mapping)
-    mapping = jskos.addMappingIdentifiers(mapping)
-    const uri = mapping.uri
-    if (!uri || !uri.startsWith(this._api.mappings)) {
-      throw new errors.InvalidOrMissingParameterError({ parameter: "mapping", message: "URI doesn't seem to be part of this registry." })
-    }
-    return this.axios({
-      ...config,
-      method: "put",
-      url: uri,
-      data: mapping,
-      params: {
-        ...this._defaultParams,
-        ...(config.params || {}),
-      },
-    })
-  }
-
-  /**
-   * Patches a mapping.
-   *
-   * @param {Object} config
-   * @param {Object} config.mapping JSKOS mapping (or part of mapping)
-   * @returns {Object} JSKOS mapping object
-   */
-  async patchMapping({ mapping, ...config }) {
-    if (!mapping) {
-      throw new errors.InvalidOrMissingParameterError({ parameter: "mapping" })
-    }
-    mapping = jskos.minifyMapping(mapping)
-    mapping = jskos.addMappingIdentifiers(mapping)
-    const uri = mapping.uri
-    if (!uri || !uri.startsWith(this._api.mappings)) {
-      throw new errors.InvalidOrMissingParameterError({ parameter: "mapping", message: "URI doesn't seem to be part of this registry." })
-    }
-    return this.axios({
-      ...config,
-      method: "patch",
-      url: uri,
-      data: mapping,
-      params: {
-        ...this._defaultParams,
-        ...(config.params || {}),
-      },
-    })
-  }
-
-  /**
-   * Deletes a mapping.
-   *
-   * @param {Object} config
-   * @param {Object} config.mapping JSKOS mapping
-   * @returns {boolean} `true` if deletion was successful
-   */
-  async deleteMapping({ mapping, ...config }) {
-    if (!mapping) {
-      throw new errors.InvalidOrMissingParameterError({ parameter: "mapping" })
-    }
-    const uri = mapping.uri
-    if (!uri || !uri.startsWith(this._api.mappings)) {
-      throw new errors.InvalidOrMissingParameterError({ parameter: "mapping", message: "URI doesn't seem to be part of this registry." })
-    }
-    await this.axios({
-      ...config,
-      method: "delete",
-      url: uri,
-    })
-    return true
-  }
-
-  /**
-   * Returns a list of annotations.
-   *
-   * @param {Object} config
-   * @param {string} [config.target] target URI
-   * @returns {Object[]} array of JSKOS annotation objects
-   */
-  async getAnnotations({ target, ...config }) {
-    if (target) {
-      _.set(config, "params.target", target)
-    }
-    return this.axios({
-      ...config,
-      method: "get",
-      url: this._api.annotations,
-    })
-  }
-
-  /**
-   * Creates an annotation.
-   *
-   * @param {Object} config
-   * @param {Object} config.annotation JSKOS annotation
-   * @returns {Object} JSKOS annotation object
-   */
-  async postAnnotation({ annotation, ...config }) {
-    return this.axios({
-      ...config,
-      method: "post",
-      url: this._api.annotations,
-      data: annotation,
-    })
-  }
-
-  /**
-   * Overwrites an annotation.
-   *
-   * @param {Object} config
-   * @param {Object} config.annotation JSKOS annotation
-   * @returns {Object} JSKOS annotation object
-   */
-  async putAnnotation({ annotation, ...config }) {
-    const uri = annotation.id
-    if (!uri || !uri.startsWith(this._api.annotations)) {
-      throw new errors.InvalidOrMissingParameterError({ parameter: "annotation", message: "URI doesn't seem to be part of this registry." })
-    }
-    return this.axios({
-      ...config,
-      method: "put",
-      url: uri,
-      data: annotation,
-    })
-  }
-
-  /**
-   * Patches an annotation.
-   *
-   * @param {Object} config
-   * @param {Object} config.annotation JSKOS annotation
-   * @returns {Object} JSKOS annotation object
-   */
-  async patchAnnotation({ annotation, ...config }) {
-    const uri = annotation.id
-    if (!uri || !uri.startsWith(this._api.annotations)) {
-      throw new errors.InvalidOrMissingParameterError({ parameter: "annotation", message: "URI doesn't seem to be part of this registry." })
-    }
-    return this.axios({
-      ...config,
-      method: "patch",
-      url: uri,
-      data: annotation,
-    })
-  }
-
-  /**
-   * Deletes an annotation.
-   *
-   * @param {Object} config
-   * @param {Object} config.annotation JSKOS annotation
-   * @returns {boolean} `true` if deletion was successful
-   */
-  async deleteAnnotation({ annotation, ...config }) {
-    const uri = annotation.id
-    if (!uri || !uri.startsWith(this._api.annotations)) {
-      throw new errors.InvalidOrMissingParameterError({ parameter: "annotation", message: "URI doesn't seem to be part of this registry." })
-    }
-    await this.axios({
-      ...config,
-      method: "delete",
-      url: uri,
-    })
-    return true
-  }
-
-  /**
-   * Returns a list of concordances.
-   *
-   * @param {Object} config
-   * @returns {Object[]} array of JSKOS concordance objects
-   */
-  async getConcordances(config) {
-    return this.axios({
-      ...config,
-      method: "get",
-      url: this._api.concordances,
-    })
-  }
-
-}
-
-MappingsApiProvider.providerName = "MappingsApi"
-MappingsApiProvider.stored = true
-
-module.exports = MappingsApiProvider

package/providers/occurrences-api-provider.js

@@ -1,234 +0,0 @@
-const BaseProvider = require("./base-provider")
-const jskos = require("jskos-tools")
-const _ = require("../utils/lodash")
-const errors = require("../errors")
-const utils = require("../utils")
-
-// TODO: Modernize.
-
-/**
- * JSKOS Occurrences API.
- *
- * This class provides access to concept occurrences via JSKOS API in [JSKOS format](https://gbv.github.io/jskos/).
- *
- * To use it in a registry, specify `provider` as "OccurrencesApi" and provide the API base URL as `api`:
- * ```json
- * {
- *  "uri": "http://coli-conc.gbv.de/registry/occurrences",
- *  "provider": "OccurrencesApi",
- *  "api": "https://coli-conc.gbv.de/occurrences/api/"
- * }
- * ```
- *
- * Additionally, the following JSKOS properties can be provided: `prefLabel`, `notation`, `definition`
- *
- * @extends BaseProvider
- * @category Providers
- */
-class OccurrencesApiProvider extends BaseProvider {
-
-  /**
-   * @private
-   */
-  _setup() {
-    this._cache = []
-    this._occurrencesSupportedSchemes = []
-    this.has.occurrences = true
-    this.has.mappings = true
-  }
-
-  /**
-   * Returns whether a concept scheme is supported for occurrences.
-   *
-   * @private
-   *
-   * @param {Object} scheme JSKOS scheme to query
-   */
-  async _occurrencesIsSupported(scheme) {
-    if (this._occurrencesSupportedSchemes && this._occurrencesSupportedSchemes.length) {
-      // No action needed
-    } else {
-      // Load supported schemes from API
-      try {
-        const url = utils.concatUrl(this._api.api, "voc")
-        const data = await this.axios({
-          method: "get",
-          url,
-        })
-        this._occurrencesSupportedSchemes = data || []
-      } catch(error) {
-        // Do nothing so that it is tried again next time
-        // TODO: Save number of failures?
-      }
-    }
-    let supported = false
-    for (let supportedScheme of this._occurrencesSupportedSchemes) {
-      if (jskos.compare(scheme, supportedScheme)) {
-        supported = true
-      }
-    }
-    return supported
-  }
-
-  /**
-   * Wrapper around getOccurrences that converts occurrences into mappings.
-   *
-   * @param {Object} config config object for getOccurrences request
-   * @returns {Object[]} array of JSKOS mapping objects
-   */
-  async getMappings(config) {
-    const occurrences = await this.getOccurrences(config)
-    const fromScheme = _.get(config, "from.inScheme[0]") || config.fromScheme
-    const toScheme = _.get(config, "to.inScheme[0]") || config.toScheme
-    const mappings = []
-    // Convert occurrences to mappings
-    for (let occurrence of occurrences) {
-      if (!occurrence) {
-        continue
-      }
-      let mapping = {}
-      mapping.from = _.get(occurrence, "memberSet[0]")
-      if (mapping.from) {
-        mapping.from = { memberSet: [mapping.from] }
-      } else {
-        mapping.from = null
-      }
-      mapping.fromScheme = _.get(occurrence, "memberSet[0].inScheme[0]")
-      mapping.to = _.get(occurrence, "memberSet[1]")
-      if (mapping.to) {
-        mapping.to = { memberSet: [mapping.to] }
-      } else {
-        mapping.to = { memberSet: [] }
-      }
-      mapping.toScheme = _.get(occurrence, "memberSet[1].inScheme[0]")
-      // Swap sides if necessary
-      if ((fromScheme && mapping.fromScheme && !jskos.compare(mapping.fromScheme, fromScheme)) || (toScheme && mapping.toScheme && !jskos.compare(mapping.toScheme, toScheme))) {
-        [mapping.from, mapping.fromScheme, mapping.to, mapping.toScheme] = [mapping.to, mapping.toScheme, mapping.from, mapping.fromScheme]
-      }
-      // Set fromScheme/toScheme if necessary
-      if (!mapping.fromScheme && fromScheme) {
-        mapping.fromScheme = fromScheme
-      }
-      if (!mapping.toScheme && toScheme) {
-        mapping.toScheme = toScheme
-      }
-      mapping.type = [jskos.defaultMappingType.uri]
-      mapping._occurrence = occurrence
-      mapping = jskos.addMappingIdentifiers(mapping)
-      if (occurrence.database) {
-        mapping.creator = [occurrence.database]
-      }
-      mappings.push(mapping)
-    }
-    return mappings
-  }
-
-  /**
-   * Returns a list of occurrences.
-   *
-   * @param {Object} config
-   * @param {Object} [config.from] JSKOS concept to load occurrences for (from side)
-   * @param {Object} [config.to] JSKOS concept to load occurrences for (to side)
-   * @param {Object[]} [config.concepts] list of JSKOS concepts to load occurrences for
-   * @returns {Object[]} array of JSKOS occurrence objects
-   */
-  async getOccurrences({ from, to, concepts, ...config }) {
-    let promises = []
-    concepts = (concepts || []).concat([from, to]).filter(c => !!c)
-    for (let concept of concepts) {
-      promises.push(this._occurrencesIsSupported(_.get(concept, "inScheme[0]")).then(supported => {
-        if (supported && concept.uri) {
-          return concept.uri
-        } else {
-          return null
-        }
-      }))
-    }
-    let uris = await Promise.all(promises)
-    uris = uris.filter(uri => uri != null)
-    if (uris.length == 0) {
-      throw new errors.InvalidOrMissingParameterError({ parameter: "concepts" })
-    }
-    promises = []
-    for (let uri of uris) {
-      promises.push(this._getOccurrences({
-        ...config,
-        params: {
-          member: uri,
-          scheme: "*",
-          threshold: 5,
-        },
-      }))
-    }
-    // Another request for co-occurrences between two specific concepts
-    if (uris.length > 1) {
-      let urisString = uris.join(" ")
-      promises.push(this._getOccurrences({
-        ...config,
-        params: {
-          member: urisString,
-          threshold: 5,
-        },
-      }))
-    }
-    const results = await Promise.all(promises)
-    let occurrences = _.concat([], ...results)
-    // Filter duplicates
-    let existingUris = []
-    let indexesToDelete = []
-    for (let i = 0; i < occurrences.length; i += 1) {
-      let occurrence = occurrences[i]
-      if (!occurrence) {
-        continue
-      }
-      let uris = occurrence.memberSet.reduce((total, current) => total.concat(current.uri), []).sort().join(" ")
-      if (existingUris.includes(uris)) {
-        indexesToDelete.push(i)
-      } else {
-        existingUris.push(uris)
-      }
-    }
-    indexesToDelete.forEach(value => {
-      delete occurrences[value]
-    })
-    // Filter null values
-    occurrences = occurrences.filter(o => o != null)
-    // Sort occurrences
-    return occurrences.sort((a, b) => parseInt(b.count || 0) - parseInt(a.count || 0))
-  }
-
-  /**
-   * Internal function for getOccurrences that either makes an API request or uses a local cache.
-   *
-   * @private
-   *
-   * @param {Object} config passthrough of config parameter for axios request
-   */
-  async _getOccurrences(config) {
-    // Use local cache.
-    let resultsFromCache = this._cache.find(item => {
-      return _.isEqual(item.config.params, config.params)
-    })
-    if (resultsFromCache) {
-      return resultsFromCache.data
-    }
-    const data = await this.axios({
-      ...config,
-      method: "get",
-      url: this._api.api,
-    })
-    this._cache.push({
-      config,
-      data,
-    })
-    if (this._cache.length > 20) {
-      this._cache = this._cache.slice(this._cache.length - 20)
-    }
-    return data
-  }
-}
-
-OccurrencesApiProvider.providerName = "OccurrencesApi"
-OccurrencesApiProvider.stored = false
-
-module.exports = OccurrencesApiProvider