v0.0.18-alpha.0

cef/package.json

@@ -0,0 +1,23 @@
+{
+    "name": "rage-fw-cef",
+    "version": "0.0.18-alpha.0",
+    "main": "dist/index.js",
+    "types": "dist/src/index.d.ts",
+    "files": [
+        "dist/**/*"
+    ],
+    "scripts": {
+        "build": "tsup"
+    },
+    "dependencies": {
+        "rage-rpc": "^0.4.0"
+    },
+    "peerDependencies": {
+        "@ragempcommunity/types-cef": "^2.1.8",
+        "rage-fw-shared-types": "workspace:^"
+    },
+    "keywords": [],
+    "author": "SashaGoncharov19",
+    "license": "MIT",
+    "description": "CEF side for rage-fw"
+}

cef/src/index.ts

@@ -0,0 +1,48 @@
+import rpc from 'rage-rpc'
+
+import {
+    RageFW_CefArguments,
+    RageFW_CefCallback,
+    RageFW_CefReturn,
+    RageFW_ClientArguments,
+    RageFW_ClientReturn,
+    RageFW_ServerArguments,
+    RageFW_ServerReturn,
+    RageFW_ICustomCefEvent,
+    RageFW_ICustomClientEvent,
+    RageFW_ICustomServerEvent,
+} from './types'
+
+class Cef {
+    public register<EventName extends keyof RageFW_ICustomCefEvent>(
+        eventName: EventName,
+        callback: RageFW_CefCallback<EventName>,
+    ): void {
+        rpc.register(eventName, callback)
+    }
+
+    public trigger<EventName extends keyof RageFW_ICustomCefEvent>(
+        eventName: EventName,
+        args: RageFW_CefArguments<EventName>,
+    ): Promise<RageFW_CefReturn<EventName>> {
+        return rpc.call(eventName, args)
+    }
+
+    public triggerServer<EventName extends keyof RageFW_ICustomServerEvent>(
+        eventName: EventName,
+        args: RageFW_ServerArguments<EventName>,
+    ): Promise<RageFW_ServerReturn<EventName>> {
+        return rpc.callServer(eventName, args)
+    }
+
+    public triggerClient<EventName extends keyof RageFW_ICustomClientEvent>(
+        eventName: EventName,
+        args: RageFW_ClientArguments<EventName>,
+    ): Promise<RageFW_ClientReturn<EventName>> {
+        return rpc.callClient(eventName, args)
+    }
+}
+
+export const fw = {
+    event: new Cef(),
+}

cef/src/types/index.ts

@@ -0,0 +1,87 @@
+/// <reference types="@ragempcommunity/types-cef" />
+
+import type {
+    RageFW_ICustomCefEvent,
+    RageFW_ICustomClientEvent,
+    RageFW_ICustomServerEvent,
+} from 'rage-fw-shared-types'
+
+export type {
+    RageFW_ICustomCefEvent,
+    RageFW_ICustomServerEvent,
+    RageFW_ICustomClientEvent,
+} from 'rage-fw-shared-types'
+
+/**
+ * Union of all available cef event names
+ * These only include custom events
+ */
+export type RageFW_CefEvent = keyof RageFW_ICustomCefEvent
+
+/**
+ * Union of all available server event names
+ * These only include custom events
+ */
+export type RageFW_ServerEvent = keyof RageFW_ICustomServerEvent
+
+/**
+ * Union of all available client event names
+ * These only include custom events
+ */
+export type RageFW_ClientEvent = keyof RageFW_ICustomClientEvent
+
+/**
+ * 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>
+
+/**
+ * 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]
+>
+
+/**
+ * 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]
+>

cef/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Base",
+  "exclude": [
+    "node_modules"
+  ],
+  "compilerOptions": {
+    "incremental": false,
+    "composite": false,
+    "target": "ES2022",
+    "experimentalDecorators": true,
+    "moduleDetection": "auto",
+    "module": "CommonJS",
+    "resolveJsonModule": true,
+    "declaration": false,
+    "declarationMap": false,
+    "sourceMap": false,
+    "downlevelIteration": false,
+    "inlineSourceMap": false,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true
+  }
+}

cef/tsup.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from 'tsup'
+
+export default defineConfig({
+    entry: ['src/index.ts'],
+    outDir: './dist',
+    format: ['cjs'],
+    noExternal: ['rage-rpc'],
+    experimentalDts: true,
+    splitting: false,
+    sourcemap: false,
+    clean: true,
+})

client/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rage-fw-client",
-    "version": "0.0.15-alpha.0",
+    "version": "0.0.18-alpha.0",
     "main": "dist/index.js",
     "types": "dist/src/index.d.ts",
     "files": [
@@ -10,11 +10,11 @@
         "build": "tsup"
     },
     "dependencies": {
-        "rage-fw-shared-types": "workspace:^",
         "rage-rpc": "^0.4.0"
     },
     "peerDependencies": {
-        "@ragempcommunity/types-client": "^2.1.8"
+        "@ragempcommunity/types-client": "^2.1.8",
+        "rage-fw-shared-types": "workspace:^"
     },
     "keywords": [],
     "author": "SashaGoncharov19",

client/src/index.ts

@@ -1,12 +1,17 @@
 import rpc from 'rage-rpc'
 
-import type {
+import Logger from './logger'
+
+import {
     RageFW_ClientEventCallback,
     RageFW_ClientEvent,
     RageFW_ClientServerEvent,
     RageFW_ClientServerEventArguments,
     RageFW_ClientServerEventReturn,
+    RageFW_ClientEventArguments,
+    RageFW_ClientEventReturn,
 } from './types'
+import type { RageFW_ICustomClientEvent } from 'rage-fw-shared-types'
 
 class Client {
     public register<EventName extends RageFW_ClientEvent>(
@@ -17,6 +22,19 @@ class Client {
             return callback(data)
         })
     }
+
+    public unregister<EventName extends RageFW_ClientEvent>(
+        eventName: EventName,
+    ): void {
+        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 {
@@ -31,4 +49,7 @@ class Player {
 export const fw = {
     event: new Client(),
     player: new Player(),
+    system: {
+        log: new Logger(),
+    },
 }

client/src/logger.ts

@@ -0,0 +1,19 @@
+export default class Logger {
+    public error(message: unknown) {
+        mp.console.logError(
+            `[${new Date().toLocaleTimeString()}] [ERROR] ${message}`,
+        )
+    }
+
+    public warn(message: unknown) {
+        mp.console.logWarning(
+            `[${new Date().toLocaleTimeString()}] [WARN] ${message}`,
+        )
+    }
+
+    public info(message: unknown) {
+        mp.console.logInfo(
+            `[${new Date().toLocaleTimeString()}] [INFO] ${message}`,
+        )
+    }
+}

client/src/types/client.ts

@@ -2,12 +2,31 @@
 
 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
 
+/**
+ * Array of arguments for an event, name of which you pass as a generic
+ * These only include custom events
+ */
+export type RageFW_ClientEventArguments<K extends RageFW_ClientEvent> =
+    Parameters<RageFW_ICustomClientEvent[K]>
+
+/**
+ * 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> = (
-    args: Parameters<RageFW_ICustomClientEvent[K]>,
+    args: RageFW_ClientEventArguments<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> =
     K extends keyof RageFW_ICustomClientEvent
         ? ReturnType<RageFW_ICustomClientEvent[K]>

client/src/types/server.ts

@@ -2,14 +2,26 @@
 
 import type { 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
 
+/**
+ * Array of arguments for an event, name of which you pass as a generic
+ * These only include custom events
+ */
 export type RageFW_ClientServerEventArguments<
     K extends RageFW_ClientServerEvent,
 > = 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 RageFW_ClientServerEventReturn<K extends RageFW_ClientServerEvent> =
     K extends keyof RageFW_ICustomServerEvent
         ? ReturnType<RageFW_ICustomServerEvent[K]>

client/tsconfig.json

@@ -9,7 +9,6 @@
     "composite": false,
     "target": "ES2022",
     "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
     "moduleDetection": "auto",
     "module": "CommonJS",
     "resolveJsonModule": true,

lerna.json

@@ -1,5 +1,5 @@
 {
     "$schema": "node_modules/lerna/schemas/lerna-schema.json",
-    "version": "0.0.15-alpha.0",
+    "version": "0.0.18-alpha.0",
     "npmClient": "pnpm"
 }

pnpm-workspace.yaml

@@ -1,5 +1,5 @@
 packages:
   - "server"
   - "client"
-  - "shared"
+  - "cef"
   - "shared-types"

readme.md

@@ -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*

server/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rage-fw-server",
-    "version": "0.0.15-alpha.0",
+    "version": "0.0.18-alpha.0",
     "main": "dist/index.js",
     "types": "dist/src/index.d.ts",
     "files": [
@@ -10,11 +10,11 @@
         "build": "tsup"
     },
     "dependencies": {
-        "rage-fw-shared-types": "workspace:^",
         "rage-rpc": "^0.4.0"
     },
     "peerDependencies": {
-        "@ragempcommunity/types-server": "^2.1.8"
+        "@ragempcommunity/types-server": "^2.1.8",
+        "rage-fw-shared-types": "workspace:^"
     },
     "keywords": [],
     "author": "SashaGoncharov19",

server/src/index.ts

@@ -2,15 +2,17 @@ import rpc from 'rage-rpc'
 
 import Logger from './logger'
 
-import type {
+import {
     RageFW_ClientEvent,
     RageFW_ClientEventArguments,
     RageFW_ClientEventReturn,
     RageFW_ICustomServerEvent,
     RageFW_ServerEvent,
+    RageFW_ServerEventArguments,
     RageFW_ServerEventCallback,
     RageFW_ServerEventCallbackCustom,
     RageFW_ServerEventCallbackNative,
+    RageFW_ServerEventReturn,
 } from './types'
 import { nativeEvents } from './native.events'
 
@@ -25,10 +27,7 @@ class Server {
     ): void {
         rpc.register(
             eventName,
-            async (
-                args: Parameters<RageFW_ICustomServerEvent[EventName]>,
-                info,
-            ) => {
+            async (args: RageFW_ServerEventArguments<EventName>, info) => {
                 callback(info.player as PlayerMp, args)
             },
         )
@@ -77,6 +76,35 @@ class Server {
             },
         )
     }
+
+    private unregisterCustom<EventName extends keyof RageFW_ICustomServerEvent>(
+        eventName: EventName,
+    ): void {
+        rpc.unregister(eventName)
+    }
+
+    private unregisterNative<EventName extends keyof IServerEvents>(
+        eventName: EventName,
+    ): void {
+        mp.events.remove(eventName)
+    }
+
+    public unregister<EventName extends RageFW_ServerEvent>(
+        eventName: EventName,
+    ): void {
+        if (this.isNativeEvent(eventName)) {
+            this.unregisterNative(eventName)
+        } else {
+            this.unregisterCustom(eventName)
+        }
+    }
+
+    private trigger<EventName extends keyof RageFW_ICustomServerEvent>(
+        eventName: EventName,
+        args: RageFW_ServerEventArguments<EventName>,
+    ): Promise<RageFW_ServerEventReturn<EventName>> {
+        return rpc.call<RageFW_ServerEventReturn<EventName>>(eventName, args)
+    }
 }
 
 class Player {

server/src/types/client.ts

@@ -2,13 +2,25 @@
 
 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
 
+/**
+ * Array of arguments of an event you pass as a generic
+ * These only include custom events
+ */
 export type RageFW_ClientEventArguments<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 RageFW_ClientEventReturn<K extends RageFW_ClientEvent> =
     K extends RageFW_ClientEvent
         ? ReturnType<RageFW_ICustomClientEvent[K]>

server/src/types/server.ts

@@ -3,24 +3,62 @@
 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 also include system events
+ */
 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]
+/**
+ * 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> =
+    K extends keyof RageFW_ICustomServerEvent
+        ? Parameters<RageFW_ServerEventCallbackCustom<K>>
+        : K extends keyof IServerEvents
+          ? Parameters<RageFW_ServerEventCallbackNative<K>>
+          : 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> =
     K extends keyof RageFW_ICustomServerEvent
         ? RageFW_ServerEventCallbackCustom<K>
         : K extends keyof IServerEvents
           ? RageFW_ServerEventCallbackNative<K>
           : 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> =
+    K extends keyof RageFW_ICustomServerEvent
+        ? ReturnType<RageFW_ICustomServerEvent[K]>
+        : K extends keyof IServerEvents
+          ? ReturnType<IServerEvents[K]>
+          : never
+
+/**
+ * Array of arguments for an event, name of which you pass as a generic
+ * These only include custom events
+ */
+export type RageFW_ServerEventCallbackCustom<
+    K extends keyof RageFW_ICustomServerEvent = keyof RageFW_ICustomServerEvent,
+> = (
+    player: PlayerMp,
+    args: RageFW_ServerEventArguments<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<
+    K extends keyof IServerEvents = keyof IServerEvents,
+> = IServerEvents[K]

shared-types/package.json

@@ -1,6 +1,6 @@
 {
     "name": "rage-fw-shared-types",
-    "version": "0.0.15-alpha.0",
+    "version": "0.0.18-alpha.0",
     "types": "types/types/index.d.ts",
     "files": [
         "types/**/*"

shared-types/types/types/index.d.ts

@@ -2,4 +2,6 @@ declare module 'rage-fw-shared-types' {
     export interface RageFW_ICustomServerEvent {}
 
     export interface RageFW_ICustomClientEvent {}
+
+    export interface RageFW_ICustomCefEvent {}
 }

shared/package.json

@@ -1,17 +0,0 @@
-{
-    "name": "rage-fw-shared",
-    "version": "0.0.15-alpha.0",
-    "type": "module",
-    "main": "index.d.ts",
-    "files": [
-        "index.d.ts"
-    ],
-    "scripts": {
-        "test": "tsup"
-    },
-    "keywords": [],
-    "author": "SashaGoncharov19",
-    "license": "MIT",
-    "description": "Shared client types for rage-fw",
-    "gitHead": "053e4fd12aa120d53e11e0d2009c0df78c1a2ad0"
-}