@code-pushup/models 0.89.2 → 0.90.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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@code-pushup/models",
3
- "version": "0.89.2",
3
+ "version": "0.90.0",
4
4
  "license": "MIT",
5
5
  "description": "Model definitions and validators for the Code PushUp CLI",
6
6
  "homepage": "https://github.com/code-pushup/cli/tree/main/packages/models#readme",
@@ -54,14 +54,6 @@ export declare const auditDetailsSchema: z.ZodObject<{
54
54
  root: z.ZodType<import("./tree.js").CoverageTreeNode, unknown, z.core.$ZodTypeInternals<import("./tree.js").CoverageTreeNode, unknown>>;
55
55
  }, z.core.$strip>]>>>;
56
56
  }, z.core.$strip>;
57
- /**
58
- * Type Definition: `AuditDetails`
59
- *
60
- * This type is derived from a Zod schema and represents
61
- * the validated structure of `AuditDetails` used within the application.
62
- *
63
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#auditdetails}
64
- */
65
57
  export type AuditDetails = z.infer<typeof auditDetailsSchema>;
66
58
  export declare const auditOutputSchema: z.ZodObject<{
67
59
  slug: z.ZodString;
@@ -123,14 +115,6 @@ export declare const auditOutputSchema: z.ZodObject<{
123
115
  }, z.core.$strip>]>>>;
124
116
  }, z.core.$strip>>;
125
117
  }, z.core.$strip>;
126
- /**
127
- * Type Definition: `AuditOutput`
128
- *
129
- * This type is derived from a Zod schema and represents
130
- * the validated structure of `AuditOutput` used within the application.
131
- *
132
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#auditoutput}
133
- */
134
118
  export type AuditOutput = z.infer<typeof auditOutputSchema>;
135
119
  export declare const auditOutputsSchema: z.ZodArray<z.ZodObject<{
136
120
  slug: z.ZodString;
@@ -192,12 +176,4 @@ export declare const auditOutputsSchema: z.ZodArray<z.ZodObject<{
192
176
  }, z.core.$strip>]>>>;
193
177
  }, z.core.$strip>>;
194
178
  }, z.core.$strip>>;
195
- /**
196
- * Type Definition: `AuditOutputs`
197
- *
198
- * This type is derived from a Zod schema and represents
199
- * the validated structure of `AuditOutputs` used within the application.
200
- *
201
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#auditoutputs}
202
- */
203
179
  export type AuditOutputs = z.infer<typeof auditOutputsSchema>;
@@ -6,14 +6,6 @@ export declare const auditSchema: z.ZodObject<{
6
6
  docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
7
7
  isSkipped: z.ZodOptional<z.ZodBoolean>;
8
8
  }, z.core.$strip>;
9
- /**
10
- * Type Definition: `Audit`
11
- *
12
- * This type is derived from a Zod schema and represents
13
- * the validated structure of `Audit` used within the application.
14
- *
15
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#audit}
16
- */
17
9
  export type Audit = z.infer<typeof auditSchema>;
18
10
  export declare const pluginAuditsSchema: z.ZodArray<z.ZodObject<{
19
11
  slug: z.ZodString;
@@ -3,35 +3,11 @@ export declare const cacheConfigObjectSchema: z.ZodObject<{
3
3
  read: z.ZodDefault<z.ZodBoolean>;
4
4
  write: z.ZodDefault<z.ZodBoolean>;
5
5
  }, z.core.$strip>;
6
- /**
7
- * Type Definition: `CacheConfigObject`
8
- *
9
- * This type is derived from a Zod schema and represents
10
- * the validated structure of `CacheConfigObject` used within the application.
11
- *
12
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#cacheconfigobject}
13
- */
14
6
  export type CacheConfigObject = z.infer<typeof cacheConfigObjectSchema>;
15
7
  export declare const cacheConfigShorthandSchema: z.ZodBoolean;
16
- /**
17
- * Type Definition: `CacheConfigShorthand`
18
- *
19
- * This type is derived from a Zod schema and represents
20
- * the validated structure of `CacheConfigShorthand` used within the application.
21
- *
22
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#cacheconfigshorthand}
23
- */
24
8
  export type CacheConfigShorthand = z.infer<typeof cacheConfigShorthandSchema>;
25
9
  export declare const cacheConfigSchema: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
26
10
  read: z.ZodDefault<z.ZodBoolean>;
27
11
  write: z.ZodDefault<z.ZodBoolean>;
28
12
  }, z.core.$strip>]>>;
29
- /**
30
- * Type Definition: `CacheConfig`
31
- *
32
- * This type is derived from a Zod schema and represents
33
- * the validated structure of `CacheConfig` used within the application.
34
- *
35
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#cacheconfig}
36
- */
37
13
  export type CacheConfig = z.infer<typeof cacheConfigSchema>;
@@ -8,14 +8,6 @@ export declare const categoryRefSchema: z.ZodObject<{
8
8
  }>;
9
9
  plugin: z.ZodString;
10
10
  }, z.core.$strip>;
11
- /**
12
- * Type Definition: `CategoryRef`
13
- *
14
- * This type is derived from a Zod schema and represents
15
- * the validated structure of `CategoryRef` used within the application.
16
- *
17
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#categoryref}
18
- */
19
11
  export type CategoryRef = z.infer<typeof categoryRefSchema>;
20
12
  export declare const categoryConfigSchema: z.ZodObject<{
21
13
  slug: z.ZodString;
@@ -34,14 +26,6 @@ export declare const categoryConfigSchema: z.ZodObject<{
34
26
  isSkipped: z.ZodOptional<z.ZodBoolean>;
35
27
  scoreTarget: z.ZodOptional<z.ZodNumber>;
36
28
  }, z.core.$strip>;
37
- /**
38
- * Type Definition: `CategoryConfig`
39
- *
40
- * This type is derived from a Zod schema and represents
41
- * the validated structure of `CategoryConfig` used within the application.
42
- *
43
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#categoryconfig}
44
- */
45
29
  export type CategoryConfig = z.infer<typeof categoryConfigSchema>;
46
30
  export declare const categoriesSchema: z.ZodArray<z.ZodObject<{
47
31
  slug: z.ZodString;
@@ -5,12 +5,4 @@ export declare const commitSchema: z.ZodObject<{
5
5
  date: z.ZodCoercedDate<unknown>;
6
6
  author: z.ZodString;
7
7
  }, z.core.$strip>;
8
- /**
9
- * Type Definition: `Commit`
10
- *
11
- * This type is derived from a Zod schema and represents
12
- * the validated structure of `Commit` used within the application.
13
- *
14
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#commit}
15
- */
16
8
  export type Commit = z.infer<typeof commitSchema>;
@@ -13,12 +13,4 @@ export declare const pluginArtifactOptionsSchema: z.ZodObject<{
13
13
  }, z.core.$strip>]>>;
14
14
  artifactsPaths: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
15
15
  }, z.core.$strip>;
16
- /**
17
- * Type Definition: `PluginArtifactOptions`
18
- *
19
- * This type is derived from a Zod schema and represents
20
- * the validated structure of `PluginArtifactOptions` used within the application.
21
- *
22
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#pluginartifactoptions}
23
- */
24
16
  export type PluginArtifactOptions = z.infer<typeof pluginArtifactOptionsSchema>;
@@ -3535,12 +3535,4 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
3535
3535
  scoreTarget: z.ZodOptional<z.ZodNumber>;
3536
3536
  }, z.core.$strip>>>;
3537
3537
  }, z.core.$strip>;
3538
- /**
3539
- * Type Definition: `CoreConfig`
3540
- *
3541
- * This type is derived from a Zod schema and represents
3542
- * the validated structure of `CoreConfig` used within the application.
3543
- *
3544
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#coreconfig}
3545
- */
3546
3538
  export type CoreConfig = z.infer<typeof coreConfigSchema>;
@@ -3,14 +3,6 @@ export declare const groupRefSchema: z.ZodObject<{
3
3
  slug: z.ZodString;
4
4
  weight: z.ZodNumber;
5
5
  }, z.core.$strip>;
6
- /**
7
- * Type Definition: `GroupRef`
8
- *
9
- * This type is derived from a Zod schema and represents
10
- * the validated structure of `GroupRef` used within the application.
11
- *
12
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#groupref}
13
- */
14
6
  export type GroupRef = z.infer<typeof groupRefSchema>;
15
7
  export declare const groupMetaSchema: z.ZodObject<{
16
8
  title: z.ZodString;
@@ -18,14 +10,6 @@ export declare const groupMetaSchema: z.ZodObject<{
18
10
  docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
19
11
  isSkipped: z.ZodOptional<z.ZodBoolean>;
20
12
  }, z.core.$strip>;
21
- /**
22
- * Type Definition: `GroupMeta`
23
- *
24
- * This type is derived from a Zod schema and represents
25
- * the validated structure of `GroupMeta` used within the application.
26
- *
27
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#groupmeta}
28
- */
29
13
  export type GroupMeta = z.infer<typeof groupMetaSchema>;
30
14
  export declare const groupSchema: z.ZodObject<{
31
15
  slug: z.ZodString;
@@ -38,14 +22,6 @@ export declare const groupSchema: z.ZodObject<{
38
22
  docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
39
23
  isSkipped: z.ZodOptional<z.ZodBoolean>;
40
24
  }, z.core.$strip>;
41
- /**
42
- * Type Definition: `Group`
43
- *
44
- * This type is derived from a Zod schema and represents
45
- * the validated structure of `Group` used within the application.
46
- *
47
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#group}
48
- */
49
25
  export type Group = z.infer<typeof groupSchema>;
50
26
  export declare const groupsSchema: z.ZodOptional<z.ZodArray<z.ZodObject<{
51
27
  slug: z.ZodString;
@@ -1,13 +1,5 @@
1
1
  import { type ZodObject, type ZodOptional, type ZodString, z } from 'zod';
2
2
  export declare const tableCellValueSchema: z.ZodDefault<z.ZodUnion<readonly [ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>;
3
- /**
4
- * Type Definition: `TableCellValue`
5
- *
6
- * This type is derived from a Zod schema and represents
7
- * the validated structure of `TableCellValue` used within the application.
8
- *
9
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tablecellvalue}
10
- */
11
3
  export type TableCellValue = z.infer<typeof tableCellValueSchema>;
12
4
  /**
13
5
  * Schema for execution meta date
@@ -71,14 +63,6 @@ export declare function weightedRefSchema(description: string, slugDescription:
71
63
  slug: ZodString;
72
64
  weight: z.ZodNumber;
73
65
  }, z.core.$strip>;
74
- /**
75
- * Type Definition: `WeightedRef`
76
- *
77
- * This type is derived from a Zod schema and represents
78
- * the validated structure of `WeightedRef` used within the application.
79
- *
80
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#weightedref}
81
- */
82
66
  export type WeightedRef = z.infer<ReturnType<typeof weightedRefSchema>>;
83
67
  export declare function scorableSchema<T extends ReturnType<typeof weightedRefSchema>>(description: string, refSchema: T, duplicateCheckFn: z.core.CheckFn<z.infer<T>[]>): ZodObject<{
84
68
  slug: ZodString;
@@ -944,14 +928,6 @@ export declare const materialIconSchema: z.ZodEnum<{
944
928
  nodejs_alt: "nodejs_alt";
945
929
  silverstripe: "silverstripe";
946
930
  }>;
947
- /**
948
- * Type Definition: `MaterialIcon`
949
- *
950
- * This type is derived from a Zod schema and represents
951
- * the validated structure of `MaterialIcon` used within the application.
952
- *
953
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#materialicon}
954
- */
955
931
  export type MaterialIcon = z.infer<typeof materialIconSchema>;
956
932
  export declare const filePositionSchema: ZodObject<{
957
933
  startLine: z.ZodNumber;
@@ -1,26 +1,10 @@
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
- */
10
2
  type SchemaValidationContext = {
11
3
  filePath?: string;
12
4
  };
13
5
  /**
14
6
  * Autocompletes valid Zod Schema input for convience, but will accept any other data as well
15
7
  */
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
- */
24
8
  type ZodInputLooseAutocomplete<T extends ZodType> = z.input<T> | {} | null | undefined;
25
9
  export declare class SchemaValidationError extends Error {
26
10
  constructor(error: ZodError, schema: ZodType, { filePath }: SchemaValidationContext);
@@ -4,14 +4,6 @@ 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
- */
15
7
  export type IssueSeverity = z.infer<typeof issueSeveritySchema>;
16
8
  export declare const issueSchema: z.ZodObject<{
17
9
  message: z.ZodString;
@@ -30,12 +22,4 @@ export declare const issueSchema: z.ZodObject<{
30
22
  }, z.core.$strip>>;
31
23
  }, z.core.$strip>>;
32
24
  }, 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
- */
41
25
  export type Issue = z.infer<typeof issueSchema>;
@@ -3,14 +3,6 @@ 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
- */
14
6
  export type Format = z.infer<typeof formatSchema>;
15
7
  export declare const persistConfigSchema: z.ZodObject<{
16
8
  outputDir: z.ZodOptional<z.ZodString>;
@@ -21,12 +13,4 @@ export declare const persistConfigSchema: z.ZodObject<{
21
13
  }>>>;
22
14
  skipReports: z.ZodOptional<z.ZodBoolean>;
23
15
  }, 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
- */
32
16
  export type PersistConfig = z.infer<typeof persistConfigSchema>;
@@ -2,14 +2,6 @@ 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
- */
13
5
  export type PluginContext = z.infer<typeof pluginContextSchema>;
14
6
  export declare const pluginMetaSchema: z.ZodObject<{
15
7
  packageName: z.ZodOptional<z.ZodString>;
@@ -880,24 +872,8 @@ export declare const pluginMetaSchema: z.ZodObject<{
880
872
  silverstripe: "silverstripe";
881
873
  }>;
882
874
  }, 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
- */
891
875
  export type PluginMeta = z.infer<typeof pluginMetaSchema>;
892
876
  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
- */
901
877
  export type PluginScoreTargets = z.infer<typeof pluginScoreTargetsSchema>;
902
878
  export declare const pluginDataSchema: z.ZodObject<{
903
879
  runner: z.ZodUnion<readonly [z.ZodObject<{
@@ -2316,24 +2292,8 @@ export declare const pluginConfigSchema: z.ZodObject<{
2316
2292
  scoreTargets: z.ZodOptional<z.ZodUnion<readonly [z.ZodOptional<z.ZodNumber>, z.ZodRecord<z.ZodString, z.ZodNonOptional<z.ZodOptional<z.ZodNumber>>>]>>;
2317
2293
  context: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
2318
2294
  }, 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
- */
2327
2295
  export type PluginConfig = z.infer<typeof pluginConfigSchema>;
2328
2296
  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
- */
2337
2297
  export type PluginUrls = z.infer<typeof pluginUrlsSchema>;
2338
2298
  export declare function findMissingSlugsInGroupRefs<T extends {
2339
2299
  audits: Audit[];
@@ -63,14 +63,6 @@ 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
- */
74
66
  export type AuditReport = z.infer<typeof auditReportSchema>;
75
67
  export declare const pluginReportSchema: z.ZodObject<{
76
68
  packageName: z.ZodOptional<z.ZodString>;
@@ -1018,14 +1010,6 @@ export declare const pluginReportSchema: z.ZodObject<{
1018
1010
  isSkipped: z.ZodOptional<z.ZodBoolean>;
1019
1011
  }, z.core.$strip>>>;
1020
1012
  }, 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
- */
1029
1013
  export type PluginReport = z.infer<typeof pluginReportSchema>;
1030
1014
  export declare const reportSchema: z.ZodObject<{
1031
1015
  packageName: z.ZodString;
@@ -2003,12 +1987,4 @@ export declare const reportSchema: z.ZodObject<{
2003
1987
  }, z.core.$strip>>;
2004
1988
  label: z.ZodOptional<z.ZodString>;
2005
1989
  }, 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
- */
2014
1990
  export type Report = z.infer<typeof reportSchema>;
@@ -78,59 +78,11 @@ export declare const auditResultSchema: z.ZodObject<{
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
- */
89
81
  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
- */
98
82
  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
- */
107
83
  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
- */
116
84
  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
- */
125
85
  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
- */
134
86
  export type AuditResult = z.infer<typeof auditResultSchema>;
135
87
  export declare const reportsDiffSchema: z.ZodObject<{
136
88
  commits: z.ZodNullable<z.ZodObject<{
@@ -299,12 +251,4 @@ export declare const reportsDiffSchema: z.ZodObject<{
299
251
  date: z.ZodString;
300
252
  duration: z.ZodNumber;
301
253
  }, 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
- */
310
254
  export type ReportsDiff = z.infer<typeof reportsDiffSchema>;
@@ -118,14 +118,6 @@ 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
- */
129
121
  export type OutputTransform = z.infer<typeof outputTransformSchema>;
130
122
  export declare const runnerArgsSchema: z.ZodObject<{
131
123
  persist: z.ZodObject<{
@@ -138,14 +130,6 @@ export declare const runnerArgsSchema: z.ZodObject<{
138
130
  skipReports: z.ZodNonOptional<z.ZodOptional<z.ZodBoolean>>;
139
131
  }, z.core.$strip>;
140
132
  }, 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
- */
149
133
  export type RunnerArgs = z.infer<typeof runnerArgsSchema>;
150
134
  export declare const runnerConfigSchema: z.ZodObject<{
151
135
  command: z.ZodString;
@@ -272,14 +256,6 @@ export declare const runnerConfigSchema: z.ZodObject<{
272
256
  }, z.core.$strip>>>]>>, unknown>>>;
273
257
  configFile: z.ZodOptional<z.ZodString>;
274
258
  }, 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
- */
283
259
  export type RunnerConfig = z.infer<typeof runnerConfigSchema>;
284
260
  export declare const runnerFunctionSchema: z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.core.$ZodTuple<[z.ZodObject<{
285
261
  persist: z.ZodObject<{
@@ -410,25 +386,9 @@ export declare const runnerFunctionSchema: z.ZodPipe<z.ZodCustom<unknown, unknow
410
386
  }, z.core.$strip>]>>>;
411
387
  }, z.core.$strip>>;
412
388
  }, 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
- */
421
389
  export type RunnerFunction = z.infer<typeof runnerFunctionSchema>;
422
390
  export declare const runnerFilesPathsSchema: z.ZodObject<{
423
391
  runnerConfigPath: z.ZodString;
424
392
  runnerOutputPath: z.ZodString;
425
393
  }, 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
- */
434
394
  export type RunnerFilesPaths = z.infer<typeof runnerFilesPathsSchema>;
@@ -8,12 +8,4 @@ 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
- */
19
11
  export type SourceFileLocation = z.infer<typeof sourceFileLocationSchema>;
@@ -4,28 +4,12 @@ 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
- */
15
7
  export type TableAlignment = z.infer<typeof tableAlignmentSchema>;
16
8
  export declare const tableColumnPrimitiveSchema: z.ZodEnum<{
17
9
  left: "left";
18
10
  center: "center";
19
11
  right: "right";
20
12
  }>;
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
- */
29
13
  export type TableColumnPrimitive = z.infer<typeof tableColumnPrimitiveSchema>;
30
14
  export declare const tableColumnObjectSchema: z.ZodObject<{
31
15
  key: z.ZodString;
@@ -36,34 +20,10 @@ export declare const tableColumnObjectSchema: z.ZodObject<{
36
20
  right: "right";
37
21
  }>>;
38
22
  }, 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
- */
47
23
  export type TableColumnObject = z.infer<typeof tableColumnObjectSchema>;
48
24
  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
- */
57
25
  export type TableRowObject = z.infer<typeof tableRowObjectSchema>;
58
26
  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
- */
67
27
  export type TableRowPrimitive = z.infer<typeof tableRowPrimitiveSchema>;
68
28
  export declare const tableSchema: (description?: string) => z.ZodUnion<readonly [z.ZodObject<{
69
29
  title: z.ZodOptional<z.ZodString>;
@@ -90,12 +50,4 @@ export declare const tableSchema: (description?: string) => z.ZodUnion<readonly
90
50
  }, z.core.$strip>>]>>;
91
51
  rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>>;
92
52
  }, 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
- */
101
53
  export type Table = z.infer<ReturnType<typeof tableSchema>>;
package/src/lib/tree.d.ts CHANGED
@@ -4,14 +4,6 @@ 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
- */
15
7
  export type BasicTreeNode = z.infer<typeof basicTreeNodeDataSchema> & {
16
8
  children?: BasicTreeNode[];
17
9
  };
@@ -23,14 +15,6 @@ export declare const coverageTreeMissingLOCSchema: z.ZodObject<{
23
15
  name: z.ZodOptional<z.ZodString>;
24
16
  kind: z.ZodOptional<z.ZodString>;
25
17
  }, 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
- */
34
18
  export type CoverageTreeMissingLOC = z.infer<typeof coverageTreeMissingLOCSchema>;
35
19
  declare const coverageTreeNodeDataSchema: z.ZodObject<{
36
20
  name: z.ZodString;
@@ -47,14 +31,6 @@ declare const coverageTreeNodeDataSchema: z.ZodObject<{
47
31
  }, z.core.$strip>;
48
32
  }, z.core.$strip>;
49
33
  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
- */
58
34
  export type CoverageTreeNode = z.infer<typeof coverageTreeNodeDataSchema> & {
59
35
  children?: CoverageTreeNode[];
60
36
  };
@@ -63,28 +39,12 @@ export declare const basicTreeSchema: z.ZodObject<{
63
39
  type: z.ZodOptional<z.ZodLiteral<"basic">>;
64
40
  root: z.ZodType<BasicTreeNode, unknown, z.core.$ZodTypeInternals<BasicTreeNode, unknown>>;
65
41
  }, 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
- */
74
42
  export type BasicTree = z.infer<typeof basicTreeSchema>;
75
43
  export declare const coverageTreeSchema: z.ZodObject<{
76
44
  title: z.ZodOptional<z.ZodString>;
77
45
  type: z.ZodLiteral<"coverage">;
78
46
  root: z.ZodType<CoverageTreeNode, unknown, z.core.$ZodTypeInternals<CoverageTreeNode, unknown>>;
79
47
  }, 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
- */
88
48
  export type CoverageTree = z.infer<typeof coverageTreeSchema>;
89
49
  export declare const treeSchema: z.ZodUnion<readonly [z.ZodObject<{
90
50
  title: z.ZodOptional<z.ZodString>;
@@ -95,13 +55,5 @@ export declare const treeSchema: z.ZodUnion<readonly [z.ZodObject<{
95
55
  type: z.ZodLiteral<"coverage">;
96
56
  root: z.ZodType<CoverageTreeNode, unknown, z.core.$ZodTypeInternals<CoverageTreeNode, unknown>>;
97
57
  }, 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
- */
106
58
  export type Tree = z.infer<typeof treeSchema>;
107
59
  export {};
@@ -6,12 +6,4 @@ export declare const uploadConfigSchema: z.ZodObject<{
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
- */
17
9
  export type UploadConfig = z.infer<typeof uploadConfigSchema>;