@pnp/cli-microsoft365 11.7.0-beta.537911c → 11.7.0-beta.71e4ac5

package/dist/config.js

@@ -7,6 +7,7 @@ export default {
         'https://graph.microsoft.com/AuditLog.Read.All',
         'https://graph.microsoft.com/Bookings.Read.All',
         'https://graph.microsoft.com/Calendars.Read',
+        'https://graph.microsoft.com/Calendars.ReadWrite',
         'https://graph.microsoft.com/ChannelMember.ReadWrite.All',
         'https://graph.microsoft.com/ChannelMessage.Read.All',
         'https://graph.microsoft.com/ChannelMessage.ReadWrite',

package/dist/m365/outlook/commands/calendar/calendar-add.js

@@ -0,0 +1,85 @@
+import request from '../../../../request.js';
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+import { z } from 'zod';
+import { globalOptionsZod } from '../../../../Command.js';
+import { validation } from '../../../../utils/validation.js';
+import { calendarGroup } from '../../../../utils/calendarGroup.js';
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    userId: z.string()
+        .refine(userId => validation.isValidGuid(userId), {
+        error: e => `'${e.input}' is not a valid GUID.`
+    }).optional(),
+    userName: z.string()
+        .refine(userName => validation.isValidUserPrincipalName(userName), {
+        error: e => `'${e.input}' is not a valid UPN.`
+    }).optional(),
+    name: z.string(),
+    calendarGroupId: z.string().optional(),
+    calendarGroupName: z.string().optional(),
+    color: z.enum(['auto', 'lightBlue', 'lightGreen', 'lightOrange', 'lightGray', 'lightYellow', 'lightTeal', 'lightPink', 'lightBrown', 'lightRed', 'maxColor']).optional().default('auto'),
+    defaultOnlineMeetingProvider: z.enum(['none', 'teamsForBusiness']).optional().default('teamsForBusiness'),
+    default: z.boolean().optional()
+});
+class OutlookCalendarAddCommand extends GraphCommand {
+    get name() {
+        return commands.CALENDAR_ADD;
+    }
+    get description() {
+        return 'Creates a new calendar for a user';
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => !(options.userId && options.userName), {
+            error: 'Specify either userId or userName, but not both'
+        })
+            .refine(options => !(options.calendarGroupId && options.calendarGroupName), {
+            error: 'Specify either calendarGroupId or calendarGroupName, but not both'
+        });
+    }
+    async commandAction(logger, args) {
+        try {
+            const userIdentifier = args.options.userId ?? args.options.userName;
+            let requestUrl = `${this.resource}/v1.0/users('${userIdentifier}')/`;
+            if (args.options.calendarGroupId || args.options.calendarGroupName) {
+                let calendarGroupId = args.options.calendarGroupId;
+                if (args.options.calendarGroupName) {
+                    const group = await calendarGroup.getUserCalendarGroupByName(userIdentifier, args.options.calendarGroupName, 'id');
+                    calendarGroupId = group.id;
+                }
+                requestUrl += `calendarGroups/${calendarGroupId}/calendars`;
+            }
+            else {
+                requestUrl += 'calendars';
+            }
+            if (args.options.verbose) {
+                await logger.logToStderr(`Creating a calendar for the user ${userIdentifier}...`);
+            }
+            const requestOptions = {
+                url: requestUrl,
+                headers: {
+                    accept: 'application/json;odata.metadata=none',
+                    'content-type': 'application/json'
+                },
+                responseType: 'json',
+                data: {
+                    name: args.options.name,
+                    color: args.options.color,
+                    defaultOnlineMeetingProvider: args.options.defaultOnlineMeetingProvider,
+                    isDefaultCalendar: args.options.default
+                }
+            };
+            const result = await request.post(requestOptions);
+            await logger.log(result);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+}
+export default new OutlookCalendarAddCommand();
+//# sourceMappingURL=calendar-add.js.map

package/dist/m365/outlook/commands/calendar/calendar-get.js

@@ -0,0 +1,71 @@
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+import { z } from 'zod';
+import { globalOptionsZod } from '../../../../Command.js';
+import { validation } from '../../../../utils/validation.js';
+import { calendarGroup } from '../../../../utils/calendarGroup.js';
+import { calendar } from '../../../../utils/calendar.js';
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    id: z.string().alias('i').optional(),
+    name: z.string().alias('n').optional(),
+    userId: z.string()
+        .refine(userId => validation.isValidGuid(userId), {
+        error: e => `'${e.input}' is not a valid GUID.`
+    }).optional(),
+    userName: z.string()
+        .refine(userName => validation.isValidUserPrincipalName(userName), {
+        error: e => `'${e.input}' is not a valid UPN.`
+    }).optional(),
+    calendarGroupId: z.string().optional(),
+    calendarGroupName: z.string().optional()
+});
+class OutlookCalendarGetCommand extends GraphCommand {
+    get name() {
+        return commands.CALENDAR_GET;
+    }
+    get description() {
+        return 'Retrieves the calendar of a user or a group';
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => [options.id, options.name].filter(x => x !== undefined).length === 1, {
+            error: 'Specify either id or name, but not both'
+        })
+            .refine(options => !(options.userId && options.userName), {
+            error: 'Specify either userId or userName, but not both'
+        })
+            .refine(options => !(options.calendarGroupId && options.calendarGroupName), {
+            error: 'Specify either calendarGroupId or calendarGroupName, but not both'
+        });
+    }
+    async commandAction(logger, args) {
+        if (this.verbose) {
+            await logger.logToStderr('Getting calendar...');
+        }
+        try {
+            const userIdentifier = args.options.userId ?? args.options.userName;
+            let calendarGroupId = args.options.calendarGroupId;
+            if (args.options.calendarGroupName) {
+                const group = await calendarGroup.getUserCalendarGroupByName(userIdentifier, args.options.calendarGroupName, 'id');
+                calendarGroupId = group.id;
+            }
+            let result;
+            if (args.options.id) {
+                result = await calendar.getUserCalendarById(userIdentifier, args.options.id, calendarGroupId);
+            }
+            else {
+                result = await calendar.getUserCalendarByName(userIdentifier, args.options.name, calendarGroupId);
+            }
+            await logger.log(result);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+}
+export default new OutlookCalendarGetCommand();
+//# sourceMappingURL=calendar-get.js.map

package/dist/m365/outlook/commands/calendar/calendar-remove.js

@@ -0,0 +1,100 @@
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+import { z } from 'zod';
+import { globalOptionsZod } from '../../../../Command.js';
+import { validation } from '../../../../utils/validation.js';
+import { calendarGroup } from '../../../../utils/calendarGroup.js';
+import { calendar } from '../../../../utils/calendar.js';
+import { cli } from '../../../../cli/cli.js';
+import request from '../../../../request.js';
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    id: z.string().alias('i').optional(),
+    name: z.string().alias('n').optional(),
+    userId: z.string()
+        .refine(userId => validation.isValidGuid(userId), {
+        error: e => `'${e.input}' is not a valid GUID.`
+    }).optional(),
+    userName: z.string()
+        .refine(userName => validation.isValidUserPrincipalName(userName), {
+        error: e => `'${e.input}' is not a valid UPN.`
+    }).optional(),
+    calendarGroupId: z.string().optional(),
+    calendarGroupName: z.string().optional(),
+    permanent: z.boolean().optional(),
+    force: z.boolean().optional().alias('f')
+});
+class OutlookCalendarRemoveCommand extends GraphCommand {
+    get name() {
+        return commands.CALENDAR_REMOVE;
+    }
+    get description() {
+        return 'Removes the calendar of a user';
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => [options.id, options.name].filter(x => x !== undefined).length === 1, {
+            error: 'Specify either id or name, but not both'
+        })
+            .refine(options => [options.userId, options.userName].filter(x => x !== undefined).length === 1, {
+            error: 'Specify either userId or userName, but not both'
+        })
+            .refine(options => [options.calendarGroupId, options.calendarGroupName].filter(x => x !== undefined).length !== 2, {
+            error: 'Do not specify both calendarGroupId and calendarGroupName'
+        });
+    }
+    async commandAction(logger, args) {
+        const removeCalendar = async () => {
+            try {
+                const userIdentifier = args.options.userId ?? args.options.userName;
+                let calendarGroupId = args.options.calendarGroupId;
+                if (args.options.calendarGroupName) {
+                    const group = await calendarGroup.getUserCalendarGroupByName(userIdentifier, args.options.calendarGroupName, 'id');
+                    calendarGroupId = group.id;
+                }
+                let calendarId = args.options.id;
+                if (args.options.name) {
+                    const result = await calendar.getUserCalendarByName(userIdentifier, args.options.name, calendarGroupId, 'id');
+                    calendarId = result.id;
+                }
+                if (args.options.verbose) {
+                    await logger.logToStderr(`Removing calendar with ID ${calendarId}...`);
+                }
+                let url = `${this.resource}/v1.0/users('${userIdentifier}')/${calendarGroupId ? `calendarGroups/${calendarGroupId}/` : ''}calendars/${calendarId}`;
+                if (args.options.permanent) {
+                    url += '/permanentDelete';
+                }
+                const requestOptions = {
+                    url: url,
+                    headers: {
+                        accept: 'application/json;odata.metadata=none'
+                    }
+                };
+                if (args.options.permanent) {
+                    await request.post(requestOptions);
+                }
+                else {
+                    await request.delete(requestOptions);
+                }
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        };
+        if (args.options.force) {
+            await removeCalendar();
+        }
+        else {
+            const calendarIdentifier = args.options.id ?? args.options.name;
+            const result = await cli.promptForConfirmation({ message: `Are you sure you want to remove calendar '${calendarIdentifier}'?` });
+            if (result) {
+                await removeCalendar();
+            }
+        }
+    }
+}
+export default new OutlookCalendarRemoveCommand();
+//# sourceMappingURL=calendar-remove.js.map

package/dist/m365/outlook/commands/event/event-list.js

@@ -0,0 +1,115 @@
+import { z } from 'zod';
+import { globalOptionsZod } from '../../../../Command.js';
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+import { validation } from '../../../../utils/validation.js';
+import { odata } from '../../../../utils/odata.js';
+import { calendar } from '../../../../utils/calendar.js';
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    userId: z.string().refine(id => validation.isValidGuid(id), {
+        error: e => `'${e.input}' is not a valid GUID.`
+    }).optional(),
+    userName: z.string().refine(name => validation.isValidUserPrincipalName(name), {
+        error: e => `'${e.input}' is not a valid UPN.`
+    }).optional(),
+    calendarId: z.string().optional(),
+    calendarName: z.string().optional(),
+    startDateTime: z.string().refine(date => validation.isValidISODateTime(date), {
+        error: e => `'${e.input}' is not a valid ISO date-time.`
+    }).optional(),
+    endDateTime: z.string().refine(date => validation.isValidISODateTime(date), {
+        error: e => `'${e.input}' is not a valid ISO date-time.`
+    }).optional(),
+    timeZone: z.string().optional(),
+    properties: z.string().optional(),
+    filter: z.string().optional()
+});
+class OutlookEventListCommand extends GraphCommand {
+    get name() {
+        return commands.EVENT_LIST;
+    }
+    get description() {
+        return 'Retrieves a list of events from a specific calendar of a user.';
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => [options.userId, options.userName].filter(x => x !== undefined).length === 1, {
+            error: 'Specify either userId or userName, but not both'
+        })
+            .refine(options => !(options.calendarId && options.calendarName), {
+            error: 'Specify either calendarId or calendarName, but not both.'
+        });
+    }
+    defaultProperties() {
+        return ['id', 'subject'];
+    }
+    async commandAction(logger, args) {
+        try {
+            if (this.verbose) {
+                await logger.logToStderr('Getting a list of the events...');
+            }
+            let events;
+            const endpoint = await this.getRequestUrl(args.options);
+            if (args.options.timeZone) {
+                const requestOptions = {
+                    url: endpoint,
+                    headers: {
+                        accept: 'application/json;odata.metadata=none',
+                        Prefer: `outlook.timezone="${args.options.timeZone}"`
+                    },
+                    responseType: 'json'
+                };
+                events = await odata.getAllItems(requestOptions);
+            }
+            else {
+                events = await odata.getAllItems(endpoint);
+            }
+            await logger.log(events);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+    async getRequestUrl(options) {
+        const queryParameters = [];
+        if (options.properties) {
+            const allProperties = options.properties.split(',');
+            const selectProperties = allProperties.filter(prop => !prop.includes('/'));
+            const expandProperties = allProperties.filter(prop => prop.includes('/'));
+            if (selectProperties.length > 0) {
+                queryParameters.push(`$select=${selectProperties}`);
+            }
+            if (expandProperties.length > 0) {
+                const fieldExpands = expandProperties.map(p => `${p.split('/')[0]}($select=${p.split('/')[1]})`);
+                queryParameters.push(`$expand=${fieldExpands.join(',')}`);
+            }
+        }
+        if (options.filter || options.startDateTime || options.endDateTime) {
+            let filter = options.filter || '';
+            if (options.startDateTime) {
+                filter += `${filter ? ' and ' : ''}start/dateTime ge '${options.startDateTime}'`;
+            }
+            if (options.endDateTime) {
+                filter += `${filter ? ' and ' : ''}start/dateTime lt '${options.endDateTime}'`;
+            }
+            queryParameters.push(`$filter=${filter}`);
+        }
+        const queryString = queryParameters.length > 0
+            ? `?${queryParameters.join('&')}`
+            : '';
+        const userIdentifier = options.userId ?? options.userName;
+        let calendarId = options.calendarId;
+        if (options.calendarName) {
+            calendarId = (await calendar.getUserCalendarByName(userIdentifier, options.calendarName)).id;
+        }
+        return calendarId
+            ? `${this.resource}/v1.0/users('${userIdentifier}')/calendars/${calendarId}/events${queryString}`
+            : `${this.resource}/v1.0/users('${userIdentifier}')/events${queryString}`;
+    }
+}
+export default new OutlookEventListCommand();
+//# sourceMappingURL=event-list.js.map

package/dist/m365/outlook/commands.js

@@ -1,6 +1,10 @@
 const prefix = 'outlook';
 export default {
+    CALENDAR_ADD: `${prefix} calendar add`,
+    CALENDAR_GET: `${prefix} calendar get`,
+    CALENDAR_REMOVE: `${prefix} calendar remove`,
     CALENDARGROUP_LIST: `${prefix} calendargroup list`,
+    EVENT_LIST: `${prefix} event list`,
     MAIL_SEARCHFOLDER_ADD: `${prefix} mail searchfolder add`,
     MAIL_SEND: `${prefix} mail send`,
     MAILBOX_SETTINGS_GET: `${prefix} mailbox settings get`,

package/dist/utils/calendar.js

@@ -0,0 +1,37 @@
+import { odata } from './odata.js';
+import { formatting } from './formatting.js';
+import { cli } from '../cli/cli.js';
+import request from '../request.js';
+export const calendar = {
+    async getUserCalendarById(userId, calendarId, calendarGroupId, properties) {
+        let url = `https://graph.microsoft.com/v1.0/users('${userId}')/${calendarGroupId ? `calendarGroups/${calendarGroupId}/` : ''}calendars/${calendarId}`;
+        if (properties) {
+            url += `?$select=${properties}`;
+        }
+        const requestOptions = {
+            url: url,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return await request.get(requestOptions);
+    },
+    async getUserCalendarByName(userId, name, calendarGroupId, properties) {
+        let url = `https://graph.microsoft.com/v1.0/users('${userId}')/${calendarGroupId ? `calendarGroups/${calendarGroupId}/` : ''}calendars?$filter=name eq '${formatting.encodeQueryParameter(name)}'`;
+        if (properties) {
+            url += `&$select=${properties}`;
+        }
+        const calendars = await odata.getAllItems(url);
+        if (calendars.length === 0) {
+            throw new Error(`The specified calendar '${name}' does not exist.`);
+        }
+        if (calendars.length > 1) {
+            const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', calendars);
+            const selectedCalendar = await cli.handleMultipleResultsFound(`Multiple calendars with name '${name}' found.`, resultAsKeyValuePair);
+            return selectedCalendar;
+        }
+        return calendars[0];
+    }
+};
+//# sourceMappingURL=calendar.js.map

package/dist/utils/calendarGroup.js

@@ -0,0 +1,22 @@
+import { odata } from './odata.js';
+import { formatting } from './formatting.js';
+import { cli } from '../cli/cli.js';
+export const calendarGroup = {
+    async getUserCalendarGroupByName(userId, displayName, properties) {
+        let url = `https://graph.microsoft.com/v1.0/users('${userId}')/calendarGroups?$filter=name eq '${formatting.encodeQueryParameter(displayName)}'`;
+        if (properties) {
+            url += `&$select=${properties}`;
+        }
+        const calendarGroups = await odata.getAllItems(url);
+        if (calendarGroups.length === 0) {
+            throw new Error(`The specified calendar group '${displayName}' does not exist.`);
+        }
+        if (calendarGroups.length > 1) {
+            const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', calendarGroups);
+            const selectedCalendarGroup = await cli.handleMultipleResultsFound(`Multiple calendar groups with name '${displayName}' found.`, resultAsKeyValuePair);
+            return selectedCalendarGroup;
+        }
+        return calendarGroups[0];
+    }
+};
+//# sourceMappingURL=calendarGroup.js.map

package/docs/docs/cmd/outlook/calendar/calendar-add.mdx

@@ -0,0 +1,165 @@
+import Global from '../../_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# outlook calendar add
+
+Creates a new calendar for a user
+
+## Usage
+
+```sh
+m365 outlook calendar add [options]
+```
+
+## Options
+
+```md definition-list
+`--userId [userId]`
+: ID of the user. Specify either `userId` or `userName`, but not both.
+
+`--userName [userName]`
+: UPN of the user. Specify either `userId` or `userName`, but not both.
+
+`--name <name>`
+: Name of the calendar.
+
+`--calendarGroupId [calendarGroupId]`
+: Id of the group where the calendar will belong. Specify either `calendarGroupId` or `calendarGroupName`, but not both.
+
+`--calendarGroupName [calendarGroupName]`
+: Name of the group where the calendar will belong. Specify either `calendarGroupId` or `calendarGroupName`, but not both.
+
+`--color [color]`
+: The color of the calendar in UI. Allowed values are `auto`, `lightBlue`, `lightGreen`, `lightOrange`, `lightGray`, `lightYellow`, `lightTeal`, `lightPink`, `lightBrown`, `lightRed`, `maxColor`. Defaults to `auto`.
+
+`--defaultOnlineMeetingProvider [defaultOnlineMeetingProvider]`
+: The default online meeting provider for meetings sent from the calendar. Allowed values are `none`, `teamsForBusiness`. Defaults to `teamsForBusiness`.
+
+`--default`
+: Specify whether the calendar will be the default calendar for new events.
+```
+
+<Global />
+
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions         |
+  |-----------------|---------------------|
+  | Microsoft Graph | Calendars.ReadWrite |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  | Resource        | Permissions         |
+  |-----------------|---------------------|
+  | Microsoft Graph | Calendars.ReadWrite |
+
+  </TabItem>
+</Tabs>
+
+## Examples
+
+Create a new calendar for a user in a default calendar's group
+
+```sh
+m365 outlook calendar add --userId '@meId' --name 'Holidays'
+```
+
+Create a new calendar for a user specified by email in a specific calendar group and defined color
+
+```sh
+m365 outlook calendar add --userName 'john.doe@contoso.com' --name 'Interviews' --calendarGroupId 'AAMkADY1YmE3N2FhLWEwMz' --color 'lightBlue'
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "AQMkAGRlMCQAAAA==",
+    "name": "My Calendars",
+    "color": "auto",
+    "hexColor": "",
+    "groupClassId": "0006f0b7-0000-0000-c000-000000000046",
+    "isDefaultCalendar": false,
+    "changeKey": "fJKVL07sbkmIfHqjbDnRgQACxSYYpw==",
+    "canShare": true,
+    "canViewPrivateItems": true,
+    "canEdit": true,
+    "allowedOnlineMeetingProviders": [
+      "teamsForBusiness"
+    ],
+    "defaultOnlineMeetingProvider": "teamsForBusiness",
+    "isTallyingResponses": false,
+    "isRemovable": true,
+    "owner": {
+      "name": "John Doe",
+      "address": "john.doe@contoso.com"
+    }
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  allowedOnlineMeetingProviders: ["teamsForBusiness"]
+  canEdit                      : true
+  canShare                     : true
+  canViewPrivateItems          : true
+  changeKey                    : fJKVL07sbkmIfHqjbDnRgQACxSYYug==
+  color                        : auto
+  defaultOnlineMeetingProvider : teamsForBusiness
+  groupClassId                 : 0006f0b7-0000-0000-c000-000000000046
+  hexColor                     :
+  id                           : AQMkAGRlMCQAAAA==
+  isDefaultCalendar            : false
+  isRemovable                  : true
+  isTallyingResponses          : false
+  name                         : My Calendars
+  owner                        : {"name":"John Doe","address":"john.doe@contoso.com"}
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,name,color,hexColor,groupClassId,isDefaultCalendar,changeKey,canShare,canViewPrivateItems,canEdit,defaultOnlineMeetingProvider,isTallyingResponses,isRemovable
+  AQMkAGRlMCQAAAA==,My Calendars,auto,,0006f0b7-0000-0000-c000-000000000046,0,fJKVL07sbkmIfHqjbDnRgQACxSYYzQ==,1,1,1,teamsForBusiness,0,1
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # outlook calendar add --userId "893f9116-e024-4bc6-8e98-54c245129485" --name "My Calendars"
+
+  Date: 2/5/2026
+
+  ## My Calendars (AQMkAGRlMCQAAAA==)
+
+  Property | Value
+  ---------|-------
+  id | AQMkAGRlMCQAAAA==
+  name | My Calendars
+  color | auto
+  hexColor |
+  groupClassId | 0006f0b7-0000-0000-c000-000000000046
+  isDefaultCalendar | false
+  changeKey | fJKVL07sbkmIfHqjbDnRgQACxSYY4A==
+  canShare | true
+  canViewPrivateItems | true
+  canEdit | true
+  defaultOnlineMeetingProvider | teamsForBusiness
+  isTallyingResponses | false
+  isRemovable | true
+  ```
+
+  </TabItem>
+</Tabs>