@pnp/cli-microsoft365 9.1.0-beta.acd25f7 → 9.1.0

package/dist/request.js

@@ -4,6 +4,7 @@ import auth, { Auth } from './Auth.js';
 import { app } from './utils/app.js';
 import { formatting } from './utils/formatting.js';
 import { timings } from './cli/timings.js';
+import { timersUtil } from './utils/timersUtil.js';
 class Request {
     set debug(debug) {
         // if the value to set is the same as current value return early to avoid
@@ -125,76 +126,60 @@ class Request {
         options.method = 'HEAD';
         return this.execute(options);
     }
-    execute(options, resolve, reject) {
+    async execute(options) {
         const start = process.hrtime.bigint();
         if (!this._logger) {
-            return Promise.reject('Logger not set on the request object');
+            throw 'Logger not set on the request object';
         }
         this.updateRequestForCloudType(options, auth.connection.cloudType);
-        return new Promise((_resolve, _reject) => {
-            (() => {
-                if (options.headers && options.headers['x-anonymous']) {
-                    return Promise.resolve('');
-                }
-                else {
-                    const url = options.headers && options.headers['x-resource'] ? options.headers['x-resource'] : options.url;
-                    const resource = Auth.getResourceFromUrl(url);
-                    return auth.ensureAccessToken(resource, this._logger, this._debug);
-                }
-            })()
-                .then((accessToken) => {
-                if (options.headers) {
-                    if (options.headers['x-anonymous']) {
-                        delete options.headers['x-anonymous'];
-                    }
-                    if (options.headers['x-resource']) {
-                        delete options.headers['x-resource'];
-                    }
-                    if (accessToken !== '') {
-                        options.headers.authorization = `Bearer ${accessToken}`;
-                    }
-                }
-                const proxyUrl = process.env.HTTP_PROXY || process.env.HTTPS_PROXY;
-                if (proxyUrl) {
-                    options.proxy = this.createProxyConfigFromUrl(proxyUrl);
+        try {
+            let accessToken = '';
+            if (options.headers && options.headers['x-anonymous']) {
+                accessToken = '';
+            }
+            else {
+                const url = options.headers && options.headers['x-resource'] ? options.headers['x-resource'] : options.url;
+                const resource = Auth.getResourceFromUrl(url);
+                accessToken = await auth.ensureAccessToken(resource, this._logger, this._debug);
+            }
+            if (options.headers) {
+                if (options.headers['x-anonymous']) {
+                    delete options.headers['x-anonymous'];
                 }
-                return this.req(options);
-            })
-                .then((res) => {
-                if (resolve) {
-                    resolve((options.responseType === 'stream' || options.fullResponse) ? res : res.data);
+                if (options.headers['x-resource']) {
+                    delete options.headers['x-resource'];
                 }
-                else {
-                    const end = process.hrtime.bigint();
-                    timings.api.push(Number(end - start));
-                    _resolve((options.responseType === 'stream' || options.fullResponse) ? res : res.data);
+                if (accessToken !== '') {
+                    options.headers.authorization = `Bearer ${accessToken}`;
                 }
-            }, async (error) => {
-                if (error && error.response &&
-                    (error.response.status === 429 ||
-                        error.response.status === 503)) {
-                    let retryAfter = parseInt(error.response.headers['retry-after'] || '10');
-                    if (isNaN(retryAfter)) {
-                        retryAfter = 10;
-                    }
-                    if (this._debug) {
-                        await this._logger.log(`Request throttled. Waiting ${retryAfter}sec before retrying...`);
-                    }
-                    // eslint-disable-next-line @typescript-eslint/no-floating-promises
-                    setTimeout(async () => { this.execute(options, resolve || _resolve, reject || _reject); }, retryAfter * 1000);
+            }
+            const proxyUrl = process.env.HTTP_PROXY || process.env.HTTPS_PROXY;
+            if (proxyUrl) {
+                options.proxy = this.createProxyConfigFromUrl(proxyUrl);
+            }
+            const res = await this.req(options);
+            const end = process.hrtime.bigint();
+            timings.api.push(Number(end - start));
+            return options.responseType === 'stream' || options.fullResponse ?
+                res :
+                res.data;
+        }
+        catch (error) {
+            const end = process.hrtime.bigint();
+            timings.api.push(Number(end - start));
+            if (error && error.response && (error.response.status === 429 || error.response.status === 503)) {
+                let retryAfter = parseInt(error.response.headers['retry-after'] || '10');
+                if (isNaN(retryAfter)) {
+                    retryAfter = 10;
                 }
-                else {
-                    if (reject) {
-                        reject(error);
-                    }
-                    else {
-                        const end = process.hrtime.bigint();
-                        timings.api.push(Number(end - start));
-                        _reject(error);
-                    }
+                if (this._debug) {
+                    await this._logger.log(`Request throttled. Waiting ${retryAfter} sec before retrying...`);
                 }
-            });
-        });
+                await timersUtil.setTimeout(retryAfter * 1000);
+                return this.execute(options);
+            }
+            throw error;
+        }
     }
     updateRequestForCloudType(options, cloudType) {
         const url = new URL(options.url);

package/dist/utils/spo.js

@@ -1541,7 +1541,7 @@ export const spo = {
         return file;
     },
     /**
-     * Gets the site collection URL for a given web URL using SP Admin site.
+     * Gets the primary owner login from a site as admin.
      * @param adminUrl The SharePoint admin URL
      * @param siteId The site ID
      * @param logger The logger object
@@ -1555,13 +1555,12 @@ export const spo = {
         const requestOptions = {
             url: `${adminUrl}/_api/SPO.Tenant/sites('${siteId}')?$select=OwnerLoginName`,
             headers: {
-                accept: 'application/json;odata=nometadata',
-                'content-type': 'application/json;charset=utf-8'
-            }
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
         };
         const response = await request.get(requestOptions);
-        const responseContent = JSON.parse(response);
-        return responseContent.OwnerLoginName;
+        return response.OwnerLoginName;
     },
     /**
      * Gets the primary owner login from a site.
@@ -1576,7 +1575,6 @@ export const spo = {
         }
         const requestOptions = {
             url: `${siteUrl}/_api/site/owner`,
-            method: 'GET',
             headers: {
                 'accept': 'application/json;odata=nometadata'
             },

package/dist/utils/timersUtil.js

@@ -0,0 +1,12 @@
+import { setTimeout } from "timers/promises";
+export const timersUtil = {
+    /**
+     * Timeout for a specific duration.
+     * @param duration Duration in milliseconds.
+     */
+    /* c8 ignore next 3 */
+    async setTimeout(duration) {
+        return setTimeout(duration);
+    }
+};
+//# sourceMappingURL=timersUtil.js.map

package/dist/utils/urlUtil.js

@@ -198,6 +198,14 @@ export const urlUtil = {
             return rootUrl.origin;
         }
     },
+    /**
+     * Removes leading slashes from the URL.
+     * @param url The URL to process.
+     * @returns The URL without leading slashes.
+     */
+    removeLeadingSlashes(url) {
+        return url.replace(/^\/+/, '');
+    },
     /**
      * Removes trailing slashes from the URL.
      * @param url The URL to process.

package/docs/docs/cmd/external/item/item-add.mdx

@@ -63,13 +63,13 @@ For more information about using these options, see the Microsoft Graph API docu
 Creates an external item with simple properties that everyone is allowed to access
 
 ```sh
-m365 external item add --id "pnp-ensure-siteassets-library" --connectionId "samplesolutiongallery" --content "Ensure that the Site Assets library is created." --title "Ensure the Site Assets Library is created" --description "Ensure that the Site Assets library is created." --authors "Phil Harding" --acls "grant,everyone,everyone"
+m365 external item add --id "pnp-ensure-siteassets-library" --externalConnectionId "samplesolutiongallery" --content "Ensure that the Site Assets library is created." --title "Ensure the Site Assets Library is created" --description "Ensure that the Site Assets library is created." --authors "Phil Harding" --acls "grant,everyone,everyone"
 ```
 
 Creates an external item with multi-value properties accessible only to users from the specified Entra group
 
 ```sh
-m365 external item add --id "pnp-ensure-siteassets-library" --connectionId "samplesolutiongallery" --content "Ensure that the Site Assets library is created." --title "Ensure the Site Assets Library is created" --description "Ensure that the Site Assets library is created." --authors@odata.type "Collection(String)" --authors "Phil Harding;#Steve Smith" --acls "grant,group,Super users"
+m365 external item add --id "pnp-ensure-siteassets-library" --externalConnectionId "samplesolutiongallery" --content "Ensure that the Site Assets library is created." --title "Ensure the Site Assets Library is created" --description "Ensure that the Site Assets library is created." --authors@odata.type "Collection(String)" --authors "Phil Harding;#Steve Smith" --acls "grant,group,Super users"
 ```
 
 ## Response
@@ -123,7 +123,7 @@ m365 external item add --id "pnp-ensure-siteassets-library" --connectionId "samp
   <TabItem value="Markdown">
 
   ```md
-  # m365 external item add --id "pnp-ensure-siteassets-library" --connectionId "samplesolutiongallery" --content "Ensure that the Site Assets library is created." --title "Ensure the Site Assets Library is created" --description "Ensure that the Site Assets library is created." --authors "Phil Harding" --acls "grant,everyone,everyone"
+  # m365 external item add --id "pnp-ensure-siteassets-library" --externalConnectionId "samplesolutiongallery" --content "Ensure that the Site Assets library is created." --title "Ensure the Site Assets Library is created" --description "Ensure that the Site Assets library is created." --authors "Phil Harding" --acls "grant,everyone,everyone"
 
   Date: 2023-10-28
 

package/docs/docs/cmd/spfx/project/project-upgrade.mdx

@@ -35,7 +35,7 @@ m365 spfx project upgrade [options]
 
 ## Remarks
 
-The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.19.0).
+The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.20.0).
 
 This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
 

package/docs/docs/cmd/spo/page/page-remove.mdx

@@ -13,36 +13,54 @@ m365 spo page remove [options]
 ## Options
 
 ```md definition-list
+`-u, --webUrl <webUrl>`
+: URL of the site where the page is located.
+
 `-n, --name <name>`
-: Name of the page to remove.
+: Name of the page.
 
-`-u, --webUrl <webUrl>`
-: URL of the site from which the page should be removed.
+`--recycle`
+: Send the page to the recycle bin instead of permanently deleting it.
+
+`--bypassSharedLock`
+: Remove the page even if it is locked for shared use.
 
 `-f, --force`
-: Do not prompt for confirmation before removing the page.
+: Do not prompt for confirmation.
 ```
 
 <Global />
 
-## Remarks
-
-If you try to remove a page with that does not exist, you will get a `The file does not exist` error.
-
-If you set the `-f, --force` flag, you will not be prompted for confirmation before the page is actually removed.
-
 ## Examples
 
 Remove a modern page
 
 ```sh
-m365 spo page remove --name page.aspx --webUrl https://contoso.sharepoint.com/sites/a-team
+m365 spo page remove --name HR.aspx --webUrl https://contoso.sharepoint.com/sites/Marketing
 ```
 
 Remove a modern page without a confirmation prompt
 
 ```sh
-m365 spo page remove --name page.aspx --webUrl https://contoso.sharepoint.com/sites/a-team --force
+m365 spo page remove --name HR.aspx --webUrl https://contoso.sharepoint.com/sites/Marketing --force
+```
+
+Send a page to the recycle bin
+
+```sh
+m365 spo page remove --name HR.aspx --webUrl https://contoso.sharepoint.com/sites/Marketing --recycle
+```
+
+Remove a page that is locked
+
+```sh
+m365 spo page remove --name HR.aspx --webUrl https://contoso.sharepoint.com/sites/Marketing --bypassSharedLock
+```
+
+Remove a page that is located in a subfolder
+
+```sh
+m365 spo page remove --name /Departments/People/HR.aspx --webUrl https://contoso.sharepoint.com/sites/Marketing
 ```
 
 ## Response

package/docs/docs/cmd/spo/site/site-admin-list.mdx

@@ -28,12 +28,10 @@ m365 spo site admin list [options]
 
 :::info
 
-To use this command with the `--asAdmin` mode, you must have permission to access the tenant admin site.
+To use this command with the `--asAdmin` mode, you must be at least SharePoint administrator.
 
 Without this parameter, you must have site collection admin permissions for the requested site.
 
-In `--asAdmin` mode, the Id, PrincipalType, and PrincipalTypeString properties are not exported.
-
 :::
 
 ## Examples
@@ -52,6 +50,8 @@ m365 spo site admin list --siteUrl https://contoso.sharepoint.com --asAdmin
 
 ## Response
 
+### Standard response
+
 <Tabs>
   <TabItem value="JSON">
 
@@ -73,13 +73,9 @@ m365 spo site admin list --siteUrl https://contoso.sharepoint.com --asAdmin
   <TabItem value="Text">
 
   ```text
-  Email               : user@contoso.com
-  Id                  : 6
-  LoginName           : i:0#.f|membership|user@contoso.com
-  PrincipalType       : 1
-  PrincipalTypeString : User
-  Title               : User Example
-  IsPrimaryAdmin      : true
+  Id  LoginName                                                                    Title    PrincipalTypeString
+  --  ---------------------------------------------------------------------------  -------  -------------------
+  15  c:0o.c|federateddirectoryclaimprovider|d8430798-5a00-00ba-83b0-dd7a032d549a  Members  SecurityGroup
   ```
 
   </TabItem>
@@ -98,7 +94,7 @@ m365 spo site admin list --siteUrl https://contoso.sharepoint.com --asAdmin
 
   Date: 20/03/2024
 
-  ## User
+  ## User Example
 
   Property | Value
   ---------|-------
@@ -112,4 +108,60 @@ m365 spo site admin list --siteUrl https://contoso.sharepoint.com --asAdmin
   ```
 
   </TabItem>
-</Tabs>
+</Tabs>
+
+### `asAdmin` response
+
+When we make use of the option `asAdmin` the response will differ. 
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "Email": "user@contoso.com",
+      "LoginName": "i:0#.f|membership|user@contoso.com",
+      "Title": "User Example",
+      "IsPrimaryAdmin": true
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  LoginName                                                                    Title          
+  ---------------------------------------------------------------------------  ---------------
+  c:0o.c|federateddirectoryclaimprovider|d8430798-5a00-00ba-83b0-dd7a032d549a  Members        
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  Email,LoginName,Title,IsPrimaryAdmin
+  user@contoso.com,i:0#.f|membership|user@contoso.com,User Example,1
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # spo site admin list --siteUrl "https://contoso.sharepoint.com/sites/Test" --asAdmin
+
+  Date: 20/03/2024
+
+  ## User Example
+
+  Property | Value
+  ---------|-------
+  Email | user@contoso.com
+  LoginName | i:0#.f\|membership\|user@contoso.com
+  Title | User Example
+  IsPrimaryAdmin | true
+  ```
+
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/spo/site/site-sharingpermission-set.mdx

@@ -0,0 +1,58 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# spo site sharingpermission set
+
+Controls how a site and its components can be shared
+
+## Usage
+
+```sh
+m365 spo site sharingpermission set [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --url <url>`
+: URL of the site.
+
+`--capability <capability>`
+: Define how the site is shared. Possible values: `full`, `limited`, `ownersOnly`.
+```
+
+<Global />
+
+## Remarks
+
+When specifying `capability`, consider the following:
+- `full`: Site owners and members can share files, folders, and the site. People with Edit permissions can share files and folders.
+- `limited`: Site owners and members, and people with Edit permissions can share files and folders, but only site owners can share the site.
+- `ownersOnly`: Only site owners can share files, folders, and the site.
+
+## Examples
+
+Update the sharing permissions for a site so only owners can share files and the site
+
+```sh
+m365 spo site sharingpermission set --siteUrl https://siteaddress.com/sites/sitename  --capability ownersOnly
+```
+
+Update the sharing permissions for a site where so both owners and members can share files and the site
+
+```sh
+m365 spo site sharingpermission set --siteUrl https://siteaddress.com/sites/sitename  --capability full
+```
+
+Update the sharing permissions for a site where so owners can share the site, but members can only share files
+
+```sh
+m365 spo site sharingpermission set --siteUrl https://siteaddress.com/sites/sitename  --capability full
+```
+
+## Response
+
+The command won't return a response on success.
+
+## More information
+
+- Sharing a SharePoint site: [https://support.microsoft.com/office/share-a-site-958771a8-d041-4eb8-b51c-afea2eae3658](https://support.microsoft.com/office/share-a-site-958771a8-d041-4eb8-b51c-afea2eae3658)

package/docs/docs/cmd/viva/engage/engage-community-list.mdx

@@ -0,0 +1,81 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# viva engage community list
+
+Lists all Viva Engage communities
+
+## Usage
+
+```sh
+m365 viva engage community list [options]
+```
+
+## Options
+
+<Global />
+
+## Examples
+
+Lists all Viva Engage communities
+
+```sh
+m365 viva engage community list
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI0NzY5MTM1ODIwOSJ9",
+      "displayName": "All Company",
+      "description": "This is the default group for everyone in the network",
+      "privacy": "public",
+      "groupId": "7c99afd7-9f3a-49e2-b105-4ee36314350c"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id                                                displayName  privacy
+  ------------------------------------------------  -----------  -------
+  eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI0NzY5MTM1ODIwOSJ9  All Company  public
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,displayName,description,privacy,groupId
+  eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI0NzY5MTM1ODIwOSJ9,All Company,This is the default group for everyone in the network,public,7c99afd7-9f3a-49e2-b105-4ee36314350c
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # viva engage community list
+
+  Date: 8/29/2024
+
+  ## All Company (eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI0NzY5MTM1ODIwOSJ9)
+
+  Property | Value
+  ---------|-------
+  id | eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiI0NzY5MTM1ODIwOSJ9
+  displayName | All Company
+  description | This is the default group for everyone in the network
+  privacy | public
+  groupId | 7c99afd7-9f3a-49e2-b105-4ee36314350c
+  ```
+  
+  </TabItem>
+</Tabs>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "9.1.0-beta.acd25f7",
+  "version": "9.1.0",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",
@@ -310,4 +310,4 @@
     "sinon": "^18.0.0",
     "source-map-support": "^0.5.21"
   }
-}
+}