@openframe-org/criteria-set-protocol 2.2.0 → 2.2.2

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 (17) hide show
  1. package/dist/v1/schemas/common.d.ts +24 -162
  2. package/dist/v1/schemas/common.js +7 -34
  3. package/dist/v1/schemas/criteria-set.js +1 -2
  4. package/dist/v1/schemas/criteria-tree.d.ts +639 -3787
  5. package/dist/v1/schemas/criteria-tree.js +1 -2
  6. package/dist/v1/schemas/criterion.d.ts +111 -668
  7. package/dist/v1/schemas/criterion.js +1 -2
  8. package/dist/v1/schemas/data-map.d.ts +41 -299
  9. package/dist/v1/schemas/task-group.d.ts +71 -438
  10. package/dist/v1/schemas/task-group.js +4 -2
  11. package/dist/v1/schemas/task-item.d.ts +22 -163
  12. package/dist/v1/schemas/task-item.js +5 -6
  13. package/dist/v1/schemas/task.d.ts +39 -250
  14. package/dist/v1/schemas/task.js +5 -4
  15. package/dist/v1/schemas/theme.d.ts +159 -940
  16. package/dist/v1/schemas/theme.js +1 -2
  17. package/package.json +1 -1
package/dist/v1/schemas/task.d.ts CHANGED
@@ -63,86 +63,34 @@ export declare const taskSchema: z.ZodObject<{
63
63
  label: string;
64
64
  text: string;
65
65
  }>]>, "many">>;
66
- data: z.ZodOptional<z.ZodIntersection<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
67
- type: z.ZodOptional<z.ZodLiteral<"number">>;
66
+ data: z.ZodOptional<z.ZodObject<{
67
+ type: z.ZodOptional<z.ZodEnum<["number", "percentage", "boolean"]>>;
68
68
  value: z.ZodOptional<z.ZodNumber>;
69
+ text: z.ZodOptional<z.ZodString>;
69
70
  total: z.ZodOptional<z.ZodNumber>;
70
71
  maximumValue: z.ZodOptional<z.ZodNumber>;
71
72
  minimumValue: z.ZodOptional<z.ZodNumber>;
72
73
  exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
73
74
  exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
74
75
  }, "strip", z.ZodTypeAny, {
75
- type?: "number" | undefined;
76
+ type?: "number" | "boolean" | "percentage" | undefined;
76
77
  total?: number | undefined;
77
78
  value?: number | undefined;
79
+ text?: string | undefined;
78
80
  maximumValue?: number | undefined;
79
81
  minimumValue?: number | undefined;
80
82
  exclusiveMaximum?: number | undefined;
81
83
  exclusiveMinimum?: number | undefined;
82
84
  }, {
83
- type?: "number" | undefined;
85
+ type?: "number" | "boolean" | "percentage" | undefined;
84
86
  total?: number | undefined;
85
87
  value?: number | undefined;
88
+ text?: string | undefined;
86
89
  maximumValue?: number | undefined;
87
90
  minimumValue?: number | undefined;
88
91
  exclusiveMaximum?: number | undefined;
89
92
  exclusiveMinimum?: number | undefined;
90
- }>, z.ZodObject<{
91
- maximumValue: z.ZodOptional<z.ZodNumber>;
92
- minimumValue: z.ZodOptional<z.ZodNumber>;
93
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
94
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
95
- } & {
96
- type: z.ZodLiteral<"percentage">;
97
- value: z.ZodOptional<z.ZodNumber>;
98
- total: z.ZodOptional<z.ZodNever>;
99
- }, "strip", z.ZodTypeAny, {
100
- type: "percentage";
101
- total?: undefined;
102
- value?: number | undefined;
103
- maximumValue?: number | undefined;
104
- minimumValue?: number | undefined;
105
- exclusiveMaximum?: number | undefined;
106
- exclusiveMinimum?: number | undefined;
107
- }, {
108
- type: "percentage";
109
- total?: undefined;
110
- value?: number | undefined;
111
- maximumValue?: number | undefined;
112
- minimumValue?: number | undefined;
113
- exclusiveMaximum?: number | undefined;
114
- exclusiveMinimum?: number | undefined;
115
- }>, z.ZodObject<{
116
- type: z.ZodLiteral<"boolean">;
117
- value: z.ZodOptional<z.ZodBoolean>;
118
- total: z.ZodOptional<z.ZodNever>;
119
- maximumValue: z.ZodOptional<z.ZodNever>;
120
- minimumValue: z.ZodOptional<z.ZodNever>;
121
- exclusiveMaximum: z.ZodOptional<z.ZodNever>;
122
- exclusiveMinimum: z.ZodOptional<z.ZodNever>;
123
- }, "strip", z.ZodTypeAny, {
124
- type: "boolean";
125
- total?: undefined;
126
- value?: boolean | undefined;
127
- maximumValue?: undefined;
128
- minimumValue?: undefined;
129
- exclusiveMaximum?: undefined;
130
- exclusiveMinimum?: undefined;
131
- }, {
132
- type: "boolean";
133
- total?: undefined;
134
- value?: boolean | undefined;
135
- maximumValue?: undefined;
136
- minimumValue?: undefined;
137
- exclusiveMaximum?: undefined;
138
- exclusiveMinimum?: undefined;
139
- }>]>, z.ZodObject<{
140
- text: z.ZodOptional<z.ZodString>;
141
- }, "strip", z.ZodTypeAny, {
142
- text?: string | undefined;
143
- }, {
144
- text?: string | undefined;
145
- }>>>;
93
+ }>>;
146
94
  sortOrder: z.ZodOptional<z.ZodNumber>;
147
95
  } & {
148
96
  type: z.ZodLiteral<"task">;
@@ -199,86 +147,34 @@ export declare const taskSchema: z.ZodObject<{
199
147
  sortOrder: z.ZodOptional<z.ZodNumber>;
200
148
  } & {
201
149
  type: z.ZodLiteral<"task-item">;
202
- data: z.ZodOptional<z.ZodIntersection<z.ZodIntersection<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
203
- type: z.ZodOptional<z.ZodLiteral<"number">>;
150
+ data: z.ZodOptional<z.ZodIntersection<z.ZodObject<{
151
+ type: z.ZodOptional<z.ZodEnum<["number", "percentage", "boolean"]>>;
204
152
  value: z.ZodOptional<z.ZodNumber>;
153
+ text: z.ZodOptional<z.ZodString>;
205
154
  total: z.ZodOptional<z.ZodNumber>;
206
155
  maximumValue: z.ZodOptional<z.ZodNumber>;
207
156
  minimumValue: z.ZodOptional<z.ZodNumber>;
208
157
  exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
209
158
  exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
210
159
  }, "strip", z.ZodTypeAny, {
211
- type?: "number" | undefined;
160
+ type?: "number" | "boolean" | "percentage" | undefined;
212
161
  total?: number | undefined;
213
162
  value?: number | undefined;
163
+ text?: string | undefined;
214
164
  maximumValue?: number | undefined;
215
165
  minimumValue?: number | undefined;
216
166
  exclusiveMaximum?: number | undefined;
217
167
  exclusiveMinimum?: number | undefined;
218
168
  }, {
219
- type?: "number" | undefined;
169
+ type?: "number" | "boolean" | "percentage" | undefined;
220
170
  total?: number | undefined;
221
171
  value?: number | undefined;
172
+ text?: string | undefined;
222
173
  maximumValue?: number | undefined;
223
174
  minimumValue?: number | undefined;
224
175
  exclusiveMaximum?: number | undefined;
225
176
  exclusiveMinimum?: number | undefined;
226
177
  }>, z.ZodObject<{
227
- maximumValue: z.ZodOptional<z.ZodNumber>;
228
- minimumValue: z.ZodOptional<z.ZodNumber>;
229
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
230
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
231
- } & {
232
- type: z.ZodLiteral<"percentage">;
233
- value: z.ZodOptional<z.ZodNumber>;
234
- total: z.ZodOptional<z.ZodNever>;
235
- }, "strip", z.ZodTypeAny, {
236
- type: "percentage";
237
- total?: undefined;
238
- value?: number | undefined;
239
- maximumValue?: number | undefined;
240
- minimumValue?: number | undefined;
241
- exclusiveMaximum?: number | undefined;
242
- exclusiveMinimum?: number | undefined;
243
- }, {
244
- type: "percentage";
245
- total?: undefined;
246
- value?: number | undefined;
247
- maximumValue?: number | undefined;
248
- minimumValue?: number | undefined;
249
- exclusiveMaximum?: number | undefined;
250
- exclusiveMinimum?: number | undefined;
251
- }>, z.ZodObject<{
252
- type: z.ZodLiteral<"boolean">;
253
- value: z.ZodOptional<z.ZodBoolean>;
254
- total: z.ZodOptional<z.ZodNever>;
255
- maximumValue: z.ZodOptional<z.ZodNever>;
256
- minimumValue: z.ZodOptional<z.ZodNever>;
257
- exclusiveMaximum: z.ZodOptional<z.ZodNever>;
258
- exclusiveMinimum: z.ZodOptional<z.ZodNever>;
259
- }, "strip", z.ZodTypeAny, {
260
- type: "boolean";
261
- total?: undefined;
262
- value?: boolean | undefined;
263
- maximumValue?: undefined;
264
- minimumValue?: undefined;
265
- exclusiveMaximum?: undefined;
266
- exclusiveMinimum?: undefined;
267
- }, {
268
- type: "boolean";
269
- total?: undefined;
270
- value?: boolean | undefined;
271
- maximumValue?: undefined;
272
- minimumValue?: undefined;
273
- exclusiveMaximum?: undefined;
274
- exclusiveMinimum?: undefined;
275
- }>]>, z.ZodObject<{
276
- text: z.ZodOptional<z.ZodString>;
277
- }, "strip", z.ZodTypeAny, {
278
- text?: string | undefined;
279
- }, {
280
- text?: string | undefined;
281
- }>>, z.ZodObject<{
282
178
  readOnly: z.ZodOptional<z.ZodBoolean>;
283
179
  valueReference: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "many">]>>;
284
180
  }, "strip", z.ZodTypeAny, {
@@ -459,7 +355,6 @@ export declare const taskSchema: z.ZodObject<{
459
355
  readOnly?: boolean | undefined;
460
356
  }>]>;
461
357
  description: z.ZodOptional<z.ZodString>;
462
- valueReference: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>, "many">]>>;
463
358
  options: z.ZodObject<{
464
359
  excludeFromTargets: z.ZodOptional<z.ZodBoolean>;
465
360
  }, "strip", z.ZodTypeAny, {
@@ -519,33 +414,16 @@ export declare const taskSchema: z.ZodObject<{
519
414
  defaultValue?: boolean | undefined;
520
415
  readOnly?: boolean | undefined;
521
416
  };
522
- data?: ((({
523
- type?: "number" | undefined;
417
+ data?: ({
418
+ type?: "number" | "boolean" | "percentage" | undefined;
524
419
  total?: number | undefined;
525
420
  value?: number | undefined;
421
+ text?: string | undefined;
526
422
  maximumValue?: number | undefined;
527
423
  minimumValue?: number | undefined;
528
424
  exclusiveMaximum?: number | undefined;
529
425
  exclusiveMinimum?: number | undefined;
530
- } | {
531
- type: "percentage";
532
- total?: undefined;
533
- value?: number | undefined;
534
- maximumValue?: number | undefined;
535
- minimumValue?: number | undefined;
536
- exclusiveMaximum?: number | undefined;
537
- exclusiveMinimum?: number | undefined;
538
- } | {
539
- type: "boolean";
540
- total?: undefined;
541
- value?: boolean | undefined;
542
- maximumValue?: undefined;
543
- minimumValue?: undefined;
544
- exclusiveMaximum?: undefined;
545
- exclusiveMinimum?: undefined;
546
- }) & {
547
- text?: string | undefined;
548
- }) & {
426
+ } & {
549
427
  readOnly?: boolean | undefined;
550
428
  valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
551
429
  }) | undefined;
@@ -567,7 +445,6 @@ export declare const taskSchema: z.ZodObject<{
567
445
  text: string;
568
446
  })[] | undefined;
569
447
  sortOrder?: number | undefined;
570
- valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
571
448
  }, {
572
449
  code: string;
573
450
  type: "task-item";
@@ -620,33 +497,16 @@ export declare const taskSchema: z.ZodObject<{
620
497
  defaultValue?: boolean | undefined;
621
498
  readOnly?: boolean | undefined;
622
499
  };
623
- data?: ((({
624
- type?: "number" | undefined;
500
+ data?: ({
501
+ type?: "number" | "boolean" | "percentage" | undefined;
625
502
  total?: number | undefined;
626
503
  value?: number | undefined;
504
+ text?: string | undefined;
627
505
  maximumValue?: number | undefined;
628
506
  minimumValue?: number | undefined;
629
507
  exclusiveMaximum?: number | undefined;
630
508
  exclusiveMinimum?: number | undefined;
631
- } | {
632
- type: "percentage";
633
- total?: undefined;
634
- value?: number | undefined;
635
- maximumValue?: number | undefined;
636
- minimumValue?: number | undefined;
637
- exclusiveMaximum?: number | undefined;
638
- exclusiveMinimum?: number | undefined;
639
- } | {
640
- type: "boolean";
641
- total?: undefined;
642
- value?: boolean | undefined;
643
- maximumValue?: undefined;
644
- minimumValue?: undefined;
645
- exclusiveMaximum?: undefined;
646
- exclusiveMinimum?: undefined;
647
- }) & {
648
- text?: string | undefined;
649
- }) & {
509
+ } & {
650
510
  readOnly?: boolean | undefined;
651
511
  valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
652
512
  }) | undefined;
@@ -668,7 +528,6 @@ export declare const taskSchema: z.ZodObject<{
668
528
  text: string;
669
529
  })[] | undefined;
670
530
  sortOrder?: number | undefined;
671
- valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
672
531
  }>>, "many">;
673
532
  options: z.ZodObject<{
674
533
  breadcrumbTextFormat: z.ZodString;
@@ -744,33 +603,16 @@ export declare const taskSchema: z.ZodObject<{
744
603
  defaultValue?: boolean | undefined;
745
604
  readOnly?: boolean | undefined;
746
605
  };
747
- data?: ((({
748
- type?: "number" | undefined;
606
+ data?: ({
607
+ type?: "number" | "boolean" | "percentage" | undefined;
749
608
  total?: number | undefined;
750
609
  value?: number | undefined;
610
+ text?: string | undefined;
751
611
  maximumValue?: number | undefined;
752
612
  minimumValue?: number | undefined;
753
613
  exclusiveMaximum?: number | undefined;
754
614
  exclusiveMinimum?: number | undefined;
755
- } | {
756
- type: "percentage";
757
- total?: undefined;
758
- value?: number | undefined;
759
- maximumValue?: number | undefined;
760
- minimumValue?: number | undefined;
761
- exclusiveMaximum?: number | undefined;
762
- exclusiveMinimum?: number | undefined;
763
- } | {
764
- type: "boolean";
765
- total?: undefined;
766
- value?: boolean | undefined;
767
- maximumValue?: undefined;
768
- minimumValue?: undefined;
769
- exclusiveMaximum?: undefined;
770
- exclusiveMinimum?: undefined;
771
- }) & {
772
- text?: string | undefined;
773
- }) & {
615
+ } & {
774
616
  readOnly?: boolean | undefined;
775
617
  valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
776
618
  }) | undefined;
@@ -792,36 +634,18 @@ export declare const taskSchema: z.ZodObject<{
792
634
  text: string;
793
635
  })[] | undefined;
794
636
  sortOrder?: number | undefined;
795
- valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
796
637
  }[];
797
638
  longFormTitle: string;
798
- data?: (({
799
- type?: "number" | undefined;
639
+ data?: {
640
+ type?: "number" | "boolean" | "percentage" | undefined;
800
641
  total?: number | undefined;
801
642
  value?: number | undefined;
643
+ text?: string | undefined;
802
644
  maximumValue?: number | undefined;
803
645
  minimumValue?: number | undefined;
804
646
  exclusiveMaximum?: number | undefined;
805
647
  exclusiveMinimum?: number | undefined;
806
- } | {
807
- type: "percentage";
808
- total?: undefined;
809
- value?: number | undefined;
810
- maximumValue?: number | undefined;
811
- minimumValue?: number | undefined;
812
- exclusiveMaximum?: number | undefined;
813
- exclusiveMinimum?: number | undefined;
814
- } | {
815
- type: "boolean";
816
- total?: undefined;
817
- value?: boolean | undefined;
818
- maximumValue?: undefined;
819
- minimumValue?: undefined;
820
- exclusiveMaximum?: undefined;
821
- exclusiveMinimum?: undefined;
822
- }) & {
823
- text?: string | undefined;
824
- }) | undefined;
648
+ } | undefined;
825
649
  description?: string | undefined;
826
650
  tags?: string[] | undefined;
827
651
  documentation?: ({
@@ -901,33 +725,16 @@ export declare const taskSchema: z.ZodObject<{
901
725
  defaultValue?: boolean | undefined;
902
726
  readOnly?: boolean | undefined;
903
727
  };
904
- data?: ((({
905
- type?: "number" | undefined;
728
+ data?: ({
729
+ type?: "number" | "boolean" | "percentage" | undefined;
906
730
  total?: number | undefined;
907
731
  value?: number | undefined;
732
+ text?: string | undefined;
908
733
  maximumValue?: number | undefined;
909
734
  minimumValue?: number | undefined;
910
735
  exclusiveMaximum?: number | undefined;
911
736
  exclusiveMinimum?: number | undefined;
912
- } | {
913
- type: "percentage";
914
- total?: undefined;
915
- value?: number | undefined;
916
- maximumValue?: number | undefined;
917
- minimumValue?: number | undefined;
918
- exclusiveMaximum?: number | undefined;
919
- exclusiveMinimum?: number | undefined;
920
- } | {
921
- type: "boolean";
922
- total?: undefined;
923
- value?: boolean | undefined;
924
- maximumValue?: undefined;
925
- minimumValue?: undefined;
926
- exclusiveMaximum?: undefined;
927
- exclusiveMinimum?: undefined;
928
- }) & {
929
- text?: string | undefined;
930
- }) & {
737
+ } & {
931
738
  readOnly?: boolean | undefined;
932
739
  valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
933
740
  }) | undefined;
@@ -949,36 +756,18 @@ export declare const taskSchema: z.ZodObject<{
949
756
  text: string;
950
757
  })[] | undefined;
951
758
  sortOrder?: number | undefined;
952
- valueReference?: string | number | boolean | (string | number | boolean | null)[] | null | undefined;
953
759
  }[];
954
760
  longFormTitle: string;
955
- data?: (({
956
- type?: "number" | undefined;
761
+ data?: {
762
+ type?: "number" | "boolean" | "percentage" | undefined;
957
763
  total?: number | undefined;
958
764
  value?: number | undefined;
765
+ text?: string | undefined;
959
766
  maximumValue?: number | undefined;
960
767
  minimumValue?: number | undefined;
961
768
  exclusiveMaximum?: number | undefined;
962
769
  exclusiveMinimum?: number | undefined;
963
- } | {
964
- type: "percentage";
965
- total?: undefined;
966
- value?: number | undefined;
967
- maximumValue?: number | undefined;
968
- minimumValue?: number | undefined;
969
- exclusiveMaximum?: number | undefined;
970
- exclusiveMinimum?: number | undefined;
971
- } | {
972
- type: "boolean";
973
- total?: undefined;
974
- value?: boolean | undefined;
975
- maximumValue?: undefined;
976
- minimumValue?: undefined;
977
- exclusiveMaximum?: undefined;
978
- exclusiveMinimum?: undefined;
979
- }) & {
980
- text?: string | undefined;
981
- }) | undefined;
770
+ } | undefined;
982
771
  description?: string | undefined;
983
772
  tags?: string[] | undefined;
984
773
  documentation?: ({
package/dist/v1/schemas/task.js CHANGED
@@ -4,7 +4,8 @@ exports.taskSchema = exports.taskOptionsSchema = void 0;
4
4
  const zod_1 = require("zod");
5
5
  const task_item_1 = require("./task-item");
6
6
  const common_1 = require("./common");
7
- exports.taskOptionsSchema = zod_1.z.object({
7
+ exports.taskOptionsSchema = zod_1.z
8
+ .object({
8
9
  breadcrumbTextFormat: zod_1.z
9
10
  .string()
10
11
  .describe("The format of the breadcrumb text, use ':code:' and ':title:' to define where the code and/or title should be inserted"),
@@ -16,7 +17,8 @@ exports.taskOptionsSchema = zod_1.z.object({
16
17
  .optional()
17
18
  .default(false)
18
19
  .describe("Whether the title of the indicator task view should show the task code, or the hardcoded description text"),
19
- }).describe("TaskOptions - Configuration options for task display and behavior");
20
+ })
21
+ .describe("TaskOptions - Configuration options for task display and behavior");
20
22
  exports.taskSchema = common_1.abstractElementSchema.extend({
21
23
  type: zod_1.z.literal("task").describe("Identifies the schema type as a task"),
22
24
  description: zod_1.z
@@ -26,6 +28,5 @@ exports.taskSchema = common_1.abstractElementSchema.extend({
26
28
  items: zod_1.z
27
29
  .array(zod_1.z.lazy(() => task_item_1.taskItemSchema))
28
30
  .describe("The task items in this task"),
29
- options: exports.taskOptionsSchema
30
- .describe("Configuration options for the task display and behavior"),
31
+ options: exports.taskOptionsSchema.describe("Configuration options for the task display and behavior"),
31
32
  });