@applitools/eyes-results 0.2.0 → 0.2.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.2.2](https://github.com/Applitools-Dev/sdk/compare/js/eyes-results@0.2.1...js/eyes-results@0.2.2) (2026-08-25)
+
+
+### Bug Fixes
+
+* discover the project .env so the family read/write keys resolve | AD-15678 ([#4131](https://github.com/Applitools-Dev/sdk/issues/4131)) ([316f39f](https://github.com/Applitools-Dev/sdk/commit/316f39fd15fd516b3d266b8aa8deccddfabd0921))
+
+## [0.2.1](https://github.com/Applitools-Dev/sdk/compare/js/eyes-results@0.2.0...js/eyes-results@0.2.1) (2026-08-24)
+
+
+### Bug Fixes
+
+* enhance url support ([#4130](https://github.com/Applitools-Dev/sdk/issues/4130)) ([4dfc0a2](https://github.com/Applitools-Dev/sdk/commit/4dfc0a2553a910278596456f1c764fae72ab2c84))
+
 ## [0.2.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes-results@0.1.0...js/eyes-results@0.2.0) (2026-08-23)
 
 

package/dist/api/diff-fetch.js

@@ -9,5 +9,5 @@ export async function fetchStepDiff(options, fetchImpl = reqTransport) {
     const { baseUrl, batchId, sessionId, stepIndex, accountId, keys } = options;
     const url = `${baseUrl}/api/sessions/batches/${batchId}/${sessionId}/${stepIndex}/diff?accountId=${accountId}&apiKey=${encodeURIComponent(keys.getReadKey())}`;
     const data = await getJson(url, fetchImpl);
-    return { image1: data.image1 ?? [], image2: data.image2 ?? [] };
+    return { image1: data?.image1 ?? [], image2: data?.image2 ?? [] };
 }

package/dist/api/polling.js

@@ -31,6 +31,9 @@ export async function getJson(url, fetchImpl = reqTransport) {
         const text = await response.text().catch(() => '');
         throw new Error(`Request failed: ${response.status} ${response.statusText}${text ? ` — ${text}` : ''}`);
     }
+    // 204 carries no body; the step-diff endpoint answers one for a step with no diff data.
+    if (response.status === 204)
+        return undefined;
     return response.json();
 }
 /**

package/dist/api/url-parsing.js

@@ -1,21 +1,49 @@
+// Dashboard route tokens under `/app/`. `testResults` is the canonical route the backend puts in
+// reports, emails, and CI integrations; `batches` is what the Eyes server itself returns as a
+// run's session URL — so it is the form a test run prints to the console and the form a user
+// pastes first; `baselines` names a baseline revision, not a batch/session pair.
+export const APP_ROUTES = { testResults: 'test-results', batches: 'batches', baselines: 'baselines' };
+const escapeForRegExp = (s) => s.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+// Regex source for the `/app/<route>/` prefix of any batch-addressing dashboard URL.
+// If a future route is a prefix of another, order longest-first (alternation is leftmost-match).
+export const BATCH_ROUTE_PREFIX_SOURCE = `\\/app\\/(?:${[APP_ROUTES.testResults, APP_ROUTES.batches]
+    .map(escapeForRegExp)
+    .join('|')})\\/`;
+// Everything after the two ids is a dashboard view (`/steps/{N}`, `/steps/{N}/edit`) that names
+// no separate entity, so it is matched only to be discarded.
+const BATCH_PATH = new RegExp(`${BATCH_ROUTE_PREFIX_SOURCE}([^/?#]+)(?:\\/([^/?#]+))?`);
+// Route segments the dashboard puts directly after a batch id. Excluded by name because they sit
+// in the position a session id would occupy, and a `steps` mistaken for a session id reaches the
+// API as a real lookup.
+const ROUTE_SEGMENTS = new Set(['steps', 'edit']);
+// A baseline URL carries a baseline id and revision, not a batch/session pair, so no amount of
+// permissiveness makes it parseable here — it needs its own message or the caller retries blind.
+const BASELINE_PATH = new RegExp(`\\/app\\/${escapeForRegExp(APP_ROUTES.baselines)}\\/`);
+const ACCEPTED_FORMS = `Accepted: https://<host>/app/${APP_ROUTES.testResults}/{batchId}[/{sessionId}[/steps/{N}]]?accountId=…, ` +
+    `or the https://<host>/app/${APP_ROUTES.batches}/{batchId}/{sessionId}?accountId=… form an SDK run prints.`;
 /**
  * Parses an Applitools dashboard URL (session or batch) into its components.
+ * Accepts any of the `APP_ROUTES` batch-addressing routes; rejections name the
+ * accepted forms so the caller can correct the URL without guessing.
  * Does not require a sessionId to be present — use parseSessionUrl/parseBatchUrl
  * for callers that need to enforce one shape or the other.
  */
 export function parseApplitoolsUrl(url) {
     const urlMatch = url.match(/^(https?:\/\/[^/]+)/);
     if (!urlMatch)
-        throw new Error(`Invalid URL format: "${url}"`);
-    const batchMatch = url.match(/\/app\/test-results\/([^/?]+)/);
+        throw new Error(`Invalid URL format: "${url}". ${ACCEPTED_FORMS}`);
+    if (BASELINE_PATH.test(url)) {
+        throw new Error(`"${url}" is a baseline URL, which names a baseline revision rather than a batch or session. ${ACCEPTED_FORMS}`);
+    }
+    const batchMatch = url.match(BATCH_PATH);
     if (!batchMatch)
-        throw new Error(`Invalid URL format: "${url}"`);
-    const accountIdMatch = url.match(/accountId=([^&]+)/);
+        throw new Error(`Invalid URL format: "${url}". ${ACCEPTED_FORMS}`);
+    const accountIdMatch = url.match(/accountId=([^&#]+)/);
     if (!accountIdMatch)
         throw new Error(`Missing accountId in URL: "${url}"`);
-    const sessionMatch = url.match(/\/app\/test-results\/[^/?]+\/([^/?]+)/);
-    const sessionId = sessionMatch ? sessionMatch[1] : null;
-    return { baseUrl: urlMatch[1], batchId: batchMatch[1], sessionId, accountId: accountIdMatch[1] };
+    const [, batchId, segmentAfterBatch] = batchMatch;
+    const sessionId = segmentAfterBatch && !ROUTE_SEGMENTS.has(segmentAfterBatch) ? segmentAfterBatch : null;
+    return { baseUrl: urlMatch[1], batchId, sessionId, accountId: accountIdMatch[1] };
 }
 /** Throws if the URL doesn't include a sessionId segment (i.e. it's a batch-only URL). */
 export function parseSessionUrl(url) {

package/dist/lib/env.js

@@ -5,22 +5,20 @@ export const defaultLoadEnvDeps = {
     existsSync: fs.existsSync,
     configDotenv: dotenv.config,
 };
-/**
- * Walks up from `startDir` (default: the current working directory) looking for a `.env`
- * file, loading the first one found via `dotenv`. Mirrors the behavior every skill's own
- * `main.ts` used to inline directly.
- */
 export function loadEnvFromCwd(startDir = process.cwd(), deps = defaultLoadEnvDeps) {
     let dir = startDir;
     while (true) {
         const envPath = path.join(dir, '.env');
         if (deps.existsSync(envPath)) {
-            deps.configDotenv({ path: envPath });
-            return;
+            const preset = new Set(Object.keys(process.env));
+            const result = deps.configDotenv({ path: envPath });
+            const parsed = result?.parsed ?? {};
+            const applied = Object.keys(parsed).filter(name => !preset.has(name));
+            return { path: envPath, applied, parsed };
         }
         const parent = path.dirname(dir);
         if (parent === dir)
-            return;
+            return undefined;
         dir = parent;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes-results",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Applitools Eyes REST plumbing, DOM diffing, and session/batch shaping",
   "keywords": [
     "applitools",

package/types/api/url-parsing.d.ts

@@ -4,8 +4,16 @@ export interface ParsedApplitoolsUrl {
     sessionId: string | null;
     accountId: string;
 }
+export declare const APP_ROUTES: {
+    readonly testResults: "test-results";
+    readonly batches: "batches";
+    readonly baselines: "baselines";
+};
+export declare const BATCH_ROUTE_PREFIX_SOURCE: string;
 /**
  * Parses an Applitools dashboard URL (session or batch) into its components.
+ * Accepts any of the `APP_ROUTES` batch-addressing routes; rejections name the
+ * accepted forms so the caller can correct the URL without guessing.
  * Does not require a sessionId to be present — use parseSessionUrl/parseBatchUrl
  * for callers that need to enforce one shape or the other.
  */

package/types/lib/env.d.ts

@@ -6,9 +6,9 @@ export interface LoadEnvDeps {
     }) => unknown;
 }
 export declare const defaultLoadEnvDeps: LoadEnvDeps;
-/**
- * Walks up from `startDir` (default: the current working directory) looking for a `.env`
- * file, loading the first one found via `dotenv`. Mirrors the behavior every skill's own
- * `main.ts` used to inline directly.
- */
-export declare function loadEnvFromCwd(startDir?: string, deps?: LoadEnvDeps): void;
+export interface LoadedEnv {
+    path: string;
+    applied: string[];
+    parsed: Record<string, string>;
+}
+export declare function loadEnvFromCwd(startDir?: string, deps?: LoadEnvDeps): LoadedEnv | undefined;