@flattype/shared 1.10.0 → 1.12.0

package/dist/index.d.cts

@@ -28,9 +28,26 @@ interface EncodeOptions {
      */
     refs?: boolean;
 }
+/** A problem lenient decoding repaired, and where it was. */
+interface FlatWarning {
+    /** What was wrong and what was done, e.g. `Expected 5 values, got 4: the missing values are null`. */
+    message: string;
+    line: number;
+    column: number;
+}
 interface DecodeOptions {
     /** Throw on malformed input (default). Set `false` to recover what it can, e.g. from LLM output. */
     strict?: boolean;
+    /**
+     * With `strict: false`: drop any line that can't be read (prose around data, a path that conflicts) as if
+     * it weren't there, instead of throwing. That's what `fromModelOutput` uses. Default `false`.
+     */
+    skipInvalidLines?: boolean;
+    /**
+     * With `strict: false`: called for every problem that was repaired (a missing value, a short row, a skipped
+     * line…), with its line and column, so you can tell the user where the data is wrong.
+     */
+    onWarning?: (warning: FlatWarning) => void;
     /** Called for every value after decoding, bottom-up, exactly like the second argument of `JSON.parse`. */
     reviver?: Reviver;
     /**
@@ -65,4 +82,4 @@ interface Decoder {
     end(): JsonValue;
 }
 
-export type { DecodeOptions, Decoder, DecoderOptions, Delimiter, EncodeOptions, FlatLeaf, FlatRecord, JsonPrimitive, JsonValue, Replacer, Reviver, TableRow };
+export type { DecodeOptions, Decoder, DecoderOptions, Delimiter, EncodeOptions, FlatLeaf, FlatRecord, FlatWarning, JsonPrimitive, JsonValue, Replacer, Reviver, TableRow };

package/dist/index.d.ts

@@ -28,9 +28,26 @@ interface EncodeOptions {
      */
     refs?: boolean;
 }
+/** A problem lenient decoding repaired, and where it was. */
+interface FlatWarning {
+    /** What was wrong and what was done, e.g. `Expected 5 values, got 4: the missing values are null`. */
+    message: string;
+    line: number;
+    column: number;
+}
 interface DecodeOptions {
     /** Throw on malformed input (default). Set `false` to recover what it can, e.g. from LLM output. */
     strict?: boolean;
+    /**
+     * With `strict: false`: drop any line that can't be read (prose around data, a path that conflicts) as if
+     * it weren't there, instead of throwing. That's what `fromModelOutput` uses. Default `false`.
+     */
+    skipInvalidLines?: boolean;
+    /**
+     * With `strict: false`: called for every problem that was repaired (a missing value, a short row, a skipped
+     * line…), with its line and column, so you can tell the user where the data is wrong.
+     */
+    onWarning?: (warning: FlatWarning) => void;
     /** Called for every value after decoding, bottom-up, exactly like the second argument of `JSON.parse`. */
     reviver?: Reviver;
     /**
@@ -65,4 +82,4 @@ interface Decoder {
     end(): JsonValue;
 }
 
-export type { DecodeOptions, Decoder, DecoderOptions, Delimiter, EncodeOptions, FlatLeaf, FlatRecord, JsonPrimitive, JsonValue, Replacer, Reviver, TableRow };
+export type { DecodeOptions, Decoder, DecoderOptions, Delimiter, EncodeOptions, FlatLeaf, FlatRecord, FlatWarning, JsonPrimitive, JsonValue, Replacer, Reviver, TableRow };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flattype/shared",
-  "version": "1.10.0",
+  "version": "1.12.0",
   "description": "Shared TypeScript contracts for FlatType.js",
   "license": "MIT",
   "type": "module",