@code-pushup/models 0.57.0 → 0.58.0

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

@@ -10,8 +10,9 @@ export const runnerConfigSchema = z.object({
         description: 'Shell command to execute',
     }),
     args: z.array(z.string({ description: 'Command arguments' })).optional(),
-    outputFile: filePathSchema.describe('Output path'),
+    outputFile: filePathSchema.describe('Runner output path'),
     outputTransform: outputTransformSchema.optional(),
+    configFile: filePathSchema.describe('Runner config path').optional(),
 }, {
     description: 'How to execute runner',
 });
@@ -23,4 +24,8 @@ 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

@@ -1 +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,aAAa,CAAC;IAClD,eAAe,EAAE,qBAAqB,CAAC,QAAQ,EAAE;CAClD,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"}
+{"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/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/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>;