[PR #15097] [MERGED] Refactor: Add missing Type definitions #39346

New Issue

GiteaMirror · 2026-04-25T11:58:17-05:00

GiteaMirror commented

2026-04-25 11:58:17 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/15097
Author: @silentoplayz
Created: 6/18/2025
Status: ✅ Merged
Merged: 6/18/2025
Merged by: @tjbck

Base: dev ← Head: index-update

📝 Commits (3)

35be40c chore: add more Settings types in stores
d66285f chore: add toolIds type
3be4fb2 fix: add ?

📊 Changes

2 files changed (+43 additions, -2 deletions)

View changed files

📝 src/lib/apis/index.ts (+2 -1)
📝 src/lib/stores/index.ts (+41 -1)

📄 Description

Pull Request Checklist

Before submitting, make sure you've checked the following:

Target branch: Please verify that the pull request targets the dev branch.
Description: Provide a concise description of the changes made in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Have you written and run sufficient tests to validate the changes?
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
- BREAKING CHANGE: Significant changes that may affect compatibility
- build: Changes that affect the build system or external dependencies
- ci: Changes to our continuous integration processes or workflows
- chore: Refactor, cleanup, or other non-functional code changes
- docs: Documentation update or addition
- feat: Introduces a new feature or enhancement to the codebase
- fix: Bug fix or error correction
- i18n: Internationalization or localization changes
- perf: Performance improvement
- refactor: Code restructuring for better maintainability, readability, or scalability
- style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
- test: Adding missing tests or correcting existing tests
- WIP: Work in progress, a temporary label for incomplete or ongoing work

Changelog Entry

Description

This pull request introduces a significant number of new settings and configuration options across different parts of the application, including user settings, audio settings, global configuration, and user session permissions. These additions aim to provide more granular control and customization for users, enabling features such as model pinning, tool server integration, various UI/UX preferences, notification management, and advanced chat functionalities.
Additionally, a new property toolIds has been added to the ModelMeta interface, indicating that models can now be associated with a list of tool identifiers. This prepares the application for integrating external tools with specific models.

Added

I added the following to src/lib/stores/index.ts:

type Settings = {
+	pinnedModels?: never[];
+	toolServers?: never[];
+	detectArtifacts?: boolean;
+	showUpdateToast?: boolean;
+	showChangelog?: boolean;
+	showEmojiInCall?: boolean;
+	voiceInterruption?: boolean;
+	collapseCodeBlocks?: boolean;
+	expandDetails?: boolean;
+	notificationSound?: boolean;
+	notificationSoundAlways?: boolean;
+	stylizedPdfExport?: boolean;
+	notifications?: any;
+	imageCompression?: boolean;
+	imageCompressionSize?: any;
+	widescreenMode?: null;
+	largeTextAsFile?: boolean;
+	promptAutocomplete?: boolean;
+	hapticFeedback?: boolean;
+	responseAutoCopy?: any;
+	richTextInput?: boolean;
+	params?: any;
+	userLocation?: any;
+	webSearch?: boolean;
+	memory?: boolean;
+	autoTags?: boolean;
+	autoFollowUps?: boolean;
+	splitLargeChunks?(body: any, splitLargeChunks: any): unknown;
+	backgroundImageUrl?: null;
+	landingPageMode?: string;
+	iframeSandboxAllowForms?: boolean;
+	iframeSandboxAllowSameOrigin?: boolean;
+	scrollOnBranchChange?: boolean;
+	directConnections?: null;
+	chatBubble?: boolean;
+	copyFormatted?: boolean;

type AudioSettings = {
+	stt: any;
+	tts: any;

type Config = {
+	license_metadata: any;

type SessionUser = {
+	permissions: any;

Changed

Updated src/lib/stores/index.ts to include new types and their properties.
Updated src/lib/apis/index.ts to add toolIds to the ModelMeta interface.

Security

None (The addition of permissions in SessionUser is for feature implementation, not a direct security fix)

Breaking Changes

BREAKING CHANGE: None. All changes are additive and expand existing type definitions without altering or removing current properties.

Additional Information

These additions primarily update type definitions in src/lib/stores/index.ts to provide structured types for new features and user-configurable options.

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/open-webui/pull/15097 **Author:** [@silentoplayz](https://github.com/silentoplayz) **Created:** 6/18/2025 **Status:** ✅ Merged **Merged:** 6/18/2025 **Merged by:** [@tjbck](https://github.com/tjbck) **Base:** `dev` ← **Head:** `index-update` --- ### 📝 Commits (3) - [`35be40c`](https://github.com/open-webui/open-webui/commit/35be40c932456185c2fa381fdd4000dd6fef27b0) chore: add more Settings types in stores - [`d66285f`](https://github.com/open-webui/open-webui/commit/d66285f9268dd0efee54a283b5416582f7e3e5a9) chore: add toolIds type - [`3be4fb2`](https://github.com/open-webui/open-webui/commit/3be4fb25cd56b7b6f90dd3a5ffcdab72df5bc3c4) fix: add ? ### 📊 Changes **2 files changed** (+43 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `src/lib/apis/index.ts` (+2 -1) 📝 `src/lib/stores/index.ts` (+41 -1) </details> ### 📄 Description # Pull Request Checklist **Before submitting, make sure you've checked the following:** - [x] **Target branch:** Please verify that the pull request targets the `dev` branch. - [x] **Description:** Provide a concise description of the changes made in this pull request. - [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description. - [x] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources? - [x] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation? - [x] **Testing:** Have you written and run sufficient tests to validate the changes? - [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards? - [x] **Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following: - **BREAKING CHANGE**: Significant changes that may affect compatibility - **build**: Changes that affect the build system or external dependencies - **ci**: Changes to our continuous integration processes or workflows - **chore**: Refactor, cleanup, or other non-functional code changes - **docs**: Documentation update or addition - **feat**: Introduces a new feature or enhancement to the codebase - **fix**: Bug fix or error correction - **i18n**: Internationalization or localization changes - **perf**: Performance improvement - **refactor**: Code restructuring for better maintainability, readability, or scalability - **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.) - **test**: Adding missing tests or correcting existing tests - **WIP**: Work in progress, a temporary label for incomplete or ongoing work # Changelog Entry ### Description - This pull request introduces a significant number of new settings and configuration options across different parts of the application, including user settings, audio settings, global configuration, and user session permissions. These additions aim to provide more granular control and customization for users, enabling features such as model pinning, tool server integration, various UI/UX preferences, notification management, and advanced chat functionalities. - Additionally, a new property `toolIds` has been added to the `ModelMeta` interface, indicating that models can now be associated with a list of tool identifiers. This prepares the application for integrating external tools with specific models. ### Added I added the following to `src/lib/stores/index.ts`: ```ts type Settings = { + pinnedModels?: never[]; + toolServers?: never[]; + detectArtifacts?: boolean; + showUpdateToast?: boolean; + showChangelog?: boolean; + showEmojiInCall?: boolean; + voiceInterruption?: boolean; + collapseCodeBlocks?: boolean; + expandDetails?: boolean; + notificationSound?: boolean; + notificationSoundAlways?: boolean; + stylizedPdfExport?: boolean; + notifications?: any; + imageCompression?: boolean; + imageCompressionSize?: any; + widescreenMode?: null; + largeTextAsFile?: boolean; + promptAutocomplete?: boolean; + hapticFeedback?: boolean; + responseAutoCopy?: any; + richTextInput?: boolean; + params?: any; + userLocation?: any; + webSearch?: boolean; + memory?: boolean; + autoTags?: boolean; + autoFollowUps?: boolean; + splitLargeChunks?(body: any, splitLargeChunks: any): unknown; + backgroundImageUrl?: null; + landingPageMode?: string; + iframeSandboxAllowForms?: boolean; + iframeSandboxAllowSameOrigin?: boolean; + scrollOnBranchChange?: boolean; + directConnections?: null; + chatBubble?: boolean; + copyFormatted?: boolean; type AudioSettings = { + stt: any; + tts: any; type Config = { + license_metadata: any; type SessionUser = { + permissions: any; ``` ### Changed - Updated `src/lib/stores/index.ts` to include new types and their properties. - Updated `src/lib/apis/index.ts` to add `toolIds` to the `ModelMeta` interface. ### Security - None (The addition of `permissions` in `SessionUser` is for feature implementation, not a direct security fix) ### Breaking Changes - **BREAKING CHANGE**: None. All changes are additive and expand existing type definitions without altering or removing current properties. --- ### Additional Information - These additions primarily update type definitions in `src/lib/stores/index.ts` to provide structured types for new features and user-configurable options. ### Contributor License Agreement By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2026-04-25 11:58:17 -05:00

GiteaMirror closed this issue

2026-04-25 11:58:17 -05:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/open-webui#39346