@code-pushup/models 0.56.0 → 0.58.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/models",
-  "version": "0.56.0",
+  "version": "0.58.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",
@@ -26,10 +26,11 @@
     "access": "public"
   },
   "type": "module",
-  "main": "./index.js",
-  "types": "./src/index.d.ts",
   "dependencies": {
     "zod": "^3.22.1",
     "vscode-material-icons": "^0.1.0"
-  }
-}
+  },
+  "module": "./src/index.js",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts"
+}

package/src/index.d.ts

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

@@ -0,0 +1,22 @@
+export { tableCellValueSchema, } from './lib/implementation/schemas.js';
+export { sourceFileLocationSchema, } from './lib/source.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';
+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 { fileNameSchema, filePathSchema, materialIconSchema, } from './lib/implementation/schemas.js';
+export { exists } from './lib/implementation/utils.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, 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

@@ -0,0 +1 @@
+{"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-output.js

@@ -0,0 +1,37 @@
+import { z } from 'zod';
+import { nonnegativeNumberSchema, scoreSchema, slugSchema, } from './implementation/schemas.js';
+import { errorItems, hasDuplicateStrings } from './implementation/utils.js';
+import { issueSchema } from './issue.js';
+import { tableSchema } from './table.js';
+export const auditValueSchema = nonnegativeNumberSchema.describe('Raw numeric value');
+export const auditDisplayValueSchema = z
+    .string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" })
+    .optional();
+export const auditDetailsSchema = z.object({
+    issues: z
+        .array(issueSchema, { description: 'List of findings' })
+        .optional(),
+    table: tableSchema('Table of related findings').optional(),
+}, { description: 'Detailed information' });
+export const auditOutputSchema = z.object({
+    slug: slugSchema.describe('Reference to audit'),
+    displayValue: auditDisplayValueSchema,
+    value: auditValueSchema,
+    score: scoreSchema,
+    details: auditDetailsSchema.optional(),
+}, { description: 'Audit information' });
+export const auditOutputsSchema = z
+    .array(auditOutputSchema, {
+    description: 'List of JSON formatted audit output emitted by the runner process of a plugin',
+})
+    // audit slugs are unique
+    .refine(audits => !getDuplicateSlugsInAudits(audits), audits => ({ message: duplicateSlugsInAuditsErrorMsg(audits) }));
+// helper for validator: audit slugs are unique
+function duplicateSlugsInAuditsErrorMsg(audits) {
+    const duplicateRefs = getDuplicateSlugsInAudits(audits);
+    return `In plugin audits the slugs are not unique: ${errorItems(duplicateRefs)}`;
+}
+function getDuplicateSlugsInAudits(audits) {
+    return hasDuplicateStrings(audits.map(({ slug }) => slug));
+}
+//# sourceMappingURL=audit-output.js.map

package/src/lib/audit-output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audit-output.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/audit-output.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,uBAAuB,EACvB,WAAW,EACX,UAAU,GACX,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,CAAC,MAAM,gBAAgB,GAC3B,uBAAuB,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;AACxD,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC;KACrC,MAAM,CAAC,EAAE,WAAW,EAAE,0CAA0C,EAAE,CAAC;KACnE,QAAQ,EAAE,CAAC;AAEd,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CACxC;IACE,MAAM,EAAE,CAAC;SACN,KAAK,CAAC,WAAW,EAAE,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;SACvD,QAAQ,EAAE;IACb,KAAK,EAAE,WAAW,CAAC,2BAA2B,CAAC,CAAC,QAAQ,EAAE;CAC3D,EACD,EAAE,WAAW,EAAE,sBAAsB,EAAE,CACxC,CAAC;AAGF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CACvC;IACE,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,oBAAoB,CAAC;IAC/C,YAAY,EAAE,uBAAuB;IACrC,KAAK,EAAE,gBAAgB;IACvB,KAAK,EAAE,WAAW;IAClB,OAAO,EAAE,kBAAkB,CAAC,QAAQ,EAAE;CACvC,EACD,EAAE,WAAW,EAAE,mBAAmB,EAAE,CACrC,CAAC;AAIF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,KAAK,CAAC,iBAAiB,EAAE;IACxB,WAAW,EACT,+EAA+E;CAClF,CAAC;IACF,yBAAyB;KACxB,MAAM,CACL,MAAM,CAAC,EAAE,CAAC,CAAC,yBAAyB,CAAC,MAAM,CAAC,EAC5C,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,8BAA8B,CAAC,MAAM,CAAC,EAAE,CAAC,CAChE,CAAC;AAGJ,+CAA+C;AAC/C,SAAS,8BAA8B,CAAC,MAAqB;IAC3D,MAAM,aAAa,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAC;IACxD,OAAO,8CAA8C,UAAU,CAC7D,aAAa,CACd,EAAE,CAAC;AACN,CAAC;AAED,SAAS,yBAAyB,CAAC,MAAqB;IACtD,OAAO,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;AAC7D,CAAC"}

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

@@ -0,0 +1,33 @@
+import { z } from 'zod';
+import { metaSchema, slugSchema } from './implementation/schemas.js';
+import { errorItems, hasDuplicateStrings } from './implementation/utils.js';
+export const auditSchema = z
+    .object({
+    slug: slugSchema.describe('ID (unique within plugin)'),
+})
+    .merge(metaSchema({
+    titleDescription: 'Descriptive name',
+    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, {
+    description: 'List of audits maintained in a plugin',
+})
+    .min(1)
+    // audit slugs are unique
+    .refine(auditMetadata => !getDuplicateSlugsInAudits(auditMetadata), auditMetadata => ({
+    message: duplicateSlugsInAuditsErrorMsg(auditMetadata),
+}));
+// =======================
+// helper for validator: audit slugs are unique
+function duplicateSlugsInAuditsErrorMsg(audits) {
+    const duplicateRefs = getDuplicateSlugsInAudits(audits);
+    return `In plugin audits the following slugs are not unique: ${errorItems(duplicateRefs)}`;
+}
+function getDuplicateSlugsInAudits(audits) {
+    return hasDuplicateStrings(audits.map(({ slug }) => slug));
+}
+//# sourceMappingURL=audit.js.map

package/src/lib/audit.js.map

@@ -0,0 +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;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/category-config.js

@@ -0,0 +1,47 @@
+import { z } from 'zod';
+import { metaSchema, scorableSchema, slugSchema, weightedRefSchema, } from './implementation/schemas.js';
+import { errorItems, hasDuplicateStrings } from './implementation/utils.js';
+export const categoryRefSchema = weightedRefSchema('Weighted references to audits and/or groups for the category', 'Slug of an audit or group (depending on `type`)').merge(z.object({
+    type: z.enum(['audit', 'group'], {
+        description: 'Discriminant for reference kind, affects where `slug` is looked up',
+    }),
+    plugin: slugSchema.describe('Plugin slug (plugin should contain referenced audit or group)'),
+}));
+export const categoryConfigSchema = scorableSchema('Category with a score calculated from audits and groups from various plugins', categoryRefSchema, getDuplicateRefsInCategoryMetrics, duplicateRefsInCategoryMetricsErrorMsg)
+    .merge(metaSchema({
+    titleDescription: 'Category Title',
+    docsUrlDescription: 'Category docs URL',
+    descriptionDescription: 'Category description',
+    description: 'Meta info for category',
+}))
+    .merge(z.object({
+    isBinary: z
+        .boolean({
+        description: 'Is this a binary category (i.e. only a perfect score considered a "pass")?',
+    })
+        .optional(),
+}));
+// helper for validator: categories have unique refs to audits or groups
+export function duplicateRefsInCategoryMetricsErrorMsg(metrics) {
+    const duplicateRefs = getDuplicateRefsInCategoryMetrics(metrics);
+    return `In the categories, the following audit or group refs are duplicates: ${errorItems(duplicateRefs)}`;
+}
+function getDuplicateRefsInCategoryMetrics(metrics) {
+    return hasDuplicateStrings(metrics.map(({ slug, type, plugin }) => `${type} :: ${plugin} / ${slug}`));
+}
+export const categoriesSchema = z
+    .array(categoryConfigSchema, {
+    description: 'Categorization of individual audits',
+})
+    .refine(categoryCfg => !getDuplicateSlugCategories(categoryCfg), categoryCfg => ({
+    message: duplicateSlugCategoriesErrorMsg(categoryCfg),
+}));
+// helper for validator: categories slugs are unique
+function duplicateSlugCategoriesErrorMsg(categories) {
+    const duplicateStringSlugs = getDuplicateSlugCategories(categories);
+    return `In the categories, the following slugs are duplicated: ${errorItems(duplicateStringSlugs)}`;
+}
+function getDuplicateSlugCategories(categories) {
+    return hasDuplicateStrings(categories.map(({ slug }) => slug));
+}
+//# sourceMappingURL=category-config.js.map

package/src/lib/category-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"category-config.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/category-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,UAAU,EACV,cAAc,EACd,UAAU,EACV,iBAAiB,GAClB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAE5E,MAAM,CAAC,MAAM,iBAAiB,GAAG,iBAAiB,CAChD,8DAA8D,EAC9D,iDAAiD,CAClD,CAAC,KAAK,CACL,CAAC,CAAC,MAAM,CAAC;IACP,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE;QAC/B,WAAW,EACT,oEAAoE;KACvE,CAAC;IACF,MAAM,EAAE,UAAU,CAAC,QAAQ,CACzB,+DAA+D,CAChE;CACF,CAAC,CACH,CAAC;AAGF,MAAM,CAAC,MAAM,oBAAoB,GAAG,cAAc,CAChD,8EAA8E,EAC9E,iBAAiB,EACjB,iCAAiC,EACjC,sCAAsC,CACvC;KACE,KAAK,CACJ,UAAU,CAAC;IACT,gBAAgB,EAAE,gBAAgB;IAClC,kBAAkB,EAAE,mBAAmB;IACvC,sBAAsB,EAAE,sBAAsB;IAC9C,WAAW,EAAE,wBAAwB;CACtC,CAAC,CACH;KACA,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;IACP,QAAQ,EAAE,CAAC;SACR,OAAO,CAAC;QACP,WAAW,EACT,4EAA4E;KAC/E,CAAC;SACD,QAAQ,EAAE;CACd,CAAC,CACH,CAAC;AAIJ,wEAAwE;AACxE,MAAM,UAAU,sCAAsC,CAAC,OAAsB;IAC3E,MAAM,aAAa,GAAG,iCAAiC,CAAC,OAAO,CAAC,CAAC;IACjE,OAAO,wEAAwE,UAAU,CACvF,aAAa,CACd,EAAE,CAAC;AACN,CAAC;AAED,SAAS,iCAAiC,CAAC,OAAsB;IAC/D,OAAO,mBAAmB,CACxB,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,GAAG,IAAI,OAAO,MAAM,MAAM,IAAI,EAAE,CAAC,CAC1E,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,KAAK,CAAC,oBAAoB,EAAE;IAC3B,WAAW,EAAE,qCAAqC;CACnD,CAAC;KACD,MAAM,CACL,WAAW,CAAC,EAAE,CAAC,CAAC,0BAA0B,CAAC,WAAW,CAAC,EACvD,WAAW,CAAC,EAAE,CAAC,CAAC;IACd,OAAO,EAAE,+BAA+B,CAAC,WAAW,CAAC;CACtD,CAAC,CACH,CAAC;AAEJ,oDAAoD;AACpD,SAAS,+BAA+B,CAAC,UAA4B;IACnE,MAAM,oBAAoB,GAAG,0BAA0B,CAAC,UAAU,CAAC,CAAC;IACpE,OAAO,0DAA0D,UAAU,CACzE,oBAAoB,CACrB,EAAE,CAAC;AACN,CAAC;AAED,SAAS,0BAA0B,CAAC,UAA4B;IAC9D,OAAO,mBAAmB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;AACjE,CAAC"}

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>;

package/src/lib/commit.js

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+export const commitSchema = z.object({
+    hash: z
+        .string({ description: 'Commit SHA (full)' })
+        .regex(/^[\da-f]{40}$/, 'Commit SHA should be a 40-character hexadecimal string'),
+    message: z.string({ description: 'Commit message' }),
+    date: z.coerce.date({
+        description: 'Date and time when commit was authored',
+    }),
+    author: z
+        .string({
+        description: 'Commit author name',
+    })
+        .trim(),
+}, { description: 'Git commit' });
+//# sourceMappingURL=commit.js.map

package/src/lib/commit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commit.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/commit.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAClC;IACE,IAAI,EAAE,CAAC;SACJ,MAAM,CAAC,EAAE,WAAW,EAAE,mBAAmB,EAAE,CAAC;SAC5C,KAAK,CACJ,eAAe,EACf,wDAAwD,CACzD;IACH,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC;IACpD,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;QAClB,WAAW,EAAE,wCAAwC;KACtD,CAAC;IACF,MAAM,EAAE,CAAC;SACN,MAAM,CAAC;QACN,WAAW,EAAE,oBAAoB;KAClC,CAAC;SACD,IAAI,EAAE;CACV,EACD,EAAE,WAAW,EAAE,YAAY,EAAE,CAC9B,CAAC"}