@argos-ci/core 5.0.4 → 5.1.0

package/dist/index.d.ts

@@ -120,6 +120,11 @@ interface Config {
      * Whether the environment is a merge queue.
      */
     mergeQueue?: boolean;
+    /**
+     * Whether this build contains only a subset of screenshots.
+     * This is useful when a build is created from an incomplete test suite where some tests are skipped.
+     */
+    subset?: boolean;
 }
 declare function readConfig(options?: Partial<Config>): Promise<Config>;
 declare function getConfigFromOptions({ parallel, ...options }: Omit<Partial<Config>, "parallel"> & {
@@ -237,11 +242,17 @@ interface components {
         };
         /** @description Build metadata */
         BuildMetadata: {
+            /** @description Test suite report */
             testReport?: {
-                /** @enum {string} */
+                /**
+                 * @description Status of the test suite
+                 * @enum {string}
+                 */
                 status: "passed" | "failed" | "timedout" | "interrupted";
                 stats?: {
+                    /** @description Date when the test suite started */
                     startTime?: string;
+                    /** @description Duration of the test suite in milliseconds */
                     duration?: number;
                 };
             };
@@ -253,6 +264,43 @@ interface components {
             number: number;
             /** @description The status of the build */
             status: ("accepted" | "rejected") | ("no-changes" | "changes-detected") | ("expired" | "pending" | "progress" | "error" | "aborted");
+            /** @description The conclusion of the build */
+            conclusion: ("no-changes" | "changes-detected") | null;
+            /** @description Stats of the diffs present in the build */
+            stats: {
+                /** @description Added snapshots */
+                added: number;
+                /** @description Removed snapshots */
+                removed: number;
+                /** @description Unchanged snapshots */
+                unchanged: number;
+                /** @description Changed snapshots */
+                changed: number;
+                /** @description Ignored snapshots */
+                ignored: number;
+                /** @description Failure screenshots */
+                failure: number;
+                /** @description Retry failure screenshots */
+                retryFailure: number;
+                /** @description Total number of snapshots */
+                total: number;
+            } | null;
+            metadata: {
+                /** @description Test suite report */
+                testReport?: {
+                    /**
+                     * @description Status of the test suite
+                     * @enum {string}
+                     */
+                    status: "passed" | "failed" | "timedout" | "interrupted";
+                    stats?: {
+                        /** @description Date when the test suite started */
+                        startTime?: string;
+                        /** @description Duration of the test suite in milliseconds */
+                        duration?: number;
+                    };
+                };
+            } | null;
             /**
              * Format: uri
              * @description The URL of the build
@@ -279,12 +327,6 @@ interface components {
                 message: string;
             }[];
         };
-        /** @description Project */
-        Project: {
-            id: string;
-            defaultBaseBranch: string;
-            hasRemoteContentAccess: boolean;
-        };
         /** @description Page information */
         PageInfo: {
             /** @description Total number of items */
@@ -294,6 +336,226 @@ interface components {
             /** @description Number of items per page */
             perPage: number;
         };
+        /** @description Snapshot diff */
+        SnapshotDiff: {
+            /** @description Unique identifier of the snapshot diff */
+            id: string;
+            /** @description Name of the snapshot diff */
+            name: string;
+            /**
+             * @description Status of the snapshot diff
+             * @enum {string}
+             */
+            status: "pending" | "removed" | "failure" | "added" | "changed" | "unchanged" | "retryFailure" | "ignored";
+            /** @description Similarity score between snapshots */
+            score: number | null;
+            /** @description Grouping key for the snapshot diff */
+            group: string | null;
+            /** @description Parent name of the snapshot (usually the story id) */
+            parentName: string | null;
+            /** @description URL of the diff image */
+            url: string | null;
+            base: {
+                /** @description Unique identifier of the snapshot */
+                id: string;
+                /** @description Name of the snapshot */
+                name: string;
+                metadata: {
+                    /**
+                     * @description Ignored. Can be set to get completions, validations and documentation in some editors.
+                     * @example https://api.argos-ci.com/v2/screenshot-metadata.json
+                     */
+                    $schema?: string;
+                    /** @description The URL of the page that was screenshotted */
+                    url?: string | null;
+                    /** @description An URL to an accessible preview of the screenshot */
+                    previewUrl?: string | null;
+                    viewport?: {
+                        /** @description The width of the viewport */
+                        width: number;
+                        /** @description The height of the viewport */
+                        height: number;
+                    } | null;
+                    /** @description The color scheme when the screenshot was taken */
+                    colorScheme?: ("light" | "dark") | null;
+                    /** @description The media type when the screenshot was taken */
+                    mediaType?: ("screen" | "print") | null;
+                    test?: ({
+                        /** @description The unique identifier of the test */
+                        id?: string | null;
+                        /** @description The title of the test */
+                        title: string;
+                        /** @description The path of titles leading to the test */
+                        titlePath: string[];
+                        /** @description The number of retries for the test */
+                        retries?: number | null;
+                        /** @description The current retry count */
+                        retry?: number | null;
+                        /** @description The repeat count for the test */
+                        repeat?: number | null;
+                        /** @description The location of the test in the source code */
+                        location?: {
+                            /** @description The located file */
+                            file: string;
+                            /** @description The line number in the file */
+                            line: number;
+                            /** @description The column number in the file */
+                            column: number;
+                        };
+                        /** @description Annotations associated to the test */
+                        annotations?: {
+                            /** @description The type of annotation */
+                            type: string;
+                            /** @description The description of the annotation */
+                            description?: string;
+                            /** @description The location of the annotation in the source code */
+                            location?: {
+                                /** @description The located file */
+                                file: string;
+                                /** @description The line number in the file */
+                                line: number;
+                                /** @description The column number in the file */
+                                column: number;
+                            };
+                        }[];
+                    } | null) | null;
+                    browser?: {
+                        /** @description The name of the browser */
+                        name: string;
+                        /** @description The version of the browser */
+                        version: string;
+                    } | null;
+                    /** @description The automation library that generated the screenshot */
+                    automationLibrary: {
+                        /** @description The name of the automation library */
+                        name: string;
+                        /** @description The version of the automation library */
+                        version: string;
+                    };
+                    /** @description The Argos SDK that generated the screenshot */
+                    sdk: {
+                        /** @description The name of the Argos SDK */
+                        name: string;
+                        /** @description The version of the Argos SDK */
+                        version: string;
+                    };
+                } | null;
+                /** @description Width of the screenshot in pixels */
+                width: number | null;
+                /** @description Height of the screenshot in pixels */
+                height: number | null;
+                /**
+                 * Format: uri
+                 * @description Public URL of the snapshot
+                 */
+                url: string;
+                /** @description Content type of the snapshot file */
+                contentType: string;
+            } | null;
+            head: {
+                /** @description Unique identifier of the snapshot */
+                id: string;
+                /** @description Name of the snapshot */
+                name: string;
+                metadata: {
+                    /**
+                     * @description Ignored. Can be set to get completions, validations and documentation in some editors.
+                     * @example https://api.argos-ci.com/v2/screenshot-metadata.json
+                     */
+                    $schema?: string;
+                    /** @description The URL of the page that was screenshotted */
+                    url?: string | null;
+                    /** @description An URL to an accessible preview of the screenshot */
+                    previewUrl?: string | null;
+                    viewport?: {
+                        /** @description The width of the viewport */
+                        width: number;
+                        /** @description The height of the viewport */
+                        height: number;
+                    } | null;
+                    /** @description The color scheme when the screenshot was taken */
+                    colorScheme?: ("light" | "dark") | null;
+                    /** @description The media type when the screenshot was taken */
+                    mediaType?: ("screen" | "print") | null;
+                    test?: ({
+                        /** @description The unique identifier of the test */
+                        id?: string | null;
+                        /** @description The title of the test */
+                        title: string;
+                        /** @description The path of titles leading to the test */
+                        titlePath: string[];
+                        /** @description The number of retries for the test */
+                        retries?: number | null;
+                        /** @description The current retry count */
+                        retry?: number | null;
+                        /** @description The repeat count for the test */
+                        repeat?: number | null;
+                        /** @description The location of the test in the source code */
+                        location?: {
+                            /** @description The located file */
+                            file: string;
+                            /** @description The line number in the file */
+                            line: number;
+                            /** @description The column number in the file */
+                            column: number;
+                        };
+                        /** @description Annotations associated to the test */
+                        annotations?: {
+                            /** @description The type of annotation */
+                            type: string;
+                            /** @description The description of the annotation */
+                            description?: string;
+                            /** @description The location of the annotation in the source code */
+                            location?: {
+                                /** @description The located file */
+                                file: string;
+                                /** @description The line number in the file */
+                                line: number;
+                                /** @description The column number in the file */
+                                column: number;
+                            };
+                        }[];
+                    } | null) | null;
+                    browser?: {
+                        /** @description The name of the browser */
+                        name: string;
+                        /** @description The version of the browser */
+                        version: string;
+                    } | null;
+                    /** @description The automation library that generated the screenshot */
+                    automationLibrary: {
+                        /** @description The name of the automation library */
+                        name: string;
+                        /** @description The version of the automation library */
+                        version: string;
+                    };
+                    /** @description The Argos SDK that generated the screenshot */
+                    sdk: {
+                        /** @description The name of the Argos SDK */
+                        name: string;
+                        /** @description The version of the Argos SDK */
+                        version: string;
+                    };
+                } | null;
+                /** @description Width of the screenshot in pixels */
+                width: number | null;
+                /** @description Height of the screenshot in pixels */
+                height: number | null;
+                /**
+                 * Format: uri
+                 * @description Public URL of the snapshot
+                 */
+                url: string;
+                /** @description Content type of the snapshot file */
+                contentType: string;
+            } | null;
+        };
+        /** @description Project */
+        Project: {
+            id: string;
+            defaultBaseBranch: string;
+            hasRemoteContentAccess: boolean;
+        };
     };
     responses: never;
     parameters: never;
@@ -401,6 +663,12 @@ interface UploadParameters {
     previewUrl?: {
         baseUrl: string;
     } | ((url: string) => string);
+    /**
+     * Whether this build contains only a subset of screenshots.
+     * This is useful when a build is created from an incomplete test suite where some tests are skipped.
+     * @default false
+     */
+    subset?: boolean;
 }
 interface Screenshot {
     hash: string;

package/dist/index.js

@@ -931,6 +931,11 @@ var schema = {
   mergeQueue: {
     format: Boolean,
     default: false
+  },
+  subset: {
+    env: "ARGOS_SUBSET",
+    format: Boolean,
+    default: false
   }
 };
 function createConfig() {
@@ -973,6 +978,7 @@ async function readConfig(options = {}) {
     ciProvider: ciEnv?.key || null,
     previewBaseUrl: defaultConfig.previewBaseUrl || null,
     skipped: options.skipped ?? defaultConfig.skipped ?? false,
+    subset: options.subset ?? defaultConfig.subset ?? false,
     mergeQueue: ciEnv?.mergeQueue ?? false
   });
   if (!config.get("branch") || !config.get("commit")) {
@@ -1395,7 +1401,8 @@ async function upload(params) {
       ciProvider: config.ciProvider,
       runId: config.runId,
       runAttempt: config.runAttempt,
-      mergeQueue: config.mergeQueue
+      mergeQueue: config.mergeQueue,
+      subset: config.subset
     }
   });
   if (createBuildResponse.error) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/core",
   "description": "Node.js SDK for visual testing with Argos.",
-  "version": "5.0.4",
+  "version": "5.1.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "exports": {
@@ -40,7 +40,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/api-client": "0.15.0",
+    "@argos-ci/api-client": "0.16.0",
     "@argos-ci/util": "3.2.0",
     "convict": "^6.2.4",
     "debug": "^4.4.3",
@@ -67,5 +67,5 @@
     "lint": "eslint .",
     "test": "vitest"
   },
-  "gitHead": "6fdd2406c03f3eea78931dc5f221cb438440c620"
+  "gitHead": "6887164dc0ccd5b2a3dd1d7d9e778cdbbdd2d534"
 }