@argos-ci/core 3.2.1 → 3.2.3

package/dist/index.d.ts

@@ -125,88 +125,72 @@ interface components {
         Sha1Hash: string;
         /** @description SHA256 hash */
         Sha256Hash: string;
-        /** @description Build */
-        Build: {
-            id: components["schemas"]["BuildId"];
-            /** @description The build number */
-            number: number;
-            /** @description The status of the build */
-            status: ("accepted" | "rejected") | ("no-changes" | "changes-detected") | ("expired" | "pending" | "progress" | "error" | "aborted");
-            /**
-             * Format: uri
-             * @description The URL of the build
-             */
-            url: string;
-            /** @description The notification payload for the build */
-            notification: {
-                description: string;
-                context: string;
-                github: {
-                    /** @enum {string} */
-                    state: "pending" | "success" | "error" | "failure";
-                };
-                gitlab: {
-                    /** @enum {string} */
-                    state: "pending" | "running" | "success" | "failed" | "canceled";
-                };
-            } | null;
-        };
         /**
          * @description A unique identifier for the build
          * @example 12345
          */
         BuildId: string;
-        /** @description Error response */
-        Error: {
-            error: string;
-            details?: {
-                message: string;
-            }[];
-        };
-        /**
-         * @description A unique identifier for the build
-         * @example 12345
-         */
-        buildId: string;
         /** @description Screenshot input */
         ScreenshotInput: {
             key: string;
             name: string;
             baseName?: string | null;
             metadata?: {
-                url?: string;
-                previewUrl?: string;
+                /** @description The URL of the page that was screenshotted */
+                url?: string | null;
+                /** @description An URL to an accessible preview of the screenshot */
+                previewUrl?: string | null;
                 viewport?: {
+                    /** @description The width of the viewport */
                     width: number;
+                    /** @description The height of the viewport */
                     height: number;
-                };
-                /** @enum {string} */
-                colorScheme?: "light" | "dark";
-                /** @enum {string} */
-                mediaType?: "screen" | "print";
-                test?: {
-                    id?: string;
+                } | null;
+                /** @description The color scheme when the screenshot was taken */
+                colorScheme?: ("light" | "dark") | null;
+                /** @description The media type when the screenshot was taken */
+                mediaType?: ("screen" | "print") | null;
+                test?: ({
+                    /** @description The unique identifier of the test */
+                    id?: string | null;
+                    /** @description The title of the test */
                     title: string;
+                    /** @description The path of titles leading to the test */
                     titlePath: string[];
-                    retries?: number;
-                    retry?: number;
-                    repeat?: number;
+                    /** @description The number of retries for the test */
+                    retries?: number | null;
+                    /** @description The current retry count */
+                    retry?: number | null;
+                    /** @description The repeat count for the test */
+                    repeat?: number | null;
+                    /** @description The location of the test in the source code */
                     location?: {
+                        /** @description The file where the test is located */
                         file: string;
+                        /** @description The line number in the file */
                         line: number;
+                        /** @description The column number in the file */
                         column: number;
                     };
-                } | null;
+                } | null) | null;
                 browser?: {
+                    /** @description The name of the browser */
                     name: string;
+                    /** @description The version of the browser */
                     version: string;
-                };
+                } | null;
+                /** @description The automation library that generated the screenshot */
                 automationLibrary: {
+                    /** @description The name of the automation library */
                     name: string;
+                    /** @description The version of the automation library */
                     version: string;
                 };
+                /** @description The Argos SDK that generated the screenshot */
                 sdk: {
+                    /** @description The name of the Argos SDK */
                     name: string;
+                    /** @description The version of the Argos SDK */
                     version: string;
                 };
             } | null;
@@ -224,6 +208,39 @@ interface components {
                 };
             };
         };
+        /** @description Build */
+        Build: {
+            id: components["schemas"]["BuildId"];
+            /** @description The build number */
+            number: number;
+            /** @description The status of the build */
+            status: ("accepted" | "rejected") | ("no-changes" | "changes-detected") | ("expired" | "pending" | "progress" | "error" | "aborted");
+            /**
+             * Format: uri
+             * @description The URL of the build
+             */
+            url: string;
+            /** @description The notification payload for the build */
+            notification: {
+                description: string;
+                context: string;
+                github: {
+                    /** @enum {string} */
+                    state: "pending" | "success" | "error" | "failure";
+                };
+                gitlab: {
+                    /** @enum {string} */
+                    state: "pending" | "running" | "success" | "failed" | "canceled";
+                };
+            } | null;
+        };
+        /** @description Error response */
+        Error: {
+            error: string;
+            details?: {
+                message: string;
+            }[];
+        };
         /** @description Project */
         Project: {
             id: string;
@@ -271,7 +288,6 @@ interface Config {
     parallelTotal: number | null;
     referenceBranch: string | null;
     referenceCommit: string | null;
-    owner: string | null;
     repository: string | null;
     jobId: string | null;
     runId: string | null;

package/dist/index.js

@@ -49,6 +49,14 @@ function branch() {
     return null;
   }
 }
+function getRepositoryURL() {
+  try {
+    const url = execSync("git config --get remote.origin.url").toString().trim();
+    return url;
+  } catch {
+    return null;
+  }
+}
 function getMergeBaseCommitShaWithDepth(input) {
   execSync(
     `git fetch --update-head-ok --depth ${input.depth} origin ${input.head}:${input.head}`
@@ -99,19 +107,27 @@ function listParentCommits(input) {
 }
 
 // src/ci-environment/services/bitrise.ts
-var getPrNumber = ({ env }) => {
+function getPrNumber(context) {
+  const { env } = context;
   return env.BITRISE_PULL_REQUEST ? Number(env.BITRISE_PULL_REQUEST) : null;
-};
+}
+function getRepository(context) {
+  const { env } = context;
+  if (env.BITRISEIO_GIT_REPOSITORY_OWNER && env.BITRISEIO_GIT_REPOSITORY_SLUG) {
+    return `${env.BITRISEIO_GIT_REPOSITORY_OWNER}/${env.BITRISEIO_GIT_REPOSITORY_SLUG}`;
+  }
+  return null;
+}
 var service = {
   name: "Bitrise",
   key: "bitrise",
   detect: ({ env }) => Boolean(env.BITRISE_IO),
-  config: ({ env }) => {
+  config: (context) => {
+    const { env } = context;
     return {
       commit: env.BITRISE_GIT_COMMIT || null,
       branch: env.BITRISE_GIT_BRANCH || null,
-      owner: env.BITRISEIO_GIT_REPOSITORY_OWNER || null,
-      repository: env.BITRISEIO_GIT_REPOSITORY_SLUG || null,
+      repository: getRepository(context),
       jobId: null,
       runId: null,
       runAttempt: null,
@@ -126,18 +142,40 @@ var service = {
 };
 var bitrise_default = service;
 
+// src/util/url.ts
+function getRepositoryNameFromURL(url) {
+  const sshMatch = url.match(/^git@[^:]+:([^/]+)\/(.+?)(?:\.git)?$/);
+  if (sshMatch && sshMatch[1] && sshMatch[2]) {
+    return `${sshMatch[1]}/${sshMatch[2]}`;
+  }
+  const httpsMatch = url.match(
+    /^(?:https?|git):\/\/[^/]+\/([^/]+)\/(.+?)(?:\.git)?$/
+  );
+  if (httpsMatch && httpsMatch[1] && httpsMatch[2]) {
+    return `${httpsMatch[1]}/${httpsMatch[2]}`;
+  }
+  return null;
+}
+
 // src/ci-environment/services/buildkite.ts
+function getRepository2(context) {
+  const { env } = context;
+  if (env.BUILDKITE_REPO) {
+    return getRepositoryNameFromURL(env.BUILDKITE_REPO);
+  }
+  return null;
+}
 var service2 = {
   name: "Buildkite",
   key: "buildkite",
   detect: ({ env }) => Boolean(env.BUILDKITE),
-  config: ({ env }) => {
+  config: (context) => {
+    const { env } = 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,
-      owner: env.BUILDKITE_ORGANIZATION_SLUG || null,
-      repository: env.BUILDKITE_PROJECT_SLUG || null,
+      repository: getRepository2(context),
       jobId: null,
       runId: null,
       runAttempt: null,
@@ -256,11 +294,15 @@ function getBranchFromPayload(payload) {
   }
   return null;
 }
-function getRepositoryFromContext({ env }) {
-  if (!env.GITHUB_REPOSITORY) {
-    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 env.GITHUB_REPOSITORY.split("/")[1] || null;
+  return env.GITHUB_REPOSITORY || null;
 }
 function readEventPayload({ env }) {
   if (!env.GITHUB_EVENT_PATH) {
@@ -297,8 +339,7 @@ var service4 = {
     const pullRequest = payload ? getPullRequestFromPayload(payload) : await getPullRequestFromHeadSha(context, sha);
     return {
       commit: sha,
-      owner: env.GITHUB_REPOSITORY_OWNER || null,
-      repository: getRepositoryFromContext(context),
+      repository: getRepository3(context, payload),
       jobId: env.GITHUB_JOB || null,
       runId: env.GITHUB_RUN_ID || null,
       runAttempt: env.GITHUB_RUN_ATTEMPT ? Number(env.GITHUB_RUN_ATTEMPT) : null,
@@ -315,24 +356,34 @@ var service4 = {
 var github_actions_default = service4;
 
 // src/ci-environment/services/circleci.ts
-var getPrNumber2 = ({ env }) => {
-  const branchRegex = /pull\/(\d+)/;
-  const matches = branchRegex.exec(env.CIRCLE_PULL_REQUEST || "");
+function getPrNumber2(context) {
+  const { env } = context;
+  const matches = /pull\/(\d+)/.exec(env.CIRCLE_PULL_REQUEST || "");
   if (matches) {
     return Number(matches[1]);
   }
   return null;
-};
+}
+function getRepository4(context) {
+  const { env } = context;
+  if (env.CIRCLE_PR_REPONAME && env.CIRCLE_PR_USERNAME) {
+    return `${env.CIRCLE_PR_USERNAME}/${env.CIRCLE_PR_REPONAME}`;
+  }
+  if (env.CIRCLE_PROJECT_USERNAME && env.CIRCLE_PROJECT_REPONAME) {
+    return `${env.CIRCLE_PROJECT_USERNAME}/${env.CIRCLE_PROJECT_REPONAME}`;
+  }
+  return null;
+}
 var service5 = {
   name: "CircleCI",
   key: "circleci",
   detect: ({ env }) => Boolean(env.CIRCLECI),
-  config: ({ env }) => {
+  config: (context) => {
+    const { env } = context;
     return {
       commit: env.CIRCLE_SHA1 || null,
       branch: env.CIRCLE_BRANCH || null,
-      owner: env.CIRCLE_PROJECT_USERNAME || null,
-      repository: env.CIRCLE_PROJECT_REPONAME || null,
+      repository: getRepository4(context),
       jobId: null,
       runId: null,
       runAttempt: null,
@@ -348,24 +399,23 @@ var service5 = {
 var circleci_default = service5;
 
 // src/ci-environment/services/travis.ts
-var getOwner = ({ env }) => {
-  if (!env.TRAVIS_REPO_SLUG) {
-    return null;
+function getRepository5(context) {
+  const { env } = context;
+  if (env.TRAVIS_PULL_REQUEST_SLUG) {
+    return env.TRAVIS_PULL_REQUEST_SLUG;
   }
-  return env.TRAVIS_REPO_SLUG.split("/")[0] || null;
-};
-var getRepository = ({ env }) => {
-  if (!env.TRAVIS_REPO_SLUG) {
-    return null;
+  if (env.TRAVIS_REPO_SLUG) {
+    return env.TRAVIS_REPO_SLUG;
   }
-  return env.TRAVIS_REPO_SLUG.split("/")[1] || null;
-};
-var getPrNumber3 = ({ env }) => {
+  return null;
+}
+function getPrNumber3(context) {
+  const { env } = context;
   if (env.TRAVIS_PULL_REQUEST) {
     return Number(env.TRAVIS_PULL_REQUEST);
   }
   return null;
-};
+}
 var service6 = {
   name: "Travis CI",
   key: "travis",
@@ -375,8 +425,7 @@ var service6 = {
     return {
       commit: env.TRAVIS_COMMIT || null,
       branch: env.TRAVIS_BRANCH || null,
-      owner: getOwner(ctx),
-      repository: getRepository(ctx),
+      repository: getRepository5(ctx),
       jobId: null,
       runId: null,
       runAttempt: null,
@@ -392,16 +441,23 @@ var service6 = {
 var travis_default = service6;
 
 // src/ci-environment/services/gitlab.ts
+function getRepository6(context) {
+  const { env } = context;
+  if (env.CI_MERGE_REQUEST_PROJECT_PATH) {
+    return env.CI_MERGE_REQUEST_PROJECT_PATH;
+  }
+  return env.CI_PROJECT_PATH || null;
+}
 var service7 = {
   name: "GitLab",
   key: "gitlab",
   detect: ({ env }) => env.GITLAB_CI === "true",
-  config: ({ env }) => {
+  config: (context) => {
+    const { env } = context;
     return {
       commit: env.CI_COMMIT_SHA || null,
       branch: env.CI_COMMIT_REF_NAME || null,
-      owner: null,
-      repository: null,
+      repository: getRepository6(context),
       jobId: null,
       runId: null,
       runAttempt: null,
@@ -417,6 +473,13 @@ var service7 = {
 var gitlab_default = service7;
 
 // src/ci-environment/services/git.ts
+function getRepository7() {
+  const repositoryURL = getRepositoryURL();
+  if (!repositoryURL) {
+    return null;
+  }
+  return getRepositoryNameFromURL(repositoryURL);
+}
 var service8 = {
   name: "Git",
   key: "git",
@@ -425,8 +488,7 @@ var service8 = {
     return {
       commit: head() || null,
       branch: branch() || null,
-      owner: null,
-      repository: null,
+      repository: getRepository7(),
       jobId: null,
       runId: null,
       runAttempt: null,
@@ -673,7 +735,6 @@ async function readConfig(options = {}) {
     prBaseBranch: config.get("prBaseBranch") || ciEnv?.prBaseBranch || null,
     referenceBranch: options.referenceBranch || config.get("referenceBranch") || null,
     referenceCommit: options.referenceCommit || config.get("referenceCommit") || null,
-    owner: ciEnv?.owner || null,
     repository: ciEnv?.repository || null,
     jobId: ciEnv?.jobId || null,
     runId: ciEnv?.runId || null,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@argos-ci/core",
   "description": "Node.js SDK for visual testing with Argos.",
-  "version": "3.2.1",
+  "version": "3.2.3",
   "type": "module",
   "main": "./dist/index.cjs",
   "exports": {
@@ -40,8 +40,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@argos-ci/api-client": "0.8.1",
-    "@argos-ci/util": "2.3.2",
+    "@argos-ci/api-client": "0.8.2",
+    "@argos-ci/util": "2.3.3",
     "axios": "^1.8.4",
     "convict": "^6.2.4",
     "debug": "^4.4.0",
@@ -54,7 +54,8 @@
     "@types/convict": "^6.1.6",
     "@types/debug": "^4.1.12",
     "@types/tmp": "^0.2.6",
-    "msw": "^2.7.3"
+    "msw": "^2.7.3",
+    "vitest": "catalog:"
   },
   "scripts": {
     "build": "tsup && cp ./src/index.cjs ./dist",
@@ -64,5 +65,5 @@
     "lint": "eslint .",
     "test": "vitest"
   },
-  "gitHead": "e1fae6c3e23967e703e761afce0ec037e07245b6"
+  "gitHead": "c54dac3320a10630c31549153473b70a2b42c2b6"
 }