@pnp/cli-microsoft365 10.3.0-beta.cd20f0c → 10.3.0-beta.df85113

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

@@ -0,0 +1,181 @@
+import SpoCommand from '../../../base/SpoCommand.js';
+import { globalOptionsZod } from '../../../../Command.js';
+import { z } from 'zod';
+import { zod } from '../../../../utils/zod.js';
+import commands from '../../commands.js';
+import { DOMParser } from '@xmldom/xmldom';
+import { validation } from '../../../../utils/validation.js';
+import { urlUtil } from '../../../../utils/urlUtil.js';
+import request from '../../../../request.js';
+import { formatting } from '../../../../utils/formatting.js';
+import { cli } from '../../../../cli/cli.js';
+const options = globalOptionsZod
+    .extend({
+    webUrl: zod.alias('u', z.string()
+        .refine(url => validation.isValidSharePointUrl(url) === true, url => ({
+        message: `'${url}' is not a valid SharePoint Online site URL.`
+    }))),
+    listId: zod.alias('i', z.string().optional()
+        .refine(id => id === undefined || validation.isValidGuid(id), id => ({
+        message: `'${id}' is not a valid GUID.`
+    }))),
+    listTitle: zod.alias('t', z.string().optional()),
+    listUrl: z.string().optional(),
+    fieldName: z.string(),
+    folderUrl: z.string().optional(),
+    force: zod.alias('f', z.boolean().optional())
+})
+    .strict();
+class SpoListDefaultValueRemoveCommand extends SpoCommand {
+    get name() {
+        return commands.LIST_DEFAULTVALUE_REMOVE;
+    }
+    get description() {
+        return 'Removes a specific default column value for a specific document library';
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => [options.listId, options.listTitle, options.listUrl].filter(o => o !== undefined).length === 1, {
+            message: 'Use one of the following options: listId, listTitle, listUrl.'
+        });
+    }
+    async commandAction(logger, args) {
+        if (!args.options.force) {
+            const result = await cli.promptForConfirmation({ message: `Are you sure you want to remove default column value '${args.options.fieldName}' from ${args.options.folderUrl ? `'${args.options.folderUrl}'` : 'the root of the list'}?` });
+            if (!result) {
+                return;
+            }
+        }
+        try {
+            if (this.verbose) {
+                await logger.logToStderr(`Removing default column value '${args.options.fieldName}' from ${args.options.folderUrl ? `'${args.options.folderUrl}'` : 'the root of the list'}.`);
+                await logger.logToStderr(`Getting server-relative URL of the list...`);
+            }
+            const listServerRelUrl = await this.getServerRelativeListUrl(args.options);
+            let folderUrl = listServerRelUrl;
+            if (args.options.folderUrl) {
+                folderUrl = urlUtil.getServerRelativePath(args.options.webUrl, urlUtil.removeTrailingSlashes(args.options.folderUrl));
+            }
+            if (this.verbose) {
+                await logger.logToStderr(`Getting default column values...`);
+            }
+            const defaultValuesXml = await this.getDefaultColumnValuesXml(args.options.webUrl, listServerRelUrl);
+            const removeDefaultValueResult = this.removeFieldFromXml(defaultValuesXml, args.options.fieldName, folderUrl);
+            if (!removeDefaultValueResult.isFieldFound) {
+                throw `Default column value '${args.options.fieldName}' was not found.`;
+            }
+            if (this.verbose) {
+                await logger.logToStderr(`Uploading default column values to list...`);
+            }
+            await this.uploadDefaultColumnValuesXml(args.options.webUrl, listServerRelUrl, removeDefaultValueResult.xml);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+    async getServerRelativeListUrl(options) {
+        const requestOptions = {
+            url: `${options.webUrl}/_api/Web`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        if (options.listUrl) {
+            const serverRelativeUrl = urlUtil.getServerRelativePath(options.webUrl, options.listUrl);
+            requestOptions.url += `/GetList('${formatting.encodeQueryParameter(serverRelativeUrl)}')`;
+        }
+        else if (options.listId) {
+            requestOptions.url += `/Lists('${options.listId}')`;
+        }
+        else if (options.listTitle) {
+            requestOptions.url += `/Lists/GetByTitle('${formatting.encodeQueryParameter(options.listTitle)}')`;
+        }
+        requestOptions.url += '?$expand=RootFolder&$select=RootFolder/ServerRelativeUrl,BaseTemplate';
+        try {
+            const response = await request.get(requestOptions);
+            if (response.BaseTemplate !== 101) {
+                throw `The specified list is not a document library.`;
+            }
+            return response.RootFolder.ServerRelativeUrl;
+        }
+        catch (error) {
+            if (error.status === 404) {
+                throw `List '${options.listId || options.listTitle || options.listUrl}' was not found.`;
+            }
+            throw error;
+        }
+    }
+    async getDefaultColumnValuesXml(webUrl, listServerRelUrl) {
+        try {
+            const requestOptions = {
+                url: `${webUrl}/_api/Web/GetFileByServerRelativePath(decodedUrl='${formatting.encodeQueryParameter(listServerRelUrl + '/Forms/client_LocationBasedDefaults.html')}')/$value`,
+                headers: {
+                    accept: 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            const defaultValuesXml = await request.get(requestOptions);
+            return defaultValuesXml;
+        }
+        catch (err) {
+            // For lists that have never had default column values set, the client_LocationBasedDefaults.html file does not exist.
+            if (err.status === 404) {
+                return null;
+            }
+            throw err;
+        }
+    }
+    removeFieldFromXml(xml, fieldName, folderUrl) {
+        if (xml === null) {
+            return { isFieldFound: false };
+        }
+        // Encode all spaces in the folder URL
+        const encodedFolderUrl = folderUrl.replace(/ /g, '%20');
+        const parser = new DOMParser();
+        const doc = parser.parseFromString(xml, 'application/xml');
+        const folderLinks = doc.getElementsByTagName('a');
+        for (let i = 0; i < folderLinks.length; i++) {
+            const folderNode = folderLinks[i];
+            const folderNodeUrl = folderNode.getAttribute('href');
+            if (encodedFolderUrl.toLowerCase() !== folderNodeUrl.toLowerCase()) {
+                continue;
+            }
+            const defaultValues = folderNode.getElementsByTagName('DefaultValue');
+            for (let j = 0; j < defaultValues.length; j++) {
+                const defaultValueNode = defaultValues[j];
+                const defaultValueNodeField = defaultValueNode.getAttribute('FieldName');
+                if (defaultValueNodeField !== fieldName) {
+                    continue;
+                }
+                if (folderNode.childNodes.length === 1) {
+                    // No other default values found in the folder, let's remove the folder node
+                    folderNode.parentNode.removeChild(folderNode);
+                }
+                else {
+                    // Default value node found, let's remove it
+                    folderNode.removeChild(defaultValueNode);
+                }
+                return { isFieldFound: true, xml: doc.toString() };
+            }
+        }
+        return { isFieldFound: false };
+    }
+    async uploadDefaultColumnValuesXml(webUrl, listServerRelUrl, xml) {
+        const requestOptions = {
+            url: `${webUrl}/_api/Web/GetFileByServerRelativePath(decodedUrl='${formatting.encodeQueryParameter(listServerRelUrl + '/Forms/client_LocationBasedDefaults.html')}')/$value`,
+            headers: {
+                accept: 'application/json;odata=nometadata',
+                'content-type': 'text/plain'
+            },
+            responseType: 'json',
+            data: xml
+        };
+        await request.put(requestOptions);
+    }
+}
+export default new SpoListDefaultValueRemoveCommand();
+//# sourceMappingURL=list-defaultvalue-remove.js.map

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

@@ -0,0 +1,210 @@
+import SpoCommand from '../../../base/SpoCommand.js';
+import { globalOptionsZod } from '../../../../Command.js';
+import { z } from 'zod';
+import { zod } from '../../../../utils/zod.js';
+import commands from '../../commands.js';
+import { DOMParser } from '@xmldom/xmldom';
+import { validation } from '../../../../utils/validation.js';
+import { urlUtil } from '../../../../utils/urlUtil.js';
+import request from '../../../../request.js';
+import { formatting } from '../../../../utils/formatting.js';
+const options = globalOptionsZod
+    .extend({
+    webUrl: zod.alias('u', z.string()
+        .refine(url => validation.isValidSharePointUrl(url) === true, url => ({
+        message: `'${url}' is not a valid SharePoint Online site URL.`
+    }))),
+    listId: zod.alias('i', z.string().optional()
+        .refine(id => id === undefined || validation.isValidGuid(id), id => ({
+        message: `'${id}' is not a valid GUID.`
+    }))),
+    listTitle: zod.alias('t', z.string().optional()),
+    listUrl: z.string().optional(),
+    fieldName: z.string(),
+    fieldValue: z.string()
+        .refine(value => value !== '', `The value cannot be empty. Use 'spo list defaultvalue remove' to remove a default column value.`),
+    folderUrl: z.string().optional()
+        .refine(url => url === undefined || (!url.includes('#') && !url.includes('%')), 'Due to limitations in SharePoint Online, setting default column values for folders with a # or % character in their path is not supported.')
+})
+    .strict();
+class SpoListDefaultValueSetCommand extends SpoCommand {
+    get name() {
+        return commands.LIST_DEFAULTVALUE_SET;
+    }
+    get description() {
+        return 'Sets default column values for a specific document library';
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => [options.listId, options.listTitle, options.listUrl].filter(o => o !== undefined).length === 1, {
+            message: 'Use one of the following options: listId, listTitle, listUrl.'
+        });
+    }
+    async commandAction(logger, args) {
+        try {
+            if (this.verbose) {
+                await logger.logToStderr(`Setting default column value '${args.options.fieldValue}' for field '${args.options.fieldName}'...`);
+                await logger.logToStderr(`Getting server-relative URL of the list...`);
+            }
+            const listServerRelUrl = await this.getServerRelativeListUrl(args.options);
+            let folderUrl = listServerRelUrl;
+            if (args.options.folderUrl) {
+                if (this.verbose) {
+                    await logger.logToStderr(`Getting server-relative URL of folder '${args.options.folderUrl}'...`);
+                }
+                // Casing of the folder URL is important, let's retrieve the correct URL
+                const serverRelativeFolderUrl = urlUtil.getServerRelativePath(args.options.webUrl, urlUtil.removeTrailingSlashes(args.options.folderUrl));
+                folderUrl = await this.getCorrectFolderUrl(args.options.webUrl, serverRelativeFolderUrl);
+            }
+            if (this.verbose) {
+                await logger.logToStderr(`Getting default column values...`);
+            }
+            const defaultValuesXml = await this.ensureDefaultColumnValuesXml(args.options.webUrl, listServerRelUrl);
+            const modifiedXml = await this.updateFieldValueXml(logger, defaultValuesXml, args.options.fieldName, args.options.fieldValue, folderUrl);
+            await this.uploadDefaultColumnValuesXml(logger, args.options.webUrl, listServerRelUrl, modifiedXml);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+    async getServerRelativeListUrl(options) {
+        const requestOptions = {
+            url: `${options.webUrl}/_api/Web`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        if (options.listUrl) {
+            const serverRelativeUrl = urlUtil.getServerRelativePath(options.webUrl, options.listUrl);
+            requestOptions.url += `/GetList('${formatting.encodeQueryParameter(serverRelativeUrl)}')`;
+        }
+        else if (options.listId) {
+            requestOptions.url += `/Lists('${options.listId}')`;
+        }
+        else if (options.listTitle) {
+            requestOptions.url += `/Lists/GetByTitle('${formatting.encodeQueryParameter(options.listTitle)}')`;
+        }
+        requestOptions.url += '?$expand=RootFolder&$select=RootFolder/ServerRelativeUrl,BaseTemplate';
+        try {
+            const response = await request.get(requestOptions);
+            if (response.BaseTemplate !== 101) {
+                throw `The specified list is not a document library.`;
+            }
+            return response.RootFolder.ServerRelativeUrl;
+        }
+        catch (error) {
+            if (error.status === 404) {
+                throw `List '${options.listId || options.listTitle || options.listUrl}' was not found.`;
+            }
+            throw error;
+        }
+    }
+    async getCorrectFolderUrl(webUrl, folderUrl) {
+        const requestOptions = {
+            // Using ListItemAllFields endpoint because GetFolderByServerRelativePath doesn't return the correctly cased URL
+            url: `${webUrl}/_api/Web/GetFolderByServerRelativePath(decodedUrl='${formatting.encodeQueryParameter(folderUrl)}')/ListItemAllFields?$select=FileRef`,
+            headers: {
+                accept: 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        const response = await request.get(requestOptions);
+        if (!response.FileRef) {
+            throw `Folder '${folderUrl}' was not found.`;
+        }
+        return response.FileRef;
+    }
+    async ensureDefaultColumnValuesXml(webUrl, listServerRelUrl) {
+        try {
+            const requestOptions = {
+                url: `${webUrl}/_api/Web/GetFileByServerRelativePath(decodedUrl='${formatting.encodeQueryParameter(listServerRelUrl + '/Forms/client_LocationBasedDefaults.html')}')/$value`,
+                headers: {
+                    accept: 'application/json;odata=nometadata'
+                },
+                responseType: 'json'
+            };
+            const defaultValuesXml = await request.get(requestOptions);
+            return defaultValuesXml;
+        }
+        catch (err) {
+            if (err.status !== 404) {
+                throw err;
+            }
+            // For lists that have never had default column values set, the client_LocationBasedDefaults.html file does not exist.
+            // In this case, we need to create the file with blank default metadata.
+            const requestOptions = {
+                url: `${webUrl}/_api/Web/GetFolderByServerRelativePath(decodedUrl='${formatting.encodeQueryParameter(listServerRelUrl + '/Forms')}')/Files/Add(url='client_LocationBasedDefaults.html', overwrite=false)`,
+                headers: {
+                    accept: 'application/json;odata=nometadata',
+                    'content-type': 'text/plain'
+                },
+                responseType: 'json',
+                data: '<MetadataDefaults />'
+            };
+            await request.post(requestOptions);
+            return requestOptions.data;
+        }
+    }
+    async updateFieldValueXml(logger, xml, fieldName, fieldValue, folderUrl) {
+        if (this.verbose) {
+            await logger.logToStderr(`Modifying default column values...`);
+        }
+        // Encode all spaces in the folder URL
+        const encodedFolderUrl = folderUrl.replace(/ /g, '%20');
+        const parser = new DOMParser();
+        const doc = parser.parseFromString(xml, 'application/xml');
+        // Create a new DefaultValue node
+        const newDefaultValueNode = doc.createElement('DefaultValue');
+        newDefaultValueNode.setAttribute('FieldName', fieldName);
+        newDefaultValueNode.textContent = fieldValue;
+        const folderLinks = doc.getElementsByTagName('a');
+        for (let i = 0; i < folderLinks.length; i++) {
+            const folderNode = folderLinks[i];
+            const folderNodeUrl = folderNode.getAttribute('href');
+            if (encodedFolderUrl !== folderNodeUrl) {
+                continue;
+            }
+            const defaultValues = folderNode.getElementsByTagName('DefaultValue');
+            for (let j = 0; j < defaultValues.length; j++) {
+                const defaultValueNode = defaultValues[j];
+                const defaultValueNodeField = defaultValueNode.getAttribute('FieldName');
+                if (defaultValueNodeField !== fieldName) {
+                    continue;
+                }
+                // Default value node found, let's update the value
+                defaultValueNode.textContent = fieldValue;
+                return doc.toString();
+            }
+            // Default value node not found, let's create it
+            folderNode.appendChild(newDefaultValueNode);
+            return doc.toString();
+        }
+        // Folder node was not found, let's create it
+        const newFolderNode = doc.createElement('a');
+        newFolderNode.setAttribute('href', encodedFolderUrl);
+        newFolderNode.appendChild(newDefaultValueNode);
+        doc.documentElement.appendChild(newFolderNode);
+        return doc.toString();
+    }
+    async uploadDefaultColumnValuesXml(logger, webUrl, listServerRelUrl, xml) {
+        if (this.verbose) {
+            await logger.logToStderr(`Uploading default column values to list...`);
+        }
+        const requestOptions = {
+            url: `${webUrl}/_api/Web/GetFileByServerRelativePath(decodedUrl='${formatting.encodeQueryParameter(listServerRelUrl + '/Forms/client_LocationBasedDefaults.html')}')/$value`,
+            headers: {
+                accept: 'application/json;odata=nometadata',
+                'content-type': 'text/plain'
+            },
+            responseType: 'json',
+            data: xml
+        };
+        await request.put(requestOptions);
+    }
+}
+export default new SpoListDefaultValueSetCommand();
+//# sourceMappingURL=list-defaultvalue-set.js.map

package/dist/m365/spo/commands/listitem/listitem-roleassignment-add.js

@@ -6,6 +6,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _SpoListItemRoleAssignmentAddCommand_instances, _SpoListItemRoleAssignmentAddCommand_initTelemetry, _SpoListItemRoleAssignmentAddCommand_initOptions, _SpoListItemRoleAssignmentAddCommand_initValidators;
 import { cli } from '../../../../cli/cli.js';
 import request from '../../../../request.js';
+import { entraGroup } from '../../../../utils/entraGroup.js';
 import { formatting } from '../../../../utils/formatting.js';
 import { urlUtil } from '../../../../utils/urlUtil.js';
 import { validation } from '../../../../utils/validation.js';
@@ -14,6 +15,7 @@ import commands from '../../commands.js';
 import spoGroupGetCommand from '../group/group-get.js';
 import spoRoleDefinitionListCommand from '../roledefinition/roledefinition-list.js';
 import spoUserGetCommand from '../user/user-get.js';
+import { spo } from '../../../../utils/spo.js';
 class SpoListItemRoleAssignmentAddCommand extends SpoCommand {
     get name() {
         return commands.LISTITEM_ROLEASSIGNMENT_ADD;
@@ -46,7 +48,7 @@ class SpoListItemRoleAssignmentAddCommand extends SpoCommand {
             }
             requestUrl += `items(${args.options.listItemId})/`;
             const roleDefinitionId = await this.getRoleDefinitionId(args.options);
-            let principalId = 0;
+            let principalId = args.options.principalId;
             if (args.options.upn) {
                 principalId = await this.getUserPrincipalId(args.options);
                 await this.addRoleAssignment(requestUrl, roleDefinitionId, principalId);
@@ -55,10 +57,17 @@ class SpoListItemRoleAssignmentAddCommand extends SpoCommand {
                 principalId = await this.getGroupPrincipalId(args.options);
                 await this.addRoleAssignment(requestUrl, roleDefinitionId, principalId);
             }
-            else {
-                principalId = args.options.principalId;
-                await this.addRoleAssignment(requestUrl, roleDefinitionId, principalId);
+            else if (args.options.entraGroupId || args.options.entraGroupName) {
+                if (this.verbose) {
+                    await logger.logToStderr('Retrieving group information...');
+                }
+                const group = args.options.entraGroupId
+                    ? await entraGroup.getGroupById(args.options.entraGroupId)
+                    : await entraGroup.getGroupByDisplayName(args.options.entraGroupName);
+                const siteUser = await spo.ensureEntraGroup(args.options.webUrl, group);
+                principalId = siteUser.Id;
             }
+            await this.addRoleAssignment(requestUrl, roleDefinitionId, principalId);
         }
         catch (err) {
             this.handleRejectedODataJsonPromise(err);
@@ -126,6 +135,8 @@ _SpoListItemRoleAssignmentAddCommand_instances = new WeakSet(), _SpoListItemRole
             principalId: typeof args.options.principalId !== 'undefined',
             upn: typeof args.options.upn !== 'undefined',
             groupName: typeof args.options.groupName !== 'undefined',
+            entraGroupId: typeof args.options.entraGroupId !== 'undefined',
+            entraGroupName: typeof args.options.entraGroupName !== 'undefined',
             roleDefinitionId: typeof args.options.roleDefinitionId !== 'undefined',
             roleDefinitionName: typeof args.options.roleDefinitionName !== 'undefined'
         });
@@ -147,6 +158,10 @@ _SpoListItemRoleAssignmentAddCommand_instances = new WeakSet(), _SpoListItemRole
         option: '--upn [upn]'
     }, {
         option: '--groupName [groupName]'
+    }, {
+        option: '--entraGroupId [entraGroupId]'
+    }, {
+        option: '--entraGroupName [entraGroupName]'
     }, {
         option: '--roleDefinitionId [roleDefinitionId]'
     }, {
@@ -177,12 +192,15 @@ _SpoListItemRoleAssignmentAddCommand_instances = new WeakSet(), _SpoListItemRole
         if (listOptions.filter(item => item !== undefined).length === 0) {
             return `Specify at least list id or title or list url`;
         }
-        const principalOptions = [args.options.principalId, args.options.upn, args.options.groupName];
+        const principalOptions = [args.options.principalId, args.options.upn, args.options.groupName, args.options.entraGroupId, args.options.entraGroupName];
         if (!principalOptions.some(item => item !== undefined)) {
-            return `Specify either principalId, upn or groupName`;
+            return `Specify either principalId, upn, groupName, entraGroupId or entraGroupName`;
         }
         if (principalOptions.filter(item => item !== undefined).length > 1) {
-            return `Specify either principalId, upn or groupName but not multiple`;
+            return `Specify either principalId, upn, groupName, entraGroupId or entraGroupName but not multiple`;
+        }
+        if (args.options.entraGroupId && !validation.isValidGuid(args.options.entraGroupId)) {
+            return `'${args.options.entraGroupId}' is not a valid GUID for option entraGroupId.`;
         }
         const roleDefinitionOptions = [args.options.roleDefinitionId, args.options.roleDefinitionName];
         if (!roleDefinitionOptions.some(item => item !== undefined)) {

package/dist/m365/spo/commands/listitem/listitem-roleassignment-remove.js

@@ -13,6 +13,8 @@ import SpoCommand from '../../../base/SpoCommand.js';
 import commands from '../../commands.js';
 import spoGroupGetCommand from '../group/group-get.js';
 import spoUserGetCommand from '../user/user-get.js';
+import { entraGroup } from '../../../../utils/entraGroup.js';
+import { spo } from '../../../../utils/spo.js';
 class SpoListItemRoleAssignmentRemoveCommand extends SpoCommand {
     get name() {
         return commands.LISTITEM_ROLEASSIGNMENT_REMOVE;
@@ -58,15 +60,21 @@ class SpoListItemRoleAssignmentRemoveCommand extends SpoCommand {
             requestUrl += `items(${options.listItemId})/`;
             if (options.upn) {
                 options.principalId = await this.getUserPrincipalId(options);
-                await this.removeRoleAssignmentWithRequestUrl(requestUrl, logger, options);
             }
             else if (options.groupName) {
                 options.principalId = await this.getGroupPrincipalId(options);
-                await this.removeRoleAssignmentWithRequestUrl(requestUrl, logger, options);
             }
-            else {
-                await this.removeRoleAssignmentWithRequestUrl(requestUrl, logger, options);
+            else if (options.entraGroupId || options.entraGroupName) {
+                if (this.verbose) {
+                    await logger.logToStderr('Retrieving group information...');
+                }
+                const group = options.entraGroupId
+                    ? await entraGroup.getGroupById(options.entraGroupId)
+                    : await entraGroup.getGroupByDisplayName(options.entraGroupName);
+                const siteUser = await spo.ensureEntraGroup(options.webUrl, group);
+                options.principalId = siteUser.Id;
             }
+            await this.removeRoleAssignmentWithRequestUrl(requestUrl, logger, options);
         }
         catch (err) {
             this.handleRejectedODataJsonPromise(err);
@@ -119,6 +127,8 @@ _SpoListItemRoleAssignmentRemoveCommand_instances = new WeakSet(), _SpoListItemR
             principalId: typeof args.options.principalId !== 'undefined',
             upn: typeof args.options.upn !== 'undefined',
             groupName: typeof args.options.groupName !== 'undefined',
+            entraGroupId: typeof args.options.entraGroupId !== 'undefined',
+            entraGroupName: typeof args.options.entraGroupName !== 'undefined',
             force: (!(!args.options.force)).toString()
         });
     });
@@ -139,6 +149,10 @@ _SpoListItemRoleAssignmentRemoveCommand_instances = new WeakSet(), _SpoListItemR
         option: '--upn [upn]'
     }, {
         option: '--groupName [groupName]'
+    }, {
+        option: '--entraGroupId [entraGroupId]'
+    }, {
+        option: '--entraGroupName [entraGroupName]'
     }, {
         option: '-f, --force'
     });
@@ -157,10 +171,13 @@ _SpoListItemRoleAssignmentRemoveCommand_instances = new WeakSet(), _SpoListItemR
         if (args.options.principalId && isNaN(args.options.principalId)) {
             return `Specified principalId ${args.options.principalId} is not a number`;
         }
+        if (args.options.entraGroupId && !validation.isValidGuid(args.options.entraGroupId)) {
+            return `'${args.options.entraGroupId}' is not a valid GUID for option entraGroupId.`;
+        }
         return true;
     });
 }, _SpoListItemRoleAssignmentRemoveCommand_initOptionSets = function _SpoListItemRoleAssignmentRemoveCommand_initOptionSets() {
-    this.optionSets.push({ options: ['listId', 'listTitle', 'listUrl'] }, { options: ['principalId', 'upn', 'groupName'] });
+    this.optionSets.push({ options: ['listId', 'listTitle', 'listUrl'] }, { options: ['principalId', 'upn', 'groupName', 'entraGroupId', 'entraGroupName'] });
 };
 export default new SpoListItemRoleAssignmentRemoveCommand();
 //# sourceMappingURL=listitem-roleassignment-remove.js.map

package/dist/m365/spo/commands/web/web-roleassignment-add.js

@@ -12,6 +12,8 @@ import commands from '../../commands.js';
 import spoGroupGetCommand from '../group/group-get.js';
 import spoRoleDefinitionListCommand from '../roledefinition/roledefinition-list.js';
 import spoUserGetCommand from '../user/user-get.js';
+import { entraGroup } from '../../../../utils/entraGroup.js';
+import { spo } from '../../../../utils/spo.js';
 class SpoWebRoleAssignmentAddCommand extends SpoCommand {
     get name() {
         return commands.WEB_ROLEASSIGNMENT_ADD;
@@ -35,15 +37,21 @@ class SpoWebRoleAssignmentAddCommand extends SpoCommand {
             args.options.roleDefinitionId = await this.getRoleDefinitionId(args.options);
             if (args.options.upn) {
                 args.options.principalId = await this.getUserPrincipalId(args.options);
-                await this.addRoleAssignment(logger, args.options);
             }
             else if (args.options.groupName) {
                 args.options.principalId = await this.getGroupPrincipalId(args.options);
-                await this.addRoleAssignment(logger, args.options);
             }
-            else {
-                await this.addRoleAssignment(logger, args.options);
+            else if (args.options.entraGroupId || args.options.entraGroupName) {
+                if (this.verbose) {
+                    await logger.logToStderr('Retrieving group information...');
+                }
+                const group = args.options.entraGroupId
+                    ? await entraGroup.getGroupById(args.options.entraGroupId)
+                    : await entraGroup.getGroupByDisplayName(args.options.entraGroupName);
+                const siteUser = await spo.ensureEntraGroup(args.options.webUrl, group);
+                args.options.principalId = siteUser.Id;
             }
+            await this.addRoleAssignment(logger, args.options);
         }
         catch (err) {
             this.handleRejectedODataJsonPromise(err);
@@ -108,6 +116,8 @@ _SpoWebRoleAssignmentAddCommand_instances = new WeakSet(), _SpoWebRoleAssignment
             principalId: typeof args.options.principalId !== 'undefined',
             upn: typeof args.options.upn !== 'undefined',
             groupName: typeof args.options.groupName !== 'undefined',
+            entraGroupId: typeof args.options.entraGroupId !== 'undefined',
+            entraGroupName: typeof args.options.entraGroupName !== 'undefined',
             roleDefinitionId: typeof args.options.roleDefinitionId !== 'undefined',
             roleDefinitionName: typeof args.options.roleDefinitionName !== 'undefined'
         });
@@ -121,6 +131,10 @@ _SpoWebRoleAssignmentAddCommand_instances = new WeakSet(), _SpoWebRoleAssignment
         option: '--upn [upn]'
     }, {
         option: '--groupName [groupName]'
+    }, {
+        option: '--entraGroupId [entraGroupId]'
+    }, {
+        option: '--entraGroupName [entraGroupName]'
     }, {
         option: '--roleDefinitionId [roleDefinitionId]'
     }, {
@@ -138,10 +152,13 @@ _SpoWebRoleAssignmentAddCommand_instances = new WeakSet(), _SpoWebRoleAssignment
         if (args.options.roleDefinitionId && isNaN(args.options.roleDefinitionId)) {
             return `Specified roleDefinitionId ${args.options.roleDefinitionId} is not a number`;
         }
+        if (args.options.entraGroupId && !validation.isValidGuid(args.options.entraGroupId)) {
+            return `'${args.options.entraGroupId}' is not a valid GUID for option entraGroupId.`;
+        }
         return true;
     });
 }, _SpoWebRoleAssignmentAddCommand_initOptionSets = function _SpoWebRoleAssignmentAddCommand_initOptionSets() {
-    this.optionSets.push({ options: ['principalId', 'upn', 'groupName'] }, { options: ['roleDefinitionId', 'roleDefinitionName'] });
+    this.optionSets.push({ options: ['principalId', 'upn', 'groupName', 'entraGroupId', 'entraGroupName'] }, { options: ['roleDefinitionId', 'roleDefinitionName'] });
 };
 export default new SpoWebRoleAssignmentAddCommand();
 //# sourceMappingURL=web-roleassignment-add.js.map