@code-pushup/models 0.81.0 → 0.83.0

package/src/lib/implementation/schemas.js

@@ -4,7 +4,8 @@ import { MAX_DESCRIPTION_LENGTH, MAX_SLUG_LENGTH, MAX_TITLE_LENGTH, } from './li
 import { filenameRegex, slugRegex } from './utils.js';
 export const tableCellValueSchema = z
     .union([z.string(), z.number(), z.boolean(), z.null()])
-    .default(null);
+    .default(null)
+    .meta({ title: 'TableCellValue' });
 /**
  * Schema for execution meta date
  */
@@ -26,15 +27,21 @@ export const slugSchema = z
     .max(MAX_SLUG_LENGTH, {
     message: `The slug can be max ${MAX_SLUG_LENGTH} characters long`,
 })
-    .describe('Unique ID (human-readable, URL-safe)');
+    .meta({
+    title: 'Slug',
+    description: 'Unique ID (human-readable, URL-safe)',
+});
 /**  Schema for a general description property */
 export const descriptionSchema = z
     .string()
     .max(MAX_DESCRIPTION_LENGTH)
-    .describe('Description (markdown)')
+    .meta({
+    title: 'Description',
+    description: 'Description (markdown)',
+})
     .optional();
 /* Schema for a URL */
-export const urlSchema = z.string().url();
+export const urlSchema = z.string().url().meta({ title: 'URL' });
 /**  Schema for a docsUrl */
 export const docsUrlSchema = urlSchema
     .optional()
@@ -51,20 +58,22 @@ export const docsUrlSchema = urlSchema
     }
     throw new ZodError(ctx.error.issues);
 })
-    .describe('Documentation site');
+    .meta({ title: 'DocsUrl', description: 'Documentation site' });
 /** Schema for a title of a plugin, category and audit */
-export const titleSchema = z
-    .string()
-    .max(MAX_TITLE_LENGTH)
-    .describe('Descriptive name');
+export const titleSchema = z.string().max(MAX_TITLE_LENGTH).meta({
+    title: 'Title',
+    description: 'Descriptive name',
+});
 /** Schema for score of audit, category or group */
-export const scoreSchema = z
-    .number()
-    .min(0)
-    .max(1)
-    .describe('Value between 0 and 1');
+export const scoreSchema = z.number().min(0).max(1).meta({
+    title: 'Score',
+    description: 'Value between 0 and 1',
+});
 /** Schema for a property indicating whether an entity is filtered out */
-export const isSkippedSchema = z.boolean().optional();
+export const isSkippedSchema = z
+    .boolean()
+    .optional()
+    .meta({ title: 'IsSkipped' });
 /**
  * Used for categories, plugins and audits
  * @param options
@@ -91,62 +100,77 @@ export function metaSchema(options) {
 export const filePathSchema = z
     .string()
     .trim()
-    .min(1, { message: 'The path is invalid' });
+    .min(1)
+    .meta({ title: 'FilePath' });
 /**
  * Regex for glob patterns - validates file paths and glob patterns
  * Allows normal paths and paths with glob metacharacters: *, **, {}, [], !, ?
  * Excludes invalid path characters: <>"|
  */
 const globRegex = /^!?[^<>"|]+$/;
-export const globPathSchema = z
-    .string()
-    .trim()
-    .min(1, { message: 'The glob pattern is invalid' })
-    .regex(globRegex, {
-    message: 'The path must be a valid file path or glob pattern (supports *, **, {}, [], !, ?)',
-})
-    .describe('Schema for a glob pattern (supports wildcards like *, **, {}, !, etc.)');
+export const globPathSchema = z.string().trim().min(1).regex(globRegex).meta({
+    title: 'GlobPath',
+    description: 'Schema for a glob pattern (supports wildcards like *, **, {}, !, etc.)',
+});
 /** Schema for a fileNameSchema */
 export const fileNameSchema = z
     .string()
     .trim()
-    .regex(filenameRegex, {
-    message: `The filename has to be valid`,
-})
-    .min(1, { message: 'The file name is invalid' });
+    .regex(filenameRegex)
+    .min(1)
+    .meta({ title: 'FileName' });
 /** Schema for a positiveInt */
-export const positiveIntSchema = z.number().int().positive();
-export const nonnegativeNumberSchema = z.number().nonnegative();
+export const positiveIntSchema = z
+    .number()
+    .int()
+    .positive()
+    .meta({ title: 'PositiveInt' });
+export const nonnegativeNumberSchema = z
+    .number()
+    .nonnegative()
+    .meta({ title: 'NonnegativeNumber' });
 export function packageVersionSchema(options) {
     const { versionDescription = 'NPM version of the package', required } = options ?? {};
-    const packageSchema = z.string().describe('NPM package name');
-    const versionSchema = z.string().describe(versionDescription);
+    const packageSchema = z.string().meta({ description: 'NPM package name' });
+    const versionSchema = z.string().meta({ description: versionDescription });
     return z
         .object({
         packageName: required ? packageSchema : packageSchema.optional(),
         version: required ? versionSchema : versionSchema.optional(),
     })
-        .describe('NPM package name and version of a published package');
+        .meta({
+        description: 'NPM package name and version of a published package',
+    });
 }
 /** Schema for a binary score threshold */
 export const scoreTargetSchema = nonnegativeNumberSchema
     .max(1)
-    .describe('Pass/fail score threshold (0-1)')
+    .meta({
+    title: 'ScoreTarget',
+    description: 'Pass/fail score threshold (0-1)',
+})
     .optional();
 /** Schema for a weight */
-export const weightSchema = nonnegativeNumberSchema.describe('Coefficient for the given score (use weight 0 if only for display)');
+export const weightSchema = nonnegativeNumberSchema.meta({
+    title: 'Weight',
+    description: 'Coefficient for the given score (use weight 0 if only for display)',
+});
 export function weightedRefSchema(description, slugDescription) {
     return z
         .object({
-        slug: slugSchema.describe(slugDescription),
-        weight: weightSchema.describe('Weight used to calculate score'),
+        slug: slugSchema.meta({ description: slugDescription }),
+        weight: weightSchema.meta({
+            description: 'Weight used to calculate score',
+        }),
     })
-        .describe(description);
+        .meta({ description });
 }
 export function scorableSchema(description, refSchema, duplicateCheckFn) {
     return z
         .object({
-        slug: slugSchema.describe('Human-readable unique ID, e.g. "performance"'),
+        slug: slugSchema.meta({
+            description: 'Human-readable unique ID, e.g. "performance"',
+        }),
         refs: z
             .array(refSchema)
             .min(1, { message: 'In a category, there has to be at least one ref' })
@@ -159,18 +183,24 @@ export function scorableSchema(description, refSchema, duplicateCheckFn) {
     })
         .describe(description);
 }
-export const materialIconSchema = z
-    .enum(MATERIAL_ICONS)
-    .describe('Icon from VSCode Material Icons extension');
+export const materialIconSchema = z.enum(MATERIAL_ICONS).meta({
+    title: 'MaterialIcon',
+    description: 'Icon from VSCode Material Icons extension',
+});
 function hasNonZeroWeightedRef(refs) {
     return refs.reduce((acc, { weight }) => weight + acc, 0) !== 0;
 }
 export const filePositionSchema = z
     .object({
-    startLine: positiveIntSchema.describe('Start line'),
-    startColumn: positiveIntSchema.describe('Start column').optional(),
-    endLine: positiveIntSchema.describe('End line').optional(),
-    endColumn: positiveIntSchema.describe('End column').optional(),
+    startLine: positiveIntSchema.meta({ description: 'Start line' }),
+    startColumn: positiveIntSchema
+        .meta({ description: 'Start column' })
+        .optional(),
+    endLine: positiveIntSchema.meta({ description: 'End line' }).optional(),
+    endColumn: positiveIntSchema.meta({ description: 'End column' }).optional(),
 })
-    .describe('Location in file');
+    .meta({
+    title: 'FilePosition',
+    description: 'Location in file',
+});
 //# sourceMappingURL=schemas.js.map

package/src/lib/implementation/schemas.js.map

@@ -1 +1 @@
-{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../../src/lib/implementation/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EACL,QAAQ,EAKR,CAAC,GACF,MAAM,KAAK,CAAC;AACb,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,gBAAgB,GACjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEtD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;KACtD,OAAO,CAAC,IAAI,CAAC,CAAC;AAGjB;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,UAGI;IACF,eAAe,EAAE,+BAA+B;IAChD,mBAAmB,EAAE,0BAA0B;CAChD;IAED,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC;QAClD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,mBAAmB,CAAC;KAC3D,CAAC,CAAC;AACL,CAAC;AAED,4DAA4D;AAC5D,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC;KACxB,MAAM,EAAE;KACR,KAAK,CAAC,SAAS,EAAE;IAChB,OAAO,EACL,6GAA6G;CAChH,CAAC;KACD,GAAG,CAAC,eAAe,EAAE;IACpB,OAAO,EAAE,uBAAuB,eAAe,kBAAkB;CAClE,CAAC;KACD,QAAQ,CAAC,sCAAsC,CAAC,CAAC;AAEpD,iDAAiD;AACjD,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,EAAE;KACR,GAAG,CAAC,sBAAsB,CAAC;KAC3B,QAAQ,CAAC,wBAAwB,CAAC;KAClC,QAAQ,EAAE,CAAC;AAEd,sBAAsB;AACtB,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;AAE1C,4BAA4B;AAC5B,MAAM,CAAC,MAAM,aAAa,GAAG,SAAS;KACnC,QAAQ,EAAE;KACV,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,yCAAyC;IAC5D,oFAAoF;KACnF,KAAK,CAAC,GAAG,CAAC,EAAE;IACX,qFAAqF;IACrF,IACE,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;QACvB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAuB,CAAA;aACpC,IAAI,EAAE;aACN,IAAI,CACH,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,gBAAgB,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CACnE,EACH,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,6BAA6B,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;QACvD,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AACvC,CAAC,CAAC;KACD,QAAQ,CAAC,oBAAoB,CAAC,CAAC;AAElC,yDAAyD;AACzD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KACzB,MAAM,EAAE;KACR,GAAG,CAAC,gBAAgB,CAAC;KACrB,QAAQ,CAAC,kBAAkB,CAAC,CAAC;AAEhC,mDAAmD;AACnD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KACzB,MAAM,EAAE;KACR,GAAG,CAAC,CAAC,CAAC;KACN,GAAG,CAAC,CAAC,CAAC;KACN,QAAQ,CAAC,uBAAuB,CAAC,CAAC;AAErC,yEAAyE;AACzE,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC;AAEtD;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,OAM1B;IACC,MAAM,EACJ,sBAAsB,EACtB,gBAAgB,EAChB,kBAAkB,EAClB,WAAW,EACX,oBAAoB,GACrB,GAAG,OAAO,IAAI,EAAE,CAAC;IAClB,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC;QACpB,KAAK,EAAE,gBAAgB;YACrB,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YACxC,CAAC,CAAC,WAAW;QACf,WAAW,EAAE,sBAAsB;YACjC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,sBAAsB,CAAC;YACpD,CAAC,CAAC,iBAAiB;QACrB,OAAO,EAAE,kBAAkB;YACzB,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,kBAAkB,CAAC;YAC5C,CAAC,CAAC,aAAa;QACjB,SAAS,EAAE,oBAAoB;YAC7B,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,oBAAoB,CAAC;YAChD,CAAC,CAAC,eAAe;KACpB,CAAC,CAAC;IACH,OAAO,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACzD,CAAC;AAED,mCAAmC;AACnC,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,EAAE;KACR,IAAI,EAAE;KACN,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,qBAAqB,EAAE,CAAC,CAAC;AAE9C;;;;GAIG;AACH,MAAM,SAAS,GAAG,cAAc,CAAC;AAEjC,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,EAAE;KACR,IAAI,EAAE;KACN,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,6BAA6B,EAAE,CAAC;KAClD,KAAK,CAAC,SAAS,EAAE;IAChB,OAAO,EACL,mFAAmF;CACtF,CAAC;KACD,QAAQ,CACP,wEAAwE,CACzE,CAAC;AAEJ,kCAAkC;AAClC,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,EAAE;KACR,IAAI,EAAE;KACN,KAAK,CAAC,aAAa,EAAE;IACpB,OAAO,EAAE,8BAA8B;CACxC,CAAC;KACD,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,0BAA0B,EAAE,CAAC,CAAC;AAEnD,+BAA+B;AAC/B,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;AAE7D,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC;AAEhE,MAAM,UAAU,oBAAoB,CAElC,OAA+D;IAC/D,MAAM,EAAE,kBAAkB,GAAG,4BAA4B,EAAE,QAAQ,EAAE,GACnE,OAAO,IAAI,EAAE,CAAC;IAChB,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAC9D,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAC9D,OAAO,CAAC;SACL,MAAM,CAAC;QACN,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE;QAChE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE;KAC7D,CAAC;SACD,QAAQ,CACP,qDAAqD,CAIvD,CAAC;AACL,CAAC;AAED,0CAA0C;AAC1C,MAAM,CAAC,MAAM,iBAAiB,GAAG,uBAAuB;KACrD,GAAG,CAAC,CAAC,CAAC;KACN,QAAQ,CAAC,iCAAiC,CAAC;KAC3C,QAAQ,EAAE,CAAC;AAEd,0BAA0B;AAC1B,MAAM,CAAC,MAAM,YAAY,GAAG,uBAAuB,CAAC,QAAQ,CAC1D,oEAAoE,CACrE,CAAC;AAEF,MAAM,UAAU,iBAAiB,CAC/B,WAAmB,EACnB,eAAuB;IAEvB,OAAO,CAAC;SACL,MAAM,CAAC;QACN,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,eAAe,CAAC;QAC1C,MAAM,EAAE,YAAY,CAAC,QAAQ,CAAC,gCAAgC,CAAC;KAChE,CAAC;SACD,QAAQ,CAAC,WAAW,CAAC,CAAC;AAC3B,CAAC;AAID,MAAM,UAAU,cAAc,CAC5B,WAAmB,EACnB,SAAY,EACZ,gBAA8C;IAE9C,OAAO,CAAC;SACL,MAAM,CAAC;QACN,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,8CAA8C,CAAC;QACzE,IAAI,EAAE,CAAC;aACJ,KAAK,CAAC,SAAS,CAAC;aAChB,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,iDAAiD,EAAE,CAAC;YACvE,kBAAkB;aACjB,KAAK,CAAC,gBAAgB,CAAC;YACxB,+BAA+B;aAC9B,MAAM,CAAC,qBAAqB,EAAE;YAC7B,KAAK,EAAE,sDAAsD;SAC9D,CAAC;KACL,CAAC;SACD,QAAQ,CAAC,WAAW,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,IAAI,CAAC,cAAc,CAAC;KACpB,QAAQ,CAAC,2CAA2C,CAAC,CAAC;AAKzD,SAAS,qBAAqB,CAAC,IAAW;IACxC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;AACjE,CAAC;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,MAAM,CAAC;IACN,SAAS,EAAE,iBAAiB,CAAC,QAAQ,CAAC,YAAY,CAAC;IACnD,WAAW,EAAE,iBAAiB,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE;IAClE,OAAO,EAAE,iBAAiB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE;IAC1D,SAAS,EAAE,iBAAiB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE;CAC/D,CAAC;KACD,QAAQ,CAAC,kBAAkB,CAAC,CAAC"}
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../../src/lib/implementation/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EACL,QAAQ,EAKR,CAAC,GACF,MAAM,KAAK,CAAC;AACb,OAAO,EACL,sBAAsB,EACtB,eAAe,EACf,gBAAgB,GACjB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEtD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;KACtD,OAAO,CAAC,IAAI,CAAC;KACb,IAAI,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC,CAAC;AAIrC;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,UAGI;IACF,eAAe,EAAE,+BAA+B;IAChD,mBAAmB,EAAE,0BAA0B;CAChD;IAED,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,eAAe,CAAC;QAClD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,mBAAmB,CAAC;KAC3D,CAAC,CAAC;AACL,CAAC;AAED,4DAA4D;AAC5D,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC;KACxB,MAAM,EAAE;KACR,KAAK,CAAC,SAAS,EAAE;IAChB,OAAO,EACL,6GAA6G;CAChH,CAAC;KACD,GAAG,CAAC,eAAe,EAAE;IACpB,OAAO,EAAE,uBAAuB,eAAe,kBAAkB;CAClE,CAAC;KACD,IAAI,CAAC;IACJ,KAAK,EAAE,MAAM;IACb,WAAW,EAAE,sCAAsC;CACpD,CAAC,CAAC;AAEL,iDAAiD;AACjD,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,EAAE;KACR,GAAG,CAAC,sBAAsB,CAAC;KAC3B,IAAI,CAAC;IACJ,KAAK,EAAE,aAAa;IACpB,WAAW,EAAE,wBAAwB;CACtC,CAAC;KACD,QAAQ,EAAE,CAAC;AAEd,sBAAsB;AACtB,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;AAEjE,4BAA4B;AAC5B,MAAM,CAAC,MAAM,aAAa,GAAG,SAAS;KACnC,QAAQ,EAAE;KACV,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,yCAAyC;IAC5D,oFAAoF;KACnF,KAAK,CAAC,GAAG,CAAC,EAAE;IACX,qFAAqF;IACrF,IACE,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;QACvB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAuB,CAAA;aACpC,IAAI,EAAE;aACN,IAAI,CACH,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,gBAAgB,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CACnE,EACH,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,6BAA6B,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;QACvD,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,IAAI,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AACvC,CAAC,CAAC;KACD,IAAI,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,oBAAoB,EAAE,CAAC,CAAC;AAEjE,yDAAyD;AACzD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC;IAC/D,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,kBAAkB;CAChC,CAAC,CAAC;AAEH,mDAAmD;AACnD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACvD,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,uBAAuB;CACrC,CAAC,CAAC;AAEH,yEAAyE;AACzE,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC7B,OAAO,EAAE;KACT,QAAQ,EAAE;KACV,IAAI,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;AAEhC;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,OAM1B;IACC,MAAM,EACJ,sBAAsB,EACtB,gBAAgB,EAChB,kBAAkB,EAClB,WAAW,EACX,oBAAoB,GACrB,GAAG,OAAO,IAAI,EAAE,CAAC;IAClB,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC;QACpB,KAAK,EAAE,gBAAgB;YACrB,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YACxC,CAAC,CAAC,WAAW;QACf,WAAW,EAAE,sBAAsB;YACjC,CAAC,CAAC,iBAAiB,CAAC,QAAQ,CAAC,sBAAsB,CAAC;YACpD,CAAC,CAAC,iBAAiB;QACrB,OAAO,EAAE,kBAAkB;YACzB,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,kBAAkB,CAAC;YAC5C,CAAC,CAAC,aAAa;QACjB,SAAS,EAAE,oBAAoB;YAC7B,CAAC,CAAC,eAAe,CAAC,QAAQ,CAAC,oBAAoB,CAAC;YAChD,CAAC,CAAC,eAAe;KACpB,CAAC,CAAC;IACH,OAAO,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACzD,CAAC;AAED,mCAAmC;AACnC,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,EAAE;KACR,IAAI,EAAE;KACN,GAAG,CAAC,CAAC,CAAC;KACN,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;AAE/B;;;;GAIG;AACH,MAAM,SAAS,GAAG,cAAc,CAAC;AAEjC,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC;IAC3E,KAAK,EAAE,UAAU;IACjB,WAAW,EACT,wEAAwE;CAC3E,CAAC,CAAC;AAEH,kCAAkC;AAClC,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,EAAE;KACR,IAAI,EAAE;KACN,KAAK,CAAC,aAAa,CAAC;KACpB,GAAG,CAAC,CAAC,CAAC;KACN,IAAI,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;AAE/B,+BAA+B;AAC/B,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,EAAE;KACR,GAAG,EAAE;KACL,QAAQ,EAAE;KACV,IAAI,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;AAElC,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC;KACrC,MAAM,EAAE;KACR,WAAW,EAAE;KACb,IAAI,CAAC,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC,CAAC;AAExC,MAAM,UAAU,oBAAoB,CAElC,OAA+D;IAC/D,MAAM,EAAE,kBAAkB,GAAG,4BAA4B,EAAE,QAAQ,EAAE,GACnE,OAAO,IAAI,EAAE,CAAC;IAChB,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAC3E,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAC3E,OAAO,CAAC;SACL,MAAM,CAAC;QACN,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE;QAChE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE;KAC7D,CAAC;SACD,IAAI,CAAC;QACJ,WAAW,EAAE,qDAAqD;KACnE,CAGD,CAAC;AACL,CAAC;AAED,0CAA0C;AAC1C,MAAM,CAAC,MAAM,iBAAiB,GAAG,uBAAuB;KACrD,GAAG,CAAC,CAAC,CAAC;KACN,IAAI,CAAC;IACJ,KAAK,EAAE,aAAa;IACpB,WAAW,EAAE,iCAAiC;CAC/C,CAAC;KACD,QAAQ,EAAE,CAAC;AAEd,0BAA0B;AAC1B,MAAM,CAAC,MAAM,YAAY,GAAG,uBAAuB,CAAC,IAAI,CAAC;IACvD,KAAK,EAAE,QAAQ;IACf,WAAW,EACT,oEAAoE;CACvE,CAAC,CAAC;AAEH,MAAM,UAAU,iBAAiB,CAC/B,WAAmB,EACnB,eAAuB;IAEvB,OAAO,CAAC;SACL,MAAM,CAAC;QACN,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC;QACvD,MAAM,EAAE,YAAY,CAAC,IAAI,CAAC;YACxB,WAAW,EAAE,gCAAgC;SAC9C,CAAC;KACH,CAAC;SACD,IAAI,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;AAC3B,CAAC;AAID,MAAM,UAAU,cAAc,CAC5B,WAAmB,EACnB,SAAY,EACZ,gBAA8C;IAE9C,OAAO,CAAC;SACL,MAAM,CAAC;QACN,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC;YACpB,WAAW,EAAE,8CAA8C;SAC5D,CAAC;QACF,IAAI,EAAE,CAAC;aACJ,KAAK,CAAC,SAAS,CAAC;aAChB,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,iDAAiD,EAAE,CAAC;YACvE,kBAAkB;aACjB,KAAK,CAAC,gBAAgB,CAAC;YACxB,+BAA+B;aAC9B,MAAM,CAAC,qBAAqB,EAAE;YAC7B,KAAK,EAAE,sDAAsD;SAC9D,CAAC;KACL,CAAC;SACD,QAAQ,CAAC,WAAW,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC;IAC5D,KAAK,EAAE,cAAc;IACrB,WAAW,EAAE,2CAA2C;CACzD,CAAC,CAAC;AAKH,SAAS,qBAAqB,CAAC,IAAW;IACxC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;AACjE,CAAC;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,MAAM,CAAC;IACN,SAAS,EAAE,iBAAiB,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC;IAChE,WAAW,EAAE,iBAAiB;SAC3B,IAAI,CAAC,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC;SACrC,QAAQ,EAAE;IACb,OAAO,EAAE,iBAAiB,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC,QAAQ,EAAE;IACvE,SAAS,EAAE,iBAAiB,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC5E,CAAC;KACD,IAAI,CAAC;IACJ,KAAK,EAAE,cAAc;IACrB,WAAW,EAAE,kBAAkB;CAChC,CAAC,CAAC"}

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

@@ -0,0 +1,30 @@
+import { ZodError, type ZodType, z } from 'zod';
+/**
+ * Type Definition: `SchemaValidationContext`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `SchemaValidationContext` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#schemavalidationcontext}
+ */
+type SchemaValidationContext = {
+    filePath?: string;
+};
+/**
+ * Autocompletes valid Zod Schema input for convience, but will accept any other data as well
+ */
+/**
+ * Type Definition: `ZodInputLooseAutocomplete`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `ZodInputLooseAutocomplete` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#zodinputlooseautocomplete}
+ */
+type ZodInputLooseAutocomplete<T extends ZodType> = z.input<T> | {} | null | undefined;
+export declare class SchemaValidationError extends Error {
+    constructor(error: ZodError, schema: ZodType, { filePath }: SchemaValidationContext);
+}
+export declare function validate<T extends ZodType>(schema: T, data: ZodInputLooseAutocomplete<T>, context?: SchemaValidationContext): z.output<T>;
+export declare function validateAsync<T extends ZodType>(schema: T, data: ZodInputLooseAutocomplete<T>, context?: SchemaValidationContext): Promise<z.output<T>>;
+export {};

package/src/lib/implementation/validate.js

@@ -0,0 +1,34 @@
+import ansis from 'ansis';
+import path from 'node:path';
+import { ZodError, z } from 'zod';
+export class SchemaValidationError extends Error {
+    constructor(error, schema, { filePath }) {
+        const formattedError = z.prettifyError(error);
+        const schemaTitle = z.globalRegistry.get(schema)?.title;
+        const summary = [
+            'Invalid',
+            schemaTitle ? ansis.bold(schemaTitle) : 'data',
+            filePath &&
+                `in ${ansis.bold(path.relative(process.cwd(), filePath))} file`,
+        ]
+            .filter(Boolean)
+            .join(' ');
+        super(`${summary}\n${formattedError}\n`);
+        this.name = SchemaValidationError.name;
+    }
+}
+export function validate(schema, data, context = {}) {
+    const result = schema.safeParse(data);
+    if (result.success) {
+        return result.data;
+    }
+    throw new SchemaValidationError(result.error, schema, context);
+}
+export async function validateAsync(schema, data, context = {}) {
+    const result = await schema.safeParseAsync(data);
+    if (result.success) {
+        return result.data;
+    }
+    throw new SchemaValidationError(result.error, schema, context);
+}
+//# sourceMappingURL=validate.js.map

package/src/lib/implementation/validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../../../src/lib/implementation/validate.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAgB,CAAC,EAAE,MAAM,KAAK,CAAC;AAehD,MAAM,OAAO,qBAAsB,SAAQ,KAAK;IAC9C,YACE,KAAe,EACf,MAAe,EACf,EAAE,QAAQ,EAA2B;QAErC,MAAM,cAAc,GAAG,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,WAAW,GAAG,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC;QACxD,MAAM,OAAO,GAAG;YACd,SAAS;YACT,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM;YAC9C,QAAQ;gBACN,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC,OAAO;SAClE;aACE,MAAM,CAAC,OAAO,CAAC;aACf,IAAI,CAAC,GAAG,CAAC,CAAC;QACb,KAAK,CAAC,GAAG,OAAO,KAAK,cAAc,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC,IAAI,CAAC;IACzC,CAAC;CACF;AAED,MAAM,UAAU,QAAQ,CACtB,MAAS,EACT,IAAkC,EAClC,UAAmC,EAAE;IAErC,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACtC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;IACD,MAAM,IAAI,qBAAqB,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AACjE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAS,EACT,IAAkC,EAClC,UAAmC,EAAE;IAErC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACjD,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;IACD,MAAM,IAAI,qBAAqB,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AACjE,CAAC"}

package/src/lib/issue.js

@@ -1,17 +1,21 @@
 import { z } from 'zod';
 import { MAX_ISSUE_MESSAGE_LENGTH } from './implementation/limits.js';
 import { sourceFileLocationSchema } from './source.js';
-export const issueSeveritySchema = z
-    .enum(['info', 'warning', 'error'])
-    .describe('Severity level');
+export const issueSeveritySchema = z.enum(['info', 'warning', 'error']).meta({
+    title: 'IssueSeverity',
+    description: 'Severity level',
+});
 export const issueSchema = z
     .object({
     message: z
         .string()
         .max(MAX_ISSUE_MESSAGE_LENGTH)
-        .describe('Descriptive error message'),
+        .meta({ description: 'Descriptive error message' }),
     severity: issueSeveritySchema,
     source: sourceFileLocationSchema.optional(),
 })
-    .describe('Issue information');
+    .meta({
+    title: 'Issue',
+    description: 'Issue information',
+});
 //# sourceMappingURL=issue.js.map

package/src/lib/issue.js.map

@@ -1 +1 @@
-{"version":3,"file":"issue.js","sourceRoot":"","sources":["../../../src/lib/issue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAEvD,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC;KACjC,IAAI,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;KAClC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;AAG9B,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KACzB,MAAM,CAAC;IACN,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,GAAG,CAAC,wBAAwB,CAAC;SAC7B,QAAQ,CAAC,2BAA2B,CAAC;IACxC,QAAQ,EAAE,mBAAmB;IAC7B,MAAM,EAAE,wBAAwB,CAAC,QAAQ,EAAE;CAC5C,CAAC;KACD,QAAQ,CAAC,mBAAmB,CAAC,CAAC"}
+{"version":3,"file":"issue.js","sourceRoot":"","sources":["../../../src/lib/issue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAEvD,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;IAC3E,KAAK,EAAE,eAAe;IACtB,WAAW,EAAE,gBAAgB;CAC9B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KACzB,MAAM,CAAC;IACN,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,GAAG,CAAC,wBAAwB,CAAC;SAC7B,IAAI,CAAC,EAAE,WAAW,EAAE,2BAA2B,EAAE,CAAC;IACrD,QAAQ,EAAE,mBAAmB;IAC7B,MAAM,EAAE,wBAAwB,CAAC,QAAQ,EAAE;CAC5C,CAAC;KACD,IAAI,CAAC;IACJ,KAAK,EAAE,OAAO;IACd,WAAW,EAAE,mBAAmB;CACjC,CAAC,CAAC"}

package/src/lib/persist-config.js

@@ -1,12 +1,16 @@
 import { z } from 'zod';
 import { fileNameSchema, filePathSchema } from './implementation/schemas.js';
-export const formatSchema = z.enum(['json', 'md']);
-export const persistConfigSchema = z.object({
-    outputDir: filePathSchema.describe('Artifacts folder').optional(),
+export const formatSchema = z.enum(['json', 'md']).meta({ title: 'Format' });
+export const persistConfigSchema = z
+    .object({
+    outputDir: filePathSchema
+        .meta({ description: 'Artifacts folder' })
+        .optional(),
     filename: fileNameSchema
-        .describe('Artifacts file name (without extension)')
+        .meta({ description: 'Artifacts file name (without extension)' })
         .optional(),
     format: z.array(formatSchema).optional(),
     skipReports: z.boolean().optional(),
-});
+})
+    .meta({ title: 'PersistConfig' });
 //# sourceMappingURL=persist-config.js.map

package/src/lib/persist-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"persist-config.js","sourceRoot":"","sources":["../../../src/lib/persist-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE7E,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;AAGnD,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,SAAS,EAAE,cAAc,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE;IACjE,QAAQ,EAAE,cAAc;SACrB,QAAQ,CAAC,yCAAyC,CAAC;SACnD,QAAQ,EAAE;IACb,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE;IACxC,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACpC,CAAC,CAAC"}
+{"version":3,"file":"persist-config.js","sourceRoot":"","sources":["../../../src/lib/persist-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE7E,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;AAG7E,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC;KACjC,MAAM,CAAC;IACN,SAAS,EAAE,cAAc;SACtB,IAAI,CAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;SACzC,QAAQ,EAAE;IACb,QAAQ,EAAE,cAAc;SACrB,IAAI,CAAC,EAAE,WAAW,EAAE,yCAAyC,EAAE,CAAC;SAChE,QAAQ,EAAE;IACb,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE;IACxC,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CACpC,CAAC;KACD,IAAI,CAAC,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,CAAC"}

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

@@ -23,6 +23,7 @@ export declare const pluginMetaSchema: z.ZodObject<{
         key: "key";
         slug: "slug";
         file: "file";
+        url: "url";
         search: "search";
         blink: "blink";
         table: "table";
@@ -447,7 +448,6 @@ export declare const pluginMetaSchema: z.ZodObject<{
         go: "go";
         python: "python";
         "python-misc": "python-misc";
-        url: "url";
         console: "console";
         powershell: "powershell";
         gradle: "gradle";
@@ -1186,6 +1186,7 @@ export declare const pluginConfigSchema: z.ZodObject<{
         key: "key";
         slug: "slug";
         file: "file";
+        url: "url";
         search: "search";
         blink: "blink";
         table: "table";
@@ -1610,7 +1611,6 @@ export declare const pluginConfigSchema: z.ZodObject<{
         go: "go";
         python: "python";
         "python-misc": "python-misc";
-        url: "url";
         console: "console";
         powershell: "powershell";
         gradle: "gradle";

package/src/lib/plugin-config.js

@@ -8,7 +8,10 @@ import { runnerConfigSchema, runnerFunctionSchema } from './runner-config.js';
 export const pluginContextSchema = z
     .record(z.string(), z.unknown())
     .optional()
-    .describe('Plugin-specific context data for helpers');
+    .meta({
+    title: 'PluginContext',
+    description: 'Plugin-specific context data for helpers',
+});
 export const pluginMetaSchema = packageVersionSchema()
     .extend(metaSchema({
     titleDescription: 'Descriptive name',
@@ -17,26 +20,35 @@ export const pluginMetaSchema = packageVersionSchema()
     description: 'Plugin metadata',
 }).shape)
     .extend({
-    slug: slugSchema.describe('Unique plugin slug within core config'),
+    slug: slugSchema.meta({
+        description: 'Unique plugin slug within core config',
+    }),
     icon: materialIconSchema,
-});
+})
+    .meta({ title: 'PluginMeta' });
 export const pluginScoreTargetsSchema = z
     .union([
     scoreTargetSchema,
     z.record(z.string(), scoreTargetSchema.nonoptional()),
 ])
-    .describe('Score targets that trigger a perfect score. Number for all audits or record { slug: target } for specific audits')
-    .optional();
-export const pluginDataSchema = z.object({
+    .optional()
+    .meta({
+    title: 'PluginScoreTargets',
+    description: 'Score targets that trigger a perfect score. Number for all audits or record { slug: target } for specific audits',
+});
+export const pluginDataSchema = z
+    .object({
     runner: z.union([runnerConfigSchema, runnerFunctionSchema]),
     audits: pluginAuditsSchema,
     groups: groupsSchema,
     scoreTargets: pluginScoreTargetsSchema,
     context: pluginContextSchema,
-});
+})
+    .meta({ title: 'PluginData' });
 export const pluginConfigSchema = pluginMetaSchema
     .extend(pluginDataSchema.shape)
-    .check(createCheck(findMissingSlugsInGroupRefs));
+    .check(createCheck(findMissingSlugsInGroupRefs))
+    .meta({ title: 'PluginConfig' });
 // every listed group ref points to an audit within the plugin
 export function findMissingSlugsInGroupRefs({ audits, groups = [] }) {
     const missingSlugs = getAuditSlugsFromGroups(audits, groups);

package/src/lib/plugin-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin-config.js","sourceRoot":"","sources":["../../../src/lib/plugin-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAc,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAc,YAAY,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EACL,kBAAkB,EAClB,UAAU,EACV,oBAAoB,EACpB,iBAAiB,EACjB,UAAU,GACX,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE9E,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC;KACjC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;KAC/B,QAAQ,EAAE;KACV,QAAQ,CAAC,0CAA0C,CAAC,CAAC;AAGxD,MAAM,CAAC,MAAM,gBAAgB,GAAG,oBAAoB,EAAE;KACnD,MAAM,CACL,UAAU,CAAC;IACT,gBAAgB,EAAE,kBAAkB;IACpC,sBAAsB,EAAE,wBAAwB;IAChD,kBAAkB,EAAE,2BAA2B;IAC/C,WAAW,EAAE,iBAAiB;CAC/B,CAAC,CAAC,KAAK,CACT;KACA,MAAM,CAAC;IACN,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,uCAAuC,CAAC;IAClE,IAAI,EAAE,kBAAkB;CACzB,CAAC,CAAC;AAGL,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACtC,KAAK,CAAC;IACL,iBAAiB;IACjB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC,WAAW,EAAE,CAAC;CACtD,CAAC;KACD,QAAQ,CACP,kHAAkH,CACnH;KACA,QAAQ,EAAE,CAAC;AAId,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAC;IAC3D,MAAM,EAAE,kBAAkB;IAC1B,MAAM,EAAE,YAAY;IACpB,YAAY,EAAE,wBAAwB;IACtC,OAAO,EAAE,mBAAmB;CAC7B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,gBAAgB;KAC/C,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC;KAC9B,KAAK,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAAC,CAAC;AAInD,8DAA8D;AAC9D,MAAM,UAAU,2BAA2B,CAEzC,EAAE,MAAM,EAAE,MAAM,GAAG,EAAE,EAAK;IAC1B,MAAM,YAAY,GAAG,uBAAuB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7D,OAAO,CACL,YAAY,IAAI;QACd,OAAO,EAAE,6DAA6D,eAAe,CACnF,YAAY,CACb,EAAE;KACJ,CACF,CAAC;AACJ,CAAC;AAED,SAAS,uBAAuB,CAAC,MAAe,EAAE,MAAe;IAC/D,OAAO,iBAAiB,CACtB,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,EAC1D,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAC/B,CAAC;AACJ,CAAC"}
+{"version":3,"file":"plugin-config.js","sourceRoot":"","sources":["../../../src/lib/plugin-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAc,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAc,YAAY,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EACL,kBAAkB,EAClB,UAAU,EACV,oBAAoB,EACpB,iBAAiB,EACjB,UAAU,GACX,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE9E,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC;KACjC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;KAC/B,QAAQ,EAAE;KACV,IAAI,CAAC;IACJ,KAAK,EAAE,eAAe;IACtB,WAAW,EAAE,0CAA0C;CACxD,CAAC,CAAC;AAIL,MAAM,CAAC,MAAM,gBAAgB,GAAG,oBAAoB,EAAE;KACnD,MAAM,CACL,UAAU,CAAC;IACT,gBAAgB,EAAE,kBAAkB;IACpC,sBAAsB,EAAE,wBAAwB;IAChD,kBAAkB,EAAE,2BAA2B;IAC/C,WAAW,EAAE,iBAAiB;CAC/B,CAAC,CAAC,KAAK,CACT;KACA,MAAM,CAAC;IACN,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC;QACpB,WAAW,EAAE,uCAAuC;KACrD,CAAC;IACF,IAAI,EAAE,kBAAkB;CACzB,CAAC;KACD,IAAI,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;AAIjC,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACtC,KAAK,CAAC;IACL,iBAAiB;IACjB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC,WAAW,EAAE,CAAC;CACtD,CAAC;KACD,QAAQ,EAAE;KACV,IAAI,CAAC;IACJ,KAAK,EAAE,oBAAoB;IAC3B,WAAW,EACT,kHAAkH;CACrH,CAAC,CAAC;AAIL,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,MAAM,CAAC;IACN,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,kBAAkB,EAAE,oBAAoB,CAAC,CAAC;IAC3D,MAAM,EAAE,kBAAkB;IAC1B,MAAM,EAAE,YAAY;IACpB,YAAY,EAAE,wBAAwB;IACtC,OAAO,EAAE,mBAAmB;CAC7B,CAAC;KACD,IAAI,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,CAAC;AAEjC,MAAM,CAAC,MAAM,kBAAkB,GAAG,gBAAgB;KAC/C,MAAM,CAAC,gBAAgB,CAAC,KAAK,CAAC;KAC9B,KAAK,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAAC;KAC/C,IAAI,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAC;AAInC,8DAA8D;AAC9D,MAAM,UAAU,2BAA2B,CAEzC,EAAE,MAAM,EAAE,MAAM,GAAG,EAAE,EAAK;IAC1B,MAAM,YAAY,GAAG,uBAAuB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7D,OAAO,CACL,YAAY,IAAI;QACd,OAAO,EAAE,6DAA6D,eAAe,CACnF,YAAY,CACb,EAAE;KACJ,CACF,CAAC;AACJ,CAAC;AAED,SAAS,uBAAuB,CAAC,MAAe,EAAE,MAAe;IAC/D,OAAO,iBAAiB,CACtB,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,EAC1D,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAC/B,CAAC;AACJ,CAAC"}

package/src/lib/report.d.ts

@@ -84,6 +84,7 @@ export declare const pluginReportSchema: z.ZodObject<{
         key: "key";
         slug: "slug";
         file: "file";
+        url: "url";
         search: "search";
         blink: "blink";
         table: "table";
@@ -508,7 +509,6 @@ export declare const pluginReportSchema: z.ZodObject<{
         go: "go";
         python: "python";
         "python-misc": "python-misc";
-        url: "url";
         console: "console";
         powershell: "powershell";
         gradle: "gradle";
@@ -1044,6 +1044,7 @@ export declare const reportSchema: z.ZodObject<{
             key: "key";
             slug: "slug";
             file: "file";
+            url: "url";
             search: "search";
             blink: "blink";
             table: "table";
@@ -1468,7 +1469,6 @@ export declare const reportSchema: z.ZodObject<{
             go: "go";
             python: "python";
             "python-misc": "python-misc";
-            url: "url";
             console: "console";
             powershell: "powershell";
             gradle: "gradle";

package/src/lib/report.js

@@ -8,7 +8,9 @@ import { createCheck } from './implementation/checks.js';
 import { executionMetaSchema, packageVersionSchema, } from './implementation/schemas.js';
 import { findMissingSlugsInCategoryRefs } from './implementation/utils.js';
 import { findMissingSlugsInGroupRefs, pluginMetaSchema, } from './plugin-config.js';
-export const auditReportSchema = auditSchema.merge(auditOutputSchema);
+export const auditReportSchema = auditSchema
+    .merge(auditOutputSchema)
+    .meta({ title: 'AuditReport' });
 export const pluginReportSchema = pluginMetaSchema
     .merge(executionMetaSchema({
     descriptionDate: 'Start date and time of plugin run',
@@ -18,7 +20,8 @@ export const pluginReportSchema = pluginMetaSchema
     audits: z.array(auditReportSchema).min(1),
     groups: z.array(groupSchema).optional(),
 }))
-    .check(createCheck(findMissingSlugsInGroupRefs));
+    .check(createCheck(findMissingSlugsInGroupRefs))
+    .meta({ title: 'PluginReport' });
 export const reportSchema = packageVersionSchema({
     versionDescription: 'NPM version of the CLI',
     required: true,
@@ -31,10 +34,16 @@ export const reportSchema = packageVersionSchema({
     plugins: z.array(pluginReportSchema).min(1),
     categories: z.array(categoryConfigSchema).optional(),
     commit: commitSchema
-        .describe('Git commit for which report was collected')
+        .meta({ description: 'Git commit for which report was collected' })
         .nullable(),
-    label: z.string().optional().describe('Label (e.g. project name)'),
+    label: z
+        .string()
+        .optional()
+        .meta({ description: 'Label (e.g. project name)' }),
 }))
     .check(createCheck(findMissingSlugsInCategoryRefs))
-    .describe('Collect output data');
+    .meta({
+    title: 'Report',
+    description: 'Collect output data',
+});
 //# sourceMappingURL=report.js.map

package/src/lib/report.js.map

@@ -1 +1 @@
-{"version":3,"file":"report.js","sourceRoot":"","sources":["../../../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,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EACL,mBAAmB,EACnB,oBAAoB,GACrB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;AAC3E,OAAO,EACL,2BAA2B,EAC3B,gBAAgB,GACjB,MAAM,oBAAoB,CAAC;AAE5B,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,KAAK,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAAC,CAAC;AAInD,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,CAAC;IACP,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;IACb,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,2BAA2B,CAAC;CACnE,CAAC,CACH;KACA,KAAK,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAAC;KAClD,QAAQ,CAAC,qBAAqB,CAAC,CAAC"}
+{"version":3,"file":"report.js","sourceRoot":"","sources":["../../../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,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EACL,mBAAmB,EACnB,oBAAoB,GACrB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;AAC3E,OAAO,EACL,2BAA2B,EAC3B,gBAAgB,GACjB,MAAM,oBAAoB,CAAC;AAE5B,MAAM,CAAC,MAAM,iBAAiB,GAAG,WAAW;KACzC,KAAK,CAAC,iBAAiB,CAAC;KACxB,IAAI,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC;AAIlC,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,KAAK,CAAC,WAAW,CAAC,2BAA2B,CAAC,CAAC;KAC/C,IAAI,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAC;AAInC,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,CAAC;IACP,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,IAAI,CAAC,EAAE,WAAW,EAAE,2CAA2C,EAAE,CAAC;SAClE,QAAQ,EAAE;IACb,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,IAAI,CAAC,EAAE,WAAW,EAAE,2BAA2B,EAAE,CAAC;CACtD,CAAC,CACH;KACA,KAAK,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAAC;KAClD,IAAI,CAAC;IACJ,KAAK,EAAE,QAAQ;IACf,WAAW,EAAE,qBAAqB;CACnC,CAAC,CAAC"}