@pnp/cli-microsoft365 6.0.0-beta.d4d33ed → 6.0.0-beta.da01a44

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

@@ -1,228 +1,236 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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 _SpoPageClientSideWebPartAddCommand_instances, _SpoPageClientSideWebPartAddCommand_initTelemetry, _SpoPageClientSideWebPartAddCommand_initOptions, _SpoPageClientSideWebPartAddCommand_initValidators;
 Object.defineProperty(exports, "__esModule", { value: true });
 const util_1 = require("util");
 const uuid_1 = require("uuid");
 const request_1 = require("../../../../request");
-const utils_1 = require("../../../../utils");
+const validation_1 = require("../../../../utils/validation");
 const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
 const StandardWebPartTypes_1 = require("../../StandardWebPartTypes");
 class SpoPageClientSideWebPartAddCommand extends SpoCommand_1.default {
+    constructor() {
+        super();
+        _SpoPageClientSideWebPartAddCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpoPageClientSideWebPartAddCommand_instances, "m", _SpoPageClientSideWebPartAddCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpoPageClientSideWebPartAddCommand_instances, "m", _SpoPageClientSideWebPartAddCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoPageClientSideWebPartAddCommand_instances, "m", _SpoPageClientSideWebPartAddCommand_initValidators).call(this);
+    }
     get name() {
         return commands_1.default.PAGE_CLIENTSIDEWEBPART_ADD;
     }
     get description() {
         return 'Adds a client-side web part to a modern page';
     }
-    getTelemetryProperties(args) {
-        const telemetryProps = super.getTelemetryProperties(args);
-        telemetryProps.standardWebPart = args.options.standardWebPart;
-        telemetryProps.webPartData = typeof args.options.webPartData !== 'undefined';
-        telemetryProps.webPartId = typeof args.options.webPartId !== 'undefined';
-        telemetryProps.webPartProperties = typeof args.options.webPartProperties !== 'undefined';
-        telemetryProps.section = typeof args.options.section !== 'undefined';
-        telemetryProps.column = typeof args.options.column !== 'undefined';
-        telemetryProps.order = typeof args.options.order !== 'undefined';
-        return telemetryProps;
-    }
-    commandAction(logger, args, cb) {
-        let canvasContent;
-        let layoutWebpartsContent = "";
-        let authorByline = [""];
-        let bannerImageUrl = "";
-        let description = "";
-        let title = "";
-        let topicHeader = "";
-        const pageData = {};
-        let pageFullName = args.options.pageName;
-        if (args.options.pageName.indexOf('.aspx') < 0) {
-            pageFullName += '.aspx';
-        }
-        if (this.verbose) {
-            logger.logToStderr(`Retrieving page information...`);
-        }
-        const requestOptions = {
-            url: `${args.options.webUrl}/_api/sitepages/pages/GetByUrl('sitepages/${encodeURIComponent(pageFullName)}')`,
-            headers: {
-                'accept': 'application/json;odata=nometadata'
-            },
-            responseType: 'json'
-        };
-        request_1.default
-            .get(requestOptions)
-            .then((res) => {
-            if (res.IsPageCheckedOutToCurrentUser) {
-                return Promise.resolve(res);
-            }
-            const requestOptions = {
-                url: `${args.options.webUrl}/_api/sitepages/pages/GetByUrl('sitepages/${encodeURIComponent(pageFullName)}')/checkoutpage`,
-                headers: {
-                    'accept': 'application/json;odata=nometadata'
-                },
-                responseType: 'json'
-            };
-            return request_1.default.post(requestOptions);
-        })
-            .then((res) => {
-            if (res) {
-                layoutWebpartsContent = res.LayoutWebpartsContent;
-                authorByline = res.AuthorByline;
-                bannerImageUrl = res.BannerImageUrl;
-                description = res.Description;
-                title = res.Title;
-                topicHeader = res.TopicHeader;
-            }
-            if (this.verbose) {
-                logger.logToStderr(`Retrieving definition for web part ${args.options.webPartId ||
-                    args.options.standardWebPart}...`);
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let canvasContent;
+            let layoutWebpartsContent = "";
+            let authorByline = [""];
+            let bannerImageUrl = "";
+            let description = "";
+            let title = "";
+            let topicHeader = "";
+            const pageData = {};
+            let pageFullName = args.options.pageName;
+            if (args.options.pageName.indexOf('.aspx') < 0) {
+                pageFullName += '.aspx';
             }
-            canvasContent = JSON.parse(res.CanvasContent1 || "[{\"controlType\":0,\"pageSettingsSlice\":{\"isDefaultDescription\":true,\"isDefaultThumbnail\":true}}]");
-            // Get the WebPart according to arguments
-            return this.getWebPart(logger, args);
-        })
-            .then((webPart) => {
             if (this.verbose) {
-                logger.logToStderr(`Setting client-side web part layout and properties...`);
+                logger.logToStderr(`Retrieving page information...`);
             }
-            this.setWebPartProperties(webPart, logger, args);
-            // if no section exists (canvasContent array only has 1 default object), add a default section (1 col)
-            if (canvasContent.length === 1) {
-                const defaultSection = {
-                    position: {
-                        controlIndex: 1,
-                        sectionIndex: 1,
-                        zoneIndex: 1,
-                        sectionFactor: 12,
-                        layoutIndex: 1
+            try {
+                let requestOptions = {
+                    url: `${args.options.webUrl}/_api/sitepages/pages/GetByUrl('sitepages/${encodeURIComponent(pageFullName)}')`,
+                    headers: {
+                        'accept': 'application/json;odata=nometadata'
                     },
-                    emphasis: {},
-                    displayMode: 2
+                    responseType: 'json'
                 };
-                canvasContent.unshift(defaultSection);
-            }
-            // get unique zoneIndex values given each section can have 1 or more
-            // columns each assigned to the zoneIndex of the corresponding section
-            const zoneIndices = canvasContent
-                .filter(c => c.position)
-                .map(c => c.position.zoneIndex)
-                .filter((value, index, array) => {
-                return array.indexOf(value) === index;
-            })
-                .sort((a, b) => a - b);
-            // get section number. if not specified, get the last section
-            const section = args.options.section || zoneIndices.length;
-            if (section > zoneIndices.length) {
-                return Promise.reject(`Invalid section '${section}'`);
-            }
-            // zoneIndex that represents the section where the web part should be added
-            const zoneIndex = zoneIndices[section - 1];
-            const column = args.options.column || 1;
-            // we need the index of the control in the array so that we know which
-            // item to replace or where to add the web part
-            const controlIndex = canvasContent
-                .findIndex(c => c.position &&
-                c.position.zoneIndex === zoneIndex &&
-                c.position.sectionIndex === column);
-            if (controlIndex === -1) {
-                return Promise.reject(`Invalid column '${args.options.column}'`);
-            }
-            // get the first control that matches section and column
-            // if it's a empty column, it should be replaced with the web part
-            // if it's a web part, then we need to determine if there are other
-            // web parts and where in the array the new web part should be put
-            const control = canvasContent[controlIndex];
-            const webPartControl = this.extend({
-                controlType: 3,
-                displayMode: 2,
-                id: webPart.id,
-                position: Object.assign({}, control.position),
-                webPartId: webPart.webPartId,
-                emphasis: {}
-            }, webPart);
-            if (!control.controlType) {
-                // it's an empty column so we need to replace it with the web part
-                // ignore the specified order
-                webPartControl.position.controlIndex = 1;
-                canvasContent.splice(controlIndex, 1, webPartControl);
-            }
-            else {
-                // it's a web part so we should find out where to put the web part in
-                // the array of page controls
-                // get web part index values to determine where to add the current
-                // web part
-                const controlIndices = canvasContent
-                    .filter(c => c.position &&
-                    c.position.zoneIndex === zoneIndex &&
-                    c.position.sectionIndex === column)
-                    .map(c => c.position.controlIndex)
+                let page = yield request_1.default.get(requestOptions);
+                if (!page.IsPageCheckedOutToCurrentUser) {
+                    const requestOptions = {
+                        url: `${args.options.webUrl}/_api/sitepages/pages/GetByUrl('sitepages/${encodeURIComponent(pageFullName)}')/checkoutpage`,
+                        headers: {
+                            'accept': 'application/json;odata=nometadata'
+                        },
+                        responseType: 'json'
+                    };
+                    page = yield request_1.default.post(requestOptions);
+                }
+                if (page) {
+                    layoutWebpartsContent = page.LayoutWebpartsContent;
+                    authorByline = page.AuthorByline;
+                    bannerImageUrl = page.BannerImageUrl;
+                    description = page.Description;
+                    title = page.Title;
+                    topicHeader = page.TopicHeader;
+                }
+                if (this.verbose) {
+                    logger.logToStderr(`Retrieving definition for web part ${args.options.webPartId ||
+                        args.options.standardWebPart}...`);
+                }
+                canvasContent = JSON.parse(page.CanvasContent1 || "[{\"controlType\":0,\"pageSettingsSlice\":{\"isDefaultDescription\":true,\"isDefaultThumbnail\":true}}]");
+                // Get the WebPart according to arguments
+                const webPart = yield this.getWebPart(logger, args);
+                if (this.verbose) {
+                    logger.logToStderr(`Setting client-side web part layout and properties...`);
+                }
+                this.setWebPartProperties(webPart, logger, args);
+                // if no section exists (canvasContent array only has 1 default object), add a default section (1 col)
+                if (canvasContent.length === 1) {
+                    const defaultSection = {
+                        position: {
+                            controlIndex: 1,
+                            sectionIndex: 1,
+                            zoneIndex: 1,
+                            sectionFactor: 12,
+                            layoutIndex: 1
+                        },
+                        emphasis: {},
+                        displayMode: 2
+                    };
+                    canvasContent.unshift(defaultSection);
+                }
+                // get unique zoneIndex values given each section can have 1 or more
+                // columns each assigned to the zoneIndex of the corresponding section
+                const zoneIndices = canvasContent
+                    .filter(c => c.position)
+                    .map(c => c.position.zoneIndex)
+                    .filter((value, index, array) => {
+                    return array.indexOf(value) === index;
+                })
                     .sort((a, b) => a - b);
-                // get the controlIndex of the web part before each the new web part
-                // should be added
-                if (!args.options.order ||
-                    args.options.order > controlIndices.length) {
-                    const controlIndex = controlIndices.pop();
-                    const webPartIndex = canvasContent
-                        .findIndex(c => c.position &&
-                        c.position.zoneIndex === zoneIndex &&
-                        c.position.sectionIndex === column &&
-                        c.position.controlIndex === controlIndex);
-                    canvasContent.splice(webPartIndex + 1, 0, webPartControl);
+                // get section number. if not specified, get the last section
+                const section = args.options.section || zoneIndices.length;
+                if (section > zoneIndices.length) {
+                    return Promise.reject(`Invalid section '${section}'`);
+                }
+                // zoneIndex that represents the section where the web part should be added
+                const zoneIndex = zoneIndices[section - 1];
+                const column = args.options.column || 1;
+                // we need the index of the control in the array so that we know which
+                // item to replace or where to add the web part
+                const controlIndex = canvasContent
+                    .findIndex(c => c.position &&
+                    c.position.zoneIndex === zoneIndex &&
+                    c.position.sectionIndex === column);
+                if (controlIndex === -1) {
+                    return Promise.reject(`Invalid column '${args.options.column}'`);
+                }
+                // get the first control that matches section and column
+                // if it's a empty column, it should be replaced with the web part
+                // if it's a web part, then we need to determine if there are other
+                // web parts and where in the array the new web part should be put
+                const control = canvasContent[controlIndex];
+                const webPartControl = this.extend({
+                    controlType: 3,
+                    displayMode: 2,
+                    id: webPart.id,
+                    position: Object.assign({}, control.position),
+                    webPartId: webPart.webPartId,
+                    emphasis: {}
+                }, webPart);
+                if (!control.controlType) {
+                    // it's an empty column so we need to replace it with the web part
+                    // ignore the specified order
+                    webPartControl.position.controlIndex = 1;
+                    canvasContent.splice(controlIndex, 1, webPartControl);
                 }
                 else {
-                    const controlIndex = controlIndices[args.options.order - 1];
-                    const webPartIndex = canvasContent
-                        .findIndex(c => c.position &&
+                    // it's a web part so we should find out where to put the web part in
+                    // the array of page controls
+                    // get web part index values to determine where to add the current
+                    // web part
+                    const controlIndices = canvasContent
+                        .filter(c => c.position &&
+                        c.position.zoneIndex === zoneIndex &&
+                        c.position.sectionIndex === column)
+                        .map(c => c.position.controlIndex)
+                        .sort((a, b) => a - b);
+                    // get the controlIndex of the web part before each the new web part
+                    // should be added
+                    if (!args.options.order ||
+                        args.options.order > controlIndices.length) {
+                        const controlIndex = controlIndices.pop();
+                        const webPartIndex = canvasContent
+                            .findIndex(c => c.position &&
+                            c.position.zoneIndex === zoneIndex &&
+                            c.position.sectionIndex === column &&
+                            c.position.controlIndex === controlIndex);
+                        canvasContent.splice(webPartIndex + 1, 0, webPartControl);
+                    }
+                    else {
+                        const controlIndex = controlIndices[args.options.order - 1];
+                        const webPartIndex = canvasContent
+                            .findIndex(c => c.position &&
+                            c.position.zoneIndex === zoneIndex &&
+                            c.position.sectionIndex === column &&
+                            c.position.controlIndex === controlIndex);
+                        canvasContent.splice(webPartIndex, 0, webPartControl);
+                    }
+                    // reset order to ensure there are no gaps
+                    const webPartsInColumn = canvasContent
+                        .filter(c => c.position &&
                         c.position.zoneIndex === zoneIndex &&
-                        c.position.sectionIndex === column &&
-                        c.position.controlIndex === controlIndex);
-                    canvasContent.splice(webPartIndex, 0, webPartControl);
+                        c.position.sectionIndex === column);
+                    let i = 1;
+                    webPartsInColumn.forEach(w => {
+                        w.position.controlIndex = i++;
+                    });
                 }
-                // reset order to ensure there are no gaps
-                const webPartsInColumn = canvasContent
-                    .filter(c => c.position &&
-                    c.position.zoneIndex === zoneIndex &&
-                    c.position.sectionIndex === column);
-                let i = 1;
-                webPartsInColumn.forEach(w => {
-                    w.position.controlIndex = i++;
-                });
-            }
-            if (authorByline) {
-                pageData.AuthorByline = authorByline;
-            }
-            if (bannerImageUrl) {
-                pageData.BannerImageUrl = bannerImageUrl;
-            }
-            if (description) {
-                pageData.Description = description;
-            }
-            if (title) {
-                pageData.Title = title;
-            }
-            if (topicHeader) {
-                pageData.TopicHeader = topicHeader;
-            }
-            if (layoutWebpartsContent) {
-                pageData.LayoutWebpartsContent = layoutWebpartsContent;
+                if (authorByline) {
+                    pageData.AuthorByline = authorByline;
+                }
+                if (bannerImageUrl) {
+                    pageData.BannerImageUrl = bannerImageUrl;
+                }
+                if (description) {
+                    pageData.Description = description;
+                }
+                if (title) {
+                    pageData.Title = title;
+                }
+                if (topicHeader) {
+                    pageData.TopicHeader = topicHeader;
+                }
+                if (layoutWebpartsContent) {
+                    pageData.LayoutWebpartsContent = layoutWebpartsContent;
+                }
+                if (canvasContent) {
+                    pageData.CanvasContent1 = JSON.stringify(canvasContent);
+                }
+                requestOptions = {
+                    url: `${args.options.webUrl}/_api/sitepages/pages/GetByUrl('sitepages/${encodeURIComponent(pageFullName)}')/SavePageAsDraft`,
+                    headers: {
+                        'X-HTTP-Method': 'MERGE',
+                        'IF-MATCH': '*',
+                        'content-type': 'application/json;odata=nometadata',
+                        accept: 'application/json;odata=nometadata'
+                    },
+                    data: pageData,
+                    responseType: 'json'
+                };
+                yield request_1.default.post(requestOptions);
             }
-            if (canvasContent) {
-                pageData.CanvasContent1 = JSON.stringify(canvasContent);
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
             }
-            const requestOptions = {
-                url: `${args.options.webUrl}/_api/sitepages/pages/GetByUrl('sitepages/${encodeURIComponent(pageFullName)}')/SavePageAsDraft`,
-                headers: {
-                    'X-HTTP-Method': 'MERGE',
-                    'IF-MATCH': '*',
-                    'content-type': 'application/json;odata=nometadata',
-                    accept: 'application/json;odata=nometadata'
-                },
-                data: pageData,
-                responseType: 'json'
-            };
-            return request_1.default.post(requestOptions);
-        })
-            .then(_ => cb())
-            .catch((err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+        });
     }
     getWebPart(logger, args) {
         return new Promise((resolve, reject) => {
@@ -319,47 +327,48 @@ class SpoPageClientSideWebPartAddCommand extends SpoCommand_1.default {
             return t;
         }, target);
     }
-    options() {
-        const options = [
-            {
-                option: '-u, --webUrl <webUrl>'
-            },
-            {
-                option: '-n, --pageName <pageName>'
-            },
-            {
-                option: '--standardWebPart [standardWebPart]'
-            },
-            {
-                option: '--webPartId [webPartId]'
-            },
-            {
-                option: '--webPartProperties [webPartProperties]'
-            },
-            {
-                option: '--webPartData [webPartData]'
-            },
-            {
-                option: '--section [section]'
-            },
-            {
-                option: '--column [column]'
-            },
-            {
-                option: '--order [order]'
-            }
-        ];
-        const parentOptions = super.options();
-        return options.concat(parentOptions);
-    }
-    validate(args) {
+}
+_SpoPageClientSideWebPartAddCommand_instances = new WeakSet(), _SpoPageClientSideWebPartAddCommand_initTelemetry = function _SpoPageClientSideWebPartAddCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            standardWebPart: args.options.standardWebPart,
+            webPartData: typeof args.options.webPartData !== 'undefined',
+            webPartId: typeof args.options.webPartId !== 'undefined',
+            webPartProperties: typeof args.options.webPartProperties !== 'undefined',
+            section: typeof args.options.section !== 'undefined',
+            column: typeof args.options.column !== 'undefined',
+            order: typeof args.options.order !== 'undefined'
+        });
+    });
+}, _SpoPageClientSideWebPartAddCommand_initOptions = function _SpoPageClientSideWebPartAddCommand_initOptions() {
+    this.options.unshift({
+        option: '-u, --webUrl <webUrl>'
+    }, {
+        option: '-n, --pageName <pageName>'
+    }, {
+        option: '--standardWebPart [standardWebPart]'
+    }, {
+        option: '--webPartId [webPartId]'
+    }, {
+        option: '--webPartProperties [webPartProperties]'
+    }, {
+        option: '--webPartData [webPartData]'
+    }, {
+        option: '--section [section]'
+    }, {
+        option: '--column [column]'
+    }, {
+        option: '--order [order]'
+    });
+}, _SpoPageClientSideWebPartAddCommand_initValidators = function _SpoPageClientSideWebPartAddCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
         if (!args.options.standardWebPart && !args.options.webPartId) {
             return 'Specify either the standardWebPart or the webPartId option';
         }
         if (args.options.standardWebPart && args.options.webPartId) {
             return 'Specify either the standardWebPart or the webPartId option but not both';
         }
-        if (args.options.webPartId && !utils_1.validation.isValidGuid(args.options.webPartId)) {
+        if (args.options.webPartId && !validation_1.validation.isValidGuid(args.options.webPartId)) {
             return `The webPartId '${args.options.webPartId}' is not a valid GUID`;
         }
         if (args.options.standardWebPart && !StandardWebPartTypes_1.StandardWebPartUtils.isValidStandardWebPartType(args.options.standardWebPart)) {
@@ -392,8 +401,8 @@ class SpoPageClientSideWebPartAddCommand extends SpoCommand_1.default {
         if (args.options.column && (!(0, util_1.isNumber)(args.options.column) || args.options.column < 1)) {
             return 'The value of parameter column must be 1 or higher';
         }
-        return utils_1.validation.isValidSharePointUrl(args.options.webUrl);
-    }
-}
+        return validation_1.validation.isValidSharePointUrl(args.options.webUrl);
+    }));
+};
 module.exports = new SpoPageClientSideWebPartAddCommand();
 //# sourceMappingURL=page-clientsidewebpart-add.js.map