npm - convert-csv-to-json - Versions diffs - 4.14.0 → 4.16.0 - Mend

convert-csv-to-json 4.14.0 → 4.16.0

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 (38) hide show

package/.github/workflows/ci-cd.yml +1 -1
package/docs/.nojekyll +0 -0
package/docs/README.md +44 -0
package/docs/demo.bundle.js +1708 -0
package/docs/index.html +536 -0
package/eslint.config.js +1 -1
package/package.json +5 -1
package/docs/api/BrowserApi.html +0 -2662
package/docs/api/BrowserApiError.html +0 -669
package/docs/api/ConfigurationError.html +0 -745
package/docs/api/CsvFormatError.html +0 -677
package/docs/api/CsvParsingError.html +0 -511
package/docs/api/CsvToJson.html +0 -3367
package/docs/api/CsvToJsonAsync.html +0 -2880
package/docs/api/FileOperationError.html +0 -382
package/docs/api/FileUtils.html +0 -1150
package/docs/api/InputValidationError.html +0 -407
package/docs/api/JsonUtil.html +0 -452
package/docs/api/JsonValidationError.html +0 -357
package/docs/api/StringUtils.html +0 -833
package/docs/api/global.html +0 -3498
package/docs/api/index.html +0 -414
package/docs/api/index.js.html +0 -447
package/docs/api/scripts/app.min.js +0 -1
package/docs/api/scripts/linenumber.js +0 -26
package/docs/api/scripts/search.js +0 -39
package/docs/api/src_browserApi.js.html +0 -362
package/docs/api/src_csvToJson.js.html +0 -696
package/docs/api/src_csvToJsonAsync.js.html +0 -335
package/docs/api/src_util_errors.js.html +0 -472
package/docs/api/src_util_fileUtils.js.html +0 -238
package/docs/api/src_util_jsonUtils.js.html +0 -166
package/docs/api/src_util_stringUtils.js.html +0 -306
package/docs/api/styles/app.min.css +0 -1
package/docs/api/styles/iframe.css +0 -13
package/docs/api/styles/prettify-jsdoc.css +0 -111
package/docs/api/styles/prettify-tomorrow.css +0 -132
package/docs/api/styles/reset.css +0 -44

package/docs/api/src_browserApi.js.html DELETED Viewed

@@ -1,362 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="utf-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1">
-  <title> src/browserApi.js</title>
-  <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
-  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
-  <script src="./build/entry.js"></script>
-  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
-  <!--[if lt IE 9]>
-    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-  <![endif]-->
-  <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
-  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
-  <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
-  <link type="text/css" rel="stylesheet" href="styles/app.min.css">
-  <link type="text/css" rel="stylesheet" href="styles/iframe.css">
-  <link type="text/css" rel="stylesheet" href="./node_modules/better-docs/css/better-docs.css">
-  <script async defer src="https://buttons.github.io/buttons.js"></script>
-</head>
-<body class="layout small-header">
-    <div id="stickyNavbarOverlay"></div>
-<div class="top-nav">
-    <div class="inner">
-        <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
-            <span aria-hidden="true"></span>
-            <span aria-hidden="true"></span>
-            <span aria-hidden="true"></span>
-        </a>
-        <div class="logo">
-                <a class="image" href="index.html">
-                    <img src="https://raw.githubusercontent.com/iuccio/CSVtoJSON/master/CSVtoJSON.png" alt="logo">
-                </a>
-                <a href="index.html">
-                    <h1 class="navbar-item">Convert CSV to JSON</h1>
-                </a>
-        </div>
-        <div class="menu">
-            <div class="navigation">
-                <a
-                    href="index.html"
-                    class="link"
-                >
-                    Documentation
-                </a>
-                        <a
-                            class="link user-link "
-                            href="https://github.com/iuccio/CSVtoJSON"
-                        >
-                            GitHub
-                        </a>
-                        <a
-                            class="link user-link "
-                            href="https://www.npmjs.com/package/convert-csv-to-json"
-                        >
-                            NPM
-                        </a>
-            </div>
-        </div>
-    </div>
-</div>
-    <div id="main">
-        <div
-            class="sidebar "
-            id="sidebarNav"
-        >
-            <nav>
-                    <h2><a href="index.html">Documentation</a></h2><div class="category"></div><div class="category"><h2>1-Core API</h2><h3>Global</h3><ul><li><a href="global.html#asciiEncoding">asciiEncoding</a></li><li><a href="global.html#base64Encoding">base64Encoding</a></li><li><a href="global.html#csvStringToJson">csvStringToJson</a></li><li><a href="global.html#csvStringToJsonStringified">csvStringToJsonStringified</a></li><li><a href="global.html#csvToJsonAsync">csvToJsonAsync</a></li><li><a href="global.html#customEncoding">customEncoding</a></li><li><a href="global.html#fieldDelimiter">fieldDelimiter</a></li><li><a href="global.html#formatValueByType">formatValueByType</a></li><li><a href="global.html#generateJsonFileFromCsv">generateJsonFileFromCsv</a></li><li><a href="global.html#getJsonFromCsv">getJsonFromCsv</a></li><li><a href="global.html#hexEncoding">hexEncoding</a></li><li><a href="global.html#indexHeader">indexHeader</a></li><li><a href="global.html#latin1Encoding">latin1Encoding</a></li><li><a href="global.html#mapRows">mapRows</a></li><li><a href="global.html#parseSubArray">parseSubArray</a></li><li><a href="global.html#supportQuotedField">supportQuotedField</a></li><li><a href="global.html#trimHeaderFieldWhiteSpace">trimHeaderFieldWhiteSpace</a></li><li><a href="global.html#ucs2Encoding">ucs2Encoding</a></li><li><a href="global.html#utf16leEncoding">utf16leEncoding</a></li><li><a href="global.html#utf8Encoding">utf8Encoding</a></li></ul></div><div class="category"><h2>2-Sync</h2><h3>Classes</h3><ul><li><a href="CsvToJson.html">CsvToJson</a></li></ul></div><div class="category"><h2>3-Async</h2><h3>Classes</h3><ul><li><a href="CsvToJsonAsync.html">CsvToJsonAsync</a></li></ul></div><div class="category"><h2>4-Browser</h2><h3>Classes</h3><ul><li><a href="BrowserApi.html">BrowserApi</a></li></ul></div><div class="category"><h2>Error Classes</h2><h3>Classes</h3><ul><li><a href="BrowserApiError.html">BrowserApiError</a></li><li><a href="ConfigurationError.html">ConfigurationError</a></li><li><a href="CsvFormatError.html">CsvFormatError</a></li><li><a href="CsvParsingError.html">CsvParsingError</a></li><li><a href="FileOperationError.html">FileOperationError</a></li><li><a href="InputValidationError.html">InputValidationError</a></li><li><a href="JsonValidationError.html">JsonValidationError</a></li></ul></div><div class="category"><h2>Utilities</h2><h3>Classes</h3><ul><li><a href="FileUtils.html">FileUtils</a></li><li><a href="JsonUtil.html">JsonUtil</a></li><li><a href="StringUtils.html">StringUtils</a></li></ul></div>
-            </nav>
-        </div>
-        <div class="core" id="main-content-wrapper">
-            <div class="content">
-                <header class="page-title">
-                    <p>Source</p>
-                    <h1>src/browserApi.js</h1>
-                </header>
-    <section>
-        <article>
-            <pre class="prettyprint source linenums"><code>/* globals CsvFormatError */
-"use strict";
-const csvToJson = require('./csvToJson');
-const { InputValidationError, BrowserApiError } = require('./util/errors');
-/**
- * Browser-friendly CSV to JSON API
- * Provides methods for parsing CSV strings and File/Blob objects in browser environments
- * Proxies configuration to sync csvToJson instance
- * @category 4-Browser
- */
-class BrowserApi {
-  /**
-   * Constructor initializes proxy to sync csvToJson instance
-   */
-  constructor() {
-    // reuse the existing csvToJson instance for parsing and configuration
-    this.csvToJson = csvToJson;
-  }
-  /**
-   * Enable or disable automatic type formatting for values
-   * @param {boolean} active - Whether to format values by type (default: true)
-   * @returns {this} For method chaining
-   */
-  formatValueByType(active = true) {
-    this.csvToJson.formatValueByType(active);
-    return this;
-  }
-  /**
-   * Enable or disable support for RFC 4180 quoted fields
-   * @param {boolean} active - Whether to support quoted fields (default: false)
-   * @returns {this} For method chaining
-   */
-  supportQuotedField(active = false) {
-    this.csvToJson.supportQuotedField(active);
-    return this;
-  }
-  /**
-   * Set the field delimiter character
-   * @param {string} delimiter - Character(s) to use as field separator
-   * @returns {this} For method chaining
-   */
-  fieldDelimiter(delimiter) {
-    this.csvToJson.fieldDelimiter(delimiter);
-    return this;
-  }
-  /**
-   * Configure whitespace handling in header field names
-   * @param {boolean} active - If true, removes all whitespace; if false, only trims edges (default: false)
-   * @returns {this} For method chaining
-   */
-  trimHeaderFieldWhiteSpace(active = false) {
-    this.csvToJson.trimHeaderFieldWhiteSpace(active);
-    return this;
-  }
-  /**
-   * Set the row index where CSV headers are located
-   * @param {number} index - Zero-based row index containing headers
-   * @returns {this} For method chaining
-   */
-  indexHeader(index) {
-    this.csvToJson.indexHeader(index);
-    return this;
-  }
-  /**
-   * Configure sub-array parsing for special field values
-   * @param {string} delimiter - Bracket character (default: '*')
-   * @param {string} separator - Item separator within brackets (default: ',')
-   * @returns {this} For method chaining
-   */
-  parseSubArray(delimiter = '*', separator = ',') {
-    this.csvToJson.parseSubArray(delimiter, separator);
-    return this;
-  }
-  /**
-   * Set a mapper function to transform each row after conversion
-   * @param {function(object, number): (object|null)} mapperFn - Function receiving (row, index) that returns transformed row or null to filter
-   * @returns {this} For method chaining
-   */
-  mapRows(mapperFn) {
-    this.csvToJson.mapRows(mapperFn);
-    return this;
-  }
-  /**
-   * Parse a CSV string and return as JSON array of objects
-   * @param {string} csvString - CSV content as string
-   * @returns {Array&lt;object>} Array of objects representing CSV rows
-   * @throws {InputValidationError} If csvString is invalid
-   * @throws {CsvFormatError} If CSV is malformed
-   * @example
-   * const csvToJson = require('convert-csv-to-json');
-   * const rows = csvToJson.browser.csvStringToJson('name,age\nAlice,30');
-   * console.log(rows); // [{ name: 'Alice', age: '30' }]
-   */
-  csvStringToJson(csvString) {
-    if (csvString === undefined || csvString === null) {
-      throw new InputValidationError(
-        'csvString',
-        'string',
-        `${typeof csvString}`,
-        'Provide valid CSV content as a string to parse.'
-      );
-    }
-    return this.csvToJson.csvToJson(csvString);
-  }
-  /**
-   * Parse a CSV string and return as stringified JSON
-   * @param {string} csvString - CSV content as string
-   * @returns {string} JSON stringified array of objects
-   * @throws {InputValidationError} If csvString is invalid
-   * @throws {CsvFormatError} If CSV is malformed
-   * @example
-   * const csvToJson = require('convert-csv-to-json');
-   * const jsonString = csvToJson.browser.csvStringToJsonStringified('name,age\nAlice,30');
-   * console.log(jsonString);
-   */
-  csvStringToJsonStringified(csvString) {
-    if (csvString === undefined || csvString === null) {
-      throw new InputValidationError(
-        'csvString',
-        'string',
-        `${typeof csvString}`,
-        'Provide valid CSV content as a string to parse.'
-      );
-    }
-    return this.csvToJson.csvStringToJsonStringified(csvString);
-  }
-  /**
-   * Parse a CSV string asynchronously (returns resolved Promise)
-   * @param {string} csvString - CSV content as string
-   * @returns {Promise&lt;Array&lt;object>>} Promise resolving to array of objects
-   * @throws {InputValidationError} If csvString is invalid
-   * @throws {CsvFormatError} If CSV is malformed
-   * @example
-   * const csvToJson = require('convert-csv-to-json');
-   * const rows = await csvToJson.browser.csvStringToJsonAsync('name,age\nAlice,30');
-   * console.log(rows);
-   */
-  csvStringToJsonAsync(csvString) {
-    return Promise.resolve(this.csvStringToJson(csvString));
-  }
-  /**
-   * Parse a CSV string asynchronously and return as stringified JSON
-   * @param {string} csvString - CSV content as string
-   * @returns {Promise&lt;string>} Promise resolving to JSON stringified array
-   * @throws {InputValidationError} If csvString is invalid
-   * @throws {CsvFormatError} If CSV is malformed
-   * @example
-   * const csvToJson = require('convert-csv-to-json');
-   * const json = await csvToJson.browser.csvStringToJsonStringifiedAsync('name,age\nAlice,30');
-   * console.log(json);
-   */
-  csvStringToJsonStringifiedAsync(csvString) {
-    return Promise.resolve(this.csvStringToJsonStringified(csvString));
-  }
-  /**
-   * Parse a browser File or Blob object to JSON array.
-   * @param {File|Blob} file - File or Blob to read as text
-   * @param {object} [options] - options: { encoding?: string }
-   * @returns {Promise&lt;object[]>} Promise resolving to parsed JSON rows
-   * @example
-   * const csvToJson = require('convert-csv-to-json');
-   * const fileInput = document.querySelector('#csvfile').files[0];
-   * const rows = await csvToJson.browser.parseFile(fileInput);
-   * console.log(rows);
-   */
-  parseFile(file, options = {}) {
-    if (!file) {
-      return Promise.reject(new InputValidationError(
-        'file',
-        'File or Blob object',
-        `${typeof file}`,
-        'Provide a valid File or Blob object to parse.'
-      ));
-    }
-    return new Promise((resolve, reject) => {
-      if (typeof FileReader === 'undefined') {
-        reject(BrowserApiError.fileReaderNotAvailable());
-        return;
-      }
-      const reader = new FileReader();
-      reader.onerror = () => reject(BrowserApiError.parseFileError(
-        reader.error || new Error('Unknown file reading error')
-      ));
-      reader.onload = () => {
-        try {
-          const text = reader.result;
-          const result = this.csvToJson.csvToJson(String(text));
-          resolve(result);
-        } catch (err) {
-          reject(BrowserApiError.parseFileError(err));
-        }
-      };
-      // If encoding is provided, pass it to readAsText
-      if (options.encoding) {
-        reader.readAsText(file, options.encoding);
-      } else {
-        reader.readAsText(file);
-      }
-    });
-  }
-}
-module.exports = new BrowserApi();
-</code></pre>
-        </article>
-    </section>
-            </div>
-            <footer class="footer">
-                <div class="content has-text-centered">
-                    <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.5</a></p>
-                    <p class="sidebar-created-by">
-                        <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
-                        <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
-                    </p>
-                </div>
-            </footer>
-        </div>
-        <div id="side-nav" class="side-nav">
-        </div>
-    </div>
-<script src="scripts/app.min.js"></script>
-<script>PR.prettyPrint();</script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>