@evitcastudio/kit 1.0.0

package/lib/event-system.d.ts

@@ -0,0 +1,12 @@
+import type { EmitterEvent, Listener } from './types/shared-types';
+export declare class EventEmitter {
+    private listener;
+    private plugin;
+    constructor(pListener: Listener, pPlugin: any);
+    /**
+     * Emit an event to all listeners.
+     * @param pEvent - The event to emit.
+     */
+    emit(pEvent: EmitterEvent): void;
+}
+//# sourceMappingURL=event-system.d.ts.map

package/lib/event-system.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-system.d.ts","sourceRoot":"","sources":["../src/event-system.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACnE,qBAAa,YAAY;IACrB,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,MAAM,CAAmB;gBAErB,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAe,GAAG;IAK1D;;;OAGG;IACH,IAAI,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI;CAcnC"}

package/lib/event-system.js

@@ -0,0 +1,25 @@
+export class EventEmitter {
+    listener;
+    plugin;
+    constructor(pListener, pPlugin) {
+        this.listener = pListener;
+        this.plugin = pPlugin;
+    }
+    /**
+     * Emit an event to all listeners.
+     * @param pEvent - The event to emit.
+     */
+    emit(pEvent) {
+        if (pEvent.plugin && pEvent.plugin !== this.plugin.name) {
+            throw new Error(`Event mismatch: ${this.plugin.name} tried to emit an event from the ${pEvent.plugin} namespace.`);
+        }
+        const event = {
+            plugin: this.plugin.name,
+            event: pEvent.event,
+            data: pEvent?.data,
+            timestamp: Date.now()
+        };
+        Object.freeze(event);
+        this.listener(event);
+    }
+}

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export { Kit } from './kit';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC"}

package/lib/index.js

@@ -0,0 +1 @@
+export { Kit } from './kit';

package/lib/kit.d.ts

@@ -0,0 +1,54 @@
+import type { EmitterEvent, Listener } from './types/shared-types';
+export declare class Kit {
+    /**
+     * A record of all plugins registered with the Kit class.
+     */
+    private static plugins;
+    /**
+     * A set of all plugin emitters.
+     */
+    private static emitters;
+    /**
+     * A record of all event listeners.
+     */
+    private static events;
+    /**
+     * Initialize the Kit class with plugins.
+     * @param pPlugins - An array of plugins to initialize.
+     */
+    static init(pPlugins: any[]): void;
+    /**
+     * Register a plugin with the Kit class.
+     * @param pPlugin - The plugin to register.
+     */
+    static registerPlugin(pPlugin: any): void;
+    /**
+     * Gets a plugin by name.
+     * @param pName - String name of the plugin to retrieve.
+     */
+    static getPlugin<T>(pName: string): T | undefined;
+    /**
+     * Lists all registered plugins.
+     */
+    static getPlugins(): string[];
+    /**
+     * Emit an event to all listeners.
+     * @param pEvent - The event to emit.
+     */
+    private static emit;
+    /**
+    * Listen for an event.
+    * @param pPluginName - The plugin namespace.
+    * @param pEventName - The event name.
+    * @param pListener - The listener to call when the event is emitted.
+    */
+    static on(pPluginName: string, pEventName: string, pListener: Listener): void;
+    /**
+     * Removes an event listener.
+     * @param pPluginName - The plugin namespace.
+     * @param pEventName - The event name.
+     * @param pListener - The listener to remove.
+     */
+    static off(pPluginName: string, pEventName: string, pListener: (pData: EmitterEvent) => void): void;
+}
+//# sourceMappingURL=kit.d.ts.map

package/lib/kit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kit.d.ts","sourceRoot":"","sources":["../src/kit.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAEnE,qBAAa,GAAG;IACZ;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,OAAO,CAAwC;IAC9D;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAmC;IAC1D;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,MAAM,CAAmD;IAExE;;;OAGG;IACH,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAkB,GAAG,EAAE,GAAG,IAAI;IAMlD;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,OAAO,EAAkB,GAAG,GAAG,IAAI;IAkBzD;;;OAGG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,EAA0B,KAAK,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAIzE;;OAEG;IACH,MAAM,CAAC,UAAU,IAAI,MAAM,EAAE;IAI7B;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,IAAI;IAWlB;;;;;MAKE;IACH,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,GAAG,IAAI;IAQ7E;;;;;OAKG;IACH,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,GAAG,IAAI;CAMtG"}

package/lib/kit.js

@@ -0,0 +1,91 @@
+import { EventEmitter } from './event-system';
+export class Kit {
+    /**
+     * A record of all plugins registered with the Kit class.
+     */
+    static plugins = {};
+    /**
+     * A set of all plugin emitters.
+     */
+    static emitters = new Map();
+    /**
+     * A record of all event listeners.
+     */
+    static events = {};
+    /**
+     * Initialize the Kit class with plugins.
+     * @param pPlugins - An array of plugins to initialize.
+     */
+    static init(pPlugins) {
+        pPlugins.forEach(pPlugin => {
+            this.registerPlugin(pPlugin);
+        });
+    }
+    /**
+     * Register a plugin with the Kit class.
+     * @param pPlugin - The plugin to register.
+     */
+    static registerPlugin(pPlugin) {
+        const plugin = new pPlugin();
+        if (Kit.plugins[plugin.name]) {
+            throw new Error(`[Kit] plugin with name '${plugin.name}' is already registered.`);
+        }
+        const listener = (pEvent) => {
+            Kit.emit(pEvent);
+        };
+        const emitter = new EventEmitter(listener, plugin);
+        Kit.emitters.set(plugin.name, emitter);
+        Kit.plugins[plugin.name] = plugin;
+        plugin._register(emitter);
+    }
+    /**
+     * Gets a plugin by name.
+     * @param pName - String name of the plugin to retrieve.
+     */
+    static getPlugin(pName) {
+        return Kit.plugins[pName];
+    }
+    /**
+     * Lists all registered plugins.
+     */
+    static getPlugins() {
+        return Object.keys(Kit.plugins);
+    }
+    /**
+     * Emit an event to all listeners.
+     * @param pEvent - The event to emit.
+     */
+    static emit(pEvent) {
+        const { plugin, event } = pEvent;
+        const eventScope = `${plugin}-${event}`;
+        if (!Kit.events[eventScope]) {
+            return;
+        }
+        Kit.events[eventScope].forEach(pListener => pListener(pEvent));
+    }
+    /**
+    * Listen for an event.
+    * @param pPluginName - The plugin namespace.
+    * @param pEventName - The event name.
+    * @param pListener - The listener to call when the event is emitted.
+    */
+    static on(pPluginName, pEventName, pListener) {
+        const eventScope = `${pPluginName}-${pEventName}`;
+        if (!Kit.events[eventScope]) {
+            Kit.events[eventScope] = [];
+        }
+        Kit.events[eventScope].push(pListener);
+    }
+    /**
+     * Removes an event listener.
+     * @param pPluginName - The plugin namespace.
+     * @param pEventName - The event name.
+     * @param pListener - The listener to remove.
+     */
+    static off(pPluginName, pEventName, pListener) {
+        const eventScope = `${pPluginName}-${pEventName}`;
+        if (Kit.events[eventScope].includes(pListener)) {
+            Kit.events[eventScope].splice(Kit.events[eventScope].indexOf(pListener), 1);
+        }
+    }
+}

package/lib/types/shared-types.d.ts

@@ -0,0 +1,18 @@
+declare global {
+    /**
+     * The EmitterEvent type is used to define the shape of the data that is passed to the event listeners.
+     */
+    type EmitterEvent = {
+        /**
+         * The event name, e.g., "draw-frame".
+         */
+        event: string;
+        /**
+         * The data associated with the event.
+         */
+        data?: Record<string, any>;
+    } & Record<string, any>;
+    type Listener = (pData: EmitterEvent) => void;
+}
+export type { EmitterEvent, Listener };
+//# sourceMappingURL=shared-types.d.ts.map

package/lib/types/shared-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared-types.d.ts","sourceRoot":"","sources":["../../src/types/shared-types.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,CAAC;IACX;;OAEG;IACH,KAAK,YAAY,GAAG;QAChB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC9B,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAExB,KAAK,QAAQ,GAAG,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;CACjD;AAED,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC"}

package/lib/types/shared-types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@evitcastudio/kit",
+  "version": "1.0.0",
+  "author": "doubleactii 56242467+doubleactii@users.noreply.github.com (https://evitcastudio.com)",
+  "main": "./lib/src/index.js",
+  "types": "./lib/src/index.d.ts",
+  "module": "lib/src/index.js",
+  "type": "module",
+  "description": "A single-player/multiplayer framework for the Vylocity Game Engine.",
+  "cli-description": "CLI for handling building resources and running | testing | publishing games.",
+  "keywords": [
+    "framework",
+    "multiplayer",
+    "single-player",
+    "toolkit",
+    "kit"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/EvitcaStudio/Kit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/EvitcaStudio/Kit/issues"
+  },
+  "homepage": "https://github.com/EvitcaStudio/Kit",
+  "license": "MIT",
+  "scripts": {
+    "prepublishOnly": "bun run build-all",
+    "test": "bun test ./tests",
+    "build-types": "bun tsc",
+    "build-dist": "bun bun-build.ts",
+    "build-docs": "bun typedoc ./src/index.ts ./src/types/shared-types.ts",
+    "build-all": "bun run build-types && bun run build-dist && bun run build-docs"
+  },
+  "bin": {
+    "kit": "./lib/bundle/cli/cli.js"
+  },
+  "devDependencies": {
+    "@types/bun": "latest",
+    "@types/node": "^22.10.2",
+    "bun": "^1.1.42",
+    "typedoc": "^0.27.5",
+    "typescript": "^5.7.2"
+  },
+  "dependencies": {
+    "chalk": "^5.4.0",
+    "commander": "^12.1.0",
+    "uuid": "^11.0.3"
+  },
+  "directories": {
+    "test": "tests"
+  }
+}

package/src/event-system.ts

@@ -0,0 +1,29 @@
+import type { EmitterEvent, Listener } from './types/shared-types';
+export class EventEmitter {
+    private listener: Listener;
+    private plugin: /*KitPlugin*/any;
+
+    constructor(pListener: Listener, pPlugin: /*KitPlugin*/any) {
+        this.listener = pListener;
+        this.plugin = pPlugin;
+    }
+    
+    /**
+     * Emit an event to all listeners.
+     * @param pEvent - The event to emit.
+     */
+    emit(pEvent: EmitterEvent): void {
+        if (pEvent.plugin && pEvent.plugin !== this.plugin.name) {
+            throw new Error(`Event mismatch: ${this.plugin.name} tried to emit an event from the ${pEvent.plugin} namespace.`);
+        }
+
+        const event: EmitterEvent = {
+            plugin: this.plugin.name,
+            event: pEvent.event,
+            data: pEvent?.data,
+            timestamp: Date.now()
+        }
+        Object.freeze(event);
+        this.listener(event);
+    }
+}

package/src/index.ts

@@ -0,0 +1 @@
+export { Kit } from './kit';

package/src/kit.ts

@@ -0,0 +1,106 @@
+import { EventEmitter } from './event-system';
+import type { EmitterEvent, Listener } from './types/shared-types';
+
+export class Kit {
+    /**
+     * A record of all plugins registered with the Kit class.
+     */
+    private static plugins: Record<string, /*KitPlugin*/any> = {};
+    /**
+     * A set of all plugin emitters.
+     */
+    private static emitters = new Map<string, EventEmitter>();
+    /**
+     * A record of all event listeners.
+     */
+    private static events: Record<string, Array<(pData: any) => void>> = {};
+
+    /**
+     * Initialize the Kit class with plugins.
+     * @param pPlugins - An array of plugins to initialize.
+     */
+    static init(pPlugins: /* KitPlugin[]*/any[]): void {
+        pPlugins.forEach(pPlugin => {
+            this.registerPlugin(pPlugin);
+        });
+    }
+
+    /**
+     * Register a plugin with the Kit class.
+     * @param pPlugin - The plugin to register.
+     */
+    static registerPlugin(pPlugin: /* KitPlugin[]*/any): void {
+        const plugin = new pPlugin();
+
+        if (Kit.plugins[plugin.name]) {
+            throw new Error(`[Kit] plugin with name '${plugin.name}' is already registered.`);
+        }
+
+        const listener: Listener = (pEvent: EmitterEvent) => {
+            Kit.emit(pEvent);
+        }
+        
+        const emitter = new EventEmitter(listener, plugin);
+        Kit.emitters.set(plugin.name, emitter);
+
+        Kit.plugins[plugin.name] = plugin;
+        plugin._register(emitter);
+    }
+
+    /**
+     * Gets a plugin by name.
+     * @param pName - String name of the plugin to retrieve.
+     */
+    static getPlugin<T /* extends KitPlugin */>(pName: string): T | undefined {
+        return Kit.plugins[pName] as T;
+    }
+
+    /**
+     * Lists all registered plugins.
+     */
+    static getPlugins(): string[] {
+        return Object.keys(Kit.plugins);
+    }
+
+    /**
+     * Emit an event to all listeners.
+     * @param pEvent - The event to emit.
+     */
+    private static emit(pEvent: EmitterEvent): void {
+        const { plugin, event } = pEvent;
+        const eventScope = `${plugin}-${event}`;
+
+        if (!Kit.events[eventScope]) {
+            return;
+        }
+
+        Kit.events[eventScope].forEach(pListener => pListener(pEvent));
+    }
+    
+     /**
+     * Listen for an event.
+     * @param pPluginName - The plugin namespace.
+     * @param pEventName - The event name.
+     * @param pListener - The listener to call when the event is emitted.
+     */
+    static on(pPluginName: string, pEventName: string, pListener: Listener): void {
+        const eventScope = `${pPluginName}-${pEventName}`;
+        if (!Kit.events[eventScope]) {
+            Kit.events[eventScope] = [];
+        }
+        Kit.events[eventScope].push(pListener);
+    }
+
+    /**
+     * Removes an event listener.
+     * @param pPluginName - The plugin namespace.
+     * @param pEventName - The event name.
+     * @param pListener - The listener to remove.
+     */
+    static off(pPluginName: string, pEventName: string, pListener: (pData: EmitterEvent) => void): void {
+        const eventScope = `${pPluginName}-${pEventName}`;
+        if (Kit.events[eventScope].includes(pListener)) {
+            Kit.events[eventScope].splice(Kit.events[eventScope].indexOf(pListener), 1);
+        }
+    }
+}

package/src/types/shared-types.ts

@@ -0,0 +1,19 @@
+declare global {
+    /**
+     * The EmitterEvent type is used to define the shape of the data that is passed to the event listeners.
+     */
+    type EmitterEvent = {
+        /**
+         * The event name, e.g., "draw-frame".
+         */
+        event: string;
+        /**
+         * The data associated with the event.
+         */
+        data?: Record<string, any>;
+    } & Record<string, any>;
+
+    type Listener = (pData: EmitterEvent) => void;
+}
+
+export type { EmitterEvent, Listener };

package/tests/kit-cli.test.ts

@@ -0,0 +1,75 @@
+import { describe, beforeEach, afterEach, test, expect } from 'bun:test';
+import { writeFile, rm, readdir, mkdir } from 'fs/promises';
+import { join } from 'path';
+import { KitCLI } from '../bin/kit';
+
+const tempDir = join(process.cwd(), 'tests/temp');
+const outDir = join(process.cwd(), 'tests/temp/dist');
+
+async function createFile(pName: string, pExtension: string): Promise<string> {
+    const filePath = join(tempDir, `${pName}.${pExtension}`);
+    await writeFile(filePath, '');
+    return filePath;
+}
+
+async function cleanUpDirectory(pDirectory: string): Promise<void> {
+    try {
+        await rm(pDirectory, { recursive: true, force: true });
+    } catch (pError) {
+        console.error(`Error cleaning up directory: ${pError}`);
+    }
+}
+
+async function ensureDirectoryExists(pDirectory: string): Promise<void> {
+    try {
+        await mkdir(pDirectory, { recursive: true });
+    } catch (pError) {
+        console.error(`Error creating directory: ${pError}`);
+    }
+}
+
+describe('Kit CLI', () => {
+    const testFiles = [
+        { name: 'file1', extension: 'txt' },
+        { name: 'file2', extension: 'json' },
+        { name: 'file3', extension: 'vyint' },
+        { name: 'file4', extension: 'vyi' },
+        { name: 'file5', extension: 'vym' },
+        { name: 'file6', extension: 'vymac' },
+        { name: 'file7', extension: 'mp3' },
+        { name: 'file8', extension: 'wav' },
+        { name: 'file9', extension: 'm4a' },
+        { name: 'file10', extension: 'ogg' },
+        { name: 'file11', extension: 'aac' },
+        { name: 'file12', extension: 'flac' },
+    ];
+
+    beforeEach(async () => {
+        await cleanUpDirectory(tempDir);
+        await ensureDirectoryExists(tempDir);
+        await ensureDirectoryExists(outDir);
+        await Promise.all(
+            testFiles.map(({ name, extension }) => createFile(name, extension))
+        );
+    });
+
+    afterEach(async () => {
+        await cleanUpDirectory(tempDir);
+    });
+
+    test('should process resources with KitCLI', async () => {
+        await KitCLI.processResources({
+            inDirectory: tempDir,
+            outDirectory: outDir,
+            ignoreSound: false,
+            verbose: true,
+        });
+
+        const filesAfterBuild = await readdir(join(outDir, 'resources'));
+        const expectedFiles = ['icon', 'interface', 'macros', 'map', 'sound'];
+
+        expectedFiles.forEach((expectedFile) => {
+            expect(filesAfterBuild).toContain(expectedFile);
+        });
+    });
+});

package/tests/kit.test.ts

@@ -0,0 +1,33 @@
+import { describe, expect, test, beforeEach, mock } from "bun:test";
+import { Kit } from '../src/kit';
+
+describe('Kit Framework', () => {
+    let kit: typeof Kit;
+
+    // Reset Kit for each test
+    beforeEach(() => {
+        kit = Kit;
+    });
+
+    test('should listen for an event and remove the listener', () => {
+        const mockListener = mock(() => {});
+        const pluginName = 'FakePlugin';
+        const eventName = 'testEvent';
+        
+        kit.on(pluginName, eventName, mockListener);
+        kit.off(pluginName, eventName, mockListener);
+        /** @ts-ignore (accessing private field)*/
+        expect(kit.events[`${pluginName}-${eventName}`].length).toBe(0);
+    });
+
+    test('should listen for an event and should not remove the listener due to a different func being passed.', () => {
+        const mockListener = mock(() => {});
+        const pluginName = 'FakePlugin';
+        const eventName = 'testEvent';
+        
+        kit.on(pluginName, eventName, mockListener);
+        kit.off(pluginName, eventName, ()=>{});
+        /** @ts-ignore (accessing private field)*/
+        expect(kit.events[`${pluginName}-${eventName}`].length).toBe(1);
+    });
+});

package/tsconfig.json

@@ -0,0 +1,37 @@
+{
+    "compilerOptions": {
+        "forceConsistentCasingInFileNames": true,
+        "declaration": true, // Generate .d.ts files
+        "declarationMap": true, // Generate .d.ts.map files for debugging
+        "emitDeclarationOnly": false, // Only emit type declarations
+        "outDir": "./lib", // Output folder for compiled files
+        "baseUrl": ".", // Base URL for module resolution
+        "esModuleInterop": true, // Enable ES module interop
+        // Enable latest features
+        "lib": ["ESNext", "DOM"],
+        "target": "ESNext",
+        "module": "ESNext",
+        "moduleDetection": "force",
+        "jsx": "react-jsx",
+        "allowJs": true,
+        "resolveJsonModule": true,
+    
+        // Bundler mode
+        "moduleResolution": "bundler",
+        // "allowImportingTsExtensions": true,
+        "verbatimModuleSyntax": true,
+        // "noEmit": true,
+    
+        // Best practices
+        "strict": true,
+        "skipLibCheck": true,
+        "noFallthroughCasesInSwitch": true,
+    
+        // Some stricter flags (disabled by default)
+        "noUnusedLocals": false,
+        "noUnusedParameters": false,
+        "noPropertyAccessFromIndexSignature": false
+    },
+    "include": ["src/**/*"],
+    "exclude": ["node_modules", "lib", "dist"]
+}