@pnp/cli-microsoft365 10.10.0-beta.bd186ba → 10.10.0

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 (86) hide show
  1. package/.devproxy/api-specs/sharepoint-admin.yaml +67 -0
  2. package/.devproxy/api-specs/sharepoint.yaml +230 -0
  3. package/.devproxy/devproxyrc.json +48 -0
  4. package/.devproxy/generate-openapi-spec.json +24 -0
  5. package/.devproxy/spo-csom-types.json +54 -0
  6. package/.eslintrc.cjs +8 -0
  7. package/allCommands.json +1 -1
  8. package/allCommandsFull.json +1 -1
  9. package/dist/cli/cli.js +2 -2
  10. package/dist/m365/app/commands/permission/permission-add.js +8 -1
  11. package/dist/m365/base/SpoCommand.js +1 -0
  12. package/dist/m365/entra/commands/app/app-permission-add.js +5 -18
  13. package/dist/m365/entra/commands/organization/organization-set.js +104 -0
  14. package/dist/m365/entra/commands.js +1 -0
  15. package/dist/m365/file/commands/file-copy.js +2 -2
  16. package/dist/m365/file/commands/file-move.js +1 -1
  17. package/dist/m365/planner/commands/tenant/tenant-settings-list.js +0 -3
  18. package/dist/m365/spo/commands/contenttype/contenttype-add.js +3 -65
  19. package/dist/m365/spo/commands/contenttype/contenttype-field-remove.js +5 -50
  20. package/dist/m365/spo/commands/contenttype/contenttype-field-set.js +4 -48
  21. package/dist/m365/spo/commands/contenttype/contenttype-set.js +8 -58
  22. package/dist/m365/spo/commands/contenttype/contenttype-sync.js +2 -2
  23. package/dist/m365/spo/commands/folder/folder-sharinglink-add.js +1 -1
  24. package/dist/m365/spo/commands/folder/folder-sharinglink-clear.js +1 -1
  25. package/dist/m365/spo/commands/folder/folder-sharinglink-get.js +1 -1
  26. package/dist/m365/spo/commands/folder/folder-sharinglink-list.js +1 -1
  27. package/dist/m365/spo/commands/folder/folder-sharinglink-remove.js +1 -1
  28. package/dist/m365/spo/commands/folder/folder-sharinglink-set.js +1 -1
  29. package/dist/m365/spo/commands/homesite/homesite-remove.js +57 -37
  30. package/dist/m365/spo/commands/list/list-view-add.js +140 -87
  31. package/dist/m365/spo/commands/listitem/listitem-batch-set.js +3 -27
  32. package/dist/m365/spo/commands/page/Page.js +16 -1
  33. package/dist/m365/spo/commands/page/clientsidepages.js +4 -0
  34. package/dist/m365/spo/commands/page/page-add.js +1 -1
  35. package/dist/m365/spo/commands/page/page-clientsidewebpart-add.js +2 -8
  36. package/dist/m365/spo/commands/page/page-control-remove.js +99 -0
  37. package/dist/m365/spo/commands/page/page-control-set.js +1 -1
  38. package/dist/m365/spo/commands/page/page-header-set.js +9 -40
  39. package/dist/m365/spo/commands/page/page-publish.js +2 -10
  40. package/dist/m365/spo/commands/page/page-section-add.js +75 -21
  41. package/dist/m365/spo/commands/page/page-set.js +1 -1
  42. package/dist/m365/spo/commands/site/site-admin-add.js +1 -12
  43. package/dist/m365/spo/commands/site/site-set.js +2 -2
  44. package/dist/m365/spo/commands.js +1 -0
  45. package/dist/utils/entraServicePrincipal.js +21 -0
  46. package/dist/utils/md.js +3 -3
  47. package/dist/utils/spo.js +87 -3
  48. package/docs/docs/cmd/_global.mdx +1 -1
  49. package/docs/docs/cmd/entra/organization/organization-set.mdx +84 -0
  50. package/docs/docs/cmd/planner/bucket/bucket-add.mdx +19 -0
  51. package/docs/docs/cmd/planner/bucket/bucket-get.mdx +19 -0
  52. package/docs/docs/cmd/planner/bucket/bucket-list.mdx +19 -0
  53. package/docs/docs/cmd/planner/bucket/bucket-remove.mdx +21 -0
  54. package/docs/docs/cmd/planner/bucket/bucket-set.mdx +21 -0
  55. package/docs/docs/cmd/planner/plan/plan-add.mdx +19 -0
  56. package/docs/docs/cmd/planner/plan/plan-get.mdx +19 -0
  57. package/docs/docs/cmd/planner/plan/plan-list.mdx +19 -0
  58. package/docs/docs/cmd/planner/plan/plan-remove.mdx +21 -0
  59. package/docs/docs/cmd/planner/plan/plan-set.mdx +19 -0
  60. package/docs/docs/cmd/planner/roster/roster-add.mdx +19 -0
  61. package/docs/docs/cmd/planner/roster/roster-get.mdx +19 -0
  62. package/docs/docs/cmd/planner/roster/roster-member-add.mdx +19 -0
  63. package/docs/docs/cmd/planner/roster/roster-member-get.mdx +19 -0
  64. package/docs/docs/cmd/planner/roster/roster-member-list.mdx +19 -0
  65. package/docs/docs/cmd/planner/roster/roster-member-remove.mdx +21 -0
  66. package/docs/docs/cmd/planner/roster/roster-plan-list.mdx +19 -0
  67. package/docs/docs/cmd/planner/roster/roster-remove.mdx +21 -0
  68. package/docs/docs/cmd/planner/task/task-add.mdx +19 -0
  69. package/docs/docs/cmd/planner/task/task-checklistitem-add.mdx +19 -0
  70. package/docs/docs/cmd/planner/task/task-checklistitem-list.mdx +19 -0
  71. package/docs/docs/cmd/planner/task/task-checklistitem-remove.mdx +21 -0
  72. package/docs/docs/cmd/planner/task/task-get.mdx +27 -0
  73. package/docs/docs/cmd/planner/task/task-list.mdx +19 -0
  74. package/docs/docs/cmd/planner/task/task-reference-add.mdx +19 -0
  75. package/docs/docs/cmd/planner/task/task-reference-list.mdx +19 -0
  76. package/docs/docs/cmd/planner/task/task-reference-remove.mdx +21 -0
  77. package/docs/docs/cmd/planner/task/task-remove.mdx +21 -0
  78. package/docs/docs/cmd/planner/task/task-set.mdx +19 -0
  79. package/docs/docs/cmd/planner/tenant/tenant-settings-list.mdx +44 -7
  80. package/docs/docs/cmd/planner/tenant/tenant-settings-set.mdx +43 -8
  81. package/docs/docs/cmd/spo/homesite/homesite-remove.mdx +6 -3
  82. package/docs/docs/cmd/spo/list/list-view-add.mdx +53 -10
  83. package/docs/docs/cmd/spo/page/page-control-remove.mdx +56 -0
  84. package/docs/docs/cmd/spo/page/page-section-add.mdx +22 -2
  85. package/npm-shrinkwrap.json +2322 -534
  86. package/package.json +17 -14
@@ -35,7 +35,7 @@ class SpoFolderSharingLinkGetCommand extends SpoCommand {
35
35
  const relFolderUrl = await spo.getFolderServerRelativeUrl(args.options.webUrl, args.options.folderUrl, args.options.folderId);
36
36
  const absoluteFolderUrl = urlUtil.getAbsoluteUrl(args.options.webUrl, relFolderUrl);
37
37
  const folderUrl = new URL(absoluteFolderUrl);
38
- const siteId = await spo.getSiteId(args.options.webUrl);
38
+ const siteId = await spo.getSiteIdByMSGraph(args.options.webUrl);
39
39
  const drive = await driveItem.getDriveByUrl(siteId, folderUrl);
40
40
  const itemId = await driveItem.getDriveItemId(drive, folderUrl);
41
41
  const requestUrl = `https://graph.microsoft.com/v1.0/drives/${drive.id}/items/${itemId}/permissions/${args.options.id}`;
@@ -40,7 +40,7 @@ class SpoFolderSharingLinkListCommand extends SpoCommand {
40
40
  const relFolderUrl = await spo.getFolderServerRelativeUrl(args.options.webUrl, args.options.folderUrl, args.options.folderId, logger, args.options.verbose);
41
41
  const absoluteFolderUrl = urlUtil.getAbsoluteUrl(args.options.webUrl, relFolderUrl);
42
42
  const folderUrl = new URL(absoluteFolderUrl);
43
- const siteId = await spo.getSiteId(args.options.webUrl);
43
+ const siteId = await spo.getSiteIdByMSGraph(args.options.webUrl);
44
44
  const driveDetails = await drive.getDriveByUrl(siteId, folderUrl, logger, args.options.verbose);
45
45
  const itemId = await drive.getDriveItemId(driveDetails, folderUrl, logger, args.options.verbose);
46
46
  let requestUrl = `https://graph.microsoft.com/v1.0/drives/${driveDetails.id}/items/${itemId}/permissions?$filter=Link ne null`;
@@ -37,7 +37,7 @@ class SpoFolderSharingLinkRemoveCommand extends SpoCommand {
37
37
  const relFolderUrl = await spo.getFolderServerRelativeUrl(args.options.webUrl, args.options.folderUrl, args.options.folderId, logger, args.options.verbose);
38
38
  const absoluteFolderUrl = urlUtil.getAbsoluteUrl(args.options.webUrl, relFolderUrl);
39
39
  const folderUrl = new URL(absoluteFolderUrl);
40
- const siteId = await spo.getSiteId(args.options.webUrl);
40
+ const siteId = await spo.getSiteIdByMSGraph(args.options.webUrl);
41
41
  const driveDetails = await drive.getDriveByUrl(siteId, folderUrl, logger, args.options.verbose);
42
42
  const itemId = await drive.getDriveItemId(driveDetails, folderUrl, logger, args.options.verbose);
43
43
  const requestOptions = {
@@ -35,7 +35,7 @@ class SpoFolderSharingLinkSetCommand extends SpoCommand {
35
35
  const relFolderUrl = await spo.getFolderServerRelativeUrl(args.options.webUrl, args.options.folderUrl, args.options.folderId, logger, args.options.verbose);
36
36
  const absoluteFolderUrl = urlUtil.getAbsoluteUrl(args.options.webUrl, relFolderUrl);
37
37
  const folderUrl = new URL(absoluteFolderUrl);
38
- const siteId = await spo.getSiteId(args.options.webUrl);
38
+ const siteId = await spo.getSiteIdByMSGraph(args.options.webUrl);
39
39
  const driveDetails = await drive.getDriveByUrl(siteId, folderUrl, logger, args.options.verbose);
40
40
  const itemId = await drive.getDriveItemId(driveDetails, folderUrl, logger, args.options.verbose);
41
41
  const requestOptions = {
@@ -1,48 +1,62 @@
1
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
2
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
3
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
4
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
5
- };
6
- var _SpoHomeSiteRemoveCommand_instances, _SpoHomeSiteRemoveCommand_initTelemetry, _SpoHomeSiteRemoveCommand_initOptions;
1
+ import { z } from 'zod';
2
+ import { zod } from '../../../../utils/zod.js';
3
+ import { globalOptionsZod } from '../../../../Command.js';
4
+ import { validation } from '../../../../utils/validation.js';
7
5
  import { cli } from '../../../../cli/cli.js';
8
6
  import config from '../../../../config.js';
9
7
  import request from '../../../../request.js';
10
8
  import { spo } from '../../../../utils/spo.js';
11
9
  import SpoCommand from '../../../base/SpoCommand.js';
12
10
  import commands from '../../commands.js';
11
+ const options = globalOptionsZod
12
+ .extend({
13
+ url: zod.alias('u', z.string()
14
+ .refine(url => validation.isValidSharePointUrl(url) === true, url => ({
15
+ message: `'${url}' is not a valid SharePoint Online site URL.`
16
+ })).optional()),
17
+ force: zod.alias('f', z.boolean().optional())
18
+ })
19
+ .strict();
13
20
  class SpoHomeSiteRemoveCommand extends SpoCommand {
14
21
  get name() {
15
22
  return commands.HOMESITE_REMOVE;
16
23
  }
17
24
  get description() {
18
- return 'Removes the current Home Site';
25
+ return 'Removes a Home Site';
19
26
  }
20
- constructor() {
21
- super();
22
- _SpoHomeSiteRemoveCommand_instances.add(this);
23
- __classPrivateFieldGet(this, _SpoHomeSiteRemoveCommand_instances, "m", _SpoHomeSiteRemoveCommand_initTelemetry).call(this);
24
- __classPrivateFieldGet(this, _SpoHomeSiteRemoveCommand_instances, "m", _SpoHomeSiteRemoveCommand_initOptions).call(this);
27
+ get schema() {
28
+ return options;
25
29
  }
26
30
  async commandAction(logger, args) {
27
31
  const removeHomeSite = async () => {
28
32
  try {
33
+ if (this.verbose) {
34
+ await logger.logToStderr(`Removing ${args.options.url ? `'${args.options.url}' as home site` : 'the current home site'}...`);
35
+ }
29
36
  const spoAdminUrl = await spo.getSpoAdminUrl(logger, this.debug);
30
37
  const reqDigest = await spo.getRequestDigest(spoAdminUrl);
31
- const requestOptions = {
32
- url: `${spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
33
- headers: {
34
- 'X-RequestDigest': reqDigest.FormDigestValue
35
- },
36
- data: `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="28" ObjectPathId="27" /><Method Name="RemoveSPHSite" Id="29" ObjectPathId="27" /></Actions><ObjectPaths><Constructor Id="27" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /></ObjectPaths></Request>`
37
- };
38
- const res = await request.post(requestOptions);
39
- const json = JSON.parse(res);
40
- const response = json[0];
41
- if (response.ErrorInfo) {
42
- throw response.ErrorInfo.ErrorMessage;
38
+ if (args.options.url) {
39
+ await this.removeHomeSiteByUrl(args.options.url, spoAdminUrl, logger);
40
+ await logger.log(`${args.options.url} has been removed as a Home Site. It may take some time for the change to apply. Check aka.ms/homesites for details.`);
43
41
  }
44
42
  else {
45
- await logger.log(json[json.length - 1]);
43
+ await this.warn(logger, `The current way this command works is deprecated and will change in the next major release. The '--url' option will become required.`);
44
+ const requestOptions = {
45
+ url: `${spoAdminUrl}/_vti_bin/client.svc/ProcessQuery`,
46
+ headers: {
47
+ 'X-RequestDigest': reqDigest.FormDigestValue
48
+ },
49
+ data: `<Request AddExpandoFieldTypeSuffix="true" SchemaVersion="15.0.0.0" LibraryVersion="16.0.0.0" ApplicationName="${config.applicationName}" xmlns="http://schemas.microsoft.com/sharepoint/clientquery/2009"><Actions><ObjectPath Id="28" ObjectPathId="27" /><Method Name="RemoveSPHSite" Id="29" ObjectPathId="27" /></Actions><ObjectPaths><Constructor Id="27" TypeId="{268004ae-ef6b-4e9b-8425-127220d84719}" /></ObjectPaths></Request>`
50
+ };
51
+ const res = await request.post(requestOptions);
52
+ const json = JSON.parse(res);
53
+ const response = json[0];
54
+ if (response.ErrorInfo) {
55
+ throw response.ErrorInfo.ErrorMessage;
56
+ }
57
+ else {
58
+ await logger.log(json[json.length - 1]);
59
+ }
46
60
  }
47
61
  }
48
62
  catch (err) {
@@ -53,23 +67,29 @@ class SpoHomeSiteRemoveCommand extends SpoCommand {
53
67
  await removeHomeSite();
54
68
  }
55
69
  else {
56
- const result = await cli.promptForConfirmation({ message: `Are you sure you want to remove the Home Site?` });
70
+ const result = await cli.promptForConfirmation({
71
+ message: args.options.url
72
+ ? `Are you sure you want to remove '${args.options.url}' as home site?`
73
+ : `Are you sure you want to remove the current home site?`
74
+ });
57
75
  if (result) {
58
76
  await removeHomeSite();
59
77
  }
60
78
  }
61
79
  }
80
+ async removeHomeSiteByUrl(siteUrl, spoAdminUrl, logger) {
81
+ const siteAdminProperties = await spo.getSiteAdminPropertiesByUrl(siteUrl, false, logger, this.verbose);
82
+ const requestOptions = {
83
+ url: `${spoAdminUrl}/_api/SPO.Tenant/RemoveTargetedSite`,
84
+ headers: {
85
+ accept: 'application/json;odata=nometadata'
86
+ },
87
+ data: {
88
+ siteId: siteAdminProperties.SiteId
89
+ }
90
+ };
91
+ await request.post(requestOptions);
92
+ }
62
93
  }
63
- _SpoHomeSiteRemoveCommand_instances = new WeakSet(), _SpoHomeSiteRemoveCommand_initTelemetry = function _SpoHomeSiteRemoveCommand_initTelemetry() {
64
- this.telemetry.push((args) => {
65
- Object.assign(this.telemetryProperties, {
66
- force: args.options.force || false
67
- });
68
- });
69
- }, _SpoHomeSiteRemoveCommand_initOptions = function _SpoHomeSiteRemoveCommand_initOptions() {
70
- this.options.unshift({
71
- option: '-f, --force'
72
- });
73
- };
74
94
  export default new SpoHomeSiteRemoveCommand();
75
95
  //# sourceMappingURL=homesite-remove.js.map
@@ -1,53 +1,126 @@
1
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
2
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
3
- if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
4
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
5
- };
6
- var _SpoListViewAddCommand_instances, _SpoListViewAddCommand_initTelemetry, _SpoListViewAddCommand_initOptions, _SpoListViewAddCommand_initValidators, _SpoListViewAddCommand_initOptionSets;
1
+ import { globalOptionsZod } from '../../../../Command.js';
7
2
  import request from '../../../../request.js';
8
3
  import { formatting } from '../../../../utils/formatting.js';
9
4
  import { urlUtil } from '../../../../utils/urlUtil.js';
10
5
  import { validation } from '../../../../utils/validation.js';
11
6
  import SpoCommand from '../../../base/SpoCommand.js';
12
7
  import commands from '../../commands.js';
8
+ import { z } from 'zod';
9
+ import { zod } from '../../../../utils/zod.js';
10
+ const options = globalOptionsZod
11
+ .extend({
12
+ webUrl: zod.alias('u', z.string()
13
+ .refine(url => validation.isValidSharePointUrl(url) === true, {
14
+ message: 'webUrl is not a valid SharePoint site URL.'
15
+ })),
16
+ listId: z.string()
17
+ .refine(id => validation.isValidGuid(id), id => ({
18
+ message: `'${id}' is not a valid GUID.`
19
+ })).optional(),
20
+ listTitle: z.string().optional(),
21
+ listUrl: z.string().optional(),
22
+ title: z.string().min(1, 'Cannot be empty.'),
23
+ fields: z.string().optional(),
24
+ viewQuery: z.string().optional(),
25
+ personal: z.boolean().optional(),
26
+ default: z.boolean().optional(),
27
+ paged: z.boolean().optional(),
28
+ rowLimit: z.number().int().positive().optional(),
29
+ customFormatter: z.string()
30
+ .refine(formatter => {
31
+ try {
32
+ JSON.parse(formatter);
33
+ return true;
34
+ }
35
+ catch {
36
+ return false;
37
+ }
38
+ }, {
39
+ message: 'Custom formatter must be a valid JSON string.'
40
+ })
41
+ .optional(),
42
+ type: z.enum(['list', 'calendar', 'gallery', 'kanban']).optional(),
43
+ calendarStartDateField: z.string().min(1, 'Cannot be empty.').optional(),
44
+ calendarEndDateField: z.string().min(1, 'Cannot be empty.').optional(),
45
+ calendarTitleField: z.string().min(1, 'Cannot be empty.').optional(),
46
+ calendarSubTitleField: z.string().min(1, 'Cannot be empty.').optional(),
47
+ calendarDefaultLayout: z.enum(['month', 'week', 'workWeek', 'day']).optional(),
48
+ kanbanBucketField: z.string().min(1, 'Cannot be empty.').optional()
49
+ })
50
+ .strict();
13
51
  class SpoListViewAddCommand extends SpoCommand {
14
52
  get name() {
15
53
  return commands.LIST_VIEW_ADD;
16
54
  }
17
55
  get description() {
18
- return 'Adds a new view to a SharePoint list.';
56
+ return 'Adds a new view to a SharePoint list';
19
57
  }
20
- constructor() {
21
- super();
22
- _SpoListViewAddCommand_instances.add(this);
23
- __classPrivateFieldGet(this, _SpoListViewAddCommand_instances, "m", _SpoListViewAddCommand_initTelemetry).call(this);
24
- __classPrivateFieldGet(this, _SpoListViewAddCommand_instances, "m", _SpoListViewAddCommand_initOptions).call(this);
25
- __classPrivateFieldGet(this, _SpoListViewAddCommand_instances, "m", _SpoListViewAddCommand_initValidators).call(this);
26
- __classPrivateFieldGet(this, _SpoListViewAddCommand_instances, "m", _SpoListViewAddCommand_initOptionSets).call(this);
58
+ get schema() {
59
+ return options;
60
+ }
61
+ getRefinedSchema(schema) {
62
+ return schema
63
+ .refine((options) => [options.listId, options.listTitle, options.listUrl].filter(o => o !== undefined).length === 1, {
64
+ message: 'Use one of the following options: listId, listTitle, or listUrl.'
65
+ })
66
+ .refine((options) => !options.personal || !options.default, {
67
+ message: 'Default view cannot be a personal view.'
68
+ })
69
+ .refine((options) => options.type !== 'calendar' || [options.calendarStartDateField, options.calendarEndDateField, options.calendarTitleField].filter(o => o === undefined).length === 0, {
70
+ message: 'When type is calendar, do specify calendarStartDateField, calendarEndDateField, and calendarTitleField.'
71
+ })
72
+ .refine((options) => options.type === 'calendar' || [options.calendarStartDateField, options.calendarEndDateField, options.calendarTitleField].filter(o => o === undefined).length === 3, {
73
+ message: 'When type is not calendar, do not specify calendarStartDateField, calendarEndDateField, and calendarTitleField.'
74
+ })
75
+ .refine((options) => options.type !== 'kanban' || options.kanbanBucketField !== undefined, {
76
+ message: 'When type is kanban, do specify kanbanBucketField.'
77
+ })
78
+ .refine((options) => options.type === 'kanban' || options.kanbanBucketField === undefined, {
79
+ message: 'When type is not kanban, do not specify kanbanBucketField.'
80
+ })
81
+ .refine((options) => options.type === 'calendar' || options.fields !== undefined, {
82
+ message: 'When type is not calendar, do specify fields.'
83
+ });
27
84
  }
28
85
  async commandAction(logger, args) {
29
- const requestOptions = {
30
- url: this.getRestUrl(args.options),
31
- headers: {
32
- 'content-type': 'application/json;odata=verbose',
33
- accept: 'application/json;odata=nometadata'
34
- },
35
- responseType: 'json',
36
- data: {
37
- parameters: {
38
- Title: args.options.title,
39
- ViewFields: {
40
- results: args.options.fields.split(',')
41
- },
42
- Query: args.options.viewQuery,
43
- PersonalView: !!args.options.personal,
44
- SetAsDefaultView: !!args.options.default,
45
- Paged: !!args.options.paged,
46
- RowLimit: args.options.rowLimit ? +args.options.rowLimit : 30
47
- }
48
- }
49
- };
50
86
  try {
87
+ if (this.verbose) {
88
+ await logger.logToStderr(`Adding view '${args.options.title}' to list...`);
89
+ }
90
+ let apiUrl = `${args.options.webUrl}/_api/web/`;
91
+ if (args.options.listId) {
92
+ apiUrl += `lists(guid'${formatting.encodeQueryParameter(args.options.listId)}')`;
93
+ }
94
+ else if (args.options.listTitle) {
95
+ apiUrl += `lists/getByTitle('${formatting.encodeQueryParameter(args.options.listTitle)}')`;
96
+ }
97
+ else if (args.options.listUrl) {
98
+ apiUrl += `GetList('${formatting.encodeQueryParameter(urlUtil.getServerRelativePath(args.options.webUrl, args.options.listUrl))}')`;
99
+ }
100
+ apiUrl += '/views/add';
101
+ const requestOptions = {
102
+ url: apiUrl,
103
+ headers: {
104
+ 'content-type': 'application/json;odata=verbose',
105
+ accept: 'application/json;odata=nometadata'
106
+ },
107
+ responseType: 'json',
108
+ data: {
109
+ parameters: {
110
+ Title: args.options.title,
111
+ ViewFields: {
112
+ results: args.options.fields?.split(',').map(f => f.trim()) ?? []
113
+ },
114
+ Query: args.options.viewQuery,
115
+ PersonalView: !!args.options.personal,
116
+ SetAsDefaultView: !!args.options.default,
117
+ Paged: !!args.options.paged,
118
+ RowLimit: args.options.rowLimit ?? 30,
119
+ CustomFormatter: args.options.customFormatter
120
+ }
121
+ }
122
+ };
123
+ this.setViewTypeSpecificParameters(args.options, requestOptions.data.parameters);
51
124
  const result = await request.post(requestOptions);
52
125
  await logger.log(result);
53
126
  }
@@ -55,62 +128,42 @@ class SpoListViewAddCommand extends SpoCommand {
55
128
  this.handleRejectedODataJsonPromise(err);
56
129
  }
57
130
  }
58
- getRestUrl(options) {
59
- let result = `${options.webUrl}/_api/web/`;
60
- if (options.listId) {
61
- result += `lists(guid'${formatting.encodeQueryParameter(options.listId)}')`;
62
- }
63
- else if (options.listTitle) {
64
- result += `lists/getByTitle('${formatting.encodeQueryParameter(options.listTitle)}')`;
65
- }
66
- else if (options.listUrl) {
67
- result += `GetList('${formatting.encodeQueryParameter(urlUtil.getServerRelativePath(options.webUrl, options.listUrl))}')`;
68
- }
69
- result += '/views/add';
70
- return result;
71
- }
72
- }
73
- _SpoListViewAddCommand_instances = new WeakSet(), _SpoListViewAddCommand_initTelemetry = function _SpoListViewAddCommand_initTelemetry() {
74
- this.telemetry.push((args) => {
75
- Object.assign(this.telemetryProperties, {
76
- listId: typeof args.options.listId !== 'undefined',
77
- listTitle: typeof args.options.listTitle !== 'undefined',
78
- listUrl: typeof args.options.listUrl !== 'undefined',
79
- title: typeof args.options.title !== 'undefined',
80
- viewQuery: typeof args.options.viewQuery !== 'undefined',
81
- personal: !!args.options.personal,
82
- default: !!args.options.default,
83
- orderedView: !!args.options.orderedView,
84
- paged: !!args.options.paged,
85
- rowLimit: typeof args.options.rowLimit !== 'undefined'
86
- });
87
- });
88
- }, _SpoListViewAddCommand_initOptions = function _SpoListViewAddCommand_initOptions() {
89
- this.options.unshift({ option: '-u, --webUrl <webUrl>' }, { option: '--listId [listId]' }, { option: '--listTitle [listTitle]' }, { option: '--listUrl [listUrl]' }, { option: '--title <title>' }, { option: '--fields <fields>' }, { option: '--viewQuery [viewQuery]' }, { option: '--personal' }, { option: '--default' }, { option: '--paged' }, { option: '--rowLimit [rowLimit]' });
90
- }, _SpoListViewAddCommand_initValidators = function _SpoListViewAddCommand_initValidators() {
91
- this.validators.push(async (args) => {
92
- const webUrlValidation = validation.isValidSharePointUrl(args.options.webUrl);
93
- if (webUrlValidation !== true) {
94
- return webUrlValidation;
131
+ setViewTypeSpecificParameters(options, requestBody) {
132
+ if (options.type === 'calendar') {
133
+ const defaultView = options.calendarDefaultLayout ?? 'month';
134
+ const titleField = options.calendarTitleField;
135
+ const subTitleField = options.calendarSubTitleField ?? '';
136
+ // Following fields are required for calendar view, order is important
137
+ const viewFields = [options.calendarStartDateField, options.calendarEndDateField, titleField, subTitleField].filter(field => field !== '');
138
+ // Add any additional fields specified by the user
139
+ const extraViewFields = requestBody.ViewFields.results.filter((field) => !viewFields.includes(field.trim()));
140
+ viewFields.push(...extraViewFields);
141
+ requestBody.CalendarViewStyles = `<CalendarViewStyle Title="Day" Type="day" Template="CalendarViewdayChrome" Sequence="1" Default="${String(defaultView === 'day').toUpperCase()}" /><CalendarViewStyle Title="Week" Type="week" Template="CalendarViewweekChrome" Sequence="2" Default="${String(defaultView === 'week').toUpperCase()}" /><CalendarViewStyle Title="Month" Type="month" Template="CalendarViewmonthChrome" Sequence="3" Default="${String(defaultView === 'month').toUpperCase()}" /><CalendarViewStyle Title="Work week" Type="workweek" Template="CalendarViewweekChrome" Sequence="4" Default="${String(defaultView === 'workWeek').toUpperCase()}" />`;
142
+ requestBody.Query = `<Where><DateRangesOverlap><FieldRef Name='${options.calendarStartDateField}' /><FieldRef Name='${options.calendarEndDateField}' /><Value Type='DateTime'><Month /></Value></DateRangesOverlap></Where>`;
143
+ requestBody.ViewData = `<FieldRef Name="${titleField}" Type="CalendarMonthTitle" /><FieldRef Name="${titleField}" Type="CalendarWeekTitle" /><FieldRef Name="${subTitleField}" Type="CalendarWeekLocation" /><FieldRef Name="${titleField}" Type="CalendarDayTitle" /><FieldRef Name="${subTitleField}" Type="CalendarDayLocation" />`;
144
+ requestBody.ViewFields.results = viewFields;
145
+ requestBody.ViewType2 = 'MODERNCALENDAR';
146
+ return;
95
147
  }
96
- if (args.options.listId && !validation.isValidGuid(args.options.listId)) {
97
- return `${args.options.listId} in option listId is not a valid GUID`;
148
+ if (options.type === 'gallery') {
149
+ requestBody.ViewType2 = 'TILES';
150
+ return;
98
151
  }
99
- if (args.options.rowLimit !== undefined) {
100
- if (isNaN(args.options.rowLimit)) {
101
- return `${args.options.rowLimit} is not a number`;
152
+ if (options.type === 'kanban') {
153
+ // Add the bucket field to the view fields if it is not already included
154
+ const viewFields = requestBody.ViewFields.results;
155
+ if (!viewFields.includes(options.kanbanBucketField)) {
156
+ viewFields.push(options.kanbanBucketField);
102
157
  }
103
- if (+args.options.rowLimit <= 0) {
104
- return 'rowLimit option must be greater than 0.';
158
+ if (!options.customFormatter) {
159
+ requestBody.CustomFormatter = '{}';
105
160
  }
161
+ requestBody.ViewData = `<FieldRef Name="${options.kanbanBucketField}" Type="KanbanPivotColumn" />`;
162
+ requestBody.ViewType2 = 'KANBAN';
163
+ return;
106
164
  }
107
- if (args.options.personal && args.options.default) {
108
- return 'Default view cannot be a personal view.';
109
- }
110
- return true;
111
- });
112
- }, _SpoListViewAddCommand_initOptionSets = function _SpoListViewAddCommand_initOptionSets() {
113
- this.optionSets.push({ options: ['listId', 'listTitle', 'listUrl'] });
114
- };
165
+ }
166
+ ;
167
+ }
115
168
  export default new SpoListViewAddCommand();
116
169
  //# sourceMappingURL=list-view-add.js.map
@@ -10,7 +10,6 @@ import request from '../../../../request.js';
10
10
  import { formatting } from '../../../../utils/formatting.js';
11
11
  import { odata } from '../../../../utils/odata.js';
12
12
  import { spo } from '../../../../utils/spo.js';
13
- import { urlUtil } from '../../../../utils/urlUtil.js';
14
13
  import { validation } from '../../../../utils/validation.js';
15
14
  import SpoCommand from '../../../base/SpoCommand.js';
16
15
  import commands from '../../commands.js';
@@ -41,7 +40,9 @@ class SpoListItemBatchSetCommand extends SpoCommand {
41
40
  if (!jsonContent[0].hasOwnProperty(idColumn)) {
42
41
  throw `The specified value for idColumn does not exist in the array. Specified idColumn is '${args.options.idColumn || 'ID'}'. Please specify the correct value.`;
43
42
  }
44
- const listId = await this.getListId(args.options, logger);
43
+ const listId = args.options.listId ?
44
+ args.options.listId :
45
+ await spo.getListId(args.options.webUrl, args.options.listTitle, args.options.listUrl, logger, this.verbose);
45
46
  const fields = await this.getListFields(args.options, listId, jsonContent, idColumn, logger);
46
47
  const userFields = fields.filter(field => field.TypeAsString === 'UserMulti' || field.TypeAsString === 'User');
47
48
  const resolvedUsers = await this.getUsersFromCsv(args.options.webUrl, jsonContent, userFields);
@@ -151,31 +152,6 @@ class SpoListItemBatchSetCommand extends SpoCommand {
151
152
  }
152
153
  return fields;
153
154
  }
154
- async getListId(options, logger) {
155
- if (options.listId) {
156
- return options.listId;
157
- }
158
- if (this.verbose) {
159
- await logger.logToStderr('Retrieving list id');
160
- }
161
- let listUrl = `${options.webUrl}/_api/web`;
162
- if (options.listTitle) {
163
- listUrl += `/lists/getByTitle('${formatting.encodeQueryParameter(options.listTitle)}')`;
164
- }
165
- else {
166
- const listServerRelativeUrl = urlUtil.getServerRelativePath(options.webUrl, options.listUrl);
167
- listUrl += `/GetList('${formatting.encodeQueryParameter(listServerRelativeUrl)}')`;
168
- }
169
- const requestOptions = {
170
- url: `${listUrl}?$select=Id`,
171
- headers: {
172
- 'accept': 'application/json;odata=nometadata'
173
- },
174
- responseType: 'json'
175
- };
176
- const listResult = await request.get(requestOptions);
177
- return listResult.Id;
178
- }
179
155
  async getUsersFromCsv(webUrl, jsonContent, userFields) {
180
156
  if (userFields.length === 0) {
181
157
  return [];
@@ -25,7 +25,7 @@ export class Page {
25
25
  }
26
26
  return ClientSidePage.fromHtml(res.ListItemAllFields.CanvasContent1);
27
27
  }
28
- static async checkout(name, webUrl, logger, debug, verbose) {
28
+ static async checkout(name, webUrl, logger, verbose) {
29
29
  if (verbose) {
30
30
  await logger.log(`Checking out ${name} page...`);
31
31
  }
@@ -77,6 +77,21 @@ export class Page {
77
77
  columns: section.columns.map(column => this.getColumnsInformation(column, isJSONOutput))
78
78
  };
79
79
  }
80
+ /**
81
+ * Publish a modern page in SharePoint Online
82
+ * @param webUrl Absolute URL of the SharePoint site where the page is located
83
+ * @param pageName List relative url of the page to publish
84
+ */
85
+ static async publishPage(webUrl, pageName) {
86
+ const filePath = `${urlUtil.getServerRelativeSiteUrl(webUrl)}/SitePages/${pageName}`;
87
+ const requestOptions = {
88
+ url: `${webUrl}/_api/web/GetFileByServerRelativePath(DecodedUrl='${formatting.encodeQueryParameter(filePath)}')/Publish()`,
89
+ headers: {
90
+ accept: 'application/json;odata=nometadata'
91
+ }
92
+ };
93
+ await request.post(requestOptions);
94
+ }
80
95
  static getPageNameWithExtension(name) {
81
96
  let pageName = name;
82
97
  if (pageName.indexOf('.aspx') < 0) {
@@ -30,6 +30,10 @@ export var CanvasSectionTemplate;
30
30
  /// Vertical
31
31
  /// </summary>
32
32
  CanvasSectionTemplate[CanvasSectionTemplate["Vertical"] = 6] = "Vertical";
33
+ /// <summary>
34
+ /// Flexible
35
+ /// </summary>
36
+ CanvasSectionTemplate[CanvasSectionTemplate["Flexible"] = 7] = "Flexible";
33
37
  })(CanvasSectionTemplate || (CanvasSectionTemplate = {}));
34
38
  /**
35
39
  * Section background shading
@@ -63,7 +63,7 @@ class SpoPageAddCommand extends SpoCommand {
63
63
  itemId = template.UniqueId;
64
64
  const file = await spo.getFileAsListItemByUrl(args.options.webUrl, serverRelativeFileUrl, logger, this.verbose);
65
65
  const listItemId = file.Id;
66
- const pageProps = await Page.checkout(pageName, args.options.webUrl, logger, this.debug, this.verbose);
66
+ const pageProps = await Page.checkout(pageName, args.options.webUrl, logger, this.verbose);
67
67
  if (pageProps) {
68
68
  pageId = pageProps.Id;
69
69
  bannerImageUrl = pageProps.BannerImageUrl;
@@ -11,6 +11,7 @@ import { validation } from '../../../../utils/validation.js';
11
11
  import SpoCommand from '../../../base/SpoCommand.js';
12
12
  import commands from '../../commands.js';
13
13
  import { StandardWebPartUtils } from '../../StandardWebPartTypes.js';
14
+ import { Page } from './Page.js';
14
15
  class SpoPageClientSideWebPartAddCommand extends SpoCommand {
15
16
  get name() {
16
17
  return commands.PAGE_CLIENTSIDEWEBPART_ADD;
@@ -52,14 +53,7 @@ class SpoPageClientSideWebPartAddCommand extends SpoCommand {
52
53
  };
53
54
  let page = await request.get(requestOptions);
54
55
  if (!page.IsPageCheckedOutToCurrentUser) {
55
- const requestOptions = {
56
- url: `${args.options.webUrl}/_api/sitepages/pages/GetByUrl('sitepages/${formatting.encodeQueryParameter(pageFullName)}')/checkoutpage`,
57
- headers: {
58
- 'accept': 'application/json;odata=nometadata'
59
- },
60
- responseType: 'json'
61
- };
62
- page = await request.post(requestOptions);
56
+ page = await Page.checkout(pageFullName, args.options.webUrl, logger, this.verbose);
63
57
  }
64
58
  if (page) {
65
59
  layoutWebpartsContent = page.LayoutWebpartsContent;