@pnp/cli-microsoft365 5.0.0-beta.aff293c → 5.0.0-beta.c4100fe

package/dist/m365/spo/commands/group/group-user-add.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const cli_1 = require("../../../../cli");
 const Command_1 = require("../../../../Command");
 const request_1 = require("../../../../request");
-const SpoCommand_1 = require("../../../base/SpoCommand");
 const AadUserGetCommand = require("../../../aad/commands/user/user-get");
+const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
 class SpoGroupUserAddCommand extends SpoCommand_1.default {
     get name() {
@@ -17,15 +17,21 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
         return ['DisplayName', 'Email'];
     }
     commandAction(logger, args, cb) {
-        this.getOnlyActiveUsers(args, logger)
+        let groupId = 0;
+        this
+            .getGroupId(args)
+            .then((_groupId) => {
+            groupId = _groupId;
+            return this.getValidUsers(args, logger);
+        })
             .then((resolvedUsernameList) => {
             if (this.verbose) {
-                logger.logToStderr(`Start adding Active user/s to SharePoint Group ${args.options.groupId}...`);
+                logger.logToStderr(`Start adding Active user/s to SharePoint Group ${args.options.groupId ? args.options.groupId : args.options.groupName}`);
             }
             const data = {
                 url: args.options.webUrl,
                 peoplePickerInput: this.getFormattedUserList(resolvedUsernameList),
-                roleValue: `group:${args.options.groupId}`
+                roleValue: `group:${groupId}`
             };
             const requestOptions = {
                 url: `${args.options.webUrl}/_api/SP.Web.ShareObject`,
@@ -46,32 +52,66 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
             cb();
         }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
     }
-    getOnlyActiveUsers(args, logger) {
+    getGroupId(args) {
+        const getGroupMethod = args.options.groupName ?
+            `GetByName('${encodeURIComponent(args.options.groupName)}')` :
+            `GetById('${args.options.groupId}')`;
+        const requestOptions = {
+            url: `${args.options.webUrl}/_api/web/sitegroups/${getGroupMethod}`,
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then(response => {
+            const groupId = response.Id;
+            if (!groupId) {
+                return Promise.reject(`The specified group does not exist in the SharePoint site`);
+            }
+            return groupId;
+        });
+    }
+    getValidUsers(args, logger) {
         if (this.verbose) {
-            logger.logToStderr(`Removing Users which are not active from the original list`);
+            logger.logToStderr(`Checking if the specified users exist`);
         }
-        const activeUsernamelist = [];
-        return Promise.all(args.options.userName.split(",").map(singleUsername => {
+        const validUserNames = [];
+        const invalidUserNames = [];
+        const userInfo = args.options.userName ? args.options.userName : args.options.email;
+        return Promise
+            .all(userInfo.split(',').map(singleUserName => {
             const options = {
-                userName: singleUsername.trim(),
                 output: 'json',
                 debug: args.options.debug,
                 verbose: args.options.verbose
             };
-            return cli_1.Cli.executeCommandWithOutput(AadUserGetCommand, { options: Object.assign(Object.assign({}, options), { _: [] }) })
+            if (args.options.userName) {
+                options.userName = singleUserName.trim();
+            }
+            else {
+                options.email = singleUserName.trim();
+            }
+            return cli_1.Cli
+                .executeCommandWithOutput(AadUserGetCommand, { options: Object.assign(Object.assign({}, options), { _: [] }) })
                 .then((getUserGetOutput) => {
                 if (this.debug) {
                     logger.logToStderr(getUserGetOutput.stderr);
                 }
-                activeUsernamelist.push(JSON.parse(getUserGetOutput.stdout).userPrincipalName);
+                validUserNames.push(JSON.parse(getUserGetOutput.stdout).userPrincipalName);
             }, (err) => {
                 if (this.debug) {
                     logger.logToStderr(err.stderr);
                 }
+                invalidUserNames.push(singleUserName);
             });
         }))
             .then(() => {
-            return Promise.resolve(activeUsernamelist);
+            if (invalidUserNames.length > 0) {
+                return Promise.reject(`Users not added to the group because the following users don't exist: ${invalidUserNames.join(', ')}`);
+            }
+            return Promise.resolve(validUserNames);
         });
     }
     getFormattedUserList(activeUserList) {
@@ -86,10 +126,16 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
                 option: '-u, --webUrl <webUrl>'
             },
             {
-                option: '--groupId <groupId>'
+                option: '--groupId [groupId]'
+            },
+            {
+                option: '--groupName [groupName]'
+            },
+            {
+                option: '--userName [userName]'
             },
             {
-                option: '--userName <userName>'
+                option: '--email [email]'
             }
         ];
         const parentOptions = super.options();
@@ -100,8 +146,20 @@ class SpoGroupUserAddCommand extends SpoCommand_1.default {
         if (isValidSharePointUrl !== true) {
             return isValidSharePointUrl;
         }
-        if (typeof args.options.groupId !== 'number') {
-            return `Group Id : ${args.options.groupId} is not a number`;
+        if (!args.options.groupId && !args.options.groupName) {
+            return 'Specify either groupId or groupName';
+        }
+        if (args.options.groupId && args.options.groupName) {
+            return 'Specify either groupId or groupName but not both';
+        }
+        if (!args.options.userName && !args.options.email) {
+            return 'Specify either userName or email';
+        }
+        if (args.options.userName && args.options.email) {
+            return 'Specify either userName or email but not both';
+        }
+        if (args.options.groupId && isNaN(args.options.groupId)) {
+            return `Specified groupId ${args.options.groupId} is not a number`;
         }
         return true;
     }

package/dist/m365/spo/commands/group/group-user-remove.js

@@ -0,0 +1,100 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_1 = require("../../../../cli");
+const request_1 = require("../../../../request");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoGroupUserRemoveCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.GROUP_USER_REMOVE;
+    }
+    get description() {
+        return 'Removes the specified user from a SharePoint group';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.groupId = (!(!args.options.groupId)).toString();
+        telemetryProps.groupName = (!(!args.options.groupName)).toString();
+        telemetryProps.confirm = (!(!args.options.confirm)).toString();
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        const removeUserfromSPGroup = () => {
+            if (this.verbose) {
+                logger.logToStderr(`Removing User with Username ${args.options.userName} from Group: ${args.options.groupId ? args.options.groupId : args.options.groupName}`);
+            }
+            const loginName = `i:0#.f|membership|${args.options.userName}`;
+            const requestUrl = `${args.options.webUrl}/_api/web/sitegroups/${args.options.groupId
+                ? `GetById('${encodeURIComponent(args.options.groupId)}')`
+                : `GetByName('${encodeURIComponent(args.options.groupName)}')`}/users/removeByLoginName(@LoginName)?@LoginName='${encodeURIComponent(loginName)}'`;
+            const requestOptions = {
+                url: requestUrl,
+                headers: {
+                    'accept': 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            request_1.default
+                .post(requestOptions)
+                .then(() => {
+                cb();
+            }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+        };
+        if (args.options.confirm) {
+            if (this.debug) {
+                logger.logToStderr('Confirmation bypassed by entering confirm option. Removing the user from SharePoint Group...');
+            }
+            removeUserfromSPGroup();
+        }
+        else {
+            cli_1.Cli.prompt({
+                type: 'confirm',
+                name: 'continue',
+                default: false,
+                message: `Are you sure you want to remove user User ${args.options.userName} from SharePoint group?`
+            }, (result) => {
+                if (!result.continue) {
+                    cb();
+                }
+                else {
+                    removeUserfromSPGroup();
+                }
+            });
+        }
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --webUrl <webUrl>'
+            },
+            {
+                option: '--groupId [groupId]'
+            },
+            {
+                option: '--groupName [groupName]'
+            },
+            {
+                option: '--userName <userName>'
+            },
+            {
+                option: '--confirm'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (args.options.groupId && args.options.groupName) {
+            return 'Use either "groupName" or "groupId", but not both';
+        }
+        if (!args.options.groupId && !args.options.groupName) {
+            return 'Either "groupName" or "groupId" is required';
+        }
+        if (args.options.groupId && isNaN(args.options.groupId)) {
+            return `Specified "groupId" ${args.options.groupId} is not valid`;
+        }
+        return SpoCommand_1.default.isValidSharePointUrl(args.options.webUrl);
+    }
+}
+module.exports = new SpoGroupUserRemoveCommand();
+//# sourceMappingURL=group-user-remove.js.map

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

@@ -16,6 +16,7 @@ class SpoListGetCommand extends SpoCommand_1.default {
         telemetryProps.id = (!(!args.options.id)).toString();
         telemetryProps.title = (!(!args.options.title)).toString();
         telemetryProps.properties = (!(!args.options.properties)).toString();
+        telemetryProps.withPermissions = typeof args.options.withPermissions !== 'undefined';
         return telemetryProps;
     }
     commandAction(logger, args, cb) {
@@ -29,10 +30,10 @@ class SpoListGetCommand extends SpoCommand_1.default {
         else {
             requestUrl = `${args.options.webUrl}/_api/web/lists/GetByTitle('${encodeURIComponent(args.options.title)}')`;
         }
-        const propertiesSelect = args.options.properties ? `?$select=${encodeURIComponent(args.options.properties)}` : ``;
+        let propertiesSelect = args.options.properties ? `?$select=${encodeURIComponent(args.options.properties)}` : ``;
+        propertiesSelect += args.options.withPermissions ? `${args.options.properties ? '&' : '?'}$expand=HasUniqueRoleAssignments,RoleAssignments/Member,RoleAssignments/RoleDefinitionBindings` : ``;
         const requestOptions = {
             url: requestUrl + propertiesSelect,
-            method: 'GET',
             headers: {
                 'accept': 'application/json;odata=nometadata'
             },
@@ -58,6 +59,9 @@ class SpoListGetCommand extends SpoCommand_1.default {
             },
             {
                 option: '-p, --properties [properties]'
+            },
+            {
+                option: '--withPermissions'
             }
         ];
         const parentOptions = super.options();

package/dist/m365/spo/commands/listitem/listitem-attachment-list.js

@@ -0,0 +1,90 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const Utils_1 = require("../../../../Utils");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoListItemAttachmentListCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.LISTITEM_ATTACHMENT_LIST;
+    }
+    get description() {
+        return 'Gets the attachments associated to a list item';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.listId = typeof args.options.listId !== 'undefined';
+        telemetryProps.listTitle = typeof args.options.listTitle !== 'undefined';
+        return telemetryProps;
+    }
+    defaultProperties() {
+        return ['FileName', 'ServerRelativeUrl'];
+    }
+    commandAction(logger, args, cb) {
+        const listIdArgument = args.options.listId || '';
+        const listTitleArgument = args.options.listTitle || '';
+        const listRestUrl = (args.options.listId ?
+            `${args.options.webUrl}/_api/web/lists(guid'${encodeURIComponent(listIdArgument)}')`
+            : `${args.options.webUrl}/_api/web/lists/getByTitle('${encodeURIComponent(listTitleArgument)}')`);
+        const requestOptions = {
+            url: `${listRestUrl}/items(${args.options.itemId})?$select=AttachmentFiles&$expand=AttachmentFiles`,
+            method: 'GET',
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .get(requestOptions)
+            .then((attachmentFiles) => {
+            if (attachmentFiles.AttachmentFiles && attachmentFiles.AttachmentFiles.length > 0) {
+                logger.log(attachmentFiles.AttachmentFiles);
+            }
+            else {
+                if (this.verbose) {
+                    logger.logToStderr('No attachments found');
+                }
+            }
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --webUrl <webUrl>'
+            },
+            {
+                option: '--itemId <itemId>'
+            },
+            {
+                option: '--listId [listId]'
+            },
+            {
+                option: '--listTitle [listTitle]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        const isValidSharePointUrl = SpoCommand_1.default.isValidSharePointUrl(args.options.webUrl);
+        if (isValidSharePointUrl !== true) {
+            return isValidSharePointUrl;
+        }
+        if (!args.options.listId && !args.options.listTitle) {
+            return `Specify listId or listTitle`;
+        }
+        if (args.options.listId && args.options.listTitle) {
+            return `Specify listId or listTitle but not both`;
+        }
+        if (args.options.listId && !Utils_1.default.isValidGuid(args.options.listId)) {
+            return `${args.options.listId} in option listId is not a valid GUID`;
+        }
+        if (isNaN(parseInt(args.options.itemId))) {
+            return `${args.options.itemId} is not a number`;
+        }
+        return true;
+    }
+}
+module.exports = new SpoListItemAttachmentListCommand();
+//# sourceMappingURL=listitem-attachment-list.js.map

package/dist/m365/spo/commands/page/Page.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Page = void 0;
+exports.Page = exports.supportedPromoteAs = exports.supportedPageLayouts = void 0;
 const request_1 = require("../../../../request");
 const Utils_1 = require("../../../../Utils");
 const clientsidepages_1 = require("./clientsidepages");
 const pageMethods_1 = require("./pageMethods");
+exports.supportedPageLayouts = ['Article', 'Home', 'SingleWebPartAppPage', 'RepostPage', 'HeaderlessSearchResults', 'Spaces', 'Topic'];
+exports.supportedPromoteAs = ['HomePage', 'NewsPage', 'Template'];
 class Page {
     static getPage(name, webUrl, logger, debug, verbose) {
         return new Promise((resolve, reject) => {

package/dist/m365/spo/commands/page/page-add.js

@@ -284,11 +284,11 @@ class SpoPageAddCommand extends SpoCommand_1.default {
             },
             {
                 option: '-l, --layoutType [layoutType]',
-                autocomplete: ['Article', 'Home']
+                autocomplete: Page_1.supportedPageLayouts
             },
             {
                 option: '-p, --promoteAs [promoteAs]',
-                autocomplete: ['HomePage', 'NewsPage', 'Template']
+                autocomplete: Page_1.supportedPromoteAs
             },
             {
                 option: '--commentsEnabled'
@@ -312,20 +312,17 @@ class SpoPageAddCommand extends SpoCommand_1.default {
             return isValidSharePointUrl;
         }
         if (args.options.layoutType &&
-            args.options.layoutType !== 'Article' &&
-            args.options.layoutType !== 'Home') {
-            return `${args.options.layoutType} is not a valid option for layoutType. Allowed values Article|Home`;
+            Page_1.supportedPageLayouts.indexOf(args.options.layoutType) < 0) {
+            return `${args.options.layoutType} is not a valid option for layoutType. Allowed values ${Page_1.supportedPageLayouts.join(', ')}`;
         }
         if (args.options.promoteAs &&
-            args.options.promoteAs !== 'HomePage' &&
-            args.options.promoteAs !== 'NewsPage' &&
-            args.options.promoteAs !== 'Template') {
-            return `${args.options.promoteAs} is not a valid option for promoteAs. Allowed values HomePage|NewsPage|Template`;
+            Page_1.supportedPromoteAs.indexOf(args.options.promoteAs) < 0) {
+            return `${args.options.promoteAs} is not a valid option for promoteAs. Allowed values ${Page_1.supportedPromoteAs.join(', ')}`;
         }
         if (args.options.promoteAs === 'HomePage' && args.options.layoutType !== 'Home') {
             return 'You can only promote home pages as site home page';
         }
-        if (args.options.promoteAs === 'NewsPage' && args.options.layoutType === 'Home') {
+        if (args.options.promoteAs === 'NewsPage' && args.options.layoutType && args.options.layoutType !== 'Article') {
             return 'You can only promote article pages as news article';
         }
         return true;

package/dist/m365/spo/commands/page/page-set.js

@@ -283,11 +283,11 @@ class SpoPageSetCommand extends SpoCommand_1.default {
             },
             {
                 option: '-l, --layoutType [layoutType]',
-                autocomplete: ['Article', 'Home']
+                autocomplete: Page_1.supportedPageLayouts
             },
             {
                 option: '-p, --promoteAs [promoteAs]',
-                autocomplete: ['HomePage', 'NewsPage', 'Template']
+                autocomplete: Page_1.supportedPromoteAs
             },
             {
                 option: '--commentsEnabled [commentsEnabled]',
@@ -315,20 +315,17 @@ class SpoPageSetCommand extends SpoCommand_1.default {
             return isValidSharePointUrl;
         }
         if (args.options.layoutType &&
-            args.options.layoutType !== 'Article' &&
-            args.options.layoutType !== 'Home') {
-            return `${args.options.layoutType} is not a valid option for layoutType. Allowed values Article|Home`;
+            Page_1.supportedPageLayouts.indexOf(args.options.layoutType) < 0) {
+            return `${args.options.layoutType} is not a valid option for layoutType. Allowed values ${Page_1.supportedPageLayouts.join(', ')}`;
         }
         if (args.options.promoteAs &&
-            args.options.promoteAs !== 'HomePage' &&
-            args.options.promoteAs !== 'NewsPage' &&
-            args.options.promoteAs !== 'Template') {
-            return `${args.options.promoteAs} is not a valid option for promoteAs. Allowed values HomePage|NewsPage|Template`;
+            Page_1.supportedPromoteAs.indexOf(args.options.promoteAs) < 0) {
+            return `${args.options.promoteAs} is not a valid option for promoteAs. Allowed values ${Page_1.supportedPromoteAs.join(', ')}`;
         }
         if (args.options.promoteAs === 'HomePage' && args.options.layoutType !== 'Home') {
             return 'You can only promote home pages as site home page';
         }
-        if (args.options.promoteAs === 'NewsPage' && args.options.layoutType === 'Home') {
+        if (args.options.promoteAs === 'NewsPage' && args.options.layoutType && args.options.layoutType !== 'Article') {
             return 'You can only promote article pages as news article';
         }
         if (typeof args.options.commentsEnabled !== 'undefined' &&

package/dist/m365/spo/commands/site/site-ensure.js

@@ -59,7 +59,7 @@ class SpoSiteEnsureCommand extends SpoCommand_1.default {
             if (this.debug) {
                 logger.logToStderr(err.stderr);
             }
-            if (err.error.message !== 'Request failed with status code 404') {
+            if (err.error.message !== '404 FILE NOT FOUND') {
                 return Promise.reject(err);
             }
             if (this.verbose) {

package/dist/m365/spo/commands/site/site-recyclebinitem-list.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoSiteRecycleBinItemListCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.SITE_RECYCLEBINITEM_LIST;
+    }
+    get description() {
+        return 'Lists items from recycle bin';
+    }
+    defaultProperties() {
+        return ['Id', 'Title', 'DirName'];
+    }
+    commandAction(logger, args, cb) {
+        if (this.verbose) {
+            logger.logToStderr(`Retrieving all items from recycle bin at ${args.options.siteUrl}...`);
+        }
+        const state = args.options.secondary ? '2' : '1';
+        let requestUrl = `${args.options.siteUrl}/_api/site/RecycleBin?$filter=(ItemState eq ${state})`;
+        if (typeof args.options.type !== 'undefined') {
+            const type = SpoSiteRecycleBinItemListCommand.recycleBinItemType.find(item => item.value === args.options.type);
+            if (typeof type !== 'undefined') {
+                requestUrl += ` and (ItemType eq ${type.id})`;
+            }
+        }
+        const requestOptions = {
+            url: requestUrl,
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .get(requestOptions)
+            .then((response) => {
+            logger.log(response.value);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --siteUrl <siteUrl>'
+            },
+            {
+                option: '-t, --type [type]',
+                autocomplete: SpoSiteRecycleBinItemListCommand.recycleBinItemType.map(item => item.value)
+            },
+            {
+                option: '-s, --secondary'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        const isValidSharePointUrl = SpoCommand_1.default.isValidSharePointUrl(args.options.siteUrl);
+        if (isValidSharePointUrl !== true) {
+            return isValidSharePointUrl;
+        }
+        if (typeof args.options.type !== 'undefined' &&
+            !SpoSiteRecycleBinItemListCommand.recycleBinItemType.some(item => item.value === args.options.type)) {
+            return `${args.options.type} is not a valid value. Allowed values are ${SpoSiteRecycleBinItemListCommand.recycleBinItemType.map(item => item.value).join(', ')}`;
+        }
+        return true;
+    }
+}
+SpoSiteRecycleBinItemListCommand.recycleBinItemType = [
+    { id: 1, value: 'files' },
+    { id: 3, value: 'listItems' },
+    { id: 5, value: 'folders' }
+];
+module.exports = new SpoSiteRecycleBinItemListCommand();
+//# sourceMappingURL=site-recyclebinitem-list.js.map