@warpfx/server 0.1.0 → 0.1.1

package/dist/index.d.ts

@@ -92,5 +92,63 @@ declare function onPlayerDisconnect(cb: (player: PlayerEventContext) => void): v
 declare function getBridge(): any;
 /** Subscribe to database tables. Call inside onReady(). */
 declare function subscribe(queries: string[]): Promise<void>;
+/** Sync configuration for a table. */
+interface SyncConfig {
+    /** Who receives updates for this table. */
+    to: "owner" | "all";
+    /** Column name for owner filtering (required when to: 'owner'). */
+    scope?: string;
+    /** Primary key column for row identity (defaults to 'id'). */
+    key?: string;
+}
+/** Context passed to action handlers. */
+interface ActionContext {
+    /** FiveM server-side player ID. */
+    source: number;
+    /** Player's citizen ID (license identifier). */
+    citizenId: string;
+    /** Player's display name. */
+    name: string;
+    /** Database table accessors (read-only). */
+    db: any;
+    /** Database reducer proxy (for mutations). */
+    reducers: any;
+}
+/** Action handler function. */
+type ActionHandler = (ctx: ActionContext, payload: any) => Promise<void> | void;
+/**
+ * Register a table for automatic sync to clients.
+ *
+ * The sync engine subscribes to SpacetimeDB table changes and routes
+ * updates to the correct players based on the config. Call inside onReady().
+ *
+ * @example
+ * registerSync('inventory', { to: 'owner', scope: 'ownerId', key: 'id' });
+ * registerSync('itemDefinitions', { to: 'all', key: 'name' });
+ */
+declare function registerSync(table: string, config: SyncConfig): void;
+/**
+ * Register an action handler that clients can invoke via useAction().
+ *
+ * Actions are the only entry point for client-initiated mutations.
+ * The sync engine handles security, error routing, and state updates.
+ *
+ * @example
+ * registerAction('inventory:moveItem', async (ctx, { itemId, toSlot }) => {
+ *   await ctx.reducers.moveItem(ctx.citizenId, itemId, toSlot);
+ * });
+ */
+declare function registerAction(name: string, handler: ActionHandler): void;
+/**
+ * Typed error for action handlers. Thrown errors with a `code` property
+ * are sent to the client as structured error messages.
+ *
+ * @example
+ * throw new WarpError('ITEM_NOT_FOUND', 'That item no longer exists');
+ */
+declare class WarpError extends Error {
+    code: string;
+    constructor(code: string, message?: string);
+}
 
-export { type EntityStore, type PlayerEventContext, type PlayerRow, type ServerEventBus, getBridge, getEntities, getEvents, getPlayer, getPlayers, isReady, onPlayerConnect, onPlayerDisconnect, onReady, provide, subscribe, use };
+export { type ActionContext, type ActionHandler, type EntityStore, type PlayerEventContext, type PlayerRow, type ServerEventBus, type SyncConfig, WarpError, getBridge, getEntities, getEvents, getPlayer, getPlayers, isReady, onPlayerConnect, onPlayerDisconnect, onReady, provide, registerAction, registerSync, subscribe, use };

package/dist/index.js

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  WarpError: () => WarpError,
   getBridge: () => getBridge,
   getEntities: () => getEntities,
   getEvents: () => getEvents,
@@ -30,6 +31,8 @@ __export(index_exports, {
   onPlayerDisconnect: () => onPlayerDisconnect,
   onReady: () => onReady,
   provide: () => provide,
+  registerAction: () => registerAction,
+  registerSync: () => registerSync,
   subscribe: () => subscribe,
   use: () => use
 });
@@ -73,8 +76,22 @@ function getBridge() {
 function subscribe(queries) {
   return warp().subscribe(queries);
 }
+function registerSync(table, config) {
+  warp().registerSync(table, config);
+}
+function registerAction(name, handler) {
+  warp().registerAction(name, handler);
+}
+var WarpError = class extends Error {
+  constructor(code, message) {
+    super(message ?? code);
+    this.code = code;
+    this.name = "WarpError";
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  WarpError,
   getBridge,
   getEntities,
   getEvents,
@@ -85,6 +102,8 @@ function subscribe(queries) {
   onPlayerDisconnect,
   onReady,
   provide,
+  registerAction,
+  registerSync,
   subscribe,
   use
 });

package/package.json

@@ -1,22 +1,27 @@
 {
   "name": "@warpfx/server",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Warp Framework SDK for server-side FiveM module development",
+  "keywords": [
+    "fivem",
+    "framework",
+    "server",
+    "warp"
+  ],
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/1camou/warp.git",
     "directory": "packages/server"
   },
-  "keywords": ["fivem", "warp", "server", "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 node22"
   }