@code-pushup/models 0.111.1 → 0.113.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/models",
-  "version": "0.111.1",
+  "version": "0.113.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/lib/audit-output.d.ts

@@ -58,6 +58,14 @@ export declare const auditDetailsSchema: z.ZodObject<{
         root: z.ZodType<import("./tree.js").CoverageTreeNode, unknown, z.core.$ZodTypeInternals<import("./tree.js").CoverageTreeNode, unknown>>;
     }, z.core.$strip>]>>>;
 }, z.core.$strip>;
+/**
+ * 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;
@@ -123,6 +131,14 @@ export declare const auditOutputSchema: z.ZodObject<{
         }, z.core.$strip>]>>>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
+/**
+ * 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.ZodArray<z.ZodObject<{
     slug: z.ZodString;
@@ -188,4 +204,12 @@ export declare const auditOutputsSchema: z.ZodArray<z.ZodObject<{
         }, z.core.$strip>]>>>;
     }, z.core.$strip>>;
 }, z.core.$strip>>;
+/**
+ * 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

@@ -6,6 +6,14 @@ export declare const auditSchema: z.ZodObject<{
     docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
     isSkipped: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
+/**
+ * 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.ZodArray<z.ZodObject<{
     slug: z.ZodString;

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

@@ -3,11 +3,35 @@ export declare const cacheConfigObjectSchema: z.ZodObject<{
     read: z.ZodDefault<z.ZodBoolean>;
     write: z.ZodDefault<z.ZodBoolean>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `CacheConfigObject`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `CacheConfigObject` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#cacheconfigobject}
+ */
 export type CacheConfigObject = z.infer<typeof cacheConfigObjectSchema>;
 export declare const cacheConfigShorthandSchema: z.ZodBoolean;
+/**
+ * Type Definition: `CacheConfigShorthand`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `CacheConfigShorthand` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#cacheconfigshorthand}
+ */
 export type CacheConfigShorthand = z.infer<typeof cacheConfigShorthandSchema>;
 export declare const cacheConfigSchema: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
     read: z.ZodDefault<z.ZodBoolean>;
     write: z.ZodDefault<z.ZodBoolean>;
 }, z.core.$strip>]>>;
+/**
+ * Type Definition: `CacheConfig`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `CacheConfig` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#cacheconfig}
+ */
 export type CacheConfig = z.infer<typeof cacheConfigSchema>;

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

@@ -8,6 +8,14 @@ export declare const categoryRefSchema: z.ZodObject<{
     }>;
     plugin: z.ZodString;
 }, z.core.$strip>;
+/**
+ * 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<{
     slug: z.ZodString;
@@ -26,6 +34,14 @@ export declare const categoryConfigSchema: z.ZodObject<{
     isSkipped: z.ZodOptional<z.ZodBoolean>;
     scoreTarget: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
+/**
+ * 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 const categoriesSchema: z.ZodArray<z.ZodObject<{
     slug: z.ZodString;

package/src/lib/commit.d.ts

@@ -5,4 +5,12 @@ export declare const commitSchema: z.ZodObject<{
     date: z.ZodCoercedDate<unknown>;
     author: z.ZodString;
 }, z.core.$strip>;
+/**
+ * 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>;

package/src/lib/configuration.d.ts

@@ -13,4 +13,12 @@ export declare const pluginArtifactOptionsSchema: z.ZodObject<{
     }, z.core.$strip>]>>;
     artifactsPaths: z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `PluginArtifactOptions`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `PluginArtifactOptions` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#pluginartifactoptions}
+ */
 export type PluginArtifactOptions = z.infer<typeof pluginArtifactOptionsSchema>;

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

@@ -3583,4 +3583,12 @@ export declare function refineCoreConfig(schema: typeof unrefinedCoreConfigSchem
         scoreTarget: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>>>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `CoreConfig`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `CoreConfig` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#coreconfig}
+ */
 export type CoreConfig = z.infer<typeof coreConfigSchema>;

package/src/lib/group.d.ts

@@ -3,6 +3,14 @@ export declare const groupRefSchema: z.ZodObject<{
     slug: z.ZodString;
     weight: z.ZodNumber;
 }, z.core.$strip>;
+/**
+ * Type Definition: `GroupRef`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `GroupRef` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#groupref}
+ */
 export type GroupRef = z.infer<typeof groupRefSchema>;
 export declare const groupMetaSchema: z.ZodObject<{
     title: z.ZodString;
@@ -10,6 +18,14 @@ export declare const groupMetaSchema: z.ZodObject<{
     docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
     isSkipped: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `GroupMeta`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `GroupMeta` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#groupmeta}
+ */
 export type GroupMeta = z.infer<typeof groupMetaSchema>;
 export declare const groupSchema: z.ZodObject<{
     slug: z.ZodString;
@@ -22,6 +38,14 @@ export declare const groupSchema: z.ZodObject<{
     docsUrl: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodCatch<z.ZodOptional<z.ZodURL>>]>>;
     isSkipped: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `Group`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `Group` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#group}
+ */
 export type Group = z.infer<typeof groupSchema>;
 export declare const groupsSchema: z.ZodOptional<z.ZodArray<z.ZodObject<{
     slug: z.ZodString;

package/src/lib/implementation/schemas.d.ts

@@ -1,5 +1,13 @@
 import { type ZodObject, type ZodOptional, type ZodString, z } from 'zod';
 export declare const tableCellValueSchema: z.ZodDefault<z.ZodUnion<readonly [ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>;
+/**
+ * Type Definition: `TableCellValue`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `TableCellValue` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tablecellvalue}
+ */
 export type TableCellValue = z.infer<typeof tableCellValueSchema>;
 /**
  * Schema for execution meta date
@@ -63,6 +71,14 @@ export declare function weightedRefSchema(description: string, slugDescription:
     slug: ZodString;
     weight: z.ZodNumber;
 }, z.core.$strip>;
+/**
+ * Type Definition: `WeightedRef`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `WeightedRef` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#weightedref}
+ */
 export type WeightedRef = z.infer<ReturnType<typeof weightedRefSchema>>;
 export declare function scorableSchema<T extends ReturnType<typeof weightedRefSchema>>(description: string, refSchema: T, duplicateCheckFn: z.core.CheckFn<z.infer<T>[]>): ZodObject<{
     slug: ZodString;
@@ -928,6 +944,14 @@ export declare const materialIconSchema: z.ZodEnum<{
     nodejs_alt: "nodejs_alt";
     silverstripe: "silverstripe";
 }>;
+/**
+ * Type Definition: `MaterialIcon`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `MaterialIcon` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#materialicon}
+ */
 export type MaterialIcon = z.infer<typeof materialIconSchema>;
 export declare const filePositionSchema: ZodObject<{
     startLine: z.ZodNumber;

package/src/lib/implementation/validate.d.ts

@@ -1,10 +1,26 @@
 import { ZodError, type ZodType, z } from 'zod';
+/**
+ * Type Definition: `SchemaValidationContext`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `SchemaValidationContext` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#schemavalidationcontext}
+ */
 type SchemaValidationContext = {
     filePath?: string;
 };
 /**
  * Autocompletes valid Zod Schema input for convience, but will accept any other data as well
  */
+/**
+ * Type Definition: `ZodInputLooseAutocomplete`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `ZodInputLooseAutocomplete` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#zodinputlooseautocomplete}
+ */
 type ZodInputLooseAutocomplete<T extends ZodType> = z.input<T> | {} | null | undefined;
 export declare class SchemaValidationError extends Error {
     constructor(error: ZodError, schema: ZodType, { filePath }: SchemaValidationContext);

package/src/lib/issue.d.ts

@@ -4,6 +4,14 @@ export declare const issueSeveritySchema: z.ZodEnum<{
     info: "info";
     warning: "warning";
 }>;
+/**
+ * Type Definition: `IssueSeverity`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `IssueSeverity` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#issueseverity}
+ */
 export type IssueSeverity = z.infer<typeof issueSeveritySchema>;
 export declare const issueSchema: z.ZodObject<{
     message: z.ZodString;
@@ -26,6 +34,14 @@ export declare const issueSchema: z.ZodObject<{
         selector: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>]>>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `Issue`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `Issue` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#issue}
+ */
 export type Issue = z.infer<typeof issueSchema>;
 export declare const fileIssueSchema: z.ZodObject<{
     message: z.ZodString;
@@ -44,6 +60,14 @@ export declare const fileIssueSchema: z.ZodObject<{
         }, z.core.$strip>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `FileIssue`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `FileIssue` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#fileissue}
+ */
 export type FileIssue = z.infer<typeof fileIssueSchema>;
 export declare const urlIssueSchema: z.ZodObject<{
     message: z.ZodString;
@@ -58,4 +82,12 @@ export declare const urlIssueSchema: z.ZodObject<{
         selector: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `UrlIssue`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `UrlIssue` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#urlissue}
+ */
 export type UrlIssue = z.infer<typeof urlIssueSchema>;

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

@@ -3,6 +3,14 @@ export declare const formatSchema: z.ZodEnum<{
     json: "json";
     md: "md";
 }>;
+/**
+ * Type Definition: `Format`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `Format` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#format}
+ */
 export type Format = z.infer<typeof formatSchema>;
 export declare const persistConfigSchema: z.ZodObject<{
     outputDir: z.ZodOptional<z.ZodString>;
@@ -13,4 +21,12 @@ export declare const persistConfigSchema: z.ZodObject<{
     }>>>;
     skipReports: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `PersistConfig`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `PersistConfig` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#persistconfig}
+ */
 export type PersistConfig = z.infer<typeof persistConfigSchema>;

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

@@ -2,6 +2,14 @@ import { z } from 'zod';
 import { type Audit } from './audit.js';
 import { type Group } from './group.js';
 export declare const pluginContextSchema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+/**
+ * Type Definition: `PluginContext`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `PluginContext` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#plugincontext}
+ */
 export type PluginContext = z.infer<typeof pluginContextSchema>;
 export declare const pluginMetaSchema: z.ZodObject<{
     packageName: z.ZodOptional<z.ZodString>;
@@ -872,8 +880,24 @@ export declare const pluginMetaSchema: z.ZodObject<{
         silverstripe: "silverstripe";
     }>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `PluginMeta`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `PluginMeta` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#pluginmeta}
+ */
 export type PluginMeta = z.infer<typeof pluginMetaSchema>;
 export declare const pluginScoreTargetsSchema: z.ZodOptional<z.ZodUnion<readonly [z.ZodOptional<z.ZodNumber>, z.ZodRecord<z.ZodString, z.ZodNonOptional<z.ZodOptional<z.ZodNumber>>>]>>;
+/**
+ * Type Definition: `PluginScoreTargets`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `PluginScoreTargets` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#pluginscoretargets}
+ */
 export type PluginScoreTargets = z.infer<typeof pluginScoreTargetsSchema>;
 export declare const pluginDataSchema: z.ZodObject<{
     runner: z.ZodUnion<readonly [z.ZodObject<{
@@ -2324,8 +2348,24 @@ export declare const pluginConfigSchema: z.ZodObject<{
     scoreTargets: z.ZodOptional<z.ZodUnion<readonly [z.ZodOptional<z.ZodNumber>, z.ZodRecord<z.ZodString, z.ZodNonOptional<z.ZodOptional<z.ZodNumber>>>]>>;
     context: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `PluginConfig`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `PluginConfig` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#pluginconfig}
+ */
 export type PluginConfig = z.infer<typeof pluginConfigSchema>;
 export declare const pluginUrlsSchema: z.ZodUnion<readonly [z.ZodURL, z.ZodArray<z.ZodURL>, z.ZodRecord<z.ZodURL, z.ZodNumber>]>;
+/**
+ * Type Definition: `PluginUrls`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `PluginUrls` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#pluginurls}
+ */
 export type PluginUrls = z.infer<typeof pluginUrlsSchema>;
 export declare function findMissingSlugsInGroupRefs<T extends {
     audits: Audit[];

package/src/lib/report.d.ts

@@ -67,6 +67,14 @@ export declare const auditReportSchema: z.ZodObject<{
         }, z.core.$strip>]>>>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `AuditReport`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `AuditReport` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#auditreport}
+ */
 export type AuditReport = z.infer<typeof auditReportSchema>;
 export declare const pluginReportSchema: z.ZodObject<{
     packageName: z.ZodOptional<z.ZodString>;
@@ -1018,6 +1026,14 @@ export declare const pluginReportSchema: z.ZodObject<{
         isSkipped: z.ZodOptional<z.ZodBoolean>;
     }, z.core.$strip>>>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `PluginReport`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `PluginReport` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#pluginreport}
+ */
 export type PluginReport = z.infer<typeof pluginReportSchema>;
 export declare const reportSchema: z.ZodObject<{
     packageName: z.ZodString;
@@ -1999,4 +2015,12 @@ export declare const reportSchema: z.ZodObject<{
     }, z.core.$strip>>;
     label: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `Report`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `Report` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#report}
+ */
 export type Report = z.infer<typeof reportSchema>;

package/src/lib/reports-diff.d.ts

@@ -78,11 +78,59 @@ export declare const auditResultSchema: z.ZodObject<{
     displayValue: z.ZodOptional<z.ZodString>;
     score: z.ZodNumber;
 }, z.core.$strip>;
+/**
+ * Type Definition: `CategoryDiff`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `CategoryDiff` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#categorydiff}
+ */
 export type CategoryDiff = z.infer<typeof categoryDiffSchema>;
+/**
+ * Type Definition: `GroupDiff`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `GroupDiff` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#groupdiff}
+ */
 export type GroupDiff = z.infer<typeof groupDiffSchema>;
+/**
+ * Type Definition: `AuditDiff`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `AuditDiff` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#auditdiff}
+ */
 export type AuditDiff = z.infer<typeof auditDiffSchema>;
+/**
+ * Type Definition: `CategoryResult`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `CategoryResult` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#categoryresult}
+ */
 export type CategoryResult = z.infer<typeof categoryResultSchema>;
+/**
+ * Type Definition: `GroupResult`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `GroupResult` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#groupresult}
+ */
 export type GroupResult = z.infer<typeof groupResultSchema>;
+/**
+ * Type Definition: `AuditResult`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `AuditResult` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#auditresult}
+ */
 export type AuditResult = z.infer<typeof auditResultSchema>;
 export declare const reportsDiffSchema: z.ZodObject<{
     commits: z.ZodNullable<z.ZodObject<{
@@ -251,4 +299,12 @@ export declare const reportsDiffSchema: z.ZodObject<{
     date: z.ZodString;
     duration: z.ZodNumber;
 }, z.core.$strip>;
+/**
+ * Type Definition: `ReportsDiff`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `ReportsDiff` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#reportsdiff}
+ */
 export type ReportsDiff = z.infer<typeof reportsDiffSchema>;

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

@@ -126,6 +126,14 @@ export declare const outputTransformSchema: z.ZodPipe<z.ZodCustom<unknown, unkno
         }, z.core.$strip>]>>>;
     }, z.core.$strip>>;
 }, z.core.$strip>>>]>>, unknown>>;
+/**
+ * Type Definition: `OutputTransform`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `OutputTransform` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#outputtransform}
+ */
 export type OutputTransform = z.infer<typeof outputTransformSchema>;
 export declare const runnerArgsSchema: z.ZodObject<{
     persist: z.ZodObject<{
@@ -138,6 +146,14 @@ export declare const runnerArgsSchema: z.ZodObject<{
         skipReports: z.ZodNonOptional<z.ZodOptional<z.ZodBoolean>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `RunnerArgs`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `RunnerArgs` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#runnerargs}
+ */
 export type RunnerArgs = z.infer<typeof runnerArgsSchema>;
 export declare const runnerConfigSchema: z.ZodObject<{
     command: z.ZodString;
@@ -272,6 +288,14 @@ export declare const runnerConfigSchema: z.ZodObject<{
     }, z.core.$strip>>>]>>, unknown>>>;
     configFile: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `RunnerConfig`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `RunnerConfig` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#runnerconfig}
+ */
 export type RunnerConfig = z.infer<typeof runnerConfigSchema>;
 export declare const runnerFunctionSchema: z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [z.ZodObject<{
     persist: z.ZodObject<{
@@ -410,9 +434,25 @@ export declare const runnerFunctionSchema: z.ZodPipe<z.ZodCustom<unknown, unknow
         }, z.core.$strip>]>>>;
     }, z.core.$strip>>;
 }, z.core.$strip>>>]>>, unknown>>;
+/**
+ * Type Definition: `RunnerFunction`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `RunnerFunction` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#runnerfunction}
+ */
 export type RunnerFunction = z.infer<typeof runnerFunctionSchema>;
 export declare const runnerFilesPathsSchema: z.ZodObject<{
     runnerConfigPath: z.ZodString;
     runnerOutputPath: z.ZodString;
 }, z.core.$strip>;
+/**
+ * Type Definition: `RunnerFilesPaths`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `RunnerFilesPaths` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#runnerfilespaths}
+ */
 export type RunnerFilesPaths = z.infer<typeof runnerFilesPathsSchema>;

package/src/lib/source.d.ts

@@ -8,12 +8,28 @@ export declare const sourceFileLocationSchema: z.ZodObject<{
         endColumn: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `SourceFileLocation`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `SourceFileLocation` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#sourcefilelocation}
+ */
 export type SourceFileLocation = z.infer<typeof sourceFileLocationSchema>;
 export declare const sourceUrlLocationSchema: z.ZodObject<{
     url: z.ZodURL;
     snippet: z.ZodOptional<z.ZodString>;
     selector: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `SourceUrlLocation`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `SourceUrlLocation` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#sourceurllocation}
+ */
 export type SourceUrlLocation = z.infer<typeof sourceUrlLocationSchema>;
 export declare const issueSourceSchema: z.ZodUnion<readonly [z.ZodObject<{
     file: z.ZodString;
@@ -28,4 +44,12 @@ export declare const issueSourceSchema: z.ZodUnion<readonly [z.ZodObject<{
     snippet: z.ZodOptional<z.ZodString>;
     selector: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>]>;
+/**
+ * Type Definition: `IssueSource`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `IssueSource` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#issuesource}
+ */
 export type IssueSource = z.infer<typeof issueSourceSchema>;

package/src/lib/table.d.ts

@@ -4,12 +4,28 @@ export declare const tableAlignmentSchema: z.ZodEnum<{
     center: "center";
     right: "right";
 }>;
+/**
+ * Type Definition: `TableAlignment`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `TableAlignment` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tablealignment}
+ */
 export type TableAlignment = z.infer<typeof tableAlignmentSchema>;
 export declare const tableColumnPrimitiveSchema: z.ZodEnum<{
     left: "left";
     center: "center";
     right: "right";
 }>;
+/**
+ * Type Definition: `TableColumnPrimitive`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `TableColumnPrimitive` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tablecolumnprimitive}
+ */
 export type TableColumnPrimitive = z.infer<typeof tableColumnPrimitiveSchema>;
 export declare const tableColumnObjectSchema: z.ZodObject<{
     key: z.ZodString;
@@ -20,10 +36,34 @@ export declare const tableColumnObjectSchema: z.ZodObject<{
         right: "right";
     }>>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `TableColumnObject`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `TableColumnObject` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tablecolumnobject}
+ */
 export type TableColumnObject = z.infer<typeof tableColumnObjectSchema>;
 export declare const tableRowObjectSchema: z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+/**
+ * Type Definition: `TableRowObject`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `TableRowObject` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tablerowobject}
+ */
 export type TableRowObject = z.infer<typeof tableRowObjectSchema>;
 export declare const tableRowPrimitiveSchema: z.ZodArray<z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+/**
+ * Type Definition: `TableRowPrimitive`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `TableRowPrimitive` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tablerowprimitive}
+ */
 export type TableRowPrimitive = z.infer<typeof tableRowPrimitiveSchema>;
 export declare const tableSchema: (description?: string) => z.ZodUnion<readonly [z.ZodObject<{
     title: z.ZodOptional<z.ZodString>;
@@ -50,4 +90,12 @@ export declare const tableSchema: (description?: string) => z.ZodUnion<readonly
     }, z.core.$strip>>]>>;
     rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>>;
 }, z.core.$strip>]>;
+/**
+ * Type Definition: `Table`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `Table` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#table}
+ */
 export type Table = z.infer<ReturnType<typeof tableSchema>>;

package/src/lib/tree.d.ts

@@ -4,6 +4,14 @@ declare const basicTreeNodeDataSchema: z.ZodObject<{
     values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
 }, z.core.$strip>;
 export declare const basicTreeNodeSchema: z.ZodType<BasicTreeNode>;
+/**
+ * Type Definition: `BasicTreeNode`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `BasicTreeNode` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#basictreenode}
+ */
 export type BasicTreeNode = z.infer<typeof basicTreeNodeDataSchema> & {
     children?: BasicTreeNode[];
 };
@@ -15,6 +23,14 @@ export declare const coverageTreeMissingLOCSchema: z.ZodObject<{
     name: z.ZodOptional<z.ZodString>;
     kind: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `CoverageTreeMissingLOC`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `CoverageTreeMissingLOC` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#coveragetreemissingloc}
+ */
 export type CoverageTreeMissingLOC = z.infer<typeof coverageTreeMissingLOCSchema>;
 declare const coverageTreeNodeDataSchema: z.ZodObject<{
     name: z.ZodString;
@@ -31,6 +47,14 @@ declare const coverageTreeNodeDataSchema: z.ZodObject<{
     }, z.core.$strip>;
 }, z.core.$strip>;
 export declare const coverageTreeNodeSchema: z.ZodType<CoverageTreeNode>;
+/**
+ * Type Definition: `CoverageTreeNode`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `CoverageTreeNode` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#coveragetreenode}
+ */
 export type CoverageTreeNode = z.infer<typeof coverageTreeNodeDataSchema> & {
     children?: CoverageTreeNode[];
 };
@@ -39,12 +63,28 @@ export declare const basicTreeSchema: z.ZodObject<{
     type: z.ZodOptional<z.ZodLiteral<"basic">>;
     root: z.ZodType<BasicTreeNode, unknown, z.core.$ZodTypeInternals<BasicTreeNode, unknown>>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `BasicTree`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `BasicTree` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#basictree}
+ */
 export type BasicTree = z.infer<typeof basicTreeSchema>;
 export declare const coverageTreeSchema: z.ZodObject<{
     title: z.ZodOptional<z.ZodString>;
     type: z.ZodLiteral<"coverage">;
     root: z.ZodType<CoverageTreeNode, unknown, z.core.$ZodTypeInternals<CoverageTreeNode, unknown>>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `CoverageTree`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `CoverageTree` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#coveragetree}
+ */
 export type CoverageTree = z.infer<typeof coverageTreeSchema>;
 export declare const treeSchema: z.ZodUnion<readonly [z.ZodObject<{
     title: z.ZodOptional<z.ZodString>;
@@ -55,5 +95,13 @@ export declare const treeSchema: z.ZodUnion<readonly [z.ZodObject<{
     type: z.ZodLiteral<"coverage">;
     root: z.ZodType<CoverageTreeNode, unknown, z.core.$ZodTypeInternals<CoverageTreeNode, unknown>>;
 }, z.core.$strip>]>;
+/**
+ * Type Definition: `Tree`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `Tree` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tree}
+ */
 export type Tree = z.infer<typeof treeSchema>;
 export {};

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

@@ -6,4 +6,12 @@ export declare const uploadConfigSchema: z.ZodObject<{
     project: z.ZodString;
     timeout: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `UploadConfig`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `UploadConfig` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#uploadconfig}
+ */
 export type UploadConfig = z.infer<typeof uploadConfigSchema>;