Merge pull request #11 from hammzj/dev/update-base-types

Dev/update base types

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hammzj/cypress-page-object",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "A set of template classes and guides to help with developing component and page objects in Cypress.",
   "author": "Zachary Hamm <[email protected]>",
   "license": "MIT",
@@ -38,6 +38,7 @@
     "test:cypress:run:e2e": "cypress run --e2e  --browser electron"
   },
   "dependencies": {
+    "@types/node": "^20.12.7",
     "lodash": "^4.17.21"
   },
   "devDependencies": {

src/element.collection.ts

@@ -8,10 +8,10 @@ export default abstract class ElementCollection {
     protected _baseContainerFn: BaseContainerFunction;
     protected _scopedIndex?: number;
     protected metadata: Partial<IMetadata>;
-    public elements: Elements = {
+    protected elements: Elements = {
         container: () => this.container(),
     };
-    public components?: NestedComponents = {};
+    protected components?: NestedComponents = {};
 
     /**
      * @param baseContainerFn {function} The base container function returns the container of the element.

src/page.object.ts

@@ -23,7 +23,7 @@ class InsufficientPathVariablesError extends Error {
  */
 export default class PageObject extends ElementCollection {
     static #PATH_REPLACEMENT_REGEX = /(?<pathVariable>:\w+)/g;
-    protected metadata: IPageMetadata;
+    public metadata: IPageMetadata;
 
     /**
      * @example new PageObject(); //Index page
@@ -85,8 +85,8 @@ export default class PageObject extends ElementCollection {
         return pathInputs ? this.#customPathUrl(...pathInputs) : this.#urlObject().toString();
     }
 
-    visit(...pathInputs: string[]): void {
-        cy.visit(this.url(...pathInputs));
+    visit(pathInputs: string[], opts?: Partial<Cypress.VisitOptions>): void {
+        cy.visit(this.url(...pathInputs), opts);
     }
 
     assertIsOnPage(...pathInputs: string[]): void {

src/types/element.collection.ts

@@ -1,9 +1,11 @@
 import ElementCollection from "../element.collection";
 
-export type BaseContainerFunction = () => Cypress.Chainable<Cypress.JQueryWithSelector>;
+export type ElementSelectorFunction = (...params: any) => Cypress.Chainable<Cypress.JQueryWithSelector>;
+
+export type BaseContainerFunction = ElementSelectorFunction;
 
 export type Elements = {
-    [key: string]: (...params: any) => Cypress.Chainable<Cypress.JQueryWithSelector>;
+    [key: string]: ElementSelectorFunction;
 };
 
 export type ComponentObjectFunction = (instance: ElementCollection | any) => void;