mgtypes 1.0.51 → 1.0.53

package/package.json

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

package/types/App.ts

@@ -1,4 +1,4 @@
-import { Position } from 'geojson';
+import { mgMapBillboards } from './Content';
 
 // App coming from admin database
 export interface App {
@@ -14,7 +14,7 @@ export interface App {
   eventZip: string;
   mapTheme: 'light' | 'dark' | 'streets' | 'outdoors';
   mapStyleUrl: string;
-  mapSigns: MapSigns;
+  mapBillboards: mgMapBillboards;
   pins: any[];
   plans: any[];
   photos: any[];
@@ -25,20 +25,7 @@ export interface App {
   appColors: AppColors;
 }
 
-/**
- * @param icon use a hyphen to connect substrings, as in 'ferris-wheel'. This is Expo-friendly.
- * @param iconColor use hex, as in '#e5e5e5'
- * @param image not configured, would be used to display image on label
- */
-export interface MapSign {
-  title: string;
-  icon: string | null;
-  latitude: number;
-  longitude: number;
-  iconColor: string | null;
-  image: string | null;
-  boundingBox: Position[];
-}
+
 
 export interface AppColors {
   primary: string;
@@ -50,8 +37,3 @@ export interface AppColors {
   outline: string;
   surfaceVariant: string;
 }
-
-export interface MapSigns {
-  zoomThresholds: number[];
-  signs: MapSign[][];
-}

package/types/Configuration.ts

@@ -1,5 +1,4 @@
-import { Position } from 'geojson';
-import { MapSign } from './App';
+import { mgMapBillboards } from './Content';
 
 /**
  * Mother Config object
@@ -23,7 +22,7 @@ export interface mgConfiguration {
  * Configs for map
  */
 export interface mgMapConfig {
-  MAP_LABELS: { zoomThresholds: number[]; labels: MapSign[][] };
+  MAP_BILLBOARDS: mgMapBillboards;
   MAP_STYLE_URL: string;
   DEFAULT_MAP_BOUNDARIES: { latitude: number; longitude: number }[];
 }
@@ -215,6 +214,8 @@ export interface mgAuthenticationConfig {
 
 /**
  * Configs based on React Native Paper color assignments w/ some extras
+ * @property surfaceVariant: seems to be the color of the icon button, but
+ * setting another component's background to it does not match the icon button
  */
 export interface mgColorsConfig {
   // NEW ONES
@@ -228,7 +229,6 @@ export interface mgColorsConfig {
   darkNeutral: string;
   dark: string;
 
-
   success: string;
   warning: string;
 
@@ -241,7 +241,6 @@ export interface mgColorsConfig {
   secondaryContainerGradient: string;
   tertiaryContainerGradient: string;
 
-
   // ORIGINALS
 
   primary: string;
@@ -269,7 +268,7 @@ export interface mgColorsConfig {
   onBackground: string;
   surface: string;
   onSurface: string;
-  surfaceVariant: string;
+  surfaceVariant: string; // IconButton and CustomChip unselected bg
   onSurfaceVariant: string;
   inverseSurface: string;
   inverseOnSurface: string;
@@ -472,39 +471,22 @@ export interface mgPermissionsProfile {
  * @param pins one of this property's internal properties can be 'all', which will filter all pins
  * @param plans same as above
  */
+
+// TODO: create a data structure that encapsulates
+// how filters might effectively work
 export interface mgMapFiltersProfile {
-  pins?: { [key: string]: mgMapFilter };
-  plans?: { [key: string]: mgMapFilter };
-  people?: {
-    friends?: mgMapFilter;
-    fire?: mgMapFilter;
-    security?: mgMapFilter;
-    medical?: mgMapFilter;
-    'mental health'?: mgMapFilter;
-    allResponders?: mgMapFilter;
-    all?: mgMapFilter;
-  };
-  emergencies?: {
-    fire?: mgMapFilter;
-    security?: mgMapFilter;
-    medical?: mgMapFilter;
-    'mental health'?: mgMapFilter;
-    all?: mgMapFilter;
-  };
-  routes?: {
-    runs?: mgMapFilter;
-    parades?: mgMapFilter;
-    all?: mgMapFilter;
-  };
+  [filterName: string]: mgMapFilter;
 }
 
 /**
  * Configs to display a map filter
  */
 export interface mgMapFilter {
-  category: 'route' | 'pin' | 'person' | 'plan' | 'emergency';
-  value: string;
-  labelText: string;
+  contentToFilter?: {
+    contentType: 'pin' | 'plan' | 'route'; // 'pin'
+    contentableCategory: string | 'all'; // 'food'
+    contentableType: string | 'all'; // 'burgers'
+  }[];
+  contentItemsToFilter?: number[];
   icon: string;
-  color: string;
 }

package/types/Content.ts

@@ -1,70 +1,22 @@
-import { Tag } from './Tag';
-import { User, UserPlan, Sender, UserRole } from './User';
-import { Vote } from './Vote';
-import { Emergency } from './Emergency';
+import { mgTag } from './Tag';
+import { mgUser, mgUserPlan, mgSender, mgUserRole } from './User';
+import { mgVote } from './Vote';
+import { mgEmergency } from './Emergency';
 import { Position } from 'geojson';
 
-/**
- * shared posts will have sharedContentDetails, normal
- * posts won't have sCD. Posts with threads attached have
- * children; thread tracks who added and where a threaded
- * post goes. A plan may have UserPlan details that indicate
- * if user is attending the plan
- * */
-export interface AppContent {
-  feedData: {
-    mainContent: { order: number[]; content: { [contentId: string]: Post } };
-    sharedContent: { order: number[]; content: { [contentId: string]: Post } };
-    friendsContent: { order: number[]; content: { [contentId: string]: Post } };
-    userContent: { order: number[]; content: { [contentId: string]: Post } };
-  };
-  mapData: {
-    pins: { [contentId: string]: Post };
-    publicPlans: { [contentId: string]: Post };
-    userPlans: { [contentId: string]: Post };
-    pinAds: { [contentId: string]: Post };
-    planAds: { [contentId: string]: Post };
-    routes: { [contentId: string]: Post };
-  };
-  userData: {
-    user: User;
-    votes: Vote[];
-    friends: { [userId: string]: User };
-    plans: UserPlan[];
-    friendRequests: { [friendRequestId: string]: FriendRequest };
-    roles: UserRole[];
-    activeRole: string;
-    emergencies: Emergency[];
-  };
-  listsData: {
-    [listId: string]: {
-      content: { [contentId: string]: Post };
-      order: number[];
-      title: string;
-      description: string;
-      icon: string;
-    };
-  };
-  calendarData: {
-    publicPlans: { [contentId: string]: Post };
-  };
-}
-export interface PostWithIndex {
-  [contentId: string]: Post;
-}
 
-export interface Post {
-  content: Content;
-  contentable: Contentable;
-  user: User;
-  tags: Tag[];
-  sharedContentDetails?: SharedContentDetails;
-  userPlan?: UserPlan;
+export interface mgPost {
+  content: mgContent;
+  contentable: mgContentable;
+  user: mgUser;
+  tags: mgTag[];
+  sharedContentDetails?: mgSharedContentDetails;
+  userPlan?: mgUserPlan;
   // children?: Post[];
   // thread?: Thread;
-  userVote?: Vote;
+  userVote?: mgVote;
   indent?: number;
-  parent?: Post;
+  parent?: mgPost;
   pages?: {
     feed:
       | { main?: number; shared?: number; user?: number; friends?: number }
@@ -78,17 +30,17 @@ export interface Post {
 /**
  * indicates who embedded a piece of content: used for ThreadModal
  * */
-export interface Thread {
+export interface mgThread {
   id: number;
   parentId: number;
   childId: number;
   threaderId: number;
   createdAt: string;
   updatedAt: string;
-  threader: User;
+  threader: mgUser;
 }
 
-export interface Content {
+export interface mgContent {
   id: number;
   latitude: number | string; // should be a number but is coming back from db as a string for some reason
   longitude: number | string; // same as above
@@ -116,7 +68,7 @@ export interface Content {
  * Covers all different content types
  *  (pin, plan, comment, photo, route) coming in from server
  *  */
-export interface Contentable {
+export interface mgContentable {
   id: number;
   primaryText: string;
   secondaryText?: string;
@@ -148,20 +100,21 @@ export interface Contentable {
   phoneNumber?: string;
 
   // Pins
-  pinHours?: PinHour[];
+  pinHours?: mgPinHour[];
 
   // Routes
   routeCategory?: string;
+  routeType?:string;
   distance?: string;
   color?: string;
   coordinates?: Position[];
 
   // Embed
-  embeddedContent: Post;
+  embeddedContent: mgPost;
   embeddedContentId: number;
 }
 
-export interface PinHour {
+export interface mgPinHour {
   id: number;
   openDateTime: string;
   closeDateTime: string;
@@ -170,16 +123,8 @@ export interface PinHour {
   pinId: number;
 }
 
-export interface SharedContentDetails {
-  senders: Sender[];
-  sharedContentStatus: {
-    id: number;
-    isArchived: boolean;
-    createdAt: string;
-    updatedAt: string;
-    contentId: number;
-    userId: number;
-  };
+export interface mgSharedContentDetails {
+  senders: mgSender[];
 }
 
 /**
@@ -189,7 +134,7 @@ export interface SharedContentDetails {
  * has last updated it. TODO:type create events that document
  * how a friendship has changed over time
  */
-export interface FriendRequest {
+export interface mgFriendRequest {
   id: number;
   status:
     | 'pending'
@@ -202,12 +147,12 @@ export interface FriendRequest {
   updatedAt: string;
   requesterId: number;
   recipientId: number;
-  requester: User;
-  recipient: User;
+  requester: mgUser;
+  recipient: mgUser;
   lastUpdaterId: number;
 }
 
-export interface Pin {
+export interface mgPin {
   id: number | null; // will not have id when creating
   pinCategory?: string;
   pinType?: string;
@@ -226,7 +171,7 @@ export interface Pin {
   link?: string | null;
 }
 
-export interface Plan {
+export interface mgPlan {
   id: number | null; // will not have id when creating
   planCategory: string;
   planType: string;
@@ -245,14 +190,14 @@ export interface Plan {
   updatedAt: string;
 }
 
-export interface Comment {
+export interface mgComment {
   id: number | null; // will not have id when creating
   primaryText: string;
   createdAt: string;
   updatedAt: string;
 }
 
-export interface Photo {
+export interface mgPhoto {
   id: number | null; // will not have id when creating
   primaryText: string;
   photoURL?: string;
@@ -260,7 +205,7 @@ export interface Photo {
   updatedAt: string;
 }
 
-export interface Route {
+export interface mgRoute {
   routeCategory: string;
   primaryText: string;
   secondaryText: string;
@@ -272,3 +217,23 @@ export interface Route {
   link: string;
   phoneNumber: string;
 }
+
+/**
+ * @param icon use a hyphen to connect substrings, as in 'ferris-wheel'. This is Expo-friendly.
+ * @param iconColor use hex, as in '#e5e5e5'
+ * @param image not configured, would be used to display image on label
+ */
+export interface mgMapBillboard {
+  title: string;
+  icon: string | null;
+  latitude: number;
+  longitude: number;
+  iconColor: string | null;
+  image: string | null;
+  boundingBox: Position[];
+}
+export interface mgMapBillboards {
+  zoomThresholds: number[];
+  billboards: mgMapBillboard[][];
+}
+

package/types/Emergency.ts

@@ -1,6 +1,6 @@
-import { User } from "./User";
+import {mgUser } from "./User";
 
-export interface Emergency {
+export interface mgEmergency {
   id?: number;
   createdAt?: string;
   updatedAt?: string;
@@ -11,6 +11,6 @@ export interface Emergency {
   emergencyType: 'medical' | 'security' | 'fire' | 'mental health' | null;
   primaryText: string;
   address: string | null;
-  reporter?: User;
+  reporter?: mgUser;
 }
 

package/types/Permissions.ts

@@ -12,26 +12,26 @@ export enum mgNativePermissionTitle {
 
 export enum mgLocationPermissionTitle {
   SHOW_LOCATION = 'SHOW_LOCATION',
-  SHOW_DISTANCE_FROM_PINS = 'SHOW_DISTANCE_FROM_PINS',
-  LOCATION_TARGETED_CONTENT = 'LOCATION_TARGETED_CONTENT',
-  FRIENDS_LOCATION_SHARING_BACKGROUND = 'FRIENDS_LOCATION_SHARING_BACKGROUND',
-  FRIENDS_LOCATION_SHARING_FOREGROUND = 'FRIENDS_LOCATION_SHARING_FOREGROUND',
-  EMERGENCY_LOCATION_SHARING = 'EMERGENCY_LOCATION_SHARING',
+  SHOW_DISTANCE_TO_PINS = 'SHOW_DISTANCE_TO_PINS',
+  ENABLE_GEOTARGETED_CONTENT = 'ENABLE_GEOTARGETED_CONTENT',
+  SHARE_BACKGROUND_LOCATION_WITH_FRIENDS = 'SHARE_BACKGROUND_LOCATION_WITH_FRIENDS',
+  SHARE_FOREGROUND_LOCATION_WITH_FRIENDS = 'SHARE_FOREGROUND_LOCATION_WITH_FRIENDS',
+  SHARE_LOCATION_FOR_EMERGENCIES = 'SHARE_LOCATION_FOR_EMERGENCIES',
 }
 
 // adding all of them distinctly to
 // educate users; they can all be default
 // and disabled true
 export enum mgCalendarPermissionTitle {
-  CREATE_EVENTS = 'CREATE_EVENTS',
-  CREATE_REMINDERS = 'CREATE_REMINDERS',
-  ADD_ATTENDEES = 'ADD_ATTENDEES',
+  ENABLE_CREATE_EVENTS = 'ENABLE_CREATE_EVENTS',
+  ENABLE_CREATE_REMINDERS = 'ENABLE_CREATE_REMINDERS',
+  ENABLE_CREATE_ATTENDEES = 'ENABLE_CREATE_ATTENDEES',
 }
 
 export enum mgNotificationsPermissionTitle {
-  ALLOW_FOR_RSVPS = 'ALLOW_FOR_RSVPS',
-  ALLOW_FOR_UPDATES = 'ALLOW_FOR_UPDATES',
-  ALLOW_FOR_MARKETING = 'ALLOW_FOR_MARKETING',
+  RECEIVE_RSVP_NOTIFICATIONS = 'RECEIVE_RSVP_NOTIFICATIONS',
+  RECEIVE_EVENT_NEWS_NOTIFICATIONS = 'RECEIVE_EVENT_NEWS_NOTIFICATIONS',
+  RECEIVE_MARKETING_NOTIFICATIONS = 'RECEIVE_MARKETING_NOTIFICATIONS',
 }
 
 export const nativePermissionsOrder: mgNativePermissionTitle[] = [
@@ -47,21 +47,21 @@ export const nativePermissionsOrder: mgNativePermissionTitle[] = [
 
 export const locationPermissionsOrder: mgLocationPermissionTitle[] = [
   mgLocationPermissionTitle.SHOW_LOCATION,
-  mgLocationPermissionTitle.SHOW_DISTANCE_FROM_PINS,
-  mgLocationPermissionTitle.LOCATION_TARGETED_CONTENT,
-  mgLocationPermissionTitle.FRIENDS_LOCATION_SHARING_FOREGROUND,
-  mgLocationPermissionTitle.FRIENDS_LOCATION_SHARING_BACKGROUND,
-  mgLocationPermissionTitle.EMERGENCY_LOCATION_SHARING,
+  mgLocationPermissionTitle.SHOW_DISTANCE_TO_PINS,
+  mgLocationPermissionTitle.ENABLE_GEOTARGETED_CONTENT,
+  mgLocationPermissionTitle.SHARE_BACKGROUND_LOCATION_WITH_FRIENDS,
+  mgLocationPermissionTitle.SHARE_FOREGROUND_LOCATION_WITH_FRIENDS,
+  mgLocationPermissionTitle.SHARE_LOCATION_FOR_EMERGENCIES,
 ];
 
 export const calendarPermissionsOrder: mgCalendarPermissionTitle[] = [
-  mgCalendarPermissionTitle.CREATE_EVENTS,
-  mgCalendarPermissionTitle.CREATE_REMINDERS,
-  mgCalendarPermissionTitle.ADD_ATTENDEES,
+  mgCalendarPermissionTitle.ENABLE_CREATE_EVENTS,
+  mgCalendarPermissionTitle.ENABLE_CREATE_REMINDERS,
+  mgCalendarPermissionTitle.ENABLE_CREATE_ATTENDEES,
 ];
 
 export const notificationsPermissionsOrder: mgNotificationsPermissionTitle[] = [
-  mgNotificationsPermissionTitle.ALLOW_FOR_RSVPS,
-  mgNotificationsPermissionTitle.ALLOW_FOR_UPDATES,
-  mgNotificationsPermissionTitle.ALLOW_FOR_MARKETING,
+  mgNotificationsPermissionTitle.RECEIVE_RSVP_NOTIFICATIONS,
+  mgNotificationsPermissionTitle.RECEIVE_EVENT_NEWS_NOTIFICATIONS,
+  mgNotificationsPermissionTitle.RECEIVE_MARKETING_NOTIFICATIONS,
 ];

package/types/SecureStore.ts

@@ -2,7 +2,7 @@
 
 import { mgNativePermissionTitle } from './Permissions';
 
-export enum SecureStoreKey {
+export enum mgSecureStoreKey {
   LOGIN_PERMISSION_MODAL= 'LOGIN_PERMISSION_MODAL',
   PERMISSIONS = 'PERMISSIONS',
 

package/types/Tag.ts

@@ -1,12 +1,12 @@
-export interface Tag {
+export interface mgTag {
   id: number;
   tag: string;
   createdAt: string;
   updatedAt: string;
-  content_tag: ContentTag;
+  content_tag: mgContentTag;
 }
 
-export interface ContentTag {
+export interface mgContentTag {
   id: number;
   createdAt: string;
   updatedAt: string;

package/types/User.ts

@@ -1,6 +1,6 @@
-import { FriendRequest } from "./Content";
+import { mgFriendRequest } from "./Content";
 
-export interface User {
+export interface mgUser {
   id: number | null;
   givenName: string | null;
   familyName: string | null;
@@ -14,11 +14,11 @@ export interface User {
   createdAt: string | null;
   updatedAt: string | null;
   imageURL: string | null;
-  friendRequest?: FriendRequest; // a user's friends have a record of the friendship attached
+  friendRequest?: mgFriendRequest; // a user's friends have a record of the friendship attached
   activeRole?:string; // indicates whether user is a friend ('user') or responder ('medical', 'security', etc.)
 }
 
-export interface UserRole {
+export interface mgUserRole {
   id: number | null;
   createdAt: string | null;
   updatedAt: string | null;
@@ -27,7 +27,7 @@ export interface UserRole {
   isActiveRole: boolean;
 }
 
-export interface UserPlan {
+export interface mgUserPlan {
   status: 'accepted' | 'denied' | 'pending';
   userId: number;
   contentId: number;
@@ -36,11 +36,11 @@ export interface UserPlan {
   id: number;
 }
 
-export interface Sender extends User {
-  shareTimeStamp: ShareTimeStamp;
+export interface mgSender extends mgUser {
+  shareTimeStamp: mgShareTimeStamp;
 }
 
-export interface ShareTimeStamp {
+export interface mgShareTimeStamp {
   id: number | null;
   contentId: number;
   senderId: number;

package/types/Vote.ts

@@ -1,4 +1,4 @@
-export interface Vote {
+export interface mgVote {
   userId: number;
   contentId: number;
   vote: 'up'|'down'|null;