@nirs4all/io-wasm 0.1.11 → 0.1.13

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,82 @@
+# Third-Party Notices — nirs4all-io
+
+`nirs4all-io` is distributed under `CeCILL-2.1 OR AGPL-3.0-or-later` (plus an optional
+commercial license; see [`LICENSING.md`](LICENSING.md)). It relies on the third-party
+open-source components listed below.
+
+The distribution model differs by surface and must not be described as uniformly
+"unvendored":
+
+- the pure-Python compatibility package installs its Python dependencies separately;
+- Rust executables, native libraries, Python wheels, and WASM packages contain compiled
+  Rust dependencies from the exact closure pinned by `Cargo.lock` (or the binding lock);
+- the R source package deliberately vendors that Rust source closure for an offline CRAN
+  build. Its `src/rust/vendor.tar.xz` retains every upstream crate's own license and notice
+  files.
+
+The release CycloneDX SBOM is the machine-readable component/version/license inventory for
+the shipped Rust closure. `Cargo.lock`, `bindings/python/Cargo.lock`,
+`bindings/wasm/Cargo.lock`, and `bindings/r/Cargo.lock.rust` are the authoritative version
+locks. This notice summarizes direct runtime dependencies; it does not replace the
+transitive inventory, upstream notices in the R vendor bundle, or the SBOM.
+
+The staged WASM npm package includes `nirs4all-io-wasm.cdx.json`, a deterministic
+CycloneDX 1.6 document generated from `cargo metadata --locked --offline`. It records
+the exact Cargo components, licenses, purls, dependency graph, and source commit/tree;
+it deliberately contains no timestamp, UUID, or local build path.
+
+## Python runtime dependencies
+
+| Component | License (SPDX) | Copyright | Upstream |
+|---|---|---|---|
+| `numpy` | BSD-3-Clause | Copyright (c) 2005-2025, NumPy Developers | https://github.com/numpy/numpy |
+| `pandas` | BSD-3-Clause | Copyright (c) 2008-2025, pandas Development Team | https://github.com/pandas-dev/pandas |
+| `pyyaml` | MIT | Copyright (c) 2006-2025 PyYAML contributors | https://github.com/yaml/pyyaml |
+| `jsonschema` | MIT | Copyright (c) 2013 Julian Berman | https://github.com/python-jsonschema/jsonschema |
+
+## Rust runtime dependencies
+
+| Component | License expression | Upstream |
+|---|---|---|
+| `dag-ml-data` | `CeCILL-2.1 OR AGPL-3.0-or-later` | https://github.com/GBeurier/dag-ml-data |
+| `serde`, `serde_json` | `MIT OR Apache-2.0` | https://github.com/serde-rs |
+| `thiserror`, `anyhow` | `MIT OR Apache-2.0` | https://github.com/dtolnay |
+| `sha2` | `MIT OR Apache-2.0` | https://github.com/RustCrypto/hashes |
+| `regex` | `MIT OR Apache-2.0` | https://github.com/rust-lang/regex |
+| `toml` | `MIT OR Apache-2.0` | https://github.com/toml-rs/toml |
+| `indexmap` | `Apache-2.0 OR MIT` | https://github.com/indexmap-rs/indexmap |
+| `csv` | `Unlicense OR MIT` | https://github.com/BurntSushi/rust-csv |
+| `ryu` (transitive through `csv`) | `Apache-2.0` selected from `Apache-2.0 OR BSL-1.0` | https://github.com/dtolnay/ryu |
+| `glob` | `MIT OR Apache-2.0` | https://github.com/rust-lang/glob |
+| `flate2` | `MIT OR Apache-2.0` | https://github.com/rust-lang/flate2-rs |
+| `zip` | `MIT` | https://github.com/zip-rs/zip2 |
+| Apache Arrow Rust (`arrow-*`, `parquet`) | `Apache-2.0` and, for `arrow-array`, `Apache-2.0 AND MIT` | https://github.com/apache/arrow-rs |
+| `clap` | `MIT OR Apache-2.0` | https://github.com/clap-rs/clap |
+| `wasm-bindgen`, `js-sys` | `MIT OR Apache-2.0` | https://github.com/wasm-bindgen/wasm-bindgen |
+| `unicode-ident` (transitive build/runtime support) | `MIT AND Unicode-3.0` selected from `(MIT OR Apache-2.0) AND Unicode-3.0` | https://github.com/dtolnay/unicode-ident |
+
+## Bundled license-family texts (`LICENSES/`)
+
+- `LICENSES/Apache-2.0.txt` — Apache-2.0
+- `LICENSES/BSD-3-Clause.txt` — BSD-3-Clause
+- `LICENSES/MIT.txt` — MIT
+- `LICENSES/Unicode-3.0.txt` — Unicode-3.0
+
+Binary distributions select the MIT branch for dependencies offered as
+`MIT OR Apache-2.0` or `Unlicense OR MIT`; consequently a separate Unlicense text
+is not required. They select the Apache-2.0 branch for `ryu 1.0.23`, so BSL-1.0
+does not apply to this distribution. The canonical Apache text was imported from
+the exact locked `ryu-1.0.23.crate` (crate SHA-256
+`9774ba4a74de5f7b1c1451ed6cd5285a32eddb5cccb8cc655a4e50009e06477f`;
+license-text SHA-256
+`62c7a1e35f56406896d7aa7ca52d0cc0d272ac022b5d2796e7d6905db8a3636a`).
+The mandatory Unicode-3.0 branch for `unicode-ident 1.0.24` is likewise copied
+from its exact locked crate (crate SHA-256
+`e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75`;
+license-text SHA-256
+`f7db81051789b729fea528a63ec4c938fdcb93d9d61d97dc8cc2e9df6d47f2a1`).
+
+Additional license families and copyright notices in the transitive Rust closure are
+preserved in the upstream crate sources inside the self-contained R vendor archive and are
+enumerated in the CycloneDX SBOM. Binary redistributors must ship this notice, the release
+SBOM, and the applicable upstream license files together with the binary artifact.

package/idiomatic.d.ts

@@ -0,0 +1,58 @@
+// SPDX-License-Identifier: CeCILL-2.1 OR AGPL-3.0-or-later
+//
+// Types for the idiomatic ESM wrapper (idiomatic.mjs).
+
+import type {
+  NamedFile,
+  RecordSet,
+  InferOptions,
+  ProposeOptions,
+  DatasetPlan,
+  DatasetSpec,
+  ProposeResult,
+  AssembledDataset,
+} from "./types/nirs4all-io";
+
+export interface NioModule {
+  inferFiles(files: NamedFile[], options?: InferOptions): DatasetPlan;
+  inferRecords(recordSets: RecordSet[]): DatasetPlan;
+  inferDataset(files: NamedFile[], recordSets: RecordSet[], options?: InferOptions): DatasetPlan;
+  proposeDataset(files: NamedFile[], recordSets: RecordSet[], options?: ProposeOptions): ProposeResult;
+  assembleDataset(files: NamedFile[], recordSets: RecordSet[], spec: DatasetSpec | string): AssembledDataset;
+  version(): string;
+  /** Native-JS convenience: spec object/string in, canonical spec OBJECT out. */
+  toSpec(spec: DatasetSpec | Record<string, unknown> | string): DatasetSpec;
+  /** Native-JS convenience: spec object/string in; throws when invalid. */
+  validateSpec(spec: DatasetSpec | Record<string, unknown> | string): void;
+  /** Raw string-JSON surface (cross-binding contract). */
+  to_spec(specJson: string): string;
+  validate(specJson: string): void;
+}
+
+/** Build the idiomatic surface around a wasm-pack module instance. */
+export function wrap(m: unknown): NioModule;
+
+export const inferFiles: NioModule["inferFiles"];
+export const inferRecords: NioModule["inferRecords"];
+export const inferDataset: NioModule["inferDataset"];
+export const proposeDataset: NioModule["proposeDataset"];
+export const assembleDataset: NioModule["assembleDataset"];
+export const version: NioModule["version"];
+export const toSpec: NioModule["toSpec"];
+export const validateSpec: NioModule["validateSpec"];
+export const to_spec: NioModule["to_spec"];
+export const validate: NioModule["validate"];
+
+declare const nio: NioModule;
+export default nio;
+
+export type {
+  NamedFile,
+  RecordSet,
+  InferOptions,
+  ProposeOptions,
+  DatasetPlan,
+  DatasetSpec,
+  ProposeResult,
+  AssembledDataset,
+};

package/idiomatic.mjs

@@ -0,0 +1,65 @@
+// SPDX-License-Identifier: CeCILL-2.1 OR AGPL-3.0-or-later
+//
+// Idiomatic ESM wrapper over the wasm-pack module. The raw exports
+// (`inferFiles` / `inferDataset` / `proposeDataset` / `inferRecords` /
+// `assembleDataset`) already return plain JS objects, so they are re-exported
+// unchanged. The string-JSON surface (`to_spec` / `validate`) gets a small
+// native-JS convenience: accept a spec OBJECT and return an OBJECT, doing the
+// JSON.stringify / JSON.parse for you. The raw string functions stay reachable
+// under their original names.
+//
+// Usage:
+//   import * as nio from "./idiomatic.mjs";   // resolves the generated module
+//   const plan = nio.inferFiles(files, { conventions: ["nirs4all-classic"] });
+//   const spec = nio.toSpec({ name: "run", sources: [...] });   // -> object
+//   nio.validateSpec(spec);                                     // throws if bad
+//
+// By default this imports the sibling `pkg/nirs4all_io_wasm.js` produced by
+//   wasm-pack build bindings/wasm --target nodejs --out-dir pkg
+// Pass a different module to `wrap()` to use another build/target.
+
+import * as defaultModule from "./nirs4all_io_wasm.js";
+
+/**
+ * Build the idiomatic surface around a wasm-pack module instance.
+ * @param {object} m the wasm-pack module (its raw exports)
+ */
+export function wrap(m) {
+  return {
+    // Raw, object-returning entry points — re-exported as-is.
+    inferFiles: (files, options) => m.inferFiles(files, options ?? {}),
+    inferRecords: (recordSets) => m.inferRecords(recordSets),
+    inferDataset: (files, recordSets, options) => m.inferDataset(files, recordSets, options ?? {}),
+    proposeDataset: (files, recordSets, options) => m.proposeDataset(files, recordSets, options ?? {}),
+    assembleDataset: (files, recordSets, spec) =>
+      m.assembleDataset(files, recordSets, typeof spec === "string" ? spec : JSON.stringify(spec)),
+    version: () => m.version(),
+
+    // Native-JS conveniences over the string-JSON surface.
+    /** Normalize a spec object (or JSON string) into a canonical spec OBJECT. */
+    toSpec: (spec) => JSON.parse(m.to_spec(typeof spec === "string" ? spec : JSON.stringify(spec))),
+    /** Validate a spec object (or JSON string); throws when invalid. */
+    validateSpec: (spec) => m.validate(typeof spec === "string" ? spec : JSON.stringify(spec)),
+
+    // The raw string functions, unchanged, for the cross-binding JSON contract.
+    to_spec: m.to_spec,
+    validate: m.validate,
+  };
+}
+
+const nio = wrap(defaultModule);
+
+export const {
+  inferFiles,
+  inferRecords,
+  inferDataset,
+  proposeDataset,
+  assembleDataset,
+  version,
+  toSpec,
+  validateSpec,
+  to_spec,
+  validate,
+} = nio;
+
+export default nio;