Merge pull request #95 from TogetherCrew/94-add-deletedat-field-to-role-channel-and-guild-member-schemas

[FEATURE]: add deletedAt to channel-role-guild member schema and soft…

Author: cyri113

README.md

@@ -107,6 +107,7 @@ GuildMember {
   isBot?: boolean,
   discriminator?: string,
   permissions?: string;
+  deletedAt?: Date | null
 }
 
 ```
@@ -182,7 +183,8 @@ Channel {
     id: Snowflake,
     name?: string | null,
     parent_id?: string | null,
-    permissionOverwrites?: IOverwrite[]
+    permissionOverwrites?: IOverwrite[],
+    deletedAt?: Date | null
 }
 ```
 
@@ -194,5 +196,6 @@ Role {
     id: Snowflake,
     name: string,
     color: number,
+    deletedAt?: Date | null
 }
 ```

package.json

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

src/interfaces/Channel.interface.ts

@@ -13,14 +13,19 @@ export interface IChannel {
   name?: string | null;
   parentId?: string | null;
   permissionOverwrites?: IOverwrite[];
+  deletedAt?: Date | null;
 }
 
 export interface IChannelUpdateBody {
   name?: string | null;
   parentId?: string | null;
   permissionOverwrites?: IOverwrite[];
+  deletedAt?: Date | null;
+}
+export interface IChannelMethods {
+  softDelete: () => void;
 }
 
-export interface ChannelModel extends Model<IChannel> {
+export interface ChannelModel extends Model<IChannel, Record<string, unknown>, IChannelMethods> {
   paginate: (filter: object, options: object) => any;
 }

src/interfaces/GuildMember.interface.ts

@@ -10,6 +10,7 @@ export interface IGuildMember {
   isBot?: boolean;
   discriminator: string;
   permissions?: string;
+  deletedAt?: Date | null;
 }
 
 export interface IGuildMemberUpdateBody {
@@ -19,8 +20,13 @@ export interface IGuildMemberUpdateBody {
   discriminator?: string;
   joinedAt?: Date | null;
   permissions?: string;
+  deletedAt?: Date | null;
 }
 
-export interface GuildMemberModel extends Model<IGuildMember> {
+export interface IGuildMemberMethods {
+  softDelete: () => void;
+}
+
+export interface GuildMemberModel extends Model<IGuildMember, Record<string, unknown>, IGuildMemberMethods> {
   paginate: (filter: object, options: object) => any;
 }

src/interfaces/Role.interface.ts

@@ -5,13 +5,19 @@ export interface IRole {
   roleId: Snowflake;
   name: string;
   color: number;
+  deletedAt?: Date | null;
 }
 
 export interface IRoleUpdateBody {
   name?: string;
   color?: number;
+  deletedAt?: Date | null;
 }
 
-export interface RoleModel extends Model<IRole> {
+export interface IRoleMethods {
+  softDelete: () => void;
+}
+
+export interface RoleModel extends Model<IRole, Record<string, unknown>, IRoleMethods> {
   paginate: (filter: object, options: object) => any;
 }

src/models/schemas/Channel.schema.ts

@@ -1,6 +1,6 @@
 import { Schema } from 'mongoose';
 import { toJSON } from './plugins';
-import { IChannel, ChannelModel } from '../../interfaces';
+import { type IChannel, type ChannelModel } from '../../interfaces';
 
 const channelSchema = new Schema<IChannel, ChannelModel>({
   channelId: {
@@ -24,6 +24,15 @@ const channelSchema = new Schema<IChannel, ChannelModel>({
       deny: String,
     },
   ],
+  deletedAt: {
+    type: Date,
+    default: null,
+  },
+});
+
+channelSchema.method('softDelete', function softDelete() {
+  this.deletedAt = Date.now();
+  this.save();
 });
 
 // Plugins

src/models/schemas/Guild.schema.ts

@@ -1,6 +1,6 @@
 import { Schema } from 'mongoose';
 import { paginate, toJSON } from './plugins';
-import { IGuild, GuildModel } from '../../interfaces';
+import { type IGuild, type GuildModel } from '../../interfaces';
 
 const guildSchema = new Schema<IGuild, GuildModel>({
   guildId: {
@@ -48,7 +48,7 @@ const guildSchema = new Schema<IGuild, GuildModel>({
     type: Array<number>,
     default: [7, 1],
     validate: {
-      validator: function (arr: Array<number>) {
+      validator: function (arr: number[]) {
         return arr.length === 2;
       },
       message: 'Window must be an array with exactly 2 numbers',
@@ -58,7 +58,7 @@ const guildSchema = new Schema<IGuild, GuildModel>({
     type: Array<number>,
     default: [1, 1, 1, 4, 3, 5, 5, 4, 3, 2, 2, 2, 1],
     validate: {
-      validator: function (arr: Array<number>) {
+      validator: function (arr: number[]) {
         return arr.length === 13;
       },
       message: 'Action must be an array with exactly 11 numbers',

src/models/schemas/GuildMember.schema.ts

@@ -1,6 +1,6 @@
 import { Schema } from 'mongoose';
 import { toJSON } from './plugins';
-import { IGuildMember, GuildMemberModel } from '../../interfaces';
+import { type IGuildMember, type GuildMemberModel } from '../../interfaces';
 
 const guildMemberSchema = new Schema<IGuildMember, GuildMemberModel>({
   discordId: {
@@ -32,6 +32,11 @@ const guildMemberSchema = new Schema<IGuildMember, GuildMemberModel>({
   },
 });
 
+guildMemberSchema.method('softDelete', function softDelete() {
+  this.deletedAt = Date.now();
+  this.save();
+});
+
 // Plugins
 guildMemberSchema.plugin(toJSON);
 

src/models/schemas/HeatMap.schema.ts

@@ -1,6 +1,6 @@
 import { Schema } from 'mongoose';
 import { toJSON } from './plugins';
-import { IHeatMap } from '../../interfaces';
+import { type IHeatMap } from '../../interfaces';
 
 const heatMapSchema = new Schema<IHeatMap>({
   date: {

src/models/schemas/Role.schema.ts

@@ -1,6 +1,6 @@
 import { Schema } from 'mongoose';
 import { toJSON } from './plugins';
-import { IRole, RoleModel } from '../../interfaces';
+import { type IRole, type RoleModel } from '../../interfaces';
 
 const roleSchema = new Schema<IRole, RoleModel>({
   roleId: {
@@ -13,6 +13,15 @@ const roleSchema = new Schema<IRole, RoleModel>({
   color: {
     type: Number,
   },
+  deletedAt: {
+    type: Date,
+    default: null,
+  },
+});
+
+roleSchema.method('softDelete', function softDelete() {
+  this.deletedAt = Date.now();
+  this.save();
 });
 
 // Plugins