@rokkit/core 1.0.0-next.93 → 1.0.0-next.94

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rokkit/core",
-  "version": "1.0.0-next.93",
+  "version": "1.0.0-next.94",
   "description": "Core components, actions and stores for svelte apps.",
   "author": "Jerry Thomas <me@jerrythomas.name>",
   "license": "MIT",
@@ -14,16 +14,16 @@
   "devDependencies": {
     "@sveltejs/vite-plugin-svelte": "^3.0.2",
     "@testing-library/svelte": "^4.1.0",
-    "@types/ramda": "^0.29.11",
+    "@types/ramda": "^0.29.12",
     "@vitest/coverage-v8": "^1.4.0",
     "@vitest/ui": "~1.4.0",
     "jsdom": "^24.0.0",
     "svelte": "^4.2.12",
-    "typescript": "^5.4.3",
-    "vite": "^5.2.7",
+    "typescript": "^5.4.4",
+    "vite": "^5.2.8",
     "vitest": "~1.4.0",
-    "shared-config": "1.0.0-next.93",
-    "validators": "1.0.0-next.93"
+    "shared-config": "1.0.0-next.94",
+    "validators": "1.0.0-next.94"
   },
   "files": [
     "src/**/*.js",
@@ -35,7 +35,7 @@
     "./package.json": "./package.json",
     "./constants": "./src/constants.js",
     ".": {
-      "types": "./dist/index.d.ts",
+      "types": "./dist/types.d.ts",
       "import": "./src/index.js",
       "svelte": "./src/index.js"
     }

package/src/mapping.js

@@ -1,5 +1,5 @@
 import { defaultFields } from './constants'
-import { isObject } from '.'
+import { toString, isObject } from './utils'
 
 /**
  * Get the component to be used to render the item.
@@ -10,7 +10,7 @@ import { isObject } from '.'
  * @param {import('./types.js').ComponentMap} using
  */
 export function getComponent(value, fields, using) {
-	return fields.component && typeof value === 'object'
+	return fields.component && isObject(value)
 		? using[value[fields.component]] ?? using.default
 		: using.default
 }
@@ -47,20 +47,36 @@ export function getValue(node, fields = defaultFields) {
  * Get the text for the item. If the text is an object,
  * it will use the field mapping to determine which attribute to get.
  *
- * @param {*} node
+ * @param {*}                              node
  * @param {import('./types').FieldMapping} fields
- * @returns {*}
+ * @returns {string}
  */
 export function getText(node, fields = defaultFields) {
-	let value = typeof node === 'object' && node != null ? node[fields.text] : node
-
-	return value != null
-		? isObject(value)
-			? JSON.stringify(value, null, 2)
-			: value.toString()
-		: value
+	const value = isObject(node) ? node[fields.text] : node
+	return value
+	// return value != null
+	// 	? isObject(value)
+	// 		? JSON.stringify(value, null, 2)
+	// 		: value.toString()
+	// 	: value
 }
 
+/**
+ * Get the formatted text for the item. If the text is an object, use the field mapping to determine
+ * which attribute to get currency. Use the formatter or identity function to format the text.
+ *
+ * @param {*}                              node
+ * @param {import('./types').FieldMapping} fields
+ * @param {function}                       formatter
+ * @returns {*}
+ */
+export function getFormattedText(node, fields = defaultFields, formatter = toString) {
+	const value = isObject(node) ? node[fields.text] : node
+	const currency = getAttribute(node, fields.currency)
+	const formatValue = typeof formatter === 'function' ? formatter : toString
+
+	return currency ? formatValue(value, currency) : formatValue(value)
+}
 /**
  * Gets the attribute from the node
  * @param {*} node

package/src/string.js

@@ -25,8 +25,8 @@ export function toPascalCase(text) {
 /**
  * Convert a PascalCase string to snake case with separator as hyphen
  *
- * @param {Strin} text
- * @returns
+ * @param {string} text
+ * @returns {string}
  */
 export function toHyphenCase(text) {
 	return text
@@ -40,11 +40,12 @@ export function toHyphenCase(text) {
  *
  * @param {String} a hyphen separates string
  * @param {String} b hyphen separates string
- * @returns
+ * @param {string} separator - separator to split the string
+ * @returns {Number} -1, 0, 1 based on comparison
  */
-export function sortByParts(a, b) {
-	const partsOfA = a.split('-')
-	const partsOfB = b.split('-')
+export function sortByParts(a, b, separator = '-') {
+	const partsOfA = a.split(separator)
+	const partsOfB = b.split(separator)
 
 	let result = compareStrings(partsOfA[0], partsOfB[0])
 	if (result === 0) result = partsOfA.length - partsOfB.length

package/src/types.js

@@ -10,7 +10,7 @@
  */
 
 /**
- * @typedef {checked|unchecked|indeterminate} SelectionState
+ * @typedef {'checked'|'unchecked'|'indeterminate'} SelectionState
  */
 
 /**

package/src/utils.js

@@ -17,6 +17,26 @@ export function isObject(val) {
 	return typeof val === 'object' && val !== null && !(val instanceof Date)
 }
 
+/**
+ * Converts the value to a string. If the value is an object, it will convert it to a JSON string.
+ *
+ * @param {*} value
+ * @returns {string}
+ */
+export function toString(value) {
+	if (value === null || value === undefined) return value
+	if (isObject(value)) return JSON.stringify(value, null, 2)
+	return value.toString()
+}
+
+/**
+ * Generates icon shortcuts for a collection of icons
+ *
+ * @param {string[]} icons
+ * @param {string} collection
+ * @param {string} variants
+ * @returns {Object}
+ */
 export function iconShortcuts(icons, collection, variants) {
 	const suffix = variants ? `-${variants}` : ''
 	const shortcuts = !collection
@@ -32,6 +52,13 @@ export function iconShortcuts(icons, collection, variants) {
 	return shortcuts
 }
 
+/**
+ * Scales the path by the size
+ *
+ * @param {number} size
+ * @param {string|number} x
+ * @returns {string|number}
+ */
 export function scaledPath(size, x) {
 	if (Array.isArray(x)) return x.map((x) => scaledPath(size, x)).join(' ')
 	return typeof x === 'number' ? x * size : x