@cybermp-community/client-types 2.3.7 → 2.4.1

package/LICENSE

@@ -1,21 +1,19 @@
-MIT License
+Creative Commons Attribution-ShareAlike 4.0 International
 
 Copyright (c) 2026 CyberMP Community Developers
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
+International License. To view a copy of this license, visit
+https://creativecommons.org/licenses/by-sa/4.0/ or send a letter to
+Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+You are free to:
+- Share: copy and redistribute the material in any medium or format
+- Adapt: remix, transform, and build upon the material for any purpose,
+  even commercially
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+Under the following terms:
+- Attribution: You must give appropriate credit, provide a link to the
+  license, and indicate if changes were made.
+- ShareAlike: If you remix, transform, or build upon the material, you
+  must distribute your contributions under the same license as the original.

package/{README → README.md}

@@ -4,12 +4,13 @@ This repository contains the TypeScript type definitions for the **[CyberMP](htt
 
 These types cover the `mp` object, the game's internal classes, enums, and bitfields.
 
-### 🖥️ Integrated Libraries
+### 🖥️ Integrated Libraries (which supports CyberMP)
 This package includes built-in types for the following essential modding libraries, providing full type safety and IntelliSense for their respective classes and functions:
 
-- **[Codeware](https://github.com/psiberx/cp2077-codeware) v1.19.1**
-- **[ArchiveXL](https://github.com/psiberx/cp2077-archive-xl) v1.26.3**
-- **[TweakXL](https://github.com/psiberx/cp2077-tweak-xl) v1.11.3**
+- **Cyberpunk 2077 2.31**
+- **[Codeware](https://github.com/psiberx/cp2077-codeware) v1.18.0**
+- **[ArchiveXL](https://github.com/psiberx/cp2077-archive-xl) v1.26.0**
+- **[TweakXL](https://github.com/psiberx/cp2077-tweak-xl) v1.11.0**
 
 ## 📦 Installation
 
@@ -37,4 +38,4 @@ This repository is developed by [CyberMP Community Developers](https://gitlab.co
 
 ## ⚖️ License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the СС BY-SA 4.0 License - see the [LICENSE](LICENSE) file for details.

package/dist/classes.d.ts

@@ -142692,16 +142692,6 @@ export class ResourceToken {
     RegisterCallback(target: M.Handle<IScriptable>, function1: string): void;
 }
 
-export class SoundBankEntry {
-    name: string;
-    isResident: boolean;
-    resourcePath: ResRef;
-}
-
-export class SoundBanksJson extends CResource {
-    soundBanks: SoundBankEntry[];
-}
-
 export class ResetSecuritySystemNetwork extends redEvent {
 }
 
@@ -142882,15 +142872,12 @@ export class Reflection {
     static GetType(name: string): M.Handle<ReflectionType>;
     static GetClass(name: string): M.Handle<ReflectionClass>;
     static GetEnum(name: string): M.Handle<ReflectionEnum>;
-    static GetBitfield(name: string): M.Handle<ReflectionBitfield>;
     static GetGlobalFunction(name: string): M.Handle<ReflectionStaticFunc>;
     static GetTypes(): M.Handle<ReflectionType>[];
     static GetClasses(): M.Handle<ReflectionClass>[];
     static GetDerivedClasses(base: string): M.Handle<ReflectionClass>[];
     static GetEnums(): M.Handle<ReflectionEnum>[];
-    static GetBitfields(): M.Handle<ReflectionBitfield>[];
     static GetGlobalFunctions(): M.Handle<ReflectionStaticFunc>[];
-    Call(name: string, args?: any[]): any;
 }
 
 export class ReflectionClass extends ReflectionType {
@@ -142914,11 +142901,6 @@ export class ReflectionEnum extends ReflectionType {
     AddConstant(name: string, value: bigint): void;
 }
 
-export class ReflectionBitfield extends ReflectionType {
-    GetConstants(): M.Handle<ReflectionConst>[];
-    IsNative(): boolean;
-}
-
 export class ReflectionConst {
     GetName(): string;
     GetValue(): bigint;
@@ -142957,10 +142939,8 @@ export class ReflectionType {
     IsArray(): boolean;
     IsClass(): boolean;
     IsEnum(): boolean;
-    IsBitfield(): boolean;
     AsClass(): M.Handle<ReflectionClass>;
     AsEnum(): M.Handle<ReflectionEnum>;
-    AsBitfield(): M.Handle<ReflectionBitfield>;
 }
 
 export class ControllerDelayCallback extends gameDelaySystemScriptedDelayCallbackWrapper {

package/dist/mp-classes.d.ts

@@ -15869,8 +15869,6 @@ export interface MpClasses {
     ResRef: typeof C.ResRef;
     ResAsyncRef: typeof C.ResAsyncRef;
     ResourceToken: typeof C.ResourceToken;
-    SoundBankEntry: typeof C.SoundBankEntry;
-    SoundBanksJson: typeof C.SoundBanksJson;
     ResetSecuritySystemNetwork: typeof C.ResetSecuritySystemNetwork;
     EntityBuilderWrapper: typeof C.EntityBuilderWrapper;
     EntityBuilderTemplateWrapper: typeof C.EntityBuilderTemplateWrapper;
@@ -15892,7 +15890,6 @@ export interface MpClasses {
     Reflection: typeof C.Reflection;
     ReflectionClass: typeof C.ReflectionClass;
     ReflectionEnum: typeof C.ReflectionEnum;
-    ReflectionBitfield: typeof C.ReflectionBitfield;
     ReflectionConst: typeof C.ReflectionConst;
     ReflectionFunc: typeof C.ReflectionFunc;
     ReflectionMemberFunc: typeof C.ReflectionMemberFunc;

package/dist/precomputed/cef.d.ts

@@ -1,5 +1,9 @@
 export interface MpCef {
-  setFocus(focus: boolean, cursor?: boolean = focus): void;
+  /**
+   * @param focus Is need to focus CEF.
+   * @param cursor By default equals focus. 
+   */
+  setFocus(focus: boolean, cursor?: boolean): void;
   isInFocus(): boolean;
   setUrl(url: string): void;
 }

package/dist/precomputed/{classes.d.ts → classes/extend.d.ts}

@@ -1,15 +1,9 @@
 
-import type { UnwrapClass } from './game.d.ts';
-import type { MpClasses } from '../mp-classes.d.ts';
-import * as CyberEnums from '../enums';
+import type { UnwrapClass } from '../../game.d.ts';
+import type { MpClasses } from '../../mp-classes.d.ts';
+import * as CyberEnums from '../../enums';
 
-export class LoadingScreenSystem {
-    GetLoadingScreenState(): CyberEnums.ELoadingScreenState;
-    GetLoadingScreenProgress(): number;
-    OnLoadingScreenStateChange(newState: CyberEnums.ELoadingScreenState): void;
-}
-
-declare module '../classes.d.ts' {
+declare module '../../classes.d.ts' {
     export interface entEntity {
         GetMorphTargets(): entMorphTargetWeightEntry[];
     }
@@ -62,10 +56,6 @@ declare module '../classes.d.ts' {
         export function GetHash(value: any): bigint;
     }
 
-    export namespace ScriptGameInstance {
-        export function GetLoadingScreenSystem(): LoadingScreenSystem;
-    }
-
     export interface inkISystemRequestsHandler {
         StartMainMenu(): void;
     }
@@ -84,7 +74,9 @@ declare module '../classes.d.ts' {
     }
 
     export interface entEntity {
-        ReassembleWithComponents(arr: entIComponent[]): void
+        GetMorphWeights(): entMorphTargetWeightEntry[];
+        ReassembleWithComponents(arr: entIComponent[]): void;
+        TeleportPed(position: Vector3, rotation?: EulerAngles): void;
     }
 
     export interface AimingStateDecisions {
@@ -96,7 +88,7 @@ declare module '../classes.d.ts' {
         OnItemEquipped(slot: CyberEnums.AttachmentSlots, item: gameItemID): void;
         OnItemUnequipped(slot: CyberEnums.AttachmentSlots, item: gameItemID): void;
     }
-    
+
     export interface ApplyStatGroupEffectorCallback {
         OnItemEquipped(slot: CyberEnums.AttachmentSlots, item: gameItemID): void;
         OnItemUnequipped(slot: CyberEnums.AttachmentSlots, item: gameItemID): void;
@@ -106,10 +98,4 @@ declare module '../classes.d.ts' {
         SetPlayerGender(gender: CyberEnums.PlayerGender, savedPos?: boolean): void;
         OnPlayerGenderChanged(gender: CyberEnums.PlayerGender): void;
     }
-}
-
-declare module '../mp-classes.d.ts' {
-    export interface MpClasses {
-        LoadingScreenSystem: typeof LoadingScreenSystem;
-    }
 }

package/dist/precomputed/classes/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./extend";
+export * from "./screens";

package/dist/precomputed/classes/screens.d.ts

@@ -0,0 +1,46 @@
+import type { MpClasses } from "../../mp-classes.d.ts";
+import type * as C from "../../classes.d.ts";
+import type * as E from "../../enums";
+import type * as M from "../../common.d.ts";
+
+export class LoadingScreenSystem {
+  GetLoadingScreenState(): E.ELoadingScreenState;
+  GetLoadingScreenProgress(): number;
+  OnLoadingScreenStateChange(newState: E.ELoadingScreenState): void;
+}
+
+export class MultiplayerSystem {
+  /**
+   * Removes game object classes (e.g., T extends gameObject, playerPuppet, NpcPuppet) from the map.
+   * @param objectClassMap Array of class names to delete.
+   */
+  DeclareDeletedObjects(objectClassMap: Array<keyof MpClasses>): void;
+
+  /**
+   * Removes game objects by their unique hashes from the map.
+   * @param objectHashMap Array of unique game object hashes to delete.
+   */
+  DeletedObjectsByUniqueHash(objectHashMap: string[]): void;
+
+  /**
+   * Enables or disables synchronization of default effects, as defined by the CyberMP platform.
+   * @param value Whether to use the default effects.
+   */
+  UseDefaultEffectsByPlatform(value: boolean): void;
+
+  SetDefaultSpawnPosition(position: C.Vector3, yaw: number): void;
+}
+
+declare module "../../mp-classes.d.ts" {
+  export interface MpClasses {
+    LoadingScreenSystem: typeof LoadingScreenSystem;
+    MultiplayerSystem: typeof MultiplayerSystem;
+  }
+}
+
+declare module "../../classes.d.ts" {
+  export namespace ScriptGameInstance {
+    function GetLoadingScreenSystem(): M.Handle<LoadingScreenSystem>;
+    function GetMultiplayerSystem(): M.Handle<MultiplayerSystem>;
+  }
+}

package/dist/precomputed/events.d.ts

@@ -1,17 +1,19 @@
+type Args = any[];
+
 export interface MpEvents {
   /**
    * Register a custom event listener.
    * @param eventName Name of the event.
    * @param callback Callback function.
    */
-  on(eventName: string, callback: (...args: any[]) => void): void;
+  on<T extends Array = Args>(eventName: string, callback: (...args: T) => void): void;
 
   /**
    * UnRegister a custom event listener.
    * @param eventName Name of the event.
    * @param callback Callback function.
    */
-  off(eventName: string, callback: (...args: any[]) => void): void;
+  off<T extends Array = Args>(eventName: string, callback: (...args: T) => void): void;
 
   /**
    * Emit a previously registered custom event.
@@ -19,29 +21,29 @@ export interface MpEvents {
    * @param eventName Name of the event.
    * @param args Arguments to pass.
    */
-  emit(eventName: string, ...args: any[]): void;
+  emit<T extends Array = Args>(eventName: string, ...args: T): void;
 
   /**
    * Register a listener for server event on client.
    */
-  onServer(eventName: string, callback: (...args: any[]) => void): void;
+  onServer<T extends Array = Args>(eventName: string, callback: (...args: T) => void): void;
 
   /**
    * Emit an event to the server.
    */
-  emitServer(eventName: string, ...args: any[]): void;
+  emitServer<T extends Array = Args>(eventName: string, ...args: T): void;
 
   /**
    * Emit an event to the cef.
    */
-  emitCef(eventName: string, ...args: any[]): void;
+  emitCef<T extends Array = Args>(eventName: string, ...args: T): void;
 
   /**
    * Register a custom cef event listener.
    * @param eventName Name of the event.
    * @param callback Callback function.
    */
-  onCef(eventName: string, callback: (...args: any[]) => void): void;
+  onCef<T extends Array = Args>(eventName: string, callback: (...args: T) => void): void;
 
   /**
    * Register a command in the client scope.

package/dist/precomputed/exports.d.ts

@@ -1,5 +1,12 @@
-export interface MpExports {
-    [module: string]: {
-        [name: string]: (...args: unknown[]) => unknown;
-    };
-}
+export type MpExports = MpExternalExports & MpCreateExport;
+
+interface MpExternalExports {
+  [module: string]: {
+    [name: string]: <T extends unknown[] = unknown[], R = unknown>(...args: T) => R | Promise<R>;
+  };
+}
+
+type MpCreateExport = <T extends unknown[] = unknown[], R = unknown>(
+  name: string,
+  callback: (...args: T) => R | Promise<R>,
+) => void;

package/dist/precomputed/game.d.ts

@@ -1,10 +1,9 @@
-
-import type { Vector3 } from '../classes.d.ts';
-import type { MpClasses } from '../mp-classes.d.ts';
-import * as CyberEnums from '../enums';
+import type { Vector3 } from "../classes.d.ts";
+import type { MpClasses } from "../mp-classes.d.ts";
+import type * as CyberEnums from "../enums";
 
 // THIS CODE IS FOR PRECOMPUTED TYPES
-export type UnwrapClass<T> = T extends { new(): infer U } ? U : T;
+export type UnwrapClass<T> = T extends { new (): infer U } ? U : T;
 
 export type OverrideFunction = <
   C extends keyof MpClasses,
@@ -63,7 +62,7 @@ export interface CyberMP {
   SetDefaultSpawnPosition(position: Vector3, yaw: number): void;
 }
 
-declare module '../game.d.ts' {
+declare module "../game.d.ts" {
   export interface MpGame {
     CyberMP: CyberMP;
     TweakDB: TweakDB;
@@ -113,7 +112,21 @@ declare module '../game.d.ts' {
      * @param type Model name type
      * @returns Model hash
      */
-    getHashFromName(name: string, type: 'tweakdbid' | 'cname' | 'resref'): string;
+    getHashFromName(
+      name: string,
+      type: "tweakdbid" | "cname" | "resref",
+    ): string;
+
+    /**
+     * Returns model name.
+     * @param name Model hash
+     * @param type Model hash type
+     * @returns Model name
+     */
+    getNameFromHash(
+      hash: string,
+      type: "tweakdbid" | "cname" | "resref",
+    ): string;
 
     /**
      * Overrides method function inside selected class.
@@ -177,4 +190,3 @@ declare module '../game.d.ts' {
     fromVariant<R = any>(obj: any): R;
   }
 }
-

package/dist/precomputed/index.d.ts

@@ -1,4 +1,4 @@
-export type * from './classes.d.ts';
+export type * from './classes';
 export type * from './cef.d.ts';
 export type * from './discord.d.ts';
 export type * from './events.d.ts';

package/dist/precomputed/mp.d.ts

@@ -123,7 +123,7 @@ declare module '../mp.d.ts' {
     /**
      * Returns time in ms since game start.
      */
-    getTimer(): number;
+    getGameTimer(): number;
 
     getLauncherSettingsJSON(): string;
 

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@cybermp-community/client-types",
-  "version": "2.3.7",
+  "version": "2.4.1",
   "description": "TypeScript type definitions for the CyberMP client-side environment.",
-  "license": "MIT",
+  "license": "CC BY-SA 4.0",
   "author": {
     "name": "An1by",
     "url": "https://gitlab.com/an1by"
@@ -30,12 +30,15 @@
     "dist"
   ],
   "scripts": {
+    "format": "biome format --write .",
+    "lint": "biome lint .",
+    "check": "biome check .",
     "redscript:dumper:build": "cd dumper && cargo build --release",
     "dumps:generate:codeware": "./dumper/target/release/codeware-dumper.exe ./libs/codeware/scripts -r -o ./json/redscript/codeware",
-    "dunps:generate:tweak-xl": "./dumper/target/release/codeware-dumper.exe ./libs/tweak-xl/scripts -r -o ./json/redscript/tweak-xl",
-    "dunps:generate:archive-xl": "./dumper/target/release/codeware-dumper.exe ./libs/archive-xl/scripts -r -o ./json/redscript/archive-xl",
+    "dumps:generate:tweak-xl": "./dumper/target/release/codeware-dumper.exe ./libs/tweak-xl/scripts -r -o ./json/redscript/tweak-xl",
+    "dumps:generate:archive-xl": "./dumper/target/release/codeware-dumper.exe ./libs/archive-xl/scripts -r -o ./json/redscript/archive-xl",
     "dumps:cyberpunk:download": "tsx ./scripts/download-dumps.ts",
-    "dumps:generate": "rimraf ./json && bun run dumps:cyberpunk:download && bun run dunps:generate:archive-xl && bun run dunps:generate:tweak-xl && bun run dumps:generate:codeware",
+    "dumps:generate": "rimraf ./json && bun run dumps:cyberpunk:download && bun run dumps:generate:archive-xl && bun run dumps:generate:tweak-xl && bun run dumps:generate:codeware",
     "types:apply-modified": "tsx ./scripts/apply-modified.ts",
     "types:generate": "tsx ./src",
     "generate": "bun run dumps:generate && bun run types:apply-modified && bun run types:generate",
@@ -56,7 +59,8 @@
     "tweakxl"
   ],
   "devDependencies": {
-    "@types/node": "^20.11.20",
+    "@biomejs/biome": "^2.0.0",
+    "@types/node": "^25.6.0",
     "consola": "^3.2.3",
     "fs-extra": "^11.3.4",
     "rimraf": "^5.0.5",