nirs4all 0.2.6 → 0.2.8

package/README.md

@@ -2,12 +2,16 @@
 
 npm package name: `nirs4all`
 
+The canonical source repository is `nirs4all-core`; the npm publication keeps
+the bare `nirs4all` name because the lite->core rename applies only to the
+Python distribution.
+
 This package is the runtime surface that `nirs4all-web` should consume. The web
 application lives in `nirs4all-web`; this directory is for the reusable
 JavaScript/WASM binding and package metadata.
 
 The portable execution API delegates Kennard-Stone, SNV, Savitzky-Golay, and
-PLS component sweeps to `@nirs4all/methods-wasm`:
+PLS component sweeps to `@nirs4all/methods`:
 
 - `runPortablePipeline(source, dataset)` parses the shared nirs4all JSON/YAML
   syntax, executes the portable subset, and returns parity-checkable split,
@@ -20,3 +24,10 @@ PLS component sweeps to `@nirs4all/methods-wasm`:
 Savitzky-Golay defaults to `mode: "interp"` for full nirs4all parity and
 preserves explicit methods-backed modes (`mirror`, `constant`, `nearest`,
 `wrap`, `interp`) plus `cval` in the serialized preprocessing chain.
+
+For a browser-only custom host, pair this package with `nirs4all-ui`: keep
+runtime loading and portable execution in `nirs4all`, and consume shared React
+components / view-model helpers / brand assets from `nirs4all-ui`. The
+reference composition lives in `../../nirs4all-web/studio-lite`, whose contract
+tests exercise `runPortablePipeline()` / `predictPortablePipeline()` together
+with the shared UI package in a no-backend environment.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nirs4all",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "description": "Portable nirs4all aggregate binding for JavaScript and WASM",
   "type": "module",
   "exports": {
@@ -22,6 +22,10 @@
     "typecheck": "tsc --project tsconfig.typecheck.json"
   },
   "license": "(CECILL-2.1 OR AGPL-3.0-or-later)",
+  "homepage": "https://nirs4all-core.readthedocs.io/en/latest/",
+  "bugs": {
+    "url": "https://github.com/GBeurier/nirs4all-core/issues"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/GBeurier/nirs4all-core.git",
@@ -43,7 +47,7 @@
     "@nirs4all/datasets-wasm": "*",
     "@nirs4all/formats-wasm": "*",
     "@nirs4all/io-wasm": "*",
-    "@nirs4all/methods-wasm": "*",
+    "@nirs4all/methods": "*",
     "@nirs4all/nirs4all-datasets-wasm": "*",
     "dag-ml-data-wasm": "*",
     "dag-ml-wasm": "*",
@@ -60,7 +64,7 @@
     "@nirs4all/io-wasm": {
       "optional": true
     },
-    "@nirs4all/methods-wasm": {
+    "@nirs4all/methods": {
       "optional": true
     },
     "@nirs4all/nirs4all-datasets-wasm": {

package/src/execution.js

@@ -238,7 +238,7 @@ function computeSplit(methods, splitter, input) {
     const indices = Array.from({ length: input.rows }, (_, i) => i);
     return { kind: 'all', trainIndices: indices, testIndices: indices };
   }
-  const splitOptions = { testSize: numberParam(splitter.params.test_size, 0.25) };
+  const splitOptions = { testSize: numberParam(splitter.params.test_size, 0.25, 'test_size') };
   if (typeof methods.computeSplitIndices === 'function') {
     const split = methods.computeSplitIndices(
       'KennardStone',
@@ -280,17 +280,17 @@ function selectRows(data, rows, cols, indices) {
 }
 
 function savgolParams(params) {
-  const delta = numberParam(params.delta, 1);
-  if (delta !== 1) {
+  const delta = numberParam(params.delta, 1, 'delta');
+  if (Math.abs(delta - 1) > Number.EPSILON) {
     throw new Error('Portable Savitzky-Golay execution currently supports delta=1 only.');
   }
   return [
-    numberParam(params.window_length ?? params.window, 11),
-    numberParam(params.polyorder, 3),
-    numberParam(params.deriv, 0),
+    integerParam(params.window_length ?? params.window, 11, 'window_length', { min: 1 }),
+    integerParam(params.polyorder, 3, 'polyorder', { min: 0 }),
+    integerParam(params.deriv, 0, 'deriv', { min: 0 }),
     // scipy.signal.savgol_filter, and therefore nirs4all Python, default to interp.
     savgolMode(params.mode ?? 'interp'),
-    numberParam(params.cval, 0),
+    numberParam(params.cval, 0, 'cval'),
   ];
 }
 
@@ -322,23 +322,52 @@ function componentValues(step) {
     if (step.param !== 'n_components') {
       throw new Error("Portable execution only supports _range_ sweeps over 'n_components'.");
     }
-    const [start, stop, stride] = step._range_.map(Number);
-    if (![start, stop, stride].every(Number.isFinite) || stride <= 0 || start > stop) {
+    if (step._range_.length !== 3) {
       throw new Error('Invalid n_components _range_; expected [start, stop, positive_step].');
     }
+    const start = integerParam(step._range_[0], undefined, 'n_components range start', { min: 1 });
+    const stop = integerParam(step._range_[1], undefined, 'n_components range stop', { min: 1 });
+    const stride = integerParam(step._range_[2], undefined, 'n_components range step', { min: 1 });
+    if (start > stop) {
+      throw new Error('Invalid n_components _range_; start must be <= stop.');
+    }
     const values = [];
     for (let value = start; value <= stop; value += stride) {
-      values.push(Math.round(value));
+      values.push(value);
     }
     return values;
   }
   const params = step.model?.params ?? {};
-  return [Math.max(1, Math.round(numberParam(params.n_components, 2)))];
+  return [integerParam(params.n_components, 2, 'n_components', { min: 1 })];
+}
+
+function numberParam(value, fallback, label) {
+  if (value == null) {
+    return fallback;
+  }
+  let n;
+  if (typeof value === 'number') {
+    n = value;
+  } else if (typeof value === 'string' && value.trim() !== '') {
+    n = Number(value);
+  } else {
+    throw new TypeError(`${label} must be numeric.`);
+  }
+  if (!Number.isFinite(n)) {
+    throw new RangeError(`${label} must be finite.`);
+  }
+  return n;
 }
 
-function numberParam(value, fallback) {
-  const n = Number(value);
-  return Number.isFinite(n) ? n : fallback;
+function integerParam(value, fallback, label, options = {}) {
+  const n = numberParam(value, fallback, label);
+  if (!Number.isInteger(n)) {
+    throw new RangeError(`${label} must be an integer.`);
+  }
+  if (options.min != null && n < options.min) {
+    throw new RangeError(`${label} must be >= ${options.min}.`);
+  }
+  return n;
 }
 
 function rmse(predictions, targets) {

package/src/index.js

@@ -28,7 +28,7 @@ export const upstreams = Object.freeze([
   },
   {
     key: 'methods',
-    candidates: ['@nirs4all/methods-wasm'],
+    candidates: ['@nirs4all/methods'],
     role: 'Portable C ABI PLS/NIRS numerical engine',
   },
 ]);
@@ -213,8 +213,8 @@ function importUpstreamCandidate(candidate) {
       return import('@nirs4all/datasets-wasm');
     case '@nirs4all/nirs4all-datasets-wasm':
       return import('@nirs4all/nirs4all-datasets-wasm');
-    case '@nirs4all/methods-wasm':
-      return import('@nirs4all/methods-wasm');
+    case '@nirs4all/methods':
+      return import('@nirs4all/methods');
     default:
       return import(candidate);
   }