🌟[Major]: Domeneshop API capabilities now available

.github/workflows/Process-PSModule.yml

@@ -27,6 +27,6 @@ permissions:
 
 jobs:
   Process-PSModule:
-    uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@205d193f34cbbaf9992955c21d842bcf98a1859f # v5.4.6
+    uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@da180bac16b13bfbcdf08b2e4e221b5b49e5ff28 # v6.1.4
     secrets:
       APIKEY: ${{ secrets.APIKEY }}

README.md

@@ -1,69 +1,27 @@
-# {{ NAME }}
+# Domeneshop
 
-{{ DESCRIPTION }}
+Domeneshop is a PowerShell module for interacting with the Domeneshop API.
 
-## Prerequisites
+## Status
 
-This uses the following external resources:
-- The [PSModule framework](https://github.com/PSModule/Process-PSModule) for building, testing and publishing the module.
+The module provides a pre-1.0 API for storing Domeneshop credentials and working with domains, DNS records, HTTP forwards, dynamic DNS, and invoices. Command names and parameters may change before v1.0.0.
 
 ## Installation
 
-To install the module from the PowerShell Gallery, you can use the following command:
-
-```powershell
-Install-PSResource -Name {{ NAME }}
-Import-Module -Name {{ NAME }}
-```
-
-## Usage
-
-Here is a list of example that are typical use cases for the module.
-
-### Example 1: Greet an entity
-
-Provide examples for typical commands that a user would like to do with the module.
-
-```powershell
-Greet-Entity -Name 'World'
-Hello, World!
-```
-
-### Example 2
-
-Provide examples for typical commands that a user would like to do with the module.
-
 ```powershell
-Import-Module -Name PSModuleTemplate
+Install-PSResource -Name Domeneshop
+Import-Module -Name Domeneshop
 ```
 
-### Find more examples
-
-To find more examples of how to use the module, please refer to the [examples](examples) folder.
+## Commands
 
-Alternatively, you can use the Get-Command -Module 'This module' to find more commands that are available in the module.
-To find examples of each of the commands you can use Get-Help -Examples 'CommandName'.
+- [Authentication](src/functions/public/Auth/Auth.md): Store credentials and select a default context.
+- [Domains](src/functions/public/Domains/Domains.md): List domains or retrieve one by ID.
+- [DNS](src/functions/public/Dns/Dns.md): List, add, update, and remove DNS records.
+- [HTTP forwards](src/functions/public/Forwards/Forwards.md): List, add, update, and remove forwards.
+- [Dynamic DNS](src/functions/public/Ddns/Ddns.md): Update a hostname with a supplied or detected address.
+- [Invoices](src/functions/public/Invoices/Invoices.md): List invoices or retrieve one by ID.
 
 ## Documentation
 
-Link to further documentation if available, or describe where in the repository users can find more detailed documentation about
-the module's functions and features.
-
-## Contributing
-
-Coder or not, you can contribute to the project! We welcome all contributions.
-
-### For Users
-
-If you don't code, you still sit on valuable information that can make this project even better. If you experience that the
-product does unexpected things, throw errors or is missing functionality, you can help by submitting bugs and feature requests.
-Please see the issues tab on this project and submit a new issue that matches your needs.
-
-### For Developers
-
-If you do code, we'd love to have your contributions. Please read the [Contribution guidelines](CONTRIBUTING.md) for more information.
-You can either help by picking up an existing issue or submit a new one if you have an idea for a new feature or improvement.
-
-## Acknowledgements
-
-Here is a list of people and projects that helped this project in some way.
+Each public command includes PowerShell help. After importing the module, run `Get-Help <CommandName> -Full` for parameter details and examples.

src/functions/private/Auth/Get-DomeneshopConfig.ps1

@@ -0,0 +1,51 @@
+#Requires -Modules @{ ModuleName = 'Context'; ModuleVersion = '8.1.6' }
+
+function Get-DomeneshopConfig {
+    <#
+        .SYNOPSIS
+        Get the Domeneshop module configuration.
+
+        .DESCRIPTION
+        Read the module configuration from the Context vault or return an in-memory default when no configuration has been stored.
+
+        .EXAMPLE
+        Get-DomeneshopConfig
+
+        Get the current Domeneshop module configuration.
+
+        .INPUTS
+        None
+
+        You can't pipe objects to Get-DomeneshopConfig.
+
+        .OUTPUTS
+        System.Object
+
+        The stored or default Domeneshop module configuration.
+
+        .NOTES
+        This read helper does not create or update Context vault entries.
+
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Auth/Get-DomeneshopContext
+
+        .LINK
+        https://psmodule.io/Context/
+    #>
+    [OutputType([object])]
+    [CmdletBinding()]
+    param()
+
+    $vault = 'Domeneshop'
+    $id = '__Domeneshop.Config'
+    $config = Get-Context -ID $id -Vault $vault
+
+    if (-not $config) {
+        $config = [pscustomobject][ordered]@{
+            DefaultContext = $null
+            ApiBaseUri     = 'https://api.domeneshop.no/v0'
+        }
+    }
+
+    $config
+}

src/functions/private/Auth/Resolve-DomeneshopContext.ps1

@@ -0,0 +1,55 @@
+function Resolve-DomeneshopContext {
+    <#
+        .SYNOPSIS
+        Validate a resolved Domeneshop context.
+
+        .DESCRIPTION
+        Verify that a context resolved by a public command contains the credentials and API endpoint required by private helpers.
+
+        .EXAMPLE
+        Resolve-DomeneshopContext -Context $storedContext
+
+        Validate and emit a stored Domeneshop context.
+
+        .INPUTS
+        None
+
+        You can't pipe objects to Resolve-DomeneshopContext.
+
+        .OUTPUTS
+        System.Object
+
+        The validated Domeneshop context.
+
+        .NOTES
+        This helper never selects or defaults a context. Public commands own that behavior.
+
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Auth/Get-DomeneshopContext
+
+        .LINK
+        https://psmodule.io/Context/
+    #>
+    [OutputType([object])]
+    [CmdletBinding()]
+    param(
+        # The context object selected by a public command.
+        [Parameter(Mandatory)]
+        [AllowNull()]
+        [object] $Context
+    )
+
+    if ($null -eq $Context) {
+        throw "No Domeneshop context found. Run 'Connect-DomeneshopAccount' first."
+    }
+
+    if ([string]::IsNullOrWhiteSpace([string] $Context.Token) -or -not ($Context.Secret -is [securestring])) {
+        throw "The Domeneshop context [$($Context.ID)] is missing valid credentials."
+    }
+
+    if ([string]::IsNullOrWhiteSpace([string] $Context.ApiBaseUri)) {
+        throw "The Domeneshop context [$($Context.ID)] is missing an API base URI."
+    }
+
+    $Context
+}

src/functions/private/Auth/Set-DomeneshopDefaultContext.ps1

@@ -0,0 +1,50 @@
+#Requires -Modules @{ ModuleName = 'Context'; ModuleVersion = '8.1.6' }
+
+function Set-DomeneshopDefaultContext {
+    <#
+        .SYNOPSIS
+        Set the default Domeneshop context name.
+
+        .DESCRIPTION
+        Persist the selected default context name in the Domeneshop configuration entry.
+
+        .EXAMPLE
+        Set-DomeneshopDefaultContext -Context 'production'
+
+        Set production as the default Domeneshop context.
+
+        .INPUTS
+        None
+
+        You can't pipe objects to Set-DomeneshopDefaultContext.
+
+        .OUTPUTS
+        None
+
+        Set-DomeneshopDefaultContext doesn't emit output.
+
+        .NOTES
+        Supports WhatIf and Confirm before changing the module configuration.
+
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Auth/Connect-DomeneshopAccount
+
+        .LINK
+        https://psmodule.io/Context/
+    #>
+    [OutputType([void])]
+    [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'Low')]
+    param(
+        # The name of an existing Domeneshop context.
+        [Parameter(Mandatory)]
+        [ValidateNotNullOrEmpty()]
+        [ValidateScript({ Test-DomeneshopContextName -Context $_ })]
+        [string] $Context
+    )
+
+    $config = Get-DomeneshopConfig
+    if ($PSCmdlet.ShouldProcess('Domeneshop module configuration', "Set [$Context] as the default context")) {
+        $config.DefaultContext = $Context
+        $null = Set-Context -ID '__Domeneshop.Config' -Vault 'Domeneshop' -Context $config
+    }
+}

src/functions/private/Auth/Test-DomeneshopContextName.ps1

@@ -0,0 +1,48 @@
+function Test-DomeneshopContextName {
+    <#
+        .SYNOPSIS
+        Validate a Domeneshop credential context name.
+
+        .DESCRIPTION
+        Reject names reserved for internal Domeneshop module configuration.
+
+        .EXAMPLE
+        Test-DomeneshopContextName -Context 'production'
+
+        Confirm that production can be used as a credential context name.
+
+        .INPUTS
+        None
+
+        You can't pipe objects to Test-DomeneshopContextName.
+
+        .OUTPUTS
+        System.Boolean
+
+        True when the context name is available for credentials.
+
+        .NOTES
+        Throws when the context name is reserved.
+
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Auth/Connect-DomeneshopAccount
+    #>
+    [OutputType([bool])]
+    [CmdletBinding()]
+    param(
+        # The proposed credential context name.
+        [Parameter(Mandatory)]
+        [ValidateNotNullOrEmpty()]
+        [string] $Context
+    )
+
+    if ([string]::IsNullOrWhiteSpace($Context)) {
+        throw 'Context name cannot be empty or whitespace.'
+    }
+
+    if ($Context -eq '__Domeneshop.Config') {
+        throw "Context name [$Context] is reserved for Domeneshop module configuration."
+    }
+
+    $true
+}

src/functions/private/Auth/Test-DomeneshopSecret.ps1

@@ -0,0 +1,51 @@
+function Test-DomeneshopSecret {
+    <#
+        .SYNOPSIS
+        Validate a Domeneshop API secret.
+
+        .DESCRIPTION
+        Reject unsupported and empty values before credential storage.
+
+        .EXAMPLE
+        Test-DomeneshopSecret -Secret $secret
+
+        Confirm that the secret contains a value.
+
+        .INPUTS
+        None
+
+        You can't pipe objects to Test-DomeneshopSecret.
+
+        .OUTPUTS
+        System.Boolean
+
+        True when the secret has a supported type and is not empty.
+
+        .NOTES
+        Supported values are String and SecureString.
+
+        .LINK
+        https://psmodule.io/Domeneshop/Functions/Auth/Connect-DomeneshopAccount
+    #>
+    [OutputType([bool])]
+    [CmdletBinding()]
+    param(
+        # The proposed API secret.
+        [Parameter(Mandatory)]
+        [ValidateNotNull()]
+        [object] $Secret
+    )
+
+    if ($Secret -isnot [string] -and $Secret -isnot [securestring]) {
+        throw 'Secret must be a SecureString or String value.'
+    }
+
+    if (
+        ($Secret -is [string] -and [string]::IsNullOrWhiteSpace($Secret)) -or
+        ($Secret -is [securestring] -and $Secret.Length -eq 0)
+    ) {
+        throw 'Secret cannot be empty or whitespace.'
+    }
+
+    $true
+}