Compare commits
25
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7ad4f2b7ae | ||
|
|
02c46389b3 | ||
|
|
2df12062d0 | ||
|
|
045614379d | ||
|
|
642545595b | ||
|
|
1766f047a4 | ||
|
|
95352908f8 | ||
|
|
7a506a02e2 | ||
|
|
c94bab24f2 | ||
|
|
a0e8c0b461 | ||
|
|
0520b869db | ||
|
|
e412aff01b | ||
|
|
c52cd8b4c8 | ||
|
|
a9486db3f5 | ||
|
|
61929d7b48 | ||
|
|
d6e9c92d0a | ||
|
|
301ef4ac57 | ||
|
|
79011e0fd2 | ||
|
|
57b4f236ac | ||
|
|
558005d7b0 | ||
|
|
a03cc01aa0 | ||
|
|
bad4d532f6 | ||
|
|
234bcecc7b | ||
|
|
2b26dbffc0 | ||
|
|
88e40a4635 |
+3
-3
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "rage-fw-cef",
|
"name": "rage-fw-cef",
|
||||||
"version": "0.0.16-alpha.0",
|
"version": "0.0.22-alpha.0",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"types": "dist/src/index.d.ts",
|
"types": "dist/src/index.d.ts",
|
||||||
"files": [
|
"files": [
|
||||||
@@ -10,11 +10,11 @@
|
|||||||
"build": "tsup"
|
"build": "tsup"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"rage-fw-shared-types": "workspace:^",
|
|
||||||
"rage-rpc": "^0.4.0"
|
"rage-rpc": "^0.4.0"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"@ragempcommunity/types-cef": "^2.1.8"
|
"@ragempcommunity/types-cef": "^2.1.8",
|
||||||
|
"rage-fw-shared-types": "workspace:^"
|
||||||
},
|
},
|
||||||
"keywords": [],
|
"keywords": [],
|
||||||
"author": "SashaGoncharov19",
|
"author": "SashaGoncharov19",
|
||||||
|
|||||||
+46
-4
@@ -1,13 +1,55 @@
|
|||||||
import rpc from 'rage-rpc'
|
import rpc from 'rage-rpc'
|
||||||
|
|
||||||
|
import {
|
||||||
|
_CefEventHasArgs,
|
||||||
|
_ClientEventHasArgs,
|
||||||
|
_ServerEventHasArgs,
|
||||||
|
RageFW_CefArguments,
|
||||||
|
RageFW_CefCallback,
|
||||||
|
RageFW_CefReturn,
|
||||||
|
RageFW_ClientArguments,
|
||||||
|
RageFW_ClientReturn,
|
||||||
|
RageFW_ICustomCefEvent,
|
||||||
|
RageFW_ICustomClientEvent,
|
||||||
|
RageFW_ICustomServerEvent,
|
||||||
|
RageFW_ServerArguments,
|
||||||
|
RageFW_ServerReturn,
|
||||||
|
} from './types'
|
||||||
|
|
||||||
class Cef {
|
class Cef {
|
||||||
public register() {}
|
public register<EventName extends keyof RageFW_ICustomCefEvent>(
|
||||||
|
eventName: EventName,
|
||||||
|
callback: RageFW_CefCallback<EventName>,
|
||||||
|
): void {
|
||||||
|
rpc.register(eventName, callback)
|
||||||
|
}
|
||||||
|
|
||||||
public trigger() {}
|
public trigger<EventName extends keyof RageFW_ICustomCefEvent>(
|
||||||
|
eventName: EventName,
|
||||||
|
...args: _CefEventHasArgs<EventName> extends true
|
||||||
|
? [RageFW_CefArguments<EventName>]
|
||||||
|
: []
|
||||||
|
): Promise<RageFW_CefReturn<EventName>> {
|
||||||
|
return rpc.call(eventName, args)
|
||||||
|
}
|
||||||
|
|
||||||
public triggerServer() {}
|
public triggerServer<EventName extends keyof RageFW_ICustomServerEvent>(
|
||||||
|
eventName: EventName,
|
||||||
|
...args: _ServerEventHasArgs<EventName> extends true
|
||||||
|
? [RageFW_ServerArguments<EventName>]
|
||||||
|
: []
|
||||||
|
): Promise<RageFW_ServerReturn<EventName>> {
|
||||||
|
return rpc.callServer(eventName, args)
|
||||||
|
}
|
||||||
|
|
||||||
public triggerClient() {}
|
public triggerClient<EventName extends keyof RageFW_ICustomClientEvent>(
|
||||||
|
eventName: EventName,
|
||||||
|
...args: _ClientEventHasArgs<EventName> extends true
|
||||||
|
? [RageFW_ClientArguments<EventName>]
|
||||||
|
: []
|
||||||
|
): Promise<RageFW_ClientReturn<EventName>> {
|
||||||
|
return rpc.callClient(eventName, args)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export const fw = {
|
export const fw = {
|
||||||
|
|||||||
@@ -0,0 +1,39 @@
|
|||||||
|
import { RageFW_ICustomCefEvent } from 'rage-fw-shared-types'
|
||||||
|
export { RageFW_ICustomCefEvent } from 'rage-fw-shared-types'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Union of all available cef event names
|
||||||
|
* These only include custom events
|
||||||
|
*/
|
||||||
|
export type RageFW_CefEvent = keyof RageFW_ICustomCefEvent
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Array of arguments of an event you pass as a generic
|
||||||
|
* These only include custom cef events
|
||||||
|
*/
|
||||||
|
export type RageFW_CefArguments<K extends RageFW_CefEvent> = Parameters<
|
||||||
|
RageFW_ICustomCefEvent[K]
|
||||||
|
>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return type of event you pass as a generic
|
||||||
|
* These only include custom cef events
|
||||||
|
*/
|
||||||
|
export type RageFW_CefReturn<K extends RageFW_CefEvent> = ReturnType<
|
||||||
|
RageFW_ICustomCefEvent[K]
|
||||||
|
>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Callback (function) of event you pass as a generic
|
||||||
|
* These only include custom cef events
|
||||||
|
*/
|
||||||
|
export type RageFW_CefCallback<K extends keyof RageFW_ICustomCefEvent> = (
|
||||||
|
args: RageFW_CefArguments<K>,
|
||||||
|
) => RageFW_CefReturn<K>
|
||||||
|
|
||||||
|
export type _CefEventHasArgs<EventName extends keyof RageFW_ICustomCefEvent> =
|
||||||
|
keyof RageFW_ICustomCefEvent extends never
|
||||||
|
? false
|
||||||
|
: Parameters<RageFW_ICustomCefEvent[EventName]>[0] extends undefined
|
||||||
|
? false
|
||||||
|
: true
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
import type { RageFW_ICustomClientEvent } from 'rage-fw-shared-types'
|
||||||
|
export type { RageFW_ICustomClientEvent } from 'rage-fw-shared-types'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Union of all available client event names
|
||||||
|
* These only include custom events
|
||||||
|
*/
|
||||||
|
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 RageFW_ClientArguments<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 RageFW_ClientReturn<K extends RageFW_ClientEvent> = ReturnType<
|
||||||
|
RageFW_ICustomClientEvent[K]
|
||||||
|
>
|
||||||
|
|
||||||
|
export type _ClientEventHasArgs<
|
||||||
|
EventName extends keyof RageFW_ICustomClientEvent,
|
||||||
|
> = keyof RageFW_ICustomClientEvent extends never
|
||||||
|
? false
|
||||||
|
: Parameters<RageFW_ICustomClientEvent[EventName]>[0] extends undefined
|
||||||
|
? false
|
||||||
|
: true
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
export * from './cef'
|
||||||
|
export * from './client'
|
||||||
|
export * from './server'
|
||||||
|
|||||||
@@ -0,0 +1,32 @@
|
|||||||
|
import type { RageFW_ICustomServerEvent } from 'rage-fw-shared-types'
|
||||||
|
export type { RageFW_ICustomServerEvent } from 'rage-fw-shared-types'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Union of all available server event names
|
||||||
|
* These only include custom events
|
||||||
|
*/
|
||||||
|
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 RageFW_ServerArguments<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 RageFW_ServerReturn<K extends RageFW_ServerEvent> = ReturnType<
|
||||||
|
RageFW_ICustomServerEvent[K]
|
||||||
|
>
|
||||||
|
|
||||||
|
export type _ServerEventHasArgs<
|
||||||
|
EventName extends keyof RageFW_ICustomServerEvent,
|
||||||
|
> = keyof RageFW_ICustomServerEvent extends never
|
||||||
|
? false
|
||||||
|
: Parameters<RageFW_ICustomServerEvent[EventName]>[0] extends undefined
|
||||||
|
? false
|
||||||
|
: true
|
||||||
+1
-1
@@ -12,7 +12,7 @@
|
|||||||
"moduleDetection": "auto",
|
"moduleDetection": "auto",
|
||||||
"module": "CommonJS",
|
"module": "CommonJS",
|
||||||
"resolveJsonModule": true,
|
"resolveJsonModule": true,
|
||||||
"declaration": true,
|
"declaration": false,
|
||||||
"declarationMap": false,
|
"declarationMap": false,
|
||||||
"sourceMap": false,
|
"sourceMap": false,
|
||||||
"downlevelIteration": false,
|
"downlevelIteration": false,
|
||||||
|
|||||||
+3
-3
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "rage-fw-client",
|
"name": "rage-fw-client",
|
||||||
"version": "0.0.16-alpha.0",
|
"version": "0.0.22-alpha.0",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"types": "dist/src/index.d.ts",
|
"types": "dist/src/index.d.ts",
|
||||||
"files": [
|
"files": [
|
||||||
@@ -10,11 +10,11 @@
|
|||||||
"build": "tsup"
|
"build": "tsup"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"rage-fw-shared-types": "workspace:^",
|
|
||||||
"rage-rpc": "^0.4.0"
|
"rage-rpc": "^0.4.0"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"@ragempcommunity/types-client": "^2.1.8"
|
"@ragempcommunity/types-client": "^2.1.8",
|
||||||
|
"rage-fw-shared-types": "workspace:^"
|
||||||
},
|
},
|
||||||
"keywords": [],
|
"keywords": [],
|
||||||
"author": "SashaGoncharov19",
|
"author": "SashaGoncharov19",
|
||||||
|
|||||||
+43
-11
@@ -3,14 +3,21 @@ import rpc from 'rage-rpc'
|
|||||||
import Logger from './logger'
|
import Logger from './logger'
|
||||||
|
|
||||||
import {
|
import {
|
||||||
RageFW_ClientEventCallback,
|
_CefEventHasArgs,
|
||||||
|
_ClientEventHasArgs,
|
||||||
|
_ServerEventHasArgs,
|
||||||
|
RageFW_CefArgs,
|
||||||
|
RageFW_CefEvent,
|
||||||
|
RageFW_CefReturn,
|
||||||
RageFW_ClientEvent,
|
RageFW_ClientEvent,
|
||||||
|
RageFW_ClientEventArguments,
|
||||||
|
RageFW_ClientEventCallback,
|
||||||
|
RageFW_ClientEventReturn,
|
||||||
RageFW_ClientServerEvent,
|
RageFW_ClientServerEvent,
|
||||||
RageFW_ClientServerEventArguments,
|
RageFW_ClientServerEventArguments,
|
||||||
RageFW_ClientServerEventReturn,
|
RageFW_ClientServerEventReturn,
|
||||||
RageFW_ClientEventArguments,
|
|
||||||
RageFW_ClientEventReturn,
|
|
||||||
} from './types'
|
} from './types'
|
||||||
|
|
||||||
import type { RageFW_ICustomClientEvent } from 'rage-fw-shared-types'
|
import type { RageFW_ICustomClientEvent } from 'rage-fw-shared-types'
|
||||||
|
|
||||||
class Client {
|
class Client {
|
||||||
@@ -28,27 +35,52 @@ class Client {
|
|||||||
): void {
|
): void {
|
||||||
rpc.unregister(eventName)
|
rpc.unregister(eventName)
|
||||||
}
|
}
|
||||||
|
|
||||||
public trigger<EventName extends keyof RageFW_ICustomClientEvent>(
|
|
||||||
eventName: EventName,
|
|
||||||
args: RageFW_ClientEventArguments<EventName>,
|
|
||||||
): Promise<RageFW_ClientEventReturn<EventName>> {
|
|
||||||
return rpc.call<RageFW_ClientEventReturn<EventName>>(eventName, args)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
class Player {
|
class Player {
|
||||||
|
public browser: BrowserMp | undefined
|
||||||
|
|
||||||
|
public trigger<EventName extends keyof RageFW_ICustomClientEvent>(
|
||||||
|
eventName: EventName,
|
||||||
|
...args: _ClientEventHasArgs<EventName> extends true
|
||||||
|
? [RageFW_ClientEventArguments<EventName>]
|
||||||
|
: []
|
||||||
|
): Promise<RageFW_ClientEventReturn<EventName>> {
|
||||||
|
return rpc.call<RageFW_ClientEventReturn<EventName>>(eventName, args)
|
||||||
|
}
|
||||||
|
|
||||||
public triggerServer<EventName extends RageFW_ClientServerEvent>(
|
public triggerServer<EventName extends RageFW_ClientServerEvent>(
|
||||||
eventName: EventName,
|
eventName: EventName,
|
||||||
args: RageFW_ClientServerEventArguments<EventName>,
|
...args: _ServerEventHasArgs<EventName> extends true
|
||||||
|
? [RageFW_ClientServerEventArguments<EventName>]
|
||||||
|
: []
|
||||||
): Promise<RageFW_ClientServerEventReturn<EventName>> {
|
): Promise<RageFW_ClientServerEventReturn<EventName>> {
|
||||||
return rpc.callServer(eventName, args)
|
return rpc.callServer(eventName, args)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public triggerBrowser<EventName extends RageFW_CefEvent>(
|
||||||
|
eventName: EventName,
|
||||||
|
...args: _CefEventHasArgs<EventName> extends true
|
||||||
|
? [RageFW_CefArgs<EventName>]
|
||||||
|
: []
|
||||||
|
): Promise<RageFW_CefReturn<EventName>> {
|
||||||
|
if (!this.browser)
|
||||||
|
throw new Error('You need to initialize browser first!')
|
||||||
|
return rpc.callBrowser(this.browser, eventName, args)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class Browser extends Player {
|
||||||
|
public registerBrowser(browser: BrowserMp) {
|
||||||
|
this.browser = browser
|
||||||
|
return browser
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export const fw = {
|
export const fw = {
|
||||||
event: new Client(),
|
event: new Client(),
|
||||||
player: new Player(),
|
player: new Player(),
|
||||||
|
browser: new Browser(),
|
||||||
system: {
|
system: {
|
||||||
log: new Logger(),
|
log: new Logger(),
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -0,0 +1,20 @@
|
|||||||
|
/// <reference types="@ragempcommunity/types-client" />
|
||||||
|
|
||||||
|
import type { RageFW_ICustomCefEvent } from 'rage-fw-shared-types'
|
||||||
|
|
||||||
|
export type RageFW_CefEvent = keyof RageFW_ICustomCefEvent
|
||||||
|
|
||||||
|
export type RageFW_CefArgs<K extends RageFW_CefEvent> = Parameters<
|
||||||
|
RageFW_ICustomCefEvent[K]
|
||||||
|
>
|
||||||
|
|
||||||
|
export type RageFW_CefReturn<K extends RageFW_CefEvent> = ReturnType<
|
||||||
|
RageFW_ICustomCefEvent[K]
|
||||||
|
>
|
||||||
|
|
||||||
|
export type _CefEventHasArgs<EventName extends keyof RageFW_ICustomCefEvent> =
|
||||||
|
keyof RageFW_ICustomCefEvent extends never
|
||||||
|
? false
|
||||||
|
: Parameters<RageFW_ICustomCefEvent[EventName]>[0] extends undefined
|
||||||
|
? false
|
||||||
|
: true
|
||||||
@@ -2,16 +2,46 @@
|
|||||||
|
|
||||||
import type { RageFW_ICustomClientEvent } from 'rage-fw-shared-types'
|
import type { RageFW_ICustomClientEvent } from 'rage-fw-shared-types'
|
||||||
|
|
||||||
export type RageFW_ClientEvent = keyof RageFW_ICustomClientEvent
|
/**
|
||||||
|
* Union of all available client event names
|
||||||
|
* These include custom and system events
|
||||||
|
*/
|
||||||
|
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 RageFW_ClientEventArguments<K extends RageFW_ClientEvent> =
|
export type RageFW_ClientEventArguments<K extends RageFW_ClientEvent> =
|
||||||
Parameters<RageFW_ICustomClientEvent[K]>
|
K extends keyof RageFW_ICustomClientEvent
|
||||||
|
? Parameters<RageFW_ICustomClientEvent[K]>
|
||||||
|
: K extends keyof IClientEvents
|
||||||
|
? Parameters<IClientEvents[K]>
|
||||||
|
: never
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Callback (function) for an event, name of which you pass as a generic
|
||||||
|
* These only include custom events
|
||||||
|
*/
|
||||||
export type RageFW_ClientEventCallback<K extends RageFW_ClientEvent> = (
|
export type RageFW_ClientEventCallback<K extends RageFW_ClientEvent> = (
|
||||||
args: RageFW_ClientEventArguments<K>,
|
args: RageFW_ClientEventArguments<K>,
|
||||||
) => RageFW_ClientEventReturn<K>
|
) => RageFW_ClientEventReturn<K>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return type for an event, name of which you pass as a generic
|
||||||
|
* These only include custom events
|
||||||
|
*/
|
||||||
export type RageFW_ClientEventReturn<K extends RageFW_ClientEvent> =
|
export type RageFW_ClientEventReturn<K extends RageFW_ClientEvent> =
|
||||||
K extends keyof RageFW_ICustomClientEvent
|
K extends keyof RageFW_ICustomClientEvent
|
||||||
? ReturnType<RageFW_ICustomClientEvent[K]>
|
? ReturnType<RageFW_ICustomClientEvent[K]>
|
||||||
: never
|
: never
|
||||||
|
|
||||||
|
export type _ClientEventHasArgs<
|
||||||
|
EventName extends keyof RageFW_ICustomClientEvent,
|
||||||
|
> = keyof RageFW_ICustomClientEvent extends never
|
||||||
|
? false
|
||||||
|
: Parameters<RageFW_ICustomClientEvent[EventName]>[0] extends undefined
|
||||||
|
? false
|
||||||
|
: true
|
||||||
|
|||||||
@@ -1,2 +1,3 @@
|
|||||||
export * from './client'
|
export * from './client'
|
||||||
export * from './server'
|
export * from './server'
|
||||||
|
export * from './browser'
|
||||||
|
|||||||
@@ -1,16 +1,39 @@
|
|||||||
/// <reference types="@ragempcommunity/types-client" />
|
/// <reference types="@ragempcommunity/types-client" />
|
||||||
|
|
||||||
import type { RageFW_ICustomServerEvent } from 'rage-fw-shared-types'
|
import type {
|
||||||
|
RageFW_ICustomClientEvent,
|
||||||
|
RageFW_ICustomServerEvent,
|
||||||
|
} from 'rage-fw-shared-types'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Union of all available server event names callable from client
|
||||||
|
* These only include custom events
|
||||||
|
*/
|
||||||
export type RageFW_ClientServerEvent = keyof RageFW_ICustomServerEvent
|
export type RageFW_ClientServerEvent = keyof RageFW_ICustomServerEvent
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Array of arguments for an event, name of which you pass as a generic
|
||||||
|
* These only include custom events
|
||||||
|
*/
|
||||||
export type RageFW_ClientServerEventArguments<
|
export type RageFW_ClientServerEventArguments<
|
||||||
K extends RageFW_ClientServerEvent,
|
K extends RageFW_ClientServerEvent,
|
||||||
> = K extends keyof RageFW_ICustomServerEvent
|
> = K extends keyof RageFW_ICustomServerEvent
|
||||||
? Parameters<RageFW_ICustomServerEvent[K]>
|
? Parameters<RageFW_ICustomServerEvent[K]>
|
||||||
: never
|
: never
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return type for an event, name of which you pass as a generic
|
||||||
|
* These only include custom events
|
||||||
|
*/
|
||||||
export type RageFW_ClientServerEventReturn<K extends RageFW_ClientServerEvent> =
|
export type RageFW_ClientServerEventReturn<K extends RageFW_ClientServerEvent> =
|
||||||
K extends keyof RageFW_ICustomServerEvent
|
K extends keyof RageFW_ICustomServerEvent
|
||||||
? ReturnType<RageFW_ICustomServerEvent[K]>
|
? ReturnType<RageFW_ICustomServerEvent[K]>
|
||||||
: never
|
: never
|
||||||
|
|
||||||
|
export type _ServerEventHasArgs<
|
||||||
|
EventName extends keyof RageFW_ICustomServerEvent,
|
||||||
|
> = keyof RageFW_ICustomClientEvent extends never
|
||||||
|
? false
|
||||||
|
: Parameters<RageFW_ICustomServerEvent[EventName]>[0] extends undefined
|
||||||
|
? false
|
||||||
|
: true
|
||||||
|
|||||||
@@ -9,7 +9,6 @@
|
|||||||
"composite": false,
|
"composite": false,
|
||||||
"target": "ES2022",
|
"target": "ES2022",
|
||||||
"experimentalDecorators": true,
|
"experimentalDecorators": true,
|
||||||
"emitDecoratorMetadata": true,
|
|
||||||
"moduleDetection": "auto",
|
"moduleDetection": "auto",
|
||||||
"module": "CommonJS",
|
"module": "CommonJS",
|
||||||
"resolveJsonModule": true,
|
"resolveJsonModule": true,
|
||||||
|
|||||||
+1
-1
@@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"$schema": "node_modules/lerna/schemas/lerna-schema.json",
|
"$schema": "node_modules/lerna/schemas/lerna-schema.json",
|
||||||
"version": "0.0.16-alpha.0",
|
"version": "0.0.22-alpha.0",
|
||||||
"npmClient": "pnpm"
|
"npmClient": "pnpm"
|
||||||
}
|
}
|
||||||
|
|||||||
Generated
+8428
-6154
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,20 @@
|
|||||||
|
# Rage Framework (RageFW)
|
||||||
|
RageFW is a type-safe framework for developing Rage:MP servers. Designed with developers in mind, RageFW brings structure and efficiency to your Rage:MP servers, ensuring robust and maintainable code
|
||||||
|
|
||||||
|
## Features
|
||||||
|
- **Type-Safe Development:** Eliminate runtime errors and enhance code reliability with RageFW comprehensive type safety, making your RP server's development smoother than a Sunday drive through Los Santos
|
||||||
|
|
||||||
|
- **Wrapped RPC client:** Communicate effortlessly between server, client and cef with RPC system, wrapped in a cozy custom-typed blanket for your peace of mind
|
||||||
|
|
||||||
|
- **Logging System:** Keep track of server activities and debug like a pro with our built-in, feature-rich logging system. After all, even virtual cops need evidence
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
*soon*
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
Join our community of developers and contribute to the ongoing development of RageFW. At the moment the only way to contribute is opening issues
|
||||||
|
|
||||||
|
## Support
|
||||||
|
Need help? Reach out via our community forums or contact us directly through our support channels. We're committed to help you as we can
|
||||||
|
|
||||||
|
> *RageFW - because in the world of GTA:RP, nobody has time for type errors*
|
||||||
+3
-3
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "rage-fw-server",
|
"name": "rage-fw-server",
|
||||||
"version": "0.0.16-alpha.0",
|
"version": "0.0.22-alpha.0",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"types": "dist/src/index.d.ts",
|
"types": "dist/src/index.d.ts",
|
||||||
"files": [
|
"files": [
|
||||||
@@ -10,11 +10,11 @@
|
|||||||
"build": "tsup"
|
"build": "tsup"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"rage-fw-shared-types": "workspace:^",
|
|
||||||
"rage-rpc": "^0.4.0"
|
"rage-rpc": "^0.4.0"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"@ragempcommunity/types-server": "^2.1.8"
|
"@ragempcommunity/types-server": "^2.1.8",
|
||||||
|
"rage-fw-shared-types": "workspace:^"
|
||||||
},
|
},
|
||||||
"keywords": [],
|
"keywords": [],
|
||||||
"author": "SashaGoncharov19",
|
"author": "SashaGoncharov19",
|
||||||
|
|||||||
+36
-8
@@ -3,10 +3,16 @@ import rpc from 'rage-rpc'
|
|||||||
import Logger from './logger'
|
import Logger from './logger'
|
||||||
|
|
||||||
import {
|
import {
|
||||||
|
_CefEventHasArgs,
|
||||||
|
_ClientEventHasArgs,
|
||||||
|
_ServerEventHasArgs,
|
||||||
|
RageFW_CefArgs,
|
||||||
|
RageFW_CefEvent,
|
||||||
|
RageFW_CefReturn,
|
||||||
RageFW_ClientEvent,
|
RageFW_ClientEvent,
|
||||||
RageFW_ClientEventArguments,
|
|
||||||
RageFW_ClientEventReturn,
|
|
||||||
RageFW_ICustomServerEvent,
|
RageFW_ICustomServerEvent,
|
||||||
|
RageFW_ServerClientEventArguments,
|
||||||
|
RageFW_ServerClientEventReturn,
|
||||||
RageFW_ServerEvent,
|
RageFW_ServerEvent,
|
||||||
RageFW_ServerEventArguments,
|
RageFW_ServerEventArguments,
|
||||||
RageFW_ServerEventCallback,
|
RageFW_ServerEventCallback,
|
||||||
@@ -28,7 +34,7 @@ class Server {
|
|||||||
rpc.register(
|
rpc.register(
|
||||||
eventName,
|
eventName,
|
||||||
async (args: RageFW_ServerEventArguments<EventName>, info) => {
|
async (args: RageFW_ServerEventArguments<EventName>, info) => {
|
||||||
callback(info.player as PlayerMp, args)
|
callback([info.player as PlayerMp, ...args])
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
@@ -37,7 +43,11 @@ class Server {
|
|||||||
eventName: EventName,
|
eventName: EventName,
|
||||||
callback: RageFW_ServerEventCallbackNative<EventName>,
|
callback: RageFW_ServerEventCallbackNative<EventName>,
|
||||||
): void {
|
): void {
|
||||||
mp.events.add(eventName, callback)
|
mp.events.add(
|
||||||
|
eventName,
|
||||||
|
(...args: Parameters<IServerEvents[EventName]>) =>
|
||||||
|
callback([...args]),
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
public register<EventName extends RageFW_ServerEvent>(
|
public register<EventName extends RageFW_ServerEvent>(
|
||||||
@@ -99,9 +109,11 @@ class Server {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private trigger<EventName extends keyof RageFW_ICustomServerEvent>(
|
public trigger<EventName extends keyof RageFW_ICustomServerEvent>(
|
||||||
eventName: EventName,
|
eventName: EventName,
|
||||||
args: RageFW_ServerEventArguments<EventName>,
|
...args: _ServerEventHasArgs<EventName> extends true
|
||||||
|
? [RageFW_ServerEventArguments<EventName>]
|
||||||
|
: []
|
||||||
): Promise<RageFW_ServerEventReturn<EventName>> {
|
): Promise<RageFW_ServerEventReturn<EventName>> {
|
||||||
return rpc.call<RageFW_ServerEventReturn<EventName>>(eventName, args)
|
return rpc.call<RageFW_ServerEventReturn<EventName>>(eventName, args)
|
||||||
}
|
}
|
||||||
@@ -111,10 +123,22 @@ class Player {
|
|||||||
public triggerClient<EventName extends RageFW_ClientEvent>(
|
public triggerClient<EventName extends RageFW_ClientEvent>(
|
||||||
player: PlayerMp,
|
player: PlayerMp,
|
||||||
eventName: EventName,
|
eventName: EventName,
|
||||||
args: RageFW_ClientEventArguments<EventName>,
|
...args: _ClientEventHasArgs<EventName> extends true
|
||||||
): Promise<RageFW_ClientEventReturn<EventName>> {
|
? [RageFW_ServerClientEventArguments<EventName>]
|
||||||
|
: []
|
||||||
|
): Promise<RageFW_ServerClientEventReturn<EventName>> {
|
||||||
return rpc.callClient(player, eventName, args)
|
return rpc.callClient(player, eventName, args)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public triggerBrowser<EventName extends RageFW_CefEvent>(
|
||||||
|
player: PlayerMp,
|
||||||
|
eventName: EventName,
|
||||||
|
...args: _CefEventHasArgs<EventName> extends true
|
||||||
|
? [RageFW_CefArgs<EventName>]
|
||||||
|
: []
|
||||||
|
): Promise<RageFW_CefReturn<EventName>> {
|
||||||
|
return rpc.callBrowsers(player, eventName, args)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export const fw = {
|
export const fw = {
|
||||||
@@ -124,3 +148,7 @@ export const fw = {
|
|||||||
log: new Logger(),
|
log: new Logger(),
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fw.system.log.info(
|
||||||
|
'Working on Rage Framework. RageFW © Powered by Entity Seven Group',
|
||||||
|
)
|
||||||
|
|||||||
@@ -0,0 +1,18 @@
|
|||||||
|
import type { RageFW_ICustomCefEvent } from 'rage-fw-shared-types'
|
||||||
|
|
||||||
|
export type RageFW_CefEvent = keyof RageFW_ICustomCefEvent
|
||||||
|
|
||||||
|
export type RageFW_CefArgs<K extends RageFW_CefEvent> = Parameters<
|
||||||
|
RageFW_ICustomCefEvent[K]
|
||||||
|
>
|
||||||
|
|
||||||
|
export type RageFW_CefReturn<K extends RageFW_CefEvent> = ReturnType<
|
||||||
|
RageFW_ICustomCefEvent[K]
|
||||||
|
>
|
||||||
|
|
||||||
|
export type _CefEventHasArgs<EventName extends keyof RageFW_ICustomCefEvent> =
|
||||||
|
keyof RageFW_ICustomCefEvent extends never
|
||||||
|
? false
|
||||||
|
: Parameters<RageFW_ICustomCefEvent[EventName]>[0] extends undefined
|
||||||
|
? false
|
||||||
|
: true
|
||||||
@@ -2,14 +2,34 @@
|
|||||||
|
|
||||||
import type { RageFW_ICustomClientEvent } from 'rage-fw-shared-types'
|
import type { RageFW_ICustomClientEvent } from 'rage-fw-shared-types'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Union of all available client event names
|
||||||
|
* These only include custom events
|
||||||
|
*/
|
||||||
export type RageFW_ClientEvent = keyof RageFW_ICustomClientEvent
|
export type RageFW_ClientEvent = keyof RageFW_ICustomClientEvent
|
||||||
|
|
||||||
export type RageFW_ClientEventArguments<K extends RageFW_ClientEvent> =
|
/**
|
||||||
|
* Array of arguments of an event you pass as a generic
|
||||||
|
* These only include custom events
|
||||||
|
*/
|
||||||
|
export type RageFW_ServerClientEventArguments<K extends RageFW_ClientEvent> =
|
||||||
K extends RageFW_ClientEvent
|
K extends RageFW_ClientEvent
|
||||||
? Parameters<RageFW_ICustomClientEvent[K]>
|
? Parameters<RageFW_ICustomClientEvent[K]>
|
||||||
: never
|
: never
|
||||||
|
|
||||||
export type RageFW_ClientEventReturn<K extends RageFW_ClientEvent> =
|
/**
|
||||||
|
* Return type of event you pass as a generic
|
||||||
|
* These only include custom events
|
||||||
|
*/
|
||||||
|
export type RageFW_ServerClientEventReturn<K extends RageFW_ClientEvent> =
|
||||||
K extends RageFW_ClientEvent
|
K extends RageFW_ClientEvent
|
||||||
? ReturnType<RageFW_ICustomClientEvent[K]>
|
? ReturnType<RageFW_ICustomClientEvent[K]>
|
||||||
: never
|
: never
|
||||||
|
|
||||||
|
export type _ClientEventHasArgs<
|
||||||
|
EventName extends keyof RageFW_ICustomClientEvent,
|
||||||
|
> = keyof RageFW_ICustomClientEvent extends never
|
||||||
|
? false
|
||||||
|
: Parameters<RageFW_ICustomClientEvent[EventName]>[0] extends undefined
|
||||||
|
? false
|
||||||
|
: true
|
||||||
|
|||||||
@@ -1,2 +1,3 @@
|
|||||||
export * from './client'
|
export * from './client'
|
||||||
export * from './server'
|
export * from './server'
|
||||||
|
export * from './browser'
|
||||||
|
|||||||
@@ -1,19 +1,34 @@
|
|||||||
/// <reference types="@ragempcommunity/types-server" />
|
/// <reference types="@ragempcommunity/types-server" />
|
||||||
|
|
||||||
import type { RageFW_ICustomServerEvent } from 'rage-fw-shared-types'
|
import type {
|
||||||
|
RageFW_ICustomClientEvent,
|
||||||
|
RageFW_ICustomServerEvent,
|
||||||
|
} from 'rage-fw-shared-types'
|
||||||
export type { RageFW_ICustomServerEvent } from 'rage-fw-shared-types'
|
export type { RageFW_ICustomServerEvent } from 'rage-fw-shared-types'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Union of all available server event names
|
||||||
|
* These also include system events
|
||||||
|
*/
|
||||||
export type RageFW_ServerEvent =
|
export type RageFW_ServerEvent =
|
||||||
| keyof RageFW_ICustomServerEvent
|
| keyof RageFW_ICustomServerEvent
|
||||||
| keyof IServerEvents
|
| keyof IServerEvents
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Array of arguments for an event, name of which you pass as a generic
|
||||||
|
* These also include system events
|
||||||
|
*/
|
||||||
export type RageFW_ServerEventArguments<K extends RageFW_ServerEvent> =
|
export type RageFW_ServerEventArguments<K extends RageFW_ServerEvent> =
|
||||||
K extends keyof RageFW_ICustomServerEvent
|
K extends keyof RageFW_ICustomServerEvent
|
||||||
? Parameters<RageFW_ServerEventCallbackCustom<K>>
|
? Parameters<RageFW_ICustomServerEvent[K]>
|
||||||
: K extends keyof IServerEvents
|
: K extends keyof IServerEvents
|
||||||
? Parameters<RageFW_ServerEventCallbackNative<K>>
|
? Parameters<IServerEvents[K]>
|
||||||
: never
|
: never
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Callback (function) for an event, name of which you pass as a generic
|
||||||
|
* These include system and custom events
|
||||||
|
*/
|
||||||
export type RageFW_ServerEventCallback<K extends RageFW_ServerEvent> =
|
export type RageFW_ServerEventCallback<K extends RageFW_ServerEvent> =
|
||||||
K extends keyof RageFW_ICustomServerEvent
|
K extends keyof RageFW_ICustomServerEvent
|
||||||
? RageFW_ServerEventCallbackCustom<K>
|
? RageFW_ServerEventCallbackCustom<K>
|
||||||
@@ -21,6 +36,10 @@ export type RageFW_ServerEventCallback<K extends RageFW_ServerEvent> =
|
|||||||
? RageFW_ServerEventCallbackNative<K>
|
? RageFW_ServerEventCallbackNative<K>
|
||||||
: never
|
: never
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return type for an event, name of which you pass as a generic
|
||||||
|
* These include system and custom events
|
||||||
|
*/
|
||||||
export type RageFW_ServerEventReturn<K extends RageFW_ServerEvent> =
|
export type RageFW_ServerEventReturn<K extends RageFW_ServerEvent> =
|
||||||
K extends keyof RageFW_ICustomServerEvent
|
K extends keyof RageFW_ICustomServerEvent
|
||||||
? ReturnType<RageFW_ICustomServerEvent[K]>
|
? ReturnType<RageFW_ICustomServerEvent[K]>
|
||||||
@@ -28,13 +47,28 @@ export type RageFW_ServerEventReturn<K extends RageFW_ServerEvent> =
|
|||||||
? ReturnType<IServerEvents[K]>
|
? ReturnType<IServerEvents[K]>
|
||||||
: never
|
: never
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Array of arguments for an event, name of which you pass as a generic
|
||||||
|
* These only include custom events
|
||||||
|
*/
|
||||||
export type RageFW_ServerEventCallbackCustom<
|
export type RageFW_ServerEventCallbackCustom<
|
||||||
K extends keyof RageFW_ICustomServerEvent = keyof RageFW_ICustomServerEvent,
|
K extends keyof RageFW_ICustomServerEvent = keyof RageFW_ICustomServerEvent,
|
||||||
> = (
|
> = (
|
||||||
player: PlayerMp,
|
payload: [player: PlayerMp, ...args: RageFW_ServerEventArguments<K>],
|
||||||
args: RageFW_ServerEventArguments<K>,
|
|
||||||
) => RageFW_ServerEventReturn<K>
|
) => RageFW_ServerEventReturn<K>
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Array of arguments for an event, name of which you pass as a generic
|
||||||
|
* These only include system events
|
||||||
|
*/
|
||||||
export type RageFW_ServerEventCallbackNative<
|
export type RageFW_ServerEventCallbackNative<
|
||||||
K extends keyof IServerEvents = keyof IServerEvents,
|
K extends keyof IServerEvents = keyof IServerEvents,
|
||||||
> = IServerEvents[K]
|
> = (payload: Parameters<IServerEvents[K]>) => ReturnType<IServerEvents[K]>
|
||||||
|
|
||||||
|
export type _ServerEventHasArgs<
|
||||||
|
EventName extends keyof RageFW_ICustomServerEvent,
|
||||||
|
> = keyof RageFW_ICustomClientEvent extends never
|
||||||
|
? false
|
||||||
|
: Parameters<RageFW_ICustomServerEvent[EventName]>[0] extends undefined
|
||||||
|
? false
|
||||||
|
: true
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "rage-fw-shared-types",
|
"name": "rage-fw-shared-types",
|
||||||
"version": "0.0.16-alpha.0",
|
"version": "0.0.22-alpha.0",
|
||||||
"types": "types/types/index.d.ts",
|
"types": "types/types/index.d.ts",
|
||||||
"files": [
|
"files": [
|
||||||
"types/**/*"
|
"types/**/*"
|
||||||
|
|||||||
Reference in New Issue
Block a user