Extends 'spo web set' with welcomePage. Closes pnp#1730

Author: arjunumenon

docs/docs/about/comparison-powershell.md

@@ -632,7 +632,7 @@ Set-PnPGroup|SharePointPnPPowerShellOnline|
 Set-PnPGroupPermissions|SharePointPnPPowerShellOnline|
 Set-PnPHomeSite|SharePointPnPPowerShellOnline|[spo homesite set](../cmd/spo/homesite/homesite-set.md)
 Set-PnPHideDefaultThemes|SharePointPnPPowerShellOnline|[spo hidedefaultthemes set](../cmd/spo/hidedefaultthemes/hidedefaultthemes-set.md)
-Set-PnPHomePage|SharePointPnPPowerShellOnline|
+Set-PnPHomePage|SharePointPnPPowerShellOnline|[spo web set](../cmd/spo/web/web-set.md)
 Set-PnPHubSite|SharePointPnPPowerShellOnline|[spo hubsite set](../cmd/spo/hubsite/hubsite-set.md)
 Set-PnPIndexedProperties|SharePointPnPPowerShellOnline|
 Set-PnPInPlaceRecordsManagement|SharePointPnPPowerShellOnline|[spo site inplacerecordsmanagement set](../cmd/spo/site/site-inplacerecordsmanagement-set.md)

docs/docs/cmd/spo/web/web-set.md

@@ -24,6 +24,7 @@ Option|Description
 `--footerEnabled [footerEnabled]`|Set to `true` to enable footer and to `false` to disable it
 `--searchScope [searchScope]`|Search scope to set in the site. Allowed values `DefaultScope,Tenant,Hub,Site`
 `--query [query]`|JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
+`--welcomePage [welcomePage]`|Site-relative URL of the welcome page for the site
 `-o, --output [output]`|Output type. `json,text`. Default `text`
 `--verbose`|Runs command with verbose logging
 `--debug`|Runs command with debug logging
@@ -76,6 +77,12 @@ Set search scope to tenant scope
 spo web set --webUrl https://contoso.sharepoint.com/sites/team-a --searchScope tenant
 ```
 
+Set welcome page for the web
+
+```sh
+spo web set  --webUrl https://contoso.sharepoint.com/sites/team-a --welcomePage "SitePages/new-home.aspx"
+```
+
 ## More information
 
 - Web properties: [https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee545886(v=office.15)](https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-server/ee545886(v=office.15))

src/m365/spo/commands/web/web-set.spec.ts

@@ -373,6 +373,44 @@ describe(commands.WEB_SET, () => {
     });
   });
 
+  it('Update Welcome page', (done) => {
+    sinon.stub(request, 'patch').callsFake((opts) => {
+      if (opts.url === 'https://contoso.sharepoint.com/sites/team-a/_api/web') {
+        return Promise.resolve();
+      }
+      return Promise.reject('Invalid request');
+    });
+
+    cmdInstance.action({ options: { debug: false, welcomePage: 'SitePages/Home.aspx', webUrl: 'https://contoso.sharepoint.com/sites/team-a' } }, () => {
+      try {
+        assert(cmdInstanceLogSpy.notCalled);
+        done();
+      }
+      catch (e) {
+        done(e);
+      }
+    });
+  });
+
+  it('Update Welcome page (debug)', (done) => {
+    sinon.stub(request, 'patch').callsFake((opts) => {
+      if (opts.url === 'https://contoso.sharepoint.com/sites/team-a/_api/web') {
+        return Promise.resolve();
+      }
+      return Promise.reject('Invalid request');
+    });
+
+    cmdInstance.action({ options: { debug: true, welcomePage: 'SitePages/Home.aspx', webUrl: 'https://contoso.sharepoint.com/sites/team-a' } }, () => {
+      try {
+        assert(cmdInstanceLogSpy.called);
+        done();
+      }
+      catch (e) {
+        done(e);
+      }
+    });
+  });
+
   it('correctly handles error when hub site not found', (done) => {
     sinon.stub(request, 'patch').callsFake((opts) => {
       return Promise.reject({
@@ -399,6 +437,32 @@ describe(commands.WEB_SET, () => {
     });
   });
 
+  it('correctly handles error while updating Welcome page', (done) => {
+    sinon.stub(request, 'patch').callsFake((opts) => {
+      return Promise.reject({
+        error: {
+          "odata.error": {
+            "code": "-1, Microsoft.SharePoint.Client.ResourceNotFoundException",
+            "message": {
+              "lang": "en-US",
+              "value": "The WelcomePage property must be a path that is relative to the folder, and the path cannot contain two consecutive periods (..)."
+            }
+          }
+        }
+      });
+    });
+
+    cmdInstance.action({ options: { debug: false, welcomePage: 'https://contoso.sharepoint.com/sites/team-a/SitePages/Home.aspx', webUrl: 'https://contoso.sharepoint.com/sites/team-a'} }, (err?: any) => {
+      try {
+        assert.equal(JSON.stringify(err), JSON.stringify(new CommandError("The WelcomePage property must be a path that is relative to the folder, and the path cannot contain two consecutive periods (..).")));
+        done();
+      }
+      catch (e) {
+        done(e);
+      }
+    });
+  });
+
   it('supports debug mode', () => {
     const options = (command.options() as CommandOption[]);
     let containsOption = false;

src/m365/spo/commands/web/web-set.ts

@@ -23,6 +23,7 @@ interface Options extends GlobalOptions {
   webUrl: string;
   footerEnabled?: string;
   searchScope?: string;
+  welcomePage?: string;
 }
 
 class SpoWebSetCommand extends SpoCommand {
@@ -48,6 +49,7 @@ class SpoWebSetCommand extends SpoCommand {
     telemetryProps.quickLaunchEnabled = typeof args.options.quickLaunchEnabled !== 'undefined';
     telemetryProps.footerEnabled = typeof args.options.footerEnabled !== 'undefined';
     telemetryProps.searchScope = args.options.searchScope !== 'undefined';
+    telemetryProps.welcomePage = args.options.welcomePage !== 'undefined';
     this.trackUnknownOptions(telemetryProps, args.options);
     return telemetryProps;
   }
@@ -102,6 +104,29 @@ class SpoWebSetCommand extends SpoCommand {
 
     request
       .patch(requestOptions)
+      .then((): Promise<void> => {
+        if (typeof args.options.welcomePage === 'undefined') {
+          return Promise.resolve();
+        }
+
+        if (this.verbose) {
+          cmd.log(`Updating Welcome page for the site ${args.options.webUrl}`);
+        }
+
+        const requestOptions: any = {
+          url: `${args.options.webUrl}/_api/web/rootfolder`,
+          headers: {
+            'Content-Type': 'application/json;odata=nometadata',
+            accept: 'application/json;odata=nometadata',
+            'IF-MATCH': '*',
+            'X-HTTP-Method': 'PATCH'
+          },
+          body: { WelcomePage: args.options.welcomePage },
+          json: true
+        };
+
+        return request.patch(requestOptions)
+      })
       .then((): void => {
         if (this.debug) {
           cmd.log(vorpal.chalk.green('DONE'));
@@ -161,6 +186,10 @@ class SpoWebSetCommand extends SpoCommand {
         option: '--searchScope [searchScope]',
         description: 'Search scope to set in the site. Allowed values DefaultScope|Tenant|Hub|Site',
         autocomplete: SpoWebSetCommand.searchScopeOptions
+      },
+      {
+        option: '--welcomePage [welcomePage]',
+        description: 'Site-relative URL of the welcome page for the site'
       }
     ];
 
@@ -237,9 +266,9 @@ class SpoWebSetCommand extends SpoCommand {
     command, you can update the value of any other web property using its
     CSOM name, eg. ${chalk.grey('--AllowAutomaticASPXPageIndexing')}. At this
     moment, the CLI supports properties of types Boolean, String and Int32.
-      
+
   Examples:
-  
+
     Update subsite title
       ${commands.WEB_SET} --webUrl https://contoso.sharepoint.com/sites/team-a --title Team-a
 
@@ -261,6 +290,9 @@ class SpoWebSetCommand extends SpoCommand {
     Set search scope to tenant scope
       ${commands.WEB_SET} --webUrl https://contoso.sharepoint.com/sites/team-a --searchScope tenant
   
+    Set welcome page for the web
+      ${commands.WEB_SET} --webUrl https://contoso.sharepoint.com/sites/team-a --welcomePage "SitePages/new-home.aspx"
+
   More information:
     
     Web properties