@pnp/cli-microsoft365 6.3.0-beta.64eb7da → 6.3.0-beta.ac7b232

package/.eslintrc.js

@@ -7,6 +7,7 @@ const dictionary = [
   'adaptive',
   'ai',
   'app',
+  'application',
   'apply',
   'approve',
   'assets',
@@ -20,6 +21,7 @@ const dictionary = [
   'content',
   'conversation',
   'custom',
+  'customizer',
   'dataverse',
   'default',
   'external',

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

@@ -0,0 +1,95 @@
+"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 _SpoApplicationCustomizerAddCommand_instances, _SpoApplicationCustomizerAddCommand_initOptions, _SpoApplicationCustomizerAddCommand_initTelemetry, _SpoApplicationCustomizerAddCommand_initValidators;
+Object.defineProperty(exports, "__esModule", { value: true });
+const Cli_1 = require("../../../../cli/Cli");
+const validation_1 = require("../../../../utils/validation");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+const spoCustomActionAddCommand = require("../customaction/customaction-add");
+class SpoApplicationCustomizerAddCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.APPLICATIONCUSTOMIZER_ADD;
+    }
+    get description() {
+        return 'Add an application customizer to a site.';
+    }
+    constructor() {
+        super();
+        _SpoApplicationCustomizerAddCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpoApplicationCustomizerAddCommand_instances, "m", _SpoApplicationCustomizerAddCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpoApplicationCustomizerAddCommand_instances, "m", _SpoApplicationCustomizerAddCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoApplicationCustomizerAddCommand_instances, "m", _SpoApplicationCustomizerAddCommand_initValidators).call(this);
+    }
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr(`Adding application customizer with title '${args.options.title}' and clientSideComponentId '${args.options.clientSideComponentId}' to the site`);
+            }
+            const options = {
+                webUrl: args.options.webUrl,
+                name: args.options.title,
+                title: args.options.title,
+                clientSideComponentId: args.options.clientSideComponentId,
+                clientSideComponentProperties: args.options.clientSideComponentProperties || '',
+                location: 'ClientSideExtension.ApplicationCustomizer',
+                debug: this.debug,
+                verbose: this.verbose
+            };
+            yield Cli_1.Cli.executeCommand(spoCustomActionAddCommand, { options: Object.assign(Object.assign({}, options), { _: [] }) });
+        });
+    }
+}
+_SpoApplicationCustomizerAddCommand_instances = new WeakSet(), _SpoApplicationCustomizerAddCommand_initOptions = function _SpoApplicationCustomizerAddCommand_initOptions() {
+    this.options.unshift({
+        option: '-t, --title <title>'
+    }, {
+        option: '-u, --webUrl <webUrl>'
+    }, {
+        option: '-i, --clientSideComponentId <clientSideComponentId>'
+    }, {
+        option: '--clientSideComponentProperties [clientSideComponentProperties]'
+    });
+}, _SpoApplicationCustomizerAddCommand_initTelemetry = function _SpoApplicationCustomizerAddCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            clientSideComponentProperties: typeof args.options.clientSideComponentProperties !== 'undefined'
+        });
+    });
+}, _SpoApplicationCustomizerAddCommand_initValidators = function _SpoApplicationCustomizerAddCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        if (args.options.webUrl) {
+            const isValidSharePointUrl = validation_1.validation.isValidSharePointUrl(args.options.webUrl);
+            if (isValidSharePointUrl !== true) {
+                return isValidSharePointUrl;
+            }
+        }
+        if (!validation_1.validation.isValidGuid(args.options.clientSideComponentId)) {
+            return `${args.options.clientSideComponentId} is not a valid GUID`;
+        }
+        if (args.options.clientSideComponentProperties) {
+            try {
+                JSON.parse(args.options.clientSideComponentProperties);
+            }
+            catch (e) {
+                return `An error has occurred while parsing clientSideComponentProperties: ${e}`;
+            }
+        }
+        return true;
+    }));
+};
+module.exports = new SpoApplicationCustomizerAddCommand();
+//# sourceMappingURL=applicationcustomizer-add.js.map

package/dist/m365/spo/commands.js

@@ -13,6 +13,7 @@ exports.default = {
     APP_TEAMSPACKAGE_DOWNLOAD: `${prefix} app teamspackage download`,
     APP_UNINSTALL: `${prefix} app uninstall`,
     APP_UPGRADE: `${prefix} app upgrade`,
+    APPLICATIONCUSTOMIZER_ADD: `${prefix} applicationcustomizer add`,
     APPPAGE_ADD: `${prefix} apppage add`,
     APPPAGE_SET: `${prefix} apppage set`,
     CDN_GET: `${prefix} cdn get`,

package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-add.md

@@ -0,0 +1,56 @@
+# spo applicationcustomizer add
+
+Add an application customizer to a site.
+
+## Usage
+
+```sh
+m365 spo applicationcustomizer add [options]
+```
+
+## Options
+
+`-t, --title <title>`
+: The title of the application customizer.
+
+`-u, --webUrl <webUrl>`
+: URL of the site.
+
+`-i, --clientSideComponentId <clientSideComponentId>`
+: Client-side component ID of the application customizer (GUID).
+
+`--clientSideComponentProperties [clientSideComponentProperties]`
+: JSON string with application customizer properties
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+Running this command from the Windows Command Shell (cmd.exe) or PowerShell for Windows OS XP, 7, 8, 8.1 without bash installed might require additional formatting for command options that have JSON, XML or JavaScript values because the command shell treat quotes differently. For example, this is how an application customizer can be created from the Windows cmd.exe:
+
+```sh
+m365 spo applicationcustomizer add --webUrl https://contoso.sharepoint.com/sites/test --title "YourAppCustomizer" --clientSideComponentId b41916e7-e69d-467f-b37f-ff8ecf8f99f2 --clientSideComponentProperties '{\"testMessage\":\"Test message\"}'
+```
+
+Note, how the clientSideComponentProperties option has escaped double quotes `'{\"testMessage\":\"Test message\"}'` compared to execution from bash `'{"testMessage":"Test message"}'`.
+
+!!! warning "Escaping JSON in PowerShell"
+    When using the `--clientSideComponentProperties` option it's possible to enter a JSON string. In PowerShell 5 to 7.2 [specific escaping rules](./../../../user-guide/using-cli.md#escaping-double-quotes-in-powershell) apply due to an issue. Remember that you can also use [file tokens](./../../../user-guide/using-cli.md#passing-complex-content-into-cli-options) instead.
+
+## Examples
+
+Adds an application customizer to the sales site.
+
+```sh
+m365 spo applicationcustomizer add --title 'Some customizer' --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+Adds an application customizer to the sales site with some properties.
+
+```sh
+m365 spo applicationcustomizer add --title 'Some customizer' --clientSideComponentId 799883f5-7962-4384-a10a-105adaec6ffc --clientSideComponentProperties '{ "someProperty": "Some value" }' --webUrl https://contoso.sharepoint.com/sites/sales
+```
+
+## Response
+
+The command won't return a response on success.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "6.3.0-beta.64eb7da",
+  "version": "6.3.0-beta.ac7b232",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",