@far-world-labs/verblets 0.2.0 → 0.4.0

package/src/verblets/to-object/README.md

@@ -1,38 +0,0 @@
-# to-object - JSON repair and validation
-
-This module is designed to take JSON results from ChatGPT calls, which can often be imperfect or malformed, and repair them to create valid JSON. If a JSON Schema is provided, the module also validates the repaired JSON against it. This process ensures that the JSON data is both well-formed and conforms to the expected structure.
-
-## Features
-
-- Automatic repair of malformed JSON data returned by ChatGPT.
-- Validation of repaired JSON data against provided JSON Schemas using the [Ajv](https://ajv.js.org/) library.
-- Recursive repair attempts through internal calls to ChatGPT for particularly stubborn cases.
-- Detailed error handling and validation messages
-- Custom ValidationError class for understanding where the returned JSON fails to meet the schema.
-
-## Installation
-
-This module is part of a larger project and is not designed to be installed standalone. However, you can copy the module into your own project and install the necessary dependencies via npm or yarn:
-
-```bash
-npm install ajv
-```
-
-## Usage
-
-The primary function exported by this module takes two arguments: a text string to be parsed into JSON, and an optional schema object which describes the expected format of the JSON data.
-
-Here is an example of how to use the module:
-```javascript
-import toObject from './path/to/module';
-
-const text = '...';  // JSON string returned from a ChatGPT call
-const schema = { ... };  // Optional JSON Schema
-
-try {
-  const result = await toObject(text, schema);
-  console.error(result);  // Repaired and validated JSON
-} catch (error) {
-  console.error(error);  // Validation message if JSON doesn't meet the schema
-}
-```

package/src/verblets/to-object/index.examples.js

@@ -1,29 +0,0 @@
-import { describe, expect, it } from 'vitest';
-
-import toObject from './index.js';
-import chatGPT from '../../lib/chatgpt/index.js';
-import { longTestTimeout } from '../../constants/common.js';
-
-const examples = [
-  {
-    inputs: { text: 'Describe SpaceX Starship' },
-    want: { typeOfResult: 'object' },
-  },
-];
-
-describe('To object verblet', () => {
-  examples.forEach((example) => {
-    it(
-      example.inputs.text,
-      async () => {
-        const chatGPTResult = await chatGPT(example.inputs.text);
-        const result = await toObject(chatGPTResult);
-
-        if (example.want.typeOfResult) {
-          expect(typeof result).toStrictEqual(example.want.typeOfResult);
-        }
-      },
-      longTestTimeout
-    );
-  });
-});

package/src/verblets/to-object/index.js

@@ -1,131 +0,0 @@
-import Ajv from 'ajv';
-
-import { debugToObject } from '../../constants/common.js';
-import { retryJSONParse } from '../../constants/messages.js';
-import chatGPT from '../../lib/chatgpt/index.js';
-import stripResponse from '../../lib/strip-response/index.js';
-import { constants as promptConstants, wrapVariable } from '../../prompts/index.js';
-
-const { contentIsSchema, contentToJSON, onlyJSON, shapeAsJSON } = promptConstants;
-
-class ValidationError extends Error {
-  constructor(message, details) {
-    super(message);
-    this.name = 'ValidationError';
-    this.details = details;
-  }
-}
-
-const buildJsonPrompt = function (text, schema, errors) {
-  let errorsDisplay = '';
-  if (errors?.length) {
-    errorsDisplay = wrapVariable(JSON.stringify(errors) ?? '', {
-      tag: 'json-schema-errors--do-not-output',
-    });
-  }
-
-  let schemaPart = '';
-  if (schema) {
-    schemaPart = `${contentIsSchema} ${wrapVariable(JSON.stringify(schema), {
-      tag: 'json-schema--do-not-output',
-    })}`;
-  }
-
-  return `${onlyJSON} ${shapeAsJSON}
-
-${schemaPart}
-
-${errorsDisplay}
-
-${contentToJSON} ${wrapVariable(stripResponse(text), { tag: 'content' })}
-
-${onlyJSON}`;
-};
-
-export default async (text, schema, config = {}) => {
-  const { llm, ...options } = config;
-  let prompt;
-  let result;
-  let response = text;
-  let errorDetails;
-
-  try {
-    result = JSON.parse(stripResponse(response));
-    if (schema) {
-      const ajv = new Ajv();
-      const validate = ajv.compile(schema);
-      const isValid = validate(result);
-
-      if (!isValid) {
-        throw new ValidationError('Ajv validation failed', validate.errors);
-      }
-      return result;
-    }
-    return result;
-  } catch (error) {
-    errorDetails = error.details;
-    if (debugToObject) {
-      console.error(`Parse JSON [error]: ${error.message} ${retryJSONParse}`);
-      console.error('<prompt attempt=1 value="unknown" />');
-      console.error('<response>');
-      console.error(stripResponse(response));
-      console.error('</response>');
-      console.error('<error>');
-      console.error(error);
-      console.error('</error>');
-    }
-  }
-
-  try {
-    prompt = buildJsonPrompt(response, schema, errorDetails);
-    response = await chatGPT(prompt, {
-      modelOptions: { modelName: 'fastGood', ...llm },
-      ...options,
-    });
-    result = JSON.parse(stripResponse(response));
-
-    if (schema) {
-      const ajv = new Ajv();
-      const validate = ajv.compile(schema);
-      const isValid = validate(result);
-
-      if (!isValid) {
-        throw new ValidationError('Ajv validation failed', validate.errors);
-      }
-      return result;
-    }
-  } catch (error) {
-    errorDetails = error.details;
-    if (debugToObject) {
-      console.error(`Parse JSON [error]: ${error.message} ${retryJSONParse}`);
-      console.error('<prompt attempt=2>');
-      console.error(prompt);
-      console.error('</prompt>');
-      console.error('<response>');
-      console.error(stripResponse(response));
-      console.error('</response>');
-      console.error('<error>');
-      console.error(error);
-      console.error('</error>');
-    }
-
-    prompt = buildJsonPrompt(response, schema, errorDetails);
-    response = await chatGPT(prompt, {
-      modelOptions: { modelName: 'fastGood', ...llm },
-      ...options,
-    });
-    result = JSON.parse(stripResponse(response));
-
-    if (debugToObject) {
-      console.error(`Parse JSON [error]: ${error.message} ${retryJSONParse}`);
-      console.error('<prompt attempt=3>');
-      console.error(prompt);
-      console.error('</prompt>');
-      console.error('<response>');
-      console.error(stripResponse(response));
-      console.error('</response>');
-    }
-  }
-
-  return result;
-};

package/src/verblets/to-object/index.spec.js

@@ -1,71 +0,0 @@
-import { describe, expect, it, vi } from 'vitest';
-
-import toObject from './index.js';
-
-vi.mock('../../lib/chatgpt/index.js', () => ({
-  default: vi.fn().mockImplementation((text) => {
-    if (/test/.test(text)) {
-      return '{}';
-    }
-    if (/valid-schema/.test(text)) {
-      return '{"key": "value"}';
-    }
-    if (/invalid-schema/.test(text)) {
-      return '{"key": "value", "extra": "unexpected"}';
-    }
-    return 'undefined';
-  }),
-}));
-
-const examples = [
-  {
-    name: 'Basic usage',
-    inputs: { text: 'test' },
-    want: { typeOfResult: 'object' },
-  },
-  {
-    name: 'Valid schema',
-    inputs: {
-      text: 'valid-schema',
-      schema: {
-        type: 'object',
-        properties: { key: { type: 'string' } },
-        required: ['key'],
-      },
-    },
-    want: { typeOfResult: 'object' },
-  },
-  {
-    name: 'Invalid schema',
-    inputs: {
-      text: 'invalid-schema',
-      schema: {
-        type: 'object',
-        properties: { key: { type: 'string' } },
-        additionalProperties: false,
-        required: ['key'],
-      },
-    },
-    wantError: true,
-  },
-];
-
-describe('To object verblet', () => {
-  examples.forEach((example) => {
-    it(example.name, async () => {
-      try {
-        const result = await toObject(example.inputs.text, example.inputs.schema);
-
-        if (example.want.typeOfResult) {
-          expect(typeof result).toStrictEqual(example.want.typeOfResult);
-        }
-      } catch (error) {
-        if (example.wantError) {
-          expect(error).toBeInstanceOf(Error);
-        } else {
-          throw error;
-        }
-      }
-    });
-  });
-});