@pnp/cli-microsoft365 11.8.0 → 11.9.0-beta.16af377

package/dist/m365/spo/commands/list/list-defaultvalue-remove.js

@@ -35,7 +35,11 @@ class SpoListDefaultValueRemoveCommand extends SpoCommand {
     getRefinedSchema(schema) {
         return schema
             .refine(options => [options.listId, options.listTitle, options.listUrl].filter(o => o !== undefined).length === 1, {
-            error: 'Use one of the following options: listId, listTitle, listUrl.'
+            error: 'Use one of the following options: listId, listTitle, listUrl.',
+            params: {
+                customCode: 'optionSet',
+                options: ['listId', 'listTitle', 'listUrl']
+            }
         });
     }
     async commandAction(logger, args) {

package/dist/m365/spo/commands/list/list-defaultvalue-set.js

@@ -36,7 +36,11 @@ class SpoListDefaultValueSetCommand extends SpoCommand {
     getRefinedSchema(schema) {
         return schema
             .refine(options => [options.listId, options.listTitle, options.listUrl].filter(o => o !== undefined).length === 1, {
-            error: 'Use one of the following options: listId, listTitle, listUrl.'
+            error: 'Use one of the following options: listId, listTitle, listUrl.',
+            params: {
+                customCode: 'optionSet',
+                options: ['listId', 'listTitle', 'listUrl']
+            }
         });
     }
     async commandAction(logger, args) {

package/dist/m365/spo/commands/list/list-view-add.js

@@ -57,25 +57,38 @@ class SpoListViewAddCommand extends SpoCommand {
     getRefinedSchema(schema) {
         return schema
             .refine((options) => [options.listId, options.listTitle, options.listUrl].filter(o => o !== undefined).length === 1, {
-            error: 'Use one of the following options: listId, listTitle, or listUrl.'
+            error: 'Use one of the following options: listId, listTitle, or listUrl.',
+            params: {
+                customCode: 'optionSet',
+                options: ['listId', 'listTitle', 'listUrl']
+            }
         })
             .refine((options) => !options.personal || !options.default, {
             error: 'Default view cannot be a personal view.'
         })
             .refine((options) => options.type !== 'calendar' || [options.calendarStartDateField, options.calendarEndDateField, options.calendarTitleField].filter(o => o === undefined).length === 0, {
-            error: 'When type is calendar, do specify calendarStartDateField, calendarEndDateField, and calendarTitleField.'
+            error: 'When type is calendar, do specify calendarStartDateField, calendarEndDateField, and calendarTitleField.',
+            params: {
+                customCode: 'required'
+            }
         })
             .refine((options) => options.type === 'calendar' || [options.calendarStartDateField, options.calendarEndDateField, options.calendarTitleField].filter(o => o === undefined).length === 3, {
             error: 'When type is not calendar, do not specify calendarStartDateField, calendarEndDateField, and calendarTitleField.'
         })
             .refine((options) => options.type !== 'kanban' || options.kanbanBucketField !== undefined, {
-            error: 'When type is kanban, do specify kanbanBucketField.'
+            error: 'When type is kanban, do specify kanbanBucketField.',
+            params: {
+                customCode: 'required'
+            }
         })
             .refine((options) => options.type === 'kanban' || options.kanbanBucketField === undefined, {
             error: 'When type is not kanban, do not specify kanbanBucketField.'
         })
             .refine((options) => options.type === 'calendar' || options.fields !== undefined, {
-            error: 'When type is not calendar, do specify fields.'
+            error: 'When type is not calendar, do specify fields.',
+            params: {
+                customCode: 'required'
+            }
         });
     }
     async commandAction(logger, args) {

package/dist/m365/spo/commands/page/page-control-set.js

@@ -79,7 +79,7 @@ class SpoPageControlSetCommand extends SpoCommand {
                     await logger.logToStderr('');
                 }
             }
-            if (args.options.webPartProperties) {
+            else if (args.options.webPartProperties) {
                 if (this.verbose) {
                     await logger.logToStderr('web part properties data:');
                     await logger.logToStderr(args.options.webPartProperties);
@@ -96,6 +96,12 @@ class SpoPageControlSetCommand extends SpoCommand {
                     await logger.logToStderr('');
                 }
             }
+            else if (args.options.innerHtml) {
+                if (canvasControl.controlType !== 4 && !canvasControl.innerHTML) {
+                    throw 'The innerHtml option can only be used with text web parts.';
+                }
+                canvasControl.innerHTML = args.options.innerHtml;
+            }
             const pageData = {};
             if (page.AuthorByline) {
                 pageData.AuthorByline = page.AuthorByline;
@@ -140,7 +146,8 @@ _SpoPageControlSetCommand_instances = new WeakSet(), _SpoPageControlSetCommand_i
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
             webPartData: typeof args.options.webPartData !== 'undefined',
-            webPartProperties: typeof args.options.webPartProperties !== 'undefined'
+            webPartProperties: typeof args.options.webPartProperties !== 'undefined',
+            innerHtml: typeof args.options.innerHtml !== 'undefined'
         });
     });
 }, _SpoPageControlSetCommand_initOptions = function _SpoPageControlSetCommand_initOptions() {
@@ -154,21 +161,23 @@ _SpoPageControlSetCommand_instances = new WeakSet(), _SpoPageControlSetCommand_i
         option: '--webPartData [webPartData]'
     }, {
         option: '--webPartProperties [webPartProperties]'
+    }, {
+        option: '--innerHtml [innerHtml]'
     });
 }, _SpoPageControlSetCommand_initValidators = function _SpoPageControlSetCommand_initValidators() {
     this.validators.push(async (args) => {
         if (!validation.isValidGuid(args.options.id)) {
             return `${args.options.id} is not a valid GUID`;
         }
-        if (args.options.webPartData && args.options.webPartProperties) {
-            return 'Specify webPartProperties or webPartData but not both';
+        if ([args.options.webPartData, args.options.webPartProperties, args.options.innerHtml].filter(Boolean).length > 1) {
+            return 'Specify webPartProperties, webPartData, or innerHtml but not more than one';
         }
         if (args.options.webPartProperties) {
             try {
                 JSON.parse(args.options.webPartProperties);
             }
             catch (e) {
-                return `Specified webPartProperties is not a valid JSON string. Input: ${args.options.webPartData}. Error: ${e}`;
+                return `Specified webPartProperties is not a valid JSON string. Input: ${args.options.webPartProperties}. Error: ${e}`;
             }
         }
         if (args.options.webPartData) {

package/dist/m365/spo/commands/page/page-get.js

@@ -30,7 +30,11 @@ class SpoPageGetCommand extends SpoCommand {
     getRefinedSchema(schema) {
         return schema
             .refine(options => [options.name, options.default].filter(x => x !== undefined).length === 1, {
-            error: `Specify either name or default, but not both.`
+            error: `Specify either name or default, but not both.`,
+            params: {
+                customCode: 'optionSet',
+                options: ['name', 'default']
+            }
         });
     }
     async commandAction(logger, args) {

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

@@ -38,10 +38,18 @@ class SpoWebAlertListCommand extends SpoCommand {
     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.`
+            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.`
+            error: `Specify either userName or userId, but not both.`,
+            params: {
+                customCode: 'optionSet',
+                options: ['userName', 'userId']
+            }
         });
     }
     async commandAction(logger, args) {

package/dist/m365/spp/commands/autofillcolumn/autofillcolumn-set.js

@@ -55,10 +55,18 @@ class SppAutofillColumnSetCommand extends SpoCommand {
     getRefinedSchema(schema) {
         return schema
             .refine(options => [options.columnId, options.columnTitle, options.columnInternalName].filter(Boolean).length === 1, {
-            message: `Specify exactly one of the following options: 'columnId', 'columnTitle' or 'columnInternalName'.`
+            message: `Specify exactly one of the following options: 'columnId', 'columnTitle' or 'columnInternalName'.`,
+            params: {
+                customCode: 'optionSet',
+                options: ['columnId', 'columnTitle', 'columnInternalName']
+            }
         })
             .refine(options => [options.listTitle, options.listId, options.listUrl].filter(Boolean).length === 1, {
-            message: `Specify exactly one of the following options: 'listTitle', 'listId' or 'listUrl'.`
+            message: `Specify exactly one of the following options: 'listTitle', 'listId' or 'listUrl'.`,
+            params: {
+                customCode: 'optionSet',
+                options: ['listTitle', 'listId', 'listUrl']
+            }
         });
     }
     async commandAction(logger, args) {

package/dist/m365/spp/commands/model/model-apply.js

@@ -39,10 +39,18 @@ class SppModelApplyCommand extends SpoCommand {
     getRefinedSchema(schema) {
         return schema
             .refine(options => [options.id, options.title].filter(x => x !== undefined).length === 1, {
-            error: `Specify exactly one of the following options: 'id' or 'title'.`
+            error: `Specify exactly one of the following options: 'id' or 'title'.`,
+            params: {
+                customCode: 'optionSet',
+                options: ['id', 'title']
+            }
         })
             .refine(options => [options.listTitle, options.listId, options.listUrl].filter(x => x !== undefined).length === 1, {
-            error: `Specify exactly one of the following options: 'listTitle', 'listId' or 'listUrl'.`
+            error: `Specify exactly one of the following options: 'listTitle', 'listId' or 'listUrl'.`,
+            params: {
+                customCode: 'optionSet',
+                options: ['listTitle', 'listId', 'listUrl']
+            }
         });
     }
     async commandAction(logger, args) {

package/dist/m365/teams/commands/callrecord/callrecord-list.js

@@ -55,7 +55,11 @@ class TeamsCallRecordListCommand extends GraphApplicationCommand {
     getRefinedSchema(schema) {
         return schema
             .refine((options) => [options.userId, options.userName].filter(o => o !== undefined).length <= 1, {
-            error: 'Use one of the following options: userId or userName but not both.'
+            error: 'Use one of the following options: userId or userName but not both.',
+            params: {
+                customCode: 'optionSet',
+                options: ['userId', 'userName']
+            }
         })
             .refine((options) => [options.startDateTime, options.endDateTime].filter(o => o !== undefined).length <= 1 || new Date(options.startDateTime) < new Date(options.endDateTime), {
             message: 'Value of startDateTime, must be before endDateTime.'

package/dist/m365/viva/commands/engage/engage-community-user-add.js

@@ -35,16 +35,32 @@ class VivaEngageCommunityUserAddCommand extends GraphCommand {
     getRefinedSchema(schema) {
         return schema
             .refine(options => [options.communityId, options.communityDisplayName, options.entraGroupId].filter(x => x !== undefined).length === 1, {
-            error: 'Specify either communityId, communityDisplayName, or entraGroupId, but not multiple.'
+            error: 'Specify either communityId, communityDisplayName, or entraGroupId, but not multiple.',
+            params: {
+                customCode: 'optionSet',
+                options: ['communityId', 'communityDisplayName', 'entraGroupId']
+            }
         })
             .refine(options => options.communityId || options.communityDisplayName || options.entraGroupId, {
-            error: 'Specify at least one of communityId, communityDisplayName, or entraGroupId.'
+            error: 'Specify at least one of communityId, communityDisplayName, or entraGroupId.',
+            params: {
+                customCode: 'optionSet',
+                options: ['communityId', 'communityDisplayName', 'entraGroupId']
+            }
         })
             .refine(options => options.ids || options.userNames, {
-            error: 'Specify either of ids or userNames.'
+            error: 'Specify either of ids or userNames.',
+            params: {
+                customCode: 'optionSet',
+                options: ['ids', 'userNames']
+            }
         })
             .refine(options => typeof options.userNames !== 'undefined' || typeof options.ids !== 'undefined', {
-            error: 'Specify either ids or userNames, but not both.'
+            error: 'Specify either ids or userNames, but not both.',
+            params: {
+                customCode: 'optionSet',
+                options: ['ids', 'userNames']
+            }
         });
     }
     async commandAction(logger, args) {

package/dist/m365/viva/commands/engage/engage-community-user-list.js

@@ -24,10 +24,18 @@ class VivaEngageCommunityUserListCommand extends GraphCommand {
     getRefinedSchema(schema) {
         return schema
             .refine(options => [options.communityId, options.communityDisplayName, options.entraGroupId].filter(x => x !== undefined).length === 1, {
-            error: 'Specify either communityId, communityDisplayName, or entraGroupId, but not multiple.'
+            error: 'Specify either communityId, communityDisplayName, or entraGroupId, but not multiple.',
+            params: {
+                customCode: 'optionSet',
+                options: ['communityId', 'communityDisplayName', 'entraGroupId']
+            }
         })
             .refine(options => options.communityId || options.communityDisplayName || options.entraGroupId, {
-            error: 'Specify at least one of communityId, communityDisplayName, or entraGroupId.'
+            error: 'Specify at least one of communityId, communityDisplayName, or entraGroupId.',
+            params: {
+                customCode: 'optionSet',
+                options: ['communityId', 'communityDisplayName', 'entraGroupId']
+            }
         });
     }
     defaultProperties() {

package/dist/m365/viva/commands/engage/engage-community-user-remove.js

@@ -32,16 +32,25 @@ class VivaEngageCommunityUserRemoveCommand extends GraphCommand {
     getRefinedSchema(schema) {
         return schema
             .refine(options => [options.communityId, options.communityDisplayName, options.entraGroupId].filter(x => x !== undefined).length === 1, {
-            error: 'Specify either communityId, communityDisplayName, or entraGroupId, but not multiple.'
+            error: 'Specify either communityId, communityDisplayName, or entraGroupId, but not multiple.',
+            params: {
+                customCode: 'optionSet',
+                options: ['communityId', 'communityDisplayName', 'entraGroupId']
+            }
         })
             .refine(options => options.communityId || options.communityDisplayName || options.entraGroupId, {
-            error: 'Specify at least one of communityId, communityDisplayName, or entraGroupId.'
-        })
-            .refine(options => options.id || options.userName, {
-            error: 'Specify either of id or userName.'
+            error: 'Specify at least one of communityId, communityDisplayName, or entraGroupId.',
+            params: {
+                customCode: 'optionSet',
+                options: ['communityId', 'communityDisplayName', 'entraGroupId']
+            }
         })
-            .refine(options => typeof options.userName !== 'undefined' || typeof options.id !== 'undefined', {
-            error: 'Specify either id or userName, but not both.'
+            .refine(options => [options.id, options.userName].filter(o => o !== undefined).length === 1, {
+            error: 'Specify either id or userName, but not both.',
+            params: {
+                customCode: 'optionSet',
+                options: ['id', 'userName']
+            }
         });
     }
     async commandAction(logger, args) {

package/dist/m365/viva/commands/engage/engage-role-member-add.js

@@ -0,0 +1,79 @@
+import { z } from 'zod';
+import { globalOptionsZod } from '../../../../Command.js';
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+import { vivaEngage } from '../../../../utils/vivaEngage.js';
+import { entraUser } from '../../../../utils/entraUser.js';
+import request from '../../../../request.js';
+import { validation } from '../../../../utils/validation.js';
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    roleId: z.uuid().optional().refine(id => validation.isValidGuid(id), {
+        error: e => `'${e.input}' is not a valid GUID.`
+    }),
+    roleName: z.string().optional(),
+    userId: z.uuid().optional().refine(id => validation.isValidGuid(id), {
+        error: e => `'${e.input}' is not a valid GUID.`
+    }),
+    userName: z.string().refine(upn => validation.isValidUserPrincipalName(upn), {
+        error: e => `'${e.input}' is not a valid UPN.`
+    }).optional()
+});
+class VivaEngageRoleMemberAddCommand extends GraphCommand {
+    get name() {
+        return commands.ENGAGE_ROLE_MEMBER_ADD;
+    }
+    get description() {
+        return 'Assign a Viva Engage role to a user';
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => [options.roleId, options.roleName].filter(x => x !== undefined).length === 1, {
+            error: 'Specify either roleId, or roleName, but not both.'
+        })
+            .refine(options => [options.userId, options.userName].filter(x => x !== undefined).length === 1, {
+            error: 'Specify either userId, or userName, but not both.'
+        });
+    }
+    async commandAction(logger, args) {
+        try {
+            let roleId = args.options.roleId;
+            let userId = args.options.userId;
+            if (args.options.roleName) {
+                if (this.verbose) {
+                    await logger.logToStderr(`Retrieving Viva Engage role ID for role name '${args.options.roleName}'...`);
+                }
+                roleId = await vivaEngage.getRoleIdByName(args.options.roleName);
+            }
+            if (args.options.userName) {
+                if (this.verbose) {
+                    await logger.logToStderr(`Retrieving Viva Engage user ID for user name '${args.options.userName}'...`);
+                }
+                userId = await entraUser.getUserIdByUpn(args.options.userName);
+            }
+            if (this.verbose) {
+                await logger.logToStderr(`Assigning user ${userId} to a Viva Engage role ${roleId}...`);
+            }
+            const requestOptions = {
+                url: `${this.resource}/beta/employeeExperience/roles/${roleId}/members`,
+                headers: {
+                    'content-type': 'application/json;odata=nometadata',
+                    'accept': 'application/json;odata.metadata=none'
+                },
+                responseType: 'json',
+                data: {
+                    'user@odata.bind': `${this.resource}/beta/users('${userId}')`
+                }
+            };
+            await request.post(requestOptions);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+}
+export default new VivaEngageRoleMemberAddCommand();
+//# sourceMappingURL=engage-role-member-add.js.map

package/dist/m365/viva/commands/engage/engage-role-member-list.js

@@ -22,7 +22,11 @@ class VivaEngageRoleMemberListCommand extends GraphCommand {
     getRefinedSchema(schema) {
         return schema
             .refine(options => [options.roleId, options.roleName].filter(x => x !== undefined).length === 1, {
-            error: 'Specify either roleId, or roleName, but not both.'
+            error: 'Specify either roleId, or roleName, but not both.',
+            params: {
+                customCode: 'optionSet',
+                options: ['roleId', 'roleName']
+            }
         });
     }
     defaultProperties() {

package/dist/m365/viva/commands.js

@@ -25,6 +25,7 @@ export default {
     ENGAGE_REPORT_GROUPSACTIVITYDETAIL: `${prefix} engage report groupsactivitydetail`,
     ENGAGE_REPORT_GROUPSACTIVITYGROUPCOUNTS: `${prefix} engage report groupsactivitygroupcounts`,
     ENGAGE_ROLE_LIST: `${prefix} engage role list`,
+    ENGAGE_ROLE_MEMBER_ADD: `${prefix} engage role member add`,
     ENGAGE_ROLE_MEMBER_LIST: `${prefix} engage role member list`,
     ENGAGE_ROLE_MEMBER_REMOVE: `${prefix} engage role member remove`,
     ENGAGE_SEARCH: `${prefix} engage search`,

package/dist/utils/prompt.js

@@ -13,13 +13,7 @@ export const prompt = {
         }
         const errorOutput = cli.getSettingWithDefaultValue(settingsNames.errorOutput, 'stderr');
         return inquirerInput
-            .default(config, { output: errorOutput === 'stderr' ? process.stderr : process.stdout })
-            .catch(error => {
-            if (error instanceof Error && error.name === 'ExitPromptError') {
-                return ''; // noop; handle Ctrl + C
-            }
-            throw error;
-        });
+            .default(config, { output: errorOutput === 'stderr' ? process.stderr : process.stdout });
     },
     /* c8 ignore next 9 */
     async forConfirmation(config) {

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

@@ -41,16 +41,16 @@ m365 outlook calendar get [options]
 <Tabs>
   <TabItem value="Delegated">
 
-  | Resource        | Permissions        |
-  |-----------------|--------------------|
-  | Microsoft Graph | Calendar.ReadBasic |
+  | Resource        | Permissions    |
+  |-----------------|----------------|
+  | Microsoft Graph | Calendars.Read |
 
   </TabItem>
   <TabItem value="Application">
 
-  | Resource        | Permissions        |
-  |-----------------|--------------------|
-  | Microsoft Graph | Calendar.ReadBasic |
+  | Resource        | Permissions    |
+  |-----------------|----------------|
+  | Microsoft Graph | Calendars.Read |
 
   </TabItem>
 </Tabs>
@@ -162,4 +162,4 @@ m365 outlook calendar get --userId b743445a-112c-4fda-9afd-05943f9c7b36 --calend
   ```
 
   </TabItem>
-</Tabs>
+</Tabs>

package/docs/docs/cmd/spe/container/container-get.mdx

@@ -15,8 +15,17 @@ m365 spe container get [options]
 ## Options
 
 ```md definition-list
-`-i, --id <id>`
-: The Id of the container instance.
+`-i, --id [id]`
+: The Id of the container instance. Specify either `id` or `name` but not both.
+
+`-n, --name [name]`
+: Display name of the container. Specify either `id` or `name` but not both.
+
+`--containerTypeId [containerTypeId]`
+: The container type ID of the container instance. Specify either `containerTypeId` or `containerTypeName` when using `name` but not both.
+
+`--containerTypeName [containerTypeName]`
+: The container type name of the container instance. Specify either `containerTypeId` or `containerTypeName` when using `name` but not both.
 ```
 
 <Global />
@@ -42,12 +51,24 @@ m365 spe container get [options]
 
 ## Examples
 
-Gets a container of a specific type.
+Gets a container of a specific type by id.
 
 ```sh
 m365 spe container get --id "b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z"
 ```
 
+Gets a container of a specific type by display name.
+
+```sh
+m365 spe container get --name "My Application Storage Container" --containerTypeId "91710488-5756-407f-9046-fbe5f0b4de73"
+```
+
+Gets container by using its name and container type name.
+
+```sh
+m365 spe container get --name "Invoices" --containerTypeName "My container type name"
+```
+
 ## Response
 
 <Tabs>

package/docs/docs/cmd/spe/container/container-permission-list.mdx

@@ -15,8 +15,17 @@ m365 spe container permission list [options]
 ## Options
 
 ```md definition-list
-`-i, --containerId <id>`
-: The ID of the SharePoint Embedded Container.
+`-i, --containerId [id]`
+: The ID of the SharePoint Embedded Container. Specify either `containerId` or `containerName` but not both.
+
+`-n, --containerName [containerName]`
+: Display name of the SharePoint Embedded Container. Specify either `containerId` or `containerName` but not both.
+
+`--containerTypeId [containerTypeId]`
+: The container type ID of the container instance. Specify either `containerTypeId` or `containerTypeName` when using `containerName` but not both.
+
+`--containerTypeName [containerTypeName]`
+: The container type name of the container instance. Specify either `containerTypeId` or `containerTypeName` when using `containerName` but not both.
 ```
 
 <Global />
@@ -42,12 +51,24 @@ m365 spe container permission list [options]
 
 ## Examples
 
-Lists Container permissions.
+Lists Container permissions by id.
 
 ```sh
 m365 spe container permission list --containerId "b!ISJs1WRro0y0EWgkUYcktDa0mE8zSlFEqFzqRn70Zwp1CEtDEBZgQICPkRbil_5Z"
 ```
 
+Lists Container permissions by display name.
+
+```sh
+m365 spe container permission list --containerName "My Application Storage Container" --containerTypeId "91710488-5756-407f-9046-fbe5f0b4de73"
+```
+
+Lists Container permissions by display name and container type name.
+
+```sh
+m365 spe container permission list --containerName "My Application Storage Container"  --containerTypeName "My container type name"
+```
+
 ## Response
 
 <Tabs>