@pnp/cli-microsoft365 11.4.0-beta.40f818c → 11.4.0-beta.f54089d

package/dist/Auth.js

@@ -798,7 +798,7 @@ export class Auth {
         const existingConnection = allConnections.find(c => c.name === newName);
         const oldName = connection.name;
         if (existingConnection) {
-            throw new CommandError(`The connection name '${newName}' is already in use`);
+            throw new CommandError(`The connection name '${newName}' is already in use.`);
         }
         connection.name = newName;
         if (this.connection.name === oldName) {

package/dist/cli/cli.js

@@ -145,7 +145,7 @@ async function execute(rawArgs) {
     if (cli.commandToExecute?.command.schema) {
         while (true) {
             const startValidation = process.hrtime.bigint();
-            const result = cli.commandToExecute.command.getSchemaToParse().safeParse(cli.optionsFromArgs.options);
+            const result = await cli.commandToExecute.command.getSchemaToParse().safeParseAsync(cli.optionsFromArgs.options);
             const endValidation = process.hrtime.bigint();
             timings.validation.push(Number(endValidation - startValidation));
             if (result.success) {

package/dist/m365/commands/login.js

@@ -21,7 +21,11 @@ export const options = z.strictObject({
     appId: z.string().optional(),
     tenant: z.string().optional(),
     secret: z.string().optional().alias('s'),
-    connectionName: z.string().optional(),
+    connectionName: z.string()
+        .refine(async (name) => !(await auth.getAllConnections()).some(c => c.name === name), {
+        error: e => `Connection with name '${e.input}' already exists.`
+    })
+        .optional(),
     ensure: z.boolean().optional()
 });
 class LoginCommand extends Command {

package/dist/m365/connection/commands/connection-set.js

@@ -1,12 +1,18 @@
-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 _ConnectionSetCommand_instances, _ConnectionSetCommand_initOptions, _ConnectionSetCommand_initValidators, _ConnectionSetCommand_initTypes;
 import auth from '../../../Auth.js';
 import commands from '../commands.js';
-import Command, { CommandError } from '../../../Command.js';
+import Command, { CommandError, globalOptionsZod } from '../../../Command.js';
+import z from 'zod';
+export const options = z.strictObject({
+    ...globalOptionsZod.shape,
+    name: z.string().alias('n')
+        .refine(async (name) => (await auth.getAllConnections()).some(c => c.name === name), {
+        error: e => `Connection with name '${e.input}' does not exist.`
+    }),
+    newName: z.string()
+        .refine(async (newName) => !(await auth.getAllConnections()).some(c => c.name === newName), {
+        error: e => `Connection with name '${e.input}' already exists.`
+    })
+});
 class ConnectionSetCommand extends Command {
     get name() {
         return commands.SET;
@@ -14,12 +20,8 @@ class ConnectionSetCommand extends Command {
     get description() {
         return 'Rename the specified connection';
     }
-    constructor() {
-        super();
-        _ConnectionSetCommand_instances.add(this);
-        __classPrivateFieldGet(this, _ConnectionSetCommand_instances, "m", _ConnectionSetCommand_initOptions).call(this);
-        __classPrivateFieldGet(this, _ConnectionSetCommand_instances, "m", _ConnectionSetCommand_initValidators).call(this);
-        __classPrivateFieldGet(this, _ConnectionSetCommand_instances, "m", _ConnectionSetCommand_initTypes).call(this);
+    get schema() {
+        return options;
     }
     async commandAction(logger, args) {
         const connection = await auth.getConnection(args.options.name);
@@ -39,21 +41,5 @@ class ConnectionSetCommand extends Command {
         await this.commandAction(logger, args);
     }
 }
-_ConnectionSetCommand_instances = new WeakSet(), _ConnectionSetCommand_initOptions = function _ConnectionSetCommand_initOptions() {
-    this.options.unshift({
-        option: '-n, --name <name>'
-    }, {
-        option: '--newName <newName>'
-    });
-}, _ConnectionSetCommand_initValidators = function _ConnectionSetCommand_initValidators() {
-    this.validators.push(async (args) => {
-        if (args.options.name === args.options.newName) {
-            return `Choose a name different from the current one`;
-        }
-        return true;
-    });
-}, _ConnectionSetCommand_initTypes = function _ConnectionSetCommand_initTypes() {
-    this.types.string.push('name', 'newName');
-};
 export default new ConnectionSetCommand();
 //# sourceMappingURL=connection-set.js.map

package/dist/m365/spo/commands/file/file-add.js

@@ -39,14 +39,38 @@ class SpoFileAddCommand extends SpoCommand {
     async commandAction(logger, args) {
         const folderPath = urlUtil.getServerRelativePath(args.options.webUrl, args.options.folder);
         const fullPath = path.resolve(args.options.path);
-        const fileName = fsUtil.getSafeFileName(path.basename(fullPath));
+        const fileName = fsUtil.getSafeFileName(args.options.fileName ?? path.basename(fullPath));
         let isCheckedOut = false;
         let listSettings;
         if (this.verbose) {
             await logger.logToStderr(`file name: ${fileName}...`);
             await logger.logToStderr(`folder path: ${folderPath}...`);
         }
+        if (args.options.overwrite === undefined) {
+            await this.warn(logger, 'In the next major version, the --overwrite option will default to false. To avoid this warning, please set the --overwrite option explicitly to true or false.');
+        }
         try {
+            if (args.options.overwrite === false) {
+                try {
+                    const requestOptions = {
+                        url: `${args.options.webUrl}/_api/Web/GetFileByServerRelativePath(DecodedUrl='${formatting.encodeQueryParameter(folderPath + '/' + fileName)}')?$select=Exists`,
+                        headers: {
+                            accept: 'application/json;odata=nometadata'
+                        },
+                        responseType: 'json'
+                    };
+                    await request.get(requestOptions);
+                    throw `File '${fileName}' already exists in folder '${folderPath}'. To overwrite the file, use the --overwrite option.`;
+                }
+                catch (err) {
+                    if (typeof err === 'string') {
+                        throw err;
+                    }
+                    if (this.verbose) {
+                        await logger.logToStderr(`File '${fileName}' does not exist in folder '${folderPath}'. Proceeding with upload.`);
+                    }
+                }
+            }
             try {
                 if (this.verbose) {
                     await logger.logToStderr('Check if the specified folder exists.');
@@ -78,6 +102,7 @@ class SpoFileAddCommand extends SpoCommand {
             if (this.verbose) {
                 await logger.logToStderr(`File size is ${fileSize} bytes`);
             }
+            let fileUploadResult;
             // only up to 250 MB are allowed in a single request
             if (fileSize > this.fileChunkingThreshold) {
                 const fileChunkCount = Math.ceil(fileSize / this.fileChunkSize);
@@ -106,7 +131,7 @@ class SpoFileAddCommand extends SpoCommand {
                     Size: fileSize
                 };
                 try {
-                    await this.uploadFileChunks(fileUploadInfo, logger);
+                    fileUploadResult = await this.uploadFileChunks(fileUploadInfo, logger);
                     if (this.verbose) {
                         await logger.logToStderr(`Finished uploading ${fileUploadInfo.Position} bytes in ${fileChunkCount} chunks`);
                     }
@@ -127,7 +152,7 @@ class SpoFileAddCommand extends SpoCommand {
                         throw err;
                     }
                     catch (err) {
-                        if (this.debug) {
+                        if (this.verbose) {
                             await logger.logToStderr(`Failed to cancel upload session: ${err}`);
                         }
                         throw err;
@@ -145,9 +170,10 @@ class SpoFileAddCommand extends SpoCommand {
                         accept: 'application/json;odata=nometadata',
                         'content-length': bodyLength
                     },
-                    maxBodyLength: this.fileChunkingThreshold
+                    maxBodyLength: this.fileChunkingThreshold,
+                    responseType: 'json'
                 };
-                await request.post(requestOptions);
+                fileUploadResult = await request.post(requestOptions);
             }
             if (args.options.contentType || args.options.publish || args.options.approve) {
                 listSettings = await this.getFileParentList(fileName, args.options.webUrl, folderPath, logger);
@@ -206,6 +232,7 @@ class SpoFileAddCommand extends SpoCommand {
                 };
                 await request.post(requestOptions);
             }
+            await logger.log(fileUploadResult);
         }
         catch (err) {
             if (isCheckedOut) {
@@ -292,15 +319,16 @@ class SpoFileAddCommand extends SpoCommand {
                     accept: 'application/json;odata=nometadata',
                     'content-length': readCount
                 },
-                maxBodyLength: this.fileChunkingThreshold
+                maxBodyLength: this.fileChunkingThreshold,
+                responseType: 'json'
             };
             try {
-                await request.post(requestOptions);
+                const uploadResponse = await request.post(requestOptions);
                 if (this.verbose) {
                     await logger.logToStderr(`Uploaded ${info.Position} of ${info.Size} bytes (${Math.round(100 * info.Position / info.Size)}%)`);
                 }
                 if (isLastChunk) {
-                    return;
+                    return uploadResponse;
                 }
                 else {
                     return this.uploadFileChunks(info, logger);
@@ -407,9 +435,12 @@ class SpoFileAddCommand extends SpoCommand {
             'approveComment',
             'publish',
             'publishComment',
+            'overwrite',
+            'fileName',
             'debug',
             'verbose',
             'output',
+            'query',
             '_',
             'u',
             'p',
@@ -434,7 +465,9 @@ _SpoFileAddCommand_instances = new WeakSet(), _SpoFileAddCommand_initTelemetry =
             approve: !!args.options.approve,
             approveComment: typeof args.options.approveComment !== 'undefined',
             publish: !!args.options.publish,
-            publishComment: typeof args.options.publishComment !== 'undefined'
+            publishComment: typeof args.options.publishComment !== 'undefined',
+            overwrite: !!args.options.overwrite,
+            fileName: typeof args.options.fileName !== 'undefined'
         });
     });
 }, _SpoFileAddCommand_initOptions = function _SpoFileAddCommand_initOptions() {
@@ -458,6 +491,11 @@ _SpoFileAddCommand_instances = new WeakSet(), _SpoFileAddCommand_initTelemetry =
         option: '--publish'
     }, {
         option: '--publishComment [publishComment]'
+    }, {
+        option: '--overwrite [overwrite]',
+        autocomplete: ['true', 'false']
+    }, {
+        option: '--fileName [fileName]'
     });
 }, _SpoFileAddCommand_initValidators = function _SpoFileAddCommand_initValidators() {
     this.validators.push(async (args) => {
@@ -477,8 +515,8 @@ _SpoFileAddCommand_instances = new WeakSet(), _SpoFileAddCommand_initTelemetry =
         return true;
     });
 }, _SpoFileAddCommand_initTypes = function _SpoFileAddCommand_initTypes() {
-    this.types.string.push('webUrl', 'folder', 'path', 'contentType', 'checkInComment', 'approveComment', 'publishComment');
-    this.types.boolean.push('checkOut', 'approve', 'publish');
+    this.types.string.push('webUrl', 'folder', 'path', 'contentType', 'checkInComment', 'approveComment', 'publishComment', 'fileName');
+    this.types.boolean.push('checkOut', 'approve', 'publish', 'overwrite');
 };
 export default new SpoFileAddCommand();
 //# sourceMappingURL=file-add.js.map

package/dist/m365/spo/commands/listitem/listitem-set.js

@@ -85,7 +85,7 @@ class SpoListItemSetCommand extends SpoCommand {
             }
             const properties = this.mapRequestBody(args.options);
             const item = args.options.systemUpdate ?
-                await spo.systemUpdateListItem(requestUrl, args.options.id, logger, this.verbose, properties, contentTypeName)
+                await spo.systemUpdateListItem(requestUrl, +args.options.id, logger, this.verbose, properties, contentTypeName)
                 : await spo.updateListItem(requestUrl, args.options.id, properties, contentTypeName);
             delete item.ID;
             await logger.log(item);

package/dist/m365/spo/commands/page/page-header-set.js

@@ -3,7 +3,8 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     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 _SpoPageHeaderSetCommand_instances, _SpoPageHeaderSetCommand_initTelemetry, _SpoPageHeaderSetCommand_initOptions, _SpoPageHeaderSetCommand_initValidators;
+var _SpoPageHeaderSetCommand_instances, _SpoPageHeaderSetCommand_initTelemetry, _SpoPageHeaderSetCommand_initOptions, _SpoPageHeaderSetCommand_initValidators, _SpoPageHeaderSetCommand_initTypes;
+import { CommandError } from '../../../../Command.js';
 import request from '../../../../request.js';
 import { formatting } from '../../../../utils/formatting.js';
 import { spo } from '../../../../utils/spo.js';
@@ -25,98 +26,102 @@ class SpoPageHeaderSetCommand extends SpoCommand {
         __classPrivateFieldGet(this, _SpoPageHeaderSetCommand_instances, "m", _SpoPageHeaderSetCommand_initTelemetry).call(this);
         __classPrivateFieldGet(this, _SpoPageHeaderSetCommand_instances, "m", _SpoPageHeaderSetCommand_initOptions).call(this);
         __classPrivateFieldGet(this, _SpoPageHeaderSetCommand_instances, "m", _SpoPageHeaderSetCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _SpoPageHeaderSetCommand_instances, "m", _SpoPageHeaderSetCommand_initTypes).call(this);
     }
     getExcludedOptionsWithUrls() {
         return ['imageUrl'];
     }
     async commandAction(logger, args) {
         const noPageHeader = {
-            "id": BannerWebPartId,
-            "instanceId": BannerWebPartId,
-            "title": "Title Region",
-            "description": "Title Region Description",
-            "serverProcessedContent": {
-                "htmlStrings": {},
-                "searchablePlainTexts": {},
-                "imageSources": {},
-                "links": {}
+            id: BannerWebPartId,
+            instanceId: BannerWebPartId,
+            title: 'Title Region',
+            description: 'Title Region Description',
+            serverProcessedContent: {
+                htmlStrings: {},
+                searchablePlainTexts: {},
+                imageSources: {},
+                links: {}
             },
-            "dataVersion": "1.4",
-            "properties": {
-                "title": "",
-                "imageSourceType": 4,
-                "layoutType": "NoImage",
-                "textAlignment": "Left",
-                "showTopicHeader": false,
-                "showPublishDate": false,
-                "topicHeader": ""
+            dataVersion: '1.4',
+            properties: {
+                title: '',
+                imageSourceType: 4,
+                layoutType: 'NoImage',
+                textAlignment: 'Left',
+                showTopicHeader: false,
+                showPublishDate: false,
+                showTimeToRead: false,
+                topicHeader: ''
             }
         };
         const defaultPageHeader = {
-            "id": BannerWebPartId,
-            "instanceId": BannerWebPartId,
-            "title": "Title Region",
-            "description": "Title Region Description",
-            "serverProcessedContent": {
-                "htmlStrings": {},
-                "searchablePlainTexts": {},
-                "imageSources": {},
-                "links": {}
+            id: BannerWebPartId,
+            instanceId: BannerWebPartId,
+            title: 'Title Region',
+            description: 'Title Region Description',
+            serverProcessedContent: {
+                htmlStrings: {},
+                searchablePlainTexts: {},
+                imageSources: {},
+                links: {}
             },
-            "dataVersion": "1.4",
-            "properties": {
-                "title": "",
-                "imageSourceType": 4,
-                "layoutType": "FullWidthImage",
-                "textAlignment": "Left",
-                "showTopicHeader": false,
-                "showPublishDate": false,
-                "topicHeader": ""
+            dataVersion: '1.4',
+            properties: {
+                title: '',
+                imageSourceType: 4,
+                layoutType: 'FullWidthImage',
+                textAlignment: 'Left',
+                showTopicHeader: false,
+                showPublishDate: false,
+                showTimeToRead: false,
+                topicHeader: ''
             }
         };
         const customPageHeader = {
-            "id": BannerWebPartId,
-            "instanceId": BannerWebPartId,
-            "title": "Title Region",
-            "description": "Title Region Description",
-            "serverProcessedContent": {
-                "htmlStrings": {},
-                "searchablePlainTexts": {},
-                "imageSources": {
-                    "imageSource": ""
+            id: BannerWebPartId,
+            instanceId: BannerWebPartId,
+            title: 'Title Region',
+            description: 'Title Region Description',
+            serverProcessedContent: {
+                htmlStrings: {},
+                searchablePlainTexts: {},
+                imageSources: {
+                    imageSource: ''
                 },
-                "links": {},
-                "customMetadata": {
-                    "imageSource": {
-                        "siteId": "",
-                        "webId": "",
-                        "listId": "",
-                        "uniqueId": ""
+                links: {},
+                customMetadata: {
+                    imageSource: {
+                        siteId: '',
+                        webId: '',
+                        listId: '',
+                        uniqueId: ''
                     }
                 }
             },
-            "dataVersion": "1.4",
-            "properties": {
-                "title": "",
-                "imageSourceType": 2,
-                "layoutType": "FullWidthImage",
-                "textAlignment": "Left",
-                "showTopicHeader": false,
-                "showPublishDate": false,
-                "topicHeader": "",
-                "authors": [],
-                "altText": "",
-                "webId": "",
-                "siteId": "",
-                "listId": "",
-                "uniqueId": "",
-                "translateX": 0,
-                "translateY": 0
+            dataVersion: '1.4',
+            properties: {
+                title: '',
+                imageSourceType: 2,
+                layoutType: 'FullWidthImage',
+                textAlignment: 'Left',
+                showTopicHeader: false,
+                showPublishDate: false,
+                showTimeToRead: false,
+                topicHeader: '',
+                authors: [],
+                altText: '',
+                webId: '',
+                siteId: '',
+                listId: '',
+                uniqueId: '',
+                translateX: 0,
+                translateY: 0
             }
         };
         let header = defaultPageHeader;
         let pageFullName = args.options.pageName.toLowerCase();
-        if (pageFullName.indexOf('.aspx') < 0) {
+        if (!pageFullName.endsWith('.aspx')) {
             pageFullName += '.aspx';
         }
         let canvasContent = "";
@@ -132,7 +137,7 @@ class SpoPageHeaderSetCommand extends SpoCommand {
             let requestOptions = {
                 url: `${args.options.webUrl}/_api/sitepages/pages/GetByUrl('sitepages/${formatting.encodeQueryParameter(pageFullName)}')?$select=IsPageCheckedOutToCurrentUser,Title`,
                 headers: {
-                    'accept': 'application/json;odata=nometadata'
+                    accept: 'application/json;odata=nometadata'
                 },
                 responseType: 'json'
             };
@@ -143,7 +148,7 @@ class SpoPageHeaderSetCommand extends SpoCommand {
                 const requestOptions = {
                     url: `${args.options.webUrl}/_api/sitepages/pages/GetByUrl('sitepages/${formatting.encodeQueryParameter(pageFullName)}')?$expand=ListItemAllFields`,
                     headers: {
-                        'accept': 'application/json;odata=nometadata'
+                        accept: 'application/json;odata=nometadata'
                     },
                     responseType: 'json'
                 };
@@ -186,6 +191,7 @@ class SpoPageHeaderSetCommand extends SpoCommand {
             header.properties.showTopicHeader = args.options.showTopicHeader || false;
             header.properties.topicHeader = args.options.topicHeader || '';
             header.properties.showPublishDate = args.options.showPublishDate || false;
+            header.properties.showTimeToRead = args.options.showTimeToRead || false;
             if (args.options.type !== 'None') {
                 header.properties.layoutType = args.options.layout || 'FullWidthImage';
             }
@@ -298,6 +304,9 @@ class SpoPageHeaderSetCommand extends SpoCommand {
             return request.post(requestOptions);
         }
         catch (err) {
+            if (err.status === 404) {
+                throw new CommandError(`The specified page '${pageFullName}' does not exist.`);
+            }
             this.handleRejectedODataJsonPromise(err);
         }
     }
@@ -323,8 +332,9 @@ _SpoPageHeaderSetCommand_instances = new WeakSet(), _SpoPageHeaderSetCommand_ini
             imageUrl: typeof args.options.imageUrl !== 'undefined',
             topicHeader: typeof args.options.topicHeader !== 'undefined',
             layout: args.options.layout,
-            showTopicHeader: args.options.showTopicHeader,
-            showPublishDate: args.options.showPublishDate,
+            showTopicHeader: !!args.options.showTopicHeader,
+            showPublishDate: !!args.options.showPublishDate,
+            showTimeToRead: !!args.options.showTimeToRead,
             textAlignment: args.options.textAlignment,
             translateX: typeof args.options.translateX !== 'undefined',
             translateY: typeof args.options.translateY !== 'undefined',
@@ -354,9 +364,14 @@ _SpoPageHeaderSetCommand_instances = new WeakSet(), _SpoPageHeaderSetCommand_ini
         option: '--textAlignment [textAlignment]',
         autocomplete: ['Left', 'Center']
     }, {
-        option: '--showTopicHeader'
+        option: '--showTopicHeader [showTopicHeader]',
+        autocomplete: ['true', 'false']
+    }, {
+        option: '--showPublishDate [showPublishDate]',
+        autocomplete: ['true', 'false']
     }, {
-        option: '--showPublishDate'
+        option: '--showTimeToRead [showTimeToRead]',
+        autocomplete: ['true', 'false']
     }, {
         option: '--topicHeader [topicHeader]'
     }, {
@@ -364,10 +379,7 @@ _SpoPageHeaderSetCommand_instances = new WeakSet(), _SpoPageHeaderSetCommand_ini
     });
 }, _SpoPageHeaderSetCommand_initValidators = function _SpoPageHeaderSetCommand_initValidators() {
     this.validators.push(async (args) => {
-        if (args.options.type &&
-            args.options.type !== 'None' &&
-            args.options.type !== 'Default' &&
-            args.options.type !== 'Custom') {
+        if (args.options.type && !['None', 'Default', 'Custom'].includes(args.options.type)) {
             return `${args.options.type} is not a valid type value. Allowed values None|Default|Custom`;
         }
         if (args.options.translateX && isNaN(args.options.translateX)) {
@@ -376,20 +388,16 @@ _SpoPageHeaderSetCommand_instances = new WeakSet(), _SpoPageHeaderSetCommand_ini
         if (args.options.translateY && isNaN(args.options.translateY)) {
             return `${args.options.translateY} is not a valid number`;
         }
-        if (args.options.layout &&
-            args.options.layout !== 'FullWidthImage' &&
-            args.options.layout !== 'NoImage' &&
-            args.options.layout !== 'ColorBlock' &&
-            args.options.layout !== 'CutInShape') {
+        if (args.options.layout && !['FullWidthImage', 'NoImage', 'ColorBlock', 'CutInShape'].includes(args.options.layout)) {
             return `${args.options.layout} is not a valid layout value. Allowed values FullWidthImage|NoImage|ColorBlock|CutInShape`;
         }
-        if (args.options.textAlignment &&
-            args.options.textAlignment !== 'Left' &&
-            args.options.textAlignment !== 'Center') {
+        if (args.options.textAlignment && !['Left', 'Center'].includes(args.options.textAlignment)) {
             return `${args.options.textAlignment} is not a valid textAlignment value. Allowed values Left|Center`;
         }
         return validation.isValidSharePointUrl(args.options.webUrl);
     });
+}, _SpoPageHeaderSetCommand_initTypes = function _SpoPageHeaderSetCommand_initTypes() {
+    this.types.boolean.push('showTimeToRead', 'showPublishDate', 'showTopicHeader');
 };
 export default new SpoPageHeaderSetCommand();
 //# sourceMappingURL=page-header-set.js.map