@code-pushup/models 0.54.0 → 0.56.0

package/index.js

@@ -29,7 +29,7 @@ function exists(value) {
   return value != null;
 }
 function getMissingRefsForCategories(categories, plugins) {
-  if (categories.length === 0) {
+  if (!categories || categories.length === 0) {
     return false;
   }
   const auditRefsFromCategory = categories.flatMap(
@@ -529,12 +529,9 @@ var unrefinedCoreConfigSchema = z14.object({
 var coreConfigSchema = refineCoreConfig(unrefinedCoreConfigSchema);
 function refineCoreConfig(schema) {
   return schema.refine(
-    (coreCfg) => !getMissingRefsForCategories(coreCfg.categories ?? [], coreCfg.plugins),
-    (coreCfg) => ({
-      message: missingRefsForCategoriesErrorMsg(
-        coreCfg.categories ?? [],
-        coreCfg.plugins
-      )
+    ({ categories, plugins }) => !getMissingRefsForCategories(categories, plugins),
+    ({ categories, plugins }) => ({
+      message: missingRefsForCategoriesErrorMsg(categories, plugins)
     })
   );
 }
@@ -595,19 +592,16 @@ var reportSchema = packageVersionSchema({
 ).merge(
   z15.object(
     {
-      categories: z15.array(categoryConfigSchema),
       plugins: z15.array(pluginReportSchema).min(1),
+      categories: z15.array(categoryConfigSchema).optional(),
       commit: commitSchema.describe("Git commit for which report was collected").nullable()
     },
     { description: "Collect output data" }
   )
 ).refine(
-  (report) => !getMissingRefsForCategories(report.categories, report.plugins),
-  (report) => ({
-    message: missingRefsForCategoriesErrorMsg(
-      report.categories,
-      report.plugins
-    )
+  ({ categories, plugins }) => !getMissingRefsForCategories(categories, plugins),
+  ({ categories, plugins }) => ({
+    message: missingRefsForCategoriesErrorMsg(categories, plugins)
   })
 );
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/models",
-  "version": "0.54.0",
+  "version": "0.56.0",
   "license": "MIT",
   "description": "Model definitions and validators for the Code PushUp CLI",
   "homepage": "https://github.com/code-pushup/cli/tree/main/packages/models#readme",

package/src/lib/implementation/utils.d.ts

@@ -36,5 +36,5 @@ export declare function exists<T>(value: T): value is NonNullable<T>;
  * @param plugins
  * @returns Array of missing references.
  */
-export declare function getMissingRefsForCategories(categories: CategoryConfig[], plugins: PluginConfig[] | PluginReport[]): false | string[];
-export declare function missingRefsForCategoriesErrorMsg(categories: CategoryConfig[], plugins: PluginConfig[] | PluginReport[]): string;
+export declare function getMissingRefsForCategories(categories: CategoryConfig[] | undefined, plugins: PluginConfig[] | PluginReport[]): false | string[];
+export declare function missingRefsForCategoriesErrorMsg(categories: CategoryConfig[] | undefined, plugins: PluginConfig[] | PluginReport[]): string;

package/src/lib/report.d.ts

@@ -798,76 +798,6 @@ export declare const reportSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendS
     date: z.ZodString;
     duration: z.ZodNumber;
 }>, {
-    categories: z.ZodArray<z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
-        slug: z.ZodString;
-        refs: z.ZodEffects<z.ZodEffects<z.ZodArray<z.ZodObject<z.objectUtil.extendShape<{
-            slug: z.ZodString;
-            weight: z.ZodNumber;
-        }, {
-            type: z.ZodEnum<["audit", "group"]>;
-            plugin: z.ZodString;
-        }>, "strip", z.ZodTypeAny, {
-            slug: string;
-            weight: number;
-            type: "audit" | "group";
-            plugin: string;
-        }, {
-            slug: string;
-            weight: number;
-            type: "audit" | "group";
-            plugin: string;
-        }>, "many">, {
-            slug: string;
-            weight: number;
-            type: "audit" | "group";
-            plugin: string;
-        }[], {
-            slug: string;
-            weight: number;
-            type: "audit" | "group";
-            plugin: string;
-        }[]>, {
-            slug: string;
-            weight: number;
-            type: "audit" | "group";
-            plugin: string;
-        }[], {
-            slug: string;
-            weight: number;
-            type: "audit" | "group";
-            plugin: string;
-        }[]>;
-    }, {
-        title: z.ZodString;
-        description: z.ZodOptional<z.ZodString>;
-        docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>;
-    }>, {
-        isBinary: z.ZodOptional<z.ZodBoolean>;
-    }>, "strip", z.ZodTypeAny, {
-        slug: string;
-        refs: {
-            slug: string;
-            weight: number;
-            type: "audit" | "group";
-            plugin: string;
-        }[];
-        title: string;
-        description?: string | undefined;
-        docsUrl?: string | undefined;
-        isBinary?: boolean | undefined;
-    }, {
-        slug: string;
-        refs: {
-            slug: string;
-            weight: number;
-            type: "audit" | "group";
-            plugin: string;
-        }[];
-        title: string;
-        description?: string | undefined;
-        docsUrl?: string | undefined;
-        isBinary?: boolean | undefined;
-    }>, "many">;
     plugins: z.ZodArray<z.ZodEffects<z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<z.objectUtil.extendShape<{
         packageName: z.ZodString | z.ZodOptional<z.ZodString>;
         version: z.ZodString | z.ZodOptional<z.ZodString>;
@@ -1408,6 +1338,76 @@ export declare const reportSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendS
             docsUrl?: string | undefined;
         }[] | undefined;
     }>, "many">;
+    categories: z.ZodOptional<z.ZodArray<z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extendShape<{
+        slug: z.ZodString;
+        refs: z.ZodEffects<z.ZodEffects<z.ZodArray<z.ZodObject<z.objectUtil.extendShape<{
+            slug: z.ZodString;
+            weight: z.ZodNumber;
+        }, {
+            type: z.ZodEnum<["audit", "group"]>;
+            plugin: z.ZodString;
+        }>, "strip", z.ZodTypeAny, {
+            slug: string;
+            weight: number;
+            type: "audit" | "group";
+            plugin: string;
+        }, {
+            slug: string;
+            weight: number;
+            type: "audit" | "group";
+            plugin: string;
+        }>, "many">, {
+            slug: string;
+            weight: number;
+            type: "audit" | "group";
+            plugin: string;
+        }[], {
+            slug: string;
+            weight: number;
+            type: "audit" | "group";
+            plugin: string;
+        }[]>, {
+            slug: string;
+            weight: number;
+            type: "audit" | "group";
+            plugin: string;
+        }[], {
+            slug: string;
+            weight: number;
+            type: "audit" | "group";
+            plugin: string;
+        }[]>;
+    }, {
+        title: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>;
+    }>, {
+        isBinary: z.ZodOptional<z.ZodBoolean>;
+    }>, "strip", z.ZodTypeAny, {
+        slug: string;
+        refs: {
+            slug: string;
+            weight: number;
+            type: "audit" | "group";
+            plugin: string;
+        }[];
+        title: string;
+        description?: string | undefined;
+        docsUrl?: string | undefined;
+        isBinary?: boolean | undefined;
+    }, {
+        slug: string;
+        refs: {
+            slug: string;
+            weight: number;
+            type: "audit" | "group";
+            plugin: string;
+        }[];
+        title: string;
+        description?: string | undefined;
+        docsUrl?: string | undefined;
+        isBinary?: boolean | undefined;
+    }>, "many">>;
     commit: z.ZodNullable<z.ZodObject<{
         hash: z.ZodString;
         message: z.ZodString;
@@ -1429,19 +1429,6 @@ export declare const reportSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendS
     packageName: string;
     version: string;
     duration: number;
-    categories: {
-        slug: string;
-        refs: {
-            slug: string;
-            weight: number;
-            type: "audit" | "group";
-            plugin: string;
-        }[];
-        title: string;
-        description?: string | undefined;
-        docsUrl?: string | undefined;
-        isBinary?: boolean | undefined;
-    }[];
     plugins: {
         slug: string;
         date: string;
@@ -1506,12 +1493,7 @@ export declare const reportSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendS
         hash: string;
         author: string;
     } | null;
-}, {
-    date: string;
-    packageName: string;
-    version: string;
-    duration: number;
-    categories: {
+    categories?: {
         slug: string;
         refs: {
             slug: string;
@@ -1523,7 +1505,12 @@ export declare const reportSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendS
         description?: string | undefined;
         docsUrl?: string | undefined;
         isBinary?: boolean | undefined;
-    }[];
+    }[] | undefined;
+}, {
+    date: string;
+    packageName: string;
+    version: string;
+    duration: number;
     plugins: {
         slug: string;
         date: string;
@@ -1588,12 +1575,7 @@ export declare const reportSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendS
         hash: string;
         author: string;
     } | null;
-}>, {
-    date: string;
-    packageName: string;
-    version: string;
-    duration: number;
-    categories: {
+    categories?: {
         slug: string;
         refs: {
             slug: string;
@@ -1605,7 +1587,12 @@ export declare const reportSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendS
         description?: string | undefined;
         docsUrl?: string | undefined;
         isBinary?: boolean | undefined;
-    }[];
+    }[] | undefined;
+}>, {
+    date: string;
+    packageName: string;
+    version: string;
+    duration: number;
     plugins: {
         slug: string;
         date: string;
@@ -1670,12 +1657,7 @@ export declare const reportSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendS
         hash: string;
         author: string;
     } | null;
-}, {
-    date: string;
-    packageName: string;
-    version: string;
-    duration: number;
-    categories: {
+    categories?: {
         slug: string;
         refs: {
             slug: string;
@@ -1687,7 +1669,12 @@ export declare const reportSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendS
         description?: string | undefined;
         docsUrl?: string | undefined;
         isBinary?: boolean | undefined;
-    }[];
+    }[] | undefined;
+}, {
+    date: string;
+    packageName: string;
+    version: string;
+    duration: number;
     plugins: {
         slug: string;
         date: string;
@@ -1752,5 +1739,18 @@ export declare const reportSchema: z.ZodEffects<z.ZodObject<z.objectUtil.extendS
         hash: string;
         author: string;
     } | null;
+    categories?: {
+        slug: string;
+        refs: {
+            slug: string;
+            weight: number;
+            type: "audit" | "group";
+            plugin: string;
+        }[];
+        title: string;
+        description?: string | undefined;
+        docsUrl?: string | undefined;
+        isBinary?: boolean | undefined;
+    }[] | undefined;
 }>;
 export type Report = z.infer<typeof reportSchema>;