@rokkit/core 1.0.0-next.107 → 1.0.0-next.109

package/dist/field-mapper.d.ts

@@ -1,5 +1,5 @@
 export class FieldMapper {
-    constructor(fields?: any, componentMap?: {});
+    constructor(fields?: any);
     hasIcon: ((obj: unknown) => obj is {
         [x: string]: unknown;
     }) | undefined;
@@ -23,24 +23,25 @@ export class FieldMapper {
     }) | undefined;
     withPrefix: ((x: any) => string) | undefined;
     excludeFlags: (<U extends Partial<Record<any, any>>>(obj: any extends keyof U ? U : never) => any extends keyof U ? Omit<U, any> : never) | undefined;
+    getChildMapper(): null;
+    /**
+     * @private
+     */
+    private prop;
+    /**
+     * Gets a mapped attribute from the original item
+     *
+     * @param {string} fieldName - Name of the field to get
+     * @returns {any|null} - The attribute value or null if not found
+     */
+    get(fieldName: string, value: any, defaultValue?: null): any | null;
     set fields(fields: any);
     get fields(): any;
-    set componentMap(components: {});
-    get componentMap(): {};
-    getComponent(value: any): any;
     getIcon(value: any): string | null;
-    getImage(value: any): any;
     getValue(value: any): any;
-    getText(value: any): any;
-    getLabel(value: any): any;
-    getAttribute(value: any, attr: any): any;
     getFormattedText(value: any, formatter: any): any;
     hasChildren(item: any): item is never;
-    isExpanded(item: any): false;
-    isHidden(item: any): unknown;
     isNested(items: any): boolean;
-    toggleVisibility(items: any, visible: any): void;
-    toggleExpansion(item: any): void;
     getChildren(item: any): never[];
     /**
      * Finds children by an index path

package/dist/index.d.ts

@@ -8,6 +8,6 @@ export { FieldMapper } from "./field-mapper.js";
 export { createEmitter } from "./events.js";
 export { getLineTypes } from "./connector.js";
 export { generateTicks } from "./ticks.js";
-export { getValue } from "./mapping.js";
 export { getItemAtIndex, getIndexForItem } from "./mapped-items.js";
 export { weekdays, getCalendarDays } from "./calendar.js";
+export { getValue, getNestedFields, hasChildren, isExpanded } from "./mapping.js";

package/dist/mapping.d.ts

@@ -66,3 +66,10 @@ export function hasChildren(item: any, fields: import("./types").FieldMapping):
  * @returns {boolean}
  */
 export function isExpanded(item: any, fields: import("./types").FieldMapping): boolean;
+/**
+ * Fetches the fieldmapping for a child node
+ *
+ * @param {import('./types').FieldMapping} fields
+ * @returns {import('./types').FieldMapping}
+ */
+export function getNestedFields(fields: import("./types").FieldMapping): import("./types").FieldMapping;

package/dist/utils.d.ts

@@ -63,6 +63,7 @@ export function getPathFromKey(key: string): string[];
  * Get snippet function from an object
  * @param {Object} obj
  * @param {string} key
+ * @param {null|Function} defaultSnippet
  * @returns {Function|undefined}
  */
-export function getSnippet(obj: Object, key: string): Function | undefined;
+export function getSnippet(obj: Object, key: string, defaultSnippet?: null | Function): Function | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rokkit/core",
-  "version": "1.0.0-next.107",
+  "version": "1.0.0-next.109",
   "description": "Contains core utility functions and classes that can be used in various components.",
   "author": "Jerry Thomas <me@jerrythomas.name>",
   "license": "MIT",

package/src/constants.js

@@ -12,7 +12,6 @@ export const defaultFields = {
 	icon: 'icon',
 	iconPrefix: null,
 	image: 'image',
-	component: 'component',
 	summary: 'summary',
 	notes: 'notes',
 	props: 'props',
@@ -22,12 +21,12 @@ export const defaultFields = {
 	parent: 'parent',
 	currency: 'currency',
 	label: 'label',
+	component: 'component',
+	snippet: '_snippet',
 	/* flag fields  */
-	isSelected: '_selected',
-	isHidden: '_hidden',
-	isOpen: '_open',
-	isDeleted: '_deleted',
-	isFiltered: '_filtered'
+	deleted: '_deleted',
+	expanded: '_expanded',
+	selected: '_selected'
 }
 
 export const defaultIcons = [

package/src/field-mapper.js

@@ -1,15 +1,13 @@
-import { defaultFields } from './constants.js'
 import { isNil, has, omit } from 'ramda'
+import { defaultFields } from './constants.js'
 import { isObject } from './utils.js'
 
 export class FieldMapper {
 	#fields = { ...defaultFields }
-	#componentMap = {}
 	#childMapper = null
 
-	constructor(fields = defaultFields, componentMap = {}) {
+	constructor(fields = defaultFields) {
 		this.#updateFields(fields)
-		this.#updateComponentMap(componentMap)
 	}
 
 	#updateFields(fields) {
@@ -33,34 +31,41 @@ export class FieldMapper {
 		])
 	}
 
-	#updateComponentMap(components) {
-		if (typeof components === 'object' && components) {
-			Object.keys(components).forEach((key) => {
-				this.#componentMap[key] = components[key]
-			})
+	getChildMapper() {
+		if (!this.#childMapper) {
+			this.#childMapper = new FieldMapper(this.fields.fields ?? this.fields)
 		}
+		return this.#childMapper
 	}
+	/**
+	 * @private
+	 */
+	prop(fieldName, value) {
+		if (isNil(value)) return null
 
-	get fields() {
-		return this.#fields
-	}
+		if (typeof value === 'object') {
+			return value[this.fields[fieldName]]
+		}
 
-	set fields(fields) {
-		this.#updateFields(fields)
+		return fieldName === 'text' ? value : null
 	}
 
-	get componentMap() {
-		return this.#componentMap
+	/**
+	 * Gets a mapped attribute from the original item
+	 *
+	 * @param {string} fieldName - Name of the field to get
+	 * @returns {any|null} - The attribute value or null if not found
+	 */
+	get(fieldName, value, defaultValue = null) {
+		return this.prop(fieldName, value) ?? defaultValue
 	}
 
-	set componentMap(components) {
-		this.#updateComponentMap(components)
+	get fields() {
+		return this.#fields
 	}
 
-	getComponent(value) {
-		if (this.hasComponent(value))
-			return this.componentMap[value[this.fields.component]] ?? this.componentMap.default
-		return this.componentMap.default
+	set fields(fields) {
+		this.#updateFields(fields)
 	}
 
 	getIcon(value) {
@@ -69,9 +74,6 @@ export class FieldMapper {
 		if (isObject(icon)) return this.withPrefix(icon[value[this.fields.state]])
 		return this.withPrefix(icon)
 	}
-	getImage(value) {
-		return this.getAttribute(value, 'image')
-	}
 
 	getValue(value) {
 		if (this.hasValue(value)) {
@@ -80,32 +82,15 @@ export class FieldMapper {
 		return value
 	}
 
-	getText(value) {
-		if (this.hasText(value)) {
-			return value[this.fields.text]
-		}
-		return typeof value === 'object' ? null : value
-	}
-
-	getLabel(value) {
-		return this.getAttribute(value, 'label') ?? this.getText(value)
-	}
-
-	getAttribute(value, attr) {
-		if (has(attr, this.fields)) {
-			return has(this.fields[attr], value) ? value[this.fields[attr]] : null
-		}
-		return null
-	}
-
 	getFormattedText(value, formatter) {
-		const text = this.getText(value)
+		const text = this.get('text', value)
+
 		if (isNil(text)) return ''
 
 		if (typeof formatter !== 'function') return text.toString()
 
 		if (this.hasCurrency(value)) {
-			return formatter(text, this.getAttribute(value, 'currency'))
+			return formatter(text, this.get('currency', value))
 		}
 		return formatter(text)
 	}
@@ -119,37 +104,10 @@ export class FieldMapper {
 		)
 	}
 
-	isExpanded(item) {
-		if (this.hasChildren(item)) {
-			return has(this.fields.isOpen, item) && item[this.fields.isOpen]
-		}
-		return false
-	}
-
-	isHidden(item) {
-		return has(this.fields.isHidden, item) && item[this.fields.isHidden]
-	}
-
 	isNested(items) {
 		return Array.isArray(items) && items.some((item) => this.hasChildren(item))
 	}
 
-	toggleVisibility(items, visible) {
-		items.forEach((item) => {
-			item[this.fields.isHidden] = !visible
-			if (this.hasChildren(item)) {
-				this.toggleVisibility(item[this.fields.children], visible && item[this.fields.isOpen])
-			}
-		})
-	}
-
-	toggleExpansion(item) {
-		if (this.hasChildren(item)) {
-			item[this.fields.isOpen] = !item[this.fields.isOpen]
-			this.toggleVisibility(item[this.fields.children], item[this.fields.isOpen])
-		}
-	}
-
 	getChildren(item) {
 		return this.hasChildren(item) ? item[this.fields.children] : []
 	}
@@ -179,10 +137,9 @@ export class FieldMapper {
 	 * @returns {Object|null}
 	 */
 	getItemByPath(items, path = []) {
-		// skipcq: JS-W1042 default undefined is needed
 		const result = path.reduce(
 			(item, index, i) => (i === 0 ? items?.[index] : item?.[this.fields.children]?.[index]),
-			undefined
+			/*  skipcq: JS-W1042 default undefined is needed */ undefined
 		)
 
 		if (result === undefined) throw new Error('Invalid path')

package/src/index.js

@@ -16,4 +16,4 @@ export { createEmitter } from './events.js'
 export { getLineTypes } from './connector.js'
 export { weekdays, getCalendarDays } from './calendar.js'
 export { generateTicks } from './ticks.js'
-export { getValue } from './mapping.js'
+export { getValue, getNestedFields, hasChildren, isExpanded } from './mapping.js'

package/src/mapping.js

@@ -1,6 +1,6 @@
 import { defaultFields } from './constants.js'
 import { toString, isObject } from './utils.js'
-
+import { has } from 'ramda'
 /**
  * Get the component to be used to render the item.
  * If the component is null or undefined, it will return the default component.
@@ -104,12 +104,7 @@ export function getFormattedText(node, fields = defaultFields, formatter = toStr
  * @returns {boolean}
  */
 export function hasChildren(item, fields) {
-	return (
-		item !== null &&
-		typeof item === 'object' &&
-		fields.children in item &&
-		Array.isArray(item[fields.children])
-	)
+	return has(fields.children, item) && Array.isArray(item[fields.children])
 }
 
 /**
@@ -122,8 +117,18 @@ export function hasChildren(item, fields) {
 export function isExpanded(item, fields) {
 	if (item === null) return false
 	if (!hasChildren(item, fields)) return false
-	if (fields.isOpen in item) {
-		return item[fields.isOpen]
+	if (has(fields.expanded, item)) {
+		return item[fields.expanded]
 	}
 	return false
 }
+
+/**
+ * Fetches the fieldmapping for a child node
+ *
+ * @param {import('./types').FieldMapping} fields
+ * @returns {import('./types').FieldMapping}
+ */
+export function getNestedFields(fields) {
+	return { ...defaultFields, ...(fields.fields ?? fields) }
+}

package/src/utils.js

@@ -1,4 +1,4 @@
-import { has } from 'ramda'
+import { has, isNil } from 'ramda'
 
 /**
  * Finds the closest ancestor of the given element that has the given attribute.
@@ -36,7 +36,7 @@ export function id() {
  * @returns {boolean}
  */
 export function isObject(val) {
-	return typeof val === 'object' && val !== null && !(val instanceof Date)
+	return typeof val === 'object' && !isNil(val) && !(val instanceof Date)
 }
 
 /**
@@ -92,7 +92,7 @@ export function scaledPath(size, x) {
  * @returns {string}
  */
 export function getKeyFromPath(path) {
-	return path.join('-')
+	return Array.isArray(path) ? path.join('-') : [path].join('-')
 }
 
 /**
@@ -108,11 +108,12 @@ export function getPathFromKey(key) {
  * Get snippet function from an object
  * @param {Object} obj
  * @param {string} key
+ * @param {null|Function} defaultSnippet
  * @returns {Function|undefined}
  */
-export function getSnippet(obj, key) {
+export function getSnippet(obj, key, defaultSnippet = null) {
 	if (has(key, obj) && typeof obj[key] === 'function') {
 		return obj[key]
 	}
-	return undefined
+	return defaultSnippet
 }