utopia-ui 3.0.60 → 3.0.62

package/dist/index.d.ts

@@ -1,37 +1,259 @@
-import * as react_jsx_runtime from '/home/fritz/workspace/utopia-os/utopia-ui/node_modules/@types/react/jsx-runtime.d.ts';
-import { UtopiaMapProps } from './types/UtopiaMapProps.js';
-export { UtopiaMapProps } from './types/UtopiaMapProps.js';
-import { LayerProps } from './types/LayerProps.js';
-export { LayerProps } from './types/LayerProps.js';
-import { ItemsApi } from './types/ItemsApi.js';
-export { ItemsApi } from './types/ItemsApi.js';
-import { Tag } from './types/Tag.js';
-export { Tag } from './types/Tag.js';
-import { Permission } from './types/Permission.js';
-export { Permission } from './types/Permission.js';
-import { Item } from './types/Item.js';
-export { Item } from './types/Item.js';
-import { AssetsApi } from './types/AssetsApi.js';
-export { AssetsApi } from './types/AssetsApi.js';
-import { UserApi } from './types/UserApi.js';
-export { UserApi } from './types/UserApi.js';
-export { UserItem } from './types/UserItem.js';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { GeoJsonObject, Geometry, Point } from 'geojson';
+import { Key } from 'react';
+import { LatLng } from 'leaflet';
+export { Popup } from 'leaflet';
+
+/**
+ * @category Types
+ */
+interface Tag {
+  color: string
+  id: string
+  name: string
+  offer_or_need?: boolean
+}
+
+interface UtopiaMapProps {
+  height?: string
+  width?: string
+  center?: [number, number]
+  zoom?: number
+  tags?: Tag[]
+  children?: React.ReactNode
+  geo?: GeoJsonObject
+  showFilterControl?: boolean
+  showLayerControl?: boolean
+  showGratitudeControl?: boolean
+  infoText?: string
+  donationWidget?: boolean
+}
 
+/**
+ * @category Map
+ */
 declare function UtopiaMap({ height, width, center, zoom, children, geo, showFilterControl, showGratitudeControl, showLayerControl, infoText, donationWidget, }: UtopiaMapProps): react_jsx_runtime.JSX.Element;
 
-declare const Layer: ({ data, children, name, menuIcon, menuText, menuColor, markerIcon, markerShape, markerDefaultColor, markerDefaultColor2, api, itemType, itemNameField, itemSubnameField, itemTextField, itemAvatarField, itemColorField, itemOwnerField, itemLatitudeField, itemLongitudeField, itemTagsField, itemOffersField, itemNeedsField, onlyOnePerOwner, customEditLink, customEditParameter, public_edit_items, listed, setItemFormPopup, itemFormPopup, clusterRef, }: LayerProps) => react_jsx_runtime.JSX.Element;
+/**
+ * @category Types
+ */
+interface ItemsApi<T> {
+  getItems(): Promise<T[]>
+  getItem?(id: string): Promise<T>
+  createItem?(item: T): Promise<T>
+  updateItem?(item: Partial<T>): Promise<T>
+  deleteItem?(id: string): Promise<boolean>
+  collectionName?: string
+}
+
+interface ItemType {
+  name: string
+  show_name_input: boolean
+  show_profile_button: boolean
+  show_start_end: boolean
+  show_start_end_input: boolean
+  show_text: boolean
+  show_text_input: boolean
+  custom_text: string
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  profileTemplate: { collection: string | number; id: Key | null | undefined; item: any }[]
+  offers_and_needs: boolean
+  icon_as_labels: unknown
+  relations: boolean
+  template: string
+  questlog: boolean
+}
+
+interface Relation {
+  related_items_id: string
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [key: string]: any
+}
+
+interface Profile {
+  id?: string
+  avatar?: string
+  color?: string
+  name: string
+  text: string
+  geoposition?: Geometry
+}
+
+/**
+ * @category Types
+ */
+interface UserItem {
+  id?: string
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  role?: any
+  email?: string
+  password?: string
+  profile?: Profile
+  first_name?: string
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  [key: string]: any
+}
+
+type TagIds = { tags_id: string }[]
+
+interface GalleryItem {
+  directus_files_id: {
+    id: number
+    width: number
+    height: number
+  }
+}
+
+/**
+ * @category Types
+ */
+interface Item {
+  id: string
+  name: string
+  text?: string
+  data?: string
+  position?: Point | null
+  date_created?: string
+  date_updated?: string | null
+  start?: string
+  end?: string
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  api?: ItemsApi<any>
+  tags?: string[]
+  layer?: LayerProps
+  relations?: Relation[]
+  parent?: string
+  subname?: string
+  public_edit?: boolean
+  slug?: string
+  user_created?: UserItem
+  image?: string
+  group_type?: string
+  offers?: TagIds
+  needs?: TagIds
+  status?: string
+  color?: string
+  markerIcon?: string
+  avatar?: string
+  new?: boolean
+  contact?: string
+  telephone?: string
+  next_appointment?: string
+  type?: ItemType
+  gallery?: GalleryItem[]
+
+  // {
+  // coordinates: [number, number]
+  /* constructor(
+    id: string,
+    name: string,
+    text: string,
+    position: Geometry,
+    layer?: LayerProps,
+    api?: ItemsApi<any>,
+  ) {
+    this.id = id
+    this.name = name
+    this.text = text
+    this.position = position
+    this.layer = layer
+    this.api = api
+  } */
+}
+
+interface ItemFormPopupProps {
+  position: LatLng
+  layer: LayerProps
+  item?: Item
+  children?: React.ReactNode
+  setItemFormPopup?: React.Dispatch<React.SetStateAction<ItemFormPopupProps | null>>
+}
+
+/**
+ * @category Types
+ */
+interface LayerProps {
+  id?: string
+  data?: Item[]
+  children?: React.ReactNode
+  name: string
+  menuIcon: string
+  menuColor: string
+  menuText: string
+  markerIcon: string
+  markerShape: string
+  markerDefaultColor: string
+  markerDefaultColor2?: string
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  api?: ItemsApi<any>
+  itemType: ItemType
+  onlyOnePerOwner?: boolean
+  customEditLink?: string
+  customEditParameter?: string
+  public_edit_items?: boolean
+  listed?: boolean
+  item_presets?: Record<string, unknown>
+  setItemFormPopup?: React.Dispatch<React.SetStateAction<ItemFormPopupProps | null>>
+  itemFormPopup?: ItemFormPopupProps | null
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  clusterRef?: any
+}
 
+/**
+ * @category Map
+ */
+declare const Layer: ({ data, children, name, menuIcon, menuText, menuColor, markerIcon, markerShape, markerDefaultColor, markerDefaultColor2, api, itemType, onlyOnePerOwner, customEditLink, customEditParameter, public_edit_items, listed, setItemFormPopup, itemFormPopup, clusterRef, }: LayerProps) => react_jsx_runtime.JSX.Element;
+
+/**
+ * @category Map
+ */
 declare function Tags({ data, api }: {
     data?: Tag[];
     api?: ItemsApi<Tag>;
 }): react_jsx_runtime.JSX.Element;
 
-declare function Permissions({ data, api, adminRole, }: {
+type PermissionAction = 'create' | 'read' | 'update' | 'delete'
+
+interface PermissionCondition {
+  user_created?: {
+    _eq: string // Erwartet den speziellen Wert "$CURRENT_USER" oder eine spezifische UUID
+  }
+  public_edit?: {
+    _eq: boolean // Erwartet den speziellen Wert "$CURRENT_USER" oder eine spezifische UUID
+  }
+}
+
+/**
+ * @category Types
+ */
+interface Permission {
+  id?: string
+  policy?: { name: string }
+  collection: string
+  action: PermissionAction
+  permissions?: {
+    // Optional, für spezifische Bedingungen wie `user_created`
+    _and: PermissionCondition[]
+  }
+}
+
+/**
+ * @category Types
+ */
+interface PermissionsProps {
     data?: Permission[];
     api?: ItemsApi<Permission>;
     adminRole?: string;
-}): react_jsx_runtime.JSX.Element;
+}
 
+/**
+ * @category Map
+ */
+declare function Permissions({ data, api, adminRole }: PermissionsProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * @category Map
+ */
 declare const ItemForm: {
     ({ children, item, title, setPopupTitle, }: {
         children?: React.ReactNode;
@@ -42,6 +264,9 @@ declare const ItemForm: {
     __TYPE: string;
 };
 
+/**
+ * @category Map
+ */
 declare const ItemView: {
     ({ children, item }: {
         children?: React.ReactNode;
@@ -50,6 +275,9 @@ declare const ItemView: {
     __TYPE: string;
 };
 
+/**
+ * @category Map
+ */
 declare const PopupTextAreaInput: ({ dataField, placeholder, style, item, }: {
     dataField: string;
     placeholder: string;
@@ -63,8 +291,14 @@ interface StartEndInputProps {
     updateStartValue?: (value: string) => void;
     updateEndValue?: (value: string) => void;
 }
+/**
+ * @category Map
+ */
 declare const PopupStartEndInput: ({ item, showLabels, updateStartValue, updateEndValue, }: StartEndInputProps) => react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Map
+ */
 declare const PopupTextInput: ({ dataField, placeholder, style, item, }: {
     dataField: string;
     placeholder: string;
@@ -72,31 +306,55 @@ declare const PopupTextInput: ({ dataField, placeholder, style, item, }: {
     item?: Item;
 }) => react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Map
+ */
 declare const PopupCheckboxInput: ({ dataField, label, item, }: {
     dataField: string;
     label: string;
     item?: Item;
 }) => react_jsx_runtime.JSX.Element;
 
-declare const TextView: ({ item, truncate, itemTextField, rawText, }: {
+/**
+ * @category Map
+ */
+declare const TextView: ({ item, itemId, text, truncate, rawText, itemTextField, }: {
     item?: Item;
+    itemId?: string;
+    text?: string;
     truncate?: boolean;
-    itemTextField?: string;
     rawText?: string;
+    itemTextField?: string;
 }) => react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Map
+ */
 declare const StartEndView: ({ item }: {
     item?: Item;
 }) => react_jsx_runtime.JSX.Element;
 
-declare const PopupButton: ({ url, parameterField, text, colorField, item, }: {
+/**
+ * @category Map
+ */
+declare const PopupButton: ({ url, parameterField, text, item, }: {
     url: string;
     parameterField?: string;
     text: string;
-    colorField?: string;
     item?: Item;
 }) => react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Types
+ */
+interface AssetsApi {
+  upload(file: Blob, title: string): Promise<{ id: string }>
+  url: string
+}
+
+/**
+ * @category AppShell
+ */
 declare function AppShell({ appName, children, assetsApi, userType, }: {
     appName: string;
     children: React.ReactNode;
@@ -111,6 +369,9 @@ type route = {
     submenu?: route;
     blank?: boolean;
 };
+/**
+ * @category AppShell
+ */
 declare function SideBar({ routes, bottomRoutes }: {
     routes: route[];
     bottomRoutes?: route[];
@@ -119,43 +380,121 @@ declare function SideBar({ routes, bottomRoutes }: {
 type ContentProps = {
     children?: React.ReactNode;
 };
+/**
+ * @category AppShell
+ */
 declare function Content({ children }: ContentProps): react_jsx_runtime.JSX.Element;
 
+/**
+ * @category AppShell
+ */
 declare const Sitemap: ({ url }: {
     url: string;
 }) => react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Types
+ */
+interface UserApi {
+  register(email: string, password: string, userName: string): Promise<void>
+  login(email: string, password: string): Promise<UserItem | undefined>
+  logout(): Promise<void>
+  getUser(): Promise<UserItem>
+  getToken(): Promise<string | null>
+  updateUser(user: UserItem): Promise<void>
+  requestPasswordReset(email: string, reset_url?: string)
+  passwordReset(token: string, new_password: string)
+}
+
 interface AuthProviderProps {
     userApi: UserApi;
     children?: React.ReactNode;
 }
+interface AuthCredentials {
+    email: string;
+    password: string;
+    otp?: string | undefined;
+}
+interface AuthContextProps {
+    isAuthenticated: boolean;
+    user: UserItem | null;
+    login: (credentials: AuthCredentials) => Promise<UserItem | undefined>;
+    register: (credentials: AuthCredentials, userName: string) => Promise<UserItem | undefined>;
+    loading: boolean;
+    logout: () => Promise<any>;
+    updateUser: (user: UserItem) => any;
+    token: string | null;
+    requestPasswordReset: (email: string, reset_url: string) => Promise<any>;
+    passwordReset: (token: string, new_password: string) => Promise<any>;
+}
+/**
+ * @category Auth
+ */
 declare const AuthProvider: ({ userApi, children }: AuthProviderProps) => react_jsx_runtime.JSX.Element;
+declare const useAuth: () => AuthContextProps;
 
+/**
+ * @category Auth
+ */
 declare function LoginPage(): react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Auth
+ */
 declare function SignupPage(): react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Auth
+ */
 declare function RequestPasswordPage({ resetUrl }: {
     resetUrl: any;
 }): react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Auth
+ */
 declare function SetNewPasswordPage(): react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Profile
+ */
 declare function UserSettings(): react_jsx_runtime.JSX.Element;
 
+declare function PlusButton({ layer, triggerAction, color, collection, }: {
+    layer?: LayerProps;
+    triggerAction: any;
+    color: string;
+    collection?: string;
+}): react_jsx_runtime.JSX.Element;
+
+/**
+ * @category Profile
+ */
 declare function ProfileView({ attestationApi }: {
     attestationApi?: ItemsApi<any>;
 }): react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Profile
+ */
 declare function ProfileForm(): react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Gaming
+ */
 declare function Modal({ children, showOnStartup, }: {
     children: React.ReactNode;
     showOnStartup?: boolean;
 }): react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Gaming
+ */
 declare function Quests(): react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Templates
+ */
 declare function CardPage({ title, hideTitle, children, parents, }: {
     title: string;
     hideTitle?: boolean;
@@ -174,8 +513,14 @@ interface TitleCardProps {
     className?: string;
     TopSideButtons?: any;
 }
+/**
+ * @category Templates
+ */
 declare function TitleCard({ title, hideTitle, children, topMargin, TopSideButtons, className, }: TitleCardProps): react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Templates
+ */
 declare function MapOverlayPage({ children, className, backdrop, card, }: {
     children: React.ReactNode;
     className?: string;
@@ -183,21 +528,36 @@ declare function MapOverlayPage({ children, className, backdrop, card, }: {
     card?: boolean;
 }): react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Templates
+ */
 declare const MoonCalendar: () => react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Templates
+ */
 declare const SelectUser: () => react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Templates
+ */
 declare const OverlayItemsIndexPage: ({ url, layerName, parameterField, plusButton, }: {
     layerName: string;
     url: string;
-    parameterField: string;
+    parameterField?: string;
     plusButton?: boolean;
 }) => react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Templates
+ */
 declare const AttestationForm: ({ api }: {
     api?: ItemsApi<unknown>;
 }) => react_jsx_runtime.JSX.Element;
 
+/**
+ * @category Templates
+ */
 declare const MarketView: () => react_jsx_runtime.JSX.Element;
 
 type TextAreaProps = {
@@ -211,6 +571,9 @@ type TextAreaProps = {
     required?: boolean;
     updateFormValue?: (value: string) => void;
 };
+/**
+ * @category Input
+ */
 declare function TextAreaInput({ labelTitle, dataField, labelStyle, containerStyle, inputStyle, defaultValue, placeholder, required, updateFormValue, }: TextAreaProps): react_jsx_runtime.JSX.Element;
 
 type InputTextProps = {
@@ -227,6 +590,9 @@ type InputTextProps = {
     required?: boolean;
     updateFormValue?: (value: string) => void;
 };
+/**
+ * @category Input
+ */
 declare function TextInput({ labelTitle, labelStyle, type, dataField, containerStyle, inputStyle, defaultValue, placeholder, autocomplete, pattern, required, updateFormValue, }: InputTextProps): react_jsx_runtime.JSX.Element;
 
 type SelectBoxProps = {
@@ -243,6 +609,9 @@ type SelectBoxProps = {
     }[];
     labelDescription?: string;
 };
+/**
+ * @category Input
+ */
 declare function SelectBox(props: SelectBoxProps): react_jsx_runtime.JSX.Element;
 
 declare global {
@@ -253,4 +622,4 @@ declare global {
     }
 }
 
-export { AppShell, AttestationForm, AuthProvider, CardPage, Content, ItemForm, ItemView, Layer, LoginPage, MapOverlayPage, MarketView, Modal, MoonCalendar, OverlayItemsIndexPage, Permissions, PopupButton, PopupCheckboxInput, PopupStartEndInput, PopupTextAreaInput, PopupTextInput, ProfileForm, ProfileView, Quests, RequestPasswordPage, SelectBox, SelectUser, SetNewPasswordPage, SideBar, SignupPage, Sitemap, StartEndView, Tags, TextAreaInput, TextInput, TextView, TitleCard, UserSettings, UtopiaMap };
+export { AppShell, type AssetsApi, AttestationForm, AuthProvider, CardPage, Content, type Item, ItemForm, ItemView, type ItemsApi, Layer, type LayerProps, LoginPage, MapOverlayPage, MarketView, Modal, MoonCalendar, OverlayItemsIndexPage, type Permission, Permissions, type PermissionsProps, PlusButton, PopupButton, PopupCheckboxInput, PopupStartEndInput, PopupTextAreaInput, PopupTextInput, ProfileForm, ProfileView, Quests, RequestPasswordPage, SelectBox, SelectUser, SetNewPasswordPage, SideBar, SignupPage, Sitemap, StartEndView, type Tag, Tags, TextAreaInput, TextInput, TextView, TitleCard, type UserApi, type UserItem, UserSettings, UtopiaMap, useAuth };