laterite 0.1.0 → 0.5.0

package/index.d.ts

@@ -67,11 +67,12 @@ export interface GroupMeta {
   lineNumbers: Array<number>
 }
 /**
- * Parse an AGS4 file (`path`) or in-memory `text` into a `Reading` handle.
- * `encoding`: `"utf-8"` (default) / `"windows-1252"` / a label. Throws the
- * classified `kind␟code␟message` (see the error-protocol note) on bad input.
+ * Parse an AGS4 file (`path`), in-memory `text`, or raw `data` bytes into a
+ * `Reading` handle. `encoding`: `"utf-8"` (default) / `"windows-1252"` / a label
+ * — applies to `path` / `data` (text is already decoded). Throws the classified
+ * `kind␟code␟message` (see the error-protocol note) on bad input.
  */
-export declare function parseArrow(path?: string | undefined | null, text?: string | undefined | null, encoding?: string | undefined | null): Reading
+export declare function parseArrow(path?: string | undefined | null, text?: string | undefined | null, data?: Uint8Array | undefined | null, encoding?: string | undefined | null): Reading
 /** One rule violation (omitting `severity` ⇒ error, matching the engine). */
 export interface Finding {
   rule: string
@@ -85,7 +86,7 @@ export interface Finding {
  * `ok` is **false only for un-validatable input** (the TS `raiseFor` raises
  * then); rule *violations* come back in `findings` with `ok:true`. `Report`'s
  * `isValid` is the separate `count == 0`. `json`/`ndjson` are byte-identical
- * to `ags4-check --json` / `--ndjson`.
+ * to `lat-check --json` / `--ndjson`.
  */
 export interface ValidationReport {
   ok: boolean
@@ -96,7 +97,7 @@ export interface ValidationReport {
   errorKind?: string
   error?: string
   /**
-   * Mirrors the `ags4-check` binary: 0 valid / 1 findings on success;
+   * Mirrors the `lat-check` binary: 0 valid / 1 findings on success;
    * 3 not-found/io, 4 not-utf8/not-ags4/bad-edition, 5 bad-dict on failure.
    */
   exitCode: number
@@ -112,8 +113,56 @@ export interface ValidationReport {
  * Validate an AGS4 file (`path`) or `text` against the AGS4 rules. `dict_version`
  * `None`/`"auto"` auto-detects from `TRAN_AGS`, else forces an edition. Returns
  * the `{ok:false}` failure report (not a throw) for un-validatable input.
+ *
+ * Severity tiers track importance (like a compiler): errors **and WARNINGs** are
+ * returned by default (`includeWarnings` defaults to `true`); pass `false` for
+ * errors-only. `includeFyi` (default `false`) adds the low-signal FYI tier.
  */
-export declare function runCheck(path?: string | undefined | null, text?: string | undefined | null, dictVersion?: string | undefined | null, includeWarnings?: boolean | undefined | null, includeFyi?: boolean | undefined | null, checkFiles?: boolean | undefined | null, encoding?: string | undefined | null): ValidationReport
+export declare function runCheck(path?: string | undefined | null, text?: string | undefined | null, data?: Uint8Array | undefined | null, dictVersion?: string | undefined | null, includeWarnings?: boolean | undefined | null, includeFyi?: boolean | undefined | null, checkFiles?: boolean | undefined | null, encoding?: string | undefined | null): ValidationReport
+/**
+ * The AGS4 rule catalogue as the gated `rules_meta.json` — byte-identical to
+ * laterite-py's `list_rules()` and `lat-check --list-rules --json`. The TS
+ * layer parses it into typed `RuleMeta[]`. No input file.
+ */
+export declare function listRules(): string
+/**
+ * One applied fix — the Node mirror of laterite-py's `applied[]` entries.
+ * `kind`/`risk` are the serde snake_case strings (`strip_bom`, `safe`, …) so
+ * the shape is identical across Python / CLI / Node.
+ */
+export interface AppliedFix {
+  kind: string
+  label: string
+  rule: string
+  line?: number
+  risk: string
+}
+/**
+ * The repair report — the Node mirror of laterite-py's `fix_file` dict. `ok` is
+ * false only for un-fixable input (the TS layer raises then). `fixed` is the
+ * repaired bytes (the original verbatim when nothing applied); `residual` is
+ * what could *not* be mechanically fixed.
+ */
+export interface FixReport {
+  ok: boolean
+  errorKind?: string
+  error?: string
+  exitCode: number
+  fixed: Buffer
+  dictVersion: string
+  resolution: string
+  fixesApplied: number
+  applied: Array<AppliedFix>
+  residual: Array<Finding>
+}
+/**
+ * Mechanically repair an AGS4 file (`path`) / `text` / `data`: apply the SAFE
+ * fixes (plus the risky set when `includeRisky`), re-validate, and return the
+ * fixed bytes + residual findings. Mirrors laterite-py's `fix()` /
+ * `lat-check --fix`; the single `fix_document` orchestration is shared. The TS
+ * layer wraps this into a `FixResult` (`.bytes` / `.text` / `.save(path)`).
+ */
+export declare function fixFile(path?: string | undefined | null, text?: string | undefined | null, data?: Uint8Array | undefined | null, dictVersion?: string | undefined | null, encoding?: string | undefined | null, includeRisky?: boolean | undefined | null): FixReport
 /**
  * One group of columnar input — its code + an Arrow IPC stream (`Buffer`)
  * whose column names are the AGS headings.
@@ -133,12 +182,12 @@ export interface EmitResult {
 }
 /**
  * Build valid AGS4 from per-group **Arrow IPC** streams (the columnar
- * producer; the read boundary reversed). = `ags4-wasm`'s `to_ags4_ipc`.
+ * producer; the read boundary reversed). = `laterite-ags4-wasm`'s `to_ags4_ipc`.
  */
 export declare function emitAgs4FromIpc(groups: Array<GroupIpc>, edition?: string | undefined | null, mode?: string | undefined | null): EmitResult
 /**
  * A parsed AGS4 file held native-side — the Node analog of laterite-py's
- * `Reading` handle (and `ags4-wasm`'s `ParsedDataset`). Each group's typed
+ * `Reading` handle (and `laterite-ags4-wasm`'s `ParsedDataset`). Each group's typed
  * `RecordBatch` is built lazily on `tableIpc(code)` and dropped after the
  * bytes are returned, so peak residency is one batch.
  */
@@ -155,7 +204,7 @@ export declare class Reading {
   /**
    * One group's rows as an Arrow **IPC stream** (`Buffer`), columns already
    * correctly typed. The Node analog of the pyo3-arrow capsule: the typed
-   * columns come from the one shared emitter (`ags5_types::arrow_cols`), the
+   * columns come from the one shared emitter (`laterite_types::arrow_cols`), the
    * SAME casting Python/wasm use — so a file types byte-identically across
    * hosts. Returns `null` if the code isn't in the file.
    */

package/index.js

@@ -310,7 +310,7 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { canonicalType, displayHint, parseValue, transportPack, transportUnpack, transportLock, transportUnlock, version, Reading, parseArrow, runCheck, emitAgs4FromIpc } = nativeBinding
+const { canonicalType, displayHint, parseValue, transportPack, transportUnpack, transportLock, transportUnlock, version, Reading, parseArrow, runCheck, listRules, fixFile, emitAgs4FromIpc } = nativeBinding
 
 module.exports.canonicalType = canonicalType
 module.exports.displayHint = displayHint
@@ -323,4 +323,6 @@ module.exports.version = version
 module.exports.Reading = Reading
 module.exports.parseArrow = parseArrow
 module.exports.runCheck = runCheck
+module.exports.listRules = listRules
+module.exports.fixFile = fixFile
 module.exports.emitAgs4FromIpc = emitAgs4FromIpc

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "laterite",
-  "version": "0.1.0",
+  "version": "0.5.0",
   "description": "AGS4 geotechnical data for Node.js — read, validate, produce, and query (the Node port of the laterite Python toolkit, Rust-backed).",
   "license": "MIT",
   "author": "niko86",
@@ -77,9 +77,9 @@
     "apache-arrow": "^21.1.0"
   },
   "optionalDependencies": {
-    "@laterite/native-linux-x64-gnu": "0.1.0",
-    "@laterite/native-darwin-arm64": "0.1.0",
-    "@laterite/native-win32-x64-msvc": "0.1.0"
+    "@laterite/native-linux-x64-gnu": "0.5.0",
+    "@laterite/native-darwin-arm64": "0.5.0",
+    "@laterite/native-win32-x64-msvc": "0.5.0"
   },
   "peerDependencies": {
     "@duckdb/node-api": ">=1.5.0"