🌟 [Major]: Introducing classes and removing base64 encoding

[MariusStorhaug]

Description

This pull request introduces several new classes, removes redundant functions, and refactors existing code to improve the management of contexts and their settings. The most significant changes include the addition of the Context and ContextInfo classes, the removal of Base64-related functions, and updates to the handling of context information.

Removal of Base64 encoding

Base64 encoding of names has been removed from the module for now. We want to make it more flexible for module developers, so this can be decided on the implementation of Context in your modules. However take into consideration that Secret names (from the Microsoft.PowerShell.SecretManagement module) cannot have some special characters, like [] for now.

• Removed Base64-related functions: ConvertFrom-Base64, ConvertTo-Base64, and Test-Base64 from the src/functions/private/Base64 directory. [1] [2] [3]

New Classes:

• src/classes/public/Context.ps1: Added a new Context class that includes methods for creating context objects from different sources and a method to return the context ID.
• src/classes/public/ContextInfo.ps1: Added a new ContextInfo class that includes methods for creating context info objects from different sources.

Remove ContextSetting functions:

• Removing the ContextSetting functions so that the implementer can create their own implementation. We want to push using Get-Context to get the object loaded to memory from disk, modify the object in memory (allows to modify one or more settings) and then use Set-Context to write the context object back to disk when all is done. Mantra: Work with objects.
• Removed context setting functions: Get-ContextSetting, Remove-ContextSetting, and Set-ContextSetting from the src/functions/public/ContextSetting directory. [1] [2] [3]

Refactoring:

• Made Get-ContextInfo function public src/functions/public/Get-ContextInfo.ps1.
• Drive consistency on how to identify a Context, which are now identified by their ID throughout the functions.
  • src/completers.ps1: Updated the argument completer to use ID instead of Name for context identification.
  • src/functions/public/Get-Context.ps1: Modified the Get-Context function to use ID instead of Name for context identification and added indentation to debug messages. [1] [2] [3] [4]
  • src/functions/public/Remove-Context.ps1: Updated the Remove-Context function to use ID instead of Name for context identification and made the ID parameter mandatory. [1] [2]

Configuration Updates:

• src/functions/private/Initialize-ContextVault.ps1: Set the VaultName in the script configuration after initializing and registering the vault. [1] [2]
• src/functions/private/JsonToObject/ConvertFrom-ContextJson.ps1: Added a default value for the JsonString parameter.
• src/functions/private/ObjectToJSON/Convert-ContextObjectToHashtableRecursive.ps1: Added a default value for the Object parameter.
• src/functions/private/ObjectToJSON/ConvertTo-ContextJson.ps1: Added a default value for the Context parameter.

Mistake in versioning

Before this PR there was two commits to main that created version 4.0.4 and 4.0.5 which was a mistake. Both of these were breaking changes, so they have been reverted and instead gathered into one major updated, covered in this PR.

Type of change

• 📖 [Docs]
• 🪲 [Fix]
• 🩹 [Patch]
• ⚠️ [Security fix]
• 🚀 [Feature]
• 🌟 [Breaking change]

Checklist

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas

[github-actions]

Module [Context - 5.0.0] published to the PowerShell Gallery.

[github-actions]

GitHub release for Context v5.0.0 has been created.