@openframe-org/criteria-set-protocol 1.4.6 → 1.4.7

package/dist/v1/utils.d.ts

@@ -1,17 +1,33 @@
-import { Color, CriteriaTreeElement, Quality, Criterion, Task, TaskGroup, TaskItem } from './types';
+import { Color, CriteriaTree, CriteriaTreeElement, Quality, Criterion, Task, TaskGroup, TaskItem } from './types';
 export declare const isQuality: (element: CriteriaTreeElement) => element is Quality;
 export declare const isCriterion: (element: CriteriaTreeElement) => element is Criterion;
 export declare const isTaskGroup: (element: CriteriaTreeElement) => element is TaskGroup;
 export declare const isTask: (element: CriteriaTreeElement) => element is Task;
 export declare const isTaskItem: (element: CriteriaTreeElement) => element is TaskItem;
+/**
+ * Convert a color object to a hex string
+ */
 export declare const toColorHexString: (color: Color) => string;
+/**
+ * Check if a tree element should be hidden in the output
+ */
 export declare const shouldHideCode: (element: CriteriaTreeElement | {
     code: string;
 } | string) => boolean;
+/**
+ * Get the qualified name of a tree element, which is the title with the code prepended if it is different
+ */
 export declare const getQualifiedName: (element: Quality | Criterion | TaskGroup | Task | {
     code: string;
     title: string;
 }) => string;
+/**
+ * Get the code for a tree element, stripping away unnecessary characters
+ */
 export declare const resolveCode: (element: CriteriaTreeElement | {
     code: string;
 } | string) => string;
+/**
+ * Find an element in the criteria tree by its code
+ */
+export declare const findInTree: (tree: CriteriaTree, code: string) => CriteriaTreeElement | null;

package/dist/v1/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveCode = exports.getQualifiedName = exports.shouldHideCode = exports.toColorHexString = exports.isTaskItem = exports.isTask = exports.isTaskGroup = exports.isCriterion = exports.isQuality = void 0;
+exports.findInTree = exports.resolveCode = exports.getQualifiedName = exports.shouldHideCode = exports.toColorHexString = exports.isTaskItem = exports.isTask = exports.isTaskGroup = exports.isCriterion = exports.isQuality = void 0;
 const isQuality = (element) => element.type === 'quality';
 exports.isQuality = isQuality;
 const isCriterion = (element) => element.type === 'criterion';
@@ -11,6 +11,9 @@ const isTask = (element) => element.type === 'task';
 exports.isTask = isTask;
 const isTaskItem = (element) => element.type === 'task-item';
 exports.isTaskItem = isTaskItem;
+/**
+ * Convert a color object to a hex string
+ */
 const toColorHexString = (color) => {
     if (typeof color === 'string') {
         return color;
@@ -18,10 +21,16 @@ const toColorHexString = (color) => {
     return `#${color.red.toString(16)}${color.green.toString(16)}${color.blue.toString(16)}`;
 };
 exports.toColorHexString = toColorHexString;
+/**
+ * Check if a tree element should be hidden in the output
+ */
 const shouldHideCode = (element) => {
     return (typeof element === 'string' ? element : element.code).startsWith('_');
 };
 exports.shouldHideCode = shouldHideCode;
+/**
+ * Get the qualified name of a tree element, which is the title with the code prepended if it is different
+ */
 const getQualifiedName = (element) => {
     const code = element.code.startsWith('_') ? element.code.substring(1) : element.code;
     if (element.title === code) {
@@ -30,8 +39,43 @@ const getQualifiedName = (element) => {
     return `${code} ${element.title}`;
 };
 exports.getQualifiedName = getQualifiedName;
+/**
+ * Get the code for a tree element, stripping away unnecessary characters
+ */
 const resolveCode = (element) => {
     const resolvedCode = typeof element === 'string' ? element : element.code;
     return resolvedCode.startsWith('_') ? resolvedCode.substring(1) : resolvedCode;
 };
 exports.resolveCode = resolveCode;
+/**
+ * Find an element in the criteria tree by its code
+ */
+const findInTree = (tree, code) => {
+    for (const quality of tree.qualities) {
+        if (quality.code === code) {
+            return quality;
+        }
+        for (const criteria of quality.items) {
+            if (criteria.code === code) {
+                return criteria;
+            }
+            for (const taskGroup of criteria.items) {
+                if (taskGroup.code === code) {
+                    return taskGroup;
+                }
+                for (const task of taskGroup.items) {
+                    if (task.code === code) {
+                        return task;
+                    }
+                    for (const taskItem of task.items) {
+                        if (taskItem.code === code) {
+                            return taskItem;
+                        }
+                    }
+                }
+            }
+        }
+    }
+    return null;
+};
+exports.findInTree = findInTree;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openframe-org/criteria-set-protocol",
-  "version": "1.4.6",
+  "version": "1.4.7",
   "description": "A protocol and tools for defining and working with criteria sets",
   "private": false,
   "author": "Andrés Angulo <aa@openframe.org>",