@pnp/cli-microsoft365 10.0.0-beta.48e9f7d → 10.0.0-beta.58166a8

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 (171) hide show
  1. package/allCommands.json +1 -1
  2. package/allCommandsFull.json +1 -1
  3. package/dist/Auth.js +17 -16
  4. package/dist/AuthServer.js +7 -7
  5. package/dist/Command.js +4 -1
  6. package/dist/api.js +1 -1
  7. package/dist/cli/cli.js +14 -0
  8. package/dist/config.js +61 -5
  9. package/dist/m365/base/PowerAutomateCommand.js +1 -1
  10. package/dist/m365/base/SpoCommand.js +1 -1
  11. package/dist/m365/cli/commands/cli-consent.js +2 -2
  12. package/dist/m365/cli/commands/cli-doctor.js +4 -4
  13. package/dist/m365/cli/commands/config/config-set.js +12 -4
  14. package/dist/m365/cli/commands.js +1 -2
  15. package/dist/m365/commands/login.js +28 -9
  16. package/dist/m365/commands/setup.js +256 -33
  17. package/dist/m365/commands/setupPresets.js +2 -4
  18. package/dist/m365/connection/commands/connection-list.js +4 -4
  19. package/dist/m365/entra/commands/app/app-add.js +52 -288
  20. package/dist/m365/entra/commands/m365group/m365group-set.js +24 -16
  21. package/dist/m365/entra/commands/m365group/m365group-user-add.js +5 -12
  22. package/dist/m365/entra/commands/oauth2grant/oauth2grant-list.js +3 -12
  23. package/dist/m365/external/commands/item/item-add.js +2 -5
  24. package/dist/m365/file/commands/file-move.js +135 -0
  25. package/dist/m365/file/commands.js +2 -1
  26. package/dist/m365/flow/commands/environment/environment-get.js +1 -1
  27. package/dist/m365/flow/commands/environment/environment-list.js +2 -2
  28. package/dist/m365/flow/commands/flow-disable.js +1 -1
  29. package/dist/m365/flow/commands/flow-enable.js +1 -1
  30. package/dist/m365/flow/commands/flow-export.js +17 -16
  31. package/dist/m365/flow/commands/flow-get.js +1 -1
  32. package/dist/m365/flow/commands/flow-list.js +1 -1
  33. package/dist/m365/flow/commands/flow-remove.js +1 -1
  34. package/dist/m365/flow/commands/owner/owner-ensure.js +1 -1
  35. package/dist/m365/flow/commands/owner/owner-list.js +1 -1
  36. package/dist/m365/flow/commands/owner/owner-remove.js +1 -1
  37. package/dist/m365/flow/commands/recyclebinitem/recyclebinitem-list.js +47 -0
  38. package/dist/m365/flow/commands/recyclebinitem/recyclebinitem-restore.js +48 -0
  39. package/dist/m365/flow/commands/run/run-cancel.js +1 -1
  40. package/dist/m365/flow/commands/run/run-get.js +1 -1
  41. package/dist/m365/flow/commands/run/run-list.js +1 -1
  42. package/dist/m365/flow/commands/run/run-resubmit.js +2 -2
  43. package/dist/m365/flow/commands.js +2 -0
  44. package/dist/m365/pa/commands/app/app-list.js +1 -6
  45. package/dist/m365/pa/commands/connector/connector-list.js +1 -6
  46. package/dist/m365/pa/commands/environment/environment-list.js +1 -1
  47. package/dist/m365/pp/commands/environment/environment-list.js +1 -1
  48. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.20.0-rc.1.js +25 -0
  49. package/dist/m365/spfx/commands/project/project-doctor.js +2 -1
  50. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.20.0-rc.1.js +57 -0
  51. package/dist/m365/spfx/commands/project/project-upgrade.js +16 -13
  52. package/dist/m365/spfx/commands/spfx-doctor.js +15 -0
  53. package/dist/m365/spo/commands/app/app-instance-list.js +3 -18
  54. package/dist/m365/spo/commands/app/app-list.js +1 -8
  55. package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +8 -8
  56. package/dist/m365/spo/commands/contenttype/contenttype-field-set.js +2 -2
  57. package/dist/m365/spo/commands/feature/feature-list.js +1 -8
  58. package/dist/m365/spo/commands/file/file-copy.js +5 -1
  59. package/dist/m365/spo/commands/file/file-move.js +55 -33
  60. package/dist/m365/spo/commands/file/file-roleassignment-add.js +17 -54
  61. package/dist/m365/spo/commands/file/file-roleassignment-remove.js +13 -40
  62. package/dist/m365/spo/commands/file/file-roleinheritance-break.js +5 -13
  63. package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +5 -13
  64. package/dist/m365/spo/commands/folder/folder-sharinglink-add.js +143 -0
  65. package/dist/m365/spo/commands/folder/folder-sharinglink-clear.js +111 -0
  66. package/dist/m365/spo/commands/folder/folder-sharinglink-remove.js +95 -0
  67. package/dist/m365/spo/commands/list/list-get.js +17 -4
  68. package/dist/m365/spo/commands/list/list-webhook-list.js +1 -6
  69. package/dist/m365/spo/commands/listitem/listitem-attachment-list.js +1 -8
  70. package/dist/m365/spo/commands/page/page-list.js +1 -1
  71. package/dist/m365/spo/commands/page/page-remove.js +37 -16
  72. package/dist/m365/spo/commands/page/page-section-add.js +185 -34
  73. package/dist/m365/spo/commands/page/page-template-list.js +1 -3
  74. package/dist/m365/spo/commands/site/SiteAdmin.js +2 -0
  75. package/dist/m365/spo/commands/site/site-admin-add.js +252 -0
  76. package/dist/m365/spo/commands/site/site-admin-list.js +10 -36
  77. package/dist/m365/spo/commands/site/site-admin-remove.js +194 -0
  78. package/dist/m365/spo/commands/site/site-sharingpermission-set.js +68 -0
  79. package/dist/m365/spo/commands/sitescript/sitescript-get.js +3 -2
  80. package/dist/m365/spo/commands/sitescript/sitescript-list.js +1 -3
  81. package/dist/m365/spo/commands/{site/site-rename.js → tenant/tenant-site-rename.js} +29 -32
  82. package/dist/m365/spo/commands/theme/theme-list.js +1 -1
  83. package/dist/m365/spo/commands/user/user-get.js +67 -9
  84. package/dist/m365/spo/commands/web/web-clientsidewebpart-list.js +1 -6
  85. package/dist/m365/spo/commands.js +7 -1
  86. package/dist/m365/spp/commands/contentcenter/contentcenter-list.js +56 -0
  87. package/dist/m365/spp/commands.js +5 -0
  88. package/dist/m365/teams/MeetingTranscript.js +2 -0
  89. package/dist/m365/teams/commands/meeting/meeting-transcript-get.js +152 -0
  90. package/dist/m365/teams/commands/tab/tab-list.js +5 -3
  91. package/dist/m365/teams/commands.js +1 -0
  92. package/dist/m365/viva/commands/engage/Community.js +2 -0
  93. package/dist/m365/viva/commands/engage/engage-community-list.js +28 -0
  94. package/dist/m365/viva/commands.js +1 -0
  95. package/dist/request.js +46 -61
  96. package/dist/settingsNames.js +6 -1
  97. package/dist/utils/driveUtil.js +51 -0
  98. package/dist/utils/entraApp.js +283 -0
  99. package/dist/utils/spo.js +76 -8
  100. package/dist/utils/timersUtil.js +12 -0
  101. package/dist/utils/urlUtil.js +8 -0
  102. package/dist/utils/zod.js +1 -1
  103. package/docs/docs/_clisettings.mdx +6 -1
  104. package/docs/docs/cmd/cli/cli-doctor.mdx +24 -23
  105. package/docs/docs/cmd/entra/m365group/m365group-report-activitystorage.mdx +2 -2
  106. package/docs/docs/cmd/entra/m365group/m365group-set.mdx +9 -6
  107. package/docs/docs/cmd/entra/m365group/m365group-user-add.mdx +0 -3
  108. package/docs/docs/cmd/external/item/item-add.mdx +3 -3
  109. package/docs/docs/cmd/file/file-move.mdx +79 -0
  110. package/docs/docs/cmd/flow/recyclebinitem/recyclebinitem-list.mdx +132 -0
  111. package/docs/docs/cmd/flow/recyclebinitem/recyclebinitem-restore.mdx +55 -0
  112. package/docs/docs/cmd/setup.mdx +17 -6
  113. package/docs/docs/cmd/spo/cdn/cdn-get.mdx +1 -1
  114. package/docs/docs/cmd/spo/cdn/cdn-origin-add.mdx +1 -1
  115. package/docs/docs/cmd/spo/cdn/cdn-origin-list.mdx +1 -1
  116. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.mdx +1 -1
  117. package/docs/docs/cmd/spo/cdn/cdn-policy-list.mdx +1 -1
  118. package/docs/docs/cmd/spo/cdn/cdn-policy-set.mdx +1 -1
  119. package/docs/docs/cmd/spo/contenttype/contenttype-field-remove.mdx +7 -7
  120. package/docs/docs/cmd/spo/contenttype/contenttype-field-set.mdx +2 -2
  121. package/docs/docs/cmd/spo/externaluser/externaluser-list.mdx +1 -1
  122. package/docs/docs/cmd/spo/file/file-move.mdx +116 -9
  123. package/docs/docs/cmd/spo/folder/folder-sharinglink-add.mdx +125 -0
  124. package/docs/docs/cmd/spo/folder/folder-sharinglink-clear.mdx +50 -0
  125. package/docs/docs/cmd/spo/folder/folder-sharinglink-remove.mdx +50 -0
  126. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-get.mdx +1 -1
  127. package/docs/docs/cmd/spo/hidedefaultthemes/hidedefaultthemes-set.mdx +1 -1
  128. package/docs/docs/cmd/spo/homesite/homesite-remove.mdx +1 -1
  129. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-get.mdx +1 -1
  130. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-remove.mdx +1 -1
  131. package/docs/docs/cmd/spo/knowledgehub/knowledgehub-set.mdx +1 -1
  132. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.mdx +1 -1
  133. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.mdx +1 -1
  134. package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.mdx +1 -1
  135. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.mdx +1 -1
  136. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-remove.mdx +1 -1
  137. package/docs/docs/cmd/spo/orgnewssite/orgnewssite-set.mdx +1 -1
  138. package/docs/docs/cmd/spo/page/page-remove.mdx +30 -12
  139. package/docs/docs/cmd/spo/page/page-section-add.mdx +57 -2
  140. package/docs/docs/cmd/spo/site/site-admin-add.mdx +67 -0
  141. package/docs/docs/cmd/spo/site/site-admin-list.mdx +64 -12
  142. package/docs/docs/cmd/spo/site/site-admin-remove.mdx +67 -0
  143. package/docs/docs/cmd/spo/site/site-appcatalog-add.mdx +1 -1
  144. package/docs/docs/cmd/spo/site/site-appcatalog-remove.mdx +1 -1
  145. package/docs/docs/cmd/spo/site/site-commsite-enable.mdx +1 -1
  146. package/docs/docs/cmd/spo/site/site-list.mdx +6 -4
  147. package/docs/docs/cmd/spo/site/site-set.mdx +1 -1
  148. package/docs/docs/cmd/spo/site/site-sharingpermission-set.mdx +58 -0
  149. package/docs/docs/cmd/spo/sitescript/sitescript-get.mdx +14 -1
  150. package/docs/docs/cmd/spo/storageentity/storageentity-remove.mdx +1 -1
  151. package/docs/docs/cmd/spo/storageentity/storageentity-set.mdx +1 -1
  152. package/docs/docs/cmd/spo/tenant/tenant-appcatalog-add.mdx +1 -1
  153. package/docs/docs/cmd/spo/tenant/tenant-appcatalogurl-get.mdx +1 -1
  154. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-list.mdx +1 -1
  155. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-remove.mdx +1 -1
  156. package/docs/docs/cmd/spo/tenant/tenant-settings-list.mdx +1 -1
  157. package/docs/docs/cmd/spo/{site/site-rename.mdx → tenant/tenant-site-rename.mdx} +7 -7
  158. package/docs/docs/cmd/spo/theme/theme-apply.mdx +1 -1
  159. package/docs/docs/cmd/spo/theme/theme-get.mdx +1 -1
  160. package/docs/docs/cmd/spo/theme/theme-list.mdx +1 -1
  161. package/docs/docs/cmd/spo/theme/theme-remove.mdx +1 -1
  162. package/docs/docs/cmd/spo/theme/theme-set.mdx +1 -1
  163. package/docs/docs/cmd/spo/user/user-get.mdx +35 -9
  164. package/docs/docs/cmd/spp/contentcenter/contentcenter-list.mdx +287 -0
  165. package/docs/docs/cmd/teams/meeting/meeting-transcript-get.mdx +132 -0
  166. package/docs/docs/cmd/teams/tab/tab-list.mdx +1 -2
  167. package/docs/docs/cmd/viva/engage/engage-community-list.mdx +81 -0
  168. package/npm-shrinkwrap.json +203 -375
  169. package/package.json +16 -17
  170. package/dist/m365/cli/commands/cli-reconsent.js +0 -30
  171. package/docs/docs/cmd/cli/cli-reconsent.mdx +0 -62
package/dist/request.js CHANGED
@@ -4,6 +4,7 @@ import auth, { Auth } from './Auth.js';
4
4
  import { app } from './utils/app.js';
5
5
  import { formatting } from './utils/formatting.js';
6
6
  import { timings } from './cli/timings.js';
7
+ import { timersUtil } from './utils/timersUtil.js';
7
8
  class Request {
8
9
  set debug(debug) {
9
10
  // if the value to set is the same as current value return early to avoid
@@ -125,76 +126,60 @@ class Request {
125
126
  options.method = 'HEAD';
126
127
  return this.execute(options);
127
128
  }
128
- execute(options, resolve, reject) {
129
+ async execute(options) {
129
130
  const start = process.hrtime.bigint();
130
131
  if (!this._logger) {
131
- return Promise.reject('Logger not set on the request object');
132
+ throw 'Logger not set on the request object';
132
133
  }
133
134
  this.updateRequestForCloudType(options, auth.connection.cloudType);
134
- return new Promise((_resolve, _reject) => {
135
- (() => {
136
- if (options.headers && options.headers['x-anonymous']) {
137
- return Promise.resolve('');
138
- }
139
- else {
140
- const url = options.headers && options.headers['x-resource'] ? options.headers['x-resource'] : options.url;
141
- const resource = Auth.getResourceFromUrl(url);
142
- return auth.ensureAccessToken(resource, this._logger, this._debug);
143
- }
144
- })()
145
- .then((accessToken) => {
146
- if (options.headers) {
147
- if (options.headers['x-anonymous']) {
148
- delete options.headers['x-anonymous'];
149
- }
150
- if (options.headers['x-resource']) {
151
- delete options.headers['x-resource'];
152
- }
153
- if (accessToken !== '') {
154
- options.headers.authorization = `Bearer ${accessToken}`;
155
- }
156
- }
157
- const proxyUrl = process.env.HTTP_PROXY || process.env.HTTPS_PROXY;
158
- if (proxyUrl) {
159
- options.proxy = this.createProxyConfigFromUrl(proxyUrl);
135
+ try {
136
+ let accessToken = '';
137
+ if (options.headers && options.headers['x-anonymous']) {
138
+ accessToken = '';
139
+ }
140
+ else {
141
+ const url = options.headers && options.headers['x-resource'] ? options.headers['x-resource'] : options.url;
142
+ const resource = Auth.getResourceFromUrl(url);
143
+ accessToken = await auth.ensureAccessToken(resource, this._logger, this._debug);
144
+ }
145
+ if (options.headers) {
146
+ if (options.headers['x-anonymous']) {
147
+ delete options.headers['x-anonymous'];
160
148
  }
161
- return this.req(options);
162
- })
163
- .then((res) => {
164
- if (resolve) {
165
- resolve((options.responseType === 'stream' || options.fullResponse) ? res : res.data);
149
+ if (options.headers['x-resource']) {
150
+ delete options.headers['x-resource'];
166
151
  }
167
- else {
168
- const end = process.hrtime.bigint();
169
- timings.api.push(Number(end - start));
170
- _resolve((options.responseType === 'stream' || options.fullResponse) ? res : res.data);
152
+ if (accessToken !== '') {
153
+ options.headers.authorization = `Bearer ${accessToken}`;
171
154
  }
172
- }, async (error) => {
173
- if (error && error.response &&
174
- (error.response.status === 429 ||
175
- error.response.status === 503)) {
176
- let retryAfter = parseInt(error.response.headers['retry-after'] || '10');
177
- if (isNaN(retryAfter)) {
178
- retryAfter = 10;
179
- }
180
- if (this._debug) {
181
- await this._logger.log(`Request throttled. Waiting ${retryAfter}sec before retrying...`);
182
- }
183
- // eslint-disable-next-line @typescript-eslint/no-floating-promises
184
- setTimeout(async () => { this.execute(options, resolve || _resolve, reject || _reject); }, retryAfter * 1000);
155
+ }
156
+ const proxyUrl = process.env.HTTP_PROXY || process.env.HTTPS_PROXY;
157
+ if (proxyUrl) {
158
+ options.proxy = this.createProxyConfigFromUrl(proxyUrl);
159
+ }
160
+ const res = await this.req(options);
161
+ const end = process.hrtime.bigint();
162
+ timings.api.push(Number(end - start));
163
+ return options.responseType === 'stream' || options.fullResponse ?
164
+ res :
165
+ res.data;
166
+ }
167
+ catch (error) {
168
+ const end = process.hrtime.bigint();
169
+ timings.api.push(Number(end - start));
170
+ if (error && error.response && (error.response.status === 429 || error.response.status === 503)) {
171
+ let retryAfter = parseInt(error.response.headers['retry-after'] || '10');
172
+ if (isNaN(retryAfter)) {
173
+ retryAfter = 10;
185
174
  }
186
- else {
187
- if (reject) {
188
- reject(error);
189
- }
190
- else {
191
- const end = process.hrtime.bigint();
192
- timings.api.push(Number(end - start));
193
- _reject(error);
194
- }
175
+ if (this._debug) {
176
+ await this._logger.log(`Request throttled. Waiting ${retryAfter} sec before retrying...`);
195
177
  }
196
- });
197
- });
178
+ await timersUtil.setTimeout(retryAfter * 1000);
179
+ return this.execute(options);
180
+ }
181
+ throw error;
182
+ }
198
183
  }
199
184
  updateRequestForCloudType(options, cloudType) {
200
185
  const url = new URL(options.url);
@@ -1,6 +1,11 @@
1
1
  const settingsNames = {
2
2
  authType: 'authType',
3
3
  autoOpenLinksInBrowser: 'autoOpenLinksInBrowser',
4
+ clientId: 'clientId',
5
+ clientSecret: 'clientSecret',
6
+ clientCertificateFile: 'clientCertificateFile',
7
+ clientCertificateBase64Encoded: 'clientCertificateBase64Encoded',
8
+ clientCertificatePassword: 'clientCertificatePassword',
4
9
  copyDeviceCodeToClipboard: 'copyDeviceCodeToClipboard',
5
10
  csvEscape: 'csvEscape',
6
11
  csvHeader: 'csvHeader',
@@ -16,7 +21,7 @@ const settingsNames = {
16
21
  prompt: 'prompt',
17
22
  promptListPageSize: 'promptListPageSize',
18
23
  showHelpOnFailure: 'showHelpOnFailure',
19
- showSpinner: 'showSpinner'
24
+ tenantId: 'tenantId'
20
25
  };
21
26
  export { settingsNames };
22
27
  //# sourceMappingURL=settingsNames.js.map
@@ -0,0 +1,51 @@
1
+ import request from "../request.js";
2
+ export const driveUtil = {
3
+ /**
4
+ * Retrieves the Drive associated with the specified site and URL.
5
+ * @param siteId Site ID
6
+ * @param url Drive URL
7
+ * @returns The Drive associated with the drive URL.
8
+ */
9
+ async getDriveByUrl(siteId, url) {
10
+ const requestOptions = {
11
+ url: `https://graph.microsoft.com/v1.0/sites/${siteId}/drives?$select=webUrl,id`,
12
+ headers: {
13
+ accept: 'application/json;odata.metadata=none'
14
+ },
15
+ responseType: 'json'
16
+ };
17
+ const drives = await request.get(requestOptions);
18
+ const lowerCaseFolderUrl = url.href.toLowerCase();
19
+ const drive = drives.value
20
+ .sort((a, b) => b.webUrl.localeCompare(a.webUrl))
21
+ .find((d) => {
22
+ const driveUrl = d.webUrl.toLowerCase();
23
+ return lowerCaseFolderUrl.startsWith(driveUrl) &&
24
+ (driveUrl.length === lowerCaseFolderUrl.length ||
25
+ lowerCaseFolderUrl[driveUrl.length] === '/');
26
+ });
27
+ if (!drive) {
28
+ throw `Drive '${url.href}' not found`;
29
+ }
30
+ return drive;
31
+ },
32
+ /**
33
+ * Retrieves the ID of a drive item (file, folder, etc.) associated with the given drive and item URL.
34
+ * @param drive The Drive object containing the item
35
+ * @param itemUrl Item URL
36
+ * @returns Drive item ID
37
+ */
38
+ async getDriveItemId(drive, itemUrl) {
39
+ const relativeItemUrl = itemUrl.href.replace(new RegExp(`${drive.webUrl}`, 'i'), '').replace(/\/+$/, '');
40
+ const requestOptions = {
41
+ url: `https://graph.microsoft.com/v1.0/drives/${drive.id}/root${relativeItemUrl ? `:${relativeItemUrl}` : ''}?$select=id`,
42
+ headers: {
43
+ accept: 'application/json;odata.metadata=none'
44
+ },
45
+ responseType: 'json'
46
+ };
47
+ const driveItem = await request.get(requestOptions);
48
+ return driveItem?.id;
49
+ }
50
+ };
51
+ //# sourceMappingURL=driveUtil.js.map
@@ -0,0 +1,283 @@
1
+ import fs from 'fs';
2
+ import request from '../request.js';
3
+ import { odata } from './odata.js';
4
+ async function getCertificateBase64Encoded({ options, logger, debug }) {
5
+ if (options.certificateBase64Encoded) {
6
+ return options.certificateBase64Encoded;
7
+ }
8
+ if (debug) {
9
+ await logger.logToStderr(`Reading existing ${options.certificateFile}...`);
10
+ }
11
+ try {
12
+ return fs.readFileSync(options.certificateFile, { encoding: 'base64' });
13
+ }
14
+ catch (e) {
15
+ throw new Error(`Error reading certificate file: ${e}. Please add the certificate using base64 option '--certificateBase64Encoded'.`);
16
+ }
17
+ }
18
+ async function createServicePrincipal(appId) {
19
+ const requestOptions = {
20
+ url: `https://graph.microsoft.com/v1.0/myorganization/servicePrincipals`,
21
+ headers: {
22
+ 'content-type': 'application/json'
23
+ },
24
+ data: {
25
+ appId: appId
26
+ },
27
+ responseType: 'json'
28
+ };
29
+ return request.post(requestOptions);
30
+ }
31
+ async function grantOAuth2Permission({ appId, resourceId, scopeName }) {
32
+ const grantAdminConsentApplicationRequestOptions = {
33
+ url: `https://graph.microsoft.com/v1.0/myorganization/oauth2PermissionGrants`,
34
+ headers: {
35
+ accept: 'application/json;odata.metadata=none'
36
+ },
37
+ responseType: 'json',
38
+ data: {
39
+ clientId: appId,
40
+ consentType: "AllPrincipals",
41
+ principalId: null,
42
+ resourceId: resourceId,
43
+ scope: scopeName
44
+ }
45
+ };
46
+ return request.post(grantAdminConsentApplicationRequestOptions);
47
+ }
48
+ async function addRoleToServicePrincipal({ objectId, resourceId, appRoleId }) {
49
+ const requestOptions = {
50
+ url: `https://graph.microsoft.com/v1.0/myorganization/servicePrincipals/${objectId}/appRoleAssignments`,
51
+ headers: {
52
+ 'Content-Type': 'application/json'
53
+ },
54
+ responseType: 'json',
55
+ data: {
56
+ appRoleId: appRoleId,
57
+ principalId: objectId,
58
+ resourceId: resourceId
59
+ }
60
+ };
61
+ return request.post(requestOptions);
62
+ }
63
+ async function getRequiredResourceAccessForApis({ servicePrincipals, apis, scopeType, logger, debug }) {
64
+ if (!apis) {
65
+ return [];
66
+ }
67
+ const resolvedApis = [];
68
+ const requestedApis = apis.split(',').map(a => a.trim());
69
+ for (const api of requestedApis) {
70
+ const pos = api.lastIndexOf('/');
71
+ const permissionName = api.substring(pos + 1);
72
+ const servicePrincipalName = api.substring(0, pos);
73
+ if (debug) {
74
+ await logger.logToStderr(`Resolving ${api}...`);
75
+ await logger.logToStderr(`Permission name: ${permissionName}`);
76
+ await logger.logToStderr(`Service principal name: ${servicePrincipalName}`);
77
+ }
78
+ const servicePrincipal = servicePrincipals.find(sp => (sp.servicePrincipalNames.indexOf(servicePrincipalName) > -1 ||
79
+ sp.servicePrincipalNames.indexOf(`${servicePrincipalName}/`) > -1));
80
+ if (!servicePrincipal) {
81
+ throw `Service principal ${servicePrincipalName} not found`;
82
+ }
83
+ const scopesOfType = scopeType === 'Scope' ? servicePrincipal.oauth2PermissionScopes : servicePrincipal.appRoles;
84
+ const permission = scopesOfType.find(scope => scope.value === permissionName);
85
+ if (!permission) {
86
+ throw `Permission ${permissionName} for service principal ${servicePrincipalName} not found`;
87
+ }
88
+ let resolvedApi = resolvedApis.find(a => a.resourceAppId === servicePrincipal.appId);
89
+ if (!resolvedApi) {
90
+ resolvedApi = {
91
+ resourceAppId: servicePrincipal.appId,
92
+ resourceAccess: []
93
+ };
94
+ resolvedApis.push(resolvedApi);
95
+ }
96
+ const resourceAccessPermission = {
97
+ id: permission.id,
98
+ type: scopeType
99
+ };
100
+ resolvedApi.resourceAccess.push(resourceAccessPermission);
101
+ updateAppPermissions({
102
+ spId: servicePrincipal.id,
103
+ resourceAccessPermission,
104
+ oAuth2PermissionValue: permission.value
105
+ });
106
+ }
107
+ return resolvedApis;
108
+ }
109
+ function updateAppPermissions({ spId, resourceAccessPermission, oAuth2PermissionValue }) {
110
+ // During API resolution, we store globally both app role assignments and oauth2permissions
111
+ // So that we'll be able to parse them during the admin consent process
112
+ let existingPermission = entraApp.appPermissions.find(oauth => oauth.resourceId === spId);
113
+ if (!existingPermission) {
114
+ existingPermission = {
115
+ resourceId: spId,
116
+ resourceAccess: [],
117
+ scope: []
118
+ };
119
+ entraApp.appPermissions.push(existingPermission);
120
+ }
121
+ if (resourceAccessPermission.type === 'Scope' && oAuth2PermissionValue && !existingPermission.scope.find(scp => scp === oAuth2PermissionValue)) {
122
+ existingPermission.scope.push(oAuth2PermissionValue);
123
+ }
124
+ if (!existingPermission.resourceAccess.find(res => res.id === resourceAccessPermission.id)) {
125
+ existingPermission.resourceAccess.push(resourceAccessPermission);
126
+ }
127
+ }
128
+ export const entraApp = {
129
+ appPermissions: [],
130
+ createAppRegistration: async ({ options, apis, logger, verbose, debug }) => {
131
+ const applicationInfo = {
132
+ displayName: options.name,
133
+ signInAudience: options.multitenant ? 'AzureADMultipleOrgs' : 'AzureADMyOrg'
134
+ };
135
+ if (apis.length > 0) {
136
+ applicationInfo.requiredResourceAccess = apis;
137
+ }
138
+ if (options.redirectUris) {
139
+ applicationInfo[options.platform] = {
140
+ redirectUris: options.redirectUris.split(',').map(u => u.trim())
141
+ };
142
+ }
143
+ if (options.implicitFlow) {
144
+ if (!applicationInfo.web) {
145
+ applicationInfo.web = {};
146
+ }
147
+ applicationInfo.web.implicitGrantSettings = {
148
+ enableAccessTokenIssuance: true,
149
+ enableIdTokenIssuance: true
150
+ };
151
+ }
152
+ if (options.certificateFile || options.certificateBase64Encoded) {
153
+ const certificateBase64Encoded = await getCertificateBase64Encoded({ options, logger, debug });
154
+ const newKeyCredential = {
155
+ type: 'AsymmetricX509Cert',
156
+ usage: 'Verify',
157
+ displayName: options.certificateDisplayName,
158
+ key: certificateBase64Encoded
159
+ };
160
+ applicationInfo.keyCredentials = [newKeyCredential];
161
+ }
162
+ if (options.allowPublicClientFlows) {
163
+ applicationInfo.isFallbackPublicClient = true;
164
+ }
165
+ if (verbose) {
166
+ await logger.logToStderr(`Creating Microsoft Entra app registration...`);
167
+ }
168
+ const createApplicationRequestOptions = {
169
+ url: `https://graph.microsoft.com/v1.0/myorganization/applications`,
170
+ headers: {
171
+ accept: 'application/json;odata.metadata=none'
172
+ },
173
+ responseType: 'json',
174
+ data: applicationInfo
175
+ };
176
+ return request.post(createApplicationRequestOptions);
177
+ },
178
+ grantAdminConsent: async ({ appInfo, appPermissions, adminConsent, logger, debug }) => {
179
+ if (!adminConsent || appPermissions.length === 0) {
180
+ return appInfo;
181
+ }
182
+ const sp = await createServicePrincipal(appInfo.appId);
183
+ if (debug) {
184
+ await logger.logToStderr("Service principal created, returned object id: " + sp.id);
185
+ }
186
+ const tasks = [];
187
+ appPermissions.forEach(async (permission) => {
188
+ if (permission.scope.length > 0) {
189
+ tasks.push(grantOAuth2Permission({
190
+ appId: sp.id,
191
+ resourceId: permission.resourceId,
192
+ scopeName: permission.scope.join(' ')
193
+ }));
194
+ if (debug) {
195
+ await logger.logToStderr(`Admin consent granted for following resource ${permission.resourceId}, with delegated permissions: ${permission.scope.join(',')}`);
196
+ }
197
+ }
198
+ permission.resourceAccess.filter(access => access.type === "Role").forEach(async (access) => {
199
+ tasks.push(addRoleToServicePrincipal({
200
+ objectId: sp.id,
201
+ resourceId: permission.resourceId,
202
+ appRoleId: access.id
203
+ }));
204
+ if (debug) {
205
+ await logger.logToStderr(`Admin consent granted for following resource ${permission.resourceId}, with application permission: ${access.id}`);
206
+ }
207
+ });
208
+ });
209
+ await Promise.all(tasks);
210
+ return appInfo;
211
+ },
212
+ resolveApis: async ({ options, manifest, logger, verbose, debug }) => {
213
+ if (!options.apisDelegated && !options.apisApplication
214
+ && (typeof manifest?.requiredResourceAccess === 'undefined' || manifest.requiredResourceAccess.length === 0)) {
215
+ return [];
216
+ }
217
+ if (verbose) {
218
+ await logger.logToStderr('Resolving requested APIs...');
219
+ }
220
+ const servicePrincipals = await odata.getAllItems(`https://graph.microsoft.com/v1.0/myorganization/servicePrincipals?$select=appId,appRoles,id,oauth2PermissionScopes,servicePrincipalNames`);
221
+ let resolvedApis = [];
222
+ if (options.apisDelegated || options.apisApplication) {
223
+ resolvedApis = await getRequiredResourceAccessForApis({
224
+ servicePrincipals,
225
+ apis: options.apisDelegated,
226
+ scopeType: 'Scope',
227
+ logger,
228
+ debug
229
+ });
230
+ if (verbose) {
231
+ await logger.logToStderr(`Resolved delegated permissions: ${JSON.stringify(resolvedApis, null, 2)}`);
232
+ }
233
+ const resolvedApplicationApis = await getRequiredResourceAccessForApis({
234
+ servicePrincipals,
235
+ apis: options.apisApplication,
236
+ scopeType: 'Role',
237
+ logger,
238
+ debug
239
+ });
240
+ if (verbose) {
241
+ await logger.logToStderr(`Resolved application permissions: ${JSON.stringify(resolvedApplicationApis, null, 2)}`);
242
+ }
243
+ // merge resolved application APIs onto resolved delegated APIs
244
+ resolvedApplicationApis.forEach(resolvedRequiredResource => {
245
+ const requiredResource = resolvedApis.find(api => api.resourceAppId === resolvedRequiredResource.resourceAppId);
246
+ if (requiredResource) {
247
+ requiredResource.resourceAccess.push(...resolvedRequiredResource.resourceAccess);
248
+ }
249
+ else {
250
+ resolvedApis.push(resolvedRequiredResource);
251
+ }
252
+ });
253
+ }
254
+ else {
255
+ const manifestApis = manifest.requiredResourceAccess;
256
+ manifestApis.forEach(manifestApi => {
257
+ resolvedApis.push(manifestApi);
258
+ const app = servicePrincipals.find(servicePrincipals => servicePrincipals.appId === manifestApi.resourceAppId);
259
+ if (app) {
260
+ manifestApi.resourceAccess.forEach((res => {
261
+ const resourceAccessPermission = {
262
+ id: res.id,
263
+ type: res.type
264
+ };
265
+ const oAuthValue = app.oauth2PermissionScopes.find(scp => scp.id === res.id)?.value;
266
+ updateAppPermissions({
267
+ spId: app.id,
268
+ resourceAccessPermission,
269
+ oAuth2PermissionValue: oAuthValue
270
+ });
271
+ }));
272
+ }
273
+ });
274
+ }
275
+ if (verbose) {
276
+ await logger.logToStderr(`Merged delegated and application permissions: ${JSON.stringify(resolvedApis, null, 2)}`);
277
+ await logger.logToStderr(`App role assignments: ${JSON.stringify(entraApp.appPermissions.flatMap(permission => permission.resourceAccess.filter(access => access.type === "Role")), null, 2)}`);
278
+ await logger.logToStderr(`OAuth2 permissions: ${JSON.stringify(entraApp.appPermissions.flatMap(permission => permission.scope), null, 2)}`);
279
+ }
280
+ return resolvedApis;
281
+ }
282
+ };
283
+ //# sourceMappingURL=entraApp.js.map
package/dist/utils/spo.js CHANGED
@@ -500,10 +500,10 @@ export const spo = {
500
500
  * @param webUrl Web url
501
501
  * @param email The email of the user
502
502
  * @param logger the Logger object
503
- * @param verbose set if verbose logging should be logged
503
+ * @param verbose set for verbose logging
504
504
  */
505
505
  async getUserByEmail(webUrl, email, logger, verbose) {
506
- if (verbose) {
506
+ if (verbose && logger) {
507
507
  await logger.logToStderr(`Retrieving the spo user by email ${email}`);
508
508
  }
509
509
  const requestUrl = `${webUrl}/_api/web/siteusers/GetByEmail('${formatting.encodeQueryParameter(email)}')`;
@@ -574,10 +574,10 @@ export const spo = {
574
574
  * @param webUrl Web url
575
575
  * @param name The name of the group
576
576
  * @param logger the Logger object
577
- * @param verbose set if verbose logging should be logged
577
+ * @param verbose set for verbose logging
578
578
  */
579
579
  async getGroupByName(webUrl, name, logger, verbose) {
580
- if (verbose) {
580
+ if (verbose && logger) {
581
581
  await logger.logToStderr(`Retrieving the group by name ${name}`);
582
582
  }
583
583
  const requestUrl = `${webUrl}/_api/web/sitegroups/GetByName('${formatting.encodeQueryParameter(name)}')`;
@@ -596,10 +596,10 @@ export const spo = {
596
596
  * @param webUrl Web url
597
597
  * @param name the name of the role definition
598
598
  * @param logger the Logger object
599
- * @param debug set if debug logging should be logged
599
+ * @param verbose set for verbose logging
600
600
  */
601
- async getRoleDefinitionByName(webUrl, name, logger, debug) {
602
- if (debug) {
601
+ async getRoleDefinitionByName(webUrl, name, logger, verbose) {
602
+ if (verbose && logger) {
603
603
  await logger.logToStderr(`Retrieving the role definitions for ${name}`);
604
604
  }
605
605
  const roledefinitions = await odata.getAllItems(`${webUrl}/_api/web/roledefinitions`);
@@ -1527,6 +1527,29 @@ export const spo = {
1527
1527
  const itemsResponse = await request.get(requestOptionsItems);
1528
1528
  return (itemsResponse);
1529
1529
  },
1530
+ /**
1531
+ * Retrieves the file by id.
1532
+ * Returns a FileProperties object
1533
+ * @param webUrl Web url
1534
+ * @param id the id of the file
1535
+ * @param logger the Logger object
1536
+ * @param verbose set for verbose logging
1537
+ */
1538
+ async getFileById(webUrl, id, logger, verbose) {
1539
+ if (verbose && logger) {
1540
+ await logger.logToStderr(`Retrieving the file with id ${id}`);
1541
+ }
1542
+ const requestUrl = `${webUrl}/_api/web/GetFileById('${formatting.encodeQueryParameter(id)}')`;
1543
+ const requestOptions = {
1544
+ url: requestUrl,
1545
+ headers: {
1546
+ 'accept': 'application/json;odata=nometadata'
1547
+ },
1548
+ responseType: 'json'
1549
+ };
1550
+ const file = await request.get(requestOptions);
1551
+ return file;
1552
+ },
1530
1553
  /**
1531
1554
  * Create a SharePoint copy job to copy a file/folder to another location.
1532
1555
  * @param webUrl Absolute web URL where the source file/folder is located.
@@ -1550,8 +1573,10 @@ export const spo = {
1550
1573
  AllowSchemaMismatch: true,
1551
1574
  BypassSharedLock: !!options?.bypassSharedLock,
1552
1575
  IgnoreVersionHistory: !!options?.ignoreVersionHistory,
1576
+ IncludeItemPermissions: !!options?.includeItemPermissions,
1553
1577
  CustomizedItemName: options?.newName ? [options.newName] : undefined,
1554
- SameWebCopyMoveOptimization: true
1578
+ SameWebCopyMoveOptimization: true,
1579
+ IsMoveMode: options?.operation === 'move'
1555
1580
  }
1556
1581
  }
1557
1582
  };
@@ -1590,6 +1615,49 @@ export const spo = {
1590
1615
  // Get the destination object information
1591
1616
  const objectInfo = logs.find(l => l.Event === 'JobFinishedObjectInfo');
1592
1617
  return objectInfo;
1618
+ },
1619
+ /**
1620
+ * Gets the primary owner login from a site as admin.
1621
+ * @param adminUrl The SharePoint admin URL
1622
+ * @param siteId The site ID
1623
+ * @param logger The logger object
1624
+ * @param verbose If in verbose mode
1625
+ * @returns Owner login name
1626
+ */
1627
+ async getPrimaryAdminLoginNameAsAdmin(adminUrl, siteId, logger, verbose) {
1628
+ if (verbose) {
1629
+ await logger.logToStderr('Getting the primary admin login name...');
1630
+ }
1631
+ const requestOptions = {
1632
+ url: `${adminUrl}/_api/SPO.Tenant/sites('${siteId}')?$select=OwnerLoginName`,
1633
+ headers: {
1634
+ accept: 'application/json;odata=nometadata'
1635
+ },
1636
+ responseType: 'json'
1637
+ };
1638
+ const response = await request.get(requestOptions);
1639
+ return response.OwnerLoginName;
1640
+ },
1641
+ /**
1642
+ * Gets the primary owner login from a site.
1643
+ * @param siteUrl The site URL
1644
+ * @param logger The logger object
1645
+ * @param verbose If in verbose mode
1646
+ * @returns Owner login name
1647
+ */
1648
+ async getPrimaryOwnerLoginFromSite(siteUrl, logger, verbose) {
1649
+ if (verbose) {
1650
+ await logger.logToStderr('Getting the primary admin login name...');
1651
+ }
1652
+ const requestOptions = {
1653
+ url: `${siteUrl}/_api/site/owner`,
1654
+ headers: {
1655
+ 'accept': 'application/json;odata=nometadata'
1656
+ },
1657
+ responseType: 'json'
1658
+ };
1659
+ const responseContent = await request.get(requestOptions);
1660
+ return responseContent?.LoginName;
1593
1661
  }
1594
1662
  };
1595
1663
  //# sourceMappingURL=spo.js.map
@@ -0,0 +1,12 @@
1
+ import { setTimeout } from "timers/promises";
2
+ export const timersUtil = {
3
+ /**
4
+ * Timeout for a specific duration.
5
+ * @param duration Duration in milliseconds.
6
+ */
7
+ /* c8 ignore next 3 */
8
+ async setTimeout(duration) {
9
+ return setTimeout(duration);
10
+ }
11
+ };
12
+ //# sourceMappingURL=timersUtil.js.map
@@ -198,6 +198,14 @@ export const urlUtil = {
198
198
  return rootUrl.origin;
199
199
  }
200
200
  },
201
+ /**
202
+ * Removes leading slashes from the URL.
203
+ * @param url The URL to process.
204
+ * @returns The URL without leading slashes.
205
+ */
206
+ removeLeadingSlashes(url) {
207
+ return url.replace(/^\/+/, '');
208
+ },
201
209
  /**
202
210
  * Removes trailing slashes from the URL.
203
211
  * @param url The URL to process.
package/dist/utils/zod.js CHANGED
@@ -60,7 +60,7 @@ function parseDefault(def, _options, currentOption) {
60
60
  function parseEnum(def, _options, currentOption) {
61
61
  if (currentOption) {
62
62
  currentOption.type = 'string';
63
- currentOption.autocomplete = def.values;
63
+ currentOption.autocomplete = [...def.values];
64
64
  }
65
65
  return;
66
66
  }