@code-pushup/models 0.108.1 → 0.109.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.
Files changed (28) hide show
  1. package/package.json +1 -1
  2. package/src/index.d.ts +2 -2
  3. package/src/index.js +2 -2
  4. package/src/index.js.map +1 -1
  5. package/src/lib/audit-output.d.ts +18 -30
  6. package/src/lib/audit.d.ts +0 -8
  7. package/src/lib/cache-config.d.ts +0 -24
  8. package/src/lib/category-config.d.ts +0 -16
  9. package/src/lib/commit.d.ts +0 -8
  10. package/src/lib/configuration.d.ts +0 -8
  11. package/src/lib/core-config.d.ts +72 -32
  12. package/src/lib/group.d.ts +0 -24
  13. package/src/lib/implementation/schemas.d.ts +0 -24
  14. package/src/lib/implementation/validate.d.ts +0 -16
  15. package/src/lib/issue.d.ts +38 -18
  16. package/src/lib/issue.js +14 -2
  17. package/src/lib/issue.js.map +1 -1
  18. package/src/lib/persist-config.d.ts +0 -16
  19. package/src/lib/plugin-config.d.ts +48 -56
  20. package/src/lib/report.d.ts +18 -30
  21. package/src/lib/reports-diff.d.ts +0 -56
  22. package/src/lib/runner-config.d.ts +36 -52
  23. package/src/lib/source.d.ts +20 -8
  24. package/src/lib/source.js +23 -1
  25. package/src/lib/source.js.map +1 -1
  26. package/src/lib/table.d.ts +0 -48
  27. package/src/lib/tree.d.ts +0 -48
  28. package/src/lib/upload-config.d.ts +0 -8
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@code-pushup/models",
3
- "version": "0.108.1",
3
+ "version": "0.109.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",
package/src/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  export { tableCellValueSchema, type TableCellValue, } from './lib/implementation/schemas.js';
2
- export { sourceFileLocationSchema, type SourceFileLocation, } from './lib/source.js';
2
+ export { sourceFileLocationSchema, sourceUrlLocationSchema, issueSourceSchema, type IssueSource, type SourceFileLocation, type SourceUrlLocation, } from './lib/source.js';
3
3
  export { auditDetailsSchema, auditOutputSchema, auditOutputsSchema, type AuditDetails, type AuditOutput, type AuditOutputs, } from './lib/audit-output.js';
4
4
  export { auditSchema, type Audit } from './lib/audit.js';
5
5
  export { cacheConfigObjectSchema, cacheConfigSchema, cacheConfigShorthandSchema, type CacheConfig, type CacheConfigObject, type CacheConfigShorthand, } from './lib/cache-config.js';
@@ -14,7 +14,7 @@ export { MAX_DESCRIPTION_LENGTH, MAX_ISSUE_MESSAGE_LENGTH, MAX_SLUG_LENGTH, MAX_
14
14
  export { fileNameSchema, filePathSchema, globPathSchema, materialIconSchema, nonnegativeNumberSchema, positiveIntSchema, scoreSchema, slugSchema, weightSchema, type MaterialIcon, } from './lib/implementation/schemas.js';
15
15
  export { exists } from './lib/implementation/utils.js';
16
16
  export { SchemaValidationError, validate, validateAsync, } from './lib/implementation/validate.js';
17
- export { issueSchema, issueSeveritySchema, type Issue, type IssueSeverity, } from './lib/issue.js';
17
+ export { fileIssueSchema, issueSchema, issueSeveritySchema, urlIssueSchema, type FileIssue, type Issue, type IssueSeverity, type UrlIssue, } from './lib/issue.js';
18
18
  export { formatSchema, persistConfigSchema, type Format, type PersistConfig, } from './lib/persist-config.js';
19
19
  export { pluginConfigSchema, pluginContextSchema, pluginMetaSchema, pluginScoreTargetsSchema, pluginUrlsSchema, type PluginConfig, type PluginContext, type PluginMeta, type PluginScoreTargets, type PluginUrls, } from './lib/plugin-config.js';
20
20
  export { auditReportSchema, pluginReportSchema, reportSchema, type AuditReport, type PluginReport, type Report, } from './lib/report.js';
package/src/index.js CHANGED
@@ -1,5 +1,5 @@
1
1
  export { tableCellValueSchema, } from './lib/implementation/schemas.js';
2
- export { sourceFileLocationSchema, } from './lib/source.js';
2
+ export { sourceFileLocationSchema, sourceUrlLocationSchema, issueSourceSchema, } from './lib/source.js';
3
3
  export { auditDetailsSchema, auditOutputSchema, auditOutputsSchema, } from './lib/audit-output.js';
4
4
  export { auditSchema } from './lib/audit.js';
5
5
  export { cacheConfigObjectSchema, cacheConfigSchema, cacheConfigShorthandSchema, } from './lib/cache-config.js';
@@ -14,7 +14,7 @@ export { MAX_DESCRIPTION_LENGTH, MAX_ISSUE_MESSAGE_LENGTH, MAX_SLUG_LENGTH, MAX_
14
14
  export { fileNameSchema, filePathSchema, globPathSchema, materialIconSchema, nonnegativeNumberSchema, positiveIntSchema, scoreSchema, slugSchema, weightSchema, } from './lib/implementation/schemas.js';
15
15
  export { exists } from './lib/implementation/utils.js';
16
16
  export { SchemaValidationError, validate, validateAsync, } from './lib/implementation/validate.js';
17
- export { issueSchema, issueSeveritySchema, } from './lib/issue.js';
17
+ export { fileIssueSchema, issueSchema, issueSeveritySchema, urlIssueSchema, } from './lib/issue.js';
18
18
  export { formatSchema, persistConfigSchema, } from './lib/persist-config.js';
19
19
  export { pluginConfigSchema, pluginContextSchema, pluginMetaSchema, pluginScoreTargetsSchema, pluginUrlsSchema, } from './lib/plugin-config.js';
20
20
  export { auditReportSchema, pluginReportSchema, reportSchema, } from './lib/report.js';
package/src/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,GAErB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,wBAAwB,GAEzB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,GAInB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAc,MAAM,gBAAgB,CAAC;AACzD,OAAO,EACL,uBAAuB,EACvB,iBAAiB,EACjB,0BAA0B,GAI3B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,oBAAoB,EACpB,iBAAiB,GAGlB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,YAAY,EAAe,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EACL,+BAA+B,EAC/B,2BAA2B,GAE5B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAmB,MAAM,sBAAsB,CAAC;AACzE,OAAO,EACL,cAAc,EACd,WAAW,GAIZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,gBAAgB,EAChB,6BAA6B,GAC9B,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,EAC1B,2BAA2B,GAC5B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,eAAe,EACf,gBAAgB,GACjB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,cAAc,EACd,cAAc,EACd,cAAc,EACd,kBAAkB,EAClB,uBAAuB,EACvB,iBAAiB,EACjB,WAAW,EACX,UAAU,EACV,YAAY,GAEb,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EACL,qBAAqB,EACrB,QAAQ,EACR,aAAa,GACd,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,WAAW,EACX,mBAAmB,GAGpB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,YAAY,EACZ,mBAAmB,GAGpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,wBAAwB,EACxB,gBAAgB,GAMjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,YAAY,GAIb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,iBAAiB,EACjB,iBAAiB,GAQlB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,GAKrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,0BAA0B,EAC1B,oBAAoB,EACpB,uBAAuB,EACvB,WAAW,GAOZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,4BAA4B,EAC5B,sBAAsB,EACtB,kBAAkB,EAClB,UAAU,GAOX,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,kBAAkB,EAAqB,MAAM,wBAAwB,CAAC;AAC/E,OAAO,EAAE,+BAA+B,EAAE,MAAM,kCAAkC,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,GAErB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,wBAAwB,EACxB,uBAAuB,EACvB,iBAAiB,GAIlB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACL,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,GAInB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,WAAW,EAAc,MAAM,gBAAgB,CAAC;AACzD,OAAO,EACL,uBAAuB,EACvB,iBAAiB,EACjB,0BAA0B,GAI3B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,oBAAoB,EACpB,iBAAiB,GAGlB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,YAAY,EAAe,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EACL,+BAA+B,EAC/B,2BAA2B,GAE5B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,gBAAgB,EAAmB,MAAM,sBAAsB,CAAC;AACzE,OAAO,EACL,cAAc,EACd,WAAW,GAIZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,gBAAgB,EAChB,6BAA6B,GAC9B,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,EAC1B,2BAA2B,GAC5B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,eAAe,EACf,gBAAgB,GACjB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,cAAc,EACd,cAAc,EACd,cAAc,EACd,kBAAkB,EAClB,uBAAuB,EACvB,iBAAiB,EACjB,WAAW,EACX,UAAU,EACV,YAAY,GAEb,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EACL,qBAAqB,EACrB,QAAQ,EACR,aAAa,GACd,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,eAAe,EACf,WAAW,EACX,mBAAmB,EACnB,cAAc,GAKf,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,YAAY,EACZ,mBAAmB,GAGpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,kBAAkB,EAClB,mBAAmB,EACnB,gBAAgB,EAChB,wBAAwB,EACxB,gBAAgB,GAMjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,YAAY,GAIb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,iBAAiB,EACjB,iBAAiB,GAQlB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,GAKrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,0BAA0B,EAC1B,oBAAoB,EACpB,uBAAuB,EACvB,WAAW,GAOZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,4BAA4B,EAC5B,sBAAsB,EACtB,kBAAkB,EAClB,UAAU,GAOX,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,kBAAkB,EAAqB,MAAM,wBAAwB,CAAC;AAC/E,OAAO,EAAE,+BAA+B,EAAE,MAAM,kCAAkC,CAAC"}
package/src/lib/audit-output.d.ts CHANGED
@@ -9,7 +9,7 @@ export declare const auditDetailsSchema: z.ZodObject<{
9
9
  info: "info";
10
10
  warning: "warning";
11
11
  }>;
12
- source: z.ZodOptional<z.ZodObject<{
12
+ source: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
13
13
  file: z.ZodString;
14
14
  position: z.ZodOptional<z.ZodObject<{
15
15
  startLine: z.ZodNumber;
@@ -17,7 +17,11 @@ export declare const auditDetailsSchema: z.ZodObject<{
17
17
  endLine: z.ZodOptional<z.ZodNumber>;
18
18
  endColumn: z.ZodOptional<z.ZodNumber>;
19
19
  }, z.core.$strip>>;
20
- }, z.core.$strip>>;
20
+ }, z.core.$strip>, z.ZodObject<{
21
+ url: z.ZodURL;
22
+ snippet: z.ZodOptional<z.ZodString>;
23
+ selector: z.ZodOptional<z.ZodString>;
24
+ }, z.core.$strip>]>>;
21
25
  }, z.core.$strip>>>;
22
26
  table: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
23
27
  title: z.ZodOptional<z.ZodString>;
@@ -54,14 +58,6 @@ export declare const auditDetailsSchema: z.ZodObject<{
54
58
  root: z.ZodType<import("./tree.js").CoverageTreeNode, unknown, z.core.$ZodTypeInternals<import("./tree.js").CoverageTreeNode, unknown>>;
55
59
  }, z.core.$strip>]>>>;
56
60
  }, 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
61
  export type AuditDetails = z.infer<typeof auditDetailsSchema>;
66
62
  export declare const auditOutputSchema: z.ZodObject<{
67
63
  slug: z.ZodString;
@@ -77,7 +73,7 @@ export declare const auditOutputSchema: z.ZodObject<{
77
73
  info: "info";
78
74
  warning: "warning";
79
75
  }>;
80
- source: z.ZodOptional<z.ZodObject<{
76
+ source: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
81
77
  file: z.ZodString;
82
78
  position: z.ZodOptional<z.ZodObject<{
83
79
  startLine: z.ZodNumber;
@@ -85,7 +81,11 @@ export declare const auditOutputSchema: z.ZodObject<{
85
81
  endLine: z.ZodOptional<z.ZodNumber>;
86
82
  endColumn: z.ZodOptional<z.ZodNumber>;
87
83
  }, z.core.$strip>>;
88
- }, z.core.$strip>>;
84
+ }, z.core.$strip>, z.ZodObject<{
85
+ url: z.ZodURL;
86
+ snippet: z.ZodOptional<z.ZodString>;
87
+ selector: z.ZodOptional<z.ZodString>;
88
+ }, z.core.$strip>]>>;
89
89
  }, z.core.$strip>>>;
90
90
  table: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
91
91
  title: z.ZodOptional<z.ZodString>;
@@ -123,14 +123,6 @@ export declare const auditOutputSchema: z.ZodObject<{
123
123
  }, z.core.$strip>]>>>;
124
124
  }, z.core.$strip>>;
125
125
  }, 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
126
  export type AuditOutput = z.infer<typeof auditOutputSchema>;
135
127
  export declare const auditOutputsSchema: z.ZodArray<z.ZodObject<{
136
128
  slug: z.ZodString;
@@ -146,7 +138,7 @@ export declare const auditOutputsSchema: z.ZodArray<z.ZodObject<{
146
138
  info: "info";
147
139
  warning: "warning";
148
140
  }>;
149
- source: z.ZodOptional<z.ZodObject<{
141
+ source: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
150
142
  file: z.ZodString;
151
143
  position: z.ZodOptional<z.ZodObject<{
152
144
  startLine: z.ZodNumber;
@@ -154,7 +146,11 @@ export declare const auditOutputsSchema: z.ZodArray<z.ZodObject<{
154
146
  endLine: z.ZodOptional<z.ZodNumber>;
155
147
  endColumn: z.ZodOptional<z.ZodNumber>;
156
148
  }, z.core.$strip>>;
157
- }, z.core.$strip>>;
149
+ }, z.core.$strip>, z.ZodObject<{
150
+ url: z.ZodURL;
151
+ snippet: z.ZodOptional<z.ZodString>;
152
+ selector: z.ZodOptional<z.ZodString>;
153
+ }, z.core.$strip>]>>;
158
154
  }, z.core.$strip>>>;
159
155
  table: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
160
156
  title: z.ZodOptional<z.ZodString>;
@@ -192,12 +188,4 @@ export declare const auditOutputsSchema: z.ZodArray<z.ZodObject<{
192
188
  }, z.core.$strip>]>>>;
193
189
  }, z.core.$strip>>;
194
190
  }, 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
191
  export type AuditOutputs = z.infer<typeof auditOutputsSchema>;
package/src/lib/audit.d.ts CHANGED
@@ -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;
package/src/lib/cache-config.d.ts CHANGED
@@ -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>;
package/src/lib/category-config.d.ts CHANGED
@@ -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;
package/src/lib/commit.d.ts CHANGED
@@ -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>;
package/src/lib/configuration.d.ts CHANGED
@@ -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>;
package/src/lib/core-config.d.ts CHANGED
@@ -886,7 +886,7 @@ export declare const unrefinedCoreConfigSchema: z.ZodObject<{
886
886
  info: "info";
887
887
  warning: "warning";
888
888
  }>;
889
- source: z.ZodOptional<z.ZodObject<{
889
+ source: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
890
890
  file: z.ZodString;
891
891
  position: z.ZodOptional<z.ZodObject<{
892
892
  startLine: z.ZodNumber;
@@ -894,7 +894,11 @@ export declare const unrefinedCoreConfigSchema: z.ZodObject<{
894
894
  endLine: z.ZodOptional<z.ZodNumber>;
895
895
  endColumn: z.ZodOptional<z.ZodNumber>;
896
896
  }, z.core.$strip>>;
897
- }, z.core.$strip>>;
897
+ }, z.core.$strip>, z.ZodObject<{
898
+ url: z.ZodURL;
899
+ snippet: z.ZodOptional<z.ZodString>;
900
+ selector: z.ZodOptional<z.ZodString>;
901
+ }, z.core.$strip>]>>;
898
902
  }, z.core.$strip>>>;
899
903
  table: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
900
904
  title: z.ZodOptional<z.ZodString>;
@@ -945,7 +949,7 @@ export declare const unrefinedCoreConfigSchema: z.ZodObject<{
945
949
  info: "info";
946
950
  warning: "warning";
947
951
  }>;
948
- source: z.ZodOptional<z.ZodObject<{
952
+ source: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
949
953
  file: z.ZodString;
950
954
  position: z.ZodOptional<z.ZodObject<{
951
955
  startLine: z.ZodNumber;
@@ -953,7 +957,11 @@ export declare const unrefinedCoreConfigSchema: z.ZodObject<{
953
957
  endLine: z.ZodOptional<z.ZodNumber>;
954
958
  endColumn: z.ZodOptional<z.ZodNumber>;
955
959
  }, z.core.$strip>>;
956
- }, z.core.$strip>>;
960
+ }, z.core.$strip>, z.ZodObject<{
961
+ url: z.ZodURL;
962
+ snippet: z.ZodOptional<z.ZodString>;
963
+ selector: z.ZodOptional<z.ZodString>;
964
+ }, z.core.$strip>]>>;
957
965
  }, z.core.$strip>>>;
958
966
  table: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
959
967
  title: z.ZodOptional<z.ZodString>;
@@ -1016,7 +1024,7 @@ export declare const unrefinedCoreConfigSchema: z.ZodObject<{
1016
1024
  info: "info";
1017
1025
  warning: "warning";
1018
1026
  }>;
1019
- source: z.ZodOptional<z.ZodObject<{
1027
+ source: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
1020
1028
  file: z.ZodString;
1021
1029
  position: z.ZodOptional<z.ZodObject<{
1022
1030
  startLine: z.ZodNumber;
@@ -1024,7 +1032,11 @@ export declare const unrefinedCoreConfigSchema: z.ZodObject<{
1024
1032
  endLine: z.ZodOptional<z.ZodNumber>;
1025
1033
  endColumn: z.ZodOptional<z.ZodNumber>;
1026
1034
  }, z.core.$strip>>;
1027
- }, z.core.$strip>>;
1035
+ }, z.core.$strip>, z.ZodObject<{
1036
+ url: z.ZodURL;
1037
+ snippet: z.ZodOptional<z.ZodString>;
1038
+ selector: z.ZodOptional<z.ZodString>;
1039
+ }, z.core.$strip>]>>;
1028
1040
  }, z.core.$strip>>>;
1029
1041
  table: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
1030
1042
  title: z.ZodOptional<z.ZodString>;
@@ -1075,7 +1087,7 @@ export declare const unrefinedCoreConfigSchema: z.ZodObject<{
1075
1087
  info: "info";
1076
1088
  warning: "warning";
1077
1089
  }>;
1078
- source: z.ZodOptional<z.ZodObject<{
1090
+ source: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
1079
1091
  file: z.ZodString;
1080
1092
  position: z.ZodOptional<z.ZodObject<{
1081
1093
  startLine: z.ZodNumber;
@@ -1083,7 +1095,11 @@ export declare const unrefinedCoreConfigSchema: z.ZodObject<{
1083
1095
  endLine: z.ZodOptional<z.ZodNumber>;
1084
1096
  endColumn: z.ZodOptional<z.ZodNumber>;
1085
1097
  }, z.core.$strip>>;
1086
- }, z.core.$strip>>;
1098
+ }, z.core.$strip>, z.ZodObject<{
1099
+ url: z.ZodURL;
1100
+ snippet: z.ZodOptional<z.ZodString>;
1101
+ selector: z.ZodOptional<z.ZodString>;
1102
+ }, z.core.$strip>]>>;
1087
1103
  }, z.core.$strip>>>;
1088
1104
  table: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
1089
1105
  title: z.ZodOptional<z.ZodString>;
@@ -2063,7 +2079,7 @@ export declare const coreConfigSchema: z.ZodObject<{
2063
2079
  info: "info";
2064
2080
  warning: "warning";
2065
2081
  }>;
2066
- source: z.ZodOptional<z.ZodObject<{
2082
+ source: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
2067
2083
  file: z.ZodString;
2068
2084
  position: z.ZodOptional<z.ZodObject<{
2069
2085
  startLine: z.ZodNumber;
@@ -2071,7 +2087,11 @@ export declare const coreConfigSchema: z.ZodObject<{
2071
2087
  endLine: z.ZodOptional<z.ZodNumber>;
2072
2088
  endColumn: z.ZodOptional<z.ZodNumber>;
2073
2089
  }, z.core.$strip>>;
2074
- }, z.core.$strip>>;
2090
+ }, z.core.$strip>, z.ZodObject<{
2091
+ url: z.ZodURL;
2092
+ snippet: z.ZodOptional<z.ZodString>;
2093
+ selector: z.ZodOptional<z.ZodString>;
2094
+ }, z.core.$strip>]>>;
2075
2095
  }, z.core.$strip>>>;
2076
2096
  table: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
2077
2097
  title: z.ZodOptional<z.ZodString>;
@@ -2122,7 +2142,7 @@ export declare const coreConfigSchema: z.ZodObject<{
2122
2142
  info: "info";
2123
2143
  warning: "warning";
2124
2144
  }>;
2125
- source: z.ZodOptional<z.ZodObject<{
2145
+ source: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
2126
2146
  file: z.ZodString;
2127
2147
  position: z.ZodOptional<z.ZodObject<{
2128
2148
  startLine: z.ZodNumber;
@@ -2130,7 +2150,11 @@ export declare const coreConfigSchema: z.ZodObject<{
2130
2150
  endLine: z.ZodOptional<z.ZodNumber>;
2131
2151
  endColumn: z.ZodOptional<z.ZodNumber>;
2132
2152
  }, z.core.$strip>>;
2133
- }, z.core.$strip>>;
2153
+ }, z.core.$strip>, z.ZodObject<{
2154
+ url: z.ZodURL;
2155
+ snippet: z.ZodOptional<z.ZodString>;
2156
+ selector: z.ZodOptional<z.ZodString>;
2157
+ }, z.core.$strip>]>>;
2134
2158
  }, z.core.$strip>>>;
2135
2159
  table: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
2136
2160
  title: z.ZodOptional<z.ZodString>;
@@ -2193,7 +2217,7 @@ export declare const coreConfigSchema: z.ZodObject<{
2193
2217
  info: "info";
2194
2218
  warning: "warning";
2195
2219
  }>;
2196
- source: z.ZodOptional<z.ZodObject<{
2220
+ source: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
2197
2221
  file: z.ZodString;
2198
2222
  position: z.ZodOptional<z.ZodObject<{
2199
2223
  startLine: z.ZodNumber;
@@ -2201,7 +2225,11 @@ export declare const coreConfigSchema: z.ZodObject<{
2201
2225
  endLine: z.ZodOptional<z.ZodNumber>;
2202
2226
  endColumn: z.ZodOptional<z.ZodNumber>;
2203
2227
  }, z.core.$strip>>;
2204
- }, z.core.$strip>>;
2228
+ }, z.core.$strip>, z.ZodObject<{
2229
+ url: z.ZodURL;
2230
+ snippet: z.ZodOptional<z.ZodString>;
2231
+ selector: z.ZodOptional<z.ZodString>;
2232
+ }, z.core.$strip>]>>;
2205
2233
  }, z.core.$strip>>>;
2206
2234
  table: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
2207
2235
  title: z.ZodOptional<z.ZodString>;
@@ -2252,7 +2280,7 @@ export declare const coreConfigSchema: z.ZodObject<{
2252
2280
  info: "info";
2253
2281
  warning: "warning";
2254
2282
  }>;
2255
- source: z.ZodOptional<z.ZodObject<{
2283
+ source: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
2256
2284
  file: z.ZodString;
2257
2285
  position: z.ZodOptional<z.ZodObject<{
2258
2286
  startLine: z.ZodNumber;
@@ -2260,7 +2288,11 @@ export declare const coreConfigSchema: z.ZodObject<{
2260
2288
  endLine: z.ZodOptional<z.ZodNumber>;
2261
2289
  endColumn: z.ZodOptional<z.ZodNumber>;
2262
2290
  }, z.core.$strip>>;
2263
- }, z.core.$strip>>;
2291
+ }, z.core.$strip>, z.ZodObject<{
2292
+ url: z.ZodURL;
2293
+ snippet: z.ZodOptional<z.ZodString>;
2294
+ selector: z.ZodOptional<z.ZodString>;
2295
+ }, z.core.$strip>]>>;
2264
2296
  }, z.core.$strip>>>;
2265
2297
  table: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
2266
2298
  title: z.ZodOptional<z.ZodString>;
@@ -3245,7 +3277,7 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
3245
3277
  info: "info";
3246
3278
  warning: "warning";
3247
3279
  }>;
3248
- source: z.ZodOptional<z.ZodObject<{
3280
+ source: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
3249
3281
  file: z.ZodString;
3250
3282
  position: z.ZodOptional<z.ZodObject<{
3251
3283
  startLine: z.ZodNumber;
@@ -3253,7 +3285,11 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
3253
3285
  endLine: z.ZodOptional<z.ZodNumber>;
3254
3286
  endColumn: z.ZodOptional<z.ZodNumber>;
3255
3287
  }, z.core.$strip>>;
3256
- }, z.core.$strip>>;
3288
+ }, z.core.$strip>, z.ZodObject<{
3289
+ url: z.ZodURL;
3290
+ snippet: z.ZodOptional<z.ZodString>;
3291
+ selector: z.ZodOptional<z.ZodString>;
3292
+ }, z.core.$strip>]>>;
3257
3293
  }, z.core.$strip>>>;
3258
3294
  table: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
3259
3295
  title: z.ZodOptional<z.ZodString>;
@@ -3304,7 +3340,7 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
3304
3340
  info: "info";
3305
3341
  warning: "warning";
3306
3342
  }>;
3307
- source: z.ZodOptional<z.ZodObject<{
3343
+ source: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
3308
3344
  file: z.ZodString;
3309
3345
  position: z.ZodOptional<z.ZodObject<{
3310
3346
  startLine: z.ZodNumber;
@@ -3312,7 +3348,11 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
3312
3348
  endLine: z.ZodOptional<z.ZodNumber>;
3313
3349
  endColumn: z.ZodOptional<z.ZodNumber>;
3314
3350
  }, z.core.$strip>>;
3315
- }, z.core.$strip>>;
3351
+ }, z.core.$strip>, z.ZodObject<{
3352
+ url: z.ZodURL;
3353
+ snippet: z.ZodOptional<z.ZodString>;
3354
+ selector: z.ZodOptional<z.ZodString>;
3355
+ }, z.core.$strip>]>>;
3316
3356
  }, z.core.$strip>>>;
3317
3357
  table: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
3318
3358
  title: z.ZodOptional<z.ZodString>;
@@ -3375,7 +3415,7 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
3375
3415
  info: "info";
3376
3416
  warning: "warning";
3377
3417
  }>;
3378
- source: z.ZodOptional<z.ZodObject<{
3418
+ source: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
3379
3419
  file: z.ZodString;
3380
3420
  position: z.ZodOptional<z.ZodObject<{
3381
3421
  startLine: z.ZodNumber;
@@ -3383,7 +3423,11 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
3383
3423
  endLine: z.ZodOptional<z.ZodNumber>;
3384
3424
  endColumn: z.ZodOptional<z.ZodNumber>;
3385
3425
  }, z.core.$strip>>;
3386
- }, z.core.$strip>>;
3426
+ }, z.core.$strip>, z.ZodObject<{
3427
+ url: z.ZodURL;
3428
+ snippet: z.ZodOptional<z.ZodString>;
3429
+ selector: z.ZodOptional<z.ZodString>;
3430
+ }, z.core.$strip>]>>;
3387
3431
  }, z.core.$strip>>>;
3388
3432
  table: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
3389
3433
  title: z.ZodOptional<z.ZodString>;
@@ -3434,7 +3478,7 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
3434
3478
  info: "info";
3435
3479
  warning: "warning";
3436
3480
  }>;
3437
- source: z.ZodOptional<z.ZodObject<{
3481
+ source: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
3438
3482
  file: z.ZodString;
3439
3483
  position: z.ZodOptional<z.ZodObject<{
3440
3484
  startLine: z.ZodNumber;
@@ -3442,7 +3486,11 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
3442
3486
  endLine: z.ZodOptional<z.ZodNumber>;
3443
3487
  endColumn: z.ZodOptional<z.ZodNumber>;
3444
3488
  }, z.core.$strip>>;
3445
- }, z.core.$strip>>;
3489
+ }, z.core.$strip>, z.ZodObject<{
3490
+ url: z.ZodURL;
3491
+ snippet: z.ZodOptional<z.ZodString>;
3492
+ selector: z.ZodOptional<z.ZodString>;
3493
+ }, z.core.$strip>]>>;
3446
3494
  }, z.core.$strip>>>;
3447
3495
  table: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
3448
3496
  title: z.ZodOptional<z.ZodString>;
@@ -3535,12 +3583,4 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
3535
3583
  scoreTarget: z.ZodOptional<z.ZodNumber>;
3536
3584
  }, z.core.$strip>>>;
3537
3585
  }, 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
3586
  export type CoreConfig = z.infer<typeof coreConfigSchema>;
package/src/lib/group.d.ts CHANGED
@@ -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;
package/src/lib/implementation/schemas.d.ts CHANGED
@@ -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;