npm - @pnp/cli-microsoft365 - Versions diffs - 6.8.0-beta.f473be5 → 6.9.0-beta.1cd2525 - Mend

@pnp/cli-microsoft365 6.8.0-beta.f473be5 → 6.9.0-beta.1cd2525

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 (1492) hide show

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

@@ -1,62 +0,0 @@
-# spfx package generate
-Generates SharePoint Framework solution package with a no-framework web part rendering the specified HTML snippet
-## Usage
-```sh
-m365 spfx package generate
-```
-## Options
-`-t, --webPartTitle <webPartTitle>`
-: Title of the web part to generate. Displayed in the tool box when adding web part to page
-`-d, --webPartDescription <webPartDescription>`
-: Description of the web part to generate. Displayed in the tool box when adding web part to page
-`-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>`
-: HTML snippet to embed in the web part. Can contain `<script>` and `<style>` tags.
-`--enableForTeams [enableForTeams]`
-: Specify, to make the generated web part available in Microsoft Teams. Specify `tab` to make the web part available as a configurable tab, `personalTab` to make it available as a personal tab or `all` to make it available both as a configurable and personal tab. By default the web part will not be available in Microsoft Teams.
-`--exposePageContextGlobally`
-: Set, to make the `legacyPageContext` exposed by SharePoint Framework available at `window._spPageContextInfo` for use in the HTML snippet of the web part
-`--exposeTeamsContextGlobally`
-: Set, to make the Microsoft Teams context exposed by SharePoint Framework available at `window._teamsContextInfo` for use in the HTML snippet of the web part
-`--allowTenantWideDeployment`
-: Set, to allow the solution package to be deployed globally to all sites
-`--developerName [developerName]`
-: Name of your organization. Displayed in Microsoft Teams when adding the solution as a (personal) tab. If not specified set to `Contoso`.
-`--developerPrivacyUrl [developerPrivacyUrl]`
-: URL of the privacy policy for this solution. Displayed in Microsoft Teams when adding the solution as a (personal) tab. If not specified, set to `https://contoso.com/privacy`.
-`--developerTermsOfUseUrl [developerTermsOfUseUrl]`
-: URL of the terms of use for this solution. Displayed in Microsoft Teams when adding the solution as a (personal) tab. If not specified, set to `https://contoso.com/terms-of-use`.
-`--developerWebsiteUrl [developerWebsiteUrl]`
-: URL of your organization's website. Displayed in Microsoft Teams when adding the solution as a (personal) tab. If not specified, set to `https://contoso.com/my-app`.
-`--developerMpnId [developerMpnId]`
-: Microsoft Partner Network ID of your organization. If not specified, set to `000000`.
-## Examples
-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" --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 DELETED Viewed

@@ -1,156 +0,0 @@
-# spfx project doctor
-Validates correctness of a SharePoint Framework project
-## Usage
-```sh
-m365 spfx project doctor [options]
-```
-## Options
-`--packageManager [packageManager]`
-: The package manager you use. Supported managers `npm,pnpm,yarn`. Default `npm`
-`-h, --help`
-: output usage information
-`--query [query]`
-: JMESPath query string. See [http://jmespath.org/](http://jmespath.org/) for more information and examples
-`-o, --output [output]`
-: Output type. `json,text,tour,csv`. Default `json`
-`--verbose`
-: Runs command with verbose logging
-`--debug`
-: Runs command with debug logging
-## Remarks
-The `spfx project doctor` command helps you validate that your SharePoint Framework project is set up correctly. The command automatically detects the version of your project using version information specified in the project's .yo-rc.json file or package.json (if no version information is included in .yo-rc.json). Based on the detected project version, the command executes several checks and reports any issues in the specified format.
-This command doesn't change your project files. Instead, it gives you a report with all steps necessary to validate 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.
-!!! important
-    Run this command in the folder where the project that you want to validate is located. This command doesn't change your project files.
-## Examples
-Validate if your project is correctly set up and save the findings in a Markdown file
-```sh
-m365 spfx project doctor --output md > "doctor-report.md"
-```
-Validate if your project is correctly set up and show the summary of the findings in the terminal
-```sh
-m365 spfx project doctor --output text
-```
-Validate if your project is correctly set up and get instructions to fix any issues using pnpm
-```sh
-m365 spfx project doctor --packageManager pnpm --output text
-```
-Validate if your project is correctly set up and get instructions to fix any issues in a [CodeTour](https://aka.ms/codetour) file
-```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 DELETED Viewed

@@ -1,171 +0,0 @@
-# spfx project externalize
-Externalizes SharePoint Framework project dependencies
-## Usage
-```sh
-m365 spfx project externalize [options]
-```
-## Options
-`-f, --outputFile [outputFile]`
-: Path to the file where the report should be stored in
-`-h, --help`
-: output usage information
-`--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 for which you want to externalize dependencies is located. This command doesn't change your project files.
-!!! attention
-    This command is in preview and could change once it's officially released. If you see any room for improvement, we'd love to hear from you at [https://github.com/pnp/cli-microsoft365/issues](https://github.com/pnp/cli-microsoft365/issues).
-The `spfx project externalize` command helps you externalize your SharePoint Framework project dependencies using the [unpkg CDN](https://unpkg.com/).
-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
-```sh
-m365 spfx project externalize --output md > "deps-report.md"
-```
-Get instructions to externalize the current SharePoint Framework project dependencies and show the summary of the findings in the terminal
-```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-permissions-grant.md DELETED Viewed

@@ -1,86 +0,0 @@
-# spfx project permissions grant
-Grant API permissions defined in the current SPFx project
-## Usage
-```sh
-m365 spfx project permissions grant [options]
-```
-## Options
---8<-- "docs/cmd/_global.md"
-## Remarks
-!!! important
-    Run this command in the folder where the project is located from where you want to grant the permissions.
-This command grant the permissions defined in: _package-solution.json_.
-## Examples
-Grant API permissions requested in the current SPFx project
-```sh
-m365 spfx project permissions grant
-```
-## Response
-=== "JSON"
-    ```json
-    {
-      "ClientId": "6004a642-185c-479a-992a-15d1c23e2229",
-      "ConsentType": "AllPrincipals",
-      "IsDomainIsolated": false,
-      "ObjectId": "QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY",
-      "PackageName": null,
-      "Resource": "Microsoft Graph",
-      "ResourceId": "a46b0017-21e2-4db1-bc69-ca63576a38d6",
-      "Scope": "Mail.Read"
-    }
-    ```
-=== "Text"
-    ```text
-    ClientId        : 6004a642-185c-479a-992a-15d1c23e2229
-    ConsentType     : AllPrincipals
-    IsDomainIsolated: false
-    ObjectId        : QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
-    PackageName     : null
-    Resource        : Microsoft Graph
-    ResourceId      : a46b0017-21e2-4db1-bc69-ca63576a38d6
-    Scope           : Mail.Read
-    ```
-=== "CSV"
-    ```csv
-    ClientId,ConsentType,IsDomainIsolated,ObjectId,PackageName,Resource,ResourceId,Scope
-    6004a642-185c-479a-992a-15d1c23e2229,AllPrincipals,,QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY,,Microsoft Graph,a46b0017-21e2-4db1-bc69-ca63576a38d6,Mail.Read
-    ```
-=== "Markdown"
-    ```md
-    # spfx project permissions grant
-    Date: 2/17/2023
-    ## QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
-    Property | Value
-    ---------|-------
-    ClientId | 6004a642-185c-479a-992a-15d1c23e2229
-    ConsentType | AllPrincipals
-    IsDomainIsolated | false
-    ObjectId | QqYEYFwYmkeZKhXRwj4iKRcAa6TiIbFNvGnKY1dqONY
-    PackageName | null
-    Resource | Microsoft Graph
-    ResourceId | a46b0017-21e2-4db1-bc69-ca63576a38d6
-    Scope | Mail.Read
-    ```

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

@@ -1,44 +0,0 @@
-# spfx project rename
-Renames SharePoint Framework project
-## Usage
-```sh
-m365 spfx project rename [options]
-```
-## Options
-`-n, --newName <newName>`
-: New name for the project
-`--generateNewId`
-: Generate a new solution ID for the project
---8<-- "docs/cmd/_global.md"
-## Remarks
-!!! important
-    Run this command in the folder where the project that you want to rename is located.
-This command will update the project name in: _package.json_, _.yo-rc.json_, _package-solution.json_, _deploy-azure-storage.json_ and _README.md_.
-## Examples
-Renames SharePoint Framework project to contoso
-```sh
-m365 spfx project rename --newName contoso
-```
-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 DELETED Viewed

@@ -1,187 +0,0 @@
-# spfx project upgrade
-Upgrades SharePoint Framework project to the specified version
-## Usage
-```sh
-m365 spfx project upgrade [options]
-```
-## Options
-`-v, --toVersion [toVersion]`
-: The version of SharePoint Framework to which upgrade the project
-`--packageManager [packageManager]`
-: The package manager you use. Supported managers `npm,pnpm,yarn`. Default `npm`
-`--shell [shell]`
-: The shell you use. Supported shells `bash,powershell,cmd`. Default `bash`
-`--preview`
-: Upgrade project to the latest SPFx preview version
-`-f, --outputFile [outputFile]`
-: Path to the file where the upgrade report should be stored in. Ignored when `output` is `tour`
---8<-- "docs/cmd/_global.md"
-## 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.17.1).
-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.
-!!! important
-    Run this command in the folder where the project that you want to upgrade is located. This command doesn't change your project files.
-## Examples
-Get instructions to upgrade the current SharePoint Framework project to SharePoint Framework version 1.5.0 and save the findings in a Markdown file
-```sh
-m365 spfx project upgrade --toVersion 1.5.0 --output md > "upgrade-report.md"
-```
-Get instructions to upgrade the current SharePoint Framework project to SharePoint Framework version 1.5.0 and show the summary of the findings in the shell
-```sh
-m365 spfx project upgrade --toVersion 1.5.0 --output text
-```
-Get instructions to upgrade the current SharePoint Framework project to the latest preview version
-```sh
-m365 spfx project upgrade --preview --output text
-```
-Get instructions to upgrade the current SharePoint Framework project to the specified preview version
-```sh
-m365 spfx project upgrade --toVersion 1.12.1-rc.0 --output text
-```
-Get instructions to upgrade the current SharePoint Framework project to the latest SharePoint Framework version supported by the CLI for Microsoft 365 using pnpm
-```sh
-m365 spfx project upgrade --packageManager pnpm --output text
-```
-Get instructions to upgrade the current SharePoint Framework project to the latest SharePoint Framework version supported by the CLI for Microsoft 365
-```sh
-m365 spfx project upgrade --output text
-```
-Get instructions to upgrade the current SharePoint Framework project to the latest SharePoint Framework version supported by the CLI for Microsoft 365 using PowerShell
-```sh
-m365 spfx project upgrade --shell powershell --output text
-```
-Get instructions to upgrade the current SharePoint Framework project to the latest version of SharePoint Framework and save the findings in a [CodeTour](https://aka.ms/codetour) file
-```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"
-      }
-    }
-    ```
-    ````