ir-spectrum 3.0.0 → 3.1.0

package/lib/index.js

@@ -28,7 +28,7 @@ function getPeakKind(transmittance, minTransmittance, maxTransmittance) {
 }
 
 /**
- * @typedef {Object} Peak
+ * @typedef {object} Peak
  * @property {number} wavenumber
  * @property {number} transmittance
  * @property {number} absorbance
@@ -38,14 +38,14 @@ function getPeakKind(transmittance, minTransmittance, maxTransmittance) {
 
 /**
  * Creates annotations for jsgraph that allows to display the result of peak picking
- * @param {array<Peak>} peaks
+ * @param {Array<Peak>} peaks
  * @param {object} [options={}]
  * @param {string} [options.fillColor='green']
  * @param {string} [options.strokeColor='red']
- * @param {string} [options.showKind=true] Display the kind, 'm', 'w', 'S'
- * @param {string} [options.showAssignment=true] Display the assignment
- * @param {function} [options.createFct] (annotation, peak) => {}: callback allowing to add properties
- * @param {string} [options.mode='t100'] 't100'=transmittance in %, 't'=transmittance, 'a'=absorbance
+ * @param {string} [options.showKind=true] - Display the kind, 'm', 'w', 'S'
+ * @param {string} [options.showAssignment=true] - Display the assignment
+ * @param {Function} [options.createFct] - (annotation, peak) => {}: callback allowing to add properties
+ * @param {string} [options.mode='t100'] - 't100'=transmittance in %, 't'=transmittance, 'a'=absorbance
  * @returns array
  */
 
@@ -244,9 +244,9 @@ function spectrumCallback(variables) {
  * @param {ArrayBuffer|string} jcamp
  * @param {object} [options={}]
  * @param {string|number} [options.id=Math.random()]
- * @param {string} [options.label=options.id] human redeable label
- * @param {string} [options.spectrumCallback] a callback to apply on variables when creating spectrum. Default will add a and t
- * @return {Analysis} - New class element with the given data
+ * @param {string} [options.label=options.id] - human redeable label
+ * @param {string} [options.spectrumCallback] - a callback to apply on variables when creating spectrum. Default will add a and t
+ * @returns {Analysis} - New class element with the given data
  */
 function fromJcamp(jcamp, options = {}) {
   return commonSpectrum.fromJcamp(jcamp, { ...options, spectrumCallback });
@@ -257,9 +257,9 @@ function fromJcamp(jcamp, options = {}) {
  * @param {ArrayBuffer} buffer
  * @param {object} [options={}]
  * @param {object} [options.id=Math.random()]
- * @param {string} [options.label=options.id] human redeable label
- * @param {string} [options.spectrumCallback] a callback to apply on variables when creating spectrum. Default will add a and t
- * @return {Analysis} - New class element with the given data
+ * @param {string} [options.label=options.id] - human redeable label
+ * @param {string} [options.spectrumCallback] - a callback to apply on variables when creating spectrum. Default will add a and t
+ * @returns {Analysis} - New class element with the given data
  */
 
 function fromSPC(buffer, options = {}) {
@@ -293,15 +293,15 @@ function autoPeakPicking(spectrum, options) {
 
 const JSGraph = { ...commonSpectrum.JSGraph, getAnnotations };
 
-Object.defineProperty(exports, 'AnalysesManager', {
+Object.defineProperty(exports, "AnalysesManager", {
   enumerable: true,
   get: function () { return commonSpectrum.AnalysesManager; }
 });
-Object.defineProperty(exports, 'Analysis', {
+Object.defineProperty(exports, "Analysis", {
   enumerable: true,
   get: function () { return commonSpectrum.Analysis; }
 });
-Object.defineProperty(exports, 'toJcamp', {
+Object.defineProperty(exports, "toJcamp", {
   enumerable: true,
   get: function () { return commonSpectrum.toJcamp; }
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ir-spectrum",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "",
   "main": "lib/index.js",
   "module": "src/index.js",
@@ -16,9 +16,9 @@
     "prepack": "rollup -c",
     "prettier": "prettier --check src",
     "prettier-write": "prettier --write src",
-    "test": "npm run test-coverage && npm run eslint",
-    "test-coverage": "jest --coverage",
-    "test-only": "jest"
+    "test": "npm run test-coverage && npm run eslint && npm run prettier",
+    "test-coverage": "vitest run --coverage",
+    "test-only": "vitest run"
   },
   "repository": {
     "type": "git",
@@ -35,22 +35,23 @@
     "testEnvironment": "node"
   },
   "devDependencies": {
-    "@babel/plugin-transform-modules-commonjs": "^7.22.5",
-    "@types/jest": "^29.5.3",
+    "@babel/plugin-transform-modules-commonjs": "^7.25.9",
+    "@vitest/coverage-v8": "^2.1.5",
     "cheminfo-build": "^1.2.0",
     "codecov": "^3.8.3",
-    "eslint": "^8.47.0",
-    "eslint-config-cheminfo": "^9.0.2",
+    "eslint": "^9.14.0",
+    "eslint-config-cheminfo": "^12.0.1",
     "esm": "^3.2.25",
-    "jest": "^29.6.3",
     "jest-matcher-deep-close-to": "^3.0.2",
-    "prettier": "^3.0.2",
-    "rollup": "^3.28.1"
+    "prettier": "^3.3.3",
+    "rollup": "^4.26.0",
+    "vitest": "^2.1.5"
   },
   "dependencies": {
-    "common-spectrum": "2.2.1",
-    "ml-gsd": "^12.1.3",
-    "spc-parser": "^0.7.2"
+    "common-spectrum": "2.12.0",
+    "ml-gsd": "^12.1.8",
+    "spc-parser": "^1.0.0",
+    "uninstall": "^0.0.0"
   },
   "info": {
     "logo": "https://raw.githubusercontent.com/cheminfo/font/master/src/ir/assignment.svg",

package/src/from/fromJcamp.js

@@ -7,9 +7,9 @@ import { spectrumCallback } from './utils/spectrumCallback';
  * @param {ArrayBuffer|string} jcamp
  * @param {object} [options={}]
  * @param {string|number} [options.id=Math.random()]
- * @param {string} [options.label=options.id] human redeable label
- * @param {string} [options.spectrumCallback] a callback to apply on variables when creating spectrum. Default will add a and t
- * @return {Analysis} - New class element with the given data
+ * @param {string} [options.label=options.id] - human redeable label
+ * @param {string} [options.spectrumCallback] - a callback to apply on variables when creating spectrum. Default will add a and t
+ * @returns {Analysis} - New class element with the given data
  */
 export function fromJcamp(jcamp, options = {}) {
   return commonFromJcamp(jcamp, { ...options, spectrumCallback });

package/src/from/fromSPC.js

@@ -8,9 +8,9 @@ import { spectrumCallback } from './utils/spectrumCallback';
  * @param {ArrayBuffer} buffer
  * @param {object} [options={}]
  * @param {object} [options.id=Math.random()]
- * @param {string} [options.label=options.id] human redeable label
- * @param {string} [options.spectrumCallback] a callback to apply on variables when creating spectrum. Default will add a and t
- * @return {Analysis} - New class element with the given data
+ * @param {string} [options.label=options.id] - human redeable label
+ * @param {string} [options.spectrumCallback] - a callback to apply on variables when creating spectrum. Default will add a and t
+ * @returns {Analysis} - New class element with the given data
  */
 
 export function fromSPC(buffer, options = {}) {

package/src/jsgraph/getAnnotations.js

@@ -1,5 +1,5 @@
 /**
- * @typedef {Object} Peak
+ * @typedef {object} Peak
  * @property {number} wavenumber
  * @property {number} transmittance
  * @property {number} absorbance
@@ -9,14 +9,14 @@
 
 /**
  * Creates annotations for jsgraph that allows to display the result of peak picking
- * @param {array<Peak>} peaks
+ * @param {Array<Peak>} peaks
  * @param {object} [options={}]
  * @param {string} [options.fillColor='green']
  * @param {string} [options.strokeColor='red']
- * @param {string} [options.showKind=true] Display the kind, 'm', 'w', 'S'
- * @param {string} [options.showAssignment=true] Display the assignment
- * @param {function} [options.createFct] (annotation, peak) => {}: callback allowing to add properties
- * @param {string} [options.mode='t100'] 't100'=transmittance in %, 't'=transmittance, 'a'=absorbance
+ * @param {string} [options.showKind=true] - Display the kind, 'm', 'w', 'S'
+ * @param {string} [options.showAssignment=true] - Display the assignment
+ * @param {Function} [options.createFct] - (annotation, peak) => {}: callback allowing to add properties
+ * @param {string} [options.mode='t100'] - 't100'=transmittance in %, 't'=transmittance, 'a'=absorbance
  * @returns array
  */