cocoda-sdk 3.6.1 → 3.6.3

package/dist/esm/lib/CocodaSDK.js

@@ -139,24 +139,31 @@ class CocodaSDK {
     });
   }
   /**
-   * Method to get a registry by URI.
+   * Method to get a service by URI.
    *
-   * @param {string} uri URI of registry in config
-   * @returns {?Object} initialized registry from config if found
+   * @param {string} uri URI of service in config
+   * @returns {?Object} initialized service from config if found
    */
-  getRegistryForUri(uri) {
+  getServiceForUri(uri) {
     return this.config.registries.find((r) => r.uri == uri);
   }
+  // alias for backwards compatibility
+  getRegistryForUri(uri) {
+    return this.getRegistryForUri(uri);
+  }
   /**
-   * Method to initialize registry.
+   * Method to initialize service.
    *
-   * @param {Object} registry JSKOS registry object
-   * @returns {Object} initialized registry
+   * @param {Object} service JSKOS service object
+   * @returns {Object} initialized service
    */
-  initializeRegistry(registry) {
-    registry = providers.init(registry);
-    registry.cdk = this;
-    return registry;
+  initializeService(service) {
+    service = providers.init(service);
+    service.cdk = this;
+    return service;
+  }
+  initializeRegistry(service) {
+    return this.initializeService(service);
   }
   /**
    * Method to add custom provider.

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

@@ -50,7 +50,8 @@ class BaseProvider {
       annotations: registry.annotations,
       occurrences: registry.occurrences,
       reconcile: registry.reconcile,
-      api: registry.endpoint || registry.api
+      api: registry.endpoint || registry.api,
+      registries: registry.registries
     };
     this._config = {};
     this.setRetryConfig();
@@ -88,7 +89,7 @@ class BaseProvider {
       }
       return data;
     }, (error) => {
-      const count = error.config._retryCount ?? 0;
+      const count = error.config?._retryCount ?? 0;
       const method = error.config.method;
       const statusCode = error.response?.status;
       if (this._retryConfig.methods.includes(method) && this._retryConfig.statusCodes.includes(statusCode) && count < this._retryConfig.count) {

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

@@ -15,7 +15,8 @@ class ConceptApiProvider extends BaseProvider {
     types: true,
     suggest: true,
     search: true,
-    auth: true
+    auth: true,
+    registries: true
   };
   /**
    * @private
@@ -39,7 +40,8 @@ class ConceptApiProvider extends BaseProvider {
         ancestors: "/ancestors",
         types: "/types",
         suggest: "/suggest",
-        search: "/search"
+        search: "/search",
+        registries: "/registries"
       };
       for (let key of Object.keys(endpoints)) {
         if (this._api[key] === void 0) {
@@ -47,6 +49,7 @@ class ConceptApiProvider extends BaseProvider {
         }
       }
     }
+    this.has.registries = !!this._api.registries;
     this.has.schemes = !!this._api.schemes;
     if (!this.has.schemes && Array.isArray(this.schemes)) {
       this.has.schemes = true;
@@ -114,6 +117,32 @@ class ConceptApiProvider extends BaseProvider {
       return null;
     }
   }
+  /**
+   * Returns all concept registries.
+   *
+   * @param {Object} config
+   * @returns {Object[]} array of JSKOS concept registry objects
+   */
+  async getRegistries(config = {}) {
+    if (!this._api.registries) {
+      if (Array.isArray(this.registries)) {
+        return this.registries;
+      }
+      throw new errors.MissingApiUrlError();
+    }
+    const registries = await this.axios({
+      ...config,
+      method: "get",
+      url: this._api.registries,
+      params: {
+        ...this._defaultParams,
+        // ? What should the default limit be?
+        limit: 500,
+        ...config.params || {}
+      }
+    });
+    return registries;
+  }
   /**
    * Returns all concept schemes.
    *
@@ -190,13 +219,10 @@ class ConceptApiProvider extends BaseProvider {
     if (!url) {
       throw new errors.MissingApiUrlError();
     }
-    if (!concepts) {
-      throw new errors.InvalidOrMissingParameterError({ parameter: "concepts" });
-    }
     if (!Array.isArray(concepts)) {
-      concepts = [concepts];
+      concepts = concepts ? [concepts] : [];
     }
-    let uris = concepts.map((concept) => concept.uri).filter((uri) => uri != null);
+    const uris = concepts.map((concept) => concept.uri).filter((uri) => uri != null);
     return this.axios({
       ...config,
       method: "get",
@@ -204,7 +230,7 @@ class ConceptApiProvider extends BaseProvider {
       params: {
         ...this._defaultParams,
         // ? What should the default limit be?
-        limit: 500,
+        limit: 100,
         ...config.params || {},
         uri: uris.join("|")
       }

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

@@ -16,7 +16,7 @@ class OlsApiProvider extends BaseProvider {
   };
   constructor(config) {
     super(config);
-    this.endpoint = config.endpoint;
+    this.endpoint = config.endpoint || config.uri;
   }
   /**
    * Used by `registryForScheme` (see src/lib/CocodaSDK.js) to determine a provider config for a concept schceme.
@@ -95,7 +95,7 @@ class OlsApiProvider extends BaseProvider {
     }
     if (term["http://www.w3.org/2000/01/rdf-schema#label"]) {
       concept.prefLabel = {};
-      concept.prefLabel[lan] = term["http://www.w3.org/2000/01/rdf-schema#label"];
+      concept.prefLabel[lan] = term["http://www.w3.org/2000/01/rdf-schema#label"].value || term["http://www.w3.org/2000/01/rdf-schema#label"];
     }
     concept.type = [
       "http://www.w3.org/2004/02/skos/core#Concept",
@@ -261,11 +261,8 @@ class OlsApiProvider extends BaseProvider {
   async getTop({ scheme }) {
     const VOCID = await this._getSchemeVOCID(scheme);
     if (VOCID) {
-      let url = this._getApiUrl(["ontologies", VOCID, "classes"], { hasDirectParents: "false" });
-      let response = await this._request(url);
-      if (response?.elements) {
-        return Promise.all(response.elements.map((item) => this._termToJSKOS(item)));
-      }
+      let response = await this._paginate(["ontologies", VOCID, "classes"], { hasDirectParents: "false" }, null);
+      return Promise.all(response.map((item) => this._termToJSKOS(item)));
     }
     return [];
   }
@@ -281,22 +278,16 @@ class OlsApiProvider extends BaseProvider {
   async getNarrower({ concept }) {
     const { VOCID, iri } = await this._splitConcept(concept);
     if (VOCID && iri) {
-      let url = this._getApiUrl(["ontologies", VOCID, "classes", iri, "children"]);
-      let response = await this._request(url);
-      if (response?.elements) {
-        return Promise.all(response.elements.map((item) => this._termToJSKOS(item)));
-      }
+      const items = await this._paginate(["ontologies", VOCID, "classes", iri, "children"], {}, 0);
+      return Promise.all(items.map((item) => this._termToJSKOS(item)));
     }
     return [];
   }
   async getAncestors({ concept }) {
     const { VOCID, iri } = await this._splitConcept(concept);
     if (VOCID && iri) {
-      let url = this._getApiUrl(["ontologies", VOCID, "classes", iri, "ancestors"]);
-      let response = await this._request(url);
-      if (response?.elements) {
-        return Promise.all(response.elements.map((item) => this._termToJSKOS(item)));
-      }
+      let response = await this._paginate(["ontologies", VOCID, "classes", iri, "ancestors"], {}, null);
+      return Promise.all(response.map((item) => this._termToJSKOS(item)));
     }
     return [];
   }

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

@@ -45,7 +45,7 @@ class SkosmosApiProvider extends BaseProvider {
    * @private
    */
   _getApiUrl(scheme, endpoint, params) {
-    const VOCID = scheme && scheme.VOCID || this.schemes.find((s) => jskos.compare(s, scheme))?.VOCID;
+    const VOCID = scheme?.VOCID || this.schemes.find((s) => jskos.compare(s, scheme))?.VOCID;
     if (!VOCID) {
       throw new errors.InvalidOrMissingParameterError({ parameter: "scheme", message: "Missing scheme or VOCID property on scheme" });
     }
@@ -179,6 +179,30 @@ class SkosmosApiProvider extends BaseProvider {
     if (!concept.type.length) {
       concept.type = ["http://www.w3.org/2004/02/skos/core#Concept"];
     }
+    const map = {
+      "skos:definition": "definition",
+      "skos:note": "note",
+      "skos:scopeNote": "scopeNote",
+      "skos:example": "example",
+      "skos:historyNote": "historyNote",
+      "skos:editorialNote": "editorialNote",
+      "skos:changeNote": "changeNote"
+    };
+    for (let key in map) {
+      let notes = skosmosConcept[key] || [];
+      if (!Array.isArray(notes)) {
+        notes = [notes];
+      }
+      if (notes.length) {
+        concept[map[key]] = {};
+        for (const { lang, value } of notes) {
+          if (lang && value) {
+            concept[map[key]][lang] ||= [];
+            concept[map[key]][lang].push(value);
+          }
+        }
+      }
+    }
     return concept;
   }
   /**
@@ -258,20 +282,20 @@ class SkosmosApiProvider extends BaseProvider {
     concepts = concepts.map((c) => ({ uri: c.uri, inScheme: c.inScheme }));
     const newConcepts = [];
     for (let concept of concepts) {
-      const url = this._getDataUrl(concept, { addFormatParameter: false });
+      if (!concept || !concept.uri) {
+        throw new errors.InvalidOrMissingParameterError({ parameter: "concept", message: "Missing concept URI" });
+      }
+      const params = { uri: concept.uri, format: "application/json" };
+      const url = this._getApiUrl(concept?.inScheme?.[0], "/data", params);
       if (!url) {
         continue;
       }
       const result = await this.axios({
         ...config,
         method: "get",
-        url,
-        params: {
-          uri: concept.uri,
-          format: "application/json"
-        }
+        url
       });
-      const resultConcept = result && result.graph && result.graph.find((c) => jskos.compare(c, concept));
+      const resultConcept = result?.graph?.find((c) => jskos.compare(c, concept));
       if (resultConcept) {
         const newConcept = this._toJskosConcept(resultConcept, { concept, result });
         for (let type of ["broader", "narrower"]) {
@@ -385,7 +409,7 @@ class SkosmosApiProvider extends BaseProvider {
       method: "get",
       url
     });
-    for (let type of response && response.types || []) {
+    for (let type of response?.types || []) {
       if (type.uri == "http://www.w3.org/2004/02/skos/core#Concept") {
         continue;
       }

package/dist/esm/utils/index.js

@@ -152,6 +152,7 @@ function withCustomProps(arr, from) {
   return arr;
 }
 const listOfCapabilities = [
+  "registries",
   "schemes",
   "top",
   "data",

package/package.json

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