@dpuse/dpuse-tool-streamparser-json-parser 0.0.0-stage → 1.0.1

package/dist/shipped-packages.json

@@ -0,0 +1,8 @@
+{
+    "packages": [
+        "@dpuse/dpuse-shared@1.0.214",
+        "@streamparser/json@0.0.26",
+        "valibot@1.5.0"
+    ],
+    "external": []
+}

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

@@ -0,0 +1,24 @@
+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.
+     */
+    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.
+     */
+    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.
+     */
+    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.
+     */
+    parseText(text: string, options: ParseTextOptions): Promise<ParseTextResult>;
+}

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

@@ -0,0 +1,19 @@
+import { ParsedRecord, StructurePath } from '@dpuse/dpuse-shared';
+import { JsonValue, StructureWalkerHandlers } from './structureWalker';
+export interface ItemReader {
+    handlers: StructureWalkerHandlers;
+    isTargetClosed: () => boolean;
+    isTargetFound: () => boolean;
+}
+export interface TableShape {
+    columnIndexes: Map<string, number>;
+    columnNames: string[];
+}
+export declare function createItemReader(targetPath: StructurePath, onItem: (item: JsonValue) => 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;
+export declare function constructRecord(fields: Map<string, JsonValue>, shape: TableShape): {
+    hasUnknownField: boolean;
+    record: ParsedRecord;
+};

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

@@ -0,0 +1,51 @@
+import { StructureContainerKindId, StructureKindId, StructurePath } from '@dpuse/dpuse-shared';
+export interface StructureWalker {
+    end: () => void;
+    write: (input: Uint8Array) => void;
+}
+export interface StructureWalkerOptions {
+    baseOffset: number;
+    firstItemIndex: number;
+    isJsonLines: boolean;
+    isStartInsideList: boolean;
+    rootPath: StructurePath;
+}
+export interface StructureWalkerHandlers {
+    onContainerEnd?: (container: OpenContainer, endOffset: number) => void;
+    onContainerStart?: (container: OpenContainer) => void;
+    onKey?: (container: OpenContainer, key: string) => void;
+    onScalar?: (scalar: ScalarEntry) => void;
+    onTokenStart?: (offset: number) => void;
+}
+export interface OpenContainer {
+    childCount: number;
+    depth: number;
+    isVirtual: boolean;
+    key: EntryKey;
+    kindId: StructureContainerKindId;
+    parent: OpenContainer | undefined;
+    path: StructurePath;
+    pendingKey: string | undefined;
+    positionId: PositionId;
+    startOffset: number;
+}
+export type EntryKey = number | string | undefined;
+type PositionId = 'afterColon' | 'afterComma' | 'afterKey' | 'afterValue' | 'start';
+export interface ScalarEntry {
+    key: EntryKey;
+    kindId: Exclude<StructureKindId, StructureContainerKindId>;
+    parent: OpenContainer | undefined;
+    startOffset: number;
+    value: JsonScalar;
+}
+export interface NumberText {
+    readonly numberText: string;
+}
+export type JsonScalar = boolean | NumberText | string | null;
+export type JsonValue = JsonScalar | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+export declare function createStructureWalker(options: StructureWalkerOptions, handlers: StructureWalkerHandlers): StructureWalker;
+export declare function isNumberText(value: unknown): value is NumberText;
+export declare function stringifyJsonValue(value: JsonValue): string;
+export {};

package/package.json

@@ -1,6 +1,80 @@
 {
-  "name": "@dpuse/dpuse-tool-streamparser-json-parser",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+    "name": "@dpuse/dpuse-tool-streamparser-json-parser",
+    "version": "1.0.1",
+    "private": false,
+    "description": "Reads JSON and JSON Lines as a stream, and maps their structure for browsing and choosing tables.",
+    "license": "MIT",
+    "author": "Jonathan Terrell <terrell.jm@gmail.com>",
+    "type": "module",
+    "sideEffects": false,
+    "homepage": "https://www.dpuse.app",
+    "bugs": {
+        "url": "https://github.com/dpuse/dpuse-tool-streamparser-json-parser/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/dpuse/dpuse-tool-streamparser-json-parser.git"
+    },
+    "module": "./dist/dpuse-tool-streamparser-json-parser.es.js",
+    "types": "./dist/types/src/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/types/src/index.d.ts",
+            "import": "./dist/dpuse-tool-streamparser-json-parser.es.js"
+        }
+    },
+    "files": [
+        "dist"
+    ],
+    "engines": {
+        "node": ">=24",
+        "npm": ">=12"
+    },
+    "devEngines": {
+        "runtime": {
+            "name": "node",
+            "version": ">=24",
+            "onFail": "error"
+        },
+        "packageManager": {
+            "name": "npm",
+            "version": ">=12",
+            "onFail": "error"
+        }
+    },
+    "prettier": "@dpuse/dpuse-development/prettierrc",
+    "allowScripts": {
+        "fsevents@2.3.3": true,
+        "esbuild@0.28.2": true,
+        "workerd@1.20261110.1": true
+    },
+    "scripts": {
+        "audit": "node -e \"import('@dpuse/dpuse-development').then(m => m.auditDependencies())\"",
+        "build": "node -e \"import('@dpuse/dpuse-development').then(m => m.buildProject())\"",
+        "check": "node -e \"import('@dpuse/dpuse-development').then(m => m.checkProject())\"",
+        "document": "node -e \"import('@dpuse/dpuse-development').then(m => m.documentProject('MIT'))\"",
+        "format": "node -e \"import('@dpuse/dpuse-development').then(m => m.formatCode())\"",
+        "lint": "node -e \"import('@dpuse/dpuse-development').then(m => m.lintCode())\"",
+        "release": "npm run build && npm run document && npm run sync && node -e \"import('@dpuse/dpuse-development').then(m => m.triggerGitHubRelease())\"",
+        "sync": "node -e \"import('@dpuse/dpuse-development').then(m => m.syncProjectWithGitHub())\"",
+        "test": "node -e \"import('@dpuse/dpuse-development').then(m => m.testProject())\""
+    },
+    "dependencies": {
+        "@dpuse/dpuse-shared": "^1.0.214",
+        "@streamparser/json": "^0.0.26"
+    },
+    "devDependencies": {
+        "@dpuse/dpuse-development": "^1.0.149",
+        "@dpuse/eslint-config-dpuse": "^1.0.150",
+        "@types/node": "^26.6.6",
+        "@vitest/coverage-v8": "^5.1.0",
+        "eslint": "^10.14.0",
+        "prettier": "^3.10.1",
+        "sonda": "^0.14.0",
+        "typescript": "^6.0.3",
+        "vite": "^8.3.8",
+        "vite-plugin-dts": "^5.1.2",
+        "vitest": "^5.1.0",
+        "wrangler": "^4.161.0"
+    }
+}