@openframe-org/criteria-set-protocol 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './services';
+export * from './types';
+export * as v1 from './v1';

package/dist/index.js

@@ -0,0 +1,32 @@
+"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 __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);
+};
+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.v1 = void 0;
+__exportStar(require("./services"), exports);
+__exportStar(require("./types"), exports);
+exports.v1 = __importStar(require("./v1"));

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

@@ -0,0 +1,5 @@
+import { ProtocolVersionServiceMap } from '../types';
+export interface IVersionedService {
+    version: string;
+    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,10 @@
+import { IVersionedService } from './i-versioned.service';
+import { ProtocolVersionServiceMap } from '../types';
+export declare class VersionsService {
+    protected versions: IVersionedService[];
+    constructor(versions: IVersionedService[]);
+    getAll(): IVersionedService[];
+    getServiceVersions<ProtocolVersion extends number, ProtocolImplementingService = ProtocolVersionServiceMap<ProtocolVersion>>(protocolVersion: ProtocolVersion): ProtocolImplementingService[];
+    get(version: string): IVersionedService | undefined;
+    getLatestVersion(): IVersionedService;
+}

package/dist/services/versions.service.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VersionsService = void 0;
+class VersionsService {
+    constructor(versions) {
+        this.versions = versions;
+    }
+    getAll() {
+        return this.versions;
+    }
+    getServiceVersions(protocolVersion) {
+        return this.versions.filter((service) => service.supportsProtocol(protocolVersion));
+    }
+    get(version) {
+        return this.versions.find((service) => service.version === version);
+    }
+    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/index.d.ts

@@ -0,0 +1,3 @@
+export * from './schemas';
+export * from './services';
+export * from './types';

package/dist/v1/index.js

@@ -0,0 +1,19 @@
+"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("./schemas"), exports);
+__exportStar(require("./services"), exports);
+__exportStar(require("./types"), exports);

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

@@ -0,0 +1,10 @@
+import * as yup from 'yup';
+export declare const criteriaSetIdParamSchema: yup.ObjectSchema<{
+    params: {
+        criteriaSetId: string;
+    };
+}, yup.AnyObject, {
+    params: {
+        criteriaSetId: undefined;
+    };
+}, "">;

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

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

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

@@ -0,0 +1,12 @@
+import * as yup from 'yup';
+export declare const downloadMatrixBodySchema: yup.ObjectSchema<{
+    body: {
+        values: {};
+        parameters: {};
+    };
+}, yup.AnyObject, {
+    body: {
+        parameters: {};
+        values: {};
+    };
+}, "">;

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

@@ -0,0 +1,33 @@
+"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"));
+exports.downloadMatrixBodySchema = yup.object({
+    body: yup.object({
+        parameters: yup.object().required(),
+        values: yup.object()
+    })
+});

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

@@ -0,0 +1,3 @@
+export * from './criteria-set-id-param-schema';
+export * from './download-matrix-body-schema';
+export * from './version-param-schema';

package/dist/v1/schemas/index.js

@@ -0,0 +1,19 @@
+"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("./criteria-set-id-param-schema"), exports);
+__exportStar(require("./download-matrix-body-schema"), exports);
+__exportStar(require("./version-param-schema"), exports);

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

@@ -0,0 +1,10 @@
+import * as yup from 'yup';
+export declare const versionParamSchema: yup.ObjectSchema<{
+    params: {
+        version: string;
+    };
+}, yup.AnyObject, {
+    params: {
+        version: undefined;
+    };
+}, "">;

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

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

package/dist/v1/services/i-protocol-v1.service.d.ts

@@ -0,0 +1,9 @@
+import { CriteriaTree, Metadata, StreamMatrixResponse, TaskItemValueMap } from '../types';
+export interface IProtocolV1Service {
+    version: string;
+    getCriteriaTree(criteriaSetId: string, rawParameters: Record<string, unknown>): Promise<CriteriaTree>;
+    validateParameters<RequestParameters>(criteriaSetId: string, parameters: RequestParameters): void;
+    streamMatrix(criteriaSetId: string, rawParameters: Record<string, unknown>, values: TaskItemValueMap): Promise<StreamMatrixResponse>;
+    getMatrixMetadataList(): Metadata[];
+    getParametersJsonSchema(criteriaSetId: string): Record<string, unknown>;
+}

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

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

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

@@ -0,0 +1 @@
+export * from './i-protocol-v1.service';

package/dist/v1/services/index.js

@@ -0,0 +1,17 @@
+"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-protocol-v1.service"), exports);

package/dist/v1/types/criteria.d.ts

@@ -0,0 +1,64 @@
+export type Metadata = {
+    id: string;
+    version: string;
+    date: Date;
+    name: string;
+    description: string;
+    documentation?: string;
+};
+export type CriteriaTree = Criterion[];
+export type Criterion = {
+    quality: string;
+    title: string;
+    label?: string;
+    tags?: string[];
+    items: (Task | TaskGroup)[];
+    documentation?: Record<string, string[]>;
+};
+export type TaskGroup = {
+    title: string;
+    label?: string;
+    tags?: string[];
+    items: (Task | TaskGroup)[];
+    documentation?: Record<string, string[]>;
+};
+export type Task = {
+    title: string;
+    label?: string;
+    tags?: string[];
+    items: TaskItem[];
+    documentation?: Record<string, string[]>;
+};
+export type TaskItem = {
+    id: string;
+    text?: string;
+    description?: string;
+    label?: string;
+    tags?: string[];
+    definition: SelectSingleType | SelectMultipleType | NumberType | BooleanType;
+    documentation?: Record<string, string[]>;
+};
+export type SelectSingleType = {
+    type: 'select-single';
+    options: PointOption[];
+};
+export type SelectMultipleType = {
+    type: 'select-multiple';
+    options: PointOption[];
+};
+export type NumberType = {
+    type: 'number';
+    minimum?: number;
+    maximum?: number;
+    step?: number;
+};
+export type BooleanType = {
+    type: 'boolean';
+};
+export type PointOption = {
+    id?: string;
+    label: string;
+    value: number;
+    annotation?: string;
+};
+export type TaskItemValue = string | number | boolean | null | Array<string | number | boolean | null>;

package/dist/v1/types/criteria.js

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

package/dist/v1/types/express.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="node" />
+import { Stream } from 'stream';
+import { Metadata, TaskItemValue } from './criteria';
+export type MetadataSchema<Parameters extends ParameterCombination = ParameterCombination> = {
+    protocol: 1;
+    metadata: Metadata;
+    parameters: Parameters;
+};
+export type StringParam<ParamName extends string> = Record<ParamName, string>;
+export type TaskItemValueMap = Record<string, TaskItemValue>;
+export type StreamCriteriaSetMatrixBody = {
+    parameters: ParameterCombination;
+    values?: TaskItemValueMap;
+};
+export type StreamMatrixResponse = {
+    filename: string;
+    contentType: string;
+    stream: Stream;
+};
+export type CriteriaSetsAndVersionsMap = Record<string, Metadata[]>;
+export type ParameterCombination = Record<string, any>;

package/dist/v1/types/express.js

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

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

@@ -0,0 +1,2 @@
+export * from './express';
+export * from './criteria';

package/dist/v1/types/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("./express"), exports);
+__exportStar(require("./criteria"), exports);

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@openframe-org/criteria-set-protocol",
+  "version": "1.0.0",
+  "description": "A protocol and tools for defining and working with criteria sets",
+  "private": false,
+  "author": "Andrés Angulo <aa@openframe.org>",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "prepublishOnly": "tsc"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "dependencies": {
+    "yup": "^1.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.6.3",
+    "typescript": "^5.2.2"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}