Adds ability to exclude optional parameters in ConvertTo-PodeWebPage; Adds support for displaying output from ConvertTo-PodeWebPage textbox as JSON; Adds further Grouping support to ConvertTo-PodeWebPage

examples/functions.ps1

@@ -1,7 +1,7 @@
 Import-Module Pode -MaximumVersion 2.99.99 -Force
 Import-Module ..\src\Pode.Web.psm1 -Force
 
-Import-Module ./misc/functions.psm1
+Import-Module ./misc/functions.psm1 -Force
 
 Start-PodeServer {
     # add a simple endpoint
@@ -15,5 +15,5 @@ Start-PodeServer {
     Export-PodeModule -Name 'functions'
 
     # convert module to pages
-    ConvertTo-PodeWebPage -Commands 'Get-Noun'
+    ConvertTo-PodeWebPage -Commands 'Get-Noun', 'Get-CustomObject' -AsJson
 }

examples/misc/functions.psm1

@@ -6,3 +6,14 @@ function Get-Noun {
 
     return "Ok = $V1"
 }
+
+function Get-CustomObject {
+    [CmdletBinding()]
+    param (
+        [String]$V1
+    )
+
+    return [PSCustomObject]@{
+        Ok = $V1
+    }
+}

src/Public/Pages.ps1

@@ -821,7 +821,7 @@ function Add-PodeWebPageLink {
 }
 
 function ConvertTo-PodeWebPage {
-    [CmdletBinding()]
+    [CmdletBinding(DefaultParameterSetName = 'NoGroup')]
     param(
         [Parameter(ValueFromPipeline = $true)]
         [string[]]
@@ -831,13 +831,33 @@ function ConvertTo-PodeWebPage {
         [string]
         $Module,
 
+        [Parameter()]
+        [ValidateRange(1, [int]::MaxValue)]
+        [int]
+        $Depth = 1,
+
+        [Parameter(ParameterSetName = 'GroupByCustom')]
+        [string]
+        $Group,
+
+        [Parameter(ParameterSetName = 'GroupByVerbs')]
         [switch]
         $GroupVerbs,
 
+        [Parameter(ParameterSetName = 'GroupByModule')]
+        [switch]
+        $GroupModule,
+
         [Parameter()]
         [Alias('NoAuth')]
         [switch]
-        $NoAuthentication
+        $NoAuthentication,
+
+        [switch]
+        $ExcludeOptionalParameters,
+
+        [switch]
+        $AsJson
     )
 
     # if a module was supplied, import it - then validate the commands
@@ -868,8 +888,13 @@ function ConvertTo-PodeWebPage {
         throw 'No commands supplied to convert to Pages'
     }
 
+    # list of system parameters to ignore when building input controls
     $sysParams = [System.Management.Automation.PSCmdlet]::CommonParameters.GetEnumerator() | Foreach-Object { $_ }
 
+    if ($ExcludeOptionalParameters) {
+        $sysParams += [System.Management.Automation.PSCmdlet]::OptionalParameters.GetEnumerator() | Foreach-Object { $_ }
+    }
+
     # create the pages for each of the commands
     foreach ($cmd in $Commands) {
         Write-Verbose "Building page for $($cmd)"
@@ -946,7 +971,9 @@ function ConvertTo-PodeWebPage {
 
                 # build form
                 $formId = "form_param_$($cmd)_$($name)"
-                $form = New-PodeWebForm -Name "$($name)_Parameters_Form" -Id $formId -Content $elements -NoAuthentication:$NoAuthentication -ScriptBlock {
+                $form = New-PodeWebForm -Name "$($name)_Parameters_Form" -Id $formId -Content $elements -NoAuthentication:$NoAuthentication -ArgumentList $AsJson.IsPresent, $Depth -ScriptBlock {
+                    param($AsJson, $Depth)
+
                     $cmd = $WebEvent.Data['_Function_Name_']
                     $WebEvent.Data.Remove('_Function_Name_')
 
@@ -983,29 +1010,49 @@ function ConvertTo-PodeWebPage {
                     }
 
                     try {
-                        (. $cmd @_args) |
-                            New-PodeWebTextbox -Name 'Output_Result' -Multiline -Preformat |
-                            Out-PodeWebElement
+                        $result = (. $cmd @_args)
+                        if ($AsJson) {
+                            $result = $result | ConvertTo-Json -Depth $Depth
+                        }
+
+                        New-PodeWebTextbox -Name 'Output_Result' -Multiline -Preformat -Value $result | Out-PodeWebElement
                     }
                     catch {
-                        $_.Exception |
-                            New-PodeWebTextbox -Name 'Output_Error' -Multiline -Preformat |
-                            Out-PodeWebElement
+                        $result = $_.Exception
+                        if ($AsJson) {
+                            $result = $result | ConvertTo-Json -Depth $Depth
+                        }
+
+                        New-PodeWebTextbox -Name 'Output_Error' -Multiline -Preformat -Value $result | Out-PodeWebElement
                     }
                 }
 
                 $card = New-PodeWebCard -Name "$($name)_Parameters" -DisplayName 'Parameters' -Content $form
                 New-PodeWebTab -Name $name -Content $card
             })
 
-        $group = [string]::Empty
-        if ($GroupVerbs) {
-            $group = $cmdInfo.Verb
-            if ([string]::IsNullOrWhiteSpace($group)) {
-                $group = '_'
+        # which group should the page belong to?
+        switch ($PSCmdlet.ParameterSetName) {
+            'NoGroup' {
+                $Group = [string]::Empty
+            }
+
+            'GroupByVerbs' {
+                $Group = $cmdInfo.Verb
+                if ([string]::IsNullOrWhiteSpace($Group)) {
+                    $Group = '_'
+                }
+            }
+
+            'GroupByModule' {
+                $Group = $cmdInfo.ModuleName
+                if ([string]::IsNullOrWhiteSpace($Group)) {
+                    $Group = '_'
+                }
             }
         }
 
+        # add the page
         Add-PodeWebPage `
             -Name $cmd `
             -Icon Settings `