cocoda-sdk 3.3.3 → 3.3.4

package/dist/cjs/index.cjs

@@ -17,6 +17,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
@@ -58,6 +62,14 @@ __export(errors_exports, {
   NetworkError: () => NetworkError
 });
 var CDKError = class extends Error {
+  /**
+   * CDKError constructor.
+   *
+   * @param {Object} options
+   * @param {string} [options.message=""] message for the error
+   * @param {Error} [options.relatedError=null] related error
+   * @param {number} [options.code] HTTP status code for the error
+   */
   constructor({ message = "", relatedError = null, code = null } = {}) {
     if (!message && relatedError && relatedError.message) {
       message = relatedError.message;
@@ -69,12 +81,26 @@ var CDKError = class extends Error {
   }
 };
 var MethodNotImplementedError = class extends CDKError {
+  /**
+   * MethodNotImplementedError constructor.
+   *
+   * @param {Object} config
+   * @param {string} config.method method that this error refers to
+   * @param {string} [config.message=""] message for the error
+   */
   constructor({ method, message = "", ...options }) {
     options.message = `Method not implemented: ${method} (${message})`;
     super(options);
   }
 };
 var InvalidOrMissingParameterError = class extends CDKError {
+  /**
+   * InvalidOrMissingParameterError constructor.
+   *
+   * @param {Object} config
+   * @param {string} config.parameter parameter that this error refers to
+   * @param {string} [config.message=""] message for the error
+   */
   constructor({ parameter, message = "", ...options }) {
     options.message = `Invalid or missing parameter: ${parameter} (${message})`;
     super(options);
@@ -145,6 +171,7 @@ __export(utils_exports, {
   withCustomProps: () => withCustomProps
 });
 var requestMethods = [
+  // General
   {
     method: "getRegistries",
     fallback: [],
@@ -183,6 +210,7 @@ var requestMethods = [
     fallback: [],
     type: "Occurrences"
   },
+  // Concepts
   {
     method: "getTop",
     fallback: [],
@@ -208,6 +236,7 @@ var requestMethods = [
     fallback: [],
     type: "Concepts"
   },
+  // Mappings
   {
     method: "getMapping",
     fallback: null,
@@ -246,6 +275,11 @@ var requestMethods = [
     method: "deleteMappings",
     fallback: []
   },
+  // Annotations
+  // {
+  //   method: "getAnnotation",
+  //   fallback: "",
+  // },
   {
     method: "getAnnotations",
     fallback: [],
@@ -308,9 +342,15 @@ var listOfCapabilities = [
 
 // src/providers/base-provider.js
 var BaseProvider = class {
+  /**
+   * Provider constructor.
+   *
+   * @param {Object} registry the registry for this provider
+   */
   constructor(registry = {}) {
     this._jskos = registry;
     this.axios = import_axios.default.create({
+      // TODO: Decide on timeout value
       timeout: 2e4
     });
     this._path = typeof window !== "undefined" && window.location.pathname;
@@ -324,6 +364,7 @@ var BaseProvider = class {
     this._repeating = [];
     this._api = {
       status: registry.status,
+      // If `schemes` on registry is an array, remove it because we're only keeping it in this._jskos.schemes
       schemes: Array.isArray(registry.schemes) ? void 0 : registry.schemes,
       top: registry.top,
       data: registry.data,
@@ -469,6 +510,7 @@ var BaseProvider = class {
       };
     }
   }
+  // Expose some properties from original registry object as getters
   get uri() {
     return this._jskos.uri;
   }
@@ -490,6 +532,11 @@ var BaseProvider = class {
   get stored() {
     return this._jskos.stored !== void 0 ? this._jskos.stored : this.constructor.stored;
   }
+  /**
+   * Load data about registry via the status endpoint.
+   *
+   * @returns {Promise} Promise that resolves when initialization is complete.
+   */
   async init() {
     if (this._init) {
       return this._init;
@@ -523,17 +570,48 @@ var BaseProvider = class {
     })();
     return this._init;
   }
+  /**
+   * Preparation to be executed before init. Should be overwritten by subclasses.
+   *
+   * @private
+   */
   _prepare() {
   }
+  /**
+   * Setup to be executed after init. Should be overwritten by subclasses.
+   *
+   * @private
+   */
   _setup() {
   }
+  /**
+   * Returns a source for a axios cancel token.
+   *
+   * @returns {Object} axios cancel token source
+   */
   getCancelTokenSource() {
     return import_axios.default.CancelToken.source();
   }
+  /**
+   * Sets authentication credentials.
+   *
+   * @param {Object} options
+   * @param {string} options.key public key of login-server instance the user is authorized for
+   * @param {string} options.bearerToken token that is sent with each request
+   */
   setAuth({ key = this._auth.key, bearerToken = this._auth.bearerToken }) {
     this._auth.key = key;
     this._auth.bearerToken = bearerToken;
   }
+  /**
+   * Sets retry configuration.
+   *
+   * @param {Object} config
+   * @param {string[]} [config.methods=["get", "head", "options"]] HTTP methods to retry (lowercase)
+   * @param {number[]} [config.statusCodes=[401, 403]] status codes to retry
+   * @param {number} [config.count=3] maximum number of retries
+   * @param {number|Function} [config.delay=300*count] a delay in ms or a function that takes the number of current retries and returns a delay in ms
+   */
   setRetryConfig(config = {}) {
     this._retryConfig = Object.assign({
       methods: ["get", "head", "options"],
@@ -544,6 +622,16 @@ var BaseProvider = class {
       }
     }, config);
   }
+  /**
+   * Returns whether a user is authorized for a certain request.
+   *
+   * @param {Object} options
+   * @param {string} options.type type of item (e.g. mappings)
+   * @param {string} options.action action to be performed (read/create/update/delete)
+   * @param {Object} options.user user object
+   * @param {boolean} [options.crossUser] whether the request is a crossUser request (i.e. updading/deleting another user's item)
+   * @returns {boolean}
+   */
   isAuthorizedFor({ type, action, user, crossUser }) {
     if (action == "read" && this.has[type] === true) {
       return true;
@@ -578,6 +666,12 @@ var BaseProvider = class {
     }
     return !!this.has[type][action];
   }
+  /**
+   * Returns a boolean whether a certain target scheme is supported or not.
+   *
+   * @param {Object} scheme
+   * @returns {boolean}
+   */
   supportsScheme(scheme) {
     if (!scheme) {
       return false;
@@ -671,6 +765,13 @@ var BaseProvider = class {
   adjustMappings(mappings) {
     return withCustomProps(mappings.map((mapping) => this.adjustMapping(mapping)), mappings);
   }
+  /**
+   * POSTs multiple mappings. Do not override in subclass!
+   *
+   * @param {Object} config
+   * @param {Array} config.mappings array of mapping objects
+   * @returns {Object[]} array of created mapping objects; in case of failure, consult the `_errors` property on the array at the index of the failed request
+   */
   async postMappings({ mappings, ...config } = {}) {
     if (!mappings || !mappings.length) {
       throw new InvalidOrMissingParameterError({ parameter: "mappings" });
@@ -682,6 +783,13 @@ var BaseProvider = class {
       config
     });
   }
+  /**
+   * DELETEs multiple mappings. Do not override in subclass!
+   *
+   * @param {Object} config
+   * @param {Array} config.mappings array of mapping objects
+   * @returns {Object[]} array of results (`true` if successful); in case of failure, consult the `_errors` property on the array at the index of the failed request
+   */
   async deleteMappings({ mappings, ...config } = {}) {
     if (!mappings || !mappings.length) {
       throw new InvalidOrMissingParameterError({ parameter: "mappings" });
@@ -693,6 +801,20 @@ var BaseProvider = class {
       config
     });
   }
+  /**
+   * Calls a method that is for only one item for an array of items. Returns an array of results.
+   *
+   * If there is an error, that index in the result array will be `null`. There is a property `_errors` on the result array that will contain the respective error at the correct index.
+   *
+   * @param {Object} options
+   * @param {string} options.method instance method to call (e.g. `postMapping`)
+   * @param {Object[]} options.items items to call the method for
+   * @param {string} options.itemProperty the property name for the item when calling the method (e.g. `mapping`)
+   * @param {Object} options.config other properties to pass to the method call
+   * @returns {any[]} result array with values returned from individual method calls
+   *
+   * @private
+   */
   async _callHelperForArrayWrappers({ method, items, itemProperty, config }) {
     const errors = [];
     const resultItems = await Promise.all(items.map(async (item) => {
@@ -716,6 +838,9 @@ var import_localforage = __toESM(require("localforage"), 1);
 var import_uuid = require("uuid");
 var uriPrefix = "urn:uuid:";
 var LocalMappingsProvider = class extends BaseProvider {
+  /**
+   * @private
+   */
   _prepare() {
     this.has.mappings = {
       read: true,
@@ -727,6 +852,9 @@ var LocalMappingsProvider = class extends BaseProvider {
       this.has[c] = false;
     });
   }
+  /**
+   * @private
+   */
   _setup() {
     this.queue = [];
     this.localStorageKey = "cocoda-mappings--" + this._path;
@@ -768,6 +896,14 @@ var LocalMappingsProvider = class extends BaseProvider {
     }
     return false;
   }
+  /**
+   * Returns a Promise that returns an object { mappings, done } with the local mappings and a done function that is supposed to be called when the transaction is finished.
+   * This prevents conflicts when saveMapping is called multiple times simultaneously.
+   *
+   * TODO: There might be a better solution for this...
+   *
+   * @private
+   */
   _getMappingsQueue() {
     let last2 = import_last.default(this.queue) || Promise.resolve();
     return new Promise((resolve) => {
@@ -793,6 +929,13 @@ var LocalMappingsProvider = class extends BaseProvider {
       });
     });
   }
+  /**
+   * Returns a single mapping.
+   *
+   * @param {Object} config
+   * @param {Object} config.mapping JSKOS mapping
+   * @returns {Object} JSKOS mapping object
+   */
   async getMapping({ mapping, ...config }) {
     config._raw = true;
     if (!mapping || !mapping.uri) {
@@ -800,6 +943,14 @@ var LocalMappingsProvider = class extends BaseProvider {
     }
     return (await this.getMappings({ ...config, uri: mapping.uri }))[0];
   }
+  /**
+   * Returns a list of local mappings.
+   *
+   * TODO: Add support for sort (`created` or `modified`) and order (`asc` or `desc`).
+   * TODO: Clean up and use async/await
+   *
+   * @returns {Object[]} array of JSKOS mapping objects
+   */
   async getMappings({ from, fromScheme, to, toScheme, creator, type, partOf, offset, limit, direction, mode, identifier, uri } = {}) {
     let params = {};
     if (from) {
@@ -945,6 +1096,13 @@ var LocalMappingsProvider = class extends BaseProvider {
       return mappings;
     });
   }
+  /**
+   * Creates a mapping.
+   *
+   * @param {Object} config
+   * @param {Object} config.mapping JSKOS mapping
+   * @returns {Object} JSKOS mapping object
+   */
   async postMapping({ mapping }) {
     if (!mapping) {
       throw new InvalidOrMissingParameterError({ parameter: "mapping" });
@@ -980,6 +1138,13 @@ var LocalMappingsProvider = class extends BaseProvider {
       throw error;
     }
   }
+  /**
+   * Overwrites a mapping.
+   *
+   * @param {Object} config
+   * @param {Object} config.mapping JSKOS mapping
+   * @returns {Object} JSKOS mapping object
+   */
   async putMapping({ mapping }) {
     if (!mapping) {
       throw new InvalidOrMissingParameterError({ parameter: "mapping" });
@@ -1005,6 +1170,13 @@ var LocalMappingsProvider = class extends BaseProvider {
       throw error;
     }
   }
+  /**
+   * Patches a mapping.
+   *
+   * @param {Object} config
+   * @param {Object} mapping JSKOS mapping (or part of mapping)
+   * @returns {Object} JSKOS mapping object
+   */
   async patchMapping({ mapping }) {
     if (!mapping) {
       throw new InvalidOrMissingParameterError({ parameter: "mapping" });
@@ -1030,6 +1202,13 @@ var LocalMappingsProvider = class extends BaseProvider {
       throw error;
     }
   }
+  /**
+   * Removes a mapping from local storage.
+   *
+   * @param {Object} config
+   * @param {Object} mapping JSKOS mapping
+   * @returns {boolean} boolean whether deleting the mapping was successful
+   */
   async deleteMapping({ mapping }) {
     if (!mapping) {
       throw new InvalidOrMissingParameterError({ parameter: "mapping" });
@@ -1053,6 +1232,9 @@ LocalMappingsProvider.stored = true;
 // src/providers/mappings-api-provider.js
 var import_jskos_tools3 = __toESM(require("jskos-tools"), 1);
 var MappingsApiProvider = class extends BaseProvider {
+  /**
+   * @private
+   */
   _prepare() {
     if (this._api.api && this._api.status === void 0) {
       this._api.status = concatUrl(this._api.api, "/status");
@@ -1064,6 +1246,9 @@ var MappingsApiProvider = class extends BaseProvider {
       this.has[c] = false;
     });
   }
+  /**
+   * @private
+   */
   _setup() {
     if (this._api.api) {
       const endpoints = {
@@ -1104,6 +1289,13 @@ var MappingsApiProvider = class extends BaseProvider {
       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 InvalidOrMissingParameterError({ parameter: "mapping" });
@@ -1127,6 +1319,12 @@ var MappingsApiProvider = class extends BaseProvider {
       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, cardinality, annotatedBy, annotatedFor, annotatedWith, sort, order, ...config }) {
     let params = {}, url = this._api.mappings;
     if (from) {
@@ -1194,6 +1392,13 @@ var MappingsApiProvider = class extends BaseProvider {
       }
     });
   }
+  /**
+   * 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 InvalidOrMissingParameterError({ parameter: "mapping" });
@@ -1211,6 +1416,13 @@ var MappingsApiProvider = class extends BaseProvider {
       }
     });
   }
+  /**
+   * 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 InvalidOrMissingParameterError({ parameter: "mapping" });
@@ -1232,6 +1444,13 @@ var MappingsApiProvider = class extends BaseProvider {
       }
     });
   }
+  /**
+   * 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 InvalidOrMissingParameterError({ parameter: "mapping" });
@@ -1251,6 +1470,13 @@ var MappingsApiProvider = class extends BaseProvider {
       }
     });
   }
+  /**
+   * 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 InvalidOrMissingParameterError({ parameter: "mapping" });
@@ -1266,6 +1492,13 @@ var MappingsApiProvider = class extends BaseProvider {
     });
     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) {
       import_set.default(config, "params.target", target);
@@ -1276,6 +1509,13 @@ var MappingsApiProvider = class extends BaseProvider {
       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,
@@ -1284,6 +1524,13 @@ var MappingsApiProvider = class extends BaseProvider {
       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)) {
@@ -1296,6 +1543,13 @@ var MappingsApiProvider = class extends BaseProvider {
       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)) {
@@ -1308,6 +1562,13 @@ var MappingsApiProvider = class extends BaseProvider {
       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)) {
@@ -1320,6 +1581,12 @@ var MappingsApiProvider = class extends BaseProvider {
     });
     return true;
   }
+  /**
+   * Returns a list of concordances.
+   *
+   * @param {Object} config
+   * @returns {Object[]} array of JSKOS concordance objects
+   */
   async getConcordances(config) {
     return this.axios({
       ...config,
@@ -1327,6 +1594,13 @@ var MappingsApiProvider = class extends BaseProvider {
       url: this._api.concordances
     });
   }
+  /**
+   * Creates a concordance.
+   *
+   * @param {Object} config
+   * @param {Object} config.concordance JSKOS concordance
+   * @returns {Object} JSKOS concordance object
+   */
   async postConcordance({ concordance, ...config }) {
     if (!concordance) {
       throw new InvalidOrMissingParameterError({ parameter: "concordance" });
@@ -1342,6 +1616,13 @@ var MappingsApiProvider = class extends BaseProvider {
       }
     });
   }
+  /**
+   * Overwrites a concordance.
+   *
+   * @param {Object} config
+   * @param {Object} config.concordance JSKOS concordance
+   * @returns {Object} JSKOS concordance object
+   */
   async putConcordance({ concordance, ...config }) {
     if (!concordance) {
       throw new InvalidOrMissingParameterError({ parameter: "concordance" });
@@ -1361,6 +1642,13 @@ var MappingsApiProvider = class extends BaseProvider {
       }
     });
   }
+  /**
+   * Patches a concordance.
+   *
+   * @param {Object} config
+   * @param {Object} config.concordance JSKOS concordance (or part of concordance)
+   * @returns {Object} JSKOS concordance object
+   */
   async patchConcordance({ concordance, ...config }) {
     if (!concordance) {
       throw new InvalidOrMissingParameterError({ parameter: "concordance" });
@@ -1380,6 +1668,13 @@ var MappingsApiProvider = class extends BaseProvider {
       }
     });
   }
+  /**
+   * Deletes a concordance.
+   *
+   * @param {Object} config
+   * @param {Object} config.concordance JSKOS concordance
+   * @returns {boolean} `true` if deletion was successful
+   */
   async deleteConcordance({ concordance, ...config }) {
     if (!concordance) {
       throw new InvalidOrMissingParameterError({ parameter: "concordance" });
@@ -1406,6 +1701,9 @@ var OccurrencesApiProvider = class extends BaseProvider {
   get _cache() {
     return cache[this.uri];
   }
+  /**
+   * @private
+   */
   _prepare() {
     cache[this.uri] = [];
     this._occurrencesSupportedSchemes = [];
@@ -1415,6 +1713,13 @@ var OccurrencesApiProvider = class extends BaseProvider {
       this.has[c] = false;
     });
   }
+  /**
+   * 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) {
     } else {
@@ -1436,6 +1741,12 @@ var OccurrencesApiProvider = class extends BaseProvider {
     }
     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 from = config.from;
@@ -1479,6 +1790,15 @@ var OccurrencesApiProvider = class extends BaseProvider {
     mappings._url = occurrences._url;
     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, threshold = 0, ...config }) {
     let promises = [];
     concepts = (concepts || []).concat([from, to]).filter((c) => !!c);
@@ -1531,6 +1851,13 @@ var OccurrencesApiProvider = class extends BaseProvider {
     occurrences._url = results.map((result) => result._url);
     return occurrences;
   }
+  /**
+   * 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) {
     let resultsFromCache = this._cache.find((item) => {
       return import_isEqual.default(item.config.params, config.params);
@@ -1559,6 +1886,9 @@ OccurrencesApiProvider.stored = false;
 // src/providers/concept-api-provider.js
 var import_jskos_tools5 = __toESM(require("jskos-tools"), 1);
 var ConceptApiProvider = class extends BaseProvider {
+  /**
+   * @private
+   */
   _prepare() {
     if (this._api.api && this._api.status === void 0) {
       this._api.status = concatUrl(this._api.api, "/status");
@@ -1577,6 +1907,9 @@ var ConceptApiProvider = class extends BaseProvider {
       this.has[c] = false;
     });
   }
+  /**
+   * @private
+   */
   _setup() {
     if (this._api.api) {
       const endpoints = {
@@ -1610,9 +1943,17 @@ var ConceptApiProvider = class extends BaseProvider {
     this.has.search = !!this._api.search;
     this.has.auth = import_get.default(this._config, "auth.key") != null;
     this._defaultParams = {
+      // Default parameters mostly for DANTE
       properties: "+created,issued,modified,editorialNote,scopeNote"
     };
   }
+  /**
+   * 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) {
       return null;
@@ -1622,6 +1963,11 @@ var ConceptApiProvider = class extends BaseProvider {
       schemes: [scheme]
     };
   }
+  /**
+   * 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 || [];
@@ -1650,6 +1996,12 @@ var ConceptApiProvider = class extends BaseProvider {
       return null;
     }
   }
+  /**
+   * Returns all concept schemes.
+   *
+   * @param {Object} config
+   * @returns {Object[]} array of JSKOS concept scheme objects
+   */
   async getSchemes(config) {
     if (!this._api.schemes) {
       if (Array.isArray(this.schemes)) {
@@ -1663,6 +2015,7 @@ var ConceptApiProvider = class extends BaseProvider {
       url: this._api.schemes,
       params: {
         ...this._defaultParams,
+        // ? What should the default limit be?
         limit: 500,
         ...config.params || {}
       }
@@ -1673,6 +2026,13 @@ var ConceptApiProvider = class extends BaseProvider {
       return schemes;
     }
   }
+  /**
+   * Returns top concepts for a concept scheme.
+   *
+   * @param {Object} config
+   * @param {Object} config.scheme concept scheme object
+   * @returns {Object[]} array of JSKOS concept objects
+   */
   async getTop({ scheme, ...config }) {
     if (!this._api.top) {
       throw new MissingApiUrlError();
@@ -1693,12 +2053,20 @@ var ConceptApiProvider = class extends BaseProvider {
       url: this._api.top,
       params: {
         ...this._defaultParams,
+        // ? What should the default limit be?
         limit: 1e4,
         ...config.params || {},
         uri: schemeUri
       }
     });
   }
+  /**
+   * 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 (this.has.data === false) {
       throw new MissingApiUrlError();
@@ -1716,12 +2084,20 @@ var ConceptApiProvider = class extends BaseProvider {
       url: this._api.data,
       params: {
         ...this._defaultParams,
+        // ? What should the default limit be?
         limit: 500,
         ...config.params || {},
         uri: uris.join("|")
       }
     });
   }
+  /**
+   * 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 (!this._api.narrower) {
       throw new MissingApiUrlError();
@@ -1735,12 +2111,20 @@ var ConceptApiProvider = class extends BaseProvider {
       url: this._api.narrower,
       params: {
         ...this._defaultParams,
+        // ? What should the default limit be?
         limit: 1e4,
         ...config.params || {},
         uri: concept.uri
       }
     });
   }
+  /**
+   * 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 (!this._api.ancestors) {
       throw new MissingApiUrlError();
@@ -1754,12 +2138,25 @@ var ConceptApiProvider = class extends BaseProvider {
       url: this._api.ancestors,
       params: {
         ...this._defaultParams,
+        // ? What should the default limit be?
         limit: 1e4,
         ...config.params || {},
         uri: concept.uri
       }
     });
   }
+  /**
+   * 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.use=notation,label] which fields to search ("notation", "label" or "notation,label")
+   * @param {string[]} [config.types=[]] list of type URIs
+   * @param {string} [config.sort=score] sorting parameter
+   * @returns {Array} result in OpenSearch Suggest Format
+   */
   async suggest({ use = "notation,label", types = [], sort = "score", params = {}, ...config }) {
     return this._search({
       ...config,
@@ -1772,6 +2169,17 @@ var ConceptApiProvider = class extends BaseProvider {
       }
     });
   }
+  /**
+   * Returns search results in JSKOS 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 {number} [config.offset=0] offset
+   * @param {string[]} [config.types=[]] list of type URIs
+   * @returns {Array} result in JSKOS Format
+   */
   async search({ types = [], params = {}, ...config }) {
     return this._search({
       ...config,
@@ -1782,6 +2190,16 @@ var ConceptApiProvider = class extends BaseProvider {
       }
     });
   }
+  /**
+   * Returns concept scheme suggestion result in OpenSearch Suggest Format.
+   *
+   * @param {Object} config
+   * @param {string} config.search search string
+   * @param {number} [config.limit=100] maximum number of search results (default might be overridden by registry)
+   * @param {string} [config.use=notation,label] which fields to search ("notation", "label" or "notation,label")
+   * @param {string} [config.sort=score] sorting parameter
+   * @returns {Array} result in OpenSearch Suggest Format
+   */
   async vocSuggest({ use = "notation,label", sort = "score", params = {}, ...config }) {
     return this._search({
       ...config,
@@ -1793,6 +2211,15 @@ var ConceptApiProvider = class extends BaseProvider {
       }
     });
   }
+  /**
+   * Returns concept scheme search results in JSKOS Format.
+   *
+   * @param {Object} config
+   * @param {string} config.search search string
+   * @param {number} [config.limit=100] maximum number of search results (default might be overridden by registry)
+   * @param {number} [config.offset=0] offset
+   * @returns {Array} result in JSKOS Format
+   */
   async vocSearch(config) {
     return this._search({
       ...config,
@@ -1818,6 +2245,7 @@ var ConceptApiProvider = class extends BaseProvider {
         ...params,
         limit,
         count: limit,
+        // Some endpoints use count instead of limit
         offset,
         search,
         query: search,
@@ -1827,6 +2255,13 @@ var ConceptApiProvider = class extends BaseProvider {
       url
     });
   }
+  /**
+   * 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 }) {
     if (!this._api.types) {
       throw new MissingApiUrlError();
@@ -1855,6 +2290,9 @@ var ReconciliationApiProvider = class extends BaseProvider {
   get _cache() {
     return cache2[this.uri];
   }
+  /**
+   * @private
+   */
   _prepare() {
     cache2[this.uri] = [];
     this.has.mappings = true;
@@ -1862,6 +2300,15 @@ var ReconciliationApiProvider = class extends BaseProvider {
       this.has[c] = false;
     });
   }
+  /**
+   * Returns a list of mappings suggestions.
+   *
+   * @param {Object} config
+   * @param {Object} config.from JSKOS concept on from side
+   * @param {Object} config.to JSKOS concept on to side
+   * @param {Object} config.mode mappings mode
+   * @returns {Object[]} array of JSKOS mapping objects
+   */
   async getMappings({ from, to, mode, ...config }) {
     let schemes = [];
     if (import_isArray.default(this.schemes)) {
@@ -1946,6 +2393,15 @@ var ReconciliationApiProvider = class extends BaseProvider {
     mappings._url = url;
     return mappings;
   }
+  /**
+   * Internal function that either makes an API request or uses a local cache.
+   *
+   * @private
+   *
+   * @param {Object} config passthrough of config object for axios request
+   * @param {string[]} labels list of labels to get results for
+   * @param {string} language language of labels
+   */
   async _getReconciliationResults({ labels, language, ...config }) {
     labels = labels.sort();
     let resultsFromCache = this._cache.find((item) => {
@@ -1994,6 +2450,9 @@ ReconciliationApiProvider.stored = false;
 // src/providers/label-search-suggestion-provider.js
 var import_jskos_tools7 = __toESM(require("jskos-tools"), 1);
 var LabelSearchSuggestionProvider = class extends BaseProvider {
+  /**
+   * @private
+   */
   _prepare() {
     this._cache = [];
     this.has.mappings = true;
@@ -2001,9 +2460,25 @@ var LabelSearchSuggestionProvider = class extends BaseProvider {
       this.has[c] = false;
     });
   }
+  /**
+   * Override `supportsScheme` to check whether a search URI is available for the scheme's registry.
+   *
+   * @param {Object} scheme - target scheme to check for support
+   * @returns {boolean}
+   */
   supportsScheme(scheme) {
     return super.supportsScheme(scheme) && import_get.default(scheme, "_registry.has.search", false);
   }
+  /**
+   * Returns a list of mappings.
+   *
+   * @param {Object} config
+   * @param {Object} config.from JSKOS concept on from side
+   * @param {Object} config.to JSKOS concept on to side
+   * @param {Object} config.mode mappings mode
+   * @param {Object} config.selected selected mappings in Cocoda
+   * @returns {Object[]} array of JSKOS mapping objects
+   */
   async getMappings({ from, to, mode, selected, limit = 10, ...config }) {
     if (mode != "or") {
       return [];
@@ -2033,6 +2508,17 @@ var LabelSearchSuggestionProvider = class extends BaseProvider {
     }
     return import_union.default(fromResult, toResult);
   }
+  /**
+   * Internal function to get mapping recommendations for a certain concept with sourceScheme and targetScheme.
+   *
+   * @private
+   *
+   * @param {Object} config
+   * @param {Object} config.concept
+   * @param {Object} config.sourceScheme
+   * @param {Pbject} config.targetScheme
+   * @param {boolean} config.swap - whether to reverse the direction of the mappings
+   */
   async _getMappings({ concept, sourceScheme, targetScheme, limit, swap = false, ...config }) {
     if (!concept || !sourceScheme || !targetScheme) {
       return [];
@@ -2082,6 +2568,15 @@ var LabelSearchSuggestionProvider = class extends BaseProvider {
     }
     return mappings;
   }
+  /**
+   * Internal function that either makes an API request or uses a local cache.
+   *
+   * @private
+   *
+   * @param {Object} config
+   * @param {string} config.label
+   * @param {Object} config.targetScheme
+   */
   async _getResults({ label, targetScheme, limit, ...config }) {
     let resultsFromCache = (this._cache[targetScheme.uri] || {})[label];
     if (resultsFromCache && resultsFromCache._limit >= limit) {
@@ -2113,6 +2608,9 @@ LabelSearchSuggestionProvider.stored = false;
 // src/providers/skosmos-api-provider.js
 var import_jskos_tools8 = __toESM(require("jskos-tools"), 1);
 var SkosmosApiProvider = class extends BaseProvider {
+  /**
+   * @private
+   */
   _prepare() {
     this.has.schemes = true;
     this.has.top = true;
@@ -2127,6 +2625,14 @@ var SkosmosApiProvider = class 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;
@@ -2141,9 +2647,15 @@ var SkosmosApiProvider = class 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 || import_get.default(this.schemes.find((s) => import_jskos_tools8.default.compare(s, scheme)), "VOCID");
     if (!VOCID) {
@@ -2157,6 +2669,9 @@ var SkosmosApiProvider = class 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 = import_get.default(concept, "inScheme[0]");
     if (!concept || !concept.uri) {
@@ -2164,6 +2679,11 @@ var SkosmosApiProvider = class 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 || [];
@@ -2194,6 +2714,9 @@ var SkosmosApiProvider = class extends BaseProvider {
       return null;
     }
   }
+  /**
+   * @private
+   */
   _toJskosConcept(skosmosConcept, { concept, scheme, result, language } = {}) {
     if (!skosmosConcept) {
       return null;
@@ -2266,6 +2789,12 @@ var SkosmosApiProvider = class 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 || []) {
@@ -2291,6 +2820,13 @@ var SkosmosApiProvider = class 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);
@@ -2314,6 +2850,13 @@ var SkosmosApiProvider = class 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 (!import_isArray.default(concepts)) {
       concepts = [concepts];
@@ -2353,6 +2896,13 @@ var SkosmosApiProvider = class 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 InvalidOrMissingParameterError({ parameter: "concept" });
@@ -2368,6 +2918,13 @@ var SkosmosApiProvider = class 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 InvalidOrMissingParameterError({ parameter: "concept" });
@@ -2392,6 +2949,16 @@ var SkosmosApiProvider = class 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);
@@ -2410,6 +2977,16 @@ var SkosmosApiProvider = class 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");
     import_set.default(config, "params.query", `${search}*`);
@@ -2424,6 +3001,13 @@ var SkosmosApiProvider = class 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 = [];
@@ -2522,6 +3106,9 @@ function madsToJskosConcept(data3, { scheme }) {
   return concept;
 }
 var LocApiProvider = class extends BaseProvider {
+  /**
+   * @private
+   */
   _prepare() {
     this.has.schemes = true;
     this.has.top = false;
@@ -2535,6 +3122,13 @@ var LocApiProvider = class 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.scheme scheme for which the config is requested
+   * @returns {Object} provider configuration
+   */
   static _registryConfigForBartocApiConfig({ scheme } = {}) {
     if (!scheme || !supportedSchemes.find((s) => import_jskos_tools9.default.compare(s, scheme))) {
       return null;
@@ -2543,6 +3137,11 @@ var LocApiProvider = class extends BaseProvider {
       schemes: [scheme]
     };
   }
+  /**
+   * Returns all concept schemes.
+   *
+   * @returns {Object[]} array of JSKOS concept scheme objects
+   */
   async getSchemes() {
     const schemes = [];
     for (let scheme of await Promise.all(
@@ -2567,6 +3166,29 @@ var LocApiProvider = class extends BaseProvider {
     }
     return schemes;
   }
+  /**
+   * TODO: Possibly reenable for LCC
+   * Returns top concepts for a concept scheme.
+   *
+   * @param {Object} config
+   * @param {Object} config.scheme concept scheme object
+   * @returns {Object[]} array of JSKOS concept objects
+   */
+  // async getTop({ scheme }) {
+  //   if (scheme.topConcepts && !scheme.topConcepts.includes(null)) {
+  //     return scheme.topConcepts
+  //   }
+  //   const schemes = await this.getSchemes()
+  //   scheme = schemes.find(s => jskos.compare(s, scheme))
+  //   return scheme && scheme.topConcepts || []
+  // }
+  /**
+   * 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 }) {
     if (!Array.isArray(concepts)) {
       concepts = [concepts];
@@ -2590,6 +3212,16 @@ var LocApiProvider = class extends BaseProvider {
     }
     return resultConcepts;
   }
+  /**
+   * 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 {number} [config.offset=0] offset
+   * @returns {Array} result in OpenSearch Suggest Format
+   */
   async suggest(config) {
     const results = await this.search(config);
     return [
@@ -2601,6 +3233,16 @@ var LocApiProvider = class extends BaseProvider {
       results.map((c) => c.uri)
     ];
   }
+  /**
+   * Returns search results in JSKOS 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 {number} [config.offset=0] offset
+   * @returns {Array} result in JSKOS Format
+   */
   async search({ search, scheme, limit, offset }) {
     const schemeUri = import_jskos_tools9.default.getAllUris(scheme).find((uri) => uri.startsWith(locUriPrefix));
     if (!schemeUri || !supportedSchemes.find((s) => import_jskos_tools9.default.compare(s, { uri: schemeUri }))) {
@@ -2672,6 +3314,14 @@ var SkohubProvider = class extends BaseProvider {
   get _schemeCache() {
     return data[this.uri] && data[this.uri].schemeCache;
   }
+  /**
+   * 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;
@@ -2801,6 +3451,15 @@ var SkohubProvider = class extends BaseProvider {
     concept = await this._loadConcept({ ...config, uri: concept.uri });
     return concept.narrower;
   }
+  /**
+   * 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
+   * @returns {Array} array of JSKOS concept objects
+   */
   async search({ search, scheme, limit = 100 }) {
     scheme = await this._loadScheme({ scheme });
     if (!scheme || !scheme.uri) {
@@ -2846,6 +3505,15 @@ var SkohubProvider = class extends BaseProvider {
     const concepts = await this.getConcepts({ concepts: result.map((uri) => ({ uri })) });
     return concepts.slice(0, limit);
   }
+  /**
+   * 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
+   * @returns {Array} result in OpenSearch Suggest Format
+   */
   async suggest(config) {
     config._raw = true;
     const concepts = await this.search(config);
@@ -2889,6 +3557,14 @@ var MyCoReProvider = class extends BaseProvider {
   _setup() {
     this._scheme = null;
   }
+  /**
+   * 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;
@@ -2897,6 +3573,9 @@ var MyCoReProvider = class extends BaseProvider {
       api: url
     };
   }
+  /**
+   * Converts scheme info (full scheme data that comes from the API) to a JSKOS scheme
+   */
   _schemeInfoToJSKOS(schemeInfo) {
     const uri = schemeInfo.labels.find((l) => l.lang === "x-uri").text;
     const prefLabel = {};
@@ -2915,6 +3594,13 @@ var MyCoReProvider = class extends BaseProvider {
     }
     return scheme;
   }
+  /**
+   * Converts a category to a JSKOS concept.
+   * - Also saves that concept in data
+   * - Also adds the concept's prefLabels to the search index
+   *
+   * ? Question: Should scopeNotes be part of the search index?
+   */
   _categoryToJSKOS(category, { scheme, broader = [] }) {
     if (!category || !scheme) {
       return null;
@@ -2947,11 +3633,17 @@ var MyCoReProvider = class extends BaseProvider {
     };
     return data2[scheme.uri].concepts[uri];
   }
+  /**
+   * Helper function that replaces `narrower` key with [null] if it has values. Use this before returning concepts.
+   */
   _removeNarrower(concept) {
     if (!concept)
       return concept;
     return Object.assign({}, concept, { narrower: concept.narrower && concept.narrower.length ? [null] : [] });
   }
+  /**
+   * Loads the data from the API. Only called from getSchemes and only called once.
+   */
   async _loadSchemeData(config) {
     const schemeInfo = await this.axios({
       ...config,
@@ -3038,6 +3730,15 @@ var MyCoReProvider = class extends BaseProvider {
     concept = data2[this._scheme.uri].concepts[concept.uri];
     return (concept && concept.narrower || []).map((c) => data2[this._scheme.uri].concepts[c.uri]).map(this._removeNarrower);
   }
+  /**
+   * 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
+   * @returns {Array} array of JSKOS concept objects
+   */
   async search({ search, scheme, limit = 100 }) {
     if (!scheme || !scheme.uri) {
       throw new InvalidOrMissingParameterError({ parameter: "scheme" });
@@ -3057,6 +3758,15 @@ var MyCoReProvider = class extends BaseProvider {
     const result = await data2[this._scheme.uri].searchIndex.search(search);
     return result.map((uri) => data2[this._scheme.uri].concepts[uri]).map(this._removeNarrower).slice(0, limit);
   }
+  /**
+   * 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
+   * @returns {Array} result in OpenSearch Suggest Format
+   */
   async suggest(config) {
     config._raw = true;
     const concepts = await this.search(config);
@@ -3100,16 +3810,37 @@ providers.addProvider(ConceptApiProvider);
 providers.addProvider(MappingsApiProvider);
 var registryCache = {};
 var CocodaSDK = class {
+  /**
+   * CDK constructor.
+   *
+   * @param {Object} [config={}] Cocoda-stye config object
+   */
   constructor(config) {
     this.config = config;
     this.axios = import_axios3.default.create();
   }
+  /**
+   * Method to set the configuration.
+   *
+   * @param {Object} config Cocoda-stye config object
+   */
   setConfig(config) {
     this.config = config;
   }
+  /**
+   * Current configuration.
+   *
+   * @returns {Object} current configuration
+   */
   get config() {
     return this._config;
   }
+  /**
+   * Prepares config when set.
+   *
+   * @param {Object} config Cocoda config object
+   * @private
+   */
   set config(config) {
     config = config || {};
     config.registries = config.registries || [];
@@ -3119,16 +3850,44 @@ var CocodaSDK = class {
     });
     this._config = config;
   }
+  /**
+   * Map of registered providers.
+   *
+   * @returns {Object} map of registered providers (name -> provider)
+   */
   get providers() {
     return providers;
   }
+  /**
+   * Creates a new CDK instance (same as `new CocodaSDK(config)`).
+   *
+   * @param {Object} config Cocoda config object
+   * @returns {CocodaSDK} new CDK instance
+   */
   createInstance(config) {
     return new CocodaSDK(config);
   }
+  /**
+   * Offer method to load a config file from URL.
+   *
+   * @param {string} url URL of config as JSON
+   */
   async loadConfig(url) {
     const response = await this.axios.get(url);
     this.config = response.data;
   }
+  /**
+   * Method to load buildInfo.
+   *
+   * Callback will only be called if buildInfo changes; it will not be called when there is no previous value.
+   *
+   * @param {Object} config
+   * @param {string} [config.url] full URL for build-info.json (default is taken from config.cocodaBaseUrl)
+   * @param {Object} [config.buildInfo] current buildInfo
+   * @param {number} [config.interval=60000] interval to load buildInfo in ms
+   * @param {Function} config.callback callback function called with two parameters (error, buildInfo, previousBuildInfo)
+   * @returns {Object} object with two function properties, `stop` to cancel the repeating request, `start` to restart the repeating request, as well as three convenience properties, `isPaused` (whether it is currently paused), `lastResult`, `hasErrored` (whether the last call of the function has errored)
+   */
   loadBuildInfo({ url, buildInfo = null, interval = 6e4, callback, ...config }) {
     if (!url && !this.config.cocodaBaseUrl) {
       throw new CDKError({ message: "Could not determine URL to load build config." });
@@ -3155,20 +3914,64 @@ var CocodaSDK = class {
       }
     });
   }
+  /**
+   * Method to get a registry by URI.
+   *
+   * @param {string} uri URI of registry in config
+   * @returns {?Object} initialized registry from config if found
+   */
   getRegistryForUri(uri) {
     return this.config.registries.find((r) => r.uri == uri);
   }
+  /**
+   * Method to initialize registry.
+   *
+   * @param {Object} registry JSKOS registry object
+   * @returns {Object} initialized registry
+   */
   initializeRegistry(registry) {
     registry = providers.init(registry);
     registry.cdk = this;
     return registry;
   }
+  /**
+   * Method to add custom provider.
+   *
+   * @param {Object} provider provider class that extends BaseProvider
+   */
   addProvider(provider) {
     providers.addProvider(provider);
   }
+  /**
+   * Static method to add custom provider.
+   *
+   * @param {Object} provider provider class that extends BaseProvider
+   */
   static addProvider(provider) {
     providers.addProvider(provider);
   }
+  /**
+   * Repeatedly call a certain function.
+   *
+   * Notes:
+   * - Callback will only be called if the results were changed.
+   * - The function will only be repeated after the previous call is resolved. This means that the total interval duration is (interval + duration of function call).
+   *
+   * Example:
+   * ```js
+   *  cdk.repeat({
+   *    function: () => registry.getMappings(),
+   *    callback: (error, result) => console.log(result),
+   *  })
+   * ```
+   *
+   * @param {Object} config
+   * @param {string} config.function a function to be called (can be async)
+   * @param {number} [config.interval=15000] interval in ms
+   * @param {Function} config.callback callback function called with two parameters (error, result, previousResult)
+   * @param {boolean} [config.callImmediately=true] whether to call the function immediately
+   * @returns {Object} object with two function properties, `stop` to cancel the repeating request, `start` to restart the repeating request, as well as three convenience properties, `isPaused` (whether it is currently paused), `lastResult`, `hasErrored` (whether the last call of the function has errored)
+   */
   repeat({ function: func, interval = 15e3, callback, callImmediately = true } = {}) {
     if (!func) {
       throw new InvalidOrMissingParameterError({ parameter: "function" });
@@ -3255,6 +4058,12 @@ var CocodaSDK = class {
       }
     };
   }
+  /**
+   * Gets schemes from all registries that support schemes and merges the results.
+   *
+   * @param {Object} [config={}] configuration object that will be used as a parameter for internal `getSchemes` calls
+   * @returns {Object[]} array of JSKOS schemes
+   */
   async getSchemes(config = {}) {
     let schemes = [], promises = [];
     for (let registry of this.config.registries) {