@code-pushup/models 0.106.0 → 0.107.0

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

@@ -1,5 +1,5 @@
 import { z } from 'zod/v4';
-export declare const outputTransformSchema: z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.core.$ZodTuple<[z.ZodUnknown], null>, z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
+export declare const outputTransformSchema: z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [z.ZodUnknown], null>, z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
     slug: z.ZodString;
     displayValue: z.ZodOptional<z.ZodString>;
     value: z.ZodNumber;
@@ -118,6 +118,14 @@ export declare const outputTransformSchema: z.ZodPipe<z.ZodCustom<unknown, unkno
         }, z.core.$strip>]>>>;
     }, z.core.$strip>>;
 }, z.core.$strip>>>]>>, unknown>>;
+/**
+ * Type Definition: `OutputTransform`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `OutputTransform` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#outputtransform}
+ */
 export type OutputTransform = z.infer<typeof outputTransformSchema>;
 export declare const runnerArgsSchema: z.ZodObject<{
     persist: z.ZodObject<{
@@ -130,12 +138,20 @@ export declare const runnerArgsSchema: z.ZodObject<{
         skipReports: z.ZodNonOptional<z.ZodOptional<z.ZodBoolean>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `RunnerArgs`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `RunnerArgs` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#runnerargs}
+ */
 export type RunnerArgs = z.infer<typeof runnerArgsSchema>;
 export declare const runnerConfigSchema: z.ZodObject<{
     command: z.ZodString;
     args: z.ZodOptional<z.ZodArray<z.ZodString>>;
     outputFile: z.ZodString;
-    outputTransform: z.ZodOptional<z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.core.$ZodTuple<[z.ZodUnknown], null>, z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
+    outputTransform: z.ZodOptional<z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [z.ZodUnknown], null>, z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
         slug: z.ZodString;
         displayValue: z.ZodOptional<z.ZodString>;
         value: z.ZodNumber;
@@ -256,8 +272,16 @@ export declare const runnerConfigSchema: z.ZodObject<{
     }, z.core.$strip>>>]>>, unknown>>>;
     configFile: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `RunnerConfig`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `RunnerConfig` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#runnerconfig}
+ */
 export type RunnerConfig = z.infer<typeof runnerConfigSchema>;
-export declare const runnerFunctionSchema: z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.core.$ZodTuple<[z.ZodObject<{
+export declare const runnerFunctionSchema: z.ZodPipe<z.ZodCustom<unknown, unknown>, z.ZodTransform<z.core.$InferInnerFunctionTypeAsync<z.ZodTuple<readonly [z.ZodObject<{
     persist: z.ZodObject<{
         outputDir: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
         filename: z.ZodNonOptional<z.ZodOptional<z.ZodString>>;
@@ -386,9 +410,25 @@ export declare const runnerFunctionSchema: z.ZodPipe<z.ZodCustom<unknown, unknow
         }, z.core.$strip>]>>>;
     }, z.core.$strip>>;
 }, z.core.$strip>>>]>>, unknown>>;
+/**
+ * Type Definition: `RunnerFunction`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `RunnerFunction` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#runnerfunction}
+ */
 export type RunnerFunction = z.infer<typeof runnerFunctionSchema>;
 export declare const runnerFilesPathsSchema: z.ZodObject<{
     runnerConfigPath: z.ZodString;
     runnerOutputPath: z.ZodString;
 }, z.core.$strip>;
+/**
+ * Type Definition: `RunnerFilesPaths`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `RunnerFilesPaths` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#runnerfilespaths}
+ */
 export type RunnerFilesPaths = z.infer<typeof runnerFilesPathsSchema>;

package/src/lib/source.d.ts

@@ -8,4 +8,12 @@ export declare const sourceFileLocationSchema: z.ZodObject<{
         endColumn: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `SourceFileLocation`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `SourceFileLocation` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#sourcefilelocation}
+ */
 export type SourceFileLocation = z.infer<typeof sourceFileLocationSchema>;

package/src/lib/table.d.ts

@@ -4,12 +4,28 @@ export declare const tableAlignmentSchema: z.ZodEnum<{
     center: "center";
     right: "right";
 }>;
+/**
+ * Type Definition: `TableAlignment`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `TableAlignment` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tablealignment}
+ */
 export type TableAlignment = z.infer<typeof tableAlignmentSchema>;
 export declare const tableColumnPrimitiveSchema: z.ZodEnum<{
     left: "left";
     center: "center";
     right: "right";
 }>;
+/**
+ * Type Definition: `TableColumnPrimitive`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `TableColumnPrimitive` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tablecolumnprimitive}
+ */
 export type TableColumnPrimitive = z.infer<typeof tableColumnPrimitiveSchema>;
 export declare const tableColumnObjectSchema: z.ZodObject<{
     key: z.ZodString;
@@ -20,10 +36,34 @@ export declare const tableColumnObjectSchema: z.ZodObject<{
         right: "right";
     }>>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `TableColumnObject`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `TableColumnObject` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tablecolumnobject}
+ */
 export type TableColumnObject = z.infer<typeof tableColumnObjectSchema>;
 export declare const tableRowObjectSchema: z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+/**
+ * Type Definition: `TableRowObject`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `TableRowObject` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tablerowobject}
+ */
 export type TableRowObject = z.infer<typeof tableRowObjectSchema>;
 export declare const tableRowPrimitiveSchema: z.ZodArray<z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>;
+/**
+ * Type Definition: `TableRowPrimitive`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `TableRowPrimitive` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#tablerowprimitive}
+ */
 export type TableRowPrimitive = z.infer<typeof tableRowPrimitiveSchema>;
 export declare const tableSchema: (description?: string) => z.ZodUnion<readonly [z.ZodObject<{
     title: z.ZodOptional<z.ZodString>;
@@ -50,4 +90,12 @@ export declare const tableSchema: (description?: string) => z.ZodUnion<readonly
     }, z.core.$strip>>]>>;
     rows: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodDefault<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>>>;
 }, z.core.$strip>]>;
+/**
+ * Type Definition: `Table`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `Table` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#table}
+ */
 export type Table = z.infer<ReturnType<typeof tableSchema>>;

package/src/lib/tree.d.ts

@@ -4,6 +4,14 @@ declare const basicTreeNodeDataSchema: z.ZodObject<{
     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[];
 };
@@ -15,6 +23,14 @@ export declare const coverageTreeMissingLOCSchema: z.ZodObject<{
     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;
@@ -31,6 +47,14 @@ declare const coverageTreeNodeDataSchema: z.ZodObject<{
     }, 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[];
 };
@@ -39,12 +63,28 @@ export declare const basicTreeSchema: z.ZodObject<{
     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>;
@@ -55,5 +95,13 @@ export declare const treeSchema: z.ZodUnion<readonly [z.ZodObject<{
     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 {};

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

@@ -1,9 +1,17 @@
 import { z } from 'zod';
 export declare const uploadConfigSchema: z.ZodObject<{
-    server: z.ZodString;
+    server: z.ZodURL;
     apiKey: z.ZodString;
     organization: z.ZodString;
     project: z.ZodString;
     timeout: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
+/**
+ * Type Definition: `UploadConfig`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `UploadConfig` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#uploadconfig}
+ */
 export type UploadConfig = z.infer<typeof uploadConfigSchema>;