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

package/dist/v1/schemas/theme.js

@@ -4,17 +4,59 @@ exports.themeSchema = exports.themeOptionsSchema = exports.themeStyleSchema = vo
 const zod_1 = require("zod");
 const criterion_1 = require("./criterion");
 const common_1 = require("./common");
-exports.themeStyleSchema = zod_1.z.object({
-    primaryColor: common_1.colorSchema,
-    secondaryColor: common_1.colorSchema,
-});
-exports.themeOptionsSchema = zod_1.z.object({
-    hideCode: zod_1.z.boolean().optional(),
-    hideFromHierarchy: zod_1.z.boolean().optional(),
-});
-exports.themeSchema = common_1.abstractElementSchema.extend({
-    type: zod_1.z.literal("theme"),
-    style: exports.themeStyleSchema.optional(),
-    items: zod_1.z.array(criterion_1.criterionSchema),
-    options: exports.themeOptionsSchema.optional(),
-});
+exports.themeStyleSchema = zod_1.z
+    .object({
+    primaryColor: common_1.colorSchema.describe("The primary color used for theme styling"),
+    secondaryColor: common_1.colorSchema.describe("The secondary color used for theme styling"),
+})
+    .describe("ThemeStyle - Style configuration for the theme's visual appearance");
+exports.themeOptionsSchema = zod_1.z
+    .object({
+    /**
+     * @deprecated use breadcrumbTextFormat instead, where breadcrumbTextFormat = hideCode === true ? ':code:' : ':title:'
+     */
+    hideCode: zod_1.z
+        .boolean()
+        .optional()
+        .describe(`Deprecated. Use breadcrumbTextFormat instead, where breadcrumbTextFormat = hideCode === true ? ':code:' : ':title:'`),
+    /**
+     * @deprecated use hideFromBreadcrumbs, hideFromDocumentTree and hideCodeInReport instead
+     */
+    hideFromHierarchy: zod_1.z
+        .boolean()
+        .optional()
+        .describe("Deprecated. Use hideFromBreadcrumbs, hideFromDocumentTree and hideCodeInReport instead"),
+    breadcrumbTextFormat: zod_1.z
+        .string()
+        .optional()
+        .default(":title:")
+        .describe("The format of the breadcrumb text, use ':code:' and ':title:' to define where the code and/or title should be inserted"),
+    hideFromBreadcrumbs: zod_1.z
+        .boolean()
+        .optional()
+        .default(false)
+        .describe("Whether to hide the theme from the breadcrumbs"),
+    hideFromDocumentTree: zod_1.z
+        .boolean()
+        .optional()
+        .default(false)
+        .describe("Whether to hide the theme from the document tree structure"),
+    hideCodeInReport: zod_1.z
+        .boolean()
+        .optional()
+        .default(false)
+        .describe("Whether to hide the theme code in the generated PDF report"),
+})
+    .describe("Configuration options for theme display and behavior");
+exports.themeSchema = common_1.abstractElementSchema
+    .extend({
+    type: zod_1.z.literal("theme").describe("Identifies the schema type as a theme"),
+    style: exports.themeStyleSchema
+        .optional()
+        .describe("Visual styling configuration for the theme"),
+    items: zod_1.z.array(criterion_1.criterionSchema).describe("The criteria in this theme"),
+    options: exports.themeOptionsSchema
+        .optional()
+        .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/types/criteria.d.ts

@@ -1,5 +1,5 @@
 import { z } from "zod";
-import { booleanTypeSchema, certificationDefinitionSchema, certificationDefinitionTypeSchema, criteriaTreeElementSchema, criteriaTreeElementTypeSchema, criteriaTreeSchema, criterionSchema, dataMapSchema, metadataSchema, numberBasedCertificationDefinitionRulesSchema, numberBasedCertificationDefinitionSchema, numberTypeSchema, percentageBasedCertificationDefinitionRulesSchema, percentageBasedCertificationDefinitionSchema, pointOptionSchema, schemaDefinitionSchema, schemaDefinitionsSchema, selectMultipleTypeSchema, selectSingleTypeSchema, taskGroupSchema, taskItemDataSchema, taskItemDefinitionSchema, taskItemScalarValueSchema, taskItemSchema, taskItemValueMapSchema, taskItemValueSchema, taskSchema, colorSchema, elementDataSchema, themeOptionsSchema, themeSchema, themeStyleSchema, documentationItemSchema, inlineDocumentationItemSchema, linkDocumentationItemSchema, pdfDocumentationItemSchema, criteriaSetsAndVersionsSchema, taskGroupOptionsSchema, criterionOptionsSchema, taskOptionsSchema, taskItemOptionsSchema, criteriaSetOptionsSchema } from "../schemas";
+import { booleanTypeSchema, certificationDefinitionSchema, certificationDefinitionTypeSchema, criteriaTreeElementSchema, criteriaTreeElementTypeSchema, criteriaTreeSchema, criterionSchema, dataMapSchema, metadataSchema, numberBasedCertificationDefinitionRulesSchema, numberBasedCertificationDefinitionSchema, numberTypeSchema, percentageBasedCertificationDefinitionRulesSchema, percentageBasedCertificationDefinitionSchema, pointOptionSchema, schemaDefinitionSchema, schemaDefinitionsSchema, selectMultipleTypeSchema, selectSingleTypeSchema, taskGroupSchema, taskItemDataSchema, taskItemDefinitionSchema, taskItemScalarValueSchema, taskItemSchema, taskItemValueMapSchema, taskItemValueSchema, taskSchema, colorSchema, elementDataSchema, themeOptionsSchema, themeSchema, themeStyleSchema, documentationItemSchema, inlineDocumentationItemSchema, linkDocumentationItemSchema, pdfDocumentationItemSchema, criteriaSetsAndVersionsSchema, taskGroupOptionsSchema, criterionOptionsSchema, taskOptionsSchema, taskItemOptionsSchema, criteriaSetOptionsSchema, dashboardCategoryListingTypeSchema } from "../schemas";
 export type CertificationDefinitionType = z.infer<typeof certificationDefinitionTypeSchema>;
 export type NumberBasedCertificationDefinitionRules = z.infer<typeof numberBasedCertificationDefinitionRulesSchema>;
 export type PercentageBasedCertificationDefinitionRules = z.infer<typeof percentageBasedCertificationDefinitionRulesSchema>;
@@ -42,3 +42,4 @@ export type CriteriaTreeElementType = z.infer<typeof criteriaTreeElementTypeSche
 export type DataMap = z.infer<typeof dataMapSchema>;
 export type CriteriaSetsAndVersions = z.infer<typeof criteriaSetsAndVersionsSchema>;
 export type CriteriaSetOptions = z.infer<typeof criteriaSetOptionsSchema>;
+export type DashboardCategoryListingType = z.infer<typeof dashboardCategoryListingTypeSchema>;

package/dist/v1/utils.d.ts

@@ -8,14 +8,6 @@ export declare const isTaskItem: (element: CriteriaTreeElement) => element is Ta
  * Convert a color object to a hex string
  */
 export declare const toColorHexString: (color: Color) => string;
-/**
- * Check if a tree element should be hidden in the output
- */
-export declare const shouldHideCode: (element: Pick<CriteriaTreeElement, "options">) => boolean;
-/**
- * Get the qualified name of a tree element, which is the title with the code prepended if it is different
- */
-export declare const getQualifiedName: (element: Pick<Exclude<CriteriaTreeElement, TaskItem>, "code" | "title" | "options">) => string;
 /**
  * Find an element in the criteria tree by its code
  */

package/dist/v1/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findInTree = exports.getQualifiedName = exports.shouldHideCode = exports.toColorHexString = exports.isTaskItem = exports.isTask = exports.isTaskGroup = exports.isCriterion = exports.isTheme = void 0;
+exports.findInTree = exports.toColorHexString = exports.isTaskItem = exports.isTask = exports.isTaskGroup = exports.isCriterion = exports.isTheme = void 0;
 const isTheme = (element) => element.type === "theme";
 exports.isTheme = isTheme;
 const isCriterion = (element) => element.type === "criterion";
@@ -21,24 +21,6 @@ const toColorHexString = (color) => {
     return `#${color.red.toString(16)}${color.green.toString(16)}${color.blue.toString(16)}`;
 };
 exports.toColorHexString = toColorHexString;
-/**
- * Check if a tree element should be hidden in the output
- */
-const shouldHideCode = (element) => {
-    var _a;
-    return !!((_a = element.options) === null || _a === void 0 ? void 0 : _a.hideCode);
-};
-exports.shouldHideCode = shouldHideCode;
-/**
- * Get the qualified name of a tree element, which is the title with the code prepended if it is different
- */
-const getQualifiedName = (element) => {
-    if (element.title === element.code || (0, exports.shouldHideCode)(element)) {
-        return element.title;
-    }
-    return `${element.code} ${element.title}`;
-};
-exports.getQualifiedName = getQualifiedName;
 /**
  * Find an element in the criteria tree by its code
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openframe-org/criteria-set-protocol",
-  "version": "2.0.28",
+  "version": "2.1.0",
   "description": "A protocol and tools for defining and working with criteria sets",
   "private": false,
   "author": "Andrés Angulo <aa@openframe.org>",
@@ -11,7 +11,8 @@
     "prepublishOnly": "tsc",
     "tc": "tsc --noEmit",
     "format": "prettier --check .",
-    "format:write": "prettier --write ."
+    "format:write": "prettier --write .",
+    "dependency-test": "madge --circular --extensions ts ./"
   },
   "engines": {
     "node": ">=22",
@@ -21,12 +22,13 @@
     "dist/**/*"
   ],
   "dependencies": {
-    "@types/node": "^22.8.4",
-    "zod": "^3.24.1"
+    "@types/node": "^22.15.21",
+    "zod": "^3.25.23"
   },
   "devDependencies": {
-    "prettier": "^3.4.2",
-    "typescript": "^5.7.3"
+    "prettier": "^3.5.3",
+    "typescript": "^5.8.3",
+    "madge": "^8.0.0"
   },
   "publishConfig": {
     "access": "public",