@solvers-hub/llm-json 0.1.7 → 0.1.8

package/docs-md/modules.md

@@ -1,28 +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)
-- [SchemaDefinition](interfaces/SchemaDefinition.md)
-- [ValidationResult](interfaces/ValidationResult.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/package.json

@@ -1,53 +1,53 @@
-{
-    "name": "@solvers-hub/llm-json",
-    "version": "0.1.7",
-    "description": "A TypeScript SDK to extract and correct JSON from LLM outputs",
-    "main": "dist/index.js",
-    "types": "dist/index.d.ts",
-    "author": "Solvers Hub",
-    "license": "MIT",
-    "scripts": {
-        "build": "tsc",
-        "test": "jest",
-        "test:coverage": "jest --coverage",
-        "lint": "eslint src/**/*.ts",
-        "prepublishOnly": "npm run build && npm run docs",
-        "example:run": "ts-node",
-        "docs": "typedoc --out docs src",
-        "docs:md": "typedoc --out docs-md --plugin typedoc-plugin-markdown src"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/solvers-hub/llm-json.git"
-    },
-    "bugs": {
-        "url": "https://github.com/solvers-hub/llm-json/issues"
-    },
-    "homepage": "https://github.com/solvers-hub/llm-json#readme",
-    "keywords": [
-        "llm",
-        "json",
-        "extractor",
-        "parser"
-    ],
-    "devDependencies": {
-        "@types/jest": "^29.5.0",
-        "@types/node": "^18.15.11",
-        "jest": "^29.5.0",
-        "ts-jest": "^29.1.0",
-        "ts-node": "^10.9.1",
-        "typedoc": "^0.25.12",
-        "typedoc-plugin-markdown": "^3.17.1",
-        "typescript": "^5.0.4"
-    },
-    "dependencies": {
-        "ajv": "^8.17.1",
-        "ajv-formats": "^3.0.1"
-    },
-    "files": [
-        "dist/**/*",
-        "docs/**/*",
-        "docs-md/**/*",
-        "examples/**/*"
-    ]
+{
+    "name": "@solvers-hub/llm-json",
+    "version": "0.1.8",
+    "description": "A TypeScript SDK to extract and correct JSON from LLM outputs",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "author": "Solvers Hub",
+    "license": "MIT",
+    "scripts": {
+        "build": "tsc",
+        "test": "jest",
+        "test:coverage": "jest --coverage",
+        "lint": "eslint src/**/*.ts",
+        "prepublishOnly": "npm run build && npm run docs",
+        "example:run": "ts-node",
+        "docs": "typedoc --out docs src",
+        "docs:md": "typedoc --out docs-md --plugin typedoc-plugin-markdown src"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/solvers-hub/llm-json.git"
+    },
+    "bugs": {
+        "url": "https://github.com/solvers-hub/llm-json/issues"
+    },
+    "homepage": "https://github.com/solvers-hub/llm-json#readme",
+    "keywords": [
+        "llm",
+        "json",
+        "extractor",
+        "parser"
+    ],
+    "devDependencies": {
+        "@types/jest": "^29.5.0",
+        "@types/node": "^18.15.11",
+        "jest": "^29.5.0",
+        "ts-jest": "^29.1.0",
+        "ts-node": "^10.9.1",
+        "typedoc": "^0.25.12",
+        "typedoc-plugin-markdown": "^3.17.1",
+        "typescript": "^5.0.4"
+    },
+    "dependencies": {
+        "ajv": "^8.17.1",
+        "ajv-formats": "^3.0.1"
+    },
+    "files": [
+        "dist/**/*",
+        "docs/**/*",
+        "docs-md/**/*",
+        "examples/**/*"
+    ]
 }

package/dist/examples/example.d.ts

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

package/dist/examples/example.js

@@ -1,96 +0,0 @@
-"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>
-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: 
-   - Exploration of new technologies (VR/AR interfaces, IoT integration)
-   - User onboarding and education tools 
-   - Novel interaction models or user interfaces
-   - Feedback and improvement loops
-   - Community engagement and collaboration spaces
-
-c. User Persona: Considering the organization's innovative nature, the primary user could be an early adopter, tech-savvy individual who is curious and willing to explore new technologies. This persona is likely someone who enjoys experimenting with novel ideas and is motivated by the excitement of participating in pioneering efforts. 
-   Study Name: "Demo - Innovator Insight"
-
-d. Potential Research Objectives:
-   - Evaluate user onboarding process effectiveness in helping users understand the product's novel features.
-   - Assess user engagement with community collaboration spaces to identify areas for increased interaction.
-   - Verify the intuitiveness of new interaction models and user interfaces.
-   - Explore user satisfaction with feedback and improvement loops.
-   - Measure the impact of educational tools on user empowerment and confidence.
-   - Analyze user behavior patterns to refine product workflows.
-   - Investigate potential barriers to user adoption and retention.
-   
-e. Narrowing Down Objectives: 
-   After considering the potential research objectives, the focus shifted towards objectives that can be directly evaluated through a live web application. The final objectives chosen were geared towards user onboarding, interaction intuitiveness, and community engagement, as they align with the persona of an early adopter and focus on improving user experience in areas relevant to the organization's innovative nature.
-</research_planning>
-
-\`\`\`json
-{
-  "studyName": "Demo - Innovator Insight",
-  "userPersona": "Tech-savvy early adopter exploring new innovations.",
-  "objectives": [
-    {
-      "objectiveTitle": "Onboarding Process Evaluation",
-      "objectiveDescription": "Assess the effectiveness of the user onboarding process in enabling users to grasp the novel features of the product quickly and efficiently, ensuring that it enhances initial user engagement and reduces learning curves."
-    },
-    {
-      "objectiveTitle": "Community Interaction Analysis",
-      "objectiveDescription": "Investigate user engagement within community collaboration spaces, identifying potential improvements to foster more interaction, sharing, and collaboration among users, enhancing overall community dynamics."
-    },
-    {
-      "objectiveTitle": "Interface Intuition Verification",
-      "objectiveDescription": "Verify the intuitiveness of new interaction models and user interfaces, focusing on how users adapt and navigate through the product, aiming to identify any areas needing refinement for better usability."
-    }
-  ]
-}
-\`\`\``;
-    // 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",
-    age: 30,
-    skills: ["JavaScript", "TypeScript"],
-    preferences: {
-      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();