@pnp/cli-microsoft365 6.0.0-beta.ff232be → 6.1.0-beta.11542c0

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

@@ -1,9 +1,24 @@
 "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 _SpoCustomActionClearCommand_instances, _SpoCustomActionClearCommand_initTelemetry, _SpoCustomActionClearCommand_initOptions, _SpoCustomActionClearCommand_initValidators;
 Object.defineProperty(exports, "__esModule", { value: true });
 const chalk = require("chalk");
-const cli_1 = require("../../../../cli");
+const Cli_1 = require("../../../../cli/Cli");
 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");
 class SpoCustomActionClearCommand extends SpoCommand_1.default {
@@ -13,44 +28,47 @@ class SpoCustomActionClearCommand extends SpoCommand_1.default {
     get description() {
         return 'Deletes all custom actions in the collection';
     }
-    getTelemetryProperties(args) {
-        const telemetryProps = super.getTelemetryProperties(args);
-        telemetryProps.scope = args.options.scope || 'All';
-        telemetryProps.confirm = (!(!args.options.confirm)).toString();
-        return telemetryProps;
+    constructor() {
+        super();
+        _SpoCustomActionClearCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpoCustomActionClearCommand_instances, "m", _SpoCustomActionClearCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpoCustomActionClearCommand_instances, "m", _SpoCustomActionClearCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoCustomActionClearCommand_instances, "m", _SpoCustomActionClearCommand_initValidators).call(this);
     }
-    commandAction(logger, args, cb) {
-        const clearCustomActions = () => {
-            (() => {
-                if (args.options.scope && args.options.scope.toLowerCase() !== "all") {
-                    return this.clearScopedCustomActions(args.options);
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const clearCustomActions = () => __awaiter(this, void 0, void 0, function* () {
+                try {
+                    if (args.options.scope && args.options.scope.toLowerCase() !== "all") {
+                        yield this.clearScopedCustomActions(args.options);
+                    }
+                    else {
+                        yield this.clearAllScopes(args.options);
+                    }
                 }
-                return this.clearAllScopes(args.options);
-            })()
-                .then(_ => cb(), (err) => this.handleRejectedPromise(err, logger, cb));
-        };
-        if (args.options.confirm) {
-            clearCustomActions();
-        }
-        else {
-            cli_1.Cli.prompt({
-                type: 'confirm',
-                name: 'continue',
-                default: false,
-                message: `Are you sure you want to clear all the user custom actions with scope ${chalk.yellow(args.options.scope || 'All')}?`
-            }, (result) => {
-                if (!result.continue) {
-                    cb();
-                }
-                else {
-                    clearCustomActions();
+                catch (err) {
+                    this.handleRejectedPromise(err);
                 }
             });
-        }
+            if (args.options.confirm) {
+                yield clearCustomActions();
+            }
+            else {
+                const result = yield Cli_1.Cli.prompt({
+                    type: 'confirm',
+                    name: 'continue',
+                    default: false,
+                    message: `Are you sure you want to clear all the user custom actions with scope ${chalk.yellow(args.options.scope || 'All')}?`
+                });
+                if (result.continue) {
+                    yield clearCustomActions();
+                }
+            }
+        });
     }
     clearScopedCustomActions(options) {
         const requestOptions = {
-            url: `${options.url}/_api/${options.scope}/UserCustomActions/clear`,
+            url: `${options.webUrl}/_api/${options.scope}/UserCustomActions/clear`,
             headers: {
                 accept: 'application/json;odata=nometadata'
             },
@@ -78,27 +96,26 @@ class SpoCustomActionClearCommand extends SpoCommand_1.default {
             });
         });
     }
-    options() {
-        const options = [
-            {
-                option: '-u, --url <url>'
-            },
-            {
-                option: '-s, --scope [scope]',
-                autocomplete: ['Site', 'Web', 'All']
-            },
-            {
-                option: '--confirm'
-            }
-        ];
-        const parentOptions = super.options();
-        return options.concat(parentOptions);
-    }
-    validate(args) {
-        if (!args.options.url) {
-            return 'Missing required option url';
-        }
-        const isValidUrl = utils_1.validation.isValidSharePointUrl(args.options.url);
+}
+_SpoCustomActionClearCommand_instances = new WeakSet(), _SpoCustomActionClearCommand_initTelemetry = function _SpoCustomActionClearCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            scope: args.options.scope || 'All',
+            confirm: (!(!args.options.confirm)).toString()
+        });
+    });
+}, _SpoCustomActionClearCommand_initOptions = function _SpoCustomActionClearCommand_initOptions() {
+    this.options.unshift({
+        option: '-u, --webUrl <webUrl>'
+    }, {
+        option: '-s, --scope [scope]',
+        autocomplete: ['Site', 'Web', 'All']
+    }, {
+        option: '--confirm'
+    });
+}, _SpoCustomActionClearCommand_initValidators = function _SpoCustomActionClearCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        const isValidUrl = validation_1.validation.isValidSharePointUrl(args.options.webUrl);
         if (typeof isValidUrl === 'string') {
             return isValidUrl;
         }
@@ -109,7 +126,7 @@ class SpoCustomActionClearCommand extends SpoCommand_1.default {
             return `${args.options.scope} is not a valid custom action scope. Allowed values are Site|Web|All`;
         }
         return true;
-    }
-}
+    }));
+};
 module.exports = new SpoCustomActionClearCommand();
 //# sourceMappingURL=customaction-clear.js.map

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

@@ -1,7 +1,23 @@
 "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 _SpoCustomActionGetCommand_instances, _SpoCustomActionGetCommand_initTelemetry, _SpoCustomActionGetCommand_initOptions, _SpoCustomActionGetCommand_initValidators, _SpoCustomActionGetCommand_initOptionSets;
 Object.defineProperty(exports, "__esModule", { value: true });
 const request_1 = require("../../../../request");
-const utils_1 = require("../../../../utils");
+const formatting_1 = require("../../../../utils/formatting");
+const validation_1 = require("../../../../utils/validation");
 const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
 class SpoCustomActionGetCommand extends SpoCommand_1.default {
@@ -11,59 +27,87 @@ class SpoCustomActionGetCommand extends SpoCommand_1.default {
     get description() {
         return 'Gets details for the specified custom action';
     }
-    getTelemetryProperties(args) {
-        const telemetryProps = super.getTelemetryProperties(args);
-        telemetryProps.scope = args.options.scope || 'All';
-        return telemetryProps;
+    constructor() {
+        super();
+        _SpoCustomActionGetCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpoCustomActionGetCommand_instances, "m", _SpoCustomActionGetCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpoCustomActionGetCommand_instances, "m", _SpoCustomActionGetCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoCustomActionGetCommand_instances, "m", _SpoCustomActionGetCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _SpoCustomActionGetCommand_instances, "m", _SpoCustomActionGetCommand_initOptionSets).call(this);
     }
-    commandAction(logger, args, cb) {
-        (() => {
-            if (args.options.scope && args.options.scope.toLowerCase() !== "all") {
-                return this.getCustomAction(args.options);
-            }
-            return this.searchAllScopes(args.options);
-        })()
-            .then((customAction) => {
-            if (customAction["odata.null"] === true) {
-                if (this.verbose) {
-                    logger.logToStderr(`Custom action with id ${args.options.id} not found`);
+    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 {
+                    logger.log({
+                        ClientSideComponentId: customAction.ClientSideComponentId,
+                        ClientSideComponentProperties: customAction.ClientSideComponentProperties,
+                        CommandUIExtension: customAction.CommandUIExtension,
+                        Description: customAction.Description,
+                        Group: customAction.Group,
+                        Id: customAction.Id,
+                        ImageUrl: customAction.ImageUrl,
+                        Location: customAction.Location,
+                        Name: customAction.Name,
+                        RegistrationId: customAction.RegistrationId,
+                        RegistrationType: customAction.RegistrationType,
+                        Rights: JSON.stringify(customAction.Rights),
+                        Scope: this.humanizeScope(customAction.Scope),
+                        ScriptBlock: customAction.ScriptBlock,
+                        ScriptSrc: customAction.ScriptSrc,
+                        Sequence: customAction.Sequence,
+                        Title: customAction.Title,
+                        Url: customAction.Url,
+                        VersionOfUserCustomAction: customAction.VersionOfUserCustomAction
+                    });
                 }
             }
-            else {
-                logger.log({
-                    ClientSideComponentId: customAction.ClientSideComponentId,
-                    ClientSideComponentProperties: customAction.ClientSideComponentProperties,
-                    CommandUIExtension: customAction.CommandUIExtension,
-                    Description: customAction.Description,
-                    Group: customAction.Group,
-                    Id: customAction.Id,
-                    ImageUrl: customAction.ImageUrl,
-                    Location: customAction.Location,
-                    Name: customAction.Name,
-                    RegistrationId: customAction.RegistrationId,
-                    RegistrationType: customAction.RegistrationType,
-                    Rights: JSON.stringify(customAction.Rights),
-                    Scope: this.humanizeScope(customAction.Scope),
-                    ScriptBlock: customAction.ScriptBlock,
-                    ScriptSrc: customAction.ScriptSrc,
-                    Sequence: customAction.Sequence,
-                    Title: customAction.Title,
-                    Url: customAction.Url,
-                    VersionOfUserCustomAction: customAction.VersionOfUserCustomAction
-                });
+            catch (err) {
+                this.handleRejectedPromise(err);
             }
-            cb();
-        }, (err) => this.handleRejectedPromise(err, logger, cb));
+        });
     }
     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.url}/_api/${options.scope}/UserCustomActions('${encodeURIComponent(options.id)}')`,
+            url: `${options.webUrl}/_api/${options.scope}/UserCustomActions${filter}`,
             headers: {
                 accept: 'application/json;odata=nometadata'
             },
             responseType: 'json'
         };
-        return request_1.default.get(requestOptions);
+        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]);
+            }
+            if (res.value.length === 0) {
+                return Promise.reject(`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(', ')}`);
+        });
     }
     /**
      * Get request with `web` scope is send first.
@@ -101,28 +145,32 @@ class SpoCustomActionGetCommand extends SpoCommand_1.default {
         }
         return `${scope}`;
     }
-    options() {
-        const options = [
-            {
-                option: '-i, --id <id>'
-            },
-            {
-                option: '-u, --url <url>'
-            },
-            {
-                option: '-s, --scope [scope]',
-                autocomplete: ['Site', 'Web', 'All']
-            }
-        ];
-        const parentOptions = super.options();
-        return options.concat(parentOptions);
-    }
-    validate(args) {
-        if (utils_1.validation.isValidGuid(args.options.id) === false) {
+}
+_SpoCustomActionGetCommand_instances = new WeakSet(), _SpoCustomActionGetCommand_initTelemetry = function _SpoCustomActionGetCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            scope: args.options.scope || 'All'
+        });
+    });
+}, _SpoCustomActionGetCommand_initOptions = function _SpoCustomActionGetCommand_initOptions() {
+    this.options.unshift({
+        option: '-i, --id [id]'
+    }, {
+        option: '-t, --title [title]'
+    }, {
+        option: '-u, --webUrl <webUrl>'
+    }, {
+        option: '-s, --scope [scope]',
+        autocomplete: ['Site', 'Web', 'All']
+    });
+}, _SpoCustomActionGetCommand_initValidators = function _SpoCustomActionGetCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        if (args.options.id && validation_1.validation.isValidGuid(args.options.id) === false) {
             return `${args.options.id} is not valid. Custom action id (Guid) expected.`;
         }
-        if (utils_1.validation.isValidSharePointUrl(args.options.url) !== true) {
-            return 'Missing required option url';
+        const isValidUrl = validation_1.validation.isValidSharePointUrl(args.options.webUrl);
+        if (typeof isValidUrl === 'string') {
+            return isValidUrl;
         }
         if (args.options.scope) {
             if (args.options.scope !== 'Site' &&
@@ -132,7 +180,9 @@ class SpoCustomActionGetCommand extends SpoCommand_1.default {
             }
         }
         return true;
-    }
-}
+    }));
+}, _SpoCustomActionGetCommand_initOptionSets = function _SpoCustomActionGetCommand_initOptionSets() {
+    this.optionSets.push({ options: ['id', 'title'] });
+};
 module.exports = new SpoCustomActionGetCommand();
 //# sourceMappingURL=customaction-get.js.map

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

@@ -1,7 +1,22 @@
 "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 _SpoCustomActionListCommand_instances, _SpoCustomActionListCommand_initTelemetry, _SpoCustomActionListCommand_initOptions, _SpoCustomActionListCommand_initValidators;
 Object.defineProperty(exports, "__esModule", { value: true });
-const request_1 = require("../../../../request");
-const utils_1 = require("../../../../utils");
+const odata_1 = require("../../../../utils/odata");
+const validation_1 = require("../../../../utils/validation");
 const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
 class SpoCustomActionListCommand extends SpoCommand_1.default {
@@ -11,58 +26,52 @@ class SpoCustomActionListCommand extends SpoCommand_1.default {
     get description() {
         return 'Lists all user custom actions at the given scope';
     }
-    getTelemetryProperties(args) {
-        const telemetryProps = super.getTelemetryProperties(args);
-        telemetryProps.scope = args.options.scope || 'All';
-        return telemetryProps;
-    }
     defaultProperties() {
         return ['Name', 'Location', 'Scope', 'Id'];
     }
-    commandAction(logger, args, cb) {
-        const scope = args.options.scope ? args.options.scope : 'All';
-        (() => {
-            if (this.debug) {
-                logger.logToStderr(`Attempt to get custom actions list with scope: ${scope}`);
-                logger.logToStderr('');
-            }
-            if (scope && scope.toLowerCase() !== "all") {
-                return this.getCustomActions(args.options);
-            }
-            return this.searchAllScopes(args.options);
-        })()
-            .then((customActions) => {
-            if (customActions.length === 0) {
-                if (this.verbose) {
-                    logger.logToStderr(`Custom actions not found`);
+    constructor() {
+        super();
+        _SpoCustomActionListCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpoCustomActionListCommand_instances, "m", _SpoCustomActionListCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpoCustomActionListCommand_instances, "m", _SpoCustomActionListCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoCustomActionListCommand_instances, "m", _SpoCustomActionListCommand_initValidators).call(this);
+    }
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const scope = args.options.scope ? args.options.scope : 'All';
+                if (this.debug) {
+                    logger.logToStderr(`Attempt to get custom actions list with scope: ${scope}`);
+                    logger.logToStderr('');
                 }
-            }
-            else {
-                if (args.options.output !== 'json') {
-                    customActions.forEach(a => a.Scope = this.humanizeScope(a.Scope));
+                let customActions;
+                if (scope && scope.toLowerCase() !== "all") {
+                    customActions = yield this.getCustomActions(args.options);
+                }
+                else {
+                    customActions = yield this.searchAllScopes(args.options);
+                }
+                if (customActions.length === 0) {
+                    if (this.verbose) {
+                        logger.logToStderr(`Custom actions not found`);
+                    }
+                }
+                else {
+                    if (args.options.output !== 'json') {
+                        customActions.forEach(a => a.Scope = this.humanizeScope(a.Scope));
+                    }
+                    logger.log(customActions);
                 }
-                logger.log(customActions);
             }
-            cb();
-        }, (err) => this.handleRejectedPromise(err, logger, cb));
+            catch (err) {
+                this.handleRejectedPromise(err);
+            }
+        });
     }
     getCustomActions(options) {
-        const requestOptions = {
-            url: `${options.url}/_api/${options.scope}/UserCustomActions`,
-            headers: {
-                accept: 'application/json;odata=nometadata'
-            },
-            responseType: 'json'
-        };
-        return new Promise((resolve, reject) => {
-            request_1.default
-                .get(requestOptions)
-                .then((response) => {
-                resolve(response.value);
-            })
-                .catch((error) => {
-                reject(error);
-            });
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield odata_1.odata.getAllItems(`${options.webUrl}/_api/${options.scope}/UserCustomActions`);
+            return response;
         });
     }
     /**
@@ -96,22 +105,25 @@ class SpoCustomActionListCommand extends SpoCommand_1.default {
         }
         return `${scope}`;
     }
-    options() {
-        const options = [
-            {
-                option: '-u, --url <url>'
-            },
-            {
-                option: '-s, --scope [scope]',
-                autocomplete: ['Site', 'Web', 'All']
-            }
-        ];
-        const parentOptions = super.options();
-        return options.concat(parentOptions);
-    }
-    validate(args) {
-        if (utils_1.validation.isValidSharePointUrl(args.options.url) !== true) {
-            return 'Missing required option url';
+}
+_SpoCustomActionListCommand_instances = new WeakSet(), _SpoCustomActionListCommand_initTelemetry = function _SpoCustomActionListCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            scope: args.options.scope || 'All'
+        });
+    });
+}, _SpoCustomActionListCommand_initOptions = function _SpoCustomActionListCommand_initOptions() {
+    this.options.unshift({
+        option: '-u, --webUrl <webUrl>'
+    }, {
+        option: '-s, --scope [scope]',
+        autocomplete: ['Site', 'Web', 'All']
+    });
+}, _SpoCustomActionListCommand_initValidators = function _SpoCustomActionListCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        const isValidUrl = validation_1.validation.isValidSharePointUrl(args.options.webUrl);
+        if (typeof isValidUrl === 'string') {
+            return isValidUrl;
         }
         if (args.options.scope) {
             if (args.options.scope !== 'Site' &&
@@ -121,7 +133,7 @@ class SpoCustomActionListCommand extends SpoCommand_1.default {
             }
         }
         return true;
-    }
-}
+    }));
+};
 module.exports = new SpoCustomActionListCommand();
 //# sourceMappingURL=customaction-list.js.map