@pnp/cli-microsoft365 7.0.0-beta.5fdb9e3 → 7.0.0-beta.607e42d

package/dist/utils/spo.js

@@ -8,6 +8,8 @@ import request from "../request.js";
 import { formatting } from './formatting.js';
 import { odata } from './odata.js';
 import { RoleType } from '../m365/spo/commands/roledefinition/RoleType.js';
+import { aadGroup } from './aadGroup.js';
+import { SharingCapabilities } from '../m365/spo/commands/site/SharingCapabilities.js';
 export const spo = {
     getRequestDigest(siteUrl) {
         const requestOptions = {
@@ -621,6 +623,586 @@ export const spo = {
         roledefinition.BasePermissionsValue = permissions.parse();
         roledefinition.RoleTypeKindValue = RoleType[roledefinition.RoleTypeKind];
         return roledefinition;
+    },
+    /**
+    * Adds a SharePoint site.
+    * @param type Type of sites to add. Allowed values TeamSite, CommunicationSite, ClassicSite, default TeamSite
+    * @param title Site title
+    * @param alias Site alias, used in the URL and in the team site group e-mail (applies to type TeamSite)
+    * @param url Site URL (applies to type CommunicationSite, ClassicSite)
+    * @param timeZone Integer representing time zone to use for the site (applies to type ClassicSite)
+    * @param description Site description
+    * @param lcid Site language in the LCID format
+    * @param owners Comma-separated list of users to set as site owners (applies to type TeamSite, ClassicSite)
+    * @param isPublic Determines if the associated group is public or not (applies to type TeamSite)
+    * @param classification Site classification (applies to type TeamSite, CommunicationSite)
+    * @param siteDesignType of communication site to create. Allowed values Topic, Showcase, Blank, default Topic. When creating a communication site, specify either siteDesign or siteDesignId (applies to type CommunicationSite)
+    * @param siteDesignId Id of the custom site design to use to create the site. When creating a communication site, specify either siteDesign or siteDesignId (applies to type CommunicationSite)
+    * @param shareByEmailEnabled Determines whether it's allowed to share file with guests (applies to type CommunicationSite)
+    * @param webTemplate Template to use for creating the site. Default `STS#0` (applies to type ClassicSite)
+    * @param resourceQuota The quota for this site collection in Sandboxed Solutions units. Default 0 (applies to type ClassicSite)
+    * @param resourceQuotaWarningLevel The warning level for the resource quota. Default 0 (applies to type ClassicSite)
+    * @param storageQuota The storage quota for this site collection in megabytes. Default 100 (applies to type ClassicSite)
+    * @param storageQuotaWarningLevel The warning level for the storage quota in megabytes. Default 100 (applies to type ClassicSite)
+    * @param removeDeletedSite Set, to remove existing deleted site with the same URL from the Recycle Bin (applies to type ClassicSite)
+    * @param wait Wait for the site to be provisioned before completing the command (applies to type ClassicSite)
+    * @param logger the Logger object
+    * @param verbose set if verbose logging should be logged
+    */
+    async addSite(title, logger, verbose, wait, type, alias, description, owners, shareByEmailEnabled, removeDeletedSite, classification, isPublic, lcid, url, siteDesign, siteDesignId, timeZone, webTemplate, resourceQuota, resourceQuotaWarningLevel, storageQuota, storageQuotaWarningLevel) {
+        if (type === 'ClassicSite') {
+            const spoAdminUrl = await spo.getSpoAdminUrl(logger, verbose);
+            let context = await spo.ensureFormDigest(spoAdminUrl, logger, undefined, verbose);
+            let exists;
+            if (removeDeletedSite) {
+                exists = await spo.siteExists(url, logger, verbose);
+            }
+            else {
+                // assume site doesn't exist
+                exists = false;
+            }
+            if (exists) {
+                if (verbose) {
+                    await logger.logToStderr('Site exists in the recycle bin');
+                }
+                await spo.deleteSiteFromTheRecycleBin(url, logger, verbose, wait);
+            }
+            else {
+                if (verbose) {
+                    await logger.logToStderr('Site not found');
+                }
+            }
+            context = await spo.ensureFormDigest(spoAdminUrl, logger, context, verbose);
+            if (verbose) {
+                await logger.logToStderr(`Creating site collection ${url}...`);
+            }
+            const lcidOption = typeof lcid === 'number' ? lcid : 1033;
+            const storageQuotaOption = typeof storageQuota === 'number' ? storageQuota : 100;
+            const storageQuotaWarningLevelOption = typeof storageQuotaWarningLevel === 'number' ? storageQuotaWarningLevel : 100;
+            const resourceQuotaOption = typeof resourceQuota === 'number' ? resourceQuota : 0;
+            const resourceQuotaWarningLevelOption = typeof resourceQuotaWarningLevel === 'number' ? resourceQuotaWarningLevel : 0;
+            const webTemplateOption = webTemplate || 'STS#0';
+            const requestOptions = {
+                url: `${spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
+                headers: {
+                    'X-RequestDigest': context.FormDigestValue
+                },
+                data: `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="4" ObjectPathId="3" /><ObjectPath Id="6" ObjectPathId="5" /><Query Id="7" ObjectPathId="3"><Query SelectAllProperties="true"><Properties /></Query></Query><Query Id="8" ObjectPathId="5"><Query SelectAllProperties="false"><Properties><Property Name="IsComplete" ScalarProperty="true" /><Property Name="PollingInterval" ScalarProperty="true" /></Properties></Query></Query></Actions><ObjectPaths><Constructor Id="3" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="5" ParentId="3" Name="CreateSite"><Parameters><Parameter TypeId="{11f84fff-b8cf-47b6-8b50-34e692656606}"><Property Name="CompatibilityLevel" Type="Int32">0</Property><Property Name="Lcid" Type="UInt32">${lcidOption}</Property><Property Name="Owner" Type="String">${formatting.escapeXml(owners)}</Property><Property Name="StorageMaximumLevel" Type="Int64">${storageQuotaOption}</Property><Property Name="StorageWarningLevel" Type="Int64">${storageQuotaWarningLevelOption}</Property><Property Name="Template" Type="String">${formatting.escapeXml(webTemplateOption)}</Property><Property Name="TimeZoneId" Type="Int32">${timeZone}</Property><Property Name="Title" Type="String">${formatting.escapeXml(title)}</Property><Property Name="Url" Type="String">${formatting.escapeXml(url)}</Property><Property Name="UserCodeMaximumLevel" Type="Double">${resourceQuotaOption}</Property><Property Name="UserCodeWarningLevel" Type="Double">${resourceQuotaWarningLevelOption}</Property></Parameter></Parameters></Method></ObjectPaths></Request>`
+            };
+            const res = await request.post(requestOptions);
+            const json = JSON.parse(res);
+            const response = json[0];
+            if (response.ErrorInfo) {
+                throw response.ErrorInfo.ErrorMessage;
+            }
+            else {
+                const operation = json[json.length - 1];
+                const isComplete = operation.IsComplete;
+                if (!wait || isComplete) {
+                    return;
+                }
+                await new Promise((resolve, reject) => {
+                    setTimeout(() => {
+                        spo.waitUntilFinished({
+                            operationId: JSON.stringify(operation._ObjectIdentity_),
+                            siteUrl: spoAdminUrl,
+                            resolve,
+                            reject,
+                            logger,
+                            currentContext: context,
+                            verbose: verbose,
+                            debug: verbose
+                        });
+                    }, operation.PollingInterval);
+                });
+            }
+        }
+        else {
+            const isTeamSite = type !== 'CommunicationSite';
+            const spoUrl = await spo.getSpoUrl(logger, verbose);
+            if (verbose) {
+                await logger.logToStderr(`Creating new site...`);
+            }
+            let requestOptions = {};
+            if (isTeamSite) {
+                requestOptions = {
+                    url: `${spoUrl}/_api/GroupSiteManager/CreateGroupEx`,
+                    headers: {
+                        'content-type': 'application/json; odata=verbose; charset=utf-8',
+                        accept: 'application/json;odata=nometadata'
+                    },
+                    responseType: 'json',
+                    data: {
+                        displayName: title,
+                        alias: alias,
+                        isPublic: isPublic,
+                        optionalParams: {
+                            Description: description || '',
+                            CreationOptions: {
+                                results: [],
+                                Classification: classification || ''
+                            }
+                        }
+                    }
+                };
+                if (lcid) {
+                    requestOptions.data.optionalParams.CreationOptions.results.push(`SPSiteLanguage:${lcid}`);
+                }
+                if (owners) {
+                    requestOptions.data.optionalParams.Owners = {
+                        results: owners.split(',').map(o => o.trim())
+                    };
+                }
+            }
+            else {
+                if (siteDesignId) {
+                    siteDesignId = siteDesignId;
+                }
+                else {
+                    if (siteDesign) {
+                        switch (siteDesign) {
+                            case 'Topic':
+                                siteDesignId = '00000000-0000-0000-0000-000000000000';
+                                break;
+                            case 'Showcase':
+                                siteDesignId = '6142d2a0-63a5-4ba0-aede-d9fefca2c767';
+                                break;
+                            case 'Blank':
+                                siteDesignId = 'f6cc5403-0d63-442e-96c0-285923709ffc';
+                                break;
+                        }
+                    }
+                    else {
+                        siteDesignId = '00000000-0000-0000-0000-000000000000';
+                    }
+                }
+                requestOptions = {
+                    url: `${spoUrl}/_api/SPSiteManager/Create`,
+                    headers: {
+                        'content-type': 'application/json;odata=nometadata',
+                        accept: 'application/json;odata=nometadata'
+                    },
+                    responseType: 'json',
+                    data: {
+                        request: {
+                            Title: title,
+                            Url: url,
+                            ShareByEmailEnabled: shareByEmailEnabled,
+                            Description: description || '',
+                            Classification: classification || '',
+                            WebTemplate: 'SITEPAGEPUBLISHING#0',
+                            SiteDesignId: siteDesignId
+                        }
+                    }
+                };
+                if (lcid) {
+                    requestOptions.data.request.Lcid = lcid;
+                }
+                if (owners) {
+                    requestOptions.data.request.Owner = owners;
+                }
+            }
+            const res = await request.post(requestOptions);
+            if (isTeamSite) {
+                if (res.ErrorMessage !== null) {
+                    throw res.ErrorMessage;
+                }
+                else {
+                    return res.SiteUrl;
+                }
+            }
+            else {
+                if (res.SiteStatus === 2) {
+                    return res.SiteUrl;
+                }
+                else {
+                    throw 'An error has occurred while creating the site';
+                }
+            }
+        }
+    },
+    /**
+    * Checks if a site exists
+    * Returns a boolean
+    * @param url The url of the site
+    * @param logger the Logger object
+    * @param verbose set if verbose logging should be logged
+    */
+    async siteExists(url, logger, verbose) {
+        const spoAdminUrl = await spo.getSpoAdminUrl(logger, verbose);
+        const context = await spo.ensureFormDigest(spoAdminUrl, logger, undefined, verbose);
+        if (verbose) {
+            await logger.logToStderr(`Checking if the site ${url} exists...`);
+        }
+        const requestOptions = {
+            url: `${spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
+            headers: {
+                'X-RequestDigest': context.FormDigestValue
+            },
+            data: `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="197" ObjectPathId="196" /><ObjectPath Id="199" ObjectPathId="198" /><Query Id="200" ObjectPathId="198"><Query SelectAllProperties="true"><Properties /></Query></Query></Actions><ObjectPaths><Constructor Id="196" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="198" ParentId="196" Name="GetSitePropertiesByUrl"><Parameters><Parameter Type="String">${formatting.escapeXml(url)}</Parameter><Parameter Type="Boolean">false</Parameter></Parameters></Method></ObjectPaths></Request>`
+        };
+        const res1 = await request.post(requestOptions);
+        const json = JSON.parse(res1);
+        const response = json[0];
+        if (response.ErrorInfo) {
+            if (response.ErrorInfo.ErrorTypeName === 'Microsoft.Online.SharePoint.Common.SpoNoSiteException') {
+                return await this.siteExistsInTheRecycleBin(url, logger, verbose);
+            }
+            else {
+                throw response.ErrorInfo.ErrorMessage;
+            }
+        }
+        else {
+            const site = json[json.length - 1];
+            return site.Status === 'Recycled';
+        }
+    },
+    /**
+    * Checks if a site exists in the recycle bin
+    * Returns a boolean
+    * @param url The url of the site
+    * @param logger the Logger object
+    * @param verbose set if verbose logging should be logged
+    */
+    async siteExistsInTheRecycleBin(url, logger, verbose) {
+        if (verbose) {
+            await logger.logToStderr(`Site doesn't exist. Checking if the site ${url} exists in the recycle bin...`);
+        }
+        const spoAdminUrl = await spo.getSpoAdminUrl(logger, verbose);
+        const context = await spo.ensureFormDigest(spoAdminUrl, logger, undefined, verbose);
+        const requestOptions = {
+            url: `${spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
+            headers: {
+                'X-RequestDigest': context.FormDigestValue
+            },
+            data: `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="181" ObjectPathId="180" /><Query Id="182" ObjectPathId="180"><Query SelectAllProperties="true"><Properties /></Query></Query></Actions><ObjectPaths><Method Id="180" ParentId="175" Name="GetDeletedSitePropertiesByUrl"><Parameters><Parameter Type="String">${formatting.escapeXml(url)}</Parameter></Parameters></Method><Constructor Id="175" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /></ObjectPaths></Request>`
+        };
+        const res = await request.post(requestOptions);
+        const json = JSON.parse(res);
+        const response = json[0];
+        if (response.ErrorInfo) {
+            if (response.ErrorInfo.ErrorTypeName === 'Microsoft.SharePoint.Client.UnknownError') {
+                return false;
+            }
+            throw response.ErrorInfo.ErrorMessage;
+        }
+        const site = json[json.length - 1];
+        return site.Status === 'Recycled';
+    },
+    /**
+    * Deletes a site from the recycle bin
+    * @param url The url of the site
+    * @param logger the Logger object
+    * @param verbose set if verbose logging should be logged
+    * @param wait set to wait until finished
+    */
+    async deleteSiteFromTheRecycleBin(url, logger, verbose, wait) {
+        const spoAdminUrl = await spo.getSpoAdminUrl(logger, verbose);
+        const context = await spo.ensureFormDigest(spoAdminUrl, logger, undefined, verbose);
+        if (verbose) {
+            await logger.logToStderr(`Deleting site ${url} from the recycle bin...`);
+        }
+        const requestOptions = {
+            url: `${spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
+            headers: {
+                'X-RequestDigest': context.FormDigestValue
+            },
+            data: `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="185" ObjectPathId="184" /><Query Id="186" ObjectPathId="184"><Query SelectAllProperties="false"><Properties><Property Name="IsComplete" ScalarProperty="true" /><Property Name="PollingInterval" ScalarProperty="true" /></Properties></Query></Query></Actions><ObjectPaths><Method Id="184" ParentId="175" Name="RemoveDeletedSite"><Parameters><Parameter Type="String">${formatting.escapeXml(url)}</Parameter></Parameters></Method><Constructor Id="175" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /></ObjectPaths></Request>`
+        };
+        const response = await request.post(requestOptions);
+        const json = JSON.parse(response);
+        const responseContent = json[0];
+        if (responseContent.ErrorInfo) {
+            throw responseContent.ErrorInfo.ErrorMessage;
+        }
+        const operation = json[json.length - 1];
+        const isComplete = operation.IsComplete;
+        if (!wait || isComplete) {
+            return;
+        }
+        await new Promise((resolve, reject) => {
+            setTimeout(() => {
+                spo.waitUntilFinished({
+                    operationId: JSON.stringify(operation._ObjectIdentity_),
+                    siteUrl: spoAdminUrl,
+                    resolve,
+                    reject,
+                    logger,
+                    currentContext: context,
+                    verbose: verbose,
+                    debug: verbose
+                });
+            }, operation.PollingInterval);
+        });
+    },
+    /**
+     * Updates a site with the given properties
+     * @param url The url of the site
+     * @param logger The logger object
+     * @param verbose Set for verbose logging
+     * @param title The new title
+     * @param classification The classification to be updated
+     * @param disableFlows If flows should be disabled or not
+     * @param isPublic If site should be public or private
+     * @param owners The owners to be updated
+     * @param shareByEmailEnabled If share by e-mail should be enabled or not
+     * @param siteDesignId The site design to be updated
+     * @param sharingCapability The sharing capability to be updated
+     */
+    async updateSite(url, logger, verbose, title, classification, disableFlows, isPublic, owners, shareByEmailEnabled, siteDesignId, sharingCapability) {
+        const tenantId = await spo.getTenantId(logger, verbose);
+        const spoAdminUrl = await spo.getSpoAdminUrl(logger, verbose);
+        let context = await spo.ensureFormDigest(spoAdminUrl, logger, undefined, verbose);
+        if (verbose) {
+            await logger.logToStderr('Loading site IDs...');
+        }
+        const requestOptions = {
+            url: `${url}/_api/site?$select=GroupId,Id`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        const siteInfo = await request.get(requestOptions);
+        const groupId = siteInfo.GroupId;
+        const siteId = siteInfo.Id;
+        const isGroupConnectedSite = groupId !== '00000000-0000-0000-0000-000000000000';
+        if (verbose) {
+            await logger.logToStderr(`Retrieved site IDs. siteId: ${siteId}, groupId: ${groupId}`);
+        }
+        if (isGroupConnectedSite) {
+            if (verbose) {
+                await logger.logToStderr(`Site attached to group ${groupId}`);
+            }
+            if (typeof title !== 'undefined' &&
+                typeof isPublic !== 'undefined' &&
+                typeof owners !== 'undefined') {
+                const promises = [];
+                if (typeof title !== 'undefined') {
+                    const requestOptions = {
+                        url: `${spoAdminUrl}/_api/SPOGroup/UpdateGroupPropertiesBySiteId`,
+                        headers: {
+                            accept: 'application/json;odata=nometadata',
+                            'content-type': 'application/json;charset=utf-8',
+                            'X-RequestDigest': context.FormDigestValue
+                        },
+                        data: {
+                            groupId: groupId,
+                            siteId: siteId,
+                            displayName: title
+                        },
+                        responseType: 'json'
+                    };
+                    promises.push(request.post(requestOptions));
+                }
+                if (typeof isPublic !== 'undefined') {
+                    promises.push(aadGroup.setGroup(groupId, (isPublic === false), logger, verbose));
+                }
+                if (typeof owners !== 'undefined') {
+                    promises.push(spo.setGroupifiedSiteOwners(spoAdminUrl, groupId, owners, logger, verbose));
+                }
+                await Promise.all(promises);
+            }
+        }
+        else {
+            if (verbose) {
+                await logger.logToStderr('Site is not group connected');
+            }
+            if (typeof isPublic !== 'undefined') {
+                throw `The isPublic option can't be set on a site that is not groupified`;
+            }
+            if (owners) {
+                await Promise.all(owners.split(',').map(async (o) => {
+                    await spo.setSiteAdmin(spoAdminUrl, context, url, o.trim());
+                }));
+            }
+        }
+        context = await spo.ensureFormDigest(spoAdminUrl, logger, context, verbose);
+        if (verbose) {
+            await logger.logToStderr(`Updating site ${url} properties...`);
+        }
+        let updatedProperties = false;
+        if (!isGroupConnectedSite) {
+            if (title !== undefined) {
+                updatedProperties = true;
+            }
+        }
+        else {
+            if (classification !== undefined || disableFlows !== undefined || shareByEmailEnabled !== undefined || sharingCapability !== undefined) {
+                updatedProperties = true;
+            }
+        }
+        if (updatedProperties) {
+            let propertyId = 27;
+            const payload = [];
+            if (!isGroupConnectedSite) {
+                if (title) {
+                    payload.push(`<SetProperty Id="${propertyId++}" ObjectPathId="5" Name="Title"><Parameter Type="String">${formatting.escapeXml(title)}</Parameter></SetProperty>`);
+                }
+            }
+            if (typeof classification === 'string') {
+                payload.push(`<SetProperty Id="${propertyId++}" ObjectPathId="5" Name="Classification"><Parameter Type="String">${formatting.escapeXml(classification)}</Parameter></SetProperty>`);
+            }
+            if (typeof disableFlows !== 'undefined') {
+                payload.push(`<SetProperty Id="${propertyId++}" ObjectPathId="5" Name="DisableFlows"><Parameter Type="Boolean">${disableFlows}</Parameter></SetProperty>`);
+            }
+            if (typeof shareByEmailEnabled !== 'undefined') {
+                payload.push(`<SetProperty Id="${propertyId++}" ObjectPathId="5" Name="ShareByEmailEnabled"><Parameter Type="Boolean">${shareByEmailEnabled}</Parameter></SetProperty>`);
+            }
+            if (sharingCapability) {
+                const sharingCapabilityOption = SharingCapabilities[sharingCapability];
+                payload.push(`<SetProperty Id="${propertyId++}" ObjectPathId="5" Name="SharingCapability"><Parameter Type="Enum">${sharingCapabilityOption}</Parameter></SetProperty>`);
+            }
+            const pos = tenantId.indexOf('|') + 1;
+            const requestOptionsUpdateProperties = {
+                url: `${spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
+                headers: {
+                    'X-RequestDigest': context.FormDigestValue
+                },
+                data: `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions>${payload.join('')}<ObjectPath Id="14" ObjectPathId="13" /><ObjectIdentityQuery Id="15" ObjectPathId="5" /><Query Id="16" ObjectPathId="13"><Query SelectAllProperties="false"><Properties><Property Name="IsComplete" ScalarProperty="true" /><Property Name="PollingInterval" ScalarProperty="true" /></Properties></Query></Query></Actions><ObjectPaths><Identity Id="5" Name="53d8499e-d0d2-5000-cb83-9ade5be42ca4|${tenantId.substr(pos, tenantId.indexOf('&') - pos)}&#xA;SiteProperties&#xA;${formatting.encodeQueryParameter(url)}" /><Method Id="13" ParentId="5" Name="Update" /></ObjectPaths></Request>`
+            };
+            const res = await request.post(requestOptionsUpdateProperties);
+            const json = JSON.parse(res);
+            const response = json[0];
+            if (response.ErrorInfo) {
+                throw response.ErrorInfo.ErrorMessage;
+            }
+            else {
+                const operation = json[json.length - 1];
+                const isComplete = operation.IsComplete;
+                if (!isComplete) {
+                    await new Promise((resolve, reject) => {
+                        setTimeout(() => {
+                            spo.waitUntilFinished({
+                                operationId: JSON.stringify(operation._ObjectIdentity_),
+                                siteUrl: spoAdminUrl,
+                                resolve,
+                                reject,
+                                logger,
+                                currentContext: context,
+                                verbose: verbose,
+                                debug: verbose
+                            });
+                        }, operation.PollingInterval);
+                    });
+                }
+            }
+        }
+        if (siteDesignId) {
+            await spo.applySiteDesign(siteDesignId, url, logger, verbose);
+        }
+    },
+    /**
+     * Updates the groupified site owners
+     * @param spoAdminUrl The SharePoint admin url
+     * @param groupId The ID of the group
+     * @param owners The owners to be updated
+     * @param logger The logger object
+     * @param verbose Set for verbose logging
+     */
+    async setGroupifiedSiteOwners(spoAdminUrl, groupId, owners, logger, verbose) {
+        const splittedOwners = owners.split(',').map(o => o.trim());
+        if (verbose) {
+            await logger.logToStderr('Retrieving user information to set group owners...');
+        }
+        const requestOptions = {
+            url: `https://graph.microsoft.com/v1.0/users?$filter=${splittedOwners.map(o => `userPrincipalName eq '${o}'`).join(' or ')}&$select=id`,
+            headers: {
+                'content-type': 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return request.get(requestOptions)
+            .then((res) => {
+            if (res.value.length === 0) {
+                return Promise.resolve();
+            }
+            return Promise.all(res.value.map(user => {
+                const requestOptions = {
+                    url: `${spoAdminUrl}/_api/SP.Directory.DirectorySession/Group('${groupId}')/Owners/Add(objectId='${user.id}', principalName='')`,
+                    headers: {
+                        'content-type': 'application/json;odata=verbose'
+                    }
+                };
+                return request.post(requestOptions);
+            }));
+        });
+    },
+    /**
+     * Updates the site admin
+     * @param spoAdminUrl The SharePoint admin url
+     * @param context The FormDigestInfo
+     * @param siteUrl The url of the site where the owners has to be updated
+     * @param principal The principal of the admin
+     * @param logger The logger object
+     * @param verbose Set for verbose logging
+     */
+    async setSiteAdmin(spoAdminUrl, context, siteUrl, principal, logger, verbose) {
+        if (verbose && logger) {
+            await logger.logToStderr(`Updating site admin ${principal} on ${siteUrl}...`);
+        }
+        const requestOptions = {
+            url: `${spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
+            headers: {
+                'X-RequestDigest': context.FormDigestValue
+            },
+            data: `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="48" ObjectPathId="47" /></Actions><ObjectPaths><Method Id="47" ParentId="34" Name="SetSiteAdmin"><Parameters><Parameter Type="String">${formatting.escapeXml(siteUrl)}</Parameter><Parameter Type="String">${formatting.escapeXml(principal)}</Parameter><Parameter Type="Boolean">true</Parameter></Parameters></Method><Constructor Id="34" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /></ObjectPaths></Request>`
+        };
+        const res = await request.post(requestOptions);
+        const json = JSON.parse(res);
+        const response = json[0];
+        if (response.ErrorInfo) {
+            throw response.ErrorInfo.ErrorMessage;
+        }
+        else {
+            return;
+        }
+    },
+    /**
+     * Applies a site design
+     * @param id The ID of the site design (GUID)
+     * @param webUrl The url of the site where the design should be applied
+     * @param logger The logger object
+     * @param verbose Set for verbose logging
+     */
+    async applySiteDesign(id, webUrl, logger, verbose) {
+        if (verbose) {
+            await logger.logToStderr(`Applying site design ${id}...`);
+        }
+        const spoUrl = await spo.getSpoUrl(logger, verbose);
+        const requestOptions = {
+            url: `${spoUrl}/_api/Microsoft.Sharepoint.Utilities.WebTemplateExtensions.SiteScriptUtility.ApplySiteDesign`,
+            headers: {
+                'content-type': 'application/json;charset=utf-8',
+                accept: 'application/json;odata=nometadata'
+            },
+            data: {
+                siteDesignId: id,
+                webUrl: webUrl
+            },
+            responseType: 'json'
+        };
+        await request.post(requestOptions);
+    },
+    /**
+     * Gets the web properties for a given url
+     * @param url The url of the web
+     * @param logger The logger object
+     * @param verbose Set for verbose logging
+     */
+    async getWeb(url, logger, verbose) {
+        if (verbose && logger) {
+            await logger.logToStderr(`Getting the web properties for ${url}`);
+        }
+        const requestOptions = {
+            url: `${url}/_api/web`,
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        const webProperties = await request.get(requestOptions);
+        return webProperties;
     }
 };
 //# sourceMappingURL=spo.js.map

package/dist/utils/validation.js

@@ -244,9 +244,6 @@ export const validation = {
         ];
         return !!input && !input.split('.').every(value => !~javascriptReservedWords.indexOf(value));
     },
-    isValidFileName(input) {
-        return !!input && !/^((\..*)|COM\d|CLOCK\$|LPT\d|AUX|NUL|CON|PRN|(.*[\u{d800}-\u{dfff}]+.*))$/iu.test(input) && !/^(.*\.\..*)$/i.test(input);
-    },
     isValidTheme(input) {
         const validThemeProperties = [
             "themePrimary",

package/docs/docs/cmd/aad/group/group-get.mdx

@@ -16,10 +16,10 @@ m365 aad group get [options]
 
 ```md definition-list
 `-i, --id [id]`
-: The object Id of the Azure AD group. Specify either `id` or `title` but not both
+: The object Id of the Azure AD group. Specify either `id` or `displayName` but not both.
 
-`-t, --title [title]`
-: The display name of the Azure AD group. Specify either `id` or `title` but not both
+`-n, --displayName [displayName]`
+: The display name of the Azure AD group. Specify either `id` or `displayName` but not both.
 ```
 
 <Global />
@@ -32,10 +32,10 @@ Get information about an Azure AD Group by id
 m365 aad group get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844
 ```
 
-Get information about an Azure AD Group by title
+Get information about an Azure AD Group by its display name
 
 ```sh
-m365 aad group get --title "Finance"
+m365 aad group get --displayName Finance
 ```
 
 ## Response

package/docs/docs/cmd/aad/group/group-list.mdx

@@ -14,11 +14,6 @@ m365 aad group list [options]
 
 ## Options
 
-```md definition-list
-`-d, --deleted`
-: Use to retrieve deleted groups
-```
-
 <Global />
 
 ## Examples
@@ -29,12 +24,6 @@ Lists all groups defined in Azure Active Directory.
 m365 aad group list
 ```
 
-List all recently deleted groups in the tenant
-
-```sh
-m365 aad group list --deleted
-```
-
 ## Response
 
 <Tabs>