@pnp/cli-microsoft365 6.0.0-beta.c32757e → 6.0.0-beta.d4d33ed

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 (98) hide show
  1. package/dist/Auth.js +2 -2
  2. package/dist/m365/aad/commands/app/app-remove.js +0 -4
  3. package/dist/m365/aad/commands/app/app-role-remove.js +0 -4
  4. package/dist/m365/aad/commands/o365group/o365group-recyclebinitem-restore.js +60 -9
  5. package/dist/m365/aad/commands.js +0 -2
  6. package/dist/m365/base/PowerAppsCommand.js +10 -0
  7. package/dist/m365/pa/commands/app/app-get.js +3 -5
  8. package/dist/m365/pa/commands/app/app-list.js +10 -9
  9. package/dist/m365/pa/commands/app/app-remove.js +3 -3
  10. package/dist/m365/pa/commands/connector/connector-export.js +3 -3
  11. package/dist/m365/pa/commands/connector/connector-list.js +10 -9
  12. package/dist/m365/pa/commands/environment/environment-get.js +3 -3
  13. package/dist/m365/pa/commands/environment/environment-list.js +4 -4
  14. package/dist/m365/planner/commands/bucket/bucket-add.js +11 -11
  15. package/dist/m365/planner/commands/bucket/bucket-get.js +13 -13
  16. package/dist/m365/planner/commands/bucket/bucket-list.js +11 -11
  17. package/dist/m365/planner/commands/bucket/bucket-remove.js +13 -13
  18. package/dist/m365/planner/commands/bucket/bucket-set.js +13 -13
  19. package/dist/m365/planner/commands/plan/plan-add.js +98 -5
  20. package/dist/m365/planner/commands/plan/plan-get.js +1 -5
  21. package/dist/m365/planner/commands/plan/plan-remove.js +1 -1
  22. package/dist/m365/planner/commands/task/task-add.js +11 -11
  23. package/dist/m365/planner/commands/task/task-get.js +10 -20
  24. package/dist/m365/planner/commands/task/task-list.js +13 -13
  25. package/dist/m365/planner/commands/task/task-remove.js +4 -19
  26. package/dist/m365/planner/commands/task/task-set.js +11 -11
  27. package/dist/m365/planner/commands.js +0 -2
  28. package/dist/m365/search/commands/externalconnection/externalconnection-get.js +69 -0
  29. package/dist/m365/search/commands.js +1 -0
  30. package/dist/m365/spo/base-permissions.js +9 -0
  31. package/dist/m365/spo/commands/customaction/customaction-get.js +32 -4
  32. package/dist/m365/spo/commands/customaction/customaction-remove.js +43 -8
  33. package/dist/m365/spo/commands/field/field-get.js +14 -5
  34. package/dist/m365/spo/commands/field/field-remove.js +19 -10
  35. package/dist/m365/spo/commands/field/field-set.js +16 -9
  36. package/dist/m365/spo/commands/group/group-add.js +96 -0
  37. package/dist/m365/spo/commands/group/group-set.js +167 -0
  38. package/dist/m365/spo/commands/hubsite/hubsite-get.js +99 -13
  39. package/dist/m365/spo/commands/list/list-list.js +1 -10
  40. package/dist/m365/spo/commands/listitem/listitem-get.js +9 -9
  41. package/dist/m365/spo/commands/listitem/listitem-list.js +9 -26
  42. package/dist/m365/spo/commands/roledefinition/RoleDefinition.js +3 -0
  43. package/dist/m365/spo/commands/roledefinition/RoleType.js +16 -0
  44. package/dist/m365/spo/commands/roledefinition/roledefinition-get.js +59 -0
  45. package/dist/m365/spo/commands/site/site-list.js +47 -16
  46. package/dist/m365/spo/commands/site/site-set.js +322 -162
  47. package/dist/m365/spo/commands/tenant/tenant-appcatalog-add.js +9 -6
  48. package/dist/m365/spo/commands.js +3 -3
  49. package/dist/m365/teams/commands/tab/tab-get.js +2 -2
  50. package/dist/m365/teams/commands/team/team-archive.js +51 -15
  51. package/dist/m365/teams/commands/team/team-clone.js +33 -7
  52. package/dist/m365/teams/commands/team/team-remove.js +47 -11
  53. package/dist/m365/teams/commands/team/team-set.js +25 -5
  54. package/dist/m365/teams/commands/team/team-unarchive.js +48 -12
  55. package/dist/utils/planner.js +6 -6
  56. package/docs/docs/cmd/aad/app/app-remove.md +0 -6
  57. package/docs/docs/cmd/aad/app/app-role-remove.md +0 -6
  58. package/docs/docs/cmd/aad/o365group/o365group-recyclebinitem-restore.md +21 -3
  59. package/docs/docs/cmd/planner/bucket/bucket-add.md +7 -7
  60. package/docs/docs/cmd/planner/bucket/bucket-get.md +8 -8
  61. package/docs/docs/cmd/planner/bucket/bucket-list.md +6 -6
  62. package/docs/docs/cmd/planner/bucket/bucket-remove.md +6 -6
  63. package/docs/docs/cmd/planner/bucket/bucket-set.md +7 -7
  64. package/docs/docs/cmd/planner/plan/plan-add.md +18 -2
  65. package/docs/docs/cmd/planner/plan/plan-get.md +0 -6
  66. package/docs/docs/cmd/planner/task/task-add.md +9 -9
  67. package/docs/docs/cmd/planner/task/task-get.md +15 -9
  68. package/docs/docs/cmd/planner/task/task-list.md +7 -7
  69. package/docs/docs/cmd/planner/task/task-set.md +7 -7
  70. package/docs/docs/cmd/search/externalconnection/externalconnection-get.md +33 -0
  71. package/docs/docs/cmd/spo/customaction/customaction-get.md +15 -2
  72. package/docs/docs/cmd/spo/customaction/customaction-remove.md +33 -2
  73. package/docs/docs/cmd/spo/field/field-get.md +6 -3
  74. package/docs/docs/cmd/spo/field/field-remove.md +9 -6
  75. package/docs/docs/cmd/spo/field/field-set.md +7 -4
  76. package/docs/docs/cmd/spo/group/group-add.md +51 -0
  77. package/docs/docs/cmd/spo/group/group-set.md +69 -0
  78. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +39 -7
  79. package/docs/docs/cmd/spo/list/list-list.md +0 -3
  80. package/docs/docs/cmd/spo/listitem/listitem-get.md +11 -2
  81. package/docs/docs/cmd/spo/listitem/listitem-list.md +8 -6
  82. package/docs/docs/cmd/spo/roledefinition/roledefinition-get.md +27 -0
  83. package/docs/docs/cmd/spo/site/site-list.md +19 -7
  84. package/docs/docs/cmd/spo/site/site-set.md +50 -6
  85. package/docs/docs/cmd/teams/tab/tab-get.md +2 -2
  86. package/docs/docs/cmd/teams/team/team-archive.md +20 -5
  87. package/docs/docs/cmd/teams/team/team-clone.md +11 -5
  88. package/docs/docs/cmd/teams/team/team-remove.md +19 -5
  89. package/docs/docs/cmd/teams/team/team-set.md +10 -4
  90. package/docs/docs/cmd/teams/team/team-unarchive.md +18 -4
  91. package/npm-shrinkwrap.json +173 -158
  92. package/package.json +13 -13
  93. package/dist/m365/spo/commands/site/site-classic-add.js +0 -333
  94. package/dist/m365/spo/commands/site/site-classic-list.js +0 -98
  95. package/dist/m365/spo/commands/site/site-classic-set.js +0 -358
  96. package/docs/docs/cmd/spo/site/site-classic-add.md +0 -93
  97. package/docs/docs/cmd/spo/site/site-classic-list.md +0 -65
  98. package/docs/docs/cmd/spo/site/site-classic-set.md +0 -99
@@ -1,9 +1,11 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ const cli_1 = require("../../../../cli");
3
4
  const request_1 = require("../../../../request");
4
5
  const utils_1 = require("../../../../utils");
5
6
  const SpoCommand_1 = require("../../../base/SpoCommand");
6
7
  const commands_1 = require("../../commands");
8
+ const SpoListItemListCommand = require("../listitem/listitem-list");
7
9
  class SpoHubSiteGetCommand extends SpoCommand_1.default {
8
10
  get name() {
9
11
  return commands_1.default.HUBSITE_GET;
@@ -11,37 +13,121 @@ class SpoHubSiteGetCommand extends SpoCommand_1.default {
11
13
  get description() {
12
14
  return 'Gets information about the specified hub site';
13
15
  }
16
+ getTelemetryProperties(args) {
17
+ const telemetryProps = super.getTelemetryProperties(args);
18
+ telemetryProps.id = typeof args.options.id !== 'undefined';
19
+ telemetryProps.title = typeof args.options.title !== 'undefined';
20
+ telemetryProps.url = typeof args.options.url !== 'undefined';
21
+ telemetryProps.includeAssociatedSites = args.options.includeAssociatedSites === true;
22
+ return telemetryProps;
23
+ }
24
+ getAssociatedSites(spoAdminUrl, hubSiteId, logger, args) {
25
+ const options = {
26
+ output: 'json',
27
+ debug: args.options.debug,
28
+ verbose: args.options.verbose,
29
+ listTitle: 'DO_NOT_DELETE_SPLIST_TENANTADMIN_AGGREGATED_SITECOLLECTIONS',
30
+ webUrl: spoAdminUrl,
31
+ filter: `HubSiteId eq '${hubSiteId}'`,
32
+ fields: 'Title,SiteUrl,SiteId'
33
+ };
34
+ return cli_1.Cli
35
+ .executeCommandWithOutput(SpoListItemListCommand, { options: Object.assign(Object.assign({}, options), { _: [] }) });
36
+ }
14
37
  commandAction(logger, args, cb) {
38
+ let hubSite;
15
39
  utils_1.spo
16
40
  .getSpoUrl(logger, this.debug)
17
41
  .then((spoUrl) => {
18
- const requestOptions = {
19
- url: `${spoUrl}/_api/hubsites/getbyid('${encodeURIComponent(args.options.id)}')`,
20
- headers: {
21
- accept: 'application/json;odata=nometadata'
22
- },
23
- responseType: 'json'
24
- };
25
- return request_1.default.get(requestOptions);
42
+ if (args.options.id) {
43
+ return this.getHubSiteById(spoUrl, args.options);
44
+ }
45
+ else {
46
+ return this.getHubSite(spoUrl, args.options);
47
+ }
26
48
  })
27
49
  .then((res) => {
28
- logger.log(res);
50
+ hubSite = res;
51
+ if (args.options.includeAssociatedSites && (args.options.output && args.options.output !== 'json')) {
52
+ throw Error('includeAssociatedSites option is only allowed with json output mode');
53
+ }
54
+ if (args.options.includeAssociatedSites !== true || args.options.output && args.options.output !== 'json') {
55
+ return Promise.resolve();
56
+ }
57
+ return utils_1.spo
58
+ .getSpoAdminUrl(logger, this.debug)
59
+ .then((spoAdminUrl) => {
60
+ return this.getAssociatedSites(spoAdminUrl, hubSite.SiteId, logger, args);
61
+ });
62
+ })
63
+ .then((associatedSitesCommandOutput) => {
64
+ if (args.options.includeAssociatedSites) {
65
+ const associatedSites = JSON.parse(associatedSitesCommandOutput.stdout);
66
+ hubSite.AssociatedSites = associatedSites.filter(s => s.SiteId !== hubSite.SiteId);
67
+ }
68
+ logger.log(hubSite);
29
69
  cb();
30
70
  }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
31
71
  }
72
+ getHubSiteById(spoUrl, options) {
73
+ const requestOptions = {
74
+ url: `${spoUrl}/_api/hubsites/getbyid('${options.id}')`,
75
+ headers: {
76
+ accept: 'application/json;odata=nometadata'
77
+ },
78
+ responseType: 'json'
79
+ };
80
+ return request_1.default.get(requestOptions);
81
+ }
82
+ getHubSite(spoUrl, options) {
83
+ const requestOptions = {
84
+ url: `${spoUrl}/_api/hubsites`,
85
+ headers: {
86
+ accept: 'application/json;odata=nometadata'
87
+ },
88
+ responseType: 'json'
89
+ };
90
+ return request_1.default
91
+ .get(requestOptions)
92
+ .then((response) => {
93
+ let hubSites = response.value;
94
+ if (options.title) {
95
+ hubSites = hubSites.filter(site => site.Title.toLocaleLowerCase() === options.title.toLocaleLowerCase());
96
+ }
97
+ else if (options.url) {
98
+ hubSites = hubSites.filter(site => site.SiteUrl.toLocaleLowerCase() === options.url.toLocaleLowerCase());
99
+ }
100
+ if (hubSites.length === 0) {
101
+ return Promise.reject(`The specified hub site ${options.title || options.url} does not exist`);
102
+ }
103
+ if (hubSites.length > 1) {
104
+ return Promise.reject(`Multiple hub sites with ${options.title || options.url} found. Please disambiguate: ${hubSites.map(site => site.SiteUrl).join(', ')}`);
105
+ }
106
+ return hubSites[0];
107
+ });
108
+ }
32
109
  options() {
33
110
  const options = [
34
- {
35
- option: '-i, --id <id>'
36
- }
111
+ { option: '-i, --id [id]' },
112
+ { option: '-t, --title [title]' },
113
+ { option: '-u, --url [url]' },
114
+ { option: '--includeAssociatedSites' }
37
115
  ];
38
116
  const parentOptions = super.options();
39
117
  return options.concat(parentOptions);
40
118
  }
119
+ optionSets() {
120
+ return [
121
+ ['id', 'title', 'url']
122
+ ];
123
+ }
41
124
  validate(args) {
42
- if (!utils_1.validation.isValidGuid(args.options.id)) {
125
+ if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
43
126
  return `${args.options.id} is not a valid GUID`;
44
127
  }
128
+ if (args.options.url) {
129
+ return utils_1.validation.isValidSharePointUrl(args.options.url);
130
+ }
45
131
  return true;
46
132
  }
47
133
  }
@@ -14,18 +14,12 @@ class SpoListListCommand extends SpoCommand_1.default {
14
14
  defaultProperties() {
15
15
  return ['Title', 'Url', 'Id'];
16
16
  }
17
- getTelemetryProperties(args) {
18
- const telemetryProps = super.getTelemetryProperties(args);
19
- telemetryProps.executeWithLimitedPermissions = !!args.options.executeWithLimitedPermissions;
20
- return telemetryProps;
21
- }
22
17
  commandAction(logger, args, cb) {
23
18
  if (this.verbose) {
24
19
  logger.logToStderr(`Retrieving all lists in site at ${args.options.webUrl}...`);
25
20
  }
26
- const suffix = args.options.executeWithLimitedPermissions ? '&$select=RootFolder/ServerRelativeUrl,*' : '';
27
21
  const requestOptions = {
28
- url: `${args.options.webUrl}/_api/web/lists?$expand=RootFolder${suffix}`,
22
+ url: `${args.options.webUrl}/_api/web/lists?$expand=RootFolder&$select=RootFolder/ServerRelativeUrl,*`,
29
23
  method: 'GET',
30
24
  headers: {
31
25
  'accept': 'application/json;odata=nometadata'
@@ -46,9 +40,6 @@ class SpoListListCommand extends SpoCommand_1.default {
46
40
  const options = [
47
41
  {
48
42
  option: '-u, --webUrl <webUrl>'
49
- },
50
- {
51
- option: '--executeWithLimitedPermissions'
52
43
  }
53
44
  ];
54
45
  const parentOptions = super.options();
@@ -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));
@@ -13,10 +13,8 @@ class SpoListItemListCommand extends SpoCommand_1.default {
13
13
  }
14
14
  getTelemetryProperties(args) {
15
15
  const telemetryProps = super.getTelemetryProperties(args);
16
- telemetryProps.id = typeof args.options.id !== 'undefined';
17
16
  telemetryProps.listId = typeof args.options.listId !== 'undefined';
18
17
  telemetryProps.listTitle = typeof args.options.listTitle !== 'undefined';
19
- telemetryProps.title = typeof args.options.title !== 'undefined';
20
18
  telemetryProps.fields = typeof args.options.fields !== 'undefined';
21
19
  telemetryProps.filter = typeof args.options.filter !== 'undefined';
22
20
  telemetryProps.pageNumber = typeof args.options.pageNumber !== 'undefined';
@@ -25,17 +23,14 @@ class SpoListItemListCommand extends SpoCommand_1.default {
25
23
  return telemetryProps;
26
24
  }
27
25
  commandAction(logger, args, cb) {
28
- if (args.options.id) {
29
- this.warn(logger, `Option 'id' is deprecated. Please use 'listId' instead.`);
30
- }
31
- if (args.options.title) {
32
- this.warn(logger, `Option 'title' is deprecated. Please use 'listTitle' instead.`);
33
- }
34
- const listIdArgument = args.options.listId || args.options.id || '';
35
- const listTitleArgument = args.options.listTitle || args.options.title || '';
26
+ const listIdArgument = args.options.listId || '';
27
+ const listTitleArgument = args.options.listTitle || '';
36
28
  let formDigestValue = '';
37
29
  const fieldsArray = args.options.fields ? args.options.fields.split(",")
38
30
  : (!args.options.output || args.options.output === "text") ? ["Title", "Id"] : [];
31
+ const fieldsWithSlash = fieldsArray.filter(item => item.includes('/'));
32
+ const fieldsToExpand = fieldsWithSlash.map(e => e.split('/')[0]);
33
+ const expandFieldsArray = fieldsToExpand.filter((item, pos) => fieldsToExpand.indexOf(item) === pos);
39
34
  const listRestUrl = listIdArgument ?
40
35
  `${args.options.webUrl}/_api/web/lists(guid'${utils_1.formatting.encodeQueryParameter(listIdArgument)}')`
41
36
  : `${args.options.webUrl}/_api/web/lists/getByTitle('${utils_1.formatting.encodeQueryParameter(listTitleArgument)}')`;
@@ -75,8 +70,9 @@ class SpoListItemListCommand extends SpoCommand_1.default {
75
70
  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
71
  const rowLimit = args.options.pageSize ? `$top=${args.options.pageSize}` : ``;
77
72
  const filter = args.options.filter ? `$filter=${encodeURIComponent(args.options.filter)}` : ``;
73
+ const fieldExpand = expandFieldsArray.length > 0 ? `&$expand=${expandFieldsArray.join(",")}` : ``;
78
74
  const fieldSelect = fieldsArray.length > 0 ?
79
- `?$select=${encodeURIComponent(fieldsArray.join(","))}&${rowLimit}&${skipToken}&${filter}` :
75
+ `?$select=${encodeURIComponent(fieldsArray.join(","))}${fieldExpand}&${rowLimit}&${skipToken}&${filter}` :
80
76
  `?${rowLimit}&${skipToken}&${filter}`;
81
77
  const requestBody = args.options.camlQuery ?
82
78
  {
@@ -107,12 +103,6 @@ class SpoListItemListCommand extends SpoCommand_1.default {
107
103
  {
108
104
  option: '-u, --webUrl <webUrl>'
109
105
  },
110
- {
111
- option: '--id [id]'
112
- },
113
- {
114
- option: '--title [title]'
115
- },
116
106
  {
117
107
  option: '-i, --listId [listId]'
118
108
  },
@@ -157,14 +147,10 @@ class SpoListItemListCommand extends SpoCommand_1.default {
157
147
  if (isValidSharePointUrl !== true) {
158
148
  return isValidSharePointUrl;
159
149
  }
160
- if (!args.options.id && !args.options.title && !args.options.listId && !args.options.listTitle) {
150
+ if (!args.options.listId && !args.options.listTitle) {
161
151
  return `Specify listId or listTitle`;
162
152
  }
163
- if (args.options.id && args.options.title) {
164
- return `Specify list id or title but not both`;
165
- }
166
- // Check if only one of the 4 options is specified
167
- if ([args.options.id, args.options.title, args.options.listId, args.options.listTitle].filter(o => o).length > 1) {
153
+ if (args.options.listId && args.options.listTitle) {
168
154
  return 'Specify listId or listTitle but not both';
169
155
  }
170
156
  if (args.options.camlQuery && args.options.fields) {
@@ -188,9 +174,6 @@ class SpoListItemListCommand extends SpoCommand_1.default {
188
174
  if (args.options.listId && !utils_1.validation.isValidGuid(args.options.listId)) {
189
175
  return `${args.options.listId} is not a valid GUID`;
190
176
  }
191
- if (args.options.id && !utils_1.validation.isValidGuid(args.options.id)) {
192
- return `${args.options.id} in option id is not a valid GUID`;
193
- }
194
177
  return true;
195
178
  }
196
179
  }
@@ -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
@@ -10,22 +10,25 @@ class SpoSiteListCommand extends SpoCommand_1.default {
10
10
  return commands_1.default.SITE_LIST;
11
11
  }
12
12
  get description() {
13
- return 'Lists modern sites of the given type';
13
+ return 'Lists sites of the given type';
14
14
  }
15
15
  getTelemetryProperties(args) {
16
16
  const telemetryProps = super.getTelemetryProperties(args);
17
- telemetryProps.siteType = args.options.type || 'TeamSite';
17
+ telemetryProps.webTemplate = args.options.webTemplate;
18
18
  telemetryProps.filter = (!(!args.options.filter)).toString();
19
- telemetryProps.deleted = args.options.deleted;
19
+ telemetryProps.includeOneDriveSites = typeof args.options.includeOneDriveSites !== 'undefined';
20
+ telemetryProps.deleted = typeof args.options.deleted !== 'undefined';
21
+ telemetryProps.siteType = args.options.type;
20
22
  return telemetryProps;
21
23
  }
22
24
  defaultProperties() {
23
25
  return ['Title', 'Url'];
24
26
  }
25
27
  commandAction(logger, args, cb) {
26
- const siteType = args.options.type || 'TeamSite';
27
- const webTemplate = siteType === 'TeamSite' ? 'GROUP#0' : 'SITEPAGEPUBLISHING#0';
28
- let spoAdminUrl;
28
+ const webTemplate = this.getWebTemplateId(args.options);
29
+ const includeOneDriveSites = args.options.includeOneDriveSites || false;
30
+ const personalSite = includeOneDriveSites === false ? '0' : '1';
31
+ let spoAdminUrl = '';
29
32
  utils_1.spo
30
33
  .getSpoAdminUrl(logger, this.debug)
31
34
  .then((_spoAdminUrl) => {
@@ -34,19 +37,19 @@ class SpoSiteListCommand extends SpoCommand_1.default {
34
37
  logger.logToStderr(`Retrieving list of site collections...`);
35
38
  }
36
39
  this.allSites = [];
37
- return this.getAllSites(spoAdminUrl, utils_1.formatting.escapeXml(args.options.filter || ''), '0', webTemplate, undefined, args.options.deleted, logger);
40
+ return this.getAllSites(spoAdminUrl, utils_1.formatting.escapeXml(args.options.filter || ''), '0', personalSite, webTemplate, undefined, args.options.deleted, logger);
38
41
  })
39
42
  .then(_ => {
40
43
  logger.log(this.allSites);
41
44
  cb();
42
45
  }, (err) => this.handleRejectedPromise(err, logger, cb));
43
46
  }
44
- getAllSites(spoAdminUrl, filter, startIndex, webTemplate, formDigest, deleted, logger) {
47
+ getAllSites(spoAdminUrl, filter, startIndex, personalSite, webTemplate, formDigest, deleted, logger) {
45
48
  return new Promise((resolve, reject) => {
46
49
  utils_1.spo
47
50
  .ensureFormDigest(spoAdminUrl, logger, formDigest, this.debug)
48
51
  .then((res) => {
49
- let requestBody = `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config_1.default.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="2" ObjectPathId="1" /><ObjectPath Id="4" ObjectPathId="3" /><Query Id="5" ObjectPathId="3"><Query SelectAllProperties="true"><Properties /></Query><ChildItemQuery SelectAllProperties="true"><Properties /></ChildItemQuery></Query></Actions><ObjectPaths><Constructor Id="1" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="3" ParentId="1" Name="GetSitePropertiesFromSharePointByFilters"><Parameters><Parameter TypeId="{b92aeee2-c92c-4b67-abcc-024e471bc140}"><Property Name="Filter" Type="String">${filter}</Property><Property Name="IncludeDetail" Type="Boolean">false</Property><Property Name="IncludePersonalSite" Type="Enum">0</Property><Property Name="StartIndex" Type="String">${startIndex}</Property><Property Name="Template" Type="String">${webTemplate}</Property></Parameter></Parameters></Method></ObjectPaths></Request>`;
52
+ let requestBody = `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config_1.default.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="2" ObjectPathId="1" /><ObjectPath Id="4" ObjectPathId="3" /><Query Id="5" ObjectPathId="3"><Query SelectAllProperties="true"><Properties /></Query><ChildItemQuery SelectAllProperties="true"><Properties /></ChildItemQuery></Query></Actions><ObjectPaths><Constructor Id="1" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="3" ParentId="1" Name="GetSitePropertiesFromSharePointByFilters"><Parameters><Parameter TypeId="{b92aeee2-c92c-4b67-abcc-024e471bc140}"><Property Name="Filter" Type="String">${filter}</Property><Property Name="IncludeDetail" Type="Boolean">false</Property><Property Name="IncludePersonalSite" Type="Enum">${personalSite}</Property><Property Name="StartIndex" Type="String">${startIndex}</Property><Property Name="Template" Type="String">${webTemplate}</Property></Parameter></Parameters></Method></ObjectPaths></Request>`;
50
53
  if (deleted) {
51
54
  requestBody = `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config_1.default.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="4" ObjectPathId="3" /><ObjectPath Id="6" ObjectPathId="5" /><Query Id="7" ObjectPathId="5"><Query SelectAllProperties="true"><Properties><Property Name="NextStartIndexFromSharePoint" ScalarProperty="true" /></Properties></Query><ChildItemQuery SelectAllProperties="true"><Properties /></ChildItemQuery></Query></Actions><ObjectPaths><Constructor Id="3" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /><Method Id="5" ParentId="3" Name="GetDeletedSitePropertiesFromSharePoint"><Parameters><Parameter Type="String">${startIndex}</Parameter></Parameters></Method></ObjectPaths></Request>`;
52
55
  }
@@ -71,7 +74,7 @@ class SpoSiteListCommand extends SpoCommand_1.default {
71
74
  this.allSites.push(...sites._Child_Items_);
72
75
  if (sites.NextStartIndexFromSharePoint) {
73
76
  this
74
- .getAllSites(spoAdminUrl, filter, sites.NextStartIndexFromSharePoint, webTemplate, formDigest, deleted, logger)
77
+ .getAllSites(spoAdminUrl, filter, sites.NextStartIndexFromSharePoint, personalSite, webTemplate, formDigest, deleted, logger)
75
78
  .then(_ => resolve(), err => reject(err));
76
79
  }
77
80
  else {
@@ -81,15 +84,37 @@ class SpoSiteListCommand extends SpoCommand_1.default {
81
84
  }, err => reject(err));
82
85
  });
83
86
  }
87
+ getWebTemplateId(options) {
88
+ if (options.webTemplate) {
89
+ return options.webTemplate;
90
+ }
91
+ if (options.includeOneDriveSites) {
92
+ return '';
93
+ }
94
+ switch (options.type) {
95
+ case "TeamSite":
96
+ return 'GROUP#0';
97
+ case "CommunicationSite":
98
+ return 'SITEPAGEPUBLISHING#0';
99
+ default:
100
+ return '';
101
+ }
102
+ }
84
103
  options() {
85
104
  const options = [
86
105
  {
87
- option: '--type [type]',
106
+ option: '-t, --type [type]',
88
107
  autocomplete: ['TeamSite', 'CommunicationSite']
89
108
  },
109
+ {
110
+ option: '--webTemplate [webTemplate]'
111
+ },
90
112
  {
91
113
  option: '-f, --filter [filter]'
92
114
  },
115
+ {
116
+ option: '--includeOneDriveSites'
117
+ },
93
118
  {
94
119
  option: '--deleted'
95
120
  }
@@ -98,11 +123,17 @@ class SpoSiteListCommand extends SpoCommand_1.default {
98
123
  return options.concat(parentOptions);
99
124
  }
100
125
  validate(args) {
101
- if (args.options.type) {
102
- if (args.options.type !== 'TeamSite' &&
103
- args.options.type !== 'CommunicationSite') {
104
- return `${args.options.type} is not a valid modern site type. Allowed types are TeamSite and CommunicationSite`;
105
- }
126
+ if (args.options.type && args.options.webTemplate) {
127
+ return 'Specify either type or webTemplate, but not both';
128
+ }
129
+ const typeValues = ['TeamSite', 'CommunicationSite'];
130
+ if (args.options.type &&
131
+ typeValues.indexOf(args.options.type) < 0) {
132
+ return `${args.options.type} is not a valid value for the type option. Allowed values are ${typeValues.join('|')}`;
133
+ }
134
+ if (args.options.includeOneDriveSites
135
+ && (args.options.type || args.options.webTemplate)) {
136
+ return 'When using includeOneDriveSites, don\'t specify the type or webTemplate options';
106
137
  }
107
138
  return true;
108
139
  }