@applitools/core 4.67.2 → 4.68.1

package/dist/offline/run-offline-snapshots.js

@@ -31,6 +31,7 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const core_1 = require("../core");
 const get_ufg_client_1 = require("../ufg/get-ufg-client");
+const build_accessibility_report_options_1 = require("../ufg/build-accessibility-report-options");
 const to_base_check_settings_1 = require("../automation/utils/to-base-check-settings");
 const logger_1 = require("@applitools/logger");
 const chalk_1 = __importDefault(require("chalk"));
@@ -63,7 +64,13 @@ async function runOfflineSnapshots(options) {
     const offlineLocationPath = path_1.default.resolve(options.offlineLocationPath);
     const startTime = Date.now();
     const logger = (_a = options.logger) !== null && _a !== void 0 ? _a : (0, logger_1.makeLogger)({ format: { label: 'offline-exec' } });
-    const eyesServerSettings = { ...options.config.open, ...options };
+    // figmaBaselines/figmaOptions are off-the-wire open config that the open seam resolves and then strips.
+    // This replay path bypasses the seam, so strip them once here — figmaOptions carries a Figma access
+    // token, and getAccountInfo logs the settings it is called with.
+    const openConfig = { ...options.config.open };
+    delete openConfig.figmaBaselines;
+    delete openConfig.figmaOptions;
+    const eyesServerSettings = { ...openConfig, ...options };
     const core = (0, core_1.makeCore)({ agentId: `js/core-offline/${version()}`, logger });
     const account = await core.getAccountInfo({ settings: eyesServerSettings });
     const ufgClient = await (0, get_ufg_client_1.makeGetUFGClient)({ logger })({
@@ -111,7 +118,7 @@ async function runOfflineSnapshots(options) {
             const fileOpenSettings = await fs_1.default.promises
                 .readFile(path_1.default.join(testPath, 'settings.json'), 'utf-8')
                 .then(JSON.parse);
-            const openSettings = (0, merge_configs_1.mergeConfigs)(fileOpenSettings, options.config.open);
+            const openSettings = (0, merge_configs_1.mergeConfigs)(fileOpenSettings, openConfig);
             messages.push(`Running test: ${openSettings.testName} (${formatEnvironment(openSettings.environment)})`);
             return { testPath, openSettings, testLogger };
         });
@@ -336,10 +343,14 @@ async function runOfflineSnapshots(options) {
         });
     }
     async function render(target, logger) {
-        var _a;
+        var _a, _b;
         const { elementReferences: selectors, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({
             settings: target.settings,
         });
+        // Only request a report when the check configures an accessibility standard.
+        const accessibilityReportOptions = target.settings.accessibilitySettings
+            ? (0, build_accessibility_report_options_1.buildAccessibilityReportOptions)({ accessibilityOptions: account.accessibilityOptions })
+            : undefined;
         const { renderId, selectorRegions, ...baseTarget } = await ufgClient.render({
             target: target.target,
             settings: {
@@ -351,6 +362,7 @@ async function runOfflineSnapshots(options) {
                 environment: target.settings.environment,
                 uploadUrl: account.uploadUrl,
                 stitchingServiceUrl: account.stitchingServiceUrl,
+                accessibilityReportOptions,
             },
             logger,
         });
@@ -365,6 +377,9 @@ async function runOfflineSnapshots(options) {
         baseSettings.renderId = renderId;
         // baseSettings.stepIndex = index
         baseTarget.source = target.target.source; // TODO verify
+        // Fall back to the minted upload URL when the render result carries no report location.
+        if (accessibilityReportOptions === null || accessibilityReportOptions === void 0 ? void 0 : accessibilityReportOptions.uploadUrl)
+            (_b = baseTarget.accessibilityReportLocation) !== null && _b !== void 0 ? _b : (baseTarget.accessibilityReportLocation = accessibilityReportOptions.uploadUrl);
         // baseTarget.name = snapshot.title // TODO figure out
         const mergedCheckSettings = (0, merge_configs_1.mergeConfigs)(baseSettings, options.config.check);
         return { mergedCheckSettings, baseTarget };

package/dist/open-eyes.js

@@ -33,6 +33,7 @@ const check_and_close_1 = require("./check-and-close");
 const close_1 = require("./close");
 const abort_1 = require("./abort");
 const get_eyes_results_1 = require("./get-eyes-results");
+const seam_1 = require("./figma/seam");
 const populate_eyes_server_settings_1 = require("./utils/populate-eyes-server-settings");
 const utils = __importStar(require("@applitools/utils"));
 const core_base_1 = require("@applitools/core-base");
@@ -110,6 +111,7 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDup
             logger.warn(`gitBranchingTimestamp is an invalid ISO date string: ${settings.gitBranchingTimestamp}`);
             settings.gitBranchingTimestamp = undefined;
         }
+        await (0, seam_1.applyFigmaBaselines)(settings, logger);
         (_x = settings.bypassCSP) !== null && _x !== void 0 ? _x : (settings.bypassCSP = utils.general.getEnvValue('BYPASS_CSP', 'boolean') === true || undefined);
         const driver = target && (await (0, driver_1.makeDriver)({ spec, driver: target, logger, customConfig: settings }));
         if (settings.bypassCSP) {
@@ -182,8 +184,8 @@ function makeOpenEyes({ type: defaultType = 'classic', clients, batch, removeDup
             var _a, _b;
             return ({
                 getTypedEyes,
-                check: (0, check_1.makeCheck)({ type, eyes, target: driver, spec, logger }),
-                checkAndClose: (0, check_and_close_1.makeCheckAndClose)({ type, eyes, target: driver, spec, logger }),
+                check: (0, check_1.makeCheck)({ type, eyes, target: driver, environments: settings.environments, spec, logger }),
+                checkAndClose: (0, check_and_close_1.makeCheckAndClose)({ type, eyes, target: driver, environments: settings.environments, spec, logger }),
                 close: (0, close_1.makeClose)({ eyes, environments: (_a = config === null || config === void 0 ? void 0 : config.check) === null || _a === void 0 ? void 0 : _a.environments, logger }),
                 abort: (0, abort_1.makeAbort)({ eyes, environments: (_b = config === null || config === void 0 ? void 0 : config.check) === null || _b === void 0 ? void 0 : _b.environments, logger }),
                 getResults: (0, get_eyes_results_1.makeGetEyesResults)({ eyes, logger }),

package/dist/ufg/build-accessibility-report-options.js

@@ -0,0 +1,40 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildAccessibilityReportOptions = void 0;
+const utils = __importStar(require("@applitools/utils"));
+const REPORT_ID_PLACEHOLDER = '__report_id__';
+/**
+ * Builds the `accessibilityReportOptions` render option: forwards `runOptions` verbatim and fills the
+ * `uploadUrl` template's `__report_id__` with a fresh random id. Returns `undefined` when the account
+ * has no accessibility options.
+ */
+function buildAccessibilityReportOptions({ accessibilityOptions, reportId = utils.general.guid(), }) {
+    if (!accessibilityOptions)
+        return undefined;
+    const uploadUrl = accessibilityOptions.uploadUrl.split(REPORT_ID_PLACEHOLDER).join(encodeURIComponent(reportId));
+    return { axeCoreOptions: accessibilityOptions.runOptions, uploadUrl };
+}
+exports.buildAccessibilityReportOptions = buildAccessibilityReportOptions;

package/dist/ufg/check-and-close.js

@@ -37,6 +37,7 @@ const lang = __importStar(require("../lang"));
 const chalk_1 = __importDefault(require("chalk"));
 const take_snapshots_1 = require("./take-snapshots");
 const create_render_target_from_snapshot_1 = require("./create-render-target-from-snapshot");
+const build_accessibility_report_options_1 = require("./build-accessibility-report-options");
 function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultEnvironments = [], spec, signal, logger: mainLogger, }) {
     return async function checkAndClose({ target = defaultTarget, settings = {}, logger = mainLogger, } = {}) {
         var _a;
@@ -72,7 +73,7 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
             snapshots = !utils.types.isArray(target) ? Array(uniqueEnvironments.length).fill(target) : target;
         }
         const promises = snapshots.map(async (snapshot, i) => {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
             const environmentLogger = logger.extend({ tags: [`environment-${utils.general.shortid()}`] });
             const { target } = snapshot;
             const environment = uniqueEnvironments[i];
@@ -115,6 +116,10 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                     const { elementReferences: selectors, getBaseCheckSettings } = (0, to_base_check_settings_1.toBaseCheckSettings)({
                         settings: snapshot.settings,
                     });
+                    // Only request a report when the check configures an accessibility standard.
+                    const accessibilityReportOptions = settings.accessibilitySettings
+                        ? (0, build_accessibility_report_options_1.buildAccessibilityReportOptions)({ accessibilityOptions: eyes.test.account.accessibilityOptions })
+                        : undefined;
                     const { renderId, selectorRegions, ...baseTarget } = await ufgClient.render({
                         target: renderTarget,
                         settings: {
@@ -126,6 +131,7 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                             environment: { ...environment, environmentId: baseEyes.test.environment.environmentId },
                             uploadUrl: baseEyes.test.uploadUrl,
                             stitchingServiceUrl: baseEyes.test.stitchingServiceUrl,
+                            accessibilityReportOptions,
                         },
                         signal,
                         logger: environmentLogger,
@@ -141,13 +147,16 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                     baseSettings.renderId = renderId;
                     baseTarget.source = snapshot.url;
                     baseTarget.name = snapshot.title;
+                    // Fall back to the minted upload URL when the render result carries no report location.
+                    if (accessibilityReportOptions === null || accessibilityReportOptions === void 0 ? void 0 : accessibilityReportOptions.uploadUrl)
+                        (_f = baseTarget.accessibilityReportLocation) !== null && _f !== void 0 ? _f : (baseTarget.accessibilityReportLocation = accessibilityReportOptions.uploadUrl);
                     if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
                         environmentLogger.warn('Command "check" was aborted after rendering');
                         throw new abort_error_1.AbortError('Command "check" was aborted after rendering');
                     }
                     else if (!baseEyes.running) {
-                        environmentLogger.warn(`Render on environment with id "${(_f = baseEyes.test.environment) === null || _f === void 0 ? void 0 : _f.environmentId}" was aborted during one of the previous steps`);
-                        throw new abort_error_1.AbortError(`Render on environment with id "${(_g = baseEyes.test.environment) === null || _g === void 0 ? void 0 : _g.environmentId}" was aborted during one of the previous steps`);
+                        environmentLogger.warn(`Render on environment with id "${(_g = baseEyes.test.environment) === null || _g === void 0 ? void 0 : _g.environmentId}" was aborted during one of the previous steps`);
+                        throw new abort_error_1.AbortError(`Render on environment with id "${(_h = baseEyes.test.environment) === null || _h === void 0 ? void 0 : _h.environmentId}" was aborted during one of the previous steps`);
                     }
                     if (settings.assumesMutability) {
                         void eyes.core.logEvent({
@@ -165,7 +174,7 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                                         userTestId: baseEyes.test.userTestId,
                                         appId: baseEyes.test.appId,
                                         baselineId: baseEyes.test.baselineId,
-                                        environmentId: (_h = baseEyes.test.environment) === null || _h === void 0 ? void 0 : _h.environmentId,
+                                        environmentId: (_j = baseEyes.test.environment) === null || _j === void 0 ? void 0 : _j.environmentId,
                                     },
                                     isNew: baseEyes.test.isNew,
                                     resultsUrl: baseEyes.test.resultsUrl,
@@ -182,7 +191,7 @@ function makeCheckAndClose({ eyes, target: defaultTarget, environments: defaultE
                     });
                 }
                 catch (error) {
-                    environmentLogger.error(`Render on environment with id "${(_j = baseEyes.test.environment) === null || _j === void 0 ? void 0 : _j.environmentId}" failed due to an error`, error);
+                    environmentLogger.error(`Render on environment with id "${(_k = baseEyes.test.environment) === null || _k === void 0 ? void 0 : _k.environmentId}" failed due to an error`, error);
                     if (baseEyes.running && !(signal === null || signal === void 0 ? void 0 : signal.aborted))
                         await baseEyes.abort({ logger: environmentLogger, settings: { reason: error } });
                 }

package/dist/ufg/check.js

@@ -38,6 +38,7 @@ const take_snapshots_1 = require("./take-snapshots");
 const create_render_target_from_snapshot_1 = require("./create-render-target-from-snapshot");
 const to_base_check_settings_1 = require("../automation/utils/to-base-check-settings");
 const to_old_infra_environment_1 = require("./to-old-infra-environment");
+const build_accessibility_report_options_1 = require("./build-accessibility-report-options");
 function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironments = [], spec, signal, logger: mainLogger, }) {
     // Sessions whose old-infra retry chain has ended: once a retry doesn't confirm an old-infra match,
     // the backend stops expecting retries, so we must stop sending them. baseEyes is cached per
@@ -122,7 +123,11 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
                         settings: snapshot.settings,
                     });
                     const renderForCheck = async (env) => {
-                        var _a;
+                        var _a, _b;
+                        // Only request a report when the check configures an accessibility standard.
+                        const accessibilityReportOptions = settings.accessibilitySettings
+                            ? (0, build_accessibility_report_options_1.buildAccessibilityReportOptions)({ accessibilityOptions: eyes.test.account.accessibilityOptions })
+                            : undefined;
                         const { renderId, selectorRegions, ...target } = await ufgClient.render({
                             target: renderTarget,
                             settings: {
@@ -134,6 +139,7 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
                                 environment: { ...env, environmentId: baseEyes.test.environment.environmentId },
                                 uploadUrl: baseEyes.test.uploadUrl,
                                 stitchingServiceUrl: baseEyes.test.stitchingServiceUrl,
+                                accessibilityReportOptions,
                             },
                             signal,
                             logger: environmentLogger,
@@ -149,6 +155,9 @@ function makeCheck({ eyes, target: defaultTarget, environments: defaultEnvironme
                         checkSettings.renderId = renderId;
                         target.source = snapshot.url;
                         target.name = snapshot.title;
+                        // Fall back to the minted upload URL when the render result carries no report location.
+                        if (accessibilityReportOptions === null || accessibilityReportOptions === void 0 ? void 0 : accessibilityReportOptions.uploadUrl)
+                            (_b = target.accessibilityReportLocation) !== null && _b !== void 0 ? _b : (target.accessibilityReportLocation = accessibilityReportOptions.uploadUrl);
                         return { target, settings: checkSettings };
                     };
                     const { target: baseTarget, settings: baseSettings } = await renderForCheck(environment);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/core",
-  "version": "4.67.2",
+  "version": "4.68.1",
   "homepage": "https://applitools.com",
   "bugs": {
     "url": "https://github.com/applitools/eyes.sdk.javascript1/issues"
@@ -61,19 +61,20 @@
     "setup:standalone": "sh -c 'yarn chromedriver --port=4444 --verbose &'"
   },
   "dependencies": {
-    "@applitools/core-base": "1.37.0",
-    "@applitools/dom-capture": "11.8.4",
-    "@applitools/dom-snapshot": "4.17.8",
-    "@applitools/driver": "1.26.7",
-    "@applitools/ec-client": "1.12.40",
-    "@applitools/logger": "2.3.0",
-    "@applitools/nml-client": "1.11.38",
-    "@applitools/req": "1.11.2",
-    "@applitools/screenshoter": "3.12.26",
-    "@applitools/snippets": "2.9.5",
-    "@applitools/socket": "1.3.15",
-    "@applitools/ufg-client": "1.22.5",
-    "@applitools/utils": "1.15.1",
+    "@applitools/core-base": "1.38.1",
+    "@applitools/dom-capture": "11.8.5",
+    "@applitools/dom-snapshot": "4.17.9",
+    "@applitools/driver": "1.26.8",
+    "@applitools/ec-client": "1.12.42",
+    "@applitools/image": "1.3.1",
+    "@applitools/logger": "2.3.1",
+    "@applitools/nml-client": "1.11.40",
+    "@applitools/req": "1.11.3",
+    "@applitools/screenshoter": "3.12.28",
+    "@applitools/snippets": "2.9.6",
+    "@applitools/socket": "1.3.16",
+    "@applitools/ufg-client": "1.23.1",
+    "@applitools/utils": "1.15.2",
     "abort-controller": "3.0.0",
     "chalk": "4.1.2",
     "node-fetch": "2.6.7",
@@ -83,13 +84,13 @@
   },
   "devDependencies": {
     "@applitools/bongo": "^5.10.0",
-    "@applitools/spec-driver-playwright": "^1.9.7",
-    "@applitools/spec-driver-puppeteer": "^1.8.7",
-    "@applitools/spec-driver-selenium": "^1.8.7",
-    "@applitools/spec-driver-webdriver": "^1.6.7",
-    "@applitools/test-server": "^1.4.6",
+    "@applitools/spec-driver-playwright": "^1.9.8",
+    "@applitools/spec-driver-puppeteer": "^1.8.8",
+    "@applitools/spec-driver-selenium": "^1.8.8",
+    "@applitools/spec-driver-webdriver": "^1.6.8",
+    "@applitools/test-server": "^1.4.7",
     "@applitools/test-utils": "^1.5.17",
-    "@applitools/tunnel-client": "^1.12.2",
+    "@applitools/tunnel-client": "^1.12.3",
     "@swc-node/register": "^1.6.8",
     "@types/mocha": "^10.0.7",
     "@types/node": "^12.20.55",
@@ -120,10 +121,10 @@
       "puppeteer": true,
       "ws>bufferutil": false,
       "ws>utf-8-validate": false,
-      "@applitools/core-base>@applitools/image>sharp": false,
       "@swc-node/register>@swc/core": false,
       "selenium-webdriver>ws>bufferutil": false,
-      "selenium-webdriver>ws>utf-8-validate": false
+      "selenium-webdriver>ws>utf-8-validate": false,
+      "@applitools/image>sharp": false
     }
   }
 }

package/types/automation/types.d.ts

@@ -3,6 +3,7 @@ import type * as BaseCore from '@applitools/core-base/types';
 import { type SpecType, type Driver, type ElementReference, type ContextReference } from '@applitools/driver';
 import { type NMLClient, type NMLClientSettings } from '@applitools/nml-client';
 import { type Logger } from '@applitools/logger';
+import type { FigmaOptions } from '../figma/types';
 export type * from '@applitools/core-base/types';
 export type DriverTarget<TSpec extends SpecType> = TSpec['driver'] | Driver<TSpec>;
 export type Target<TSpec extends SpecType> = DriverTarget<TSpec> | BaseCore.Target;
@@ -180,4 +181,12 @@ export type OpenSettings = BaseCore.OpenSettings & {
     disableBrokerUrlCache?: boolean;
     environments?: Environment[];
     bypassCSP?: boolean;
+    /**
+     * @internal Resolved in core's open-eyes (the Figma seam) before session creation and stripped
+     * from the wire config — it is not part of the cross-language wire contract, but is available to
+     * every SDK that routes its opens through core.
+     */
+    figmaBaselines?: string | Record<string, string | string[]>;
+    /** @internal Read and stripped by the Figma seam during open, like `figmaBaselines` — never reaches the wire. */
+    figmaOptions?: FigmaOptions;
 };

package/types/autonomous/types.d.ts

@@ -71,6 +71,7 @@ export type StartedRender = {
     settings: UFGCore.SafeCheckSettings;
     environment: UFGCore.ExactEnvironment;
     account: UFGCore.Account;
+    accessibilityReportLocation?: string;
 };
 export type RenderResult = {
     status: 'rendering' | 'rendered' | 'error';

package/types/check-and-close.d.ts

@@ -1,14 +1,15 @@
-import type { Target, DriverTarget, Eyes, Config, CheckSettings, CloseSettings } from './types';
+import type { Target, DriverTarget, Eyes, Config, CheckSettings, CloseSettings, Environment } from './types';
 import { type Logger } from '@applitools/logger';
 import { type SpecType, type SpecDriver } from '@applitools/driver';
 type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
     type?: TType;
     eyes: Eyes<TSpec, TType>;
     target?: DriverTarget<TSpec>;
+    environments?: Environment[];
     spec?: SpecDriver<TSpec>;
     logger: Logger;
 };
-export declare function makeCheckAndClose<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg'>({ type: defaultType, eyes, target: defaultTarget, spec, logger: mainLogger, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, target, settings, config, logger, }?: {
+export declare function makeCheckAndClose<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg'>({ type: defaultType, eyes, target: defaultTarget, environments: openEnvironments, spec, logger: mainLogger, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, target, settings, config, logger, }?: {
     type?: TType | undefined;
     target?: Target<TSpec, TType> | undefined;
     settings?: (CheckSettings<TSpec, TDefaultType> & CloseSettings<TDefaultType> & CheckSettings<TSpec, TType> & CloseSettings<TType>) | undefined;

package/types/check.d.ts

@@ -1,14 +1,15 @@
-import type { Target, DriverTarget, Eyes, Config, CheckSettings } from './types';
+import type { Target, DriverTarget, Eyes, Config, CheckSettings, Environment } from './types';
 import { type Logger } from '@applitools/logger';
 import { type SpecType, type SpecDriver } from '@applitools/driver';
 type Options<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = {
     type?: TType;
     eyes: Eyes<TSpec, TType>;
     target?: DriverTarget<TSpec>;
+    environments?: Environment[];
     spec?: SpecDriver<TSpec>;
     logger: Logger;
 };
-export declare function makeCheck<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg'>({ type: defaultType, eyes, target: defaultTarget, spec, logger: mainLogger, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, target, settings, config, logger, }?: {
+export declare function makeCheck<TSpec extends SpecType, TDefaultType extends 'classic' | 'ufg'>({ type: defaultType, eyes, target: defaultTarget, environments: openEnvironments, spec, logger: mainLogger, }: Options<TSpec, TDefaultType>): <TType extends "classic" | "ufg" = TDefaultType>({ type, target, settings, config, logger, }?: {
     type?: TType | undefined;
     target?: Target<TSpec, TType> | undefined;
     settings?: CheckSettings<TSpec, TType> | undefined;

package/types/figma/client/figma-req.d.ts

@@ -0,0 +1,9 @@
+import { type Req, type Proxy } from '@applitools/req';
+import { type Logger } from '@applitools/logger';
+export declare const FIGMA_API = "https://api.figma.com/v1";
+export type FigmaReqOptions = {
+    proxy?: Proxy;
+    logger?: Logger;
+    maxRateLimitWaitSeconds?: number;
+};
+export declare function makeFigmaReq({ proxy, logger, maxRateLimitWaitSeconds }?: FigmaReqOptions): Req;

package/types/figma/client/figma-rest.d.ts

@@ -0,0 +1,24 @@
+import { type Logger } from '@applitools/logger';
+import type { Proxy, Req } from '@applitools/req';
+import type { FigmaImageResult, FigmaNodeMetadata } from '../types';
+export type FigmaRestOptions = {
+    tempPath?: string;
+    nodesCacheTtlSeconds?: number;
+    maxRateLimitWaitSeconds?: number;
+    /** Serve from the on-disk caches only; throw on any miss. */
+    skipApi?: boolean;
+    proxy?: Proxy;
+    /** Defaults to `makeFigmaReq(…)`; tests inject a stub. */
+    req?: Req;
+    logger?: Logger;
+};
+/**
+ * Cache names are hashed because Figma node ids are not filename-safe — an instance node id looks like
+ * `I1:2;3:4`, and `:` / `;` are illegal on Windows.
+ *
+ * `test/fixtures/figma-cache/seed.mjs` mirrors both functions — keep them in sync.
+ */
+export declare function figmaNodesCacheFileName(fileId: string, uniqueNodeIds: string[]): string;
+export declare function figmaImageCacheFileName(fileId: string, nodeId: string, lastModifiedUnix: number): string;
+export declare function fetchFigmaMetadata(urls: string[], accessToken: string, opts?: FigmaRestOptions): Promise<FigmaNodeMetadata[]>;
+export declare function fetchFigmaImages(urls: string[], accessToken: string, opts?: FigmaRestOptions): Promise<FigmaImageResult[]>;

package/types/figma/client/index.d.ts

@@ -0,0 +1,2 @@
+export * from './figma-req';
+export * from './figma-rest';

package/types/figma/figma-images.d.ts

@@ -0,0 +1,6 @@
+export declare function createPlaceholderPng(width: number, height: number, tempPath: string): Promise<string>;
+export declare function createPaddedDesignImage(imagePath: string, width: number, height: number, minSize: number, tempPath: string): Promise<{
+    imagePath: string;
+    width: number;
+    height: number;
+}>;

package/types/figma/figma.d.ts

@@ -0,0 +1,21 @@
+import { type Logger } from '@applitools/logger';
+import type { Proxy, Req } from '@applitools/req';
+import type { OpenSettings } from '../automation/types';
+import { type FigmaMode } from './utils';
+import type { FigmaViewportOptions, FigmaBaselineDeps } from './types';
+export declare function setFigmaBaselineFlow(figmaUrls: string[], originalConfig: Partial<OpenSettings>, deps: FigmaBaselineDeps, mode?: Exclude<FigmaMode, 'disabled'>, viewportOpts?: FigmaViewportOptions, logger?: Logger): Promise<Partial<OpenSettings>>;
+export declare function setFigmaBaseline(configuration: Partial<OpenSettings>, figmaBaselines: string | Record<string, string | string[]>, opts?: {
+    accessToken?: string;
+    maxRateLimitWaitSeconds?: number;
+    nodesCacheTtlSeconds?: number;
+    tempPath?: string;
+    mode?: FigmaMode;
+    maxViewportHeight?: number;
+    minViewportSize?: number | null;
+    /** Serve from the disk caches only; throw on any miss. */
+    skipApi?: boolean;
+    proxy?: Proxy;
+    /** Defaults to the client's own req; tests inject a stub. */
+    req?: Req;
+    logger?: Logger;
+}): Promise<void>;

package/types/figma/index.d.ts

@@ -0,0 +1,8 @@
+export * from './types';
+export * from './utils';
+export * from './target-config';
+export * from './client';
+export * from './figma-images';
+export * from './figma';
+export { runFigmaCheck } from './run-figma-check';
+export { applyFigmaBaselines } from './seam';

package/types/figma/run-figma-check.d.ts

@@ -0,0 +1,13 @@
+import type { FigmaReferenceConfig } from './types';
+/**
+ * Establishes/updates the Figma-reference baseline via a throwaway headless classic image test (checks
+ * each PNG, closes, deletes the result — the saved baseline persists). Uses core's own API, not the
+ * eyes layer (core cannot depend on `@applitools/eyes`).
+ */
+export declare function runFigmaCheck(config: FigmaReferenceConfig, checks: Array<{
+    imagePath: string;
+    tag: string;
+}>): Promise<{
+    isNew: boolean;
+    diffs: boolean;
+}>;

package/types/figma/seam.d.ts

@@ -0,0 +1,12 @@
+import type { OpenSettings } from '../automation/types';
+import { type Logger } from '@applitools/logger';
+import { setFigmaBaseline } from './figma';
+/**
+ * @internal
+ * Resolves the `figmaBaselines` / `figmaOptions` open config once per open, then always strips both — they
+ * are off-the-wire and must never be logged or sent. The resolver mutates `settings` in place.
+ *
+ * The only place the Figma feature reads the environment; everything below it takes parameters. Each
+ * `figmaOptions` field wins over its env fallback.
+ */
+export declare function applyFigmaBaselines(settings: Partial<OpenSettings>, logger: Logger, resolve?: typeof setFigmaBaseline): Promise<void>;

package/types/figma/target-config.d.ts

@@ -0,0 +1,7 @@
+import type { OpenSettings, Environment } from '../automation/types';
+import { type FigmaMode } from './utils';
+import type { FigmaNodeMetadata, FigmaViewport, FigmaBaselineLink } from './types';
+export declare const DEFAULT_MAX_VIEWPORT_HEIGHT = 800;
+export declare const PLACEHOLDER_TAG = "(no design)";
+export declare function deduplicateBrowsers(environments: Environment[], targetWidth: number, targetHeight: number): Environment[];
+export declare function buildTargetTestConfig(originalConfig: Partial<OpenSettings>, metadata: FigmaNodeMetadata, figmaViewport: FigmaViewport, baselineLink: FigmaBaselineLink | null, mode: FigmaMode): Partial<OpenSettings>;

package/types/figma/types.d.ts

@@ -0,0 +1,69 @@
+import type { OpenSettings } from '../automation/types';
+import type { FigmaMode } from './utils';
+/**
+ * The user-facing `figmaOptions` open config. Precedence is per field, not per object: a field set here
+ * wins, one left unset falls back to that field's environment variable where it has one; `README.md`
+ * holds the per-field mapping.
+ *
+ * `APPLITOOLS_FIGMA_SKIP_API` has no field by design — it is a CI/debug switch, not a user option.
+ */
+export type FigmaOptions = FigmaViewportOptions & {
+    mode?: FigmaMode;
+    accessToken?: string;
+    maxRateLimitWaitSeconds?: number;
+    nodesCacheTtlSeconds?: number;
+    tempPath?: string;
+};
+export type FigmaNodeRef = {
+    fileId: string;
+    nodeId: string;
+};
+export type FigmaNodeMetadata = {
+    name: string;
+    type: string;
+    width: number;
+    height: number;
+    revision: string;
+    lastModifiedAt: string;
+};
+export type FigmaImageResult = {
+    imagePath: string;
+    metadata: FigmaNodeMetadata;
+};
+export type FigmaViewport = {
+    width: number;
+    height: number;
+};
+export type FigmaViewportOptions = {
+    maxViewportHeight?: number;
+    /**
+     * One dimension, not a width/height pair: the same floor applies to both axes independently, so 320
+     * means "at least 320 wide AND at least 320 tall". `null` disables the floor.
+     */
+    minViewportSize?: number | null;
+};
+export type FigmaBaselineLink = {
+    figmaEnvName: string;
+    useLatestEnvBaseline: boolean;
+};
+/** The throwaway Figma-reference test's config: a subset of core `OpenSettings` plus `saveNewTests` (maps to close's `updateBaselineIfNew`). */
+export type FigmaReferenceConfig = Partial<OpenSettings> & {
+    saveNewTests?: boolean;
+};
+export type FigmaBaselineDeps = {
+    fetchFigmaImages: (figmaUrls: string[]) => Promise<FigmaImageResult[]>;
+    fetchFigmaMetadata: (figmaUrls: string[]) => Promise<FigmaNodeMetadata[]>;
+    createPlaceholderImage: (width: number, height: number) => Promise<string>;
+    padDesignImage: (imagePath: string, width: number, height: number, minViewportSize: number) => Promise<{
+        imagePath: string;
+        width: number;
+        height: number;
+    }>;
+    runFigmaCheck: (config: FigmaReferenceConfig, checks: Array<{
+        imagePath: string;
+        tag: string;
+    }>) => Promise<{
+        isNew: boolean;
+        diffs: boolean;
+    }>;
+};

package/types/figma/utils.d.ts

@@ -0,0 +1,26 @@
+import type { FigmaNodeRef, FigmaNodeMetadata, FigmaViewport } from './types';
+export declare function isFigmaUrl(url: string): boolean;
+export declare function parseFigmaNodeUrl(url: string): FigmaNodeRef;
+/**
+ * The tag becomes the Eyes baseline step name, and Eyes matches steps by name, so it must derive only from
+ * stable identity. Figma's "Copy link to selection" appends a `t=` param that differs on every copy —
+ * keeping it means re-copying the link renames the step and orphans its accepted baseline.
+ *
+ * Drop only `t`: `node-id` is what distinguishes two frames of the same file, so stripping the whole query
+ * would give every frame in a file the same step name.
+ */
+export declare function figmaStepTag(figmaUrl: string): string;
+export declare function resolveFigmaUrls(figmaBaselines: string | Record<string, string | string[]>, testName: string | undefined): string[] | null;
+export declare const FIGMA_MODES: readonly ["figma-baseline", "test-baseline", "auto-baseline", "disabled"];
+export type FigmaMode = (typeof FIGMA_MODES)[number];
+export declare function resolveFigmaMode(value: string | undefined): FigmaMode;
+export declare function figmaMetadataToProperties(metadata: FigmaNodeMetadata, mode: FigmaMode): Array<{
+    name: string;
+    value: string;
+}>;
+export declare function boundingViewport(viewports: FigmaViewport[]): FigmaViewport;
+export declare function computeFigmaViewport(stepViewports: FigmaViewport[], maxViewportHeight: number): FigmaViewport;
+export declare function paddedDesignSize(width: number, height: number, minSize: number): {
+    width: number;
+    height: number;
+};

package/types/types.d.ts

@@ -8,6 +8,7 @@ import { type Logger } from '@applitools/logger';
 import { type ECClient, type ECClientSettings } from '@applitools/ec-client';
 export { ECClient };
 export * from './automation/types';
+export type { FigmaOptions } from './figma/types';
 export { DEFAULT_CONCURRENCY } from '@applitools/core-base';
 export type TypedCore<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.Core<TSpec> : ClassicCore.Core<TSpec>;
 export type TypedEyes<TSpec extends SpecType, TType extends 'classic' | 'ufg'> = TType extends 'ufg' ? UFGCore.Eyes<TSpec> : ClassicCore.Eyes<TSpec>;

package/types/ufg/build-accessibility-report-options.d.ts

@@ -0,0 +1,13 @@
+import { type Account } from '@applitools/core-base';
+/**
+ * Builds the `accessibilityReportOptions` render option: forwards `runOptions` verbatim and fills the
+ * `uploadUrl` template's `__report_id__` with a fresh random id. Returns `undefined` when the account
+ * has no accessibility options.
+ */
+export declare function buildAccessibilityReportOptions({ accessibilityOptions, reportId, }: {
+    accessibilityOptions?: Account['accessibilityOptions'];
+    reportId?: string;
+}): {
+    axeCoreOptions: unknown;
+    uploadUrl: string;
+} | undefined;