@code-pushup/models 0.114.0 → 0.115.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.114.0",
3
+ "version": "0.115.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",
@@ -58,14 +58,6 @@ export declare const auditDetailsSchema: z.ZodObject<{
58
58
  root: z.ZodType<import("./tree.js").CoverageTreeNode, unknown, z.core.$ZodTypeInternals<import("./tree.js").CoverageTreeNode, unknown>>;
59
59
  }, z.core.$strip>]>>>;
60
60
  }, z.core.$strip>;
61
- /**
62
- * Type Definition: `AuditDetails`
63
- *
64
- * This type is derived from a Zod schema and represents
65
- * the validated structure of `AuditDetails` used within the application.
66
- *
67
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#auditdetails}
68
- */
69
61
  export type AuditDetails = z.infer<typeof auditDetailsSchema>;
70
62
  export declare const auditOutputSchema: z.ZodObject<{
71
63
  slug: z.ZodString;
@@ -131,14 +123,6 @@ export declare const auditOutputSchema: z.ZodObject<{
131
123
  }, z.core.$strip>]>>>;
132
124
  }, z.core.$strip>>;
133
125
  }, z.core.$strip>;
134
- /**
135
- * Type Definition: `AuditOutput`
136
- *
137
- * This type is derived from a Zod schema and represents
138
- * the validated structure of `AuditOutput` used within the application.
139
- *
140
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#auditoutput}
141
- */
142
126
  export type AuditOutput = z.infer<typeof auditOutputSchema>;
143
127
  export declare const auditOutputsSchema: z.ZodArray<z.ZodObject<{
144
128
  slug: z.ZodString;
@@ -204,12 +188,4 @@ export declare const auditOutputsSchema: z.ZodArray<z.ZodObject<{
204
188
  }, z.core.$strip>]>>>;
205
189
  }, z.core.$strip>>;
206
190
  }, z.core.$strip>>;
207
- /**
208
- * Type Definition: `AuditOutputs`
209
- *
210
- * This type is derived from a Zod schema and represents
211
- * the validated structure of `AuditOutputs` used within the application.
212
- *
213
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#auditoutputs}
214
- */
215
191
  export type AuditOutputs = z.infer<typeof auditOutputsSchema>;
@@ -6,14 +6,6 @@ export declare const auditSchema: z.ZodObject<{
6
6
  docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
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>;
@@ -3583,12 +3583,4 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
3583
3583
  scoreTarget: z.ZodOptional<z.ZodNumber>;
3584
3584
  }, z.core.$strip>>>;
3585
3585
  }, z.core.$strip>;
3586
- /**
3587
- * Type Definition: `CoreConfig`
3588
- *
3589
- * This type is derived from a Zod schema and represents
3590
- * the validated structure of `CoreConfig` used within the application.
3591
- *
3592
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#coreconfig}
3593
- */
3594
3586
  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.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
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.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
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;
@@ -34,14 +26,6 @@ export declare const issueSchema: z.ZodObject<{
34
26
  selector: z.ZodOptional<z.ZodString>;
35
27
  }, z.core.$strip>]>>;
36
28
  }, z.core.$strip>;
37
- /**
38
- * Type Definition: `Issue`
39
- *
40
- * This type is derived from a Zod schema and represents
41
- * the validated structure of `Issue` used within the application.
42
- *
43
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#issue}
44
- */
45
29
  export type Issue = z.infer<typeof issueSchema>;
46
30
  export declare const fileIssueSchema: z.ZodObject<{
47
31
  message: z.ZodString;
@@ -60,14 +44,6 @@ export declare const fileIssueSchema: z.ZodObject<{
60
44
  }, z.core.$strip>>;
61
45
  }, z.core.$strip>;
62
46
  }, z.core.$strip>;
63
- /**
64
- * Type Definition: `FileIssue`
65
- *
66
- * This type is derived from a Zod schema and represents
67
- * the validated structure of `FileIssue` used within the application.
68
- *
69
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#fileissue}
70
- */
71
47
  export type FileIssue = z.infer<typeof fileIssueSchema>;
72
48
  export declare const urlIssueSchema: z.ZodObject<{
73
49
  message: z.ZodString;
@@ -82,12 +58,4 @@ export declare const urlIssueSchema: z.ZodObject<{
82
58
  selector: z.ZodOptional<z.ZodString>;
83
59
  }, z.core.$strip>;
84
60
  }, z.core.$strip>;
85
- /**
86
- * Type Definition: `UrlIssue`
87
- *
88
- * This type is derived from a Zod schema and represents
89
- * the validated structure of `UrlIssue` used within the application.
90
- *
91
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#urlissue}
92
- */
93
61
  export type UrlIssue = z.infer<typeof urlIssueSchema>;
@@ -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<{
@@ -2348,24 +2324,8 @@ export declare const pluginConfigSchema: z.ZodObject<{
2348
2324
  scoreTargets: z.ZodOptional<z.ZodUnion<readonly [z.ZodOptional<z.ZodNumber>, z.ZodRecord<z.ZodString, z.ZodNonOptional<z.ZodOptional<z.ZodNumber>>>]>>;
2349
2325
  context: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
2350
2326
  }, z.core.$strip>;
2351
- /**
2352
- * Type Definition: `PluginConfig`
2353
- *
2354
- * This type is derived from a Zod schema and represents
2355
- * the validated structure of `PluginConfig` used within the application.
2356
- *
2357
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#pluginconfig}
2358
- */
2359
2327
  export type PluginConfig = z.infer<typeof pluginConfigSchema>;
2360
2328
  export declare const pluginUrlsSchema: z.ZodUnion<readonly [z.ZodURL, z.ZodArray<z.ZodURL>, z.ZodRecord<z.ZodURL, z.ZodNumber>]>;
2361
- /**
2362
- * Type Definition: `PluginUrls`
2363
- *
2364
- * This type is derived from a Zod schema and represents
2365
- * the validated structure of `PluginUrls` used within the application.
2366
- *
2367
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#pluginurls}
2368
- */
2369
2329
  export type PluginUrls = z.infer<typeof pluginUrlsSchema>;
2370
2330
  export declare function findMissingSlugsInGroupRefs<T extends {
2371
2331
  audits: Audit[];
@@ -67,14 +67,6 @@ export declare const auditReportSchema: z.ZodObject<{
67
67
  }, z.core.$strip>]>>>;
68
68
  }, z.core.$strip>>;
69
69
  }, z.core.$strip>;
70
- /**
71
- * Type Definition: `AuditReport`
72
- *
73
- * This type is derived from a Zod schema and represents
74
- * the validated structure of `AuditReport` used within the application.
75
- *
76
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#auditreport}
77
- */
78
70
  export type AuditReport = z.infer<typeof auditReportSchema>;
79
71
  export declare const pluginReportSchema: z.ZodObject<{
80
72
  packageName: z.ZodOptional<z.ZodString>;
@@ -1026,14 +1018,6 @@ export declare const pluginReportSchema: z.ZodObject<{
1026
1018
  isSkipped: z.ZodOptional<z.ZodBoolean>;
1027
1019
  }, z.core.$strip>>>;
1028
1020
  }, z.core.$strip>;
1029
- /**
1030
- * Type Definition: `PluginReport`
1031
- *
1032
- * This type is derived from a Zod schema and represents
1033
- * the validated structure of `PluginReport` used within the application.
1034
- *
1035
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#pluginreport}
1036
- */
1037
1021
  export type PluginReport = z.infer<typeof pluginReportSchema>;
1038
1022
  export declare const reportSchema: z.ZodObject<{
1039
1023
  packageName: z.ZodString;
@@ -2015,12 +1999,4 @@ export declare const reportSchema: z.ZodObject<{
2015
1999
  }, z.core.$strip>>;
2016
2000
  label: z.ZodOptional<z.ZodString>;
2017
2001
  }, z.core.$strip>;
2018
- /**
2019
- * Type Definition: `Report`
2020
- *
2021
- * This type is derived from a Zod schema and represents
2022
- * the validated structure of `Report` used within the application.
2023
- *
2024
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#report}
2025
- */
2026
2002
  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>;
@@ -126,14 +126,6 @@ export declare const outputTransformSchema: z.ZodPipe<z.ZodCustom<unknown, unkno
126
126
  }, z.core.$strip>]>>>;
127
127
  }, z.core.$strip>>;
128
128
  }, z.core.$strip>>>]>>, unknown>>;
129
- /**
130
- * Type Definition: `OutputTransform`
131
- *
132
- * This type is derived from a Zod schema and represents
133
- * the validated structure of `OutputTransform` used within the application.
134
- *
135
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#outputtransform}
136
- */
137
129
  export type OutputTransform = z.infer<typeof outputTransformSchema>;
138
130
  export declare const runnerArgsSchema: z.ZodObject<{
139
131
  persist: z.ZodObject<{
@@ -146,14 +138,6 @@ export declare const runnerArgsSchema: z.ZodObject<{
146
138
  skipReports: z.ZodNonOptional<z.ZodOptional<z.ZodBoolean>>;
147
139
  }, z.core.$strip>;
148
140
  }, z.core.$strip>;
149
- /**
150
- * Type Definition: `RunnerArgs`
151
- *
152
- * This type is derived from a Zod schema and represents
153
- * the validated structure of `RunnerArgs` used within the application.
154
- *
155
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#runnerargs}
156
- */
157
141
  export type RunnerArgs = z.infer<typeof runnerArgsSchema>;
158
142
  export declare const runnerConfigSchema: z.ZodObject<{
159
143
  command: z.ZodString;
@@ -288,14 +272,6 @@ export declare const runnerConfigSchema: z.ZodObject<{
288
272
  }, z.core.$strip>>>]>>, unknown>>>;
289
273
  configFile: z.ZodOptional<z.ZodString>;
290
274
  }, z.core.$strip>;
291
- /**
292
- * Type Definition: `RunnerConfig`
293
- *
294
- * This type is derived from a Zod schema and represents
295
- * the validated structure of `RunnerConfig` used within the application.
296
- *
297
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#runnerconfig}
298
- */
299
275
  export type RunnerConfig = z.infer<typeof runnerConfigSchema>;
300
276
  export declare const runnerFunctionSchema: z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [z.ZodObject<{
301
277
  persist: z.ZodObject<{
@@ -434,25 +410,9 @@ export declare const runnerFunctionSchema: z.ZodPipe<z.ZodCustom<unknown, unknow
434
410
  }, z.core.$strip>]>>>;
435
411
  }, z.core.$strip>>;
436
412
  }, z.core.$strip>>>]>>, unknown>>;
437
- /**
438
- * Type Definition: `RunnerFunction`
439
- *
440
- * This type is derived from a Zod schema and represents
441
- * the validated structure of `RunnerFunction` used within the application.
442
- *
443
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#runnerfunction}
444
- */
445
413
  export type RunnerFunction = z.infer<typeof runnerFunctionSchema>;
446
414
  export declare const runnerFilesPathsSchema: z.ZodObject<{
447
415
  runnerConfigPath: z.ZodString;
448
416
  runnerOutputPath: z.ZodString;
449
417
  }, z.core.$strip>;
450
- /**
451
- * Type Definition: `RunnerFilesPaths`
452
- *
453
- * This type is derived from a Zod schema and represents
454
- * the validated structure of `RunnerFilesPaths` used within the application.
455
- *
456
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#runnerfilespaths}
457
- */
458
418
  export type RunnerFilesPaths = z.infer<typeof runnerFilesPathsSchema>;
@@ -8,28 +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
- */
19
11
  export type SourceFileLocation = z.infer<typeof sourceFileLocationSchema>;
20
12
  export declare const sourceUrlLocationSchema: z.ZodObject<{
21
13
  url: z.ZodURL;
22
14
  snippet: z.ZodOptional<z.ZodString>;
23
15
  selector: z.ZodOptional<z.ZodString>;
24
16
  }, z.core.$strip>;
25
- /**
26
- * Type Definition: `SourceUrlLocation`
27
- *
28
- * This type is derived from a Zod schema and represents
29
- * the validated structure of `SourceUrlLocation` used within the application.
30
- *
31
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#sourceurllocation}
32
- */
33
17
  export type SourceUrlLocation = z.infer<typeof sourceUrlLocationSchema>;
34
18
  export declare const issueSourceSchema: z.ZodUnion<readonly [z.ZodObject<{
35
19
  file: z.ZodString;
@@ -44,12 +28,4 @@ export declare const issueSourceSchema: z.ZodUnion<readonly [z.ZodObject<{
44
28
  snippet: z.ZodOptional<z.ZodString>;
45
29
  selector: z.ZodOptional<z.ZodString>;
46
30
  }, z.core.$strip>]>;
47
- /**
48
- * Type Definition: `IssueSource`
49
- *
50
- * This type is derived from a Zod schema and represents
51
- * the validated structure of `IssueSource` used within the application.
52
- *
53
- * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#issuesource}
54
- */
55
31
  export type IssueSource = z.infer<typeof issueSourceSchema>;
@@ -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>;