@code-pushup/models 0.66.2 → 0.68.0

package/src/lib/source.js

@@ -1,14 +1,7 @@
 import { z } from 'zod';
-import { filePathSchema, positiveIntSchema } from './implementation/schemas.js';
+import { filePathSchema, filePositionSchema, } from './implementation/schemas.js';
 export const sourceFileLocationSchema = z.object({
     file: filePathSchema.describe('Relative path to source file in Git repo'),
-    position: z
-        .object({
-        startLine: positiveIntSchema.describe('Start line'),
-        startColumn: positiveIntSchema.describe('Start column').optional(),
-        endLine: positiveIntSchema.describe('End line').optional(),
-        endColumn: positiveIntSchema.describe('End column').optional(),
-    }, { description: 'Location in file' })
-        .optional(),
+    position: filePositionSchema.optional(),
 }, { description: 'Source file location' });
 //# sourceMappingURL=source.js.map

package/src/lib/source.js.map

@@ -1 +1 @@
-{"version":3,"file":"source.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/source.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAEhF,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAC9C;IACE,IAAI,EAAE,cAAc,CAAC,QAAQ,CAAC,0CAA0C,CAAC;IACzE,QAAQ,EAAE,CAAC;SACR,MAAM,CACL;QACE,SAAS,EAAE,iBAAiB,CAAC,QAAQ,CAAC,YAAY,CAAC;QACnD,WAAW,EAAE,iBAAiB,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE;QAClE,OAAO,EAAE,iBAAiB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE;QAC1D,SAAS,EAAE,iBAAiB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE;KAC/D,EACD,EAAE,WAAW,EAAE,kBAAkB,EAAE,CACpC;SACA,QAAQ,EAAE;CACd,EACD,EAAE,WAAW,EAAE,sBAAsB,EAAE,CACxC,CAAC"}
+{"version":3,"file":"source.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/source.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,cAAc,EACd,kBAAkB,GACnB,MAAM,6BAA6B,CAAC;AAErC,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAC9C;IACE,IAAI,EAAE,cAAc,CAAC,QAAQ,CAAC,0CAA0C,CAAC;IACzE,QAAQ,EAAE,kBAAkB,CAAC,QAAQ,EAAE;CACxC,EACD,EAAE,WAAW,EAAE,sBAAsB,EAAE,CACxC,CAAC"}

package/src/lib/tree.d.ts

@@ -0,0 +1,301 @@
+import { z } from 'zod';
+declare const basicTreeNodeDataSchema: z.ZodObject<{
+    name: z.ZodString;
+    values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodNumber, z.ZodString]>>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    values?: Record<string, string | number> | undefined;
+}, {
+    name: string;
+    values?: Record<string, string | number> | undefined;
+}>;
+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<z.objectUtil.extendShape<{
+    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>;
+}>, "strip", z.ZodTypeAny, {
+    startLine: number;
+    startColumn?: number | undefined;
+    endLine?: number | undefined;
+    endColumn?: number | undefined;
+    name?: string | undefined;
+    kind?: string | undefined;
+}, {
+    startLine: number;
+    startColumn?: number | undefined;
+    endLine?: number | undefined;
+    endColumn?: number | undefined;
+    name?: string | undefined;
+    kind?: string | undefined;
+}>;
+/**
+ * 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<z.objectUtil.extendShape<{
+            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>;
+        }>, "strip", z.ZodTypeAny, {
+            startLine: number;
+            startColumn?: number | undefined;
+            endLine?: number | undefined;
+            endColumn?: number | undefined;
+            name?: string | undefined;
+            kind?: string | undefined;
+        }, {
+            startLine: number;
+            startColumn?: number | undefined;
+            endLine?: number | undefined;
+            endColumn?: number | undefined;
+            name?: string | undefined;
+            kind?: string | undefined;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        coverage: number;
+        missing?: {
+            startLine: number;
+            startColumn?: number | undefined;
+            endLine?: number | undefined;
+            endColumn?: number | undefined;
+            name?: string | undefined;
+            kind?: string | undefined;
+        }[] | undefined;
+    }, {
+        coverage: number;
+        missing?: {
+            startLine: number;
+            startColumn?: number | undefined;
+            endLine?: number | undefined;
+            endColumn?: number | undefined;
+            name?: string | undefined;
+            kind?: string | undefined;
+        }[] | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    values: {
+        coverage: number;
+        missing?: {
+            startLine: number;
+            startColumn?: number | undefined;
+            endLine?: number | undefined;
+            endColumn?: number | undefined;
+            name?: string | undefined;
+            kind?: string | undefined;
+        }[] | undefined;
+    };
+    name: string;
+}, {
+    values: {
+        coverage: number;
+        missing?: {
+            startLine: number;
+            startColumn?: number | undefined;
+            endLine?: number | undefined;
+            endColumn?: number | undefined;
+            name?: string | undefined;
+            kind?: string | undefined;
+        }[] | undefined;
+    };
+    name: string;
+}>;
+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, z.ZodTypeDef, BasicTreeNode>;
+}, "strip", z.ZodTypeAny, {
+    root: {
+        name: string;
+        values?: Record<string, string | number> | undefined;
+    } & {
+        children?: BasicTreeNode[];
+    };
+    type?: "basic" | undefined;
+    title?: string | undefined;
+}, {
+    root: {
+        name: string;
+        values?: Record<string, string | number> | undefined;
+    } & {
+        children?: BasicTreeNode[];
+    };
+    type?: "basic" | undefined;
+    title?: string | undefined;
+}>;
+/**
+ * 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, z.ZodTypeDef, CoverageTreeNode>;
+}, "strip", z.ZodTypeAny, {
+    type: "coverage";
+    root: {
+        values: {
+            coverage: number;
+            missing?: {
+                startLine: number;
+                startColumn?: number | undefined;
+                endLine?: number | undefined;
+                endColumn?: number | undefined;
+                name?: string | undefined;
+                kind?: string | undefined;
+            }[] | undefined;
+        };
+        name: string;
+    } & {
+        children?: CoverageTreeNode[];
+    };
+    title?: string | undefined;
+}, {
+    type: "coverage";
+    root: {
+        values: {
+            coverage: number;
+            missing?: {
+                startLine: number;
+                startColumn?: number | undefined;
+                endLine?: number | undefined;
+                endColumn?: number | undefined;
+                name?: string | undefined;
+                kind?: string | undefined;
+            }[] | undefined;
+        };
+        name: string;
+    } & {
+        children?: CoverageTreeNode[];
+    };
+    title?: string | undefined;
+}>;
+/**
+ * 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<[z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    type: z.ZodOptional<z.ZodLiteral<"basic">>;
+    root: z.ZodType<BasicTreeNode, z.ZodTypeDef, BasicTreeNode>;
+}, "strip", z.ZodTypeAny, {
+    root: {
+        name: string;
+        values?: Record<string, string | number> | undefined;
+    } & {
+        children?: BasicTreeNode[];
+    };
+    type?: "basic" | undefined;
+    title?: string | undefined;
+}, {
+    root: {
+        name: string;
+        values?: Record<string, string | number> | undefined;
+    } & {
+        children?: BasicTreeNode[];
+    };
+    type?: "basic" | undefined;
+    title?: string | undefined;
+}>, z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"coverage">;
+    root: z.ZodType<CoverageTreeNode, z.ZodTypeDef, CoverageTreeNode>;
+}, "strip", z.ZodTypeAny, {
+    type: "coverage";
+    root: {
+        values: {
+            coverage: number;
+            missing?: {
+                startLine: number;
+                startColumn?: number | undefined;
+                endLine?: number | undefined;
+                endColumn?: number | undefined;
+                name?: string | undefined;
+                kind?: string | undefined;
+            }[] | undefined;
+        };
+        name: string;
+    } & {
+        children?: CoverageTreeNode[];
+    };
+    title?: string | undefined;
+}, {
+    type: "coverage";
+    root: {
+        values: {
+            coverage: number;
+            missing?: {
+                startLine: number;
+                startColumn?: number | undefined;
+                endLine?: number | undefined;
+                endColumn?: number | undefined;
+                name?: string | undefined;
+                kind?: string | undefined;
+            }[] | undefined;
+        };
+        name: string;
+    } & {
+        children?: CoverageTreeNode[];
+    };
+    title?: string | undefined;
+}>]>;
+/**
+ * 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/tree.js

@@ -0,0 +1,52 @@
+import { z } from 'zod';
+import { filePositionSchema } from './implementation/schemas.js';
+const basicTreeNodeValuesSchema = z.record(z.union([z.number(), z.string()]));
+const basicTreeNodeDataSchema = z.object({
+    name: z.string().min(1).describe('Text label for node'),
+    values: basicTreeNodeValuesSchema
+        .optional()
+        .describe('Additional values for node'),
+});
+export const basicTreeNodeSchema = basicTreeNodeDataSchema.extend({
+    children: z
+        .lazy(() => z.array(basicTreeNodeSchema).optional())
+        .describe('Direct descendants of this node (omit if leaf)'),
+});
+export const coverageTreeMissingLOCSchema = filePositionSchema
+    .extend({
+    name: z.string().optional().describe('Identifier of function/class/etc.'),
+    kind: z.string().optional().describe('E.g. "function", "class"'),
+})
+    .describe('Uncovered line of code, optionally referring to a named function/class/etc.');
+const coverageTreeNodeValuesSchema = z.object({
+    coverage: z.number().min(0).max(1).describe('Coverage ratio'),
+    missing: z
+        .array(coverageTreeMissingLOCSchema)
+        .optional()
+        .describe('Uncovered lines of code'),
+});
+const coverageTreeNodeDataSchema = z.object({
+    name: z.string().min(1).describe('File or folder name'),
+    values: coverageTreeNodeValuesSchema.describe('Coverage metrics for file/folder'),
+});
+export const coverageTreeNodeSchema = coverageTreeNodeDataSchema.extend({
+    children: z
+        .lazy(() => z.array(coverageTreeNodeSchema).optional())
+        .describe('Files and folders contained in this folder (omit if file)'),
+});
+export const basicTreeSchema = z
+    .object({
+    title: z.string().optional().describe('Heading'),
+    type: z.literal('basic').optional().describe('Discriminant'),
+    root: basicTreeNodeSchema.describe('Root node'),
+})
+    .describe('Generic tree');
+export const coverageTreeSchema = z
+    .object({
+    title: z.string().optional().describe('Heading'),
+    type: z.literal('coverage').describe('Discriminant'),
+    root: coverageTreeNodeSchema.describe('Root folder'),
+})
+    .describe('Coverage for files and folders');
+export const treeSchema = z.union([basicTreeSchema, coverageTreeSchema]);
+//# sourceMappingURL=tree.js.map

package/src/lib/tree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/tree.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAEjE,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;AAC9E,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,qBAAqB,CAAC;IACvD,MAAM,EAAE,yBAAyB;SAC9B,QAAQ,EAAE;SACV,QAAQ,CAAC,4BAA4B,CAAC;CAC1C,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,mBAAmB,GAC9B,uBAAuB,CAAC,MAAM,CAAC;IAC7B,QAAQ,EAAE,CAAC;SACR,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,QAAQ,EAAE,CAAC;SACnD,QAAQ,CAAC,gDAAgD,CAAC;CAC9D,CAAC,CAAC;AAKL,MAAM,CAAC,MAAM,4BAA4B,GAAG,kBAAkB;KAC3D,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC;IACzE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,0BAA0B,CAAC;CACjE,CAAC;KACD,QAAQ,CACP,6EAA6E,CAC9E,CAAC;AAKJ,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IAC7D,OAAO,EAAE,CAAC;SACP,KAAK,CAAC,4BAA4B,CAAC;SACnC,QAAQ,EAAE;SACV,QAAQ,CAAC,yBAAyB,CAAC;CACvC,CAAC,CAAC;AACH,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,qBAAqB,CAAC;IACvD,MAAM,EAAE,4BAA4B,CAAC,QAAQ,CAC3C,kCAAkC,CACnC;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,sBAAsB,GACjC,0BAA0B,CAAC,MAAM,CAAC;IAChC,QAAQ,EAAE,CAAC;SACR,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,QAAQ,EAAE,CAAC;SACtD,QAAQ,CAAC,2DAA2D,CAAC;CACzE,CAAC,CAAC;AAKL,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC;KAC7B,MAAM,CAAC;IACN,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC;IAChD,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC;IAC5D,IAAI,EAAE,mBAAmB,CAAC,QAAQ,CAAC,WAAW,CAAC;CAChD,CAAC;KACD,QAAQ,CAAC,cAAc,CAAC,CAAC;AAG5B,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,MAAM,CAAC;IACN,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC;IAChD,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC;IACpD,IAAI,EAAE,sBAAsB,CAAC,QAAQ,CAAC,aAAa,CAAC;CACrD,CAAC;KACD,QAAQ,CAAC,gCAAgC,CAAC,CAAC;AAG9C,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC,CAAC"}