@argos-ci/core 4.1.4 → 4.1.6

package/dist/index.d.ts

@@ -293,27 +293,99 @@ declare function finalize(params: FinalizeParameters): Promise<{
 }>;
 
 interface Config {
+    /**
+     * Argos API base URL (for self-hosted installations)
+     */
     apiBaseUrl: string;
+    /**
+     * The commit SHA1 (40 characters)
+     */
     commit: string;
+    /**
+     * The git branch name (e.g. "main", "master", "develop", "release/1.0" etc.)
+     */
     branch: string;
+    /**
+     * The Argos repository token (40 characters)
+     */
     token: string | null;
+    /**
+     * The name of the build (for multi-build setups)
+     */
     buildName: string | null;
+    /**
+     * Whether the current run is parallelized (split in multiple jobs) or not
+     */
     parallel: boolean;
+    /**
+     * The parallelization nonce (identifier shared by all parallel jobs)
+     */
     parallelNonce: string | null;
+    /**
+     * The index of the current job (between 1 and parallelTotal inclusive, or null if not set)
+     */
     parallelIndex: number | null;
+    /**
+     * The total number of parallel jobs (or -1 if unknown, or null if not set)
+     */
     parallelTotal: number | null;
+    /**
+     * The reference git branch to compare against
+     */
     referenceBranch: string | null;
+    /**
+     * The reference commit SHA1 to compare against
+     */
     referenceCommit: string | null;
+    /**
+     * The git repository slug (e.g. "my-org/my-repo" or "my-user/my-repo")
+     * If from a fork, this is the fork's repository.
+     */
     repository: string | null;
+    /**
+     * The original git repository slug (e.g. "my-org/my-repo" or "my-user/my-repo")
+     * If from a fork, this is the base repository.
+     */
+    originalRepository: string | null;
+    /**
+     * The CI job identifier (if available)
+     */
     jobId: string | null;
+    /**
+     * The CI run identifier (if available)
+     */
     runId: string | null;
+    /**
+     * The CI run attempt (if available)
+     */
     runAttempt: number | null;
+    /**
+     * The pull request number (if available)
+     */
     prNumber: number | null;
+    /**
+     * The pull request head commit SHA1 (if available)
+     */
     prHeadCommit: string | null;
+    /**
+     * The pull request base branch (if available)
+     */
     prBaseBranch: string | null;
+    /**
+     * The mode Argos is running in (ci or monitoring)
+     */
     mode: "ci" | "monitoring" | null;
+    /**
+     * The CI provider name (if detected)
+     */
     ciProvider: string | null;
+    /**
+     * The threshold to use for this run (if any, between 0 and 1 inclusive, e.g. 0.1 for 10% or 0.0 for 0%)
+     */
     threshold: number | null;
+    /**
+     * The base URL to use for preview links (if any)
+     */
     previewBaseUrl: string | null;
 }
 declare function readConfig(options?: Partial<Config>): Promise<Config>;

package/dist/index.js

@@ -131,10 +131,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 +180,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 +211,7 @@ var service3 = {
     branch: env.HEROKU_TEST_RUN_BRANCH || null,
     owner: null,
     repository: null,
+    originalRepository: null,
     jobId: null,
     runId: null,
     runAttempt: null,
@@ -306,13 +311,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 +359,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 +389,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 +408,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 +429,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 +452,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 +473,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 +489,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 +517,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 +754,11 @@ var schema = {
     default: null,
     nullable: true
   },
+  originalRepository: {
+    format: String,
+    default: null,
+    nullable: true
+  },
   ciProvider: {
     format: String,
     default: null,
@@ -777,6 +805,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,
@@ -898,14 +927,15 @@ var hashFile = async (filepath) => {
 
 // src/auth.ts
 var base64Encode = (obj) => Buffer.from(JSON.stringify(obj), "utf8").toString("base64");
-function getAuthToken({
-  token,
-  ciProvider,
-  repository,
-  jobId,
-  runId,
-  prNumber
-}) {
+function getAuthToken(args) {
+  const {
+    token,
+    ciProvider,
+    originalRepository: repository,
+    jobId,
+    runId,
+    prNumber
+  } = args;
   if (token) {
     return token;
   }
@@ -982,10 +1012,10 @@ async function getConfigFromOptions({
 }) {
   return readConfig({
     ...options,
-    parallel: Boolean(parallel),
-    parallelNonce: parallel ? parallel.nonce : null,
-    parallelTotal: parallel ? parallel.total : null,
-    parallelIndex: parallel ? parallel.index : null
+    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) {
@@ -1211,7 +1241,7 @@ async function upload(params) {
 import { createClient as createClient2, throwAPIError as throwAPIError2 } from "@argos-ci/api-client";
 async function finalize(params) {
   const config = await readConfig({
-    parallelNonce: params.parallel?.nonce ?? null
+    parallelNonce: params.parallel?.nonce
   });
   const authToken = getAuthToken(config);
   const apiClient = createClient2({

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/core",
   "description": "Node.js SDK for visual testing with Argos.",
-  "version": "4.1.4",
+  "version": "4.1.6",
   "type": "module",
   "main": "./dist/index.cjs",
   "exports": {
@@ -40,20 +40,20 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/api-client": "0.11.0",
+    "@argos-ci/api-client": "0.11.1",
     "@argos-ci/util": "3.1.0",
     "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": "a1f55cdee00ce144eb5b0f7ef08e451867d0c129"
+  "gitHead": "00f28041a847158e437aaab5fc9e816f6b609021"
 }