@pnp/cli-microsoft365 9.0.0-beta.62575a1 → 9.0.0-beta.872d524

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (147) hide show
  1. package/allCommands.json +1 -1
  2. package/allCommandsFull.json +1 -1
  3. package/dist/Auth.js +9 -9
  4. package/dist/Command.js +49 -2
  5. package/dist/cli/cli.js +66 -39
  6. package/dist/config.js +1 -1
  7. package/dist/m365/app/commands/permission/permission-add.js +9 -9
  8. package/dist/m365/cli/commands/cli-consent.js +3 -7
  9. package/dist/m365/commands/login.js +44 -96
  10. package/dist/m365/commands/status.js +2 -2
  11. package/dist/m365/connection/commands/connection-remove.js +6 -2
  12. package/dist/m365/connection/commands/connection-set.js +4 -1
  13. package/dist/m365/connection/commands/connection-use.js +25 -4
  14. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-add.js +13 -13
  15. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-get.js +18 -18
  16. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-list.js +1 -1
  17. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-remove.js +123 -0
  18. package/dist/m365/entra/commands/group/group-set.js +256 -0
  19. package/dist/m365/entra/commands/group/group-user-list.js +4 -4
  20. package/dist/m365/entra/commands/m365group/m365group-conversation-post-list.js +4 -4
  21. package/dist/m365/entra/commands/m365group/m365group-recyclebinitem-list.js +3 -3
  22. package/dist/m365/entra/commands/m365group/m365group-user-add.js +109 -32
  23. package/dist/m365/entra/commands/m365group/m365group-user-list.js +6 -9
  24. package/dist/m365/entra/commands/m365group/m365group-user-set.js +159 -84
  25. package/dist/m365/entra/commands/multitenant/multitenant-add.js +65 -0
  26. package/dist/m365/entra/commands/multitenant/multitenant-remove.js +118 -0
  27. package/dist/m365/entra/commands/multitenant/multitenant-set.js +72 -0
  28. package/dist/m365/entra/commands.js +6 -0
  29. package/dist/m365/flow/commands/flow-get.js +1 -1
  30. package/dist/m365/outlook/commands/message/message-get.js +11 -11
  31. package/dist/m365/pa/commands/app/app-export.js +13 -7
  32. package/dist/m365/spe/ContainerTypeProperties.js +2 -0
  33. package/dist/m365/spe/commands/containertype/containertype-list.js +49 -0
  34. package/dist/m365/spe/commands.js +2 -1
  35. package/dist/m365/spfx/commands/project/DeployWorkflow.js +1 -1
  36. package/dist/m365/spfx/commands/project/project-github-workflow-add.js +1 -10
  37. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-get.js +16 -22
  38. package/dist/m365/spo/commands/commandset/commandset-get.js +31 -17
  39. package/dist/m365/spo/commands/file/file-copy.js +55 -34
  40. package/dist/m365/spo/commands/file/file-roleassignment-add.js +1 -1
  41. package/dist/m365/spo/commands/file/file-roleinheritance-break.js +1 -1
  42. package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +1 -1
  43. package/dist/m365/spo/commands/folder/folder-retentionlabel-ensure.js +1 -1
  44. package/dist/m365/spo/commands/folder/folder-set.js +0 -4
  45. package/dist/m365/spo/commands/folder/folder-sharinglink-get.js +86 -0
  46. package/dist/m365/spo/commands/folder/folder-sharinglink-list.js +110 -0
  47. package/dist/m365/spo/commands/list/ListInstance.js +6 -1
  48. package/dist/m365/spo/commands/list/list-get.js +9 -3
  49. package/dist/m365/spo/commands/list/list-list.js +1 -4
  50. package/dist/m365/spo/commands/list/list-roleassignment-add.js +46 -21
  51. package/dist/m365/spo/commands/list/list-roleassignment-remove.js +48 -46
  52. package/dist/m365/spo/commands/site/site-appcatalog-remove.js +48 -24
  53. package/dist/m365/spo/commands/site/site-remove.js +1 -7
  54. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +19 -5
  55. package/dist/m365/spo/commands/tenant/tenant-commandset-get.js +20 -6
  56. package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-restore.js +2 -22
  57. package/dist/m365/spo/commands.js +2 -1
  58. package/dist/m365/teams/commands/message/message-restore.js +106 -0
  59. package/dist/m365/teams/commands.js +1 -0
  60. package/dist/m365/viva/commands/engage/engage-group-list.js +0 -5
  61. package/dist/m365/viva/commands/engage/engage-group-user-add.js +0 -5
  62. package/dist/m365/viva/commands/engage/engage-group-user-remove.js +0 -5
  63. package/dist/m365/viva/commands/engage/engage-message-add.js +0 -5
  64. package/dist/m365/viva/commands/engage/engage-message-get.js +0 -5
  65. package/dist/m365/viva/commands/engage/engage-message-like-set.js +0 -5
  66. package/dist/m365/viva/commands/engage/engage-message-list.js +0 -5
  67. package/dist/m365/viva/commands/engage/engage-message-remove.js +0 -5
  68. package/dist/m365/viva/commands/engage/engage-network-list.js +0 -5
  69. package/dist/m365/viva/commands/engage/engage-report-activitycounts.js +0 -8
  70. package/dist/m365/viva/commands/engage/engage-report-activityusercounts.js +0 -8
  71. package/dist/m365/viva/commands/engage/engage-report-activityuserdetail.js +0 -8
  72. package/dist/m365/viva/commands/engage/engage-report-deviceusagedistributionusercounts.js +0 -8
  73. package/dist/m365/viva/commands/engage/engage-report-deviceusageusercounts.js +0 -8
  74. package/dist/m365/viva/commands/engage/engage-report-deviceusageuserdetail.js +0 -8
  75. package/dist/m365/viva/commands/engage/engage-report-groupsactivitycounts.js +0 -8
  76. package/dist/m365/viva/commands/engage/engage-report-groupsactivitydetail.js +0 -8
  77. package/dist/m365/viva/commands/engage/engage-report-groupsactivitygroupcounts.js +0 -8
  78. package/dist/m365/viva/commands/engage/engage-search.js +0 -5
  79. package/dist/m365/viva/commands/engage/engage-user-get.js +0 -5
  80. package/dist/m365/viva/commands/engage/engage-user-list.js +0 -5
  81. package/dist/utils/drive.js +61 -0
  82. package/dist/utils/formatting.js +16 -0
  83. package/dist/utils/spo.js +143 -6
  84. package/dist/utils/zod.js +124 -0
  85. package/docs/docs/cmd/app/permission/permission-add.mdx +5 -5
  86. package/docs/docs/cmd/cli/cli-consent.mdx +1 -1
  87. package/docs/docs/cmd/connection/connection-use.mdx +8 -2
  88. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-add.mdx +12 -12
  89. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-get.mdx +14 -14
  90. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-list.mdx +5 -5
  91. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-remove.mdx +65 -0
  92. package/docs/docs/cmd/entra/group/group-add.mdx +0 -4
  93. package/docs/docs/cmd/entra/group/group-set.mdx +89 -0
  94. package/docs/docs/cmd/entra/group/group-user-list.mdx +7 -7
  95. package/docs/docs/cmd/entra/m365group/m365group-conversation-post-list.mdx +5 -5
  96. package/docs/docs/cmd/entra/m365group/m365group-recyclebinitem-list.mdx +3 -3
  97. package/docs/docs/cmd/entra/m365group/m365group-user-add.mdx +28 -10
  98. package/docs/docs/cmd/entra/m365group/m365group-user-list.mdx +1 -1
  99. package/docs/docs/cmd/entra/m365group/m365group-user-set.mdx +35 -11
  100. package/docs/docs/cmd/entra/multitenant/multitenant-add.mdx +107 -0
  101. package/docs/docs/cmd/entra/multitenant/multitenant-remove.mdx +58 -0
  102. package/docs/docs/cmd/entra/multitenant/multitenant-set.mdx +53 -0
  103. package/docs/docs/cmd/flow/flow-get.mdx +149 -283
  104. package/docs/docs/cmd/outlook/message/message-get.mdx +5 -5
  105. package/docs/docs/cmd/pa/app/app-export.mdx +15 -9
  106. package/docs/docs/cmd/planner/plan/plan-remove.mdx +1 -1
  107. package/docs/docs/cmd/spe/containertype/containertype-list.mdx +102 -0
  108. package/docs/docs/cmd/spfx/project/project-github-workflow-add.mdx +11 -12
  109. package/docs/docs/cmd/spo/app/app-uninstall.mdx +1 -1
  110. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +88 -38
  111. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx +22 -28
  112. package/docs/docs/cmd/spo/commandset/commandset-get.mdx +75 -24
  113. package/docs/docs/cmd/spo/commandset/commandset-list.mdx +26 -32
  114. package/docs/docs/cmd/spo/file/file-copy.mdx +119 -12
  115. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +1 -1
  116. package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +2 -2
  117. package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +1 -1
  118. package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +1 -1
  119. package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +1 -1
  120. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +2 -2
  121. package/docs/docs/cmd/spo/folder/folder-set.mdx +0 -6
  122. package/docs/docs/cmd/spo/folder/folder-sharinglink-get.mdx +110 -0
  123. package/docs/docs/cmd/spo/folder/folder-sharinglink-list.mdx +114 -0
  124. package/docs/docs/cmd/spo/list/list-get.mdx +6 -0
  125. package/docs/docs/cmd/spo/list/list-list.mdx +5 -7
  126. package/docs/docs/cmd/spo/list/list-roleassignment-add.mdx +15 -3
  127. package/docs/docs/cmd/spo/list/list-roleassignment-remove.mdx +15 -3
  128. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.mdx +4 -4
  129. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-remove.mdx +1 -1
  130. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.mdx +9 -9
  131. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-remove.mdx +7 -7
  132. package/docs/docs/cmd/spo/site/site-appcatalog-remove.mdx +11 -2
  133. package/docs/docs/cmd/spo/site/site-recyclebinitem-list.mdx +1 -1
  134. package/docs/docs/cmd/spo/site/site-remove.mdx +0 -3
  135. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.mdx +79 -30
  136. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.mdx +20 -19
  137. package/docs/docs/cmd/spo/tenant/tenant-commandset-get.mdx +84 -38
  138. package/docs/docs/cmd/spo/tenant/tenant-commandset-list.mdx +20 -19
  139. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.mdx +2 -49
  140. package/docs/docs/cmd/spo/web/web-roleassignment-add.mdx +1 -1
  141. package/docs/docs/cmd/spo/web/web-roleassignment-remove.mdx +1 -1
  142. package/docs/docs/cmd/teams/meeting/meeting-list.mdx +7 -3
  143. package/docs/docs/cmd/teams/message/message-remove.mdx +2 -1
  144. package/docs/docs/cmd/teams/message/message-restore.mdx +62 -0
  145. package/npm-shrinkwrap.json +1002 -1147
  146. package/package.json +26 -23
  147. package/dist/m365/viva/commands/engage/yammerCommands.js +0 -25
@@ -9,7 +9,6 @@ import request from '../../../../request.js';
9
9
  import { formatting } from '../../../../utils/formatting.js';
10
10
  import VivaEngageCommand from '../../../base/VivaEngageCommand.js';
11
11
  import commands from '../../commands.js';
12
- import yammerCommands from './yammerCommands.js';
13
12
  class VivaEngageSearchCommand extends VivaEngageCommand {
14
13
  get name() {
15
14
  return commands.ENGAGE_SEARCH;
@@ -17,9 +16,6 @@ class VivaEngageSearchCommand extends VivaEngageCommand {
17
16
  get description() {
18
17
  return 'Returns a list of messages, users, topics and groups that match the specified query.';
19
18
  }
20
- alias() {
21
- return [yammerCommands.SEARCH];
22
- }
23
19
  constructor() {
24
20
  super();
25
21
  _VivaEngageSearchCommand_instances.add(this);
@@ -93,7 +89,6 @@ class VivaEngageSearchCommand extends VivaEngageCommand {
93
89
  }
94
90
  }
95
91
  async commandAction(logger, args) {
96
- await this.showDeprecationWarning(logger, this.alias()[0], this.name);
97
92
  this.summary = {
98
93
  messages: 0,
99
94
  groups: 0,
@@ -8,7 +8,6 @@ import request from '../../../../request.js';
8
8
  import { formatting } from '../../../../utils/formatting.js';
9
9
  import VivaEngageCommand from '../../../base/VivaEngageCommand.js';
10
10
  import commands from '../../commands.js';
11
- import yammerCommands from './yammerCommands.js';
12
11
  class VivaEngageUserGetCommand extends VivaEngageCommand {
13
12
  get name() {
14
13
  return commands.ENGAGE_USER_GET;
@@ -16,9 +15,6 @@ class VivaEngageUserGetCommand extends VivaEngageCommand {
16
15
  get description() {
17
16
  return 'Retrieves the current user or searches for a user by ID or e-mail';
18
17
  }
19
- alias() {
20
- return [yammerCommands.USER_GET];
21
- }
22
18
  defaultProperties() {
23
19
  return ['id', 'full_name', 'email', 'job_title', 'state', 'url'];
24
20
  }
@@ -30,7 +26,6 @@ class VivaEngageUserGetCommand extends VivaEngageCommand {
30
26
  __classPrivateFieldGet(this, _VivaEngageUserGetCommand_instances, "m", _VivaEngageUserGetCommand_initValidators).call(this);
31
27
  }
32
28
  async commandAction(logger, args) {
33
- await this.showDeprecationWarning(logger, this.alias()[0], this.name);
34
29
  let endPoint = `${this.resource}/v1/users/current.json`;
35
30
  if (args.options.id) {
36
31
  endPoint = `${this.resource}/v1/users/${args.options.id}.json`;
@@ -7,7 +7,6 @@ var _VivaEngageUserListCommand_instances, _VivaEngageUserListCommand_initTelemet
7
7
  import request from '../../../../request.js';
8
8
  import VivaEngageCommand from '../../../base/VivaEngageCommand.js';
9
9
  import commands from '../../commands.js';
10
- import yammerCommands from './yammerCommands.js';
11
10
  class VivaEngageUserListCommand extends VivaEngageCommand {
12
11
  get name() {
13
12
  return commands.ENGAGE_USER_LIST;
@@ -15,9 +14,6 @@ class VivaEngageUserListCommand extends VivaEngageCommand {
15
14
  get description() {
16
15
  return 'Returns users from the current network';
17
16
  }
18
- alias() {
19
- return [yammerCommands.USER_LIST];
20
- }
21
17
  defaultProperties() {
22
18
  return ['id', 'full_name', 'email'];
23
19
  }
@@ -92,7 +88,6 @@ class VivaEngageUserListCommand extends VivaEngageCommand {
92
88
  });
93
89
  }
94
90
  async commandAction(logger, args) {
95
- await this.showDeprecationWarning(logger, this.alias()[0], this.name);
96
91
  this.items = []; // this will reset the items array in interactive mode
97
92
  try {
98
93
  await this.getAllItems(logger, args, 1);
@@ -0,0 +1,61 @@
1
+ import request from "../request.js";
2
+ export const drive = {
3
+ /**
4
+ * Retrieves the Drive associated with the specified site and URL.
5
+ * @param siteId Site ID
6
+ * @param url Drive URL
7
+ * @param logger The logger object
8
+ * @param verbose Set for verbose logging
9
+ * @returns The Drive associated with the drive URL.
10
+ */
11
+ async getDriveByUrl(siteId, url, logger, verbose) {
12
+ if (verbose && logger) {
13
+ await logger.logToStderr(`Retrieving drive information for URL: ${url.href}`);
14
+ }
15
+ const requestOptions = {
16
+ url: `https://graph.microsoft.com/v1.0/sites/${siteId}/drives?$select=webUrl,id`,
17
+ headers: {
18
+ accept: 'application/json;odata.metadata=none'
19
+ },
20
+ responseType: 'json'
21
+ };
22
+ const drives = await request.get(requestOptions);
23
+ const lowerCaseFolderUrl = url.href.toLowerCase();
24
+ const drive = drives.value
25
+ .sort((a, b) => b.webUrl.localeCompare(a.webUrl))
26
+ .find((d) => {
27
+ const driveUrl = d.webUrl.toLowerCase();
28
+ return lowerCaseFolderUrl.startsWith(driveUrl) &&
29
+ (driveUrl.length === lowerCaseFolderUrl.length ||
30
+ lowerCaseFolderUrl[driveUrl.length] === '/');
31
+ });
32
+ if (!drive) {
33
+ throw new Error(`Drive '${url.href}' not found`);
34
+ }
35
+ return drive;
36
+ },
37
+ /**
38
+ * Retrieves the ID of a drive item (file, folder, etc.) associated with the given drive and item URL.
39
+ * @param drive The Drive object containing the item
40
+ * @param itemUrl Item URL
41
+ * @param logger The logger object
42
+ * @param verbose Set for verbose logging
43
+ * @returns Drive item ID
44
+ */
45
+ async getDriveItemId(drive, itemUrl, logger, verbose) {
46
+ const relativeItemUrl = itemUrl.href.replace(new RegExp(`${drive.webUrl}`, 'i'), '').replace(/\/+$/, '');
47
+ if (verbose && logger) {
48
+ await logger.logToStderr(`Retrieving drive item ID for URL: ${relativeItemUrl}`);
49
+ }
50
+ const requestOptions = {
51
+ url: `https://graph.microsoft.com/v1.0/drives/${drive.id}/root${relativeItemUrl ? `:${relativeItemUrl}` : ''}?$select=id`,
52
+ headers: {
53
+ accept: 'application/json;odata.metadata=none'
54
+ },
55
+ responseType: 'json'
56
+ };
57
+ const driveItem = await request.get(requestOptions);
58
+ return driveItem?.id;
59
+ }
60
+ };
61
+ //# sourceMappingURL=drive.js.map
@@ -39,6 +39,22 @@ export const formatting = {
39
39
  parseJsonWithBom(s) {
40
40
  return JSON.parse(s.replace(/^\uFEFF/, ''));
41
41
  },
42
+ /**
43
+ * Tries to parse a string as JSON. If it fails, returns the original string.
44
+ * @param value JSON string to parse.
45
+ * @returns JSON object or the original string if parsing fails.
46
+ */
47
+ tryParseJson(value) {
48
+ try {
49
+ if (typeof value !== 'string') {
50
+ return value;
51
+ }
52
+ return JSON.parse(value);
53
+ }
54
+ catch {
55
+ return value;
56
+ }
57
+ },
42
58
  filterObject(obj, propertiesToInclude) {
43
59
  const objKeys = Object.keys(obj);
44
60
  return propertiesToInclude
package/dist/utils/spo.js CHANGED
@@ -12,6 +12,16 @@ import { RoleType } from '../m365/spo/commands/roledefinition/RoleType.js';
12
12
  import { entraGroup } from './entraGroup.js';
13
13
  import { SharingCapabilities } from '../m365/spo/commands/site/SharingCapabilities.js';
14
14
  import { setTimeout } from 'timers/promises';
15
+ export var CreateCopyJobsNameConflictBehavior;
16
+ (function (CreateCopyJobsNameConflictBehavior) {
17
+ CreateCopyJobsNameConflictBehavior[CreateCopyJobsNameConflictBehavior["Fail"] = 0] = "Fail";
18
+ CreateCopyJobsNameConflictBehavior[CreateCopyJobsNameConflictBehavior["Replace"] = 1] = "Replace";
19
+ CreateCopyJobsNameConflictBehavior[CreateCopyJobsNameConflictBehavior["Rename"] = 2] = "Rename";
20
+ })(CreateCopyJobsNameConflictBehavior || (CreateCopyJobsNameConflictBehavior = {}));
21
+ // Wrapping this into a settings object so we can alter the values in tests
22
+ export const settings = {
23
+ pollingInterval: 3000
24
+ };
15
25
  export const spo = {
16
26
  async getRequestDigest(siteUrl) {
17
27
  const requestOptions = {
@@ -454,15 +464,46 @@ export const spo = {
454
464
  const res = await request.get(requestOptions);
455
465
  return res.AadObjectId.NameId;
456
466
  },
467
+ /**
468
+ * Ensure a user exists on a specific SharePoint site.
469
+ * @param webUrl URL of the SharePoint site.
470
+ * @param logonName Logon name of the user to ensure on the SharePoint site.
471
+ * @returns SharePoint user object.
472
+ */
473
+ async ensureUser(webUrl, logonName) {
474
+ const requestOptions = {
475
+ url: `${webUrl}/_api/web/EnsureUser`,
476
+ headers: {
477
+ accept: 'application/json;odata=nometadata'
478
+ },
479
+ responseType: 'json',
480
+ data: {
481
+ logonName: logonName
482
+ }
483
+ };
484
+ return request.post(requestOptions);
485
+ },
486
+ /**
487
+ * Ensure a Microsoft Entra ID group exists on a specific SharePoint site.
488
+ * @param webUrl URL of the SharePoint site.
489
+ * @param group Microsoft Entra ID group.
490
+ * @returns SharePoint user object.
491
+ */
492
+ async ensureEntraGroup(webUrl, group) {
493
+ if (!group.securityEnabled) {
494
+ throw new Error('Cannot ensure a Microsoft Entra ID group that is not security enabled.');
495
+ }
496
+ return this.ensureUser(webUrl, group.mailEnabled ? `c:0o.c|federateddirectoryclaimprovider|${group.id}` : `c:0t.c|tenant|${group.id}`);
497
+ },
457
498
  /**
458
499
  * Retrieves the spo user by email.
459
500
  * @param webUrl Web url
460
501
  * @param email The email of the user
461
502
  * @param logger the Logger object
462
- * @param debug set if debug logging should be logged
503
+ * @param verbose set if verbose logging should be logged
463
504
  */
464
- async getUserByEmail(webUrl, email, logger, debug) {
465
- if (debug) {
505
+ async getUserByEmail(webUrl, email, logger, verbose) {
506
+ if (verbose) {
466
507
  await logger.logToStderr(`Retrieving the spo user by email ${email}`);
467
508
  }
468
509
  const requestUrl = `${webUrl}/_api/web/siteusers/GetByEmail('${formatting.encodeQueryParameter(email)}')`;
@@ -533,10 +574,10 @@ export const spo = {
533
574
  * @param webUrl Web url
534
575
  * @param name The name of the group
535
576
  * @param logger the Logger object
536
- * @param debug set if debug logging should be logged
577
+ * @param verbose set if verbose logging should be logged
537
578
  */
538
- async getGroupByName(webUrl, name, logger, debug) {
539
- if (debug) {
579
+ async getGroupByName(webUrl, name, logger, verbose) {
580
+ if (verbose) {
540
581
  await logger.logToStderr(`Retrieving the group by name ${name}`);
541
582
  }
542
583
  const requestUrl = `${webUrl}/_api/web/sitegroups/GetByName('${formatting.encodeQueryParameter(name)}')`;
@@ -1374,6 +1415,38 @@ export const spo = {
1374
1415
  const site = await request.get(requestOptions);
1375
1416
  return site.id;
1376
1417
  },
1418
+ /**
1419
+ * Retrieves the server-relative URL of a folder.
1420
+ * @param webUrl Web URL
1421
+ * @param folderUrl Folder URL
1422
+ * @param folderId Folder ID
1423
+ * @param logger The logger object
1424
+ * @param verbose Set for verbose logging
1425
+ * @returns The server-relative URL of the folder
1426
+ */
1427
+ async getFolderServerRelativeUrl(webUrl, folderUrl, folderId, logger, verbose) {
1428
+ if (verbose && logger) {
1429
+ await logger.logToStderr(`Retrieving server-relative URL for folder ${folderUrl ? `URL: ${folderUrl}` : `ID: ${folderId}`}`);
1430
+ }
1431
+ let requestUrl = `${webUrl}/_api/web/`;
1432
+ if (folderUrl) {
1433
+ const folderServerRelativeUrl = urlUtil.getServerRelativePath(webUrl, folderUrl);
1434
+ requestUrl += `GetFolderByServerRelativePath(decodedUrl='${formatting.encodeQueryParameter(folderServerRelativeUrl)}')`;
1435
+ }
1436
+ else {
1437
+ requestUrl += `GetFolderById('${folderId}')`;
1438
+ }
1439
+ requestUrl += '?$select=ServerRelativeUrl';
1440
+ const requestOptions = {
1441
+ url: requestUrl,
1442
+ headers: {
1443
+ accept: 'application/json;odata=nometadata'
1444
+ },
1445
+ responseType: 'json'
1446
+ };
1447
+ const res = await request.get(requestOptions);
1448
+ return res.ServerRelativeUrl;
1449
+ },
1377
1450
  /**
1378
1451
  * Retrieves the ObjectIdentity from a SharePoint site
1379
1452
  * @param webUrl web url
@@ -1453,6 +1526,70 @@ export const spo = {
1453
1526
  };
1454
1527
  const itemsResponse = await request.get(requestOptionsItems);
1455
1528
  return (itemsResponse);
1529
+ },
1530
+ /**
1531
+ * Create a SharePoint copy job to copy a file/folder to another location.
1532
+ * @param webUrl Absolute web URL where the source file/folder is located.
1533
+ * @param sourceUrl Absolute URL of the source file/folder.
1534
+ * @param destinationUrl Absolute URL of the destination folder.
1535
+ * @param options Options for the copy job.
1536
+ * @returns Copy job information. Use {@link spo.getCopyJobResult} to get the result of the copy job.
1537
+ */
1538
+ async createCopyJob(webUrl, sourceUrl, destinationUrl, options) {
1539
+ const requestOptions = {
1540
+ url: `${webUrl}/_api/Site/CreateCopyJobs`,
1541
+ headers: {
1542
+ accept: 'application/json;odata=nometadata'
1543
+ },
1544
+ responseType: 'json',
1545
+ data: {
1546
+ destinationUri: destinationUrl,
1547
+ exportObjectUris: [sourceUrl],
1548
+ options: {
1549
+ NameConflictBehavior: options?.nameConflictBehavior ?? CreateCopyJobsNameConflictBehavior.Fail,
1550
+ AllowSchemaMismatch: true,
1551
+ BypassSharedLock: !!options?.bypassSharedLock,
1552
+ IgnoreVersionHistory: !!options?.ignoreVersionHistory,
1553
+ CustomizedItemName: options?.newName ? [options.newName] : undefined,
1554
+ SameWebCopyMoveOptimization: true
1555
+ }
1556
+ }
1557
+ };
1558
+ const response = await request.post(requestOptions);
1559
+ return response.value[0];
1560
+ },
1561
+ /**
1562
+ * Poll until the copy job is finished and return the result.
1563
+ * @param webUrl Absolute web URL where the copy job was created.
1564
+ * @param copyJobInfo Information about the copy job.
1565
+ * @throws Error if the copy job has failed.
1566
+ * @returns Information about the destination object.
1567
+ */
1568
+ async getCopyJobResult(webUrl, copyJobInfo) {
1569
+ const requestOptions = {
1570
+ url: `${webUrl}/_api/Site/GetCopyJobProgress`,
1571
+ headers: {
1572
+ accept: 'application/json;odata=nometadata'
1573
+ },
1574
+ responseType: 'json',
1575
+ data: {
1576
+ copyJobInfo: copyJobInfo
1577
+ }
1578
+ };
1579
+ let progress = await request.post(requestOptions);
1580
+ while (progress.JobState !== 0) {
1581
+ await setTimeout(settings.pollingInterval);
1582
+ progress = await request.post(requestOptions);
1583
+ }
1584
+ const logs = progress.Logs.map(l => JSON.parse(l));
1585
+ // Check if the job has failed
1586
+ const errorLog = logs.find(l => l.Event === 'JobError');
1587
+ if (errorLog) {
1588
+ throw new Error(errorLog.Message);
1589
+ }
1590
+ // Get the destination object information
1591
+ const objectInfo = logs.find(l => l.Event === 'JobFinishedObjectInfo');
1592
+ return objectInfo;
1456
1593
  }
1457
1594
  };
1458
1595
  //# sourceMappingURL=spo.js.map
@@ -0,0 +1,124 @@
1
+ import { z } from 'zod';
2
+ function parseEffect(def, _options, _currentOption) {
3
+ return def.schema._def;
4
+ }
5
+ function parseIntersection(def, _options, _currentOption) {
6
+ if (def.left._def.typeName !== z.ZodFirstPartyTypeKind.ZodAny) {
7
+ return def.left._def;
8
+ }
9
+ if (def.right._def.typeName !== z.ZodFirstPartyTypeKind.ZodAny) {
10
+ return def.right._def;
11
+ }
12
+ return;
13
+ }
14
+ function parseObject(def, options, _currentOption) {
15
+ const properties = def.shape();
16
+ for (const key in properties) {
17
+ const property = properties[key];
18
+ const option = {
19
+ name: key,
20
+ long: key,
21
+ short: property._def.alias,
22
+ required: true,
23
+ type: 'string'
24
+ };
25
+ parseDef(property._def, options, option);
26
+ options.push(option);
27
+ }
28
+ return;
29
+ }
30
+ function parseString(_def, _options, currentOption) {
31
+ if (currentOption) {
32
+ currentOption.type = 'string';
33
+ }
34
+ return;
35
+ }
36
+ function parseNumber(_def, _options, currentOption) {
37
+ if (currentOption) {
38
+ currentOption.type = 'number';
39
+ }
40
+ return;
41
+ }
42
+ function parseBoolean(_def, _options, currentOption) {
43
+ if (currentOption) {
44
+ currentOption.type = 'boolean';
45
+ }
46
+ return;
47
+ }
48
+ function parseOptional(def, _options, currentOption) {
49
+ if (currentOption) {
50
+ currentOption.required = false;
51
+ }
52
+ return def.innerType._def;
53
+ }
54
+ function parseDefault(def, _options, currentOption) {
55
+ if (currentOption) {
56
+ currentOption.required = false;
57
+ }
58
+ return def.innerType._def;
59
+ }
60
+ function parseEnum(def, _options, currentOption) {
61
+ if (currentOption) {
62
+ currentOption.type = 'string';
63
+ currentOption.autocomplete = def.values;
64
+ }
65
+ return;
66
+ }
67
+ function parseNativeEnum(def, _options, currentOption) {
68
+ if (currentOption) {
69
+ currentOption.type = 'string';
70
+ currentOption.autocomplete = Object.getOwnPropertyNames(def.values);
71
+ }
72
+ return;
73
+ }
74
+ function getParseFn(typeName) {
75
+ switch (typeName) {
76
+ case z.ZodFirstPartyTypeKind.ZodEffects:
77
+ return parseEffect;
78
+ case z.ZodFirstPartyTypeKind.ZodObject:
79
+ return parseObject;
80
+ case z.ZodFirstPartyTypeKind.ZodOptional:
81
+ return parseOptional;
82
+ case z.ZodFirstPartyTypeKind.ZodString:
83
+ return parseString;
84
+ case z.ZodFirstPartyTypeKind.ZodNumber:
85
+ return parseNumber;
86
+ case z.ZodFirstPartyTypeKind.ZodBoolean:
87
+ return parseBoolean;
88
+ case z.ZodFirstPartyTypeKind.ZodEnum:
89
+ return parseEnum;
90
+ case z.ZodFirstPartyTypeKind.ZodNativeEnum:
91
+ return parseNativeEnum;
92
+ case z.ZodFirstPartyTypeKind.ZodDefault:
93
+ return parseDefault;
94
+ case z.ZodFirstPartyTypeKind.ZodIntersection:
95
+ return parseIntersection;
96
+ default:
97
+ return;
98
+ }
99
+ }
100
+ function parseDef(def, options, currentOption) {
101
+ let parsedDef = def;
102
+ do {
103
+ const parse = getParseFn(parsedDef.typeName);
104
+ if (!parse) {
105
+ break;
106
+ }
107
+ parsedDef = parse(parsedDef, options, currentOption);
108
+ if (!parsedDef) {
109
+ break;
110
+ }
111
+ } while (parsedDef);
112
+ }
113
+ export const zod = {
114
+ alias(alias, type) {
115
+ type._def.alias = alias;
116
+ return type;
117
+ },
118
+ schemaToOptions(schema) {
119
+ const options = [];
120
+ parseDef(schema._def, options);
121
+ return options;
122
+ }
123
+ };
124
+ //# sourceMappingURL=zod.js.map
@@ -16,10 +16,10 @@ m365 app permission add [options]
16
16
  `--appId [appId]`
17
17
  : Client ID of the Microsoft Entra app registered in the .m365rc.json file to retrieve API permissions for.
18
18
 
19
- `--applicationPermission [applicationPermission]`
19
+ `--applicationPermissions [applicationPermissions]`
20
20
  : Space-separated list of application permissions to add.
21
21
 
22
- `--delegatedPermission [delegatedPermission]`
22
+ `--delegatedPermissions [delegatedPermissions]`
23
23
  : Space-separated list of delegated permissions to add.
24
24
 
25
25
  `--grantAdminConsent`
@@ -37,19 +37,19 @@ If you have multiple apps registered in your .m365rc.json file, you can specify
37
37
  Adds the specified application permissions to the default app registered in the _.m365rc.json_ file while granting admin consent.
38
38
 
39
39
  ```sh
40
- m365 app permission add --applicationPermission 'https://graph.microsoft.com/User.ReadWrite.All https://graph.microsoft.com/User.Read.All' --grantAdminConsent
40
+ m365 app permission add --applicationPermissions 'https://graph.microsoft.com/User.ReadWrite.All https://graph.microsoft.com/User.Read.All' --grantAdminConsent
41
41
  ```
42
42
 
43
43
  Adds the specified delegated permissions to the default app registered in the _.m365rc.json_ file without granting admin consent.
44
44
 
45
45
  ```sh
46
- m365 app permission add --delegatedPermission 'https://graph.microsoft.com/offline_access'
46
+ m365 app permission add --delegatedPermissions 'https://graph.microsoft.com/offline_access'
47
47
  ```
48
48
 
49
49
  Adds the specified application and delegated permissions to a specific app registered in the _.m365rc.json_ file while granting admin consent.
50
50
 
51
51
  ```sh
52
- m365 app permission add --appId '1663767b-4172-4519-bfd1-28e6ff19055b' --applicationPermission 'https://graph.microsoft.com/User.ReadWrite.All https://graph.microsoft.com/User.Read.All' --delegatedPermission 'https://graph.microsoft.com/offline_access' --grantAdminConsent
52
+ m365 app permission add --appId '1663767b-4172-4519-bfd1-28e6ff19055b' --applicationPermissions 'https://graph.microsoft.com/User.ReadWrite.All https://graph.microsoft.com/User.Read.All' --delegatedPermissions 'https://graph.microsoft.com/offline_access' --grantAdminConsent
53
53
  ```
54
54
 
55
55
  ## Response
@@ -16,7 +16,7 @@ m365 cli consent [options]
16
16
 
17
17
  ```md definition-list
18
18
  `-s, --service <service>`
19
- : Service for which to consent permissions. Allowed values: `VivaEngage`, (deprecated)`yammer`.
19
+ : Service for which to consent permissions. Allowed values: `VivaEngage`.
20
20
  ```
21
21
 
22
22
  <Global />
@@ -15,7 +15,7 @@ m365 connection use [options]
15
15
  ## Options
16
16
 
17
17
  ```md definition-list
18
- `-n, --name <name>`
18
+ `-n, --name [name]`
19
19
  : The name of the connection to switch to.
20
20
  ```
21
21
 
@@ -23,7 +23,13 @@ m365 connection use [options]
23
23
 
24
24
  ## Remarks
25
25
 
26
- The value for `--name` can be found by running [m365 connection list](connection-list.mdx). You can update the name of a connection by running [m365 connection set](connection-set.mdx).
26
+ :::tip
27
+
28
+ If you haven't disabled the "prompt" setting, running this command without options will show a list of available connections. You can then select the connection to activate it.
29
+
30
+ :::
31
+
32
+ You can update the name of a connection by running [m365 connection set](connection-set.mdx).
27
33
 
28
34
  ## Examples
29
35
 
@@ -22,39 +22,39 @@ m365 entra sp add [options]
22
22
  ## Options
23
23
 
24
24
  ```md definition-list
25
- `--appId [appId]`
26
- : ID of the app for which the enterprise application should be created
25
+ `-i, --id [id]`
26
+ : ID of the app for which the enterprise application should be created.
27
27
 
28
- `--appName [appName]`
29
- : Display name of the app for which the enterprise application should be created
28
+ `-n, --displayName [displayName]`
29
+ : Display name of the app for which the enterprise application should be created.
30
30
 
31
31
  `--objectId [objectId]`
32
- : ObjectId of the app for which the enterprise application should be created
32
+ : ObjectId of the app for which the enterprise application should be created.
33
33
  ```
34
34
 
35
35
  <Global />
36
36
 
37
37
  ## Remarks
38
38
 
39
- Specify either the `appId`, `appName` or `objectId`. If you specify more than one option value, the command will fail with an error.
39
+ Specify either the `id`, `displayName` or `objectId`. If you specify more than one option value, the command will fail with an error.
40
40
 
41
41
  If you register an application in the portal, an application object as well as an enterprise application object are automatically created in your home tenant. If you register an application using CLI for Microsoft 365 or the Microsoft Graph, you'll need to create the enterprise application separately. To register/create an application using the CLI for Microsoft 365, use the [m365 entra app add](../app/app-add.mdx) command.
42
42
 
43
43
  ## Examples
44
44
 
45
- Creates an enterprise application for a registered Entra app with appId _b2307a39-e878-458b-bc90-03bc578531d6_.
45
+ Creates an enterprise application for a registered Entra app with the specified id.
46
46
 
47
47
  ```sh
48
- m365 entra enterpriseapp add --appId b2307a39-e878-458b-bc90-03bc578531d6
48
+ m365 entra enterpriseapp add --id b2307a39-e878-458b-bc90-03bc578531d6
49
49
  ```
50
50
 
51
- Creates an enterprise application for a registered Entra app with appName _Microsoft Graph_.
51
+ Creates an enterprise application for a registered Entra app with the specified displayName.
52
52
 
53
53
  ```sh
54
- m365 entra enterpriseapp add --appName "Microsoft Graph"
54
+ m365 entra enterpriseapp add --displayName "Microsoft Graph"
55
55
  ```
56
56
 
57
- Creates an enterprise application for a registered Entra app with objectId _b2307a39-e878-458b-bc90-03bc578531d6_.
57
+ Creates an enterprise application for a registered Entra app with the specified objectId.
58
58
 
59
59
  ```sh
60
60
  m365 entra enterpriseapp add --objectId b2307a39-e878-458b-bc90-03bc578531d6
@@ -172,7 +172,7 @@ m365 entra enterpriseapp add --objectId b2307a39-e878-458b-bc90-03bc578531d6
172
172
  <TabItem value="Markdown">
173
173
 
174
174
  ```md
175
- # entra enterpriseapp add --appId "8da75b6a-4272-4b17-8ee1-20ba66e2b06f"
175
+ # entra enterpriseapp add --id "8da75b6a-4272-4b17-8ee1-20ba66e2b06f"
176
176
 
177
177
  Date: 2023-06-02
178
178
 
@@ -22,40 +22,40 @@ m365 entra sp get [options]
22
22
  ## Options
23
23
 
24
24
  ```md definition-list
25
- `-i, --appId [appId]`
26
- : ID of the application for which the enterprise application should be retrieved
25
+ `-i, --id [id]`
26
+ : ID of the application for which the enterprise application should be retrieved.
27
27
 
28
- `-n, --appDisplayName [appDisplayName]`
29
- : Display name of the application for which the enterprise application should be retrieved
28
+ `-n, --displayName [displayName]`
29
+ : Display name of the application for which the enterprise application should be retrieved.
30
30
 
31
- `--appObjectId [appObjectId]`
32
- : ObjectId of the application for which the enterprise application should be retrieved
31
+ `--objectId [objectId]`
32
+ : ObjectId of the application for which the enterprise application should be retrieved.
33
33
  ```
34
34
 
35
35
  <Global />
36
36
 
37
37
  ## Remarks
38
38
 
39
- Specify either the `appId`, `appObjectId` or `appDisplayName`. If you specify more than one option value, the command will fail with an error.
39
+ Specify either the `id`, `objectId` or `displayName`. If you specify more than one option value, the command will fail with an error.
40
40
 
41
41
  ## Examples
42
42
 
43
- Return details about the enterprise application with appId _b2307a39-e878-458b-bc90-03bc578531d6_.
43
+ Return details about the enterprise application with the specified id.
44
44
 
45
45
  ```sh
46
- m365 entra enterpriseapp get --appId b2307a39-e878-458b-bc90-03bc578531d6
46
+ m365 entra enterpriseapp get --id b2307a39-e878-458b-bc90-03bc578531d6
47
47
  ```
48
48
 
49
- Return details about the _Microsoft Graph_ enterprise application.
49
+ Return details about the enterprise application with the specified displayName.
50
50
 
51
51
  ```sh
52
- m365 entra enterpriseapp get --appDisplayName "Microsoft Graph"
52
+ m365 entra enterpriseapp get --displayName "Microsoft Graph"
53
53
  ```
54
54
 
55
- Return details about the enterprise application with ObjectId _b2307a39-e878-458b-bc90-03bc578531dd_.
55
+ Return details about the enterprise application with the specified ObjectId.
56
56
 
57
57
  ```sh
58
- m365 entra enterpriseapp get --appObjectId b2307a39-e878-458b-bc90-03bc578531dd
58
+ m365 entra enterpriseapp get --objectId b2307a39-e878-458b-bc90-03bc578531dd
59
59
  ```
60
60
 
61
61
  ## Response
@@ -198,7 +198,7 @@ m365 entra enterpriseapp get --appObjectId b2307a39-e878-458b-bc90-03bc578531dd
198
198
  <TabItem value="Markdown">
199
199
 
200
200
  ```md
201
- # entra enterpriseapp get --appId "ac7c9b4b-83b0-4a5e-ace2-a3530162c8f8"
201
+ # entra enterpriseapp get --id "ac7c9b4b-83b0-4a5e-ace2-a3530162c8f8"
202
202
 
203
203
  Date: 2023-06-02
204
204