@solvers-hub/llm-json 0.1.1 → 0.1.2

package/docs-md/interfaces/ExtractResult.md

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

package/docs-md/interfaces/JsonBlock.md

@@ -0,0 +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)

package/docs-md/interfaces/JsonParseError.md

@@ -0,0 +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)

package/docs-md/modules.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@solvers-hub/llm-json",
-    "version": "0.1.1",
+    "version": "0.1.2",
     "description": "A TypeScript SDK to extract and correct JSON from LLM outputs",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -14,12 +14,13 @@
         "test": "jest",
         "test:coverage": "jest --coverage",
         "lint": "eslint src/**/*.ts",
-        "prepublishOnly": "npm run build",
+        "prepublishOnly": "npm run build && npm run docs",
         "example": "ts-node examples/example.ts",
         "build:example": "tsc && node dist/examples/example.js",
-        "docs": "typedoc"
+        "docs": "typedoc --out docs src",
+        "docs:md": "typedoc --out docs-md --plugin typedoc-plugin-markdown src"
     },
-    "report": {
+    "repository": {
         "type": "git",
         "url": "https://github.com/solvers-hub/llm-json.git"
     },
@@ -38,10 +39,14 @@
         "@types/node": "^18.15.11",
         "jest": "^29.5.0",
         "ts-jest": "^29.1.0",
-        "typescript": "^5.0.4",
-        "ts-node": "^10.9.1"
+        "ts-node": "^10.9.1",
+        "typedoc": "^0.25.12",
+        "typedoc-plugin-markdown": "^3.17.1",
+        "typescript": "^5.0.4"
     },
     "files": [
-        "dist/**/*"
+        "dist/**/*",
+        "docs/**/*",
+        "docs-md/**/*"
     ]
 }