@openframe-org/criteria-set-protocol 2.7.4 → 2.7.6

package/dist/v1/utils.d.ts

@@ -1,4 +1,4 @@
-import { Color, CriteriaTree, CriteriaTreeElement, Theme, Criterion, Task, TaskGroup, TaskItem, CertificationDefinition, TaskItemValueReference, TaskItemData, ElementData, TreeResult } from "./types";
+import { Color, CriteriaTree, CriteriaTreeElement, Theme, Criterion, Task, TaskGroup, TaskItem, CertificationDefinition, TaskItemValueReference, TaskItemData, ElementData, TreeResult, CriteriaTreeElementType } from "./types";
 interface ApplyBreadcrumbTextFormattingPlaceholdersFunction {
     (options: {
         breadcrumbTextFormat: string | undefined;
@@ -83,5 +83,7 @@ export declare const getCertificationsByValue: (certificationDefinitions: Certif
  * - 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 declare function validateData(data: TaskItemData | ElementData | TreeResult, dataType: Exclude<CriteriaTreeElementType, "task-group" | "task-item">): data is ElementData;
+export declare function validateData(data: TaskItemData | ElementData | TreeResult, dataType: Extract<CriteriaTreeElementType, "task-item">): data is TaskItemData;
+export declare function validateData(data: TaskItemData | ElementData | TreeResult, dataType: "tree-result"): data is TreeResult;
 export {};

package/dist/v1/utils.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+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 = validateData;
 const isTheme = (element) => element.type === "theme";
 exports.isTheme = isTheme;
 const isCriterion = (element) => element.type === "criterion";
@@ -91,25 +92,9 @@ 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-group") {
-        throw new Error("Task groups cannot have data");
-    }
-    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");
+function validateData(data, dataType) {
+    if (!["theme", "criterion", "task", "task-item", "tree-result"].includes(dataType)) {
+        throw new Error(`Invalid element type: '${dataType}'`);
     }
     ["value", "text"].forEach((property) => {
         if (!(property in data)) {
@@ -142,5 +127,10 @@ const validateData = (dataOrTreeElement) => {
         default:
             throw new Error(`Data has an invalid 'type' property: ${data.type}`);
     }
-};
-exports.validateData = validateData;
+    if (dataType === 'task-item') {
+        if (!("readOnly" in data)) {
+            throw new Error("Data is missing 'readOnly' property");
+        }
+    }
+    return true;
+}

package/package.json

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