ref: code clean up + comments

removed sqlite backups lol

Author: GalvinPython

src/index.ts

@@ -9,13 +9,11 @@ import {
     Routes,
     type APIApplicationCommand,
 } from "discord.js";
-import { CronJob } from "cron";
 
 import { env } from "./config.ts";
 import commandsMap from "./commands.ts";
 import initTables from "./utils/db/init.ts";
 import { getTwitchToken } from "./utils/twitch/auth.ts";
-import backup from "./utils/backup.ts";
 
 if (!env.discordToken || env.discordToken === "YOUR_DISCORD_TOKEN") {
     throw new Error("You MUST provide a discord token in .env!");
@@ -36,15 +34,6 @@ if (
     throw new Error("You MUST provide a Twitch client secret in .env!");
 }
 
-// Start the cron jobs
-await fs.mkdir(path.resolve(process.cwd(), "backups"), { recursive: true });
-new CronJob("0 0 * * *", async () => {
-    await backup(
-        path.resolve(process.cwd(), "db.sqlite3"),
-        `./backups/db-${new Date().toISOString().replace(/[:.]/g, "-")}.sqlite3`,
-    );
-}).start();
-
 const client = new Client({
     intents: [GatewayIntentBits.Guilds, GatewayIntentBits.GuildMessages],
 });

src/types/database.d.ts

@@ -1,3 +1,5 @@
+// This file contains TypeScript interfaces for the database schema used in the application.
+// YouTube Table Interface
 export interface dbYouTube {
     youtube_channel_id: string;
     latest_video_id: string | null;
@@ -9,19 +11,22 @@ export interface dbYouTube {
     youtube_channel_is_live: boolean;
 }
 
+// Twitch Table Interface
 export interface dbTwitch {
     twitch_channel_id: string;
     is_live: boolean;
 }
 
-export type dbDiscordTable = {
+// Guild YouTube Subscriptions Table Interface
+export interface dbDiscordTable {
     guild_id: string;
     guild_channel_id: string;
     guild_platform: string;
     platform_user_id: string;
     guild_ping_role: null | string;
-};
+}
 
+// Bot Info Table Interface
 export interface dbBotInfo {
     locked_row: boolean;
     guilds_total: number;

src/types/youtube.d.ts

@@ -1,3 +1,5 @@
+// This file contains TypeScript interfaces for the YouTube API responses and requests used in the bot.
+// YouTube Playlist API Response Interface
 export interface YouTubePlaylistResponse {
     kind: string;
     etag: string;
@@ -55,6 +57,50 @@ export interface YouTubePlaylistResponse {
     };
 }
 
+// YouTube Channel API Response Interface
+export interface YouTubeChannelResponse {
+    kind: string;
+    etag: string;
+    pageInfo: {
+        totalResults: number;
+        resultsPerPage: number;
+    };
+    items: Array<{
+        kind: string;
+        etag: string;
+        id: string;
+        snippet: {
+            title: string;
+            description: string;
+            customUrl: string;
+            publishedAt: string;
+            thumbnails: {
+                default: {
+                    url: string;
+                    width: number;
+                    height: number;
+                };
+                medium: {
+                    url: string;
+                    width: number;
+                    height: number;
+                };
+                high: {
+                    url: string;
+                    width: number;
+                    height: number;
+                };
+            };
+            localized: {
+                title: string;
+                description: string;
+            };
+            country: string;
+        };
+    }>;
+}
+
+// YouTube Innertube Search Request Interface
 export interface InnertubeSearchRequest {
     contents: {
         twoColumnSearchResultsRenderer: {

src/utils/backup.ts

@@ -1,8 +1,14 @@
+// This function checks if a given YouTube channel ID is valid by making a request to the YouTube Data API.
 import { env } from "../../config";
 
 export default async function checkIfChannelIdIsValid(channelId: string) {
+    // Invalid channel ID format
+    if (!channelId.startsWith("UC")) {
+        return false;
+    }
+
     const res = await fetch(
-        `https://www.googleapis.com/youtube/v3/channels?part=snippet&id=${channelId}&key=${env.youtubeApiKey}`,
+        `https://youtube.googleapis.com/youtube/v3/channels?part=snippet&id=${channelId}&key=${env.youtubeApiKey}`,
     );
     const data = await res.json();
 

src/utils/youtube/checkIfChannelIdIsValid.ts

@@ -10,7 +10,7 @@ export default async function (
     channelId: string,
 ): Promise<channelDetails | null> {
     const res = await fetch(
-        `https://www.googleapis.com/youtube/v3/channels?part=snippet&id=${channelId}&key=${env.youtubeApiKey}`,
+        `https://youtube.googleapis.com/youtube/v3/channels?part=snippet&id=${channelId}&key=${env.youtubeApiKey}`,
     );
 
     if (!res.ok) {

src/utils/youtube/getChannelDetails.ts

@@ -1,3 +1,6 @@
+// This function is used when a new channel is being added to the database
+// It will also be used to get the content type of a new upload
+
 import type { YouTubePlaylistResponse } from "../../types/youtube";
 
 import { env } from "../../config";