@rokkit/data 1.0.0-next.96 → 1.0.0-next.98

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rokkit/data",
-  "version": "1.0.0-next.96",
+  "version": "1.0.0-next.98",
   "description": "Contains generic data manipulation functions that can be used in various components.",
   "author": "Jerry Thomas <me@jerrythomas.name>",
   "license": "MIT",
@@ -12,15 +12,15 @@
     "access": "public"
   },
   "devDependencies": {
-    "@sveltejs/vite-plugin-svelte": "^3.1.1",
-    "@testing-library/svelte": "^5.1.0",
-    "@types/ramda": "^0.30.0",
+    "@sveltejs/vite-plugin-svelte": "^3.1.2",
+    "@testing-library/svelte": "^5.2.1",
+    "@types/ramda": "^0.30.2",
     "@vitest/coverage-v8": "^1.6.0",
     "@vitest/ui": "~1.6.0",
-    "typescript": "^5.4.5",
-    "vite": "^5.2.12",
+    "typescript": "^5.6.2",
+    "vite": "^5.4.6",
     "vitest": "~1.6.0",
-    "shared-config": "1.0.0-next.96"
+    "shared-config": "1.0.0-next.98"
   },
   "files": [
     "src/**/*.js",
@@ -40,8 +40,8 @@
     "d3-array": "^3.2.4",
     "d3-collection": "^1.0.7",
     "ramda": "^0.30.1",
-    "svelte": "^4.2.17",
-    "@rokkit/core": "1.0.0-next.96"
+    "svelte": "^4.2.19",
+    "@rokkit/core": "1.0.0-next.98"
   },
   "scripts": {
     "format": "prettier --write .",

package/src/dataset.js

@@ -40,7 +40,7 @@ export function dataset(data, options = {}) {
 		// joins
 		innerJoin: (other, condition) => dataset(innerJoin(data, other.select(), condition)),
 		leftJoin: (other, condition) => dataset(leftJoin(data, other.select(), condition)),
-		rightJoin: (other, condition) => dataset(rightJoin(data, other.select(), condition)),
+		rightJoin: (other, condition) => dataset(leftJoin(other.select(), data, condition)),
 		fullJoin: (other, condition) => dataset(fullJoin(data, other.select(), condition)),
 		crossJoin: (other) => dataset(crossJoin(data, other.select())),
 		semiJoin: (other, condition) => dataset(semiJoin(data, other.select(), condition)),
@@ -179,6 +179,8 @@ function innerJoin(first, second, condition) {
  * are returned. When combining the rows, the columns from the first dataset take precedence.
  * If there is no match in the second dataset, only the row from the first dataset is returned.
  *
+ * This can be used to perform a right join by swapping the datasets.
+ *
  * @param {Array}    first     - The first dataset to join.
  * @param {Array}    second    - The second dataset to join.
  * @param {Function} condition - The condition to join the datasets on.
@@ -189,22 +191,6 @@ function leftJoin(first, second, condition) {
 	return inner.concat(outer)
 }
 
-/**
- * Performs a right join on two datasets based on a condition. Result includes all rows from the second
- * dataset and matching rows from the first dataset. In case of multiple matches, all combinations
- * are returned. When combining the rows, the columns from the second dataset take precedence.
- * If there is no match in the first dataset, only the row from the second dataset is returned.
- *
- * @param {Array}    first     - The first dataset to join.
- * @param {Array}    second    - The second dataset to join.
- * @param {Function} condition - The condition to join the datasets on.
- * @returns {Array}            - The joined dataset.
- */
-function rightJoin(first, second, condition) {
-	const { inner, outer } = joinData(second, first, condition)
-	return inner.concat(outer)
-}
-
 /**
  * Performs a full join on two datasets based on a condition. Result includes all rows from both
  * datasets. In case of multiple matches, all combinations are returned. When combining the rows,

package/src/index.js

@@ -1,5 +1,6 @@
+// skipcq: JS-E1004 - Needed for exposing all types
 export * from './types'
-export * from './utils'
+export { typeOf } from './utils'
 export { renamer } from './renamer'
 export { model } from './model'
 export { dataset } from './dataset'

package/src/infer.js

@@ -3,7 +3,7 @@ import { compact } from '@rokkit/core'
 import { omit } from 'ramda'
 import { createFormatter } from './formatter'
 import { defaultViewOptions, defaultActionOrder } from './constants'
-import { getType } from './utils'
+import { typeOf } from './utils'
 import { deriveColumnProperties } from './metadata'
 
 /**
@@ -14,7 +14,7 @@ import { deriveColumnProperties } from './metadata'
  * @throws {Error} Throws an error if the value type is not supported or the value format is invalid.
  */
 export function deriveSortableColumn(value) {
-	const type = getType(value)
+	const type = typeOf(value)
 
 	const configGenerators = {
 		array: arrayConfigGenerator,
@@ -166,10 +166,10 @@ export function inferDataType(values) {
 		return 'null'
 	}
 
-	let type = getType(nonNullValues[0])
+	let type = typeOf(nonNullValues[0])
 
 	for (let i = 1; i < nonNullValues.length; i++) {
-		if (getType(nonNullValues[i]) !== type) {
+		if (typeOf(nonNullValues[i]) !== type) {
 			type = 'mixed'
 			break
 		}

package/src/metadata.js

@@ -1,6 +1,6 @@
 import { defaultPathOptions } from './constants'
 import { getDeepScanSample } from './infer'
-import { getType } from './utils'
+import { typeOf } from './utils'
 
 /**
  * Merges currency-related attributes into the corresponding base columns.
@@ -64,7 +64,7 @@ export function deriveColumnProperties(sample, options) {
 
 	let columns = Object.keys(sample).map((key) => ({
 		name: key,
-		type: getType(sample[key]),
+		type: typeOf(sample[key]),
 		sortable: true,
 		filterable: true,
 		sorted: 'none',
@@ -90,7 +90,7 @@ export function deriveColumnMetadata(data, options = {}) {
 	if (Array.isArray(metadata) && metadata.length > 0) return metadata
 	if (data.length === 0) return []
 	const sample = deepScan ? getDeepScanSample(data) : data[0]
-	return Object.entries(sample).map(([name, value]) => ({ name, type: getType(value) }))
+	return Object.entries(sample).map(([name, value]) => ({ name, type: typeOf(value) }))
 }
 
 /**

package/src/model.js

@@ -1,6 +1,6 @@
 import { identity, clone as copy } from 'ramda'
 import { getDeepScanSample } from './infer'
-import { getType } from './utils'
+import { typeOf } from './utils'
 
 /**
  * A model is a representation of a dataset
@@ -72,7 +72,7 @@ function deriveModel(data, sparse = false) {
 	kv.forEach(([key, value]) => {
 		result.push({
 			name: key,
-			type: getType(value)
+			type: typeOf(value)
 		})
 	})
 	return result

package/src/parser.js

@@ -48,7 +48,8 @@ export function parseFilters(string) {
 	// Iterate over the tokens
 	for (const token of tokens) {
 		// Extract the named groups from the token
-		let { group, column, operator, value } = token.groups
+		const { group, column } = token.groups
+		let { operator, value } = token.groups
 		search = search.replace(group, '').trim()
 
 		operator = replaceOperators(operator)

package/src/utils.js

@@ -7,25 +7,30 @@ function isDateString(value) {
 	return !isNaN(Date.parse(value))
 }
 
+function deriveTypeFromEmptyValue(value) {
+	if (value === undefined || value === null) return 'string'
+	return typeof value
+}
 /**
  * Infer the type of a value as array, date or the default type
  * @param {any} value
  * @returns {string}
  */
-function inferArrayAndDateTypes(value) {
+function deriveArrayAndDateTypes(value) {
 	if (Array.isArray(value)) return 'array'
 	if (value instanceof Date) return 'date'
 
-	return typeof value
+	return deriveTypeFromEmptyValue(value)
 }
 /**
  * Derive the type of a value
  * @param {any} value
  * @returns {string}
  */
-export function getType(value) {
-	const type = inferArrayAndDateTypes(value)
+export function typeOf(value) {
+	const type = deriveArrayAndDateTypes(value)
 	if (type === 'string' && isDateString(value)) return 'date'
 	if (type === 'number' && Number.isInteger(value)) return 'integer'
+
 	return type
 }

package/src/view.js

@@ -10,76 +10,24 @@ import {
 } from './hierarchy'
 
 /**
- * Creates a view object for managing data presentation with metadata and hierarchy structures,
- * as well as providing methods for sorting, selection, and toggling of data expansion.
+ * Sorts a nested array of objects based on a group of sorters.
  *
- * @param {Array<Object>} data    - The source data array to be presented by the view.
- * @param {Object}        options - The configuration options used for deriving metadata and hierarchy from the data.
- * @returns {import('svelte/store').Writable} An object representing the view, providing methods to manipulate and query the presentation state.
+ * @param {Array<Object>} elements - The array of objects to sort.
  */
-export function dataview(data, options) {
-	const store = writable({
-		columns: deriveMetadata(data, options),
-		hierarchy: deriveHierarchy(data, options)
-	})
-	let sortGroup = []
-
-	/**
-	 * Sorts the hierarchy based on a specific field name and order.
-	 *
-	 * @param {string} name - The field name to sort by.
-	 * @param {boolean} [ascending=true] - Whether the sort should be in ascending order.
-	 */
-	const sortBy = (name, ascending = true) => {
-		sortGroup = [...sortGroup, [name, ascending]]
-		// change the sort order in the metadata
-		const { columns, hierarchy } = get(store)
-		columns.forEach((column) => {
-			if (column.name === name) {
-				column.order = ascending ? 'ascending' : 'descending'
+function sortNested(elements, group) {
+	elements
+		.sort((a, b) => {
+			let result = 0
+			for (let i = 0; i < group.length && result === 0; i++) {
+				result = group[i].sorter(a, b)
+			}
+			return result
+		})
+		.forEach((x) => {
+			if (Array.isArray(x.children) && x.children.length > 0) {
+				sortNested(x.children, group)
 			}
 		})
-		groupSort(hierarchy, sortGroup)
-		store.set({ columns, hierarchy })
-	}
-
-	return {
-		...omit(['set', 'update'], store),
-		// filter: noop,
-		/**
-		 * Clears the applied sort order from the hierarchy.
-		 * TODO: clearing sort should clear the sort orders in columns
-		 */
-		clearSort: () => {
-			sortGroup = []
-			const { columns } = get(store)
-			columns.forEach((column) => {
-				column.order = 'none'
-			})
-			// clearSortOrder(metadata)
-		},
-		sortBy,
-		/**
-		 * Toggles the selection state of a data element at the specified index.
-		 *
-		 * @param {number} index - The index of the element in the hierarchy to select or deselect.
-		 */
-		select: (index) => {
-			const { hierarchy } = get(store)
-			toggleSelection(hierarchy[index])
-			store.update((state) => ({ ...state, hierarchy }))
-		},
-		/**
-		 * Toggles the expansion state of a data element at the specified index.
-		 *
-		 * @param {number} index - The index of the element in the hierarchy to expand or collapse.
-		 */
-		toggle: (index) => {
-			const { hierarchy } = get(store)
-			toggleExpansion(hierarchy[index])
-			store.update((state) => ({ ...state, hierarchy }))
-		}
-	}
 }
 
 /**
@@ -100,39 +48,22 @@ export function groupSort(hierarchy, sortGroup) {
 }
 
 /**
- * Sorts a nested array of objects based on a group of sorters.
- *
- * @param {Array<Object>} elements - The array of objects to sort.
- */
-function sortNested(elements, group) {
-	elements
-		.sort((a, b) => {
-			let result = 0
-			for (let i = 0; i < group.length && result === 0; i++) {
-				result = group[i].sorter(a, b)
-			}
-			return result
-		})
-		.forEach((x) => {
-			if (Array.isArray(x.children) && x.children.length > 0) {
-				sortNested(x.children, group)
-			}
-		})
-}
-
-/**
- * Toggles the selection state of a node in the hierarchy.
- * Depending on whether the node to toggle is a parent or child,
- * it will either select or deselect all children, or update the parent's selection state based on its children's states.
- *
- * @param {import('./types').Hierarchy} item - The node to toggle.
+ * Sorts the hierarchy based on a specific field name and order.
  *
+ * @param {string} name - The field name to sort by.
+ * @param {boolean} [ascending=true] - Whether the sort should be in ascending order.
  */
-export function toggleSelection(item) {
-	item.selected = item.selected === 'checked' ? 'unchecked' : 'checked'
-
-	updateParents(item)
-	updateChildren(item)
+const sortHierarchyBy = (store, sortGroup, name, ascending = true) => {
+	sortGroup = [...sortGroup, [name, ascending]]
+	// change the sort order in the metadata
+	const { columns, hierarchy } = get(store)
+	columns.forEach((column) => {
+		if (column.name === name) {
+			column.order = ascending ? 'ascending' : 'descending'
+		}
+	})
+	groupSort(hierarchy, sortGroup)
+	store.set({ columns, hierarchy })
 }
 
 /**
@@ -185,3 +116,66 @@ function updateParents(item) {
 		parent = parent.parent
 	}
 }
+
+/**
+ * Toggles the selection state of a node in the hierarchy.
+ * Depending on whether the node to toggle is a parent or child,
+ * it will either select or deselect all children, or update the parent's selection state based on its children's states.
+ *
+ * @param {import('./types').Hierarchy} item - The node to toggle.
+ *
+ */
+export function toggleSelection(item) {
+	item.selected = item.selected === 'checked' ? 'unchecked' : 'checked'
+
+	updateParents(item)
+	updateChildren(item)
+}
+
+/**
+ * Toggles the expansion or selection state of a data element at the specified index.
+ *
+ * @param {import('svelte/store').Writable} store - The store object representing the view.
+ * @param {number} index - The index of the element in the hierarchy to expand or collapse.
+ * @param {string} mode - The mode to toggle, either 'expansion' or 'selection'.
+ */
+function toggleState(store, index, mode) {
+	const { hierarchy } = get(store)
+	if (mode === 'selection') toggleSelection(hierarchy[index])
+	else if (mode === 'expansion') toggleExpansion(hierarchy[index])
+	store.update((state) => ({ ...state, hierarchy }))
+}
+
+/**
+ * Creates a view object for managing data presentation with metadata and hierarchy structures,
+ * as well as providing methods for sorting, selection, and toggling of data expansion.
+ *
+ * @param {Array<Object>} data    - The source data array to be presented by the view.
+ * @param {Object}        options - The configuration options used for deriving metadata and hierarchy from the data.
+ * @returns {import('svelte/store').Writable} An object representing the view, providing methods to manipulate and query the presentation state.
+ */
+export function dataview(data, options) {
+	const store = writable({
+		columns: deriveMetadata(data, options),
+		hierarchy: deriveHierarchy(data, options)
+	})
+	let sortGroup = []
+
+	return {
+		...omit(['set', 'update'], store),
+		// filter: noop,
+		/**
+		 * Clears the applied sort order from the hierarchy.
+		 */
+		clearSort: () => {
+			sortGroup = []
+			store.update((state) => ({
+				...state,
+				columns: state.columns.map((column) => ({ ...column, order: 'none' }))
+			}))
+		},
+		sortBy: (name, ascending) => sortHierarchyBy(store, sortGroup, name, ascending),
+		select: (index) => toggleState(store, index, 'selection'),
+		toggle: (index) => toggleState(store, index, 'expansion')
+	}
+}