@pnp/cli-microsoft365 10.0.0-beta.a868b81 → 10.0.0-beta.d03ed9d

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

@@ -11,17 +11,20 @@ import { odata } from './odata.js';
 import { RoleType } from '../m365/spo/commands/roledefinition/RoleType.js';
 import { entraGroup } from './entraGroup.js';
 import { SharingCapabilities } from '../m365/spo/commands/site/SharingCapabilities.js';
-import { setTimeout } from 'timers/promises';
-export var CreateCopyJobsNameConflictBehavior;
-(function (CreateCopyJobsNameConflictBehavior) {
-    CreateCopyJobsNameConflictBehavior[CreateCopyJobsNameConflictBehavior["Fail"] = 0] = "Fail";
-    CreateCopyJobsNameConflictBehavior[CreateCopyJobsNameConflictBehavior["Replace"] = 1] = "Replace";
-    CreateCopyJobsNameConflictBehavior[CreateCopyJobsNameConflictBehavior["Rename"] = 2] = "Rename";
-})(CreateCopyJobsNameConflictBehavior || (CreateCopyJobsNameConflictBehavior = {}));
+import { timersUtil } from './timersUtil.js';
+export var CreateFileCopyJobsNameConflictBehavior;
+(function (CreateFileCopyJobsNameConflictBehavior) {
+    CreateFileCopyJobsNameConflictBehavior[CreateFileCopyJobsNameConflictBehavior["Fail"] = 0] = "Fail";
+    CreateFileCopyJobsNameConflictBehavior[CreateFileCopyJobsNameConflictBehavior["Replace"] = 1] = "Replace";
+    CreateFileCopyJobsNameConflictBehavior[CreateFileCopyJobsNameConflictBehavior["Rename"] = 2] = "Rename";
+})(CreateFileCopyJobsNameConflictBehavior || (CreateFileCopyJobsNameConflictBehavior = {}));
+export var CreateFolderCopyJobsNameConflictBehavior;
+(function (CreateFolderCopyJobsNameConflictBehavior) {
+    CreateFolderCopyJobsNameConflictBehavior[CreateFolderCopyJobsNameConflictBehavior["Fail"] = 0] = "Fail";
+    CreateFolderCopyJobsNameConflictBehavior[CreateFolderCopyJobsNameConflictBehavior["Rename"] = 2] = "Rename";
+})(CreateFolderCopyJobsNameConflictBehavior || (CreateFolderCopyJobsNameConflictBehavior = {}));
 // Wrapping this into a settings object so we can alter the values in tests
-export const settings = {
-    pollingInterval: 3000
-};
+const pollingInterval = 3000;
 export const spo = {
     async getRequestDigest(siteUrl) {
         const requestOptions = {
@@ -79,7 +82,7 @@ export const spo = {
                 }
                 return;
             }
-            await setTimeout(operation.PollingInterval);
+            await timersUtil.setTimeout(pollingInterval);
             await spo.waitUntilFinished({
                 operationId: JSON.stringify(operation._ObjectIdentity_),
                 siteUrl,
@@ -691,7 +694,7 @@ export const spo = {
                 if (!wait || isComplete) {
                     return;
                 }
-                await setTimeout(operation.PollingInterval);
+                await timersUtil.setTimeout(pollingInterval);
                 await spo.waitUntilFinished({
                     operationId: JSON.stringify(operation._ObjectIdentity_),
                     siteUrl: spoAdminUrl,
@@ -905,7 +908,7 @@ export const spo = {
         if (!wait || isComplete) {
             return;
         }
-        await setTimeout(operation.PollingInterval);
+        await timersUtil.setTimeout(pollingInterval);
         await spo.waitUntilFinished({
             operationId: JSON.stringify(operation._ObjectIdentity_),
             siteUrl: spoAdminUrl,
@@ -1051,7 +1054,7 @@ export const spo = {
                 const operation = json[json.length - 1];
                 const isComplete = operation.IsComplete;
                 if (!isComplete) {
-                    await setTimeout(operation.PollingInterval);
+                    await timersUtil.setTimeout(pollingInterval);
                     await spo.waitUntilFinished({
                         operationId: JSON.stringify(operation._ObjectIdentity_),
                         siteUrl: spoAdminUrl,
@@ -1551,14 +1554,14 @@ export const spo = {
         return file;
     },
     /**
-     * Create a SharePoint copy job to copy a file/folder to another location.
-     * @param webUrl Absolute web URL where the source file/folder is located.
-     * @param sourceUrl Absolute URL of the source file/folder.
+     * Create a SharePoint copy job to copy a file to another location.
+     * @param webUrl Absolute web URL where the source file is located.
+     * @param sourceUrl Absolute URL of the source file.
      * @param destinationUrl Absolute URL of the destination folder.
      * @param options Options for the copy job.
      * @returns Copy job information. Use {@link spo.getCopyJobResult} to get the result of the copy job.
      */
-    async createCopyJob(webUrl, sourceUrl, destinationUrl, options) {
+    async createFileCopyJob(webUrl, sourceUrl, destinationUrl, options) {
         const requestOptions = {
             url: `${webUrl}/_api/Site/CreateCopyJobs`,
             headers: {
@@ -1569,12 +1572,44 @@ export const spo = {
                 destinationUri: destinationUrl,
                 exportObjectUris: [sourceUrl],
                 options: {
-                    NameConflictBehavior: options?.nameConflictBehavior ?? CreateCopyJobsNameConflictBehavior.Fail,
+                    NameConflictBehavior: options?.nameConflictBehavior ?? CreateFileCopyJobsNameConflictBehavior.Fail,
                     AllowSchemaMismatch: true,
                     BypassSharedLock: !!options?.bypassSharedLock,
                     IgnoreVersionHistory: !!options?.ignoreVersionHistory,
+                    IncludeItemPermissions: !!options?.includeItemPermissions,
+                    CustomizedItemName: options?.newName ? [options.newName] : undefined,
+                    SameWebCopyMoveOptimization: true,
+                    IsMoveMode: options?.operation === 'move'
+                }
+            }
+        };
+        const response = await request.post(requestOptions);
+        return response.value[0];
+    },
+    /**
+     * Create a SharePoint copy job to copy a folder to another location.
+     * @param webUrl Absolute web URL where the source folder is located.
+     * @param sourceUrl Absolute URL of the source folder.
+     * @param destinationUrl Absolute URL of the destination folder.
+     * @param options Options for the copy job.
+     * @returns Copy job information. Use {@link spo.getCopyJobResult} to get the result of the copy job.
+     */
+    async createFolderCopyJob(webUrl, sourceUrl, destinationUrl, options) {
+        const requestOptions = {
+            url: `${webUrl}/_api/Site/CreateCopyJobs`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json',
+            data: {
+                destinationUri: destinationUrl,
+                exportObjectUris: [sourceUrl],
+                options: {
+                    NameConflictBehavior: options?.nameConflictBehavior ?? CreateFolderCopyJobsNameConflictBehavior.Fail,
+                    AllowSchemaMismatch: true,
                     CustomizedItemName: options?.newName ? [options.newName] : undefined,
-                    SameWebCopyMoveOptimization: true
+                    SameWebCopyMoveOptimization: true,
+                    IsMoveMode: options?.operation === 'move'
                 }
             }
         };
@@ -1599,12 +1634,20 @@ export const spo = {
                 copyJobInfo: copyJobInfo
             }
         };
+        const logs = [];
         let progress = await request.post(requestOptions);
+        const newLogs = progress.Logs?.map(l => JSON.parse(l));
+        if (newLogs?.length > 0) {
+            logs.push(...newLogs);
+        }
         while (progress.JobState !== 0) {
-            await setTimeout(settings.pollingInterval);
+            await timersUtil.setTimeout(pollingInterval);
             progress = await request.post(requestOptions);
+            const newLogs = progress.Logs?.map(l => JSON.parse(l));
+            if (newLogs?.length > 0) {
+                logs.push(...newLogs);
+            }
         }
-        const logs = progress.Logs.map(l => JSON.parse(l));
         // Check if the job has failed
         const errorLog = logs.find(l => l.Event === 'JobError');
         if (errorLog) {
@@ -1613,6 +1656,49 @@ export const spo = {
         // Get the destination object information
         const objectInfo = logs.find(l => l.Event === 'JobFinishedObjectInfo');
         return objectInfo;
+    },
+    /**
+     * 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
+     * @param verbose If in verbose mode
+     * @returns Owner login name
+     */
+    async getPrimaryAdminLoginNameAsAdmin(adminUrl, siteId, logger, verbose) {
+        if (verbose) {
+            await logger.logToStderr('Getting the primary admin login name...');
+        }
+        const requestOptions = {
+            url: `${adminUrl}/_api/SPO.Tenant/sites('${siteId}')?$select=OwnerLoginName`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        const response = await request.get(requestOptions);
+        return response.OwnerLoginName;
+    },
+    /**
+     * Gets the primary owner login from a site.
+     * @param siteUrl The site URL
+     * @param logger The logger object
+     * @param verbose If in verbose mode
+     * @returns Owner login name
+     */
+    async getPrimaryOwnerLoginFromSite(siteUrl, logger, verbose) {
+        if (verbose) {
+            await logger.logToStderr('Getting the primary admin login name...');
+        }
+        const requestOptions = {
+            url: `${siteUrl}/_api/site/owner`,
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        const responseContent = await request.get(requestOptions);
+        return responseContent?.LoginName;
     }
 };
 //# sourceMappingURL=spo.js.map

package/dist/utils/timersUtil.js

@@ -0,0 +1,13 @@
+import { setTimeout } from "timers/promises";
+export const timersUtil = {
+    /**
+     * Timeout for a specific duration.
+     * @param duration Duration in milliseconds.
+     */
+    /* c8 ignore next 4 */
+    // Function is created so we can easily mock it in our tests
+    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/dist/utils/zod.js

@@ -60,14 +60,14 @@ function parseDefault(def, _options, currentOption) {
 function parseEnum(def, _options, currentOption) {
     if (currentOption) {
         currentOption.type = 'string';
-        currentOption.autocomplete = def.values;
+        currentOption.autocomplete = [...def.values];
     }
     return;
 }
 function parseNativeEnum(def, _options, currentOption) {
     if (currentOption) {
         currentOption.type = 'string';
-        currentOption.autocomplete = Object.getOwnPropertyNames(def.values);
+        currentOption.autocomplete = Object.values(def.values).map(v => String(v));
     }
     return;
 }
@@ -119,6 +119,15 @@ export const zod = {
         const options = [];
         parseDef(schema._def, options);
         return options;
-    }
+    },
+    coercedEnum: (e) => z.preprocess(val => {
+        const target = String(val)?.toLowerCase();
+        for (const k of Object.values(e)) {
+            if (String(k)?.toLowerCase() === target) {
+                return k;
+            }
+        }
+        return null;
+    }, z.nativeEnum(e))
 };
 //# sourceMappingURL=zod.js.map

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

@@ -12,12 +12,6 @@ Creates a new administrative unit
 m365 entra administrativeunit add [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit add [options]
-```
-
 ## Options
 
 ```md definition-list

package/docs/docs/cmd/entra/administrativeunit/administrativeunit-get.mdx

@@ -12,12 +12,6 @@ Gets information about a specific administrative unit
 m365 entra administrativeunit get [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit get [options]
-```
-
 ## Options
 
 ```md definition-list

package/docs/docs/cmd/entra/administrativeunit/administrativeunit-list.mdx

@@ -12,12 +12,6 @@ Retrieves a list of administrative units
 m365 entra administrativeunit list [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit list [options]
-```
-
 ## Options
 
 <Global />

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

@@ -10,12 +10,6 @@ Add a member (user, group, or device) to an administrative unit
 m365 entra administrativeunit member add [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit member add [options]
-```
-
 ## Options
 
 ```md definition-list

package/docs/docs/cmd/entra/administrativeunit/administrativeunit-member-get.mdx

@@ -12,12 +12,6 @@ Retrieves info about a specific member of an administrative unit
 m365 entra administrativeunit member get [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit member get [options]
-```
-
 ## Options
 
 ```md definition-list

package/docs/docs/cmd/entra/administrativeunit/administrativeunit-member-list.mdx

@@ -12,12 +12,6 @@ Retrieves members (users, groups, or devices) of an administrative unit
 m365 entra administrativeunit member list [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit member list [options]
-```
-
 ## Options
 
 ```md definition-list

package/docs/docs/cmd/entra/administrativeunit/administrativeunit-remove.mdx

@@ -10,12 +10,6 @@ Removes an administrative unit
 m365 entra administrativeunit remove [options]
 ```
 
-## Alias
-
-```sh
-m365 aad administrativeunit remove [options]
-```
-
 ## options
 
 ```md definition-list

package/docs/docs/cmd/entra/app/app-add.mdx

@@ -15,7 +15,6 @@ m365 entra app add [options]
 ## Alias
 
 ```sh
-m365 aad app add [options]
 m365 entra appregistration add [options]
 ```
 

package/docs/docs/cmd/entra/app/app-get.mdx

@@ -15,7 +15,6 @@ m365 entra app get [options]
 ## Alias
 
 ```sh
-m365 aad app get [options]
 m365 entra appregistration get [options]
 ```
 

package/docs/docs/cmd/entra/app/app-list.mdx

@@ -15,7 +15,6 @@ m365 entra app list [options]
 ## Alias
 
 ```sh
-m365 aad app list [options]
 m365 entra appregistration list [options]
 ```
 

package/docs/docs/cmd/entra/app/app-permission-add.mdx

@@ -15,7 +15,6 @@ m365 entra app permission add [options]
 ## Alias
 
 ```sh
-m365 aad app permission add [options]
 m365 entra appregistration permission add [options]
 ```
 

package/docs/docs/cmd/entra/app/app-permission-list.mdx

@@ -12,12 +12,6 @@ Lists the application and delegated permissions for a specified Entra Applicatio
 m365 entra app permission list [options]
 ```
 
-## Alias
-
-```sh
-m365 aad app permission list [options]
-```
-
 ## Options
 
 ```md definition-list

package/docs/docs/cmd/entra/app/app-remove.mdx

@@ -13,7 +13,6 @@ m365 entra app remove [options]
 ## Alias
 
 ```sh
-m365 aad app remove [options]
 m365 entra appregistration remove [options]
 ```
 

package/docs/docs/cmd/entra/app/app-role-add.mdx

@@ -13,7 +13,6 @@ m365 entra app role add [options]
 ## Alias
 
 ```sh
-m365 aad app role add [options]
 m365 entra appregistration role add [options]
 ```
 

package/docs/docs/cmd/entra/app/app-role-list.mdx

@@ -15,7 +15,6 @@ m365 entra app role list [options]
 ## Alias
 
 ```sh
-m365 aad app role list [options]
 m365 entra appregistration role list [options]
 ```
 

package/docs/docs/cmd/entra/app/app-role-remove.mdx

@@ -13,7 +13,6 @@ m365 entra app role remove [options]
 ## Alias
 
 ```sh
-m365 aad app role remove [options]
 m365 entra appregistration role remove [options]
 ```
 

package/docs/docs/cmd/entra/app/app-set.mdx

@@ -13,7 +13,6 @@ m365 entra app set [options]
 ## Alias
 
 ```sh
-m365 aad app set [options]
 m365 entra appregistration set [options]
 ```
 

package/docs/docs/cmd/entra/approleassignment/approleassignment-add.mdx

@@ -12,12 +12,6 @@ Adds service principal permissions also known as scopes and app role assignments
 m365 entra approleassignment add [options]
 ```
 
-## Alias
-
-```sh
-m365 aad approleassignment add [options]
-```
-
 ## Options
 
 ```md definition-list

package/docs/docs/cmd/entra/approleassignment/approleassignment-list.mdx

@@ -12,12 +12,6 @@ Lists app role assignments for the specified application registration
 m365 entra approleassignment list [options]
 ```
 
-## Alias
-
-```sh
-m365 aad approleassignment list [options]
-```
-
 ## Options
 
 ```md definition-list

package/docs/docs/cmd/entra/approleassignment/approleassignment-remove.mdx

@@ -10,12 +10,6 @@ Deletes an app role assignment for the specified Entra application registration
 m365 entra approleassignment remove [options]
 ```
 
-## Alias
-
-```sh
-m365 aad approleassignment remove [options]
-```
-
 ## Options
 
 ```md definition-list

package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-add.mdx

@@ -15,7 +15,6 @@ m365 entra enterpriseapp add [options]
 ## Alias
 
 ```sh
-m365 aad sp add [options]
 m365 entra sp add [options]
 ```
 

package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-get.mdx

@@ -15,7 +15,6 @@ m365 entra enterpriseapp get [options]
 ## Alias
 
 ```sh
-m365 aad sp get [options]
 m365 entra sp get [options]
 ```