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

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 (55) hide show
  1. package/dist/Auth.js +2 -2
  2. package/dist/m365/base/PowerAppsCommand.js +10 -0
  3. package/dist/m365/pa/commands/app/app-get.js +3 -5
  4. package/dist/m365/pa/commands/app/app-list.js +10 -9
  5. package/dist/m365/pa/commands/app/app-remove.js +3 -3
  6. package/dist/m365/pa/commands/connector/connector-export.js +3 -3
  7. package/dist/m365/pa/commands/connector/connector-list.js +10 -9
  8. package/dist/m365/pa/commands/environment/environment-get.js +3 -3
  9. package/dist/m365/pa/commands/environment/environment-list.js +4 -4
  10. package/dist/m365/planner/commands/bucket/bucket-add.js +17 -9
  11. package/dist/m365/planner/commands/bucket/bucket-get.js +19 -11
  12. package/dist/m365/planner/commands/bucket/bucket-list.js +17 -9
  13. package/dist/m365/planner/commands/bucket/bucket-remove.js +19 -11
  14. package/dist/m365/planner/commands/bucket/bucket-set.js +19 -11
  15. package/dist/m365/planner/commands/plan/plan-add.js +98 -5
  16. package/dist/m365/planner/commands/plan/plan-get.js +1 -1
  17. package/dist/m365/planner/commands/plan/plan-remove.js +1 -1
  18. package/dist/m365/planner/commands/task/task-add.js +15 -9
  19. package/dist/m365/planner/commands/task/task-get.js +14 -9
  20. package/dist/m365/planner/commands/task/task-list.js +19 -11
  21. package/dist/m365/planner/commands/task/task-remove.js +4 -19
  22. package/dist/m365/planner/commands/task/task-set.js +15 -9
  23. package/dist/m365/search/commands/externalconnection/externalconnection-get.js +69 -0
  24. package/dist/m365/search/commands.js +1 -0
  25. package/dist/m365/spo/base-permissions.js +9 -0
  26. package/dist/m365/spo/commands/hubsite/hubsite-get.js +62 -12
  27. package/dist/m365/spo/commands/listitem/listitem-get.js +9 -9
  28. package/dist/m365/spo/commands/listitem/listitem-list.js +5 -1
  29. package/dist/m365/spo/commands/roledefinition/RoleDefinition.js +3 -0
  30. package/dist/m365/spo/commands/roledefinition/RoleType.js +16 -0
  31. package/dist/m365/spo/commands/roledefinition/roledefinition-get.js +59 -0
  32. package/dist/m365/spo/commands.js +1 -0
  33. package/dist/m365/teams/commands/team/team-archive.js +51 -15
  34. package/dist/m365/teams/commands/team/team-remove.js +47 -11
  35. package/dist/m365/teams/commands/team/team-unarchive.js +48 -12
  36. package/dist/utils/planner.js +6 -6
  37. package/docs/docs/cmd/planner/bucket/bucket-add.md +9 -6
  38. package/docs/docs/cmd/planner/bucket/bucket-get.md +10 -7
  39. package/docs/docs/cmd/planner/bucket/bucket-list.md +8 -5
  40. package/docs/docs/cmd/planner/bucket/bucket-remove.md +8 -5
  41. package/docs/docs/cmd/planner/bucket/bucket-set.md +9 -6
  42. package/docs/docs/cmd/planner/plan/plan-add.md +18 -2
  43. package/docs/docs/cmd/planner/task/task-add.md +11 -8
  44. package/docs/docs/cmd/planner/task/task-get.md +17 -8
  45. package/docs/docs/cmd/planner/task/task-list.md +9 -6
  46. package/docs/docs/cmd/planner/task/task-set.md +9 -6
  47. package/docs/docs/cmd/search/externalconnection/externalconnection-get.md +33 -0
  48. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +19 -8
  49. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  50. package/docs/docs/cmd/spo/listitem/listitem-list.md +8 -0
  51. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +27 -0
  52. package/docs/docs/cmd/teams/team/team-archive.md +20 -5
  53. package/docs/docs/cmd/teams/team/team-remove.md +19 -5
  54. package/docs/docs/cmd/teams/team/team-unarchive.md +18 -4
  55. package/package.json +1 -1
@@ -11,37 +11,87 @@ class SpoHubSiteGetCommand extends SpoCommand_1.default {
11
11
  get description() {
12
12
  return 'Gets information about the specified hub site';
13
13
  }
14
+ getTelemetryProperties(args) {
15
+ const telemetryProps = super.getTelemetryProperties(args);
16
+ telemetryProps.id = typeof args.options.id !== 'undefined';
17
+ telemetryProps.title = typeof args.options.title !== 'undefined';
18
+ telemetryProps.url = typeof args.options.url !== 'undefined';
19
+ return telemetryProps;
20
+ }
14
21
  commandAction(logger, args, cb) {
15
22
  utils_1.spo
16
23
  .getSpoUrl(logger, this.debug)
17
24
  .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);
25
+ if (args.options.id) {
26
+ return this.getHubSiteById(spoUrl, args.options);
27
+ }
28
+ else {
29
+ return this.getHubSite(spoUrl, args.options);
30
+ }
26
31
  })
27
32
  .then((res) => {
28
33
  logger.log(res);
29
34
  cb();
30
35
  }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
31
36
  }
37
+ getHubSiteById(spoUrl, options) {
38
+ const requestOptions = {
39
+ url: `${spoUrl}/_api/hubsites/getbyid('${options.id}')`,
40
+ headers: {
41
+ accept: 'application/json;odata=nometadata'
42
+ },
43
+ responseType: 'json'
44
+ };
45
+ return request_1.default.get(requestOptions);
46
+ }
47
+ getHubSite(spoUrl, options) {
48
+ const requestOptions = {
49
+ url: `${spoUrl}/_api/hubsites`,
50
+ headers: {
51
+ accept: 'application/json;odata=nometadata'
52
+ },
53
+ responseType: 'json'
54
+ };
55
+ return request_1.default
56
+ .get(requestOptions)
57
+ .then((response) => {
58
+ let hubSites = response.value;
59
+ if (options.title) {
60
+ hubSites = hubSites.filter(site => site.Title.toLocaleLowerCase() === options.title.toLocaleLowerCase());
61
+ }
62
+ else if (options.url) {
63
+ hubSites = hubSites.filter(site => site.SiteUrl.toLocaleLowerCase() === options.url.toLocaleLowerCase());
64
+ }
65
+ if (hubSites.length === 0) {
66
+ return Promise.reject(`The specified hub site ${options.title || options.url} does not exist`);
67
+ }
68
+ if (hubSites.length > 1) {
69
+ return Promise.reject(`Multiple hub sites with ${options.title || options.url} found. Please disambiguate: ${hubSites.map(site => site.SiteUrl).join(', ')}`);
70
+ }
71
+ return hubSites[0];
72
+ });
73
+ }
32
74
  options() {
33
75
  const options = [
34
- {
35
- option: '-i, --id <id>'
36
- }
76
+ { option: '-i, --id [id]' },
77
+ { option: '-t, --title [title]' },
78
+ { option: '-u, --url [url]' }
37
79
  ];
38
80
  const parentOptions = super.options();
39
81
  return options.concat(parentOptions);
40
82
  }
83
+ optionSets() {
84
+ return [
85
+ ['id', 'title', 'url']
86
+ ];
87
+ }
41
88
  validate(args) {
42
- if (!utils_1.validation.isValidGuid(args.options.id)) {
89
+ if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
43
90
  return `${args.options.id} is not a valid GUID`;
44
91
  }
92
+ if (args.options.url) {
93
+ return utils_1.validation.isValidSharePointUrl(args.options.url);
94
+ }
45
95
  return true;
46
96
  }
47
97
  }
@@ -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
@@ -167,6 +167,7 @@ exports.default = {
167
167
  REPORT_SITEUSAGEPAGES: `${prefix} report siteusagepages`,
168
168
  REPORT_SITEUSAGESITECOUNTS: `${prefix} report siteusagesitecounts`,
169
169
  REPORT_SITEUSAGESTORAGE: `${prefix} report siteusagestorage`,
170
+ ROLEDEFINITION_GET: `${prefix} roledefinition get`,
170
171
  ROLEDEFINITION_LIST: `${prefix} roledefinition list`,
171
172
  ROLEDEFINITION_REMOVE: `${prefix} roledefinition remove`,
172
173
  SEARCH: `${prefix} search`,
@@ -2,6 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const request_1 = require("../../../../request");
4
4
  const utils_1 = require("../../../../utils");
5
+ const aadGroup_1 = require("../../../../utils/aadGroup");
5
6
  const GraphCommand_1 = require("../../../base/GraphCommand");
6
7
  const commands_1 = require("../../commands");
7
8
  class TeamsTeamArchiveCommand extends GraphCommand_1.default {
@@ -16,27 +17,53 @@ class TeamsTeamArchiveCommand extends GraphCommand_1.default {
16
17
  telemetryProps.shouldSetSpoSiteReadOnlyForMembers = args.options.shouldSetSpoSiteReadOnlyForMembers === true;
17
18
  return telemetryProps;
18
19
  }
20
+ getTeamId(args) {
21
+ if (args.options.id) {
22
+ return Promise.resolve(args.options.id);
23
+ }
24
+ return aadGroup_1.aadGroup
25
+ .getGroupByDisplayName(args.options.name)
26
+ .then(group => {
27
+ if (group.resourceProvisioningOptions.indexOf('Team') === -1) {
28
+ return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
29
+ }
30
+ return group.id;
31
+ });
32
+ }
19
33
  commandAction(logger, args, cb) {
34
+ if (args.options.teamId) {
35
+ args.options.id = args.options.teamId;
36
+ this.warn(logger, `Option 'teamId' is deprecated. Please use 'id' instead.`);
37
+ }
20
38
  const siteReadOnlyForMembers = args.options.shouldSetSpoSiteReadOnlyForMembers === true;
21
- const requestOptions = {
22
- url: `${this.resource}/v1.0/teams/${encodeURIComponent(args.options.teamId)}/archive`,
23
- headers: {
24
- 'content-type': 'application/json;odata=nometadata',
25
- 'accept': 'application/json;odata.metadata=none'
26
- },
27
- responseType: 'json',
28
- data: {
29
- shouldSetSpoSiteReadOnlyForMembers: siteReadOnlyForMembers
30
- }
31
- };
32
- request_1.default
33
- .post(requestOptions)
39
+ this
40
+ .getTeamId(args)
41
+ .then((teamId) => {
42
+ const requestOptions = {
43
+ url: `${this.resource}/v1.0/teams/${encodeURIComponent(teamId)}/archive`,
44
+ headers: {
45
+ 'content-type': 'application/json;odata=nometadata',
46
+ 'accept': 'application/json;odata.metadata=none'
47
+ },
48
+ responseType: 'json',
49
+ data: {
50
+ shouldSetSpoSiteReadOnlyForMembers: siteReadOnlyForMembers
51
+ }
52
+ };
53
+ return request_1.default.post(requestOptions);
54
+ })
34
55
  .then(_ => cb(), (res) => this.handleRejectedODataJsonPromise(res, logger, cb));
35
56
  }
36
57
  options() {
37
58
  const options = [
38
59
  {
39
- option: '-i, --teamId <teamId>'
60
+ option: '-i, --id [id]'
61
+ },
62
+ {
63
+ option: '-n, --name [name]'
64
+ },
65
+ {
66
+ option: '--teamId [teamId]'
40
67
  },
41
68
  {
42
69
  option: '--shouldSetSpoSiteReadOnlyForMembers'
@@ -46,9 +73,18 @@ class TeamsTeamArchiveCommand extends GraphCommand_1.default {
46
73
  return options.concat(parentOptions);
47
74
  }
48
75
  validate(args) {
49
- if (!utils_1.validation.isValidGuid(args.options.teamId)) {
76
+ if (!args.options.id && !args.options.name && !args.options.teamId) {
77
+ return 'Specify either id or name';
78
+ }
79
+ if (args.options.name && (args.options.id || args.options.teamId)) {
80
+ return 'Specify either id or name but not both';
81
+ }
82
+ if (args.options.teamId && !utils_1.validation.isValidGuid(args.options.teamId)) {
50
83
  return `${args.options.teamId} is not a valid GUID`;
51
84
  }
85
+ if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
86
+ return `${args.options.id} is not a valid GUID`;
87
+ }
52
88
  return true;
53
89
  }
54
90
  }
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const cli_1 = require("../../../../cli");
4
4
  const request_1 = require("../../../../request");
5
5
  const utils_1 = require("../../../../utils");
6
+ const aadGroup_1 = require("../../../../utils/aadGroup");
6
7
  const GraphCommand_1 = require("../../../base/GraphCommand");
7
8
  const commands_1 = require("../../commands");
8
9
  class TeamsTeamRemoveCommand extends GraphCommand_1.default {
@@ -17,17 +18,37 @@ class TeamsTeamRemoveCommand extends GraphCommand_1.default {
17
18
  telemetryProps.confirm = (!(!args.options.confirm)).toString();
18
19
  return telemetryProps;
19
20
  }
21
+ getTeamId(args) {
22
+ if (args.options.id) {
23
+ return Promise.resolve(args.options.id);
24
+ }
25
+ return aadGroup_1.aadGroup
26
+ .getGroupByDisplayName(args.options.name)
27
+ .then(group => {
28
+ if (group.resourceProvisioningOptions.indexOf('Team') === -1) {
29
+ return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
30
+ }
31
+ return group.id;
32
+ });
33
+ }
20
34
  commandAction(logger, args, cb) {
35
+ if (args.options.teamId) {
36
+ args.options.id = args.options.teamId;
37
+ this.warn(logger, `Option 'teamId' is deprecated. Please use 'id' instead.`);
38
+ }
21
39
  const removeTeam = () => {
22
- const requestOptions = {
23
- url: `${this.resource}/v1.0/groups/${encodeURIComponent(args.options.teamId)}`,
24
- headers: {
25
- accept: 'application/json;odata.metadata=none'
26
- },
27
- responseType: 'json'
28
- };
29
- request_1.default
30
- .delete(requestOptions)
40
+ this
41
+ .getTeamId(args)
42
+ .then((teamId) => {
43
+ const requestOptions = {
44
+ url: `${this.resource}/v1.0/groups/${encodeURIComponent(teamId)}`,
45
+ headers: {
46
+ accept: 'application/json;odata.metadata=none'
47
+ },
48
+ responseType: 'json'
49
+ };
50
+ return request_1.default.delete(requestOptions);
51
+ })
31
52
  .then(_ => cb(), (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
32
53
  };
33
54
  if (args.options.confirm) {
@@ -52,7 +73,13 @@ class TeamsTeamRemoveCommand extends GraphCommand_1.default {
52
73
  options() {
53
74
  const options = [
54
75
  {
55
- option: '-i, --teamId <teamId>'
76
+ option: '-i, --id [id]'
77
+ },
78
+ {
79
+ option: '-n, --name [name]'
80
+ },
81
+ {
82
+ option: '--teamId [teamId]'
56
83
  },
57
84
  {
58
85
  option: '--confirm'
@@ -62,9 +89,18 @@ class TeamsTeamRemoveCommand extends GraphCommand_1.default {
62
89
  return options.concat(parentOptions);
63
90
  }
64
91
  validate(args) {
65
- if (!utils_1.validation.isValidGuid(args.options.teamId)) {
92
+ if (!args.options.id && !args.options.name && !args.options.teamId) {
93
+ return 'Specify either id or name';
94
+ }
95
+ if (args.options.name && (args.options.id || args.options.teamId)) {
96
+ return 'Specify either id or name but not both';
97
+ }
98
+ if (args.options.teamId && !utils_1.validation.isValidGuid(args.options.teamId)) {
66
99
  return `${args.options.teamId} is not a valid GUID`;
67
100
  }
101
+ if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
102
+ return `${args.options.id} is not a valid GUID`;
103
+ }
68
104
  return true;
69
105
  }
70
106
  }
@@ -2,6 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const request_1 = require("../../../../request");
4
4
  const utils_1 = require("../../../../utils");
5
+ const aadGroup_1 = require("../../../../utils/aadGroup");
5
6
  const GraphCommand_1 = require("../../../base/GraphCommand");
6
7
  const commands_1 = require("../../commands");
7
8
  class TeamsTeamUnarchiveCommand extends GraphCommand_1.default {
@@ -11,33 +12,68 @@ class TeamsTeamUnarchiveCommand extends GraphCommand_1.default {
11
12
  get description() {
12
13
  return 'Restores an archived Microsoft Teams team';
13
14
  }
15
+ getTeamId(args) {
16
+ if (args.options.id) {
17
+ return Promise.resolve(args.options.id);
18
+ }
19
+ return aadGroup_1.aadGroup
20
+ .getGroupByDisplayName(args.options.name)
21
+ .then(group => {
22
+ if (group.resourceProvisioningOptions.indexOf('Team') === -1) {
23
+ return Promise.reject(`The specified team does not exist in the Microsoft Teams`);
24
+ }
25
+ return group.id;
26
+ });
27
+ }
14
28
  commandAction(logger, args, cb) {
29
+ if (args.options.teamId) {
30
+ args.options.id = args.options.teamId;
31
+ this.warn(logger, `Option 'teamId' is deprecated. Please use 'id' instead.`);
32
+ }
15
33
  const endpoint = `${this.resource}/v1.0`;
16
- const requestOptions = {
17
- url: `${endpoint}/teams/${encodeURIComponent(args.options.teamId)}/unarchive`,
18
- headers: {
19
- 'content-type': 'application/json;odata=nometadata',
20
- 'accept': 'application/json;odata.metadata=none'
21
- },
22
- responseType: 'json'
23
- };
24
- request_1.default
25
- .post(requestOptions)
34
+ this
35
+ .getTeamId(args)
36
+ .then((teamId) => {
37
+ const requestOptions = {
38
+ url: `${endpoint}/teams/${encodeURIComponent(teamId)}/unarchive`,
39
+ headers: {
40
+ 'content-type': 'application/json;odata=nometadata',
41
+ 'accept': 'application/json;odata.metadata=none'
42
+ },
43
+ responseType: 'json'
44
+ };
45
+ return request_1.default.post(requestOptions);
46
+ })
26
47
  .then(_ => cb(), (res) => this.handleRejectedODataJsonPromise(res, logger, cb));
27
48
  }
28
49
  options() {
29
50
  const options = [
30
51
  {
31
- option: '-i, --teamId <teamId>'
52
+ option: '-i, --id [id]'
53
+ },
54
+ {
55
+ option: '-n, --name [name]'
56
+ },
57
+ {
58
+ option: '--teamId [teamId]'
32
59
  }
33
60
  ];
34
61
  const parentOptions = super.options();
35
62
  return options.concat(parentOptions);
36
63
  }
37
64
  validate(args) {
38
- if (!utils_1.validation.isValidGuid(args.options.teamId)) {
65
+ if (!args.options.id && !args.options.name && !args.options.teamId) {
66
+ return 'Specify either id or name';
67
+ }
68
+ if (args.options.name && (args.options.id || args.options.teamId)) {
69
+ return 'Specify either id or name but not both';
70
+ }
71
+ if (args.options.teamId && !utils_1.validation.isValidGuid(args.options.teamId)) {
39
72
  return `${args.options.teamId} is not a valid GUID`;
40
73
  }
74
+ if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
75
+ return `${args.options.id} is not a valid GUID`;
76
+ }
41
77
  return true;
42
78
  }
43
79
  }
@@ -45,19 +45,19 @@ exports.planner = {
45
45
  return odata_1.odata.getAllItems(`${graphResource}/v1.0/groups/${groupId}/planner/plans`, 'none');
46
46
  },
47
47
  /**
48
- * Get Planner plan by name in a specific group.
49
- * @param name Name of the Planner plan. Case insensitive.
48
+ * Get Planner plan by title in a specific group.
49
+ * @param title Title of the Planner plan. Case insensitive.
50
50
  * @param groupId Owner group ID .
51
51
  */
52
- getPlanByName(name, groupId) {
52
+ getPlanByTitle(title, groupId) {
53
53
  return __awaiter(this, void 0, void 0, function* () {
54
54
  const plans = yield this.getPlansByGroupId(groupId);
55
- const filteredPlans = plans.filter(p => p.title && p.title.toLowerCase() === name.toLowerCase());
55
+ const filteredPlans = plans.filter(p => p.title && p.title.toLowerCase() === title.toLowerCase());
56
56
  if (!filteredPlans.length) {
57
- throw Error(`The specified plan '${name}' does not exist.`);
57
+ throw Error(`The specified plan '${title}' does not exist.`);
58
58
  }
59
59
  if (filteredPlans.length > 1) {
60
- throw Error(`Multiple plans with name '${name}' found: ${filteredPlans.map(x => x.id)}.`);
60
+ throw Error(`Multiple plans with title '${title}' found: ${filteredPlans.map(x => x.id)}.`);
61
61
  }
62
62
  return filteredPlans[0];
63
63
  });
@@ -14,16 +14,19 @@ m365 planner bucket add [options]
14
14
  : Name of the bucket to add.
15
15
 
16
16
  `--planId [planId]`
17
- : Plan ID to which the bucket belongs. Specify either `planId` or `planName` but not both.
17
+ : ID of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
18
+
19
+ `--planTitle [planTitle]`
20
+ : Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` but not both.
18
21
 
19
22
  `--planName [planName]`
20
- : Plan Name to which the bucket belongs. Specify either `planId` or `planName` but not both.
23
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
21
24
 
22
25
  `--ownerGroupId [ownerGroupId]`
23
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
26
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
24
27
 
25
28
  `--ownerGroupName [ownerGroupName]`
26
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--orderHint [orderHint]`
29
32
  : Hint used to order items of this type in a list view. The format is defined as outlined [here](https://docs.microsoft.com/en-us/graph/api/resources/planner-order-hint-format?view=graph-rest-1.0).
@@ -38,8 +41,8 @@ Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with
38
41
  m365 planner bucket add --name "My Planner Bucket" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM" --orderHint " !"
39
42
  ```
40
43
 
41
- Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with the name _My Planner Plan_ owned by group _My Planner Group_
44
+ Adds a Microsoft Planner bucket with the name _My Planner Bucket_ for plan with the title _My Planner Plan_ owned by group _My Planner Group_
42
45
 
43
46
  ```sh
44
- m365 planner bucket add --name "My Planner Bucket" --planName "My Planner Plan" --ownerGroupName "My Planner Group"
47
+ m365 planner bucket add --name "My Planner Bucket" --planTitle "My Planner Plan" --ownerGroupName "My Planner Group"
45
48
  ```
@@ -17,16 +17,19 @@ m365 planner bucket get [options]
17
17
  : Name of the bucket to retrieve details. Specify either `id` or `name` but not both.
18
18
 
19
19
  `--planId [planId]`
20
- : Plan ID to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
20
+ : ID of the plan to which the bucket belongs. Specify either `planId` or `planTitle` when using `name`.
21
+
22
+ `--planTitle [planTitle]`
23
+ : Title of the plan to which the bucket belongs. Specify either `planId` or `planTitle` when using `name`.
21
24
 
22
25
  `--planName [planName]`
23
- : Plan Name to which the bucket belongs. Specify either `planId` or `planName` when using `name`.
26
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
24
27
 
25
28
  `--ownerGroupId [ownerGroupId]`
26
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--ownerGroupName [ownerGroupName]`
29
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
32
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
30
33
 
31
34
  --8<-- "docs/cmd/_global.md"
32
35
 
@@ -47,11 +50,11 @@ m365 planner bucket get --name "Planner Bucket A" --planId "xqQg5FS2LkCp935s-FIF
47
50
  Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by group _My Group_
48
51
 
49
52
  ```sh
50
- m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupName "My Group"
53
+ m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupName "My Group"
51
54
  ```
52
55
 
53
56
  Gets the Microsoft Planner bucket in the Plan _My Plan_ owned by groupId ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e
54
57
 
55
58
  ```sh
56
- m365 planner bucket get --name "Planner Bucket A" --planName "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
57
- ```
59
+ m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerGroupId "ee0f40fc-b2f7-45c7-b62d-11b90dd2ea8e"
60
+ ```