@pnp/cli-microsoft365 9.0.0-beta.f2c5f82 → 10.0.0-beta.7dfc31a

package/dist/Command.js

@@ -111,9 +111,7 @@ class Command {
                 prompted = true;
                 await cli.error('🌶️  Provide values for the following parameters:');
             }
-            const answer = optionInfo.autocomplete !== undefined
-                ? await prompt.forSelection({ message: `${optionInfo.name}: `, choices: optionInfo.autocomplete.map((choice) => { return { name: choice, value: choice }; }) })
-                : await prompt.forInput({ message: `${optionInfo.name}: ` });
+            const answer = await cli.promptForValue(optionInfo);
             args.options[optionInfo.name] = answer;
         }
         if (prompted) {

package/dist/cli/cli.js

@@ -137,14 +137,38 @@ async function execute(rawArgs) {
     }
     let finalArgs = cli.optionsFromArgs.options;
     if (cli.commandToExecute?.command.schema) {
-        const startValidation = process.hrtime.bigint();
-        const result = cli.commandToExecute.command.getSchemaToParse().safeParse(cli.optionsFromArgs.options);
-        const endValidation = process.hrtime.bigint();
-        timings.validation.push(Number(endValidation - startValidation));
-        if (!result.success) {
-            return cli.closeWithError(result.error, cli.optionsFromArgs, true);
+        while (true) {
+            const startValidation = process.hrtime.bigint();
+            const result = cli.commandToExecute.command.getSchemaToParse().safeParse(cli.optionsFromArgs.options);
+            const endValidation = process.hrtime.bigint();
+            timings.validation.push(Number(endValidation - startValidation));
+            if (result.success) {
+                finalArgs = result.data;
+                break;
+            }
+            else {
+                const hasNonRequiredErrors = result.error.errors.some(e => e.code !== 'invalid_type' || e.received !== 'undefined');
+                const shouldPrompt = cli.getSettingWithDefaultValue(settingsNames.prompt, true);
+                if (hasNonRequiredErrors === false &&
+                    shouldPrompt) {
+                    await cli.error('🌶️  Provide values for the following parameters:');
+                    for (const error of result.error.errors) {
+                        const optionInfo = cli.commandToExecute.options.find(o => o.name === error.path.join('.'));
+                        const answer = await cli.promptForValue(optionInfo);
+                        cli.optionsFromArgs.options[error.path.join('.')] = answer;
+                    }
+                }
+                else {
+                    result.error.errors.forEach(e => {
+                        if (e.code === 'invalid_type' &&
+                            e.received === 'undefined') {
+                            e.message = `Required option not specified`;
+                        }
+                    });
+                    return cli.closeWithError(result.error, cli.optionsFromArgs, true);
+                }
+            }
         }
-        finalArgs = result.data;
     }
     else {
         const startValidation = process.hrtime.bigint();
@@ -753,7 +777,7 @@ async function closeWithError(error, args, showHelpIfEnabled = false) {
     }
     let errorMessage = error instanceof CommandError ? error.message : error;
     if (error instanceof ZodError) {
-        errorMessage = error.errors.map(e => `${e.path}: ${e.message}`).join(os.EOL);
+        errorMessage = error.errors.map(e => `${e.path.join('.')}: ${e.message}`).join(os.EOL);
     }
     if ((!args.options.output || args.options.output === 'json') &&
         !cli.getSettingWithDefaultValue(settingsNames.printErrorsAsPlainText, true)) {
@@ -793,6 +817,16 @@ async function error(message, ...optionalParams) {
         console.error(message, ...optionalParams);
     }
 }
+async function promptForValue(optionInfo) {
+    return optionInfo.autocomplete !== undefined
+        ? await prompt.forSelection({
+            message: `${optionInfo.name}: `,
+            choices: optionInfo.autocomplete.map((choice) => {
+                return { name: choice, value: choice };
+            })
+        })
+        : await prompt.forInput({ message: `${optionInfo.name}: ` });
+}
 async function promptForSelection(config) {
     const answer = await prompt.forSelection(config);
     await cli.error('');
@@ -857,6 +891,7 @@ export const cli = {
     printAvailableCommands,
     promptForConfirmation,
     promptForSelection,
+    promptForValue,
     shouldTrimOutput,
     yargsConfiguration
 };

package/dist/m365/commands/login.js

@@ -38,19 +38,24 @@ class LoginCommand extends Command {
     getRefinedSchema(schema) {
         return schema
             .refine(options => options.authType !== 'password' || options.userName, {
-            message: 'Username is required when using password authentication'
+            message: 'Username is required when using password authentication',
+            path: ['userName']
         })
             .refine(options => options.authType !== 'password' || options.password, {
-            message: 'Password is required when using password authentication'
+            message: 'Password is required when using password authentication',
+            path: ['password']
         })
             .refine(options => options.authType !== 'certificate' || !(options.certificateFile && options.certificateBase64Encoded), {
-            message: 'Specify either certificateFile or certificateBase64Encoded, but not both.'
+            message: 'Specify either certificateFile or certificateBase64Encoded, but not both.',
+            path: ['certificateBase64Encoded']
         })
             .refine(options => options.authType !== 'certificate' || options.certificateFile || options.certificateBase64Encoded, {
-            message: 'Specify either certificateFile or certificateBase64Encoded'
+            message: 'Specify either certificateFile or certificateBase64Encoded',
+            path: ['certificateFile']
         })
             .refine(options => options.authType !== 'secret' || options.secret, {
-            message: 'Secret is required when using secret authentication'
+            message: 'Secret is required when using secret authentication',
+            path: ['secret']
         });
     }
     async commandAction(logger, args) {

package/dist/m365/onenote/commands/notebook/notebook-add.js

@@ -0,0 +1,132 @@
+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 _OneNoteNotebookAddCommand_instances, _OneNoteNotebookAddCommand_initTelemetry, _OneNoteNotebookAddCommand_initOptions, _OneNoteNotebookAddCommand_initValidators, _OneNoteNotebookAddCommand_initOptionSets;
+import request from '../../../../request.js';
+import { entraGroup } from '../../../../utils/entraGroup.js';
+import { validation } from '../../../../utils/validation.js';
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+import { spo } from '../../../../utils/spo.js';
+class OneNoteNotebookAddCommand extends GraphCommand {
+    get name() {
+        return commands.NOTEBOOK_ADD;
+    }
+    get description() {
+        return 'Create a new OneNote notebook';
+    }
+    constructor() {
+        super();
+        _OneNoteNotebookAddCommand_instances.add(this);
+        __classPrivateFieldGet(this, _OneNoteNotebookAddCommand_instances, "m", _OneNoteNotebookAddCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _OneNoteNotebookAddCommand_instances, "m", _OneNoteNotebookAddCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _OneNoteNotebookAddCommand_instances, "m", _OneNoteNotebookAddCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _OneNoteNotebookAddCommand_instances, "m", _OneNoteNotebookAddCommand_initOptionSets).call(this);
+    }
+    async commandAction(logger, args) {
+        try {
+            if (this.verbose) {
+                await logger.logToStderr(`Creating OneNote notebook ${args.options.name}`);
+            }
+            const requestUrl = await this.getRequestUrl(args);
+            const requestOptions = {
+                url: requestUrl,
+                headers: {
+                    accept: 'application/json;odata.metadata=none',
+                    'content-type': "application/json"
+                },
+                responseType: 'json',
+                data: {
+                    displayName: args.options.name
+                }
+            };
+            const response = await request.post(requestOptions);
+            await logger.log(response);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+    async getRequestUrl(args) {
+        let endpoint = `${this.resource}/v1.0/`;
+        if (args.options.userId) {
+            endpoint += `users/${args.options.userId}`;
+        }
+        else if (args.options.userName) {
+            endpoint += `users/${args.options.userName}`;
+        }
+        else if (args.options.groupId) {
+            endpoint += `groups/${args.options.groupId}`;
+        }
+        else if (args.options.groupName) {
+            const groupId = await entraGroup.getGroupIdByDisplayName(args.options.groupName);
+            endpoint += `groups/${groupId}`;
+        }
+        else if (args.options.webUrl) {
+            const siteId = await spo.getSpoGraphSiteId(args.options.webUrl);
+            endpoint += `sites/${siteId}`;
+        }
+        else {
+            endpoint += 'me';
+        }
+        endpoint += '/onenote/notebooks';
+        return endpoint;
+    }
+}
+_OneNoteNotebookAddCommand_instances = new WeakSet(), _OneNoteNotebookAddCommand_initTelemetry = function _OneNoteNotebookAddCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            userId: typeof args.options.userId !== 'undefined',
+            userName: typeof args.options.userName !== 'undefined',
+            groupId: typeof args.options.groupId !== 'undefined',
+            groupName: typeof args.options.groupName !== 'undefined',
+            webUrl: typeof args.options.webUrl !== 'undefined'
+        });
+    });
+}, _OneNoteNotebookAddCommand_initOptions = function _OneNoteNotebookAddCommand_initOptions() {
+    this.options.unshift({
+        option: '-n, --name <name>'
+    }, {
+        option: '--userId [userId]'
+    }, {
+        option: '--userName [userName]'
+    }, {
+        option: '--groupId [groupId]'
+    }, {
+        option: '--groupName [groupName]'
+    }, {
+        option: '-u, --webUrl [webUrl]'
+    });
+}, _OneNoteNotebookAddCommand_initValidators = function _OneNoteNotebookAddCommand_initValidators() {
+    this.validators.push(async (args) => {
+        // check name for invalid characters
+        if (args.options.name.length > 128) {
+            return 'The specified name is too long. It should be less than 128 characters';
+        }
+        if (/[?*/:<>|'"]/.test(args.options.name)) {
+            return `The specified name contains invalid characters. It cannot contain ?*/:<>|'". Please remove them and try again.`;
+        }
+        if (args.options.userId && !validation.isValidGuid(args.options.userId)) {
+            return `${args.options.userId} is not a valid GUID`;
+        }
+        if (args.options.groupId && !validation.isValidGuid(args.options.groupId)) {
+            return `${args.options.groupId} is not a valid GUID`;
+        }
+        if (args.options.webUrl) {
+            return validation.isValidSharePointUrl(args.options.webUrl);
+        }
+        return true;
+    });
+}, _OneNoteNotebookAddCommand_initOptionSets = function _OneNoteNotebookAddCommand_initOptionSets() {
+    this.optionSets.push({
+        options: ['userId', 'userName', 'groupId', 'groupName', 'webUrl'],
+        runsWhen: (args) => {
+            const options = [args.options.userId, args.options.userName, args.options.groupId, args.options.groupName, args.options.webUrl];
+            return options.some(item => item !== undefined);
+        }
+    });
+};
+export default new OneNoteNotebookAddCommand();
+//# sourceMappingURL=notebook-add.js.map

package/dist/m365/onenote/commands.js

@@ -1,5 +1,6 @@
 const prefix = 'onenote';
 export default {
+    NOTEBOOK_ADD: `${prefix} notebook add`,
     NOTEBOOK_LIST: `${prefix} notebook list`,
     PAGE_LIST: `${prefix} page list`
 };

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

@@ -1,13 +1,17 @@
-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 _SpoSiteGetCommand_instances, _SpoSiteGetCommand_initOptions, _SpoSiteGetCommand_initValidators;
+import { z } from 'zod';
+import { globalOptionsZod } from '../../../../Command.js';
 import request from '../../../../request.js';
 import { validation } from '../../../../utils/validation.js';
+import { zod } from '../../../../utils/zod.js';
 import SpoCommand from '../../../base/SpoCommand.js';
 import commands from '../../commands.js';
+const options = globalOptionsZod
+    .extend({
+    url: zod.alias('u', z.string().refine(url => validation.isValidSharePointUrl(url) === true, {
+        message: 'Specify a valid SharePoint site URL'
+    }))
+})
+    .strict();
 class SpoSiteGetCommand extends SpoCommand {
     get name() {
         return commands.SITE_GET;
@@ -15,11 +19,8 @@ class SpoSiteGetCommand extends SpoCommand {
     get description() {
         return 'Gets information about the specific site collection';
     }
-    constructor() {
-        super();
-        _SpoSiteGetCommand_instances.add(this);
-        __classPrivateFieldGet(this, _SpoSiteGetCommand_instances, "m", _SpoSiteGetCommand_initOptions).call(this);
-        __classPrivateFieldGet(this, _SpoSiteGetCommand_instances, "m", _SpoSiteGetCommand_initValidators).call(this);
+    get schema() {
+        return options;
     }
     async commandAction(logger, args) {
         const requestOptions = {
@@ -38,10 +39,5 @@ class SpoSiteGetCommand extends SpoCommand {
         }
     }
 }
-_SpoSiteGetCommand_instances = new WeakSet(), _SpoSiteGetCommand_initOptions = function _SpoSiteGetCommand_initOptions() {
-    this.options.unshift({ option: '-u, --url <url>' });
-}, _SpoSiteGetCommand_initValidators = function _SpoSiteGetCommand_initValidators() {
-    this.validators.push(async (args) => validation.isValidSharePointUrl(args.options.url));
-};
 export default new SpoSiteGetCommand();
 //# sourceMappingURL=site-get.js.map

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

@@ -0,0 +1,169 @@
+import Global from '/docs/cmd/_global.mdx';
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# onenote notebook add
+
+Create a new OneNote notebook.
+
+## Usage
+
+```sh
+m365 onenote notebook add [options]
+```
+
+## Options
+
+```md definition-list
+`-n, --name <name>`
+: Name of the notebook. Notebook names must be unique. The name cannot contain more than 128 characters or contain the following characters: `?*/:<>`
+
+`--userId [userId]`
+: Id of the user. Specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, but not multiple.
+
+`--userName [userName]`
+: Name of the user. Specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, but not multiple.
+
+`--groupId [groupId]`
+: Id of the SharePoint group. Specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, but not multiple.
+
+`--groupName [groupName]`
+: Name of the SharePoint group. Specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, but not multiple.
+
+`-u, --webUrl [webUrl]`
+: URL of the SharePoint site. Specify either `userId`, `userName`, `groupId`, `groupName` or `webUrl`, but not multiple.
+```
+
+<Global />
+
+## Examples
+
+Create a Microsoft OneNote notebook for the currently logged in user
+
+```sh
+m365 onenote notebook add --name "Private Notebook"
+```
+
+Create a Microsoft OneNote notebook in a group specified by id.
+
+```sh
+m365 onenote notebook add --name "Private Notebook" --groupId 233e43d0-dc6a-482e-9b4e-0de7a7bce9b4
+```
+
+Create a Microsoft OneNote notebook in a group specified by displayName.
+
+```sh
+m365 onenote notebook add --name "Private Notebook" --groupName "MyGroup"
+```
+
+Create a Microsoft OneNote notebook for a user specified by name
+
+```sh
+m365 onenote notebook add --name "Private Notebook" --userName user1@contoso.onmicrosoft.com
+```
+
+Create a Microsoft OneNote notebook for a user specified by id
+
+```sh
+m365 onenote notebook add --name "Private Notebook" --userId 2609af39-7775-4f94-a3dc-0dd67657e900
+```
+
+Creates a Microsoft OneNote notebooks for a site
+
+```sh
+ m365 onenote notebook add --name "Private Notebook" --webUrl https://contoso.sharepoint.com/sites/testsite
+```
+
+## Response
+
+<Tabs>
+  <TabItem value="JSON">
+
+  ```json
+  {
+    "id": "1-08554ffd-b769-4a4a-9563-faaa3191f253",
+    "self": "https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-08554ffd-b769-4a4a-9563-faaa3191f253",
+    "createdDateTime": "2024-04-05T17:58:27Z",
+    "displayName": "Private Notebook",
+    "lastModifiedDateTime": "2024-04-05T17:58:27Z",
+    "isDefault": false,
+    "userRole": "Owner",
+    "isShared": false,
+    "sectionsUrl": "https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-08554ffd-b769-4a4a-9563-faaa3191f253/sections",
+    "sectionGroupsUrl": "https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-08554ffd-b769-4a4a-9563-faaa3191f253/sectionGroups",
+    "createdBy": {
+      "user": {
+        "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
+        "displayName": "John Doe"
+      }
+    },
+    "lastModifiedBy": {
+      "user": {
+        "id": "fe36f75e-c103-410b-a18a-2bf6df06ac3a",
+        "displayName": "John Doe"
+      }
+    },
+    "links": {
+      "oneNoteClientUrl": {
+        "href": "onenote:https://contoso-my.sharepoint.com/personal/john_contoso_onmicrosoft_com/Documents/Notebooks/Private Notebook"
+      },
+      "oneNoteWebUrl": {
+        "href": "https://contoso-my.sharepoint.com/personal/john_contoso_onmicrosoft_com/Documents/Notebooks/Private Notebook"
+      }
+    }
+  }
+  ```
+
+  </TabItem>
+  <TabItem value="Text">
+
+  ```text
+  createdBy           : {"user":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"John Doe"}}
+  createdDateTime     : 2024-04-05T17:58:36Z
+  displayName         : Private Notebook
+  id                  : 1-f4bba32b-9b3e-4892-8df4-931a15f7eb6f
+  isDefault           : false
+  isShared            : false
+  lastModifiedBy      : {"user":{"id":"fe36f75e-c103-410b-a18a-2bf6df06ac3a","displayName":"John Doe"}}
+  lastModifiedDateTime: 2024-04-05T17:58:36Z
+  links               : {"oneNoteClientUrl":{"href":"onenote:https://contoso-my.sharepoint.com/personal/john_contoso_onmicrosoft_com/Documents/Notebooks/Private Notebook"},"oneNoteWebUrl":{"href":"https://contoso-my.sharepoint.com/personal/john_contoso_onmicrosoft_com/Documents/Notebooks/Private Notebook"}}
+  sectionGroupsUrl    : https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-f4bba32b-9b3e-4892-8df4-931a15f7eb6f/sectionGroups
+  sectionsUrl         : https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-f4bba32b-9b3e-4892-8df4-931a15f7eb6f/sections
+  self                : https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-f4bba32b-9b3e-4892-8df4-931a15f7eb6f
+  userRole            : Owner
+  ```
+
+  </TabItem>
+  <TabItem value="CSV">
+
+  ```csv
+  id,self,createdDateTime,displayName,lastModifiedDateTime,isDefault,userRole,isShared,sectionsUrl,sectionGroupsUrl
+  1-272a5791-2c95-45cf-b27d-7f68e07f6149,https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-272a5791-2c95-45cf-b27d-7f68e07f6149,2024-04-05T18:00:28Z,Private Notebook,2024-04-05T18:00:28Z,,Owner,,https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-272a5791-2c95-45cf-b27d-7f68e07f6149/sections,https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-272a5791-2c95-45cf-b27d-7f68e07f6149/sectionGroups
+  ```
+
+  </TabItem>
+  <TabItem value="Markdown">
+
+  ```md
+  # onenote notebook add --name "Private Notebook"
+
+  Date: 05/04/2024
+
+  ## Private Notebook (1-fa279d79-4701-43a2-9593-c2abfbe6999f)
+
+  Property | Value
+  ---------|-------
+  id | 1-fa279d79-4701-43a2-9593-c2abfbe6999f
+  self | https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-fa279d79-4701-43a2-9593-c2abfbe6999f
+  createdDateTime | 2024-04-05T18:00:58Z
+  displayName | Private Notebook
+  lastModifiedDateTime | 2024-04-05T18:00:58Z
+  isDefault | false
+  userRole | Owner
+  isShared | false
+  sectionsUrl | https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-fa279d79-4701-43a2-9593-c2abfbe6999f/sections
+  sectionGroupsUrl | https://graph.microsoft.com/v1.0/users/fe36f75e-c103-410b-a18a-2bf6df06ac3a/onenote/notebooks/1-fa279d79-4701-43a2-9593-c2abfbe6999f/sectionGroups
+  ```
+
+  </TabItem>
+</Tabs>

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "9.0.0",
+  "version": "10.0.0",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@pnp/cli-microsoft365",
-      "version": "9.0.0",
+      "version": "10.0.0",
       "license": "MIT",
       "dependencies": {
         "@azure/msal-common": "^14.14.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "9.0.0-beta.f2c5f82",
+  "version": "10.0.0-beta.7dfc31a",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",