mgtypes 1.0.83 → 1.0.85

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mgtypes",
-  "version": "1.0.83",
+  "version": "1.0.85",
   "description": "types for mg development",
   "main": "index.js",
   "scripts": {

package/types/configs/ClientConfig.ts

@@ -4,19 +4,29 @@ import { mgMapBillboards } from '../Content';
  * Mother Config object
  */
 export interface mgClientConfiguration {
-  specs: mgSpecsConfig;
-  colors: mgColorsConfig;
-  fonts: mgFontsConfig;
-  styles: mgStylesConfig;
-  features: mgFeaturesConfig;
-  map: mgMapConfig;
-  feed: mgFeedConfig;
-  profiles: mgProfilesConfig;
-  lists: mgListsConfig;
-  navigation: mgNavigationConfig;
-  calendar: mgCalendarConfig;
-  authentication: mgAuthenticationConfig;
-  content: mgContentConfig;
+  SPECS: mgSpecsConfig;
+  COLORS: mgColorsConfig;
+  FONTS: mgFontsConfig;
+  STYLES: mgStylesConfig;
+  FEATURES: mgFeaturesConfig;
+  MAP: mgMapConfig;
+  PROFILES: mgProfilesConfig;
+  CONTENT: mgContentConfig;
+  PLACEHOLDERS: mgPlaceholdersConfig;
+}
+
+export interface mgPlaceholdersConfig {
+  networkFailureMessage: string;
+  FEED_NOTIFICATION: {
+    MAIN_TAB: {
+      searchMode: (numberOfHits: number) => string;
+      browseMode: string;
+    };
+    friendsTab: string;
+    archiveTab: string;
+    userTab: string;
+  };
+  stickySearchBar: string;
 }
 
 /**
@@ -24,41 +34,20 @@ export interface mgClientConfiguration {
  */
 export interface mgMapConfig {
   MAP_BILLBOARDS: mgMapBillboards;
-  MAP_STYLE_URL: string;
-  DEFAULT_MAP_BOUNDARIES: { latitude: number; longitude: number }[];
-  EVENT_CENTER_COORDINATES: {latitude: number, longitude:number}
-}
-
-/**
- * Configs for feed
- */
-export interface mgFeedConfig {
-  SHOW_NETWORK_INDICATOR: boolean; // TODO: delete, not used, just have a popup when network fails
-}
-
-/**
- * Configs for lists
- */
-export interface mgListsConfig {
-  THIS_INTERFACE_HAS_NO_PROPERTIES: undefined;
-}
-
-/**
- * Configs for calendars
- */
-export interface mgCalendarConfig {
-  THIS_INTERFACE_HAS_NO_PROPERTIES: undefined;
+  DEFAULT_MAP_BOUNDARIES: { latitude: number; longitude: number }[] | null;
+  EVENT_CENTER_COORDINATES: { latitude: number; longitude: number } | null;
+  mapStyleURL: string | null;
 }
 
 /**
  * Configs for event dates, locations, names, map details and feed header
  */
 export interface mgSpecsConfig {
-  EVENT_NAME: string;
-  APP_ALIAS: string;
-  PRESENTING_ORGANIZATION: string | null;
-  EVENT_START_DATETIME: string | null;
-  EVENT_END_DATETIME: string | null;
+  eventName: string;
+  appAlias: string;
+  presentingOrganization: string | null;
+  eventStartDateTime: string | null;
+  eventEndDateTime: string | null;
 }
 
 /**
@@ -74,26 +63,51 @@ export enum mgNavButton {
   SETTINGS = 'settings',
 }
 
-/**
- * Configs for nav, like bottom nav buttons
- * @property bottomNavButtons.primary: buttons that show on bottom nav, listed in order they're displayed
- * @property bottomNavButtons.secondary: buttons that show in 'MORE' menu
- */
-export interface mgNavigationConfig {
-  bottomNavButtons: {
-    primary: ('feed'|'map'|'create'|'list'|'calendar'|'help'|'settings')[];
-    secondary: ('feed'|'map'|'create'|'list'|'calendar'|'help'|'settings')[];
-  };
-  homePage: 'Settings' | 'Map' | 'Feed' | 'Calendar' | 'Lists';
-}
-
 /**
  * Configs that dictate user interactivity
  */
 export interface mgFeaturesConfig {
-  IS_CONTENT_THREADED: boolean;
-  VOTING_MODE: 'none' | 'up only' | 'up and down'
-  SHOW_CONTENT_CREATION_DATE: boolean
+  CONTENT: {
+    isContentThreaded: boolean;
+    votingMode: 'none' | 'up only' | 'up and down';
+    showContentCreationDate: boolean;
+  };
+  PAGES: {
+    FEED: {
+      isEnabled: boolean;
+    };
+    MAP: {
+      isEnabled: boolean;
+    };
+    LISTS: {
+      isEnabled: boolean;
+    };
+    CALENDAR: {
+      isEnabled: boolean;
+    };
+    SETTINGS: {
+      isEnabled: boolean;
+    };
+  };
+  NAV: {
+    homePage: 'settings' | 'map' | 'feed' | 'calendar' | 'lists';
+    primaryButtons: 'settings' | 'map' | 'feed' | 'calendar' | 'lists'[]; // | 'create' | 'help'
+    secondaryButtons: 'settings' | 'map' | 'feed' | 'calendar' | 'lists'[]; // | 'create' | 'help'
+  };
+  AUTH: {
+    userAuthMode: 'guest only' | 'account only' | 'guest or account';
+    AUTH_PAGE: {
+      displayMode: 'never' | 'interval' | 'always';
+      interval:
+        | null
+        | '10 minutes'
+        | '30 minutes'
+        | '1 hour'
+        | '1 day'
+        | '1 week'
+        | '1 month';
+    };
+  };
 }
 
 /**
@@ -107,7 +121,7 @@ export interface mgFeaturesConfig {
  *
  */
 export interface mgContentConfig {
-  TAGS: string[];
+  tags: string[];
   PINS: {
     art?: string[]; // painting, sculpture, etc... same as "plans-art"
     default: ['pin'];
@@ -152,22 +166,6 @@ export interface mgContentConfig {
   EMERGENCIES?: ('mental health' | 'security' | 'fire' | 'medical')[];
 }
 
-// ** AUTH **
-export interface mgAuthenticationConfig {
-  USER_AUTH_MODE: 'guest only' | 'account only' | 'guest or account';
-  AUTH_PAGE: {
-    DISPLAY_MODE: 'never' | 'interval' | 'always';
-    INTERVAL:
-      | null
-      | '10 minutes'
-      | '30 minutes'
-      | '1 hour'
-      | '1 day'
-      | '1 week'
-      | '1 month';
-  };
-}
-
 // ** COLORS **
 /**
  * Configs based on React Native Paper color assignments w/ some extras
@@ -201,7 +199,7 @@ export interface mgColorsConfig {
   lightNeutral: string;
   darkNeutral: string;
   dark: string;
-  sunkSurface:string;
+  sunkSurface: string;
   success: string;
   warning: string;
   locationPuck: string;

package/types/configs/ComponentConfig.ts

@@ -1,5 +1,5 @@
-import { ReactElement } from 'react';
-
+// COMPONENT DIMENSIONS
+// VALUES ARE NUMBER ONLY!
 export interface mgComponentConfiguration {
   authentication: mgAuthenticationComponentConfig;
   feed: mgFeedComponentConfig;
@@ -7,25 +7,32 @@ export interface mgComponentConfiguration {
   other: mgOtherComponentConfig;
 }
 
-export interface mgMapComponentConfig{
-  mapIconButtonSize:number;
+export interface mgMapComponentConfig {
+  mapIconButtonSize: number;
 }
 export interface mgAuthenticationComponentConfig {
-   THIS_INTERFACE_HAS_NO_PROPERTIES: undefined;
+  THIS_INTERFACE_HAS_NO_PROPERTIES: undefined;
 }
 
 export interface mgFeedComponentConfig {
-  HEADER: { height: number; graphicPadding:{top:number, right:number, bottom:number, left:number} };
+  HEADER: {
+    height: number;
+    graphicPadding: {
+      top: number;
+      right: number;
+      bottom: number;
+      left: number;
+    };
+  };
   NOTIFICATION: {
     height: number;
-    fallbackText: string; // what's displayed if server doesn't work
   };
 }
 
 export interface mgOtherComponentConfig {
   STICKY: {
     height: number;
-    SEARCH_BAR: { fontSize: number; height: number; placeholder: string };
+    SEARCH_BAR: { fontSize: number; height: number; };
     BOTTOM: { height: number };
   };
   CARD: {