🥳 v2.0.0 | Plugin Sistemi!

- Plugin sistemi!
- Otomatik plugin tip oluşturucu!

Co-Authored-By: Erdem <[email protected]>

Author: TheArmagan

config.js

@@ -107,7 +107,6 @@ module.exports = new (require("./types/Config"))({
   async onReady(client) {
     console.log("[CONFIG] Discord hesabına giriş yaptıktan sonra çalıştı.");
     client.user.setActivity(`/help - Basit Altyapı by TheArmagan`, { type: "WATCHING" });
-
   },
   // interaksiyon üzerinde hiçbir kontrol yapılmadan önce çalışır.
   // Sadece cevap true ise işleme devam eder.
@@ -141,4 +140,4 @@ module.exports = new (require("./types/Config"))({
   async onAfterEvent(eventName, [arg1, arg2], other) {
 
   },
-})
+})

events/-ornekPluginOlay.js

@@ -0,0 +1,6 @@
+module.exports = new Underline.Event({
+  eventName: "mongooseDatabase:onConnect",
+  async onEvent(connected) {
+    console.log(`[DATABASE] ${ connected ? "Bağlandı": "Bağlanamadı" }!`);
+  }
+})

generated/pluginTypes.d.ts

@@ -0,0 +1,6 @@
+export class Types {
+  ["mongooseDatabase"]: { connection: import("mongoose").Connection, connect: import("mongoose").connect, addModel: (name: string, schema: import("mongoose").Schema, collection?: string, options?: import("mongoose").CompileModelOptions)=>any, getModel: (name: string) => import("mongoose").Model, Schema: import("mongoose").Schema };
+};
+export type TEventNames = "mongooseDatabase:onConnect";
+export type TEvents = mongooseDatabase_onConnect;
+export interface mongooseDatabase_onConnect { eventName: "mongooseDatabase:onConnect", onEvent: (arg0: boolean) => void }

globals.d.ts

@@ -16,6 +16,8 @@ interface Underline {
   Button: typeof import("./types/Button"),
   SelectMenu: typeof import("./types/SelectMenu"),
   Locale: typeof import("./types/Locale"),
+  plugins: import("./generated/pluginTypes").Types,
+  Plugin: typeof import("./types/Plugin"),
 
   reload(): Promise<any>;
 

index.js

@@ -23,7 +23,8 @@ let onFunctions = {
   onInteraction: [config.onInteraction],
   onAfterInteraction: [config.onAfterInteraction],
   onEvent: [config.onEvent],
-  onAfterEvent: [config.onAfterEvent]
+  onAfterEvent: [config.onAfterEvent],
+  onReady: [config.onReady],
 };
 globalThis.Underline = {
   ...config.globalObjects,
@@ -44,6 +45,7 @@ globalThis.Underline = {
   SelectMenu: require("./types/SelectMenu"),
   Button: require("./types/Button"),
   Locale: require("./types/Locale"),
+  Plugin: require("./types/Plugin"),
 }
 
 const extractZip = require("extract-zip");
@@ -65,7 +67,7 @@ async function getPluginFilePaths() {
       let folderPath = path.resolve(pluginsPath, folderOrZip.name.replace(".up.zip", ".up"));
       let zipPath = path.resolve(pluginsPath, folderOrZip.name);
 
-      await fs.promises.rmdir(folderPath, {recursive: true}).catch(() => {});
+      await fs.promises.rm(folderPath, {recursive: true}).catch(() => {});
       await makeSureFolderExists(folderPath);
       await extractZip(zipPath, { dir: folderPath });
       fs.promises.unlink(zipPath).catch(() => null);
@@ -119,7 +121,8 @@ async function load() {
     onInteraction: [config.onInteraction],
     onAfterInteraction: [config.onAfterInteraction],
     onEvent: [config.onEvent],
-    onAfterEvent: [config.onAfterEvent]
+    onAfterEvent: [config.onAfterEvent],
+    onReady: [config.onReady],
   };
 
   let loadStart = Date.now();
@@ -144,6 +147,7 @@ async function load() {
   })
 
   pluginFiles = await getPluginFilePaths();
+  let pluginCache = [];
   await chillout.forEach(pluginFiles, (pluginFile) => {
     let start = Date.now();
     let rltPath = path.relative(__dirname, pluginFile);
@@ -158,10 +162,25 @@ async function load() {
     if (Underline.plugins[plugin.namespace])
       return console.warn(`[UYARI] ${plugin.name} plugini zaten yüklenmiş. Atlanıyor..`);
 
+    pluginCache.push(plugin);
+    console.info(`[BİLGİ] "${plugin.name}" plugini yüklenme sırasına alındı. (${Date.now() - start}ms sürdü.)`);
+    
+  })
+
+  pluginCache = pluginCache.sort((plugin, dependency) => plugin?.requires?.plugins?.includes(dependency) ? 1 : 0);
+
+  let pluginSort = utils.sortDependant(pluginCache.map(i=>i.namespace), Object.fromEntries(pluginCache.map(i => [i.namespace, i?.requires?.plugins || []])))
+
+  await chillout.forEach(pluginSort, async (pluginNamespace) => {
+    let start = Date.now();
+
+    const plugin = pluginCache.find(x => x.namespace === pluginNamespace);
+    
     const pluginApi = {};
+    let isReady = false;
 
-    pluginApi.ready = async () => { 
-      if (isReady) throw new Error("Plugin already ready!")
+    pluginApi.setPluginReady = async () => { 
+      if (isReady) throw new Error("Plugin is already ready!")
       isReady = true;
     }
 
@@ -181,18 +200,20 @@ async function load() {
 
     pluginApi.onEvent = onFunctions.onEvent.push;
     pluginApi.onAfterEvent = onFunctions.onAfterEvent.push;
+    pluginApi.onBotReady = onFunctions.onReady.push;
 
     pluginApi.client = client;
 
     plugin.onLoad(pluginApi);
+    console.info(`[BİLGİ] "${plugin.name}" pluginin yüklenmesi bekleniyor!`);	
     await chillout.waitUntil(() => {
       if (isReady) return chillout.StopIteration;
     })
-    
-    console.info(`[BİLGİ] "${plugin.name}" plugini yüklendi. (${Date.now() - start}ms sürdü.)`);
+    console.info(`[BİLGİ] "${plugin.name}" plugini yüklendi! (${Date.now() - start}ms sürdü.)`);	
   })
 
-  
+
+  for (let ind in onFunctions) onFunctions[ind] = onFunctions[ind].filter(x => typeof x === "function");
 
   interactionFiles = await getInteractionFilePaths();
   await chillout.forEach(interactionFiles, (interactionFile) => {
@@ -612,7 +633,7 @@ client.on("interactionCreate", async (interaction) => {
   let now = Date.now();
 
   for (let k in converter) {
-    let keyCooldown = uInter.coolDowns.get(key);
+    let keyCooldown = uInter.coolDowns.get(k);
     if (now < keyCooldown) {
       config.userErrors.coolDown(interaction, uInter, keyCooldown - now, k, other);
       return;
@@ -677,6 +698,16 @@ client.on("interactionCreate", async (interaction) => {
   await client.login(config.clientToken);
 
   config.onReady(client);
+  quickForEach(onFunctions.onReady, async (func) => {
+    try {
+      func?.catch?.(() => {
+
+      });
+    } catch (err) {
+
+    }
+    
+  })
 })();
 
 Underline.reload = reload;

other/pluginTypesGenerator.js

@@ -0,0 +1,139 @@
+require("./patchConsoleLog");
+
+const chillout = require("chillout");
+const fs = require("fs");
+const extractZip = require("extract-zip");
+const { makeSureFolderExists } = require("stuffs");
+const path = require("path");
+
+globalThis.Underline = {
+  Plugin: require("../types/Plugin")
+};
+
+(async () => {
+  let pluginFiles = await getPluginFilePaths();
+  let pluginTypes = [];
+  let TEventNames = [];
+  let TEvents = [];
+  let TInterfaces = [];
+  let loadedNamespaces = [];
+  await chillout.forEach(pluginFiles, async (pluginFile) => {
+    let rltPath = path.relative(__dirname, pluginFile);
+    console.info(`[BİLGİ] "${rltPath}" konumundaki plugin yükleniyor..`)
+    /** @type {import("../types/Plugin")} */
+    let plugin = require(pluginFile);
+    console.info("Plugin:", plugin._type, plugin.namespace,plugin);
+    // console.log(plugin)
+
+    if (plugin._type != "plugin")
+      return console.warn(`[UYARI] "${rltPath}" plugin dosyası boş. Atlanıyor..`);
+
+    if (loadedNamespaces.find(x => x == plugin.namespace))
+      return console.warn(`[UYARI] ${plugin.name} plugini zaten yüklenmiş. Atlanıyor..`);
+
+    loadedNamespaces.push(plugin.namespace);
+    
+    let parsedPluginPath = path.parse(pluginFile);
+    // console.log(parsedPluginPath)
+    
+    let dtsPath = "";
+
+    switch (parsedPluginPath.dir.split(path.sep).pop()) {
+      case "plugins": {
+        dtsPath = path.resolve(parsedPluginPath.dir, parsedPluginPath.base.replace(".up.js", ".up.d.ts"));
+        break;
+      }
+      default: {
+        dtsPath = path.resolve(parsedPluginPath.dir, "index.d.ts");
+        break;
+      }
+    }
+    console.log(dtsPath);
+    let isDTS = fs.existsSync(dtsPath);
+  
+    if (isDTS) {
+      pluginTypes.push(`["${plugin.namespace}"]: import("${path.relative(process.cwd(), dtsPath).replace(".d.ts", "").replaceAll(path.sep, "/")}").Plugin`);
+    } else {
+      // let implements = Object.entries(plugin.implements.properties);
+      if (!plugin?.implements?.properties) return;
+      let result = []
+      for (let property in plugin.implements.properties) {
+        let returns = plugin.implements.properties[property];
+        let returnsString = generateReturn(returns);
+        result.push(`${property}: ${returnsString}`)
+      }
+      result = `{ ${result.join(", ")} }`;
+      pluginTypes.push(`["${plugin.namespace}"]: ${result}`);
+    }
+
+    if (plugin?.implements?.events) {
+      for (let eventName in plugin.implements.events) {
+        let args = plugin.implements.events[eventName].split(/ *, */).map(x => x.includes(":") ? (x.split(":")[0] + ":" + generateReturn(x.split(":")[1])) : generateReturn(x));
+        TEventNames.push(`"${plugin.namespace}:${eventName}"`);
+        TInterfaces.push(`export interface ${plugin.namespace}_${eventName.replace(/ |-/, "")} { eventName: "${plugin.namespace}:${eventName}", onEvent: (${!args?.[0] ? "" : args.map((v, i) => v.includes(":") ? v : `arg${i}: ${v}`).join(", ")}) => void }`);
+        TEvents.push(`${plugin.namespace}_${eventName.replace(/ |-/, "")}`);
+
+      }
+    }
+    
+    console.info(`[BİLGİ] "${plugin.name}" plugini tipi çıkartıldı.`);
+  });
+
+  await makeSureFolderExists(path.resolve(__dirname, "../generated"));
+  let result = `export class Types {\n${pluginTypes.map(i => `  ${i};`).join("\n")}\n};\n${TEventNames.length ? `export type TEventNames = ${TEventNames.join(" | ")};` : ""}\n${TEvents.length ? `export type TEvents = ${TEvents.join(" | ")};` : ""}\n${TInterfaces.join("\n")}\n`.trim();
+  console.info(result);
+  await fs.promises.writeFile(path.resolve(__dirname, "../generated/pluginTypes.d.ts"), result);
+
+
+})();
+
+function generateReturn(returns) {
+  let returnsString = "";
+  switch (returns) {
+    case "function": {
+      returnsString = "(...args: any[]) => any";
+      break;
+    }
+    case "object": {
+      returnsString = "{ [key:string|number]: any }";
+      break;
+    }
+    case "array": {
+      returnsString = "any[]";
+      break;
+    }
+    default: {
+      returnsString = returns;
+    }
+  }
+  return returnsString;
+}
+
+async function getPluginFilePaths() {
+  let pluginsPath = path.resolve(__dirname, "../plugins");
+  await makeSureFolderExists(pluginsPath);
+  let folderOrZips = await fs.promises.readdir(pluginsPath, { withFileTypes: true });
+  let result = [];
+  for (let i = 0; i < folderOrZips.length; i++) {
+    const folderOrZip = folderOrZips[i];
+    if (folderOrZip.isDirectory() && folderOrZip.name.endsWith(".up")) {
+      if (folderOrZip.name.startsWith("-")) continue;
+      result.push(path.resolve(pluginsPath, folderOrZip.name, "index.js"));
+    } else if (folderOrZip.name.endsWith(".up.js")) {
+      if (folderOrZip.name.startsWith("-")) continue;
+      result.push(path.resolve(pluginsPath, folderOrZip.name));
+    } else if (folderOrZip.name.endsWith(".up.zip")) {
+      let folderPath = path.resolve(pluginsPath, folderOrZip.name.replace(".up.zip", ".up"));
+      let zipPath = path.resolve(pluginsPath, folderOrZip.name);
+
+      await fs.promises.rm(folderPath, {recursive: true}).catch(() => {});
+      await makeSureFolderExists(folderPath);
+      await extractZip(zipPath, { dir: folderPath });
+      fs.promises.unlink(zipPath).catch(() => null);
+      if (folderOrZip.name.startsWith("-")) continue;
+      result.push(path.resolve(folderPath, "index.js"));
+    }
+  }
+  console.log(result)
+  return result;
+}

other/utils.js

@@ -9,5 +9,21 @@ module.exports = {
       },
     });
     return true;
+  },
+  /**
+   * @param {string[]} names 
+   * @param {{[key: string]: string[]}} obj 
+   * @param {string[]?} start 
+   * @param {number?} depth 
+   * @returns {string[]}
+   */
+  sortDependant(names, obj, start=[], depth = 0) {
+    const processed = names.reduce((a, b, i) => {
+      if (obj[b].every(Array.prototype.includes, a)) a.push(b)
+      return a
+    }, start)
+    const nextNames = names.filter(n => !processed.includes(n)),
+      goAgain = nextNames.length && depth <= names.length
+    return goAgain ? this.sortDependant(nextNames, obj, processed, depth + 1) : processed
   }
 }

package.json

@@ -33,7 +33,8 @@
   "scripts": {
     "interaksiyon": "node ./other/generator.js interaction",
     "olay": "node ./other/generator.js event",
-    "baslat": "node index.js"
+    "baslat": "node index.js",
+    "plugin-tipleri": "node ./other/pluginTypesGenerator.js"
   },
   "bugs": {
     "url": "https://github.com/TheArmagan/basit-altyapi/issues"

plugins/database.up.zip

@@ -1,9 +1,11 @@
-# Basit Altyapı (Versiyon 1.9.9) (v13.x)
+# Basit Altyapı (Versiyon 2.0.0) (v13.x)
 
 Kullanımı basit ancak bir yandanda içinde birçek özellik barındıran discord bot altyapısı. Sık sık güncelleme alıyor. (Slash Commands)
 
 ## Özellikler
 
+- ✅ **Plugin sistemi!** *- Altyapıya istediğiniz özellikleri parça parça ekleyin!*
+- ✅ Pluginler TAM tip desteği! `yarn plugin-tipleri`
 - ✅ **Çoklu dil desteği.**
 - ✅ **Sunucuya özel komut paylaşma tipleri.**
 - ✅ **SelectMenu ve Button desteği.**
@@ -62,10 +64,6 @@ Kullanımı basit ancak bir yandanda içinde birçek özellik barındıran disco
 - Olaylar için `events` klasörünün içindeki [`-ornekOlay.js`](./events/-ornekOlay.js) dosyasını dikkatlice okuyabilirsiniz.
 - Yeni bir olay dosyası oluşturmak isterseniz `yarn olay` interaksiyonunu kullanabilsiniz. Bu sayede sizi ilk olay altyapısını yazma derdinden kurtaracak ve olay hakkında her türlü soruyu soracaktır.
 
-## Güncelleme
-
-- Güncelleme yaparken yapmanız gereken sadece `types klasörünü`, `other klasörünü`, `index.js dosyası`, `package.json dosyasını` eskisi ile değiştirmek.
-
 ## Yardım
 
 - Eğer buradaki herşeyi okudunuz ama bir şey anlamadıysanız, salaklar için tasarlanmış olan [Basit Altyapı Rehberi](https://www.youtube.com/watch?v=bQ9ZLpfyCyY&list=PLONuYdOGaaL3m705lBXLAp2okk0TE5EiO) serimizi izleyebilirsiniz.