🚀 [Feature]: Add classes and restructure context handling

.github/linters/.powershell-psscriptanalyzer.psd1

@@ -2,10 +2,10 @@
 @{
     #CustomRulePath='path\to\CustomRuleModule.psm1'
     #RecurseCustomRulePath='path\of\customrules'
-    #Severity = @(
-    #    'Error'
-    #    'Warning'
-    #)
+    # Severity     = @(
+    #     'Error'
+    #     'Warning'
+    # )
     #IncludeDefaultRules=${true}
     ExcludeRules = @(
         'PSMissingModuleManifestField'

.github/workflows/Linter.yml

@@ -31,3 +31,4 @@ jobs:
           VALIDATE_MARKDOWN_PRETTIER: false
           VALIDATE_YAML_PRETTIER: false
           VALIDATE_GITLEAKS: false
+          VALIDATE_POWERSHELL: false # Added due to class usage in the project... TypeNotFound

src/classes/public/Config/GitHubConfig.ps1

@@ -0,0 +1,19 @@
+class GitHubConfig : Context {
+    # The access token grace period in hours.
+    [int] $AccessTokenGracePeriodInHours
+
+    # The default context.
+    [string] $DefaultContext
+
+    # The default GitHub App client ID.
+    [string] $GitHubAppClientID
+
+    # The default host name.
+    [string] $HostName
+
+    # The default OAuth app client ID.
+    [string] $OAuthAppClientID
+
+    # Simple parameterless constructor
+    GitHubConfig() {}
+}

src/classes/public/Context/GitHubContext.ps1

@@ -0,0 +1,58 @@
+class GitHubContext : Context {
+    # The GitHub Context Name.
+    # HostName/Username or HostName/AppSlug
+    # github.com/Octocat
+    [string] $Name
+
+    # The context type
+    # User / App / Installation
+    [string] $Type
+
+    # The API hostname.
+    # github.com / msx.ghe.com / github.local
+    [string] $HostName
+
+    # The API base URI.
+    # https://api.github.com
+    [string] $ApiBaseUri
+
+    # The GitHub API version.
+    # 2022-11-28
+    [string] $ApiVersion
+
+    # The authentication type.
+    # UAT / PAT / App / IAT
+    [string] $AuthType
+
+    # User ID / App ID as GraphQL Node ID
+    [string] $NodeID
+
+    # The Database ID of the context.
+    [string] $DatabaseID
+
+    # The user name.
+    [string] $UserName
+
+    # The access token.
+    [securestring] $Token
+
+    # The token type.
+    # ghu / gho / ghp / github_pat / PEM / ghs /
+    [string] $TokenType
+
+    # The default value for the Enterprise parameter.
+    [string] $Enterprise
+
+    # The default value for the Owner parameter.
+    [string] $Owner
+
+    # The default value for the Repo parameter.
+    [string] $Repo
+
+    # Simple parameterless constructor
+    GitHubContext() {}
+
+    [string] ToString() {
+        return $this.Name
+    }
+}

src/classes/public/Context/GitHubContext/AppGitHubContext.ps1

@@ -0,0 +1,18 @@
+class AppGitHubContext : GitHubContext {
+    # Client ID for GitHub Apps
+    [string] $ClientID
+
+    # Creates a context object from a hashtable of key-vaule pairs.
+    AppGitHubContext([hashtable]$Properties) {
+        foreach ($Property in $Properties.Keys) {
+            $this.$Property = $Properties.$Property
+        }
+    }
+
+    # Creates a context object from a PSCustomObject.
+    AppGitHubContext([PSCustomObject]$Object) {
+        $Object.PSObject.Properties | ForEach-Object {
+            $this.($_.Name) = $_.Value
+        }
+    }
+}

src/classes/public/Context/GitHubContext/InstallationGitHubContext.ps1

@@ -0,0 +1,25 @@
+class InstallationGitHubContext : GitHubContext {
+    # Client ID for GitHub Apps
+    [string] $ClientID
+
+    # The token expiration date.
+    # 2024-01-01-00:00:00
+    [datetime] $TokenExpirationDate
+
+    # The installation ID.
+    [int] $InstallationID
+
+    # Creates a context object from a hashtable of key-vaule pairs.
+    InstallationGitHubContext([hashtable]$Properties) {
+        foreach ($Property in $Properties.Keys) {
+            $this.$Property = $Properties.$Property
+        }
+    }
+
+    # Creates a context object from a PSCustomObject.
+    InstallationGitHubContext([PSCustomObject]$Object) {
+        $Object.PSObject.Properties | ForEach-Object {
+            $this.($_.Name) = $_.Value
+        }
+    }
+}

src/classes/public/Context/GitHubContext/UserGitHubContext.ps1

@@ -0,0 +1,38 @@
+class UserGitHubContext : GitHubContext {
+    # The authentication client ID.
+    # Client ID for UAT
+    [string] $AuthClientID
+
+    # The device flow type.
+    # GitHubApp / OAuthApp
+    [string] $DeviceFlowType
+
+    # The scope when authenticating with OAuth.
+    # 'gist read:org repo workflow'
+    [string] $Scope
+
+    # The token expiration date.
+    # 2024-01-01-00:00:00
+    [datetime] $TokenExpirationDate
+
+    # The refresh token.
+    [securestring] $RefreshToken
+
+    # The refresh token expiration date.
+    # 2024-01-01-00:00:00
+    [datetime] $RefreshTokenExpirationDate
+
+    # Creates a context object from a hashtable of key-vaule pairs.
+    UserGitHubContext([hashtable]$Properties) {
+        foreach ($Property in $Properties.Keys) {
+            $this.$Property = $Properties.$Property
+        }
+    }
+
+    # Creates a context object from a PSCustomObject.
+    UserGitHubContext([PSCustomObject]$Object) {
+        $Object.PSObject.Properties | ForEach-Object {
+            $this.($_.Name) = $_.Value
+        }
+    }
+}

src/functions/private/Auth/Context/Resolve-GitHubContext.ps1

@@ -33,32 +33,35 @@
         $commandName = $MyInvocation.MyCommand.Name
         Write-Verbose "[$commandName] - Start"
         Write-Verbose 'Context:'
-        $Context | Out-String -Stream | ForEach-Object { Write-Verbose $_ }
+        $Context | Format-Table | Out-String -Stream | ForEach-Object { Write-Verbose $_ }
     }
 
     process {
         if ($Context -is [string]) {
             $contextName = $Context
-            Write-Debug "Getting context: [$contextName]"
+            Write-Verbose "Getting context: [$contextName]"
             $Context = Get-GitHubContext -Context $contextName
         }
 
         if (-not $Context) {
             throw "Context [$contextName] not found. Please provide a valid context or log in using 'Connect-GitHub'."
         }
 
-        switch ($Context.Type) {
-            'App' {
-                $availableContexts = Get-GitHubContext -ListAvailable |
-                    Where-Object { $_.Type -eq 'Installation' -and $_.ClientID -eq $Context.ClientID }
-                $params = Get-FunctionParameter -Scope 2
-                Write-Verbose 'Resolving parameters used in called function'
-                Write-Verbose ($params | Out-String)
-                if ($params.Keys -in 'Owner', 'Organization') {
-                    $Context = $availableContexts | Where-Object { $_.Owner -eq $params.Owner }
-                }
-            }
-        }
+        # switch ($Context.Type) {
+        #     'App' {
+        #         $availableContexts = Get-GitHubContext -ListAvailable |
+        #             Where-Object { $_.Type -eq 'Installation' -and $_.ClientID -eq $Context.ClientID }
+        #         $params = Get-FunctionParameter -Scope 2
+        #         Write-Verbose 'Resolving parameters used in called function'
+        #         Write-Verbose ($params | Out-String)
+        #         if ($params.Keys -in 'Owner', 'Organization') {
+        #             $Context = $availableContexts | Where-Object { $_.Owner -eq $params.Owner }
+        #         }
+        #     }
+        # }
+
+        Write-Verbose 'Resolved Context:'
+        $Context | Out-String -Stream | ForEach-Object { Write-Verbose $_ }
     }
 
     end {

src/functions/private/Auth/DeviceFlow/Test-GitHubAccessTokenRefreshRequired.ps1

@@ -21,12 +21,9 @@
     )
 
     $Context = Resolve-GitHubContext -Context $Context
-
-    $gitHubConfig = Get-GitHubConfig
     $tokenExpirationDate = $Context.TokenExpirationDate
     $currentDateTime = Get-Date
     $remainingDuration = [datetime]$tokenExpirationDate - $currentDateTime
 
-    # If the remaining time is less that $script:Auth.AccessTokenGracePeriodInHours then the token should be refreshed
-    $remainingDuration.TotalHours -lt $gitHubConfig.AccessTokenGracePeriodInHours
+    $remainingDuration.TotalHours -lt $script:GitHub.Config.AccessTokenGracePeriodInHours
 }

src/functions/private/Config/Initialize-GitHubConfig.ps1

@@ -0,0 +1,36 @@
+function Initialize-GitHubConfig {
+    <#
+        .SYNOPSIS
+
+        .DESCRIPTION
+
+        .EXAMPLE
+        Initialize-GitHubConfig
+    #>
+    [OutputType([void])]
+    [CmdletBinding()]
+    param ()
+
+    begin {
+        $commandName = $MyInvocation.MyCommand.Name
+        Write-Debug "[$commandName] - Start"
+    }
+
+    process {
+        try {
+            $context = [GitHubConfig](Get-Context -ID $script:GitHub.Config.ID)
+            if (-not $context) {
+                $context = Set-Context -ID $script:GitHub.Config.ID -Context $script:GitHub.Config -PassThru
+            }
+            $script:GitHub.Config = [GitHubConfig]$context
+            $script:GitHub.Initialized = $true
+        } catch {
+            Write-Error $_
+            throw 'Failed to initialize GitHub config'
+        }
+    }
+
+    end {
+        Write-Debug "[$commandName] - End"
+    }
+}