entityseven/rage-framework
2
2
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

upd (fw):

Browse Source 
- fixed inconsistent rpc build
- changed project-wide naming convention to prefix with "FW_" instead of "RageFW_"
This commit is contained in:
rilaxik
2025-01-30 19:40:09 +00:00
parent 7a37aa390e
commit edafb5289e
29 changed files with 248 additions and 287 deletions
Download Patch File Download Diff File Expand all files Collapse all files
client/src/core/client.ts
+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')
client/src/core/logger.ts
+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
*
client/src/core/middleware.ts
+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,
)
client/src/core/player.ts
+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)
}
}
client/src/types/browser.ts
+9 -9
View File
@@ -1,29 +1,29 @@
/// <reference types="@ragempcommunity/types-client" />
import type { RageFW_ICustomBrowserEvent } from '@entityseven/rage-fw-shared-types'
import type { FW_ICustomBrowserEvent } from '@entityseven/rage-fw-shared-types'
/**
* Union of all available browser event names callable from client
* These only include custom events
*/
export type RageFW_BrowserEvent = keyof RageFW_ICustomBrowserEvent
export type FW_BrowserEvent = keyof FW_ICustomBrowserEvent
/**
* Array of arguments for an event, name of which you pass as a generic
* These only include custom events
*/
export type RageFW_BrowserArgs<K extends RageFW_BrowserEvent> = Parameters<
RageFW_ICustomBrowserEvent[K]
export type FW_BrowserArgs<K extends FW_BrowserEvent> = Parameters<
FW_ICustomBrowserEvent[K]
>
export type RageFW_BrowserReturn<K extends RageFW_BrowserEvent> = ReturnType<
RageFW_ICustomBrowserEvent[K]
export type FW_BrowserReturn<K extends FW_BrowserEvent> = ReturnType<
FW_ICustomBrowserEvent[K]
>
export type _BrowserEventHasArgs<
EventName extends keyof RageFW_ICustomBrowserEvent,
> = keyof RageFW_ICustomBrowserEvent extends never
EventName extends keyof FW_ICustomBrowserEvent,
> = keyof FW_ICustomBrowserEvent extends never
? false
: Parameters<RageFW_ICustomBrowserEvent[EventName]>[0] extends undefined
: Parameters<FW_ICustomBrowserEvent[EventName]>[0] extends undefined
? false
: true
client/src/types/client.ts
+18 -21
View File
@@ -1,24 +1,22 @@
/// <reference types="@ragempcommunity/types-client" />
import type { RageFW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
import type { FW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
export type { RageFW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
export type { FW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
/**
* Union of all available client event names
* These include custom and system events
*/
export type RageFW_ClientEvent =
| keyof RageFW_ICustomClientEvent
| keyof IClientEvents
export type FW_ClientEvent = keyof FW_ICustomClientEvent | keyof IClientEvents
/**
* Array of arguments for an event, name of which you pass as a generic
* These include custom and system events
*/
export type RageFW_ClientArgs<K extends RageFW_ClientEvent> =
K extends keyof RageFW_ICustomClientEvent
? Parameters<RageFW_ICustomClientEvent[K]>
export type FW_ClientArgs<K extends FW_ClientEvent> =
K extends keyof FW_ICustomClientEvent
? Parameters<FW_ICustomClientEvent[K]>
: K extends keyof IClientEvents
? Parameters<IClientEvents[K]>
: never
@@ -27,9 +25,9 @@ export type RageFW_ClientArgs<K extends RageFW_ClientEvent> =
* Return type for an event, name of which you pass as a generic
* These include custom and system events
*/
export type RageFW_ClientReturn<K extends RageFW_ClientEvent> =
K extends keyof RageFW_ICustomClientEvent
? ReturnType<RageFW_ICustomClientEvent[K]>
export type FW_ClientReturn<K extends FW_ClientEvent> =
K extends keyof FW_ICustomClientEvent
? ReturnType<FW_ICustomClientEvent[K]>
: K extends keyof IClientEvents
? ReturnType<IClientEvents[K]>
: void
@@ -38,17 +36,16 @@ export type RageFW_ClientReturn<K extends RageFW_ClientEvent> =
* Callback (function) for an event, name of which you pass as a generic
* These include custom and system events
*/
export type RageFW_ClientCallback<K extends RageFW_ClientEvent> = (
...args: RageFW_ClientArgs<K>
) => Promise<RageFW_ClientReturn<K>>
export type FW_ClientCallback<K extends FW_ClientEvent> = (
...args: FW_ClientArgs<K>
) => Promise<FW_ClientReturn<K>>
/**
*
*/
export type _ClientEventHasArgs<
EventName extends keyof RageFW_ICustomClientEvent,
> = keyof RageFW_ICustomClientEvent extends never
? false
: Parameters<RageFW_ICustomClientEvent[EventName]>[0] extends undefined
? false
: true
export type _ClientEventHasArgs<EventName extends keyof FW_ICustomClientEvent> =
keyof FW_ICustomClientEvent extends never
? false
: Parameters<FW_ICustomClientEvent[EventName]>[0] extends undefined
? false
: true
client/src/types/middleware.ts
+8 -9
View File
@@ -1,26 +1,25 @@
import type * as T from './client'
export type RageFW_MiddlewareResponse =
export type FW_MiddlewareResponse =
| {
success: boolean
message?: string
}
| boolean
export type RageFW_MiddlewareResponseInternal = {
export type FW_MiddlewareResponseInternal = {
success: boolean
message?: string
id?: number
}
export type RageFW_MiddlewareFunction<EventName extends T.RageFW_ClientEvent> =
(
...args: T.RageFW_ClientArgs<EventName>
) => Promise<RageFW_MiddlewareResponse>
export type FW_MiddlewareFunction<EventName extends T.FW_ClientEvent> = (
...args: T.FW_ClientArgs<EventName>
) => Promise<FW_MiddlewareResponse>
export type RageFW_MiddlewareOptions<EventName extends T.RageFW_ClientEvent> =
| RageFW_MiddlewareFunction<EventName>[]
export type FW_MiddlewareOptions<EventName extends T.FW_ClientEvent> =
| FW_MiddlewareFunction<EventName>[]
| {
executables: RageFW_MiddlewareFunction<EventName>[]
executables: FW_MiddlewareFunction<EventName>[]
onError: (error: string) => unknown
}
client/src/types/server.ts
+15 -16
View File
@@ -1,38 +1,37 @@
/// <reference types="@ragempcommunity/types-client" />
import type {
RageFW_ICustomClientEvent,
RageFW_ICustomServerEvent,
FW_ICustomClientEvent,
FW_ICustomServerEvent,
} from '@entityseven/rage-fw-shared-types'
/**
* Union of all available server event names callable from client
* These only include custom events
*/
export type RageFW_ServerEvent = keyof RageFW_ICustomServerEvent
export type FW_ServerEvent = keyof FW_ICustomServerEvent
/**
* Array of arguments for an event, name of which you pass as a generic
* These only include custom events
*/
export type RageFW_ServerArgs<K extends RageFW_ServerEvent> =
K extends keyof RageFW_ICustomServerEvent
? Parameters<RageFW_ICustomServerEvent[K]>
export type FW_ServerArgs<K extends FW_ServerEvent> =
K extends keyof FW_ICustomServerEvent
? Parameters<FW_ICustomServerEvent[K]>
: never
/**
* Return type for an event, name of which you pass as a generic
* These only include custom events
*/
export type RageFW_ClientServerReturn<K extends RageFW_ServerEvent> =
K extends keyof RageFW_ICustomServerEvent
? ReturnType<RageFW_ICustomServerEvent[K]>
export type FW_ClientServerReturn<K extends FW_ServerEvent> =
K extends keyof FW_ICustomServerEvent
? ReturnType<FW_ICustomServerEvent[K]>
: never
export type _ServerEventHasArgs<
EventName extends keyof RageFW_ICustomServerEvent,
> = keyof RageFW_ICustomClientEvent extends never
? false
: Parameters<RageFW_ICustomServerEvent[EventName]>[0] extends undefined
? false
: true
export type _ServerEventHasArgs<EventName extends keyof FW_ICustomServerEvent> =
keyof FW_ICustomClientEvent extends never
? false
: Parameters<FW_ICustomServerEvent[EventName]>[0] extends undefined
? false
: true