@code-pushup/models 0.4.5 → 0.5.2

package/index.js

@@ -118,12 +118,14 @@ function scorableSchema(description, refSchema, duplicateCheckFn, duplicateMessa
   return z.object(
     {
       slug: slugSchema('Human-readable unique ID, e.g. "performance"'),
-      refs: z.array(refSchema).refine(
+      refs: z.array(refSchema).min(1).refine(
         (refs) => !duplicateCheckFn(refs),
         (refs) => ({
           message: duplicateMessageFn(refs)
         })
-      )
+      ).refine(hasWeightedRefsInCategories, () => ({
+        message: `In a category there has to be at least one ref with weight > 0`
+      }))
     },
     { description }
   );
@@ -132,6 +134,9 @@ var materialIconSchema = z.enum(
   MATERIAL_ICONS,
   { description: "Icon from VSCode Material Icons extension" }
 );
+function hasWeightedRefsInCategories(categoryRefs) {
+  return categoryRefs.reduce((acc, { weight }) => weight + acc, 0) !== 0;
+}
 
 // packages/models/src/lib/category-config.ts
 var categoryRefSchema = weightedRefSchema(
@@ -177,6 +182,23 @@ function getDuplicateRefsInCategoryMetrics(metrics) {
     metrics.map(({ slug, type, plugin }) => `${type} :: ${plugin} / ${slug}`)
   );
 }
+var categoriesSchema = z2.array(categoryConfigSchema, {
+  description: "Categorization of individual audits"
+}).min(1).refine(
+  (categoryCfg) => !getDuplicateSlugCategories(categoryCfg),
+  (categoryCfg) => ({
+    message: duplicateSlugCategoriesErrorMsg(categoryCfg)
+  })
+);
+function duplicateSlugCategoriesErrorMsg(categories) {
+  const duplicateStringSlugs = getDuplicateSlugCategories(categories);
+  return `In the categories, the following slugs are duplicated: ${errorItems(
+    duplicateStringSlugs
+  )}`;
+}
+function getDuplicateSlugCategories(categories) {
+  return hasDuplicateStrings(categories.map(({ slug }) => slug));
+}
 
 // packages/models/src/lib/core-config.ts
 import { z as z11 } from "zod";
@@ -185,10 +207,10 @@ import { z as z11 } from "zod";
 import { z as z3 } from "zod";
 var formatSchema = z3.enum(["json", "md"]);
 var persistConfigSchema = z3.object({
-  outputDir: filePathSchema("Artifacts folder"),
-  filename: fileNameSchema("Artifacts file name (without extension)").default(
-    "report"
-  ),
+  outputDir: filePathSchema("Artifacts folder").optional(),
+  filename: fileNameSchema(
+    "Artifacts file name (without extension)"
+  ).optional(),
   format: z3.array(formatSchema).default(["json"]).optional()
   // @TODO remove default or optional value and otherwise it will not set defaults.
 });
@@ -424,17 +446,10 @@ var unrefinedCoreConfigSchema = z11.object({
     description: "List of plugins to be used (official, community-provided, or custom)"
   }),
   /** portal configuration for persisting results */
-  persist: persistConfigSchema,
+  persist: persistConfigSchema.optional(),
   /** portal configuration for uploading results */
   upload: uploadConfigSchema.optional(),
-  categories: z11.array(categoryConfigSchema, {
-    description: "Categorization of individual audits"
-  }).refine(
-    (categoryCfg) => !getDuplicateSlugCategories(categoryCfg),
-    (categoryCfg) => ({
-      message: duplicateSlugCategoriesErrorMsg(categoryCfg)
-    })
-  )
+  categories: categoriesSchema
 });
 var coreConfigSchema = refineCoreConfig(unrefinedCoreConfigSchema);
 function refineCoreConfig(schema) {
@@ -485,15 +500,11 @@ function getMissingRefsForCategories(coreCfg) {
   }
   return missingRefs.length ? missingRefs : false;
 }
-function duplicateSlugCategoriesErrorMsg(categories) {
-  const duplicateStringSlugs = getDuplicateSlugCategories(categories);
-  return `In the categories, the following slugs are duplicated: ${errorItems(
-    duplicateStringSlugs
-  )}`;
-}
-function getDuplicateSlugCategories(categories) {
-  return hasDuplicateStrings(categories.map(({ slug }) => slug));
-}
+
+// packages/models/src/lib/implementation/constants.ts
+var PERSIST_OUTPUT_DIR = ".code-pushup";
+var PERSIST_FORMAT = ["json"];
+var PERSIST_FILENAME = "report";
 
 // packages/models/src/lib/report.ts
 import { z as z12 } from "zod";
@@ -529,6 +540,9 @@ export {
   MAX_DESCRIPTION_LENGTH,
   MAX_SLUG_LENGTH,
   MAX_TITLE_LENGTH,
+  PERSIST_FILENAME,
+  PERSIST_FORMAT,
+  PERSIST_OUTPUT_DIR,
   auditGroupSchema,
   auditOutputsSchema,
   auditReportSchema,
@@ -536,6 +550,8 @@ export {
   categoryConfigSchema,
   categoryRefSchema,
   coreConfigSchema,
+  fileNameSchema,
+  filePathSchema,
   formatSchema,
   materialIconSchema,
   onProgressSchema,
@@ -547,5 +563,6 @@ export {
   reportSchema,
   runnerConfigSchema,
   unrefinedCoreConfigSchema,
-  uploadConfigSchema
+  uploadConfigSchema,
+  urlSchema
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/models",
-  "version": "0.4.5",
+  "version": "0.5.2",
   "dependencies": {
     "zod": "^3.22.1",
     "@code-pushup/portal-client": "^0.1.2"

package/src/index.d.ts

@@ -1,7 +1,8 @@
 export { CategoryConfig, CategoryRef, categoryConfigSchema, categoryRefSchema, } from './lib/category-config';
 export { CoreConfig, coreConfigSchema, refineCoreConfig, unrefinedCoreConfigSchema, } from './lib/core-config';
 export { MAX_DESCRIPTION_LENGTH, MAX_SLUG_LENGTH, MAX_TITLE_LENGTH, } from './lib/implementation/limits';
-export { materialIconSchema } from './lib/implementation/schemas';
+export { PERSIST_FILENAME, PERSIST_OUTPUT_DIR, PERSIST_FORMAT, } from './lib/implementation/constants';
+export { materialIconSchema, filePathSchema, fileNameSchema, urlSchema, } from './lib/implementation/schemas';
 export { Format, PersistConfig, formatSchema, persistConfigSchema, } from './lib/persist-config';
 export { PluginConfig, pluginConfigSchema, PluginMeta, } from './lib/plugin-config';
 export { Audit, auditSchema, pluginAuditsSchema, } from './lib/plugin-config-audits';

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

@@ -21,7 +21,7 @@ export declare const categoryConfigSchema: z.ZodObject<{
     title: z.ZodString;
     docsUrl: z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodString]>;
     slug: z.ZodString;
-    refs: z.ZodEffects<z.ZodArray<z.ZodObject<{
+    refs: z.ZodEffects<z.ZodEffects<z.ZodArray<z.ZodObject<{
         slug: z.ZodString;
         weight: z.ZodNumber;
         type: z.ZodEnum<["audit", "group"]>;
@@ -46,6 +46,16 @@ export declare const categoryConfigSchema: z.ZodObject<{
         slug: string;
         weight: number;
         plugin: string;
+    }[]>, {
+        type: "audit" | "group";
+        slug: string;
+        weight: number;
+        plugin: string;
+    }[], {
+        type: "audit" | "group";
+        slug: string;
+        weight: number;
+        plugin: string;
     }[]>;
     isBinary: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
@@ -75,3 +85,94 @@ 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;
+    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;
+        plugin: string;
+    }, {
+        type: "audit" | "group";
+        slug: string;
+        weight: number;
+        plugin: string;
+    }>, "many">, {
+        type: "audit" | "group";
+        slug: string;
+        weight: number;
+        plugin: string;
+    }[], {
+        type: "audit" | "group";
+        slug: string;
+        weight: number;
+        plugin: string;
+    }[]>, {
+        type: "audit" | "group";
+        slug: string;
+        weight: number;
+        plugin: string;
+    }[], {
+        type: "audit" | "group";
+        slug: string;
+        weight: number;
+        plugin: string;
+    }[]>;
+    isBinary: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    slug: string;
+    refs: {
+        type: "audit" | "group";
+        slug: string;
+        weight: number;
+        plugin: string;
+    }[];
+    description?: string | undefined;
+    docsUrl?: string | undefined;
+    isBinary?: boolean | undefined;
+}, {
+    title: string;
+    slug: string;
+    refs: {
+        type: "audit" | "group";
+        slug: string;
+        weight: number;
+        plugin: string;
+    }[];
+    description?: string | undefined;
+    docsUrl?: string | undefined;
+    isBinary?: boolean | undefined;
+}>, "many">, {
+    title: string;
+    slug: string;
+    refs: {
+        type: "audit" | "group";
+        slug: string;
+        weight: number;
+        plugin: string;
+    }[];
+    description?: string | undefined;
+    docsUrl?: string | undefined;
+    isBinary?: boolean | undefined;
+}[], {
+    title: string;
+    slug: string;
+    refs: {
+        type: "audit" | "group";
+        slug: string;
+        weight: number;
+        plugin: string;
+    }[];
+    description?: string | undefined;
+    docsUrl?: string | undefined;
+    isBinary?: boolean | undefined;
+}[]>;