Add os.showAlert() function to display information dialogs

[Copilot]

Closes #62008316-1f4f-42d5-9793-0928f77ed09a

Overview

Adds a new os.showAlert() function that displays an information/alert dialog with a single dismiss button. This complements the existing os.showConfirm() function and provides a simple way to communicate important information to users that needs to be manually dismissed.

Changes

Core Implementation

• Added ShowAlertAction and ShowAlertOptions types in BotEvents.ts with proper JSDoc documentation
• Implemented os.showAlert(options) function in AuxLibrary.ts that returns a Promise<void> which resolves when the user dismisses the alert
• Created ShowAlertModal Vue component with TypeScript, template, and CSS files that handles the alert dialog display
• Integrated the modal into PlayerApp.ts and PlayerApp.vue

API

interface ShowAlertOptions {
    /**
     * The title that should be shown on the dialog.
     */
    title: string;

    /**
     * The content of the dialog.
     */
    content: string;

    /**
     * The text that should be shown on the "Dismiss" button.
     */
    dismissText?: string;  // Defaults to "OK"
}

Usage Examples

// Basic alert
await os.showAlert({
    title: 'Alert',
    content: 'This is an important message.'
});

os.toast('Alert dismissed');

// Alert with custom button text
await os.showAlert({
    title: 'Warning',
    content: 'Please read this carefully.',
    dismissText: 'Got it'
});

Testing

• ✅ Added comprehensive unit tests in AuxLibrary.spec.ts
• ✅ All 1,798 tests pass in AuxLibrary test suite
• ✅ All 3,731 tests pass in aux-runtime test suite
• ✅ Build completes successfully
• ✅ Linter passes with no issues

Documentation

• Added JSDoc comments with @dochash, @docid, and @docname tags for automatic documentation generation
• Updated CHANGELOG.md with the new feature
• Included example usage in the JSDoc comments

The implementation follows the same architectural pattern as os.showConfirm(), ensuring consistency with the existing codebase.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• checkpoint.prisma.io
  • Triggering command: /opt/hostedtoolcache/node/20.19.5/x64/bin/node /home/REDACTED/work/casualos/casualos/node_modules/.pnpm/[email protected][email protected]/node_modules/prisma/build/child {"product":"prisma","version":"6.14.0","cli_install_type":"local","information":"","local_timestamp":"2025-10-03T17:48:21Z","project_hash":"a33db9b0","cli_path":"/home/REDACTED/work/casualos/casualos/src/aux-server/node_modules/prisma/build/index.js","cli_path_hash":"3b63eda1","endpoint":"REDACTED","disable":false,"arch":"x64","os":"linux","node_version":"v20.19.5","ci":true,"ci_name":"GitHub Actions","command":"generate","schema_providers":["cockroachdb"],"schema_preview_features":["tracing"],"schema_generators_providers":["prisma-client-js"],"cache_file":"/home/REDACTED/.cache/checkpoint-nodejs/prisma-3b63eda1","cache_duration":43200000,"remind_duration":172800000,"force":false,"timeout":5000,"unref":true,"child_path":"/home/REDACTED/work/casualos/casualos/node_modules/.pnpm/[email protected][email protected]/node_modules/prisma/build/child","client_event_id":"","previous_client_event_id":"","check_if_update_available":false} (dns block)
  • Triggering command: /opt/hostedtoolcache/node/20.19.5/x64/bin/node /home/REDACTED/work/casualos/casualos/node_modules/.pnpm/[email protected][email protected]/node_modules/prisma/build/child {"product":"prisma","version":"6.14.0","cli_install_type":"local","information":"","local_timestamp":"2025-10-03T17:48:24Z","project_hash":"5ca80110","cli_path":"/home/REDACTED/work/casualos/casualos/src/aux-server/node_modules/prisma/build/index.js","cli_path_hash":"3b63eda1","endpoint":"REDACTED","disable":false,"arch":"x64","os":"linux","node_version":"v20.19.5","ci":true,"ci_name":"GitHub Actions","command":"--config [redacted] generate","schema_providers":["sqlite"],"schema_preview_features":["tracing"],"schema_generators_providers":["prisma-client-js"],"cache_file":"/home/REDACTED/.cache/checkpoint-nodejs/prisma-3b63eda1","cache_duration":43200000,"remind_duration":172800000,"force":false,"timeout":5000,"unref":true,"child_path":"/home/REDACTED/work/casualos/casualos/node_modules/.pnpm/[email protected][email protected]/node_modules/prisma/build/child","client_event_id":"","previous_client_event_id":"","check_if_update_available":false} (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Add os.showAlert() to show an alert / info dialog with only an OK button.</issue_title>
<issue_description>We currently have os.showConfirm() which is great for asking the user if they want to do something or cancel the operation. It would be very useful to have a version of this that is just used for information / alerts where something should be communicated to the user and then manually dismissed.</issue_description>

<agent_instructions>Currently, there is no way to easily show the user an "alert" or "warning". This task is to add a new function, os.showAlert() that displays an information dialog to the user.

Implementation details

User Script Function

Function name: os.showAlert(options: ShowAlertOptions)
Parameters:

• options is a ShowAlertOptions

interface ShowAlertOptions {
    /**
     * The title that should be shown on the dialog.
     */
    title: string;

    /**
     * The content of the dialog.
     */
    content: string;

    /**
     * The text that should be shown on the "Dismiss" button.
     */
    dismissText?: string;
}

Return value: A promise that resolves when the user has dismissed the alert.
Implementation Areas:

• AuxLibrary.ts for the user script function
• AuxLibrary.spec.ts for tests for the user script function
• AuxLibraryDefinitions.def for typescript definitions for the function
• ShowAlertModal.ts for the implementation of the HTML alert modal.
• PlayerApp.vue for including the ShowAlertModal.
• (Example) ShowConfirmModal.ts for an example implementation
  </agent_instructions>

Comments on the Issue (you are @copilot in this section)

Fixes #685

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ KallynGowdy
❌ Copilot
_{You have signed the CLA already but the status is still pending? Let us recheck it.}