@pnp/cli-microsoft365 10.3.1 → 10.4.0-beta.1d1e5a7

package/dist/m365/spo/commands/page/clientsidepages.js

@@ -271,6 +271,12 @@ export class ClientSidePage {
         for (let i = 0; i < this.sections.length; i++) {
             html.push(this.sections[i].toHtml());
         }
+        if (this.pageSettings) {
+            html.push(this.pageSettings.toHtml());
+        }
+        if (this.backgroundSettings) {
+            html.push(this.backgroundSettings.toHtml());
+        }
         html.push("</div>");
         return html.join("");
     }
@@ -286,17 +292,23 @@ export class ClientSidePage {
         // gather our controls from the supplied html
         getBoundedDivMarkup(html, /<div\b[^>]*data-sp-canvascontrol[^>]*?>/i, markup => {
             // get the control type
-            const ct = /controlType&quot;&#58;(\d*?),/i.exec(markup);
+            const ct = /controlType&quot;&#58;(\d*?)(,|&)/i.exec(markup);
             // if no control type is present this is a column which we give type 0 to let us process it
-            const controlType = ct == null || ct.length < 2 ? 0 : parseInt(ct[1], 10);
+            const controlType = ct == null || ct.length < 0 ? -1 : parseInt(ct[1], 10);
             let control = null;
             switch (controlType) {
-                case 0:
+                case -1:
                     // empty canvas column
                     control = new CanvasColumn(null, 0);
                     control.fromHtml(markup);
                     page.mergeColumnToTree(control);
                     break;
+                case 0:
+                    // page settings
+                    control = new PageSettings();
+                    control.fromHtml(markup);
+                    page.pageSettings = control;
+                    break;
                 case 3:
                     // client side webpart
                     control = new ClientSideWebpart("");
@@ -309,6 +321,12 @@ export class ClientSidePage {
                     control.fromHtml(markup);
                     page.mergePartToTree(control);
                     break;
+                case 14:
+                    // backgroundSection
+                    control = new BackgroundSettings();
+                    control.fromHtml(markup);
+                    page.backgroundSettings = control;
+                    break;
             }
         });
         // refresh all the orders within the tree
@@ -364,7 +382,7 @@ export class ClientSidePage {
         }
         const sections = this.sections.filter(s => s.order === zoneIndex);
         if (sections.length < 1) {
-            section = new CanvasSection(this, zoneIndex);
+            section = new CanvasSection(this, zoneIndex, [], control?.controlData?.position.zoneId, control.controlData?.zoneGroupMetadata);
             this.sections.push(section);
         }
         else {
@@ -392,7 +410,7 @@ export class ClientSidePage {
         let section = null;
         const sections = this.sections.filter(s => s.order === order);
         if (sections.length < 1) {
-            section = new CanvasSection(this, order);
+            section = new CanvasSection(this, order, [], column.controlData?.position?.zoneId, column.controlData?.zoneGroupMetadata);
             this.sections.push(section);
         }
         else {
@@ -403,10 +421,12 @@ export class ClientSidePage {
     }
 }
 export class CanvasSection {
-    constructor(page, order, columns = []) {
+    constructor(page, order, columns = [], zoneId, zoneGroupMetadata) {
         this.page = page;
         this.order = order;
         this.columns = columns;
+        this.zoneId = zoneId;
+        this.zoneGroupMetadata = zoneGroupMetadata;
     }
     /**
      * Default column (this.columns[0]) for this section
@@ -457,6 +477,20 @@ class CanvasControl {
         this.id = this.controlData.id;
     }
 }
+export class PageSettings extends CanvasControl {
+    constructor() {
+        super(0, "1.0");
+    }
+    getControlData() {
+        return this.controlData;
+    }
+    toHtml() {
+        return `<div data-sp-canvascontrol="" data-sp-canvasdataversion="${this.dataVersion}" data-sp-controldata="${this.jsonData}"></div>`;
+    }
+    fromHtml(html) {
+        super.fromHtml(html);
+    }
+}
 export class CanvasColumn extends CanvasControl {
     constructor(section, order, factor = 12, controls = [], dataVersion = "1.0") {
         super(0, dataVersion);
@@ -513,8 +547,10 @@ export class CanvasColumn extends CanvasControl {
             position: {
                 sectionFactor: this.factor,
                 sectionIndex: this.order,
-                zoneIndex: this.section ? this.section.order : 0
+                zoneIndex: this.section ? this.section.order : 0,
+                zoneId: this.section?.zoneId
             },
+            zoneGroupMetadata: this.section?.zoneGroupMetadata,
         };
     }
     /**
@@ -543,6 +579,58 @@ export class ClientSidePart extends CanvasControl {
         }
     }
 }
+export class BackgroundSettings extends ClientSidePart {
+    constructor() {
+        super(0, "1.0");
+        this.propertieJson = {};
+        this.serverProcessedContent = null;
+    }
+    getControlData() {
+        return {
+            controlType: this.controlType
+        };
+    }
+    toHtml() {
+        // will form the value of the data-sp-webpartdata attribute
+        const data = {
+            dataVersion: this.dataVersion,
+            instanceId: this.id,
+            properties: this.propertieJson,
+            serverProcessedContent: this.serverProcessedContent,
+        };
+        const html = [];
+        html.push(`<div data-sp-canvascontrol="" data-sp-canvasdataversion="${this.dataVersion}" data-sp-controldata="${this.jsonData}">`);
+        html.push(`<div data-sp-webpart="" data-sp-webpartdataversion="${this.dataVersion}" data-sp-webpartdata="${ClientSidePage.jsonToEscapedString(data)}">`);
+        html.push(`<div data-sp-componentid="">`);
+        html.push("</div>");
+        html.push(`<div data-sp-htmlproperties="">`);
+        for (let imageSource in this.serverProcessedContent?.imageSources) {
+            html.push(`<img data-sp-prop-name="${imageSource}" src="${this.serverProcessedContent?.imageSources[imageSource]}" />`);
+        }
+        html.push("</div>");
+        html.push("</div>");
+        html.push("</div>");
+        return html.join("");
+    }
+    setProperties(properties) {
+        this.propertieJson = extend(this.propertieJson, properties);
+        return this;
+    }
+    fromHtml(html) {
+        super.fromHtml(html);
+        const webPartData = ClientSidePage.escapedStringToJson(getAttrValueFromString(html, "data-sp-webpartdata"));
+        this.setProperties(webPartData.properties);
+        if (typeof webPartData.serverProcessedContent !== "undefined") {
+            this.serverProcessedContent = webPartData.serverProcessedContent;
+        }
+        if (typeof webPartData.dynamicDataPaths !== "undefined") {
+            this.dynamicDataPaths = webPartData.dynamicDataPaths;
+        }
+        if (typeof webPartData.dynamicDataValues !== "undefined") {
+            this.dynamicDataValues = webPartData.dynamicDataValues;
+        }
+    }
+}
 export class ClientSideText extends ClientSidePart {
     constructor(text = "") {
         super(4, "1.0");
@@ -570,8 +658,10 @@ export class ClientSideText extends ClientSidePart {
                 controlIndex: this.order,
                 sectionFactor: this.column ? this.column.factor : 0,
                 sectionIndex: this.column ? this.column.order : 0,
-                zoneIndex: this.column && this.column.section ? this.column.section.order : 0
+                zoneIndex: this.column && this.column.section ? this.column.section.order : 0,
+                zoneId: this.column?.section?.zoneId
             },
+            zoneGroupMetadata: this.column?.section?.zoneGroupMetadata,
         };
     }
     toHtml(index) {
@@ -684,9 +774,11 @@ export class ClientSideWebpart extends ClientSidePart {
                 controlIndex: this.order,
                 sectionFactor: this.column ? this.column.factor : 0,
                 sectionIndex: this.column ? this.column.order : 0,
-                zoneIndex: this.column && this.column.section ? this.column.section.order : 0
+                zoneIndex: this.column && this.column.section ? this.column.section.order : 0,
+                zoneId: this.column?.section?.zoneId
             },
             webPartId: this.webPartId,
+            zoneGroupMetadata: this.column?.section?.zoneGroupMetadata,
         };
     }
     renderHtmlProperties() {

package/dist/m365/spo/commands/page/page-clientsidewebpart-add.js

@@ -132,7 +132,8 @@ class SpoPageClientSideWebPartAddCommand extends SpoCommand {
                 id: webPart.id,
                 position: Object.assign({}, control.position),
                 webPartId: webPart.webPartId,
-                emphasis: {}
+                emphasis: {},
+                zoneGroupMetadata: control.zoneGroupMetadata
             }, webPart);
             if (!control.controlType) {
                 // it's an empty column so we need to replace it with the web part

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/page/page-text-add.js

@@ -10,7 +10,7 @@ import { urlUtil } from '../../../../utils/urlUtil.js';
 import { validation } from '../../../../utils/validation.js';
 import SpoCommand from '../../../base/SpoCommand.js';
 import commands from '../../commands.js';
-import { ClientSideText } from './clientsidepages.js';
+import { CanvasSection, ClientSideText } from './clientsidepages.js';
 import { Page } from './Page.js';
 class SpoPageTextAddCommand extends SpoCommand {
     get name() {
@@ -46,6 +46,12 @@ class SpoPageTextAddCommand extends SpoCommand {
             const page = await Page.getPage(pageName, args.options.webUrl, logger, this.debug, this.verbose);
             const section = (args.options.section || 1) - 1;
             const column = (args.options.column || 1) - 1;
+            // Add a new section when page does not contain any sections
+            if (page.sections.length < 1) {
+                const newSection = new CanvasSection(page, 1);
+                newSection.defaultColumn;
+                page.sections.push(newSection);
+            }
             // Make sure the section is in range
             if (section >= page.sections.length) {
                 throw new Error(`Invalid section '${section + 1}'`);

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.js

@@ -15,6 +15,7 @@ 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`,

package/docs/docs/cmd/entra/group/group-member-add.mdx

@@ -14,10 +14,13 @@ m365 entra group member add [options]
 
 ```md definition-list
 `-i, --groupId [groupId]`
-: The ID of the Microsoft Entra group. Specify `groupId` or `groupDisplayName` but not both.
+: The ID of the Microsoft Entra group. Specify `groupId`, `groupDisplayName` or `groupName` but not multiple.
 
 `-n, --groupDisplayName [groupDisplayName]`
-: The display name of the Microsoft Entra group. Specify `groupId` or `groupDisplayName` but not both.
+: (deprecated. Use option `groupName` instead) The display name of the Microsoft Entra group. Specify `groupId`, `groupDisplayName` or `groupName` but not multiple.
+
+`--groupName [groupName]`
+: The display name of the Microsoft Entra group. Specify `groupId`, `groupDisplayName` or `groupName` but not multiple.
 
 `--ids [ids]`
 : Microsoft Entra IDs of users. You can also pass a comma-separated list of IDs. Specify either `ids` or `userNames` but not both.
@@ -39,6 +42,12 @@ Add a single member specified by ID as a member to a group specified by display
 m365 entra group member add --groupDisplayName Developers --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
 ```
 
+Add a single member specified by ID as a member to a group specified by group name.
+
+```sh
+m365 entra group member add --groupName Developers --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
+```
+
 Add multiple members specified by ID as members to a group specified by ID.
 
 ```sh
@@ -51,6 +60,12 @@ Add a single member specified by UPN as an owner to a group specified by display
 m365 entra group member add --groupDisplayName Developers --userNames john.doe@contoso.com --role Owner
 ```
 
+Add a single member specified by UPN as an owner to a group specified by group name.
+
+```sh
+m365 entra group member add --groupName Developers --userNames john.doe@contoso.com --role Owner
+```
+
 Adds multiple members specified by UPN as owners to a group specified by ID.
 
 ```sh

package/docs/docs/cmd/entra/group/group-member-set.mdx

@@ -14,10 +14,13 @@ m365 entra group member set [options]
 
 ```md definition-list
 `-i, --groupId [groupId]`
-: The ID of the Entra ID group. Specify `groupId` or `groupDisplayName` but not both.
+: The ID of the Entra ID group. Specify `groupId`, `groupDisplayName` or `groupName` but not multiple.
 
 `-n, --groupDisplayName [groupDisplayName]`
-: The display name of the Entra ID group. Specify `groupId` or `groupDisplayName` but not both.
+: (deprecated. Use option `groupName` instead) The display name of the Entra ID group. Specify `groupId`, `groupDisplayName` or `groupName` but not multiple.
+
+`--groupName [groupName]`
+: The display name of the Microsoft Entra group. Specify `groupId`, `groupDisplayName` or `groupName` but not multiple.
 
 `--ids [ids]`
 : Comma-separated list of user IDs. Specify either `ids` or `userNames` but not both.
@@ -39,6 +42,12 @@ Update a single member specified by ID to a member of a group specified by displ
 m365 entra group member set --groupDisplayName Developers --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
 ```
 
+Update a single member specified by ID to a member of a group specified by group name
+
+```sh
+m365 entra group member set --groupName Developers --ids 098b9f52-f48c-4401-819f-29c33794c3f5 --role Member
+```
+
 Update multiple members specified by ID to members of a group specified by ID
 
 ```sh
@@ -51,6 +60,12 @@ Update a single member specified by UPN to an owner of a group specified by disp
 m365 entra group member set --groupDisplayName Developers --userNames john.doe@contoso.com --role Owner
 ```
 
+Update a single member specified by UPN to an owner of a group specified by group name
+
+```sh
+m365 entra group member set --groupName Developers --userNames john.doe@contoso.com --role Owner
+```
+
 Update multiple members specified by UPN to owners of a group specified by ID
 
 ```sh

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/rolepermission/rolepermission-list.mdx

@@ -32,6 +32,8 @@ The command is based on an API that is currently in preview and is subject to ch
 
 :::
 
+Use the `m365 entra resourcenamespace list` command to get a list of available resource namespaces.
+
 ## Examples
 
 Get a list of role permissions

package/docs/docs/cmd/entra/user/user-session-revoke.mdx

@@ -0,0 +1,65 @@
+import Global from '/docs/cmd/_global.mdx';
+
+# entra user session revoke
+
+Revokes all sign-in sessions for a given user
+
+## Usage
+
+```sh
+m365 entra user session revoke [options]
+```
+
+## Options
+```md definition-list
+`-i, --userId [userId]`
+: The id of the user. Specify either `userId` or `userName`, but not both.
+
+`-n, --userName [userName]`
+: The user principal name of the user. Specify either `userId` or `userName`, but not both.
+
+`-f, --force`
+: Don't prompt for confirmation.
+```
+
+<Global />
+
+## Remarks
+
+:::info
+
+To use this command you must be either **User Administrator** or **Global Administrator**.
+
+:::
+
+:::note
+
+There might be a small delay of a few minutes before tokens are revoked.
+
+This API doesn't revoke sign-in sessions for external users, because external users sign in through their home tenant.
+
+:::
+
+## Examples
+
+Revoke sign-in sessions of a user specified by id
+
+```sh
+m365 entra user session revoke --userId 4fb72b9b-d0b0-4a35-8bc1-83f9a6488c48
+```
+
+Revoke sign-in sessions of a user specified by its UPN
+
+```sh
+m365 entra user session revoke --userName john.doe@contoso.onmicrosoft.com
+```
+
+Revoke sign-in sessions of a user specified by its UPN without prompting for confirmation
+
+```sh
+m365 entra user session revoke --userName john.doe@contoso.onmicrosoft.com --force
+```
+
+## Response
+
+The command won't return a response on success.