bdy 1.25.2-dev → 1.25.2-stage

package/distTs/src/command/vt/installBrowser.js

@@ -1,20 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("../../utils");
-const texts_1 = require("../../texts");
-const output_1 = __importDefault(require("../../output"));
-const commandVtInstallBrowser = (0, utils_1.newCommand)('install-browser', texts_1.DESC_COMMAND_VT_INSTALL_BROWSER);
-commandVtInstallBrowser.action(async () => {
-    try {
-        const { installBrowser } = require('../../visualTest/browser');
-        await installBrowser();
-        output_1.default.exitNormal('');
-    }
-    catch (error) {
-        output_1.default.exitError(`${error}`);
-    }
-});
-exports.default = commandVtInstallBrowser;

package/distTs/src/command/vt/scrape.js

@@ -1,193 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("../../utils");
-const commander_1 = require("commander");
-const texts_1 = require("../../texts");
-const validation_1 = require("../../visualTest/validation");
-const output_1 = __importDefault(require("../../output"));
-const requests_1 = require("../../visualTest/requests");
-const zod_1 = require("zod");
-const node_zlib_1 = require("node:zlib");
-const tar_stream_1 = __importDefault(require("tar-stream"));
-const promises_1 = require("node:stream/promises");
-const node_fs_1 = require("node:fs");
-const node_path_1 = __importDefault(require("node:path"));
-const promises_2 = require("node:fs/promises");
-const commandScrape = (0, utils_1.newCommand)('scrape', texts_1.DESC_COMMAND_VT_SCRAPE);
-commandScrape.argument('<url>', texts_1.OPTION_SCRAPE_URL);
-commandScrape.option('--follow', texts_1.OPTION_SCRAPE_FOLLOW, false);
-commandScrape.addOption(new commander_1.Option('--outputType <type>', texts_1.OPTION_SCRAPE_OUTPUT_TYPE)
-    .choices(['jpeg', 'png', 'md', 'html'])
-    .makeOptionMandatory());
-commandScrape.option('--quality <quality>', texts_1.OPTION_SCRAPE_QUALITY);
-commandScrape.option('--fullPage', texts_1.OPTION_SCRAPE_FULL_PAGE, false);
-commandScrape.option('--cssSelector <selector>', texts_1.OPTION_SCRAPE_CSS_SELECTOR);
-commandScrape.option('--xpathSelector <selector>', texts_1.OPTION_SCRAPE_XPATH_SELECTOR);
-commandScrape.addOption(new commander_1.Option('--browser <browser>', texts_1.OPTION_SCRAPE_BROWSER)
-    .choices(['chrome', 'firefox', 'safari'])
-    .default('chrome'));
-commandScrape.option('--viewport <viewport>', texts_1.OPTION_SCRAPE_VIEWPORT, '1920x1080');
-commandScrape.option('--devicePixelRatio <ratio>', texts_1.OPTION_SCRAPE_DEVICE_PIXEL_RATIO, '1');
-commandScrape.option('--waitForElement <selector>', texts_1.OPTION_SCRAPE_WAIT_FOR_ELEMENT);
-commandScrape.option('--darkMode', texts_1.OPTION_SCRAPE_DARK_MODE, false);
-commandScrape.option('--delay <delay>', texts_1.OPTION_SCRAPE_DELAY, '0');
-commandScrape.option('--outputDir <dir>', texts_1.OPTION_SCRAPE_OUTPUT_DIR, '.');
-commandScrape.action(async (inputUrl, options) => {
-    if (!(0, validation_1.checkToken)()) {
-        output_1.default.exitError(texts_1.ERR_MISSING_VT_TOKEN);
-    }
-    const { url, follow, outputType, quality, outputDir, fullPage, cssSelector, xpathSelector, browser, viewport, devicePixelRatio, darkMode, delay, waitForElement, } = validateInputAndOptions(inputUrl, options);
-    try {
-        const { buildId } = await (0, requests_1.sendScrap)(url, outputType, follow, quality, fullPage, cssSelector, xpathSelector, browser, viewport, devicePixelRatio, darkMode, delay, waitForElement);
-        output_1.default.normal('Starting scrape session');
-        const status = await watchSessionStatus(buildId);
-        if (!status.ok) {
-            output_1.default.exitError(`Unexpected error while watching session status: ${status.error}`);
-        }
-        output_1.default.normal('Downloading scrape package');
-        const scrapPackageStream = await (0, requests_1.downloadScrapPackage)(buildId);
-        const brotliDecompressor = (0, node_zlib_1.createBrotliDecompress)();
-        const unpack = tar_stream_1.default.extract();
-        unpack.on('entry', async (header, stream, next) => {
-            const currentDir = process.cwd();
-            const preparedOutputDir = outputDir.startsWith('.')
-                ? node_path_1.default.join(currentDir, outputDir)
-                : outputDir;
-            const newFilePath = node_path_1.default.join(preparedOutputDir, header.name);
-            try {
-                if (header.type === 'file') {
-                    await (0, promises_2.mkdir)(node_path_1.default.dirname(newFilePath), { recursive: true });
-                    const fileWriteStream = (0, node_fs_1.createWriteStream)(newFilePath);
-                    await (0, promises_1.pipeline)(stream, fileWriteStream);
-                    next();
-                }
-                else {
-                    stream.resume();
-                    next();
-                }
-            }
-            catch (entryError) {
-                output_1.default.error(`Error processing entry ${header.name}: ${entryError}`);
-                next(entryError);
-            }
-        });
-        await (0, promises_1.pipeline)(scrapPackageStream, brotliDecompressor, unpack);
-        output_1.default.exitSuccess('Downloading scrape package finished');
-    }
-    catch (error) {
-        output_1.default.exitError(`${error}`);
-    }
-});
-function validateInputAndOptions(input, options) {
-    const urlSchema = zod_1.z.string().url();
-    const optionsSchema = zod_1.z.object({
-        follow: zod_1.z.boolean(),
-        outputType: zod_1.z.enum(['jpeg', 'png', 'md', 'html']),
-        quality: zod_1.z.coerce.number().min(1).max(100).optional(),
-        outputDir: zod_1.z.string().default('.'),
-        fullPage: zod_1.z.boolean().optional(),
-        cssSelector: zod_1.z.string().optional(),
-        xpathSelector: zod_1.z.string().optional(),
-        browser: zod_1.z.enum(['chrome', 'firefox', 'safari']),
-        viewport: zod_1.z
-            .string()
-            .refine((value) => {
-            const [width, height] = value.split('x');
-            return (width &&
-                height &&
-                !isNaN(Number(width)) &&
-                !isNaN(Number(height)) &&
-                Number(width) > 0 &&
-                Number(height) > 0);
-        }, 'Invalid viewport format, example: 1920x1080')
-            .transform((value) => {
-            const [width, height] = value.split('x');
-            return {
-                width: Number(width),
-                height: Number(height),
-            };
-        }),
-        devicePixelRatio: zod_1.z.coerce.number().min(1).max(4),
-        darkMode: zod_1.z.boolean(),
-        delay: zod_1.z.coerce.number().min(0).max(10000),
-        waitForElement: zod_1.z.string().optional(),
-    });
-    try {
-        const url = urlSchema.parse(input);
-        const { follow, outputType, quality, outputDir, fullPage, cssSelector, xpathSelector, browser, viewport, devicePixelRatio, darkMode, delay, waitForElement, } = optionsSchema.parse(options);
-        if (typeof quality === 'number' && outputType !== 'jpeg') {
-            output_1.default.exitError('Quality is only supported for jpeg output type, use --outputType jpeg');
-        }
-        if (cssSelector && xpathSelector) {
-            output_1.default.exitError('Only one of --cssSelector or --xpathSelector can be used');
-        }
-        return {
-            url,
-            follow,
-            outputType,
-            quality,
-            outputDir,
-            fullPage,
-            cssSelector,
-            xpathSelector,
-            browser,
-            viewport,
-            devicePixelRatio,
-            darkMode,
-            delay,
-            waitForElement,
-        };
-    }
-    catch (error) {
-        if (error instanceof zod_1.ZodError) {
-            output_1.default.exitError(error.errors.map((e) => `${e.path}: ${e.message}`).join(', '));
-        }
-        else {
-            throw error;
-        }
-    }
-}
-async function watchSessionStatus(buildId) {
-    return new Promise((resolve) => {
-        const eventSource = (0, requests_1.connectToScrapSession)(buildId);
-        eventSource.addEventListener('SESSION_STATUS', (event) => {
-            const data = JSON.parse(event.data);
-            if (data.status === 'GATHER_URLS_COMPLETED') {
-                output_1.default.normal(`Gathering URLs completed, found ${data.text} URLs`);
-            }
-            else if (data.status === 'GATHER_URLS_FAILED') {
-                output_1.default.error('Gathering URLs failed');
-            }
-            else if (data.status === 'SCRAPE_URL_COMPLETED') {
-                output_1.default.normal(`Scraping ${data.text} completed`);
-            }
-            else if (data.status === 'SCRAPE_URL_FAILED') {
-                output_1.default.error(`Scraping ${data.text} failed`);
-            }
-            else if (data.status === 'CREATE_PACKAGE_COMPLETED') {
-                output_1.default.normal('Package created');
-            }
-            else if (data.status === 'CREATE_PACKAGE_FAILED') {
-                output_1.default.error('Package creation failed');
-            }
-            else if (data.status === 'FINISHED') {
-                eventSource.close();
-                output_1.default.normal('Scrape session finished');
-                resolve({ ok: true });
-            }
-        });
-        eventSource.addEventListener('error', (event) => {
-            if (event.code) {
-                eventSource.close();
-                if (event.code === 410) {
-                    output_1.default.normal('Scrape session finished');
-                }
-                resolve({ ok: event.code === 410, error: event.code });
-            }
-        });
-    });
-}
-exports.default = commandScrape;

package/distTs/src/command/vt/shared/validation.js

@@ -1,145 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.waitForSchema = exports.delaySchema = exports.headerSchema = exports.cookieSchema = exports.DEFAULT_SCOPE = void 0;
-exports.parseScopedSelector = parseScopedSelector;
-exports.parseScopedKeyValue = parseScopedKeyValue;
-const zod_1 = require("zod");
-const output_1 = __importDefault(require("../../../output"));
-exports.DEFAULT_SCOPE = '**';
-function parseScopedSelector(value) {
-    return value?.map((v) => {
-        let scope, type, selectorValue;
-        if (v.includes('::CSS=') || v.includes('::XPATH=')) {
-            const [scopePart, ...rest] = v.split('::');
-            const [typePart, ...valuePart] = rest.join('::').split('=');
-            type = typePart;
-            selectorValue = valuePart.join('=');
-            scope = scopePart;
-        }
-        else {
-            const [typePart, ...valuePart] = v.split('=');
-            type = typePart;
-            selectorValue = valuePart.join('=');
-            scope = exports.DEFAULT_SCOPE;
-        }
-        return { scope, type, value: selectorValue };
-    });
-}
-function parseScopedKeyValue(rawValue) {
-    let scope = exports.DEFAULT_SCOPE;
-    let keyValue = rawValue;
-    const scopeSeparatorIndex = rawValue.indexOf('::');
-    if (scopeSeparatorIndex >= 0) {
-        scope = rawValue.slice(0, scopeSeparatorIndex).trim();
-        keyValue = rawValue.slice(scopeSeparatorIndex + 2).trim();
-    }
-    const equalSignIndex = keyValue.indexOf('=');
-    if (equalSignIndex <= 0) {
-        output_1.default.exitError("Option value must follow pattern '[scope::]key=value' (scope is optional)");
-    }
-    const key = keyValue.slice(0, equalSignIndex).trim();
-    const value = keyValue.slice(equalSignIndex + 1).trim();
-    if (!key) {
-        output_1.default.exitError('Option key cannot be empty');
-    }
-    return { scope, key, value };
-}
-exports.cookieSchema = zod_1.z
-    .array(zod_1.z
-    .string()
-    .max(4096, {
-    message: 'Cookie must be less than 4096 characters',
-})
-    .regex(/^(?:([^:]+)::)?([^=]+)=(.*)$/, {
-    message: "Cookie option must follow pattern '[scope::]key=value[;attribute]' (scope is optional)",
-}))
-    .optional()
-    .transform((value) => value?.map((v) => {
-    let scope = exports.DEFAULT_SCOPE;
-    let cookieValue = v;
-    if (v.includes('::')) {
-        const [scopePart, valuePart] = v.split('::');
-        scope = scopePart.trim();
-        cookieValue = valuePart.trim();
-    }
-    const cookieParts = cookieValue.split(';').map((part) => part.trim());
-    const mainPart = cookieParts[0];
-    const firstEqualSignIndex = mainPart.indexOf('=');
-    const key = mainPart.slice(0, firstEqualSignIndex).trim();
-    const value = mainPart.slice(firstEqualSignIndex + 1).trim();
-    const cookie = {
-        scope,
-        key,
-        value,
-        httpOnly: false,
-        secure: false,
-    };
-    for (let i = 1; i < cookieParts.length; i++) {
-        const part = cookieParts[i].toLowerCase();
-        if (part === 'httponly') {
-            cookie.httpOnly = true;
-        }
-        else if (part === 'secure') {
-            cookie.secure = true;
-        }
-        else if (part.startsWith('domain=')) {
-            cookie.domain = part.substring(7);
-        }
-        else if (part.startsWith('path=')) {
-            cookie.path = part.substring(5);
-        }
-        else if (part.startsWith('samesite=')) {
-            const sameSiteValue = part.substring(9);
-            if (['strict', 'lax', 'none'].includes(sameSiteValue)) {
-                cookie.sameSite = (sameSiteValue.charAt(0).toUpperCase() +
-                    sameSiteValue.slice(1));
-            }
-        }
-    }
-    return cookie;
-}));
-exports.headerSchema = zod_1.z
-    .array(zod_1.z.string().regex(/^(?:([^:]+)::)?([^=]+)=(.*)$/, {
-    message: "Header option must follow pattern '[scope::]key=value' (scope is optional)",
-}))
-    .optional()
-    .transform((value) => value?.map((v) => {
-    const { scope, key, value } = parseScopedKeyValue(v);
-    return { scope, key, value };
-}));
-exports.delaySchema = zod_1.z
-    .array(zod_1.z.string().regex(/^(?:([^:]+)::)?(\d+)$/, {
-    message: "Delay option must follow pattern '[scope::]milliseconds' (scope is optional)",
-}))
-    .optional()
-    .transform((value) => value?.map((v) => {
-    let scope = exports.DEFAULT_SCOPE;
-    let milliseconds;
-    if (v.includes('::')) {
-        const [scopePart, msPart] = v.split('::');
-        scope = scopePart.trim();
-        milliseconds = Number(msPart);
-    }
-    else {
-        milliseconds = Number(v);
-    }
-    if (milliseconds < 1 || milliseconds > 60000) {
-        throw new zod_1.z.ZodError([
-            {
-                code: 'custom',
-                message: 'Delay must be between 1 and 60000 milliseconds',
-                path: [],
-            },
-        ]);
-    }
-    return { scope, value: milliseconds };
-}));
-exports.waitForSchema = zod_1.z
-    .array(zod_1.z.string().regex(/^(?:([^:]+)::)?(?:(CSS|XPATH))=(.+)$/, {
-    message: "WaitFor option must follow pattern '[scope::]type=value' where type must be CSS or XPATH (scope is optional)",
-}))
-    .optional()
-    .transform(parseScopedSelector);

package/distTs/src/command/vt/storybook.js

@@ -1,138 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("../../utils");
-const texts_1 = require("../../texts");
-const output_1 = __importDefault(require("../../output"));
-const node_fs_1 = require("node:fs");
-const node_path_1 = __importDefault(require("node:path"));
-const node_zlib_1 = require("node:zlib");
-const commandVtStorybook = (0, utils_1.newCommand)('storybook', texts_1.DESC_COMMAND_VT_STORYBOOK);
-commandVtStorybook.action(async () => {
-    const { getCiAndGitInfo, formattedCiInfo } = require('@buddy-works/ci-info');
-    const { checkToken } = require('../../visualTest/validation');
-    const { getDefaultSettings, sendStorybook } = require('../../visualTest/requests');
-    const { setDefaultSettings } = require('../../visualTest/snapshots');
-    const { setCiAndCommitInfo } = require('../../visualTest/context');
-    if (!checkToken('vt')) {
-        output_1.default.exitError(texts_1.ERR_MISSING_VT_TOKEN);
-    }
-    const currentDirectoryFiles = getCurrentDirectoryFiles();
-    if (!isStorybookDirectory(currentDirectoryFiles)) {
-        output_1.default.exitError(texts_1.ERR_WRONG_STORYBOOK_DIRECTORY);
-    }
-    const storybookStoriesIndex = getStorybookStoriesIndex(currentDirectoryFiles);
-    const storiesList = getStoriesList(storybookStoriesIndex);
-    const storybookSnapshots = getStorybookSnapshots(storiesList);
-    const defaultSettings = await getDefaultSettings();
-    setDefaultSettings(defaultSettings);
-    const ciAndGitInfo = await getCiAndGitInfo({
-        baseBranch: defaultSettings.baseBranch,
-        logger: output_1.default.warning,
-    });
-    setCiAndCommitInfo(ciAndGitInfo);
-    output_1.default.normal(formattedCiInfo(ciAndGitInfo));
-    try {
-        const compressedStorybookDirectory = await createCompressedStorybookDirectory(currentDirectoryFiles);
-        const { message } = await sendStorybook(storybookSnapshots, compressedStorybookDirectory);
-        output_1.default.exitSuccess(message);
-    }
-    catch (error) {
-        output_1.default.exitError(`${error}`);
-    }
-});
-function getCurrentDirectoryFiles() {
-    const cwd = process.cwd();
-    const filesAndDirectories = (0, node_fs_1.readdirSync)(cwd, {
-        encoding: 'utf8',
-        recursive: true,
-    });
-    return filesAndDirectories.filter((file) => {
-        const elementPath = node_path_1.default.join(cwd, file);
-        const stats = (0, node_fs_1.statSync)(elementPath);
-        return stats.isFile();
-    });
-}
-async function createCompressedStorybookDirectory(files) {
-    const tar = require('tar-stream');
-    const cwd = process.cwd();
-    const chunks = [];
-    return new Promise((resolve, reject) => {
-        const compressStream = (0, node_zlib_1.createBrotliCompress)({
-            params: {
-                [node_zlib_1.constants.BROTLI_PARAM_QUALITY]: 6,
-            },
-        });
-        compressStream.on('data', (chunk) => {
-            chunks.push(chunk);
-        });
-        compressStream.on('end', () => {
-            resolve(Buffer.concat(chunks));
-        });
-        compressStream.on('error', reject);
-        const packStream = tar.pack();
-        packStream.pipe(compressStream);
-        let filesProcessed = 0;
-        for (const file of files) {
-            const filePath = node_path_1.default.join(cwd, file);
-            const stats = (0, node_fs_1.statSync)(filePath);
-            const entry = packStream.entry({
-                name: file,
-                size: stats.size,
-            }, (error) => {
-                if (error) {
-                    reject(error);
-                }
-                else {
-                    filesProcessed += 1;
-                    if (filesProcessed === files.length) {
-                        packStream.finalize();
-                    }
-                }
-            });
-            const fileStream = (0, node_fs_1.createReadStream)(filePath);
-            fileStream.pipe(entry);
-            fileStream.on('error', reject);
-        }
-    });
-}
-function isStorybookDirectory(files) {
-    return (files.length > 0 &&
-        files.includes('index.html') &&
-        files.includes('iframe.html'));
-}
-function getStorybookStoriesIndex(files) {
-    const indexFiles = files.find((file) => file === 'index.json');
-    if (indexFiles) {
-        return indexFiles;
-    }
-    else {
-        return output_1.default.exitError(texts_1.ERR_MISSING_STORYBOOK_INDEX_FILE);
-    }
-}
-function getStoriesList(storybookStoriesIndex) {
-    const storiesListFile = (0, node_fs_1.readFileSync)(storybookStoriesIndex);
-    try {
-        const json = JSON.parse(storiesListFile.toString());
-        if (![4, 5].includes(json.v)) {
-            output_1.default.exitError(texts_1.ERR_UNSUPPORTED_STORYBOOK);
-        }
-        return json;
-    }
-    catch {
-        output_1.default.exitError(texts_1.ERR_PARSING_STORIES);
-    }
-}
-function getStorybookSnapshots(storiesList) {
-    const stories = Object.entries(storiesList.entries)
-        .filter(([, value]) => value.type === 'story')
-        .map(([key, value]) => ({
-        id: key,
-        name: `${value.title}/${value.name}`,
-    }));
-    output_1.default.normal((0, texts_1.TXT_STORIES_AMOUNT)(stories.length));
-    return stories;
-}
-exports.default = commandVtStorybook;

package/distTs/src/command/vt.js

@@ -1,20 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const texts_1 = require("../texts");
-const utils_1 = require("../utils");
-const close_1 = __importDefault(require("./vt/close"));
-const storybook_1 = __importDefault(require("./vt/storybook"));
-const exec_1 = __importDefault(require("./vt/exec"));
-const installBrowser_1 = __importDefault(require("./vt/installBrowser"));
-const compare_1 = __importDefault(require("./vt/compare"));
-const commandVt = (0, utils_1.newCommand)('visual', texts_1.DESC_COMMAND_VT);
-commandVt.alias('vt');
-commandVt.addCommand(close_1.default);
-commandVt.addCommand(storybook_1.default);
-commandVt.addCommand(exec_1.default);
-commandVt.addCommand(installBrowser_1.default);
-commandVt.addCommand(compare_1.default);
-exports.default = commandVt;