@pnp/cli-microsoft365 6.3.0-beta.655c566 → 6.3.0-beta.80fcd21

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

@@ -15,8 +15,8 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _SpoCustomActionGetCommand_instances, _SpoCustomActionGetCommand_initTelemetry, _SpoCustomActionGetCommand_initOptions, _SpoCustomActionGetCommand_initValidators, _SpoCustomActionGetCommand_initOptionSets;
 Object.defineProperty(exports, "__esModule", { value: true });
-const request_1 = require("../../../../request");
 const formatting_1 = require("../../../../utils/formatting");
+const spo_1 = require("../../../../utils/spo");
 const validation_1 = require("../../../../utils/validation");
 const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
@@ -38,19 +38,8 @@ class SpoCustomActionGetCommand extends SpoCommand_1.default {
     commandAction(logger, args) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                let customAction;
-                if (args.options.scope && args.options.scope.toLowerCase() !== "all") {
-                    customAction = yield this.getCustomAction(args.options);
-                }
-                else {
-                    customAction = yield this.searchAllScopes(args.options);
-                }
-                if (customAction["odata.null"] === true) {
-                    if (this.verbose) {
-                        logger.logToStderr(`Custom action with id ${args.options.id} not found`);
-                    }
-                }
-                else {
+                const customAction = yield this.getCustomAction(args.options);
+                if (customAction) {
                     logger.log({
                         ClientSideComponentId: customAction.ClientSideComponentId,
                         ClientSideComponentProperties: customAction.ClientSideComponentProperties,
@@ -80,60 +69,22 @@ class SpoCustomActionGetCommand extends SpoCommand_1.default {
         });
     }
     getCustomAction(options) {
-        const filter = options.id ?
-            `('${formatting_1.formatting.encodeQueryParameter(options.id)}')` :
-            `?$filter=Title eq '${formatting_1.formatting.encodeQueryParameter(options.title)}'`;
-        const requestOptions = {
-            url: `${options.webUrl}/_api/${options.scope}/UserCustomActions${filter}`,
-            headers: {
-                accept: 'application/json;odata=nometadata'
-            },
-            responseType: 'json'
-        };
-        if (options.id) {
-            return request_1.default
-                .get(requestOptions)
-                .then((res) => {
-                return Promise.resolve(res);
-            });
-        }
-        return request_1.default
-            .get(requestOptions)
-            .then((res) => {
-            if (res.value.length === 1) {
-                return Promise.resolve(res.value[0]);
+        return __awaiter(this, void 0, void 0, function* () {
+            if (options.id) {
+                const customAction = yield spo_1.spo.getCustomActionById(options.webUrl, options.id, options.scope);
+                if (!customAction) {
+                    throw `No user custom action with id '${options.id}' found`;
+                }
+                return customAction;
             }
-            if (res.value.length === 0) {
-                return Promise.reject(`No user custom action with title '${options.title}' found`);
+            const customActions = yield spo_1.spo.getCustomActions(options.webUrl, options.scope, `Title eq '${formatting_1.formatting.encodeQueryParameter(options.title)}'`);
+            if (customActions.length === 1) {
+                return customActions[0];
             }
-            return Promise.reject(`Multiple user custom actions with title '${options.title}' found. Please disambiguate using IDs: ${res.value.map(a => a.Id).join(', ')}`);
-        });
-    }
-    /**
-     * Get request with `web` scope is send first.
-     * If custom action not found then
-     * another get request is send with `site` scope.
-     */
-    searchAllScopes(options) {
-        return new Promise((resolve, reject) => {
-            options.scope = "Web";
-            this
-                .getCustomAction(options)
-                .then((webResult) => {
-                if (webResult["odata.null"] !== true) {
-                    return resolve(webResult);
-                }
-                options.scope = "Site";
-                this
-                    .getCustomAction(options)
-                    .then((siteResult) => {
-                    return resolve(siteResult);
-                }, (err) => {
-                    reject(err);
-                });
-            }, (err) => {
-                reject(err);
-            });
+            if (customActions.length === 0) {
+                throw `No user custom action with title '${options.title}' found`;
+            }
+            throw `Multiple user custom actions with title '${options.title}' found. Please disambiguate using IDs: ${customActions.map(a => a.Id).join(', ')}`;
         });
     }
     humanizeScope(scope) {

package/dist/m365/spo/commands/customaction/customaction-list.js

@@ -15,7 +15,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _SpoCustomActionListCommand_instances, _SpoCustomActionListCommand_initTelemetry, _SpoCustomActionListCommand_initOptions, _SpoCustomActionListCommand_initValidators;
 Object.defineProperty(exports, "__esModule", { value: true });
-const odata_1 = require("../../../../utils/odata");
+const spo_1 = require("../../../../utils/spo");
 const validation_1 = require("../../../../utils/validation");
 const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
@@ -44,13 +44,7 @@ class SpoCustomActionListCommand extends SpoCommand_1.default {
                     logger.logToStderr(`Attempt to get custom actions list with scope: ${scope}`);
                     logger.logToStderr('');
                 }
-                let customActions;
-                if (scope && scope.toLowerCase() !== "all") {
-                    customActions = yield this.getCustomActions(args.options);
-                }
-                else {
-                    customActions = yield this.searchAllScopes(args.options);
-                }
+                const customActions = yield spo_1.spo.getCustomActions(args.options.webUrl, args.options.scope);
                 if (customActions.length === 0) {
                     if (this.verbose) {
                         logger.logToStderr(`Custom actions not found`);
@@ -68,34 +62,6 @@ class SpoCustomActionListCommand extends SpoCommand_1.default {
             }
         });
     }
-    getCustomActions(options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield odata_1.odata.getAllItems(`${options.webUrl}/_api/${options.scope}/UserCustomActions`);
-            return response;
-        });
-    }
-    /**
-     * Two REST GET requests with `web` and `site` scope are sent.
-     * The results are combined in one array.
-     */
-    searchAllScopes(options) {
-        return new Promise((resolve, reject) => {
-            options.scope = "Web";
-            let webCustomActions = [];
-            this
-                .getCustomActions(options)
-                .then((customActions) => {
-                webCustomActions = customActions;
-                options.scope = "Site";
-                return this.getCustomActions(options);
-            })
-                .then((siteCustomActions) => {
-                resolve(siteCustomActions.concat(webCustomActions));
-            }, (err) => {
-                reject(err);
-            });
-        });
-    }
     humanizeScope(scope) {
         switch (scope) {
             case 2:

package/dist/m365/spo/commands/customaction/customaction-remove.js

@@ -18,6 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const Cli_1 = require("../../../../cli/Cli");
 const request_1 = require("../../../../request");
 const formatting_1 = require("../../../../utils/formatting");
+const spo_1 = require("../../../../utils/spo");
 const validation_1 = require("../../../../utils/validation");
 const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
@@ -74,26 +75,18 @@ class SpoCustomActionRemoveCommand extends SpoCommand_1.default {
         });
     }
     getCustomActionId(options) {
-        if (options.id) {
-            return Promise.resolve(options.id);
-        }
-        const customActionRequestOptions = {
-            url: `${options.webUrl}/_api/${options.scope}/UserCustomActions?$filter=Title eq '${formatting_1.formatting.encodeQueryParameter(options.title)}'`,
-            headers: {
-                accept: 'application/json;odata=nometadata'
-            },
-            responseType: 'json'
-        };
-        return request_1.default
-            .get(customActionRequestOptions)
-            .then((res) => {
-            if (res.value.length === 1) {
-                return Promise.resolve(res.value[0].Id);
+        return __awaiter(this, void 0, void 0, function* () {
+            if (options.id) {
+                return Promise.resolve(options.id);
+            }
+            const customActions = yield spo_1.spo.getCustomActions(options.webUrl, options.scope, `Title eq '${formatting_1.formatting.encodeQueryParameter(options.title)}'`);
+            if (customActions.length === 1) {
+                return customActions[0].Id;
             }
-            if (res.value.length === 0) {
-                return Promise.reject(`No user custom action with title '${options.title}' found`);
+            if (customActions.length === 0) {
+                throw `No user custom action with title '${options.title}' found`;
             }
-            return Promise.reject(`Multiple user custom actions with title '${options.title}' found. Please disambiguate using IDs: ${res.value.map(a => a.Id).join(', ')}`);
+            throw `Multiple user custom actions with title '${options.title}' found. Please disambiguate using IDs: ${customActions.map(a => a.Id).join(', ')}`;
         });
     }
     removeScopedCustomAction(options) {

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

@@ -82,7 +82,6 @@ class SpoFileMoveCommand extends SpoCommand_1.default {
                     responseType: 'json'
                 };
                 const jobInfo = yield request_1.default.post(requestOptions);
-                this.dots = '';
                 const copyJobInfo = jobInfo.value[0];
                 const progressPollInterval = 1800; // 30 * 60; //used previously implemented interval. The API does not provide guidance on what value should be used.
                 yield new Promise((resolve, reject) => {
@@ -94,7 +93,6 @@ class SpoFileMoveCommand extends SpoCommand_1.default {
                             resolve,
                             reject,
                             logger,
-                            dots: this.dots,
                             debug: this.debug,
                             verbose: this.verbose
                         });

package/dist/m365/spo/commands/folder/folder-copy.js

@@ -64,7 +64,6 @@ class SpoFolderCopyCommand extends SpoCommand_1.default {
             };
             try {
                 const jobInfo = yield request_1.default.post(requestOptions);
-                this.dots = '';
                 const copyJobInfo = jobInfo.value[0];
                 const progressPollInterval = 30 * 60; //used previously implemented interval. The API does not provide guidance on what value should be used.
                 yield new Promise((resolve, reject) => {
@@ -76,7 +75,6 @@ class SpoFolderCopyCommand extends SpoCommand_1.default {
                             resolve,
                             reject,
                             logger,
-                            dots: this.dots,
                             debug: this.debug,
                             verbose: this.verbose
                         });

package/dist/m365/spo/commands/folder/folder-move.js

@@ -65,7 +65,6 @@ class SpoFolderMoveCommand extends SpoCommand_1.default {
             };
             try {
                 const jobInfo = yield request_1.default.post(requestOptions);
-                this.dots = '';
                 const copyJobInfo = jobInfo.value[0];
                 const progressPollInterval = 30 * 60; //used previously implemented interval. The API does not provide guidance on what value should be used.
                 yield new Promise((resolve, reject) => {
@@ -77,7 +76,6 @@ class SpoFolderMoveCommand extends SpoCommand_1.default {
                             resolve,
                             reject,
                             logger,
-                            dots: this.dots,
                             debug: this.debug,
                             verbose: this.verbose
                         });

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

@@ -166,7 +166,6 @@ class SpoSiteAddCommand extends SpoCommand_1.default {
     }
     createClassicSite(logger, args) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.dots = '';
             try {
                 this.spoAdminUrl = yield spo_1.spo.getSpoAdminUrl(logger, this.debug);
                 this.context = yield spo_1.spo.ensureFormDigest(this.spoAdminUrl, logger, this.context, this.debug);
@@ -228,7 +227,6 @@ class SpoSiteAddCommand extends SpoCommand_1.default {
                                 reject,
                                 logger,
                                 currentContext: this.context,
-                                dots: this.dots,
                                 verbose: this.verbose,
                                 debug: this.debug
                             });
@@ -362,7 +360,6 @@ class SpoSiteAddCommand extends SpoCommand_1.default {
                             reject,
                             logger,
                             currentContext: this.context,
-                            dots: this.dots,
                             verbose: this.verbose,
                             debug: this.debug
                         });

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

@@ -43,7 +43,6 @@ class SpoSiteRemoveCommand extends SpoCommand_1.default {
         return __awaiter(this, void 0, void 0, function* () {
             const removeSite = () => __awaiter(this, void 0, void 0, function* () {
                 try {
-                    this.dots = '';
                     if (args.options.fromRecycleBin) {
                         yield this.deleteSiteWithoutGroup(logger, args);
                     }
@@ -203,7 +202,6 @@ class SpoSiteRemoveCommand extends SpoCommand_1.default {
                             reject,
                             logger,
                             currentContext: this.context,
-                            dots: this.dots,
                             debug: this.debug,
                             verbose: this.verbose
                         });
@@ -248,7 +246,6 @@ class SpoSiteRemoveCommand extends SpoCommand_1.default {
                             reject,
                             logger,
                             currentContext: this.context,
-                            dots: this.dots,
                             debug: this.debug,
                             verbose: this.verbose
                         });

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

@@ -46,7 +46,6 @@ class SpoSiteSetCommand extends SpoCommand_1.default {
     commandAction(logger, args) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                this.dots = '';
                 this.tenantId = yield spo_1.spo.getTenantId(logger, this.debug);
                 this.spoAdminUrl = yield spo_1.spo.getSpoAdminUrl(logger, this.debug);
                 this.context = yield spo_1.spo.ensureFormDigest(this.spoAdminUrl, logger, this.context, this.debug);
@@ -128,7 +127,6 @@ class SpoSiteSetCommand extends SpoCommand_1.default {
                         reject,
                         logger,
                         currentContext: this.context,
-                        dots: this.dots,
                         debug: this.debug,
                         verbose: this.verbose
                     });

package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-remove.js

@@ -74,7 +74,6 @@ class SpoTenantRecycleBinItemRemoveCommand extends SpoCommand_1.default {
                                     reject,
                                     logger,
                                     currentContext: this.context,
-                                    dots: this.dots,
                                     debug: this.debug,
                                     verbose: this.verbose
                                 });

package/dist/m365/teams/commands/team/team-add.js

@@ -44,7 +44,6 @@ class TeamsTeamAddCommand extends GraphCommand_1.default {
     }
     commandAction(logger, args) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.dots = '';
             let requestBody;
             if (args.options.template) {
                 if (this.verbose) {
@@ -95,7 +94,7 @@ class TeamsTeamAddCommand extends GraphCommand_1.default {
                     }
                     else {
                         setTimeout(() => {
-                            this.waitUntilFinished(requestOptions, resolve, reject, logger, this.dots);
+                            this.waitUntilFinished(requestOptions, resolve, reject, logger);
                         }, this.pollingInterval);
                     }
                 }));
@@ -113,11 +112,7 @@ class TeamsTeamAddCommand extends GraphCommand_1.default {
             }
         });
     }
-    waitUntilFinished(requestOptions, resolve, reject, logger, dots) {
-        if (!this.debug && this.verbose) {
-            dots += '.';
-            process.stdout.write(`\r${dots}`);
-        }
+    waitUntilFinished(requestOptions, resolve, reject, logger) {
         request_1.default
             .get(requestOptions)
             .then((teamsAsyncOperation) => {
@@ -133,7 +128,7 @@ class TeamsTeamAddCommand extends GraphCommand_1.default {
                 return;
             }
             setTimeout(() => {
-                this.waitUntilFinished(requestOptions, resolve, reject, logger, dots);
+                this.waitUntilFinished(requestOptions, resolve, reject, logger);
             }, this.pollingInterval);
         }).catch(err => reject(err));
     }

package/dist/utils/aadUser.js

@@ -0,0 +1,38 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.aadUser = void 0;
+const request_1 = require("../request");
+const formatting_1 = require("./formatting");
+const graphResource = 'https://graph.microsoft.com';
+exports.aadUser = {
+    /**
+     * Retrieve the id of a user by its UPN.
+     * @param upn User UPN.
+     */
+    getUserIdByUpn(upn) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = {
+                url: `${graphResource}/v1.0/users?$filter=userPrincipalName eq '${formatting_1.formatting.encodeQueryParameter(upn)}'&$select=Id`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            const res = yield request_1.default.get(requestOptions);
+            if (res.value.length === 0) {
+                throw Error(`The specified user with user name ${upn} does not exist.`);
+            }
+            return res.value[0].id;
+        });
+    }
+};
+//# sourceMappingURL=aadUser.js.map

package/dist/utils/planner.js

@@ -57,15 +57,12 @@ exports.planner = {
      * @param groupId Owner group ID.
      * @param rosterId Roster ID.
      */
-    getPlanByTitle(title, groupId, rosterId, metadata = 'none') {
+    getPlanByTitle(title, groupId, metadata = 'none') {
         return __awaiter(this, void 0, void 0, function* () {
             let plans = [];
             if (groupId) {
                 plans = yield this.getPlansByGroupId(groupId, metadata);
             }
-            else if (rosterId) {
-                plans = yield this.getPlansByRosterId(rosterId, metadata);
-            }
             const filteredPlans = plans.filter(p => p.title && p.title.toLowerCase() === title.toLowerCase());
             if (!filteredPlans.length) {
                 throw Error(`The specified plan '${title}' does not exist.`);

package/dist/utils/session.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.session = void 0;
+const crypto = require("crypto");
+const cache_1 = require("./cache");
+exports.session = {
+    getId(pid) {
+        const key = `${pid.toString()}_session`;
+        let sessionId = cache_1.cache.getValue(key);
+        if (sessionId) {
+            return sessionId;
+        }
+        sessionId = crypto.randomBytes(24).toString('base64');
+        cache_1.cache.setValue(key, sessionId);
+        return sessionId;
+    }
+};
+//# sourceMappingURL=session.js.map

package/dist/utils/spo.js

@@ -18,6 +18,7 @@ const config_1 = require("../config");
 const base_permissions_1 = require("../m365/spo/base-permissions");
 const request_1 = require("../request");
 const formatting_1 = require("./formatting");
+const odata_1 = require("./odata");
 exports.spo = {
     getRequestDigest(siteUrl) {
         const requestOptions = {
@@ -55,7 +56,7 @@ exports.spo = {
             });
         });
     },
-    waitUntilFinished({ operationId, siteUrl, resolve, reject, logger, currentContext, dots, debug, verbose }) {
+    waitUntilFinished({ operationId, siteUrl, resolve, reject, logger, currentContext, debug, verbose }) {
         exports.spo
             .ensureFormDigest(siteUrl, logger, currentContext, debug)
             .then((res) => {
@@ -63,10 +64,6 @@ exports.spo = {
             if (debug) {
                 logger.logToStderr(`Checking if operation ${operationId} completed...`);
             }
-            if (!debug && verbose) {
-                dots += '.';
-                process.stdout.write(`\r${dots}`);
-            }
             const requestOptions = {
                 url: `${siteUrl}/_vti_bin/client.svc/ProcessQuery`,
                 headers: {
@@ -100,7 +97,6 @@ exports.spo = {
                         reject,
                         logger,
                         currentContext,
-                        dots,
                         debug,
                         verbose
                     });
@@ -108,7 +104,7 @@ exports.spo = {
             }
         });
     },
-    waitUntilCopyJobFinished({ copyJobInfo, siteUrl, pollingInterval, resolve, reject, logger, dots, debug, verbose }) {
+    waitUntilCopyJobFinished({ copyJobInfo, siteUrl, pollingInterval, resolve, reject, logger, debug, verbose }) {
         const requestUrl = `${siteUrl}/_api/site/GetCopyJobProgress`;
         const requestOptions = {
             url: requestUrl,
@@ -118,10 +114,6 @@ exports.spo = {
             data: { "copyJobInfo": copyJobInfo },
             responseType: 'json'
         };
-        if (!debug && verbose) {
-            dots += '.';
-            process.stdout.write(`\r${dots}`);
-        }
         request_1.default
             .post(requestOptions)
             .then((resp) => {
@@ -148,7 +140,7 @@ exports.spo = {
             }
             else {
                 setTimeout(() => {
-                    exports.spo.waitUntilCopyJobFinished({ copyJobInfo, siteUrl, pollingInterval, resolve, reject, logger, dots, debug, verbose });
+                    exports.spo.waitUntilCopyJobFinished({ copyJobInfo, siteUrl, pollingInterval, resolve, reject, logger, debug, verbose });
                 }, pollingInterval);
             }
         });
@@ -484,6 +476,66 @@ exports.spo = {
             const res = yield request_1.default.get(requestOptions);
             return res;
         });
+    },
+    /**
+     * Retrieves a list of Custom Actions from a SharePoint site.
+     * @param webUrl Web url
+     * @param scope The scope of custom actions to retrieve, allowed values "Site", "Web" or "All".
+     * @param filter An OData filter query to limit the results.
+     */
+    getCustomActions(webUrl, scope, filter) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (scope && scope !== "All" && scope !== "Site" && scope !== "Web") {
+                throw `Invalid scope '${scope}'. Allowed values are 'Site', 'Web' or 'All'.`;
+            }
+            const queryString = filter ? `?$filter=${filter}` : "";
+            if (scope && scope !== "All") {
+                return yield odata_1.odata.getAllItems(`${webUrl}/_api/${scope}/UserCustomActions${queryString}`);
+            }
+            const customActions = [
+                ...yield odata_1.odata.getAllItems(`${webUrl}/_api/Site/UserCustomActions${queryString}`),
+                ...yield odata_1.odata.getAllItems(`${webUrl}/_api/Web/UserCustomActions${queryString}`)
+            ];
+            return customActions;
+        });
+    },
+    /**
+     * Retrieves a Custom Actions from a SharePoint site by Id.
+     * @param webUrl Web url
+     * @param id The Id of the Custom Action
+     * @param scope The scope of custom actions to retrieve, allowed values "Site", "Web" or "All".
+     */
+    getCustomActionById(webUrl, id, scope) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (scope && scope !== "All" && scope !== "Site" && scope !== "Web") {
+                throw `Invalid scope '${scope}'. Allowed values are 'Site', 'Web' or 'All'.`;
+            }
+            function getById(webUrl, id, scope) {
+                return __awaiter(this, void 0, void 0, function* () {
+                    const requestOptions = {
+                        url: `${webUrl}/_api/${scope}/UserCustomActions(guid'${id}')`,
+                        headers: {
+                            accept: 'application/json;odata=nometadata'
+                        },
+                        responseType: 'json'
+                    };
+                    const result = yield request_1.default.get(requestOptions);
+                    if (result["odata.null"] === true) {
+                        return undefined;
+                    }
+                    return result;
+                });
+            }
+            if (scope && scope !== "All") {
+                return yield getById(webUrl, id, scope);
+            }
+            const customActionOnWeb = yield getById(webUrl, id, "Web");
+            if (customActionOnWeb) {
+                return customActionOnWeb;
+            }
+            const customActionOnSite = yield getById(webUrl, id, "Site");
+            return customActionOnSite;
+        });
     }
 };
 //# sourceMappingURL=spo.js.map