@pnp/cli-microsoft365 6.0.0-beta.37b9374 → 6.0.0-beta.38e141b

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

@@ -16,10 +16,14 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _SpoFileCopyCommand_instances, _SpoFileCopyCommand_initTelemetry, _SpoFileCopyCommand_initOptions, _SpoFileCopyCommand_initValidators;
 Object.defineProperty(exports, "__esModule", { value: true });
 const url = require("url");
+const Cli_1 = require("../../../../cli/Cli");
 const request_1 = require("../../../../request");
-const utils_1 = require("../../../../utils");
+const spo_1 = require("../../../../utils/spo");
+const urlUtil_1 = require("../../../../utils/urlUtil");
+const validation_1 = require("../../../../utils/validation");
 const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
+const removeCommand = require('./file-remove');
 class SpoFileCopyCommand extends SpoCommand_1.default {
     constructor() {
         super();
@@ -37,70 +41,68 @@ class SpoFileCopyCommand extends SpoCommand_1.default {
     getExcludedOptionsWithUrls() {
         return ['targetUrl'];
     }
-    commandAction(logger, args, cb) {
-        const webUrl = args.options.webUrl;
-        const parsedUrl = url.parse(webUrl);
-        const tenantUrl = `${parsedUrl.protocol}//${parsedUrl.hostname}`;
-        // Check if the source file exists.
-        // Called on purpose, we explicitly check if user specified file
-        // in the sourceUrl option.
-        // The CreateCopyJobs endpoint accepts file, folder or batch from both.
-        // A user might enter folder instead of file as source url by mistake
-        // then there are edge cases when deleteIfAlreadyExists flag is set
-        // the user can receive misleading error message.
-        this
-            .fileExists(tenantUrl, webUrl, args.options.sourceUrl)
-            .then(() => {
-            if (args.options.deleteIfAlreadyExists) {
-                // try delete target file, if deleteIfAlreadyExists flag is set
-                const filename = args.options.sourceUrl.replace(/^.*[\\\/]/, '');
-                return this.recycleFile(tenantUrl, args.options.targetUrl, filename, logger);
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const webUrl = args.options.webUrl;
+            const parsedUrl = url.parse(webUrl);
+            const tenantUrl = `${parsedUrl.protocol}//${parsedUrl.hostname}`;
+            try {
+                // Check if the source file exists.
+                // Called on purpose, we explicitly check if user specified file
+                // in the sourceUrl option.
+                // The CreateCopyJobs endpoint accepts file, folder or batch from both.
+                // A user might enter folder instead of file as source url by mistake
+                // then there are edge cases when deleteIfAlreadyExists flag is set
+                // the user can receive misleading error message.
+                yield this.fileExists(tenantUrl, webUrl, args.options.sourceUrl);
+                if (args.options.deleteIfAlreadyExists) {
+                    // try delete target file, if deleteIfAlreadyExists flag is set
+                    const filename = args.options.sourceUrl.replace(/^.*[\\\/]/, '');
+                    yield this.recycleFile(tenantUrl, args.options.targetUrl, filename, logger);
+                }
+                // all preconditions met, now create copy job
+                const sourceAbsoluteUrl = urlUtil_1.urlUtil.urlCombine(webUrl, args.options.sourceUrl);
+                const allowSchemaMismatch = args.options.allowSchemaMismatch || false;
+                const requestUrl = urlUtil_1.urlUtil.urlCombine(webUrl, '/_api/site/CreateCopyJobs');
+                const requestOptions = {
+                    url: requestUrl,
+                    headers: {
+                        'accept': 'application/json;odata=nometadata'
+                    },
+                    data: {
+                        exportObjectUris: [sourceAbsoluteUrl],
+                        destinationUri: urlUtil_1.urlUtil.urlCombine(tenantUrl, args.options.targetUrl),
+                        options: {
+                            "AllowSchemaMismatch": allowSchemaMismatch,
+                            "IgnoreVersionHistory": true
+                        }
+                    },
+                    responseType: 'json'
+                };
+                const jobInfo = yield request_1.default.post(requestOptions);
+                yield new Promise((resolve, reject) => {
+                    this.dots = '';
+                    const copyJobInfo = jobInfo.value[0];
+                    const progressPollInterval = 30 * 60; //used previously implemented interval. The API does not provide guidance on what value should be used.
+                    setTimeout(() => {
+                        spo_1.spo.waitUntilCopyJobFinished({
+                            copyJobInfo,
+                            siteUrl: webUrl,
+                            pollingInterval: progressPollInterval,
+                            resolve,
+                            reject,
+                            logger,
+                            dots: this.dots,
+                            debug: this.debug,
+                            verbose: this.verbose
+                        });
+                    }, progressPollInterval);
+                });
             }
-            return Promise.resolve();
-        })
-            .then(() => {
-            // all preconditions met, now create copy job
-            const sourceAbsoluteUrl = utils_1.urlUtil.urlCombine(webUrl, args.options.sourceUrl);
-            const allowSchemaMismatch = args.options.allowSchemaMismatch || false;
-            const requestUrl = utils_1.urlUtil.urlCombine(webUrl, '/_api/site/CreateCopyJobs');
-            const requestOptions = {
-                url: requestUrl,
-                headers: {
-                    'accept': 'application/json;odata=nometadata'
-                },
-                data: {
-                    exportObjectUris: [sourceAbsoluteUrl],
-                    destinationUri: utils_1.urlUtil.urlCombine(tenantUrl, args.options.targetUrl),
-                    options: {
-                        "AllowSchemaMismatch": allowSchemaMismatch,
-                        "IgnoreVersionHistory": true
-                    }
-                },
-                responseType: 'json'
-            };
-            return request_1.default.post(requestOptions);
-        })
-            .then((jobInfo) => {
-            return new Promise((resolve, reject) => {
-                this.dots = '';
-                const copyJobInfo = jobInfo.value[0];
-                const progressPollInterval = 30 * 60; //used previously implemented interval. The API does not provide guidance on what value should be used.
-                setTimeout(() => {
-                    utils_1.spo.waitUntilCopyJobFinished({
-                        copyJobInfo,
-                        siteUrl: webUrl,
-                        pollingInterval: progressPollInterval,
-                        resolve,
-                        reject,
-                        logger,
-                        dots: this.dots,
-                        debug: this.debug,
-                        verbose: this.verbose
-                    });
-                }, progressPollInterval);
-            });
-        })
-            .then(_ => cb(), (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        });
     }
     /**
      * Checks if a file exists on the server relative url
@@ -123,50 +125,34 @@ class SpoFileCopyCommand extends SpoCommand_1.default {
      * Moves file in the site recycle bin
      */
     recycleFile(tenantUrl, targetUrl, filename, logger) {
-        return new Promise((resolve, reject) => {
-            const targetFolderAbsoluteUrl = utils_1.urlUtil.urlCombine(tenantUrl, targetUrl);
-            // since the target WebFullUrl is unknown we can use getRequestDigestForSite
+        return __awaiter(this, void 0, void 0, function* () {
+            const targetFolderAbsoluteUrl = urlUtil_1.urlUtil.urlCombine(tenantUrl, targetUrl);
+            // since the target WebFullUrl is unknown we can use getRequestDigest
             // to get it from target folder absolute url.
             // Similar approach used here Microsoft.SharePoint.Client.Web.WebUrlFromFolderUrlDirect
-            utils_1.spo
-                .getRequestDigest(targetFolderAbsoluteUrl)
-                .then((contextResponse) => {
-                if (this.debug) {
-                    logger.logToStderr(`contextResponse.WebFullUrl: ${contextResponse.WebFullUrl}`);
-                }
-                if (targetUrl.charAt(0) !== '/') {
-                    targetUrl = `/${targetUrl}`;
+            const contextResponse = yield spo_1.spo.getRequestDigest(targetFolderAbsoluteUrl);
+            if (this.debug) {
+                logger.logToStderr(`contextResponse.WebFullUrl: ${contextResponse.WebFullUrl}`);
+            }
+            const targetFileServerRelativeUrl = `${urlUtil_1.urlUtil.getServerRelativePath(contextResponse.WebFullUrl, targetUrl)}/${filename}`;
+            const removeOptions = {
+                webUrl: contextResponse.WebFullUrl,
+                url: targetFileServerRelativeUrl,
+                recycle: true,
+                confirm: true,
+                debug: this.debug,
+                verbose: this.verbose
+            };
+            try {
+                yield Cli_1.Cli.executeCommand(removeCommand, { options: Object.assign(Object.assign({}, removeOptions), { _: [] }) });
+            }
+            catch (err) {
+                if (err.error !== undefined && err.error.message !== undefined && err.error.message.includes('does not exist')) {
                 }
-                if (targetUrl.lastIndexOf('/') !== targetUrl.length - 1) {
-                    targetUrl = `${targetUrl}/`;
+                else {
+                    throw err;
                 }
-                const requestUrl = `${contextResponse.WebFullUrl}/_api/web/GetFileByServerRelativeUrl('${encodeURIComponent(`${targetUrl}${filename}`)}')/recycle()`;
-                const requestOptions = {
-                    url: requestUrl,
-                    method: 'POST',
-                    headers: {
-                        'X-HTTP-Method': 'DELETE',
-                        'If-Match': '*',
-                        'accept': 'application/json;odata=nometadata'
-                    },
-                    responseType: 'json'
-                };
-                request_1.default.post(requestOptions)
-                    .then(() => {
-                    resolve();
-                })
-                    .catch((err) => {
-                    if (err.statusCode === 404) {
-                        // file does not exist so can proceed
-                        return resolve();
-                    }
-                    if (this.debug) {
-                        logger.logToStderr(`recycleFile error...`);
-                        logger.logToStderr(err);
-                    }
-                    reject(err);
-                });
-            }, (e) => reject(e));
+            }
         });
     }
 }
@@ -190,7 +176,7 @@ _SpoFileCopyCommand_instances = new WeakSet(), _SpoFileCopyCommand_initTelemetry
         option: '--allowSchemaMismatch'
     });
 }, _SpoFileCopyCommand_initValidators = function _SpoFileCopyCommand_initValidators() {
-    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () { return utils_1.validation.isValidSharePointUrl(args.options.webUrl); }));
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () { return validation_1.validation.isValidSharePointUrl(args.options.webUrl); }));
 };
 module.exports = new SpoFileCopyCommand();
 //# sourceMappingURL=file-copy.js.map

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

@@ -13,12 +13,12 @@ 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 _SpoFileGetCommand_instances, _SpoFileGetCommand_initTelemetry, _SpoFileGetCommand_initOptions, _SpoFileGetCommand_initValidators;
+var _SpoFileGetCommand_instances, _SpoFileGetCommand_initTelemetry, _SpoFileGetCommand_initOptions, _SpoFileGetCommand_initValidators, _SpoFileGetCommand_initOptionSets;
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require("fs");
 const path = require("path");
 const request_1 = require("../../../../request");
-const utils_1 = require("../../../../utils");
+const validation_1 = require("../../../../utils/validation");
 const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
 class SpoFileGetCommand extends SpoCommand_1.default {
@@ -28,6 +28,7 @@ class SpoFileGetCommand extends SpoCommand_1.default {
         __classPrivateFieldGet(this, _SpoFileGetCommand_instances, "m", _SpoFileGetCommand_initTelemetry).call(this);
         __classPrivateFieldGet(this, _SpoFileGetCommand_instances, "m", _SpoFileGetCommand_initOptions).call(this);
         __classPrivateFieldGet(this, _SpoFileGetCommand_instances, "m", _SpoFileGetCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _SpoFileGetCommand_instances, "m", _SpoFileGetCommand_initOptionSets).call(this);
     }
     get name() {
         return commands_1.default.FILE_GET;
@@ -38,78 +39,76 @@ class SpoFileGetCommand extends SpoCommand_1.default {
     getExcludedOptionsWithUrls() {
         return ['url'];
     }
-    commandAction(logger, args, cb) {
-        if (this.verbose) {
-            logger.logToStderr(`Retrieving file from site ${args.options.webUrl}...`);
-        }
-        let requestUrl = '';
-        let options = '';
-        if (args.options.id) {
-            requestUrl = `${args.options.webUrl}/_api/web/GetFileById('${encodeURIComponent(args.options.id)}')`;
-        }
-        else if (args.options.url) {
-            requestUrl = `${args.options.webUrl}/_api/web/GetFileByServerRelativePath(DecodedUrl=@f)`;
-        }
-        if (args.options.asListItem) {
-            options = '?$expand=ListItemAllFields';
-        }
-        else if (args.options.asFile || args.options.asString) {
-            options = '/$value';
-        }
-        if (args.options.url) {
-            if (options.indexOf('?') < 0) {
-                options += '?';
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr(`Retrieving file from site ${args.options.webUrl}...`);
             }
-            else {
-                options += '&';
+            let requestUrl = '';
+            let options = '';
+            if (args.options.id) {
+                requestUrl = `${args.options.webUrl}/_api/web/GetFileById('${encodeURIComponent(args.options.id)}')`;
             }
-            options += `@f='${encodeURIComponent(args.options.url)}'`;
-        }
-        const requestOptions = {
-            url: requestUrl + options,
-            headers: {
-                'accept': 'application/json;odata=nometadata'
-            },
-            // Set responseType to arraybuffer, otherwise binary data will be encoded
-            // to utf8 and binary data is corrupt
-            responseType: args.options.asFile ? 'stream' : 'json'
-        };
-        if (args.options.asFile && args.options.path) {
-            request_1.default
-                .get(requestOptions)
-                .then((file) => {
-                return new Promise((resolve, reject) => {
-                    const writer = fs.createWriteStream(args.options.path);
-                    file.data.pipe(writer);
-                    writer.on('error', err => {
-                        reject(err);
-                    });
-                    writer.on('close', () => {
-                        resolve(args.options.path);
-                    });
-                });
-            })
-                .then((file) => {
-                if (this.verbose) {
-                    logger.logToStderr(`File saved to path ${file}`);
+            else if (args.options.url) {
+                requestUrl = `${args.options.webUrl}/_api/web/GetFileByServerRelativePath(DecodedUrl=@f)`;
+            }
+            if (args.options.asListItem) {
+                options = '?$expand=ListItemAllFields';
+            }
+            else if (args.options.asFile || args.options.asString) {
+                options = '/$value';
+            }
+            if (args.options.url) {
+                if (options.indexOf('?') < 0) {
+                    options += '?';
                 }
-                cb();
-            }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
-        }
-        else {
-            request_1.default
-                .get(requestOptions)
-                .then((file) => {
-                if (args.options.asString) {
-                    logger.log(file.toString());
+                else {
+                    options += '&';
+                }
+                options += `@f='${encodeURIComponent(args.options.url)}'`;
+            }
+            const requestOptions = {
+                url: requestUrl + options,
+                headers: {
+                    'accept': 'application/json;odata=nometadata'
+                },
+                // Set responseType to arraybuffer, otherwise binary data will be encoded
+                // to utf8 and binary data is corrupt
+                responseType: args.options.asFile ? 'stream' : 'json'
+            };
+            try {
+                const file = yield request_1.default.get(requestOptions);
+                if (args.options.asFile && args.options.path) {
+                    // Not possible to use async/await for this promise
+                    yield new Promise((resolve, reject) => {
+                        const writer = fs.createWriteStream(args.options.path);
+                        file.data.pipe(writer);
+                        writer.on('error', err => {
+                            reject(err);
+                        });
+                        writer.on('close', () => {
+                            const filePath = args.options.path;
+                            if (this.verbose) {
+                                logger.logToStderr(`File saved to path ${filePath}`);
+                            }
+                            return resolve();
+                        });
+                    });
                 }
                 else {
-                    const fileProperties = JSON.parse(JSON.stringify(file));
-                    logger.log(args.options.asListItem ? fileProperties.ListItemAllFields : fileProperties);
+                    if (args.options.asString) {
+                        logger.log(file.toString());
+                    }
+                    else {
+                        const fileProperties = JSON.parse(JSON.stringify(file));
+                        logger.log(args.options.asListItem ? fileProperties.ListItemAllFields : fileProperties);
+                    }
                 }
-                cb();
-            }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
-        }
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        });
     }
 }
 _SpoFileGetCommand_instances = new WeakSet(), _SpoFileGetCommand_initTelemetry = function _SpoFileGetCommand_initTelemetry() {
@@ -141,21 +140,15 @@ _SpoFileGetCommand_instances = new WeakSet(), _SpoFileGetCommand_initTelemetry =
     });
 }, _SpoFileGetCommand_initValidators = function _SpoFileGetCommand_initValidators() {
     this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
-        const isValidSharePointUrl = utils_1.validation.isValidSharePointUrl(args.options.webUrl);
+        const isValidSharePointUrl = validation_1.validation.isValidSharePointUrl(args.options.webUrl);
         if (isValidSharePointUrl !== true) {
             return isValidSharePointUrl;
         }
         if (args.options.id) {
-            if (!utils_1.validation.isValidGuid(args.options.id)) {
+            if (!validation_1.validation.isValidGuid(args.options.id)) {
                 return `${args.options.id} is not a valid GUID`;
             }
         }
-        if (args.options.id && args.options.url) {
-            return 'Specify id or url, but not both';
-        }
-        if (!args.options.id && !args.options.url) {
-            return 'Specify id or url, one is required';
-        }
         if (args.options.asFile && !args.options.path) {
             return 'The path should be specified when the --asFile option is used';
         }
@@ -174,6 +167,8 @@ _SpoFileGetCommand_instances = new WeakSet(), _SpoFileGetCommand_initTelemetry =
         }
         return true;
     }));
+}, _SpoFileGetCommand_initOptionSets = function _SpoFileGetCommand_initOptionSets() {
+    this.optionSets.push(['id', 'url']);
 };
 module.exports = new SpoFileGetCommand();
 //# sourceMappingURL=file-get.js.map

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

@@ -16,7 +16,8 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _SpoFileListCommand_instances, _SpoFileListCommand_initTelemetry, _SpoFileListCommand_initOptions, _SpoFileListCommand_initValidators;
 Object.defineProperty(exports, "__esModule", { value: true });
 const request_1 = require("../../../../request");
-const utils_1 = require("../../../../utils");
+const formatting_1 = require("../../../../utils/formatting");
+const validation_1 = require("../../../../utils/validation");
 const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
 class SpoFileListCommand extends SpoCommand_1.default {
@@ -33,20 +34,25 @@ class SpoFileListCommand extends SpoCommand_1.default {
     get description() {
         return 'Lists all available files in the specified folder and site';
     }
-    commandAction(logger, args, cb) {
-        if (this.verbose) {
-            logger.logToStderr(`Retrieving all files in folder ${args.options.folder} at site ${args.options.webUrl}...`);
-        }
-        this.getFiles(args.options.folder, args).then((files) => {
-            logger.log(files.value);
-            cb();
-        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    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}...`);
+            }
+            try {
+                const files = yield this.getFiles(args.options.folder, args);
+                logger.log(files.value);
+            }
+            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('${utils_1.formatting.encodeQueryParameter(folderUrl)}')?$expand=${expandParameters}`;
+        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';
         }
@@ -89,7 +95,7 @@ _SpoFileListCommand_instances = new WeakSet(), _SpoFileListCommand_initTelemetry
         option: '-r, --recursive'
     });
 }, _SpoFileListCommand_initValidators = function _SpoFileListCommand_initValidators() {
-    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () { return utils_1.validation.isValidSharePointUrl(args.options.webUrl); }));
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () { return validation_1.validation.isValidSharePointUrl(args.options.webUrl); }));
 };
 module.exports = new SpoFileListCommand();
 //# sourceMappingURL=file-list.js.map