@open-discord-bots/framework 0.0.4 → 0.0.6

package/README.md

@@ -1,8 +1,8 @@
 <p align="center">
-<img src="https://apis.dj-dj.be/cdn/opendiscord/logo.png" alt="Open Ticket" width="650px"><br>
+<img src="https://apis.dj-dj.be/cdn/opendiscord/logo.png" alt="Open Discord Logo" width="650px"><br>
 <span align="center"><b>A modular framework for the next-generation of Discord bots</b></span><br><br>
-<a href="https://otgithub.dj-dj.be"><img src="https://apis.dj-dj.be/cdn/openticket/logo.png" alt="Open Ticket" height="55px"></a>
-<a href="https://otgithub.dj-dj.be"><img src="https://apis.dj-dj.be/cdn/openmoderation/logo.png" alt="Open Moderation" height="60px"></a><br><br>
+<a href="https://otgithub.dj-dj.be"><img src="https://apis.dj-dj.be/cdn/openticket/logo.png" alt="Open Ticket Logo" height="55px"></a>
+<a href="https://otgithub.dj-dj.be"><img src="https://apis.dj-dj.be/cdn/openmoderation/logo.png" alt="Open Moderation Logo" height="60px"></a><br><br>
 <a href="https://discord.com/invite/26vT9wt3n3"><img alt="Discord Invite Link" src="https://img.shields.io/badge/discord-support%20server-5865F2.svg?style=flat-square&logo=discord"></img></a>
 <a href="https://github.com/open-discord-bots/plugins/blob/main/LICENSE"><img alt="Open Discord Plugins License" src="https://img.shields.io/badge/license-MIT-important.svg?style=flat-square"></img></a>
 <a href="https://discord.dj-dj.be"><img alt="Open Discord Plugins Stars" src="https://img.shields.io/github/stars/open-discord-bots/framework?color=yellow&label=stars&logo=github&style=flat-square"></img></a>

package/dist/index.js

@@ -43,3 +43,6 @@ var pluginLauncher_1 = require("./startup/pluginLauncher");
 Object.defineProperty(exports, "loadAllPlugins", { enumerable: true, get: function () { return pluginLauncher_1.loadAllPlugins; } });
 var compilation_1 = require("./startup/compilation");
 Object.defineProperty(exports, "frameworkStartup", { enumerable: true, get: function () { return compilation_1.frameworkStartup; } });
+const compilation_2 = require("./startup/compilation");
+//check directory structure
+(0, compilation_2.checkFrameworkAllowed)();

package/dist/startup/compilation.d.ts

@@ -1,2 +1,3 @@
 import type { ODProjectType } from "../api/api";
+export declare function checkFrameworkAllowed(project?: ODProjectType): void;
 export declare function frameworkStartup(startupFlags: string[], project: ODProjectType, startCallback: () => void): void;

package/dist/startup/compilation.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkFrameworkAllowed = checkFrameworkAllowed;
 exports.frameworkStartup = frameworkStartup;
 const fs_1 = __importDefault(require("fs"));
 const typescript_1 = __importDefault(require("typescript"));
@@ -62,11 +63,8 @@ function saveNewCompilationHash() {
     const hash = sourceHash + ":" + pluginHash;
     fs_1.default.writeFileSync("./dist/hash.txt", hash);
 }
-function frameworkStartup(startupFlags, project, startCallback) {
-    const logTitle = (project == "openticket") ? "OT" : "OM";
-    //push additional startup flags (for pterodactyl panels)
-    process.argv.push(...startupFlags);
-    //check directory structure
+function checkFrameworkAllowed(project) {
+    const logTitle = (project) ? ((project == "openticket") ? "OT" : "OM") : "OD";
     const requiredStructures = [
         "index.js",
         "./package.json",
@@ -80,12 +78,27 @@ function frameworkStartup(startupFlags, project, startCallback) {
         "./plugins/",
         "./.github/",
         "./.github/FUNDING.yml",
-        "./.github/SECURITY.yml"
+        "./.github/SECURITY.md"
     ];
     for (const path of requiredStructures) {
         if (!fs_1.default.existsSync(path))
-            throw new Error(logTitle + ": Project uses invalid structure for Open Discord! (" + path + ")");
+            throw new Error(logTitle + ": Project uses invalid structure for Open Discord! (missing: " + path + ")");
     }
+    if (!fs_1.default.readFileSync("./.github/FUNDING.yml").toString().startsWith("github: DJj123dj"))
+        throw new Error(logTitle + ": Please do not use this framework in third party bots outside Open Ticket/Moderation! (1)");
+    const readmeContents = fs_1.default.readFileSync("./README.md").toString();
+    if (!readmeContents.includes(`<img src="https://apis.dj-dj.be/cdn/openticket/logo.png" alt="Open Ticket" width="650px">`) &&
+        !readmeContents.includes(`<img src="https://apis.dj-dj.be/cdn/openmoderation/logo.png" alt="Open Moderation" width="650px">`))
+        throw new Error(logTitle + ": Please do not use this framework in third party bots or outside Open Ticket/Moderation! (2)");
+    if (!readmeContents.includes("DJdj Development") || !readmeContents.includes("DJj123dj"))
+        throw new Error(logTitle + ": Please do not use this framework in third party bots or outside Open Ticket/Moderation! (3)");
+}
+function frameworkStartup(startupFlags, project, startCallback) {
+    const logTitle = (project == "openticket") ? "OT" : "OM";
+    //push additional startup flags (for pterodactyl panels)
+    process.argv.push(...startupFlags);
+    //check directory structure
+    checkFrameworkAllowed(project);
     //start compilation
     if (!process.argv.includes("--no-compile")) {
         const requiredDependencies = new Set();

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@open-discord-bots/framework",
     "author": "DJj123dj",
-    "version": "0.0.4",
+    "version": "0.0.6",
     "description": "The core framework of the popular open-source discord bots: Open Ticket & Open Moderation.",
     "main": "dist/index.js",
     "module": "dist/index.js",
@@ -9,7 +9,7 @@
         "build": "node ./tools/cleanup.js && tsc -p ./tsconfig.json"
     },
     "keywords": [],
-    "license": "MIT",
+    "license": "GPL-3.0-only",
     "dependencies": {
         "@discordjs/rest": "^2.6.0",
         "@types/terminal-kit": "^2.5.7",

package/src/index.ts

@@ -1,6 +1,11 @@
+
 export * as api from "./api/api"
 export * as utilities from "./api/utils"
 export * as cli from "./cli/cli"
 export { loadDumpCommand } from "./startup/dump"
 export { loadAllPlugins } from "./startup/pluginLauncher"
-export { frameworkStartup } from "./startup/compilation"
+export { frameworkStartup } from "./startup/compilation"
+import { checkFrameworkAllowed } from "./startup/compilation"
+
+//check directory structure
+checkFrameworkAllowed()

package/src/startup/compilation.ts

@@ -60,13 +60,8 @@ function saveNewCompilationHash(){
     fs.writeFileSync("./dist/hash.txt",hash)
 }
 
-export function frameworkStartup(startupFlags:string[],project:ODProjectType,startCallback:() => void){
-    const logTitle = (project == "openticket") ? "OT" : "OM"
-
-    //push additional startup flags (for pterodactyl panels)
-    process.argv.push(...startupFlags)
-
-    //check directory structure
+export function checkFrameworkAllowed(project?:ODProjectType){
+    const logTitle = (project) ? ((project == "openticket") ? "OT" : "OM") : "OD"
     const requiredStructures: string[] = [
         "index.js",
         "./package.json",
@@ -80,12 +75,29 @@ export function frameworkStartup(startupFlags:string[],project:ODProjectType,sta
         "./plugins/",
         "./.github/",
         "./.github/FUNDING.yml",
-        "./.github/SECURITY.yml"
+        "./.github/SECURITY.md"
     ]
     for (const path of requiredStructures){
-        if (!fs.existsSync(path)) throw new Error(logTitle+": Project uses invalid structure for Open Discord! ("+path+")")
+        if (!fs.existsSync(path)) throw new Error(logTitle+": Project uses invalid structure for Open Discord! (missing: "+path+")")
     }
+    if (!fs.readFileSync("./.github/FUNDING.yml").toString().startsWith("github: DJj123dj")) throw new Error(logTitle+": Please do not use this framework in third party bots outside Open Ticket/Moderation! (1)")
+    const readmeContents = fs.readFileSync("./README.md").toString()
+    if (
+        !readmeContents.includes(`<img src="https://apis.dj-dj.be/cdn/openticket/logo.png" alt="Open Ticket" width="650px">`) &&
+        !readmeContents.includes(`<img src="https://apis.dj-dj.be/cdn/openmoderation/logo.png" alt="Open Moderation" width="650px">`)
+    ) throw new Error(logTitle+": Please do not use this framework in third party bots or outside Open Ticket/Moderation! (2)")
+    if (!readmeContents.includes("DJdj Development") || !readmeContents.includes("DJj123dj")) throw new Error(logTitle+": Please do not use this framework in third party bots or outside Open Ticket/Moderation! (3)")
+}
 
+export function frameworkStartup(startupFlags:string[],project:ODProjectType,startCallback:() => void){
+    const logTitle = (project == "openticket") ? "OT" : "OM"
+
+    //push additional startup flags (for pterodactyl panels)
+    process.argv.push(...startupFlags)
+
+    //check directory structure
+    checkFrameworkAllowed(project)
+    
     //start compilation
     if (!process.argv.includes("--no-compile")){
         const requiredDependencies: Set<string> = new Set()