@snailycfx/nexus 1.0.1 → 1.0.3

package/out/server/managers/EventManager.d.ts

@@ -1,4 +1,4 @@
-import { NexusEvent } from "../../index.server";
+import { NexusEvent } from "../..";
 import IListener from "../../interfaces/IListener";
 export declare class EventManager {
     private readonly handlers;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@snailycfx/nexus",
-    "version": "1.0.1",
-    "description": "",
+    "version": "1.0.3",
+    "description": "Bukkit-inspired framework for roblox-ts",
     "main": "out/init.lua",
     "types": "out/index.d.ts",
     "scripts": {
@@ -9,9 +9,14 @@
         "watch": "rbxtsc -w",
         "prepublishOnly": "npm run build"
     },
-    "keywords": [],
-    "author": "",
-    "license": "ISC",
+    "keywords": [
+        "roblox",
+        "roblox-ts",
+        "framework",
+        "game"
+    ],
+    "author": "Snaily",
+    "license": "MIT",
     "packageManager": "pnpm@10.11.0",
     "devDependencies": {
         "@rbxts/compiler-types": "3.0.0-types.0",

package/src/events/core/EventClass.ts

@@ -1 +0,0 @@
-export type EventClass = new (...args: unknown[]) => object;

package/src/events/core/EventHandlerMeta.ts

@@ -1,9 +0,0 @@
-import { EventPriority } from "./EventPriority"
-import { EventClass } from "./EventClass";
-
-export interface EventHandlerMeta {
-    readonly methodName: string;
-    readonly eventClass: EventClass;
-    readonly async: boolean;
-    readonly priority: EventPriority;
-}

package/src/events/core/EventHandlerOptions.ts

@@ -1,6 +0,0 @@
-import { EventPriority } from "./EventPriority"
-
-export interface EventHandlerOptions {
-    readonly async?: boolean;
-    readonly priority?: EventPriority;
-}

package/src/events/core/EventPriority.ts

@@ -1,8 +0,0 @@
-export const enum EventPriority {
-    Lowest  = 0,
-    Low     = 1,
-    Normal  = 2,
-    High    = 3,
-    Highest = 4,
-    Monitor = 5,
-}

package/src/events/core/NexusEvent.ts

@@ -1,11 +0,0 @@
-export abstract class NexusEvent {
-    private cancelled: boolean = false;
-
-    public setCancelled(cancelled: boolean): void {
-        this.cancelled = cancelled;
-    }
-
-    public isCancelled(): boolean {
-        return this.cancelled;
-    }
-}

package/src/events/core/metadata/NexusMetadata.ts

@@ -1,16 +0,0 @@
-import { EventClass } from "../EventClass";
-
-export class NexusMetadata {
-    private static readonly store = new Map<string, EventClass>();
-
-    public static define(key: string, paramTypes: EventClass[], _target: object, methodName: string): void {
-        if (key !== 'paramtypes') return;
-        if (paramTypes.size() === 0) return;
-
-        NexusMetadata.store.set(methodName, paramTypes[0]);
-    }
-
-    public static getEventClass(methodName: string): EventClass | undefined {
-        return NexusMetadata.store.get(methodName);
-    }
-}

package/src/events/decorators/EventHandler.ts

@@ -1,30 +0,0 @@
-import { EventHandlerOptions } from "../../events/core/EventHandlerOptions";
-import { EventHandlerMeta } from "../../events/core/EventHandlerMeta";
-import { EventPriority } from "../../events/core/EventPriority";
-
-import { NexusMetadata } from "../../events/core/metadata/NexusMetadata";
-
-const EVENT_HANDLER_KEY = '__nexus_event_handlers__';
-
-export function EventHandler(options?: EventHandlerOptions) {
-    return (target: object, methodName: string) => {
-        const eventClass = NexusMetadata.getEventClass(methodName);
-        if (eventClass === undefined) return;
-
-        const meta: EventHandlerMeta = {
-            methodName,
-            eventClass,
-            async: options?.async ?? false,
-            priority: options?.priority ?? EventPriority.Normal
-        }
-
-        const existing: EventHandlerMeta[] = (target as Record<string, unknown>)[EVENT_HANDLER_KEY] as EventHandlerMeta[] ?? [];
-        existing.push(meta);
-    
-        (target as Record<string, unknown>)[EVENT_HANDLER_KEY] = existing;
-    }
-}
-
-export function getEventHandlerMetas(target: object): EventHandlerMeta[] {
-    return (target as Record<string, unknown>)[EVENT_HANDLER_KEY] as EventHandlerMeta[] ?? [];
-}

package/src/events/handlers/player/PlayerJoinEvent.ts

@@ -1,12 +0,0 @@
-import { NexusEvent } from "../../core/NexusEvent";
-
-export class PlayerJoinEvent extends NexusEvent {
-    private readonly player: Player;
-
-    public constructor(player: Player) {
-        super();
-        this.player = player;
-    }
-
-    public getPlayer(): Player { return this.player; }
-}

package/src/events/handlers/player/PlayerLeaveEvent.ts

@@ -1,12 +0,0 @@
-import { NexusEvent } from "../../core/NexusEvent";
-
-export class PlayerLeaveEvent extends NexusEvent {
-    private readonly player: Player;
-
-    public constructor(player: Player) {
-        super();
-        this.player = player;
-    }
-
-    public getPlayer(): Player { return this.player; }
-}

package/src/index.server.ts

@@ -1,11 +0,0 @@
-export { Nexus } from './server/Nexus';
-export { NexusEvent } from './events/core/NexusEvent';
-export { NexusMetadata } from './events/core/metadata/NexusMetadata';
-
-export { EventPriority } from './events/core/EventPriority';
-export { EventHandler } from './events/decorators/EventHandler';
-export { EventHandlerMeta } from './events/core/EventHandlerMeta';
-export { EventHandlerOptions } from './events/core/EventHandlerOptions';
-
-export { PlayerJoinEvent } from './events/handlers/player/PlayerJoinEvent';
-export { PlayerLeaveEvent } from './events/handlers/player/PlayerLeaveEvent';

package/src/interfaces/IListener.ts

@@ -1 +0,0 @@
-export default interface IListener {}

package/src/server/Nexus.ts

@@ -1,29 +0,0 @@
-import { RunService } from "@rbxts/services";
-import { EventManager } from "./managers/EventManager";
-
-export abstract class Nexus {
-    private readonly eventManager: EventManager = new EventManager();
-    private static instance: Nexus;
-
-    public constructor() {
-        if (!RunService.IsServer()) {
-            error('Nexus can only be instantiated in server!');
-        }
-
-        if (Nexus.instance !== undefined) {
-            error('Nexus can only be instantiated once!');
-        }
-
-        Nexus.instance = this;
-        game.BindToClose(() => this.onDisable());
-    }
-
-    public static getInstance<T extends Nexus>(): T {
-        return Nexus.instance as T;
-    }
-
-    public getEventManager(): EventManager { return this.eventManager; }
-
-    public onEnable(): void {};
-    public onDisable(): void {};
-}

package/src/server/managers/EventManager.ts

@@ -1,48 +0,0 @@
-import { getEventHandlerMetas } from "../../events/decorators/EventHandler";
-import { EventHandlerMeta, NexusEvent, EventPriority } from "../../index.server";
-
-import { EventClass } from "../../events/core/EventClass";
-import IListener from "../../interfaces/IListener";
-
-interface RegisteredHandler {
-    readonly listener: IListener; // TODO: IListener
-    readonly meta: EventHandlerMeta;
-}
-
-export class EventManager {
-    private readonly handlers = new Map<EventClass, RegisteredHandler[]>();
-
-    public register(listener: IListener): void {
-        const metas = getEventHandlerMetas(listener);
-        if (metas.size() === 0) return;
-
-        return metas.forEach((meta) => this.addHandler(meta.eventClass as EventClass, { listener, meta }));
-    }
-
-    public dispatch<T extends NexusEvent>(event: T): void {
-        const eventClass = getmetatable(event) as unknown as EventClass
-        const registered = this.handlers.get(eventClass)
-        if (registered === undefined) return
-
-        registered.forEach(({ listener, meta }) => {
-            if (meta.priority === EventPriority.Monitor && event.isCancelled()) return
-
-            const method = (listener as Record<string, unknown>)[meta.methodName] as (event: NexusEvent) => void
-
-            if (meta.async) {
-                task.defer(() => method(event))
-            } else {
-                method(event)
-            }
-        })
-    }
-
-    private addHandler(eventClass: EventClass, handler: RegisteredHandler): void {
-        const existing = this.handlers.get(eventClass) ?? [];
-
-        existing.push(handler);
-        existing.sort((a, b) => a.meta.priority < b.meta.priority);
-
-        this.handlers.set(eventClass, existing);
-    }
-}

package/tsconfig.json

@@ -1,26 +0,0 @@
-{
-    "compilerOptions": {
-        "allowSyntheticDefaultImports": true,
-        "downlevelIteration": true,
-        "jsx": "react",
-        "jsxFactory": "React.createElement",
-        "jsxFragmentFactory": "React.Fragment",
-        "experimentalDecorators": true,
-        "module": "commonjs",
-        "moduleResolution": "Node",
-        "noLib": true,
-        "resolveJsonModule": true,
-        "strict": true,
-        "target": "ESNext",
-        "stripInternal": true,
-        "typeRoots": ["node_modules/@rbxts"],
-        "moduleDetection": "force",
-        "declaration": true,
-        "rootDir": "src",
-        "outDir": "out",
-        "plugins": [
-            { "transform": "@snailycfx/nexus-transformer" }
-        ]
-    },
-    "include": ["src"]
-}