@pnp/cli-microsoft365 5.9.0-beta.5aade58 → 5.9.0-beta.78b8547

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 (47) hide show
  1. package/.eslintrc.js +2 -0
  2. package/dist/appInsights.js +2 -0
  3. package/dist/m365/pp/commands/dataverse/dataverse-table-list.js +75 -0
  4. package/dist/m365/pp/commands/tenant/tenant-settings-list.js +45 -0
  5. package/dist/m365/pp/commands.js +3 -1
  6. package/dist/m365/spfx/commands/project/project-upgrade/upgrade-1.14.0.js +0 -2
  7. package/dist/m365/spfx/commands/spfx-doctor.js +52 -7
  8. package/dist/m365/spo/commands/file/file-roleassignment-add.js +231 -0
  9. package/dist/m365/spo/commands/file/file-roleassignment-remove.js +180 -0
  10. package/dist/m365/spo/commands/file/file-roleinheritance-reset.js +125 -0
  11. package/dist/m365/spo/commands/folder/folder-roleinheritance-break.js +94 -0
  12. package/dist/m365/spo/commands/folder/folder-roleinheritance-reset.js +89 -0
  13. package/dist/m365/spo/commands.js +5 -0
  14. package/dist/utils/cache.js +81 -0
  15. package/dist/utils/pid.js +57 -0
  16. package/dist/utils/powerPlatform.js +42 -0
  17. package/docs/docs/cmd/aad/o365group/o365group-recyclebinitem-restore.md +1 -1
  18. package/docs/docs/cmd/aad/user/user-signin-list.md +1 -1
  19. package/docs/docs/cmd/onedrive/report/report-activityusercounts.md +1 -1
  20. package/docs/docs/cmd/planner/task/task-checklistitem-list.md +1 -1
  21. package/docs/docs/cmd/planner/task/task-reference-add.md +1 -1
  22. package/docs/docs/cmd/pp/dataverse/dataverse-table-list.md +33 -0
  23. package/docs/docs/cmd/pp/tenant/tenant-settings-list.md +26 -0
  24. package/docs/docs/cmd/search/externalconnection/externalconnection-remove.md +1 -1
  25. package/docs/docs/cmd/spfx/spfx-doctor.md +10 -1
  26. package/docs/docs/cmd/spo/file/file-roleassignment-add.md +57 -0
  27. package/docs/docs/cmd/spo/file/file-roleassignment-remove.md +54 -0
  28. package/docs/docs/cmd/spo/file/file-roleinheritance-reset.md +39 -0
  29. package/docs/docs/cmd/spo/folder/folder-roleinheritance-break.md +39 -0
  30. package/docs/docs/cmd/spo/folder/folder-roleinheritance-reset.md +36 -0
  31. package/docs/docs/cmd/spo/hubsite/hubsite-disconnect.md +1 -1
  32. package/docs/docs/cmd/spo/hubsite/hubsite-get.md +3 -3
  33. package/docs/docs/cmd/spo/list/list-roleassignment-add.md +1 -1
  34. package/docs/docs/cmd/spo/list/list-roleassignment-remove.md +1 -1
  35. package/docs/docs/cmd/spo/listitem/listitem-roleassignment-remove.md +1 -1
  36. package/docs/docs/cmd/spo/roledefinition/roledefinition-add.md +1 -1
  37. package/docs/docs/cmd/spo/web/web-roleinheritance-reset.md +1 -1
  38. package/docs/docs/cmd/teams/cache/cache-remove.md +1 -1
  39. package/docs/docs/cmd/teams/channel/channel-add.md +1 -1
  40. package/docs/docs/cmd/teams/channel/channel-member-set.md +1 -1
  41. package/docs/docs/cmd/teams/funsettings/funsettings-set.md +6 -6
  42. package/docs/docs/cmd/tenant/security/security-alerts-list.md +1 -1
  43. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-get.md +1 -1
  44. package/docs/docs/cmd/tenant/serviceannouncement/serviceannouncement-health-list.md +1 -1
  45. package/npm-shrinkwrap.json +342 -357
  46. package/package.json +21 -18
  47. package/dist/m365/spfx/commands/project/project-upgrade/rules/FN006006_CFG_PS_features.js +0 -60
package/.eslintrc.js CHANGED
@@ -17,6 +17,7 @@ const dictionary = [
17
17
  'content',
18
18
  'conversation',
19
19
  'custom',
20
+ 'dataverse',
20
21
  'default',
21
22
  'external',
22
23
  'externalize',
@@ -61,6 +62,7 @@ const dictionary = [
61
62
  'site',
62
63
  'status',
63
64
  'storage',
65
+ 'table',
64
66
  'teams',
65
67
  'token',
66
68
  'type',
@@ -10,6 +10,7 @@ const appInsights = require("applicationinsights");
10
10
  const crypto = require("crypto");
11
11
  const fs = require("fs");
12
12
  const path = require("path");
13
+ const pid_1 = require("./utils/pid");
13
14
  const config = appInsights.setup('6b908c80-d09f-4cf6-8274-e54349a0149a');
14
15
  config.setInternalLogging(false, false);
15
16
  // append -dev to the version number when ran locally
@@ -20,6 +21,7 @@ const env = process.env.CLIMICROSOFT365_ENV !== undefined ? process.env.CLIMICRO
20
21
  appInsights.defaultClient.commonProperties = {
21
22
  version: version,
22
23
  node: process.version,
24
+ shell: pid_1.pid.getProcessName(process.ppid) || '',
23
25
  env: env,
24
26
  ci: Boolean(process.env.CI).toString()
25
27
  };
@@ -0,0 +1,75 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
12
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
13
+ 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");
14
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
15
+ };
16
+ var _PpDataverseTableListCommand_instances, _PpDataverseTableListCommand_initTelemetry, _PpDataverseTableListCommand_initOptions;
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ const request_1 = require("../../../../request");
19
+ const powerPlatform_1 = require("../../../../utils/powerPlatform");
20
+ const PowerPlatformCommand_1 = require("../../../base/PowerPlatformCommand");
21
+ const commands_1 = require("../../commands");
22
+ class PpDataverseTableListCommand extends PowerPlatformCommand_1.default {
23
+ constructor() {
24
+ super();
25
+ _PpDataverseTableListCommand_instances.add(this);
26
+ __classPrivateFieldGet(this, _PpDataverseTableListCommand_instances, "m", _PpDataverseTableListCommand_initTelemetry).call(this);
27
+ __classPrivateFieldGet(this, _PpDataverseTableListCommand_instances, "m", _PpDataverseTableListCommand_initOptions).call(this);
28
+ }
29
+ get name() {
30
+ return commands_1.default.DATAVERSE_TABLE_LIST;
31
+ }
32
+ get description() {
33
+ return 'Lists dataverse tables in a given environment';
34
+ }
35
+ defaultProperties() {
36
+ return ['SchemaName', 'EntitySetName', 'IsManaged'];
37
+ }
38
+ commandAction(logger, args) {
39
+ return __awaiter(this, void 0, void 0, function* () {
40
+ if (this.verbose) {
41
+ logger.logToStderr(`Retrieving list of tables for which the user is an admin...`);
42
+ }
43
+ const dynamicsApiUrl = yield powerPlatform_1.powerPlatform.getDynamicsInstanceApiUrl(args.options.environment, args.options.asAdmin);
44
+ const requestOptions = {
45
+ url: `${dynamicsApiUrl}/api/data/v9.0/EntityDefinitions?$select=MetadataId,IsCustomEntity,IsManaged,SchemaName,IconVectorName,LogicalName,EntitySetName,IsActivity,DataProviderId,IsRenameable,IsCustomizable,CanCreateForms,CanCreateViews,CanCreateCharts,CanCreateAttributes,CanChangeTrackingBeEnabled,CanModifyAdditionalSettings,CanChangeHierarchicalRelationship,CanEnableSyncToExternalSearchIndex&$filter=(IsIntersect eq false and IsLogicalEntity eq false and%0APrimaryNameAttribute ne null and PrimaryNameAttribute ne %27%27 and ObjectTypeCode gt 0 and%0AObjectTypeCode ne 4712 and ObjectTypeCode ne 4724 and ObjectTypeCode ne 9933 and ObjectTypeCode ne 9934 and%0AObjectTypeCode ne 9935 and ObjectTypeCode ne 9947 and ObjectTypeCode ne 9945 and ObjectTypeCode ne 9944 and%0AObjectTypeCode ne 9942 and ObjectTypeCode ne 9951 and ObjectTypeCode ne 2016 and ObjectTypeCode ne 9949 and%0AObjectTypeCode ne 9866 and ObjectTypeCode ne 9867 and ObjectTypeCode ne 9868) and (IsCustomizable/Value eq true or IsCustomEntity eq true or IsManaged eq false or IsMappable/Value eq true or IsRenameable/Value eq true)&api-version=9.1`,
46
+ headers: {
47
+ accept: 'application/json;odata.metadata=none'
48
+ },
49
+ responseType: 'json'
50
+ };
51
+ try {
52
+ const res = yield request_1.default.get(requestOptions);
53
+ logger.log(res.value);
54
+ }
55
+ catch (err) {
56
+ this.handleRejectedODataJsonPromise(err);
57
+ }
58
+ });
59
+ }
60
+ }
61
+ _PpDataverseTableListCommand_instances = new WeakSet(), _PpDataverseTableListCommand_initTelemetry = function _PpDataverseTableListCommand_initTelemetry() {
62
+ this.telemetry.push((args) => {
63
+ Object.assign(this.telemetryProperties, {
64
+ asAdmin: !!args.options.asAdmin
65
+ });
66
+ });
67
+ }, _PpDataverseTableListCommand_initOptions = function _PpDataverseTableListCommand_initOptions() {
68
+ this.options.unshift({
69
+ option: '-e, --environment <environment>'
70
+ }, {
71
+ option: '-a, --asAdmin'
72
+ });
73
+ };
74
+ module.exports = new PpDataverseTableListCommand();
75
+ //# sourceMappingURL=dataverse-table-list.js.map
@@ -0,0 +1,45 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ const request_1 = require("../../../../request");
13
+ const PowerPlatformCommand_1 = require("../../../base/PowerPlatformCommand");
14
+ const commands_1 = require("../../commands");
15
+ class PpTenantSettingsListCommand extends PowerPlatformCommand_1.default {
16
+ get name() {
17
+ return commands_1.default.TENANT_SETTINGS_LIST;
18
+ }
19
+ get description() {
20
+ return 'Lists the global Power Platform tenant settings';
21
+ }
22
+ defaultProperties() {
23
+ return ['disableCapacityAllocationByEnvironmentAdmins', 'disableEnvironmentCreationByNonAdminUsers', 'disableNPSCommentsReachout', 'disablePortalsCreationByNonAdminUsers', 'disableSupportTicketsVisibleByAllUsers', 'disableSurveyFeedback', 'disableTrialEnvironmentCreationByNonAdminUsers', 'walkMeOptOut'];
24
+ }
25
+ commandAction(logger) {
26
+ return __awaiter(this, void 0, void 0, function* () {
27
+ const requestOptions = {
28
+ url: `${this.resource}/providers/Microsoft.BusinessAppPlatform/listtenantsettings?api-version=2020-10-01`,
29
+ headers: {
30
+ accept: 'application/json'
31
+ },
32
+ responseType: 'json'
33
+ };
34
+ try {
35
+ const res = yield request_1.default.post(requestOptions);
36
+ logger.log(res);
37
+ }
38
+ catch (err) {
39
+ this.handleRejectedODataJsonPromise(err);
40
+ }
41
+ });
42
+ }
43
+ }
44
+ module.exports = new PpTenantSettingsListCommand();
45
+ //# sourceMappingURL=tenant-settings-list.js.map
@@ -2,9 +2,11 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  const prefix = 'pp';
4
4
  exports.default = {
5
+ DATAVERSE_TABLE_LIST: `${prefix} dataverse table list`,
5
6
  ENVIRONMENT_LIST: `${prefix} environment list`,
6
7
  GATEWAY_LIST: `${prefix} gateway list`,
7
8
  MANAGEMENTAPP_ADD: `${prefix} managementapp add`,
8
- MANAGEMENTAPP_LIST: `${prefix} managementapp list`
9
+ MANAGEMENTAPP_LIST: `${prefix} managementapp list`,
10
+ TENANT_SETTINGS_LIST: `${prefix} tenant settings list`
9
11
  };
10
12
  //# sourceMappingURL=commands.js.map
@@ -25,7 +25,6 @@ const FN002009_DEVDEP_microsoft_sp_tslint_rules_1 = require("./rules/FN002009_DE
25
25
  const FN002019_DEVDEP_spfx_fast_serve_helpers_1 = require("./rules/FN002019_DEVDEP_spfx_fast_serve_helpers");
26
26
  const FN006004_CFG_PS_developer_1 = require("./rules/FN006004_CFG_PS_developer");
27
27
  const FN006005_CFG_PS_metadata_1 = require("./rules/FN006005_CFG_PS_metadata");
28
- const FN006006_CFG_PS_features_1 = require("./rules/FN006006_CFG_PS_features");
29
28
  const FN010001_YORC_version_1 = require("./rules/FN010001_YORC_version");
30
29
  const FN014008_CODE_launch_hostedWorkbench_type_1 = require("./rules/FN014008_CODE_launch_hostedWorkbench_type");
31
30
  module.exports = [
@@ -54,7 +53,6 @@ module.exports = [
54
53
  new FN002019_DEVDEP_spfx_fast_serve_helpers_1.FN002019_DEVDEP_spfx_fast_serve_helpers('1.14.0'),
55
54
  new FN006004_CFG_PS_developer_1.FN006004_CFG_PS_developer('1.14.0'),
56
55
  new FN006005_CFG_PS_metadata_1.FN006005_CFG_PS_metadata(),
57
- new FN006006_CFG_PS_features_1.FN006006_CFG_PS_features(),
58
56
  new FN010001_YORC_version_1.FN010001_YORC_version('1.14.0'),
59
57
  new FN014008_CODE_launch_hostedWorkbench_type_1.FN014008_CODE_launch_hostedWorkbench_type('pwa-chrome')
60
58
  ];
@@ -13,7 +13,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
13
13
  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");
14
14
  return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
15
15
  };
16
- var _SpfxDoctorCommand_instances, _SpfxDoctorCommand_initTelemetry, _SpfxDoctorCommand_initOptions, _SpfxDoctorCommand_initValidators, _SpfxDoctorCommand_initTypes;
16
+ var _SpfxDoctorCommand_instances, _SpfxDoctorCommand_initTelemetry, _SpfxDoctorCommand_initOptions, _SpfxDoctorCommand_initValidators;
17
17
  Object.defineProperty(exports, "__esModule", { value: true });
18
18
  const chalk = require("chalk");
19
19
  const child_process = require("child_process");
@@ -428,12 +428,26 @@ class SpfxDoctorCommand extends AnonymousCommand_1.default {
428
428
  range: '^4',
429
429
  fix: 'npm i -g yo@4'
430
430
  }
431
+ },
432
+ '1.16.0-beta.1': {
433
+ gulpCli: {
434
+ range: '^1 || ^2',
435
+ fix: 'npm i -g gulp-cli@2'
436
+ },
437
+ node: {
438
+ range: '^16.13',
439
+ fix: 'Install Node.js v16.13 or higher'
440
+ },
441
+ sp: SharePointVersion.SPO,
442
+ yo: {
443
+ range: '^4',
444
+ fix: 'npm i -g yo@4'
445
+ }
431
446
  }
432
447
  };
433
448
  __classPrivateFieldGet(this, _SpfxDoctorCommand_instances, "m", _SpfxDoctorCommand_initTelemetry).call(this);
434
449
  __classPrivateFieldGet(this, _SpfxDoctorCommand_instances, "m", _SpfxDoctorCommand_initOptions).call(this);
435
450
  __classPrivateFieldGet(this, _SpfxDoctorCommand_instances, "m", _SpfxDoctorCommand_initValidators).call(this);
436
- __classPrivateFieldGet(this, _SpfxDoctorCommand_instances, "m", _SpfxDoctorCommand_initTypes).call(this);
437
451
  }
438
452
  get name() {
439
453
  return commands_1.default.DOCTOR;
@@ -442,6 +456,7 @@ class SpfxDoctorCommand extends AnonymousCommand_1.default {
442
456
  return 'Verifies environment configuration for using the specific version of the SharePoint Framework';
443
457
  }
444
458
  commandAction(logger, args) {
459
+ var _a;
445
460
  return __awaiter(this, void 0, void 0, function* () {
446
461
  if (!args.options.output) {
447
462
  args.options.output = 'text';
@@ -454,7 +469,7 @@ class SpfxDoctorCommand extends AnonymousCommand_1.default {
454
469
  let prerequisites;
455
470
  const fixes = [];
456
471
  try {
457
- spfxVersion = yield this.getSharePointFrameworkVersion(logger);
472
+ spfxVersion = (_a = args.options.spfxVersion) !== null && _a !== void 0 ? _a : yield this.getSharePointFrameworkVersion(logger);
458
473
  if (!spfxVersion) {
459
474
  logger.log(this.getStatus(CheckStatus.Failure, `SharePoint Framework`));
460
475
  throw `SharePoint Framework not found`;
@@ -464,7 +479,13 @@ class SpfxDoctorCommand extends AnonymousCommand_1.default {
464
479
  logger.log(this.getStatus(CheckStatus.Failure, `SharePoint Framework v${spfxVersion}`));
465
480
  throw `spfx doctor doesn't support SPFx v${spfxVersion} at this moment`;
466
481
  }
467
- logger.log(this.getStatus(CheckStatus.Success, `SharePoint Framework v${spfxVersion}`));
482
+ if (args.options.spfxVersion) {
483
+ yield this.checkSharePointFrameworkVersion(args.options.spfxVersion, fixes, logger);
484
+ }
485
+ else {
486
+ // spfx was detected and if we are here, it means that we support it
487
+ logger.log(this.getStatus(CheckStatus.Success, `SharePoint Framework v${spfxVersion}`));
488
+ }
468
489
  yield this.checkSharePointCompatibility(spfxVersion, prerequisites, args, fixes, logger);
469
490
  yield this.checkNodeVersion(prerequisites, fixes, logger);
470
491
  yield this.checkYo(prerequisites, fixes, logger);
@@ -517,6 +538,23 @@ class SpfxDoctorCommand extends AnonymousCommand_1.default {
517
538
  this.checkStatus('Node', nodeVersion, prerequisites.node, OptionalOrRequired.Required, fixes, logger);
518
539
  });
519
540
  }
541
+ checkSharePointFrameworkVersion(spfxVersionRequested, fixes, logger) {
542
+ return this
543
+ .getPackageVersion('@microsoft/generator-sharepoint', PackageSearchMode.GlobalOnly, HandlePromise.Continue, logger)
544
+ .then((spfxVersionDetected) => {
545
+ const versionCheck = {
546
+ range: spfxVersionRequested,
547
+ fix: `npm i -g @microsoft/generator-sharepoint@${spfxVersionRequested}`
548
+ };
549
+ if (spfxVersionDetected) {
550
+ this.checkStatus(`SharePoint Framework`, spfxVersionDetected, versionCheck, OptionalOrRequired.Required, fixes, logger);
551
+ }
552
+ else {
553
+ logger.log(this.getStatus(CheckStatus.Failure, `SharePoint Framework v${spfxVersionRequested} not found`));
554
+ fixes.push(versionCheck.fix);
555
+ }
556
+ });
557
+ }
520
558
  checkYo(prerequisites, fixes, logger) {
521
559
  return this
522
560
  .getPackageVersion('yo', PackageSearchMode.GlobalOnly, HandlePromise.Continue, logger)
@@ -695,13 +733,17 @@ class SpfxDoctorCommand extends AnonymousCommand_1.default {
695
733
  _SpfxDoctorCommand_instances = new WeakSet(), _SpfxDoctorCommand_initTelemetry = function _SpfxDoctorCommand_initTelemetry() {
696
734
  this.telemetry.push((args) => {
697
735
  Object.assign(this.telemetryProperties, {
698
- env: args.options.env
736
+ env: args.options.env,
737
+ spfxVersion: args.options.spfxVersion
699
738
  });
700
739
  });
701
740
  }, _SpfxDoctorCommand_initOptions = function _SpfxDoctorCommand_initOptions() {
702
741
  this.options.unshift({
703
742
  option: '-e, --env [env]',
704
743
  autocomplete: ['sp2016', 'sp2019', 'spo']
744
+ }, {
745
+ option: '-v, --spfxVersion [spfxVersion]',
746
+ autocomplete: Object.keys(this.versions)
705
747
  });
706
748
  }, _SpfxDoctorCommand_initValidators = function _SpfxDoctorCommand_initValidators() {
707
749
  this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
@@ -711,13 +753,16 @@ _SpfxDoctorCommand_instances = new WeakSet(), _SpfxDoctorCommand_initTelemetry =
711
753
  return `${args.options.env} is not a valid SharePoint version. Valid versions are sp2016, sp2019 or spo`;
712
754
  }
713
755
  }
756
+ if (args.options.spfxVersion) {
757
+ if (!this.versions[args.options.spfxVersion]) {
758
+ return `${args.options.spfxVersion} is not a supported SharePoint Framework version. Supported versions are ${Object.keys(this.versions).join(', ')}`;
759
+ }
760
+ }
714
761
  if (args.options.output && args.options.output !== 'text') {
715
762
  return `The output option only accepts the type 'text'`;
716
763
  }
717
764
  return true;
718
765
  }));
719
- }, _SpfxDoctorCommand_initTypes = function _SpfxDoctorCommand_initTypes() {
720
- this.types.string.push('e', 'env');
721
766
  };
722
767
  module.exports = new SpfxDoctorCommand();
723
768
  //# sourceMappingURL=spfx-doctor.js.map
@@ -0,0 +1,231 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
12
+ if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
13
+ 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");
14
+ return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
15
+ };
16
+ var _SpoFileRoleAssignmentAddCommand_instances, _SpoFileRoleAssignmentAddCommand_initTelemetry, _SpoFileRoleAssignmentAddCommand_initOptions, _SpoFileRoleAssignmentAddCommand_initValidators, _SpoFileRoleAssignmentAddCommand_initOptionSets;
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ const Cli_1 = require("../../../../cli/Cli");
19
+ const SpoUserGetCommand = require("../user/user-get");
20
+ const SpoGroupGetCommand = require("../group/group-get");
21
+ const SpoRoleDefinitionListCommand = require("../roledefinition/roledefinition-list");
22
+ const SpoFileGetCommand = require("./file-get");
23
+ const request_1 = require("../../../../request");
24
+ const validation_1 = require("../../../../utils/validation");
25
+ const formatting_1 = require("../../../../utils/formatting");
26
+ const SpoCommand_1 = require("../../../base/SpoCommand");
27
+ const commands_1 = require("../../commands");
28
+ class SpoFileRoleAssignmentAddCommand extends SpoCommand_1.default {
29
+ constructor() {
30
+ super();
31
+ _SpoFileRoleAssignmentAddCommand_instances.add(this);
32
+ __classPrivateFieldGet(this, _SpoFileRoleAssignmentAddCommand_instances, "m", _SpoFileRoleAssignmentAddCommand_initTelemetry).call(this);
33
+ __classPrivateFieldGet(this, _SpoFileRoleAssignmentAddCommand_instances, "m", _SpoFileRoleAssignmentAddCommand_initOptions).call(this);
34
+ __classPrivateFieldGet(this, _SpoFileRoleAssignmentAddCommand_instances, "m", _SpoFileRoleAssignmentAddCommand_initValidators).call(this);
35
+ __classPrivateFieldGet(this, _SpoFileRoleAssignmentAddCommand_instances, "m", _SpoFileRoleAssignmentAddCommand_initOptionSets).call(this);
36
+ }
37
+ get name() {
38
+ return commands_1.default.FILE_ROLEASSIGNMENT_ADD;
39
+ }
40
+ get description() {
41
+ return 'Adds a role assignment to the specified file.';
42
+ }
43
+ commandAction(logger, args) {
44
+ return __awaiter(this, void 0, void 0, function* () {
45
+ if (this.verbose) {
46
+ logger.logToStderr(`Adding role assignment to file in site at ${args.options.webUrl}...`);
47
+ }
48
+ try {
49
+ const fileUrl = yield this.getFileURL(args);
50
+ const roleDefinitionId = yield this.getRoleDefinitionId(args.options);
51
+ if (args.options.upn) {
52
+ const upnPrincipalId = yield this.getUserPrincipalId(args.options);
53
+ yield this.addRoleAssignment(fileUrl, args.options.webUrl, upnPrincipalId, roleDefinitionId);
54
+ }
55
+ else if (args.options.groupName) {
56
+ const groupPrincipalId = yield this.getGroupPrincipalId(args.options);
57
+ yield this.addRoleAssignment(fileUrl, args.options.webUrl, groupPrincipalId, roleDefinitionId);
58
+ }
59
+ else {
60
+ yield this.addRoleAssignment(fileUrl, args.options.webUrl, args.options.principalId, roleDefinitionId);
61
+ }
62
+ }
63
+ catch (err) {
64
+ this.handleRejectedODataJsonPromise(err);
65
+ }
66
+ });
67
+ }
68
+ addRoleAssignment(fileUrl, webUrl, principalId, roleDefinitionId) {
69
+ return __awaiter(this, void 0, void 0, function* () {
70
+ try {
71
+ const requestOptions = {
72
+ url: `${webUrl}/_api/web/GetFileByServerRelativeUrl('${formatting_1.formatting.encodeQueryParameter(fileUrl)}')/ListItemAllFields/roleassignments/addroleassignment(principalid='${principalId}',roledefid='${roleDefinitionId}')`,
73
+ method: 'POST',
74
+ headers: {
75
+ 'accept': 'application/json;odata=nometadata',
76
+ 'content-type': 'application/json'
77
+ },
78
+ responseType: 'json'
79
+ };
80
+ yield request_1.default.post(requestOptions);
81
+ }
82
+ catch (err) {
83
+ return Promise.reject(err);
84
+ }
85
+ });
86
+ }
87
+ getRoleDefinitionId(options) {
88
+ return __awaiter(this, void 0, void 0, function* () {
89
+ if (!options.roleDefinitionName) {
90
+ return options.roleDefinitionId;
91
+ }
92
+ try {
93
+ const roleDefinitionListCommandOptions = {
94
+ webUrl: options.webUrl,
95
+ output: 'json',
96
+ debug: this.debug,
97
+ verbose: this.verbose
98
+ };
99
+ const output = yield Cli_1.Cli.executeCommandWithOutput(SpoRoleDefinitionListCommand, { options: Object.assign(Object.assign({}, roleDefinitionListCommandOptions), { _: [] }) });
100
+ const getRoleDefinitionListOutput = JSON.parse(output.stdout);
101
+ const roleDefinitionId = getRoleDefinitionListOutput.find((role) => role.Name === options.roleDefinitionName).Id;
102
+ return roleDefinitionId;
103
+ }
104
+ catch (err) {
105
+ return Promise.reject(err);
106
+ }
107
+ });
108
+ }
109
+ getGroupPrincipalId(options) {
110
+ return __awaiter(this, void 0, void 0, function* () {
111
+ try {
112
+ const groupGetCommandOptions = {
113
+ webUrl: options.webUrl,
114
+ name: options.groupName,
115
+ output: 'json',
116
+ debug: this.debug,
117
+ verbose: this.verbose
118
+ };
119
+ const output = yield Cli_1.Cli.executeCommandWithOutput(SpoGroupGetCommand, { options: Object.assign(Object.assign({}, groupGetCommandOptions), { _: [] }) });
120
+ const getGroupOutput = JSON.parse(output.stdout);
121
+ return getGroupOutput.Id;
122
+ }
123
+ catch (err) {
124
+ return Promise.reject(err);
125
+ }
126
+ });
127
+ }
128
+ getUserPrincipalId(options) {
129
+ return __awaiter(this, void 0, void 0, function* () {
130
+ try {
131
+ const userGetCommandOptions = {
132
+ webUrl: options.webUrl,
133
+ email: options.upn,
134
+ id: undefined,
135
+ output: 'json',
136
+ debug: this.debug,
137
+ verbose: this.verbose
138
+ };
139
+ const output = yield Cli_1.Cli.executeCommandWithOutput(SpoUserGetCommand, { options: Object.assign(Object.assign({}, userGetCommandOptions), { _: [] }) });
140
+ const getUserOutput = JSON.parse(output.stdout);
141
+ return getUserOutput.Id;
142
+ }
143
+ catch (err) {
144
+ return Promise.reject(err);
145
+ }
146
+ });
147
+ }
148
+ getFileURL(args) {
149
+ return __awaiter(this, void 0, void 0, function* () {
150
+ if (args.options.fileUrl) {
151
+ return args.options.fileUrl;
152
+ }
153
+ const options = {
154
+ webUrl: args.options.webUrl,
155
+ id: args.options.fileId,
156
+ output: 'json',
157
+ debug: this.debug,
158
+ verbose: this.verbose
159
+ };
160
+ const output = yield Cli_1.Cli.executeCommandWithOutput(SpoFileGetCommand, { options: Object.assign(Object.assign({}, options), { _: [] }) });
161
+ const getFileOutput = JSON.parse(output.stdout);
162
+ return getFileOutput.ServerRelativeUrl;
163
+ });
164
+ }
165
+ }
166
+ _SpoFileRoleAssignmentAddCommand_instances = new WeakSet(), _SpoFileRoleAssignmentAddCommand_initTelemetry = function _SpoFileRoleAssignmentAddCommand_initTelemetry() {
167
+ this.telemetry.push((args) => {
168
+ Object.assign(this.telemetryProperties, {
169
+ fileUrl: typeof args.options.fileUrl !== 'undefined',
170
+ fileId: typeof args.options.fileId !== 'undefined',
171
+ principalId: typeof args.options.principalId !== 'undefined',
172
+ upn: typeof args.options.upn !== 'undefined',
173
+ groupName: typeof args.options.groupName !== 'undefined',
174
+ roleDefinitionId: typeof args.options.roleDefinitionId !== 'undefined',
175
+ roleDefinitionName: typeof args.options.roleDefinitionName !== 'undefined'
176
+ });
177
+ });
178
+ }, _SpoFileRoleAssignmentAddCommand_initOptions = function _SpoFileRoleAssignmentAddCommand_initOptions() {
179
+ this.options.unshift({
180
+ option: '-u, --webUrl <webUrl>'
181
+ }, {
182
+ option: '--fileUrl [fileUrl]'
183
+ }, {
184
+ option: 'i, --fileId [fileId]'
185
+ }, {
186
+ option: '--principalId [principalId]'
187
+ }, {
188
+ option: '--upn [upn]'
189
+ }, {
190
+ option: '--groupName [groupName]'
191
+ }, {
192
+ option: '--roleDefinitionId [roleDefinitionId]'
193
+ }, {
194
+ option: '--roleDefinitionName [roleDefinitionName]'
195
+ });
196
+ }, _SpoFileRoleAssignmentAddCommand_initValidators = function _SpoFileRoleAssignmentAddCommand_initValidators() {
197
+ this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
198
+ const isValidSharePointUrl = validation_1.validation.isValidSharePointUrl(args.options.webUrl);
199
+ if (isValidSharePointUrl !== true) {
200
+ return isValidSharePointUrl;
201
+ }
202
+ if (args.options.fileId && !validation_1.validation.isValidGuid(args.options.fileId)) {
203
+ return `${args.options.fileId} is not a valid GUID`;
204
+ }
205
+ if (args.options.principalId && isNaN(args.options.principalId)) {
206
+ return `Specified principalId ${args.options.principalId} is not a number`;
207
+ }
208
+ if (args.options.roleDefinitionId && isNaN(args.options.roleDefinitionId)) {
209
+ return `Specified roleDefinitionId ${args.options.roleDefinitionId} is not a number`;
210
+ }
211
+ const principalOptions = [args.options.principalId, args.options.upn, args.options.groupName];
212
+ if (!principalOptions.some(item => item !== undefined)) {
213
+ return `Specify either principalId, upn or groupName`;
214
+ }
215
+ if (principalOptions.filter(item => item !== undefined).length > 1) {
216
+ return `Specify either principalId, upn or groupName but not multiple`;
217
+ }
218
+ const roleDefinitionOptions = [args.options.roleDefinitionId, args.options.roleDefinitionName];
219
+ if (!roleDefinitionOptions.some(item => item !== undefined)) {
220
+ return `Specify either roleDefinitionId or roleDefinitionName`;
221
+ }
222
+ if (roleDefinitionOptions.filter(item => item !== undefined).length > 1) {
223
+ return `Specify either roleDefinitionId or roleDefinitionName but not multiple`;
224
+ }
225
+ return true;
226
+ }));
227
+ }, _SpoFileRoleAssignmentAddCommand_initOptionSets = function _SpoFileRoleAssignmentAddCommand_initOptionSets() {
228
+ this.optionSets.push(['fileId', 'fileUrl']);
229
+ };
230
+ module.exports = new SpoFileRoleAssignmentAddCommand();
231
+ //# sourceMappingURL=file-roleassignment-add.js.map