mgtypes 1.0.23 → 1.0.24

package/.eslintrc.js

@@ -0,0 +1,33 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+    node: true,
+  },
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+  overrides: [
+    {
+      env: {
+        node: true,
+      },
+      files: ['.eslintrc.{js,cjs}'],
+      parserOptions: {
+        sourceType: 'script',
+      },
+    },
+    {
+      files: ['*.js'],
+      rules: {
+        '@typescript-eslint/no-var-requires': 'off',
+      },
+    },
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  rules: {
+    '@typescript-eslint/no-unused-vars': 0,
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mgtypes",
-  "version": "1.0.23",
+  "version": "1.0.24",
   "description": "types for mg development",
   "main": "index.js",
   "scripts": {
@@ -16,7 +16,12 @@
     "url": "https://github.com/MobGob/mgTypes/issues"
   },
   "homepage": "https://github.com/MobGob/mgTypes#readme",
-  "dependencies": {
-    "@types/geojson": "^7946.0.16"
+  "devDependencies": {
+    "@types/geojson": "^7946.0.16",
+    "@typescript-eslint/eslint-plugin": "^8.46.2",
+    "@typescript-eslint/parser": "^8.46.2",
+    "eslint": "^8.57.1",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-plugin-import": "^2.32.0"
   }
 }

package/types/Configuration.ts

@@ -12,6 +12,8 @@ export interface mgConfiguration {
   features: mgFeaturesConfig;
   map: mgMapConfig;
   feed: mgFeedConfig;
+  profiles: mgProfilesConfig;
+  lists: mgListsConfig;
 }
 
 /**
@@ -20,8 +22,7 @@ export interface mgConfiguration {
 export interface mgMapConfig {
   MAP_LABELS: { zoomThresholds: number[]; labels: MapSign[][] };
   MAP_STYLE_URL: string;
-  DEFAULT_MAP_BOUNDARIES: Position[];
-  MAP_FILTERS: { [key: string]: any };
+  DEFAULT_MAP_BOUNDARIES: { latitude: number; longitude: number }[];
 }
 
 /**
@@ -48,6 +49,13 @@ export interface mgFeedConfig {
   };
 }
 
+/**
+ * Configs for lists
+ */
+export interface mgListsConfig {
+  HAS_CALENDAR: boolean;
+}
+
 /**
  * Configs for event dates, locations, names, map details and feed header
  */
@@ -60,65 +68,99 @@ export interface mgSpecsConfig {
   APP_ALIAS: string;
 }
 
-interface PERMISSION_PROFILE {
-  CONTENT_CREATION: {
-    comment: boolean;
-    photo: boolean;
-    pin:
-      | {
-          [key: string]: any;
-        }
-      | false;
-    plan:
-      | {
-          [key: string]: any;
-        }
-      | false;
-    route: boolean;
-  };
-  VISIBLE_FEED_TABS: {
-    main: boolean;
-    archive: boolean;
-    mine: boolean;
-    friends: boolean;
-  };
-  CAN_HAVE_FRIENDS: boolean;
-  CAN_SHARE_LOCATION: boolean;
-  CAN_SHARE_CONTENT: boolean;
-  CAN_SAVE_CONTENT: boolean;
-  CAN_VOTE: boolean;
-  CAN_ADD_TO_THREAD: boolean;
-  CAN_EMBED_CONTENT_IN_THREAD: boolean;
-}
-
 /**
- * Configs that dictate user interactivity and determine what the configured app "is all about", so to speak
- * @param PERMISSION_PROFILES dictates what types of content users with various roles can add through the app. A configured object for each role (GUEST, USER, etc.) is a PERMISSION_PROFILE:
- *
- * {
- *  CONTENT_CREATION:{
- *   comment: true,
- *   photo: false,
- *   pin: { personal: ['car', 'bicycle', 'default'] },
- *   plan: { sport: ['soccer'] },
- *   route: false
- *  }
- * },
+ * Configs that dictate user interactivity
  */
 export interface mgFeaturesConfig {
   EVENT_TAGS: string[];
-  PIN_TYPES: { [key: string]: string[] };
-  PLAN_TYPES: { [key: string]: string[] };
-  SERVICE_TYPES: { [key: string]: any };
-  EMERGENCY_TYPES: { [key: string]: any };
-  USER_AUTH_SETTING: 'guest only' | 'account only' | 'guest or account';
-  PERMISSION_PROFILES: {
-    guest: PERMISSION_PROFILE | null;
-    user: PERMISSION_PROFILE | null;
+  PIN_TYPES: {
+    food?: string[];
+    drink?: string[];
+    infrastructure?: string[];
+    activity?: string[];
+    toilet?: string[];
+    service?: string[];
+    transportation?: string[];
+    shopping?: string[];
+    personal?: string[];
+    other?: string[];
   };
-  IS_CONTENT_THREADED: boolean
+  PLAN_TYPES: {
+    sport?: string[];
+    hallmark?: string[];
+    music?: string[];
+    other?: string[];
+  };
+  SERVICE_TYPES: {
+    fire?: {
+      value: 'fire';
+      label: string;
+      icon: string;
+      color: string;
+    };
+    medical?: {
+      value: 'medical';
+      label: string;
+      icon: string;
+      color: string;
+    };
+    'mental health'?: {
+      value: 'mental health';
+      label: string;
+      icon: string;
+      color: string;
+    };
+    security?: {
+      value: 'security';
+      label: string;
+      icon: string;
+      color: string;
+    };
+    default: {
+      value: 'default';
+      label: string;
+      icon: string;
+      color: string;
+    };
+  };
+  EMERGENCY_TYPES: {
+    fire?: {
+      value: 'fire';
+      label: string;
+      icon: string;
+      color: string;
+    };
+    medical?: {
+      value: 'medical';
+      label: string;
+      icon: string;
+      color: string;
+    };
+    'mental health'?: {
+      value: 'mental health';
+      label: string;
+      icon: string;
+      color: string;
+    };
+    security?: {
+      value: 'security';
+      label: string;
+      icon: string;
+      color: string;
+    };
+    default: {
+      value: 'default';
+      label: string;
+      icon: string;
+      color: string;
+    };
+  };
+  USER_AUTH_SETTING: 'guest only' | 'account only' | 'guest or account';
+  IS_CONTENT_THREADED: boolean;
 }
 
+// ** COLORS **
+
 /**
  * Configs based on React Native Paper color assignments w/ some extras
  */
@@ -170,6 +212,8 @@ export interface mgColorsConfig {
   backdrop: string;
 }
 
+// ** FONTS **
+
 /**
  * Configs for an individual font style
  */
@@ -196,6 +240,8 @@ export interface mgFontsConfig {
   default: mgFontTextStyle;
 }
 
+// ** STYLES **
+
 /**
  * Configs for border and shadow styles
  */
@@ -208,3 +254,96 @@ export interface mgStylesConfig {
   buttonShadow: 'none' | 'small' | 'large';
   shadowRadius: 'small' | 'large' | 'none';
 }
+
+// ** ACCOUNT PROFILES **
+
+/**
+ * Configs for account-specific permissions and features
+ */
+export interface mgProfilesConfig {
+  USER: mgProfileConfig;
+  GUEST: mgProfileConfig;
+  ADMIN: mgProfileConfig;
+}
+
+interface mgProfileConfig {
+  mgPermissionProfile: mgPermissionProfile;
+  mgMapFilterProfile: mgMapFilterProfile;
+}
+
+interface mgPermissionProfile {
+  CONTENT_CREATION: {
+    comment: boolean;
+    // whether a guest/user can take a photo versus
+    // use one from their library
+    photo: { camera: boolean; library: boolean };
+    pin:
+      | {
+          [key: string]: string[];
+        }
+      | false;
+    plan:
+      | {
+          [key: string]: string[];
+        }
+      | false;
+    route: boolean;
+  };
+  VISIBLE_FEED_TABS: {
+    main: boolean;
+    archive: boolean;
+    mine: boolean;
+    friends: boolean;
+  };
+  CAN_HAVE_FRIENDS: boolean;
+  CAN_SHARE_LOCATION: boolean;
+  CAN_SHARE_CONTENT: boolean;
+  CAN_SAVE_CONTENT: boolean;
+  CAN_VOTE: boolean;
+  CAN_ADD_TO_THREAD: boolean;
+  CAN_EMBED_CONTENT_IN_THREAD: boolean;
+}
+
+/**
+ * Determines what filters are displayed to
+ * a defined account type, such that an admin
+ * would see different filters than a guest or user
+ *
+ * @param pins one of this property's internal properties can be 'all', which will filter all pins
+ * @param plans same as above
+ */
+interface mgMapFilterProfile {
+  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;
+  };
+}
+
+/**
+ * Configs to display a map filter
+ */
+interface mgMapFilter {
+  category: 'route' | 'pin' | 'person' | 'plan' | 'emergency';
+  value: string;
+  labelText: string;
+  icon: string;
+}

package/types/Content.ts

@@ -4,9 +4,14 @@ import { Vote } from './Vote';
 import { Emergency } 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 AllAppContent {
+/**
+ * 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 } };
@@ -31,6 +36,10 @@ export interface AllAppContent {
     activeRole: string;
     emergencies: Emergency[];
   };
+  listsData: {
+    [listId:string]: Post[]
+  }
+  // TODO: add lists
 }
 export interface PostWithIndex {
   [contentId: string]: Post;
@@ -50,7 +59,9 @@ export interface Post {
   parent?: Post;
 }
 
-// indicates who embedded a piece of content: used for ThreadModal
+/**
+ * indicates who embedded a piece of content: used for ThreadModal
+ * */
 export interface Thread {
   id: number;
   parentId: number;
@@ -85,7 +96,10 @@ export interface Content {
   fakeCreatedAt: string;
 }
 
-// Covers all different content types (pin, plan, comment, photo) coming in from server
+/**
+ * Covers all different content types
+ *  (pin, plan, comment, photo) coming in from server
+ *  */
 export interface Contentable {
   id: number;
   primaryText: string;
@@ -155,7 +169,7 @@ export interface SharedContentDetails {
  * Consists of information from both user_friend and user records
  * to display the state of a friendship on client.
  * Documents when the request was originally made and who
- * has last updated it. TODO: create events that document
+ * has last updated it. TODO:type create events that document
  * how a friendship has changed over time
  */
 export interface FriendRequest {
@@ -176,12 +190,11 @@ export interface FriendRequest {
   lastUpdaterId: number;
 }
 
-// Specific content types - type Contentable above covers all content types coming in from server, but content types below are used for creating/editing content in Create[ContentType].tsx component
 export interface Pin {
   id: number | null; // will not have id when creating
   pinCategory?: string;
   pinType?: string;
-  // TODO: CHANGE TO KEY AND BUCKET
+  // TODO:type CHANGE TO KEY AND BUCKET
   // WHICH ARE NEEDED FOR createPresignedUrlWothClient
   // KEY IS ROUTE + FILENAME
   photoURL?: string; // only available after post is created (ie, this is not added by the user)
@@ -225,7 +238,7 @@ export interface Comment {
 export interface Photo {
   id: number | null; // will not have id when creating
   primaryText: string;
-  photoURL?: string; // may not have one (gets returned from Cloudinary after posting)
+  photoURL?: string;
   createdAt: string;
   updatedAt: string;
 }

package/types/Emergency.ts

@@ -8,7 +8,7 @@ export interface Emergency {
   latitude: number | string | null;
   status: 'open' | 'closed';
   reporterId?: number | null;
-  emergencyType: 'medical' | 'security' | 'fire' | null;
+  emergencyType: 'medical' | 'security' | 'fire' | 'mental health' | null;
   primaryText: string;
   address: string | null;
   reporter?: User;

package/types/User.ts

@@ -6,7 +6,7 @@ export interface User {
   familyName: string | null;
   longName: string | null;
   email: string | null;
-  phoneNumber: string | number | null; // TODO: currently this datum is a string but could/should change to numbers?
+  phoneNumber: string | number | null; // TODO:type currently this datum is a string but could/should change to numbers?
   latitude: number | string | null; // same as Content interface
   longitude: number | string | null; // same
   shareLoc: boolean | null;