@pnp/cli-microsoft365 5.5.0-beta.d1aff8a → 5.5.0-beta.f697eab

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 (68) hide show
  1. package/dist/Auth.js +2 -2
  2. package/dist/m365/aad/commands/o365group/o365group-recyclebinitem-restore.js +60 -9
  3. package/dist/m365/base/PowerAppsCommand.js +10 -0
  4. package/dist/m365/pa/commands/app/app-get.js +3 -5
  5. package/dist/m365/pa/commands/app/app-list.js +10 -9
  6. package/dist/m365/pa/commands/app/app-remove.js +3 -3
  7. package/dist/m365/pa/commands/connector/connector-export.js +3 -3
  8. package/dist/m365/pa/commands/connector/connector-list.js +10 -9
  9. package/dist/m365/pa/commands/environment/environment-get.js +3 -3
  10. package/dist/m365/pa/commands/environment/environment-list.js +4 -4
  11. package/dist/m365/planner/commands/bucket/bucket-add.js +17 -9
  12. package/dist/m365/planner/commands/bucket/bucket-get.js +19 -11
  13. package/dist/m365/planner/commands/bucket/bucket-list.js +17 -9
  14. package/dist/m365/planner/commands/bucket/bucket-remove.js +19 -11
  15. package/dist/m365/planner/commands/bucket/bucket-set.js +19 -11
  16. package/dist/m365/planner/commands/plan/plan-add.js +98 -5
  17. package/dist/m365/planner/commands/plan/plan-get.js +1 -1
  18. package/dist/m365/planner/commands/plan/plan-remove.js +1 -1
  19. package/dist/m365/planner/commands/task/task-add.js +15 -9
  20. package/dist/m365/planner/commands/task/task-get.js +14 -9
  21. package/dist/m365/planner/commands/task/task-list.js +19 -11
  22. package/dist/m365/planner/commands/task/task-remove.js +4 -19
  23. package/dist/m365/planner/commands/task/task-set.js +15 -9
  24. package/dist/m365/search/commands/externalconnection/externalconnection-get.js +69 -0
  25. package/dist/m365/search/commands.js +1 -0
  26. package/dist/m365/spo/base-permissions.js +9 -0
  27. package/dist/m365/spo/commands/field/field-set.js +16 -9
  28. package/dist/m365/spo/commands/group/group-add.js +96 -0
  29. package/dist/m365/spo/commands/group/group-set.js +167 -0
  30. package/dist/m365/spo/commands/hubsite/hubsite-get.js +99 -13
  31. package/dist/m365/spo/commands/listitem/listitem-get.js +9 -9
  32. package/dist/m365/spo/commands/listitem/listitem-list.js +5 -1
  33. package/dist/m365/spo/commands/roledefinition/RoleDefinition.js +3 -0
  34. package/dist/m365/spo/commands/roledefinition/RoleType.js +16 -0
  35. package/dist/m365/spo/commands/roledefinition/roledefinition-get.js +59 -0
  36. package/dist/m365/spo/commands/site/site-classic-list.js +1 -0
  37. package/dist/m365/spo/commands/site/site-list.js +59 -17
  38. package/dist/m365/spo/commands.js +3 -0
  39. package/dist/m365/teams/commands/team/team-archive.js +51 -15
  40. package/dist/m365/teams/commands/team/team-remove.js +47 -11
  41. package/dist/m365/teams/commands/team/team-unarchive.js +48 -12
  42. package/dist/utils/planner.js +6 -6
  43. package/docs/docs/cmd/aad/o365group/o365group-recyclebinitem-restore.md +21 -3
  44. package/docs/docs/cmd/planner/bucket/bucket-add.md +9 -6
  45. package/docs/docs/cmd/planner/bucket/bucket-get.md +10 -7
  46. package/docs/docs/cmd/planner/bucket/bucket-list.md +8 -5
  47. package/docs/docs/cmd/planner/bucket/bucket-remove.md +8 -5
  48. package/docs/docs/cmd/planner/bucket/bucket-set.md +9 -6
  49. package/docs/docs/cmd/planner/plan/plan-add.md +18 -2
  50. package/docs/docs/cmd/planner/task/task-add.md +11 -8
  51. package/docs/docs/cmd/planner/task/task-get.md +17 -8
  52. package/docs/docs/cmd/planner/task/task-list.md +9 -6
  53. package/docs/docs/cmd/planner/task/task-set.md +9 -6
  54. package/docs/docs/cmd/search/externalconnection/externalconnection-get.md +33 -0
  55. package/docs/docs/cmd/spo/field/field-set.md +7 -4
  56. package/docs/docs/cmd/spo/group/group-add.md +51 -0
  57. package/docs/docs/cmd/spo/group/group-set.md +69 -0
  58. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +39 -7
  59. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  60. package/docs/docs/cmd/spo/listitem/listitem-list.md +8 -0
  61. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +27 -0
  62. package/docs/docs/cmd/spo/site/site-classic-list.md +3 -0
  63. package/docs/docs/cmd/spo/site/site-list.md +19 -7
  64. package/docs/docs/cmd/teams/team/team-archive.md +20 -5
  65. package/docs/docs/cmd/teams/team/team-remove.md +19 -5
  66. package/docs/docs/cmd/teams/team/team-unarchive.md +18 -4
  67. package/npm-shrinkwrap.json +173 -158
  68. package/package.json +13 -13
@@ -16,6 +16,7 @@ class SpoFieldSetCommand extends SpoCommand_1.default {
16
16
  getTelemetryProperties(args) {
17
17
  const telemetryProps = super.getTelemetryProperties(args);
18
18
  telemetryProps.id = typeof args.options.id !== 'undefined';
19
+ telemetryProps.title = typeof args.options.title !== 'undefined';
19
20
  telemetryProps.name = typeof args.options.name !== 'undefined';
20
21
  telemetryProps.listId = typeof args.options.listId !== 'undefined';
21
22
  telemetryProps.listTitle = typeof args.options.listTitle !== 'undefined';
@@ -26,6 +27,9 @@ class SpoFieldSetCommand extends SpoCommand_1.default {
26
27
  return true;
27
28
  }
28
29
  commandAction(logger, args, cb) {
30
+ if (args.options.name) {
31
+ this.warn(logger, `Option 'name' is deprecated. Please use 'title' instead.`);
32
+ }
29
33
  let requestDigest = '';
30
34
  utils_1.spo
31
35
  .getRequestDigest(args.options.webUrl)
@@ -61,7 +65,7 @@ class SpoFieldSetCommand extends SpoCommand_1.default {
61
65
  // retrieve column CSOM object id
62
66
  const fieldQuery = args.options.id ?
63
67
  `<Method Id="663" ParentId="7" Name="GetById"><Parameters><Parameter Type="Guid">${utils_1.formatting.escapeXml(args.options.id)}</Parameter></Parameters></Method>` :
64
- `<Method Id="663" ParentId="7" Name="GetByInternalNameOrTitle"><Parameters><Parameter Type="String">${utils_1.formatting.escapeXml(args.options.name)}</Parameter></Parameters></Method>`;
68
+ `<Method Id="663" ParentId="7" Name="GetByInternalNameOrTitle"><Parameters><Parameter Type="String">${utils_1.formatting.escapeXml(args.options.name || args.options.title)}</Parameter></Parameters></Method>`;
65
69
  const requestOptions = {
66
70
  url: `${args.options.webUrl}/_vti_bin/client.svc/ProcessQuery`,
67
71
  headers: {
@@ -105,6 +109,7 @@ class SpoFieldSetCommand extends SpoCommand_1.default {
105
109
  'listTitle',
106
110
  'id',
107
111
  'name',
112
+ 'title',
108
113
  'updateExistingLists',
109
114
  'debug',
110
115
  'verbose',
@@ -116,6 +121,11 @@ class SpoFieldSetCommand extends SpoCommand_1.default {
116
121
  }).join('');
117
122
  return payload;
118
123
  }
124
+ optionSets() {
125
+ return [
126
+ ['id', 'title', 'name']
127
+ ];
128
+ }
119
129
  options() {
120
130
  const options = [
121
131
  {
@@ -128,10 +138,13 @@ class SpoFieldSetCommand extends SpoCommand_1.default {
128
138
  option: '--listTitle [listTitle]'
129
139
  },
130
140
  {
131
- option: '-i|--id [id]'
141
+ option: '-i, --id [id]'
132
142
  },
133
143
  {
134
- option: '-n|--name [name]'
144
+ option: '-n, --name [name]'
145
+ },
146
+ {
147
+ option: '-t, --title [title]'
135
148
  },
136
149
  {
137
150
  option: '--updateExistingLists'
@@ -152,12 +165,6 @@ class SpoFieldSetCommand extends SpoCommand_1.default {
152
165
  !utils_1.validation.isValidGuid(args.options.listId)) {
153
166
  return `${args.options.listId} in option listId is not a valid GUID`;
154
167
  }
155
- if (!args.options.id && !args.options.name) {
156
- return `Specify id or name`;
157
- }
158
- if (args.options.id && args.options.name) {
159
- return `Specify viewId or viewTitle but not both`;
160
- }
161
168
  if (args.options.id &&
162
169
  !utils_1.validation.isValidGuid(args.options.id)) {
163
170
  return `${args.options.id} in option id is not a valid GUID`;
@@ -0,0 +1,96 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const utils_1 = require("../../../../utils");
4
+ const request_1 = require("../../../../request");
5
+ const SpoCommand_1 = require("../../../base/SpoCommand");
6
+ const commands_1 = require("../../commands");
7
+ class SpoGroupAddCommand extends SpoCommand_1.default {
8
+ get name() {
9
+ return commands_1.default.GROUP_ADD;
10
+ }
11
+ get description() {
12
+ return 'Creates group in the specified site';
13
+ }
14
+ getTelemetryProperties(args) {
15
+ const telemetryProps = super.getTelemetryProperties(args);
16
+ telemetryProps.description = typeof args.options.description !== 'undefined';
17
+ telemetryProps.allowMembersEditMembership = typeof args.options.allowMembersEditMembership !== 'undefined';
18
+ telemetryProps.onlyAllowMembersViewMembership = typeof args.options.onlyAllowMembersViewMembership !== 'undefined';
19
+ telemetryProps.allowRequestToJoinLeave = typeof args.options.allowRequestToJoinLeave !== 'undefined';
20
+ telemetryProps.autoAcceptRequestToJoinLeave = typeof args.options.autoAcceptRequestToJoinLeave !== 'undefined';
21
+ telemetryProps.requestToJoinLeaveEmailSetting = typeof args.options.requestToJoinLeaveEmailSetting !== 'undefined';
22
+ return telemetryProps;
23
+ }
24
+ commandAction(logger, args, cb) {
25
+ const requestOptions = {
26
+ url: `${args.options.webUrl}/_api/web/sitegroups`,
27
+ headers: {
28
+ accept: 'application/json;odata=nometadata'
29
+ },
30
+ responseType: 'json',
31
+ data: {
32
+ Title: args.options.name,
33
+ Description: args.options.description,
34
+ AllowMembersEditMembership: args.options.allowMembersEditMembership,
35
+ OnlyAllowMembersViewMembership: args.options.onlyAllowMembersViewMembership,
36
+ AllowRequestToJoinLeave: args.options.allowRequestToJoinLeave,
37
+ AutoAcceptRequestToJoinLeave: args.options.autoAcceptRequestToJoinLeave,
38
+ RequestToJoinLeaveEmailSetting: args.options.requestToJoinLeaveEmailSetting
39
+ }
40
+ };
41
+ request_1.default
42
+ .post(requestOptions)
43
+ .then((response) => {
44
+ logger.log(response);
45
+ cb();
46
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
47
+ }
48
+ options() {
49
+ const options = [
50
+ {
51
+ option: '-u, --webUrl <webUrl>'
52
+ },
53
+ {
54
+ option: '-n, --name <name>'
55
+ },
56
+ {
57
+ option: '--description [description]'
58
+ },
59
+ {
60
+ option: '--allowMembersEditMembership [allowMembersEditMembership]'
61
+ },
62
+ {
63
+ option: '--onlyAllowMembersViewMembership [onlyAllowMembersViewMembership]'
64
+ },
65
+ {
66
+ option: '--allowRequestToJoinLeave [allowRequestToJoinLeave]'
67
+ },
68
+ {
69
+ option: '--autoAcceptRequestToJoinLeave [autoAcceptRequestToJoinLeave]'
70
+ },
71
+ {
72
+ option: '--requestToJoinLeaveEmailSetting [requestToJoinLeaveEmailSetting]'
73
+ }
74
+ ];
75
+ const parentOptions = super.options();
76
+ return options.concat(parentOptions);
77
+ }
78
+ validate(args) {
79
+ const isValidSharePointUrl = utils_1.validation.isValidSharePointUrl(args.options.webUrl);
80
+ if (isValidSharePointUrl !== true) {
81
+ return isValidSharePointUrl;
82
+ }
83
+ const booleanOptions = [
84
+ args.options.allowMembersEditMembership, args.options.onlyAllowMembersViewMembership,
85
+ args.options.allowRequestToJoinLeave, args.options.autoAcceptRequestToJoinLeave
86
+ ];
87
+ for (const option of booleanOptions) {
88
+ if (typeof option !== 'undefined' && !utils_1.validation.isValidBoolean(option)) {
89
+ return `Value '${option}' is not a valid boolean`;
90
+ }
91
+ }
92
+ return true;
93
+ }
94
+ }
95
+ module.exports = new SpoGroupAddCommand();
96
+ //# sourceMappingURL=group-add.js.map
@@ -0,0 +1,167 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const AadUserGetCommand = require("../../../aad/commands/user/user-get");
4
+ const cli_1 = require("../../../../cli");
5
+ const utils_1 = require("../../../../utils");
6
+ const request_1 = require("../../../../request");
7
+ const SpoCommand_1 = require("../../../base/SpoCommand");
8
+ const commands_1 = require("../../commands");
9
+ class SpoGroupSetCommand extends SpoCommand_1.default {
10
+ get name() {
11
+ return commands_1.default.GROUP_SET;
12
+ }
13
+ get description() {
14
+ return 'Updates a group in the specified site';
15
+ }
16
+ getTelemetryProperties(args) {
17
+ const telemetryProps = super.getTelemetryProperties(args);
18
+ telemetryProps.id = typeof args.options.id !== 'undefined';
19
+ telemetryProps.name = typeof args.options.name !== 'undefined';
20
+ telemetryProps.newName = typeof args.options.newName !== 'undefined';
21
+ telemetryProps.description = typeof args.options.description !== 'undefined';
22
+ telemetryProps.allowMembersEditMembership = typeof args.options.allowMembersEditMembership !== 'undefined';
23
+ telemetryProps.onlyAllowMembersViewMembership = typeof args.options.onlyAllowMembersViewMembership !== 'undefined';
24
+ telemetryProps.allowRequestToJoinLeave = typeof args.options.allowRequestToJoinLeave !== 'undefined';
25
+ telemetryProps.autoAcceptRequestToJoinLeave = typeof args.options.autoAcceptRequestToJoinLeave !== 'undefined';
26
+ telemetryProps.requestToJoinLeaveEmailSetting = typeof args.options.requestToJoinLeaveEmailSetting !== 'undefined';
27
+ telemetryProps.ownerEmail = typeof args.options.ownerEmail !== 'undefined';
28
+ telemetryProps.ownerUserName = typeof args.options.ownerUserName !== 'undefined';
29
+ return telemetryProps;
30
+ }
31
+ commandAction(logger, args, cb) {
32
+ const requestOptions = {
33
+ url: `${args.options.webUrl}/_api/web/sitegroups/${args.options.id ? `GetById(${args.options.id})` : `GetByName('${args.options.name}')`}`,
34
+ headers: {
35
+ accept: 'application/json;odata.metadata=none',
36
+ 'content-type': 'application/json'
37
+ },
38
+ responseType: 'json',
39
+ data: {
40
+ Title: args.options.newName,
41
+ Description: args.options.description,
42
+ AllowMembersEditMembership: args.options.allowMembersEditMembership,
43
+ OnlyAllowMembersViewMembership: args.options.onlyAllowMembersViewMembership,
44
+ AllowRequestToJoinLeave: args.options.allowRequestToJoinLeave,
45
+ AutoAcceptRequestToJoinLeave: args.options.autoAcceptRequestToJoinLeave,
46
+ RequestToJoinLeaveEmailSetting: args.options.requestToJoinLeaveEmailSetting
47
+ }
48
+ };
49
+ request_1.default
50
+ .patch(requestOptions)
51
+ .then(() => this.setGroupOwner(args.options))
52
+ .then(_ => cb(), (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
53
+ }
54
+ setGroupOwner(options) {
55
+ if (!options.ownerEmail && !options.ownerUserName) {
56
+ return Promise.resolve();
57
+ }
58
+ return this
59
+ .getOwnerId(options)
60
+ .then((ownerId) => {
61
+ const requestOptions = {
62
+ url: `${options.webUrl}/_api/web/sitegroups/${options.id ? `GetById(${options.id})` : `GetByName('${options.name}')`}/SetUserAsOwner(${ownerId})`,
63
+ headers: {
64
+ accept: 'application/json;odata.metadata=none',
65
+ 'content-type': 'application/json'
66
+ },
67
+ responseType: 'json'
68
+ };
69
+ return request_1.default.post(requestOptions);
70
+ });
71
+ }
72
+ getOwnerId(options) {
73
+ const cmdOptions = {
74
+ userName: options.ownerUserName,
75
+ email: options.ownerEmail,
76
+ output: 'json',
77
+ debug: options.debug,
78
+ verbose: options.verbose
79
+ };
80
+ return cli_1.Cli
81
+ .executeCommandWithOutput(AadUserGetCommand, { options: Object.assign(Object.assign({}, cmdOptions), { _: [] }) })
82
+ .then((output) => {
83
+ const getUserOutput = JSON.parse(output.stdout);
84
+ const requestOptions = {
85
+ url: `${options.webUrl}/_api/web/ensureUser('${getUserOutput.userPrincipalName}')?$select=Id`,
86
+ headers: {
87
+ accept: 'application/json',
88
+ 'content-type': 'application/json'
89
+ },
90
+ responseType: 'json'
91
+ };
92
+ return request_1.default.post(requestOptions);
93
+ })
94
+ .then((response) => response.Id);
95
+ }
96
+ options() {
97
+ const options = [
98
+ {
99
+ option: '-u, --webUrl <webUrl>'
100
+ },
101
+ {
102
+ option: '-i, --id [id]'
103
+ },
104
+ {
105
+ option: '-n, --name [name]'
106
+ },
107
+ {
108
+ option: '--newName [newName]'
109
+ },
110
+ {
111
+ option: '--description [description]'
112
+ },
113
+ {
114
+ option: '--allowMembersEditMembership [allowMembersEditMembership]'
115
+ },
116
+ {
117
+ option: '--onlyAllowMembersViewMembership [onlyAllowMembersViewMembership]'
118
+ },
119
+ {
120
+ option: '--allowRequestToJoinLeave [allowRequestToJoinLeave]'
121
+ },
122
+ {
123
+ option: '--autoAcceptRequestToJoinLeave [autoAcceptRequestToJoinLeave]'
124
+ },
125
+ {
126
+ option: '--requestToJoinLeaveEmailSetting [requestToJoinLeaveEmailSetting]'
127
+ },
128
+ {
129
+ option: '--ownerEmail [ownerEmail]'
130
+ },
131
+ {
132
+ option: '--ownerUserName [ownerUserName]'
133
+ }
134
+ ];
135
+ const parentOptions = super.options();
136
+ return options.concat(parentOptions);
137
+ }
138
+ optionSets() {
139
+ return [
140
+ ['id', 'name']
141
+ ];
142
+ }
143
+ validate(args) {
144
+ const isValidSharePointUrl = utils_1.validation.isValidSharePointUrl(args.options.webUrl);
145
+ if (isValidSharePointUrl !== true) {
146
+ return isValidSharePointUrl;
147
+ }
148
+ if (args.options.id && isNaN(args.options.id)) {
149
+ return `Specified id ${args.options.id} is not a number`;
150
+ }
151
+ if (args.options.ownerEmail && args.options.ownerUserName) {
152
+ return 'Specify either ownerEmail or ownerUserName but not both';
153
+ }
154
+ const booleanOptions = [
155
+ args.options.allowMembersEditMembership, args.options.onlyAllowMembersViewMembership,
156
+ args.options.allowRequestToJoinLeave, args.options.autoAcceptRequestToJoinLeave
157
+ ];
158
+ for (const option of booleanOptions) {
159
+ if (typeof option !== 'undefined' && !utils_1.validation.isValidBoolean(option)) {
160
+ return `Value '${option}' is not a valid boolean`;
161
+ }
162
+ }
163
+ return true;
164
+ }
165
+ }
166
+ module.exports = new SpoGroupSetCommand();
167
+ //# sourceMappingURL=group-set.js.map
@@ -1,9 +1,11 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ const cli_1 = require("../../../../cli");
3
4
  const request_1 = require("../../../../request");
4
5
  const utils_1 = require("../../../../utils");
5
6
  const SpoCommand_1 = require("../../../base/SpoCommand");
6
7
  const commands_1 = require("../../commands");
8
+ const SpoListItemListCommand = require("../listitem/listitem-list");
7
9
  class SpoHubSiteGetCommand extends SpoCommand_1.default {
8
10
  get name() {
9
11
  return commands_1.default.HUBSITE_GET;
@@ -11,37 +13,121 @@ class SpoHubSiteGetCommand extends SpoCommand_1.default {
11
13
  get description() {
12
14
  return 'Gets information about the specified hub site';
13
15
  }
16
+ getTelemetryProperties(args) {
17
+ const telemetryProps = super.getTelemetryProperties(args);
18
+ telemetryProps.id = typeof args.options.id !== 'undefined';
19
+ telemetryProps.title = typeof args.options.title !== 'undefined';
20
+ telemetryProps.url = typeof args.options.url !== 'undefined';
21
+ telemetryProps.includeAssociatedSites = args.options.includeAssociatedSites === true;
22
+ return telemetryProps;
23
+ }
24
+ getAssociatedSites(spoAdminUrl, hubSiteId, logger, args) {
25
+ const options = {
26
+ output: 'json',
27
+ debug: args.options.debug,
28
+ verbose: args.options.verbose,
29
+ listTitle: 'DO_NOT_DELETE_SPLIST_TENANTADMIN_AGGREGATED_SITECOLLECTIONS',
30
+ webUrl: spoAdminUrl,
31
+ filter: `HubSiteId eq '${hubSiteId}'`,
32
+ fields: 'Title,SiteUrl,SiteId'
33
+ };
34
+ return cli_1.Cli
35
+ .executeCommandWithOutput(SpoListItemListCommand, { options: Object.assign(Object.assign({}, options), { _: [] }) });
36
+ }
14
37
  commandAction(logger, args, cb) {
38
+ let hubSite;
15
39
  utils_1.spo
16
40
  .getSpoUrl(logger, this.debug)
17
41
  .then((spoUrl) => {
18
- const requestOptions = {
19
- url: `${spoUrl}/_api/hubsites/getbyid('${encodeURIComponent(args.options.id)}')`,
20
- headers: {
21
- accept: 'application/json;odata=nometadata'
22
- },
23
- responseType: 'json'
24
- };
25
- return request_1.default.get(requestOptions);
42
+ if (args.options.id) {
43
+ return this.getHubSiteById(spoUrl, args.options);
44
+ }
45
+ else {
46
+ return this.getHubSite(spoUrl, args.options);
47
+ }
26
48
  })
27
49
  .then((res) => {
28
- logger.log(res);
50
+ hubSite = res;
51
+ if (args.options.includeAssociatedSites && (args.options.output && args.options.output !== 'json')) {
52
+ throw Error('includeAssociatedSites option is only allowed with json output mode');
53
+ }
54
+ if (args.options.includeAssociatedSites !== true || args.options.output && args.options.output !== 'json') {
55
+ return Promise.resolve();
56
+ }
57
+ return utils_1.spo
58
+ .getSpoAdminUrl(logger, this.debug)
59
+ .then((spoAdminUrl) => {
60
+ return this.getAssociatedSites(spoAdminUrl, hubSite.SiteId, logger, args);
61
+ });
62
+ })
63
+ .then((associatedSitesCommandOutput) => {
64
+ if (args.options.includeAssociatedSites) {
65
+ const associatedSites = JSON.parse(associatedSitesCommandOutput.stdout);
66
+ hubSite.AssociatedSites = associatedSites.filter(s => s.SiteId !== hubSite.SiteId);
67
+ }
68
+ logger.log(hubSite);
29
69
  cb();
30
70
  }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
31
71
  }
72
+ getHubSiteById(spoUrl, options) {
73
+ const requestOptions = {
74
+ url: `${spoUrl}/_api/hubsites/getbyid('${options.id}')`,
75
+ headers: {
76
+ accept: 'application/json;odata=nometadata'
77
+ },
78
+ responseType: 'json'
79
+ };
80
+ return request_1.default.get(requestOptions);
81
+ }
82
+ getHubSite(spoUrl, options) {
83
+ const requestOptions = {
84
+ url: `${spoUrl}/_api/hubsites`,
85
+ headers: {
86
+ accept: 'application/json;odata=nometadata'
87
+ },
88
+ responseType: 'json'
89
+ };
90
+ return request_1.default
91
+ .get(requestOptions)
92
+ .then((response) => {
93
+ let hubSites = response.value;
94
+ if (options.title) {
95
+ hubSites = hubSites.filter(site => site.Title.toLocaleLowerCase() === options.title.toLocaleLowerCase());
96
+ }
97
+ else if (options.url) {
98
+ hubSites = hubSites.filter(site => site.SiteUrl.toLocaleLowerCase() === options.url.toLocaleLowerCase());
99
+ }
100
+ if (hubSites.length === 0) {
101
+ return Promise.reject(`The specified hub site ${options.title || options.url} does not exist`);
102
+ }
103
+ if (hubSites.length > 1) {
104
+ return Promise.reject(`Multiple hub sites with ${options.title || options.url} found. Please disambiguate: ${hubSites.map(site => site.SiteUrl).join(', ')}`);
105
+ }
106
+ return hubSites[0];
107
+ });
108
+ }
32
109
  options() {
33
110
  const options = [
34
- {
35
- option: '-i, --id <id>'
36
- }
111
+ { option: '-i, --id [id]' },
112
+ { option: '-t, --title [title]' },
113
+ { option: '-u, --url [url]' },
114
+ { option: '--includeAssociatedSites' }
37
115
  ];
38
116
  const parentOptions = super.options();
39
117
  return options.concat(parentOptions);
40
118
  }
119
+ optionSets() {
120
+ return [
121
+ ['id', 'title', 'url']
122
+ ];
123
+ }
41
124
  validate(args) {
42
- if (!utils_1.validation.isValidGuid(args.options.id)) {
125
+ if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
43
126
  return `${args.options.id} is not a valid GUID`;
44
127
  }
128
+ if (args.options.url) {
129
+ return utils_1.validation.isValidSharePointUrl(args.options.url);
130
+ }
45
131
  return true;
46
132
  }
47
133
  }
@@ -24,15 +24,15 @@ class SpoListItemGetCommand extends SpoCommand_1.default {
24
24
  const listIdArgument = args.options.listId || '';
25
25
  const listTitleArgument = args.options.listTitle || '';
26
26
  const listRestUrl = (args.options.listId ?
27
- `${args.options.webUrl}/_api/web/lists(guid'${utils_1.formatting.encodeQueryParameter(listIdArgument)}')`
28
- : `${args.options.webUrl}/_api/web/lists/getByTitle('${utils_1.formatting.encodeQueryParameter(listTitleArgument)}')`);
29
- const propertiesSelect = args.options.properties ?
30
- `?$select=${encodeURIComponent(args.options.properties)}` :
31
- ((!args.options.output || args.options.output === 'text') ?
32
- `?$select=Id,Title` :
33
- ``);
27
+ `${args.options.webUrl}/_api/web/lists(guid'${utils_1.formatting.encodeQueryParameter(listIdArgument)}')` :
28
+ `${args.options.webUrl}/_api/web/lists/getByTitle('${utils_1.formatting.encodeQueryParameter(listTitleArgument)}')`);
29
+ const propertiesSelect = args.options.properties ? args.options.properties.split(',') : [];
30
+ const propertiesWithSlash = propertiesSelect.filter(item => item.includes('/'));
31
+ const propertiesToExpand = propertiesWithSlash.map(e => e.split('/')[0]);
32
+ const expandPropertiesArray = propertiesToExpand.filter((item, pos) => propertiesToExpand.indexOf(item) === pos);
33
+ const fieldExpand = expandPropertiesArray.length > 0 ? `&$expand=${expandPropertiesArray.join(",")}` : ``;
34
34
  const requestOptions = {
35
- url: `${listRestUrl}/items(${args.options.id})${propertiesSelect}`,
35
+ url: `${listRestUrl}/items(${args.options.id})?$select=${encodeURIComponent(propertiesSelect.join(","))}${fieldExpand}`,
36
36
  headers: {
37
37
  'accept': 'application/json;odata=nometadata'
38
38
  },
@@ -41,7 +41,7 @@ class SpoListItemGetCommand extends SpoCommand_1.default {
41
41
  request_1.default
42
42
  .get(requestOptions)
43
43
  .then((response) => {
44
- delete response["ID"];
44
+ delete response['ID'];
45
45
  logger.log(response);
46
46
  cb();
47
47
  }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
@@ -36,6 +36,9 @@ class SpoListItemListCommand extends SpoCommand_1.default {
36
36
  let formDigestValue = '';
37
37
  const fieldsArray = args.options.fields ? args.options.fields.split(",")
38
38
  : (!args.options.output || args.options.output === "text") ? ["Title", "Id"] : [];
39
+ const fieldsWithSlash = fieldsArray.filter(item => item.includes('/'));
40
+ const fieldsToExpand = fieldsWithSlash.map(e => e.split('/')[0]);
41
+ const expandFieldsArray = fieldsToExpand.filter((item, pos) => fieldsToExpand.indexOf(item) === pos);
39
42
  const listRestUrl = listIdArgument ?
40
43
  `${args.options.webUrl}/_api/web/lists(guid'${utils_1.formatting.encodeQueryParameter(listIdArgument)}')`
41
44
  : `${args.options.webUrl}/_api/web/lists/getByTitle('${utils_1.formatting.encodeQueryParameter(listTitleArgument)}')`;
@@ -75,8 +78,9 @@ class SpoListItemListCommand extends SpoCommand_1.default {
75
78
  const skipToken = (args.options.pageNumber && Number(args.options.pageNumber) > 0 && skipTokenId > 0) ? `$skiptoken=Paged=TRUE%26p_ID=${res.value[res.value.length - 1].Id}` : ``;
76
79
  const rowLimit = args.options.pageSize ? `$top=${args.options.pageSize}` : ``;
77
80
  const filter = args.options.filter ? `$filter=${encodeURIComponent(args.options.filter)}` : ``;
81
+ const fieldExpand = expandFieldsArray.length > 0 ? `&$expand=${expandFieldsArray.join(",")}` : ``;
78
82
  const fieldSelect = fieldsArray.length > 0 ?
79
- `?$select=${encodeURIComponent(fieldsArray.join(","))}&${rowLimit}&${skipToken}&${filter}` :
83
+ `?$select=${encodeURIComponent(fieldsArray.join(","))}${fieldExpand}&${rowLimit}&${skipToken}&${filter}` :
80
84
  `?${rowLimit}&${skipToken}&${filter}`;
81
85
  const requestBody = args.options.camlQuery ?
82
86
  {
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=RoleDefinition.js.map
@@ -0,0 +1,16 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.RoleType = void 0;
4
+ var RoleType;
5
+ (function (RoleType) {
6
+ RoleType[RoleType["None"] = 0] = "None";
7
+ RoleType[RoleType["Guest"] = 1] = "Guest";
8
+ RoleType[RoleType["Reader"] = 2] = "Reader";
9
+ RoleType[RoleType["Contributor"] = 3] = "Contributor";
10
+ RoleType[RoleType["WebDesigner"] = 4] = "WebDesigner";
11
+ RoleType[RoleType["Administrator"] = 5] = "Administrator";
12
+ RoleType[RoleType["Editor"] = 6] = "Editor";
13
+ RoleType[RoleType["Reviewer"] = 7] = "Reviewer";
14
+ RoleType[RoleType["System"] = 8] = "System";
15
+ })(RoleType = exports.RoleType || (exports.RoleType = {}));
16
+ //# sourceMappingURL=RoleType.js.map
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const request_1 = require("../../../../request");
4
+ const utils_1 = require("../../../../utils");
5
+ const SpoCommand_1 = require("../../../base/SpoCommand");
6
+ const base_permissions_1 = require("../../base-permissions");
7
+ const commands_1 = require("../../commands");
8
+ const RoleType_1 = require("./RoleType");
9
+ class SpoRoleDefinitionGetCommand extends SpoCommand_1.default {
10
+ get name() {
11
+ return commands_1.default.ROLEDEFINITION_GET;
12
+ }
13
+ get description() {
14
+ return 'Gets specified role definition from web by id';
15
+ }
16
+ commandAction(logger, args, cb) {
17
+ if (this.verbose) {
18
+ logger.logToStderr(`Getting role definition from ${args.options.webUrl}...`);
19
+ }
20
+ const requestOptions = {
21
+ url: `${args.options.webUrl}/_api/web/roledefinitions(${args.options.id})`,
22
+ headers: {
23
+ 'accept': 'application/json;odata=nometadata'
24
+ },
25
+ responseType: 'json'
26
+ };
27
+ request_1.default
28
+ .get(requestOptions)
29
+ .then((response) => {
30
+ const permissions = new base_permissions_1.BasePermissions();
31
+ permissions.high = response.BasePermissions.High;
32
+ permissions.low = response.BasePermissions.Low;
33
+ response.BasePermissionsValue = permissions.parse();
34
+ response.RoleTypeKindValue = RoleType_1.RoleType[response.RoleTypeKind];
35
+ logger.log(response);
36
+ cb();
37
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
38
+ }
39
+ options() {
40
+ const options = [
41
+ {
42
+ option: '-u, --webUrl <webUrl>'
43
+ },
44
+ {
45
+ option: '-i, --id <id>'
46
+ }
47
+ ];
48
+ const parentOptions = super.options();
49
+ return options.concat(parentOptions);
50
+ }
51
+ validate(args) {
52
+ if (isNaN(args.options.id)) {
53
+ return `${args.options.id} is not a number`;
54
+ }
55
+ return utils_1.validation.isValidSharePointUrl(args.options.webUrl);
56
+ }
57
+ }
58
+ module.exports = new SpoRoleDefinitionGetCommand();
59
+ //# sourceMappingURL=roledefinition-get.js.map
@@ -23,6 +23,7 @@ class SpoSiteClassicListCommand extends SpoCommand_1.default {
23
23
  return ['Title', 'Url'];
24
24
  }
25
25
  commandAction(logger, args, cb) {
26
+ this.showDeprecationWarning(logger, commands_1.default.SITE_CLASSIC_LIST, commands_1.default.SITE_LIST);
26
27
  const webTemplate = args.options.webTemplate || '';
27
28
  const includeOneDriveSites = args.options.includeOneDriveSites || false;
28
29
  const personalSite = includeOneDriveSites === false ? '0' : '1';