@code-pushup/models 0.57.0 → 0.59.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/models",
-  "version": "0.57.0",
+  "version": "0.59.0",
   "license": "MIT",
   "description": "Model definitions and validators for the Code PushUp CLI",
   "homepage": "https://github.com/code-pushup/cli/tree/main/packages/models#readme",

package/src/index.d.ts

@@ -1,21 +1,21 @@
-export { type TableCellValue, tableCellValueSchema, } from './lib/implementation/schemas.js';
-export { type SourceFileLocation, sourceFileLocationSchema, } from './lib/source.js';
-export { type Audit, auditSchema } from './lib/audit.js';
-export { type AuditDetails, type AuditOutput, type AuditOutputs, auditDetailsSchema, auditOutputSchema, auditOutputsSchema, } from './lib/audit-output.js';
-export { type CategoryConfig, type CategoryRef, categoryConfigSchema, categoryRefSchema, } from './lib/category-config.js';
-export { type Commit, commitSchema } from './lib/commit.js';
-export { type CoreConfig, coreConfigSchema } from './lib/core-config.js';
-export { type Group, type GroupRef, type GroupMeta, groupRefSchema, groupSchema, } from './lib/group.js';
+export { tableCellValueSchema, type TableCellValue, } from './lib/implementation/schemas.js';
+export { sourceFileLocationSchema, type SourceFileLocation, } from './lib/source.js';
+export { auditDetailsSchema, auditOutputSchema, auditOutputsSchema, type AuditDetails, type AuditOutput, type AuditOutputs, } from './lib/audit-output.js';
+export { auditSchema, type Audit } from './lib/audit.js';
+export { categoryConfigSchema, categoryRefSchema, type CategoryConfig, type CategoryRef, } from './lib/category-config.js';
+export { commitSchema, type Commit } from './lib/commit.js';
+export { coreConfigSchema, type CoreConfig } from './lib/core-config.js';
+export { groupRefSchema, groupSchema, type Group, type GroupMeta, type GroupRef, } from './lib/group.js';
 export { CONFIG_FILE_NAME, SUPPORTED_CONFIG_FILE_FORMATS, } from './lib/implementation/configuration.js';
 export { DEFAULT_PERSIST_FILENAME, DEFAULT_PERSIST_FORMAT, DEFAULT_PERSIST_OUTPUT_DIR, } from './lib/implementation/constants.js';
 export { MAX_DESCRIPTION_LENGTH, MAX_ISSUE_MESSAGE_LENGTH, MAX_SLUG_LENGTH, MAX_TITLE_LENGTH, } from './lib/implementation/limits.js';
-export { type MaterialIcon, materialIconSchema, } from './lib/implementation/schemas.js';
+export { fileNameSchema, filePathSchema, materialIconSchema, type MaterialIcon, } from './lib/implementation/schemas.js';
 export { exists } from './lib/implementation/utils.js';
-export { type TableAlignment, tableAlignmentSchema, type TableRowPrimitive, tableRowPrimitiveSchema, type TableRowObject, tableRowObjectSchema, type TableColumnPrimitive, tableColumnPrimitiveSchema, type TableColumnObject, tableColumnObjectSchema, type Table, tableSchema, } from './lib/table.js';
-export { type Issue, type IssueSeverity, issueSchema, issueSeveritySchema, } from './lib/issue.js';
-export { type Format, type PersistConfig, formatSchema, persistConfigSchema, } from './lib/persist-config.js';
-export { type PluginConfig, type PluginMeta, pluginConfigSchema, pluginMetaSchema, } from './lib/plugin-config.js';
-export { type AuditReport, type PluginReport, type Report, auditReportSchema, pluginReportSchema, reportSchema, } from './lib/report.js';
-export { type AuditDiff, type AuditResult, type CategoryDiff, type CategoryResult, type GroupDiff, type GroupResult, type ReportsDiff, auditDiffSchema, auditResultSchema, categoryDiffSchema, categoryResultSchema, groupDiffSchema, groupResultSchema, reportsDiffSchema, } from './lib/reports-diff.js';
-export { type OnProgress, type RunnerConfig, type RunnerFunction, onProgressSchema, runnerConfigSchema, runnerFunctionSchema, } from './lib/runner-config.js';
-export { type UploadConfig, uploadConfigSchema } from './lib/upload-config.js';
+export { issueSchema, issueSeveritySchema, type Issue, type IssueSeverity, } from './lib/issue.js';
+export { formatSchema, persistConfigSchema, type Format, type PersistConfig, } from './lib/persist-config.js';
+export { pluginConfigSchema, pluginMetaSchema, type PluginConfig, type PluginMeta, } from './lib/plugin-config.js';
+export { auditReportSchema, pluginReportSchema, reportSchema, type AuditReport, type PluginReport, type Report, } from './lib/report.js';
+export { auditDiffSchema, auditResultSchema, categoryDiffSchema, categoryResultSchema, groupDiffSchema, groupResultSchema, reportsDiffSchema, type AuditDiff, type AuditResult, type CategoryDiff, type CategoryResult, type GroupDiff, type GroupResult, type ReportsDiff, } from './lib/reports-diff.js';
+export { onProgressSchema, runnerConfigSchema, runnerFunctionSchema, runnerFilesPathsSchema, type OnProgress, type RunnerConfig, type RunnerFunction, type RunnerFilesPaths, } from './lib/runner-config.js';
+export { tableAlignmentSchema, tableColumnObjectSchema, tableColumnPrimitiveSchema, tableRowObjectSchema, tableRowPrimitiveSchema, tableSchema, type Table, type TableAlignment, type TableColumnObject, type TableColumnPrimitive, type TableRowObject, type TableRowPrimitive, } from './lib/table.js';
+export { uploadConfigSchema, type UploadConfig } from './lib/upload-config.js';

package/src/index.js

@@ -1,7 +1,7 @@
 export { tableCellValueSchema, } from './lib/implementation/schemas.js';
 export { sourceFileLocationSchema, } from './lib/source.js';
-export { auditSchema } from './lib/audit.js';
 export { auditDetailsSchema, auditOutputSchema, auditOutputsSchema, } from './lib/audit-output.js';
+export { auditSchema } from './lib/audit.js';
 export { categoryConfigSchema, categoryRefSchema, } from './lib/category-config.js';
 export { commitSchema } from './lib/commit.js';
 export { coreConfigSchema } from './lib/core-config.js';
@@ -9,14 +9,14 @@ export { groupRefSchema, groupSchema, } from './lib/group.js';
 export { CONFIG_FILE_NAME, SUPPORTED_CONFIG_FILE_FORMATS, } from './lib/implementation/configuration.js';
 export { DEFAULT_PERSIST_FILENAME, DEFAULT_PERSIST_FORMAT, DEFAULT_PERSIST_OUTPUT_DIR, } from './lib/implementation/constants.js';
 export { MAX_DESCRIPTION_LENGTH, MAX_ISSUE_MESSAGE_LENGTH, MAX_SLUG_LENGTH, MAX_TITLE_LENGTH, } from './lib/implementation/limits.js';
-export { materialIconSchema, } from './lib/implementation/schemas.js';
+export { fileNameSchema, filePathSchema, materialIconSchema, } from './lib/implementation/schemas.js';
 export { exists } from './lib/implementation/utils.js';
-export { tableAlignmentSchema, tableRowPrimitiveSchema, tableRowObjectSchema, tableColumnPrimitiveSchema, tableColumnObjectSchema, tableSchema, } from './lib/table.js';
 export { issueSchema, issueSeveritySchema, } from './lib/issue.js';
 export { formatSchema, persistConfigSchema, } from './lib/persist-config.js';
 export { pluginConfigSchema, pluginMetaSchema, } from './lib/plugin-config.js';
 export { auditReportSchema, pluginReportSchema, reportSchema, } from './lib/report.js';
 export { auditDiffSchema, auditResultSchema, categoryDiffSchema, categoryResultSchema, groupDiffSchema, groupResultSchema, reportsDiffSchema, } from './lib/reports-diff.js';
-export { onProgressSchema, runnerConfigSchema, runnerFunctionSchema, } from './lib/runner-config.js';
+export { onProgressSchema, runnerConfigSchema, runnerFunctionSchema, runnerFilesPathsSchema, } from './lib/runner-config.js';
+export { tableAlignmentSchema, tableColumnObjectSchema, tableColumnPrimitiveSchema, tableRowObjectSchema, tableRowPrimitiveSchema, tableSchema, } from './lib/table.js';
 export { uploadConfigSchema } from './lib/upload-config.js';
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/models/src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,oBAAoB,GACrB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAEL,wBAAwB,GACzB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAc,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAIL,kBAAkB,EAClB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAGL,oBAAoB,EACpB,iBAAiB,GAClB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAe,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAmB,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACzE,OAAO,EAIL,cAAc,EACd,WAAW,GACZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,gBAAgB,EAChB,6BAA6B,GAC9B,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACL,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,GAC3B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,eAAe,EACf,gBAAgB,GACjB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAEL,kBAAkB,GACnB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EAEL,oBAAoB,EAEpB,uBAAuB,EAEvB,oBAAoB,EAEpB,0BAA0B,EAE1B,uBAAuB,EAEvB,WAAW,GACZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAGL,WAAW,EACX,mBAAmB,GACpB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAGL,YAAY,EACZ,mBAAmB,GACpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAGL,kBAAkB,EAClB,gBAAgB,GACjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAIL,iBAAiB,EACjB,kBAAkB,EAClB,YAAY,GACb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAQL,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAIL,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAqB,kBAAkB,EAAE,MAAM,wBAAwB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/models/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,oBAAoB,EACpB,iBAAiB,GAGlB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,YAAY,EAAe,MAAM,iBAAiB,CAAC;AAC5D,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,wBAAwB,EACxB,sBAAsB,EACtB,0BAA0B,GAC3B,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,eAAe,EACf,gBAAgB,GACjB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,cAAc,EACd,cAAc,EACd,kBAAkB,GAEnB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,+BAA+B,CAAC;AACvD,OAAO,EACL,WAAW,EACX,mBAAmB,GAGpB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,YAAY,EACZ,mBAAmB,GAGpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,kBAAkB,EAClB,gBAAgB,GAGjB,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,oBAAoB,EACpB,sBAAsB,GAKvB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,oBAAoB,EACpB,uBAAuB,EACvB,0BAA0B,EAC1B,oBAAoB,EACpB,uBAAuB,EACvB,WAAW,GAOZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAqB,MAAM,wBAAwB,CAAC"}

package/src/lib/audit-output.d.ts

@@ -167,6 +167,14 @@ export declare const auditDetailsSchema: z.ZodObject<{
         }[] | undefined;
     } | undefined;
 }>;
+/**
+ * Type Definition: `AuditDetails`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `AuditDetails` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#auditdetails}
+ */
 export type AuditDetails = z.infer<typeof auditDetailsSchema>;
 export declare const auditOutputSchema: z.ZodObject<{
     slug: z.ZodString;
@@ -406,6 +414,14 @@ export declare const auditOutputSchema: z.ZodObject<{
         } | undefined;
     } | undefined;
 }>;
+/**
+ * Type Definition: `AuditOutput`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `AuditOutput` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#auditoutput}
+ */
 export type AuditOutput = z.infer<typeof auditOutputSchema>;
 export declare const auditOutputsSchema: z.ZodEffects<z.ZodArray<z.ZodObject<{
     slug: z.ZodString;
@@ -711,4 +727,12 @@ export declare const auditOutputsSchema: z.ZodEffects<z.ZodArray<z.ZodObject<{
         } | undefined;
     } | undefined;
 }[]>;
+/**
+ * Type Definition: `AuditOutputs`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `AuditOutputs` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#auditoutputs}
+ */
 export type AuditOutputs = z.infer<typeof auditOutputsSchema>;

package/src/lib/audit.d.ts

@@ -5,17 +5,28 @@ export declare const auditSchema: z.ZodObject<z.objectUtil.extendShape<{
     title: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
     docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>;
+    isSkipped: z.ZodOptional<z.ZodBoolean>;
 }>, "strip", z.ZodTypeAny, {
     slug: string;
     title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
+    isSkipped?: boolean | undefined;
 }, {
     slug: string;
     title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
+    isSkipped?: boolean | undefined;
 }>;
+/**
+ * Type Definition: `Audit`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `Audit` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#audit}
+ */
 export type Audit = z.infer<typeof auditSchema>;
 export declare const pluginAuditsSchema: z.ZodEffects<z.ZodArray<z.ZodObject<z.objectUtil.extendShape<{
     slug: z.ZodString;
@@ -23,24 +34,29 @@ export declare const pluginAuditsSchema: z.ZodEffects<z.ZodArray<z.ZodObject<z.o
     title: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
     docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>;
+    isSkipped: z.ZodOptional<z.ZodBoolean>;
 }>, "strip", z.ZodTypeAny, {
     slug: string;
     title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
+    isSkipped?: boolean | undefined;
 }, {
     slug: string;
     title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
+    isSkipped?: boolean | undefined;
 }>, "many">, {
     slug: string;
     title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
+    isSkipped?: boolean | undefined;
 }[], {
     slug: string;
     title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
+    isSkipped?: boolean | undefined;
 }[]>;

package/src/lib/audit.js

@@ -10,6 +10,7 @@ export const auditSchema = z
     descriptionDescription: 'Description (markdown)',
     docsUrlDescription: 'Link to documentation (rationale)',
     description: 'List of scorable metrics for the given plugin',
+    isSkippedDescription: 'Indicates whether the audit is skipped',
 }));
 export const pluginAuditsSchema = z
     .array(auditSchema, {

package/src/lib/audit.js.map

@@ -1 +1 @@
-{"version":3,"file":"audit.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/audit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAE5E,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KACzB,MAAM,CAAC;IACN,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,2BAA2B,CAAC;CACvD,CAAC;KACD,KAAK,CACJ,UAAU,CAAC;IACT,gBAAgB,EAAE,kBAAkB;IACpC,sBAAsB,EAAE,wBAAwB;IAChD,kBAAkB,EAAE,mCAAmC;IACvD,WAAW,EAAE,+CAA+C;CAC7D,CAAC,CACH,CAAC;AAGJ,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,KAAK,CAAC,WAAW,EAAE;IAClB,WAAW,EAAE,uCAAuC;CACrD,CAAC;KACD,GAAG,CAAC,CAAC,CAAC;IACP,yBAAyB;KACxB,MAAM,CACL,aAAa,CAAC,EAAE,CAAC,CAAC,yBAAyB,CAAC,aAAa,CAAC,EAC1D,aAAa,CAAC,EAAE,CAAC,CAAC;IAChB,OAAO,EAAE,8BAA8B,CAAC,aAAa,CAAC;CACvD,CAAC,CACH,CAAC;AAEJ,0BAA0B;AAE1B,+CAA+C;AAC/C,SAAS,8BAA8B,CAAC,MAAe;IACrD,MAAM,aAAa,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAC;IACxD,OAAO,wDAAwD,UAAU,CACvE,aAAa,CACd,EAAE,CAAC;AACN,CAAC;AAED,SAAS,yBAAyB,CAAC,MAAe;IAChD,OAAO,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;AAC7D,CAAC"}
+{"version":3,"file":"audit.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/audit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAE5E,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KACzB,MAAM,CAAC;IACN,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,2BAA2B,CAAC;CACvD,CAAC;KACD,KAAK,CACJ,UAAU,CAAC;IACT,gBAAgB,EAAE,kBAAkB;IACpC,sBAAsB,EAAE,wBAAwB;IAChD,kBAAkB,EAAE,mCAAmC;IACvD,WAAW,EAAE,+CAA+C;IAC5D,oBAAoB,EAAE,wCAAwC;CAC/D,CAAC,CACH,CAAC;AAGJ,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,KAAK,CAAC,WAAW,EAAE;IAClB,WAAW,EAAE,uCAAuC;CACrD,CAAC;KACD,GAAG,CAAC,CAAC,CAAC;IACP,yBAAyB;KACxB,MAAM,CACL,aAAa,CAAC,EAAE,CAAC,CAAC,yBAAyB,CAAC,aAAa,CAAC,EAC1D,aAAa,CAAC,EAAE,CAAC,CAAC;IAChB,OAAO,EAAE,8BAA8B,CAAC,aAAa,CAAC;CACvD,CAAC,CACH,CAAC;AAEJ,0BAA0B;AAE1B,+CAA+C;AAC/C,SAAS,8BAA8B,CAAC,MAAe;IACrD,MAAM,aAAa,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAC;IACxD,OAAO,wDAAwD,UAAU,CACvE,aAAa,CACd,EAAE,CAAC;AACN,CAAC;AAED,SAAS,yBAAyB,CAAC,MAAe;IAChD,OAAO,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;AAC7D,CAAC"}

package/src/lib/category-config.d.ts

@@ -16,6 +16,14 @@ export declare const categoryRefSchema: z.ZodObject<z.objectUtil.extendShape<{
     type: "audit" | "group";
     plugin: string;
 }>;
+/**
+ * Type Definition: `CategoryRef`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `CategoryRef` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#categoryref}
+ */
 export type CategoryRef = z.infer<typeof categoryRefSchema>;
 export declare const categoryConfigSchema: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
     slug: z.ZodString;
@@ -60,6 +68,7 @@ export declare const categoryConfigSchema: z.ZodObject<z.objectUtil.extendShape<
     title: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
     docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>;
+    isSkipped: z.ZodOptional<z.ZodBoolean>;
 }>, {
     isBinary: z.ZodOptional<z.ZodBoolean>;
 }>, "strip", z.ZodTypeAny, {
@@ -73,6 +82,7 @@ export declare const categoryConfigSchema: z.ZodObject<z.objectUtil.extendShape<
     title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
+    isSkipped?: boolean | undefined;
     isBinary?: boolean | undefined;
 }, {
     slug: string;
@@ -85,8 +95,17 @@ export declare const categoryConfigSchema: z.ZodObject<z.objectUtil.extendShape<
     title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
+    isSkipped?: boolean | undefined;
     isBinary?: boolean | undefined;
 }>;
+/**
+ * Type Definition: `CategoryConfig`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `CategoryConfig` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#categoryconfig}
+ */
 export type CategoryConfig = z.infer<typeof categoryConfigSchema>;
 export declare function duplicateRefsInCategoryMetricsErrorMsg(metrics: CategoryRef[]): string;
 export declare const categoriesSchema: z.ZodEffects<z.ZodArray<z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
@@ -132,6 +151,7 @@ export declare const categoriesSchema: z.ZodEffects<z.ZodArray<z.ZodObject<z.obj
     title: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
     docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>;
+    isSkipped: z.ZodOptional<z.ZodBoolean>;
 }>, {
     isBinary: z.ZodOptional<z.ZodBoolean>;
 }>, "strip", z.ZodTypeAny, {
@@ -145,6 +165,7 @@ export declare const categoriesSchema: z.ZodEffects<z.ZodArray<z.ZodObject<z.obj
     title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
+    isSkipped?: boolean | undefined;
     isBinary?: boolean | undefined;
 }, {
     slug: string;
@@ -157,6 +178,7 @@ export declare const categoriesSchema: z.ZodEffects<z.ZodArray<z.ZodObject<z.obj
     title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
+    isSkipped?: boolean | undefined;
     isBinary?: boolean | undefined;
 }>, "many">, {
     slug: string;
@@ -169,6 +191,7 @@ export declare const categoriesSchema: z.ZodEffects<z.ZodArray<z.ZodObject<z.obj
     title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
+    isSkipped?: boolean | undefined;
     isBinary?: boolean | undefined;
 }[], {
     slug: string;
@@ -181,5 +204,6 @@ export declare const categoriesSchema: z.ZodEffects<z.ZodArray<z.ZodObject<z.obj
     title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
+    isSkipped?: boolean | undefined;
     isBinary?: boolean | undefined;
 }[]>;

package/src/lib/commit.d.ts

@@ -15,4 +15,12 @@ export declare const commitSchema: z.ZodObject<{
     hash: string;
     author: string;
 }>;
+/**
+ * Type Definition: `Commit`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `Commit` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#commit}
+ */
 export type Commit = z.infer<typeof commitSchema>;