@pnp/cli-microsoft365 6.1.0 → 6.2.0-beta.02615ee

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 (63) hide show
  1. package/.eslintrc.js +6 -0
  2. package/dist/m365/aad/commands/approleassignment/approleassignment-add.js +3 -0
  3. package/dist/m365/onenote/commands/page/page-list.js +137 -0
  4. package/dist/m365/onenote/commands.js +2 -1
  5. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-get.js +110 -0
  6. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-list.js +68 -0
  7. package/dist/m365/pp/commands/aibuildermodel/aibuildermodel-remove.js +130 -0
  8. package/dist/m365/pp/commands.js +3 -0
  9. package/dist/m365/purview/commands/retentionlabel/retentionlabel-add.js +143 -0
  10. package/dist/m365/purview/commands/retentionlabel/retentionlabel-get.js +70 -0
  11. package/dist/m365/purview/commands.js +2 -0
  12. package/dist/m365/spo/commands/file/GraphFileDetails.js +3 -0
  13. package/dist/m365/spo/commands/file/file-sharinginfo-get.js +12 -12
  14. package/dist/m365/spo/commands/file/file-sharinglink-get.js +116 -0
  15. package/dist/m365/spo/commands/file/file-sharinglink-list.js +133 -0
  16. package/dist/m365/spo/commands/file/file-sharinglink-remove.js +135 -0
  17. package/dist/m365/spo/commands/group/group-member-add.js +33 -6
  18. package/dist/m365/spo/commands/group/group-member-remove.js +78 -33
  19. package/dist/m365/spo/commands/list/list-retentionlabel-ensure.js +10 -2
  20. package/dist/m365/spo/commands/listitem/ListItemRetentionLabel.js +3 -0
  21. package/dist/m365/spo/commands/listitem/SiteRetentionLabel.js +3 -0
  22. package/dist/m365/spo/commands/listitem/listitem-list.js +1 -1
  23. package/dist/m365/spo/commands/listitem/listitem-record-lock.js +129 -0
  24. package/dist/m365/spo/commands/listitem/listitem-record-unlock.js +129 -0
  25. package/dist/m365/spo/commands/listitem/listitem-retentionlabel-ensure.js +161 -0
  26. package/dist/m365/spo/commands/term/term-list.js +99 -29
  27. package/dist/m365/spo/commands.js +6 -0
  28. package/dist/m365/teams/commands/chat/chat-list.js +29 -7
  29. package/dist/request.js +2 -2
  30. package/docs/docs/cmd/onenote/page/page-list.md +140 -0
  31. package/docs/docs/cmd/planner/bucket/bucket-add.md +17 -0
  32. package/docs/docs/cmd/planner/bucket/bucket-get.md +17 -0
  33. package/docs/docs/cmd/planner/bucket/bucket-list.md +17 -0
  34. package/docs/docs/cmd/planner/plan/plan-add.md +40 -0
  35. package/docs/docs/cmd/planner/plan/plan-get.md +21 -0
  36. package/docs/docs/cmd/planner/plan/plan-list.md +19 -0
  37. package/docs/docs/cmd/planner/plan/plan-set.md +20 -0
  38. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-get.md +99 -0
  39. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-list.md +95 -0
  40. package/docs/docs/cmd/pp/aibuildermodel/aibuildermodel-remove.md +53 -0
  41. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-add.md +128 -0
  42. package/docs/docs/cmd/purview/retentionlabel/retentionlabel-get.md +95 -0
  43. package/docs/docs/cmd/spo/cdn/cdn-get.md +1 -1
  44. package/docs/docs/cmd/spo/cdn/cdn-origin-add.md +1 -1
  45. package/docs/docs/cmd/spo/cdn/cdn-origin-list.md +1 -1
  46. package/docs/docs/cmd/spo/cdn/cdn-origin-remove.md +1 -1
  47. package/docs/docs/cmd/spo/cdn/cdn-policy-list.md +1 -1
  48. package/docs/docs/cmd/spo/cdn/cdn-policy-set.md +1 -1
  49. package/docs/docs/cmd/spo/cdn/cdn-set.md +1 -1
  50. package/docs/docs/cmd/spo/file/file-sharinglink-get.md +107 -0
  51. package/docs/docs/cmd/spo/file/file-sharinglink-list.md +106 -0
  52. package/docs/docs/cmd/spo/file/file-sharinglink-remove.md +52 -0
  53. package/docs/docs/cmd/spo/group/group-member-add.md +22 -4
  54. package/docs/docs/cmd/spo/group/group-member-remove.md +24 -6
  55. package/docs/docs/cmd/spo/list/list-retentionlabel-ensure.md +8 -5
  56. package/docs/docs/cmd/spo/listitem/listitem-list.md +5 -5
  57. package/docs/docs/cmd/spo/listitem/listitem-record-lock.md +52 -0
  58. package/docs/docs/cmd/spo/listitem/listitem-record-unlock.md +52 -0
  59. package/docs/docs/cmd/spo/listitem/listitem-retentionlabel-ensure.md +58 -0
  60. package/docs/docs/cmd/spo/term/term-list.md +138 -0
  61. package/docs/docs/cmd/teams/chat/chat-list.md +16 -4
  62. package/npm-shrinkwrap.json +184 -204
  63. package/package.json +13 -12
@@ -22,6 +22,7 @@ const validation_1 = require("../../../../utils/validation");
22
22
  const AadUserGetCommand = require("../../../aad/commands/user/user-get");
23
23
  const SpoCommand_1 = require("../../../base/SpoCommand");
24
24
  const commands_1 = require("../../commands");
25
+ const SpoGroupMemberListCommand = require("./group-member-list");
25
26
  class SpoGroupMemberRemoveCommand extends SpoCommand_1.default {
26
27
  get name() {
27
28
  return commands_1.default.GROUP_MEMBER_REMOVE;
@@ -58,54 +59,89 @@ class SpoGroupMemberRemoveCommand extends SpoCommand_1.default {
58
59
  }
59
60
  commandAction(logger, args) {
60
61
  return __awaiter(this, void 0, void 0, function* () {
61
- const removeUserfromSPGroup = () => __awaiter(this, void 0, void 0, function* () {
62
- if (this.verbose) {
63
- logger.logToStderr(`Removing User ${args.options.userName || args.options.email || args.options.userId} from Group: ${args.options.groupId ? args.options.groupId : args.options.groupName}`);
64
- }
65
- let requestUrl = `${args.options.webUrl}/_api/web/sitegroups/${args.options.groupId
66
- ? `GetById('${args.options.groupId}')`
67
- : `GetByName('${formatting_1.formatting.encodeQueryParameter(args.options.groupName)}')`}`;
68
- if (args.options.userId) {
69
- requestUrl += `/users/removeById(${args.options.userId})`;
70
- }
71
- else {
72
- const userName = yield this.getUserName(logger, args);
73
- const loginName = `i:0#.f|membership|${userName}`;
74
- requestUrl += `/users/removeByLoginName(@LoginName)?@LoginName='${formatting_1.formatting.encodeQueryParameter(loginName)}'`;
75
- }
76
- const requestOptions = {
77
- url: requestUrl,
78
- headers: {
79
- 'accept': 'application/json;odata=nometadata'
80
- },
81
- responseType: 'json'
82
- };
83
- try {
84
- yield request_1.default.post(requestOptions);
85
- }
86
- catch (err) {
87
- this.handleRejectedODataJsonPromise(err);
88
- }
89
- });
90
62
  if (args.options.confirm) {
91
63
  if (this.debug) {
92
64
  logger.logToStderr('Confirmation bypassed by entering confirm option. Removing the user from SharePoint Group...');
93
65
  }
94
- yield removeUserfromSPGroup();
66
+ yield this.removeUserfromSPGroup(logger, args);
95
67
  }
96
68
  else {
97
69
  const result = yield Cli_1.Cli.prompt({
98
70
  type: 'confirm',
99
71
  name: 'continue',
100
72
  default: false,
101
- message: `Are you sure you want to remove user ${args.options.userName || args.options.userId || args.options.email} from the SharePoint group?`
73
+ message: `Are you sure you want to remove user ${args.options.userName || args.options.userId || args.options.email || args.options.aadGroupId || args.options.aadGroupName} from the SharePoint group?`
102
74
  });
103
75
  if (result.continue) {
104
- yield removeUserfromSPGroup();
76
+ yield this.removeUserfromSPGroup(logger, args);
105
77
  }
106
78
  }
107
79
  });
108
80
  }
81
+ removeUserfromSPGroup(logger, args) {
82
+ return __awaiter(this, void 0, void 0, function* () {
83
+ if (this.verbose) {
84
+ logger.logToStderr(`Removing User ${args.options.userName || args.options.email || args.options.userId || args.options.aadGroupId || args.options.aadGroupName} from Group: ${args.options.groupId || args.options.groupName}`);
85
+ }
86
+ let requestUrl = `${args.options.webUrl}/_api/web/sitegroups/${args.options.groupId
87
+ ? `GetById('${args.options.groupId}')`
88
+ : `GetByName('${formatting_1.formatting.encodeQueryParameter(args.options.groupName)}')`}`;
89
+ if (args.options.userId) {
90
+ requestUrl += `/users/removeById(${args.options.userId})`;
91
+ }
92
+ else if (args.options.userName || args.options.email) {
93
+ const userName = yield this.getUserName(logger, args);
94
+ const loginName = `i:0#.f|membership|${userName}`;
95
+ requestUrl += `/users/removeByLoginName(@LoginName)?@LoginName='${formatting_1.formatting.encodeQueryParameter(loginName)}'`;
96
+ }
97
+ else {
98
+ const aadGroupId = yield this.getGroupId(args);
99
+ requestUrl += `/users/RemoveById(${aadGroupId})`;
100
+ }
101
+ const requestOptions = {
102
+ url: requestUrl,
103
+ headers: {
104
+ 'accept': 'application/json;odata=nometadata'
105
+ },
106
+ responseType: 'json'
107
+ };
108
+ try {
109
+ yield request_1.default.post(requestOptions);
110
+ }
111
+ catch (err) {
112
+ this.handleRejectedODataJsonPromise(err);
113
+ }
114
+ });
115
+ }
116
+ getGroupId(args) {
117
+ return __awaiter(this, void 0, void 0, function* () {
118
+ const options = {
119
+ webUrl: args.options.webUrl,
120
+ output: 'json',
121
+ debug: this.debug,
122
+ verbose: this.verbose
123
+ };
124
+ if (args.options.groupId) {
125
+ options.groupId = args.options.groupId;
126
+ }
127
+ else {
128
+ options.groupName = args.options.groupName;
129
+ }
130
+ const output = yield Cli_1.Cli.executeCommandWithOutput(SpoGroupMemberListCommand, { options: Object.assign(Object.assign({}, options), { _: [] }) });
131
+ const getGroupMemberListOutput = JSON.parse(output.stdout);
132
+ let foundgroups;
133
+ if (args.options.aadGroupId) {
134
+ foundgroups = getGroupMemberListOutput.filter((x) => { return x.LoginName.indexOf(args.options.aadGroupId) > -1 && (x.LoginName.indexOf("c:0o.c|federateddirectoryclaimprovider|") === 0 || x.LoginName.indexOf("c:0t.c|tenant|") === 0); });
135
+ }
136
+ else {
137
+ foundgroups = getGroupMemberListOutput.filter((x) => { return x.Title === args.options.aadGroupName && (x.LoginName.indexOf("c:0o.c|federateddirectoryclaimprovider|") === 0 || x.LoginName.indexOf("c:0t.c|tenant|") === 0); });
138
+ }
139
+ if (foundgroups.length === 0) {
140
+ throw `The Azure AD group ${args.options.aadGroupId || args.options.aadGroupName} is not found in SharePoint group ${args.options.groupId || args.options.groupName}`;
141
+ }
142
+ return foundgroups[0].Id;
143
+ });
144
+ }
109
145
  }
110
146
  _SpoGroupMemberRemoveCommand_instances = new WeakSet(), _SpoGroupMemberRemoveCommand_initTelemetry = function _SpoGroupMemberRemoveCommand_initTelemetry() {
111
147
  this.telemetry.push((args) => {
@@ -115,6 +151,8 @@ _SpoGroupMemberRemoveCommand_instances = new WeakSet(), _SpoGroupMemberRemoveCom
115
151
  userName: (!(!args.options.userName)).toString(),
116
152
  email: (!(!args.options.email)).toString(),
117
153
  userId: (!(!args.options.userId)).toString(),
154
+ aadGroupId: (!(!args.options.groupId)).toString(),
155
+ aadGroupName: (!(!args.options.groupName)).toString(),
118
156
  confirm: (!(!args.options.confirm)).toString()
119
157
  });
120
158
  });
@@ -131,6 +169,10 @@ _SpoGroupMemberRemoveCommand_instances = new WeakSet(), _SpoGroupMemberRemoveCom
131
169
  option: '--email [email]'
132
170
  }, {
133
171
  option: '--userId [userId]'
172
+ }, {
173
+ option: '--aadGroupId [aadGroupId]'
174
+ }, {
175
+ option: '--aadGroupName [aadGroupName]'
134
176
  }, {
135
177
  option: '--confirm'
136
178
  });
@@ -148,10 +190,13 @@ _SpoGroupMemberRemoveCommand_instances = new WeakSet(), _SpoGroupMemberRemoveCom
148
190
  if (args.options.email && !validation_1.validation.isValidUserPrincipalName(args.options.email)) {
149
191
  return `${args.options.email} is not a valid email`;
150
192
  }
193
+ if (args.options.aadGroupId && !validation_1.validation.isValidGuid(args.options.aadGroupId)) {
194
+ return `${args.options.aadGroupId} is not a valid GUID`;
195
+ }
151
196
  return validation_1.validation.isValidSharePointUrl(args.options.webUrl);
152
197
  }));
153
198
  }, _SpoGroupMemberRemoveCommand_initOptionSets = function _SpoGroupMemberRemoveCommand_initOptionSets() {
154
- this.optionSets.push({ options: ['groupName', 'groupId'] }, { options: ['userName', 'email', 'userId'] });
199
+ this.optionSets.push({ options: ['groupName', 'groupId'] }, { options: ['userName', 'email', 'userId', 'aadGroupId', 'aadGroupName'] });
155
200
  };
156
201
  module.exports = new SpoGroupMemberRemoveCommand();
157
202
  //# sourceMappingURL=group-member-remove.js.map
@@ -42,6 +42,10 @@ class SpoListRetentionLabelEnsureCommand extends SpoCommand_1.default {
42
42
  commandAction(logger, args) {
43
43
  return __awaiter(this, void 0, void 0, function* () {
44
44
  this.showDeprecationWarning(logger, commands_1.default.LIST_LABEL_SET, commands_1.default.LIST_RETENTIONLABEL_ENSURE);
45
+ if (args.options.label) {
46
+ args.options.name = args.options.label;
47
+ this.warn(logger, `Option 'label' is deprecated. Please use 'name' instead`);
48
+ }
45
49
  if (args.options.blockDelete) {
46
50
  this.warn(logger, `Option 'blockDelete' is deprecated.`);
47
51
  }
@@ -81,7 +85,7 @@ class SpoListRetentionLabelEnsureCommand extends SpoCommand_1.default {
81
85
  },
82
86
  data: {
83
87
  listUrl: listAbsoluteUrl,
84
- complianceTagValue: args.options.label,
88
+ complianceTagValue: args.options.name,
85
89
  blockDelete: args.options.blockDelete || false,
86
90
  blockEdit: args.options.blockEdit || false,
87
91
  syncToItems: args.options.syncToItems || false
@@ -99,6 +103,8 @@ class SpoListRetentionLabelEnsureCommand extends SpoCommand_1.default {
99
103
  _SpoListRetentionLabelEnsureCommand_instances = new WeakSet(), _SpoListRetentionLabelEnsureCommand_initTelemetry = function _SpoListRetentionLabelEnsureCommand_initTelemetry() {
100
104
  this.telemetry.push((args) => {
101
105
  Object.assign(this.telemetryProperties, {
106
+ name: (!(!args.options.name)).toString(),
107
+ label: (!(!args.options.label)).toString(),
102
108
  listId: (!(!args.options.listId)).toString(),
103
109
  listTitle: (!(!args.options.listTitle)).toString(),
104
110
  listUrl: (!(!args.options.listUrl)).toString(),
@@ -111,7 +117,9 @@ _SpoListRetentionLabelEnsureCommand_instances = new WeakSet(), _SpoListRetention
111
117
  this.options.unshift({
112
118
  option: '-u, --webUrl <webUrl>'
113
119
  }, {
114
- option: '--label <label>'
120
+ option: '--name [name]'
121
+ }, {
122
+ option: '--label [label]'
115
123
  }, {
116
124
  option: '-t, --listTitle [listTitle]'
117
125
  }, {
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=ListItemRetentionLabel.js.map
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=SiteRetentionLabel.js.map
@@ -177,7 +177,7 @@ _SpoListItemListCommand_instances = new WeakSet(), _SpoListItemListCommand_initT
177
177
  return true;
178
178
  }));
179
179
  }, _SpoListItemListCommand_initOptionSets = function _SpoListItemListCommand_initOptionSets() {
180
- this.optionSets.push({ options: ['listId', 'listTitle'] });
180
+ this.optionSets.push({ options: ['listId', 'listTitle', 'listUrl'] });
181
181
  }, _SpoListItemListCommand_initTypes = function _SpoListItemListCommand_initTypes() {
182
182
  this.types.string.push('webUrl', 'camlQuery', 'pageSize', 'pageNumber', 'fields', 'filter');
183
183
  };
@@ -0,0 +1,129 @@
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 _SpoListItemRecordLockCommand_instances, _SpoListItemRecordLockCommand_initTelemetry, _SpoListItemRecordLockCommand_initOptions, _SpoListItemRecordLockCommand_initValidators, _SpoListItemRecordLockCommand_initOptionSets;
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ const request_1 = require("../../../../request");
19
+ const formatting_1 = require("../../../../utils/formatting");
20
+ const urlUtil_1 = require("../../../../utils/urlUtil");
21
+ const validation_1 = require("../../../../utils/validation");
22
+ const SpoCommand_1 = require("../../../base/SpoCommand");
23
+ const commands_1 = require("../../commands");
24
+ class SpoListItemRecordLockCommand extends SpoCommand_1.default {
25
+ get name() {
26
+ return commands_1.default.LISTITEM_RECORD_LOCK;
27
+ }
28
+ get description() {
29
+ return 'Locks the list item record';
30
+ }
31
+ constructor() {
32
+ super();
33
+ _SpoListItemRecordLockCommand_instances.add(this);
34
+ __classPrivateFieldGet(this, _SpoListItemRecordLockCommand_instances, "m", _SpoListItemRecordLockCommand_initTelemetry).call(this);
35
+ __classPrivateFieldGet(this, _SpoListItemRecordLockCommand_instances, "m", _SpoListItemRecordLockCommand_initOptions).call(this);
36
+ __classPrivateFieldGet(this, _SpoListItemRecordLockCommand_instances, "m", _SpoListItemRecordLockCommand_initValidators).call(this);
37
+ __classPrivateFieldGet(this, _SpoListItemRecordLockCommand_instances, "m", _SpoListItemRecordLockCommand_initOptionSets).call(this);
38
+ }
39
+ commandAction(logger, args) {
40
+ return __awaiter(this, void 0, void 0, function* () {
41
+ if (this.verbose) {
42
+ logger.logToStderr(`Locking the list item record ${args.options.listId || args.options.listTitle || args.options.listUrl} in site at ${args.options.webUrl}...`);
43
+ }
44
+ try {
45
+ let listRestUrl = '';
46
+ let listServerRelativeUrl = '';
47
+ if (args.options.listUrl) {
48
+ const listServerRelativeUrlFromPath = urlUtil_1.urlUtil.getServerRelativePath(args.options.webUrl, args.options.listUrl);
49
+ listServerRelativeUrl = listServerRelativeUrlFromPath;
50
+ }
51
+ else {
52
+ if (args.options.listId) {
53
+ listRestUrl = `lists(guid'${formatting_1.formatting.encodeQueryParameter(args.options.listId)}')/`;
54
+ }
55
+ else {
56
+ listRestUrl = `lists/getByTitle('${formatting_1.formatting.encodeQueryParameter(args.options.listTitle)}')/`;
57
+ }
58
+ const requestOptions = {
59
+ url: `${args.options.webUrl}/_api/web/${listRestUrl}?$expand=RootFolder&$select=RootFolder`,
60
+ headers: {
61
+ 'accept': 'application/json;odata=nometadata'
62
+ },
63
+ responseType: 'json'
64
+ };
65
+ const listInstance = yield request_1.default.get(requestOptions);
66
+ listServerRelativeUrl = listInstance.RootFolder.ServerRelativeUrl;
67
+ }
68
+ const listAbsoluteUrl = urlUtil_1.urlUtil.getAbsoluteUrl(args.options.webUrl, listServerRelativeUrl);
69
+ const requestUrl = `${args.options.webUrl}/_api/SP.CompliancePolicy.SPPolicyStoreProxy.LockRecordItem()`;
70
+ const requestOptions = {
71
+ url: requestUrl,
72
+ headers: {
73
+ 'accept': 'application/json;odata=nometadata'
74
+ },
75
+ data: {
76
+ listUrl: listAbsoluteUrl,
77
+ itemId: args.options.listItemId
78
+ },
79
+ responseType: 'json'
80
+ };
81
+ yield request_1.default.post(requestOptions);
82
+ }
83
+ catch (err) {
84
+ this.handleRejectedODataJsonPromise(err);
85
+ }
86
+ });
87
+ }
88
+ }
89
+ _SpoListItemRecordLockCommand_instances = new WeakSet(), _SpoListItemRecordLockCommand_initTelemetry = function _SpoListItemRecordLockCommand_initTelemetry() {
90
+ this.telemetry.push((args) => {
91
+ Object.assign(this.telemetryProperties, {
92
+ listId: typeof args.options.listId !== 'undefined',
93
+ listTitle: typeof args.options.listTitle !== 'undefined',
94
+ listUrl: typeof args.options.listUrl !== 'undefined'
95
+ });
96
+ });
97
+ }, _SpoListItemRecordLockCommand_initOptions = function _SpoListItemRecordLockCommand_initOptions() {
98
+ this.options.unshift({
99
+ option: '-u, --webUrl <webUrl>'
100
+ }, {
101
+ option: '--listItemId <listItemId>'
102
+ }, {
103
+ option: '--listId [listId]'
104
+ }, {
105
+ option: '--listTitle [listTitle]'
106
+ }, {
107
+ option: '--listUrl [listUrl]'
108
+ });
109
+ }, _SpoListItemRecordLockCommand_initValidators = function _SpoListItemRecordLockCommand_initValidators() {
110
+ this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
111
+ const id = parseInt(args.options.listItemId);
112
+ if (isNaN(id)) {
113
+ return `${args.options.listItemId} is not a valid list item ID`;
114
+ }
115
+ const isValidSharePointUrl = validation_1.validation.isValidSharePointUrl(args.options.webUrl);
116
+ if (isValidSharePointUrl !== true) {
117
+ return isValidSharePointUrl;
118
+ }
119
+ if (args.options.listId &&
120
+ !validation_1.validation.isValidGuid(args.options.listId)) {
121
+ return `${args.options.listId} is not a valid GUID`;
122
+ }
123
+ return true;
124
+ }));
125
+ }, _SpoListItemRecordLockCommand_initOptionSets = function _SpoListItemRecordLockCommand_initOptionSets() {
126
+ this.optionSets.push({ options: ['listId', 'listTitle', 'listUrl'] });
127
+ };
128
+ module.exports = new SpoListItemRecordLockCommand();
129
+ //# sourceMappingURL=listitem-record-lock.js.map
@@ -0,0 +1,129 @@
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 _SpoListItemRecordUnlockCommand_instances, _SpoListItemRecordUnlockCommand_initTelemetry, _SpoListItemRecordUnlockCommand_initOptions, _SpoListItemRecordUnlockCommand_initValidators, _SpoListItemRecordUnlockCommand_initOptionSets;
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ const request_1 = require("../../../../request");
19
+ const formatting_1 = require("../../../../utils/formatting");
20
+ const urlUtil_1 = require("../../../../utils/urlUtil");
21
+ const validation_1 = require("../../../../utils/validation");
22
+ const SpoCommand_1 = require("../../../base/SpoCommand");
23
+ const commands_1 = require("../../commands");
24
+ class SpoListItemRecordUnlockCommand extends SpoCommand_1.default {
25
+ get name() {
26
+ return commands_1.default.LISTITEM_RECORD_UNLOCK;
27
+ }
28
+ get description() {
29
+ return 'Unlocks the list item record';
30
+ }
31
+ constructor() {
32
+ super();
33
+ _SpoListItemRecordUnlockCommand_instances.add(this);
34
+ __classPrivateFieldGet(this, _SpoListItemRecordUnlockCommand_instances, "m", _SpoListItemRecordUnlockCommand_initTelemetry).call(this);
35
+ __classPrivateFieldGet(this, _SpoListItemRecordUnlockCommand_instances, "m", _SpoListItemRecordUnlockCommand_initOptions).call(this);
36
+ __classPrivateFieldGet(this, _SpoListItemRecordUnlockCommand_instances, "m", _SpoListItemRecordUnlockCommand_initValidators).call(this);
37
+ __classPrivateFieldGet(this, _SpoListItemRecordUnlockCommand_instances, "m", _SpoListItemRecordUnlockCommand_initOptionSets).call(this);
38
+ }
39
+ commandAction(logger, args) {
40
+ return __awaiter(this, void 0, void 0, function* () {
41
+ if (this.verbose) {
42
+ logger.logToStderr(`Unlocking the list item record ${args.options.listId || args.options.listTitle || args.options.listUrl} in site at ${args.options.webUrl}...`);
43
+ }
44
+ try {
45
+ let listRestUrl = '';
46
+ let listServerRelativeUrl = '';
47
+ if (args.options.listUrl) {
48
+ const listServerRelativeUrlFromPath = urlUtil_1.urlUtil.getServerRelativePath(args.options.webUrl, args.options.listUrl);
49
+ listServerRelativeUrl = listServerRelativeUrlFromPath;
50
+ }
51
+ else {
52
+ if (args.options.listId) {
53
+ listRestUrl = `lists(guid'${formatting_1.formatting.encodeQueryParameter(args.options.listId)}')/`;
54
+ }
55
+ else {
56
+ listRestUrl = `lists/getByTitle('${formatting_1.formatting.encodeQueryParameter(args.options.listTitle)}')/`;
57
+ }
58
+ const requestOptions = {
59
+ url: `${args.options.webUrl}/_api/web/${listRestUrl}?$expand=RootFolder&$select=RootFolder`,
60
+ headers: {
61
+ 'accept': 'application/json;odata=nometadata'
62
+ },
63
+ responseType: 'json'
64
+ };
65
+ const listInstance = yield request_1.default.get(requestOptions);
66
+ listServerRelativeUrl = listInstance.RootFolder.ServerRelativeUrl;
67
+ }
68
+ const listAbsoluteUrl = urlUtil_1.urlUtil.getAbsoluteUrl(args.options.webUrl, listServerRelativeUrl);
69
+ const requestUrl = `${args.options.webUrl}/_api/SP.CompliancePolicy.SPPolicyStoreProxy.UnlockRecordItem()`;
70
+ const requestOptions = {
71
+ url: requestUrl,
72
+ headers: {
73
+ 'accept': 'application/json;odata=nometadata'
74
+ },
75
+ data: {
76
+ listUrl: listAbsoluteUrl,
77
+ itemId: args.options.listItemId
78
+ },
79
+ responseType: 'json'
80
+ };
81
+ yield request_1.default.post(requestOptions);
82
+ }
83
+ catch (err) {
84
+ this.handleRejectedODataJsonPromise(err);
85
+ }
86
+ });
87
+ }
88
+ }
89
+ _SpoListItemRecordUnlockCommand_instances = new WeakSet(), _SpoListItemRecordUnlockCommand_initTelemetry = function _SpoListItemRecordUnlockCommand_initTelemetry() {
90
+ this.telemetry.push((args) => {
91
+ Object.assign(this.telemetryProperties, {
92
+ listId: typeof args.options.listId !== 'undefined',
93
+ listTitle: typeof args.options.listTitle !== 'undefined',
94
+ listUrl: typeof args.options.listUrl !== 'undefined'
95
+ });
96
+ });
97
+ }, _SpoListItemRecordUnlockCommand_initOptions = function _SpoListItemRecordUnlockCommand_initOptions() {
98
+ this.options.unshift({
99
+ option: '-u, --webUrl <webUrl>'
100
+ }, {
101
+ option: '--listItemId <listItemId>'
102
+ }, {
103
+ option: '--listId [listId]'
104
+ }, {
105
+ option: '--listTitle [listTitle]'
106
+ }, {
107
+ option: '--listUrl [listUrl]'
108
+ });
109
+ }, _SpoListItemRecordUnlockCommand_initValidators = function _SpoListItemRecordUnlockCommand_initValidators() {
110
+ this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
111
+ const id = parseInt(args.options.listItemId);
112
+ if (isNaN(id)) {
113
+ return `${args.options.listItemId} is not a valid list item ID`;
114
+ }
115
+ const isValidSharePointUrl = validation_1.validation.isValidSharePointUrl(args.options.webUrl);
116
+ if (isValidSharePointUrl !== true) {
117
+ return isValidSharePointUrl;
118
+ }
119
+ if (args.options.listId &&
120
+ !validation_1.validation.isValidGuid(args.options.listId)) {
121
+ return `${args.options.listId} is not a valid GUID`;
122
+ }
123
+ return true;
124
+ }));
125
+ }, _SpoListItemRecordUnlockCommand_initOptionSets = function _SpoListItemRecordUnlockCommand_initOptionSets() {
126
+ this.optionSets.push({ options: ['listId', 'listTitle', 'listUrl'] });
127
+ };
128
+ module.exports = new SpoListItemRecordUnlockCommand();
129
+ //# sourceMappingURL=listitem-record-unlock.js.map
@@ -0,0 +1,161 @@
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 _SpoListItemRetentionLabelEnsureCommand_instances, _SpoListItemRetentionLabelEnsureCommand_initTelemetry, _SpoListItemRetentionLabelEnsureCommand_initOptions, _SpoListItemRetentionLabelEnsureCommand_initValidators, _SpoListItemRetentionLabelEnsureCommand_initOptionSets;
17
+ Object.defineProperty(exports, "__esModule", { value: true });
18
+ const request_1 = require("../../../../request");
19
+ const formatting_1 = require("../../../../utils/formatting");
20
+ const urlUtil_1 = require("../../../../utils/urlUtil");
21
+ const validation_1 = require("../../../../utils/validation");
22
+ const SpoCommand_1 = require("../../../base/SpoCommand");
23
+ const commands_1 = require("../../commands");
24
+ const SpoWebRetentionLabelListCommand = require("../web/web-retentionlabel-list");
25
+ const Cli_1 = require("../../../../cli/Cli");
26
+ class SpoListItemRetentionLabelEnsureCommand extends SpoCommand_1.default {
27
+ get name() {
28
+ return commands_1.default.LISTITEM_RETENTIONLABEL_ENSURE;
29
+ }
30
+ get description() {
31
+ return 'Apply a retention label to a list item';
32
+ }
33
+ constructor() {
34
+ super();
35
+ _SpoListItemRetentionLabelEnsureCommand_instances.add(this);
36
+ __classPrivateFieldGet(this, _SpoListItemRetentionLabelEnsureCommand_instances, "m", _SpoListItemRetentionLabelEnsureCommand_initTelemetry).call(this);
37
+ __classPrivateFieldGet(this, _SpoListItemRetentionLabelEnsureCommand_instances, "m", _SpoListItemRetentionLabelEnsureCommand_initOptions).call(this);
38
+ __classPrivateFieldGet(this, _SpoListItemRetentionLabelEnsureCommand_instances, "m", _SpoListItemRetentionLabelEnsureCommand_initValidators).call(this);
39
+ __classPrivateFieldGet(this, _SpoListItemRetentionLabelEnsureCommand_instances, "m", _SpoListItemRetentionLabelEnsureCommand_initOptionSets).call(this);
40
+ }
41
+ commandAction(logger, args) {
42
+ return __awaiter(this, void 0, void 0, function* () {
43
+ try {
44
+ const labelInformation = yield this.getLabelInformation(args.options, logger);
45
+ yield this.applyLabel(args.options, labelInformation, logger);
46
+ }
47
+ catch (err) {
48
+ this.handleRejectedODataJsonPromise(err);
49
+ }
50
+ });
51
+ }
52
+ getLabelInformation(options, logger) {
53
+ return __awaiter(this, void 0, void 0, function* () {
54
+ const cmdOptions = {
55
+ webUrl: options.webUrl,
56
+ output: 'json',
57
+ debug: options.debug,
58
+ verbose: options.verbose
59
+ };
60
+ const output = yield Cli_1.Cli.executeCommandWithOutput(SpoWebRetentionLabelListCommand, { options: Object.assign(Object.assign({}, cmdOptions), { _: [] }) });
61
+ if (this.verbose) {
62
+ logger.logToStderr(output.stderr);
63
+ }
64
+ const labels = JSON.parse(output.stdout);
65
+ const label = labels.find(l => l.TagName === options.name || l.TagId === options.id);
66
+ if (this.verbose && label !== undefined) {
67
+ logger.logToStderr(`Retention label found in the list of available labels: '${label.TagName}' / '${label.TagId}'...`);
68
+ }
69
+ if (label === undefined) {
70
+ throw new Error(`The specified retention label does not exist`);
71
+ }
72
+ return {
73
+ complianceTag: label.TagName,
74
+ isTagPolicyHold: label.BlockDelete,
75
+ isTagPolicyRecord: label.BlockEdit,
76
+ isEventBasedTag: label.IsEventTag,
77
+ isTagSuperLock: label.SuperLock,
78
+ isUnlockedAsDefault: label.UnlockedAsDefault
79
+ };
80
+ });
81
+ }
82
+ applyLabel(options, labelInformation, logger) {
83
+ return __awaiter(this, void 0, void 0, function* () {
84
+ if (this.verbose) {
85
+ logger.logToStderr(`Applying retention label to item in list '${options.listId || options.listTitle || options.listUrl}' in site at ${options.webUrl}...`);
86
+ }
87
+ let requestUrl = `${options.webUrl}/_api/web`;
88
+ if (options.listId) {
89
+ requestUrl += `/lists(guid'${formatting_1.formatting.encodeQueryParameter(options.listId)}')/items(${options.listItemId})/SetComplianceTag()`;
90
+ }
91
+ else if (options.listTitle) {
92
+ requestUrl += `/lists/getByTitle('${formatting_1.formatting.encodeQueryParameter(options.listTitle)}')/items(${options.listItemId})/SetComplianceTag()`;
93
+ }
94
+ else if (options.listUrl) {
95
+ const listServerRelativeUrl = urlUtil_1.urlUtil.getServerRelativePath(options.webUrl, options.listUrl);
96
+ requestUrl += `/GetList(@listUrl)/items(${options.listItemId})/SetComplianceTag()?@listUrl='${formatting_1.formatting.encodeQueryParameter(listServerRelativeUrl)}'`;
97
+ }
98
+ const requestOptions = {
99
+ url: requestUrl,
100
+ headers: {
101
+ 'accept': 'application/json;odata=nometadata'
102
+ },
103
+ data: labelInformation,
104
+ responseType: 'json'
105
+ };
106
+ yield request_1.default.post(requestOptions);
107
+ });
108
+ }
109
+ }
110
+ _SpoListItemRetentionLabelEnsureCommand_instances = new WeakSet(), _SpoListItemRetentionLabelEnsureCommand_initTelemetry = function _SpoListItemRetentionLabelEnsureCommand_initTelemetry() {
111
+ this.telemetry.push((args) => {
112
+ Object.assign(this.telemetryProperties, {
113
+ listId: typeof args.options.listId !== 'undefined',
114
+ listTitle: typeof args.options.listTitle !== 'undefined',
115
+ listUrl: typeof args.options.listUrl !== 'undefined',
116
+ name: typeof args.options.name !== 'undefined',
117
+ id: typeof args.options.id !== 'undefined'
118
+ });
119
+ });
120
+ }, _SpoListItemRetentionLabelEnsureCommand_initOptions = function _SpoListItemRetentionLabelEnsureCommand_initOptions() {
121
+ this.options.unshift({
122
+ option: '-u, --webUrl <webUrl>'
123
+ }, {
124
+ option: '--listItemId <listItemId>'
125
+ }, {
126
+ option: '--listId [listId]'
127
+ }, {
128
+ option: '--listTitle [listTitle]'
129
+ }, {
130
+ option: '--listUrl [listUrl]'
131
+ }, {
132
+ option: '-n, --name [name]'
133
+ }, {
134
+ option: '-i, --id [id]'
135
+ });
136
+ }, _SpoListItemRetentionLabelEnsureCommand_initValidators = function _SpoListItemRetentionLabelEnsureCommand_initValidators() {
137
+ this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
138
+ const id = parseInt(args.options.listItemId);
139
+ if (isNaN(id)) {
140
+ return `${args.options.listItemId} is not a valid list item ID`;
141
+ }
142
+ const isValidSharePointUrl = validation_1.validation.isValidSharePointUrl(args.options.webUrl);
143
+ if (isValidSharePointUrl !== true) {
144
+ return isValidSharePointUrl;
145
+ }
146
+ if (args.options.listId &&
147
+ !validation_1.validation.isValidGuid(args.options.listId)) {
148
+ return `${args.options.listId} is not a valid GUID`;
149
+ }
150
+ if (args.options.id &&
151
+ !validation_1.validation.isValidGuid(args.options.id)) {
152
+ return `${args.options.id} is not a valid GUID`;
153
+ }
154
+ return true;
155
+ }));
156
+ }, _SpoListItemRetentionLabelEnsureCommand_initOptionSets = function _SpoListItemRetentionLabelEnsureCommand_initOptionSets() {
157
+ this.optionSets.push({ options: ['listId', 'listTitle', 'listUrl'] });
158
+ this.optionSets.push({ options: ['name', 'id'] });
159
+ };
160
+ module.exports = new SpoListItemRetentionLabelEnsureCommand();
161
+ //# sourceMappingURL=listitem-retentionlabel-ensure.js.map