@openframe-org/criteria-set-protocol 2.0.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/README.md +34 -27
  2. package/dist/index.d.ts +1 -1
  3. package/dist/v1/errors/DataValidationError.d.ts +1 -1
  4. package/dist/v1/errors/DataValidationError.js +1 -1
  5. package/dist/v1/errors/ParameterValidationError.d.ts +1 -1
  6. package/dist/v1/errors/ParameterValidationError.js +1 -1
  7. package/dist/v1/errors/ValidationError.d.ts +1 -1
  8. package/dist/v1/errors/ValidationError.js +1 -1
  9. package/dist/v1/errors/index.d.ts +4 -4
  10. package/dist/v1/errors/types.d.ts +1 -1
  11. package/dist/v1/index.d.ts +5 -5
  12. package/dist/v1/schemas/certification.d.ts +1 -1
  13. package/dist/v1/schemas/certification.js +19 -13
  14. package/dist/v1/schemas/common.d.ts +13 -11
  15. package/dist/v1/schemas/common.js +27 -11
  16. package/dist/v1/schemas/criteria-tree.d.ts +365 -311
  17. package/dist/v1/schemas/criteria-tree.js +13 -5
  18. package/dist/v1/schemas/criterion.d.ts +68 -58
  19. package/dist/v1/schemas/criterion.js +4 -4
  20. package/dist/v1/schemas/data-map.d.ts +1 -1
  21. package/dist/v1/schemas/data-map.js +1 -1
  22. package/dist/v1/schemas/documentation.d.ts +1 -1
  23. package/dist/v1/schemas/documentation.js +9 -5
  24. package/dist/v1/schemas/index.d.ts +13 -13
  25. package/dist/v1/schemas/metadata.d.ts +1 -1
  26. package/dist/v1/schemas/metadata.js +6 -6
  27. package/dist/v1/schemas/quality.d.ts +469 -141
  28. package/dist/v1/schemas/quality.js +7 -7
  29. package/dist/v1/schemas/request/criteria-set-id-param-schema.d.ts +1 -1
  30. package/dist/v1/schemas/request/criteria-set-id-param-schema.js +3 -2
  31. package/dist/v1/schemas/request/index.d.ts +4 -4
  32. package/dist/v1/schemas/request/matrix-body-schema.d.ts +1 -1
  33. package/dist/v1/schemas/request/matrix-body-schema.js +5 -3
  34. package/dist/v1/schemas/request/matrix-request-body-schema.d.ts +1 -1
  35. package/dist/v1/schemas/request/matrix-request-body-schema.js +8 -6
  36. package/dist/v1/schemas/request/tree-and-data-body-schema.d.ts +1 -1
  37. package/dist/v1/schemas/request/tree-and-data-body-schema.js +5 -3
  38. package/dist/v1/schemas/request/tree-and-data-request-body-schema.d.ts +1 -1
  39. package/dist/v1/schemas/request/tree-and-data-request-body-schema.js +7 -5
  40. package/dist/v1/schemas/request/version-param-schema.d.ts +1 -1
  41. package/dist/v1/schemas/request/version-param-schema.js +3 -2
  42. package/dist/v1/schemas/response.d.ts +2 -2
  43. package/dist/v1/schemas/response.js +1 -1
  44. package/dist/v1/schemas/task-group.d.ts +47 -39
  45. package/dist/v1/schemas/task-group.js +5 -5
  46. package/dist/v1/schemas/task-item.d.ts +23 -20
  47. package/dist/v1/schemas/task-item.js +29 -35
  48. package/dist/v1/schemas/task.d.ts +30 -24
  49. package/dist/v1/schemas/task.js +4 -4
  50. package/dist/v1/schemas/theme.d.ts +93 -81
  51. package/dist/v1/schemas/theme.js +4 -4
  52. package/dist/v1/services/i-criteria-set.service.d.ts +1 -1
  53. package/dist/v1/services/index.d.ts +2 -2
  54. package/dist/v1/services/manager.service.js +4 -1
  55. package/dist/v1/types/criteria.d.ts +2 -2
  56. package/dist/v1/types/express.d.ts +3 -3
  57. package/dist/v1/types/index.d.ts +2 -2
  58. package/dist/v1/utils.d.ts +38 -33
  59. package/dist/v1/utils.js +6 -6
  60. package/package.json +11 -3
@@ -1,4 +1,4 @@
1
- import { Color, CriteriaTree, CriteriaTreeElement } from './types';
1
+ import { Color, CriteriaTree, CriteriaTreeElement } from "./types";
2
2
  export declare const isTheme: (element: CriteriaTreeElement) => element is {
3
3
  type: "theme";
4
4
  code: string;
@@ -49,11 +49,11 @@ export declare const isTheme: (element: CriteriaTreeElement) => element is {
49
49
  true: string;
50
50
  } | undefined;
51
51
  };
52
- data?: (Record<string, any> & {
52
+ data?: {
53
53
  value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
54
54
  text?: string | undefined;
55
55
  valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
56
- }) | undefined;
56
+ } | undefined;
57
57
  options?: {
58
58
  hideCode?: boolean | undefined;
59
59
  } | undefined;
@@ -75,12 +75,13 @@ export declare const isTheme: (element: CriteriaTreeElement) => element is {
75
75
  text: string;
76
76
  })[] | undefined;
77
77
  sortOrder?: number | undefined;
78
+ valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
78
79
  providedData?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
79
80
  }[];
80
- data?: (Record<string, any> & {
81
+ data?: {
81
82
  value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
82
83
  text?: string | undefined;
83
- }) | undefined;
84
+ } | undefined;
84
85
  options?: {
85
86
  hideCode?: boolean | undefined;
86
87
  } | undefined;
@@ -103,10 +104,10 @@ export declare const isTheme: (element: CriteriaTreeElement) => element is {
103
104
  })[] | undefined;
104
105
  sortOrder?: number | undefined;
105
106
  }[];
106
- data?: (Record<string, any> & {
107
+ data?: {
107
108
  value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
108
109
  text?: string | undefined;
109
- }) | undefined;
110
+ } | undefined;
110
111
  options?: {
111
112
  hideCode?: boolean | undefined;
112
113
  hideFromHierarchy?: boolean | undefined;
@@ -130,10 +131,10 @@ export declare const isTheme: (element: CriteriaTreeElement) => element is {
130
131
  sortOrder?: number | undefined;
131
132
  category?: string | undefined;
132
133
  }[];
133
- data?: (Record<string, any> & {
134
+ data?: {
134
135
  value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
135
136
  text?: string | undefined;
136
- }) | undefined;
137
+ } | undefined;
137
138
  options?: {
138
139
  hideCode?: boolean | undefined;
139
140
  hideFromHierarchy?: boolean | undefined;
@@ -156,10 +157,10 @@ export declare const isTheme: (element: CriteriaTreeElement) => element is {
156
157
  })[] | undefined;
157
158
  sortOrder?: number | undefined;
158
159
  }[];
159
- data?: (Record<string, any> & {
160
+ data?: {
160
161
  value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
161
162
  text?: string | undefined;
162
- }) | undefined;
163
+ } | undefined;
163
164
  style?: {
164
165
  primaryColor: string | {
165
166
  red: number;
@@ -239,11 +240,11 @@ export declare const isCriterion: (element: CriteriaTreeElement) => element is {
239
240
  true: string;
240
241
  } | undefined;
241
242
  };
242
- data?: (Record<string, any> & {
243
+ data?: {
243
244
  value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
244
245
  text?: string | undefined;
245
246
  valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
246
- }) | undefined;
247
+ } | undefined;
247
248
  options?: {
248
249
  hideCode?: boolean | undefined;
249
250
  } | undefined;
@@ -265,12 +266,13 @@ export declare const isCriterion: (element: CriteriaTreeElement) => element is {
265
266
  text: string;
266
267
  })[] | undefined;
267
268
  sortOrder?: number | undefined;
269
+ valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
268
270
  providedData?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
269
271
  }[];
270
- data?: (Record<string, any> & {
272
+ data?: {
271
273
  value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
272
274
  text?: string | undefined;
273
- }) | undefined;
275
+ } | undefined;
274
276
  options?: {
275
277
  hideCode?: boolean | undefined;
276
278
  } | undefined;
@@ -293,10 +295,10 @@ export declare const isCriterion: (element: CriteriaTreeElement) => element is {
293
295
  })[] | undefined;
294
296
  sortOrder?: number | undefined;
295
297
  }[];
296
- data?: (Record<string, any> & {
298
+ data?: {
297
299
  value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
298
300
  text?: string | undefined;
299
- }) | undefined;
301
+ } | undefined;
300
302
  options?: {
301
303
  hideCode?: boolean | undefined;
302
304
  hideFromHierarchy?: boolean | undefined;
@@ -320,10 +322,10 @@ export declare const isCriterion: (element: CriteriaTreeElement) => element is {
320
322
  sortOrder?: number | undefined;
321
323
  category?: string | undefined;
322
324
  }[];
323
- data?: (Record<string, any> & {
325
+ data?: {
324
326
  value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
325
327
  text?: string | undefined;
326
- }) | undefined;
328
+ } | undefined;
327
329
  options?: {
328
330
  hideCode?: boolean | undefined;
329
331
  hideFromHierarchy?: boolean | undefined;
@@ -388,11 +390,11 @@ export declare const isTaskGroup: (element: CriteriaTreeElement) => element is {
388
390
  true: string;
389
391
  } | undefined;
390
392
  };
391
- data?: (Record<string, any> & {
393
+ data?: {
392
394
  value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
393
395
  text?: string | undefined;
394
396
  valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
395
- }) | undefined;
397
+ } | undefined;
396
398
  options?: {
397
399
  hideCode?: boolean | undefined;
398
400
  } | undefined;
@@ -414,12 +416,13 @@ export declare const isTaskGroup: (element: CriteriaTreeElement) => element is {
414
416
  text: string;
415
417
  })[] | undefined;
416
418
  sortOrder?: number | undefined;
419
+ valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
417
420
  providedData?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
418
421
  }[];
419
- data?: (Record<string, any> & {
422
+ data?: {
420
423
  value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
421
424
  text?: string | undefined;
422
- }) | undefined;
425
+ } | undefined;
423
426
  options?: {
424
427
  hideCode?: boolean | undefined;
425
428
  } | undefined;
@@ -442,10 +445,10 @@ export declare const isTaskGroup: (element: CriteriaTreeElement) => element is {
442
445
  })[] | undefined;
443
446
  sortOrder?: number | undefined;
444
447
  }[];
445
- data?: (Record<string, any> & {
448
+ data?: {
446
449
  value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
447
450
  text?: string | undefined;
448
- }) | undefined;
451
+ } | undefined;
449
452
  options?: {
450
453
  hideCode?: boolean | undefined;
451
454
  hideFromHierarchy?: boolean | undefined;
@@ -507,11 +510,11 @@ export declare const isTask: (element: CriteriaTreeElement) => element is {
507
510
  true: string;
508
511
  } | undefined;
509
512
  };
510
- data?: (Record<string, any> & {
513
+ data?: {
511
514
  value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
512
515
  text?: string | undefined;
513
516
  valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
514
- }) | undefined;
517
+ } | undefined;
515
518
  options?: {
516
519
  hideCode?: boolean | undefined;
517
520
  } | undefined;
@@ -533,12 +536,13 @@ export declare const isTask: (element: CriteriaTreeElement) => element is {
533
536
  text: string;
534
537
  })[] | undefined;
535
538
  sortOrder?: number | undefined;
539
+ valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
536
540
  providedData?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
537
541
  }[];
538
- data?: (Record<string, any> & {
542
+ data?: {
539
543
  value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
540
544
  text?: string | undefined;
541
- }) | undefined;
545
+ } | undefined;
542
546
  options?: {
543
547
  hideCode?: boolean | undefined;
544
548
  } | undefined;
@@ -595,11 +599,11 @@ export declare const isTaskItem: (element: CriteriaTreeElement) => element is {
595
599
  true: string;
596
600
  } | undefined;
597
601
  };
598
- data?: (Record<string, any> & {
602
+ data?: {
599
603
  value?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
600
604
  text?: string | undefined;
601
605
  valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
602
- }) | undefined;
606
+ } | undefined;
603
607
  options?: {
604
608
  hideCode?: boolean | undefined;
605
609
  } | undefined;
@@ -621,6 +625,7 @@ export declare const isTaskItem: (element: CriteriaTreeElement) => element is {
621
625
  text: string;
622
626
  })[] | undefined;
623
627
  sortOrder?: number | undefined;
628
+ valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
624
629
  providedData?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
625
630
  };
626
631
  /**
@@ -630,11 +635,11 @@ export declare const toColorHexString: (color: Color) => string;
630
635
  /**
631
636
  * Check if a tree element should be hidden in the output
632
637
  */
633
- export declare const shouldHideCode: (element: Pick<CriteriaTreeElement, 'options'>) => boolean;
638
+ export declare const shouldHideCode: (element: Pick<CriteriaTreeElement, "options">) => boolean;
634
639
  /**
635
640
  * Get the qualified name of a tree element, which is the title with the code prepended if it is different
636
641
  */
637
- export declare const getQualifiedName: (element: Pick<CriteriaTreeElement, 'code' | 'title' | 'options'>) => string;
642
+ export declare const getQualifiedName: (element: Pick<CriteriaTreeElement, "code" | "title" | "options">) => string;
638
643
  /**
639
644
  * Find an element in the criteria tree by its code
640
645
  */
package/dist/v1/utils.js CHANGED
@@ -1,21 +1,21 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.findInTree = exports.getQualifiedName = exports.shouldHideCode = exports.toColorHexString = exports.isTaskItem = exports.isTask = exports.isTaskGroup = exports.isCriterion = exports.isTheme = void 0;
4
- const isTheme = (element) => element.type === 'theme';
4
+ const isTheme = (element) => element.type === "theme";
5
5
  exports.isTheme = isTheme;
6
- const isCriterion = (element) => element.type === 'criterion';
6
+ const isCriterion = (element) => element.type === "criterion";
7
7
  exports.isCriterion = isCriterion;
8
- const isTaskGroup = (element) => element.type === 'task-group';
8
+ const isTaskGroup = (element) => element.type === "task-group";
9
9
  exports.isTaskGroup = isTaskGroup;
10
- const isTask = (element) => element.type === 'task';
10
+ const isTask = (element) => element.type === "task";
11
11
  exports.isTask = isTask;
12
- const isTaskItem = (element) => element.type === 'task-item';
12
+ const isTaskItem = (element) => element.type === "task-item";
13
13
  exports.isTaskItem = isTaskItem;
14
14
  /**
15
15
  * Convert a color object to a hex string
16
16
  */
17
17
  const toColorHexString = (color) => {
18
- if (typeof color === 'string') {
18
+ if (typeof color === "string") {
19
19
  return color;
20
20
  }
21
21
  return `#${color.red.toString(16)}${color.green.toString(16)}${color.blue.toString(16)}`;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openframe-org/criteria-set-protocol",
3
- "version": "2.0.0",
3
+ "version": "2.0.1",
4
4
  "description": "A protocol and tools for defining and working with criteria sets",
5
5
  "private": false,
6
6
  "author": "Andrés Angulo <aa@openframe.org>",
@@ -8,16 +8,24 @@
8
8
  "main": "dist/index.js",
9
9
  "types": "dist/index.d.ts",
10
10
  "scripts": {
11
- "prepublishOnly": "tsc"
11
+ "prepublishOnly": "tsc",
12
+ "tc": "tsc --noEmit",
13
+ "format": "prettier --check .",
14
+ "format:write": "prettier --write ."
15
+ },
16
+ "engines": {
17
+ "node": "22.8.0",
18
+ "npm": ">=10"
12
19
  },
13
20
  "files": [
14
21
  "dist/**/*"
15
22
  ],
16
23
  "dependencies": {
17
- "@types/node": "^20.6.3",
24
+ "@types/node": "^22.8.4",
18
25
  "zod": "^3.23.8"
19
26
  },
20
27
  "devDependencies": {
28
+ "prettier": "^3.3.3",
21
29
  "typescript": "^5.2.2"
22
30
  },
23
31
  "publishConfig": {