@applitools/eyes 1.28.0 → 1.29.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [1.29.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes@1.28.0...js/eyes@1.29.0) (2024-11-29)
+
+
+### Features
+
+* offline cli with config ([#2646](https://github.com/Applitools-Dev/sdk/issues/2646)) ([0589dc4](https://github.com/Applitools-Dev/sdk/commit/0589dc429a0c94451e957932106f258dadfd88cc))
+
+
+### Dependencies
+
+* @applitools/core bumped to 4.25.0
+  #### Features
+
+  * offline cli with config ([#2646](https://github.com/Applitools-Dev/sdk/issues/2646)) ([0589dc4](https://github.com/Applitools-Dev/sdk/commit/0589dc429a0c94451e957932106f258dadfd88cc))
+
 ## [1.28.0](https://github.com/Applitools-Dev/sdk/compare/js/eyes@1.27.0...js/eyes@1.28.0) (2024-11-27)
 
 

package/dist/cli/cli.js

@@ -0,0 +1,47 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint no-console: off */
+const core_1 = require("@applitools/core");
+const yargs_1 = __importDefault(require("yargs"));
+const Configuration_1 = require("../input/Configuration");
+const load_config_1 = require("./load-config");
+void yargs_1.default
+    .example([['eyes run-offline-snapshots', 'Run Eyes visual tests on existing snapshots']])
+    .command({
+    command: 'run-offline-snapshots',
+    builder: yargs => {
+        return yargs
+            .options({
+            offlineLocationPath: {
+                description: 'path to offline snapshots folder',
+                type: 'string',
+            },
+            failOnDiff: {
+                description: 'should exit process with non-zero exit code, thereby failing the CI job',
+                type: 'boolean',
+                default: false,
+            },
+            configPath: {
+                description: 'path to configuration file (applitools.config.js / applitools.config.ts)',
+                type: 'string',
+            },
+        })
+            .fail((_msg, err, _yargs) => {
+            if (err) {
+                console.error(err.message);
+                // console.log(err)
+                process.exit(1);
+            }
+        });
+    },
+    handler: async (args) => {
+        const config = await (0, load_config_1.loadConfig)(args.configPath);
+        const options = { ...args, config: new Configuration_1.ConfigurationData(config).toJSON() };
+        await (0, core_1.runOfflineSnapshots)(options);
+    },
+})
+    .wrap(yargs_1.default.terminalWidth()).argv;

package/dist/cli/load-config.js

@@ -0,0 +1,73 @@
+"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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadConfig = void 0;
+/* eslint no-console: off */
+const utils = __importStar(require("@applitools/utils"));
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const chalk = __importStar(require("chalk"));
+async function loadConfig(configPath) {
+    const configPathArr = configPath ? [configPath] : [];
+    const paths = configPathArr.concat(['applitools.config.js']);
+    let config = {};
+    try {
+        config = utils.config.getConfig({
+            paths,
+            traverse: false,
+            strict: true,
+        });
+        // @ts-ignore
+        if (config.__esModule) {
+            // @ts-ignore
+            config = config.default;
+        }
+    }
+    catch (err) {
+        if (err.code === 'ERR_REQUIRE_ESM') {
+            const resolvedPaths = paths.map(probablePath => path_1.default.resolve(process.cwd(), probablePath));
+            const foundPath = resolvedPaths.find(resolvedPath => fs_1.default.existsSync(resolvedPath));
+            if (foundPath) {
+                try {
+                    config = await import(foundPath);
+                }
+                catch (err) {
+                    console.warn(chalk.yellow(err.message));
+                }
+            }
+            else {
+                console.warn(chalk.yellow('Could not find configuration file.'));
+            }
+        }
+        else {
+            console.warn(chalk.yellow(err.message));
+        }
+    }
+    return config;
+}
+exports.loadConfig = loadConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@applitools/eyes",
-  "version": "1.28.0",
+  "version": "1.29.0",
   "keywords": [
     "applitools",
     "eyes",
@@ -39,15 +39,17 @@
     "dist",
     "types"
   ],
+  "bin": "./dist/cli/cli.js",
   "scripts": {
     "lint": "run --top-level eslint '**/*.ts'",
     "build": "run --top-level tsc --project ./tsconfig.build.json",
     "test": "run --top-level mocha './test/**/*.spec.ts'"
   },
   "dependencies": {
-    "@applitools/core": "4.24.2",
+    "@applitools/core": "4.25.0",
     "@applitools/logger": "2.0.19",
-    "@applitools/utils": "1.7.5"
+    "@applitools/utils": "1.7.5",
+    "chalk": "4.1.2"
   },
   "devDependencies": {
     "@applitools/req": "^1.7.4",

package/types/cli/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/types/cli/load-config.d.ts

@@ -0,0 +1 @@
+export declare function loadConfig(configPath: string): Promise<object>;