@code-pushup/models 0.106.0 → 0.107.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +2 -2
- package/src/index.d.ts +1 -0
- package/src/index.js +1 -0
- package/src/index.js.map +1 -1
- package/src/lib/audit-output.d.ts +24 -0
- package/src/lib/audit.d.ts +10 -2
- package/src/lib/cache-config.d.ts +24 -0
- package/src/lib/category-config.d.ts +18 -2
- package/src/lib/commit.d.ts +8 -0
- package/src/lib/configuration.d.ts +8 -0
- package/src/lib/core-config.d.ts +29 -21
- package/src/lib/group.d.ts +27 -3
- package/src/lib/implementation/schemas.d.ts +27 -3
- package/src/lib/implementation/schemas.js +16 -16
- package/src/lib/implementation/schemas.js.map +1 -1
- package/src/lib/implementation/validate.d.ts +16 -0
- package/src/lib/issue.d.ts +16 -0
- package/src/lib/persist-config.d.ts +16 -0
- package/src/lib/plugin-config.d.ts +50 -10
- package/src/lib/report.d.ts +32 -8
- package/src/lib/reports-diff.d.ts +87 -31
- package/src/lib/runner-config.d.ts +43 -3
- package/src/lib/source.d.ts +8 -0
- package/src/lib/table.d.ts +48 -0
- package/src/lib/tree.d.ts +48 -0
- package/src/lib/upload-config.d.ts +9 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@code-pushup/models",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.107.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",
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"dependencies": {
|
|
30
30
|
"ansis": "^3.3.2",
|
|
31
31
|
"vscode-material-icons": "^0.1.0",
|
|
32
|
-
"zod": "^4.
|
|
32
|
+
"zod": "^4.2.1"
|
|
33
33
|
},
|
|
34
34
|
"files": [
|
|
35
35
|
"src",
|
package/src/index.d.ts
CHANGED
|
@@ -23,3 +23,4 @@ export { runnerArgsSchema, runnerConfigSchema, runnerFilesPathsSchema, runnerFun
|
|
|
23
23
|
export { tableAlignmentSchema, tableColumnObjectSchema, tableColumnPrimitiveSchema, tableRowObjectSchema, tableRowPrimitiveSchema, tableSchema, type Table, type TableAlignment, type TableColumnObject, type TableColumnPrimitive, type TableRowObject, type TableRowPrimitive, } from './lib/table.js';
|
|
24
24
|
export { basicTreeNodeSchema, basicTreeSchema, coverageTreeMissingLOCSchema, coverageTreeNodeSchema, coverageTreeSchema, treeSchema, type BasicTree, type BasicTreeNode, type CoverageTree, type CoverageTreeMissingLOC, type CoverageTreeNode, type Tree, } from './lib/tree.js';
|
|
25
25
|
export { uploadConfigSchema, type UploadConfig } from './lib/upload-config.js';
|
|
26
|
+
export { convertAsyncZodFunctionToSchema } from './lib/implementation/function.js';
|
package/src/index.js
CHANGED
|
@@ -23,4 +23,5 @@ export { runnerArgsSchema, runnerConfigSchema, runnerFilesPathsSchema, runnerFun
|
|
|
23
23
|
export { tableAlignmentSchema, tableColumnObjectSchema, tableColumnPrimitiveSchema, tableRowObjectSchema, tableRowPrimitiveSchema, tableSchema, } from './lib/table.js';
|
|
24
24
|
export { basicTreeNodeSchema, basicTreeSchema, coverageTreeMissingLOCSchema, coverageTreeNodeSchema, coverageTreeSchema, treeSchema, } from './lib/tree.js';
|
|
25
25
|
export { uploadConfigSchema } from './lib/upload-config.js';
|
|
26
|
+
export { convertAsyncZodFunctionToSchema } from './lib/implementation/function.js';
|
|
26
27
|
//# sourceMappingURL=index.js.map
|
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"}
|
|
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"}
|
|
@@ -54,6 +54,14 @@ 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
|
+
*/
|
|
57
65
|
export type AuditDetails = z.infer<typeof auditDetailsSchema>;
|
|
58
66
|
export declare const auditOutputSchema: z.ZodObject<{
|
|
59
67
|
slug: z.ZodString;
|
|
@@ -115,6 +123,14 @@ export declare const auditOutputSchema: z.ZodObject<{
|
|
|
115
123
|
}, z.core.$strip>]>>>;
|
|
116
124
|
}, z.core.$strip>>;
|
|
117
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
|
+
*/
|
|
118
134
|
export type AuditOutput = z.infer<typeof auditOutputSchema>;
|
|
119
135
|
export declare const auditOutputsSchema: z.ZodArray<z.ZodObject<{
|
|
120
136
|
slug: z.ZodString;
|
|
@@ -176,4 +192,12 @@ export declare const auditOutputsSchema: z.ZodArray<z.ZodObject<{
|
|
|
176
192
|
}, z.core.$strip>]>>>;
|
|
177
193
|
}, z.core.$strip>>;
|
|
178
194
|
}, 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
|
+
*/
|
|
179
203
|
export type AuditOutputs = z.infer<typeof auditOutputsSchema>;
|
package/src/lib/audit.d.ts
CHANGED
|
@@ -3,14 +3,22 @@ export declare const auditSchema: z.ZodObject<{
|
|
|
3
3
|
slug: z.ZodString;
|
|
4
4
|
title: z.ZodString;
|
|
5
5
|
description: z.ZodOptional<z.ZodString>;
|
|
6
|
-
docsUrl: z.
|
|
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
|
+
*/
|
|
9
17
|
export type Audit = z.infer<typeof auditSchema>;
|
|
10
18
|
export declare const pluginAuditsSchema: z.ZodArray<z.ZodObject<{
|
|
11
19
|
slug: z.ZodString;
|
|
12
20
|
title: z.ZodString;
|
|
13
21
|
description: z.ZodOptional<z.ZodString>;
|
|
14
|
-
docsUrl: z.
|
|
22
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
15
23
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
16
24
|
}, z.core.$strip>>;
|
|
@@ -3,11 +3,35 @@ 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
|
+
*/
|
|
6
14
|
export type CacheConfigObject = z.infer<typeof cacheConfigObjectSchema>;
|
|
7
15
|
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
|
+
*/
|
|
8
24
|
export type CacheConfigShorthand = z.infer<typeof cacheConfigShorthandSchema>;
|
|
9
25
|
export declare const cacheConfigSchema: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
|
|
10
26
|
read: z.ZodDefault<z.ZodBoolean>;
|
|
11
27
|
write: z.ZodDefault<z.ZodBoolean>;
|
|
12
28
|
}, 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
|
+
*/
|
|
13
37
|
export type CacheConfig = z.infer<typeof cacheConfigSchema>;
|
|
@@ -8,6 +8,14 @@ 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
|
+
*/
|
|
11
19
|
export type CategoryRef = z.infer<typeof categoryRefSchema>;
|
|
12
20
|
export declare const categoryConfigSchema: z.ZodObject<{
|
|
13
21
|
slug: z.ZodString;
|
|
@@ -22,10 +30,18 @@ export declare const categoryConfigSchema: z.ZodObject<{
|
|
|
22
30
|
}, z.core.$strip>>;
|
|
23
31
|
title: z.ZodString;
|
|
24
32
|
description: z.ZodOptional<z.ZodString>;
|
|
25
|
-
docsUrl: z.
|
|
33
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
26
34
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
27
35
|
scoreTarget: z.ZodOptional<z.ZodNumber>;
|
|
28
36
|
}, 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
|
+
*/
|
|
29
45
|
export type CategoryConfig = z.infer<typeof categoryConfigSchema>;
|
|
30
46
|
export declare const categoriesSchema: z.ZodArray<z.ZodObject<{
|
|
31
47
|
slug: z.ZodString;
|
|
@@ -40,7 +56,7 @@ export declare const categoriesSchema: z.ZodArray<z.ZodObject<{
|
|
|
40
56
|
}, z.core.$strip>>;
|
|
41
57
|
title: z.ZodString;
|
|
42
58
|
description: z.ZodOptional<z.ZodString>;
|
|
43
|
-
docsUrl: z.
|
|
59
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
44
60
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
45
61
|
scoreTarget: z.ZodOptional<z.ZodNumber>;
|
|
46
62
|
}, z.core.$strip>>;
|
package/src/lib/commit.d.ts
CHANGED
|
@@ -5,4 +5,12 @@ 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
|
+
*/
|
|
8
16
|
export type Commit = z.infer<typeof commitSchema>;
|
|
@@ -13,4 +13,12 @@ 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
|
+
*/
|
|
16
24
|
export type PluginArtifactOptions = z.infer<typeof pluginArtifactOptionsSchema>;
|
package/src/lib/core-config.d.ts
CHANGED
|
@@ -5,7 +5,7 @@ export declare const unrefinedCoreConfigSchema: z.ZodObject<{
|
|
|
5
5
|
version: z.ZodOptional<z.ZodString>;
|
|
6
6
|
title: z.ZodString;
|
|
7
7
|
description: z.ZodOptional<z.ZodString>;
|
|
8
|
-
docsUrl: z.
|
|
8
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
9
9
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
10
10
|
slug: z.ZodString;
|
|
11
11
|
icon: z.ZodEnum<{
|
|
@@ -872,7 +872,7 @@ export declare const unrefinedCoreConfigSchema: z.ZodObject<{
|
|
|
872
872
|
command: z.ZodString;
|
|
873
873
|
args: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
874
874
|
outputFile: z.ZodString;
|
|
875
|
-
outputTransform: z.ZodOptional<z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.
|
|
875
|
+
outputTransform: z.ZodOptional<z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [z.ZodUnknown], null>, z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
|
|
876
876
|
slug: z.ZodString;
|
|
877
877
|
displayValue: z.ZodOptional<z.ZodString>;
|
|
878
878
|
value: z.ZodNumber;
|
|
@@ -992,7 +992,7 @@ export declare const unrefinedCoreConfigSchema: z.ZodObject<{
|
|
|
992
992
|
}, z.core.$strip>>;
|
|
993
993
|
}, z.core.$strip>>>]>>, unknown>>>;
|
|
994
994
|
configFile: z.ZodOptional<z.ZodString>;
|
|
995
|
-
}, z.core.$strip>, z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.
|
|
995
|
+
}, z.core.$strip>, z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [z.ZodObject<{
|
|
996
996
|
persist: z.ZodObject<{
|
|
997
997
|
outputDir: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
|
|
998
998
|
filename: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
|
|
@@ -1125,7 +1125,7 @@ export declare const unrefinedCoreConfigSchema: z.ZodObject<{
|
|
|
1125
1125
|
slug: z.ZodString;
|
|
1126
1126
|
title: z.ZodString;
|
|
1127
1127
|
description: z.ZodOptional<z.ZodString>;
|
|
1128
|
-
docsUrl: z.
|
|
1128
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
1129
1129
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
1130
1130
|
}, z.core.$strip>>;
|
|
1131
1131
|
groups: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
@@ -1136,7 +1136,7 @@ export declare const unrefinedCoreConfigSchema: z.ZodObject<{
|
|
|
1136
1136
|
}, z.core.$strip>>;
|
|
1137
1137
|
title: z.ZodString;
|
|
1138
1138
|
description: z.ZodOptional<z.ZodString>;
|
|
1139
|
-
docsUrl: z.
|
|
1139
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
1140
1140
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
1141
1141
|
}, z.core.$strip>>>;
|
|
1142
1142
|
scoreTargets: z.ZodOptional<z.ZodUnion<readonly [z.ZodOptional<z.ZodNumber>, z.ZodRecord<z.ZodString, z.ZodNonOptional<z.ZodOptional<z.ZodNumber>>>]>>;
|
|
@@ -1152,7 +1152,7 @@ export declare const unrefinedCoreConfigSchema: z.ZodObject<{
|
|
|
1152
1152
|
skipReports: z.ZodOptional<z.ZodBoolean>;
|
|
1153
1153
|
}, z.core.$strip>>;
|
|
1154
1154
|
upload: z.ZodOptional<z.ZodObject<{
|
|
1155
|
-
server: z.
|
|
1155
|
+
server: z.ZodURL;
|
|
1156
1156
|
apiKey: z.ZodString;
|
|
1157
1157
|
organization: z.ZodString;
|
|
1158
1158
|
project: z.ZodString;
|
|
@@ -1171,7 +1171,7 @@ export declare const unrefinedCoreConfigSchema: z.ZodObject<{
|
|
|
1171
1171
|
}, z.core.$strip>>;
|
|
1172
1172
|
title: z.ZodString;
|
|
1173
1173
|
description: z.ZodOptional<z.ZodString>;
|
|
1174
|
-
docsUrl: z.
|
|
1174
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
1175
1175
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
1176
1176
|
scoreTarget: z.ZodOptional<z.ZodNumber>;
|
|
1177
1177
|
}, z.core.$strip>>>;
|
|
@@ -1182,7 +1182,7 @@ export declare const coreConfigSchema: z.ZodObject<{
|
|
|
1182
1182
|
version: z.ZodOptional<z.ZodString>;
|
|
1183
1183
|
title: z.ZodString;
|
|
1184
1184
|
description: z.ZodOptional<z.ZodString>;
|
|
1185
|
-
docsUrl: z.
|
|
1185
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
1186
1186
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
1187
1187
|
slug: z.ZodString;
|
|
1188
1188
|
icon: z.ZodEnum<{
|
|
@@ -2049,7 +2049,7 @@ export declare const coreConfigSchema: z.ZodObject<{
|
|
|
2049
2049
|
command: z.ZodString;
|
|
2050
2050
|
args: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
2051
2051
|
outputFile: z.ZodString;
|
|
2052
|
-
outputTransform: z.ZodOptional<z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.
|
|
2052
|
+
outputTransform: z.ZodOptional<z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [z.ZodUnknown], null>, z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
|
|
2053
2053
|
slug: z.ZodString;
|
|
2054
2054
|
displayValue: z.ZodOptional<z.ZodString>;
|
|
2055
2055
|
value: z.ZodNumber;
|
|
@@ -2169,7 +2169,7 @@ export declare const coreConfigSchema: z.ZodObject<{
|
|
|
2169
2169
|
}, z.core.$strip>>;
|
|
2170
2170
|
}, z.core.$strip>>>]>>, unknown>>>;
|
|
2171
2171
|
configFile: z.ZodOptional<z.ZodString>;
|
|
2172
|
-
}, z.core.$strip>, z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.
|
|
2172
|
+
}, z.core.$strip>, z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [z.ZodObject<{
|
|
2173
2173
|
persist: z.ZodObject<{
|
|
2174
2174
|
outputDir: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
|
|
2175
2175
|
filename: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
|
|
@@ -2302,7 +2302,7 @@ export declare const coreConfigSchema: z.ZodObject<{
|
|
|
2302
2302
|
slug: z.ZodString;
|
|
2303
2303
|
title: z.ZodString;
|
|
2304
2304
|
description: z.ZodOptional<z.ZodString>;
|
|
2305
|
-
docsUrl: z.
|
|
2305
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
2306
2306
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
2307
2307
|
}, z.core.$strip>>;
|
|
2308
2308
|
groups: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
@@ -2313,7 +2313,7 @@ export declare const coreConfigSchema: z.ZodObject<{
|
|
|
2313
2313
|
}, z.core.$strip>>;
|
|
2314
2314
|
title: z.ZodString;
|
|
2315
2315
|
description: z.ZodOptional<z.ZodString>;
|
|
2316
|
-
docsUrl: z.
|
|
2316
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
2317
2317
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
2318
2318
|
}, z.core.$strip>>>;
|
|
2319
2319
|
scoreTargets: z.ZodOptional<z.ZodUnion<readonly [z.ZodOptional<z.ZodNumber>, z.ZodRecord<z.ZodString, z.ZodNonOptional<z.ZodOptional<z.ZodNumber>>>]>>;
|
|
@@ -2329,7 +2329,7 @@ export declare const coreConfigSchema: z.ZodObject<{
|
|
|
2329
2329
|
skipReports: z.ZodOptional<z.ZodBoolean>;
|
|
2330
2330
|
}, z.core.$strip>>;
|
|
2331
2331
|
upload: z.ZodOptional<z.ZodObject<{
|
|
2332
|
-
server: z.
|
|
2332
|
+
server: z.ZodURL;
|
|
2333
2333
|
apiKey: z.ZodString;
|
|
2334
2334
|
organization: z.ZodString;
|
|
2335
2335
|
project: z.ZodString;
|
|
@@ -2348,7 +2348,7 @@ export declare const coreConfigSchema: z.ZodObject<{
|
|
|
2348
2348
|
}, z.core.$strip>>;
|
|
2349
2349
|
title: z.ZodString;
|
|
2350
2350
|
description: z.ZodOptional<z.ZodString>;
|
|
2351
|
-
docsUrl: z.
|
|
2351
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
2352
2352
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
2353
2353
|
scoreTarget: z.ZodOptional<z.ZodNumber>;
|
|
2354
2354
|
}, z.core.$strip>>>;
|
|
@@ -2364,7 +2364,7 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
|
|
|
2364
2364
|
version: z.ZodOptional<z.ZodString>;
|
|
2365
2365
|
title: z.ZodString;
|
|
2366
2366
|
description: z.ZodOptional<z.ZodString>;
|
|
2367
|
-
docsUrl: z.
|
|
2367
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
2368
2368
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
2369
2369
|
slug: z.ZodString;
|
|
2370
2370
|
icon: z.ZodEnum<{
|
|
@@ -3231,7 +3231,7 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
|
|
|
3231
3231
|
command: z.ZodString;
|
|
3232
3232
|
args: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
3233
3233
|
outputFile: z.ZodString;
|
|
3234
|
-
outputTransform: z.ZodOptional<z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.
|
|
3234
|
+
outputTransform: z.ZodOptional<z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [z.ZodUnknown], null>, z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
|
|
3235
3235
|
slug: z.ZodString;
|
|
3236
3236
|
displayValue: z.ZodOptional<z.ZodString>;
|
|
3237
3237
|
value: z.ZodNumber;
|
|
@@ -3351,7 +3351,7 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
|
|
|
3351
3351
|
}, z.core.$strip>>;
|
|
3352
3352
|
}, z.core.$strip>>>]>>, unknown>>>;
|
|
3353
3353
|
configFile: z.ZodOptional<z.ZodString>;
|
|
3354
|
-
}, z.core.$strip>, z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.
|
|
3354
|
+
}, z.core.$strip>, z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [z.ZodObject<{
|
|
3355
3355
|
persist: z.ZodObject<{
|
|
3356
3356
|
outputDir: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
|
|
3357
3357
|
filename: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
|
|
@@ -3484,7 +3484,7 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
|
|
|
3484
3484
|
slug: z.ZodString;
|
|
3485
3485
|
title: z.ZodString;
|
|
3486
3486
|
description: z.ZodOptional<z.ZodString>;
|
|
3487
|
-
docsUrl: z.
|
|
3487
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
3488
3488
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
3489
3489
|
}, z.core.$strip>>;
|
|
3490
3490
|
groups: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
@@ -3495,7 +3495,7 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
|
|
|
3495
3495
|
}, z.core.$strip>>;
|
|
3496
3496
|
title: z.ZodString;
|
|
3497
3497
|
description: z.ZodOptional<z.ZodString>;
|
|
3498
|
-
docsUrl: z.
|
|
3498
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
3499
3499
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
3500
3500
|
}, z.core.$strip>>>;
|
|
3501
3501
|
scoreTargets: z.ZodOptional<z.ZodUnion<readonly [z.ZodOptional<z.ZodNumber>, z.ZodRecord<z.ZodString, z.ZodNonOptional<z.ZodOptional<z.ZodNumber>>>]>>;
|
|
@@ -3511,7 +3511,7 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
|
|
|
3511
3511
|
skipReports: z.ZodOptional<z.ZodBoolean>;
|
|
3512
3512
|
}, z.core.$strip>>;
|
|
3513
3513
|
upload: z.ZodOptional<z.ZodObject<{
|
|
3514
|
-
server: z.
|
|
3514
|
+
server: z.ZodURL;
|
|
3515
3515
|
apiKey: z.ZodString;
|
|
3516
3516
|
organization: z.ZodString;
|
|
3517
3517
|
project: z.ZodString;
|
|
@@ -3530,9 +3530,17 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
|
|
|
3530
3530
|
}, z.core.$strip>>;
|
|
3531
3531
|
title: z.ZodString;
|
|
3532
3532
|
description: z.ZodOptional<z.ZodString>;
|
|
3533
|
-
docsUrl: z.
|
|
3533
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
3534
3534
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
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
|
+
*/
|
|
3538
3546
|
export type CoreConfig = z.infer<typeof coreConfigSchema>;
|
package/src/lib/group.d.ts
CHANGED
|
@@ -3,13 +3,29 @@ 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
|
+
*/
|
|
6
14
|
export type GroupRef = z.infer<typeof groupRefSchema>;
|
|
7
15
|
export declare const groupMetaSchema: z.ZodObject<{
|
|
8
16
|
title: z.ZodString;
|
|
9
17
|
description: z.ZodOptional<z.ZodString>;
|
|
10
|
-
docsUrl: z.
|
|
18
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
11
19
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
12
20
|
}, 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
|
+
*/
|
|
13
29
|
export type GroupMeta = z.infer<typeof groupMetaSchema>;
|
|
14
30
|
export declare const groupSchema: z.ZodObject<{
|
|
15
31
|
slug: z.ZodString;
|
|
@@ -19,9 +35,17 @@ export declare const groupSchema: z.ZodObject<{
|
|
|
19
35
|
}, z.core.$strip>>;
|
|
20
36
|
title: z.ZodString;
|
|
21
37
|
description: z.ZodOptional<z.ZodString>;
|
|
22
|
-
docsUrl: z.
|
|
38
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
23
39
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
24
40
|
}, 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
|
+
*/
|
|
25
49
|
export type Group = z.infer<typeof groupSchema>;
|
|
26
50
|
export declare const groupsSchema: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
27
51
|
slug: z.ZodString;
|
|
@@ -31,6 +55,6 @@ export declare const groupsSchema: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
|
31
55
|
}, z.core.$strip>>;
|
|
32
56
|
title: z.ZodString;
|
|
33
57
|
description: z.ZodOptional<z.ZodString>;
|
|
34
|
-
docsUrl: z.
|
|
58
|
+
docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
|
|
35
59
|
isSkipped: z.ZodOptional<z.ZodBoolean>;
|
|
36
60
|
}, z.core.$strip>>>;
|
|
@@ -1,5 +1,13 @@
|
|
|
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
|
+
*/
|
|
3
11
|
export type TableCellValue = z.infer<typeof tableCellValueSchema>;
|
|
4
12
|
/**
|
|
5
13
|
* Schema for execution meta date
|
|
@@ -15,9 +23,9 @@ export declare function executionMetaSchema(options?: {
|
|
|
15
23
|
export declare const slugSchema: ZodString;
|
|
16
24
|
/** Schema for a general description property */
|
|
17
25
|
export declare const descriptionSchema: ZodOptional<ZodString>;
|
|
18
|
-
export declare const urlSchema:
|
|
26
|
+
export declare const urlSchema: z.ZodURL;
|
|
19
27
|
/** Schema for a docsUrl */
|
|
20
|
-
export declare const docsUrlSchema:
|
|
28
|
+
export declare const docsUrlSchema: ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<ZodOptional<z.ZodURL>>]>>;
|
|
21
29
|
/** Schema for a title of a plugin, category and audit */
|
|
22
30
|
export declare const titleSchema: ZodString;
|
|
23
31
|
/** Schema for score of audit, category or group */
|
|
@@ -37,7 +45,7 @@ export declare function metaSchema(options?: {
|
|
|
37
45
|
}): ZodObject<{
|
|
38
46
|
title: ZodString;
|
|
39
47
|
description: ZodOptional<ZodString>;
|
|
40
|
-
docsUrl:
|
|
48
|
+
docsUrl: ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<ZodOptional<z.ZodURL>>]>>;
|
|
41
49
|
isSkipped: ZodOptional<z.ZodBoolean>;
|
|
42
50
|
}, z.core.$strip>;
|
|
43
51
|
/** Schema for a generalFilePath */
|
|
@@ -63,6 +71,14 @@ export declare function weightedRefSchema(description: string, slugDescription:
|
|
|
63
71
|
slug: ZodString;
|
|
64
72
|
weight: z.ZodNumber;
|
|
65
73
|
}, 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
|
+
*/
|
|
66
82
|
export type WeightedRef = z.infer<ReturnType<typeof weightedRefSchema>>;
|
|
67
83
|
export declare function scorableSchema<T extends ReturnType<typeof weightedRefSchema>>(description: string, refSchema: T, duplicateCheckFn: z.core.CheckFn<z.infer<T>[]>): ZodObject<{
|
|
68
84
|
slug: ZodString;
|
|
@@ -928,6 +944,14 @@ export declare const materialIconSchema: z.ZodEnum<{
|
|
|
928
944
|
nodejs_alt: "nodejs_alt";
|
|
929
945
|
silverstripe: "silverstripe";
|
|
930
946
|
}>;
|
|
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
|
+
*/
|
|
931
955
|
export type MaterialIcon = z.infer<typeof materialIconSchema>;
|
|
932
956
|
export declare const filePositionSchema: ZodObject<{
|
|
933
957
|
startLine: z.ZodNumber;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { MATERIAL_ICONS } from 'vscode-material-icons';
|
|
2
|
-
import {
|
|
2
|
+
import { z } from 'zod';
|
|
3
3
|
import { MAX_DESCRIPTION_LENGTH, MAX_SLUG_LENGTH, MAX_TITLE_LENGTH, } from './limits.js';
|
|
4
4
|
import { filenameRegex, slugRegex } from './utils.js';
|
|
5
5
|
export const tableCellValueSchema = z
|
|
@@ -41,23 +41,23 @@ export const descriptionSchema = z
|
|
|
41
41
|
})
|
|
42
42
|
.optional();
|
|
43
43
|
/* Schema for a URL */
|
|
44
|
-
export const urlSchema = z.
|
|
44
|
+
export const urlSchema = z.url().meta({ title: 'URL' });
|
|
45
45
|
/** Schema for a docsUrl */
|
|
46
|
-
export const docsUrlSchema =
|
|
47
|
-
.
|
|
48
|
-
|
|
46
|
+
export const docsUrlSchema = z
|
|
47
|
+
.union([
|
|
48
|
+
z.literal(''), // allow empty string (no URL validation)
|
|
49
49
|
// eslint-disable-next-line unicorn/prefer-top-level-await, unicorn/catch-error-name
|
|
50
|
-
.catch(ctx => {
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
return
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
|
|
50
|
+
urlSchema.optional().catch(ctx => {
|
|
51
|
+
const issue = ctx.issues[0];
|
|
52
|
+
if (issue?.code === 'invalid_format' && issue?.format === 'url') {
|
|
53
|
+
console.warn(`Ignoring invalid docsUrl: ${ctx.value}`);
|
|
54
|
+
return '';
|
|
55
|
+
}
|
|
56
|
+
// re-parse to throw formatted error for non-URL issues
|
|
57
|
+
return urlSchema.parse(ctx.value);
|
|
58
|
+
}),
|
|
59
|
+
])
|
|
60
|
+
.optional()
|
|
61
61
|
.meta({ title: 'DocsUrl', description: 'Documentation site' });
|
|
62
62
|
/** Schema for a title of a plugin, category and audit */
|
|
63
63
|
export const titleSchema = z.string().max(MAX_TITLE_LENGTH).meta({
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../../src/lib/implementation/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,
|
|
1
|
+
{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../../src/lib/implementation/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAoD,CAAC,EAAE,MAAM,KAAK,CAAC;AAC1E,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,gBAAgB,GACjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEtD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;KACtD,OAAO,CAAC,IAAI,CAAC;KACb,IAAI,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC,CAAC;AAIrC;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,UAGI;IACF,eAAe,EAAE,+BAA+B;IAChD,mBAAmB,EAAE,0BAA0B;CAChD;IAED,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC;QAClD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,mBAAmB,CAAC;KAC3D,CAAC,CAAC;AACL,CAAC;AAED,4DAA4D;AAC5D,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC;KACxB,MAAM,EAAE;KACR,KAAK,CAAC,SAAS,EAAE;IAChB,OAAO,EACL,6GAA6G;CAChH,CAAC;KACD,GAAG,CAAC,eAAe,EAAE;IACpB,OAAO,EAAE,uBAAuB,eAAe,kBAAkB;CAClE,CAAC;KACD,IAAI,CAAC;IACJ,KAAK,EAAE,MAAM;IACb,WAAW,EAAE,sCAAsC;CACpD,CAAC,CAAC;AAEL,iDAAiD;AACjD,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,EAAE;KACR,GAAG,CAAC,sBAAsB,CAAC;KAC3B,IAAI,CAAC;IACJ,KAAK,EAAE,aAAa;IACpB,WAAW,EAAE,wBAAwB;CACtC,CAAC;KACD,QAAQ,EAAE,CAAC;AAEd,sBAAsB;AACtB,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;AAExD,4BAA4B;AAC5B,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC3B,KAAK,CAAC;IACL,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,yCAAyC;IACxD,oFAAoF;IACpF,SAAS,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;QAC/B,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC5B,IAAI,KAAK,EAAE,IAAI,KAAK,gBAAgB,IAAI,KAAK,EAAE,MAAM,KAAK,KAAK,EAAE,CAAC;YAChE,OAAO,CAAC,IAAI,CAAC,6BAA6B,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;YACvD,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,uDAAuD;QACvD,OAAO,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC,CAAC;CACH,CAAC;KACD,QAAQ,EAAE;KACV,IAAI,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,oBAAoB,EAAE,CAAC,CAAC;AAEjE,yDAAyD;AACzD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC;IAC/D,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,kBAAkB;CAChC,CAAC,CAAC;AAEH,mDAAmD;AACnD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACvD,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,uBAAuB;CACrC,CAAC,CAAC;AAEH,yEAAyE;AACzE,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC7B,OAAO,EAAE;KACT,QAAQ,EAAE;KACV,IAAI,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;AAEhC;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,OAM1B;IACC,MAAM,EACJ,sBAAsB,EACtB,gBAAgB,EAChB,kBAAkB,EAClB,WAAW,EACX,oBAAoB,GACrB,GAAG,OAAO,IAAI,EAAE,CAAC;IAClB,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC;QACpB,KAAK,EAAE,gBAAgB;YACrB,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YACxC,CAAC,CAAC,WAAW;QACf,WAAW,EAAE,sBAAsB;YACjC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,sBAAsB,CAAC;YACpD,CAAC,CAAC,iBAAiB;QACrB,OAAO,EAAE,kBAAkB;YACzB,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,kBAAkB,CAAC;YAC5C,CAAC,CAAC,aAAa;QACjB,SAAS,EAAE,oBAAoB;YAC7B,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,oBAAoB,CAAC;YAChD,CAAC,CAAC,eAAe;KACpB,CAAC,CAAC;IACH,OAAO,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACzD,CAAC;AAED,mCAAmC;AACnC,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,EAAE;KACR,IAAI,EAAE;KACN,GAAG,CAAC,CAAC,CAAC;KACN,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;AAE/B;;;;GAIG;AACH,MAAM,SAAS,GAAG,cAAc,CAAC;AAEjC,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC;IAC3E,KAAK,EAAE,UAAU;IACjB,WAAW,EACT,wEAAwE;CAC3E,CAAC,CAAC;AAEH,kCAAkC;AAClC,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,EAAE;KACR,IAAI,EAAE;KACN,KAAK,CAAC,aAAa,CAAC;KACpB,GAAG,CAAC,CAAC,CAAC;KACN,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;AAE/B,+BAA+B;AAC/B,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,EAAE;KACR,GAAG,EAAE;KACL,QAAQ,EAAE;KACV,IAAI,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;AAElC,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC;KACrC,MAAM,EAAE;KACR,WAAW,EAAE;KACb,IAAI,CAAC,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC,CAAC;AAExC,MAAM,UAAU,oBAAoB,CAElC,OAA+D;IAC/D,MAAM,EAAE,kBAAkB,GAAG,4BAA4B,EAAE,QAAQ,EAAE,GACnE,OAAO,IAAI,EAAE,CAAC;IAChB,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAC3E,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAC3E,OAAO,CAAC;SACL,MAAM,CAAC;QACN,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE;QAChE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE;KAC7D,CAAC;SACD,IAAI,CAAC;QACJ,WAAW,EAAE,qDAAqD;KACnE,CAGD,CAAC;AACL,CAAC;AAED,0CAA0C;AAC1C,MAAM,CAAC,MAAM,iBAAiB,GAAG,uBAAuB;KACrD,GAAG,CAAC,CAAC,CAAC;KACN,IAAI,CAAC;IACJ,KAAK,EAAE,aAAa;IACpB,WAAW,EAAE,iCAAiC;CAC/C,CAAC;KACD,QAAQ,EAAE,CAAC;AAEd,0BAA0B;AAC1B,MAAM,CAAC,MAAM,YAAY,GAAG,uBAAuB,CAAC,IAAI,CAAC;IACvD,KAAK,EAAE,QAAQ;IACf,WAAW,EACT,oEAAoE;CACvE,CAAC,CAAC;AAEH,MAAM,UAAU,iBAAiB,CAC/B,WAAmB,EACnB,eAAuB;IAEvB,OAAO,CAAC;SACL,MAAM,CAAC;QACN,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC;QACvD,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC;YACxB,WAAW,EAAE,gCAAgC;SAC9C,CAAC;KACH,CAAC;SACD,IAAI,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;AAC3B,CAAC;AAID,MAAM,UAAU,cAAc,CAC5B,WAAmB,EACnB,SAAY,EACZ,gBAA8C;IAE9C,OAAO,CAAC;SACL,MAAM,CAAC;QACN,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC;YACpB,WAAW,EAAE,8CAA8C;SAC5D,CAAC;QACF,IAAI,EAAE,CAAC;aACJ,KAAK,CAAC,SAAS,CAAC;aAChB,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,iDAAiD,EAAE,CAAC;YACvE,kBAAkB;aACjB,KAAK,CAAC,gBAAgB,CAAC;YACxB,+BAA+B;aAC9B,MAAM,CAAC,qBAAqB,EAAE;YAC7B,KAAK,EAAE,sDAAsD;SAC9D,CAAC;KACL,CAAC;SACD,QAAQ,CAAC,WAAW,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC;IAC5D,KAAK,EAAE,cAAc;IACrB,WAAW,EAAE,2CAA2C;CACzD,CAAC,CAAC;AAKH,SAAS,qBAAqB,CAAC,IAAW;IACxC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;AACjE,CAAC;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,MAAM,CAAC;IACN,SAAS,EAAE,iBAAiB,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC;IAChE,WAAW,EAAE,iBAAiB;SAC3B,IAAI,CAAC,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC;SACrC,QAAQ,EAAE;IACb,OAAO,EAAE,iBAAiB,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvE,SAAS,EAAE,iBAAiB,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC5E,CAAC;KACD,IAAI,CAAC;IACJ,KAAK,EAAE,cAAc;IACrB,WAAW,EAAE,kBAAkB;CAChC,CAAC,CAAC"}
|