@code-pushup/models/src/lib/group.d.ts

Model definitions and validators for the Code PushUp CLI

import { z } from 'zod';
export declare const groupRefSchema: z.ZodObject<{
    slug: z.ZodString;
    weight: z.ZodNumber;
}, z.core.$strip>;
/**
 * Type Definition: `GroupRef`
 *
 * This type is derived from a Zod schema and represents
 * the validated structure of `GroupRef` used within the application.
 *
 * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#groupref}
 */
export type GroupRef = z.infer<typeof groupRefSchema>;
export declare const groupMetaSchema: z.ZodObject<{
    title: z.ZodString;
    description: z.ZodOptional<z.ZodString>;
    docsUrl: z.ZodCatch<z.ZodUnion<[z.ZodOptional<z.ZodString>, z.ZodLiteral<"">]>>;
    isSkipped: z.ZodOptional<z.ZodBoolean>;
}, z.core.$strip>;
/**
 * Type Definition: `GroupMeta`
 *
 * This type is derived from a Zod schema and represents
 * the validated structure of `GroupMeta` used within the application.
 *
 * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#groupmeta}
 */
export type GroupMeta = z.infer<typeof groupMetaSchema>;
export declare const groupSchema: z.ZodObject<{
    slug: z.ZodString;
    refs: z.ZodArray<z.ZodObject<{
        slug: z.ZodString;
        weight: z.ZodNumber;
    }, 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>;
}, z.core.$strip>;
/**
 * Type Definition: `Group`
 *
 * This type is derived from a Zod schema and represents
 * the validated structure of `Group` used within the application.
 *
 * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#group}
 */
export type Group = z.infer<typeof groupSchema>;
export declare const groupsSchema: z.ZodOptional<z.ZodArray<z.ZodObject<{
    slug: z.ZodString;
    refs: z.ZodArray<z.ZodObject<{
        slug: z.ZodString;
        weight: z.ZodNumber;
    }, 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>;
}, z.core.$strip>>>;