@openframe-org/criteria-set-protocol 2.0.29 → 2.1.0

package/dist/v1/schemas/certification.js

@@ -2,34 +2,57 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.certificationDefinitionSchema = exports.percentageBasedCertificationDefinitionSchema = exports.numberBasedCertificationDefinitionSchema = exports.percentageBasedCertificationDefinitionRulesSchema = exports.numberBasedCertificationDefinitionRulesSchema = exports.certificationDefinitionTypeSchema = void 0;
 const zod_1 = require("zod");
-exports.certificationDefinitionTypeSchema = zod_1.z.enum([
-    "number",
-    "percentage",
-]);
-exports.numberBasedCertificationDefinitionRulesSchema = zod_1.z.object({
+exports.certificationDefinitionTypeSchema = zod_1.z
+    .enum(["number", "percentage"])
+    .describe("CertificationDefinitionType");
+exports.numberBasedCertificationDefinitionRulesSchema = zod_1.z
+    .object({
     minimum: zod_1.z.number().optional(),
     exclusiveMinimum: zod_1.z.number().optional(),
     maximum: zod_1.z.number().optional(),
     exclusiveMaximum: zod_1.z.number().optional(),
-});
-exports.percentageBasedCertificationDefinitionRulesSchema = exports.numberBasedCertificationDefinitionRulesSchema;
-const abstractCertificationDefinitionSchema = zod_1.z.object({
-    type: exports.certificationDefinitionTypeSchema,
-    code: zod_1.z.string(),
-    icon: zod_1.z.string().optional(),
-    name: zod_1.z.string(),
-    description: zod_1.z.string().optional(),
-    rulesText: zod_1.z.string(),
-});
-exports.numberBasedCertificationDefinitionSchema = abstractCertificationDefinitionSchema.extend({
-    type: zod_1.z.literal("number"),
-    rules: exports.numberBasedCertificationDefinitionRulesSchema,
-});
-exports.percentageBasedCertificationDefinitionSchema = abstractCertificationDefinitionSchema.extend({
-    type: zod_1.z.literal("percentage"),
-    rules: exports.percentageBasedCertificationDefinitionRulesSchema,
-});
-exports.certificationDefinitionSchema = zod_1.z.discriminatedUnion("type", [
+})
+    .describe("NumberBasedCertificationDefinitionRules");
+exports.percentageBasedCertificationDefinitionRulesSchema = exports.numberBasedCertificationDefinitionRulesSchema.describe("PercentageBasedCertificationDefinitionRules");
+const abstractCertificationDefinitionSchema = zod_1.z
+    .object({
+    type: exports.certificationDefinitionTypeSchema.describe("Type of certification definition"),
+    code: zod_1.z
+        .string()
+        .describe("Unique identifier code for the certification, such as 'platinum' or 'ecolabel'"),
+    icon: zod_1.z
+        .string()
+        .optional()
+        .describe("Optional icon URL for the certification"),
+    name: zod_1.z.string().describe("Display name of the certification"),
+    description: zod_1.z
+        .string()
+        .optional()
+        .describe("Optional detailed description of the certification"),
+    rulesText: zod_1.z
+        .string()
+        .describe("Human-readable text describing the certification rules"),
+})
+    .describe("Abstract base schema for certification definitions");
+exports.numberBasedCertificationDefinitionSchema = abstractCertificationDefinitionSchema
+    .extend({
+    type: zod_1.z
+        .literal("number")
+        .describe("Specifies this as a number-based certification"),
+    rules: exports.numberBasedCertificationDefinitionRulesSchema.describe("Rules specific to number-based certification"),
+})
+    .describe("NumberBasedCertificationDefinition");
+exports.percentageBasedCertificationDefinitionSchema = abstractCertificationDefinitionSchema
+    .extend({
+    type: zod_1.z
+        .literal("percentage")
+        .describe("Specifies this as a percentage-based certification"),
+    rules: exports.percentageBasedCertificationDefinitionRulesSchema.describe("Rules specific to percentage-based certification"),
+})
+    .describe("PercentageBasedCertificationDefinition");
+exports.certificationDefinitionSchema = zod_1.z
+    .discriminatedUnion("type", [
     exports.numberBasedCertificationDefinitionSchema,
     exports.percentageBasedCertificationDefinitionSchema,
-]);
+])
+    .describe("CertificationDefinition");

package/dist/v1/schemas/common.js

@@ -3,51 +3,85 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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.union([
-    zod_1.z.string(),
+exports.colorSchema = zod_1.z
+    .union([
+    zod_1.z.string().describe("Hex color string"),
     zod_1.z.object({
-        red: zod_1.z.number(),
-        green: zod_1.z.number(),
-        blue: zod_1.z.number(),
+        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)"),
     }),
-]);
+])
+    .describe("Color");
 // These are not "common" and are task-item specific, but generate a circular dependency if moved to task-item.ts
-exports.taskItemScalarValueSchema = zod_1.z.union([
-    zod_1.z.string(),
-    zod_1.z.number(),
-    zod_1.z.boolean(),
-    zod_1.z.null(),
-]);
-exports.taskItemValueSchema = zod_1.z.union([
-    exports.taskItemScalarValueSchema,
-    zod_1.z.array(exports.taskItemScalarValueSchema),
-]);
-exports.elementDataSchema = zod_1.z.object({
-    type: zod_1.z.enum(["percentage", "number"]).optional(),
-    value: exports.taskItemValueSchema.optional(),
-    text: zod_1.z.string().optional(),
-    maximumValue: zod_1.z.number().optional(),
-    minimumValue: zod_1.z.number().optional(),
-    exclusiveMaximum: zod_1.z.number().optional(),
-    exclusiveMinimum: zod_1.z.number().optional(),
-    step: zod_1.z.number().optional(),
-    total: zod_1.z.number().optional(),
-    readOnly: zod_1.z.boolean().optional(),
-});
-exports.criteriaTreeElementTypeSchema = zod_1.z.enum([
-    "theme",
-    "criterion",
-    "task-group",
-    "task",
-    "task-item",
-]);
-exports.abstractElementSchema = zod_1.z.object({
-    type: exports.criteriaTreeElementTypeSchema,
-    title: zod_1.z.string(),
-    longFormTitle: zod_1.z.string().optional(),
-    code: zod_1.z.string(),
-    tags: zod_1.z.array(zod_1.z.string()).optional(),
-    documentation: zod_1.z.array(documentation_1.documentationItemSchema).optional(),
-    data: exports.elementDataSchema.optional(),
-    sortOrder: zod_1.z.number().optional(),
-});
+exports.taskItemScalarValueSchema = zod_1.z
+    .union([zod_1.z.string(), zod_1.z.number(), zod_1.z.boolean(), zod_1.z.null()])
+    .describe("TaskItemScalarValue - Basic scalar value types that can be used in task items");
+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");
+exports.elementDataSchema = zod_1.z
+    .object({
+    type: zod_1.z
+        .enum(["percentage", "number"])
+        .optional()
+        .describe("Type of numeric data (percentage or number)"),
+    value: exports.taskItemValueSchema.optional().describe("Value of the element"),
+    text: zod_1.z.string().optional().describe("Text representation of the value"),
+    maximumValue: zod_1.z
+        .number()
+        .optional()
+        .describe("Maximum allowed value (inclusive)"),
+    minimumValue: zod_1.z
+        .number()
+        .optional()
+        .describe("Minimum allowed value (inclusive)"),
+    exclusiveMaximum: zod_1.z
+        .number()
+        .optional()
+        .describe("Maximum allowed value (exclusive)"),
+    exclusiveMinimum: zod_1.z
+        .number()
+        .optional()
+        .describe("Minimum allowed value (exclusive)"),
+    step: zod_1.z
+        .number()
+        .optional()
+        .describe("Increment/decrement step size for numeric inputs"),
+    total: zod_1.z
+        .number()
+        .optional()
+        .describe("Total value, understood as 'value'/'total'"),
+    readOnly: zod_1.z
+        .boolean()
+        .optional()
+        .describe("Whether the element value can be modified"),
+})
+    .describe("Element data containing value constraints and metadata");
+exports.criteriaTreeElementTypeSchema = zod_1.z
+    .enum(["theme", "criterion", "task-group", "task", "task-item"])
+    .describe("CriteriaTreeElementType - Types of elements that can exist in the criteria tree hierarchy");
+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()
+        .optional()
+        .describe("Extended or full-length title"),
+    code: zod_1.z.string().describe("Unique identifier code"),
+    tags: zod_1.z
+        .array(zod_1.z.string())
+        .optional()
+        .describe("List of classification tags"),
+    documentation: zod_1.z
+        .array(documentation_1.documentationItemSchema)
+        .optional()
+        .describe("Associated documentation items"),
+    data: exports.elementDataSchema.optional().describe("Element data"),
+    sortOrder: zod_1.z
+        .number()
+        .optional()
+        .describe("Custom sorting position within parent"),
+})
+    .describe("AbstractElement - Base schema for all tree elements");

package/dist/v1/schemas/criteria-set.d.ts

@@ -1,8 +1,16 @@
 import { z } from "zod";
+export declare const DASHBOARD_CATEGORY_LISTING_TYPES: readonly ["per-criteria", "per-task"];
+export declare const dashboardCategoryListingTypeSchema: z.ZodEnum<["per-criteria", "per-task"]>;
 export declare const criteriaSetOptionsSchema: z.ZodObject<{
+    /**
+     * @deprecated Use dashboardRenderingType = renderDetailedViewInDashboard === false ? 'per-criteria' : 'per-task'
+     */
     renderDetailedViewInDashboard: z.ZodOptional<z.ZodBoolean>;
+    dashboardRenderingType: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     renderDetailedViewInDashboard?: boolean | undefined;
+    dashboardRenderingType?: string | undefined;
 }, {
     renderDetailedViewInDashboard?: boolean | undefined;
+    dashboardRenderingType?: string | undefined;
 }>;

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

@@ -1,7 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.criteriaSetOptionsSchema = void 0;
+exports.criteriaSetOptionsSchema = exports.dashboardCategoryListingTypeSchema = exports.DASHBOARD_CATEGORY_LISTING_TYPES = void 0;
 const zod_1 = require("zod");
-exports.criteriaSetOptionsSchema = zod_1.z.object({
-    renderDetailedViewInDashboard: zod_1.z.boolean().optional(),
-});
+exports.DASHBOARD_CATEGORY_LISTING_TYPES = [
+    "per-criteria",
+    "per-task",
+];
+exports.dashboardCategoryListingTypeSchema = zod_1.z.enum(exports.DASHBOARD_CATEGORY_LISTING_TYPES);
+exports.criteriaSetOptionsSchema = zod_1.z
+    .object({
+    /**
+     * @deprecated Use dashboardRenderingType = renderDetailedViewInDashboard === false ? 'per-criteria' : 'per-task'
+     */
+    renderDetailedViewInDashboard: zod_1.z
+        .boolean()
+        .optional()
+        .describe("Deprecated. Use dashboardRenderingType = renderDetailedViewInDashboard === false ? 'per-criteria' : 'per-task'"),
+    dashboardRenderingType: zod_1.z
+        .string()
+        .optional()
+        .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");