@cybermp-community/browser-types 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

package/README.md

@@ -0,0 +1,44 @@
+# CyberMP Browser Types
+> By [CyberMP Community Developers](https://gitlab.com/cybermp).
+
+This repository contains the TypeScript type definitions for the **[CyberMP](https://cyber.mp) user interface (CEF)** environment, providing comprehensive type safety for creating the game's UI in a browser context.
+
+These types allow for robust communication between the UI and the client, as well as access to any browser-side APIs provided by the CyberMP mod.
+
+## 📦 Installation
+
+### 1. Install Package
+
+Using NPM:
+
+```bash
+npm install -D @cybermp-community/browser-types
+```
+
+Using PNPM:
+
+```bash
+pnpm install -D @cybermp-community/browser-types
+```
+
+Using Bun:
+
+```bash
+bun add -d @cybermp-community/browser-types
+```
+
+### 2. Set types in tsconfig.json
+
+```json
+{
+   "compilerOptions": {
+        "types": [
+            "@cybermp-community/browser-types"
+        ]
+    }
+}
+```
+
+## ⚖️ License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@cybermp-community/browser-types",
+  "version": "1.0.0",
+  "description": "TypeScript type definitions for the CyberMP browser environment (CEF).",
+  "main": "src/index.d.ts",
+  "files": [
+    "src/index.d.ts"
+  ],
+  "repository": {
+    "type": "gitlab",
+    "url": "https://gitlab.com/cybermp/types/browser"
+  },
+  "scripts": {
+    "bump": "npm version patch --no-git-tag-version",
+    "pub": "npm publish --access public"
+  },
+  "keywords": [
+    "cybermp",
+    "cyberpunk",
+    "multiplayer",
+    "mp",
+    "browser",
+    "cef",
+    "cp2077",
+    "types"
+  ],
+  "author": "An1by",
+  "license": "MIT",
+  "contributors": [
+    "terminaate"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,28 @@
+export interface MpEvents {
+  /**
+   * Used for listening for events coming from client-side.
+   * @param eventName Name of the event to listen for.
+   * @param callback Function to execute when the event is triggered.
+   */
+  on(eventName: string, callback: (...args: any[]) => void): void;
+
+  /**
+   * Removes a previously registered event listener.
+   * @param eventName Name of the event.
+   * @param func Callback function to remove.
+   */
+  off(eventName: string, func: (...args: any[]) => void): void;
+
+  /**
+   * Triggers an event on client-side.
+   * @param eventName Name of the event to trigger.
+   * @param args Arguments to send with the event.
+   */
+  emit(eventName: string, ...args: any[]): void;
+}
+
+export interface MpBrowser {
+  events: MpEvents;
+}
+
+export const mp: MpBrowser;