@nteract/sift 0.5.5-nightly.38595740678 → 0.5.6
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.
- package/README.md +5 -3
- package/docs/embedding-guide.md +13 -3
- package/lib/wasm/sift_wasm_bg.wasm +0 -0
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -39,7 +39,9 @@ The package ships JavaScript, compiled CSS, TypeScript declarations, and WASM,
|
|
|
39
39
|
with notices for the Rust crates compiled into the WASM in
|
|
40
40
|
`lib/THIRD_PARTY_NOTICES.md`. React and React DOM are peer dependencies; no
|
|
41
41
|
notebook, kernel, or daemon is needed. Tested with React 19. Types resolve
|
|
42
|
-
under TypeScript's `bundler` module resolution (Vite, webpack, esbuild).
|
|
42
|
+
under TypeScript's `bundler` module resolution (Vite, webpack, esbuild). Pin an
|
|
43
|
+
exact version; stable nteract releases publish to `latest` and nightlies to the
|
|
44
|
+
`nightly` dist-tag.
|
|
43
45
|
|
|
44
46
|
```tsx
|
|
45
47
|
import { loadTableFile, SiftTable } from '@nteract/sift'
|
|
@@ -50,7 +52,7 @@ const load = useCallback(() => loadTableFile(bytes), [bytes]) // Parquet or Arro
|
|
|
50
52
|
```
|
|
51
53
|
|
|
52
54
|
Files load whole or fail; defaults are 16 MiB, 100,000 rows, and 256 columns.
|
|
53
|
-
CSV and TSV go through [`@nteract/sift-csv`](
|
|
55
|
+
CSV and TSV go through [`@nteract/sift-csv`](https://www.npmjs.com/package/@nteract/sift-csv), a separate WASM
|
|
54
56
|
module that returns Arrow IPC bytes for `loadTableFile`, so apps that only open
|
|
55
57
|
Parquet or Arrow do not carry the CSV parser.
|
|
56
58
|
|
|
@@ -84,7 +86,7 @@ cargo xtask wasm sift --skip-renderer-plugins
|
|
|
84
86
|
|-------|------|
|
|
85
87
|
| Layout | [@chenglou/pretext](https://github.com/chenglou/pretext) — DOM-free text measurement |
|
|
86
88
|
| Data | [Apache Arrow](https://arrow.apache.org/) — columnar, streamed via RecordBatchReader |
|
|
87
|
-
| Compute | [sift-wasm](
|
|
89
|
+
| Compute | [sift-wasm](https://github.com/nteract/nteract/tree/main/crates/sift-wasm) — arrow-rs WASM kernels |
|
|
88
90
|
| Reactivity | [RxJS](https://rxjs.dev/) — streaming pipeline |
|
|
89
91
|
| Charts | SVG histograms + HTML bars |
|
|
90
92
|
|
package/docs/embedding-guide.md
CHANGED
|
@@ -8,9 +8,17 @@ DOM are required even for the imperative API because column controls use React.
|
|
|
8
8
|
## Install and assets
|
|
9
9
|
|
|
10
10
|
```sh
|
|
11
|
-
npm install @nteract/sift react react-dom
|
|
11
|
+
npm install --save-exact @nteract/sift react react-dom
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
+
Pin an exact version. Stable nteract releases publish `@nteract/sift` to npm's
|
|
15
|
+
`latest` tag; nightly releases publish `<version>-nightly.<run ID>` to `nightly`
|
|
16
|
+
for hosts that track main between stables. `@nteract/sift-csv` follows the same
|
|
17
|
+
channels with its own version. Both carry npm provenance from the nteract
|
|
18
|
+
release workflow. Hosts that vendored a packed tarball can switch to the
|
|
19
|
+
registry package: it is the same `pnpm pack` output, with the same exports,
|
|
20
|
+
`lib/` layout, and `lib/THIRD_PARTY_NOTICES.md`.
|
|
21
|
+
|
|
14
22
|
```tsx
|
|
15
23
|
import { SiftTable, setWasmUrl } from '@nteract/sift'
|
|
16
24
|
import '@nteract/sift/style.css'
|
|
@@ -181,5 +189,7 @@ Accent and boolean colors keep Sift's defaults unless set, since a shadcn
|
|
|
181
189
|
|
|
182
190
|
`lib/THIRD_PARTY_NOTICES.md` lists the Rust crates compiled into the WASM with
|
|
183
191
|
their license texts and NOTICE files. Ship it with any app that redistributes
|
|
184
|
-
Sift.
|
|
185
|
-
|
|
192
|
+
Sift. The JavaScript in `lib/` is first-party; every npm dependency is
|
|
193
|
+
installed by the host under its own license. Building and
|
|
194
|
+
verifying the package from source is covered in `packages/sift/AGENTS.md` in
|
|
195
|
+
the nteract repository.
|
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nteract/sift",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.6",
|
|
4
4
|
"repository": {
|
|
5
5
|
"type": "git",
|
|
6
6
|
"url": "git+https://github.com/nteract/nteract.git",
|
|
@@ -62,9 +62,9 @@
|
|
|
62
62
|
],
|
|
63
63
|
"license": "BSD-3-Clause",
|
|
64
64
|
"nteractRelease": {
|
|
65
|
-
"channel": "
|
|
66
|
-
"sourceSha": "
|
|
67
|
-
"runId": "
|
|
65
|
+
"channel": "stable",
|
|
66
|
+
"sourceSha": "d552f512676a9edb718db72f5a4914ab308e47d0",
|
|
67
|
+
"runId": "38689790928"
|
|
68
68
|
},
|
|
69
69
|
"scripts": {
|
|
70
70
|
"generate": "npx tsx src/generate-data.ts",
|