@rokkit/core 1.0.0-next.35 → 1.0.0-next.36

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rokkit/core",
-  "version": "1.0.0-next.35",
+  "version": "1.0.0-next.36",
   "description": "Core components, actions and stores for svelte apps.",
   "author": "Jerry Thomas <me@jerrythomas.name>",
   "license": "MIT",
@@ -15,16 +15,17 @@
   "devDependencies": {
     "@sveltejs/vite-plugin-svelte": "^2.4.2",
     "@testing-library/svelte": "^4.0.3",
-    "@vitest/coverage-c8": "^0.32.3",
-    "@vitest/coverage-istanbul": "^0.32.3",
-    "@vitest/ui": "~0.32.3",
+    "@vitest/coverage-c8": "^0.33.0",
+    "@vitest/coverage-istanbul": "^0.33.0",
+    "@vitest/coverage-v8": "^0.33.0",
+    "@vitest/ui": "~0.33.0",
     "jsdom": "^22.1.0",
-    "svelte": "^4.0.1",
+    "svelte": "^4.0.5",
     "typescript": "^5.1.6",
     "validators": "latest",
-    "vite": "^4.3.9",
-    "vitest": "~0.32.3",
-    "shared-config": "1.0.0-next.35"
+    "vite": "^4.4.4",
+    "vitest": "~0.33.0",
+    "shared-config": "1.0.0-next.36"
   },
   "files": [
     "src/**/*.js",

package/src/constants.js

@@ -1,3 +1,25 @@
+/**
+ * @type {import('./types).FieldMapping} Fields
+ */
+export const defaultFields = {
+	id: 'id',
+	url: 'url',
+	text: 'text',
+	children: 'children',
+	icon: 'icon',
+	image: 'image',
+	component: 'component',
+	summary: 'summary',
+	notes: 'notes',
+	props: 'props',
+	target: 'target',
+	state: 'state',
+	isOpen: '_open',
+	isDeleted: '_deleted',
+	level: 'level',
+	parent: 'parent'
+}
+
 export const defaultIcons = [
 	'accordion-opened',
 	'accordion-closed',
@@ -23,7 +45,16 @@ export const defaultIcons = [
 	'navigate-left',
 	'navigate-right',
 	'navigate-up',
-	'navigate-down'
+	'navigate-down',
+	'state-error',
+	'state-warning',
+	'state-success',
+	'state-info',
+	'state-unknown',
+	'validity-failed',
+	'validity-warning',
+	'validity-passed',
+	'validity-unknown'
 ]
 
 export const defaultOptions = {
@@ -33,44 +64,6 @@ export const defaultOptions = {
 	checked: 'checked'
 }
 
-/**
- * Structure to map custom fields for rendering
- *
- * @typedef FieldMapping
- * @property {string} [id='id']              - Unique id for the item
- * @property {string} [text='text']          - Attribute to identify the text to render
- * @property {string} [url='url']            - Attribute to identify a URL
- * @property {string} [icon='icon']          - Attribute to identify an icon class to render
- * @property {string} [image='image']        - Attribute to identify an image to render
- * @property {string} [children='children']  - Attribute to identify children of the current item
- * @property {string} [summary='summary']
- * @property {string} [notes='notes']
- * @property {string} [props='props']
- * @property {string} [isOpen='_open']       - Attribute to identify if the current item is open
- * @property {string} [level='level']        - Attribute to identify level of current item
- * @property {string} [parent='parent']      - Attribute to identify if the current item is a parent
- * @property {string} [isDeleted='_deleted'] - Attribute to identify if the current item is deleted
- * @property {FieldMapping} [fields?]        - Field mapping to be used on children in the next level
- */
-export const defaultFields = {
-	id: 'id',
-	url: 'url',
-	text: 'text',
-	children: 'children',
-	icon: 'icon',
-	image: 'image',
-	component: 'component',
-	summary: 'summary',
-	notes: 'notes',
-	props: 'props',
-	target: 'target',
-	state: 'state',
-	isOpen: '_open',
-	isDeleted: '_deleted',
-	level: 'level',
-	parent: 'parent'
-}
-
 export const defaultKeyMap = {
 	ArrowRight: 'open',
 	ArrowLeft: 'close',

package/src/index.js

@@ -1,3 +1,4 @@
+import './types'
 export * from './constants'
 export * from './nested'
 export * from './mapping'

package/src/mapping.js

@@ -1,11 +1,25 @@
 import { defaultFields } from './constants'
 
+/**
+ * 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 {import('./types.js').FieldMapping} fields
+ * @param {import('./types.js').ComponentMap} using
+ */
 export function getComponent(value, fields, using) {
 	return fields.component && typeof value == 'object'
 		? using[value[fields.component]] ?? using.default
 		: using.default
 }
 
+/**
+ * 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 {import('./types.js').FieldMapping} fields
+ */
 export function getIcon(value, fields = defaultFields) {
 	if (fields.icon === undefined || typeof (value ?? '') !== 'object')
 		return null
@@ -14,3 +28,9 @@ export function getIcon(value, fields = defaultFields) {
 		? value[fields.icon][value[fields.state]]
 		: value[fields.icon]
 }
+
+export function getId(node, fields = defaultFields) {
+	return typeof node === 'object' && node !== null
+		? node[fields.id] ?? node[fields.text]
+		: node
+}

package/src/types.js

@@ -0,0 +1,24 @@
+/**
+ * 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} [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']
+ * @property {string} [notes='notes']
+ * @property {string} [props='props']
+ * @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} [isDeleted='_deleted'] item is deleted
+ * @property {FieldMapping} [fields]         Field mapping to be used on children in the next level
+ */
+
+/**
+ * Component map to be used to render the item.
+ * @typedef {Object<string, import('svelte').SvelteComponent>} ComponentMap
+ */