upd (fw):
- fixed inconsistent rpc build - changed project-wide naming convention to prefix with "FW_" instead of "RageFW_"
This commit is contained in:
parent
7a37aa390e
commit
edafb5289e
@ -1,9 +1,9 @@
|
|||||||
import { Helper } from './helper'
|
import { FW_Helper } from './helper'
|
||||||
import { rpc } from './rpc'
|
import { rpc } from './rpc'
|
||||||
import type * as T from '../types'
|
import type * as T from '../types'
|
||||||
|
|
||||||
/** Browser-side interactions */
|
/** Browser-side interactions */
|
||||||
export class Browser extends Helper {
|
export class FW_Browser extends FW_Helper {
|
||||||
constructor() {
|
constructor() {
|
||||||
super()
|
super()
|
||||||
}
|
}
|
||||||
@ -29,7 +29,7 @@ export class Browser extends Helper {
|
|||||||
*
|
*
|
||||||
* @param eventName - The name of the event to register
|
* @param eventName - The name of the event to register
|
||||||
* @param callback - The callback function to be executed when the event is triggered
|
* @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
|
* @example
|
||||||
* // Registering an event
|
* // Registering an event
|
||||||
@ -39,10 +39,10 @@ export class Browser extends Helper {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @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,
|
eventName: EventName,
|
||||||
callback: T.RageFW_BrowserCallback<EventName>,
|
callback: T.FW_BrowserCallback<EventName>,
|
||||||
): Browser {
|
): FW_Browser {
|
||||||
this.log_('register', eventName, callback)
|
this.log_('register', eventName, callback)
|
||||||
|
|
||||||
rpc.register<
|
rpc.register<
|
||||||
@ -58,7 +58,7 @@ export class Browser extends Helper {
|
|||||||
* Unregisters a browser event, removing the associated callback
|
* Unregisters a browser event, removing the associated callback
|
||||||
*
|
*
|
||||||
* @param eventName - The name of the event to unregister
|
* @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
|
* @example
|
||||||
* // Unregistering an event
|
* // Unregistering an event
|
||||||
@ -66,9 +66,9 @@ export class Browser extends Helper {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @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,
|
eventName: EventName,
|
||||||
): Browser {
|
): FW_Browser {
|
||||||
rpc.unregister<EventName>(eventName)
|
rpc.unregister<EventName>(eventName)
|
||||||
|
|
||||||
return this
|
return this
|
||||||
@ -93,18 +93,18 @@ export class Browser extends Helper {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @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,
|
eventName: EventName,
|
||||||
...args: T._BrowserEventHasArgs<EventName> extends true
|
...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)
|
this.log_('[RPC](trigger):', eventName, ...args)
|
||||||
|
|
||||||
return await rpc.call<
|
return await rpc.call<
|
||||||
typeof args,
|
typeof args,
|
||||||
EventName,
|
EventName,
|
||||||
T.RageFW_BrowserReturn<EventName>
|
T.FW_BrowserReturn<EventName>
|
||||||
>(eventName, args)
|
>(eventName, args)
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -127,18 +127,18 @@ export class Browser extends Helper {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @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,
|
eventName: EventName,
|
||||||
...args: T._ServerEventHasArgs<EventName> extends true
|
...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)
|
this.log_('[RPC](triggerServer):', eventName, ...args)
|
||||||
|
|
||||||
return await rpc.callServer<
|
return await rpc.callServer<
|
||||||
typeof args,
|
typeof args,
|
||||||
EventName,
|
EventName,
|
||||||
T.RageFW_ServerReturn<EventName>
|
T.FW_ServerReturn<EventName>
|
||||||
>(eventName, args)
|
>(eventName, args)
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -161,18 +161,18 @@ export class Browser extends Helper {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @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,
|
eventName: EventName,
|
||||||
...args: T._ClientEventHasArgs<EventName> extends true
|
...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)
|
this.log_('[RPC](triggerClient):', eventName, ...args)
|
||||||
|
|
||||||
return await rpc.callClient<
|
return await rpc.callClient<
|
||||||
typeof args,
|
typeof args,
|
||||||
EventName,
|
EventName,
|
||||||
T.RageFW_ClientReturn<EventName>
|
T.FW_ClientReturn<EventName>
|
||||||
>(eventName, args)
|
>(eventName, args)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
export class Helper {
|
export class FW_Helper {
|
||||||
protected debugLogs_: boolean = false
|
protected debugLogs_: boolean = false
|
||||||
protected customLogger_:
|
protected customLogger_:
|
||||||
| undefined
|
| undefined
|
||||||
|
@ -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
|
* Package used on a browser-side of your Rage:MP Server
|
||||||
@ -7,10 +7,12 @@ import { Browser, rpc } from './core'
|
|||||||
*/
|
*/
|
||||||
export const fw = {
|
export const fw = {
|
||||||
/** Browser-side interactions */
|
/** 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 */
|
/** ``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,
|
rpc,
|
||||||
}
|
}
|
||||||
;(async () => {
|
;(async () => {
|
||||||
await fw.event.triggerClient('cefReady')
|
await fw.event.triggerClient(
|
||||||
|
'cefReady' as Parameters<typeof fw.event.triggerClient>[0],
|
||||||
|
)
|
||||||
})()
|
})()
|
||||||
|
@ -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
|
* Union of all available browser event names
|
||||||
* These only include custom events
|
* 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
|
* Array of arguments of an event you pass as a generic
|
||||||
* These only include custom browser events
|
* These only include custom browser events
|
||||||
*/
|
*/
|
||||||
export type RageFW_BrowserArgs<K extends RageFW_BrowserEvent> = Parameters<
|
export type FW_BrowserArgs<K extends FW_BrowserEvent> = Parameters<
|
||||||
RageFW_ICustomBrowserEvent[K]
|
FW_ICustomBrowserEvent[K]
|
||||||
>
|
>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return type of event you pass as a generic
|
* Return type of event you pass as a generic
|
||||||
* These only include custom browser events
|
* These only include custom browser events
|
||||||
*/
|
*/
|
||||||
export type RageFW_BrowserReturn<K extends RageFW_BrowserEvent> = ReturnType<
|
export type FW_BrowserReturn<K extends FW_BrowserEvent> = ReturnType<
|
||||||
RageFW_ICustomBrowserEvent[K]
|
FW_ICustomBrowserEvent[K]
|
||||||
>
|
>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Callback (function) of event you pass as a generic
|
* Callback (function) of event you pass as a generic
|
||||||
* These only include custom browser events
|
* These only include custom browser events
|
||||||
*/
|
*/
|
||||||
export type RageFW_BrowserCallback<K extends keyof RageFW_ICustomBrowserEvent> =
|
export type FW_BrowserCallback<K extends keyof FW_ICustomBrowserEvent> = (
|
||||||
(...args: RageFW_BrowserArgs<K>) => Promise<RageFW_BrowserReturn<K>>
|
...args: FW_BrowserArgs<K>
|
||||||
|
) => Promise<FW_BrowserReturn<K>>
|
||||||
|
|
||||||
export type _BrowserEventHasArgs<
|
export type _BrowserEventHasArgs<
|
||||||
EventName extends keyof RageFW_ICustomBrowserEvent,
|
EventName extends keyof FW_ICustomBrowserEvent,
|
||||||
> = keyof RageFW_ICustomBrowserEvent extends never
|
> = keyof FW_ICustomBrowserEvent extends never
|
||||||
? false
|
? false
|
||||||
: Parameters<RageFW_ICustomBrowserEvent[EventName]>[0] extends undefined
|
: Parameters<FW_ICustomBrowserEvent[EventName]>[0] extends undefined
|
||||||
? false
|
? false
|
||||||
: true
|
: true
|
||||||
|
@ -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'
|
export type { FW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
|
||||||
|
|
||||||
/**
|
|
||||||
* Union of all internal client event names
|
|
||||||
* These only include internal events
|
|
||||||
*/
|
|
||||||
export type RageFW_InternalEvent = 'cefReady'
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Union of all available client event names
|
* Union of all available client event names
|
||||||
* These only include custom events and some internals for RageFW
|
* These only include custom events and some internals for RageFW
|
||||||
*/
|
*/
|
||||||
export type RageFW_ClientEvent =
|
export type FW_ClientEvent = keyof FW_ICustomClientEvent
|
||||||
| keyof RageFW_ICustomClientEvent
|
|
||||||
| RageFW_InternalEvent
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Array of arguments of event you pass as a generic
|
* Array of arguments of event you pass as a generic
|
||||||
* These only include custom client events
|
* These only include custom client events
|
||||||
*/
|
*/
|
||||||
export type RageFW_ClientArgs<K extends RageFW_ClientEvent> = Parameters<
|
export type FW_ClientArgs<K extends FW_ClientEvent> = Parameters<
|
||||||
RageFW_ICustomClientEvent[K]
|
FW_ICustomClientEvent[K]
|
||||||
>
|
>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return type of event you pass as a generic
|
* Return type of event you pass as a generic
|
||||||
* These only include custom client events
|
* These only include custom client events
|
||||||
*/
|
*/
|
||||||
export type RageFW_ClientReturn<K extends RageFW_ClientEvent> = ReturnType<
|
export type FW_ClientReturn<K extends FW_ClientEvent> = ReturnType<
|
||||||
RageFW_ICustomClientEvent[K]
|
FW_ICustomClientEvent[K]
|
||||||
>
|
>
|
||||||
|
|
||||||
export type _ClientEventHasArgs<
|
export type _ClientEventHasArgs<EventName extends keyof FW_ICustomClientEvent> =
|
||||||
EventName extends keyof RageFW_ICustomClientEvent,
|
keyof FW_ICustomClientEvent extends never
|
||||||
> = keyof RageFW_ICustomClientEvent extends never
|
|
||||||
? false
|
? false
|
||||||
: Parameters<RageFW_ICustomClientEvent[EventName]>[0] extends undefined
|
: Parameters<FW_ICustomClientEvent[EventName]>[0] extends undefined
|
||||||
? false
|
? false
|
||||||
: true
|
: true
|
||||||
|
@ -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
|
* Union of all available server event names
|
||||||
* These only include custom events
|
* 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
|
* Array of arguments of event you pass as a generic
|
||||||
* These only include custom server events
|
* These only include custom server events
|
||||||
*/
|
*/
|
||||||
export type RageFW_ServerArgs<K extends RageFW_ServerEvent> = Parameters<
|
export type FW_ServerArgs<K extends FW_ServerEvent> = Parameters<
|
||||||
RageFW_ICustomServerEvent[K]
|
FW_ICustomServerEvent[K]
|
||||||
>
|
>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return type of event you pass as a generic
|
* Return type of event you pass as a generic
|
||||||
* These only include custom server events
|
* These only include custom server events
|
||||||
*/
|
*/
|
||||||
export type RageFW_ServerReturn<K extends RageFW_ServerEvent> = ReturnType<
|
export type FW_ServerReturn<K extends FW_ServerEvent> = ReturnType<
|
||||||
RageFW_ICustomServerEvent[K]
|
FW_ICustomServerEvent[K]
|
||||||
>
|
>
|
||||||
|
|
||||||
export type _ServerEventHasArgs<
|
export type _ServerEventHasArgs<EventName extends keyof FW_ICustomServerEvent> =
|
||||||
EventName extends keyof RageFW_ICustomServerEvent,
|
keyof FW_ICustomServerEvent extends never
|
||||||
> = keyof RageFW_ICustomServerEvent extends never
|
|
||||||
? false
|
? false
|
||||||
: Parameters<RageFW_ICustomServerEvent[EventName]>[0] extends undefined
|
: Parameters<FW_ICustomServerEvent[EventName]>[0] extends undefined
|
||||||
? false
|
? false
|
||||||
: true
|
: true
|
||||||
|
@ -1,9 +1,9 @@
|
|||||||
import { rpc } from './rpc'
|
import { rpc } from './rpc'
|
||||||
import { Middleware } from './middleware'
|
import { FW_Middleware } from './middleware'
|
||||||
import type * as T from '../types'
|
import type * as T from '../types'
|
||||||
|
|
||||||
/** Client-side interactions */
|
/** Client-side interactions */
|
||||||
export class Client {
|
export class FW_Client {
|
||||||
/**
|
/**
|
||||||
* Registers a client event with an associated callback
|
* 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 callback - The callback function to be executed when the event is triggered
|
||||||
* @param [options] - Optional settings for callback execution
|
* @param [options] - Optional settings for callback execution
|
||||||
* @param [options.middlewares] - Middleware functions to be checked before the callback executes
|
* @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
|
* @example
|
||||||
* // Registering an event
|
* // Registering an event
|
||||||
@ -40,13 +40,13 @@ export class Client {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @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,
|
eventName: EventName,
|
||||||
callback: T.RageFW_ClientCallback<EventName>,
|
callback: T.FW_ClientCallback<EventName>,
|
||||||
options?: {
|
options?: {
|
||||||
middlewares?: T.RageFW_MiddlewareOptions<EventName>
|
middlewares?: T.FW_MiddlewareOptions<EventName>
|
||||||
},
|
},
|
||||||
): Client {
|
): FW_Client {
|
||||||
rpc.register<
|
rpc.register<
|
||||||
Parameters<typeof callback>,
|
Parameters<typeof callback>,
|
||||||
ReturnType<typeof callback> | Promise<unknown>,
|
ReturnType<typeof callback> | Promise<unknown>,
|
||||||
@ -54,7 +54,7 @@ export class Client {
|
|||||||
>(eventName, async (...data) => {
|
>(eventName, async (...data) => {
|
||||||
if (!options?.middlewares) return await callback(...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
|
return this
|
||||||
@ -72,15 +72,11 @@ export class Client {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @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,
|
eventName: EventName,
|
||||||
): Client {
|
): FW_Client {
|
||||||
rpc.unregister<EventName>(eventName)
|
rpc.unregister<EventName>(eventName)
|
||||||
|
|
||||||
return this
|
return this
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// new Client()
|
|
||||||
// .register('customClientEvent', async (a, b) => true)
|
|
||||||
// .unregister('customClientEvent')
|
|
||||||
|
@ -1,7 +1,7 @@
|
|||||||
/**
|
/**
|
||||||
* Used to log to a client in-game console
|
* Used to log to a client in-game console
|
||||||
*/
|
*/
|
||||||
export class Logger {
|
export class FW_Logger {
|
||||||
/**
|
/**
|
||||||
* Informational logs. Colored in white
|
* Informational logs. Colored in white
|
||||||
*
|
*
|
||||||
|
@ -1,12 +1,12 @@
|
|||||||
import type * as T from '../types'
|
import type * as T from '../types'
|
||||||
|
|
||||||
export class Middleware {
|
export class FW_Middleware {
|
||||||
constructor() {}
|
constructor() {}
|
||||||
|
|
||||||
private static async execute<EventName extends T.RageFW_ClientEvent>(
|
private static async execute<EventName extends T.FW_ClientEvent>(
|
||||||
middlewares: T.RageFW_MiddlewareFunction<EventName>[],
|
middlewares: T.FW_MiddlewareFunction<EventName>[],
|
||||||
args: T.RageFW_ClientArgs<EventName>,
|
args: T.FW_ClientArgs<EventName>,
|
||||||
): Promise<T.RageFW_MiddlewareResponseInternal> {
|
): Promise<T.FW_MiddlewareResponseInternal> {
|
||||||
for (let i = 0; i < middlewares.length; i++) {
|
for (let i = 0; i < middlewares.length; i++) {
|
||||||
const result = await middlewares[i](...args)
|
const result = await middlewares[i](...args)
|
||||||
|
|
||||||
@ -21,20 +21,20 @@ export class Middleware {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public static async process<EventName extends T.RageFW_ClientEvent>(
|
public static async process<EventName extends T.FW_ClientEvent>(
|
||||||
middlewareOptions: T.RageFW_MiddlewareOptions<EventName>,
|
middlewareOptions: T.FW_MiddlewareOptions<EventName>,
|
||||||
callback: T.RageFW_ClientCallback<EventName>,
|
callback: T.FW_ClientCallback<EventName>,
|
||||||
args: T.RageFW_ClientArgs<EventName>,
|
args: T.FW_ClientArgs<EventName>,
|
||||||
) {
|
) {
|
||||||
if (Array.isArray(middlewareOptions)) {
|
if (Array.isArray(middlewareOptions)) {
|
||||||
const middlewaresResponse = await Middleware.execute(
|
const middlewaresResponse = await FW_Middleware.execute(
|
||||||
middlewareOptions,
|
middlewareOptions,
|
||||||
args,
|
args,
|
||||||
)
|
)
|
||||||
|
|
||||||
if (middlewaresResponse.success) return await callback(...args)
|
if (middlewaresResponse.success) return await callback(...args)
|
||||||
} else {
|
} else {
|
||||||
const middlewaresResponse = await Middleware.execute(
|
const middlewaresResponse = await FW_Middleware.execute(
|
||||||
middlewareOptions.executables,
|
middlewareOptions.executables,
|
||||||
args,
|
args,
|
||||||
)
|
)
|
||||||
|
@ -2,7 +2,7 @@ import { rpc } from './rpc'
|
|||||||
import type * as T from '../types'
|
import type * as T from '../types'
|
||||||
|
|
||||||
/** Handles event manipulations that require player to be present in context */
|
/** Handles event manipulations that require player to be present in context */
|
||||||
export class Player {
|
export class FW_Player {
|
||||||
private _browser: BrowserMp | undefined = undefined
|
private _browser: BrowserMp | undefined = undefined
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -32,16 +32,16 @@ export class Player {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @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,
|
eventName: EventName,
|
||||||
...args: T._ClientEventHasArgs<EventName> extends true
|
...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<
|
return await rpc.call<
|
||||||
typeof args,
|
typeof args,
|
||||||
EventName,
|
EventName,
|
||||||
T.RageFW_ClientReturn<EventName>
|
T.FW_ClientReturn<EventName>
|
||||||
>(eventName, args)
|
>(eventName, args)
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -64,16 +64,16 @@ export class Player {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @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,
|
eventName: EventName,
|
||||||
...args: T._ServerEventHasArgs<EventName> extends true
|
...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<
|
return await rpc.callServer<
|
||||||
typeof args,
|
typeof args,
|
||||||
EventName,
|
EventName,
|
||||||
T.RageFW_ClientServerReturn<EventName>
|
T.FW_ClientServerReturn<EventName>
|
||||||
>(eventName, args)
|
>(eventName, args)
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -96,19 +96,19 @@ export class Player {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @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,
|
eventName: EventName,
|
||||||
...args: T._BrowserEventHasArgs<EventName> extends true
|
...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)
|
if (!this._browser)
|
||||||
throw new Error('You need to initialize browser first')
|
throw new Error('You need to initialize browser first')
|
||||||
|
|
||||||
return await rpc.callBrowser<
|
return await rpc.callBrowser<
|
||||||
typeof args,
|
typeof args,
|
||||||
EventName,
|
EventName,
|
||||||
T.RageFW_BrowserReturn<EventName>
|
T.FW_BrowserReturn<EventName>
|
||||||
>(eventName, args)
|
>(eventName, args)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,29 +1,29 @@
|
|||||||
/// <reference types="@ragempcommunity/types-client" />
|
/// <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
|
* Union of all available browser event names callable from client
|
||||||
* These only include custom events
|
* 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
|
* Array of arguments for an event, name of which you pass as a generic
|
||||||
* These only include custom events
|
* These only include custom events
|
||||||
*/
|
*/
|
||||||
export type RageFW_BrowserArgs<K extends RageFW_BrowserEvent> = Parameters<
|
export type FW_BrowserArgs<K extends FW_BrowserEvent> = Parameters<
|
||||||
RageFW_ICustomBrowserEvent[K]
|
FW_ICustomBrowserEvent[K]
|
||||||
>
|
>
|
||||||
|
|
||||||
export type RageFW_BrowserReturn<K extends RageFW_BrowserEvent> = ReturnType<
|
export type FW_BrowserReturn<K extends FW_BrowserEvent> = ReturnType<
|
||||||
RageFW_ICustomBrowserEvent[K]
|
FW_ICustomBrowserEvent[K]
|
||||||
>
|
>
|
||||||
|
|
||||||
export type _BrowserEventHasArgs<
|
export type _BrowserEventHasArgs<
|
||||||
EventName extends keyof RageFW_ICustomBrowserEvent,
|
EventName extends keyof FW_ICustomBrowserEvent,
|
||||||
> = keyof RageFW_ICustomBrowserEvent extends never
|
> = keyof FW_ICustomBrowserEvent extends never
|
||||||
? false
|
? false
|
||||||
: Parameters<RageFW_ICustomBrowserEvent[EventName]>[0] extends undefined
|
: Parameters<FW_ICustomBrowserEvent[EventName]>[0] extends undefined
|
||||||
? false
|
? false
|
||||||
: true
|
: true
|
||||||
|
@ -1,24 +1,22 @@
|
|||||||
/// <reference types="@ragempcommunity/types-client" />
|
/// <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
|
* Union of all available client event names
|
||||||
* These include custom and system events
|
* These include custom and system events
|
||||||
*/
|
*/
|
||||||
export type RageFW_ClientEvent =
|
export type FW_ClientEvent = keyof FW_ICustomClientEvent | keyof IClientEvents
|
||||||
| keyof RageFW_ICustomClientEvent
|
|
||||||
| keyof IClientEvents
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Array of arguments for an event, name of which you pass as a generic
|
* Array of arguments for an event, name of which you pass as a generic
|
||||||
* These include custom and system events
|
* These include custom and system events
|
||||||
*/
|
*/
|
||||||
export type RageFW_ClientArgs<K extends RageFW_ClientEvent> =
|
export type FW_ClientArgs<K extends FW_ClientEvent> =
|
||||||
K extends keyof RageFW_ICustomClientEvent
|
K extends keyof FW_ICustomClientEvent
|
||||||
? Parameters<RageFW_ICustomClientEvent[K]>
|
? Parameters<FW_ICustomClientEvent[K]>
|
||||||
: K extends keyof IClientEvents
|
: K extends keyof IClientEvents
|
||||||
? Parameters<IClientEvents[K]>
|
? Parameters<IClientEvents[K]>
|
||||||
: never
|
: 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
|
* Return type for an event, name of which you pass as a generic
|
||||||
* These include custom and system events
|
* These include custom and system events
|
||||||
*/
|
*/
|
||||||
export type RageFW_ClientReturn<K extends RageFW_ClientEvent> =
|
export type FW_ClientReturn<K extends FW_ClientEvent> =
|
||||||
K extends keyof RageFW_ICustomClientEvent
|
K extends keyof FW_ICustomClientEvent
|
||||||
? ReturnType<RageFW_ICustomClientEvent[K]>
|
? ReturnType<FW_ICustomClientEvent[K]>
|
||||||
: K extends keyof IClientEvents
|
: K extends keyof IClientEvents
|
||||||
? ReturnType<IClientEvents[K]>
|
? ReturnType<IClientEvents[K]>
|
||||||
: void
|
: 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
|
* Callback (function) for an event, name of which you pass as a generic
|
||||||
* These include custom and system events
|
* These include custom and system events
|
||||||
*/
|
*/
|
||||||
export type RageFW_ClientCallback<K extends RageFW_ClientEvent> = (
|
export type FW_ClientCallback<K extends FW_ClientEvent> = (
|
||||||
...args: RageFW_ClientArgs<K>
|
...args: FW_ClientArgs<K>
|
||||||
) => Promise<RageFW_ClientReturn<K>>
|
) => Promise<FW_ClientReturn<K>>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
export type _ClientEventHasArgs<
|
export type _ClientEventHasArgs<EventName extends keyof FW_ICustomClientEvent> =
|
||||||
EventName extends keyof RageFW_ICustomClientEvent,
|
keyof FW_ICustomClientEvent extends never
|
||||||
> = keyof RageFW_ICustomClientEvent extends never
|
|
||||||
? false
|
? false
|
||||||
: Parameters<RageFW_ICustomClientEvent[EventName]>[0] extends undefined
|
: Parameters<FW_ICustomClientEvent[EventName]>[0] extends undefined
|
||||||
? false
|
? false
|
||||||
: true
|
: true
|
||||||
|
@ -1,26 +1,25 @@
|
|||||||
import type * as T from './client'
|
import type * as T from './client'
|
||||||
|
|
||||||
export type RageFW_MiddlewareResponse =
|
export type FW_MiddlewareResponse =
|
||||||
| {
|
| {
|
||||||
success: boolean
|
success: boolean
|
||||||
message?: string
|
message?: string
|
||||||
}
|
}
|
||||||
| boolean
|
| boolean
|
||||||
|
|
||||||
export type RageFW_MiddlewareResponseInternal = {
|
export type FW_MiddlewareResponseInternal = {
|
||||||
success: boolean
|
success: boolean
|
||||||
message?: string
|
message?: string
|
||||||
id?: number
|
id?: number
|
||||||
}
|
}
|
||||||
|
|
||||||
export type RageFW_MiddlewareFunction<EventName extends T.RageFW_ClientEvent> =
|
export type FW_MiddlewareFunction<EventName extends T.FW_ClientEvent> = (
|
||||||
(
|
...args: T.FW_ClientArgs<EventName>
|
||||||
...args: T.RageFW_ClientArgs<EventName>
|
) => Promise<FW_MiddlewareResponse>
|
||||||
) => Promise<RageFW_MiddlewareResponse>
|
|
||||||
|
|
||||||
export type RageFW_MiddlewareOptions<EventName extends T.RageFW_ClientEvent> =
|
export type FW_MiddlewareOptions<EventName extends T.FW_ClientEvent> =
|
||||||
| RageFW_MiddlewareFunction<EventName>[]
|
| FW_MiddlewareFunction<EventName>[]
|
||||||
| {
|
| {
|
||||||
executables: RageFW_MiddlewareFunction<EventName>[]
|
executables: FW_MiddlewareFunction<EventName>[]
|
||||||
onError: (error: string) => unknown
|
onError: (error: string) => unknown
|
||||||
}
|
}
|
||||||
|
@ -1,38 +1,37 @@
|
|||||||
/// <reference types="@ragempcommunity/types-client" />
|
/// <reference types="@ragempcommunity/types-client" />
|
||||||
|
|
||||||
import type {
|
import type {
|
||||||
RageFW_ICustomClientEvent,
|
FW_ICustomClientEvent,
|
||||||
RageFW_ICustomServerEvent,
|
FW_ICustomServerEvent,
|
||||||
} from '@entityseven/rage-fw-shared-types'
|
} from '@entityseven/rage-fw-shared-types'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Union of all available server event names callable from client
|
* Union of all available server event names callable from client
|
||||||
* These only include custom events
|
* 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
|
* Array of arguments for an event, name of which you pass as a generic
|
||||||
* These only include custom events
|
* These only include custom events
|
||||||
*/
|
*/
|
||||||
export type RageFW_ServerArgs<K extends RageFW_ServerEvent> =
|
export type FW_ServerArgs<K extends FW_ServerEvent> =
|
||||||
K extends keyof RageFW_ICustomServerEvent
|
K extends keyof FW_ICustomServerEvent
|
||||||
? Parameters<RageFW_ICustomServerEvent[K]>
|
? Parameters<FW_ICustomServerEvent[K]>
|
||||||
: never
|
: never
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return type for an event, name of which you pass as a generic
|
* Return type for an event, name of which you pass as a generic
|
||||||
* These only include custom events
|
* These only include custom events
|
||||||
*/
|
*/
|
||||||
export type RageFW_ClientServerReturn<K extends RageFW_ServerEvent> =
|
export type FW_ClientServerReturn<K extends FW_ServerEvent> =
|
||||||
K extends keyof RageFW_ICustomServerEvent
|
K extends keyof FW_ICustomServerEvent
|
||||||
? ReturnType<RageFW_ICustomServerEvent[K]>
|
? ReturnType<FW_ICustomServerEvent[K]>
|
||||||
: never
|
: never
|
||||||
|
|
||||||
export type _ServerEventHasArgs<
|
export type _ServerEventHasArgs<EventName extends keyof FW_ICustomServerEvent> =
|
||||||
EventName extends keyof RageFW_ICustomServerEvent,
|
keyof FW_ICustomClientEvent extends never
|
||||||
> = keyof RageFW_ICustomClientEvent extends never
|
|
||||||
? false
|
? false
|
||||||
: Parameters<RageFW_ICustomServerEvent[EventName]>[0] extends undefined
|
: Parameters<FW_ICustomServerEvent[EventName]>[0] extends undefined
|
||||||
? false
|
? false
|
||||||
: true
|
: true
|
||||||
|
19
rpc/index.d.ts
vendored
19
rpc/index.d.ts
vendored
@ -1,25 +1,8 @@
|
|||||||
export {}
|
export {}
|
||||||
|
|
||||||
interface Mp {
|
declare var global: Record<string, (...args: any[]) => unknown>
|
||||||
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 global {
|
declare global {
|
||||||
const mp: Mp
|
|
||||||
const global: Record<string, (...args: any[]) => unknown>
|
|
||||||
interface Window {
|
interface Window {
|
||||||
[p: string]: any
|
[p: string]: any
|
||||||
}
|
}
|
||||||
|
@ -2,8 +2,11 @@
|
|||||||
"private": false,
|
"private": false,
|
||||||
"name": "@entityseven/rage-fw-rpc",
|
"name": "@entityseven/rage-fw-rpc",
|
||||||
"version": "0.2.5",
|
"version": "0.2.5",
|
||||||
|
"main": "src/index.ts",
|
||||||
|
"publishConfig": {
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"types": "dist/src/index.d.ts",
|
"types": "dist/index.d.ts"
|
||||||
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "tsup",
|
"build": "tsup",
|
||||||
"start": "npx ./dist create"
|
"start": "npx ./dist create"
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
/// <reference types="@ragempcommunity/types-cef" />
|
||||||
|
|
||||||
import { Wrapper } from './wrapper'
|
import { Wrapper } from './wrapper'
|
||||||
import {
|
import {
|
||||||
Environment,
|
Environment,
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
/// <reference types="@ragempcommunity/types-client" />
|
||||||
|
|
||||||
import { Wrapper } from './wrapper'
|
import { Wrapper } from './wrapper'
|
||||||
import {
|
import {
|
||||||
Environment,
|
Environment,
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
/// <reference types="@ragempcommunity/types-server" />
|
||||||
|
|
||||||
import { Wrapper } from './wrapper'
|
import { Wrapper } from './wrapper'
|
||||||
import {
|
import {
|
||||||
type PlayerMp,
|
type PlayerMp,
|
||||||
|
@ -12,7 +12,7 @@
|
|||||||
"sourceMap": true,
|
"sourceMap": true,
|
||||||
},
|
},
|
||||||
"include": [
|
"include": [
|
||||||
"./index.d.ts"
|
"src"
|
||||||
],
|
],
|
||||||
"extends": ["../tsconfig.ragefw.json"]
|
"extends": ["../tsconfig.ragefw.json"]
|
||||||
}
|
}
|
@ -3,7 +3,7 @@ import winston, { format } from 'winston'
|
|||||||
const { timestamp, printf, colorize } = format
|
const { timestamp, printf, colorize } = format
|
||||||
|
|
||||||
/** Used to log in a server console */
|
/** Used to log in a server console */
|
||||||
export class Logger {
|
export class FW_Logger {
|
||||||
private format = printf(({ message, level }) => {
|
private format = printf(({ message, level }) => {
|
||||||
return `[${new Date().toLocaleTimeString()}] [${level}]: ${message}`
|
return `[${new Date().toLocaleTimeString()}] [${level}]: ${message}`
|
||||||
})
|
})
|
||||||
|
@ -1,12 +1,12 @@
|
|||||||
import type * as T from '../types'
|
import type * as T from '../types'
|
||||||
|
|
||||||
export class Middleware {
|
export class FW_Middleware {
|
||||||
constructor() {}
|
constructor() {}
|
||||||
|
|
||||||
private static async execute<EventName extends T.RageFW_ServerEvent>(
|
private static async execute<EventName extends T.FW_ServerEvent>(
|
||||||
middlewares: T.RageFW_MiddlewareFunction<EventName>[],
|
middlewares: T.FW_MiddlewareFunction<EventName>[],
|
||||||
args: T.RageFW_ServerArgs<EventName>,
|
args: T.FW_ServerArgs<EventName>,
|
||||||
): Promise<T.RageFW_MiddlewareResponseInternal> {
|
): Promise<T.FW_MiddlewareResponseInternal> {
|
||||||
for (let i = 0; i < middlewares.length; i++) {
|
for (let i = 0; i < middlewares.length; i++) {
|
||||||
const result = await middlewares[i](...args)
|
const result = await middlewares[i](...args)
|
||||||
|
|
||||||
@ -21,20 +21,20 @@ export class Middleware {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public static async process<EventName extends T.RageFW_ServerEvent>(
|
public static async process<EventName extends T.FW_ServerEvent>(
|
||||||
middlewareOptions: T.RageFW_MiddlewareOptions<EventName>,
|
middlewareOptions: T.FW_MiddlewareOptions<EventName>,
|
||||||
callback: T.RageFW_ServerCallback<EventName>,
|
callback: T.FW_ServerCallback<EventName>,
|
||||||
args: T.RageFW_ServerArgs<EventName>,
|
args: T.FW_ServerArgs<EventName>,
|
||||||
) {
|
) {
|
||||||
if (Array.isArray(middlewareOptions)) {
|
if (Array.isArray(middlewareOptions)) {
|
||||||
const middlewaresResponse = await Middleware.execute(
|
const middlewaresResponse = await FW_Middleware.execute(
|
||||||
middlewareOptions,
|
middlewareOptions,
|
||||||
args,
|
args,
|
||||||
)
|
)
|
||||||
|
|
||||||
if (middlewaresResponse.success) return await callback(...args)
|
if (middlewaresResponse.success) return await callback(...args)
|
||||||
} else {
|
} else {
|
||||||
const middlewaresResponse = await Middleware.execute(
|
const middlewaresResponse = await FW_Middleware.execute(
|
||||||
middlewareOptions.executables,
|
middlewareOptions.executables,
|
||||||
args,
|
args,
|
||||||
)
|
)
|
||||||
|
@ -2,7 +2,7 @@ import { rpc } from './rpc'
|
|||||||
import type * as T from '../types'
|
import type * as T from '../types'
|
||||||
|
|
||||||
/** Handles event manipulations that require player to be present in context */
|
/** 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
|
* 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}
|
* @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,
|
player: PlayerMp,
|
||||||
eventName: EventName,
|
eventName: EventName,
|
||||||
...args: T._ClientEventHasArgs<EventName> extends true
|
...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)
|
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}
|
* @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,
|
player: PlayerMp,
|
||||||
eventName: EventName,
|
eventName: EventName,
|
||||||
...args: T._BrowserEventHasArgs<EventName> extends true
|
...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)
|
return await rpc.callBrowser(player, eventName, args)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// new Player().triggerBrowser({} as PlayerMp, 'customCefEvent', ['', 1])
|
|
||||||
// new Player().triggerClient({} as PlayerMp, 'customClientEvent', ['', 1])
|
|
||||||
|
@ -1,9 +1,9 @@
|
|||||||
import { rpc } from './rpc'
|
import { rpc } from './rpc'
|
||||||
import { Middleware } from './middleware'
|
import { FW_Middleware } from './middleware'
|
||||||
import type * as T from '../types'
|
import type * as T from '../types'
|
||||||
|
|
||||||
/** Server-side interactions */
|
/** Server-side interactions */
|
||||||
export class Server {
|
export class FW_Server {
|
||||||
/**
|
/**
|
||||||
* Registers a server event with an associated callback
|
* 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 callback - The callback function to be executed when the event is triggered
|
||||||
* @param [options] - Optional settings for callback execution
|
* @param [options] - Optional settings for callback execution
|
||||||
* @param [options.middlewares] - Middleware functions to be checked before the callback executes
|
* @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
|
* @example
|
||||||
* // Registering an event
|
* // Registering an event
|
||||||
@ -40,13 +40,13 @@ export class Server {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @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,
|
eventName: EventName,
|
||||||
callback: T.RageFW_ServerCallback<EventName>,
|
callback: T.FW_ServerCallback<EventName>,
|
||||||
options?: {
|
options?: {
|
||||||
middlewares?: T.RageFW_MiddlewareOptions<EventName>
|
middlewares?: T.FW_MiddlewareOptions<EventName>
|
||||||
},
|
},
|
||||||
): Server {
|
): FW_Server {
|
||||||
rpc.register<
|
rpc.register<
|
||||||
Parameters<typeof callback>,
|
Parameters<typeof callback>,
|
||||||
ReturnType<typeof callback> | Promise<unknown>,
|
ReturnType<typeof callback> | Promise<unknown>,
|
||||||
@ -54,7 +54,7 @@ export class Server {
|
|||||||
>(eventName, async (...data) => {
|
>(eventName, async (...data) => {
|
||||||
if (!options?.middlewares) return await callback(...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
|
return this
|
||||||
@ -64,7 +64,7 @@ export class Server {
|
|||||||
* Unregisters a server event, removing the associated callback
|
* Unregisters a server event, removing the associated callback
|
||||||
*
|
*
|
||||||
* @param eventName - The name of the event to unregister
|
* @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
|
* @example
|
||||||
* // Unregistering an event
|
* // Unregistering an event
|
||||||
@ -72,25 +72,21 @@ export class Server {
|
|||||||
*
|
*
|
||||||
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
|
* @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,
|
eventName: EventName,
|
||||||
): Server {
|
): FW_Server {
|
||||||
rpc.unregister<EventName>(eventName)
|
rpc.unregister<EventName>(eventName)
|
||||||
|
|
||||||
return this
|
return this
|
||||||
}
|
}
|
||||||
|
|
||||||
// fixme
|
// fixme
|
||||||
// public trigger<EventName extends keyof T.RageFW_ICustomServerEvent>(
|
// public trigger<EventName extends keyof T.FW_ICustomServerEvent>(
|
||||||
// eventName: EventName,
|
// eventName: EventName,
|
||||||
// ...args: T._ServerEventHasArgs<EventName> extends true
|
// ...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)
|
// return rpc.call(eventName, args)
|
||||||
// }
|
// }
|
||||||
}
|
}
|
||||||
|
|
||||||
// new Server()
|
|
||||||
// .register('customServerEvent', async (a, b, c) => true)
|
|
||||||
// .unregister('customServerEvent')
|
|
||||||
|
@ -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
|
* Union of all available browser event names
|
||||||
* These only include custom events
|
* 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
|
* Array of arguments of an event you pass as a generic
|
||||||
* These only include custom events
|
* These only include custom events
|
||||||
*/
|
*/
|
||||||
export type RageFW_BrowserArgs<K extends RageFW_BrowserEvent> = Parameters<
|
export type FW_BrowserArgs<K extends FW_BrowserEvent> = Parameters<
|
||||||
RageFW_ICustomBrowserEvent[K]
|
FW_ICustomBrowserEvent[K]
|
||||||
>
|
>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return type of event you pass as a generic
|
* Return type of event you pass as a generic
|
||||||
* These only include custom events
|
* These only include custom events
|
||||||
*/
|
*/
|
||||||
export type RageFW_BrowserReturn<K extends RageFW_BrowserEvent> = ReturnType<
|
export type FW_BrowserReturn<K extends FW_BrowserEvent> = ReturnType<
|
||||||
RageFW_ICustomBrowserEvent[K]
|
FW_ICustomBrowserEvent[K]
|
||||||
>
|
>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
export type _BrowserEventHasArgs<
|
export type _BrowserEventHasArgs<
|
||||||
EventName extends keyof RageFW_ICustomBrowserEvent,
|
EventName extends keyof FW_ICustomBrowserEvent,
|
||||||
> = keyof RageFW_ICustomBrowserEvent extends never
|
> = keyof FW_ICustomBrowserEvent extends never
|
||||||
? false
|
? false
|
||||||
: Parameters<RageFW_ICustomBrowserEvent[EventName]>[0] extends undefined
|
: Parameters<FW_ICustomBrowserEvent[EventName]>[0] extends undefined
|
||||||
? false
|
? false
|
||||||
: true
|
: true
|
||||||
|
@ -1,38 +1,35 @@
|
|||||||
/// <reference types="@ragempcommunity/types-server" />
|
/// <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
|
* Union of all available client event names
|
||||||
* These only include custom events
|
* 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
|
* Array of arguments of an event you pass as a generic
|
||||||
* These only include custom events
|
* These only include custom events
|
||||||
*/
|
*/
|
||||||
export type RageFW_ClientArgs<K extends RageFW_ClientEvent> =
|
export type FW_ClientArgs<K extends FW_ClientEvent> = K extends FW_ClientEvent
|
||||||
K extends RageFW_ClientEvent
|
? Parameters<FW_ICustomClientEvent[K]>
|
||||||
? Parameters<RageFW_ICustomClientEvent[K]>
|
|
||||||
: never
|
: never
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Return type of event you pass as a generic
|
* Return type of event you pass as a generic
|
||||||
* These only include custom events
|
* These only include custom events
|
||||||
*/
|
*/
|
||||||
export type RageFW_ClientReturn<K extends RageFW_ClientEvent> =
|
export type FW_ClientReturn<K extends FW_ClientEvent> = K extends FW_ClientEvent
|
||||||
K extends RageFW_ClientEvent
|
? ReturnType<FW_ICustomClientEvent[K]>
|
||||||
? ReturnType<RageFW_ICustomClientEvent[K]>
|
|
||||||
: never
|
: never
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
export type _ClientEventHasArgs<
|
export type _ClientEventHasArgs<EventName extends keyof FW_ICustomClientEvent> =
|
||||||
EventName extends keyof RageFW_ICustomClientEvent,
|
keyof FW_ICustomClientEvent extends never
|
||||||
> = keyof RageFW_ICustomClientEvent extends never
|
|
||||||
? false
|
? false
|
||||||
: Parameters<RageFW_ICustomClientEvent[EventName]>[0] extends undefined
|
: Parameters<FW_ICustomClientEvent[EventName]>[0] extends undefined
|
||||||
? false
|
? false
|
||||||
: true
|
: true
|
||||||
|
@ -1,26 +1,25 @@
|
|||||||
import type * as T from './server'
|
import type * as T from './server'
|
||||||
|
|
||||||
export type RageFW_MiddlewareResponse =
|
export type FW_MiddlewareResponse =
|
||||||
| {
|
| {
|
||||||
success: boolean
|
success: boolean
|
||||||
message?: string
|
message?: string
|
||||||
}
|
}
|
||||||
| boolean
|
| boolean
|
||||||
|
|
||||||
export type RageFW_MiddlewareResponseInternal = {
|
export type FW_MiddlewareResponseInternal = {
|
||||||
success: boolean
|
success: boolean
|
||||||
message?: string
|
message?: string
|
||||||
id?: number
|
id?: number
|
||||||
}
|
}
|
||||||
|
|
||||||
export type RageFW_MiddlewareFunction<EventName extends T.RageFW_ServerEvent> =
|
export type FW_MiddlewareFunction<EventName extends T.FW_ServerEvent> = (
|
||||||
(
|
...args: T.FW_ServerArgs<EventName>
|
||||||
...args: T.RageFW_ServerArgs<EventName>
|
) => Promise<FW_MiddlewareResponse>
|
||||||
) => Promise<RageFW_MiddlewareResponse>
|
|
||||||
|
|
||||||
export type RageFW_MiddlewareOptions<EventName extends T.RageFW_ServerEvent> =
|
export type FW_MiddlewareOptions<EventName extends T.FW_ServerEvent> =
|
||||||
| RageFW_MiddlewareFunction<EventName>[]
|
| FW_MiddlewareFunction<EventName>[]
|
||||||
| {
|
| {
|
||||||
executables: RageFW_MiddlewareFunction<EventName>[]
|
executables: FW_MiddlewareFunction<EventName>[]
|
||||||
onError: (error: string) => unknown
|
onError: (error: string) => unknown
|
||||||
}
|
}
|
||||||
|
@ -1,27 +1,25 @@
|
|||||||
/// <reference types="@ragempcommunity/types-server" />
|
/// <reference types="@ragempcommunity/types-server" />
|
||||||
|
|
||||||
import type {
|
import type {
|
||||||
RageFW_ICustomClientEvent,
|
FW_ICustomClientEvent,
|
||||||
RageFW_ICustomServerEvent,
|
FW_ICustomServerEvent,
|
||||||
} from '@entityseven/rage-fw-shared-types'
|
} 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
|
* Union of all available server event names
|
||||||
* These also include system events
|
* These also include system events
|
||||||
*/
|
*/
|
||||||
export type RageFW_ServerEvent =
|
export type FW_ServerEvent = keyof FW_ICustomServerEvent | keyof IServerEvents
|
||||||
| keyof RageFW_ICustomServerEvent
|
|
||||||
| keyof IServerEvents
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Array of arguments for an event, name of which you pass as a generic
|
* Array of arguments for an event, name of which you pass as a generic
|
||||||
* These also include system events
|
* These also include system events
|
||||||
*/
|
*/
|
||||||
export type RageFW_ServerArgs<K extends RageFW_ServerEvent> =
|
export type FW_ServerArgs<K extends FW_ServerEvent> =
|
||||||
K extends keyof RageFW_ICustomServerEvent
|
K extends keyof FW_ICustomServerEvent
|
||||||
? [PlayerMp, ...Parameters<RageFW_ICustomServerEvent[K]>]
|
? [PlayerMp, ...Parameters<FW_ICustomServerEvent[K]>]
|
||||||
: K extends keyof IServerEvents
|
: K extends keyof IServerEvents
|
||||||
? [PlayerMp, Parameters<IServerEvents[K]>]
|
? [PlayerMp, Parameters<IServerEvents[K]>]
|
||||||
: never
|
: 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
|
* Return type for an event, name of which you pass as a generic
|
||||||
* These include system and custom events
|
* These include system and custom events
|
||||||
*/
|
*/
|
||||||
export type RageFW_ServerReturn<K extends RageFW_ServerEvent> =
|
export type FW_ServerReturn<K extends FW_ServerEvent> =
|
||||||
K extends keyof RageFW_ICustomServerEvent
|
K extends keyof FW_ICustomServerEvent
|
||||||
? ReturnType<RageFW_ICustomServerEvent[K]>
|
? ReturnType<FW_ICustomServerEvent[K]>
|
||||||
: K extends keyof IServerEvents
|
: K extends keyof IServerEvents
|
||||||
? ReturnType<IServerEvents[K]>
|
? ReturnType<IServerEvents[K]>
|
||||||
: void
|
: 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
|
* Callback (function) for an event, name of which you pass as a generic
|
||||||
* These include system and custom events
|
* These include system and custom events
|
||||||
*/
|
*/
|
||||||
export type RageFW_ServerCallback<K extends RageFW_ServerEvent> = (
|
export type FW_ServerCallback<K extends FW_ServerEvent> = (
|
||||||
...args: RageFW_ServerArgs<K>
|
...args: FW_ServerArgs<K>
|
||||||
) => Promise<RageFW_ServerReturn<K>>
|
) => Promise<FW_ServerReturn<K>>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
export type _ServerEventHasArgs<EventName extends RageFW_ServerEvent> =
|
export type _ServerEventHasArgs<EventName extends FW_ServerEvent> =
|
||||||
EventName extends keyof RageFW_ICustomServerEvent
|
EventName extends keyof FW_ICustomServerEvent
|
||||||
? keyof RageFW_ICustomClientEvent extends never
|
? keyof FW_ICustomClientEvent extends never
|
||||||
? false
|
? false
|
||||||
: Parameters<
|
: Parameters<FW_ICustomServerEvent[EventName]>[0] extends undefined
|
||||||
RageFW_ICustomServerEvent[EventName]
|
|
||||||
>[0] extends undefined
|
|
||||||
? false
|
? false
|
||||||
: true
|
: true
|
||||||
: EventName extends keyof IServerEvents
|
: EventName extends keyof IServerEvents
|
||||||
|
6
shared-types/types/types/index.d.ts
vendored
6
shared-types/types/types/index.d.ts
vendored
@ -1,13 +1,13 @@
|
|||||||
declare module '@entityseven/rage-fw-shared-types' {
|
declare module '@entityseven/rage-fw-shared-types' {
|
||||||
export interface RageFW_ICustomServerEvent {
|
export interface FW_ICustomServerEvent {
|
||||||
// customServerEvent(arg1: string, arg2: number): boolean // example event
|
// customServerEvent(arg1: string, arg2: number): boolean // example event
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface RageFW_ICustomClientEvent {
|
export interface FW_ICustomClientEvent {
|
||||||
// customClientEvent(arg1: string, arg2: number): boolean // example event
|
// customClientEvent(arg1: string, arg2: number): boolean // example event
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface RageFW_ICustomBrowserEvent {
|
export interface FW_ICustomBrowserEvent {
|
||||||
// customCefEvent(arg1: string, arg2: number): boolean // example event
|
// customCefEvent(arg1: string, arg2: number): boolean // example event
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user