@argos-ci/core 2.4.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,9 +54,13 @@ 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.
@@ -40,7 +70,7 @@ interface UploadParameters {
     threshold?: number;
 }
 /**
- * Upload screenshots to argos-ci.com.
+ * Upload screenshots to Argos.
  */
 declare function upload(params: UploadParameters): Promise<{
     build: {

package/dist/index.mjs

@@ -759,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

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.4.0",
+  "version": "2.4.1",
   "type": "module",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
@@ -59,5 +59,5 @@
     "build": "rollup -c",
     "e2e": "node ./e2e/upload.cjs && node ./e2e/upload.mjs"
   },
-  "gitHead": "aca82cf842a6d8310611a8594c581794df85cbd8"
+  "gitHead": "8fbd0bb85ba9df1e8ca39d46acfe9903264d0b51"
 }