@openframe-org/criteria-set-protocol 2.2.19 → 2.3.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.
Files changed (8) hide show
  1. package/dist/v1/schemas/common.d.ts +6 -0
  2. package/dist/v1/schemas/common.js +3 -1
  3. package/dist/v1/schemas/criteria-tree.d.ts +8 -0
  4. package/dist/v1/schemas/data-map.d.ts +8 -0
  5. package/dist/v1/schemas/metadata.d.ts +3 -0
  6. package/dist/v1/schemas/metadata.js +1 -0
  7. package/dist/v1/schemas/response.d.ts +3 -0
  8. package/package.json +1 -1
package/dist/v1/schemas/common.d.ts CHANGED
@@ -250,6 +250,8 @@ export declare const treeResultSchema: z.ZodObject<{
250
250
  minimumValue: z.ZodOptional<z.ZodNumber>;
251
251
  exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
252
252
  exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
253
+ } & {
254
+ percentage: z.ZodNumber;
253
255
  }, "strip", z.ZodAny, z.objectOutputType<{
254
256
  type: z.ZodOptional<z.ZodEnum<["number", "percentage", "boolean"]>>;
255
257
  value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
@@ -259,6 +261,8 @@ export declare const treeResultSchema: z.ZodObject<{
259
261
  minimumValue: z.ZodOptional<z.ZodNumber>;
260
262
  exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
261
263
  exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
264
+ } & {
265
+ percentage: z.ZodNumber;
262
266
  }, z.ZodAny, "strip">, z.objectInputType<{
263
267
  type: z.ZodOptional<z.ZodEnum<["number", "percentage", "boolean"]>>;
264
268
  value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
@@ -268,4 +272,6 @@ export declare const treeResultSchema: z.ZodObject<{
268
272
  minimumValue: z.ZodOptional<z.ZodNumber>;
269
273
  exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
270
274
  exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
275
+ } & {
276
+ percentage: z.ZodNumber;
271
277
  }, z.ZodAny, "strip">>;
package/dist/v1/schemas/common.js CHANGED
@@ -121,4 +121,6 @@ exports.reportOptionsSchema = zod_1.z
121
121
  .optional()
122
122
  .describe("The format of the report row text, use ':code:' and ':title:' to define where the code and/or title should be inserted, if not provided only the title will be rendered")
123
123
  });
124
- exports.treeResultSchema = exports.elementDataSchema.describe("TreeResult - The result of the evaluation of a criteria set");
124
+ exports.treeResultSchema = exports.elementDataSchema.extend({
125
+ percentage: zod_1.z.number().min(0).max(1).describe("Result as a percentage of the total"),
126
+ }).describe("TreeResult - The result of the evaluation of a criteria set");
package/dist/v1/schemas/criteria-tree.d.ts CHANGED
@@ -75,6 +75,8 @@ export declare const criteriaTreeSchema: z.ZodObject<Pick<{
75
75
  minimumValue: z.ZodOptional<z.ZodNumber>;
76
76
  exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
77
77
  exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
78
+ } & {
79
+ percentage: z.ZodNumber;
78
80
  }, "strip", z.ZodAny, z.objectOutputType<{
79
81
  type: z.ZodOptional<z.ZodEnum<["number", "percentage", "boolean"]>>;
80
82
  value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
@@ -84,6 +86,8 @@ export declare const criteriaTreeSchema: z.ZodObject<Pick<{
84
86
  minimumValue: z.ZodOptional<z.ZodNumber>;
85
87
  exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
86
88
  exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
89
+ } & {
90
+ percentage: z.ZodNumber;
87
91
  }, z.ZodAny, "strip">, z.objectInputType<{
88
92
  type: z.ZodOptional<z.ZodEnum<["number", "percentage", "boolean"]>>;
89
93
  value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
@@ -93,6 +97,8 @@ export declare const criteriaTreeSchema: z.ZodObject<Pick<{
93
97
  minimumValue: z.ZodOptional<z.ZodNumber>;
94
98
  exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
95
99
  exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
100
+ } & {
101
+ percentage: z.ZodNumber;
96
102
  }, z.ZodAny, "strip">>;
97
103
  certifications: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
98
104
  }, "version" | "revision" | "result" | "certifications"> & {
@@ -2729,6 +2735,7 @@ export declare const criteriaTreeSchema: z.ZodObject<Pick<{
2729
2735
  version: string;
2730
2736
  revision: string;
2731
2737
  result: {
2738
+ percentage: number;
2732
2739
  type?: "number" | "boolean" | "percentage" | undefined;
2733
2740
  total?: number | undefined;
2734
2741
  value?: number | boolean | undefined;
@@ -3053,6 +3060,7 @@ export declare const criteriaTreeSchema: z.ZodObject<Pick<{
3053
3060
  version: string;
3054
3061
  revision: string;
3055
3062
  result: {
3063
+ percentage: number;
3056
3064
  type?: "number" | "boolean" | "percentage" | undefined;
3057
3065
  total?: number | undefined;
3058
3066
  value?: number | boolean | undefined;
package/dist/v1/schemas/data-map.d.ts CHANGED
@@ -139,6 +139,8 @@ export declare const dataMapSchema: z.ZodObject<{
139
139
  minimumValue: z.ZodOptional<z.ZodNumber>;
140
140
  exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
141
141
  exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
142
+ } & {
143
+ percentage: z.ZodNumber;
142
144
  }, "strip", z.ZodAny, z.objectOutputType<{
143
145
  type: z.ZodOptional<z.ZodEnum<["number", "percentage", "boolean"]>>;
144
146
  value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
@@ -148,6 +150,8 @@ export declare const dataMapSchema: z.ZodObject<{
148
150
  minimumValue: z.ZodOptional<z.ZodNumber>;
149
151
  exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
150
152
  exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
153
+ } & {
154
+ percentage: z.ZodNumber;
151
155
  }, z.ZodAny, "strip">, z.objectInputType<{
152
156
  type: z.ZodOptional<z.ZodEnum<["number", "percentage", "boolean"]>>;
153
157
  value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
@@ -157,6 +161,8 @@ export declare const dataMapSchema: z.ZodObject<{
157
161
  minimumValue: z.ZodOptional<z.ZodNumber>;
158
162
  exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
159
163
  exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
164
+ } & {
165
+ percentage: z.ZodNumber;
160
166
  }, z.ZodAny, "strip">>;
161
167
  certifications: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
162
168
  }, "strip", z.ZodTypeAny, {
@@ -187,6 +193,7 @@ export declare const dataMapSchema: z.ZodObject<{
187
193
  version: string;
188
194
  revision: string;
189
195
  result: {
196
+ percentage: number;
190
197
  type?: "number" | "boolean" | "percentage" | undefined;
191
198
  total?: number | undefined;
192
199
  value?: number | boolean | undefined;
@@ -227,6 +234,7 @@ export declare const dataMapSchema: z.ZodObject<{
227
234
  version: string;
228
235
  revision: string;
229
236
  result: {
237
+ percentage: number;
230
238
  type?: "number" | "boolean" | "percentage" | undefined;
231
239
  total?: number | undefined;
232
240
  value?: number | boolean | undefined;
package/dist/v1/schemas/metadata.d.ts CHANGED
@@ -19,6 +19,7 @@ export declare const metadataSchema: z.ZodObject<{
19
19
  revision: z.ZodString;
20
20
  date: z.ZodDate;
21
21
  name: z.ZodString;
22
+ shortName: z.ZodString;
22
23
  description: z.ZodString;
23
24
  documentation: z.ZodOptional<z.ZodString>;
24
25
  locales: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
@@ -43,6 +44,7 @@ export declare const metadataSchema: z.ZodObject<{
43
44
  date: Date;
44
45
  version: string;
45
46
  revision: string;
47
+ shortName: string;
46
48
  documentation?: string | undefined;
47
49
  locales?: string[] | undefined;
48
50
  defaultLocale?: string | undefined;
@@ -58,6 +60,7 @@ export declare const metadataSchema: z.ZodObject<{
58
60
  date: Date;
59
61
  version: string;
60
62
  revision: string;
63
+ shortName: string;
61
64
  documentation?: string | undefined;
62
65
  locales?: string[] | undefined;
63
66
  defaultLocale?: string | undefined;
package/dist/v1/schemas/metadata.js CHANGED
@@ -25,6 +25,7 @@ exports.metadataSchema = zod_1.z
25
25
  revision: zod_1.z.string().describe("The internal version of this criteria set"),
26
26
  date: zod_1.z.date().describe("The date when the criteria set was created"),
27
27
  name: zod_1.z.string().describe("The name of the criteria set"),
28
+ shortName: zod_1.z.string().describe("A short version of the name of the criteria set"),
28
29
  description: zod_1.z
29
30
  .string()
30
31
  .describe("A detailed description of the criteria set"),
package/dist/v1/schemas/response.d.ts CHANGED
@@ -5,6 +5,7 @@ export declare const criteriaSetsAndVersionsSchema: z.ZodRecord<z.ZodString, z.Z
5
5
  revision: z.ZodString;
6
6
  date: z.ZodDate;
7
7
  name: z.ZodString;
8
+ shortName: z.ZodString;
8
9
  description: z.ZodString;
9
10
  documentation: z.ZodOptional<z.ZodString>;
10
11
  locales: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
@@ -29,6 +30,7 @@ export declare const criteriaSetsAndVersionsSchema: z.ZodRecord<z.ZodString, z.Z
29
30
  date: Date;
30
31
  version: string;
31
32
  revision: string;
33
+ shortName: string;
32
34
  documentation?: string | undefined;
33
35
  locales?: string[] | undefined;
34
36
  defaultLocale?: string | undefined;
@@ -44,6 +46,7 @@ export declare const criteriaSetsAndVersionsSchema: z.ZodRecord<z.ZodString, z.Z
44
46
  date: Date;
45
47
  version: string;
46
48
  revision: string;
49
+ shortName: string;
47
50
  documentation?: string | undefined;
48
51
  locales?: string[] | undefined;
49
52
  defaultLocale?: string | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openframe-org/criteria-set-protocol",
3
- "version": "2.2.19",
3
+ "version": "2.3.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>",