From 40e7c1a4a83062cea1e8855bea612f36b3ae8057 Mon Sep 17 00:00:00 2001
From: Ferdinand Thiessen <opensource@fthiessen.de>
Date: Wed, 28 Jan 2026 18:32:22 +0100
Subject: [PATCH] feat(NcSelectUsers): export `NcSelectUsersModel` type

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>
---
 .../NcSelectUsers/NcSelectUsers.vue           | 69 +++++++++++++++----
 .../NcSelectUsers/{index.js => index.ts}      |  2 +
 src/components/index.js                       |  2 +-
 3 files changed, 58 insertions(+), 15 deletions(-)
 rename src/components/NcSelectUsers/{index.js => index.ts} (73%)

diff --git a/src/components/NcSelectUsers/NcSelectUsers.vue b/src/components/NcSelectUsers/NcSelectUsers.vue
index 8a59498314..b514dffba6 100644
--- a/src/components/NcSelectUsers/NcSelectUsers.vue
+++ b/src/components/NcSelectUsers/NcSelectUsers.vue
@@ -164,13 +164,58 @@ export default {
 ```
 </docs>
 
-<script setup>
+<script setup lang="ts">
+import type { PropType } from 'vue'
+
 import { ref, watch } from 'vue'
 import NcListItemIcon from '../NcListItemIcon/NcListItemIcon.vue'
 import NcSelect from '../NcSelect/NcSelect.vue'
 import { t } from '../../l10n.js'
 import createElementId from '../../utils/GenRandomId.js'
 
+export interface NcSelectUsersModel {
+	id: string
+
+	/**
+	 * Main display name
+	 */
+	displayName: string
+
+	/**
+	 * The user id.
+	 * Will be used to fetch the user status if not disabled.
+	 */
+	user?: string
+
+	/**
+	 * The secondary displayname (e.g. the email address).
+	 */
+	subname?: string
+
+	/**
+	 * Optional icon to use as the avatar.
+	 * Setting this will disable the automatic avatar loading.
+	 */
+	iconSvg?: string
+
+	/**
+	 * Accessible name for the icon.
+	 */
+	iconName?: string
+
+	/**
+	 * If this is a guest user.
+	 * Needed as guest users have a different API endpoint for avatar loading.
+	 */
+	isGuest?: boolean
+
+	/**
+	 * Set if this is not a regular user.
+	 * This will disable user status and avatar loading.
+	 */
+	isNoUser?: boolean
+}
+
 const props = defineProps({
 	/**
 	 * `aria-label` for the clear input button
@@ -191,12 +236,10 @@ const props = defineProps({
 	/**
 	 * Allows to customize the `aria-label` for the deselect-option button
 	 * The default is "Deselect " + optionLabel
-	 *
-	 * @type {(optionLabel: string) => string}
 	 */
 	ariaLabelDeselectOption: {
-		type: Function,
-		default: (optionLabel) => t('Deselect {option}', { option: optionLabel }),
+		type: Function as PropType<(optionLabel: string) => string>,
+		default: (optionLabel: string) => t('Deselect {option}', { option: optionLabel }),
 	},
 
 	/**
@@ -223,7 +266,7 @@ const props = defineProps({
 	 * option object unless this prop is set explicitly
 	 */
 	filterBy: {
-		type: Function,
+		type: Function as PropType<(option: NcSelectUsersModel, label: string, search: string) => boolean>,
 		default: null,
 	},
 
@@ -286,11 +329,9 @@ const props = defineProps({
 
 	/**
 	 * Array of users.
-	 *
-	 * @type {{displayName: string, user: string, subname?: string, iconSvg?: string, iconName?: string, isGuest?: boolean, isNoUser?: boolean}[]}
 	 */
 	options: {
-		type: Array,
+		type: Array as PropType<NcSelectUsersModel[]>,
 		default: () => [],
 	},
 
@@ -340,11 +381,11 @@ const avatarSize = clickableArea - 2 * gridBaseLine
 /**
  * Filter function to search users.
  *
- * @param {{subname: string}} option - The option to check
- * @param {string} label - The label of the option
- * @param {string} search - The current search string
+ * @param option - The option to check
+ * @param label - The label of the option
+ * @param search - The current search string
  */
-function localFilterBy(option, label, search) {
+function localFilterBy(option: NcSelectUsersModel, label: string, search: string) {
 	if (props.filterBy) {
 		return props.filterBy
 	}
@@ -361,7 +402,7 @@ function localFilterBy(option, label, search) {
 }
 </script>
 
-<script>
+<script lang="ts">
 /** For backward compatibility with Vue 2 */
 export default {
 	model: {
diff --git a/src/components/NcSelectUsers/index.js b/src/components/NcSelectUsers/index.ts
similarity index 73%
rename from src/components/NcSelectUsers/index.js
rename to src/components/NcSelectUsers/index.ts
index 23fcb61ba4..379dc528db 100644
--- a/src/components/NcSelectUsers/index.js
+++ b/src/components/NcSelectUsers/index.ts
@@ -3,4 +3,6 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
+export type { NcSelectUsersModel } from './NcSelectUsers.vue'
+
 export { default } from './NcSelectUsers.vue'
diff --git a/src/components/index.js b/src/components/index.js
index 313b345dcb..f70c97ec0f 100644
--- a/src/components/index.js
+++ b/src/components/index.js
@@ -87,7 +87,7 @@ export { default as NcRichText } from './NcRichText/index.js'
 export { default as NcSavingIndicatorIcon } from './NcSavingIndicatorIcon/index.js'
 export { default as NcSelect } from './NcSelect/index.js'
 export { default as NcSelectTags } from './NcSelectTags/index.js'
-export { default as NcSelectUsers } from './NcSelectUsers/index.js'
+export { default as NcSelectUsers } from './NcSelectUsers/index.ts'
 export { default as NcSettingsInputText } from './NcSettingsInputText/index.js'
 export { default as NcSettingsSection } from './NcSettingsSection/index.js'
 export { default as NcSettingsSelectGroup } from './NcSettingsSelectGroup/index.js'