@dpuse/dpuse-tool-streamparser-json-parser 1.0.3 → 1.0.4

package/dist/shipped-packages.json

@@ -1,6 +1,6 @@
 {
     "packages": [
-        "@dpuse/dpuse-shared@1.0.214",
+        "@dpuse/dpuse-shared@1.0.216",
         "@streamparser/json@0.0.26",
         "valibot@1.5.0"
     ],

package/dist/types/src/index.d.ts

@@ -1,24 +1,28 @@
 import { BuildStructureIndexOptions, ListStructureEntriesOptions, ListStructureEntriesResult, ParsedRecordsChunk, ParseStreamOptions, ParseStreamSummary, ParseTextOptions, ParseTextResult, StructuredParserInterface, StructureIndex } from '@dpuse/dpuse-shared';
 export declare class Tool implements StructuredParserInterface {
     /**
-     * Build structure index. Reads the whole item once and maps its lists and objects down to 'maxDepth', with where
-     * each starts and ends, so any of them can be read again on its own. Memory stays small however large the item.
+     * Build structure index. Maps the lists and objects of the item, or of its start for a preview, with a locator for
+     * each, so any of them can be read again on its own. Suggests the list to read as the table when there is only one.
+     * A syntax error ends the map early and is reported in it. Memory stays small however large the item.
      */
     buildStructureIndex(stream: ReadableStream<Uint8Array>, options: BuildStructureIndexOptions): Promise<StructureIndex>;
     /**
-     * List structure entries. Lists one level of a list or object for a viewer that opens one level at a time. Reading
-     * stops as soon as the entries asked for are known, so a page near the start of a large node is quick.
+     * List structure entries. Lists one page of a list or object for a viewer that opens one level at a time, and says
+     * where the next page starts. Reading stops as soon as the page is known, so a page near the start of a large node is
+     * quick.
      */
     listStructureEntries(stream: ReadableStream<Uint8Array>, options: ListStructureEntriesOptions): Promise<ListStructureEntriesResult>;
     /**
-     * Parse stream. Reads the list at 'structurePath', or the whole item when it is not given, as rows: a header of
-     * column names, then one row per item. The columns are those found in the first chunk of items. A later item with a
-     * field outside them keeps its other fields and counts as not uniform. The caller owns the stream and its fetch.
+     * Parse stream. Reads the list at 'structurePath', or at the top of the item when it is not given, as rows: a header
+     * of column names, then one row per item. The columns are those found in the first chunk of items. A later item with
+     * a field outside them keeps its other fields and counts as not uniform. Stops between items at 'byteLimit' or when
+     * 'stopSignal' fires. Fails on a syntax error, naming its line and column. The caller owns the stream and its fetch.
      */
     parseStream(stream: ReadableStream<Uint8Array>, options: ParseStreamOptions): AsyncGenerator<ParsedRecordsChunk, ParseStreamSummary, undefined>;
     /**
      * Parse text. Reads a preview the same way as 'parseStream'. A preview cut short ends in the middle of the JSON, so
-     * only an error in a complete item is an issue. The items read before the cut are kept.
+     * only an error in what was read is an issue, and the items read before the cut are kept. In JSON Lines each line is
+     * read on its own, so a line that cannot be read is an issue and the lines after it are still read.
      */
     parseText(text: string, options: ParseTextOptions): Promise<ParseTextResult>;
 }

package/dist/types/src/itemRecords.d.ts

@@ -9,7 +9,7 @@ export interface TableShape {
     columnIndexes: Map<string, number>;
     columnNames: string[];
 }
-export declare function createItemReader(targetPath: StructurePath, onItem: (item: JsonValue) => void): ItemReader;
+export declare function createItemReader(targetPath: StructurePath, onItem: (item: JsonValue, endOffset: number) => void): ItemReader;
 export declare function flattenItem(item: JsonValue): Map<string, JsonValue>;
 export declare function constructTableShape(itemFields: Map<string, JsonValue>[]): TableShape;
 export declare function constructHeaderRecord(shape: TableShape): ParsedRecord;

package/dist/types/src/structureWalker.d.ts

@@ -1,14 +1,18 @@
 import { StructureContainerKindId, StructureKindId, StructurePath } from '@dpuse/dpuse-shared';
 export interface StructureWalker {
+    byteCount: () => number;
     end: () => void;
     write: (input: Uint8Array) => void;
 }
 export interface StructureWalkerOptions {
     baseOffset: number;
-    firstItemIndex: number;
     isJsonLines: boolean;
-    isStartInsideList: boolean;
     rootPath: StructurePath;
+    startInside: StartInside | undefined;
+}
+export interface StartInside {
+    firstIndex: number;
+    kindId: StructureContainerKindId;
 }
 export interface StructureWalkerHandlers {
     onContainerEnd?: (container: OpenContainer, endOffset: number) => void;
@@ -45,7 +49,11 @@ export type JsonScalar = boolean | NumberText | string | null;
 export type JsonValue = JsonScalar | JsonValue[] | {
     [key: string]: JsonValue;
 };
+export interface StructureError extends Error {
+    offset: number;
+}
 export declare function createStructureWalker(options: StructureWalkerOptions, handlers: StructureWalkerHandlers): StructureWalker;
 export declare function isNumberText(value: unknown): value is NumberText;
+export declare function isStructureError(error: unknown): error is StructureError;
 export declare function stringifyJsonValue(value: JsonValue): string;
 export {};

package/dist/types/src/textPosition.d.ts

@@ -0,0 +1,11 @@
+export interface PositionTracker {
+    locate: (offset: number) => TextPosition;
+    take: (bytes: Uint8Array, startOffset: number) => void;
+}
+export interface TextPosition {
+    columnNumber: number | undefined;
+    excerpt: string;
+    lineNumber: number | undefined;
+}
+export declare function createPositionTracker(isFromTop: boolean): PositionTracker;
+export declare function countLineFeeds(bytes: Uint8Array): number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dpuse/dpuse-tool-streamparser-json-parser",
-    "version": "1.0.3",
+    "version": "1.0.4",
     "private": false,
     "description": "Reads JSON and JSON Lines as a stream, and maps their structure for browsing and choosing tables.",
     "license": "MIT",
@@ -60,7 +60,7 @@
         "test": "node -e \"import('@dpuse/dpuse-development').then(m => m.testProject())\""
     },
     "dependencies": {
-        "@dpuse/dpuse-shared": "^1.0.214",
+        "@dpuse/dpuse-shared": "^1.0.216",
         "@streamparser/json": "^0.0.26"
     },
     "devDependencies": {