@openframe-org/criteria-set-protocol 2.8.0-alpha.0 → 2.9.0

package/dist/v1/schemas/theme.d.ts

@@ -164,10 +164,115 @@ export declare const themeSchema: z.ZodObject<{
                         defaultValue: z.ZodOptional<z.ZodBoolean>;
                     }, z.core.$strip>], "type">;
                     description: z.ZodNullable<z.ZodString>;
+                    data: z.ZodIntersection<z.ZodType<{
+                        text: string;
+                    } & ({
+                        [x: string]: any;
+                        value: number;
+                        total: number;
+                        maximumValue?: number | undefined;
+                        minimumValue?: number | undefined;
+                        exclusiveMaximum?: number | undefined;
+                        exclusiveMinimum?: number | undefined;
+                        weight?: number | undefined;
+                        type?: "number" | undefined;
+                    } | {
+                        [x: string]: any;
+                        type: "percentage";
+                        value: number;
+                        maximumValue?: number | undefined;
+                        minimumValue?: number | undefined;
+                        exclusiveMaximum?: number | undefined;
+                        exclusiveMinimum?: number | undefined;
+                        weight?: number | undefined;
+                    } | {
+                        [x: string]: any;
+                        type: "boolean";
+                        value: boolean;
+                    }), unknown, z.core.$ZodTypeInternals<{
+                        text: string;
+                    } & ({
+                        [x: string]: any;
+                        value: number;
+                        total: number;
+                        maximumValue?: number | undefined;
+                        minimumValue?: number | undefined;
+                        exclusiveMaximum?: number | undefined;
+                        exclusiveMinimum?: number | undefined;
+                        weight?: number | undefined;
+                        type?: "number" | undefined;
+                    } | {
+                        [x: string]: any;
+                        type: "percentage";
+                        value: number;
+                        maximumValue?: number | undefined;
+                        minimumValue?: number | undefined;
+                        exclusiveMaximum?: number | undefined;
+                        exclusiveMinimum?: number | undefined;
+                        weight?: number | undefined;
+                    } | {
+                        [x: string]: any;
+                        type: "boolean";
+                        value: boolean;
+                    }), unknown>>, z.ZodObject<{
+                        readOnly: z.ZodBoolean;
+                        valueReference: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull, z.ZodUndefined, z.ZodArray<z.ZodString>]>>;
+                    }, z.core.$strip>>;
                     options: z.ZodObject<{
                         excludeFromTargets: z.ZodOptional<z.ZodBoolean>;
                     }, z.core.$strip>;
                 }, z.core.$strip>>>;
+                data: z.ZodType<{
+                    text: string;
+                } & ({
+                    [x: string]: any;
+                    value: number;
+                    total: number;
+                    maximumValue?: number | undefined;
+                    minimumValue?: number | undefined;
+                    exclusiveMaximum?: number | undefined;
+                    exclusiveMinimum?: number | undefined;
+                    weight?: number | undefined;
+                    type?: "number" | undefined;
+                } | {
+                    [x: string]: any;
+                    type: "percentage";
+                    value: number;
+                    maximumValue?: number | undefined;
+                    minimumValue?: number | undefined;
+                    exclusiveMaximum?: number | undefined;
+                    exclusiveMinimum?: number | undefined;
+                    weight?: number | undefined;
+                } | {
+                    [x: string]: any;
+                    type: "boolean";
+                    value: boolean;
+                }), unknown, z.core.$ZodTypeInternals<{
+                    text: string;
+                } & ({
+                    [x: string]: any;
+                    value: number;
+                    total: number;
+                    maximumValue?: number | undefined;
+                    minimumValue?: number | undefined;
+                    exclusiveMaximum?: number | undefined;
+                    exclusiveMinimum?: number | undefined;
+                    weight?: number | undefined;
+                    type?: "number" | undefined;
+                } | {
+                    [x: string]: any;
+                    type: "percentage";
+                    value: number;
+                    maximumValue?: number | undefined;
+                    minimumValue?: number | undefined;
+                    exclusiveMaximum?: number | undefined;
+                    exclusiveMinimum?: number | undefined;
+                    weight?: number | undefined;
+                } | {
+                    [x: string]: any;
+                    type: "boolean";
+                    value: boolean;
+                }), unknown>>;
                 options: z.ZodObject<{
                     breadcrumbTextFormat: z.ZodString;
                     documentTreeFolderTextFormat: z.ZodString;
@@ -177,6 +282,57 @@ export declare const themeSchema: z.ZodObject<{
                 }, z.core.$strip>;
             }, z.core.$strip>>>;
         }, z.core.$strip>>>;
+        data: z.ZodType<{
+            text: string;
+        } & ({
+            [x: string]: any;
+            value: number;
+            total: number;
+            maximumValue?: number | undefined;
+            minimumValue?: number | undefined;
+            exclusiveMaximum?: number | undefined;
+            exclusiveMinimum?: number | undefined;
+            weight?: number | undefined;
+            type?: "number" | undefined;
+        } | {
+            [x: string]: any;
+            type: "percentage";
+            value: number;
+            maximumValue?: number | undefined;
+            minimumValue?: number | undefined;
+            exclusiveMaximum?: number | undefined;
+            exclusiveMinimum?: number | undefined;
+            weight?: number | undefined;
+        } | {
+            [x: string]: any;
+            type: "boolean";
+            value: boolean;
+        }), unknown, z.core.$ZodTypeInternals<{
+            text: string;
+        } & ({
+            [x: string]: any;
+            value: number;
+            total: number;
+            maximumValue?: number | undefined;
+            minimumValue?: number | undefined;
+            exclusiveMaximum?: number | undefined;
+            exclusiveMinimum?: number | undefined;
+            weight?: number | undefined;
+            type?: "number" | undefined;
+        } | {
+            [x: string]: any;
+            type: "percentage";
+            value: number;
+            maximumValue?: number | undefined;
+            minimumValue?: number | undefined;
+            exclusiveMaximum?: number | undefined;
+            exclusiveMinimum?: number | undefined;
+            weight?: number | undefined;
+        } | {
+            [x: string]: any;
+            type: "boolean";
+            value: boolean;
+        }), unknown>>;
         options: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
             hideCodeInReport: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
             criteriaTreeElementTextFormat: z.ZodString;
@@ -193,6 +349,57 @@ export declare const themeSchema: z.ZodObject<{
             documentTreeFolderTextFormat: z.ZodString;
         }, z.core.$strip>], "hideFromDocumentTree">>;
     }, z.core.$strip>>;
+    data: z.ZodType<{
+        text: string;
+    } & ({
+        [x: string]: any;
+        value: number;
+        total: number;
+        maximumValue?: number | undefined;
+        minimumValue?: number | undefined;
+        exclusiveMaximum?: number | undefined;
+        exclusiveMinimum?: number | undefined;
+        weight?: number | undefined;
+        type?: "number" | undefined;
+    } | {
+        [x: string]: any;
+        type: "percentage";
+        value: number;
+        maximumValue?: number | undefined;
+        minimumValue?: number | undefined;
+        exclusiveMaximum?: number | undefined;
+        exclusiveMinimum?: number | undefined;
+        weight?: number | undefined;
+    } | {
+        [x: string]: any;
+        type: "boolean";
+        value: boolean;
+    }), unknown, z.core.$ZodTypeInternals<{
+        text: string;
+    } & ({
+        [x: string]: any;
+        value: number;
+        total: number;
+        maximumValue?: number | undefined;
+        minimumValue?: number | undefined;
+        exclusiveMaximum?: number | undefined;
+        exclusiveMinimum?: number | undefined;
+        weight?: number | undefined;
+        type?: "number" | undefined;
+    } | {
+        [x: string]: any;
+        type: "percentage";
+        value: number;
+        maximumValue?: number | undefined;
+        minimumValue?: number | undefined;
+        exclusiveMaximum?: number | undefined;
+        exclusiveMinimum?: number | undefined;
+        weight?: number | undefined;
+    } | {
+        [x: string]: any;
+        type: "boolean";
+        value: boolean;
+    }), unknown>>;
     options: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
         hideCodeInReport: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
         reportTitleTextFormat: z.ZodOptional<z.ZodString>;

package/dist/v1/schemas/theme.js

@@ -30,6 +30,7 @@ exports.themeSchema = common_1.abstractElementSchema
         .nullable()
         .describe("Visual styling configuration for the theme"),
     items: zod_1.z.array(criterion_1.criterionSchema).describe("The criteria in this theme"),
+    data: common_1.elementDataSchema.describe("Data associated with the theme"),
     options: exports.themeOptionsSchema.describe("Configuration options for the theme display and behavior"),
 })
     .describe("Theme - Represents a theme, which is the top layer of the criteria tree");

package/dist/v1/services/criteria-set.service.d.ts

@@ -1,7 +1,7 @@
 import { CriteriaTree, Metadata, DataMap, StreamMatrixResponse, TaskItemValueReferenceMap } from "../types";
 export type TreeAndMapParameters<ParametersType extends Record<string, any> | undefined = undefined> = {
     parameters: ParametersType extends undefined ? undefined : ParametersType;
-    values?: TaskItemValueReferenceMap | null;
+    valueReferences?: TaskItemValueReferenceMap | null;
 };
 export type MatrixParameters<ParametersType extends Record<string, any> | undefined = undefined> = TreeAndMapParameters<ParametersType> & {
     additional?: any;

package/dist/v1/utils.d.ts

@@ -1,4 +1,4 @@
-import { Color, CriteriaTree, CriteriaTreeElement, Theme, Criterion, Task, TaskGroup, TaskItem, CertificationDefinition, TaskItemValueReference, TaskItemData, ElementData, TreeResult, CriteriaTreeElementType } from "./types";
+import { Color, CriteriaTree, CriteriaTreeElement, Theme, Criterion, Task, TaskGroup, TaskItem, CertificationDefinition, TaskItemValueReference, TaskItemData, ElementData, TreeResult, CriteriaTreeElementType, TaskItemDefinition } from "./types";
 interface ApplyBreadcrumbTextFormattingPlaceholdersFunction {
     (options: {
         breadcrumbTextFormat: string | undefined;
@@ -73,7 +73,7 @@ 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?: TaskItemValueReference) => CertificationDefinition[] | undefined;
+export declare const getCertificationsByValue: (certificationDefinitions: CertificationDefinition[], value?: number | boolean | null) => CertificationDefinition[];
 /**
  * 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:
@@ -86,4 +86,5 @@ export declare const getCertificationsByValue: (certificationDefinitions: Certif
 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 declare const resolveTaskItemValue: (taskItemDefinition: TaskItemDefinition, valueReference: TaskItemValueReference) => number | boolean | null;
 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.resolveTaskItemValue = 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;
@@ -46,14 +46,14 @@ exports.findInTree = findInTree;
 /**
  * Apply the text formatting used in document tree folder naming
  */
-const applyBreadcrumbTextFormattingPlaceholders = ({ breadcrumbTextFormat = ':code:' }, { title, code }) => breadcrumbTextFormat
+const applyBreadcrumbTextFormattingPlaceholders = ({ breadcrumbTextFormat = ":code:" }, { title, code }) => breadcrumbTextFormat
     .replace(/:code:/g, code)
     .replace(/:title:/g, title);
 exports.applyBreadcrumbTextFormattingPlaceholders = applyBreadcrumbTextFormattingPlaceholders;
 /**
  * Apply the text formatting used in the document tree
  */
-const applyDocumentTreeFolderTextFormattingPlaceholders = ({ documentTreeFolderTextFormat = ':code:' }, { title, code }) => documentTreeFolderTextFormat
+const applyDocumentTreeFolderTextFormattingPlaceholders = ({ documentTreeFolderTextFormat = ":code:" }, { title, code }) => documentTreeFolderTextFormat
     .replace(/:code:/g, code)
     .replace(/:title:/g, title);
 exports.applyDocumentTreeFolderTextFormattingPlaceholders = applyDocumentTreeFolderTextFormattingPlaceholders;
@@ -67,7 +67,7 @@ exports.applyCriteriaTreeElementTextFormatFormattingPlaceholders = applyCriteria
 /**
  * Apply the text formatting used in the report title
  */
-const applyReportTitleTextFormatFormattingPlaceholders = ({ reportTitleTextFormat = ':title:' }, { title, code }) => reportTitleTextFormat
+const applyReportTitleTextFormatFormattingPlaceholders = ({ reportTitleTextFormat = ":title:" }, { title, code }) => reportTitleTextFormat
     .replace(/:code:/g, code)
     .replace(/:title:/g, title);
 exports.applyReportTitleTextFormatFormattingPlaceholders = applyReportTitleTextFormatFormattingPlaceholders;
@@ -78,17 +78,17 @@ exports.isNil = isNil;
  */
 const getCertificationsByValue = (certificationDefinitions, value) => {
     if (typeof value !== "number") {
-        return undefined;
+        return [];
     }
     return certificationDefinitions.filter((definition) => {
         return (((0, exports.isNil)(definition.rules.minimum) ||
-            value > definition.rules.minimum) &&
+            value >= definition.rules.minimum) &&
             ((0, exports.isNil)(definition.rules.exclusiveMinimum) ||
-                value >= definition.rules.exclusiveMinimum) &&
+                value > definition.rules.exclusiveMinimum) &&
             ((0, exports.isNil)(definition.rules.maximum) ||
-                value < definition.rules.maximum) &&
+                value <= definition.rules.maximum) &&
             ((0, exports.isNil)(definition.rules.exclusiveMaximum) ||
-                value <= definition.rules.exclusiveMaximum));
+                value < definition.rules.exclusiveMaximum));
     });
 };
 exports.getCertificationsByValue = getCertificationsByValue;
@@ -127,10 +127,54 @@ function validateData(data, dataType) {
         default:
             throw new Error(`Data has an invalid 'type' property: ${data.type}`);
     }
-    if (dataType === 'task-item') {
+    if (dataType === "task-item") {
         if (!("readOnly" in data)) {
             throw new Error("Data is missing 'readOnly' property");
         }
     }
     return true;
 }
+const resolveTaskItemValue = (taskItemDefinition, valueReference) => {
+    const toFiniteNumberOrNull = (rawValue) => {
+        if ((0, exports.isNil)(rawValue)) {
+            return null;
+        }
+        const numericValue = Number(rawValue);
+        return Number.isFinite(numericValue) ? numericValue : null;
+    };
+    const resolveSingleOptionValue = (optionOrValueReference) => {
+        var _a, _b;
+        if (taskItemDefinition.type !== "select-single" && taskItemDefinition.type !== "select-multiple") {
+            return null;
+        }
+        if (typeof optionOrValueReference === "number") {
+            return optionOrValueReference;
+        }
+        const foundValue = (_b = (_a = taskItemDefinition.options.find((option) => option.id === optionOrValueReference)) === null || _a === void 0 ? void 0 : _a.value) !== null && _b !== void 0 ? _b : null;
+        return toFiniteNumberOrNull(foundValue);
+    };
+    switch (taskItemDefinition.type) {
+        case "number":
+            return toFiniteNumberOrNull(valueReference);
+        case "boolean":
+            return valueReference === "true" || valueReference === "1" || valueReference === true || valueReference === 1;
+        case "select-single": {
+            return resolveSingleOptionValue(valueReference);
+        }
+        case "select-multiple": {
+            const optionIds = Array.isArray(valueReference) ? valueReference : [valueReference];
+            let resolvedValue = null;
+            for (const optionId of optionIds) {
+                const resolvedOptionValue = resolveSingleOptionValue(optionId);
+                if (!(0, exports.isNil)(resolvedOptionValue)) {
+                    resolvedValue !== null && resolvedValue !== void 0 ? resolvedValue : (resolvedValue = 0);
+                    resolvedValue += resolvedOptionValue;
+                }
+            }
+            return resolvedValue;
+        }
+        default:
+            throw new Error(`Unsupported task item type: ${taskItemDefinition.type}`);
+    }
+};
+exports.resolveTaskItemValue = resolveTaskItemValue;

package/package.json

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