@pnp/cli-microsoft365 5.5.0-beta.f0f7ad7 → 5.6.0-beta.18a47a8

package/dist/m365/aad/commands/o365group/o365group-recyclebinitem-restore.js

@@ -14,33 +14,84 @@ class AadO365GroupRecycleBinItemRestoreCommand extends GraphCommand_1.default {
     alias() {
         return [commands_1.default.O365GROUP_RESTORE];
     }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.id = typeof args.options.id !== 'undefined';
+        telemetryProps.displayName = typeof args.options.displayName !== 'undefined';
+        telemetryProps.mailNickname = typeof args.options.mailNickname !== 'undefined';
+        return telemetryProps;
+    }
     commandAction(logger, args, cb) {
         if (this.verbose) {
-            logger.logToStderr(`Restoring Microsoft 365 Group: ${args.options.id}...`);
+            logger.logToStderr(`Restoring Microsoft 365 Group: ${args.options.id || args.options.displayName || args.options.mailNickname}...`);
+        }
+        this
+            .getGroupId(args.options)
+            .then((groupId) => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/directory/deleteditems/${groupId}/restore`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none',
+                    'content-type': 'application/json'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.post(requestOptions);
+        })
+            .then(_ => cb(), (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    getGroupId(options) {
+        const { id, displayName, mailNickname } = options;
+        if (id) {
+            return Promise.resolve(id);
+        }
+        let filterValue = '';
+        if (displayName) {
+            filterValue = `displayName eq '${utils_1.formatting.encodeQueryParameter(displayName)}'`;
+        }
+        if (mailNickname) {
+            filterValue = `mailNickname eq '${utils_1.formatting.encodeQueryParameter(mailNickname)}'`;
         }
         const requestOptions = {
-            url: `${this.resource}/v1.0/directory/deleteditems/${args.options.id}/restore/`,
+            url: `${this.resource}/v1.0/directory/deletedItems/Microsoft.Graph.Group?$filter=${filterValue}`,
             headers: {
-                'accept': 'application/json;odata.metadata=none',
-                'content-type': 'application/json'
+                accept: 'application/json;odata.metadata=none'
             },
             responseType: 'json'
         };
-        request_1.default
-            .post(requestOptions)
-            .then(_ => cb(), (rawRes) => this.handleRejectedODataJsonPromise(rawRes, logger, cb));
+        return request_1.default
+            .get(requestOptions)
+            .then((response) => {
+            const groups = response.value;
+            if (groups.length === 0) {
+                return Promise.reject(`The specified group '${displayName || mailNickname}' does not exist.`);
+            }
+            if (groups.length > 1) {
+                return Promise.reject(`Multiple groups with name '${displayName || mailNickname}' found: ${groups.map(x => x.id).join(',')}.`);
+            }
+            return Promise.resolve(groups[0].id);
+        });
+    }
+    optionSets() {
+        return [['id', 'displayName', 'mailNickname']];
     }
     options() {
         const options = [
             {
-                option: '-i, --id <id>'
+                option: '-i, --id [id]'
+            },
+            {
+                option: '-d, --displayName [displayName]'
+            },
+            {
+                option: '-m, --mailNickname [mailNickname]'
             }
         ];
         const parentOptions = super.options();
         return options.concat(parentOptions);
     }
     validate(args) {
-        if (!utils_1.validation.isValidGuid(args.options.id)) {
+        if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
             return `${args.options.id} is not a valid GUID`;
         }
         return true;

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

@@ -11,6 +11,11 @@ class SpoCustomActionGetCommand extends SpoCommand_1.default {
     get description() {
         return 'Gets details for the specified custom action';
     }
+    optionSets() {
+        return [
+            ['id', 'title']
+        ];
+    }
     getTelemetryProperties(args) {
         const telemetryProps = super.getTelemetryProperties(args);
         telemetryProps.scope = args.options.scope || 'All';
@@ -56,14 +61,34 @@ class SpoCustomActionGetCommand extends SpoCommand_1.default {
         }, (err) => this.handleRejectedPromise(err, logger, cb));
     }
     getCustomAction(options) {
+        const filter = options.id ?
+            `('${encodeURIComponent(options.id)}')` :
+            `?$filter=Title eq '${encodeURIComponent(options.title)}'`;
         const requestOptions = {
-            url: `${options.url}/_api/${options.scope}/UserCustomActions('${encodeURIComponent(options.id)}')`,
+            url: `${options.url}/_api/${options.scope}/UserCustomActions${filter}`,
             headers: {
                 accept: 'application/json;odata=nometadata'
             },
             responseType: 'json'
         };
-        return request_1.default.get(requestOptions);
+        if (options.id) {
+            return request_1.default
+                .get(requestOptions)
+                .then((res) => {
+                return Promise.resolve(res);
+            });
+        }
+        return request_1.default
+            .get(requestOptions)
+            .then((res) => {
+            if (res.value.length === 1) {
+                return Promise.resolve(res.value[0]);
+            }
+            if (res.value.length === 0) {
+                return Promise.reject(`No user custom action with title '${options.title}' found`);
+            }
+            return Promise.reject(`Multiple user custom actions with title '${options.title}' found. Please disambiguate using IDs: ${res.value.map(a => a.Id).join(', ')}`);
+        });
     }
     /**
      * Get request with `web` scope is send first.
@@ -104,7 +129,10 @@ class SpoCustomActionGetCommand extends SpoCommand_1.default {
     options() {
         const options = [
             {
-                option: '-i, --id <id>'
+                option: '-i, --id [id]'
+            },
+            {
+                option: '-t, --title [title]'
             },
             {
                 option: '-u, --url <url>'
@@ -118,7 +146,7 @@ class SpoCustomActionGetCommand extends SpoCommand_1.default {
         return options.concat(parentOptions);
     }
     validate(args) {
-        if (utils_1.validation.isValidGuid(args.options.id) === false) {
+        if (args.options.id && utils_1.validation.isValidGuid(args.options.id) === false) {
             return `${args.options.id} is not valid. Custom action id (Guid) expected.`;
         }
         if (utils_1.validation.isValidSharePointUrl(args.options.url) !== true) {

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

@@ -12,6 +12,11 @@ class SpoCustomActionRemoveCommand extends SpoCommand_1.default {
     get description() {
         return 'Removes the specified custom action';
     }
+    optionSets() {
+        return [
+            ['id', 'title']
+        ];
+    }
     getTelemetryProperties(args) {
         const telemetryProps = super.getTelemetryProperties(args);
         telemetryProps.scope = args.options.scope || 'All';
@@ -54,16 +59,43 @@ class SpoCustomActionRemoveCommand extends SpoCommand_1.default {
             });
         }
     }
-    removeScopedCustomAction(options) {
-        const requestOptions = {
-            url: `${options.url}/_api/${options.scope}/UserCustomActions('${encodeURIComponent(options.id)}')`,
+    getCustomActionId(options) {
+        if (options.id) {
+            return Promise.resolve(options.id);
+        }
+        const customActionRequestOptions = {
+            url: `${options.url}/_api/${options.scope}/UserCustomActions?$filter=Title eq '${encodeURIComponent(options.title)}'`,
             headers: {
-                accept: 'application/json;odata=nometadata',
-                'X-HTTP-Method': 'DELETE'
+                accept: 'application/json;odata=nometadata'
             },
             responseType: 'json'
         };
-        return request_1.default.post(requestOptions);
+        return request_1.default
+            .get(customActionRequestOptions)
+            .then((res) => {
+            if (res.value.length === 1) {
+                return Promise.resolve(res.value[0].Id);
+            }
+            if (res.value.length === 0) {
+                return Promise.reject(`No user custom action with title '${options.title}' found`);
+            }
+            return Promise.reject(`Multiple user custom actions with title '${options.title}' found. Please disambiguate using IDs: ${res.value.map(a => a.Id).join(', ')}`);
+        });
+    }
+    removeScopedCustomAction(options) {
+        return this
+            .getCustomActionId(options)
+            .then((customActionId) => {
+            const requestOptions = {
+                url: `${options.url}/_api/${options.scope}/UserCustomActions('${encodeURIComponent(customActionId)}')')`,
+                headers: {
+                    accept: 'application/json;odata=nometadata',
+                    'X-HTTP-Method': 'DELETE'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.post(requestOptions);
+        });
     }
     /**
      * Remove request with `web` scope is send first.
@@ -95,7 +127,10 @@ class SpoCustomActionRemoveCommand extends SpoCommand_1.default {
     options() {
         const options = [
             {
-                option: '-i, --id <id>'
+                option: '-i, --id [id]'
+            },
+            {
+                option: '-t, --title [title]'
             },
             {
                 option: '-u, --url <url>'
@@ -112,7 +147,7 @@ class SpoCustomActionRemoveCommand extends SpoCommand_1.default {
         return options.concat(parentOptions);
     }
     validate(args) {
-        if (utils_1.validation.isValidGuid(args.options.id) === false) {
+        if (args.options.id && utils_1.validation.isValidGuid(args.options.id) === false) {
             return `${args.options.id} is not valid. Custom action Id (GUID) expected.`;
         }
         if (utils_1.validation.isValidSharePointUrl(args.options.url) !== true) {

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

@@ -17,10 +17,19 @@ class SpoFieldGetCommand extends SpoCommand_1.default {
         telemetryProps.listTitle = typeof args.options.listTitle !== 'undefined';
         telemetryProps.listUrl = typeof args.options.listUrl !== 'undefined';
         telemetryProps.id = typeof args.options.id !== 'undefined';
-        telemetryProps.fieldTitle = typeof args.options.fieldTitle !== 'undefined';
+        telemetryProps.title = typeof args.options.title !== 'undefined';
         return telemetryProps;
     }
+    optionSets() {
+        return [
+            ['id', 'title', 'fieldTitle']
+        ];
+    }
     commandAction(logger, args, cb) {
+        if (args.options.fieldTitle) {
+            args.options.title = args.options.fieldTitle;
+            this.warn(logger, `Option 'fieldTitle' is deprecated. Please use 'title' instead.`);
+        }
         let listRestUrl = '';
         if (args.options.listId) {
             listRestUrl = `lists(guid'${utils_1.formatting.encodeQueryParameter(args.options.listId)}')/`;
@@ -37,7 +46,7 @@ class SpoFieldGetCommand extends SpoCommand_1.default {
             fieldRestUrl = `/getbyid('${utils_1.formatting.encodeQueryParameter(args.options.id)}')`;
         }
         else {
-            fieldRestUrl = `/getbyinternalnameortitle('${utils_1.formatting.encodeQueryParameter(args.options.fieldTitle)}')`;
+            fieldRestUrl = `/getbyinternalnameortitle('${utils_1.formatting.encodeQueryParameter(args.options.title)}')`;
         }
         const requestOptions = {
             url: `${args.options.webUrl}/_api/web/${listRestUrl}fields${fieldRestUrl}`,
@@ -72,6 +81,9 @@ class SpoFieldGetCommand extends SpoCommand_1.default {
             },
             {
                 option: '--fieldTitle [fieldTitle]'
+            },
+            {
+                option: '-t, --title [title]'
             }
         ];
         const parentOptions = super.options();
@@ -82,9 +94,6 @@ class SpoFieldGetCommand extends SpoCommand_1.default {
         if (isValidSharePointUrl !== true) {
             return isValidSharePointUrl;
         }
-        if (!args.options.id && !args.options.fieldTitle) {
-            return 'Specify id or fieldTitle, one is required';
-        }
         if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
             return `${args.options.id} is not a valid GUID`;
         }

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

@@ -19,11 +19,20 @@ class SpoFieldRemoveCommand extends SpoCommand_1.default {
         telemetryProps.listUrl = typeof args.options.listUrl !== 'undefined';
         telemetryProps.id = typeof args.options.id !== 'undefined';
         telemetryProps.group = typeof args.options.group !== 'undefined';
-        telemetryProps.fieldTitle = typeof args.options.fieldTitle !== 'undefined';
+        telemetryProps.title = typeof args.options.title !== 'undefined';
         telemetryProps.confirm = (!(!args.options.confirm)).toString();
         return telemetryProps;
     }
+    optionSets() {
+        return [
+            ['id', 'title', 'fieldTitle', 'group']
+        ];
+    }
     commandAction(logger, args, cb) {
+        if (args.options.fieldTitle) {
+            args.options.title = args.options.fieldTitle;
+            this.warn(logger, `Option 'fieldTitle' is deprecated. Please use 'title' instead.`);
+        }
         let messageEnd;
         if (args.options.listId || args.options.listTitle) {
             messageEnd = `in list ${args.options.listId || args.options.listTitle}`;
@@ -31,16 +40,16 @@ class SpoFieldRemoveCommand extends SpoCommand_1.default {
         else {
             messageEnd = `in site ${args.options.webUrl}`;
         }
-        const removeField = (listRestUrl, fieldId, fieldTitle) => {
+        const removeField = (listRestUrl, fieldId, title) => {
             if (this.verbose) {
-                logger.logToStderr(`Removing field ${fieldId || fieldTitle} ${messageEnd}...`);
+                logger.logToStderr(`Removing field ${fieldId || title} ${messageEnd}...`);
             }
             let fieldRestUrl = '';
             if (fieldId) {
                 fieldRestUrl = `/getbyid('${utils_1.formatting.encodeQueryParameter(fieldId)}')`;
             }
             else {
-                fieldRestUrl = `/getbyinternalnameortitle('${utils_1.formatting.encodeQueryParameter(fieldTitle)}')`;
+                fieldRestUrl = `/getbyinternalnameortitle('${utils_1.formatting.encodeQueryParameter(title)}')`;
             }
             const requestOptions = {
                 url: `${args.options.webUrl}/_api/web/${listRestUrl}fields${fieldRestUrl}`,
@@ -97,7 +106,7 @@ class SpoFieldRemoveCommand extends SpoCommand_1.default {
                 }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
             }
             else {
-                removeField(listRestUrl, args.options.id, args.options.fieldTitle)
+                removeField(listRestUrl, args.options.id, args.options.title)
                     .then(() => {
                     // REST post call doesn't return anything
                     cb();
@@ -108,7 +117,7 @@ class SpoFieldRemoveCommand extends SpoCommand_1.default {
             prepareRemoval();
         }
         else {
-            const confirmMessage = `Are you sure you want to remove the ${args.options.group ? 'fields' : 'field'} ${args.options.id || args.options.fieldTitle || 'from group ' + args.options.group} ${messageEnd}?`;
+            const confirmMessage = `Are you sure you want to remove the ${args.options.group ? 'fields' : 'field'} ${args.options.id || args.options.title || 'from group ' + args.options.group} ${messageEnd}?`;
             cli_1.Cli.prompt({
                 type: 'confirm',
                 name: 'continue',
@@ -142,7 +151,10 @@ class SpoFieldRemoveCommand extends SpoCommand_1.default {
                 option: '-i, --id [id]'
             },
             {
-                option: '-t, --fieldTitle [fieldTitle]'
+                option: '--fieldTitle [fieldTitle]'
+            },
+            {
+                option: '-t, --title [title]'
             },
             {
                 option: '-g, --group [group]'
@@ -159,9 +171,6 @@ class SpoFieldRemoveCommand extends SpoCommand_1.default {
         if (isValidSharePointUrl !== true) {
             return isValidSharePointUrl;
         }
-        if (!args.options.id && !args.options.fieldTitle && !args.options.group) {
-            return 'Specify id, fieldTitle, or group. One is required';
-        }
         if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
             return `${args.options.id} is not a valid GUID`;
         }

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

@@ -16,6 +16,7 @@ class SpoFieldSetCommand extends SpoCommand_1.default {
     getTelemetryProperties(args) {
         const telemetryProps = super.getTelemetryProperties(args);
         telemetryProps.id = typeof args.options.id !== 'undefined';
+        telemetryProps.title = typeof args.options.title !== 'undefined';
         telemetryProps.name = typeof args.options.name !== 'undefined';
         telemetryProps.listId = typeof args.options.listId !== 'undefined';
         telemetryProps.listTitle = typeof args.options.listTitle !== 'undefined';
@@ -26,6 +27,9 @@ class SpoFieldSetCommand extends SpoCommand_1.default {
         return true;
     }
     commandAction(logger, args, cb) {
+        if (args.options.name) {
+            this.warn(logger, `Option 'name' is deprecated. Please use 'title' instead.`);
+        }
         let requestDigest = '';
         utils_1.spo
             .getRequestDigest(args.options.webUrl)
@@ -61,7 +65,7 @@ class SpoFieldSetCommand extends SpoCommand_1.default {
             // retrieve column CSOM object id
             const fieldQuery = args.options.id ?
                 `<Method Id="663" ParentId="7" Name="GetById"><Parameters><Parameter Type="Guid">${utils_1.formatting.escapeXml(args.options.id)}</Parameter></Parameters></Method>` :
-                `<Method Id="663" ParentId="7" Name="GetByInternalNameOrTitle"><Parameters><Parameter Type="String">${utils_1.formatting.escapeXml(args.options.name)}</Parameter></Parameters></Method>`;
+                `<Method Id="663" ParentId="7" Name="GetByInternalNameOrTitle"><Parameters><Parameter Type="String">${utils_1.formatting.escapeXml(args.options.name || args.options.title)}</Parameter></Parameters></Method>`;
             const requestOptions = {
                 url: `${args.options.webUrl}/_vti_bin/client.svc/ProcessQuery`,
                 headers: {
@@ -105,6 +109,7 @@ class SpoFieldSetCommand extends SpoCommand_1.default {
             'listTitle',
             'id',
             'name',
+            'title',
             'updateExistingLists',
             'debug',
             'verbose',
@@ -116,6 +121,11 @@ class SpoFieldSetCommand extends SpoCommand_1.default {
         }).join('');
         return payload;
     }
+    optionSets() {
+        return [
+            ['id', 'title', 'name']
+        ];
+    }
     options() {
         const options = [
             {
@@ -128,10 +138,13 @@ class SpoFieldSetCommand extends SpoCommand_1.default {
                 option: '--listTitle [listTitle]'
             },
             {
-                option: '-i|--id [id]'
+                option: '-i, --id [id]'
             },
             {
-                option: '-n|--name [name]'
+                option: '-n, --name [name]'
+            },
+            {
+                option: '-t, --title [title]'
             },
             {
                 option: '--updateExistingLists'
@@ -152,12 +165,6 @@ class SpoFieldSetCommand extends SpoCommand_1.default {
             !utils_1.validation.isValidGuid(args.options.listId)) {
             return `${args.options.listId} in option listId is not a valid GUID`;
         }
-        if (!args.options.id && !args.options.name) {
-            return `Specify id or name`;
-        }
-        if (args.options.id && args.options.name) {
-            return `Specify viewId or viewTitle but not both`;
-        }
         if (args.options.id &&
             !utils_1.validation.isValidGuid(args.options.id)) {
             return `${args.options.id} in option id is not a valid GUID`;

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

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../../../../utils");
+const request_1 = require("../../../../request");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoGroupAddCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.GROUP_ADD;
+    }
+    get description() {
+        return 'Creates group in the specified site';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.description = typeof args.options.description !== 'undefined';
+        telemetryProps.allowMembersEditMembership = typeof args.options.allowMembersEditMembership !== 'undefined';
+        telemetryProps.onlyAllowMembersViewMembership = typeof args.options.onlyAllowMembersViewMembership !== 'undefined';
+        telemetryProps.allowRequestToJoinLeave = typeof args.options.allowRequestToJoinLeave !== 'undefined';
+        telemetryProps.autoAcceptRequestToJoinLeave = typeof args.options.autoAcceptRequestToJoinLeave !== 'undefined';
+        telemetryProps.requestToJoinLeaveEmailSetting = typeof args.options.requestToJoinLeaveEmailSetting !== 'undefined';
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        const requestOptions = {
+            url: `${args.options.webUrl}/_api/web/sitegroups`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json',
+            data: {
+                Title: args.options.name,
+                Description: args.options.description,
+                AllowMembersEditMembership: args.options.allowMembersEditMembership,
+                OnlyAllowMembersViewMembership: args.options.onlyAllowMembersViewMembership,
+                AllowRequestToJoinLeave: args.options.allowRequestToJoinLeave,
+                AutoAcceptRequestToJoinLeave: args.options.autoAcceptRequestToJoinLeave,
+                RequestToJoinLeaveEmailSetting: args.options.requestToJoinLeaveEmailSetting
+            }
+        };
+        request_1.default
+            .post(requestOptions)
+            .then((response) => {
+            logger.log(response);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --webUrl <webUrl>'
+            },
+            {
+                option: '-n, --name <name>'
+            },
+            {
+                option: '--description [description]'
+            },
+            {
+                option: '--allowMembersEditMembership [allowMembersEditMembership]'
+            },
+            {
+                option: '--onlyAllowMembersViewMembership [onlyAllowMembersViewMembership]'
+            },
+            {
+                option: '--allowRequestToJoinLeave [allowRequestToJoinLeave]'
+            },
+            {
+                option: '--autoAcceptRequestToJoinLeave [autoAcceptRequestToJoinLeave]'
+            },
+            {
+                option: '--requestToJoinLeaveEmailSetting [requestToJoinLeaveEmailSetting]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        const isValidSharePointUrl = utils_1.validation.isValidSharePointUrl(args.options.webUrl);
+        if (isValidSharePointUrl !== true) {
+            return isValidSharePointUrl;
+        }
+        const booleanOptions = [
+            args.options.allowMembersEditMembership, args.options.onlyAllowMembersViewMembership,
+            args.options.allowRequestToJoinLeave, args.options.autoAcceptRequestToJoinLeave
+        ];
+        for (const option of booleanOptions) {
+            if (typeof option !== 'undefined' && !utils_1.validation.isValidBoolean(option)) {
+                return `Value '${option}' is not a valid boolean`;
+            }
+        }
+        return true;
+    }
+}
+module.exports = new SpoGroupAddCommand();
+//# sourceMappingURL=group-add.js.map