@pnp/cli-microsoft365 11.8.0-beta.ae98113 → 11.9.0-beta.0365d84

package/dist/m365/spo/commands/homesite/homesite-set.js

@@ -38,7 +38,11 @@ class SpoHomeSiteSetCommand extends SpoCommand {
     getRefinedSchema(schema) {
         return schema
             .refine((options) => [options.audienceIds, options.audienceNames].filter(o => o !== undefined).length <= 1, {
-            message: 'You must specify either audienceIds or audienceNames but not both.'
+            message: 'You must specify either audienceIds or audienceNames but not both.',
+            params: {
+                customCode: 'optionSet',
+                options: ['audienceIds', 'audienceNames']
+            }
         })
             .refine((options) => options.vivaConnectionsDefaultStart !== undefined ||
             options.draftMode !== undefined ||
@@ -46,7 +50,10 @@ class SpoHomeSiteSetCommand extends SpoCommand {
             options.audienceNames !== undefined ||
             options.targetedLicenseType !== undefined ||
             options.order !== undefined, {
-            message: 'You must specify at least one option to configure.'
+            message: 'You must specify at least one option to configure.',
+            params: {
+                customCode: 'required'
+            }
         });
     }
     async commandAction(logger, args) {

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

@@ -35,10 +35,18 @@ class SpoListDefaultValueClearCommand 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']
+            }
         })
             .refine(options => (options.fieldName !== undefined) !== (options.folderUrl !== undefined) || (options.fieldName === undefined && options.folderUrl === undefined), {
-            error: `Specify 'fieldName' or 'folderUrl', but not both.`
+            error: `Specify 'fieldName' or 'folderUrl', but not both.`,
+            params: {
+                customCode: 'optionSet',
+                options: ['fieldName', 'folderUrl']
+            }
         });
     }
     async commandAction(logger, args) {

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

@@ -33,7 +33,11 @@ class SpoListDefaultValueGetCommand 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-list.js

@@ -32,7 +32,11 @@ class SpoListDefaultValueListCommand 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-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-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-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/request.js

@@ -34,7 +34,7 @@ class Request {
                     await this._logger.logToStderr('Response:');
                     const properties = ['status', 'statusText', 'headers'];
                     if (response.headers['content-type'] &&
-                        response.headers['content-type'].indexOf('json') > -1) {
+                        response.headers['content-type'].toString().indexOf('json') > -1) {
                         properties.push('data');
                     }
                     await this._logger.logToStderr(JSON.stringify({

package/dist/utils/packageManager.js

@@ -2,29 +2,44 @@ const packageCommands = {
     npm: {
         install: 'npm i -SE',
         installDev: 'npm i -DE',
+        installLockFile: 'npm i',
         uninstall: 'npm un -S',
-        uninstallDev: 'npm un -D'
+        uninstallDev: 'npm un -D',
+        override: 'npm pkg set',
+        removeOverride: 'npm pkg delete'
     },
     pnpm: {
         install: 'pnpm i -E',
         installDev: 'pnpm i -DE',
+        installLockFile: 'pnpm i',
         uninstall: 'pnpm un',
-        uninstallDev: 'pnpm un'
+        uninstallDev: 'pnpm un',
+        override: 'pnpm pkg set',
+        removeOverride: 'pnpm pkg delete'
     },
     yarn: {
         install: 'yarn add -E',
         installDev: 'yarn add -DE',
         uninstall: 'yarn remove',
         uninstallDev: 'yarn remove'
+        // Yarn is not supported for project upgrade since their CLI does not support setting overrides.
     }
 };
 export const packageManager = {
     getPackageManagerCommand(command, packageManager) {
         return packageCommands[packageManager][command];
     },
-    mapPackageManagerCommand({ command, packagesDepExact, packagesDevExact, packagesDepUn, packagesDevUn, packageMgr }) {
+    mapPackageManagerCommand({ command, packagesDepExact, packagesDevExact, packagesDepUn, packagesDevUn, packagesOverride, packagesOverrideRemove, packageMgr }) {
         // matches must be in this particular order to avoid false matches, eg.
-        // uninstallDev contains install
+        // uninstallDev contains install, removeOverride contains override
+        if (command.startsWith(`${packageManager.getPackageManagerCommand('removeOverride', packageMgr)} `)) {
+            packagesOverrideRemove.push(command.replace(packageManager.getPackageManagerCommand('removeOverride', packageMgr), '').trim());
+            return;
+        }
+        if (command.startsWith(`${packageManager.getPackageManagerCommand('override', packageMgr)} `)) {
+            packagesOverride.push(command.replace(packageManager.getPackageManagerCommand('override', packageMgr), '').trim());
+            return;
+        }
         if (command.startsWith(`${packageManager.getPackageManagerCommand('uninstallDev', packageMgr)} `)) {
             packagesDevUn.push(command.replace(packageManager.getPackageManagerCommand('uninstallDev', packageMgr), '').trim());
             return;
@@ -41,10 +56,21 @@ export const packageManager = {
             packagesDepExact.push(command.replace(packageManager.getPackageManagerCommand('install', packageMgr), '').trim());
         }
     },
-    reducePackageManagerCommand({ packagesDepExact, packagesDevExact, packagesDepUn, packagesDevUn, packageMgr }) {
+    reducePackageManagerCommand({ packagesDepExact, packagesDevExact, packagesDepUn, packagesDevUn, packagesOverride, packagesOverrideRemove, packageMgr }) {
         const commandsToExecute = [];
-        // uninstall commands must come first otherwise there is a chance that
-        // whatever we recommended to install, will be immediately uninstalled
+        // removeOverride comes first to clear stale overrides before any install/uninstall
+        // uninstall commands must come before install commands otherwise there is a
+        // chance that whatever we recommended to install will be immediately uninstalled
+        // override (add) comes last so it is applied after all
+        // install/uninstall operations have completed
+        if (packagesOverrideRemove.length > 0) {
+            commandsToExecute.push(`${packageManager.getPackageManagerCommand('removeOverride', packageMgr)} ${packagesOverrideRemove.join(' ')}`);
+            // removeOverride only updates package.json; run a plain install to update the lock file
+            // only needed when no other install/uninstall commands will already update the lock file
+            if (packagesDepUn.length === 0 && packagesDevUn.length === 0 && packagesDepExact.length === 0 && packagesDevExact.length === 0 && packagesOverride.length === 0) {
+                commandsToExecute.push(packageManager.getPackageManagerCommand('installLockFile', packageMgr));
+            }
+        }
         if (packagesDepUn.length > 0) {
             commandsToExecute.push(`${packageManager.getPackageManagerCommand('uninstall', packageMgr)} ${packagesDepUn.join(' ')}`);
         }
@@ -57,6 +83,11 @@ export const packageManager = {
         if (packagesDevExact.length > 0) {
             commandsToExecute.push(`${packageManager.getPackageManagerCommand('installDev', packageMgr)} ${packagesDevExact.join(' ')}`);
         }
+        if (packagesOverride.length > 0) {
+            commandsToExecute.push(`${packageManager.getPackageManagerCommand('override', packageMgr)} ${packagesOverride.join(' ')}`);
+            // override only updates package.json; run a plain install to update the lock file
+            commandsToExecute.push(packageManager.getPackageManagerCommand('installLockFile', packageMgr));
+        }
         return commandsToExecute;
     }
 };

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/spfx/project/project-upgrade.mdx

@@ -19,7 +19,7 @@ m365 spfx project upgrade [options]
 : The version of SharePoint Framework to which upgrade the project
 
 `--packageManager [packageManager]`
-: The package manager you use. Supported managers `npm`, `pnpm`, `yarn`. Default `npm`
+: The package manager you use. Supported managers `npm` or `pnpm`. Default `npm`
 
 `--shell [shell]`
 : The shell you use. Supported shells `bash`, `powershell`, `cmd`. Default `powershell`
@@ -45,7 +45,7 @@ m365 spfx project upgrade [options]
 
 ## Remarks
 
-The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.23.0-rc.0).
+The `spfx project upgrade` command helps you upgrade your SharePoint Framework project to the specified version. If no version is specified, the command will upgrade to the latest version of the SharePoint Framework it supports (v1.23.0).
 
 This command doesn't change your project files. Instead, it gives you a report with all steps necessary to upgrade your project to the specified version of the SharePoint Framework. Changing project files is error-prone, especially when it comes to updating your solution's code. This is why at this moment, this command produces a report that you can use yourself to perform the necessary updates and verify that everything is working as expected.