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