@code-pushup/models 0.39.0 → 0.42.0

package/index.js

@@ -1,6 +1,3 @@
-// packages/models/src/lib/audit.ts
-import { z as z2 } from "zod";
-
 // packages/models/src/lib/implementation/schemas.ts
 import { MATERIAL_ICONS } from "vscode-material-icons";
 import { z } from "zod";
@@ -66,6 +63,7 @@ function missingRefsForCategoriesErrorMsg(categories, plugins) {
 }
 
 // packages/models/src/lib/implementation/schemas.ts
+var primitiveValueSchema = z.union([z.string(), z.number()]);
 function executionMetaSchema(options = {
   descriptionDate: "Execution start date and time",
   descriptionDuration: "Execution duration in ms"
@@ -157,6 +155,7 @@ function hasNonZeroWeightedRef(refs) {
 }
 
 // packages/models/src/lib/audit.ts
+import { z as z2 } from "zod";
 var auditSchema = z2.object({
   slug: slugSchema.describe("ID (unique within plugin)")
 }).merge(
@@ -186,7 +185,7 @@ function getDuplicateSlugsInAudits(audits) {
 }
 
 // packages/models/src/lib/audit-output.ts
-import { z as z4 } from "zod";
+import { z as z5 } from "zod";
 
 // packages/models/src/lib/issue.ts
 import { z as z3 } from "zod";
@@ -217,16 +216,62 @@ var issueSchema = z3.object(
   { description: "Issue information" }
 );
 
+// packages/models/src/lib/table.ts
+import { z as z4 } from "zod";
+var tableAlignmentSchema = z4.enum(["left", "center", "right"], {
+  description: "Cell alignment"
+});
+var tableColumnPrimitiveSchema = tableAlignmentSchema;
+var tableColumnObjectSchema = z4.object({
+  key: z4.string(),
+  label: z4.string().optional(),
+  align: tableAlignmentSchema.optional()
+});
+var tableRowObjectSchema = z4.record(primitiveValueSchema, {
+  description: "Object row"
+});
+var tableRowPrimitiveSchema = z4.array(primitiveValueSchema, {
+  description: "Primitive row"
+});
+var tableSharedSchema = z4.object({
+  title: z4.string().optional().describe("Display title for table")
+});
+var tablePrimitiveSchema = tableSharedSchema.merge(
+  z4.object(
+    {
+      columns: z4.array(tableAlignmentSchema).optional(),
+      rows: z4.array(tableRowPrimitiveSchema)
+    },
+    { description: "Table with primitive rows and optional alignment columns" }
+  )
+);
+var tableObjectSchema = tableSharedSchema.merge(
+  z4.object(
+    {
+      columns: z4.union([
+        z4.array(tableAlignmentSchema),
+        z4.array(tableColumnObjectSchema)
+      ]).optional(),
+      rows: z4.array(tableRowObjectSchema)
+    },
+    {
+      description: "Table with object rows and optional alignment or object columns"
+    }
+  )
+);
+var tableSchema = (description = "Table information") => z4.union([tablePrimitiveSchema, tableObjectSchema], { description });
+
 // 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(
+var auditDisplayValueSchema = z5.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional();
+var auditDetailsSchema = z5.object(
   {
-    issues: z4.array(issueSchema, { description: "List of findings" })
+    issues: z5.array(issueSchema, { description: "List of findings" }).optional(),
+    table: tableSchema("Table of related findings").optional()
   },
   { description: "Detailed information" }
 );
-var auditOutputSchema = z4.object(
+var auditOutputSchema = z5.object(
   {
     slug: slugSchema.describe("Reference to audit"),
     displayValue: auditDisplayValueSchema,
@@ -236,7 +281,7 @@ var auditOutputSchema = z4.object(
   },
   { description: "Audit information" }
 );
-var auditOutputsSchema = z4.array(auditOutputSchema, {
+var auditOutputsSchema = z5.array(auditOutputSchema, {
   description: "List of JSON formatted audit output emitted by the runner process of a plugin"
 }).refine(
   (audits) => !getDuplicateSlugsInAudits2(audits),
@@ -253,13 +298,13 @@ function getDuplicateSlugsInAudits2(audits) {
 }
 
 // packages/models/src/lib/category-config.ts
-import { z as z5 } from "zod";
+import { z as z6 } 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(
-  z5.object({
-    type: z5.enum(["audit", "group"], {
+  z6.object({
+    type: z6.enum(["audit", "group"], {
       description: "Discriminant for reference kind, affects where `slug` is looked up"
     }),
     plugin: slugSchema.describe(
@@ -280,8 +325,8 @@ var categoryConfigSchema = scorableSchema(
     description: "Meta info for category"
   })
 ).merge(
-  z5.object({
-    isBinary: z5.boolean({
+  z6.object({
+    isBinary: z6.boolean({
       description: 'Is this a binary category (i.e. only a perfect score considered a "pass")?'
     }).optional()
   })
@@ -297,7 +342,7 @@ function getDuplicateRefsInCategoryMetrics(metrics) {
     metrics.map(({ slug, type, plugin }) => `${type} :: ${plugin} / ${slug}`)
   );
 }
-var categoriesSchema = z5.array(categoryConfigSchema, {
+var categoriesSchema = z6.array(categoryConfigSchema, {
   description: "Categorization of individual audits"
 }).refine(
   (categoryCfg) => !getDuplicateSlugCategories(categoryCfg),
@@ -316,18 +361,18 @@ function getDuplicateSlugCategories(categories) {
 }
 
 // packages/models/src/lib/commit.ts
-import { z as z6 } from "zod";
-var commitSchema = z6.object(
+import { z as z7 } from "zod";
+var commitSchema = z7.object(
   {
-    hash: z6.string({ description: "Commit SHA (full)" }).regex(
+    hash: z7.string({ description: "Commit SHA (full)" }).regex(
       /^[\da-f]{40}$/,
       "Commit SHA should be a 40-character hexadecimal string"
     ),
-    message: z6.string({ description: "Commit message" }),
-    date: z6.coerce.date({
+    message: z7.string({ description: "Commit message" }),
+    date: z7.coerce.date({
       description: "Date and time when commit was authored"
     }),
-    author: z6.string({
+    author: z7.string({
       description: "Commit author name"
     }).trim()
   },
@@ -335,22 +380,22 @@ var commitSchema = z6.object(
 );
 
 // packages/models/src/lib/core-config.ts
-import { z as z12 } from "zod";
+import { z as z13 } from "zod";
 
 // packages/models/src/lib/persist-config.ts
-import { z as z7 } from "zod";
-var formatSchema = z7.enum(["json", "md"]);
-var persistConfigSchema = z7.object({
+import { z as z8 } from "zod";
+var formatSchema = z8.enum(["json", "md"]);
+var persistConfigSchema = z8.object({
   outputDir: filePathSchema.describe("Artifacts folder").optional(),
   filename: fileNameSchema.describe("Artifacts file name (without extension)").optional(),
-  format: z7.array(formatSchema).optional()
+  format: z8.array(formatSchema).optional()
 });
 
 // packages/models/src/lib/plugin-config.ts
-import { z as z10 } from "zod";
+import { z as z11 } from "zod";
 
 // packages/models/src/lib/group.ts
-import { z as z8 } from "zod";
+import { z as z9 } from "zod";
 var groupRefSchema = weightedRefSchema(
   "Weighted reference to a group",
   "Reference slug to a group within this plugin (e.g. 'max-lines')"
@@ -367,7 +412,7 @@ var groupSchema = scorableSchema(
   getDuplicateRefsInGroups,
   duplicateRefsInGroupsErrorMsg
 ).merge(groupMetaSchema);
-var groupsSchema = z8.array(groupSchema, {
+var groupsSchema = z9.array(groupSchema, {
   description: "List of groups"
 }).optional().refine(
   (groups) => !getDuplicateSlugsInGroups(groups),
@@ -395,14 +440,14 @@ function getDuplicateSlugsInGroups(groups) {
 }
 
 // packages/models/src/lib/runner-config.ts
-import { z as z9 } from "zod";
-var outputTransformSchema = z9.function().args(z9.unknown()).returns(z9.union([auditOutputsSchema, z9.promise(auditOutputsSchema)]));
-var runnerConfigSchema = z9.object(
+import { z as z10 } from "zod";
+var outputTransformSchema = z10.function().args(z10.unknown()).returns(z10.union([auditOutputsSchema, z10.promise(auditOutputsSchema)]));
+var runnerConfigSchema = z10.object(
   {
-    command: z9.string({
+    command: z10.string({
       description: "Shell command to execute"
     }),
-    args: z9.array(z9.string({ description: "Command arguments" })).optional(),
+    args: z10.array(z10.string({ description: "Command arguments" })).optional(),
     outputFile: filePathSchema.describe("Output path"),
     outputTransform: outputTransformSchema.optional()
   },
@@ -410,8 +455,8 @@ var runnerConfigSchema = z9.object(
     description: "How to execute runner"
   }
 );
-var onProgressSchema = z9.function().args(z9.unknown()).returns(z9.void());
-var runnerFunctionSchema = z9.function().args(onProgressSchema.optional()).returns(z9.union([auditOutputsSchema, z9.promise(auditOutputsSchema)]));
+var onProgressSchema = z10.function().args(z10.unknown()).returns(z10.void());
+var runnerFunctionSchema = z10.function().args(onProgressSchema.optional()).returns(z10.union([auditOutputsSchema, z10.promise(auditOutputsSchema)]));
 
 // packages/models/src/lib/plugin-config.ts
 var pluginMetaSchema = packageVersionSchema().merge(
@@ -422,13 +467,13 @@ var pluginMetaSchema = packageVersionSchema().merge(
     description: "Plugin metadata"
   })
 ).merge(
-  z10.object({
+  z11.object({
     slug: slugSchema.describe("Unique plugin slug within core config"),
     icon: materialIconSchema
   })
 );
-var pluginDataSchema = z10.object({
-  runner: z10.union([runnerConfigSchema, runnerFunctionSchema]),
+var pluginDataSchema = z11.object({
+  runner: z11.union([runnerConfigSchema, runnerFunctionSchema]),
   audits: pluginAuditsSchema,
   groups: groupsSchema
 });
@@ -454,22 +499,22 @@ function getMissingRefsFromGroups(pluginCfg) {
 }
 
 // packages/models/src/lib/upload-config.ts
-import { z as z11 } from "zod";
-var uploadConfigSchema = z11.object({
+import { z as z12 } from "zod";
+var uploadConfigSchema = z12.object({
   server: urlSchema.describe("URL of deployed portal API"),
-  apiKey: z11.string({
+  apiKey: z12.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: z11.number({ description: "Request timeout in minutes (default is 5)" }).positive().int().optional()
+  timeout: z12.number({ description: "Request timeout in minutes (default is 5)" }).positive().int().optional()
 });
 
 // packages/models/src/lib/core-config.ts
-var unrefinedCoreConfigSchema = z12.object({
-  plugins: z12.array(pluginConfigSchema, {
+var unrefinedCoreConfigSchema = z13.object({
+  plugins: z13.array(pluginConfigSchema, {
     description: "List of plugins to be used (official, community-provided, or custom)"
   }).min(1),
   /** portal configuration for persisting results */
@@ -501,7 +546,7 @@ var DEFAULT_PERSIST_FILENAME = "report";
 var DEFAULT_PERSIST_FORMAT = ["json", "md"];
 
 // packages/models/src/lib/report.ts
-import { z as z13 } from "zod";
+import { z as z14 } from "zod";
 var auditReportSchema = auditSchema.merge(auditOutputSchema);
 var pluginReportSchema = pluginMetaSchema.merge(
   executionMetaSchema({
@@ -509,9 +554,9 @@ var pluginReportSchema = pluginMetaSchema.merge(
     descriptionDuration: "Duration of the plugin run in ms"
   })
 ).merge(
-  z13.object({
-    audits: z13.array(auditReportSchema).min(1),
-    groups: z13.array(groupSchema).optional()
+  z14.object({
+    audits: z14.array(auditReportSchema).min(1),
+    groups: z14.array(groupSchema).optional()
   })
 ).refine(
   (pluginReport) => !getMissingRefsFromGroups2(pluginReport.audits, pluginReport.groups ?? []),
@@ -545,10 +590,10 @@ var reportSchema = packageVersionSchema({
     descriptionDuration: "Duration of the collect run in ms"
   })
 ).merge(
-  z13.object(
+  z14.object(
     {
-      categories: z13.array(categoryConfigSchema),
-      plugins: z13.array(pluginReportSchema).min(1),
+      categories: z14.array(categoryConfigSchema),
+      plugins: z14.array(pluginReportSchema).min(1),
       commit: commitSchema.describe("Git commit for which report was collected").nullable()
     },
     { description: "Collect output data" }
@@ -564,40 +609,40 @@ var reportSchema = packageVersionSchema({
 );
 
 // packages/models/src/lib/reports-diff.ts
-import { z as z14 } from "zod";
+import { z as z15 } from "zod";
 function makeComparisonSchema(schema) {
   const sharedDescription = schema.description || "Result";
-  return z14.object({
+  return z15.object({
     before: schema.describe(`${sharedDescription} (source commit)`),
     after: schema.describe(`${sharedDescription} (target commit)`)
   });
 }
 function makeArraysComparisonSchema(diffSchema, resultSchema, description) {
-  return z14.object(
+  return z15.object(
     {
-      changed: z14.array(diffSchema),
-      unchanged: z14.array(resultSchema),
-      added: z14.array(resultSchema),
-      removed: z14.array(resultSchema)
+      changed: z15.array(diffSchema),
+      unchanged: z15.array(resultSchema),
+      added: z15.array(resultSchema),
+      removed: z15.array(resultSchema)
     },
     { description }
   );
 }
-var scorableMetaSchema = z14.object({
+var scorableMetaSchema = z15.object({
   slug: slugSchema,
   title: titleSchema,
   docsUrl: docsUrlSchema
 });
 var scorableWithPluginMetaSchema = scorableMetaSchema.merge(
-  z14.object({
+  z15.object({
     plugin: pluginMetaSchema.pick({ slug: true, title: true, docsUrl: true }).describe("Plugin which defines it")
   })
 );
 var scorableDiffSchema = scorableMetaSchema.merge(
-  z14.object({
+  z15.object({
     scores: makeComparisonSchema(scoreSchema).merge(
-      z14.object({
-        diff: z14.number().min(-1).max(1).describe("Score change (`scores.after - scores.before`)")
+      z15.object({
+        diff: z15.number().min(-1).max(1).describe("Score change (`scores.after - scores.before`)")
       })
     ).describe("Score comparison")
   })
@@ -608,10 +653,10 @@ var scorableWithPluginDiffSchema = scorableDiffSchema.merge(
 var categoryDiffSchema = scorableDiffSchema;
 var groupDiffSchema = scorableWithPluginDiffSchema;
 var auditDiffSchema = scorableWithPluginDiffSchema.merge(
-  z14.object({
+  z15.object({
     values: makeComparisonSchema(auditValueSchema).merge(
-      z14.object({
-        diff: z14.number().int().describe("Value change (`values.after - values.before`)")
+      z15.object({
+        diff: z15.number().int().describe("Value change (`values.after - values.before`)")
       })
     ).describe("Audit `value` comparison"),
     displayValues: makeComparisonSchema(auditDisplayValueSchema).describe(
@@ -620,15 +665,15 @@ var auditDiffSchema = scorableWithPluginDiffSchema.merge(
   })
 );
 var categoryResultSchema = scorableMetaSchema.merge(
-  z14.object({ score: scoreSchema })
+  z15.object({ score: scoreSchema })
 );
 var groupResultSchema = scorableWithPluginMetaSchema.merge(
-  z14.object({ score: scoreSchema })
+  z15.object({ score: scoreSchema })
 );
 var auditResultSchema = scorableWithPluginMetaSchema.merge(
   auditOutputSchema.pick({ score: true, value: true, displayValue: true })
 );
-var reportsDiffSchema = z14.object({
+var reportsDiffSchema = z15.object({
   commits: makeComparisonSchema(commitSchema).nullable().describe("Commits identifying compared reports"),
   categories: makeArraysComparisonSchema(
     categoryDiffSchema,
@@ -693,9 +738,16 @@ export {
   pluginConfigSchema,
   pluginMetaSchema,
   pluginReportSchema,
+  primitiveValueSchema,
   reportSchema,
   reportsDiffSchema,
   runnerConfigSchema,
   runnerFunctionSchema,
+  tableAlignmentSchema,
+  tableColumnObjectSchema,
+  tableColumnPrimitiveSchema,
+  tableRowObjectSchema,
+  tableRowPrimitiveSchema,
+  tableSchema,
   uploadConfigSchema
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/models",
-  "version": "0.39.0",
+  "version": "0.42.0",
   "license": "MIT",
   "dependencies": {
     "zod": "^3.22.1",
@@ -12,7 +12,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/code-pushup/cli.git",
+    "url": "git+https://github.com/code-pushup/cli.git",
     "directory": "packages/models"
   },
   "contributors": [

package/src/index.d.ts

@@ -1,3 +1,4 @@
+export { PrimitiveValue, primitiveValueSchema, } from './lib/implementation/schemas';
 export { Audit, auditSchema } from './lib/audit';
 export { AuditDetails, AuditOutput, AuditOutputs, auditDetailsSchema, auditOutputSchema, auditOutputsSchema, } from './lib/audit-output';
 export { CategoryConfig, CategoryRef, categoryConfigSchema, categoryRefSchema, } from './lib/category-config';
@@ -9,6 +10,7 @@ export { DEFAULT_PERSIST_FILENAME, DEFAULT_PERSIST_FORMAT, DEFAULT_PERSIST_OUTPU
 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';
+export { TableAlignment, tableAlignmentSchema, TableRowPrimitive, tableRowPrimitiveSchema, TableRowObject, tableRowObjectSchema, TableColumnPrimitive, tableColumnPrimitiveSchema, TableColumnObject, tableColumnObjectSchema, Table, tableSchema, } from './lib/table';
 export { Issue, IssueSeverity, issueSchema, issueSeveritySchema, } from './lib/issue';
 export { Format, PersistConfig, formatSchema, persistConfigSchema, } from './lib/persist-config';
 export { PluginConfig, PluginMeta, pluginConfigSchema, pluginMetaSchema, } from './lib/plugin-config';