@pnp/cli-microsoft365 5.4.0 → 5.5.0-beta.10c7ae2

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 (63) hide show
  1. package/dist/Auth.js +1 -1
  2. package/dist/Command.js +22 -0
  3. package/dist/m365/flow/commands/flow-export.js +3 -0
  4. package/dist/m365/planner/commands/bucket/bucket-add.js +17 -9
  5. package/dist/m365/planner/commands/bucket/bucket-get.js +19 -11
  6. package/dist/m365/planner/commands/bucket/bucket-list.js +17 -9
  7. package/dist/m365/planner/commands/bucket/bucket-remove.js +19 -11
  8. package/dist/m365/planner/commands/bucket/bucket-set.js +19 -11
  9. package/dist/m365/planner/commands/plan/plan-get.js +58 -17
  10. package/dist/m365/planner/commands/plan/plan-remove.js +141 -0
  11. package/dist/m365/planner/commands/task/task-add.js +16 -16
  12. package/dist/m365/planner/commands/task/task-get.js +14 -9
  13. package/dist/m365/planner/commands/task/task-list.js +19 -11
  14. package/dist/m365/planner/commands/task/task-reference-add.js +1 -7
  15. package/dist/m365/planner/commands/task/task-reference-remove.js +11 -14
  16. package/dist/m365/planner/commands/task/task-remove.js +4 -19
  17. package/dist/m365/planner/commands/task/task-set.js +17 -23
  18. package/dist/m365/planner/commands/tenant/tenant-settings-set.js +95 -0
  19. package/dist/m365/planner/commands.js +3 -1
  20. package/dist/m365/search/commands/externalconnection/externalconnection-get.js +69 -0
  21. package/dist/m365/search/commands.js +1 -0
  22. package/dist/m365/spfx/commands/project/project-doctor/doctor-1.15.0.js +23 -0
  23. package/dist/m365/spfx/commands/project/project-doctor.js +2 -1
  24. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN015008_FILE_eslintrc_js.js +7 -0
  25. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.15.0.js +6 -4
  26. package/dist/m365/spfx/commands/spfx-doctor.js +15 -0
  27. package/dist/m365/spo/base-permissions.js +9 -0
  28. package/dist/m365/spo/commands/hubsite/hubsite-get.js +62 -12
  29. package/dist/m365/spo/commands/listitem/listitem-set.js +2 -2
  30. package/dist/m365/spo/commands/roledefinition/RoleDefinition.js +3 -0
  31. package/dist/m365/spo/commands/roledefinition/RoleType.js +16 -0
  32. package/dist/m365/spo/commands/roledefinition/roledefinition-get.js +59 -0
  33. package/dist/m365/spo/commands.js +1 -0
  34. package/dist/m365/teams/commands/cache/cache-remove.js +155 -0
  35. package/dist/m365/teams/commands.js +1 -0
  36. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-get.js +1 -9
  37. package/dist/utils/accessToken.js +18 -0
  38. package/dist/utils/planner.js +9 -8
  39. package/dist/utils/validation.js +5 -1
  40. package/docs/docs/cmd/aad/user/user-get.md +12 -0
  41. package/docs/docs/cmd/planner/bucket/bucket-add.md +9 -6
  42. package/docs/docs/cmd/planner/bucket/bucket-get.md +10 -7
  43. package/docs/docs/cmd/planner/bucket/bucket-list.md +8 -5
  44. package/docs/docs/cmd/planner/bucket/bucket-remove.md +8 -5
  45. package/docs/docs/cmd/planner/bucket/bucket-set.md +9 -6
  46. package/docs/docs/cmd/planner/plan/plan-get.md +14 -2
  47. package/docs/docs/cmd/planner/plan/plan-remove.md +48 -0
  48. package/docs/docs/cmd/planner/task/task-add.md +11 -8
  49. package/docs/docs/cmd/planner/task/task-get.md +11 -8
  50. package/docs/docs/cmd/planner/task/task-list.md +9 -6
  51. package/docs/docs/cmd/planner/task/task-set.md +9 -6
  52. package/docs/docs/cmd/planner/tenant/tenant-settings-set.md +56 -0
  53. package/docs/docs/cmd/search/externalconnection/externalconnection-get.md +33 -0
  54. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +19 -8
  55. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +27 -0
  56. package/docs/docs/cmd/teams/cache/cache-remove.md +46 -0
  57. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +1 -1
  58. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-healthissue-list.md +1 -1
  59. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-message-list.md +1 -1
  60. package/npm-shrinkwrap.json +2 -2
  61. package/package.json +3 -3
  62. package/dist/m365/planner/commands/plan/plan-details-get.js +0 -116
  63. package/docs/docs/cmd/planner/plan/plan-details-get.md +0 -45
package/dist/Auth.js CHANGED
@@ -330,7 +330,7 @@ class Auth {
330
330
  }
331
331
  return this.clientApplication.acquireTokenByUsernamePassword({
332
332
  username: this.service.userName,
333
- password: encodeURIComponent(this.service.password),
333
+ password: this.service.password,
334
334
  scopes: [`${resource}/.default`]
335
335
  });
336
336
  });
package/dist/Command.js CHANGED
@@ -14,6 +14,7 @@ const appInsights_1 = require("./appInsights");
14
14
  const Auth_1 = require("./Auth");
15
15
  const cli_1 = require("./cli");
16
16
  const request_1 = require("./request");
17
+ const utils_1 = require("./utils");
17
18
  class CommandError {
18
19
  constructor(message, code) {
19
20
  this.message = message;
@@ -81,6 +82,7 @@ class Command {
81
82
  cb(new CommandError('Log in to Microsoft 365 first'));
82
83
  return;
83
84
  }
85
+ this.loadValuesFromAccessToken(args);
84
86
  this.commandAction(logger, args, cb);
85
87
  }, (error) => {
86
88
  cb(new CommandError(error));
@@ -292,6 +294,26 @@ class Command {
292
294
  payload[o] = unknownOptions[o];
293
295
  });
294
296
  }
297
+ loadValuesFromAccessToken(args) {
298
+ if (!Auth_1.default.service.accessTokens[Auth_1.default.defaultResource]) {
299
+ return;
300
+ }
301
+ const token = Auth_1.default.service.accessTokens[Auth_1.default.defaultResource].accessToken;
302
+ const optionNames = Object.getOwnPropertyNames(args.options);
303
+ optionNames.forEach(option => {
304
+ const value = args.options[option];
305
+ if (!value || typeof value !== 'string') {
306
+ return;
307
+ }
308
+ const lowerCaseValue = value.toLowerCase();
309
+ if (lowerCaseValue === '@meid') {
310
+ args.options[option] = utils_1.accessToken.getUserIdFromAccessToken(token);
311
+ }
312
+ if (lowerCaseValue === '@meusername') {
313
+ args.options[option] = utils_1.accessToken.getUserNameFromAccessToken(token);
314
+ }
315
+ });
316
+ }
295
317
  }
296
318
  exports.default = Command;
297
319
  //# sourceMappingURL=Command.js.map
@@ -96,6 +96,9 @@ class FlowExportCommand extends AzmgmtCommand_1.default {
96
96
  const downloadFileUrl = formatArgument === 'json' ? '' : res.packageLink.value;
97
97
  const filenameRegEx = /([^\/]+\.zip)/i;
98
98
  filenameFromApi = formatArgument === 'json' ? `${res.properties.displayName}.json` : (filenameRegEx.exec(downloadFileUrl) || ['output.zip'])[0];
99
+ // Replace all illegal characters from the file name
100
+ const illegalCharsRegEx = /[\\\/:*?"<>|]/g;
101
+ filenameFromApi = filenameFromApi.replace(illegalCharsRegEx, '_');
99
102
  if (this.debug) {
100
103
  logger.logToStderr(`Filename from PowerApps API: ${filenameFromApi}`);
101
104
  logger.logToStderr('');
@@ -18,6 +18,7 @@ class PlannerBucketAddCommand extends GraphCommand_1.default {
18
18
  const telemetryProps = super.getTelemetryProperties(args);
19
19
  telemetryProps.planId = typeof args.options.planId !== 'undefined';
20
20
  telemetryProps.planName = typeof args.options.planName !== 'undefined';
21
+ telemetryProps.planTitle = typeof args.options.planTitle !== 'undefined';
21
22
  telemetryProps.ownerGroupId = typeof args.options.ownerGroupId !== 'undefined';
22
23
  telemetryProps.ownerGroupName = typeof args.options.ownerGroupName !== 'undefined';
23
24
  telemetryProps.orderHint = typeof args.options.orderHint !== 'undefined';
@@ -27,6 +28,10 @@ class PlannerBucketAddCommand extends GraphCommand_1.default {
27
28
  return ['id', 'name', 'planId', 'orderHint'];
28
29
  }
29
30
  commandAction(logger, args, cb) {
31
+ if (args.options.planName) {
32
+ args.options.planTitle = args.options.planName;
33
+ this.warn(logger, `Option 'planName' is deprecated. Please use 'planTitle' instead`);
34
+ }
30
35
  if (utils_1.accessToken.isAppOnlyAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken)) {
31
36
  this.handleError('This command does not support application permissions.', logger, cb);
32
37
  return;
@@ -59,7 +64,7 @@ class PlannerBucketAddCommand extends GraphCommand_1.default {
59
64
  }
60
65
  return this
61
66
  .getGroupId(args)
62
- .then(groupId => planner_1.planner.getPlanByName(args.options.planName, groupId))
67
+ .then(groupId => planner_1.planner.getPlanByTitle(args.options.planTitle, groupId))
63
68
  .then(plan => plan.id);
64
69
  }
65
70
  getGroupId(args) {
@@ -81,6 +86,9 @@ class PlannerBucketAddCommand extends GraphCommand_1.default {
81
86
  {
82
87
  option: "--planName [planName]"
83
88
  },
89
+ {
90
+ option: "--planTitle [planTitle]"
91
+ },
84
92
  {
85
93
  option: "--ownerGroupId [ownerGroupId]"
86
94
  },
@@ -95,17 +103,17 @@ class PlannerBucketAddCommand extends GraphCommand_1.default {
95
103
  return options.concat(parentOptions);
96
104
  }
97
105
  validate(args) {
98
- if (!args.options.planId && !args.options.planName) {
99
- return 'Specify either planId or planName';
106
+ if (!args.options.planId && !args.options.planName && !args.options.planTitle) {
107
+ return 'Specify either planId or planTitle';
100
108
  }
101
- if (args.options.planId && args.options.planName) {
102
- return 'Specify either planId or planName but not both';
109
+ if (args.options.planId && (args.options.planName || args.options.planTitle)) {
110
+ return 'Specify either planId or planTitle but not both';
103
111
  }
104
- if (args.options.planName && !args.options.ownerGroupId && !args.options.ownerGroupName) {
105
- return 'Specify either ownerGroupId or ownerGroupName when using planName';
112
+ if ((args.options.planName || args.options.planTitle) && !args.options.ownerGroupId && !args.options.ownerGroupName) {
113
+ return 'Specify either ownerGroupId or ownerGroupName when using planTitle';
106
114
  }
107
- if (args.options.planName && args.options.ownerGroupId && args.options.ownerGroupName) {
108
- return 'Specify either ownerGroupId or ownerGroupName when using planName but not both';
115
+ if ((args.options.planName || args.options.planTitle) && args.options.ownerGroupId && args.options.ownerGroupName) {
116
+ return 'Specify either ownerGroupId or ownerGroupName when using planTitle but not both';
109
117
  }
110
118
  if (args.options.ownerGroupId && !utils_1.validation.isValidGuid(args.options.ownerGroupId)) {
111
119
  return `${args.options.ownerGroupId} is not a valid GUID`;
@@ -29,11 +29,16 @@ class PlannerBucketGetCommand extends GraphCommand_1.default {
29
29
  telemetryProps.name = typeof args.options.name !== 'undefined';
30
30
  telemetryProps.planId = typeof args.options.planId !== 'undefined';
31
31
  telemetryProps.planName = typeof args.options.planName !== 'undefined';
32
+ telemetryProps.planTitle = typeof args.options.planTitle !== 'undefined';
32
33
  telemetryProps.ownerGroupId = typeof args.options.ownerGroupId !== 'undefined';
33
34
  telemetryProps.ownerGroupName = typeof args.options.ownerGroupName !== 'undefined';
34
35
  return telemetryProps;
35
36
  }
36
37
  commandAction(logger, args, cb) {
38
+ if (args.options.planName) {
39
+ args.options.planTitle = args.options.planName;
40
+ this.warn(logger, `Option 'planName' is deprecated. Please use 'planTitle' instead`);
41
+ }
37
42
  if (utils_1.accessToken.isAppOnlyAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken)) {
38
43
  this.handleError('This command does not support application permissions.', logger, cb);
39
44
  return;
@@ -75,13 +80,13 @@ class PlannerBucketGetCommand extends GraphCommand_1.default {
75
80
  });
76
81
  }
77
82
  getPlanId(args) {
78
- const { planId, planName } = args.options;
83
+ const { planId, planTitle } = args.options;
79
84
  if (planId) {
80
85
  return Promise.resolve(planId);
81
86
  }
82
87
  return this
83
88
  .getGroupId(args)
84
- .then(groupId => planner_1.planner.getPlanByName(planName, groupId))
89
+ .then(groupId => planner_1.planner.getPlanByTitle(planTitle, groupId))
85
90
  .then(plan => plan.id);
86
91
  }
87
92
  getBucketById(id) {
@@ -119,6 +124,9 @@ class PlannerBucketGetCommand extends GraphCommand_1.default {
119
124
  {
120
125
  option: '--planName [planName]'
121
126
  },
127
+ {
128
+ option: "--planTitle [planTitle]"
129
+ },
122
130
  {
123
131
  option: '--ownerGroupId [ownerGroupId]'
124
132
  },
@@ -131,26 +139,26 @@ class PlannerBucketGetCommand extends GraphCommand_1.default {
131
139
  }
132
140
  validate(args) {
133
141
  if (args.options.id) {
134
- if (args.options.planId || args.options.planName || args.options.ownerGroupId || args.options.ownerGroupName) {
135
- return 'Don\'t specify planId, planName, ownerGroupId or ownerGroupName when using id';
142
+ if (args.options.planId || args.options.planName || args.options.planTitle || args.options.ownerGroupId || args.options.ownerGroupName) {
143
+ return 'Don\'t specify planId, planTitle, ownerGroupId or ownerGroupName when using id';
136
144
  }
137
145
  if (args.options.name) {
138
146
  return 'Specify either id or name';
139
147
  }
140
148
  }
141
149
  if (args.options.name) {
142
- if (!args.options.planId && !args.options.planName) {
143
- return 'Specify either planId or planName when using name';
150
+ if (!args.options.planId && !args.options.planName && !args.options.planTitle) {
151
+ return 'Specify either planId or planTitle when using name';
144
152
  }
145
- if (args.options.planId && args.options.planName) {
146
- return 'Specify either planId or planName when using name but not both';
153
+ if (args.options.planId && (args.options.planName || args.options.planTitle)) {
154
+ return 'Specify either planId or planTitle when using name but not both';
147
155
  }
148
- if (args.options.planName) {
156
+ if (args.options.planName || args.options.planTitle) {
149
157
  if (!args.options.ownerGroupId && !args.options.ownerGroupName) {
150
- return 'Specify either ownerGroupId or ownerGroupName when using planName';
158
+ return 'Specify either ownerGroupId or ownerGroupName when using planTitle';
151
159
  }
152
160
  if (args.options.ownerGroupId && args.options.ownerGroupName) {
153
- return 'Specify either ownerGroupId or ownerGroupName when using planName but not both';
161
+ return 'Specify either ownerGroupId or ownerGroupName when using planTitle but not both';
154
162
  }
155
163
  if (args.options.ownerGroupId && !utils_1.validation.isValidGuid(args.options.ownerGroupId)) {
156
164
  return `${args.options.ownerGroupId} is not a valid GUID`;
@@ -17,6 +17,7 @@ class PlannerBucketListCommand extends GraphCommand_1.default {
17
17
  const telemetryProps = super.getTelemetryProperties(args);
18
18
  telemetryProps.planId = typeof args.options.planId !== 'undefined';
19
19
  telemetryProps.planName = typeof args.options.planName !== 'undefined';
20
+ telemetryProps.planTitle = typeof args.options.planTitle !== 'undefined';
20
21
  telemetryProps.ownerGroupId = typeof args.options.ownerGroupId !== 'undefined';
21
22
  telemetryProps.ownerGroupName = typeof args.options.ownerGroupName !== 'undefined';
22
23
  return telemetryProps;
@@ -25,6 +26,10 @@ class PlannerBucketListCommand extends GraphCommand_1.default {
25
26
  return ['id', 'name', 'planId', 'orderHint'];
26
27
  }
27
28
  commandAction(logger, args, cb) {
29
+ if (args.options.planName) {
30
+ args.options.planTitle = args.options.planName;
31
+ this.warn(logger, `Option 'planName' is deprecated. Please use 'planTitle' instead`);
32
+ }
28
33
  if (utils_1.accessToken.isAppOnlyAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken)) {
29
34
  this.handleError('This command does not support application permissions.', logger, cb);
30
35
  return;
@@ -43,7 +48,7 @@ class PlannerBucketListCommand extends GraphCommand_1.default {
43
48
  }
44
49
  return this
45
50
  .getGroupId(args)
46
- .then(groupId => planner_1.planner.getPlanByName(args.options.planName, groupId))
51
+ .then(groupId => planner_1.planner.getPlanByTitle(args.options.planTitle, groupId))
47
52
  .then(plan => plan.id);
48
53
  }
49
54
  getGroupId(args) {
@@ -62,6 +67,9 @@ class PlannerBucketListCommand extends GraphCommand_1.default {
62
67
  {
63
68
  option: '--planName [planName]'
64
69
  },
70
+ {
71
+ option: "--planTitle [planTitle]"
72
+ },
65
73
  {
66
74
  option: '--ownerGroupId [ownerGroupId]'
67
75
  },
@@ -73,17 +81,17 @@ class PlannerBucketListCommand extends GraphCommand_1.default {
73
81
  return options.concat(parentOptions);
74
82
  }
75
83
  validate(args) {
76
- if (!args.options.planId && !args.options.planName) {
77
- return 'Specify either planId or planName';
84
+ if (!args.options.planId && !args.options.planName && !args.options.planTitle) {
85
+ return 'Specify either planId or planTitle';
78
86
  }
79
- if (args.options.planId && args.options.planName) {
80
- return 'Specify either planId or planName but not both';
87
+ if (args.options.planId && (args.options.planName || args.options.planTitle)) {
88
+ return 'Specify either planId or planTitle but not both';
81
89
  }
82
- if (args.options.planName && !args.options.ownerGroupId && !args.options.ownerGroupName) {
83
- return 'Specify either ownerGroupId or ownerGroupName when using planName';
90
+ if ((args.options.planName || args.options.planTitle) && !args.options.ownerGroupId && !args.options.ownerGroupName) {
91
+ return 'Specify either ownerGroupId or ownerGroupName when using planTitle';
84
92
  }
85
- if (args.options.planName && args.options.ownerGroupId && args.options.ownerGroupName) {
86
- return 'Specify either ownerGroupId or ownerGroupName when using planName but not both';
93
+ if ((args.options.planName || args.options.planTitle) && args.options.ownerGroupId && args.options.ownerGroupName) {
94
+ return 'Specify either ownerGroupId or ownerGroupName when using planTitle but not both';
87
95
  }
88
96
  if (args.options.ownerGroupId && !utils_1.validation.isValidGuid(args.options.ownerGroupId)) {
89
97
  return `${args.options.ownerGroupId} is not a valid GUID`;
@@ -21,12 +21,17 @@ class PlannerBucketRemoveCommand extends GraphCommand_1.default {
21
21
  telemetryProps.name = typeof args.options.name !== 'undefined';
22
22
  telemetryProps.planId = typeof args.options.planId !== 'undefined';
23
23
  telemetryProps.planName = typeof args.options.planName !== 'undefined';
24
+ telemetryProps.planTitle = typeof args.options.planTitle !== 'undefined';
24
25
  telemetryProps.ownerGroupId = typeof args.options.ownerGroupId !== 'undefined';
25
26
  telemetryProps.ownerGroupName = typeof args.options.ownerGroupName !== 'undefined';
26
27
  telemetryProps.confirm = args.options.confirm || false;
27
28
  return telemetryProps;
28
29
  }
29
30
  commandAction(logger, args, cb) {
31
+ if (args.options.planName) {
32
+ args.options.planTitle = args.options.planName;
33
+ this.warn(logger, `Option 'planName' is deprecated. Please use 'planTitle' instead`);
34
+ }
30
35
  if (utils_1.accessToken.isAppOnlyAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken)) {
31
36
  this.handleError('This command does not support application permissions.', logger, cb);
32
37
  return;
@@ -101,13 +106,13 @@ class PlannerBucketRemoveCommand extends GraphCommand_1.default {
101
106
  });
102
107
  }
103
108
  getPlanId(args) {
104
- const { planId, planName } = args.options;
109
+ const { planId, planTitle } = args.options;
105
110
  if (planId) {
106
111
  return Promise.resolve(planId);
107
112
  }
108
113
  return this
109
114
  .getGroupId(args)
110
- .then(groupId => planner_1.planner.getPlanByName(planName, groupId))
115
+ .then(groupId => planner_1.planner.getPlanByTitle(planTitle, groupId))
111
116
  .then(plan => plan.id);
112
117
  }
113
118
  getGroupId(args) {
@@ -133,6 +138,9 @@ class PlannerBucketRemoveCommand extends GraphCommand_1.default {
133
138
  {
134
139
  option: '--planName [planName]'
135
140
  },
141
+ {
142
+ option: "--planTitle [planTitle]"
143
+ },
136
144
  {
137
145
  option: '--ownerGroupId [ownerGroupId]'
138
146
  },
@@ -153,23 +161,23 @@ class PlannerBucketRemoveCommand extends GraphCommand_1.default {
153
161
  }
154
162
  validate(args) {
155
163
  if (args.options.id) {
156
- if (args.options.planId || args.options.planName || args.options.ownerGroupId || args.options.ownerGroupName) {
157
- return 'Don\'t specify planId, planName, ownerGroupId or ownerGroupName when using id';
164
+ if (args.options.planId || args.options.planName || args.options.planTitle || args.options.ownerGroupId || args.options.ownerGroupName) {
165
+ return 'Don\'t specify planId, planTitle, ownerGroupId or ownerGroupName when using id';
158
166
  }
159
167
  }
160
168
  else {
161
- if (!args.options.planId && !args.options.planName) {
162
- return 'Specify either planId or planName when using name';
169
+ if (!args.options.planId && !args.options.planName && !args.options.planTitle) {
170
+ return 'Specify either planId or planTitle when using name';
163
171
  }
164
- if (args.options.planId && args.options.planName) {
165
- return 'Specify either planId or planName when using name but not both';
172
+ if (args.options.planId && (args.options.planName || args.options.planTitle)) {
173
+ return 'Specify either planId or planTitle when using name but not both';
166
174
  }
167
- if (args.options.planName) {
175
+ if (args.options.planName || args.options.planTitle) {
168
176
  if (!args.options.ownerGroupId && !args.options.ownerGroupName) {
169
- return 'Specify either ownerGroupId or ownerGroupName when using planName';
177
+ return 'Specify either ownerGroupId or ownerGroupName when using planTitle';
170
178
  }
171
179
  if (args.options.ownerGroupId && args.options.ownerGroupName) {
172
- return 'Specify either ownerGroupId or ownerGroupName when using planName but not both';
180
+ return 'Specify either ownerGroupId or ownerGroupName when using planTitle but not both';
173
181
  }
174
182
  if (args.options.ownerGroupId && !utils_1.validation.isValidGuid(args.options.ownerGroupId)) {
175
183
  return `${args.options.ownerGroupId} is not a valid GUID`;
@@ -20,6 +20,7 @@ class PlannerBucketSetCommand extends GraphCommand_1.default {
20
20
  telemetryProps.name = typeof args.options.name !== 'undefined';
21
21
  telemetryProps.planId = typeof args.options.planId !== 'undefined';
22
22
  telemetryProps.planName = typeof args.options.planName !== 'undefined';
23
+ telemetryProps.planTitle = typeof args.options.planTitle !== 'undefined';
23
24
  telemetryProps.ownerGroupId = typeof args.options.ownerGroupId !== 'undefined';
24
25
  telemetryProps.ownerGroupName = typeof args.options.ownerGroupName !== 'undefined';
25
26
  telemetryProps.newName = typeof args.options.newName !== 'undefined';
@@ -27,6 +28,10 @@ class PlannerBucketSetCommand extends GraphCommand_1.default {
27
28
  return telemetryProps;
28
29
  }
29
30
  commandAction(logger, args, cb) {
31
+ if (args.options.planName) {
32
+ args.options.planTitle = args.options.planName;
33
+ this.warn(logger, `Option 'planName' is deprecated. Please use 'planTitle' instead`);
34
+ }
30
35
  if (utils_1.accessToken.isAppOnlyAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken)) {
31
36
  this.handleError('This command does not support application permissions.', logger, cb);
32
37
  return;
@@ -89,13 +94,13 @@ class PlannerBucketSetCommand extends GraphCommand_1.default {
89
94
  });
90
95
  }
91
96
  getPlanId(args) {
92
- const { planId, planName } = args.options;
97
+ const { planId, planTitle } = args.options;
93
98
  if (planId) {
94
99
  return Promise.resolve(planId);
95
100
  }
96
101
  return this
97
102
  .getGroupId(args)
98
- .then(groupId => planner_1.planner.getPlanByName(planName, groupId))
103
+ .then(groupId => planner_1.planner.getPlanByTitle(planTitle, groupId))
99
104
  .then(plan => plan.id);
100
105
  }
101
106
  getGroupId(args) {
@@ -121,6 +126,9 @@ class PlannerBucketSetCommand extends GraphCommand_1.default {
121
126
  {
122
127
  option: '--planName [planName]'
123
128
  },
129
+ {
130
+ option: "--planTitle [planTitle]"
131
+ },
124
132
  {
125
133
  option: '--ownerGroupId [ownerGroupId]'
126
134
  },
@@ -144,23 +152,23 @@ class PlannerBucketSetCommand extends GraphCommand_1.default {
144
152
  }
145
153
  validate(args) {
146
154
  if (args.options.id) {
147
- if (args.options.planId || args.options.planName || args.options.ownerGroupId || args.options.ownerGroupName) {
148
- return 'Don\'t specify planId, planName, ownerGroupId or ownerGroupName when using id';
155
+ if (args.options.planId || args.options.planName || args.options.planTitle || args.options.ownerGroupId || args.options.ownerGroupName) {
156
+ return 'Don\'t specify planId, planTitle, ownerGroupId or ownerGroupName when using id';
149
157
  }
150
158
  }
151
159
  if (args.options.name) {
152
- if (!args.options.planId && !args.options.planName) {
153
- return 'Specify either planId or planName when using name';
160
+ if (!args.options.planId && !args.options.planName && !args.options.planTitle) {
161
+ return 'Specify either planId or planTitle when using name';
154
162
  }
155
- if (args.options.planId && args.options.planName) {
156
- return 'Specify either planId or planName when using name but not both';
163
+ if (args.options.planId && (args.options.planName || args.options.planTitle)) {
164
+ return 'Specify either planId or planTitle when using name but not both';
157
165
  }
158
- if (args.options.planName) {
166
+ if (args.options.planName || args.options.planTitle) {
159
167
  if (!args.options.ownerGroupId && !args.options.ownerGroupName) {
160
- return 'Specify either ownerGroupId or ownerGroupName when using planName';
168
+ return 'Specify either ownerGroupId or ownerGroupName when using planTitle';
161
169
  }
162
170
  if (args.options.ownerGroupId && args.options.ownerGroupName) {
163
- return 'Specify either ownerGroupId or ownerGroupName when using planName but not both';
171
+ return 'Specify either ownerGroupId or ownerGroupName when using planTitle but not both';
164
172
  }
165
173
  if (args.options.ownerGroupId && !utils_1.validation.isValidGuid(args.options.ownerGroupId)) {
166
174
  return `${args.options.ownerGroupId} is not a valid GUID`;
@@ -6,15 +6,21 @@ const GraphCommand_1 = require("../../../base/GraphCommand");
6
6
  const commands_1 = require("../../commands");
7
7
  const Auth_1 = require("../../../../Auth");
8
8
  const aadGroup_1 = require("../../../../utils/aadGroup");
9
+ const request_1 = require("../../../../request");
9
10
  class PlannerPlanGetCommand extends GraphCommand_1.default {
10
11
  get name() {
11
12
  return commands_1.default.PLAN_GET;
12
13
  }
14
+ alias() {
15
+ return [commands_1.default.PLAN_DETAILS_GET];
16
+ }
13
17
  get description() {
14
18
  return 'Get a Microsoft Planner plan';
15
19
  }
16
20
  getTelemetryProperties(args) {
17
21
  const telemetryProps = super.getTelemetryProperties(args);
22
+ telemetryProps.planId = typeof args.options.planId !== 'undefined';
23
+ telemetryProps.planTitle = typeof args.options.planTitle !== 'undefined';
18
24
  telemetryProps.id = typeof args.options.id !== 'undefined';
19
25
  telemetryProps.title = typeof args.options.title !== 'undefined';
20
26
  telemetryProps.ownerGroupId = typeof args.options.ownerGroupId !== 'undefined';
@@ -25,13 +31,21 @@ class PlannerPlanGetCommand extends GraphCommand_1.default {
25
31
  return ['id', 'title', 'createdDateTime', 'owner', '@odata.etag'];
26
32
  }
27
33
  commandAction(logger, args, cb) {
34
+ this.showDeprecationWarning(logger, commands_1.default.PLAN_DETAILS_GET, commands_1.default.PLAN_GET);
28
35
  if (utils_1.accessToken.isAppOnlyAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken)) {
29
36
  this.handleError('This command does not support application permissions.', logger, cb);
30
37
  return;
31
38
  }
39
+ if (args.options.planId) {
40
+ args.options.id = args.options.planId;
41
+ }
42
+ if (args.options.planTitle) {
43
+ args.options.title = args.options.planTitle;
44
+ }
32
45
  if (args.options.id) {
33
46
  planner_1.planner
34
47
  .getPlanById(args.options.id)
48
+ .then(plan => this.getPlanDetails(plan))
35
49
  .then((res) => {
36
50
  logger.log(res);
37
51
  cb();
@@ -40,15 +54,31 @@ class PlannerPlanGetCommand extends GraphCommand_1.default {
40
54
  else {
41
55
  this
42
56
  .getGroupId(args)
43
- .then(groupId => planner_1.planner.getPlanByName(args.options.title, groupId))
44
- .then((plan) => {
45
- if (plan) {
46
- logger.log(plan);
57
+ .then(groupId => planner_1.planner.getPlanByTitle(args.options.title, groupId))
58
+ .then(plan => this.getPlanDetails(plan))
59
+ .then((res) => {
60
+ if (res) {
61
+ logger.log(res);
47
62
  }
48
63
  cb();
49
64
  }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
50
65
  }
51
66
  }
67
+ getPlanDetails(plan) {
68
+ const requestOptionsTaskDetails = {
69
+ url: `${this.resource}/v1.0/planner/plans/${plan.id}/details`,
70
+ headers: {
71
+ 'accept': 'application/json;odata.metadata=none',
72
+ 'Prefer': 'return=representation'
73
+ },
74
+ responseType: 'json'
75
+ };
76
+ return request_1.default
77
+ .get(requestOptionsTaskDetails)
78
+ .then(planDetails => {
79
+ return Object.assign(Object.assign({}, plan), planDetails);
80
+ });
81
+ }
52
82
  getGroupId(args) {
53
83
  if (args.options.ownerGroupId) {
54
84
  return Promise.resolve(args.options.ownerGroupId);
@@ -59,6 +89,12 @@ class PlannerPlanGetCommand extends GraphCommand_1.default {
59
89
  }
60
90
  options() {
61
91
  const options = [
92
+ {
93
+ option: '--planId [planId]'
94
+ },
95
+ {
96
+ option: '--planTitle [planTitle]'
97
+ },
62
98
  {
63
99
  option: '-i, --id [id]'
64
100
  },
@@ -76,20 +112,25 @@ class PlannerPlanGetCommand extends GraphCommand_1.default {
76
112
  return options.concat(parentOptions);
77
113
  }
78
114
  validate(args) {
79
- if (!args.options.id && !args.options.title) {
80
- return 'Specify either id or title';
81
- }
82
- if (args.options.id && args.options.title) {
83
- return 'Specify either id or title';
84
- }
85
- if (args.options.title && !args.options.ownerGroupId && !args.options.ownerGroupName) {
86
- return 'Specify either ownerGroupId or ownerGroupName';
87
- }
88
- if (args.options.title && args.options.ownerGroupId && args.options.ownerGroupName) {
89
- return 'Specify either ownerGroupId or ownerGroupName but not both';
115
+ if (args.options.planId && args.options.planTitle ||
116
+ args.options.id && args.options.title ||
117
+ args.options.planId && args.options.title ||
118
+ args.options.id && args.options.planTitle) {
119
+ return 'Specify either id or title but not both';
90
120
  }
91
- if (args.options.ownerGroupId && !utils_1.validation.isValidGuid(args.options.ownerGroupId)) {
92
- return `${args.options.ownerGroupId} is not a valid GUID`;
121
+ if (!args.options.planId && !args.options.id) {
122
+ if (!args.options.planTitle && !args.options.title) {
123
+ return 'Specify either id or title';
124
+ }
125
+ if ((args.options.title || args.options.planTitle) && !args.options.ownerGroupId && !args.options.ownerGroupName) {
126
+ return 'Specify either ownerGroupId or ownerGroupName';
127
+ }
128
+ if ((args.options.title || args.options.planTitle) && args.options.ownerGroupId && args.options.ownerGroupName) {
129
+ return 'Specify either ownerGroupId or ownerGroupName but not both';
130
+ }
131
+ if (args.options.ownerGroupId && !utils_1.validation.isValidGuid(args.options.ownerGroupId)) {
132
+ return `${args.options.ownerGroupId} is not a valid GUID`;
133
+ }
93
134
  }
94
135
  return true;
95
136
  }