@cybermp-community/server-types 1.0.4 → 1.0.6

package/README.md

@@ -6,8 +6,6 @@ These types are designed to work seamlessly with the CyberMP server environment,
 
 ## 📦 Installation
 
-### 1. Install Package
-
 Using NPM:
 
 ```bash
@@ -26,18 +24,6 @@ Using Bun:
 bun add -d @cybermp-community/server-types
 ```
 
-### 2. Set types in tsconfig.json
-
-```json
-{
-   "compilerOptions": {
-        "types": [
-            "@cybermp-community/server-types"
-        ]
-    }
-}
-```
-
 ## 📜 Disclaimer
 
 This repository is developed by [CyberMP Community Developers](https://gitlab.com/cybermp) and is not directly related to CyberMP (cyber.mp).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cybermp-community/server-types",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "TypeScript type definitions for the CyberMP server-side environment.",
   "license": "MIT",
   "author": {
@@ -17,11 +17,12 @@
   "publishConfig": {
     "access": "public"
   },
-  "types": "./src/index.d.ts",
+  "main": "./src/index.ts",
+  "types": "./src/index.ts",
   "exports": {
     ".": {
-      "import": "./src/index.d.ts",
-      "types": "./src/index.d.ts"
+      "import": "./src/index.ts",
+      "types": "./src/index.ts"
     }
   },
   "files": [

package/src/hashes.d.ts

@@ -1,7 +1,27 @@
 import type { CName, ResRef, TweakDBID } from './shared';
 
+/**
+ * Interface providing utility methods to hash object paths into internal types.
+ */
 export interface MpHashes {
+  /**
+   * Converts a string path into a TweakDBID hash.
+   * @param path - The string path of entry.
+   * @returns The corresponding TweakDBID.
+   */
   tweakdbid(path: string): TweakDBID;
+
+  /**
+   * Converts a string path into a CName hash.
+   * @param path - The string path of entry.
+   * @returns The corresponding CName.
+   */
   cname(path: string): CName;
+
+  /**
+   * Converts a string path into a ResRef hash.
+   * @param path - The string path of entry.
+   * @returns The corresponding ResRef.
+   */
   resref(path: string): ResRef;
 }

package/src/index.ts

@@ -0,0 +1,13 @@
+export type * from './commands';
+export type * from './entities';
+export type * from './events';
+export type * from './hashes';
+export type * from './meta';
+export type * from './mp';
+export type * from './objects';
+export type * from './peds';
+export type * from './pickups';
+export type * from './resources';
+export type * from './shared';
+export type * from './vehicles';
+export type * from './voice-chat';

package/src/mp/multiplayer.d.ts

@@ -32,7 +32,7 @@ export interface MpServer {
    */
   isServer(): boolean;
 
-  config: MpServ.ServerConfig;
+  config: MpServ.ServerConfig & Record<string, string>;
 }
 
 export const mp: MpServer;

package/src/resources.d.ts

@@ -18,6 +18,10 @@ export interface MpResources {
    */
   stop(resourceName: string): void;
 
+  /**
+ * Restarts a specific resource by name.
+ * @param resourceName Name of the resource to restart.
+ */
   restart(resourceName: string): void;
 
   /**

package/src/voice-chat.d.ts

@@ -1,9 +1,26 @@
 import type { MpPlayer } from './entities';
 
+/**
+ * Interface representing the voice chat management system on the server.
+ */
 export interface MpVoiceChat {
-  mutePlayer(player: MpPlayer | number): void;
+  /**
+   * Mutes or unmutes a specific player.
+   * @param player - The player instance or their unique ID.
+   * @param state - Set to `true` to mute, `false` to unmute.
+   */
+  mutePlayer(player: MpPlayer | number, state: boolean): void;
 
+  /**
+   * Creates a new voice chat channel.
+   * @param voiceId - The unique identifier for the voice channel.
+   */
   createChannel(voiceId: number): void;
 
+  /**
+   * Checks whether a specific player is currently muted in the voice chat.
+   * @param player - The player instance or their unique ID.
+   * @returns `true` if the player is muted, `false` otherwise.
+   */
   isPlayerMuted(player: MpPlayer | number): boolean;
 }

package/src/index.d.ts

@@ -1,13 +0,0 @@
-export type * from './commands.d.ts';
-export type * from './entities';
-export type * from './events';
-export type * from './hashes.d.ts';
-export type * from './meta.d.ts';
-export type * from './mp';
-export type * from './objects.d.ts';
-export type * from './peds.d.ts';
-export type * from './pickups.d.ts';
-export type * from './resources.d.ts';
-export type * from './shared';
-export type * from './vehicles.d.ts';
-export type * from './voice-chat.d.ts';