@solvers-hub/llm-json 0.1.10 → 0.1.11

package/docs-md/README.md

@@ -1,108 +0,0 @@
-@solvers-hub/llm-json / [Exports](modules.md)
-
-# LLM-JSON Extractor
-
-A TypeScript SDK for extracting and correcting JSON data from LLM outputs.
-
-[![npm version](https://badge.fury.io/js/llm-json.svg)](https://badge.fury.io/js/llm-json)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-## Overview
-
-LLM-JSON is a lightweight library designed to parse and extract JSON objects from large language model (LLM) outputs. It can handle multiple JSON objects within text, extract text separately from JSON, and even attempt to fix malformed JSON.
-
-## Key Features
-
-- **Text/JSON Separation**: Cleanly separates text content from JSON data in LLM outputs
-- **Multiple JSON Support**: Extracts multiple JSON objects or arrays from a single input
-- **JSON Validation & Correction**: Automatically fixes common JSON formatting errors from LLMs
-- **Code Block Support**: Extracts JSON from markdown code blocks (```json)
-- **Schema Validation**: Validates extracted JSON against provided schemas
-- **TypeScript Support**: Written in TypeScript with full type definitions
-
-## Quick Start
-
-### Installation
-
-```bash
-npm install @solvers-hub/llm-json
-```
-
-### Basic Usage
-
-```typescript
-import { LlmJson } from '@solvers-hub/llm-json';
-
-const llmOutput = `Here's some text followed by JSON:
-
-{
-  "name": "John",
-  "age": 30,
-  "skills": ["JavaScript", "TypeScript", "React"]
-}`;
-
-const llmJson = new LlmJson({ attemptCorrection: true });
-const { text, json } = llmJson.extract(llmOutput);
-
-console.log(text); // ['Here\'s some text followed by JSON:']
-console.log(json); // [{ name: 'John', age: 30, skills: ['JavaScript', 'TypeScript', 'React'] }]
-```
-
-### Schema Validation
-
-You can validate extracted JSON against schemas:
-
-```typescript
-import { LlmJson } from '@solvers-hub/llm-json';
-
-const schemas = [
-  {
-    name: 'person',
-    schema: {
-      type: 'object',
-      properties: {
-        name: { type: 'string' },
-        age: { type: 'integer' }
-      },
-      required: ['name', 'age']
-    }
-  }
-];
-
-const llmJson = new LlmJson({ 
-  attemptCorrection: true,
-  schemas
-});
-
-const llmOutput = `Here's a person: {"name": "John", "age": 30}
-And some other data: {"title": "Meeting notes"}`;
-const result = llmJson.extract(llmOutput);
-
-// Note: All extracted JSON objects are included in the json array
-console.log(result.json);
-// [
-//   { name: 'John', age: 30 },
-//   { title: 'Meeting notes' }
-// ]
-
-// The validatedJson array includes validation results for each JSON object
-console.log(result.validatedJson);
-// [
-//   {
-//     json: { name: 'John', age: 30 },
-//     matchedSchema: 'person',
-//     isValid: true
-//   },
-//   {
-//     json: { title: 'Meeting notes' },
-//     matchedSchema: null,
-//     isValid: false,
-//     validationErrors: [...]  // Validation errors
-//   }
-// ]
-
-```
-
-## License
-
-MIT © 2025

package/docs-md/classes/LlmJson.md

@@ -1,147 +0,0 @@
-[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / LlmJson
-
-# Class: LlmJson
-
-Main factory class for the LLM-JSON extractor SDK.
-
-## Table of contents
-
-### Constructors
-
-- [constructor](LlmJson.md#constructor)
-
-### Properties
-
-- [arrayExtractor](LlmJson.md#arrayextractor)
-- [objectExtractor](LlmJson.md#objectextractor)
-- [instance](LlmJson.md#instance)
-
-### Methods
-
-- [extract](LlmJson.md#extract)
-- [extractAll](LlmJson.md#extractall)
-- [getInstance](LlmJson.md#getinstance)
-
-## Constructors
-
-### constructor
-
-• **new LlmJson**(`options?`): [`LlmJson`](LlmJson.md)
-
-Creates a new LlmJson instance with the specified options.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `options` | [`ExtractOptions`](../interfaces/ExtractOptions.md) | Configuration options for extraction. |
-
-#### Returns
-
-[`LlmJson`](LlmJson.md)
-
-#### Defined in
-
-[index.ts:17](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/index.ts#L17)
-
-## Properties
-
-### arrayExtractor
-
-• `Private` **arrayExtractor**: `JsonArrayExtractor`
-
-#### Defined in
-
-[index.ts:11](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/index.ts#L11)
-
-___
-
-### objectExtractor
-
-• `Private` **objectExtractor**: `JsonExtractor`
-
-#### Defined in
-
-[index.ts:10](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/index.ts#L10)
-
-___
-
-### instance
-
-▪ `Static` `Private` **instance**: [`LlmJson`](LlmJson.md)
-
-#### Defined in
-
-[index.ts:9](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/index.ts#L9)
-
-## Methods
-
-### extract
-
-▸ **extract**(`input`): [`ExtractResult`](../interfaces/ExtractResult.md)
-
-Extract JSON objects and text from a string input.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `input` | `string` | The input string that may contain JSON. |
-
-#### Returns
-
-[`ExtractResult`](../interfaces/ExtractResult.md)
-
-An object containing arrays of extracted text and JSON.
-
-#### Defined in
-
-[index.ts:39](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/index.ts#L39)
-
-___
-
-### extractAll
-
-▸ **extractAll**(`input`): [`ExtractResult`](../interfaces/ExtractResult.md)
-
-Extract JSON objects, arrays, and text from a string input.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `input` | `string` | The input string that may contain JSON. |
-
-#### Returns
-
-[`ExtractResult`](../interfaces/ExtractResult.md)
-
-An object containing arrays of extracted text and JSON.
-
-#### Defined in
-
-[index.ts:48](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/index.ts#L48)
-
-___
-
-### getInstance
-
-▸ **getInstance**(`options?`): [`LlmJson`](LlmJson.md)
-
-Get or create a singleton instance of LlmJson.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `options` | [`ExtractOptions`](../interfaces/ExtractOptions.md) | Configuration options for extraction. |
-
-#### Returns
-
-[`LlmJson`](LlmJson.md)
-
-The LlmJson singleton instance.
-
-#### Defined in
-
-[index.ts:27](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/index.ts#L27)

package/docs-md/interfaces/ExtractOptions.md

@@ -1,49 +0,0 @@
-[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / ExtractOptions
-
-# Interface: ExtractOptions
-
-Options for JSON extraction.
-
-## Table of contents
-
-### Properties
-
-- [attemptCorrection](ExtractOptions.md#attemptcorrection)
-- [schemas](ExtractOptions.md#schemas)
-
-## Properties
-
-### attemptCorrection
-
-• `Optional` **attemptCorrection**: `boolean`
-
-Whether to attempt to correct malformed JSON.
-
-**`Default`**
-
-```ts
-false
-```
-
-#### Defined in
-
-[types.ts:9](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L9)
-
-___
-
-### schemas
-
-• `Optional` **schemas**: [`SchemaDefinition`](SchemaDefinition.md)[]
-
-JSON schemas to validate extracted JSON against.
-If provided, the extracted JSON will be validated against these schemas.
-
-**`Default`**
-
-```ts
-undefined
-```
-
-#### Defined in
-
-[types.ts:16](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L16)

package/docs-md/interfaces/ExtractResult.md

@@ -1,49 +0,0 @@
-[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / ExtractResult
-
-# Interface: ExtractResult
-
-Result of the JSON extraction.
-
-## Table of contents
-
-### Properties
-
-- [json](ExtractResult.md#json)
-- [text](ExtractResult.md#text)
-- [validatedJson](ExtractResult.md#validatedjson)
-
-## Properties
-
-### json
-
-• **json**: `any`[]
-
-Array of parsed JSON objects extracted from the input.
-
-#### Defined in
-
-[types.ts:71](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L71)
-
-___
-
-### text
-
-• **text**: `string`[]
-
-Array of text blocks extracted from the input.
-
-#### Defined in
-
-[types.ts:66](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L66)
-
-___
-
-### validatedJson
-
-• `Optional` **validatedJson**: [`ValidationResult`](ValidationResult.md)[]
-
-Array of validated JSON results, only present if schemas were provided.
-
-#### Defined in
-
-[types.ts:76](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L76)

package/docs-md/interfaces/JsonBlock.md

@@ -1,75 +0,0 @@
-[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / JsonBlock
-
-# Interface: JsonBlock
-
-Information about a detected JSON block.
-
-## Table of contents
-
-### Properties
-
-- [endIndex](JsonBlock.md#endindex)
-- [parsed](JsonBlock.md#parsed)
-- [raw](JsonBlock.md#raw)
-- [startIndex](JsonBlock.md#startindex)
-- [wasCorrected](JsonBlock.md#wascorrected)
-
-## Properties
-
-### endIndex
-
-• **endIndex**: `number`
-
-The end index of the JSON block in the input string.
-
-#### Defined in
-
-[types.ts:96](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L96)
-
-___
-
-### parsed
-
-• `Optional` **parsed**: `any`
-
-The parsed JSON object.
-
-#### Defined in
-
-[types.ts:106](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L106)
-
-___
-
-### raw
-
-• **raw**: `string`
-
-The raw JSON string.
-
-#### Defined in
-
-[types.ts:86](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L86)
-
-___
-
-### startIndex
-
-• **startIndex**: `number`
-
-The start index of the JSON block in the input string.
-
-#### Defined in
-
-[types.ts:91](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L91)
-
-___
-
-### wasCorrected
-
-• `Optional` **wasCorrected**: `boolean`
-
-Whether the JSON was corrected.
-
-#### Defined in
-
-[types.ts:101](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L101)

package/docs-md/interfaces/JsonParseError.md

@@ -1,49 +0,0 @@
-[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / JsonParseError
-
-# Interface: JsonParseError
-
-Error information for JSON parsing failures.
-
-## Table of contents
-
-### Properties
-
-- [message](JsonParseError.md#message)
-- [position](JsonParseError.md#position)
-- [raw](JsonParseError.md#raw)
-
-## Properties
-
-### message
-
-• **message**: `string`
-
-The original error message.
-
-#### Defined in
-
-[types.ts:116](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L116)
-
-___
-
-### position
-
-• `Optional` **position**: `number`
-
-The position in the JSON string where the error occurred.
-
-#### Defined in
-
-[types.ts:126](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L126)
-
-___
-
-### raw
-
-• **raw**: `string`
-
-The raw JSON string that failed to parse.
-
-#### Defined in
-
-[types.ts:121](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L121)

package/docs-md/interfaces/SchemaDefinition.md

@@ -1,36 +0,0 @@
-[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / SchemaDefinition
-
-# Interface: SchemaDefinition
-
-Definition of a JSON schema for validation.
-
-## Table of contents
-
-### Properties
-
-- [name](SchemaDefinition.md#name)
-- [schema](SchemaDefinition.md#schema)
-
-## Properties
-
-### name
-
-• **name**: `string`
-
-A unique name for the schema to identify which schema matched.
-
-#### Defined in
-
-[types.ts:26](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L26)
-
-___
-
-### schema
-
-• **schema**: `object`
-
-The JSON schema object conforming to JSON Schema specification.
-
-#### Defined in
-
-[types.ts:31](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L31)

package/docs-md/interfaces/ValidationResult.md

@@ -1,62 +0,0 @@
-[@solvers-hub/llm-json](../README.md) / [Exports](../modules.md) / ValidationResult
-
-# Interface: ValidationResult
-
-Result of schema validation for a JSON object.
-
-## Table of contents
-
-### Properties
-
-- [isValid](ValidationResult.md#isvalid)
-- [json](ValidationResult.md#json)
-- [matchedSchema](ValidationResult.md#matchedschema)
-- [validationErrors](ValidationResult.md#validationerrors)
-
-## Properties
-
-### isValid
-
-• **isValid**: `boolean`
-
-Whether the JSON is valid according to the matched schema.
-
-#### Defined in
-
-[types.ts:51](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L51)
-
-___
-
-### json
-
-• **json**: `any`
-
-The JSON object that was validated.
-
-#### Defined in
-
-[types.ts:41](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L41)
-
-___
-
-### matchedSchema
-
-• **matchedSchema**: ``null`` \| `string`
-
-The name of the schema that matched, or null if no schema matched.
-
-#### Defined in
-
-[types.ts:46](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L46)
-
-___
-
-### validationErrors
-
-• `Optional` **validationErrors**: `any`[]
-
-Validation errors if any, or undefined if validation passed.
-
-#### Defined in
-
-[types.ts:56](https://github.com/solvers-hub/llm-json/blob/6d8d00890ee1d42b63f8bb8c3f6401333e41041e/src/types.ts#L56)

package/docs-md/modules.md

@@ -1,28 +0,0 @@
-[@solvers-hub/llm-json](README.md) / Exports
-
-# @solvers-hub/llm-json
-
-## Table of contents
-
-### References
-
-- [default](modules.md#default)
-
-### Classes
-
-- [LlmJson](classes/LlmJson.md)
-
-### Interfaces
-
-- [ExtractOptions](interfaces/ExtractOptions.md)
-- [ExtractResult](interfaces/ExtractResult.md)
-- [JsonBlock](interfaces/JsonBlock.md)
-- [JsonParseError](interfaces/JsonParseError.md)
-- [SchemaDefinition](interfaces/SchemaDefinition.md)
-- [ValidationResult](interfaces/ValidationResult.md)
-
-## References
-
-### default
-
-Renames and re-exports [LlmJson](classes/LlmJson.md)