From 693e68b4f92ee7480d1f7d3153d36e6414fc7168 Mon Sep 17 00:00:00 2001 From: Ulf Gebhardt Date: Tue, 18 Feb 2025 15:28:18 +0100 Subject: [PATCH] assigne types to category types --- src/Components/Map/Permissions.tsx | 3 +++ src/types/AssetsApi.d.ts | 3 +++ src/types/Item.d.ts | 3 +++ src/types/ItemsApi.d.ts | 3 +++ src/types/LayerProps.d.ts | 3 +++ src/types/Permission.d.ts | 3 +++ src/types/Tag.d.ts | 3 +++ src/types/UserApi.d.ts | 3 +++ src/types/UserItem.d.ts | 3 +++ 9 files changed, 27 insertions(+) diff --git a/src/Components/Map/Permissions.tsx b/src/Components/Map/Permissions.tsx index ab429529..0a109bd8 100644 --- a/src/Components/Map/Permissions.tsx +++ b/src/Components/Map/Permissions.tsx @@ -7,6 +7,9 @@ import { useSetPermissionData, useSetPermissionApi, useSetAdminRole } from './ho import type { ItemsApi } from '#types/ItemsApi' import type { Permission } from '#types/Permission' +/** + * @category Types + */ export interface PermissionsProps { data?: Permission[] api?: ItemsApi diff --git a/src/types/AssetsApi.d.ts b/src/types/AssetsApi.d.ts index f2005016..7a8e9e77 100644 --- a/src/types/AssetsApi.d.ts +++ b/src/types/AssetsApi.d.ts @@ -1,3 +1,6 @@ +/** + * @category Types + */ export interface AssetsApi { upload(file: Blob, title: string): Promise<{ id: string }> url: string diff --git a/src/types/Item.d.ts b/src/types/Item.d.ts index 8723732c..4e84e992 100644 --- a/src/types/Item.d.ts +++ b/src/types/Item.d.ts @@ -15,6 +15,9 @@ interface GalleryItem { } } +/** + * @category Types + */ export interface Item { id: string name: string diff --git a/src/types/ItemsApi.d.ts b/src/types/ItemsApi.d.ts index 54553c1e..e20b2ed8 100644 --- a/src/types/ItemsApi.d.ts +++ b/src/types/ItemsApi.d.ts @@ -1,3 +1,6 @@ +/** + * @category Types + */ export interface ItemsApi { getItems(): Promise getItem?(id: string): Promise diff --git a/src/types/LayerProps.d.ts b/src/types/LayerProps.d.ts index fef17678..e1b94b8b 100644 --- a/src/types/LayerProps.d.ts +++ b/src/types/LayerProps.d.ts @@ -3,6 +3,9 @@ import type { ItemFormPopupProps } from './ItemFormPopupProps' import type { ItemsApi } from './ItemsApi' import type { ItemType } from './ItemType' +/** + * @category Types + */ export interface LayerProps { id?: string data?: Item[] diff --git a/src/types/Permission.d.ts b/src/types/Permission.d.ts index 57067fee..871558a2 100644 --- a/src/types/Permission.d.ts +++ b/src/types/Permission.d.ts @@ -1,6 +1,9 @@ import type { PermissionAction } from './PermissionAction' import type { PermissionCondition } from './PermissionCondition' +/** + * @category Types + */ export interface Permission { id?: string policy?: { name: string } diff --git a/src/types/Tag.d.ts b/src/types/Tag.d.ts index 1dc7c5a9..0999d7cd 100644 --- a/src/types/Tag.d.ts +++ b/src/types/Tag.d.ts @@ -1,3 +1,6 @@ +/** + * @category Types + */ export interface Tag { color: string id: string diff --git a/src/types/UserApi.d.ts b/src/types/UserApi.d.ts index 6c36cd4e..a35e079d 100644 --- a/src/types/UserApi.d.ts +++ b/src/types/UserApi.d.ts @@ -1,5 +1,8 @@ import type { UserItem } from './UserItem' +/** + * @category Types + */ export interface UserApi { register(email: string, password: string, userName: string): Promise login(email: string, password: string): Promise diff --git a/src/types/UserItem.d.ts b/src/types/UserItem.d.ts index 1d28817e..68ccb8d7 100644 --- a/src/types/UserItem.d.ts +++ b/src/types/UserItem.d.ts @@ -1,5 +1,8 @@ import type { Profile } from './Profile' +/** + * @category Types + */ export interface UserItem { id?: string // eslint-disable-next-line @typescript-eslint/no-explicit-any