cocoda-sdk 3.3.3 → 3.3.4

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

@@ -71,6 +71,9 @@ function madsToJskosConcept(data, { scheme }) {
   return concept;
 }
 class LocApiProvider extends BaseProvider {
+  /**
+   * @private
+   */
   _prepare() {
     this.has.schemes = true;
     this.has.top = false;
@@ -84,6 +87,13 @@ class LocApiProvider 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) => jskos.compare(s, scheme))) {
       return null;
@@ -92,6 +102,11 @@ class LocApiProvider 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(
@@ -116,6 +131,29 @@ class LocApiProvider 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];
@@ -139,6 +177,16 @@ class LocApiProvider 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 [
@@ -150,6 +198,16 @@ class LocApiProvider 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 = jskos.getAllUris(scheme).find((uri) => uri.startsWith(locUriPrefix));
     if (!schemeUri || !supportedSchemes.find((s) => jskos.compare(s, { uri: schemeUri }))) {

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

@@ -7,6 +7,9 @@ import * as errors from "../errors/index.js";
 import { listOfCapabilities } from "../utils/index.js";
 const uriPrefix = "urn:uuid:";
 class LocalMappingsProvider extends BaseProvider {
+  /**
+   * @private
+   */
   _prepare() {
     this.has.mappings = {
       read: true,
@@ -18,6 +21,9 @@ class LocalMappingsProvider extends BaseProvider {
       this.has[c] = false;
     });
   }
+  /**
+   * @private
+   */
   _setup() {
     this.queue = [];
     this.localStorageKey = "cocoda-mappings--" + this._path;
@@ -59,6 +65,14 @@ class LocalMappingsProvider 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 last = _.last(this.queue) || Promise.resolve();
     return new Promise((resolve) => {
@@ -84,6 +98,13 @@ class LocalMappingsProvider 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) {
@@ -91,6 +112,14 @@ class LocalMappingsProvider 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) {
@@ -236,6 +265,13 @@ class LocalMappingsProvider 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 errors.InvalidOrMissingParameterError({ parameter: "mapping" });
@@ -271,6 +307,13 @@ class LocalMappingsProvider 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 errors.InvalidOrMissingParameterError({ parameter: "mapping" });
@@ -296,6 +339,13 @@ class LocalMappingsProvider 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 errors.InvalidOrMissingParameterError({ parameter: "mapping" });
@@ -321,6 +371,13 @@ class LocalMappingsProvider 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 errors.InvalidOrMissingParameterError({ parameter: "mapping" });

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

@@ -4,6 +4,9 @@ import * as _ from "../utils/lodash.js";
 import * as errors from "../errors/index.js";
 import * as utils from "../utils/index.js";
 class MappingsApiProvider extends BaseProvider {
+  /**
+   * @private
+   */
   _prepare() {
     if (this._api.api && this._api.status === void 0) {
       this._api.status = utils.concatUrl(this._api.api, "/status");
@@ -15,6 +18,9 @@ class MappingsApiProvider extends BaseProvider {
       this.has[c] = false;
     });
   }
+  /**
+   * @private
+   */
   _setup() {
     if (this._api.api) {
       const endpoints = {
@@ -55,6 +61,13 @@ class MappingsApiProvider 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 errors.InvalidOrMissingParameterError({ parameter: "mapping" });
@@ -78,6 +91,12 @@ class MappingsApiProvider 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) {
@@ -145,6 +164,13 @@ class MappingsApiProvider 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 errors.InvalidOrMissingParameterError({ parameter: "mapping" });
@@ -162,6 +188,13 @@ class MappingsApiProvider 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 errors.InvalidOrMissingParameterError({ parameter: "mapping" });
@@ -183,6 +216,13 @@ class MappingsApiProvider 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 errors.InvalidOrMissingParameterError({ parameter: "mapping" });
@@ -202,6 +242,13 @@ class MappingsApiProvider 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 errors.InvalidOrMissingParameterError({ parameter: "mapping" });
@@ -217,6 +264,13 @@ class MappingsApiProvider 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) {
       _.set(config, "params.target", target);
@@ -227,6 +281,13 @@ class MappingsApiProvider 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,
@@ -235,6 +296,13 @@ class MappingsApiProvider 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)) {
@@ -247,6 +315,13 @@ class MappingsApiProvider 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)) {
@@ -259,6 +334,13 @@ class MappingsApiProvider 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)) {
@@ -271,6 +353,12 @@ class MappingsApiProvider 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,
@@ -278,6 +366,13 @@ class MappingsApiProvider 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 errors.InvalidOrMissingParameterError({ parameter: "concordance" });
@@ -293,6 +388,13 @@ class MappingsApiProvider 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 errors.InvalidOrMissingParameterError({ parameter: "concordance" });
@@ -312,6 +414,13 @@ class MappingsApiProvider 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 errors.InvalidOrMissingParameterError({ parameter: "concordance" });
@@ -331,6 +440,13 @@ class MappingsApiProvider 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 errors.InvalidOrMissingParameterError({ parameter: "concordance" });

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

@@ -22,6 +22,14 @@ class MyCoReProvider 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;
@@ -30,6 +38,9 @@ class MyCoReProvider 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 = {};
@@ -48,6 +59,13 @@ class MyCoReProvider 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;
@@ -80,11 +98,17 @@ class MyCoReProvider extends BaseProvider {
     };
     return data[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,
@@ -171,6 +195,15 @@ class MyCoReProvider extends BaseProvider {
     concept = data[this._scheme.uri].concepts[concept.uri];
     return (concept && concept.narrower || []).map((c) => data[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 errors.InvalidOrMissingParameterError({ parameter: "scheme" });
@@ -190,6 +223,15 @@ class MyCoReProvider extends BaseProvider {
     const result = await data[this._scheme.uri].searchIndex.search(search);
     return result.map((uri) => data[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);

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

@@ -8,6 +8,9 @@ class OccurrencesApiProvider extends BaseProvider {
   get _cache() {
     return cache[this.uri];
   }
+  /**
+   * @private
+   */
   _prepare() {
     cache[this.uri] = [];
     this._occurrencesSupportedSchemes = [];
@@ -17,6 +20,13 @@ class OccurrencesApiProvider 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 {
@@ -38,6 +48,12 @@ class OccurrencesApiProvider 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;
@@ -81,6 +97,15 @@ class OccurrencesApiProvider 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);
@@ -133,6 +158,13 @@ class OccurrencesApiProvider 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 _.isEqual(item.config.params, config.params);

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

@@ -8,6 +8,9 @@ class ReconciliationApiProvider extends BaseProvider {
   get _cache() {
     return cache[this.uri];
   }
+  /**
+   * @private
+   */
   _prepare() {
     cache[this.uri] = [];
     this.has.mappings = true;
@@ -15,6 +18,15 @@ class ReconciliationApiProvider 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 (_.isArray(this.schemes)) {
@@ -99,6 +111,15 @@ class ReconciliationApiProvider 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) => {

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

@@ -41,6 +41,14 @@ class SkohubProvider 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;
@@ -170,6 +178,15 @@ class SkohubProvider 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) {
@@ -215,6 +232,15 @@ class SkohubProvider 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);