@code-pushup/models 0.55.0 → 0.57.0

package/src/lib/core-config.js

@@ -0,0 +1,31 @@
+import { z } from 'zod';
+import { categoriesSchema } from './category-config.js';
+import { getMissingRefsForCategories, missingRefsForCategoriesErrorMsg, } from './implementation/utils.js';
+import { persistConfigSchema } from './persist-config.js';
+import { pluginConfigSchema } from './plugin-config.js';
+import { uploadConfigSchema } from './upload-config.js';
+export const unrefinedCoreConfigSchema = z.object({
+    plugins: z
+        .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 */
+    upload: uploadConfigSchema.optional(),
+    categories: categoriesSchema.optional(),
+});
+export const coreConfigSchema = refineCoreConfig(unrefinedCoreConfigSchema);
+/**
+ * Add refinements to coreConfigSchema
+ * workaround for zod issue: https://github.com/colinhacks/zod/issues/454
+ *
+ */
+export function refineCoreConfig(schema) {
+    // categories point to existing audit or group refs
+    return schema.refine(({ categories, plugins }) => !getMissingRefsForCategories(categories, plugins), ({ categories, plugins }) => ({
+        message: missingRefsForCategoriesErrorMsg(categories, plugins),
+    }));
+}
+//# sourceMappingURL=core-config.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"core-config.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/core-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EACL,2BAA2B,EAC3B,gCAAgC,GACjC,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,kBAAkB,EAAE;QACzB,WAAW,EACT,sEAAsE;KACzE,CAAC;SACD,GAAG,CAAC,CAAC,CAAC;IACT,kDAAkD;IAClD,OAAO,EAAE,mBAAmB,CAAC,QAAQ,EAAE;IACvC,iDAAiD;IACjD,MAAM,EAAE,kBAAkB,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAE,gBAAgB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,yBAAyB,CAAC,CAAC;AAE5E;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAwC;IACvE,mDAAmD;IACnD,OAAO,MAAM,CAAC,MAAM,CAClB,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,EAAE,CAC1B,CAAC,2BAA2B,CAAC,UAAU,EAAE,OAAO,CAAC,EACnD,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;QAC5B,OAAO,EAAE,gCAAgC,CAAC,UAAU,EAAE,OAAO,CAAC;KAC/D,CAAC,CACH,CAAC;AACJ,CAAC"}

package/src/lib/group.js

@@ -0,0 +1,40 @@
+import { z } from 'zod';
+import { metaSchema, scorableSchema, weightedRefSchema, } from './implementation/schemas.js';
+import { errorItems, exists, hasDuplicateStrings, } from './implementation/utils.js';
+export const groupRefSchema = weightedRefSchema('Weighted reference to a group', "Reference slug to a group within this plugin (e.g. 'max-lines')");
+export const groupMetaSchema = metaSchema({
+    titleDescription: 'Descriptive name for the group',
+    descriptionDescription: 'Description of the group (markdown)',
+    docsUrlDescription: 'Group documentation site',
+    description: 'Group metadata',
+});
+export const groupSchema = scorableSchema('A group aggregates a set of audits into a single score which can be referenced from a category. ' +
+    'E.g. the group slug "performance" groups audits and can be referenced in a category', groupRefSchema, getDuplicateRefsInGroups, duplicateRefsInGroupsErrorMsg).merge(groupMetaSchema);
+export const groupsSchema = z
+    .array(groupSchema, {
+    description: 'List of groups',
+})
+    .optional()
+    .refine(groups => !getDuplicateSlugsInGroups(groups), groups => ({
+    message: duplicateSlugsInGroupsErrorMsg(groups),
+}));
+// ============
+// helper for validator: group refs are unique
+function duplicateRefsInGroupsErrorMsg(groups) {
+    const duplicateRefs = getDuplicateRefsInGroups(groups);
+    return `In plugin groups the following references are not unique: ${errorItems(duplicateRefs)}`;
+}
+function getDuplicateRefsInGroups(groups) {
+    return hasDuplicateStrings(groups.map(({ slug: ref }) => ref).filter(exists));
+}
+// helper for validator: group refs are unique
+function duplicateSlugsInGroupsErrorMsg(groups) {
+    const duplicateRefs = getDuplicateSlugsInGroups(groups);
+    return `In groups the following slugs are not unique: ${errorItems(duplicateRefs)}`;
+}
+function getDuplicateSlugsInGroups(groups) {
+    return Array.isArray(groups)
+        ? hasDuplicateStrings(groups.map(({ slug }) => slug))
+        : false;
+}
+//# sourceMappingURL=group.js.map

package/src/lib/group.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"group.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/group.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAEL,UAAU,EACV,cAAc,EACd,iBAAiB,GAClB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,UAAU,EACV,MAAM,EACN,mBAAmB,GACpB,MAAM,2BAA2B,CAAC;AAEnC,MAAM,CAAC,MAAM,cAAc,GAAG,iBAAiB,CAC7C,+BAA+B,EAC/B,iEAAiE,CAClE,CAAC;AAGF,MAAM,CAAC,MAAM,eAAe,GAAG,UAAU,CAAC;IACxC,gBAAgB,EAAE,gCAAgC;IAClD,sBAAsB,EAAE,qCAAqC;IAC7D,kBAAkB,EAAE,0BAA0B;IAC9C,WAAW,EAAE,gBAAgB;CAC9B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,WAAW,GAAG,cAAc,CACvC,kGAAkG;IAChG,qFAAqF,EACvF,cAAc,EACd,wBAAwB,EACxB,6BAA6B,CAC9B,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;AAIzB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC;KAC1B,KAAK,CAAC,WAAW,EAAE;IAClB,WAAW,EAAE,gBAAgB;CAC9B,CAAC;KACD,QAAQ,EAAE;KACV,MAAM,CACL,MAAM,CAAC,EAAE,CAAC,CAAC,yBAAyB,CAAC,MAAM,CAAC,EAC5C,MAAM,CAAC,EAAE,CAAC,CAAC;IACT,OAAO,EAAE,8BAA8B,CAAC,MAAM,CAAC;CAChD,CAAC,CACH,CAAC;AAEJ,eAAe;AAEf,8CAA8C;AAC9C,SAAS,6BAA6B,CAAC,MAAqB;IAC1D,MAAM,aAAa,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAC;IACvD,OAAO,6DAA6D,UAAU,CAC5E,aAAa,CACd,EAAE,CAAC;AACN,CAAC;AAED,SAAS,wBAAwB,CAAC,MAAqB;IACrD,OAAO,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;AAChF,CAAC;AAED,8CAA8C;AAC9C,SAAS,8BAA8B,CAAC,MAA2B;IACjE,MAAM,aAAa,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAC;IACxD,OAAO,iDAAiD,UAAU,CAChE,aAAa,CACd,EAAE,CAAC;AACN,CAAC;AAED,SAAS,yBAAyB,CAAC,MAA2B;IAC5D,OAAO,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QAC1B,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;QACrD,CAAC,CAAC,KAAK,CAAC;AACZ,CAAC"}

package/src/lib/implementation/configuration.js

@@ -0,0 +1,3 @@
+export const CONFIG_FILE_NAME = 'code-pushup.config';
+export const SUPPORTED_CONFIG_FILE_FORMATS = ['ts', 'mjs', 'js'];
+//# sourceMappingURL=configuration.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"configuration.js","sourceRoot":"","sources":["../../../../../../packages/models/src/lib/implementation/configuration.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,gBAAgB,GAAG,oBAAoB,CAAC;AACrD,MAAM,CAAC,MAAM,6BAA6B,GAAa,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC"}

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

@@ -1,4 +1,4 @@
-import type { Format } from '../persist-config';
+import type { Format } from '../persist-config.js';
 export declare const DEFAULT_PERSIST_OUTPUT_DIR = ".code-pushup";
 export declare const DEFAULT_PERSIST_FILENAME = "report";
 export declare const DEFAULT_PERSIST_FORMAT: Format[];

package/src/lib/implementation/constants.js

@@ -0,0 +1,4 @@
+export const DEFAULT_PERSIST_OUTPUT_DIR = '.code-pushup';
+export const DEFAULT_PERSIST_FILENAME = 'report';
+export const DEFAULT_PERSIST_FORMAT = ['json', 'md'];
+//# sourceMappingURL=constants.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../../../packages/models/src/lib/implementation/constants.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,0BAA0B,GAAG,cAAc,CAAC;AACzD,MAAM,CAAC,MAAM,wBAAwB,GAAG,QAAQ,CAAC;AACjD,MAAM,CAAC,MAAM,sBAAsB,GAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC"}

package/src/lib/implementation/limits.js

@@ -0,0 +1,5 @@
+export const MAX_SLUG_LENGTH = 128;
+export const MAX_TITLE_LENGTH = 256;
+export const MAX_DESCRIPTION_LENGTH = 65_536;
+export const MAX_ISSUE_MESSAGE_LENGTH = 1024;
+//# sourceMappingURL=limits.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"limits.js","sourceRoot":"","sources":["../../../../../../packages/models/src/lib/implementation/limits.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,CAAC;AACnC,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,CAAC;AACpC,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAC7C,MAAM,CAAC,MAAM,wBAAwB,GAAG,IAAI,CAAC"}

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

@@ -63,19 +63,7 @@ export declare function packageVersionSchema<TRequired extends boolean>(options?
 }): ZodObject<{
     packageName: TRequired extends true ? ZodString : ZodOptional<ZodString>;
     version: TRequired extends true ? ZodString : ZodOptional<ZodString>;
-}, z.UnknownKeysParam, z.ZodTypeAny, z.objectUtil.addQuestionMarks<z.baseObjectOutputType<{
-    packageName: TRequired extends true ? ZodString : ZodOptional<ZodString>;
-    version: TRequired extends true ? ZodString : ZodOptional<ZodString>;
-}>, any> extends infer T ? { [k in keyof T]: z.objectUtil.addQuestionMarks<z.baseObjectOutputType<{
-    packageName: TRequired extends true ? ZodString : ZodOptional<ZodString>;
-    version: TRequired extends true ? ZodString : ZodOptional<ZodString>;
-}>, any>[k]; } : never, z.baseObjectInputType<{
-    packageName: TRequired extends true ? ZodString : ZodOptional<ZodString>;
-    version: TRequired extends true ? ZodString : ZodOptional<ZodString>;
-}> extends infer T_1 ? { [k_1 in keyof T_1]: z.baseObjectInputType<{
-    packageName: TRequired extends true ? ZodString : ZodOptional<ZodString>;
-    version: TRequired extends true ? ZodString : ZodOptional<ZodString>;
-}>[k_1]; } : never>;
+}>;
 /** Schema for a weight */
 export declare const weightSchema: z.ZodNumber;
 export declare function weightedRefSchema(description: string, slugDescription: string): ZodObject<{

package/src/lib/implementation/schemas.js

@@ -0,0 +1,128 @@
+import { MATERIAL_ICONS } from 'vscode-material-icons';
+import { z } from 'zod';
+import { MAX_DESCRIPTION_LENGTH, MAX_SLUG_LENGTH, MAX_TITLE_LENGTH, } from './limits.js';
+import { filenameRegex, slugRegex } from './utils.js';
+export const tableCellValueSchema = z
+    .union([z.string(), z.number(), z.boolean(), z.null()])
+    .default(null);
+/**
+ * Schema for execution meta date
+ */
+export function executionMetaSchema(options = {
+    descriptionDate: 'Execution start date and time',
+    descriptionDuration: 'Execution duration in ms',
+}) {
+    return z.object({
+        date: z.string({ description: options.descriptionDate }),
+        duration: z.number({ description: options.descriptionDuration }),
+    });
+}
+/** Schema for a slug of a categories, plugins or audits. */
+export const 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: `The slug can be max ${MAX_SLUG_LENGTH} characters long`,
+});
+/**  Schema for a general description property */
+export const descriptionSchema = z
+    .string({ description: 'Description (markdown)' })
+    .max(MAX_DESCRIPTION_LENGTH)
+    .optional();
+/* Schema for a URL */
+export const urlSchema = z.string().url();
+/**  Schema for a docsUrl */
+export const docsUrlSchema = urlSchema
+    .optional()
+    .or(z.literal(''))
+    .describe('Documentation site'); // allow empty string (no URL validation)
+/** Schema for a title of a plugin, category and audit */
+export const titleSchema = z
+    .string({ description: 'Descriptive name' })
+    .max(MAX_TITLE_LENGTH);
+/** Schema for score of audit, category or group */
+export const scoreSchema = z
+    .number({
+    description: 'Value between 0 and 1',
+})
+    .min(0)
+    .max(1);
+/**
+ * Used for categories, plugins and audits
+ * @param options
+ */
+export function metaSchema(options) {
+    const { descriptionDescription, titleDescription, docsUrlDescription, description, } = options ?? {};
+    return z.object({
+        title: titleDescription
+            ? titleSchema.describe(titleDescription)
+            : titleSchema,
+        description: descriptionDescription
+            ? descriptionSchema.describe(descriptionDescription)
+            : descriptionSchema,
+        docsUrl: docsUrlDescription
+            ? docsUrlSchema.describe(docsUrlDescription)
+            : docsUrlSchema,
+    }, { description });
+}
+/** Schema for a generalFilePath */
+export const filePathSchema = z
+    .string()
+    .trim()
+    .min(1, { message: 'The path is invalid' });
+/** 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' });
+/** Schema for a positiveInt */
+export const positiveIntSchema = z.number().int().positive();
+export const nonnegativeNumberSchema = z.number().nonnegative();
+export function packageVersionSchema(options) {
+    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: required ? packageSchema : packageSchema.optional(),
+        version: required ? versionSchema : versionSchema.optional(),
+    }, { description: 'NPM package name and version of a published package' });
+}
+/** Schema for a weight */
+export const weightSchema = nonnegativeNumberSchema.describe('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'),
+    }, { description });
+}
+export function scorableSchema(description, refSchema, duplicateCheckFn, duplicateMessageFn) {
+    return z.object({
+        slug: slugSchema.describe('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' })
+            // refs are unique
+            .refine(refs => !duplicateCheckFn(refs), refs => ({
+            message: duplicateMessageFn(refs),
+        }))
+            // category weights are correct
+            .refine(hasNonZeroWeightedRef, refs => {
+            const affectedRefs = refs.map(ref => ref.slug).join(', ');
+            return {
+                message: `In a category, there has to be at least one ref with weight > 0. Affected refs: ${affectedRefs}`,
+            };
+        }),
+    }, { description });
+}
+export const materialIconSchema = z.enum(MATERIAL_ICONS, {
+    description: 'Icon from VSCode Material Icons extension',
+});
+function hasNonZeroWeightedRef(refs) {
+    return refs.reduce((acc, { weight }) => weight + acc, 0) !== 0;
+}
+//# sourceMappingURL=schemas.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../../../../packages/models/src/lib/implementation/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAoD,CAAC,EAAE,MAAM,KAAK,CAAC;AAC1E,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,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,eAAe,EAAE,CAAC;QACxD,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,mBAAmB,EAAE,CAAC;KACjE,CAAC,CAAC;AACL,CAAC;AAED,4DAA4D;AAC5D,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC;KACxB,MAAM,CAAC,EAAE,WAAW,EAAE,sCAAsC,EAAE,CAAC;KAC/D,KAAK,CAAC,SAAS,EAAE;IAChB,OAAO,EACL,6GAA6G;CAChH,CAAC;KACD,GAAG,CAAC,eAAe,EAAE;IACpB,OAAO,EAAE,uBAAuB,eAAe,kBAAkB;CAClE,CAAC,CAAC;AAEL,iDAAiD;AACjD,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,CAAC,EAAE,WAAW,EAAE,wBAAwB,EAAE,CAAC;KACjD,GAAG,CAAC,sBAAsB,CAAC;KAC3B,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;KACjB,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC,yCAAyC;AAE5E,yDAAyD;AACzD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KACzB,MAAM,CAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC;KAC3C,GAAG,CAAC,gBAAgB,CAAC,CAAC;AAEzB,mDAAmD;AACnD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KACzB,MAAM,CAAC;IACN,WAAW,EAAE,uBAAuB;CACrC,CAAC;KACD,GAAG,CAAC,CAAC,CAAC;KACN,GAAG,CAAC,CAAC,CAAC,CAAC;AAEV;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,OAK1B;IACC,MAAM,EACJ,sBAAsB,EACtB,gBAAgB,EAChB,kBAAkB,EAClB,WAAW,GACZ,GAAG,OAAO,IAAI,EAAE,CAAC;IAClB,OAAO,CAAC,CAAC,MAAM,CACb;QACE,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;KAClB,EACD,EAAE,WAAW,EAAE,CAChB,CAAC;AACJ,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,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,CAA4B,OAG/D;IACC,MAAM,EAAE,kBAAkB,GAAG,4BAA4B,EAAE,QAAQ,EAAE,GACnE,OAAO,IAAI,EAAE,CAAC;IAChB,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC;IACpE,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,CAAC,CAAC;IACpE,OAAO,CAAC,CAAC,MAAM,CACb;QACE,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,EACD,EAAE,WAAW,EAAE,qDAAqD,EAAE,CAItE,CAAC;AACL,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,CAAC,MAAM,CACb;QACE,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,eAAe,CAAC;QAC1C,MAAM,EAAE,YAAY,CAAC,QAAQ,CAAC,gCAAgC,CAAC;KAChE,EACD,EAAE,WAAW,EAAE,CAChB,CAAC;AACJ,CAAC;AAID,MAAM,UAAU,cAAc,CAC5B,WAAmB,EACnB,SAAY,EACZ,gBAA6D,EAC7D,kBAAqD;IAErD,OAAO,CAAC,CAAC,MAAM,CACb;QACE,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,MAAM,CACL,IAAI,CAAC,EAAE,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAC/B,IAAI,CAAC,EAAE,CAAC,CAAC;YACP,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC;SAClC,CAAC,CACH;YACD,+BAA+B;aAC9B,MAAM,CAAC,qBAAqB,EAAE,IAAI,CAAC,EAAE;YACpC,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC1D,OAAO;gBACL,OAAO,EAAE,mFAAmF,YAAY,EAAE;aAC3G,CAAC;QACJ,CAAC,CAAC;KACL,EACD,EAAE,WAAW,EAAE,CAChB,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,IAAI,CAAC,cAAc,EAAE;IACvD,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"}

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

@@ -1,6 +1,6 @@
-import type { CategoryConfig } from '../category-config';
-import type { PluginConfig } from '../plugin-config';
-import type { PluginReport } from '../report';
+import type { CategoryConfig } from '../category-config.js';
+import type { PluginConfig } from '../plugin-config.js';
+import type { PluginReport } from '../report.js';
 /**
  * Regular expression to validate a slug for categories, plugins and audits.
  * - audit (e.g. 'max-lines')

package/src/lib/implementation/utils.js

@@ -0,0 +1,72 @@
+/**
+ * Regular expression to validate a slug for categories, plugins and audits.
+ * - audit (e.g. 'max-lines')
+ * - category (e.g. 'performance')
+ * Also validates ``and ` `
+ */
+export const slugRegex = /^[a-z\d]+(?:-[a-z\d]+)*$/;
+/**
+ * Regular expression to validate a filename.
+ */
+export const filenameRegex = /^(?!.*[ \\/:*?"<>|]).+$/;
+/**
+ * helper function to validate string arrays
+ *
+ * @param strings
+ */
+export function hasDuplicateStrings(strings) {
+    const sortedStrings = strings.toSorted();
+    const duplStrings = sortedStrings.filter((item, index) => index !== 0 && item === sortedStrings[index - 1]);
+    return duplStrings.length === 0 ? false : [...new Set(duplStrings)];
+}
+/**
+ * helper function to validate string arrays
+ *
+ * @param toCheck
+ * @param existing
+ */
+export function hasMissingStrings(toCheck, existing) {
+    const nonExisting = toCheck.filter(s => !existing.includes(s));
+    return nonExisting.length === 0 ? false : nonExisting;
+}
+/**
+ * helper for error items
+ */
+export function errorItems(items, transform = itemArr => itemArr.join(', ')) {
+    return transform(items || []);
+}
+export function exists(value) {
+    return value != null;
+}
+/**
+ * Get category references that do not point to any audit or group
+ * @param categories
+ * @param plugins
+ * @returns Array of missing references.
+ */
+export function getMissingRefsForCategories(categories, plugins) {
+    if (!categories || categories.length === 0) {
+        return false;
+    }
+    const auditRefsFromCategory = categories.flatMap(({ refs }) => refs
+        .filter(({ type }) => type === 'audit')
+        .map(({ plugin, slug }) => `${plugin}/${slug}`));
+    const auditRefsFromPlugins = plugins.flatMap(({ audits, slug: pluginSlug }) => audits.map(({ slug }) => `${pluginSlug}/${slug}`));
+    const missingAuditRefs = hasMissingStrings(auditRefsFromCategory, auditRefsFromPlugins);
+    const groupRefsFromCategory = categories.flatMap(({ refs }) => refs
+        .filter(({ type }) => type === 'group')
+        .map(({ plugin, slug }) => `${plugin}#${slug} (group)`));
+    const groupRefsFromPlugins = plugins.flatMap(({ groups, slug: pluginSlug }) => Array.isArray(groups)
+        ? groups.map(({ slug }) => `${pluginSlug}#${slug} (group)`)
+        : []);
+    const missingGroupRefs = hasMissingStrings(groupRefsFromCategory, groupRefsFromPlugins);
+    const missingRefs = [missingAuditRefs, missingGroupRefs]
+        .filter((refs) => Array.isArray(refs) && refs.length > 0)
+        .flat();
+    return missingRefs.length > 0 ? missingRefs : false;
+}
+export function missingRefsForCategoriesErrorMsg(categories, plugins) {
+    const missingRefs = getMissingRefsForCategories(categories, plugins);
+    return `The following category references need to point to an audit or group: ${errorItems(missingRefs)}`;
+}
+//# sourceMappingURL=utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../../../packages/models/src/lib/implementation/utils.ts"],"names":[],"mappings":"AAIA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,0BAA0B,CAAC;AAEpD;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,yBAAyB,CAAC;AAEvD;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAiB;IACnD,MAAM,aAAa,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IACzC,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CACtC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,CAAC,IAAI,IAAI,KAAK,aAAa,CAAC,KAAK,GAAG,CAAC,CAAC,CAClE,CAAC;IAEF,OAAO,WAAW,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;AACtE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAiB,EACjB,QAAkB;IAElB,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,OAAO,WAAW,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC;AACxD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CACxB,KAAuB,EACvB,YAA2C,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;IAExE,OAAO,SAAS,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,MAAM,CAAI,KAAQ;IAChC,OAAO,KAAK,IAAI,IAAI,CAAC;AACvB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CACzC,UAAwC,EACxC,OAAwC;IAExC,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,qBAAqB,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAC5D,IAAI;SACD,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,KAAK,OAAO,CAAC;SACtC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC,CAClD,CAAC;IACF,MAAM,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,CAC5E,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,GAAG,UAAU,IAAI,IAAI,EAAE,CAAC,CAClD,CAAC;IACF,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,qBAAqB,EACrB,oBAAoB,CACrB,CAAC;IAEF,MAAM,qBAAqB,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAC5D,IAAI;SACD,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,KAAK,OAAO,CAAC;SACtC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,GAAG,MAAM,IAAI,IAAI,UAAU,CAAC,CAC1D,CAAC;IACF,MAAM,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAC1C,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,CAC/B,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QACnB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,GAAG,UAAU,IAAI,IAAI,UAAU,CAAC;QAC3D,CAAC,CAAC,EAAE,CACT,CAAC;IACF,MAAM,gBAAgB,GAAG,iBAAiB,CACxC,qBAAqB,EACrB,oBAAoB,CACrB,CAAC;IAEF,MAAM,WAAW,GAAG,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;SACrD,MAAM,CAAC,CAAC,IAAI,EAAoB,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;SAC1E,IAAI,EAAE,CAAC;IAEV,OAAO,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,gCAAgC,CAC9C,UAAwC,EACxC,OAAwC;IAExC,MAAM,WAAW,GAAG,2BAA2B,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IACrE,OAAO,yEAAyE,UAAU,CACxF,WAAW,CACZ,EAAE,CAAC;AACN,CAAC"}

package/src/lib/issue.js

@@ -0,0 +1,14 @@
+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'], {
+    description: 'Severity level',
+});
+export const issueSchema = z.object({
+    message: z
+        .string({ description: 'Descriptive error message' })
+        .max(MAX_ISSUE_MESSAGE_LENGTH),
+    severity: issueSeveritySchema,
+    source: sourceFileLocationSchema.optional(),
+}, { description: 'Issue information' });
+//# sourceMappingURL=issue.js.map

package/src/lib/issue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"issue.js","sourceRoot":"","sources":["../../../../../packages/models/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,EAAE;IACtE,WAAW,EAAE,gBAAgB;CAC9B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CACjC;IACE,OAAO,EAAE,CAAC;SACP,MAAM,CAAC,EAAE,WAAW,EAAE,2BAA2B,EAAE,CAAC;SACpD,GAAG,CAAC,wBAAwB,CAAC;IAChC,QAAQ,EAAE,mBAAmB;IAC7B,MAAM,EAAE,wBAAwB,CAAC,QAAQ,EAAE;CAC5C,EACD,EAAE,WAAW,EAAE,mBAAmB,EAAE,CACrC,CAAC"}

package/src/lib/persist-config.js

@@ -0,0 +1,11 @@
+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(),
+    filename: fileNameSchema
+        .describe('Artifacts file name (without extension)')
+        .optional(),
+    format: z.array(formatSchema).optional(),
+});
+//# sourceMappingURL=persist-config.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"persist-config.js","sourceRoot":"","sources":["../../../../../packages/models/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;CACzC,CAAC,CAAC"}

package/src/lib/plugin-config.js

@@ -0,0 +1,37 @@
+import { z } from 'zod';
+import { pluginAuditsSchema } from './audit.js';
+import { groupsSchema } from './group.js';
+import { materialIconSchema, metaSchema, packageVersionSchema, slugSchema, } from './implementation/schemas.js';
+import { errorItems, hasMissingStrings } from './implementation/utils.js';
+import { runnerConfigSchema, runnerFunctionSchema } from './runner-config.js';
+export const pluginMetaSchema = packageVersionSchema()
+    .merge(metaSchema({
+    titleDescription: 'Descriptive name',
+    descriptionDescription: 'Description (markdown)',
+    docsUrlDescription: 'Plugin documentation site',
+    description: 'Plugin metadata',
+}))
+    .merge(z.object({
+    slug: slugSchema.describe('Unique plugin slug within core config'),
+    icon: materialIconSchema,
+}));
+export const pluginDataSchema = z.object({
+    runner: z.union([runnerConfigSchema, runnerFunctionSchema]),
+    audits: pluginAuditsSchema,
+    groups: groupsSchema,
+});
+export const pluginConfigSchema = pluginMetaSchema
+    .merge(pluginDataSchema)
+    // every listed group ref points to an audit within the plugin
+    .refine(pluginCfg => !getMissingRefsFromGroups(pluginCfg), pluginCfg => ({
+    message: missingRefsFromGroupsErrorMsg(pluginCfg),
+}));
+// helper for validator: every listed group ref points to an audit within the plugin
+function missingRefsFromGroupsErrorMsg(pluginCfg) {
+    const missingRefs = getMissingRefsFromGroups(pluginCfg);
+    return `The following group references need to point to an existing audit in this plugin config: ${errorItems(missingRefs)}`;
+}
+function getMissingRefsFromGroups(pluginCfg) {
+    return hasMissingStrings(pluginCfg.groups?.flatMap(({ refs: audits }) => audits.map(({ slug: ref }) => ref)) ?? [], pluginCfg.audits.map(({ slug }) => slug));
+}
+//# sourceMappingURL=plugin-config.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"plugin-config.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/plugin-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EACL,kBAAkB,EAClB,UAAU,EACV,oBAAoB,EACpB,UAAU,GACX,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC1E,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE9E,MAAM,CAAC,MAAM,gBAAgB,GAAG,oBAAoB,EAAE;KACnD,KAAK,CACJ,UAAU,CAAC;IACT,gBAAgB,EAAE,kBAAkB;IACpC,sBAAsB,EAAE,wBAAwB;IAChD,kBAAkB,EAAE,2BAA2B;IAC/C,WAAW,EAAE,iBAAiB;CAC/B,CAAC,CACH;KACA,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;IACP,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,uCAAuC,CAAC;IAClE,IAAI,EAAE,kBAAkB;CACzB,CAAC,CACH,CAAC;AAGJ,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;CACrB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,kBAAkB,GAAG,gBAAgB;KAC/C,KAAK,CAAC,gBAAgB,CAAC;IACxB,8DAA8D;KAC7D,MAAM,CACL,SAAS,CAAC,EAAE,CAAC,CAAC,wBAAwB,CAAC,SAAS,CAAC,EACjD,SAAS,CAAC,EAAE,CAAC,CAAC;IACZ,OAAO,EAAE,6BAA6B,CAAC,SAAS,CAAC;CAClD,CAAC,CACH,CAAC;AAIJ,oFAAoF;AACpF,SAAS,6BAA6B,CAAC,SAAqB;IAC1D,MAAM,WAAW,GAAG,wBAAwB,CAAC,SAAS,CAAC,CAAC;IACxD,OAAO,4FAA4F,UAAU,CAC3G,WAAW,CACZ,EAAE,CAAC;AACN,CAAC;AAED,SAAS,wBAAwB,CAAC,SAAqB;IACrD,OAAO,iBAAiB,CACtB,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,CAC7C,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CACnC,IAAI,EAAE,EACP,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CACzC,CAAC;AACJ,CAAC"}

package/src/lib/report.js

@@ -0,0 +1,49 @@
+import { z } from 'zod';
+import { auditOutputSchema } from './audit-output.js';
+import { auditSchema } from './audit.js';
+import { categoryConfigSchema } from './category-config.js';
+import { commitSchema } from './commit.js';
+import { groupSchema } from './group.js';
+import { executionMetaSchema, packageVersionSchema, } from './implementation/schemas.js';
+import { errorItems, getMissingRefsForCategories, hasMissingStrings, missingRefsForCategoriesErrorMsg, } from './implementation/utils.js';
+import { pluginMetaSchema } from './plugin-config.js';
+export const auditReportSchema = auditSchema.merge(auditOutputSchema);
+export const pluginReportSchema = pluginMetaSchema
+    .merge(executionMetaSchema({
+    descriptionDate: 'Start date and time of plugin run',
+    descriptionDuration: 'Duration of the plugin run in ms',
+}))
+    .merge(z.object({
+    audits: z.array(auditReportSchema).min(1),
+    groups: z.array(groupSchema).optional(),
+}))
+    .refine(pluginReport => !getMissingRefsFromGroups(pluginReport.audits, pluginReport.groups ?? []), pluginReport => ({
+    message: missingRefsFromGroupsErrorMsg(pluginReport.audits, pluginReport.groups ?? []),
+}));
+// every listed group ref points to an audit within the plugin report
+function missingRefsFromGroupsErrorMsg(audits, groups) {
+    const missingRefs = getMissingRefsFromGroups(audits, groups);
+    return `group references need to point to an existing audit in this plugin report: ${errorItems(missingRefs)}`;
+}
+function getMissingRefsFromGroups(audits, groups) {
+    return hasMissingStrings(groups.flatMap(({ refs: auditRefs }) => auditRefs.map(({ slug: ref }) => ref)), audits.map(({ slug }) => slug));
+}
+export const reportSchema = packageVersionSchema({
+    versionDescription: 'NPM version of the CLI',
+    required: true,
+})
+    .merge(executionMetaSchema({
+    descriptionDate: 'Start date and time of the collect run',
+    descriptionDuration: 'Duration of the collect run in ms',
+}))
+    .merge(z.object({
+    plugins: z.array(pluginReportSchema).min(1),
+    categories: z.array(categoryConfigSchema).optional(),
+    commit: commitSchema
+        .describe('Git commit for which report was collected')
+        .nullable(),
+}, { description: 'Collect output data' }))
+    .refine(({ categories, plugins }) => !getMissingRefsForCategories(categories, plugins), ({ categories, plugins }) => ({
+    message: missingRefsForCategoriesErrorMsg(categories, plugins),
+}));
+//# sourceMappingURL=report.js.map

package/src/lib/report.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.js","sourceRoot":"","sources":["../../../../../packages/models/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,EAAc,WAAW,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EACL,mBAAmB,EACnB,oBAAoB,GACrB,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,UAAU,EACV,2BAA2B,EAC3B,iBAAiB,EACjB,gCAAgC,GACjC,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,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,MAAM,CACL,YAAY,CAAC,EAAE,CACb,CAAC,wBAAwB,CAAC,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,IAAI,EAAE,CAAC,EAC3E,YAAY,CAAC,EAAE,CAAC,CAAC;IACf,OAAO,EAAE,6BAA6B,CACpC,YAAY,CAAC,MAAM,EACnB,YAAY,CAAC,MAAM,IAAI,EAAE,CAC1B;CACF,CAAC,CACH,CAAC;AAIJ,qEAAqE;AACrE,SAAS,6BAA6B,CAAC,MAAqB,EAAE,MAAe;IAC3E,MAAM,WAAW,GAAG,wBAAwB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7D,OAAO,8EAA8E,UAAU,CAC7F,WAAW,CACZ,EAAE,CAAC;AACN,CAAC;AAED,SAAS,wBAAwB,CAAC,MAAqB,EAAE,MAAe;IACtE,OAAO,iBAAiB,CACtB,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,CACrC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CACtC,EACD,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAC/B,CAAC;AACJ,CAAC;AAED,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,CACN;IACE,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;CACd,EACD,EAAE,WAAW,EAAE,qBAAqB,EAAE,CACvC,CACF;KACA,MAAM,CACL,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,EAAE,CAC1B,CAAC,2BAA2B,CAAC,UAAU,EAAE,OAAO,CAAC,EACnD,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5B,OAAO,EAAE,gCAAgC,CAAC,UAAU,EAAE,OAAO,CAAC;CAC/D,CAAC,CACH,CAAC"}

package/src/lib/reports-diff.js

@@ -0,0 +1,79 @@
+import { z } from 'zod';
+import { auditDisplayValueSchema, auditOutputSchema, auditValueSchema, } from './audit-output.js';
+import { commitSchema } from './commit.js';
+import { docsUrlSchema, executionMetaSchema, packageVersionSchema, scoreSchema, slugSchema, titleSchema, urlSchema, } from './implementation/schemas.js';
+import { pluginMetaSchema } from './plugin-config.js';
+function makeComparisonSchema(schema) {
+    const sharedDescription = schema.description || 'Result';
+    return z.object({
+        before: schema.describe(`${sharedDescription} (source commit)`),
+        after: schema.describe(`${sharedDescription} (target commit)`),
+    });
+}
+function makeArraysComparisonSchema(diffSchema, resultSchema, description) {
+    return z.object({
+        changed: z.array(diffSchema),
+        unchanged: z.array(resultSchema),
+        added: z.array(resultSchema),
+        removed: z.array(resultSchema),
+    }, { description });
+}
+const scorableMetaSchema = z.object({
+    slug: slugSchema,
+    title: titleSchema,
+    docsUrl: docsUrlSchema,
+});
+const scorableWithPluginMetaSchema = scorableMetaSchema.merge(z.object({
+    plugin: pluginMetaSchema
+        .pick({ slug: true, title: true, docsUrl: true })
+        .describe('Plugin which defines it'),
+}));
+const scorableDiffSchema = scorableMetaSchema.merge(z.object({
+    scores: makeComparisonSchema(scoreSchema)
+        .merge(z.object({
+        diff: z
+            .number()
+            .min(-1)
+            .max(1)
+            .describe('Score change (`scores.after - scores.before`)'),
+    }))
+        .describe('Score comparison'),
+}));
+const scorableWithPluginDiffSchema = scorableDiffSchema.merge(scorableWithPluginMetaSchema);
+export const categoryDiffSchema = scorableDiffSchema;
+export const groupDiffSchema = scorableWithPluginDiffSchema;
+export const auditDiffSchema = scorableWithPluginDiffSchema.merge(z.object({
+    values: makeComparisonSchema(auditValueSchema)
+        .merge(z.object({
+        diff: z
+            .number()
+            .describe('Value change (`values.after - values.before`)'),
+    }))
+        .describe('Audit `value` comparison'),
+    displayValues: makeComparisonSchema(auditDisplayValueSchema).describe('Audit `displayValue` comparison'),
+}));
+export const categoryResultSchema = scorableMetaSchema.merge(z.object({ score: scoreSchema }));
+export const groupResultSchema = scorableWithPluginMetaSchema.merge(z.object({ score: scoreSchema }));
+export const auditResultSchema = scorableWithPluginMetaSchema.merge(auditOutputSchema.pick({ score: true, value: true, displayValue: true }));
+export const reportsDiffSchema = z
+    .object({
+    commits: makeComparisonSchema(commitSchema)
+        .nullable()
+        .describe('Commits identifying compared reports'),
+    portalUrl: urlSchema
+        .optional()
+        .describe('Link to comparison page in Code PushUp portal'),
+    label: z.string().optional().describe('Label (e.g. project name)'),
+    categories: makeArraysComparisonSchema(categoryDiffSchema, categoryResultSchema, 'Changes affecting categories'),
+    groups: makeArraysComparisonSchema(groupDiffSchema, groupResultSchema, 'Changes affecting groups'),
+    audits: makeArraysComparisonSchema(auditDiffSchema, auditResultSchema, 'Changes affecting audits'),
+})
+    .merge(packageVersionSchema({
+    versionDescription: 'NPM version of the CLI (when `compare` was run)',
+    required: true,
+}))
+    .merge(executionMetaSchema({
+    descriptionDate: 'Start date and time of the compare run',
+    descriptionDuration: 'Duration of the compare run in ms',
+}));
+//# sourceMappingURL=reports-diff.js.map

package/src/lib/reports-diff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports-diff.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/reports-diff.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,CAAC,EAAE,MAAM,KAAK,CAAC;AACzC,OAAO,EACL,uBAAuB,EACvB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,WAAW,EACX,UAAU,EACV,WAAW,EACX,SAAS,GACV,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,SAAS,oBAAoB,CAAuB,MAAS;IAC3D,MAAM,iBAAiB,GAAG,MAAM,CAAC,WAAW,IAAI,QAAQ,CAAC;IACzD,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,iBAAiB,kBAAkB,CAAC;QAC/D,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,iBAAiB,kBAAkB,CAAC;KAC/D,CAAC,CAAC;AACL,CAAC;AAED,SAAS,0BAA0B,CAGjC,UAAiB,EAAE,YAAqB,EAAE,WAAmB;IAC7D,OAAO,CAAC,CAAC,MAAM,CACb;QACE,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;QAC5B,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC;QAChC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC;QAC5B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC;KAC/B,EACD,EAAE,WAAW,EAAE,CAChB,CAAC;AACJ,CAAC;AAED,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,IAAI,EAAE,UAAU;IAChB,KAAK,EAAE,WAAW;IAClB,OAAO,EAAE,aAAa;CACvB,CAAC,CAAC;AACH,MAAM,4BAA4B,GAAG,kBAAkB,CAAC,KAAK,CAC3D,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,gBAAgB;SACrB,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;SAChD,QAAQ,CAAC,yBAAyB,CAAC;CACvC,CAAC,CACH,CAAC;AAEF,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,KAAK,CACjD,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,oBAAoB,CAAC,WAAW,CAAC;SACtC,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,CAAC;aACJ,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC,CAAC;aACP,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,CAAC,+CAA+C,CAAC;KAC7D,CAAC,CACH;SACA,QAAQ,CAAC,kBAAkB,CAAC;CAChC,CAAC,CACH,CAAC;AACF,MAAM,4BAA4B,GAAG,kBAAkB,CAAC,KAAK,CAC3D,4BAA4B,CAC7B,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,kBAAkB,CAAC;AACrD,MAAM,CAAC,MAAM,eAAe,GAAG,4BAA4B,CAAC;AAC5D,MAAM,CAAC,MAAM,eAAe,GAAG,4BAA4B,CAAC,KAAK,CAC/D,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,oBAAoB,CAAC,gBAAgB,CAAC;SAC3C,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,CAAC;aACJ,MAAM,EAAE;aACR,QAAQ,CAAC,+CAA+C,CAAC;KAC7D,CAAC,CACH;SACA,QAAQ,CAAC,0BAA0B,CAAC;IACvC,aAAa,EAAE,oBAAoB,CAAC,uBAAuB,CAAC,CAAC,QAAQ,CACnE,iCAAiC,CAClC;CACF,CAAC,CACH,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,kBAAkB,CAAC,KAAK,CAC1D,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CACjC,CAAC;AACF,MAAM,CAAC,MAAM,iBAAiB,GAAG,4BAA4B,CAAC,KAAK,CACjE,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CACjC,CAAC;AACF,MAAM,CAAC,MAAM,iBAAiB,GAAG,4BAA4B,CAAC,KAAK,CACjE,iBAAiB,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CACzE,CAAC;AASF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,CAAC;IACN,OAAO,EAAE,oBAAoB,CAAC,YAAY,CAAC;SACxC,QAAQ,EAAE;SACV,QAAQ,CAAC,sCAAsC,CAAC;IACnD,SAAS,EAAE,SAAS;SACjB,QAAQ,EAAE;SACV,QAAQ,CAAC,+CAA+C,CAAC;IAC5D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,2BAA2B,CAAC;IAClE,UAAU,EAAE,0BAA0B,CACpC,kBAAkB,EAClB,oBAAoB,EACpB,8BAA8B,CAC/B;IACD,MAAM,EAAE,0BAA0B,CAChC,eAAe,EACf,iBAAiB,EACjB,0BAA0B,CAC3B;IACD,MAAM,EAAE,0BAA0B,CAChC,eAAe,EACf,iBAAiB,EACjB,0BAA0B,CAC3B;CACF,CAAC;KACD,KAAK,CACJ,oBAAoB,CAAC;IACnB,kBAAkB,EAAE,iDAAiD;IACrE,QAAQ,EAAE,IAAI;CACf,CAAC,CACH;KACA,KAAK,CACJ,mBAAmB,CAAC;IAClB,eAAe,EAAE,wCAAwC;IACzD,mBAAmB,EAAE,mCAAmC;CACzD,CAAC,CACH,CAAC"}

package/src/lib/runner-config.js

@@ -0,0 +1,26 @@
+import { z } from 'zod';
+import { auditOutputsSchema } from './audit-output.js';
+import { filePathSchema } from './implementation/schemas.js';
+export const outputTransformSchema = z
+    .function()
+    .args(z.unknown())
+    .returns(z.union([auditOutputsSchema, z.promise(auditOutputsSchema)]));
+export const runnerConfigSchema = z.object({
+    command: z.string({
+        description: 'Shell command to execute',
+    }),
+    args: z.array(z.string({ description: 'Command arguments' })).optional(),
+    outputFile: filePathSchema.describe('Output path'),
+    outputTransform: outputTransformSchema.optional(),
+}, {
+    description: 'How to execute runner',
+});
+export const onProgressSchema = z
+    .function()
+    .args(z.unknown())
+    .returns(z.void());
+export const runnerFunctionSchema = z
+    .function()
+    .args(onProgressSchema.optional())
+    .returns(z.union([auditOutputsSchema, z.promise(auditOutputsSchema)]));
+//# sourceMappingURL=runner-config.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"runner-config.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/runner-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE7D,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC;KACnC,QAAQ,EAAE;KACV,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;KACjB,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;AAIzE,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CACxC;IACE,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;QAChB,WAAW,EAAE,0BAA0B;KACxC,CAAC;IACF,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,mBAAmB,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IACxE,UAAU,EAAE,cAAc,CAAC,QAAQ,CAAC,aAAa,CAAC;IAClD,eAAe,EAAE,qBAAqB,CAAC,QAAQ,EAAE;CAClD,EACD;IACE,WAAW,EAAE,uBAAuB;CACrC,CACF,CAAC;AAIF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,QAAQ,EAAE;KACV,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;KACjB,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;AAGrB,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,QAAQ,EAAE;KACV,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC;KACjC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC"}