bdy 1.22.44-dev-distro → 1.22.44-dev

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

@@ -0,0 +1,193 @@
+"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/whoami.js

@@ -10,7 +10,8 @@ const output_1 = __importDefault(require("../output"));
 const input_1 = __importDefault(require("../input"));
 const cfg_2 = __importDefault(require("../project/cfg"));
 const commandWhoami = (0, utils_1.newCommand)('whoami', texts_1.DESC_COMMAND_WHOAMI);
-commandWhoami.action(async () => {
+commandWhoami.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandWhoami.action(async (options) => {
     const workspace = cfg_1.default.getWorkspace();
     const localWorkspace = cfg_2.default.getWorkspace();
     const localProject = cfg_2.default.getProject();
@@ -20,27 +21,35 @@ commandWhoami.action(async () => {
         output_1.default.exitError(texts_1.ERR_WHOAMI_LOGOUT);
     }
     const email = await (0, utils_1.tryGetEmail)(client);
-    output_1.default.normal(`User: ${user.name}${email ? ` (${email})` : ''}`);
+    const obj = {
+        'User': `${user.name}${email ? ` (${email})` : ''}`
+    };
     if (localWorkspace) {
-        output_1.default.normal(`Workspace: ${localWorkspace}`);
+        obj.Workspace = localWorkspace;
     }
     else {
-        output_1.default.normal(`Workspace: ${!workspace ? texts_1.TXT_WHOAMI_NO_WORKSPACE : workspace}`);
+        obj.Workspace = !workspace ? texts_1.TXT_WHOAMI_NO_WORKSPACE : workspace;
     }
     if (localProject) {
-        output_1.default.normal(`Project: ${localProject}`);
+        obj.Project = localProject;
     }
     const vtSuite = cfg_2.default.getVtSuite();
     const utSuite = cfg_2.default.getUtSuite();
     const crawlSuite = cfg_2.default.getCrawlSuite();
     if (vtSuite) {
-        output_1.default.normal(`Visual test suite: ${vtSuite}`);
+        obj['Visual test suite'] = vtSuite;
     }
     if (utSuite) {
-        output_1.default.normal(`Unit test suite: ${utSuite}`);
+        obj['Unit test suite'] = utSuite;
     }
     if (crawlSuite) {
-        output_1.default.normal(`Crawl suite: ${crawlSuite}`);
+        obj['Crawl suite'] = crawlSuite;
+    }
+    if (options.format === 'json') {
+        output_1.default.json(obj);
+    }
+    else {
+        output_1.default.object(obj);
     }
     output_1.default.exitNormal();
 });

package/distTs/src/command/workspace/list.js

@@ -9,18 +9,24 @@ const utils_1 = require("../../utils");
 const input_1 = __importDefault(require("../../input"));
 const commandWorkspaceList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_WORKSPACE_LIST);
 commandWorkspaceList.alias('ls');
-commandWorkspaceList.action(async () => {
+commandWorkspaceList.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandWorkspaceList.action(async (options) => {
     const client = input_1.default.restApiTokenClient();
     const response = await client.getWorkspaces();
-    if (!response.workspaces || response.workspaces.length === 0) {
-        output_1.default.normal('No workspaces found.');
-        output_1.default.exitNormal();
+    if (options.format === 'json') {
+        output_1.default.json(response.workspaces || []);
     }
-    const data = [['NAME', 'DOMAIN', 'URL']];
-    for (const ws of response.workspaces) {
-        data.push([ws.name, ws.domain, ws.html_url]);
+    else {
+        if (!response.workspaces || response.workspaces.length === 0) {
+            output_1.default.normal('No workspaces found.');
+            output_1.default.exitNormal();
+        }
+        const data = [['NAME', 'DOMAIN', 'URL']];
+        for (const ws of response.workspaces) {
+            data.push([ws.name, ws.domain, ws.html_url]);
+        }
+        output_1.default.table(data);
     }
-    output_1.default.table(data);
     output_1.default.exitNormal();
 });
 exports.default = commandWorkspaceList;

package/distTs/src/output.js

@@ -251,10 +251,10 @@ class Output {
             this.tunnelNonInteractive(tunnel);
     }
     static object(data) {
-        const table = [['Field', 'Value'], ...Object.entries(data)];
-        this.table(table);
+        const table = [...Object.entries(data)];
+        this.table(table, false);
     }
-    static table(data) {
+    static table(data, firstRowBlue = true) {
         // apply padding
         for (let i = 0; i < data.length; i += 1) {
             for (let j = 0; j < data[i].length; j += 1) {
@@ -266,11 +266,13 @@ class Output {
                 data[i][j] = tmp.join('\n');
             }
         }
-        getTerminal().table(data, {
+        const opts = {
             fit: false,
             hasBorder: false,
-            firstRowTextAttr: { color: 'blue' },
-        });
+        };
+        if (firstRowBlue)
+            opts.firstRowTextAttr = { color: 'blue' };
+        getTerminal().table(data, opts);
     }
     static configTunnels(tunnels) {
         const OutputNoninteractiveConfigTunnels = require('./tunnel/output/noninteractive/config/tunnels').default;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bdy",
   "preferGlobal": false,
-  "version": "1.22.44-dev-distro",
+  "version": "1.22.44-dev",
   "type": "commonjs",
   "license": "MIT",
   "scripts": {

package/distTs/src/command/pipeline/run/apply.js

@@ -1,62 +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 input_1 = __importDefault(require("../../../input"));
-const output_1 = __importDefault(require("../../../output"));
-const pipeline_1 = require("../../../types/pipeline");
-const commandPipelineRunApply = (0, utils_1.newCommand)('apply', texts_1.DESC_COMMAND_PIPELINE_RUN_APPLY);
-commandPipelineRunApply.option('-w, --workspace <domain>', texts_1.OPTION_REST_API_WORKSPACE);
-commandPipelineRunApply.option('-p, --project <name>', texts_1.OPTION_REST_API_PROJECT);
-commandPipelineRunApply.option('-n, --no-wait', texts_1.OPTION_PIPELINE_RUN_NO_WAIT);
-commandPipelineRunApply.argument('<identifier>', texts_1.OPTION_PIPELINE_RUN_ARGUMENT);
-commandPipelineRunApply.argument('<run-id>', texts_1.OPTION_PIPELINE_RUN_ID);
-commandPipelineRunApply.argument('<run-action-id>', texts_1.OPTION_PIPELINE_RUN_ACTION_ID);
-commandPipelineRunApply.option('-v,--variable <variables...>', texts_1.OPTION_PIPELINE_RUN_VAR);
-commandPipelineRunApply.addHelpText('after', texts_1.EXAMPLE_PIPELINE_RUN_APPLY);
-commandPipelineRunApply.action(async (identifier, runId, runActionId, options) => {
-    const workspace = input_1.default.restApiWorkspace(options.workspace);
-    const project = input_1.default.restApiProject(options.project);
-    const rid = input_1.default.pipelineRunId(runId);
-    const variables = input_1.default.pipelineRunVariable(options.variable || [], false);
-    const client = input_1.default.restApiTokenClient();
-    const data = await client.getPipelineByIdentifier(workspace, project, identifier);
-    if (!data || !data.domain) {
-        output_1.default.exitError(texts_1.ERR_WORKSPACE_NOT_FOUND);
-    }
-    if (!data.project_identifier) {
-        output_1.default.exitError(texts_1.ERR_PROJECT_NOT_FOUND);
-    }
-    if (!data.pipeline_id) {
-        output_1.default.exitError(texts_1.ERR_PIPELINE_NOT_FOUND);
-    }
-    const a = await client.getPipelineRunActionExecution(workspace, project, data.pipeline_id, rid, runActionId);
-    let type;
-    if (a.status === pipeline_1.PIPELINE_RUN_STATUS.WAITING_FOR_APPLY) {
-        type = 'APPLY';
-    }
-    else if (a.status === pipeline_1.PIPELINE_RUN_STATUS.WAITING_FOR_VT_SESSION) {
-        type = 'APPROVE_VT';
-    }
-    else if (a.status === pipeline_1.PIPELINE_RUN_STATUS.WAITING_FOR_VARIABLES) {
-        type = 'APPLY_VARIABLES';
-    }
-    else if (a.status === pipeline_1.PIPELINE_RUN_STATUS.WAITING_FOR_SETTABLE_VARIABLES) {
-        type = 'SET_VARIABLES';
-    }
-    else {
-        output_1.default.exitError(texts_1.ERR_CANT_APPLY_ACTION_EXECUTION);
-    }
-    const body = {
-        operation: type,
-        approve_action_id: runActionId,
-        variables,
-    };
-    await client.pipelineRunApply(workspace, project, data.pipeline_id, rid, body);
-    const OutputPipeline = require('../../../output/pipeline').default;
-    await OutputPipeline.runStatus(client, workspace, project, data.pipeline_id, rid, !options.wait);
-});
-exports.default = commandPipelineRunApply;