@code-pushup/models 0.50.0 → 0.51.0

package/index.js

@@ -155,9 +155,27 @@ function hasNonZeroWeightedRef(refs) {
   return refs.reduce((acc, { weight }) => weight + acc, 0) !== 0;
 }
 
-// packages/models/src/lib/audit.ts
+// packages/models/src/lib/source.ts
 import { z as z2 } from "zod";
-var auditSchema = z2.object({
+var sourceFileLocationSchema = z2.object(
+  {
+    file: filePathSchema.describe("Relative path to source file in Git repo"),
+    position: z2.object(
+      {
+        startLine: positiveIntSchema.describe("Start line"),
+        startColumn: positiveIntSchema.describe("Start column").optional(),
+        endLine: positiveIntSchema.describe("End line").optional(),
+        endColumn: positiveIntSchema.describe("End column").optional()
+      },
+      { description: "Location in file" }
+    ).optional()
+  },
+  { description: "Source file location" }
+);
+
+// packages/models/src/lib/audit.ts
+import { z as z3 } from "zod";
+var auditSchema = z3.object({
   slug: slugSchema.describe("ID (unique within plugin)")
 }).merge(
   metaSchema({
@@ -167,7 +185,7 @@ var auditSchema = z2.object({
     description: "List of scorable metrics for the given plugin"
   })
 );
-var pluginAuditsSchema = z2.array(auditSchema, {
+var pluginAuditsSchema = z3.array(auditSchema, {
   description: "List of audits maintained in a plugin"
 }).min(1).refine(
   (auditMetadata) => !getDuplicateSlugsInAudits(auditMetadata),
@@ -186,31 +204,16 @@ function getDuplicateSlugsInAudits(audits) {
 }
 
 // packages/models/src/lib/audit-output.ts
-import { z as z5 } from "zod";
+import { z as z6 } from "zod";
 
 // packages/models/src/lib/issue.ts
-import { z as z3 } from "zod";
-var sourceFileLocationSchema = z3.object(
-  {
-    file: filePathSchema.describe("Relative path to source file in Git repo"),
-    position: z3.object(
-      {
-        startLine: positiveIntSchema.describe("Start line"),
-        startColumn: positiveIntSchema.describe("Start column").optional(),
-        endLine: positiveIntSchema.describe("End line").optional(),
-        endColumn: positiveIntSchema.describe("End column").optional()
-      },
-      { description: "Location in file" }
-    ).optional()
-  },
-  { description: "Source file location" }
-);
-var issueSeveritySchema = z3.enum(["info", "warning", "error"], {
+import { z as z4 } from "zod";
+var issueSeveritySchema = z4.enum(["info", "warning", "error"], {
   description: "Severity level"
 });
-var issueSchema = z3.object(
+var issueSchema = z4.object(
   {
-    message: z3.string({ description: "Descriptive error message" }).max(MAX_ISSUE_MESSAGE_LENGTH),
+    message: z4.string({ description: "Descriptive error message" }).max(MAX_ISSUE_MESSAGE_LENGTH),
     severity: issueSeveritySchema,
     source: sourceFileLocationSchema.optional()
   },
@@ -218,61 +221,61 @@ var issueSchema = z3.object(
 );
 
 // packages/models/src/lib/table.ts
-import { z as z4 } from "zod";
-var tableAlignmentSchema = z4.enum(["left", "center", "right"], {
+import { z as z5 } from "zod";
+var tableAlignmentSchema = z5.enum(["left", "center", "right"], {
   description: "Cell alignment"
 });
 var tableColumnPrimitiveSchema = tableAlignmentSchema;
-var tableColumnObjectSchema = z4.object({
-  key: z4.string(),
-  label: z4.string().optional(),
+var tableColumnObjectSchema = z5.object({
+  key: z5.string(),
+  label: z5.string().optional(),
   align: tableAlignmentSchema.optional()
 });
-var tableRowObjectSchema = z4.record(tableCellValueSchema, {
+var tableRowObjectSchema = z5.record(tableCellValueSchema, {
   description: "Object row"
 });
-var tableRowPrimitiveSchema = z4.array(tableCellValueSchema, {
+var tableRowPrimitiveSchema = z5.array(tableCellValueSchema, {
   description: "Primitive row"
 });
-var tableSharedSchema = z4.object({
-  title: z4.string().optional().describe("Display title for table")
+var tableSharedSchema = z5.object({
+  title: z5.string().optional().describe("Display title for table")
 });
 var tablePrimitiveSchema = tableSharedSchema.merge(
-  z4.object(
+  z5.object(
     {
-      columns: z4.array(tableAlignmentSchema).optional(),
-      rows: z4.array(tableRowPrimitiveSchema)
+      columns: z5.array(tableAlignmentSchema).optional(),
+      rows: z5.array(tableRowPrimitiveSchema)
     },
     { description: "Table with primitive rows and optional alignment columns" }
   )
 );
 var tableObjectSchema = tableSharedSchema.merge(
-  z4.object(
+  z5.object(
     {
-      columns: z4.union([
-        z4.array(tableAlignmentSchema),
-        z4.array(tableColumnObjectSchema)
+      columns: z5.union([
+        z5.array(tableAlignmentSchema),
+        z5.array(tableColumnObjectSchema)
       ]).optional(),
-      rows: z4.array(tableRowObjectSchema)
+      rows: z5.array(tableRowObjectSchema)
     },
     {
       description: "Table with object rows and optional alignment or object columns"
     }
   )
 );
-var tableSchema = (description = "Table information") => z4.union([tablePrimitiveSchema, tableObjectSchema], { description });
+var tableSchema = (description = "Table information") => z5.union([tablePrimitiveSchema, tableObjectSchema], { description });
 
 // packages/models/src/lib/audit-output.ts
 var auditValueSchema = nonnegativeNumberSchema.describe("Raw numeric value");
-var auditDisplayValueSchema = z5.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional();
-var auditDetailsSchema = z5.object(
+var auditDisplayValueSchema = z6.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional();
+var auditDetailsSchema = z6.object(
   {
-    issues: z5.array(issueSchema, { description: "List of findings" }).optional(),
+    issues: z6.array(issueSchema, { description: "List of findings" }).optional(),
     table: tableSchema("Table of related findings").optional()
   },
   { description: "Detailed information" }
 );
-var auditOutputSchema = z5.object(
+var auditOutputSchema = z6.object(
   {
     slug: slugSchema.describe("Reference to audit"),
     displayValue: auditDisplayValueSchema,
@@ -282,7 +285,7 @@ var auditOutputSchema = z5.object(
   },
   { description: "Audit information" }
 );
-var auditOutputsSchema = z5.array(auditOutputSchema, {
+var auditOutputsSchema = z6.array(auditOutputSchema, {
   description: "List of JSON formatted audit output emitted by the runner process of a plugin"
 }).refine(
   (audits) => !getDuplicateSlugsInAudits2(audits),
@@ -299,13 +302,13 @@ function getDuplicateSlugsInAudits2(audits) {
 }
 
 // packages/models/src/lib/category-config.ts
-import { z as z6 } from "zod";
+import { z as z7 } from "zod";
 var categoryRefSchema = weightedRefSchema(
   "Weighted references to audits and/or groups for the category",
   "Slug of an audit or group (depending on `type`)"
 ).merge(
-  z6.object({
-    type: z6.enum(["audit", "group"], {
+  z7.object({
+    type: z7.enum(["audit", "group"], {
       description: "Discriminant for reference kind, affects where `slug` is looked up"
     }),
     plugin: slugSchema.describe(
@@ -326,8 +329,8 @@ var categoryConfigSchema = scorableSchema(
     description: "Meta info for category"
   })
 ).merge(
-  z6.object({
-    isBinary: z6.boolean({
+  z7.object({
+    isBinary: z7.boolean({
       description: 'Is this a binary category (i.e. only a perfect score considered a "pass")?'
     }).optional()
   })
@@ -343,7 +346,7 @@ function getDuplicateRefsInCategoryMetrics(metrics) {
     metrics.map(({ slug, type, plugin }) => `${type} :: ${plugin} / ${slug}`)
   );
 }
-var categoriesSchema = z6.array(categoryConfigSchema, {
+var categoriesSchema = z7.array(categoryConfigSchema, {
   description: "Categorization of individual audits"
 }).refine(
   (categoryCfg) => !getDuplicateSlugCategories(categoryCfg),
@@ -362,18 +365,18 @@ function getDuplicateSlugCategories(categories) {
 }
 
 // packages/models/src/lib/commit.ts
-import { z as z7 } from "zod";
-var commitSchema = z7.object(
+import { z as z8 } from "zod";
+var commitSchema = z8.object(
   {
-    hash: z7.string({ description: "Commit SHA (full)" }).regex(
+    hash: z8.string({ description: "Commit SHA (full)" }).regex(
       /^[\da-f]{40}$/,
       "Commit SHA should be a 40-character hexadecimal string"
     ),
-    message: z7.string({ description: "Commit message" }),
-    date: z7.coerce.date({
+    message: z8.string({ description: "Commit message" }),
+    date: z8.coerce.date({
       description: "Date and time when commit was authored"
     }),
-    author: z7.string({
+    author: z8.string({
       description: "Commit author name"
     }).trim()
   },
@@ -381,22 +384,22 @@ var commitSchema = z7.object(
 );
 
 // packages/models/src/lib/core-config.ts
-import { z as z13 } from "zod";
+import { z as z14 } from "zod";
 
 // packages/models/src/lib/persist-config.ts
-import { z as z8 } from "zod";
-var formatSchema = z8.enum(["json", "md"]);
-var persistConfigSchema = z8.object({
+import { z as z9 } from "zod";
+var formatSchema = z9.enum(["json", "md"]);
+var persistConfigSchema = z9.object({
   outputDir: filePathSchema.describe("Artifacts folder").optional(),
   filename: fileNameSchema.describe("Artifacts file name (without extension)").optional(),
-  format: z8.array(formatSchema).optional()
+  format: z9.array(formatSchema).optional()
 });
 
 // packages/models/src/lib/plugin-config.ts
-import { z as z11 } from "zod";
+import { z as z12 } from "zod";
 
 // packages/models/src/lib/group.ts
-import { z as z9 } from "zod";
+import { z as z10 } from "zod";
 var groupRefSchema = weightedRefSchema(
   "Weighted reference to a group",
   "Reference slug to a group within this plugin (e.g. 'max-lines')"
@@ -413,7 +416,7 @@ var groupSchema = scorableSchema(
   getDuplicateRefsInGroups,
   duplicateRefsInGroupsErrorMsg
 ).merge(groupMetaSchema);
-var groupsSchema = z9.array(groupSchema, {
+var groupsSchema = z10.array(groupSchema, {
   description: "List of groups"
 }).optional().refine(
   (groups) => !getDuplicateSlugsInGroups(groups),
@@ -441,14 +444,14 @@ function getDuplicateSlugsInGroups(groups) {
 }
 
 // packages/models/src/lib/runner-config.ts
-import { z as z10 } from "zod";
-var outputTransformSchema = z10.function().args(z10.unknown()).returns(z10.union([auditOutputsSchema, z10.promise(auditOutputsSchema)]));
-var runnerConfigSchema = z10.object(
+import { z as z11 } from "zod";
+var outputTransformSchema = z11.function().args(z11.unknown()).returns(z11.union([auditOutputsSchema, z11.promise(auditOutputsSchema)]));
+var runnerConfigSchema = z11.object(
   {
-    command: z10.string({
+    command: z11.string({
       description: "Shell command to execute"
     }),
-    args: z10.array(z10.string({ description: "Command arguments" })).optional(),
+    args: z11.array(z11.string({ description: "Command arguments" })).optional(),
     outputFile: filePathSchema.describe("Output path"),
     outputTransform: outputTransformSchema.optional()
   },
@@ -456,8 +459,8 @@ var runnerConfigSchema = z10.object(
     description: "How to execute runner"
   }
 );
-var onProgressSchema = z10.function().args(z10.unknown()).returns(z10.void());
-var runnerFunctionSchema = z10.function().args(onProgressSchema.optional()).returns(z10.union([auditOutputsSchema, z10.promise(auditOutputsSchema)]));
+var onProgressSchema = z11.function().args(z11.unknown()).returns(z11.void());
+var runnerFunctionSchema = z11.function().args(onProgressSchema.optional()).returns(z11.union([auditOutputsSchema, z11.promise(auditOutputsSchema)]));
 
 // packages/models/src/lib/plugin-config.ts
 var pluginMetaSchema = packageVersionSchema().merge(
@@ -468,13 +471,13 @@ var pluginMetaSchema = packageVersionSchema().merge(
     description: "Plugin metadata"
   })
 ).merge(
-  z11.object({
+  z12.object({
     slug: slugSchema.describe("Unique plugin slug within core config"),
     icon: materialIconSchema
   })
 );
-var pluginDataSchema = z11.object({
-  runner: z11.union([runnerConfigSchema, runnerFunctionSchema]),
+var pluginDataSchema = z12.object({
+  runner: z12.union([runnerConfigSchema, runnerFunctionSchema]),
   audits: pluginAuditsSchema,
   groups: groupsSchema
 });
@@ -500,22 +503,22 @@ function getMissingRefsFromGroups(pluginCfg) {
 }
 
 // packages/models/src/lib/upload-config.ts
-import { z as z12 } from "zod";
-var uploadConfigSchema = z12.object({
+import { z as z13 } from "zod";
+var uploadConfigSchema = z13.object({
   server: urlSchema.describe("URL of deployed portal API"),
-  apiKey: z12.string({
+  apiKey: z13.string({
     description: "API key with write access to portal (use `process.env` for security)"
   }),
   organization: slugSchema.describe(
     "Organization slug from Code PushUp portal"
   ),
   project: slugSchema.describe("Project slug from Code PushUp portal"),
-  timeout: z12.number({ description: "Request timeout in minutes (default is 5)" }).positive().int().optional()
+  timeout: z13.number({ description: "Request timeout in minutes (default is 5)" }).positive().int().optional()
 });
 
 // packages/models/src/lib/core-config.ts
-var unrefinedCoreConfigSchema = z13.object({
-  plugins: z13.array(pluginConfigSchema, {
+var unrefinedCoreConfigSchema = z14.object({
+  plugins: z14.array(pluginConfigSchema, {
     description: "List of plugins to be used (official, community-provided, or custom)"
   }).min(1),
   /** portal configuration for persisting results */
@@ -547,7 +550,7 @@ var DEFAULT_PERSIST_FILENAME = "report";
 var DEFAULT_PERSIST_FORMAT = ["json", "md"];
 
 // packages/models/src/lib/report.ts
-import { z as z14 } from "zod";
+import { z as z15 } from "zod";
 var auditReportSchema = auditSchema.merge(auditOutputSchema);
 var pluginReportSchema = pluginMetaSchema.merge(
   executionMetaSchema({
@@ -555,9 +558,9 @@ var pluginReportSchema = pluginMetaSchema.merge(
     descriptionDuration: "Duration of the plugin run in ms"
   })
 ).merge(
-  z14.object({
-    audits: z14.array(auditReportSchema).min(1),
-    groups: z14.array(groupSchema).optional()
+  z15.object({
+    audits: z15.array(auditReportSchema).min(1),
+    groups: z15.array(groupSchema).optional()
   })
 ).refine(
   (pluginReport) => !getMissingRefsFromGroups2(pluginReport.audits, pluginReport.groups ?? []),
@@ -591,10 +594,10 @@ var reportSchema = packageVersionSchema({
     descriptionDuration: "Duration of the collect run in ms"
   })
 ).merge(
-  z14.object(
+  z15.object(
     {
-      categories: z14.array(categoryConfigSchema),
-      plugins: z14.array(pluginReportSchema).min(1),
+      categories: z15.array(categoryConfigSchema),
+      plugins: z15.array(pluginReportSchema).min(1),
       commit: commitSchema.describe("Git commit for which report was collected").nullable()
     },
     { description: "Collect output data" }
@@ -610,40 +613,40 @@ var reportSchema = packageVersionSchema({
 );
 
 // packages/models/src/lib/reports-diff.ts
-import { z as z15 } from "zod";
+import { z as z16 } from "zod";
 function makeComparisonSchema(schema) {
   const sharedDescription = schema.description || "Result";
-  return z15.object({
+  return z16.object({
     before: schema.describe(`${sharedDescription} (source commit)`),
     after: schema.describe(`${sharedDescription} (target commit)`)
   });
 }
 function makeArraysComparisonSchema(diffSchema, resultSchema, description) {
-  return z15.object(
+  return z16.object(
     {
-      changed: z15.array(diffSchema),
-      unchanged: z15.array(resultSchema),
-      added: z15.array(resultSchema),
-      removed: z15.array(resultSchema)
+      changed: z16.array(diffSchema),
+      unchanged: z16.array(resultSchema),
+      added: z16.array(resultSchema),
+      removed: z16.array(resultSchema)
     },
     { description }
   );
 }
-var scorableMetaSchema = z15.object({
+var scorableMetaSchema = z16.object({
   slug: slugSchema,
   title: titleSchema,
   docsUrl: docsUrlSchema
 });
 var scorableWithPluginMetaSchema = scorableMetaSchema.merge(
-  z15.object({
+  z16.object({
     plugin: pluginMetaSchema.pick({ slug: true, title: true, docsUrl: true }).describe("Plugin which defines it")
   })
 );
 var scorableDiffSchema = scorableMetaSchema.merge(
-  z15.object({
+  z16.object({
     scores: makeComparisonSchema(scoreSchema).merge(
-      z15.object({
-        diff: z15.number().min(-1).max(1).describe("Score change (`scores.after - scores.before`)")
+      z16.object({
+        diff: z16.number().min(-1).max(1).describe("Score change (`scores.after - scores.before`)")
       })
     ).describe("Score comparison")
   })
@@ -654,10 +657,10 @@ var scorableWithPluginDiffSchema = scorableDiffSchema.merge(
 var categoryDiffSchema = scorableDiffSchema;
 var groupDiffSchema = scorableWithPluginDiffSchema;
 var auditDiffSchema = scorableWithPluginDiffSchema.merge(
-  z15.object({
+  z16.object({
     values: makeComparisonSchema(auditValueSchema).merge(
-      z15.object({
-        diff: z15.number().int().describe("Value change (`values.after - values.before`)")
+      z16.object({
+        diff: z16.number().int().describe("Value change (`values.after - values.before`)")
       })
     ).describe("Audit `value` comparison"),
     displayValues: makeComparisonSchema(auditDisplayValueSchema).describe(
@@ -666,18 +669,18 @@ var auditDiffSchema = scorableWithPluginDiffSchema.merge(
   })
 );
 var categoryResultSchema = scorableMetaSchema.merge(
-  z15.object({ score: scoreSchema })
+  z16.object({ score: scoreSchema })
 );
 var groupResultSchema = scorableWithPluginMetaSchema.merge(
-  z15.object({ score: scoreSchema })
+  z16.object({ score: scoreSchema })
 );
 var auditResultSchema = scorableWithPluginMetaSchema.merge(
   auditOutputSchema.pick({ score: true, value: true, displayValue: true })
 );
-var reportsDiffSchema = z15.object({
+var reportsDiffSchema = z16.object({
   commits: makeComparisonSchema(commitSchema).nullable().describe("Commits identifying compared reports"),
   portalUrl: urlSchema.optional().describe("Link to comparison page in Code PushUp portal"),
-  label: z15.string().optional().describe("Label (e.g. project name)"),
+  label: z16.string().optional().describe("Label (e.g. project name)"),
   categories: makeArraysComparisonSchema(
     categoryDiffSchema,
     categoryResultSchema,
@@ -745,6 +748,7 @@ export {
   reportsDiffSchema,
   runnerConfigSchema,
   runnerFunctionSchema,
+  sourceFileLocationSchema,
   tableAlignmentSchema,
   tableCellValueSchema,
   tableColumnObjectSchema,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/models",
-  "version": "0.50.0",
+  "version": "0.51.0",
   "license": "MIT",
   "description": "Model definitions and validators for the Code PushUp CLI",
   "dependencies": {

package/src/index.d.ts

@@ -1,4 +1,5 @@
 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';

package/src/lib/source.d.ts

@@ -0,0 +1,37 @@
+import { z } from 'zod';
+export declare const sourceFileLocationSchema: z.ZodObject<{
+    file: z.ZodString;
+    position: z.ZodOptional<z.ZodObject<{
+        startLine: z.ZodNumber;
+        startColumn: z.ZodOptional<z.ZodNumber>;
+        endLine: z.ZodOptional<z.ZodNumber>;
+        endColumn: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        startLine: number;
+        startColumn?: number | undefined;
+        endLine?: number | undefined;
+        endColumn?: number | undefined;
+    }, {
+        startLine: number;
+        startColumn?: number | undefined;
+        endLine?: number | undefined;
+        endColumn?: number | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    file: string;
+    position?: {
+        startLine: number;
+        startColumn?: number | undefined;
+        endLine?: number | undefined;
+        endColumn?: number | undefined;
+    } | undefined;
+}, {
+    file: string;
+    position?: {
+        startLine: number;
+        startColumn?: number | undefined;
+        endLine?: number | undefined;
+        endColumn?: number | undefined;
+    } | undefined;
+}>;
+export type SourceFileLocation = z.infer<typeof sourceFileLocationSchema>;