@pnp/cli-microsoft365 12.0.0-beta.0be7d8d → 12.0.0-beta.1752794

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 (190) hide show
  1. package/.devproxy/generate-openapi-spec.json +1 -1
  2. package/allCommands.json +1 -1
  3. package/allCommandsFull.json +1 -1
  4. package/dist/Auth.js +2 -6
  5. package/dist/auth/FileTokenStorage.js +0 -3
  6. package/dist/auth/msalCachePlugin.js +201 -12
  7. package/dist/googleAnalytics.js +96 -0
  8. package/dist/m365/commands/logout.js +2 -4
  9. package/dist/m365/entra/commands/m365group/m365group-remove.js +4 -3
  10. package/dist/m365/spe/commands/container/container-remove.js +6 -7
  11. package/dist/m365/spo/commands/app/app-add.js +35 -56
  12. package/dist/m365/spo/commands/app/app-deploy.js +41 -59
  13. package/dist/m365/spo/commands/app/app-get.js +40 -56
  14. package/dist/m365/spo/commands/app/app-install.js +20 -41
  15. package/dist/m365/spo/commands/app/app-instance-list.js +12 -24
  16. package/dist/m365/spo/commands/app/app-list.js +26 -44
  17. package/dist/m365/spo/commands/app/app-remove.js +32 -52
  18. package/dist/m365/spo/commands/app/app-retract.js +32 -51
  19. package/dist/m365/spo/commands/app/app-teamspackage-download.js +35 -54
  20. package/dist/m365/spo/commands/app/app-uninstall.js +21 -44
  21. package/dist/m365/spo/commands/app/app-upgrade.js +20 -41
  22. package/dist/m365/spo/commands/feature/feature-disable.js +20 -50
  23. package/dist/m365/spo/commands/feature/feature-enable.js +22 -50
  24. package/dist/m365/spo/commands/feature/feature-list.js +11 -36
  25. package/dist/m365/spo/commands/field/field-add.js +33 -62
  26. package/dist/m365/spo/commands/field/field-get.js +30 -57
  27. package/dist/m365/spo/commands/field/field-list.js +21 -46
  28. package/dist/m365/spo/commands/field/field-remove.js +32 -63
  29. package/dist/m365/spo/commands/field/field-set.js +34 -66
  30. package/dist/m365/spo/commands/file/file-archive.js +1 -1
  31. package/dist/m365/spo/commands/file/file-get.js +4 -3
  32. package/dist/m365/spo/commands/file/file-remove.js +5 -5
  33. package/dist/m365/spo/commands/file/file-unarchive.js +1 -1
  34. package/dist/m365/spo/commands/folder/folder-archive.js +1 -1
  35. package/dist/m365/spo/commands/folder/folder-remove.js +5 -5
  36. package/dist/m365/spo/commands/folder/folder-unarchive.js +90 -0
  37. package/dist/m365/spo/commands/hidedefaultthemes/hidedefaultthemes-get.js +5 -0
  38. package/dist/m365/spo/commands/hidedefaultthemes/hidedefaultthemes-set.js +8 -26
  39. package/dist/m365/spo/commands/homesite/homesite-list.js +5 -0
  40. package/dist/m365/spo/commands/hubsite/hubsite-connect.js +38 -63
  41. package/dist/m365/spo/commands/hubsite/hubsite-data-get.js +11 -27
  42. package/dist/m365/spo/commands/hubsite/hubsite-disconnect.js +25 -47
  43. package/dist/m365/spo/commands/hubsite/hubsite-get.js +25 -37
  44. package/dist/m365/spo/commands/hubsite/hubsite-list.js +12 -24
  45. package/dist/m365/spo/commands/hubsite/hubsite-register.js +10 -18
  46. package/dist/m365/spo/commands/hubsite/hubsite-rights-grant.js +14 -32
  47. package/dist/m365/spo/commands/hubsite/hubsite-rights-revoke.js +12 -29
  48. package/dist/m365/spo/commands/hubsite/hubsite-set.js +19 -46
  49. package/dist/m365/spo/commands/hubsite/hubsite-unregister.js +11 -27
  50. package/dist/m365/spo/commands/list/list-remove.js +4 -4
  51. package/dist/m365/spo/commands/listitem/listitem-batch-remove.js +5 -4
  52. package/dist/m365/spo/commands/listitem/listitem-get.js +1 -12
  53. package/dist/m365/spo/commands/listitem/listitem-remove.js +8 -5
  54. package/dist/m365/spo/commands/navigation/navigation-node-list.js +6 -4
  55. package/dist/m365/spo/commands/page/page-remove.js +7 -7
  56. package/dist/m365/spo/commands/site/site-list.js +60 -49
  57. package/dist/m365/spo/commands/site/site-remove.js +7 -7
  58. package/dist/m365/spo/commands/spo-get.js +5 -0
  59. package/dist/m365/spo/commands/spo-set.js +10 -21
  60. package/dist/m365/spo/commands/storageentity/storageentity-get.js +23 -17
  61. package/dist/m365/spo/commands/storageentity/storageentity-list.js +39 -36
  62. package/dist/m365/spo/commands/storageentity/storageentity-remove.js +26 -33
  63. package/dist/m365/spo/commands/storageentity/storageentity-set.js +26 -36
  64. package/dist/m365/spo/commands/tenant/tenant-appcatalog-add.js +1 -1
  65. package/dist/m365/spo/commands/user/user-ensure.js +24 -60
  66. package/dist/m365/spo/commands/user/user-get.js +25 -65
  67. package/dist/m365/spo/commands/user/user-list.js +10 -18
  68. package/dist/m365/spo/commands/user/user-remove.js +26 -68
  69. package/dist/m365/spo/commands/userprofile/userprofile-get.js +10 -23
  70. package/dist/m365/spo/commands/userprofile/userprofile-set.js +10 -19
  71. package/dist/m365/spo/commands/web/web-add.js +20 -55
  72. package/dist/m365/spo/commands/web/web-clientsidewebpart-list.js +10 -18
  73. package/dist/m365/spo/commands/web/web-get.js +12 -30
  74. package/dist/m365/spo/commands/web/web-installedlanguage-list.js +10 -18
  75. package/dist/m365/spo/commands/web/web-list.js +10 -18
  76. package/dist/m365/spo/commands/web/web-reindex.js +10 -18
  77. package/dist/m365/spo/commands/web/web-remove.js +11 -27
  78. package/dist/m365/spo/commands/web/web-retentionlabel-list.js +10 -18
  79. package/dist/m365/spo/commands/web/web-roleassignment-add.js +40 -64
  80. package/dist/m365/spo/commands/web/web-roleassignment-remove.js +31 -58
  81. package/dist/m365/spo/commands/web/web-roleinheritance-break.js +12 -36
  82. package/dist/m365/spo/commands/web/web-roleinheritance-reset.js +11 -29
  83. package/dist/m365/spo/commands/web/web-rule-get.js +47 -0
  84. package/dist/m365/spo/commands/web/web-rule-list.js +6 -4
  85. package/dist/m365/spo/commands/web/web-rule-remove.js +0 -3
  86. package/dist/m365/spo/commands/web/web-set.js +26 -96
  87. package/dist/m365/spo/commands.js +3 -3
  88. package/dist/m365/teams/commands/channel/channel-add.js +46 -57
  89. package/dist/m365/teams/commands/channel/channel-get.js +41 -48
  90. package/dist/m365/teams/commands/channel/channel-list.js +30 -48
  91. package/dist/m365/teams/commands/channel/channel-member-add.js +55 -60
  92. package/dist/m365/teams/commands/channel/channel-member-list.js +49 -61
  93. package/dist/m365/teams/commands/channel/channel-member-remove.js +64 -68
  94. package/dist/m365/teams/commands/channel/channel-member-set.js +63 -71
  95. package/dist/m365/teams/commands/channel/channel-remove.js +49 -57
  96. package/dist/m365/teams/commands/channel/channel-set.js +49 -62
  97. package/dist/m365/teams/commands/chat/chat-get.js +30 -45
  98. package/dist/m365/teams/commands/chat/chat-list.js +22 -42
  99. package/dist/m365/teams/commands/chat/chat-member-add.js +43 -64
  100. package/dist/m365/teams/commands/chat/chat-member-list.js +10 -23
  101. package/dist/m365/teams/commands/chat/chat-member-remove.js +28 -50
  102. package/dist/m365/teams/commands/chat/chat-message-send.js +32 -55
  103. package/dist/m365/teams/commands/tab/tab-get.js +2 -6
  104. package/dist/m365/teams/commands/team/team-archive.js +2 -6
  105. package/dist/m365/teams/commands/team/team-remove.js +2 -6
  106. package/dist/m365/teams/commands/team/team-unarchive.js +2 -6
  107. package/dist/m365/util/commands/accesstoken/accesstoken-get.js +10 -28
  108. package/dist/telemetry.js +7 -11
  109. package/dist/utils/spo.js +1 -3
  110. package/dist/utils/urlUtil.js +2 -2
  111. package/docs/docs/cmd/entra/m365group/m365group-remove.mdx +4 -4
  112. package/docs/docs/cmd/spe/container/container-remove.mdx +5 -5
  113. package/docs/docs/cmd/spo/file/file-archive.mdx +9 -1
  114. package/docs/docs/cmd/spo/file/file-checkin.mdx +2 -2
  115. package/docs/docs/cmd/spo/file/file-checkout-undo.mdx +1 -1
  116. package/docs/docs/cmd/spo/file/file-checkout.mdx +2 -2
  117. package/docs/docs/cmd/spo/file/file-copy.mdx +2 -2
  118. package/docs/docs/cmd/spo/file/file-get.mdx +6 -6
  119. package/docs/docs/cmd/spo/file/file-remove.mdx +4 -4
  120. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +1 -1
  121. package/docs/docs/cmd/spo/file/file-retentionlabel-remove.mdx +1 -1
  122. package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +1 -1
  123. package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +1 -1
  124. package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +3 -3
  125. package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +2 -2
  126. package/docs/docs/cmd/spo/file/file-sharinginfo-get.mdx +2 -2
  127. package/docs/docs/cmd/spo/file/file-sharinglink-add.mdx +22 -1
  128. package/docs/docs/cmd/spo/file/file-sharinglink-clear.mdx +24 -1
  129. package/docs/docs/cmd/spo/file/file-sharinglink-get.mdx +22 -1
  130. package/docs/docs/cmd/spo/file/file-sharinglink-list.mdx +22 -1
  131. package/docs/docs/cmd/spo/file/file-sharinglink-remove.mdx +24 -1
  132. package/docs/docs/cmd/spo/file/file-sharinglink-set.mdx +22 -1
  133. package/docs/docs/cmd/spo/file/file-unarchive.mdx +9 -1
  134. package/docs/docs/cmd/spo/file/file-version-clear.mdx +1 -1
  135. package/docs/docs/cmd/spo/file/file-version-get.mdx +1 -1
  136. package/docs/docs/cmd/spo/file/file-version-keep.mdx +1 -1
  137. package/docs/docs/cmd/spo/file/file-version-list.mdx +1 -1
  138. package/docs/docs/cmd/spo/file/file-version-remove.mdx +1 -1
  139. package/docs/docs/cmd/spo/file/file-version-restore.mdx +1 -1
  140. package/docs/docs/cmd/spo/folder/folder-archive.mdx +7 -1
  141. package/docs/docs/cmd/spo/folder/folder-copy.mdx +1 -1
  142. package/docs/docs/cmd/spo/folder/folder-get.mdx +2 -2
  143. package/docs/docs/cmd/spo/folder/folder-remove.mdx +4 -4
  144. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +1 -1
  145. package/docs/docs/cmd/spo/folder/folder-retentionlabel-remove.mdx +1 -1
  146. package/docs/docs/cmd/spo/folder/folder-sharinglink-add.mdx +22 -1
  147. package/docs/docs/cmd/spo/folder/folder-sharinglink-clear.mdx +23 -0
  148. package/docs/docs/cmd/spo/folder/folder-sharinglink-get.mdx +21 -0
  149. package/docs/docs/cmd/spo/folder/folder-sharinglink-list.mdx +22 -1
  150. package/docs/docs/cmd/spo/folder/folder-sharinglink-remove.mdx +24 -1
  151. package/docs/docs/cmd/spo/folder/folder-sharinglink-set.mdx +21 -0
  152. package/docs/docs/cmd/spo/folder/folder-unarchive.mdx +76 -0
  153. package/docs/docs/cmd/spo/list/list-remove.mdx +4 -4
  154. package/docs/docs/cmd/spo/listitem/listitem-batch-remove.mdx +8 -2
  155. package/docs/docs/cmd/spo/listitem/listitem-get.mdx +0 -6
  156. package/docs/docs/cmd/spo/listitem/listitem-remove.mdx +8 -2
  157. package/docs/docs/cmd/spo/navigation/navigation-node-list.mdx +37 -27
  158. package/docs/docs/cmd/spo/page/page-remove.mdx +4 -4
  159. package/docs/docs/cmd/spo/site/site-apppermission-add.mdx +52 -21
  160. package/docs/docs/cmd/spo/site/site-list.mdx +22 -1
  161. package/docs/docs/cmd/spo/site/site-remove.mdx +3 -3
  162. package/docs/docs/cmd/spo/storageentity/storageentity-get.mdx +11 -2
  163. package/docs/docs/cmd/spo/storageentity/storageentity-list.mdx +9 -3
  164. package/docs/docs/cmd/spo/storageentity/storageentity-remove.mdx +6 -6
  165. package/docs/docs/cmd/spo/storageentity/storageentity-set.mdx +10 -4
  166. package/docs/docs/cmd/spo/web/web-rule-get.mdx +108 -0
  167. package/docs/docs/cmd/spo/web/web-rule-list.mdx +8 -12
  168. package/docs/docs/cmd/spo/web/web-rule-remove.mdx +0 -6
  169. package/docs/docs/cmd/spp/model/model-get.mdx +1 -1
  170. package/docs/docs/cmd/spp/model/model-remove.mdx +1 -1
  171. package/docs/docs/cmd/teams/app/app-install.mdx +21 -0
  172. package/docs/docs/cmd/teams/app/app-list.mdx +19 -0
  173. package/docs/docs/cmd/teams/app/app-publish.mdx +17 -0
  174. package/docs/docs/cmd/teams/app/app-remove.mdx +19 -0
  175. package/docs/docs/cmd/teams/app/app-uninstall.mdx +21 -0
  176. package/docs/docs/cmd/teams/app/app-update.mdx +19 -0
  177. package/docs/docs/cmd/tenant/people/people-profilecardproperty-add.mdx +19 -0
  178. package/docs/docs/cmd/tenant/people/people-profilecardproperty-get.mdx +19 -0
  179. package/docs/docs/cmd/tenant/people/people-profilecardproperty-list.mdx +19 -0
  180. package/docs/docs/cmd/tenant/people/people-profilecardproperty-remove.mdx +19 -0
  181. package/docs/docs/cmd/tenant/people/people-profilecardproperty-set.mdx +19 -0
  182. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.mdx +19 -0
  183. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.mdx +19 -0
  184. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-get.mdx +19 -0
  185. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.mdx +19 -0
  186. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-get.mdx +19 -0
  187. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.mdx +19 -0
  188. package/npm-shrinkwrap.json +1120 -3216
  189. package/package.json +23 -33
  190. package/dist/appInsights.js +0 -43
@@ -1,15 +1,32 @@
1
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
2
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
3
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
4
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
5
- };
6
- var _SpoSiteListCommand_instances, _SpoSiteListCommand_initTelemetry, _SpoSiteListCommand_initOptions, _SpoSiteListCommand_initValidators;
1
+ import { z } from 'zod';
2
+ import { globalOptionsZod } from '../../../../Command.js';
7
3
  import config from '../../../../config.js';
8
4
  import request from '../../../../request.js';
9
5
  import { formatting } from '../../../../utils/formatting.js';
10
6
  import { spo } from '../../../../utils/spo.js';
7
+ import { zod } from '../../../../utils/zod.js';
11
8
  import SpoCommand from '../../../base/SpoCommand.js';
12
9
  import commands from '../../commands.js';
10
+ var SiteListType;
11
+ (function (SiteListType) {
12
+ SiteListType["TeamSite"] = "TeamSite";
13
+ SiteListType["CommunicationSite"] = "CommunicationSite";
14
+ })(SiteListType || (SiteListType = {}));
15
+ var SiteListState;
16
+ (function (SiteListState) {
17
+ SiteListState["active"] = "active";
18
+ SiteListState["fullyArchived"] = "fullyArchived";
19
+ SiteListState["recentlyArchived"] = "recentlyArchived";
20
+ SiteListState["archived"] = "archived";
21
+ })(SiteListState || (SiteListState = {}));
22
+ export const options = z.strictObject({
23
+ ...globalOptionsZod.shape,
24
+ type: zod.coercedEnum(SiteListType).optional().alias('t'),
25
+ state: zod.coercedEnum(SiteListState).optional(),
26
+ webTemplate: z.string().optional(),
27
+ filter: z.string().optional(),
28
+ withOneDriveSites: z.boolean().optional()
29
+ });
13
30
  class SpoSiteListCommand extends SpoCommand {
14
31
  get name() {
15
32
  return commands.SITE_LIST;
@@ -20,12 +37,20 @@ class SpoSiteListCommand extends SpoCommand {
20
37
  defaultProperties() {
21
38
  return ['Title', 'Url'];
22
39
  }
23
- constructor() {
24
- super();
25
- _SpoSiteListCommand_instances.add(this);
26
- __classPrivateFieldGet(this, _SpoSiteListCommand_instances, "m", _SpoSiteListCommand_initTelemetry).call(this);
27
- __classPrivateFieldGet(this, _SpoSiteListCommand_instances, "m", _SpoSiteListCommand_initOptions).call(this);
28
- __classPrivateFieldGet(this, _SpoSiteListCommand_instances, "m", _SpoSiteListCommand_initValidators).call(this);
40
+ get schema() {
41
+ return options;
42
+ }
43
+ getRefinedSchema(schema) {
44
+ return schema
45
+ .refine(o => !(o.type && o.webTemplate), {
46
+ message: 'Specify either type or webTemplate, but not both'
47
+ })
48
+ .refine(o => !(o.withOneDriveSites && (o.type !== undefined || o.webTemplate !== undefined)), {
49
+ message: `When using withOneDriveSites, don't specify the type or webTemplate options`
50
+ })
51
+ .refine(o => !(o.withOneDriveSites && o.state !== undefined), {
52
+ message: `When using withOneDriveSites, don't specify the state option`
53
+ });
29
54
  }
30
55
  alias() {
31
56
  return [commands.SITE_LIST];
@@ -34,13 +59,14 @@ class SpoSiteListCommand extends SpoCommand {
34
59
  const webTemplate = this.getWebTemplateId(args.options);
35
60
  const includeOneDriveSites = args.options.withOneDriveSites || false;
36
61
  const personalSite = includeOneDriveSites === false ? '0' : '1';
62
+ const effectiveFilter = this.buildFilter(args.options);
37
63
  try {
38
64
  const spoAdminUrl = await spo.getSpoAdminUrl(logger, this.debug);
39
65
  if (this.verbose) {
40
66
  await logger.logToStderr(`Retrieving list of site collections...`);
41
67
  }
42
68
  this.allSites = [];
43
- await this.getAllSites(spoAdminUrl, formatting.escapeXml(args.options.filter || ''), '0', personalSite, webTemplate, undefined, logger);
69
+ await this.getAllSites(spoAdminUrl, formatting.escapeXml(effectiveFilter), '0', personalSite, webTemplate, undefined, logger);
44
70
  await logger.log(this.allSites);
45
71
  }
46
72
  catch (err) {
@@ -88,43 +114,28 @@ class SpoSiteListCommand extends SpoCommand {
88
114
  return '';
89
115
  }
90
116
  }
91
- }
92
- _SpoSiteListCommand_instances = new WeakSet(), _SpoSiteListCommand_initTelemetry = function _SpoSiteListCommand_initTelemetry() {
93
- this.telemetry.push((args) => {
94
- Object.assign(this.telemetryProperties, {
95
- webTemplate: args.options.webTemplate,
96
- type: args.options.type,
97
- filter: (!(!args.options.filter)).toString(),
98
- withOneDriveSites: typeof args.options.withOneDriveSites !== 'undefined'
99
- });
100
- });
101
- }, _SpoSiteListCommand_initOptions = function _SpoSiteListCommand_initOptions() {
102
- this.options.unshift({
103
- option: '-t, --type [type]',
104
- autocomplete: ['TeamSite', 'CommunicationSite']
105
- }, {
106
- option: '--webTemplate [webTemplate]'
107
- }, {
108
- option: '--filter [filter]'
109
- }, {
110
- option: '--withOneDriveSites'
111
- });
112
- }, _SpoSiteListCommand_initValidators = function _SpoSiteListCommand_initValidators() {
113
- this.validators.push(async (args) => {
114
- if (args.options.type && args.options.webTemplate) {
115
- return 'Specify either type or webTemplate, but not both';
117
+ buildFilter(options) {
118
+ const providedFilter = options.filter || '';
119
+ let stateFilter = '';
120
+ switch (options.state) {
121
+ case 'active':
122
+ stateFilter = `ArchiveStatus -eq 'NotArchived'`;
123
+ break;
124
+ case 'fullyArchived':
125
+ stateFilter = `ArchiveStatus -eq 'FullyArchived'`;
126
+ break;
127
+ case 'recentlyArchived':
128
+ stateFilter = `ArchiveStatus -eq 'RecentlyArchived'`;
129
+ break;
130
+ case 'archived':
131
+ stateFilter = `ArchiveStatus -ne 'NotArchived'`;
132
+ break;
116
133
  }
117
- const typeValues = ['TeamSite', 'CommunicationSite'];
118
- if (args.options.type &&
119
- typeValues.indexOf(args.options.type) < 0) {
120
- return `${args.options.type} is not a valid value for the type option. Allowed values are ${typeValues.join('|')}`;
134
+ if (stateFilter && providedFilter) {
135
+ return `${providedFilter} and ${stateFilter}`;
121
136
  }
122
- if (args.options.withOneDriveSites
123
- && (args.options.type || args.options.webTemplate)) {
124
- return 'When using withOneDriveSites, don\'t specify the type or webTemplate options';
125
- }
126
- return true;
127
- });
128
- };
137
+ return stateFilter || providedFilter;
138
+ }
139
+ }
129
140
  export default new SpoSiteListCommand();
130
141
  //# sourceMappingURL=site-list.js.map
@@ -71,7 +71,7 @@ class SpoSiteRemoveCommand extends SpoCommand {
71
71
  }
72
72
  if (isGroupSite) {
73
73
  await this.deleteGroupifiedSite(logger, siteUrl);
74
- if (options.skipRecycleBin) {
74
+ if (options.permanent) {
75
75
  let isGroupInRecycleBin = await this.isGroupInEntraRecycleBin(logger, siteDetails.GroupId);
76
76
  let amountOfPolls = 0;
77
77
  while (!isGroupInRecycleBin && amountOfPolls < 20) {
@@ -87,7 +87,7 @@ class SpoSiteRemoveCommand extends SpoCommand {
87
87
  else {
88
88
  await this.deleteNonGroupSite(logger, siteUrl);
89
89
  }
90
- if (options.skipRecycleBin) {
90
+ if (options.permanent) {
91
91
  await this.deleteSiteFromSharePointRecycleBin(logger, siteUrl);
92
92
  }
93
93
  }
@@ -191,7 +191,7 @@ class SpoSiteRemoveCommand extends SpoCommand {
191
191
  _SpoSiteRemoveCommand_instances = new WeakSet(), _SpoSiteRemoveCommand_initTelemetry = function _SpoSiteRemoveCommand_initTelemetry() {
192
192
  this.telemetry.push((args) => {
193
193
  Object.assign(this.telemetryProperties, {
194
- skipRecycleBin: !!args.options.skipRecycleBin,
194
+ permanent: !!args.options.permanent,
195
195
  fromRecycleBin: !!args.options.fromRecycleBin,
196
196
  force: !!args.options.force
197
197
  });
@@ -200,7 +200,7 @@ _SpoSiteRemoveCommand_instances = new WeakSet(), _SpoSiteRemoveCommand_initTelem
200
200
  this.options.unshift({
201
201
  option: '-u, --url <url>'
202
202
  }, {
203
- option: '--skipRecycleBin'
203
+ option: '--permanent'
204
204
  }, {
205
205
  option: '--fromRecycleBin'
206
206
  }, {
@@ -217,14 +217,14 @@ _SpoSiteRemoveCommand_instances = new WeakSet(), _SpoSiteRemoveCommand_initTelem
217
217
  if (rootUrl.toLowerCase() === urlUtil.removeTrailingSlashes(args.options.url.toLowerCase())) {
218
218
  return `The root site cannot be deleted.`;
219
219
  }
220
- if (args.options.fromRecycleBin && args.options.skipRecycleBin) {
221
- return 'Specify either fromRecycleBin or skipRecycleBin, but not both.';
220
+ if (args.options.fromRecycleBin && args.options.permanent) {
221
+ return 'Specify either fromRecycleBin or permanent, but not both.';
222
222
  }
223
223
  return true;
224
224
  });
225
225
  }, _SpoSiteRemoveCommand_initTypes = function _SpoSiteRemoveCommand_initTypes() {
226
226
  this.types.string.push('url');
227
- this.types.boolean.push('skipRecycleBin', 'fromRecycleBin', 'force');
227
+ this.types.boolean.push('permanent', 'fromRecycleBin', 'force');
228
228
  };
229
229
  export default new SpoSiteRemoveCommand();
230
230
  //# sourceMappingURL=site-remove.js.map
@@ -1,6 +1,8 @@
1
1
  import auth from '../../../Auth.js';
2
+ import { globalOptionsZod } from '../../../Command.js';
2
3
  import SpoCommand from '../../base/SpoCommand.js';
3
4
  import commands from '../commands.js';
5
+ export const options = globalOptionsZod.strict();
4
6
  class SpoGetCommand extends SpoCommand {
5
7
  get name() {
6
8
  return commands.GET;
@@ -8,6 +10,9 @@ class SpoGetCommand extends SpoCommand {
8
10
  get description() {
9
11
  return 'Gets the context URL for the root SharePoint site collection and SharePoint tenant admin site';
10
12
  }
13
+ get schema() {
14
+ return options;
15
+ }
11
16
  async commandAction(logger) {
12
17
  const spoContext = {
13
18
  SpoUrl: auth.connection.spoUrl ? auth.connection.spoUrl : ''
@@ -1,14 +1,16 @@
1
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
2
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
3
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
4
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
5
- };
6
- var _SpoSetCommand_instances, _SpoSetCommand_initOptions, _SpoSetCommand_initValidators, _SpoSetCommand_initTypes;
7
1
  import auth from '../../../Auth.js';
2
+ import { globalOptionsZod } from '../../../Command.js';
8
3
  import { urlUtil } from '../../../utils/urlUtil.js';
9
4
  import { validation } from '../../../utils/validation.js';
10
5
  import SpoCommand from '../../base/SpoCommand.js';
11
6
  import commands from '../commands.js';
7
+ import { z } from 'zod';
8
+ export const options = z.strictObject({
9
+ ...globalOptionsZod.shape,
10
+ url: z.string().alias('u').refine(url => validation.isValidSharePointUrl(url) === true, {
11
+ message: 'Specify a valid SharePoint URL'
12
+ })
13
+ });
12
14
  class SpoSetCommand extends SpoCommand {
13
15
  get name() {
14
16
  return commands.SET;
@@ -16,12 +18,8 @@ class SpoSetCommand extends SpoCommand {
16
18
  get description() {
17
19
  return 'Sets the URL of the root SharePoint site collection for use in SPO commands';
18
20
  }
19
- constructor() {
20
- super();
21
- _SpoSetCommand_instances.add(this);
22
- __classPrivateFieldGet(this, _SpoSetCommand_instances, "m", _SpoSetCommand_initOptions).call(this);
23
- __classPrivateFieldGet(this, _SpoSetCommand_instances, "m", _SpoSetCommand_initValidators).call(this);
24
- __classPrivateFieldGet(this, _SpoSetCommand_instances, "m", _SpoSetCommand_initTypes).call(this);
21
+ get schema() {
22
+ return options;
25
23
  }
26
24
  async commandAction(logger, args) {
27
25
  auth.connection.spoUrl = urlUtil.removeTrailingSlashes(args.options.url);
@@ -33,14 +31,5 @@ class SpoSetCommand extends SpoCommand {
33
31
  }
34
32
  }
35
33
  }
36
- _SpoSetCommand_instances = new WeakSet(), _SpoSetCommand_initOptions = function _SpoSetCommand_initOptions() {
37
- this.options.unshift({
38
- option: '-u, --url <url>'
39
- });
40
- }, _SpoSetCommand_initValidators = function _SpoSetCommand_initValidators() {
41
- this.validators.push(async (args) => validation.isValidSharePointUrl(args.options.url));
42
- }, _SpoSetCommand_initTypes = function _SpoSetCommand_initTypes() {
43
- this.types.string.push('url');
44
- };
45
34
  export default new SpoSetCommand();
46
35
  //# sourceMappingURL=spo-set.js.map
@@ -1,14 +1,21 @@
1
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
2
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
3
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
4
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
5
- };
6
- var _SpoStorageEntityGetCommand_instances, _SpoStorageEntityGetCommand_initOptions;
1
+ import { z } from 'zod';
2
+ import { globalOptionsZod } from '../../../../Command.js';
7
3
  import request from '../../../../request.js';
8
4
  import { formatting } from '../../../../utils/formatting.js';
9
5
  import { spo } from '../../../../utils/spo.js';
6
+ import { validation } from '../../../../utils/validation.js';
10
7
  import SpoCommand from '../../../base/SpoCommand.js';
11
8
  import commands from '../../commands.js';
9
+ export const options = z.strictObject({
10
+ ...globalOptionsZod.shape,
11
+ key: z.string().alias('k'),
12
+ appCatalogUrl: z.string()
13
+ .refine(url => validation.isValidSharePointUrl(url) === true, {
14
+ error: e => `'${e.input}' is not a valid SharePoint Online site URL.`
15
+ })
16
+ .optional()
17
+ .alias('u')
18
+ });
12
19
  class SpoStorageEntityGetCommand extends SpoCommand {
13
20
  get name() {
14
21
  return commands.STORAGEENTITY_GET;
@@ -16,16 +23,20 @@ class SpoStorageEntityGetCommand extends SpoCommand {
16
23
  get description() {
17
24
  return 'Gets details for the specified tenant property';
18
25
  }
19
- constructor() {
20
- super();
21
- _SpoStorageEntityGetCommand_instances.add(this);
22
- __classPrivateFieldGet(this, _SpoStorageEntityGetCommand_instances, "m", _SpoStorageEntityGetCommand_initOptions).call(this);
26
+ get schema() {
27
+ return options;
23
28
  }
24
29
  async commandAction(logger, args) {
25
30
  try {
26
- const spoUrl = await spo.getSpoUrl(logger, this.debug);
31
+ let appCatalogUrl = args.options.appCatalogUrl;
32
+ if (!appCatalogUrl) {
33
+ appCatalogUrl = await spo.getTenantAppCatalogUrl(logger, this.debug);
34
+ if (!appCatalogUrl) {
35
+ throw 'Tenant app catalog URL not found. Specify the URL of the app catalog site using the appCatalogUrl option.';
36
+ }
37
+ }
27
38
  const requestOptions = {
28
- url: `${spoUrl}/_api/web/GetStorageEntity('${formatting.encodeQueryParameter(args.options.key)}')`,
39
+ url: `${appCatalogUrl}/_api/web/GetStorageEntity('${formatting.encodeQueryParameter(args.options.key)}')`,
29
40
  headers: {
30
41
  accept: 'application/json;odata=nometadata'
31
42
  },
@@ -51,10 +62,5 @@ class SpoStorageEntityGetCommand extends SpoCommand {
51
62
  }
52
63
  }
53
64
  }
54
- _SpoStorageEntityGetCommand_instances = new WeakSet(), _SpoStorageEntityGetCommand_initOptions = function _SpoStorageEntityGetCommand_initOptions() {
55
- this.options.unshift({
56
- option: '-k, --key <key>'
57
- });
58
- };
59
65
  export default new SpoStorageEntityGetCommand();
60
66
  //# sourceMappingURL=storageentity-get.js.map
@@ -1,13 +1,19 @@
1
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
2
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
3
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
4
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
5
- };
6
- var _SpoStorageEntityListCommand_instances, _SpoStorageEntityListCommand_initOptions, _SpoStorageEntityListCommand_initValidators;
1
+ import { z } from 'zod';
2
+ import { globalOptionsZod } from '../../../../Command.js';
7
3
  import request from '../../../../request.js';
4
+ import { spo } from '../../../../utils/spo.js';
8
5
  import { validation } from '../../../../utils/validation.js';
9
6
  import SpoCommand from '../../../base/SpoCommand.js';
10
7
  import commands from '../../commands.js';
8
+ export const options = z.strictObject({
9
+ ...globalOptionsZod.shape,
10
+ appCatalogUrl: z.string()
11
+ .refine(url => validation.isValidSharePointUrl(url) === true, {
12
+ error: e => `'${e.input}' is not a valid SharePoint Online site URL.`
13
+ })
14
+ .optional()
15
+ .alias('u')
16
+ });
11
17
  class SpoStorageEntityListCommand extends SpoCommand {
12
18
  get name() {
13
19
  return commands.STORAGEENTITY_LIST;
@@ -15,30 +21,35 @@ class SpoStorageEntityListCommand extends SpoCommand {
15
21
  get description() {
16
22
  return 'Lists tenant properties stored on the specified SharePoint Online app catalog';
17
23
  }
18
- constructor() {
19
- super();
20
- _SpoStorageEntityListCommand_instances.add(this);
21
- __classPrivateFieldGet(this, _SpoStorageEntityListCommand_instances, "m", _SpoStorageEntityListCommand_initOptions).call(this);
22
- __classPrivateFieldGet(this, _SpoStorageEntityListCommand_instances, "m", _SpoStorageEntityListCommand_initValidators).call(this);
24
+ get schema() {
25
+ return options;
23
26
  }
24
27
  async commandAction(logger, args) {
25
- if (this.verbose) {
26
- await logger.logToStderr(`Retrieving details for all tenant properties in ${args.options.appCatalogUrl}...`);
27
- }
28
- const requestOptions = {
29
- url: `${args.options.appCatalogUrl}/_api/web/AllProperties?$select=storageentitiesindex`,
30
- headers: {
31
- accept: 'application/json;odata=nometadata'
32
- },
33
- responseType: 'json'
34
- };
35
28
  try {
29
+ let appCatalogUrl = args.options.appCatalogUrl;
30
+ if (!appCatalogUrl) {
31
+ appCatalogUrl = await spo.getTenantAppCatalogUrl(logger, this.debug);
32
+ if (!appCatalogUrl) {
33
+ throw 'Tenant app catalog URL not found. Specify the URL of the app catalog site using the appCatalogUrl option.';
34
+ }
35
+ }
36
+ if (this.verbose) {
37
+ await logger.logToStderr(`Retrieving details for all tenant properties in ${appCatalogUrl}...`);
38
+ }
39
+ const requestOptions = {
40
+ url: `${appCatalogUrl}/_api/web/AllProperties?$select=storageentitiesindex`,
41
+ headers: {
42
+ accept: 'application/json;odata=nometadata'
43
+ },
44
+ responseType: 'json'
45
+ };
36
46
  const web = await request.get(requestOptions);
37
47
  if (!web.storageentitiesindex ||
38
48
  web.storageentitiesindex.trim().length === 0) {
39
49
  if (this.verbose) {
40
50
  await logger.logToStderr('No tenant properties found');
41
51
  }
52
+ await logger.log([]);
42
53
  }
43
54
  else {
44
55
  const properties = JSON.parse(web.storageentitiesindex);
@@ -47,17 +58,16 @@ class SpoStorageEntityListCommand extends SpoCommand {
47
58
  if (this.verbose) {
48
59
  await logger.logToStderr('No tenant properties found');
49
60
  }
61
+ await logger.log([]);
50
62
  }
51
63
  else {
52
- await logger.log(keys.map((key) => {
53
- const property = properties[key];
54
- return {
55
- Key: key,
56
- Value: property.Value,
57
- Description: property.Description,
58
- Comment: property.Comment
59
- };
64
+ const result = keys.map(key => ({
65
+ Key: key,
66
+ Value: properties[key].Value,
67
+ Description: properties[key].Description,
68
+ Comment: properties[key].Comment
60
69
  }));
70
+ await logger.log(result);
61
71
  }
62
72
  }
63
73
  }
@@ -66,12 +76,5 @@ class SpoStorageEntityListCommand extends SpoCommand {
66
76
  }
67
77
  }
68
78
  }
69
- _SpoStorageEntityListCommand_instances = new WeakSet(), _SpoStorageEntityListCommand_initOptions = function _SpoStorageEntityListCommand_initOptions() {
70
- this.options.unshift({
71
- option: '-u, --appCatalogUrl <appCatalogUrl>'
72
- });
73
- }, _SpoStorageEntityListCommand_initValidators = function _SpoStorageEntityListCommand_initValidators() {
74
- this.validators.push(async (args) => validation.isValidSharePointUrl(args.options.appCatalogUrl));
75
- };
76
79
  export default new SpoStorageEntityListCommand();
77
80
  //# sourceMappingURL=storageentity-list.js.map
@@ -1,17 +1,24 @@
1
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
2
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
3
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
4
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
5
- };
6
- var _SpoStorageEntityRemoveCommand_instances, _SpoStorageEntityRemoveCommand_initTelemetry, _SpoStorageEntityRemoveCommand_initOptions, _SpoStorageEntityRemoveCommand_initValidators;
1
+ import { z } from 'zod';
7
2
  import { cli } from '../../../../cli/cli.js';
8
3
  import config from '../../../../config.js';
4
+ import { globalOptionsZod } from '../../../../Command.js';
9
5
  import request from '../../../../request.js';
10
6
  import { formatting } from '../../../../utils/formatting.js';
11
7
  import { spo } from '../../../../utils/spo.js';
12
8
  import { validation } from '../../../../utils/validation.js';
13
9
  import SpoCommand from '../../../base/SpoCommand.js';
14
10
  import commands from '../../commands.js';
11
+ export const options = z.strictObject({
12
+ ...globalOptionsZod.shape,
13
+ appCatalogUrl: z.string()
14
+ .refine(url => validation.isValidSharePointUrl(url) === true, {
15
+ error: e => `'${e.input}' is not a valid SharePoint Online site URL.`
16
+ })
17
+ .optional()
18
+ .alias('u'),
19
+ key: z.string().alias('k'),
20
+ force: z.boolean().optional().alias('f')
21
+ });
15
22
  class SpoStorageEntityRemoveCommand extends SpoCommand {
16
23
  get name() {
17
24
  return commands.STORAGEENTITY_REMOVE;
@@ -19,12 +26,8 @@ class SpoStorageEntityRemoveCommand extends SpoCommand {
19
26
  get description() {
20
27
  return 'Removes tenant property stored on the specified SharePoint Online app catalog';
21
28
  }
22
- constructor() {
23
- super();
24
- _SpoStorageEntityRemoveCommand_instances.add(this);
25
- __classPrivateFieldGet(this, _SpoStorageEntityRemoveCommand_instances, "m", _SpoStorageEntityRemoveCommand_initTelemetry).call(this);
26
- __classPrivateFieldGet(this, _SpoStorageEntityRemoveCommand_instances, "m", _SpoStorageEntityRemoveCommand_initOptions).call(this);
27
- __classPrivateFieldGet(this, _SpoStorageEntityRemoveCommand_instances, "m", _SpoStorageEntityRemoveCommand_initValidators).call(this);
29
+ get schema() {
30
+ return options;
28
31
  }
29
32
  async commandAction(logger, args) {
30
33
  if (args.options.force) {
@@ -38,10 +41,17 @@ class SpoStorageEntityRemoveCommand extends SpoCommand {
38
41
  }
39
42
  }
40
43
  async removeTenantProperty(logger, args) {
41
- if (this.verbose) {
42
- await logger.logToStderr(`Removing tenant property ${args.options.key} from ${args.options.appCatalogUrl}...`);
43
- }
44
44
  try {
45
+ let appCatalogUrl = args.options.appCatalogUrl;
46
+ if (!appCatalogUrl) {
47
+ appCatalogUrl = await spo.getTenantAppCatalogUrl(logger, this.debug);
48
+ if (!appCatalogUrl) {
49
+ throw 'Tenant app catalog URL not found. Specify the URL of the app catalog site using the appCatalogUrl option.';
50
+ }
51
+ }
52
+ if (this.verbose) {
53
+ await logger.logToStderr(`Removing tenant property ${args.options.key} from ${appCatalogUrl}...`);
54
+ }
45
55
  const spoAdminUrl = await spo.getSpoAdminUrl(logger, this.debug);
46
56
  const digestInfo = await spo.getRequestDigest(spoAdminUrl);
47
57
  const requestOptions = {
@@ -49,7 +59,7 @@ class SpoStorageEntityRemoveCommand extends SpoCommand {
49
59
  headers: {
50
60
  'X-RequestDigest': digestInfo.FormDigestValue
51
61
  },
52
- data: `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="31" ObjectPathId="30" /><ObjectPath Id="33" ObjectPathId="32" /><ObjectPath Id="35" ObjectPathId="34" /><Method Name="RemoveStorageEntity" Id="36" ObjectPathId="34"><Parameters><Parameter Type="String">${formatting.escapeXml(args.options.key)}</Parameter></Parameters></Method></Actions><ObjectPaths><Constructor Id="30" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="32" ParentId="30" Name="GetSiteByUrl"><Parameters><Parameter Type="String">${formatting.escapeXml(args.options.appCatalogUrl)}</Parameter></Parameters></Method><Property Id="34" ParentId="32" Name="RootWeb" /></ObjectPaths></Request>`
62
+ data: `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="31" ObjectPathId="30" /><ObjectPath Id="33" ObjectPathId="32" /><ObjectPath Id="35" ObjectPathId="34" /><Method Name="RemoveStorageEntity" Id="36" ObjectPathId="34"><Parameters><Parameter Type="String">${formatting.escapeXml(args.options.key)}</Parameter></Parameters></Method></Actions><ObjectPaths><Constructor Id="30" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="32" ParentId="30" Name="GetSiteByUrl"><Parameters><Parameter Type="String">${formatting.escapeXml(appCatalogUrl)}</Parameter></Parameters></Method><Property Id="34" ParentId="32" Name="RootWeb" /></ObjectPaths></Request>`
53
63
  };
54
64
  const processQuery = await request.post(requestOptions);
55
65
  const json = JSON.parse(processQuery);
@@ -63,22 +73,5 @@ class SpoStorageEntityRemoveCommand extends SpoCommand {
63
73
  }
64
74
  }
65
75
  }
66
- _SpoStorageEntityRemoveCommand_instances = new WeakSet(), _SpoStorageEntityRemoveCommand_initTelemetry = function _SpoStorageEntityRemoveCommand_initTelemetry() {
67
- this.telemetry.push((args) => {
68
- Object.assign(this.telemetryProperties, {
69
- force: (!(!args.options.force)).toString()
70
- });
71
- });
72
- }, _SpoStorageEntityRemoveCommand_initOptions = function _SpoStorageEntityRemoveCommand_initOptions() {
73
- this.options.unshift({
74
- option: '-u, --appCatalogUrl <appCatalogUrl>'
75
- }, {
76
- option: '-k, --key <key>'
77
- }, {
78
- option: '-f, --force'
79
- });
80
- }, _SpoStorageEntityRemoveCommand_initValidators = function _SpoStorageEntityRemoveCommand_initValidators() {
81
- this.validators.push(async (args) => validation.isValidSharePointUrl(args.options.appCatalogUrl));
82
- };
83
76
  export default new SpoStorageEntityRemoveCommand();
84
77
  //# sourceMappingURL=storageentity-remove.js.map