@pnp/cli-microsoft365 5.0.0-beta.60ed6bc → 5.0.0-beta.6d4dbfb

package/dist/m365/planner/commands/task/task-set.js

@@ -0,0 +1,357 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const Utils_1 = require("../../../../Utils");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+class PlannerTaskSetCommand extends GraphCommand_1.default {
+    constructor() {
+        super(...arguments);
+        this.allowedAppliedCategories = ['category1', 'category2', 'category3', 'category4', 'category5', 'category6'];
+    }
+    get name() {
+        return commands_1.default.TASK_SET;
+    }
+    get description() {
+        return 'Updates a Microsoft Planner Task';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.title = typeof args.options.title !== 'undefined';
+        telemetryProps.planId = typeof args.options.planId !== 'undefined';
+        telemetryProps.planName = typeof args.options.planName !== 'undefined';
+        telemetryProps.ownerGroupId = typeof args.options.ownerGroupId !== 'undefined';
+        telemetryProps.ownerGroupName = typeof args.options.ownerGroupName !== 'undefined';
+        telemetryProps.bucketId = typeof args.options.bucketId !== 'undefined';
+        telemetryProps.bucketName = typeof args.options.bucketName !== 'undefined';
+        telemetryProps.startDateTime = typeof args.options.startDateTime !== 'undefined';
+        telemetryProps.dueDateTime = typeof args.options.dueDateTime !== 'undefined';
+        telemetryProps.percentComplete = typeof args.options.percentComplete !== 'undefined';
+        telemetryProps.assignedToUserIds = typeof args.options.assignedToUserIds !== 'undefined';
+        telemetryProps.assignedToUserNames = typeof args.options.assignedToUserNames !== 'undefined';
+        telemetryProps.assigneePriority = typeof args.options.assigneePriority !== 'undefined';
+        telemetryProps.description = typeof args.options.description !== 'undefined';
+        telemetryProps.appliedCategories = typeof args.options.appliedCategories !== 'undefined';
+        telemetryProps.orderHint = typeof args.options.orderHint !== 'undefined';
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        this
+            .getBucketId(args.options)
+            .then(bucketId => {
+            this.bucketId = bucketId;
+            return this.generateUserAssignments(args.options);
+        })
+            .then(resultAssignments => {
+            this.assignments = resultAssignments;
+            return this.getTaskEtag(args.options.id);
+        })
+            .then(etag => {
+            const appliedCategories = this.generateAppliedCategories(args.options);
+            const data = this.mapRequestBody(args.options, appliedCategories);
+            const requestOptions = {
+                url: `${this.resource}/v1.0/planner/tasks/${args.options.id}`,
+                headers: {
+                    'accept': 'application/json;odata.metadata=none',
+                    'If-Match': etag,
+                    'Prefer': 'return=representation'
+                },
+                responseType: 'json',
+                data: data
+            };
+            return request_1.default.patch(requestOptions);
+        })
+            .then(newTask => this.updateTaskDetails(args.options, newTask))
+            .then((res) => {
+            logger.log(res);
+            cb();
+        }, (err) => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    updateTaskDetails(options, newTask) {
+        if (!options.description) {
+            return Promise.resolve(newTask);
+        }
+        const taskId = newTask.id;
+        return this
+            .getTaskDetailsEtag(taskId)
+            .then(etag => {
+            const requestOptionsTaskDetails = {
+                url: `${this.resource}/v1.0/planner/tasks/${taskId}/details`,
+                headers: {
+                    'accept': 'application/json;odata.metadata=none',
+                    'If-Match': etag,
+                    'Prefer': 'return=representation'
+                },
+                responseType: 'json',
+                data: {
+                    description: options.description
+                }
+            };
+            return request_1.default.patch(requestOptionsTaskDetails);
+        })
+            .then(taskDetails => {
+            return Object.assign(Object.assign({}, newTask), taskDetails);
+        });
+    }
+    getTaskDetailsEtag(taskId) {
+        const requestOptions = {
+            url: `${this.resource}/v1.0/planner/tasks/${encodeURIComponent(taskId)}/details`,
+            headers: {
+                accept: 'application/json'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then((response) => {
+            const etag = response ? response['@odata.etag'] : undefined;
+            if (!etag) {
+                return Promise.reject(`Error fetching task details`);
+            }
+            return Promise.resolve(etag);
+        });
+    }
+    getTaskEtag(taskId) {
+        const requestOptions = {
+            url: `${this.resource}/v1.0/planner/tasks/${encodeURIComponent(taskId)}`,
+            headers: {
+                accept: 'application/json'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then((response) => {
+            const etag = response ? response['@odata.etag'] : undefined;
+            if (!etag) {
+                return Promise.reject(`Error fetching task`);
+            }
+            return Promise.resolve(etag);
+        });
+    }
+    generateAppliedCategories(options) {
+        if (!options.appliedCategories) {
+            return {};
+        }
+        const categories = {};
+        options.appliedCategories.toLocaleLowerCase().split(',').forEach(x => categories[x] = true);
+        return categories;
+    }
+    generateUserAssignments(options) {
+        const assignments = {};
+        if (!options.assignedToUserIds && !options.assignedToUserNames) {
+            return Promise.resolve(assignments);
+        }
+        return this
+            .getUserIds(options)
+            .then((userIds) => {
+            userIds.forEach(x => assignments[x] = {
+                '@odata.type': '#microsoft.graph.plannerAssignment',
+                orderHint: ' !'
+            });
+            return Promise.resolve(assignments);
+        });
+    }
+    getUserIds(options) {
+        if (options.assignedToUserIds) {
+            return Promise.resolve(options.assignedToUserIds.split(',').map(o => o.trim()));
+        }
+        // Hitting this section means assignedToUserNames won't be undefined
+        const userNames = options.assignedToUserNames;
+        const userArr = userNames.split(',').map(o => o.trim());
+        let userIds = [];
+        const promises = userArr.map(user => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/users?$filter=userPrincipalName eq '${Utils_1.default.encodeQueryParameter(user)}'&$select=id,userPrincipalName`,
+                headers: {
+                    'accept ': 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.get(requestOptions);
+        });
+        return Promise
+            .all(promises)
+            .then((usersRes) => {
+            let userUpns = [];
+            userUpns = usersRes.map(res => { var _a; return (_a = res.value[0]) === null || _a === void 0 ? void 0 : _a.userPrincipalName; });
+            userIds = usersRes.map(res => { var _a; return (_a = res.value[0]) === null || _a === void 0 ? void 0 : _a.id; });
+            // Find the members where no graph response was found
+            const invalidUsers = userArr.filter(user => !userUpns.some((upn) => (upn === null || upn === void 0 ? void 0 : upn.toLowerCase()) === user.toLowerCase()));
+            if (invalidUsers && invalidUsers.length > 0) {
+                return Promise.reject(`Cannot proceed with planner task update. The following users provided are invalid : ${invalidUsers.join(',')}`);
+            }
+            return Promise.resolve(userIds);
+        });
+    }
+    getBucketId(options) {
+        if (options.bucketId) {
+            return Promise.resolve(options.bucketId);
+        }
+        if (!options.bucketName) {
+            return Promise.resolve(undefined);
+        }
+        return this
+            .getPlanId(options)
+            .then(planId => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/planner/plans/${planId}/buckets?$select=id,name`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.get(requestOptions);
+        })
+            .then((response) => {
+            const bucket = response.value.find(val => val.name === options.bucketName);
+            if (!bucket) {
+                return Promise.reject(`The specified bucket does not exist`);
+            }
+            return Promise.resolve(bucket.id);
+        });
+    }
+    getPlanId(options) {
+        if (options.planId) {
+            return Promise.resolve(options.planId);
+        }
+        return this
+            .getGroupId(options)
+            .then((groupId) => {
+            const requestOptions = {
+                url: `${this.resource}/v1.0/planner/plans?$filter=(owner eq '${groupId}')&$select=id,title`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                responseType: 'json'
+            };
+            return request_1.default.get(requestOptions);
+        })
+            .then((response) => {
+            const plan = response.value.find(val => val.title === options.planName);
+            if (!plan) {
+                return Promise.reject(`The specified plan does not exist`);
+            }
+            return Promise.resolve(plan.id);
+        });
+    }
+    getGroupId(options) {
+        if (options.ownerGroupId) {
+            return Promise.resolve(options.ownerGroupId);
+        }
+        const requestOptions = {
+            url: `${this.resource}/v1.0/groups?$filter=displayName eq '${encodeURIComponent(options.ownerGroupName)}'&$select=id`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        return request_1.default
+            .get(requestOptions)
+            .then(response => {
+            const group = response.value[0];
+            if (!group) {
+                return Promise.reject(`The specified owner group does not exist`);
+            }
+            return Promise.resolve(group.id);
+        });
+    }
+    mapRequestBody(options, appliedCategories) {
+        const requestBody = {};
+        if (options.title) {
+            requestBody.title = options.title;
+        }
+        if (this.bucketId) {
+            requestBody.bucketId = this.bucketId;
+        }
+        if (options.startDateTime) {
+            requestBody.startDateTime = options.startDateTime;
+        }
+        if (options.dueDateTime) {
+            requestBody.dueDateTime = options.dueDateTime;
+        }
+        if (options.percentComplete) {
+            requestBody.percentComplete = options.percentComplete;
+        }
+        if (this.assignments && Object.keys(this.assignments).length > 0) {
+            requestBody.assignments = this.assignments;
+        }
+        if (options.assigneePriority) {
+            requestBody.assigneePriority = options.assigneePriority;
+        }
+        if (appliedCategories && Object.keys(appliedCategories).length > 0) {
+            requestBody.appliedCategories = appliedCategories;
+        }
+        if (options.orderHint) {
+            requestBody.orderHint = options.orderHint;
+        }
+        return requestBody;
+    }
+    options() {
+        const options = [
+            { option: '-i, --id <id>' },
+            { option: '-t, --title [title]' },
+            { option: '--planId [planId]' },
+            { option: '--planName [planName]' },
+            { option: '--ownerGroupId [ownerGroupId]' },
+            { option: '--ownerGroupName [ownerGroupName]' },
+            { option: '--bucketId [bucketId]' },
+            { option: '--bucketName [bucketName]' },
+            { option: '--startDateTime [startDateTime]' },
+            { option: '--dueDateTime [dueDateTime]' },
+            { option: '--percentComplete [percentComplete]' },
+            { option: '--assignedToUserIds [assignedToUserIds]' },
+            { option: '--assignedToUserNames [assignedToUserNames]' },
+            { option: '--assigneePriority [assigneePriority]' },
+            { option: '--description [description]' },
+            { option: '--appliedCategories [appliedCategories]' },
+            { option: '--orderHint [orderHint]' }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        if (args.options.bucketId && args.options.bucketName) {
+            return 'Specify either bucketId or bucketName but not both';
+        }
+        if (args.options.bucketName && !args.options.planId && !args.options.planName) {
+            return 'Specify either planId or planName when using bucketName';
+        }
+        if (args.options.bucketName && args.options.planId && args.options.planName) {
+            return 'Specify either planId or planName when using bucketName but not both';
+        }
+        if (args.options.planName && !args.options.ownerGroupId && !args.options.ownerGroupName) {
+            return 'Specify either ownerGroupId or ownerGroupName when using planName';
+        }
+        if (args.options.planName && args.options.ownerGroupId && args.options.ownerGroupName) {
+            return 'Specify either ownerGroupId or ownerGroupName when using planName but not both';
+        }
+        if (args.options.ownerGroupId && !Utils_1.default.isValidGuid(args.options.ownerGroupId)) {
+            return `${args.options.ownerGroupId} is not a valid GUID`;
+        }
+        if (args.options.startDateTime && !Utils_1.default.isValidISODateTime(args.options.startDateTime)) {
+            return 'The startDateTime is not a valid ISO date string';
+        }
+        if (args.options.dueDateTime && !Utils_1.default.isValidISODateTime(args.options.dueDateTime)) {
+            return 'The dueDateTime is not a valid ISO date string';
+        }
+        if (args.options.percentComplete && isNaN(args.options.percentComplete)) {
+            return `percentComplete is not a number`;
+        }
+        if (args.options.percentComplete && (args.options.percentComplete < 0 || args.options.percentComplete > 100)) {
+            return `percentComplete should be between 0 and 100`;
+        }
+        if (args.options.assignedToUserIds && !Utils_1.default.isValidGuidArray(args.options.assignedToUserIds.split(','))) {
+            return 'assignedToUserIds contains invalid GUID';
+        }
+        if (args.options.assignedToUserIds && args.options.assignedToUserNames) {
+            return 'Specify either assignedToUserIds or assignedToUserNames but not both';
+        }
+        if (args.options.appliedCategories && args.options.appliedCategories.split(',').filter(category => this.allowedAppliedCategories.indexOf(category.toLocaleLowerCase()) < 0).length !== 0) {
+            return 'The appliedCategories contains invalid value. Specify either category1, category2, category3, category4, category5 and/or category6 as properties';
+        }
+        return true;
+    }
+}
+module.exports = new PlannerTaskSetCommand();
+//# sourceMappingURL=task-set.js.map

package/dist/m365/planner/commands.js

@@ -7,6 +7,10 @@ exports.default = {
     PLAN_ADD: `${prefix} plan add`,
     PLAN_GET: `${prefix} plan get`,
     PLAN_LIST: `${prefix} plan list`,
-    TASK_LIST: `${prefix} task list`
+    TASK_ADD: `${prefix} task add`,
+    TASK_DETAILS_GET: `${prefix} task details get`,
+    TASK_GET: `${prefix} task get`,
+    TASK_LIST: `${prefix} task list`,
+    TASK_SET: `${prefix} task set`
 };
 //# sourceMappingURL=commands.js.map

package/dist/m365/search/commands/externalconnection/externalconnection-add.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const request_1 = require("../../../../request");
+const GraphCommand_1 = require("../../../base/GraphCommand");
+const commands_1 = require("../../commands");
+class SearchExternalConnectionAddCommand extends GraphCommand_1.default {
+    get name() {
+        return commands_1.default.EXTERNALCONNECTION_ADD;
+    }
+    get description() {
+        return 'Adds a new External Connection for Microsoft Search';
+    }
+    getTelemetryProperties(args) {
+        const telemetryProps = super.getTelemetryProperties(args);
+        telemetryProps.authorizedAppIds = typeof args.options.authorizedAppIds !== undefined;
+        return telemetryProps;
+    }
+    commandAction(logger, args, cb) {
+        let appIds = [];
+        if (args.options.authorizedAppIds !== undefined &&
+            args.options.authorizedAppIds !== '') {
+            appIds = args.options.authorizedAppIds.split(',');
+        }
+        const commandData = {
+            id: args.options.id,
+            name: args.options.name,
+            description: args.options.description,
+            configuration: {
+                authorizedAppIds: appIds
+            }
+        };
+        const requestOptions = {
+            url: `${this.resource}/v1.0/external/connections`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json',
+            data: commandData
+        };
+        request_1.default
+            .post(requestOptions)
+            .then(_ => cb(), err => this.handleRejectedODataJsonPromise(err, logger, cb));
+    }
+    options() {
+        const options = [
+            {
+                option: '-i, --id <id>'
+            },
+            {
+                option: '-n, --name <name>'
+            },
+            {
+                option: '-d, --description <description>'
+            },
+            {
+                option: '--authorizedAppIds [authorizedAppIds]'
+            }
+        ];
+        const parentOptions = super.options();
+        return options.concat(parentOptions);
+    }
+    validate(args) {
+        const id = args.options.id;
+        if (id.length < 3 || id.length > 32) {
+            return 'ID must be between 3 and 32 characters in length.';
+        }
+        const alphaNumericRegEx = /[^\w]|_/g;
+        if (alphaNumericRegEx.test(id)) {
+            return 'ID must only contain alphanumeric characters.';
+        }
+        if (id.length > 9 &&
+            id.startsWith('Microsoft')) {
+            return 'ID cannot begin with Microsoft';
+        }
+        const invalidIds = ['None',
+            'Directory',
+            'Exchange',
+            'ExchangeArchive',
+            'LinkedIn',
+            'Mailbox',
+            'OneDriveBusiness',
+            'SharePoint',
+            'Teams',
+            'Yammer',
+            'Connectors',
+            'TaskFabric',
+            'PowerBI',
+            'Assistant',
+            'TopicEngine',
+            'MSFT_All_Connectors'
+        ];
+        if (invalidIds.indexOf(id) > -1) {
+            return `ID cannot be one of the following values: ${invalidIds.join(', ')}.`;
+        }
+        return true;
+    }
+}
+module.exports = new SearchExternalConnectionAddCommand();
+//# sourceMappingURL=externalconnection-add.js.map

package/dist/m365/search/commands.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const prefix = 'search';
+exports.default = {
+    EXTERNALCONNECTION_ADD: `${prefix} externalconnection add`
+};
+//# sourceMappingURL=commands.js.map

package/dist/m365/spfx/commands/project/project-upgrade/rules/FN006005_CFG_PS_metadata.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FN006005_CFG_PS_metadata = void 0;
+const JsonRule_1 = require("./JsonRule");
+class FN006005_CFG_PS_metadata extends JsonRule_1.JsonRule {
+    constructor() {
+        super();
+    }
+    get id() {
+        return 'FN006005';
+    }
+    get title() {
+        return 'package-solution.json metadata';
+    }
+    get description() {
+        return `In package-solution.json add metadata section`;
+    }
+    get resolution() {
+        return '';
+    }
+    get resolutionType() {
+        return 'json';
+    }
+    get severity() {
+        return 'Required';
+    }
+    get file() {
+        return './config/package-solution.json';
+    }
+    visit(project, findings) {
+        var _a;
+        if (!project.packageSolutionJson ||
+            !project.packageSolutionJson.solution) {
+            return;
+        }
+        if (!project.packageSolutionJson.solution.metadata) {
+            const solutionDescription = `${(_a = project.packageJson) === null || _a === void 0 ? void 0 : _a.name} description`;
+            const resolution = {
+                solution: {
+                    metadata: {
+                        shortDescription: {
+                            default: solutionDescription
+                        },
+                        longDescription: {
+                            default: solutionDescription
+                        },
+                        screenshotPaths: [],
+                        videoUrl: '',
+                        categories: []
+                    }
+                }
+            };
+            const node = this.getAstNodeFromFile(project.packageSolutionJson, 'solution');
+            this.addFindingWithOccurrences([{
+                    file: this.file,
+                    resolution: JSON.stringify(resolution, null, 2),
+                    position: this.getPositionFromNode(node)
+                }], findings);
+        }
+    }
+}
+exports.FN006005_CFG_PS_metadata = FN006005_CFG_PS_metadata;
+//# sourceMappingURL=FN006005_CFG_PS_metadata.js.map

package/dist/m365/spfx/commands/project/project-upgrade/rules/FN006006_CFG_PS_features.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FN006006_CFG_PS_features = void 0;
+const JsonRule_1 = require("./JsonRule");
+const uuid_1 = require("uuid");
+class FN006006_CFG_PS_features extends JsonRule_1.JsonRule {
+    constructor() {
+        super();
+    }
+    get id() {
+        return 'FN006006';
+    }
+    get title() {
+        return 'package-solution.json features';
+    }
+    get description() {
+        return `In package-solution.json add features section`;
+    }
+    get resolution() {
+        return '';
+    }
+    get resolutionType() {
+        return 'json';
+    }
+    get severity() {
+        return 'Required';
+    }
+    get file() {
+        return './config/package-solution.json';
+    }
+    visit(project, findings) {
+        var _a, _b;
+        if (!project.packageSolutionJson ||
+            !project.packageSolutionJson.solution) {
+            return;
+        }
+        if (!project.packageSolutionJson.solution.features) {
+            const resolution = {
+                solution: {
+                    features: [
+                        {
+                            title: `${(_a = project.packageJson) === null || _a === void 0 ? void 0 : _a.name} Feature`,
+                            description: `The feature that activates elements of the ${(_b = project.packageJson) === null || _b === void 0 ? void 0 : _b.name} solution.`,
+                            id: (0, uuid_1.v4)(),
+                            version: project.packageSolutionJson.solution.version
+                        }
+                    ]
+                }
+            };
+            const node = this.getAstNodeFromFile(project.packageSolutionJson, 'solution');
+            this.addFindingWithOccurrences([{
+                    file: this.file,
+                    resolution: JSON.stringify(resolution, null, 2),
+                    position: this.getPositionFromNode(node)
+                }], findings);
+        }
+    }
+}
+exports.FN006006_CFG_PS_features = FN006006_CFG_PS_features;
+//# sourceMappingURL=FN006006_CFG_PS_features.js.map

package/dist/m365/spfx/commands/project/project-upgrade/rules/FN014008_CODE_launch_hostedWorkbench_type.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FN014008_CODE_launch_hostedWorkbench_type = void 0;
+const path = require("path");
+const JsonRule_1 = require("./JsonRule");
+class FN014008_CODE_launch_hostedWorkbench_type extends JsonRule_1.JsonRule {
+    constructor(type) {
+        super();
+        this.type = type;
+    }
+    get id() {
+        return 'FN014008';
+    }
+    get title() {
+        return 'Hosted workbench type in .vscode/launch.json';
+    }
+    get description() {
+        return `In the .vscode/launch.json file, update the type property for the hosted workbench launch configuration`;
+    }
+    get resolution() {
+        return `{
+  "configurations": [
+    {
+      "type": "${this.type}"
+    }
+  ]
+}`;
+    }
+    get resolutionType() {
+        return 'json';
+    }
+    get severity() {
+        return 'Recommended';
+    }
+    get file() {
+        return '.vscode/launch.json';
+    }
+    visit(project, findings) {
+        if (!project.vsCode ||
+            !project.vsCode.launchJson ||
+            !project.vsCode.launchJson.configurations) {
+            return;
+        }
+        const occurrences = [];
+        project.vsCode.launchJson.configurations.forEach((configuration, i) => {
+            if (configuration.name === 'Hosted workbench' &&
+                configuration.type !== this.type) {
+                const node = this.getAstNodeFromFile(project.vsCode.launchJson, `configurations[${i}].url`);
+                occurrences.push({
+                    file: path.relative(project.path, this.file),
+                    resolution: this.resolution,
+                    position: this.getPositionFromNode(node)
+                });
+            }
+        });
+        if (occurrences.length > 0) {
+            this.addFindingWithOccurrences(occurrences, findings);
+        }
+    }
+}
+exports.FN014008_CODE_launch_hostedWorkbench_type = FN014008_CODE_launch_hostedWorkbench_type;
+//# sourceMappingURL=FN014008_CODE_launch_hostedWorkbench_type.js.map