refactor: change hooks structure

Author: notwindstone

src/declarations.ts

@@ -5,15 +5,14 @@ import type { getRelativeDate } from "@/lib/helpers/get-relative-date.ts";
 import type { getConfigFile } from "@/lib/main/get-config-file.ts";
 import type { getDefaultConfig } from "@/lib/main/get-default-config.ts";
 import type { initializeConfigFile } from "@/lib/main/initialize-config-file.ts";
+import type { HookReturnType } from "@/types/extensions/hook-return.type.ts";
 import * as TauriApi from "@tauri-apps/api";
-import * as TauriLog from "@tauri-apps/plugin-log";
 import * as TauriFs from "@tauri-apps/plugin-fs";
 
 declare global {
   interface Window {
     "__TAURI__": {
       "api": typeof TauriApi;
-      "log": typeof TauriLog;
       "fs" : typeof TauriFs;
     };
     "__KAEDE__": {
@@ -29,11 +28,10 @@ declare global {
       };
       "hooks": {
         "getConfigFile": {
-          "before": () => Promise<"stop" | void>;
+          "before": HookReturnType<ConfigType>;
         };
         "getDefaultConfig": {
-          "before" : () => Promise<"stop" | void>;
-          "onAbort": () => Promise<ConfigType>;
+          "before": HookReturnType<ConfigType>;
         };
       };
     };

src/lib/handlers/log.ts

@@ -1,4 +1,4 @@
-const { debug, info, warn, error } = window.__TAURI__.log;
+import { debug, info, warn, error } from "@tauri-apps/plugin-log";
 
 // We do not care about promises here
 export const log = {

src/lib/main/declare-window.ts

@@ -20,11 +20,10 @@ export function declareWindow() {
     },
     "hooks": {
       "getConfigFile": {
-        "before": async () => {},
+        "before": [],
       },
       "getDefaultConfig": {
-        "before" : async () => {},
-        "onAbort": async () => getDefaultConfig(),
+        "before": [],
       },
     },
   };

src/lib/main/get-config-file.ts

@@ -2,18 +2,23 @@ import { log } from "@/lib/handlers/log.ts";
 import { ApplicationNamespace, ConfigFilename } from "@/constants/application.ts";
 import { getDefaultConfig } from "@/lib/main/get-default-config.ts";
 import { initializeConfigFile } from "@/lib/main/initialize-config-file.ts";
+import { BaseDirectory, exists, readTextFile } from "@tauri-apps/plugin-fs";
 import { type ConfigType, ConfigValidator } from "@/types/config/config.schema.ts";
-const { BaseDirectory, exists, readTextFile } = window.__TAURI__.fs;
 
 export async function getConfigFile(): Promise<ConfigType> {
-  log.debug("Executing the 'before' method on extensions' hook for 'getConfigFile'");
-  const hookResponse = await window[ApplicationNamespace].hooks.getConfigFile.before();
+  const hooksArray = window[ApplicationNamespace].hooks.getConfigFile.before;
 
-  if (hookResponse === "stop") {
-    log.debug("'getConfigFile.before' hook has aborted execution");
+  log.debug("Starting iterating through hooks for 'getConfigFile.before'");
+  for (const [hookIndex, hookFunction] of hooksArray.entries()) {
+    log.debug("Executing a hook with the next index:", hookIndex.toString());
+    const hookResponse = await hookFunction();
 
-    // Awaiting here will just be an unnecessary action
-    return getDefaultConfig();
+    if (hookResponse.status === "stop") {
+      log.debug(`A hook with the index of ${hookIndex} has aborted execution`);
+
+      // Awaiting here will just be an unnecessary action
+      return hookResponse.response;
+    }
   }
 
   log.debug("Checking if config file exists");

src/lib/main/get-default-config.ts

@@ -1,16 +1,22 @@
 import type { ConfigType } from "@/types/config/config.schema.ts";
 import { log } from "@/lib/handlers/log.ts";
 import { ApplicationNamespace } from "@/constants/application.ts";
-const { getCurrentWindow } = window.__TAURI__.api.window;
+import { getCurrentWindow } from "@tauri-apps/api/window";
 
 export async function getDefaultConfig(): Promise<ConfigType> {
-  log.debug("Executing the 'before' method on extensions' hook for 'getDefaultConfig'");
-  const hookResponse = await window[ApplicationNamespace].hooks.getDefaultConfig.before();
+  const hooksArray = window[ApplicationNamespace].hooks.getDefaultConfig.before;
 
-  if (hookResponse === "stop") {
-    log.debug("'getConfigFile.before' hook has aborted execution");
+  log.debug("Starting iterating through hooks for 'getDefaultConfig.before'");
+  for (const [hookIndex, hookFunction] of hooksArray.entries()) {
+    log.debug("Executing a hook with the next index:", hookIndex.toString());
+    const hookResponse = await hookFunction();
 
-    return await window[ApplicationNamespace].hooks.getDefaultConfig.onAbort();
+    if (hookResponse.status === "stop") {
+      log.debug(`A hook with the index of ${hookIndex} has aborted execution`);
+
+      // Awaiting here will just be an unnecessary action
+      return hookResponse.response;
+    }
   }
 
   log.debug("Getting current window theme");

src/lib/main/initialize-config-file.ts

@@ -1,7 +1,7 @@
 import { ConfigFilename } from "@/constants/application.ts";
 import { getDefaultConfig } from "@/lib/main/get-default-config.ts";
 import { log } from "@/lib/handlers/log.ts";
-const { BaseDirectory, writeFile } = window.__TAURI__.fs;
+import { BaseDirectory, writeFile } from "@tauri-apps/plugin-fs";
 
 export async function initializeConfigFile(): Promise<void> {
   log.debug("Getting default config");

src/lib/main/initialize-launcher.ts

@@ -1,8 +1,8 @@
 import { log } from "@/lib/handlers/log.ts";
 import { getConfigFile } from "@/lib/main/get-config-file.ts";
 import { getDefaultConfig } from "@/lib/main/get-default-config.ts";
+import { getCurrentWebviewWindow } from "@tauri-apps/api/webviewWindow";
 import type { ConfigType } from "@/types/config/config.schema.ts";
-const { getCurrentWebviewWindow } = window.__TAURI__.api.webviewWindow;
 
 export async function initializeLauncher(): Promise<void> {
   let config: ConfigType;

src/types/extensions/hook-return.type.ts

@@ -0,0 +1,10 @@
+/**
+ * Used in '/src/declarations.ts'.
+ * All hooks are promises and are stored in the array to handle multiple hooks
+ */
+export type HookReturnType<T> = Array<() => Promise<{
+  // 'stop' aborts a function that executed current hook
+  "status"  : "stop" | "continue";
+  // if 'status' is 'stop', function will return this field
+  "response": T | Promise<T>;
+}>>;