<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **New Features**
- Added comprehensive activation code customization service with dynamic
theming, partner branding, and UI updates.
- Introduced new GraphQL types and public queries for activation code,
partner info, and theme data.
- Implemented new web UI stores and components for activation modal,
partner logos, and theme management.
- **Improvements**
- Removed legacy activation code scripts, PHP components, and plugin
references, streamlining activation logic.
- Enhanced configuration and environment support for activation and
theming features.
- Improved error handling, validation, and type safety in activation and
customization modules.
- **Bug Fixes**
- Fixed color code validation and path handling in customization
service.
- **Chores**
- Added pre-commit linting hooks and related configuration.
- Cleaned up test and development environment files.
- **Tests**
- Added extensive tests covering activation customization service
initialization, data handling, and file modifications.
- Removed obsolete tests related to legacy activation code store.
- **Refactor**
- Migrated activation and partner branding logic from legacy scripts and
PHP to TypeScript services and GraphQL resolvers.
- Reorganized store and component architecture for activation-related
features.
- **Style**
- Updated UI components for improved branding, theming, accessibility,
and layout consistency.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: Zack Spear <hi@zackspear.com>
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **New Features**
- Introduced comprehensive testing utilities for Vue components
utilizing the composition API.
- Enhanced testing coverage for the `DownloadApiLogs` and `KeyActions`
components, ensuring robust functionality and user interaction
validation.
- Added mock implementations for various libraries and components to
facilitate isolated unit testing.
- Improved flexibility in the `DummyServerSwitcher` component's input
handling.
- Added a new test setup file to configure the testing environment for
Vue applications.
- Added new test files for `AuthComponent` and `KeyActions` with
comprehensive test cases.
- Introduced a new mock implementation for UI components to streamline
testing.
- Added a new mock implementation for the `useRequest` composable to
prevent hanging issues during tests.
- Added a new mock implementation for the server store used by the Auth
component.
- **Bug Fixes**
- Improved sanitization process to block inline styles for a safer and
more consistent display.
- **Documentation**
- Added README documentation for Vue Component Testing Utilities,
detailing usage and examples.
- Updated ESLint configuration to ignore coverage directory files.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: mdatelle <mike@datelle.net>
Co-authored-by: Eli Bosley <ekbosley@gmail.com>
For now just used in Dev Mode to help assist in testing webgui CSS
changes.
- Introduced a new `UnraidThemeSwitcher` component to allow users to
change themes dynamically.
- Updated `nuxt.config.ts` to register the new component.
- Created `ThemeSwitcher.ce.vue` with functionality to handle theme
changes and update the UI accordingly.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **New Features**
- Introduced a theme switcher, allowing users to easily swap between
available application themes.
- Expanded the configuration to register the new theme switcher as a
custom element for seamless integration.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **Style**
- Updated CSS file paths across multiple components to reference assets
absolutely, ensuring consistent and reliable styling across the user
interface.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **New Features**
- Introduced a comprehensive Log Viewer accessible from the web
interface and Unraid management, allowing users to easily view, refresh,
and download log files.
- Enabled real-time log updates with auto-scroll functionality for
seamless monitoring.
- Enhanced log display with syntax highlighting and detailed file
metadata for improved readability.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Replaces the Connect Settings form at Settings > Management Access with a webcomponent containing a generated form.
CodeRabbit:
- **New Features**
- Enhanced connection settings with an updated UI, including a new
custom element `<unraid-connect-settings>`.
- Introduced several new form components (e.g., `NumberField`,
`StringArrayField`, `Select`, `Switch`, `PreconditionsLabel`,
`ControlLayout`, and `VerticalLayout`) for a more dynamic experience.
- Added a notification system with the `Toaster` component for user
feedback.
- New GraphQL operations for managing connection settings and API
updates.
- **Chores**
- Upgraded multiple backend and frontend dependencies and refined
configuration files.
- **Tests**
- Expanded test coverage for CSV conversion, form settings merging, and
the new `csvStringToArray` function.
- **Documentation**
- Added introductory documentation for form components and a readme for
the forms directory.
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **Chores**
- Updated configuration versions and connection status settings for
improved consistency.
- Restructured build and tooling processes with refined script
organization, including new commands for type checking and cleanup.
- Updated dependency management to support enhanced styling and state
management.
- Removed legacy scripts related to environment handling and CSS
utilities.
- **Refactor**
- Streamlined module imports to align with an updated theme management
structure.
- **Bug Fixes**
- Enhanced error handling in various components to provide more
informative error messages during operations.
- Improved error reporting in the update cancellation process.
- Improved error reporting in date difference calculations.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **New Features**
- Introduced enhanced project management scripts for building, testing,
and deploying the monorepo.
- Added an automated testing pipeline for improved reliability of the
Libvirt functionality.
- Provided a new plugin installation script that ensures thorough
cleanup during removal.
- **Improvements**
- Updated container mappings and dependency configurations for more
stable and efficient operations.
- Refined web application settings and build commands for smoother
performance.
- Streamlined continuous integration workflows with optimized caching
and dependency management.
- Updated allowed origins in configuration for enhanced security.
- **Chores/Refactor**
- Removed outdated configuration files to simplify maintenance and
enhance consistency.
- Enhanced event listener management in the web application for better
error handling.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **New Features**
- Introduced enhanced stepper components for smoother multi-step
interactions.
- Added new loading indicators and improved the loading experience with
customizable variants.
- **UI Improvements**
- Refreshed the global color palette and updated styling across buttons,
badges, and loading indicators for a more modern, consistent experience.
- Improved the organization and readability of templates and styles
across various components.
- **Code & Dependency Updates**
- Updated key dependencies and revised the theme and configuration
settings to improve performance and maintainability.
- Introduced new environment variables for better configuration
management.
- **Legacy Cleanup**
- Removed deprecated components and streamlined registrations to
simplify the codebase without affecting end-user functionality.
- Eliminated unused utility functions and legacy code to enhance overall
code quality.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: mdatelle <mike@datelle.net>
Co-authored-by: Eli Bosley <ekbosley@gmail.com>
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **Refactor**
- Updated the user profile’s loading indicator for a smoother visual
experience during system restart.
- **Chores**
- Improved environment-specific configurations and asset management,
streamlining production builds and deployment.
- Enhanced the development tools behavior based on the environment.
- Updated scripts for building and serving the application to align with
production settings.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: mdatelle <mike@datelle.net>
* feat: begin fixing dark mode in the webcomponents
* feat: lots of progress on colors
* feat: begin nuking alpha beta gamma
* feat: set background color on webcomponents
* fix: more color work
* feat: eliminate all alpha beta gamma variable usage
* feat: move variable declarations to theme.ts
* feat: begin fixing dark mode in the webcomponents
* feat: lots of progress on colors
* feat: begin nuking alpha beta gamma
* feat: set background color on webcomponents
* fix: more color work
* feat: eliminate all alpha beta gamma variable usage
* feat: download nodejs and install on legacy OS versions
* feat: do not move upgradepkg
* feat: array iteration for restoring files
* feat: separate install process
* feat: extract node to usr/local/
* feat: move variable declarations to theme.ts
* feat: remove nghttp3 and only bundle nodejs
* feat: validate entries correctly
* fix: upgradepkg
* feat: copy only needed files for nodejs
* fix: install syntax error
* fix: strip components from tar line
* feat: error when nodejs download fails
* feat(php): add OEM data extraction functionality
* feat(web): WIP add OEM activation modal and integrate OEM data handling
* refactor: replace oem etamology with activation
* feat(web): enhance activation modal with header and main title options
* refactor(web): update activation modal title to handle partner name conditionally
* feat: make partnerName optional in activation code data
* refactor: remove activationCodeStore from UserProfile component
* feat: integrate activation code data into server store
* feat: enhance activation code store to include callback actions and improve modal visibility logic
* refactor: remove unused theme reference from ColorSwitcher component
* fix: update partnerName in activationCodeData for clarity
* refactor: adjust gap spacing in Modal component for improved layout
* feat: enhance Activation Modal component with dynamic title and description, and add documentation buttons
* feat: implement localization for Activation Modal component titles and button texts
* feat: add new translations for activation prompts and welcome messages in the WebComponentTranslations class
* feat: implement key sequence to close Activation Modal and persist visibility state
* feat: update activation logic to conditionally activate or redeem based on activation code presence
* feat(plg): plg install / remove partner banner
* feat(plg): on install update config to enable display settings banner and on remove banner setting if no custom banner used
* fix(plg): plg remove, display banner no if no custom image
* feat(plg): implement partner banner handling and system model identification from activation JSON
* feat(web): add loading and error states to notification sidebar
* refactor(web): add container for loading & error states
* feat(web): add count labels to notification tabs
* refactor(web): lift notifications overview query to Sidebar from Indicator
* fix(web): refetch notifications for sidebar when new notifications arrive
* feat(web): move notification indicator icons to top-right of bell icon
previously, icons were placed next to bell icon because the status indicators
were not accessible to color-blind users. this commit replaces circular
status indicators with the icons.
* feat(web): remove notification indicator pulse
the pulse was initially added to provide visual feedback when:
1. a new notification arrived
2. an alert notification was unread
because we began using the legacy notify script, we now get a toast
on new notifications. re:2, feedback on the pulse was mixed, so i'm
removing it.
* refactor(plg): improve conditional for activation & partner setup
* feat(plg): add case model icon handling based on activation JSON
* feat(plg): enhance partner setup process with detailed logging and system identification updates and setup flag
* feat(plg): add setup flag file creation and logging for activation changes
* feat(plg): update activation setup flag checks for banner, case model icon, and system identity
* fix(plg): add error handling for invalid activation JSON and improve conditional checks for setup flags
* fix(plg): improve partner banner and case model icon setup logic with enhanced checks and comments
* fix(plg): update case model icon configuration to prevent newline issues in parsing
* fix(plg): remove unnecessary echo debug statements and improve setup flag handling for partner details
* fix(plg): remove unnecessary registration page check from activation code modal logic
* fix(plg): add overlay opacity prop to modal components for customizable background transparency
* fix(plg): enhance modal component with vertical centering option and adjust max-width
* fix(plg): enhance configuration handling by dynamically updating multiple header parameters in the config file
* fix(plg): improve comments and enhance setup flag handling for custom icons in activation logic
* fix(translations): correct capitalization and punctuation in user prompts for consistency
* fix(store): enhance activation code data structure with additional properties and correct partner URL reference
* fix(modal): enhance activation modal with dynamic partner logo and improved title handling
* fix(store): update activation code data structure with additional properties and correct partner details
* fix(index): refactor badge and button color handling with typed constants for improved maintainability
* fix(dependencies): add vue-tsc for improved TypeScript support in Vue projects
* refactor(plugin): remove unnecessary comments and clean up code structure
* refactor(plugin): remove todo comment for custom header logo
* fix(Modal): add partnerUrl handling for logo link and improve code structure
* fix(serverState): update partnerLogoPath to use a placeholder image for development
* feat(plugin): add rsync activation script for testing activation modal & installs
* refactor(activationCode): remove debug log for modal visibility check
* feat(plugin): enhance activation process by adding logo and case model handling
* refactor(activationCode): rename partnerLogoPath to partnerLogo and update handling for logo file type
* refactor(activationCode): remove debug log for partnerLogo watcher
* chore(nuxt.config): add ignore rule for webGui images directory
* refactor(plugin): rename params array to DISPLAY_PARAMS and update handling for configuration updates
* fix(web): partner logo handling for themes
* fix(plg): activation oem, custom case icon cfg handling
* fix(plugin): replace sed with awk for config file updates in DISPLAY_PARAMS handling
* fix(web): add target and rel attributes to partner logo link for security
* feat(plugin): add theme parameter to DISPLAY_PARAMS and activation code interface
* fix(plugin): replace sed with parameter expansion and awk for config file updates
* fix(plugin): reboot logic for plg install to prevent settings overwrite
* feat(plugin): streamline activation and partner setup by abstracting scripts for better maintainability
* fix(plugin): update script source paths for activation and partner setup
* fix(plugin): update script source paths for activation and partner setup to use relative paths
* fix(plugin): update script source paths for activation and partner setup to use absolute paths
* fix(plugin): add debug mode support to activation scripts and update setup flag handling
* fix(plugin): enhance activation scripts with debug mode and conditional execution for safety
* refactor(plugin): reposition execution of activation_code setup / remove scripts
* fix(plugin): add checks for activation_code_setup script existence and improve deletion logging
* fix(plugin): add option to remove setup flag after script execution
* fix(plugin): streamline activation script execution by removing unnecessary checks
* fix(plugin): remove duplicate activation_code_setup script sourcing
* feat(modal): add overlay color prop and enhance class binding for modal background
* feat(activation): update modal overlay color and opacity
* feat(plg): add WebComponentsExtractor class for managing JS file retrieval
* feat(plugin): myservers1.phpintegrate WebComponentsExtractor for dynamic script tag generation
* feat(activation): enhance getData method to support JSON output and add getDataForHtmlAttr for HTML-safe JSON
* refactor(activation): simplify getData method by removing parameters
* feat(plugin): add welcome-modal.php for displaying server state and web components
* refactor(web): activation code store rename modal visibility variables for clarity
* feat(web): add WelcomeModal component for user onboarding and server setup
* feat(plugin): activation_code setup and remove script support welcome modal
* refactor(plugin): streamline activation code setup script by removing some comments
* fix(plugin): update activation code setup script to prepend items to auth request allow list array
* feat: enhance ActivationCodeExtractor with partner logo handling and metadata extraction
- Added constants for document root and web GUI images directory.
- Introduced properties for partner name, URL, logo path, and logo file type.
- Implemented methods to retrieve partner logo path, render logo string, partner name, and URL.
- Enhanced data extraction logic to include partner-related information from JSON data.
- Added debug method for outputting internal state for troubleshooting.
* refactor: update activation-data.php to include debug output for ActivationCodeExtractor
- Removed JSON response and replaced it with a debug output wrapped in <pre> tags.
- This change allows for easier troubleshooting by displaying internal state information directly on the page.
* feat: inject partner logo into DefaultPageLayout and update JS file paths
- Modified the activation code setup script to change the path of JavaScript files to be relative to the web GUI's webroot.
- Added functionality to inject a partner logo into the DefaultPageLayout by replacing the existing logo string.
- Implemented a conditional backup mechanism for the DefaultPageLayout file before making changes.
- Included debug output to confirm successful injection or report errors during the process.
* feat: add partner logo display functionality and style adjustments
- Introduced a new file for displaying the partner logo, which retrieves the logo and URL based on the activation code.
- Added CSS styles to adjust the display properties of the partner logo in the header, ensuring proper sizing and alignment.
- Enhanced the integration of the partner logo into the existing plugin structure.
* refactor: simplify partner logo injection debug output in activation code setup script
- Removed syntax check for the DefaultPageLayout file after injecting the partner logo.
- Streamlined debug output to confirm successful injection without additional checks, enhancing clarity and reducing complexity.
* style: adjust partner logo height in myservers1.php
* style: update partner logo width in PartnerLogoImg.vue
- Changed the CSS class for the partner logo image from a max height constraint to a fixed width of 72 units, ensuring better responsiveness and alignment in the layout.
* fix: update modal title attribute for conditional close behavior
- Modified the title attribute of the modal overlay to conditionally display the close instruction based on the showCloseX property. This change improves accessibility by ensuring the title is only set when the close button is visible.
* refactor: update partner logo handling in activation code scripts and extractor
- Changed the partner logo file name to 'partner-logo.svg' in ActivationCodeExtractor.
- Simplified logo path handling by removing unnecessary file type checks and directly using the SVG file.
- Updated CSS in myservers1.php to target only the SVG logo.
- Modified activation code setup and removal scripts to consistently reference the SVG logo, improving clarity and maintainability.
* feat: enhance activation code setup script to include server name handling
- Added logic to retrieve and set the server name from the activation JSON if the current system model or comment is not set, or if the current name is "Tower".
- Improved debug output to include the partner server name, enhancing visibility during the activation process.
- Sanitized the partner server name to remove quotes and backslashes for better handling.
* feat: validate activation JSON before proceeding with setup
- Added validation for the activation JSON file to ensure it is correctly formatted before executing the setup process.
- Enhanced debug output to indicate whether the JSON is valid or not, improving troubleshooting capabilities.
- The setup will now only proceed if the activation JSON is confirmed to be valid, preventing potential errors during execution.
* fix(plg): improve warning message for invalid activation JSON in setup script
* feat: enhance activation code handling with partner logo integration
- Added a new optional property 'partnerLogo' to the ActivationCodeExtractor class and updated related interfaces to support boolean values for logo display.
- Removed the PNG logo reference from the activation code setup script, streamlining the logo handling process.
- Updated the server state to utilize the new 'partnerLogo' property, ensuring consistent logo display logic across the application.
- Adjusted computed properties in the activation code store to reflect the changes in logo handling, improving clarity and maintainability.
* fix: correct activation JSON validation in setup script
- Updated the activation code setup script to use 'jq empty' for validating the activation JSON file, ensuring proper error handling and validation.
- This change improves the robustness of the setup process by accurately checking the JSON format before proceeding.
* fix: correct comment formatting in dynamix.unraid.net.plg
- Fixed a formatting issue in the comment regarding the use of myservers.cfg values to prevent conflicts during installation. This change improves code readability and clarity.
* chore: update rsync activation script comments for clarity
- Revised comments in the rsync-activation-dir.sh script to better describe its purpose and usage.
- Enhanced documentation with an example usage to improve user understanding of the script's functionality.
* refactor: clean up activation data and extractor files
- Removed outdated copyright comments from activation-data.php and activation-code-extractor.php for improved readability.
- Simplified the debug output in activation-data.php by using short PHP tags.
- Updated the comment in the ActivationCodeExtractor class to be more concise, enhancing clarity for future developers.
* fix: remove unnecessary CSS properties in myservers1.php
- Eliminated redundant display and margin properties from the CSS in myservers1.php to streamline the styling and improve code clarity.
* refactor: streamline WebComponentsExtractor class and update method names
- Removed outdated copyright comments from web-components-extractor.php for improved readability.
- Renamed method getJsFileUrl() to getJSFileRelativePath() to enhance clarity and consistency in naming conventions.
- Adjusted indentation for better code formatting and readability.
* refactor: simplify partner logo handling in activation code script
- Removed unnecessary variable initialization and included only essential requires for improved clarity.
- Streamlined the code in partner-logo.php to focus on the core functionality of displaying the partner logo.
- Enhanced maintainability by reducing complexity in the script.
* refactor: clean up activation and server state files
- Removed outdated copyright comments and unnecessary variable initializations from activation-data.php and server-state.php for improved readability.
- Streamlined the code by eliminating redundant require statements, focusing on essential functionality.
- Enhanced maintainability and clarity by simplifying the structure of both files.
* feat: add password creation prompts to translations
- Introduced new translation strings for password creation in both PHP and JSON files.
- Enhanced user guidance by providing detailed messages about the importance of the password for system access and management.
- Improved overall user experience by ensuring clarity in the password setup process.
* refactor: update activation code setup script comments
* refactor: enhance activation code removal script functionality
- Updated the activation code removal script to delete additional related files, including PHP and setup scripts, for a more thorough cleanup.
- Improved comments for clarity on script usage and options, particularly regarding the self-delete functionality.
- Streamlined the deletion process by using an array to manage files to be removed, enhancing maintainability and readability.
* fix: update WelcomeModal to disable close button
* refactor: reorganize activation code setup and improve script clarity
- Moved the activation and partner setup section to follow the web component timestamp check to ensure correct targeting during setup.
- Updated comments for better clarity regarding the activation code setup process.
- Retained the warning message about not closing the window yet for user guidance.
* refactor: enhance activation code setup script with improved comments and logic
- Updated comments to clarify the purpose of server name, model, and description checks.
- Modified conditional logic to include additional checks for server identification.
- Added a TODO note regarding the necessity of updating the ident.cfg file, ensuring future review for potential optimizations.
* refactor: update activation code scripts to use .done flag
* refactor: introduce constant for activation modal storage key
- Added a new constant for the activation code modal hidden storage key to improve code maintainability and clarity.
- Updated the activation code store to utilize the new constant, replacing hardcoded string references.
* feat: enhance user onboarding and modal components
- Added new translation strings for activating Unraid licenses and creating Unraid.net accounts to improve user onboarding experience.
- Updated the WelcomeModal and Activation Modal components to reflect new messaging and improved styling options, including the ability to disable shadows.
- Implemented a workaround in the WelcomeModal to address font-size inconsistencies between login and authenticated pages.
- Refactored the index page to correctly pass server data to the WelcomeModal component.
* chore: comment out WelcomeModalCe component for testing
* feat: add disableOverlayClose prop to Modal and WelcomeModal components
- Introduced a new prop `disableOverlayClose` to the Modal component, allowing users to prevent closing the modal by clicking on the overlay.
- Updated the WelcomeModal component to utilize the new `disableOverlayClose` prop, enhancing modal behavior customization.
* refactor: update activation code removal script to delete by default
- Changed the activation code removal script to use a dry-run flag instead of a self-delete flag, enhancing safety during execution.
- Updated the plugin file to reflect the removal of the --delete option, ensuring consistency with the new script behavior.
---------
Co-authored-by: Eli Bosley <ekbosley@gmail.com>
Co-authored-by: Pujit Mehrotra <pujit@lime-technology.com>
