@ethlete/cli 3.0.0-next.26 → 3.0.0-next.28

package/src/lib/design/system/harness-server.js

@@ -0,0 +1,306 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withHarnessUrl = exports.startHarnessServer = exports.serveStatic = exports.servingOf = exports.projectOf = exports.stopGroup = exports.killGroup = exports.nxBuildCommandOf = exports.NX_BUSY = exports.freePortOf = exports.RESERVED_PORTS = void 0;
+const child_process_1 = require("child_process");
+const fs_1 = require("fs");
+const http_1 = require("http");
+const module_1 = require("module");
+const net_1 = require("net");
+const os_1 = require("os");
+const path_1 = require("path");
+const promises_1 = require("timers/promises");
+const harness_build_cache_1 = require("./harness-build-cache");
+const harness_map_1 = require("./harness-map");
+const part_compare_1 = require("./part-compare");
+const plain_output_1 = require("../../plain-output");
+const phase_timing_1 = require("../phase-timing");
+const timings_1 = require("../timings");
+const wait_1 = require("../wait");
+exports.RESERVED_PORTS = [4221, 4400, 4402, 4403, 4492];
+const BUILD_TIMEOUT_MS = 300000;
+const STOP_TIMEOUT_MS = 10000;
+const messageOf = (error) => (error instanceof Error ? error.message : String(error));
+const ephemeralPort = () => new Promise((done, fail) => {
+    const server = (0, net_1.createServer)();
+    server.once('error', fail);
+    server.listen(0, '127.0.0.1', () => {
+        const address = server.address();
+        server.close(() => (typeof address === 'object' && address ? done(address.port) : fail(new Error('no port'))));
+    });
+});
+/** A free local port the OS hands out, never one of the `RESERVED_PORTS` the user's own servers use. */
+const freePortOf = (...args_1) => __awaiter(void 0, [...args_1], void 0, function* (probe = ephemeralPort) {
+    for (let attempt = 0; attempt < 20; attempt++) {
+        const port = yield probe();
+        if (!exports.RESERVED_PORTS.includes(port))
+            return port;
+    }
+    throw new Error(`no free port outside ${exports.RESERVED_PORTS.join(', ')}`);
+});
+exports.freePortOf = freePortOf;
+exports.NX_BUSY = /Waiting for \S+ in another nx process/;
+const CONTENT_TYPES = {
+    '.html': 'text/html; charset=utf-8',
+    '.js': 'text/javascript; charset=utf-8',
+    '.mjs': 'text/javascript; charset=utf-8',
+    '.css': 'text/css; charset=utf-8',
+    '.json': 'application/json',
+    '.map': 'application/json',
+    '.svg': 'image/svg+xml',
+    '.png': 'image/png',
+    '.jpg': 'image/jpeg',
+    '.webp': 'image/webp',
+    '.ico': 'image/x-icon',
+    '.woff': 'font/woff',
+    '.woff2': 'font/woff2',
+    '.ttf': 'font/ttf',
+};
+const nxBuildCommandOf = ({ target, project, outputPath }) => ({
+    command: process.execPath,
+    args: [
+        (0, module_1.createRequire)((0, path_1.resolve)(target, 'package.json')).resolve('nx/bin/nx'),
+        'run',
+        `${project}:build:development`,
+        `--outputPath=${outputPath}`,
+        '--excludeTaskDependencies',
+        '--skipNxCache',
+    ],
+});
+exports.nxBuildCommandOf = nxBuildCommandOf;
+const groupAlive = (pid) => {
+    try {
+        process.kill(-pid, 0);
+        return true;
+    }
+    catch (_a) {
+        return false;
+    }
+};
+const killGroup = (pid, signal) => {
+    try {
+        process.kill(-pid, signal);
+    }
+    catch (_a) {
+        return;
+    }
+};
+exports.killGroup = killGroup;
+const stopGroup = (pid) => __awaiter(void 0, void 0, void 0, function* () {
+    (0, exports.killGroup)(pid, 'SIGTERM');
+    const until = Date.now() + STOP_TIMEOUT_MS;
+    while (groupAlive(pid) && Date.now() < until)
+        yield (0, promises_1.setTimeout)(100);
+    (0, exports.killGroup)(pid, 'SIGKILL');
+});
+exports.stopGroup = stopGroup;
+const projectOf = (target, app) => {
+    var _a;
+    const file = (0, path_1.resolve)(target, app, 'project.json');
+    if (!(0, fs_1.existsSync)(file))
+        return `the harness app ${app} has no project.json`;
+    const project = JSON.parse((0, fs_1.readFileSync)(file, 'utf8'));
+    if (typeof project.name !== 'string')
+        return `${app}/project.json names no project`;
+    if (!((_a = project.targets) === null || _a === void 0 ? void 0 : _a['build']))
+        return `${app}/project.json has no build target`;
+    return { name: project.name };
+};
+exports.projectOf = projectOf;
+const servingOf = (url) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        return (yield fetch(`${url}${part_compare_1.HARNESS_PATH}`, { signal: AbortSignal.timeout(5000) })).ok;
+    }
+    catch (_a) {
+        return false;
+    }
+});
+exports.servingOf = servingOf;
+const fileOf = (root, url) => {
+    var _a;
+    try {
+        const file = (0, path_1.resolve)(root, `.${decodeURIComponent(new URL(url !== null && url !== void 0 ? url : '/', 'http://local').pathname)}`);
+        if (file.startsWith(root + path_1.sep) && ((_a = (0, fs_1.statSync)(file, { throwIfNoEntry: false })) === null || _a === void 0 ? void 0 : _a.isFile()))
+            return file;
+    }
+    catch (_b) {
+        return (0, path_1.join)(root, 'index.html');
+    }
+    return (0, path_1.join)(root, 'index.html');
+};
+const serveStatic = (root, port) => new Promise((done, fail) => {
+    const server = (0, http_1.createServer)((request, response) => {
+        var _a;
+        const file = fileOf(root, request.url);
+        response.setHeader('content-type', (_a = CONTENT_TYPES[(0, path_1.extname)(file)]) !== null && _a !== void 0 ? _a : 'application/octet-stream');
+        (0, fs_1.createReadStream)(file)
+            .on('error', () => response.writeHead(404).end())
+            .pipe(response);
+    });
+    server.once('error', fail);
+    server.listen(port, '127.0.0.1', () => done(server));
+});
+exports.serveStatic = serveStatic;
+/**
+ * Builds the product's harness app in development mode and serves it on a free port, answering unknown paths with its
+ * index.html. Reuses the last build while no input of it changed. The caller must `stop` it.
+ */
+const startHarnessServer = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c;
+    const { target, product } = options;
+    const harness = (0, harness_map_1.harnessOf)(product);
+    if (harness === null)
+        return `product "${product.name}" has no harness in config.json - pass --url <app dev server url>`;
+    if (typeof harness === 'string')
+        return harness;
+    const found = (0, exports.projectOf)(target, harness.app);
+    if (typeof found === 'string')
+        return found;
+    const task = `${found.name}:build:development`;
+    const dir = (0, fs_1.mkdtempSync)((0, path_1.join)((0, os_1.tmpdir)(), 'et-design-harness-'));
+    const outputPath = (0, path_1.join)(dir, 'out');
+    let child = null;
+    let server = null;
+    let stopped = null;
+    let release = () => undefined;
+    const removeDir = () => {
+        release();
+        (0, fs_1.rmSync)(dir, { recursive: true, force: true });
+    };
+    const killOnExit = () => {
+        if ((child === null || child === void 0 ? void 0 : child.pid) !== undefined)
+            (0, exports.killGroup)(child.pid, 'SIGKILL');
+        removeDir();
+    };
+    const stop = () => {
+        process.off('exit', killOnExit);
+        process.off('SIGINT', interrupt);
+        process.off('SIGTERM', interrupt);
+        stopped !== null && stopped !== void 0 ? stopped : (stopped = (() => __awaiter(void 0, void 0, void 0, function* () {
+            if ((child === null || child === void 0 ? void 0 : child.pid) !== undefined)
+                yield (0, exports.stopGroup)(child.pid);
+            if (server) {
+                const closed = new Promise((done) => server === null || server === void 0 ? void 0 : server.close(done));
+                server.closeAllConnections();
+                yield closed;
+            }
+            removeDir();
+        }))());
+        return stopped;
+    };
+    const interrupt = (signal) => void stop().then(() => process.exit(signal === 'SIGINT' ? 130 : 143));
+    process.once('exit', killOnExit);
+    process.once('SIGINT', interrupt);
+    process.once('SIGTERM', interrupt);
+    let build;
+    try {
+        build = ((_a = options.commandOf) !== null && _a !== void 0 ? _a : exports.nxBuildCommandOf)({ target, project: found.name, outputPath });
+    }
+    catch (error) {
+        yield stop();
+        return `cannot start ${task}: ${messageOf(error)}`;
+    }
+    const cacheDir = (0, harness_build_cache_1.harnessCacheDirOf)({ target, project: found.name, base: options.cacheDir });
+    const keyOf = () => (0, harness_build_cache_1.harnessBuildKeyOf)({
+        target,
+        app: harness.app,
+        command: [build.command, ...build.args.map((arg) => arg.split(outputPath).join('<out>'))],
+    });
+    const key = (0, phase_timing_1.timedPhase)('harness-cache-key', keyOf);
+    const cached = key === null ? null : (0, harness_build_cache_1.claimHarnessBuild)(cacheDir, key);
+    (0, timings_1.recordCache)(cached !== null);
+    if (cached) {
+        release = cached.release;
+        return serveBuild({ task, output: cached.dir, stop, serving: (started) => (server = started) });
+    }
+    const buildTimeout = (_b = options.timeout) !== null && _b !== void 0 ? _b : BUILD_TIMEOUT_MS;
+    console.log(`building ${task} for the harness app (up to ${(0, wait_1.durationOf)(buildTimeout)})`);
+    const spawned = (0, child_process_1.spawn)(build.command, build.args, {
+        cwd: target,
+        detached: true,
+        stdio: ['ignore', 'pipe', 'pipe'],
+        env: (0, plain_output_1.plainEnv)(Object.assign(Object.assign({}, process.env), { NX_NO_CLOUD: 'true', NX_TUI: 'false', NX_DAEMON: 'false' })),
+    });
+    child = spawned;
+    let tail = '';
+    const timer = new AbortController();
+    const ended = yield (0, phase_timing_1.timedPhase)('harness-build', () => Promise.race([
+        new Promise((done) => {
+            var _a, _b;
+            const keep = (chunk) => {
+                tail = (tail + chunk.toString()).slice(-2000);
+                if (exports.NX_BUSY.test(tail))
+                    done('busy');
+            };
+            (_a = spawned.stdout) === null || _a === void 0 ? void 0 : _a.on('data', keep);
+            (_b = spawned.stderr) === null || _b === void 0 ? void 0 : _b.on('data', keep);
+            spawned.once('error', done);
+            spawned.once('close', (code) => done(code === 0 ? 'built' : 'failed'));
+        }),
+        (0, promises_1.setTimeout)(buildTimeout, 'timeout', { signal: timer.signal }).catch(() => 'timeout'),
+    ]));
+    timer.abort();
+    if (ended !== 'built') {
+        yield stop();
+        if (ended instanceof Error)
+            return `cannot start ${task}: ${ended.message}`;
+        if (ended === 'busy')
+            return `${task} waits for another nx process running the same task - wait for it to finish, or pass --url <app dev server url>:\n${tail.trim()}`;
+        return `${task} ${ended === 'failed' ? 'failed' : `did not finish in ${(0, wait_1.durationOf)(buildTimeout)}`}:\n${tail.trim()}`;
+    }
+    const stored = key !== null && keyOf() === key ? (0, harness_build_cache_1.storeHarnessBuild)({ dir: cacheDir, key, outputPath }) : null;
+    if (stored)
+        release = stored.release;
+    return serveBuild({
+        task,
+        output: (_c = stored === null || stored === void 0 ? void 0 : stored.dir) !== null && _c !== void 0 ? _c : outputPath,
+        stop,
+        serving: (started) => (server = started),
+    });
+});
+exports.startHarnessServer = startHarnessServer;
+const serveBuild = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    const { task, output, stop } = options;
+    const browser = (0, path_1.join)(output, 'browser');
+    const root = (0, fs_1.existsSync)(browser) ? browser : output;
+    const port = yield (0, exports.freePortOf)();
+    const url = `http://127.0.0.1:${port}`;
+    try {
+        options.serving(yield (0, exports.serveStatic)(root, port));
+    }
+    catch (error) {
+        yield stop();
+        return `cannot serve the ${task} output on ${url}: ${messageOf(error)}`;
+    }
+    if (!(yield (0, exports.servingOf)(url))) {
+        yield stop();
+        return `the ${task} output does not serve ${part_compare_1.HARNESS_PATH} on ${url}`;
+    }
+    return { url, stop, root };
+});
+/** Runs `run` with `url`, or without one with the URL of a harness server it starts and always stops afterwards. */
+const withHarnessUrl = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    if (options.url)
+        return options.run(options.url, null);
+    const server = yield (0, phase_timing_1.timedPhase)('harness-start', () => { var _a; return ((_a = options.start) !== null && _a !== void 0 ? _a : exports.startHarnessServer)({ target: options.target, product: options.product }); });
+    if (typeof server === 'string')
+        return server;
+    console.log(`started the harness app on ${server.url}`);
+    try {
+        return yield options.run(server.url, (_a = server.root) !== null && _a !== void 0 ? _a : null);
+    }
+    finally {
+        yield (0, phase_timing_1.timedPhase)('harness-stop', () => server.stop());
+    }
+});
+exports.withHarnessUrl = withHarnessUrl;
+//# sourceMappingURL=harness-server.js.map

package/src/lib/design/system/harness-server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"harness-server.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/design/system/harness-server.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iDAAoD;AACpD,2BAA+F;AAC/F,+BAAgE;AAChE,mCAAuC;AACvC,6BAAmC;AACnC,2BAA4B;AAC5B,+BAAmD;AACnD,8CAAsD;AACtD,+DAAmH;AACnH,+CAA0C;AAC1C,iDAA8C;AAE9C,qDAA8C;AAC9C,kDAA6C;AAC7C,wCAAyC;AACzC,kCAAqC;AAExB,QAAA,cAAc,GAAsB,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAEhF,MAAM,gBAAgB,GAAG,MAAO,CAAC;AACjC,MAAM,eAAe,GAAG,KAAM,CAAC;AAe/B,MAAM,SAAS,GAAG,CAAC,KAAc,EAAE,EAAE,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAE/F,MAAM,aAAa,GAAG,GAAG,EAAE,CACzB,IAAI,OAAO,CAAS,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;IACjC,MAAM,MAAM,GAAG,IAAA,kBAAY,GAAE,CAAC;IAE9B,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC3B,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE;QACjC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC;QAEjC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IACjH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEL,wGAAwG;AACjG,MAAM,UAAU,GAAG,YAAqD,EAAE,mDAAhD,QAA+B,aAAa;IAC3E,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,EAAE,EAAE,OAAO,EAAE,EAAE,CAAC;QAC9C,MAAM,IAAI,GAAG,MAAM,KAAK,EAAE,CAAC;QAE3B,IAAI,CAAC,sBAAc,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAC;IAClD,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,wBAAwB,sBAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACvE,CAAC,CAAA,CAAC;AARW,QAAA,UAAU,cAQrB;AAEW,QAAA,OAAO,GAAG,uCAAuC,CAAC;AAE/D,MAAM,aAAa,GAA2B;IAC5C,OAAO,EAAE,0BAA0B;IACnC,KAAK,EAAE,gCAAgC;IACvC,MAAM,EAAE,gCAAgC;IACxC,MAAM,EAAE,yBAAyB;IACjC,OAAO,EAAE,kBAAkB;IAC3B,MAAM,EAAE,kBAAkB;IAC1B,MAAM,EAAE,eAAe;IACvB,MAAM,EAAE,WAAW;IACnB,MAAM,EAAE,YAAY;IACpB,OAAO,EAAE,YAAY;IACrB,MAAM,EAAE,cAAc;IACtB,OAAO,EAAE,WAAW;IACpB,QAAQ,EAAE,YAAY;IACtB,MAAM,EAAE,UAAU;CACnB,CAAC;AAEK,MAAM,gBAAgB,GAAmB,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC;IACpF,OAAO,EAAE,OAAO,CAAC,QAAQ;IACzB,IAAI,EAAE;QACJ,IAAA,sBAAa,EAAC,IAAA,cAAO,EAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;QACnE,KAAK;QACL,GAAG,OAAO,oBAAoB;QAC9B,gBAAgB,UAAU,EAAE;QAC5B,2BAA2B;QAC3B,eAAe;KAChB;CACF,CAAC,CAAC;AAVU,QAAA,gBAAgB,oBAU1B;AAEH,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,EAAE;IACjC,IAAI,CAAC;QACH,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAEtB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAC;AAEK,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,MAAsB,EAAE,EAAE;IAC/D,IAAI,CAAC;QACH,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC7B,CAAC;IAAC,WAAM,CAAC;QACP,OAAO;IACT,CAAC;AACH,CAAC,CAAC;AANW,QAAA,SAAS,aAMpB;AAEK,MAAM,SAAS,GAAG,CAAO,GAAW,EAAE,EAAE;IAC7C,IAAA,iBAAS,EAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,eAAe,CAAC;IAE3C,OAAO,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK;QAAE,MAAM,IAAA,qBAAK,EAAC,GAAG,CAAC,CAAC;IAE/D,IAAA,iBAAS,EAAC,GAAG,EAAE,SAAS,CAAC,CAAC;AAC5B,CAAC,CAAA,CAAC;AARW,QAAA,SAAS,aAQpB;AAEK,MAAM,SAAS,GAAG,CAAC,MAAc,EAAE,GAAW,EAAE,EAAE;;IACvD,MAAM,IAAI,GAAG,IAAA,cAAO,EAAC,MAAM,EAAE,GAAG,EAAE,cAAc,CAAC,CAAC;IAElD,IAAI,CAAC,IAAA,eAAU,EAAC,IAAI,CAAC;QAAE,OAAO,mBAAmB,GAAG,sBAAsB,CAAC;IAE3E,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,iBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAA0D,CAAC;IAEhH,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,GAAG,GAAG,gCAAgC,CAAC;IACpF,IAAI,CAAC,CAAA,MAAA,OAAO,CAAC,OAAO,0CAAG,OAAO,CAAC,CAAA;QAAE,OAAO,GAAG,GAAG,mCAAmC,CAAC;IAElF,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;AAChC,CAAC,CAAC;AAXW,QAAA,SAAS,aAWpB;AAEK,MAAM,SAAS,GAAG,CAAO,GAAW,EAAE,EAAE;IAC7C,IAAI,CAAC;QACH,OAAO,CAAC,MAAM,KAAK,CAAC,GAAG,GAAG,GAAG,2BAAY,EAAE,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,IAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3F,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAA,CAAC;AANW,QAAA,SAAS,aAMpB;AAEF,MAAM,MAAM,GAAG,CAAC,IAAY,EAAE,GAAuB,EAAE,EAAE;;IACvD,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,IAAA,cAAO,EAAC,IAAI,EAAE,IAAI,kBAAkB,CAAC,IAAI,GAAG,CAAC,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,GAAG,EAAE,cAAc,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAEnG,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,UAAG,CAAC,KAAI,MAAA,IAAA,aAAQ,EAAC,IAAI,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,0CAAE,MAAM,EAAE,CAAA;YAAE,OAAO,IAAI,CAAC;IACtG,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,IAAA,WAAI,EAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAClC,CAAC;IAED,OAAO,IAAA,WAAI,EAAC,IAAI,EAAE,YAAY,CAAC,CAAC;AAClC,CAAC,CAAC;AAEK,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,EAAE,CACxD,IAAI,OAAO,CAAS,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;IACjC,MAAM,MAAM,GAAG,IAAA,mBAAgB,EAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE;;QACpD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;QAEvC,QAAQ,CAAC,SAAS,CAAC,cAAc,EAAE,MAAA,aAAa,CAAC,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC,mCAAI,0BAA0B,CAAC,CAAC;QAC/F,IAAA,qBAAgB,EAAC,IAAI,CAAC;aACnB,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;aAChD,IAAI,CAAC,QAAQ,CAAC,CAAC;IACpB,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC3B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;AACvD,CAAC,CAAC,CAAC;AAbQ,QAAA,WAAW,eAanB;AAIL;;;GAGG;AACI,MAAM,kBAAkB,GAAG,CAAO,OAMxC,EAAmC,EAAE;;IACpC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IACpC,MAAM,OAAO,GAAG,IAAA,uBAAS,EAAC,OAAO,CAAC,CAAC;IAEnC,IAAI,OAAO,KAAK,IAAI;QAClB,OAAO,YAAY,OAAO,CAAC,IAAI,mEAAmE,CAAC;IACrG,IAAI,OAAO,OAAO,KAAK,QAAQ;QAAE,OAAO,OAAO,CAAC;IAEhD,MAAM,KAAK,GAAG,IAAA,iBAAS,EAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IAE7C,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAE5C,MAAM,IAAI,GAAG,GAAG,KAAK,CAAC,IAAI,oBAAoB,CAAC;IAC/C,MAAM,GAAG,GAAG,IAAA,gBAAW,EAAC,IAAA,WAAI,EAAC,IAAA,WAAM,GAAE,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAC9D,MAAM,UAAU,GAAG,IAAA,WAAI,EAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACpC,IAAI,KAAK,GAAwB,IAAI,CAAC;IACtC,IAAI,MAAM,GAAkB,IAAI,CAAC;IACjC,IAAI,OAAO,GAAyB,IAAI,CAAC;IACzC,IAAI,OAAO,GAAG,GAAG,EAAE,CAAC,SAAiB,CAAC;IACtC,MAAM,SAAS,GAAG,GAAG,EAAE;QACrB,OAAO,EAAE,CAAC;QACV,IAAA,WAAM,EAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAChD,CAAC,CAAC;IACF,MAAM,UAAU,GAAG,GAAG,EAAE;QACtB,IAAI,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,MAAK,SAAS;YAAE,IAAA,iBAAS,EAAC,KAAK,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC9D,SAAS,EAAE,CAAC;IACd,CAAC,CAAC;IACF,MAAM,IAAI,GAAG,GAAG,EAAE;QAChB,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAChC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACjC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAClC,OAAO,aAAP,OAAO,cAAP,OAAO,IAAP,OAAO,GAAK,CAAC,GAAS,EAAE;YACtB,IAAI,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,GAAG,MAAK,SAAS;gBAAE,MAAM,IAAA,iBAAS,EAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACzD,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,MAAM,GAAG,IAAI,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;gBAE1D,MAAM,CAAC,mBAAmB,EAAE,CAAC;gBAC7B,MAAM,MAAM,CAAC;YACf,CAAC;YACD,SAAS,EAAE,CAAC;QACd,CAAC,CAAA,CAAC,EAAE,EAAC;QAEL,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;IACF,MAAM,SAAS,GAAG,CAAC,MAAsB,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAEpH,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACjC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IAClC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAEnC,IAAI,KAAiC,CAAC;IAEtC,IAAI,CAAC;QACH,KAAK,GAAG,CAAC,MAAA,OAAO,CAAC,SAAS,mCAAI,wBAAgB,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;IAC/F,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,EAAE,CAAC;QAEb,OAAO,gBAAgB,IAAI,KAAK,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;IACrD,CAAC;IAED,MAAM,QAAQ,GAAG,IAAA,uCAAiB,EAAC,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC5F,MAAM,KAAK,GAAG,GAAG,EAAE,CACjB,IAAA,uCAAiB,EAAC;QAChB,MAAM;QACN,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,OAAO,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;KAC1F,CAAC,CAAC;IACL,MAAM,GAAG,GAAG,IAAA,yBAAU,EAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC;IACnD,MAAM,MAAM,GAAG,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAA,uCAAiB,EAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IAEtE,IAAA,qBAAW,EAAC,MAAM,KAAK,IAAI,CAAC,CAAC;IAE7B,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAEzB,OAAO,UAAU,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,MAAM,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC;IAClG,CAAC;IAED,MAAM,YAAY,GAAG,MAAA,OAAO,CAAC,OAAO,mCAAI,gBAAgB,CAAC;IAEzD,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,+BAA+B,IAAA,iBAAU,EAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IAExF,MAAM,OAAO,GAAG,IAAA,qBAAK,EAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,EAAE;QAC/C,GAAG,EAAE,MAAM;QACX,QAAQ,EAAE,IAAI;QACd,KAAK,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC;QACjC,GAAG,EAAE,IAAA,uBAAQ,kCAAM,OAAO,CAAC,GAAG,KAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,IAAG;KAC5F,CAAC,CAAC;IAEH,KAAK,GAAG,OAAO,CAAC;IAEhB,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,MAAM,KAAK,GAAG,IAAI,eAAe,EAAE,CAAC;IACpC,MAAM,KAAK,GAAG,MAAM,IAAA,yBAAU,EAAC,eAAe,EAAE,GAAG,EAAE,CACnD,OAAO,CAAC,IAAI,CAAC;QACX,IAAI,OAAO,CAAmB,CAAC,IAAI,EAAE,EAAE;;YACrC,MAAM,IAAI,GAAG,CAAC,KAAa,EAAE,EAAE;gBAC7B,IAAI,GAAG,CAAC,IAAI,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,IAAK,CAAC,CAAC;gBAE/C,IAAI,eAAO,CAAC,IAAI,CAAC,IAAI,CAAC;oBAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YACvC,CAAC,CAAC;YAEF,MAAA,OAAO,CAAC,MAAM,0CAAE,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YACjC,MAAA,OAAO,CAAC,MAAM,0CAAE,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;YACjC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAC5B,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;QACzE,CAAC,CAAC;QACF,IAAA,qBAAK,EAAC,YAAY,EAAE,SAAkB,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAkB,CAAC;KAClG,CAAC,CACH,CAAC;IAEF,KAAK,CAAC,KAAK,EAAE,CAAC;IAEd,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;QACtB,MAAM,IAAI,EAAE,CAAC;QAEb,IAAI,KAAK,YAAY,KAAK;YAAE,OAAO,gBAAgB,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;QAC5E,IAAI,KAAK,KAAK,MAAM;YAClB,OAAO,GAAG,IAAI,qHAAqH,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;QAEnJ,OAAO,GAAG,IAAI,IAAI,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,qBAAqB,IAAA,iBAAU,EAAC,YAAY,CAAC,EAAE,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;IACvH,CAAC;IAED,MAAM,MAAM,GAAG,GAAG,KAAK,IAAI,IAAI,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,IAAA,uCAAiB,EAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAE9G,IAAI,MAAM;QAAE,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAErC,OAAO,UAAU,CAAC;QAChB,IAAI;QACJ,MAAM,EAAE,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,mCAAI,UAAU;QACjC,IAAI;QACJ,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,MAAM,GAAG,OAAO,CAAC;KACzC,CAAC,CAAC;AACL,CAAC,CAAA,CAAC;AA3IW,QAAA,kBAAkB,sBA2I7B;AAEF,MAAM,UAAU,GAAG,CAAO,OAKzB,EAAmC,EAAE;IACpC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IACvC,MAAM,OAAO,GAAG,IAAA,WAAI,EAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACxC,MAAM,IAAI,GAAG,IAAA,eAAU,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;IACpD,MAAM,IAAI,GAAG,MAAM,IAAA,kBAAU,GAAE,CAAC;IAChC,MAAM,GAAG,GAAG,oBAAoB,IAAI,EAAE,CAAC;IAEvC,IAAI,CAAC;QACH,OAAO,CAAC,OAAO,CAAC,MAAM,IAAA,mBAAW,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IACjD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,EAAE,CAAC;QAEb,OAAO,oBAAoB,IAAI,cAAc,GAAG,KAAK,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;IAC1E,CAAC;IAED,IAAI,CAAC,CAAC,MAAM,IAAA,iBAAS,EAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,EAAE,CAAC;QAEb,OAAO,OAAO,IAAI,0BAA0B,2BAAY,OAAO,GAAG,EAAE,CAAC;IACvE,CAAC;IAED,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AAC7B,CAAC,CAAA,CAAC;AAEF,oHAAoH;AAC7G,MAAM,cAAc,GAAG,CAAU,OAMvC,EAAuB,EAAE;;IACxB,IAAI,OAAO,CAAC,GAAG;QAAE,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAEvD,MAAM,MAAM,GAAG,MAAM,IAAA,yBAAU,EAAC,eAAe,EAAE,GAAG,EAAE,WACpD,OAAA,CAAC,MAAA,OAAO,CAAC,KAAK,mCAAI,0BAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA,EAAA,CAC5F,CAAC;IAEF,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC;IAE9C,OAAO,CAAC,GAAG,CAAC,8BAA8B,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC;IAExD,IAAI,CAAC;QACH,OAAO,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,MAAA,MAAM,CAAC,IAAI,mCAAI,IAAI,CAAC,CAAC;IAC5D,CAAC;YAAS,CAAC;QACT,MAAM,IAAA,yBAAU,EAAC,cAAc,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;IACxD,CAAC;AACH,CAAC,CAAA,CAAC;AAtBW,QAAA,cAAc,kBAsBzB"}

package/src/lib/design/system/harness-shot.d.ts

@@ -0,0 +1,78 @@
+import { DesignPreset } from '../design-config';
+import { TextAmbient } from '../shot';
+import { Browser } from '../thumb';
+import { ForcedElement, FrameLook } from './part-compare';
+import { FrozenAnimation } from './frozen-animations';
+export declare class MissingPanesError extends Error {
+}
+/** @internal The problem of a state whose app opened fewer overlay panes than its design draws. */
+export declare const missingPanesProblemOf: (count: {
+    drawn: number;
+    opened: number;
+}) => string;
+/**
+ * How compare draws a part: a page at a product preset, the asked one or the first, with the harness host filling
+ * its viewport; any other part fitted to its content.
+ */
+export declare const compareFrameOf: (options: {
+    presets: Record<string, DesignPreset>;
+    part: string;
+    preset: string | null;
+}) => {
+    preset: string | null;
+    size: DesignPreset | null;
+    layout: "page" | null;
+} | string;
+export declare class HarnessError extends Error {
+}
+export declare class UndrivableError extends HarnessError {
+}
+export declare class DroppedPropsError extends Error {
+}
+export declare class LookMissError extends Error {
+}
+/** @internal The problem of a state whose app draws no element a look of the design targets. */
+export declare const lookMissProblemOf: ({ look, selector, part }: FrameLook) => string;
+/**
+ * The number of overlay panes a design picture draws: each `<et-overlay-container>`, `.et-overlay-runtime-pane`,
+ * `<et-menu>` and `<et-select-panel>` mock, as the app renders each of them in a pane of its own. A mock inside a
+ * `hidden` element draws none.
+ */
+export declare const drawnPaneCountOf: (markup: string) => number;
+/**
+ * A PNG of the harness host element at `url`, in the viewport of `size` at device scale 1, or without `size` fitted
+ * as a design frame fits its root, with its overflowing positioned descendants and rounded to whole pixels, with the
+ * pointer off the page, after a pointer click on the app trigger of the design `markup`'s `[data-et-control]` named
+ * `opened`, and with each `forced` element hovered, pressed or keyboard-focused as the design picture forces it.
+ * With `roomAbove`, for a design picture drawn above its part root, the fitted host gets room above and before it, so
+ * an overlay that opens above neither flips below nor shifts off the viewport edge, and the shot grows up as well.
+ * Without `size`, a `width` sets the viewport and the host to that width, as a design frame draws a part with `widths`.
+ */
+export declare const harnessShotOf: (options: {
+    browser: Browser;
+    url: string;
+    size?: DesignPreset | null;
+    width?: number | null;
+    forced?: ForcedElement[];
+    /** Draws the app's `data-et-force` elements forced, for a design that forces elements of framed drawings. */
+    forcesInFrames?: boolean;
+    /** Fails with the first look whose selector matches nothing inside the app's elements with that look. */
+    looks?: FrameLook[];
+    opened?: {
+        control: string;
+        markup: string;
+    };
+    roomAbove?: boolean;
+    panes?: number;
+    frozen?: FrozenAnimation[];
+    timeout?: number;
+    /** The design frame root's text style, set on the host so a part that inherits its type draws in the design's, not the app body's. */
+    ambient?: TextAmbient;
+    /** Fails with the props the mounted component has no input for, but `designOnly`; skipped in a production build. */
+    props?: {
+        sent: unknown;
+        designOnly: ReadonlySet<string>;
+    };
+    /** Records the steps of the shot as `<phase> load|prepare|drive|settle|screenshot` timing phases. */
+    phase?: string;
+}) => Promise<Buffer<ArrayBufferLike>>;