mgtypes 1.0.20 → 1.0.21

package/package.json

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

package/types/Configuration.ts

@@ -1,30 +1,35 @@
 import { Position } from 'geojson';
 import { MapSign } from './App';
 
+/**
+ * Mother Config object
+ */
 export interface Configuration {
-  eventSpecs: EventSpecs;
-  eventColors: EventColors;
-  eventFonts: EventFonts;
-  eventStyles: EventStyles;
+  specs: mgSpecs;
+  colors: mgColors;
+  fonts: mgFonts;
+  styles: mgStyles;
+  features: mgFeatures;
+  map: mgMap;
+  feed: mgFeed;
 }
 
-export interface EventSpecs {
-  EVENT_TAGS: string[];
-  PIN_TYPES: { [key: string]: string[] };
-  PLAN_TYPES: string[];
-  USER_CREATABLE_CONTENT_TYPES: { [key: string]: { [key: string]: any } };
-  USER_MAP_FILTER_OPTIONS: { [key: string]: any };
-  SERVICE_TYPES: { [key: string]: any };
-  EMERGENCY_TYPES: { [key: string]: any };
+
+/**
+ * Configs for map
+ */
+export interface mgMap {
   MAP_LABELS: { zoomThresholds: number[]; labels: MapSign[][] };
-  EVENT_END_DATETIME: string;
-  EVENT_START_DATETIME: string;
-  EVENT_LONGITUDE: string;
-  EVENT_LATITUDE: string;
-  EVENT_DEFAULT_MAP_BOUNDARIES: Position[];
-  EVENT_NAME: string;
-  APP_ALIAS: string;
   MAP_STYLE_URL: string;
+  DEFAULT_MAP_BOUNDARIES: Position[];
+  MAP_FILTERS: { [key: string]: any };
+}
+
+
+/**
+ * Configs for feed
+ */
+export interface mgFeed {
   FEED_HEADER_IMAGE_NAMES: string[];
   FEED_HEADER_CONFIG: {
     position:
@@ -45,12 +50,67 @@ export interface EventSpecs {
   };
 }
 
-export interface EventColors {
+/**
+ * Configs for event dates, locations, names, map details and feed header
+ */
+export interface mgSpecs {
+  EVENT_NAME: string;
+  EVENT_START_DATETIME: string;
+  EVENT_END_DATETIME: string;
+  EVENT_LONGITUDE: string;
+  EVENT_LATITUDE: string;
+  APP_ALIAS: string;
+}
+
+interface PERMISSION_PROFILE {
+  comment: boolean;
+  photo: boolean;
+  pin:
+    | {
+        [key: string]: any;
+      }
+    | false;
+  plan:
+    | {
+        [key: string]: any;
+      }
+    | false;
+  route: 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:
+ *
+ * {
+ * comment: true,
+ *  photo: false,
+ *  pin: { personal: ['car', 'bicycle', 'default'] },
+ *  plan: { sport: ['soccer'] },
+ *  route: false
+  },
+ */
+export interface mgFeatures {
+  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;
+    USER: PERMISSION_PROFILE;
+  };
+}
+
+/**
+ * Configs based on React Native Paper color assignments w/ some extras
+ */
+export interface mgColors {
   success: string;
   warning: string;
   warningUnselected: string;
   locationPuck: string;
-
   primary: string;
   onPrimary: string;
   primaryContainer: string;
@@ -94,7 +154,10 @@ export interface EventColors {
   backdrop: string;
 }
 
-interface MGFontTextStyle {
+/**
+ * Configs for an individual font style
+ */
+interface mgFontTextStyle {
   fontFamily?: string;
   fontWeight?: '200' | '300' | '400' | '500' | '700';
   letterSpacing?: number;
@@ -102,19 +165,25 @@ interface MGFontTextStyle {
   lineHeight?: number;
 }
 
-export interface EventFonts {
-  labelLarge: MGFontTextStyle;
-  labelMedium: MGFontTextStyle;
-  labelSmall: MGFontTextStyle;
-  bodyLarge: MGFontTextStyle;
-  bodyMedium: MGFontTextStyle;
-  displayMedium: MGFontTextStyle;
-  displaySmall: MGFontTextStyle;
-  headlineSmall: MGFontTextStyle;
-  default: MGFontTextStyle;
+/**
+ * Configs for all the app's font styles
+ */
+export interface mgFonts {
+  labelLarge: mgFontTextStyle;
+  labelMedium: mgFontTextStyle;
+  labelSmall: mgFontTextStyle;
+  bodyLarge: mgFontTextStyle;
+  bodyMedium: mgFontTextStyle;
+  displayMedium: mgFontTextStyle;
+  displaySmall: mgFontTextStyle;
+  headlineSmall: mgFontTextStyle;
+  default: mgFontTextStyle;
 }
 
-export interface EventStyles {
+/**
+ * Configs for border and shadow styles
+ */
+export interface mgStyles {
   containerBorderRadius: 'none' | 'small' | 'large' | 'full';
   containerBorderWidth: 'none' | 'thin' | 'normal' | 'thick';
   containerShadow: 'none' | 'small' | 'large';

package/types/User.ts

@@ -22,7 +22,7 @@ export interface UserRole {
   id: number | null;
   createdAt: string | null;
   updatedAt: string | null;
-  role: 'user' | 'admin' | 'medical' | 'fire' | 'security' | 'advertiser' |'mental-health'|'vendor'; // TODO: make this configurable
+  role: 'user' | 'admin' | 'medical' | 'fire' | 'security' | 'advertiser' |'mental_health'|'vendor';
   userId: number | null;
   isActiveRole: boolean;
 }