@code-pushup/models 0.106.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.
@@ -1,10 +1,26 @@
1
1
  import { ZodError, type ZodType, z } from 'zod';
2
+ /**
3
+ * Type Definition: `SchemaValidationContext`
4
+ *
5
+ * This type is derived from a Zod schema and represents
6
+ * the validated structure of `SchemaValidationContext` used within the application.
7
+ *
8
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#schemavalidationcontext}
9
+ */
2
10
  type SchemaValidationContext = {
3
11
  filePath?: string;
4
12
  };
5
13
  /**
6
14
  * Autocompletes valid Zod Schema input for convience, but will accept any other data as well
7
15
  */
16
+ /**
17
+ * Type Definition: `ZodInputLooseAutocomplete`
18
+ *
19
+ * This type is derived from a Zod schema and represents
20
+ * the validated structure of `ZodInputLooseAutocomplete` used within the application.
21
+ *
22
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#zodinputlooseautocomplete}
23
+ */
8
24
  type ZodInputLooseAutocomplete<T extends ZodType> = z.input<T> | {} | null | undefined;
9
25
  export declare class SchemaValidationError extends Error {
10
26
  constructor(error: ZodError, schema: ZodType, { filePath }: SchemaValidationContext);
@@ -4,6 +4,14 @@ export declare const issueSeveritySchema: z.ZodEnum<{
4
4
  info: "info";
5
5
  warning: "warning";
6
6
  }>;
7
+ /**
8
+ * Type Definition: `IssueSeverity`
9
+ *
10
+ * This type is derived from a Zod schema and represents
11
+ * the validated structure of `IssueSeverity` used within the application.
12
+ *
13
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#issueseverity}
14
+ */
7
15
  export type IssueSeverity = z.infer<typeof issueSeveritySchema>;
8
16
  export declare const issueSchema: z.ZodObject<{
9
17
  message: z.ZodString;
@@ -22,4 +30,12 @@ export declare const issueSchema: z.ZodObject<{
22
30
  }, z.core.$strip>>;
23
31
  }, z.core.$strip>>;
24
32
  }, z.core.$strip>;
33
+ /**
34
+ * Type Definition: `Issue`
35
+ *
36
+ * This type is derived from a Zod schema and represents
37
+ * the validated structure of `Issue` used within the application.
38
+ *
39
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#issue}
40
+ */
25
41
  export type Issue = z.infer<typeof issueSchema>;
@@ -3,6 +3,14 @@ export declare const formatSchema: z.ZodEnum<{
3
3
  json: "json";
4
4
  md: "md";
5
5
  }>;
6
+ /**
7
+ * Type Definition: `Format`
8
+ *
9
+ * This type is derived from a Zod schema and represents
10
+ * the validated structure of `Format` used within the application.
11
+ *
12
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#format}
13
+ */
6
14
  export type Format = z.infer<typeof formatSchema>;
7
15
  export declare const persistConfigSchema: z.ZodObject<{
8
16
  outputDir: z.ZodOptional<z.ZodString>;
@@ -13,4 +21,12 @@ export declare const persistConfigSchema: z.ZodObject<{
13
21
  }>>>;
14
22
  skipReports: z.ZodOptional<z.ZodBoolean>;
15
23
  }, z.core.$strip>;
24
+ /**
25
+ * Type Definition: `PersistConfig`
26
+ *
27
+ * This type is derived from a Zod schema and represents
28
+ * the validated structure of `PersistConfig` used within the application.
29
+ *
30
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#persistconfig}
31
+ */
16
32
  export type PersistConfig = z.infer<typeof persistConfigSchema>;
@@ -2,13 +2,21 @@ import { z } from 'zod';
2
2
  import { type Audit } from './audit.js';
3
3
  import { type Group } from './group.js';
4
4
  export declare const pluginContextSchema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
5
+ /**
6
+ * Type Definition: `PluginContext`
7
+ *
8
+ * This type is derived from a Zod schema and represents
9
+ * the validated structure of `PluginContext` used within the application.
10
+ *
11
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#plugincontext}
12
+ */
5
13
  export type PluginContext = z.infer<typeof pluginContextSchema>;
6
14
  export declare const pluginMetaSchema: z.ZodObject<{
7
15
  packageName: z.ZodOptional<z.ZodString>;
8
16
  version: z.ZodOptional<z.ZodString>;
9
17
  title: z.ZodString;
10
18
  description: z.ZodOptional<z.ZodString>;
11
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
19
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
12
20
  isSkipped: z.ZodOptional<z.ZodBoolean>;
13
21
  slug: z.ZodString;
14
22
  icon: z.ZodEnum<{
@@ -872,15 +880,31 @@ export declare const pluginMetaSchema: z.ZodObject<{
872
880
  silverstripe: "silverstripe";
873
881
  }>;
874
882
  }, z.core.$strip>;
883
+ /**
884
+ * Type Definition: `PluginMeta`
885
+ *
886
+ * This type is derived from a Zod schema and represents
887
+ * the validated structure of `PluginMeta` used within the application.
888
+ *
889
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#pluginmeta}
890
+ */
875
891
  export type PluginMeta = z.infer<typeof pluginMetaSchema>;
876
892
  export declare const pluginScoreTargetsSchema: z.ZodOptional<z.ZodUnion<readonly [z.ZodOptional<z.ZodNumber>, z.ZodRecord<z.ZodString, z.ZodNonOptional<z.ZodOptional<z.ZodNumber>>>]>>;
893
+ /**
894
+ * Type Definition: `PluginScoreTargets`
895
+ *
896
+ * This type is derived from a Zod schema and represents
897
+ * the validated structure of `PluginScoreTargets` used within the application.
898
+ *
899
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#pluginscoretargets}
900
+ */
877
901
  export type PluginScoreTargets = z.infer<typeof pluginScoreTargetsSchema>;
878
902
  export declare const pluginDataSchema: z.ZodObject<{
879
903
  runner: z.ZodUnion<readonly [z.ZodObject<{
880
904
  command: z.ZodString;
881
905
  args: z.ZodOptional<z.ZodArray<z.ZodString>>;
882
906
  outputFile: z.ZodString;
883
- 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<{
907
+ 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<{
884
908
  slug: z.ZodString;
885
909
  displayValue: z.ZodOptional<z.ZodString>;
886
910
  value: z.ZodNumber;
@@ -1000,7 +1024,7 @@ export declare const pluginDataSchema: z.ZodObject<{
1000
1024
  }, z.core.$strip>>;
1001
1025
  }, z.core.$strip>>>]>>, unknown>>>;
1002
1026
  configFile: z.ZodOptional<z.ZodString>;
1003
- }, z.core.$strip>, z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.core.$ZodTuple<[z.ZodObject<{
1027
+ }, z.core.$strip>, z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [z.ZodObject<{
1004
1028
  persist: z.ZodObject<{
1005
1029
  outputDir: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
1006
1030
  filename: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
@@ -1133,7 +1157,7 @@ export declare const pluginDataSchema: z.ZodObject<{
1133
1157
  slug: z.ZodString;
1134
1158
  title: z.ZodString;
1135
1159
  description: z.ZodOptional<z.ZodString>;
1136
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
1160
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
1137
1161
  isSkipped: z.ZodOptional<z.ZodBoolean>;
1138
1162
  }, z.core.$strip>>;
1139
1163
  groups: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -1144,7 +1168,7 @@ export declare const pluginDataSchema: z.ZodObject<{
1144
1168
  }, z.core.$strip>>;
1145
1169
  title: z.ZodString;
1146
1170
  description: z.ZodOptional<z.ZodString>;
1147
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
1171
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
1148
1172
  isSkipped: z.ZodOptional<z.ZodBoolean>;
1149
1173
  }, z.core.$strip>>>;
1150
1174
  scoreTargets: z.ZodOptional<z.ZodUnion<readonly [z.ZodOptional<z.ZodNumber>, z.ZodRecord<z.ZodString, z.ZodNonOptional<z.ZodOptional<z.ZodNumber>>>]>>;
@@ -1155,7 +1179,7 @@ export declare const pluginConfigSchema: z.ZodObject<{
1155
1179
  version: z.ZodOptional<z.ZodString>;
1156
1180
  title: z.ZodString;
1157
1181
  description: z.ZodOptional<z.ZodString>;
1158
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
1182
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
1159
1183
  isSkipped: z.ZodOptional<z.ZodBoolean>;
1160
1184
  slug: z.ZodString;
1161
1185
  icon: z.ZodEnum<{
@@ -2022,7 +2046,7 @@ export declare const pluginConfigSchema: z.ZodObject<{
2022
2046
  command: z.ZodString;
2023
2047
  args: z.ZodOptional<z.ZodArray<z.ZodString>>;
2024
2048
  outputFile: z.ZodString;
2025
- 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<{
2049
+ 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<{
2026
2050
  slug: z.ZodString;
2027
2051
  displayValue: z.ZodOptional<z.ZodString>;
2028
2052
  value: z.ZodNumber;
@@ -2142,7 +2166,7 @@ export declare const pluginConfigSchema: z.ZodObject<{
2142
2166
  }, z.core.$strip>>;
2143
2167
  }, z.core.$strip>>>]>>, unknown>>>;
2144
2168
  configFile: z.ZodOptional<z.ZodString>;
2145
- }, z.core.$strip>, z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.core.$ZodTuple<[z.ZodObject<{
2169
+ }, z.core.$strip>, z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [z.ZodObject<{
2146
2170
  persist: z.ZodObject<{
2147
2171
  outputDir: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
2148
2172
  filename: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
@@ -2275,7 +2299,7 @@ export declare const pluginConfigSchema: z.ZodObject<{
2275
2299
  slug: z.ZodString;
2276
2300
  title: z.ZodString;
2277
2301
  description: z.ZodOptional<z.ZodString>;
2278
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
2302
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
2279
2303
  isSkipped: z.ZodOptional<z.ZodBoolean>;
2280
2304
  }, z.core.$strip>>;
2281
2305
  groups: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -2286,14 +2310,30 @@ export declare const pluginConfigSchema: z.ZodObject<{
2286
2310
  }, z.core.$strip>>;
2287
2311
  title: z.ZodString;
2288
2312
  description: z.ZodOptional<z.ZodString>;
2289
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
2313
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
2290
2314
  isSkipped: z.ZodOptional<z.ZodBoolean>;
2291
2315
  }, z.core.$strip>>>;
2292
2316
  scoreTargets: z.ZodOptional<z.ZodUnion<readonly [z.ZodOptional<z.ZodNumber>, z.ZodRecord<z.ZodString, z.ZodNonOptional<z.ZodOptional<z.ZodNumber>>>]>>;
2293
2317
  context: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
2294
2318
  }, z.core.$strip>;
2319
+ /**
2320
+ * Type Definition: `PluginConfig`
2321
+ *
2322
+ * This type is derived from a Zod schema and represents
2323
+ * the validated structure of `PluginConfig` used within the application.
2324
+ *
2325
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#pluginconfig}
2326
+ */
2295
2327
  export type PluginConfig = z.infer<typeof pluginConfigSchema>;
2296
2328
  export declare const pluginUrlsSchema: z.ZodUnion<readonly [z.ZodURL, z.ZodArray<z.ZodURL>, z.ZodRecord<z.ZodURL, z.ZodNumber>]>;
2329
+ /**
2330
+ * Type Definition: `PluginUrls`
2331
+ *
2332
+ * This type is derived from a Zod schema and represents
2333
+ * the validated structure of `PluginUrls` used within the application.
2334
+ *
2335
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#pluginurls}
2336
+ */
2297
2337
  export type PluginUrls = z.infer<typeof pluginUrlsSchema>;
2298
2338
  export declare function findMissingSlugsInGroupRefs<T extends {
2299
2339
  audits: Audit[];
@@ -2,7 +2,7 @@ import { z } from 'zod';
2
2
  export declare const auditReportSchema: z.ZodObject<{
3
3
  title: z.ZodString;
4
4
  description: z.ZodOptional<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
  isSkipped: z.ZodOptional<z.ZodBoolean>;
7
7
  slug: z.ZodString;
8
8
  displayValue: z.ZodOptional<z.ZodString>;
@@ -63,13 +63,21 @@ export declare const auditReportSchema: z.ZodObject<{
63
63
  }, z.core.$strip>]>>>;
64
64
  }, z.core.$strip>>;
65
65
  }, z.core.$strip>;
66
+ /**
67
+ * Type Definition: `AuditReport`
68
+ *
69
+ * This type is derived from a Zod schema and represents
70
+ * the validated structure of `AuditReport` used within the application.
71
+ *
72
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#auditreport}
73
+ */
66
74
  export type AuditReport = z.infer<typeof auditReportSchema>;
67
75
  export declare const pluginReportSchema: z.ZodObject<{
68
76
  packageName: z.ZodOptional<z.ZodString>;
69
77
  version: z.ZodOptional<z.ZodString>;
70
78
  title: z.ZodString;
71
79
  description: z.ZodOptional<z.ZodString>;
72
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
80
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
73
81
  isSkipped: z.ZodOptional<z.ZodBoolean>;
74
82
  slug: z.ZodString;
75
83
  icon: z.ZodEnum<{
@@ -937,7 +945,7 @@ export declare const pluginReportSchema: z.ZodObject<{
937
945
  audits: z.ZodArray<z.ZodObject<{
938
946
  title: z.ZodString;
939
947
  description: z.ZodOptional<z.ZodString>;
940
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
948
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
941
949
  isSkipped: z.ZodOptional<z.ZodBoolean>;
942
950
  slug: z.ZodString;
943
951
  displayValue: z.ZodOptional<z.ZodString>;
@@ -1006,10 +1014,18 @@ export declare const pluginReportSchema: z.ZodObject<{
1006
1014
  }, z.core.$strip>>;
1007
1015
  title: z.ZodString;
1008
1016
  description: z.ZodOptional<z.ZodString>;
1009
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
1017
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
1010
1018
  isSkipped: z.ZodOptional<z.ZodBoolean>;
1011
1019
  }, z.core.$strip>>>;
1012
1020
  }, z.core.$strip>;
1021
+ /**
1022
+ * Type Definition: `PluginReport`
1023
+ *
1024
+ * This type is derived from a Zod schema and represents
1025
+ * the validated structure of `PluginReport` used within the application.
1026
+ *
1027
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#pluginreport}
1028
+ */
1013
1029
  export type PluginReport = z.infer<typeof pluginReportSchema>;
1014
1030
  export declare const reportSchema: z.ZodObject<{
1015
1031
  packageName: z.ZodString;
@@ -1021,7 +1037,7 @@ export declare const reportSchema: z.ZodObject<{
1021
1037
  version: z.ZodOptional<z.ZodString>;
1022
1038
  title: z.ZodString;
1023
1039
  description: z.ZodOptional<z.ZodString>;
1024
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
1040
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
1025
1041
  isSkipped: z.ZodOptional<z.ZodBoolean>;
1026
1042
  slug: z.ZodString;
1027
1043
  icon: z.ZodEnum<{
@@ -1889,7 +1905,7 @@ export declare const reportSchema: z.ZodObject<{
1889
1905
  audits: z.ZodArray<z.ZodObject<{
1890
1906
  title: z.ZodString;
1891
1907
  description: z.ZodOptional<z.ZodString>;
1892
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
1908
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
1893
1909
  isSkipped: z.ZodOptional<z.ZodBoolean>;
1894
1910
  slug: z.ZodString;
1895
1911
  displayValue: z.ZodOptional<z.ZodString>;
@@ -1958,7 +1974,7 @@ export declare const reportSchema: z.ZodObject<{
1958
1974
  }, z.core.$strip>>;
1959
1975
  title: z.ZodString;
1960
1976
  description: z.ZodOptional<z.ZodString>;
1961
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
1977
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
1962
1978
  isSkipped: z.ZodOptional<z.ZodBoolean>;
1963
1979
  }, z.core.$strip>>>;
1964
1980
  }, z.core.$strip>>;
@@ -1975,7 +1991,7 @@ export declare const reportSchema: z.ZodObject<{
1975
1991
  }, z.core.$strip>>;
1976
1992
  title: z.ZodString;
1977
1993
  description: z.ZodOptional<z.ZodString>;
1978
- docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
1994
+ docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
1979
1995
  isSkipped: z.ZodOptional<z.ZodBoolean>;
1980
1996
  scoreTarget: z.ZodOptional<z.ZodNumber>;
1981
1997
  }, z.core.$strip>>>;
@@ -1987,4 +2003,12 @@ export declare const reportSchema: z.ZodObject<{
1987
2003
  }, z.core.$strip>>;
1988
2004
  label: z.ZodOptional<z.ZodString>;
1989
2005
  }, z.core.$strip>;
2006
+ /**
2007
+ * Type Definition: `Report`
2008
+ *
2009
+ * This type is derived from a Zod schema and represents
2010
+ * the validated structure of `Report` used within the application.
2011
+ *
2012
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#report}
2013
+ */
1990
2014
  export type Report = z.infer<typeof reportSchema>;
@@ -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>;