@openframe-org/criteria-set-protocol 1.0.24 → 1.0.26

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

@@ -1,4 +1,4 @@
-import { CriteriaTree, Metadata, StreamMatrixResponse, TaskItemValueMap } from '../types';
+import { CriteriaTree, CriteriaSetMetadata, StreamMatrixResponse, TaskItemValueMap } from '../types';
 /**
  * Interface for services which implement the v1 protocol
  */
@@ -22,7 +22,7 @@ export interface IProtocolV1Service {
     /**
      * Get the metadata of all criteria sets supported by this service
      */
-    getCriteriaSetMetadataList(): Metadata[];
+    getCriteriaSetMetadataList(): CriteriaSetMetadata[];
     /**
      * Get the JSON schema for the given criteria set ID
      */

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

@@ -8,6 +8,15 @@ export type QualityStyle = {
     secondaryColor: Color;
 };
 export type Metadata = {
+    protocol: string;
+    metadata: CriteriaSetMetadata;
+    locales?: string[];
+    defaultLocale?: string;
+    parameters: Record<string, any>;
+    result: Record<string, any>;
+    definitions: Record<string, any>;
+};
+export type CriteriaSetMetadata = {
     id: string;
     version: string;
     date: Date;
@@ -44,7 +53,7 @@ type BaseElement<Type extends CriteriaTreeElementType> = {
     label?: string;
     tags?: string[];
     documentation?: DocumentationItem[];
-    data: Record<string, any>;
+    data?: Record<string, any>;
 };
 export type Quality = Pick<BaseElement<'quality'>, 'type' | 'tags' | 'documentation' | 'data'> & {
     code: string;

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

@@ -1,9 +1,7 @@
 /// <reference types="node" />
 import { Stream } from 'stream';
-import { CriteriaTree, Metadata, TaskItemValue } from './criteria';
-export type MetadataResponse<Parameters extends ParameterCombination = ParameterCombination> = {
-    protocol: 1;
-    metadata: Metadata;
+import { CriteriaTree, CriteriaSetMetadata, TaskItemValue, Metadata } from './criteria';
+export type MetadataResponse<Parameters extends ParameterCombination = ParameterCombination> = Omit<Metadata, 'parameters'> & {
     parameters: Parameters;
 };
 export type CriteriaTreeResponse = CriteriaTree;
@@ -19,5 +17,5 @@ export type StreamMatrixResponse = {
     contentType: string;
     stream: Stream;
 };
-export type CriteriaSetsAndVersionsMap = Record<string, Metadata[]>;
+export type CriteriaSetsAndVersionsMap = Record<string, CriteriaSetMetadata[]>;
 export type ParameterCombination = Record<string, any>;

package/package.json

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