KOS UI SDK Release 2.0

KOS Release Notes are official documents published with each new version of the KOS platform and its tools, including KOS Studio. They provide a clear summary of all changes delivered in a specific release.

Release Notes are essential for anyone working with the KOS ecosystem—developers, integrators, partners, and business stakeholders—because they help users quickly understand:

  • New Features: Highlights of new capabilities or tools added to the platform.
  • Enhancements: Enhancements to existing features, performance optimizations, or user experience updates.
  • Resolved Issues: Issues resolved from previous versions, helping teams track reliability improvements.
  • Breaking Changes: Changes that may affect backward compatibility or require adjustments to existing projects.
  • Known Issues: Current limitations or defects that users should be aware of, often with workarounds or planned fixes.

For developers and technical teams, KOS Release Notes are an essential guide for planning upgrades, testing new features.

KOS UI SDK – 2.0.39

Aug 16th, 2025

kos-ui-sdk

New Features

  • Canvas Matrix Color Customization: Added baseColor parameter to MatrixRenderer with RGB support and automatic gradient calculation
  • Scrolling Image Renderer: New canvas renderer for animated image scrolling with configurable direction and speed
    • Support for horizontal/vertical scrolling
    • Configurable speed and easing
    • Smooth continuous animation
  • Scrolling Text Renderer: New ScrollingTextRenderer with LED panel optimization for efficient text display
  • Color Support: Added flexible hex/RGB color support to renderers with utility functions for color conversion
  • Runtime Parameter Overrides: Support for dynamic renderer parameter changes via POST request body for all renderer types

Enhancements

  • Canvas Documentation: Added comprehensive documentation for canvas renderer system with examples
  • Type Safety: Enhanced TypeScript definitions for Matrix renderer and canvas systems
  • Scrolling Text Renderer: Enhanced multi-line text rendering with line height and layout improvements for better text display
  • Canvas Renderer: Code formatting and cleanup for ScrollingTextRenderer

kos-dispense-sdk

New Features

  • Reset Idle Timer: Added reset idle timer functionality to lifecycle hook for better timer control
  • Preflight Check Support: New onBeforeAreYouThereTimer callback for conditional “Are You There” modal display
  • Timer Rejection Policies: Added areYouThereRejectionPolicy with options:
    • pause – Pause the current timer
    • restart – Restart timer from beginning
    • none – Let timers continue
  • Timer Event Publishing: Comprehensive event publishing for:
    • /kos/dispense/{nozzlePath}/idle/timeout/
    • /kos/dispense/{nozzlePath}/are-you-there/timeout/
    • /kos/dispense/{nozzlePath}/ambient/start/
    • /kos/dispense/{nozzlePath}/attract/start/
    • /kos/dispense/{nozzlePath}/attract/resume/
  • Timer Event Handlers: New handlers in useDispenseLifecycle:
    • onIdleTimeout – Called when idle timer expires
    • onAreYouThereTimeout – Called when “Are You There” timer expires
  • Manual Timer Controls: Added to useDefaultCuiKitLifecycle:
    • pauseIdleTimer() – Pause idle countdown
    • restartIdleTimer() – Restart idle timer from full duration
    • pauseScreenTimer() – Pause ambient/attract sequence
    • restartScreenTimer() – Restart ambient/attract sequence

Enhancements

  • CUI Kit Documentation: Updated with new timer features, manual controls, and rejection policies
  • Logging Support: Added proper logging and debugging throughout timer lifecycle
  • Dependency Management: Removed timer controls from callback dependencies to prevent recreation loops
  • Memory Management: Better cleanup of timer resources and event subscriptions

Resolved Issues

  • Timer Infinite Loop: Resolved timer recreation loop that prevented idle timeouts from occurring
  • Are You There Modal: Fixed modal not closing properly when idle timeout expires
  • Timer Event Loops: Removed circular event subscriptions that caused lifecycle hooks to listen to their own published events
  • Timer Reliability: Fixed timer callbacks to prevent multiple firing per cycle using ref-based flags
  • Timer Handling: Improved timer handling and fixed pauseScreenTimer mapping for better timer control
  • Ambient Timer: Pause ambient timer when clearing areYouThere modal and during pour operations

kos-freestyle-sdk

No changes in this release

kos-ui-cli

No changes in this release

kos-nx-plugin

No changes in this release

KOS UI SDK – 2.0.34

Aug 14, 2025

kos-ui-sdk

New Features

  • Log Manager Model: Added KOS Log Manager model for runtime log level management with WebSocket support
  • HTTP Router Integration: Implemented browser router with automatic route cleanup and duplicate detection
  • Canvas Rendering System: Added comprehensive canvas rendering with video looping, sequence patterns, and completion events
  • Flow Control & Async Iterators: Enhanced event handling with advanced flow control and async iterator support
  • Future-Aware Models: Added future mixin utilities and cancellable promise support
  • Timer Management: Enhanced TimerManager and useTimer hook for flexible timer event handling
  • Log Stream Model (new in 2.0): Real-time log streaming and monitoring capabilities
  • Browser Router (new in 2.0): Automatic route management and cleanup
  • Added comprehensive JSDoc documentation for models and methods

Enhancements

  • Simplified API Types: Introduced ApiResponse<Path, Method> type alias for cleaner service definitions
  • Backpressure Management: Implemented queue handling and drop policies for better performance
  • AbortController Support: Added cancellation support to kosFetch utility
  • Feature Flag System: Added extensible feature flag resolution system for assembly models
  • Unit Conversion: Added convertWithUnits for region-aware unit conversion and formatting
  • Query Parameter Support (new in 2.0): Enhanced clientRequest with query parameter handling
  • Updated documentation for future-aware models and mixins

Resolved Issues

  • Enhanced type safety for getParent method in setupCompanionDecoratorMixin
  • Fixed import race conditions for DDK
  • Corrected header visibility logic in sendCanvasData function
  • Fixed log cancellation errors in CancellationBatch
  • Updated canvas constructors and renderer instantiation

kos-dispense-sdk

New Features

  • Generic Pour Model: Implemented generic pour model with related services and hooks
  • Pour Lifecycle Enhancement: Added onBeforePour, onBeforePourRejected, and onReturnToHome callbacks
  • Ice Agitator Integration: Added pour functionality and enhanced detail views
  • Nozzle Event Broadcasting (new in 2.0): Pour-specific event broadcasting capabilities

CUI Kit Enhancements

The CUI Kit has received significant updates to improve the developer experience and pour lifecycle management:

  • Context Management: Enhanced CuiKitWrapper to accept nozzleProps for better context propagation
    • Allows passing nozzle-specific properties directly to the CUI context
    • Improves data flow between dispense components and CUI implementations
    • Enables better customization per nozzle configuration
  • Timer Management Integration:
    • Added addTimer, removeTimer, and clearTimers functions to CUI Kit
    • Integrated timer lifecycle with navigation events
    • Added logging for timer state changes and navigation events in useCuiKit
    • Automatic timer cleanup on component unmount
  • Pour Lifecycle Hooks:
    • onBeforePour: Hook called before pour initiation, allows validation and preparation
    • onBeforePourRejected: Handler for pour rejection scenarios with reason tracking
    • onReturnToHome: Callback triggered when returning to home screen
    • handleBeforePour: Internal handler for pour preparation logic
  • Lifecycle Updates:
    • Improved lifecycle management for CUI Kit components
    • Better integration with dispense flow states
    • Enhanced error handling during pour operations
  • Documentation: Enhanced documentation for brand and beverage modules in CUI Kit

API Enhancements

  • Defensive Assembly Models: Added defensive code to assembly models for better error handling

Resolved Issues

  • Enabled brand refresh on availability
  • Fixed pour abort callback handling in usePourTarget hook
  • Updated generic pour model lifecycle
  • Fixed null value handling for timer in addTimer function
  • Updated pour strategy implementations
  • Made replace line operations async (new in 2.0)

kos-freestyle-sdk

New Features

  • Remote Tray Integration: Added remote tray model and initial summary cards for remote tray cards
  • Ice Agitator Components: Added Ice Agitator components and integrated with dashboard
  • Future Model Support: Added future mixin utilities for enhanced async operations

API Enhancements

  • Enhanced Ice Agitator: Improved detail view with additional properties and layout
  • Path Parameter Support: Added path parameter support for ice type retrieval and settings reset

Resolved Issues

  • Fixed typescript build errors with future aware models
  • Removed unused test model export
  • Updated type declarations for cartridge agitator model
  • Fixed race condition in agitation required model
  • Cleared completed queued troubles on exit

kos-ui-cli

New Features

  • Future Model Support: Added ability to add futures to existing models with generator support
  • Companion Model Mixins: Added support for companion model mixins
  • Project Defaults: Implemented project defaults and optimized project filtering
  • Named Arguments: Added comprehensive named arguments support to all generators

API Enhancements

  • Help Command Optimization: Optimized help command processing and example generation
  • Modular Architecture: Refactored kos-ui-cli with modular design
  • Metadata Structure: Updated metadata.json structure and improved logging

Resolved Issues

  • Fixed cache refresh issues on model creation
  • Enabled control pour plugin in CLI and core
  • Fixed workspace generator to run outside of workspace
  • Updated develop workflow for repository context

kos-nx-plugin

New Features

  • Modular Generator Architecture: Refactored kos-component generator with plugin handler architecture
  • Migration Support: Added migration for SDK version 2.0.0 with dependency updates
  • Theming Enhancement: Enhanced theming support with CSS variables and global styles
  • Emotion Dependencies: Added Emotion dependencies for styling in SDK updates
  • Automated Migration (new in 2.0): Complete codemod support for 1.x to 2.x migration

API Enhancements

  • Simplified Service Types: Updated generated services to use simplified type aliases
  • Future Handler Support: Enhanced future handler types and operation progress tracking
  • Project Type Support: Added support for default project types and metadata generation
  • OpenAPI Integration (new in 2.0): Added openapi-typescript for enhanced type generation

Resolved Issues

  • Fixed future handler type to include operation progress
  • Updated perform operation return type to FutureResponse
  • Enabled control pour plugin support
  • Updated app.css.template styling