@pnp/cli-microsoft365 9.0.0-beta.33615bd → 9.0.0-beta.39e78b2

package/dist/Command.js

@@ -111,9 +111,7 @@ class Command {
                 prompted = true;
                 await cli.error('🌶️  Provide values for the following parameters:');
             }
-            const answer = optionInfo.autocomplete !== undefined
-                ? await prompt.forSelection({ message: `${optionInfo.name}: `, choices: optionInfo.autocomplete.map((choice) => { return { name: choice, value: choice }; }) })
-                : await prompt.forInput({ message: `${optionInfo.name}: ` });
+            const answer = await cli.promptForValue(optionInfo);
             args.options[optionInfo.name] = answer;
         }
         if (prompted) {

package/dist/cli/cli.js

@@ -36,6 +36,14 @@ const defaultHelpMode = 'options';
 const defaultHelpTarget = 'console';
 const helpModes = ['options', 'examples', 'remarks', 'response', 'full'];
 const helpTargets = ['console', 'web'];
+const yargsConfiguration = {
+    'parse-numbers': true,
+    'strip-aliased': true,
+    'strip-dashed': true,
+    'dot-notation': false,
+    'boolean-negation': true,
+    'camel-case-expansion': false
+};
 function getConfig() {
     if (!_config) {
         _config = new Configstore(config.configstoreName);
@@ -129,14 +137,38 @@ async function execute(rawArgs) {
     }
     let finalArgs = cli.optionsFromArgs.options;
     if (cli.commandToExecute?.command.schema) {
-        const startValidation = process.hrtime.bigint();
-        const result = cli.commandToExecute.command.getSchemaToParse().safeParse(cli.optionsFromArgs.options);
-        const endValidation = process.hrtime.bigint();
-        timings.validation.push(Number(endValidation - startValidation));
-        if (!result.success) {
-            return cli.closeWithError(result.error, cli.optionsFromArgs, true);
+        while (true) {
+            const startValidation = process.hrtime.bigint();
+            const result = cli.commandToExecute.command.getSchemaToParse().safeParse(cli.optionsFromArgs.options);
+            const endValidation = process.hrtime.bigint();
+            timings.validation.push(Number(endValidation - startValidation));
+            if (result.success) {
+                finalArgs = result.data;
+                break;
+            }
+            else {
+                const hasNonRequiredErrors = result.error.errors.some(e => e.code !== 'invalid_type' || e.received !== 'undefined');
+                const shouldPrompt = cli.getSettingWithDefaultValue(settingsNames.prompt, true);
+                if (hasNonRequiredErrors === false &&
+                    shouldPrompt) {
+                    await cli.error('🌶️  Provide values for the following parameters:');
+                    for (const error of result.error.errors) {
+                        const optionInfo = cli.commandToExecute.options.find(o => o.name === error.path.join('.'));
+                        const answer = await cli.promptForValue(optionInfo);
+                        cli.optionsFromArgs.options[error.path.join('.')] = answer;
+                    }
+                }
+                else {
+                    result.error.errors.forEach(e => {
+                        if (e.code === 'invalid_type' &&
+                            e.received === 'undefined') {
+                            e.message = `Required option not specified`;
+                        }
+                    });
+                    return cli.closeWithError(result.error, cli.optionsFromArgs, true);
+                }
+            }
         }
-        finalArgs = result.data;
     }
     else {
         const startValidation = process.hrtime.bigint();
@@ -404,11 +436,7 @@ function getCommandOptions(command) {
 function getCommandOptionsFromArgs(args, commandInfo) {
     const yargsOptions = {
         alias: {},
-        configuration: {
-            "parse-numbers": false,
-            "strip-aliased": true,
-            "strip-dashed": true
-        }
+        configuration: yargsConfiguration
     };
     let argsToParse = args;
     if (commandInfo) {
@@ -749,7 +777,7 @@ async function closeWithError(error, args, showHelpIfEnabled = false) {
     }
     let errorMessage = error instanceof CommandError ? error.message : error;
     if (error instanceof ZodError) {
-        errorMessage = error.errors.map(e => `${e.path}: ${e.message}`).join(os.EOL);
+        errorMessage = error.errors.map(e => `${e.path.join('.')}: ${e.message}`).join(os.EOL);
     }
     if ((!args.options.output || args.options.output === 'json') &&
         !cli.getSettingWithDefaultValue(settingsNames.printErrorsAsPlainText, true)) {
@@ -789,6 +817,16 @@ async function error(message, ...optionalParams) {
         console.error(message, ...optionalParams);
     }
 }
+async function promptForValue(optionInfo) {
+    return optionInfo.autocomplete !== undefined
+        ? await prompt.forSelection({
+            message: `${optionInfo.name}: `,
+            choices: optionInfo.autocomplete.map((choice) => {
+                return { name: choice, value: choice };
+            })
+        })
+        : await prompt.forInput({ message: `${optionInfo.name}: ` });
+}
 async function promptForSelection(config) {
     const answer = await prompt.forSelection(config);
     await cli.error('');
@@ -853,6 +891,8 @@ export const cli = {
     printAvailableCommands,
     promptForConfirmation,
     promptForSelection,
-    shouldTrimOutput
+    promptForValue,
+    shouldTrimOutput,
+    yargsConfiguration
 };
 //# sourceMappingURL=cli.js.map

package/dist/config.js

@@ -3,7 +3,7 @@ const cliEntraAppId = '31359c7f-bd7e-475c-86db-fdb8c937548e';
 export default {
     applicationName: `CLI for Microsoft 365 v${app.packageJson().version}`,
     delimiter: 'm365\$',
-    cliEntraAppId: process.env.CLIMICROSOFT365_ENTRAAPPID || process.env.CLIMICROSOFT365_AADAPPID || cliEntraAppId,
+    cliEntraAppId: process.env.CLIMICROSOFT365_ENTRAAPPID || cliEntraAppId,
     tenant: process.env.CLIMICROSOFT365_TENANT || 'common',
     configstoreName: 'cli-m365-config'
 };

package/dist/m365/cli/commands/cli-consent.js

@@ -23,12 +23,8 @@ class CliConsentCommand extends AnonymousCommand {
     }
     async commandAction(logger, args) {
         let scope = '';
-        switch (args.options.service) {
-            case 'yammer':
-                await this.warn(logger, 'The yammer service is deprecated. Please use the VivaEngage service instead.');
-            case 'VivaEngage':
-                scope = 'https://api.yammer.com/user_impersonation';
-                break;
+        if (args.options.service === 'VivaEngage') {
+            scope = 'https://api.yammer.com/user_impersonation';
         }
         await logger.log(`To consent permissions for executing ${args.options.service} commands, navigate in your web browser to https://login.microsoftonline.com/${config.tenant}/oauth2/v2.0/authorize?client_id=${config.cliEntraAppId}&response_type=code&scope=${encodeURIComponent(scope)}`);
     }
@@ -50,7 +46,7 @@ _CliConsentCommand_instances = new WeakSet(), _CliConsentCommand_initTelemetry =
     });
 }, _CliConsentCommand_initValidators = function _CliConsentCommand_initValidators() {
     this.validators.push(async (args) => {
-        if (args.options.service !== 'VivaEngage' && args.options.service !== 'yammer') {
+        if (args.options.service !== 'VivaEngage') {
             return `${args.options.service} is not a valid value for the service option. Allowed values: VivaEngage`;
         }
         return true;

package/dist/m365/commands/login.js

@@ -38,19 +38,24 @@ class LoginCommand extends Command {
     getRefinedSchema(schema) {
         return schema
             .refine(options => options.authType !== 'password' || options.userName, {
-            message: 'Username is required when using password authentication'
+            message: 'Username is required when using password authentication',
+            path: ['userName']
         })
             .refine(options => options.authType !== 'password' || options.password, {
-            message: 'Password is required when using password authentication'
+            message: 'Password is required when using password authentication',
+            path: ['password']
         })
             .refine(options => options.authType !== 'certificate' || !(options.certificateFile && options.certificateBase64Encoded), {
-            message: 'Specify either certificateFile or certificateBase64Encoded, but not both.'
+            message: 'Specify either certificateFile or certificateBase64Encoded, but not both.',
+            path: ['certificateBase64Encoded']
         })
             .refine(options => options.authType !== 'certificate' || options.certificateFile || options.certificateBase64Encoded, {
-            message: 'Specify either certificateFile or certificateBase64Encoded'
+            message: 'Specify either certificateFile or certificateBase64Encoded',
+            path: ['certificateFile']
         })
             .refine(options => options.authType !== 'secret' || options.secret, {
-            message: 'Secret is required when using secret authentication'
+            message: 'Secret is required when using secret authentication',
+            path: ['secret']
         });
     }
     async commandAction(logger, args) {

package/dist/m365/commands/status.js

@@ -30,8 +30,8 @@ class StatusCommand extends Command {
             const connections = await auth.getAllConnections();
             if (this.verbose) {
                 const message = connections.length > 0
-                    ? `Logged out from Microsoft 365, signed in connections available`
-                    : 'Logged out from Microsoft 365';
+                    ? `Logged out, signed in connections available`
+                    : 'Logged out';
                 await logger.logToStderr(message);
             }
             else {

package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-add.js

@@ -30,12 +30,12 @@ class EntraEnterpriseAppAddCommand extends GraphCommand {
         __classPrivateFieldGet(this, _EntraEnterpriseAppAddCommand_instances, "m", _EntraEnterpriseAppAddCommand_initOptionSets).call(this);
     }
     async getAppId(args) {
-        if (args.options.appId) {
-            return args.options.appId;
+        if (args.options.id) {
+            return args.options.id;
         }
         let spMatchQuery = '';
-        if (args.options.appName) {
-            spMatchQuery = `displayName eq '${formatting.encodeQueryParameter(args.options.appName)}'`;
+        if (args.options.displayName) {
+            spMatchQuery = `displayName eq '${formatting.encodeQueryParameter(args.options.displayName)}'`;
         }
         else if (args.options.objectId) {
             spMatchQuery = `id eq '${formatting.encodeQueryParameter(args.options.objectId)}'`;
@@ -54,7 +54,7 @@ class EntraEnterpriseAppAddCommand extends GraphCommand {
         }
         if (response.value.length > 1) {
             const resultAsKeyValuePair = formatting.convertArrayToHashTable('appId', response.value);
-            const result = await cli.handleMultipleResultsFound(`Multiple Entra apps with name '${args.options.appName}' found.`, resultAsKeyValuePair);
+            const result = await cli.handleMultipleResultsFound(`Multiple Entra apps with name '${args.options.displayName}' found.`, resultAsKeyValuePair);
             return result.appId;
         }
         return spItem.appId;
@@ -85,31 +85,31 @@ class EntraEnterpriseAppAddCommand extends GraphCommand {
 _EntraEnterpriseAppAddCommand_instances = new WeakSet(), _EntraEnterpriseAppAddCommand_initTelemetry = function _EntraEnterpriseAppAddCommand_initTelemetry() {
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
-            appId: (!(!args.options.appId)).toString(),
-            appName: (!(!args.options.appName)).toString(),
+            id: (!(!args.options.id)).toString(),
+            displayName: (!(!args.options.displayName)).toString(),
             objectId: (!(!args.options.objectId)).toString()
         });
     });
 }, _EntraEnterpriseAppAddCommand_initOptions = function _EntraEnterpriseAppAddCommand_initOptions() {
     this.options.unshift({
-        option: '--appId [appId]'
+        option: '-i, --id [id]'
     }, {
-        option: '--appName [appName]'
+        option: '-n, --displayName [displayName]'
     }, {
         option: '--objectId [objectId]'
     });
 }, _EntraEnterpriseAppAddCommand_initValidators = function _EntraEnterpriseAppAddCommand_initValidators() {
     this.validators.push(async (args) => {
-        if (args.options.appId && !validation.isValidGuid(args.options.appId)) {
-            return `${args.options.appId} is not a valid appId GUID`;
+        if (args.options.id && !validation.isValidGuid(args.options.id)) {
+            return `${args.options.id} is not a valid GUID`;
         }
         if (args.options.objectId && !validation.isValidGuid(args.options.objectId)) {
-            return `${args.options.objectId} is not a valid objectId GUID`;
+            return `${args.options.objectId} is not a valid GUID`;
         }
         return true;
     });
 }, _EntraEnterpriseAppAddCommand_initOptionSets = function _EntraEnterpriseAppAddCommand_initOptionSets() {
-    this.optionSets.push({ options: ['appId', 'appName', 'objectId'] });
+    this.optionSets.push({ options: ['id', 'displayName', 'objectId'] });
 };
 export default new EntraEnterpriseAppAddCommand();
 //# sourceMappingURL=enterpriseapp-add.js.map

package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-get.js

@@ -30,15 +30,15 @@ class EntraEnterpriseAppGetCommand extends GraphCommand {
         __classPrivateFieldGet(this, _EntraEnterpriseAppGetCommand_instances, "m", _EntraEnterpriseAppGetCommand_initOptionSets).call(this);
     }
     async getSpId(args) {
-        if (args.options.appObjectId) {
-            return args.options.appObjectId;
+        if (args.options.objectId) {
+            return args.options.objectId;
         }
         let spMatchQuery = '';
-        if (args.options.appDisplayName) {
-            spMatchQuery = `displayName eq '${formatting.encodeQueryParameter(args.options.appDisplayName)}'`;
+        if (args.options.displayName) {
+            spMatchQuery = `displayName eq '${formatting.encodeQueryParameter(args.options.displayName)}'`;
         }
-        else if (args.options.appId) {
-            spMatchQuery = `appId eq '${formatting.encodeQueryParameter(args.options.appId)}'`;
+        else if (args.options.id) {
+            spMatchQuery = `appId eq '${formatting.encodeQueryParameter(args.options.id)}'`;
         }
         const idRequestOptions = {
             url: `${this.resource}/v1.0/servicePrincipals?$filter=${spMatchQuery}`,
@@ -54,7 +54,7 @@ class EntraEnterpriseAppGetCommand extends GraphCommand {
         }
         if (response.value.length > 1) {
             const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', response.value);
-            const result = await cli.handleMultipleResultsFound(`Multiple Entra apps with name '${args.options.appDisplayName}' found.`, resultAsKeyValuePair);
+            const result = await cli.handleMultipleResultsFound(`Multiple Entra apps with name '${args.options.displayName}' found.`, resultAsKeyValuePair);
             return result.id;
         }
         return spItem.id;
@@ -85,31 +85,31 @@ class EntraEnterpriseAppGetCommand extends GraphCommand {
 _EntraEnterpriseAppGetCommand_instances = new WeakSet(), _EntraEnterpriseAppGetCommand_initTelemetry = function _EntraEnterpriseAppGetCommand_initTelemetry() {
     this.telemetry.push((args) => {
         Object.assign(this.telemetryProperties, {
-            appId: (!(!args.options.appId)).toString(),
-            appDisplayName: (!(!args.options.appDisplayName)).toString(),
-            appObjectId: (!(!args.options.appObjectId)).toString()
+            id: (!(!args.options.id)).toString(),
+            displayName: (!(!args.options.displayName)).toString(),
+            objectId: (!(!args.options.objectId)).toString()
         });
     });
 }, _EntraEnterpriseAppGetCommand_initOptions = function _EntraEnterpriseAppGetCommand_initOptions() {
     this.options.unshift({
-        option: '-i, --appId [appId]'
+        option: '-i, --id [id]'
     }, {
-        option: '-n, --appDisplayName [appDisplayName]'
+        option: '-n, --displayName [displayName]'
     }, {
-        option: '--appObjectId [appObjectId]'
+        option: '--objectId [objectId]'
     });
 }, _EntraEnterpriseAppGetCommand_initValidators = function _EntraEnterpriseAppGetCommand_initValidators() {
     this.validators.push(async (args) => {
-        if (args.options.appId && !validation.isValidGuid(args.options.appId)) {
-            return `${args.options.appId} is not a valid appId GUID`;
+        if (args.options.id && !validation.isValidGuid(args.options.id)) {
+            return `${args.options.id} is not a valid GUID`;
         }
-        if (args.options.appObjectId && !validation.isValidGuid(args.options.appObjectId)) {
-            return `${args.options.appObjectId} is not a valid objectId GUID`;
+        if (args.options.objectId && !validation.isValidGuid(args.options.objectId)) {
+            return `${args.options.objectId} is not a valid GUID`;
         }
         return true;
     });
 }, _EntraEnterpriseAppGetCommand_initOptionSets = function _EntraEnterpriseAppGetCommand_initOptionSets() {
-    this.optionSets.push({ options: ['appId', 'appDisplayName', 'appObjectId'] });
+    this.optionSets.push({ options: ['id', 'displayName', 'objectId'] });
 };
 export default new EntraEnterpriseAppGetCommand();
 //# sourceMappingURL=enterpriseapp-get.js.map

package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-list.js

@@ -61,7 +61,7 @@ _EntraEnterpriseAppListCommand_instances = new WeakSet(), _EntraEnterpriseAppLis
     });
 }, _EntraEnterpriseAppListCommand_initOptions = function _EntraEnterpriseAppListCommand_initOptions() {
     this.options.unshift({
-        option: '--displayName [displayName]'
+        option: '-n, --displayName [displayName]'
     }, {
         option: '--tag [tag]'
     });

package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-remove.js

@@ -0,0 +1,123 @@
+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 _EntraEnterpriseAppRemoveCommand_instances, _EntraEnterpriseAppRemoveCommand_initTelemetry, _EntraEnterpriseAppRemoveCommand_initOptions, _EntraEnterpriseAppRemoveCommand_initValidators, _EntraEnterpriseAppRemoveCommand_initOptionSets, _EntraEnterpriseAppRemoveCommand_initTypes;
+import { cli } from '../../../../cli/cli.js';
+import request from '../../../../request.js';
+import { odata } from '../../../../utils/odata.js';
+import { formatting } from '../../../../utils/formatting.js';
+import { validation } from '../../../../utils/validation.js';
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+class EntraEnterpriseAppRemoveCommand extends GraphCommand {
+    get name() {
+        return commands.ENTERPRISEAPP_REMOVE;
+    }
+    get description() {
+        return 'Deletes an enterprise application (or service principal)';
+    }
+    alias() {
+        return [commands.SP_REMOVE];
+    }
+    constructor() {
+        super();
+        _EntraEnterpriseAppRemoveCommand_instances.add(this);
+        __classPrivateFieldGet(this, _EntraEnterpriseAppRemoveCommand_instances, "m", _EntraEnterpriseAppRemoveCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _EntraEnterpriseAppRemoveCommand_instances, "m", _EntraEnterpriseAppRemoveCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _EntraEnterpriseAppRemoveCommand_instances, "m", _EntraEnterpriseAppRemoveCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _EntraEnterpriseAppRemoveCommand_instances, "m", _EntraEnterpriseAppRemoveCommand_initOptionSets).call(this);
+        __classPrivateFieldGet(this, _EntraEnterpriseAppRemoveCommand_instances, "m", _EntraEnterpriseAppRemoveCommand_initTypes).call(this);
+    }
+    async commandAction(logger, args) {
+        const removeEnterpriseApplication = async () => {
+            if (this.verbose) {
+                await logger.logToStderr(`Removing enterprise application ${args.options.id || args.options.displayName || args.options.objectId}...`);
+            }
+            try {
+                let url = `${this.resource}/v1.0`;
+                if (args.options.id) {
+                    url += `/servicePrincipals(appId='${args.options.id}')`;
+                }
+                else {
+                    const id = await this.getSpId(args.options);
+                    url += `/servicePrincipals/${id}`;
+                }
+                const requestOptions = {
+                    url: url,
+                    headers: {
+                        accept: 'application/json;odata.metadata=none'
+                    },
+                    responseType: 'json'
+                };
+                await request.delete(requestOptions);
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        };
+        if (args.options.force) {
+            await removeEnterpriseApplication();
+        }
+        else {
+            const result = await cli.promptForConfirmation({ message: `Are you sure you want to remove enterprise application '${args.options.id || args.options.displayName || args.options.objectId}'?` });
+            if (result) {
+                await removeEnterpriseApplication();
+            }
+        }
+    }
+    async getSpId(options) {
+        if (options.objectId) {
+            return options.objectId;
+        }
+        const spItemsResponse = await odata.getAllItems(`${this.resource}/v1.0/servicePrincipals?$filter=displayName eq '${formatting.encodeQueryParameter(options.displayName)}'&$select=id`);
+        if (spItemsResponse.length === 0) {
+            throw `The specified enterprise application does not exist.`;
+        }
+        if (spItemsResponse.length > 1) {
+            const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', spItemsResponse);
+            const result = await cli.handleMultipleResultsFound(`Multiple enterprise applications with name '${options.displayName}' found.`, resultAsKeyValuePair);
+            return result.id;
+        }
+        const spItem = spItemsResponse[0];
+        return spItem.id;
+    }
+}
+_EntraEnterpriseAppRemoveCommand_instances = new WeakSet(), _EntraEnterpriseAppRemoveCommand_initTelemetry = function _EntraEnterpriseAppRemoveCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            id: typeof args.options.id !== 'undefined',
+            displayName: typeof args.options.displayName !== 'undefined',
+            objectId: typeof args.options.objectId !== 'undefined',
+            force: !!args.options.force
+        });
+    });
+}, _EntraEnterpriseAppRemoveCommand_initOptions = function _EntraEnterpriseAppRemoveCommand_initOptions() {
+    this.options.unshift({
+        option: '-i, --id [id]'
+    }, {
+        option: '-n, --displayName [displayName]'
+    }, {
+        option: '--objectId [objectId]'
+    }, {
+        option: '-f, --force'
+    });
+}, _EntraEnterpriseAppRemoveCommand_initValidators = function _EntraEnterpriseAppRemoveCommand_initValidators() {
+    this.validators.push(async (args) => {
+        if (args.options.id && !validation.isValidGuid(args.options.id)) {
+            return `The option 'id' with value '${args.options.id}' is not a valid GUID.`;
+        }
+        if (args.options.objectId && !validation.isValidGuid(args.options.objectId)) {
+            return `The option 'objectId' with value '${args.options.objectId}' is not a valid GUID.`;
+        }
+        return true;
+    });
+}, _EntraEnterpriseAppRemoveCommand_initOptionSets = function _EntraEnterpriseAppRemoveCommand_initOptionSets() {
+    this.optionSets.push({ options: ['id', 'displayName', 'objectId'] });
+}, _EntraEnterpriseAppRemoveCommand_initTypes = function _EntraEnterpriseAppRemoveCommand_initTypes() {
+    this.types.string.push('id', 'displayName', 'objectId');
+    this.types.boolean.push('force');
+};
+export default new EntraEnterpriseAppRemoveCommand();
+//# sourceMappingURL=enterpriseapp-remove.js.map