Release JumpCloud PowerShell Module v3.1.0

.github/workflows/powershell-module-ci.yml

@@ -7,6 +7,7 @@ on:
     # Sequence of patterns matched against refs/heads
     branches:
       - "master"
+      - "v*.*.*_pwshModule"
     paths:
       - "PowerShell/Deploy/**"
       - "PowerShell/JumpCloud Module/**"
@@ -98,20 +99,24 @@ jobs:
               'PlatyPS'                               = @{Repository = 'PSGallery'; RequiredVersion = '0.14.2' }
               'AWS.Tools.Common'                      = @{Repository = 'PSGallery'; RequiredVersion = '4.1.122' }
               'AWS.Tools.CodeArtifact'                = @{Repository = 'PSGallery'; RequiredVersion = '4.1.122' }
-              'JumpCloud.SDK.V1'                      = @{Repository = 'PSGallery'; RequiredVersion = '0.1.1'}
-              'JumpCloud.SDK.V2'                      = @{Repository = 'PSGallery'; RequiredVersion = '0.1.1'}
-              'JumpCloud.SDK.DirectoryInsights'       = @{Repository = 'PSGallery'; RequiredVersion = '0.1.1'}
+              'JumpCloud.SDK.V1'                      = @{Repository = 'PSGallery'; RequiredVersion = 'latest'}
+              'JumpCloud.SDK.V2'                      = @{Repository = 'PSGallery'; RequiredVersion = 'latest'}
+              'JumpCloud.SDK.DirectoryInsights'       = @{Repository = 'PSGallery'; RequiredVersion = 'latest'}
               'powershell-yaml'                       = @{Repository = 'PSGallery'; RequiredVersion = '0.4.7'}
           }
 
           foreach ($RequiredModule in $PSDependencies.Keys) {
-              If ([System.String]::IsNullOrEmpty((Get-InstalledModule | Where-Object { $_.Name -eq $RequiredModule }))) {
-                  Write-Host("[status]Installing module: '$RequiredModule'; version: $($PSDependencies[$RequiredModule].RequiredVersion) from $($PSDependencies[$RequiredModule].Repository)")
-                  if ($($PSDependencies[$RequiredModule].RequiredVersion) -eq "latest"){
-                    Install-Module -Name $RequiredModule -Repository:($($PSDependencies[$RequiredModule].Repository)) -AllowPrerelease -Force
-                  } else {
-                    Install-Module -Name $RequiredModule -Repository:($($PSDependencies[$RequiredModule].Repository)) -RequiredVersion:($($PSDependencies[$RequiredModule].RequiredVersion)) -AllowPrerelease -Force
-                  }
+              $spec = $PSDependencies[$RequiredModule]
+              $requiredVersion = $spec.RequiredVersion
+              $repository = $spec.Repository
+              if ($requiredVersion -eq 'latest') {
+                  Write-Host "[status]Installing latest '$RequiredModule' from $repository"
+                  Install-Module -Name $RequiredModule -Repository $repository -AllowPrerelease -Force
+                  continue
+              }
+              if ([System.String]::IsNullOrEmpty((Get-InstalledModule | Where-Object { $_.Name -eq $RequiredModule }))) {
+                  Write-Host "[status]Installing module: '$RequiredModule'; version: $requiredVersion from $repository"
+                  Install-Module -Name $RequiredModule -Repository $repository -RequiredVersion $requiredVersion -AllowPrerelease -Force
               }
           }
 
@@ -207,6 +212,7 @@ jobs:
               Set-Variable -Name $_.Name -Value $_.Value -Scope Global
             }
           }
+          Set-Variable -Name PesterParams_Org -Value "$env:PESTER_ORGID" -Scope Global
           Set-Variable -Name PesterParams_ApiKey -Value "$env:PESTER_APIKEY" -Scope Global
           Set-Variable -Name PesterParams_EU_ApiKey -Value "$env:PESTER_EU_APIKEY" -Scope Global
           Set-Variable -Name PesterParams_EU_OrgID -Value "$env:PESTER_EU_ORGID" -Scope Global
@@ -235,10 +241,11 @@ jobs:
       - shell: pwsh
         env:
           PESTER_APIKEY: ${{ secrets.PESTER_APIKEY }}
-          PESTER_ORGID: ${{ secrets.PESTER_ORGID }}
+          PESTER_ORGID: ${{ secrets.PESTER_MSP_ORGID }}
           PESTER_MSP_APIKEY: ${{ secrets.PESTER_MSP_APIKEY }}
           PESTER_PROVIDER_ID: ${{ secrets.PESTER_PROVIDER_ID }}
         run: |
           Set-Variable -Name PesterParams_ApiKeyMsp -Value "$env:PESTER_MSP_APIKEY" -Scope Global
+          Set-Variable -Name PESTER_ORGID -Value "$env:PESTER_MSP_ORGID" -Scope Global
 
           . "./PowerShell/JumpCloud Module/Tests/InvokePester.ps1" -JumpCloudApiKeyMsp "$env:PESTER_MSP_APIKEY" -JumpCloudMspOrg "$env:PESTER_ORGID" -ProviderID "$env:PESTER_PROVIDER_ID" -RequiredModulesRepo "PSGallery" -MSP

PowerShell/Deploy/Build-Module.ps1

@@ -1,11 +1,5 @@
 [CmdletBinding()]
 param (
-    [Parameter()]
-    [String]
-    $GitSourceBranch,
-    [Parameter()]
-    [String]
-    $GitSourceRepo,
     [Parameter()]
     [String]
     $ReleaseType,
@@ -19,15 +13,15 @@ param (
     [Boolean]
     $ManualModuleVersion
 )
-. "$PSScriptRoot/Get-Config.ps1" -GitSourceBranch:($GitSourceBranch) -GitSourceRepo:($GitSourceRepo) -ReleaseType:($ReleaseType) -RequiredModulesRepo:($RequiredModulesRepo)
+. "$PSScriptRoot/Get-Config.ps1" -ModuleName:($ModuleName) -ModuleFolderName:("JumpCloud Module") -DeployFolder:("/PowerShell/Deploy")
 # Region Checking PowerShell Gallery module version
 Write-Host ('[status]Check PowerShell Gallery for module version info')
 $PSGalleryInfo = Get-PSGalleryModuleVersion -Name:($ModuleName) -ReleaseType:($RELEASETYPE) #('Major', 'Minor', 'Patch')
 # Check to see if ManualModuleVersion parameter is set to true
 if ($ManualModuleVersion) {
     $ManualModuleVersionRetrieval = Get-Content -Path:($FilePath_psd1) | Where-Object { $_ -like '*ModuleVersion*' }
     $SemanticRegex = [Regex]"[0-9]+.[0-9]+.[0-9]+"
-    $SemeanticVersion = Select-String -InputObject $ManualModuleVersionRetrieval -pattern ($SemanticRegex)
+    $SemeanticVersion = Select-String -InputObject $ManualModuleVersionRetrieval -Pattern ($SemanticRegex)
     $ModuleVersion = $SemeanticVersion[0].Matches.Value
 } else {
     $ModuleVersion = $PSGalleryInfo.NextVersion
@@ -45,7 +39,7 @@ New-JCModuleManifest -Path:($FilePath_psd1) `
 Write-Host ('[status]Updating module change log: "' + $FilePath_ModuleChangelog + '"')
 $ModuleChangelog = Get-Content -Path:($FilePath_ModuleChangelog)
 $NewModuleChangelogRecord = New-ModuleChangelog -LatestVersion:($ModuleVersion) -ReleaseNotes:('{{Fill in the Release Notes}}') -Features:('{{Fill in the Features}}') -Improvements:('{{Fill in the Improvements}}') -BugFixes('{{Fill in the Bug Fixes}}')
-If (!(($ModuleChangelog | Select-Object -First 1) -match $ModuleVersion)) {
+if (!(($ModuleChangelog | Select-Object -First 1) -match $ModuleVersion)) {
     ($NewModuleChangelogRecord + ($ModuleChangelog | Out-String)).Trim() | Set-Content -Path:($FilePath_ModuleChangelog) -Force
 }
 # EndRegion Updating module change log

PowerShell/Deploy/SdkSync/jcapiToSupportSync.ps1

@@ -25,56 +25,72 @@ $ApprovedFunctions = [Ordered]@{
         #         Destination = '/Public/Reports';
         #     }
     );
-    #'JumpCloud.SDK.V2'                = @(
-    #     [PSCustomObject]@{
-    #         Name        = 'Get-JcSdkAppleMdm';
-    #         Destination = '/Public/AppleMdm';
-    #     },
-    #     [PSCustomObject]@{
-    #         Name        = 'Remove-JcSdkAppleMdm';
-    #         Destination = '/Public/AppleMdm';
-    #     },
-    #     [PSCustomObject]@{
-    #         Name        = 'Set-JcSdkAppleMdm';
-    #         Destination = '/Public/AppleMdm';
-    #     },
-    #     [PSCustomObject]@{
-    #         Name        = 'Get-JcSdkAppleMdmCsr';
-    #         Destination = '/Public/AppleMdm';
-    #     },
-    #     [PSCustomObject]@{
-    #         Name        = 'Get-JcSdkAppleMdmDepKey';
-    #         Destination = '/Public/AppleMdm';
-    #     },
-    #     [PSCustomObject]@{
-    #         Name        = 'Clear-JcSdkAppleMdmDevice';
-    #         Destination = '/Public/AppleMdm';
-    #     },
-    #     [PSCustomObject]@{
-    #         Name        = 'Get-JcSdkAppleMdmDevice';
-    #         Destination = '/Public/AppleMdm';
-    #     },
-    #     [PSCustomObject]@{
-    #         Name        = 'Lock-JcSdkAppleMdmDevice';
-    #         Destination = '/Public/AppleMdm';
-    #     },
-    #     [PSCustomObject]@{
-    #         Name        = 'Restart-JcSdkAppleMdmDevice';
-    #         Destination = '/Public/AppleMdm';
-    #     },
-    #     [PSCustomObject]@{
-    #         Name        = 'Stop-JcSdkAppleMdmDevice';
-    #         Destination = '/Public/AppleMdm';
-    #     },
-    #     [PSCustomObject]@{
-    #         Name        = 'Sync-JcSdkAppleMdmDevice';
-    #         Destination = '/Public/AppleMdm';
-    #     },
-    #     [PSCustomObject]@{
-    #         Name        = 'Get-JcSdkAppleMdmEnrollmentProfile';
-    #         Destination = '/Public/AppleMdm';
-    #     }
-    #)
+    'JumpCloud.SDK.V2'                = @(
+        [PSCustomObject]@{
+            Name        = 'Get-JcSdkUserGroup';
+            Destination = '/Public/Groups/UserGroups';
+        },
+        [PSCustomObject]@{
+            Name        = 'Get-JcSdkSystemGroup';
+            Destination = '/Public/Groups/SystemGroups';
+        },
+        [PSCustomObject]@{
+            Name              = 'Get-JcSdkPolicyGroup';
+            Destination       = '/Public/Groups/PolicyGroups';
+            IdentityParameter = @{
+                SdkName = 'Id'
+                Aliases = @('_id', 'PolicyGroupID')
+            }
+        },
+        [PSCustomObject]@{
+            Name              = 'Get-JcSdkPolicyGroupMember';
+            Destination       = '/Public/Groups/PolicyGroups';
+            IdentityParameter = @{
+                SdkName = 'GroupId'
+                Aliases = @('PolicyGroupID')
+            }
+        },
+        [PSCustomObject]@{
+            Name        = 'Set-JcSdkUserGroup';
+            Destination = '/Public/Groups/UserGroups';
+        },
+        [PSCustomObject]@{
+            Name        = 'Set-JcSdkSystemGroup';
+            Destination = '/Public/Groups/SystemGroups';
+        },
+        [PSCustomObject]@{
+            Name              = 'Set-JcSdkPolicyGroup';
+            Destination       = '/Public/Groups/PolicyGroups';
+            IdentityParameter = @{
+                SdkName = 'Id'
+                Aliases = @('_id', 'PolicyGroupID')
+            }
+        },
+        [PSCustomObject]@{
+            Name              = 'Set-JcSdkPolicyGroupMember';
+            Destination       = '/Public/Groups/PolicyGroups';
+            IdentityParameter = @{
+                SdkName = 'GroupId'
+                Aliases = @('PolicyGroupID')
+            }
+        },
+        [PSCustomObject]@{
+            Name              = 'New-JcSdkPolicyGroup';
+            Destination       = '/Public/Groups/PolicyGroups';
+            IdentityParameter = @{
+                SdkName = 'Id'
+                Aliases = @('_id', 'PolicyGroupID')
+            }
+        },
+        [PSCustomObject]@{
+            Name              = 'Remove-JcSdkPolicyGroup';
+            Destination       = '/Public/Groups/PolicyGroups';
+            IdentityParameter = @{
+                SdkName = 'Id'
+                Aliases = @('_id', 'PolicyGroupID')
+            }
+        }
+    )
 }
 $SdkPrefix = 'JcSdk'
 $JumpCloudModulePrefix = 'JC'
@@ -147,6 +163,18 @@ if (-not [System.String]::IsNullOrEmpty($Modules)) {
                 }
                 # Extract the sections we want to copy over to our new function.
                 $PSScriptInfo = ($FunctionContent | Select-String -Pattern:([regex]'(?s)(<#)(.*?)(#>)')).Matches.Value
+                # Remove autorest/OpenAPI curl blocks (repeated under .Synopsis / .Description, etc.)
+                if (-not [System.String]::IsNullOrEmpty($PSScriptInfo)) {
+                    $PSScriptInfo = [regex]::Replace(
+                        $PSScriptInfo,
+                        '(?ms)^\s*#### Sample Request\s*\r?\n```[\s\S]*?```\s*',
+                        '')
+                    # .Link docs URL must track master, not whatever branch the SDK was built from.
+                    $PSScriptInfo = [regex]::Replace(
+                        $PSScriptInfo,
+                        '(https://github\.com/TheJumpCloud/jcapi-powershell/tree/)[^/\s\r\n]+(/)',
+                        '${1}master$2')
+                }
                 $Params = $FunctionContent | Select-String -Pattern:([regex]'(?s)(    \[Parameter)(.*?)(\})') -AllMatches
                 $ParameterContent = ($Params.Matches.Value | Where-Object { $_ -notlike '*DontShow*' -and $_ -notlike '${Limit}' -and $_ -notlike '*${Skip}*' -and $_ -notlike '*${apiHost}*' -and $_ -notlike '*${consoleHost}*' })
 
@@ -181,11 +209,61 @@ if (-not [System.String]::IsNullOrEmpty($Modules)) {
 "@
                     }
                 }
+                # Proxy/cmdlet sources sometimes emit the Param body as one long line; split attributes before Alias insert.
+                $paramString = [regex]::Replace($paramString, '(?<=\])\s{2,}(?=\[)', "`n        ")
+                $paramString = [regex]::Replace($paramString, '(?<=,)\s{2,}(?=\[Parameter)', "`n        `n        ")
+                # Optional: add [Alias(...)] on SDK identity param; if Name is set and differs from SdkName, rename ${SdkName} and splat to SDK cmdlet.
+                if ($Function.IdentityParameter -and $Function.IdentityParameter.SdkName) {
+                    $ip = $Function.IdentityParameter
+                    $sdkToken = '$' + '{' + $ip.SdkName + '}'
+                    $shouldRename = $ip.Name -and ($ip.Name -cne $ip.SdkName)
+                    if ($shouldRename) {
+                        $wrapToken = '$' + '{' + $ip.Name + '}'
+                        $paramString = $paramString.Replace($sdkToken, $wrapToken)
+                    }
+                    if ($ip.Aliases -and $ip.Aliases.Count -gt 0) {
+                        $aliasList = (($ip.Aliases | ForEach-Object { "'$_'" }) -join ', ')
+                        $aliasLine = "        [Alias($aliasList)]"
+                        $targetToken = if ($shouldRename) { '$' + '{' + $ip.Name + '}' } else { $sdkToken }
+                        $targetEscaped = [regex]::Escape($targetToken)
+                        # First Path + [System.String] + ${SdkName} only (excludes InputObject's IJumpCloudApiIdentity).
+                        $aliasBeforePathStringId = '(?s)((?:\s*\[Parameter[^\]]+\]\s*)+)(\[JumpCloud\.SDK\.V2\.Category\(''Path''\)\]\s*\[System\.String\]\s*(?:#[^\r\n]*)?\s*' + $targetEscaped + ')'
+                        $alreadyAliased = [regex]::Match($paramString, '(?s)\[Parameter[^\]]+\]\s*\[Alias\([^\]]+\)\]\s*\[JumpCloud\.SDK\.V2\.Category\(''Path''\)\]\s*\[System\.String\][\s\S]*?' + $targetEscaped).Success
+                        if (-not $alreadyAliased -and $paramString -match $aliasBeforePathStringId) {
+                            $paramString = [regex]::Replace($paramString, $aliasBeforePathStringId, "`$1`n$aliasLine`n        `$2", 1)
+                        }
+                    }
+                }
+                $identityParamRenamed = $false
+                if ($Function.IdentityParameter -and $Function.IdentityParameter.SdkName -and $Function.IdentityParameter.Name -and ($Function.IdentityParameter.Name -cne $Function.IdentityParameter.SdkName)) {
+                    $identityParamRenamed = $paramString -match ('\$\{' + [regex]::Escape($Function.IdentityParameter.Name) + '\}')
+                }
                 $OutputType = (($FunctionContent | Select-String -Pattern:([regex]'(\[OutputType)(.*?)(\]\s+)')).Matches.Value).TrimEnd()
                 $CmdletBinding = (($FunctionContent | Select-String -Pattern:([regex]'(\[CmdletBinding)(.*?)(\]\s+)')).Matches.Value).TrimEnd()
                 if (-not [System.String]::IsNullOrEmpty($PSScriptInfo)) {
                     $PSScriptInfo = $PSScriptInfo.Replace($SdkPrefix, $JumpCloudModulePrefix)
                     $PSScriptInfo = $PSScriptInfo.Replace("$NewCommandName.md", "$FunctionName.md")
+                    if ($identityParamRenamed -and $Function.IdentityParameter.SdkName) {
+                        $ip = $Function.IdentityParameter
+                        $PSScriptInfo = $PSScriptInfo.Replace("-$($ip.SdkName):(", "-$($ip.Name):(")
+                    }
+                }
+
+                $processInvocation = if ($identityParamRenamed -and $Function.IdentityParameter.SdkName -and $Function.IdentityParameter.Name) {
+                    $ip = $Function.IdentityParameter
+                    @"
+        `$SdkParams = @{}
+        foreach (`$key in `$PSBoundParameters.Keys) {
+            if (`$key -eq '$($ip.Name)') {
+                `$SdkParams['$($ip.SdkName)'] = `$PSBoundParameters[`$key]
+            } else {
+                `$SdkParams[`$key] = `$PSBoundParameters[`$key]
+            }
+        }
+        `$Results = $($ModuleName)\$($CommandName) @SdkParams
+"@
+                } else {
+                    "        `$Results = $($ModuleName)\$($CommandName) @PSBoundParameters"
                 }
 
                 # Build $BeginContent, $ProcessContent, and $EndContent
@@ -209,7 +287,7 @@ $paramString
         `$Results = @()
     }
     Process {
-        `$Results = $($ModuleName)\$($CommandName) @PSBoundParameters
+$processInvocation
     }
     End {
         Return `$Results

PowerShell/JumpCloud Module/Docs/Connect-JCOnline.md

@@ -87,7 +87,7 @@ Specific to JumpCloud development team to connect to staging dev environment. [M
 Type: System.String
 Parameter Sets: (All)
 Aliases:
-Accepted values: STANDARD, staging, EU
+Accepted values: STANDARD, STAGING, EU
 
 Required: False
 Position: 3
@@ -131,17 +131,14 @@ Accept wildcard characters: False
 ```
 
 ### CommonParameters
-
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
 
 ### System.String
-
 ## OUTPUTS
 
 ### System.Object
-
 ## NOTES
 
-## RELATED LINKS
+## RELATED LINKS

PowerShell/JumpCloud Module/Docs/Get-JCGroup.md

@@ -80,7 +80,7 @@ Note there are only two options - User and System.
 Type: System.String
 Parameter Sets: Type
 Aliases:
-Accepted values: User, System
+Accepted values: User, System, Policy
 
 Required: False
 Position: 0