@code-pushup/utils 0.19.0 → 0.20.1

package/index.js

@@ -75,25 +75,15 @@ function executionMetaSchema(options = {
     duration: z.number({ description: options.descriptionDuration })
   });
 }
-function slugSchema(description = "Unique ID (human-readable, URL-safe)") {
-  return z.string({ description }).regex(slugRegex, {
-    message: "The slug has to follow the pattern [0-9a-z] followed by multiple optional groups of -[0-9a-z]. e.g. my-slug"
-  }).max(MAX_SLUG_LENGTH, {
-    message: `slug can be max ${MAX_SLUG_LENGTH} characters long`
-  });
-}
-function descriptionSchema(description = "Description (markdown)") {
-  return z.string({ description }).max(MAX_DESCRIPTION_LENGTH).optional();
-}
-function docsUrlSchema(description = "Documentation site") {
-  return urlSchema(description).optional().or(z.string().max(0));
-}
-function urlSchema(description) {
-  return z.string({ description }).url();
-}
-function titleSchema(description = "Descriptive name") {
-  return z.string({ description }).max(MAX_TITLE_LENGTH);
-}
+var slugSchema = z.string({ description: "Unique ID (human-readable, URL-safe)" }).regex(slugRegex, {
+  message: "The slug has to follow the pattern [0-9a-z] followed by multiple optional groups of -[0-9a-z]. e.g. my-slug"
+}).max(MAX_SLUG_LENGTH, {
+  message: `slug can be max ${MAX_SLUG_LENGTH} characters long`
+});
+var descriptionSchema = z.string({ description: "Description (markdown)" }).max(MAX_DESCRIPTION_LENGTH).optional();
+var urlSchema = z.string().url();
+var docsUrlSchema = urlSchema.optional().or(z.literal("")).describe("Documentation site");
+var titleSchema = z.string({ description: "Descriptive name" }).max(MAX_TITLE_LENGTH);
 function metaSchema(options) {
   const {
     descriptionDescription,
@@ -103,24 +93,19 @@ function metaSchema(options) {
   } = options ?? {};
   return z.object(
     {
-      title: titleSchema(titleDescription),
-      description: descriptionSchema(descriptionDescription),
-      docsUrl: docsUrlSchema(docsUrlDescription)
+      title: titleDescription ? titleSchema.describe(titleDescription) : titleSchema,
+      description: descriptionDescription ? descriptionSchema.describe(descriptionDescription) : descriptionSchema,
+      docsUrl: docsUrlDescription ? docsUrlSchema.describe(docsUrlDescription) : docsUrlSchema
     },
     { description }
   );
 }
-function filePathSchema(description) {
-  return z.string({ description }).trim().min(1, { message: "path is invalid" });
-}
-function fileNameSchema(description) {
-  return z.string({ description }).trim().regex(filenameRegex, {
-    message: `The filename has to be valid`
-  }).min(1, { message: "file name is invalid" });
-}
-function positiveIntSchema(description) {
-  return z.number({ description }).int().nonnegative();
-}
+var filePathSchema = z.string().trim().min(1, { message: "path is invalid" });
+var fileNameSchema = z.string().trim().regex(filenameRegex, {
+  message: `The filename has to be valid`
+}).min(1, { message: "file name is invalid" });
+var positiveIntSchema = z.number().int().positive();
+var nonnegativeIntSchema = z.number().int().nonnegative();
 function packageVersionSchema(options) {
   const { versionDescription = "NPM version of the package", required } = options ?? {};
   const packageSchema = z.string({ description: "NPM package name" });
@@ -133,14 +118,14 @@ function packageVersionSchema(options) {
     { description: "NPM package name and version of a published package" }
   );
 }
-function weightSchema(description = "Coefficient for the given score (use weight 0 if only for display)") {
-  return positiveIntSchema(description);
-}
+var weightSchema = nonnegativeIntSchema.describe(
+  "Coefficient for the given score (use weight 0 if only for display)"
+);
 function weightedRefSchema(description, slugDescription) {
   return z.object(
     {
-      slug: slugSchema(slugDescription),
-      weight: weightSchema("Weight used to calculate score")
+      slug: slugSchema.describe(slugDescription),
+      weight: weightSchema.describe("Weight used to calculate score")
     },
     { description }
   );
@@ -148,14 +133,14 @@ function weightedRefSchema(description, slugDescription) {
 function scorableSchema(description, refSchema, duplicateCheckFn, duplicateMessageFn) {
   return z.object(
     {
-      slug: slugSchema('Human-readable unique ID, e.g. "performance"'),
+      slug: slugSchema.describe('Human-readable unique ID, e.g. "performance"'),
       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`
+      ).refine(hasNonZeroWeightedRef, () => ({
+        message: "In a category there has to be at least one ref with weight > 0"
       }))
     },
     { description }
@@ -164,13 +149,13 @@ function scorableSchema(description, refSchema, duplicateCheckFn, duplicateMessa
 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;
+function hasNonZeroWeightedRef(refs) {
+  return refs.reduce((acc, { weight }) => weight + acc, 0) !== 0;
 }
 
 // packages/models/src/lib/audit.ts
 var auditSchema = z2.object({
-  slug: slugSchema("ID (unique within plugin)")
+  slug: slugSchema.describe("ID (unique within plugin)")
 }).merge(
   metaSchema({
     titleDescription: "Descriptive name",
@@ -197,17 +182,20 @@ function getDuplicateSlugsInAudits(audits) {
   return hasDuplicateStrings(audits.map(({ slug }) => slug));
 }
 
-// packages/models/src/lib/audit-issue.ts
+// packages/models/src/lib/audit-output.ts
+import { z as z4 } from "zod";
+
+// packages/models/src/lib/issue.ts
 import { z as z3 } from "zod";
 var sourceFileLocationSchema = z3.object(
   {
-    file: filePathSchema("Relative path to source file in Git repo"),
+    file: filePathSchema.describe("Relative path to source file in Git repo"),
     position: z3.object(
       {
-        startLine: positiveIntSchema("Start line"),
-        startColumn: positiveIntSchema("Start column").optional(),
-        endLine: positiveIntSchema("End line").optional(),
-        endColumn: positiveIntSchema("End column").optional()
+        startLine: positiveIntSchema.describe("Start line"),
+        startColumn: positiveIntSchema.describe("Start column").optional(),
+        endLine: positiveIntSchema.describe("End line").optional(),
+        endColumn: positiveIntSchema.describe("End column").optional()
       },
       { description: "Location in file" }
     ).optional()
@@ -227,21 +215,21 @@ var issueSchema = z3.object(
 );
 
 // packages/models/src/lib/audit-output.ts
-import { z as z4 } from "zod";
+var auditDetailsSchema = z4.object(
+  {
+    issues: z4.array(issueSchema, { description: "List of findings" })
+  },
+  { description: "Detailed information" }
+);
 var auditOutputSchema = z4.object(
   {
-    slug: slugSchema("Reference to audit"),
+    slug: slugSchema.describe("Reference to audit"),
     displayValue: z4.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional(),
-    value: positiveIntSchema("Raw numeric value"),
+    value: nonnegativeIntSchema.describe("Raw numeric value"),
     score: z4.number({
       description: "Value between 0 and 1"
     }).min(0).max(1),
-    details: z4.object(
-      {
-        issues: z4.array(issueSchema, { description: "List of findings" })
-      },
-      { description: "Detailed information" }
-    ).optional()
+    details: auditDetailsSchema.optional()
   },
   { description: "Audit information" }
 );
@@ -271,7 +259,7 @@ var categoryRefSchema = weightedRefSchema(
     type: z5.enum(["audit", "group"], {
       description: "Discriminant for reference kind, affects where `slug` is looked up"
     }),
-    plugin: slugSchema(
+    plugin: slugSchema.describe(
       "Plugin slug (plugin should contain referenced audit or group)"
     )
   })
@@ -331,10 +319,8 @@ import { z as z11 } from "zod";
 import { z as z6 } from "zod";
 var formatSchema = z6.enum(["json", "md"]);
 var persistConfigSchema = z6.object({
-  outputDir: filePathSchema("Artifacts folder").optional(),
-  filename: fileNameSchema(
-    "Artifacts file name (without extension)"
-  ).optional(),
+  outputDir: filePathSchema.describe("Artifacts folder").optional(),
+  filename: fileNameSchema.describe("Artifacts file name (without extension)").optional(),
   format: z6.array(formatSchema).optional()
 });
 
@@ -395,7 +381,7 @@ var runnerConfigSchema = z8.object(
       description: "Shell command to execute"
     }),
     args: z8.array(z8.string({ description: "Command arguments" })).optional(),
-    outputFile: filePathSchema("Output path"),
+    outputFile: filePathSchema.describe("Output path"),
     outputTransform: outputTransformSchema.optional()
   },
   {
@@ -415,7 +401,7 @@ var pluginMetaSchema = packageVersionSchema().merge(
   })
 ).merge(
   z9.object({
-    slug: slugSchema("Unique plugin slug within core config"),
+    slug: slugSchema.describe("Unique plugin slug within core config"),
     icon: materialIconSchema
   })
 );
@@ -448,12 +434,14 @@ function getMissingRefsFromGroups(pluginCfg) {
 // packages/models/src/lib/upload-config.ts
 import { z as z10 } from "zod";
 var uploadConfigSchema = z10.object({
-  server: urlSchema("URL of deployed portal API"),
+  server: urlSchema.describe("URL of deployed portal API"),
   apiKey: z10.string({
     description: "API key with write access to portal (use `process.env` for security)"
   }),
-  organization: slugSchema("Organization slug from Code PushUp portal"),
-  project: slugSchema("Project slug from Code PushUp portal"),
+  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()
 });
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.19.0",
+  "version": "0.20.1",
   "dependencies": {
     "@code-pushup/models": "*",
     "bundle-require": "^4.0.1",