@code-pushup/models 0.26.1 → 0.28.0

package/index.js

@@ -84,6 +84,9 @@ var descriptionSchema = z.string({ description: "Description (markdown)" }).max(
 var urlSchema = z.string().url();
 var docsUrlSchema = urlSchema.optional().or(z.literal("")).describe("Documentation site");
 var titleSchema = z.string({ description: "Descriptive name" }).max(MAX_TITLE_LENGTH);
+var scoreSchema = z.number({
+  description: "Value between 0 and 1"
+}).min(0).max(1);
 function metaSchema(options) {
   const {
     descriptionDescription,
@@ -215,6 +218,8 @@ var issueSchema = z3.object(
 );
 
 // packages/models/src/lib/audit-output.ts
+var auditValueSchema = nonnegativeIntSchema.describe("Raw numeric value");
+var auditDisplayValueSchema = z4.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional();
 var auditDetailsSchema = z4.object(
   {
     issues: z4.array(issueSchema, { description: "List of findings" })
@@ -224,11 +229,9 @@ var auditDetailsSchema = z4.object(
 var auditOutputSchema = z4.object(
   {
     slug: slugSchema.describe("Reference to audit"),
-    displayValue: z4.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional(),
-    value: nonnegativeIntSchema.describe("Raw numeric value"),
-    score: z4.number({
-      description: "Value between 0 and 1"
-    }).min(0).max(1),
+    displayValue: auditDisplayValueSchema,
+    value: auditValueSchema,
+    score: scoreSchema,
     details: auditDetailsSchema.optional()
   },
   { description: "Audit information" }
@@ -493,9 +496,9 @@ var CONFIG_FILE_NAME = "code-pushup.config";
 var SUPPORTED_CONFIG_FILE_FORMATS = ["ts", "mjs", "js"];
 
 // packages/models/src/lib/implementation/constants.ts
-var PERSIST_OUTPUT_DIR = ".code-pushup";
-var PERSIST_FORMAT = ["json"];
-var PERSIST_FILENAME = "report";
+var DEFAULT_PERSIST_OUTPUT_DIR = ".code-pushup";
+var DEFAULT_PERSIST_FILENAME = "report";
+var DEFAULT_PERSIST_FORMAT = ["json", "md"];
 
 // packages/models/src/lib/report.ts
 import { z as z13 } from "zod";
@@ -559,28 +562,124 @@ var reportSchema = packageVersionSchema({
     )
   })
 );
+
+// packages/models/src/lib/reports-diff.ts
+import { z as z14 } from "zod";
+function makeComparisonSchema(schema) {
+  const sharedDescription = schema.description || "Result";
+  return z14.object({
+    before: schema.describe(`${sharedDescription} (source commit)`),
+    after: schema.describe(`${sharedDescription} (target commit)`)
+  });
+}
+function makeArraysComparisonSchema(diffSchema, resultSchema, description) {
+  return z14.object(
+    {
+      changed: z14.array(diffSchema),
+      unchanged: z14.array(resultSchema),
+      added: z14.array(resultSchema),
+      removed: z14.array(resultSchema)
+    },
+    { description }
+  );
+}
+var scorableMetaSchema = z14.object({ slug: slugSchema, title: titleSchema });
+var scorableWithPluginMetaSchema = scorableMetaSchema.merge(
+  z14.object({
+    plugin: pluginMetaSchema.pick({ slug: true, title: true }).describe("Plugin which defines it")
+  })
+);
+var scorableDiffSchema = scorableMetaSchema.merge(
+  z14.object({
+    scores: makeComparisonSchema(scoreSchema).merge(
+      z14.object({
+        diff: z14.number().min(-1).max(1).describe("Score change (`scores.after - scores.before`)")
+      })
+    ).describe("Score comparison")
+  })
+);
+var scorableWithPluginDiffSchema = scorableDiffSchema.merge(
+  scorableWithPluginMetaSchema
+);
+var categoryDiffSchema = scorableDiffSchema;
+var groupDiffSchema = scorableWithPluginDiffSchema;
+var auditDiffSchema = scorableWithPluginDiffSchema.merge(
+  z14.object({
+    values: makeComparisonSchema(auditValueSchema).merge(
+      z14.object({
+        diff: z14.number().int().describe("Value change (`values.after - values.before`)")
+      })
+    ).describe("Audit `value` comparison"),
+    displayValues: makeComparisonSchema(auditDisplayValueSchema).describe(
+      "Audit `displayValue` comparison"
+    )
+  })
+);
+var categoryResultSchema = scorableMetaSchema.merge(
+  z14.object({ score: scoreSchema })
+);
+var groupResultSchema = scorableWithPluginMetaSchema.merge(
+  z14.object({ score: scoreSchema })
+);
+var auditResultSchema = scorableWithPluginMetaSchema.merge(
+  auditOutputSchema.pick({ score: true, value: true, displayValue: true })
+);
+var reportsDiffSchema = z14.object({
+  commits: makeComparisonSchema(commitSchema).nullable().describe("Commits identifying compared reports"),
+  categories: makeArraysComparisonSchema(
+    categoryDiffSchema,
+    categoryResultSchema,
+    "Changes affecting categories"
+  ),
+  groups: makeArraysComparisonSchema(
+    groupDiffSchema,
+    groupResultSchema,
+    "Changes affecting groups"
+  ),
+  audits: makeArraysComparisonSchema(
+    auditDiffSchema,
+    auditResultSchema,
+    "Changes affecting audits"
+  )
+}).merge(
+  packageVersionSchema({
+    versionDescription: "NPM version of the CLI (when `compare` was run)",
+    required: true
+  })
+).merge(
+  executionMetaSchema({
+    descriptionDate: "Start date and time of the compare run",
+    descriptionDuration: "Duration of the compare run in ms"
+  })
+);
 export {
   CONFIG_FILE_NAME,
+  DEFAULT_PERSIST_FILENAME,
+  DEFAULT_PERSIST_FORMAT,
+  DEFAULT_PERSIST_OUTPUT_DIR,
   MAX_DESCRIPTION_LENGTH,
   MAX_ISSUE_MESSAGE_LENGTH,
   MAX_SLUG_LENGTH,
   MAX_TITLE_LENGTH,
-  PERSIST_FILENAME,
-  PERSIST_FORMAT,
-  PERSIST_OUTPUT_DIR,
   SUPPORTED_CONFIG_FILE_FORMATS,
   auditDetailsSchema,
+  auditDiffSchema,
   auditOutputSchema,
   auditOutputsSchema,
   auditReportSchema,
+  auditResultSchema,
   auditSchema,
   categoryConfigSchema,
+  categoryDiffSchema,
   categoryRefSchema,
+  categoryResultSchema,
   commitSchema,
   coreConfigSchema,
   exists,
   formatSchema,
+  groupDiffSchema,
   groupRefSchema,
+  groupResultSchema,
   groupSchema,
   issueSchema,
   issueSeveritySchema,
@@ -591,6 +690,7 @@ export {
   pluginMetaSchema,
   pluginReportSchema,
   reportSchema,
+  reportsDiffSchema,
   runnerConfigSchema,
   runnerFunctionSchema,
   uploadConfigSchema

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/models",
-  "version": "0.26.1",
+  "version": "0.28.0",
   "license": "MIT",
   "dependencies": {
     "zod": "^3.22.1",

package/src/index.d.ts

@@ -5,7 +5,7 @@ export { Commit, commitSchema } from './lib/commit';
 export { CoreConfig, coreConfigSchema } from './lib/core-config';
 export { Group, GroupRef, groupRefSchema, groupSchema } from './lib/group';
 export { CONFIG_FILE_NAME, SUPPORTED_CONFIG_FILE_FORMATS, } from './lib/implementation/configuration';
-export { PERSIST_FILENAME, PERSIST_FORMAT, PERSIST_OUTPUT_DIR, } from './lib/implementation/constants';
+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 { MaterialIcon, materialIconSchema } from './lib/implementation/schemas';
 export { exists } from './lib/implementation/utils';
@@ -13,5 +13,6 @@ export { Issue, IssueSeverity, issueSchema, issueSeveritySchema, } from './lib/i
 export { Format, PersistConfig, formatSchema, persistConfigSchema, } from './lib/persist-config';
 export { PluginConfig, PluginMeta, pluginConfigSchema, pluginMetaSchema, } from './lib/plugin-config';
 export { AuditReport, PluginReport, Report, auditReportSchema, pluginReportSchema, reportSchema, } from './lib/report';
+export { AuditDiff, AuditResult, CategoryDiff, CategoryResult, GroupDiff, GroupResult, ReportsDiff, auditDiffSchema, auditResultSchema, categoryDiffSchema, categoryResultSchema, groupDiffSchema, groupResultSchema, reportsDiffSchema, } from './lib/reports-diff';
 export { OnProgress, RunnerConfig, RunnerFunction, onProgressSchema, runnerConfigSchema, runnerFunctionSchema, } from './lib/runner-config';
 export { UploadConfig, uploadConfigSchema } from './lib/upload-config';

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

@@ -1,4 +1,6 @@
 import { z } from 'zod';
+export declare const auditValueSchema: z.ZodNumber;
+export declare const auditDisplayValueSchema: z.ZodOptional<z.ZodString>;
 export declare const auditDetailsSchema: z.ZodObject<{
     issues: z.ZodArray<z.ZodObject<{
         message: z.ZodString;

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

@@ -1,4 +1,4 @@
 import { Format } from '../persist-config';
-export declare const PERSIST_OUTPUT_DIR = ".code-pushup";
-export declare const PERSIST_FORMAT: Format[];
-export declare const PERSIST_FILENAME = "report";
+export declare const DEFAULT_PERSIST_OUTPUT_DIR = ".code-pushup";
+export declare const DEFAULT_PERSIST_FILENAME = "report";
+export declare const DEFAULT_PERSIST_FORMAT: Format[];

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

@@ -24,6 +24,8 @@ export declare const urlSchema: ZodString;
 export declare const docsUrlSchema: z.ZodUnion<[ZodOptional<ZodString>, z.ZodLiteral<"">]>;
 /** Schema for a title of a plugin, category and audit */
 export declare const titleSchema: ZodString;
+/** Schema for score of audit, category or group */
+export declare const scoreSchema: z.ZodNumber;
 /**
  * Used for categories, plugins and audits
  * @param options