npm - jtcsv - Versions diffs - 2.1.3 → 2.2.2 - Mend

jtcsv 2.1.3 → 2.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (52) hide show

package/LICENSE +1 -1
package/README.md +60 -341
package/bin/jtcsv.js +2462 -1372
package/csv-to-json.js +35 -26
package/dist/jtcsv.cjs.js +807 -133
package/dist/jtcsv.cjs.js.map +1 -1
package/dist/jtcsv.esm.js +800 -134
package/dist/jtcsv.esm.js.map +1 -1
package/dist/jtcsv.umd.js +807 -133
package/dist/jtcsv.umd.js.map +1 -1
package/errors.js +20 -0
package/examples/browser-vanilla.html +37 -0
package/examples/cli-batch-processing.js +38 -0
package/examples/error-handling.js +324 -0
package/examples/ndjson-processing.js +434 -0
package/examples/react-integration.jsx +637 -0
package/examples/schema-validation.js +640 -0
package/examples/simple-usage.js +10 -7
package/examples/typescript-example.ts +486 -0
package/examples/web-workers-advanced.js +28 -0
package/index.d.ts +2 -0
package/json-save.js +2 -1
package/json-to-csv.js +171 -131
package/package.json +20 -4
package/plugins/README.md +41 -467
package/plugins/express-middleware/README.md +32 -274
package/plugins/hono/README.md +16 -13
package/plugins/nestjs/README.md +13 -11
package/plugins/nextjs-api/README.md +28 -423
package/plugins/nextjs-api/index.js +1 -2
package/plugins/nextjs-api/route.js +1 -2
package/plugins/nuxt/README.md +6 -7
package/plugins/remix/README.md +9 -9
package/plugins/sveltekit/README.md +8 -8
package/plugins/trpc/README.md +8 -5
package/src/browser/browser-functions.js +33 -3
package/src/browser/csv-to-json-browser.js +269 -11
package/src/browser/errors-browser.js +19 -1
package/src/browser/index.js +39 -5
package/src/browser/streams.js +393 -0
package/src/browser/workers/csv-parser.worker.js +20 -2
package/src/browser/workers/worker-pool.js +507 -447
package/src/core/plugin-system.js +4 -0
package/src/engines/fast-path-engine.js +31 -23
package/src/errors.js +26 -0
package/src/formats/ndjson-parser.js +54 -5
package/src/formats/tsv-parser.js +4 -1
package/src/utils/schema-validator.js +594 -0
package/src/utils/transform-loader.js +205 -0
package/src/web-server/index.js +683 -0
package/stream-csv-to-json.js +16 -87
package/stream-json-to-csv.js +18 -86

package/errors.js CHANGED Viewed

@@ -83,6 +83,23 @@ class ConfigurationError extends JtcsvError {
   }
 }
+const ERROR_CODES = {
+  JTCSV_ERROR: 'JTCSV_ERROR',
+  VALIDATION_ERROR: 'VALIDATION_ERROR',
+  SECURITY_ERROR: 'SECURITY_ERROR',
+  FILE_SYSTEM_ERROR: 'FILE_SYSTEM_ERROR',
+  PARSING_ERROR: 'PARSING_ERROR',
+  LIMIT_ERROR: 'LIMIT_ERROR',
+  CONFIGURATION_ERROR: 'CONFIGURATION_ERROR',
+  INVALID_INPUT: 'INVALID_INPUT',
+  SECURITY_VIOLATION: 'SECURITY_VIOLATION',
+  FILE_NOT_FOUND: 'FILE_NOT_FOUND',
+  PARSE_FAILED: 'PARSE_FAILED',
+  SIZE_LIMIT: 'SIZE_LIMIT',
+  INVALID_CONFIG: 'INVALID_CONFIG',
+  UNKNOWN_ERROR: 'UNKNOWN_ERROR'
+};
 /**
  * Utility function to create standardized error messages
  */
@@ -103,6 +120,7 @@ function createErrorMessage(type, details) {
 /**
  * Error handler utility
  */
+/* istanbul ignore next */
 function handleError(error, context = {}) {
   // Log error in development
   if (process.env.NODE_ENV === 'development') {
@@ -121,6 +139,7 @@ function handleError(error, context = {}) {
 /**
  * Safe execution wrapper for async functions
  */
+/* istanbul ignore next */
 async function safeExecuteAsync(fn, errorType, context = {}) {
   try {
     return await fn();
@@ -180,6 +199,7 @@ module.exports = {
   ParsingError,
   LimitError,
   ConfigurationError,
+  ERROR_CODES,
   createErrorMessage,
   handleError,
   safeExecute,

package/examples/browser-vanilla.html ADDED Viewed

@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>JTCSV Vanilla Browser Example</title>
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <style>
+      body { font-family: Arial, sans-serif; padding: 20px; }
+      textarea { width: 100%; height: 160px; margin-top: 8px; }
+      .row { margin: 10px 0; }
+    </style>
+  </head>
+  <body>
+    <h1>JTCSV Browser Example</h1>
+    <div class="row">
+      <input type="file" id="csvFile" accept=".csv" />
+      <button id="parseBtn">Parse CSV</button>
+    </div>
+    <div class="row">
+      <textarea id="output" placeholder="JSON output..."></textarea>
+    </div>
+    <script src="https://cdn.jsdelivr.net/npm/jtcsv@latest/dist/jtcsv.umd.js"></script>
+    <script>
+      const fileInput = document.getElementById('csvFile');
+      const output = document.getElementById('output');
+      const parseBtn = document.getElementById('parseBtn');
+      parseBtn.addEventListener('click', async () => {
+        const file = fileInput.files[0];
+        if (!file) return;
+        const json = await window.jtcsv.parseCsvFile(file, { delimiter: ',', parseNumbers: true });
+        output.value = JSON.stringify(json, null, 2);
+      });
+    </script>
+  </body>
+</html>

package/examples/cli-batch-processing.js ADDED Viewed

@@ -0,0 +1,38 @@
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+const { spawnSync } = require('child_process');
+const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'jtcsv-batch-'));
+const inputDir = path.join(tempDir, 'input');
+const outputDir = path.join(tempDir, 'output');
+fs.mkdirSync(inputDir, { recursive: true });
+fs.mkdirSync(outputDir, { recursive: true });
+const sampleData = [
+  [{ id: 1, name: 'John' }, { id: 2, name: 'Jane' }],
+  [{ id: 3, name: 'Max' }, { id: 4, name: 'Eva' }]
+];
+sampleData.forEach((data, idx) => {
+  const filePath = path.join(inputDir, `data-${idx + 1}.json`);
+  fs.writeFileSync(filePath, JSON.stringify(data, null, 2));
+});
+const cliPath = path.join(__dirname, '..', 'bin', 'jtcsv.js');
+const result = spawnSync('node', [
+  cliPath,
+  'batch',
+  'json-to-csv',
+  path.join(inputDir, '*.json'),
+  outputDir,
+  '--delimiter=,'
+], { stdio: 'inherit' });
+if (result.status !== 0) {
+  process.exit(result.status);
+}
+console.log('Output files:', fs.readdirSync(outputDir));

package/examples/error-handling.js ADDED Viewed

@@ -0,0 +1,324 @@
+/**
+ * Error Handling Examples for jtcsv
+ *
+ * This file demonstrates proper error handling patterns
+ * using jtcsv's typed error classes.
+ */
+const {
+  csvToJson,
+  jsonToCsv,
+  saveAsCsv,
+  readCsvAsJson,
+  // Error classes
+  JtcsvError,
+  ValidationError,
+  SecurityError,
+  ParsingError,
+  FileSystemError,
+  LimitError,
+  ConfigurationError
+} = require('jtcsv');
+// =============================================================================
+// Example 1: Basic Error Handling
+// =============================================================================
+function basicErrorHandling() {
+  console.log('\n=== Basic Error Handling ===\n');
+  // Invalid input type
+  try {
+    csvToJson(null);
+  } catch (error) {
+    if (error instanceof ValidationError) {
+      console.log('ValidationError caught:', error.message);
+      console.log('Error code:', error.code);
+    }
+  }
+  // Malformed CSV
+  const malformedCsv = 'name,age\n"unclosed quote,25';
+  try {
+    csvToJson(malformedCsv);
+  } catch (error) {
+    if (error instanceof ParsingError) {
+      console.log('ParsingError caught:', error.message);
+      console.log('Line number:', error.lineNumber);
+    }
+  }
+}
+// =============================================================================
+// Example 2: Comprehensive Error Handling with Type Checks
+// =============================================================================
+async function comprehensiveErrorHandling() {
+  console.log('\n=== Comprehensive Error Handling ===\n');
+  const operations = [
+    {
+      name: 'Parse invalid CSV',
+      action: () => csvToJson(12345) // Not a string
+    },
+    {
+      name: 'Convert non-array to CSV',
+      action: () => jsonToCsv('not an array')
+    },
+    {
+      name: 'Read non-existent file',
+      action: async () => await readCsvAsJson('./non-existent-file.csv')
+    },
+    {
+      name: 'Exceed row limit',
+      action: () => {
+        const csv = 'a,b\n' + '1,2\n'.repeat(100);
+        return csvToJson(csv, { maxRows: 5 });
+      }
+    },
+    {
+      name: 'Path traversal attempt',
+      action: async () => await saveAsCsv([], '../../../etc/passwd.csv')
+    }
+  ];
+  for (const op of operations) {
+    try {
+      await op.action();
+      console.log(`${op.name}: Success (unexpected)`);
+    } catch (error) {
+      const errorType = getErrorTypeName(error);
+      console.log(`${op.name}: ${errorType} - ${error.message}`);
+    }
+  }
+}
+function getErrorTypeName(error) {
+  if (error instanceof ValidationError) return 'ValidationError';
+  if (error instanceof SecurityError) return 'SecurityError';
+  if (error instanceof ParsingError) return 'ParsingError';
+  if (error instanceof FileSystemError) return 'FileSystemError';
+  if (error instanceof LimitError) return 'LimitError';
+  if (error instanceof ConfigurationError) return 'ConfigurationError';
+  if (error instanceof JtcsvError) return 'JtcsvError';
+  return 'UnknownError';
+}
+// =============================================================================
+// Example 3: Error Recovery Strategies
+// =============================================================================
+function errorRecoveryStrategies() {
+  console.log('\n=== Error Recovery Strategies ===\n');
+  // Strategy 1: Fallback to default delimiter
+  function parseWithFallback(csv) {
+    const delimiters = [',', ';', '\t', '|'];
+    for (const delimiter of delimiters) {
+      try {
+        const result = csvToJson(csv, {
+          delimiter,
+          autoDetect: false
+        });
+        console.log(`Successfully parsed with delimiter: "${delimiter}"`);
+        return result;
+      } catch (error) {
+        console.log(`Failed with delimiter "${delimiter}": ${error.message}`);
+      }
+    }
+    throw new Error('Could not parse CSV with any known delimiter');
+  }
+  const testCsv = 'name|age|city\nJohn|25|NYC\nJane|30|LA';
+  const result = parseWithFallback(testCsv);
+  console.log('Result:', result);
+}
+// =============================================================================
+// Example 4: Batch Processing with Error Collection
+// =============================================================================
+async function batchProcessingWithErrorCollection() {
+  console.log('\n=== Batch Processing with Error Collection ===\n');
+  const csvFiles = [
+    { name: 'valid.csv', content: 'a,b\n1,2\n3,4' },
+    { name: 'invalid.csv', content: 'a,b\n"unclosed' },
+    { name: 'empty.csv', content: '' },
+    { name: 'valid2.csv', content: 'x,y\n5,6' }
+  ];
+  const results = {
+    successful: [],
+    failed: []
+  };
+  for (const file of csvFiles) {
+    try {
+      const data = csvToJson(file.content);
+      results.successful.push({
+        name: file.name,
+        rowCount: data.length
+      });
+    } catch (error) {
+      results.failed.push({
+        name: file.name,
+        error: error.message,
+        errorType: getErrorTypeName(error)
+      });
+    }
+  }
+  console.log('Processing Results:');
+  console.log('Successful:', results.successful);
+  console.log('Failed:', results.failed);
+  console.log(`\nSuccess rate: ${results.successful.length}/${csvFiles.length}`);
+}
+// =============================================================================
+// Example 5: Custom Error Handler Wrapper
+// =============================================================================
+function createSafeParser(options = {}) {
+  const { onError, defaultValue = [] } = options;
+  return function safeParse(csv, parseOptions = {}) {
+    try {
+      return {
+        success: true,
+        data: csvToJson(csv, parseOptions),
+        error: null
+      };
+    } catch (error) {
+      if (onError) {
+        onError(error);
+      }
+      return {
+        success: false,
+        data: defaultValue,
+        error: {
+          type: getErrorTypeName(error),
+          message: error.message,
+          code: error.code
+        }
+      };
+    }
+  };
+}
+function customErrorHandlerDemo() {
+  console.log('\n=== Custom Error Handler ===\n');
+  const safeParse = createSafeParser({
+    onError: (error) => {
+      console.log(`[Logger] Error occurred: ${error.message}`);
+    },
+    defaultValue: []
+  });
+  // Test with valid CSV
+  const result1 = safeParse('a,b\n1,2');
+  console.log('Valid CSV result:', result1);
+  // Test with invalid CSV
+  const result2 = safeParse(null);
+  console.log('Invalid CSV result:', result2);
+}
+// =============================================================================
+// Example 6: Async Error Handling with Retries
+// =============================================================================
+async function asyncWithRetries() {
+  console.log('\n=== Async Error Handling with Retries ===\n');
+  async function readWithRetry(filePath, maxRetries = 3) {
+    let lastError;
+    for (let attempt = 1; attempt <= maxRetries; attempt++) {
+      try {
+        console.log(`Attempt ${attempt}: Reading ${filePath}`);
+        const data = await readCsvAsJson(filePath);
+        return data;
+      } catch (error) {
+        lastError = error;
+        console.log(`Attempt ${attempt} failed: ${error.message}`);
+        if (error instanceof FileSystemError) {
+          // File system errors might be transient
+          await new Promise(r => setTimeout(r, 100 * attempt));
+        } else if (error instanceof ValidationError) {
+          // Validation errors won't resolve with retry
+          throw error;
+        } else if (error instanceof SecurityError) {
+          // Security errors should not be retried
+          throw error;
+        }
+      }
+    }
+    throw lastError;
+  }
+  try {
+    await readWithRetry('./test-data.csv');
+  } catch (error) {
+    console.log(`All retries failed: ${error.message}`);
+  }
+}
+// =============================================================================
+// Example 7: Schema Validation Error Details
+// =============================================================================
+function schemaValidationErrors() {
+  console.log('\n=== Schema Validation Errors ===\n');
+  const schema = {
+    type: 'object',
+    required: ['name', 'age'],
+    properties: {
+      name: { type: 'string', minLength: 1 },
+      age: { type: 'number', minimum: 0, maximum: 150 }
+    }
+  };
+  const data = [
+    { name: 'John', age: 25 },
+    { name: '', age: 30 },          // Invalid: empty name
+    { name: 'Jane', age: -5 },      // Invalid: negative age
+    { name: 'Bob', age: 200 }       // Invalid: age > 150
+  ];
+  try {
+    jsonToCsv(data, { schema });
+  } catch (error) {
+    if (error instanceof ValidationError) {
+      console.log('Schema validation failed:');
+      console.log('Message:', error.message);
+    }
+  }
+}
+// =============================================================================
+// Run All Examples
+// =============================================================================
+async function main() {
+  console.log('jtcsv Error Handling Examples\n');
+  console.log('='.repeat(60));
+  basicErrorHandling();
+  await comprehensiveErrorHandling();
+  errorRecoveryStrategies();
+  await batchProcessingWithErrorCollection();
+  customErrorHandlerDemo();
+  await asyncWithRetries();
+  schemaValidationErrors();
+  console.log('\n' + '='.repeat(60));
+  console.log('All examples completed.');
+}
+main().catch(console.error);