@code-pushup/models/src/lib/category-config.d.ts

Model definitions and validators for the Code PushUp CLI

import { z } from 'zod';
export declare const categoryRefSchema: z.ZodObject<{
    slug: z.ZodString;
    weight: z.ZodNumber;
    type: z.ZodEnum<{
        audit: "audit";
        group: "group";
    }>;
    plugin: z.ZodString;
}, z.core.$strip>;
/**
 * Type Definition: `CategoryRef`
 *
 * This type is derived from a Zod schema and represents
 * the validated structure of `CategoryRef` used within the application.
 *
 * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#categoryref}
 */
export type CategoryRef = z.infer<typeof categoryRefSchema>;
export declare const categoryConfigSchema: z.ZodObject<{
    slug: z.ZodString;
    refs: z.ZodArray<z.ZodObject<{
        slug: z.ZodString;
        weight: z.ZodNumber;
        type: z.ZodEnum<{
            audit: "audit";
            group: "group";
        }>;
        plugin: z.ZodString;
    }, z.core.$strip>>;
    title: z.ZodString;
    description: z.ZodOptional<z.ZodString>;
    docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
    isSkipped: z.ZodOptional<z.ZodBoolean>;
    isBinary: z.ZodOptional<z.ZodBoolean>;
}, z.core.$strip>;
/**
 * Type Definition: `CategoryConfig`
 *
 * This type is derived from a Zod schema and represents
 * the validated structure of `CategoryConfig` used within the application.
 *
 * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#categoryconfig}
 */
export type CategoryConfig = z.infer<typeof categoryConfigSchema>;
export declare const categoriesSchema: z.ZodArray<z.ZodObject<{
    slug: z.ZodString;
    refs: z.ZodArray<z.ZodObject<{
        slug: z.ZodString;
        weight: z.ZodNumber;
        type: z.ZodEnum<{
            audit: "audit";
            group: "group";
        }>;
        plugin: z.ZodString;
    }, z.core.$strip>>;
    title: z.ZodString;
    description: z.ZodOptional<z.ZodString>;
    docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
    isSkipped: z.ZodOptional<z.ZodBoolean>;
    isBinary: z.ZodOptional<z.ZodBoolean>;
}, z.core.$strip>>;