@pnp/cli-microsoft365 6.7.0-beta.f5f5666 → 6.8.0-beta.00c3a00

package/dist/m365/spfx/commands/spfx-doctor.js

@@ -15,19 +15,11 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _SpfxDoctorCommand_instances, _SpfxDoctorCommand_initTelemetry, _SpfxDoctorCommand_initOptions, _SpfxDoctorCommand_initValidators;
 Object.defineProperty(exports, "__esModule", { value: true });
-const chalk = require("chalk");
 const child_process = require("child_process");
 const semver_1 = require("semver");
+const formatting_1 = require("../../../utils/formatting");
 const commands_1 = require("../commands");
 const base_project_command_1 = require("./project/base-project-command");
-/**
- * Has the particular check passed or failed
- */
-var CheckStatus;
-(function (CheckStatus) {
-    CheckStatus[CheckStatus["Success"] = 0] = "Success";
-    CheckStatus[CheckStatus["Failure"] = 1] = "Failure";
-})(CheckStatus || (CheckStatus = {}));
 /**
  * Where to search for the particular npm package: only in the current project,
  * in global packages or both
@@ -520,12 +512,12 @@ class SpfxDoctorCommand extends base_project_command_1.BaseProjectCommand {
             try {
                 spfxVersion = (_a = args.options.spfxVersion) !== null && _a !== void 0 ? _a : yield this.getSharePointFrameworkVersion(logger);
                 if (!spfxVersion) {
-                    logger.log(this.getStatus(CheckStatus.Failure, `SharePoint Framework`));
+                    logger.log(formatting_1.formatting.getStatus(formatting_1.CheckStatus.Failure, `SharePoint Framework`));
                     throw `SharePoint Framework not found`;
                 }
                 prerequisites = this.versions[spfxVersion];
                 if (!prerequisites) {
-                    logger.log(this.getStatus(CheckStatus.Failure, `SharePoint Framework v${spfxVersion}`));
+                    logger.log(formatting_1.formatting.getStatus(formatting_1.CheckStatus.Failure, `SharePoint Framework v${spfxVersion}`));
                     throw `spfx doctor doesn't support SPFx v${spfxVersion} at this moment`;
                 }
                 if (args.options.spfxVersion) {
@@ -533,7 +525,7 @@ class SpfxDoctorCommand extends base_project_command_1.BaseProjectCommand {
                 }
                 else {
                     // spfx was detected and if we are here, it means that we support it
-                    logger.log(this.getStatus(CheckStatus.Success, `SharePoint Framework v${spfxVersion}`));
+                    logger.log(formatting_1.formatting.getStatus(formatting_1.CheckStatus.Success, `SharePoint Framework v${spfxVersion}`));
                 }
                 yield this.checkSharePointCompatibility(spfxVersion, prerequisites, args, fixes, logger);
                 yield this.checkNodeVersion(prerequisites, fixes, logger);
@@ -566,11 +558,11 @@ class SpfxDoctorCommand extends base_project_command_1.BaseProjectCommand {
             if (args.options.env) {
                 const sp = this.spVersionStringToEnum(args.options.env);
                 if ((prerequisites.sp & sp) === sp) {
-                    logger.log(this.getStatus(CheckStatus.Success, `Supported in ${SharePointVersion[sp]}`));
+                    logger.log(formatting_1.formatting.getStatus(formatting_1.CheckStatus.Success, `Supported in ${SharePointVersion[sp]}`));
                     resolve();
                 }
                 else {
-                    logger.log(this.getStatus(CheckStatus.Failure, `Not supported in ${SharePointVersion[sp]}`));
+                    logger.log(formatting_1.formatting.getStatus(formatting_1.CheckStatus.Failure, `Not supported in ${SharePointVersion[sp]}`));
                     fixes.push(`Use SharePoint Framework v${(sp === SharePointVersion.SP2016 ? '1.1' : '1.4.1')}`);
                     reject(`SharePoint Framework v${spfxVersion} is not supported in ${SharePointVersion[sp]}`);
                 }
@@ -601,7 +593,7 @@ class SpfxDoctorCommand extends base_project_command_1.BaseProjectCommand {
                 this.checkStatus(`SharePoint Framework`, spfxVersionDetected, versionCheck, OptionalOrRequired.Required, fixes, logger);
             }
             else {
-                logger.log(this.getStatus(CheckStatus.Failure, `SharePoint Framework v${spfxVersionRequested} not found`));
+                logger.log(formatting_1.formatting.getStatus(formatting_1.CheckStatus.Failure, `SharePoint Framework v${spfxVersionRequested} not found`));
                 fixes.push(versionCheck.fix);
             }
         });
@@ -614,7 +606,7 @@ class SpfxDoctorCommand extends base_project_command_1.BaseProjectCommand {
                 this.checkStatus('yo', yoVersion, prerequisites.yo, OptionalOrRequired.Required, fixes, logger);
             }
             else {
-                logger.log(this.getStatus(CheckStatus.Failure, `yo not found`));
+                logger.log(formatting_1.formatting.getStatus(formatting_1.CheckStatus.Failure, `yo not found`));
                 fixes.push(prerequisites.yo.fix);
             }
         });
@@ -627,7 +619,7 @@ class SpfxDoctorCommand extends base_project_command_1.BaseProjectCommand {
                 this.checkStatus('gulp-cli', gulpCliVersion, prerequisites.gulpCli, OptionalOrRequired.Required, fixes, logger);
             }
             else {
-                logger.log(this.getStatus(CheckStatus.Failure, `gulp-cli not found`));
+                logger.log(formatting_1.formatting.getStatus(formatting_1.CheckStatus.Failure, `gulp-cli not found`));
                 fixes.push(prerequisites.gulpCli.fix);
             }
         });
@@ -637,7 +629,7 @@ class SpfxDoctorCommand extends base_project_command_1.BaseProjectCommand {
             .getPackageVersion('gulp', PackageSearchMode.GlobalOnly, HandlePromise.Continue, logger)
             .then((gulpVersion) => {
             if (gulpVersion) {
-                logger.log(this.getStatus(CheckStatus.Failure, `gulp should be removed`));
+                logger.log(formatting_1.formatting.getStatus(formatting_1.CheckStatus.Failure, `gulp should be removed`));
                 fixes.push('npm un -g gulp');
             }
         });
@@ -647,11 +639,11 @@ class SpfxDoctorCommand extends base_project_command_1.BaseProjectCommand {
             .getPackageVersion('typescript', PackageSearchMode.LocalOnly, HandlePromise.Continue, logger)
             .then((typeScriptVersion) => {
             if (typeScriptVersion) {
-                logger.log(this.getStatus(CheckStatus.Failure, `typescript v${typeScriptVersion} installed in the project`));
+                logger.log(formatting_1.formatting.getStatus(formatting_1.CheckStatus.Failure, `typescript v${typeScriptVersion} installed in the project`));
                 fixes.push('npm un typescript');
             }
             else {
-                logger.log(this.getStatus(CheckStatus.Success, `bundled typescript used`));
+                logger.log(formatting_1.formatting.getStatus(formatting_1.CheckStatus.Success, `bundled typescript used`));
             }
         });
     }
@@ -775,22 +767,14 @@ class SpfxDoctorCommand extends base_project_command_1.BaseProjectCommand {
     checkStatus(what, versionFound, versionCheck, optionalOrRequired, fixes, logger) {
         if (versionFound) {
             if ((0, semver_1.satisfies)(versionFound, versionCheck.range)) {
-                logger.log(this.getStatus(CheckStatus.Success, `${what} v${versionFound}`));
+                logger.log(formatting_1.formatting.getStatus(formatting_1.CheckStatus.Success, `${what} v${versionFound}`));
             }
             else {
-                logger.log(this.getStatus(CheckStatus.Failure, `${what} v${versionFound} found, v${versionCheck.range} required`));
+                logger.log(formatting_1.formatting.getStatus(formatting_1.CheckStatus.Failure, `${what} v${versionFound} found, v${versionCheck.range} required`));
                 fixes.push(versionCheck.fix);
             }
         }
     }
-    getStatus(result, message) {
-        const primarySupported = process.platform !== 'win32' ||
-            process.env.CI === 'true' ||
-            process.env.TERM === 'xterm-256color';
-        const success = primarySupported ? '✔' : '√';
-        const failure = primarySupported ? '✖' : '×';
-        return `${result === CheckStatus.Success ? chalk.green(success) : chalk.red(failure)} ${message}`;
-    }
 }
 _SpfxDoctorCommand_instances = new WeakSet(), _SpfxDoctorCommand_initTelemetry = function _SpfxDoctorCommand_initTelemetry() {
     this.telemetry.push((args) => {

package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-remove.js

@@ -0,0 +1,146 @@
+"use strict";
+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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SpoApplicationCustomizerRemoveCommand_instances, _SpoApplicationCustomizerRemoveCommand_initOptions, _SpoApplicationCustomizerRemoveCommand_initTelemetry, _SpoApplicationCustomizerRemoveCommand_initValidators, _SpoApplicationCustomizerRemoveCommand_initOptionSets;
+Object.defineProperty(exports, "__esModule", { value: true });
+const Cli_1 = require("../../../../cli/Cli");
+const request_1 = require("../../../../request");
+const validation_1 = require("../../../../utils/validation");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+const spo_1 = require("../../../../utils/spo");
+const formatting_1 = require("../../../../utils/formatting");
+const os = require("os");
+class SpoApplicationCustomizerRemoveCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.APPLICATIONCUSTOMIZER_REMOVE;
+    }
+    get description() {
+        return 'Removes an application customizer that is added to a site';
+    }
+    constructor() {
+        super();
+        _SpoApplicationCustomizerRemoveCommand_instances.add(this);
+        this.allowedScopes = ['Site', 'Web', 'All'];
+        __classPrivateFieldGet(this, _SpoApplicationCustomizerRemoveCommand_instances, "m", _SpoApplicationCustomizerRemoveCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpoApplicationCustomizerRemoveCommand_instances, "m", _SpoApplicationCustomizerRemoveCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoApplicationCustomizerRemoveCommand_instances, "m", _SpoApplicationCustomizerRemoveCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _SpoApplicationCustomizerRemoveCommand_instances, "m", _SpoApplicationCustomizerRemoveCommand_initOptionSets).call(this);
+    }
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (args.options.confirm) {
+                    return yield this.removeApplicationCustomizer(logger, args.options);
+                }
+                const result = yield Cli_1.Cli.prompt({
+                    type: 'confirm',
+                    name: 'continue',
+                    default: false,
+                    message: `Are you sure you want to remove the application customizer '${args.options.clientSideComponentId || args.options.title || args.options.id}'?`
+                });
+                if (result.continue) {
+                    yield this.removeApplicationCustomizer(logger, args.options);
+                }
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        });
+    }
+    removeApplicationCustomizer(logger, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const applicationCustomizer = yield this.getApplicationCustomizer(options);
+            if (this.verbose) {
+                logger.logToStderr(`Removing application customizer '${options.clientSideComponentId || options.title || options.id}' from the site '${options.webUrl}'...`);
+            }
+            const requestOptions = {
+                url: `${options.webUrl}/_api/${applicationCustomizer.Scope.toString() === '2' ? 'Site' : 'Web'}/UserCustomActions('${applicationCustomizer.Id}')`,
+                headers: {
+                    accept: 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            yield request_1.default.delete(requestOptions);
+        });
+    }
+    getApplicationCustomizer(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resolvedScope = options.scope || 'All';
+            let appCustomizers = [];
+            if (options.id) {
+                const appCustomizer = yield spo_1.spo.getCustomActionById(options.webUrl, options.id, resolvedScope);
+                if (appCustomizer) {
+                    appCustomizers.push(appCustomizer);
+                }
+            }
+            else if (options.title) {
+                appCustomizers = yield spo_1.spo.getCustomActions(options.webUrl, resolvedScope, `(Title eq '${formatting_1.formatting.encodeQueryParameter(options.title)}') and (startswith(Location,'ClientSideExtension.ApplicationCustomizer'))`);
+            }
+            else {
+                appCustomizers = yield spo_1.spo.getCustomActions(options.webUrl, resolvedScope, `(ClientSideComponentId eq guid'${options.clientSideComponentId}') and (startswith(Location,'ClientSideExtension.ApplicationCustomizer'))`);
+            }
+            if (appCustomizers.length === 0) {
+                throw `No application customizer with ${options.title && `title '${options.title}'` || options.clientSideComponentId && `ClientSideComponentId '${options.clientSideComponentId}'` || options.id && `id '${options.id}'`} found`;
+            }
+            if (appCustomizers.length > 1) {
+                throw `Multiple application customizer with ${options.title ? `title '${options.title}'` : `ClientSideComponentId '${options.clientSideComponentId}'`} found. Please disambiguate using IDs: ${os.EOL}${appCustomizers.map(a => `- ${a.Id}`).join(os.EOL)}`;
+            }
+            return appCustomizers[0];
+        });
+    }
+}
+_SpoApplicationCustomizerRemoveCommand_instances = new WeakSet(), _SpoApplicationCustomizerRemoveCommand_initOptions = function _SpoApplicationCustomizerRemoveCommand_initOptions() {
+    this.options.unshift({
+        option: '-u, --webUrl <webUrl>'
+    }, {
+        option: '-t, --title [title]'
+    }, {
+        option: '-i, --id [id]'
+    }, {
+        option: '-c, --clientSideComponentId [clientSideComponentId]'
+    }, {
+        option: '-s, --scope [scope]', autocomplete: this.allowedScopes
+    }, {
+        option: '--confirm'
+    });
+}, _SpoApplicationCustomizerRemoveCommand_initTelemetry = function _SpoApplicationCustomizerRemoveCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            title: typeof args.options.title !== 'undefined',
+            id: typeof args.options.id !== 'undefined',
+            clientSideComponentId: typeof args.options.clientSideComponentId !== 'undefined',
+            scope: typeof args.options.scope !== 'undefined',
+            confirm: !!args.options.confirm
+        });
+    });
+}, _SpoApplicationCustomizerRemoveCommand_initValidators = function _SpoApplicationCustomizerRemoveCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        if (args.options.id && !validation_1.validation.isValidGuid(args.options.id)) {
+            return `${args.options.id} is not a valid GUID`;
+        }
+        if (args.options.clientSideComponentId && !validation_1.validation.isValidGuid(args.options.clientSideComponentId)) {
+            return `${args.options.clientSideComponentId} is not a valid GUID`;
+        }
+        if (args.options.scope && this.allowedScopes.indexOf(args.options.scope) === -1) {
+            return `'${args.options.scope}' is not a valid application customizer scope. Allowed values are: ${this.allowedScopes.join(',')}`;
+        }
+        return validation_1.validation.isValidSharePointUrl(args.options.webUrl);
+    }));
+}, _SpoApplicationCustomizerRemoveCommand_initOptionSets = function _SpoApplicationCustomizerRemoveCommand_initOptionSets() {
+    this.optionSets.push({ options: ['id', 'title', 'clientSideComponentId'] });
+};
+module.exports = new SpoApplicationCustomizerRemoveCommand();
+//# sourceMappingURL=applicationcustomizer-remove.js.map

package/dist/m365/spo/commands/file/file-checkin.js

@@ -17,6 +17,7 @@ var _SpoFileCheckinCommand_instances, _SpoFileCheckinCommand_initTelemetry, _Spo
 Object.defineProperty(exports, "__esModule", { value: true });
 const request_1 = require("../../../../request");
 const formatting_1 = require("../../../../utils/formatting");
+const urlUtil_1 = require("../../../../utils/urlUtil");
 const validation_1 = require("../../../../utils/validation");
 const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
@@ -41,6 +42,9 @@ class SpoFileCheckinCommand extends SpoCommand_1.default {
         __classPrivateFieldGet(this, _SpoFileCheckinCommand_instances, "m", _SpoFileCheckinCommand_initValidators).call(this);
         __classPrivateFieldGet(this, _SpoFileCheckinCommand_instances, "m", _SpoFileCheckinCommand_initOptionSets).call(this);
     }
+    getExcludedOptionsWithUrls() {
+        return ['url'];
+    }
     commandAction(logger, args) {
         return __awaiter(this, void 0, void 0, function* () {
             let type = CheckinType.Major;
@@ -62,7 +66,8 @@ class SpoFileCheckinCommand extends SpoCommand_1.default {
                 requestUrl = `${args.options.webUrl}/_api/web/GetFileById('${formatting_1.formatting.encodeQueryParameter(args.options.id)}')/checkin(comment='${comment}',checkintype=${type})`;
             }
             if (args.options.url) {
-                requestUrl = `${args.options.webUrl}/_api/web/GetFileByServerRelativeUrl('${formatting_1.formatting.encodeQueryParameter(args.options.url)}')/checkin(comment='${comment}',checkintype=${type})`;
+                const serverRelativePath = urlUtil_1.urlUtil.getServerRelativePath(args.options.webUrl, args.options.url);
+                requestUrl = `${args.options.webUrl}/_api/web/GetFileByServerRelativeUrl('${formatting_1.formatting.encodeQueryParameter(serverRelativePath)}')/checkin(comment='${comment}',checkintype=${type})`;
             }
             const requestOptions = {
                 url: requestUrl,
@@ -83,8 +88,8 @@ class SpoFileCheckinCommand extends SpoCommand_1.default {
 _SpoFileCheckinCommand_instances = new WeakSet(), _SpoFileCheckinCommand_initTelemetry = function _SpoFileCheckinCommand_initTelemetry() {
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
-            id: (!(!args.options.id)).toString(),
-            url: (!(!args.options.url)).toString(),
+            id: typeof args.options.id !== 'undefined',
+            url: typeof args.options.url !== 'undefined',
             type: args.options.type || 'Major',
             comment: typeof args.options.comment !== 'undefined'
         });

package/dist/m365/spo/commands/file/file-checkout.js

@@ -17,6 +17,7 @@ var _SpoFileCheckoutCommand_instances, _SpoFileCheckoutCommand_initTelemetry, _S
 Object.defineProperty(exports, "__esModule", { value: true });
 const request_1 = require("../../../../request");
 const formatting_1 = require("../../../../utils/formatting");
+const urlUtil_1 = require("../../../../utils/urlUtil");
 const validation_1 = require("../../../../utils/validation");
 const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
@@ -35,6 +36,9 @@ class SpoFileCheckoutCommand extends SpoCommand_1.default {
         __classPrivateFieldGet(this, _SpoFileCheckoutCommand_instances, "m", _SpoFileCheckoutCommand_initValidators).call(this);
         __classPrivateFieldGet(this, _SpoFileCheckoutCommand_instances, "m", _SpoFileCheckoutCommand_initOptionSets).call(this);
     }
+    getExcludedOptionsWithUrls() {
+        return ['url'];
+    }
     commandAction(logger, args) {
         return __awaiter(this, void 0, void 0, function* () {
             let requestUrl = '';
@@ -42,7 +46,8 @@ class SpoFileCheckoutCommand extends SpoCommand_1.default {
                 requestUrl = `${args.options.webUrl}/_api/web/GetFileById('${formatting_1.formatting.encodeQueryParameter(args.options.id)}')/checkout`;
             }
             if (args.options.url) {
-                requestUrl = `${args.options.webUrl}/_api/web/GetFileByServerRelativeUrl('${formatting_1.formatting.encodeQueryParameter(args.options.url)}')/checkout`;
+                const serverRelativePath = urlUtil_1.urlUtil.getServerRelativePath(args.options.webUrl, args.options.url);
+                requestUrl = `${args.options.webUrl}/_api/web/GetFileByServerRelativeUrl('${formatting_1.formatting.encodeQueryParameter(serverRelativePath)}')/checkout`;
             }
             const requestOptions = {
                 url: requestUrl,
@@ -63,8 +68,8 @@ class SpoFileCheckoutCommand extends SpoCommand_1.default {
 _SpoFileCheckoutCommand_instances = new WeakSet(), _SpoFileCheckoutCommand_initTelemetry = function _SpoFileCheckoutCommand_initTelemetry() {
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
-            id: (!(!args.options.id)).toString(),
-            url: (!(!args.options.url)).toString()
+            id: typeof args.options.id !== 'undefined',
+            url: typeof args.options.url !== 'undefined'
         });
     });
 }, _SpoFileCheckoutCommand_initOptions = function _SpoFileCheckoutCommand_initOptions() {

package/dist/m365/spo/commands/file/file-copy.js

@@ -38,10 +38,7 @@ class SpoFileCopyCommand extends SpoCommand_1.default {
     commandAction(logger, args) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                if (this.verbose) {
-                    logger.logToStderr(`Copying file '${args.options.sourceUrl}' to '${args.options.targetUrl}'...`);
-                }
-                const sourcePath = this.getAbsoluteUrl(args.options.webUrl, args.options.sourceUrl);
+                const sourcePath = this.getAbsoluteUrl(args.options.webUrl, urlUtil_1.urlUtil.getServerRelativePath(args.options.webUrl, args.options.sourceUrl));
                 let destinationPath = this.getAbsoluteUrl(args.options.webUrl, args.options.targetUrl) + '/';
                 if (args.options.newName) {
                     destinationPath += args.options.newName;
@@ -50,6 +47,9 @@ class SpoFileCopyCommand extends SpoCommand_1.default {
                     // Keep the original file name
                     destinationPath += sourcePath.substring(sourcePath.lastIndexOf('/') + 1);
                 }
+                if (this.verbose) {
+                    logger.logToStderr(`Copying file '${sourcePath}' to '${destinationPath}'...`);
+                }
                 const requestOptions = {
                     url: `${args.options.webUrl}/_api/SP.MoveCopyUtil.CopyFileByPath`,
                     headers: {

package/dist/m365/spo/commands/file/file-get.js

@@ -19,6 +19,7 @@ const fs = require("fs");
 const path = require("path");
 const request_1 = require("../../../../request");
 const formatting_1 = require("../../../../utils/formatting");
+const urlUtil_1 = require("../../../../utils/urlUtil");
 const validation_1 = require("../../../../utils/validation");
 const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
@@ -66,7 +67,8 @@ class SpoFileGetCommand extends SpoCommand_1.default {
                 else {
                     options += '&';
                 }
-                options += `@f='${formatting_1.formatting.encodeQueryParameter(args.options.url)}'`;
+                const serverRelativePath = urlUtil_1.urlUtil.getServerRelativePath(args.options.webUrl, args.options.url);
+                options += `@f='${formatting_1.formatting.encodeQueryParameter(serverRelativePath)}'`;
             }
             const requestOptions = {
                 url: requestUrl + options,

package/dist/m365/spo/commands/file/file-list.js

@@ -13,10 +13,11 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _SpoFileListCommand_instances, _SpoFileListCommand_initTelemetry, _SpoFileListCommand_initOptions, _SpoFileListCommand_initValidators;
+var _SpoFileListCommand_instances, _SpoFileListCommand_initTelemetry, _SpoFileListCommand_initOptions, _SpoFileListCommand_initValidators, _SpoFileListCommand_initOptionSets;
 Object.defineProperty(exports, "__esModule", { value: true });
 const request_1 = require("../../../../request");
 const formatting_1 = require("../../../../utils/formatting");
+const urlUtil_1 = require("../../../../utils/urlUtil");
 const validation_1 = require("../../../../utils/validation");
 const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
@@ -33,69 +34,155 @@ class SpoFileListCommand extends SpoCommand_1.default {
         __classPrivateFieldGet(this, _SpoFileListCommand_instances, "m", _SpoFileListCommand_initTelemetry).call(this);
         __classPrivateFieldGet(this, _SpoFileListCommand_instances, "m", _SpoFileListCommand_initOptions).call(this);
         __classPrivateFieldGet(this, _SpoFileListCommand_instances, "m", _SpoFileListCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _SpoFileListCommand_instances, "m", _SpoFileListCommand_initOptionSets).call(this);
     }
     commandAction(logger, args) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.verbose) {
-                logger.logToStderr(`Retrieving all files in folder ${args.options.folder} at site ${args.options.webUrl}...`);
+                logger.logToStderr(`Retrieving all files in folder '${args.options.folder}' at site '${args.options.webUrl}'${args.options.recursive ? ' (recursive)' : ''}...`);
             }
             try {
-                const files = yield this.getFiles(args.options.folder, args);
-                logger.log(files.value);
+                if (args.options.folder) {
+                    args.options.folderUrl = args.options.folder;
+                    this.warn(logger, `Option 'folder' is deprecated. Please use 'folderUrl' instead`);
+                }
+                const fieldProperties = this.formatSelectProperties(args.options.fields, args.options.output);
+                const allFiles = [];
+                const allFolders = args.options.recursive
+                    ? [...yield this.getFolders(args.options.folderUrl, args, logger), args.options.folderUrl]
+                    : [args.options.folderUrl];
+                for (const folder of allFolders) {
+                    const files = yield this.getFiles(folder, fieldProperties, args, logger);
+                    files.forEach((file) => allFiles.push(file));
+                }
+                // Clean ListItemAllFields.ID property from the output if included
+                // Reason: It causes a casing conflict with 'Id' when parsing JSON in PowerShell
+                if (fieldProperties.selectProperties.some(p => p.toLowerCase().indexOf('listitemallfields') > -1)) {
+                    allFiles.filter(file => { var _a; return ((_a = file.ListItemAllFields) === null || _a === void 0 ? void 0 : _a.ID) !== undefined; }).forEach(file => delete file.ListItemAllFields['ID']);
+                }
+                logger.log(allFiles);
             }
             catch (err) {
                 this.handleRejectedODataJsonPromise(err);
             }
         });
     }
-    // Gets files from a folder recursively.
-    getFiles(folderUrl, args, files = { value: [] }) {
-        // If --recursive option is specified, retrieve both Files and Folder details, otherwise only Files.
-        const expandParameters = args.options.recursive ? 'Files,Folders' : 'Files';
-        let requestUrl = `${args.options.webUrl}/_api/web/GetFolderByServerRelativeUrl('${formatting_1.formatting.encodeQueryParameter(folderUrl)}')?$expand=${expandParameters}`;
-        if (args.options.output !== 'json') {
-            requestUrl += '&$select=Files/UniqueId,Files/Name,Files/ServerRelativeUrl';
-        }
-        const requestOptions = {
-            url: requestUrl,
-            method: 'GET',
-            headers: {
-                'accept': 'application/json;odata=nometadata'
-            },
-            responseType: 'json'
-        };
-        return request_1.default
-            .get(requestOptions)
-            .then((filesAndFoldersResult) => {
-            filesAndFoldersResult.Files.forEach((file) => files.value.push(file));
-            // If the request is --recursive, call this method for other folders.
-            if (args.options.recursive &&
-                filesAndFoldersResult.Folders !== undefined &&
-                filesAndFoldersResult.Folders.length !== 0) {
-                return Promise.all(filesAndFoldersResult.Folders.map((folder) => this.getFiles(folder.ServerRelativeUrl, args, files)));
+    getFiles(folderUrl, fieldProperties, args, logger, skip = 0) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                const page = Math.ceil(skip / SpoFileListCommand.pageSize) + 1;
+                logger.logToStderr(`Retrieving files in folder '${folderUrl}'${page > 1 ? ', page ' + page : ''}...`);
+            }
+            const allFiles = [];
+            const serverRelativePath = urlUtil_1.urlUtil.getServerRelativePath(args.options.webUrl, folderUrl);
+            const requestUrl = `${args.options.webUrl}/_api/web/GetFolderByServerRelativeUrl(@url)/Files?@url='${formatting_1.formatting.encodeQueryParameter(serverRelativePath)}'`;
+            const queryParams = [`$skip=${skip}`, `$top=${SpoFileListCommand.pageSize}`];
+            if (fieldProperties.expandProperties.length > 0) {
+                queryParams.push(`$expand=${fieldProperties.expandProperties.join(',')}`);
+            }
+            if (fieldProperties.selectProperties.length > 0) {
+                queryParams.push(`$select=${fieldProperties.selectProperties.join(',')}`);
+            }
+            if (args.options.filter) {
+                queryParams.push(`$filter=${args.options.filter}`);
+            }
+            const requestOptions = {
+                url: `${requestUrl}&${queryParams.join('&')}`,
+                method: 'GET',
+                headers: {
+                    'accept': 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            const response = yield request_1.default.get(requestOptions);
+            response.value.forEach(file => allFiles.push(file));
+            if (response.value.length === SpoFileListCommand.pageSize) {
+                const files = yield this.getFiles(folderUrl, fieldProperties, args, logger, skip + SpoFileListCommand.pageSize);
+                files.forEach(file => allFiles.push(file));
+            }
+            return allFiles;
+        });
+    }
+    getFolders(folderUrl, args, logger, skip = 0) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                const page = Math.ceil(skip / SpoFileListCommand.pageSize) + 1;
+                logger.logToStderr(`Retrieving folders in folder '${folderUrl}'${page > 1 ? ', page ' + page : ''}...`);
+            }
+            const allFolders = [];
+            const serverRelativeUrl = urlUtil_1.urlUtil.getServerRelativePath(args.options.webUrl, folderUrl);
+            const requestUrl = `${args.options.webUrl}/_api/web/GetFolderByServerRelativeUrl(@url)/Folders?@url='${formatting_1.formatting.encodeQueryParameter(serverRelativeUrl)}'`;
+            const requestOptions = {
+                url: `${requestUrl}&$skip=${skip}&$top=${SpoFileListCommand.pageSize}&$select=ServerRelativeUrl`,
+                method: 'GET',
+                headers: {
+                    'accept': 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            const response = yield request_1.default.get(requestOptions);
+            for (const folder of response.value) {
+                allFolders.push(folder.ServerRelativeUrl);
+                const subfolders = yield this.getFolders(folder.ServerRelativeUrl, args, logger);
+                subfolders.forEach(folder => allFolders.push(folder));
             }
-            else {
-                return;
+            if (response.value.length === SpoFileListCommand.pageSize) {
+                const folders = yield this.getFolders(folderUrl, args, logger, skip + SpoFileListCommand.pageSize);
+                folders.forEach(folder => allFolders.push(folder));
             }
-        }).then(() => files);
+            return allFolders;
+        });
+    }
+    formatSelectProperties(fields, output) {
+        let selectProperties = [];
+        const expandProperties = [];
+        if (output === 'text' && !fields) {
+            selectProperties = ['UniqueId', 'Name', 'ServerRelativeUrl'];
+        }
+        if (fields) {
+            fields.split(',').forEach((field) => {
+                const subparts = field.trim().split('/');
+                if (subparts.length > 1) {
+                    expandProperties.push(subparts[0]);
+                }
+                selectProperties.push(field.trim());
+            });
+        }
+        return {
+            selectProperties: [...new Set(selectProperties)],
+            expandProperties: [...new Set(expandProperties)]
+        };
     }
 }
 _SpoFileListCommand_instances = new WeakSet(), _SpoFileListCommand_initTelemetry = function _SpoFileListCommand_initTelemetry() {
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
-            recursive: args.options.recursive
+            folder: typeof args.options.folder !== 'undefined',
+            folderUrl: typeof args.options.folderUrl !== 'undefined',
+            recursive: args.options.recursive,
+            fields: typeof args.options.fields !== 'undefined',
+            filter: typeof args.options.filter !== 'undefined'
         });
     });
 }, _SpoFileListCommand_initOptions = function _SpoFileListCommand_initOptions() {
     this.options.unshift({
         option: '-u, --webUrl <webUrl>'
     }, {
-        option: '-f, --folder <folder>'
+        option: '-f, --folder [folder]'
+    }, {
+        option: '-f, --folderUrl [folderUrl]'
+    }, {
+        option: '--fields [fields]'
+    }, {
+        option: '--filter [filter]'
     }, {
         option: '-r, --recursive'
     });
 }, _SpoFileListCommand_initValidators = function _SpoFileListCommand_initValidators() {
     this.validators.push((args) => __awaiter(this, void 0, void 0, function* () { return validation_1.validation.isValidSharePointUrl(args.options.webUrl); }));
+}, _SpoFileListCommand_initOptionSets = function _SpoFileListCommand_initOptionSets() {
+    this.optionSets.push({ options: ['folder', 'folderUrl'] });
 };
+SpoFileListCommand.pageSize = 5000;
 module.exports = new SpoFileListCommand();
 //# sourceMappingURL=file-list.js.map