@openframe-org/criteria-set-protocol 1.0.8 → 1.0.10

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

@@ -6,37 +6,60 @@ export type Metadata = {
     description: string;
     documentation?: string;
 };
+export type PdfDocumentationItem = {
+    type: 'pdf';
+    label: string;
+    url: string;
+};
+export type InlineDocumentationItem = {
+    type: 'text';
+    label?: string;
+    text: string;
+};
+export type LinkDocumentationItem = {
+    type: 'link';
+    label: string;
+    url: string;
+};
+export type DocumentationItem = PdfDocumentationItem | InlineDocumentationItem | LinkDocumentationItem;
 export type CriteriaTree = Criterion[];
 export type Criterion = {
+    type: 'criterion';
+    id?: string;
     quality: string;
     title: string;
     label?: string;
     tags?: string[];
     items: (Task | TaskGroup)[];
-    documentation?: Record<string, string[]>;
+    documentation?: DocumentationItem[];
 };
 export type TaskGroup = {
+    type: 'task-group';
+    id?: string;
     title: string;
     label?: string;
     tags?: string[];
     items: (Task | TaskGroup)[];
-    documentation?: Record<string, string[]>;
+    documentation?: DocumentationItem[];
 };
 export type Task = {
+    type: 'task';
+    id?: string;
     title: string;
     label?: string;
+    description?: string;
     tags?: string[];
     items: TaskItem[];
-    documentation?: Record<string, string[]>;
+    documentation?: DocumentationItem[];
 };
 export type TaskItem = {
+    type: 'task-item';
     id: string;
-    text?: string;
     description?: string;
     label?: string;
     tags?: string[];
     definition: SelectSingleType | SelectMultipleType | NumberType | BooleanType;
-    documentation?: Record<string, string[]>;
+    documentation?: DocumentationItem[];
     providedData?: Record<string, TaskItemValue>;
     calculatedData?: Record<string, any>;
 };
@@ -60,7 +83,9 @@ export type BooleanType = {
 export type PointOption = {
     id?: string;
     label: string;
-    value: number;
+    value: string | number | boolean | null;
     annotation?: string;
 };
 export type TaskItemValue = string | number | boolean | null | Array<string | number | boolean | null>;
+export type CriteriaTreeElement = Criterion | TaskGroup | Task | TaskItem;
+export type CriteriaTreeElementType = 'criterion' | 'task-group' | 'task' | 'task-item';

package/dist/v1/utils.d.ts

@@ -0,0 +1,5 @@
+import { CriteriaTreeElement, Criterion } from './types';
+export declare const isCriterion: (element: CriteriaTreeElement) => element is Criterion;
+export declare const isTaskGroup: (element: CriteriaTreeElement) => element is Criterion;
+export declare const isTask: (element: CriteriaTreeElement) => element is Criterion;
+export declare const isTaskItem: (element: CriteriaTreeElement) => element is Criterion;

package/dist/v1/utils.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTaskItem = exports.isTask = exports.isTaskGroup = exports.isCriterion = void 0;
+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;

package/package.json

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