@pnp/cli-microsoft365 6.0.0-beta.6a854fc → 6.0.0-beta.78fdd2c

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

@@ -1,21 +1,39 @@
 "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 SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
 class SpoCustomActionGetCommand extends SpoCommand_1.default {
+    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);
+    }
     get name() {
         return commands_1.default.CUSTOMACTION_GET;
     }
     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;
-    }
     commandAction(logger, args, cb) {
         (() => {
             if (args.options.scope && args.options.scope.toLowerCase() !== "all") {
@@ -56,14 +74,34 @@ class SpoCustomActionGetCommand extends SpoCommand_1.default {
         }, (err) => this.handleRejectedPromise(err, logger, cb));
     }
     getCustomAction(options) {
+        const filter = options.id ?
+            `('${encodeURIComponent(options.id)}')` :
+            `?$filter=Title eq '${encodeURIComponent(options.title)}'`;
         const requestOptions = {
-            url: `${options.url}/_api/${options.scope}/UserCustomActions('${encodeURIComponent(options.id)}')`,
+            url: `${options.url}/_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,24 +139,27 @@ 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, --url <url>'
+    }, {
+        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 && utils_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) {
@@ -132,7 +173,9 @@ class SpoCustomActionGetCommand extends SpoCommand_1.default {
             }
         }
         return true;
-    }
-}
+    }));
+}, _SpoCustomActionGetCommand_initOptionSets = function _SpoCustomActionGetCommand_initOptionSets() {
+    this.optionSets.push(['id', 'title']);
+};
 module.exports = new SpoCustomActionGetCommand();
 //# sourceMappingURL=customaction-get.js.map

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

@@ -1,21 +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());
+    });
+};
+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 SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
 class SpoCustomActionListCommand extends SpoCommand_1.default {
+    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);
+    }
     get name() {
         return commands_1.default.CUSTOMACTION_LIST;
     }
     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'];
     }
@@ -96,20 +113,22 @@ 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) {
+}
+_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, --url <url>'
+    }, {
+        option: '-s, --scope [scope]',
+        autocomplete: ['Site', 'Web', 'All']
+    });
+}, _SpoCustomActionListCommand_initValidators = function _SpoCustomActionListCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
         if (utils_1.validation.isValidSharePointUrl(args.options.url) !== true) {
             return 'Missing required option url';
         }
@@ -121,7 +140,7 @@ class SpoCustomActionListCommand extends SpoCommand_1.default {
             }
         }
         return true;
-    }
-}
+    }));
+};
 module.exports = new SpoCustomActionListCommand();
 //# sourceMappingURL=customaction-list.js.map

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

@@ -1,4 +1,19 @@
 "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 _SpoCustomActionRemoveCommand_instances, _SpoCustomActionRemoveCommand_initTelemetry, _SpoCustomActionRemoveCommand_initOptions, _SpoCustomActionRemoveCommand_initValidators, _SpoCustomActionRemoveCommand_initOptionSets;
 Object.defineProperty(exports, "__esModule", { value: true });
 const cli_1 = require("../../../../cli");
 const request_1 = require("../../../../request");
@@ -6,18 +21,20 @@ const utils_1 = require("../../../../utils");
 const SpoCommand_1 = require("../../../base/SpoCommand");
 const commands_1 = require("../../commands");
 class SpoCustomActionRemoveCommand extends SpoCommand_1.default {
+    constructor() {
+        super();
+        _SpoCustomActionRemoveCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpoCustomActionRemoveCommand_instances, "m", _SpoCustomActionRemoveCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpoCustomActionRemoveCommand_instances, "m", _SpoCustomActionRemoveCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoCustomActionRemoveCommand_instances, "m", _SpoCustomActionRemoveCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _SpoCustomActionRemoveCommand_instances, "m", _SpoCustomActionRemoveCommand_initOptionSets).call(this);
+    }
     get name() {
         return commands_1.default.CUSTOMACTION_REMOVE;
     }
     get description() {
         return 'Removes the specified custom action';
     }
-    getTelemetryProperties(args) {
-        const telemetryProps = super.getTelemetryProperties(args);
-        telemetryProps.scope = args.options.scope || 'All';
-        telemetryProps.confirm = (!(!args.options.confirm)).toString();
-        return telemetryProps;
-    }
     commandAction(logger, args, cb) {
         const removeCustomAction = () => {
             (() => {
@@ -54,16 +71,43 @@ class SpoCustomActionRemoveCommand extends SpoCommand_1.default {
             });
         }
     }
-    removeScopedCustomAction(options) {
-        const requestOptions = {
-            url: `${options.url}/_api/${options.scope}/UserCustomActions('${encodeURIComponent(options.id)}')`,
+    getCustomActionId(options) {
+        if (options.id) {
+            return Promise.resolve(options.id);
+        }
+        const customActionRequestOptions = {
+            url: `${options.url}/_api/${options.scope}/UserCustomActions?$filter=Title eq '${encodeURIComponent(options.title)}'`,
             headers: {
-                accept: 'application/json;odata=nometadata',
-                'X-HTTP-Method': 'DELETE'
+                accept: 'application/json;odata=nometadata'
             },
             responseType: 'json'
         };
-        return request_1.default.post(requestOptions);
+        return request_1.default
+            .get(customActionRequestOptions)
+            .then((res) => {
+            if (res.value.length === 1) {
+                return Promise.resolve(res.value[0].Id);
+            }
+            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(', ')}`);
+        });
+    }
+    removeScopedCustomAction(options) {
+        return this
+            .getCustomActionId(options)
+            .then((customActionId) => {
+            const requestOptions = {
+                url: `${options.url}/_api/${options.scope}/UserCustomActions('${encodeURIComponent(customActionId)}')')`,
+                headers: {
+                    accept: 'application/json;odata=nometadata',
+                    'X-HTTP-Method': 'DELETE'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.post(requestOptions);
+        });
     }
     /**
      * Remove request with `web` scope is send first.
@@ -92,27 +136,30 @@ class SpoCustomActionRemoveCommand extends SpoCommand_1.default {
             });
         });
     }
-    options() {
-        const options = [
-            {
-                option: '-i, --id <id>'
-            },
-            {
-                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 (utils_1.validation.isValidGuid(args.options.id) === false) {
+}
+_SpoCustomActionRemoveCommand_instances = new WeakSet(), _SpoCustomActionRemoveCommand_initTelemetry = function _SpoCustomActionRemoveCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            scope: args.options.scope || 'All',
+            confirm: (!(!args.options.confirm)).toString()
+        });
+    });
+}, _SpoCustomActionRemoveCommand_initOptions = function _SpoCustomActionRemoveCommand_initOptions() {
+    this.options.unshift({
+        option: '-i, --id [id]'
+    }, {
+        option: '-t, --title [title]'
+    }, {
+        option: '-u, --url <url>'
+    }, {
+        option: '-s, --scope [scope]',
+        autocomplete: ['Site', 'Web', 'All']
+    }, {
+        option: '--confirm'
+    });
+}, _SpoCustomActionRemoveCommand_initValidators = function _SpoCustomActionRemoveCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        if (args.options.id && utils_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) {
@@ -126,7 +173,9 @@ class SpoCustomActionRemoveCommand extends SpoCommand_1.default {
             }
         }
         return true;
-    }
-}
+    }));
+}, _SpoCustomActionRemoveCommand_initOptionSets = function _SpoCustomActionRemoveCommand_initOptionSets() {
+    this.optionSets.push(['id', 'title']);
+};
 module.exports = new SpoCustomActionRemoveCommand();
 //# sourceMappingURL=customaction-remove.js.map