Merge pull request #117 from TogetherCrew/114-new-db-models-schema-an…

…d-methods

114 new db models schema and methods

README.md

@@ -35,56 +35,39 @@ docker compose -f docker-compose.test.yml up --exit-code-from app --build
 
 Note: This will create a /coverage folder where you can review the coverage details.
 
-### Schema for rawinfo
+
+### User interface
 
 ```ts
-rawinfo {
-  type: number,
-  author: Snowflake,
-  content: string,
-  createdDate: Date,
-  user_mentions: Array<Snowflake>,
-  role_mentions: Array<Snowflake>,
-  reactions: Array<Snowflake>,
-  replied_user: Snowflake | null | undefined,
-  messageId: Snowflake,
-  channelId: Snowflake,
-  channelName: string | null,
-  threadId: Snowflake | null,
-  threadName: string | null,
-  isGeneratedByWebhook: boolean
+User {
+  discordId: Snowflake,
+  email?: string,
+  communities?: [Types.ObjectId]
 }
 ```
 
-### Schema for user
+### Community interface
 
 ```ts
-User {
-    discordId: Snowflake,
-    username?: string,
-    discriminator?: string,
-    avatar?: string,
-    bot?: boolean,
-    system?: boolean,
-    mfa_enabled?: boolean,
-    banner?: string,
-    accent_color?: number
-    locale?: string,
-    verified?: boolean
-    email?: string,
-    flags?: number,
-    premium_type?: number,
-    public_flags?: number,
-    twitterId?: string,
-    twitterUsername?: string,
-    twitterProfileImageUrl?: string,
-    twitterConnectedAt?:string,
-    twitterIsInProgress?:boolean
-
+Community {
+    name: string,
+    avatarURL?: string,
+    users?: [Types.ObjectId],
+    platforms?: [Types.ObjectId],
 }
 ```
 
-### Schema for heatmap
+### Platform interface
+
+```ts
+Platform {
+    name: string,
+    community: Types.ObjectId,
+    metadata?: Record<string, any>, // dynamic object since structure can change
+    disconnectedAt?: Date | null,
+}
+```
+### Heatmap interface
 
 ```ts
 HeatMap {
@@ -105,7 +88,7 @@ HeatMap {
 }
 ```
 
-### Schema for guildMembers
+### GuildMembers interface
 
 ```ts
 GuildMember {
@@ -124,7 +107,52 @@ GuildMember {
 
 ```
 
-### Schema for memberactivities
+### Channel interface
+
+```ts
+Channel {
+    id: Snowflake,
+    name?: string | null,
+    parent_id?: string | null,
+    permissionOverwrites?: IOverwrite[],
+    deletedAt?: Date | null
+}
+```
+
+
+### Role interface
+
+```ts
+Role {
+    id: Snowflake,
+    name: string,
+    color: number,
+    deletedAt?: Date | null
+}
+```
+
+### Rawinfo interface
+
+```ts
+rawinfo {
+  type: number,
+  author: Snowflake,
+  content: string,
+  createdDate: Date,
+  user_mentions: Array<Snowflake>,
+  role_mentions: Array<Snowflake>,
+  reactions: Array<Snowflake>,
+  replied_user: Snowflake | null | undefined,
+  messageId: Snowflake,
+  channelId: Snowflake,
+  channelName: string | null,
+  threadId: Snowflake | null,
+  threadName: string | null,
+  isGeneratedByWebhook: boolean
+}
+```
+
+### Memberactivities interface
 
 ```ts
 memberactivities {
@@ -153,7 +181,7 @@ memberactivities {
 }
 ```
 
-### Schema for token
+### Token interface
 
 ```ts
 Token {
@@ -163,51 +191,4 @@ Token {
     expires: Date,
     blacklisted?: boolean
 }
-```
-
-### Schema for guild
-
-```ts
-Guild {
-    guildId: Snowflake,
-    user: Snowflake,
-    name?: string,
-    connectedAt?: Date,
-    isInProgress?: Boolean,
-    isDisconnected?: Boolean,
-    icon?: string,
-    selectedChannels?: Array<objects> [
-        {
-            channelId: Snowflake,
-            channelName?: string
-        }
-    ],
-    period?: Date,
-    aciton: Array<number>,
-    window: Array<number>
-}
-```
-
-### Schema for channel
-
-```ts
-Channel {
-    id: Snowflake,
-    name?: string | null,
-    parent_id?: string | null,
-    permissionOverwrites?: IOverwrite[],
-    deletedAt?: Date | null
-}
-```
-
-
-### Schema for role
-
-```ts
-Role {
-    id: Snowflake,
-    name: string,
-    color: number,
-    deletedAt?: Date | null
-}
-```
+```

__tests__/unit/models/community.mode.test.ts

@@ -0,0 +1,19 @@
+import { Community } from '../../../src/models';
+import { ICommunity } from '../../../src/interfaces';
+import { Types } from 'mongoose';
+
+describe('Community model', () => {
+  describe('Community validation', () => {
+    let community: ICommunity;
+    beforeEach(() => {
+      community = {
+        name: 'community1',
+        users: [new Types.ObjectId()],
+      };
+    });
+
+    test('should correctly validate a valid community', async () => {
+      await expect(new Community(community).validate()).resolves.toBeUndefined();
+    });
+  });
+});

__tests__/unit/models/platform.model.test.ts

@@ -0,0 +1,19 @@
+import { Platfrom } from '../../../src/models';
+import { IPlatform } from '../../../src/interfaces';
+import { Types } from 'mongoose';
+
+describe('Platfrom model', () => {
+  describe('Platform validation', () => {
+    let platfrom: IPlatform;
+    beforeEach(() => {
+      platfrom = {
+        name: 'Discord',
+        community: new Types.ObjectId(),
+      };
+    });
+
+    test('should correctly validate a valid platfrom', async () => {
+      await expect(new Platfrom(platfrom).validate()).resolves.toBeUndefined();
+    });
+  });
+});

package.json

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

src/interfaces/Community.interface.ts

@@ -0,0 +1,19 @@
+import { type Model, type Types } from 'mongoose';
+
+export interface ICommunity {
+  name: string;
+  avatarURL?: string;
+  users: [Types.ObjectId];
+  platforms?: [Types.ObjectId];
+}
+
+export interface ICommunityUpdateBody {
+  name?: string;
+  avatarURL?: string;
+  users?: [Types.ObjectId];
+  platforms?: [Types.ObjectId];
+}
+
+export interface CommunityModel extends Model<ICommunity> {
+  paginate: (filter: object, options: object) => any;
+}

src/interfaces/Platfrom.interface.ts

@@ -0,0 +1,19 @@
+import { type Model, type Types } from 'mongoose';
+
+export interface IPlatform {
+  name: string;
+  community: Types.ObjectId;
+  metadata?: Record<string, any>; // dynamic object since structure can change
+  disconnectedAt?: Date | null;
+}
+
+export interface IPlatformUpdateBody {
+  name?: string;
+  community?: Types.ObjectId;
+  metadata?: Record<string, any>;
+  disconnectedAt?: Date | null;
+}
+
+export interface PlatformModel extends Model<IPlatform> {
+  paginate: (filter: object, options: object) => any;
+}