cocoda-sdk 1.0.13 → 2.0.0

package/{utils → dist/esm/utils}/index.js

@@ -1,163 +1,150 @@
 const requestMethods = [
-  // General
   {
     method: "getRegistries",
     fallback: [],
-    type: "Registries",
+    type: "Registries"
   },
   {
     method: "getSchemes",
     fallback: [],
-    type: "Schemes",
+    type: "Schemes"
   },
   {
     method: "vocSearch",
     fallback: [],
-    type: "Schemes",
+    type: "Schemes"
   },
   {
     method: "getTypes",
     fallback: [],
-    type: "Types",
+    type: "Types"
   },
   {
     method: "suggest",
-    fallback: ["", [], [], []],
+    fallback: ["", [], [], []]
   },
   {
     method: "vocSuggest",
-    fallback: ["", [], [], []],
+    fallback: ["", [], [], []]
   },
   {
     method: "getConcordances",
     fallback: [],
-    type: "Concordances",
+    type: "Concordances"
   },
   {
     method: "getOccurrences",
     fallback: [],
-    type: "Occurrences",
+    type: "Occurrences"
   },
-  // Concepts
   {
     method: "getTop",
     fallback: [],
-    type: "Concepts",
+    type: "Concepts"
   },
   {
     method: "getConcepts",
     fallback: [],
-    type: "Concepts",
+    type: "Concepts"
   },
   {
     method: "getNarrower",
     fallback: [],
-    type: "Concepts",
+    type: "Concepts"
   },
   {
     method: "getAncestors",
     fallback: [],
-    type: "Concepts",
+    type: "Concepts"
   },
   {
     method: "search",
     fallback: [],
-    type: "Concepts",
+    type: "Concepts"
   },
-  // Mappings
   {
     method: "getMapping",
     fallback: null,
-    type: "Mapping",
+    type: "Mapping"
   },
   {
     method: "getMappings",
     fallback: [],
-    type: "Mappings",
+    type: "Mappings"
   },
   {
     method: "postMapping",
     fallback: null,
-    type: "Mapping",
+    type: "Mapping"
   },
   {
     method: "postMappings",
     fallback: [],
-    type: "Mapping",
+    type: "Mapping"
   },
   {
     method: "putMapping",
     fallback: null,
-    type: "Mapping",
+    type: "Mapping"
   },
   {
     method: "patchMapping",
     fallback: null,
-    type: "Mapping",
+    type: "Mapping"
   },
   {
     method: "deleteMapping",
-    fallback: false,
+    fallback: false
   },
   {
     method: "deleteMappings",
-    fallback: [],
+    fallback: []
   },
-  // Annotations
-  // {
-  //   method: "getAnnotation",
-  //   fallback: "",
-  // },
   {
     method: "getAnnotations",
     fallback: [],
-    type: "Annotations",
+    type: "Annotations"
   },
   {
     method: "postAnnotation",
     fallback: null,
-    type: "Annotation",
+    type: "Annotation"
   },
   {
     method: "putAnnotation",
     fallback: null,
-    type: "Annotation",
+    type: "Annotation"
   },
   {
     method: "patchAnnotation",
     fallback: null,
-    type: "Annotation",
+    type: "Annotation"
   },
   {
     method: "deleteAnnotation",
-    fallback: false,
-  },
-]
-
+    fallback: false
+  }
+];
 function concatUrl(...parts) {
-  let [url, ...otherParts] = parts
+  let [url, ...otherParts] = parts;
   for (let part of otherParts) {
     if (!url.endsWith("/")) {
-      url += "/"
+      url += "/";
     }
     if (part.startsWith("/")) {
-      part = part.slice(1)
+      part = part.slice(1);
     }
-    url += part
+    url += part;
   }
-  return url
+  return url;
 }
-
-
-// Retain custom array properties
 function withCustomProps(arr, from) {
-  arr._totalCount = from._totalCount
-  arr._url = from._url
-  return arr
+  arr._totalCount = from._totalCount;
+  arr._url = from._url;
+  return arr;
 }
-
-module.exports = {
-  requestMethods,
+export {
   concatUrl,
-  withCustomProps,
-}
+  requestMethods,
+  withCustomProps
+};

package/dist/esm/utils/lodash.js

@@ -0,0 +1,34 @@
+import {
+  get,
+  set,
+  uniq,
+  intersection,
+  union,
+  forOwn,
+  isArray,
+  isObject,
+  isString,
+  isEmpty,
+  isEqual,
+  merge,
+  last,
+  omit,
+  concat
+} from "lodash-es";
+export {
+  concat,
+  forOwn,
+  get,
+  intersection,
+  isArray,
+  isEmpty,
+  isEqual,
+  isObject,
+  isString,
+  last,
+  merge,
+  omit,
+  set,
+  union,
+  uniq
+};

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "cocoda-sdk",
-  "version": "1.0.13",
+  "version": "2.0.0",
   "description": "SDK for Cocoda",
-  "main": "index.js",
-  "browser": "dist/cocoda-sdk.js",
-  "browserslist": "> 1.5%, not dead",
+  "main": "dist/cjs/index.cjs",
+  "module": "dist/esm/index.js",
+  "jsdelivr": "dist/cocoda-sdk.js",
+  "unpkg": "dist/cocoda-sdk.js",
+  "sideEffects": false,
+  "browserslist": "defaults and not ie<=11 and supports es6",
+  "type": "module",
   "files": [
     "dist",
     "lib",
@@ -17,7 +21,7 @@
     "lint": "eslint ./**/*.js ./**/.*.js",
     "fix": "eslint --fix ./**/*.js ./**/.*.js",
     "lint-staged": "lint-staged",
-    "build": "rollup -c",
+    "build": "node --experimental-json-modules build.js",
     "release": "npm run build && npm test && git checkout dev && git pull && npm version $SEMVER && git push && git checkout master && git merge dev && git push --follow-tags && git checkout dev",
     "release:patch": "SEMVER=patch npm run release",
     "release:minor": "SEMVER=minor npm run release",
@@ -46,28 +50,23 @@
   },
   "homepage": "https://github.com/gbv/cocoda-sdk#readme",
   "devDependencies": {
-    "@babel/core": "^7.15.0",
-    "@babel/helper-define-map": "^7.14.5",
-    "@babel/preset-env": "^7.15.0",
-    "@rollup/plugin-babel": "^5.3.0",
-    "@rollup/plugin-commonjs": "^20.0.0",
-    "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-node-resolve": "^13.0.4",
     "axios-mock-adapter": "^1.20.0",
+    "esbuild": "^0.12.28",
+    "esbuild-plugin-ifdef": "^1.0.1",
     "eslint": "^7.32.0",
     "eslint-config-gbv": "^1.0.3",
+    "glob": "^7.1.7",
+    "license-checker": "^25.0.1",
     "lint-staged": "^11.1.2",
     "mocha": "^9.1.1",
     "mocha-eslint": "^7.0.0",
-    "pre-commit": "^1.2.2",
-    "rollup": "^2.56.3",
-    "rollup-plugin-license": "^2.5.0"
+    "pre-commit": "^1.2.2"
   },
   "dependencies": {
-    "axios": "^0.21.1",
+    "axios": "^0.21.4",
     "jskos-tools": "^1.0.17",
     "localforage": "^1.10.0",
-    "lodash": "^4.17.21",
+    "lodash-es": "^4.17.21",
     "uuid": "^8.3.2"
   }
 }

package/errors/index.js

@@ -1,119 +0,0 @@
-/**
- * CDKError superclass.
- *
- * @category Errors
- */
-class CDKError 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
-    }
-    super(message)
-    this.name = this.constructor.name
-    this.relatedError = relatedError
-    this.code = code
-  }
-}
-
-/**
- * MethodNotImplementedError is thrown when the called method is valid, but not implemented for the current provider.
- *
- * @category Errors
- */
-class MethodNotImplementedError 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)
-  }
-}
-
-/**
- * InvalidOrMissingParameterError is thrown when a parameter is missing or is not valid for the request.
- *
- * @category Errors
- */
-class InvalidOrMissingParameterError 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)
-  }
-}
-
-/**
- * InvalidRequestError is thrown when the server responded with a 4xx error (i.e. it's a problem on the client side).
- *
- * @category Errors
- */
-class InvalidRequestError extends CDKError {}
-
-/**
- * BackendError is thrown when the server responded with a 5xx error (i.e. it's a problem on the server side).
- *
- * @category Errors
- */
-class BackendError extends CDKError {}
-
-/**
- * BackendUnavailableError is thrown when the server did not respond, but the client's internet connection seems to be working.
- *
- * @category Errors
- */
-class BackendUnavailableError extends CDKError {}
-
-/**
- * NetworkError is thrown when the request could not be performend (e.g. the network was not available).
- *
- * @category Errors
- */
-class NetworkError extends CDKError {}
-
-/**
- * MissingApiUrlError is thrown when the called method is valid, but the required API URL is not available for the current registry.
- *
- * @category Errors
- */
-class MissingApiUrlError extends CDKError {}
-
-/**
- * InvalidProviderError is thrown when a provider is added to the provider list that does not inherit from BaseProvider.
- *
- * @category Errors
- */
-class InvalidProviderError extends CDKError {}
-
-module.exports = {
-  CDKError,
-  MethodNotImplementedError,
-  InvalidOrMissingParameterError,
-  BackendError,
-  BackendUnavailableError,
-  NetworkError,
-  InvalidRequestError,
-  MissingApiUrlError,
-  InvalidProviderError,
-}

package/index.js

@@ -1,5 +0,0 @@
-const CDK = require("./lib/CocodaSDK")
-
-// Create and export a default instance
-const cdk = new CDK()
-module.exports = cdk