@pnp/cli-microsoft365 5.5.0-beta.42585c2 → 5.5.0-beta.6fb46e0

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 (59) hide show
  1. package/dist/Auth.js +2 -2
  2. package/dist/Command.js +22 -0
  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 +16 -16
  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-reference-add.js +1 -7
  23. package/dist/m365/planner/commands/task/task-reference-remove.js +11 -14
  24. package/dist/m365/planner/commands/task/task-remove.js +4 -19
  25. package/dist/m365/planner/commands/task/task-set.js +17 -23
  26. package/dist/m365/search/commands/externalconnection/externalconnection-get.js +69 -0
  27. package/dist/m365/search/commands.js +1 -0
  28. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN015008_FILE_eslintrc_js.js +7 -0
  29. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.15.0.js +6 -4
  30. package/dist/m365/spo/base-permissions.js +9 -0
  31. package/dist/m365/spo/commands/hubsite/hubsite-get.js +62 -12
  32. package/dist/m365/spo/commands/listitem/listitem-get.js +9 -9
  33. package/dist/m365/spo/commands/listitem/listitem-list.js +5 -1
  34. package/dist/m365/spo/commands/roledefinition/RoleDefinition.js +3 -0
  35. package/dist/m365/spo/commands/roledefinition/RoleType.js +16 -0
  36. package/dist/m365/spo/commands/roledefinition/roledefinition-get.js +59 -0
  37. package/dist/m365/spo/commands.js +1 -0
  38. package/dist/m365/tenant/commands/serviceannouncement/serviceannouncement-health-get.js +1 -9
  39. package/dist/utils/accessToken.js +18 -0
  40. package/dist/utils/planner.js +6 -6
  41. package/dist/utils/validation.js +5 -1
  42. package/docs/docs/cmd/aad/user/user-get.md +12 -0
  43. package/docs/docs/cmd/planner/bucket/bucket-add.md +9 -6
  44. package/docs/docs/cmd/planner/bucket/bucket-get.md +10 -7
  45. package/docs/docs/cmd/planner/bucket/bucket-list.md +8 -5
  46. package/docs/docs/cmd/planner/bucket/bucket-remove.md +8 -5
  47. package/docs/docs/cmd/planner/bucket/bucket-set.md +9 -6
  48. package/docs/docs/cmd/planner/plan/plan-add.md +18 -2
  49. package/docs/docs/cmd/planner/plan/plan-remove.md +1 -1
  50. package/docs/docs/cmd/planner/task/task-add.md +11 -8
  51. package/docs/docs/cmd/planner/task/task-get.md +11 -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/hubsite/hubsite-get.md +19 -8
  56. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  57. package/docs/docs/cmd/spo/listitem/listitem-list.md +8 -0
  58. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +27 -0
  59. package/package.json +1 -1
@@ -1,6 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.FN015008_FILE_eslintrc_js = void 0;
4
+ const utils_1 = require("../../../../../../utils");
4
5
  const FileAddRemoveRule_1 = require("./FileAddRemoveRule");
5
6
  class FN015008_FILE_eslintrc_js extends FileAddRemoveRule_1.FileAddRemoveRule {
6
7
  constructor(add, contents) {
@@ -9,6 +10,12 @@ class FN015008_FILE_eslintrc_js extends FileAddRemoveRule_1.FileAddRemoveRule {
9
10
  get id() {
10
11
  return 'FN015008';
11
12
  }
13
+ visit(project, notifications) {
14
+ if (utils_1.spfx.isReactProject(project)) {
15
+ this.contents = this.contents.replace('@microsoft/eslint-config-spfx/lib/profiles/default', '@microsoft/eslint-config-spfx/lib/profiles/react');
16
+ }
17
+ super.visit(project, notifications);
18
+ }
12
19
  }
13
20
  exports.FN015008_FILE_eslintrc_js = FN015008_FILE_eslintrc_js;
14
21
  //# sourceMappingURL=FN015008_FILE_eslintrc_js.js.map
@@ -27,6 +27,7 @@ const FN002007_DEVDEP_ajv_1 = require("./rules/FN002007_DEVDEP_ajv");
27
27
  const FN002009_DEVDEP_microsoft_sp_tslint_rules_1 = require("./rules/FN002009_DEVDEP_microsoft_sp_tslint_rules");
28
28
  const FN002013_DEVDEP_types_webpack_env_1 = require("./rules/FN002013_DEVDEP_types_webpack_env");
29
29
  const FN002018_DEVDEP_microsoft_rush_stack_compiler_3_9_1 = require("./rules/FN002018_DEVDEP_microsoft_rush_stack_compiler_3_9");
30
+ const FN002019_DEVDEP_spfx_fast_serve_helpers_1 = require("./rules/FN002019_DEVDEP_spfx_fast_serve_helpers");
30
31
  const FN002020_DEVDEP_microsoft_rush_stack_compiler_4_5_1 = require("./rules/FN002020_DEVDEP_microsoft_rush_stack_compiler_4_5");
31
32
  const FN002021_DEVDEP_rushstack_eslint_config_1 = require("./rules/FN002021_DEVDEP_rushstack_eslint_config");
32
33
  const FN002022_DEVDEP_microsoft_eslint_plugin_spfx_1 = require("./rules/FN002022_DEVDEP_microsoft_eslint_plugin_spfx");
@@ -67,6 +68,7 @@ module.exports = [
67
68
  new FN002009_DEVDEP_microsoft_sp_tslint_rules_1.FN002009_DEVDEP_microsoft_sp_tslint_rules('', false),
68
69
  new FN002013_DEVDEP_types_webpack_env_1.FN002013_DEVDEP_types_webpack_env('1.15.2'),
69
70
  new FN002018_DEVDEP_microsoft_rush_stack_compiler_3_9_1.FN002018_DEVDEP_microsoft_rush_stack_compiler_3_9('', false),
71
+ new FN002019_DEVDEP_spfx_fast_serve_helpers_1.FN002019_DEVDEP_spfx_fast_serve_helpers('1.15.2'),
70
72
  new FN002020_DEVDEP_microsoft_rush_stack_compiler_4_5_1.FN002020_DEVDEP_microsoft_rush_stack_compiler_4_5('0.2.2'),
71
73
  new FN002021_DEVDEP_rushstack_eslint_config_1.FN002021_DEVDEP_rushstack_eslint_config('2.5.1'),
72
74
  new FN002022_DEVDEP_microsoft_eslint_plugin_spfx_1.FN002022_DEVDEP_microsoft_eslint_plugin_spfx('1.15.0'),
@@ -78,10 +80,10 @@ module.exports = [
78
80
  new FN012017_TSC_extends_1.FN012017_TSC_extends('./node_modules/@microsoft/rush-stack-compiler-4.5/includes/tsconfig-web.json'),
79
81
  new FN015003_FILE_tslint_json_1.FN015003_FILE_tslint_json(false, ''),
80
82
  new FN015008_FILE_eslintrc_js_1.FN015008_FILE_eslintrc_js(true, `require('@rushstack/eslint-config/patch/modern-module-resolution');
81
- module.exports = {
82
- extends: ['@microsoft/eslint-config-spfx/lib/profiles/react'],
83
- parserOptions: { tsconfigRootDir: __dirname }
84
- };`),
83
+ module.exports = {
84
+ extends: ['@microsoft/eslint-config-spfx/lib/profiles/default'],
85
+ parserOptions: { tsconfigRootDir: __dirname }
86
+ };`),
85
87
  new FN023002_GITIGNORE_heft_1.FN023002_GITIGNORE_heft()
86
88
  ];
87
89
  //# sourceMappingURL=upgrade-1.15.0.js.map
@@ -22,6 +22,15 @@ class BasePermissions {
22
22
  set low(value) {
23
23
  this._low = value;
24
24
  }
25
+ parse() {
26
+ const result = [];
27
+ for (const permissionKind in PermissionKind) {
28
+ if (this.has(PermissionKind[permissionKind])) {
29
+ result.push(permissionKind);
30
+ }
31
+ }
32
+ return result;
33
+ }
25
34
  has(perm) {
26
35
  let hasPermission = false;
27
36
  if (perm === PermissionKind.FullMask) {
@@ -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`,
@@ -34,15 +34,7 @@ class TenantServiceAnnouncementHealthGetCommand extends GraphCommand_1.default {
34
34
  },
35
35
  responseType: 'json'
36
36
  };
37
- return request_1.default
38
- .get(requestOptions)
39
- .then(response => {
40
- const serviceHealth = response;
41
- if (!serviceHealth) {
42
- return Promise.reject(`Error fetching service health`);
43
- }
44
- return Promise.resolve(serviceHealth);
45
- });
37
+ return request_1.default.get(requestOptions);
46
38
  }
47
39
  options() {
48
40
  const options = [
@@ -57,6 +57,24 @@ exports.accessToken = {
57
57
  catch (_a) {
58
58
  }
59
59
  return userName;
60
+ },
61
+ getUserIdFromAccessToken(accessToken) {
62
+ let userId = '';
63
+ if (!accessToken || accessToken.length === 0) {
64
+ return userId;
65
+ }
66
+ const chunks = accessToken.split('.');
67
+ if (chunks.length !== 3) {
68
+ return userId;
69
+ }
70
+ const tokenString = Buffer.from(chunks[1], 'base64').toString();
71
+ try {
72
+ const token = JSON.parse(tokenString);
73
+ userId = token.oid;
74
+ }
75
+ catch (_a) {
76
+ }
77
+ return userId;
60
78
  }
61
79
  };
62
80
  //# sourceMappingURL=accessToken.js.map
@@ -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
  });
@@ -6,8 +6,12 @@ exports.validation = {
6
6
  return guids.every(guid => this.isValidGuid(guid));
7
7
  },
8
8
  isValidGuid(guid) {
9
+ if (!guid) {
10
+ return false;
11
+ }
9
12
  const guidRegEx = new RegExp(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i);
10
- return guidRegEx.test(guid);
13
+ // verify if the guid is a valid guid. @meid will be replaced in a later stage with the actual user id of the logged in user
14
+ return guidRegEx.test(guid) || guid.toLocaleLowerCase().trim() === "@meid";
11
15
  },
12
16
  isValidTeamsChannelId(guid) {
13
17
  const guidRegEx = new RegExp(/^19:[0-9a-zA-Z-_]+@thread\.(skype|tacv2)$/i);
@@ -56,6 +56,18 @@ For the user with id _1caf7dcd-7e83-4c3a-94f7-932a1299c844_ retrieve the user na
56
56
  m365 aad user get --id 1caf7dcd-7e83-4c3a-94f7-932a1299c844 --properties "userPrincipalName,mail,displayName"
57
57
  ```
58
58
 
59
+ Get information about the currently logged user using the Id token
60
+
61
+ ```sh
62
+ m365 aad user get --id "@meId"
63
+ ```
64
+
65
+ Get information about the currently logged in user using the UserName token
66
+
67
+ ```sh
68
+ m365 aad user get --userName "@meUserName"
69
+ ```
70
+
59
71
  ## More information
60
72
 
61
73
  - Microsoft Graph User properties: [https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties](https://developer.microsoft.com/en-us/graph/docs/api-reference/v1.0/resources/user#properties)
@@ -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
+ ```
@@ -11,16 +11,19 @@ m365 planner bucket list [options]
11
11
  ## Options
12
12
 
13
13
  `--planId [planId]`
14
- : ID of the plan to list the buckets of. Specify either `planId` or `planName` but not both.
14
+ : ID of the plan to list the buckets of. Specify either `planId` or `planTitle` but not both.
15
+
16
+ `--planTitle [planTitle]`
17
+ : Title of the plan to list the buckets of. Specify either `planId` or `planTitle` but not both.
15
18
 
16
19
  `--planName [planName]`
17
- : Name of the plan to list the buckets of. Specify either `planId` or `planName` but not both.
20
+ : (deprecated. Use `planTitle` instead) Title of the plan to which the bucket belongs.
18
21
 
19
22
  `--ownerGroupId [ownerGroupId]`
20
- : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
23
+ : ID of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
21
24
 
22
25
  `--ownerGroupName [ownerGroupName]`
23
- : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planName`.
26
+ : Name of the group to which the plan belongs. Specify `ownerGroupId` or `ownerGroupName` when using `planTitle`.
24
27
 
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
@@ -35,5 +38,5 @@ m365 planner bucket list --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
35
38
  Lists the Microsoft Planner buckets in the Plan _My Plan_ owned by group _My Group_
36
39
 
37
40
  ```sh
38
- m365 planner bucket list --planName "My Plan" --ownerGroupName "My Group"
41
+ m365 planner bucket list --planTitle "My Plan" --ownerGroupName "My Group"
39
42
  ```
@@ -17,16 +17,19 @@ m365 planner bucket remove [options]
17
17
  : Name of the bucket to remove. Specify either `id` or `name` but not both.
18
18
 
19
19
  `--planId [planId]`
20
- : ID of the plan to which the bucket to remove belongs. Specify either `planId` or `planName` when using `name`.
20
+ : ID of the plan to which the bucket to remove belongs. Specify either `planId` or `planTitle` when using `name`.
21
+
22
+ `--planTitle [planTitle]`
23
+ : Title of the plan to which the bucket to remove belongs. Specify either `planId` or `planTitle` when using `name`.
21
24
 
22
25
  `--planName [planName]`
23
- : Name of the plan to which the bucket to remove 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 either `ownerGroupId` or `ownerGroupName` when using `planName`.
29
+ : ID of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
27
30
 
28
31
  `--ownerGroupName [ownerGroupName]`
29
- : Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planName`.
32
+ : Name of the group to which the plan belongs. Specify either `ownerGroupId` or `ownerGroupName` when using `planTitle`.
30
33
 
31
34
  `--confirm`
32
35
  : Don't prompt for confirmation
@@ -56,5 +59,5 @@ m365 planner bucket remove --name "My Bucket" --planId "oUHpnKBFekqfGE_PS6GGUZcA
56
59
  Removes the Microsoft Planner bucket with name _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
57
60
 
58
61
  ```sh
59
- m365 planner bucket remove --name "My Bucket" --planName "My Plan" --ownerGroupName "My Group"
62
+ m365 planner bucket remove --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group"
60
63
  ```
@@ -17,16 +17,19 @@ m365 planner bucket set [options]
17
17
  : Name of the bucket. Specify either `id` or `name` but not both.
18
18
 
19
19
  `--planId [planId]`
20
- : ID of the plan to update the bucket of. Specify either `planId` or `planName` when using `name`.
20
+ : ID of the plan to update the bucket of. Specify either `planId` or `planTitle` when using `name`.
21
+
22
+ `--planTitle [planTitle]`
23
+ : Title of the plan to update the bucket of. Specify either `planId` or `planTitle` when using `name`. Always use in combination with either `ownerGroupId` or `ownerGroupName`.
21
24
 
22
25
  `--planName [planName]`
23
- : Name of the plan to update the bucket of. Specify either `planId` or `planName` when using `name`. Always use in combination with either `ownerGroupId` or `ownerGroupName`.
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
  `--newName [newName]`
32
35
  : New name of the bucket.
@@ -47,11 +50,11 @@ m365 planner bucket set --id "vncYUXCRBke28qMLB-d4xJcACtNz" --newName "New bucke
47
50
  Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ owned by group _My Group_
48
51
 
49
52
  ```sh
50
- m365 planner bucket set --name "My Bucket" --planName "My Plan" --ownerGroupName "My Group" --newName "New bucket name"
53
+ m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupName "My Group" --newName "New bucket name"
51
54
  ```
52
55
 
53
56
  Updates the Microsoft Planner bucket named _My Bucket_ in the Plan _My Plan_ owned by group with ID _00000000-0000-0000-0000-000000000000_
54
57
 
55
58
  ```sh
56
- m365 planner bucket set --name "My Bucket" --planName "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000 --newName "New bucket name"
59
+ m365 planner bucket set --name "My Bucket" --planTitle "My Plan" --ownerGroupId 00000000-0000-0000-0000-000000000000 --newName "New bucket name"
57
60
  ```
@@ -19,18 +19,34 @@ m365 planner plan add [options]
19
19
  `--ownerGroupName [ownerGroupName]`
20
20
  : Name of the Group that owns the plan. A valid group must exist before this option can be set. Specify either `ownerGroupId` or `ownerGroupName` but not both.
21
21
 
22
+ `--shareWithUserIds [shareWithUserIds]`
23
+ : The comma-separated IDs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
24
+
25
+ `--shareWithUserNames [shareWithUserNames]`
26
+ : The comma-separated UPNs of the users with whom you want to share the plan. Specify either `shareWithUserIds` or `shareWithUserNames` but not both.
27
+
22
28
  --8<-- "docs/cmd/_global.md"
23
29
 
30
+ ## Remarks
31
+
32
+ Related to the options `--shareWithUserIds` and `--shareWithUserNames`. If you are leveraging Microsoft 365 groups, use the `aad o365group user` commands to manage group membership to share the [group's](https://pnp.github.io/cli-microsoft365/cmd/aad/o365group/o365group-user-add/) plan. You can also add existing members of the group to this collection though it is not required for them to access the plan owned by the group.
33
+
24
34
  ## Examples
25
35
 
26
36
  Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
27
37
 
28
38
  ```sh
29
- m365 planner plan add --title "My Planner Plan" --ownerGroupId "233e43d0-dc6a-482e-9b4e-0de7a7bce9b4"
39
+ m365 planner plan add --title 'My Planner Plan' --ownerGroupId '233e43d0-dc6a-482e-9b4e-0de7a7bce9b4'
30
40
  ```
31
41
 
32
42
  Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Planner Group_
33
43
 
34
44
  ```sh
35
- m365 planner plan add --title "My Planner Plan" --ownerGroupName "My Planner Group"
45
+ m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group'
46
+ ```
47
+
48
+ Adds a Microsoft Planner plan with the name _My Planner Plan_ for Group _My Planner Group_ and share it with the users _Allan.Carroll@contoso.com_ and _Ida.Stevens@contoso.com_
49
+
50
+ ```sh
51
+ m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Group' --shareWithUserNames 'Allan.Carroll@contoso.com,Ida.Stevens@contoso.com'
36
52
  ```