@flattype/shared 1.9.0 → 1.11.0

package/dist/index.d.cts

@@ -5,6 +5,10 @@ type JsonValue = JsonPrimitive | JsonValue[] | {
 };
 /** Cell separator for inline arrays and table rows. */
 type Delimiter = "," | "|" | "\t";
+/** Like the `JSON.stringify` replacer: called with `this` set to the holder of each key. */
+type Replacer = (this: any, key: string, value: any) => any;
+/** Like the `JSON.parse` reviver: called bottom-up with `this` set to the holder of each key. */
+type Reviver = (this: any, key: string, value: any) => any;
 interface EncodeOptions {
     /** Separator for inline arrays and table rows. Default `","`. */
     delimiter?: Delimiter;
@@ -12,10 +16,35 @@ interface EncodeOptions {
     indent?: number;
     /** `"auto"` writes arrays of same-shaped objects as tables (header once, then rows). Default `"auto"`. */
     tabular?: "auto" | "off";
+    /**
+     * A function that can change or drop (`undefined`) each value, or a list of the object keys to keep,
+     * exactly like the second argument of `JSON.stringify`.
+     */
+    replacer?: Replacer | (string | number)[];
+    /**
+     * Write an object that appears more than once (a shared object or a cycle) only once, and
+     * `path = first.path` where it appears again. Without it, shared objects are repeated and cycles throw.
+     * Default `false`.
+     */
+    refs?: boolean;
 }
 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;
+    /** Called for every value after decoding, bottom-up, exactly like the second argument of `JSON.parse`. */
+    reviver?: Reviver;
+    /**
+     * Accept `path = other.path` references and rebuild the shared objects and cycles they describe.
+     * Off by default: a few reference lines can describe a graph that is huge or endless when walked, so only
+     * turn it on for text you trust or code that handles cycles. Without it, a reference is an error
+     * (strict) or skipped (lenient).
+     */
+    refs?: boolean;
 }
 /** A leaf in a flattened record: a primitive, or an empty object/array that has no leaves of its own. */
 type FlatLeaf = JsonPrimitive | Record<string, never> | never[];
@@ -41,4 +70,4 @@ interface Decoder {
     end(): JsonValue;
 }
 
-export type { DecodeOptions, Decoder, DecoderOptions, Delimiter, EncodeOptions, FlatLeaf, FlatRecord, JsonPrimitive, JsonValue, TableRow };
+export type { DecodeOptions, Decoder, DecoderOptions, Delimiter, EncodeOptions, FlatLeaf, FlatRecord, JsonPrimitive, JsonValue, Replacer, Reviver, TableRow };

package/dist/index.d.ts

@@ -5,6 +5,10 @@ type JsonValue = JsonPrimitive | JsonValue[] | {
 };
 /** Cell separator for inline arrays and table rows. */
 type Delimiter = "," | "|" | "\t";
+/** Like the `JSON.stringify` replacer: called with `this` set to the holder of each key. */
+type Replacer = (this: any, key: string, value: any) => any;
+/** Like the `JSON.parse` reviver: called bottom-up with `this` set to the holder of each key. */
+type Reviver = (this: any, key: string, value: any) => any;
 interface EncodeOptions {
     /** Separator for inline arrays and table rows. Default `","`. */
     delimiter?: Delimiter;
@@ -12,10 +16,35 @@ interface EncodeOptions {
     indent?: number;
     /** `"auto"` writes arrays of same-shaped objects as tables (header once, then rows). Default `"auto"`. */
     tabular?: "auto" | "off";
+    /**
+     * A function that can change or drop (`undefined`) each value, or a list of the object keys to keep,
+     * exactly like the second argument of `JSON.stringify`.
+     */
+    replacer?: Replacer | (string | number)[];
+    /**
+     * Write an object that appears more than once (a shared object or a cycle) only once, and
+     * `path = first.path` where it appears again. Without it, shared objects are repeated and cycles throw.
+     * Default `false`.
+     */
+    refs?: boolean;
 }
 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;
+    /** Called for every value after decoding, bottom-up, exactly like the second argument of `JSON.parse`. */
+    reviver?: Reviver;
+    /**
+     * Accept `path = other.path` references and rebuild the shared objects and cycles they describe.
+     * Off by default: a few reference lines can describe a graph that is huge or endless when walked, so only
+     * turn it on for text you trust or code that handles cycles. Without it, a reference is an error
+     * (strict) or skipped (lenient).
+     */
+    refs?: boolean;
 }
 /** A leaf in a flattened record: a primitive, or an empty object/array that has no leaves of its own. */
 type FlatLeaf = JsonPrimitive | Record<string, never> | never[];
@@ -41,4 +70,4 @@ interface Decoder {
     end(): JsonValue;
 }
 
-export type { DecodeOptions, Decoder, DecoderOptions, Delimiter, EncodeOptions, FlatLeaf, FlatRecord, JsonPrimitive, JsonValue, TableRow };
+export type { DecodeOptions, Decoder, DecoderOptions, Delimiter, EncodeOptions, FlatLeaf, FlatRecord, JsonPrimitive, JsonValue, Replacer, Reviver, TableRow };

package/package.json

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