vectorjson 0.3.2 → 0.4.1

package/README.md

@@ -242,22 +242,6 @@ const result = parser.getValue(); // lazy Proxy — materializes on access
 parser.destroy();
 ```
 
-### Vercel AI SDK-compatible signature
-
-If you have code that calls `parsePartialJson`, VectorJSON provides a compatible function:
-
-```js
-// Before
-import { parsePartialJson } from "ai";
-const { value, state } = parsePartialJson(buffer);
-
-// After
-import { parsePartialJson } from "vectorjson";
-const { value, state } = parsePartialJson(buffer);
-```
-
-> **Note:** AI SDKs (Vercel, Anthropic, TanStack) parse JSON internally inside `streamObject()`, `MessageStream`, etc. — you don't get access to the raw chunks. To use VectorJSON today, work with the raw LLM stream directly (raw fetch, WebSocket, SSE).
-
 ### Event-driven: React to fields as they stream in
 
 When an LLM streams a tool call, you usually care about specific fields at specific times. `createEventParser` lets you subscribe to paths and get notified the moment a value completes or a string grows:
@@ -350,7 +334,7 @@ for await (const partial of createParser({ source: chunks() })) {
 
 Validate and auto-infer types with Zod, Valibot, ArkType, or any lib with `.safeParse()`. Works on all three APIs:
 
-**Streaming parser with typed partial objects** — like Vercel AI SDK's `output`, but O(n) instead of O(n²):
+**Streaming parser with typed partial objects:**
 
 ```ts
 import { z } from 'zod';
@@ -454,6 +438,24 @@ result.status;       // "complete" | "complete_early" | "incomplete" | "invalid"
 result.value.users;  // lazy Proxy — materializes on access
 ```
 
+### JSONL & JSON5
+
+Both `createParser` and `createEventParser` accept `format: "jsonl" | "json5"`:
+
+```js
+// JSONL — yields each value separately
+for await (const value of createParser({ format: "jsonl", source: stream })) {
+  console.log(value);  // { user: "Alice" }, { user: "Bob" }, ...
+}
+
+// JSON5 — comments, trailing commas, unquoted keys, single-quoted strings, hex, Infinity/NaN
+const p = createParser({ format: "json5" });
+p.feed(`{ name: 'Alice', tags: ['admin',], color: 0xFF0000, timeout: Infinity, }`);
+p.getValue(); // { name: "Alice", tags: ["admin"], color: 16711680, timeout: Infinity }
+```
+
+JSONL push-based: call `resetForNext()` after each value. JSON5 comments are stripped at the byte level during streaming.
+
 ## API Reference
 
 ### Direct exports (recommended)
@@ -503,6 +505,7 @@ createParser({ schema, source });  // options object
 interface CreateParserOptions<T = unknown> {
   schema?: ZodLike<T>;   // only parse schema fields, validate on complete
   source?: ReadableStream<Uint8Array> | AsyncIterable<Uint8Array | string>;
+  format?: "json" | "jsonl" | "json5";  // default: "json"
 }
 ```
 
@@ -526,6 +529,7 @@ interface StreamingParser<T = unknown> {
   getRemaining(): Uint8Array | null;
   getRawBuffer(): ArrayBuffer | null;  // transferable buffer for Worker postMessage
   getStatus(): FeedStatus;
+  resetForNext(): number;  // JSONL: reset for next value, returns remaining byte count
   destroy(): void;
   [Symbol.asyncIterator](): AsyncIterableIterator<T | undefined>;  // requires source
 }
@@ -549,7 +553,7 @@ Works with Zod, Valibot, ArkType — any library with `{ safeParse(v) → { succ
 
 ### `parsePartialJson(input, schema?): PartialJsonResult<DeepPartial<T>>`
 
-Compatible with Vercel AI SDK's `parsePartialJson` signature. Returns a plain JS object (not a Proxy). Pass an optional schema for type-safe validation.
+One-shot partial JSON parse. Returns a plain JS object (not a Proxy). Pass an optional schema for type-safe validation.
 
 With a schema, returns `DeepPartial<T>` — all properties are optional because incomplete JSON will have missing fields. When `safeParse` succeeds, returns validated `data`. When `safeParse` fails on a repaired-parse (partial JSON), the raw parsed value is kept — the object is partial, that's expected.
 
@@ -581,7 +585,7 @@ createEventParser({ schema, source });              // schema + for-await
 {
   source?: ReadableStream<Uint8Array> | AsyncIterable<Uint8Array | string>;
   schema?: ZodLike<T>;   // only parse schema fields (same as createParser)
-  // format?: "json" | "jsonl";  // planned — JSONL support for both parsers
+  format?: "json" | "jsonl" | "json5";  // default: "json"
 }
 ```
 
@@ -654,7 +658,7 @@ interface DeltaEvent {
 | **Schema** | Pass Zod/Valibot, only schema fields are parsed | Same |
 | **Skip non-JSON** (think tags, code fences, prose) | — | Always |
 | **Field subscriptions** | — | `on()`, `onDelta()` |
-| **JSONL** | `format: "jsonl"` (planned) | `format: "jsonl"` (planned) |
+| **JSONL** | `format: "jsonl"` | `format: "jsonl"` |
 | **Text callbacks** | — | `onText()` |
 
 **`createParser` parses one JSON value** and reports status — you check it and react:
@@ -744,7 +748,7 @@ ANTHROPIC_API_KEY=sk-ant-... bun examples/anthropic-tool-call.ts
 OPENAI_API_KEY=sk-...       bun examples/openai-function-call.ts
 ```
 
-See also `examples/ai-usage.ts` for additional patterns (MCP stdio, Vercel AI SDK `streamObject`, NDJSON embeddings).
+See also `examples/ai-usage.ts` for additional patterns (MCP stdio, NDJSON embeddings).
 
 ## Building from Source