@openframe-org/criteria-set-protocol 2.0.0-beta.8 → 2.0.0
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.
- package/README.md +27 -34
- package/dist/index.d.ts +1 -1
- package/dist/v1/errors/DataValidationError.d.ts +1 -1
- package/dist/v1/errors/DataValidationError.js +1 -1
- package/dist/v1/errors/ParameterValidationError.d.ts +1 -1
- package/dist/v1/errors/ParameterValidationError.js +1 -1
- package/dist/v1/errors/ValidationError.d.ts +1 -1
- package/dist/v1/errors/ValidationError.js +1 -1
- package/dist/v1/errors/index.d.ts +4 -4
- package/dist/v1/errors/types.d.ts +1 -1
- package/dist/v1/index.d.ts +5 -5
- package/dist/v1/schemas/certification.d.ts +1 -1
- package/dist/v1/schemas/certification.js +13 -19
- package/dist/v1/schemas/common.d.ts +1 -1
- package/dist/v1/schemas/common.js +8 -16
- package/dist/v1/schemas/criteria-tree.d.ts +1 -49
- package/dist/v1/schemas/criteria-tree.js +5 -13
- package/dist/v1/schemas/criterion.d.ts +1 -10
- package/dist/v1/schemas/criterion.js +4 -4
- package/dist/v1/schemas/data-map.d.ts +1 -1
- package/dist/v1/schemas/data-map.js +1 -1
- package/dist/v1/schemas/documentation.d.ts +1 -1
- package/dist/v1/schemas/documentation.js +5 -9
- package/dist/v1/schemas/index.d.ts +13 -13
- package/dist/v1/schemas/metadata.d.ts +1 -1
- package/dist/v1/schemas/metadata.js +6 -6
- package/dist/v1/schemas/quality.d.ts +141 -469
- package/dist/v1/schemas/quality.js +7 -7
- package/dist/v1/schemas/request/criteria-set-id-param-schema.d.ts +1 -1
- package/dist/v1/schemas/request/criteria-set-id-param-schema.js +2 -3
- package/dist/v1/schemas/request/index.d.ts +4 -4
- package/dist/v1/schemas/request/matrix-body-schema.d.ts +1 -1
- package/dist/v1/schemas/request/matrix-body-schema.js +3 -5
- package/dist/v1/schemas/request/matrix-request-body-schema.d.ts +1 -1
- package/dist/v1/schemas/request/matrix-request-body-schema.js +6 -8
- package/dist/v1/schemas/request/tree-and-data-body-schema.d.ts +1 -1
- package/dist/v1/schemas/request/tree-and-data-body-schema.js +3 -5
- package/dist/v1/schemas/request/tree-and-data-request-body-schema.d.ts +1 -1
- package/dist/v1/schemas/request/tree-and-data-request-body-schema.js +5 -7
- package/dist/v1/schemas/request/version-param-schema.d.ts +1 -1
- package/dist/v1/schemas/request/version-param-schema.js +2 -3
- package/dist/v1/schemas/response.d.ts +2 -2
- package/dist/v1/schemas/response.js +1 -1
- package/dist/v1/schemas/task-group.d.ts +1 -8
- package/dist/v1/schemas/task-group.js +5 -5
- package/dist/v1/schemas/task-item.d.ts +1 -4
- package/dist/v1/schemas/task-item.js +27 -35
- package/dist/v1/schemas/task.d.ts +1 -6
- package/dist/v1/schemas/task.js +4 -4
- package/dist/v1/schemas/theme.d.ts +1 -12
- package/dist/v1/schemas/theme.js +4 -4
- package/dist/v1/services/i-criteria-set.service.d.ts +1 -1
- package/dist/v1/services/index.d.ts +2 -2
- package/dist/v1/services/manager.service.js +1 -4
- package/dist/v1/types/criteria.d.ts +2 -2
- package/dist/v1/types/express.d.ts +3 -3
- package/dist/v1/types/index.d.ts +2 -2
- package/dist/v1/utils.d.ts +3 -8
- package/dist/v1/utils.js +6 -6
- package/package.json +3 -11
package/dist/v1/types/index.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export * from
|
|
2
|
-
export * from
|
|
1
|
+
export * from './express';
|
|
2
|
+
export * from './criteria';
|
package/dist/v1/utils.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Color, CriteriaTree, CriteriaTreeElement } from
|
|
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;
|
|
@@ -75,7 +75,6 @@ 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;
|
|
79
78
|
providedData?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
|
|
80
79
|
}[];
|
|
81
80
|
data?: (Record<string, any> & {
|
|
@@ -266,7 +265,6 @@ export declare const isCriterion: (element: CriteriaTreeElement) => element is {
|
|
|
266
265
|
text: string;
|
|
267
266
|
})[] | undefined;
|
|
268
267
|
sortOrder?: number | undefined;
|
|
269
|
-
valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
|
|
270
268
|
providedData?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
|
|
271
269
|
}[];
|
|
272
270
|
data?: (Record<string, any> & {
|
|
@@ -416,7 +414,6 @@ export declare const isTaskGroup: (element: CriteriaTreeElement) => element is {
|
|
|
416
414
|
text: string;
|
|
417
415
|
})[] | undefined;
|
|
418
416
|
sortOrder?: number | undefined;
|
|
419
|
-
valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
|
|
420
417
|
providedData?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
|
|
421
418
|
}[];
|
|
422
419
|
data?: (Record<string, any> & {
|
|
@@ -536,7 +533,6 @@ export declare const isTask: (element: CriteriaTreeElement) => element is {
|
|
|
536
533
|
text: string;
|
|
537
534
|
})[] | undefined;
|
|
538
535
|
sortOrder?: number | undefined;
|
|
539
|
-
valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
|
|
540
536
|
providedData?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
|
|
541
537
|
}[];
|
|
542
538
|
data?: (Record<string, any> & {
|
|
@@ -625,7 +621,6 @@ export declare const isTaskItem: (element: CriteriaTreeElement) => element is {
|
|
|
625
621
|
text: string;
|
|
626
622
|
})[] | undefined;
|
|
627
623
|
sortOrder?: number | undefined;
|
|
628
|
-
valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
|
|
629
624
|
providedData?: Record<string, string | number | boolean | (string | number | boolean | null)[] | null> | undefined;
|
|
630
625
|
};
|
|
631
626
|
/**
|
|
@@ -635,11 +630,11 @@ export declare const toColorHexString: (color: Color) => string;
|
|
|
635
630
|
/**
|
|
636
631
|
* Check if a tree element should be hidden in the output
|
|
637
632
|
*/
|
|
638
|
-
export declare const shouldHideCode: (element: Pick<CriteriaTreeElement,
|
|
633
|
+
export declare const shouldHideCode: (element: Pick<CriteriaTreeElement, 'options'>) => boolean;
|
|
639
634
|
/**
|
|
640
635
|
* Get the qualified name of a tree element, which is the title with the code prepended if it is different
|
|
641
636
|
*/
|
|
642
|
-
export declare const getQualifiedName: (element: Pick<CriteriaTreeElement,
|
|
637
|
+
export declare const getQualifiedName: (element: Pick<CriteriaTreeElement, 'code' | 'title' | 'options'>) => string;
|
|
643
638
|
/**
|
|
644
639
|
* Find an element in the criteria tree by its code
|
|
645
640
|
*/
|
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 ===
|
|
4
|
+
const isTheme = (element) => element.type === 'theme';
|
|
5
5
|
exports.isTheme = isTheme;
|
|
6
|
-
const isCriterion = (element) => element.type ===
|
|
6
|
+
const isCriterion = (element) => element.type === 'criterion';
|
|
7
7
|
exports.isCriterion = isCriterion;
|
|
8
|
-
const isTaskGroup = (element) => element.type ===
|
|
8
|
+
const isTaskGroup = (element) => element.type === 'task-group';
|
|
9
9
|
exports.isTaskGroup = isTaskGroup;
|
|
10
|
-
const isTask = (element) => element.type ===
|
|
10
|
+
const isTask = (element) => element.type === 'task';
|
|
11
11
|
exports.isTask = isTask;
|
|
12
|
-
const isTaskItem = (element) => element.type ===
|
|
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 ===
|
|
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.0",
|
|
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,24 +8,16 @@
|
|
|
8
8
|
"main": "dist/index.js",
|
|
9
9
|
"types": "dist/index.d.ts",
|
|
10
10
|
"scripts": {
|
|
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"
|
|
11
|
+
"prepublishOnly": "tsc"
|
|
19
12
|
},
|
|
20
13
|
"files": [
|
|
21
14
|
"dist/**/*"
|
|
22
15
|
],
|
|
23
16
|
"dependencies": {
|
|
24
|
-
"@types/node": "^
|
|
17
|
+
"@types/node": "^20.6.3",
|
|
25
18
|
"zod": "^3.23.8"
|
|
26
19
|
},
|
|
27
20
|
"devDependencies": {
|
|
28
|
-
"prettier": "^3.3.3",
|
|
29
21
|
"typescript": "^5.2.2"
|
|
30
22
|
},
|
|
31
23
|
"publishConfig": {
|