@pnp/cli-microsoft365 10.3.0-beta.f5e6f85 → 10.4.0-beta.17b3a55

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/mail/mail-send.js

@@ -8,6 +8,7 @@ import request from '../../../../request.js';
 import { validation } from '../../../../utils/validation.js';
 import SpoCommand from '../../../base/SpoCommand.js';
 import commands from '../../commands.js';
+import outlookCommands from '../../../outlook/commands.js';
 class SpoMailSendCommand extends SpoCommand {
     get name() {
         return commands.MAIL_SEND;
@@ -23,6 +24,7 @@ class SpoMailSendCommand extends SpoCommand {
         __classPrivateFieldGet(this, _SpoMailSendCommand_instances, "m", _SpoMailSendCommand_initValidators).call(this);
     }
     async commandAction(logger, args) {
+        await this.showDeprecationWarning(logger, commands.MAIL_SEND, outlookCommands.MAIL_SEND);
         const params = {
             properties: {
                 __metadata: { "type": "SP.Utilities.EmailProperties" },

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

@@ -1,15 +1,23 @@
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _SpoPageGetCommand_instances, _SpoPageGetCommand_initOptions, _SpoPageGetCommand_initValidators;
+import { z } from 'zod';
+import { zod } from '../../../../utils/zod.js';
+import { globalOptionsZod } from '../../../../Command.js';
 import request from '../../../../request.js';
 import { formatting } from '../../../../utils/formatting.js';
 import { urlUtil } from '../../../../utils/urlUtil.js';
 import { validation } from '../../../../utils/validation.js';
 import SpoCommand from '../../../base/SpoCommand.js';
 import commands from '../../commands.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.`
+    }))),
+    name: zod.alias('n', z.string()).optional(),
+    default: z.boolean().optional(),
+    metadataOnly: z.boolean().optional()
+})
+    .strict();
 class SpoPageGetCommand extends SpoCommand {
     get name() {
         return commands.PAGE_GET;
@@ -20,21 +28,37 @@ class SpoPageGetCommand extends SpoCommand {
     defaultProperties() {
         return ['commentsDisabled', 'numSections', 'numControls', 'title', 'layoutType'];
     }
-    constructor() {
-        super();
-        _SpoPageGetCommand_instances.add(this);
-        __classPrivateFieldGet(this, _SpoPageGetCommand_instances, "m", _SpoPageGetCommand_initOptions).call(this);
-        __classPrivateFieldGet(this, _SpoPageGetCommand_instances, "m", _SpoPageGetCommand_initValidators).call(this);
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => [options.name, options.default].filter(x => x !== undefined).length === 1, {
+            message: `Specify either name or default, but not both.`
+        });
     }
     async commandAction(logger, args) {
         if (this.verbose) {
             await logger.logToStderr(`Retrieving information about the page...`);
         }
-        let pageName = args.options.name;
-        if (args.options.name.indexOf('.aspx') < 0) {
-            pageName += '.aspx';
-        }
+        let pageName = '';
         try {
+            if (args.options.name) {
+                pageName = args.options.name.endsWith('.aspx')
+                    ? args.options.name
+                    : `${args.options.name}.aspx`;
+            }
+            else if (args.options.default) {
+                const requestOptions = {
+                    url: `${args.options.webUrl}/_api/Web/RootFolder?$select=WelcomePage`,
+                    headers: {
+                        accept: 'application/json;odata=nometadata'
+                    },
+                    responseType: 'json'
+                };
+                const { WelcomePage } = await request.get(requestOptions);
+                pageName = WelcomePage.split('/').pop();
+            }
             let requestOptions = {
                 url: `${args.options.webUrl}/_api/web/GetFileByServerRelativePath(DecodedUrl='${urlUtil.getServerRelativeSiteUrl(args.options.webUrl)}/SitePages/${formatting.encodeQueryParameter(pageName)}')?$expand=ListItemAllFields/ClientSideApplicationId,ListItemAllFields/PageLayoutType,ListItemAllFields/CommentsDisabled`,
                 headers: {
@@ -45,7 +69,7 @@ class SpoPageGetCommand extends SpoCommand {
             };
             const page = await request.get(requestOptions);
             if (page.ListItemAllFields.ClientSideApplicationId !== 'b6917cb1-93a0-4b97-a84d-7cf49975d4ec') {
-                throw `Page ${args.options.name} is not a modern page.`;
+                throw `Page ${pageName} is not a modern page.`;
             }
             let pageItemData = {};
             pageItemData = Object.assign({}, page);
@@ -80,16 +104,5 @@ class SpoPageGetCommand extends SpoCommand {
         }
     }
 }
-_SpoPageGetCommand_instances = new WeakSet(), _SpoPageGetCommand_initOptions = function _SpoPageGetCommand_initOptions() {
-    this.options.unshift({
-        option: '-n, --name <name>'
-    }, {
-        option: '-u, --webUrl <webUrl>'
-    }, {
-        option: '--metadataOnly'
-    });
-}, _SpoPageGetCommand_initValidators = function _SpoPageGetCommand_initValidators() {
-    this.validators.push(async (args) => validation.isValidSharePointUrl(args.options.webUrl));
-};
 export default new SpoPageGetCommand();
 //# sourceMappingURL=page-get.js.map

package/dist/m365/spo/commands.js

@@ -137,7 +137,10 @@ export default {
     LIST_CONTENTTYPE_LIST: `${prefix} list contenttype list`,
     LIST_CONTENTTYPE_REMOVE: `${prefix} list contenttype remove`,
     LIST_CONTENTTYPE_DEFAULT_SET: `${prefix} list contenttype default set`,
+    LIST_DEFAULTVALUE_CLEAR: `${prefix} list defaultvalue clear`,
     LIST_DEFAULTVALUE_LIST: `${prefix} list defaultvalue list`,
+    LIST_DEFAULTVALUE_REMOVE: `${prefix} list defaultvalue remove`,
+    LIST_DEFAULTVALUE_SET: `${prefix} list defaultvalue set`,
     LIST_GET: `${prefix} list get`,
     LIST_LIST: `${prefix} list list`,
     LIST_REMOVE: `${prefix} list remove`,

package/dist/m365/tenant/commands/report/report-settings-get.js

@@ -0,0 +1,32 @@
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+import request from '../../../../request.js';
+class TenantReportSettingsGetCommand extends GraphCommand {
+    get name() {
+        return commands.REPORT_SETTINGS_GET;
+    }
+    get description() {
+        return 'Get the tenant-level settings for Microsoft 365 reports';
+    }
+    async commandAction(logger) {
+        if (this.verbose) {
+            await logger.logToStderr('Getting tenant-level settings for Microsoft 365 reports...');
+        }
+        const requestOptions = {
+            url: `${this.resource}/v1.0/admin/reportSettings`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        try {
+            const res = await request.get(requestOptions);
+            await logger.log(res);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+}
+export default new TenantReportSettingsGetCommand();
+//# sourceMappingURL=report-settings-get.js.map

package/dist/m365/tenant/commands/report/report-settings-set.js

@@ -0,0 +1,47 @@
+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 { zod } from '../../../../utils/zod.js';
+const options = globalOptionsZod
+    .extend({
+    displayConcealedNames: zod.alias('d', z.boolean())
+})
+    .strict();
+class TenantReportSettingsSetCommand extends GraphCommand {
+    get name() {
+        return commands.REPORT_SETTINGS_SET;
+    }
+    get description() {
+        return 'Update tenant-level settings for Microsoft 365 reports';
+    }
+    get schema() {
+        return options;
+    }
+    async commandAction(logger, args) {
+        try {
+            const { displayConcealedNames } = args.options;
+            if (this.verbose) {
+                await logger.logToStderr(`Updating report setting displayConcealedNames to ${displayConcealedNames}`);
+            }
+            const requestOptions = {
+                url: `${this.resource}/v1.0/admin/reportSettings`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none',
+                    'content-type': 'application/json'
+                },
+                responseType: 'json',
+                data: {
+                    displayConcealedNames
+                }
+            };
+            await request.patch(requestOptions);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+}
+export default new TenantReportSettingsSetCommand();
+//# sourceMappingURL=report-settings-set.js.map

package/dist/m365/tenant/commands.js

@@ -15,6 +15,8 @@ export default {
     REPORT_OFFICE365ACTIVATIONSUSERDETAIL: `${prefix} report office365activationsuserdetail`,
     REPORT_OFFICE365ACTIVATIONSUSERCOUNTS: `${prefix} report office365activationsusercounts`,
     REPORT_SERVICESUSERCOUNTS: `${prefix} report servicesusercounts`,
+    REPORT_SETTINGS_GET: `${prefix} report settings get`,
+    REPORT_SETTINGS_SET: `${prefix} report settings set`,
     SECURITY_ALERTS_LIST: `${prefix} security alerts list`,
     SERVICEANNOUNCEMENT_HEALTHISSUE_GET: `${prefix} serviceannouncement healthissue get`,
     SERVICEANNOUNCEMENT_HEALTH_GET: `${prefix} serviceannouncement health get`,

package/docs/docs/cmd/entra/app/app-add.mdx

@@ -31,7 +31,7 @@ m365 entra appregistration add [options]
 : Comma-separated list of redirect URIs. Requires `platform` to be specified.
 
 `-p, --platform [platform]`
-: Platform for which the `redirectUris` should be configured. Allowed values `spa`, `web`, `publicClient`.
+: Platform for which the `redirectUris` should be configured. Allowed values `spa`, `web`, `publicClient`. Requires `redirectUris` to be specified.
 
 `--implicitFlow`
 : Specify, to indicate that the authorization endpoint should return ID and access tokens.

package/docs/docs/cmd/entra/resourcenamespace/resourcenamespace-list.mdx

@@ -0,0 +1,96 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# entra resourcenamespace list
+
+Get a list of the RBAC resource namespaces and their properties
+
+## Usage
+
+```sh
+m365 entra resourcenamespace list [options]
+```
+
+## Options
+
+<Global />
+
+## Remarks
+
+:::warning
+
+The command is based on an API that is currently in preview and is subject to change once the API reached general availability.
+
+:::
+
+## Examples
+
+Retrieve all resource namespaces.
+
+```sh
+m365 entra resourcenamespace list
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  [
+    {
+      "id": "microsoft.directory",
+      "name": "microsoft.directory"
+    },
+    {
+      "id": "microsoft.aad.b2c",
+      "name": "microsoft.aad.b2c"
+    }
+  ]
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  id                     name
+  --------------------   --------------------
+  microsoft.directory    microsoft.directory
+  microsoft.aad.b2c      microsoft.aad.b2c
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,name
+  microsoft.directory,microsoft.directory
+  microsoft.aad.b2c,microsoft.aad.b2c
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # entra resourcenamespace list
+
+  Date: 1/31/2025
+
+  ## microsoft.directory (microsoft.directory)
+
+  Property | Value
+  ---------|-------
+  id | microsoft.directory
+  name | microsoft.directory
+
+  ## microsoft.aad.b2c (microsoft.aad.b2c)
+
+  Property | Value
+  ---------|-------
+  id | microsoft.aad.b2c
+  name | microsoft.aad.b2c
+  ```
+  
+  </TabItem>
+</Tabs>

package/docs/docs/cmd/entra/roledefinition/roledefinition-add.mdx

@@ -33,6 +33,10 @@ m365 entra roledefinition add [options]
 
 <Global />
 
+## Remarks
+
+Use the `m365 entra rolepermission list --resourceNamespace microsoft.directory` command to get a list of available resource actions.
+
 ## Examples
 
 Create a custom Microsoft Entra ID role

package/docs/docs/cmd/entra/roledefinition/roledefinition-set.mdx

@@ -37,6 +37,10 @@ m365 entra roledefinition set [options]
 
 <Global />
 
+## Remarks
+
+Use the `m365 entra rolepermission list --resourceNamespace microsoft.directory` command to get a list of available resource actions.
+
 ## Examples
 
 Update a custom Microsoft Entra ID role specified by the id