@pnp/cli-microsoft365 12.0.0-beta.10c5833 → 12.0.0-beta.4ac11a7

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 (137) 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 +15 -1
  5. package/dist/googleAnalytics.js +96 -0
  6. package/dist/m365/spfx/commands/SpfxCompatibilityMatrix.js +15 -0
  7. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.24.0-rc.0.js +19 -0
  8. package/dist/m365/spfx/commands/project/project-doctor.js +2 -1
  9. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN012021_TSC_excludeDirectories.js +43 -0
  10. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN027002_OVERRIDES_qs.js +33 -0
  11. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN027003_OVERRIDES_uuid.js +33 -0
  12. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.24.0-rc.0.js +77 -0
  13. package/dist/m365/spfx/commands/project/project-upgrade.js +12 -11
  14. package/dist/m365/spo/commands/app/app-add.js +35 -56
  15. package/dist/m365/spo/commands/app/app-deploy.js +41 -59
  16. package/dist/m365/spo/commands/app/app-get.js +40 -56
  17. package/dist/m365/spo/commands/app/app-install.js +20 -41
  18. package/dist/m365/spo/commands/app/app-instance-list.js +12 -24
  19. package/dist/m365/spo/commands/app/app-list.js +26 -44
  20. package/dist/m365/spo/commands/app/app-remove.js +32 -52
  21. package/dist/m365/spo/commands/app/app-retract.js +32 -51
  22. package/dist/m365/spo/commands/app/app-teamspackage-download.js +35 -54
  23. package/dist/m365/spo/commands/app/app-uninstall.js +21 -44
  24. package/dist/m365/spo/commands/app/app-upgrade.js +20 -41
  25. package/dist/m365/spo/commands/feature/feature-disable.js +20 -50
  26. package/dist/m365/spo/commands/feature/feature-enable.js +22 -50
  27. package/dist/m365/spo/commands/feature/feature-list.js +11 -36
  28. package/dist/m365/spo/commands/field/field-add.js +33 -62
  29. package/dist/m365/spo/commands/field/field-get.js +30 -57
  30. package/dist/m365/spo/commands/field/field-list.js +21 -46
  31. package/dist/m365/spo/commands/field/field-remove.js +32 -63
  32. package/dist/m365/spo/commands/field/field-set.js +34 -66
  33. package/dist/m365/spo/commands/file/file-get.js +4 -3
  34. package/dist/m365/spo/commands/folder/folder-unarchive.js +90 -0
  35. package/dist/m365/spo/commands/hubsite/hubsite-connect.js +38 -63
  36. package/dist/m365/spo/commands/hubsite/hubsite-data-get.js +11 -27
  37. package/dist/m365/spo/commands/hubsite/hubsite-disconnect.js +25 -47
  38. package/dist/m365/spo/commands/hubsite/hubsite-get.js +25 -37
  39. package/dist/m365/spo/commands/hubsite/hubsite-list.js +12 -24
  40. package/dist/m365/spo/commands/hubsite/hubsite-register.js +10 -18
  41. package/dist/m365/spo/commands/hubsite/hubsite-rights-grant.js +14 -32
  42. package/dist/m365/spo/commands/hubsite/hubsite-rights-revoke.js +12 -29
  43. package/dist/m365/spo/commands/hubsite/hubsite-set.js +19 -46
  44. package/dist/m365/spo/commands/hubsite/hubsite-unregister.js +11 -27
  45. package/dist/m365/spo/commands/listitem/listitem-get.js +1 -12
  46. package/dist/m365/spo/commands/navigation/navigation-node-add.js +74 -120
  47. package/dist/m365/spo/commands/navigation/navigation-node-get.js +4 -13
  48. package/dist/m365/spo/commands/navigation/navigation-node-list.js +6 -4
  49. package/dist/m365/spo/commands/navigation/navigation-node-set.js +53 -114
  50. package/dist/m365/spo/commands/page/page-unpublish.js +53 -0
  51. package/dist/m365/spo/commands/sitescript/sitescript-add.js +22 -37
  52. package/dist/m365/spo/commands/sitescript/sitescript-get.js +9 -26
  53. package/dist/m365/spo/commands/sitescript/sitescript-list.js +5 -0
  54. package/dist/m365/spo/commands/sitescript/sitescript-remove.js +9 -33
  55. package/dist/m365/spo/commands/sitescript/sitescript-set.js +29 -56
  56. package/dist/m365/spo/commands.js +3 -1
  57. package/dist/m365/spp/commands/contentcenter/contentcenter-list.js +5 -0
  58. package/dist/m365/spp/commands/model/model-get.js +25 -45
  59. package/dist/m365/spp/commands/model/model-list.js +12 -23
  60. package/dist/m365/spp/commands/model/model-remove.js +25 -45
  61. package/dist/m365/teams/commands/channel/channel-add.js +46 -57
  62. package/dist/m365/teams/commands/channel/channel-get.js +41 -48
  63. package/dist/m365/teams/commands/channel/channel-list.js +28 -42
  64. package/dist/m365/teams/commands/channel/channel-member-add.js +53 -54
  65. package/dist/m365/teams/commands/channel/channel-member-list.js +47 -55
  66. package/dist/m365/teams/commands/channel/channel-member-remove.js +62 -62
  67. package/dist/m365/teams/commands/channel/channel-member-set.js +61 -65
  68. package/dist/m365/teams/commands/channel/channel-remove.js +47 -49
  69. package/dist/m365/teams/commands/channel/channel-set.js +47 -54
  70. package/dist/m365/teams/commands/chat/chat-get.js +30 -45
  71. package/dist/m365/teams/commands/chat/chat-list.js +22 -42
  72. package/dist/m365/teams/commands/chat/chat-member-add.js +43 -64
  73. package/dist/m365/teams/commands/chat/chat-member-list.js +10 -23
  74. package/dist/m365/teams/commands/chat/chat-member-remove.js +28 -50
  75. package/dist/m365/teams/commands/chat/chat-message-send.js +32 -55
  76. package/dist/m365/util/commands/accesstoken/accesstoken-get.js +10 -28
  77. package/dist/telemetry.js +7 -11
  78. package/dist/utils/spo.js +40 -3
  79. package/dist/utils/urlUtil.js +2 -2
  80. package/docs/docs/cmd/login.mdx +15 -2
  81. package/docs/docs/cmd/spo/file/file-archive.mdx +1 -1
  82. package/docs/docs/cmd/spo/file/file-checkin.mdx +2 -2
  83. package/docs/docs/cmd/spo/file/file-checkout-undo.mdx +1 -1
  84. package/docs/docs/cmd/spo/file/file-checkout.mdx +2 -2
  85. package/docs/docs/cmd/spo/file/file-copy.mdx +2 -2
  86. package/docs/docs/cmd/spo/file/file-get.mdx +6 -6
  87. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +1 -1
  88. package/docs/docs/cmd/spo/file/file-retentionlabel-remove.mdx +1 -1
  89. package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +1 -1
  90. package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +1 -1
  91. package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +3 -3
  92. package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +2 -2
  93. package/docs/docs/cmd/spo/file/file-sharinginfo-get.mdx +2 -2
  94. package/docs/docs/cmd/spo/file/file-sharinglink-add.mdx +22 -1
  95. package/docs/docs/cmd/spo/file/file-sharinglink-clear.mdx +24 -1
  96. package/docs/docs/cmd/spo/file/file-sharinglink-get.mdx +22 -1
  97. package/docs/docs/cmd/spo/file/file-sharinglink-list.mdx +22 -1
  98. package/docs/docs/cmd/spo/file/file-sharinglink-remove.mdx +24 -1
  99. package/docs/docs/cmd/spo/file/file-sharinglink-set.mdx +22 -1
  100. package/docs/docs/cmd/spo/file/file-unarchive.mdx +1 -1
  101. package/docs/docs/cmd/spo/file/file-version-clear.mdx +1 -1
  102. package/docs/docs/cmd/spo/file/file-version-get.mdx +1 -1
  103. package/docs/docs/cmd/spo/file/file-version-keep.mdx +1 -1
  104. package/docs/docs/cmd/spo/file/file-version-list.mdx +1 -1
  105. package/docs/docs/cmd/spo/file/file-version-remove.mdx +1 -1
  106. package/docs/docs/cmd/spo/file/file-version-restore.mdx +1 -1
  107. package/docs/docs/cmd/spo/folder/folder-archive.mdx +1 -1
  108. package/docs/docs/cmd/spo/folder/folder-copy.mdx +1 -1
  109. package/docs/docs/cmd/spo/folder/folder-get.mdx +2 -2
  110. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +1 -1
  111. package/docs/docs/cmd/spo/folder/folder-retentionlabel-remove.mdx +1 -1
  112. package/docs/docs/cmd/spo/folder/folder-sharinglink-add.mdx +22 -1
  113. package/docs/docs/cmd/spo/folder/folder-sharinglink-clear.mdx +23 -0
  114. package/docs/docs/cmd/spo/folder/folder-sharinglink-get.mdx +21 -0
  115. package/docs/docs/cmd/spo/folder/folder-sharinglink-list.mdx +22 -1
  116. package/docs/docs/cmd/spo/folder/folder-sharinglink-remove.mdx +24 -1
  117. package/docs/docs/cmd/spo/folder/folder-sharinglink-set.mdx +21 -0
  118. package/docs/docs/cmd/spo/folder/folder-unarchive.mdx +76 -0
  119. package/docs/docs/cmd/spo/listitem/listitem-get.mdx +0 -6
  120. package/docs/docs/cmd/spo/navigation/navigation-node-add.mdx +45 -30
  121. package/docs/docs/cmd/spo/navigation/navigation-node-get.mdx +64 -42
  122. package/docs/docs/cmd/spo/navigation/navigation-node-list.mdx +37 -27
  123. package/docs/docs/cmd/spo/navigation/navigation-node-set.mdx +10 -8
  124. package/docs/docs/cmd/spo/page/page-unpublish.mdx +63 -0
  125. package/docs/docs/cmd/spp/model/model-get.mdx +1 -1
  126. package/docs/docs/cmd/spp/model/model-remove.mdx +1 -1
  127. package/docs/docs/cmd/teams/tab/tab-add.mdx +19 -0
  128. package/docs/docs/cmd/teams/tab/tab-get.mdx +19 -0
  129. package/docs/docs/cmd/teams/tab/tab-list.mdx +19 -0
  130. package/docs/docs/cmd/teams/tab/tab-remove.mdx +21 -0
  131. package/docs/docs/cmd/viva/engage/engage-message-add.mdx +17 -0
  132. package/docs/docs/cmd/viva/engage/engage-message-get.mdx +17 -0
  133. package/docs/docs/cmd/viva/engage/engage-message-list.mdx +17 -0
  134. package/docs/docs/cmd/viva/engage/engage-message-remove.mdx +19 -0
  135. package/npm-shrinkwrap.json +702 -3230
  136. package/package.json +21 -38
  137. package/dist/appInsights.js +0 -43
@@ -1,16 +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 _SpoHubSiteSetCommand_instances, _SpoHubSiteSetCommand_initTelemetry, _SpoHubSiteSetCommand_initOptions, _SpoHubSiteSetCommand_initValidators, _SpoHubSiteSetCommand_initTypes;
1
+ import { z } from 'zod';
7
2
  import config from '../../../../config.js';
3
+ import { globalOptionsZod } from '../../../../Command.js';
8
4
  import request from '../../../../request.js';
9
5
  import { formatting } from '../../../../utils/formatting.js';
10
6
  import { spo } from '../../../../utils/spo.js';
11
7
  import { validation } from '../../../../utils/validation.js';
12
8
  import SpoCommand from '../../../base/SpoCommand.js';
13
9
  import commands from '../../commands.js';
10
+ export const options = z.strictObject({
11
+ ...globalOptionsZod.shape,
12
+ id: z.string().refine(id => validation.isValidGuid(id), {
13
+ error: e => `${e.input} is not a valid GUID`
14
+ }).alias('i'),
15
+ title: z.string().optional().alias('t'),
16
+ description: z.string().optional().alias('d'),
17
+ logoUrl: z.string().optional().alias('l')
18
+ });
14
19
  class SpoHubSiteSetCommand extends SpoCommand {
15
20
  get name() {
16
21
  return commands.HUBSITE_SET;
@@ -18,13 +23,14 @@ class SpoHubSiteSetCommand extends SpoCommand {
18
23
  get description() {
19
24
  return 'Updates properties of the specified hub site';
20
25
  }
21
- constructor() {
22
- super();
23
- _SpoHubSiteSetCommand_instances.add(this);
24
- __classPrivateFieldGet(this, _SpoHubSiteSetCommand_instances, "m", _SpoHubSiteSetCommand_initTelemetry).call(this);
25
- __classPrivateFieldGet(this, _SpoHubSiteSetCommand_instances, "m", _SpoHubSiteSetCommand_initOptions).call(this);
26
- __classPrivateFieldGet(this, _SpoHubSiteSetCommand_instances, "m", _SpoHubSiteSetCommand_initValidators).call(this);
27
- __classPrivateFieldGet(this, _SpoHubSiteSetCommand_instances, "m", _SpoHubSiteSetCommand_initTypes).call(this);
26
+ get schema() {
27
+ return options;
28
+ }
29
+ getRefinedSchema(schema) {
30
+ return schema
31
+ .refine(opts => opts.title !== undefined || opts.description !== undefined || opts.logoUrl !== undefined, {
32
+ error: 'Specify title, description or logoUrl to update'
33
+ });
28
34
  }
29
35
  async commandAction(logger, args) {
30
36
  try {
@@ -62,38 +68,5 @@ class SpoHubSiteSetCommand extends SpoCommand {
62
68
  }
63
69
  }
64
70
  }
65
- _SpoHubSiteSetCommand_instances = new WeakSet(), _SpoHubSiteSetCommand_initTelemetry = function _SpoHubSiteSetCommand_initTelemetry() {
66
- this.telemetry.push((args) => {
67
- Object.assign(this.telemetryProperties, {
68
- title: typeof args.options.title === 'string',
69
- description: typeof args.options.description === 'string',
70
- logoUrl: typeof args.options.logoUrl === 'string'
71
- });
72
- });
73
- }, _SpoHubSiteSetCommand_initOptions = function _SpoHubSiteSetCommand_initOptions() {
74
- this.options.unshift({
75
- option: '-i, --id <id>'
76
- }, {
77
- option: '-t, --title [title]'
78
- }, {
79
- option: '-d, --description [description]'
80
- }, {
81
- option: '-l, --logoUrl [logoUrl]'
82
- });
83
- }, _SpoHubSiteSetCommand_initValidators = function _SpoHubSiteSetCommand_initValidators() {
84
- this.validators.push(async (args) => {
85
- if (!validation.isValidGuid(args.options.id)) {
86
- return `${args.options.id} is not a valid GUID`;
87
- }
88
- if (!args.options.title &&
89
- !args.options.description &&
90
- !args.options.logoUrl) {
91
- return 'Specify title, description or logoUrl to update';
92
- }
93
- return true;
94
- });
95
- }, _SpoHubSiteSetCommand_initTypes = function _SpoHubSiteSetCommand_initTypes() {
96
- this.types.string.push('t', 'title', 'd', 'description', 'l', 'logoUrl');
97
- };
98
71
  export default new SpoHubSiteSetCommand();
99
72
  //# sourceMappingURL=hubsite-set.js.map
@@ -1,15 +1,18 @@
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 _SpoHubSiteUnregisterCommand_instances, _SpoHubSiteUnregisterCommand_initTelemetry, _SpoHubSiteUnregisterCommand_initOptions, _SpoHubSiteUnregisterCommand_initValidators;
1
+ import { z } from 'zod';
7
2
  import { cli } from '../../../../cli/cli.js';
3
+ import { globalOptionsZod } from '../../../../Command.js';
8
4
  import request from '../../../../request.js';
9
5
  import { spo } from '../../../../utils/spo.js';
10
6
  import { validation } from '../../../../utils/validation.js';
11
7
  import SpoCommand from '../../../base/SpoCommand.js';
12
8
  import commands from '../../commands.js';
9
+ export const options = z.strictObject({
10
+ ...globalOptionsZod.shape,
11
+ url: z.string().refine(url => validation.isValidSharePointUrl(url) === true, {
12
+ error: e => `'${e.input}' is not a valid SharePoint Online site URL.`
13
+ }).alias('u'),
14
+ force: z.boolean().optional().alias('f')
15
+ });
13
16
  class SpoHubSiteUnregisterCommand extends SpoCommand {
14
17
  get name() {
15
18
  return commands.HUBSITE_UNREGISTER;
@@ -17,12 +20,8 @@ class SpoHubSiteUnregisterCommand extends SpoCommand {
17
20
  get description() {
18
21
  return 'Unregisters the specified site collection as a hub site';
19
22
  }
20
- constructor() {
21
- super();
22
- _SpoHubSiteUnregisterCommand_instances.add(this);
23
- __classPrivateFieldGet(this, _SpoHubSiteUnregisterCommand_instances, "m", _SpoHubSiteUnregisterCommand_initTelemetry).call(this);
24
- __classPrivateFieldGet(this, _SpoHubSiteUnregisterCommand_instances, "m", _SpoHubSiteUnregisterCommand_initOptions).call(this);
25
- __classPrivateFieldGet(this, _SpoHubSiteUnregisterCommand_instances, "m", _SpoHubSiteUnregisterCommand_initValidators).call(this);
23
+ get schema() {
24
+ return options;
26
25
  }
27
26
  async commandAction(logger, args) {
28
27
  const unregisterHubSite = async () => {
@@ -56,20 +55,5 @@ class SpoHubSiteUnregisterCommand extends SpoCommand {
56
55
  }
57
56
  }
58
57
  }
59
- _SpoHubSiteUnregisterCommand_instances = new WeakSet(), _SpoHubSiteUnregisterCommand_initTelemetry = function _SpoHubSiteUnregisterCommand_initTelemetry() {
60
- this.telemetry.push((args) => {
61
- Object.assign(this.telemetryProperties, {
62
- force: args.options.force || false
63
- });
64
- });
65
- }, _SpoHubSiteUnregisterCommand_initOptions = function _SpoHubSiteUnregisterCommand_initOptions() {
66
- this.options.unshift({
67
- option: '-u, --url <url>'
68
- }, {
69
- option: '-f, --force'
70
- });
71
- }, _SpoHubSiteUnregisterCommand_initValidators = function _SpoHubSiteUnregisterCommand_initValidators() {
72
- this.validators.push(async (args) => validation.isValidSharePointUrl(args.options.url));
73
- };
74
58
  export default new SpoHubSiteUnregisterCommand();
75
59
  //# sourceMappingURL=hubsite-unregister.js.map
@@ -11,9 +11,6 @@ import { validation } from '../../../../utils/validation.js';
11
11
  import SpoCommand from '../../../base/SpoCommand.js';
12
12
  import commands from '../../commands.js';
13
13
  class SpoListItemGetCommand extends SpoCommand {
14
- allowUnknownOptions() {
15
- return true;
16
- }
17
14
  get name() {
18
15
  return commands.LISTITEM_GET;
19
16
  }
@@ -30,12 +27,6 @@ class SpoListItemGetCommand extends SpoCommand {
30
27
  __classPrivateFieldGet(this, _SpoListItemGetCommand_instances, "m", _SpoListItemGetCommand_initOptionSets).call(this);
31
28
  }
32
29
  async commandAction(logger, args) {
33
- if (args.options.properties) {
34
- await this.warn(logger, `Option 'properties' is deprecated. Please use 'fields' instead.`);
35
- if (!args.options.fields) {
36
- args.options.fields = args.options.properties;
37
- }
38
- }
39
30
  let requestUrl = `${args.options.webUrl}/_api/web`;
40
31
  if (args.options.listId) {
41
32
  requestUrl += `/lists(guid'${formatting.encodeQueryParameter(args.options.listId)}')`;
@@ -109,8 +100,6 @@ _SpoListItemGetCommand_instances = new WeakSet(), _SpoListItemGetCommand_initTel
109
100
  option: '--listUrl [listUrl]'
110
101
  }, {
111
102
  option: '--fields [fields]'
112
- }, {
113
- option: '-p, --properties [properties]'
114
103
  }, {
115
104
  option: '--withPermissions'
116
105
  });
@@ -135,7 +124,7 @@ _SpoListItemGetCommand_instances = new WeakSet(), _SpoListItemGetCommand_initTel
135
124
  return true;
136
125
  });
137
126
  }, _SpoListItemGetCommand_initTypes = function _SpoListItemGetCommand_initTypes() {
138
- this.types.string.push('webUrl', 'listId', 'listTitle', 'id', 'uniqueId', 'fields', 'properties');
127
+ this.types.string.push('webUrl', 'listId', 'listTitle', 'id', 'uniqueId', 'fields');
139
128
  }, _SpoListItemGetCommand_initOptionSets = function _SpoListItemGetCommand_initOptionSets() {
140
129
  this.optionSets.push({ options: ['listId', 'listTitle', 'listUrl'] }, { options: ['id', 'uniqueId'] });
141
130
  };
@@ -1,14 +1,30 @@
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 _SpoNavigationNodeAddCommand_instances, _SpoNavigationNodeAddCommand_initTelemetry, _SpoNavigationNodeAddCommand_initOptions, _SpoNavigationNodeAddCommand_initValidators, _SpoNavigationNodeAddCommand_initOptionSets;
7
- import request from '../../../../request.js';
1
+ import { globalOptionsZod } from '../../../../Command.js';
2
+ import { z } from 'zod';
8
3
  import { spo } from '../../../../utils/spo.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
+ export const options = z.strictObject({
8
+ ...globalOptionsZod.shape,
9
+ webUrl: z.string()
10
+ .refine(url => validation.isValidSharePointUrl(url) === true, {
11
+ error: e => `'${e.input}' is not a valid SharePoint Online site URL.`
12
+ })
13
+ .alias('u'),
14
+ location: z.enum(['QuickLaunch', 'TopNavigationBar']).optional().alias('l'),
15
+ title: z.string().min(1, 'Cannot be empty.').alias('t'),
16
+ url: z.string().optional(),
17
+ parentNodeId: z.int().positive().optional(),
18
+ audienceIds: z.string()
19
+ .refine(audienceIds => audienceIds.split(',').length <= 10, {
20
+ error: 'The maximum amount of audienceIds per navigation node exceeded. The maximum amount of audienceIds is 10.'
21
+ })
22
+ .refine(audienceIds => validation.isValidGuidArray(audienceIds) === true, {
23
+ error: e => `The following GUIDs are invalid for the option 'audienceIds': ${validation.isValidGuidArray(e.input)}.`
24
+ })
25
+ .optional(),
26
+ openInNewWindow: z.boolean().optional()
27
+ });
12
28
  class SpoNavigationNodeAddCommand extends SpoCommand {
13
29
  get name() {
14
30
  return commands.NAVIGATION_NODE_ADD;
@@ -16,134 +32,72 @@ class SpoNavigationNodeAddCommand extends SpoCommand {
16
32
  get description() {
17
33
  return 'Adds a navigation node to the specified site navigation';
18
34
  }
19
- constructor() {
20
- super();
21
- _SpoNavigationNodeAddCommand_instances.add(this);
22
- __classPrivateFieldGet(this, _SpoNavigationNodeAddCommand_instances, "m", _SpoNavigationNodeAddCommand_initTelemetry).call(this);
23
- __classPrivateFieldGet(this, _SpoNavigationNodeAddCommand_instances, "m", _SpoNavigationNodeAddCommand_initOptions).call(this);
24
- __classPrivateFieldGet(this, _SpoNavigationNodeAddCommand_instances, "m", _SpoNavigationNodeAddCommand_initValidators).call(this);
25
- __classPrivateFieldGet(this, _SpoNavigationNodeAddCommand_instances, "m", _SpoNavigationNodeAddCommand_initOptionSets).call(this);
35
+ get schema() {
36
+ return options;
37
+ }
38
+ getRefinedSchema(schema) {
39
+ return schema
40
+ .refine(options => [options.location, options.parentNodeId].filter(o => o !== undefined).length === 1, {
41
+ error: `Specify either 'location' or 'parentNodeId', but not both.`,
42
+ params: {
43
+ customCode: 'optionSet',
44
+ options: ['location', 'parentNodeId']
45
+ }
46
+ });
26
47
  }
27
48
  getExcludedOptionsWithUrls() {
28
49
  return ['url'];
29
50
  }
30
51
  async commandAction(logger, args) {
52
+ const { webUrl, location, parentNodeId, title, url, audienceIds, openInNewWindow } = args.options;
31
53
  if (this.verbose) {
32
54
  await logger.logToStderr(`Adding navigation node...`);
33
55
  }
34
- const nodesCollection = args.options.parentNodeId ?
35
- `GetNodeById(${args.options.parentNodeId})/Children` :
36
- args.options.location.toLowerCase();
37
- const requestOptions = {
38
- url: `${args.options.webUrl}/_api/web/navigation/${nodesCollection}`,
39
- headers: {
40
- accept: 'application/json;odata=nometadata',
41
- 'content-type': 'application/json;odata=nometadata'
42
- },
43
- responseType: 'json',
44
- data: {
45
- AudienceIds: args.options.audienceIds?.split(','),
46
- Title: args.options.title,
47
- Url: args.options.url ?? 'http://linkless.header/',
48
- IsExternal: args.options.isExternal === true
49
- }
50
- };
51
56
  try {
52
- const res = await request.post(requestOptions);
53
- if (args.options.openInNewWindow) {
54
- if (this.verbose) {
55
- await logger.logToStderr(`Making sure that the newly added navigation node opens in a new window.`);
56
- }
57
- const id = res.Id.toString();
58
- let menuState = args.options.location === 'TopNavigationBar' ? await spo.getTopNavigationMenuState(args.options.webUrl) : await spo.getQuickLaunchMenuState(args.options.webUrl);
59
- let menuStateItem = this.getMenuStateNode(menuState.Nodes, id);
60
- if (args.options.parentNodeId && !menuStateItem) {
61
- menuState = await spo.getTopNavigationMenuState(args.options.webUrl);
62
- menuStateItem = this.getMenuStateNode(menuState.Nodes, id);
63
- }
64
- menuStateItem.OpenInNewWindow = true;
65
- await spo.saveMenuState(args.options.webUrl, menuState);
57
+ let menuState;
58
+ let siblingNodes;
59
+ if (parentNodeId) {
60
+ const parent = await spo.getMenuStateNodeByKey(webUrl, parentNodeId.toString());
61
+ menuState = parent.menuState;
62
+ siblingNodes = parent.node.Nodes;
63
+ }
64
+ else {
65
+ menuState = location === 'TopNavigationBar'
66
+ ? await spo.getTopNavigationMenuState(webUrl)
67
+ : await spo.getQuickLaunchMenuState(webUrl);
68
+ siblingNodes = menuState.Nodes;
66
69
  }
67
- await logger.log(res);
70
+ const existingKeys = siblingNodes.map(node => node.Key);
71
+ const newNode = {
72
+ AudienceIds: audienceIds ? audienceIds.split(',') : [],
73
+ IsDeleted: false,
74
+ IsHidden: false,
75
+ Key: null,
76
+ Nodes: [],
77
+ NodeType: 0,
78
+ OpenInNewWindow: openInNewWindow ? true : null,
79
+ SimpleUrl: url ?? '',
80
+ Title: title
81
+ };
82
+ siblingNodes.push(newNode);
83
+ await spo.saveMenuState(webUrl, menuState);
84
+ if (this.verbose) {
85
+ await logger.logToStderr(`Retrieving the added navigation node...`);
86
+ }
87
+ const updatedMenuState = await spo.getMenuState(webUrl, menuState.StartingNodeKey);
88
+ const updatedSiblingNodes = parentNodeId
89
+ ? spo.findMenuStateNode(updatedMenuState.Nodes, parentNodeId.toString())?.Nodes
90
+ : updatedMenuState.Nodes;
91
+ const addedNode = updatedSiblingNodes?.find(node => !existingKeys.includes(node.Key) && node.Title === title);
92
+ if (!addedNode) {
93
+ throw `The navigation node was added, but it couldn't be retrieved.`;
94
+ }
95
+ await logger.log(addedNode);
68
96
  }
69
97
  catch (err) {
70
98
  this.handleRejectedODataJsonPromise(err);
71
99
  }
72
100
  }
73
- getMenuStateNode(nodes, id) {
74
- let menuNode = nodes.find((node) => node.Key !== null && node.Key === id);
75
- if (menuNode === undefined) {
76
- for (const node of nodes.filter(node => node.Nodes.length > 0)) {
77
- menuNode = this.getMenuStateNode(node.Nodes, id);
78
- if (menuNode) {
79
- break;
80
- }
81
- }
82
- }
83
- return menuNode;
84
- }
85
101
  }
86
- _SpoNavigationNodeAddCommand_instances = new WeakSet(), _SpoNavigationNodeAddCommand_initTelemetry = function _SpoNavigationNodeAddCommand_initTelemetry() {
87
- this.telemetry.push((args) => {
88
- Object.assign(this.telemetryProperties, {
89
- isExternal: args.options.isExternal,
90
- location: typeof args.options.location !== 'undefined',
91
- parentNodeId: typeof args.options.parentNodeId !== 'undefined',
92
- audienceIds: typeof args.options.audienceIds !== 'undefined',
93
- url: typeof args.options.url !== 'undefined',
94
- openInNewWindow: !!args.options.openInNewWindow
95
- });
96
- });
97
- }, _SpoNavigationNodeAddCommand_initOptions = function _SpoNavigationNodeAddCommand_initOptions() {
98
- this.options.unshift({
99
- option: '-u, --webUrl <webUrl>'
100
- }, {
101
- option: '-l, --location [location]',
102
- autocomplete: ['QuickLaunch', 'TopNavigationBar']
103
- }, {
104
- option: '-t, --title <title>'
105
- }, {
106
- option: '--url [url]'
107
- }, {
108
- option: '--parentNodeId [parentNodeId]'
109
- }, {
110
- option: '--isExternal'
111
- }, {
112
- option: '--audienceIds [audienceIds]'
113
- }, {
114
- option: '--openInNewWindow'
115
- });
116
- }, _SpoNavigationNodeAddCommand_initValidators = function _SpoNavigationNodeAddCommand_initValidators() {
117
- this.validators.push(async (args) => {
118
- const isValidSharePointUrl = validation.isValidSharePointUrl(args.options.webUrl);
119
- if (isValidSharePointUrl !== true) {
120
- return isValidSharePointUrl;
121
- }
122
- if (args.options.parentNodeId) {
123
- if (isNaN(args.options.parentNodeId)) {
124
- return `${args.options.parentNodeId} is not a number`;
125
- }
126
- }
127
- else {
128
- if (args.options.location !== 'QuickLaunch' &&
129
- args.options.location !== 'TopNavigationBar') {
130
- return `${args.options.location} is not a valid value for the location option. Allowed values are QuickLaunch|TopNavigationBar`;
131
- }
132
- }
133
- if (args.options.audienceIds) {
134
- const audienceIdsSplitted = args.options.audienceIds.split(',');
135
- if (audienceIdsSplitted.length > 10) {
136
- return 'The maximum amount of audienceIds per navigation node exceeded. The maximum amount of auciendeIds is 10.';
137
- }
138
- const isValidGUIDArrayResult = validation.isValidGuidArray(args.options.audienceIds);
139
- if (isValidGUIDArrayResult !== true) {
140
- return `The following GUIDs are invalid for the option 'audienceIds': ${isValidGUIDArrayResult}.`;
141
- }
142
- }
143
- return true;
144
- });
145
- }, _SpoNavigationNodeAddCommand_initOptionSets = function _SpoNavigationNodeAddCommand_initOptionSets() {
146
- this.optionSets.push({ options: ['location', 'parentNodeId'] });
147
- };
148
102
  export default new SpoNavigationNodeAddCommand();
149
103
  //# sourceMappingURL=navigation-node-add.js.map
@@ -1,6 +1,6 @@
1
1
  import { globalOptionsZod } from '../../../../Command.js';
2
2
  import { z } from 'zod';
3
- import request from '../../../../request.js';
3
+ import { spo } from '../../../../utils/spo.js';
4
4
  import { validation } from '../../../../utils/validation.js';
5
5
  import SpoCommand from '../../../base/SpoCommand.js';
6
6
  import commands from '../../commands.js';
@@ -11,6 +11,7 @@ export const options = z.strictObject({
11
11
  error: e => `'${e.input}' is not a valid SharePoint Online site URL.`
12
12
  })
13
13
  .alias('u'),
14
+ location: z.enum(['QuickLaunch', 'TopNavigationBar']).alias('l'),
14
15
  id: z.int().positive()
15
16
  });
16
17
  class SpoNavigationNodeGetCommand extends SpoCommand {
@@ -27,19 +28,9 @@ class SpoNavigationNodeGetCommand extends SpoCommand {
27
28
  if (this.verbose) {
28
29
  await logger.logToStderr(`Retrieving information about navigation node with id ${args.options.id}`);
29
30
  }
30
- const requestOptions = {
31
- url: `${args.options.webUrl}/_api/web/navigation/GetNodeById(${args.options.id})?$expand=Children,Children/Children,Children/Children/Children`,
32
- headers: {
33
- accept: 'application/json;odata=nometadata'
34
- },
35
- responseType: 'json'
36
- };
37
31
  try {
38
- const listInstance = await request.get(requestOptions);
39
- if (listInstance['odata.null']) {
40
- throw `No navigation node found with id ${args.options.id}.`;
41
- }
42
- await logger.log(listInstance);
32
+ const { node } = await spo.getMenuStateNodeByKey(args.options.webUrl, args.options.id.toString(), args.options.location);
33
+ await logger.log(node);
43
34
  }
44
35
  catch (err) {
45
36
  this.handleRejectedODataJsonPromise(err);
@@ -1,6 +1,6 @@
1
1
  import { globalOptionsZod } from '../../../../Command.js';
2
2
  import { z } from 'zod';
3
- import { odata } from '../../../../utils/odata.js';
3
+ import { spo } from '../../../../utils/spo.js';
4
4
  import { validation } from '../../../../utils/validation.js';
5
5
  import SpoCommand from '../../../base/SpoCommand.js';
6
6
  import commands from '../../commands.js';
@@ -21,7 +21,7 @@ class SpoNavigationNodeListCommand extends SpoCommand {
21
21
  return 'Lists nodes from the specified site navigation';
22
22
  }
23
23
  defaultProperties() {
24
- return ['Id', 'Title', 'Url'];
24
+ return ['Key', 'Title', 'SimpleUrl'];
25
25
  }
26
26
  get schema() {
27
27
  return options;
@@ -31,8 +31,10 @@ class SpoNavigationNodeListCommand extends SpoCommand {
31
31
  await logger.logToStderr(`Retrieving navigation nodes...`);
32
32
  }
33
33
  try {
34
- const res = await odata.getAllItems(`${args.options.webUrl}/_api/web/navigation/${args.options.location.toLowerCase()}?$expand=Children,Children/Children,Children/Children/Children`);
35
- await logger.log(res);
34
+ const menuState = args.options.location === 'TopNavigationBar'
35
+ ? await spo.getTopNavigationMenuState(args.options.webUrl)
36
+ : await spo.getQuickLaunchMenuState(args.options.webUrl);
37
+ await logger.log(menuState.Nodes);
36
38
  }
37
39
  catch (err) {
38
40
  this.handleRejectedODataJsonPromise(err);