@pnp/cli-microsoft365 8.1.0-beta.3dec9fa → 9.0.0-beta.1cfb646

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (97) hide show
  1. package/allCommands.json +1 -1
  2. package/allCommandsFull.json +1 -1
  3. package/dist/Auth.js +9 -9
  4. package/dist/Command.js +49 -2
  5. package/dist/cli/cli.js +60 -38
  6. package/dist/config.js +1 -1
  7. package/dist/m365/app/commands/permission/permission-add.js +9 -9
  8. package/dist/m365/commands/login.js +44 -96
  9. package/dist/m365/commands/status.js +2 -2
  10. package/dist/m365/connection/commands/connection-remove.js +6 -2
  11. package/dist/m365/connection/commands/connection-set.js +4 -1
  12. package/dist/m365/connection/commands/connection-use.js +25 -4
  13. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-add.js +13 -13
  14. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-get.js +18 -18
  15. package/dist/m365/entra/commands/enterpriseapp/enterpriseapp-list.js +1 -1
  16. package/dist/m365/entra/commands/group/group-user-list.js +4 -4
  17. package/dist/m365/entra/commands/m365group/m365group-conversation-post-list.js +4 -4
  18. package/dist/m365/entra/commands/m365group/m365group-recyclebinitem-list.js +3 -3
  19. package/dist/m365/entra/commands/m365group/m365group-user-list.js +6 -9
  20. package/dist/m365/entra/commands/multitenant/multitenant-add.js +65 -0
  21. package/dist/m365/entra/commands/multitenant/multitenant-remove.js +118 -0
  22. package/dist/m365/entra/commands/multitenant/multitenant-set.js +72 -0
  23. package/dist/m365/entra/commands.js +3 -0
  24. package/dist/m365/outlook/commands/message/message-get.js +11 -11
  25. package/dist/m365/spe/ContainerTypeProperties.js +2 -0
  26. package/dist/m365/spe/commands/containertype/containertype-list.js +49 -0
  27. package/dist/m365/spe/commands.js +2 -1
  28. package/dist/m365/spfx/commands/project/DeployWorkflow.js +1 -1
  29. package/dist/m365/spfx/commands/project/project-github-workflow-add.js +1 -10
  30. package/dist/m365/spo/commands/applicationcustomizer/applicationcustomizer-get.js +16 -21
  31. package/dist/m365/spo/commands/commandset/commandset-get.js +31 -17
  32. package/dist/m365/spo/commands/file/file-copy.js +55 -34
  33. package/dist/m365/spo/commands/file/file-roleassignment-add.js +1 -1
  34. package/dist/m365/spo/commands/file/file-roleinheritance-break.js +1 -1
  35. package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +1 -1
  36. package/dist/m365/spo/commands/folder/folder-retentionlabel-ensure.js +1 -1
  37. package/dist/m365/spo/commands/folder/folder-set.js +0 -4
  38. package/dist/m365/spo/commands/list/list-list.js +1 -4
  39. package/dist/m365/spo/commands/list/list-roleassignment-add.js +46 -21
  40. package/dist/m365/spo/commands/list/list-roleassignment-remove.js +48 -46
  41. package/dist/m365/spo/commands/site/site-appcatalog-remove.js +48 -24
  42. package/dist/m365/spo/commands/site/site-remove.js +1 -7
  43. package/dist/m365/spo/commands/tenant/tenant-applicationcustomizer-get.js +19 -5
  44. package/dist/m365/spo/commands/tenant/tenant-commandset-get.js +20 -6
  45. package/dist/m365/spo/commands/tenant/tenant-recyclebinitem-restore.js +2 -22
  46. package/dist/m365/spo/commands.js +0 -1
  47. package/dist/utils/formatting.js +16 -0
  48. package/dist/utils/spo.js +111 -6
  49. package/dist/utils/zod.js +124 -0
  50. package/docs/docs/cmd/app/permission/permission-add.mdx +5 -5
  51. package/docs/docs/cmd/connection/connection-use.mdx +8 -2
  52. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-add.mdx +12 -12
  53. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-get.mdx +14 -14
  54. package/docs/docs/cmd/entra/enterpriseapp/enterpriseapp-list.mdx +5 -5
  55. package/docs/docs/cmd/entra/group/group-user-list.mdx +7 -7
  56. package/docs/docs/cmd/entra/m365group/m365group-conversation-post-list.mdx +5 -5
  57. package/docs/docs/cmd/entra/m365group/m365group-recyclebinitem-list.mdx +3 -3
  58. package/docs/docs/cmd/entra/m365group/m365group-user-list.mdx +1 -1
  59. package/docs/docs/cmd/entra/multitenant/multitenant-add.mdx +107 -0
  60. package/docs/docs/cmd/entra/multitenant/multitenant-remove.mdx +58 -0
  61. package/docs/docs/cmd/entra/multitenant/multitenant-set.mdx +53 -0
  62. package/docs/docs/cmd/outlook/message/message-get.mdx +5 -5
  63. package/docs/docs/cmd/planner/plan/plan-remove.mdx +1 -1
  64. package/docs/docs/cmd/spe/containertype/containertype-list.mdx +102 -0
  65. package/docs/docs/cmd/spfx/project/project-github-workflow-add.mdx +11 -12
  66. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-get.mdx +87 -38
  67. package/docs/docs/cmd/spo/applicationcustomizer/applicationcustomizer-list.mdx +22 -28
  68. package/docs/docs/cmd/spo/commandset/commandset-get.mdx +75 -24
  69. package/docs/docs/cmd/spo/commandset/commandset-list.mdx +26 -32
  70. package/docs/docs/cmd/spo/file/file-copy.mdx +119 -12
  71. package/docs/docs/cmd/spo/file/file-retentionlabel-ensure.mdx +1 -1
  72. package/docs/docs/cmd/spo/file/file-roleassignment-add.mdx +2 -2
  73. package/docs/docs/cmd/spo/file/file-roleassignment-remove.mdx +1 -1
  74. package/docs/docs/cmd/spo/file/file-roleinheritance-break.mdx +1 -1
  75. package/docs/docs/cmd/spo/file/file-roleinheritance-reset.mdx +1 -1
  76. package/docs/docs/cmd/spo/folder/folder-retentionlabel-ensure.mdx +2 -2
  77. package/docs/docs/cmd/spo/folder/folder-set.mdx +0 -6
  78. package/docs/docs/cmd/spo/list/list-list.mdx +5 -7
  79. package/docs/docs/cmd/spo/list/list-roleassignment-add.mdx +15 -3
  80. package/docs/docs/cmd/spo/list/list-roleassignment-remove.mdx +15 -3
  81. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.mdx +4 -4
  82. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-remove.mdx +1 -1
  83. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-add.mdx +9 -9
  84. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-remove.mdx +7 -7
  85. package/docs/docs/cmd/spo/site/site-appcatalog-remove.mdx +11 -2
  86. package/docs/docs/cmd/spo/site/site-recyclebinitem-list.mdx +1 -1
  87. package/docs/docs/cmd/spo/site/site-remove.mdx +0 -3
  88. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-get.mdx +79 -30
  89. package/docs/docs/cmd/spo/tenant/tenant-applicationcustomizer-list.mdx +20 -19
  90. package/docs/docs/cmd/spo/tenant/tenant-commandset-get.mdx +84 -38
  91. package/docs/docs/cmd/spo/tenant/tenant-commandset-list.mdx +20 -19
  92. package/docs/docs/cmd/spo/tenant/tenant-recyclebinitem-restore.mdx +2 -49
  93. package/docs/docs/cmd/spo/web/web-roleassignment-add.mdx +1 -1
  94. package/docs/docs/cmd/spo/web/web-roleassignment-remove.mdx +1 -1
  95. package/docs/docs/cmd/teams/meeting/meeting-list.mdx +7 -3
  96. package/npm-shrinkwrap.json +606 -845
  97. package/package.json +6 -2
package/dist/Auth.js CHANGED
@@ -1,4 +1,5 @@
1
1
  import { AzureCloudInstance } from '@azure/msal-common';
2
+ import assert from 'assert';
2
3
  import { CommandError } from './Command.js';
3
4
  import { FileTokenStorage } from './auth/FileTokenStorage.js';
4
5
  import { msalCachePlugin } from './auth/msalCachePlugin.js';
@@ -6,16 +7,15 @@ import { cli } from './cli/cli.js';
6
7
  import config from './config.js';
7
8
  import request from './request.js';
8
9
  import { settingsNames } from './settingsNames.js';
9
- import { browserUtil } from './utils/browserUtil.js';
10
10
  import * as accessTokenUtil from './utils/accessToken.js';
11
- import assert from 'assert';
11
+ import { browserUtil } from './utils/browserUtil.js';
12
12
  export var CloudType;
13
13
  (function (CloudType) {
14
- CloudType[CloudType["Public"] = 0] = "Public";
15
- CloudType[CloudType["USGov"] = 1] = "USGov";
16
- CloudType[CloudType["USGovHigh"] = 2] = "USGovHigh";
17
- CloudType[CloudType["USGovDoD"] = 3] = "USGovDoD";
18
- CloudType[CloudType["China"] = 4] = "China";
14
+ CloudType["Public"] = "Public";
15
+ CloudType["USGov"] = "USGov";
16
+ CloudType["USGovHigh"] = "USGovHigh";
17
+ CloudType["USGovDoD"] = "USGovDoD";
18
+ CloudType["China"] = "China";
19
19
  })(CloudType || (CloudType = {}));
20
20
  export class Connection {
21
21
  constructor() {
@@ -691,7 +691,7 @@ export class Auth {
691
691
  const allConnections = await this.getAllConnections();
692
692
  const connection = allConnections.find(i => i.name === name);
693
693
  if (!connection) {
694
- throw new CommandError(`The connection '${name}' cannot be found`);
694
+ throw new CommandError(`The connection '${name}' cannot be found.`);
695
695
  }
696
696
  return connection;
697
697
  }
@@ -710,7 +710,7 @@ export class Auth {
710
710
  return details;
711
711
  }
712
712
  }
713
- Auth.cloudEndpoints = [];
713
+ Auth.cloudEndpoints = {};
714
714
  Auth.initialize();
715
715
  export default new Auth();
716
716
  //# sourceMappingURL=Auth.js.map
package/dist/Command.js CHANGED
@@ -5,6 +5,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
5
5
  };
6
6
  var _Command_instances, _Command_initTelemetry, _Command_initOptions, _Command_initValidators;
7
7
  import os from 'os';
8
+ import { z } from 'zod';
8
9
  import auth from './Auth.js';
9
10
  import { cli } from './cli/cli.js';
10
11
  import request from './request.js';
@@ -13,6 +14,7 @@ import { telemetry } from './telemetry.js';
13
14
  import { accessToken } from './utils/accessToken.js';
14
15
  import { md } from './utils/md.js';
15
16
  import { prompt } from './utils/prompt.js';
17
+ import { zod } from './utils/zod.js';
16
18
  export class CommandError {
17
19
  constructor(message, code) {
18
20
  this.message = message;
@@ -25,10 +27,26 @@ export class CommandErrorWithOutput {
25
27
  this.stderr = stderr;
26
28
  }
27
29
  }
30
+ export const globalOptionsZod = z.object({
31
+ query: z.string().optional(),
32
+ output: zod.alias('o', z.enum(['csv', 'json', 'md', 'text', 'none']).optional()),
33
+ debug: z.boolean().default(false),
34
+ verbose: z.boolean().default(false)
35
+ });
28
36
  class Command {
29
37
  get allowedOutputs() {
30
38
  return ['csv', 'json', 'md', 'text', 'none'];
31
39
  }
40
+ get schema() {
41
+ return undefined;
42
+ }
43
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
44
+ getRefinedSchema(schema) {
45
+ return undefined;
46
+ }
47
+ getSchemaToParse() {
48
+ return this.getRefinedSchema(this.schema) ?? this.schema;
49
+ }
32
50
  constructor() {
33
51
  // These functions must be defined with # so that they're truly private
34
52
  // otherwise you'll get a ts2415 error (Types have separate declarations of
@@ -48,6 +66,9 @@ class Command {
48
66
  string: []
49
67
  };
50
68
  this.validators = [];
69
+ // metadata for command's options
70
+ // used for building telemetry
71
+ this.optionsInfo = [];
51
72
  __classPrivateFieldGet(this, _Command_instances, "m", _Command_initTelemetry).call(this);
52
73
  __classPrivateFieldGet(this, _Command_instances, "m", _Command_initOptions).call(this);
53
74
  __classPrivateFieldGet(this, _Command_instances, "m", _Command_initValidators).call(this);
@@ -410,8 +431,34 @@ class Command {
410
431
  return '';
411
432
  }
412
433
  getTelemetryProperties(args) {
413
- this.telemetry.forEach(t => t(args));
414
- return this.telemetryProperties;
434
+ if (this.schema) {
435
+ const telemetryProperties = {};
436
+ this.optionsInfo.forEach(o => {
437
+ if (o.required) {
438
+ return;
439
+ }
440
+ if (typeof args.options[o.name] === 'undefined') {
441
+ return;
442
+ }
443
+ switch (o.type) {
444
+ case 'string':
445
+ telemetryProperties[o.name] = o.autocomplete ? args.options[o.name] : typeof args.options[o.name] !== 'undefined';
446
+ break;
447
+ case 'boolean':
448
+ telemetryProperties[o.name] = args.options[o.name];
449
+ break;
450
+ case 'number':
451
+ telemetryProperties[o.name] = typeof args.options[o.name] !== 'undefined';
452
+ break;
453
+ }
454
+ ;
455
+ });
456
+ return telemetryProperties;
457
+ }
458
+ else {
459
+ this.telemetry.forEach(t => t(args));
460
+ return this.telemetryProperties;
461
+ }
415
462
  }
416
463
  async getTextOutput(logStatement) {
417
464
  // display object as a list of key-value pairs
package/dist/cli/cli.js CHANGED
@@ -1,22 +1,24 @@
1
1
  import Configstore from 'configstore';
2
2
  import fs from 'fs';
3
- import minimist from 'minimist';
4
3
  import { createRequire } from 'module';
5
4
  import os from 'os';
6
5
  import path from 'path';
7
6
  import { fileURLToPath, pathToFileURL } from 'url';
7
+ import yargs from 'yargs-parser';
8
+ import { ZodError } from 'zod';
8
9
  import Command, { CommandError } from '../Command.js';
9
10
  import config from '../config.js';
10
11
  import request from '../request.js';
11
12
  import { settingsNames } from '../settingsNames.js';
12
13
  import { telemetry } from '../telemetry.js';
13
14
  import { app } from '../utils/app.js';
15
+ import { browserUtil } from '../utils/browserUtil.js';
14
16
  import { formatting } from '../utils/formatting.js';
15
17
  import { md } from '../utils/md.js';
16
- import { validation } from '../utils/validation.js';
17
18
  import { prompt } from '../utils/prompt.js';
19
+ import { validation } from '../utils/validation.js';
20
+ import { zod } from '../utils/zod.js';
18
21
  import { timings } from './timings.js';
19
- import { browserUtil } from '../utils/browserUtil.js';
20
22
  const require = createRequire(import.meta.url);
21
23
  const __dirname = fileURLToPath(new URL('.', import.meta.url));
22
24
  let _config;
@@ -64,7 +66,7 @@ async function execute(rawArgs) {
64
66
  rawArgs.shift();
65
67
  }
66
68
  // parse args to see if a command has been specified
67
- const parsedArgs = minimist(rawArgs);
69
+ const parsedArgs = yargs(rawArgs);
68
70
  // load command
69
71
  await cli.loadCommandFromArgs(parsedArgs._);
70
72
  if (cli.commandToExecute) {
@@ -77,8 +79,7 @@ async function execute(rawArgs) {
77
79
  };
78
80
  }
79
81
  catch (e) {
80
- const optionsWithoutShorts = removeShortOptions({ options: parsedArgs });
81
- return cli.closeWithError(e.message, optionsWithoutShorts, false);
82
+ return cli.closeWithError(e.message, { options: parsedArgs }, false);
82
83
  }
83
84
  }
84
85
  else {
@@ -126,18 +127,30 @@ async function execute(rawArgs) {
126
127
  if (cli.optionsFromArgs.options.output === undefined) {
127
128
  cli.optionsFromArgs.options.output = cli.getSettingWithDefaultValue(settingsNames.output, 'json');
128
129
  }
129
- const startValidation = process.hrtime.bigint();
130
- const validationResult = await cli.commandToExecute.command.validate(cli.optionsFromArgs, cli.commandToExecute);
131
- const endValidation = process.hrtime.bigint();
132
- timings.validation.push(Number(endValidation - startValidation));
133
- if (validationResult !== true) {
134
- return cli.closeWithError(validationResult, cli.optionsFromArgs, true);
130
+ let finalArgs = cli.optionsFromArgs.options;
131
+ if (cli.commandToExecute?.command.schema) {
132
+ const startValidation = process.hrtime.bigint();
133
+ const result = cli.commandToExecute.command.getSchemaToParse().safeParse(cli.optionsFromArgs.options);
134
+ const endValidation = process.hrtime.bigint();
135
+ timings.validation.push(Number(endValidation - startValidation));
136
+ if (!result.success) {
137
+ return cli.closeWithError(result.error, cli.optionsFromArgs, true);
138
+ }
139
+ finalArgs = result.data;
140
+ }
141
+ else {
142
+ const startValidation = process.hrtime.bigint();
143
+ const validationResult = await cli.commandToExecute.command.validate(cli.optionsFromArgs, cli.commandToExecute);
144
+ const endValidation = process.hrtime.bigint();
145
+ timings.validation.push(Number(endValidation - startValidation));
146
+ if (validationResult !== true) {
147
+ return cli.closeWithError(validationResult, cli.optionsFromArgs, true);
148
+ }
135
149
  }
136
- cli.optionsFromArgs = removeShortOptions(cli.optionsFromArgs);
137
150
  const end = process.hrtime.bigint();
138
151
  timings.core.push(Number(end - start));
139
152
  try {
140
- await cli.executeCommand(cli.commandToExecute.command, cli.optionsFromArgs);
153
+ await cli.executeCommand(cli.commandToExecute.command, { options: finalArgs });
141
154
  const endTotal = process.hrtime.bigint();
142
155
  timings.total.push(Number(endTotal - start));
143
156
  await printTimings(rawArgs);
@@ -347,12 +360,14 @@ async function loadCommandFromFile(commandFileUrl) {
347
360
  catch { }
348
361
  }
349
362
  function getCommandInfo(command, filePath = '', helpFilePath = '') {
363
+ const options = command.schema ? zod.schemaToOptions(command.schema) : getCommandOptions(command);
364
+ command.optionsInfo = options;
350
365
  return {
351
366
  aliases: command.alias(),
352
367
  name: command.name,
353
368
  description: command.description,
354
369
  command: command,
355
- options: getCommandOptions(command),
370
+ options,
356
371
  defaultProperties: command.defaultProperties(),
357
372
  file: filePath,
358
373
  help: helpFilePath
@@ -387,36 +402,47 @@ function getCommandOptions(command) {
387
402
  return options;
388
403
  }
389
404
  function getCommandOptionsFromArgs(args, commandInfo) {
390
- const minimistOptions = {
391
- alias: {}
405
+ const yargsOptions = {
406
+ alias: {},
407
+ configuration: {
408
+ "parse-numbers": false,
409
+ "strip-aliased": true,
410
+ "strip-dashed": true
411
+ }
392
412
  };
393
413
  let argsToParse = args;
394
414
  if (commandInfo) {
395
- const commandTypes = commandInfo.command.types;
396
- if (commandTypes) {
397
- minimistOptions.string = commandTypes.string;
398
- // minimist will parse unused boolean options to 'false' (unused options => options that are not included in the args)
399
- // But in the CLI booleans are nullable. They can can be true, false or undefined.
400
- // For this reason we only pass boolean types that are actually used as arg.
401
- minimistOptions.boolean = commandTypes.boolean.filter(optionName => args.some(arg => `--${optionName}` === arg || `-${optionName}` === arg));
402
- }
403
- minimistOptions.alias = {};
415
+ if (commandInfo.command.schema) {
416
+ yargsOptions.string = commandInfo.options.filter(o => o.type === 'string').map(o => o.name);
417
+ yargsOptions.boolean = commandInfo.options.filter(o => o.type === 'boolean').map(o => o.name);
418
+ yargsOptions.number = commandInfo.options.filter(o => o.type === 'number').map(o => o.name);
419
+ argsToParse = getRewrittenArgs(args, yargsOptions.boolean);
420
+ }
421
+ else {
422
+ const commandTypes = commandInfo.command.types;
423
+ if (commandTypes) {
424
+ yargsOptions.string = commandTypes.string;
425
+ // minimist will parse unused boolean options to 'false' (unused options => options that are not included in the args)
426
+ // But in the CLI booleans are nullable. They can can be true, false or undefined.
427
+ // For this reason we only pass boolean types that are actually used as arg.
428
+ yargsOptions.boolean = commandTypes.boolean.filter(optionName => args.some(arg => `--${optionName}` === arg || `-${optionName}` === arg));
429
+ }
430
+ argsToParse = getRewrittenArgs(args, commandTypes.boolean);
431
+ }
404
432
  commandInfo.options.forEach(option => {
405
433
  if (option.short && option.long) {
406
- minimistOptions.alias[option.short] = option.long;
434
+ yargsOptions.alias[option.long] = option.short;
407
435
  }
408
436
  });
409
- argsToParse = getRewrittenArgs(args, commandTypes);
410
437
  }
411
- return minimist(argsToParse, minimistOptions);
438
+ return yargs(argsToParse, yargsOptions);
412
439
  }
413
440
  /**
414
441
  * Rewrites arguments (if necessary) before passing them into minimist.
415
442
  * Currently only boolean values are checked and fixed.
416
443
  * Args are only checked and rewritten if the option has been added to the 'types.boolean' array.
417
444
  */
418
- function getRewrittenArgs(args, commandTypes) {
419
- const booleanTypes = commandTypes.boolean;
445
+ function getRewrittenArgs(args, booleanTypes) {
420
446
  if (booleanTypes.length === 0) {
421
447
  return args;
422
448
  }
@@ -722,6 +748,9 @@ async function closeWithError(error, args, showHelpIfEnabled = false) {
722
748
  return process.exit(exitCode);
723
749
  }
724
750
  let errorMessage = error instanceof CommandError ? error.message : error;
751
+ if (error instanceof ZodError) {
752
+ errorMessage = error.errors.map(e => `${e.path}: ${e.message}`).join(os.EOL);
753
+ }
725
754
  if ((!args.options.output || args.options.output === 'json') &&
726
755
  !cli.getSettingWithDefaultValue(settingsNames.printErrorsAsPlainText, true)) {
727
756
  errorMessage = JSON.stringify({ error: errorMessage });
@@ -780,13 +809,6 @@ async function handleMultipleResultsFound(message, values) {
780
809
  const response = await cli.promptForSelection({ message: `Please choose one:`, choices });
781
810
  return values[response];
782
811
  }
783
- function removeShortOptions(args) {
784
- const filteredArgs = JSON.parse(JSON.stringify(args));
785
- const optionsToRemove = Object.getOwnPropertyNames(args.options)
786
- .filter(option => option.length === 1 || option === '--');
787
- optionsToRemove.forEach(option => delete filteredArgs.options[option]);
788
- return filteredArgs;
789
- }
790
812
  function loadOptionValuesFromFiles(args) {
791
813
  const optionNames = Object.getOwnPropertyNames(args.options);
792
814
  optionNames.forEach(option => {
package/dist/config.js CHANGED
@@ -3,7 +3,7 @@ const cliEntraAppId = '31359c7f-bd7e-475c-86db-fdb8c937548e';
3
3
  export default {
4
4
  applicationName: `CLI for Microsoft 365 v${app.packageJson().version}`,
5
5
  delimiter: 'm365\$',
6
- cliEntraAppId: process.env.CLIMICROSOFT365_ENTRAAPPID || process.env.CLIMICROSOFT365_AADAPPID || cliEntraAppId,
6
+ cliEntraAppId: process.env.CLIMICROSOFT365_ENTRAAPPID || cliEntraAppId,
7
7
  tenant: process.env.CLIMICROSOFT365_TENANT || 'common',
8
8
  configstoreName: 'cli-m365-config'
9
9
  };
@@ -33,12 +33,12 @@ class AppPermissionAddCommand extends AppCommand {
33
33
  const appObject = await this.getAppObject();
34
34
  const servicePrincipals = await odata.getAllItems(`${this.resource}/v1.0/myorganization/servicePrincipals?$select=appId,appRoles,id,oauth2PermissionScopes,servicePrincipalNames`);
35
35
  const appPermissions = [];
36
- if (args.options.delegatedPermission) {
37
- const delegatedPermissions = await this.getRequiredResourceAccessForApis(servicePrincipals, args.options.delegatedPermission, ScopeType.Scope, appPermissions, logger);
36
+ if (args.options.delegatedPermissions) {
37
+ const delegatedPermissions = await this.getRequiredResourceAccessForApis(servicePrincipals, args.options.delegatedPermissions, ScopeType.Scope, appPermissions, logger);
38
38
  this.addPermissionsToResourceArray(delegatedPermissions, appObject.requiredResourceAccess);
39
39
  }
40
- if (args.options.applicationPermission) {
41
- const applicationPermissions = await this.getRequiredResourceAccessForApis(servicePrincipals, args.options.applicationPermission, ScopeType.Role, appPermissions, logger);
40
+ if (args.options.applicationPermissions) {
41
+ const applicationPermissions = await this.getRequiredResourceAccessForApis(servicePrincipals, args.options.applicationPermissions, ScopeType.Role, appPermissions, logger);
42
42
  this.addPermissionsToResourceArray(applicationPermissions, appObject.requiredResourceAccess);
43
43
  }
44
44
  const addPermissionsRequestOptions = {
@@ -198,17 +198,17 @@ _AppPermissionAddCommand_instances = new WeakSet(), _AppPermissionAddCommand_ini
198
198
  this.telemetry.push((args) => {
199
199
  Object.assign(this.telemetryProperties, {
200
200
  appId: typeof args.options.appId !== 'undefined',
201
- applicationPermission: typeof args.options.applicationPermission !== 'undefined',
202
- delegatedPermission: typeof args.options.delegatedPermission !== 'undefined',
201
+ applicationPermissions: typeof args.options.applicationPermissions !== 'undefined',
202
+ delegatedPermissions: typeof args.options.delegatedPermissions !== 'undefined',
203
203
  grantAdminConsent: !!args.options.grantAdminConsent
204
204
  });
205
205
  });
206
206
  }, _AppPermissionAddCommand_initOptions = function _AppPermissionAddCommand_initOptions() {
207
- this.options.unshift({ option: '--appId [appId]' }, { option: '--applicationPermission [applicationPermission]' }, { option: '--delegatedPermission [delegatedPermission]' }, { option: '--grantAdminConsent' });
207
+ this.options.unshift({ option: '--appId [appId]' }, { option: '--applicationPermissions [applicationPermissions]' }, { option: '--delegatedPermissions [delegatedPermissions]' }, { option: '--grantAdminConsent' });
208
208
  }, _AppPermissionAddCommand_initOptionSets = function _AppPermissionAddCommand_initOptionSets() {
209
209
  this.optionSets.push({
210
- options: ['applicationPermission', 'delegatedPermission'],
211
- runsWhen: (args) => args.options.delegatedPermission === undefined && args.options.applicationPermission === undefined
210
+ options: ['applicationPermissions', 'delegatedPermissions'],
211
+ runsWhen: (args) => args.options.delegatedPermissions === undefined && args.options.applicationPermissions === undefined
212
212
  });
213
213
  };
214
214
  export default new AppPermissionAddCommand();
@@ -1,17 +1,30 @@
1
- var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
2
- if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
3
- 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");
4
- return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
5
- };
6
- var _LoginCommand_instances, _a, _LoginCommand_initTelemetry, _LoginCommand_initOptions, _LoginCommand_initValidators;
7
1
  import fs from 'fs';
2
+ import { z } from 'zod';
8
3
  import auth, { AuthType, CloudType } from '../../Auth.js';
9
- import Command, { CommandError } from '../../Command.js';
4
+ import Command, { CommandError, globalOptionsZod } from '../../Command.js';
5
+ import { cli } from '../../cli/cli.js';
10
6
  import config from '../../config.js';
11
- import { misc } from '../../utils/misc.js';
12
- import commands from './commands.js';
13
7
  import { settingsNames } from '../../settingsNames.js';
14
- import { cli } from '../../cli/cli.js';
8
+ import { zod } from '../../utils/zod.js';
9
+ import commands from './commands.js';
10
+ const options = globalOptionsZod
11
+ .extend({
12
+ authType: zod.alias('t', z.enum(['certificate', 'deviceCode', 'password', 'identity', 'browser', 'secret']).optional()),
13
+ cloud: z.nativeEnum(CloudType).optional().default(CloudType.Public),
14
+ userName: zod.alias('u', z.string().optional()),
15
+ password: zod.alias('p', z.string().optional()),
16
+ certificateFile: zod.alias('c', z.string().optional()
17
+ .refine(filePath => !filePath || fs.existsSync(filePath), filePath => ({
18
+ message: `Certificate file ${filePath} does not exist`
19
+ }))),
20
+ certificateBase64Encoded: z.string().optional(),
21
+ thumbprint: z.string().optional(),
22
+ appId: z.string().optional(),
23
+ tenant: z.string().optional(),
24
+ secret: zod.alias('s', z.string().optional()),
25
+ connectionName: z.string().optional()
26
+ })
27
+ .strict();
15
28
  class LoginCommand extends Command {
16
29
  get name() {
17
30
  return commands.LOGIN;
@@ -19,12 +32,26 @@ class LoginCommand extends Command {
19
32
  get description() {
20
33
  return 'Log in to Microsoft 365';
21
34
  }
22
- constructor() {
23
- super();
24
- _LoginCommand_instances.add(this);
25
- __classPrivateFieldGet(this, _LoginCommand_instances, "m", _LoginCommand_initTelemetry).call(this);
26
- __classPrivateFieldGet(this, _LoginCommand_instances, "m", _LoginCommand_initOptions).call(this);
27
- __classPrivateFieldGet(this, _LoginCommand_instances, "m", _LoginCommand_initValidators).call(this);
35
+ get schema() {
36
+ return options;
37
+ }
38
+ getRefinedSchema(schema) {
39
+ return schema
40
+ .refine(options => options.authType !== 'password' || options.userName, {
41
+ message: 'Username is required when using password authentication'
42
+ })
43
+ .refine(options => options.authType !== 'password' || options.password, {
44
+ message: 'Password is required when using password authentication'
45
+ })
46
+ .refine(options => options.authType !== 'certificate' || !(options.certificateFile && options.certificateBase64Encoded), {
47
+ message: 'Specify either certificateFile or certificateBase64Encoded, but not both.'
48
+ })
49
+ .refine(options => options.authType !== 'certificate' || options.certificateFile || options.certificateBase64Encoded, {
50
+ message: 'Specify either certificateFile or certificateBase64Encoded'
51
+ })
52
+ .refine(options => options.authType !== 'secret' || options.secret, {
53
+ message: 'Secret is required when using secret authentication'
54
+ });
28
55
  }
29
56
  async commandAction(logger, args) {
30
57
  // disconnect before re-connecting
@@ -64,12 +91,7 @@ class LoginCommand extends Command {
64
91
  auth.connection.secret = args.options.secret;
65
92
  break;
66
93
  }
67
- if (args.options.cloud) {
68
- auth.connection.cloudType = CloudType[args.options.cloud];
69
- }
70
- else {
71
- auth.connection.cloudType = CloudType.Public;
72
- }
94
+ auth.connection.cloudType = args.options.cloud;
73
95
  try {
74
96
  await auth.ensureAccessToken(auth.defaultResource, logger, this.debug);
75
97
  auth.connection.active = true;
@@ -102,79 +124,5 @@ class LoginCommand extends Command {
102
124
  await this.commandAction(logger, args);
103
125
  }
104
126
  }
105
- _a = LoginCommand, _LoginCommand_instances = new WeakSet(), _LoginCommand_initTelemetry = function _LoginCommand_initTelemetry() {
106
- this.telemetry.push((args) => {
107
- Object.assign(this.telemetryProperties, {
108
- authType: args.options.authType || cli.getSettingWithDefaultValue(settingsNames.authType, 'deviceCode'),
109
- cloud: args.options.cloud ?? CloudType.Public
110
- });
111
- });
112
- }, _LoginCommand_initOptions = function _LoginCommand_initOptions() {
113
- this.options.unshift({
114
- option: '-t, --authType [authType]',
115
- autocomplete: _a.allowedAuthTypes
116
- }, {
117
- option: '-u, --userName [userName]'
118
- }, {
119
- option: '-p, --password [password]'
120
- }, {
121
- option: '-c, --certificateFile [certificateFile]'
122
- }, {
123
- option: '--certificateBase64Encoded [certificateBase64Encoded]'
124
- }, {
125
- option: '--thumbprint [thumbprint]'
126
- }, {
127
- option: '--appId [appId]'
128
- }, {
129
- option: '--tenant [tenant]'
130
- }, {
131
- option: '-s, --secret [secret]'
132
- }, {
133
- option: '--cloud [cloud]',
134
- autocomplete: misc.getEnums(CloudType)
135
- }, {
136
- option: '--connectionName [connectionName]'
137
- });
138
- }, _LoginCommand_initValidators = function _LoginCommand_initValidators() {
139
- this.validators.push(async (args) => {
140
- const authType = args.options.authType || cli.getSettingWithDefaultValue(settingsNames.authType, 'deviceCode');
141
- if (authType === 'password') {
142
- if (!args.options.userName) {
143
- return 'Required option userName missing';
144
- }
145
- if (!args.options.password) {
146
- return 'Required option password missing';
147
- }
148
- }
149
- if (authType === 'certificate') {
150
- if (args.options.certificateFile && args.options.certificateBase64Encoded) {
151
- return 'Specify either certificateFile or certificateBase64Encoded, but not both.';
152
- }
153
- if (!args.options.certificateFile && !args.options.certificateBase64Encoded) {
154
- return 'Specify either certificateFile or certificateBase64Encoded';
155
- }
156
- if (args.options.certificateFile) {
157
- if (!fs.existsSync(args.options.certificateFile)) {
158
- return `File '${args.options.certificateFile}' does not exist`;
159
- }
160
- }
161
- }
162
- if (authType &&
163
- _a.allowedAuthTypes.indexOf(authType) < 0) {
164
- return `'${authType}' is not a valid authentication type. Allowed authentication types are ${_a.allowedAuthTypes.join(', ')}`;
165
- }
166
- if (authType === 'secret') {
167
- if (!args.options.secret) {
168
- return 'Required option secret missing';
169
- }
170
- }
171
- if (args.options.cloud &&
172
- typeof CloudType[args.options.cloud] === 'undefined') {
173
- return `${args.options.cloud} is not a valid value for cloud. Valid options are ${misc.getEnums(CloudType).join(', ')}`;
174
- }
175
- return true;
176
- });
177
- };
178
- LoginCommand.allowedAuthTypes = ['certificate', 'deviceCode', 'password', 'identity', 'browser', 'secret'];
179
127
  export default new LoginCommand();
180
128
  //# sourceMappingURL=login.js.map
@@ -30,8 +30,8 @@ class StatusCommand extends Command {
30
30
  const connections = await auth.getAllConnections();
31
31
  if (this.verbose) {
32
32
  const message = connections.length > 0
33
- ? `Logged out from Microsoft 365, signed in connections available`
34
- : 'Logged out from Microsoft 365';
33
+ ? `Logged out, signed in connections available`
34
+ : 'Logged out';
35
35
  await logger.logToStderr(message);
36
36
  }
37
37
  else {
@@ -3,7 +3,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
3
3
  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");
4
4
  return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
5
5
  };
6
- var _ConnectionRemoveCommand_instances, _ConnectionRemoveCommand_initTelemetry, _ConnectionRemoveCommand_initOptions;
6
+ var _ConnectionRemoveCommand_instances, _ConnectionRemoveCommand_initTelemetry, _ConnectionRemoveCommand_initOptions, _ConnectionRemoveCommand_initTypes;
7
7
  import auth from '../../../Auth.js';
8
8
  import commands from '../commands.js';
9
9
  import Command, { CommandError } from '../../../Command.js';
@@ -20,6 +20,7 @@ class ConnectionRemoveCommand extends Command {
20
20
  _ConnectionRemoveCommand_instances.add(this);
21
21
  __classPrivateFieldGet(this, _ConnectionRemoveCommand_instances, "m", _ConnectionRemoveCommand_initTelemetry).call(this);
22
22
  __classPrivateFieldGet(this, _ConnectionRemoveCommand_instances, "m", _ConnectionRemoveCommand_initOptions).call(this);
23
+ __classPrivateFieldGet(this, _ConnectionRemoveCommand_instances, "m", _ConnectionRemoveCommand_initTypes).call(this);
23
24
  }
24
25
  async commandAction(logger, args) {
25
26
  const deleteConnection = async () => {
@@ -53,7 +54,7 @@ class ConnectionRemoveCommand extends Command {
53
54
  _ConnectionRemoveCommand_instances = new WeakSet(), _ConnectionRemoveCommand_initTelemetry = function _ConnectionRemoveCommand_initTelemetry() {
54
55
  this.telemetry.push((args) => {
55
56
  Object.assign(this.telemetryProperties, {
56
- force: (!(!args.options.force)).toString()
57
+ force: !!args.options.force
57
58
  });
58
59
  });
59
60
  }, _ConnectionRemoveCommand_initOptions = function _ConnectionRemoveCommand_initOptions() {
@@ -62,6 +63,9 @@ _ConnectionRemoveCommand_instances = new WeakSet(), _ConnectionRemoveCommand_ini
62
63
  }, {
63
64
  option: '-f, --force'
64
65
  });
66
+ }, _ConnectionRemoveCommand_initTypes = function _ConnectionRemoveCommand_initTypes() {
67
+ this.types.string.push('name');
68
+ this.types.boolean.push('force');
65
69
  };
66
70
  export default new ConnectionRemoveCommand();
67
71
  //# sourceMappingURL=connection-remove.js.map
@@ -3,7 +3,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
3
3
  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");
4
4
  return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
5
5
  };
6
- var _ConnectionSetCommand_instances, _ConnectionSetCommand_initOptions, _ConnectionSetCommand_initValidators;
6
+ var _ConnectionSetCommand_instances, _ConnectionSetCommand_initOptions, _ConnectionSetCommand_initValidators, _ConnectionSetCommand_initTypes;
7
7
  import auth from '../../../Auth.js';
8
8
  import commands from '../commands.js';
9
9
  import Command, { CommandError } from '../../../Command.js';
@@ -19,6 +19,7 @@ class ConnectionSetCommand extends Command {
19
19
  _ConnectionSetCommand_instances.add(this);
20
20
  __classPrivateFieldGet(this, _ConnectionSetCommand_instances, "m", _ConnectionSetCommand_initOptions).call(this);
21
21
  __classPrivateFieldGet(this, _ConnectionSetCommand_instances, "m", _ConnectionSetCommand_initValidators).call(this);
22
+ __classPrivateFieldGet(this, _ConnectionSetCommand_instances, "m", _ConnectionSetCommand_initTypes).call(this);
22
23
  }
23
24
  async commandAction(logger, args) {
24
25
  const connection = await auth.getConnection(args.options.name);
@@ -51,6 +52,8 @@ _ConnectionSetCommand_instances = new WeakSet(), _ConnectionSetCommand_initOptio
51
52
  }
52
53
  return true;
53
54
  });
55
+ }, _ConnectionSetCommand_initTypes = function _ConnectionSetCommand_initTypes() {
56
+ this.types.string.push('name', 'newName');
54
57
  };
55
58
  export default new ConnectionSetCommand();
56
59
  //# sourceMappingURL=connection-set.js.map