chore: fix cypress typings (#1401)

v3/cypress/cypress.d.ts

@@ -0,0 +1,21 @@
+export {}
+
+declare global {
+  namespace Cypress {
+    interface Cypress {
+      // added to Cypress config via cypress.*.json configuration files
+      config(key: "index"): string
+    }
+    interface Chainable {
+      /**
+       * Custom commands defined in commands.ts
+       */
+      clickMenuItem(item: string): void
+      clickToUnselect(subject: Array<{ x: number, y: number }>, options?: { delay: number }): void
+      checkDragAttributeHighlights(source: string, attribute: string, target: string, exists?: boolean): void
+      dragAttributeToTarget(source: string, attribute: string, target: string, targetNumber?: number): void
+      mouseMoveBy(subject: JQuery<HTMLElement>, targetRect: DOMRect, options?: { delay: number }): void
+      pointerMoveBy(subject: JQuery<HTMLElement>, targetRect: DOMRect, options?: { delay: number }): void
+    }
+  }
+}

v3/cypress/e2e/adornments.spec.ts

@@ -392,6 +392,7 @@ context("Graph adornments", () => {
       // The exact value of left may vary slightly depending on browser, screen resolution, etc.
       // The below checks that the value is within an expected range to accommodate these variations.
       // Modeled after https://github.com/cypress-io/cypress/issues/14722#issuecomment-767367519
+      // @ts-expect-error -- type definition is incorrect: return value is property value not chained element
       .should("have.css", "left").should((left: string) => {
         expect(left).to.include("px")
         expect(parseInt(left, 10)).to.be.within(271, 273)

v3/cypress/e2e/calculator.spec.ts

@@ -37,7 +37,7 @@ context("Calculator", () => {
     c.changeComponentTitle("calculator", newCalculatorName)
     c.getComponentTitle("calculator").should("have.text", newCalculatorName)
 
-    c.getIconFromToolshelf("calc").click()
+    c.getIconFromToolShelf("calc").click()
     c.checkComponentDoesNotExist("calculator")
 
     cy.log("Check undo/redo of close and open calculator component")
@@ -50,7 +50,7 @@ context("Calculator", () => {
     toolbar.getRedoTool().click()
     c.checkComponentDoesNotExist("calculator")
 
-    c.getIconFromToolshelf("calc").click()
+    c.getIconFromToolShelf("calc").click()
     c.checkComponentExists("calculator")
     c.getComponentTitle("calculator").should("contain", newCalculatorName)
   })
@@ -71,7 +71,7 @@ context("Calculator", () => {
     toolbar.getRedoTool().click()
     c.checkComponentDoesNotExist("calculator")
 
-    c.getIconFromToolshelf("calc").click()
+    c.getIconFromToolShelf("calc").click()
     c.checkComponentExists("calculator")
     c.getComponentTitle("calculator").should("contain", newCalculatorName)
   })

v3/cypress/e2e/formula/formula-component.spec.ts

@@ -12,7 +12,7 @@ context("Formula Engine", () => {
       fh.editFormula("Formula", "a+2")
       fh.verifyValues("Formula", [3, 4, 5, 5, 2])
     })
-    it("Add and edit formula for an existng attribute", () => {
+    it("Add and edit formula for an existing attribute", () => {
       fh.visitURL("?sample=four&dashboard")
       fh.addFormula("b", "count(a)")
       fh.verifyValues("b", [4, 4, 4, 4, 4])

v3/cypress/e2e/graph.spec.ts

@@ -26,7 +26,7 @@ context.skip("Test graph plot transitions", () => {
 
   plots.forEach(test => {
     it.skip(`${test.testName}`, () => {
-      c.getIconFromToolshelf("graph").click()
+      c.getIconFromToolShelf("graph").click()
       c.moveComponent("graph", 1000)
       test.axes.forEach(hash => {
         hash.checks.forEach(check => {
@@ -70,7 +70,7 @@ context("Graph UI", () => {
         cy.log(`Initial CODAP Graph Count: ${initialCount}`)
 
         // perform an action that gets a new graph
-        c.getIconFromToolshelf("graph").click()
+        c.getIconFromToolShelf("graph").click()
         // cy.wait(1000)
         c.getComponentTitle("graph").should("contain", collectionName)
         c.getComponentTitle("graph", 1).should("contain", collectionName)
@@ -90,12 +90,12 @@ context("Graph UI", () => {
     it("creates graphs with new collection names when existing ones are closed", () => {
       c.closeComponent("graph")
       c.checkComponentDoesNotExist("graph")
-      c.getIconFromToolshelf("graph").click()
+      c.getIconFromToolShelf("graph").click()
       c.getComponentTitle("graph").should("contain", collectionName)
 
       c.closeComponent("graph")
       c.checkComponentDoesNotExist("graph")
-      c.getIconFromToolshelf("graph").click()
+      c.getIconFromToolShelf("graph").click()
       c.getComponentTitle("graph").should("contain", collectionName)
     })
     it("checks all graph tooltips", () => {
@@ -277,7 +277,7 @@ context("Graph UI", () => {
       cy.get("[data-testid=parent-toggles-last]").click()
       cy.wait(250)
       cy.get("[data-testid=parent-toggles-last]").should("have.text", "☒ Last")
-      cy.get("[data-testid=parent-toggles-case-buttons-list]").find("button").then((buttons: HTMLButtonElement[]) => {
+      cy.get("[data-testid=parent-toggles-case-buttons-list]").find("button").then((buttons) => {
         const lastButtonIndex = buttons.length - 1
         buttons.each((i: number, button: HTMLButtonElement) => {
           if (i !== lastButtonIndex) {
@@ -533,12 +533,12 @@ context("Graph UI", () => {
           .trigger("mouseup", { force: true, view: win })
       })
       graph.getDisplayConfigButton().click()
-      cy.get("[data-testid=graph-bin-width-setting]").find("input").invoke("val").then((valueStr: string) => {
-        const valueNum = parseFloat(valueStr)
+      cy.get("[data-testid=graph-bin-width-setting]").find("input").invoke("val").then((value) => {
+        const valueNum = parseFloat(value as string)
         expect(valueNum).to.be.closeTo(2.75, 0.25)
       })
-      cy.get("[data-testid=graph-bin-alignment-setting]").find("input").invoke("val").then((valueStr: string) => {
-        const valueNum = parseFloat(valueStr)
+      cy.get("[data-testid=graph-bin-alignment-setting]").find("input").invoke("val").then((value) => {
+        const valueNum = parseFloat(value as string)
         expect(valueNum).to.be.closeTo(4, 0.1)
       })
     })

v3/cypress/e2e/hierarchical-table.spec.ts

@@ -1,5 +1,7 @@
 import { TableTileElements as table } from "../support/elements/table-tile"
 import hierarchical from '../fixtures/hierarchical.json'
+type HierarchicalTest = typeof hierarchical.tests[number] & { only?: boolean }
+
 const values = hierarchical.attributes
 
 context("hierarchical collections", () => {
@@ -11,7 +13,7 @@ context("hierarchical collections", () => {
     cy.wait(2500)
     cy.log('Setup complete')
   })
-  hierarchical.tests.forEach((h) => {
+  hierarchical.tests.forEach((h: HierarchicalTest) => {
     // FIXME: enable skipped tests
     const itOrSkip = h.skip ? it.skip : h.only ? it.only : it
     itOrSkip(`${h.testName}`, () => {

v3/cypress/e2e/map.spec.ts

@@ -28,20 +28,20 @@ context("Map UI", () => {
     cy.log("updates map title")
 
     cfm.openLocalDoc(filename1)
-    c.getIconFromToolshelf("map").click()
+    c.getIconFromToolShelf("map").click()
     c.getComponentTitle("map").should("have.text", componentName)
     c.changeComponentTitle("map", newComponentName)
     c.getComponentTitle("map").should("have.text", newComponentName)
 
     cy.log("creates maps with new component name")
-    c.getIconFromToolshelf("map").click()
+    c.getIconFromToolShelf("map").click()
 
     c.getComponentTitle("map").should("contain", componentName)
     c.getComponentTitle("map", 1).should("contain", componentName)
   })
   it("checks all map tooltips", () => {
     cfm.openLocalDoc(filename1)
-    c.getIconFromToolshelf("map").click()
+    c.getIconFromToolShelf("map").click()
     c.selectTile("map", 0)
 
     toolbar.getToolShelfIcon("map").then($element => {
@@ -78,7 +78,7 @@ context("Map UI", () => {
   // flaky test skipped in PR #1239, see PT #187534790
   it.skip("checks numerical and categorical attributes for map legend", () => {
     cfm.openLocalDoc(filename2)
-    c.getIconFromToolshelf("map").click()
+    c.getIconFromToolShelf("map").click()
     cy.dragAttributeToTarget("attribute", arrayOfAttributes[0], "map")
 
     mlh.verifyLegendLabel(arrayOfAttributes[0])
@@ -117,7 +117,7 @@ context("Map UI", () => {
   })
   it("checks show/hide selected/unselected/all map boundaries", () => {
     cfm.openLocalDoc(filename2)
-    c.getIconFromToolshelf("map").click()
+    c.getIconFromToolShelf("map").click()
     c.selectTile("map", 0)
 
     map.selectHideShowButton()
@@ -142,7 +142,7 @@ context("Map UI", () => {
   })
   it("checks show/hide selected/unselected/all map points", () => {
     cfm.openLocalDoc(filename1)
-    c.getIconFromToolshelf("map").click()
+    c.getIconFromToolShelf("map").click()
     c.selectTile("map", 0)
 
     map.selectHideShowButton()
@@ -168,7 +168,7 @@ context("Map UI", () => {
   // flaky test skipped in PR #1239, see PT #187534790
   it.skip("checks show/hide map boundaries with legend selections", () => {
     cfm.openLocalDoc(filename2)
-    c.getIconFromToolshelf("map").click()
+    c.getIconFromToolShelf("map").click()
     cy.dragAttributeToTarget("attribute", arrayOfAttributes[0], "map")
 
     mlh.verifyCategoricalLegend(arrayOfValues[0].values.length)
@@ -209,7 +209,7 @@ context("Map UI", () => {
   // flaky test skipped in PR #1239, see PT #187534790
   it.skip("checks show/hide map points with legend selections", () => {
     cfm.openLocalDoc(filename1)
-    c.getIconFromToolshelf("map").click()
+    c.getIconFromToolShelf("map").click()
     cy.wait(1000)
     cy.dragAttributeToTarget("attribute", arrayOfAttributes[2], "map")
 
@@ -251,7 +251,7 @@ context("Map UI", () => {
   // flaky test skipped in PR #1239, see PT #187534790
   it.skip("checks legend attribute menu", () => {
     cfm.openLocalDoc(filename2)
-    c.getIconFromToolshelf("map").click()
+    c.getIconFromToolShelf("map").click()
     cy.dragAttributeToTarget("attribute", arrayOfAttributes[0], "map")
 
     mlh.verifyLegendLabel(arrayOfAttributes[0])
@@ -280,7 +280,7 @@ context("Map UI", () => {
 
   it("shows connecting lines when Connecting Lines option is checked", () => {
     cfm.openLocalDoc(filename1)
-    c.getIconFromToolshelf("map").click()
+    c.getIconFromToolShelf("map").click()
     c.selectTile("map", 0)
     cy.wait(2000)
     cy.get("[data-testid=connecting-lines-map-1").find("path").should("have.length", 0)

v3/cypress/e2e/plugin.spec.ts

@@ -165,12 +165,12 @@ context("codap plugins", () => {
     webView.toggleAPITesterFilter()
 
     cy.log("Broadcast dataContextCountChanged notifications when dataset is added to document")
-    table.createNewTableFromToolshelf()
+    table.createNewTableFromToolShelf()
     webView.confirmAPITesterResponseContains(/"operation":\s"dataContextCountChanged/)
     webView.clearAPITesterResponses()
 
     cy.log("Broadcast dataContextDeleted notifications when dataset is deleted")
-    table.deleteDataSetFromToolshelf(1)
+    table.deleteDataSetFromToolShelf(1)
     webView.confirmAPITesterResponseContains(/"operation":\s"dataContextDeleted/)
     webView.confirmAPITesterResponseContains(/"deletedContext":\s"New\sDataset/)
     webView.clearAPITesterResponses()
@@ -273,7 +273,7 @@ context("codap plugins", () => {
     cy.log("Broadcast notifications involving dragging")
     const url = `${Cypress.config("index")}?mouseSensor`
     cy.visit(url)
-    table.createNewTableFromToolshelf()
+    table.createNewTableFromToolShelf()
     table.addNewAttribute()
     table.addNewAttribute()
     openAPITester()

v3/cypress/e2e/slider.spec.ts

@@ -151,7 +151,7 @@ context("Slider UI", () => {
     slider.checkPlayButtonIsPaused()
   })
   it("creates another slider from toolshelf", () => {
-    c.getIconFromToolshelf("slider").click()
+    c.getIconFromToolShelf("slider").click()
 
     c.getComponentTitle("slider").should("contain", sliderName)
     slider.getVariableName().should("have.text", sliderName)
@@ -165,7 +165,7 @@ context("Slider UI", () => {
   })
   it("checks editing variable name in one slider only affects that slider", () => {
     const newSliderName = "xyz"
-    c.getIconFromToolshelf("slider").click()
+    c.getIconFromToolShelf("slider").click()
 
     slider.changeVariableName(newSliderName, 1)
     c.getComponentTitle("slider", 0).should("contain", sliderName)
@@ -175,14 +175,14 @@ context("Slider UI", () => {
   })
   it("checks editing variable value in one slider only affects that slider", () => {
     const newVariableValue = "100"
-    c.getIconFromToolshelf("slider").click()
+    c.getIconFromToolShelf("slider").click()
 
     slider.changeVariableValue(newVariableValue, 1)
     slider.getVariableValue(0).should("contain", initialSliderValue)
     slider.getVariableValue(1).should("contain", newVariableValue)
   })
   it("checks playing in one slider only plays that slider", () => {
-    c.getIconFromToolshelf("slider").click()
+    c.getIconFromToolShelf("slider").click()
     slider.setAnimationRate(3, 1)
 
     slider.checkPlayButtonIsPaused(0)
@@ -205,7 +205,7 @@ context("Slider UI", () => {
     slider.checkPlayButtonIsPaused(1)
   })
   it("creates sliders with incrementing names", () => {
-    c.getIconFromToolshelf("slider").click()
+    c.getIconFromToolShelf("slider").click()
 
     c.getComponentTitle("slider").should("contain", sliderName)
     slider.getVariableName().should("have.text", sliderName)
@@ -217,7 +217,7 @@ context("Slider UI", () => {
     slider.getVariableValue(1).should("contain", initialSliderValue)
     slider.checkPlayButtonIsPaused(1)
 
-    c.getIconFromToolshelf("slider").click()
+    c.getIconFromToolShelf("slider").click()
     c.getComponentTitle("slider", 2).should("contain", "v3")
     slider.getVariableName(2).should("have.text", "v3")
     slider.getVariableValue(2).should("contain", initialSliderValue)
@@ -226,7 +226,7 @@ context("Slider UI", () => {
   it("reuses slider names after existing ones are closed", () => {
     c.closeComponent("slider")
     c.checkComponentDoesNotExist("slider")
-    c.getIconFromToolshelf("slider").click()
+    c.getIconFromToolShelf("slider").click()
 
     c.getComponentTitle("slider").should("contain", "v1")
     slider.getVariableName().should("have.text", "v1")
@@ -235,7 +235,7 @@ context("Slider UI", () => {
 
     c.closeComponent("slider")
     c.checkComponentDoesNotExist("slider")
-    c.getIconFromToolshelf("slider").click()
+    c.getIconFromToolShelf("slider").click()
 
     c.getComponentTitle("slider").should("contain", "v1")
     slider.getVariableName().should("have.text", "v1")