@pnp/cli-microsoft365 9.1.0-beta.9a7d76f → 9.1.0-beta.a781c51

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

@@ -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/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

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/file/file-move.mdx

@@ -0,0 +1,79 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# file move
+
+Moves a file to another location using the Microsoft Graph
+
+## Usage
+
+```sh
+m365 file move [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the site where the file is located.
+
+`-s, --sourceUrl <sourceUrl>`
+: Server-relative or absolute URL of the file.
+
+`-t, --targetUrl <targetUrl>`
+: Server-relative or absolute URL of the location.
+
+`--newName [newName]`
+: New name of the destination file.
+
+`--nameConflictBehavior [nameConflictBehavior]`
+: Behavior when a document with the same name is already present at the destination. Possible values: `fail`, `replace`, `rename`. Default is `fail`.
+```
+
+<Global />
+
+## Remarks
+
+- If the source and target locations are within the same document library or drive, the command will utilize the Move DriveItem API, preserving the version history of the file.
+- If the source and target locations are in different document libraries or drives, the command will use a copy-and-delete combination to move the file. Please note that in this case, version history will not be retained.
+
+## Examples
+
+Move a file by server-relative URL to a folder in the same document library
+
+```sh
+m365 file move --webUrl "https://contoso.sharepoint.com/sites/project" --sourceUrl "/sites/project/Shared Documents/Document.pdf" --targetUrl "/sites/project/Shared Documents/NewFolder"
+```
+
+Move a file by server-relative URL to a document library in another site collection with server relative URL
+
+```sh
+m365 file move --webUrl "https://contoso.sharepoint.com/sites/project" --sourceUrl "/sites/project/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents"
+```
+
+Move a file by absolute URL to a document library in another site collection with absolute URL
+
+```sh
+m365 file move --webUrl "https://contoso.sharepoint.com" --sourceUrl "https://contoso.sharepoint.com/Shared Documents/Document.pdf" --targetUrl "https://contoso.sharepoint.com/sites/IT/Shared Documents"
+```
+
+Move a file to a document library in another site collection and rename the file
+
+```sh
+m365 file move --webUrl "https://contoso.sharepoint.com" --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --newName "newName"
+```
+
+Move a file to a document library in another site collection and rename the file if a file with the same name already exists.
+
+```sh
+m365 file move --webUrl "https://contoso.sharepoint.com" --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "/sites/IT/Shared Documents" --nameConflictBehavior rename
+```
+
+Move a file to Onedrive for business 
+
+```sh
+m365 file move --webUrl "https://contoso.sharepoint.com" --sourceUrl "/Shared Documents/Document.pdf" --targetUrl "https://contoso-my.sharepoint.com/personal/john_contoso_onmicrosoft_com/documents"
+```
+
+## Response
+
+The command won't return a response on success.

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/cdn/cdn-get.mdx

@@ -27,7 +27,7 @@ Using the `-t, --type` option you can choose whether you want to manage the sett
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/cdn/cdn-origin-add.mdx

@@ -28,7 +28,7 @@ Using the `-t, --type` option you can choose whether you want to manage the sett
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
     

package/docs/docs/cmd/spo/cdn/cdn-origin-list.mdx

@@ -27,7 +27,7 @@ Using the `-t, --type` option you can choose whether you want to manage the sett
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/cdn/cdn-origin-remove.mdx

@@ -31,7 +31,7 @@ Using the `-t, --type` option you can choose whether you want to manage the sett
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
     

package/docs/docs/cmd/spo/cdn/cdn-policy-list.mdx

@@ -27,7 +27,7 @@ Using the `-t, --cdnType` option you can choose whether you want to manage the s
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/cdn/cdn-policy-set.mdx

@@ -31,7 +31,7 @@ Using the `-t, --cdnType` option you can choose whether you want to manage the s
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
     

package/docs/docs/cmd/spo/externaluser/externaluser-list.mdx

@@ -37,7 +37,7 @@ m365 spo externaluser list [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.mdx

@@ -20,7 +20,7 @@ m365 spo hidedefaultthemes get [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.mdx

@@ -23,7 +23,7 @@ m365 spo hidedefaultthemes set [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

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

@@ -25,7 +25,7 @@ m365 spo homesite remove [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.mdx

@@ -20,7 +20,7 @@ m365 spo knowledgehub get [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

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

@@ -25,7 +25,7 @@ m365 spo knowledgehub remove [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.mdx

@@ -27,7 +27,7 @@ If the specified url doesn't refer to an existing site collection, you will get
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
     

package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.mdx

@@ -32,7 +32,7 @@ m365 spo orgassetslibrary add [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.mdx

@@ -20,7 +20,7 @@ m365 spo orgassetslibrary list [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

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

@@ -28,7 +28,7 @@ m365 spo orgassetslibrary remove [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.mdx

@@ -20,7 +20,7 @@ m365 spo orgnewssite list [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

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

@@ -26,7 +26,7 @@ m365 spo orgnewssite remove [options]
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
 

package/docs/docs/cmd/spo/orgnewssite/orgnewssite-set.mdx

@@ -25,7 +25,7 @@ Using the `-u, --url` option you can specify which site to add to the list of or
 
 :::info
 
-To use this command you have to have permissions to access the tenant admin site.
+To use this command you must be either **SharePoint Administrator** or **Global Administrator**.
 
 :::
     

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-add.mdx

@@ -9,7 +9,7 @@ Adds a user or group as a site collection administrator
 ## Usage
 
 ```sh
-m365 spo site admin add  [options]
+m365 spo site admin add [options]
 ```
 
 ## Options
@@ -64,4 +64,4 @@ m365 spo site admin add --siteUrl https://contoso.sharepoint.com --groupName SP_
 ```
 ## Response
 
-The command won't return a response on success.
+The command won't return a response on success.

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>