@pnp/cli-microsoft365 10.3.0-beta.d1b978f → 10.3.0-beta.f5e6f85

package/dist/m365/outlook/commands/mailbox/mailbox-settings-set.js

@@ -0,0 +1,163 @@
+import { z } from 'zod';
+import { globalOptionsZod } from '../../../../Command.js';
+import { zod } from '../../../../utils/zod.js';
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+import { validation } from '../../../../utils/validation.js';
+import request from '../../../../request.js';
+import { accessToken } from '../../../../utils/accessToken.js';
+import auth from '../../../../Auth.js';
+const options = globalOptionsZod
+    .extend({
+    userId: zod.alias('i', z.string().refine(id => validation.isValidGuid(id), id => ({
+        message: `'${id}' is not a valid GUID.`
+    })).optional()),
+    userName: zod.alias('n', z.string().refine(name => validation.isValidUserPrincipalName(name), name => ({
+        message: `'${name}' is not a valid UPN.`
+    })).optional()),
+    dateFormat: z.string().optional(),
+    timeFormat: z.string().optional(),
+    timeZone: z.string().optional(),
+    language: z.string().optional(),
+    delegateMeetingMessageDeliveryOptions: z.enum(['sendToDelegateAndInformationToPrincipal', 'sendToDelegateAndPrincipal', 'sendToDelegateOnly']).optional(),
+    workingDays: z.string().transform((value) => value.split(',')).pipe(z.enum(['monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday', 'sunday']).array()).optional(),
+    workingHoursStartTime: z.string().optional(),
+    workingHoursEndTime: z.string().optional(),
+    workingHoursTimeZone: z.string().optional(),
+    autoReplyExternalAudience: z.enum(['none', 'all', 'contactsOnly']).optional(),
+    autoReplyExternalMessage: z.string().optional(),
+    autoReplyInternalMessage: z.string().optional(),
+    autoReplyStartDateTime: z.string().optional(),
+    autoReplyStartTimeZone: z.string().optional(),
+    autoReplyEndDateTime: z.string().optional(),
+    autoReplyEndTimeZone: z.string().optional(),
+    autoReplyStatus: z.enum(['disabled', 'scheduled', 'alwaysEnabled']).optional()
+})
+    .strict();
+class OutlookMailboxSettingsSetCommand extends GraphCommand {
+    get name() {
+        return commands.MAILBOX_SETTINGS_SET;
+    }
+    get description() {
+        return 'Updates user mailbox settings';
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => [options.workingDays, options.workingHoursStartTime, options.workingHoursEndTime, options.workingHoursTimeZone,
+            options.autoReplyStatus, options.autoReplyExternalAudience, options.autoReplyExternalMessage, options.autoReplyInternalMessage,
+            options.autoReplyStartDateTime, options.autoReplyStartTimeZone, options.autoReplyEndDateTime, options.autoReplyEndTimeZone,
+            options.timeFormat, options.timeZone, options.dateFormat, options.delegateMeetingMessageDeliveryOptions, options.language].filter(o => o !== undefined).length > 0, {
+            message: 'Specify at least one of the following options: workingDays, workingHoursStartTime, workingHoursEndTime, workingHoursTimeZone, autoReplyStatus, autoReplyExternalAudience, autoReplyExternalMessage, autoReplyInternalMessage, autoReplyStartDateTime, autoReplyStartTimeZone, autoReplyEndDateTime, autoReplyEndTimeZone, timeFormat, timeZone, dateFormat, delegateMeetingMessageDeliveryOptions, or language'
+        });
+    }
+    async commandAction(logger, args) {
+        const isAppOnlyAccessToken = accessToken.isAppOnlyAccessToken(auth.connection.accessTokens[auth.defaultResource].accessToken);
+        let requestUrl = `${this.resource}/v1.0/me/mailboxSettings`;
+        if (isAppOnlyAccessToken) {
+            if (args.options.userId && args.options.userName) {
+                throw 'When running with application permissions either userId or userName is required, but not both';
+            }
+            const userIdentifier = args.options.userId ?? args.options.userName;
+            if (this.verbose) {
+                await logger.logToStderr(`Updating mailbox settings for user ${userIdentifier}...`);
+            }
+            requestUrl = `${this.resource}/v1.0/users('${userIdentifier}')/mailboxSettings`;
+        }
+        else {
+            if (args.options.userId || args.options.userName) {
+                throw 'You can update mailbox settings of other users only if CLI is authenticated in app-only mode';
+            }
+        }
+        const requestOptions = {
+            url: requestUrl,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json',
+            data: this.createRequestBody(args)
+        };
+        try {
+            const result = await request.patch(requestOptions);
+            await logger.log(result);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+    createRequestBody(args) {
+        const data = {};
+        if (args.options.dateFormat) {
+            data.dateFormat = args.options.dateFormat;
+        }
+        if (args.options.timeFormat) {
+            data.timeFormat = args.options.timeFormat;
+        }
+        if (args.options.timeZone) {
+            data.timeZone = args.options.timeZone;
+        }
+        if (args.options.delegateMeetingMessageDeliveryOptions) {
+            data.delegateMeetingMessageDeliveryOptions = args.options.delegateMeetingMessageDeliveryOptions;
+        }
+        if (args.options.language) {
+            data.language = {
+                locale: args.options.language
+            };
+        }
+        if (args.options.workingDays || args.options.workingHoursStartTime || args.options.workingHoursEndTime || args.options.workingHoursTimeZone) {
+            data['workingHours'] = {};
+        }
+        if (args.options.workingDays) {
+            data.workingHours.daysOfWeek = args.options.workingDays;
+        }
+        if (args.options.workingHoursStartTime) {
+            data.workingHours.startTime = args.options.workingHoursStartTime;
+        }
+        if (args.options.workingHoursEndTime) {
+            data.workingHours.endTime = args.options.workingHoursEndTime;
+        }
+        if (args.options.workingHoursTimeZone) {
+            data.workingHours.timeZone = {
+                name: args.options.workingHoursTimeZone
+            };
+        }
+        if (args.options.autoReplyStatus || args.options.autoReplyExternalAudience || args.options.autoReplyExternalMessage || args.options.autoReplyInternalMessage || args.options.autoReplyStartDateTime || args.options.autoReplyStartTimeZone || args.options.autoReplyEndDateTime || args.options.autoReplyEndTimeZone) {
+            data['automaticRepliesSetting'] = {};
+        }
+        if (args.options.autoReplyStatus) {
+            data.automaticRepliesSetting['status'] = args.options.autoReplyStatus;
+        }
+        if (args.options.autoReplyExternalAudience) {
+            data.automaticRepliesSetting['externalAudience'] = args.options.autoReplyExternalAudience;
+        }
+        if (args.options.autoReplyExternalMessage) {
+            data.automaticRepliesSetting['externalReplyMessage'] = args.options.autoReplyExternalMessage;
+        }
+        if (args.options.autoReplyInternalMessage) {
+            data.automaticRepliesSetting['internalReplyMessage'] = args.options.autoReplyInternalMessage;
+        }
+        if (args.options.autoReplyStartDateTime || args.options.autoReplyStartTimeZone) {
+            data.automaticRepliesSetting['scheduledStartDateTime'] = {};
+        }
+        if (args.options.autoReplyStartDateTime) {
+            data.automaticRepliesSetting['scheduledStartDateTime']['dateTime'] = args.options.autoReplyStartDateTime;
+        }
+        if (args.options.autoReplyStartTimeZone) {
+            data.automaticRepliesSetting['scheduledStartDateTime']['timeZone'] = args.options.autoReplyStartTimeZone;
+        }
+        if (args.options.autoReplyEndDateTime || args.options.autoReplyEndTimeZone) {
+            data.automaticRepliesSetting['scheduledEndDateTime'] = {};
+        }
+        if (args.options.autoReplyEndDateTime) {
+            data.automaticRepliesSetting['scheduledEndDateTime']['dateTime'] = args.options.autoReplyEndDateTime;
+        }
+        if (args.options.autoReplyEndTimeZone) {
+            data.automaticRepliesSetting['scheduledEndDateTime']['timeZone'] = args.options.autoReplyEndTimeZone;
+        }
+        return data;
+    }
+}
+export default new OutlookMailboxSettingsSetCommand();
+//# sourceMappingURL=mailbox-settings-set.js.map

package/dist/m365/outlook/commands.js

@@ -1,6 +1,7 @@
 const prefix = 'outlook';
 export default {
     MAIL_SEND: `${prefix} mail send`,
+    MAILBOX_SETTINGS_SET: `${prefix} mailbox settings set`,
     MESSAGE_GET: `${prefix} message get`,
     MESSAGE_LIST: `${prefix} message list`,
     MESSAGE_MOVE: `${prefix} message move`,

package/dist/m365/pp/commands/website/website-get.js

@@ -0,0 +1,60 @@
+import { globalOptionsZod } from '../../../../Command.js';
+import { powerPlatform } from '../../../../utils/powerPlatform.js';
+import { validation } from '../../../../utils/validation.js';
+import { zod } from '../../../../utils/zod.js';
+import PowerPlatformCommand from '../../../base/PowerPlatformCommand.js';
+import commands from '../../commands.js';
+import { z } from 'zod';
+const options = globalOptionsZod
+    .extend({
+    url: zod.alias('u', z.string().optional()
+        .refine(url => url === undefined || validation.isValidPowerPagesUrl(url) === true, url => ({
+        message: `'${url}' is not a valid Power Pages URL.`
+    }))),
+    id: zod.alias('i', z.string().uuid().optional()),
+    name: zod.alias('n', z.string().optional()),
+    environmentName: zod.alias('e', z.string())
+}).strict();
+class PpWebSiteGetCommand extends PowerPlatformCommand {
+    get name() {
+        return commands.WEBSITE_GET;
+    }
+    get description() {
+        return 'Gets information about the specified Power Pages website.';
+    }
+    defaultProperties() {
+        return ['id', 'name', 'websiteUrl', 'tenantId', 'subdomain', 'type', 'status', 'siteVisibility'];
+    }
+    get schema() {
+        return options;
+    }
+    getRefinedSchema(schema) {
+        return schema
+            .refine(options => [options.url, options.id, options.name].filter(x => x !== undefined).length === 1, {
+            message: `Specify either url, id or name, but not multiple.`
+        });
+    }
+    async commandAction(logger, args) {
+        if (this.verbose) {
+            await logger.logToStderr(`Retrieving the website...`);
+        }
+        try {
+            let item = null;
+            if (args.options.id) {
+                item = await powerPlatform.getWebsiteById(args.options.environmentName, args.options.id);
+            }
+            else if (args.options.name) {
+                item = await powerPlatform.getWebsiteByName(args.options.environmentName, args.options.name);
+            }
+            else if (args.options.url) {
+                item = await powerPlatform.getWebsiteByUrl(args.options.environmentName, args.options.url);
+            }
+            await logger.log(item);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+}
+export default new PpWebSiteGetCommand();
+//# sourceMappingURL=website-get.js.map

package/dist/m365/pp/commands.js

@@ -33,6 +33,7 @@ export default {
     SOLUTION_PUBLISHER_LIST: `${prefix} solution publisher list`,
     SOLUTION_PUBLISHER_REMOVE: `${prefix} solution publisher remove`,
     TENANT_SETTINGS_LIST: `${prefix} tenant settings list`,
-    TENANT_SETTINGS_SET: `${prefix} tenant settings set`
+    TENANT_SETTINGS_SET: `${prefix} tenant settings set`,
+    WEBSITE_GET: `${prefix} website get`
 };
 //# sourceMappingURL=commands.js.map

package/dist/m365/spo/commands/folder/folder-roleassignment-add.js

@@ -64,25 +64,12 @@ class SpoFolderRoleAssignmentAddCommand extends SpoCommand {
                 const siteUser = await spo.ensureEntraGroup(args.options.webUrl, group);
                 principalId = siteUser.Id;
             }
-            await this.breakRoleAssignment(requestUrl);
             await this.addRoleAssignment(requestUrl, principalId, roleDefinitionId);
         }
         catch (err) {
             this.handleRejectedODataJsonPromise(err);
         }
     }
-    async breakRoleAssignment(requestUrl) {
-        const requestOptions = {
-            url: `${requestUrl}/breakroleinheritance(true)`,
-            method: 'POST',
-            headers: {
-                'accept': 'application/json;odata=nometadata',
-                'content-type': 'application/json'
-            },
-            responseType: 'json'
-        };
-        return request.post(requestOptions);
-    }
     async addRoleAssignment(requestUrl, principalId, roleDefinitionId) {
         const requestOptions = {
             url: `${requestUrl}/roleassignments/addroleassignment(principalid='${principalId}',roledefid='${roleDefinitionId}')`,

package/dist/m365/tenant/commands/people/people-pronouns-set.js

@@ -0,0 +1,46 @@
+import { z } from 'zod';
+import { globalOptionsZod } from '../../../../Command.js';
+import request from '../../../../request.js';
+import { zod } from '../../../../utils/zod.js';
+import GraphCommand from '../../../base/GraphCommand.js';
+import commands from '../../commands.js';
+const options = globalOptionsZod
+    .extend({
+    enabled: zod.alias('e', z.boolean())
+})
+    .strict();
+class TenantPeoplePronounsSetCommand extends GraphCommand {
+    get name() {
+        return commands.PEOPLE_PRONOUNS_SET;
+    }
+    get description() {
+        return 'Manage pronouns settings for an organization';
+    }
+    get schema() {
+        return options;
+    }
+    async commandAction(logger, args) {
+        try {
+            if (this.verbose) {
+                await logger.logToStderr('Updating pronouns settings...');
+            }
+            const requestOptions = {
+                url: `${this.resource}/v1.0/admin/people/pronouns`,
+                headers: {
+                    accept: 'application/json;odata.metadata=none'
+                },
+                data: {
+                    isEnabledInOrganization: args.options.enabled
+                },
+                responseType: 'json'
+            };
+            const pronouns = await request.patch(requestOptions);
+            await logger.log(pronouns);
+        }
+        catch (err) {
+            this.handleRejectedODataJsonPromise(err);
+        }
+    }
+}
+export default new TenantPeoplePronounsSetCommand();
+//# sourceMappingURL=people-pronouns-set.js.map

package/dist/m365/tenant/commands.js

@@ -8,6 +8,7 @@ export default {
     PEOPLE_PROFILECARDPROPERTY_REMOVE: `${prefix} people profilecardproperty remove`,
     PEOPLE_PROFILECARDPROPERTY_SET: `${prefix} people profilecardproperty set`,
     PEOPLE_PRONOUNS_GET: `${prefix} people pronouns get`,
+    PEOPLE_PRONOUNS_SET: `${prefix} people pronouns set`,
     REPORT_ACTIVEUSERCOUNTS: `${prefix} report activeusercounts`,
     REPORT_ACTIVEUSERDETAIL: `${prefix} report activeuserdetail`,
     REPORT_OFFICE365ACTIVATIONCOUNTS: `${prefix} report office365activationcounts`,

package/dist/utils/customAppScope.js

@@ -0,0 +1,29 @@
+import { cli } from '../cli/cli.js';
+import { formatting } from './formatting.js';
+import { odata } from './odata.js';
+export const customAppScope = {
+    /**
+     * Get a custom application scope by its name
+     * @param displayName Custom application scope display name.
+     * @param properties Comma-separated list of properties to include in the response.
+     * @returns The custom application scope.
+     * @throws Error when role definition was not found.
+     */
+    async getCustomAppScopeByDisplayName(displayName, properties) {
+        let url = `https://graph.microsoft.com/beta/roleManagement/exchange/customAppScopes?$filter=displayName eq '${formatting.encodeQueryParameter(displayName)}'`;
+        if (properties) {
+            url += `&$select=${properties}`;
+        }
+        const customAppScopes = await odata.getAllItems(url);
+        if (customAppScopes.length === 0) {
+            throw `The specified custom application scope '${displayName}' does not exist.`;
+        }
+        if (customAppScopes.length > 1) {
+            const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', customAppScopes);
+            const selectedCustomAppScope = await cli.handleMultipleResultsFound(`Multiple custom application scopes with name '${displayName}' found.`, resultAsKeyValuePair);
+            return selectedCustomAppScope;
+        }
+        return customAppScopes[0];
+    }
+};
+//# sourceMappingURL=customAppScope.js.map

package/dist/utils/entraServicePrincipal.js

@@ -0,0 +1,46 @@
+import { odata } from './odata.js';
+import { formatting } from './formatting.js';
+import { cli } from '../cli/cli.js';
+export const entraServicePrincipal = {
+    /**
+     * Get service principal by its appId
+     * @param appId App id.
+     * @param properties Comma-separated list of properties to include in the response.
+     * @returns The service principal.
+     * @throws Error when service principal was not found.
+     */
+    async getServicePrincipalByAppId(appId, properties) {
+        let url = `https://graph.microsoft.com/v1.0/servicePrincipals?$filter=appId eq '${appId}'`;
+        if (properties) {
+            url += `&$select=${properties}`;
+        }
+        const apps = await odata.getAllItems(url);
+        if (apps.length === 0) {
+            throw `Service principal with appId '${appId}' not found in Microsoft Entra ID`;
+        }
+        return apps[0];
+    },
+    /**
+     * Get service principal by its name
+     * @param appName Service principal name.
+     * @param properties Comma-separated list of properties to include in the response.
+     * @returns The service principal.
+     * @throws Error when service principal was not found.
+     */
+    async getServicePrincipalByAppName(appName, properties) {
+        let url = `https://graph.microsoft.com/v1.0/servicePrincipals?$filter=displayName eq '${formatting.encodeQueryParameter(appName)}'`;
+        if (properties) {
+            url += `&$select=${properties}`;
+        }
+        const apps = await odata.getAllItems(url);
+        if (apps.length === 0) {
+            throw `Service principal with name '${appName}' not found in Microsoft Entra ID`;
+        }
+        if (apps.length > 1) {
+            const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', apps);
+            return await cli.handleMultipleResultsFound(`Multiple service principals with name '${appName}' found in Microsoft Entra ID.`, resultAsKeyValuePair);
+        }
+        return apps[0];
+    }
+};
+//# sourceMappingURL=entraServicePrincipal.js.map

package/dist/utils/powerPlatform.js

@@ -1,5 +1,7 @@
+import { cli } from "../cli/cli.js";
 import request from "../request.js";
 import { formatting } from "./formatting.js";
+import { odata } from "./odata.js";
 const powerPlatformResource = 'https://api.bap.microsoft.com';
 export const powerPlatform = {
     async getDynamicsInstanceApiUrl(environment, asAdmin) {
@@ -24,6 +26,42 @@ export const powerPlatform = {
         catch (ex) {
             throw Error(`The environment '${environment}' could not be retrieved. See the inner exception for more details: ${ex.message}`);
         }
+    },
+    async getWebsiteById(environment, id) {
+        const requestOptions = {
+            url: `https://api.powerplatform.com/powerpages/environments/${environment}/websites/${id}?api-version=2022-03-01-preview`,
+            headers: {
+                accept: 'application/json;odata.metadata=none'
+            },
+            responseType: 'json'
+        };
+        try {
+            const response = await request.get(requestOptions);
+            return response;
+        }
+        catch (ex) {
+            throw Error(`The specified Power Page website with id '${id}' does not exist.`);
+        }
+    },
+    async getWebsiteByName(environment, websiteName) {
+        const response = await odata.getAllItems(`https://api.powerplatform.com/powerpages/environments/${environment}/websites?api-version=2022-03-01-preview`);
+        const items = response.filter(response => response.name === websiteName);
+        if (items.length === 0) {
+            throw Error(`The specified Power Page website '${websiteName}' does not exist.`);
+        }
+        if (items.length > 1) {
+            const resultAsKeyValuePair = formatting.convertArrayToHashTable('websiteUrl', items);
+            return cli.handleMultipleResultsFound(`Multiple Power Page websites with name '${websiteName}' found`, resultAsKeyValuePair);
+        }
+        return items[0];
+    },
+    async getWebsiteByUrl(environment, url) {
+        const response = await odata.getAllItems(`https://api.powerplatform.com/powerpages/environments/${environment}/websites?api-version=2022-03-01-preview`);
+        const items = response.filter(response => response.websiteUrl === url);
+        if (items.length === 0) {
+            throw Error(`The specified Power Page website with url '${url}' does not exist.`);
+        }
+        return items[0];
     }
 };
 //# sourceMappingURL=powerPlatform.js.map

package/dist/utils/roleDefinition.js

@@ -46,6 +46,29 @@ export const roleDefinition = {
             responseType: 'json'
         };
         return await request.get(requestOptions);
+    },
+    /**
+     * Get an Exchange role by its name
+     * @param displayName Role definition display name.
+     * @param properties Comma-separated list of properties to include in the response.
+     * @returns The role definition.
+     * @throws Error when role definition was not found.
+     */
+    async getExchangeRoleDefinitionByDisplayName(displayName, properties) {
+        let url = `https://graph.microsoft.com/beta/roleManagement/exchange/roleDefinitions?$filter=displayName eq '${formatting.encodeQueryParameter(displayName)}'`;
+        if (properties) {
+            url += `&$select=${properties}`;
+        }
+        const roleDefinitions = await odata.getAllItems(url);
+        if (roleDefinitions.length === 0) {
+            throw `The specified role definition '${displayName}' does not exist.`;
+        }
+        if (roleDefinitions.length > 1) {
+            const resultAsKeyValuePair = formatting.convertArrayToHashTable('id', roleDefinitions);
+            const selectedRoleDefinition = await cli.handleMultipleResultsFound(`Multiple role definitions with name '${displayName}' found.`, resultAsKeyValuePair);
+            return selectedRoleDefinition;
+        }
+        return roleDefinitions[0];
     }
 };
 //# sourceMappingURL=roleDefinition.js.map

package/dist/utils/validation.js

@@ -357,6 +357,10 @@ export const validation = {
             .split(' ')
             .filter(permission => permission.indexOf('/') < 0);
         return invalidPermissions.length > 0 ? invalidPermissions : true;
+    },
+    isValidPowerPagesUrl(url) {
+        const powerPagesUrlPattern = /^https:\/\/[a-zA-Z0-9-]+\.powerappsportals\.com$/;
+        return powerPagesUrlPattern.test(url);
     }
 };
 //# sourceMappingURL=validation.js.map