@pnp/cli-microsoft365 4.2.0 → 4.3.0-beta.014ebf5

package/.eslintrc.js

@@ -30,6 +30,7 @@ const dictionary = [
   'in',
   'init',
   'install',
+  'installed',
   'is',
   'issue',
   'list',

package/dist/m365/aad/commands/app/app-get.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const Utils_1 = require("../../../../Utils");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+class AadAppGetCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.APP_GET;
+    }
+    get description() {
+        return 'Gets an Azure AD app registration';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.appId = typeof args.options.appId !== 'undefined';
+        telemetryProps.objectId = typeof args.options.objectId !== 'undefined';
+        telemetryProps.name = typeof args.options.name !== 'undefined';
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        this
+            .getAppObjectId(args)
+            .then((appObjectId) => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/myorganization/applications/${appObjectId}`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.get(requestOptions);
+        })
+            .then((res) => {
+            logger.log(res);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    getAppObjectId(args) {
+        if (args.options.objectId) {
+            return Promise.resolve(args.options.objectId);
+        }
+        const { appId, name } = args.options;
+        const filter = appId ?
+            `appId eq '${encodeURIComponent(appId)}'` :
+            `displayName eq '${encodeURIComponent(name)}'`;
+        const requestOptions = {
+            url: `${this.resource}/v1.0/myorganization/applications?$filter=${filter}&$select=id`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then((res) => {
+            if (res.value.length === 1) {
+                return Promise.resolve(res.value[0].id);
+            }
+            if (res.value.length === 0) {
+                const applicationIdentifier = appId ? `ID ${appId}` : `name ${name}`;
+                return Promise.reject(`No Azure AD application registration with ${applicationIdentifier} found`);
+            }
+            return Promise.reject(`Multiple Azure AD application registration with name ${name} found. Please disambiguate (app object IDs): ${res.value.map(a => a.id).join(', ')}`);
+        });
+    }
+    options() {
+        const options = [
+            { option: '--appId [appId]' },
+            { option: '--objectId [objectId]' },
+            { option: '--name [name]' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (!args.options.appId &&
+            !args.options.objectId &&
+            !args.options.name) {
+            return 'Specify either appId, objectId, or name';
+        }
+        if ((args.options.appId && args.options.objectId) ||
+            (args.options.appId && args.options.name) ||
+            (args.options.objectId && args.options.name)) {
+            return 'Specify either appId, objectId, or name but not both';
+        }
+        if (args.options.appId && !Utils_1.default.isValidGuid(args.options.appId)) {
+            return `${args.options.appId} is not a valid GUID`;
+        }
+        if (args.options.objectId && !Utils_1.default.isValidGuid(args.options.objectId)) {
+            return `${args.options.objectId} is not a valid GUID`;
+        }
+        return true;
+    }
+}
+module.exports = new AadAppGetCommand();
+//# sourceMappingURL=app-get.js.map

package/dist/m365/aad/commands.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const prefix = 'aad';
 exports.default = {
     APP_ADD: `${prefix} app add`,
+    APP_GET: `${prefix} app get`,
     APP_SET: `${prefix} app set`,
     APP_ROLE_ADD: `${prefix} app role add`,
     APP_ROLE_LIST: `${prefix} app role list`,

package/dist/m365/search/commands/externalconnection/externalconnection-add.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+class SearchExternalConnectionAddCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.EXTERNALCONNECTION_ADD;
+    }
+    get description() {
+        return 'Adds a new External Connection for Microsoft Search';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.authorizedAppIds = typeof args.options.authorizedAppIds !== undefined;
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        let appIds = [];
+        if (args.options.authorizedAppIds !== undefined &&
+            args.options.authorizedAppIds !== '') {
+            appIds = args.options.authorizedAppIds.split(',');
+        }
+        const commandData = {
+            id: args.options.id,
+            name: args.options.name,
+            description: args.options.description,
+            configuration: {
+                authorizedAppIds: appIds
+            }
+        };
+        const requestOptions = {
+            url: `${this.resource}/v1.0/external/connections`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json',
+            data: commandData
+        };
+        request_1.default
+            .post(requestOptions)
+            .then(_ => cb(), err => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-i, --id <id>'
+            },
+            {
+                option: '-n, --name <name>'
+            },
+            {
+                option: '-d, --description <description>'
+            },
+            {
+                option: '--authorizedAppIds [authorizedAppIds]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        const id = args.options.id;
+        if (id.length < 3 || id.length > 32) {
+            return 'ID must be between 3 and 32 characters in length.';
+        }
+        const alphaNumericRegEx = /[^\w]|_/g;
+        if (alphaNumericRegEx.test(id)) {
+            return 'ID must only contain alphanumeric characters.';
+        }
+        if (id.length > 9 &&
+            id.startsWith('Microsoft')) {
+            return 'ID cannot begin with Microsoft';
+        }
+        const invalidIds = ['None',
+            'Directory',
+            'Exchange',
+            'ExchangeArchive',
+            'LinkedIn',
+            'Mailbox',
+            'OneDriveBusiness',
+            'SharePoint',
+            'Teams',
+            'Yammer',
+            'Connectors',
+            'TaskFabric',
+            'PowerBI',
+            'Assistant',
+            'TopicEngine',
+            'MSFT_All_Connectors'
+        ];
+        if (invalidIds.indexOf(id) > -1) {
+            return `ID cannot be one of the following values: ${invalidIds.join(', ')}.`;
+        }
+        return true;
+    }
+}
+module.exports = new SearchExternalConnectionAddCommand();
+//# sourceMappingURL=externalconnection-add.js.map

package/dist/m365/search/commands.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const prefix = 'search';
+exports.default = {
+    EXTERNALCONNECTION_ADD: `${prefix} externalconnection add`
+};
+//# sourceMappingURL=commands.js.map

package/dist/m365/spo/commands/web/web-installedlanguage-list.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoWebInstalledLanguageListCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.WEB_INSTALLEDLANGUAGE_LIST;
+    }
+    get description() {
+        return 'Lists all installed languages on site';
+    }
+    defaultProperties() {
+        return ['DisplayName', 'LanguageTag', 'Lcid'];
+    }
+    commandAction(logger, args, cb) {
+        if (this.verbose) {
+            logger.logToStderr(`Retrieving all installed languages on site ${args.options.webUrl}...`);
+        }
+        const requestOptions = {
+            url: `${args.options.webUrl}/_api/web/RegionalSettings/InstalledLanguages`,
+            headers: {
+                'accept': 'application/json;odata=nometadata'
+            },
+            responseType: 'json'
+        };
+        request_1.default
+            .get(requestOptions)
+            .then((webInstalledLanguageProperties) => {
+            logger.log(webInstalledLanguageProperties.Items);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-u, --webUrl <webUrl>'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        return SpoCommand_1.default.isValidSharePointUrl(args.options.webUrl);
+    }
+}
+module.exports = new SpoWebInstalledLanguageListCommand();
+//# sourceMappingURL=web-installedlanguage-list.js.map

package/dist/m365/spo/commands.js

@@ -246,6 +246,7 @@ exports.default = {
     WEB_ADD: `${prefix} web add`,
     WEB_CLIENTSIDEWEBPART_LIST: `${prefix} web clientsidewebpart list`,
     WEB_GET: `${prefix} web get`,
+    WEB_INSTALLEDLANGUAGE_LIST: `${prefix} web installedlanguage list`,
     WEB_LIST: `${prefix} web list`,
     WEB_REINDEX: `${prefix} web reindex`,
     WEB_REMOVE: `${prefix} web remove`,

package/docs/docs/cmd/aad/app/app-get.md

@@ -0,0 +1,48 @@
+# aad app get
+
+Gets an Azure AD app registration
+
+## Usage
+
+```sh
+m365 aad app get [options]
+```
+
+## Options
+
+`--appId [appId]`
+: Application (client) ID of the Azure AD application registration to get. Specify either `appId`, `objectId` or `name`
+
+`--objectId [objectId]`
+: Object ID of the Azure AD application registration to get. Specify either `appId`, `objectId` or `name`
+
+`--name [name]`
+: Name of the Azure AD application registration to get. Specify either `appId`, `objectId` or `name`
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+For best performance use the `objectId` option to reference the Azure AD application registration to update. If you use `appId` or `name`, this command will first need to find the corresponding object ID for that application.
+
+If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
+
+## Examples
+
+Get the Azure AD application registration by its app (client) ID
+
+```sh
+m365 aad app get --appId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Get the Azure AD application registration by its object ID
+
+```sh
+m365 aad app get --objectId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Get the Azure AD application registration by its name
+
+```sh
+m365 aad app get --name "My app"
+```

package/docs/docs/cmd/search/externalconnection/externalconnection-add.md

@@ -0,0 +1,43 @@
+# search externalconnection add
+
+Add a new external connection to be defined for Microsoft Search
+
+## Usage
+
+```sh
+m365 search externalconnection add [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: Developer-provided unique ID of the connection within the Azure Active Directory tenant
+
+`-n, --name <name>`
+: The display name of the connection to be displayed in the Microsoft 365 admin center. Maximum length of 128 characters
+
+`-d, --description <description>`
+: Description of the connection displayed in the Microsoft 365 admin center
+
+`--authorizedAppIds [authorizedAppIds]`
+: Comma-separated collection of application IDs for registered Azure Active Directory apps that are allowed to manage the external connection and to index content in the external connection.
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+The `id` must be at least 3 and no more than 32 characters long. It can contain only alphanumeric characters, can't begin with _Microsoft_ and can be any of the following values: *None, Directory, Exchange, ExchangeArchive, LinkedIn, Mailbox, OneDriveBusiness, SharePoint, Teams, Yammer, Connectors, TaskFabric, PowerBI, Assistant, TopicEngine, MSFT_All_Connectors*.
+
+## Examples
+
+Adds a new external connection with name and description of test
+
+```sh
+m365 search externalconnection add --id MyApp --name "My application" --description "Description of your application"
+```
+
+Adds a new external connection with a limited number of authorized apps
+
+```sh
+m365 search externalconnection add --id MyApp --name "My application" --description "Description of your application" --authorizedAppIds  "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002"
+```

package/docs/docs/cmd/spo/web/web-installedlanguage-list.md

@@ -0,0 +1,24 @@
+# spo web installedlanguage list
+
+Lists all installed languages on site
+
+## Usage
+
+```sh
+m365 spo web installedlanguage list [options]
+```
+
+## Options
+
+`-u, --webUrl <webUrl>`
+: URL of the site for which to retrieve the list of installed languages
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Return all installed languages from site _https://contoso.sharepoint.com/_
+
+```sh
+m365 spo web installedlanguage list --webUrl https://contoso.sharepoint.com
+```

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "@pnp/cli-microsoft365",
-      "version": "4.2.0",
+      "version": "4.3.0",
       "license": "MIT",
       "dependencies": {
         "@azure/msal-node": "^1.3.2",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "4.2.0",
+  "version": "4.3.0-beta.014ebf5",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/index.js",
@@ -122,6 +122,7 @@
     "Levert, Sebastien <slevert@outlook.com>",
     "Maillot, Michaël <battosaimykle@gmail.com>",
     "Mastykarz, Waldek <waldek@mastykarz.nl>",
+    "McDonnell, Kevin <kevin@mcd79.com>",
     "Menon, Arjun <arjun.umenon@gmail.com>",
     "Moujahid, Abderahman <rags_place@hotmail.com>",
     "Mücklisch, Steve <steve.muecklisch@gmail.com>",
@@ -219,4 +220,4 @@
     "rimraf": "^3.0.2",
     "sinon": "^11.1.2"
   }
-}
+}