@pnp/cli-microsoft365/dist/m365/planner/commands/plan/plan-add.js

Manage Microsoft 365 and SharePoint Framework projects on any platform

import { z } from 'zod';
import { globalOptionsZod, CommandError } from '../../../../Command.js';
import request from '../../../../request.js';
import { entraGroup } from '../../../../utils/entraGroup.js';
import { formatting } from '../../../../utils/formatting.js';
import { validation } from '../../../../utils/validation.js';
import GraphCommand from '../../../base/GraphCommand.js';
import commands from '../../commands.js';
export const options = z.strictObject({
    ...globalOptionsZod.shape,
    title: z.string().alias('t'),
    ownerGroupId: z.string()
        .refine(val => validation.isValidGuid(val), {
        message: 'The value is not a valid GUID.'
    })
        .optional(),
    ownerGroupName: z.string().optional(),
    rosterId: z.string().optional(),
    shareWithUserIds: z.string()
        .refine(val => validation.isValidGuidArray(val) === true, {
        message: 'The value contains invalid GUIDs.'
    })
        .optional(),
    shareWithUserNames: z.string()
        .refine(val => validation.isValidUserPrincipalNameArray(val) === true, {
        message: 'The value contains invalid user principal names.'
    })
        .optional()
});
class PlannerPlanAddCommand extends GraphCommand {
    get name() {
        return commands.PLAN_ADD;
    }
    get description() {
        return 'Adds a new Microsoft Planner plan';
    }
    get schema() {
        return options;
    }
    getRefinedSchema(schema) {
        return schema
            .refine(opts => [opts.ownerGroupId, opts.ownerGroupName, opts.rosterId].filter(x => x !== undefined).length === 1, {
            message: `Specify exactly one of the following options: 'ownerGroupId', 'ownerGroupName' or 'rosterId'.`,
            params: {
                customCode: 'optionSet',
                options: ['ownerGroupId', 'ownerGroupName', 'rosterId']
            }
        })
            .refine(opts => !opts.shareWithUserIds || !opts.shareWithUserNames, {
            message: 'Specify either shareWithUserIds or shareWithUserNames but not both'
        });
    }
    async commandAction(logger, args) {
        try {
            const data = {
                title: args.options.title
            };
            if (args.options.rosterId) {
                data.container = {
                    url: `https://graph.microsoft.com/v1.0/planner/rosters/${args.options.rosterId}`
                };
            }
            else {
                const groupId = await this.getGroupId(args);
                data.container = {
                    url: `https://graph.microsoft.com/v1.0/groups/${groupId}`
                };
            }
            const requestOptions = {
                url: `${this.resource}/v1.0/planner/plans`,
                headers: {
                    'accept': 'application/json;odata.metadata=none'
                },
                responseType: 'json',
                data: data
            };
            const newPlan = await request.post(requestOptions);
            const result = await this.updatePlanDetails(args.options, newPlan);
            await logger.log(result);
        }
        catch (err) {
            if (args.options.rosterId && err.error?.error.message === "You do not have the required permissions to access this item, or the item may not exist.") {
                throw new CommandError("You can only add 1 plan to a Roster");
            }
            this.handleRejectedODataJsonPromise(err);
        }
    }
    async updatePlanDetails(options, newPlan) {
        const planId = newPlan.id;
        if (!options.shareWithUserIds && !options.shareWithUserNames) {
            return newPlan;
        }
        const resArray = await Promise.all([this.generateSharedWith(options), this.getPlanDetailsEtag(planId)]);
        const sharedWith = resArray[0];
        const etag = resArray[1];
        const requestOptionsPlanDetails = {
            url: `${this.resource}/v1.0/planner/plans/${planId}/details`,
            headers: {
                'accept': 'application/json;odata.metadata=none',
                'If-Match': etag,
                'Prefer': 'return=representation'
            },
            responseType: 'json',
            data: {
                sharedWith: sharedWith
            }
        };
        const planDetails = await request.patch(requestOptionsPlanDetails);
        return { ...newPlan, ...planDetails };
    }
    async getPlanDetailsEtag(planId) {
        const requestOptions = {
            url: `${this.resource}/v1.0/planner/plans/${planId}/details`,
            headers: {
                accept: 'application/json'
            },
            responseType: 'json'
        };
        const response = await request.get(requestOptions);
        return response['@odata.etag'];
    }
    async generateSharedWith(options) {
        const sharedWith = {};
        const userIds = await this.getUserIds(options);
        userIds.map(x => sharedWith[x] = true);
        return sharedWith;
    }
    async getUserIds(options) {
        if (options.shareWithUserIds) {
            return options.shareWithUserIds.split(',');
        }
        // Hitting this section means assignedToUserNames won't be undefined
        const userNames = options.shareWithUserNames;
        const userArr = userNames.split(',').map(o => o.trim());
        const promises = userArr.map(user => {
            const requestOptions = {
                url: `${this.resource}/v1.0/users?$filter=userPrincipalName eq '${formatting.encodeQueryParameter(user)}'&$select=id,userPrincipalName`,
                headers: {
                    'content-type': 'application/json'
                },
                responseType: 'json'
            };
            return request.get(requestOptions);
        });
        const usersRes = await Promise.all(promises);
        const userUpns = usersRes.map(res => res.value[0]?.userPrincipalName);
        const userIds = usersRes.map(res => res.value[0]?.id);
        // Find the members where no graph response was found
        const invalidUsers = userArr.filter(user => !userUpns.some((upn) => upn?.toLowerCase() === user.toLowerCase()));
        if (invalidUsers && invalidUsers.length > 0) {
            throw `Cannot proceed with planner plan creation. The following users provided are invalid : ${invalidUsers.join(',')}`;
        }
        return userIds;
    }
    async getGroupId(args) {
        if (args.options.ownerGroupId) {
            return args.options.ownerGroupId;
        }
        return entraGroup.getGroupIdByDisplayName(args.options.ownerGroupName);
    }
}
export default new PlannerPlanAddCommand();
//# sourceMappingURL=plan-add.js.map