web-csv-toolbox 0.2.0 → 0.3.1

package/README.md

@@ -1,6 +1,5 @@
 <div align="center">
 
-[![Node.js CI](https://github.com/kamiazya/web-csv-toolbox/actions/workflows/node.js.yaml/badge.svg)](https://github.com/kamiazya/web-csv-toolbox/actions/workflows/node.js.yaml)
 [![npm version](https://badge.fury.io/js/web-csv-toolbox.svg)](https://badge.fury.io/js/web-csv-toolbox)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
@@ -38,9 +37,8 @@ A CSV Toolbox utilizing Web Standard APIs.
   - Using only Web Standards APIs.
 - 💪 **Property-based testing.**
   - Using [fast-check](https://fast-check.dev/) and [vitest](https://vitest.dev).
-- ✅ **_To Be Tested_** **Cross-platform.**
+- ✅ **Cross-platform.**
   - Works on browsers, Node.js, and Deno.
-    - Only web standard APIs are used, so it should work with these runtimes.
 
 ## Key Features 📗
 
@@ -58,6 +56,10 @@ A CSV Toolbox utilizing Web Standard APIs.
 
 ## Installation 📥
 
+### With Package manager 📦
+
+This package can then be installed using a package manager.
+
 ```sh
 # Install with npm
 $ npm install web-csv-toolbox
@@ -67,6 +69,50 @@ $ yarn add web-csv-toolbox
 $ pnpm add web-csv-toolbox
 ```
 
+### From CDN (unpkg.com) 🌐
+
+#### UMD Style 🔄
+
+```html
+<script src="https://unpkg.com/web-csv-toolbox"></script>
+<script>
+const csv = `name,age
+Alice,42
+Bob,69`;
+
+(async function () {
+  for await (const record of CSV.parse(csv)) {
+    console.log(record);
+  }
+})();
+</script>
+```
+
+
+#### ESModule Style 📦
+
+```html
+<script type="module">
+import { parse } from 'https://unpkg.com/web-csv-toolbox/lib/index.js';
+
+const csv = `name,age
+Alice,42
+Bob,69`;
+
+for await (const record of parse(csv)) {
+  console.log(record);
+}
+</script>
+```
+
+#### Deno 🦕
+
+You can install and use the package by specifying the following:
+
+```js
+import { parse } from "npm:web-csv-toolbox";
+```
+
 ## Usage 📘
 
 ### Parsing CSV files from strings
@@ -158,6 +204,30 @@ for await (const record of parse(csv, { headers: ['name', 'age'] })) {
 // { name: 'Bob', age: '69' }
 ```
 
+## Supported Runtimes 💻
+
+### Works on Node.js [![Node.js CI](https://github.com/kamiazya/web-csv-toolbox/actions/workflows/node.js.yaml/badge.svg)](https://github.com/kamiazya/web-csv-toolbox/actions/workflows/node.js.yaml)
+
+| Versions | Status |
+| -------- | ------ |
+| 20.x     | ✅     |
+| 18.x     | ✅     |
+
+
+### Works on Browser [![Browsers CI](https://github.com/kamiazya/web-csv-toolbox/actions/workflows/browsers.yaml/badge.svg)](https://github.com/kamiazya/web-csv-toolbox/actions/workflows/browsers.yaml)
+
+| OS      | Chrome | FireFox | Default       |
+| ------- | ------ | ------- | ------------- |
+| Windows | ✅     | ✅      | ✅ (Edge)     |
+| macos   | ✅     | ✅      | ⬜ (Safari *) |
+| Linux   | ✅     | ✅      | -             |
+
+> **\* To Be Tested**:  [I couldn't launch Safari in headless mode](https://github.com/vitest-dev/vitest/blob/main/packages/browser/src/node/providers/webdriver.ts#L39-L41) on GitHub Actions, so I couldn't verify it, but it probably works.
+
+### Others
+
+- Verify that JavaScript is executable on the Deno. [![Deno CI](https://github.com/kamiazya/web-csv-toolbox/actions/workflows/deno.yaml/badge.svg)](https://github.com/kamiazya/web-csv-toolbox/actions/workflows/deno.yaml)
+
 ## APIs 🧑‍💻
 
 ### High-level APIs 🚀
@@ -204,20 +274,20 @@ ideal for developers looking for in-depth control and flexibility.
 
 ### Common Options ⚙️
 
-| Option         | Description                           | Default     | Notes |
-| -------------- | ------------------------------------- | ----------- | ----- |
-| `delimiter`    | Character to separate fields          | `,`         |       |
-| `quotation`    | Character used for quoting fields     | `"`         |       |
-| `headers`      | Custom headers for the parsed records | First row   | If not provided, the first row is used as headers |
+| Option      | Description                           | Default   | Notes                                             |
+| ----------- | ------------------------------------- | --------- | ------------------------------------------------- |
+| `delimiter` | Character to separate fields          | `,`       |                                                   |
+| `quotation` | Character used for quoting fields     | `"`       |                                                   |
+| `headers`   | Custom headers for the parsed records | First row | If not provided, the first row is used as headers |
 
 ### Advanced Options (Binary-Specific) 🧬
 
-| Option          | Description                                       | Default   | Notes |
-| --------------- | ------------------------------------------------- | --------- | ---------------------- |
-| `charset`       | Character encoding for binary CSV inputs          | `utf-8`   | See [Encoding API Compatibility](https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API/Encodings) for the encoding formats that can be specified. |
-| `decompression` | Decompression algorithm for compressed CSV inputs |           | See [DecompressionStream Compatibility](https://developer.mozilla.org/en-US/docs/Web/API/DecompressionStream#browser_compatibilit). |
-| `ignoreBOM`     | Whether to ignore Byte Order Mark (BOM)           | `false`   | See [TextDecoderOptions.ignoreBOM](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoderStream/ignoreBOM) for more information about the BOM. |
-| `fatal`         | Throw an error on invalid characters              | `false`   | See [TextDecoderOptions.fatal](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoderStream/fatal) for more information. |
+| Option          | Description                                       | Default | Notes                                                                                                                                                     |
+| --------------- | ------------------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `charset`       | Character encoding for binary CSV inputs          | `utf-8` | See [Encoding API Compatibility](https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API/Encodings) for the encoding formats that can be specified. |
+| `decompression` | Decompression algorithm for compressed CSV inputs |         | See [DecompressionStream Compatibility](https://developer.mozilla.org/en-US/docs/Web/API/DecompressionStream#browser_compatibilit).                       |
+| `ignoreBOM`     | Whether to ignore Byte Order Mark (BOM)           | `false` | See [TextDecoderOptions.ignoreBOM](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoderStream/ignoreBOM) for more information about the BOM.      |
+| `fatal`         | Throw an error on invalid characters              | `false` | See [TextDecoderOptions.fatal](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoderStream/fatal) for more information.                            |
 
 ## How to Contribute 💪
 

package/lib/index.js

@@ -1,13 +1,11 @@
 const FieldDelimiter = Symbol.for("web-streams-csv.FieldDelimiter");
 const RecordDelimiter = Symbol.for("web-streams-csv.RecordDelimiter");
 const Field = Symbol.for("web-streams-csv.Field");
-
 const CR = "\r";
 const CRLF = "\r\n";
 const LF = "\n";
 const COMMA = ",";
 const DOUBLE_QUATE = '"';
-
 function assertCommonOptions(options) {
   if (typeof options.quotation === "string" && options.quotation.length === 0) {
     throw new Error("quotation must not be empty");
@@ -30,11 +28,9 @@ function assertCommonOptions(options) {
     );
   }
 }
-
 function escapeRegExp(v) {
   return v.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 }
-
 class LexerTransformer extends TransformStream {
   #demiliter;
   #demiliterLength;
@@ -166,7 +162,6 @@ class LexerTransformer extends TransformStream {
     return null;
   }
 }
-
 class RecordAssemblerTransformar extends TransformStream {
   #fieldIndex = 0;
   #row = [];
@@ -229,7 +224,6 @@ class RecordAssemblerTransformar extends TransformStream {
     }
   }
 }
-
 class SingleValueReadableStream extends ReadableStream {
   constructor(value) {
     super({
@@ -240,7 +234,6 @@ class SingleValueReadableStream extends ReadableStream {
     });
   }
 }
-
 async function toArray(...args) {
   const rows = [];
   for await (const row of this(...args)) {
@@ -248,7 +241,6 @@ async function toArray(...args) {
   }
   return rows;
 }
-
 async function* parseStringStream(stream, options) {
   let controller;
   const readable = new ReadableStream({
@@ -277,14 +269,12 @@ async function* parseStringStream(stream, options) {
 ((parseStringStream) => {
   parseStringStream.toArray = toArray;
 })(parseStringStream || (parseStringStream = {}));
-
 async function* parseString(csv, options) {
   yield* parseStringStream(new SingleValueReadableStream(csv), options);
 }
 ((parseString) => {
   parseString.toArray = toArray;
 })(parseString || (parseString = {}));
-
 async function* parseBinaryStream(stream, options) {
   const { charset, fatal, ignoreBOM, decomposition } = options ?? {};
   yield* parseStringStream(
@@ -298,7 +288,6 @@ async function* parseBinaryStream(stream, options) {
 ((parseBinaryStream) => {
   parseBinaryStream.toArray = toArray;
 })(parseBinaryStream || (parseBinaryStream = {}));
-
 function parseMime(contentType) {
   const [type, ...parameters] = contentType.split(";");
   const result = {
@@ -311,7 +300,6 @@ function parseMime(contentType) {
   }
   return result;
 }
-
 function parseResponse(response, options) {
   const { headers } = response;
   const contentType = headers.get("content-type") ?? "text/csv";
@@ -333,7 +321,6 @@ function parseResponse(response, options) {
 ((parseResponse) => {
   parseResponse.toArray = toArray;
 })(parseResponse || (parseResponse = {}));
-
 async function* parseStream(stream, options) {
   const [branch1, branch2] = stream.tee();
   const reader1 = branch1.getReader();
@@ -348,7 +335,6 @@ async function* parseStream(stream, options) {
 ((parseStream) => {
   parseStream.toArray = toArray;
 })(parseStream || (parseStream = {}));
-
 async function* parse(csv, options) {
   if (typeof csv === "string") {
     yield* parseString(csv, options);
@@ -361,7 +347,6 @@ async function* parse(csv, options) {
 ((parse) => {
   parse.toArray = toArray;
 })(parse || (parse = {}));
-
 export {
   Field,
   FieldDelimiter,

package/lib/index.umd.js

@@ -0,0 +1 @@
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self).CSV={})}(this,(function(e){"use strict";const t=Symbol.for("web-streams-csv.FieldDelimiter"),i=Symbol.for("web-streams-csv.RecordDelimiter"),r=Symbol.for("web-streams-csv.Field"),n="\n";function s(e){return e.replace(/[.*+?^${}()|[\]\\]/g,"\\$&")}class o extends TransformStream{#e;#t;#i;#r;#n;#s="";get demiliter(){return this.#e}get quotation(){return this.#i}constructor({demiliter:e=",",quotation:t='"'}={}){!function(e){if("string"==typeof e.quotation&&0===e.quotation.length)throw new Error("quotation must not be empty");if("string"==typeof e.demiliter&&0===e.demiliter.length)throw new Error("demiliter must not be empty");if(e.quotation.includes(n)||e.quotation.includes("\r"))throw new Error("quotation must not include CR or LF");if(e.demiliter.includes(n)||e.demiliter.includes("\r"))throw new Error("demiliter must not include CR or LF");if(e.demiliter.includes(e.quotation)||e.quotation.includes(e.demiliter))throw new Error("demiliter and quotation must not include each other as a substring")}({demiliter:e,quotation:t}),super({transform:(e,t)=>{if(0!==e.length){this.#s+=e;for(const e of this.#o({flush:!1}))t.enqueue(e)}},flush:e=>{for(const t of this.#o({flush:!0}))e.enqueue(t)}}),this.#e=e,this.#t=e.length,this.#i=t,this.#r=t.length;const i=s(e),r=s(t);this.#n=new RegExp(`^(?:(?!${r})(?!${i})(?![\\r\\n]))([\\S\\s\\uFEFF\\xA0]+?)(?=${r}|${i}|\\r|\\n|$)`)}*#o({flush:e}){let n=null;for(let s;s=this.#a({flush:e});)switch(s.type){case r:n?n.value+=s.value:n=s;break;case t:case i:n&&(yield n,n=null),yield s}n&&(yield n)}#a({flush:e=!1}={}){if(0===this.#s.length)return null;if(this.#s.startsWith("\r\n"))return this.#s=this.#s.slice(2),{type:i,value:"\r\n"};if(this.#s.startsWith(n))return this.#s=this.#s.slice(1),{type:i,value:n};if(this.#s.startsWith(this.#e))return this.#s=this.#s.slice(this.#t),{type:t,value:this.#e};if(this.#s.startsWith(this.#i))return!1===e&&this.#s.endsWith(this.#i)?null:this.extractQuotedString();const s=this.#n.exec(this.#s);return s?!1===e&&s[0].length===this.#s.length?null:(this.#s=this.#s.slice(s[0].length),{type:r,value:s[0]}):null}extractQuotedString(){let e=this.#r,t="";for(;e<this.#s.length;)if(this.#s.slice(e,e+this.#r)!==this.quotation||this.#s.slice(e+this.#r,e+2*this.#r)!==this.quotation){if(this.#s.slice(e,e+this.#r)===this.quotation)return this.#s=this.#s.slice(e+this.#r),{type:r,value:t};t+=this.#s[e],e++}else t+=this.quotation,e+=2*this.#r;return null}}class a extends TransformStream{#u=0;#h=[];#l;#f=!1;constructor(e={}){super({transform:(e,n)=>{switch(e.type){case r:this.#f=!0,this.#h[this.#u]=e.value;break;case t:this.#u++;break;case i:if(void 0===this.#l)this.#d(this.#h);else if(this.#f){const e=Object.fromEntries(this.#l.filter((e=>e)).map(((e,t)=>[e,this.#h.at(t)])));n.enqueue(e)}this.#u=0,this.#h=new Array(this.#l?.length),this.#f=!1}},flush:e=>{if(0!==this.#u&&void 0!==this.#l&&this.#f){const t=Object.fromEntries(this.#l.filter((e=>e)).map(((e,t)=>[e,this.#h.at(t)])));e.enqueue(t)}}}),void 0!==e.header&&Array.isArray(e.header)&&this.#d(e.header)}#d(e){if(this.#l=e,0===this.#l.length)throw new Error("The header must not be empty.");if(new Set(this.#l).size!==this.#l.length)throw new Error("The header must not contain duplicate fields.")}}class u extends ReadableStream{constructor(e){super({start(t){t.enqueue(e),t.close()}})}}async function h(...e){const t=[];for await(const i of this(...e))t.push(i);return t}async function*l(e,t){let i;const r=new ReadableStream({start:e=>i=e});await e.pipeThrough(new o(t)).pipeThrough(new a(t)).pipeTo(new WritableStream({write:e=>i.enqueue(e),close:()=>i.close()}));const n=r.getReader();try{for(;;){const{value:e,done:t}=await n.read();if(t)break;yield e}}finally{n.releaseLock()}}async function*f(e,t){yield*l(new u(e),t)}async function*d(e,t){const{charset:i,fatal:r,ignoreBOM:n,decomposition:s}=t??{};yield*l([...s?[new DecompressionStream(s)]:[],new TextDecoderStream(i,{fatal:r,ignoreBOM:n})].reduce(((e,t)=>e.pipeThrough(t)),e),t)}function c(e,t){const{headers:i}=e,r=i.get("content-type")??"text/csv",n=function(e){const[t,...i]=e.split(";"),r={type:t.trim(),parameters:{}};for(const e of i){const[t,i]=e.split("=");r.parameters[t.trim()]=i.trim()}return r}(r);if("text/csv"!==n.type)throw new Error(`Invalid mime type: ${r}`);const s=i.get("content-encoding")??void 0,o=n.parameters.charset??"utf-8";if(null===e.body)throw new Error("Response body is null");return d(e.body,{decomposition:s,charset:o,...t})}async function*m(e,t){const[i,r]=e.tee(),n=i.getReader(),{value:s}=await n.read();n.releaseLock(),"string"==typeof s?yield*l(r,t):s instanceof Uint8Array&&(yield*d(r,t))}async function*y(e,t){"string"==typeof e?yield*f(e,t):e instanceof ReadableStream?yield*m(e,t):e instanceof Response&&(yield*c(e,t))}!function(e){e.toArray=h}(l||(l={})),function(e){e.toArray=h}(f||(f={})),function(e){e.toArray=h}(d||(d={})),function(e){e.toArray=h}(c||(c={})),function(e){e.toArray=h}(m||(m={})),function(e){e.toArray=h}(y||(y={})),e.Field=r,e.FieldDelimiter=t,e.LexerTransformer=o,e.RecordAssemblerTransformar=a,e.RecordDelimiter=i,e.parse=y,e.parseBinaryStream=d,e.parseResponse=c,e.parseStream=m,e.parseString=f,e.parseStringStream=l}));

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "web-csv-toolbox",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "A CSV Toolbox utilizing Web Standard APIs.",
   "type": "module",
   "main": "lib/index.js",
   "module": "lib/index.js",
   "types": "lib/index.d.ts",
+  "unpkg": "lib/index.umd.js",
   "engines": {
     "node": ">=18.0.0"
   },
@@ -23,6 +24,7 @@
   "scripts": {
     "doc": "typedoc",
     "test": "vitest",
+    "test:browser": "vitest --browser",
     "format": "biome format . --write",
     "lint": "biome lint .",
     "check": "biome check src --apply",
@@ -51,9 +53,10 @@
     "@changesets/changelog-github": "^0.5.0",
     "@changesets/cli": "^2.27.1",
     "@fast-check/vitest": "^0.0.9",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@vitest/browser": "^1.1.0",
     "changesets-github-release": "^0.1.0",
     "husky": "^8.0.0",
-    "jsdom": "^23.0.1",
     "lint-staged": "^15.2.0",
     "rollup": "^4.9.1",
     "rollup-plugin-delete": "^2.0.0",
@@ -62,6 +65,7 @@
     "typedoc": "^0.25.4",
     "typedoc-plugin-mdn-links": "^3.1.9",
     "typescript": "^5.3.2",
-    "vitest": "^1.1.0"
+    "vitest": "^1.1.0",
+    "webdriverio": "^8.27.0"
   }
 }