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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rokkit/core",
-  "version": "1.0.0-next.96",
+  "version": "1.0.0-next.98",
   "description": "Core components, actions and stores for svelte apps.",
   "author": "Jerry Thomas <me@jerrythomas.name>",
   "license": "MIT",
@@ -12,18 +12,18 @@
     "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",
-    "jsdom": "^24.1.0",
-    "svelte": "^4.2.17",
-    "typescript": "^5.4.5",
-    "vite": "^5.2.12",
+    "jsdom": "^24.1.3",
+    "svelte": "^4.2.19",
+    "typescript": "^5.6.2",
+    "vite": "^5.4.6",
     "vitest": "~1.6.0",
-    "shared-config": "1.0.0-next.96",
-    "validators": "1.0.0-next.96"
+    "shared-config": "1.0.0-next.98",
+    "validators": "1.0.0-next.98"
   },
   "files": [
     "src/**/*.js",

package/src/calendar.js

@@ -10,6 +10,14 @@ export const weekdays = [
 	'Saturday'
 ]
 
+/**
+ * Get the days in the month.
+ *
+ * @param {Date}    value
+ * @param {Array}   holidays
+ * @param {boolean} fixed
+ * @returns {import('./types').CalendarDay[]}
+ */
 export function getCalendarDays(value, holidays = [], fixed = false) {
 	const month = getMonth(value)
 	const year = getYear(value)

package/src/constants.js

@@ -97,6 +97,12 @@ export const defaultThemeMapping = {
 	info: 'cyan'
 }
 
+/**
+ * Generate a state icon mapping from a list of icon names
+ *
+ * @param {string[]} icons
+ * @returns {import('./types').StateIcons}
+ */
 export function stateIconsFromNames(icons) {
 	return icons
 		.map((k) => [...k.split('-')])

package/src/index.js

@@ -1,12 +1,17 @@
+// skipcq: JS-E1004 - Needed for exposing JS Doc types
 export * from './types'
+// skipcq: JS-E1004 - Needed for exposing all constants
 export * from './constants'
-export * from './nested'
+export { flattenNestedList, findValueFromPath } from './nested'
+// skipcq: JS-E1004 - Needed for exposing all functions
 export * from './mapping'
-export * from './mapped-list'
-export * from './connector'
-export * from './ticks'
-export * from './calendar'
+export { mappedList } from './mapped-list'
+export { getLineTypes } from './connector'
+export { generateTicks } from './ticks'
+export { weekdays, getCalendarDays } from './calendar'
+// skipcq: JS-E1004 - Needed for exposing all functions
 export * from './utils'
+// skipcq: JS-E1004 - Needed for exposing all functions
 export * from './theme'
-export * from './parser'
+// skipcq: JS-E1004 - Needed for exposing all functions
 export * from './string'

package/src/mapped-list.js

@@ -28,6 +28,7 @@ function findInChildren(item, index, fields, value, attr, position) {
 			index
 		])
 	}
+	return null
 }
 /**
  * Traverses the tree to find an item by value.
@@ -186,7 +187,6 @@ function getNextSiblingOrAncestor(position, items, fields) {
 	let children = parent.item[parent.fields.children]
 	if (index < children.length - 1) {
 		index += 1
-
 		const sibling = findItemByIndexArray([...position.slice(0, -1), index], items, fields)
 		return { item: sibling.item, position: sibling.position, fields }
 	} else {
@@ -197,12 +197,10 @@ function getNextSiblingOrAncestor(position, items, fields) {
 			parent = findItemByIndexArray(position, items, fields)
 			children = parent.item[parent.fields.children]
 		}
-		if (index < children.length - 1) {
-			return {
-				item: children[index + 1],
-				position: [...position, index + 1],
-				fields
-			}
+		return {
+			item: children[index + 1],
+			position: [...position, index + 1],
+			fields
 		}
 	}
 }

package/src/mapping.js

@@ -5,7 +5,7 @@ import { toString, isObject } from './utils'
  * Get the component to be used to render the item.
  * If the component is null or undefined, it will return the default component.
  *
- * @param {object|string} value
+ * @param {object|string}                     value
  * @param {import('./types.js').FieldMapping} fields
  * @param {import('./types.js').ComponentMap} using
  */
@@ -18,24 +18,34 @@ export function getComponent(value, fields, using) {
 /**
  * Get the icon for the item. If the icon is an object, it will use the state to determine which icon to use.
  *
- * @param {object|string} value
+ * @param {object|string}                     value
  * @param {import('./types.js').FieldMapping} fields
+ * @returns {string}
  */
 export function getIcon(value, fields = defaultFields) {
 	if (fields.icon === undefined || typeof (value ?? '') !== 'object') return null
-	// console.log(fields.icon, fields.state, value[fields.icon][value[fields.state]])
-	const name =
-		typeof value[fields.icon] === 'object'
-			? value[fields.icon][value[fields.state]]
-			: value[fields.icon]
+
+	const name = getIconFromObject(value, fields)
 	return fields.iconPrefix ? [fields.iconPrefix, name].join('-') : name
 }
 
+/**
+ * Get the icon for the item. If the icon is an object, it will use the state to determine which icon to use.
+ *
+ * @param {object}                            value
+ * @param {import('./types.js').FieldMapping} fields
+ * @returns {string}
+ */
+function getIconFromObject(value, fields) {
+	if (typeof value[fields.icon] === 'object') return value[fields.icon][value[fields.state]]
+	return value[fields.icon]
+}
+
 /**
  * Get the value for the item. If the value 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 {*}
  */
@@ -54,11 +64,6 @@ export function getValue(node, fields = defaultFields) {
 export function getText(node, fields = defaultFields) {
 	const value = isObject(node) ? node[fields.text] : node
 	return value
-	// return value != null
-	// 	? isObject(value)
-	// 		? JSON.stringify(value, null, 2)
-	// 		: value.toString()
-	// 	: value
 }
 
 /**
@@ -67,8 +72,8 @@ export function getText(node, fields = defaultFields) {
  *
  * @param {*}                              node
  * @param {import('./types').FieldMapping} fields
- * @param {function}                       formatter
- * @returns {*}
+ * @param {Function}                       formatter
+ * @returns {Function}
  */
 export function getFormattedText(node, fields = defaultFields, formatter = toString) {
 	const value = isObject(node) ? node[fields.text] : node
@@ -79,7 +84,7 @@ export function getFormattedText(node, fields = defaultFields, formatter = toStr
 }
 /**
  * Gets the attribute from the node
- * @param {*} node
+ * @param {*}      node
  * @param {string} attr
  * @returns {*}
  */
@@ -89,7 +94,7 @@ export function getAttribute(node, attr) {
 /**
  * Check if the current item is a parent
  *
- * @param {*} item
+ * @param {*}                              item
  * @param {import('./types').FieldMapping} fields
  * @returns {boolean}
  */
@@ -105,7 +110,7 @@ export function hasChildren(item, fields) {
 /**
  * Check if the current item is a parent and is expanded
  *
- * @param {*} item
+ * @param {*}                              item
  * @param {import('./types').FieldMapping} fields
  * @returns {boolean}
  */
@@ -121,7 +126,7 @@ export function isExpanded(item, fields) {
 /**
  * Verify if at least one item has children
  *
- * @param {Array<*>} items
+ * @param {Array<*>}                       items
  * @param {import('./types').FieldMapping} fields
  * @returns {boolean}
  */

package/src/nested.js

@@ -1,6 +1,14 @@
 import { omit } from 'ramda'
 import { defaultFields } from './constants'
 
+/**
+ * Flattens a nested list of items
+ *
+ * @param {Array}                         items
+ * @param {import('./types).FieldMapping} fields
+ * @param {number}                        level
+ * @returns {Array}
+ */
 export function flattenNestedList(items, fields = defaultFields, level = 0) {
 	fields = { ...defaultFields, ...fields }
 	let data = []
@@ -20,9 +28,11 @@ export function flattenNestedList(items, fields = defaultFields, level = 0) {
 }
 
 /**
- * Converts a path slug to a value in the menu
+ * Matches a path slug to a value in the menu
  *
- * @param {string} slug
+ * @param {string}                         slug
+ * @param {Array}                          data
+ * @param {import('./types').FieldMapping} fields
  * @returns {any}
  */
 export function findValueFromPath(slug, data, fields) {

package/src/theme.js

@@ -11,6 +11,7 @@ const modifiers = {
  * Generate shades for a color using css varuable
  *
  * @param {string} name
+ * @param {string} modifier
  * @returns
  */
 export function shadesOf(name, modifier = 'none') {
@@ -36,6 +37,13 @@ export function shadesOf(name, modifier = 'none') {
 	)
 }
 
+/**
+ * Generate shades for a color using css varuable
+ *
+ * @param {string} name
+ * @param {string} modifier
+ * @returns {object}
+ */
 export function stateColors(name, modifier = 'none') {
 	const fn = modifier in modifiers ? modifiers[modifier] : modifiers.none
 	return {
@@ -75,7 +83,7 @@ export function themeColors(modifier = 'none') {
  * @param {'light' | 'dark'}         mode           - The theme mode for which the mappings are being created.
  * @param {function(number): string} valueCondition - A function that takes a shade value and returns the color value
  *                                                    based on the condition appropriate for light or dark mode.
- * @returns {{import('./types'}.ShadeMappings>} An array of objects, where each object contains key, value, and mode
+ * @returns {{import('./types'}.ShadeMapping[]>} An array of objects, where each object contains key, value, and mode
  *                                              properties corresponding to  a CSS custom property definition.
  */
 function createShadeMappings(variant, mode, valueCondition) {

package/src/ticks.js

@@ -1,11 +1,11 @@
 /**
  * Generates an array of tick marks for a range of values.
  *
- * @param {number} lowerBound - The lower bound of the range.
- * @param {number} upperBound - The upper bound of the range.
+ * @param {number} lowerBound                            - The lower bound of the range.
+ * @param {number} upperBound                            - The upper bound of the range.
  * @param {number} [minorTickStep=upperBound-lowerBound] - The step size for minor ticks.
- * @param {number} [majorTickStep=1] - The step size for major ticks.
- * @returns {Array<{value: number, label: string, major: boolean}>} An array of tick mark objects.
+ * @param {number} [majorTickStep=1]                     - The step size for major ticks.
+ * @returns {import('./types').TickMark[]>} An array of tick mark objects.
  */
 export function generateTicks(
 	lowerBound,
@@ -13,10 +13,6 @@ export function generateTicks(
 	minorTickStep = upperBound - lowerBound,
 	majorTickStep = 1
 ) {
-	// lowerBound = +lowerBound
-	// upperBound = +upperBound
-	// minorTickStep = +minorTickStep
-	// majorTickStep = +majorTickStep
 	const length = 1 + Math.ceil((upperBound - lowerBound) / minorTickStep)
 	return Array.from({ length }, (_, i) => {
 		const value = i === length - 1 ? upperBound : lowerBound + minorTickStep * i

package/src/types.js

@@ -96,6 +96,20 @@
  */
 
 /**
- * @typedef {Array<ShadeMapping>} ShadeMappings
+ * @typedef {Object} TickMark
+ * @property {number} value - The value of the tick mark.
+ * @property {string} label - The label for the tick mark.
+ * @property {boolean} major - Indicates if the tick mark is a major tick.
  */
+
+/**
+ * @typedef {Object} CalendarDay
+ * @property {number}  day     - The day of the month.
+ * @property {number}  offset  - indicates the offset for positioning
+ * @property {date}    date    - Datevalue for the day.
+ * @property {string}  text    - formatted text for the day.
+ * @property {boolean} holiday - Indicates if the day is a holiday.
+ * @property {boolean} weekend - Indicates if the day is on the weekend.
+ */
+
 export default {}

package/src/parser.js

@@ -1,110 +0,0 @@
-/**
- * Constructs a regular expression pattern for matching search filter strings.
- * The pattern captures "column", "operator", and "value" groups for filter expressions.
- * Supported operators include common comparison and wildcard operators.
- *
- * Examples of valid expressions this regex can match:
- * - "username:john_doe"
- * - "age>30"
- * - "status!=active"
- * - "title~\"Product Manager\""
- * - "completed!~*yes"
- *
- * The "column" group matches one or more word characters.
- * The "operator" group matches one among the specified comparison or wildcard operators:
- * :, >, <, >=, <=, =<, =>, =, !=, ~, ~*, !~, !~*.
- * The "value" group matches either a double-quoted string or a single unquoted word
- * that doesn't include whitespace or any of the operator characters.
- *
- * @returns {RegExp} - The regular expression pattern to identify search filter elements.
- */
-export function getRegex() {
-	const column = '[\\w]+'
-	const operator = ':|>|<|>=|<=|=<|=>|=|!=|~|~\\*|!~|!~\\*'
-	const value = '("[^"]+"|[^\\s=:<>!~*]+)'
-
-	const pattern = `(?<group>((?<column>${column})\\s?(?<operator>${operator})\\s?)(?<value>${value}))`
-
-	return new RegExp(pattern, 'gm')
-}
-
-/**
- * Parses a search string and extracts filters based on a predefined regular expression pattern.
- * Each filter captures column, operator, and value components. Any remaining text that
- * does not fit the pattern is considered a general search term.
- *
- * @param {string} string - The search string to parse for filters.
- * @returns {Object[]} - An array of filter objects each containing the column, operator, and value,
- *                       plus an additional object for general search if there is remaining text.
- */
-export function parseFilters(string) {
-	const results = []
-	const regex = getRegex()
-
-	// Split the string into an array of tokens
-	const tokens = string.matchAll(regex)
-	let search = string
-
-	// Iterate over the tokens
-	for (const token of tokens) {
-		// Extract the named groups from the token
-		let { group, column, operator, value } = token.groups
-		search = search.replace(group, '').trim()
-
-		operator = replaceOperators(operator)
-		value = processValue(value, operator)
-
-		if (column && value) results.push({ column, operator, value })
-	}
-
-	if (search.length > 0) {
-		results.push({
-			operator: '~*',
-			value: new RegExp(removeQuotes(search), 'i')
-		})
-	}
-
-	return results
-}
-
-/**
- * Replaces various shorthand operators with their standardized equivalent for filtering.
- *
- * @param {string} operator - The operator to be replaced.
- * @returns {string} - The replaced operator string.
- */
-function replaceOperators(operator) {
-	return operator.replace(':', '~*').replace('=>', '>=').replace('=<', '<=')
-}
-
-/**
- * Processes the filter value provided, converting it into a format suitable for filtering.
- * If the operator includes a tilde (~), the value is converted to a RegExp.
- *
- * @param {string|number} value - The value to be processed. It could be a string needing quote removal or a number that needs parsing.
- * @param {string} operator - The operator that determines the type of processing to be applied to the value.
- * @returns {string|number|RegExp} - The processed value, which may be a RegExp if the operator involves pattern matching.
- */
-function processValue(value, operator) {
-	// If the value can be parsed as an integer, do so. Otherwise, strip quotes if present.
-
-	value = !isNaN(parseInt(value)) ? parseInt(value) : removeQuotes(value)
-	// If the operator includes a tilde (~), treat the value as a regular expression,
-	// case-insensitive if '*' is present, sensitive otherwise.
-	if (operator.includes('~')) {
-		value = operator.includes('*') ? new RegExp(value, 'i') : new RegExp(value)
-	}
-
-	return value
-}
-
-/**
- * Removes double quotes from the start and end of a string.
- *
- * @param {string} str - The input string from which the surrounding quotes should be removed.
- * @returns {string} - The unquoted string.
- */
-function removeQuotes(str) {
-	const quoteMatch = str.match(/^"([^"]+)"$/)
-	return quoteMatch ? quoteMatch[1] : str
-}