@pnp/cli-microsoft365 10.0.0-beta.787c5f1 → 10.0.0-beta.7be7794

package/dist/m365/viva/commands/engage/engage-community-list.js

@@ -0,0 +1,28 @@
+import { odata } from '../../../../utils/odata.js';
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+class VivaEngageCommunityListCommand extends GraphCommand {
+    get name() {
+        return commands.ENGAGE_COMMUNITY_LIST;
+    }
+    get description() {
+        return 'Lists all Viva Engage communities';
+    }
+    defaultProperties() {
+        return ['id', 'displayName', 'privacy'];
+    }
+    async commandAction(logger) {
+        if (this.verbose) {
+            await logger.logToStderr('Getting all Viva Engage communities...');
+        }
+        try {
+            const results = await odata.getAllItems(`${this.resource}/v1.0/employeeExperience/communities`);
+            await logger.log(results);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+}
+export default new VivaEngageCommunityListCommand();
+//# sourceMappingURL=engage-community-list.js.map

package/dist/m365/viva/commands.js

@@ -3,6 +3,7 @@ export default {
     CONNECTIONS_APP_CREATE: `${prefix} connections app create`,
     ENGAGE_COMMUNITY_ADD: `${prefix} engage community add`,
     ENGAGE_COMMUNITY_GET: `${prefix} engage community get`,
+    ENGAGE_COMMUNITY_LIST: `${prefix} engage community list`,
     ENGAGE_GROUP_LIST: `${prefix} engage group list`,
     ENGAGE_GROUP_USER_ADD: `${prefix} engage group user add`,
     ENGAGE_GROUP_USER_REMOVE: `${prefix} engage group user remove`,

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/driveUtil.js

@@ -0,0 +1,51 @@
+import request from "../request.js";
+export const driveUtil = {
+    /**
+     * Retrieves the Drive associated with the specified site and URL.
+     * @param siteId Site ID
+     * @param url Drive URL
+     * @returns The Drive associated with the drive URL.
+     */
+    async getDriveByUrl(siteId, url) {
+        const requestOptions = {
+            url: `https://graph.microsoft.com/v1.0/sites/${siteId}/drives?$select=webUrl,id`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        const drives = await request.get(requestOptions);
+        const lowerCaseFolderUrl = url.href.toLowerCase();
+        const drive = drives.value
+            .sort((a, b) => b.webUrl.localeCompare(a.webUrl))
+            .find((d) => {
+            const driveUrl = d.webUrl.toLowerCase();
+            return lowerCaseFolderUrl.startsWith(driveUrl) &&
+                (driveUrl.length === lowerCaseFolderUrl.length ||
+                    lowerCaseFolderUrl[driveUrl.length] === '/');
+        });
+        if (!drive) {
+            throw `Drive '${url.href}' not found`;
+        }
+        return drive;
+    },
+    /**
+     * Retrieves the ID of a drive item (file, folder, etc.) associated with the given drive and item URL.
+     * @param drive The Drive object containing the item
+     * @param itemUrl Item URL
+     * @returns Drive item ID
+     */
+    async getDriveItemId(drive, itemUrl) {
+        const relativeItemUrl = itemUrl.href.replace(new RegExp(`${drive.webUrl}`, 'i'), '').replace(/\/+$/, '');
+        const requestOptions = {
+            url: `https://graph.microsoft.com/v1.0/drives/${drive.id}/root${relativeItemUrl ? `:${relativeItemUrl}` : ''}?$select=id`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        const driveItem = await request.get(requestOptions);
+        return driveItem?.id;
+    }
+};
+//# sourceMappingURL=driveUtil.js.map

package/dist/utils/spo.js

@@ -1573,8 +1573,10 @@ export const spo = {
                     AllowSchemaMismatch: true,
                     BypassSharedLock: !!options?.bypassSharedLock,
                     IgnoreVersionHistory: !!options?.ignoreVersionHistory,
+                    IncludeItemPermissions: !!options?.includeItemPermissions,
                     CustomizedItemName: options?.newName ? [options.newName] : undefined,
-                    SameWebCopyMoveOptimization: true
+                    SameWebCopyMoveOptimization: true,
+                    IsMoveMode: options?.operation === 'move'
                 }
             }
         };
@@ -1615,7 +1617,7 @@ export const spo = {
         return objectInfo;
     },
     /**
-     * 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
@@ -1629,13 +1631,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.
@@ -1650,7 +1651,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/cli/cli-doctor.mdx

@@ -22,7 +22,7 @@ This command gets all the necessary diagnostic information needed to triage and
 
 ## Examples
 
-Retrieve diagnostic information
+Retrieve diagnostic information.
 
 ```sh
 m365 cli doctor
@@ -42,18 +42,20 @@ m365 cli doctor
     },
     "cliVersion": "6.1.0",
     "nodeVersion": "v16.13.0",
-    "cliAadAppId": "31359c7f-bd7e-475c-86db-fdb8c937548e",
-    "cliAadAppTenant": "common",
-    "authMode": "DeviceCode",
+    "cliEntraAppId": "31359c7f-bd7e-475c-86db-fdb8c937548e",
+    "cliEntraAppTenant": "common",
+    "authMode": "deviceCode",
     "cliEnvironment": "",
     "cliConfig": {
       "output": "json",
       "showHelpOnFailure": false
     },
     "roles": [],
-    "scopes": [
-      "AllSites.FullControl"
-    ]
+    "scopes": {
+      "https://graph.microsoft.com": [
+        "AllSites.FullControl"
+      ]
+    }
   }
   ```
 
@@ -61,24 +63,24 @@ m365 cli doctor
   <TabItem value="Text">
 
   ```text
-  authMode       : DeviceCode
-  cliAadAppId    : 31359c7f-bd7e-475c-86db-fdb8c937548e
-  cliAadAppTenant: common
-  cliConfig      : {"output":"json","showHelpOnFailure":false}
-  cliEnvironment :
-  cliVersion     : 6.1.0
-  nodeVersion    : v16.13.0
-  os             : {"platform":"win32","version":"Windows 10 Pro","release":"10.0.19045"}
-  roles          : []
-  scopes         : ["AllSites.FullControl"]
+  authMode         : deviceCode
+  cliConfig        : {"output":"json","showHelpOnFailure":false}
+  cliEntraAppId    : 31359c7f-bd7e-475c-86db-fdb8c937548e
+  cliEntraAppTenant: common
+  cliEnvironment   :
+  cliVersion       : 6.1.0
+  nodeVersion      : v16.13.0
+  os               : {"platform":"win32","version":"Windows 10 Pro","release":"10.0.19045"}
+  roles            : []
+  scopes           : {"https://graph.microsoft.com":["AllSites.FullControl"]}
   ```
 
   </TabItem>
   <TabItem value="CSV">
 
   ```csv
-  os,cliVersion,nodeVersion,cliAadAppId,cliAadAppTenant,authMode,cliEnvironment,cliConfig,roles,scopes
-  "{""platform"":""win32"",""version"":""Windows 10 Pro"",""release"":""10.0.19045""}",6.1.0,v16.13.0,31359c7f-bd7e-475c-86db-fdb8c937548e,common,DeviceCode,,"{""output"":""json"",""showHelpOnFailure"":false}",[],"[""AllSites.FullControl""]"
+  os,cliVersion,nodeVersion,cliEntraAppId,cliEntraAppTenant,authMode,cliEnvironment,cliConfig,roles,scopes
+  "{""platform"":""win32"",""version"":""Windows 10 Pro"",""release"":""10.0.19045""}",6.1.0,v16.13.0,31359c7f-bd7e-475c-86db-fdb8c937548e,common,deviceCode,,"{""output"":""json"",""showHelpOnFailure"":false}",[],"{""https://graph.microsoft.com"":[""AllSites.FullControl""]}"
   ```
 
   </TabItem>
@@ -93,12 +95,11 @@ m365 cli doctor
   ---------|-------
   cliVersion | 6.1.0
   nodeVersion | v16.13.0
-  cliAadAppId | 31359c7f-bd7e-475c-86db-fdb8c937548e
-  cliAadAppTenant | common
-  authMode | DeviceCode
+  cliEntraAppId | 31359c7f-bd7e-475c-86db-fdb8c937548e
+  cliEntraAppTenant | common
+  authMode | deviceCode
   cliEnvironment |
   ```
 
   </TabItem>
 </Tabs>
-

package/docs/docs/cmd/entra/group/group-member-add.mdx

@@ -0,0 +1,62 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# entra group member add
+
+Adds a member to a Microsoft Entra ID group
+
+## Usage
+
+```sh
+m365 entra group member add [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --groupId [groupId]`
+: The ID of the Microsoft Entra group. Specify `groupId` or `groupDisplayName` but not both.
+
+`-n, --groupDisplayName [groupDisplayName]`
+: The display name of the Microsoft Entra group. Specify `groupId` or `groupDisplayName` but not both.
+
+`--ids [ids]`
+: Microsoft Entra IDs of users. You can also pass a comma-separated list of IDs. Specify either `ids` or `userNames` but not both.
+
+`--userNames [userNames]`
+: The user principal names of users. You can also pass a comma-separated list of UPNs. Specify either `ids` or `userNames` but not both.
+
+`-r, --role <role>`
+: The role to be assigned to the new users. Valid values: `Owner`, `Member`.
+```
+
+<Global />
+
+## Examples
+
+Add a single member specified by ID as a member to a group specified by display name.
+
+```sh
+m365 entra group member add --groupDisplayName Developers --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
+```
+
+Add multiple members specified by ID as members to a group specified by ID.
+
+```sh
+m365 entra group member add --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --ids "098b9f52-f48c-4401-819f-29c33794c3f5,f1e06e31-3abf-4746-83c2-1513d71f38b8" --role Member
+```
+
+Add a single member specified by UPN as an owner to a group specified by display name.
+
+```sh
+m365 entra group member add --groupDisplayName Developers --userNames john.doe@contoso.com --role Owner
+```
+
+Adds multiple members specified by UPN as owners to a group specified by ID.
+
+```sh
+m365 entra group member add --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --userNames "john.doe@contoso.com,adele.vance@contoso.com" --role Owner
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/entra/group/{group-user-list.mdx → group-member-list.mdx}

@@ -2,14 +2,14 @@ import Global from '/docs/cmd/_global.mdx';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-# entra group user list
+# entra group member list
 
-Lists users of a specific Entra group
+Lists members of a specific Entra group
 
 ## Usage
 
 ```sh
-m365 entra group user list [options]
+m365 entra group member list [options]
 ```
 
 ## Alias
@@ -28,13 +28,13 @@ m365 aad group user list [options]
 : The display name of the Entra group. Specify `groupId` or `groupName` but not both.
 
 `-r, --role [role]`
-: Filter the results to only users with the given role: `Owner`, `Member`.
+: Filter the results to only members with the given role: `Owner`, `Member`.
 
 `-p, --properties [properties]`
 : Comma-separated list of properties to retrieve.
 
 `-f, --filter [filter]`
-: OData filter to use to query the list of users with.
+: OData filter to use to query the list of members with.
 ```
 
 <Global />
@@ -45,34 +45,34 @@ When the `properties` option includes values with a `/`, for example: `manager/d
 
 ## Examples
 
-List all group users from a group specified by ID.
+List all group members from a group specified by ID.
 
 ```sh
-m365 entra group user list --groupId 03cba9da-3974-46c1-afaf-79caa2e45bbe
+m365 entra group member list --groupId 03cba9da-3974-46c1-afaf-79caa2e45bbe
 ```
 
 List all owners from a group specified by display name.
 
 ```sh
-m365 entra group user list --groupName Developers --role Owner
+m365 entra group member list --groupName Developers --role Owner
 ```
 
-List all group users from a group specified by name. For each one return the display name, e-mail address, and manager display name.
+List all group members from a group specified by name. For each one return the display name, e-mail address, and manager display name.
 
 ```sh
-m365 entra group user list --groupName Developers --properties "displayName,mail,manager/displayName"
+m365 entra group member list --groupName Developers --properties "displayName,mail,manager/displayName"
 ```
 
-List all group users from a group specified by name. For each one return the display name, e-mail address, and manager information.
+List all group members from a group specified by name. For each one return the display name, e-mail address, and manager information.
 
 ```sh
-m365 entra group user list --groupName Developers --properties "displayName,mail,manager/*"
+m365 entra group member list --groupName Developers --properties "displayName,mail,manager/*"
 ```
 
-List all group members that are guest users.
+List all group members that are guest members.
 
 ```sh
-m365 entra group user list --groupName Developers --filter "userType eq 'Guest'"
+m365 entra group member list --groupName Developers --filter "userType eq 'Guest'"
 ```
 
 ## Response

package/docs/docs/cmd/entra/group/group-member-set.mdx

@@ -0,0 +1,62 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# entra group member set
+
+Updates role of members in a Microsoft Entra ID group
+
+## Usage
+
+```sh
+m365 entra group member set [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --groupId [groupId]`
+: The ID of the Entra ID group. Specify `groupId` or `groupDisplayName` but not both.
+
+`-n, --groupDisplayName [groupDisplayName]`
+: The display name of the Entra ID group. Specify `groupId` or `groupDisplayName` but not both.
+
+`--ids [ids]`
+: Comma-separated list of user IDs. Specify either `ids` or `userNames` but not both.
+
+`--userNames [userNames]`
+: The user principal names of users. You can also pass a comma-separated list of UPNs. Specify either `ids` or `userNames` but not both.
+
+`-r, --role <role>`
+: The new role to be assigned to the members. Valid values: `Owner`, `Member`.
+```
+
+<Global />
+
+## Examples
+
+Update a single member specified by ID to a member of a group specified by display name
+
+```sh
+m365 entra group member set --groupDisplayName Developers --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
+```
+
+Update multiple members specified by ID to members of a group specified by ID
+
+```sh
+m365 entra group member set --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --ids "098b9f52-f48c-4401-819f-29c33794c3f5,f1e06e31-3abf-4746-83c2-1513d71f38b8" --role Member
+```
+
+Update a single member specified by UPN to an owner of a group specified by display name
+
+```sh
+m365 entra group member set --groupDisplayName Developers --userNames john.doe@contoso.com --role Owner
+```
+
+Update multiple members specified by UPN to owners of a group specified by ID
+
+```sh
+m365 entra group member set --groupId a03c0c35-ef9a-419b-8cab-f89e0a8d2d2a --userNames "john.doe@contoso.com,adele.vance@contoso.com" --role Owner
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/entra/m365group/m365group-report-activitystorage.mdx

@@ -9,13 +9,13 @@ Get the total storage used across all group mailboxes and group sites
 ## Usage
 
 ```sh
-m365 entra m365group report activitystorage  [options]
+m365 entra m365group report activitystorage [options]
 ```
 
 ## Alias
 
 ```sh
-m365 aad m365group report activitystorage  [options]
+m365 aad m365group report activitystorage [options]
 ```
 
 ## Options