dceky 1.0.5-beta.ky-declarations.13 → 1.0.5

package/lib/start/helpers/runCypressHeadless.js

@@ -0,0 +1,138 @@
+"use strict";
+/* eslint-disable no-console */
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import libs
+var child_process_1 = require("child_process");
+var path_1 = __importDefault(require("path"));
+var fs_1 = __importDefault(require("fs"));
+// Import helpers
+var getRootPath_1 = __importDefault(require("./getRootPath"));
+var generateReporterConfig_1 = __importDefault(require("./generateReporterConfig"));
+var mergeReports_1 = __importDefault(require("./mergeReports"));
+var generateHtmlReport_1 = __importDefault(require("./generateHtmlReport"));
+// Import constants
+var DEFAULT_THREADS_PER_COMBO_1 = __importDefault(require("../constants/DEFAULT_THREADS_PER_COMBO"));
+/**
+ * Run Cypress in headless mode for a single profile and browser using cypress-parallel
+ * @author Yuen Ler Chow
+ * @param opts - object of arguments
+ * @param opts.profileName - The profile name to use
+ * @param opts.browser - The browser to use
+ * @param opts.outputDir - The output directory for results
+ * @param [opts.numThreads] - The number of parallel threads to use (default: 2)
+ * @returns Promise that resolves with run result
+ */
+var runCypressHeadless = function (opts) {
+    var profileName = opts.profileName, browser = opts.browser, outputDir = opts.outputDir, _a = opts.numThreads, numThreads = _a === void 0 ? DEFAULT_THREADS_PER_COMBO_1.default : _a;
+    return new Promise(function (resolve, reject) {
+        var root = (0, getRootPath_1.default)();
+        // Ensure output directory exists
+        if (!fs_1.default.existsSync(outputDir)) {
+            fs_1.default.mkdirSync(outputDir, { recursive: true });
+        }
+        // Create subdirectory for this profile+browser combination
+        var comboDir = path_1.default.join(outputDir, "".concat(profileName, "-").concat(browser));
+        if (!fs_1.default.existsSync(comboDir)) {
+            fs_1.default.mkdirSync(comboDir, { recursive: true });
+        }
+        // Create per-combo screenshots directory
+        var comboScreenshotsDir = path_1.default.join(comboDir, 'screenshots');
+        if (!fs_1.default.existsSync(comboScreenshotsDir)) {
+            fs_1.default.mkdirSync(comboScreenshotsDir, { recursive: true });
+        }
+        var env = __assign(__assign({}, process.env), { CYPRESS_PROFILE: profileName, BROWSER: browser });
+        console.log("\n\uD83D\uDE80 Starting Cypress headless: ".concat(profileName, " + ").concat(browser));
+        console.log("Output: ".concat(comboDir, "\n"));
+        // Create reporter config for cypress-multi-reporters
+        var reporterConfigPath = path_1.default.join(comboDir, 'reporter-config.json');
+        var reporterConfig = (0, generateReporterConfig_1.default)({
+            resultsDir: outputDir,
+            profileName: profileName,
+            browserName: browser,
+        });
+        fs_1.default.writeFileSync(reporterConfigPath, JSON.stringify(reporterConfig, null, 2));
+        // Cypress parallel run command with browser, threads, and reporter config
+        var cypressArgsString = "--headless --browser ".concat(browser, " --config screenshotsFolder=").concat(comboScreenshotsDir, " --reporter cypress-multi-reporters --reporter-options configFile=").concat(reporterConfigPath);
+        console.log("Reporter config path: ".concat(reporterConfigPath));
+        console.log("Granular results dir: ".concat(path_1.default.join(comboDir, 'granular-results')));
+        var args = [
+            'cypress-parallel',
+            '-s',
+            'cy:run',
+            '--threads',
+            numThreads.toString(),
+            '-d',
+            'cypress/e2e/**/*',
+            '-a',
+            // eslint-disable-next-line quotes
+            "'\"".concat(cypressArgsString, "\"'"),
+        ];
+        var cypressProcess = (0, child_process_1.spawn)('npx', args, {
+            cwd: root,
+            env: env,
+            stdio: 'inherit',
+            shell: true,
+        });
+        cypressProcess.on('close', function (code) {
+            var success = code === 0;
+            // Merge granular mochawesome JSON and generate a single HTML report
+            var reportGenerated = true;
+            try {
+                // Merge all json test suites (test files) into one report
+                (0, mergeReports_1.default)({
+                    resultsDir: outputDir,
+                    profileName: profileName,
+                    browserName: browser,
+                });
+                // Generate combined HTML report for all test suites for this single browser+profile combo
+                (0, generateHtmlReport_1.default)({
+                    resultsDir: outputDir,
+                    profileName: profileName,
+                    browserName: browser,
+                });
+            }
+            catch (reportError) {
+                console.error("\n\u26A0\uFE0F Report generation failed for ".concat(profileName, " + ").concat(browser, ":"), reportError);
+                reportGenerated = false;
+            }
+            // By default, marge names the HTML after the JSON basename: report-data.html
+            var reportPath = path_1.default.join(outputDir, "".concat(profileName, "-").concat(browser), 'report', 'report-data.html');
+            var result = {
+                profileName: profileName,
+                browser: browser,
+                success: success && reportGenerated,
+                outputDir: comboDir,
+                reportPath: reportGenerated ? reportPath : undefined,
+            };
+            if (success && reportGenerated) {
+                console.log("\n\u2705 Completed: ".concat(profileName, " + ").concat(browser));
+            }
+            else if (!reportGenerated) {
+                console.log("\n\u26A0\uFE0F Tests ran but report generation failed: ".concat(profileName, " + ").concat(browser));
+            }
+            else {
+                console.log("\n\u274C Failed: ".concat(profileName, " + ").concat(browser, " (exit code: ").concat(code, ")"));
+            }
+            resolve(result);
+        });
+        cypressProcess.on('error', function (error) {
+            reject(error);
+        });
+    });
+};
+exports.default = runCypressHeadless;
+//# sourceMappingURL=runCypressHeadless.js.map

package/lib/start/helpers/runCypressHeadless.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runCypressHeadless.js","sourceRoot":"","sources":["../../../start/helpers/runCypressHeadless.ts"],"names":[],"mappings":";AAAA,+BAA+B;;;;;;;;;;;;;;;;AAE/B,cAAc;AACd,+CAAsC;AACtC,8CAAwB;AACxB,0CAAoB;AAEpB,iBAAiB;AACjB,8DAAwC;AACxC,oFAA8D;AAC9D,gEAA0C;AAC1C,4EAAsD;AAKtD,mBAAmB;AACnB,qGAA+E;AAE/E;;;;;;;;;GASG;AACH,IAAM,kBAAkB,GAAG,UAAC,IAK3B;IAEG,IAAA,WAAW,GAIT,IAAI,YAJK,EACX,OAAO,GAGL,IAAI,QAHC,EACP,SAAS,GAEP,IAAI,UAFG,EACT,KACE,IAAI,WADgC,EAAtC,UAAU,mBAAG,mCAAyB,KAAA,CAC/B;IAET,OAAO,IAAI,OAAO,CAAC,UAAC,OAAO,EAAE,MAAM;QACjC,IAAM,IAAI,GAAG,IAAA,qBAAW,GAAE,CAAC;QAE3B,iCAAiC;QACjC,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,YAAE,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/C,CAAC;QAED,2DAA2D;QAC3D,IAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAG,WAAW,cAAI,OAAO,CAAE,CAAC,CAAC;QACnE,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7B,YAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9C,CAAC;QAED,yCAAyC;QACzC,IAAM,mBAAmB,GAAG,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QAC/D,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACxC,YAAE,CAAC,SAAS,CAAC,mBAAmB,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACzD,CAAC;QAED,IAAM,GAAG,yBACJ,OAAO,CAAC,GAAG,KACd,eAAe,EAAE,WAAW,EAC5B,OAAO,EAAE,OAAO,GACjB,CAAC;QAEF,OAAO,CAAC,GAAG,CAAC,oDAAmC,WAAW,gBAAM,OAAO,CAAE,CAAC,CAAC;QAC3E,OAAO,CAAC,GAAG,CAAC,kBAAW,QAAQ,OAAI,CAAC,CAAC;QAErC,qDAAqD;QACrD,IAAM,kBAAkB,GAAG,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;QACvE,IAAM,cAAc,GAAG,IAAA,gCAAsB,EAAC;YAC5C,UAAU,EAAE,SAAS;YACrB,WAAW,aAAA;YACX,WAAW,EAAE,OAAO;SACrB,CAAC,CAAC;QACH,YAAE,CAAC,aAAa,CAAC,kBAAkB,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAE9E,0EAA0E;QAC1E,IAAM,iBAAiB,GAAG,+BAAwB,OAAO,yCAA+B,mBAAmB,+EAAqE,kBAAkB,CAAE,CAAC;QAErM,OAAO,CAAC,GAAG,CAAC,gCAAyB,kBAAkB,CAAE,CAAC,CAAC;QAC3D,OAAO,CAAC,GAAG,CAAC,gCAAyB,cAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAE,CAAC,CAAC;QAEhF,IAAM,IAAI,GAAG;YACX,kBAAkB;YAClB,IAAI;YACJ,QAAQ;YACR,WAAW;YACX,UAAU,CAAC,QAAQ,EAAE;YACrB,IAAI;YACJ,kBAAkB;YAClB,IAAI;YACJ,kCAAkC;YAClC,aAAK,iBAAiB,QAAI;SAC3B,CAAC;QAEF,IAAM,cAAc,GAAG,IAAA,qBAAK,EAAC,KAAK,EAAE,IAAI,EAAE;YACxC,GAAG,EAAE,IAAI;YACT,GAAG,KAAA;YACH,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC;QAEH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,UAAC,IAAI;YAC9B,IAAM,OAAO,GAAG,IAAI,KAAK,CAAC,CAAC;YAE3B,oEAAoE;YACpE,IAAI,eAAe,GAAG,IAAI,CAAC;YAC3B,IAAI,CAAC;gBACH,0DAA0D;gBAC1D,IAAA,sBAAY,EAAC;oBACX,UAAU,EAAE,SAAS;oBACrB,WAAW,aAAA;oBACX,WAAW,EAAE,OAAO;iBACrB,CAAC,CAAC;gBAEH,0FAA0F;gBAC1F,IAAA,4BAAkB,EAAC;oBACjB,UAAU,EAAE,SAAS;oBACrB,WAAW,aAAA;oBACX,WAAW,EAAE,OAAO;iBACrB,CAAC,CAAC;YACL,CAAC;YAAC,OAAO,WAAW,EAAE,CAAC;gBACrB,OAAO,CAAC,KAAK,CAAC,sDAAqC,WAAW,gBAAM,OAAO,MAAG,EAAE,WAAW,CAAC,CAAC;gBAC7F,eAAe,GAAG,KAAK,CAAC;YAC1B,CAAC;YAED,6EAA6E;YAC7E,IAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAC1B,SAAS,EACT,UAAG,WAAW,cAAI,OAAO,CAAE,EAC3B,QAAQ,EACR,kBAAkB,CACnB,CAAC;YAEF,IAAM,MAAM,GAAc;gBACxB,WAAW,aAAA;gBACX,OAAO,SAAA;gBACP,OAAO,EAAE,OAAO,IAAI,eAAe;gBACnC,SAAS,EAAE,QAAQ;gBACnB,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;aACrD,CAAC;YAEF,IAAI,OAAO,IAAI,eAAe,EAAE,CAAC;gBAC/B,OAAO,CAAC,GAAG,CAAC,8BAAkB,WAAW,gBAAM,OAAO,CAAE,CAAC,CAAC;YAC5D,CAAC;iBAAM,IAAI,CAAC,eAAe,EAAE,CAAC;gBAC5B,OAAO,CAAC,GAAG,CAAC,iEAAgD,WAAW,gBAAM,OAAO,CAAE,CAAC,CAAC;YAC1F,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,GAAG,CAAC,2BAAe,WAAW,gBAAM,OAAO,0BAAgB,IAAI,MAAG,CAAC,CAAC;YAC9E,CAAC;YAED,OAAO,CAAC,MAAM,CAAC,CAAC;QAClB,CAAC,CAAC,CAAC;QAEH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,UAAC,KAAK;YAC/B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,kBAAe,kBAAkB,CAAC"}

package/lib/start/helpers/runCypressVisible.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Run Cypress in visible/interactive mode with a profile
+ * @author Yuen Ler Chow
+ * @param profileName - The profile name to use
+ * @returns Promise that resolves when Cypress closes
+ */
+declare const runCypressVisible: (profileName: string) => Promise<void>;
+export default runCypressVisible;

package/lib/start/helpers/runCypressVisible.js

@@ -0,0 +1,53 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-console */
+var child_process_1 = require("child_process");
+// Import helpers
+var getRootPath_1 = __importDefault(require("./getRootPath"));
+/**
+ * Run Cypress in visible/interactive mode with a profile
+ * @author Yuen Ler Chow
+ * @param profileName - The profile name to use
+ * @returns Promise that resolves when Cypress closes
+ */
+var runCypressVisible = function (profileName) {
+    return new Promise(function (resolve, reject) {
+        var root = (0, getRootPath_1.default)();
+        var env = __assign(__assign({}, process.env), { CYPRESS_PROFILE: profileName });
+        console.log("\n\uD83D\uDE80 Launching Cypress in interactive mode with profile: ".concat(profileName));
+        console.log("  CYPRESS_PROFILE=".concat(profileName, "\n"));
+        var cypressProcess = (0, child_process_1.spawn)('npx', ['cypress', 'open'], {
+            cwd: root,
+            env: env,
+            stdio: 'inherit',
+            shell: true,
+        });
+        cypressProcess.on('close', function (code) {
+            if (code === 0) {
+                resolve();
+            }
+            else {
+                reject(new Error("Cypress exited with code ".concat(code)));
+            }
+        });
+        cypressProcess.on('error', function (error) {
+            reject(error);
+        });
+    });
+};
+exports.default = runCypressVisible;
+//# sourceMappingURL=runCypressVisible.js.map

package/lib/start/helpers/runCypressVisible.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runCypressVisible.js","sourceRoot":"","sources":["../../../start/helpers/runCypressVisible.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+BAA+B;AAC/B,+CAAsC;AAEtC,iBAAiB;AACjB,8DAAwC;AAExC;;;;;GAKG;AACH,IAAM,iBAAiB,GAAG,UAAC,WAAmB;IAC5C,OAAO,IAAI,OAAO,CAAC,UAAC,OAAO,EAAE,MAAM;QACjC,IAAM,IAAI,GAAG,IAAA,qBAAW,GAAE,CAAC;QAC3B,IAAM,GAAG,yBACJ,OAAO,CAAC,GAAG,KACd,eAAe,EAAE,WAAW,GAC7B,CAAC;QAEF,OAAO,CAAC,GAAG,CAAC,6EAA4D,WAAW,CAAE,CAAC,CAAC;QACvF,OAAO,CAAC,GAAG,CAAC,4BAAqB,WAAW,OAAI,CAAC,CAAC;QAElD,IAAM,cAAc,GAAG,IAAA,qBAAK,EAAC,KAAK,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE;YACvD,GAAG,EAAE,IAAI;YACT,GAAG,KAAA;YACH,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC;QAEH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,UAAC,IAAI;YAC9B,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACf,OAAO,EAAE,CAAC;YACZ,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,KAAK,CAAC,mCAA4B,IAAI,CAAE,CAAC,CAAC,CAAC;YACxD,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,UAAC,KAAK;YAC/B,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,kBAAe,iBAAiB,CAAC"}

package/lib/start/index.js

@@ -20,8 +20,10 @@ var findProfilesByNames_1 = __importDefault(require("./helpers/findProfilesByNam
 var validateBrowsers_1 = __importDefault(require("./helpers/validateBrowsers"));
 var extractArgValue_1 = __importDefault(require("./helpers/extractArgValue"));
 var getRootPath_1 = __importDefault(require("./helpers/getRootPath"));
+var executeCypress_1 = __importDefault(require("./helpers/executeCypress"));
 // Import constants
 var AVAILABLE_BROWSERS_1 = __importDefault(require("./constants/AVAILABLE_BROWSERS"));
+var DEFAULT_THREADS_PER_COMBO_1 = __importDefault(require("./constants/DEFAULT_THREADS_PER_COMBO"));
 // Get the project directory
 var pwd = (0, getRootPath_1.default)();
 // Find available profiles under /cypress/profiles
@@ -73,6 +75,20 @@ var envHeadlessRaw = process.env.HEADLESS;
 var headlessFlagValue = (0, extractArgValue_1.default)(args, '--headless');
 var hasHeadlessFlag = headlessFlagValue !== undefined;
 isHeadless = !!(envHeadlessRaw && envHeadlessRaw.toLowerCase() !== 'false') || hasHeadlessFlag;
+// Check for THREADS_PER_COMBO (env var or CLI arg)
+var envThreadsRaw = process.env.THREADS_PER_COMBO;
+var argThreadsRaw = (0, extractArgValue_1.default)(args, '--threadsPerCombo');
+var threadsRaw = envThreadsRaw || argThreadsRaw;
+var threadsPerCombo;
+if (threadsRaw) {
+    var parsed = Number.parseInt(threadsRaw, 10);
+    if (!Number.isNaN(parsed) && parsed > 0) {
+        threadsPerCombo = parsed;
+    }
+    else {
+        console.warn("\u26A0\uFE0F Invalid THREADS_PER_COMBO value: \"".concat(threadsRaw, "\". Using default (").concat(DEFAULT_THREADS_PER_COMBO_1.default, ")."));
+    }
+}
 // If headless wasn't specified, ask the user to choose
 if (!envHeadlessRaw && !hasHeadlessFlag) {
     var choices = (0, showChooser_1.default)({
@@ -132,9 +148,11 @@ if (selectedProfiles.length === 0
     });
     selectedProfiles = choices.map(function (choice) { return profiles[choice.index]; });
 }
-// Execute commands for each combination of profile and browser (not yet implemented)
-console.log('Starting Cypress with the following configuration:');
-console.log("Profiles: ".concat(selectedProfiles.map(function (p) { return p.profileName; }).join(', ')));
-console.log("Browsers: ".concat(selectedBrowsers.join(', ')));
-console.log("Headless: ".concat(isHeadless));
+// Execute Cypress with selected configuration
+(0, executeCypress_1.default)({
+    selectedProfiles: selectedProfiles,
+    selectedBrowsers: selectedBrowsers,
+    isHeadless: isHeadless,
+    threadsPerCombo: threadsPerCombo,
+});
 //# sourceMappingURL=index.js.map

package/lib/start/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../start/index.ts"],"names":[],"mappings":";AAAA,+BAA+B;AAC/B;;;;;GAKG;;;;;AAEH,cAAc;AACd,0CAAoB;AACpB,8CAAwB;AAExB,iBAAiB;AACjB,sEAAgD;AAChD,sFAAgE;AAChE,sFAAgE;AAChE,gFAA0D;AAC1D,8EAAwD;AACxD,sEAAgD;AAEhD,mBAAmB;AACnB,sFAAgE;AAEhE,4BAA4B;AAC5B,IAAM,GAAG,GAAG,IAAA,qBAAW,GAAE,CAAC;AAE1B,kDAAkD;AAClD,IAAM,WAAW,GAAG,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;AACvD,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;IAChC,OAAO,CAAC,IAAI,CAAC,mDAA4C,WAAW,MAAG,CAAC,CAAC;IACzE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,gEAAgE;AAChE,IAAM,YAAY,GAAG,CACnB,YAAE;KACC,WAAW,CAAC,WAAW,CAAC;KACxB,MAAM,CAAC,UAAC,CAAC;IACR,OAAO,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;AACnC,CAAC,CAAC,CACL,CAAC;AAEF,8CAA8C;AAC9C,IAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,UAAC,IAAI;IACrC,IAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IACpD,OAAO,EAAE,IAAI,MAAA,EAAE,WAAW,aAAA,EAAE,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,4BAA4B;AAC5B,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;IAC1B,OAAO,CAAC,KAAK,CAAC,gCAAyB,WAAW,MAAG,CAAC,CAAC;IACvD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,sBAAsB;AACtB,IAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEnC,6DAA6D;AAC7D,IAAI,gBAAgB,GAA4C,EAAE,CAAC;AACnE,IAAI,gBAAgB,GAAa,EAAE,CAAC;AACpC,IAAI,UAAU,GAAG,KAAK,CAAC;AAEvB,yCAAyC;AACzC,IAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;AAC1C,IAAM,aAAa,GAAG,IAAA,yBAAe,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;AACzD,IAAM,UAAU,GAAG,aAAa,IAAI,aAAa,CAAC;AAElD,IAAI,UAAU,EAAE,CAAC;IACf,IAAM,YAAY,GAAG,IAAA,6BAAmB,EAAC,UAAU,CAAC,CAAC;IACrD,gBAAgB,GAAG,IAAA,6BAAmB,EAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;AACjE,CAAC;AAED,yCAAyC;AACzC,IAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;AAC1C,IAAM,aAAa,GAAG,IAAA,yBAAe,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;AACzD,IAAM,UAAU,GAAG,aAAa,IAAI,aAAa,CAAC;AAElD,IAAI,UAAU,EAAE,CAAC;IACf,IAAM,YAAY,GAAG,IAAA,6BAAmB,EAAC,UAAU,CAAC,CAAC;IACrD,gBAAgB,GAAG,IAAA,0BAAgB,EAAC,YAAY,CAAC,CAAC;AACpD,CAAC;AAED,2CAA2C;AAC3C,IAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;AAC5C,IAAM,iBAAiB,GAAG,IAAA,yBAAe,EAAC,IAAI,EAAE,YAAY,CAAC,CAAC;AAC9D,IAAM,eAAe,GAAG,iBAAiB,KAAK,SAAS,CAAC;AACxD,UAAU,GAAG,CAAC,CAAC,CAAC,cAAc,IAAI,cAAc,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,IAAI,eAAe,CAAC;AAE/F,uDAAuD;AACvD,IAAI,CAAC,cAAc,IAAI,CAAC,eAAe,EAAE,CAAC;IACxC,IAAM,OAAO,GAAG,IAAA,qBAAW,EAAC;QAC1B,QAAQ,EAAE,uBAAuB;QACjC,OAAO,EAAE;YACP,EAAE,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,gBAAgB,EAAE;YAC3C,EAAE,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,kBAAkB,EAAE;SAC9C;QACD,KAAK,EAAE,aAAa;QACpB,UAAU,EAAE,KAAK;KAClB,CAAC,CAAC;IAEH,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC;AACtC,CAAC;AAED,4EAA4E;AAC5E,IAAI,UAAU,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;IAChD,IAAM,OAAO,GAAG,4BAAkB,CAAC,GAAG,CAAC,UAAC,EAAa;YAAX,GAAG,SAAA,EAAE,IAAI,UAAA;QACjD,OAAO;YACL,GAAG,KAAA;YACH,WAAW,EAAE,IAAI;SAClB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAM,OAAO,GAAG,IAAA,qBAAW,EAAC;QAC1B,QAAQ,EAAE,8CAA8C;QACxD,OAAO,SAAA;QACP,KAAK,EAAE,mBAAmB;QAC1B,UAAU,EAAE,IAAI;KACjB,CAAC,CAAC;IAEH,gBAAgB,GAAG,CACjB,OAAO;SACJ,GAAG,CAAC,UAAC,MAAM;QACV,OAAO,4BAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC,CAAC;SACD,GAAG,CAAC,UAAC,EAAQ;YAAN,IAAI,UAAA;QACV,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CACL,CAAC;AACJ,CAAC;AAED,uDAAuD;AACvD,wDAAwD;AACxD,2DAA2D;AAC3D,qHAAqH;AACrH,IACE,gBAAgB,CAAC,MAAM,KAAK,CAAC;OAC1B,CAAC,CAAC,UAAU,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC,EAC/C,CAAC;IACD,IAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,UAAC,CAAC,EAAE,GAAG;QAClC,OAAO;YACL,GAAG,EAAE,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC;YACpB,WAAW,EAAE,CAAC,CAAC,WAAW;SAC3B,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAM,OAAO,GAAG,IAAA,qBAAW,EAAC;QAC1B,QAAQ,EAAE,CACR,UAAU;YACR,CAAC,CAAC,+CAA+C;YACjD,CAAC,CAAC,iBAAiB,CACtB;QACD,OAAO,SAAA;QACP,KAAK,EAAE,wBAAiB,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAE;QAC/C,UAAU,EAAE,UAAU;KACvB,CAAC,CAAC;IAEH,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,UAAC,MAAM,IAAO,OAAO,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACjF,CAAC;AAED,qFAAqF;AACrF,OAAO,CAAC,GAAG,CAAC,oDAAoD,CAAC,CAAC;AAClE,OAAO,CAAC,GAAG,CAAC,oBAAa,gBAAgB,CAAC,GAAG,CAAC,UAAC,CAAC,IAAO,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAC,CAAC;AAC9F,OAAO,CAAC,GAAG,CAAC,oBAAa,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAE,CAAC,CAAC;AACxD,OAAO,CAAC,GAAG,CAAC,oBAAa,UAAU,CAAE,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../start/index.ts"],"names":[],"mappings":";AAAA,+BAA+B;AAC/B;;;;;GAKG;;;;;AAEH,cAAc;AACd,0CAAoB;AACpB,8CAAwB;AAExB,iBAAiB;AACjB,sEAAgD;AAChD,sFAAgE;AAChE,sFAAgE;AAChE,gFAA0D;AAC1D,8EAAwD;AACxD,sEAAgD;AAChD,4EAAsD;AAEtD,mBAAmB;AACnB,sFAAgE;AAChE,oGAA8E;AAE9E,4BAA4B;AAC5B,IAAM,GAAG,GAAG,IAAA,qBAAW,GAAE,CAAC;AAE1B,kDAAkD;AAClD,IAAM,WAAW,GAAG,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;AACvD,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;IAChC,OAAO,CAAC,IAAI,CAAC,mDAA4C,WAAW,MAAG,CAAC,CAAC;IACzE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,gEAAgE;AAChE,IAAM,YAAY,GAAG,CACnB,YAAE;KACC,WAAW,CAAC,WAAW,CAAC;KACxB,MAAM,CAAC,UAAC,CAAC;IACR,OAAO,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;AACnC,CAAC,CAAC,CACL,CAAC;AAEF,8CAA8C;AAC9C,IAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,UAAC,IAAI;IACrC,IAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IACpD,OAAO,EAAE,IAAI,MAAA,EAAE,WAAW,aAAA,EAAE,CAAC;AAC/B,CAAC,CAAC,CAAC;AAEH,4BAA4B;AAC5B,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;IAC1B,OAAO,CAAC,KAAK,CAAC,gCAAyB,WAAW,MAAG,CAAC,CAAC;IACvD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,sBAAsB;AACtB,IAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEnC,6DAA6D;AAC7D,IAAI,gBAAgB,GAA4C,EAAE,CAAC;AACnE,IAAI,gBAAgB,GAAa,EAAE,CAAC;AACpC,IAAI,UAAU,GAAG,KAAK,CAAC;AAEvB,yCAAyC;AACzC,IAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;AAC1C,IAAM,aAAa,GAAG,IAAA,yBAAe,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;AACzD,IAAM,UAAU,GAAG,aAAa,IAAI,aAAa,CAAC;AAElD,IAAI,UAAU,EAAE,CAAC;IACf,IAAM,YAAY,GAAG,IAAA,6BAAmB,EAAC,UAAU,CAAC,CAAC;IACrD,gBAAgB,GAAG,IAAA,6BAAmB,EAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;AACjE,CAAC;AAED,yCAAyC;AACzC,IAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;AAC1C,IAAM,aAAa,GAAG,IAAA,yBAAe,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;AACzD,IAAM,UAAU,GAAG,aAAa,IAAI,aAAa,CAAC;AAElD,IAAI,UAAU,EAAE,CAAC;IACf,IAAM,YAAY,GAAG,IAAA,6BAAmB,EAAC,UAAU,CAAC,CAAC;IACrD,gBAAgB,GAAG,IAAA,0BAAgB,EAAC,YAAY,CAAC,CAAC;AACpD,CAAC;AAED,2CAA2C;AAC3C,IAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;AAC5C,IAAM,iBAAiB,GAAG,IAAA,yBAAe,EAAC,IAAI,EAAE,YAAY,CAAC,CAAC;AAC9D,IAAM,eAAe,GAAG,iBAAiB,KAAK,SAAS,CAAC;AACxD,UAAU,GAAG,CAAC,CAAC,CAAC,cAAc,IAAI,cAAc,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,IAAI,eAAe,CAAC;AAE/F,mDAAmD;AACnD,IAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;AACpD,IAAM,aAAa,GAAG,IAAA,yBAAe,EAAC,IAAI,EAAE,mBAAmB,CAAC,CAAC;AACjE,IAAM,UAAU,GAAG,aAAa,IAAI,aAAa,CAAC;AAClD,IAAI,eAAmC,CAAC;AACxC,IAAI,UAAU,EAAE,CAAC;IACf,IAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAC/C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;QACxC,eAAe,GAAG,MAAM,CAAC;IAC3B,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,IAAI,CAAC,0DAAwC,UAAU,gCAAqB,mCAAyB,OAAI,CAAC,CAAC;IACrH,CAAC;AACH,CAAC;AAED,uDAAuD;AACvD,IAAI,CAAC,cAAc,IAAI,CAAC,eAAe,EAAE,CAAC;IACxC,IAAM,OAAO,GAAG,IAAA,qBAAW,EAAC;QAC1B,QAAQ,EAAE,uBAAuB;QACjC,OAAO,EAAE;YACP,EAAE,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,gBAAgB,EAAE;YAC3C,EAAE,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,kBAAkB,EAAE;SAC9C;QACD,KAAK,EAAE,aAAa;QACpB,UAAU,EAAE,KAAK;KAClB,CAAC,CAAC;IAEH,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC;AACtC,CAAC;AAED,4EAA4E;AAC5E,IAAI,UAAU,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;IAChD,IAAM,OAAO,GAAG,4BAAkB,CAAC,GAAG,CAAC,UAAC,EAAa;YAAX,GAAG,SAAA,EAAE,IAAI,UAAA;QACjD,OAAO;YACL,GAAG,KAAA;YACH,WAAW,EAAE,IAAI;SAClB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAM,OAAO,GAAG,IAAA,qBAAW,EAAC;QAC1B,QAAQ,EAAE,8CAA8C;QACxD,OAAO,SAAA;QACP,KAAK,EAAE,mBAAmB;QAC1B,UAAU,EAAE,IAAI;KACjB,CAAC,CAAC;IAEH,gBAAgB,GAAG,CACjB,OAAO;SACJ,GAAG,CAAC,UAAC,MAAM;QACV,OAAO,4BAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC,CAAC;SACD,GAAG,CAAC,UAAC,EAAQ;YAAN,IAAI,UAAA;QACV,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CACL,CAAC;AACJ,CAAC;AAED,uDAAuD;AACvD,wDAAwD;AACxD,2DAA2D;AAC3D,qHAAqH;AACrH,IACE,gBAAgB,CAAC,MAAM,KAAK,CAAC;OAC1B,CAAC,CAAC,UAAU,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC,EAC/C,CAAC;IACD,IAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,UAAC,CAAC,EAAE,GAAG;QAClC,OAAO;YACL,GAAG,EAAE,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC;YACpB,WAAW,EAAE,CAAC,CAAC,WAAW;SAC3B,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAM,OAAO,GAAG,IAAA,qBAAW,EAAC;QAC1B,QAAQ,EAAE,CACR,UAAU;YACR,CAAC,CAAC,+CAA+C;YACjD,CAAC,CAAC,iBAAiB,CACtB;QACD,OAAO,SAAA;QACP,KAAK,EAAE,wBAAiB,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAE;QAC/C,UAAU,EAAE,UAAU;KACvB,CAAC,CAAC;IAEH,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC,UAAC,MAAM,IAAO,OAAO,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACjF,CAAC;AAED,8CAA8C;AAC9C,IAAA,wBAAc,EAAC;IACb,gBAAgB,kBAAA;IAChB,gBAAgB,kBAAA;IAChB,UAAU,YAAA;IACV,eAAe,iBAAA;CAChB,CAAC,CAAC"}

package/lib/start/types/MochawesomeReporterConfig.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Mochawesome reporter configuration
+ * @author Yuen Ler Chow
+ */
+type MochawesomeReporterConfig = {
+    reporterEnabled: string;
+    mochawesomeReporterOptions: {
+        reportDir: string;
+        reportFilename: string;
+        overwrite: boolean;
+        html: boolean;
+        json: boolean;
+    };
+};
+export default MochawesomeReporterConfig;

package/lib/start/types/MochawesomeReporterConfig.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=MochawesomeReporterConfig.js.map

package/lib/start/types/MochawesomeReporterConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MochawesomeReporterConfig.js","sourceRoot":"","sources":["../../../start/types/MochawesomeReporterConfig.ts"],"names":[],"mappings":""}

package/lib/start/types/Profile.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Profile configuration
+ * @author Yuen Ler Chow
+ */
+type Profile = {
+    file: string;
+    profileName: string;
+};
+export default Profile;

package/lib/start/types/Profile.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Profile.js.map

package/lib/start/types/Profile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Profile.js","sourceRoot":"","sources":["../../../start/types/Profile.ts"],"names":[],"mappings":""}

package/lib/start/types/ReportInfo.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Information about a generated report
+ * @author Yuen Ler Chow
+ */
+type ReportInfo = {
+    profileName: string;
+    browser: string;
+    reportPath: string;
+    success: boolean;
+    timestamp: string;
+    totalTests?: number;
+    passedTests?: number;
+};
+export default ReportInfo;

package/lib/start/types/ReportInfo.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ReportInfo.js.map

package/lib/start/types/ReportInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReportInfo.js","sourceRoot":"","sources":["../../../start/types/ReportInfo.ts"],"names":[],"mappings":""}

package/lib/start/types/RunResult.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Result from a Cypress headless run
+ * @author Yuen Ler Chow
+ */
+type RunResult = {
+    profileName: string;
+    browser: string;
+    success: boolean;
+    outputDir: string;
+    reportPath?: string;
+};
+export default RunResult;

package/lib/start/types/RunResult.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=RunResult.js.map

package/lib/start/types/RunResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RunResult.js","sourceRoot":"","sources":["../../../start/types/RunResult.ts"],"names":[],"mappings":""}

package/lib/start/types/ScreenshotInfo.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Information about a screenshot captured during a Cypress test run,
+ * used for linking screenshots in the report homepage
+ * @author Yuen Ler Chow
+ */
+type ScreenshotInfo = {
+    href: string;
+    name: string;
+};
+export default ScreenshotInfo;

package/lib/start/types/ScreenshotInfo.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ScreenshotInfo.js.map

package/lib/start/types/ScreenshotInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ScreenshotInfo.js","sourceRoot":"","sources":["../../../start/types/ScreenshotInfo.ts"],"names":[],"mappings":""}

package/lib/start/types/TemplateReportInfo.d.ts

@@ -0,0 +1,12 @@
+import ReportInfo from './ReportInfo';
+import ScreenshotInfo from './ScreenshotInfo';
+/**
+ * Extended version of ReportInfo with additional computed fields
+ * needed for rendering the EJS report homepage template
+ * @author Yuen Ler Chow
+ */
+type TemplateReportInfo = ReportInfo & {
+    relativeReportPath: string | null;
+    screenshots: ScreenshotInfo[];
+};
+export default TemplateReportInfo;

package/lib/start/types/TemplateReportInfo.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TemplateReportInfo.js.map

package/lib/start/types/TemplateReportInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TemplateReportInfo.js","sourceRoot":"","sources":["../../../start/types/TemplateReportInfo.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "dceky",
-  "version": "1.0.5-beta.ky-declarations.13",
+  "version": "1.0.5",
   "description": "Cypress toolkit for Harvard DCE",
   "main": "./lib/src/index.js",
   "types": "./lib/src/index.d.ts",
   "scripts": {
-    "build": "tsc --project ./tsconfig.json",
+    "build": "tsc --project ./tsconfig.json && cp start/helpers/reportHomepage.ejs lib/start/helpers/",
     "ky:start": "npx tsx ./start/index.ts",
     "ky:setup": "npx tsx ./setup/index.ts",
     "ky:dev": "npm run ky:setup && npm run ky:start",
@@ -28,16 +28,17 @@
   },
   "homepage": "https://github.com/harvard-edtech/dceky#readme",
   "dependencies": {
+    "@types/clear": "^0.1.4",
+    "@types/ejs": "^3.1.5",
+    "@types/node": "^22.7.0",
+    "@types/prompt-sync": "^4.2.3",
     "child_process": "^1.0.2",
     "clear": "^0.1.0",
     "deepmerge": "4.3.1",
-    "prompt-sync": "^4.2.0",
-    "@types/prompt-sync": "^4.2.3",
-    "@types/clear": "^0.1.4",
-    "@types/node": "^22.7.0"
+    "ejs": "^3.1.10",
+    "prompt-sync": "^4.2.0"
   },
   "devDependencies": {
-    "typescript": "^5.9.3",
     "@types/deepmerge": "2.1.0",
     "@types/node": "^24.6.1",
     "cross-env": "^10.1.0",
@@ -46,7 +47,8 @@
     "eslint-config-airbnb-typescript": "^17.1.0",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-jsx-a11y": "^6.10.2",
-    "eslint-plugin-react": "^7.37.5"
+    "eslint-plugin-react": "^7.37.5",
+    "typescript": "^5.9.3"
   },
   "peerDependencies": {
     "cypress": "^x.x.x"

package/src/commands/extractDataFromClass.ts

@@ -11,14 +11,16 @@ declare global {
        * Obtain data from a class attribute that starts with a specific prefix
        * and return it
        * @author Allison Zhang
-       * @param selector the css selector for finding the element
-       * @param classPrefix the prefix to look for in the class attribute
+       * @param opts the options object
+       * @param opts.selector the css selector for finding the element
+       * @param opts.classPrefix the prefix to look for in the class attribute
        * @returns the extracted data
-       * @example cy.extractDataFromClass('.item', 'data-').then((data) => { ... })
        */
       extractDataFromClass(
-        selector: string,
-        classPrefix: string,
+        opts: {
+          selector: string,
+          classPrefix: string,
+        },
       ): Chainable<string[]>;
     }
   }
@@ -29,7 +31,16 @@ declare global {
 /*----------------------------------------*/
 
 const extractDataFromClass = () => {
-  Cypress.Commands.add('extractDataFromClass', (selector: string, classPrefix: string) => {
+  Cypress.Commands.add('extractDataFromClass', (
+    opts: {
+      selector: string,
+      classPrefix: string,
+    },
+  ) => {
+    const {
+      selector,
+      classPrefix,
+    } = opts;
     return (
       cy
         .get(selector)

package/src/commands/extractDataFromClassByContents.ts

@@ -11,16 +11,18 @@ declare global {
        * Obtain data from a class attribute that starts with a specific prefix
        * and with specific contents, and return it
        * @author Allison Zhang
-       * @param contents the contents of the element to find
-       * @param selector the css selector for finding the element
-       * @param classPrefix the prefix to look for in the class attribute
+       * @param opts the options object
+       * @param opts.contents the contents of the element to find
+       * @param opts.selector the css selector for finding the element
+       * @param opts.classPrefix the prefix to look for in the class attribute
        * @returns the extracted data
-       * @example cy.extractDataFromClassByContents('Submit', '.button', 'btn-').then((data) => { ... })
        */
       extractDataFromClassByContents(
-        contents: string,
-        selector: string,
-        classPrefix: string,
+        opts: {
+          contents: string,
+          selector: string,
+          classPrefix: string,
+        },
       ): Chainable<string[]>;
     }
   }
@@ -31,7 +33,18 @@ declare global {
 /*----------------------------------------*/
 
 const extractDataFromClassByContents = () => {
-  Cypress.Commands.add('extractDataFromClassByContents', (contents: string, selector: string, classPrefix: string) => {
+  Cypress.Commands.add('extractDataFromClassByContents', (
+    opts: {
+      contents: string,
+      selector: string,
+      classPrefix: string,
+    },
+  ) => {
+    const {
+      contents,
+      selector,
+      classPrefix,
+    } = opts;
     return (
       cy
         .get(selector)

package/src/commands/genTextOfLength.ts

@@ -0,0 +1,54 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Generate a string of specified length for Cypress tests
+       * @author Gardenia Liu, Allison Zhang
+       * @param opts options object
+       * @param opts.length the desired length of the string
+       * @param opts.text optional text to repeat to form the string; defaults to '123456789x' if not provided
+       * @returns a string of the specified length, if the length is not a multiple of the text length, it is truncated
+       */
+      genTextOfLength(
+        opts: {
+          length: number,
+          text?: string,
+        },
+      ): Chainable<string>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const genTextOfLength = () => {
+  Cypress.Commands.add('genTextOfLength', (
+    opts: {
+      length: number,
+      text?: string,
+    },
+  ) => {
+    const {
+      length,
+      text,
+    } = opts;
+    const textToUse = text || '123456789x';
+    const lengthOfTextToUse = Math.ceil(length / textToUse.length);
+    const result = textToUse.repeat(lengthOfTextToUse).substring(0, length);
+    return cy.wrap(result);
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default genTextOfLength;