@pnp/cli-microsoft365 11.3.0-beta.b2b02ae → 11.3.0

package/dist/m365/spfx/commands/project/project-upgrade.js

@@ -2,7 +2,7 @@ import fs from 'fs';
 import os from 'os';
 import path from 'path';
 // uncomment to support upgrading to preview releases
-import { prerelease } from 'semver';
+// import { prerelease } from 'semver';
 import { z } from 'zod';
 import { CommandError, globalOptionsZod } from '../../../../Command.js';
 import { fsUtil } from '../../../../utils/fsUtil.js';
@@ -85,7 +85,8 @@ class SpfxProjectUpgradeCommand extends BaseProjectCommand {
             '1.20.0',
             '1.21.0',
             '1.21.1',
-            '1.22.0-rc.0'
+            '1.22.0',
+            '1.22.1'
         ];
     }
     async commandAction(logger, args) {
@@ -95,15 +96,15 @@ class SpfxProjectUpgradeCommand extends BaseProjectCommand {
         }
         this.toVersion = args.options.toVersion ? args.options.toVersion : this.supportedVersions[this.supportedVersions.length - 1];
         // uncomment to support upgrading to preview releases
-        if (!args.options.toVersion &&
-            !args.options.preview &&
-            prerelease(this.toVersion)) {
-            // no version and no preview specified while the current version to
-            // upgrade to is a prerelease so let's grab the first non-preview version
-            // since we're supporting only one preview version, it's sufficient for
-            // us to take second to last version
-            this.toVersion = this.supportedVersions[this.supportedVersions.length - 2];
-        }
+        // if (!args.options.toVersion &&
+        //   !args.options.preview &&
+        //   prerelease(this.toVersion)) {
+        //   // no version and no preview specified while the current version to
+        //   // upgrade to is a prerelease so let's grab the first non-preview version
+        //   // since we're supporting only one preview version, it's sufficient for
+        //   // us to take second to last version
+        //   this.toVersion = this.supportedVersions[this.supportedVersions.length - 2];
+        // }
         this.packageManager = args.options.packageManager || 'npm';
         this.shell = args.options.shell || 'powershell';
         if (this.supportedVersions.indexOf(this.toVersion) < 0) {

package/dist/m365/spfx/commands/spfx-doctor.js

@@ -621,7 +621,26 @@ class SpfxDoctorCommand extends BaseProjectCommand {
                     fix: 'npm i -g yo@5'
                 }
             },
-            '1.22.0-rc.0': {
+            '1.22.0': {
+                heft: {
+                    range: '^1',
+                    fix: 'npm i -g @rushstack/heft@1'
+                },
+                node: {
+                    range: '>=22.14.0 < 23.0.0',
+                    fix: 'Install Node.js >=22.14.0 < 23.0.0'
+                },
+                sp: SharePointVersion.SPO,
+                yo: {
+                    range: '^4 || ^5 || ^6',
+                    fix: 'npm i -g yo@6'
+                }
+            },
+            '1.22.1': {
+                heft: {
+                    range: '^1',
+                    fix: 'npm i -g @rushstack/heft@1'
+                },
                 node: {
                     range: '>=22.14.0 < 23.0.0',
                     fix: 'Install Node.js >=22.14.0 < 23.0.0'
@@ -702,6 +721,7 @@ class SpfxDoctorCommand extends BaseProjectCommand {
             await this.checkYo(prerequisites);
             await this.checkGulp();
             await this.checkGulpCli(prerequisites);
+            await this.checkHeft(prerequisites);
             await this.checkTypeScript();
             if (this.resultsObject.some(y => y.fix !== undefined)) {
                 await this.logMessage('Recommended fixes:');
@@ -831,6 +851,26 @@ class SpfxDoctorCommand extends BaseProjectCommand {
             await this.logMessage(formatting.getStatus(CheckStatus.Failure, message));
         }
     }
+    async checkHeft(prerequisites) {
+        if (!prerequisites.heft) {
+            // heft is not required for this version of SPFx
+            return;
+        }
+        const heftVersion = await this.getPackageVersion('@rushstack/heft', PackageSearchMode.GlobalOnly, HandlePromise.Continue);
+        if (heftVersion) {
+            await this.checkStatus('@rushstack/heft', heftVersion, prerequisites.heft);
+        }
+        else {
+            const message = '@rushstack/heft not found';
+            this.resultsObject.push({
+                check: '@rushstack/heft',
+                passed: false,
+                message: message,
+                fix: prerequisites.heft.fix
+            });
+            await this.logMessage(formatting.getStatus(CheckStatus.Failure, message));
+        }
+    }
     async checkGulp() {
         const gulpVersion = await this.getPackageVersion('gulp', PackageSearchMode.GlobalOnly, HandlePromise.Continue);
         if (gulpVersion) {

package/dist/utils/stringUtil.js

@@ -0,0 +1,4 @@
+export const stringUtil = {
+    normalizeLineEndings: (str) => str?.replace(/\r\n/g, '\n')
+};
+//# sourceMappingURL=stringUtil.js.map

package/docs/docs/cmd/login.mdx

@@ -118,54 +118,72 @@ Log in to Microsoft 365 using your own Microsoft Entra application and a persona
 m365 login --authType certificate --appId 31359c7f-bd7e-475c-86db-fdb8c937548c --tenant 31359c7f-bd7e-475c-86db-fdb8c937548a --certificateFile /Users/user/dev/localhost.pfx --password 'pass@word1'
 ```
 
-Log in to Microsoft 365 using a user name and password with `clientId` set in the configuration.
+Log in to Microsoft 365 using a user name and password by providing the application and tenant identifiers explicitly.
 
 ```sh
-m365 login --authType password --userName user@contoso.com --password pass@word1
+m365 login --authType password --appId 31359c7f-bd7e-475c-86db-fdb8c937548c --tenant 31359c7f-bd7e-475c-86db-fdb8c937548a --userName user@contoso.com --password pass@word1
 ```
 
-Log in to Microsoft 365 using a PEM certificate with `clientId` set in the configuration.
+Log in to Microsoft 365 using a PEM certificate with `CLIMICROSOFT365_ENTRAAPPID` and `CLIMICROSOFT365_TENANT` environment variables set.
 
 ```sh
 m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pem
 ```
 
-Log in to Microsoft 365 using a PEM certificate with `clientId` set in the configuration. Use the specified thumbprint.
+Log in to Microsoft 365 using a PEM certificate and a specific thumbprint with `CLIMICROSOFT365_ENTRAAPPID` and `CLIMICROSOFT365_TENANT` environment variables set.
 
 ```sh
-m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pem  --thumbprint 47C4885736C624E90491F32B98855AA8A7562AF1
+m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pem --thumbprint 47C4885736C624E90491F32B98855AA8A7562AF1
 ```
 
-Log in to Microsoft 365 using a personal information exchange (.pfx) file with `CLIMICROSOFT365_ENTRAAPPID` environment variable set.
+Log in to Microsoft 365 using a PEM certificate by providing the application and tenant identifiers explicitly.
+
+```sh
+m365 login --authType certificate --appId 31359c7f-bd7e-475c-86db-fdb8c937548c --tenant 31359c7f-bd7e-475c-86db-fdb8c937548a --certificateFile /Users/user/dev/localhost.pem
+```
+
+Log in to Microsoft 365 using a personal information exchange (.pfx) file with `CLIMICROSOFT365_ENTRAAPPID` and `CLIMICROSOFT365_TENANT` environment variables set.
 
 ```sh
 m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pfx --password 'pass@word1'
 ```
 
-Log in to Microsoft 365 using a personal information exchange (.pfx) file protected with an empty password and `CLIMICROSOFT365_ENTRAAPPID` environment variable set.
+Log in to Microsoft 365 using a personal information exchange (.pfx) file protected with an empty password with `CLIMICROSOFT365_ENTRAAPPID` and `CLIMICROSOFT365_TENANT` environment variables set.
 
 ```sh
 m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pfx --password
 ```
 
-Log in to Microsoft 365 using a personal information exchange (.pfx) file not protected with a password and `CLIMICROSOFT365_ENTRAAPPID` environment variable set.
+Log in to Microsoft 365 using a personal information exchange (.pfx) file not protected with a password with `CLIMICROSOFT365_ENTRAAPPID` and `CLIMICROSOFT365_TENANT` environment variables set.
 
 ```sh
 m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pfx
 ```
 
-Log in to Microsoft 365 using a personal information exchange (.pfx) file. Use the specified thumbprint and `CLIMICROSOFT365_ENTRAAPPID` environment variable set.
+Log in to Microsoft 365 using a personal information exchange (.pfx) file and a specific thumbprint with `CLIMICROSOFT365_ENTRAAPPID` and `CLIMICROSOFT365_TENANT` environment variables set.
 
 ```sh
 m365 login --authType certificate --certificateFile /Users/user/dev/localhost.pfx --thumbprint 47C4885736C624E90491F32B98855AA8A7562AF1 --password 'pass@word1'
 ```
 
-Log in to Microsoft 365 using a certificate from a base64-encoded string with `CLIMICROSOFT365_ENTRAAPPID` environment variable set.
+Log in to Microsoft 365 using a personal information exchange (.pfx) file by providing the application and tenant identifiers explicitly.
+
+```sh
+m365 login --authType certificate --appId 31359c7f-bd7e-475c-86db-fdb8c937548c --tenant 31359c7f-bd7e-475c-86db-fdb8c937548a --certificateFile /Users/user/dev/localhost.pfx --password 'pass@word1'
+```
+
+Log in to Microsoft 365 using a certificate from a base64-encoded string with `CLIMICROSOFT365_ENTRAAPPID` and `CLIMICROSOFT365_TENANT` environment variables set.
 
 ```sh
 m365 login --authType certificate --certificateBase64Encoded MIII2QIBAzCCCJ8GCSqGSIb3DQEHAaCCCJAEg...eX1N5AgIIAA== --thumbprint D0C9B442DE249F55D10CDA1A2418952DC7D407A3
 ```
 
+Log in to Microsoft 365 using a certificate from a base64-encoded string by providing the application and tenant identifiers explicitly.
+
+```sh
+m365 login --authType certificate --appId 31359c7f-bd7e-475c-86db-fdb8c937548c --tenant 31359c7f-bd7e-475c-86db-fdb8c937548a --certificateBase64Encoded MIII2QIBAzCCCJ8GCSqGSIb3DQEHAaCCCJAEg...eX1N5AgIIAA== --thumbprint D0C9B442DE249F55D10CDA1A2418952DC7D407A3
+```
+
 Log in to Microsoft 365 using a system assigned managed identity with `clientId` set in the configuration. Applies to Azure resources with managed identity enabled, such as Azure Virtual Machines, Azure App Service or Azure Functions.
 
 ```sh
@@ -196,12 +214,18 @@ Log in to Microsoft 365 using the interactive browser authentication with `clien
 m365 login --authType browser
 ```
 
-Log in to Microsoft 365 using a client secret with `clientId` set in the configuration.
+Log in to Microsoft 365 using a client secret with `CLIMICROSOFT365_ENTRAAPPID` and `CLIMICROSOFT365_TENANT` environment variables set.
 
 ```sh
 m365 login --authType secret --secret topSeCr3t@007
 ```
 
+Log in to Microsoft 365 using a client secret by providing the application and tenant identifiers explicitly.
+
+```sh
+m365 login --authType secret --appId 31359c7f-bd7e-475c-86db-fdb8c937548c --tenant 31359c7f-bd7e-475c-86db-fdb8c937548a --secret topSeCr3t@007
+```
+
 Ensures that the user is signed in, initiates the login flow if the user isn't signed in
 
 ```sh

package/docs/docs/cmd/onenote/notebook/notebook-add.mdx

@@ -36,6 +36,23 @@ m365 onenote notebook add [options]
 
 <Global />
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions                                                      |
+  |-----------------|------------------------------------------------------------------|
+  | Microsoft Graph | Notes.Create, Sites.Read.All, User.ReadBasic.All, Group.Read.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  This command does not support application permissions.
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 Create a Microsoft OneNote notebook for the currently logged in user

package/docs/docs/cmd/onenote/notebook/notebook-list.mdx

@@ -33,6 +33,23 @@ m365 onenote notebook list [options]
 
 <Global />
 
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions                                                        |
+  |-----------------|--------------------------------------------------------------------|
+  | Microsoft Graph | Notes.Read.All, Sites.Read.All, User.ReadBasic.All, Group.Read.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  This command does not support application permissions.
+
+  </TabItem>
+</Tabs>
+
 ## Examples
 
 List Microsoft OneNote notebooks for the currently logged in user

package/docs/docs/cmd/onenote/page/page-list.mdx

@@ -35,7 +35,24 @@ m365 onenote page list [options]
 
 ## Remarks
 
-When we don't specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, the OneNote pages will be retrieved of the currently logged in user.
+When you don't specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, the OneNote pages will be retrieved of the currently logged in user.
+
+## Permissions
+
+<Tabs>
+  <TabItem value="Delegated">
+
+  | Resource        | Permissions                                                        |
+  |-----------------|--------------------------------------------------------------------|
+  | Microsoft Graph | Notes.Read.All, Sites.Read.All, User.ReadBasic.All, Group.Read.All |
+
+  </TabItem>
+  <TabItem value="Application">
+
+  This command does not support application permissions.
+
+  </TabItem>
+</Tabs>
 
 ## Examples
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "11.3.0-beta.b2b02ae",
+  "version": "11.3.0",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",
@@ -323,4 +323,4 @@
     "source-map-support": "^0.5.21",
     "tsc-watch": "^7.2.0"
   }
-}
+}

package/dist/m365/spfx/commands/project/project-upgrade/rules/FN021007_PKG_scripts_deploy.js

@@ -1,45 +0,0 @@
-import { JsonRule } from "../../JsonRule.js";
-export class FN021007_PKG_scripts_deploy extends JsonRule {
-    constructor(script) {
-        super();
-        this.script = script;
-    }
-    get id() {
-        return 'FN021007';
-    }
-    get title() {
-        return 'package.json scripts.deploy';
-    }
-    get description() {
-        return 'Update package.json scripts.deploy property';
-    }
-    get resolution() {
-        return `{
-  "scripts": {
-    "deploy": "${this.script}"
-  }
-}`;
-    }
-    get resolutionType() {
-        return 'json';
-    }
-    get severity() {
-        return 'Required';
-    }
-    get file() {
-        return './package.json';
-    }
-    visit(project, findings) {
-        if (!project.packageJson) {
-            return;
-        }
-        if (!project.packageJson.scripts ||
-            typeof project.packageJson.scripts !== 'object' ||
-            !project.packageJson.scripts.deploy ||
-            project.packageJson.scripts.deploy !== this.script) {
-            const node = this.getAstNodeFromFile(project.packageJson, 'scripts.deploy');
-            this.addFindingWithPosition(findings, node);
-        }
-    }
-}
-//# sourceMappingURL=FN021007_PKG_scripts_deploy.js.map

package/dist/m365/spfx/commands/project/project-upgrade/rules/FN021009_PKG_scripts_build_watch.js

@@ -1,45 +0,0 @@
-import { JsonRule } from "../../JsonRule.js";
-export class FN021009_PKG_scripts_build_watch extends JsonRule {
-    constructor(script) {
-        super();
-        this.script = script;
-    }
-    get id() {
-        return 'FN021009';
-    }
-    get title() {
-        return 'package.json scripts.build-watch';
-    }
-    get description() {
-        return 'Update package.json scripts.build-watch property';
-    }
-    get resolution() {
-        return `{
-  "scripts": {
-    "build-watch": "${this.script}"
-  }
-}`;
-    }
-    get resolutionType() {
-        return 'json';
-    }
-    get severity() {
-        return 'Required';
-    }
-    get file() {
-        return './package.json';
-    }
-    visit(project, findings) {
-        if (!project.packageJson) {
-            return;
-        }
-        if (!project.packageJson.scripts ||
-            typeof project.packageJson.scripts !== 'object' ||
-            !project.packageJson.scripts['build-watch'] ||
-            project.packageJson.scripts['build-watch'] !== this.script) {
-            const node = this.getAstNodeFromFile(project.packageJson, 'scripts.build-watch');
-            this.addFindingWithPosition(findings, node);
-        }
-    }
-}
-//# sourceMappingURL=FN021009_PKG_scripts_build_watch.js.map

package/dist/m365/spfx/commands/project/project-upgrade/rules/FN021010_PKG_scripts_package_solution.js

@@ -1,45 +0,0 @@
-import { JsonRule } from "../../JsonRule.js";
-export class FN021010_PKG_scripts_package_solution extends JsonRule {
-    constructor(script) {
-        super();
-        this.script = script;
-    }
-    get id() {
-        return 'FN021010';
-    }
-    get title() {
-        return 'package.json scripts.package-solution';
-    }
-    get description() {
-        return 'Update package.json scripts.package-solution property';
-    }
-    get resolution() {
-        return `{
-  "scripts": {
-    "package-solution": "${this.script}"
-  }
-}`;
-    }
-    get resolutionType() {
-        return 'json';
-    }
-    get severity() {
-        return 'Required';
-    }
-    get file() {
-        return './package.json';
-    }
-    visit(project, findings) {
-        if (!project.packageJson) {
-            return;
-        }
-        if (!project.packageJson.scripts ||
-            typeof project.packageJson.scripts !== 'object' ||
-            !project.packageJson.scripts['package-solution'] ||
-            project.packageJson.scripts['package-solution'] !== this.script) {
-            const node = this.getAstNodeFromFile(project.packageJson, 'scripts.package-solution');
-            this.addFindingWithPosition(findings, node);
-        }
-    }
-}
-//# sourceMappingURL=FN021010_PKG_scripts_package_solution.js.map

package/dist/m365/spfx/commands/project/project-upgrade/rules/FN021011_PKG_scripts_deploy_azure_storage.js

@@ -1,45 +0,0 @@
-import { JsonRule } from "../../JsonRule.js";
-export class FN021011_PKG_scripts_deploy_azure_storage extends JsonRule {
-    constructor(script) {
-        super();
-        this.script = script;
-    }
-    get id() {
-        return 'FN021011';
-    }
-    get title() {
-        return 'package.json scripts.deploy-azure-storage';
-    }
-    get description() {
-        return 'Update package.json scripts.deploy-azure-storage property';
-    }
-    get resolution() {
-        return `{
-  "scripts": {
-    "deploy-azure-storage": "${this.script}"
-  }
-}`;
-    }
-    get resolutionType() {
-        return 'json';
-    }
-    get severity() {
-        return 'Required';
-    }
-    get file() {
-        return './package.json';
-    }
-    visit(project, findings) {
-        if (!project.packageJson) {
-            return;
-        }
-        if (!project.packageJson.scripts ||
-            typeof project.packageJson.scripts !== 'object' ||
-            !project.packageJson.scripts['deploy-azure-storage'] ||
-            project.packageJson.scripts['deploy-azure-storage'] !== this.script) {
-            const node = this.getAstNodeFromFile(project.packageJson, 'scripts.deploy-azure-storage');
-            this.addFindingWithPosition(findings, node);
-        }
-    }
-}
-//# sourceMappingURL=FN021011_PKG_scripts_deploy_azure_storage.js.map

package/dist/m365/spfx/commands/project/project-upgrade/rules/FN021014_PKG_scripts_test_only.js

@@ -1,45 +0,0 @@
-import { JsonRule } from "../../JsonRule.js";
-export class FN021014_PKG_scripts_test_only extends JsonRule {
-    constructor(script) {
-        super();
-        this.script = script;
-    }
-    get id() {
-        return 'FN021014';
-    }
-    get title() {
-        return 'package.json scripts.test-only';
-    }
-    get description() {
-        return 'Add package.json scripts.test-only property';
-    }
-    get resolution() {
-        return `{
-  "scripts": {
-    "test-only": "${this.script}"
-  }
-}`;
-    }
-    get resolutionType() {
-        return 'json';
-    }
-    get severity() {
-        return 'Required';
-    }
-    get file() {
-        return './package.json';
-    }
-    visit(project, findings) {
-        if (!project.packageJson) {
-            return;
-        }
-        if (!project.packageJson.scripts ||
-            typeof project.packageJson.scripts !== 'object' ||
-            !project.packageJson.scripts['test-only'] ||
-            project.packageJson.scripts['test-only'] !== this.script) {
-            const node = this.getAstNodeFromFile(project.packageJson, 'scripts.test-only');
-            this.addFindingWithPosition(findings, node);
-        }
-    }
-}
-//# sourceMappingURL=FN021014_PKG_scripts_test_only.js.map

package/dist/m365/spfx/commands/project/project-upgrade/rules/FN021015_PKG_scripts_trust_dev_cert.js

@@ -1,45 +0,0 @@
-import { JsonRule } from "../../JsonRule.js";
-export class FN021015_PKG_scripts_trust_dev_cert extends JsonRule {
-    constructor(script) {
-        super();
-        this.script = script;
-    }
-    get id() {
-        return 'FN021015';
-    }
-    get title() {
-        return 'package.json scripts.trust-dev-cert';
-    }
-    get description() {
-        return 'Add package.json scripts.trust-dev-cert property';
-    }
-    get resolution() {
-        return `{
-  "scripts": {
-    "trust-dev-cert": "${this.script}"
-  }
-}`;
-    }
-    get resolutionType() {
-        return 'json';
-    }
-    get severity() {
-        return 'Required';
-    }
-    get file() {
-        return './package.json';
-    }
-    visit(project, findings) {
-        if (!project.packageJson) {
-            return;
-        }
-        if (!project.packageJson.scripts ||
-            typeof project.packageJson.scripts !== 'object' ||
-            !project.packageJson.scripts['trust-dev-cert'] ||
-            project.packageJson.scripts['trust-dev-cert'] !== this.script) {
-            const node = this.getAstNodeFromFile(project.packageJson, 'scripts.trust-dev-cert');
-            this.addFindingWithPosition(findings, node);
-        }
-    }
-}
-//# sourceMappingURL=FN021015_PKG_scripts_trust_dev_cert.js.map

package/dist/m365/spfx/commands/project/project-upgrade/rules/FN021016_PKG_scripts_untrust_dev_cert.js

@@ -1,45 +0,0 @@
-import { JsonRule } from "../../JsonRule.js";
-export class FN021016_PKG_scripts_untrust_dev_cert extends JsonRule {
-    constructor(script) {
-        super();
-        this.script = script;
-    }
-    get id() {
-        return 'FN021016';
-    }
-    get title() {
-        return 'package.json scripts.untrust-dev-cert';
-    }
-    get description() {
-        return 'Add package.json scripts.untrust-dev-cert property';
-    }
-    get resolution() {
-        return `{
-  "scripts": {
-    "untrust-dev-cert": "${this.script}"
-  }
-}`;
-    }
-    get resolutionType() {
-        return 'json';
-    }
-    get severity() {
-        return 'Required';
-    }
-    get file() {
-        return './package.json';
-    }
-    visit(project, findings) {
-        if (!project.packageJson) {
-            return;
-        }
-        if (!project.packageJson.scripts ||
-            typeof project.packageJson.scripts !== 'object' ||
-            !project.packageJson.scripts['untrust-dev-cert'] ||
-            project.packageJson.scripts['untrust-dev-cert'] !== this.script) {
-            const node = this.getAstNodeFromFile(project.packageJson, 'scripts.untrust-dev-cert');
-            this.addFindingWithPosition(findings, node);
-        }
-    }
-}
-//# sourceMappingURL=FN021016_PKG_scripts_untrust_dev_cert.js.map