@openframe-org/criteria-set-protocol 2.2.14 → 2.2.16
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/dist/v1/schemas/criteria-tree.d.ts +4 -1
- package/dist/v1/schemas/criteria-tree.js +1 -0
- package/dist/v1/schemas/data-map.d.ts +3 -0
- package/dist/v1/schemas/data-map.js +1 -0
- package/dist/v1/schemas/metadata.d.ts +3 -0
- package/dist/v1/schemas/metadata.js +1 -0
- package/dist/v1/schemas/response.d.ts +3 -0
- package/dist/v1/services/criteria-set.service.d.ts +1 -1
- package/dist/v1/services/index.d.ts +0 -1
- package/dist/v1/services/index.js +0 -1
- package/package.json +1 -1
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
2
|
export declare const criteriaTreeSchema: z.ZodObject<Pick<{
|
|
3
3
|
version: z.ZodString;
|
|
4
|
+
revision: z.ZodString;
|
|
4
5
|
elements: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<{
|
|
5
6
|
type: z.ZodOptional<z.ZodEnum<["number", "percentage", "boolean"]>>;
|
|
6
7
|
value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
|
|
@@ -94,7 +95,7 @@ export declare const criteriaTreeSchema: z.ZodObject<Pick<{
|
|
|
94
95
|
exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
|
|
95
96
|
}, z.ZodAny, "strip">>;
|
|
96
97
|
certifications: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
97
|
-
}, "version" | "result" | "certifications"> & {
|
|
98
|
+
}, "version" | "revision" | "result" | "certifications"> & {
|
|
98
99
|
themes: z.ZodArray<z.ZodObject<{
|
|
99
100
|
title: z.ZodString;
|
|
100
101
|
longFormTitle: z.ZodString;
|
|
@@ -2726,6 +2727,7 @@ export declare const criteriaTreeSchema: z.ZodObject<Pick<{
|
|
|
2726
2727
|
dashboardRenderingType: "per-criteria" | "per-task";
|
|
2727
2728
|
};
|
|
2728
2729
|
version: string;
|
|
2730
|
+
revision: string;
|
|
2729
2731
|
result: {
|
|
2730
2732
|
type?: "number" | "boolean" | "percentage" | undefined;
|
|
2731
2733
|
total?: number | undefined;
|
|
@@ -3049,6 +3051,7 @@ export declare const criteriaTreeSchema: z.ZodObject<Pick<{
|
|
|
3049
3051
|
dashboardRenderingType: "per-criteria" | "per-task";
|
|
3050
3052
|
};
|
|
3051
3053
|
version: string;
|
|
3054
|
+
revision: string;
|
|
3052
3055
|
result: {
|
|
3053
3056
|
type?: "number" | "boolean" | "percentage" | undefined;
|
|
3054
3057
|
total?: number | undefined;
|
|
@@ -65,6 +65,7 @@ export declare const elementDataMapSchema: z.ZodRecord<z.ZodString, z.ZodUnion<[
|
|
|
65
65
|
}>>]>>;
|
|
66
66
|
export declare const dataMapSchema: z.ZodObject<{
|
|
67
67
|
version: z.ZodString;
|
|
68
|
+
revision: z.ZodString;
|
|
68
69
|
elements: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<{
|
|
69
70
|
type: z.ZodOptional<z.ZodEnum<["number", "percentage", "boolean"]>>;
|
|
70
71
|
value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
|
|
@@ -184,6 +185,7 @@ export declare const dataMapSchema: z.ZodObject<{
|
|
|
184
185
|
valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
|
|
185
186
|
})>;
|
|
186
187
|
version: string;
|
|
188
|
+
revision: string;
|
|
187
189
|
result: {
|
|
188
190
|
type?: "number" | "boolean" | "percentage" | undefined;
|
|
189
191
|
total?: number | undefined;
|
|
@@ -223,6 +225,7 @@ export declare const dataMapSchema: z.ZodObject<{
|
|
|
223
225
|
valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
|
|
224
226
|
})>;
|
|
225
227
|
version: string;
|
|
228
|
+
revision: string;
|
|
226
229
|
result: {
|
|
227
230
|
type?: "number" | "boolean" | "percentage" | undefined;
|
|
228
231
|
total?: number | undefined;
|
|
@@ -11,6 +11,7 @@ exports.dataMapSchema = zod_1.z
|
|
|
11
11
|
version: zod_1.z
|
|
12
12
|
.string()
|
|
13
13
|
.describe("The version of the criteria set used to generate the data map"),
|
|
14
|
+
revision: zod_1.z.string().describe("The internal version of this criteria set"),
|
|
14
15
|
elements: exports.elementDataMapSchema
|
|
15
16
|
.describe("The data map consisting of a map of element codes to their data"),
|
|
16
17
|
result: common_1.treeResultSchema.describe("The overall result of the evaluation of the criteria set"),
|
|
@@ -13,6 +13,7 @@ export declare const schemaDefinitionsSchema: z.ZodObject<{
|
|
|
13
13
|
export declare const metadataSchema: z.ZodObject<{
|
|
14
14
|
id: z.ZodString;
|
|
15
15
|
version: z.ZodString;
|
|
16
|
+
revision: z.ZodString;
|
|
16
17
|
date: z.ZodDate;
|
|
17
18
|
name: z.ZodString;
|
|
18
19
|
description: z.ZodString;
|
|
@@ -35,6 +36,7 @@ export declare const metadataSchema: z.ZodObject<{
|
|
|
35
36
|
description: string;
|
|
36
37
|
date: Date;
|
|
37
38
|
version: string;
|
|
39
|
+
revision: string;
|
|
38
40
|
documentation?: string | undefined;
|
|
39
41
|
locales?: string[] | undefined;
|
|
40
42
|
defaultLocale?: string | undefined;
|
|
@@ -48,6 +50,7 @@ export declare const metadataSchema: z.ZodObject<{
|
|
|
48
50
|
description: string;
|
|
49
51
|
date: Date;
|
|
50
52
|
version: string;
|
|
53
|
+
revision: string;
|
|
51
54
|
documentation?: string | undefined;
|
|
52
55
|
locales?: string[] | undefined;
|
|
53
56
|
defaultLocale?: string | undefined;
|
|
@@ -19,6 +19,7 @@ exports.metadataSchema = zod_1.z
|
|
|
19
19
|
version: zod_1.z
|
|
20
20
|
.string()
|
|
21
21
|
.describe("The version of the criteria set being retrieved"),
|
|
22
|
+
revision: zod_1.z.string().describe("The internal version of this criteria set"),
|
|
22
23
|
date: zod_1.z.date().describe("The date when the criteria set was created"),
|
|
23
24
|
name: zod_1.z.string().describe("The name of the criteria set"),
|
|
24
25
|
description: zod_1.z
|
|
@@ -2,6 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
export declare const criteriaSetsAndVersionsSchema: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
|
|
3
3
|
id: z.ZodString;
|
|
4
4
|
version: z.ZodString;
|
|
5
|
+
revision: z.ZodString;
|
|
5
6
|
date: z.ZodDate;
|
|
6
7
|
name: z.ZodString;
|
|
7
8
|
description: z.ZodString;
|
|
@@ -24,6 +25,7 @@ export declare const criteriaSetsAndVersionsSchema: z.ZodRecord<z.ZodString, z.Z
|
|
|
24
25
|
description: string;
|
|
25
26
|
date: Date;
|
|
26
27
|
version: string;
|
|
28
|
+
revision: string;
|
|
27
29
|
documentation?: string | undefined;
|
|
28
30
|
locales?: string[] | undefined;
|
|
29
31
|
defaultLocale?: string | undefined;
|
|
@@ -37,6 +39,7 @@ export declare const criteriaSetsAndVersionsSchema: z.ZodRecord<z.ZodString, z.Z
|
|
|
37
39
|
description: string;
|
|
38
40
|
date: Date;
|
|
39
41
|
version: string;
|
|
42
|
+
revision: string;
|
|
40
43
|
documentation?: string | undefined;
|
|
41
44
|
locales?: string[] | undefined;
|
|
42
45
|
defaultLocale?: string | undefined;
|
|
@@ -11,7 +11,7 @@ export interface CriteriaSetService<ParametersType extends Record<string, any> |
|
|
|
11
11
|
id: string;
|
|
12
12
|
version: string;
|
|
13
13
|
validateParameters(parameters: ParametersType): Promise<void>;
|
|
14
|
-
getMetadata(): Metadata
|
|
14
|
+
getMetadata(): Promise<Metadata>;
|
|
15
15
|
getDataMap(parameters: TreeAndMapParameters<ParametersType>): Promise<DataMap>;
|
|
16
16
|
getCriteriaTree(parameters: TreeAndMapParameters<ParametersType>): Promise<CriteriaTree>;
|
|
17
17
|
streamMatrix(parameters: MatrixParameters<ParametersType>): Promise<StreamMatrixResponse>;
|
package/package.json
CHANGED