buckaroo-js-core 0.8.5 → 0.14.0

package/LICENSE

@@ -1,15 +1,27 @@
-ISC License
+Copyright (c) 2019 Bloomberg
+All rights reserved.
 
-Copyright (c) 2022, Momtchil Momtchev <momtchil@momtchev.com>
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
 
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+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.

package/README.md

@@ -1,66 +1,70 @@
-# react-edit-list
+# buckaroo-js-core
 
-[![License: ISC](https://img.shields.io/github/license/mmomtchev/react-edit-list)](https://github.com/mmomtchev/react-edit-list/blob/main/LICENSE) [![npm version](https://img.shields.io/npm/v/react-edit-list)](https://www.npmjs.com/package/react-edit-list) [![Node.js CI](https://github.com/mmomtchev/react-edit-list/workflows/Node.js%20CI/badge.svg)](https://github.com/mmomtchev/react-edit-list/actions?query=workflow%3A%22Node.js+CI%22) [![codecov](https://codecov.io/gh/mmomtchev/react-edit-list/branch/main/graph/badge.svg?token=ZHVvNADJrZ)](https://codecov.io/gh/mmomtchev/react-edit-list)
+React + AG-Grid components and the infinite-scroll data layer that power the [Buckaroo](https://github.com/paddymul/buckaroo) DataFrame viewer.
 
-Universal Editable List React Component
+This package is the framework-agnostic JS half of Buckaroo. The Python widget side ships it bundled inside `buckaroo` on PyPI; you only need to install this package directly if you are:
 
-`react-edit-list` allows for easy creation of editable lists in React that can be interfaced with a database
+- embedding the DataFrame viewer in a React app outside Jupyter (e.g. a SPA),
+- building a custom widget shell against a different host, or
+- developing Buckaroo itself.
 
-*   Fully customizable
-*   Zero-dependency
-*   Supports async callbacks for calling externals APIs
-*   Supports input validation
-*   Supports optional `null` fields
-*   Supports custom field types
+## Install
 
-# Installation
-
-```shell
-npm i --save react-edit-layers
+```sh
+npm install buckaroo-js-core
+# or
+pnpm add buckaroo-js-core
+# or
+yarn add buckaroo-js-core
 ```
 
-# Usage
-
-Refer to the [examples](https://mmomtchev.github.io/react-edit-list/)
-
-![screenshot](https://raw.githubusercontent.com/mmomtchev/react-edit-list/main/screen-animation.gif)
-
-# API
-
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-### Table of Contents
-
-*   [\_](#\_)
-*   [AnimationTiming](#animationtiming)
-*   [AnimationDuration](#animationduration)
-*   [React](#react)
-*   [defaultProps](#defaultprops)
-
-## \_
-
-This module contains the standard library from rechart so that base rechart code cna be imported with the minimum amount of rewriting
-
-## AnimationTiming
-
-The type of easing function to use for animations
-
-Type: (`"ease"` | `"ease-in"` | `"ease-out"` | `"ease-in-out"` | `"linear"`)
+React 18 is a peer dependency.
+
+## Usage
+
+```tsx
+import { DFViewer } from "buckaroo-js-core";
+import "buckaroo-js-core/style.css";
+
+export function App() {
+  return (
+    <DFViewer
+      df_data={[{ index: 0, a: 1 }, { index: 1, a: 2 }]}
+      df_viewer_config={{
+        pinned_rows: [],
+        left_col_configs: [],
+        column_config: [
+          { col_name: "index", header_name: "index", displayer_args: { displayer: "obj" } },
+          { col_name: "a",     header_name: "a",     displayer_args: { displayer: "obj" } },
+        ],
+      }}
+    />
+  );
+}
+```
 
-## AnimationDuration
+Higher-level components are also exported:
 
-Specifies the duration of animation, the unit of this option is ms.
+- `DFViewer` — render a static array of rows
+- `DFViewerInfinite` — infinite-scroll grid backed by an AG-Grid datasource
+- `DFViewerInfiniteDS` — datasource-driven grid wired to a `KeyAwareSmartRowCache`
+- `BuckarooInfiniteWidget` — the full Buckaroo UI (status bar + grid + columns editor)
+- `getKeySmartRowCache` — factory that wires a model's `infinite_request` / `infinite_resp` messages into a row cache
 
-Type: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)
+See `src/index.ts` for the full export surface.
 
-## React
+## Development
 
-Reimplementation of rechart tooltips.  most of this is copied from ??? in the recharts source tree because the parts we are editting are deeply embedded into functions.
+```sh
+pnpm install
+pnpm run build           # tsc -b && vite build
+pnpm test                # jest
+pnpm run test:pw         # Playwright against Storybook
+pnpm storybook           # interactive component dev
+```
 
-Most of the point of this is to get tooltips to be absolutely positioned off of document.body, not the nearest parent element.  AG-Grid hides those tooltips otherwise.
+The package is part of the Buckaroo pnpm workspace at the repo root; see the [main README](https://github.com/paddymul/buckaroo) for the full build/release flow.
 
-## defaultProps
+## License
 
-needs to be set so that renderByOrder can access an have default values for
-children.props when there are no props set by the consumer
-doesn't work if using default parameters
+[BSD-3-Clause](./LICENSE)