@warpfx/server 0.3.1 → 0.3.3

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /**
- * Schema types for Warp module developers.
+ * Schema types for Warp resource developers.
  *
- * Modules define their database tables in a `warp.schema.json` file
+ * Resources define their database tables in a `warp.schema.json` file
  * placed at the root of their FiveM resource. These types document
  * the expected format.
  *
@@ -81,12 +81,35 @@ interface TableDef {
      */
     access?: AccessMode;
 }
+/** Parameter/field definition for actions and functions. */
+interface ParamDef {
+    /** The data type of this parameter. */
+    type: ColumnType;
+    /** If true, this parameter is optional in the payload. */
+    optional?: boolean;
+}
+/** Action definition — declares the payload shape for a client-to-server action. */
+interface ActionDef {
+    /** Parameters the action accepts from the client. */
+    params: Record<string, ParamDef>;
+}
+/** Function definition — declares request params and return shape for a client-to-server function. */
+interface FunctionDef {
+    /** Parameters the function accepts from the client. */
+    params: Record<string, ParamDef>;
+    /** Fields the function returns to the client. */
+    returns: Record<string, ParamDef>;
+}
 /** The full warp.schema.json format. */
 interface WarpSchema {
-    /** Unique module name (used as table prefix in the database). */
+    /** Unique resource name (used as table prefix in the database). */
     module: string;
     /** Table definitions keyed by table name. */
     tables: Record<string, TableDef>;
+    /** Action definitions keyed by action name. */
+    actions?: Record<string, ActionDef>;
+    /** Function definitions keyed by function name. */
+    functions?: Record<string, FunctionDef>;
     /** Schema version number (increment when making breaking changes). */
     version?: number;
     /** Acknowledged breaking changes (required in production for destructive schema changes). */
@@ -94,7 +117,7 @@ interface WarpSchema {
 }
 
 /**
- * @warpfx/server — Server-side SDK for Warp module development.
+ * @warpfx/server — Server-side SDK for Warp resource development.
  *
  * Clean, minimal API for building FiveM server features with Warp.
  * All calls delegate to the Warp core via FiveM resource exports.
@@ -245,6 +268,37 @@ declare function fn<T = any>(name: string, handler: (player: Player, payload: an
  * }, (player, args) => { ... });
  */
 declare function command(name: string, handlerOrOptions: CommandOptions | ((player: Player, args: string[], raw: string) => void), handler?: (player: Player, args: string[], raw: string) => void): void;
+/** Context passed to middleware handlers. */
+interface MiddlewareContext extends Player {
+    /** The action or function name being dispatched. */
+    actionName: string;
+    /** The payload sent by the client. */
+    payload: any;
+}
+/**
+ * Register middleware that intercepts actions and functions.
+ *
+ * Middleware runs in registration order, wrapping the handler (Koa-style).
+ * Use glob patterns to match action/function names.
+ *
+ * @example
+ * // Module-scoped — applies to all economy actions
+ * middleware('economy:*', async (ctx, next) => {
+ *   const entity = getEntity(ctx.citizenId);
+ *   if (entity?.getComponent('frozen')) {
+ *     throw error('FROZEN', 'Account is frozen');
+ *   }
+ *   await next();
+ * });
+ *
+ * // Global — applies to everything
+ * middleware('*', async (ctx, next) => {
+ *   const start = Date.now();
+ *   await next();
+ *   console.log(`[${ctx.actionName}] ${Date.now() - start}ms`);
+ * });
+ */
+declare function middleware(pattern: string, handler: (ctx: MiddlewareContext, next: () => Promise<void>) => Promise<void> | void): void;
 /**
  * Create an error to throw from action/function handlers.
  * The error is sent back to the client with a structured code and message.
@@ -269,7 +323,7 @@ declare function table<T = any>(name: string): Table<T>;
  * React to any change in a database table.
  *
  * Fires on insert, update, or delete — regardless of what caused the change
- * (action, another module, migration, Studio edit). Works on all tables
+ * (action, another resource, migration, Studio edit). Works on all tables
  * including server-only tables without an `access` field.
  *
  * @example
@@ -287,9 +341,9 @@ declare function onTableChange<T = any>(table: string, handler: (change: TableCh
 declare function onReady(cb: () => void): void;
 /** Check if Warp has finished booting. */
 declare function isReady(): boolean;
-/** Register a service that other modules can resolve via use(). */
+/** Register a service that other resources can resolve via use(). */
 declare function provide<T>(token: string, service: T): void;
-/** Resolve a service registered by another module. */
+/** Resolve a service registered by another resource. */
 declare function use<T = unknown>(token: string): T;
 /** Get the shared event bus instance. */
 declare function getEvents<TMap extends Record<string, any> = Record<string, any>>(): ServerEventBus<TMap>;
@@ -314,4 +368,4 @@ declare function getBridge(): any;
 /** Subscribe to database tables. */
 declare function subscribe(queries: string[]): Promise<void>;
 
-export { type AccessMode, type ActionError, type ColumnDef, type ColumnType, type CommandOptions, type CommandParam, type EntityStore, type Player, type PlayerEntity, type PlayerRow, type PlayerState, type ServerEventBus, type Table, type TableChange, type TableDef, type WarpSchema, action, command, error, fn, getBridge, getEntities, getEntity, getEvents, getPlayer, getPlayers, isReady, onPlayerConnect, onPlayerDisconnect, onPlayerSpawned, onReady, onTableChange, provide, spawnPlayer, subscribe, table, use };
+export { type AccessMode, type ActionDef, type ActionError, type ColumnDef, type ColumnType, type CommandOptions, type CommandParam, type EntityStore, type FunctionDef, type MiddlewareContext, type ParamDef, type Player, type PlayerEntity, type PlayerRow, type PlayerState, type ServerEventBus, type Table, type TableChange, type TableDef, type WarpSchema, action, command, error, fn, getBridge, getEntities, getEntity, getEvents, getPlayer, getPlayers, isReady, middleware, onPlayerConnect, onPlayerDisconnect, onPlayerSpawned, onReady, onTableChange, provide, spawnPlayer, subscribe, table, use };

package/dist/index.js

@@ -31,6 +31,7 @@ __export(index_exports, {
   getPlayer: () => getPlayer,
   getPlayers: () => getPlayers,
   isReady: () => isReady,
+  middleware: () => middleware,
   onPlayerConnect: () => onPlayerConnect,
   onPlayerDisconnect: () => onPlayerDisconnect,
   onPlayerSpawned: () => onPlayerSpawned,
@@ -59,6 +60,9 @@ function command(name, handlerOrOptions, handler) {
     warp().command(name, handlerOrOptions, handler);
   }
 }
+function middleware(pattern, handler) {
+  warp().middleware(pattern, handler);
+}
 function error(code, message) {
   return warp().error(code, message);
 }
@@ -126,6 +130,7 @@ function subscribe(queries) {
   getPlayer,
   getPlayers,
   isReady,
+  middleware,
   onPlayerConnect,
   onPlayerDisconnect,
   onPlayerSpawned,

package/package.json

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