Compare commits

...
Author SHA1 Message Date
Oleksandr Honcharov 97b094c3d4 v0.0.16-alpha.0 2024-06-11 20:29:42 +03:00
Oleksandr Honcharov acd7ad3406 client / server ragempcommunity types peerDependency 2024-06-11 20:29:07 +03:00
Oleksandr Honcharov 0a81acf49e logger functionality 2024-06-11 20:28:57 +03:00
Oleksandr Honcharov 1b2f0d02ef server logger 2024-06-11 20:27:54 +03:00
Oleksandr Honcharov 3bb9256eb8 v0.0.15-alpha.0 2024-06-11 19:12:23 +03:00
Oleksandr Honcharov 23c1e6080a fixes types 2024-06-11 19:12:03 +03:00
Oleksandr Honcharov 33ebdaac84 clear usages 2024-06-11 19:09:19 +03:00
Oleksandr Honcharov 8972fee22e v0.0.14-alpha.0 2024-06-11 19:08:49 +03:00
rilaxik 828d74dad9 eslint 2024-06-11 16:25:41 +01:00
rilaxik e1450397ab split types in server/client files 2024-06-11 16:02:53 +01:00
rilaxik 3f48215eb1 resolved types 2024-06-11 15:14:20 +01:00
rilaxik 5205a9e245 resolved types 2024-06-11 14:45:47 +01:00
rilaxik 4695f5dbd1 types 2024-06-11 02:57:19 +01:00
rilaxik fa4c218a7a Merge remote-tracking branch 'origin/master'
# Conflicts:
#	server/src/index.ts
#	server/src/types.ts
2024-06-11 02:50:29 +01:00
rilaxik 454fc12d2e types 2024-06-11 02:49:56 +01:00
Oleksandr Honcharov 2da34bd382 temp 2024-06-11 03:38:31 +03:00
20 changed files with 1223 additions and 107 deletions
+31
View File
@@ -0,0 +1,31 @@
env:
node: true
es6: true
es2019: true
extends:
- 'eslint:recommended'
- 'plugin:@typescript-eslint/recommended'
# - 'prettier'
parser: '@typescript-eslint/parser'
parserOptions:
ecmaVersion: '2019'
sourceType: 'script'
plugins:
- '@typescript-eslint'
ignorePatterns:
- 'node_modules'
rules: {
'@typescript-eslint/no-explicit-any': 'off',
'@typescript-eslint/no-unused-vars': [
'warn',
{
"argsIgnorePattern": '^_',
"varsIgnorePattern": '^_',
"caughtErrorsIgnorePattern": '^_'
}
],
'@typescript-eslint/ban-ts-comment': 'off',
'@typescript-eslint/ban-types': 'off',
'consistent-return': 'warn',
'no-empty': 'off',
}
+5 -3
View File
@@ -1,8 +1,8 @@
{
"name": "rage-fw-client",
"version": "0.0.13-alpha.0",
"version": "0.0.16-alpha.0",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"types": "dist/src/index.d.ts",
"files": [
"dist/**/*"
],
@@ -10,10 +10,12 @@
"build": "tsup"
},
"dependencies": {
"@ragempcommunity/types-client": "^2.1.8",
"rage-fw-shared-types": "workspace:^",
"rage-rpc": "^0.4.0"
},
"peerDependencies": {
"@ragempcommunity/types-client": "^2.1.8"
},
"keywords": [],
"author": "SashaGoncharov19",
"license": "MIT",
+12 -11
View File
@@ -1,29 +1,30 @@
import rpc from 'rage-rpc'
import {
RageFW_ClientEventReturn,
import type {
RageFW_ClientEventCallback,
RageFW_ClientEvent,
RageFW_ClientEventArguments,
RageFW_ClientServerCallback,
RageFW_ClientServerEvent,
RageFW_ClientServerEventArguments,
RageFW_ClientServerEventReturn,
} from './types'
class Client {
public register<EventName extends RageFW_ClientServerEvent>(
public register<EventName extends RageFW_ClientEvent>(
eventName: EventName,
callback: RageFW_ClientServerCallback<EventName>,
callback: RageFW_ClientEventCallback<EventName>,
): void {
rpc.register(eventName, data => {
return callback(...data)
return callback(data)
})
}
}
class Player {
public triggerServer<EventName extends RageFW_ClientEvent>(
public triggerServer<EventName extends RageFW_ClientServerEvent>(
eventName: EventName,
...args: RageFW_ClientEventArguments<EventName>
): Promise<RageFW_ClientEventReturn<EventName>> {
return rpc.callServer(eventName, ...args)
args: RageFW_ClientServerEventArguments<EventName>,
): Promise<RageFW_ClientServerEventReturn<EventName>> {
return rpc.callServer(eventName, args)
}
}
-24
View File
@@ -1,24 +0,0 @@
/// <reference types="@ragempcommunity/types-client" />
import type {
RageFW_ICustomClientEvent,
RageFW_ICustomServerEvent,
} from 'rage-fw-shared-types'
export type RageFW_ClientEvent = keyof RageFW_ICustomServerEvent
export type RageFW_ClientEventArguments<K extends RageFW_ClientEvent> =
K extends keyof RageFW_ICustomServerEvent
? Parameters<RageFW_ICustomServerEvent[K]>
: never
export type RageFW_ClientEventReturn<K extends RageFW_ClientEvent> =
K extends keyof RageFW_ICustomClientEvent
? ReturnType<RageFW_ICustomClientEvent[K]>
: never
export type RageFW_ClientServerEvent = keyof RageFW_ICustomClientEvent
export type RageFW_ClientServerCallback<K extends RageFW_ClientServerEvent> = (
...args: Parameters<RageFW_ICustomClientEvent[K]>
) => ReturnType<RageFW_ICustomClientEvent[K]>
+14
View File
@@ -0,0 +1,14 @@
/// <reference types="@ragempcommunity/types-client" />
import type { RageFW_ICustomClientEvent } from 'rage-fw-shared-types'
export type RageFW_ClientEvent = keyof RageFW_ICustomClientEvent
export type RageFW_ClientEventCallback<K extends RageFW_ClientEvent> = (
args: Parameters<RageFW_ICustomClientEvent[K]>,
) => RageFW_ClientEventReturn<K>
export type RageFW_ClientEventReturn<K extends RageFW_ClientEvent> =
K extends keyof RageFW_ICustomClientEvent
? ReturnType<RageFW_ICustomClientEvent[K]>
: never
+2
View File
@@ -0,0 +1,2 @@
export * from './client'
export * from './server'
+16
View File
@@ -0,0 +1,16 @@
/// <reference types="@ragempcommunity/types-client" />
import type { RageFW_ICustomServerEvent } from 'rage-fw-shared-types'
export type RageFW_ClientServerEvent = keyof RageFW_ICustomServerEvent
export type RageFW_ClientServerEventArguments<
K extends RageFW_ClientServerEvent,
> = K extends keyof RageFW_ICustomServerEvent
? Parameters<RageFW_ICustomServerEvent[K]>
: never
export type RageFW_ClientServerEventReturn<K extends RageFW_ClientServerEvent> =
K extends keyof RageFW_ICustomServerEvent
? ReturnType<RageFW_ICustomServerEvent[K]>
: never
+1 -1
View File
@@ -5,7 +5,7 @@ export default defineConfig({
outDir: './dist',
format: ['cjs'],
noExternal: ['rage-rpc'],
dts: true,
experimentalDts: true,
splitting: false,
sourcemap: false,
clean: true,
+1 -1
View File
@@ -1,5 +1,5 @@
{
"$schema": "node_modules/lerna/schemas/lerna-schema.json",
"version": "0.0.13-alpha.0",
"version": "0.0.16-alpha.0",
"npmClient": "pnpm"
}
+9 -4
View File
@@ -2,18 +2,23 @@
"private": true,
"scripts": {
"publish": "pnpm build && lerna publish --force-publish",
"build": "lerna run build"
"build": "lerna run build",
"lint": "eslint --c .eslintrc.yaml --ext .ts client/ server/ shared-types/"
},
"dependencies": {
"@microsoft/api-extractor": "^7.47.0",
"@ragempcommunity/types-cef": "^2.1.8",
"@ragempcommunity/types-client": "^2.1.8",
"@ragempcommunity/types-server": "^2.1.8",
"@microsoft/api-extractor": "^7.47.0",
"tsup": "^8.1.0",
"@typescript-eslint/eslint-plugin": "^7.13.0",
"@typescript-eslint/parser": "^7.13.0",
"eslint": "^8.56.0",
"lerna": "^8.1.3",
"prettier": "^3.3.1",
"rage-rpc": "^0.4.0",
"typescript": "^5.4.5"
"tsup": "^8.1.0",
"typescript": "^5.4.5",
"winston": "^3.13.0"
},
"type": "module"
}
+985 -6
View File
File diff suppressed because it is too large Load Diff
+4 -2
View File
@@ -1,6 +1,6 @@
{
"name": "rage-fw-server",
"version": "0.0.13-alpha.0",
"version": "0.0.16-alpha.0",
"main": "dist/index.js",
"types": "dist/src/index.d.ts",
"files": [
@@ -10,10 +10,12 @@
"build": "tsup"
},
"dependencies": {
"@ragempcommunity/types-server": "^2.1.8",
"rage-fw-shared-types": "workspace:^",
"rage-rpc": "^0.4.0"
},
"peerDependencies": {
"@ragempcommunity/types-server": "^2.1.8"
},
"keywords": [],
"author": "SashaGoncharov19",
"license": "MIT",
+62 -20
View File
@@ -1,42 +1,81 @@
import rpc from 'rage-rpc'
import {
import Logger from './logger'
import type {
RageFW_ClientEvent,
RageFW_ClientEventArguments,
RageFW_ClientEventReturn,
RageFW_ICustomServerEvent,
RageFW_ServerEvent,
RageFW_ServerEventCallback,
} from './types.js'
RageFW_ServerEventCallbackCustom,
RageFW_ServerEventCallbackNative,
} from './types'
import { nativeEvents } from './native.events'
class Server {
private isNativeEvent(eventName: string): eventName is keyof IServerEvents {
return nativeEvents.includes(eventName)
}
private registerCustom<EventName extends keyof RageFW_ICustomServerEvent>(
eventName: EventName,
callback: RageFW_ServerEventCallbackCustom<EventName>,
): void {
rpc.register(
eventName,
async (
args: Parameters<RageFW_ICustomServerEvent[EventName]>,
info,
) => {
callback(info.player as PlayerMp, args)
},
)
}
private registerNative<EventName extends keyof IServerEvents>(
eventName: EventName,
callback: RageFW_ServerEventCallbackNative<EventName>,
): void {
mp.events.add(eventName, callback)
}
public register<EventName extends RageFW_ServerEvent>(
eventName: EventName,
callback: RageFW_ServerEventCallback<EventName>,
): void {
if (nativeEvents.includes(eventName)) {
mp.events.add(eventName, callback)
if (this.isNativeEvent(eventName)) {
this.registerNative(
eventName,
callback as RageFW_ServerEventCallbackNative,
)
} else {
rpc.register(eventName, callback as rpc.ProcedureListener)
this.registerCustom(
eventName,
callback as unknown as RageFW_ServerEventCallbackCustom,
)
}
}
public registerMany<EventName extends RageFW_ServerEvent>(events: {
[event in EventName]: RageFW_ServerEventCallback<event>
}): void {
Object.entries(events).map(([eventName, callback]) => {
if (nativeEvents.includes(eventName)) {
mp.events.add(
eventName as keyof IServerEvents,
callback as (...arg: unknown[]) => void,
)
} else {
rpc.register(eventName, (args: unknown[]) => {
return Array.isArray(args)
? (callback as (...arg: typeof args) => void)(...args)
: (callback as (arg: typeof args) => void)(args)
})
}
})
Object.entries<RageFW_ServerEventCallback<EventName>>(events).map(
([eventName, callback]) => {
if (this.isNativeEvent(eventName)) {
this.registerNative(
eventName,
callback as RageFW_ServerEventCallbackNative,
)
} else {
this.registerCustom(
eventName as keyof RageFW_ICustomServerEvent,
callback as unknown as RageFW_ServerEventCallbackCustom,
)
}
},
)
}
}
@@ -44,7 +83,7 @@ class Player {
public triggerClient<EventName extends RageFW_ClientEvent>(
player: PlayerMp,
eventName: EventName,
...args: RageFW_ClientEventArguments<EventName>
args: RageFW_ClientEventArguments<EventName>,
): Promise<RageFW_ClientEventReturn<EventName>> {
return rpc.callClient(player, eventName, args)
}
@@ -53,4 +92,7 @@ class Player {
export const fw = {
event: new Server(),
player: new Player(),
system: {
log: new Logger(),
},
}
+36
View File
@@ -0,0 +1,36 @@
import winston, { format } from 'winston'
const { timestamp, printf, colorize } = format
export default class Logger {
private format = printf(({ message, level, timestamp }) => {
return `[${new Date(timestamp).toLocaleTimeString()}] [${level}]: ${message}`
})
private systemLogger = winston.createLogger({
transports: [new winston.transports.Console()],
format: format.combine(
colorize({
level: true,
colors: {
error: 'red',
warn: 'yellow',
info: 'white',
},
}),
timestamp(),
this.format,
),
})
public info(message: unknown) {
this.systemLogger.info(message)
}
public warn(message: unknown) {
this.systemLogger.warn(message)
}
public error(message: unknown) {
this.systemLogger.error(message)
}
}
-33
View File
@@ -1,33 +0,0 @@
/// <reference types="@ragempcommunity/types-server" />
import type {
RageFW_ICustomServerEvent,
RageFW_ICustomClientEvent,
} from 'rage-fw-shared-types'
export type RageFW_ServerEvent =
| keyof RageFW_ICustomServerEvent
| keyof IServerEvents
export type RageFW_ServerEventCallback<
K extends keyof RageFW_ICustomServerEvent | keyof IServerEvents,
> = K extends keyof RageFW_ICustomServerEvent
? (
player: PlayerMp,
...args: Parameters<RageFW_ICustomServerEvent[K]>
) => ReturnType<RageFW_ICustomServerEvent[K]>
: K extends keyof IServerEvents
? ThisifyServerEvents[K]
: never
export type RageFW_ClientEvent = keyof RageFW_ICustomClientEvent
export type RageFW_ClientEventArguments<K extends RageFW_ClientEvent> =
K extends RageFW_ClientEvent
? Parameters<RageFW_ICustomClientEvent[K]>
: never
export type RageFW_ClientEventReturn<K extends RageFW_ClientEvent> =
K extends RageFW_ClientEvent
? ReturnType<RageFW_ICustomClientEvent[K]>
: never
+15
View File
@@ -0,0 +1,15 @@
/// <reference types="@ragempcommunity/types-server" />
import type { RageFW_ICustomClientEvent } from 'rage-fw-shared-types'
export type RageFW_ClientEvent = keyof RageFW_ICustomClientEvent
export type RageFW_ClientEventArguments<K extends RageFW_ClientEvent> =
K extends RageFW_ClientEvent
? Parameters<RageFW_ICustomClientEvent[K]>
: never
export type RageFW_ClientEventReturn<K extends RageFW_ClientEvent> =
K extends RageFW_ClientEvent
? ReturnType<RageFW_ICustomClientEvent[K]>
: never
+2
View File
@@ -0,0 +1,2 @@
export * from './client'
export * from './server'
+26
View File
@@ -0,0 +1,26 @@
/// <reference types="@ragempcommunity/types-server" />
import type { RageFW_ICustomServerEvent } from 'rage-fw-shared-types'
export type { RageFW_ICustomServerEvent } from 'rage-fw-shared-types'
export type RageFW_ServerEvent =
| keyof RageFW_ICustomServerEvent
| keyof IServerEvents
export type RageFW_ServerEventCallbackCustom<
K extends keyof RageFW_ICustomServerEvent = keyof RageFW_ICustomServerEvent,
> = (
player: PlayerMp,
args: Parameters<RageFW_ICustomServerEvent[K]>,
) => ReturnType<RageFW_ICustomServerEvent[K]>
export type RageFW_ServerEventCallbackNative<
K extends keyof IServerEvents = keyof IServerEvents,
> = IServerEvents[K]
export type RageFW_ServerEventCallback<K extends RageFW_ServerEvent> =
K extends keyof RageFW_ICustomServerEvent
? RageFW_ServerEventCallbackCustom<K>
: K extends keyof IServerEvents
? RageFW_ServerEventCallbackNative<K>
: never
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "rage-fw-shared-types",
"version": "0.0.13-alpha.0",
"version": "0.0.16-alpha.0",
"types": "types/types/index.d.ts",
"files": [
"types/**/*"
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "rage-fw-shared",
"version": "0.0.13-alpha.0",
"version": "0.0.16-alpha.0",
"type": "module",
"main": "index.d.ts",
"files": [