@pnp/cli-microsoft365 7.2.0 → 7.3.0-beta.16c6462

package/dist/telemetry.js

@@ -29,14 +29,6 @@ export const telemetry = {
             commandName,
             properties
         });
-    },
-    trackException: (exception) => {
-        if (Cli.getInstance().getSettingWithDefaultValue(settingsNames.disableTelemetry, false)) {
-            return;
-        }
-        trackTelemetry({
-            exception
-        });
     }
 };
 //# sourceMappingURL=telemetry.js.map

package/docs/docs/cmd/external/connection/connection-doctor.mdx

@@ -0,0 +1,179 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# external connection doctor
+
+Checks if the external connection is correctly configured for use with a specified user experience in Microsoft 365
+
+## Usage
+
+```sh
+m365 external connection doctor [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: The ID of the external connection to check.
+
+`--ux [ux]`
+: Microsoft 365 experience for which to check compatibility. Allowed values `copilot`, `search`, `all` (default)
+
+<Global />
+
+## Remarks
+
+The `external connection doctor` command runs several automated checks to verify if an external connection is correctly configured for use with a user experience in Microsoft 365.
+
+Check|ID|UX|Type|Description
+-----|--|:--:|--|------------
+Required semantic labels|`copilotRequiredSemanticLabels`|Copilot|Required|Checks if the external connection schema has the required semantic labels configured: `title`, `url` and `iconUrl`
+Searchable properties|Copilot|`searchableProperties`|Required|Checks if the external connection schema has at least one searchable property
+Items have content ingested|`contentIngested`|Copilot|Required|Checks if external items have content ingested
+Connection configured for inline results|`enabledForInlineResults`|Copilot|Required (manual)|Check if the external connection is configured for inline results
+Items have activities recorded|`itemsHaveActivities`|Copilot|Recommended (manual)|Check if external items have activities recorded
+Meaningful connection name and description|`meaningfulNameAndDescription`|Copilot|Required (manual)|Check if the external connection has a meaningful name and description
+Semantic labels|`semanticLabels`|Search|Recommended|Checks if the external connection schema uses semantic labels
+Searchable properties|`searchableProperties`|Search|Recommended|Checks if the external connection schema has at least one searchable property
+Result types|`resultType`|Search|Recommended|Checks if the external connection has a result type configured
+Items have content ingested|`contentIngested`|Search|Recommended|Checks if external items have content ingested
+Items have activities recorded|`itemsHaveActivities`|Search|Recommended|Check if external items have activities recorded
+urlToItemResolver configured|`urlToItemResolver`|All|Recommended|Checks if the external connection has at least one urlToItemResolver configured
+
+Required checks must pass for the external connection to be compatible with the specified user experience. Recommended checks are optional, but recommended for optimal user experience.
+
+Some checks must be done manually, because there are no APIs available to verify the configuration automatically.
+
+When you check the compatibility with all UXs, and there are multiple checks with the same ID, the command will use the first matching check, following the order listed above.
+
+## Examples
+
+Checks if the external connection with the specified ID is correctly configured for use with Copilot for Microsoft 365.
+
+```sh
+m365 external connection doctor --id contosoproducts --ux copilot
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "loadExternalConnection",
+      "text": "Load connection",
+      "type": "required",
+      "status": "passed"
+    },
+    {
+      "id": "loadSchema",
+      "text": "Load schema",
+      "type": "required",
+      "status": "passed"
+    },
+    {
+      "id": "copilotRequiredSemanticLabels",
+      "text": "Required semantic labels",
+      "type": "required",
+      "errorMessage": "Missing label iconUrl",
+      "status": "failed"
+    },
+    {
+      "id": "searchableProperties",
+      "text": "Searchable properties",
+      "type": "required",
+      "status": "passed"
+    },
+    {
+      "id": "contentIngested",
+      "text": "Items have content ingested",
+      "type": "required",
+      "status": "passed"
+    },
+    {
+      "id": "enabledForInlineResults",
+      "text": "Connection configured for inline results",
+      "type": "required",
+      "status": "manual"
+    },
+    {
+      "id": "itemsHaveActivities",
+      "text": "Items have activities recorded",
+      "type": "recommended",
+      "status": "manual"
+    },
+    {
+      "id": "meaningfulNameAndDescription",
+      "text": "Meaningful connection name and description",
+      "type": "required",
+      "status": "manual"
+    },
+    {
+      "id": "urlToItemResolver",
+      "text": "urlToItemResolver configured",
+      "type": "recommended",
+      "status": "passed"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  ✔ Load connection
+  ✔ Load schema
+  ✖ Required semantic labels: Missing label iconUrl
+  ✔ Searchable properties
+  ✔ Items have content ingested
+  ℹ Connection configured for inline results (manual)
+  ℹ Items have activities recorded (manual)
+  ℹ Meaningful connection name and description (manual)
+  ✔ urlToItemResolver configured
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,text,type,status,errorMessage
+  loadExternalConnection,Load connection,required,passed,
+  loadSchema,Load schema,required,passed,
+  copilotRequiredSemanticLabels,Required semantic labels,required,failed,Missing label iconUrl
+  searchableProperties,Searchable properties,required,passed,
+  contentIngested,Items have content ingested,required,passed,
+  enabledForInlineResults,Connection configured for inline results,required,manual,
+  itemsHaveActivities,Items have activities recorded,recommended,manual,
+  meaningfulNameAndDescription,Meaningful connection name and description,required,manual,
+  urlToItemResolver,urlToItemResolver configured,recommended,passed,
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # external connection doctor --id "msgraphdocs" --ux "copilot"
+
+  Date: 11/23/2023
+
+  Check|Type|Status|Error message
+  :----|:--:|:----:|:------------
+  Load connection|required|passed|
+  Load schema|required|passed|
+  Required semantic labels|required|failed|Missing label iconUrl
+  Searchable properties|required|passed|
+  Items have content ingested|required|passed|
+  Connection configured for inline results|required|manual|
+  Items have activities recorded|recommended|manual|
+  Meaningful connection name and description|required|manual|
+  urlToItemResolver configured|recommended|passed|
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+- Microsoft Graph connector experiences: [https://learn.microsoft.com/graph/connecting-external-content-experiences](https://learn.microsoft.com/graph/connecting-external-content-experiences)

package/docs/docs/cmd/external/item/item-add.mdx

@@ -0,0 +1,145 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# external item add
+
+Creates external item
+
+## Usage
+
+```sh
+m365 external item add [options]
+```
+
+## Options
+
+```md definition-list
+`-i, --id <id>`
+: The ID of the item to create
+
+`--externalConnectionId <name>`
+: The ID of the external connection on which to create the item
+
+`--content <content>`
+: External item content
+
+`--contentType [contentType]`
+: Type of content to load. Allowed values: `text` (default), `html`
+
+`--acls <acls>`
+: List of permissions to set on the item, in the format `accessType1,type1,value1;accessType2,type2,value2`, eg. `grant,everyone,everyone`
+```
+<Global />
+
+## Remarks
+
+When creating an external item, the options you specify will map to the external item properties, eg. `--author "Steve"` will set the `author` property of the external item to `Steve`.
+
+If in your schema you have a multi-value property, to specify its value you need two things:
+
+- you need to separate multiple values using `;#`, eg. `--author "Steve;#Bill"`
+- you need to specify the type of the property as defined in the schema, eg. `--author@odata.type "Collection(String)"`
+
+When creating items you can specify one or more permissions that define who can access the external item. The format of the permissions is `accessType1,type1,value1;accessType2,type2,value2`, eg. `grant,everyone,everyone`.
+
+You can use the following access types:
+
+- `grant` - grants access to the specified users or groups
+- `deny` - denies access to the specified users or groups
+
+You can use the following types:
+
+- `everyone` - everyone
+- `group` - an Entra group
+- `user` - an Entra user
+- `everyoneExceptGuests` - everyone except external users
+- `externalGroup` - a group defined in the external system from which you're importing the content
+
+For more information about using these options, see the Microsoft Graph API documentation and documentation about Microsoft Graph connectors.
+
+## Examples
+
+Creates an external item with simple properties that everyone is allowed to access
+
+```sh
+m365 external item add --id "pnp-ensure-siteassets-library" --connectionId "samplesolutiongallery" --content "Ensure that the Site Assets library is created." --title "Ensure the Site Assets Library is created" --description "Ensure that the Site Assets library is created." --authors "Phil Harding" --acls "grant,everyone,everyone"
+```
+
+Creates an external item with multi-value properties accessible only to users from the specified Entra group
+
+```sh
+m365 external item add --id "pnp-ensure-siteassets-library" --connectionId "samplesolutiongallery" --content "Ensure that the Site Assets library is created." --title "Ensure the Site Assets Library is created" --description "Ensure that the Site Assets library is created." --authors@odata.type "Collection(String)" --authors "Phil Harding;#Steve Smith" --acls "grant,group,Super users"
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "pnp-ensure-siteassets-library",
+    "acl": [
+      {
+        "type": "everyone",
+        "value": "everyone",
+        "accessType": "grant"
+      }
+    ],
+    "properties": {
+      "title": "Ensure the Site Assets Library is created",
+      "description": "Ensure that the Site Assets library is created.",
+      "authors": "Phil Harding"
+    },
+    "content": {
+      "value": "Ensure that the Site Assets library is created.",
+      "type": "text"
+    },
+    "activities": []
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  acl       : [{"type":"everyone","value":"everyone","accessType":"grant"}]
+  activities: []
+  content   : {"value":"Ensure that the Site Assets library is created.","type":"text"}
+  id        : pnp-ensure-siteassets-library
+  properties: {"title":"Ensure the Site Assets Library is created","description":"Ensure that the Site Assets library is created.","authors":"Phil Harding"}
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id
+  pnp-ensure-siteassets-library
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # m365 external item add --id "pnp-ensure-siteassets-library" --connectionId "samplesolutiongallery" --content "Ensure that the Site Assets library is created." --title "Ensure the Site Assets Library is created" --description "Ensure that the Site Assets library is created." --authors "Phil Harding" --acls "grant,everyone,everyone"
+
+  Date: 2023-10-28
+
+  ## pnp-ensure-siteassets-library
+
+  Property | Value
+  ---------|-------
+  id | pnp-ensure-siteassets-library
+  ```
+
+  </TabItem>
+</Tabs>
+
+## More information
+
+- Microsoft Graph connectors access control list [https://learn.microsoft.com/graph/connecting-external-content-manage-items#access-control-list](https://learn.microsoft.com/graph/connecting-external-content-manage-items#access-control-list)
+- Create, update, and delete items added by your application via Microsoft Graph connectors [https://learn.microsoft.com/graph/connecting-external-content-manage-items](https://learn.microsoft.com/graph/connecting-external-content-manage-items)
+- Use external groups to manage permissions to Microsoft Graph connectors data sources [https://learn.microsoft.com/graph/connecting-external-content-external-groups](https://learn.microsoft.com/graph/connecting-external-content-external-groups)
+- Create externalItem [https://learn.microsoft.com/graph/api/externalconnectors-externalconnection-put-items?view=graph-rest-1.0&tabs=http](https://learn.microsoft.com/graph/api/externalconnectors-externalconnection-put-items?view=graph-rest-1.0&tabs=http)

package/docs/docs/cmd/teams/user/user-app-remove.mdx

@@ -13,8 +13,11 @@ m365 teams user app remove [options]
 ## Options
 
 ```md definition-list
-`--id <id>`
-: The unique id of the app instance installed for the user.
+`--id [id]`
+: The unique id of the app instance installed for the user. Specify either `id` or `name`.
+
+`--name [name]`
+: Name of the app instance installed for the user. Specify either `id` or `name`.
 
 `--userId [userId]`
 : The ID of the user to uninstall the app for. Specify `userId` or `userName` but not both.
@@ -35,18 +38,24 @@ Do not use the ID from the manifest of the zip app package or the id from the Mi
 
 ## Examples
 
-Uninstall an app for the specified user.
+Uninstall an app by id for the specified user.
 
 ```sh
 m365 teams user app remove --id YzUyN2E0NzAtYTg4Mi00ODFjLTk4MWMtZWU2ZWZhYmE4NWM3IyM0ZDFlYTA0Ny1mMTk2LTQ1MGQtYjJlOS0wZDI4NTViYTA1YTY= --userId 2609af39-7775-4f94-a3dc-0dd67657e900
 ```
 
-Uninstall an app for the specified user using its UPN.
+Uninstall an app by id for the specified user using its UPN.
 
 ```sh
 m365 teams user app remove --id YzUyN2E0NzAtYTg4Mi00ODFjLTk4MWMtZWU2ZWZhYmE4NWM3IyM0ZDFlYTA0Ny1mMTk2LTQ1MGQtYjJlOS0wZDI4NTViYTA1YTY= --userName admin@contoso.com
 ```
 
+Uninstall an app by name for the specified user.
+
+```sh
+m365 teams user app remove --name HelloWorld --userId 2609af39-7775-4f94-a3dc-0dd67657e900
+```
+
 ## Response
 
 The command won't return a response on success.

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "7.2.0",
+  "version": "7.3.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@pnp/cli-microsoft365",
-      "version": "7.2.0",
+      "version": "7.3.0",
       "license": "MIT",
       "dependencies": {
         "@azure/msal-common": "^13.2.1",
@@ -47,7 +47,7 @@
         "microsoft365": "dist/index.js"
       },
       "devDependencies": {
-        "@microsoft/microsoft-graph-types": "^2.38.0",
+        "@microsoft/microsoft-graph-types": "^2.40.0",
         "@types/adm-zip": "^0.5.4",
         "@types/jmespath": "^0.15.2",
         "@types/json-to-ast": "^2.1.4",
@@ -506,9 +506,9 @@
       "integrity": "sha512-2IHAOaLauc8qaAitvWS+U931T+ze+7MNWrDHY47IENP5y2UA0vqJDu67kWZDdpCN1fFC77sfgfB+HV7SrKshnQ=="
     },
     "node_modules/@microsoft/microsoft-graph-types": {
-      "version": "2.38.0",
-      "resolved": "https://registry.npmjs.org/@microsoft/microsoft-graph-types/-/microsoft-graph-types-2.38.0.tgz",
-      "integrity": "sha512-EXpTf/TFUb0EfBXiQ0rTmZf6fRgBn73lNfYdU2QKvqiMPQD/Cs2Gt+VmWVtK19F9Mf5Mt4bDTu5Ft0TGXOF8rA==",
+      "version": "2.40.0",
+      "resolved": "https://registry.npmjs.org/@microsoft/microsoft-graph-types/-/microsoft-graph-types-2.40.0.tgz",
+      "integrity": "sha512-1fcPVrB/NkbNcGNfCy+Cgnvwxt6/sbIEEFgZHFBJ670zYLegENYJF8qMo7x3LqBjWX2/Eneq5BVVRCLTmlJN+g==",
       "dev": true
     },
     "node_modules/@microsoft/recognizers-text-data-types-timex-expression": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "7.2.0",
+  "version": "7.3.0-beta.16c6462",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",
@@ -276,7 +276,7 @@
     "yaml": "^2.3.4"
   },
   "devDependencies": {
-    "@microsoft/microsoft-graph-types": "^2.38.0",
+    "@microsoft/microsoft-graph-types": "^2.40.0",
     "@types/adm-zip": "^0.5.4",
     "@types/jmespath": "^0.15.2",
     "@types/json-to-ast": "^2.1.4",
@@ -300,4 +300,4 @@
     "sinon": "^15.2.0",
     "source-map-support": "^0.5.21"
   }
-}
+}