@openframe-org/criteria-set-protocol 2.5.0 → 3.0.0-alpha.1

package/dist/v1/schemas/task-item.js

@@ -9,16 +9,16 @@ exports.taskItemValueMapSchema = zod_1.z
 exports.pointOptionSchema = zod_1.z.object({
     id: zod_1.z
         .string()
-        .optional()
+        .nullable()
         .describe("Optional unique identifier for the point option"),
     text: zod_1.z.string().describe("Display text for the point option"),
     intro: zod_1.z
         .string()
-        .optional()
+        .nullable()
         .describe("Optional introductory text for the point option"),
     outro: zod_1.z
         .string()
-        .optional()
+        .nullable()
         .describe("Optional concluding text for the point option"),
     value: zod_1.z
         .union([zod_1.z.string(), zod_1.z.number(), zod_1.z.boolean(), zod_1.z.null()])
@@ -28,10 +28,10 @@ const abstractDefinitionSchema = zod_1.z.object({
     type: zod_1.z
         .enum(["select-single", "select-multiple", "number", "boolean"])
         .describe("The type of task item definition"),
-    label: zod_1.z.string().optional().describe("Optional label for the task item"),
+    label: zod_1.z.string().nullable().describe("Optional label for the task item"),
     readOnly: zod_1.z
         .boolean()
-        .optional()
+        .nullable()
         .describe("Whether the task item is read-only"),
 });
 exports.selectSingleTypeSchema = abstractDefinitionSchema.extend({
@@ -40,16 +40,16 @@ exports.selectSingleTypeSchema = abstractDefinitionSchema.extend({
         .describe("Indicates a single-selection type task item"),
     minimum: zod_1.z
         .number()
-        .optional()
+        .nullable()
         .describe("Minimum value, used when treating this task item as an interpolation"),
     maximum: zod_1.z
         .number()
-        .optional()
+        .nullable()
         .describe("Maximum value, used when treating this task item as an interpolation"),
     options: zod_1.z
         .array(exports.pointOptionSchema)
         .describe("Available options for selection"),
-    defaultValue: zod_1.z.string().optional().describe("Default selected value"),
+    defaultValue: zod_1.z.string().nullable().describe("Default selected value"),
 });
 exports.selectMultipleTypeSchema = abstractDefinitionSchema.extend({
     type: zod_1.z
@@ -57,29 +57,29 @@ exports.selectMultipleTypeSchema = abstractDefinitionSchema.extend({
         .describe("Indicates a multiple-selection type task item"),
     minimum: zod_1.z
         .number()
-        .optional()
+        .nullable()
         .describe("Minimum value, used when treating this task item as an interpolation"),
     maximum: zod_1.z
         .number()
-        .optional()
+        .nullable()
         .describe("Maximum value, used when treating this task item as an interpolation"),
     options: zod_1.z
         .array(exports.pointOptionSchema)
         .describe("Available options for selection"),
     defaultValue: zod_1.z
         .array(zod_1.z.string())
-        .optional()
+        .nullable()
         .describe("Default selected values"),
 });
 exports.numberTypeSchema = abstractDefinitionSchema.extend({
     type: zod_1.z
         .literal("number")
-        .optional()
+        .nullable()
         .describe("Indicates a numeric type task item"),
-    minimum: zod_1.z.number().optional().describe("Minimum allowed value"),
-    maximum: zod_1.z.number().optional().describe("Maximum allowed value"),
-    step: zod_1.z.number().optional().describe("Step size for numeric input"),
-    defaultValue: zod_1.z.number().optional().describe("Default numeric value"),
+    minimum: zod_1.z.number().nullable().describe("Minimum allowed value"),
+    maximum: zod_1.z.number().nullable().describe("Maximum allowed value"),
+    step: zod_1.z.number().nullable().describe("Step size for numeric input"),
+    defaultValue: zod_1.z.number().nullable().describe("Default numeric value"),
 });
 exports.booleanTypeSchema = abstractDefinitionSchema.extend({
     type: zod_1.z.literal("boolean").describe("Indicates a boolean type task item"),
@@ -88,9 +88,9 @@ exports.booleanTypeSchema = abstractDefinitionSchema.extend({
         true: zod_1.z.string().describe("Label for the true value"),
         false: zod_1.z.string().describe("Label for the false value"),
     })
-        .optional()
+        .nullable()
         .describe("Custom labels for boolean values"),
-    defaultValue: zod_1.z.boolean().optional().describe("Default boolean value"),
+    defaultValue: zod_1.z.boolean().nullable().describe("Default boolean value"),
 });
 exports.taskItemDefinitionSchema = zod_1.z
     .discriminatedUnion("type", [
@@ -104,10 +104,10 @@ exports.taskItemDataSchema = common_1.elementDataSchema
     .and(zod_1.z.object({
     readOnly: zod_1.z
         .boolean()
-        .optional()
+        .nullable()
         .describe("Whether the element value can be modified"),
     valueReference: common_1.taskItemValueSchema
-        .optional()
+        .nullable()
         .describe("Reference to a task item value"),
 }))
     .describe("TaskItemData - The data associated with a task item");
@@ -115,7 +115,7 @@ exports.taskItemOptionsSchema = zod_1.z
     .object({
     excludeFromTargets: zod_1.z
         .boolean()
-        .optional()
+        .nullable()
         .describe("Whether to exclude this task item from the targets page altogether"),
 })
     .describe("TaskItemOptions - Options for configuring the display and behavior of a task item");
@@ -126,12 +126,12 @@ exports.taskItemSchema = common_1.abstractElementSchema
         .literal("task-item")
         .describe("Identifies the schema type as a task item"),
     data: exports.taskItemDataSchema
-        .optional()
+        .nullable()
         .describe("Additional data associated with the task item"),
     definition: exports.taskItemDefinitionSchema.describe("The definition that specifies the type and behavior of the task item"),
     description: zod_1.z
         .string()
-        .optional()
+        .nullable()
         .describe("Additional detailed description of the task item"),
     options: exports.taskItemOptionsSchema.describe("Configuration options for the task item display and behavior"),
 });

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

@@ -2,18 +2,18 @@ import { z } from "zod";
 export declare const taskOptionsSchema: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
     breadcrumbTextFormat: z.ZodString;
     documentTreeFolderTextFormat: z.ZodString;
-    showCodeAsIndicatorTaskViewTitle: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    showCodeAsIndicatorTaskViewTitle: z.ZodDefault<z.ZodNullable<z.ZodBoolean>>;
 }, z.core.$strip>, z.ZodObject<{
     criteriaTreeElementTextFormat: z.ZodString;
 }, z.core.$strip>>, z.ZodObject<{
-    reportTitleTextFormat: z.ZodOptional<z.ZodString>;
+    reportTitleTextFormat: z.ZodNullable<z.ZodString>;
 }, z.core.$strip>>;
 export declare const taskSchema: z.ZodObject<{
     title: z.ZodString;
     longFormTitle: z.ZodString;
     code: z.ZodString;
-    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    documentation: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+    tags: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    documentation: z.ZodNullable<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
         label: z.ZodString;
         text: z.ZodString;
         type: z.ZodLiteral<"pdf">;
@@ -28,28 +28,28 @@ export declare const taskSchema: z.ZodObject<{
         type: z.ZodLiteral<"link">;
         url: z.ZodString;
     }, z.core.$strip>], "type">>>;
-    data: z.ZodOptional<z.ZodObject<{
-        type: z.ZodOptional<z.ZodEnum<{
+    data: z.ZodNullable<z.ZodObject<{
+        type: z.ZodNullable<z.ZodEnum<{
             number: "number";
             boolean: "boolean";
             percentage: "percentage";
         }>>;
-        value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
-        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>;
-        weight: z.ZodOptional<z.ZodNumber>;
+        value: z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
+        text: z.ZodNullable<z.ZodString>;
+        total: z.ZodNullable<z.ZodNumber>;
+        maximumValue: z.ZodNullable<z.ZodNumber>;
+        minimumValue: z.ZodNullable<z.ZodNumber>;
+        exclusiveMaximum: z.ZodNullable<z.ZodNumber>;
+        exclusiveMinimum: z.ZodNullable<z.ZodNumber>;
+        weight: z.ZodNullable<z.ZodNumber>;
     }, z.core.$catchall<z.ZodAny>>>;
-    sortOrder: z.ZodOptional<z.ZodNumber>;
+    sortOrder: z.ZodNullable<z.ZodNumber>;
     type: z.ZodLiteral<"task">;
-    description: z.ZodOptional<z.ZodString>;
+    description: z.ZodNullable<z.ZodString>;
     items: z.ZodArray<z.ZodLazy<z.ZodObject<{
         code: z.ZodString;
-        tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
-        documentation: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+        tags: z.ZodNullable<z.ZodArray<z.ZodString>>;
+        documentation: z.ZodNullable<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
             label: z.ZodString;
             text: z.ZodString;
             type: z.ZodLiteral<"pdf">;
@@ -64,84 +64,84 @@ export declare const taskSchema: z.ZodObject<{
             type: z.ZodLiteral<"link">;
             url: z.ZodString;
         }, z.core.$strip>], "type">>>;
-        sortOrder: z.ZodOptional<z.ZodNumber>;
+        sortOrder: z.ZodNullable<z.ZodNumber>;
         type: z.ZodLiteral<"task-item">;
-        data: z.ZodOptional<z.ZodIntersection<z.ZodObject<{
-            type: z.ZodOptional<z.ZodEnum<{
+        data: z.ZodNullable<z.ZodIntersection<z.ZodObject<{
+            type: z.ZodNullable<z.ZodEnum<{
                 number: "number";
                 boolean: "boolean";
                 percentage: "percentage";
             }>>;
-            value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
-            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>;
-            weight: z.ZodOptional<z.ZodNumber>;
+            value: z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
+            text: z.ZodNullable<z.ZodString>;
+            total: z.ZodNullable<z.ZodNumber>;
+            maximumValue: z.ZodNullable<z.ZodNumber>;
+            minimumValue: z.ZodNullable<z.ZodNumber>;
+            exclusiveMaximum: z.ZodNullable<z.ZodNumber>;
+            exclusiveMinimum: z.ZodNullable<z.ZodNumber>;
+            weight: z.ZodNullable<z.ZodNumber>;
         }, z.core.$catchall<z.ZodAny>>, z.ZodObject<{
-            readOnly: z.ZodOptional<z.ZodBoolean>;
-            valueReference: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>;
+            readOnly: z.ZodNullable<z.ZodBoolean>;
+            valueReference: z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>;
         }, z.core.$strip>>>;
         definition: z.ZodDiscriminatedUnion<[z.ZodObject<{
-            label: z.ZodOptional<z.ZodString>;
-            readOnly: z.ZodOptional<z.ZodBoolean>;
+            label: z.ZodNullable<z.ZodString>;
+            readOnly: z.ZodNullable<z.ZodBoolean>;
             type: z.ZodLiteral<"select-single">;
-            minimum: z.ZodOptional<z.ZodNumber>;
-            maximum: z.ZodOptional<z.ZodNumber>;
+            minimum: z.ZodNullable<z.ZodNumber>;
+            maximum: z.ZodNullable<z.ZodNumber>;
             options: z.ZodArray<z.ZodObject<{
-                id: z.ZodOptional<z.ZodString>;
+                id: z.ZodNullable<z.ZodString>;
                 text: z.ZodString;
-                intro: z.ZodOptional<z.ZodString>;
-                outro: z.ZodOptional<z.ZodString>;
+                intro: z.ZodNullable<z.ZodString>;
+                outro: z.ZodNullable<z.ZodString>;
                 value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>;
             }, z.core.$strip>>;
-            defaultValue: z.ZodOptional<z.ZodString>;
+            defaultValue: z.ZodNullable<z.ZodString>;
         }, z.core.$strip>, z.ZodObject<{
-            label: z.ZodOptional<z.ZodString>;
-            readOnly: z.ZodOptional<z.ZodBoolean>;
+            label: z.ZodNullable<z.ZodString>;
+            readOnly: z.ZodNullable<z.ZodBoolean>;
             type: z.ZodLiteral<"select-multiple">;
-            minimum: z.ZodOptional<z.ZodNumber>;
-            maximum: z.ZodOptional<z.ZodNumber>;
+            minimum: z.ZodNullable<z.ZodNumber>;
+            maximum: z.ZodNullable<z.ZodNumber>;
             options: z.ZodArray<z.ZodObject<{
-                id: z.ZodOptional<z.ZodString>;
+                id: z.ZodNullable<z.ZodString>;
                 text: z.ZodString;
-                intro: z.ZodOptional<z.ZodString>;
-                outro: z.ZodOptional<z.ZodString>;
+                intro: z.ZodNullable<z.ZodString>;
+                outro: z.ZodNullable<z.ZodString>;
                 value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>;
             }, z.core.$strip>>;
-            defaultValue: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            defaultValue: z.ZodNullable<z.ZodArray<z.ZodString>>;
         }, z.core.$strip>, z.ZodObject<{
-            label: z.ZodOptional<z.ZodString>;
-            readOnly: z.ZodOptional<z.ZodBoolean>;
-            type: z.ZodOptional<z.ZodLiteral<"number">>;
-            minimum: z.ZodOptional<z.ZodNumber>;
-            maximum: z.ZodOptional<z.ZodNumber>;
-            step: z.ZodOptional<z.ZodNumber>;
-            defaultValue: z.ZodOptional<z.ZodNumber>;
+            label: z.ZodNullable<z.ZodString>;
+            readOnly: z.ZodNullable<z.ZodBoolean>;
+            type: z.ZodNullable<z.ZodLiteral<"number">>;
+            minimum: z.ZodNullable<z.ZodNumber>;
+            maximum: z.ZodNullable<z.ZodNumber>;
+            step: z.ZodNullable<z.ZodNumber>;
+            defaultValue: z.ZodNullable<z.ZodNumber>;
         }, z.core.$strip>, z.ZodObject<{
-            label: z.ZodOptional<z.ZodString>;
-            readOnly: z.ZodOptional<z.ZodBoolean>;
+            label: z.ZodNullable<z.ZodString>;
+            readOnly: z.ZodNullable<z.ZodBoolean>;
             type: z.ZodLiteral<"boolean">;
-            labels: z.ZodOptional<z.ZodObject<{
+            labels: z.ZodNullable<z.ZodObject<{
                 true: z.ZodString;
                 false: z.ZodString;
             }, z.core.$strip>>;
-            defaultValue: z.ZodOptional<z.ZodBoolean>;
+            defaultValue: z.ZodNullable<z.ZodBoolean>;
         }, z.core.$strip>], "type">;
-        description: z.ZodOptional<z.ZodString>;
+        description: z.ZodNullable<z.ZodString>;
         options: z.ZodObject<{
-            excludeFromTargets: z.ZodOptional<z.ZodBoolean>;
+            excludeFromTargets: z.ZodNullable<z.ZodBoolean>;
         }, z.core.$strip>;
     }, z.core.$strip>>>;
     options: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
         breadcrumbTextFormat: z.ZodString;
         documentTreeFolderTextFormat: z.ZodString;
-        showCodeAsIndicatorTaskViewTitle: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        showCodeAsIndicatorTaskViewTitle: z.ZodDefault<z.ZodNullable<z.ZodBoolean>>;
     }, z.core.$strip>, z.ZodObject<{
         criteriaTreeElementTextFormat: z.ZodString;
     }, z.core.$strip>>, z.ZodObject<{
-        reportTitleTextFormat: z.ZodOptional<z.ZodString>;
+        reportTitleTextFormat: z.ZodNullable<z.ZodString>;
     }, z.core.$strip>>;
 }, z.core.$strip>;

package/dist/v1/schemas/task.js

@@ -14,7 +14,7 @@ exports.taskOptionsSchema = zod_1.z
         .describe("The format of the document tree folder text, use ':code:' and ':title:' to define where the code and/or title should be inserted"),
     showCodeAsIndicatorTaskViewTitle: zod_1.z
         .boolean()
-        .optional()
+        .nullable()
         .default(false)
         .describe("Whether the title of the indicator task view should show the task code, or the hardcoded description text"),
 })
@@ -25,7 +25,7 @@ exports.taskSchema = common_1.abstractElementSchema.extend({
     type: zod_1.z.literal("task").describe("Identifies the schema type as a task"),
     description: zod_1.z
         .string()
-        .optional()
+        .nullable()
         .describe("Additional detailed description of the task"),
     items: zod_1.z
         .array(zod_1.z.lazy(() => task_item_1.taskItemSchema))