@evitcastudio/kit 1.3.2 → 2.0.0

package/README.md

@@ -14,6 +14,31 @@ npm i @evitcastudio/kit -g
 
 *global flag is so the path is set properly for the CLI tool*
 
+# Resources
+
+This script will locate all Vylocity engine-related files within the specified directory and anonymize them before placing them in the designated resources folder.
+
+```bash
+# From the CLI you will build all your resources to the out dir
+kit build -i ./<in-dir> -o ./<out-dir>
+```
+
+During the execution of this command, a `resource.json` file will be automatically generated within your source directory.
+It is recommended to exclude this file from your version control system, as it is considered a build artifact.
+
+
+> [!IMPORTANT]
+> This API should be ran BEFORE VYLO.load() is called.
+
+> [!WARNING]
+> Depending on your environment the following [import syntax](https://github.com/EvitcaStudio/Kit/wiki/FAQ#importing-json-resources) for json may not work.
+
+
+```js
+import resourceJSON from 'resource.json';
+await Kit.setResources(resourceJSON);
+```
+
 # Using Kit with plugins
 
 ```ts

package/lib/bundle/cli/cli.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
 /*!
- * @evitcastudio/kit@1.3.2 git+https://github.com/EvitcaStudio/Kit.git
- * Compiled Sat, 04 Jan 2025 16:05:39 UTC
+ * @evitcastudio/kit@2.0.0 git+https://github.com/EvitcaStudio/Kit.git
+ * Compiled Wed, 08 Jan 2025 21:06:50 UTC
  * Copyright (c) 2025 Jared Bates, Evitca Studio, "doubleactii"
  *
  * @evitcastudio/kit is licensed under the MIT License.
@@ -2528,7 +2528,7 @@ async function copyFile(pSource, pDestinationDir, pNewName) {
   }
 }
 async function saveResourceJSON() {
-  const filePath = join(resourceOutDirectory, "resources", "resource.json");
+  const filePath = "resource.json";
   try {
     await fs.writeFile(filePath, JSON.stringify(resourceJSON, null, 4));
   } catch (pError) {
@@ -2573,7 +2573,7 @@ class KitCLI {
 // package.json
 var package_default = {
   name: "@evitcastudio/kit",
-  version: "1.3.2",
+  version: "2.0.0",
   author: "doubleactii 56242467+doubleactii@users.noreply.github.com (https://evitcastudio.com)",
   main: "./lib/index.js",
   types: "./lib/index.d.ts",
@@ -2613,7 +2613,6 @@ var package_default = {
   devDependencies: {
     "@eslint/create-config": "1.4.0",
     "@eslint/js": "^9.17.0",
-    "@evitcastudio/kit-plugin": "^1.0.7",
     "@types/bun": "latest",
     "@types/node": "^22.10.2",
     bun: "^1.1.42",

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"event-system.d.ts","sourceRoot":"","sources":["../../src/events/event-system.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACpE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAEvD,qBAAa,YAAY;IACrB,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,MAAM,CAAY;gBAEd,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS;IAKnD;;;OAGG;IACH,IAAI,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI;CAcnC"}

package/lib/events/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

@@ -1,4 +1,7 @@
 export { Kit } from './kit';
-export { EventEmitter } from './event-system';
+export { EventEmitter } from './events/event-system';
 export type { EmitterEvent, ResourceData, Listener } from './types/shared-types';
+export { KitPlugin } from './plugins/kit-plugin';
+export { Network } from './plugins/network';
+export type { NetworkListener } from './plugins/network';
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAGjF,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,YAAY,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC"}

package/lib/index.js

@@ -1,2 +1,5 @@
 export { Kit } from './kit';
-export { EventEmitter } from './event-system';
+export { EventEmitter } from './events/event-system';
+// Plugins
+export { KitPlugin } from './plugins/kit-plugin';
+export { Network } from './plugins/network';

package/lib/kit.d.ts

@@ -1,5 +1,5 @@
-import type { KitPlugin } from '@evitcastudio/kit-plugin';
-import type { EmitterEvent, Listener, KitPluginConstructor } from './types/shared-types';
+import type { KitPlugin } from './plugins/kit-plugin';
+import type { ResourceData, Listener, KitPluginConstructor } from './types/shared-types';
 export declare class Kit {
     /**
      * A record of all plugins registered with the Kit class.
@@ -51,7 +51,7 @@ export declare class Kit {
      * @param pEventName - The event name.
      * @param pListener - The listener to remove.
      */
-    static off(pPluginName: string, pEventName: string, pListener: (pData: EmitterEvent) => void): void;
+    static off(pPluginName: string, pEventName: string, pListener: Listener): void;
     /**
      * Sets the resource locator for the engine to reference the files we have in the resources folder. interface | map | icon | macro | sound are checked for.
      * @param pData - An array of each file that was found in the resources folder.
@@ -60,6 +60,6 @@ export declare class Kit {
     /**
      * Sets the resources found in resources and preloads all interfaces found.
      */
-    static setResources(): Promise<void>;
+    static setResources(pResourceJson: Record<string, ResourceData[]>): Promise<void>;
 }
 //# sourceMappingURL=kit.d.ts.map

package/lib/kit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kit.d.ts","sourceRoot":"","sources":["../src/kit.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,KAAK,EAAE,YAAY,EAAgB,QAAQ,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAevG,qBAAa,GAAG;IACZ;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,OAAO,CAAiC;IACvD;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAmC;IAC1D;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,MAAM,CAAuC;IAE5D,OAAO;IAIP;;;OAGG;IACH,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,SAAS,EAAE,QAAQ,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI;IAM3E;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,SAAS,EAAE,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAAG,IAAI;IAkBlF;;;OAGG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAInE;;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;IAOnG;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IAiB1B;;OAEG;WACU,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CA4C7C"}
+{"version":3,"file":"kit.d.ts","sourceRoot":"","sources":["../src/kit.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAgB,YAAY,EAAE,QAAQ,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAgBvG,qBAAa,GAAG;IACZ;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,OAAO,CAAiC;IACvD;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAmC;IAC1D;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,MAAM,CAAuC;IAE5D,OAAO;IAIP;;;OAGG;IACH,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,SAAS,EAAE,QAAQ,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI;IAM3E;;;OAGG;IACH,MAAM,CAAC,cAAc,CAAC,CAAC,SAAS,SAAS,EAAE,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAAG,IAAI;IAyBlF;;;OAGG;IACH,MAAM,CAAC,SAAS,CAAC,CAAC,SAAS,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IAQnE;;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,QAAQ,GAAG,IAAI;IAO9E;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAC,WAAW;IAiB1B;;OAEG;WACU,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAa1F"}

package/lib/kit.js

@@ -1,4 +1,4 @@
-import { EventEmitter } from './event-system';
+import { EventEmitter } from './events/event-system';
 const extensionToPath = {
     '.vyint': 'interface',
     '.vym': 'map',
@@ -42,23 +42,32 @@ export class Kit {
      */
     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 pluginName = plugin.name;
+        if (!pluginName || typeof pluginName !== 'string' || !/^[a-zA-Z0-9-_]+$/.test(pluginName)) {
+            throw new Error(`[Kit] Invalid plugin name: '${pluginName}'. The name must be a non-empty string containing only alphanumeric characters, dashes, or underscores.`);
         }
-        const listener = (pEvent) => {
+        if (Kit.plugins[pluginName]) {
+            throw new Error(`[Kit] plugin with name '${pluginName}' is already registered.`);
+        }
+        const listener = function (pEvent) {
             Kit.emit(pEvent);
         };
         const emitter = new EventEmitter(listener, plugin);
-        Kit.emitters.set(plugin.name, emitter);
-        Kit.plugins[plugin.name] = plugin;
+        Kit.emitters.set(pluginName, emitter);
+        Kit.plugins[pluginName] = plugin;
         plugin._register(emitter);
+        plugin.onRegistered();
     }
     /**
      * Gets a plugin by name.
      * @param pName - String name of the plugin to retrieve.
      */
     static getPlugin(pName) {
-        return Kit.plugins[pName];
+        const plugin = Kit.plugins[pName];
+        if (!plugin) {
+            return undefined;
+        }
+        return plugin;
     }
     /**
      * Lists all registered plugins.
@@ -124,39 +133,12 @@ export class Kit {
     /**
      * Sets the resources found in resources and preloads all interfaces found.
      */
-    static async setResources() {
+    static async setResources(pResourceJson) {
         if (!globalThis.VYLO) {
             throw new Error('[Kit] VYLO is not defined. Please ensure the VYLO variable is available in the global namespace.');
         }
-        let resourcePath = './resources/resource.json';
-        let resourceJson;
-        // Server environment (we do not use fetch as the file:// protocol is not supported atm)
-        if (!globalThis.window) {
-            const [fsPromises, path] = await Promise.all([
-                import('fs/promises'),
-                import('path')
-            ]);
-            const { readFile } = fsPromises;
-            resourcePath = path.resolve('resources', 'resource.json');
-            const data = await readFile(resourcePath, 'utf-8');
-            resourceJson = JSON.parse(data);
-            // Client environment
-        }
-        else {
-            // Load the resource json and set the resources found
-            try {
-                const response = await fetch(resourcePath);
-                if (!response.ok) {
-                    throw new Error(`[Kit] HTTP error! Status: ${response.status}`);
-                }
-                resourceJson = await response.json();
-            }
-            catch (pError) {
-                console.error(`[Kit] error reading ${resourcePath}`, pError);
-            }
-        }
-        if (resourceJson) {
-            const resources = Object.values(resourceJson);
+        if (pResourceJson) {
+            const resources = Object.values(pResourceJson);
             // Group all data from separate arrays in object to one unified array of all resource data
             const consolidatedData = resources.flat();
             // Set all the resources

package/lib/plugins/kit-plugin.d.ts

@@ -0,0 +1,27 @@
+import type { EventEmitter } from '../events/event-system';
+import type { EmitterEvent } from '../types/shared-types';
+export declare abstract class KitPlugin {
+    /**
+     * The name of this plugin.
+     */
+    abstract name: string;
+    /**
+     * The emitter that belongs to this plugin.
+     */
+    private _emitter;
+    /**
+     * Register this plugin with the event system.
+     * @param pEmitter - The emitter that belongs to this plugin.
+     */
+    _register(pEmitter: EventEmitter): void;
+    /**
+     * The entry point for custom behavior after registration for custom plugins.
+     */
+    abstract onRegistered(): void;
+    /**
+     * Emit an event.
+     * @param pEvent - The event to emit.
+     */
+    emit(pEvent: EmitterEvent): void;
+}
+//# sourceMappingURL=kit-plugin.d.ts.map

package/lib/plugins/kit-plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kit-plugin.d.ts","sourceRoot":"","sources":["../../src/plugins/kit-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAE1D,8BAAsB,SAAS;IAC3B;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,CAAC,QAAQ,CAA6B;IAE7C;;;OAGG;IACH,SAAS,CAAC,QAAQ,EAAE,YAAY;IAIhC;;OAEG;IACH,QAAQ,CAAC,YAAY,IAAI,IAAI;IAE7B;;;OAGG;IACH,IAAI,CAAC,MAAM,EAAE,YAAY;CAO5B"}

package/lib/plugins/kit-plugin.js

@@ -0,0 +1,24 @@
+export class KitPlugin {
+    /**
+     * The emitter that belongs to this plugin.
+     */
+    _emitter = null;
+    /**
+     * Register this plugin with the event system.
+     * @param pEmitter - The emitter that belongs to this plugin.
+     */
+    _register(pEmitter) {
+        this._emitter = pEmitter;
+    }
+    /**
+     * Emit an event.
+     * @param pEvent - The event to emit.
+     */
+    emit(pEvent) {
+        if (!this._emitter) {
+            console.error('[Kit Plugin] emitter not set. This is an indication that the plugin is not registered.');
+            return;
+        }
+        this._emitter.emit(pEvent);
+    }
+}

package/lib/plugins/network/index.d.ts

@@ -0,0 +1,48 @@
+import { KitPlugin } from '../kit-plugin';
+import type { Client } from '../../types/vylo.d.ts';
+export type NetworkListener<T extends unknown[] = unknown[]> = (pClient: Client, ...pData: T) => void;
+export declare class Network extends KitPlugin {
+    name: string;
+    /**
+     * If this plugin is initiated.
+     */
+    private initiated;
+    /**
+     * The packets that this plugin has registered. It is in the format of name: index
+     */
+    private packets;
+    /**
+     * The packets that this plugin has registered. It is in the format of index: name
+     */
+    private reversedPacketMap;
+    onRegistered(): void;
+    /**
+     * The listeners that are registered.
+     */
+    private listeners;
+    /**
+     * Register a listener for a packet.
+     * @param pPacketName - The name of the packet that will be listened to.
+     * @param pListener - The listener that will be called when the packet is received.
+     */
+    on<T extends unknown[]>(pPacketName: string, pListener: NetworkListener<T>): void;
+    /**
+     * API for receiving data from the server.
+     * @param pClient - The client involved with this packet.
+     * @param pPacketName - The name of the packet that was sent.
+     * @param pData - The data that was sent.
+     * @param [pVerbose] - If the plugin should log packets.
+     */
+    onNetwork(pClient: Client, pPacketName: number | string, pData?: unknown[], pVerbose?: boolean): void;
+    /**
+     * Register the packets registry.
+     * @param pPackets - An array of strings that represent the packet names.
+     */
+    registerPackets(pPackets: readonly string[]): void;
+    /**
+     * Gets the index of a packet.
+     * @param pPacketName - The name of the packet.
+     */
+    getPacket(pPacketName: string): number | undefined;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/plugins/network/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugins/network/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAEpD,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,OAAO,EAAE,GAAG,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;AAEtG,qBAAa,OAAQ,SAAQ,SAAS;IAClC,IAAI,SAAa;IACjB;;OAEG;IACH,OAAO,CAAC,SAAS,CAAkB;IACnC;;OAEG;IACH,OAAO,CAAC,OAAO,CAAkC;IACjD;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAkC;IAC3D,YAAY,IAAI,IAAI;IAGpB;;OAEG;IACH,OAAO,CAAC,SAAS,CAAiD;IAClE;;;;OAIG;IACH,EAAE,CAAC,CAAC,SAAS,OAAO,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC,CAAC,GAAG,IAAI;IAMjF;;;;;;OAMG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,GAAE,OAAO,EAAO,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI;IA4BzG;;;OAGG;IACH,eAAe,CAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI;IASlD;;;OAGG;IACH,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;CAOrD"}

package/lib/plugins/network/index.js

@@ -0,0 +1,88 @@
+import { KitPlugin } from '../kit-plugin';
+export class Network extends KitPlugin {
+    name = 'Network';
+    /**
+     * If this plugin is initiated.
+     */
+    initiated = false;
+    /**
+     * The packets that this plugin has registered. It is in the format of name: index
+     */
+    packets = new Map();
+    /**
+     * The packets that this plugin has registered. It is in the format of index: name
+     */
+    reversedPacketMap = new Map();
+    onRegistered() {
+        this.initiated = true;
+    }
+    /**
+     * The listeners that are registered.
+     */
+    listeners = new Map();
+    /**
+     * Register a listener for a packet.
+     * @param pPacketName - The name of the packet that will be listened to.
+     * @param pListener - The listener that will be called when the packet is received.
+     */
+    on(pPacketName, pListener) {
+        if (!this.packets.has(pPacketName)) {
+            throw new Error(`Packet name '${pPacketName}' is not registered.`);
+        }
+        this.listeners.set(pPacketName, pListener);
+    }
+    /**
+     * API for receiving data from the server.
+     * @param pClient - The client involved with this packet.
+     * @param pPacketName - The name of the packet that was sent.
+     * @param pData - The data that was sent.
+     * @param [pVerbose] - If the plugin should log packets.
+     */
+    onNetwork(pClient, pPacketName, pData = [], pVerbose) {
+        if (!this.initiated)
+            return;
+        if (typeof pPacketName === 'number') {
+            const packetName = this.reversedPacketMap.get(pPacketName);
+            if (!packetName) {
+                console.warn(`Unknown packet index: ${pPacketName}`);
+                return;
+            }
+            const listener = this.listeners.get(packetName);
+            if (pVerbose) {
+                console.group(`Kit.${this.name}Plugin.onNetwork`);
+                console.log(`Packet name: ${pPacketName}`);
+                console.log(`Resolved packet name: ${packetName}`);
+                console.log(`Data:`, pData);
+                console.groupEnd();
+                if (!listener) {
+                    console.warn(`No listener registered for packet: ${packetName}`);
+                }
+            }
+            listener?.(pClient, ...pData);
+        }
+    }
+    /**
+     * Register the packets registry.
+     * @param pPackets - An array of strings that represent the packet names.
+     */
+    registerPackets(pPackets) {
+        this.packets.clear();
+        this.reversedPacketMap.clear();
+        pPackets.forEach((name, index) => {
+            this.packets.set(name, index);
+            this.reversedPacketMap.set(index, name);
+        });
+    }
+    /**
+     * Gets the index of a packet.
+     * @param pPacketName - The name of the packet.
+     */
+    getPacket(pPacketName) {
+        const packet = this.packets.get(pPacketName);
+        if (packet === undefined) {
+            console.warn(`Packet '${pPacketName}' is not registered.`);
+        }
+        ;
+        return packet;
+    }
+}

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

@@ -1,4 +1,5 @@
-import type { KitPlugin } from '@evitcastudio/kit-plugin';
+import type { KitPlugin } from '../plugins/kit-plugin';
+import type { VyloType } from './vylo.d.ts';
 /**
  * The EmitterEvent type is used to define the shape of the data that is passed to the event listeners.
  */
@@ -11,7 +12,8 @@ type EmitterEvent = {
      * The data associated with the event.
      */
     data?: Record<string, unknown>;
-} & Record<string, unknown>;
+    [key: string]: unknown;
+};
 type ResourceData = {
     resourceIdentifier: string;
     fileName: string;
@@ -19,6 +21,9 @@ type ResourceData = {
 type Listener = (pData: EmitterEvent) => void;
 type KitPluginConstructor<T extends KitPlugin> = new () => T;
 declare global {
+    /**
+     * The Vylocity engine.
+     */
     var VYLO: VyloType;
 }
 export type { EmitterEvent, ResourceData, Listener, KitPluginConstructor };

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

@@ -1 +1 @@
-{"version":3,"file":"shared-types.d.ts","sourceRoot":"","sources":["../../src/types/shared-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAE1D;;GAEG;AACH,KAAK,YAAY,GAAG;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE5B,KAAK,YAAY,GAAG;IAChB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAA;CACnB,CAAC;AAEF,KAAK,QAAQ,GAAG,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;AAE9C,KAAK,oBAAoB,CAAC,CAAC,SAAS,SAAS,IAAI,UAAU,CAAC,CAAC;AAC7D,OAAO,CAAC,MAAM,CAAC;IAEX,IAAI,IAAI,EAAE,QAAQ,CAAC;CACtB;AAED,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,oBAAoB,EAAE,CAAC"}
+{"version":3,"file":"shared-types.d.ts","sourceRoot":"","sources":["../../src/types/shared-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C;;GAEG;AACH,KAAK,YAAY,GAAG;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B,CAAA;AAED,KAAK,YAAY,GAAG;IAChB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAA;CACnB,CAAC;AAEF,KAAK,QAAQ,GAAG,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC;AAE9C,KAAK,oBAAoB,CAAC,CAAC,SAAS,SAAS,IAAI,UAAU,CAAC,CAAC;AAC7D,OAAO,CAAC,MAAM,CAAC;IACX;;OAEG;IAEH,IAAI,IAAI,EAAE,QAAQ,CAAC;CACtB;AAED,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,QAAQ,EAAE,oBAAoB,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evitcastudio/kit",
-  "version": "1.3.2",
+  "version": "2.0.0",
   "author": "doubleactii 56242467+doubleactii@users.noreply.github.com (https://evitcastudio.com)",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -40,7 +40,6 @@
   "devDependencies": {
     "@eslint/create-config": "1.4.0",
     "@eslint/js": "^9.17.0",
-    "@evitcastudio/kit-plugin": "^1.0.7",
     "@types/bun": "latest",
     "@types/node": "^22.10.2",
     "bun": "^1.1.42",