@openframe-org/criteria-set-protocol 2.0.9-alpha.0 → 2.0.11

package/dist/services/i-versioned.service.d.ts

@@ -0,0 +1,16 @@
+import { ProtocolVersionServiceMap } from '../types';
+/**
+ * Interface for versioned services
+ *
+ * Services that implement this interface can be managed by the VersionsService
+ */
+export interface IVersionedService {
+    /**
+     * The SemVer version of the service
+     */
+    version: string;
+    /**
+     * Whether the service supports the given protocol version
+     */
+    supportsProtocol: <ProtocolVersion extends number>(protocolVersion: ProtocolVersion) => this is ProtocolVersionServiceMap<ProtocolVersion>;
+}

package/dist/services/i-versioned.service.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/services/index.d.ts

@@ -0,0 +1,2 @@
+export * from './i-versioned.service';
+export * from './versions.service';

package/dist/services/index.js

@@ -0,0 +1,18 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./i-versioned.service"), exports);
+__exportStar(require("./versions.service"), exports);

package/dist/services/versions.service.d.ts

@@ -0,0 +1,38 @@
+import { IVersionedService } from './i-versioned.service';
+import { ProtocolVersionServiceMap } from '../types';
+/**
+ * Service for managing versions of services
+ *
+ * The VersionsService class is a utility class for services which implement different versions of the protocol, and different versions of their
+ * own service. For example, say you have a v1service, v11service, v2service and v21service with versions 1.0, 1.1, 2.0 and 2.1 respectively.
+ * The VersionsService class can be used to manage these services:
+ *
+ * const versionsService = new VersionsService([v1service, v11service, v2service, v21service]);
+ * versionsService.getLatestVersion(); // v21service
+ * versionsService.getServiceVersions(1); // [v1service, v11service]
+ * versionsService.getServiceVersions(2); // [v2service, v21service]
+ * versionsService.get('1.1'); // v11service
+ */
+export declare class VersionsService {
+    protected versions: IVersionedService[];
+    /**
+     * @param versions An array of services implementing IVersionedService
+     */
+    constructor(versions: IVersionedService[]);
+    /**
+     * Get all services
+     */
+    getAll(): IVersionedService[];
+    /**
+     * Retrieve the services which are compatible with the requested protocol version
+     */
+    getServiceVersions<ProtocolVersion extends number, ProtocolImplementingService = ProtocolVersionServiceMap<ProtocolVersion>>(protocolVersion: ProtocolVersion): ProtocolImplementingService[];
+    /**
+     * Retrieve a service by version
+     */
+    get(version: string): IVersionedService | undefined;
+    /**
+     * Retrieve the latest service
+     */
+    getLatestVersion(): IVersionedService;
+}

package/dist/services/versions.service.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VersionsService = void 0;
+/**
+ * Service for managing versions of services
+ *
+ * The VersionsService class is a utility class for services which implement different versions of the protocol, and different versions of their
+ * own service. For example, say you have a v1service, v11service, v2service and v21service with versions 1.0, 1.1, 2.0 and 2.1 respectively.
+ * The VersionsService class can be used to manage these services:
+ *
+ * const versionsService = new VersionsService([v1service, v11service, v2service, v21service]);
+ * versionsService.getLatestVersion(); // v21service
+ * versionsService.getServiceVersions(1); // [v1service, v11service]
+ * versionsService.getServiceVersions(2); // [v2service, v21service]
+ * versionsService.get('1.1'); // v11service
+ */
+class VersionsService {
+    /**
+     * @param versions An array of services implementing IVersionedService
+     */
+    constructor(versions) {
+        this.versions = versions;
+    }
+    /**
+     * Get all services
+     */
+    getAll() {
+        return this.versions;
+    }
+    /**
+     * Retrieve the services which are compatible with the requested protocol version
+     */
+    getServiceVersions(protocolVersion) {
+        return this.versions.filter((service) => service.supportsProtocol(protocolVersion));
+    }
+    /**
+     * Retrieve a service by version
+     */
+    get(version) {
+        return this.versions.find((service) => service.version === version);
+    }
+    /**
+     * Retrieve the latest service
+     */
+    getLatestVersion() {
+        return this.versions[this.versions.length - 1];
+    }
+}
+exports.VersionsService = VersionsService;

package/dist/types.d.ts

@@ -0,0 +1,2 @@
+import { IProtocolV1Service } from './v1/services/i-protocol-v1.service';
+export type ProtocolVersionServiceMap<Version extends number> = Version extends 1 ? IProtocolV1Service : unknown;

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,10 +1,10 @@
 import { z } from "zod";
 export declare const certificationDefinitionTypeSchema: z.ZodEnum<["number", "percentage"]>;
 export declare const numberBasedCertificationDefinitionRulesSchema: z.ZodObject<{
-    minimum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-    exclusiveMinimum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-    maximum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-    exclusiveMaximum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
+    minimum: z.ZodOptional<z.ZodNumber>;
+    exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
+    maximum: z.ZodOptional<z.ZodNumber>;
+    exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     minimum?: number | undefined;
     maximum?: number | undefined;
@@ -17,10 +17,10 @@ export declare const numberBasedCertificationDefinitionRulesSchema: z.ZodObject<
     exclusiveMinimum?: number | undefined;
 }>;
 export declare const percentageBasedCertificationDefinitionRulesSchema: z.ZodObject<{
-    minimum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-    exclusiveMinimum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-    maximum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-    exclusiveMaximum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
+    minimum: z.ZodOptional<z.ZodNumber>;
+    exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
+    maximum: z.ZodOptional<z.ZodNumber>;
+    exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     minimum?: number | undefined;
     maximum?: number | undefined;
@@ -35,17 +35,17 @@ export declare const percentageBasedCertificationDefinitionRulesSchema: z.ZodObj
 export declare const numberBasedCertificationDefinitionSchema: z.ZodObject<z.objectUtil.extendShape<{
     type: z.ZodEnum<["number", "percentage"]>;
     code: z.ZodString;
-    icon: z.ZodOptional<z.ZodType<string, z.ZodTypeDef, string>>;
+    icon: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
-    description: z.ZodOptional<z.ZodType<string, z.ZodTypeDef, string>>;
+    description: z.ZodOptional<z.ZodString>;
     rulesText: z.ZodString;
 }, {
     type: z.ZodLiteral<"number">;
     rules: z.ZodObject<{
-        minimum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-        exclusiveMinimum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-        maximum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-        exclusiveMaximum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
+        minimum: z.ZodOptional<z.ZodNumber>;
+        exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
+        maximum: z.ZodOptional<z.ZodNumber>;
+        exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
         minimum?: number | undefined;
         maximum?: number | undefined;
@@ -58,9 +58,9 @@ export declare const numberBasedCertificationDefinitionSchema: z.ZodObject<z.obj
         exclusiveMinimum?: number | undefined;
     }>;
 }>, "strip", z.ZodTypeAny, {
+    type: "number";
     code: string;
     name: string;
-    type: "number";
     rulesText: string;
     rules: {
         minimum?: number | undefined;
@@ -71,9 +71,9 @@ export declare const numberBasedCertificationDefinitionSchema: z.ZodObject<z.obj
     description?: string | undefined;
     icon?: string | undefined;
 }, {
+    type: "number";
     code: string;
     name: string;
-    type: "number";
     rulesText: string;
     rules: {
         minimum?: number | undefined;
@@ -87,17 +87,17 @@ export declare const numberBasedCertificationDefinitionSchema: z.ZodObject<z.obj
 export declare const percentageBasedCertificationDefinitionSchema: z.ZodObject<z.objectUtil.extendShape<{
     type: z.ZodEnum<["number", "percentage"]>;
     code: z.ZodString;
-    icon: z.ZodOptional<z.ZodType<string, z.ZodTypeDef, string>>;
+    icon: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
-    description: z.ZodOptional<z.ZodType<string, z.ZodTypeDef, string>>;
+    description: z.ZodOptional<z.ZodString>;
     rulesText: z.ZodString;
 }, {
     type: z.ZodLiteral<"percentage">;
     rules: z.ZodObject<{
-        minimum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-        exclusiveMinimum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-        maximum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-        exclusiveMaximum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
+        minimum: z.ZodOptional<z.ZodNumber>;
+        exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
+        maximum: z.ZodOptional<z.ZodNumber>;
+        exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
         minimum?: number | undefined;
         maximum?: number | undefined;
@@ -110,9 +110,9 @@ export declare const percentageBasedCertificationDefinitionSchema: z.ZodObject<z
         exclusiveMinimum?: number | undefined;
     }>;
 }>, "strip", z.ZodTypeAny, {
+    type: "percentage";
     code: string;
     name: string;
-    type: "percentage";
     rulesText: string;
     rules: {
         minimum?: number | undefined;
@@ -123,9 +123,9 @@ export declare const percentageBasedCertificationDefinitionSchema: z.ZodObject<z
     description?: string | undefined;
     icon?: string | undefined;
 }, {
+    type: "percentage";
     code: string;
     name: string;
-    type: "percentage";
     rulesText: string;
     rules: {
         minimum?: number | undefined;
@@ -139,17 +139,17 @@ export declare const percentageBasedCertificationDefinitionSchema: z.ZodObject<z
 export declare const certificationDefinitionSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<z.objectUtil.extendShape<{
     type: z.ZodEnum<["number", "percentage"]>;
     code: z.ZodString;
-    icon: z.ZodOptional<z.ZodType<string, z.ZodTypeDef, string>>;
+    icon: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
-    description: z.ZodOptional<z.ZodType<string, z.ZodTypeDef, string>>;
+    description: z.ZodOptional<z.ZodString>;
     rulesText: z.ZodString;
 }, {
     type: z.ZodLiteral<"number">;
     rules: z.ZodObject<{
-        minimum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-        exclusiveMinimum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-        maximum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-        exclusiveMaximum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
+        minimum: z.ZodOptional<z.ZodNumber>;
+        exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
+        maximum: z.ZodOptional<z.ZodNumber>;
+        exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
         minimum?: number | undefined;
         maximum?: number | undefined;
@@ -162,9 +162,9 @@ export declare const certificationDefinitionSchema: z.ZodDiscriminatedUnion<"typ
         exclusiveMinimum?: number | undefined;
     }>;
 }>, "strip", z.ZodTypeAny, {
+    type: "number";
     code: string;
     name: string;
-    type: "number";
     rulesText: string;
     rules: {
         minimum?: number | undefined;
@@ -175,9 +175,9 @@ export declare const certificationDefinitionSchema: z.ZodDiscriminatedUnion<"typ
     description?: string | undefined;
     icon?: string | undefined;
 }, {
+    type: "number";
     code: string;
     name: string;
-    type: "number";
     rulesText: string;
     rules: {
         minimum?: number | undefined;
@@ -190,17 +190,17 @@ export declare const certificationDefinitionSchema: z.ZodDiscriminatedUnion<"typ
 }>, z.ZodObject<z.objectUtil.extendShape<{
     type: z.ZodEnum<["number", "percentage"]>;
     code: z.ZodString;
-    icon: z.ZodOptional<z.ZodType<string, z.ZodTypeDef, string>>;
+    icon: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
-    description: z.ZodOptional<z.ZodType<string, z.ZodTypeDef, string>>;
+    description: z.ZodOptional<z.ZodString>;
     rulesText: z.ZodString;
 }, {
     type: z.ZodLiteral<"percentage">;
     rules: z.ZodObject<{
-        minimum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-        exclusiveMinimum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-        maximum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-        exclusiveMaximum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
+        minimum: z.ZodOptional<z.ZodNumber>;
+        exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
+        maximum: z.ZodOptional<z.ZodNumber>;
+        exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
     }, "strip", z.ZodTypeAny, {
         minimum?: number | undefined;
         maximum?: number | undefined;
@@ -213,9 +213,9 @@ export declare const certificationDefinitionSchema: z.ZodDiscriminatedUnion<"typ
         exclusiveMinimum?: number | undefined;
     }>;
 }>, "strip", z.ZodTypeAny, {
+    type: "percentage";
     code: string;
     name: string;
-    type: "percentage";
     rulesText: string;
     rules: {
         minimum?: number | undefined;
@@ -226,9 +226,9 @@ export declare const certificationDefinitionSchema: z.ZodDiscriminatedUnion<"typ
     description?: string | undefined;
     icon?: string | undefined;
 }, {
+    type: "percentage";
     code: string;
     name: string;
-    type: "percentage";
     rulesText: string;
     rules: {
         minimum?: number | undefined;

package/dist/v1/schemas/certification.js

@@ -2,24 +2,23 @@
 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");
-const utils_1 = require("./utils");
 exports.certificationDefinitionTypeSchema = zod_1.z.enum([
     "number",
     "percentage",
 ]);
 exports.numberBasedCertificationDefinitionRulesSchema = zod_1.z.object({
-    minimum: (0, utils_1.optional)(zod_1.z.number()),
-    exclusiveMinimum: (0, utils_1.optional)(zod_1.z.number()),
-    maximum: (0, utils_1.optional)(zod_1.z.number()),
-    exclusiveMaximum: (0, utils_1.optional)(zod_1.z.number()),
+    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: (0, utils_1.optional)(zod_1.z.string()),
+    icon: zod_1.z.string().optional(),
     name: zod_1.z.string(),
-    description: (0, utils_1.optional)(zod_1.z.string()),
+    description: zod_1.z.string().optional(),
     rulesText: zod_1.z.string(),
 });
 exports.numberBasedCertificationDefinitionSchema = abstractCertificationDefinitionSchema.extend({

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

@@ -15,16 +15,16 @@ export declare const colorSchema: z.ZodUnion<[z.ZodString, z.ZodObject<{
 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 elementDataSchema: z.ZodObject<{
-    type: z.ZodOptional<z.ZodType<"number" | "percentage", z.ZodTypeDef, "number" | "percentage">>;
-    value: z.ZodOptional<z.ZodType<string | number | boolean | (string | number | boolean | null)[] | null, z.ZodTypeDef, string | number | boolean | (string | number | boolean | null)[] | null>>;
-    text: z.ZodOptional<z.ZodType<string, z.ZodTypeDef, string>>;
-    maximumValue: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-    minimumValue: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-    exclusiveMaximum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-    exclusiveMinimum: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-    step: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-    total: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
-    readOnly: z.ZodOptional<z.ZodType<boolean, z.ZodTypeDef, boolean>>;
+    type: z.ZodOptional<z.ZodEnum<["percentage", "number"]>>;
+    value: z.ZodOptional<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">]>>;
+    text: z.ZodOptional<z.ZodString>;
+    maximumValue: z.ZodOptional<z.ZodNumber>;
+    minimumValue: z.ZodOptional<z.ZodNumber>;
+    exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
+    exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
+    step: z.ZodOptional<z.ZodNumber>;
+    total: z.ZodOptional<z.ZodNumber>;
+    readOnly: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     type?: "number" | "percentage" | undefined;
     total?: number | undefined;
@@ -53,37 +53,68 @@ export declare const abstractElementSchema: z.ZodObject<{
     type: z.ZodEnum<["theme", "criterion", "task-group", "task", "task-item"]>;
     title: z.ZodString;
     code: z.ZodString;
-    tags: z.ZodOptional<z.ZodType<string[], z.ZodTypeDef, string[]>>;
-    documentation: z.ZodOptional<z.ZodType<({
+    tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    documentation: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<"type", [z.ZodObject<z.objectUtil.extendShape<{
+        type: z.ZodEnum<["pdf", "text", "link"]>;
+        label: z.ZodString;
+        text: z.ZodString;
+    }, {
+        type: z.ZodLiteral<"pdf">;
+        url: z.ZodString;
+    }>, "strip", z.ZodTypeAny, {
         type: "pdf";
         url: string;
         label: string;
         text: string;
-    } | {
-        type: "text";
-        label: string;
-        text: string;
-    } | {
-        type: "link";
+    }, {
+        type: "pdf";
         url: string;
         label: string;
         text: string;
-    })[], z.ZodTypeDef, ({
-        type: "pdf";
-        url: string;
+    }>, z.ZodObject<z.objectUtil.extendShape<{
+        type: z.ZodEnum<["pdf", "text", "link"]>;
+        label: z.ZodString;
+        text: z.ZodString;
+    }, {
+        type: z.ZodLiteral<"text">;
+    }>, "strip", z.ZodTypeAny, {
+        type: "text";
         label: string;
         text: string;
-    } | {
+    }, {
         type: "text";
         label: string;
         text: string;
-    } | {
+    }>, z.ZodObject<z.objectUtil.extendShape<{
+        type: z.ZodEnum<["pdf", "text", "link"]>;
+        label: z.ZodString;
+        text: z.ZodString;
+    }, {
+        type: z.ZodLiteral<"link">;
+        url: z.ZodString;
+    }>, "strip", z.ZodTypeAny, {
+        type: "link";
+        url: string;
+        label: string;
+        text: string;
+    }, {
         type: "link";
         url: string;
         label: string;
         text: string;
-    })[]>>;
-    data: z.ZodOptional<z.ZodType<{
+    }>]>, "many">>;
+    data: z.ZodOptional<z.ZodObject<{
+        type: z.ZodOptional<z.ZodEnum<["percentage", "number"]>>;
+        value: z.ZodOptional<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">]>>;
+        text: z.ZodOptional<z.ZodString>;
+        maximumValue: z.ZodOptional<z.ZodNumber>;
+        minimumValue: z.ZodOptional<z.ZodNumber>;
+        exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
+        exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
+        step: z.ZodOptional<z.ZodNumber>;
+        total: z.ZodOptional<z.ZodNumber>;
+        readOnly: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
         type?: "number" | "percentage" | undefined;
         total?: number | undefined;
         value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
@@ -94,7 +125,7 @@ export declare const abstractElementSchema: z.ZodObject<{
         exclusiveMinimum?: number | undefined;
         step?: number | undefined;
         readOnly?: boolean | undefined;
-    }, z.ZodTypeDef, {
+    }, {
         type?: "number" | "percentage" | undefined;
         total?: number | undefined;
         value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
@@ -106,10 +137,10 @@ export declare const abstractElementSchema: z.ZodObject<{
         step?: number | undefined;
         readOnly?: boolean | undefined;
     }>>;
-    sortOrder: z.ZodOptional<z.ZodType<number, z.ZodTypeDef, number>>;
+    sortOrder: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
-    code: string;
     type: "theme" | "criterion" | "task-group" | "task" | "task-item";
+    code: string;
     title: string;
     data?: {
         type?: "number" | "percentage" | undefined;
@@ -141,8 +172,8 @@ export declare const abstractElementSchema: z.ZodObject<{
     })[] | undefined;
     sortOrder?: number | undefined;
 }, {
-    code: string;
     type: "theme" | "criterion" | "task-group" | "task" | "task-item";
+    code: string;
     title: string;
     data?: {
         type?: "number" | "percentage" | undefined;

package/dist/v1/schemas/common.js

@@ -3,7 +3,6 @@ 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");
-const utils_1 = require("./utils");
 exports.colorSchema = zod_1.z.union([
     zod_1.z.string(),
     zod_1.z.object({
@@ -24,16 +23,16 @@ exports.taskItemValueSchema = zod_1.z.union([
     zod_1.z.array(exports.taskItemScalarValueSchema),
 ]);
 exports.elementDataSchema = zod_1.z.object({
-    type: (0, utils_1.optional)(zod_1.z.enum(["percentage", "number"])),
-    value: (0, utils_1.optional)(exports.taskItemValueSchema),
-    text: (0, utils_1.optional)(zod_1.z.string()),
-    maximumValue: (0, utils_1.optional)(zod_1.z.number()),
-    minimumValue: (0, utils_1.optional)(zod_1.z.number()),
-    exclusiveMaximum: (0, utils_1.optional)(zod_1.z.number()),
-    exclusiveMinimum: (0, utils_1.optional)(zod_1.z.number()),
-    step: (0, utils_1.optional)(zod_1.z.number()),
-    total: (0, utils_1.optional)(zod_1.z.number()),
-    readOnly: (0, utils_1.optional)(zod_1.z.boolean()),
+    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",
@@ -46,8 +45,8 @@ exports.abstractElementSchema = zod_1.z.object({
     type: exports.criteriaTreeElementTypeSchema,
     title: zod_1.z.string(),
     code: zod_1.z.string(),
-    tags: (0, utils_1.optional)(zod_1.z.array(zod_1.z.string())),
-    documentation: (0, utils_1.optional)(zod_1.z.array(documentation_1.documentationItemSchema)),
-    data: (0, utils_1.optional)(exports.elementDataSchema),
-    sortOrder: (0, utils_1.optional)(zod_1.z.number()),
+    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(),
 });

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

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+/**
+ * Validates the criteriaSetId parameter for endpoints which use it
+ */
+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

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.criteriaSetIdParamSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Validates the criteriaSetId parameter for endpoints which use it
+ */
+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')
+});