@pnp/cli-microsoft365 5.8.0-beta.bc15f2b → 5.8.0-beta.c1d5041

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

@@ -39,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() {

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

@@ -33,14 +33,19 @@ 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: [] }) {

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

@@ -37,71 +37,69 @@ class SpoFileMoveCommand 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);
-            }
-            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,
-                        "IsMoveMode": true
-                    }
-                },
-                responseType: 'json'
-            };
-            return request_1.default.post(requestOptions);
-        })
-            .then((jobInfo) => {
-            return new Promise((resolve, reject) => {
+    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.
+                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 = 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,
+                            "IsMoveMode": true
+                        }
+                    },
+                    responseType: 'json'
+                };
+                const jobInfo = yield request_1.default.post(requestOptions);
                 this.dots = '';
                 const copyJobInfo = jobInfo.value[0];
                 const progressPollInterval = 1800; // 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));
+                yield new Promise((resolve, reject) => {
+                    setTimeout(() => {
+                        utils_1.spo.waitUntilCopyJobFinished({
+                            copyJobInfo,
+                            siteUrl: webUrl,
+                            pollingInterval: progressPollInterval,
+                            resolve,
+                            reject,
+                            logger,
+                            dots: this.dots,
+                            debug: this.debug,
+                            verbose: this.verbose
+                        });
+                    }, progressPollInterval);
+                });
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        });
     }
     /**
      * Checks if a file exists on the server relative url

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

@@ -38,67 +38,65 @@ class SpoFileRemoveCommand extends SpoCommand_1.default {
     getExcludedOptionsWithUrls() {
         return ['url'];
     }
-    commandAction(logger, args, cb) {
-        const removeFile = () => {
-            if (this.verbose) {
-                logger.logToStderr(`Removing file in site at ${args.options.webUrl}...`);
-            }
-            let requestUrl = '';
-            if (args.options.id) {
-                requestUrl = `${args.options.webUrl}/_api/web/GetFileById(guid'${encodeURIComponent(args.options.id)}')`;
-            }
-            else {
-                // concatenate trailing '/' if not provided
-                // so if the provided url is for the root site, the substr bellow will get the right value
-                let serverRelativeSiteUrl = args.options.webUrl;
-                if (!serverRelativeSiteUrl.endsWith('/')) {
-                    serverRelativeSiteUrl = `${serverRelativeSiteUrl}/`;
-                }
-                serverRelativeSiteUrl = serverRelativeSiteUrl.substr(serverRelativeSiteUrl.indexOf('/', 8));
-                let fileUrl = args.options.url;
-                if (!fileUrl.startsWith(serverRelativeSiteUrl)) {
-                    fileUrl = `${serverRelativeSiteUrl}${fileUrl}`;
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const removeFile = () => __awaiter(this, void 0, void 0, function* () {
+                if (this.verbose) {
+                    logger.logToStderr(`Removing file in site at ${args.options.webUrl}...`);
                 }
-                requestUrl = `${args.options.webUrl}/_api/web/GetFileByServerRelativeUrl('${encodeURIComponent(fileUrl)}')`;
-            }
-            if (args.options.recycle) {
-                requestUrl += `/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(() => {
-                // REST post call doesn't return anything
-                cb();
-            }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
-        };
-        if (args.options.confirm) {
-            removeFile();
-        }
-        else {
-            cli_1.Cli.prompt({
-                type: 'confirm',
-                name: 'continue',
-                default: false,
-                message: `Are you sure you want to ${args.options.recycle ? "recycle" : "remove"} the file ${args.options.id || args.options.url} located in site ${args.options.webUrl}?`
-            }, (result) => {
-                if (!result.continue) {
-                    cb();
+                let requestUrl = '';
+                if (args.options.id) {
+                    requestUrl = `${args.options.webUrl}/_api/web/GetFileById(guid'${encodeURIComponent(args.options.id)}')`;
                 }
                 else {
-                    removeFile();
+                    // concatenate trailing '/' if not provided
+                    // so if the provided url is for the root site, the substr bellow will get the right value
+                    let serverRelativeSiteUrl = args.options.webUrl;
+                    if (!serverRelativeSiteUrl.endsWith('/')) {
+                        serverRelativeSiteUrl = `${serverRelativeSiteUrl}/`;
+                    }
+                    serverRelativeSiteUrl = serverRelativeSiteUrl.substr(serverRelativeSiteUrl.indexOf('/', 8));
+                    let fileUrl = args.options.url;
+                    if (!fileUrl.startsWith(serverRelativeSiteUrl)) {
+                        fileUrl = `${serverRelativeSiteUrl}${fileUrl}`;
+                    }
+                    requestUrl = `${args.options.webUrl}/_api/web/GetFileByServerRelativeUrl('${encodeURIComponent(fileUrl)}')`;
+                }
+                if (args.options.recycle) {
+                    requestUrl += `/recycle()`;
+                }
+                const requestOptions = {
+                    url: requestUrl,
+                    method: 'POST',
+                    headers: {
+                        'X-HTTP-Method': 'DELETE',
+                        'If-Match': '*',
+                        'accept': 'application/json;odata=nometadata'
+                    },
+                    responseType: 'json'
+                };
+                try {
+                    yield request_1.default.post(requestOptions);
+                }
+                catch (err) {
+                    this.handleRejectedODataJsonPromise(err);
                 }
             });
-        }
+            if (args.options.confirm) {
+                yield removeFile();
+            }
+            else {
+                const result = yield cli_1.Cli.prompt({
+                    type: 'confirm',
+                    name: 'continue',
+                    default: false,
+                    message: `Are you sure you want to ${args.options.recycle ? "recycle" : "remove"} the file ${args.options.id || args.options.url} located in site ${args.options.webUrl}?`
+                });
+                if (result.continue) {
+                    yield removeFile();
+                }
+            }
+        });
     }
 }
 _SpoFileRemoveCommand_instances = new WeakSet(), _SpoFileRemoveCommand_initTelemetry = function _SpoFileRemoveCommand_initTelemetry() {

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

@@ -35,38 +35,36 @@ class SpoFileRenameCommand extends SpoCommand_1.default {
     get description() {
         return 'Renames a file';
     }
-    commandAction(logger, args, cb) {
-        const webUrl = args.options.webUrl;
-        const originalFileServerRelativeUrl = utils_1.urlUtil.getServerRelativePath(args.options.webUrl, args.options.sourceUrl);
-        this
-            .getFile(originalFileServerRelativeUrl, webUrl)
-            .then((_) => {
-            if (args.options.force) {
-                return this.deleteFile(webUrl, args.options.sourceUrl, args.options.targetFileName);
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const webUrl = args.options.webUrl;
+            const originalFileServerRelativeUrl = utils_1.urlUtil.getServerRelativePath(args.options.webUrl, args.options.sourceUrl);
+            try {
+                yield this.getFile(originalFileServerRelativeUrl, webUrl);
+                if (args.options.force) {
+                    yield this.deleteFile(webUrl, args.options.sourceUrl, args.options.targetFileName);
+                }
+                const requestBody = {
+                    formValues: [{
+                            FieldName: 'FileLeafRef',
+                            FieldValue: args.options.targetFileName
+                        }]
+                };
+                const requestOptions = {
+                    url: `${webUrl}/_api/web/GetFileByServerRelativeUrl('${encodeURIComponent(originalFileServerRelativeUrl)}')/ListItemAllFields/ValidateUpdateListItem()`,
+                    headers: {
+                        'accept': 'application/json;odata=nometadata'
+                    },
+                    data: requestBody,
+                    responseType: 'json'
+                };
+                const resp = yield request_1.default.post(requestOptions);
+                logger.log(resp.value);
             }
-            return Promise.resolve();
-        })
-            .then(_ => {
-            const requestBody = {
-                formValues: [{
-                        FieldName: 'FileLeafRef',
-                        FieldValue: args.options.targetFileName
-                    }]
-            };
-            const requestOptions = {
-                url: `${webUrl}/_api/web/GetFileByServerRelativeUrl('${encodeURIComponent(originalFileServerRelativeUrl)}')/ListItemAllFields/ValidateUpdateListItem()`,
-                headers: {
-                    'accept': 'application/json;odata=nometadata'
-                },
-                data: requestBody,
-                responseType: 'json'
-            };
-            return request_1.default.post(requestOptions);
-        })
-            .then((resp) => {
-            logger.log(resp.value);
-            cb();
-        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        });
     }
     getFile(originalFileServerRelativeUrl, webUrl) {
         const requestUrl = `${webUrl}/_api/web/GetFileByServerRelativeUrl('${encodeURIComponent(originalFileServerRelativeUrl)}')?$select=UniqueId`;

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

@@ -38,55 +38,57 @@ class SpoFileSharinginfoGetCommand extends SpoCommand_1.default {
     getExcludedOptionsWithUrls() {
         return ['url'];
     }
-    commandAction(logger, args, cb) {
-        if (this.verbose) {
-            logger.logToStderr(`Retrieving sharing information report for the file...`);
-        }
-        this
-            .getNeededFileInformation(args)
-            .then((fileInformation) => {
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
             if (this.verbose) {
-                logger.logToStderr(`Retrieving sharing information report for the file with item Id  ${fileInformation.fileItemId}`);
-            }
-            const requestOptions = {
-                url: `${args.options.webUrl}/_api/web/lists/getbytitle('${utils_1.formatting.encodeQueryParameter(fileInformation.libraryName)}')/items(${fileInformation.fileItemId})/GetSharingInformation?$select=permissionsInformation&$Expand=permissionsInformation`,
-                headers: {
-                    'accept': 'application/json;odata=nometadata'
-                },
-                responseType: 'json'
-            };
-            return request_1.default.post(requestOptions);
-        }).then((res) => {
-            // typically, we don't do this, but in this case, we need to due to
-            // the complexity of the retrieved object and the fact that we can't
-            // use the generic way of simplifying the output
-            if (args.options.output === 'json') {
-                logger.log(res);
+                logger.logToStderr(`Retrieving sharing information report for the file...`);
             }
-            else {
-                const fileSharingInfoCollection = [];
-                res.permissionsInformation.links.forEach(link => {
-                    link.linkDetails.Invitations.forEach(linkInvite => {
-                        fileSharingInfoCollection.push({
-                            SharedWith: linkInvite.invitee.name,
-                            IsActive: linkInvite.invitee.isActive,
-                            IsExternal: linkInvite.invitee.isExternal,
-                            PrincipalType: FileSharingPrincipalType_1.FileSharingPrincipalType[parseInt(linkInvite.invitee.principalType)]
+            try {
+                const fileInformation = yield this.getNeededFileInformation(args);
+                if (this.verbose) {
+                    logger.logToStderr(`Retrieving sharing information report for the file with item Id  ${fileInformation.fileItemId}`);
+                }
+                const requestOptions = {
+                    url: `${args.options.webUrl}/_api/web/lists/getbytitle('${utils_1.formatting.encodeQueryParameter(fileInformation.libraryName)}')/items(${fileInformation.fileItemId})/GetSharingInformation?$select=permissionsInformation&$Expand=permissionsInformation`,
+                    headers: {
+                        'accept': 'application/json;odata=nometadata'
+                    },
+                    responseType: 'json'
+                };
+                const res = yield request_1.default.post(requestOptions);
+                // typically, we don't do this, but in this case, we need to due to
+                // the complexity of the retrieved object and the fact that we can't
+                // use the generic way of simplifying the output
+                if (args.options.output === 'json') {
+                    logger.log(res);
+                }
+                else {
+                    const fileSharingInfoCollection = [];
+                    res.permissionsInformation.links.forEach(link => {
+                        link.linkDetails.Invitations.forEach(linkInvite => {
+                            fileSharingInfoCollection.push({
+                                SharedWith: linkInvite.invitee.name,
+                                IsActive: linkInvite.invitee.isActive,
+                                IsExternal: linkInvite.invitee.isExternal,
+                                PrincipalType: FileSharingPrincipalType_1.FileSharingPrincipalType[parseInt(linkInvite.invitee.principalType)]
+                            });
                         });
                     });
-                });
-                res.permissionsInformation.principals.forEach(principal => {
-                    fileSharingInfoCollection.push({
-                        SharedWith: principal.principal.name,
-                        IsActive: principal.principal.isActive,
-                        IsExternal: principal.principal.isExternal,
-                        PrincipalType: FileSharingPrincipalType_1.FileSharingPrincipalType[parseInt(principal.principal.principalType)]
+                    res.permissionsInformation.principals.forEach(principal => {
+                        fileSharingInfoCollection.push({
+                            SharedWith: principal.principal.name,
+                            IsActive: principal.principal.isActive,
+                            IsExternal: principal.principal.isExternal,
+                            PrincipalType: FileSharingPrincipalType_1.FileSharingPrincipalType[parseInt(principal.principal.principalType)]
+                        });
                     });
-                });
-                logger.log(fileSharingInfoCollection);
+                    logger.log(fileSharingInfoCollection);
+                }
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
             }
-            cb();
-        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+        });
     }
     getNeededFileInformation(args) {
         let requestUrl = '';