toon-formatter 1.1.1 → 2.0.1

package/src/json.js

@@ -120,10 +120,11 @@ export async function jsonToToon(data) {
 /**
  * Converts TOON to JSON format (Synchronous)
  * @param {string} toonString - TOON formatted string
- * @returns {Object} JSON object
+ * @param {boolean} [returnJson=false] - If true, returns JSON string; if false, returns object
+ * @returns {Object|string} JSON object or JSON string
  * @throws {Error} If TOON string is invalid
  */
-export function toonToJsonSync(toonString) {
+export function toonToJsonSync(toonString, returnJson = false) {
     // Validate TOON string before conversion
     const validationStatus = validateToonStringSync(toonString);
     if (!validationStatus.isValid) {
@@ -136,7 +137,7 @@ export function toonToJsonSync(toonString) {
 
     // Pre-process: Check for Root Array or Root Primitive
     const firstLine = lines.find(l => l.trim() !== '');
-    if (!firstLine) return {}; // Empty document
+    if (!firstLine) return returnJson ? '{}' : {}; // Empty document
 
     // Root Array detection: [N]... at start of line
     if (firstLine.trim().startsWith('[')) {
@@ -324,14 +325,15 @@ export function toonToJsonSync(toonString) {
         }
     }
 
-    return root;
+    return returnJson ? JSON.stringify(root) : root;
 }
 
 /**
  * Converts TOON to JSON format (Async)
  * @param {string} toonString - TOON formatted string
- * @returns {Promise<Object>} Parsed JSON data
+ * @param {boolean} [returnJson=false] - If true, returns JSON string; if false, returns object
+ * @returns {Promise<Object|string>} Parsed JSON data (object or string)
  */
-export async function toonToJson(toonString) {
-    return toonToJsonSync(toonString);
+export async function toonToJson(toonString, returnJson = false) {
+    return toonToJsonSync(toonString, returnJson);
 }

package/.github/FUNDING.yml

@@ -1,15 +0,0 @@
-# These are supported funding model platforms
-
-github: [ankitpal181] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-# patreon: # Replace with a single Patreon username
-# open_collective: # Replace with a single Open Collective username
-# ko_fi: # Replace with a single Ko-fi username
-# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-# liberapay: # Replace with a single Liberapay username
-# issuehunt: # Replace with a single IssueHunt username
-# lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
-# polar: # Replace with a single Polar username
-# buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
-# thanks_dev: # Replace with a single thanks.dev username
-# custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

package/ENHANCEMENTS.md

@@ -1,124 +0,0 @@
-# TOON Converter Library - Enhancement Summary
-
-## Overview
-Updated the `toon-converter-lib` package with improved validators, mixed text extraction capabilities, validation checks on reverse conversions, and loop-based conversion for embedded formats.
-
----
-
-## ✨ New Features Added
-
-### 1. **Enhanced Validator** (`src/validator.js`)
-- **Empty Block Detection**: Validates that arrays with size > 0 have actual items
-- **Tabular Array Support**: Properly handles tabular arrays with `{field1,field2}` syntax  
-- **List Item Context Checking**: Ensures `-` items only appear in array contexts
-- **Better Error Messages**: Line numbers and specific error descriptions
-
-**Example Error**:
-```
-L5: Array declared with size 3 but has no items (expected indented block).
-```
-
----
-
-### 2. **Format Extraction Functions** (`src/utils.js`)
-Added utilities to extract specific formats from mixed text:
-
-- `extractJsonFromString(text)` - Finds and extracts JSON objects/arrays
-- `extractYamlFromString(text)` - Extracts YAML blocks
-- `extractXmlFromString(text)` - Extracts XML elements with balance checking
-- `extractCsvFromString(text)` - Identifies CSV data
-
-**Use Case**: Allows conversion of mixed content (e.g., JSON embedded in markdown).
-
----
-
-### 3. **Integrated Mixed Text Conversion**
-The conversion functions now automatically detect and handle mixed text input using an extraction loop. This logic covers both embedded data and full data strings.
-
-**Synchronous API (Main Logic)**:
-- `jsonToToonSync(input)`
-- `xmlToToonSync(input)`
-- `csvToToonSync(input)`
-- `yamlToToonSync(input)`
-
-**Asynchronous API (Wrappers)**:
-- `jsonToToon(input)`
-- `xmlToToon(input)`
-- `csvToToon(input)`
-- `yamlToToon(input)`
-
-**Behavior**:
-1. Checks if input is a string.
-2. Uses extraction logic (`extract*FromString`) in a loop to find and convert all data blocks.
-3. If no blocks are found (and input is not valid data), it returns the original text (or throws if strict parsing fails inside the loop).
-
-**Note**: `*TextToToon` functions have been removed in favor of this integrated approach.
-
----
-
----
-
-### 4. **Validation on Reverse Conversions**
-All `toonTo*` functions now validate TOON input before conversion:
-
-- `toonToJson()` - Validates before parsing
-- `toonToYaml()` - Validates before conversion
-- `toonToXml()` - Validates before conversion
-- `toonToCsv()` - Validates before conversion
-
-**Benefits**:
-- Early error detection
-- Clear error messages
-- Prevents invalid conversions
-
----
-
-### 6. **API Consistency (Sync & Async)**
-All converters now support both Synchronous and Asynchronous operations for consistency.
-
-| Format | Sync Method | Async Method |
-|--------|-------------|--------------|
-| **JSON** | `jsonToToon` | `jsonToToonAsync` |
-| **YAML** | `yamlToToon` | `yamlToToonAsync` |
-| **XML** | `xmlToToonSync`* | `xmlToToon` |
-| **CSV** | `csvToToonSync` | `csvToToon` |
-
-*\*Note: `xmlToToonSync` in Node.js requires a global `DOMParser` polyfill (e.g., via `jsdom`).*
-
-### 7. **Unified Class API** (`ToonConverter`)
-The `ToonConverter` class now exposes all variations:
-
-```javascript
-// Async
-await ToonConverter.fromJsonAsync(data);
-await ToonConverter.fromXmlAsync(xml);
-await ToonConverter.fromCsvAsync(csv);
-
-// Sync
-ToonConverter.fromJson(data);
-ToonConverter.fromXmlSync(xml);
-ToonConverter.fromCsvSync(csv);
-
-// Mixed Text
-ToonConverter.fromJsonText(text);
-await ToonConverter.fromXmlText(text);
-```
-
----
-
-## 🚀 Benefits
-
-- **Robustness**: Validation prevents invalid conversions
-- **Flexibility**: Handle mixed content seamlessly
-- **Consistency**: Unified API for all formats
-- **Developer Experience**: Clear errors, easy debugging
-- **Reliability**: Comprehensive validation at every step
-- **Reusability**: Extraction functions available for custom use
-
----
-
-**Note**: History feature was intentionally NOT added to the package as requested.
-
----
-
-Made with ❤️ for the TOON Formatter project

package/test/basic.test.js

@@ -1,139 +0,0 @@
-/**
- * Basic tests for TOON Converter
- * Run with: node --test test/basic.test.js
- */
-
-import { test } from 'node:test';
-import assert from 'node:assert';
-import { jsonToToonSync, toonToJsonSync } from '../src/json.js';
-import { validateToonStringSync } from '../src/validator.js';
-
-test('JSON to TOON - Simple Object', () => {
-    const input = { name: "Alice", age: 30, active: true };
-    const result = jsonToToonSync(input);
-
-    assert.ok(result.includes('name: "Alice"'));
-    assert.ok(result.includes('age: 30'));
-    assert.ok(result.includes('active: true'));
-});
-
-test('JSON to TOON - Array of Primitives', () => {
-    const input = { numbers: [1, 2, 3, 4, 5] };
-    const result = jsonToToonSync(input);
-
-    assert.ok(result.includes('numbers[5]: 1, 2, 3, 4, 5'));
-});
-
-test('JSON to TOON - Tabular Array', () => {
-    const input = {
-        users: [
-            { id: 1, name: "Alice", active: true },
-            { id: 2, name: "Bob", active: false }
-        ]
-    };
-    const result = jsonToToonSync(input);
-
-    assert.ok(result.includes('users[2]{id,name,active}:'));
-    assert.ok(result.includes('1,"Alice",true'));
-    assert.ok(result.includes('2,"Bob",false'));
-});
-
-test('TOON to JSON - Simple Object', () => {
-    const input = `name: "Alice"\nage: 30\nactive: true`;
-    const result = toonToJsonSync(input);
-
-    assert.strictEqual(result.name, "Alice");
-    assert.strictEqual(result.age, 30);
-    assert.strictEqual(result.active, true);
-});
-
-test('TOON to JSON - Array of Primitives', () => {
-    const input = `numbers[5]: 1, 2, 3, 4, 5`;
-    const result = toonToJsonSync(input);
-
-    assert.ok(Array.isArray(result.numbers));
-    assert.strictEqual(result.numbers.length, 5);
-    assert.deepStrictEqual(result.numbers, [1, 2, 3, 4, 5]);
-});
-
-test('TOON to JSON - Tabular Array', () => {
-    const input = `users[2]{id,name,active}:\n  1,"Alice",true\n  2,"Bob",false`;
-    const result = toonToJsonSync(input);
-
-    assert.ok(Array.isArray(result.users));
-    assert.strictEqual(result.users.length, 2);
-    assert.strictEqual(result.users[0].id, 1);
-    assert.strictEqual(result.users[0].name, "Alice");
-    assert.strictEqual(result.users[0].active, true);
-    assert.strictEqual(result.users[1].id, 2);
-    assert.strictEqual(result.users[1].name, "Bob");
-    assert.strictEqual(result.users[1].active, false);
-});
-
-test('Round-trip Conversion - Object', () => {
-    const original = {
-        company: "TechCorp",
-        employees: [
-            { name: "Alice", role: "Engineer" },
-            { name: "Bob", role: "Designer" }
-        ]
-    };
-
-    const toon = jsonToToonSync(original);
-    const result = toonToJsonSync(toon);
-
-    assert.deepStrictEqual(result, original);
-});
-
-test('Validator - Valid TOON', () => {
-    const input = `name: "Alice"\nage: 30`;
-    const result = validateToonStringSync(input);
-
-    assert.strictEqual(result.isValid, true);
-    assert.strictEqual(result.error, null);
-});
-
-test('Validator - Invalid TOON (Array Size Mismatch)', () => {
-    const input = `items[3]: 1, 2`; // Declared 3, but only 2 items
-    const result = validateToonStringSync(input);
-
-    assert.strictEqual(result.isValid, false);
-    assert.ok(result.error.includes('Array size mismatch'));
-});
-
-test('Validator - Valid Tabular Array', () => {
-    const input = `users[2]{id,name}:\n  1,"Alice"\n  2,"Bob"`;
-    const result = validateToonStringSync(input);
-
-    assert.strictEqual(result.isValid, true);
-    assert.strictEqual(result.error, null);
-});
-
-test('Edge Case - Empty Object', () => {
-    const input = {};
-    const result = jsonToToonSync(input);
-
-    assert.strictEqual(result.trim(), '');
-});
-
-test('Edge Case - Null Value', () => {
-    const input = { value: null };
-    const result = jsonToToonSync(input);
-
-    assert.ok(result.includes('value: null'));
-});
-
-test('Edge Case - Nested Objects', () => {
-    const input = {
-        level1: {
-            level2: {
-                level3: "deep"
-            }
-        }
-    };
-
-    const toon = jsonToToonSync(input);
-    const result = toonToJsonSync(toon);
-
-    assert.deepStrictEqual(result, input);
-});

package/test/converters.test.js

@@ -1,135 +0,0 @@
-/**
- * Tests for YAML, XML, and CSV Converters
- * Run with: node --test test/converters.test.js
- */
-
-import { test } from 'node:test';
-import assert from 'node:assert';
-import { yamlToToonSync, toonToYamlSync } from '../src/yaml.js';
-import { xmlToToon, toonToXmlSync } from '../src/xml.js';
-import { csvToToon, csvToToonSync, toonToCsvSync } from '../src/csv.js';
-
-// --- YAML Tests ---
-
-test('YAML to TOON - Simple Object', () => {
-    const yaml = `
-name: Alice
-age: 30
-`;
-    const toon = yamlToToonSync(yaml);
-    assert.ok(toon.includes('name: "Alice"'));
-    assert.ok(toon.includes('age: 30'));
-});
-
-test('TOON to YAML - Simple Object', () => {
-    const toon = `name: "Alice"\nage: 30`;
-    const yaml = toonToYamlSync(toon);
-    assert.ok(yaml.includes('name: Alice'));
-    assert.ok(yaml.includes('age: 30'));
-});
-
-test('YAML to TOON - Nested Structure', () => {
-    const yaml = `
-user:
-  name: Alice
-  roles:
-    - admin
-    - editor
-`;
-    const toon = yamlToToonSync(yaml);
-    assert.ok(toon.includes('user:'));
-    assert.ok(toon.includes('name: "Alice"'));
-    assert.ok(toon.includes('roles[2]:'));
-});
-
-// --- XML Tests ---
-
-test('XML to TOON - Simple Element', async () => {
-    const xml = `<user><name>Alice</name><age>30</age></user>`;
-    const toon = await xmlToToon(xml);
-
-    // Note: XML conversion wraps based on root element
-    assert.ok(toon.includes('user:'));
-    assert.ok(toon.includes('name: "Alice"'));
-    assert.ok(toon.includes('age: "30"')); // XML text content is usually string
-});
-
-test('TOON to XML - Simple Element', () => {
-    const toon = `user:\n  name: "Alice"\n  age: 30`;
-    const xml = toonToXmlSync(toon);
-
-    assert.ok(xml.includes('<user>'));
-    assert.ok(xml.includes('<name>Alice</name>'));
-    assert.ok(xml.includes('<age>30</age>'));
-    assert.ok(xml.includes('</user>'));
-});
-
-test('XML to TOON - Attributes', async () => {
-    const xml = `<item id="123" type="widget">Content</item>`;
-    const toon = await xmlToToon(xml);
-
-    assert.ok(toon.includes('item:'));
-    assert.ok(toon.includes('@attributes:'));
-    assert.ok(toon.includes('id: "123"'));
-    assert.ok(toon.includes('type: "widget"'));
-    assert.ok(toon.includes('#text: "Content"'));
-});
-
-// --- CSV Tests ---
-
-test('CSV to TOON - Basic (Async)', async () => {
-    const csv = `name,age,active
-Alice,30,true
-Bob,25,false`;
-
-    const toon = await csvToToon(csv);
-
-    // Should detect as tabular array or array of objects
-    // Since root is array, it might be [2]{name,age,active}: ...
-
-    assert.ok(toon.includes('[2]{name,age,active}:'));
-    assert.ok(toon.includes('Alice'));
-    assert.ok(toon.includes('30'));
-    assert.ok(toon.includes('true'));
-});
-
-test('CSV to TOON - Basic (Sync)', () => {
-    const csv = `id,product
-1,Apple
-2,Banana`;
-
-    const toon = csvToToonSync(csv);
-
-    assert.ok(toon.includes('[2]{id,product}:'));
-    assert.ok(toon.includes('1,"Apple"'));
-    assert.ok(toon.includes('2,"Banana"'));
-});
-
-test('TOON to CSV - Basic', () => {
-    const toon = `
-[2]{name,role}:
-  "Alice","Admin"
-  "Bob","User"
-`;
-    const csv = toonToCsvSync(toon);
-
-    assert.ok(csv.includes('name,role'));
-    assert.ok(csv.includes('Alice,Admin'));
-    assert.ok(csv.includes('Bob,User'));
-});
-
-test('CSV Round Trip', async () => {
-    const originalCsv = `name,score
-Alice,100
-Bob,95`;
-
-    const toon = await csvToToon(originalCsv);
-    const finalCsv = toonToCsvSync(toon);
-
-    // Note: PapaParse might add/remove quotes or change spacing, so exact match isn't always guaranteed
-    // But content should be same
-    assert.ok(finalCsv.includes('name'));
-    assert.ok(finalCsv.includes('score'));
-    assert.ok(finalCsv.includes('Alice'));
-    assert.ok(finalCsv.includes('100'));
-});