@pnp/cli-microsoft365/dist/m365/spo/commands/web/web-alert-list.js

Manage Microsoft 365 and SharePoint Framework projects on any platform

import commands from '../../commands.js';
import SpoCommand from '../../../base/SpoCommand.js';
import { globalOptionsZod } from '../../../../Command.js';
import { z } from 'zod';
import { zod } from '../../../../utils/zod.js';
import { validation } from '../../../../utils/validation.js';
import { spo } from '../../../../utils/spo.js';
import { entraUser } from '../../../../utils/entraUser.js';
import { formatting } from '../../../../utils/formatting.js';
import { odata } from '../../../../utils/odata.js';
import { cli } from '../../../../cli/cli.js';
export const options = globalOptionsZod
    .extend({
    webUrl: zod.alias('u', z.string()
        .refine(url => validation.isValidSharePointUrl(url) === true, url => ({
        message: `'${url}' is not a valid SharePoint site URL.`
    }))),
    listId: z.string()
        .refine(id => validation.isValidGuid(id), id => ({
        message: `'${id}' is not a valid GUID.`
    })).optional(),
    listUrl: z.string().optional(),
    listTitle: z.string().optional(),
    userName: z.string().refine(upn => validation.isValidUserPrincipalName(upn), upn => ({
        message: `'${upn}' is not a valid UPN.`
    })).optional(),
    userId: z.string().refine(id => validation.isValidGuid(id), id => ({
        message: `'${id}' is not a valid GUID.`
    })).optional()
})
    .strict();
class SpoWebAlertListCommand extends SpoCommand {
    get name() {
        return commands.WEB_ALERT_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, {
            message: `Specify either listId, listUrl, or listTitle, but not more than one.`
        })
            .refine(options => [options.userName, options.userId].filter(x => x !== undefined).length <= 1, {
            message: `Specify either userName or userId, but not both.`
        });
    }
    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 SpoWebAlertListCommand();
//# sourceMappingURL=web-alert-list.js.map