@pnp/cli-microsoft365 6.1.0-beta.f03db2d → 6.1.0-beta.f818fbb

package/dist/m365/yammer/commands/user/user-list.js

@@ -19,14 +19,6 @@ const request_1 = require("../../../../request");
 const YammerCommand_1 = require("../../../base/YammerCommand");
 const commands_1 = require("../../commands");
 class YammerUserListCommand extends YammerCommand_1.default {
-    constructor() {
-        super();
-        _YammerUserListCommand_instances.add(this);
-        this.items = [];
-        __classPrivateFieldGet(this, _YammerUserListCommand_instances, "m", _YammerUserListCommand_initTelemetry).call(this);
-        __classPrivateFieldGet(this, _YammerUserListCommand_instances, "m", _YammerUserListCommand_initOptions).call(this);
-        __classPrivateFieldGet(this, _YammerUserListCommand_instances, "m", _YammerUserListCommand_initValidators).call(this);
-    }
     get name() {
         return commands_1.default.USER_LIST;
     }
@@ -36,6 +28,14 @@ class YammerUserListCommand extends YammerCommand_1.default {
     defaultProperties() {
         return ['id', 'full_name', 'email'];
     }
+    constructor() {
+        super();
+        _YammerUserListCommand_instances.add(this);
+        this.items = [];
+        __classPrivateFieldGet(this, _YammerUserListCommand_instances, "m", _YammerUserListCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _YammerUserListCommand_instances, "m", _YammerUserListCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _YammerUserListCommand_instances, "m", _YammerUserListCommand_initValidators).call(this);
+    }
     getAllItems(logger, args, page) {
         return new Promise((resolve, reject) => {
             if (page === 1) {

package/dist/m365/yammer/commands/yammer-search.js

@@ -20,6 +20,12 @@ const formatting_1 = require("../../../utils/formatting");
 const YammerCommand_1 = require("../../base/YammerCommand");
 const commands_1 = require("../commands");
 class YammerSearchCommand extends YammerCommand_1.default {
+    get name() {
+        return commands_1.default.SEARCH;
+    }
+    get description() {
+        return 'Returns a list of messages, users, topics and groups that match the specified query.';
+    }
     constructor() {
         super();
         _YammerSearchCommand_instances.add(this);
@@ -37,12 +43,6 @@ class YammerSearchCommand extends YammerCommand_1.default {
         __classPrivateFieldGet(this, _YammerSearchCommand_instances, "m", _YammerSearchCommand_initOptions).call(this);
         __classPrivateFieldGet(this, _YammerSearchCommand_instances, "m", _YammerSearchCommand_initValidators).call(this);
     }
-    get name() {
-        return commands_1.default.SEARCH;
-    }
-    get description() {
-        return 'Returns a list of messages, users, topics and groups that match the specified query.';
-    }
     getAllItems(logger, args, page) {
         return new Promise((resolve, reject) => {
             const endpoint = `${this.resource}/v1/search.json?search=${formatting_1.formatting.encodeQueryParameter(args.options.queryText)}&page=${page}`;

package/dist/request.js

@@ -6,44 +6,6 @@ const Auth_1 = require("./Auth");
 const formatting_1 = require("./utils/formatting");
 const packageJSON = require('../package.json');
 class Request {
-    constructor() {
-        this._debug = false;
-        this.req = axios_1.default.create({
-            headers: {
-                'user-agent': `NONISV|SharePointPnP|CLIMicrosoft365/${packageJSON.version}`,
-                'accept-encoding': 'gzip, deflate'
-            },
-            decompress: true,
-            responseType: 'text',
-            /* c8 ignore next */
-            transformResponse: [data => data],
-            maxBodyLength: Infinity,
-            maxContentLength: Infinity
-        });
-        // since we're stubbing requests, request interceptor is never called in
-        // tests, so let's exclude it from coverage
-        /* c8 ignore next 7 */
-        this.req.interceptors.request.use((config) => {
-            if (config.responseType === 'json') {
-                config.transformResponse = axios_1.default.defaults.transformResponse;
-            }
-            return config;
-        });
-        // since we're stubbing requests, response interceptor is never called in
-        // tests, so let's exclude it from coverage
-        /* c8 ignore next 15 */
-        this.req.interceptors.response.use((response) => response, (error) => {
-            if (error &&
-                error.response &&
-                error.response.data &&
-                !(error.response.data instanceof stream_1.Stream)) {
-                // move error details from response.data to error property to make
-                // it compatible with our code
-                error.error = JSON.parse(JSON.stringify(error.response.data));
-            }
-            throw error;
-        });
-    }
     set debug(debug) {
         // if the value to set is the same as current value return early to avoid
         // instantiating interceptors multiple times. This can happen when calling
@@ -94,6 +56,44 @@ class Request {
     set logger(logger) {
         this._logger = logger;
     }
+    constructor() {
+        this._debug = false;
+        this.req = axios_1.default.create({
+            headers: {
+                'user-agent': `NONISV|SharePointPnP|CLIMicrosoft365/${packageJSON.version}`,
+                'accept-encoding': 'gzip, deflate'
+            },
+            decompress: true,
+            responseType: 'text',
+            /* c8 ignore next */
+            transformResponse: [data => data],
+            maxBodyLength: Infinity,
+            maxContentLength: Infinity
+        });
+        // since we're stubbing requests, request interceptor is never called in
+        // tests, so let's exclude it from coverage
+        /* c8 ignore next 7 */
+        this.req.interceptors.request.use((config) => {
+            if (config.responseType === 'json') {
+                config.transformResponse = axios_1.default.defaults.transformResponse;
+            }
+            return config;
+        });
+        // since we're stubbing requests, response interceptor is never called in
+        // tests, so let's exclude it from coverage
+        /* c8 ignore next 15 */
+        this.req.interceptors.response.use((response) => response, (error) => {
+            if (error &&
+                error.response &&
+                error.response.data &&
+                !(error.response.data instanceof stream_1.Stream)) {
+                // move error details from response.data to error property to make
+                // it compatible with our code
+                error.error = JSON.parse(JSON.stringify(error.response.data));
+            }
+            throw error;
+        });
+    }
     post(options) {
         options.method = 'POST';
         return this.execute(options);

package/dist/settingsNames.js

@@ -9,6 +9,7 @@ const settingsNames = {
     csvQuote: 'csvQuote',
     csvQuoted: 'csvQuoted',
     csvQuotedEmpty: 'csvQuotedEmpty',
+    disableTelemetry: 'disableTelemetry',
     errorOutput: 'errorOutput',
     helpMode: 'helpMode',
     output: 'output',

package/dist/telemetry.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.telemetry = void 0;
+const appInsights_1 = require("./appInsights");
+const Cli_1 = require("./cli/Cli");
+const settingsNames_1 = require("./settingsNames");
+class Telemetry {
+    trackEvent(commandName, properties) {
+        if (Cli_1.Cli.getInstance().getSettingWithDefaultValue(settingsNames_1.settingsNames.disableTelemetry, false)) {
+            return;
+        }
+        appInsights_1.default.trackEvent({
+            name: commandName,
+            properties
+        });
+        appInsights_1.default.flush();
+    }
+    trackException(exception) {
+        if (Cli_1.Cli.getInstance().getSettingWithDefaultValue(settingsNames_1.settingsNames.disableTelemetry, false)) {
+            return;
+        }
+        appInsights_1.default.trackException({
+            exception
+        });
+        appInsights_1.default.flush();
+    }
+}
+exports.telemetry = new Telemetry();
+//# sourceMappingURL=telemetry.js.map

package/dist/utils/md.js

@@ -65,6 +65,14 @@ function removeTooManyEmptyLines(md) {
     const regex = new RegExp('(' + os_1.EOL + '){4,}', 'g');
     return md.replace(regex, Array(4).join(os_1.EOL));
 }
+function escapeMd(mdString) {
+    if (!mdString) {
+        return mdString;
+    }
+    return mdString.toString()
+        .replace(/([_*~`|])/g, '\\$1')
+        .replace(/\n/g, '<br>');
+}
 const convertFunctions = [
     convertTitle,
     convertHeadings,
@@ -83,6 +91,7 @@ exports.md = {
             md = convert(md);
         });
         return md;
-    }
+    },
+    escapeMd
 };
 //# sourceMappingURL=md.js.map

package/docs/docs/_clisettings.md

@@ -11,6 +11,7 @@ Setting name|Definition|Default value
 `csvQuote`|The quote characters surrounding a field. An empty quote value will preserve the original field, whether it contains quotation marks or not.|` `
 `csvQuoted`|Quote all the non-empty fields even if not required|`false`
 `csvQuotedEmpty`|Quote empty strings and overrides quoted_string on empty strings when defined|`false`
+`disableTelemetry`|Disables sending of telemetry data|`false`
 `errorOutput`|Defines if errors should be written to `stdout` or `stderr`|`stderr`
 `helpMode`|Defines what part of command's help to display. Allowed values are `options`, `examples`, `remarks`, `response`, `full`|`full`
 `output`|Defines the default output when issuing a command|`json`

package/docs/docs/cmd/_global.md

@@ -5,7 +5,7 @@
 : JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
 
 `-o, --output [output]`
-: Output type. `json,text,csv`. Default `json`
+: Output type. `json,text,csv,md`. Default `json`
 
 `--verbose`
 : Runs command with verbose logging

package/docs/docs/cmd/pp/dataverse/dataverse-table-row-remove.md

@@ -0,0 +1,61 @@
+# pp dataverse table row remove
+
+Removes a row from a dataverse table in a given environment.
+
+## Usage
+
+```sh
+pp dataverse table row remove [options]
+```
+
+## Options
+
+`-e, --environment <environment>`
+: The name of the environment to remove a row from a table from.
+
+`-i, --id <id>`
+: The id of the row to remove.
+
+`--entitySetName [entitySetName]`
+: The entity set name of the table. Specify either `entitySetName` or `tableName` but not both
+
+`--tableName [tableName]`
+: The name of the table. Specify either `entitySetName` or `tableName` but not both
+
+`--confirm`
+: Don't prompt for confirmation
+
+`--asAdmin`
+: Set, to remove the row from the dataverse table as admin for environments you are not a member of.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Removes a row from a dataverse table in a given environment
+
+```sh
+m365 pp dataverse table row remove --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --tableName "aadusers" --id "21d01cf4-356c-ed11-9561-000d3a4bbea4"
+```
+
+Removes a row from a dataverse table in a given environment as Admin
+
+```sh
+m365 pp dataverse table row remove --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --tableName "aadusers" --id "21d01cf4-356c-ed11-9561-000d3a4bbea4" --asAdmin
+```
+
+Removes a row from a dataverse table in a given environment without prompting for confirmation
+
+```sh
+m365 pp dataverse table row remove --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --tableName "aadusers" --id "21d01cf4-356c-ed11-9561-000d3a4bbea4" --confirm
+```
+
+Removes a row from a dataverse table in a given environment based on the entity set name without prompting for confirmation
+
+```sh
+m365 pp dataverse table row remove --environment "Default-2ca3eaa5-140f-4175-8261-3272edf9f339" --entitySetName "cr6c3_accounts" --id "21d01cf4-356c-ed11-9561-000d3a4bbea4" --confirm
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/pp/environment/environment-get.md

@@ -16,6 +16,8 @@ m365 pp environment get [options]
 `--asAdmin`
 : Run the command as admin and retrieve details of environments you do not have explicitly assigned permissions to
 
+--8<-- "docs/cmd/_global.md"
+
 ## Remarks
 
 !!! attention

package/docs/docs/cmd/pp/solution/solution-publisher-remove.md

@@ -1,4 +1,4 @@
-# solution remove
+# pp solution publisher remove
 
 Removes the specified publisher in the specified Power Platform environment
 

package/docs/docs/cmd/purview/retentionlabel/retentionlabel-remove.md

@@ -0,0 +1,36 @@
+# purview retentionlabel remove
+
+Delete a retention label
+
+## Usage
+
+```sh
+m365 purview retentionlabel remove [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: The Id of the retention label.
+
+`--confirm`
+: Don't prompt for confirming to remove the label.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Delete a retention label
+
+```sh
+m365 purview retentionlabel remove --id 'e554d69c-0992-4f9b-8a66-fca3c4d9c531'
+```
+
+## Remarks
+
+!!! attention
+    This command is based on a Microsoft Graph API that is currently in preview and is subject to change once the API reached general availability.
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/list/{list-label-get.md → list-retentionlabel-get.md}

@@ -1,11 +1,17 @@
-# spo list label get
+# spo list retentionlabel get
 
-Gets label set on the specified list
+Gets the default retention label set on the specified list or library.
 
 ## Usage
 
 ```sh
-m365 spo list label get  [options]
+m365 spo list retentionlabel get [options]
+```
+
+## Alias
+
+```sh
+m365 spo list label get [options]
 ```
 
 ## Options
@@ -26,28 +32,28 @@ m365 spo list label get  [options]
 
 ## Examples
 
-Gets label set on the list with specified title located in the specified site.
+Gets retention label set on the list with specified title located in the specified site.
 
 ```sh
-m365 spo list label get --listTitle ContosoList --webUrl https://contoso.sharepoint.com/sites/project-x
+m365 spo list retentionlabel get --listTitle ContosoList --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
 
-Gets label set on the list with specified id located in the specified site.
+Gets retention label set on the list with specified id located in the specified site.
 
 ```sh
-m365 spo list label get --listId cc27a922-8224-4296-90a5-ebbc54da2e85 --webUrl https://contoso.sharepoint.com/sites/project-x
+m365 spo list retentionlabel get --listId cc27a922-8224-4296-90a5-ebbc54da2e85 --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
 
-Gets label set on the list with specified server relative url located in the specified site.
+Gets retention label set on the list with specified server relative url located in the specified site.
 
 ```sh
-m365 spo list label get --listUrl 'sites/project-x/Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
+m365 spo list retentionlabel get --listUrl 'sites/project-x/Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
 
-Gets label set on the list with specified site-relative URL located in the specified site.
+Gets retention label set on the list with specified site-relative URL located in the specified site.
 
 ```sh
-m365 spo list label get --listUrl 'Shared Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
+m365 spo list retentionlabel get --listUrl 'Shared Documents' --webUrl https://contoso.sharepoint.com/sites/project-x
 ```
 
 ## Response

package/docs/docs/cmd/spo/list/list-retentionlabel-set.md

@@ -0,0 +1,65 @@
+# spo list retentionlabel set
+
+Sets a default retention label on the specified list or library.
+
+## Usage
+
+```sh
+m365 spo list retentionlabel set [options]
+```
+
+## Alias
+
+```sh
+m365 spo list label set [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: The URL of the site where the list is located
+
+`--label <label>`
+: The label to set on the list
+
+`-t, --listTitle [listTitle]`
+: The title of the list on which to set the label. Specify only one of `listTitle`, `listId` or `listUrl`
+
+`-l, --listId [listId]`
+: The ID of the list on which to set the label. Specify only one of `listTitle`, `listId` or `listUrl`
+
+`--listUrl [listUrl]`
+: Server- or web-relative URL of the list on which to set the label. Specify only one of `listTitle`, `listId` or `listUrl`
+
+`--syncToItems`
+: Specify, to set the label on all existing items in the list
+
+`--blockDelete`
+: Specify, to disallow deleting items in the list
+
+`--blockEdit`
+: Specify, to disallow editing items in the list
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+A list retention label is a default label that will be applied to all new items in the list. If you specify `syncToItems`, it is also synced to existing items. 
+
+## Examples
+
+Sets retention label "Some label" on the list _Shared Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo list retentionlabel set --webUrl https://contoso.sharepoint.com/sites/project-x --listUrl 'Shared Documents' --label 'Some label'
+```
+
+Sets retention label "Some label" and disables editing and deleting items on the list and all existing items for list for list _Documents_ located in site _https://contoso.sharepoint.com/sites/project-x_
+
+```sh
+m365 spo list retentionlabel set --webUrl https://contoso.sharepoint.com/sites/project-x --listTitle 'Documents' --label 'Some label' --blockEdit --blockDelete --syncToItems
+```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-add.md

@@ -11,13 +11,13 @@ m365 spo orgassetslibrary add [options]
 ## Options
 
 `--libraryUrl <libraryUrl>`
-: The URL of the library to promote
+: The URL of the library to promote.
 
 `--thumbnailUrl <thumbnailUrl>`
-: The URL of the thumbnail to render
+: The URL of the thumbnail to render.
 
 `--cdnType [cdnType]`
-: Specifies the CDN type. `Public,Private`. Default is `Private`
+: Specifies the CDN type. Allowed values `Public`, `Private`. Default `Private`.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -29,11 +29,15 @@ m365 spo orgassetslibrary add [options]
 Promotes an existing library to become an organization assets library
 
 ```sh
-m365 spo orgassetslibrary add --libraryUrl "https://contoso.sharepoint.com/assets"
+m365 spo orgassetslibrary add --libraryUrl "https://contoso.sharepoint.com/SiteAssets"
 ```
 
 Promotes an existing library to become an organization assets library with Thumbnail
 
 ```sh
-m365 spo orgassetslibrary --libraryUrl "https://contoso.sharepoint.com/assets" --thumbnailUrl "https://contoso.sharepoint.com/assets/logo.png"
+m365 spo orgassetslibrary --libraryUrl "https://contoso.sharepoint.com/SiteAssets" --thumbnailUrl "https://contoso.sharepoint.com/assets/logo.png"
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-list.md

@@ -22,3 +22,45 @@ List all libraries that are assigned as asset library
 ```sh
 m365 spo orgassetslibrary list
 ```
+
+## Response
+
+### Standard response
+
+=== "JSON"
+
+    ```json
+    {
+      "Url": "/",
+      "Libraries": [
+        {
+          "DisplayName": "Site Assets",
+          "LibraryUrl": "SiteAssets",
+          "ListId": "/Guid(0a327c3f-ba82-4b19-bfa1-628405539420)/",
+          "ThumbnailUrl": null
+        }
+      ]
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    Libraries: [{"DisplayName":"Site Assets","LibraryUrl":"SiteAssets","ListId":"/Guid(0a327c3f-ba82-4b19-bfa1-628405539420)/","ThumbnailUrl":null}]
+    Url      : /
+    ```
+
+=== "CSV"
+
+    ```csv
+    Url,Libraries
+    /,"[{""DisplayName"":""Site Assets"",""LibraryUrl"":""SiteAssets"",""ListId"":""/Guid(0a327c3f-ba82-4b19-bfa1-628405539420)/"",""ThumbnailUrl"":null}]"
+    ```
+
+### Response when no library is assigned as asset library
+
+=== "Text"
+
+    ```text
+    No libraries in Organization Assets
+    ```

package/docs/docs/cmd/spo/orgassetslibrary/orgassetslibrary-remove.md

@@ -11,10 +11,10 @@ m365 spo orgassetslibrary remove [options]
 ## Options
 
 `--libraryUrl <libraryUrl>`
-: The server relative URL of the library to be removed as a central location for organization assets
+: The server relative URL of the library to be removed as a central location for organization assets.
 
 `--confirm`
-: Don't prompt for confirming removing the organization asset library
+: Don't prompt for confirming removing the organization asset library.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -23,8 +23,30 @@ m365 spo orgassetslibrary remove [options]
 
 ## Examples
 
-Removes organization assets library without confirmation
+Removes organization assets library without prompting for confirmation
 
 ```sh
 m365 spo orgassetslibrary remove --libraryUrl "/sites/branding/assets" --confirm
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    {
+      "IsNull": false
+    }
+    ```
+
+=== "Text"
+
+    ```text
+    IsNull: false
+    ```
+
+=== "CSV"
+
+    ```csv
+    IsNull
+    ```

package/docs/docs/cmd/spo/orgnewssite/orgnewssite-list.md

@@ -22,3 +22,25 @@ List all organizational news sites
 ```sh
 m365 spo orgnewssite list
 ```
+
+## Response
+
+=== "JSON"
+
+    ```json
+    [
+      "https://contoso.sharepoint.com/sites/contosoNews"
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    https://contoso.sharepoint.com/sites/contosoNews
+    ```
+
+=== "CSV"
+
+    ```csv
+    https://contoso.sharepoint.com/sites/contosoNews
+    ```

package/docs/docs/cmd/spo/orgnewssite/orgnewssite-remove.md

@@ -11,10 +11,10 @@ m365 spo orgnewssite remove [options]
 ## Options
 
 `-u, --url <url>`
-: Absolute URL of the site to remove
+: Absolute URL of the site to remove.
 
 `--confirm`
-: Don't prompt for confirmation
+: Don't prompt for confirmation.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -34,3 +34,7 @@ Remove a site from the list of organizational news sites, without prompting for
 ```sh
 m365 spo orgnewssite remove --url https://contoso.sharepoint.com/sites/site1 --confirm
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spo/orgnewssite/orgnewssite-set.md

@@ -11,7 +11,7 @@ m365 spo orgnewssite set [options]
 ## Options
 
 `-u, --url <url>`
-: The URL of the site to mark as an organizational news site
+: The URL of the site to mark as an organizational news site.
 
 --8<-- "docs/cmd/_global.md"
 
@@ -29,3 +29,7 @@ Set a site as an organizational news site
 ```sh
 m365 spo orgnewssite set --url https://contoso.sharepoint.com/sites/site1
 ```
+
+## Response
+
+The command won't return a response on success.