@solvers-hub/llm-json 0.1.6 → 0.1.8

package/docs-md/interfaces/ExtractResult.md

@@ -1,36 +1,49 @@
-[@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)
-
-## Properties
-
-### json
-
-• **json**: `any`[]
-
-Array of parsed JSON objects extracted from the input.
-
-#### Defined in
-
-[types.ts:24](https://github.com/solvers-hub/llm-json/blob/4d60f7fa6cdcace0d353b33e3d79c6fd33db1860/src/types.ts#L24)
-
-___
-
-### text
-
-• **text**: `string`[]
-
-Array of text blocks extracted from the input.
-
-#### Defined in
-
-[types.ts:19](https://github.com/solvers-hub/llm-json/blob/4d60f7fa6cdcace0d353b33e3d79c6fd33db1860/src/types.ts#L19)
+[@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 +1,75 @@
-[@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:44](https://github.com/solvers-hub/llm-json/blob/4d60f7fa6cdcace0d353b33e3d79c6fd33db1860/src/types.ts#L44)
-
-___
-
-### parsed
-
-• `Optional` **parsed**: `any`
-
-The parsed JSON object.
-
-#### Defined in
-
-[types.ts:54](https://github.com/solvers-hub/llm-json/blob/4d60f7fa6cdcace0d353b33e3d79c6fd33db1860/src/types.ts#L54)
-
-___
-
-### raw
-
-• **raw**: `string`
-
-The raw JSON string.
-
-#### Defined in
-
-[types.ts:34](https://github.com/solvers-hub/llm-json/blob/4d60f7fa6cdcace0d353b33e3d79c6fd33db1860/src/types.ts#L34)
-
-___
-
-### startIndex
-
-• **startIndex**: `number`
-
-The start index of the JSON block in the input string.
-
-#### Defined in
-
-[types.ts:39](https://github.com/solvers-hub/llm-json/blob/4d60f7fa6cdcace0d353b33e3d79c6fd33db1860/src/types.ts#L39)
-
-___
-
-### wasCorrected
-
-• `Optional` **wasCorrected**: `boolean`
-
-Whether the JSON was corrected.
-
-#### Defined in
-
-[types.ts:49](https://github.com/solvers-hub/llm-json/blob/4d60f7fa6cdcace0d353b33e3d79c6fd33db1860/src/types.ts#L49)
+[@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 +1,49 @@
-[@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:64](https://github.com/solvers-hub/llm-json/blob/4d60f7fa6cdcace0d353b33e3d79c6fd33db1860/src/types.ts#L64)
-
-___
-
-### position
-
-• `Optional` **position**: `number`
-
-The position in the JSON string where the error occurred.
-
-#### Defined in
-
-[types.ts:74](https://github.com/solvers-hub/llm-json/blob/4d60f7fa6cdcace0d353b33e3d79c6fd33db1860/src/types.ts#L74)
-
-___
-
-### raw
-
-• **raw**: `string`
-
-The raw JSON string that failed to parse.
-
-#### Defined in
-
-[types.ts:69](https://github.com/solvers-hub/llm-json/blob/4d60f7fa6cdcace0d353b33e3d79c6fd33db1860/src/types.ts#L69)
+[@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

@@ -0,0 +1,36 @@
+[@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

@@ -0,0 +1,62 @@
+[@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,26 +1,28 @@
-[@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)
-
-## References
-
-### default
-
-Renames and re-exports [LlmJson](classes/LlmJson.md)
+[@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)

package/examples/array-example.ts

@@ -0,0 +1,69 @@
+import LlmJson from '../src/index';
+
+/**
+ * Example demonstrating how to use the LLM-JSON library for arrays.
+ */
+function runArrayExample() {
+    // Create an instance with auto-correction enabled
+    const llmJson = new LlmJson({ attemptCorrection: true });
+
+    // Simple array example
+    const simpleArrayInput = `Here is a list of names: ["John", "Jane", "Bob"]`;
+
+    console.log("=== Simple Array Example ===");
+
+    // Using extract - might not properly handle standalone arrays
+    const simpleExtractResult = llmJson.extract(simpleArrayInput);
+    console.log("With extract():");
+    console.log("Text:", simpleExtractResult.text);
+    console.log("JSON:", JSON.stringify(simpleExtractResult.json, null, 2));
+    console.log();
+
+    // Using extractAll - properly handles arrays
+    const simpleExtractAllResult = llmJson.extractAll(simpleArrayInput);
+    console.log("With extractAll():");
+    console.log("Text:", simpleExtractAllResult.text);
+    console.log("JSON:", JSON.stringify(simpleExtractAllResult.json, null, 2));
+    console.log();
+
+    // Complex array example
+    const complexArrayInput = `Here's an array of users:
+  [
+    {
+      "name": "John Doe",
+      "age": 30,
+      "skills": ["JavaScript", "TypeScript"]
+    },
+    {
+      "name": "Jane Smith",
+      "age": 28,
+      "skills": ["Python", "Machine Learning"]
+    }
+  ]`;
+
+    console.log("=== Complex Array Example ===");
+
+    // Using extractAll - properly handles complex arrays
+    const complexResult = llmJson.extractAll(complexArrayInput);
+    console.log("With extractAll():");
+    console.log("Text:", complexResult.text);
+    console.log("JSON:", JSON.stringify(complexResult.json, null, 2));
+    console.log();
+
+    // Multiple JSON structures example
+    const mixedInput = `Here's an object: {"name": "John", "age": 30}
+  
+  And here's an array: [1, 2, 3, 4, 5]
+  
+  And another object: {"city": "New York", "country": "USA"}`;
+
+    console.log("=== Mixed JSON Types Example ===");
+
+    // Using extractAll - handles both objects and arrays
+    const mixedResult = llmJson.extractAll(mixedInput);
+    console.log("With extractAll():");
+    console.log("Text:", mixedResult.text);
+    console.log("JSON:", JSON.stringify(mixedResult.json, null, 2));
+}
+
+runArrayExample(); 

package/{dist/examples/example.js → examples/example.ts}

@@ -1,17 +1,14 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_1 = __importDefault(require("../src/index"));
-/**
- * Example demonstrating how to use the LLM-JSON library.
- */
-function runExample() {
-    // Create an instance with auto-correction enabled
-    const llmJson = new index_1.default({ attemptCorrection: true });
-    // Example from the requirements
-    const input = `<research_planning>
+import LlmJson from '../src/index';
+
+/**
+ * Example demonstrating how to use the LLM-JSON library.
+ */
+function runExample() {
+  // Create an instance with auto-correction enabled
+  const llmJson = new LlmJson({ attemptCorrection: true });
+
+  // Example from the requirements
+  const input = `<research_planning>
 a. Summary: The given organization is unnamed and works in the area of "something new," which suggests an innovative or emerging field. This could involve novel technologies, fresh market approaches, or unexplored domains. Without specific details, assumptions about the sector or industry may involve startups, tech innovation, or trendsetting industries. The focus and goals may lean toward exploration, user adoption, and refinement of novel concepts.
 
 b. Potential Product Features: 
@@ -56,27 +53,32 @@ e. Narrowing Down Objectives:
     }
   ]
 }
-\`\`\``;
-    // Extract JSON and text
-    const result = llmJson.extract(input);
-    console.log("Extracted text:");
-    console.log("------------------");
-    result.text.forEach((text, index) => {
-        console.log(`Text block ${index + 1}:`);
-        console.log(text);
-        console.log();
-    });
-    console.log("Extracted JSON:");
-    console.log("------------------");
-    result.json.forEach((json, index) => {
-        console.log(`JSON object ${index + 1}:`);
-        console.log(JSON.stringify(json, null, 2));
-        console.log();
-    });
-    // Example with malformed JSON
-    console.log("\nExample with malformed JSON:");
-    console.log("---------------------------");
-    const malformedInput = `Here is some information:
+\`\`\``;
+
+  // Extract JSON and text
+  const result = llmJson.extract(input);
+
+  console.log("Extracted text:");
+  console.log("------------------");
+  result.text.forEach((text, index) => {
+    console.log(`Text block ${index + 1}:`);
+    console.log(text);
+    console.log();
+  });
+
+  console.log("Extracted JSON:");
+  console.log("------------------");
+  result.json.forEach((json, index) => {
+    console.log(`JSON object ${index + 1}:`);
+    console.log(JSON.stringify(json, null, 2));
+    console.log();
+  });
+
+  // Example with malformed JSON
+  console.log("\nExample with malformed JSON:");
+  console.log("---------------------------");
+
+  const malformedInput = `Here is some information:
   
   {
     name: "John",
@@ -86,11 +88,14 @@ e. Narrowing Down Objectives:
       theme: "dark",
       notifications: true,
     }
-  }`;
-    const malformedResult = llmJson.extract(malformedInput);
-    console.log("Text:");
-    console.log(malformedResult.text[0]);
-    console.log("\nCorrected JSON:");
-    console.log(JSON.stringify(malformedResult.json[0], null, 2));
-}
-runExample();
+  }`;
+
+  const malformedResult = llmJson.extract(malformedInput);
+
+  console.log("Text:");
+  console.log(malformedResult.text[0]);
+  console.log("\nCorrected JSON:");
+  console.log(JSON.stringify(malformedResult.json[0], null, 2));
+}
+
+runExample();