@openframe-org/criteria-set-protocol 2.5.0 → 3.0.0-alpha.3

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 (27) hide show
  1. package/dist/v1/schemas/certification.d.ts +86 -44
  2. package/dist/v1/schemas/certification.js +29 -9
  3. package/dist/v1/schemas/common.d.ts +30 -36
  4. package/dist/v1/schemas/common.js +18 -26
  5. package/dist/v1/schemas/criteria-tree.d.ts +500 -528
  6. package/dist/v1/schemas/criteria-tree.js +1 -1
  7. package/dist/v1/schemas/criterion.d.ts +92 -100
  8. package/dist/v1/schemas/criterion.js +1 -1
  9. package/dist/v1/schemas/data-map.d.ts +40 -50
  10. package/dist/v1/schemas/data-map.js +1 -1
  11. package/dist/v1/schemas/metadata.d.ts +10 -10
  12. package/dist/v1/schemas/metadata.js +7 -7
  13. package/dist/v1/schemas/request/matrix-request-body-schema.d.ts +5 -5
  14. package/dist/v1/schemas/request/matrix-request-body-schema.js +5 -5
  15. package/dist/v1/schemas/request/tree-and-data-request-body-schema.d.ts +4 -4
  16. package/dist/v1/schemas/request/tree-and-data-request-body-schema.js +4 -4
  17. package/dist/v1/schemas/response.d.ts +7 -7
  18. package/dist/v1/schemas/task-group.d.ts +69 -75
  19. package/dist/v1/schemas/task-group.js +2 -2
  20. package/dist/v1/schemas/task-item.d.ts +109 -113
  21. package/dist/v1/schemas/task-item.js +23 -23
  22. package/dist/v1/schemas/task.d.ts +58 -62
  23. package/dist/v1/schemas/task.js +2 -2
  24. package/dist/v1/schemas/theme.d.ts +110 -120
  25. package/dist/v1/schemas/theme.js +2 -2
  26. package/dist/v1/utils.js +4 -7
  27. package/package.json +1 -1
package/dist/v1/schemas/criteria-tree.js CHANGED
@@ -23,7 +23,7 @@ exports.criteriaTreeSchema = data_map_1.dataMapSchema
23
23
  .describe("Themes, the top-level layer of the tree"),
24
24
  certificationDefinitions: zod_1.z
25
25
  .array(certification_1.certificationDefinitionSchema)
26
- .optional()
26
+ .nullable()
27
27
  .describe("Definitions of the attainable certifications"),
28
28
  options: criteria_set_1.criteriaSetOptionsSchema.describe("Configuration options for the criteria set display and behavior"),
29
29
  });
package/dist/v1/schemas/criterion.d.ts CHANGED
@@ -1,29 +1,29 @@
1
1
  import { z } from "zod";
2
2
  export declare const criterionOptionsSchema: z.ZodIntersection<z.ZodIntersection<z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
3
- hideCodeInReport: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
3
+ hideCodeInReport: z.ZodDefault<z.ZodNullable<z.ZodBoolean>>;
4
4
  }, z.core.$strip>, z.ZodUnion<[z.ZodObject<{
5
5
  hideFromBreadcrumbs: z.ZodLiteral<true>;
6
- breadcrumbTextFormat: z.ZodOptional<z.ZodNever>;
6
+ breadcrumbTextFormat: z.ZodNullable<z.ZodNever>;
7
7
  }, z.core.$strip>, z.ZodObject<{
8
- hideFromBreadcrumbs: z.ZodDefault<z.ZodOptional<z.ZodLiteral<false>>>;
8
+ hideFromBreadcrumbs: z.ZodDefault<z.ZodNullable<z.ZodLiteral<false>>>;
9
9
  breadcrumbTextFormat: z.ZodString;
10
10
  }, z.core.$strip>]>>, z.ZodUnion<[z.ZodObject<{
11
11
  hideFromDocumentTree: z.ZodLiteral<true>;
12
- documentTreeFolderTextFormat: z.ZodOptional<z.ZodNever>;
12
+ documentTreeFolderTextFormat: z.ZodNullable<z.ZodNever>;
13
13
  }, z.core.$strip>, z.ZodObject<{
14
- hideFromDocumentTree: z.ZodOptional<z.ZodLiteral<false>>;
14
+ hideFromDocumentTree: z.ZodNullable<z.ZodLiteral<false>>;
15
15
  documentTreeFolderTextFormat: z.ZodString;
16
16
  }, z.core.$strip>]>>, z.ZodObject<{
17
17
  criteriaTreeElementTextFormat: z.ZodString;
18
18
  }, z.core.$strip>>, z.ZodObject<{
19
- reportTitleTextFormat: z.ZodOptional<z.ZodString>;
19
+ reportTitleTextFormat: z.ZodNullable<z.ZodString>;
20
20
  }, z.core.$strip>>;
21
21
  export declare const criterionSchema: z.ZodObject<{
22
22
  title: z.ZodString;
23
23
  longFormTitle: z.ZodString;
24
24
  code: z.ZodString;
25
- tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
26
- documentation: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
25
+ tags: z.ZodNullable<z.ZodArray<z.ZodString>>;
26
+ documentation: z.ZodNullable<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
27
27
  label: z.ZodString;
28
28
  text: z.ZodString;
29
29
  type: z.ZodLiteral<"pdf">;
@@ -38,29 +38,27 @@ export declare const criterionSchema: z.ZodObject<{
38
38
  type: z.ZodLiteral<"link">;
39
39
  url: z.ZodString;
40
40
  }, z.core.$strip>], "type">>>;
41
- data: z.ZodOptional<z.ZodObject<{
42
- type: z.ZodOptional<z.ZodEnum<{
41
+ data: z.ZodNullable<z.ZodObject<{
42
+ type: z.ZodNullable<z.ZodEnum<{
43
43
  number: "number";
44
44
  boolean: "boolean";
45
45
  percentage: "percentage";
46
46
  }>>;
47
- value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
48
- text: z.ZodOptional<z.ZodString>;
49
- total: z.ZodOptional<z.ZodNumber>;
50
- maximumValue: z.ZodOptional<z.ZodNumber>;
51
- minimumValue: z.ZodOptional<z.ZodNumber>;
52
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
53
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
54
- weight: z.ZodOptional<z.ZodNumber>;
47
+ value: z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
48
+ text: z.ZodNullable<z.ZodString>;
49
+ total: z.ZodNullable<z.ZodNumber>;
50
+ maximumValue: z.ZodNullable<z.ZodNumber>;
51
+ minimumValue: z.ZodNullable<z.ZodNumber>;
52
+ weight: z.ZodNullable<z.ZodNumber>;
55
53
  }, z.core.$catchall<z.ZodAny>>>;
56
- sortOrder: z.ZodOptional<z.ZodNumber>;
54
+ sortOrder: z.ZodNullable<z.ZodNumber>;
57
55
  type: z.ZodLiteral<"criterion">;
58
56
  items: z.ZodArray<z.ZodLazy<z.ZodObject<{
59
57
  title: z.ZodString;
60
58
  longFormTitle: z.ZodString;
61
59
  code: z.ZodString;
62
- tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
63
- documentation: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
60
+ tags: z.ZodNullable<z.ZodArray<z.ZodString>>;
61
+ documentation: z.ZodNullable<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
64
62
  label: z.ZodString;
65
63
  text: z.ZodString;
66
64
  type: z.ZodLiteral<"pdf">;
@@ -75,31 +73,29 @@ export declare const criterionSchema: z.ZodObject<{
75
73
  type: z.ZodLiteral<"link">;
76
74
  url: z.ZodString;
77
75
  }, z.core.$strip>], "type">>>;
78
- data: z.ZodOptional<z.ZodObject<{
79
- type: z.ZodOptional<z.ZodEnum<{
76
+ data: z.ZodNullable<z.ZodObject<{
77
+ type: z.ZodNullable<z.ZodEnum<{
80
78
  number: "number";
81
79
  boolean: "boolean";
82
80
  percentage: "percentage";
83
81
  }>>;
84
- value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
85
- text: z.ZodOptional<z.ZodString>;
86
- total: z.ZodOptional<z.ZodNumber>;
87
- maximumValue: z.ZodOptional<z.ZodNumber>;
88
- minimumValue: z.ZodOptional<z.ZodNumber>;
89
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
90
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
91
- weight: z.ZodOptional<z.ZodNumber>;
82
+ value: z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
83
+ text: z.ZodNullable<z.ZodString>;
84
+ total: z.ZodNullable<z.ZodNumber>;
85
+ maximumValue: z.ZodNullable<z.ZodNumber>;
86
+ minimumValue: z.ZodNullable<z.ZodNumber>;
87
+ weight: z.ZodNullable<z.ZodNumber>;
92
88
  }, z.core.$catchall<z.ZodAny>>>;
93
- sortOrder: z.ZodOptional<z.ZodNumber>;
89
+ sortOrder: z.ZodNullable<z.ZodNumber>;
94
90
  type: z.ZodLiteral<"task-group">;
95
- description: z.ZodOptional<z.ZodString>;
96
- category: z.ZodOptional<z.ZodString>;
91
+ description: z.ZodNullable<z.ZodString>;
92
+ category: z.ZodNullable<z.ZodString>;
97
93
  items: z.ZodArray<z.ZodLazy<z.ZodObject<{
98
94
  title: z.ZodString;
99
95
  longFormTitle: z.ZodString;
100
96
  code: z.ZodString;
101
- tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
102
- documentation: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
97
+ tags: z.ZodNullable<z.ZodArray<z.ZodString>>;
98
+ documentation: z.ZodNullable<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
103
99
  label: z.ZodString;
104
100
  text: z.ZodString;
105
101
  type: z.ZodLiteral<"pdf">;
@@ -114,28 +110,26 @@ export declare const criterionSchema: z.ZodObject<{
114
110
  type: z.ZodLiteral<"link">;
115
111
  url: z.ZodString;
116
112
  }, z.core.$strip>], "type">>>;
117
- data: z.ZodOptional<z.ZodObject<{
118
- type: z.ZodOptional<z.ZodEnum<{
113
+ data: z.ZodNullable<z.ZodObject<{
114
+ type: z.ZodNullable<z.ZodEnum<{
119
115
  number: "number";
120
116
  boolean: "boolean";
121
117
  percentage: "percentage";
122
118
  }>>;
123
- value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
124
- text: z.ZodOptional<z.ZodString>;
125
- total: z.ZodOptional<z.ZodNumber>;
126
- maximumValue: z.ZodOptional<z.ZodNumber>;
127
- minimumValue: z.ZodOptional<z.ZodNumber>;
128
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
129
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
130
- weight: z.ZodOptional<z.ZodNumber>;
119
+ value: z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
120
+ text: z.ZodNullable<z.ZodString>;
121
+ total: z.ZodNullable<z.ZodNumber>;
122
+ maximumValue: z.ZodNullable<z.ZodNumber>;
123
+ minimumValue: z.ZodNullable<z.ZodNumber>;
124
+ weight: z.ZodNullable<z.ZodNumber>;
131
125
  }, z.core.$catchall<z.ZodAny>>>;
132
- sortOrder: z.ZodOptional<z.ZodNumber>;
126
+ sortOrder: z.ZodNullable<z.ZodNumber>;
133
127
  type: z.ZodLiteral<"task">;
134
- description: z.ZodOptional<z.ZodString>;
128
+ description: z.ZodNullable<z.ZodString>;
135
129
  items: z.ZodArray<z.ZodLazy<z.ZodObject<{
136
130
  code: z.ZodString;
137
- tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
138
- documentation: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
131
+ tags: z.ZodNullable<z.ZodArray<z.ZodString>>;
132
+ documentation: z.ZodNullable<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
139
133
  label: z.ZodString;
140
134
  text: z.ZodString;
141
135
  type: z.ZodLiteral<"pdf">;
@@ -150,105 +144,103 @@ export declare const criterionSchema: z.ZodObject<{
150
144
  type: z.ZodLiteral<"link">;
151
145
  url: z.ZodString;
152
146
  }, z.core.$strip>], "type">>>;
153
- sortOrder: z.ZodOptional<z.ZodNumber>;
147
+ sortOrder: z.ZodNullable<z.ZodNumber>;
154
148
  type: z.ZodLiteral<"task-item">;
155
- data: z.ZodOptional<z.ZodIntersection<z.ZodObject<{
156
- type: z.ZodOptional<z.ZodEnum<{
149
+ data: z.ZodNullable<z.ZodIntersection<z.ZodObject<{
150
+ type: z.ZodNullable<z.ZodEnum<{
157
151
  number: "number";
158
152
  boolean: "boolean";
159
153
  percentage: "percentage";
160
154
  }>>;
161
- value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
162
- text: z.ZodOptional<z.ZodString>;
163
- total: z.ZodOptional<z.ZodNumber>;
164
- maximumValue: z.ZodOptional<z.ZodNumber>;
165
- minimumValue: z.ZodOptional<z.ZodNumber>;
166
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
167
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
168
- weight: z.ZodOptional<z.ZodNumber>;
155
+ value: z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
156
+ text: z.ZodNullable<z.ZodString>;
157
+ total: z.ZodNullable<z.ZodNumber>;
158
+ maximumValue: z.ZodNullable<z.ZodNumber>;
159
+ minimumValue: z.ZodNullable<z.ZodNumber>;
160
+ weight: z.ZodNullable<z.ZodNumber>;
169
161
  }, z.core.$catchall<z.ZodAny>>, z.ZodObject<{
170
- readOnly: z.ZodOptional<z.ZodBoolean>;
171
- valueReference: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>;
162
+ readOnly: z.ZodNullable<z.ZodBoolean>;
163
+ valueReference: z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>;
172
164
  }, z.core.$strip>>>;
173
165
  definition: z.ZodDiscriminatedUnion<[z.ZodObject<{
174
- label: z.ZodOptional<z.ZodString>;
175
- readOnly: z.ZodOptional<z.ZodBoolean>;
166
+ label: z.ZodNullable<z.ZodString>;
167
+ readOnly: z.ZodNullable<z.ZodBoolean>;
176
168
  type: z.ZodLiteral<"select-single">;
177
- minimum: z.ZodOptional<z.ZodNumber>;
178
- maximum: z.ZodOptional<z.ZodNumber>;
169
+ minimum: z.ZodNullable<z.ZodNumber>;
170
+ maximum: z.ZodNullable<z.ZodNumber>;
179
171
  options: z.ZodArray<z.ZodObject<{
180
- id: z.ZodOptional<z.ZodString>;
172
+ id: z.ZodNullable<z.ZodString>;
181
173
  text: z.ZodString;
182
- intro: z.ZodOptional<z.ZodString>;
183
- outro: z.ZodOptional<z.ZodString>;
174
+ intro: z.ZodNullable<z.ZodString>;
175
+ outro: z.ZodNullable<z.ZodString>;
184
176
  value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>;
185
177
  }, z.core.$strip>>;
186
- defaultValue: z.ZodOptional<z.ZodString>;
178
+ defaultValue: z.ZodNullable<z.ZodString>;
187
179
  }, z.core.$strip>, z.ZodObject<{
188
- label: z.ZodOptional<z.ZodString>;
189
- readOnly: z.ZodOptional<z.ZodBoolean>;
180
+ label: z.ZodNullable<z.ZodString>;
181
+ readOnly: z.ZodNullable<z.ZodBoolean>;
190
182
  type: z.ZodLiteral<"select-multiple">;
191
- minimum: z.ZodOptional<z.ZodNumber>;
192
- maximum: z.ZodOptional<z.ZodNumber>;
183
+ minimum: z.ZodNullable<z.ZodNumber>;
184
+ maximum: z.ZodNullable<z.ZodNumber>;
193
185
  options: z.ZodArray<z.ZodObject<{
194
- id: z.ZodOptional<z.ZodString>;
186
+ id: z.ZodNullable<z.ZodString>;
195
187
  text: z.ZodString;
196
- intro: z.ZodOptional<z.ZodString>;
197
- outro: z.ZodOptional<z.ZodString>;
188
+ intro: z.ZodNullable<z.ZodString>;
189
+ outro: z.ZodNullable<z.ZodString>;
198
190
  value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>;
199
191
  }, z.core.$strip>>;
200
- defaultValue: z.ZodOptional<z.ZodArray<z.ZodString>>;
192
+ defaultValue: z.ZodNullable<z.ZodArray<z.ZodString>>;
201
193
  }, z.core.$strip>, z.ZodObject<{
202
- label: z.ZodOptional<z.ZodString>;
203
- readOnly: z.ZodOptional<z.ZodBoolean>;
204
- type: z.ZodOptional<z.ZodLiteral<"number">>;
205
- minimum: z.ZodOptional<z.ZodNumber>;
206
- maximum: z.ZodOptional<z.ZodNumber>;
207
- step: z.ZodOptional<z.ZodNumber>;
208
- defaultValue: z.ZodOptional<z.ZodNumber>;
194
+ label: z.ZodNullable<z.ZodString>;
195
+ readOnly: z.ZodNullable<z.ZodBoolean>;
196
+ type: z.ZodNullable<z.ZodLiteral<"number">>;
197
+ minimum: z.ZodNullable<z.ZodNumber>;
198
+ maximum: z.ZodNullable<z.ZodNumber>;
199
+ step: z.ZodNullable<z.ZodNumber>;
200
+ defaultValue: z.ZodNullable<z.ZodNumber>;
209
201
  }, z.core.$strip>, z.ZodObject<{
210
- label: z.ZodOptional<z.ZodString>;
211
- readOnly: z.ZodOptional<z.ZodBoolean>;
202
+ label: z.ZodNullable<z.ZodString>;
203
+ readOnly: z.ZodNullable<z.ZodBoolean>;
212
204
  type: z.ZodLiteral<"boolean">;
213
- labels: z.ZodOptional<z.ZodObject<{
205
+ labels: z.ZodNullable<z.ZodObject<{
214
206
  true: z.ZodString;
215
207
  false: z.ZodString;
216
208
  }, z.core.$strip>>;
217
- defaultValue: z.ZodOptional<z.ZodBoolean>;
209
+ defaultValue: z.ZodNullable<z.ZodBoolean>;
218
210
  }, z.core.$strip>], "type">;
219
- description: z.ZodOptional<z.ZodString>;
211
+ description: z.ZodNullable<z.ZodString>;
220
212
  options: z.ZodObject<{
221
- excludeFromTargets: z.ZodOptional<z.ZodBoolean>;
213
+ excludeFromTargets: z.ZodNullable<z.ZodBoolean>;
222
214
  }, z.core.$strip>;
223
215
  }, z.core.$strip>>>;
224
216
  options: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
225
217
  breadcrumbTextFormat: z.ZodString;
226
218
  documentTreeFolderTextFormat: z.ZodString;
227
- showCodeAsIndicatorTaskViewTitle: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
219
+ showCodeAsIndicatorTaskViewTitle: z.ZodDefault<z.ZodNullable<z.ZodBoolean>>;
228
220
  }, z.core.$strip>, z.ZodObject<{
229
221
  criteriaTreeElementTextFormat: z.ZodString;
230
222
  }, z.core.$strip>>, z.ZodObject<{
231
- reportTitleTextFormat: z.ZodOptional<z.ZodString>;
223
+ reportTitleTextFormat: z.ZodNullable<z.ZodString>;
232
224
  }, z.core.$strip>>;
233
225
  }, z.core.$strip>>>;
234
226
  }, z.core.$strip>>>;
235
227
  options: z.ZodIntersection<z.ZodIntersection<z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
236
- hideCodeInReport: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
228
+ hideCodeInReport: z.ZodDefault<z.ZodNullable<z.ZodBoolean>>;
237
229
  }, z.core.$strip>, z.ZodUnion<[z.ZodObject<{
238
230
  hideFromBreadcrumbs: z.ZodLiteral<true>;
239
- breadcrumbTextFormat: z.ZodOptional<z.ZodNever>;
231
+ breadcrumbTextFormat: z.ZodNullable<z.ZodNever>;
240
232
  }, z.core.$strip>, z.ZodObject<{
241
- hideFromBreadcrumbs: z.ZodDefault<z.ZodOptional<z.ZodLiteral<false>>>;
233
+ hideFromBreadcrumbs: z.ZodDefault<z.ZodNullable<z.ZodLiteral<false>>>;
242
234
  breadcrumbTextFormat: z.ZodString;
243
235
  }, z.core.$strip>]>>, z.ZodUnion<[z.ZodObject<{
244
236
  hideFromDocumentTree: z.ZodLiteral<true>;
245
- documentTreeFolderTextFormat: z.ZodOptional<z.ZodNever>;
237
+ documentTreeFolderTextFormat: z.ZodNullable<z.ZodNever>;
246
238
  }, z.core.$strip>, z.ZodObject<{
247
- hideFromDocumentTree: z.ZodOptional<z.ZodLiteral<false>>;
239
+ hideFromDocumentTree: z.ZodNullable<z.ZodLiteral<false>>;
248
240
  documentTreeFolderTextFormat: z.ZodString;
249
241
  }, z.core.$strip>]>>, z.ZodObject<{
250
242
  criteriaTreeElementTextFormat: z.ZodString;
251
243
  }, z.core.$strip>>, z.ZodObject<{
252
- reportTitleTextFormat: z.ZodOptional<z.ZodString>;
244
+ reportTitleTextFormat: z.ZodNullable<z.ZodString>;
253
245
  }, z.core.$strip>>;
254
246
  }, z.core.$strip>;
package/dist/v1/schemas/criterion.js CHANGED
@@ -8,7 +8,7 @@ exports.criterionOptionsSchema = zod_1.z
8
8
  .object({
9
9
  hideCodeInReport: zod_1.z
10
10
  .boolean()
11
- .optional()
11
+ .nullable()
12
12
  .default(false)
13
13
  .describe("Whether to hide the criterion code in the generated PDF report"),
14
14
  })
package/dist/v1/schemas/data-map.d.ts CHANGED
@@ -1,85 +1,75 @@
1
1
  import { z } from "zod";
2
2
  export declare const elementDataMapSchema: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<{
3
- type: z.ZodOptional<z.ZodEnum<{
3
+ type: z.ZodNullable<z.ZodEnum<{
4
4
  number: "number";
5
5
  boolean: "boolean";
6
6
  percentage: "percentage";
7
7
  }>>;
8
- value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
9
- text: z.ZodOptional<z.ZodString>;
10
- total: z.ZodOptional<z.ZodNumber>;
11
- maximumValue: z.ZodOptional<z.ZodNumber>;
12
- minimumValue: z.ZodOptional<z.ZodNumber>;
13
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
14
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
15
- weight: z.ZodOptional<z.ZodNumber>;
8
+ value: z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
9
+ text: z.ZodNullable<z.ZodString>;
10
+ total: z.ZodNullable<z.ZodNumber>;
11
+ maximumValue: z.ZodNullable<z.ZodNumber>;
12
+ minimumValue: z.ZodNullable<z.ZodNumber>;
13
+ weight: z.ZodNullable<z.ZodNumber>;
16
14
  }, z.core.$catchall<z.ZodAny>>, z.ZodIntersection<z.ZodObject<{
17
- type: z.ZodOptional<z.ZodEnum<{
15
+ type: z.ZodNullable<z.ZodEnum<{
18
16
  number: "number";
19
17
  boolean: "boolean";
20
18
  percentage: "percentage";
21
19
  }>>;
22
- value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
23
- text: z.ZodOptional<z.ZodString>;
24
- total: z.ZodOptional<z.ZodNumber>;
25
- maximumValue: z.ZodOptional<z.ZodNumber>;
26
- minimumValue: z.ZodOptional<z.ZodNumber>;
27
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
28
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
29
- weight: z.ZodOptional<z.ZodNumber>;
20
+ value: z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
21
+ text: z.ZodNullable<z.ZodString>;
22
+ total: z.ZodNullable<z.ZodNumber>;
23
+ maximumValue: z.ZodNullable<z.ZodNumber>;
24
+ minimumValue: z.ZodNullable<z.ZodNumber>;
25
+ weight: z.ZodNullable<z.ZodNumber>;
30
26
  }, z.core.$catchall<z.ZodAny>>, z.ZodObject<{
31
- readOnly: z.ZodOptional<z.ZodBoolean>;
32
- valueReference: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>;
27
+ readOnly: z.ZodNullable<z.ZodBoolean>;
28
+ valueReference: z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>;
33
29
  }, z.core.$strip>>]>>;
34
30
  export declare const dataMapSchema: z.ZodObject<{
35
31
  version: z.ZodString;
36
32
  revision: z.ZodString;
37
33
  elements: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<{
38
- type: z.ZodOptional<z.ZodEnum<{
34
+ type: z.ZodNullable<z.ZodEnum<{
39
35
  number: "number";
40
36
  boolean: "boolean";
41
37
  percentage: "percentage";
42
38
  }>>;
43
- value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
44
- text: z.ZodOptional<z.ZodString>;
45
- total: z.ZodOptional<z.ZodNumber>;
46
- maximumValue: z.ZodOptional<z.ZodNumber>;
47
- minimumValue: z.ZodOptional<z.ZodNumber>;
48
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
49
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
50
- weight: z.ZodOptional<z.ZodNumber>;
39
+ value: z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
40
+ text: z.ZodNullable<z.ZodString>;
41
+ total: z.ZodNullable<z.ZodNumber>;
42
+ maximumValue: z.ZodNullable<z.ZodNumber>;
43
+ minimumValue: z.ZodNullable<z.ZodNumber>;
44
+ weight: z.ZodNullable<z.ZodNumber>;
51
45
  }, z.core.$catchall<z.ZodAny>>, z.ZodIntersection<z.ZodObject<{
52
- type: z.ZodOptional<z.ZodEnum<{
46
+ type: z.ZodNullable<z.ZodEnum<{
53
47
  number: "number";
54
48
  boolean: "boolean";
55
49
  percentage: "percentage";
56
50
  }>>;
57
- value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
58
- text: z.ZodOptional<z.ZodString>;
59
- total: z.ZodOptional<z.ZodNumber>;
60
- maximumValue: z.ZodOptional<z.ZodNumber>;
61
- minimumValue: z.ZodOptional<z.ZodNumber>;
62
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
63
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
64
- weight: z.ZodOptional<z.ZodNumber>;
51
+ value: z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
52
+ text: z.ZodNullable<z.ZodString>;
53
+ total: z.ZodNullable<z.ZodNumber>;
54
+ maximumValue: z.ZodNullable<z.ZodNumber>;
55
+ minimumValue: z.ZodNullable<z.ZodNumber>;
56
+ weight: z.ZodNullable<z.ZodNumber>;
65
57
  }, z.core.$catchall<z.ZodAny>>, z.ZodObject<{
66
- readOnly: z.ZodOptional<z.ZodBoolean>;
67
- valueReference: z.ZodOptional<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>;
58
+ readOnly: z.ZodNullable<z.ZodBoolean>;
59
+ valueReference: z.ZodNullable<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>;
68
60
  }, z.core.$strip>>]>>;
69
61
  result: z.ZodObject<{
70
- type: z.ZodOptional<z.ZodEnum<{
62
+ type: z.ZodNullable<z.ZodEnum<{
71
63
  number: "number";
72
64
  boolean: "boolean";
73
65
  percentage: "percentage";
74
66
  }>>;
75
- value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
76
- text: z.ZodOptional<z.ZodString>;
77
- total: z.ZodOptional<z.ZodNumber>;
78
- maximumValue: z.ZodOptional<z.ZodNumber>;
79
- minimumValue: z.ZodOptional<z.ZodNumber>;
80
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
81
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
82
- weight: z.ZodOptional<z.ZodNumber>;
67
+ value: z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
68
+ text: z.ZodNullable<z.ZodString>;
69
+ total: z.ZodNullable<z.ZodNumber>;
70
+ maximumValue: z.ZodNullable<z.ZodNumber>;
71
+ minimumValue: z.ZodNullable<z.ZodNumber>;
72
+ weight: z.ZodNullable<z.ZodNumber>;
83
73
  }, z.core.$catchall<z.ZodAny>>;
84
- certifications: z.ZodOptional<z.ZodArray<z.ZodString>>;
74
+ certifications: z.ZodNullable<z.ZodArray<z.ZodString>>;
85
75
  }, z.core.$strip>;
package/dist/v1/schemas/data-map.js CHANGED
@@ -17,7 +17,7 @@ exports.dataMapSchema = zod_1.z
17
17
  result: common_1.treeResultSchema.describe("The overall result of the evaluation of the criteria set"),
18
18
  certifications: zod_1.z
19
19
  .array(zod_1.z.string())
20
- .optional()
20
+ .nullable()
21
21
  .describe("The attained certifications"),
22
22
  })
23
23
  .describe("DataMap");
package/dist/v1/schemas/metadata.d.ts CHANGED
@@ -1,9 +1,9 @@
1
1
  import { z } from "zod";
2
2
  export declare const schemaDefinitionSchema: z.ZodRecord<z.ZodString, z.ZodAny>;
3
3
  export declare const schemaDefinitionsSchema: z.ZodObject<{
4
- properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
5
- parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
6
- result: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
4
+ properties: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
5
+ parameters: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
6
+ result: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
7
7
  }, z.core.$strip>;
8
8
  export declare const metadataSchema: z.ZodObject<{
9
9
  id: z.ZodString;
@@ -14,12 +14,12 @@ export declare const metadataSchema: z.ZodObject<{
14
14
  shortName: z.ZodString;
15
15
  group: z.ZodString;
16
16
  description: z.ZodString;
17
- documentation: z.ZodOptional<z.ZodString>;
18
- locales: z.ZodOptional<z.ZodArray<z.ZodString>>;
19
- defaultLocale: z.ZodOptional<z.ZodString>;
20
- schemas: z.ZodOptional<z.ZodObject<{
21
- properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
22
- parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
23
- result: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
17
+ documentation: z.ZodNullable<z.ZodString>;
18
+ locales: z.ZodNullable<z.ZodArray<z.ZodString>>;
19
+ defaultLocale: z.ZodNullable<z.ZodString>;
20
+ schemas: z.ZodNullable<z.ZodObject<{
21
+ properties: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
22
+ parameters: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
23
+ result: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
24
24
  }, z.core.$strip>>;
25
25
  }, z.core.$strip>;
package/dist/v1/schemas/metadata.js CHANGED
@@ -6,13 +6,13 @@ exports.schemaDefinitionSchema = zod_1.z.record(zod_1.z.string(), zod_1.z.any())
6
6
  exports.schemaDefinitionsSchema = zod_1.z
7
7
  .object({
8
8
  properties: exports.schemaDefinitionSchema
9
- .optional()
9
+ .nullable()
10
10
  .describe("The JSON schema describing the configurable properties of projects using this criteria set"),
11
11
  parameters: exports.schemaDefinitionSchema
12
- .optional()
12
+ .nullable()
13
13
  .describe("The JSON schema describing the parameters of the criteria set"),
14
14
  result: exports.schemaDefinitionSchema
15
- .optional()
15
+ .nullable()
16
16
  .describe("The JSON schema describing the result of the criteria set"),
17
17
  })
18
18
  .describe("SchemaDefinitions - The JSON schemas describing the parameters and result of the criteria set, if any");
@@ -32,18 +32,18 @@ exports.metadataSchema = zod_1.z
32
32
  .describe("A detailed description of the criteria set"),
33
33
  documentation: zod_1.z
34
34
  .string()
35
- .optional()
35
+ .nullable()
36
36
  .describe("Additional documentation or usage guidelines for the criteria set"),
37
37
  locales: zod_1.z
38
38
  .array(zod_1.z.string())
39
- .optional()
39
+ .nullable()
40
40
  .describe("List of supported locale codes for internationalization"),
41
41
  defaultLocale: zod_1.z
42
42
  .string()
43
- .optional()
43
+ .nullable()
44
44
  .describe("The default locale to use when no specific locale is specified"),
45
45
  schemas: exports.schemaDefinitionsSchema
46
- .optional()
46
+ .nullable()
47
47
  .describe("Definitions of property, parameter and result schemas for the criteria set"),
48
48
  })
49
49
  .describe("Metadata - The metadata for a criteria set");
package/dist/v1/schemas/request/matrix-request-body-schema.d.ts CHANGED
@@ -2,9 +2,9 @@ import { z } from "zod";
2
2
  /**
3
3
  * Validates the request body for the matrix endpoints
4
4
  */
5
- export declare const matrixRequestBodySchema: z.ZodOptional<z.ZodObject<{
6
- locale: z.ZodOptional<z.ZodString>;
7
- parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
8
- values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>>;
9
- additional: z.ZodOptional<z.ZodAny>;
5
+ export declare const matrixRequestBodySchema: z.ZodNullable<z.ZodObject<{
6
+ locale: z.ZodNullable<z.ZodString>;
7
+ parameters: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
8
+ values: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>>;
9
+ additional: z.ZodNullable<z.ZodAny>;
10
10
  }, z.core.$strip>>;
package/dist/v1/schemas/request/matrix-request-body-schema.js CHANGED
@@ -10,19 +10,19 @@ exports.matrixRequestBodySchema = zod_1.z
10
10
  .object({
11
11
  locale: zod_1.z
12
12
  .string()
13
- .optional()
13
+ .nullable()
14
14
  .describe("Locale to be passed when generating the matrix"),
15
15
  parameters: zod_1.z
16
16
  .record(zod_1.z.string(), zod_1.z.any())
17
- .optional()
17
+ .nullable()
18
18
  .describe("Parameters to be passed when generating the matrix"),
19
19
  values: task_item_1.taskItemValueMapSchema
20
- .optional()
20
+ .nullable()
21
21
  .describe("Values to be passed when generating the matrix"),
22
22
  additional: zod_1.z
23
23
  .any()
24
- .optional()
24
+ .nullable()
25
25
  .describe("Additional data to be passed when generating the matrix"),
26
26
  })
27
- .optional()
27
+ .nullable()
28
28
  .describe("MatrixRequestBody - The request body for matrix endpoints");
package/dist/v1/schemas/request/tree-and-data-request-body-schema.d.ts CHANGED
@@ -2,8 +2,8 @@ import { z } from "zod";
2
2
  /**
3
3
  * Validates the request body for the tree and data endpoints
4
4
  */
5
- export declare const treeAndDataRequestBodySchema: z.ZodOptional<z.ZodObject<{
6
- locale: z.ZodOptional<z.ZodString>;
7
- parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
8
- values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>>;
5
+ export declare const treeAndDataRequestBodySchema: z.ZodNullable<z.ZodObject<{
6
+ locale: z.ZodNullable<z.ZodString>;
7
+ parameters: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>;
8
+ values: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>]>>>;
9
9
  }, z.core.$strip>>;
package/dist/v1/schemas/request/tree-and-data-request-body-schema.js CHANGED
@@ -10,15 +10,15 @@ exports.treeAndDataRequestBodySchema = zod_1.z
10
10
  .object({
11
11
  locale: zod_1.z
12
12
  .string()
13
- .optional()
13
+ .nullable()
14
14
  .describe("Locale to be passed when generating the matrix"),
15
15
  parameters: zod_1.z
16
16
  .record(zod_1.z.string(), zod_1.z.any())
17
- .optional()
17
+ .nullable()
18
18
  .describe("Parameters to be passed when generating the matrix"),
19
19
  values: task_item_1.taskItemValueMapSchema
20
- .optional()
20
+ .nullable()
21
21
  .describe("Values to be passed when generating the matrix"),
22
22
  })
23
- .optional()
23
+ .nullable()
24
24
  .describe("TreeAndDataRequestBody - The request body for tree and data endpoints");