cocoda-sdk 3.3.3 → 3.3.4

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

@@ -4,6 +4,9 @@ import * as _ from "../utils/lodash.js";
 import * as errors from "../errors/index.js";
 import { listOfCapabilities } from "../utils/index.js";
 class SkosmosApiProvider extends BaseProvider {
+  /**
+   * @private
+   */
   _prepare() {
     this.has.schemes = true;
     this.has.top = true;
@@ -18,6 +21,14 @@ class SkosmosApiProvider extends BaseProvider {
       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 BARTOC instance
+   * @param {Object} options.scheme scheme for which the config is requested
+   * @returns {Object} provider configuration
+   */
   static _registryConfigForBartocApiConfig({ url, scheme } = {}) {
     if (!url || !scheme) {
       return null;
@@ -32,9 +43,15 @@ class SkosmosApiProvider extends BaseProvider {
     config.schemes = [scheme];
     return config;
   }
+  /**
+   * @private
+   */
   get _language() {
     return this.languages[0] || this._defaultLanguages[0] || "en";
   }
+  /**
+   * @private
+   */
   _getApiUrl(scheme, endpoint, params) {
     const VOCID = scheme && scheme.VOCID || _.get(this.schemes.find((s) => jskos.compare(s, scheme)), "VOCID");
     if (!VOCID) {
@@ -48,6 +65,9 @@ class SkosmosApiProvider extends BaseProvider {
     const paramString = Object.keys(params).map((k) => `${k}=${encodeURIComponent(params[k])}`).join("&");
     return `${this._api.api}${VOCID}${endpoint}${paramString ? "?" + paramString : ""}`;
   }
+  /**
+   * @private
+   */
   _getDataUrl(concept, { addFormatParameter = true } = {}) {
     const scheme = _.get(concept, "inScheme[0]");
     if (!concept || !concept.uri) {
@@ -55,6 +75,11 @@ class SkosmosApiProvider extends BaseProvider {
     }
     return this._getApiUrl(scheme, "/data", addFormatParameter ? { format: "application/json" } : {});
   }
+  /**
+   * Returns the main vocabulary URI by requesting the scheme info and saving it in a cache.
+   *
+   * @private
+   */
   async _getSchemeUri(scheme) {
     this._approvedSchemes = this._approvedSchemes || [];
     this._rejectedSchemes = this._rejectedSchemes || [];
@@ -85,6 +110,9 @@ class SkosmosApiProvider extends BaseProvider {
       return null;
     }
   }
+  /**
+   * @private
+   */
   _toJskosConcept(skosmosConcept, { concept, scheme, result, language } = {}) {
     if (!skosmosConcept) {
       return null;
@@ -157,6 +185,12 @@ class SkosmosApiProvider extends BaseProvider {
     }
     return concept;
   }
+  /**
+   * Returns all concept schemes.
+   *
+   * @param {Object} config
+   * @returns {Object[]} array of JSKOS concept scheme objects
+   */
   async getSchemes({ ...config }) {
     const schemes = [];
     for (let scheme of this.schemes || []) {
@@ -182,6 +216,13 @@ class SkosmosApiProvider extends BaseProvider {
     }
     return schemes;
   }
+  /**
+   * Returns top concepts.
+   *
+   * @param {Object} config
+   * @param {Object} config.scheme concept scheme
+   * @returns {Object[]} array of JSKOS concept scheme objects
+   */
   async getTop({ scheme, ...config }) {
     const url = this._getApiUrl(scheme, "/topConcepts");
     const schemeUri = await this._getSchemeUri(scheme);
@@ -205,6 +246,13 @@ class SkosmosApiProvider extends BaseProvider {
     }
     return concepts;
   }
+  /**
+   * Returns details for a list of concepts.
+   *
+   * @param {Object} config
+   * @param {Object[]} config.concepts list of concept objects to load
+   * @returns {Object[]} array of JSKOS concept objects
+   */
   async getConcepts({ concepts, ...config }) {
     if (!_.isArray(concepts)) {
       concepts = [concepts];
@@ -244,6 +292,13 @@ class SkosmosApiProvider extends BaseProvider {
     }
     return newConcepts;
   }
+  /**
+   * Returns narrower concepts for a concept.
+   *
+   * @param {Object} config
+   * @param {Object} config.concept concept object
+   * @returns {Object[]} array of JSKOS concept objects
+   */
   async getNarrower({ concept, ...config }) {
     if (!concept || !concept.uri) {
       throw new errors.InvalidOrMissingParameterError({ parameter: "concept" });
@@ -259,6 +314,13 @@ class SkosmosApiProvider extends BaseProvider {
     const concepts = (response.narrower || []).map((c) => this._toJskosConcept(c, { scheme }));
     return concepts;
   }
+  /**
+   * Returns ancestor concepts for a concept.
+   *
+   * @param {Object} config
+   * @param {Object} config.concept concept object
+   * @returns {Object[]} array of JSKOS concept objects
+   */
   async getAncestors({ concept, ...config }) {
     if (!concept || !concept.uri) {
       throw new errors.InvalidOrMissingParameterError({ parameter: "concept" });
@@ -283,6 +345,16 @@ class SkosmosApiProvider extends BaseProvider {
     const concepts = ancestors.map((c) => this._toJskosConcept(c, { scheme })).filter((c) => c.uri != concept.uri);
     return concepts;
   }
+  /**
+   * Returns suggestion result in OpenSearch Suggest Format.
+   *
+   * @param {Object} config
+   * @param {string} config.search search string
+   * @param {Object} [config.scheme] concept scheme to search in
+   * @param {number} [config.limit=100] maximum number of search results (default might be overridden by registry)
+   * @param {string[]} [config.types=[]] list of type URIs
+   * @returns {Array} result in OpenSearch Suggest Format
+   */
   async suggest(config) {
     config._raw = true;
     const concepts = await this.search(config);
@@ -301,6 +373,16 @@ class SkosmosApiProvider extends BaseProvider {
     }
     return result;
   }
+  /**
+   * Returns concept search results.
+   *
+   * @param {Object} config
+   * @param {string} config.search search string
+   * @param {Object} [config.scheme] concept scheme to search in
+   * @param {number} [config.limit=100] maximum number of search results (default might be overridden by registry)
+   * @param {string[]} [config.types=[]] list of type URIs
+   * @returns {Array} array of JSKOS concept objects
+   */
   async search({ search, scheme, limit, types = [], ...config }) {
     const url = this._getApiUrl(scheme, "/search");
     _.set(config, "params.query", `${search}*`);
@@ -315,6 +397,13 @@ class SkosmosApiProvider extends BaseProvider {
     const concepts = (response.results || []).map((c) => this._toJskosConcept(c, { scheme }));
     return concepts;
   }
+  /**
+   * Returns a list of types.
+   *
+   * @param {Object} config
+   * @param {Object} [config.scheme] concept scheme to load types for
+   * @returns {Object[]} array of JSKOS type objects
+   */
   async getTypes({ scheme, ...config }) {
     const url = this._getApiUrl(scheme, "/types");
     const types = [];

package/dist/esm/utils/index.js

@@ -1,4 +1,5 @@
 const requestMethods = [
+  // General
   {
     method: "getRegistries",
     fallback: [],
@@ -37,6 +38,7 @@ const requestMethods = [
     fallback: [],
     type: "Occurrences"
   },
+  // Concepts
   {
     method: "getTop",
     fallback: [],
@@ -62,6 +64,7 @@ const requestMethods = [
     fallback: [],
     type: "Concepts"
   },
+  // Mappings
   {
     method: "getMapping",
     fallback: null,
@@ -100,6 +103,11 @@ const requestMethods = [
     method: "deleteMappings",
     fallback: []
   },
+  // Annotations
+  // {
+  //   method: "getAnnotation",
+  //   fallback: "",
+  // },
   {
     method: "getAnnotations",
     fallback: [],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cocoda-sdk",
-  "version": "3.3.3",
+  "version": "3.3.4",
   "description": "SDK for Cocoda",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.js",
@@ -54,11 +54,11 @@
   "devDependencies": {
     "axios-mock-adapter": "^1.21.2",
     "better-docs": "^2.7.2",
-    "esbuild": "~0.14.54",
+    "esbuild": "~0.17.3",
     "esbuild-plugin-ifdef": "^1.0.1",
-    "eslint": "^8.31.0",
+    "eslint": "^8.32.0",
     "eslint-config-gbv": "^1.0.4",
-    "glob": "^8.0.3",
+    "glob": "^8.1.0",
     "jsdoc": "^3.6.11",
     "license-checker": "^25.0.1",
     "lint-staged": "^13.1.0",
@@ -67,7 +67,7 @@
     "pre-commit": "^1.2.2"
   },
   "dependencies": {
-    "axios": "~0.26.1",
+    "axios": "^1.2.3",
     "flexsearch": "~0.6.32",
     "jskos-tools": "^1.0.28",
     "localforage": "^1.10.0",