@warpfx/client 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @warp/client — Typed SDK for Warp client-side module development.
+ *
+ * Provides type-safe access to the Warp client API. Under the hood,
+ * all calls go through FiveM's resource exports to the 'warp' resource.
+ *
+ * Usage:
+ *   import { onReady, getEvents } from '@warp/client';
+ *
+ *   onReady(() => {
+ *     const events = getEvents();
+ *     events.onServer('economy:balance', (data) => { ... });
+ *     events.emitServer('economy:request-balance', {});
+ *   });
+ */
+/** Typed event bus for client-side and network communication. */
+interface ClientEventBus<TMap extends Record<string, any> = Record<string, any>> {
+    /** Subscribe to a local event. Returns an unsubscribe function. */
+    on<K extends string & keyof TMap>(event: K, handler: (data: TMap[K]) => void): () => void;
+    /** Unsubscribe from a local event. */
+    off<K extends string & keyof TMap>(event: K, handler: (data: TMap[K]) => void): void;
+    /** Emit a local event to all subscribers. */
+    emit<K extends string & keyof TMap>(event: K, data: TMap[K]): void;
+    /** Send an event to the server. */
+    emitServer<K extends string & keyof TMap>(event: K, data: TMap[K]): void;
+    /** Listen for events from the server. Returns an unsubscribe function. */
+    onServer<K extends string & keyof TMap>(event: K, handler: (data: TMap[K]) => void): () => void;
+    /** Unsubscribe from a server event. */
+    offServer<K extends string & keyof TMap>(event: K, handler: (data: TMap[K]) => void): void;
+}
+/**
+ * Register a callback to run when Warp client is ready.
+ * If already ready, the callback fires immediately.
+ */
+declare function onReady(cb: () => void): void;
+/** Check if Warp client has finished initializing. */
+declare function isReady(): boolean;
+/** Get the shared client event bus instance. */
+declare function getEvents<TMap extends Record<string, any> = Record<string, any>>(): ClientEventBus<TMap>;
+
+export { type ClientEventBus, getEvents, isReady, onReady };

package/dist/index.js

@@ -0,0 +1,45 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  getEvents: () => getEvents,
+  isReady: () => isReady,
+  onReady: () => onReady
+});
+module.exports = __toCommonJS(index_exports);
+function warp() {
+  return globalThis.exports["warp"];
+}
+function onReady(cb) {
+  warp().onReady(cb);
+}
+function isReady() {
+  return warp().isReady();
+}
+function getEvents() {
+  return warp().getEvents();
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  getEvents,
+  isReady,
+  onReady
+});

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@warpfx/client",
+  "version": "0.1.0",
+  "description": "Warp Framework SDK for client-side FiveM module development",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/1camou/warp.git",
+    "directory": "packages/client"
+  },
+  "keywords": ["fivem", "warp", "client", "framework"],
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs --dts --out-dir dist --target es2017"
+  }
+}