npm - dceky - Versions diffs - 1.1.0 → 1.1.2 - Mend

dceky 1.1.0 → 1.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (176) hide show

package/docs/commands.html +961 -0
package/genDocs/index.ts +322 -0
package/lib/genDocs/index.d.ts +1 -0
package/lib/genDocs/index.js +285 -0
package/lib/genDocs/index.js.map +1 -0
package/lib/postinstall/helpers/getRootPath.js +3 -3
package/lib/postinstall/helpers/getRootPath.js.map +1 -1
package/lib/postinstall/index.js +6 -6
package/lib/postinstall/index.js.map +1 -1
package/lib/preinstall/helpers/getRootPath.js +3 -3
package/lib/preinstall/helpers/getRootPath.js.map +1 -1
package/lib/preinstall/index.js +6 -6
package/lib/preinstall/index.js.map +1 -1
package/lib/setup/addToGitIgnore.js +13 -13
package/lib/setup/addToGitIgnore.js.map +1 -1
package/lib/setup/checkRequiredFiles/genEmptyGlobalFile.js +12 -12
package/lib/setup/checkRequiredFiles/genEmptyGlobalFile.js.map +1 -1
package/lib/setup/checkRequiredFiles/genEmptyProfileFile.js +12 -12
package/lib/setup/checkRequiredFiles/genEmptyProfileFile.js.map +1 -1
package/lib/setup/checkRequiredFiles/genExampleTest.js +8 -8
package/lib/setup/checkRequiredFiles/genExampleTest.js.map +1 -1
package/lib/setup/checkRequiredFiles/index.js +21 -21
package/lib/setup/checkRequiredFiles/index.js.map +1 -1
package/lib/setup/genCommandImportFile.js +24 -24
package/lib/setup/genCommandImportFile.js.map +1 -1
package/lib/setup/genDynamicConfigFile.js +8 -8
package/lib/setup/genDynamicConfigFile.js.map +1 -1
package/lib/setup/genE2ELaunchFile.js +9 -9
package/lib/setup/genE2ELaunchFile.js.map +1 -1
package/lib/setup/genKyCommandDeclarations.js +24 -24
package/lib/setup/genKyCommandDeclarations.js.map +1 -1
package/lib/setup/genTsConfigFile.d.ts +6 -0
package/lib/setup/genTsConfigFile.js +51 -0
package/lib/setup/genTsConfigFile.js.map +1 -0
package/lib/setup/helpers/getRootPath.js +3 -3
package/lib/setup/helpers/getRootPath.js.map +1 -1
package/lib/setup/index.js +9 -7
package/lib/setup/index.js.map +1 -1
package/lib/setup/setupCypressDependencies.js +11 -11
package/lib/setup/setupCypressDependencies.js.map +1 -1
package/lib/src/commands/assertDoesNotHaveClass.js +3 -3
package/lib/src/commands/assertDoesNotHaveClass.js.map +1 -1
package/lib/src/commands/assertHasClass.js +3 -3
package/lib/src/commands/assertHasClass.js.map +1 -1
package/lib/src/commands/assertNumElements.js +3 -3
package/lib/src/commands/assertNumElements.js.map +1 -1
package/lib/src/commands/checkIfElementExists.js +3 -3
package/lib/src/commands/checkIfElementExists.js.map +1 -1
package/lib/src/commands/extractDataFromClass.js +8 -8
package/lib/src/commands/extractDataFromClass.js.map +1 -1
package/lib/src/commands/extractDataFromClassByContents.js +8 -8
package/lib/src/commands/extractDataFromClassByContents.js.map +1 -1
package/lib/src/commands/genTextOfLength.js +6 -6
package/lib/src/commands/genTextOfLength.js.map +1 -1
package/lib/src/commands/getAttribute.js +4 -4
package/lib/src/commands/getAttribute.js.map +1 -1
package/lib/src/commands/getClassName.js +3 -3
package/lib/src/commands/getClassName.js.map +1 -1
package/lib/src/commands/getCredentialValue.d.ts +1 -3
package/lib/src/commands/getCredentialValue.js +3 -4
package/lib/src/commands/getCredentialValue.js.map +1 -1
package/lib/src/commands/getCredentialValues.js +2 -2
package/lib/src/commands/getCredentialValues.js.map +1 -1
package/lib/src/commands/getCurrentDateInfo.js +4 -4
package/lib/src/commands/getCurrentDateInfo.js.map +1 -1
package/lib/src/commands/getId.js +3 -3
package/lib/src/commands/getId.js.map +1 -1
package/lib/src/commands/getJSON.js +2 -2
package/lib/src/commands/getJSON.js.map +1 -1
package/lib/src/commands/getNumElements.js +4 -4
package/lib/src/commands/getNumElements.js.map +1 -1
package/lib/src/commands/getProfileValue.d.ts +2 -1
package/lib/src/commands/getProfileValue.js +1 -1
package/lib/src/commands/getProfileValue.js.map +1 -1
package/lib/src/commands/getSpecialChars.js +2 -2
package/lib/src/commands/getSpecialChars.js.map +1 -1
package/lib/src/commands/getTitle.js +3 -3
package/lib/src/commands/getTitle.js.map +1 -1
package/lib/src/commands/handleHarvardKey.js +12 -12
package/lib/src/commands/handleHarvardKey.js.map +1 -1
package/lib/src/commands/helpers/getFormData.js +13 -13
package/lib/src/commands/helpers/getFormData.js.map +1 -1
package/lib/src/commands/index.js +34 -34
package/lib/src/commands/index.js.map +1 -1
package/lib/src/commands/launchAs.js +25 -26
package/lib/src/commands/launchAs.js.map +1 -1
package/lib/src/commands/listSelectLabels.js +6 -6
package/lib/src/commands/listSelectLabels.js.map +1 -1
package/lib/src/commands/listSelectValues.js +7 -7
package/lib/src/commands/listSelectValues.js.map +1 -1
package/lib/src/commands/logIntoPorta.js +21 -31
package/lib/src/commands/logIntoPorta.js.map +1 -1
package/lib/src/commands/navigateToHref.js +7 -7
package/lib/src/commands/navigateToHref.js.map +1 -1
package/lib/src/commands/padWithZeros.js +6 -6
package/lib/src/commands/padWithZeros.js.map +1 -1
package/lib/src/commands/runScript.js +4 -4
package/lib/src/commands/runScript.js.map +1 -1
package/lib/src/commands/tap.js +2 -2
package/lib/src/commands/tap.js.map +1 -1
package/lib/src/commands/tapInIFrame.js +2 -2
package/lib/src/commands/tapInIFrame.js.map +1 -1
package/lib/src/commands/typeInto.js +9 -9
package/lib/src/commands/typeInto.js.map +1 -1
package/lib/src/commands/uniquify.js +7 -7
package/lib/src/commands/uniquify.js.map +1 -1
package/lib/src/commands/visitCanvasEndpoint.js +7 -18
package/lib/src/commands/visitCanvasEndpoint.js.map +1 -1
package/lib/src/commands/waitForAtLeastOneElementPresent.js +9 -9
package/lib/src/commands/waitForAtLeastOneElementPresent.js.map +1 -1
package/lib/src/commands/waitForElementVisible.js +4 -4
package/lib/src/commands/waitForElementVisible.js.map +1 -1
package/lib/src/genConfiguration/helpers/getRootPath.js +3 -3
package/lib/src/genConfiguration/helpers/getRootPath.js.map +1 -1
package/lib/src/genConfiguration/helpers/resolveDependents.js +8 -9
package/lib/src/genConfiguration/helpers/resolveDependents.js.map +1 -1
package/lib/src/genConfiguration/helpers/splitEnv.js +5 -6
package/lib/src/genConfiguration/helpers/splitEnv.js.map +1 -1
package/lib/src/genConfiguration/index.js +36 -44
package/lib/src/genConfiguration/index.js.map +1 -1
package/lib/src/index.js +1 -1
package/lib/src/index.js.map +1 -1
package/lib/start/constants/AVAILABLE_BROWSERS.js +1 -1
package/lib/start/constants/AVAILABLE_BROWSERS.js.map +1 -1
package/lib/start/constants/DEFAULT_THREADS_PER_COMBO.js +1 -1
package/lib/start/constants/DEFAULT_THREADS_PER_COMBO.js.map +1 -1
package/lib/start/helpers/collectPngFiles.js +8 -9
package/lib/start/helpers/collectPngFiles.js.map +1 -1
package/lib/start/helpers/exec.js +2 -2
package/lib/start/helpers/exec.js.map +1 -1
package/lib/start/helpers/executeAllHeadlessCombinations.js +58 -89
package/lib/start/helpers/executeAllHeadlessCombinations.js.map +1 -1
package/lib/start/helpers/executeCypress.js +32 -73
package/lib/start/helpers/executeCypress.js.map +1 -1
package/lib/start/helpers/extractArgValue.js +7 -7
package/lib/start/helpers/extractArgValue.js.map +1 -1
package/lib/start/helpers/findProfilesByNames.js +7 -7
package/lib/start/helpers/findProfilesByNames.js.map +1 -1
package/lib/start/helpers/generateHtmlReport.js +19 -19
package/lib/start/helpers/generateHtmlReport.js.map +1 -1
package/lib/start/helpers/generateReportHomepage.js +49 -68
package/lib/start/helpers/generateReportHomepage.js.map +1 -1
package/lib/start/helpers/generateReporterConfig.js +4 -4
package/lib/start/helpers/generateReporterConfig.js.map +1 -1
package/lib/start/helpers/getDateLabeledDir.js +17 -17
package/lib/start/helpers/getDateLabeledDir.js.map +1 -1
package/lib/start/helpers/getRootPath.js +3 -3
package/lib/start/helpers/getRootPath.js.map +1 -1
package/lib/start/helpers/mergeAllReportsAndGenerateHtml.js +29 -29
package/lib/start/helpers/mergeAllReportsAndGenerateHtml.js.map +1 -1
package/lib/start/helpers/mergeReports.js +22 -22
package/lib/start/helpers/mergeReports.js.map +1 -1
package/lib/start/helpers/parseCommaSeparated.js +3 -3
package/lib/start/helpers/parseCommaSeparated.js.map +1 -1
package/lib/start/helpers/print.js +19 -19
package/lib/start/helpers/print.js.map +1 -1
package/lib/start/helpers/prompt.js +5 -5
package/lib/start/helpers/prompt.js.map +1 -1
package/lib/start/helpers/runCypressHeadless.js +41 -52
package/lib/start/helpers/runCypressHeadless.js.map +1 -1
package/lib/start/helpers/runCypressVisible.js +13 -24
package/lib/start/helpers/runCypressVisible.js.map +1 -1
package/lib/start/helpers/showChooser.js +27 -38
package/lib/start/helpers/showChooser.js.map +1 -1
package/lib/start/helpers/validateBrowsers.js +8 -8
package/lib/start/helpers/validateBrowsers.js.map +1 -1
package/lib/start/index.js +58 -60
package/lib/start/index.js.map +1 -1
package/package.json +6 -4
package/setup/genE2ELaunchFile.ts +1 -1
package/setup/genTsConfigFile.ts +55 -0
package/setup/index.ts +2 -0
package/src/commands/getCredentialValue.ts +1 -3
package/src/commands/getProfileValue.ts +2 -1
package/src/genConfiguration/index.ts +3 -1
package/tsconfig.json +4 -3

package/docs/commands.html ADDED Viewed

@@ -0,0 +1,961 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Ky Functions</title>
+  <style>
+    *, *::before, *::after { box-sizing: border-box; }
+    body {
+      font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
+      background: #f5f6fa;
+      color: #222;
+      margin: 0;
+      padding: 2rem;
+    }
+    h1 { font-size: 2rem; margin-bottom: 0.25rem; }
+    .subtitle { color: #666; margin-bottom: 1.5rem; }
+    .toc {
+      background: #fff;
+      border-radius: 8px;
+      padding: 1.25rem 1.5rem;
+      box-shadow: 0 1px 4px rgba(0,0,0,0.10);
+      margin-bottom: 2rem;
+    }
+    .toc h2 { margin: 0 0 0.75rem; font-size: 1rem; text-transform: uppercase; letter-spacing: 0.05em; color: #555; }
+    .toc ul { margin: 0; padding: 0; list-style: none; display: flex; flex-direction: column; gap: 0.4rem; }
+    .toc a { text-decoration: none; color: #4f7ef8; font-size: 0.9rem; }
+    .toc a:hover { text-decoration: underline; }
+    .toc code { background: none; font-size: 0.88rem; }
+    .grid {
+      display: grid;
+      grid-template-columns: repeat(auto-fill, minmax(480px, 1fr));
+      gap: 1.25rem;
+    }
+    .card {
+      background: #fff;
+      border-radius: 8px;
+      padding: 1.25rem 1.5rem;
+      box-shadow: 0 1px 4px rgba(0,0,0,0.10);
+      border-left: 4px solid #4f7ef8;
+    }
+    .card h2 {
+      margin: 0 0 0.5rem;
+      font-size: 1.1rem;
+      color: #1a1a2e;
+    }
+    .card h2 code {
+      background: none;
+      font-size: 1.05rem;
+    }
+    .description { margin-bottom: 0.75rem; line-height: 1.6; }
+    .description p { margin: 0 0 0.4rem; }
+    .returns { font-size: 0.875rem; color: #444; margin: 0.4rem 0; }
+    .label { font-weight: 600; }
+    .params {
+      width: 100%;
+      border-collapse: collapse;
+      font-size: 0.85rem;
+      margin: 0.5rem 0;
+    }
+    .params th {
+      text-align: left;
+      background: #f0f3ff;
+      padding: 0.35rem 0.6rem;
+      border-bottom: 2px solid #dde3f7;
+    }
+    .params td {
+      padding: 0.3rem 0.6rem;
+      border-bottom: 1px solid #eee;
+      vertical-align: top;
+    }
+    .params td code {
+      background: #f0f3ff;
+      padding: 0.1rem 0.3rem;
+      border-radius: 3px;
+      font-size: 0.82rem;
+    }
+  </style>
+</head>
+<body>
+  <h1>Ky Functions</h1>
+  <p class="subtitle">Ky functions that are available in all Ky projects, in addition to the built-in cypress functions</p>
+  <nav class="toc" aria-label="Table of contents">
+  <h2>Commands</h2>
+  <ul>
+    <li><a href="#fn-assertDoesNotHaveClass"><code>ky.assertDoesNotHaveClass()</code></a></li>
+    <li><a href="#fn-assertHasClass"><code>ky.assertHasClass()</code></a></li>
+    <li><a href="#fn-assertNumElements"><code>ky.assertNumElements()</code></a></li>
+    <li><a href="#fn-checkIfElementExists"><code>ky.checkIfElementExists()</code></a></li>
+    <li><a href="#fn-extractDataFromClass"><code>ky.extractDataFromClass()</code></a></li>
+    <li><a href="#fn-extractDataFromClassByContents"><code>ky.extractDataFromClassByContents()</code></a></li>
+    <li><a href="#fn-genTextOfLength"><code>ky.genTextOfLength()</code></a></li>
+    <li><a href="#fn-getAttribute"><code>ky.getAttribute()</code></a></li>
+    <li><a href="#fn-getClassName"><code>ky.getClassName()</code></a></li>
+    <li><a href="#fn-getCredentialValue"><code>ky.getCredentialValue()</code></a></li>
+    <li><a href="#fn-getCredentialValues"><code>ky.getCredentialValues()</code></a></li>
+    <li><a href="#fn-getCurrentDateInfo"><code>ky.getCurrentDateInfo()</code></a></li>
+    <li><a href="#fn-getId"><code>ky.getId()</code></a></li>
+    <li><a href="#fn-getJSON"><code>ky.getJSON()</code></a></li>
+    <li><a href="#fn-getNumElements"><code>ky.getNumElements()</code></a></li>
+    <li><a href="#fn-getProfileValue"><code>ky.getProfileValue()</code></a></li>
+    <li><a href="#fn-getSpecialChars"><code>ky.getSpecialChars()</code></a></li>
+    <li><a href="#fn-getTitle"><code>ky.getTitle()</code></a></li>
+    <li><a href="#fn-handleHarvardKey"><code>ky.handleHarvardKey()</code></a></li>
+    <li><a href="#fn-launchAs"><code>ky.launchAs()</code></a></li>
+    <li><a href="#fn-listSelectLabels"><code>ky.listSelectLabels()</code></a></li>
+    <li><a href="#fn-listSelectValues"><code>ky.listSelectValues()</code></a></li>
+    <li><a href="#fn-logIntoPorta"><code>ky.logIntoPorta()</code></a></li>
+    <li><a href="#fn-navigateToHref"><code>ky.navigateToHref()</code></a></li>
+    <li><a href="#fn-padWithZeros"><code>ky.padWithZeros()</code></a></li>
+    <li><a href="#fn-runScript"><code>ky.runScript()</code></a></li>
+    <li><a href="#fn-tap"><code>ky.tap()</code></a></li>
+    <li><a href="#fn-tapInIFrame"><code>ky.tapInIFrame()</code></a></li>
+    <li><a href="#fn-typeInto"><code>ky.typeInto()</code></a></li>
+    <li><a href="#fn-uniquify"><code>ky.uniquify()</code></a></li>
+    <li><a href="#fn-visitCanvasEndpoint"><code>ky.visitCanvasEndpoint()</code></a></li>
+    <li><a href="#fn-waitForAtLeastOneElementPresent"><code>ky.waitForAtLeastOneElementPresent()</code></a></li>
+    <li><a href="#fn-waitForElementVisible"><code>ky.waitForElementVisible()</code></a></li>
+  </ul>
+</nav>
+  <div class="grid">
+  <div class="card" id="fn-assertDoesNotHaveClass">
+    <h2><code>ky.assertDoesNotHaveClass()</code></h2>
+    <div class="description"><p>Assert that an element does not have a specific className</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>opts</code></td>
+        <td>No</td>
+        <td>object containing all arguments</td>
+      </tr>
+      <tr>
+        <td><code>opts.item</code></td>
+        <td>No</td>
+        <td>the css selector for finding the element</td>
+      </tr>
+      <tr>
+        <td><code>opts.className</code></td>
+        <td>No</td>
+        <td>the className to check for</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> Cypress chainable containing the element that was checked</p>
+  </div>
+  <div class="card" id="fn-assertHasClass">
+    <h2><code>ky.assertHasClass()</code></h2>
+    <div class="description"><p>Assert that an element has a specific className</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>opts</code></td>
+        <td>No</td>
+        <td>object containing all arguments</td>
+      </tr>
+      <tr>
+        <td><code>opts.item</code></td>
+        <td>No</td>
+        <td>the css selector for finding the element</td>
+      </tr>
+      <tr>
+        <td><code>opts.className</code></td>
+        <td>No</td>
+        <td>the className to check for</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> Cypress chainable containing the element that was checked</p>
+  </div>
+  <div class="card" id="fn-assertNumElements">
+    <h2><code>ky.assertNumElements()</code></h2>
+    <div class="description"><p>Assert a certain number of elements</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>opts</code></td>
+        <td>No</td>
+        <td>object containing all arguments</td>
+      </tr>
+      <tr>
+        <td><code>opts.item</code></td>
+        <td>No</td>
+        <td>a CSS selector corresponding to the item</td>
+      </tr>
+      <tr>
+        <td><code>opts.num</code></td>
+        <td>No</td>
+        <td>the precise number of elements expected</td>
+      </tr>
+          </tbody>
+        </table>
+  </div>
+  <div class="card" id="fn-checkIfElementExists">
+    <h2><code>ky.checkIfElementExists()</code></h2>
+    <div class="description"><p>Check if an element exists on the page</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>selector</code></td>
+        <td>No</td>
+        <td>- The selector for the element to check</td>
+      </tr>
+          </tbody>
+        </table>
+  </div>
+  <div class="card" id="fn-extractDataFromClass">
+    <h2><code>ky.extractDataFromClass()</code></h2>
+    <div class="description"><p>Obtain data from a class attribute that starts with a specific prefix
+and return it</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>opts</code></td>
+        <td>No</td>
+        <td>the options object</td>
+      </tr>
+      <tr>
+        <td><code>opts.selector</code></td>
+        <td>No</td>
+        <td>the css selector for finding the element</td>
+      </tr>
+      <tr>
+        <td><code>opts.classPrefix</code></td>
+        <td>No</td>
+        <td>the prefix to look for in the class attribute</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> the extracted data</p>
+  </div>
+  <div class="card" id="fn-extractDataFromClassByContents">
+    <h2><code>ky.extractDataFromClassByContents()</code></h2>
+    <div class="description"><p>Obtain data from a class attribute that starts with a specific prefix
+and with specific contents, and return it</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>opts</code></td>
+        <td>No</td>
+        <td>the options object</td>
+      </tr>
+      <tr>
+        <td><code>opts.contents</code></td>
+        <td>No</td>
+        <td>the contents of the element to find</td>
+      </tr>
+      <tr>
+        <td><code>opts.selector</code></td>
+        <td>No</td>
+        <td>the css selector for finding the element</td>
+      </tr>
+      <tr>
+        <td><code>opts.classPrefix</code></td>
+        <td>No</td>
+        <td>the prefix to look for in the class attribute</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> the extracted data</p>
+  </div>
+  <div class="card" id="fn-genTextOfLength">
+    <h2><code>ky.genTextOfLength()</code></h2>
+    <div class="description"><p>Generate a string of specified length for Cypress tests</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>opts</code></td>
+        <td>No</td>
+        <td>options object</td>
+      </tr>
+      <tr>
+        <td><code>opts.length</code></td>
+        <td>No</td>
+        <td>the desired length of the string</td>
+      </tr>
+      <tr>
+        <td><code>opts.text</code></td>
+        <td>No</td>
+        <td>optional text to repeat to form the string; defaults to '123456789x' if not provided</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> a string of the specified length, if the length is not a multiple of the text length, it is truncated</p>
+  </div>
+  <div class="card" id="fn-getAttribute">
+    <h2><code>ky.getAttribute()</code></h2>
+    <div class="description"><p>Get the attribute of an element</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>opts</code></td>
+        <td>No</td>
+        <td>options object</td>
+      </tr>
+      <tr>
+        <td><code>opts.selector</code></td>
+        <td>No</td>
+        <td>the CSS selector of the element</td>
+      </tr>
+      <tr>
+        <td><code>opts.attribute</code></td>
+        <td>No</td>
+        <td>the attribute to retrieve</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> the attribute of the element</p>
+  </div>
+  <div class="card" id="fn-getClassName">
+    <h2><code>ky.getClassName()</code></h2>
+    <div class="description"><p>Get the class attribute of an element</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>selector</code></td>
+        <td>No</td>
+        <td>the CSS selector of the element</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> the class of the element, if multiple classes exist, they are space-separated</p>
+  </div>
+  <div class="card" id="fn-getCredentialValue">
+    <h2><code>ky.getCredentialValue()</code></h2>
+    <div class="description"><p>Get a credential from GlobalCredentials</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>key</code></td>
+        <td>No</td>
+        <td>the key of the environment variable to retrieve</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> The value of the specified environment variable</p>
+  </div>
+  <div class="card" id="fn-getCredentialValues">
+    <h2><code>ky.getCredentialValues()</code></h2>
+    <div class="description"><p>Alias for cy.env for retrieving multiple environment variables at once
+Obtains multiple credential values from the Cypress env depending on
+the provided keys.</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>keys</code></td>
+        <td>No</td>
+        <td>the keys of the environment variables to retrieve</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> Object where keys are the provided keys and the values are</p>
+  </div>
+  <div class="card" id="fn-getCurrentDateInfo">
+    <h2><code>ky.getCurrentDateInfo()</code></h2>
+    <div class="description"><p>Get the current day</p>
+</div>
+    <p class="returns"><span class="label">Returns:</span> the current month as a number (1-31)</p>
+  </div>
+  <div class="card" id="fn-getId">
+    <h2><code>ky.getId()</code></h2>
+    <div class="description"><p>Get the id of an element</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>selector</code></td>
+        <td>No</td>
+        <td>the CSS selector of the element</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> the id of the element</p>
+  </div>
+  <div class="card" id="fn-getJSON">
+    <h2><code>ky.getJSON()</code></h2>
+    <div class="description"><p>Obtain JSON data from a request and return it.</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>url</code></td>
+        <td>No</td>
+        <td>the URL to fetch the JSON data from</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> the JSON data</p>
+  </div>
+  <div class="card" id="fn-getNumElements">
+    <h2><code>ky.getNumElements()</code></h2>
+    <div class="description"><p>Get number of elements</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>selector</code></td>
+        <td>No</td>
+        <td>a CSS selector corresponding to the item to count</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> Cypress chainable containing the number of elements matching the selector</p>
+  </div>
+  <div class="card" id="fn-getProfileValue">
+    <h2><code>ky.getProfileValue()</code></h2>
+    <div class="description"><p>Get a (non-credential) value from the current profile,
+GlobalValues, or GlobalResources</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>key</code></td>
+        <td>No</td>
+        <td>the key of the environment variable to retrieve</td>
+      </tr>
+          </tbody>
+        </table>
+  </div>
+  <div class="card" id="fn-getSpecialChars">
+    <h2><code>ky.getSpecialChars()</code></h2>
+    <div class="description"><p>Generate all printable special characters for Cypress tests</p>
+</div>
+    <p class="returns"><span class="label">Returns:</span> a string containing all special characters</p>
+  </div>
+  <div class="card" id="fn-getTitle">
+    <h2><code>ky.getTitle()</code></h2>
+    <div class="description"><p>Get the current title of the page</p>
+</div>
+  </div>
+  <div class="card" id="fn-handleHarvardKey">
+    <h2><code>ky.handleHarvardKey()</code></h2>
+    <div class="description"><p>Handle a HarvardKey login page for a user via UI (form filling with cy.origin(), not API calls)</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>name</code></td>
+        <td>No</td>
+        <td>the name of the user environment variable</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> Cypress chainable (void) - performs authentication flow, no return value</p>
+  </div>
+  <div class="card" id="fn-launchAs">
+    <h2><code>ky.launchAs()</code></h2>
+    <div class="description"><p>Log into Canvas and launch an LTI app as a specific user from environment variables.
+The user should be defined as an environment variable with the following properties:</p>
+<ul>
+<li>accessToken: Canvas access token for the user (required for production mode)</li>
+<li>username: the HarvardKey username of the user</li>
+<li>password: the HarvardKey password of the user</li>
+</ul>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>name</code></td>
+        <td>No</td>
+        <td>the name of the user environment variable</td>
+      </tr>
+      <tr>
+        <td><code>opts</code></td>
+        <td>No</td>
+        <td>object containing all arguments</td>
+      </tr>
+      <tr>
+        <td><code>opts.courseId</code></td>
+        <td>Yes</td>
+        <td>the Canvas ID of the course to launch from</td>
+      </tr>
+      <tr>
+        <td><code>opts.appName</code></td>
+        <td>Yes</td>
+        <td>the name of the app as it appears in the course's left-hand nav</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> Cypress chainable (void) - launches the LTI app, no return value</p>
+  </div>
+  <div class="card" id="fn-listSelectLabels">
+    <h2><code>ky.listSelectLabels()</code></h2>
+    <div class="description"><p>Get the labels of all the options within a select element</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>selector</code></td>
+        <td>No</td>
+        <td>the CSS selector of the select element</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> an array of strings representing the labels of the options</p>
+  </div>
+  <div class="card" id="fn-listSelectValues">
+    <h2><code>ky.listSelectValues()</code></h2>
+    <div class="description"><p>Get the values of all the options within a select element</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>selector</code></td>
+        <td>No</td>
+        <td>the CSS selector of the select element</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> an array of strings representing the values of the options</p>
+  </div>
+  <div class="card" id="fn-logIntoPorta">
+    <h2><code>ky.logIntoPorta()</code></h2>
+    <div class="description"><p>Log into Porta via HarvardKey authentication using API requests (no UI interaction).</p>
+<p>Flow:</p>
+<ol>
+<li>GET Cirrus Identity discovery page → extract HarvardKey IdP button href</li>
+<li>GET IdP login page → extract form action and hidden fields</li>
+<li>POST credentials to the login form</li>
+<li>POST SAML form to ACS</li>
+</ol>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>name</code></td>
+        <td>No</td>
+        <td>the name of the user environment variable</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> Cypress chainable (void) - performs authentication flow, no return value</p>
+  </div>
+  <div class="card" id="fn-navigateToHref">
+    <h2><code>ky.navigateToHref()</code></h2>
+    <div class="description"><p>Navigate to href attribute of Harvard identity provider button</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>item</code></td>
+        <td>No</td>
+        <td>the CSS selector of interest</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> Cypress chainable containing the full URL string (hostname + href attribute value)</p>
+  </div>
+  <div class="card" id="fn-padWithZeros">
+    <h2><code>ky.padWithZeros()</code></h2>
+    <div class="description"><p>Pads a number with leading zeros to a user-defined length.</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>opts</code></td>
+        <td>No</td>
+        <td>options object</td>
+      </tr>
+      <tr>
+        <td><code>opts.length</code></td>
+        <td>No</td>
+        <td>the desired total length of the output string, must be larger than the length of the number</td>
+      </tr>
+      <tr>
+        <td><code>opts.number</code></td>
+        <td>No</td>
+        <td>the number to be padded with leading zeros</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> padded string with leading zeros</p>
+  </div>
+  <div class="card" id="fn-runScript">
+    <h2><code>ky.runScript()</code></h2>
+    <div class="description"><p>Run a script on the page</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>script</code></td>
+        <td>No</td>
+        <td>the script to run</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> Cypress chainable containing the return value from executing the script</p>
+  </div>
+  <div class="card" id="fn-tap">
+    <h2><code>ky.tap()</code></h2>
+    <div class="description"><p>Click on an element.</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>item</code></td>
+        <td>No</td>
+        <td>the CSS selector of interest</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> Cypress chainable containing the clicked element</p>
+  </div>
+  <div class="card" id="fn-tapInIFrame">
+    <h2><code>ky.tapInIFrame()</code></h2>
+    <div class="description"><p>Given an iframe, begins controlling it.</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>iframeSelector</code></td>
+        <td>No</td>
+        <td>- The selector for the iframe to control</td>
+      </tr>
+      <tr>
+        <td><code>selectorToTap</code></td>
+        <td>No</td>
+        <td>- The selector for the element inside the iframe to tap</td>
+      </tr>
+          </tbody>
+        </table>
+  </div>
+  <div class="card" id="fn-typeInto">
+    <h2><code>ky.typeInto()</code></h2>
+    <div class="description"><p>Type text into an element. This function first removes the previous text in the element</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>opts</code></td>
+        <td>No</td>
+        <td>object containing all arguments</td>
+      </tr>
+      <tr>
+        <td><code>opts.item</code></td>
+        <td>No</td>
+        <td>the CSS selector of interest</td>
+      </tr>
+      <tr>
+        <td><code>opts.text</code></td>
+        <td>No</td>
+        <td>the text to type</td>
+      </tr>
+      <tr>
+        <td><code>opts.pressEnter</code></td>
+        <td>Yes</td>
+        <td>if true, after typing into the text field, simulate pressing enter</td>
+      </tr>
+      <tr>
+        <td><code>opts.append</code></td>
+        <td>Yes</td>
+        <td>if true, append the text to the end of the existing text in the element instead of replacing it</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> Cypress chainable containing the input element that text was typed into</p>
+  </div>
+  <div class="card" id="fn-uniquify">
+    <h2><code>ky.uniquify()</code></h2>
+    <div class="description"><p>Makes a string unique by appending a timestamp and a counter.</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>text</code></td>
+        <td>No</td>
+        <td>the original string</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> the uniquified string</p>
+  </div>
+  <div class="card" id="fn-visitCanvasEndpoint">
+    <h2><code>ky.visitCanvasEndpoint()</code></h2>
+    <div class="description"><p>Send a request to a Canvas API endpoint.</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>opts</code></td>
+        <td>No</td>
+        <td>options object</td>
+      </tr>
+      <tr>
+        <td><code>opts.method</code></td>
+        <td>No</td>
+        <td>the HTTP method (e.g., 'GET', 'POST', 'DELETE')</td>
+      </tr>
+      <tr>
+        <td><code>opts.path</code></td>
+        <td>No</td>
+        <td>the API endpoint path excluding 'https://canvas.harvard.edu', (e.g., '/api/v1/courses/123')</td>
+      </tr>
+      <tr>
+        <td><code>opts.accessToken</code></td>
+        <td>No</td>
+        <td>the access token for authentication</td>
+      </tr>
+      <tr>
+        <td><code>opts.params</code></td>
+        <td>No</td>
+        <td>the request params (if any)</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> Cypress chainable containing the Canvas API response body</p>
+  </div>
+  <div class="card" id="fn-waitForAtLeastOneElementPresent">
+    <h2><code>ky.waitForAtLeastOneElementPresent()</code></h2>
+    <div class="description"><p>Wait for any element in a list to be present (check every tenth
+of a second for status)</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>opts</code></td>
+        <td>No</td>
+        <td>object containing all arguments</td>
+      </tr>
+      <tr>
+        <td><code>opts.items</code></td>
+        <td>No</td>
+        <td>list of CSS selectors of interest</td>
+      </tr>
+      <tr>
+        <td><code>opts.timeoutSec</code></td>
+        <td>Yes</td>
+        <td>the number of seconds to wait before</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> the selector of the item that was found first, ties</p>
+  </div>
+  <div class="card" id="fn-waitForElementVisible">
+    <h2><code>ky.waitForElementVisible()</code></h2>
+    <div class="description"><p>Wait for an element to be visible</p>
+</div>
+    <table class="params">
+          <thead><tr><th>Parameter</th><th>Optional</th><th>Description</th></tr></thead>
+          <tbody>
+      <tr>
+        <td><code>item</code></td>
+        <td>No</td>
+        <td>the CSS selector of interest</td>
+      </tr>
+      <tr>
+        <td><code>timeoutSec</code></td>
+        <td>Yes</td>
+        <td>=10] the number of seconds to wait before timing out</td>
+      </tr>
+          </tbody>
+        </table>
+    <p class="returns"><span class="label">Returns:</span> Cypress chainable containing the visible element</p>
+  </div>
+  </div>
+</body>
+</html>