@openframe-org/criteria-set-protocol 1.4.8 → 1.5.0

package/dist/v1/schemas/criteria-set-id-param-schema.d.ts

@@ -1,13 +1,11 @@
-import * as yup from 'yup';
+import { z } from 'zod';
 /**
  * Validates the criteriaSetId parameter for endpoints which use it
  */
-export declare const criteriaSetIdParamSchema: yup.ObjectSchema<{
-    params: {
-        criteriaSetId: string;
-    };
-}, yup.AnyObject, {
-    params: {
-        criteriaSetId: undefined;
-    };
-}, "">;
+export declare const criteriaSetIdParamSchema: z.ZodObject<{
+    criteriaSetId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    criteriaSetId: string;
+}, {
+    criteriaSetId: string;
+}>;

package/dist/v1/schemas/criteria-set-id-param-schema.js

@@ -1,37 +1,11 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.criteriaSetIdParamSchema = void 0;
-const yup = __importStar(require("yup"));
+const zod_1 = require("zod");
 /**
  * Validates the criteriaSetId parameter for endpoints which use it
  */
-exports.criteriaSetIdParamSchema = yup.object({
-    params: yup.object({
-        criteriaSetId: yup.string()
-            .matches(/^[a-zA-Z0-9.\-_]+$/, 'Criteria set ID must contain only full stops, alphanumeric characters, dashes and underscores')
-            .required()
-    })
+exports.criteriaSetIdParamSchema = zod_1.z.object({
+    criteriaSetId: zod_1.z.string()
+        .regex(/^[a-zA-Z0-9.\-_]+$/, 'Criteria set ID must contain only full stops, alphanumeric characters, dashes and underscores')
 });

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

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+import { Criterion } from '../types';
+export declare const criterionSchema: z.Schema<Criterion>;

package/dist/v1/schemas/criterion.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.criterionSchema = void 0;
+const zod_1 = require("zod");
+const task_item_1 = require("./task-item");
+const task_group_1 = require("./task-group");
+exports.criterionSchema = zod_1.z.object({
+    type: zod_1.z.literal('criterion'),
+    title: zod_1.z.string(),
+    code: zod_1.z.string(),
+    tags: zod_1.z.array(zod_1.z.string()).optional(),
+    documentation: zod_1.z.array(task_item_1.documentationItemSchema).optional(),
+    data: zod_1.z.record(zod_1.z.any()).optional(),
+    sortOrder: zod_1.z.number().optional(),
+    items: zod_1.z.array(task_group_1.taskGroupSchema)
+});

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

@@ -1,4 +1,9 @@
 export * from './criteria-set-id-param-schema';
-export * from './tree-body-schema';
+export * from './tree-and-data-body-schema';
 export * from './matrix-body-schema';
 export * from './version-param-schema';
+export * from './quality';
+export * from './task-group';
+export * from './criterion';
+export * from './task';
+export * from './task-item';

package/dist/v1/schemas/index.js

@@ -15,6 +15,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./criteria-set-id-param-schema"), exports);
-__exportStar(require("./tree-body-schema"), exports);
+__exportStar(require("./tree-and-data-body-schema"), exports);
 __exportStar(require("./matrix-body-schema"), exports);
 __exportStar(require("./version-param-schema"), exports);
+__exportStar(require("./quality"), exports);
+__exportStar(require("./task-group"), exports);
+__exportStar(require("./criterion"), exports);
+__exportStar(require("./task"), exports);
+__exportStar(require("./task-item"), exports);

package/dist/v1/schemas/matrix-body-schema.d.ts

@@ -1,19 +1,6 @@
-import * as yup from 'yup';
+import { z } from 'zod';
+import { MatrixRequestBody } from '../types';
 /**
  * Validates the request body for the matrix endpoints
  */
-export declare const matrixBodySchema: yup.ObjectSchema<{
-    body: {
-        values?: {} | undefined;
-        locale?: string | undefined;
-        parameters?: {} | undefined;
-        additional?: {} | undefined;
-    } | undefined;
-}, yup.AnyObject, {
-    body: {
-        locale: undefined;
-        parameters: {};
-        values: {};
-        additional: undefined;
-    };
-}, "">;
+export declare const matrixBodySchema: z.Schema<MatrixRequestBody | undefined>;

package/dist/v1/schemas/matrix-body-schema.js

@@ -1,38 +1,14 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.matrixBodySchema = void 0;
-const yup = __importStar(require("yup"));
+const zod_1 = require("zod");
+const task_item_1 = require("./task-item");
 /**
  * Validates the request body for the matrix endpoints
  */
-exports.matrixBodySchema = yup.object({
-    body: yup.object({
-        locale: yup.string().optional(),
-        parameters: yup.object().optional(),
-        values: yup.object().optional(),
-        additional: yup.mixed().optional()
-    }).optional()
-});
+exports.matrixBodySchema = zod_1.z.object({
+    locale: zod_1.z.string().optional(),
+    parameters: zod_1.z.record(zod_1.z.string()).optional(),
+    values: task_item_1.taskItemValueMapSchema.optional(),
+    additional: zod_1.z.any().optional()
+}).optional();

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

@@ -0,0 +1,5 @@
+import { z } from 'zod';
+import { Color, Quality, QualityStyle } from '../types';
+export declare const colorSchema: z.Schema<Color>;
+export declare const qualityStyleSchema: z.Schema<QualityStyle>;
+export declare const qualitySchema: z.Schema<Quality>;

package/dist/v1/schemas/quality.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.qualitySchema = exports.qualityStyleSchema = exports.colorSchema = void 0;
+const zod_1 = require("zod");
+const task_item_1 = require("./task-item");
+const criterion_1 = require("./criterion");
+exports.colorSchema = zod_1.z.union([
+    zod_1.z.string(),
+    zod_1.z.object({
+        red: zod_1.z.number(),
+        green: zod_1.z.number(),
+        blue: zod_1.z.number()
+    })
+]);
+exports.qualityStyleSchema = zod_1.z.object({
+    primaryColor: exports.colorSchema,
+    secondaryColor: exports.colorSchema
+});
+exports.qualitySchema = zod_1.z.object({
+    type: zod_1.z.literal('quality'),
+    title: zod_1.z.string(),
+    code: zod_1.z.string(),
+    tags: zod_1.z.array(zod_1.z.string()).optional(),
+    documentation: zod_1.z.array(task_item_1.documentationItemSchema).optional(),
+    data: zod_1.z.record(zod_1.z.any()).optional(),
+    sortOrder: zod_1.z.number().optional(),
+    style: exports.qualityStyleSchema.optional(),
+    items: zod_1.z.array(criterion_1.criterionSchema)
+});

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

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+import { TaskGroup } from '../types';
+export declare const taskGroupSchema: z.Schema<TaskGroup>;

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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taskGroupSchema = void 0;
+const zod_1 = require("zod");
+const task_item_1 = require("./task-item");
+const task_1 = require("./task");
+exports.taskGroupSchema = zod_1.z.object({
+    type: zod_1.z.literal('task-group'),
+    title: zod_1.z.string(),
+    code: zod_1.z.string(),
+    tags: zod_1.z.array(zod_1.z.string()).optional(),
+    documentation: zod_1.z.array(task_item_1.documentationItemSchema).optional(),
+    data: zod_1.z.record(zod_1.z.any()).optional(),
+    sortOrder: zod_1.z.number().optional(),
+    category: zod_1.z.string().optional(),
+    items: zod_1.z.array(task_1.taskSchema)
+});

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

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+import { BooleanType, DocumentationItem, InlineDocumentationItem, LinkDocumentationItem, NumberType, PdfDocumentationItem, PointOption, SelectMultipleType, SelectSingleType, TaskItem, TaskItemDefinition, TaskItemValueMap } from '../types';
+export declare const pdfDocumentationItem: z.Schema<PdfDocumentationItem>;
+export declare const inlineDocumentationItem: z.Schema<InlineDocumentationItem>;
+export declare const linkDocumentationItem: z.Schema<LinkDocumentationItem>;
+export declare const documentationItemSchema: z.Schema<DocumentationItem>;
+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 taskItemValueMapSchema: z.Schema<TaskItemValueMap>;
+export declare const pointOptionSchema: z.Schema<PointOption>;
+export declare const selectSingleTypeSchema: z.Schema<SelectSingleType>;
+export declare const selectMultipleTypeSchema: z.Schema<SelectMultipleType>;
+export declare const numberTypeSchema: z.Schema<NumberType>;
+export declare const booleanTypeSchema: z.Schema<BooleanType>;
+export declare const taskItemDefinitionSchema: z.Schema<TaskItemDefinition>;
+export declare const taskItemSchema: z.Schema<TaskItem>;

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

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taskItemSchema = exports.taskItemDefinitionSchema = exports.booleanTypeSchema = exports.numberTypeSchema = exports.selectMultipleTypeSchema = exports.selectSingleTypeSchema = exports.pointOptionSchema = exports.taskItemValueMapSchema = exports.taskItemValueSchema = exports.taskItemScalarValueSchema = exports.documentationItemSchema = exports.linkDocumentationItem = exports.inlineDocumentationItem = exports.pdfDocumentationItem = void 0;
+const zod_1 = require("zod");
+exports.pdfDocumentationItem = zod_1.z.object({
+    type: zod_1.z.literal('pdf'),
+    label: zod_1.z.string(),
+    url: zod_1.z.string(),
+    text: zod_1.z.string()
+});
+exports.inlineDocumentationItem = zod_1.z.object({
+    type: zod_1.z.literal('text'),
+    label: zod_1.z.string(),
+    text: zod_1.z.string()
+});
+exports.linkDocumentationItem = zod_1.z.object({
+    type: zod_1.z.literal('link'),
+    label: zod_1.z.string(),
+    url: zod_1.z.string(),
+    text: zod_1.z.string()
+});
+exports.documentationItemSchema = zod_1.z.union([
+    exports.pdfDocumentationItem,
+    exports.inlineDocumentationItem,
+    exports.linkDocumentationItem
+]);
+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.taskItemValueMapSchema = zod_1.z.record(zod_1.z.string(), exports.taskItemValueSchema);
+exports.pointOptionSchema = zod_1.z.object({
+    id: zod_1.z.string().optional(),
+    text: zod_1.z.string(),
+    intro: zod_1.z.string().optional(),
+    outro: zod_1.z.string().optional(),
+    value: exports.taskItemScalarValueSchema
+});
+exports.selectSingleTypeSchema = zod_1.z.object({
+    type: zod_1.z.literal('select-single'),
+    options: zod_1.z.array(exports.pointOptionSchema)
+});
+exports.selectMultipleTypeSchema = zod_1.z.object({
+    type: zod_1.z.literal('select-multiple'),
+    options: zod_1.z.array(exports.pointOptionSchema)
+});
+exports.numberTypeSchema = zod_1.z.object({
+    type: zod_1.z.literal('number'),
+    minimum: zod_1.z.number().optional(),
+    maximum: zod_1.z.number().optional(),
+    step: zod_1.z.number().optional()
+});
+exports.booleanTypeSchema = zod_1.z.object({
+    type: zod_1.z.literal('boolean'),
+    labels: zod_1.z.object({
+        true: zod_1.z.string().optional(),
+        false: zod_1.z.string().optional()
+    }).optional()
+});
+exports.taskItemDefinitionSchema = zod_1.z.union([
+    exports.selectSingleTypeSchema,
+    exports.selectMultipleTypeSchema
+]);
+exports.taskItemSchema = zod_1.z.object({
+    type: zod_1.z.literal('task-item'),
+    code: zod_1.z.string(),
+    tags: zod_1.z.array(zod_1.z.string()).optional(),
+    documentation: zod_1.z.array(exports.documentationItemSchema).optional(),
+    data: zod_1.z.record(zod_1.z.string()).optional(),
+    sortOrder: zod_1.z.number().optional(),
+    definition: exports.taskItemDefinitionSchema,
+    description: zod_1.z.string().optional(),
+    providedData: exports.taskItemValueMapSchema.optional()
+});

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

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+import { Task } from '../types';
+export declare const taskSchema: z.Schema<Task>;

package/dist/v1/schemas/task.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taskSchema = void 0;
+const zod_1 = require("zod");
+const task_item_1 = require("./task-item");
+exports.taskSchema = zod_1.z.object({
+    type: zod_1.z.literal('task'),
+    title: zod_1.z.string(),
+    code: zod_1.z.string(),
+    tags: zod_1.z.array(zod_1.z.string()).optional(),
+    documentation: zod_1.z.array(task_item_1.documentationItemSchema).optional(),
+    data: zod_1.z.record(zod_1.z.any()).optional(),
+    sortOrder: zod_1.z.number().optional(),
+    description: zod_1.z.string().optional(),
+    items: zod_1.z.array(task_item_1.taskItemSchema)
+});

package/dist/v1/schemas/tree-and-data-body-schema.d.ts

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+import { TreeAndDataRequestBody } from '../types';
+/**
+ * Validates the request body for the tree and data endpoints
+ */
+export declare const treeAndDataBodySchema: z.Schema<TreeAndDataRequestBody | undefined>;

package/dist/v1/schemas/tree-and-data-body-schema.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.treeAndDataBodySchema = void 0;
+const zod_1 = require("zod");
+const task_item_1 = require("./task-item");
+/**
+ * Validates the request body for the tree and data endpoints
+ */
+exports.treeAndDataBodySchema = zod_1.z.object({
+    locale: zod_1.z.string().optional(),
+    parameters: zod_1.z.record(zod_1.z.string()).optional(),
+    values: task_item_1.taskItemValueMapSchema.optional()
+}).optional();

package/dist/v1/schemas/version-param-schema.d.ts

@@ -1,13 +1,11 @@
-import * as yup from 'yup';
+import { z } from 'zod';
 /**
  * Validates the version parameter for endpoints which use it
  */
-export declare const versionParamSchema: yup.ObjectSchema<{
-    params: {
-        version: string;
-    };
-}, yup.AnyObject, {
-    params: {
-        version: undefined;
-    };
-}, "">;
+export declare const versionParamSchema: z.ZodObject<{
+    version: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    version: string;
+}, {
+    version: string;
+}>;

package/dist/v1/schemas/version-param-schema.js

@@ -1,37 +1,11 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.versionParamSchema = void 0;
-const yup = __importStar(require("yup"));
+const zod_1 = require("zod");
 /**
  * Validates the version parameter for endpoints which use it
  */
-exports.versionParamSchema = yup.object({
-    params: yup.object({
-        version: yup.string()
-            .matches(/^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$/, 'Service version must be a SemVer-formatted string which includes exclusively a major, minor and patch version')
-            .required()
-    })
+exports.versionParamSchema = zod_1.z.object({
+    version: zod_1.z.string()
+        .regex(/^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)$/, 'Service version must be a SemVer-formatted string which includes exclusively a major, minor and patch version')
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openframe-org/criteria-set-protocol",
-  "version": "1.4.8",
+  "version": "1.5.0",
   "description": "A protocol and tools for defining and working with criteria sets",
   "private": false,
   "author": "Andrés Angulo <aa@openframe.org>",
@@ -14,10 +14,10 @@
     "dist/**/*"
   ],
   "dependencies": {
-    "yup": "^1.2.0"
+    "@types/node": "^20.6.3",
+    "zod": "^3.23.8"
   },
   "devDependencies": {
-    "@types/node": "^20.6.3",
     "typescript": "^5.2.2"
   },
   "publishConfig": {