@pnp/cli-microsoft365 5.0.0-beta.5a92c19 → 5.0.0-beta.5f22572

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 (28) hide show
  1. package/dist/appInsights.js +2 -0
  2. package/dist/m365/aad/commands/app/app-add.js +58 -5
  3. package/dist/m365/aad/commands/o365group/o365group-add.js +56 -50
  4. package/dist/m365/base/M365RcJson.js +3 -0
  5. package/dist/m365/file/commands/file-list.js +181 -0
  6. package/dist/m365/file/commands.js +2 -1
  7. package/dist/m365/search/commands/externalconnection/externalconnection-add.js +99 -0
  8. package/dist/m365/search/commands.js +7 -0
  9. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.13.1.js +53 -0
  10. package/dist/m365/spfx/commands/project/project-upgrade.js +2 -1
  11. package/dist/m365/spfx/commands/spfx-doctor.js +19 -0
  12. package/dist/m365/spo/commands/contenttype/contenttype-list.js +52 -0
  13. package/dist/m365/spo/commands/list/list-get.js +6 -2
  14. package/dist/m365/spo/commands/page/Page.js +3 -1
  15. package/dist/m365/spo/commands/page/page-add.js +7 -10
  16. package/dist/m365/spo/commands/page/page-set.js +7 -10
  17. package/dist/m365/spo/commands.js +2 -1
  18. package/docs/docs/cmd/aad/app/app-add.md +11 -0
  19. package/docs/docs/cmd/aad/o365group/o365group-add.md +1 -0
  20. package/docs/docs/cmd/file/file-list.md +46 -0
  21. package/docs/docs/cmd/search/externalconnection/externalconnection-add.md +43 -0
  22. package/docs/docs/cmd/spfx/project/project-upgrade.md +1 -1
  23. package/docs/docs/cmd/spo/contenttype/contenttype-list.md +33 -0
  24. package/docs/docs/cmd/spo/list/list-get.md +9 -0
  25. package/docs/docs/cmd/spo/page/page-add.md +2 -2
  26. package/docs/docs/cmd/spo/page/page-set.md +3 -3
  27. package/npm-shrinkwrap.json +73 -40
  28. package/package.json +3 -2
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const request_1 = require("../../../../request");
4
+ const SpoCommand_1 = require("../../../base/SpoCommand");
5
+ const commands_1 = require("../../commands");
6
+ class SpoContentTypeListCommand extends SpoCommand_1.default {
7
+ get name() {
8
+ return commands_1.default.CONTENTTYPE_LIST;
9
+ }
10
+ get description() {
11
+ return 'Lists all available content types in the specified site';
12
+ }
13
+ defaultProperties() {
14
+ return ['StringId', 'Name', 'Hidden', 'ReadOnly', 'Sealed'];
15
+ }
16
+ commandAction(logger, args, cb) {
17
+ let requestUrl = `${args.options.webUrl}/_api/web/ContentTypes`;
18
+ if (args.options.category) {
19
+ requestUrl += `?$filter=Group eq '${encodeURIComponent(args.options.category)}'`;
20
+ }
21
+ const requestOptions = {
22
+ url: requestUrl,
23
+ headers: {
24
+ accept: 'application/json;odata=nometadata'
25
+ },
26
+ responseType: 'json'
27
+ };
28
+ request_1.default
29
+ .get(requestOptions)
30
+ .then((res) => {
31
+ logger.log(res.value);
32
+ cb();
33
+ }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
34
+ }
35
+ options() {
36
+ const options = [
37
+ {
38
+ option: '-u, --webUrl <webUrl>'
39
+ },
40
+ {
41
+ option: '-c, --category [category]'
42
+ }
43
+ ];
44
+ const parentOptions = super.options();
45
+ return options.concat(parentOptions);
46
+ }
47
+ validate(args) {
48
+ return SpoCommand_1.default.isValidSharePointUrl(args.options.webUrl);
49
+ }
50
+ }
51
+ module.exports = new SpoContentTypeListCommand();
52
+ //# sourceMappingURL=contenttype-list.js.map
@@ -16,6 +16,7 @@ class SpoListGetCommand extends SpoCommand_1.default {
16
16
  telemetryProps.id = (!(!args.options.id)).toString();
17
17
  telemetryProps.title = (!(!args.options.title)).toString();
18
18
  telemetryProps.properties = (!(!args.options.properties)).toString();
19
+ telemetryProps.withPermissions = typeof args.options.withPermissions !== 'undefined';
19
20
  return telemetryProps;
20
21
  }
21
22
  commandAction(logger, args, cb) {
@@ -29,10 +30,10 @@ class SpoListGetCommand extends SpoCommand_1.default {
29
30
  else {
30
31
  requestUrl = `${args.options.webUrl}/_api/web/lists/GetByTitle('${encodeURIComponent(args.options.title)}')`;
31
32
  }
32
- const propertiesSelect = args.options.properties ? `?$select=${encodeURIComponent(args.options.properties)}` : ``;
33
+ let propertiesSelect = args.options.properties ? `?$select=${encodeURIComponent(args.options.properties)}` : ``;
34
+ propertiesSelect += args.options.withPermissions ? `${args.options.properties ? '&' : '?'}$expand=HasUniqueRoleAssignments,RoleAssignments/Member,RoleAssignments/RoleDefinitionBindings` : ``;
33
35
  const requestOptions = {
34
36
  url: requestUrl + propertiesSelect,
35
- method: 'GET',
36
37
  headers: {
37
38
  'accept': 'application/json;odata=nometadata'
38
39
  },
@@ -58,6 +59,9 @@ class SpoListGetCommand extends SpoCommand_1.default {
58
59
  },
59
60
  {
60
61
  option: '-p, --properties [properties]'
62
+ },
63
+ {
64
+ option: '--withPermissions'
61
65
  }
62
66
  ];
63
67
  const parentOptions = super.options();
@@ -1,10 +1,12 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Page = void 0;
3
+ exports.Page = exports.supportedPromoteAs = exports.supportedPageLayouts = void 0;
4
4
  const request_1 = require("../../../../request");
5
5
  const Utils_1 = require("../../../../Utils");
6
6
  const clientsidepages_1 = require("./clientsidepages");
7
7
  const pageMethods_1 = require("./pageMethods");
8
+ exports.supportedPageLayouts = ['Article', 'Home', 'SingleWebPartAppPage', 'RepostPage', 'HeaderlessSearchResults', 'Spaces', 'Topic'];
9
+ exports.supportedPromoteAs = ['HomePage', 'NewsPage', 'Template'];
8
10
  class Page {
9
11
  static getPage(name, webUrl, logger, debug, verbose) {
10
12
  return new Promise((resolve, reject) => {
@@ -284,11 +284,11 @@ class SpoPageAddCommand extends SpoCommand_1.default {
284
284
  },
285
285
  {
286
286
  option: '-l, --layoutType [layoutType]',
287
- autocomplete: ['Article', 'Home']
287
+ autocomplete: Page_1.supportedPageLayouts
288
288
  },
289
289
  {
290
290
  option: '-p, --promoteAs [promoteAs]',
291
- autocomplete: ['HomePage', 'NewsPage', 'Template']
291
+ autocomplete: Page_1.supportedPromoteAs
292
292
  },
293
293
  {
294
294
  option: '--commentsEnabled'
@@ -312,20 +312,17 @@ class SpoPageAddCommand extends SpoCommand_1.default {
312
312
  return isValidSharePointUrl;
313
313
  }
314
314
  if (args.options.layoutType &&
315
- args.options.layoutType !== 'Article' &&
316
- args.options.layoutType !== 'Home') {
317
- return `${args.options.layoutType} is not a valid option for layoutType. Allowed values Article|Home`;
315
+ Page_1.supportedPageLayouts.indexOf(args.options.layoutType) < 0) {
316
+ return `${args.options.layoutType} is not a valid option for layoutType. Allowed values ${Page_1.supportedPageLayouts.join(', ')}`;
318
317
  }
319
318
  if (args.options.promoteAs &&
320
- args.options.promoteAs !== 'HomePage' &&
321
- args.options.promoteAs !== 'NewsPage' &&
322
- args.options.promoteAs !== 'Template') {
323
- return `${args.options.promoteAs} is not a valid option for promoteAs. Allowed values HomePage|NewsPage|Template`;
319
+ Page_1.supportedPromoteAs.indexOf(args.options.promoteAs) < 0) {
320
+ return `${args.options.promoteAs} is not a valid option for promoteAs. Allowed values ${Page_1.supportedPromoteAs.join(', ')}`;
324
321
  }
325
322
  if (args.options.promoteAs === 'HomePage' && args.options.layoutType !== 'Home') {
326
323
  return 'You can only promote home pages as site home page';
327
324
  }
328
- if (args.options.promoteAs === 'NewsPage' && args.options.layoutType === 'Home') {
325
+ if (args.options.promoteAs === 'NewsPage' && args.options.layoutType && args.options.layoutType !== 'Article') {
329
326
  return 'You can only promote article pages as news article';
330
327
  }
331
328
  return true;
@@ -283,11 +283,11 @@ class SpoPageSetCommand extends SpoCommand_1.default {
283
283
  },
284
284
  {
285
285
  option: '-l, --layoutType [layoutType]',
286
- autocomplete: ['Article', 'Home']
286
+ autocomplete: Page_1.supportedPageLayouts
287
287
  },
288
288
  {
289
289
  option: '-p, --promoteAs [promoteAs]',
290
- autocomplete: ['HomePage', 'NewsPage', 'Template']
290
+ autocomplete: Page_1.supportedPromoteAs
291
291
  },
292
292
  {
293
293
  option: '--commentsEnabled [commentsEnabled]',
@@ -315,20 +315,17 @@ class SpoPageSetCommand extends SpoCommand_1.default {
315
315
  return isValidSharePointUrl;
316
316
  }
317
317
  if (args.options.layoutType &&
318
- args.options.layoutType !== 'Article' &&
319
- args.options.layoutType !== 'Home') {
320
- return `${args.options.layoutType} is not a valid option for layoutType. Allowed values Article|Home`;
318
+ Page_1.supportedPageLayouts.indexOf(args.options.layoutType) < 0) {
319
+ return `${args.options.layoutType} is not a valid option for layoutType. Allowed values ${Page_1.supportedPageLayouts.join(', ')}`;
321
320
  }
322
321
  if (args.options.promoteAs &&
323
- args.options.promoteAs !== 'HomePage' &&
324
- args.options.promoteAs !== 'NewsPage' &&
325
- args.options.promoteAs !== 'Template') {
326
- return `${args.options.promoteAs} is not a valid option for promoteAs. Allowed values HomePage|NewsPage|Template`;
322
+ Page_1.supportedPromoteAs.indexOf(args.options.promoteAs) < 0) {
323
+ return `${args.options.promoteAs} is not a valid option for promoteAs. Allowed values ${Page_1.supportedPromoteAs.join(', ')}`;
327
324
  }
328
325
  if (args.options.promoteAs === 'HomePage' && args.options.layoutType !== 'Home') {
329
326
  return 'You can only promote home pages as site home page';
330
327
  }
331
- if (args.options.promoteAs === 'NewsPage' && args.options.layoutType === 'Home') {
328
+ if (args.options.promoteAs === 'NewsPage' && args.options.layoutType && args.options.layoutType !== 'Article') {
332
329
  return 'You can only promote article pages as news article';
333
330
  }
334
331
  if (typeof args.options.commentsEnabled !== 'undefined' &&
@@ -22,9 +22,10 @@ exports.default = {
22
22
  CDN_POLICY_SET: `${prefix} cdn policy set`,
23
23
  CDN_SET: `${prefix} cdn set`,
24
24
  CONTENTTYPE_ADD: `${prefix} contenttype add`,
25
- CONTENTTYPE_GET: `${prefix} contenttype get`,
26
25
  CONTENTTYPE_FIELD_REMOVE: `${prefix} contenttype field remove`,
27
26
  CONTENTTYPE_FIELD_SET: `${prefix} contenttype field set`,
27
+ CONTENTTYPE_GET: `${prefix} contenttype get`,
28
+ CONTENTTYPE_LIST: `${prefix} contenttype list`,
28
29
  CONTENTTYPE_REMOVE: `${prefix} contenttype remove`,
29
30
  CONTENTTYPEHUB_GET: `${prefix} contenttypehub get`,
30
31
  CUSTOMACTION_ADD: `${prefix} customaction add`,
@@ -52,6 +52,9 @@ m365 aad app add [options]
52
52
  `--manifest [manifest]`
53
53
  : Azure AD app manifest as retrieved from the Azure Portal to create the app registration from
54
54
 
55
+ `--save`
56
+ : Use to store the information about the created app in a local file
57
+
55
58
  --8<-- "docs/cmd/_global.md"
56
59
 
57
60
  ## Remarks
@@ -80,6 +83,8 @@ When using the `withSecret` option, this command will automatically generate a s
80
83
 
81
84
  After creating the Azure AD app registration, this command returns the app ID and object ID of the created app registration. If you used the `withSecret` option, it will also return the generated secret.
82
85
 
86
+ If you want to store the information about the created Azure AD app registration, use the `--save` option. This is useful when you build solutions connected to Microsoft 365 and want to easily manage app registrations used with your solution. When you use the `--save` option, after you create the app registration, the command will write its ID and name to the `.m365rc.json` file in the current directory. If the file already exists, it will add the information about the to it, allowing you to track multiple apps. If the file doesn't exist, the command will create it.
87
+
83
88
  ## Examples
84
89
 
85
90
  Create new Azure AD app registration with the specified name
@@ -141,3 +146,9 @@ Create new Azure AD app registration with Application ID URI set to a value that
141
146
  ```sh
142
147
  m365 aad app add --name 'My AAD app' --uri api://caf406b91cd4.ngrok.io/_appId_ --scopeName access_as_user --scopeAdminConsentDescription 'Access as a user' --scopeAdminConsentDisplayName 'Access as a user' --scopeConsentBy adminsAndUsers
143
148
  ```
149
+
150
+ Create new Azure AD app registration with the specified name. Store information about the created app registration in the _.m365rc.json_ file in the current directory.
151
+
152
+ ```sh
153
+ m365 aad app add --name 'My AAD app' --save
154
+ ```
@@ -36,6 +36,7 @@ m365 aad o365group add [options]
36
36
  ## Remarks
37
37
 
38
38
  When specifying the path to the logo image you can use both relative and absolute paths. Note, that ~ in the path, will not be resolved and will most likely result in an error.
39
+ If an invalid user is provided in the comma-separated list or Owners or Members, the command operation will fail and the Micrsoft 365 Group will not be created.
39
40
 
40
41
  ## Examples
41
42
 
@@ -0,0 +1,46 @@
1
+ # file list
2
+
3
+ Retrieves files from the specified folder and site
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 file list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : The URL of the site where the folder from which to retrieve files is located
15
+
16
+ `-f, --folderUrl <folderUrl>`
17
+ : The server- or site-relative URL of the folder from which to retrieve files
18
+
19
+ `--recursive`
20
+ : Set to retrieve files from subfolders
21
+
22
+ --8<-- "docs/cmd/_global.md"
23
+
24
+ ## Remarks
25
+
26
+ This command is an improved version of the `spo file list` command. The main difference between the two commands is, that `file list` uses Microsoft Graph and properly supports retrieving files from large folders. Because `file list` uses Microsoft Graph and `spo file list` uses SharePoint REST APIs, the data returned by both commands is different.
27
+
28
+ ## Examples
29
+
30
+ Return all files from folder _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
31
+
32
+ ```sh
33
+ m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents'
34
+ ```
35
+
36
+ Return all files from the folder _Shared Documents_ and all the sub-folders of _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
37
+
38
+ ```sh
39
+ m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents' --recursive
40
+ ```
41
+
42
+ Return all files from the _Important_ folder in the _Shared Documents_ document library located in site _https://contoso.sharepoint.com/sites/project-x_
43
+
44
+ ```sh
45
+ m365 file list --webUrl https://contoso.sharepoint.com/sites/project-x --folder 'Shared Documents/Important'
46
+ ```
@@ -0,0 +1,43 @@
1
+ # search externalconnection add
2
+
3
+ Add a new external connection to be defined for Microsoft Search
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 search externalconnection add [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-i, --id <id>`
14
+ : Developer-provided unique ID of the connection within the Azure Active Directory tenant
15
+
16
+ `-n, --name <name>`
17
+ : The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters
18
+
19
+ `-d, --description <description>`
20
+ : Description of the connection displayed in the Microsoft 365 admin center
21
+
22
+ `--authorizedAppIds [authorizedAppIds]`
23
+ : Comma-separated collection of application IDs for registered Azure Active Directory apps that are allowed to manage the external connection and to index content in the external connection.
24
+
25
+ --8<-- "docs/cmd/_global.md"
26
+
27
+ ## Remarks
28
+
29
+ The `id` must be at least 3 and no more than 32 characters long. It can contain only alphanumeric characters, can't begin with _Microsoft_ and can be any of the following values: *None, Directory, Exchange, ExchangeArchive, LinkedIn, Mailbox, OneDriveBusiness, SharePoint, Teams, Yammer, Connectors, TaskFabric, PowerBI, Assistant, TopicEngine, MSFT_All_Connectors*.
30
+
31
+ ## Examples
32
+
33
+ Adds a new external connection with name and description of test
34
+
35
+ ```sh
36
+ m365 search externalconnection add --id MyApp --name "My application" --description "Description of your application"
37
+ ```
38
+
39
+ Adds a new external connection with a limited number of authorized apps
40
+
41
+ ```sh
42
+ m365 search externalconnection add --id MyApp --name "My application" --description "Description of your application" --authorizedAppIds "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002"
43
+ ```
@@ -32,7 +32,7 @@ m365 spfx project upgrade [options]
32
32
 
33
33
  ## Remarks
34
34
 
35
- The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.13.0).
35
+ The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.13.1).
36
36
 
37
37
  This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.
38
38
 
@@ -0,0 +1,33 @@
1
+ # spo contenttype list
2
+
3
+ Lists content types from specified site
4
+
5
+ ## Usage
6
+
7
+ ```sh
8
+ m365 spo contenttype list [options]
9
+ ```
10
+
11
+ ## Options
12
+
13
+ `-u, --webUrl <webUrl>`
14
+ : Absolute URL of the site for which to list content types
15
+
16
+ `-c, --category [category]`
17
+ : Category name of content types. When defined will return only content types from specified category
18
+
19
+ --8<-- "docs/cmd/_global.md"
20
+
21
+ ## Examples
22
+
23
+ Retrieve site content types
24
+
25
+ ```PowerShell
26
+ m365 spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales"
27
+ ```
28
+
29
+ Retrieve site content types from the 'List Content Types' category
30
+
31
+ ```PowerShell
32
+ m365 spo contenttype list --webUrl "https://contoso.sharepoint.com/sites/contoso-sales" --category "List Content Types"
33
+ ```
@@ -22,6 +22,9 @@ m365 spo list get [options]
22
22
  `-p, --properties [properties]`
23
23
  : Comma-separated list of properties to retrieve from the list. Will retrieve all properties possible from default response, if not specified.
24
24
 
25
+ `--withPermissions`
26
+ : Set if you want to return associated roles and permissions of the list.
27
+
25
28
  --8<-- "docs/cmd/_global.md"
26
29
 
27
30
  ## Examples
@@ -44,6 +47,12 @@ Get information about a list returning the specified list properties
44
47
  m365 spo list get --title Documents --webUrl https://contoso.sharepoint.com/sites/project-x --properties "Title,Id,HasUniqueRoleAssignments,AllowContentTypes"
45
48
  ```
46
49
 
50
+ Get information about a list along with the roles and permissions
51
+
52
+ ```sh
53
+ m365 spo list get --title Documents --webUrl https://contoso.sharepoint.com/sites/project-x --withPermissions
54
+ ```
55
+
47
56
  ## More information
48
57
 
49
58
  - List REST API resources: [https://msdn.microsoft.com/en-us/library/office/dn531433.aspx#bk_ListEndpoint](https://msdn.microsoft.com/en-us/library/office/dn531433.aspx#bk_ListEndpoint)
@@ -20,10 +20,10 @@ m365 spo page add [options]
20
20
  : Title of the page to create. If not specified, will use the page name as its title
21
21
 
22
22
  `-l, --layoutType [layoutType]`
23
- : Layout of the page. Allowed values `Article,Home`. Default `Article`
23
+ : Layout of the page. Allowed values `Article`, `Home`, `SingleWebPartAppPage`, `RepostPage`,`HeaderlessSearchResults`, `Spaces`, `Topic`. Default `Article`
24
24
 
25
25
  `-p, --promoteAs [promoteAs]`
26
- : Create the page for a specific purpose. Allowed values `HomePage,NewsPage`
26
+ : Create the page for a specific purpose. Allowed values `HomePage`, `NewsPage`
27
27
 
28
28
  `--commentsEnabled`
29
29
  : Set to enable comments on the page
@@ -17,13 +17,13 @@ m365 spo page set [options]
17
17
  : URL of the site where the page to update is located
18
18
 
19
19
  `-l, --layoutType [layoutType]`
20
- : Layout of the page. Allowed values `Article,Home`
20
+ : Layout of the page. Allowed values `Article`, `Home`, `SingleWebPartAppPage`, `RepostPage`,`HeaderlessSearchResults`, `Spaces`, `Topic`
21
21
 
22
22
  `-p, --promoteAs [promoteAs]`
23
- : Update the page purpose. Allowed values `HomePage,NewsPage`
23
+ : Update the page purpose. Allowed values `HomePage`, `NewsPage`
24
24
 
25
25
  `--commentsEnabled [commentsEnabled]`
26
- : Set to `true`, to enable comments on the page. Allowed values `true,false`
26
+ : Set to `true`, to enable comments on the page. Allowed values `true`, `false`
27
27
 
28
28
  `--publish`
29
29
  : Set to publish the page