@flattype/shared 1.0.0 → 1.2.0

package/dist/index.d.cts

@@ -21,5 +21,24 @@ interface DecodeOptions {
 type FlatLeaf = JsonPrimitive | Record<string, never> | never[];
 /** Path → leaf, e.g. `{ "user.name": "John", "tags[0]": "a" }`. */
 type FlatRecord = Record<string, FlatLeaf>;
+/** One table row, passed to `onRow` as soon as its line has been read. */
+interface TableRow {
+    /** Path of the table, e.g. `"users"` or `"data.items"`; `""` for a root table. */
+    path: string;
+    /** Row number within the table, from 0. */
+    index: number;
+    value: JsonValue;
+}
+interface DecoderOptions extends DecodeOptions {
+    onRow?: (row: TableRow) => void;
+    /** Keep rows in the decoded result. `false` passes them only to `onRow`. Default `true`. */
+    keepRows?: boolean;
+}
+interface Decoder {
+    /** Feeds the next chunk of text. Chunks may split lines anywhere. */
+    write(chunk: string): void;
+    /** Finishes decoding and returns the value. */
+    end(): JsonValue;
+}
 
-export type { DecodeOptions, Delimiter, EncodeOptions, FlatLeaf, FlatRecord, JsonPrimitive, JsonValue };
+export type { DecodeOptions, Decoder, DecoderOptions, Delimiter, EncodeOptions, FlatLeaf, FlatRecord, JsonPrimitive, JsonValue, TableRow };

package/dist/index.d.ts

@@ -21,5 +21,24 @@ interface DecodeOptions {
 type FlatLeaf = JsonPrimitive | Record<string, never> | never[];
 /** Path → leaf, e.g. `{ "user.name": "John", "tags[0]": "a" }`. */
 type FlatRecord = Record<string, FlatLeaf>;
+/** One table row, passed to `onRow` as soon as its line has been read. */
+interface TableRow {
+    /** Path of the table, e.g. `"users"` or `"data.items"`; `""` for a root table. */
+    path: string;
+    /** Row number within the table, from 0. */
+    index: number;
+    value: JsonValue;
+}
+interface DecoderOptions extends DecodeOptions {
+    onRow?: (row: TableRow) => void;
+    /** Keep rows in the decoded result. `false` passes them only to `onRow`. Default `true`. */
+    keepRows?: boolean;
+}
+interface Decoder {
+    /** Feeds the next chunk of text. Chunks may split lines anywhere. */
+    write(chunk: string): void;
+    /** Finishes decoding and returns the value. */
+    end(): JsonValue;
+}
 
-export type { DecodeOptions, Delimiter, EncodeOptions, FlatLeaf, FlatRecord, JsonPrimitive, JsonValue };
+export type { DecodeOptions, Decoder, DecoderOptions, Delimiter, EncodeOptions, FlatLeaf, FlatRecord, JsonPrimitive, JsonValue, TableRow };

package/package.json

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