dev/refactor

.env.example

@@ -1,20 +1,52 @@
-# Environnement (dev | prod)
-ENVIRONNEMENT=prod
+# Bot Identifier
 BOT_ID=
 
-#Votes
-TOPGG_VOTE_WEBHOOK=topggWebhookKeyHere
-VCODES_VOTE_WEBHOOK=vCodesWebhookKeyHere
-DLIST_VOTE_WEBHOOK=dlistWebhookKeyHere
-WUMPUSSTORE_VOTE_WEBHOOK=wumpusStoreWebhookKeyHere
-# payments
-TEBEX_KEY=putyourtebexencryptionkeyhere
+# Server port
+PORT=
 
-# internal api key
+# Rate Limit IP
+RATE_LIMIT_IP_ACCESS= # default 100
+RATE_LIMIT_IP_TIME= # default 15m
+
+# Rate Limit Token
+RATE_LIMIT_TOKEN_ACCESS= # default 100
+RATE_LIMIT_TOKEN_TIME= # default 15m
+
+# Voting webhook URLs for various services
+TOPGG_VOTE_WEBHOOK=
+VCODES_VOTE_WEBHOOK=
+DLIST_VOTE_WEBHOOK=
+WUMPUSSTORE_VOTE_WEBHOOK=
+
+# Tebex payment API key
+TEBEX_API_KEY=
+
+# Internal API key for secured access
 INTERNAL_API_KEY=
 
-# emails
+# SendGrid API key for sending emails
 SENDGRID_API_KEY=
 
-# integrations
-DC_API_KEY=
+# DoubleCounter integration API key
+DC_API_KEY=
+
+# Configuration for Prod DB
+PROD_DB_HOST=localhost
+PROD_DB_PORT=3306
+PROD_DB_USERNAME=root
+PROD_DB_PASSWORD=password
+PROD_DB_DATABASE=bot
+
+# Configuration for Dashboard DB
+DASH_DB_HOST=localhost
+DASH_DB_PORT=3306
+DASH_DB_USERNAME=root
+DASH_DB_PASSWORD=password
+DASH_DB_DATABASE=dash
+
+# Configuration for Bot DB
+BOT_DB_HOST=localhost
+BOT_DB_PORT=3306
+BOT_DB_USERNAME=root
+BOT_DB_PASSWORD=password
+BOT_DB_DATABASE=bot

.eslintrc.json

@@ -0,0 +1,23 @@
+{
+  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint", "prettier"],
+  "ignorePatterns": ["bin", "node_modules"],
+  "rules": {
+    "indent": ["error", 2, { "SwitchCase": 1, "ignoredNodes": ["PropertyDefinition"] }],
+    "linebreak-style": ["error", "unix"],
+    "quotes": ["error", "double"],
+    "semi": ["error", "always"],
+    "no-case-declarations": "off",
+    "prettier/prettier": "error",
+    "@typescript-eslint/no-explicit-any": "off"
+  },
+  "env": {
+    "es2021": true,
+    "node": true
+  }
+}

.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

.gitignore

@@ -65,9 +65,6 @@ typings/
 # Output of 'npm pack'
 *.tgz
 
-# Yarn Integrity file
-.yarn-integrity
-
 # dotenv environment variables file
 .env
 .env.test
@@ -103,6 +100,12 @@ dist
 # TernJS port file
 .tern-port
 
+# JetBrains
+.idea/
+
+# VSCode
+.vscode/
+
 # custom
-bin/*
-ormconfig.json
+bin/
+ormconfig.json

.husky/commit-msg

@@ -0,0 +1,21 @@
+#!/bin/sh
+
+commit_msg=$(cat "$1")
+
+types="feat|fix|refactor|docs|style|test|chore|ci|perf|revert"
+
+if ! echo "$commit_msg" | grep -Eq "^($types)"; then
+  echo ""
+  echo "ERROR: Missing or incorrect commit type."
+  echo "The commit message must start with one of the following types: $types"
+  echo ""
+  exit 1
+fi
+
+if ! echo "$commit_msg" | grep -Eq ": [a-z].{2,75}$"; then
+  echo ""
+  echo "ERROR: Missing or incorrect commit description."
+  echo "The commit description must be written in lowercase and be between 3 and 75 characters long."
+  echo ""
+  exit 1
+fi

.husky/pre-commit

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+npm run lint:staged

.prettierrc.json

@@ -0,0 +1,9 @@
+{
+  "semi": true,
+  "useTabs": false,
+  "trailingComma": "es5",
+  "singleQuote": false,
+  "printWidth": 120,
+  "tabWidth": 2,
+  "endOfLine": "lf"
+}

LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2021-2024 chaun14
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

config/config.ts

@@ -0,0 +1,96 @@
+const { env } = process;
+
+export enum Environments {
+  DEVELOPMENT,
+  PRODUCTION,
+}
+
+const parseRateLimitTime = (timeValue?: string) => {
+  if (!timeValue) return 15 * 60 * 1000;
+
+  const unit = timeValue.slice(-1);
+  const time = Number(timeValue.slice(0, -1));
+
+  console.log(unit);
+
+  switch (unit) {
+    case "h":
+      return time * 60 * 60 * 1000;
+    case "m":
+      return time * 60 * 1000;
+    case "s":
+      return time * 1000;
+    default:
+      throw new Error(`Unexpected unit for RATE_LIMIT_TIMEt: ${unit}. Accepted unit: 'h', 'm' and 's'`);
+  }
+};
+
+const config = {
+  // Bot Id
+  botId: env.BOT_ID,
+
+  // Rate limit
+  rateLimit: {
+    ip: {
+      max: env.RATE_LIMIT_IP_ACCESS ? Number(env.RATE_LIMIT_IP_TIME) : 100,
+      time: parseRateLimitTime(env.RATE_LIMIT_IP_TIME),
+    },
+    token: {
+      max: env.RATE_LIMIT_TOKEN_ACCESS ? Number(env.RATE_LIMIT_TOKEN_TIME) : 100,
+      time: parseRateLimitTime(env.RATE_LIMIT_TOKEN_TIME),
+    },
+  },
+
+  // Port number for the server
+  port: env.PORT,
+
+  // Environment type (development || production)
+  environment: env.NODE_ENV === "production" ? Environments.PRODUCTION : Environments.DEVELOPMENT,
+
+  // Webhook configurations for votes
+  voteWebhooks: {
+    topgg: env.TOPGG_VOTE_WEBHOOK,
+    vcodes: env.VCODES_VOTE_WEBHOOK,
+    dlist: env.DLIST_VOTE_WEBHOOK,
+    wumpus: env.WUMPUSSTORE_VOTE_WEBHOOK,
+  },
+
+  // Tebex payment API key
+  tebexKey: env.TEBEX_API_KEY,
+
+  // Internal API key for secured access
+  internalApiKey: env.INTERNAL_API_KEY,
+
+  // SendGrid API key for sending emails
+  sendgridApiKey: env.SENDGRID_API_KEY,
+
+  // DoubleCounter integration API key
+  dcApiKey: env.DC_API_KEY,
+
+  // Database configurations
+  databases: {
+    dash: {
+      host: env.DASH_DB_HOST,
+      port: Number(env.DASH_DB_PORT),
+      username: env.DASH_DB_USERNAME,
+      password: env.DASH_DB_PASSWORD,
+      database: env.DASH_DB_DATABASE,
+    },
+    bot: {
+      host: env.BOT_DB_HOST,
+      port: Number(env.BOT_DB_PORT),
+      username: env.BOT_DB_USERNAME,
+      password: env.BOT_DB_PASSWORD,
+      database: env.BOT_DB_DATABASE,
+    },
+    prod: {
+      host: env.PROD_DB_HOST,
+      port: Number(env.PROD_DB_PORT),
+      username: env.PROD_DB_USERNAME,
+      password: env.PROD_DB_PASSWORD,
+      database: env.PROD_DB_DATABASE,
+    },
+  },
+};
+
+export default config;

config/ormconfig.ts

@@ -0,0 +1,34 @@
+import { DataSource, DataSourceOptions } from "typeorm";
+
+import Applications from "@entity/dash/Applications.js";
+import Payments from "@entity/dash/Payments.js";
+import PremiumPlans from "@entity/dash/PremiumPlans.js";
+import PremiumServices from "@entity/dash/PremiumServices.js";
+import Votes from "@entity/dash/Votes.js";
+import CustomInvites from "@entity/bot/CustomInvites.js";
+import GuildSettings from "@entity/bot/GuildSettings.js";
+import Joins from "@entity/bot/Joins.js";
+
+const entities: { dash: object[]; bot: object[]; prod: object[] } = {
+  dash: [Applications, Payments, PremiumPlans, PremiumServices, Votes],
+  bot: [CustomInvites, GuildSettings, Joins],
+  prod: [CustomInvites, GuildSettings, Joins],
+};
+
+import config from "@config";
+
+const createDataSourceOptions = (name: string): DataSourceOptions => ({
+  type: "mysql",
+  host: config.databases[name]["host"]!,
+  port: config.databases[name]["port"]!,
+  username: config.databases[name]["username"]!,
+  password: config.databases[name]["password"]!,
+  database: config.databases[name]["database"]!,
+  synchronize: false,
+  logging: ["error", "warn"],
+  entities: entities[name],
+});
+
+export const dashDataSource = new DataSource(createDataSourceOptions("dash"));
+export const customBotDataSource = new DataSource(createDataSourceOptions("bot"));
+export const prodbotDataSource = new DataSource(createDataSourceOptions("prod"));