Add outlook calendargroup get command. Closes #7111#7166
Add outlook calendargroup get command. Closes #7111#7166AlejandroGispert wants to merge 2 commits intopnp:mainfrom
Conversation
AlejandroGispert
force-pushed
the
feature/outlook-calendargroup-get
branch
from
46032d6 to
3da5852
Compare
Made-with: Cursor
AlejandroGispert
force-pushed
the
feature/outlook-calendargroup-get
branch
from
e63aaba to
d002fb8
Compare
|
Hi @milanholemans @MartinM85 , Can you check my PR? |
There was a problem hiding this comment.
Pull request overview
Adds the missing m365 outlook calendargroup get command to the CLI for Microsoft 365 to retrieve a specific Outlook calendar group for a user, supporting lookup by either --id or --name, and documenting/validating delegated vs app-only behavior.
Changes:
- Introduces
outlook calendargroup getcommand implementation with Zod validation and Graph calls - Adds unit tests covering key permission/lookup scenarios
- Adds documentation page and wires it into the Docusaurus sidebar
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/m365/outlook/commands/calendargroup/calendargroup-get.ts | Implements the new calendargroup get command, including permission handling and name-to-id resolution |
| src/m365/outlook/commands/calendargroup/calendargroup-get.spec.ts | Adds unit tests for the new command (id/name, delegated/app-only, shared-scope handling) |
| src/m365/outlook/commands.ts | Registers the new command name constant |
| docs/src/config/sidebars.ts | Adds the new command docs page to the Outlook sidebar group |
| docs/docs/cmd/outlook/calendargroup/calendargroup-get.mdx | Adds reference documentation for outlook calendargroup get |
| const getCalendarGroupId = async (calendarGroupName: string): Promise<string> => { | ||
| const userPath = userIdentifier ? `users('${userIdentifier}')` : 'me'; | ||
| const calendarGroups = await odata.getAllItems<CalendarGroup>( | ||
| `${this.resource}/v1.0/${userPath}/calendarGroups?$select=id,name&$filter=name eq '${formatting.encodeQueryParameter(calendarGroupName)}'` | ||
| ); |
There was a problem hiding this comment.
userIdentifier is interpolated directly into the users('...') OData path without encoding/escaping. This breaks for valid UPNs containing characters like # (guest #EXT# users) and can also allow malformed OData paths if the identifier contains a single quote. Use formatting.encodeQueryParameter(userIdentifier) (as done in other commands) when building userPath/URLs.
| // For delegated access without userId/userName: use /me. | ||
| const userPath = userIdentifier ? `users('${userIdentifier}')` : 'me'; | ||
| const requestUrl = `${this.resource}/v1.0/${userPath}/calendarGroups/${calendarGroupId}`; | ||
|
|
There was a problem hiding this comment.
userIdentifier is used unencoded in users('...') when constructing the final requestUrl. For guest UPNs containing #EXT# this will produce an invalid URL (the # starts a fragment) and the request will fail. Encode/escape the identifier (e.g., via formatting.encodeQueryParameter) before inserting it into the URL, and adjust the unit tests that assert the raw URL for --userName accordingly.
…rs for API requests - Updated the command to encode user identifiers before constructing API URLs. - Adjusted test cases to reflect changes in user identifier handling.
Closes #7111
Summary
Adds the missing m365 outlook calendargroup get command to retrieve a specific calendar group for a user, supporting lookup by either --id or --name (with --name resolving to an id via OData filtering).
Details
Implements m365 outlook calendargroup get with delegated vs app-only permission handling.
Enforces mutually exclusive --id/--name and --userId/--userName.
Adds unit tests and a docs page, and wires the command into the docs sidebar.