@warpfx/client 0.1.0 → 0.1.1

package/dist/index.d.ts

@@ -37,5 +37,65 @@ declare function onReady(cb: () => void): void;
 declare function isReady(): boolean;
 /** Get the shared client event bus instance. */
 declare function getEvents<TMap extends Record<string, any> = Record<string, any>>(): ClientEventBus<TMap>;
+/** Reactive handle to synced state. */
+interface SyncHandle<T = any> {
+    /** Current value of the synced state. */
+    readonly value: T;
+    /** Register a callback for when state changes. Returns unsubscribe function. */
+    onChange(handler: (newState: T, oldState: T) => void): () => void;
+}
+/** Action error received from the server. */
+interface ActionError {
+    action: string;
+    code: string;
+    message: string;
+}
+/**
+ * Subscribe to synced state from the server.
+ *
+ * Returns a handle with a `.value` getter and `.onChange()` method.
+ * State updates automatically when the server pushes changes.
+ *
+ * @example
+ * const inventory = useSync<InventoryItem[]>('inventory', []);
+ * console.log(inventory.value); // current items
+ * inventory.onChange((items) => console.log('Updated:', items.length));
+ */
+declare function useSync<T = any>(key: string, defaultValue?: T): SyncHandle<T>;
+/**
+ * Create an action dispatcher to call server-side action handlers.
+ *
+ * Returns a function that sends the action to the server.
+ * State updates flow back automatically via the sync engine.
+ *
+ * @example
+ * const moveItem = useAction<{ itemId: string; toSlot: number }>('inventory:moveItem');
+ * moveItem({ itemId: 'abc', toSlot: 5 });
+ */
+declare function useAction<P = any>(name: string, opts?: {
+    onError?: (error: ActionError) => void;
+}): (payload: P) => void;
+/**
+ * Register a global error handler for all action errors.
+ * Returns an unsubscribe function.
+ *
+ * @example
+ * useErrorHandler((error) => {
+ *   console.log(`Action ${error.action} failed: ${error.message}`);
+ * });
+ */
+declare function useErrorHandler(handler: (error: ActionError) => void): () => void;
+/**
+ * Get the current synced state for a key.
+ * Unlike useSync(), this is a one-shot read with no change tracking.
+ */
+declare function getSyncState<T = any>(key: string): T | undefined;
+/**
+ * Show the NUI overlay with mouse/keyboard focus.
+ * Optionally specify a panel name to show a specific module UI.
+ */
+declare function showNUI(panel?: string): void;
+/** Hide the NUI overlay and release mouse/keyboard focus. */
+declare function hideNUI(): void;
 
-export { type ClientEventBus, getEvents, isReady, onReady };
+export { type ActionError, type ClientEventBus, type SyncHandle, getEvents, getSyncState, hideNUI, isReady, onReady, showNUI, useAction, useErrorHandler, useSync };

package/dist/index.js

@@ -21,8 +21,14 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   getEvents: () => getEvents,
+  getSyncState: () => getSyncState,
+  hideNUI: () => hideNUI,
   isReady: () => isReady,
-  onReady: () => onReady
+  onReady: () => onReady,
+  showNUI: () => showNUI,
+  useAction: () => useAction,
+  useErrorHandler: () => useErrorHandler,
+  useSync: () => useSync
 });
 module.exports = __toCommonJS(index_exports);
 function warp() {
@@ -37,9 +43,33 @@ function isReady() {
 function getEvents() {
   return warp().getEvents();
 }
+function useSync(key, defaultValue) {
+  return warp().useSync(key, defaultValue);
+}
+function useAction(name, opts) {
+  return warp().useAction(name, opts);
+}
+function useErrorHandler(handler) {
+  return warp().useErrorHandler(handler);
+}
+function getSyncState(key) {
+  return warp().getSyncState(key);
+}
+function showNUI(panel) {
+  warp().showNUI(panel);
+}
+function hideNUI() {
+  warp().hideNUI();
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   getEvents,
+  getSyncState,
+  hideNUI,
   isReady,
-  onReady
+  onReady,
+  showNUI,
+  useAction,
+  useErrorHandler,
+  useSync
 });

package/package.json

@@ -1,22 +1,27 @@
 {
   "name": "@warpfx/client",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Warp Framework SDK for client-side FiveM module development",
+  "keywords": [
+    "client",
+    "fivem",
+    "framework",
+    "warp"
+  ],
   "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",
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "build": "tsup src/index.ts --format cjs --dts --out-dir dist --target es2017"
   }