utopia-ui 1.0.8 → 2.0.0

package/README.md

@@ -7,15 +7,7 @@ Check [utopia-os.org](https://utopia-os.org) for more information
 
 Utopia UI is the approach to create a Open Source Library of JavaScript Components which should bring useful maps and apps to all kind of projects and communities.
 
-
-## Map UI Component
-The Map Component based on [leaflet](https://leafletjs.com) is the crystalisation point of Utopia OS.
-
-The map shows places, events and people at their respective position whith nice and informative Popups. Tags, colors and clusters help to retain the overview.
-
-Include it somewhere in your React Application, pass some data and the required props.
-
-### Getting Started
+## Getting Started
 
 
 install via npm
@@ -23,85 +15,51 @@ install via npm
  npm install utopia-ui
 ```
 
-then import in your React App
-```jsx
-import UtopiaMap from 'utopia-ui'
-```
+## Map Component
+The map shows various Layers (places, events, profiles ...) of Irems at their respective position whith nice and informative Popups.
+
+Tags, colors and clusters help to retain the overview.
 
 use the Map UI Component
 ```jsx
-<UtopiaMap
-   height='360px'
-   width='100vw'
-   center={[51.3, 9.6]}
-   zoom={6}
-   places={places}
-   events={events}
-   tags = {tags}>
-</UtopiaMap>
+import { UtopiaMap, Layer, Tags } from 'utopia-ui'
+
+      <UtopiaMap zoom={5} height='calc(100vh - 64px)' width="100%">
+        <Layer
+          name='events'
+          menuIcon='CalendarIcon'
+          menuText='add new event'
+          menuColor='#f9a825'
+          markerIcon='calendar-days-solid'
+          markerShape='square'
+          markerDefaultColor='#777'
+          data={events} />
+        <Layer
+          name='places'
+          menuIcon='MapPinIcon'
+          menuText='add new place'
+          menuColor='#2E7D32'
+          markerIcon='circle-solid'
+          markerShape='circle'
+          markerDefaultColor='#777'
+          data={places} />
+        <Tags data={tags}></Tags>
+      </UtopiaMap>
 ```
-You can find some Sample Data (places, events, tags) for test purpose below
+You can find some Sample Data (places, events, tags) for test in the `SamleData/` folder
 
-### Sample Data
-```jsx
-const places = [{
-  "id": 51,
-  "name": "Stadtgemüse",
-  "text": "Stadtgemüse Fulda ist eine Gemüsegärtnerei in Maberzell, die es sich zur Aufgabe gemacht hat, die Stadt und seine Bewohner:innen mit regionalem, frischem und natürlich angebautem Gemüse mittels Gemüsekisten zu versorgen. Es gibt also jede Woche, von Frühjahr bis Herbst, angepasst an die Saison eine Kiste mit schmackhaftem und frischem Gemüse für euch, welche ihr direkt vor Ort abholen könnt. \r\n\r\nhttps://stadtgemuese-fulda.de",
-  "position": { "type": "Point", "coordinates": [9.632435, 50.560342] },
-  "tags": [9,13],
-},
-{
-  "id": 166,
-  "name": "Weidendom",
-  "text": "free camping",
-  "position": { "type": "Point", "coordinates": [9.438793, 50.560112] },
-  "tags": [10,11]
-}];
-
-const events = [
-  {
-    "id": 423,
-    "name": "Hackathon",
-    "text": "still in progress",
-    "position": { "type": "Point", "coordinates": [9.5, 50.62] },
-    "start": "2022-03-25T12:00:00",
-    "end": "2022-05-12T12:00:00",
-    "tags": [10]
-  }
-]
-
-const tags = [
-  {"id": 9, "name": "Gardening", "color": "#008e5b" },
-  {"id": 10, "name": "Art", "color": "#fdc60b" },
-  {"id": 11, "name": "Nature", "color": "#8cbb26"  },
-  {"id": 13, "name": "Market", "color": "#2a71b0" }
-]
 
-```
 
 ### Options
 
-
  Option         | Type              | Default      | Required   | Description 
  ---            | ---               | ---          | ---        | ---    
  `height`       | `string`          |`'400px'`     |    No      | height of the map           
  `width`        | `string`          |`'100vw'`     |    No      | width of the map
  `center`       | `LatLng`          |`[50.6, 9.5]` |    No      | initial map position           
  `zoom`         | `number`          |`10`          |    No      | initial zoom level
- `places`       | [`Item[]`](https://utopia-os.org/docs/utopia-ui/map-components/item)| `[]` | No | Array with Items           
- `events`       | [`Item[]`](https://utopia-os.org/docs/utopia-ui/map-components/item)| `[]` | No | Array with Items             
- `tags`         | [`Tag[]`](https://utopia-os.org/docs/utopia-ui/map-components/tag)  | `[]` | No | Array with Tags  
-
- ## Coming Soon
-
- * Profile UI Component
- * Market UI Component
- * Calendar UI Component
- * Friends
- * Groups
- * Tags & Colors
- * Gamification Elements
+
+
 
 ## Join the community
 

package/dist/Components/AppShell/AppShell.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+export declare function AppShell({ name, useAuth, children }: {
+    name: any;
+    useAuth: any;
+    children: any;
+}): JSX.Element;

package/dist/Components/AppShell/Content.d.ts

@@ -0,0 +1,6 @@
+import * as React from 'react';
+declare type ContentProps = {
+    children?: React.ReactNode;
+};
+export declare function Content({ children }: ContentProps): JSX.Element;
+export {};

package/dist/Components/AppShell/NavBar.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+export default function NavBar({ name, useAuth }: {
+    name: string;
+    useAuth: any;
+}): JSX.Element;

package/dist/Components/AppShell/SideBar.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+declare type route = {
+    path: string;
+    icon: JSX.Element;
+    name: string;
+    submenu?: route;
+};
+export declare function SideBar({ routes }: {
+    routes: route[];
+}): JSX.Element;
+export {};

package/dist/Components/AppShell/SidebarSubmenu.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+declare function SidebarSubmenu({ submenu, name, icon }: {
+    path: string;
+    icon: JSX.Element;
+    name: string;
+    submenu?: any | undefined;
+}): JSX.Element;
+export default SidebarSubmenu;

package/dist/Components/AppShell/index.d.ts

@@ -0,0 +1,3 @@
+export { AppShell } from "./AppShell";
+export { SideBar } from "./SideBar";
+export { Content } from "./Content";

package/dist/Components/Auth/auth.d.ts

@@ -0,0 +1,24 @@
+import React from "react";
+import { AuthCredentials, UserItem } from "@directus/sdk";
+declare type AuthProviderProps = {
+    children?: React.ReactNode;
+};
+export declare type MyUserItem = {
+    id: string;
+    first_name: string;
+    description: string;
+    email: string;
+    password: string;
+};
+declare type AuthContextProps = {
+    isAuthenticated: Boolean;
+    user: UserItem | null;
+    login: (credentials: AuthCredentials) => Promise<UserItem | undefined>;
+    loading: Boolean;
+    logout: () => void;
+    updateUser: (user: MyUserItem) => any;
+    token: String | null;
+};
+export declare const AuthProvider: ({ children }: AuthProviderProps) => JSX.Element;
+export declare const useAuth: () => AuthContextProps;
+export {};

package/dist/Components/Auth/authDirectus.d.ts

@@ -0,0 +1,30 @@
+import * as React from "react";
+declare type AuthProviderProps = {
+    directus: any;
+    children?: React.ReactNode;
+};
+declare type AuthCredentials = {
+    email: string;
+    password: string;
+    otp?: string | undefined;
+};
+export declare type MyUserItem = {
+    id: string;
+    avatar: string;
+    first_name: string;
+    description: string;
+    email: string;
+    password: string;
+};
+declare type AuthContextProps = {
+    isAuthenticated: Boolean;
+    user: MyUserItem | null;
+    login: (credentials: AuthCredentials) => Promise<MyUserItem | undefined>;
+    loading: Boolean;
+    logout: () => void;
+    updateUser: (user: MyUserItem) => any;
+    token: String | null;
+};
+export declare const AuthProviderDirectus: ({ directus, children }: AuthProviderProps) => JSX.Element;
+export declare const useAuthDirectus: () => AuthContextProps;
+export {};

package/dist/Components/Auth/index.d.ts

@@ -0,0 +1 @@
+export { AuthProviderDirectus, useAuthDirectus } from "./authDirectus";

package/dist/Components/Gaming/Modal.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+declare type ModalProps = {
+    clickAction: () => void;
+};
+export declare function Welcome1({ clickAction }: ModalProps): JSX.Element;
+export declare function Welcome2({ clickAction }: ModalProps): JSX.Element;
+export declare function Welcome3({ clickAction }: ModalProps): JSX.Element;
+export declare function Modal(): JSX.Element;
+export {};

package/dist/Components/Gaming/Quests.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function Quests(): JSX.Element;

package/dist/Components/Gaming/index.d.ts

@@ -0,0 +1,2 @@
+export { Modal } from './Modal';
+export { Quests } from './Quests';

package/dist/Components/Input/InputText.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="react" />
+declare type InputTextProps = {
+    labelTitle?: string;
+    labelStyle?: string;
+    type?: string;
+    containerStyle?: string;
+    defaultValue: string;
+    placeholder?: string;
+    updateFormValue: (value: string) => void;
+};
+declare function InputText({ labelTitle, labelStyle, type, containerStyle, defaultValue, placeholder, updateFormValue }: InputTextProps): JSX.Element;
+export default InputText;

package/dist/Components/Input/TextAreaInput.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+declare type TextAreaProps = {
+    labelTitle: string;
+    labelStyle?: string;
+    containerStyle?: string;
+    defaultValue: string;
+    placeholder?: string;
+    updateFormValue: (value: string) => void;
+};
+declare function TextAreaInput({ labelTitle, labelStyle, containerStyle, defaultValue, placeholder, updateFormValue }: TextAreaProps): JSX.Element;
+export default TextAreaInput;

package/dist/Components/Map/UtopiaMap.d.ts

@@ -1,11 +1,12 @@
 import "leaflet/dist/leaflet.css";
 import * as React from "react";
-import { Item, Tag, API, Layer, UtopiaMap as UtopiaMapProps } from "../../types";
-import "../../index.css";
+import { Item, Tag, ItemsApi, Layer, UtopiaMap as UtopiaMapProps } from "../../types";
+import "./UtopiaMap.css";
 export interface MapEventListenerProps {
     selectMode: Layer | null;
-    setSelectMode: React.Dispatch<React.SetStateAction<any>>;
+    setSelectMode: React.Dispatch<any>;
     setNewItemPopup: React.Dispatch<React.SetStateAction<any>>;
 }
+/** This is a description of the foo function. */
 declare function UtopiaMap({ height, width, center, zoom, children }: UtopiaMapProps): JSX.Element;
-export { UtopiaMap, Item, Tag, API };
+export { UtopiaMap, Item, Tag, ItemsApi };

package/dist/Components/Map/UtopiaMap.stories.d.ts

@@ -1,4 +1,3 @@
-import { ComponentMeta } from "@storybook/react";
 import { UtopiaMap } from "./UtopiaMap";
 declare const _default: ComponentMeta<typeof UtopiaMap>;
 export default _default;

package/dist/Components/Map/hooks/useItems.d.ts

@@ -1,11 +1,12 @@
 import * as React from "react";
-import { Item } from "../../../types";
+import { Item, Layer } from "../../../types";
 declare type UseItemManagerResult = ReturnType<typeof useItemsManager>;
 declare function useItemsManager(initialItems: Item[]): {
     items: Item[];
     addItem: (item: Item) => void;
     updateItem: (item: Item) => void;
     removeItem: (item: Item) => void;
+    resetItems: (layer: Layer) => void;
 };
 export declare const ItemsProvider: React.FunctionComponent<{
     initialItems: Item[];
@@ -15,4 +16,5 @@ export declare const useItems: () => Item[];
 export declare const useAddItem: () => UseItemManagerResult["addItem"];
 export declare const useUpdateItem: () => UseItemManagerResult["updateItem"];
 export declare const useRemoveItem: () => UseItemManagerResult["removeItem"];
+export declare const useResetItems: () => UseItemManagerResult["resetItems"];
 export {};

package/dist/Components/Map/index.d.ts

@@ -1,3 +1,3 @@
-export { UtopiaMap, Item, Tag, API } from './UtopiaMap';
+export { UtopiaMap, Item, Tag, ItemsApi } from './UtopiaMap';
 export { Layer } from './Layer';
 export { Tags } from "./Tags";

package/dist/Components/Profile/Settings.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import 'react-toastify/dist/ReactToastify.css';
+export declare function Settings({ useAuth }: {
+    useAuth: any;
+}): JSX.Element;

package/dist/Components/Profile/index.d.ts

@@ -0,0 +1 @@
+export { Settings } from './Settings';

package/dist/Components/TitleCard.d.ts

@@ -0,0 +1,9 @@
+import * as React from "react";
+interface TitleCardProps {
+    title: string;
+    children: React.ReactNode;
+    topMargin: string;
+    TopSideButtons?: any;
+}
+declare function TitleCard({ title, children, topMargin, TopSideButtons }: TitleCardProps): JSX.Element;
+export default TitleCard;

package/dist/Components/Typography/Subtitle.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+declare function Subtitle({ styleClass, children }: {
+    styleClass: any;
+    children: any;
+}): JSX.Element;
+export default Subtitle;

package/dist/index.d.ts

@@ -1 +1,6 @@
-export { UtopiaMap, Layer, Tags, Item, Tag, API } from './Components/Map/index';
+export { UtopiaMap, Layer, Tags, Item, Tag, ItemsApi } from './Components/Map/index';
+export { AppShell, Content, SideBar } from "./Components/AppShell";
+export { AuthProviderDirectus, useAuthDirectus } from "./Components/Auth";
+export { Settings } from './Components/Profile';
+export { Quests, Modal } from './Components/Gaming';
+import "./index.css";