@pnp/cli-microsoft365 6.0.0-beta.e1e0a1b → 6.0.0-beta.e42aed1

package/docs/docs/cmd/request.md

@@ -0,0 +1,76 @@
+# request
+
+Executes the specified web request using CLI for Microsoft 365
+
+## Usage
+
+```sh
+m365 request [options]
+```
+
+## Options
+
+`-u, --url <url>`
+: The request URL.
+
+`-m, --method [method]`
+: The HTTP request method. Accepted values are `get, post, put, patch, delete, head, options`. The default value is `get`.
+
+`-r, --resource [resource]`
+: The resource uri for which the CLI should acquire a token from AAD in order to access
+the service.
+
+`-b, --body [body]`
+: The request body. Optionally use `@example.json` to load the body from a file.
+
+`-p, --filePath [filePath]`
+: The file path to save the response to. This option can be used when downloading files.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+When executing a request, CLI will take care of the very basic configuration, and you'll need to specify all additional information, such as headers, method and body. CLI will take care for you of:
+
+- applying compression and handling throttling,
+- setting the `accept` to `application/json` if you don't specify it yourself,
+- setting the `authorization` header to the bearer token obtained for the resource determined from the request URL
+
+If you specify the `resource` option, the CLI will try to retrieve a valid token for the resource instead of determining the resource based on the url. The value doesn't have to be a URL. It can be also a URI like `app://<guid>`.
+
+Specify additional headers by typing them as options, for example: `--content-type "application/json"`, `--if-match "*"`, `--x-requestdigest "somedigest"`.
+
+!!! important
+    When building the request, depending on the shell you use, you might need to escape all `$` characters in the URL, request headers, and the body. If you don't do it, the shell will treat it as a variable and will remove the following word from the request, breaking the request.
+
+## Examples
+
+Call the SharePoint Rest API using a GET request with a constructed URL containing expands, filters and selects.
+
+```sh
+m365 request --url "https://contoso.sharepoint.com/sites/project-x/_api/web/siteusers?\$filter=IsShareByEmailGuestUser eq true&\$expand=Groups&\$select=Title,LoginName,Email,Groups/LoginName" --accept "application/json;odata=nometadata"
+```
+
+Call the Microsoft Graph beta endpoint using a GET request.
+
+```sh
+m365 request --url "https://graph.microsoft.com/beta/me"
+```
+
+Call the SharePoint API to retrieve a form digest.
+
+```sh
+m365 request --method post --url "https://contoso.sharepoint.com/sites/project-x/_api/contextinfo"
+```
+
+Call the SharePoint API to update a site title.
+
+```sh
+m365 request --method post --url "https://contoso.sharepoint.com/sites/project-x/_api/web" --body '{ "Title": "New title" }' --content-type "application/json" --x-http-method "PATCH"
+```
+
+Call the Microsoft Graph to get a profile photo.
+
+```sh
+m365 request --url "https://graph.microsoft.com/beta/me/photo/\$value" --filePath ./profile-pic.jpg
+```

package/docs/docs/cmd/search/externalconnection/externalconnection-remove.md

@@ -0,0 +1,40 @@
+# search externalconnection remove
+
+Allow the administrator to remove a specific external connection used in Microsoft Search.
+
+## Usage
+
+```sh
+m365 search externalconnection remove [options]
+```
+
+## Options
+
+`-i, --id [id]`
+: ID of the External Connection to remove. Specify either `id` or `name`
+
+`-n, --name [name]`
+: Name of the External Connection to remove. Specify either `id` or `name`
+
+`--confirm`
+: Don't prompt for confirming removing the connection
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+If the command finds multiple external connections used in Microsoft Search with the specified name, it will prompt you to disambiguate which external connection it should remove, listing the discovered IDs.
+
+## Examples
+
+Removes external connection with id _MyApp_
+
+```sh
+m365 search externalconnection remove --id "MyApp"
+```
+
+Removes external connection with name _Test_. Will NOT prompt for confirmation before removing.
+
+```sh
+m365 search externalconnection remove --name "Test" --confirm
+```

package/docs/docs/cmd/spfx/package/package-generate.md

@@ -16,7 +16,7 @@ m365 spfx package generate
 `-d, --webPartDescription <webPartDescription>`
 : Description of the web part to generate. Displayed in the tool box when adding web part to page
 
-`-n, --packageName <packageName>`
+`-n, --name <name>`
 : Name of the package to generate. Used among others for the .sppkg file. Must be unique in the app catalog to avoid collisions with other solutions.
 
 `--html <html>`
@@ -54,5 +54,9 @@ m365 spfx package generate
 Generate a web part that shows the weather for Amsterdam. Load web part contents from a local file. Allow the web part to be deployed to all sites. Expose the web part in Teams as a personal tab.
 
 ```sh
-m365 spfx package generate --webPartTitle "Amsterdam weather" --webPartDescription "Shows weather in Amsterdam" --packageName amsterdam-weather --html @amsterdam-weather.html --allowTenantWideDeployment --enableForTeams all
+m365 spfx package generate --webPartTitle "Amsterdam weather" --webPartDescription "Shows weather in Amsterdam" --name amsterdam-weather --html @amsterdam-weather.html --allowTenantWideDeployment --enableForTeams all
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spfx/project/project-doctor.md

@@ -62,3 +62,95 @@ Validate if your project is correctly set up and get instructions to fix any iss
 ```sh
 m365 spfx project doctor --output tour
 ```
+
+## Response
+
+### Response with no issues
+
+=== "JSON"
+
+    ```json
+    []
+    ```
+
+=== "Text"
+
+    ```text
+    ✅ CLI for Microsoft 365 has found no issues in your project
+    ```
+
+=== "Markdown"
+
+    ````md
+    # Validate project spfx-solution
+
+    Date: 11/7/2022
+
+    ## Findings
+
+    ✅ CLI for Microsoft 365 has found no issues in your project
+    ````
+
+### Response with issues reported
+
+When the npm packages related issues are reported. 
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "description": "Install supported version of the office-ui-fabric-react package",
+        "id": "FN001022",
+        "file": "./package.json",
+        "position": {
+          "line": 24,
+          "character": 5
+        },
+        "resolution": "npm i -SE office-ui-fabric-react@7.174.1",
+        "resolutionType": "cmd",
+        "severity": "Required",
+        "title": "office-ui-fabric-react"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Execute in command line
+    -----------------------
+    npm i -SE office-ui-fabric-react@7.174.1
+    ```
+
+=== "Markdown"
+
+    ````md
+    # Validate project react-page-navigator
+
+    Date: 11/15/2022
+
+    ## Findings
+
+    Following is the list of issues found in your project. [Summary](#Summary) of the recommended fixes is included at the end of the report.
+
+    ### FN001022 office-ui-fabric-react | Required
+
+    Install supported version of the office-ui-fabric-react package
+
+    Execute the following command:
+
+    ```sh
+    npm i -SE office-ui-fabric-react@7.174.1
+    ```
+
+    File: [./package.json:24:5](./package.json)
+
+    ## Summary
+
+    ### Execute script
+
+    ```sh
+    npm i -SE office-ui-fabric-react@7.174.1
+    ```
+    ````

package/docs/docs/cmd/spfx/project/project-externalize.md

@@ -40,6 +40,8 @@ The `spfx project externalize` command helps you externalize your SharePoint Fra
 
 This command doesn't change your project files. Instead, it gives you a report with all steps necessary to externalize your project dependencies. Externalizing project dependencies 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 changes and verify that everything is working as expected.
 
+Supported SharePoint Framework versions are 1.0.0, 1.0.1, 1.0.2, 1.1.0, 1.1.1, 1.1.3, 1.2.0, 1.3.0, 1.3.1, 1.3.2, 1.3.4, 1.4.0, 1.4.1, 1.5.0, 1.5.1, 1.6.0, 1.7.0, 1.7.1, 1.8.0, 1.8.1, 1.8.2, 1.9.1.
+
 ## Examples
 
 Get instructions to externalize the current SharePoint Framework project dependencies and save the findings in a Markdown file
@@ -53,3 +55,117 @@ Get instructions to externalize the current SharePoint Framework project depende
 ```sh
 m365 spfx project externalize
 ```
+
+## Response
+
+Below output will be produced to externalize the SharePoint Framework project dependencies.
+
+=== "JSON"
+
+    ```json
+    {
+      "externalConfiguration": {
+        "externals": {
+          "@pnp/sp": {
+            "path": "https://unpkg.com/@pnp/sp@^1.3.11/dist/sp.es5.umd.min.js",
+            "globalName": "pnp.sp",
+            "globalDependencies": [
+              "@pnp/logging",
+              "@pnp/common",
+              "@pnp/odata",
+              "tslib"
+            ]
+          },
+          "tslib": {
+            "path": "https://unpkg.com/tslib@^1.10.0/tslib.js",
+            "globalName": "tslib"
+          }
+        }
+      },
+      "edits": [
+        {
+          "action": "add",
+          "path": "C:\\react-global-news-sp2019\\src\\webparts\\news\\NewsWebPart.ts",
+          "targetValue": "require(\"tslib\");"
+        }
+      ]
+    }
+    ```
+
+
+=== "Text"
+
+    ```text
+    In the config/config.json file update the externals property to:
+
+    {
+      "externalConfiguration": {
+        "externals": {
+          "@pnp/sp": {
+            "path": "https://unpkg.com/@pnp/sp@^1.3.11/dist/sp.es5.umd.min.js",
+            "globalName": "pnp.sp",
+            "globalDependencies": [
+              "@pnp/logging",
+              "@pnp/common",
+              "@pnp/odata",
+              "tslib"
+            ]
+          },
+          "tslib": {
+            "path": "https://unpkg.com/tslib@^1.10.0/tslib.js",
+            "globalName": "tslib"
+          }
+        }
+      },
+      "edits": [
+        {
+          "action": "add",
+          "path": "C:\\react-global-news-sp2019\\src\\webparts\\news\\NewsWebPart.ts",
+          "targetValue": "require(\"tslib\");"
+        }
+      ]
+    }
+    ```
+
+=== "Markdown"
+
+    ````md
+    # Externalizing dependencies of project react-global-news-sp2019
+
+    Date: 11/7/2022
+
+    ## Findings
+
+    ### Modify files
+
+    #### [config.json](config/config.json)
+
+    Replace the externals property (or add if not defined) with
+    
+    ```json
+    {
+      "externals": {
+        "@pnp/sp": {
+          "path": "https://unpkg.com/@pnp/sp@^1.3.11/dist/sp.es5.umd.min.js",
+          "globalName": "pnp.sp",
+          "globalDependencies": [
+            "@pnp/logging",
+            "@pnp/common",
+            "@pnp/odata",
+            "tslib"
+          ]
+        },
+        "tslib": {
+          "path": "https://unpkg.com/tslib@^1.10.0/tslib.js",
+          "globalName": "tslib"
+        }
+      }
+    }
+    ```
+    
+    #### [C:\react-global-news-sp2019\src\webparts\news\NewsWebPart.ts](C:\react-global-news-sp2019\src\webparts\news\NewsWebPart.ts)
+    add
+    ```JavaScript
+    require("tslib");
+    ```
+    ````

package/docs/docs/cmd/spfx/project/project-rename.md

@@ -16,26 +16,13 @@ m365 spfx project rename [options]
 `--generateNewId`
 : Generate a new solution ID for the project
 
-`-h, --help`
-: output usage information
+--8<-- "docs/cmd/_global.md"
 
-`--query [query]`
-: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
-
-`-o, --output [output]`
-: Output type. `json,text,csv,md`. Default `json`
-
-`--verbose`
-: Runs command with verbose logging
-
-`--debug`
-: Runs command with debug logging
+## Remarks
 
 !!! important
     Run this command in the folder where the project that you want to rename is located.
 
-## Remarks
-
 This command will update the project name in: _package.json_, _.yo-rc.json_, _package-solution.json_, _deploy-azure-storage.json_ and _README.md_.
 
 ## Examples
@@ -51,3 +38,7 @@ Renames SharePoint Framework project to contoso with new solution ID
 ```sh
 m365 spfx project rename --newName contoso --generateNewId
 ```
+
+## Response
+
+The command won't return a response on success.

package/docs/docs/cmd/spfx/project/project-upgrade.md

@@ -32,7 +32,7 @@ m365 spfx project upgrade [options]
 
 ## Remarks
 
-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.15.0).
+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.16.0).
 
 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.
 
@@ -85,3 +85,103 @@ Get instructions to upgrade the current SharePoint Framework project to the late
 ```sh
 m365 spfx project upgrade --output tour
 ```
+
+## Response
+
+When upgrading an SPFx project built using version 1.15.0 to SPFx version 1.15.2, you'll get output similar to following (output is truncated):
+
+=== "JSON"
+
+    ```json
+    [
+      {
+        "description": "Upgrade SharePoint Framework dependency package @microsoft/sp-core-library",
+        "id": "FN001001",
+        "file": "./package.json",
+        "position": {
+          "line": 15,
+          "character": 5
+        },
+        "resolution": "npm i -SE @microsoft/sp-core-library@1.15.2",
+        "resolutionType": "cmd",
+        "severity": "Required",
+        "title": "@microsoft/sp-core-library"
+      },
+      {
+        "description": "Update version in .yo-rc.json",
+        "id": "FN010001",
+        "file": "./.yo-rc.json",
+        "position": {
+          "line": 5,
+          "character": 5
+        },
+        "resolution": "{\\\n  \"@microsoft/generator-sharepoint\": {\\\n    \"version\": \"1.15.2\"\\\n  }\\\n}",
+        "resolutionType": "json",
+        "severity": "Recommended",
+        "title": ".yo-rc.json version"
+      }
+    ]
+    ```
+
+=== "Text"
+
+    ```text
+    Execute in bash
+    -----------------------
+    npm i -SE @microsoft/sp-core-library@1.15.2
+
+    ./.yo-rc.json
+    -------------
+    Update version in .yo-rc.json:
+    {
+      "@microsoft/generator-sharepoint": {
+        "version": "1.15.2"
+      }
+    }
+    ```
+
+=== "Markdown"
+
+    ````md
+    # Upgrade project HelloWorld to v1.15.2
+
+    Date: 20/11/2022
+
+    ## Findings
+
+    Following is the list of steps required to upgrade your project to SharePoint Framework version 1.15.2. [Summary](#Summary) of the modifications is included at the end of the report.
+
+    ### FN001001 @microsoft/sp-core-library | Required
+
+    Upgrade SharePoint Framework dependency package @microsoft/sp-core-library
+
+    Execute the following command:
+
+    ```sh
+    npm i -SE @microsoft/sp-core-library@1.15.2
+    ```
+
+    File: [./package.json:17:5](./package.json)
+
+    ## Summary
+
+    ### Execute script
+
+    ```sh
+    npm i -SE @microsoft/sp-core-library@1.15.2
+    ```
+
+    ### Modify files
+
+    #### [./.yo-rc.json](./.yo-rc.json)
+
+    Update version in .yo-rc.json:
+
+    ```json
+    {
+      "@microsoft/generator-sharepoint": {
+        "version": "1.15.2"
+      }
+    }
+    ```
+    ````

package/docs/docs/cmd/spfx/spfx-doctor.md

@@ -13,6 +13,9 @@ m365 spfx doctor [options]
 `-e, --env [env]`
 : Version of SharePoint for which to check compatibility: `sp2016|sp2019|spo`
 
+`-v, --spfxVersion [spfxVersion]`
+: Version of the SharePoint Framework Yeoman generator to check compatibility for without `v`, eg. `1.11.0`
+
 `-h, --help`
 : output usage information
 
@@ -37,7 +40,7 @@ This commands helps you to verify if your environment meets all prerequisites fo
 
 The command starts by detecting the version of SharePoint Framework that you want to use. First, it looks at the current project. If you didn't run the command in the context of a SharePoint Framework project, the command will try to determine the SharePoint Framework version based on the SharePoint Framework Yeoman generator that you have installed either in the current directory or globally.
 
-Based on the determined version of the SharePoint Framework, the command will look at other dependencies such as Node.js, npm, Yeoman, Gulp and TypeScript to verify if their meet the requirements of that particular version of the SharePoint Framework.
+Based on the determined version of the SharePoint Framework, the command will look at other dependencies such as Node.js, npm, Yeoman, Gulp CLI and TypeScript to verify if their meet the requirements of that particular version of the SharePoint Framework.
 
 If you miss any required tools or use a version that doesn't meet the SharePoint Framework requirements, the command will give you a list of recommendation how to address these issues.
 
@@ -48,14 +51,58 @@ Next to verifying the readiness of your environment to use a particular version
 
 ## Examples
 
-Verify if your environment meets the requirements to work with the SharePoint Framework
+Verify if your environment meets the requirements to work with SharePoint Framework based on the globally installed version of the SharePoint Framework Yeoman generator or the current project
 
 ```sh
-m365 spfx doctor
+m365 spfx doctor --output text
 ```
 
 Verify if your environment meets the requirements to work with the SharePoint Framework and also if the version of the SharePoint Framework that you're using is compatible with SharePoint 2019
 
 ```sh
-m365 spfx doctor --env sp2019
+m365 spfx doctor --env sp2019 --output text
+```
+
+Verify if your environment meets the requirements to work with SharePoint Framework v1.11.0
+
+```sh
+m365 spfx doctor --spfxVersion 1.11.0 --output text
 ```
+
+## Response
+
+### Response with no issues
+
+=== "Text"
+
+    ```text
+    CLI for Microsoft 365 SharePoint Framework doctor
+    Verifying configuration of your system for working with the SharePoint Framework
+
+    √ SharePoint Framework v1.15.0
+    √ Node v16.13.0    
+    √ yo v4.3.0
+    √ gulp-cli v2.3.0
+    √ bundled typescript used
+    ```
+
+### Response with issues reported
+
+When the installed version of Yeoman is lower than expected to run SharePoint Framework v1.15.0
+
+=== "Text"
+
+    ```text
+    CLI for Microsoft 365 SharePoint Framework doctor
+    Verifying configuration of your system for working with the SharePoint Framework
+
+    √ SharePoint Framework v1.15.0
+    √ Node v16.16.0
+    × yo v3.1.1 found, v^4 required
+    √ gulp-cli v2.3.0
+    √ bundled typescript used
+
+    Recommended fixes:
+
+    - npm i -g yo@4
+    ```

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

@@ -16,7 +16,7 @@ m365 spo app add [options]
 `--overwrite`
 : Set to overwrite the existing package file
 
-`-s, --scope [scope]`
+`-s, --appCatalogScope [appCatalogScope]`
 : Scope of the app catalog: `tenant,sitecollection`. Default `tenant`
 
 `-u, --appCatalogUrl [appCatalogUrl]`
@@ -51,7 +51,7 @@ m365 spo app add --filePath sharepoint/solution/spfx.sppkg --overwrite
 Add the _spfx.sppkg_ package to the site collection app catalog of site _https://contoso.sharepoint.com/sites/site1_
 
 ```sh
-m365 spo app add --filePath c:\spfx.sppkg --scope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1
+m365 spo app add --filePath c:\spfx.sppkg --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1
 ```
 
 ## More information

package/docs/docs/cmd/spo/app/app-deploy.md

@@ -22,7 +22,7 @@ m365 spo app deploy [options]
 `--skipFeatureDeployment`
 : If the app supports tenant-wide deployment, deploy it to the whole tenant
 
-`-s, --scope [scope]`
+`-s, --appCatalogScope [appCatalogScope]`
 : Scope of the app catalog: `tenant,sitecollection`. Default `tenant`
 
 --8<-- "docs/cmd/_global.md"
@@ -46,7 +46,7 @@ m365 spo app deploy --id 058140e3-0e37-44fc-a1d3-79c487d371a3
 Deploy the specified app in the site collection app catalog of site _https://contoso.sharepoint.com/sites/site1_
 
 ```sh
-m365 spo app deploy --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --scope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1
+m365 spo app deploy --id 058140e3-0e37-44fc-a1d3-79c487d371a3 --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1
 ```
 
 Deploy the app with the specified name in the tenant app catalog. Try to resolve the URL of the tenant app catalog automatically.

package/docs/docs/cmd/spo/app/app-get.md

@@ -19,7 +19,7 @@ m365 spo app get [options]
 `-u, --appCatalogUrl [appCatalogUrl]`
 : URL of the tenant or site collection app catalog. It must be specified when the scope is `sitecollection`
 
-`-s, --scope [scope]`
+`-s, --appCatalogScope [appCatalogScope]`
 : Scope of the app catalog: `tenant,sitecollection`. Default `tenant`
 
 --8<-- "docs/cmd/_global.md"
@@ -53,7 +53,7 @@ m365 spo app get --name solution.sppkg --appCatalogUrl https://contoso.sharepoin
 Return details about the app with ID _b2307a39-e878-458b-bc90-03bc578531d6_ available in the site collection app catalog of site _https://contoso.sharepoint.com/sites/site1_.
 
 ```sh
-m365 spo app get --id b2307a39-e878-458b-bc90-03bc578531d6 --scope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1
+m365 spo app get --id b2307a39-e878-458b-bc90-03bc578531d6 --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1
 ```
 
 ## More information

package/docs/docs/cmd/spo/app/app-install.md

@@ -16,7 +16,7 @@ m365 spo app install [options]
 `-s, --siteUrl <siteUrl>`
 : Absolute URL of the site to install the app in
 
-`--scope [scope]`
+`--appCatalogScope [appCatalogScope]`
 : Scope of the app catalog: `tenant,sitecollection`. Default `tenant`
 
 --8<-- "docs/cmd/_global.md"
@@ -36,7 +36,7 @@ m365 spo app install --id b2307a39-e878-458b-bc90-03bc578531d6 --siteUrl https:/
 Install the app with ID _b2307a39-e878-458b-bc90-03bc578531d6_ in the _https://contoso.sharepoint.com_ site from site collection app catalog.
 
 ```sh
-m365 spo app install --id b2307a39-e878-458b-bc90-03bc578531d6 --siteUrl https://contoso.sharepoint.com --scope sitecollection
+m365 spo app install --id b2307a39-e878-458b-bc90-03bc578531d6 --siteUrl https://contoso.sharepoint.com --appCatalogScope sitecollection
 ```
 
 ## More information

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

@@ -10,7 +10,7 @@ m365 spo app list [options]
 
 ## Options
 
-`-s, --scope [scope]`
+`-s, --appCatalogScope [appCatalogScope]`
 : Target app catalog. `tenant,sitecollection`. Default `tenant`
 
 `-u, --appCatalogUrl [appCatalogUrl]`
@@ -37,7 +37,7 @@ m365 spo app list
 Return the list of available apps from a site collection app catalog of site _https://contoso.sharepoint.com/sites/site1_.
 
 ```sh
-m365 spo app list --scope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1
+m365 spo app list --appCatalogScope sitecollection --appCatalogUrl https://contoso.sharepoint.com/sites/site1
 ```
 
 ## More information