@warpfx/server 0.2.0 → 0.2.1

package/dist/index.d.ts

@@ -249,6 +249,8 @@ interface ActionContext {
 }
 /** Action handler function. */
 type ActionHandler = (ctx: ActionContext, payload: any) => Promise<void> | void;
+/** Server function handler — returns a value back to the caller. */
+type FunctionHandler<T = any> = (ctx: ActionContext, payload: any) => Promise<T> | T;
 /**
  * Register a table for automatic sync to clients.
  *
@@ -272,6 +274,20 @@ declare function registerSync(table: string, config: SyncConfig): void;
  * });
  */
 declare function registerAction(name: string, handler: ActionHandler): void;
+/**
+ * Register a server function that clients can call and await a result.
+ *
+ * Unlike actions (fire-and-forget mutations), functions return a value
+ * to the caller. Use for request/response patterns like data fetches,
+ * calculations, or validations that need a result.
+ *
+ * @example
+ * registerFunction('economy:getBalance', async (ctx) => {
+ *   const account = ctx.db.economy_accounts.citizenId.find(ctx.citizenId);
+ *   return { balance: account?.balance ?? 0 };
+ * });
+ */
+declare function registerFunction<T = any>(name: string, handler: FunctionHandler<T>): void;
 /**
  * Typed error for action handlers. Thrown errors with a `code` property
  * are sent to the client as structured error messages.
@@ -283,5 +299,41 @@ declare class WarpError extends Error {
     code: string;
     constructor(code: string, message?: string);
 }
+/** Parameter hint shown in command autocomplete. */
+interface CommandParam {
+    /** Parameter name displayed in the suggestion (e.g. "id", "reason"). */
+    name: string;
+    /** Optional help text for the parameter. */
+    help?: string;
+}
+/** Options for registerCommand(). */
+interface CommandOptions {
+    /** Short description shown in autocomplete. */
+    description?: string;
+    /** ACE permission required — players without it won't see the command. */
+    ace?: string;
+    /** Custom permission predicate (overrides ace check when provided). */
+    canUse?: (source: number) => boolean;
+    /** Parameter hints shown in autocomplete. */
+    params?: CommandParam[];
+}
+/**
+ * Register a command with autocomplete support.
+ *
+ * Players see matching commands as they type in the chat input,
+ * filtered by permission. The handler receives the standard FiveM
+ * command arguments.
+ *
+ * @example
+ * registerCommand('arrest', {
+ *   description: 'Arrest a nearby player',
+ *   ace: 'police.arrest',
+ *   params: [{ name: 'id', help: 'Player server ID' }],
+ * }, (source, args) => {
+ *   const targetId = parseInt(args[0], 10);
+ *   // ...
+ * });
+ */
+declare function registerCommand(name: string, options: CommandOptions, handler: (source: number, args: string[], rawCommand: string) => void): void;
 
-export { type ActionContext, type ActionHandler, type ColumnDef, type ColumnType, type EntityStore, type PlayerEntity, type PlayerEventContext, type PlayerRow, type PlayerState, type ServerEventBus, type SyncConfig, type TableDef, WarpError, type WarpSchema, getBridge, getEntities, getEntity, getEvents, getPlayer, getPlayers, isReady, onPlayerConnect, onPlayerDisconnect, onPlayerSpawned, onReady, provide, registerAction, registerSync, spawnPlayer, subscribe, use };
+export { type ActionContext, type ActionHandler, type ColumnDef, type ColumnType, type CommandOptions, type CommandParam, type EntityStore, type FunctionHandler, type PlayerEntity, type PlayerEventContext, type PlayerRow, type PlayerState, type ServerEventBus, type SyncConfig, type TableDef, WarpError, type WarpSchema, getBridge, getEntities, getEntity, getEvents, getPlayer, getPlayers, isReady, onPlayerConnect, onPlayerDisconnect, onPlayerSpawned, onReady, provide, registerAction, registerCommand, registerFunction, registerSync, spawnPlayer, subscribe, use };

package/dist/index.js

@@ -34,6 +34,8 @@ __export(index_exports, {
   onReady: () => onReady,
   provide: () => provide,
   registerAction: () => registerAction,
+  registerCommand: () => registerCommand,
+  registerFunction: () => registerFunction,
   registerSync: () => registerSync,
   spawnPlayer: () => spawnPlayer,
   subscribe: () => subscribe,
@@ -94,6 +96,9 @@ function registerSync(table, config) {
 function registerAction(name, handler) {
   warp().registerAction(name, handler);
 }
+function registerFunction(name, handler) {
+  warp().registerFunction(name, handler);
+}
 var WarpError = class extends Error {
   constructor(code, message) {
     super(message ?? code);
@@ -101,6 +106,9 @@ var WarpError = class extends Error {
     this.name = "WarpError";
   }
 };
+function registerCommand(name, options, handler) {
+  warp().registerCommand(name, options, handler);
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   WarpError,
@@ -117,6 +125,8 @@ var WarpError = class extends Error {
   onReady,
   provide,
   registerAction,
+  registerCommand,
+  registerFunction,
   registerSync,
   spawnPlayer,
   subscribe,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@warpfx/server",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Warp Framework SDK for server-side FiveM module development",
   "keywords": [
     "fivem",