@pnp/cli-microsoft365 12.0.0-beta.0be7d8d → 12.0.0-beta.c9bd7f3

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

@@ -1,111 +0,0 @@
-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';
-    }
-    alias() {
-        return [commands.WEB_ALERT_LIST];
-    }
-    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) {
-            listId = await spo.getListId(args.options.webUrl, args.options.listTitle, args.options.listUrl, logger, this.verbose);
-        }
-        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

@@ -1,57 +0,0 @@
-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';
-    }
-    alias() {
-        return [commands.WEB_ALERT_REMOVE];
-    }
-    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/docs/docs/cmd/spo/web/web-rule-list.mdx

@@ -1,193 +0,0 @@
-import Global from '../../_global.mdx';
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-# spo web rule list
-
-Lists all SharePoint list alerts
-
-## Usage
-
-```sh
-m365 spo web rule list [options]
-```
-
-## Alias
-
-```sh
-m365 spo web alert list
-```
-
-## Options
-
-```md definition-list
-`-u, --webUrl <webUrl>`
-: The URL of the SharePoint site.
-
-`--listId [listId]`
-: The ID of the SharePoint list. Specify either `listId`, `listUrl`, or `listTitle`, but not more than one.
-
-`--listUrl [listUrl]`
-: The URL of the SharePoint list. Specify either `listId`, `listUrl`, or `listTitle`, but not more than one.
-
-`--listTitle [listTitle]`
-: The title of the SharePoint list. Specify either `listId`, `listUrl`, or `listTitle`, but not more than one.
-
-`--userName [userName]`
-: The user name to filter alerts for. Specify either `userName` or `userId`, but not both.
-
-`--userId [userId]`
-: The user ID to filter alerts for. Specify either `userName` or `userId`, but not both.
-```
-
-<Global />
-
-## Permissions
-
-<Tabs>
-  <TabItem value="Delegated">
-
-  | Resource   | Permissions          |
-  |------------|----------------------|
-  | SharePoint | AllSites.FullControl |
-
-  </TabItem>
-  <TabItem value="Application">
-
-  | Resource   | Permissions           |
-  |------------|-----------------------|
-  | SharePoint | Sites.FullControl.All |
-
-  </TabItem>
-</Tabs>
-
-## Examples
-
-List all alerts for a SharePoint site:
-
-```sh
-m365 spo web rule list --webUrl https://contoso.sharepoint.com/sites/Marketing
-```
-
-List alerts for a SharePoint list by listUrl:
-
-```sh
-m365 spo web rule list --webUrl https://contoso.sharepoint.com/sites/Marketing --listUrl /sites/Marketing/lists/Tasks
-```
-
-List alerts for a specific user by userId:
-
-```sh
-m365 spo web rule list --webUrl https://contoso.sharepoint.com/sites/Marketing --userId 7cbb4c8d-8e4d-4d2e-9c6f-3f1d8b2e6a0e
-```
-
-List alerts for a specific list by title and user by username:
-
-```sh
-m365 spo web rule list --webUrl https://contoso.sharepoint.com/sites/Marketing --listTitle "Tasks" --userName jane.doe@contoso.com
-```
-
-## Response
-
-<Tabs>
-  <TabItem value="JSON">
-
-  ```json
-  [
-    {
-      "AlertFrequency": 0,
-      "AlertTemplateName": "SPAlertTemplateType.DocumentLibrary",
-      "AlertType": 1,
-      "AlwaysNotify": false,
-      "DeliveryChannels": 1,
-      "EventType": -1,
-      "Filter": "",
-      "ID": "c52b4bf0-add0-4323-b670-f765bb46337b",
-      "Properties": [
-        {
-          "Key": "dispformurl",
-          "Value": "Shared Documents/Forms/DispForm.aspx",
-          "ValueType": "Edm.String"
-        }
-      ],
-      "Status": 0,
-      "Title": "Documents: ProjectPlan.docx",
-      "UserId": 9,
-      "Item": {
-        "Id": 37326,
-        "FileRef": "/sites/marketing/Shared Documents/ProjectPlan.docx",
-        "GUID": "ef5cc60b-71c0-4357-a291-14274234efde"
-      },
-      "List": {
-        "Id": "6b4f195c-02da-47f4-8237-065b96258cf3",
-        "Title": "Documents",
-        "RootFolder": {
-          "ServerRelativeUrl": "/sites/marketing/Shared Documents"
-        }
-      },
-      "User": {
-        "Id": 9,
-        "IsHiddenInUI": false,
-        "LoginName": "i:0#.f|membership|jane.doe@contoso.onmicrosoft.com",
-        "Title": "Jane Doe",
-        "PrincipalType": 1,
-        "Email": "jane.doe@contoso.onmicrosoft.com",
-        "Expiration": "",
-        "IsEmailAuthenticationGuestUser": false,
-        "IsShareByEmailGuestUser": false,
-        "IsSiteAdmin": false,
-        "UserId": {
-          "NameId": "10037ffeaed549a5",
-          "NameIdIssuer": "urn:federation:microsoftonline"
-        },
-        "UserPrincipalName": "jane.doe@contoso.onmicrosoft.com"
-      }
-    }
-  ]
-  ```
-
-  </TabItem>
-  <TabItem value="Text">
-
-  ```txt
-  ID                                    Title                        UserPrincipalName
-  ------------------------------------  ---------------------------  --------------------
-  fa5115ee-0c72-4d17-9fda-ee2451ba1c6d  Documents: ProjectPlan.docx  jane.doe@contoso.com
-  ```
-
-  </TabItem>
-  <TabItem value="CSV">
-
-  ```csv
-  AlertFrequency,AlertTemplateName,AlertType,AlwaysNotify,DeliveryChannels,EventType,Filter,ID,Status,Title,UserId,UserPrincipalName
-  0,SPAlertTemplateType.DocumentLibrary,1,0,1,-1,,fa5115ee-0c72-4d17-9fda-ee2451ba1c6d,0,Documents: ProjectPlan.docx,6,jane.doe@contoso.com
-  ```
-
-  </TabItem>
-  <TabItem value="Markdown">
-
-  ```md
-  # spo web rule list --webUrl "https://contoso.sharepoint.com/sites/marketing" --listUrl "/sites/marketing/Shared Documents"
-
-  Date: 10/6/2025
-
-  ## Documents: ProjectPlan.docx (c52b4bf0-add0-4323-b670-f765bb46337b)
-
-  Property | Value
-  ---------|-------
-  AlertFrequency | 0
-  AlertTemplateName | SPAlertTemplateType.DocumentLibrary
-  AlertType | 1
-  AlwaysNotify | false
-  DeliveryChannels | 1
-  EventType | -1
-  Filter |
-  ID | c52b4bf0-add0-4323-b670-f765bb46337b
-  Status | 0
-  Title | Documents: ProjectPlan.docx
-  UserId | 9
-  UserPrincipalName | jane.doe@contoso.com
-  ```
-
-  </TabItem>
-</Tabs>

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

@@ -1,71 +0,0 @@
-import Global from '../../_global.mdx';
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-# spo web rule remove
-
-Removes an alert from a SharePoint list
-
-## Usage
-
-```sh
-m365 spo web rule remove [options]
-```
-
-## Alias
-
-```sh
-m365 spo web alert remove
-```
-
-## Options
-
-```md definition-list
-`-u, --webUrl <webUrl>`
-: The URL of the SharePoint site.
-
-`--id <id>`
-: The ID of the alert.
-
-`-f, --force`
-: Don't prompt for confirmation.
-```
-
-<Global />
-
-## Permissions
-
-<Tabs>
-  <TabItem value="Delegated">
-
-  | Resource   | Permissions          |
-  |------------|----------------------|
-  | SharePoint | AllSites.FullControl |
-
-  </TabItem>
-  <TabItem value="Application">
-
-  | Resource   | Permissions           |
-  |------------|-----------------------|
-  | SharePoint | Sites.FullControl.All |
-
-  </TabItem>
-</Tabs>
-
-## Examples
-
-Remove an alert by ID
-
-```sh
-m365 spo web rule remove --webUrl https://contoso.sharepoint.com/sites/Marketing --id 7cbb4c8d-8e4d-4d2e-9c6f-3f1d8b2e6a0e
-```
-
-Remove another alert without confirmation
-
-```sh
-m365 spo web rule remove --webUrl https://contoso.sharepoint.com/sites/Marketing --id 2b6f1c8a-3e6a-4c7e-b8c0-7bf4c8e6d7f1 --force
-```
-
-## Response
-
-The command won't return a response on success.