@jahia/cypress 4.3.0 → 4.4.0

package/dist/support/provisioning/runProvisioningScript.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="cypress" />
+import RequestOptions = Cypress.RequestOptions;
 declare global {
     namespace Cypress {
         interface Chainable<Subject> {
@@ -21,4 +22,4 @@ export declare type JahiaServer = {
     username: string;
     password: string;
 };
-export declare const runProvisioningScript: (script: FormFile | StringDictionary[], files?: FormFile[], jahiaServer?: JahiaServer, options?: Cypress.Loggable, timeout?: number) => void;
+export declare const runProvisioningScript: (script: FormFile | StringDictionary[], files?: FormFile[], jahiaServer?: JahiaServer, options?: Cypress.Loggable, timeout?: number, requestOptions?: Partial<RequestOptions>) => void;

package/dist/support/provisioning/runProvisioningScript.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 exports.__esModule = true;
 exports.runProvisioningScript = void 0;
 function processContent(formFile) {
@@ -36,9 +47,10 @@ function isFormFile(script) {
     return Boolean(script.fileContent || script.fileName);
 }
 // eslint-disable-next-line default-param-last, max-params
-var runProvisioningScript = function (script, files, jahiaServer, options, timeout) {
+var runProvisioningScript = function (script, files, jahiaServer, options, timeout, requestOptions) {
     if (jahiaServer === void 0) { jahiaServer = serverDefaults; }
     if (options === void 0) { options = { log: true }; }
+    if (requestOptions === void 0) { requestOptions = {}; }
     var formData = new FormData();
     if (isFormFile(script)) {
         append(script, formData, 'script');
@@ -75,17 +87,11 @@ var runProvisioningScript = function (script, files, jahiaServer, options, timeo
             }
         });
     }
-    var request = {
-        url: jahiaServer.url + "/modules/api/provisioning",
-        method: 'POST',
-        auth: {
+    var request = __assign({ url: jahiaServer.url + "/modules/api/provisioning", method: 'POST', auth: {
             user: jahiaServer.username,
             pass: jahiaServer.password,
             sendImmediately: true
-        },
-        body: formData,
-        log: false
-    };
+        }, body: formData, log: false }, requestOptions);
     if (typeof timeout !== 'undefined') {
         request.timeout = timeout;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jahia/cypress",
-  "version": "4.3.0",
+  "version": "4.4.0",
   "scripts": {
     "build": "tsc",
     "lint": "eslint src -c .eslintrc.json --ext .ts --max-warnings=0"

package/src/support/provisioning/runProvisioningScript.md

@@ -45,6 +45,15 @@ Additional files that can be referenced in the script. When an operation require
 
 - `log` : should the command be logged or not
 
+#### > timeout (`number`)
+
+the timeout in milliseconds
+
+#### > requestOptions (`RequestOptions`)
+
+Addition options for the cypress request object, some useful ones are:
+- `failOnStatusCode` : useful when you expect a 4xx or 5xx error and need to test it
+
 ### Yields
 
 The provisioning script result, as JSON object

package/src/support/provisioning/runProvisioningScript.ts

@@ -69,7 +69,7 @@ function isFormFile(script: FormFile | StringDictionary[]): script is FormFile {
 }
 
 // eslint-disable-next-line default-param-last, max-params
-export const runProvisioningScript = (script: FormFile | StringDictionary[], files?: FormFile[], jahiaServer: JahiaServer = serverDefaults, options: Cypress.Loggable = {log: true}, timeout?: number): void => {
+export const runProvisioningScript = (script: FormFile | StringDictionary[], files?: FormFile[], jahiaServer: JahiaServer = serverDefaults, options: Cypress.Loggable = {log: true}, timeout?: number, requestOptions: Partial<RequestOptions> = {}): void => {
     const formData = new FormData();
 
     if (isFormFile(script)) {
@@ -119,7 +119,8 @@ export const runProvisioningScript = (script: FormFile | StringDictionary[], fil
             sendImmediately: true
         },
         body: formData,
-        log: false
+        log: false,
+        ...requestOptions
     };
 
     if (typeof timeout !== 'undefined') {