@code-pushup/models 0.56.0 → 0.58.0

package/src/lib/reports-diff.js

@@ -0,0 +1,79 @@
+import { z } from 'zod';
+import { auditDisplayValueSchema, auditOutputSchema, auditValueSchema, } from './audit-output.js';
+import { commitSchema } from './commit.js';
+import { docsUrlSchema, executionMetaSchema, packageVersionSchema, scoreSchema, slugSchema, titleSchema, urlSchema, } from './implementation/schemas.js';
+import { pluginMetaSchema } from './plugin-config.js';
+function makeComparisonSchema(schema) {
+    const sharedDescription = schema.description || 'Result';
+    return z.object({
+        before: schema.describe(`${sharedDescription} (source commit)`),
+        after: schema.describe(`${sharedDescription} (target commit)`),
+    });
+}
+function makeArraysComparisonSchema(diffSchema, resultSchema, description) {
+    return z.object({
+        changed: z.array(diffSchema),
+        unchanged: z.array(resultSchema),
+        added: z.array(resultSchema),
+        removed: z.array(resultSchema),
+    }, { description });
+}
+const scorableMetaSchema = z.object({
+    slug: slugSchema,
+    title: titleSchema,
+    docsUrl: docsUrlSchema,
+});
+const scorableWithPluginMetaSchema = scorableMetaSchema.merge(z.object({
+    plugin: pluginMetaSchema
+        .pick({ slug: true, title: true, docsUrl: true })
+        .describe('Plugin which defines it'),
+}));
+const scorableDiffSchema = scorableMetaSchema.merge(z.object({
+    scores: makeComparisonSchema(scoreSchema)
+        .merge(z.object({
+        diff: z
+            .number()
+            .min(-1)
+            .max(1)
+            .describe('Score change (`scores.after - scores.before`)'),
+    }))
+        .describe('Score comparison'),
+}));
+const scorableWithPluginDiffSchema = scorableDiffSchema.merge(scorableWithPluginMetaSchema);
+export const categoryDiffSchema = scorableDiffSchema;
+export const groupDiffSchema = scorableWithPluginDiffSchema;
+export const auditDiffSchema = scorableWithPluginDiffSchema.merge(z.object({
+    values: makeComparisonSchema(auditValueSchema)
+        .merge(z.object({
+        diff: z
+            .number()
+            .describe('Value change (`values.after - values.before`)'),
+    }))
+        .describe('Audit `value` comparison'),
+    displayValues: makeComparisonSchema(auditDisplayValueSchema).describe('Audit `displayValue` comparison'),
+}));
+export const categoryResultSchema = scorableMetaSchema.merge(z.object({ score: scoreSchema }));
+export const groupResultSchema = scorableWithPluginMetaSchema.merge(z.object({ score: scoreSchema }));
+export const auditResultSchema = scorableWithPluginMetaSchema.merge(auditOutputSchema.pick({ score: true, value: true, displayValue: true }));
+export const reportsDiffSchema = z
+    .object({
+    commits: makeComparisonSchema(commitSchema)
+        .nullable()
+        .describe('Commits identifying compared reports'),
+    portalUrl: urlSchema
+        .optional()
+        .describe('Link to comparison page in Code PushUp portal'),
+    label: z.string().optional().describe('Label (e.g. project name)'),
+    categories: makeArraysComparisonSchema(categoryDiffSchema, categoryResultSchema, 'Changes affecting categories'),
+    groups: makeArraysComparisonSchema(groupDiffSchema, groupResultSchema, 'Changes affecting groups'),
+    audits: makeArraysComparisonSchema(auditDiffSchema, auditResultSchema, 'Changes affecting audits'),
+})
+    .merge(packageVersionSchema({
+    versionDescription: 'NPM version of the CLI (when `compare` was run)',
+    required: true,
+}))
+    .merge(executionMetaSchema({
+    descriptionDate: 'Start date and time of the compare run',
+    descriptionDuration: 'Duration of the compare run in ms',
+}));
+//# sourceMappingURL=reports-diff.js.map

package/src/lib/reports-diff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reports-diff.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/reports-diff.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,CAAC,EAAE,MAAM,KAAK,CAAC;AACzC,OAAO,EACL,uBAAuB,EACvB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,oBAAoB,EACpB,WAAW,EACX,UAAU,EACV,WAAW,EACX,SAAS,GACV,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,SAAS,oBAAoB,CAAuB,MAAS;IAC3D,MAAM,iBAAiB,GAAG,MAAM,CAAC,WAAW,IAAI,QAAQ,CAAC;IACzD,OAAO,CAAC,CAAC,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,iBAAiB,kBAAkB,CAAC;QAC/D,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,iBAAiB,kBAAkB,CAAC;KAC/D,CAAC,CAAC;AACL,CAAC;AAED,SAAS,0BAA0B,CAGjC,UAAiB,EAAE,YAAqB,EAAE,WAAmB;IAC7D,OAAO,CAAC,CAAC,MAAM,CACb;QACE,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;QAC5B,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC;QAChC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC;QAC5B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC;KAC/B,EACD,EAAE,WAAW,EAAE,CAChB,CAAC;AACJ,CAAC;AAED,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,IAAI,EAAE,UAAU;IAChB,KAAK,EAAE,WAAW;IAClB,OAAO,EAAE,aAAa;CACvB,CAAC,CAAC;AACH,MAAM,4BAA4B,GAAG,kBAAkB,CAAC,KAAK,CAC3D,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,gBAAgB;SACrB,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;SAChD,QAAQ,CAAC,yBAAyB,CAAC;CACvC,CAAC,CACH,CAAC;AAEF,MAAM,kBAAkB,GAAG,kBAAkB,CAAC,KAAK,CACjD,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,oBAAoB,CAAC,WAAW,CAAC;SACtC,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,CAAC;aACJ,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC,CAAC;aACP,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,CAAC,+CAA+C,CAAC;KAC7D,CAAC,CACH;SACA,QAAQ,CAAC,kBAAkB,CAAC;CAChC,CAAC,CACH,CAAC;AACF,MAAM,4BAA4B,GAAG,kBAAkB,CAAC,KAAK,CAC3D,4BAA4B,CAC7B,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,kBAAkB,CAAC;AACrD,MAAM,CAAC,MAAM,eAAe,GAAG,4BAA4B,CAAC;AAC5D,MAAM,CAAC,MAAM,eAAe,GAAG,4BAA4B,CAAC,KAAK,CAC/D,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,oBAAoB,CAAC,gBAAgB,CAAC;SAC3C,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,CAAC;aACJ,MAAM,EAAE;aACR,QAAQ,CAAC,+CAA+C,CAAC;KAC7D,CAAC,CACH;SACA,QAAQ,CAAC,0BAA0B,CAAC;IACvC,aAAa,EAAE,oBAAoB,CAAC,uBAAuB,CAAC,CAAC,QAAQ,CACnE,iCAAiC,CAClC;CACF,CAAC,CACH,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,kBAAkB,CAAC,KAAK,CAC1D,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CACjC,CAAC;AACF,MAAM,CAAC,MAAM,iBAAiB,GAAG,4BAA4B,CAAC,KAAK,CACjE,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CACjC,CAAC;AACF,MAAM,CAAC,MAAM,iBAAiB,GAAG,4BAA4B,CAAC,KAAK,CACjE,iBAAiB,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CACzE,CAAC;AASF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAC/B,MAAM,CAAC;IACN,OAAO,EAAE,oBAAoB,CAAC,YAAY,CAAC;SACxC,QAAQ,EAAE;SACV,QAAQ,CAAC,sCAAsC,CAAC;IACnD,SAAS,EAAE,SAAS;SACjB,QAAQ,EAAE;SACV,QAAQ,CAAC,+CAA+C,CAAC;IAC5D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,2BAA2B,CAAC;IAClE,UAAU,EAAE,0BAA0B,CACpC,kBAAkB,EAClB,oBAAoB,EACpB,8BAA8B,CAC/B;IACD,MAAM,EAAE,0BAA0B,CAChC,eAAe,EACf,iBAAiB,EACjB,0BAA0B,CAC3B;IACD,MAAM,EAAE,0BAA0B,CAChC,eAAe,EACf,iBAAiB,EACjB,0BAA0B,CAC3B;CACF,CAAC;KACD,KAAK,CACJ,oBAAoB,CAAC;IACnB,kBAAkB,EAAE,iDAAiD;IACrE,QAAQ,EAAE,IAAI;CACf,CAAC,CACH;KACA,KAAK,CACJ,mBAAmB,CAAC;IAClB,eAAe,EAAE,wCAAwC;IACzD,mBAAmB,EAAE,mCAAmC;CACzD,CAAC,CACH,CAAC"}

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

@@ -606,6 +606,14 @@ export declare const outputTransformSchema: z.ZodFunction<z.ZodTuple<[z.ZodUnkno
         } | undefined;
     } | undefined;
 }[]>>]>>;
+/**
+ * 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 runnerConfigSchema: z.ZodObject<{
     command: z.ZodString;
@@ -1218,6 +1226,7 @@ export declare const runnerConfigSchema: z.ZodObject<{
             } | undefined;
         } | undefined;
     }[]>>]>>>;
+    configFile: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     command: string;
     outputFile: string;
@@ -1289,6 +1298,7 @@ export declare const runnerConfigSchema: z.ZodObject<{
             } | undefined;
         } | undefined;
     }[]>) | undefined;
+    configFile?: string | undefined;
 }, {
     command: string;
     outputFile: string;
@@ -1360,9 +1370,26 @@ export declare const runnerConfigSchema: z.ZodObject<{
             } | undefined;
         } | undefined;
     }[]>) | undefined;
+    configFile?: string | undefined;
 }>;
+/**
+ * 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 onProgressSchema: z.ZodFunction<z.ZodTuple<[z.ZodUnknown], z.ZodUnknown>, z.ZodVoid>;
+/**
+ * Type Definition: `OnProgress`
+ *
+ * This type is derived from a Zod schema and represents
+ * the validated structure of `OnProgress` used within the application.
+ *
+ * @see {@link https://github.com/code-pushup/cli/blob/main/packages/models/docs/models-reference.md#onprogress}
+ */
 export type OnProgress = z.infer<typeof onProgressSchema>;
 export declare const runnerFunctionSchema: z.ZodFunction<z.ZodTuple<[z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodUnknown], z.ZodUnknown>, z.ZodVoid>>], z.ZodUnknown>, z.ZodUnion<[z.ZodEffects<z.ZodArray<z.ZodObject<{
     slug: z.ZodString;
@@ -1971,4 +1998,31 @@ export declare const runnerFunctionSchema: z.ZodFunction<z.ZodTuple<[z.ZodOption
         } | undefined;
     } | undefined;
 }[]>>]>>;
+/**
+ * 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;
+}, "strip", z.ZodTypeAny, {
+    runnerConfigPath: string;
+    runnerOutputPath: string;
+}, {
+    runnerConfigPath: string;
+    runnerOutputPath: string;
+}>;
+/**
+ * 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/runner-config.js

@@ -0,0 +1,31 @@
+import { z } from 'zod';
+import { auditOutputsSchema } from './audit-output.js';
+import { filePathSchema } from './implementation/schemas.js';
+export const outputTransformSchema = z
+    .function()
+    .args(z.unknown())
+    .returns(z.union([auditOutputsSchema, z.promise(auditOutputsSchema)]));
+export const runnerConfigSchema = z.object({
+    command: z.string({
+        description: 'Shell command to execute',
+    }),
+    args: z.array(z.string({ description: 'Command arguments' })).optional(),
+    outputFile: filePathSchema.describe('Runner output path'),
+    outputTransform: outputTransformSchema.optional(),
+    configFile: filePathSchema.describe('Runner config path').optional(),
+}, {
+    description: 'How to execute runner',
+});
+export const onProgressSchema = z
+    .function()
+    .args(z.unknown())
+    .returns(z.void());
+export const runnerFunctionSchema = z
+    .function()
+    .args(onProgressSchema.optional())
+    .returns(z.union([auditOutputsSchema, z.promise(auditOutputsSchema)]));
+export const runnerFilesPathsSchema = z.object({
+    runnerConfigPath: filePathSchema.describe('Runner config path'),
+    runnerOutputPath: filePathSchema.describe('Runner output path'),
+});
+//# sourceMappingURL=runner-config.js.map

package/src/lib/runner-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runner-config.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/runner-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE7D,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC;KACnC,QAAQ,EAAE;KACV,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;KACjB,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;AAIzE,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CACxC;IACE,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;QAChB,WAAW,EAAE,0BAA0B;KACxC,CAAC;IACF,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,mBAAmB,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IACxE,UAAU,EAAE,cAAc,CAAC,QAAQ,CAAC,oBAAoB,CAAC;IACzD,eAAe,EAAE,qBAAqB,CAAC,QAAQ,EAAE;IACjD,UAAU,EAAE,cAAc,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,QAAQ,EAAE;CACrE,EACD;IACE,WAAW,EAAE,uBAAuB;CACrC,CACF,CAAC;AAIF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,QAAQ,EAAE;KACV,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;KACjB,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;AAGrB,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC;KAClC,QAAQ,EAAE;KACV,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC;KACjC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;AAIzE,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,gBAAgB,EAAE,cAAc,CAAC,QAAQ,CAAC,oBAAoB,CAAC;IAC/D,gBAAgB,EAAE,cAAc,CAAC,QAAQ,CAAC,oBAAoB,CAAC;CAChE,CAAC,CAAC"}

package/src/lib/source.d.ts

@@ -34,4 +34,12 @@ export declare const sourceFileLocationSchema: z.ZodObject<{
         endColumn?: number | undefined;
     } | undefined;
 }>;
+/**
+ * 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/source.js

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+import { filePathSchema, positiveIntSchema } 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(),
+}, { description: 'Source file location' });
+//# sourceMappingURL=source.js.map

package/src/lib/source.js.map

@@ -0,0 +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"}

package/src/lib/table.d.ts

@@ -1,7 +1,23 @@
 import { z } from 'zod';
 export declare const tableAlignmentSchema: z.ZodEnum<["left", "center", "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", "center", "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;
@@ -16,10 +32,34 @@ export declare const tableColumnObjectSchema: z.ZodObject<{
     label?: string | undefined;
     align?: "left" | "center" | "right" | undefined;
 }>;
+/**
+ * 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<[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<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>, "many">;
+/**
+ * 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<[z.ZodObject<z.objectUtil.extendShape<{
     title: z.ZodOptional<z.ZodString>;
@@ -68,4 +108,12 @@ export declare const tableSchema: (description?: string) => z.ZodUnion<[z.ZodObj
         align?: "left" | "center" | "right" | undefined;
     }[] | undefined;
 }>]>;
+/**
+ * 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/table.js

@@ -0,0 +1,37 @@
+import { z } from 'zod';
+import { tableCellValueSchema } from './implementation/schemas.js';
+export const tableAlignmentSchema = z.enum(['left', 'center', 'right'], {
+    description: 'Cell alignment',
+});
+export const tableColumnPrimitiveSchema = tableAlignmentSchema;
+export const tableColumnObjectSchema = z.object({
+    key: z.string(),
+    label: z.string().optional(),
+    align: tableAlignmentSchema.optional(),
+});
+export const tableRowObjectSchema = z.record(tableCellValueSchema, {
+    description: 'Object row',
+});
+export const tableRowPrimitiveSchema = z.array(tableCellValueSchema, {
+    description: 'Primitive row',
+});
+const tableSharedSchema = z.object({
+    title: z.string().optional().describe('Display title for table'),
+});
+const tablePrimitiveSchema = tableSharedSchema.merge(z.object({
+    columns: z.array(tableAlignmentSchema).optional(),
+    rows: z.array(tableRowPrimitiveSchema),
+}, { description: 'Table with primitive rows and optional alignment columns' }));
+const tableObjectSchema = tableSharedSchema.merge(z.object({
+    columns: z
+        .union([
+        z.array(tableAlignmentSchema),
+        z.array(tableColumnObjectSchema),
+    ])
+        .optional(),
+    rows: z.array(tableRowObjectSchema),
+}, {
+    description: 'Table with object rows and optional alignment or object columns',
+}));
+export const tableSchema = (description = 'Table information') => z.union([tablePrimitiveSchema, tableObjectSchema], { description });
+//# sourceMappingURL=table.js.map

package/src/lib/table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AAEnE,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,EAAE;IACtE,WAAW,EAAE,gBAAgB;CAC9B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,0BAA0B,GAAG,oBAAoB,CAAC;AAG/D,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,KAAK,EAAE,oBAAoB,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC,oBAAoB,EAAE;IACjE,WAAW,EAAE,YAAY;CAC1B,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,oBAAoB,EAAE;IACnE,WAAW,EAAE,eAAe;CAC7B,CAAC,CAAC;AAGH,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;CACjE,CAAC,CAAC;AACH,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,KAAK,CAClD,CAAC,CAAC,MAAM,CACN;IACE,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,QAAQ,EAAE;IACjD,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC;CACvC,EACD,EAAE,WAAW,EAAE,0DAA0D,EAAE,CAC5E,CACF,CAAC;AACF,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,KAAK,CAC/C,CAAC,CAAC,MAAM,CACN;IACE,OAAO,EAAE,CAAC;SACP,KAAK,CAAC;QACL,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC;QAC7B,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC;KACjC,CAAC;SACD,QAAQ,EAAE;IACb,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC;CACpC,EACD;IACE,WAAW,EACT,iEAAiE;CACpE,CACF,CACF,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,WAAW,GAAG,mBAAmB,EAAE,EAAE,CAC/D,CAAC,CAAC,KAAK,CAAC,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC"}

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

@@ -18,4 +18,12 @@ export declare const uploadConfigSchema: z.ZodObject<{
     project: string;
     timeout?: number | undefined;
 }>;
+/**
+ * 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>;

package/src/lib/upload-config.js

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+import { slugSchema, urlSchema } from './implementation/schemas.js';
+export const uploadConfigSchema = z.object({
+    server: urlSchema.describe('URL of deployed portal API'),
+    apiKey: z.string({
+        description: 'API key with write access to portal (use `process.env` for security)',
+    }),
+    organization: slugSchema.describe('Organization slug from Code PushUp portal'),
+    project: slugSchema.describe('Project slug from Code PushUp portal'),
+    timeout: z
+        .number({ description: 'Request timeout in minutes (default is 5)' })
+        .positive()
+        .int()
+        .optional(),
+});
+//# sourceMappingURL=upload-config.js.map

package/src/lib/upload-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upload-config.js","sourceRoot":"","sources":["../../../../../packages/models/src/lib/upload-config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAEpE,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,MAAM,EAAE,SAAS,CAAC,QAAQ,CAAC,4BAA4B,CAAC;IACxD,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC;QACf,WAAW,EACT,sEAAsE;KACzE,CAAC;IACF,YAAY,EAAE,UAAU,CAAC,QAAQ,CAC/B,2CAA2C,CAC5C;IACD,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,sCAAsC,CAAC;IACpE,OAAO,EAAE,CAAC;SACP,MAAM,CAAC,EAAE,WAAW,EAAE,2CAA2C,EAAE,CAAC;SACpE,QAAQ,EAAE;SACV,GAAG,EAAE;SACL,QAAQ,EAAE;CACd,CAAC,CAAC"}