@openframe-org/criteria-set-protocol 2.2.1 → 2.2.3

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

@@ -14,86 +14,34 @@ export declare const colorSchema: z.ZodUnion<[z.ZodString, z.ZodObject<{
 }>]>;
 export declare const taskItemScalarValueSchema: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>;
 export declare const taskItemValueSchema: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "many">]>;
-export declare const elementDataSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
-    type: z.ZodOptional<z.ZodLiteral<"number">>;
+export declare const elementDataSchema: z.ZodObject<{
+    type: z.ZodOptional<z.ZodEnum<["number", "percentage", "boolean"]>>;
     value: z.ZodOptional<z.ZodNumber>;
+    text: z.ZodOptional<z.ZodString>;
     total: z.ZodOptional<z.ZodNumber>;
     maximumValue: z.ZodOptional<z.ZodNumber>;
     minimumValue: z.ZodOptional<z.ZodNumber>;
     exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
     exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
-    type?: "number" | undefined;
+    type?: "number" | "boolean" | "percentage" | undefined;
     total?: number | undefined;
     value?: number | undefined;
+    text?: string | undefined;
     maximumValue?: number | undefined;
     minimumValue?: number | undefined;
     exclusiveMaximum?: number | undefined;
     exclusiveMinimum?: number | undefined;
 }, {
-    type?: "number" | undefined;
+    type?: "number" | "boolean" | "percentage" | undefined;
     total?: number | undefined;
     value?: number | undefined;
+    text?: string | undefined;
     maximumValue?: number | undefined;
     minimumValue?: number | undefined;
     exclusiveMaximum?: number | undefined;
     exclusiveMinimum?: number | undefined;
-}>, z.ZodObject<{
-    maximumValue: z.ZodOptional<z.ZodNumber>;
-    minimumValue: z.ZodOptional<z.ZodNumber>;
-    exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
-    exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
-} & {
-    type: z.ZodLiteral<"percentage">;
-    value: z.ZodOptional<z.ZodNumber>;
-    total: z.ZodOptional<z.ZodNever>;
-}, "strip", z.ZodTypeAny, {
-    type: "percentage";
-    total?: undefined;
-    value?: number | undefined;
-    maximumValue?: number | undefined;
-    minimumValue?: number | undefined;
-    exclusiveMaximum?: number | undefined;
-    exclusiveMinimum?: number | undefined;
-}, {
-    type: "percentage";
-    total?: undefined;
-    value?: number | undefined;
-    maximumValue?: number | undefined;
-    minimumValue?: number | undefined;
-    exclusiveMaximum?: number | undefined;
-    exclusiveMinimum?: number | undefined;
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"boolean">;
-    value: z.ZodOptional<z.ZodBoolean>;
-    total: z.ZodOptional<z.ZodNever>;
-    maximumValue: z.ZodOptional<z.ZodNever>;
-    minimumValue: z.ZodOptional<z.ZodNever>;
-    exclusiveMaximum: z.ZodOptional<z.ZodNever>;
-    exclusiveMinimum: z.ZodOptional<z.ZodNever>;
-}, "strip", z.ZodTypeAny, {
-    type: "boolean";
-    total?: undefined;
-    value?: boolean | undefined;
-    maximumValue?: undefined;
-    minimumValue?: undefined;
-    exclusiveMaximum?: undefined;
-    exclusiveMinimum?: undefined;
-}, {
-    type: "boolean";
-    total?: undefined;
-    value?: boolean | undefined;
-    maximumValue?: undefined;
-    minimumValue?: undefined;
-    exclusiveMaximum?: undefined;
-    exclusiveMinimum?: undefined;
-}>]>, z.ZodObject<{
-    text: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    text?: string | undefined;
-}, {
-    text?: string | undefined;
-}>>;
+}>;
 export declare const criteriaTreeElementTypeSchema: z.ZodEnum<["theme", "criterion", "task-group", "task", "task-item"]>;
 export declare const abstractElementSchema: z.ZodObject<{
     type: z.ZodEnum<["theme", "criterion", "task-group", "task", "task-item"]>;
@@ -147,119 +95,50 @@ export declare const abstractElementSchema: z.ZodObject<{
         label: string;
         text: string;
     }>]>, "many">>;
-    data: z.ZodOptional<z.ZodIntersection<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
-        type: z.ZodOptional<z.ZodLiteral<"number">>;
+    data: z.ZodOptional<z.ZodObject<{
+        type: z.ZodOptional<z.ZodEnum<["number", "percentage", "boolean"]>>;
         value: z.ZodOptional<z.ZodNumber>;
+        text: z.ZodOptional<z.ZodString>;
         total: z.ZodOptional<z.ZodNumber>;
         maximumValue: z.ZodOptional<z.ZodNumber>;
         minimumValue: z.ZodOptional<z.ZodNumber>;
         exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
         exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
-        type?: "number" | undefined;
+        type?: "number" | "boolean" | "percentage" | undefined;
         total?: number | undefined;
         value?: number | undefined;
+        text?: string | undefined;
         maximumValue?: number | undefined;
         minimumValue?: number | undefined;
         exclusiveMaximum?: number | undefined;
         exclusiveMinimum?: number | undefined;
     }, {
-        type?: "number" | undefined;
+        type?: "number" | "boolean" | "percentage" | undefined;
         total?: number | undefined;
         value?: number | undefined;
+        text?: string | undefined;
         maximumValue?: number | undefined;
         minimumValue?: number | undefined;
         exclusiveMaximum?: number | undefined;
         exclusiveMinimum?: number | undefined;
-    }>, z.ZodObject<{
-        maximumValue: z.ZodOptional<z.ZodNumber>;
-        minimumValue: z.ZodOptional<z.ZodNumber>;
-        exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
-        exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
-    } & {
-        type: z.ZodLiteral<"percentage">;
-        value: z.ZodOptional<z.ZodNumber>;
-        total: z.ZodOptional<z.ZodNever>;
-    }, "strip", z.ZodTypeAny, {
-        type: "percentage";
-        total?: undefined;
-        value?: number | undefined;
-        maximumValue?: number | undefined;
-        minimumValue?: number | undefined;
-        exclusiveMaximum?: number | undefined;
-        exclusiveMinimum?: number | undefined;
-    }, {
-        type: "percentage";
-        total?: undefined;
-        value?: number | undefined;
-        maximumValue?: number | undefined;
-        minimumValue?: number | undefined;
-        exclusiveMaximum?: number | undefined;
-        exclusiveMinimum?: number | undefined;
-    }>, z.ZodObject<{
-        type: z.ZodLiteral<"boolean">;
-        value: z.ZodOptional<z.ZodBoolean>;
-        total: z.ZodOptional<z.ZodNever>;
-        maximumValue: z.ZodOptional<z.ZodNever>;
-        minimumValue: z.ZodOptional<z.ZodNever>;
-        exclusiveMaximum: z.ZodOptional<z.ZodNever>;
-        exclusiveMinimum: z.ZodOptional<z.ZodNever>;
-    }, "strip", z.ZodTypeAny, {
-        type: "boolean";
-        total?: undefined;
-        value?: boolean | undefined;
-        maximumValue?: undefined;
-        minimumValue?: undefined;
-        exclusiveMaximum?: undefined;
-        exclusiveMinimum?: undefined;
-    }, {
-        type: "boolean";
-        total?: undefined;
-        value?: boolean | undefined;
-        maximumValue?: undefined;
-        minimumValue?: undefined;
-        exclusiveMaximum?: undefined;
-        exclusiveMinimum?: undefined;
-    }>]>, z.ZodObject<{
-        text: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        text?: string | undefined;
-    }, {
-        text?: string | undefined;
-    }>>>;
+    }>>;
     sortOrder: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     code: string;
     type: "theme" | "criterion" | "task-group" | "task" | "task-item";
     title: string;
     longFormTitle: string;
-    data?: (({
-        type?: "number" | undefined;
+    data?: {
+        type?: "number" | "boolean" | "percentage" | undefined;
         total?: number | undefined;
         value?: number | undefined;
+        text?: string | undefined;
         maximumValue?: number | undefined;
         minimumValue?: number | undefined;
         exclusiveMaximum?: number | undefined;
         exclusiveMinimum?: number | undefined;
-    } | {
-        type: "percentage";
-        total?: undefined;
-        value?: number | undefined;
-        maximumValue?: number | undefined;
-        minimumValue?: number | undefined;
-        exclusiveMaximum?: number | undefined;
-        exclusiveMinimum?: number | undefined;
-    } | {
-        type: "boolean";
-        total?: undefined;
-        value?: boolean | undefined;
-        maximumValue?: undefined;
-        minimumValue?: undefined;
-        exclusiveMaximum?: undefined;
-        exclusiveMinimum?: undefined;
-    }) & {
-        text?: string | undefined;
-    }) | undefined;
+    } | undefined;
     tags?: string[] | undefined;
     documentation?: ({
         type: "pdf";
@@ -282,33 +161,16 @@ export declare const abstractElementSchema: z.ZodObject<{
     type: "theme" | "criterion" | "task-group" | "task" | "task-item";
     title: string;
     longFormTitle: string;
-    data?: (({
-        type?: "number" | undefined;
+    data?: {
+        type?: "number" | "boolean" | "percentage" | undefined;
         total?: number | undefined;
         value?: number | undefined;
+        text?: string | undefined;
         maximumValue?: number | undefined;
         minimumValue?: number | undefined;
         exclusiveMaximum?: number | undefined;
         exclusiveMinimum?: number | undefined;
-    } | {
-        type: "percentage";
-        total?: undefined;
-        value?: number | undefined;
-        maximumValue?: number | undefined;
-        minimumValue?: number | undefined;
-        exclusiveMaximum?: number | undefined;
-        exclusiveMinimum?: number | undefined;
-    } | {
-        type: "boolean";
-        total?: undefined;
-        value?: boolean | undefined;
-        maximumValue?: undefined;
-        minimumValue?: undefined;
-        exclusiveMaximum?: undefined;
-        exclusiveMinimum?: undefined;
-    }) & {
-        text?: string | undefined;
-    }) | undefined;
+    } | undefined;
     tags?: string[] | undefined;
     documentation?: ({
         type: "pdf";
@@ -365,3 +227,31 @@ export declare const documentTreeOptionsSchema: z.ZodUnion<[z.ZodObject<{
     documentTreeFolderTextFormat: string;
     hideFromDocumentTree?: false | undefined;
 }>]>;
+export declare const treeResultSchema: z.ZodObject<{
+    type: z.ZodOptional<z.ZodEnum<["number", "percentage", "boolean"]>>;
+    value: z.ZodOptional<z.ZodNumber>;
+    text: z.ZodOptional<z.ZodString>;
+    total: z.ZodOptional<z.ZodNumber>;
+    maximumValue: z.ZodOptional<z.ZodNumber>;
+    minimumValue: z.ZodOptional<z.ZodNumber>;
+    exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
+    exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    type?: "number" | "boolean" | "percentage" | undefined;
+    total?: number | undefined;
+    value?: number | undefined;
+    text?: string | undefined;
+    maximumValue?: number | undefined;
+    minimumValue?: number | undefined;
+    exclusiveMaximum?: number | undefined;
+    exclusiveMinimum?: number | undefined;
+}, {
+    type?: "number" | "boolean" | "percentage" | undefined;
+    total?: number | undefined;
+    value?: number | undefined;
+    text?: string | undefined;
+    maximumValue?: number | undefined;
+    minimumValue?: number | undefined;
+    exclusiveMaximum?: number | undefined;
+    exclusiveMinimum?: number | undefined;
+}>;

package/dist/v1/schemas/common.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.documentTreeOptionsSchema = exports.breadcrumbOptionsSchema = exports.abstractElementSchema = exports.criteriaTreeElementTypeSchema = exports.elementDataSchema = exports.taskItemValueSchema = exports.taskItemScalarValueSchema = exports.colorSchema = void 0;
+exports.treeResultSchema = exports.documentTreeOptionsSchema = exports.breadcrumbOptionsSchema = exports.abstractElementSchema = exports.criteriaTreeElementTypeSchema = exports.elementDataSchema = exports.taskItemValueSchema = exports.taskItemScalarValueSchema = exports.colorSchema = void 0;
 const zod_1 = require("zod");
 const documentation_1 = require("./documentation");
 exports.colorSchema = zod_1.z
@@ -20,12 +20,14 @@ exports.taskItemScalarValueSchema = zod_1.z
 exports.taskItemValueSchema = zod_1.z
     .union([exports.taskItemScalarValueSchema, zod_1.z.array(exports.taskItemScalarValueSchema)])
     .describe("TaskItemValue - Can be either a scalar value or an array of scalar values");
-const numberBasedDataSchema = zod_1.z.object({
+exports.elementDataSchema = zod_1.z
+    .object({
     type: zod_1.z
-        .literal("number")
+        .enum(["number", "percentage", "boolean"])
         .optional()
-        .describe("Type of numeric data (percentage or number)"),
+        .describe("Type of data"),
     value: zod_1.z.number().optional().describe("Value of the element"),
+    text: zod_1.z.string().optional().describe("Text representation of the value"),
     total: zod_1.z
         .number()
         .optional()
@@ -46,34 +48,7 @@ const numberBasedDataSchema = zod_1.z.object({
         .number()
         .optional()
         .describe("Minimum allowed value (exclusive)"),
-});
-const percentageBasedDataSchema = numberBasedDataSchema.omit({
-    type: true,
-    total: true
-}).extend({
-    type: zod_1.z
-        .literal("percentage")
-        .describe("Type of numeric data (percentage or number)"),
-    value: zod_1.z.number().optional().describe("Value of the element"),
-    total: zod_1.z.never().optional(),
-});
-const booleanBasedDataSchema = zod_1.z.object({
-    type: zod_1.z
-        .literal("boolean")
-        .describe("Type of numeric data (percentage or number)"),
-    value: zod_1.z.boolean().optional().describe("Value of the element"),
-    total: zod_1.z.never().optional(),
-    maximumValue: zod_1.z.never().optional(),
-    minimumValue: zod_1.z.never().optional(),
-    exclusiveMaximum: zod_1.z.never().optional(),
-    exclusiveMinimum: zod_1.z.never().optional(),
-});
-const valueDataSchema = zod_1.z.discriminatedUnion('type', [numberBasedDataSchema, percentageBasedDataSchema, booleanBasedDataSchema])
-    .describe("ValueData - Data containing value constraints and metadata");
-exports.elementDataSchema = valueDataSchema.and(zod_1.z
-    .object({
-    text: zod_1.z.string().optional().describe("Text representation of the value"),
-}))
+})
     .describe("ElementData - Element data containing value constraints and metadata");
 exports.criteriaTreeElementTypeSchema = zod_1.z
     .enum(["theme", "criterion", "task-group", "task", "task-item"])
@@ -82,9 +57,7 @@ exports.abstractElementSchema = zod_1.z
     .object({
     type: exports.criteriaTreeElementTypeSchema.describe("CriteriaTreeElementType of the tree element"),
     title: zod_1.z.string().describe("Display title of the element"),
-    longFormTitle: zod_1.z
-        .string()
-        .describe("Extended or full-length title"),
+    longFormTitle: zod_1.z.string().describe("Extended or full-length title"),
     code: zod_1.z.string().describe("Unique identifier code"),
     tags: zod_1.z
         .array(zod_1.z.string())
@@ -134,3 +107,4 @@ exports.documentTreeOptionsSchema = zod_1.z
         .string()
         .describe("The format of the document tree folder text, use ':code:' and ':title:' to define where the code and/or title should be inserted"),
 }));
+exports.treeResultSchema = exports.elementDataSchema.describe('TreeResult - The result of the evaluation of a criteria set');

package/dist/v1/schemas/criteria-set.js

@@ -9,7 +9,6 @@ exports.DASHBOARD_CATEGORY_LISTING_TYPES = [
 exports.dashboardCategoryListingTypeSchema = zod_1.z.enum(exports.DASHBOARD_CATEGORY_LISTING_TYPES);
 exports.criteriaSetOptionsSchema = zod_1.z
     .object({
-    dashboardRenderingType: exports.dashboardCategoryListingTypeSchema
-        .describe("Whether to render the criteria set in a dashboard as a list of criteria or as a list of tasks"),
+    dashboardRenderingType: exports.dashboardCategoryListingTypeSchema.describe("Whether to render the criteria set in a dashboard as a list of criteria or as a list of tasks"),
 })
     .describe("CriteriaSetOptions - options for a criteria set");