@argos-ci/core 2.3.0 → 2.4.1

package/dist/index.d.ts

@@ -1,25 +1,51 @@
 interface UploadParameters {
-    /** Globs matching image file paths to upload */
+    /**
+     * Globs matching image file paths to upload
+     */
     files?: string[];
-    /** Root directory to look for image to upload (default to current directory) */
+    /**
+     * Root directory to look for image to upload
+     * @default process.cwd()
+     */
     root?: string;
-    /** Globs matching image file paths to ignore (default to "**\/*.\{png,jpg,jpeg\}") */
+    /**
+     * Globs matching image file paths to ignore
+     * @default ["**\/*.\{png,jpg,jpeg\}"]
+     */
     ignore?: string[];
-    /** Base URL of Argos API (default to "https://api.argos-ci.com/v2/") */
+    /**
+     * Base URL of Argos API
+     * @default "https://api.argos-ci.com/v2/"
+     */
     apiBaseUrl?: string;
-    /** Git commit */
+    /**
+     * Git commit
+     */
     commit?: string;
-    /** Git branch */
+    /**
+     * Git branch
+     */
     branch?: string;
-    /** Argos repository token */
+    /**
+     * Argos repository token
+     */
     token?: string;
-    /** Pull-request number */
+    /**
+     * Pull-request number
+     */
     prNumber?: number;
-    /** Name of the build used to trigger multiple Argos builds on one commit */
+    /**
+     * Name of the build used to trigger multiple Argos builds on one commit
+     */
     buildName?: string;
-    /** Mode of comparison applied */
+    /**
+     * Mode of comparison applied
+     * @default "ci"
+     */
     mode?: "ci" | "monitoring";
-    /** Parallel test suite mode */
+    /**
+     Parallel test suite mode
+     */
     parallel?: {
         /** Unique build ID for this parallel build */
         nonce: string;
@@ -28,13 +54,23 @@ interface UploadParameters {
         /** The index of the parallel node */
         index?: number;
     } | false;
-    /** Branch used as baseline for screenshot comparison */
+    /**
+     * Branch used as baseline for screenshot comparison
+     */
     referenceBranch?: string;
-    /** Commit used as baseline for screenshot comparison */
+    /**
+     * Commit used as baseline for screenshot comparison
+     */
     referenceCommit?: string;
+    /**
+     * Sensitivity threshold between 0 and 1.
+     * The higher the threshold, the less sensitive the diff will be.
+     * @default 0.5
+     */
+    threshold?: number;
 }
 /**
- * Upload screenshots to argos-ci.com.
+ * Upload screenshots to Argos.
  */
 declare function upload(params: UploadParameters): Promise<{
     build: {
@@ -45,6 +81,8 @@ declare function upload(params: UploadParameters): Promise<{
         hash: string;
         optimizedPath: string;
         metadata: import("@argos-ci/util").ScreenshotMetadata | null;
+        threshold: number | null;
+        baseName: string | null;
         pwTrace: {
             path: string;
             hash: string;
@@ -74,6 +112,7 @@ interface Config {
     prHeadCommit: string | null;
     mode: "ci" | "monitoring" | null;
     ciProvider: string | null;
+    threshold: number | null;
 }
 declare function readConfig(options?: Partial<Config>): Promise<Config>;
 export { UploadParameters, upload, Config, readConfig };

package/dist/index.mjs

@@ -408,6 +408,17 @@ const mustBeArgosToken = (value)=>{
         throw new Error("Invalid Argos repository token (must be 40 characters)");
     }
 };
+convict.addFormat({
+    name: "float-percent",
+    validate: function(val) {
+        if (val !== 0 && (!val || val > 1 || val < 0)) {
+            throw new Error("Must be a float between 0 and 1, inclusive.");
+        }
+    },
+    coerce: function(val) {
+        return parseFloat(val);
+    }
+});
 const schema = {
     apiBaseUrl: {
         env: "ARGOS_API_BASE_URL",
@@ -520,6 +531,12 @@ const schema = {
         format: String,
         default: null,
         nullable: true
+    },
+    threshold: {
+        env: "ARGOS_THRESHOLD",
+        format: "float-percent",
+        default: null,
+        nullable: true
     }
 };
 const createConfig = ()=>{
@@ -742,7 +759,7 @@ async function uploadFilesToS3(files) {
     }
 }
 /**
- * Upload screenshots to argos-ci.com.
+ * Upload screenshots to Argos.
  */ async function upload(params) {
     debug("Starting upload with params", params);
     // Read config
@@ -775,11 +792,18 @@ async function uploadFilesToS3(files) {
             hashFile(optimizedPath),
             pwTracePath ? hashFile(pwTracePath) : null
         ]);
+        const threshold = metadata?.transient?.threshold ?? null;
+        const baseName = metadata?.transient?.baseName ?? null;
+        if (metadata) {
+            delete metadata.transient;
+        }
         return {
             ...screenshot,
             hash,
             optimizedPath,
             metadata,
+            threshold,
+            baseName,
             pwTrace: pwTracePath && pwTraceHash ? {
                 path: pwTracePath,
                 hash: pwTraceHash
@@ -855,7 +879,9 @@ async function uploadFilesToS3(files) {
                 key: screenshot.hash,
                 name: screenshot.name,
                 metadata: screenshot.metadata,
-                pwTraceKey: screenshot.pwTrace?.hash ?? null
+                pwTraceKey: screenshot.pwTrace?.hash ?? null,
+                threshold: screenshot.threshold ?? config?.threshold ?? null,
+                baseName: screenshot.baseName
             })),
         parallel: config.parallel,
         parallelTotal: config.parallelTotal,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/core",
   "description": "Visual testing solution to avoid visual regression. The core component of Argos SDK that handles build creation.",
-  "version": "2.3.0",
+  "version": "2.4.1",
   "type": "module",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
@@ -40,7 +40,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/util": "2.0.0",
+    "@argos-ci/util": "2.1.0",
     "axios": "^1.6.8",
     "convict": "^6.2.4",
     "debug": "^4.3.4",
@@ -59,5 +59,5 @@
     "build": "rollup -c",
     "e2e": "node ./e2e/upload.cjs && node ./e2e/upload.mjs"
   },
-  "gitHead": "0c328bfcd6475ad625c0335cab11e912e856173c"
+  "gitHead": "8fbd0bb85ba9df1e8ca39d46acfe9903264d0b51"
 }