@sitecore-jss/sitecore-jss-dev-tools 16.0.0-canary.8 → 16.0.1

package/dist/disconnected-server/media-service.js

@@ -6,6 +6,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createDisconnectedAssetMiddleware = void 0;
 var fs_1 = __importDefault(require("fs"));
 var path_1 = __importDefault(require("path"));
+/**
+ * @param {DisconnectedAssetMiddlewareOptions} config
+ */
 function createDisconnectedAssetMiddleware(_a) {
     var manifestPath = _a.manifestPath, staticRootPath = _a.staticRootPath;
     return function disconnectedAssetMiddleware(request, response) {

package/dist/mergeFs.js

@@ -25,6 +25,7 @@ var processFileSync = function (filePath, parseFileContents) {
     // if no encoding is specified, readFileSync returns a buffer instead of a string
     var contents = fs_1.default.readFileSync(filePath, 'utf8');
     if (contents) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         var contentObject = void 0;
         if (parseFileContents) {
             contentObject = parseFileContents(filePath, contents);
@@ -47,16 +48,18 @@ var readDirSync = function (dir) {
         filesList: [],
         dirList: [],
     };
-    if (IS_HIDDEN_FILE(dir))
+    if (IS_HIDDEN_FILE(dir)) {
         return result;
+    }
     var list = fs_1.default.readdirSync(dir);
     if (!list) {
         return result;
     }
     list.forEach(function (file) {
         var filePath = path_1.default.join(dir, file);
-        if (IS_HIDDEN_FILE(file))
+        if (IS_HIDDEN_FILE(file)) {
             return;
+        }
         var stats = fs_1.default.statSync(filePath);
         if (stats && stats.isDirectory()) {
             result.dirList.push(filePath);

package/dist/package-deploy.js

@@ -1,4 +1,34 @@
 "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);
+};
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -39,35 +69,44 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.packageDeploy = void 0;
+exports.getHttpsTransport = exports.extractProxy = exports.packageDeploy = exports.logJobStatus = exports.finishWatchJobStatusTask = exports.doFingerprintsMatch = exports.normalizeFingerprint = exports.applyCertPinning = void 0;
 var chalk_1 = __importDefault(require("chalk"));
 var fs_1 = __importDefault(require("fs"));
-var https_1 = require("https");
+var https_1 = __importStar(require("https"));
 var path_1 = __importDefault(require("path"));
-var request_1 = __importDefault(require("request"));
+var form_data_1 = __importDefault(require("form-data"));
+var axios_1 = __importDefault(require("axios"));
 var digest_1 = require("./digest");
 // Node does not use system level trusted CAs. This causes issues because SIF likes to install
 // using a Windows trusted CA - so SSL connections to Sitecore will fail from Node.
 // If the options.acceptCertificate is passed, we disable normal SSL validation and use this function
 // to whitelist only a cert with the specific thumbprint - essentially certificate pinning.
+/**
+ * @param {ClientRequest} req
+ * @param {PackageDeployOptions} options
+ */
 function applyCertPinning(req, options) {
     req.on('socket', function (socket) {
         socket.on('secureConnect', function () {
             var fingerprint = socket.getPeerCertificate().fingerprint;
             // Match the fingerprint with our saved fingerprint
-            if (options.acceptCertificate && (!doFingerprintsMatch(options.acceptCertificate, fingerprint))) {
+            if (options.acceptCertificate &&
+                !doFingerprintsMatch(options.acceptCertificate, fingerprint)) {
                 // Abort request, optionally emit an error event
-                // tslint:disable-next-line:max-line-length
                 req.emit('error', new Error("Expected server SSL certificate to have thumbprint " + options.acceptCertificate + " from acceptCertificate, but got " + fingerprint + " from server. This may mean the certificate has changed, or that a malicious certificate is present."));
                 return req.abort();
             }
         });
     });
 }
+exports.applyCertPinning = applyCertPinning;
+/**
+ * @param {string} fp
+ */
 function normalizeFingerprint(fp) {
     //
     // The fingerprint for a certificate is a 20-byte value.
-    // Such values are typically expressed as strings, but 
+    // Such values are typically expressed as strings, but
     // there are many different formats that may be used.
     //
     // For example, the following values all represent
@@ -82,60 +121,117 @@ function normalizeFingerprint(fp) {
     // function implements the logic for that conversion.
     return fp.toLowerCase().replace(new RegExp(':', 'g'), '');
 }
+exports.normalizeFingerprint = normalizeFingerprint;
+/**
+ * @param {string} fp1
+ * @param {string} fp2
+ */
 function doFingerprintsMatch(fp1, fp2) {
     return normalizeFingerprint(fp1) === normalizeFingerprint(fp2);
 }
+exports.doFingerprintsMatch = doFingerprintsMatch;
+/**
+ * @param {Object} params
+ * @param {string[]} params.warnings
+ * @param {string[]} params.errors
+ * @param {Function} params.resolve
+ * @param {Function} params.reject
+ */
+function finishWatchJobStatusTask(_a) {
+    var warnings = _a.warnings, errors = _a.errors, resolve = _a.resolve, reject = _a.reject;
+    console.log();
+    console.log('Import is complete.');
+    if (warnings.length) {
+        console.log();
+        console.warn(chalk_1.default.yellow('IMPORT WARNING(S) OCCURRED!'));
+        warnings.forEach(function (w) { return console.error(chalk_1.default.yellow(w)); });
+    }
+    if (errors.length) {
+        console.log();
+        console.error(chalk_1.default.red('IMPORT ERROR(S) OCCURRED!'));
+        errors.forEach(function (e) { return console.error(chalk_1.default.red(e)); });
+        reject();
+    }
+    else {
+        resolve();
+    }
+}
+exports.finishWatchJobStatusTask = finishWatchJobStatusTask;
+/**
+ * @param {Object} params
+ * @param {string} params.message
+ * @param {string} params.entryLevel
+ * @param {string[]} params.warnings
+ * @param {string[]} params.errors
+ */
+function logJobStatus(_a) {
+    var message = _a.message, entryLevel = _a.entryLevel, warnings = _a.warnings, errors = _a.errors;
+    switch (entryLevel) {
+        case 'WARN':
+            console.warn(chalk_1.default.yellow(message));
+            warnings.push(message);
+            break;
+        case 'ERROR':
+            console.error(chalk_1.default.red(message));
+            errors.push(message);
+            break;
+        case 'DEBUG':
+            console.log(chalk_1.default.white(message));
+            break;
+        default:
+            console.log(chalk_1.default.green(message));
+            break;
+    }
+}
+exports.logJobStatus = logJobStatus;
+/**
+ * @param {PackageDeployOptions} options
+ * @param {string} taskName
+ */
 function watchJobStatus(options, taskName) {
     return __awaiter(this, void 0, void 0, function () {
-        var logOffset, errors, warnings, factors, mac, requestBaseOptions;
+        var logOffset, errors, warnings, factors, mac, isHttps, requestBaseOptions;
         return __generator(this, function (_a) {
             logOffset = 0;
             errors = [];
             warnings = [];
             factors = [options.appName, taskName, options.importServiceUrl + "/status"];
             mac = digest_1.hmac(factors, options.secret);
+            isHttps = options.importServiceUrl.startsWith('https');
             requestBaseOptions = {
+                transport: isHttps ? getHttpsTransport(options) : undefined,
                 headers: {
                     'User-Agent': 'Sitecore/JSS-Import',
                     'Cache-Control': 'no-cache',
                     'X-JSS-Auth': mac,
                 },
-                proxy: options.proxy,
-                // we turn off normal CA cert validation when we are whitelisting a single cert thumbprint
-                strictSSL: options.acceptCertificate ? false : true,
-                followRedirect: false,
+                proxy: extractProxy(options.proxy),
+                maxRedirects: 0,
+                httpsAgent: isHttps
+                    ? new https_1.Agent({
+                        // we turn off normal CA cert validation when we are whitelisting a single cert thumbprint
+                        rejectUnauthorized: options.acceptCertificate ? false : true,
+                        // needed to allow whitelisting a cert thumbprint if a connection is reused
+                        maxCachedSessions: options.acceptCertificate ? 0 : undefined,
+                    })
+                    : undefined,
             };
-            // needed to allow whitelisting a cert thumbprint if a connection is reused
-            if (options.importServiceUrl.startsWith('https') && options.acceptCertificate) {
-                requestBaseOptions.agent = new https_1.Agent({ maxCachedSessions: 0 });
-            }
             if (options.debugSecurity) {
                 console.log("Deployment status security factors: " + factors);
                 console.log("Deployment status HMAC: " + mac);
             }
             return [2 /*return*/, new Promise(function (resolve, reject) {
+                    /**
+                     * Send job status request
+                     */
                     function sendJobStatusRequest() {
-                        // tslint:disable-next-line:max-line-length
-                        var req = request_1.default.get(options.importServiceUrl + "/status?appName=" + options.appName + "&jobName=" + taskName + "&after=" + logOffset, requestBaseOptions, function (error, response, body) {
-                            if (error || response.statusCode < 200 || response.statusCode >= 300) {
-                                // tslint:disable-next-line:max-line-length
-                                console.error(chalk_1.default.red('Unexpected response from import status service. The import task is probably still running; check the Sitecore logs for details.'));
-                                if (error) {
-                                    console.error(chalk_1.default.red(error));
-                                }
-                                if (response && response.statusMessage) {
-                                    console.error(chalk_1.default.red(response.statusMessage));
-                                }
-                                if (body) {
-                                    console.error(chalk_1.default.red(body));
-                                }
-                                reject();
-                                return;
-                            }
+                        axios_1.default
+                            .get(options.importServiceUrl + "/status?appName=" + options.appName + "&jobName=" + taskName + "&after=" + logOffset, requestBaseOptions)
+                            .then(function (response) {
+                            var body = response.data;
                             try {
-                                var logReplies = JSON.parse(body);
-                                var complete_1 = false;
-                                logReplies.forEach(function (entry) {
+                                var state = body.state, messages = body.messages;
+                                messages.forEach(function (entry) {
                                     logOffset++;
                                     var entryBits = /^(\[([A-Z]+)\] )?(.+)/.exec(entry);
                                     var entryLevel = 'INFO';
@@ -146,49 +242,16 @@ function watchJobStatus(options, taskName) {
                                         // we're not using the capture group as the message might be multi-line
                                         message = entry.substring(entryLevel.length + 3);
                                     }
-                                    if (entry.startsWith('Job ended:')) {
-                                        console.log();
-                                        console.log('Import is complete.');
-                                        if (warnings.length > 0) {
-                                            console.log();
-                                            console.warn(chalk_1.default.yellow('IMPORT WARNING(S) OCCURRED!'));
-                                            warnings.forEach(function (w) { return console.error(chalk_1.default.yellow(w)); });
-                                        }
-                                        if (errors.length > 0) {
-                                            console.log();
-                                            console.error(chalk_1.default.red('IMPORT ERROR(S) OCCURRED!'));
-                                            errors.forEach(function (e) { return console.error(chalk_1.default.red(e)); });
-                                            reject();
-                                        }
-                                        else {
-                                            resolve();
-                                        }
-                                        complete_1 = true;
-                                        return;
-                                    }
                                     if (message.startsWith('[JSS] - ')) {
                                         message = message.substring(8);
                                     }
-                                    switch (entryLevel) {
-                                        case 'WARN':
-                                            console.warn(chalk_1.default.yellow(message));
-                                            warnings.push(message);
-                                            break;
-                                        case 'ERROR':
-                                            console.error(chalk_1.default.red(message));
-                                            errors.push(message);
-                                            break;
-                                        case 'DEBUG':
-                                            console.log(chalk_1.default.white(message));
-                                            break;
-                                        default:
-                                            console.log(chalk_1.default.green(message));
-                                            break;
-                                    }
+                                    logJobStatus({ message: message, entryLevel: entryLevel, warnings: warnings, errors: errors });
                                 });
-                                if (!complete_1) {
-                                    setTimeout(sendJobStatusRequest, 1000);
+                                if (state === 'Finished') {
+                                    finishWatchJobStatusTask({ warnings: warnings, errors: errors, resolve: resolve, reject: reject });
+                                    return;
                                 }
+                                setTimeout(sendJobStatusRequest, 1000);
                             }
                             catch (error) {
                                 console.error(chalk_1.default.red("Unexpected error processing reply from import status service: " + error));
@@ -196,26 +259,37 @@ function watchJobStatus(options, taskName) {
                                 console.error(chalk_1.default.red('Consult the Sitecore logs for details.'));
                                 reject(error);
                             }
+                        })
+                            .catch(function (error) {
+                            console.error(chalk_1.default.red('Unexpected response from import status service. The import task is probably still running; check the Sitecore logs for details.'));
+                            if (error.response) {
+                                console.error(chalk_1.default.red("Status message: " + error.response.statusText));
+                                console.error(chalk_1.default.red("Status: " + error.response.status));
+                            }
+                            else {
+                                console.error(chalk_1.default.red(error.message));
+                            }
+                            reject();
                         });
-                        applyCertPinning(req, options);
                     }
                     setTimeout(sendJobStatusRequest, 1000);
                 })];
         });
     });
 }
+/**
+ * @param {PackageDeployOptions} options
+ */
 function packageDeploy(options) {
     return __awaiter(this, void 0, void 0, function () {
-        var packageFile, factors, _a, requestBaseOptions;
+        var packageFile, factors, _a, formData, isHttps, requestBaseOptions;
         return __generator(this, function (_b) {
             switch (_b.label) {
                 case 0:
                     if (!options.secret) {
-                        // tslint:disable-next-line:max-line-length
                         throw new Error('Deployment secret was not passed. A shared secret must be configured on both the Sitecore app config and the JS app config');
                     }
                     if (options.secret.length < 32) {
-                        // tslint:disable-next-line:max-line-length
                         throw new Error('Deployment secret was too short. Use a RANDOM (not words or phrases) secret at least 32 characters long.');
                     }
                     packageFile = null;
@@ -237,50 +311,82 @@ function packageDeploy(options) {
                         console.log("Deployment security factors: " + factors);
                         console.log("Deployment HMAC: " + digest_1.hmac(factors, options.secret));
                     }
+                    formData = new form_data_1.default();
+                    formData.append('path', fs_1.default.createReadStream(packageFile));
+                    formData.append('appName', options.appName);
+                    isHttps = options.importServiceUrl.startsWith('https');
                     requestBaseOptions = {
-                        headers: {
-                            'User-Agent': 'Sitecore/JSS-Import',
-                            'Cache-Control': 'no-cache',
-                            'X-JSS-Auth': digest_1.hmac(factors, options.secret),
-                        },
-                        proxy: options.proxy,
-                        // we turn off normal CA cert validation when we are whitelisting a single cert thumbprint
-                        strictSSL: options.acceptCertificate ? false : true,
-                        followRedirect: false,
-                        formData: {
-                            path: fs_1.default.createReadStream(packageFile),
-                            appName: options.appName,
-                        },
+                        transport: isHttps ? getHttpsTransport(options) : undefined,
+                        headers: __assign({ 'User-Agent': 'Sitecore/JSS-Import', 'Cache-Control': 'no-cache', 'X-JSS-Auth': digest_1.hmac(factors, options.secret) }, formData.getHeaders()),
+                        proxy: extractProxy(options.proxy),
+                        httpsAgent: isHttps
+                            ? new https_1.Agent({
+                                // we turn off normal CA cert validation when we are whitelisting a single cert thumbprint
+                                rejectUnauthorized: options.acceptCertificate ? false : true,
+                                // needed to allow whitelisting a cert thumbprint if a connection is reused
+                                maxCachedSessions: options.acceptCertificate ? 0 : undefined,
+                            })
+                            : undefined,
+                        maxRedirects: 0,
                     };
-                    // needed to allow whitelisting a cert thumbprint if a connection is reused
-                    if (options.importServiceUrl.startsWith('https') && options.acceptCertificate) {
-                        requestBaseOptions.agent = new https_1.Agent({ maxCachedSessions: 0 });
-                    }
                     console.log("Sending package " + packageFile + " to " + options.importServiceUrl + "...");
                     return [2 /*return*/, new Promise(function (resolve, reject) {
-                            var req = request_1.default.post(options.importServiceUrl, requestBaseOptions, function (error, response, body) {
-                                if (error || response.statusCode < 200 || response.statusCode >= 300) {
-                                    console.error(chalk_1.default.red('Unexpected response from import service:'));
-                                    if (error) {
-                                        console.error(chalk_1.default.red(error));
-                                    }
-                                    if (response && response.statusMessage) {
-                                        console.error(chalk_1.default.red("Status message: " + response.statusMessage));
-                                    }
-                                    if (body) {
-                                        console.error(chalk_1.default.red("Body: " + body));
-                                    }
-                                    reject();
-                                    return;
-                                }
+                            axios_1.default
+                                .post(options.importServiceUrl, formData, requestBaseOptions)
+                                .then(function (response) {
+                                var body = response.data;
                                 console.log(chalk_1.default.green("Sitecore has accepted import task " + body));
                                 resolve(body);
+                            })
+                                .catch(function (error) {
+                                console.error(chalk_1.default.red('Unexpected response from import service:'));
+                                if (error.response) {
+                                    console.error(chalk_1.default.red("Status message: " + error.response.statusText));
+                                    console.error(chalk_1.default.red("Status: " + error.response.status));
+                                }
+                                else {
+                                    console.error(chalk_1.default.red(error.message));
+                                }
+                                reject();
                             });
-                            applyCertPinning(req, options);
-                        })
-                            .then(function (taskName) { return watchJobStatus(options, taskName); })];
+                        }).then(function (taskName) { return watchJobStatus(options, taskName); })];
             }
         });
     });
 }
 exports.packageDeploy = packageDeploy;
+/**
+ * Creates valid proxy object which fit to axios configuration
+ * @param {string} [proxy] proxy url
+ */
+function extractProxy(proxy) {
+    if (!proxy)
+        return undefined;
+    try {
+        var proxyUrl = new URL(proxy);
+        return {
+            protocol: proxyUrl.protocol.slice(0, -1),
+            host: proxyUrl.hostname,
+            port: +proxyUrl.port,
+        };
+    }
+    catch (error) {
+        console.error(chalk_1.default.red("Invalid proxy url provided " + proxy));
+        process.exit(1);
+    }
+}
+exports.extractProxy = extractProxy;
+/**
+ * Provides way to customize axios request adapter
+ * in order to execute certificate pinning before request sent:
+ * {@link https://github.com/axios/axios/issues/2808}
+ * @param {PackageDeployOptions} options
+ */
+function getHttpsTransport(options) {
+    return __assign(__assign({}, https_1.default), { request: function (reqOptions, callback) {
+            var req = https_1.default.request(__assign({}, reqOptions), callback);
+            applyCertPinning(req, options);
+            return req;
+        } });
+}
+exports.getHttpsTransport = getHttpsTransport;

package/dist/package-generate.js

@@ -7,6 +7,9 @@ exports.packageGenerate = void 0;
 var sitecore_jss_update_package_1 = require("@sitecore-jss/sitecore-jss-update-package");
 var fs_extra_1 = __importDefault(require("fs-extra"));
 var path_1 = __importDefault(require("path"));
+/**
+ * @param {PackageGenerateOptions} options
+ */
 function packageGenerate(options) {
     // clear output folder
     fs_extra_1.default.emptyDirSync(options.outputPath);

package/dist/resolve-scjssconfig.js

@@ -5,6 +5,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveScJssConfig = void 0;
 var resolve_1 = __importDefault(require("resolve"));
+/**
+ * @param {any} config
+ */
 function resolveScJssConfig(_a) {
     var _b = _a === void 0 ? {} : _a, _c = _b.configPath, configPath = _c === void 0 ? './scjssconfig.json' : _c, _d = _b.configName, configName = _d === void 0 ? 'sitecore' : _d, _e = _b.assert, assert = _e === void 0 ? true : _e;
     return new Promise(function (resolvePromise, rejectPromise) {

package/dist/setup/find-app-name.js

@@ -5,6 +5,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.findAppNameInContents = exports.findAppNameInConfig = void 0;
 var fs_1 = __importDefault(require("fs"));
+/**
+ * @param {string} path
+ */
 function findAppNameInConfig(path) {
     if (!fs_1.default.existsSync(path)) {
         return null;
@@ -13,6 +16,9 @@ function findAppNameInConfig(path) {
     return findAppNameInContents(file);
 }
 exports.findAppNameInConfig = findAppNameInConfig;
+/**
+ * @param {string} contents
+ */
 function findAppNameInContents(contents) {
     var matches = /<app (.*)name="([^"]+)/gm.exec(contents);
     if (matches && matches.length >= 2) {

package/dist/setup/jss-config.js

@@ -18,9 +18,7 @@ exports.replaceConfigTokens = function (val) {
     // ensure instance path is defined if used
     // this would result in copying files to random places
     if (newVal.indexOf('{sitecoreInstancePath}') > -1 && !config.sitecore.instancePath) {
-        throw new Error(
-        // tslint:disable-next-line:max-line-length
-        "instancePath config variable was used but was undefined or empty. You likely need to run npm run setup or update your " + setup_1.userConfigPath);
+        throw new Error("instancePath config variable was used but was undefined or empty. You likely need to run npm run setup or update your " + setup_1.userConfigPath);
     }
     // variable replacement {var} => var from jss config
     Object.keys(config.sitecore).forEach(function (key) {

package/dist/setup/secret-patch.js

@@ -2,10 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createSecretPatchContents = exports.writeSecretPatchFile = void 0;
 var fs_1 = require("fs");
+/**
+ * @param {string} path
+ * @param {string} appName
+ * @param {string} secret
+ */
 function writeSecretPatchFile(path, appName, secret) {
     fs_1.writeFileSync(path, createSecretPatchContents(appName, secret), { encoding: 'utf8' });
 }
 exports.writeSecretPatchFile = writeSecretPatchFile;
+/**
+ * @param {string} appName
+ * @param {string} secret
+ */
 function createSecretPatchContents(appName, secret) {
     return "<configuration xmlns:patch=\"http://www.sitecore.net/xmlconfig/\">\n  <sitecore>\n    <javaScriptServices>\n      <apps>\n        <app name=\"" + appName + "\"\n             deploymentSecret=\"" + secret + "\"\n             debugSecurity=\"false\"\n        />\n      </apps>\n    </javaScriptServices>\n  </sitecore>\n</configuration>\n";
 }