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

Model definitions and validators for the Code PushUp CLI

import { z } from 'zod';
declare const basicTreeNodeDataSchema: z.ZodObject<{
    name: z.ZodString;
    values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
}, z.core.$strip>;
export declare const basicTreeNodeSchema: z.ZodType<BasicTreeNode>;
/**
 * Type Definition: `BasicTreeNode`
 *
 * This type is derived from a Zod schema and represents
 * the validated structure of `BasicTreeNode` used within the application.
 *
 * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#basictreenode}
 */
export type BasicTreeNode = z.infer<typeof basicTreeNodeDataSchema> & {
    children?: BasicTreeNode[];
};
export declare const coverageTreeMissingLOCSchema: z.ZodObject<{
    startLine: z.ZodNumber;
    startColumn: z.ZodOptional<z.ZodNumber>;
    endLine: z.ZodOptional<z.ZodNumber>;
    endColumn: z.ZodOptional<z.ZodNumber>;
    name: z.ZodOptional<z.ZodString>;
    kind: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
/**
 * Type Definition: `CoverageTreeMissingLOC`
 *
 * This type is derived from a Zod schema and represents
 * the validated structure of `CoverageTreeMissingLOC` used within the application.
 *
 * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#coveragetreemissingloc}
 */
export type CoverageTreeMissingLOC = z.infer<typeof coverageTreeMissingLOCSchema>;
declare const coverageTreeNodeDataSchema: z.ZodObject<{
    name: z.ZodString;
    values: z.ZodObject<{
        coverage: z.ZodNumber;
        missing: z.ZodOptional<z.ZodArray<z.ZodObject<{
            startLine: z.ZodNumber;
            startColumn: z.ZodOptional<z.ZodNumber>;
            endLine: z.ZodOptional<z.ZodNumber>;
            endColumn: z.ZodOptional<z.ZodNumber>;
            name: z.ZodOptional<z.ZodString>;
            kind: z.ZodOptional<z.ZodString>;
        }, z.core.$strip>>>;
    }, z.core.$strip>;
}, z.core.$strip>;
export declare const coverageTreeNodeSchema: z.ZodType<CoverageTreeNode>;
/**
 * Type Definition: `CoverageTreeNode`
 *
 * This type is derived from a Zod schema and represents
 * the validated structure of `CoverageTreeNode` used within the application.
 *
 * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#coveragetreenode}
 */
export type CoverageTreeNode = z.infer<typeof coverageTreeNodeDataSchema> & {
    children?: CoverageTreeNode[];
};
export declare const basicTreeSchema: z.ZodObject<{
    title: z.ZodOptional<z.ZodString>;
    type: z.ZodOptional<z.ZodLiteral<"basic">>;
    root: z.ZodType<BasicTreeNode, unknown, z.core.$ZodTypeInternals<BasicTreeNode, unknown>>;
}, z.core.$strip>;
/**
 * Type Definition: `BasicTree`
 *
 * This type is derived from a Zod schema and represents
 * the validated structure of `BasicTree` used within the application.
 *
 * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#basictree}
 */
export type BasicTree = z.infer<typeof basicTreeSchema>;
export declare const coverageTreeSchema: z.ZodObject<{
    title: z.ZodOptional<z.ZodString>;
    type: z.ZodLiteral<"coverage">;
    root: z.ZodType<CoverageTreeNode, unknown, z.core.$ZodTypeInternals<CoverageTreeNode, unknown>>;
}, z.core.$strip>;
/**
 * Type Definition: `CoverageTree`
 *
 * This type is derived from a Zod schema and represents
 * the validated structure of `CoverageTree` used within the application.
 *
 * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#coveragetree}
 */
export type CoverageTree = z.infer<typeof coverageTreeSchema>;
export declare const treeSchema: z.ZodUnion<readonly [z.ZodObject<{
    title: z.ZodOptional<z.ZodString>;
    type: z.ZodOptional<z.ZodLiteral<"basic">>;
    root: z.ZodType<BasicTreeNode, unknown, z.core.$ZodTypeInternals<BasicTreeNode, unknown>>;
}, z.core.$strip>, z.ZodObject<{
    title: z.ZodOptional<z.ZodString>;
    type: z.ZodLiteral<"coverage">;
    root: z.ZodType<CoverageTreeNode, unknown, z.core.$ZodTypeInternals<CoverageTreeNode, unknown>>;
}, z.core.$strip>]>;
/**
 * Type Definition: `Tree`
 *
 * This type is derived from a Zod schema and represents
 * the validated structure of `Tree` used within the application.
 *
 * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tree}
 */
export type Tree = z.infer<typeof treeSchema>;
export {};