@pnp/cli-microsoft365 6.0.0-beta.a644c64 → 6.0.0-beta.d4d33ed

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/list/list-list.js

@@ -14,18 +14,12 @@ class SpoListListCommand extends SpoCommand_1.default {
     defaultProperties() {
         return ['Title', 'Url', 'Id'];
     }
-    getTelemetryProperties(args) {
-        const telemetryProps = super.getTelemetryProperties(args);
-        telemetryProps.executeWithLimitedPermissions = !!args.options.executeWithLimitedPermissions;
-        return telemetryProps;
-    }
     commandAction(logger, args, cb) {
         if (this.verbose) {
             logger.logToStderr(`Retrieving all lists in site at ${args.options.webUrl}...`);
         }
-        const suffix = args.options.executeWithLimitedPermissions ? '&$select=RootFolder/ServerRelativeUrl,*' : '';
         const requestOptions = {
-            url: `${args.options.webUrl}/_api/web/lists?$expand=RootFolder${suffix}`,
+            url: `${args.options.webUrl}/_api/web/lists?$expand=RootFolder&$select=RootFolder/ServerRelativeUrl,*`,
             method: 'GET',
             headers: {
                 'accept': 'application/json;odata=nometadata'
@@ -46,9 +40,6 @@ class SpoListListCommand extends SpoCommand_1.default {
         const options = [
             {
                 option: '-u, --webUrl <webUrl>'
-            },
-            {
-                option: '--executeWithLimitedPermissions'
             }
         ];
         const parentOptions = super.options();

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

@@ -10,22 +10,25 @@ class SpoSiteListCommand extends SpoCommand_1.default {
         return commands_1.default.SITE_LIST;
     }
     get description() {
-        return 'Lists modern sites of the given type';
+        return 'Lists sites of the given type';
     }
     getTelemetryProperties(args) {
         const telemetryProps = super.getTelemetryProperties(args);
-        telemetryProps.siteType = args.options.type || 'TeamSite';
+        telemetryProps.webTemplate = args.options.webTemplate;
         telemetryProps.filter = (!(!args.options.filter)).toString();
-        telemetryProps.deleted = args.options.deleted;
+        telemetryProps.includeOneDriveSites = typeof args.options.includeOneDriveSites !== 'undefined';
+        telemetryProps.deleted = typeof args.options.deleted !== 'undefined';
+        telemetryProps.siteType = args.options.type;
         return telemetryProps;
     }
     defaultProperties() {
         return ['Title', 'Url'];
     }
     commandAction(logger, args, cb) {
-        const siteType = args.options.type || 'TeamSite';
-        const webTemplate = siteType === 'TeamSite' ? 'GROUP#0' : 'SITEPAGEPUBLISHING#0';
-        let spoAdminUrl;
+        const webTemplate = this.getWebTemplateId(args.options);
+        const includeOneDriveSites = args.options.includeOneDriveSites || false;
+        const personalSite = includeOneDriveSites === false ? '0' : '1';
+        let spoAdminUrl = '';
         utils_1.spo
             .getSpoAdminUrl(logger, this.debug)
             .then((_spoAdminUrl) => {
@@ -34,19 +37,19 @@ class SpoSiteListCommand extends SpoCommand_1.default {
                 logger.logToStderr(`Retrieving list of site collections...`);
             }
             this.allSites = [];
-            return this.getAllSites(spoAdminUrl, utils_1.formatting.escapeXml(args.options.filter || ''), '0', webTemplate, undefined, args.options.deleted, logger);
+            return this.getAllSites(spoAdminUrl, utils_1.formatting.escapeXml(args.options.filter || ''), '0', personalSite, webTemplate, undefined, args.options.deleted, logger);
         })
             .then(_ => {
             logger.log(this.allSites);
             cb();
         }, (err) => this.handleRejectedPromise(err, logger, cb));
     }
-    getAllSites(spoAdminUrl, filter, startIndex, webTemplate, formDigest, deleted, logger) {
+    getAllSites(spoAdminUrl, filter, startIndex, personalSite, webTemplate, formDigest, deleted, logger) {
         return new Promise((resolve, reject) => {
             utils_1.spo
                 .ensureFormDigest(spoAdminUrl, logger, formDigest, this.debug)
                 .then((res) => {
-                let requestBody = `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config_1.default.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="2" ObjectPathId="1" /><ObjectPath Id="4" ObjectPathId="3" /><Query Id="5" ObjectPathId="3"><Query SelectAllProperties="true"><Properties /></Query><ChildItemQuery SelectAllProperties="true"><Properties /></ChildItemQuery></Query></Actions><ObjectPaths><Constructor Id="1" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="3" ParentId="1" Name="GetSitePropertiesFromSharePointByFilters"><Parameters><Parameter TypeId="{b92aeee2-c92c-4b67-abcc-024e471bc140}"><Property Name="Filter" Type="String">${filter}</Property><Property Name="IncludeDetail" Type="Boolean">false</Property><Property Name="IncludePersonalSite" Type="Enum">0</Property><Property Name="StartIndex" Type="String">${startIndex}</Property><Property Name="Template" Type="String">${webTemplate}</Property></Parameter></Parameters></Method></ObjectPaths></Request>`;
+                let requestBody = `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config_1.default.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="2" ObjectPathId="1" /><ObjectPath Id="4" ObjectPathId="3" /><Query Id="5" ObjectPathId="3"><Query SelectAllProperties="true"><Properties /></Query><ChildItemQuery SelectAllProperties="true"><Properties /></ChildItemQuery></Query></Actions><ObjectPaths><Constructor Id="1" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="3" ParentId="1" Name="GetSitePropertiesFromSharePointByFilters"><Parameters><Parameter TypeId="{b92aeee2-c92c-4b67-abcc-024e471bc140}"><Property Name="Filter" Type="String">${filter}</Property><Property Name="IncludeDetail" Type="Boolean">false</Property><Property Name="IncludePersonalSite" Type="Enum">${personalSite}</Property><Property Name="StartIndex" Type="String">${startIndex}</Property><Property Name="Template" Type="String">${webTemplate}</Property></Parameter></Parameters></Method></ObjectPaths></Request>`;
                 if (deleted) {
                     requestBody = `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config_1.default.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="4" ObjectPathId="3" /><ObjectPath Id="6" ObjectPathId="5" /><Query Id="7" ObjectPathId="5"><Query SelectAllProperties="true"><Properties><Property Name="NextStartIndexFromSharePoint" ScalarProperty="true" /></Properties></Query><ChildItemQuery SelectAllProperties="true"><Properties /></ChildItemQuery></Query></Actions><ObjectPaths><Constructor Id="3" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="5" ParentId="3" Name="GetDeletedSitePropertiesFromSharePoint"><Parameters><Parameter Type="String">${startIndex}</Parameter></Parameters></Method></ObjectPaths></Request>`;
                 }
@@ -71,7 +74,7 @@ class SpoSiteListCommand extends SpoCommand_1.default {
                     this.allSites.push(...sites._Child_Items_);
                     if (sites.NextStartIndexFromSharePoint) {
                         this
-                            .getAllSites(spoAdminUrl, filter, sites.NextStartIndexFromSharePoint, webTemplate, formDigest, deleted, logger)
+                            .getAllSites(spoAdminUrl, filter, sites.NextStartIndexFromSharePoint, personalSite, webTemplate, formDigest, deleted, logger)
                             .then(_ => resolve(), err => reject(err));
                     }
                     else {
@@ -81,15 +84,37 @@ class SpoSiteListCommand extends SpoCommand_1.default {
             }, err => reject(err));
         });
     }
+    getWebTemplateId(options) {
+        if (options.webTemplate) {
+            return options.webTemplate;
+        }
+        if (options.includeOneDriveSites) {
+            return '';
+        }
+        switch (options.type) {
+            case "TeamSite":
+                return 'GROUP#0';
+            case "CommunicationSite":
+                return 'SITEPAGEPUBLISHING#0';
+            default:
+                return '';
+        }
+    }
     options() {
         const options = [
             {
-                option: '--type [type]',
+                option: '-t, --type [type]',
                 autocomplete: ['TeamSite', 'CommunicationSite']
             },
+            {
+                option: '--webTemplate [webTemplate]'
+            },
             {
                 option: '-f, --filter [filter]'
             },
+            {
+                option: '--includeOneDriveSites'
+            },
             {
                 option: '--deleted'
             }
@@ -98,11 +123,17 @@ class SpoSiteListCommand extends SpoCommand_1.default {
         return options.concat(parentOptions);
     }
     validate(args) {
-        if (args.options.type) {
-            if (args.options.type !== 'TeamSite' &&
-                args.options.type !== 'CommunicationSite') {
-                return `${args.options.type} is not a valid modern site type. Allowed types are TeamSite and CommunicationSite`;
-            }
+        if (args.options.type && args.options.webTemplate) {
+            return 'Specify either type or webTemplate, but not both';
+        }
+        const typeValues = ['TeamSite', 'CommunicationSite'];
+        if (args.options.type &&
+            typeValues.indexOf(args.options.type) < 0) {
+            return `${args.options.type} is not a valid value for the type option. Allowed values are ${typeValues.join('|')}`;
+        }
+        if (args.options.includeOneDriveSites
+            && (args.options.type || args.options.webTemplate)) {
+            return 'When using includeOneDriveSites, don\'t specify the type or webTemplate options';
         }
         return true;
     }