@code-pushup/models 0.8.9 → 0.8.11

package/index.js

@@ -32,6 +32,46 @@ function errorItems(items, transform = (items2) => items2.join(", ")) {
 function exists(value) {
   return value != null;
 }
+function getMissingRefsForCategories(categories, plugins) {
+  const missingRefs = [];
+  const auditRefsFromCategory = categories.flatMap(
+    ({ refs }) => refs.filter(({ type }) => type === "audit").map(({ plugin, slug }) => `${plugin}/${slug}`)
+  );
+  const auditRefsFromPlugins = plugins.flatMap(
+    ({ audits, slug: pluginSlug }) => {
+      return audits.map(({ slug }) => `${pluginSlug}/${slug}`);
+    }
+  );
+  const missingAuditRefs = hasMissingStrings(
+    auditRefsFromCategory,
+    auditRefsFromPlugins
+  );
+  if (Array.isArray(missingAuditRefs) && missingAuditRefs.length > 0) {
+    missingRefs.push(...missingAuditRefs);
+  }
+  const groupRefsFromCategory = categories.flatMap(
+    ({ refs }) => refs.filter(({ type }) => type === "group").map(({ plugin, slug }) => `${plugin}#${slug} (group)`)
+  );
+  const groupRefsFromPlugins = plugins.flatMap(
+    ({ groups, slug: pluginSlug }) => {
+      return Array.isArray(groups) ? groups.map(({ slug }) => `${pluginSlug}#${slug} (group)`) : [];
+    }
+  );
+  const missingGroupRefs = hasMissingStrings(
+    groupRefsFromCategory,
+    groupRefsFromPlugins
+  );
+  if (Array.isArray(missingGroupRefs) && missingGroupRefs.length > 0) {
+    missingRefs.push(...missingGroupRefs);
+  }
+  return missingRefs.length ? missingRefs : false;
+}
+function missingRefsForCategoriesErrorMsg(categories, plugins) {
+  const missingRefs = getMissingRefsForCategories(categories, plugins);
+  return `The following category references need to point to an audit or group: ${errorItems(
+    missingRefs
+  )}`;
+}
 
 // packages/models/src/lib/implementation/schemas.ts
 function executionMetaSchema(options = {
@@ -90,15 +130,13 @@ function positiveIntSchema(description) {
   return z.number({ description }).int().nonnegative();
 }
 function packageVersionSchema(options) {
-  let { versionDescription, optional } = options || {};
-  versionDescription = versionDescription || "NPM version of the package";
-  optional = !!optional;
+  const { versionDescription = "NPM version of the package", required } = options ?? {};
   const packageSchema = z.string({ description: "NPM package name" });
   const versionSchema = z.string({ description: versionDescription });
   return z.object(
     {
-      packageName: optional ? packageSchema.optional() : packageSchema,
-      version: optional ? versionSchema.optional() : versionSchema
+      packageName: required ? packageSchema : packageSchema.optional(),
+      version: required ? versionSchema : versionSchema.optional()
     },
     { description: "NPM package name and version of a published package" }
   );
@@ -160,7 +198,7 @@ var pluginAuditsSchema = z2.array(auditSchema, {
 );
 function duplicateSlugsInAuditsErrorMsg(audits) {
   const duplicateRefs = getDuplicateSlugsInAudits(audits);
-  return `In plugin audits the slugs are not unique: ${errorItems(
+  return `In plugin audits the following slugs are not unique: ${errorItems(
     duplicateRefs
   )}`;
 }
@@ -349,7 +387,9 @@ function getDuplicateRefsInGroups(groups) {
 }
 function duplicateSlugsInGroupsErrorMsg(groups) {
   const duplicateRefs = getDuplicateSlugsInGroups(groups);
-  return `In groups the slugs are not unique: ${errorItems(duplicateRefs)}`;
+  return `In groups the following slugs are not unique: ${errorItems(
+    duplicateRefs
+  )}`;
 }
 function getDuplicateSlugsInGroups(groups) {
   return Array.isArray(groups) ? hasDuplicateStrings(groups.map(({ slug }) => slug)) : false;
@@ -375,9 +415,7 @@ var onProgressSchema = z8.function().args(z8.unknown()).returns(z8.void());
 var runnerFunctionSchema = z8.function().args(onProgressSchema.optional()).returns(z8.union([auditOutputsSchema, z8.promise(auditOutputsSchema)]));
 
 // packages/models/src/lib/plugin-config.ts
-var pluginMetaSchema = packageVersionSchema({
-  optional: true
-}).merge(
+var pluginMetaSchema = packageVersionSchema().merge(
   metaSchema({
     titleDescription: "Descriptive name",
     descriptionDescription: "Description (markdown)",
@@ -386,7 +424,7 @@ var pluginMetaSchema = packageVersionSchema({
   })
 ).merge(
   z9.object({
-    slug: slugSchema("References plugin. ID (unique within core config)"),
+    slug: slugSchema("Unique plugin slug within core config"),
     icon: materialIconSchema
   })
 );
@@ -403,20 +441,17 @@ var pluginConfigSchema = pluginMetaSchema.merge(pluginDataSchema).refine(
 );
 function missingRefsFromGroupsErrorMsg(pluginCfg) {
   const missingRefs = getMissingRefsFromGroups(pluginCfg);
-  return `In the groups, the following audit ref's needs to point to a audit in this plugin config: ${errorItems(
+  return `The following group references need to point to an existing audit in this plugin config: ${errorItems(
     missingRefs
   )}`;
 }
 function getMissingRefsFromGroups(pluginCfg) {
-  if (pluginCfg?.groups?.length && pluginCfg?.audits?.length) {
-    const groups = pluginCfg?.groups || [];
-    const audits = pluginCfg?.audits || [];
-    return hasMissingStrings(
-      groups.flatMap(({ refs: audits2 }) => audits2.map(({ slug: ref }) => ref)),
-      audits.map(({ slug }) => slug)
-    );
-  }
-  return false;
+  return hasMissingStrings(
+    pluginCfg.groups?.flatMap(
+      ({ refs: audits }) => audits.map(({ slug: ref }) => ref)
+    ) ?? [],
+    pluginCfg.audits.map(({ slug }) => slug)
+  );
 }
 
 // packages/models/src/lib/upload-config.ts
@@ -426,19 +461,15 @@ var uploadConfigSchema = z10.object({
   apiKey: z10.string({
     description: "API key with write access to portal (use `process.env` for security)"
   }),
-  organization: z10.string({
-    description: "Organization in code versioning system"
-  }),
-  project: z10.string({
-    description: "Project in code versioning system"
-  })
+  organization: slugSchema("Organization slug from Code PushUp portal"),
+  project: slugSchema("Project slug from Code PushUp portal")
 });
 
 // packages/models/src/lib/core-config.ts
 var unrefinedCoreConfigSchema = z11.object({
   plugins: z11.array(pluginConfigSchema, {
     description: "List of plugins to be used (official, community-provided, or custom)"
-  }),
+  }).min(1),
   /** portal configuration for persisting results */
   persist: persistConfigSchema.optional(),
   /** portal configuration for uploading results */
@@ -448,52 +479,15 @@ var unrefinedCoreConfigSchema = z11.object({
 var coreConfigSchema = refineCoreConfig(unrefinedCoreConfigSchema);
 function refineCoreConfig(schema) {
   return schema.refine(
-    (coreCfg) => !getMissingRefsForCategories(coreCfg),
+    (coreCfg) => !getMissingRefsForCategories(coreCfg.categories, coreCfg.plugins),
     (coreCfg) => ({
-      message: missingRefsForCategoriesErrorMsg(coreCfg)
+      message: missingRefsForCategoriesErrorMsg(
+        coreCfg.categories,
+        coreCfg.plugins
+      )
     })
   );
 }
-function missingRefsForCategoriesErrorMsg(coreCfg) {
-  const missingRefs = getMissingRefsForCategories(coreCfg);
-  return `In the categories, the following plugin refs do not exist in the provided plugins: ${errorItems(
-    missingRefs
-  )}`;
-}
-function getMissingRefsForCategories(coreCfg) {
-  const missingRefs = [];
-  const auditRefsFromCategory = coreCfg.categories.flatMap(
-    ({ refs }) => refs.filter(({ type }) => type === "audit").map(({ plugin, slug }) => `${plugin}/${slug}`)
-  );
-  const auditRefsFromPlugins = coreCfg.plugins.flatMap(
-    ({ audits, slug: pluginSlug }) => {
-      return audits.map(({ slug }) => `${pluginSlug}/${slug}`);
-    }
-  );
-  const missingAuditRefs = hasMissingStrings(
-    auditRefsFromCategory,
-    auditRefsFromPlugins
-  );
-  if (Array.isArray(missingAuditRefs) && missingAuditRefs.length > 0) {
-    missingRefs.push(...missingAuditRefs);
-  }
-  const groupRefsFromCategory = coreCfg.categories.flatMap(
-    ({ refs }) => refs.filter(({ type }) => type === "group").map(({ plugin, slug }) => `${plugin}#${slug} (group)`)
-  );
-  const groupRefsFromPlugins = coreCfg.plugins.flatMap(
-    ({ groups, slug: pluginSlug }) => {
-      return Array.isArray(groups) ? groups.map(({ slug }) => `${pluginSlug}#${slug} (group)`) : [];
-    }
-  );
-  const missingGroupRefs = hasMissingStrings(
-    groupRefsFromCategory,
-    groupRefsFromPlugins
-  );
-  if (Array.isArray(missingGroupRefs) && missingGroupRefs.length > 0) {
-    missingRefs.push(...missingGroupRefs);
-  }
-  return missingRefs.length ? missingRefs : false;
-}
 
 // packages/models/src/lib/implementation/constants.ts
 var PERSIST_OUTPUT_DIR = ".code-pushup";
@@ -513,9 +507,32 @@ var pluginReportSchema = pluginMetaSchema.merge(
     audits: z12.array(auditReportSchema),
     groups: z12.array(groupSchema).optional()
   })
+).refine(
+  (pluginReport) => !getMissingRefsFromGroups2(pluginReport.audits, pluginReport.groups ?? []),
+  (pluginReport) => ({
+    message: missingRefsFromGroupsErrorMsg2(
+      pluginReport.audits,
+      pluginReport.groups ?? []
+    )
+  })
 );
+function missingRefsFromGroupsErrorMsg2(audits, groups) {
+  const missingRefs = getMissingRefsFromGroups2(audits, groups);
+  return `group references need to point to an existing audit in this plugin report: ${errorItems(
+    missingRefs
+  )}`;
+}
+function getMissingRefsFromGroups2(audits, groups) {
+  return hasMissingStrings(
+    groups.flatMap(
+      ({ refs: auditRefs }) => auditRefs.map(({ slug: ref }) => ref)
+    ),
+    audits.map(({ slug }) => slug)
+  );
+}
 var reportSchema = packageVersionSchema({
-  versionDescription: "NPM version of the CLI"
+  versionDescription: "NPM version of the CLI",
+  required: true
 }).merge(
   executionMetaSchema({
     descriptionDate: "Start date and time of the collect run",
@@ -525,10 +542,18 @@ var reportSchema = packageVersionSchema({
   z12.object(
     {
       categories: z12.array(categoryConfigSchema),
-      plugins: z12.array(pluginReportSchema)
+      plugins: z12.array(pluginReportSchema).min(1)
     },
     { description: "Collect output data" }
   )
+).refine(
+  (report) => !getMissingRefsForCategories(report.categories, report.plugins),
+  (report) => ({
+    message: missingRefsForCategoriesErrorMsg(
+      report.categories,
+      report.plugins
+    )
+  })
 );
 export {
   MAX_DESCRIPTION_LENGTH,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/models",
-  "version": "0.8.9",
+  "version": "0.8.11",
   "dependencies": {
     "zod": "^3.22.1",
     "@code-pushup/portal-client": "^0.3.0"

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

@@ -98,8 +98,8 @@ export declare const auditOutputSchema: z.ZodObject<{
         }[];
     }>>;
 }, "strip", z.ZodTypeAny, {
-    value: number;
     slug: string;
+    value: number;
     score: number;
     displayValue?: string | undefined;
     details?: {
@@ -118,8 +118,8 @@ export declare const auditOutputSchema: z.ZodObject<{
         }[];
     } | undefined;
 }, {
-    value: number;
     slug: string;
+    value: number;
     score: number;
     displayValue?: string | undefined;
     details?: {
@@ -238,8 +238,8 @@ export declare const auditOutputsSchema: z.ZodEffects<z.ZodArray<z.ZodObject<{
         }[];
     }>>;
 }, "strip", z.ZodTypeAny, {
-    value: number;
     slug: string;
+    value: number;
     score: number;
     displayValue?: string | undefined;
     details?: {
@@ -258,8 +258,8 @@ export declare const auditOutputsSchema: z.ZodEffects<z.ZodArray<z.ZodObject<{
         }[];
     } | undefined;
 }, {
-    value: number;
     slug: string;
+    value: number;
     score: number;
     displayValue?: string | undefined;
     details?: {
@@ -278,8 +278,8 @@ export declare const auditOutputsSchema: z.ZodEffects<z.ZodArray<z.ZodObject<{
         }[];
     } | undefined;
 }>, "many">, {
-    value: number;
     slug: string;
+    value: number;
     score: number;
     displayValue?: string | undefined;
     details?: {
@@ -298,8 +298,8 @@ export declare const auditOutputsSchema: z.ZodEffects<z.ZodArray<z.ZodObject<{
         }[];
     } | undefined;
 }[], {
-    value: number;
     slug: string;
+    value: number;
     score: number;
     displayValue?: string | undefined;
     details?: {

package/src/lib/audit.d.ts

@@ -5,13 +5,13 @@ export declare const auditSchema: z.ZodObject<{
     description: z.ZodOptional<z.ZodString>;
     docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodString]>;
 }, "strip", z.ZodTypeAny, {
-    title: string;
     slug: string;
+    title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
 }, {
-    title: string;
     slug: string;
+    title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
 }>;
@@ -22,23 +22,23 @@ export declare const pluginAuditsSchema: z.ZodEffects<z.ZodArray<z.ZodObject<{
     description: z.ZodOptional<z.ZodString>;
     docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodString]>;
 }, "strip", z.ZodTypeAny, {
-    title: string;
     slug: string;
+    title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
 }, {
-    title: string;
     slug: string;
+    title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
 }>, "many">, {
-    title: string;
     slug: string;
+    title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
 }[], {
-    title: string;
     slug: string;
+    title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
 }[]>;

package/src/lib/category-config.d.ts

@@ -5,80 +5,80 @@ export declare const categoryRefSchema: z.ZodObject<{
     type: z.ZodEnum<["audit", "group"]>;
     plugin: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    type: "audit" | "group";
     slug: string;
     weight: number;
+    type: "audit" | "group";
     plugin: string;
 }, {
-    type: "audit" | "group";
     slug: string;
     weight: number;
+    type: "audit" | "group";
     plugin: string;
 }>;
 export type CategoryRef = z.infer<typeof categoryRefSchema>;
 export declare const categoryConfigSchema: z.ZodObject<{
-    description: z.ZodOptional<z.ZodString>;
-    title: z.ZodString;
-    docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodString]>;
     slug: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
     refs: z.ZodEffects<z.ZodEffects<z.ZodArray<z.ZodObject<{
         slug: z.ZodString;
         weight: z.ZodNumber;
         type: z.ZodEnum<["audit", "group"]>;
         plugin: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }, {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }>, "many">, {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }[], {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }[]>, {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }[], {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }[]>;
+    title: z.ZodString;
+    docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodString]>;
     isBinary: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
-    title: string;
     slug: string;
     refs: {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }[];
+    title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
     isBinary?: boolean | undefined;
 }, {
-    title: string;
     slug: string;
     refs: {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }[];
+    title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
     isBinary?: boolean | undefined;
@@ -86,92 +86,92 @@ export declare const categoryConfigSchema: z.ZodObject<{
 export type CategoryConfig = z.infer<typeof categoryConfigSchema>;
 export declare function duplicateRefsInCategoryMetricsErrorMsg(metrics: CategoryRef[]): string;
 export declare const categoriesSchema: z.ZodEffects<z.ZodArray<z.ZodObject<{
-    description: z.ZodOptional<z.ZodString>;
-    title: z.ZodString;
-    docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodString]>;
     slug: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
     refs: z.ZodEffects<z.ZodEffects<z.ZodArray<z.ZodObject<{
         slug: z.ZodString;
         weight: z.ZodNumber;
         type: z.ZodEnum<["audit", "group"]>;
         plugin: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }, {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }>, "many">, {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }[], {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }[]>, {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }[], {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }[]>;
+    title: z.ZodString;
+    docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodString]>;
     isBinary: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
-    title: string;
     slug: string;
     refs: {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }[];
+    title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
     isBinary?: boolean | undefined;
 }, {
-    title: string;
     slug: string;
     refs: {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }[];
+    title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
     isBinary?: boolean | undefined;
 }>, "many">, {
-    title: string;
     slug: string;
     refs: {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }[];
+    title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
     isBinary?: boolean | undefined;
 }[], {
-    title: string;
     slug: string;
     refs: {
-        type: "audit" | "group";
         slug: string;
         weight: number;
+        type: "audit" | "group";
         plugin: string;
     }[];
+    title: string;
     description?: string | undefined;
     docsUrl?: string | undefined;
     isBinary?: boolean | undefined;