@openframe-org/criteria-set-protocol 2.1.4 → 2.1.6

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

@@ -52,7 +52,7 @@ export declare const criteriaTreeElementTypeSchema: z.ZodEnum<["theme", "criteri
 export declare const abstractElementSchema: z.ZodObject<{
     type: z.ZodEnum<["theme", "criterion", "task-group", "task", "task-item"]>;
     title: z.ZodString;
-    longFormTitle: z.ZodOptional<z.ZodString>;
+    longFormTitle: z.ZodString;
     code: z.ZodString;
     tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     documentation: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
@@ -140,6 +140,7 @@ export declare const abstractElementSchema: z.ZodObject<{
     code: string;
     type: "theme" | "criterion" | "task-group" | "task" | "task-item";
     title: string;
+    longFormTitle: string;
     data?: {
         type?: "number" | "percentage" | undefined;
         total?: number | undefined;
@@ -152,7 +153,6 @@ export declare const abstractElementSchema: z.ZodObject<{
         step?: number | undefined;
         readOnly?: boolean | undefined;
     } | undefined;
-    longFormTitle?: string | undefined;
     tags?: string[] | undefined;
     documentation?: ({
         type: "pdf";
@@ -174,6 +174,7 @@ export declare const abstractElementSchema: z.ZodObject<{
     code: string;
     type: "theme" | "criterion" | "task-group" | "task" | "task-item";
     title: string;
+    longFormTitle: string;
     data?: {
         type?: "number" | "percentage" | undefined;
         total?: number | undefined;
@@ -186,7 +187,6 @@ export declare const abstractElementSchema: z.ZodObject<{
         step?: number | undefined;
         readOnly?: boolean | undefined;
     } | undefined;
-    longFormTitle?: string | undefined;
     tags?: string[] | undefined;
     documentation?: ({
         type: "pdf";
@@ -205,3 +205,41 @@ export declare const abstractElementSchema: z.ZodObject<{
     })[] | undefined;
     sortOrder?: number | undefined;
 }>;
+export declare const breadcrumbOptionsSchema: z.ZodUnion<[z.ZodObject<{
+    hideFromBreadcrumbs: z.ZodLiteral<true>;
+    breadcrumbTextFormat: z.ZodOptional<z.ZodNever>;
+}, "strip", z.ZodTypeAny, {
+    hideFromBreadcrumbs: true;
+    breadcrumbTextFormat?: undefined;
+}, {
+    hideFromBreadcrumbs: true;
+    breadcrumbTextFormat?: undefined;
+}>, z.ZodObject<{
+    hideFromBreadcrumbs: z.ZodDefault<z.ZodOptional<z.ZodLiteral<false>>>;
+    breadcrumbTextFormat: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    hideFromBreadcrumbs: false;
+    breadcrumbTextFormat: string;
+}, {
+    breadcrumbTextFormat: string;
+    hideFromBreadcrumbs?: false | undefined;
+}>]>;
+export declare const documentTreeOptionsSchema: z.ZodUnion<[z.ZodObject<{
+    hideFromDocumentTree: z.ZodLiteral<true>;
+    documentTreeFolderTextFormat: z.ZodOptional<z.ZodNever>;
+}, "strip", z.ZodTypeAny, {
+    hideFromDocumentTree: true;
+    documentTreeFolderTextFormat?: undefined;
+}, {
+    hideFromDocumentTree: true;
+    documentTreeFolderTextFormat?: undefined;
+}>, z.ZodObject<{
+    hideFromDocumentTree: z.ZodOptional<z.ZodLiteral<false>>;
+    documentTreeFolderTextFormat: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    documentTreeFolderTextFormat: string;
+    hideFromDocumentTree?: false | undefined;
+}, {
+    documentTreeFolderTextFormat: string;
+    hideFromDocumentTree?: false | undefined;
+}>]>;

package/dist/v1/schemas/common.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.abstractElementSchema = exports.criteriaTreeElementTypeSchema = exports.elementDataSchema = exports.taskItemValueSchema = exports.taskItemScalarValueSchema = exports.colorSchema = void 0;
+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
@@ -67,7 +67,6 @@ exports.abstractElementSchema = zod_1.z
     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
@@ -85,3 +84,36 @@ exports.abstractElementSchema = zod_1.z
         .describe("Custom sorting position within parent"),
 })
     .describe("AbstractElement - Base schema for all tree elements");
+exports.breadcrumbOptionsSchema = zod_1.z
+    .object({
+    hideFromBreadcrumbs: zod_1.z
+        .literal(true)
+        .describe("Whether to hide the element from the breadcrumbs"),
+    breadcrumbTextFormat: zod_1.z.never().optional(),
+})
+    .or(zod_1.z.object({
+    hideFromBreadcrumbs: zod_1.z
+        .literal(false)
+        .optional()
+        .default(false)
+        .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"),
+}));
+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(),
+})
+    .or(zod_1.z.object({
+    hideFromDocumentTree: zod_1.z
+        .literal(false)
+        .optional()
+        .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"),
+}));

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

@@ -2,9 +2,9 @@ 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<{
-    dashboardRenderingType: z.ZodOptional<z.ZodString>;
+    dashboardRenderingType: z.ZodEnum<["per-criteria", "per-task"]>;
 }, "strip", z.ZodTypeAny, {
-    dashboardRenderingType?: string | undefined;
+    dashboardRenderingType: "per-criteria" | "per-task";
 }, {
-    dashboardRenderingType?: string | undefined;
+    dashboardRenderingType: "per-criteria" | "per-task";
 }>;

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

@@ -9,9 +9,7 @@ exports.DASHBOARD_CATEGORY_LISTING_TYPES = [
 exports.dashboardCategoryListingTypeSchema = zod_1.z.enum(exports.DASHBOARD_CATEGORY_LISTING_TYPES);
 exports.criteriaSetOptionsSchema = zod_1.z
     .object({
-    dashboardRenderingType: zod_1.z
-        .string()
-        .optional()
+    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");