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