@pnp/cli-microsoft365 5.0.0-beta.fc638c4 → 5.1.0-beta.55e5dfb

package/dist/utils/validation.js

@@ -0,0 +1,310 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validation = void 0;
+exports.validation = {
+    isValidGuidArray(guids) {
+        return guids.every(guid => this.isValidGuid(guid));
+    },
+    isValidGuid(guid) {
+        const guidRegEx = new RegExp(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i);
+        return guidRegEx.test(guid);
+    },
+    isValidTeamsChannelId(guid) {
+        const guidRegEx = new RegExp(/^19:[0-9a-zA-Z-_]+@thread\.(skype|tacv2)$/i);
+        return guidRegEx.test(guid);
+    },
+    isValidTeamsChatId(guid) {
+        const guidRegEx = new RegExp(/^19:[0-9a-zA-Z-_]+(@thread\.v2|@unq\.gbl\.spaces)$/i);
+        return guidRegEx.test(guid);
+    },
+    isValidUserPrincipalName(upn) {
+        const upnRegEx = new RegExp(/^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*$/i);
+        return upnRegEx.test(upn);
+    },
+    isDateInRange(date, monthOffset) {
+        const d = new Date(date);
+        const cutoffDate = new Date();
+        cutoffDate.setMonth(cutoffDate.getMonth() - monthOffset);
+        return d > cutoffDate;
+    },
+    isValidISODate(date) {
+        const dateRegEx = new RegExp(/^(19|20)\d\d[- /.](0[1-9]|1[012])[- /.](0[1-9]|[12][0-9]|3[01])$/i);
+        return dateRegEx.test(date);
+    },
+    isValidISODateDashOnly(date) {
+        const dateTimeRegEx = new RegExp(/^(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d\.\d+([+-][0-2]\d:[0-5]\d|Z))|(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z))|(\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z))$/i);
+        const dateOnlyRegEx = new RegExp(/^(19|20)\d\d[-](0[1-9]|1[012])[-](0[1-9]|[12][0-9]|3[01])$/i);
+        return dateTimeRegEx.test(date) ? true : dateOnlyRegEx.test(date);
+    },
+    isValidISODateTime(dateTime) {
+        const withMilliSecsPattern = new RegExp(/^[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|[12][0-9]))T(0[0-9]|1[0-9]|2[0-3]):(0[0-9]|[1-5][0-9]):(0[0-9]|[1-5][0-9])\.[0-9]{3}Z$/);
+        if (withMilliSecsPattern.test(dateTime)) {
+            return true;
+        }
+        const withSecsPattern = new RegExp(/^[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|[12][0-9]))T(0[0-9]|1[0-9]|2[0-3]):(0[0-9]|[1-5][0-9]):(0[0-9]|[1-5][0-9])Z$/);
+        if (withSecsPattern.test(dateTime)) {
+            return true;
+        }
+        const withMinutesPattern = new RegExp(/^[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|[12][0-9]))T(0[0-9]|1[0-9]|2[0-3]):(0[0-9]|[1-5][0-9])Z$/);
+        if (withMinutesPattern.test(dateTime)) {
+            return true;
+        }
+        const withHoursPattern = new RegExp(/^[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|[12][0-9]))T(0[0-9]|1[0-9]|2[0-3])Z$/);
+        if (withHoursPattern.test(dateTime)) {
+            return true;
+        }
+        const withoutTimePattern = new RegExp(/^[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|[12][0-9]))$/);
+        if (withoutTimePattern.test(dateTime)) {
+            return true;
+        }
+        return false;
+    },
+    isValidBoolean(value) {
+        return value.toLowerCase() === 'true' || value.toLowerCase() === 'false';
+    },
+    isJavaScriptReservedWord(input) {
+        const javascriptReservedWords = [
+            "arguments",
+            "await",
+            "break",
+            "case",
+            "catch",
+            "class",
+            "const",
+            "continue",
+            "debugger",
+            "default",
+            "delete",
+            "do",
+            "else",
+            "enum",
+            "eval",
+            "export",
+            "extends",
+            "false",
+            "finally",
+            "for",
+            "function",
+            "if",
+            "implements",
+            "import",
+            "in",
+            "instanceof",
+            "interface",
+            "let",
+            "new",
+            "null",
+            "package",
+            "private",
+            "protected",
+            "public",
+            "return",
+            "static",
+            "super",
+            "switch",
+            "this",
+            "throw",
+            "true",
+            "try",
+            "typeof",
+            "var",
+            "void",
+            "while",
+            "with",
+            "yield",
+            "Array",
+            "Date",
+            "eval",
+            "function",
+            "hasOwnProperty",
+            "Infinity",
+            "isFinite",
+            "isNaN",
+            "isPrototypeOf",
+            "length",
+            "Math",
+            "NaN",
+            "name",
+            "Number",
+            "Object",
+            "prototype",
+            "String",
+            "toString",
+            "undefined",
+            "valueOf",
+            "alert",
+            "all",
+            "anchor",
+            "anchors",
+            "area",
+            "assign",
+            "blur",
+            "button",
+            "checkbox",
+            "clearInterval",
+            "clearTimeout",
+            "clientInformation",
+            "close",
+            "closed",
+            "confirm",
+            "constructor",
+            "crypto",
+            "decodeURI",
+            "decodeURIComponent",
+            "defaultStatus",
+            "document",
+            "element",
+            "elements",
+            "embed",
+            "embeds",
+            "encodeURI",
+            "encodeURIComponent",
+            "escape",
+            "event",
+            "fileUpload",
+            "focus",
+            "form",
+            "forms",
+            "frame",
+            "innerHeight",
+            "innerWidth",
+            "layer",
+            "layers",
+            "link",
+            "location",
+            "mimeTypes",
+            "navigate",
+            "navigator",
+            "frames",
+            "frameRate",
+            "hidden",
+            "history",
+            "image",
+            "images",
+            "offscreenBuffering",
+            "open",
+            "opener",
+            "option",
+            "outerHeight",
+            "outerWidth",
+            "packages",
+            "pageXOffset",
+            "pageYOffset",
+            "parent",
+            "parseFloat",
+            "parseInt",
+            "password",
+            "pkcs11",
+            "plugin",
+            "prompt",
+            "propertyIsEnum",
+            "radio",
+            "reset",
+            "screenX",
+            "screenY",
+            "scroll",
+            "secure",
+            "select",
+            "self",
+            "setInterval",
+            "setTimeout",
+            "status",
+            "submit",
+            "taint",
+            "text",
+            "textarea",
+            "top",
+            "unescape",
+            "untaint",
+            "window",
+            "onblur",
+            "onclick",
+            "onerror",
+            "onfocus",
+            "onkeydown",
+            "onkeypress",
+            "onkeyup",
+            "onmouseover",
+            "onload",
+            "onmouseup",
+            "onmousedown",
+            "onsubmit"
+        ];
+        return !!input && !input.split('.').every(value => !~javascriptReservedWords.indexOf(value));
+    },
+    isValidFileName(input) {
+        return !!input && !/^((\..*)|COM\d|CLOCK\$|LPT\d|AUX|NUL|CON|PRN|(.*[\u{d800}-\u{dfff}]+.*))$/iu.test(input) && !/^(.*\.\..*)$/i.test(input);
+    },
+    isValidTheme(input) {
+        const validThemeProperties = [
+            "themePrimary",
+            "themeLighterAlt",
+            "themeLighter",
+            "themeLight",
+            "themeTertiary",
+            "themeSecondary",
+            "themeDarkAlt",
+            "themeDark",
+            "themeDarker",
+            "neutralLighterAlt",
+            "neutralLighter",
+            "neutralLight",
+            "neutralQuaternaryAlt",
+            "neutralQuaternary",
+            "neutralTertiaryAlt",
+            "neutralTertiary",
+            "neutralSecondary",
+            "neutralPrimaryAlt",
+            "neutralPrimary",
+            "neutralDark",
+            "black",
+            "white"
+        ];
+        let theme;
+        try {
+            theme = JSON.parse(input);
+        }
+        catch (_a) {
+            return false;
+        }
+        if (Array.isArray(theme)) {
+            return false;
+        }
+        const hasInvalidProperties = validThemeProperties.map((property) => {
+            return theme.hasOwnProperty(property);
+        }).includes(false);
+        if (hasInvalidProperties) {
+            return false;
+        }
+        const regex = new RegExp(/^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/);
+        const hasInvalidValues = validThemeProperties.map((property) => {
+            return regex.test(theme[property]);
+        }).includes(false);
+        if (hasInvalidValues) {
+            return false;
+        }
+        return true;
+    },
+    isValidSharePointUrl(url) {
+        if (!url) {
+            return false;
+        }
+        if (url.indexOf('https://') !== 0) {
+            return `${url} is not a valid SharePoint Online site URL`;
+        }
+        else {
+            return true;
+        }
+    },
+    isValidFormDigest(contextInfo) {
+        if (!contextInfo) {
+            return false;
+        }
+        const now = new Date();
+        if (contextInfo.FormDigestValue && now < contextInfo.FormDigestExpiresAt) {
+            return true;
+        }
+        return false;
+    }
+};
+//# sourceMappingURL=validation.js.map

package/docs/docs/cmd/aad/app/app-delete.md

@@ -0,0 +1,51 @@
+# aad app delete
+
+Removes an Azure AD app registration
+
+## Usage
+
+```sh
+m365 aad app delete [options]
+```
+
+## Options
+
+`--appId [appId]`
+: Application (client) ID of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name`
+
+`--objectId [objectId]`
+: Object ID of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name`
+
+`--name [name]`
+: Name of the Azure AD application registration to remove. Specify either `appId`, `objectId` or `name`
+
+`--confirm`:
+: Don't prompt for confirmation to delete the app
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+For best performance use the `objectId` option to reference the Azure AD application registration to delete. If you use `appId` or `name`, this command will first need to find the corresponding object ID for that application.
+
+If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
+
+## Examples
+
+Delete the Azure AD application registration by its app (client) ID
+
+```sh
+m365 aad app delete --appId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Delete the Azure AD application registration by its object ID
+
+```sh
+m365 aad app delete --objectId d75be2e1-0204-4f95-857d-51a37cf40be8
+```
+
+Delete the Azure AD application registration by its name. Will NOT prompt for confirmation before deleting.
+
+```sh
+m365 aad app delete --name "My app" --confirm
+```

package/docs/docs/cmd/aad/app/app-get.md

@@ -19,14 +19,19 @@ m365 aad app get [options]
 `--name [name]`
 : Name of the Azure AD application registration to get. Specify either `appId`, `objectId` or `name`
 
+`--save`
+: Use to store the information about the created app in a local file
+
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
 
-For best performance use the `objectId` option to reference the Azure AD application registration to update. If you use `appId` or `name`, this command will first need to find the corresponding object ID for that application.
+For best performance use the `objectId` option to reference the Azure AD application registration to get. If you use `appId` or `name`, this command will first need to find the corresponding object ID for that application.
 
 If the command finds multiple Azure AD application registrations with the specified app name, it will prompt you to disambiguate which app it should use, listing the discovered object IDs.
 
+If you want to store the information about the Azure AD app registration, use the `--save` option. This is useful when you build solutions connected to Microsoft 365 and want to easily manage app registrations used with your solution. When you use the `--save` option, after you get the app registration, the command will write its ID and name to the `.m365rc.json` file in the current directory. If the file already exists, it will add the information about the App registration to it if it's not already present, allowing you to track multiple apps. If the file doesn't exist, the command will create it.
+
 ## Examples
 
 Get the Azure AD application registration by its app (client) ID
@@ -46,3 +51,9 @@ Get the Azure AD application registration by its name
 ```sh
 m365 aad app get --name "My app"
 ```
+
+Get the Azure AD application registration by its name. Store information about the retrieved app registration in the _.m365rc.json_ file in the current directory.
+
+```sh
+m365 aad app get --name "My app" --save
+```

package/docs/docs/cmd/aad/app/app-set.md

@@ -22,6 +22,15 @@ m365 aad app set [options]
 `-u, --uri [uri]`
 : Application ID URI to update
 
+`-r, --redirectUris [redirectUris]`
+: Comma-separated list of redirect URIs to add to the app registration. Requires `platform` to be specified
+
+`-p, --platform [platform]`
+: Platform for which the `redirectUri` should be configured. Allowed values `spa,web,publicClient`
+
+`--redirectUrisToRemove [redirectUrisToRemove]`
+: Comma-separated list of existing redirect URIs to remove. Specify, when you want to replace existing redirect URIs with another
+
 --8<-- "docs/cmd/_global.md"
 
 ## Remarks
@@ -49,3 +58,15 @@ Update the app URI of the Azure AD application registration specified by its nam
 ```sh
 m365 aad app set --name "My app" --uri https://contoso.com/e75be2e1-0204-4f95-857d-51a37cf40be8
 ```
+
+Add a new redirect URI for SPA authentication
+
+```sh
+m365 aad app set --objectId 95cfe30d-ed44-4f9d-b73d-c66560f72e83 --redirectUris https://contoso.com/auth --platform spa
+```
+
+Replace one redirect URI with another for SPA authentication
+
+```sh
+m365 aad app set --objectId 95cfe30d-ed44-4f9d-b73d-c66560f72e83 --redirectUris https://contoso.com/auth --platform spa --redirectUrisToRemove https://contoso.com/old-auth
+```

package/docs/docs/cmd/aad/group/group-list.md

@@ -10,6 +10,9 @@ m365 aad group list [options]
 
 ## Options
 
+`-d, --deleted`
+: Use to retrieve deleted groups
+
 --8<-- "docs/cmd/_global.md"
 
 ## Examples
@@ -18,4 +21,10 @@ Lists all groups defined in Azure Active Directory.
 
 ```sh
 m365 aad group list
+```
+
+List all recently deleted groups in the tenant
+
+```sh
+m365 aad group list --deleted
 ```

package/docs/docs/cmd/aad/o365group/o365group-conversation-list.md

@@ -0,0 +1,24 @@
+# aad o365group conversation list
+
+Lists conversations for the specified Microsoft 365 group
+
+## Usage
+
+```sh
+m365 aad o365group conversation list [options]
+```
+
+## Options
+
+`-i, --groupId <groupId>`
+: The ID of the Microsoft 365 group
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Lists conversations for the specified Microsoft 365 group
+
+```sh
+m365 aad o365group conversation list --groupId '00000000-0000-0000-0000-000000000000'
+```

package/docs/docs/cmd/outlook/room/room-list.md

@@ -0,0 +1,30 @@
+# outlook room list
+
+Get a collection of all available rooms
+
+## Usage
+
+```sh
+m365 outlook room list [options]
+```
+
+## Options
+
+`--roomlistEmail [roomlistEmail]`
+: Use to filter returned rooms by their roomlist email (eg. bldg2@contoso.com)
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get all the rooms
+
+```sh
+m365 outlook room list
+```
+
+Get all the rooms of specified roomlist e-mail address
+
+```sh
+m365 outlook room list --roomlistEmail "bldg2@contoso.com"
+```

package/docs/docs/cmd/outlook/roomlist/roomlist-list.md

@@ -0,0 +1,21 @@
+# outlook roomlist list
+
+Get a collection of available roomlists
+
+## Usage
+
+```sh
+m365 outlook roomlist list [options]
+```
+
+## Options
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Get all roomlists in your tenant
+
+```sh
+m365 outlook roomlist list
+```

package/docs/docs/cmd/planner/plan/plan-details-get.md

@@ -0,0 +1,45 @@
+# planner plan details get
+
+Retrieve the planner details about the specified plan.
+
+## Usage
+
+```sh
+m365 planner plan details get [options]
+```
+
+## Options
+
+`-i, --planId [planId]`
+: ID of the plan. Specify either `planId` or `planTitle` but not both.
+
+`-t, --planTitle [planTitle]`
+: Title of the plan. Specify either `planId` or `planTitle` but not both.
+
+`--ownerGroupId [ownerGroupId]`
+: ID of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` but not both.
+
+`--ownerGroupName [ownerGroupName]`
+: Name of the Group that owns the plan. Specify either `ownerGroupId` or `ownerGroupName` but not both.
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Returns the Microsoft Planner plan details with id _gndWOTSK60GfPQfiDDj43JgACDCb_
+
+```sh
+m365 planner plan details get --planId "gndWOTSK60GfPQfiDDj43JgACDCb"
+```
+
+Returns the Microsoft Planner plan details with title _MyPlan_ for Group _233e43d0-dc6a-482e-9b4e-0de7a7bce9b4_
+
+```sh
+m365 planner plan details get --planTitle "MyPlan" --ownerGroupId "233e43d0-dc6a-482e-9b4e-0de7a7bce9b4"
+```
+
+Returns the Microsoft Planner plan details with title _MyPlan_ for Group _My Planner Group_
+
+```sh
+m365 planner plan details get --planTitle "MyPlan" --ownerGroupName "My Planner Group"
+```

package/docs/docs/cmd/planner/task/task-details-get.md

@@ -0,0 +1,24 @@
+# planner task details get
+
+Retrieve the details of the specified planner task
+
+## Usage
+
+```sh
+m365 planner task details get [options]
+```
+
+## Options
+
+`-i, --taskId <taskId>`
+: ID of the task to retrieve details from
+
+--8<-- "docs/cmd/_global.md"
+
+## Examples
+
+Retrieve the details of the specified planner task
+
+```sh
+m365 planner task details get --taskId 'vzCcZoOv-U27PwydxHB8opcADJo-'
+```

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

@@ -0,0 +1,29 @@
+# planner task get
+
+Retrieve the the specified planner task
+
+## Usage
+
+```sh
+m365 planner task get [options]
+```
+
+## Options
+
+`-i, --id <id>`
+: ID of the task to retrieve details from
+
+--8<-- "docs/cmd/_global.md"
+
+## Remarks
+
+!!! attention
+    This command uses an API that is currently in preview to enrich the results with the `priority` field. Keep in mind that this preview API is subject to change once the API reached general availability.
+
+## Examples
+
+Retrieve the the specified planner task
+
+```sh
+m365 planner task get --id 'vzCcZoOv-U27PwydxHB8opcADJo-'
+```

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

@@ -30,6 +30,11 @@ m365 planner task list [options]
 
 --8<-- "docs/cmd/_global.md"
 
+## Remarks
+
+!!! attention
+    This command uses API that is currently in preview to enrich the results with the `priority` field. Keep in mind that this preview API is subject to change once the API reached general availability.
+
 ## Examples
 
 List tasks for the currently logged in user

package/docs/docs/cmd/search/externalconnection/externalconnection-add.md

@@ -30,14 +30,14 @@ The `id` must be at least 3 and no more than 32 characters long. It can contain
 
 ## Examples
 
-Adds a new external connection with name and description of test
+Adds a new external connection with name and description of test app
 
 ```sh
-m365 search externalconnection add --id MyApp --name "My application" --description "Description of your application"
+m365 search externalconnection add --id MyApp --name "Test" --description "Test"
 ```
 
 Adds a new external connection with a limited number of authorized apps
 
 ```sh
-m365 search externalconnection add --id MyApp --name "My application" --description "Description of your application" --authorizedAppIds  "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002"
+m365 search externalconnection add --id MyApp --name "Test" --description "Test" --authorizedAppIds  "00000000-0000-0000-0000-000000000000,00000000-0000-0000-0000-000000000001,00000000-0000-0000-0000-000000000002"
 ```