@rokkit/data 1.0.0-next.94

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Jerry Thomas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,50 @@
+# @rokkit/data
+
+This package provides a set of tools for managing and manipulating data in user interfaces. It is framework agnostic and can be used with any ui framework.
+
+## Features
+
+- **Datasets:** Manage and manipulate datasets with ease
+  - filtering, sorting, and aggregation.
+  - **Joins:** Combine datasets effortlessly with support for inner, outer, left, and right joins.
+  - **Rollup:** Summarize data across multiple dimensions, calculating aggregate statistics like sum, average, min, and max.
+- **Modeling:** Create and manage data models, including merging, renaming, and resolving conflicts.
+- **Renaming:** Simplify key renaming in JavaScript objects, with options for prefixes, suffixes, and custom separators.
+- **Dataviews:** Create interactive views for exploring and analyzing datasets, including sortable and filterable columns.
+
+## Dataset
+
+- The `dataset` function initializes a dataset from an array of objects.
+- This dataset comprises data rows that are sortable, filterable, and groupable.
+- Leverage dataset for SQL-like operations such as selecting, updating, and deleting rows.
+- Employ aggregate functions like sum, average, and count for summarizing multiple attributes of the data.
+- Utilize the dataset for various data operations like joining and merging data from disparate sources.
+- Establish connected data views with joins to visualize data relationships, particularly for tracking parent-child connections.
+
+This makes it easier to build a tweenable data structure for animations. Here is an example of how to use the `dataset` to generate a tweenable data:
+
+```js
+function tweenable(data, by, group, template) {
+  return dataset(data)
+    .groupBy(by)
+    .using(template)
+    .alignBy(...group)
+    .rollup()
+    .sortBy(by)
+    .select()
+}
+```
+
+Refer to [dataset](docs/dataset.md) documentation for more details.
+
+## DataView
+
+- Utilize the `dataview` function to create a data view, enabling dynamic data manipulation and observation.
+- This view facilitates sorting, filtering, and grouping data while providing insight into selected or hidden rows.
+- The original dataset remains untouched while the view offers flexible data presentation options.
+- Associate actions such as select, edit, and delete with data rows using action columns within the view.
+- Manage data effectively, including parent-child links, even within a flat array structure.
+
+Refer to [dataview](docs/dataview.md) documentation for more details.
+
+The `dataview` function initializes a manageable data state with methods that allow for manipulation and observation of data changes, integrating smoothly with UI updates.

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@rokkit/data",
+  "version": "1.0.0-next.94",
+  "description": "Contains generic data manipulation functions that can be used in various components.",
+  "author": "Jerry Thomas <me@jerrythomas.name>",
+  "license": "MIT",
+  "main": "index.js",
+  "module": "src/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@sveltejs/vite-plugin-svelte": "^3.0.2",
+    "@testing-library/svelte": "^4.1.0",
+    "@types/ramda": "^0.29.12",
+    "@vitest/coverage-v8": "^1.4.0",
+    "@vitest/ui": "~1.4.0",
+    "typescript": "^5.4.4",
+    "vite": "^5.2.8",
+    "vitest": "~1.4.0",
+    "shared-config": "1.0.0-next.94"
+  },
+  "files": [
+    "src/**/*.js",
+    "src/**/*.svelte"
+  ],
+  "exports": {
+    "./src": "./src",
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./src/index.js",
+      "svelte": "./src/index.js"
+    }
+  },
+  "dependencies": {
+    "@lukeed/uuid": "^2.0.1",
+    "d3-array": "^3.2.4",
+    "d3-collection": "^1.0.7",
+    "ramda": "^0.29.1",
+    "svelte": "^4.2.12",
+    "@rokkit/core": "1.0.0-next.94"
+  },
+  "scripts": {
+    "format": "prettier --write .",
+    "lint": "eslint --fix .",
+    "test:ci": "vitest run",
+    "test:ui": "vitest --ui",
+    "test": "vitest",
+    "coverage": "vitest run --coverage",
+    "latest": "pnpm upgrade --latest && pnpm test:ci",
+    "release": "pnpm publish --access public"
+  }
+}

package/src/aggregators.js

@@ -0,0 +1,24 @@
+/**
+ * Counts the number of values in an array.
+ *
+ * @param {Array} values - An array of values to count.
+ * @returns {number} The count of values in the array.
+ */
+export const counter = (values) => values.length
+
+/**
+ * Calculates the quartiles and interquartile range (IQR) of a numeric data array.
+ * Assumes that the `quantile` function is defined elsewhere and can calculate a
+ * quantile for a given array of numbers and a probability.
+ *
+ * @param {number[]} values - An array of numeric values to calculate the quartiles for.
+ * @returns {Object} An object containing the first quartile (q1), third quartile (q3),
+ *                   interquartile range (iqr), and the minimum and maximum range values (qr_min, qr_max)
+ *                   after applying the IQR rule for identifying potential outliers.
+ */
+export const violin = (values) => {
+	const { q1, q3 } = values
+	const iqr = q3 - q1
+
+	return { ...values, q1, q3, iqr, qr_min: q1 - 1.5 * iqr, qr_max: q1 + 1.5 * iqr }
+}

package/src/constants.js

@@ -0,0 +1,72 @@
+import { identity, pick } from 'ramda'
+
+export const pickAllowedConfig = pick(['children', 'actual_flag'])
+
+/** @type {import('./types').DataFrameConfig */
+export const defaultConfig = {
+	children: 'children',
+	actual_flag: 'actual_flag',
+	inplace: false,
+	group_by: [],
+	align_by: [],
+	template: {},
+	summaries: []
+}
+
+export const defaultPathOptions = {
+	path: null,
+	separator: '/',
+	currencySuffix: '_currency'
+}
+
+export const defaultViewOptions = {
+	...defaultPathOptions,
+	expanded: false,
+	actions: [],
+	language: 'en-US',
+	scanMode: 'fast'
+}
+
+export const defaultActionOrder = {
+	select: 0,
+	edit: 1,
+	delete: 2
+}
+
+/**
+ * Returns the default properties for a column
+ * @param {string} key - the key to use for the column
+ * @returns {Object} the default properties for a column
+ */
+// export const defaultProps = (key) => ({
+// 	sortable: true,
+// 	filterable: true,
+// 	sorted: 'none',
+// 	fields: { text: key }
+// })
+
+export const filterOperations = {
+	'=': (value, pattern) => value === pattern,
+	'<': (value, pattern) => value < pattern,
+	'>': (value, pattern) => value > pattern,
+	'<=': (value, pattern) => value <= pattern,
+	'>=': (value, pattern) => value >= pattern,
+	'~*': (value, pattern) => pattern.test(value),
+	'~': (value, pattern) => pattern.test(value),
+	'!=': (value, pattern) => value !== pattern,
+	'!~*': (value, pattern) => !pattern.test(value),
+	'!~': (value, pattern) => !pattern.test(value)
+}
+
+export const typeConverters = {
+	string: (value) => String(value),
+	number: (value) => Number(value),
+	boolean: (value) => value === 'true' || value === true,
+	date: (value) => new Date(value),
+	mixed: identity
+}
+
+/**
+ * A filter function that includes all rows.
+ */
+export const includeAll = () => true

package/src/convert.js

@@ -0,0 +1,36 @@
+import { inferDataType } from './infer'
+
+/**
+ * Converts an array of objects into a columnar structure, returning an object with two attributes:
+ *
+ * - columns, which contains an array of column names
+ * - data, which is an object with column names as keys and arrays as values.
+ *
+ * @param {Array<Object>} input
+ * @returns {import('./types').Dataframe}
+ */
+export function fromArray(input) {
+	const data = {}
+	let columns = []
+
+	input.forEach((items, index) => {
+		const keys = Object.keys(items)
+		const missing = columns.filter((x) => !keys.includes(x))
+
+		columns = [...columns, ...keys.filter((x) => !columns.includes(x))]
+
+		missing.forEach((key) => {
+			data[key] = [...data[key], null]
+		})
+		keys.forEach((key) => {
+			if (key in data) {
+				data[key] = [...data[key], items[key]]
+			} else {
+				data[key] = [...Array(index).fill(null), items[key]]
+			}
+		})
+	})
+
+	const types = columns.reduce((acc, x) => ({ ...acc, [x]: inferDataType(data[x]) }), {})
+	return { data, columns, types }
+}