@argos-ci/core 4.1.5 → 4.2.0

package/dist/index.d.ts

@@ -1,123 +1,133 @@
-import * as _argos_ci_util from '@argos-ci/util';
 import { ArgosAPISchema } from '@argos-ci/api-client';
+import { ScreenshotMetadata } from '@argos-ci/util';
 
-type BuildMetadata = ArgosAPISchema.components["schemas"]["BuildMetadata"];
-interface UploadParameters {
+interface Config {
     /**
-     * Globs matching image file paths to upload
+     * Base URL of the Argos API.
+     * Use this to target a self-hosted installation.
+     * @default "https://api.argos-ci.com/v2/"
      */
-    files?: string[];
+    apiBaseUrl: string;
     /**
-     * Root directory to look for image to upload
-     * @default process.cwd()
+     * Git commit SHA.
      */
-    root?: string;
+    commit: string;
     /**
-     * Globs matching image file paths to ignore
-     * @default ["**\/*.\{png,jpg,jpeg\}"]
+     * Git branch name of the build.
+     * @example "main", "develop", "release/1.0"
      */
-    ignore?: string[];
+    branch: string;
     /**
-     * Base URL of Argos API
-     * @default "https://api.argos-ci.com/v2/"
+     * Argos repository access token.
      */
-    apiBaseUrl?: string;
+    token: string | null;
     /**
-     * Git commit
+     * Custom build name.
+     * Useful for multi-build setups on the same commit.
      */
-    commit?: string;
+    buildName: string | null;
     /**
-     * Git branch
+     * Whether this build is split across multiple parallel jobs.
+     * @default false
      */
-    branch?: string;
+    parallel: boolean;
     /**
-     * Argos repository token
+     * Unique identifier shared by all parallel jobs.
      */
-    token?: string;
+    parallelNonce: string | null;
     /**
-     * Pull-request number
+     * Index of the current parallel job.
+     * Must be between 1 and `parallelTotal`, or null if not set.
      */
-    prNumber?: number;
+    parallelIndex: number | null;
     /**
-     * Name of the build used to trigger multiple Argos builds on one commit
+     * Total number of parallel jobs.
+     * Use -1 if unknown, or null if not set.
      */
-    buildName?: string;
+    parallelTotal: number | null;
     /**
-     * Mode of comparison applied
-     * @default "ci"
+     * Git branch used as the baseline for screenshot comparison.
      */
-    mode?: "ci" | "monitoring";
+    referenceBranch: string | null;
     /**
-     Parallel test suite mode
+     * Git commit SHA used as the baseline for screenshot comparison.
      */
-    parallel?: {
-        /** Unique build ID for this parallel build */
-        nonce: string;
-        /** The number of parallel nodes being ran */
-        total: number;
-        /** The index of the parallel node */
-        index?: number;
-    } | false;
+    referenceCommit: string | null;
     /**
-     * Branch used as baseline for screenshot comparison
+     * Repository slug of the source repository.
+     * Example: "my-org/my-repo" or "my-user/my-repo".
+     * If from a fork, this refers to the fork repository.
      */
-    referenceBranch?: string;
+    repository: string | null;
     /**
-     * Commit used as baseline for screenshot comparison
+     * Repository slug of the original (base) repository.
+     * Example: "my-org/my-repo" or "my-user/my-repo".
+     * If from a fork, this refers to the base repository.
      */
-    referenceCommit?: string;
+    originalRepository: string | null;
     /**
-     * Sensitivity threshold between 0 and 1.
-     * The higher the threshold, the less sensitive the diff will be.
-     * @default 0.5
+     * CI job identifier (if provided by the CI environment).
      */
-    threshold?: number;
+    jobId: string | null;
     /**
-     * Build metadata.
+     * CI run identifier (if provided by the CI environment).
      */
-    metadata?: BuildMetadata;
+    runId: string | null;
     /**
-     * Preview URL configuration.
-     * Accepts a base URL or a function that receives the URL and returns the preview URL.
+     * CI run attempt number (if provided by the CI environment).
      */
-    previewUrl?: {
-        baseUrl: string;
-    } | ((url: string) => string);
+    runAttempt: number | null;
+    /**
+     * Pull request number associated with the build.
+     */
+    prNumber: number | null;
+    /**
+     * Pull request head commit SHA (if available).
+     */
+    prHeadCommit: string | null;
+    /**
+     * Pull request base branch (if available).
+     */
+    prBaseBranch: string | null;
+    /**
+     * Build mode to use.
+     * - "ci": Review visual changes introduced by a feature branch and prevent regressions.
+     * - "monitoring": Track visual changes outside the standard CI flow, either on a schedule or before a release.
+     * @see https://argos-ci.com/docs/build-modes
+     */
+    mode: "ci" | "monitoring" | null;
+    /**
+     * Name of the detected CI provider (if available).
+     * @example "github-actions", "gitlab-ci", "circleci"
+     */
+    ciProvider: string | null;
+    /**
+     * Diff sensitivity threshold between 0 and 1.
+     * Higher values make Argos less sensitive to differences.
+     */
+    threshold: number | null;
+    /**
+     * Base URL to use for preview links.
+     * @example "https://my-preview.example.com"
+     */
+    previewBaseUrl: string | null;
+    /**
+     * Skip this build.
+     * No screenshots are uploaded, and the commit status is marked as success.
+     */
+    skipped?: boolean;
 }
-/**
- * Upload screenshots to Argos.
- */
-declare function upload(params: UploadParameters): Promise<{
-    build: {
-        id: ArgosAPISchema.components["schemas"]["BuildId"];
-        number: number;
-        status: ("accepted" | "rejected") | ("no-changes" | "changes-detected") | ("expired" | "pending" | "progress" | "error" | "aborted");
-        url: string;
-        notification: {
-            description: string;
-            context: string;
-            github: {
-                state: "pending" | "success" | "error" | "failure";
-            };
-            gitlab: {
-                state: "pending" | "running" | "success" | "failed" | "canceled";
-            };
-        } | null;
-    };
-    screenshots: {
-        hash: string;
-        optimizedPath: string;
-        metadata: _argos_ci_util.ScreenshotMetadata | null;
-        threshold: number | null;
-        baseName: string | null;
-        pwTrace: {
-            path: string;
-            hash: string;
-        } | null;
-        name: string;
-        path: string;
-    }[];
-}>;
+declare function readConfig(options?: Partial<Config>): Promise<Config>;
+declare function getConfigFromOptions({ parallel, ...options }: Omit<Partial<Config>, "parallel"> & {
+    parallel?: {
+        /** Unique build ID for this parallel build */
+        nonce: string;
+        /** The number of parallel nodes being ran */
+        total: number;
+        /** The index of the parallel node */
+        index?: number;
+    } | false | undefined;
+}): Promise<Config>;
 
 interface components {
     schemas: {
@@ -136,6 +146,11 @@ interface components {
             name: string;
             baseName?: string | null;
             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 */
@@ -292,30 +307,118 @@ declare function finalize(params: FinalizeParameters): Promise<{
     builds: components["schemas"]["Build"][];
 }>;
 
-interface Config {
-    apiBaseUrl: string;
-    commit: string;
-    branch: string;
-    token: string | null;
-    buildName: string | null;
-    parallel: boolean;
-    parallelNonce: string | null;
-    parallelIndex: number | null;
-    parallelTotal: number | null;
-    referenceBranch: string | null;
-    referenceCommit: string | null;
-    repository: string | null;
-    jobId: string | null;
-    runId: string | null;
-    runAttempt: number | null;
-    prNumber: number | null;
-    prHeadCommit: string | null;
-    prBaseBranch: string | null;
-    mode: "ci" | "monitoring" | null;
-    ciProvider: string | null;
+type BuildMetadata = ArgosAPISchema.components["schemas"]["BuildMetadata"];
+interface UploadParameters {
+    /**
+     * Globs that match image file paths to upload.
+     */
+    files?: string[];
+    /**
+     * Root directory used to resolve image paths.
+     * @default process.cwd()
+     */
+    root?: string;
+    /**
+     * Globs that match image file paths to exclude from upload.
+     * @default ["**\/*.{png,jpg,jpeg}"]
+     */
+    ignore?: string[];
+    /**
+     * Base URL of the Argos API.
+     * @default "https://api.argos-ci.com/v2/"
+     */
+    apiBaseUrl?: string;
+    /**
+     * Git commit SHA of the build.
+     */
+    commit?: string;
+    /**
+     * Git branch name of the build.
+     */
+    branch?: string;
+    /**
+     * Argos repository access token.
+     */
+    token?: string;
+    /**
+     * Pull request number associated with the build.
+     */
+    prNumber?: number;
+    /**
+     * Custom build name. Useful when triggering multiple Argos builds
+     * for the same commit.
+     */
+    buildName?: string;
+    /**
+     * Build mode to use.
+     * - "ci": Review the visual changes introduced by a feature branch and prevent regressions.
+     * - "monitoring": Track visual changes outside the standard CI flow, either on a schedule or before a release.
+     * @see https://argos-ci.com/docs/build-modes
+     * @default "ci"
+     */
+    mode?: "ci" | "monitoring";
+    /**
+     * Parallel test suite configuration.
+     * @default false
+     */
+    parallel?: {
+        /** Unique build identifier shared across parallel jobs. */
+        nonce: string;
+        /** Total number of parallel jobs, set to -1 to finalize manually. */
+        total: number;
+        /** Index of the current job (must start from 1). */
+        index?: number;
+    } | false;
+    /**
+     * Branch used as the baseline for screenshot comparison.
+     */
+    referenceBranch?: string;
+    /**
+     * Commit SHA used as the baseline for screenshot comparison.
+     */
+    referenceCommit?: string;
+    /**
+     * Diff sensitivity threshold between 0 and 1.
+     * Higher values make Argos less sensitive to differences.
+     * @default 0.5
+     */
+    threshold?: number;
+    /**
+     * Additional build metadata.
+     */
+    metadata?: BuildMetadata;
+    /**
+     * Preview URL configuration.
+     * Can be a fixed base URL or a function to transform URLs dynamically.
+     */
+    previewUrl?: {
+        baseUrl: string;
+    } | ((url: string) => string);
+    /**
+     * Mark this build as skipped.
+     * No screenshots are uploaded, and the commit status is marked as success.
+     */
+    skipped?: boolean;
+}
+interface Screenshot {
+    hash: string;
+    optimizedPath: string;
+    metadata: ScreenshotMetadata | null;
     threshold: number | null;
-    previewBaseUrl: string | null;
+    baseName: string | null;
+    pwTrace: {
+        path: string;
+        hash: string;
+    } | null;
+    name: string;
+    path: string;
 }
-declare function readConfig(options?: Partial<Config>): Promise<Config>;
+/**
+ * Upload screenshots to Argos.
+ */
+declare function upload(params: UploadParameters): Promise<{
+    build: ArgosAPISchema.components["schemas"]["Build"];
+    screenshots: Screenshot[];
+}>;
 
-export { type Config, type FinalizeParameters, type UploadParameters, finalize, readConfig, upload };
+export { type Config, type FinalizeParameters, type UploadParameters, finalize, getConfigFromOptions, readConfig, upload };

package/dist/index.js

@@ -1,6 +1,3 @@
-// src/upload.ts
-import { createClient, throwAPIError } from "@argos-ci/api-client";
-
 // src/config.ts
 import convict from "convict";
 
@@ -131,10 +128,12 @@ var service = {
   detect: ({ env }) => Boolean(env.BITRISE_IO),
   config: (context) => {
     const { env } = context;
+    const repository = getRepository(context);
     return {
       commit: env.BITRISE_GIT_COMMIT || null,
       branch: env.BITRISE_GIT_BRANCH || null,
-      repository: getRepository(context),
+      repository,
+      originalRepository: repository,
       jobId: null,
       runId: null,
       runAttempt: null,
@@ -178,11 +177,13 @@ var service2 = {
   detect: ({ env }) => Boolean(env.BUILDKITE),
   config: (context) => {
     const { env } = context;
+    const repository = getRepository2(context);
     return {
       // Buildkite doesn't work well so we fallback to git to ensure we have commit and branch
       commit: env.BUILDKITE_COMMIT || head() || null,
       branch: env.BUILDKITE_BRANCH || branch() || null,
-      repository: getRepository2(context),
+      repository,
+      originalRepository: repository,
       jobId: null,
       runId: null,
       runAttempt: null,
@@ -207,6 +208,7 @@ var service3 = {
     branch: env.HEROKU_TEST_RUN_BRANCH || null,
     owner: null,
     repository: null,
+    originalRepository: null,
     jobId: null,
     runId: null,
     runAttempt: null,
@@ -306,13 +308,16 @@ function getBranchFromPayload(payload) {
   return null;
 }
 function getRepository3(context, payload) {
-  const { env } = context;
   if (payload && "pull_request" in payload && payload.pull_request) {
     const pr = payload.pull_request;
     if (pr.head && pr.head.repo && pr.head.repo.full_name) {
       return pr.head.repo.full_name;
     }
   }
+  return getOriginalRepository(context);
+}
+function getOriginalRepository(context) {
+  const { env } = context;
   return env.GITHUB_REPOSITORY || null;
 }
 function readEventPayload({ env }) {
@@ -351,6 +356,7 @@ var service4 = {
     return {
       commit: sha,
       repository: getRepository3(context, payload),
+      originalRepository: getOriginalRepository(context),
       jobId: env.GITHUB_JOB || null,
       runId: env.GITHUB_RUN_ID || null,
       runAttempt: env.GITHUB_RUN_ATTEMPT ? Number(env.GITHUB_RUN_ATTEMPT) : null,
@@ -380,6 +386,10 @@ function getRepository4(context) {
   if (env.CIRCLE_PR_REPONAME && env.CIRCLE_PR_USERNAME) {
     return `${env.CIRCLE_PR_USERNAME}/${env.CIRCLE_PR_REPONAME}`;
   }
+  return getOriginalRepository2(context);
+}
+function getOriginalRepository2(context) {
+  const { env } = context;
   if (env.CIRCLE_PROJECT_USERNAME && env.CIRCLE_PROJECT_REPONAME) {
     return `${env.CIRCLE_PROJECT_USERNAME}/${env.CIRCLE_PROJECT_REPONAME}`;
   }
@@ -395,6 +405,7 @@ var service5 = {
       commit: env.CIRCLE_SHA1 || null,
       branch: env.CIRCLE_BRANCH || null,
       repository: getRepository4(context),
+      originalRepository: getOriginalRepository2(context),
       jobId: null,
       runId: null,
       runAttempt: null,
@@ -415,10 +426,11 @@ function getRepository5(context) {
   if (env.TRAVIS_PULL_REQUEST_SLUG) {
     return env.TRAVIS_PULL_REQUEST_SLUG;
   }
-  if (env.TRAVIS_REPO_SLUG) {
-    return env.TRAVIS_REPO_SLUG;
-  }
-  return null;
+  return getOriginalRepository3(context);
+}
+function getOriginalRepository3(context) {
+  const { env } = context;
+  return env.TRAVIS_REPO_SLUG || null;
 }
 function getPrNumber3(context) {
   const { env } = context;
@@ -437,6 +449,7 @@ var service6 = {
       commit: env.TRAVIS_COMMIT || null,
       branch: env.TRAVIS_BRANCH || null,
       repository: getRepository5(ctx),
+      originalRepository: getOriginalRepository3(ctx),
       jobId: null,
       runId: null,
       runAttempt: null,
@@ -457,6 +470,10 @@ function getRepository6(context) {
   if (env.CI_MERGE_REQUEST_PROJECT_PATH) {
     return env.CI_MERGE_REQUEST_PROJECT_PATH;
   }
+  return getOriginalRepository4(context);
+}
+function getOriginalRepository4(context) {
+  const { env } = context;
   return env.CI_PROJECT_PATH || null;
 }
 var service7 = {
@@ -469,6 +486,7 @@ var service7 = {
       commit: env.CI_COMMIT_SHA || null,
       branch: env.CI_COMMIT_REF_NAME || null,
       repository: getRepository6(context),
+      originalRepository: getOriginalRepository4(context),
       jobId: null,
       runId: null,
       runAttempt: null,
@@ -496,10 +514,12 @@ var service8 = {
   key: "git",
   detect: () => checkIsGitRepository(),
   config: () => {
+    const repository = getRepository7();
     return {
       commit: head() || null,
       branch: branch() || null,
-      repository: getRepository7(),
+      repository,
+      originalRepository: repository,
       jobId: null,
       runId: null,
       runAttempt: null,
@@ -731,6 +751,11 @@ var schema = {
     default: null,
     nullable: true
   },
+  originalRepository: {
+    format: String,
+    default: null,
+    nullable: true
+  },
   ciProvider: {
     format: String,
     default: null,
@@ -747,6 +772,11 @@ var schema = {
     format: String,
     default: null,
     nullable: true
+  },
+  skipped: {
+    env: "ARGOS_SKIPPED",
+    format: Boolean,
+    default: false
   }
 };
 function createConfig() {
@@ -777,6 +807,7 @@ async function readConfig(options = {}) {
     referenceBranch: options.referenceBranch || defaultConfig.referenceBranch || null,
     referenceCommit: options.referenceCommit || defaultConfig.referenceCommit || null,
     repository: ciEnv?.repository || null,
+    originalRepository: ciEnv?.originalRepository || null,
     jobId: ciEnv?.jobId || null,
     runId: ciEnv?.runId || null,
     runAttempt: ciEnv?.runAttempt || null,
@@ -786,7 +817,8 @@ async function readConfig(options = {}) {
     parallelIndex: options.parallelIndex ?? defaultConfig.parallelIndex ?? null,
     mode: options.mode || defaultConfig.mode || null,
     ciProvider: ciEnv?.key || null,
-    previewBaseUrl: defaultConfig.previewBaseUrl || null
+    previewBaseUrl: defaultConfig.previewBaseUrl || null,
+    skipped: options.skipped ?? defaultConfig.skipped ?? false
   });
   if (!config.get("branch") || !config.get("commit")) {
     throw new Error(
@@ -796,6 +828,83 @@ async function readConfig(options = {}) {
   config.validate();
   return config.get();
 }
+async function getConfigFromOptions({
+  parallel,
+  ...options
+}) {
+  return readConfig({
+    ...options,
+    parallel: parallel !== void 0 ? Boolean(parallel) : void 0,
+    parallelNonce: parallel ? parallel.nonce : void 0,
+    parallelTotal: parallel ? parallel.total : void 0,
+    parallelIndex: parallel ? parallel.index : void 0
+  });
+}
+
+// src/finalize.ts
+import { createClient, throwAPIError } from "@argos-ci/api-client";
+
+// src/auth.ts
+var base64Encode = (obj) => Buffer.from(JSON.stringify(obj), "utf8").toString("base64");
+function getAuthToken(args) {
+  const {
+    token,
+    ciProvider,
+    originalRepository: repository,
+    jobId,
+    runId,
+    prNumber
+  } = args;
+  if (token) {
+    return token;
+  }
+  switch (ciProvider) {
+    case "github-actions": {
+      if (!repository || !jobId || !runId) {
+        throw new Error(
+          `Automatic GitHub Actions variables detection failed. Please add the 'ARGOS_TOKEN'`
+        );
+      }
+      const [owner, repo] = repository.split("/");
+      return `tokenless-github-${base64Encode({
+        owner,
+        repository: repo,
+        jobId,
+        runId,
+        prNumber: prNumber ?? void 0
+      })}`;
+    }
+    default:
+      throw new Error("Missing Argos repository token 'ARGOS_TOKEN'");
+  }
+}
+
+// src/finalize.ts
+async function finalize(params) {
+  const config = await readConfig({
+    parallelNonce: params.parallel?.nonce
+  });
+  const authToken = getAuthToken(config);
+  const apiClient = createClient({
+    baseUrl: config.apiBaseUrl,
+    authToken
+  });
+  if (!config.parallelNonce) {
+    throw new Error("parallel.nonce is required to finalize the build");
+  }
+  const finalizeBuildsResult = await apiClient.POST("/builds/finalize", {
+    body: {
+      parallelNonce: config.parallelNonce
+    }
+  });
+  if (finalizeBuildsResult.error) {
+    throwAPIError(finalizeBuildsResult.error);
+  }
+  return finalizeBuildsResult.data;
+}
+
+// src/upload.ts
+import { createClient as createClient2, throwAPIError as throwAPIError2 } from "@argos-ci/api-client";
 
 // src/discovery.ts
 import { resolve } from "path";
@@ -896,40 +1005,6 @@ var hashFile = async (filepath) => {
   return hash.digest("hex");
 };
 
-// src/auth.ts
-var base64Encode = (obj) => Buffer.from(JSON.stringify(obj), "utf8").toString("base64");
-function getAuthToken({
-  token,
-  ciProvider,
-  repository,
-  jobId,
-  runId,
-  prNumber
-}) {
-  if (token) {
-    return token;
-  }
-  switch (ciProvider) {
-    case "github-actions": {
-      if (!repository || !jobId || !runId) {
-        throw new Error(
-          `Automatic GitHub Actions variables detection failed. Please add the 'ARGOS_TOKEN'`
-        );
-      }
-      const [owner, repo] = repository.split("/");
-      return `tokenless-github-${base64Encode({
-        owner,
-        repository: repo,
-        jobId,
-        runId,
-        prNumber: prNumber ?? void 0
-      })}`;
-    }
-    default:
-      throw new Error("Missing Argos repository token 'ARGOS_TOKEN'");
-  }
-}
-
 // src/s3.ts
 import { readFile } from "fs/promises";
 async function uploadFile(input) {
@@ -962,7 +1037,10 @@ var chunk = (collection, size) => {
 };
 
 // src/upload.ts
-import { getPlaywrightTracePath, readMetadata } from "@argos-ci/util";
+import {
+  getPlaywrightTracePath,
+  readMetadata
+} from "@argos-ci/util";
 
 // src/version.ts
 import { readVersionFromPackage } from "@argos-ci/util";
@@ -976,66 +1054,48 @@ async function getArgosCoreSDKIdentifier() {
 
 // src/upload.ts
 var CHUNK_SIZE = 10;
-async function getConfigFromOptions({
-  parallel,
-  ...options
-}) {
-  return readConfig({
-    ...options,
-    parallel: parallel !== void 0 ? Boolean(parallel) : void 0,
-    parallelNonce: parallel ? parallel.nonce : void 0,
-    parallelTotal: parallel ? parallel.total : void 0,
-    parallelIndex: parallel ? parallel.index : void 0
-  });
-}
-async function uploadFilesToS3(files) {
-  debug(`Split files in chunks of ${CHUNK_SIZE}`);
-  const chunks = chunk(files, CHUNK_SIZE);
-  debug(`Starting upload of ${chunks.length} chunks`);
-  for (let i = 0; i < chunks.length; i++) {
-    debug(`Uploading chunk ${i + 1}/${chunks.length}`);
-    const timeLabel = `Chunk ${i + 1}/${chunks.length}`;
-    debugTime(timeLabel);
-    const chunk2 = chunks[i];
-    if (!chunk2) {
-      throw new Error(`Invariant: chunk ${i} is empty`);
-    }
-    await Promise.all(
-      chunk2.map(async ({ url, path, contentType }) => {
-        await uploadFile({
-          url,
-          path,
-          contentType
-        });
-      })
-    );
-    debugTimeEnd(timeLabel);
-  }
-}
-function formatPreviewUrl(url, formatter) {
-  if (typeof formatter === "function") {
-    return formatter(url);
-  }
-  const urlObj = new URL(url);
-  return new URL(
-    urlObj.pathname + urlObj.search + urlObj.hash,
-    formatter.baseUrl
-  ).href;
-}
 async function upload(params) {
   debug("Starting upload with params", params);
   const [config, argosSdk] = await Promise.all([
     getConfigFromOptions(params),
     getArgosCoreSDKIdentifier()
   ]);
-  const previewUrlFormatter = params.previewUrl ?? (config.previewBaseUrl ? { baseUrl: config.previewBaseUrl } : void 0);
-  const files = params.files ?? ["**/*.{png,jpg,jpeg}"];
-  debug("Using config and files", config, files);
   const authToken = getAuthToken(config);
-  const apiClient = createClient({
+  const apiClient = createClient2({
     baseUrl: config.apiBaseUrl,
     authToken
   });
+  if (config.skipped) {
+    const createBuildResponse2 = await apiClient.POST("/builds", {
+      body: {
+        commit: config.commit,
+        branch: config.branch,
+        name: config.buildName,
+        mode: config.mode,
+        parallel: config.parallel,
+        parallelNonce: config.parallelNonce,
+        prNumber: config.prNumber,
+        prHeadCommit: config.prHeadCommit,
+        referenceBranch: config.referenceBranch,
+        referenceCommit: config.referenceCommit,
+        argosSdk,
+        ciProvider: config.ciProvider,
+        runId: config.runId,
+        runAttempt: config.runAttempt,
+        skipped: true,
+        screenshotKeys: [],
+        pwTraceKeys: [],
+        parentCommits: []
+      }
+    });
+    if (createBuildResponse2.error) {
+      throwAPIError2(createBuildResponse2.error);
+    }
+    return { build: createBuildResponse2.data.build, screenshots: [] };
+  }
+  const previewUrlFormatter = params.previewUrl ?? (config.previewBaseUrl ? { baseUrl: config.previewBaseUrl } : void 0);
+  const files = params.files ?? ["**/*.{png,jpg,jpeg}"];
+  debug("Using config and files", config, files);
   const foundScreenshots = await discoverScreenshots(files, {
     root: params.root,
     ignore: params.ignore
@@ -1077,7 +1137,7 @@ async function upload(params) {
   debug("Fetch project");
   const projectResponse = await apiClient.GET("/project");
   if (projectResponse.error) {
-    throwAPIError(projectResponse.error);
+    throwAPIError2(projectResponse.error);
   }
   debug("Project fetched", projectResponse.data);
   const { defaultBaseBranch, hasRemoteContentAccess } = projectResponse.data;
@@ -1148,7 +1208,7 @@ async function upload(params) {
     }
   });
   if (createBuildResponse.error) {
-    throwAPIError(createBuildResponse.error);
+    throwAPIError2(createBuildResponse.error);
   }
   const result = createBuildResponse.data;
   debug("Got uploads url", result);
@@ -1202,37 +1262,47 @@ async function upload(params) {
     }
   });
   if (uploadBuildResponse.error) {
-    throwAPIError(uploadBuildResponse.error);
+    throwAPIError2(uploadBuildResponse.error);
   }
   return { build: uploadBuildResponse.data.build, screenshots };
 }
-
-// src/finalize.ts
-import { createClient as createClient2, throwAPIError as throwAPIError2 } from "@argos-ci/api-client";
-async function finalize(params) {
-  const config = await readConfig({
-    parallelNonce: params.parallel?.nonce
-  });
-  const authToken = getAuthToken(config);
-  const apiClient = createClient2({
-    baseUrl: config.apiBaseUrl,
-    authToken
-  });
-  if (!config.parallelNonce) {
-    throw new Error("parallel.nonce is required to finalize the build");
-  }
-  const finalizeBuildsResult = await apiClient.POST("/builds/finalize", {
-    body: {
-      parallelNonce: config.parallelNonce
+async function uploadFilesToS3(files) {
+  debug(`Split files in chunks of ${CHUNK_SIZE}`);
+  const chunks = chunk(files, CHUNK_SIZE);
+  debug(`Starting upload of ${chunks.length} chunks`);
+  for (let i = 0; i < chunks.length; i++) {
+    debug(`Uploading chunk ${i + 1}/${chunks.length}`);
+    const timeLabel = `Chunk ${i + 1}/${chunks.length}`;
+    debugTime(timeLabel);
+    const chunk2 = chunks[i];
+    if (!chunk2) {
+      throw new Error(`Invariant: chunk ${i} is empty`);
     }
-  });
-  if (finalizeBuildsResult.error) {
-    throwAPIError2(finalizeBuildsResult.error);
+    await Promise.all(
+      chunk2.map(async ({ url, path, contentType }) => {
+        await uploadFile({
+          url,
+          path,
+          contentType
+        });
+      })
+    );
+    debugTimeEnd(timeLabel);
   }
-  return finalizeBuildsResult.data;
+}
+function formatPreviewUrl(url, formatter) {
+  if (typeof formatter === "function") {
+    return formatter(url);
+  }
+  const urlObj = new URL(url);
+  return new URL(
+    urlObj.pathname + urlObj.search + urlObj.hash,
+    formatter.baseUrl
+  ).href;
 }
 export {
   finalize,
+  getConfigFromOptions,
   readConfig,
   upload
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/core",
   "description": "Node.js SDK for visual testing with Argos.",
-  "version": "4.1.5",
+  "version": "4.2.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "exports": {
@@ -40,20 +40,20 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/api-client": "0.11.0",
-    "@argos-ci/util": "3.1.0",
+    "@argos-ci/api-client": "0.12.0",
+    "@argos-ci/util": "3.1.1",
     "convict": "^6.2.4",
-    "debug": "^4.4.0",
+    "debug": "^4.4.3",
     "fast-glob": "^3.3.3",
-    "sharp": "^0.34.3",
-    "tmp": "^0.2.3"
+    "sharp": "^0.34.4",
+    "tmp": "^0.2.5"
   },
   "devDependencies": {
     "@octokit/webhooks": "^14.1.3",
     "@types/convict": "^6.1.6",
     "@types/debug": "^4.1.12",
     "@types/tmp": "^0.2.6",
-    "msw": "^2.10.4",
+    "msw": "^2.11.3",
     "vitest": "catalog:"
   },
   "scripts": {
@@ -64,5 +64,5 @@
     "lint": "eslint .",
     "test": "vitest"
   },
-  "gitHead": "a865ca5004133efd5bf86e866116afabe3c1a478"
+  "gitHead": "867a93c5ffc01d55c7385d3ac3903c4c3ab270b6"
 }