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

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 +32 -32
  2. package/dist/v1/schemas/certification.js +6 -6
  3. package/dist/v1/schemas/common.d.ts +36 -36
  4. package/dist/v1/schemas/common.js +18 -18
  5. package/dist/v1/schemas/criteria-tree.d.ts +524 -524
  6. package/dist/v1/schemas/criteria-tree.js +1 -1
  7. package/dist/v1/schemas/criterion.d.ts +100 -100
  8. package/dist/v1/schemas/criterion.js +1 -1
  9. package/dist/v1/schemas/data-map.d.ts +50 -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 +75 -75
  19. package/dist/v1/schemas/task-group.js +2 -2
  20. package/dist/v1/schemas/task-item.d.ts +113 -113
  21. package/dist/v1/schemas/task-item.js +23 -23
  22. package/dist/v1/schemas/task.d.ts +62 -62
  23. package/dist/v1/schemas/task.js +2 -2
  24. package/dist/v1/schemas/theme.d.ts +120 -120
  25. package/dist/v1/schemas/theme.js +2 -2
  26. package/dist/v1/utils.js +5 -4
  27. package/package.json +1 -1
package/dist/v1/schemas/certification.d.ts CHANGED
@@ -4,69 +4,69 @@ export declare const certificationDefinitionTypeSchema: z.ZodEnum<{
4
4
  percentage: "percentage";
5
5
  }>;
6
6
  export declare const numberBasedCertificationDefinitionRulesSchema: z.ZodObject<{
7
- minimum: z.ZodOptional<z.ZodNumber>;
8
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
9
- maximum: z.ZodOptional<z.ZodNumber>;
10
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
7
+ minimum: z.ZodNullable<z.ZodNumber>;
8
+ exclusiveMinimum: z.ZodNullable<z.ZodNumber>;
9
+ maximum: z.ZodNullable<z.ZodNumber>;
10
+ exclusiveMaximum: z.ZodNullable<z.ZodNumber>;
11
11
  }, z.core.$strip>;
12
12
  export declare const percentageBasedCertificationDefinitionRulesSchema: z.ZodObject<{
13
- minimum: z.ZodOptional<z.ZodNumber>;
14
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
15
- maximum: z.ZodOptional<z.ZodNumber>;
16
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
13
+ minimum: z.ZodNullable<z.ZodNumber>;
14
+ exclusiveMinimum: z.ZodNullable<z.ZodNumber>;
15
+ maximum: z.ZodNullable<z.ZodNumber>;
16
+ exclusiveMaximum: z.ZodNullable<z.ZodNumber>;
17
17
  }, z.core.$strip>;
18
18
  export declare const numberBasedCertificationDefinitionSchema: z.ZodObject<{
19
19
  code: z.ZodString;
20
- icon: z.ZodOptional<z.ZodString>;
20
+ icon: z.ZodNullable<z.ZodString>;
21
21
  name: z.ZodString;
22
- description: z.ZodOptional<z.ZodString>;
22
+ description: z.ZodNullable<z.ZodString>;
23
23
  rulesText: z.ZodString;
24
24
  type: z.ZodLiteral<"number">;
25
25
  rules: z.ZodObject<{
26
- minimum: z.ZodOptional<z.ZodNumber>;
27
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
28
- maximum: z.ZodOptional<z.ZodNumber>;
29
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
26
+ minimum: z.ZodNullable<z.ZodNumber>;
27
+ exclusiveMinimum: z.ZodNullable<z.ZodNumber>;
28
+ maximum: z.ZodNullable<z.ZodNumber>;
29
+ exclusiveMaximum: z.ZodNullable<z.ZodNumber>;
30
30
  }, z.core.$strip>;
31
31
  }, z.core.$strip>;
32
32
  export declare const percentageBasedCertificationDefinitionSchema: z.ZodObject<{
33
33
  code: z.ZodString;
34
- icon: z.ZodOptional<z.ZodString>;
34
+ icon: z.ZodNullable<z.ZodString>;
35
35
  name: z.ZodString;
36
- description: z.ZodOptional<z.ZodString>;
36
+ description: z.ZodNullable<z.ZodString>;
37
37
  rulesText: z.ZodString;
38
38
  type: z.ZodLiteral<"percentage">;
39
39
  rules: z.ZodObject<{
40
- minimum: z.ZodOptional<z.ZodNumber>;
41
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
42
- maximum: z.ZodOptional<z.ZodNumber>;
43
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
40
+ minimum: z.ZodNullable<z.ZodNumber>;
41
+ exclusiveMinimum: z.ZodNullable<z.ZodNumber>;
42
+ maximum: z.ZodNullable<z.ZodNumber>;
43
+ exclusiveMaximum: z.ZodNullable<z.ZodNumber>;
44
44
  }, z.core.$strip>;
45
45
  }, z.core.$strip>;
46
46
  export declare const certificationDefinitionSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
47
47
  code: z.ZodString;
48
- icon: z.ZodOptional<z.ZodString>;
48
+ icon: z.ZodNullable<z.ZodString>;
49
49
  name: z.ZodString;
50
- description: z.ZodOptional<z.ZodString>;
50
+ description: z.ZodNullable<z.ZodString>;
51
51
  rulesText: z.ZodString;
52
52
  type: z.ZodLiteral<"number">;
53
53
  rules: z.ZodObject<{
54
- minimum: z.ZodOptional<z.ZodNumber>;
55
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
56
- maximum: z.ZodOptional<z.ZodNumber>;
57
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
54
+ minimum: z.ZodNullable<z.ZodNumber>;
55
+ exclusiveMinimum: z.ZodNullable<z.ZodNumber>;
56
+ maximum: z.ZodNullable<z.ZodNumber>;
57
+ exclusiveMaximum: z.ZodNullable<z.ZodNumber>;
58
58
  }, z.core.$strip>;
59
59
  }, z.core.$strip>, z.ZodObject<{
60
60
  code: z.ZodString;
61
- icon: z.ZodOptional<z.ZodString>;
61
+ icon: z.ZodNullable<z.ZodString>;
62
62
  name: z.ZodString;
63
- description: z.ZodOptional<z.ZodString>;
63
+ description: z.ZodNullable<z.ZodString>;
64
64
  rulesText: z.ZodString;
65
65
  type: z.ZodLiteral<"percentage">;
66
66
  rules: z.ZodObject<{
67
- minimum: z.ZodOptional<z.ZodNumber>;
68
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
69
- maximum: z.ZodOptional<z.ZodNumber>;
70
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
67
+ minimum: z.ZodNullable<z.ZodNumber>;
68
+ exclusiveMinimum: z.ZodNullable<z.ZodNumber>;
69
+ maximum: z.ZodNullable<z.ZodNumber>;
70
+ exclusiveMaximum: z.ZodNullable<z.ZodNumber>;
71
71
  }, z.core.$strip>;
72
72
  }, z.core.$strip>], "type">;
package/dist/v1/schemas/certification.js CHANGED
@@ -7,10 +7,10 @@ exports.certificationDefinitionTypeSchema = zod_1.z
7
7
  .describe("CertificationDefinitionType");
8
8
  exports.numberBasedCertificationDefinitionRulesSchema = zod_1.z
9
9
  .object({
10
- minimum: zod_1.z.number().optional(),
11
- exclusiveMinimum: zod_1.z.number().optional(),
12
- maximum: zod_1.z.number().optional(),
13
- exclusiveMaximum: zod_1.z.number().optional(),
10
+ minimum: zod_1.z.number().nullable(),
11
+ exclusiveMinimum: zod_1.z.number().nullable(),
12
+ maximum: zod_1.z.number().nullable(),
13
+ exclusiveMaximum: zod_1.z.number().nullable(),
14
14
  })
15
15
  .describe("NumberBasedCertificationDefinitionRules");
16
16
  exports.percentageBasedCertificationDefinitionRulesSchema = exports.numberBasedCertificationDefinitionRulesSchema.describe("PercentageBasedCertificationDefinitionRules");
@@ -22,12 +22,12 @@ const abstractCertificationDefinitionSchema = zod_1.z
22
22
  .describe("Unique identifier code for the certification, such as 'platinum' or 'ecolabel'"),
23
23
  icon: zod_1.z
24
24
  .string()
25
- .optional()
25
+ .nullable()
26
26
  .describe("Optional icon URL for the certification"),
27
27
  name: zod_1.z.string().describe("Display name of the certification"),
28
28
  description: zod_1.z
29
29
  .string()
30
- .optional()
30
+ .nullable()
31
31
  .describe("Optional detailed description of the certification"),
32
32
  rulesText: zod_1.z
33
33
  .string()
package/dist/v1/schemas/common.d.ts CHANGED
@@ -7,19 +7,19 @@ export declare const colorSchema: z.ZodUnion<readonly [z.ZodString, z.ZodObject<
7
7
  export declare const taskItemScalarValueSchema: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>;
8
8
  export declare const taskItemValueSchema: 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
  export declare const elementDataSchema: z.ZodObject<{
10
- type: z.ZodOptional<z.ZodEnum<{
10
+ type: z.ZodNullable<z.ZodEnum<{
11
11
  number: "number";
12
12
  boolean: "boolean";
13
13
  percentage: "percentage";
14
14
  }>>;
15
- value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
16
- text: z.ZodOptional<z.ZodString>;
17
- total: z.ZodOptional<z.ZodNumber>;
18
- maximumValue: z.ZodOptional<z.ZodNumber>;
19
- minimumValue: z.ZodOptional<z.ZodNumber>;
20
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
21
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
22
- weight: z.ZodOptional<z.ZodNumber>;
15
+ value: z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
16
+ text: z.ZodNullable<z.ZodString>;
17
+ total: z.ZodNullable<z.ZodNumber>;
18
+ maximumValue: z.ZodNullable<z.ZodNumber>;
19
+ minimumValue: z.ZodNullable<z.ZodNumber>;
20
+ exclusiveMaximum: z.ZodNullable<z.ZodNumber>;
21
+ exclusiveMinimum: z.ZodNullable<z.ZodNumber>;
22
+ weight: z.ZodNullable<z.ZodNumber>;
23
23
  }, z.core.$catchall<z.ZodAny>>;
24
24
  export declare const criteriaTreeElementTypeSchema: z.ZodEnum<{
25
25
  theme: "theme";
@@ -39,8 +39,8 @@ export declare const abstractElementSchema: z.ZodObject<{
39
39
  title: z.ZodString;
40
40
  longFormTitle: z.ZodString;
41
41
  code: z.ZodString;
42
- tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
43
- documentation: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
42
+ tags: z.ZodNullable<z.ZodArray<z.ZodString>>;
43
+ documentation: z.ZodNullable<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
44
44
  label: z.ZodString;
45
45
  text: z.ZodString;
46
46
  type: z.ZodLiteral<"pdf">;
@@ -55,55 +55,55 @@ export declare const abstractElementSchema: z.ZodObject<{
55
55
  type: z.ZodLiteral<"link">;
56
56
  url: z.ZodString;
57
57
  }, z.core.$strip>], "type">>>;
58
- data: z.ZodOptional<z.ZodObject<{
59
- type: z.ZodOptional<z.ZodEnum<{
58
+ data: z.ZodNullable<z.ZodObject<{
59
+ type: z.ZodNullable<z.ZodEnum<{
60
60
  number: "number";
61
61
  boolean: "boolean";
62
62
  percentage: "percentage";
63
63
  }>>;
64
- value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
65
- text: z.ZodOptional<z.ZodString>;
66
- total: z.ZodOptional<z.ZodNumber>;
67
- maximumValue: z.ZodOptional<z.ZodNumber>;
68
- minimumValue: z.ZodOptional<z.ZodNumber>;
69
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
70
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
71
- weight: z.ZodOptional<z.ZodNumber>;
64
+ value: z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
65
+ text: z.ZodNullable<z.ZodString>;
66
+ total: z.ZodNullable<z.ZodNumber>;
67
+ maximumValue: z.ZodNullable<z.ZodNumber>;
68
+ minimumValue: z.ZodNullable<z.ZodNumber>;
69
+ exclusiveMaximum: z.ZodNullable<z.ZodNumber>;
70
+ exclusiveMinimum: z.ZodNullable<z.ZodNumber>;
71
+ weight: z.ZodNullable<z.ZodNumber>;
72
72
  }, z.core.$catchall<z.ZodAny>>>;
73
- sortOrder: z.ZodOptional<z.ZodNumber>;
73
+ sortOrder: z.ZodNullable<z.ZodNumber>;
74
74
  }, z.core.$strip>;
75
75
  export declare const breadcrumbOptionsSchema: z.ZodUnion<[z.ZodObject<{
76
76
  hideFromBreadcrumbs: z.ZodLiteral<true>;
77
- breadcrumbTextFormat: z.ZodOptional<z.ZodNever>;
77
+ breadcrumbTextFormat: z.ZodNullable<z.ZodNever>;
78
78
  }, z.core.$strip>, z.ZodObject<{
79
- hideFromBreadcrumbs: z.ZodDefault<z.ZodOptional<z.ZodLiteral<false>>>;
79
+ hideFromBreadcrumbs: z.ZodDefault<z.ZodNullable<z.ZodLiteral<false>>>;
80
80
  breadcrumbTextFormat: z.ZodString;
81
81
  }, z.core.$strip>]>;
82
82
  export declare const documentTreeOptionsSchema: z.ZodUnion<[z.ZodObject<{
83
83
  hideFromDocumentTree: z.ZodLiteral<true>;
84
- documentTreeFolderTextFormat: z.ZodOptional<z.ZodNever>;
84
+ documentTreeFolderTextFormat: z.ZodNullable<z.ZodNever>;
85
85
  }, z.core.$strip>, z.ZodObject<{
86
- hideFromDocumentTree: z.ZodOptional<z.ZodLiteral<false>>;
86
+ hideFromDocumentTree: z.ZodNullable<z.ZodLiteral<false>>;
87
87
  documentTreeFolderTextFormat: z.ZodString;
88
88
  }, z.core.$strip>]>;
89
89
  export declare const criteriaTreeOptionsSchema: z.ZodObject<{
90
90
  criteriaTreeElementTextFormat: z.ZodString;
91
91
  }, z.core.$strip>;
92
92
  export declare const reportOptionsSchema: z.ZodObject<{
93
- reportTitleTextFormat: z.ZodOptional<z.ZodString>;
93
+ reportTitleTextFormat: z.ZodNullable<z.ZodString>;
94
94
  }, z.core.$strip>;
95
95
  export declare const treeResultSchema: z.ZodObject<{
96
- type: z.ZodOptional<z.ZodEnum<{
96
+ type: z.ZodNullable<z.ZodEnum<{
97
97
  number: "number";
98
98
  boolean: "boolean";
99
99
  percentage: "percentage";
100
100
  }>>;
101
- value: z.ZodOptional<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
102
- text: z.ZodOptional<z.ZodString>;
103
- total: z.ZodOptional<z.ZodNumber>;
104
- maximumValue: z.ZodOptional<z.ZodNumber>;
105
- minimumValue: z.ZodOptional<z.ZodNumber>;
106
- exclusiveMaximum: z.ZodOptional<z.ZodNumber>;
107
- exclusiveMinimum: z.ZodOptional<z.ZodNumber>;
108
- weight: z.ZodOptional<z.ZodNumber>;
101
+ value: z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodBoolean]>>;
102
+ text: z.ZodNullable<z.ZodString>;
103
+ total: z.ZodNullable<z.ZodNumber>;
104
+ maximumValue: z.ZodNullable<z.ZodNumber>;
105
+ minimumValue: z.ZodNullable<z.ZodNumber>;
106
+ exclusiveMaximum: z.ZodNullable<z.ZodNumber>;
107
+ exclusiveMinimum: z.ZodNullable<z.ZodNumber>;
108
+ weight: z.ZodNullable<z.ZodNumber>;
109
109
  }, z.core.$catchall<z.ZodAny>>;
package/dist/v1/schemas/common.js CHANGED
@@ -24,31 +24,31 @@ exports.elementDataSchema = zod_1.z
24
24
  .object({
25
25
  type: zod_1.z
26
26
  .enum(["number", "percentage", "boolean"])
27
- .optional()
27
+ .nullable()
28
28
  .describe("Type of data"),
29
- value: zod_1.z.number().or(zod_1.z.boolean()).optional().describe("Value of the element"),
30
- text: zod_1.z.string().optional().describe("Text representation of the value"),
29
+ value: zod_1.z.number().or(zod_1.z.boolean()).nullable().describe("Value of the element"),
30
+ text: zod_1.z.string().nullable().describe("Text representation of the value"),
31
31
  total: zod_1.z
32
32
  .number()
33
- .optional()
33
+ .nullable()
34
34
  .describe("Total value, understood as 'value'/'total'"),
35
35
  maximumValue: zod_1.z
36
36
  .number()
37
- .optional()
37
+ .nullable()
38
38
  .describe("Maximum allowed value (inclusive)"),
39
39
  minimumValue: zod_1.z
40
40
  .number()
41
- .optional()
41
+ .nullable()
42
42
  .describe("Minimum allowed value (inclusive)"),
43
43
  exclusiveMaximum: zod_1.z
44
44
  .number()
45
- .optional()
45
+ .nullable()
46
46
  .describe("Maximum allowed value (exclusive)"),
47
47
  exclusiveMinimum: zod_1.z
48
48
  .number()
49
- .optional()
49
+ .nullable()
50
50
  .describe("Minimum allowed value (exclusive)"),
51
- weight: zod_1.z.number().optional().describe("Weight of the element")
51
+ weight: zod_1.z.number().nullable().describe("Weight of the element")
52
52
  })
53
53
  .catchall(zod_1.z.any())
54
54
  .describe("ElementData - Element data containing value constraints and metadata");
@@ -63,16 +63,16 @@ exports.abstractElementSchema = zod_1.z
63
63
  code: zod_1.z.string().describe("Unique identifier code"),
64
64
  tags: zod_1.z
65
65
  .array(zod_1.z.string())
66
- .optional()
66
+ .nullable()
67
67
  .describe("List of classification tags"),
68
68
  documentation: zod_1.z
69
69
  .array(documentation_1.documentationItemSchema)
70
- .optional()
70
+ .nullable()
71
71
  .describe("Associated documentation items"),
72
- data: exports.elementDataSchema.optional().describe("Element data"),
72
+ data: exports.elementDataSchema.nullable().describe("Element data"),
73
73
  sortOrder: zod_1.z
74
74
  .number()
75
- .optional()
75
+ .nullable()
76
76
  .describe("Custom sorting position within parent")
77
77
  })
78
78
  .describe("AbstractElement - Base schema for all tree elements");
@@ -81,12 +81,12 @@ exports.breadcrumbOptionsSchema = zod_1.z
81
81
  hideFromBreadcrumbs: zod_1.z
82
82
  .literal(true)
83
83
  .describe("Whether to hide the element from the breadcrumbs"),
84
- breadcrumbTextFormat: zod_1.z.never().optional()
84
+ breadcrumbTextFormat: zod_1.z.never().nullable()
85
85
  })
86
86
  .or(zod_1.z.object({
87
87
  hideFromBreadcrumbs: zod_1.z
88
88
  .literal(false)
89
- .optional()
89
+ .nullable()
90
90
  .default(false)
91
91
  .describe("Whether to hide the element from the breadcrumbs"),
92
92
  breadcrumbTextFormat: zod_1.z
@@ -98,12 +98,12 @@ exports.documentTreeOptionsSchema = zod_1.z
98
98
  hideFromDocumentTree: zod_1.z
99
99
  .literal(true)
100
100
  .describe("Whether to hide the element from the document tree folder structure"),
101
- documentTreeFolderTextFormat: zod_1.z.never().optional()
101
+ documentTreeFolderTextFormat: zod_1.z.never().nullable()
102
102
  })
103
103
  .or(zod_1.z.object({
104
104
  hideFromDocumentTree: zod_1.z
105
105
  .literal(false)
106
- .optional()
106
+ .nullable()
107
107
  .describe("Whether to hide the element from the document tree folder structure"),
108
108
  documentTreeFolderTextFormat: zod_1.z
109
109
  .string()
@@ -119,7 +119,7 @@ exports.reportOptionsSchema = zod_1.z
119
119
  .object({
120
120
  reportTitleTextFormat: zod_1.z
121
121
  .string()
122
- .optional()
122
+ .nullable()
123
123
  .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")
124
124
  });
125
125
  exports.treeResultSchema = exports.elementDataSchema.describe("TreeResult - The result of the evaluation of a criteria set");