@pnp/cli-microsoft365 7.4.0-beta.4c4cef8 → 7.4.0-beta.5c123d7

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 (32) hide show
  1. package/README.md +1 -1
  2. package/allCommands.json +1 -1
  3. package/allCommandsFull.json +1 -1
  4. package/dist/cli/cli.js +1 -0
  5. package/dist/utils/md.js +2 -2
  6. package/docs/docs/cmd/adaptivecard/adaptivecard-send.mdx +1 -1
  7. package/docs/docs/cmd/graph/schemaextension/schemaextension-add.mdx +1 -1
  8. package/docs/docs/cmd/graph/schemaextension/schemaextension-set.mdx +1 -1
  9. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.mdx +1 -1
  10. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-set.mdx +1 -1
  11. package/docs/docs/cmd/spo/commandset/commandset-add.mdx +1 -1
  12. package/docs/docs/cmd/spo/commandset/commandset-set.mdx +1 -1
  13. package/docs/docs/cmd/spo/contenttype/contenttype-set.mdx +1 -1
  14. package/docs/docs/cmd/spo/customaction/customaction-add.mdx +1 -1
  15. package/docs/docs/cmd/spo/customaction/customaction-set.mdx +1 -1
  16. package/docs/docs/cmd/spo/field/field-set.mdx +1 -1
  17. package/docs/docs/cmd/spo/list/list-view-set.mdx +1 -1
  18. package/docs/docs/cmd/spo/listitem/listitem-add.mdx +1 -1
  19. package/docs/docs/cmd/spo/listitem/listitem-batch-add.mdx +1 -1
  20. package/docs/docs/cmd/spo/listitem/listitem-set.mdx +1 -1
  21. package/docs/docs/cmd/spo/page/page-clientsidewebpart-add.mdx +1 -1
  22. package/docs/docs/cmd/spo/page/page-control-set.mdx +1 -1
  23. package/docs/docs/cmd/spo/page/page-set.mdx +2 -2
  24. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-add.mdx +1 -1
  25. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-set.mdx +1 -1
  26. package/docs/docs/cmd/spo/tenant/tenant-commandset-add.mdx +1 -1
  27. package/docs/docs/cmd/spo/tenant/tenant-commandset-set.mdx +1 -1
  28. package/docs/docs/cmd/spo/term/term-add.mdx +1 -1
  29. package/docs/docs/cmd/spo/term/term-group-add.mdx +1 -1
  30. package/docs/docs/cmd/spo/term/term-set-add.mdx +1 -1
  31. package/npm-shrinkwrap.json +184 -430
  32. package/package.json +9 -9
package/dist/cli/cli.js CHANGED
@@ -134,6 +134,7 @@ async function execute(rawArgs) {
134
134
  if (validationResult !== true) {
135
135
  return cli.closeWithError(validationResult, cli.optionsFromArgs, true);
136
136
  }
137
+ cli.optionsFromArgs = removeShortOptions(cli.optionsFromArgs);
137
138
  const end = process.hrtime.bigint();
138
139
  timings.core.push(Number(end - start));
139
140
  try {
package/dist/utils/md.js CHANGED
@@ -13,8 +13,8 @@ function convertHeadings(md) {
13
13
  });
14
14
  }
15
15
  function convertAdmonitions(md) {
16
- const regex = new RegExp(/^:::(\w+)([\s\S]*?):::$/, 'gm');
17
- return md.replace(regex, (_, label, content) => label.toLocaleUpperCase() + EOL + EOL + content.trim());
16
+ const regex = new RegExp(/^:::(\w+)(?:\[([^\]]+)\])?([\s\S]*?):::$/, 'gm');
17
+ return md.replace(regex, (_, label, title, content) => label.toLocaleUpperCase() + (title ? EOL + EOL + title : '') + EOL + EOL + content.trim());
18
18
  }
19
19
  function includeContent(md, rootFolder) {
20
20
  const mdxImports = [
@@ -47,7 +47,7 @@ The predefined card is automatically adjusted based on which options have been s
47
47
 
48
48
  If your custom card is a card template (card with placeholders like `${title}`), you can fill it with data either by specifying the complete data object using the `cardData` option, or by passing any number of arbitrary options that will be mapped onto the card. The arbitrary properties should not match any of the global options like `output`, `query`, `debug`, etc. Data options like `title`, `description`, `imageUrl` and `actionUrl` will be mapped onto the card as well.
49
49
 
50
- :::warning Escaping JSON in PowerShell
50
+ :::warning[Escaping JSON in PowerShell]
51
51
 
52
52
  When using the `--card` and `--cardData` options it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
53
53
 
@@ -49,7 +49,7 @@ The schema extension owner is the ID of the Azure AD application that is the own
49
49
 
50
50
  The target types are the set of Microsoft Graph resource types (that support schema extensions) that this schema extension definition can be applied to. This option is specified as a comma-separated list
51
51
 
52
- :::warning Escaping JSON in PowerShell
52
+ :::warning[Escaping JSON in PowerShell]
53
53
 
54
54
  When using the `--properties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
55
55
 
@@ -40,7 +40,7 @@ The lifecycle state of the schema extension. The initial state upon creation is
40
40
  Possible states transitions are from `InDevelopment` to `Available` and `Available` to `Deprecated`.
41
41
  The target types are the set of Microsoft Graph resource types (that support schema extensions) that this schema extension definition can be applied to. This option is specified as a comma-separated list.
42
42
 
43
- :::warning Escaping JSON in PowerShell
43
+ :::warning[Escaping JSON in PowerShell]
44
44
 
45
45
  When using the `--properties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
46
46
 
@@ -41,7 +41,7 @@ m365 spo applicationcustomizer add --webUrl https://contoso.sharepoint.com/sites
41
41
 
42
42
  Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
43
43
 
44
- :::warning Escaping JSON in PowerShell
44
+ :::warning[Escaping JSON in PowerShell]
45
45
 
46
46
  When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
47
47
 
@@ -47,7 +47,7 @@ m365 spo applicationcustomizer set --webUrl https://contoso.sharepoint.com/sites
47
47
 
48
48
  Note, how the clientSideComponentProperties option (--clientSideComponentProperties) has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
49
49
 
50
- :::warning Escaping JSON in PowerShell
50
+ :::warning[Escaping JSON in PowerShell]
51
51
 
52
52
  When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
53
53
 
@@ -49,7 +49,7 @@ m365 spo commandset add --webUrl https://contoso.sharepoint.com/sites/test --tit
49
49
 
50
50
  Note, how the clientSideComponentProperties option (-p) has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
51
51
 
52
- :::warning Escaping JSON in PowerShell
52
+ :::warning[Escaping JSON in PowerShell]
53
53
 
54
54
  When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
55
55
 
@@ -56,7 +56,7 @@ m365 spo commandset set --webUrl https://contoso.sharepoint.com/sites/test --tit
56
56
 
57
57
  Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
58
58
 
59
- :::warning Escaping JSON in PowerShell
59
+ :::warning[Escaping JSON in PowerShell]
60
60
 
61
61
  When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
62
62
 
@@ -39,7 +39,7 @@ m365 spo contenttype set [options]
39
39
 
40
40
  ## Remarks
41
41
 
42
- :::warning Updating child content types
42
+ :::warning[Updating child content types]
43
43
 
44
44
  When specifying the `--updateChildren` flag, SharePoint will only propagate the changes that are made in the current request. If you want to know more about updating a content type and propagating changes to child content types, be sure to [read more here](https://learn.microsoft.com/previous-versions/office/developer/sharepoint-2010/ms442695(v=office.14)#considerations-when-updating-child-content-types).
45
45
 
@@ -82,7 +82,7 @@ Note, how the clientSideComponentProperties option (-p) has escaped double quote
82
82
 
83
83
  The `--rights` option accepts **case sensitive** values.
84
84
 
85
- :::warning Escaping JSON in PowerShell
85
+ :::warning[Escaping JSON in PowerShell]
86
86
 
87
87
  When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
88
88
 
@@ -85,7 +85,7 @@ The `--rights` option accepts **case-sensitive** values.
85
85
 
86
86
  Note, specifying the scope option might speed up the execution of the command, but would not update the scope. If the scope has to be changed, then the existing custom action should be removed and new should be added with different scope.
87
87
 
88
- :::warning Escaping JSON in PowerShell
88
+ :::warning[Escaping JSON in PowerShell]
89
89
 
90
90
  When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
91
91
 
@@ -41,7 +41,7 @@ m365 spo field set [options]
41
41
 
42
42
  Specify properties to update using their names, eg. `--Title 'New Title' --JSLink jslink.js`.
43
43
 
44
- :::warning Escaping JSON in PowerShell
44
+ :::warning[Escaping JSON in PowerShell]
45
45
 
46
46
  When updating column formatting for a field with the `--CustomFormatter` option, it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
47
47
 
@@ -42,7 +42,7 @@ Specify properties to update using their names, eg. `--Title 'New Title' --JSLin
42
42
 
43
43
  When updating list formatting, the value of the CustomFormatter property must be XML-escaped, eg. `&lt;` instead of `<`.
44
44
 
45
- :::warning Escaping JSON in PowerShell
45
+ :::warning[Escaping JSON in PowerShell]
46
46
 
47
47
  When updating list view formatting for a view with the `--CustomFormatter` option, it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
48
48
 
@@ -38,7 +38,7 @@ m365 spo listitem add [options]
38
38
 
39
39
  ## Remarks
40
40
 
41
- :::warning When using DateTime fields
41
+ :::warning[When using DateTime fields]
42
42
 
43
43
  When creating a list item with a DateTime field, use the timezone and the format that the site expects, based on its regional settings. Alternatively, a format which works on all regions is the following: `yyyy-MM-dd HH:mm:ss`. However, you should use the local timezone in all situations. UTC date/time or ISO 8601 formatted date/time is not supported.
44
44
 
@@ -43,7 +43,7 @@ ContentType,Title,SingleChoiceField,MultiChoiceField,SingleMetadataField,MultiMe
43
43
  Item,Title A,Choice 1,Choice 1;#Choice 2,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;,Engineering|4a3cc5f3-a4a6-433e-a07a-746978ff1760;Finance|f994a4ac-cf34-448e-a22c-2b35fd9bbffa;,[{'Key':'i:0#.f|membership|markh@contoso.com'}],"[{'Key':'i:0#.f|membership|markh@contoso.com'},{'Key':'i:0#.f|membership|john.doe@contoso.com'}]","https://bing.com, URL",5,2023-01-01 10:00:00
44
44
  ```
45
45
 
46
- :::warning When using DateTime fields
46
+ :::warning[When using DateTime fields]
47
47
 
48
48
  When creating list items with a DateTime field, use the timezone and the format that the site expects, based on its regional settings. Alternatively, a format which works on all regions is the following: `yyyy-MM-dd HH:mm:ss`. However, you should use the local timezone in all situations. UTC date/time or ISO 8601 formatted date/time is not supported.
49
49
 
@@ -41,7 +41,7 @@ m365 spo listitem set [options]
41
41
 
42
42
  ## Remarks
43
43
 
44
- :::warning When using DateTime fields
44
+ :::warning[When using DateTime fields]
45
45
 
46
46
  When updating a list item with a DateTime field, use the timezone and the format that the site expects, based on its regional settings. Alternatively, a format which works on all regions is the following: `yyyy-MM-dd HH:mm:ss`. However, you should use the local timezone in all situations. UTC date/time or ISO 8601 formatted date/time is not supported.
47
47
 
@@ -49,7 +49,7 @@ If the specified `pageName` doesn't refer to an existing modern page, you will g
49
49
 
50
50
  To add a standard web part to the page, specify one of the following values: _ContentRollup, BingMap, ContentEmbed, DocumentEmbed, Image, ImageGallery, LinkPreview, NewsFeed, NewsReel, PowerBIReportEmbed, QuickChart, SiteActivity, VideoEmbed, YammerEmbed, Events, GroupCalendar, Hero, List, PageTitle, People, QuickLinks, CustomMessageRegion, Divider, MicrosoftForms, Spacer_.
51
51
 
52
- :::warning Escaping JSON in PowerShell
52
+ :::warning[Escaping JSON in PowerShell]
53
53
 
54
54
  When using the `--webPartProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
55
55
 
@@ -35,7 +35,7 @@ m365 spo page control set [options]
35
35
 
36
36
  If the specified `pageName` doesn't refer to an existing modern page, you will get a `File doesn't exists` error.
37
37
 
38
- :::warning Escaping JSON in PowerShell
38
+ :::warning[Escaping JSON in PowerShell]
39
39
 
40
40
  When using the `--webPartProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
41
41
 
@@ -63,9 +63,9 @@ m365 spo page set --name page.aspx --webUrl https://contoso.sharepoint.com/sites
63
63
 
64
64
  Note, how the content option has escaped double quotes `'[{\"controlType\": 4,\"id\": \"42b8afe8-dafe-4c11-bfbf-df5ef5b1feb7\",\"position\": {\"layoutIndex\": 1,\"zoneIndex\": 1,\"sectionIndex\": 1,\"sectionFactor\": 12,\"controlIndex\": 1},\"addedFromPersistedData\": true,\"innerHTML\":\"<p>Hello World</p>\"}]'` compared to execution from bash `''[{"controlType": 4,"id": "42b8afe8-dafe-4c11-bfbf-df5ef5b1feb7","position": {"layoutIndex": 1,"zoneIndex": 1,"sectionIndex": 1,"sectionFactor": 12,"controlIndex": 1},"addedFromPersistedData": true,"innerHTML":"<p>Hello World</p>"}]'`.
65
65
 
66
- :::warning Escaping JSON in PowerShell
66
+ :::warning[Escaping JSON in PowerShell]
67
67
 
68
- When using the `--content` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
68
+ When using the `--content` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
69
69
 
70
70
  :::
71
71
 
@@ -38,7 +38,7 @@ m365 spo tenant applicationcustomizer add --title "YourAppCustomizer" --clientSi
38
38
 
39
39
  Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
40
40
 
41
- :::warning Escaping JSON in PowerShell
41
+ :::warning[Escaping JSON in PowerShell]
42
42
 
43
43
  When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
44
44
 
@@ -47,7 +47,7 @@ m365 spo tenant applicationcustomizer set --id 3 --clientSideComponentProperties
47
47
 
48
48
  Note, how the clientSideComponentProperties option (--clientSideComponentProperties) has escaped double quotes `'{\"someProperty\":\"Some value\"}'` compared to execution from bash `'{"someProperty": "Some value"}'`.
49
49
 
50
- :::warning Escaping JSON in PowerShell
50
+ :::warning[Escaping JSON in PowerShell]
51
51
 
52
52
  When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
53
53
 
@@ -46,7 +46,7 @@ m365 spo tenant commandset add --title "YourAppCustomizer" --clientSideComponent
46
46
 
47
47
  Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
48
48
 
49
- :::warning Escaping JSON in PowerShell
49
+ :::warning[Escaping JSON in PowerShell]
50
50
 
51
51
  When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
52
52
 
@@ -45,7 +45,7 @@ m365 spo tenant commandset set [options]
45
45
 
46
46
  ## Remarks
47
47
 
48
- :::warning Escaping JSON in PowerShell
48
+ :::warning[Escaping JSON in PowerShell]
49
49
 
50
50
  When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
51
51
 
@@ -53,7 +53,7 @@ m365 spo term add [options]
53
53
 
54
54
  ## Remarks
55
55
 
56
- :::warning Escaping JSON in PowerShell
56
+ :::warning[Escaping JSON in PowerShell]
57
57
 
58
58
  When using the `--customProperties` and/or `--localCustomProperties` options it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
59
59
 
@@ -32,7 +32,7 @@ m365 spo term group add [options]
32
32
 
33
33
  ## Remarks
34
34
 
35
- :::warning
35
+ :::warning
36
36
 
37
37
  To use this command without the `--webUrl` option you must have permissions to access the tenant admin site.
38
38
 
@@ -41,7 +41,7 @@ m365 spo term set add [options]
41
41
 
42
42
  ## Remarks
43
43
 
44
- :::warning Escaping JSON in PowerShell
44
+ :::warning[Escaping JSON in PowerShell]
45
45
 
46
46
  When using the `--customProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.mdx#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.mdx#passing-complex-content-into-cli-options) instead.
47
47