@rokkit/data 1.0.0-next.94 → 1.0.0-next.95

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rokkit/data",
-  "version": "1.0.0-next.94",
+  "version": "1.0.0-next.95",
   "description": "Contains generic data manipulation functions that can be used in various components.",
   "author": "Jerry Thomas <me@jerrythomas.name>",
   "license": "MIT",
@@ -20,7 +20,7 @@
     "typescript": "^5.4.4",
     "vite": "^5.2.8",
     "vitest": "~1.4.0",
-    "shared-config": "1.0.0-next.94"
+    "shared-config": "1.0.0-next.95"
   },
   "files": [
     "src/**/*.js",
@@ -41,7 +41,7 @@
     "d3-collection": "^1.0.7",
     "ramda": "^0.29.1",
     "svelte": "^4.2.12",
-    "@rokkit/core": "1.0.0-next.94"
+    "@rokkit/core": "1.0.0-next.95"
   },
   "scripts": {
     "format": "prettier --write .",

package/src/index.js

@@ -1,4 +1,4 @@
-import './types'
+export * from './types'
 export * from './utils'
 export { renamer } from './renamer'
 export { model } from './model'

package/src/model.js

@@ -63,19 +63,19 @@ export function model() {
  * @returns {Array}             - the derived model
  */
 function deriveModel(data, sparse = false) {
-	const model = []
+	const result = []
 	let item = data
 
 	if (Array.isArray(data)) item = sparse ? getDeepScanSample(data) : data[0]
 
 	const kv = Object.entries(item)
 	kv.forEach(([key, value]) => {
-		model.push({
+		result.push({
 			name: key,
 			type: getType(value)
 		})
 	})
-	return model
+	return result
 }
 
 /**

package/src/types.js

@@ -1,31 +1,17 @@
 /**
- * Options for the sort order of the column.
- *
- * @typedef {'ascending'|'descending'|'none'} SortOptions
- */
-
-/**
- * Options for aligning text in a column.
- * @typedef {'left'|'center'|'right'|'justify'} HorizontalAlignOptions
- */
-
-/**
- * Options for the action type of the column.
- * @typedef {'edit'|'delete'|'select'} ActionTypes
- */
-
-/**
- * @typedef {'checked'|'unchecked'|'indeterminate'} SelectionState
- */
-
-/**
- * @typedef {string|[string,boolean]|ColumnSorter} SortableColumn
+ * @typedef {import('@rokkit/core').FieldMapping} FieldMapping
+ * @typedef {import('@rokkit/core').SortOptions} SortOptions
+ * @typedef {import('@rokkit/core').HorizontalAlignOptions} HorizontalAlignOptions
+ * @typedef {import('@rokkit/core').ActionTypes} ActionTypes
+ * @typedef {import('@rokkit/core').SelectionState} SelectionState
  */
 
 /**
  * @typedef {Object} ColumnSorter
  * @property {string}   name
  * @property {function} sorter
+ *
+ * @typedef {string|[string,boolean]|ColumnSorter} SortableColumn
  */
 
 /**
@@ -44,28 +30,6 @@
  * @property {string} [separator='_']  - Separator to be used when adding prefix or suffix. defaults to _
  */
 
-/**
- * Structure to map custom fields for rendering. This is used to identofy the attributes for various purposes.
- *
- * @typedef FieldMapping
- * @property {string} [id='id']              Unique id for the item
- * @property {string} [text='text']          the text to render
- * @property {string} [value='value']        the value associated with the item
- * @property {string} [url='url']            a URL
- * @property {string} [icon='icon']          icon to render
- * @property {string} [image='image']        the image to render
- * @property {string} [children='children']  children of the item
- * @property {string} [summary='summary']    summary of the item
- * @property {string} [notes='notes']        notes for the item
- * @property {string} [props='props']        additional properties
- * @property {string} [isOpen='_open']       item is open or closed
- * @property {string} [level='level']        level of item
- * @property {string} [parent='parent']      item is a parent
- * @property {string} [currency='currency]   column specifying currency to be used for the current value
- * @property {string} [isDeleted='_deleted'] item is deleted
- * @property {FieldMapping} [fields]         Field mapping to be used on children in the next level
- */
-
 /**
  * Column metadata for the table.
  *
@@ -205,4 +169,5 @@
  * @property {Function} toggle      - toggle expand or collapse the DataView by the specified columns.
  * @property {Function} select      - select the DataView by the specified columns.
  */
-export {}
+
+export default {}

package/src/view.js

@@ -45,7 +45,7 @@ export function dataview(data, options) {
 
 	return {
 		...omit(['set', 'update'], store),
-		// filter: () => {},
+		// filter: noop,
 		/**
 		 * Clears the applied sort order from the hierarchy.
 		 * TODO: clearing sort should clear the sort orders in columns