@openframe-org/criteria-set-protocol 2.6.0 → 2.6.2

package/dist/v1/utils.d.ts

@@ -1,4 +1,4 @@
-import { Color, CriteriaTree, CriteriaTreeElement, Theme, Criterion, Task, TaskGroup, TaskItem, ThemeOptions, CriterionOptions, TaskOptions, CertificationDefinition, TaskItemValue } from "./types";
+import { Color, CriteriaTree, CriteriaTreeElement, Theme, Criterion, Task, TaskGroup, TaskItem, ThemeOptions, CriterionOptions, TaskOptions, CertificationDefinition, TaskItemValue, TaskItemData, ElementData, TreeResult } from "./types";
 interface ApplyTextFormattingPlaceholdersForThemeFunction {
     (options: ThemeOptions, element: Pick<Task, "title" | "code">): string;
 }
@@ -50,4 +50,14 @@ export declare const isNil: (value: unknown) => value is null | undefined;
  * Given a list of certification definitions, return the ones for which the given value is valid
  */
 export declare const getCertificationsByValue: (certificationDefinitions: CertificationDefinition[], value?: TaskItemValue) => CertificationDefinition[] | undefined;
+/**
+ * Given a tree element or a data object, validate that it contains valid data. If it is a tree element,
+ * extract the data object from it and validate it:
+ * - If the data is a number/<undefined> type, ensure that it has a numeric value and total
+ * - If the data is a percentage type, ensure that it has a numeric value
+ * - If the data is a boolean type, ensure that it has a boolean value
+ * - If it is a different type, throw an error
+ * In all cases, the data should contain 'text' and 'readOnly' properties
+ */
+export declare const validateData: (dataOrTreeElement: CriteriaTreeElement | TaskItemData | ElementData | TreeResult) => void;
 export {};

package/dist/v1/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCertificationsByValue = exports.isNil = exports.applyReportTitleTextFormatFormattingPlaceholders = exports.applyCriteriaTreeElementTextFormatFormattingPlaceholders = exports.applyDocumentTreeFolderTextFormattingPlaceholders = exports.applyBreadcrumbTextFormattingPlaceholders = exports.findInTree = exports.toColorHexString = exports.isTaskItem = exports.isTask = exports.isTaskGroup = exports.isCriterion = exports.isTheme = void 0;
+exports.validateData = exports.getCertificationsByValue = exports.isNil = exports.applyReportTitleTextFormatFormattingPlaceholders = exports.applyCriteriaTreeElementTextFormatFormattingPlaceholders = exports.applyDocumentTreeFolderTextFormattingPlaceholders = exports.applyBreadcrumbTextFormattingPlaceholders = exports.findInTree = exports.toColorHexString = exports.isTaskItem = exports.isTask = exports.isTaskGroup = exports.isCriterion = exports.isTheme = void 0;
 const isTheme = (element) => element.type === "theme";
 exports.isTheme = isTheme;
 const isCriterion = (element) => element.type === "criterion";
@@ -91,3 +91,53 @@ const getCertificationsByValue = (certificationDefinitions, value) => {
     });
 };
 exports.getCertificationsByValue = getCertificationsByValue;
+/**
+ * Given a tree element or a data object, validate that it contains valid data. If it is a tree element,
+ * extract the data object from it and validate it:
+ * - If the data is a number/<undefined> type, ensure that it has a numeric value and total
+ * - If the data is a percentage type, ensure that it has a numeric value
+ * - If the data is a boolean type, ensure that it has a boolean value
+ * - If it is a different type, throw an error
+ * In all cases, the data should contain 'text' and 'readOnly' properties
+ */
+const validateData = (dataOrTreeElement) => {
+    if (("type" in dataOrTreeElement) && dataOrTreeElement.type === "task-item" && !("readOnly" in dataOrTreeElement)) {
+        throw new Error("Data is missing 'readOnly' property");
+    }
+    const data = "data" in dataOrTreeElement ? dataOrTreeElement.data : dataOrTreeElement;
+    if (!data) {
+        throw new Error("Invalid data object");
+    }
+    ["value", "text"].forEach((property) => {
+        if (!(property in data)) {
+            throw new Error(`Data is missing '${property}' property`);
+        }
+    });
+    switch (data.type) {
+        case "number":
+        case undefined: {
+            if (typeof data.value !== "number") {
+                throw new Error(`Data value is not numeric: ${data.value}`);
+            }
+            if (!("total" in data) || typeof data.total !== "number") {
+                throw new Error(`Data total is missing or not numeric: ${data.total}`);
+            }
+            break;
+        }
+        case "percentage": {
+            if (typeof data.value !== "number") {
+                throw new Error(`Data value is not numeric: ${data.value}`);
+            }
+            break;
+        }
+        case "boolean": {
+            if (typeof data.value !== "boolean") {
+                throw new Error(`Data value is not a boolean: ${data.value}`);
+            }
+            break;
+        }
+        default:
+            throw new Error(`Data has an invalid 'type' property: ${data.type}`);
+    }
+};
+exports.validateData = validateData;

package/package.json

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