@loaders.gl/json 3.1.0-alpha.4 → 3.1.0-alpha.5

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export type { JSONLoaderOptions } from './json-loader';
+export { JSONLoader } from './json-loader';
+export { NDJSONLoader } from './ndjson-loader';
+export type { GeoJSONLoaderOptions as _GeoJSONLoaderOptions } from './geojson-loader';
+export { GeoJSONLoader as _GeoJSONLoader, GeoJSONWorkerLoader as _GeoJSONWorkerLoader } from './geojson-loader';
+export { default as _JSONPath } from './lib/jsonpath/jsonpath';
+export { default as _ClarinetParser } from './lib/clarinet/clarinet';

package/dist/json-loader.d.ts

@@ -0,0 +1,13 @@
+import type { LoaderWithParser, LoaderOptions } from '@loaders.gl/loader-utils';
+/**
+ * @param table -
+ * @param jsonpaths -
+ */
+export declare type JSONLoaderOptions = LoaderOptions & {
+    json?: {
+        shape?: 'row-table';
+        table?: false;
+        jsonpaths?: string[];
+    };
+};
+export declare const JSONLoader: LoaderWithParser;

package/dist/lib/clarinet/clarinet.d.ts

@@ -0,0 +1,40 @@
+export const EVENTS: string[];
+export default class ClarinetParser {
+    constructor(options?: {});
+    _initialize(options: any): void;
+    bufferCheckPosition: number | undefined;
+    q: string | undefined;
+    c: any;
+    p: any;
+    options: any;
+    closed: boolean | undefined;
+    closedRoot: boolean | undefined;
+    sawRoot: boolean | undefined;
+    tag: any;
+    error: any;
+    state: any;
+    stack: any[] | undefined;
+    position: number | undefined;
+    column: number | undefined;
+    line: number | undefined;
+    slashed: any;
+    unicodeI: any;
+    unicodeS: string | null | undefined;
+    depth: number | undefined;
+    onready: any;
+    onopenobject: any;
+    onkey: any;
+    oncloseobject: any;
+    onopenarray: any;
+    onclosearray: any;
+    onvalue: any;
+    onerror: any;
+    onend: any;
+    onchunkparsed: any;
+    _clearBuffers(): void;
+    end(): ClarinetParser;
+    resume(): ClarinetParser;
+    close(): any;
+    write(chunk: any): any;
+    textNode: string | undefined;
+}

package/dist/lib/jsonpath/jsonpath.d.ts

@@ -0,0 +1,31 @@
+/**
+ * A parser for a minimal subset of the jsonpath standard
+ * Full JSON path parsers for JS exist but are quite large (bundle size)
+ *
+ * Supports
+ *
+ *   `$.component.component.component`
+ */
+export default class JSONPath {
+    path: string[];
+    constructor(path?: JSONPath | string[] | string | null);
+    clone(): JSONPath;
+    toString(): string;
+    push(name: string): void;
+    pop(): string | undefined;
+    set(name: string): void;
+    equals(other: JSONPath): boolean;
+    /**
+     * Sets the value pointed at by path
+     * TODO - handle root path
+     * @param object
+     * @param value
+     */
+    setFieldAtPath(object: any, value: any): void;
+    /**
+     * Gets the value pointed at by path
+     * TODO - handle root path
+     * @param object
+     */
+    getFieldAtPath(object: any): any;
+}

package/dist/lib/parse-json-in-batches.d.ts

@@ -0,0 +1,3 @@
+import type { Batch } from '@loaders.gl/schema';
+import type { JSONLoaderOptions } from '../json-loader';
+export default function parseJSONInBatches(binaryAsyncIterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>, options: JSONLoaderOptions): AsyncIterable<Batch>;

package/dist/lib/parse-json.d.ts

@@ -0,0 +1,2 @@
+import type { JSONLoaderOptions } from '../json-loader';
+export default function parseJSONSync(jsonText: string, options: JSONLoaderOptions): any;

package/dist/lib/parse-ndjson-in-batches.d.ts

@@ -0,0 +1,3 @@
+import type { Batch } from '@loaders.gl/schema';
+import { LoaderOptions } from '@loaders.gl/loader-utils';
+export default function parseNDJSONInBatches(binaryAsyncIterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>, options?: LoaderOptions): AsyncIterable<Batch>;

package/dist/lib/parse-ndjson.d.ts

@@ -0,0 +1 @@
+export default function parseNDJSONSync(ndjsonText: string): any[];

package/dist/lib/parser/json-parser.d.ts

@@ -0,0 +1,17 @@
+import ClarinetParser from '../clarinet/clarinet';
+import JSONPath from '../jsonpath/jsonpath';
+export default class JSONParser {
+    jsonpath: JSONPath;
+    _parser?: ClarinetParser;
+    constructor();
+    reset(): void;
+    write(chunk: any): void;
+    close(): void;
+    _pushOrSet(value: any): void;
+    _openArray(newContainer?: never[]): void;
+    _closeArray(): void;
+    _openObject(newContainer?: {}): void;
+    _closeObject(): void;
+    _initializeParser(): void;
+    protected get parser(): ClarinetParser;
+}

package/dist/lib/parser/streaming-json-parser.d.ts

@@ -0,0 +1,37 @@
+import { default as JSONParser } from './json-parser';
+import JSONPath from '../jsonpath/jsonpath';
+/**
+ * The `StreamingJSONParser` looks for the first array in the JSON structure.
+ * and emits an array of chunks
+ */
+export default class StreamingJSONParser extends JSONParser {
+    private jsonPaths;
+    private streamingJsonPath;
+    private streamingArray;
+    private topLevelObject;
+    constructor(options?: {
+        [key: string]: any;
+    });
+    /**
+     * write REDEFINITION
+     * - super.write() chunk to parser
+     * - get the contents (so far) of "topmost-level" array as batch of rows
+     * - clear top-level array
+     * - return the batch of rows\
+     */
+    write(chunk: any): any[];
+    /**
+     * Returns a partially formed result object
+     * Useful for returning the "wrapper" object when array is not top level
+     * e.g. GeoJSON
+     */
+    getPartialResult(): object | null;
+    getStreamingJsonPath(): JSONPath | null;
+    getStreamingJsonPathAsString(): string | null;
+    getJsonPath(): JSONPath;
+    /**
+     * Checks is this.getJsonPath matches the jsonpaths provided in options
+     */
+    _matchJSONPath(): boolean;
+    _extendParser(): void;
+}

package/dist/ndjson-loader.d.ts

@@ -0,0 +1,2 @@
+import type { LoaderWithParser } from '@loaders.gl/loader-utils';
+export declare const NDJSONLoader: LoaderWithParser;

package/dist/workers/geojson-worker.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loaders.gl/json",
-  "version": "3.1.0-alpha.4",
+  "version": "3.1.0-alpha.5",
   "description": "Framework-independent loader for JSON and streaming JSON formats",
   "license": "MIT",
   "publishConfig": {
@@ -20,7 +20,7 @@
     "JSON stream",
     "JSON async iterator"
   ],
-  "types": "src/index.ts",
+  "types": "dist/index.d.ts",
   "main": "dist/es5/index.js",
   "module": "dist/esm/index.js",
   "sideEffects": false,
@@ -31,13 +31,14 @@
   ],
   "scripts": {
     "pre-build": "npm run build-bundle && npm run build-worker",
+    "post-build": "tsc",
     "build-bundle": "webpack --config ../../scripts/webpack/bundle.js",
     "build-worker": "webpack --entry ./src/workers/geojson-worker.ts --output ./dist/geojson-worker.js --config ../../scripts/webpack/worker.js"
   },
   "dependencies": {
-    "@loaders.gl/gis": "3.1.0-alpha.4",
-    "@loaders.gl/loader-utils": "3.1.0-alpha.4",
-    "@loaders.gl/schema": "3.1.0-alpha.4"
+    "@loaders.gl/gis": "3.1.0-alpha.5",
+    "@loaders.gl/loader-utils": "3.1.0-alpha.5",
+    "@loaders.gl/schema": "3.1.0-alpha.5"
   },
-  "gitHead": "e309784af37ef9f3640c7733c7851124c72e1fa3"
+  "gitHead": "352241dd910a8c6307a235dadbe154ca915b885b"
 }