@openframe-org/criteria-set-protocol 1.0.48 → 1.0.50

package/README.md

@@ -27,6 +27,7 @@ The library contains the types defined in the protocol v1 specification, and a s
 | `Color`                       |                                                     |
 | **Task tree types**           |                                                     |
 | `CriteriaTree`                |                                                     |
+| `Quality`                           |                                                     |
 | `Criterion`                   |                                                     |
 | `TaskGroup`                   |                                                     |
 | `Task`                        |                                                     |
@@ -41,7 +42,7 @@ The library contains the types defined in the protocol v1 specification, and a s
 | `TaskItemScalarValue`         | The raw value of a TaskItem                         |
 | **Express types**             |                                                     |
 | `MetadataResponse`            | Metadata endpoint response body                     |
-| `StreamCriteriaSetMatrixBody` | Request body for the matrix streaming endpoints     |
+| `TreeAndMatrixRequestBody` | Request body for the matrix streaming endpoints     |
 | `StreamMatrixResponse`        | Matrix streaming endpoints response body            |
 
 ##### Schemas

package/dist/index.d.ts

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

package/dist/index.js

@@ -15,9 +15,6 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : 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 = {};
@@ -27,6 +24,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 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/v1/schemas/tree-and-matrix-body-schema.d.ts

@@ -4,10 +4,10 @@ import * as yup from 'yup';
  */
 export declare const treeAndMatrixBodySchema: yup.ObjectSchema<{
     body: {
+        values?: {} | undefined;
         locale?: string | undefined;
-        values: {};
-        parameters: {};
-    };
+        parameters?: {} | undefined;
+    } | undefined;
 }, yup.AnyObject, {
     body: {
         locale: undefined;

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

@@ -30,8 +30,8 @@ const yup = __importStar(require("yup"));
  */
 exports.treeAndMatrixBodySchema = yup.object({
     body: yup.object({
-        locale: yup.string(),
-        parameters: yup.object(),
-        values: yup.object()
-    })
+        locale: yup.string().optional(),
+        parameters: yup.object().optional(),
+        values: yup.object().optional()
+    }).optional()
 });

package/dist/v1/services/i-criteria-set.service.d.ts

@@ -0,0 +1,9 @@
+import { CriteriaTree, Metadata, StreamMatrixResponse, TaskItemValueMap } from '../types';
+export interface ICriteriaSetService<ParametersType extends Record<string, any> = Record<string, any>> {
+    id: string;
+    version: string;
+    validateParameters(parameters: ParametersType): Promise<void>;
+    getMetadata(): Metadata;
+    getCriteriaTree(parameters?: ParametersType, values?: TaskItemValueMap | null, locale?: string | null): CriteriaTree;
+    streamMatrix(parameters?: ParametersType, values?: TaskItemValueMap | null, locale?: string | null): StreamMatrixResponse;
+}

package/dist/v1/services/i-criteria-set.service.js

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

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

@@ -1 +1,2 @@
-export * from './i-protocol-v1.service';
+export * from './i-criteria-set.service';
+export * from './manager.service';

package/dist/v1/services/index.js

@@ -14,4 +14,5 @@ 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);
+__exportStar(require("./i-criteria-set.service"), exports);
+__exportStar(require("./manager.service"), exports);

package/dist/v1/services/manager.service.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/v1/services/manager.service.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ManagerService {
+    constructor(criteriaSetServices = {}) {
+        this.criteriaSetServices = criteriaSetServices;
+    }
+    // Get the criteria sets and versions available to this service
+    getCriteriaSetsAndVersions() {
+        return Object.fromEntries(Object.entries(this.criteriaSetServices).map(([criteriaSetId, services]) => {
+            return [criteriaSetId, services.map((service) => service.getMetadata())];
+        }));
+    }
+    // Get the criteria set with the given ID. If no version is requested, return the latest version
+    getServiceForCriteriaSet(criteriaSetId, version) {
+        var _a;
+        const services = (_a = this.criteriaSetServices) === null || _a === void 0 ? void 0 : _a[criteriaSetId];
+        if (!(services === null || services === void 0 ? void 0 : services.length)) {
+            throw new Error(`Criteria set ID not found: ${criteriaSetId}`);
+        }
+        if (!version) {
+            return services[services.length - 1];
+        }
+        const service = services === null || services === void 0 ? void 0 : services.find((service) => {
+            return service.version === version;
+        });
+        if (!service) {
+            throw new Error(`Criteria set version not found: ${criteriaSetId}/${version}`);
+        }
+        return service;
+    }
+}

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

@@ -8,20 +8,16 @@ export type QualityStyle = {
     secondaryColor: Color;
 };
 export type Metadata = {
-    protocol: number;
-    metadata: CriteriaSetMetadata;
-    locales?: string[];
-    defaultLocale?: string;
-    parameters?: Record<string, any>;
-    result?: Record<string, any>;
-};
-export type CriteriaSetMetadata = {
     id: string;
     version: string;
     date: Date;
     name: string;
     description: string;
     documentation?: string;
+    locales?: string[];
+    defaultLocale?: string;
+    parameters?: Record<string, any>;
+    result?: Record<string, any>;
 };
 export type PdfDocumentationItem = {
     type: 'pdf';

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

@@ -7,7 +7,7 @@ export type StringParam<ParamName extends string> = Record<ParamName, string>;
 export type TaskItemValueMap = Record<string, TaskItemValue>;
 export type TreeAndMatrixRequestBody = {
     locale?: string;
-    parameters: ParameterCombination;
+    parameters?: ParameterCombination;
     values?: TaskItemValueMap;
 };
 export type StreamMatrixResponse = {
@@ -15,5 +15,4 @@ export type StreamMatrixResponse = {
     contentType: string;
     stream: Stream;
 };
-export type CriteriaSetsAndVersionsMap = Record<string, Metadata[]>;
 export type ParameterCombination = Record<string, any>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openframe-org/criteria-set-protocol",
-  "version": "1.0.48",
+  "version": "1.0.50",
   "description": "A protocol and tools for defining and working with criteria sets",
   "private": false,
   "author": "Andrés Angulo <aa@openframe.org>",