@pnp/cli-microsoft365 6.0.0-beta.e031afa → 6.0.0-beta.e1e0a1b

package/docs/docs/cmd/spo/site/site-list.md

@@ -11,16 +11,16 @@ m365 spo site list [options]
 ## Options
 
 `-t, --type [type]`
-: type of sites to list. Allowed values are `TeamSite,CommunicationSite,All`. The default value is `TeamSite`. 
+: convenience option for type of sites to list. Allowed values are `TeamSite,CommunicationSite`.
 
 `--webTemplate [webTemplate]`
-: types of sites to list. To be used with values like `GROUP#0` and `SITEPAGEPUBLISHING#0`. Specify either `type` or `webTemplate`, but not both.  
+: type of sites to list. To be used with values like `GROUP#0` and `SITEPAGEPUBLISHING#0`. Specify either `type` or `webTemplate`, but not both.  
 
 `-f, --filter [filter]`
 : filter to apply when retrieving sites
 
 `--includeOneDriveSites`
-: use this switch to include OneDrive sites in the result when retrieving sites. Can only be used in combination with `type` All.
+: use this switch to include OneDrive sites in the result when retrieving sites. Do not specify the `type` or `webTemplate` options when using this.
 
 `--deleted`
 : use this switch to only return deleted sites
@@ -34,14 +34,14 @@ m365 spo site list [options]
 
 Using the `-f, --filter` option you can specify which sites you want to retrieve. For example, to get sites with _project_ in their URL, use `Url -like 'project'` as the filter.
 
-When using the text output type (default), the command lists only the values of the `Title`, and `Url` properties of the site. When setting the output type to JSON, all available properties are included in the command output.
+When using the text output type, the command lists only the values of the `Title`, and `Url` properties of the site. When setting the output type to JSON, all available properties are included in the command output.
 
 ## Examples
 
 List all sites in the currently connected tenant
 
 ```sh
-m365 spo site list --type All
+m365 spo site list
 ```
 
 List all group connected team sites in the currently connected tenant
@@ -65,7 +65,7 @@ m365 spo site list --type TeamSite --filter "Url -like 'project'"
 List all sites in the currently connected tenant including OneDrive sites
 
 ```sh
-m365 spo site list --type All --includeOneDriveSites
+m365 spo site list --includeOneDriveSites
 ```
 
 List all deleted sites in the tenant you're logged in to

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "6.0.0-beta.e031afa",
+  "version": "6.0.0-beta.e1e0a1b",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",

package/dist/m365/spo/commands/site/site-classic-add.js

@@ -1,333 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const config_1 = require("../../../../config");
-const request_1 = require("../../../../request");
-const utils_1 = require("../../../../utils");
-const SpoCommand_1 = require("../../../base/SpoCommand");
-const commands_1 = require("../../commands");
-class SpoSiteClassicAddCommand extends SpoCommand_1.default {
-    get name() {
-        return commands_1.default.SITE_CLASSIC_ADD;
-    }
-    get description() {
-        return 'Creates new classic site';
-    }
-    getTelemetryProperties(args) {
-        const telemetryProps = super.getTelemetryProperties(args);
-        telemetryProps.lcid = typeof args.options.lcid !== 'undefined';
-        telemetryProps.webTemplate = typeof args.options.webTemplate !== 'undefined';
-        telemetryProps.resourceQuota = typeof args.options.resourceQuota !== 'undefined';
-        telemetryProps.resourceQuotaWarningLevel = typeof args.options.resourceQuotaWarningLevel !== 'undefined';
-        telemetryProps.storageQuota = typeof args.options.storageQuota !== 'undefined';
-        telemetryProps.storageQuotaWarningLevel = typeof args.options.storageQuotaWarningLevel !== 'undefined';
-        telemetryProps.removeDeletedSite = args.options.removeDeletedSite;
-        telemetryProps.wait = args.options.wait;
-        return telemetryProps;
-    }
-    commandAction(logger, args, cb) {
-        this.dots = '';
-        this.showDeprecationWarning(logger, commands_1.default.SITE_CLASSIC_ADD, commands_1.default.SITE_ADD);
-        utils_1.spo
-            .getSpoAdminUrl(logger, this.debug)
-            .then((_spoAdminUrl) => {
-            this.spoAdminUrl = _spoAdminUrl;
-            return utils_1.spo.ensureFormDigest(this.spoAdminUrl, logger, this.context, this.debug);
-        })
-            .then((res) => {
-            this.context = res;
-            if (args.options.removeDeletedSite) {
-                return this.siteExistsInTheRecycleBin(args.options.url, logger);
-            }
-            else {
-                // assume site doesn't exist
-                return Promise.resolve(false);
-            }
-        })
-            .then((exists) => {
-            if (exists) {
-                if (this.verbose) {
-                    logger.logToStderr('Site exists in the recycle bin');
-                }
-                return this.deleteSiteFromTheRecycleBin(args.options.url, args.options.wait, logger);
-            }
-            else {
-                if (this.verbose) {
-                    logger.logToStderr('Site not found');
-                }
-                return Promise.resolve();
-            }
-        })
-            .then(() => {
-            return utils_1.spo.ensureFormDigest(this.spoAdminUrl, logger, this.context, this.debug);
-        })
-            .then((res) => {
-            this.context = res;
-            if (this.verbose) {
-                logger.logToStderr(`Creating site collection ${args.options.url}...`);
-            }
-            const lcid = typeof args.options.lcid === 'number' ? args.options.lcid : 1033;
-            const storageQuota = typeof args.options.storageQuota === 'number' ? args.options.storageQuota : 100;
-            const storageQuotaWarningLevel = typeof args.options.storageQuotaWarningLevel === 'number' ? args.options.storageQuotaWarningLevel : 100;
-            const resourceQuota = typeof args.options.resourceQuota === 'number' ? args.options.resourceQuota : 0;
-            const resourceQuotaWarningLevel = typeof args.options.resourceQuotaWarningLevel === 'number' ? args.options.resourceQuotaWarningLevel : 0;
-            const webTemplate = args.options.webTemplate || 'STS#0';
-            const requestOptions = {
-                url: `${this.spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
-                headers: {
-                    'X-RequestDigest': this.context.FormDigestValue
-                },
-                data: `<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="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">${lcid}</Property><Property Name="Owner" Type="String">${utils_1.formatting.escapeXml(args.options.owner)}</Property><Property Name="StorageMaximumLevel" Type="Int64">${storageQuota}</Property><Property Name="StorageWarningLevel" Type="Int64">${storageQuotaWarningLevel}</Property><Property Name="Template" Type="String">${utils_1.formatting.escapeXml(webTemplate)}</Property><Property Name="TimeZoneId" Type="Int32">${args.options.timeZone}</Property><Property Name="Title" Type="String">${utils_1.formatting.escapeXml(args.options.title)}</Property><Property Name="Url" Type="String">${utils_1.formatting.escapeXml(args.options.url)}</Property><Property Name="UserCodeMaximumLevel" Type="Double">${resourceQuota}</Property><Property Name="UserCodeWarningLevel" Type="Double">${resourceQuotaWarningLevel}</Property></Parameter></Parameters></Method></ObjectPaths></Request>`
-            };
-            return request_1.default.post(requestOptions);
-        })
-            .then((res) => {
-            return new Promise((resolve, reject) => {
-                const json = JSON.parse(res);
-                const response = json[0];
-                if (response.ErrorInfo) {
-                    reject(response.ErrorInfo.ErrorMessage);
-                }
-                else {
-                    const operation = json[json.length - 1];
-                    const isComplete = operation.IsComplete;
-                    if (!args.options.wait || isComplete) {
-                        resolve();
-                        return;
-                    }
-                    setTimeout(() => {
-                        utils_1.spo.waitUntilFinished({
-                            operationId: JSON.stringify(operation._ObjectIdentity_),
-                            siteUrl: this.spoAdminUrl,
-                            resolve,
-                            reject,
-                            logger,
-                            currentContext: this.context,
-                            dots: this.dots,
-                            debug: this.debug,
-                            verbose: this.verbose
-                        });
-                    }, operation.PollingInterval);
-                }
-            });
-        })
-            .then(_ => cb(), (err) => this.handleRejectedPromise(err, logger, cb));
-    }
-    siteExistsInTheRecycleBin(url, logger) {
-        return new Promise((resolve, reject) => {
-            utils_1.spo
-                .ensureFormDigest(this.spoAdminUrl, logger, this.context, this.debug)
-                .then((res) => {
-                this.context = res;
-                if (this.verbose) {
-                    logger.logToStderr(`Checking if the site ${url} exists...`);
-                }
-                const requestOptions = {
-                    url: `${this.spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
-                    headers: {
-                        'X-RequestDigest': this.context.FormDigestValue
-                    },
-                    data: `<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="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">${utils_1.formatting.escapeXml(url)}</Parameter><Parameter Type="Boolean">false</Parameter></Parameters></Method></ObjectPaths></Request>`
-                };
-                return request_1.default.post(requestOptions);
-            })
-                .then((res) => {
-                const json = JSON.parse(res);
-                const response = json[0];
-                if (response.ErrorInfo) {
-                    if (response.ErrorInfo.ErrorTypeName === 'Microsoft.Online.SharePoint.Common.SpoNoSiteException') {
-                        return Promise.resolve(false);
-                    }
-                    else {
-                        return Promise.reject(response.ErrorInfo.ErrorMessage);
-                    }
-                }
-                else {
-                    const site = json[json.length - 1];
-                    if (site.Status === 'Recycled') {
-                        return Promise.reject(true);
-                    }
-                    else {
-                        return Promise.resolve(false);
-                    }
-                }
-            })
-                .then(() => {
-                if (this.verbose) {
-                    logger.logToStderr(`Site doesn't exist. Checking if the site ${url} exists in the recycle bin...`);
-                }
-                const requestOptions = {
-                    url: `${this.spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
-                    headers: {
-                        'X-RequestDigest': this.context.FormDigestValue
-                    },
-                    data: `<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="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">${utils_1.formatting.escapeXml(url)}</Parameter></Parameters></Method><Constructor Id="175" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /></ObjectPaths></Request>`
-                };
-                return request_1.default.post(requestOptions);
-            })
-                .then((res) => {
-                const json = JSON.parse(res);
-                const response = json[0];
-                if (response.ErrorInfo) {
-                    if (response.ErrorInfo.ErrorTypeName === 'Microsoft.SharePoint.Client.UnknownError') {
-                        resolve(false);
-                    }
-                    else {
-                        reject(response.ErrorInfo.ErrorMessage);
-                    }
-                }
-                else {
-                    const site = json[json.length - 1];
-                    if (site.Status === 'Recycled') {
-                        resolve(true);
-                    }
-                    else {
-                        resolve(false);
-                    }
-                }
-            }, (error) => {
-                if (typeof error === 'boolean') {
-                    resolve(error);
-                }
-                else {
-                    reject(error);
-                }
-            });
-        });
-    }
-    deleteSiteFromTheRecycleBin(url, wait, logger) {
-        return new Promise((resolve, reject) => {
-            utils_1.spo
-                .ensureFormDigest(this.spoAdminUrl, logger, this.context, this.debug)
-                .then((res) => {
-                this.context = res;
-                if (this.verbose) {
-                    logger.logToStderr(`Deleting site ${url} from the recycle bin...`);
-                }
-                const requestOptions = {
-                    url: `${this.spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
-                    headers: {
-                        'X-RequestDigest': this.context.FormDigestValue
-                    },
-                    data: `<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="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">${utils_1.formatting.escapeXml(url)}</Parameter></Parameters></Method><Constructor Id="175" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /></ObjectPaths></Request>`
-                };
-                return request_1.default.post(requestOptions);
-            })
-                .then((res) => {
-                const json = JSON.parse(res);
-                const response = json[0];
-                if (response.ErrorInfo) {
-                    reject(response.ErrorInfo.ErrorMessage);
-                }
-                else {
-                    const operation = json[json.length - 1];
-                    const isComplete = operation.IsComplete;
-                    if (!wait || isComplete) {
-                        resolve();
-                        return;
-                    }
-                    setTimeout(() => {
-                        utils_1.spo.waitUntilFinished({
-                            operationId: JSON.stringify(operation._ObjectIdentity_),
-                            siteUrl: this.spoAdminUrl,
-                            resolve,
-                            reject,
-                            logger,
-                            currentContext: this.context,
-                            dots: this.dots,
-                            verbose: this.verbose,
-                            debug: this.debug
-                        });
-                    }, operation.PollingInterval);
-                }
-            });
-        });
-    }
-    options() {
-        const options = [
-            {
-                option: '-u, --url <url>'
-            },
-            {
-                option: '-t, --title <title>'
-            },
-            {
-                option: '--owner <owner>'
-            },
-            {
-                option: '-z, --timeZone <timeZone>'
-            },
-            {
-                option: '-l, --lcid [lcid]'
-            },
-            {
-                option: '-w, --webTemplate [webTemplate]'
-            },
-            {
-                option: '--resourceQuota [resourceQuota]'
-            },
-            {
-                option: '--resourceQuotaWarningLevel [resourceQuotaWarningLevel]'
-            },
-            {
-                option: '--storageQuota [storageQuota]'
-            },
-            {
-                option: '--storageQuotaWarningLevel [storageQuotaWarningLevel]'
-            },
-            {
-                option: '--removeDeletedSite'
-            },
-            {
-                option: '--wait'
-            }
-        ];
-        const parentOptions = super.options();
-        return options.concat(parentOptions);
-    }
-    validate(args) {
-        const isValidSharePointUrl = utils_1.validation.isValidSharePointUrl(args.options.url);
-        if (isValidSharePointUrl !== true) {
-            return isValidSharePointUrl;
-        }
-        if (typeof args.options.timeZone !== 'number') {
-            return `${args.options.timeZone} is not a number`;
-        }
-        if (args.options.lcid &&
-            typeof args.options.lcid !== 'number') {
-            return `${args.options.lcid} is not a number`;
-        }
-        if (args.options.resourceQuota &&
-            typeof args.options.resourceQuota !== 'number') {
-            return `${args.options.resourceQuota} is not a number`;
-        }
-        if (args.options.resourceQuotaWarningLevel &&
-            typeof args.options.resourceQuotaWarningLevel !== 'number') {
-            return `${args.options.resourceQuotaWarningLevel} is not a number`;
-        }
-        if (args.options.resourceQuotaWarningLevel &&
-            !args.options.resourceQuota) {
-            return `You cannot specify resourceQuotaWarningLevel without specifying resourceQuota`;
-        }
-        if (args.options.resourceQuotaWarningLevel > args.options.resourceQuota) {
-            return `resourceQuotaWarningLevel cannot exceed resourceQuota`;
-        }
-        if (args.options.storageQuota &&
-            typeof args.options.storageQuota !== 'number') {
-            return `${args.options.storageQuota} is not a number`;
-        }
-        if (args.options.storageQuotaWarningLevel &&
-            typeof args.options.storageQuotaWarningLevel !== 'number') {
-            return `${args.options.storageQuotaWarningLevel} is not a number`;
-        }
-        if (args.options.storageQuotaWarningLevel &&
-            !args.options.storageQuota) {
-            return `You cannot specify storageQuotaWarningLevel without specifying storageQuota`;
-        }
-        if (args.options.storageQuotaWarningLevel > args.options.storageQuota) {
-            return `storageQuotaWarningLevel cannot exceed storageQuota`;
-        }
-        return true;
-    }
-}
-module.exports = new SpoSiteClassicAddCommand();
-//# sourceMappingURL=site-classic-add.js.map

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

@@ -1,99 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const config_1 = require("../../../../config");
-const request_1 = require("../../../../request");
-const utils_1 = require("../../../../utils");
-const SpoCommand_1 = require("../../../base/SpoCommand");
-const commands_1 = require("../../commands");
-class SpoSiteClassicListCommand extends SpoCommand_1.default {
-    get name() {
-        return commands_1.default.SITE_CLASSIC_LIST;
-    }
-    get description() {
-        return 'Lists sites of the given type';
-    }
-    getTelemetryProperties(args) {
-        const telemetryProps = super.getTelemetryProperties(args);
-        telemetryProps.webTemplate = args.options.webTemplate;
-        telemetryProps.filter = (!(!args.options.filter)).toString();
-        telemetryProps.includeOneDriveSites = args.options.includeOneDriveSites;
-        return telemetryProps;
-    }
-    defaultProperties() {
-        return ['Title', 'Url'];
-    }
-    commandAction(logger, args, cb) {
-        this.showDeprecationWarning(logger, commands_1.default.SITE_CLASSIC_LIST, commands_1.default.SITE_LIST);
-        const webTemplate = args.options.webTemplate || '';
-        const includeOneDriveSites = args.options.includeOneDriveSites || false;
-        const personalSite = includeOneDriveSites === false ? '0' : '1';
-        let spoAdminUrl = '';
-        utils_1.spo
-            .getSpoAdminUrl(logger, this.debug)
-            .then((_spoAdminUrl) => {
-            spoAdminUrl = _spoAdminUrl;
-            if (this.verbose) {
-                logger.logToStderr(`Retrieving list of site collections...`);
-            }
-            this.allSites = [];
-            return this.getAllSites(spoAdminUrl, utils_1.formatting.escapeXml(args.options.filter || ''), '0', personalSite, webTemplate, undefined, logger);
-        })
-            .then(_ => {
-            logger.log(this.allSites);
-            cb();
-        }, (err) => this.handleRejectedPromise(err, logger, cb));
-    }
-    getAllSites(spoAdminUrl, filter, startIndex, personalSite, webTemplate, formDigest, logger) {
-        return new Promise((resolve, reject) => {
-            utils_1.spo
-                .ensureFormDigest(spoAdminUrl, logger, formDigest, this.debug)
-                .then((res) => {
-                const requestOptions = {
-                    url: `${spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
-                    headers: {
-                        'X-RequestDigest': res.FormDigestValue
-                    },
-                    data: `<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>`
-                };
-                return request_1.default.post(requestOptions);
-            })
-                .then((res) => {
-                const json = JSON.parse(res);
-                const response = json[0];
-                if (response.ErrorInfo) {
-                    reject(response.ErrorInfo.ErrorMessage);
-                    return;
-                }
-                else {
-                    const sites = json[json.length - 1];
-                    this.allSites.push(...sites._Child_Items_);
-                    if (sites.NextStartIndexFromSharePoint) {
-                        this
-                            .getAllSites(spoAdminUrl, filter, sites.NextStartIndexFromSharePoint, personalSite, webTemplate, formDigest, logger)
-                            .then(_ => resolve(), err => reject(err));
-                    }
-                    else {
-                        resolve();
-                    }
-                }
-            }, err => reject(err));
-        });
-    }
-    options() {
-        const options = [
-            {
-                option: '-t, --webTemplate [webTemplate]'
-            },
-            {
-                option: '-f, --filter [filter]'
-            },
-            {
-                option: '--includeOneDriveSites'
-            }
-        ];
-        const parentOptions = super.options();
-        return options.concat(parentOptions);
-    }
-}
-module.exports = new SpoSiteClassicListCommand();
-//# sourceMappingURL=site-classic-list.js.map