@pnp/cli-microsoft365 7.8.0-beta.3152fc7 → 7.8.0-beta.5f64790

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

@@ -3,17 +3,17 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _SpoSiteRemoveCommand_instances, _SpoSiteRemoveCommand_initTelemetry, _SpoSiteRemoveCommand_initOptions, _SpoSiteRemoveCommand_initValidators;
-import chalk from 'chalk';
+var _SpoSiteRemoveCommand_instances, _SpoSiteRemoveCommand_initTelemetry, _SpoSiteRemoveCommand_initOptions, _SpoSiteRemoveCommand_initValidators, _SpoSiteRemoveCommand_initTypes;
 import { cli } from '../../../../cli/cli.js';
-import config from '../../../../config.js';
 import request from '../../../../request.js';
-import { entraGroup } from '../../../../utils/entraGroup.js';
 import { formatting } from '../../../../utils/formatting.js';
-import { spo } from '../../../../utils/spo.js';
 import { validation } from '../../../../utils/validation.js';
 import SpoCommand from '../../../base/SpoCommand.js';
 import commands from '../../commands.js';
+import { odata } from '../../../../utils/odata.js';
+import { spo } from '../../../../utils/spo.js';
+import { setTimeout } from 'timers/promises';
+import { urlUtil } from '../../../../utils/urlUtil.js';
 class SpoSiteRemoveCommand extends SpoCommand {
     get name() {
         return commands.SITE_REMOVE;
@@ -24,227 +24,180 @@ class SpoSiteRemoveCommand extends SpoCommand {
     constructor() {
         super();
         _SpoSiteRemoveCommand_instances.add(this);
+        this.pollingInterval = 5000;
         __classPrivateFieldGet(this, _SpoSiteRemoveCommand_instances, "m", _SpoSiteRemoveCommand_initTelemetry).call(this);
         __classPrivateFieldGet(this, _SpoSiteRemoveCommand_instances, "m", _SpoSiteRemoveCommand_initOptions).call(this);
         __classPrivateFieldGet(this, _SpoSiteRemoveCommand_instances, "m", _SpoSiteRemoveCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _SpoSiteRemoveCommand_instances, "m", _SpoSiteRemoveCommand_initTypes).call(this);
     }
     async commandAction(logger, args) {
+        if (args.options.wait) {
+            await this.warn(logger, `Option 'wait' is deprecated and will be removed in the next major release.`);
+        }
         if (args.options.force) {
-            await this.removeSite(logger, args);
+            await this.removeSite(logger, args.options);
         }
         else {
-            const result = await cli.promptForConfirmation({ message: `Are you sure you want to remove the site ${args.options.url}?` });
+            const result = await cli.promptForConfirmation({ message: `Are you sure you want to remove the site '${args.options.url}'?` });
             if (result) {
-                await this.removeSite(logger, args);
+                await this.removeSite(logger, args.options);
             }
         }
     }
-    async removeSite(logger, args) {
+    async removeSite(logger, options) {
         try {
-            if (args.options.fromRecycleBin) {
-                await this.deleteSiteWithoutGroup(logger, args);
+            if (this.verbose) {
+                await logger.logToStderr(`Removing site '${options.url}'...`);
             }
-            else {
-                const groupId = await this.getSiteGroupId(args.options.url, logger);
-                if (groupId === '00000000-0000-0000-0000-000000000000') {
-                    if (this.debug) {
-                        await logger.logToStderr('Site is not groupified. Going ahead with the conventional site deletion options');
-                    }
-                    await this.deleteSiteWithoutGroup(logger, args);
+            this.spoAdminUrl = await spo.getSpoAdminUrl(logger, this.debug);
+            const siteUrl = urlUtil.removeTrailingSlashes(options.url);
+            const siteDetails = await this.getSiteDetails(logger, siteUrl);
+            const isGroupSite = siteDetails.GroupId && siteDetails.GroupId !== '00000000-0000-0000-0000-000000000000';
+            if (options.fromRecycleBin) {
+                if (!siteDetails.TimeDeleted) {
+                    throw `Site is currently not in the recycle bin. Remove --fromRecycleBin if you want to remove it as active site.`;
                 }
-                else {
-                    if (this.debug) {
-                        await logger.logToStderr(`Site attached to group ${groupId}. Initiating group delete operation via Graph API`);
+                if (isGroupSite) {
+                    if (this.verbose) {
+                        await logger.logToStderr(`Checking if group '${siteDetails.GroupId}' is already permanently deleted from recycle bin.`);
                     }
-                    try {
-                        const group = await entraGroup.getGroupById(groupId);
-                        if (args.options.skipRecycleBin || args.options.wait) {
-                            await logger.logToStderr(chalk.yellow(`Entered site is a groupified site. Hence, the parameters 'skipRecycleBin' and 'wait' will not be applicable.`));
-                        }
-                        await this.deleteGroup(group.id, logger);
-                        await this.deleteSite(args.options.url, args.options.wait, logger);
+                    const isGroupInRecycleBin = await this.isGroupInEntraRecycleBin(logger, siteDetails.GroupId);
+                    if (isGroupInRecycleBin) {
+                        await this.removeGroupFromEntraRecycleBin(logger, siteDetails.GroupId);
                     }
-                    catch (err) {
-                        if (this.verbose) {
-                            await logger.logToStderr(`Site group doesn't exist. Searching in the Microsoft 365 deleted groups.`);
-                        }
-                        const deletedGroups = await this.isSiteGroupDeleted(groupId);
-                        if (deletedGroups.value.length === 0) {
-                            if (this.verbose) {
-                                await logger.logToStderr("Site group doesn't exist anymore. Deleting the site.");
-                            }
-                            if (args.options.wait) {
-                                await logger.logToStderr(chalk.yellow(`Entered site is a groupified site. Hence, the parameter 'wait' will not be applicable.`));
-                            }
-                            await this.deleteOrphanedSite(logger, args.options.url);
+                }
+                await this.deleteSiteFromSharePointRecycleBin(logger, siteUrl);
+            }
+            else {
+                if (siteDetails.TimeDeleted) {
+                    throw `Site is already in the recycle bin. Use --fromRecycleBin to permanently delete it.`;
+                }
+                if (isGroupSite) {
+                    await this.deleteGroupifiedSite(logger, siteUrl);
+                    if (options.skipRecycleBin) {
+                        let isGroupInRecycleBin = await this.isGroupInEntraRecycleBin(logger, siteDetails.GroupId);
+                        let amountOfPolls = 0;
+                        while (!isGroupInRecycleBin && amountOfPolls < 20) {
+                            await setTimeout(this.pollingInterval);
+                            isGroupInRecycleBin = await this.isGroupInEntraRecycleBin(logger, siteDetails.GroupId);
+                            amountOfPolls++;
                         }
-                        else {
-                            throw `Site group still exists in the deleted groups. The site won't be removed.`;
+                        if (isGroupInRecycleBin) {
+                            await this.removeGroupFromEntraRecycleBin(logger, siteDetails.GroupId);
                         }
                     }
                 }
+                else {
+                    await this.deleteNonGroupSite(logger, siteUrl);
+                }
+                if (options.skipRecycleBin) {
+                    await this.deleteSiteFromSharePointRecycleBin(logger, siteUrl);
+                }
             }
         }
         catch (err) {
-            this.handleRejectedPromise(err);
+            this.handleRejectedODataJsonPromise(err);
         }
     }
-    isSiteGroupDeleted(groupId) {
+    async removeGroupFromEntraRecycleBin(logger, groupId) {
+        if (this.verbose) {
+            await logger.logToStderr(`Permanently deleting group '${groupId}'.`);
+        }
         const requestOptions = {
-            url: `https://graph.microsoft.com/v1.0/directory/deletedItems/Microsoft.Graph.Group?$select=id&$filter=groupTypes/any(c:c+eq+'Unified') and startswith(id, '${groupId}')`,
+            url: `https://graph.microsoft.com/v1.0/directory/deletedItems/Microsoft.Graph.Group/${groupId}`,
             headers: {
                 accept: 'application/json;odata.metadata=none'
             },
             responseType: 'json'
         };
-        return request.get(requestOptions);
+        return request.delete(requestOptions);
     }
-    async deleteOrphanedSite(logger, url) {
-        const spoAdminUrl = await spo.getSpoAdminUrl(logger, this.debug);
+    async isGroupInEntraRecycleBin(logger, groupId) {
+        if (this.verbose) {
+            await logger.logToStderr(`Checking if group '${groupId}' is in the Microsoft Entra recycle bin.`);
+        }
         const requestOptions = {
-            url: `${spoAdminUrl}/_api/GroupSiteManager/Delete?siteUrl='${url}'`,
+            url: `https://graph.microsoft.com/v1.0/directory/deletedItems/Microsoft.Graph.Group/${groupId}?$select=id`,
             headers: {
-                'content-type': 'application/json;odata=nometadata',
-                accept: 'application/json;odata=nometadata'
+                accept: 'application/json;odata.metadata=none'
             },
             responseType: 'json'
         };
-        return await request.post(requestOptions);
-    }
-    async deleteSiteWithoutGroup(logger, args) {
-        this.spoAdminUrl = await spo.getSpoAdminUrl(logger, this.debug);
-        this.context = await spo.ensureFormDigest(this.spoAdminUrl, logger, this.context, this.debug);
-        if (args.options.fromRecycleBin) {
-            if (this.verbose) {
-                await logger.logToStderr(`Deleting site from recycle bin ${args.options.url}...`);
-            }
-            await this.deleteSiteFromTheRecycleBin(args.options.url, args.options.wait, logger);
-        }
-        else {
-            await this.deleteSite(args.options.url, args.options.wait, logger);
+        try {
+            await request.get(requestOptions);
+            return true;
         }
-        if (args.options.skipRecycleBin) {
-            if (this.verbose) {
-                await logger.logToStderr(`Also deleting site from tenant recycle bin ${args.options.url}...`);
+        catch (err) {
+            if (err.response?.status === 404) {
+                return false;
             }
-            await this.deleteSiteFromTheRecycleBin(args.options.url, args.options.wait, logger);
+            throw err;
         }
     }
-    async deleteSite(url, wait, logger) {
-        this.context = await spo.ensureFormDigest(this.spoAdminUrl, logger, this.context, this.debug);
+    async deleteNonGroupSite(logger, siteUrl) {
         if (this.verbose) {
-            await logger.logToStderr(`Deleting site ${url}...`);
+            await logger.logToStderr(`Deleting site.`);
         }
         const requestOptions = {
-            url: `${this.spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
+            url: `${this.spoAdminUrl}/_api/Microsoft.Online.SharePoint.TenantAdministration.Tenant/RemoveSite`,
             headers: {
-                'X-RequestDigest': this.context.FormDigestValue
+                accept: 'application/json;odata=nometadata'
             },
-            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="55" ObjectPathId="54"/><ObjectPath Id="57" ObjectPathId="56"/><Query Id="58" ObjectPathId="54"><Query SelectAllProperties="true"><Properties/></Query></Query><Query Id="59" ObjectPathId="56"><Query SelectAllProperties="false"><Properties><Property Name="IsComplete" ScalarProperty="true"/><Property Name="PollingInterval" ScalarProperty="true"/></Properties></Query></Query></Actions><ObjectPaths><Constructor Id="54" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}"/><Method Id="56" ParentId="54" Name="RemoveSite"><Parameters><Parameter Type="String">${formatting.escapeXml(url)}</Parameter></Parameters></Method></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: this.spoAdminUrl,
-                    resolve,
-                    reject,
-                    logger,
-                    currentContext: this.context,
-                    debug: this.debug,
-                    verbose: this.verbose
-                });
-            }, operation.PollingInterval);
-        });
-    }
-    async deleteSiteFromTheRecycleBin(url, wait, logger) {
-        this.context = await spo.ensureFormDigest(this.spoAdminUrl, logger, this.context, this.debug);
-        const requestOptions = {
-            url: `${this.spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
-            headers: {
-                'X-RequestDigest': this.context.FormDigestValue
+            data: {
+                siteUrl: siteUrl
             },
-            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>`
+            responseType: 'json'
         };
-        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: this.spoAdminUrl,
-                    resolve,
-                    reject,
-                    logger,
-                    currentContext: this.context,
-                    debug: this.debug,
-                    verbose: this.verbose
-                });
-            }, operation.PollingInterval);
-        });
+        return request.post(requestOptions);
     }
-    async getSiteGroupId(url, logger) {
-        this.spoAdminUrl = await spo.getSpoAdminUrl(logger, this.debug);
-        this.context = await spo.ensureFormDigest(this.spoAdminUrl, logger, this.context, this.debug);
+    async deleteSiteFromSharePointRecycleBin(logger, url) {
         if (this.verbose) {
-            await logger.logToStderr(`Retrieving the group Id of the site ${url}`);
+            await logger.logToStderr(`Permanently deleting site from the recycle bin.`);
         }
         const requestOptions = {
-            url: `${this.spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
+            url: `${this.spoAdminUrl}/_api/Microsoft.Online.SharePoint.TenantAdministration.Tenant/RemoveDeletedSite`,
             headers: {
-                'X-RequestDigest': this.context.FormDigestValue
+                accept: 'application/json;odata=nometadata',
+                'Content-Type': 'application/json'
             },
-            data: `<Request xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009" AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}"><Actions><ObjectPath Id="4" ObjectPathId="3"/><Query Id="5" ObjectPathId="3"><Query SelectAllProperties="false"><Properties><Property Name="GroupId" ScalarProperty="true"/></Properties></Query></Query></Actions><ObjectPaths><Constructor Id="1" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}"/><Method Id="3" ParentId="1" Name="GetSitePropertiesByUrl"><Parameters><Parameter Type="String">${formatting.escapeXml(url)}</Parameter></Parameters></Method></ObjectPaths></Request>`
+            data: {
+                siteUrl: url
+            },
+            responseType: 'json'
         };
-        const response = await request.post(requestOptions);
-        const json = JSON.parse(response);
-        const responseContent = json[0];
-        if (responseContent.ErrorInfo) {
-            throw responseContent.ErrorInfo.ErrorMessage;
+        return request.post(requestOptions);
+    }
+    async getSiteDetails(logger, url) {
+        if (this.verbose) {
+            await logger.logToStderr(`Retrieving site info.`);
         }
-        const groupId = json[json.length - 1].GroupId.replace('/Guid(', '').replace(')/', '');
-        return groupId;
+        const sites = await odata.getAllItems(`${this.spoAdminUrl}/_api/web/lists/GetByTitle('DO_NOT_DELETE_SPLIST_TENANTADMIN_AGGREGATED_SITECOLLECTIONS')/items?$filter=SiteUrl eq '${formatting.encodeQueryParameter(url)}'&$select=GroupId,TimeDeleted,SiteId`);
+        if (sites.length === 0) {
+            throw `Site not found in the tenant.`;
+        }
+        return sites[0];
     }
-    async deleteGroup(groupId, logger) {
+    async deleteGroupifiedSite(logger, siteUrl) {
         if (this.verbose) {
-            await logger.logToStderr(`Removing Microsoft 365 Group: ${groupId}...`);
+            await logger.logToStderr(`Removing groupified site.`);
         }
         const requestOptions = {
-            url: `https://graph.microsoft.com/v1.0/groups/${groupId}`,
+            url: `${this.spoAdminUrl}/_api/GroupSiteManager/Delete?siteUrl='${formatting.encodeQueryParameter(siteUrl)}'`,
             headers: {
-                'accept': 'application/json;odata.metadata=none'
-            }
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
         };
-        return request.delete(requestOptions);
+        return request.post(requestOptions);
     }
 }
 _SpoSiteRemoveCommand_instances = new WeakSet(), _SpoSiteRemoveCommand_initTelemetry = function _SpoSiteRemoveCommand_initTelemetry() {
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
-            skipRecycleBin: (!(!args.options.skipRecycleBin)).toString(),
-            fromRecycleBin: (!(!args.options.fromRecycleBin)).toString(),
-            wait: args.options.wait,
-            force: (!(!args.options.force)).toString()
+            skipRecycleBin: !!args.options.skipRecycleBin,
+            fromRecycleBin: !!args.options.fromRecycleBin,
+            wait: !!args.options.wait,
+            force: !!args.options.force
         });
     });
 }, _SpoSiteRemoveCommand_initOptions = function _SpoSiteRemoveCommand_initOptions() {
@@ -260,7 +213,24 @@ _SpoSiteRemoveCommand_instances = new WeakSet(), _SpoSiteRemoveCommand_initTelem
         option: '-f, --force'
     });
 }, _SpoSiteRemoveCommand_initValidators = function _SpoSiteRemoveCommand_initValidators() {
-    this.validators.push(async (args) => validation.isValidSharePointUrl(args.options.url));
+    this.validators.push(async (args) => {
+        const isValidSharePointUrl = validation.isValidSharePointUrl(args.options.url);
+        if (isValidSharePointUrl !== true) {
+            return isValidSharePointUrl;
+        }
+        const uri = new URL(args.options.url);
+        const rootUrl = `${uri.protocol}//${uri.hostname}`;
+        if (rootUrl.toLowerCase() === urlUtil.removeTrailingSlashes(args.options.url.toLowerCase())) {
+            return `The root site cannot be deleted.`;
+        }
+        if (args.options.fromRecycleBin && args.options.skipRecycleBin) {
+            return 'Specify either fromRecycleBin or skipRecycleBin, but not both.';
+        }
+        return true;
+    });
+}, _SpoSiteRemoveCommand_initTypes = function _SpoSiteRemoveCommand_initTypes() {
+    this.types.string.push('url');
+    this.types.boolean.push('skipRecycleBin', 'fromRecycleBin', 'wait', 'force');
 };
 export default new SpoSiteRemoveCommand();
 //# sourceMappingURL=site-remove.js.map

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

@@ -18,6 +18,7 @@ import commands from '../../commands.js';
 import { SharingCapabilities } from '../site/SharingCapabilities.js';
 import spoSiteDesignApplyCommand from '../sitedesign/sitedesign-apply.js';
 import { FlowsPolicy } from './FlowsPolicy.js';
+import { setTimeout } from 'timers/promises';
 class SpoSiteSetCommand extends SpoCommand {
     get name() {
         return commands.SITE_SET;
@@ -128,19 +129,14 @@ class SpoSiteSetCommand extends SpoCommand {
         if (!args.options.wait || isComplete) {
             return;
         }
-        await new Promise((resolve, reject) => {
-            setTimeout(() => {
-                spo.waitUntilFinished({
-                    operationId: JSON.stringify(operation._ObjectIdentity_),
-                    siteUrl: this.spoAdminUrl,
-                    resolve,
-                    reject,
-                    logger,
-                    currentContext: this.context,
-                    debug: this.debug,
-                    verbose: this.verbose
-                });
-            }, operation.PollingInterval);
+        await setTimeout(operation.PollingInterval);
+        await spo.waitUntilFinished({
+            operationId: JSON.stringify(operation._ObjectIdentity_),
+            siteUrl: this.spoAdminUrl,
+            logger,
+            currentContext: this.context,
+            debug: this.debug,
+            verbose: this.verbose
         });
     }
     async updateSiteOwners(logger, args) {

package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-remove.js

@@ -4,6 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _SpoTenantRecycleBinItemRemoveCommand_instances, _SpoTenantRecycleBinItemRemoveCommand_initTelemetry, _SpoTenantRecycleBinItemRemoveCommand_initOptions, _SpoTenantRecycleBinItemRemoveCommand_initValidators;
+import { setTimeout } from 'timers/promises';
 import { cli } from '../../../../cli/cli.js';
 import config from '../../../../config.js';
 import request from '../../../../request.js';
@@ -62,19 +63,14 @@ class SpoTenantRecycleBinItemRemoveCommand extends SpoCommand {
             if (!args.options.wait || isComplete) {
                 return;
             }
-            await new Promise((resolve, reject) => {
-                setTimeout(() => {
-                    spo.waitUntilFinished({
-                        operationId: JSON.stringify(operation._ObjectIdentity_),
-                        siteUrl: spoAdminUrl,
-                        resolve,
-                        reject,
-                        logger,
-                        currentContext: this.context,
-                        debug: this.debug,
-                        verbose: this.verbose
-                    });
-                }, operation.PollingInterval);
+            await setTimeout(operation.PollingInterval);
+            await spo.waitUntilFinished({
+                operationId: JSON.stringify(operation._ObjectIdentity_),
+                siteUrl: spoAdminUrl,
+                logger,
+                currentContext: this.context,
+                debug: this.debug,
+                verbose: this.verbose
             });
         }
         catch (err) {

package/dist/settingsNames.js

@@ -10,6 +10,7 @@ const settingsNames = {
     disableTelemetry: 'disableTelemetry',
     errorOutput: 'errorOutput',
     helpMode: 'helpMode',
+    helpTarget: 'helpTarget',
     output: 'output',
     printErrorsAsPlainText: 'printErrorsAsPlainText',
     prompt: 'prompt',