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
server/src/core/logger.ts
+1 -1
View File
@@ -3,7 +3,7 @@ import winston, { format } from 'winston'
const { timestamp, printf, colorize } = format
/** Used to log in a server console */
export class Logger {
export class FW_Logger {
private format = printf(({ message, level }) => {
return `[${new Date().toLocaleTimeString()}] [${level}]: ${message}`
})
server/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_ServerEvent>(
middlewares: T.RageFW_MiddlewareFunction<EventName>[],
args: T.RageFW_ServerArgs<EventName>,
): Promise<T.RageFW_MiddlewareResponseInternal> {
private static async execute<EventName extends T.FW_ServerEvent>(
middlewares: T.FW_MiddlewareFunction<EventName>[],
args: T.FW_ServerArgs<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_ServerEvent>(
middlewareOptions: T.RageFW_MiddlewareOptions<EventName>,
callback: T.RageFW_ServerCallback<EventName>,
args: T.RageFW_ServerArgs<EventName>,
public static async process<EventName extends T.FW_ServerEvent>(
middlewareOptions: T.FW_MiddlewareOptions<EventName>,
callback: T.FW_ServerCallback<EventName>,
args: T.FW_ServerArgs<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,
)
server/src/core/player.ts
+7 -10
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 {
/**
* Triggers a client event from the server with arguments from shared types
*
@@ -23,13 +23,13 @@ export class Player {
*
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/
public async triggerClient<EventName extends T.RageFW_ClientEvent>(
public async triggerClient<EventName extends T.FW_ClientEvent>(
player: PlayerMp,
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.callClient(player, eventName, args)
}
@@ -53,16 +53,13 @@ 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>(
player: PlayerMp,
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>> {
return await rpc.callBrowser(player, eventName, args)
}
}
// new Player().triggerBrowser({} as PlayerMp, 'customCefEvent', ['', 1])
// new Player().triggerClient({} as PlayerMp, 'customClientEvent', ['', 1])
server/src/core/server.ts
+14 -18
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'
/** Server-side interactions */
export class Server {
export class FW_Server {
/**
* Registers a server event with an associated callback
*
@@ -11,7 +11,7 @@ export class Server {
* @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 {Server} The current server instance, enabling method chaining
* @returns {FW_Server} The current server instance, enabling method chaining
*
* @example
* // Registering an event
@@ -40,13 +40,13 @@ export class Server {
*
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/
public register<EventName extends T.RageFW_ServerEvent>(
public register<EventName extends T.FW_ServerEvent>(
eventName: EventName,
callback: T.RageFW_ServerCallback<EventName>,
callback: T.FW_ServerCallback<EventName>,
options?: {
middlewares?: T.RageFW_MiddlewareOptions<EventName>
middlewares?: T.FW_MiddlewareOptions<EventName>
},
): Server {
): FW_Server {
rpc.register<
Parameters<typeof callback>,
ReturnType<typeof callback> | Promise<unknown>,
@@ -54,7 +54,7 @@ export class Server {
>(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
@@ -64,7 +64,7 @@ export class Server {
* Unregisters a server event, removing the associated callback
*
* @param eventName - The name of the event to unregister
* @returns {Server} The current server instance, enabling method chaining
* @returns {FW_Server} The current server instance, enabling method chaining
*
* @example
* // Unregistering an event
@@ -72,25 +72,21 @@ export class Server {
*
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/
public unregister<EventName extends T.RageFW_ServerEvent>(
public unregister<EventName extends T.FW_ServerEvent>(
eventName: EventName,
): Server {
): FW_Server {
rpc.unregister<EventName>(eventName)
return this
}
// fixme
// public trigger<EventName extends keyof T.RageFW_ICustomServerEvent>(
// public trigger<EventName extends keyof T.FW_ICustomServerEvent>(
// eventName: EventName,
// ...args: T._ServerEventHasArgs<EventName> extends true
// ? [T.RageFW_ServerArgs<EventName>]
// ? [T.FW_ServerArgs<EventName>]
// : []
// ): Promise<T.RageFW_ServerReturn<EventName>> {
// ): Promise<T.FW_ServerReturn<EventName>> {
// return rpc.call(eventName, args)
// }
}
// new Server()
// .register('customServerEvent', async (a, b, c) => true)
// .unregister('customServerEvent')
server/src/types/browser.ts
+9 -9
View File
@@ -1,34 +1,34 @@
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
* These only include custom events
*/
export type RageFW_BrowserEvent = keyof RageFW_ICustomBrowserEvent
export type FW_BrowserEvent = keyof FW_ICustomBrowserEvent
/**
* Array of arguments of an event 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]
>
/**
* Return type of event you pass as a generic
* These only include custom events
*/
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
server/src/types/client.ts
+14 -17
View File
@@ -1,38 +1,35 @@
/// <reference types="@ragempcommunity/types-server" />
import type { RageFW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
import type { FW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
/**
* Union of all available client event names
* These only include custom events
*/
export type RageFW_ClientEvent = keyof RageFW_ICustomClientEvent
export type FW_ClientEvent = keyof FW_ICustomClientEvent
/**
* Array of arguments of an event you pass as a generic
* These only include custom events
*/
export type RageFW_ClientArgs<K extends RageFW_ClientEvent> =
K extends RageFW_ClientEvent
? Parameters<RageFW_ICustomClientEvent[K]>
: never
export type FW_ClientArgs<K extends FW_ClientEvent> = K extends FW_ClientEvent
? Parameters<FW_ICustomClientEvent[K]>
: never
/**
* Return type of event you pass as a generic
* These only include custom events
*/
export type RageFW_ClientReturn<K extends RageFW_ClientEvent> =
K extends RageFW_ClientEvent
? ReturnType<RageFW_ICustomClientEvent[K]>
: never
export type FW_ClientReturn<K extends FW_ClientEvent> = K extends FW_ClientEvent
? ReturnType<FW_ICustomClientEvent[K]>
: never
/**
*
*/
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
server/src/types/middleware.ts
+8 -9
View File
@@ -1,26 +1,25 @@
import type * as T from './server'
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_ServerEvent> =
(
...args: T.RageFW_ServerArgs<EventName>
) => Promise<RageFW_MiddlewareResponse>
export type FW_MiddlewareFunction<EventName extends T.FW_ServerEvent> = (
...args: T.FW_ServerArgs<EventName>
) => Promise<FW_MiddlewareResponse>
export type RageFW_MiddlewareOptions<EventName extends T.RageFW_ServerEvent> =
| RageFW_MiddlewareFunction<EventName>[]
export type FW_MiddlewareOptions<EventName extends T.FW_ServerEvent> =
| FW_MiddlewareFunction<EventName>[]
| {
executables: RageFW_MiddlewareFunction<EventName>[]
executables: FW_MiddlewareFunction<EventName>[]
onError: (error: string) => unknown
}
server/src/types/server.ts
+17 -21
View File
@@ -1,27 +1,25 @@
/// <reference types="@ragempcommunity/types-server" />
import type {
RageFW_ICustomClientEvent,
RageFW_ICustomServerEvent,
FW_ICustomClientEvent,
FW_ICustomServerEvent,
} from '@entityseven/rage-fw-shared-types'
export type { RageFW_ICustomServerEvent } from '@entityseven/rage-fw-shared-types'
export type { FW_ICustomServerEvent } from '@entityseven/rage-fw-shared-types'
/**
* Union of all available server event names
* These also include system events
*/
export type RageFW_ServerEvent =
| keyof RageFW_ICustomServerEvent
| keyof IServerEvents
export type FW_ServerEvent = keyof FW_ICustomServerEvent | keyof IServerEvents
/**
* Array of arguments for an event, name of which you pass as a generic
* These also include system events
*/
export type RageFW_ServerArgs<K extends RageFW_ServerEvent> =
K extends keyof RageFW_ICustomServerEvent
? [PlayerMp, ...Parameters<RageFW_ICustomServerEvent[K]>]
export type FW_ServerArgs<K extends FW_ServerEvent> =
K extends keyof FW_ICustomServerEvent
? [PlayerMp, ...Parameters<FW_ICustomServerEvent[K]>]
: K extends keyof IServerEvents
? [PlayerMp, Parameters<IServerEvents[K]>]
: never
@@ -30,9 +28,9 @@ export type RageFW_ServerArgs<K extends RageFW_ServerEvent> =
* Return type for an event, name of which you pass as a generic
* These include system and custom events
*/
export type RageFW_ServerReturn<K extends RageFW_ServerEvent> =
K extends keyof RageFW_ICustomServerEvent
? ReturnType<RageFW_ICustomServerEvent[K]>
export type FW_ServerReturn<K extends FW_ServerEvent> =
K extends keyof FW_ICustomServerEvent
? ReturnType<FW_ICustomServerEvent[K]>
: K extends keyof IServerEvents
? ReturnType<IServerEvents[K]>
: void
@@ -41,20 +39,18 @@ export type RageFW_ServerReturn<K extends RageFW_ServerEvent> =
* Callback (function) for an event, name of which you pass as a generic
* These include system and custom events
*/
export type RageFW_ServerCallback<K extends RageFW_ServerEvent> = (
...args: RageFW_ServerArgs<K>
) => Promise<RageFW_ServerReturn<K>>
export type FW_ServerCallback<K extends FW_ServerEvent> = (
...args: FW_ServerArgs<K>
) => Promise<FW_ServerReturn<K>>
/**
*
*/
export type _ServerEventHasArgs<EventName extends RageFW_ServerEvent> =
EventName extends keyof RageFW_ICustomServerEvent
? keyof RageFW_ICustomClientEvent extends never
export type _ServerEventHasArgs<EventName extends FW_ServerEvent> =
EventName extends keyof FW_ICustomServerEvent
? keyof FW_ICustomClientEvent extends never
? false
: Parameters<
RageFW_ICustomServerEvent[EventName]
>[0] extends undefined
: Parameters<FW_ICustomServerEvent[EventName]>[0] extends undefined
? false
: true
: EventName extends keyof IServerEvents