upd (fw):

- fixed inconsistent rpc build
- changed project-wide naming convention to prefix with "FW_" instead of "RageFW_"
This commit is contained in:
2025-01-30 19:40:09 +00:00
parent 7a37aa390e
commit edafb5289e
29 changed files with 248 additions and 287 deletions
+10 -14
View File
@@ -1,9 +1,9 @@
import { rpc } from './rpc'
import { Middleware } from './middleware'
import { FW_Middleware } from './middleware'
import type * as T from '../types'
/** Client-side interactions */
export class Client {
export class FW_Client {
/**
* Registers a client event with an associated callback
*
@@ -11,7 +11,7 @@ export class Client {
* @param callback - The callback function to be executed when the event is triggered
* @param [options] - Optional settings for callback execution
* @param [options.middlewares] - Middleware functions to be checked before the callback executes
* @returns {Client} The current client instance, enabling method chaining
* @returns {FW_Client} The current client instance, enabling method chaining
*
* @example
* // Registering an event
@@ -40,13 +40,13 @@ export class Client {
*
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/
public register<EventName extends T.RageFW_ClientEvent>(
public register<EventName extends T.FW_ClientEvent>(
eventName: EventName,
callback: T.RageFW_ClientCallback<EventName>,
callback: T.FW_ClientCallback<EventName>,
options?: {
middlewares?: T.RageFW_MiddlewareOptions<EventName>
middlewares?: T.FW_MiddlewareOptions<EventName>
},
): Client {
): FW_Client {
rpc.register<
Parameters<typeof callback>,
ReturnType<typeof callback> | Promise<unknown>,
@@ -54,7 +54,7 @@ export class Client {
>(eventName, async (...data) => {
if (!options?.middlewares) return await callback(...data)
await Middleware.process(options.middlewares, callback, data)
await FW_Middleware.process(options.middlewares, callback, data)
})
return this
@@ -72,15 +72,11 @@ export class Client {
*
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/
public unregister<EventName extends T.RageFW_ClientEvent>(
public unregister<EventName extends T.FW_ClientEvent>(
eventName: EventName,
): Client {
): FW_Client {
rpc.unregister<EventName>(eventName)
return this
}
}
// new Client()
// .register('customClientEvent', async (a, b) => true)
// .unregister('customClientEvent')
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* Used to log to a client in-game console
*/
export class Logger {
export class FW_Logger {
/**
* Informational logs. Colored in white
*
+11 -11
View File
@@ -1,12 +1,12 @@
import type * as T from '../types'
export class Middleware {
export class FW_Middleware {
constructor() {}
private static async execute<EventName extends T.RageFW_ClientEvent>(
middlewares: T.RageFW_MiddlewareFunction<EventName>[],
args: T.RageFW_ClientArgs<EventName>,
): Promise<T.RageFW_MiddlewareResponseInternal> {
private static async execute<EventName extends T.FW_ClientEvent>(
middlewares: T.FW_MiddlewareFunction<EventName>[],
args: T.FW_ClientArgs<EventName>,
): Promise<T.FW_MiddlewareResponseInternal> {
for (let i = 0; i < middlewares.length; i++) {
const result = await middlewares[i](...args)
@@ -21,20 +21,20 @@ export class Middleware {
}
}
public static async process<EventName extends T.RageFW_ClientEvent>(
middlewareOptions: T.RageFW_MiddlewareOptions<EventName>,
callback: T.RageFW_ClientCallback<EventName>,
args: T.RageFW_ClientArgs<EventName>,
public static async process<EventName extends T.FW_ClientEvent>(
middlewareOptions: T.FW_MiddlewareOptions<EventName>,
callback: T.FW_ClientCallback<EventName>,
args: T.FW_ClientArgs<EventName>,
) {
if (Array.isArray(middlewareOptions)) {
const middlewaresResponse = await Middleware.execute(
const middlewaresResponse = await FW_Middleware.execute(
middlewareOptions,
args,
)
if (middlewaresResponse.success) return await callback(...args)
} else {
const middlewaresResponse = await Middleware.execute(
const middlewaresResponse = await FW_Middleware.execute(
middlewareOptions.executables,
args,
)
+13 -13
View File
@@ -2,7 +2,7 @@ import { rpc } from './rpc'
import type * as T from '../types'
/** Handles event manipulations that require player to be present in context */
export class Player {
export class FW_Player {
private _browser: BrowserMp | undefined = undefined
/**
@@ -32,16 +32,16 @@ export class Player {
*
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/
public async trigger<EventName extends keyof T.RageFW_ICustomClientEvent>(
public async trigger<EventName extends keyof T.FW_ICustomClientEvent>(
eventName: EventName,
...args: T._ClientEventHasArgs<EventName> extends true
? [T.RageFW_ClientArgs<EventName>]
? [T.FW_ClientArgs<EventName>]
: []
): Promise<T.RageFW_ClientReturn<EventName>> {
): Promise<T.FW_ClientReturn<EventName>> {
return await rpc.call<
typeof args,
EventName,
T.RageFW_ClientReturn<EventName>
T.FW_ClientReturn<EventName>
>(eventName, args)
}
@@ -64,16 +64,16 @@ export class Player {
*
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/
public async triggerServer<EventName extends T.RageFW_ServerEvent>(
public async triggerServer<EventName extends T.FW_ServerEvent>(
eventName: EventName,
...args: T._ServerEventHasArgs<EventName> extends true
? [T.RageFW_ServerArgs<EventName>]
? [T.FW_ServerArgs<EventName>]
: []
): Promise<T.RageFW_ClientServerReturn<EventName>> {
): Promise<T.FW_ClientServerReturn<EventName>> {
return await rpc.callServer<
typeof args,
EventName,
T.RageFW_ClientServerReturn<EventName>
T.FW_ClientServerReturn<EventName>
>(eventName, args)
}
@@ -96,19 +96,19 @@ export class Player {
*
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/
public async triggerBrowser<EventName extends T.RageFW_BrowserEvent>(
public async triggerBrowser<EventName extends T.FW_BrowserEvent>(
eventName: EventName,
...args: T._BrowserEventHasArgs<EventName> extends true
? [T.RageFW_BrowserArgs<EventName>]
? [T.FW_BrowserArgs<EventName>]
: []
): Promise<T.RageFW_BrowserReturn<EventName>> {
): Promise<T.FW_BrowserReturn<EventName>> {
if (!this._browser)
throw new Error('You need to initialize browser first')
return await rpc.callBrowser<
typeof args,
EventName,
T.RageFW_BrowserReturn<EventName>
T.FW_BrowserReturn<EventName>
>(eventName, args)
}
}