@jahia/cypress 7.4.0 → 8.1.0

package/dist/utils/SAMHelper.js

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.waitUntilSAMStatusGreen = exports.waitUntilSAMStatus = exports.healthCheck = void 0;
 /**
  * Simple health check query
@@ -42,7 +42,7 @@ var waitUntilSAMStatus = function (_a) {
     var statusCount = 0;
     var lastGraphqlResponse = {};
     cy.waitUntil(function () {
-        return exports.healthCheck(severity, probeHealthFilter, probeNamesFilter).then(function (result) {
+        return (0, exports.healthCheck)(severity, probeHealthFilter, probeNamesFilter).then(function (result) {
             lastGraphqlResponse = result;
             var healthStatus = result === null || result === void 0 ? void 0 : result.status;
             if (healthStatus) {
@@ -52,7 +52,7 @@ var waitUntilSAMStatus = function (_a) {
         });
     }, {
         errorMsg: function () {
-            return "Timeout waiting for SAM to be " + expectedHealth + " for severity: " + severity + " and probeHealthFilter: " + probeHealthFilter + ". Last GraphQL response: " + JSON.stringify(lastGraphqlResponse);
+            return "Timeout waiting for SAM to be ".concat(expectedHealth, " for severity: ").concat(severity, " and probeHealthFilter: ").concat(probeHealthFilter, ". Last GraphQL response: ").concat(JSON.stringify(lastGraphqlResponse));
         },
         timeout: timeout,
         verbose: true,
@@ -76,6 +76,6 @@ var waitUntilSAMStatusGreen = function (severity, timeout, interval, greenMatchC
     if (interval === void 0) { interval = 500; }
     if (greenMatchCount === void 0) { greenMatchCount = 10; }
     // We use YELLOW as the probeHealthFilter because we are not interested in potential GREEN probes in the response
-    exports.waitUntilSAMStatus({ expectedHealth: 'GREEN', severity: severity, probeHealthFilter: 'YELLOW', timeout: timeout, interval: interval, statusMatchCount: greenMatchCount });
+    (0, exports.waitUntilSAMStatus)({ expectedHealth: 'GREEN', severity: severity, probeHealthFilter: 'YELLOW', timeout: timeout, interval: interval, statusMatchCount: greenMatchCount });
 };
 exports.waitUntilSAMStatusGreen = waitUntilSAMStatusGreen;

package/dist/utils/SiteHelper.js

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.editSite = exports.disableModule = exports.enableModule = exports.deleteSite = exports.createSite = void 0;
 // eslint-disable-next-line default-param-last
 var createSite = function (siteKey, config, jahiaServer) {
@@ -32,7 +32,7 @@ exports.enableModule = enableModule;
 var disableModule = function (moduleName, siteKey) {
     cy.apollo({
         mutationFile: 'graphql/jcr/mutation/disableModule.graphql',
-        variables: { moduleName: moduleName, pathOrId: "/sites/" + siteKey }
+        variables: { moduleName: moduleName, pathOrId: "/sites/".concat(siteKey) }
     });
 };
 exports.disableModule = disableModule;

package/dist/utils/UsersHelper.js

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.addUserToGroup = exports.deleteGroup = exports.createGroup = exports.deleteUser = exports.getUserPath = exports.createUser = exports.revokeRoles = exports.grantRoles = void 0;
 var grantRoles = function (pathOrId, roleNames, principalName, principalType) {
     cy.log('Grant role(s) ' + roleNames + ' with principal type ' + principalType + ' to ' + principalName + ' on node ' + pathOrId);
@@ -79,7 +79,7 @@ var addUserToGroup = function (userName, groupName, siteKey) {
     cy.executeGroovy('groovy/admin/addUserToGroup.groovy', {
         USER_NAME: userName,
         GROUP_NAME: groupName,
-        SITE_KEY: siteKey ? "\"" + siteKey + "\"" : 'null'
+        SITE_KEY: siteKey ? "\"".concat(siteKey, "\"") : 'null'
     });
 };
 exports.addUserToGroup = addUserToGroup;

package/dist/utils/VanityUrlHelper.js

@@ -1,5 +1,5 @@
 "use strict";
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.removeVanityUrl = exports.getVanityUrl = exports.addVanityUrl = void 0;
 var addVanityUrl = function (pathOrId, language, url) {
     return cy.apollo({

package/dist/utils/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -9,7 +13,7 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./JCRHelper"), exports);
 __exportStar(require("./PublicationAndWorkflowHelper"), exports);
 __exportStar(require("./SiteHelper"), exports);

package/docs/browser-helper.md

@@ -0,0 +1,158 @@
+# Browser Helpers
+
+## Overview
+
+The Browser Helpers module provides exported helper functions for debugging and managing browser storage (`cookies`, `localStorage`, `sessionStorage`) in Cypress tests.
+
+Warning: These helpers log full storage/cookie values by design. Use carefully in automated runs to avoid leaking tokens, credentials, or session identifiers in logs.
+
+## Import and Usage Model
+
+```typescript
+import {BrowserHelper} from '@jahia/cypress';
+
+it('inspects browser state', () => {
+  cy.login();
+  BrowserHelper.logCookies();
+  BrowserHelper.logLocalStorage();
+});
+```
+
+## Available Helpers
+
+### `BrowserHelper.logCookies()`
+
+Logs all available cookies with metadata and values.
+
+- Returns: `Cypress.Chainable<void>`
+- Typical use: inspect authentication and security cookie attributes during debugging
+
+### `BrowserHelper.logCookie(cookieName)`
+
+Logs one cookie by name in a detailed format.
+
+- Parameters: `cookieName: string`
+- Returns: `Cypress.Chainable<void>`
+
+### `BrowserHelper.clearSessionCookies()`
+
+Clears only session cookies.
+
+- Returns: `Cypress.Chainable<void>`
+
+### `BrowserHelper.clearPersistentCookies()`
+
+Clears only persistent cookies.
+
+- Returns: `Cypress.Chainable<void>`
+
+### `BrowserHelper.simulateClose()`
+
+Simulates a browser close by clearing `sessionStorage` and session cookies only.
+
+- Returns: `void`
+- Clears: session cookies + all `sessionStorage`
+- Keeps: persistent cookies + `localStorage`
+
+### `BrowserHelper.resetState()`
+
+Resets browser client-side state by clearing all cookies and all storages.
+
+- Returns: `void`
+- Clears: all cookies + all `localStorage` + all `sessionStorage`
+
+### `BrowserHelper.logSessionStorage()`
+
+Logs all `sessionStorage` entries grouped by origin.
+
+- Returns: `Cypress.Chainable<void>`
+
+### `BrowserHelper.logLocalStorage()`
+
+Logs all `localStorage` entries grouped by origin.
+
+- Returns: `Cypress.Chainable<void>`
+
+## Integration Examples
+
+### Authentication Debugging
+
+```typescript
+import {BrowserHelper} from '@jahia/cypress';
+
+describe('Authentication Flow', () => {
+  it('keeps session after reload', () => {
+    cy.step('Login', () => {
+      cy.login('testuser@example.com', 'password');
+      BrowserHelper.logCookie('JSESSIONID');
+      cy.get('[data-testid="dashboard"]').should('be.visible');
+    });
+
+    cy.step('Reload page', () => {
+      cy.reload();
+      BrowserHelper.logCookie('JSESSIONID');
+      cy.get('[data-testid="dashboard"]').should('be.visible');
+    });
+  });
+});
+```
+
+### Simulate Browser Close
+
+```typescript
+import {BrowserHelper} from '@jahia/cypress';
+
+it('validates behavior after browser close', () => {
+  cy.login();
+  BrowserHelper.logCookies();
+
+  // Simulate browser close (clears session cookies and session storage)
+  BrowserHelper.simulateClose();
+
+  // Visit the app again to see the effect of reset
+  cy.visit(url);
+
+  BrowserHelper.logCookies();
+  BrowserHelper.logSessionStorage();
+});
+```
+
+### Simulate Browser Reset (clear all cookies and storages)
+
+```typescript
+import {BrowserHelper} from '@jahia/cypress';
+
+it('validates behavior after full browser reset', () => {
+    cy.login();
+    BrowserHelper.logCookies();
+
+    // Reset all browser state
+    BrowserHelper.resetState();
+
+    // Visit the app again to see the effect of reset
+    cy.visit(url); 
+
+    BrowserHelper.logCookies();
+    BrowserHelper.logSessionStorage();
+});
+```
+
+## Best Practices
+
+1. Use these helpers for interactive debugging, not as regular test assertions.
+2. Avoid running full storage/cookie logging in CI unless required.
+3. Prefer targeted checks (`logCookie`) over full dumps (`logCookies`) for sensitive environments.
+4. Use `resetState()` for hard test isolation, and `simulateClose()` for realistic session lifecycle checks.
+
+## API Reference
+
+| Helper | Parameters | Returns | Description |
+|--------|------------|---------|-------------|
+| `BrowserHelper.logCookies()` | - | `Cypress.Chainable<void>` | Logs all cookies with full metadata |
+| `BrowserHelper.logCookie(cookieName)` | `string` | `Cypress.Chainable<void>` | Logs one cookie by name |
+| `BrowserHelper.clearSessionCookies()` | - | `Cypress.Chainable<void>` | Clears session cookies only |
+| `BrowserHelper.clearPersistentCookies()` | - | `Cypress.Chainable<void>` | Clears persistent cookies only |
+| `BrowserHelper.simulateClose()` | - | `void` | Clears session storage and session cookies |
+| `BrowserHelper.resetState()` | - | `void` | Clears all storages and all cookies |
+| `BrowserHelper.logSessionStorage()` | - | `Cypress.Chainable<void>` | Logs all session storage data |
+| `BrowserHelper.logLocalStorage()` | - | `Cypress.Chainable<void>` | Logs all local storage data |