Merge pull request #124 from TogetherCrew/123-add-tcaat-to-user-commu…

…nity-schemas-and-isinprogress-to-platform-schema

123 add tcaat to user community schemas and isinprogress to platform schema

README.md

@@ -43,6 +43,7 @@ User {
   discordId: Snowflake,
   email?: string,
   communities?: [Types.ObjectId]
+  tcaAt?: Date;
 }
 ```
 
@@ -54,6 +55,7 @@ Community {
     avatarURL?: string,
     users?: [Types.ObjectId],
     platforms?: [Types.ObjectId],
+    tcaAt?: Date;
 }
 ```
 
@@ -65,6 +67,7 @@ Platform {
     community: Types.ObjectId,
     metadata?: Record<string, any>, // dynamic object since structure can change
     disconnectedAt?: Date | null,
+    isInProgress?: boolean;
 }
 ```
 ### Heatmap interface

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@togethercrew.dev/db",
-  "version": "3.0.12",
+  "version": "3.0.13",
   "description": "All interactions with DB",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

src/interfaces/Community.interface.ts

@@ -5,13 +5,15 @@ export interface ICommunity {
   avatarURL?: string;
   users: Types.ObjectId[];
   platforms?: Types.ObjectId[];
+  tcaAt?: Date;
 }
 
 export interface ICommunityUpdateBody {
   name?: string;
   avatarURL?: string;
   users?: Types.ObjectId[];
   platforms?: Types.ObjectId[];
+  tcaAt?: Date;
 }
 
 export interface CommunityModel extends Model<ICommunity> {

src/interfaces/Platfrom.interface.ts

@@ -5,13 +5,15 @@ export interface IPlatform {
   community: Types.ObjectId;
   metadata?: Record<string, any>; // dynamic object since structure can change
   disconnectedAt?: Date | null;
+  isInProgress?: boolean;
 }
 
 export interface IPlatformUpdateBody {
   name?: string;
   community?: Types.ObjectId;
   metadata?: Record<string, any>;
   disconnectedAt?: Date | null;
+  isInProgress?: boolean;
 }
 
 export interface PlatformModel extends Model<IPlatform> {

src/interfaces/User.interface.ts

@@ -5,11 +5,13 @@ export interface IUser {
   discordId: Snowflake;
   email?: string;
   communities?: Types.ObjectId[];
+  tcaAt?: Date;
 }
 
 export interface IUserUpdateBody {
   email?: string;
   communities?: Types.ObjectId[];
+  tcaAt?: Date;
 }
 
 export interface UserModel extends Model<IUser> {

src/models/schemas/Community.schema.ts

@@ -26,6 +26,9 @@ const communitySchema = new Schema<ICommunity, CommunityModel>(
         ref: 'Platform',
       },
     ],
+    tcaAt: {
+      type: Date,
+    },
   },
 
   { timestamps: true },

src/models/schemas/Platform.schema.ts

@@ -21,6 +21,10 @@ const platformSchema = new Schema<IPlatform, PlatformModel>(
       type: Date,
       default: null,
     },
+    isInProgress: {
+      type: Boolean,
+      default: true,
+    },
   },
 
   { timestamps: true },

src/models/schemas/User.schema.ts

@@ -21,6 +21,9 @@ const userSchema = new Schema<IUser, UserModel>(
         ref: 'Community',
       },
     ],
+    tcaAt: {
+      type: Date,
+    },
   },
   { timestamps: true },
 );