@argos-ci/core 3.0.0 → 3.1.1-alpha.3

package/dist/index.d.ts

@@ -76,6 +76,13 @@ interface UploadParameters {
      * Build metadata.
      */
     metadata?: BuildMetadata;
+    /**
+     * Preview URL configuration.
+     * Accepts a base URL or a function that receives the URL and returns the preview URL.
+     */
+    previewUrl?: {
+        baseUrl: string;
+    } | ((url: string) => string);
 }
 /**
  * Upload screenshots to Argos.
@@ -84,7 +91,7 @@ declare function upload(params: UploadParameters): Promise<{
     build: {
         id: ArgosAPISchema.components["schemas"]["BuildId"];
         number: number;
-        status: ("accepted" | "rejected") | ("stable" | "diffDetected") | ("expired" | "pending" | "progress" | "error" | "aborted");
+        status: ("accepted" | "rejected") | ("no-changes" | "changes-detected") | ("expired" | "pending" | "progress" | "error" | "aborted");
         url: string;
         notification: {
             description: string;
@@ -124,7 +131,7 @@ interface components {
             /** @description The build number */
             number: number;
             /** @description The status of the build */
-            status: ("accepted" | "rejected") | ("stable" | "diffDetected") | ("expired" | "pending" | "progress" | "error" | "aborted");
+            status: ("accepted" | "rejected") | ("no-changes" | "changes-detected") | ("expired" | "pending" | "progress" | "error" | "aborted");
             /**
              * Format: uri
              * @description The URL of the build
@@ -168,6 +175,7 @@ interface components {
             baseName?: string | null;
             metadata?: {
                 url?: string;
+                previewUrl?: string;
                 viewport?: {
                     width: number;
                     height: number;
@@ -274,6 +282,7 @@ interface Config {
     mode: "ci" | "monitoring" | null;
     ciProvider: string | null;
     threshold: number | null;
+    previewBaseUrl: string | null;
 }
 declare function readConfig(options?: Partial<Config>): Promise<Config>;
 

package/dist/index.js

@@ -1,8 +1,5 @@
 // src/upload.ts
-import {
-  createClient,
-  throwAPIError
-} from "@argos-ci/api-client";
+import { createClient, throwAPIError } from "@argos-ci/api-client";
 
 // src/config.ts
 import convict from "convict";
@@ -251,12 +248,18 @@ function getBranchFromPayload(payload) {
   return null;
 }
 function getRepositoryFromContext({ env }) {
-  if (!env.GITHUB_REPOSITORY) return null;
+  if (!env.GITHUB_REPOSITORY) {
+    return null;
+  }
   return env.GITHUB_REPOSITORY.split("/")[1] || null;
 }
 function readEventPayload({ env }) {
-  if (!env.GITHUB_EVENT_PATH) return null;
-  if (!existsSync(env.GITHUB_EVENT_PATH)) return null;
+  if (!env.GITHUB_EVENT_PATH) {
+    return null;
+  }
+  if (!existsSync(env.GITHUB_EVENT_PATH)) {
+    return null;
+  }
   return JSON.parse(readFileSync(env.GITHUB_EVENT_PATH, "utf-8"));
 }
 function getPullRequestFromPayload(payload) {
@@ -290,7 +293,7 @@ var service4 = {
       jobId: env.GITHUB_JOB || null,
       runId: env.GITHUB_RUN_ID || null,
       runAttempt: env.GITHUB_RUN_ATTEMPT ? Number(env.GITHUB_RUN_ATTEMPT) : null,
-      nonce: `${env.GITHUB_RUN_ID}-${env.GITHUB_RUN_ATTEMPT}` || null,
+      nonce: `${env.GITHUB_RUN_ID}-${env.GITHUB_RUN_ATTEMPT}`,
       branch: getBranchFromContext(context) || pullRequest?.head.ref || (payload ? getBranchFromPayload(payload) : null) || null,
       prNumber: pullRequest?.number || null,
       prHeadCommit: pullRequest?.head.sha ?? null,
@@ -337,15 +340,21 @@ var circleci_default = service5;
 
 // src/ci-environment/services/travis.ts
 var getOwner = ({ env }) => {
-  if (!env.TRAVIS_REPO_SLUG) return null;
+  if (!env.TRAVIS_REPO_SLUG) {
+    return null;
+  }
   return env.TRAVIS_REPO_SLUG.split("/")[0] || null;
 };
 var getRepository = ({ env }) => {
-  if (!env.TRAVIS_REPO_SLUG) return null;
+  if (!env.TRAVIS_REPO_SLUG) {
+    return null;
+  }
   return env.TRAVIS_REPO_SLUG.split("/")[1] || null;
 };
 var getPrNumber3 = ({ env }) => {
-  if (env.TRAVIS_PULL_REQUEST) return Number(env.TRAVIS_PULL_REQUEST);
+  if (env.TRAVIS_PULL_REQUEST) {
+    return Number(env.TRAVIS_PULL_REQUEST);
+  }
   return null;
 };
 var service6 = {
@@ -476,7 +485,7 @@ async function getCiEnvironment() {
 
 // src/config.ts
 var mustBeApiBaseUrl = (value) => {
-  const URL_REGEX = /https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)/;
+  const URL_REGEX = /https?:\/\/(www\.)?[-a-zA-Z0-9@:%._+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_+.~#?&//=]*)/;
   if (!URL_REGEX.test(value)) {
     throw new Error("Invalid Argos API base URL");
   }
@@ -628,6 +637,12 @@ var schema = {
     format: "float-percent",
     default: null,
     nullable: true
+  },
+  previewBaseUrl: {
+    env: "ARGOS_PREVIEW_BASE_URL",
+    format: String,
+    default: null,
+    nullable: true
   }
 };
 var createConfig = () => {
@@ -659,7 +674,8 @@ async function readConfig(options = {}) {
     parallelTotal: options.parallelTotal ?? config.get("parallelTotal") ?? null,
     parallelIndex: options.parallelIndex ?? config.get("parallelIndex") ?? null,
     mode: options.mode || config.get("mode") || null,
-    ciProvider: ciEnv?.key || null
+    ciProvider: ciEnv?.key || null,
+    previewBaseUrl: config.get("previewBaseUrl") || null
   });
   config.validate();
   return config.get();
@@ -817,8 +833,8 @@ var upload = async (input) => {
 var chunk = (collection, size) => {
   const result = [];
   for (let x = 0; x < Math.ceil(collection.length / size); x++) {
-    let start = x * size;
-    let end = start + size;
+    const start = x * size;
+    const end = start + size;
     result.push(collection.slice(start, end));
   }
   return result;
@@ -875,12 +891,23 @@ async function uploadFilesToS3(files) {
     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 upload2(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);
@@ -908,6 +935,12 @@ async function upload2(params) {
       const baseName = metadata?.transient?.baseName ?? null;
       if (metadata) {
         delete metadata.transient;
+        if (metadata.url && previewUrlFormatter) {
+          metadata.previewUrl = formatPreviewUrl(
+            metadata.url,
+            previewUrlFormatter
+          );
+        }
       }
       return {
         ...screenshot,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/core",
   "description": "Node.js SDK for visual testing with Argos.",
-  "version": "3.0.0",
+  "version": "3.1.1-alpha.3+d98d368",
   "type": "module",
   "main": "./dist/index.cjs",
   "exports": {
@@ -40,8 +40,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/api-client": "0.7.2",
-    "@argos-ci/util": "2.2.2",
+    "@argos-ci/api-client": "0.8.1-alpha.3+d98d368",
+    "@argos-ci/util": "2.3.1-alpha.3+d98d368",
     "axios": "^1.7.9",
     "convict": "^6.2.4",
     "debug": "^4.4.0",
@@ -60,5 +60,5 @@
     "build": "tsup && cp ./src/index.cjs ./dist",
     "e2e": "node ./e2e/upload.cjs && node ./e2e/upload.mjs"
   },
-  "gitHead": "0c91306ae0cb8bec5ef93db79565635e405086f7"
+  "gitHead": "d98d368f95bee0eff3bd70ce945daf883f37f2d4"
 }