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

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.6",
   "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/setup/checkRequiredFiles/index.ts

@@ -26,6 +26,7 @@ const checkRequiredFiles = (): void => {
 
   // Determine profile file name (default is stage)
   const profileName = process.env.CYPRESS_PROFILE || 'Stage';
+  const defaultProfileName = 'Default';
   const requiredProfile = `${profileName}.Profile.ts`;
 
   // Check global files
@@ -44,6 +45,12 @@ const checkRequiredFiles = (): void => {
   if (!profileFound) {
     genEmptyProfileFile(profileName);
   }
+  // Check default profile file
+  const defaultProfileFilePath = path.join(profilesPath, `${defaultProfileName}.Profile.ts`);
+  const defaultProfileFound = existsSync(defaultProfileFilePath);
+  if (!defaultProfileFound) {
+    genEmptyProfileFile(defaultProfileName);
+  }
 };
 
 export default checkRequiredFiles;

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;

package/src/commands/getAttribute.ts

@@ -0,0 +1,58 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Get the attribute of an element
+       * @author Allison Zhang
+       * @param opts options object
+       * @param opts.selector the CSS selector of the element
+       * @param opts.attribute the attribute to retrieve
+       * @returns the attribute of the element
+       */
+      getAttribute(
+        opts: {
+          selector: string,
+          attribute: string,
+        },
+      ): Chainable<string>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const getAttribute = () => {
+  Cypress.Commands.add('getAttribute', (
+    opts: {
+      selector: string,
+      attribute: string,
+    },
+  ) => {
+    const {
+      selector,
+      attribute,
+    } = opts;
+    return (
+      cy
+        .get(selector)
+        .invoke('attr', attribute)
+        .then((attr) => {
+          return attr;
+        })
+    );
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default getAttribute;

package/src/commands/getClassName.ts

@@ -0,0 +1,44 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Get the class attribute of an element
+       * @author Allison Zhang
+       * @param selector the CSS selector of the element
+       * @returns the class of the element, if multiple classes exist, they are space-separated
+       */
+      getClassName(
+        selector: string,
+      ): Chainable<string>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const getClassName = () => {
+  Cypress.Commands.add('getClassName', (selector: string) => {
+    return (
+      cy
+        .get(selector)
+        .invoke('attr', 'class')
+        .then((attr) => {
+          return attr;
+        })
+    );
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default getClassName;

package/src/commands/getCurrentDateInfo.ts

@@ -0,0 +1,57 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Get the current day
+       * @author Allison Zhang
+       * @returns the current month as a number (1-31)
+       */
+      getCurrentDateInfo(): Chainable<{
+        minute: number,
+        hour: number,
+        day: number,
+        month: number,
+        year: number,
+        dateString: string,
+      }>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const getCurrentDateInfo = () => {
+  Cypress.Commands.add('getCurrentDateInfo', () => {
+    const current = new Date();
+    const dateInfo: {
+      minute: number,
+      hour: number,
+      day: number,
+      month: number,
+      year: number,
+      dateString: string,
+    } = {
+      minute: current.getMinutes(),
+      hour: current.getHours(),
+      day: current.getDate(),
+      month: current.getMonth() + 1,
+      year: current.getFullYear(),
+      dateString: current.toDateString(),
+    };
+    return cy.wrap(dateInfo);
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default getCurrentDateInfo;

package/src/commands/getId.ts

@@ -0,0 +1,44 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Get the id of an element
+       * @author Allison Zhang
+       * @param selector the CSS selector of the element
+       * @returns the id of the element
+       */
+      getId(
+        selector: string,
+      ): Chainable<string>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const getId = () => {
+  Cypress.Commands.add('getId', (selector: string) => {
+    return (
+      cy
+        .get(selector)
+        .invoke('attr', 'id')
+        .then((attr) => {
+          return attr;
+        })
+    );
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default getId;

package/src/commands/getJSON.ts

@@ -12,7 +12,6 @@ declare global {
        * @author Allison Zhang
        * @param url the URL to fetch the JSON data from
        * @returns the JSON data
-       * @example cy.getJSON('https://api.example.com/data').then((data) => { ... })
        */
       getJSON(
         url: string,
@@ -31,9 +30,6 @@ const getJSON = () => {
       cy
         .request(url)
         .its('body')
-        .then((body) => {
-          return body;
-        })
     );
   });
 };

package/src/commands/getSpecialChars.ts

@@ -0,0 +1,34 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Generate all printable special characters for Cypress tests
+       * @author Allison Zhang
+       * @returns a string containing all special characters
+       */
+      getSpecialChars(): Chainable<string>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const getSpecialChars = () => {
+  Cypress.Commands.add('getSpecialChars', () => {
+    return cy.wrap('!"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~€‚ƒ„…†‡ˆ‰Š‹ŒŽ‘’“”•–—˜™š›œžŸ¡¢£¤¥¦§¨©ª«¬®¯°±²³´µ¶·¸¹º»¼½¾¿ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþÿ≤≥≠÷…£¢∞§¶•º');
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default getSpecialChars;

package/src/commands/getTitle.ts

@@ -0,0 +1,39 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Get the current title of the page
+       * @author Gardenia Liu
+       */
+      getTitle(): Chainable<string>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const getTitle = () => {
+  Cypress.Commands.add('getTitle', () => {
+    return (
+      cy
+        .title()
+        .then((title) => {
+          return title;
+        })
+    );
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default getTitle;

package/src/commands/index.ts

@@ -4,15 +4,27 @@ import assertHasClass from './assertHasClass';
 import assertNumElements from './assertNumElements';
 import extractDataFromClass from './extractDataFromClass';
 import extractDataFromClassByContents from './extractDataFromClassByContents';
+import genTextOfLength from './genTextOfLength';
+import getAttribute from './getAttribute';
+import getClassName from './getClassName';
+import getCurrentDateInfo from './getCurrentDateInfo';
+import getId from './getId';
 import getJSON from './getJSON';
 import getNumElements from './getNumElements';
+import getSpecialChars from './getSpecialChars';
+import getTitle from './getTitle';
 import handleHarvardKey from './handleHarvardKey';
 import launchAs from './launchAs';
 import launchLTIUsingToken from './launchLTIUsingToken';
+import listSelectLabels from './listSelectLabels';
+import listSelectValues from './listSelectValues';
 import navigateToHref from './navigateToHref';
+import padWithZeros from './padWithZeros';
 import runScript from './runScript';
 import typeInto from './typeInto';
-import visitCanvasGETEndpoint from './visitCanvasGETEndpoint';
+import uniquify from './uniquify';
+import visitCanvasEndpoint from './visitCanvasEndpoint';
+import waitForAtLeastOneElementPresent from './waitForAtLeastOneElementPresent';
 import waitForElementVisible from './waitForElementVisible';
 
 /**
@@ -24,18 +36,30 @@ const commands = () => {
   assertDoesNotHaveClass();
   assertHasClass();
   assertNumElements();
+  extractDataFromClass();
+  extractDataFromClassByContents();
+  genTextOfLength();
+  getAttribute();
+  getClassName();
+  getCurrentDateInfo();
+  getId();
+  getJSON();
   getNumElements();
+  getSpecialChars();
+  getTitle();
   handleHarvardKey();
   launchAs();
   launchLTIUsingToken();
+  listSelectLabels();
+  listSelectValues();
   navigateToHref();
+  padWithZeros();
   runScript();
   typeInto();
-  visitCanvasGETEndpoint();
+  uniquify();
+  visitCanvasEndpoint();
+  waitForAtLeastOneElementPresent();
   waitForElementVisible();
-  extractDataFromClass();
-  extractDataFromClassByContents();
-  getJSON();
 };
 
 export default commands;

package/src/commands/launchLTIUsingToken.ts

@@ -59,9 +59,13 @@ const launchLTIUsingToken = () => {
       cy.log(`Launch LTI app "${appName}" in course ${courseId} using access token`);
 
       // Get the external tools for the course
-      cy.visitCanvasGETEndpoint({
-        path: `/courses/${courseId}/external_tools`,
+      cy.visitCanvasEndpoint({
+        method: 'GET',
+        path: `/api/v1/courses/${courseId}/external_tools`,
         accessToken,
+        params: {
+          per_page: 200,
+        },
       }).then((externalTools: { [key: string]: any }[]) => {
         cy.log(`Found ${externalTools.length} external tools`);
 
@@ -93,9 +97,13 @@ const launchLTIUsingToken = () => {
         }
 
         // Get a sessionless launch URL
-        cy.visitCanvasGETEndpoint({
-          path: `/courses/${courseId}/external_tools/sessionless_launch?id=${toolId}`,
+        cy.visitCanvasEndpoint({
+          method: 'GET',
+          path: `/api/v1/courses/${courseId}/external_tools/sessionless_launch?id=${toolId}`,
           accessToken,
+          params: {
+            per_page: 200,
+          },
         }).then((sessionlessLaunchInfo) => {
           const launchURL = sessionlessLaunchInfo.url;
           cy.log(`Launching LTI app at: ${launchURL}`);