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:
Danya H 2025-01-30 19:40:09 +00:00
parent 7a37aa390e
commit edafb5289e
29 changed files with 248 additions and 287 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
browser/src/core/browser.ts
View File

@ -1,9 +1,9 @@
import { Helper } from './helper'
import { FW_Helper } from './helper'
import { rpc } from './rpc'
import type * as T from '../types'
/** Browser-side interactions */
export class Browser extends Helper {
export class FW_Browser extends FW_Helper {
constructor() {
super()
}
@ -29,7 +29,7 @@ export class Browser extends Helper {
*
* @param eventName - The name of the event to register
* @param callback - The callback function to be executed when the event is triggered
* @returns {Browser} The current browser instance, enabling method chaining
* @returns {FW_Browser} The current browser instance, enabling method chaining
*
* @example
* // Registering an event
@ -39,10 +39,10 @@ export class Browser extends Helper {
*
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/
public register<EventName extends T.RageFW_BrowserEvent>(
public register<EventName extends T.FW_BrowserEvent>(
eventName: EventName,
callback: T.RageFW_BrowserCallback<EventName>,
): Browser {
callback: T.FW_BrowserCallback<EventName>,
): FW_Browser {
this.log_('register', eventName, callback)
rpc.register<
@ -58,7 +58,7 @@ export class Browser extends Helper {
* Unregisters a browser event, removing the associated callback
*
* @param eventName - The name of the event to unregister
* @returns {Browser} The current browser instance, enabling method chaining
* @returns {FW_Browser} The current browser instance, enabling method chaining
*
* @example
* // Unregistering an event
@ -66,9 +66,9 @@ export class Browser extends Helper {
*
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/
public unregister<EventName extends T.RageFW_BrowserEvent>(
public unregister<EventName extends T.FW_BrowserEvent>(
eventName: EventName,
): Browser {
): FW_Browser {
rpc.unregister<EventName>(eventName)
return this
@ -93,18 +93,18 @@ export class Browser extends Helper {
*
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/
public async trigger<EventName extends T.RageFW_BrowserEvent>(
public async trigger<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>> {
this.log_('[RPC](trigger):', eventName, ...args)
return await rpc.call<
typeof args,
EventName,
T.RageFW_BrowserReturn<EventName>
T.FW_BrowserReturn<EventName>
>(eventName, args)
}
@ -127,18 +127,18 @@ export class Browser extends Helper {
*
* @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_ServerReturn<EventName>> {
): Promise<T.FW_ServerReturn<EventName>> {
this.log_('[RPC](triggerServer):', eventName, ...args)
return await rpc.callServer<
typeof args,
EventName,
T.RageFW_ServerReturn<EventName>
T.FW_ServerReturn<EventName>
>(eventName, args)
}
@ -161,18 +161,18 @@ export class Browser extends Helper {
*
* @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>(
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>> {
this.log_('[RPC](triggerClient):', eventName, ...args)
return await rpc.callClient<
typeof args,
EventName,
T.RageFW_ClientReturn<EventName>
T.FW_ClientReturn<EventName>
>(eventName, args)
}
}

2
browser/src/core/helper.ts
View File

@ -1,4 +1,4 @@
export class Helper {
export class FW_Helper {
protected debugLogs_: boolean = false
protected customLogger_:
| undefined

8
browser/src/index.ts
View File

@ -1,4 +1,4 @@
import { Browser, rpc } from './core'
import { FW_Browser, rpc } from './core'
/**
* Package used on a browser-side of your Rage:MP Server
@ -7,10 +7,12 @@ import { Browser, rpc } from './core'
*/
export const fw = {
/** Browser-side interactions */
event: new Browser(),
event: new FW_Browser(),
/** ``rage-fw-rpc`` instance used under the hood. It is highly recommended to use this one if you need it instead of creating a new instance */
rpc,
}
;(async () => {
await fw.event.triggerClient('cefReady')
await fw.event.triggerClient(
'cefReady' as Parameters<typeof fw.event.triggerClient>[0],
)
})()

25
browser/src/types/browser.ts
View File

@ -1,40 +1,41 @@
import type { RageFW_ICustomBrowserEvent } from '@entityseven/rage-fw-shared-types'
import type { FW_ICustomBrowserEvent } from '@entityseven/rage-fw-shared-types'
export type { RageFW_ICustomBrowserEvent } from '@entityseven/rage-fw-shared-types'
export 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 browser 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 browser 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]
>
/**
* Callback (function) of event you pass as a generic
* These only include custom browser events
*/
export type RageFW_BrowserCallback<K extends keyof RageFW_ICustomBrowserEvent> =
(...args: RageFW_BrowserArgs<K>) => Promise<RageFW_BrowserReturn<K>>
export type FW_BrowserCallback<K extends keyof FW_ICustomBrowserEvent> = (
...args: FW_BrowserArgs<K>
) => Promise<FW_BrowserReturn<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

29
browser/src/types/client.ts
View File

@ -1,41 +1,32 @@
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'
/**
* Union of all internal client event names
* These only include internal events
*/
export type RageFW_InternalEvent = 'cefReady'
export type { FW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
/**
* Union of all available client event names
* These only include custom events and some internals for RageFW
*/
export type RageFW_ClientEvent =
| keyof RageFW_ICustomClientEvent
| RageFW_InternalEvent
export type FW_ClientEvent = keyof FW_ICustomClientEvent
/**
* Array of arguments of event you pass as a generic
* These only include custom client events
*/
export type RageFW_ClientArgs<K extends RageFW_ClientEvent> = Parameters<
RageFW_ICustomClientEvent[K]
export type FW_ClientArgs<K extends FW_ClientEvent> = Parameters<
FW_ICustomClientEvent[K]
>
/**
* Return type of event you pass as a generic
* These only include custom client events
*/
export type RageFW_ClientReturn<K extends RageFW_ClientEvent> = ReturnType<
RageFW_ICustomClientEvent[K]
export type FW_ClientReturn<K extends FW_ClientEvent> = ReturnType<
FW_ICustomClientEvent[K]
>
export type _ClientEventHasArgs<
EventName extends keyof RageFW_ICustomClientEvent,
> = keyof RageFW_ICustomClientEvent extends never
export type _ClientEventHasArgs<EventName extends keyof FW_ICustomClientEvent> =
keyof FW_ICustomClientEvent extends never
? false
: Parameters<RageFW_ICustomClientEvent[EventName]>[0] extends undefined
: Parameters<FW_ICustomClientEvent[EventName]>[0] extends undefined
? false
: true

21
browser/src/types/server.ts
View File

@ -1,33 +1,32 @@
import type { RageFW_ICustomServerEvent } from '@entityseven/rage-fw-shared-types'
import type { 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 only include custom events
*/
export type RageFW_ServerEvent = keyof RageFW_ICustomServerEvent
export type FW_ServerEvent = keyof FW_ICustomServerEvent
/**
* Array of arguments of event you pass as a generic
* These only include custom server events
*/
export type RageFW_ServerArgs<K extends RageFW_ServerEvent> = Parameters<
RageFW_ICustomServerEvent[K]
export type FW_ServerArgs<K extends FW_ServerEvent> = Parameters<
FW_ICustomServerEvent[K]
>
/**
* Return type of event you pass as a generic
* These only include custom server events
*/
export type RageFW_ServerReturn<K extends RageFW_ServerEvent> = ReturnType<
RageFW_ICustomServerEvent[K]
export type FW_ServerReturn<K extends FW_ServerEvent> = ReturnType<
FW_ICustomServerEvent[K]
>
export type _ServerEventHasArgs<
EventName extends keyof RageFW_ICustomServerEvent,
> = keyof RageFW_ICustomServerEvent extends never
export type _ServerEventHasArgs<EventName extends keyof FW_ICustomServerEvent> =
keyof FW_ICustomServerEvent extends never
? false
: Parameters<RageFW_ICustomServerEvent[EventName]>[0] extends undefined
: Parameters<FW_ICustomServerEvent[EventName]>[0] extends undefined
? false
: true

24
client/src/core/client.ts
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')

2
client/src/core/logger.ts
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
*

22
client/src/core/middleware.ts
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,
)

26
client/src/core/player.ts
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)
}
}

18
client/src/types/browser.ts
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

33
client/src/types/client.ts
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
export type _ClientEventHasArgs<EventName extends keyof FW_ICustomClientEvent> =
keyof FW_ICustomClientEvent extends never
? false
: Parameters<RageFW_ICustomClientEvent[EventName]>[0] extends undefined
: Parameters<FW_ICustomClientEvent[EventName]>[0] extends undefined
? false
: true

17
client/src/types/middleware.ts
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
}

25
client/src/types/server.ts
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
export type _ServerEventHasArgs<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

19
rpc/index.d.ts vendored
View File

@ -1,25 +1,8 @@
export {}
interface Mp {
trigger(event: string, data?: any): void
events: {
add(event: string, data: any): void
call(event: string, data: any): void
callRemote(event: string, data: any): void
remove(event: string): void
}
joaat?: unknown
game: {
joaat?: unknown
}
console: {
logInfo: (...args: unknown[]) => void
}
}
declare var global: Record<string, (...args: any[]) => unknown>
declare global {
const mp: Mp
const global: Record<string, (...args: any[]) => unknown>
interface Window {
[p: string]: any
}

5
rpc/package.json
View File

@ -2,8 +2,11 @@
"private": false,
"name": "@entityseven/rage-fw-rpc",
"version": "0.2.5",
"main": "src/index.ts",
"publishConfig": {
"main": "dist/index.js",
"types": "dist/src/index.d.ts",
"types": "dist/index.d.ts"
},
"scripts": {
"build": "tsup",
"start": "npx ./dist create"

2
rpc/src/browser.ts
View File

@ -1,3 +1,5 @@
/// <reference types="@ragempcommunity/types-cef" />
import { Wrapper } from './wrapper'
import {
Environment,

2
rpc/src/client.ts
View File

@ -1,3 +1,5 @@
/// <reference types="@ragempcommunity/types-client" />
import { Wrapper } from './wrapper'
import {
Environment,

2
rpc/src/server.ts
View File

@ -1,3 +1,5 @@
/// <reference types="@ragempcommunity/types-server" />
import { Wrapper } from './wrapper'
import {
type PlayerMp,

2
rpc/tsconfig.json
View File

@ -12,7 +12,7 @@
"sourceMap": true,
},
"include": [
"./index.d.ts"
"src"
],
"extends": ["../tsconfig.ragefw.json"]
}

2
server/src/core/logger.ts
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}`
})

22
server/src/core/middleware.ts
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,
)

17
server/src/core/player.ts
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])

32
server/src/core/server.ts
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')

18
server/src/types/browser.ts
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

21
server/src/types/client.ts
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]>
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]>
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
export type _ClientEventHasArgs<EventName extends keyof FW_ICustomClientEvent> =
keyof FW_ICustomClientEvent extends never
? false
: Parameters<RageFW_ICustomClientEvent[EventName]>[0] extends undefined
: Parameters<FW_ICustomClientEvent[EventName]>[0] extends undefined
? false
: true

17
server/src/types/middleware.ts
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
}

38
server/src/types/server.ts
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

6
shared-types/types/types/index.d.ts vendored
View File

@ -1,13 +1,13 @@
declare module '@entityseven/rage-fw-shared-types' {
export interface RageFW_ICustomServerEvent {
export interface FW_ICustomServerEvent {
// customServerEvent(arg1: string, arg2: number): boolean // example event
}
export interface RageFW_ICustomClientEvent {
export interface FW_ICustomClientEvent {
// customClientEvent(arg1: string, arg2: number): boolean // example event
}
export interface RageFW_ICustomBrowserEvent {
export interface FW_ICustomBrowserEvent {
// customCefEvent(arg1: string, arg2: number): boolean // example event
}
}