@code-pushup/models 0.25.7 → 0.26.0

package/index.js

@@ -312,23 +312,42 @@ function getDuplicateSlugCategories(categories) {
   return hasDuplicateStrings(categories.map(({ slug }) => slug));
 }
 
+// packages/models/src/lib/commit.ts
+import { z as z6 } from "zod";
+var commitSchema = z6.object(
+  {
+    hash: z6.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({
+      description: "Date and time when commit was authored"
+    }),
+    author: z6.string({
+      description: "Commit author name"
+    }).trim()
+  },
+  { description: "Git commit" }
+);
+
 // packages/models/src/lib/core-config.ts
-import { z as z11 } from "zod";
+import { z as z12 } from "zod";
 
 // packages/models/src/lib/persist-config.ts
-import { z as z6 } from "zod";
-var formatSchema = z6.enum(["json", "md"]);
-var persistConfigSchema = z6.object({
+import { z as z7 } from "zod";
+var formatSchema = z7.enum(["json", "md"]);
+var persistConfigSchema = z7.object({
   outputDir: filePathSchema.describe("Artifacts folder").optional(),
   filename: fileNameSchema.describe("Artifacts file name (without extension)").optional(),
-  format: z6.array(formatSchema).optional()
+  format: z7.array(formatSchema).optional()
 });
 
 // packages/models/src/lib/plugin-config.ts
-import { z as z9 } from "zod";
+import { z as z10 } from "zod";
 
 // packages/models/src/lib/group.ts
-import { z as z7 } from "zod";
+import { z as z8 } from "zod";
 var groupRefSchema = weightedRefSchema(
   "Weighted reference to a group",
   "Reference slug to a group within this plugin (e.g. 'max-lines')"
@@ -345,7 +364,7 @@ var groupSchema = scorableSchema(
   getDuplicateRefsInGroups,
   duplicateRefsInGroupsErrorMsg
 ).merge(groupMetaSchema);
-var groupsSchema = z7.array(groupSchema, {
+var groupsSchema = z8.array(groupSchema, {
   description: "List of groups"
 }).optional().refine(
   (groups) => !getDuplicateSlugsInGroups(groups),
@@ -373,14 +392,14 @@ function getDuplicateSlugsInGroups(groups) {
 }
 
 // packages/models/src/lib/runner-config.ts
-import { z as z8 } from "zod";
-var outputTransformSchema = z8.function().args(z8.unknown()).returns(z8.union([auditOutputsSchema, z8.promise(auditOutputsSchema)]));
-var runnerConfigSchema = z8.object(
+import { z as z9 } from "zod";
+var outputTransformSchema = z9.function().args(z9.unknown()).returns(z9.union([auditOutputsSchema, z9.promise(auditOutputsSchema)]));
+var runnerConfigSchema = z9.object(
   {
-    command: z8.string({
+    command: z9.string({
       description: "Shell command to execute"
     }),
-    args: z8.array(z8.string({ description: "Command arguments" })).optional(),
+    args: z9.array(z9.string({ description: "Command arguments" })).optional(),
     outputFile: filePathSchema.describe("Output path"),
     outputTransform: outputTransformSchema.optional()
   },
@@ -388,8 +407,8 @@ var runnerConfigSchema = z8.object(
     description: "How to execute runner"
   }
 );
-var onProgressSchema = z8.function().args(z8.unknown()).returns(z8.void());
-var runnerFunctionSchema = z8.function().args(onProgressSchema.optional()).returns(z8.union([auditOutputsSchema, z8.promise(auditOutputsSchema)]));
+var onProgressSchema = z9.function().args(z9.unknown()).returns(z9.void());
+var runnerFunctionSchema = z9.function().args(onProgressSchema.optional()).returns(z9.union([auditOutputsSchema, z9.promise(auditOutputsSchema)]));
 
 // packages/models/src/lib/plugin-config.ts
 var pluginMetaSchema = packageVersionSchema().merge(
@@ -400,13 +419,13 @@ var pluginMetaSchema = packageVersionSchema().merge(
     description: "Plugin metadata"
   })
 ).merge(
-  z9.object({
+  z10.object({
     slug: slugSchema.describe("Unique plugin slug within core config"),
     icon: materialIconSchema
   })
 );
-var pluginDataSchema = z9.object({
-  runner: z9.union([runnerConfigSchema, runnerFunctionSchema]),
+var pluginDataSchema = z10.object({
+  runner: z10.union([runnerConfigSchema, runnerFunctionSchema]),
   audits: pluginAuditsSchema,
   groups: groupsSchema
 });
@@ -432,22 +451,22 @@ function getMissingRefsFromGroups(pluginCfg) {
 }
 
 // packages/models/src/lib/upload-config.ts
-import { z as z10 } from "zod";
-var uploadConfigSchema = z10.object({
+import { z as z11 } from "zod";
+var uploadConfigSchema = z11.object({
   server: urlSchema.describe("URL of deployed portal API"),
-  apiKey: z10.string({
+  apiKey: z11.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: z10.number({ description: "Request timeout in minutes (default is 5)" }).positive().int().optional()
+  timeout: z11.number({ description: "Request timeout in minutes (default is 5)" }).positive().int().optional()
 });
 
 // packages/models/src/lib/core-config.ts
-var unrefinedCoreConfigSchema = z11.object({
-  plugins: z11.array(pluginConfigSchema, {
+var unrefinedCoreConfigSchema = z12.object({
+  plugins: z12.array(pluginConfigSchema, {
     description: "List of plugins to be used (official, community-provided, or custom)"
   }).min(1),
   /** portal configuration for persisting results */
@@ -479,7 +498,7 @@ var PERSIST_FORMAT = ["json"];
 var PERSIST_FILENAME = "report";
 
 // packages/models/src/lib/report.ts
-import { z as z12 } from "zod";
+import { z as z13 } from "zod";
 var auditReportSchema = auditSchema.merge(auditOutputSchema);
 var pluginReportSchema = pluginMetaSchema.merge(
   executionMetaSchema({
@@ -487,9 +506,9 @@ var pluginReportSchema = pluginMetaSchema.merge(
     descriptionDuration: "Duration of the plugin run in ms"
   })
 ).merge(
-  z12.object({
-    audits: z12.array(auditReportSchema).min(1),
-    groups: z12.array(groupSchema).optional()
+  z13.object({
+    audits: z13.array(auditReportSchema).min(1),
+    groups: z13.array(groupSchema).optional()
   })
 ).refine(
   (pluginReport) => !getMissingRefsFromGroups2(pluginReport.audits, pluginReport.groups ?? []),
@@ -523,10 +542,11 @@ var reportSchema = packageVersionSchema({
     descriptionDuration: "Duration of the collect run in ms"
   })
 ).merge(
-  z12.object(
+  z13.object(
     {
-      categories: z12.array(categoryConfigSchema),
-      plugins: z12.array(pluginReportSchema).min(1)
+      categories: z13.array(categoryConfigSchema),
+      plugins: z13.array(pluginReportSchema).min(1),
+      commit: commitSchema.describe("Git commit for which report was collected").nullable()
     },
     { description: "Collect output data" }
   )
@@ -556,6 +576,7 @@ export {
   auditSchema,
   categoryConfigSchema,
   categoryRefSchema,
+  commitSchema,
   coreConfigSchema,
   exists,
   formatSchema,

package/package.json

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

package/src/index.d.ts

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

package/src/lib/commit.d.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+export declare const commitSchema: z.ZodObject<{
+    hash: z.ZodString;
+    message: z.ZodString;
+    date: z.ZodDate;
+    author: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    date: Date;
+    hash: string;
+    author: string;
+}, {
+    message: string;
+    date: Date;
+    hash: string;
+    author: string;
+}>;
+export type Commit = z.infer<typeof commitSchema>;

package/src/lib/report.d.ts

@@ -983,6 +983,22 @@ export declare const reportSchema: z.ZodEffects<z.ZodObject<{
             docsUrl?: string | undefined;
         }[] | undefined;
     }>, "many">;
+    commit: z.ZodNullable<z.ZodObject<{
+        hash: z.ZodString;
+        message: z.ZodString;
+        date: z.ZodDate;
+        author: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        date: Date;
+        hash: string;
+        author: string;
+    }, {
+        message: string;
+        date: Date;
+        hash: string;
+        author: string;
+    }>>;
 }, "strip", z.ZodTypeAny, {
     date: string;
     packageName: string;
@@ -1046,6 +1062,12 @@ export declare const reportSchema: z.ZodEffects<z.ZodObject<{
             docsUrl?: string | undefined;
         }[] | undefined;
     }[];
+    commit: {
+        message: string;
+        date: Date;
+        hash: string;
+        author: string;
+    } | null;
 }, {
     date: string;
     packageName: string;
@@ -1109,6 +1131,12 @@ export declare const reportSchema: z.ZodEffects<z.ZodObject<{
             docsUrl?: string | undefined;
         }[] | undefined;
     }[];
+    commit: {
+        message: string;
+        date: Date;
+        hash: string;
+        author: string;
+    } | null;
 }>, {
     date: string;
     packageName: string;
@@ -1172,6 +1200,12 @@ export declare const reportSchema: z.ZodEffects<z.ZodObject<{
             docsUrl?: string | undefined;
         }[] | undefined;
     }[];
+    commit: {
+        message: string;
+        date: Date;
+        hash: string;
+        author: string;
+    } | null;
 }, {
     date: string;
     packageName: string;
@@ -1235,5 +1269,11 @@ export declare const reportSchema: z.ZodEffects<z.ZodObject<{
             docsUrl?: string | undefined;
         }[] | undefined;
     }[];
+    commit: {
+        message: string;
+        date: Date;
+        hash: string;
+        author: string;
+    } | null;
 }>;
 export type Report = z.infer<typeof reportSchema>;