@openframe-org/criteria-set-protocol 2.2.5 → 2.2.7

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

@@ -14,9 +14,7 @@ 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.ZodObject<{
-    type: z.ZodOptional<z.ZodEnum<["number", "percentage", "boolean"]>>;
-    value: z.ZodOptional<z.ZodNumber>;
+export declare const elementDataSchema: z.ZodIntersection<z.ZodObject<{
     text: z.ZodOptional<z.ZodString>;
     total: z.ZodOptional<z.ZodNumber>;
     maximumValue: z.ZodOptional<z.ZodNumber>;
@@ -24,24 +22,38 @@ export declare const elementDataSchema: z.ZodObject<{
     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;
-}>;
+}>, z.ZodUnion<[z.ZodObject<{
+    type: z.ZodOptional<z.ZodEnum<["number", "percentage"]>>;
+    value: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    type?: "number" | "percentage" | undefined;
+    value?: number | undefined;
+}, {
+    type?: "number" | "percentage" | undefined;
+    value?: number | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"boolean">;
+    value: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    type: "boolean";
+    value?: boolean | undefined;
+}, {
+    type: "boolean";
+    value?: boolean | 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"]>;
@@ -95,9 +107,7 @@ export declare const abstractElementSchema: z.ZodObject<{
         label: string;
         text: string;
     }>]>, "many">>;
-    data: z.ZodOptional<z.ZodObject<{
-        type: z.ZodOptional<z.ZodEnum<["number", "percentage", "boolean"]>>;
-        value: z.ZodOptional<z.ZodNumber>;
+    data: z.ZodOptional<z.ZodIntersection<z.ZodObject<{
         text: z.ZodOptional<z.ZodString>;
         total: z.ZodOptional<z.ZodNumber>;
         maximumValue: z.ZodOptional<z.ZodNumber>;
@@ -105,40 +115,58 @@ export declare const abstractElementSchema: z.ZodObject<{
         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;
-    }>>;
+    }>, z.ZodUnion<[z.ZodObject<{
+        type: z.ZodOptional<z.ZodEnum<["number", "percentage"]>>;
+        value: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        type?: "number" | "percentage" | undefined;
+        value?: number | undefined;
+    }, {
+        type?: "number" | "percentage" | undefined;
+        value?: number | undefined;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"boolean">;
+        value: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        type: "boolean";
+        value?: boolean | undefined;
+    }, {
+        type: "boolean";
+        value?: boolean | 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" | "boolean" | "percentage" | undefined;
+    data?: ({
         total?: number | undefined;
-        value?: number | undefined;
         text?: string | undefined;
         maximumValue?: number | undefined;
         minimumValue?: number | undefined;
         exclusiveMaximum?: number | undefined;
         exclusiveMinimum?: number | undefined;
-    } | undefined;
+    } & ({
+        type?: "number" | "percentage" | undefined;
+        value?: number | undefined;
+    } | {
+        type: "boolean";
+        value?: boolean | undefined;
+    })) | undefined;
     tags?: string[] | undefined;
     documentation?: ({
         type: "pdf";
@@ -161,16 +189,20 @@ export declare const abstractElementSchema: z.ZodObject<{
     type: "theme" | "criterion" | "task-group" | "task" | "task-item";
     title: string;
     longFormTitle: string;
-    data?: {
-        type?: "number" | "boolean" | "percentage" | undefined;
+    data?: ({
         total?: number | undefined;
-        value?: number | undefined;
         text?: string | undefined;
         maximumValue?: number | undefined;
         minimumValue?: number | undefined;
         exclusiveMaximum?: number | undefined;
         exclusiveMinimum?: number | undefined;
-    } | undefined;
+    } & ({
+        type?: "number" | "percentage" | undefined;
+        value?: number | undefined;
+    } | {
+        type: "boolean";
+        value?: boolean | undefined;
+    })) | undefined;
     tags?: string[] | undefined;
     documentation?: ({
         type: "pdf";
@@ -227,9 +259,14 @@ 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>;
+export declare const criteriaTreeOptionsSchema: z.ZodObject<{
+    criteriaTreeElementTextFormat: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    criteriaTreeElementTextFormat: string;
+}, {
+    criteriaTreeElementTextFormat: string;
+}>;
+export declare const treeResultSchema: z.ZodIntersection<z.ZodObject<{
     text: z.ZodOptional<z.ZodString>;
     total: z.ZodOptional<z.ZodNumber>;
     maximumValue: z.ZodOptional<z.ZodNumber>;
@@ -237,21 +274,35 @@ export declare const treeResultSchema: z.ZodObject<{
     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;
-}>;
+}>, z.ZodUnion<[z.ZodObject<{
+    type: z.ZodOptional<z.ZodEnum<["number", "percentage"]>>;
+    value: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    type?: "number" | "percentage" | undefined;
+    value?: number | undefined;
+}, {
+    type?: "number" | "percentage" | undefined;
+    value?: number | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"boolean">;
+    value: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    type: "boolean";
+    value?: boolean | undefined;
+}, {
+    type: "boolean";
+    value?: boolean | undefined;
+}>]>>;

package/dist/v1/schemas/common.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.treeResultSchema = exports.documentTreeOptionsSchema = exports.breadcrumbOptionsSchema = exports.abstractElementSchema = exports.criteriaTreeElementTypeSchema = exports.elementDataSchema = exports.taskItemValueSchema = exports.taskItemScalarValueSchema = exports.colorSchema = void 0;
+exports.treeResultSchema = exports.criteriaTreeOptionsSchema = 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
@@ -9,8 +9,8 @@ exports.colorSchema = zod_1.z
     zod_1.z.object({
         red: zod_1.z.number().describe("Red component (0-255)"),
         green: zod_1.z.number().describe("Green component (0-255)"),
-        blue: zod_1.z.number().describe("Blue component (0-255)"),
-    }),
+        blue: zod_1.z.number().describe("Blue component (0-255)")
+    })
 ])
     .describe("Color");
 // These are not "common" and are task-item specific, but generate a circular dependency if moved to task-item.ts
@@ -22,11 +22,6 @@ exports.taskItemValueSchema = zod_1.z
     .describe("TaskItemValue - Can be either a scalar value or an array of scalar values");
 exports.elementDataSchema = zod_1.z
     .object({
-    type: zod_1.z
-        .enum(["number", "percentage", "boolean"])
-        .optional()
-        .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()
@@ -47,8 +42,20 @@ exports.elementDataSchema = zod_1.z
     exclusiveMinimum: zod_1.z
         .number()
         .optional()
-        .describe("Minimum allowed value (exclusive)"),
+        .describe("Minimum allowed value (exclusive)")
 })
+    .and(zod_1.z.union([zod_1.z.object({
+        type: zod_1.z
+            .enum(["number", "percentage"])
+            .optional()
+            .describe("Type of data"),
+        value: zod_1.z.number().optional().describe("Value of the element"),
+    }), zod_1.z.object({
+        type: zod_1.z
+            .literal('boolean')
+            .describe("Type of data"),
+        value: zod_1.z.boolean().optional().describe("Value of the element"),
+    })]))
     .describe("ElementData - Element data containing value constraints and metadata");
 exports.criteriaTreeElementTypeSchema = zod_1.z
     .enum(["theme", "criterion", "task-group", "task", "task-item"])
@@ -71,7 +78,7 @@ exports.abstractElementSchema = zod_1.z
     sortOrder: zod_1.z
         .number()
         .optional()
-        .describe("Custom sorting position within parent"),
+        .describe("Custom sorting position within parent")
 })
     .describe("AbstractElement - Base schema for all tree elements");
 exports.breadcrumbOptionsSchema = zod_1.z
@@ -79,7 +86,7 @@ exports.breadcrumbOptionsSchema = zod_1.z
     hideFromBreadcrumbs: zod_1.z
         .literal(true)
         .describe("Whether to hide the element from the breadcrumbs"),
-    breadcrumbTextFormat: zod_1.z.never().optional(),
+    breadcrumbTextFormat: zod_1.z.never().optional()
 })
     .or(zod_1.z.object({
     hideFromBreadcrumbs: zod_1.z
@@ -89,14 +96,14 @@ exports.breadcrumbOptionsSchema = zod_1.z
         .describe("Whether to hide the element from the breadcrumbs"),
     breadcrumbTextFormat: zod_1.z
         .string()
-        .describe("The format of the breadcrumb text, use ':code:' and ':title:' to define where the code and/or title should be inserted"),
+        .describe("The format of the breadcrumb text, use ':code:' and ':title:' to define where the code and/or title should be inserted")
 }));
 exports.documentTreeOptionsSchema = zod_1.z
     .object({
     hideFromDocumentTree: zod_1.z
         .literal(true)
         .describe("Whether to hide the element from the document tree folder structure"),
-    documentTreeFolderTextFormat: zod_1.z.never().optional(),
+    documentTreeFolderTextFormat: zod_1.z.never().optional()
 })
     .or(zod_1.z.object({
     hideFromDocumentTree: zod_1.z
@@ -105,6 +112,12 @@ exports.documentTreeOptionsSchema = zod_1.z
         .describe("Whether to hide the element from the document tree folder structure"),
     documentTreeFolderTextFormat: 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"),
+        .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');
+exports.criteriaTreeOptionsSchema = zod_1.z
+    .object({
+    criteriaTreeElementTextFormat: zod_1.z
+        .string()
+        .describe("The format of the criteria tree element 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");