Merge pull request #320 from Hornwitser/rename-rules

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## UNRELEASED
 
+### Changes
+
+-   Renamed report rules to categories
+
 ### Additions
 
 -   Added in Master Rules API to add and remove rules with a master API key

package.json

@@ -28,7 +28,7 @@
 		"discord.js": "^13.6.0",
 		"dotenv": "^14.2.0",
 		"envalid": "^7.2.2",
-		"fagc-api-types": "^1.7.0",
+		"fagc-api-types": "^1.9.0",
 		"fastify": "^3.26.0",
 		"fastify-autoload": "^3.10.0",
 		"fastify-cors": "^6.0.2",

src/app.ts

@@ -76,7 +76,7 @@ fastify.register(fastifySwagger, {
 		// produces: ["application/json"],
 		tags: [
 			{ name: "community", description: "Community related end-points" },
-			{ name: "rules", description: "Rule related end-points" },
+			{ name: "categories", description: "Category related end-points" },
 			{ name: "reports", description: "Report related end-points" },
 			{ name: "profiles", description: "Profile related end-points" },
 			{
@@ -130,8 +130,8 @@ fastify.addSchema({
 	...generateSchema(Types.Community)
 })
 fastify.addSchema({
-	$id: "RuleClass",
-	...generateSchema(Types.Rule)
+	$id: "CategoryClass",
+	...generateSchema(Types.Category)
 })
 fastify.addSchema({
 	$id: "ReportClass",

src/database/rule.ts → src/database/category.ts

@@ -4,18 +4,18 @@ import IdModel, { IdType } from "./ids"
 
 @modelOptions({
 	schemaOptions: {
-		collection: "rules",
+		collection: "categories",
 	},
 })
-@pre<RuleClass>("save", async function (next) {
+@pre<CategoryClass>("save", async function (next) {
 	if (!this.id || !this._id) {
 		const id = await getUserStringFromID(IdType.COMMUNITY)
 		this.id = id.id
 		this._id = id._id
 	}
 	next()
 })
-export class RuleClass {
+export class CategoryClass {
 	@prop({ unique: true })
 		id!: string
 
@@ -26,9 +26,9 @@ export class RuleClass {
 		longdesc!: string
 }
 
-const RuleModel = getModelForClass(RuleClass)
+const CategoryModel = getModelForClass(CategoryClass)
 
-const watcher = RuleModel.watch()
+const watcher = CategoryModel.watch()
 watcher.on("change", async (change) => {
 	if (change.operationType === "delete") {
 		// delete the ID from the db too
@@ -38,4 +38,4 @@ watcher.on("change", async (change) => {
 	}
 })
 
-export default RuleModel
+export default CategoryModel

src/database/guildconfig.ts

@@ -11,7 +11,7 @@ class Roles {
 	reports!: string
 	webhooks!: string
 	setConfig!: string
-	setRules!: string
+	setCategories!: string
 	setCommunities!: string
 }
 
@@ -36,14 +36,14 @@ export class GuildConfigClass {
 				reports: String,
 				webhooks: String,
 				setConfig: String,
-				setRules: String,
+				setCategories: String,
 				setCommunities: String,
 			}),
 		default: {
 			reports: "",
 			webhooks: "",
 			setConfig: "",
-			setRules: "",
+			setCategories: "",
 			setCommunities: "",
 		}
 	})
@@ -53,7 +53,7 @@ export class GuildConfigClass {
 		trustedCommunities!: string[]
 
 	@prop({ type: [ String ], default: [] })
-		ruleFilters!: string[]
+		categoryFilters!: string[]
 }
 
 const GuildConfigModel = getModelForClass(GuildConfigClass)

src/database/ids.ts

@@ -2,7 +2,7 @@ import { getModelForClass, modelOptions, prop } from "@typegoose/typegoose"
 
 export enum IdType {
 	COMMUNITY = "community",
-	RULE = "rule",
+	CATEGORY = "category",
 	REPORT = "report",
 	REVOCATION = "revocation",
 	LOG = "log",

src/database/reportinfo.ts

@@ -27,7 +27,7 @@ export class ReportInfoClass {
 		communityId!: string
 
 	@prop()
-		brokenRule!: string
+		categoryId!: string
 
 	@prop()
 		proof!: string