mgtypes 1.0.0

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "mgtypes",
+  "version": "1.0.0",
+  "description": "types for mg development",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MobGob/mgTypes.git"
+  },
+  "author": "Evan Perry",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/MobGob/mgTypes/issues"
+  },
+  "homepage": "https://github.com/MobGob/mgTypes#readme",
+  "dependencies": {
+    "@types/geojson": "^7946.0.16"
+  }
+}

package/types/Configuration.ts

@@ -0,0 +1,82 @@
+import { Position } from 'geojson';
+import { MapLabel } from './Content';
+
+interface Configuration {
+  eventSpecs: EventSpecs;
+  eventColors: EventColors;
+}
+
+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 };
+
+  EVENT_MAP_LABELS: { zoomThresholds: number[]; labels: MapLabel[][] };
+
+  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;
+  FEED_HEADER_IMAGE_NAMES: string[];
+}
+
+export interface EventColors {
+  success: string;
+  warning: string;
+  warningUnselected: string;
+  locationPuck: string;
+
+  primary: string;
+  onPrimary: string;
+  primaryContainer: string;
+  onPrimaryContainer: string;
+  onPrimaryContainerUnselected:string;
+  secondary: string;
+  onSecondary: string;
+  secondaryContainer: string;
+  onSecondaryContainer: string;
+  tertiary: string;
+  onTertiary: string;
+  tertiaryContainer: string;
+  onTertiaryContainer: string;
+  error: string;
+  onError: string;
+  errorContainer: string;
+  onErrorContainer: string;
+  background: string;
+  onBackground: string;
+  surface: string;
+  onSurface: string;
+  surfaceVariant: string;
+  onSurfaceVariant: string;
+  outline: string;
+  outlineVariant: string;
+  shadow: string;
+  scrim: string;
+  inverseSurface: string;
+  inverseOnSurface: string;
+  inversePrimary: string;
+  elevation: {
+    level0: string;
+    level1: string;
+    level2: string;
+    level3: string;
+    level4: string;
+    level5: string;
+  };
+  surfaceDisabled: string;
+  onSurfaceDisabled: string;
+  backdrop: string;
+}
+
+export default Configuration;

package/types/Content.ts

@@ -0,0 +1,259 @@
+import { Tag } from './Tag';
+import { User, UserPlan, Sender, UserRole } from './User';
+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
+
+interface AllAppContent {
+  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[];
+  };
+}
+interface PostWithIndex {
+  [contentId: string]: Post;
+}
+
+interface Post {
+  content: Content;
+  contentable: Contentable;
+  user: User;
+  tags: Tag[];
+  sharedContentDetails?: SharedContentDetails;
+  userPlan?: UserPlan;
+  // children?: Post[];
+  // thread?: Thread;
+  userVote?: Vote;
+  indent?: number;
+  parent?: Post;
+}
+
+// indicates who embedded a piece of content: used for ThreadModal
+interface Thread {
+  id: number;
+  parentId: number;
+  childId: number;
+  threaderId: number;
+  createdAt: string;
+  updatedAt: string;
+  threader: User;
+}
+
+interface Content {
+  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
+  upvotes: number;
+  placement: 'public' | 'private' | 'ad' | 'system';
+  contentableType: 'photo' | 'comment' | 'plan' | 'pin' | 'route' | 'embed';
+  contentableId: number;
+  parentId: null | number;
+  progenitorId: null | number;
+  createdAt: string;
+  updatedAt: string;
+  userId: number;
+  displayRule: string;
+  shareCount: number;
+  threadCount: number;
+  displayScore: number;
+
+  fakeUpvotes: number;
+  fakeThreadCount: number;
+  fakeShareCount: number;
+  fakeCreatedAt: string;
+}
+
+// Covers all different content types (pin, plan, comment, photo) coming in from server
+interface Contentable {
+  id: number;
+  primaryText: string;
+  secondaryText?: string;
+  createdAt: string;
+  updatedAt: string;
+
+  // Pins, plans, routes & photos
+  photoURL?: string;
+
+  // Pins
+  pinCategory?: string;
+  pinType?: string;
+
+  // Plans
+  planType?: string;
+  inviteCount?: number;
+  attendingCount?: number;
+
+  // Plans or Route
+  startTime?: string | Date;
+  endTime?: string | Date;
+
+  // Plan or Pin
+  address?: string;
+  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
+  link?: string;
+  phoneNumber?: string;
+
+  // Pins
+  pinHours?: PinHour[];
+
+  // Routes
+  routeType?: string;
+  color?: string;
+  coordinates?: Position[];
+
+  // Embed
+  embeddedContent: Post;
+  embeddedContentId: number;
+}
+
+interface PinHour {
+  id: number;
+  openDateTime: string;
+  closeDateTime: string;
+  createdAt: string;
+  updatedAt: string;
+  pinId: number;
+}
+
+interface SharedContentDetails {
+  senders: Sender[];
+  sharedContentStatus: {
+    id: number;
+    isArchived: boolean;
+    createdAt: string;
+    updatedAt: string;
+    contentId: number;
+    userId: number;
+  };
+}
+
+interface FriendRequest {
+  id: number;
+  status: 'pending' | 'approved' | 'denied' | 'blocked';
+  createdAt: string;
+  updatedAt: string;
+  requesterId: number;
+  recipientId: number;
+  requester: User;
+  recipient: User;
+}
+
+// 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
+interface Pin {
+  id: number | null; // will not have id when creating
+  pinCategory?: string;
+  pinType?: string;
+  photoURL?: string; // only available after post is created (ie, this is not added by the user)
+  primaryText: string;
+  secondaryText: string;
+  latitude?: number | string | null; // should be a number but is coming back from db as a string for some reason
+  longitude?: number | string | null; // same as above
+  createdAt: string;
+  updatedAt: string;
+  address: string;
+  phoneNumber?: string | null;
+  link?: string | null;
+}
+
+interface Plan {
+  id: number | null; // will not have id when creating
+  planType: string;
+  primaryText: string;
+  secondaryText: string;
+  address?: string;
+  startTime?: string | Date;
+  endTime?: string | Date;
+  inviteCount?: number;
+  attendingCount?: number;
+  link?: string | null;
+  phoneNumber?: string | null;
+  latitude?: number | string | null;
+  longitude?: number | string | null;
+  createdAt: string;
+  updatedAt: string;
+}
+
+interface Comment {
+  id: number | null; // will not have id when creating
+  primaryText: string;
+  createdAt: string;
+  updatedAt: string;
+}
+
+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)
+  createdAt: string;
+  updatedAt: string;
+}
+
+interface Route {
+  routeType: string;
+  primaryText: string;
+  secondaryText: string;
+  photoURL?: string;
+  color: string;
+  coordinates: Position[];
+  startTime: string;
+  endTime: string;
+  link: string;
+  phoneNumber: string;
+}
+
+interface MapLabel {
+  longitude: number;
+  latitude: number;
+  icon: string | null;
+  iconColor: string | null;
+  image: string | null;
+  title: string;
+  boundingBox: Position[];
+}
+
+interface Route {
+  id: number;
+  name: string;
+  routeType: string;
+  coordinates: number[][];
+  createdAt: string;
+  updatedAt: string;
+}
+
+export {
+  Post,
+  FriendRequest,
+  Comment,
+  Photo,
+  Pin,
+  Plan,
+  PostWithIndex,
+  AllAppContent,
+  PinHour,
+  MapLabel,
+  Route,
+  Contentable,
+};

package/types/Emergency.ts

@@ -0,0 +1,17 @@
+import { User } from "./User";
+
+interface Emergency {
+  id?: number;
+  createdAt?: string;
+  updatedAt?: string;
+  longitude: number | string | null;
+  latitude: number | string | null;
+  status: 'open' | 'closed';
+  reporterId?: number | null;
+  emergencyType: 'medical' | 'security' | 'fire' | null;
+  primaryText: string;
+  address: string | null;
+  reporter?: User;
+}
+
+export { Emergency };

package/types/Tag.ts

@@ -0,0 +1,19 @@
+interface Tag {
+  id: number;
+  tag: string;
+  createdAt: string;
+  updatedAt: string;
+  content_tag: ContentTag;
+}
+
+interface ContentTag {
+  id: number;
+  createdAt: string;
+  updatedAt: string;
+  contentId: number;
+  tagId: number;
+}
+
+export {
+  Tag
+}

package/types/User.ts

@@ -0,0 +1,52 @@
+import { FriendRequest } from "./Content";
+
+interface User {
+  id: number | null;
+  givenName: string | null;
+  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?
+  latitude: number | string | null; // same as Content interface
+  longitude: number | string | null; // same
+  shareLoc: boolean | null;
+  birthdate: string | null;
+  createdAt: string | null;
+  updatedAt: string | null;
+  imageURL: string | null;
+  friendRequest?: FriendRequest; // 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.)
+}
+
+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
+  userId: number | null;
+  isActiveRole: boolean;
+}
+
+interface UserPlan {
+  status: 'accepted' | 'denied' | 'pending';
+  userId: number;
+  contentId: number;
+  createdAt: string;
+  updatedAt: string;
+  id: number;
+}
+
+interface Sender extends User {
+  shareTimeStamp: ShareTimeStamp;
+}
+
+interface ShareTimeStamp {
+  id: number | null;
+  contentId: number;
+  senderId: number;
+  recipientId: number;
+  createdAt: string;
+  updatedAt: string;
+}
+
+export { User, UserPlan, Sender, UserRole };

package/types/Vote.ts

@@ -0,0 +1,9 @@
+interface Vote {
+  userId: number;
+  contentId: number;
+  vote: 'up'|'down'|null;
+  updatedAt: string;
+  createdAt: string;
+}
+
+export { Vote }