@pnp/cli-microsoft365 6.2.0-beta.d0cdaa3 → 6.2.0-beta.d5442a1

package/dist/m365/spo/commands/listitem/listitem-record-lock.js

@@ -0,0 +1,129 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SpoListItemRecordLockCommand_instances, _SpoListItemRecordLockCommand_initTelemetry, _SpoListItemRecordLockCommand_initOptions, _SpoListItemRecordLockCommand_initValidators, _SpoListItemRecordLockCommand_initOptionSets;
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const formatting_1 = require("../../../../utils/formatting");
+const urlUtil_1 = require("../../../../utils/urlUtil");
+const validation_1 = require("../../../../utils/validation");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoListItemRecordLockCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.LISTITEM_RECORD_LOCK;
+    }
+    get description() {
+        return 'Locks the list item record';
+    }
+    constructor() {
+        super();
+        _SpoListItemRecordLockCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpoListItemRecordLockCommand_instances, "m", _SpoListItemRecordLockCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpoListItemRecordLockCommand_instances, "m", _SpoListItemRecordLockCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoListItemRecordLockCommand_instances, "m", _SpoListItemRecordLockCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _SpoListItemRecordLockCommand_instances, "m", _SpoListItemRecordLockCommand_initOptionSets).call(this);
+    }
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr(`Locking the list item record ${args.options.listId || args.options.listTitle || args.options.listUrl} in site at ${args.options.webUrl}...`);
+            }
+            try {
+                let listRestUrl = '';
+                let listServerRelativeUrl = '';
+                if (args.options.listUrl) {
+                    const listServerRelativeUrlFromPath = urlUtil_1.urlUtil.getServerRelativePath(args.options.webUrl, args.options.listUrl);
+                    listServerRelativeUrl = listServerRelativeUrlFromPath;
+                }
+                else {
+                    if (args.options.listId) {
+                        listRestUrl = `lists(guid'${formatting_1.formatting.encodeQueryParameter(args.options.listId)}')/`;
+                    }
+                    else {
+                        listRestUrl = `lists/getByTitle('${formatting_1.formatting.encodeQueryParameter(args.options.listTitle)}')/`;
+                    }
+                    const requestOptions = {
+                        url: `${args.options.webUrl}/_api/web/${listRestUrl}?$expand=RootFolder&$select=RootFolder`,
+                        headers: {
+                            'accept': 'application/json;odata=nometadata'
+                        },
+                        responseType: 'json'
+                    };
+                    const listInstance = yield request_1.default.get(requestOptions);
+                    listServerRelativeUrl = listInstance.RootFolder.ServerRelativeUrl;
+                }
+                const listAbsoluteUrl = urlUtil_1.urlUtil.getAbsoluteUrl(args.options.webUrl, listServerRelativeUrl);
+                const requestUrl = `${args.options.webUrl}/_api/SP.CompliancePolicy.SPPolicyStoreProxy.LockRecordItem()`;
+                const requestOptions = {
+                    url: requestUrl,
+                    headers: {
+                        'accept': 'application/json;odata=nometadata'
+                    },
+                    data: {
+                        listUrl: listAbsoluteUrl,
+                        itemId: args.options.listItemId
+                    },
+                    responseType: 'json'
+                };
+                yield request_1.default.post(requestOptions);
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        });
+    }
+}
+_SpoListItemRecordLockCommand_instances = new WeakSet(), _SpoListItemRecordLockCommand_initTelemetry = function _SpoListItemRecordLockCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            listId: typeof args.options.listId !== 'undefined',
+            listTitle: typeof args.options.listTitle !== 'undefined',
+            listUrl: typeof args.options.listUrl !== 'undefined'
+        });
+    });
+}, _SpoListItemRecordLockCommand_initOptions = function _SpoListItemRecordLockCommand_initOptions() {
+    this.options.unshift({
+        option: '-u, --webUrl <webUrl>'
+    }, {
+        option: '--listItemId <listItemId>'
+    }, {
+        option: '--listId [listId]'
+    }, {
+        option: '--listTitle [listTitle]'
+    }, {
+        option: '--listUrl [listUrl]'
+    });
+}, _SpoListItemRecordLockCommand_initValidators = function _SpoListItemRecordLockCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        const id = parseInt(args.options.listItemId);
+        if (isNaN(id)) {
+            return `${args.options.listItemId} is not a valid list item ID`;
+        }
+        const isValidSharePointUrl = validation_1.validation.isValidSharePointUrl(args.options.webUrl);
+        if (isValidSharePointUrl !== true) {
+            return isValidSharePointUrl;
+        }
+        if (args.options.listId &&
+            !validation_1.validation.isValidGuid(args.options.listId)) {
+            return `${args.options.listId} is not a valid GUID`;
+        }
+        return true;
+    }));
+}, _SpoListItemRecordLockCommand_initOptionSets = function _SpoListItemRecordLockCommand_initOptionSets() {
+    this.optionSets.push({ options: ['listId', 'listTitle', 'listUrl'] });
+};
+module.exports = new SpoListItemRecordLockCommand();
+//# sourceMappingURL=listitem-record-lock.js.map

package/dist/m365/spo/commands/listitem/listitem-record-unlock.js

@@ -0,0 +1,129 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SpoListItemRecordUnlockCommand_instances, _SpoListItemRecordUnlockCommand_initTelemetry, _SpoListItemRecordUnlockCommand_initOptions, _SpoListItemRecordUnlockCommand_initValidators, _SpoListItemRecordUnlockCommand_initOptionSets;
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const formatting_1 = require("../../../../utils/formatting");
+const urlUtil_1 = require("../../../../utils/urlUtil");
+const validation_1 = require("../../../../utils/validation");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+class SpoListItemRecordUnlockCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.LISTITEM_RECORD_UNLOCK;
+    }
+    get description() {
+        return 'Unlocks the list item record';
+    }
+    constructor() {
+        super();
+        _SpoListItemRecordUnlockCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpoListItemRecordUnlockCommand_instances, "m", _SpoListItemRecordUnlockCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpoListItemRecordUnlockCommand_instances, "m", _SpoListItemRecordUnlockCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoListItemRecordUnlockCommand_instances, "m", _SpoListItemRecordUnlockCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _SpoListItemRecordUnlockCommand_instances, "m", _SpoListItemRecordUnlockCommand_initOptionSets).call(this);
+    }
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr(`Unlocking the list item record ${args.options.listId || args.options.listTitle || args.options.listUrl} in site at ${args.options.webUrl}...`);
+            }
+            try {
+                let listRestUrl = '';
+                let listServerRelativeUrl = '';
+                if (args.options.listUrl) {
+                    const listServerRelativeUrlFromPath = urlUtil_1.urlUtil.getServerRelativePath(args.options.webUrl, args.options.listUrl);
+                    listServerRelativeUrl = listServerRelativeUrlFromPath;
+                }
+                else {
+                    if (args.options.listId) {
+                        listRestUrl = `lists(guid'${formatting_1.formatting.encodeQueryParameter(args.options.listId)}')/`;
+                    }
+                    else {
+                        listRestUrl = `lists/getByTitle('${formatting_1.formatting.encodeQueryParameter(args.options.listTitle)}')/`;
+                    }
+                    const requestOptions = {
+                        url: `${args.options.webUrl}/_api/web/${listRestUrl}?$expand=RootFolder&$select=RootFolder`,
+                        headers: {
+                            'accept': 'application/json;odata=nometadata'
+                        },
+                        responseType: 'json'
+                    };
+                    const listInstance = yield request_1.default.get(requestOptions);
+                    listServerRelativeUrl = listInstance.RootFolder.ServerRelativeUrl;
+                }
+                const listAbsoluteUrl = urlUtil_1.urlUtil.getAbsoluteUrl(args.options.webUrl, listServerRelativeUrl);
+                const requestUrl = `${args.options.webUrl}/_api/SP.CompliancePolicy.SPPolicyStoreProxy.UnlockRecordItem()`;
+                const requestOptions = {
+                    url: requestUrl,
+                    headers: {
+                        'accept': 'application/json;odata=nometadata'
+                    },
+                    data: {
+                        listUrl: listAbsoluteUrl,
+                        itemId: args.options.listItemId
+                    },
+                    responseType: 'json'
+                };
+                yield request_1.default.post(requestOptions);
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        });
+    }
+}
+_SpoListItemRecordUnlockCommand_instances = new WeakSet(), _SpoListItemRecordUnlockCommand_initTelemetry = function _SpoListItemRecordUnlockCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            listId: typeof args.options.listId !== 'undefined',
+            listTitle: typeof args.options.listTitle !== 'undefined',
+            listUrl: typeof args.options.listUrl !== 'undefined'
+        });
+    });
+}, _SpoListItemRecordUnlockCommand_initOptions = function _SpoListItemRecordUnlockCommand_initOptions() {
+    this.options.unshift({
+        option: '-u, --webUrl <webUrl>'
+    }, {
+        option: '--listItemId <listItemId>'
+    }, {
+        option: '--listId [listId]'
+    }, {
+        option: '--listTitle [listTitle]'
+    }, {
+        option: '--listUrl [listUrl]'
+    });
+}, _SpoListItemRecordUnlockCommand_initValidators = function _SpoListItemRecordUnlockCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        const id = parseInt(args.options.listItemId);
+        if (isNaN(id)) {
+            return `${args.options.listItemId} is not a valid list item ID`;
+        }
+        const isValidSharePointUrl = validation_1.validation.isValidSharePointUrl(args.options.webUrl);
+        if (isValidSharePointUrl !== true) {
+            return isValidSharePointUrl;
+        }
+        if (args.options.listId &&
+            !validation_1.validation.isValidGuid(args.options.listId)) {
+            return `${args.options.listId} is not a valid GUID`;
+        }
+        return true;
+    }));
+}, _SpoListItemRecordUnlockCommand_initOptionSets = function _SpoListItemRecordUnlockCommand_initOptionSets() {
+    this.optionSets.push({ options: ['listId', 'listTitle', 'listUrl'] });
+};
+module.exports = new SpoListItemRecordUnlockCommand();
+//# sourceMappingURL=listitem-record-unlock.js.map

package/dist/m365/spo/commands/listitem/listitem-retentionlabel-ensure.js

@@ -0,0 +1,161 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SpoListItemRetentionLabelEnsureCommand_instances, _SpoListItemRetentionLabelEnsureCommand_initTelemetry, _SpoListItemRetentionLabelEnsureCommand_initOptions, _SpoListItemRetentionLabelEnsureCommand_initValidators, _SpoListItemRetentionLabelEnsureCommand_initOptionSets;
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const formatting_1 = require("../../../../utils/formatting");
+const urlUtil_1 = require("../../../../utils/urlUtil");
+const validation_1 = require("../../../../utils/validation");
+const SpoCommand_1 = require("../../../base/SpoCommand");
+const commands_1 = require("../../commands");
+const SpoWebRetentionLabelListCommand = require("../web/web-retentionlabel-list");
+const Cli_1 = require("../../../../cli/Cli");
+class SpoListItemRetentionLabelEnsureCommand extends SpoCommand_1.default {
+    get name() {
+        return commands_1.default.LISTITEM_RETENTIONLABEL_ENSURE;
+    }
+    get description() {
+        return 'Apply a retention label to a list item';
+    }
+    constructor() {
+        super();
+        _SpoListItemRetentionLabelEnsureCommand_instances.add(this);
+        __classPrivateFieldGet(this, _SpoListItemRetentionLabelEnsureCommand_instances, "m", _SpoListItemRetentionLabelEnsureCommand_initTelemetry).call(this);
+        __classPrivateFieldGet(this, _SpoListItemRetentionLabelEnsureCommand_instances, "m", _SpoListItemRetentionLabelEnsureCommand_initOptions).call(this);
+        __classPrivateFieldGet(this, _SpoListItemRetentionLabelEnsureCommand_instances, "m", _SpoListItemRetentionLabelEnsureCommand_initValidators).call(this);
+        __classPrivateFieldGet(this, _SpoListItemRetentionLabelEnsureCommand_instances, "m", _SpoListItemRetentionLabelEnsureCommand_initOptionSets).call(this);
+    }
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const labelInformation = yield this.getLabelInformation(args.options, logger);
+                yield this.applyLabel(args.options, labelInformation, logger);
+            }
+            catch (err) {
+                this.handleRejectedODataJsonPromise(err);
+            }
+        });
+    }
+    getLabelInformation(options, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cmdOptions = {
+                webUrl: options.webUrl,
+                output: 'json',
+                debug: options.debug,
+                verbose: options.verbose
+            };
+            const output = yield Cli_1.Cli.executeCommandWithOutput(SpoWebRetentionLabelListCommand, { options: Object.assign(Object.assign({}, cmdOptions), { _: [] }) });
+            if (this.verbose) {
+                logger.logToStderr(output.stderr);
+            }
+            const labels = JSON.parse(output.stdout);
+            const label = labels.find(l => l.TagName === options.name || l.TagId === options.id);
+            if (this.verbose && label !== undefined) {
+                logger.logToStderr(`Retention label found in the list of available labels: '${label.TagName}' / '${label.TagId}'...`);
+            }
+            if (label === undefined) {
+                throw new Error(`The specified retention label does not exist`);
+            }
+            return {
+                complianceTag: label.TagName,
+                isTagPolicyHold: label.BlockDelete,
+                isTagPolicyRecord: label.BlockEdit,
+                isEventBasedTag: label.IsEventTag,
+                isTagSuperLock: label.SuperLock,
+                isUnlockedAsDefault: label.UnlockedAsDefault
+            };
+        });
+    }
+    applyLabel(options, labelInformation, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.verbose) {
+                logger.logToStderr(`Applying retention label to item in list '${options.listId || options.listTitle || options.listUrl}' in site at ${options.webUrl}...`);
+            }
+            let requestUrl = `${options.webUrl}/_api/web`;
+            if (options.listId) {
+                requestUrl += `/lists(guid'${formatting_1.formatting.encodeQueryParameter(options.listId)}')/items(${options.listItemId})/SetComplianceTag()`;
+            }
+            else if (options.listTitle) {
+                requestUrl += `/lists/getByTitle('${formatting_1.formatting.encodeQueryParameter(options.listTitle)}')/items(${options.listItemId})/SetComplianceTag()`;
+            }
+            else if (options.listUrl) {
+                const listServerRelativeUrl = urlUtil_1.urlUtil.getServerRelativePath(options.webUrl, options.listUrl);
+                requestUrl += `/GetList(@listUrl)/items(${options.listItemId})/SetComplianceTag()?@listUrl='${formatting_1.formatting.encodeQueryParameter(listServerRelativeUrl)}'`;
+            }
+            const requestOptions = {
+                url: requestUrl,
+                headers: {
+                    'accept': 'application/json;odata=nometadata'
+                },
+                data: labelInformation,
+                responseType: 'json'
+            };
+            yield request_1.default.post(requestOptions);
+        });
+    }
+}
+_SpoListItemRetentionLabelEnsureCommand_instances = new WeakSet(), _SpoListItemRetentionLabelEnsureCommand_initTelemetry = function _SpoListItemRetentionLabelEnsureCommand_initTelemetry() {
+    this.telemetry.push((args) => {
+        Object.assign(this.telemetryProperties, {
+            listId: typeof args.options.listId !== 'undefined',
+            listTitle: typeof args.options.listTitle !== 'undefined',
+            listUrl: typeof args.options.listUrl !== 'undefined',
+            name: typeof args.options.name !== 'undefined',
+            id: typeof args.options.id !== 'undefined'
+        });
+    });
+}, _SpoListItemRetentionLabelEnsureCommand_initOptions = function _SpoListItemRetentionLabelEnsureCommand_initOptions() {
+    this.options.unshift({
+        option: '-u, --webUrl <webUrl>'
+    }, {
+        option: '--listItemId <listItemId>'
+    }, {
+        option: '--listId [listId]'
+    }, {
+        option: '--listTitle [listTitle]'
+    }, {
+        option: '--listUrl [listUrl]'
+    }, {
+        option: '-n, --name [name]'
+    }, {
+        option: '-i, --id [id]'
+    });
+}, _SpoListItemRetentionLabelEnsureCommand_initValidators = function _SpoListItemRetentionLabelEnsureCommand_initValidators() {
+    this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
+        const id = parseInt(args.options.listItemId);
+        if (isNaN(id)) {
+            return `${args.options.listItemId} is not a valid list item ID`;
+        }
+        const isValidSharePointUrl = validation_1.validation.isValidSharePointUrl(args.options.webUrl);
+        if (isValidSharePointUrl !== true) {
+            return isValidSharePointUrl;
+        }
+        if (args.options.listId &&
+            !validation_1.validation.isValidGuid(args.options.listId)) {
+            return `${args.options.listId} is not a valid GUID`;
+        }
+        if (args.options.id &&
+            !validation_1.validation.isValidGuid(args.options.id)) {
+            return `${args.options.id} is not a valid GUID`;
+        }
+        return true;
+    }));
+}, _SpoListItemRetentionLabelEnsureCommand_initOptionSets = function _SpoListItemRetentionLabelEnsureCommand_initOptionSets() {
+    this.optionSets.push({ options: ['listId', 'listTitle', 'listUrl'] });
+    this.optionSets.push({ options: ['name', 'id'] });
+};
+module.exports = new SpoListItemRetentionLabelEnsureCommand();
+//# sourceMappingURL=listitem-retentionlabel-ensure.js.map

package/dist/m365/spo/commands.js

@@ -62,6 +62,7 @@ exports.default = {
     FILE_ROLEINHERITANCE_BREAK: `${prefix} file roleinheritance break`,
     FILE_ROLEINHERITANCE_RESET: `${prefix} file roleinheritance reset`,
     FILE_SHARINGINFO_GET: `${prefix} file sharinginfo get`,
+    FILE_SHARINGLINK_LIST: `${prefix} file sharinglink list`,
     FILE_VERSION_CLEAR: `${prefix} file version clear`,
     FILE_VERSION_GET: `${prefix} file version get`,
     FILE_VERSION_LIST: `${prefix} file version list`,
@@ -143,8 +144,11 @@ exports.default = {
     LISTITEM_ISRECORD: `${prefix} listitem isrecord`,
     LISTITEM_LIST: `${prefix} listitem list`,
     LISTITEM_RECORD_DECLARE: `${prefix} listitem record declare`,
+    LISTITEM_RECORD_LOCK: `${prefix} listitem record lock`,
     LISTITEM_RECORD_UNDECLARE: `${prefix} listitem record undeclare`,
+    LISTITEM_RECORD_UNLOCK: `${prefix} listitem record unlock`,
     LISTITEM_REMOVE: `${prefix} listitem remove`,
+    LISTITEM_RETENTIONLABEL_ENSURE: `${prefix} listitem retentionlabel ensure`,
     LISTITEM_RETENTIONLABEL_REMOVE: `${prefix} listitem retentionlabel remove`,
     LISTITEM_ROLEASSIGNMENT_ADD: `${prefix} listitem roleassignment add`,
     LISTITEM_ROLEASSIGNMENT_REMOVE: `${prefix} listitem roleassignment remove`,

package/dist/m365/teams/commands/chat/chat-list.js

@@ -15,9 +15,12 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _TeamsChatListCommand_instances, _TeamsChatListCommand_initTelemetry, _TeamsChatListCommand_initOptions, _TeamsChatListCommand_initValidators;
 Object.defineProperty(exports, "__esModule", { value: true });
+const Auth_1 = require("../../../../Auth");
+const accessToken_1 = require("../../../../utils/accessToken");
 const odata_1 = require("../../../../utils/odata");
 const GraphCommand_1 = require("../../../base/GraphCommand");
 const commands_1 = require("../../commands");
+const validation_1 = require("../../../../utils/validation");
 class TeamsChatListCommand extends GraphCommand_1.default {
     get name() {
         return commands_1.default.CHAT_LIST;
@@ -31,16 +34,26 @@ class TeamsChatListCommand extends GraphCommand_1.default {
     constructor() {
         super();
         _TeamsChatListCommand_instances.add(this);
+        this.supportedTypes = ['oneOnOne', 'group', 'meeting'];
         __classPrivateFieldGet(this, _TeamsChatListCommand_instances, "m", _TeamsChatListCommand_initTelemetry).call(this);
         __classPrivateFieldGet(this, _TeamsChatListCommand_instances, "m", _TeamsChatListCommand_initOptions).call(this);
         __classPrivateFieldGet(this, _TeamsChatListCommand_instances, "m", _TeamsChatListCommand_initValidators).call(this);
     }
     commandAction(logger, args) {
         return __awaiter(this, void 0, void 0, function* () {
-            const filter = args.options.type !== undefined ? `?$filter=chatType eq '${args.options.type}'` : '';
-            const endpoint = `${this.resource}/v1.0/chats${filter}`;
+            const isAppOnlyAuth = accessToken_1.accessToken.isAppOnlyAccessToken(Auth_1.default.service.accessTokens[this.resource].accessToken);
+            if (isAppOnlyAuth && !args.options.userId && !args.options.userName) {
+                throw `The option 'userId' or 'userName' is required when obtaining chats using app only permissions`;
+            }
+            else if (!isAppOnlyAuth && (args.options.userId || args.options.userName)) {
+                throw `The options 'userId' or 'userName' cannot be used when obtaining chats using delegated permissions`;
+            }
+            let requestUrl = `${this.resource}/v1.0/${!isAppOnlyAuth ? 'me' : `users/${args.options.userId || args.options.userName}`}/chats`;
+            if (args.options.type) {
+                requestUrl += `?$filter=chatType eq '${args.options.type}'`;
+            }
             try {
-                const items = yield odata_1.odata.getAllItems(endpoint);
+                const items = yield odata_1.odata.getAllItems(requestUrl);
                 logger.log(items);
             }
             catch (err) {
@@ -58,13 +71,22 @@ _TeamsChatListCommand_instances = new WeakSet(), _TeamsChatListCommand_initTelem
 }, _TeamsChatListCommand_initOptions = function _TeamsChatListCommand_initOptions() {
     this.options.unshift({
         option: '-t, --type [type]',
-        autocomplete: ['oneOnOne', 'group', 'meeting']
+        autocomplete: this.supportedTypes
+    }, {
+        option: '--userId [userId]'
+    }, {
+        option: '--userName [userName]'
     });
 }, _TeamsChatListCommand_initValidators = function _TeamsChatListCommand_initValidators() {
     this.validators.push((args) => __awaiter(this, void 0, void 0, function* () {
-        const supportedTypes = ['oneOnOne', 'group', 'meeting'];
-        if (args.options.type !== undefined && supportedTypes.indexOf(args.options.type) === -1) {
-            return `${args.options.type} is not a valid chatType. Accepted values are ${supportedTypes.join(', ')}`;
+        if (args.options.type !== undefined && this.supportedTypes.indexOf(args.options.type) === -1) {
+            return `${args.options.type} is not a valid chatType. Accepted values are ${this.supportedTypes.join(', ')}`;
+        }
+        if (args.options.userId && args.options.userName) {
+            return `You can only specify either 'userId' or 'userName'`;
+        }
+        if (args.options.userId && !validation_1.validation.isValidGuid(args.options.userId)) {
+            return `${args.options.userId} is not a valid GUID`;
         }
         return true;
     }));

package/dist/request.js

@@ -150,10 +150,10 @@ class Request {
             })
                 .then((res) => {
                 if (resolve) {
-                    resolve(options.responseType === 'stream' ? res : res.data);
+                    resolve((options.responseType === 'stream' || options.fullResponse) ? res : res.data);
                 }
                 else {
-                    _resolve(options.responseType === 'stream' ? res : res.data);
+                    _resolve((options.responseType === 'stream' || options.fullResponse) ? res : res.data);
                 }
             }, (error) => {
                 if (error && error.response &&

package/docs/docs/cmd/planner/bucket/bucket-add.md

@@ -72,3 +72,20 @@ m365 planner bucket add --name "My Planner Bucket" --planTitle "My Planner Plan"
     id,name,planId,orderHint
     ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
     ```
+
+=== "Markdown"
+
+    ```md
+    # planner bucket add  --name "My Planner Bucket" --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
+
+    Date: 27/12/2022
+
+    ## My Planner Bucket (ttEB_Uj690STdR3GC1MIDZgANq1U)
+
+    Property | Value
+    ---------|-------
+    name | My Planner Bucket
+    planId | xqQg5FS2LkCp935s-FIFm2QAFkHM
+    orderHint | 8585363889524958496
+    id | ttEB_Uj690STdR3GC1MIDZgANq1U
+    ```

package/docs/docs/cmd/planner/bucket/bucket-get.md

@@ -84,3 +84,20 @@ m365 planner bucket get --name "Planner Bucket A" --planTitle "My Plan" --ownerG
     id,name,planId,orderHint
     ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
     ```
+
+=== "Markdown"
+
+    ```md
+    # planner bucket get --id "ttEB_Uj690STdR3GC1MIDZgANq1U"
+
+    Date: 27/12/2022
+
+    ## My Planner Bucket (ttEB_Uj690STdR3GC1MIDZgANq1U)
+
+    Property | Value
+    ---------|-------
+    name | My Planner Bucket
+    planId | xqQg5FS2LkCp935s-FIFm2QAFkHM
+    orderHint | 8585363889524958496
+    id | ttEB_Uj690STdR3GC1MIDZgANq1U
+    ```

package/docs/docs/cmd/planner/bucket/bucket-list.md

@@ -67,3 +67,20 @@ m365 planner bucket list --planTitle "My Plan" --ownerGroupName "My Group"
     id,name,planId,orderHint
     ttEB_Uj690STdR3GC1MIDZgANq1U,My Planner Bucket,xqQg5FS2LkCp935s-FIFm2QAFkHM,8585363889524958496
     ```
+
+=== "Markdown"
+
+    ```md
+    # planner bucket list --planId "xqQg5FS2LkCp935s-FIFm2QAFkHM"
+
+    Date: 27/12/2022
+
+    ## My Planner Bucket (ttEB_Uj690STdR3GC1MIDZgANq1U)
+
+    Property | Value
+    ---------|-------
+    name | My Planner Bucket
+    planId | xqQg5FS2LkCp935s-FIFm2QAFkHM
+    orderHint | 8585363889524958496
+    id | ttEB_Uj690STdR3GC1MIDZgANq1U
+    ```

package/docs/docs/cmd/planner/plan/plan-add.md

@@ -97,6 +97,25 @@ m365 planner plan add --title 'My Planner Plan' --ownerGroupName 'My Planner Gro
     xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
     ```
 
+=== "Markdown"
+
+    ```md
+    # planner plan add --title "My Planner Plan" --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874"
+
+    Date: 30/03/2015
+
+    ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
+
+    Property | Value
+    ---------|-------
+    createdDateTime | 2015-03-30T18:36:49.2407981Z
+    owner | ebf3b108-5234-4e22-b93d-656d7dae5874
+    title | My Planner Plan
+    id | xqQg5FS2LkCp935s-FIFm2QAFkHM
+    createdBy | {"user":{"displayName":null,"id":"95e27074-6c4a-447a-aa24-9d718a0b86fa"},"application":{"displayName":null,"id":"ebf3b108-5234-4e22-b93d-656d7dae5874"}}
+    container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
+    ```
+
 ### `shareWithUserIds`, `shareWithUserNames` response
 
 When we make use of the option `shareWithUserIds` or `shareWithUserNames` the response will differ. 
@@ -173,3 +192,24 @@ When we make use of the option `shareWithUserIds` or `shareWithUserNames` the re
     id,title,createdDateTime,owner
     xqQg5FS2LkCp935s-FIFm2QAFkHM,My Planner Plan,2015-03-30T18:36:49.2407981Z,ebf3b108-5234-4e22-b93d-656d7dae5874
     ```
+
+=== "Markdown"
+
+    ```md
+    # planner plan add --title "My Planner Plan" --ownerGroupId "ebf3b108-5234-4e22-b93d-656d7dae5874" --shareWithUserNames "Allan.Carroll@contoso.com,Ida.Stevens@contoso.com"
+
+    Date: 30/03/2015
+
+    ## My Planner Plan (xqQg5FS2LkCp935s-FIFm2QAFkHM)
+
+    Property | Value
+    ---------|-------
+    createdDateTime | 2015-03-30T18:36:49.2407981Z
+    owner | ebf3b108-5234-4e22-b93d-656d7dae5874
+    title | My Planner Plan
+    id | xqQg5FS2LkCp935s-FIFm2QAFkHM
+    createdBy | {"user":{"displayName":null,"id":"dd8b99a7-77c6-4238-a609-396d27844921"},"application":{"displayName":null,"id":"31359c7f-bd7e-475c-86db-fdb8c937548e"}}
+    container | {"containerId":"ebf3b108-5234-4e22-b93d-656d7dae5874","type":"group","url":"https://graph.microsoft.com/v1.0/groups/ebf3b108-5234-4e22-b93d-656d7dae5874"}
+    sharedWith | {"ebf3b108-5234-4e22-b93d-656d7dae5874":true,"6463a5ce-2119-4198-9f2a-628761df4a62":true}
+    categoryDescriptions | {"category1":null,"category2":null,"category3":null,"category4":null,"category5":null,"category6":null,"category7":null,"category8":null,"category9":null,"category10":null,"category11":null,"category12":null,"category13":null,"category14":null,"category15":null,"category16":null,"category17":null,"category18":null,"category19":null,"category20":null,"category21":null,"category22":null,"category23":null,"category24":null,"category25":null}
+    ```