@pnp/cli-microsoft365 12.0.0-beta.c9bd7f3 → 12.0.0-beta.d654135

package/dist/m365/entra/commands/m365group/m365group-remove.js

@@ -32,10 +32,6 @@ class EntraM365GroupRemoveCommand extends GraphCommand {
         __classPrivateFieldGet(this, _EntraM365GroupRemoveCommand_instances, "m", _EntraM365GroupRemoveCommand_initTypes).call(this);
     }
     async commandAction(logger, args) {
-        if (args.options.skipRecycleBin) {
-            await this.warn(logger, `Option 'skipRecycleBin' is deprecated. Please use 'permanent' instead.`);
-            args.options.permanent = true;
-        }
         const removeGroup = async () => {
             if (this.verbose) {
                 await logger.logToStderr(`Removing Microsoft 365 Group: ${args.options.id || args.options.displayName}...`);
@@ -173,7 +169,7 @@ _EntraM365GroupRemoveCommand_instances = new WeakSet(), _EntraM365GroupRemoveCom
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
             force: (!(!args.options.force)).toString(),
-            permanent: !!(args.options.permanent || args.options.skipRecycleBin)
+            permanent: !!args.options.permanent
         });
     });
 }, _EntraM365GroupRemoveCommand_initOptions = function _EntraM365GroupRemoveCommand_initOptions() {
@@ -185,8 +181,6 @@ _EntraM365GroupRemoveCommand_instances = new WeakSet(), _EntraM365GroupRemoveCom
         option: '-f, --force'
     }, {
         option: '--permanent'
-    }, {
-        option: '--skipRecycleBin'
     });
 }, _EntraM365GroupRemoveCommand_initValidators = function _EntraM365GroupRemoveCommand_initValidators() {
     this.validators.push(async (args) => {
@@ -199,7 +193,7 @@ _EntraM365GroupRemoveCommand_instances = new WeakSet(), _EntraM365GroupRemoveCom
     this.optionSets.push({ options: ['id', 'displayName'] });
 }, _EntraM365GroupRemoveCommand_initTypes = function _EntraM365GroupRemoveCommand_initTypes() {
     this.types.string.push('id', 'displayName');
-    this.types.boolean.push('permanent', 'skipRecycleBin');
+    this.types.boolean.push('permanent');
 };
 EntraM365GroupRemoveCommand.maxRetries = 10;
 export default new EntraM365GroupRemoveCommand();

package/dist/m365/spo/commands/navigation/navigation-node-list.js

@@ -1,6 +1,6 @@
 import { globalOptionsZod } from '../../../../Command.js';
 import { z } from 'zod';
-import { odata } from '../../../../utils/odata.js';
+import { spo } from '../../../../utils/spo.js';
 import { validation } from '../../../../utils/validation.js';
 import SpoCommand from '../../../base/SpoCommand.js';
 import commands from '../../commands.js';
@@ -21,7 +21,7 @@ class SpoNavigationNodeListCommand extends SpoCommand {
         return 'Lists nodes from the specified site navigation';
     }
     defaultProperties() {
-        return ['Id', 'Title', 'Url'];
+        return ['Key', 'Title', 'SimpleUrl'];
     }
     get schema() {
         return options;
@@ -31,8 +31,10 @@ class SpoNavigationNodeListCommand extends SpoCommand {
             await logger.logToStderr(`Retrieving navigation nodes...`);
         }
         try {
-            const res = await odata.getAllItems(`${args.options.webUrl}/_api/web/navigation/${args.options.location.toLowerCase()}?$expand=Children,Children/Children,Children/Children/Children`);
-            await logger.log(res);
+            const menuState = args.options.location === 'TopNavigationBar'
+                ? await spo.getTopNavigationMenuState(args.options.webUrl)
+                : await spo.getQuickLaunchMenuState(args.options.webUrl);
+            await logger.log(menuState.Nodes);
         }
         catch (err) {
             this.handleRejectedODataJsonPromise(err);

package/dist/m365/spo/commands/site/site-remove.js

@@ -31,10 +31,6 @@ class SpoSiteRemoveCommand extends SpoCommand {
         __classPrivateFieldGet(this, _SpoSiteRemoveCommand_instances, "m", _SpoSiteRemoveCommand_initTypes).call(this);
     }
     async commandAction(logger, args) {
-        if (args.options.skipRecycleBin) {
-            await this.warn(logger, `Option 'skipRecycleBin' is deprecated. Please use 'permanent' instead.`);
-            args.options.permanent = true;
-        }
         if (args.options.force) {
             await this.removeSite(logger, args.options);
         }
@@ -195,7 +191,7 @@ class SpoSiteRemoveCommand extends SpoCommand {
 _SpoSiteRemoveCommand_instances = new WeakSet(), _SpoSiteRemoveCommand_initTelemetry = function _SpoSiteRemoveCommand_initTelemetry() {
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
-            permanent: !!(args.options.permanent || args.options.skipRecycleBin),
+            permanent: !!args.options.permanent,
             fromRecycleBin: !!args.options.fromRecycleBin,
             force: !!args.options.force
         });
@@ -205,8 +201,6 @@ _SpoSiteRemoveCommand_instances = new WeakSet(), _SpoSiteRemoveCommand_initTelem
         option: '-u, --url <url>'
     }, {
         option: '--permanent'
-    }, {
-        option: '--skipRecycleBin'
     }, {
         option: '--fromRecycleBin'
     }, {
@@ -223,14 +217,14 @@ _SpoSiteRemoveCommand_instances = new WeakSet(), _SpoSiteRemoveCommand_initTelem
         if (rootUrl.toLowerCase() === urlUtil.removeTrailingSlashes(args.options.url.toLowerCase())) {
             return `The root site cannot be deleted.`;
         }
-        if (args.options.fromRecycleBin && (args.options.permanent || args.options.skipRecycleBin)) {
+        if (args.options.fromRecycleBin && args.options.permanent) {
             return 'Specify either fromRecycleBin or permanent, but not both.';
         }
         return true;
     });
 }, _SpoSiteRemoveCommand_initTypes = function _SpoSiteRemoveCommand_initTypes() {
     this.types.string.push('url');
-    this.types.boolean.push('permanent', 'skipRecycleBin', 'fromRecycleBin', 'force');
+    this.types.boolean.push('permanent', 'fromRecycleBin', 'force');
 };
 export default new SpoSiteRemoveCommand();
 //# sourceMappingURL=site-remove.js.map

package/dist/m365/spo/commands/tenant/tenant-appcatalog-add.js

@@ -73,7 +73,7 @@ class SpoTenantAppCatalogAddCommand extends SpoCommand {
             }
             const siteRemoveOptions = {
                 url: url,
-                skipRecycleBin: true,
+                permanent: true,
                 wait: true,
                 force: true,
                 verbose: this.verbose,

package/dist/m365/spo/commands/web/web-rule-get.js

@@ -0,0 +1,47 @@
+import { z } from 'zod';
+import { globalOptionsZod } from '../../../../Command.js';
+import request from '../../../../request.js';
+import { formatting } from '../../../../utils/formatting.js';
+import { validation } from '../../../../utils/validation.js';
+import SpoCommand from '../../../base/SpoCommand.js';
+import commands from '../../commands.js';
+const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    webUrl: z.string().alias('u')
+        .refine(url => validation.isValidSharePointUrl(url) === true, {
+        error: e => `'${e.input}' is not a valid SharePoint URL.`
+    }),
+    id: z.uuid()
+});
+class SpoWebRuleGetCommand extends SpoCommand {
+    get name() {
+        return commands.WEB_RULE_GET;
+    }
+    get description() {
+        return 'Retrieves details of a specific rule from a SharePoint site list';
+    }
+    get schema() {
+        return options;
+    }
+    async commandAction(logger, args) {
+        try {
+            if (this.verbose) {
+                await logger.logToStderr(`Retrieving rule with id '${args.options.id}' from site '${args.options.webUrl}'...`);
+            }
+            const requestOptions = {
+                url: `${args.options.webUrl}/_api/web/alerts/GetById('${formatting.encodeQueryParameter(args.options.id)}')?$expand=List,User,List/Rootfolder&$select=*,List/Id,List/Title,List/Rootfolder/ServerRelativeUrl`,
+                headers: {
+                    accept: 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            const res = await request.get(requestOptions);
+            await logger.log(res);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+}
+export default new SpoWebRuleGetCommand();
+//# sourceMappingURL=web-rule-get.js.map

package/dist/m365/spo/commands/web/web-rule-list.js

@@ -0,0 +1,113 @@
+import { z } from 'zod';
+import { cli } from '../../../../cli/cli.js';
+import { globalOptionsZod } from '../../../../Command.js';
+import { entraUser } from '../../../../utils/entraUser.js';
+import { formatting } from '../../../../utils/formatting.js';
+import { odata } from '../../../../utils/odata.js';
+import { spo } from '../../../../utils/spo.js';
+import { validation } from '../../../../utils/validation.js';
+import SpoCommand from '../../../base/SpoCommand.js';
+import commands from '../../commands.js';
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    webUrl: z.string().alias('u')
+        .refine(url => validation.isValidSharePointUrl(url) === true, {
+        error: e => `'${e.input}' is not a valid SharePoint site URL.`
+    }),
+    listId: z.uuid().optional(),
+    listUrl: z.string().optional(),
+    listTitle: z.string().optional(),
+    userName: z.string().optional().refine(upn => typeof upn === 'undefined' || validation.isValidUserPrincipalName(upn), {
+        error: e => `'${e.input}' is not a valid UPN.`
+    }),
+    userId: z.uuid().optional()
+});
+class SpoWebRuleListCommand extends SpoCommand {
+    get name() {
+        return commands.WEB_RULE_LIST;
+    }
+    get description() {
+        return 'Lists all SharePoint list alerts';
+    }
+    defaultProperties() {
+        return ['ID', 'Title', 'UserPrincipalName'];
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => [options.listId, options.listUrl, options.listTitle].filter(x => x !== undefined).length <= 1, {
+            error: `Specify either listId, listUrl, or listTitle, but not more than one.`,
+            params: {
+                customCode: 'optionSet',
+                options: ['listId', 'listUrl', 'listTitle']
+            }
+        })
+            .refine(options => [options.userName, options.userId].filter(x => x !== undefined).length <= 1, {
+            error: `Specify either userName or userId, but not both.`,
+            params: {
+                customCode: 'optionSet',
+                options: ['userName', 'userId']
+            }
+        });
+    }
+    async commandAction(logger, args) {
+        if (this.verbose) {
+            const listParams = args.options.listId || args.options.listTitle || args.options.listUrl;
+            const userParams = args.options.userName || args.options.userId;
+            let message = `Retrieving alerts from site '${args.options.webUrl}'`;
+            if (listParams) {
+                message += ` for list '${listParams}'`;
+            }
+            if (userParams) {
+                message += `${listParams ? ' and' : ''} for user '${userParams}'`;
+            }
+            await logger.logToStderr(`${message}...`);
+        }
+        let requestUrl = `${args.options.webUrl}/_api/web/alerts?$expand=List,User,List/Rootfolder,Item&$select=*,List/Id,List/Title,List/Rootfolder/ServerRelativeUrl,Item/ID,Item/FileRef,Item/Guid`;
+        const filters = [];
+        let listId;
+        if (args.options.listId) {
+            listId = args.options.listId;
+        }
+        else if (args.options.listUrl || args.options.listTitle) {
+            try {
+                listId = await spo.getListId(args.options.webUrl, args.options.listTitle, args.options.listUrl, logger, this.verbose);
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        }
+        if (listId) {
+            filters.push(`List/Id eq guid'${formatting.encodeQueryParameter(listId)}'`);
+        }
+        if (args.options.userName) {
+            filters.push(`User/UserPrincipalName eq '${formatting.encodeQueryParameter(args.options.userName)}'`);
+        }
+        else if (args.options.userId) {
+            const userPrincipalName = await entraUser.getUpnByUserId(args.options.userId);
+            filters.push(`User/UserPrincipalName eq '${formatting.encodeQueryParameter(userPrincipalName)}'`);
+        }
+        if (filters.length > 0) {
+            requestUrl += `&$filter=${filters.join(' and ')}`;
+        }
+        try {
+            const res = await odata.getAllItems(requestUrl);
+            res.forEach(alert => {
+                if (alert.Item) {
+                    delete alert.Item['ID'];
+                }
+                if (cli.shouldTrimOutput(args.options.output)) {
+                    alert.UserPrincipalName = alert.User?.UserPrincipalName;
+                }
+            });
+            await logger.log(res);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+}
+export default new SpoWebRuleListCommand();
+//# sourceMappingURL=web-rule-list.js.map

package/dist/m365/spo/commands/web/web-rule-remove.js

@@ -0,0 +1,54 @@
+import { z } from 'zod';
+import { cli } from '../../../../cli/cli.js';
+import { globalOptionsZod } from '../../../../Command.js';
+import request from '../../../../request.js';
+import { formatting } from '../../../../utils/formatting.js';
+import { validation } from '../../../../utils/validation.js';
+import SpoCommand from '../../../base/SpoCommand.js';
+import commands from '../../commands.js';
+const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    webUrl: z.string().alias('u')
+        .refine(url => validation.isValidSharePointUrl(url) === true, {
+        error: e => `'${e.input}' is not a valid SharePoint URL.`
+    }),
+    id: z.uuid(),
+    force: z.boolean().optional().alias('f')
+});
+class SpoWebRuleRemoveCommand extends SpoCommand {
+    get name() {
+        return commands.WEB_RULE_REMOVE;
+    }
+    get description() {
+        return 'Removes an alert from a SharePoint list';
+    }
+    get schema() {
+        return options;
+    }
+    async commandAction(logger, args) {
+        if (!args.options.force) {
+            const result = await cli.promptForConfirmation({ message: `Are you sure you want to remove the alert with id '${args.options.id}' from site '${args.options.webUrl}'?` });
+            if (!result) {
+                return;
+            }
+        }
+        try {
+            if (this.verbose) {
+                await logger.logToStderr(`Removing alert with ID '${args.options.id}' from site '${args.options.webUrl}'...`);
+            }
+            const requestOptions = {
+                url: `${args.options.webUrl}/_api/web/Alerts/DeleteAlert('${formatting.encodeQueryParameter(args.options.id)}')`,
+                headers: {
+                    accept: 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            await request.delete(requestOptions);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+}
+export default new SpoWebRuleRemoveCommand();
+//# sourceMappingURL=web-rule-remove.js.map

package/dist/m365/spo/commands.js

@@ -377,6 +377,9 @@ export default {
     WEB_ROLEASSIGNMENT_ADD: `${prefix} web roleassignment add`,
     WEB_ROLEINHERITANCE_BREAK: `${prefix} web roleinheritance break`,
     WEB_ROLEINHERITANCE_RESET: `${prefix} web roleinheritance reset`,
+    WEB_RULE_GET: `${prefix} web rule get`,
+    WEB_RULE_LIST: `${prefix} web rule list`,
+    WEB_RULE_REMOVE: `${prefix} web rule remove`,
     WEB_SET: `${prefix} web set`
 };
 //# sourceMappingURL=commands.js.map

package/docs/docs/cmd/entra/m365group/m365group-remove.mdx

@@ -26,9 +26,6 @@ m365 entra m365group remove [options]
 
 `--permanent`
 : Permanently remove the group without leaving it in the recycle bin.
-
-`--skipRecycleBin`
-: Deprecated: use `--permanent` instead.
 ```
 
 <Global />

package/docs/docs/cmd/spo/navigation/navigation-node-list.mdx

@@ -69,27 +69,35 @@ m365 spo navigation node list --webUrl https://contoso.sharepoint.com/sites/Mark
         "5786b8e8-c495-4734-b345-756733960730"
       ],
       "CurrentLCID": 1033,
-      "Id": 2032,
-      "IsDocLib": true,
-      "IsExternal": true,
-      "IsVisible": true,
-      "ListTemplateType": 0,
-      "Title": "Navigation Link",
-      "Url": "https://contoso.sharepoint.com",
-      "Children": [
+      "CustomProperties": [],
+      "FriendlyUrlSegment": "",
+      "IsDeleted": false,
+      "IsHidden": false,
+      "IsTitleForExistingLanguage": false,
+      "Key": "2032",
+      "Nodes": [
         {
-          "AudienceIds": null,
+          "AudienceIds": [],
           "CurrentLCID": 1033,
-          "Id": 2033,
-          "IsDocLib": true,
-          "IsExternal": true,
-          "IsVisible": true,
-          "ListTemplateType": 0,
+          "CustomProperties": [],
+          "FriendlyUrlSegment": "",
+          "IsDeleted": false,
+          "IsHidden": false,
+          "IsTitleForExistingLanguage": false,
+          "Key": "2033",
+          "Nodes": [],
+          "NodeType": 0,
+          "OpenInNewWindow": true,
+          "SimpleUrl": "https://microsoft365.com",
           "Title": "Microsoft 365",
-          "Url": "https://microsoft365.com",
-          "Children": []
+          "Translations": []
         }
-      ]
+      ],
+      "NodeType": 0,
+      "OpenInNewWindow": false,
+      "SimpleUrl": "https://contoso.sharepoint.com",
+      "Title": "Navigation Link",
+      "Translations": []
     }
   ]
   ```
@@ -98,7 +106,7 @@ m365 spo navigation node list --webUrl https://contoso.sharepoint.com/sites/Mark
   <TabItem value="Text">
 
   ```text
-  Id    Title            Url
+  Key   Title            SimpleUrl
   ----  ---------------  ------------------------------
   2032  Navigation Link  https://contoso.sharepoint.com
   ```
@@ -107,8 +115,8 @@ m365 spo navigation node list --webUrl https://contoso.sharepoint.com/sites/Mark
   <TabItem value="CSV">
 
   ```csv
-  Id,Title,Url
-  2032,Navigation Link,https://contoso.sharepoint.com
+  CurrentLCID,FriendlyUrlSegment,IsDeleted,IsHidden,IsTitleForExistingLanguage,Key,NodeType,OpenInNewWindow,SimpleUrl,Title
+  1033,,0,0,0,2032,0,0,https://contoso.sharepoint.com,Navigation Link
   ```
 
   </TabItem>
@@ -119,18 +127,20 @@ m365 spo navigation node list --webUrl https://contoso.sharepoint.com/sites/Mark
 
   Date: 27/1/2023
 
-  ## Home (1031)
+  ## Navigation Link
 
   Property | Value
   ---------|-------
   CurrentLCID | 1033
-  Id | 2032
-  IsDocLib | true
-  IsExternal | false
-  IsVisible | true
-  ListTemplateType | 0
+  FriendlyUrlSegment |
+  IsDeleted | false
+  IsHidden | false
+  IsTitleForExistingLanguage | false
+  Key | 2032
+  NodeType | 0
+  OpenInNewWindow | false
+  SimpleUrl | https://contoso.sharepoint.com
   Title | Navigation Link
-  Url | https://contoso.sharepoint.com
   ```
 
   </TabItem>

package/docs/docs/cmd/spo/site/site-remove.mdx

@@ -19,9 +19,6 @@ m365 spo site remove [options]
 `--permanent`
 : Permanently remove the site without leaving it in the recycle bin.
 
-`--skipRecycleBin`
-: Deprecated: use `--permanent` instead.
-
 `--fromRecycleBin`
 : Set to remove the site from the recycle bin.
 

package/docs/docs/cmd/spo/web/web-rule-get.mdx

@@ -0,0 +1,108 @@
+import Global from '../../_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# spo web rule get
+
+Retrieves information about a specific alert from a SharePoint list
+
+## Usage
+
+```sh
+m365 spo web rule get [options]
+```
+
+## Options
+
+```md definition-list
+`-u, --webUrl <webUrl>`
+: The URL of the SharePoint site.
+
+`--id <id>`
+: The ID of the rule.
+```
+
+<Global />
+
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions          |
+  |-----------------|----------------------|
+  | SharePoint      | AllSites.FullControl |
+  | Microsoft Graph | User.ReadBasic.All   |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions           |
+  |-----------------|-----------------------|
+  | SharePoint      | Sites.FullControl.All |
+  | Microsoft Graph | User.ReadBasic.All    |
+
+  </TabItem>
+</Tabs>
+
+## Examples
+
+Retrieve a rule by ID
+
+```sh
+m365 spo web rule get --webUrl https://contoso.sharepoint.com/sites/Marketing --id 7cbb4c8d-8e4d-4d2e-9c6f-3f1d8b2e6a0e
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "AlertFrequency": 0,
+    "AlertTemplateName": "SPAlertTemplateType.DocumentLibrary",
+    "AlertType": 0,
+    "AlwaysNotify": false,
+    "DeliveryChannels": 1,
+    "EventType": -1,
+    "Filter": "",
+    "ID": "7cbb4c8d-8e4d-4d2e-9c6f-3f1d8b2e6a0e",
+    "Status": 0,
+    "Title": "Marketing documents",
+    "UserId": 8,
+    "List": {
+      "Id": "39d9e102-9e8f-4e74-8f17-84a92f972fcf",
+      "Title": "Documents",
+      "RootFolder": {
+        "ServerRelativeUrl": "/sites/Marketing/Shared Documents"
+      }
+    },
+    "User": {
+      "Id": 8,
+      "UserPrincipalName": "jane.doe@contoso.com"
+    }
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  AlertFrequency   : 0
+  AlertTemplateName: SPAlertTemplateType.DocumentLibrary
+  AlertType        : 0
+  AlwaysNotify     : false
+  DeliveryChannels : 1
+  EventType        : -1
+  Filter           : 
+  ID               : 7cbb4c8d-8e4d-4d2e-9c6f-3f1d8b2e6a0e
+  Status           : 0
+  Title            : Marketing documents
+  UserId           : 8
+  List             : {"Id":"39d9e102-9e8f-4e74-8f17-84a92f972fcf","Title":"Documents","RootFolder":{"ServerRelativeUrl":"/sites/Marketing/Shared Documents"}}
+  User             : {"Id":8,"UserPrincipalName":"jane.doe@contoso.com"}
+  ```
+
+  </TabItem>
+</Tabs>