@cybermp-community/browser-types 1.0.6 → 1.0.8

package/README.md

@@ -1,33 +1,50 @@
 # CyberMP Browser Types
 
-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.
+`@cybermp-community/browser-types` types the global `mp` of the CEF page. The page exchanges events with the client script.
 
-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
-
-Using NPM:
+## Installation
 
 ```bash
+# npm
 npm install -D @cybermp-community/browser-types
+
+# pnpm
+pnpm add -D @cybermp-community/browser-types
+
+# bun
+bun add -d @cybermp-community/browser-types
 ```
 
-Using PNPM:
+## Usage
 
-```bash
-pnpm install -D @cybermp-community/browser-types
+`browser/global.d.ts`:
+
+```ts
+import type { MpBrowser } from "@cybermp-community/browser-types";
+
+declare global {
+  const mp: MpBrowser;
+}
 ```
 
-Using Bun:
+`browser/main.ts` runs in the page the client opened with `mp.cef.setUrl`:
 
-```bash
-bun add -d @cybermp-community/browser-types
+```ts
+mp.events.emit("ui:ready");
+
+mp.events.on("ui:close", () => {
+  mp.events.emit("ui:closed");
+});
 ```
 
-## 📜 Disclaimer
+`mp.events.emit` arrives on the client as `mp.events.onCef`. `mp.events.on` receives events the client sent with `mp.events.emitCef`.
+
+Put `global.d.ts` next to the page scripts so `include` in `tsconfig.json` picks it up.
+
+## Disclaimer
 
-This repository is developed by [CyberMP Community Developers](https://gitlab.com/cybermp) and is not directly related to CyberMP (cyber.mp).
+This repository is developed by [CyberMP Community Developers](https://gitlab.com/cybermp) and is separate from CyberMP (cyber.mp).
 
-## ⚖️ License
+## License
 
-This project is licensed under the СС BY-SA 4.0 License - see the [LICENSE](LICENSE) file for details.
+CC BY-SA 4.0. See the [LICENSE](LICENSE) file for details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cybermp-community/browser-types",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "TypeScript type definitions for the CyberMP browser environment (CEF).",
   "license": "CC BY-SA 4.0",
   "author": {
@@ -49,3 +49,4 @@
     "@biomejs/biome": "^2.0.0"
   }
 }
+

package/src/index.ts

@@ -1 +1 @@
-export * from "./mp"
+export * from './mp';

package/src/mp.d.ts

@@ -25,4 +25,4 @@ export interface MpBrowser {
   events: MpEvents;
 }
 
-export const mp: MpBrowser;
+export declare const mp: MpBrowser;