utopia-ui 1.0.7 → 2.0.0

package/LICENSE.md

@@ -0,0 +1,5 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,19 +1,13 @@
-# Utopia UI
-Reuseable React Components to build mapping apps for all kinds of communities with focus of real life action, local connection and positiv impact.
+# Utopia UI [![npm version](https://img.shields.io/npm/v/utopia-ui.svg)](https://www.npmjs.com/package/utopia-ui)
+is a UI Library to build mapping apps with focus of real life action, local connection and positiv impact.
 
 Check [utopia-os.org](https://utopia-os.org) for more information
 
-*This Library is in early alpha stage. You are very welcome to participate in the development*
-
-*A Django-based Proof of Concept can be found @ [new.docutopia.de](https://new.docutopia.de). This map can be edited freely you can register to create an account and place them on the map. The project is no longer maintained.*
-
-Utopia UI is a fully new approach to create a Open Source Library of JavaScript Components which should fit the needs of many different projects and communities. 
-
+*In early 2021, we developed a Django-based Proof of Concept, which can be found @ [new.docutopia.de](https://new.docutopia.de). This map can be edited freely you can register to create an account and place them on the map.*
 
-## Map UI Component
-Map UI is a JavaScript Map Library to create nice and easy to use Maps 
+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.
 
-### Getting Started
+## Getting Started
 
 
 install via npm
@@ -21,88 +15,56 @@ 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.
 
-use the [Map UI Component](/docs/utopia-ui/map-components/map)
+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
 
-### Options
 
 
+### 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  
-
-### 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" }
-]
 
-```
-
- ## Coming Soon
 
- * Profile UI Component
- * Market UI Component
- * Calendar UI Component
- * Friends
- * Groups
- * Tags & Colors
- * Gamification Elements
 
 ## Join the community
 
- *We are looking for Web Developer, UX Designer, Community Manager, Visionaries, Artists, etc. who like to support this Vision.*
+*This Library is in early alpha stage. You are very welcome to participate in the development*
+
+*We are looking for Web Developer, UX Designer, Community Manager, Visionaries, Artists, etc. who like to support this Vision.*
 
 [https://t.me/utopiaOS](https://t.me/utopiaOS)

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/Layer.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { Layer as LayerProps } from '../../types';
+export declare const Layer: (props: LayerProps) => JSX.Element;

package/dist/Components/Map/Subcomponents/AddButton.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+export default function AddButton({ setSelectMode }: {
+    setSelectMode: React.Dispatch<React.SetStateAction<any>>;
+}): JSX.Element;

package/dist/Components/Map/Subcomponents/NewItemPopup.d.ts

@@ -0,0 +1,10 @@
+import * as React from 'react';
+import { LatLng } from 'leaflet';
+import { Layer, Item } from '../../../types';
+export interface NewItemPopupProps {
+    position: LatLng;
+    layer: Layer;
+    item?: Item;
+    setNewItemPopup: React.Dispatch<React.SetStateAction<any>>;
+}
+export default function NewItemPopup(props: NewItemPopupProps): JSX.Element;

package/dist/Components/Map/Subcomponents/Popup.d.ts

@@ -0,0 +1,10 @@
+import * as React from 'react';
+import { Item, Tag } from '../../../types';
+import { NewItemPopupProps } from './NewItemPopup';
+export interface UtopiaPopupProps {
+    item: Item;
+    tags: Tag[];
+    setNewItemPopup?: React.Dispatch<React.SetStateAction<NewItemPopupProps | null>>;
+}
+declare const Popup: (props: UtopiaPopupProps) => JSX.Element;
+export { Popup };

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

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { Tag } from '../../types';
+export declare function Tags({ data }: {
+    data: Tag[];
+}): JSX.Element;

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

@@ -0,0 +1,12 @@
+import "leaflet/dist/leaflet.css";
+import * as React from "react";
+import { Item, Tag, ItemsApi, Layer, UtopiaMap as UtopiaMapProps } from "../../types";
+import "./UtopiaMap.css";
+export interface MapEventListenerProps {
+    selectMode: Layer | null;
+    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, ItemsApi };

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

@@ -0,0 +1,5 @@
+import { UtopiaMap } from "./UtopiaMap";
+declare const _default: ComponentMeta<typeof UtopiaMap>;
+export default _default;
+export declare const Custom: any;
+export declare const BadSalzschlirf: any;

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

@@ -0,0 +1,4 @@
+import { Item, Tag } from "../../types";
+export declare const tags: Tag[];
+export declare const events: Item[];
+export declare const places: Item[];

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

@@ -0,0 +1,20 @@
+import * as React from "react";
+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[];
+    children?: React.ReactNode;
+}>;
+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/hooks/useLayers.d.ts

@@ -0,0 +1,14 @@
+import * as React from "react";
+import { Layer } from "../../../types";
+declare type UseItemManagerResult = ReturnType<typeof useLayerManager>;
+declare function useLayerManager(initialLayers: Layer[]): {
+    layers: Layer[];
+    addLayer: (layer: Layer) => void;
+};
+export declare const LayersProvider: React.FunctionComponent<{
+    initialLayers: Layer[];
+    children?: React.ReactNode;
+}>;
+export declare const useLayers: () => Layer[];
+export declare const useAddLayer: () => UseItemManagerResult["addLayer"];
+export {};

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

@@ -0,0 +1,16 @@
+import * as React from "react";
+import { Tag } from "../../../types";
+declare type UseTagManagerResult = ReturnType<typeof useTagsManager>;
+declare function useTagsManager(initialTags: Tag[]): {
+    tags: Tag[];
+    addTag: (tag: Tag) => void;
+    removeTag: (id: number) => void;
+};
+export declare const TagsProvider: React.FunctionComponent<{
+    initialTags: Tag[];
+    children?: React.ReactNode;
+}>;
+export declare const useTags: () => Tag[];
+export declare const useAddTag: () => UseTagManagerResult["addTag"];
+export declare const useRemoveTag: () => UseTagManagerResult["removeTag"];
+export {};

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

@@ -0,0 +1,3 @@
+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/Utils/DynamicHeroIcon.d.ts

@@ -0,0 +1,5 @@
+import { FC } from 'react';
+declare const DynamicHeroIcon: FC<{
+    icon: string;
+}>;
+export default DynamicHeroIcon;

package/dist/Utils/ReplaceURLs.d.ts

@@ -0,0 +1 @@
+export declare function replaceURLs(message: string): string;

package/dist/index.d.ts

@@ -1,16 +1,6 @@
-/// <reference types="react" />
-import "leaflet/dist/leaflet.css";
-import { Item, Tag } from "./types";
-import "./styles.scss";
-import { LatLng } from "leaflet";
-export interface MapProps {
-    height: string;
-    width: string;
-    center: LatLng;
-    zoom: number;
-    places?: Item[];
-    events?: Item[];
-    tags?: Tag[];
-}
-declare const UtopiaMap: (props: MapProps) => JSX.Element;
-export { UtopiaMap, Item, Tag };
+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";