@code-pushup/models 0.105.0 → 0.107.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.
@@ -2,7 +2,7 @@ import { z } from 'zod';
2
2
  export declare const categoryDiffSchema: z.ZodObject<{
3
3
  slug: z.ZodString;
4
4
  title: z.ZodString;
5
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
5
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
6
6
  scores: z.ZodObject<{
7
7
  before: z.ZodNumber;
8
8
  after: z.ZodNumber;
@@ -17,11 +17,11 @@ export declare const groupDiffSchema: z.ZodObject<{
17
17
  }, z.core.$strip>;
18
18
  slug: z.ZodString;
19
19
  title: z.ZodString;
20
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
20
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
21
21
  plugin: z.ZodObject<{
22
22
  slug: z.ZodString;
23
23
  title: z.ZodString;
24
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
24
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
25
25
  }, z.core.$strip>;
26
26
  }, z.core.$strip>;
27
27
  export declare const auditDiffSchema: z.ZodObject<{
@@ -32,11 +32,11 @@ export declare const auditDiffSchema: z.ZodObject<{
32
32
  }, z.core.$strip>;
33
33
  slug: z.ZodString;
34
34
  title: z.ZodString;
35
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
35
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
36
36
  plugin: z.ZodObject<{
37
37
  slug: z.ZodString;
38
38
  title: z.ZodString;
39
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
39
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
40
40
  }, z.core.$strip>;
41
41
  values: z.ZodObject<{
42
42
  before: z.ZodNumber;
@@ -51,38 +51,86 @@ export declare const auditDiffSchema: z.ZodObject<{
51
51
  export declare const categoryResultSchema: z.ZodObject<{
52
52
  slug: z.ZodString;
53
53
  title: z.ZodString;
54
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
54
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
55
55
  score: z.ZodNumber;
56
56
  }, z.core.$strip>;
57
57
  export declare const groupResultSchema: z.ZodObject<{
58
58
  slug: z.ZodString;
59
59
  title: z.ZodString;
60
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
60
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
61
61
  plugin: z.ZodObject<{
62
62
  slug: z.ZodString;
63
63
  title: z.ZodString;
64
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
64
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
65
65
  }, z.core.$strip>;
66
66
  score: z.ZodNumber;
67
67
  }, z.core.$strip>;
68
68
  export declare const auditResultSchema: z.ZodObject<{
69
69
  slug: z.ZodString;
70
70
  title: z.ZodString;
71
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
71
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
72
72
  plugin: z.ZodObject<{
73
73
  slug: z.ZodString;
74
74
  title: z.ZodString;
75
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
75
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
76
76
  }, z.core.$strip>;
77
77
  value: z.ZodNumber;
78
78
  displayValue: z.ZodOptional<z.ZodString>;
79
79
  score: z.ZodNumber;
80
80
  }, z.core.$strip>;
81
+ /**
82
+ * Type Definition: `CategoryDiff`
83
+ *
84
+ * This type is derived from a Zod schema and represents
85
+ * the validated structure of `CategoryDiff` used within the application.
86
+ *
87
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#categorydiff}
88
+ */
81
89
  export type CategoryDiff = z.infer<typeof categoryDiffSchema>;
90
+ /**
91
+ * Type Definition: `GroupDiff`
92
+ *
93
+ * This type is derived from a Zod schema and represents
94
+ * the validated structure of `GroupDiff` used within the application.
95
+ *
96
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#groupdiff}
97
+ */
82
98
  export type GroupDiff = z.infer<typeof groupDiffSchema>;
99
+ /**
100
+ * Type Definition: `AuditDiff`
101
+ *
102
+ * This type is derived from a Zod schema and represents
103
+ * the validated structure of `AuditDiff` used within the application.
104
+ *
105
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#auditdiff}
106
+ */
83
107
  export type AuditDiff = z.infer<typeof auditDiffSchema>;
108
+ /**
109
+ * Type Definition: `CategoryResult`
110
+ *
111
+ * This type is derived from a Zod schema and represents
112
+ * the validated structure of `CategoryResult` used within the application.
113
+ *
114
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#categoryresult}
115
+ */
84
116
  export type CategoryResult = z.infer<typeof categoryResultSchema>;
117
+ /**
118
+ * Type Definition: `GroupResult`
119
+ *
120
+ * This type is derived from a Zod schema and represents
121
+ * the validated structure of `GroupResult` used within the application.
122
+ *
123
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#groupresult}
124
+ */
85
125
  export type GroupResult = z.infer<typeof groupResultSchema>;
126
+ /**
127
+ * Type Definition: `AuditResult`
128
+ *
129
+ * This type is derived from a Zod schema and represents
130
+ * the validated structure of `AuditResult` used within the application.
131
+ *
132
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#auditresult}
133
+ */
86
134
  export type AuditResult = z.infer<typeof auditResultSchema>;
87
135
  export declare const reportsDiffSchema: z.ZodObject<{
88
136
  commits: z.ZodNullable<z.ZodObject<{
@@ -99,13 +147,13 @@ export declare const reportsDiffSchema: z.ZodObject<{
99
147
  author: z.ZodString;
100
148
  }, z.core.$strip>;
101
149
  }, z.core.$strip>>;
102
- portalUrl: z.ZodOptional<z.ZodString>;
150
+ portalUrl: z.ZodOptional<z.ZodURL>;
103
151
  label: z.ZodOptional<z.ZodString>;
104
152
  categories: z.ZodObject<{
105
153
  changed: z.ZodArray<z.ZodObject<{
106
154
  slug: z.ZodString;
107
155
  title: z.ZodString;
108
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
156
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
109
157
  scores: z.ZodObject<{
110
158
  before: z.ZodNumber;
111
159
  after: z.ZodNumber;
@@ -115,19 +163,19 @@ export declare const reportsDiffSchema: z.ZodObject<{
115
163
  unchanged: z.ZodArray<z.ZodObject<{
116
164
  slug: z.ZodString;
117
165
  title: z.ZodString;
118
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
166
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
119
167
  score: z.ZodNumber;
120
168
  }, z.core.$strip>>;
121
169
  added: z.ZodArray<z.ZodObject<{
122
170
  slug: z.ZodString;
123
171
  title: z.ZodString;
124
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
172
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
125
173
  score: z.ZodNumber;
126
174
  }, z.core.$strip>>;
127
175
  removed: z.ZodArray<z.ZodObject<{
128
176
  slug: z.ZodString;
129
177
  title: z.ZodString;
130
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
178
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
131
179
  score: z.ZodNumber;
132
180
  }, z.core.$strip>>;
133
181
  }, z.core.$strip>;
@@ -140,43 +188,43 @@ export declare const reportsDiffSchema: z.ZodObject<{
140
188
  }, z.core.$strip>;
141
189
  slug: z.ZodString;
142
190
  title: z.ZodString;
143
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
191
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
144
192
  plugin: z.ZodObject<{
145
193
  slug: z.ZodString;
146
194
  title: z.ZodString;
147
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
195
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
148
196
  }, z.core.$strip>;
149
197
  }, z.core.$strip>>;
150
198
  unchanged: z.ZodArray<z.ZodObject<{
151
199
  slug: z.ZodString;
152
200
  title: z.ZodString;
153
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
201
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
154
202
  plugin: z.ZodObject<{
155
203
  slug: z.ZodString;
156
204
  title: z.ZodString;
157
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
205
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
158
206
  }, z.core.$strip>;
159
207
  score: z.ZodNumber;
160
208
  }, z.core.$strip>>;
161
209
  added: z.ZodArray<z.ZodObject<{
162
210
  slug: z.ZodString;
163
211
  title: z.ZodString;
164
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
212
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
165
213
  plugin: z.ZodObject<{
166
214
  slug: z.ZodString;
167
215
  title: z.ZodString;
168
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
216
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
169
217
  }, z.core.$strip>;
170
218
  score: z.ZodNumber;
171
219
  }, z.core.$strip>>;
172
220
  removed: z.ZodArray<z.ZodObject<{
173
221
  slug: z.ZodString;
174
222
  title: z.ZodString;
175
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
223
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
176
224
  plugin: z.ZodObject<{
177
225
  slug: z.ZodString;
178
226
  title: z.ZodString;
179
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
227
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
180
228
  }, z.core.$strip>;
181
229
  score: z.ZodNumber;
182
230
  }, z.core.$strip>>;
@@ -190,11 +238,11 @@ export declare const reportsDiffSchema: z.ZodObject<{
190
238
  }, z.core.$strip>;
191
239
  slug: z.ZodString;
192
240
  title: z.ZodString;
193
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
241
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
194
242
  plugin: z.ZodObject<{
195
243
  slug: z.ZodString;
196
244
  title: z.ZodString;
197
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
245
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
198
246
  }, z.core.$strip>;
199
247
  values: z.ZodObject<{
200
248
  before: z.ZodNumber;
@@ -209,11 +257,11 @@ export declare const reportsDiffSchema: z.ZodObject<{
209
257
  unchanged: z.ZodArray<z.ZodObject<{
210
258
  slug: z.ZodString;
211
259
  title: z.ZodString;
212
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
260
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
213
261
  plugin: z.ZodObject<{
214
262
  slug: z.ZodString;
215
263
  title: z.ZodString;
216
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
264
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
217
265
  }, z.core.$strip>;
218
266
  value: z.ZodNumber;
219
267
  displayValue: z.ZodOptional<z.ZodString>;
@@ -222,11 +270,11 @@ export declare const reportsDiffSchema: z.ZodObject<{
222
270
  added: z.ZodArray<z.ZodObject<{
223
271
  slug: z.ZodString;
224
272
  title: z.ZodString;
225
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
273
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
226
274
  plugin: z.ZodObject<{
227
275
  slug: z.ZodString;
228
276
  title: z.ZodString;
229
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
277
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
230
278
  }, z.core.$strip>;
231
279
  value: z.ZodNumber;
232
280
  displayValue: z.ZodOptional<z.ZodString>;
@@ -235,11 +283,11 @@ export declare const reportsDiffSchema: z.ZodObject<{
235
283
  removed: z.ZodArray<z.ZodObject<{
236
284
  slug: z.ZodString;
237
285
  title: z.ZodString;
238
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
286
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
239
287
  plugin: z.ZodObject<{
240
288
  slug: z.ZodString;
241
289
  title: z.ZodString;
242
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
290
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
243
291
  }, z.core.$strip>;
244
292
  value: z.ZodNumber;
245
293
  displayValue: z.ZodOptional<z.ZodString>;
@@ -251,4 +299,12 @@ export declare const reportsDiffSchema: z.ZodObject<{
251
299
  date: z.ZodString;
252
300
  duration: z.ZodNumber;
253
301
  }, z.core.$strip>;
302
+ /**
303
+ * Type Definition: `ReportsDiff`
304
+ *
305
+ * This type is derived from a Zod schema and represents
306
+ * the validated structure of `ReportsDiff` used within the application.
307
+ *
308
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#reportsdiff}
309
+ */
254
310
  export type ReportsDiff = z.infer<typeof reportsDiffSchema>;
@@ -1,5 +1,5 @@
1
1
  import { z } from 'zod/v4';
2
- export declare const outputTransformSchema: z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.core.$ZodTuple<[z.ZodUnknown], null>, z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
2
+ export declare const outputTransformSchema: z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [z.ZodUnknown], null>, z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
3
3
  slug: z.ZodString;
4
4
  displayValue: z.ZodOptional<z.ZodString>;
5
5
  value: z.ZodNumber;
@@ -118,6 +118,14 @@ export declare const outputTransformSchema: z.ZodPipe<z.ZodCustom<unknown, unkno
118
118
  }, z.core.$strip>]>>>;
119
119
  }, z.core.$strip>>;
120
120
  }, z.core.$strip>>>]>>, unknown>>;
121
+ /**
122
+ * Type Definition: `OutputTransform`
123
+ *
124
+ * This type is derived from a Zod schema and represents
125
+ * the validated structure of `OutputTransform` used within the application.
126
+ *
127
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#outputtransform}
128
+ */
121
129
  export type OutputTransform = z.infer<typeof outputTransformSchema>;
122
130
  export declare const runnerArgsSchema: z.ZodObject<{
123
131
  persist: z.ZodObject<{
@@ -130,12 +138,20 @@ export declare const runnerArgsSchema: z.ZodObject<{
130
138
  skipReports: z.ZodNonOptional<z.ZodOptional<z.ZodBoolean>>;
131
139
  }, z.core.$strip>;
132
140
  }, z.core.$strip>;
141
+ /**
142
+ * Type Definition: `RunnerArgs`
143
+ *
144
+ * This type is derived from a Zod schema and represents
145
+ * the validated structure of `RunnerArgs` used within the application.
146
+ *
147
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#runnerargs}
148
+ */
133
149
  export type RunnerArgs = z.infer<typeof runnerArgsSchema>;
134
150
  export declare const runnerConfigSchema: z.ZodObject<{
135
151
  command: z.ZodString;
136
152
  args: z.ZodOptional<z.ZodArray<z.ZodString>>;
137
153
  outputFile: z.ZodString;
138
- outputTransform: z.ZodOptional<z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.core.$ZodTuple<[z.ZodUnknown], null>, z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
154
+ outputTransform: z.ZodOptional<z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [z.ZodUnknown], null>, z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
139
155
  slug: z.ZodString;
140
156
  displayValue: z.ZodOptional<z.ZodString>;
141
157
  value: z.ZodNumber;
@@ -256,8 +272,16 @@ export declare const runnerConfigSchema: z.ZodObject<{
256
272
  }, z.core.$strip>>>]>>, unknown>>>;
257
273
  configFile: z.ZodOptional<z.ZodString>;
258
274
  }, z.core.$strip>;
275
+ /**
276
+ * Type Definition: `RunnerConfig`
277
+ *
278
+ * This type is derived from a Zod schema and represents
279
+ * the validated structure of `RunnerConfig` used within the application.
280
+ *
281
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#runnerconfig}
282
+ */
259
283
  export type RunnerConfig = z.infer<typeof runnerConfigSchema>;
260
- export declare const runnerFunctionSchema: z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.core.$ZodTuple<[z.ZodObject<{
284
+ export declare const runnerFunctionSchema: z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [z.ZodObject<{
261
285
  persist: z.ZodObject<{
262
286
  outputDir: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
263
287
  filename: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
@@ -386,9 +410,25 @@ export declare const runnerFunctionSchema: z.ZodPipe<z.ZodCustom<unknown, unknow
386
410
  }, z.core.$strip>]>>>;
387
411
  }, z.core.$strip>>;
388
412
  }, z.core.$strip>>>]>>, unknown>>;
413
+ /**
414
+ * Type Definition: `RunnerFunction`
415
+ *
416
+ * This type is derived from a Zod schema and represents
417
+ * the validated structure of `RunnerFunction` used within the application.
418
+ *
419
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#runnerfunction}
420
+ */
389
421
  export type RunnerFunction = z.infer<typeof runnerFunctionSchema>;
390
422
  export declare const runnerFilesPathsSchema: z.ZodObject<{
391
423
  runnerConfigPath: z.ZodString;
392
424
  runnerOutputPath: z.ZodString;
393
425
  }, z.core.$strip>;
426
+ /**
427
+ * Type Definition: `RunnerFilesPaths`
428
+ *
429
+ * This type is derived from a Zod schema and represents
430
+ * the validated structure of `RunnerFilesPaths` used within the application.
431
+ *
432
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#runnerfilespaths}
433
+ */
394
434
  export type RunnerFilesPaths = z.infer<typeof runnerFilesPathsSchema>;
@@ -8,4 +8,12 @@ export declare const sourceFileLocationSchema: z.ZodObject<{
8
8
  endColumn: z.ZodOptional<z.ZodNumber>;
9
9
  }, z.core.$strip>>;
10
10
  }, z.core.$strip>;
11
+ /**
12
+ * Type Definition: `SourceFileLocation`
13
+ *
14
+ * This type is derived from a Zod schema and represents
15
+ * the validated structure of `SourceFileLocation` used within the application.
16
+ *
17
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#sourcefilelocation}
18
+ */
11
19
  export type SourceFileLocation = z.infer<typeof sourceFileLocationSchema>;
@@ -4,12 +4,28 @@ export declare const tableAlignmentSchema: z.ZodEnum<{
4
4
  center: "center";
5
5
  right: "right";
6
6
  }>;
7
+ /**
8
+ * Type Definition: `TableAlignment`
9
+ *
10
+ * This type is derived from a Zod schema and represents
11
+ * the validated structure of `TableAlignment` used within the application.
12
+ *
13
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tablealignment}
14
+ */
7
15
  export type TableAlignment = z.infer<typeof tableAlignmentSchema>;
8
16
  export declare const tableColumnPrimitiveSchema: z.ZodEnum<{
9
17
  left: "left";
10
18
  center: "center";
11
19
  right: "right";
12
20
  }>;
21
+ /**
22
+ * Type Definition: `TableColumnPrimitive`
23
+ *
24
+ * This type is derived from a Zod schema and represents
25
+ * the validated structure of `TableColumnPrimitive` used within the application.
26
+ *
27
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tablecolumnprimitive}
28
+ */
13
29
  export type TableColumnPrimitive = z.infer<typeof tableColumnPrimitiveSchema>;
14
30
  export declare const tableColumnObjectSchema: z.ZodObject<{
15
31
  key: z.ZodString;
@@ -20,10 +36,34 @@ export declare const tableColumnObjectSchema: z.ZodObject<{
20
36
  right: "right";
21
37
  }>>;
22
38
  }, z.core.$strip>;
39
+ /**
40
+ * Type Definition: `TableColumnObject`
41
+ *
42
+ * This type is derived from a Zod schema and represents
43
+ * the validated structure of `TableColumnObject` used within the application.
44
+ *
45
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tablecolumnobject}
46
+ */
23
47
  export type TableColumnObject = z.infer<typeof tableColumnObjectSchema>;
24
48
  export declare const tableRowObjectSchema: z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
49
+ /**
50
+ * Type Definition: `TableRowObject`
51
+ *
52
+ * This type is derived from a Zod schema and represents
53
+ * the validated structure of `TableRowObject` used within the application.
54
+ *
55
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tablerowobject}
56
+ */
25
57
  export type TableRowObject = z.infer<typeof tableRowObjectSchema>;
26
58
  export declare const tableRowPrimitiveSchema: z.ZodArray<z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
59
+ /**
60
+ * Type Definition: `TableRowPrimitive`
61
+ *
62
+ * This type is derived from a Zod schema and represents
63
+ * the validated structure of `TableRowPrimitive` used within the application.
64
+ *
65
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tablerowprimitive}
66
+ */
27
67
  export type TableRowPrimitive = z.infer<typeof tableRowPrimitiveSchema>;
28
68
  export declare const tableSchema: (description?: string) => z.ZodUnion<readonly [z.ZodObject<{
29
69
  title: z.ZodOptional<z.ZodString>;
@@ -50,4 +90,12 @@ export declare const tableSchema: (description?: string) => z.ZodUnion<readonly
50
90
  }, z.core.$strip>>]>>;
51
91
  rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>>;
52
92
  }, z.core.$strip>]>;
93
+ /**
94
+ * Type Definition: `Table`
95
+ *
96
+ * This type is derived from a Zod schema and represents
97
+ * the validated structure of `Table` used within the application.
98
+ *
99
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#table}
100
+ */
53
101
  export type Table = z.infer<ReturnType<typeof tableSchema>>;
package/src/lib/tree.d.ts CHANGED
@@ -4,6 +4,14 @@ declare const basicTreeNodeDataSchema: z.ZodObject<{
4
4
  values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
5
5
  }, z.core.$strip>;
6
6
  export declare const basicTreeNodeSchema: z.ZodType<BasicTreeNode>;
7
+ /**
8
+ * Type Definition: `BasicTreeNode`
9
+ *
10
+ * This type is derived from a Zod schema and represents
11
+ * the validated structure of `BasicTreeNode` used within the application.
12
+ *
13
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#basictreenode}
14
+ */
7
15
  export type BasicTreeNode = z.infer<typeof basicTreeNodeDataSchema> & {
8
16
  children?: BasicTreeNode[];
9
17
  };
@@ -15,6 +23,14 @@ export declare const coverageTreeMissingLOCSchema: z.ZodObject<{
15
23
  name: z.ZodOptional<z.ZodString>;
16
24
  kind: z.ZodOptional<z.ZodString>;
17
25
  }, z.core.$strip>;
26
+ /**
27
+ * Type Definition: `CoverageTreeMissingLOC`
28
+ *
29
+ * This type is derived from a Zod schema and represents
30
+ * the validated structure of `CoverageTreeMissingLOC` used within the application.
31
+ *
32
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#coveragetreemissingloc}
33
+ */
18
34
  export type CoverageTreeMissingLOC = z.infer<typeof coverageTreeMissingLOCSchema>;
19
35
  declare const coverageTreeNodeDataSchema: z.ZodObject<{
20
36
  name: z.ZodString;
@@ -31,6 +47,14 @@ declare const coverageTreeNodeDataSchema: z.ZodObject<{
31
47
  }, z.core.$strip>;
32
48
  }, z.core.$strip>;
33
49
  export declare const coverageTreeNodeSchema: z.ZodType<CoverageTreeNode>;
50
+ /**
51
+ * Type Definition: `CoverageTreeNode`
52
+ *
53
+ * This type is derived from a Zod schema and represents
54
+ * the validated structure of `CoverageTreeNode` used within the application.
55
+ *
56
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#coveragetreenode}
57
+ */
34
58
  export type CoverageTreeNode = z.infer<typeof coverageTreeNodeDataSchema> & {
35
59
  children?: CoverageTreeNode[];
36
60
  };
@@ -39,12 +63,28 @@ export declare const basicTreeSchema: z.ZodObject<{
39
63
  type: z.ZodOptional<z.ZodLiteral<"basic">>;
40
64
  root: z.ZodType<BasicTreeNode, unknown, z.core.$ZodTypeInternals<BasicTreeNode, unknown>>;
41
65
  }, z.core.$strip>;
66
+ /**
67
+ * Type Definition: `BasicTree`
68
+ *
69
+ * This type is derived from a Zod schema and represents
70
+ * the validated structure of `BasicTree` used within the application.
71
+ *
72
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#basictree}
73
+ */
42
74
  export type BasicTree = z.infer<typeof basicTreeSchema>;
43
75
  export declare const coverageTreeSchema: z.ZodObject<{
44
76
  title: z.ZodOptional<z.ZodString>;
45
77
  type: z.ZodLiteral<"coverage">;
46
78
  root: z.ZodType<CoverageTreeNode, unknown, z.core.$ZodTypeInternals<CoverageTreeNode, unknown>>;
47
79
  }, z.core.$strip>;
80
+ /**
81
+ * Type Definition: `CoverageTree`
82
+ *
83
+ * This type is derived from a Zod schema and represents
84
+ * the validated structure of `CoverageTree` used within the application.
85
+ *
86
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#coveragetree}
87
+ */
48
88
  export type CoverageTree = z.infer<typeof coverageTreeSchema>;
49
89
  export declare const treeSchema: z.ZodUnion<readonly [z.ZodObject<{
50
90
  title: z.ZodOptional<z.ZodString>;
@@ -55,5 +95,13 @@ export declare const treeSchema: z.ZodUnion<readonly [z.ZodObject<{
55
95
  type: z.ZodLiteral<"coverage">;
56
96
  root: z.ZodType<CoverageTreeNode, unknown, z.core.$ZodTypeInternals<CoverageTreeNode, unknown>>;
57
97
  }, z.core.$strip>]>;
98
+ /**
99
+ * Type Definition: `Tree`
100
+ *
101
+ * This type is derived from a Zod schema and represents
102
+ * the validated structure of `Tree` used within the application.
103
+ *
104
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tree}
105
+ */
58
106
  export type Tree = z.infer<typeof treeSchema>;
59
107
  export {};
@@ -1,9 +1,17 @@
1
1
  import { z } from 'zod';
2
2
  export declare const uploadConfigSchema: z.ZodObject<{
3
- server: z.ZodString;
3
+ server: z.ZodURL;
4
4
  apiKey: z.ZodString;
5
5
  organization: z.ZodString;
6
6
  project: z.ZodString;
7
7
  timeout: z.ZodOptional<z.ZodNumber>;
8
8
  }, z.core.$strip>;
9
+ /**
10
+ * Type Definition: `UploadConfig`
11
+ *
12
+ * This type is derived from a Zod schema and represents
13
+ * the validated structure of `UploadConfig` used within the application.
14
+ *
15
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#uploadconfig}
16
+ */
9
17
  export type UploadConfig = z.infer<typeof uploadConfigSchema>;