@nteract/sift-csv 0.0.1 → 0.1.1-nightly.38500811922

package/README.md

@@ -1,13 +1,48 @@
-# @nteract/sift-csv 0.0.1
+# @nteract/sift-csv
 
-This version only reserves the package name so nteract's release workflow can
-publish through npm trusted publishing. It contains no code.
+CSV and TSV to Arrow IPC, in WebAssembly. Published as
+[`@nteract/sift-csv`](https://www.npmjs.com/package/@nteract/sift-csv). Built for
+[`@nteract/sift`](https://www.npmjs.com/package/@nteract/sift), usable by any
+Arrow consumer. Pin an exact version; the package is pre-1.0.
 
-Install a real build instead:
+```ts
+import { csvToArrowIpc } from '@nteract/sift-csv'
+import { loadTableFile } from '@nteract/sift'
 
-```sh
-npm install --save-exact @nteract/sift-csv@nightly
+const ipc = await csvToArrowIpc(text, { delimiter: '\t' })
+const data = await loadTableFile(ipc, { format: 'arrow-ipc' })
 ```
 
-Stable versions publish to `latest` from the nteract release workflow. See
-https://github.com/nteract/nteract/tree/main/packages/sift-csv.
+It is a separate package so apps that only open Parquet or Arrow do not carry
+the CSV parser: the WASM is about 2 MB (590 KB gzipped).
+
+## Behavior
+
+- Type inference reads the whole file. Booleans (`true`/`false`, any case),
+  Int64, Float64 (including exponents), ISO Date32, and ISO Timestamp columns
+  are detected. A column with mixed shapes is text.
+- Empty fields are null in every column type.
+- Files load whole or fail. Ragged rows, unbalanced quotes, and limit breaches
+  reject with the reason; nothing is truncated or sampled.
+- Defaults: 16 MiB input, 100,000 rows, 256 columns, 128 MiB of Arrow output.
+  Every limit is an option.
+
+## WASM asset
+
+`lib/wasm/sift_csv_wasm_bg.wasm` is resolved next to the glue through
+`import.meta.url`. When a bundler or iframe moves it, point at the binary first:
+
+```ts
+import { setWasmUrl } from '@nteract/sift-csv'
+setWasmUrl(new URL('@nteract/sift-csv/wasm', import.meta.url))
+```
+
+## Development
+
+```sh
+cargo xtask wasm sift-csv              # crates/sift-csv-wasm/pkg
+pnpm --dir packages/sift-csv test
+pnpm --dir packages/sift-csv build:lib
+pnpm --dir packages/sift-csv test:package
+cargo test -p sift-csv-wasm
+```

package/lib/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, runtimed
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.