cocoda-sdk 3.3.4 → 3.4.1

package/README.md

@@ -1,5 +1,5 @@
 # Cocoda SDK
-![Node.js CI](https://github.com/gbv/cocoda-sdk/workflows/Node.js%20CI/badge.svg)
+[![Test and build](https://github.com/gbv/cocoda-sdk/actions/workflows/test-and-build.yml/badge.svg)](https://github.com/gbv/cocoda-sdk/actions/workflows/test-and-build.yml)
 [![GitHub package version](https://img.shields.io/github/package-json/v/gbv/cocoda-sdk.svg?label=version)](https://github.com/gbv/cocoda-sdk)
 [![NPM package name](https://img.shields.io/badge/npm-cocoda--sdk-blue.svg)](https://www.npmjs.com/package/cocoda-sdk)
 [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg)](https://github.com/RichardLitt/standard-readme)
@@ -167,6 +167,8 @@ The following providers are also exported, but have to be added via `cdk.addProv
   - **This integration is currently experimental and only supports LCSH and LCNAF.**
 - `Skohub` - access to concept schemes and concepts via a [SkoHub Vocabs](https://blog.lobid.org/2019/09/27/presenting-skohub-vocabs.html)
   - **This integration is currently experimental. Only vocabularies that use a [slash namespace pattern]([hash](https://www.w3.org/2001/sw/BestPractices/VM/http-examples/2006-01-18/#slash)) with dereferenceable URIs are supported.**
+- `LobidApi` - access to GND via [lobid](https://lobid.org)
+  - **This integration is currently experimental.**
 - `MyCoRe` - access to vocabularies via [MyCoRe](https://www.mycore.de/)
   - **This integration is currently experimental. Only one vocabulary per registry is supported. Not recommended for large vocabularies as all of the vocabulary data is loaded and kept in memory.**
 - `ReconciliationApi` - access to mapping suggestions via a [OpenRefine Reconciliation API](https://github.com/OpenRefine/OpenRefine/wiki/Reconciliation-Service-API)

package/dist/cjs/index.cjs

@@ -33,6 +33,7 @@ __export(src_exports, {
   CocodaSDK: () => CocodaSDK,
   ConceptApiProvider: () => ConceptApiProvider,
   LabelSearchSuggestionProvider: () => LabelSearchSuggestionProvider,
+  LobidApiProvider: () => LobidApiProvider,
   LocApiProvider: () => LocApiProvider,
   LocalMappingsProvider: () => LocalMappingsProvider,
   MappingsApiProvider: () => MappingsApiProvider,
@@ -120,7 +121,7 @@ var InvalidProviderError = class extends CDKError {
 };
 
 // src/lib/CocodaSDK.js
-var import_axios3 = __toESM(require("axios"), 1);
+var import_axios4 = __toESM(require("axios"), 1);
 
 // src/utils/lodash.js
 var import_get = __toESM(require("lodash/get.js"), 1);
@@ -140,7 +141,7 @@ var import_omit = __toESM(require("lodash/omit.js"), 1);
 var import_concat = __toESM(require("lodash/concat.js"), 1);
 
 // src/lib/CocodaSDK.js
-var import_jskos_tools12 = __toESM(require("jskos-tools"), 1);
+var import_jskos_tools13 = __toESM(require("jskos-tools"), 1);
 
 // src/providers/index.js
 var providers_exports = {};
@@ -148,6 +149,7 @@ __export(providers_exports, {
   BaseProvider: () => BaseProvider,
   ConceptApiProvider: () => ConceptApiProvider,
   LabelSearchSuggestionProvider: () => LabelSearchSuggestionProvider,
+  LobidApiProvider: () => LobidApiProvider,
   LocApiProvider: () => LocApiProvider,
   LocalMappingsProvider: () => LocalMappingsProvider,
   MappingsApiProvider: () => MappingsApiProvider,
@@ -1122,7 +1124,7 @@ var LocalMappingsProvider = class extends BaseProvider {
       throw new InvalidOrMissingParameterError({ parameter: "mapping", message: "Duplicate URI" });
     }
     if (!mapping.created) {
-      mapping.created = new Date().toISOString();
+      mapping.created = (/* @__PURE__ */ new Date()).toISOString();
     }
     if (!mapping.modified) {
       mapping.modified = mapping.created;
@@ -1158,7 +1160,7 @@ var LocalMappingsProvider = class extends BaseProvider {
     if (!mapping.created) {
       mapping.created = localMappings[index].created;
     }
-    mapping.modified = new Date().toISOString();
+    mapping.modified = (/* @__PURE__ */ new Date()).toISOString();
     localMappings[index] = mapping;
     localMappings = localMappings.map((mapping2) => import_jskos_tools2.default.minifyMapping(mapping2));
     try {
@@ -1190,7 +1192,7 @@ var LocalMappingsProvider = class extends BaseProvider {
     if (!mapping.created) {
       mapping.created = localMappings[index].created;
     }
-    mapping.modified = new Date().toISOString();
+    mapping.modified = (/* @__PURE__ */ new Date()).toISOString();
     localMappings[index] = Object.assign(localMappings[index], mapping);
     localMappings = localMappings.map((mapping2) => import_jskos_tools2.default.minifyMapping(mapping2));
     try {
@@ -2273,11 +2275,15 @@ var ConceptApiProvider = class extends BaseProvider {
     if (schemeUri) {
       import_set.default(config, "params.uri", schemeUri);
     }
-    return this.axios({
+    let types = await this.axios({
       ...config,
       method: "get",
       url: this._api.types
     });
+    if (schemeUri) {
+      types = types.filter((type) => !type.inScheme || import_jskos_tools5.default.isContainedIn(scheme, type.inScheme));
+    }
+    return types;
   }
 };
 ConceptApiProvider.providerName = "ConceptApi";
@@ -3536,8 +3542,243 @@ var SkohubProvider = class extends BaseProvider {
 SkohubProvider.providerName = "Skohub";
 SkohubProvider.providerType = "http://bartoc.org/api-type/skohub";
 
-// src/providers/mycore-provider.js
+// src/providers/lobid-api-provider.js
 var import_jskos_tools11 = __toESM(require("jskos-tools"), 1);
+var import_axios3 = __toESM(require("axios"), 1);
+var gndJson = {
+  uri: "http://bartoc.org/en/node/430",
+  concepts: [
+    null
+  ],
+  topConcepts: [],
+  type: [
+    "http://www.w3.org/2004/02/skos/core#ConceptScheme"
+  ],
+  DISPLAY: {
+    hideNotation: true
+  },
+  identifier: [
+    "http://www.wikidata.org/entity/Q36578"
+  ],
+  license: [
+    {
+      uri: "http://creativecommons.org/publicdomain/zero/1.0/"
+    }
+  ],
+  namespace: "https://d-nb.info/gnd/",
+  notation: [
+    "GND"
+  ],
+  notationPattern: "[0-9X-]+",
+  prefLabel: {
+    de: "Gemeinsame Normdatei",
+    en: "Integrated Authority File"
+  },
+  types: [
+    {
+      uri: "https://d-nb.info/standards/elementset/gnd#DifferentiatedPerson",
+      prefLabel: {
+        de: "Person",
+        en: "Person"
+      }
+    },
+    {
+      uri: "https://d-nb.info/standards/elementset/gnd#PlaceOrGeographicName",
+      prefLabel: {
+        de: "Geografikum",
+        en: "Place"
+      }
+    },
+    {
+      uri: "https://d-nb.info/standards/elementset/gnd#CorporateBody",
+      prefLabel: {
+        de: "Organisation",
+        en: "Organization"
+      }
+    },
+    {
+      uri: "https://d-nb.info/standards/elementset/gnd#SubjectHeading",
+      prefLabel: {
+        de: "Sachbegriff",
+        en: "Subject"
+      }
+    },
+    {
+      uri: "https://d-nb.info/standards/elementset/gnd#Work",
+      prefLabel: {
+        de: "Werk",
+        en: "Work"
+      }
+    },
+    {
+      uri: "https://d-nb.info/standards/elementset/gnd#ConferenceOrEvent",
+      prefLabel: {
+        de: "Konferenz oder Veranstaltung",
+        en: "ConferenceOrEvent"
+      }
+    }
+  ]
+};
+var gndTypeScheme = new import_jskos_tools11.default.ConceptScheme({
+  uri: "https://d-nb.info/standards/elementset/gnd",
+  namespace: "https://d-nb.info/standards/elementset/gnd#"
+});
+gndJson.types.forEach((type) => {
+  type.notation = [gndTypeScheme.notationFromUri(type.uri)];
+});
+var gnd = new import_jskos_tools11.default.ConceptScheme(gndJson);
+var broaderProps = [
+  "broaderTerm",
+  "broaderTermGeneral",
+  "broaderTermGeneric",
+  "broaderTermInstantial",
+  "broaderTermPartitive"
+];
+function toJSKOS(data3) {
+  const concept = {
+    uri: data3.id,
+    notation: [data3.gndIdentifier],
+    prefLabel: { de: data3.preferredName },
+    inScheme: [{ uri: gndJson.uri }]
+  };
+  if (data3.variantName) {
+    concept.altLabel = { de: data3.variantName };
+  }
+  concept.type = data3.type.map((type) => gndTypeScheme.uriFromNotation(type)).filter(Boolean);
+  concept.broader = [];
+  broaderProps.forEach((prop) => {
+    concept.broader = concept.broader.concat(data3[prop] || []);
+  });
+  concept.broader = concept.broader.map((broader) => ({ uri: broader.id }));
+  concept.identifier = [concept.uri.replace("https://", "http://")];
+  return concept;
+}
+function fixURI(uri) {
+  if (uri && uri.startsWith("http://")) {
+    return uri.replace("http://", "https://");
+  }
+  return uri;
+}
+var LobidApiProvider = class extends BaseProvider {
+  _prepare() {
+    this.has.schemes = true;
+    this.has.data = true;
+    this.has.concepts = true;
+    this.has.narrower = true;
+    this.has.suggest = true;
+    this.has.search = true;
+    this.has.types = true;
+    listOfCapabilities.filter((c) => !this.has[c]).forEach((c) => {
+      this.has[c] = false;
+    });
+  }
+  /**
+   * Used by `registryForScheme` (see src/lib/CocodaSDK.js) to determine a provider config for a concept schceme.
+   *
+   * @param {Object} options
+   * @param {Object} options.url API URL for server
+   * @returns {Object} provider configuration
+   */
+  static _registryConfigForBartocApiConfig({ url, scheme } = {}) {
+    if (!url || !scheme || !import_jskos_tools11.default.compare(scheme, gndJson) || url !== "https://lobid.org/gnd/api") {
+      return null;
+    }
+    return {
+      api: "https://lobid.org/gnd/",
+      schemes: [gndJson]
+    };
+  }
+  async getSchemes() {
+    return [gndJson];
+  }
+  async getTop() {
+    return [];
+  }
+  async getConcepts({ concepts }) {
+    if (!concepts) {
+      throw new errors.InvalidOrMissingParameterError({ parameter: "concepts" });
+    }
+    if (!Array.isArray(concepts)) {
+      concepts = [concepts];
+    }
+    const notations = concepts.map((concept) => {
+      if (concept?.notation?.[0]) {
+        return concept?.notation?.[0];
+      }
+      return gnd.notationFromUri(fixURI(concept?.uri));
+    }).filter(Boolean);
+    const errors = [];
+    const results = await Promise.all(notations.map(async (notation) => {
+      try {
+        const result = await import_axios3.default.get(`${this._api.api}${notation}.json`);
+        return toJSKOS(result.data);
+      } catch (error) {
+        errors.push(error);
+      }
+    }));
+    if (errors.length === concepts.length) {
+      throw errors[0];
+    }
+    return results.filter(Boolean);
+  }
+  async getNarrower({ concept, limit = 200, offset = 0 }) {
+    if (!concept || !concept.uri) {
+      throw new InvalidOrMissingParameterError({ parameter: "concept" });
+    }
+    const uri = fixURI(concept.uri);
+    const q = broaderProps.map((prop) => `${prop}.id:"${uri}"`).join(" OR ");
+    const result = await import_axios3.default.get(`${this._api.api}search`, {
+      params: {
+        q,
+        format: "json",
+        size: limit,
+        from: offset
+      }
+    });
+    return result.data.member.map((member) => toJSKOS(member));
+  }
+  async suggest(config) {
+    const results = await this._search({ ...config, format: "json:suggest" });
+    return [
+      config.search,
+      results.map((r) => r.label),
+      [],
+      results.map((r) => r.id)
+    ];
+  }
+  async search(config) {
+    const results = await this._search(config);
+    return results.member.map((member) => toJSKOS(member));
+  }
+  async _search({ search, types, limit = 100, offset = 0, format = "json" }) {
+    if (!search) {
+      throw new InvalidOrMissingParameterError({ parameter: "search" });
+    }
+    let filter = "";
+    types = types?.map((type) => gndTypeScheme.notationFromUri(fixURI(type))).filter(Boolean) || [];
+    if (types.length) {
+      filter = types.map((type) => `type:${type}`).join(" OR ");
+    }
+    const results = await import_axios3.default.get(`${this._api.api}search`, { params: {
+      q: search,
+      filter,
+      format,
+      size: limit,
+      from: offset
+    } });
+    return results.data;
+  }
+  async getTypes({ scheme }) {
+    if (!scheme || !import_jskos_tools11.default.compare(scheme, gndJson)) {
+      throw new InvalidOrMissingParameterError({ parameter: "search", message: scheme?.uri ? `scheme ${scheme?.uri} not supported` : "" });
+    }
+    return gndJson.types;
+  }
+};
+LobidApiProvider.providerName = "LobidApi";
+
+// src/providers/mycore-provider.js
+var import_jskos_tools12 = __toESM(require("jskos-tools"), 1);
 var import_flexsearch2 = __toESM(require("flexsearch"), 1);
 var data2 = {};
 var MyCoReProvider = class extends BaseProvider {
@@ -3686,7 +3927,7 @@ var MyCoReProvider = class extends BaseProvider {
     if (!this._scheme) {
       await this.getSchemes(config);
     }
-    if (!import_jskos_tools11.default.compare(scheme, this._scheme)) {
+    if (!import_jskos_tools12.default.compare(scheme, this._scheme)) {
       throw new InvalidOrMissingParameterError({ parameter: "scheme", message: "Requested vocabulary seems to be unsupported by this API." });
     }
     return data2[this._scheme.uri].topConcepts.map(this._removeNarrower);
@@ -3752,7 +3993,7 @@ var MyCoReProvider = class extends BaseProvider {
     if (!this._scheme) {
       await this.getSchemes();
     }
-    if (!import_jskos_tools11.default.compare(scheme, this._scheme)) {
+    if (!import_jskos_tools12.default.compare(scheme, this._scheme)) {
       throw new InvalidOrMissingParameterError({ parameter: "scheme", message: "Requested vocabulary seems to be unsupported by this API." });
     }
     const result = await data2[this._scheme.uri].searchIndex.search(search);
@@ -3772,8 +4013,8 @@ var MyCoReProvider = class extends BaseProvider {
     const concepts = await this.search(config);
     const result = [config.search, [], [], []];
     for (let concept of concepts) {
-      const notation = import_jskos_tools11.default.notation(concept);
-      const label = import_jskos_tools11.default.prefLabel(concept);
+      const notation = import_jskos_tools12.default.notation(concept);
+      const label = import_jskos_tools12.default.prefLabel(concept);
       result[1].push((notation ? notation + " " : "") + label);
       result[2].push("");
       result[3].push(concept.uri);
@@ -3817,7 +4058,7 @@ var CocodaSDK = class {
    */
   constructor(config) {
     this.config = config;
-    this.axios = import_axios3.default.create();
+    this.axios = import_axios4.default.create();
   }
   /**
    * Method to set the configuration.
@@ -4073,7 +4314,7 @@ var CocodaSDK = class {
             scheme._registry = registry;
             scheme.__DETAILSLOADED__ = 1;
             scheme.type = scheme.type || ["http://www.w3.org/2004/02/skos/core#ConceptScheme"];
-            let otherScheme = schemes.find((s) => import_jskos_tools12.default.compare(s, scheme)), prio, otherPrio, override = false;
+            let otherScheme = schemes.find((s) => import_jskos_tools13.default.compare(s, scheme)), prio, otherPrio, override = false;
             if (otherScheme) {
               prio = this.config.registries.indexOf(registry);
               if (prio != -1) {
@@ -4095,19 +4336,19 @@ var CocodaSDK = class {
             }
             if (!otherScheme || override) {
               if (override) {
-                let otherSchemeIndex = schemes.findIndex((s) => import_jskos_tools12.default.compare(s, otherScheme));
+                let otherSchemeIndex = schemes.findIndex((s) => import_jskos_tools13.default.compare(s, otherScheme));
                 if (otherSchemeIndex != -1) {
                   schemes.splice(otherSchemeIndex, 1);
                 }
-                scheme = import_jskos_tools12.default.merge(scheme, import_omit.default(otherScheme, ["concepts", "topConcepts"]), { mergeUris: true, skipPaths: ["_registry"] });
+                scheme = import_jskos_tools13.default.merge(scheme, import_omit.default(otherScheme, ["concepts", "topConcepts"]), { mergeUris: true, skipPaths: ["_registry"] });
               }
               scheme._registry = registry;
               schemes.push(scheme);
             } else {
-              const index = schemes.findIndex((s) => import_jskos_tools12.default.compare(s, scheme));
+              const index = schemes.findIndex((s) => import_jskos_tools13.default.compare(s, scheme));
               if (index != -1) {
                 const otherSchemeRegistry = schemes[index]._registry;
-                schemes[index] = import_jskos_tools12.default.merge(schemes[index], import_omit.default(scheme, ["concepts", "topConcepts"]), { mergeUris: true, skipPaths: ["_registry"] });
+                schemes[index] = import_jskos_tools13.default.merge(schemes[index], import_omit.default(scheme, ["concepts", "topConcepts"]), { mergeUris: true, skipPaths: ["_registry"] });
                 schemes[index]._registry = otherSchemeRegistry;
               }
             }
@@ -4129,7 +4370,7 @@ var CocodaSDK = class {
         scheme._registry = newRegistry;
       }
     });
-    return import_jskos_tools12.default.sortSchemes(schemes.filter(Boolean));
+    return import_jskos_tools13.default.sortSchemes(schemes.filter(Boolean));
   }
   registryForScheme(scheme) {
     let registry = scheme._registry;
@@ -4140,30 +4381,34 @@ var CocodaSDK = class {
       const url = config.url;
       if (registryCache[url]) {
         const registry2 = registryCache[url];
-        if (Array.isArray(registry2._jskos.schemes) && !import_jskos_tools12.default.isContainedIn(scheme, registry2._jskos.schemes)) {
+        if (Array.isArray(registry2._jskos.schemes) && !import_jskos_tools13.default.isContainedIn(scheme, registry2._jskos.schemes)) {
           registry2._jskos.schemes.push(scheme);
         }
         return registry2;
       } else {
-        const provider = Object.values(providers).find((p) => p.providerType === type);
-        if (!provider || !provider._registryConfigForBartocApiConfig) {
-          continue;
-        }
-        const providerName = provider.providerName;
         config.scheme = scheme;
-        config = providers[providerName]._registryConfigForBartocApiConfig(config);
-        if (!config) {
-          continue;
-        }
-        config.provider = providerName;
-        try {
-          registry = this.initializeRegistry(config);
-          if (registry) {
-            registryCache[url] = registry;
-            return registry;
+        for (const provider of Object.values(providers)) {
+          if (provider.providerType && provider.providerType !== type) {
+            continue;
+          }
+          if (!provider._registryConfigForBartocApiConfig) {
+            continue;
+          }
+          const providerName = provider.providerName;
+          const registryConfig = providers[providerName]._registryConfigForBartocApiConfig(config);
+          if (!registryConfig) {
+            continue;
+          }
+          registryConfig.provider = providerName;
+          try {
+            registry = this.initializeRegistry(registryConfig);
+            if (registry) {
+              registryCache[url] = registry;
+              return registry;
+            }
+          } catch (error) {
+            continue;
           }
-        } catch (error) {
-          continue;
         }
       }
     }
@@ -4182,6 +4427,7 @@ function addAllProviders(_cdk) {
   CocodaSDK,
   ConceptApiProvider,
   LabelSearchSuggestionProvider,
+  LobidApiProvider,
   LocApiProvider,
   LocalMappingsProvider,
   MappingsApiProvider,