@openframe-org/criteria-set-protocol 1.4.9 → 1.5.1

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

@@ -0,0 +1,400 @@
+import { z } from 'zod';
+export declare const taskSchema: z.ZodObject<{
+    type: z.ZodLiteral<"task">;
+    title: z.ZodString;
+    code: z.ZodString;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    documentation: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"pdf">;
+        label: z.ZodString;
+        url: z.ZodString;
+        text: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "pdf";
+        url: string;
+        label: string;
+        text: string;
+    }, {
+        type: "pdf";
+        url: string;
+        label: string;
+        text: string;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"text">;
+        label: z.ZodString;
+        text: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "text";
+        label: string;
+        text: string;
+    }, {
+        type: "text";
+        label: string;
+        text: string;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"link">;
+        label: z.ZodString;
+        url: z.ZodString;
+        text: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "link";
+        url: string;
+        label: string;
+        text: string;
+    }, {
+        type: "link";
+        url: string;
+        label: string;
+        text: string;
+    }>]>, "many">>;
+    data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    sortOrder: z.ZodOptional<z.ZodNumber>;
+    description: z.ZodOptional<z.ZodString>;
+    items: z.ZodArray<z.ZodObject<{
+        type: z.ZodLiteral<"task-item">;
+        code: z.ZodString;
+        tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        documentation: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"pdf">;
+            label: z.ZodString;
+            url: z.ZodString;
+            text: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: "pdf";
+            url: string;
+            label: string;
+            text: string;
+        }, {
+            type: "pdf";
+            url: string;
+            label: string;
+            text: string;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"text">;
+            label: z.ZodString;
+            text: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: "text";
+            label: string;
+            text: string;
+        }, {
+            type: "text";
+            label: string;
+            text: string;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"link">;
+            label: z.ZodString;
+            url: z.ZodString;
+            text: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: "link";
+            url: string;
+            label: string;
+            text: string;
+        }, {
+            type: "link";
+            url: string;
+            label: string;
+            text: string;
+        }>]>, "many">>;
+        data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        sortOrder: z.ZodOptional<z.ZodNumber>;
+        definition: z.ZodUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"select-single">;
+            options: z.ZodArray<z.ZodObject<{
+                id: z.ZodOptional<z.ZodString>;
+                text: z.ZodString;
+                intro: z.ZodOptional<z.ZodString>;
+                outro: z.ZodOptional<z.ZodString>;
+                value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>;
+            }, "strip", z.ZodTypeAny, {
+                value: string | number | boolean | null;
+                text: string;
+                id?: string | undefined;
+                intro?: string | undefined;
+                outro?: string | undefined;
+            }, {
+                value: string | number | boolean | null;
+                text: string;
+                id?: string | undefined;
+                intro?: string | undefined;
+                outro?: string | undefined;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            type: "select-single";
+            options: {
+                value: string | number | boolean | null;
+                text: string;
+                id?: string | undefined;
+                intro?: string | undefined;
+                outro?: string | undefined;
+            }[];
+        }, {
+            type: "select-single";
+            options: {
+                value: string | number | boolean | null;
+                text: string;
+                id?: string | undefined;
+                intro?: string | undefined;
+                outro?: string | undefined;
+            }[];
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"select-multiple">;
+            options: z.ZodArray<z.ZodObject<{
+                id: z.ZodOptional<z.ZodString>;
+                text: z.ZodString;
+                intro: z.ZodOptional<z.ZodString>;
+                outro: z.ZodOptional<z.ZodString>;
+                value: z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>;
+            }, "strip", z.ZodTypeAny, {
+                value: string | number | boolean | null;
+                text: string;
+                id?: string | undefined;
+                intro?: string | undefined;
+                outro?: string | undefined;
+            }, {
+                value: string | number | boolean | null;
+                text: string;
+                id?: string | undefined;
+                intro?: string | undefined;
+                outro?: string | undefined;
+            }>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            type: "select-multiple";
+            options: {
+                value: string | number | boolean | null;
+                text: string;
+                id?: string | undefined;
+                intro?: string | undefined;
+                outro?: string | undefined;
+            }[];
+        }, {
+            type: "select-multiple";
+            options: {
+                value: string | number | boolean | null;
+                text: string;
+                id?: string | undefined;
+                intro?: string | undefined;
+                outro?: string | undefined;
+            }[];
+        }>]>;
+        description: z.ZodOptional<z.ZodString>;
+        providedData: z.ZodOptional<z.ZodRecord<z.ZodString, 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">]>>>;
+    }, "strip", z.ZodTypeAny, {
+        type: "task-item";
+        code: string;
+        definition: {
+            type: "select-single";
+            options: {
+                value: string | number | boolean | null;
+                text: string;
+                id?: string | undefined;
+                intro?: string | undefined;
+                outro?: string | undefined;
+            }[];
+        } | {
+            type: "select-multiple";
+            options: {
+                value: string | number | boolean | null;
+                text: string;
+                id?: string | undefined;
+                intro?: string | undefined;
+                outro?: string | undefined;
+            }[];
+        };
+        data?: Record<string, string> | undefined;
+        description?: string | undefined;
+        tags?: string[] | undefined;
+        documentation?: ({
+            type: "pdf";
+            url: string;
+            label: string;
+            text: string;
+        } | {
+            type: "text";
+            label: string;
+            text: string;
+        } | {
+            type: "link";
+            url: string;
+            label: string;
+            text: string;
+        })[] | undefined;
+        sortOrder?: number | undefined;
+        providedData?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
+    }, {
+        type: "task-item";
+        code: string;
+        definition: {
+            type: "select-single";
+            options: {
+                value: string | number | boolean | null;
+                text: string;
+                id?: string | undefined;
+                intro?: string | undefined;
+                outro?: string | undefined;
+            }[];
+        } | {
+            type: "select-multiple";
+            options: {
+                value: string | number | boolean | null;
+                text: string;
+                id?: string | undefined;
+                intro?: string | undefined;
+                outro?: string | undefined;
+            }[];
+        };
+        data?: Record<string, string> | undefined;
+        description?: string | undefined;
+        tags?: string[] | undefined;
+        documentation?: ({
+            type: "pdf";
+            url: string;
+            label: string;
+            text: string;
+        } | {
+            type: "text";
+            label: string;
+            text: string;
+        } | {
+            type: "link";
+            url: string;
+            label: string;
+            text: string;
+        })[] | undefined;
+        sortOrder?: number | undefined;
+        providedData?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    type: "task";
+    code: string;
+    title: string;
+    items: {
+        type: "task-item";
+        code: string;
+        definition: {
+            type: "select-single";
+            options: {
+                value: string | number | boolean | null;
+                text: string;
+                id?: string | undefined;
+                intro?: string | undefined;
+                outro?: string | undefined;
+            }[];
+        } | {
+            type: "select-multiple";
+            options: {
+                value: string | number | boolean | null;
+                text: string;
+                id?: string | undefined;
+                intro?: string | undefined;
+                outro?: string | undefined;
+            }[];
+        };
+        data?: Record<string, string> | undefined;
+        description?: string | undefined;
+        tags?: string[] | undefined;
+        documentation?: ({
+            type: "pdf";
+            url: string;
+            label: string;
+            text: string;
+        } | {
+            type: "text";
+            label: string;
+            text: string;
+        } | {
+            type: "link";
+            url: string;
+            label: string;
+            text: string;
+        })[] | undefined;
+        sortOrder?: number | undefined;
+        providedData?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
+    }[];
+    data?: Record<string, any> | undefined;
+    description?: string | undefined;
+    tags?: string[] | undefined;
+    documentation?: ({
+        type: "pdf";
+        url: string;
+        label: string;
+        text: string;
+    } | {
+        type: "text";
+        label: string;
+        text: string;
+    } | {
+        type: "link";
+        url: string;
+        label: string;
+        text: string;
+    })[] | undefined;
+    sortOrder?: number | undefined;
+}, {
+    type: "task";
+    code: string;
+    title: string;
+    items: {
+        type: "task-item";
+        code: string;
+        definition: {
+            type: "select-single";
+            options: {
+                value: string | number | boolean | null;
+                text: string;
+                id?: string | undefined;
+                intro?: string | undefined;
+                outro?: string | undefined;
+            }[];
+        } | {
+            type: "select-multiple";
+            options: {
+                value: string | number | boolean | null;
+                text: string;
+                id?: string | undefined;
+                intro?: string | undefined;
+                outro?: string | undefined;
+            }[];
+        };
+        data?: Record<string, string> | undefined;
+        description?: string | undefined;
+        tags?: string[] | undefined;
+        documentation?: ({
+            type: "pdf";
+            url: string;
+            label: string;
+            text: string;
+        } | {
+            type: "text";
+            label: string;
+            text: string;
+        } | {
+            type: "link";
+            url: string;
+            label: string;
+            text: string;
+        })[] | undefined;
+        sortOrder?: number | undefined;
+        providedData?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
+    }[];
+    data?: Record<string, any> | undefined;
+    description?: string | undefined;
+    tags?: string[] | undefined;
+    documentation?: ({
+        type: "pdf";
+        url: string;
+        label: string;
+        text: string;
+    } | {
+        type: "text";
+        label: string;
+        text: string;
+    } | {
+        type: "link";
+        url: string;
+        label: string;
+        text: string;
+    })[] | undefined;
+    sortOrder?: number | undefined;
+}>;

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,17 @@
+import { z } from 'zod';
+/**
+ * Validates the request body for the tree and data endpoints
+ */
+export declare const treeAndDataBodySchema: z.ZodOptional<z.ZodObject<{
+    locale: z.ZodOptional<z.ZodString>;
+    parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    values: z.ZodOptional<z.ZodRecord<z.ZodString, 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">]>>>;
+}, "strip", z.ZodTypeAny, {
+    values?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
+    locale?: string | undefined;
+    parameters?: Record<string, string> | undefined;
+}, {
+    values?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
+    locale?: string | undefined;
+    parameters?: Record<string, string> | 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.9",
+  "version": "1.5.1",
   "description": "A protocol and tools for defining and working with criteria sets",
   "private": false,
   "author": "Andrés Angulo <aa@openframe.org>",
@@ -15,7 +15,7 @@
   ],
   "dependencies": {
     "@types/node": "^20.6.3",
-    "yup": "^1.2.0"
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "typescript": "^5.2.2"