@openframe-org/criteria-set-protocol 2.0.13 → 2.0.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openframe-org/criteria-set-protocol",
-  "version": "2.0.13",
+  "version": "2.0.15",
   "description": "A protocol and tools for defining and working with criteria sets",
   "private": false,
   "author": "Andrés Angulo <aa@openframe.org>",
@@ -22,11 +22,11 @@
   ],
   "dependencies": {
     "@types/node": "^22.8.4",
-    "zod": "^3.23.8"
+    "zod": "^3.24.1"
   },
   "devDependencies": {
-    "prettier": "^3.3.3",
-    "typescript": "^5.2.2"
+    "prettier": "^3.4.2",
+    "typescript": "^5.7.3"
   },
   "publishConfig": {
     "access": "public",

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

@@ -1,16 +0,0 @@
-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

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

package/dist/services/index.d.ts

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

package/dist/services/index.js

@@ -1,18 +0,0 @@
-"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

@@ -1,38 +0,0 @@
-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

@@ -1,49 +0,0 @@
-"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

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

package/dist/types.js

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

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

@@ -1,11 +0,0 @@
-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

@@ -1,11 +0,0 @@
-"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')
-});

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

@@ -1,15 +0,0 @@
-import * as yup from 'yup';
-/**
- * Validates the request body for the download matrix endpoints
- */
-export declare const downloadMatrixBodySchema: yup.ObjectSchema<{
-    body: {
-        values: {};
-        parameters: {};
-    };
-}, yup.AnyObject, {
-    body: {
-        parameters: {};
-        values: {};
-    };
-}, "">;

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

@@ -1,36 +0,0 @@
-"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.downloadMatrixBodySchema = void 0;
-const yup = __importStar(require("yup"));
-/**
- * Validates the request body for the download matrix endpoints
- */
-exports.downloadMatrixBodySchema = yup.object({
-    body: yup.object({
-        parameters: yup.object().required(),
-        values: yup.object()
-    })
-});

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

@@ -1,20 +0,0 @@
-import { z } from 'zod';
-/**
- * Validates the request body for the matrix endpoints
- */
-export declare const matrixBodySchema: 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">]>>>;
-    additional: z.ZodOptional<z.ZodAny>;
-}, "strip", z.ZodTypeAny, {
-    values?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
-    locale?: string | undefined;
-    parameters?: Record<string, string> | undefined;
-    additional?: any;
-}, {
-    values?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
-    locale?: string | undefined;
-    parameters?: Record<string, string> | undefined;
-    additional?: any;
-}>>;

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

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.matrixBodySchema = void 0;
-const zod_1 = require("zod");
-const task_item_1 = require("./task-item");
-/**
- * Validates the request body for the matrix endpoints
- */
-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/tree-and-data-body-schema.d.ts

@@ -1,17 +0,0 @@
-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

@@ -1,13 +0,0 @@
-"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/tree-and-matrix-body-schema.d.ts

@@ -1,19 +0,0 @@
-import * as yup from 'yup';
-/**
- * Validates the request body for the tree and matrix endpoints
- */
-export declare const treeAndMatrixBodySchema: yup.ObjectSchema<{
-    body: {
-        values?: {} | undefined;
-        locale?: string | undefined;
-        parameters?: {} | undefined;
-        additional?: {} | undefined;
-    } | undefined;
-}, yup.AnyObject, {
-    body: {
-        locale: undefined;
-        parameters: {};
-        values: {};
-        additional: undefined;
-    };
-}, "">;

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

@@ -1,38 +0,0 @@
-"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.treeAndMatrixBodySchema = void 0;
-const yup = __importStar(require("yup"));
-/**
- * Validates the request body for the tree and matrix endpoints
- */
-exports.treeAndMatrixBodySchema = yup.object({
-    body: yup.object({
-        locale: yup.string().optional(),
-        parameters: yup.object().optional(),
-        values: yup.object().optional(),
-        additional: yup.mixed().optional()
-    }).optional()
-});

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

@@ -1,17 +0,0 @@
-import * as yup from 'yup';
-/**
- * Validates the request body for the tree and data endpoints
- */
-export declare const treeBodySchema: yup.ObjectSchema<{
-    body: {
-        values?: {} | undefined;
-        locale?: string | undefined;
-        parameters?: {} | undefined;
-    } | undefined;
-}, yup.AnyObject, {
-    body: {
-        locale: undefined;
-        parameters: {};
-        values: {};
-    };
-}, "">;

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

@@ -1,37 +0,0 @@
-"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.treeBodySchema = void 0;
-const yup = __importStar(require("yup"));
-/**
- * Validates the request body for the tree and data endpoints
- */
-exports.treeBodySchema = yup.object({
-    body: yup.object({
-        locale: yup.string().optional(),
-        parameters: yup.object().optional(),
-        values: yup.object().optional()
-    }).optional()
-});

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

@@ -1,11 +0,0 @@
-import { z } from 'zod';
-/**
- * Validates the version parameter for endpoints which use it
- */
-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,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.versionParamSchema = void 0;
-const zod_1 = require("zod");
-/**
- * Validates the version parameter for endpoints which use it
- */
-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/dist/v1/services/i-protocol-v1.service.d.ts

@@ -1,26 +0,0 @@
-import { CriteriaTree, StreamMatrixResponse, TaskItemValueMap, Metadata } from '../types';
-/**
- * Interface for services which implement the v1 protocol
- */
-export interface IProtocolV1Service {
-    /**
-     * Specific version of this service, SemVer-formatted
-     */
-    version: string;
-    /**
-     * Get the criteria tree for the given criteria set ID and combination of parameters
-     */
-    getCriteriaTree<Parameters>(criteriaSetId: string, parameters: Parameters, values?: TaskItemValueMap, locale?: string): Promise<CriteriaTree>;
-    /**
-     * Validate the given parameters for the given criteria set ID
-     */
-    validateParameters<Parameters>(criteriaSetId: string, parameters: Parameters): void;
-    /**
-     * Stream the matrix for the given criteria set ID, parameter combination and value map
-     */
-    streamMatrix<Parameters>(criteriaSetId: string, parameters: Parameters, values?: TaskItemValueMap, locale?: string): Promise<StreamMatrixResponse>;
-    /**
-     * Get the metadata of all criteria sets supported by this service
-     */
-    getCriteriaSetMetadataList(): Metadata[];
-}

package/dist/v1/services/i-protocol-v1.service.js

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

package/dist/v1/utils/color.d.ts

@@ -1,2 +0,0 @@
-import { Color } from '../types';
-export declare const toColorHexString: (color: Color) => string;

package/dist/v1/utils/color.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toColorHexString = void 0;
-const toColorHexString = (color) => {
-    if (typeof color === 'string') {
-        return color;
-    }
-    return `#${color.red.toString(16)}${color.green.toString(16)}${color.blue.toString(16)}`;
-};
-exports.toColorHexString = toColorHexString;

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

@@ -1,7 +0,0 @@
-import { CriteriaTreeElement, Quality, Criterion, Task, TaskGroup, TaskItem } from '../types';
-export { toColorHexString } from './color';
-export declare const isQuality: (element: CriteriaTreeElement) => element is Quality;
-export declare const isCriterion: (element: CriteriaTreeElement) => element is Criterion;
-export declare const isTaskGroup: (element: CriteriaTreeElement) => element is TaskGroup;
-export declare const isTask: (element: CriteriaTreeElement) => element is Task;
-export declare const isTaskItem: (element: CriteriaTreeElement) => element is TaskItem;

package/dist/v1/utils/index.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTaskItem = exports.isTask = exports.isTaskGroup = exports.isCriterion = exports.isQuality = exports.toColorHexString = void 0;
-var color_1 = require("./color");
-Object.defineProperty(exports, "toColorHexString", { enumerable: true, get: function () { return color_1.toColorHexString; } });
-const isQuality = (element) => element.type === 'quality';
-exports.isQuality = isQuality;
-const isCriterion = (element) => element.type === 'criterion';
-exports.isCriterion = isCriterion;
-const isTaskGroup = (element) => element.type === 'task-group';
-exports.isTaskGroup = isTaskGroup;
-const isTask = (element) => element.type === 'task';
-exports.isTask = isTask;
-const isTaskItem = (element) => element.type === 'task-item';
-exports.isTaskItem = isTaskItem;