cocoda-sdk 2.0.13 → 3.0.0

package/dist/esm/lib/CocodaSDK.js

@@ -21,6 +21,7 @@ const providers = {
 };
 providers.addProvider(ConceptApiProvider);
 providers.addProvider(MappingsApiProvider);
+const registryCache = {};
 class CocodaSDK {
   constructor(config) {
     this.config = config;
@@ -173,9 +174,10 @@ class CocodaSDK {
   async getSchemes(config = {}) {
     let schemes = [], promises = [];
     for (let registry of this.config.registries) {
-      if (registry.has.schemes) {
+      if (registry.has.schemes !== false) {
         let promise = registry.getSchemes(config).then((results) => {
           for (let scheme of results) {
+            const currentSchemeRegistry = scheme._registry;
             scheme.__DETAILSLOADED__ = 1;
             scheme.type = scheme.type || ["http://www.w3.org/2004/02/skos/core#ConceptScheme"];
             let otherScheme = schemes.find((s) => jskos.compare(s, scheme)), prio, otherPrio, override = false;
@@ -206,14 +208,14 @@ class CocodaSDK {
                 }
                 scheme = jskos.merge(scheme, _.omit(otherScheme, ["concepts", "topConcepts"]), { mergeUris: true, skipPaths: ["_registry"] });
               }
-              scheme._registry = registry;
+              scheme._registry = currentSchemeRegistry;
               schemes.push(scheme);
             } else {
-              let index = schemes.findIndex((s) => jskos.compare(s, scheme));
+              const index = schemes.findIndex((s) => jskos.compare(s, scheme));
               if (index != -1) {
-                let registry2 = schemes[index]._registry;
+                const otherSchemeRegistry = schemes[index]._registry;
                 schemes[index] = jskos.merge(schemes[index], _.omit(scheme, ["concepts", "topConcepts"]), { mergeUris: true, skipPaths: ["_registry"] });
-                schemes[index]._registry = registry2;
+                schemes[index]._registry = otherSchemeRegistry;
               }
             }
           }
@@ -232,22 +234,34 @@ class CocodaSDK {
       return registry;
     }
     for (let { type, ...config } of scheme.API || []) {
-      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);
-        return registry;
-      } catch (error) {
-        continue;
+      const url = config.url;
+      if (registryCache[url]) {
+        const registry2 = registryCache[url];
+        if (Array.isArray(registry2._jskos.schemes) && !jskos.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;
+          }
+        } catch (error) {
+          continue;
+        }
       }
     }
     return null;

package/dist/esm/providers/base-provider.js

@@ -20,7 +20,7 @@ class BaseProvider {
     this._repeating = [];
     this._api = {
       status: registry.status,
-      schemes: registry.schemes,
+      schemes: Array.isArray(registry.schemes) ? void 0 : registry.schemes,
       top: registry.top,
       data: registry.data,
       concepts: registry.concepts,
@@ -307,7 +307,16 @@ class BaseProvider {
     return registries;
   }
   adjustScheme(scheme) {
-    scheme._registry = this.cdk && this.cdk.registryForScheme(scheme) || this;
+    scheme._registry = this.cdk && this.cdk.registryForScheme(scheme);
+    if (!scheme._registry) {
+      scheme._registry = this;
+    } else {
+      ["concepts", "topConcepts"].forEach((key) => {
+        if (Array.isArray(scheme[key]) && (scheme[key].length === 0 || scheme[key][0] === null)) {
+          delete scheme[key];
+        }
+      });
+    }
     if (scheme._registry) {
       scheme._getTop = (config) => {
         return scheme._registry.getTop({ ...config, scheme });

package/dist/esm/providers/concept-api-provider.js

@@ -18,6 +18,9 @@ class ConceptApiProvider extends BaseProvider {
     this.has.suggest = true;
     this.has.search = true;
     this.has.auth = true;
+    utils.listOfCapabilities.filter((c) => !this.has[c]).forEach((c) => {
+      this.has[c] = false;
+    });
   }
   _setup() {
     if (this._api.api) {
@@ -49,15 +52,16 @@ class ConceptApiProvider extends BaseProvider {
     this.has.search = !!this._api.search;
     this.has.auth = _.get(this._config, "auth.key") != null;
     this._defaultParams = {
-      properties: "uri,prefLabel,notation,inScheme"
+      properties: "+created,issued,modified,editorialNote,scopeNote"
     };
   }
-  static _registryConfigForBartocApiConfig({ url } = {}) {
-    if (!url) {
+  static _registryConfigForBartocApiConfig({ url, scheme } = {}) {
+    if (!url || !scheme) {
       return null;
     }
     return {
-      api: url
+      api: url,
+      schemes: [scheme]
     };
   }
   async _getSchemeUri(scheme) {
@@ -70,7 +74,9 @@ class ConceptApiProvider extends BaseProvider {
     if (this._rejectedSchemes.find((s) => jskos.compare(scheme, s))) {
       return null;
     }
-    const schemes = await this.getSchemes({ uri: jskos.getAllUris(scheme) });
+    const schemes = await this.getSchemes({ params: {
+      uri: jskos.getAllUris(scheme).join("|")
+    } });
     const resultScheme = schemes.find((s) => jskos.compare(s, scheme));
     if (resultScheme) {
       this._approvedSchemes.push({
@@ -90,9 +96,6 @@ class ConceptApiProvider extends BaseProvider {
     if (!this._api.schemes) {
       throw new errors.MissingApiUrlError();
     }
-    if (Array.isArray(this._api.schemes)) {
-      return this._api.schemes;
-    }
     const schemes = await this.axios({
       ...config,
       method: "get",
@@ -103,8 +106,8 @@ class ConceptApiProvider extends BaseProvider {
         ...config.params || {}
       }
     });
-    if (Array.isArray(this._jskos.schemes)) {
-      return utils.withCustomProps(schemes.filter((s) => jskos.isContainedIn(s, this._jskos.schemes)), schemes);
+    if (Array.isArray(this.schemes)) {
+      return utils.withCustomProps(schemes.filter((s) => jskos.isContainedIn(s, this.schemes)), schemes);
     } else {
       return schemes;
     }
@@ -136,7 +139,7 @@ class ConceptApiProvider extends BaseProvider {
     });
   }
   async getConcepts({ concepts, ...config }) {
-    if (!this.has.data) {
+    if (this.has.data === false) {
       throw new errors.MissingApiUrlError();
     }
     if (!concepts) {
@@ -196,26 +199,24 @@ class ConceptApiProvider extends BaseProvider {
       }
     });
   }
-  async suggest({ scheme, use = "notation,label", types = [], sort = "score", ...config }) {
+  async suggest({ use = "notation,label", types = [], sort = "score", ...config }) {
     return this._search({
       ...config,
       endpoint: "suggest",
       params: {
         ...config.params,
-        voc: _.get(scheme, "uri", ""),
         type: types.join("|"),
         use,
         sort
       }
     });
   }
-  async search({ scheme, types = [], ...config }) {
+  async search({ types = [], ...config }) {
     return this._search({
       ...config,
       endpoint: "search",
       params: {
         ...config.params,
-        voc: _.get(scheme, "uri", ""),
         type: types.join("|")
       }
     });
@@ -237,7 +238,7 @@ class ConceptApiProvider extends BaseProvider {
       endpoint: "voc-search"
     });
   }
-  async _search({ endpoint, search, limit, offset, params, ...config }) {
+  async _search({ endpoint, scheme, search, limit, offset, params, ...config }) {
     let url = this._api[endpoint];
     if (!url) {
       throw new errors.MissingApiUrlError();
@@ -247,6 +248,7 @@ class ConceptApiProvider extends BaseProvider {
     }
     limit = limit || this._jskos.suggestResultLimit || 100;
     offset = offset || 0;
+    const voc = scheme && await this._getSchemeUri(scheme);
     url = url.replace("{searchTerms}", search);
     return this.axios({
       ...config,
@@ -257,7 +259,8 @@ class ConceptApiProvider extends BaseProvider {
         count: limit,
         offset,
         search,
-        query: search
+        query: search,
+        voc
       },
       method: "get",
       url

package/dist/esm/providers/label-search-suggestion-provider.js

@@ -1,11 +1,15 @@
 import BaseProvider from "./base-provider.js";
 import jskos from "jskos-tools";
 import * as _ from "../utils/lodash.js";
+import { listOfCapabilities } from "../utils/index.js";
 import * as errors from "../errors/index.js";
 class LabelSearchSuggestionProvider extends BaseProvider {
-  _setup() {
+  _prepare() {
     this._cache = [];
     this.has.mappings = true;
+    listOfCapabilities.filter((c) => !this.has[c]).forEach((c) => {
+      this.has[c] = false;
+    });
   }
   supportsScheme(scheme) {
     return _.get(scheme, "_registry.has.search", false);
@@ -54,6 +58,8 @@ class LabelSearchSuggestionProvider extends BaseProvider {
     if (!label) {
       return [];
     }
+    const regexResult = /^[\s\wäüöÄÜÖß]*\w/.exec(label);
+    label = regexResult ? regexResult[0] : label;
     const results = await this._getResults({ ...config, label, targetScheme, limit });
     let mappings = results.map((result) => ({
       fromScheme: sourceScheme,
@@ -78,7 +84,7 @@ class LabelSearchSuggestionProvider extends BaseProvider {
       return resultsFromCache;
     }
     const registry = _.get(targetScheme, "_registry");
-    if (!registry || !registry.has.search) {
+    if (!registry || registry.has.search === false) {
       return [];
     }
     const data = await registry.search({

package/dist/esm/providers/loc-api-provider.js

@@ -1,5 +1,6 @@
 import BaseProvider from "./base-provider.js";
 import * as errors from "../errors/index.js";
+import { listOfCapabilities } from "../utils/index.js";
 import jskos from "jskos-tools";
 import axios from "axios";
 const locUriPrefix = "http://id.loc.gov/authorities/";
@@ -70,7 +71,7 @@ function madsToJskosConcept(data, { scheme }) {
   return concept;
 }
 class LocApiProvider extends BaseProvider {
-  _setup() {
+  _prepare() {
     this.has.schemes = true;
     this.has.top = false;
     this.has.data = true;
@@ -79,6 +80,9 @@ class LocApiProvider extends BaseProvider {
     this.has.ancestors = false;
     this.has.suggest = true;
     this.has.search = true;
+    listOfCapabilities.filter((c) => !this.has[c]).forEach((c) => {
+      this.has[c] = false;
+    });
   }
   static _registryConfigForBartocApiConfig({ scheme } = {}) {
     if (!scheme || !supportedSchemes.find((s) => jskos.compare(s, scheme))) {

package/dist/esm/providers/local-mappings-provider.js

@@ -4,15 +4,21 @@ import * as _ from "../utils/lodash.js";
 import localforage from "localforage";
 import { v4 as uuid } from "uuid";
 import * as errors from "../errors/index.js";
+import { listOfCapabilities } from "../utils/index.js";
 const uriPrefix = "urn:uuid:";
 class LocalMappingsProvider extends BaseProvider {
-  _setup() {
+  _prepare() {
     this.has.mappings = {
       read: true,
       create: true,
       update: true,
       delete: true
     };
+    listOfCapabilities.filter((c) => !this.has[c]).forEach((c) => {
+      this.has[c] = false;
+    });
+  }
+  _setup() {
     this.queue = [];
     this.localStorageKey = "cocoda-mappings--" + this._path;
     let oldLocalStorageKey = "mappings";

package/dist/esm/providers/mappings-api-provider.js

@@ -8,6 +8,12 @@ class MappingsApiProvider extends BaseProvider {
     if (this._api.api && this._api.status === void 0) {
       this._api.status = utils.concatUrl(this._api.api, "/status");
     }
+    this.has.mappings = true;
+    this.has.concordances = true;
+    this.has.annotations = true;
+    utils.listOfCapabilities.filter((c) => !this.has[c]).forEach((c) => {
+      this.has[c] = false;
+    });
   }
   _setup() {
     if (this._api.api) {

package/dist/esm/providers/occurrences-api-provider.js

@@ -4,11 +4,14 @@ import * as _ from "../utils/lodash.js";
 import * as errors from "../errors/index.js";
 import * as utils from "../utils/index.js";
 class OccurrencesApiProvider extends BaseProvider {
-  _setup() {
+  _prepare() {
     this._cache = [];
     this._occurrencesSupportedSchemes = [];
     this.has.occurrences = true;
     this.has.mappings = true;
+    utils.listOfCapabilities.filter((c) => !this.has[c]).forEach((c) => {
+      this.has[c] = false;
+    });
   }
   async _occurrencesIsSupported(scheme) {
     if (this._occurrencesSupportedSchemes && this._occurrencesSupportedSchemes.length) {

package/dist/esm/providers/reconciliation-api-provider.js

@@ -2,10 +2,14 @@ import BaseProvider from "./base-provider.js";
 import jskos from "jskos-tools";
 import * as _ from "../utils/lodash.js";
 import * as errors from "../errors/index.js";
+import { listOfCapabilities } from "../utils/index.js";
 class ReconciliationApiProvider extends BaseProvider {
-  _setup() {
-    this.has.mappings = true;
+  _prepare() {
     this._cache = [];
+    this.has.mappings = true;
+    listOfCapabilities.filter((c) => !this.has[c]).forEach((c) => {
+      this.has[c] = false;
+    });
   }
   async getMappings({ from, to, mode, ...config }) {
     let schemes = [];

package/dist/esm/providers/skosmos-api-provider.js

@@ -2,8 +2,9 @@ import BaseProvider from "./base-provider.js";
 import jskos from "jskos-tools";
 import * as _ from "../utils/lodash.js";
 import * as errors from "../errors/index.js";
+import { listOfCapabilities } from "../utils/index.js";
 class SkosmosApiProvider extends BaseProvider {
-  _setup() {
+  _prepare() {
     this.has.schemes = true;
     this.has.top = true;
     this.has.data = true;
@@ -13,6 +14,9 @@ class SkosmosApiProvider extends BaseProvider {
     this.has.types = true;
     this.has.suggest = true;
     this.has.search = true;
+    listOfCapabilities.filter((c) => !this.has[c]).forEach((c) => {
+      this.has[c] = false;
+    });
   }
   static _registryConfigForBartocApiConfig({ url, scheme } = {}) {
     if (!url || !scheme) {

package/dist/esm/utils/index.js

@@ -143,8 +143,25 @@ function withCustomProps(arr, from) {
   arr._url = from._url;
   return arr;
 }
+const listOfCapabilities = [
+  "schemes",
+  "top",
+  "data",
+  "concepts",
+  "narrower",
+  "ancestors",
+  "types",
+  "suggest",
+  "search",
+  "auth",
+  "mappings",
+  "concordances",
+  "annotations",
+  "occurrences"
+];
 export {
   concatUrl,
+  listOfCapabilities,
   requestMethods,
   withCustomProps
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cocoda-sdk",
-  "version": "2.0.13",
+  "version": "3.0.0",
   "description": "SDK for Cocoda",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.js",