@code-pushup/models 0.56.0 → 0.58.0

package/src/lib/report.js

@@ -0,0 +1,49 @@
+import { z } from 'zod';
+import { auditOutputSchema } from './audit-output.js';
+import { auditSchema } from './audit.js';
+import { categoryConfigSchema } from './category-config.js';
+import { commitSchema } from './commit.js';
+import { groupSchema } from './group.js';
+import { executionMetaSchema, packageVersionSchema, } from './implementation/schemas.js';
+import { errorItems, getMissingRefsForCategories, hasMissingStrings, missingRefsForCategoriesErrorMsg, } from './implementation/utils.js';
+import { pluginMetaSchema } from './plugin-config.js';
+export const auditReportSchema = auditSchema.merge(auditOutputSchema);
+export const pluginReportSchema = pluginMetaSchema
+    .merge(executionMetaSchema({
+    descriptionDate: 'Start date and time of plugin run',
+    descriptionDuration: 'Duration of the plugin run in ms',
+}))
+    .merge(z.object({
+    audits: z.array(auditReportSchema).min(1),
+    groups: z.array(groupSchema).optional(),
+}))
+    .refine(pluginReport => !getMissingRefsFromGroups(pluginReport.audits, pluginReport.groups ?? []), pluginReport => ({
+    message: missingRefsFromGroupsErrorMsg(pluginReport.audits, pluginReport.groups ?? []),
+}));
+// every listed group ref points to an audit within the plugin report
+function missingRefsFromGroupsErrorMsg(audits, groups) {
+    const missingRefs = getMissingRefsFromGroups(audits, groups);
+    return `group references need to point to an existing audit in this plugin report: ${errorItems(missingRefs)}`;
+}
+function getMissingRefsFromGroups(audits, groups) {
+    return hasMissingStrings(groups.flatMap(({ refs: auditRefs }) => auditRefs.map(({ slug: ref }) => ref)), audits.map(({ slug }) => slug));
+}
+export const reportSchema = packageVersionSchema({
+    versionDescription: 'NPM version of the CLI',
+    required: true,
+})
+    .merge(executionMetaSchema({
+    descriptionDate: 'Start date and time of the collect run',
+    descriptionDuration: 'Duration of the collect run in ms',
+}))
+    .merge(z.object({
+    plugins: z.array(pluginReportSchema).min(1),
+    categories: z.array(categoryConfigSchema).optional(),
+    commit: commitSchema
+        .describe('Git commit for which report was collected')
+        .nullable(),
+}, { description: 'Collect output data' }))
+    .refine(({ categories, plugins }) => !getMissingRefsForCategories(categories, plugins), ({ categories, plugins }) => ({
+    message: missingRefsForCategoriesErrorMsg(categories, plugins),
+}));
+//# sourceMappingURL=report.js.map

package/src/lib/report.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/report.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAc,WAAW,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EACL,mBAAmB,EACnB,oBAAoB,GACrB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,UAAU,EACV,2BAA2B,EAC3B,iBAAiB,EACjB,gCAAgC,GACjC,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,MAAM,CAAC,MAAM,iBAAiB,GAAG,WAAW,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;AAGtE,MAAM,CAAC,MAAM,kBAAkB,GAAG,gBAAgB;KAC/C,KAAK,CACJ,mBAAmB,CAAC;IAClB,eAAe,EAAE,mCAAmC;IACpD,mBAAmB,EAAE,kCAAkC;CACxD,CAAC,CACH;KACA,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACzC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE;CACxC,CAAC,CACH;KACA,MAAM,CACL,YAAY,CAAC,EAAE,CACb,CAAC,wBAAwB,CAAC,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,IAAI,EAAE,CAAC,EAC3E,YAAY,CAAC,EAAE,CAAC,CAAC;IACf,OAAO,EAAE,6BAA6B,CACpC,YAAY,CAAC,MAAM,EACnB,YAAY,CAAC,MAAM,IAAI,EAAE,CAC1B;CACF,CAAC,CACH,CAAC;AAIJ,qEAAqE;AACrE,SAAS,6BAA6B,CAAC,MAAqB,EAAE,MAAe;IAC3E,MAAM,WAAW,GAAG,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7D,OAAO,8EAA8E,UAAU,CAC7F,WAAW,CACZ,EAAE,CAAC;AACN,CAAC;AAED,SAAS,wBAAwB,CAAC,MAAqB,EAAE,MAAe;IACtE,OAAO,iBAAiB,CACtB,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,CACrC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CACtC,EACD,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAC/B,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,oBAAoB,CAAC;IAC/C,kBAAkB,EAAE,wBAAwB;IAC5C,QAAQ,EAAE,IAAI;CACf,CAAC;KACC,KAAK,CACJ,mBAAmB,CAAC;IAClB,eAAe,EAAE,wCAAwC;IACzD,mBAAmB,EAAE,mCAAmC;CACzD,CAAC,CACH;KACA,KAAK,CACJ,CAAC,CAAC,MAAM,CACN;IACE,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3C,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,QAAQ,EAAE;IACpD,MAAM,EAAE,YAAY;SACjB,QAAQ,CAAC,2CAA2C,CAAC;SACrD,QAAQ,EAAE;CACd,EACD,EAAE,WAAW,EAAE,qBAAqB,EAAE,CACvC,CACF;KACA,MAAM,CACL,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,EAAE,CAC1B,CAAC,2BAA2B,CAAC,UAAU,EAAE,OAAO,CAAC,EACnD,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5B,OAAO,EAAE,gCAAgC,CAAC,UAAU,EAAE,OAAO,CAAC;CAC/D,CAAC,CACH,CAAC"}