@jahia/cypress 2.0.0 → 3.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-2023 Jahia Forge - Code Repository
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,4 +1,10 @@
-# @jahia/cypress
+
+<a href="https://www.jahia.com/">
+    <img src="https://www.jahia.com/modules/jahiacom-templates/images/jahia-3x.png" alt="Jahia logo" title="Jahia" align="right" height="60" />
+</a>
+
+@jahia/cypress
+======================
 
 ## Commands
 
@@ -94,3 +100,6 @@ module.exports = (on, config) => {
     return config;
 };
 ```
+## Open-Source
+
+This is an Open-Source codebase, you can find more details about Open-Source @ Jahia [in this repository](https://github.com/Jahia/open-source)

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from './page-object';
 export * from './plugins';
 export * from './support';
+export * from './utils';

package/dist/index.js

@@ -13,3 +13,4 @@ exports.__esModule = true;
 __exportStar(require("./page-object"), exports);
 __exportStar(require("./plugins"), exports);
 __exportStar(require("./support"), exports);
+__exportStar(require("./utils"), exports);

package/dist/page-object/html/iframe.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="cypress" />
-import { BaseComponent } from "../baseComponent";
+import { BaseComponent } from '../baseComponent';
 import Chainable = Cypress.Chainable;
 export declare class IFrame extends BaseComponent {
     static defaultSelector: string;

package/dist/page-object/material/muiinput.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="cypress" />
-import { BaseComponent } from "../baseComponent";
+import { BaseComponent } from '../baseComponent';
 import TypeOptions = Cypress.TypeOptions;
 export declare class MUIInput extends BaseComponent {
     static defaultSelector: string;

package/dist/page-object/material/muiradio.d.ts

@@ -1,4 +1,4 @@
-import { BaseComponent } from "../baseComponent";
+import { BaseComponent } from '../baseComponent';
 export declare class MUIRadio extends BaseComponent {
     static defaultSelector: string;
     click(): MUIRadio;

package/dist/page-object/moonstone/accordion.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="cypress" />
-import { BaseComponent } from "../baseComponent";
+import { BaseComponent } from '../baseComponent';
 import Chainable = Cypress.Chainable;
 export declare class Accordion extends BaseComponent {
     static defaultSelector: string;

package/dist/page-object/moonstone/button.d.ts

@@ -1,4 +1,4 @@
-import { BaseComponent } from "../baseComponent";
+import { BaseComponent } from '../baseComponent';
 export declare class Button extends BaseComponent {
     static defaultSelector: string;
     click(): Button;

package/dist/page-object/moonstone/collapsible.d.ts

@@ -1,4 +1,4 @@
-import { BaseComponent } from "../baseComponent";
+import { BaseComponent } from '../baseComponent';
 export declare class Collapsible extends BaseComponent {
     static defaultSelector: string;
     collapse(): Collapsible;

package/dist/page-object/moonstone/dropdown.d.ts

@@ -1,4 +1,4 @@
-import { BaseComponent } from "../baseComponent";
+import { BaseComponent } from '../baseComponent';
 export declare class Dropdown extends BaseComponent {
     static defaultSelector: string;
     select(item: string): Dropdown;

package/dist/page-object/moonstone/menu.d.ts

@@ -1,4 +1,4 @@
-import { BaseComponent } from "../baseComponent";
+import { BaseComponent } from '../baseComponent';
 export declare class Menu extends BaseComponent {
     static defaultSelector: string;
     select(item: string): Menu;

package/dist/page-object/moonstone/menu.js

@@ -25,7 +25,7 @@ var Menu = /** @class */ (function (_super) {
     Menu.prototype.select = function (item) {
         // eslint-disable-next-line cypress/no-unnecessary-waiting
         cy.wait(500);
-        this.get().find(".moonstone-menuItem").should("contain", item).contains(item).trigger('click');
+        this.get().find('.moonstone-menuItem').should('contain', item).contains(item).trigger('click');
         return this;
     };
     Menu.prototype.selectByRole = function (item) {

package/dist/page-object/moonstone/pagination.d.ts

@@ -1,4 +1,4 @@
-import { BaseComponent } from "../baseComponent";
+import { BaseComponent } from '../baseComponent';
 import Chainable = Cypress.Chainable;
 export declare class Pagination extends BaseComponent {
     static defaultSelector: string;

package/dist/page-object/moonstone/primaryNav.d.ts

@@ -1,4 +1,4 @@
-import { BaseComponent } from "../baseComponent";
+import { BaseComponent } from '../baseComponent';
 import Chainable = Cypress.Chainable;
 export declare class PrimaryNav extends BaseComponent {
     static defaultSelector: string;

package/dist/page-object/moonstone/primaryNav.js

@@ -27,7 +27,7 @@ var PrimaryNav = /** @class */ (function (_super) {
     };
     PrimaryNav.prototype.listItems = function () {
         return this.get().find('.moonstone-primaryNavItem').then(function (items) {
-            return Array.prototype.slice.call(items, 0).map(function (i) { return i.attributes['role'] ? i.attributes['role'].value : null; }).filter(function (i) { return i !== null; });
+            return Array.prototype.slice.call(items, 0).map(function (i) { return i.attributes.role ? i.attributes.role.value : null; }).filter(function (i) { return i !== null; });
         });
     };
     PrimaryNav.defaultSelector = '.moonstone-primaryNav';

package/dist/page-object/moonstone/secondaryNav.d.ts

@@ -1,4 +1,4 @@
-import { BaseComponent } from "../baseComponent";
+import { BaseComponent } from '../baseComponent';
 export declare class SecondaryNav extends BaseComponent {
     static defaultSelector: string;
 }

package/dist/page-object/moonstone/table.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="cypress" />
-import { BaseComponent } from "../baseComponent";
-import { Menu } from "./menu";
+import { BaseComponent } from '../baseComponent';
+import { Menu } from './menu';
 export declare class Table extends BaseComponent {
     static defaultSelector: string;
     getRows(assertion?: (s: JQuery) => void): TableRow;

package/dist/page-object/utils.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="cypress" />
-import { Table } from "./moonstone";
-import { BaseComponent, ComponentType } from "./baseComponent";
+import { Table } from './moonstone';
+import { BaseComponent, ComponentType } from './baseComponent';
 import Chainable = Cypress.Chainable;
 export declare function getElement(selector: string, parent?: BaseComponent, assertion?: (s: JQuery) => void): Chainable<JQuery>;
 export declare function getComponentBySelector<Component>(C: ComponentType<Component>, selector: string, parent?: BaseComponent, assertion?: (s: JQuery) => void): Component;

package/dist/support/apollo/apollo.js

@@ -43,53 +43,51 @@ var apollo = function (apollo, options) {
     }
     var result;
     var logger;
-    var optionsWithDefaultCache = __assign({ fetchPolicy: "no-cache" }, options);
+    var optionsWithDefaultCache = __assign({ fetchPolicy: 'no-cache' }, options);
     if (!apollo) {
         cy.apolloClient().apollo(optionsWithDefaultCache);
     }
+    else if (isQueryFile(optionsWithDefaultCache)) {
+        var queryFile = optionsWithDefaultCache.queryFile, apolloOptions_1 = __rest(optionsWithDefaultCache, ["queryFile"]);
+        cy.fixture(queryFile).then(function (content) {
+            cy.apollo(__assign({ query: graphql_tag_1["default"](content) }, apolloOptions_1));
+        });
+    }
+    else if (isMutationFile(optionsWithDefaultCache)) {
+        var mutationFile = optionsWithDefaultCache.mutationFile, apolloOptions_2 = __rest(optionsWithDefaultCache, ["mutationFile"]);
+        cy.fixture(mutationFile).then(function (content) {
+            cy.apollo(__assign({ mutation: graphql_tag_1["default"](content) }, apolloOptions_2));
+        });
+    }
     else {
-        if (isQueryFile(optionsWithDefaultCache)) {
-            var queryFile = optionsWithDefaultCache.queryFile, apolloOptions_1 = __rest(optionsWithDefaultCache, ["queryFile"]);
-            cy.fixture(queryFile).then(function (content) {
-                cy.apollo(__assign({ query: graphql_tag_1["default"](content) }, apolloOptions_1));
+        var _a = optionsWithDefaultCache.log, log = _a === void 0 ? true : _a, apolloOptions_3 = __rest(optionsWithDefaultCache, ["log"]);
+        if (log) {
+            logger = Cypress.log({
+                autoEnd: false,
+                name: 'apollo',
+                displayName: 'apollo',
+                message: isQuery(apolloOptions_3) ? "Execute Graphql Query: " + apolloOptions_3.query.loc.source.body : "Execute Graphql Mutation: " + apolloOptions_3.mutation.loc.source.body,
+                consoleProps: function () {
+                    return {
+                        Options: apolloOptions_3,
+                        Yielded: result
+                    };
+                }
             });
         }
-        else if (isMutationFile(optionsWithDefaultCache)) {
-            var mutationFile = optionsWithDefaultCache.mutationFile, apolloOptions_2 = __rest(optionsWithDefaultCache, ["mutationFile"]);
-            cy.fixture(mutationFile).then(function (content) {
-                cy.apollo(__assign({ mutation: graphql_tag_1["default"](content) }, apolloOptions_2));
-            });
-        }
-        else {
-            var _a = optionsWithDefaultCache.log, log = _a === void 0 ? true : _a, apolloOptions_3 = __rest(optionsWithDefaultCache, ["log"]);
-            if (log) {
-                logger = Cypress.log({
-                    autoEnd: false,
-                    name: 'apollo',
-                    displayName: 'apollo',
-                    message: isQuery(apolloOptions_3) ? "Execute Graphql Query: " + apolloOptions_3.query.loc.source.body : "Execute Graphql Mutation: " + apolloOptions_3.mutation.loc.source.body,
-                    consoleProps: function () {
-                        return {
-                            Options: apolloOptions_3,
-                            Yielded: result
-                        };
-                    }
-                });
-            }
-            cy.wrap({}, { log: false })
-                .then(function () { return (isQuery(optionsWithDefaultCache) ? apollo.query(optionsWithDefaultCache)["catch"](function (error) {
-                cy.log("Caught Graphql Query Error: " + JSON.stringify(error));
-                return error;
-            }) : apollo.mutate(optionsWithDefaultCache)["catch"](function (error) {
-                cy.log("Caught Graphql Mutation Error: " + JSON.stringify(error));
-                return error;
-            }))
-                .then(function (r) {
-                result = r;
-                logger === null || logger === void 0 ? void 0 : logger.end();
-                return r;
-            }); });
-        }
+        cy.wrap({}, { log: true })
+            .then(function () { return (isQuery(optionsWithDefaultCache) ? apollo.query(optionsWithDefaultCache)["catch"](function (error) {
+            cy.log("Caught Graphql Query Error: " + JSON.stringify(error));
+            return error;
+        }) : apollo.mutate(optionsWithDefaultCache)["catch"](function (error) {
+            cy.log("Caught Graphql Mutation Error: " + JSON.stringify(error));
+            return error;
+        }))
+            .then(function (r) {
+            result = r;
+            logger === null || logger === void 0 ? void 0 : logger.end();
+            return r;
+        }); });
     }
 };
 exports.apollo = apollo;

package/dist/support/apollo/apolloClient.js

@@ -33,7 +33,7 @@ var apolloClient = function (authMethod, options) {
         Cypress.log({
             name: 'apolloClient',
             displayName: 'apClient',
-            message: "Create new apollo client",
+            message: 'Create new apollo client',
             consoleProps: function () {
                 return {
                     Auth: authMethod,

package/dist/support/apollo/links.js

@@ -65,9 +65,7 @@ exports.uploadLink = context_1.setContext(function (operation, _a) {
             fetchOptions: __assign(__assign({}, fetchOptions), { formData: formData })
         };
     }
-    else {
-        return {
-            fetchOptions: __assign({}, fetchOptions)
-        };
-    }
+    return {
+        fetchOptions: __assign({}, fetchOptions)
+    };
 });

package/dist/support/commands.d.ts

@@ -0,0 +1 @@
+import 'cypress-wait-until';

package/dist/support/commands.js

@@ -0,0 +1,3 @@
+"use strict";
+exports.__esModule = true;
+require("cypress-wait-until");

package/dist/support/fixture.js

@@ -15,7 +15,7 @@ var fixture = function (originalCommand, fixture) {
     return cy.wrap({}, { log: false }).then(function () {
         return originalCommand.apply(void 0, __spreadArray([fixture], args)).then(function (f) {
             return f;
-        })["catch"](function (err) {
+        })["catch"](function () {
             return null;
         });
     }).then(function (file) {

package/dist/support/logout.js

@@ -6,7 +6,7 @@ exports.logout = void 0;
 var logout = function () {
     Cypress.log({
         name: 'logout',
-        message: "Logout",
+        message: 'Logout',
         consoleProps: function () {
             return {};
         }

package/dist/support/provisioning/runProvisioningScript.js

@@ -4,7 +4,9 @@ exports.runProvisioningScript = void 0;
 function processContent(formFile) {
     var content = formFile.fileContent;
     if (formFile.replacements) {
-        Object.keys(formFile.replacements).forEach(function (k) { return content = content.replaceAll(k, formFile.replacements[k]); });
+        Object.keys(formFile.replacements).forEach(function (k) {
+            content = content.replaceAll(k, formFile.replacements[k]);
+        });
     }
     formFile.fileContent = content;
     return Cypress.Blob.binaryStringToBlob(content, formFile.type);
@@ -38,17 +40,17 @@ var runProvisioningScript = function (script, files, jahiaServer, options, timeo
     if (options === void 0) { options = { log: true }; }
     var formData = new FormData();
     if (isFormFile(script)) {
-        append(script, formData, "script");
+        append(script, formData, 'script');
     }
     else {
         append({
             fileContent: JSON.stringify(script),
             type: 'application/json'
-        }, formData, "script");
+        }, formData, 'script');
     }
     if (files) {
         files.forEach(function (f) {
-            append(f, formData, "file");
+            append(f, formData, 'file');
         });
     }
     var response;

package/dist/utils/Utils.d.ts

@@ -0,0 +1,12 @@
+export declare const setNodeProperty: (pathOrId: string, property: string, value: string, language: string) => Cypress.Chainable;
+export declare const deleteNode: (pathOrId: string) => Cypress.Chainable;
+export declare const grantRoles: (pathOrId: string, roleNames: Array<string>, principalName: string, principalType: string) => Cypress.Chainable;
+export declare const waitAllJobsFinished: (errorMessage?: string, timeout?: number) => void;
+export declare const addNode: (variables: {
+    parentPathOrId: string;
+    primaryNodeType: string;
+    name: string;
+    properties?: any[];
+    children?: any[];
+}) => Cypress.Chainable;
+export declare const getNodeByPath: (path: string) => Cypress.Chainable;

package/dist/utils/Utils.js

@@ -0,0 +1,79 @@
+"use strict";
+exports.__esModule = true;
+exports.getNodeByPath = exports.addNode = exports.waitAllJobsFinished = exports.grantRoles = exports.deleteNode = exports.setNodeProperty = void 0;
+var setNodeProperty = function (pathOrId, property, value, language) {
+    return cy.apollo({
+        variables: {
+            pathOrId: pathOrId,
+            property: property,
+            value: value,
+            language: language
+        },
+        mutationFile: 'graphql/jcr/mutation/setProperty.graphql'
+    });
+};
+exports.setNodeProperty = setNodeProperty;
+var deleteNode = function (pathOrId) {
+    return cy.apollo({
+        variables: {
+            pathOrId: pathOrId
+        },
+        mutationFile: 'graphql/jcr/mutation/deleteNode.graphql'
+    });
+};
+exports.deleteNode = deleteNode;
+var grantRoles = function (pathOrId, roleNames, principalName, principalType) {
+    cy.log('Grant role(s) ' + roleNames + ' with principal type ' + principalType + ' to ' + principalName + ' on node ' + pathOrId);
+    return cy.apollo({
+        variables: {
+            pathOrId: pathOrId,
+            roleNames: roleNames,
+            principalName: principalName,
+            principalType: principalType
+        },
+        mutationFile: 'graphql/jcr/mutation/grantRoles.graphql'
+    });
+};
+exports.grantRoles = grantRoles;
+var waitAllJobsFinished = function (errorMessage, timeout) {
+    if (timeout === void 0) { timeout = 60000; }
+    cy.waitUntil(function () {
+        return cy
+            .apollo({
+            fetchPolicy: 'no-cache',
+            queryFile: 'graphql/jcr/query/getJobsWithStatus.graphql'
+        })
+            .then(function (response) {
+            var _a, _b, _c, _d;
+            var jobs = (_d = (_c = (_b = (_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.admin) === null || _b === void 0 ? void 0 : _b.jahia) === null || _c === void 0 ? void 0 : _c.scheduler) === null || _d === void 0 ? void 0 : _d.jobs;
+            var publicationJobs = jobs.filter(function (job) { return job.group === 'PublicationJob'; });
+            var hasActivePublicationJobs = publicationJobs.some(function (job) { return job.jobStatus === 'EXECUTING'; });
+            return !hasActivePublicationJobs;
+        });
+    }, {
+        errorMsg: errorMessage ? errorMessage : 'Jobs are still running before the end of timeout',
+        timeout: timeout,
+        verbose: true,
+        interval: 1000
+    });
+    // Wait 2 seconds for server sync after publication
+    // eslint-disable-next-line cypress/no-unnecessary-waiting
+    cy.wait(2000);
+};
+exports.waitAllJobsFinished = waitAllJobsFinished;
+var addNode = function (variables) {
+    return cy.apollo({
+        variables: variables,
+        mutationFile: 'graphql/jcr/mutation/addNode.graphql'
+    });
+};
+exports.addNode = addNode;
+var getNodeByPath = function (path) {
+    return cy.apollo({
+        variables: {
+            path: path
+        },
+        queryFile: 'graphql/jcr/query/getNodeByPath.graphql'
+    });
+};
+exports.getNodeByPath = getNodeByPath;

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './Utils';

package/dist/utils/index.js

@@ -0,0 +1,13 @@
+"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]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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;
+__exportStar(require("./Utils"), exports);

package/fixtures/graphql/jcr/mutation/addNode.graphql

@@ -0,0 +1,18 @@
+mutation addNode($parentPathOrId: String!, $name: String!, $primaryNodeType: String!, $children: [InputJCRNode] = [], $properties: [InputJCRProperty]) {
+    jcr(workspace: EDIT) {
+        addNode(
+            parentPathOrId: $parentPathOrId,
+            name: $name,
+            primaryNodeType: $primaryNodeType,
+            properties: $properties,
+        ) {
+            addChildrenBatch(nodes: $children){
+                uuid
+            }
+            uuid
+            node {
+                name
+            }
+        }
+    }
+}

package/fixtures/graphql/jcr/{deleteNode.graphql → mutation/deleteNode.graphql}

@@ -1,4 +1,4 @@
-mutation($pathOrId: String!) {
+mutation deleteNode($pathOrId: String!) {
     jcr(workspace: EDIT) {
         deleteNode(pathOrId: $pathOrId)
     }

package/fixtures/graphql/jcr/mutation/grantRoles.graphql

@@ -0,0 +1,16 @@
+mutation grantRoles(
+    $pathOrId: String!
+    $roleNames: [String]!
+    $principalName: String!
+    $principalType: PrincipalType!
+) {
+    jcr {
+        mutateNode(pathOrId: $pathOrId) {
+            grantRoles(
+                roleNames: $roleNames
+                principalType: $principalType
+                principalName: $principalName
+            )
+        }
+    }
+}

package/fixtures/graphql/jcr/mutation/setProperty.graphql

@@ -0,0 +1,9 @@
+mutation setProperty($pathOrId: String!, $property: String!, $value: String!, $language: String!){
+    jcr{
+        mutateNode(pathOrId: $pathOrId){
+            mutateProperty(name: $property){
+                setValue(value: $value, language: $language)
+            }
+        }
+    }
+}

package/fixtures/graphql/jcr/query/getJobsWithStatus.graphql

@@ -0,0 +1,13 @@
+query getJobsWithStatus{
+    admin {
+        jahia {
+            scheduler{
+                jobs {
+                    siteKey
+                    group
+                    jobStatus
+                }
+            }
+        }
+    }
+}

package/fixtures/graphql/jcr/query/getNodeByPath.graphql

@@ -0,0 +1,15 @@
+query getNodeByPath($path: String!, $properties: [String]=[]) {
+    jcr {
+        nodeByPath(path: $path) {
+            uuid
+            name
+        	properties(names: $properties){
+              name
+              value
+            }
+            primaryNodeType {
+                name
+            }
+        }
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jahia/cypress",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "scripts": {
     "build": "tsc",
     "lint": "eslint src -c .eslintrc.json --ext .ts"
@@ -9,12 +9,17 @@
   "types": "dist/index.d.ts",
   "license": "MIT",
   "devDependencies": {
+    "@jahia/eslint-config": "^1.1.0",
     "@typescript-eslint/eslint-plugin": "^4.29.3",
     "@typescript-eslint/parser": "^4.29.3",
     "cypress": "^12.2.0",
+    "cypress-wait-until": "^1.7.2",
     "eslint": "^7.32.0",
     "eslint-plugin-cypress": "^2.11.3",
     "cross-fetch": "^3.1.5",
+    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-react": "^7.32.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
     "typescript": "^4.3.5"
   },
   "dependencies": {