@code-pushup/models 0.49.0 → 0.50.0

package/index.js

@@ -676,6 +676,8 @@ var auditResultSchema = scorableWithPluginMetaSchema.merge(
 );
 var reportsDiffSchema = z15.object({
   commits: makeComparisonSchema(commitSchema).nullable().describe("Commits identifying compared reports"),
+  portalUrl: urlSchema.optional().describe("Link to comparison page in Code PushUp portal"),
+  label: z15.string().optional().describe("Label (e.g. project name)"),
   categories: makeArraysComparisonSchema(
     categoryDiffSchema,
     categoryResultSchema,

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@code-pushup/models",
-  "version": "0.49.0",
+  "version": "0.50.0",
   "license": "MIT",
+  "description": "Model definitions and validators for the Code PushUp CLI",
   "dependencies": {
     "zod": "^3.22.1",
     "vscode-material-icons": "^0.1.0"
   },
-  "homepage": "https://github.com/code-pushup/cli#readme",
+  "homepage": "https://github.com/code-pushup/cli/tree/main/packages/models#readme",
   "bugs": {
     "url": "https://github.com/code-pushup/cli/issues"
   },
@@ -15,33 +16,6 @@
     "url": "git+https://github.com/code-pushup/cli.git",
     "directory": "packages/models"
   },
-  "contributors": [
-    {
-      "name": "Igor Katsuba",
-      "email": "igor@katsuba.dev",
-      "url": "https://katsuba.dev"
-    },
-    {
-      "name": "Kateřina Pilátová",
-      "email": "katerina.pilatova@flowup.cz",
-      "url": "https://github.com/Tlacenka"
-    },
-    {
-      "name": "Matěj Chalk",
-      "email": "matej.chalk@flowup.cz",
-      "url": "https://github.com/matejchalk"
-    },
-    {
-      "name": "Michael Hladky",
-      "email": "michael.hladky@push-based.io",
-      "url": "https://push-based.io"
-    },
-    {
-      "name": "Michael Seredenko",
-      "email": "misha.seredenko@push-based.io",
-      "url": "https://github.com/MishaSeredenkoPushBased"
-    }
-  ],
   "type": "module",
   "main": "./index.js",
   "types": "./src/index.d.ts"

package/src/index.d.ts

@@ -1,20 +1,20 @@
-export { TableCellValue, tableCellValueSchema, } from './lib/implementation/schemas';
-export { Audit, auditSchema } from './lib/audit';
-export { AuditDetails, AuditOutput, AuditOutputs, auditDetailsSchema, auditOutputSchema, auditOutputsSchema, } from './lib/audit-output';
-export { CategoryConfig, CategoryRef, categoryConfigSchema, categoryRefSchema, } from './lib/category-config';
-export { Commit, commitSchema } from './lib/commit';
-export { CoreConfig, coreConfigSchema } from './lib/core-config';
-export { Group, GroupRef, groupRefSchema, groupSchema } from './lib/group';
+export { type TableCellValue, tableCellValueSchema, } from './lib/implementation/schemas';
+export { type Audit, auditSchema } from './lib/audit';
+export { type AuditDetails, type AuditOutput, type AuditOutputs, auditDetailsSchema, auditOutputSchema, auditOutputsSchema, } from './lib/audit-output';
+export { type CategoryConfig, type CategoryRef, categoryConfigSchema, categoryRefSchema, } from './lib/category-config';
+export { type Commit, commitSchema } from './lib/commit';
+export { type CoreConfig, coreConfigSchema } from './lib/core-config';
+export { type Group, type GroupRef, groupRefSchema, groupSchema, } from './lib/group';
 export { CONFIG_FILE_NAME, SUPPORTED_CONFIG_FILE_FORMATS, } from './lib/implementation/configuration';
 export { DEFAULT_PERSIST_FILENAME, DEFAULT_PERSIST_FORMAT, DEFAULT_PERSIST_OUTPUT_DIR, } from './lib/implementation/constants';
 export { MAX_DESCRIPTION_LENGTH, MAX_ISSUE_MESSAGE_LENGTH, MAX_SLUG_LENGTH, MAX_TITLE_LENGTH, } from './lib/implementation/limits';
-export { MaterialIcon, materialIconSchema } from './lib/implementation/schemas';
+export { type MaterialIcon, materialIconSchema, } from './lib/implementation/schemas';
 export { exists } from './lib/implementation/utils';
-export { TableAlignment, tableAlignmentSchema, TableRowPrimitive, tableRowPrimitiveSchema, TableRowObject, tableRowObjectSchema, TableColumnPrimitive, tableColumnPrimitiveSchema, TableColumnObject, tableColumnObjectSchema, Table, tableSchema, } from './lib/table';
-export { Issue, IssueSeverity, issueSchema, issueSeveritySchema, } from './lib/issue';
-export { Format, PersistConfig, formatSchema, persistConfigSchema, } from './lib/persist-config';
-export { PluginConfig, PluginMeta, pluginConfigSchema, pluginMetaSchema, } from './lib/plugin-config';
-export { AuditReport, PluginReport, Report, auditReportSchema, pluginReportSchema, reportSchema, } from './lib/report';
-export { AuditDiff, AuditResult, CategoryDiff, CategoryResult, GroupDiff, GroupResult, ReportsDiff, auditDiffSchema, auditResultSchema, categoryDiffSchema, categoryResultSchema, groupDiffSchema, groupResultSchema, reportsDiffSchema, } from './lib/reports-diff';
-export { OnProgress, RunnerConfig, RunnerFunction, onProgressSchema, runnerConfigSchema, runnerFunctionSchema, } from './lib/runner-config';
-export { UploadConfig, uploadConfigSchema } from './lib/upload-config';
+export { type TableAlignment, tableAlignmentSchema, type TableRowPrimitive, tableRowPrimitiveSchema, type TableRowObject, tableRowObjectSchema, type TableColumnPrimitive, tableColumnPrimitiveSchema, type TableColumnObject, tableColumnObjectSchema, type Table, tableSchema, } from './lib/table';
+export { type Issue, type IssueSeverity, issueSchema, issueSeveritySchema, } from './lib/issue';
+export { type Format, type PersistConfig, formatSchema, persistConfigSchema, } from './lib/persist-config';
+export { type PluginConfig, type PluginMeta, pluginConfigSchema, pluginMetaSchema, } from './lib/plugin-config';
+export { type AuditReport, type PluginReport, type Report, auditReportSchema, pluginReportSchema, reportSchema, } from './lib/report';
+export { type AuditDiff, type AuditResult, type CategoryDiff, type CategoryResult, type GroupDiff, type GroupResult, type ReportsDiff, auditDiffSchema, auditResultSchema, categoryDiffSchema, categoryResultSchema, groupDiffSchema, groupResultSchema, reportsDiffSchema, } from './lib/reports-diff';
+export { type OnProgress, type RunnerConfig, type RunnerFunction, onProgressSchema, runnerConfigSchema, runnerFunctionSchema, } from './lib/runner-config';
+export { type UploadConfig, uploadConfigSchema } from './lib/upload-config';

package/src/lib/implementation/constants.d.ts

@@ -1,4 +1,4 @@
-import { Format } from '../persist-config';
+import type { Format } from '../persist-config';
 export declare const DEFAULT_PERSIST_OUTPUT_DIR = ".code-pushup";
 export declare const DEFAULT_PERSIST_FILENAME = "report";
 export declare const DEFAULT_PERSIST_FORMAT: Format[];

package/src/lib/implementation/schemas.d.ts

@@ -1,4 +1,4 @@
-import { ZodObject, ZodOptional, ZodString, z } from 'zod';
+import { type ZodObject, type ZodOptional, type ZodString, z } from 'zod';
 export declare const tableCellValueSchema: z.ZodDefault<z.ZodUnion<[ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>;
 export type TableCellValue = z.infer<typeof tableCellValueSchema>;
 /**

package/src/lib/reports-diff.d.ts

@@ -575,6 +575,8 @@ export declare const reportsDiffSchema: z.ZodObject<z.objectUtil.extendShape<z.o
             author: string;
         };
     }>>;
+    portalUrl: z.ZodOptional<z.ZodString>;
+    label: z.ZodOptional<z.ZodString>;
     categories: z.ZodObject<{
         changed: z.ZodArray<z.ZodObject<z.objectUtil.extendShape<{
             slug: z.ZodString;
@@ -2112,6 +2114,8 @@ export declare const reportsDiffSchema: z.ZodObject<z.objectUtil.extendShape<z.o
             author: string;
         };
     } | null;
+    label?: string | undefined;
+    portalUrl?: string | undefined;
 }, {
     date: string;
     packageName: string;
@@ -2276,5 +2280,7 @@ export declare const reportsDiffSchema: z.ZodObject<z.objectUtil.extendShape<z.o
             author: string;
         };
     } | null;
+    label?: string | undefined;
+    portalUrl?: string | undefined;
 }>;
 export type ReportsDiff = z.infer<typeof reportsDiffSchema>;