upd cli

- handled process exit
- updated docs + readme
- typos fix

.gitea/ISSUE_TEMPLATE.yaml

@@ -28,7 +28,7 @@ body:
   - type: textarea
     id: reproduction
     attributes:
-      label: Reproduction (Optional)
+      label: Reproduction
       description: Steps to reproduce the bug, if applicable
     validations:
       required: true
@@ -57,7 +57,7 @@ body:
   - type: textarea
     id: additional_information
     attributes:
-      label: Additional Information
+      label: Additional Information (Optional)
       description: Add any other information that might be useful in diagnosing the issue
     validations:
       required: false

browser/LICENSE

@@ -0,0 +1,15 @@
+Custom Attribution-NoDerivs Software License
+
+Copyright (c) 2024 Entity Seven Group
+
+This license allows you to use, copy, and distribute the RageFW (the "Software"), including for commercial purposes, provided that the following conditions are met:
+
+1. **Attribution:** You must give appropriate credit to the original author of the Software, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
+
+2. **No Derivative Works:** You may not modify, transform, or build upon the Software.
+
+3. **Usage and Commercial Use:** You are allowed to use, sell, and gain income from projects that utilize the Software, as long as you comply with the terms of this license.
+
+4. **No Additional Restrictions:** You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

browser/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@entityseven/rage-fw-browser",
+  "version": "0.2.0",
+  "main": "dist/index.js",
+  "types": "dist/src/index.d.ts",
+  "files": [
+    "dist/**/*",
+    "readme.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup"
+  },
+  "dependencies": {
+    "@entityseven/rage-fw-rpc": "0.2.5"
+  },
+  "peerDependencies": {
+    "@entityseven/rage-fw-shared-types": "0.2.0",
+    "@ragempcommunity/types-cef": "^2.1.8"
+  },
+  "description": "Package used on a browser-side of your Rage:MP Server",
+  "keywords": [
+    "ragefw",
+    "rage-fw",
+    "ragemp",
+    "rage:mp",
+    "rage",
+    "gta5"
+  ],
+  "author": "Entity Seven Group",
+  "contributors": [
+    {
+      "name": "Danya H",
+      "email": "dev.rilaxik@gmail.com",
+      "url": "https://github.com/rilaxik/"
+    },
+    {
+      "name": "Oleksandr Honcharov",
+      "email": "0976053529@ukr.net",
+      "url": "https://github.com/SashaGoncharov19/"
+    }
+  ],
+  "license": "Custom-Attribution-NoDerivs",
+  "gitHead": "ffd542c1deddb3033e16e0dae7557313ae09b05f"
+}

browser/readme.md

@@ -1,2 +1,2 @@
-# RageFW CEF
-[Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki/Docs)
+# RageFW Browser
+[Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki)

browser/src/core/browser.ts

@@ -0,0 +1,187 @@
+import { Helper } from './helper'
+import { rpc } from './rpc'
+import type * as T from '../types'
+import {
+    RageFW_BrowserEvent,
+    RageFW_ClientEvent,
+    RageFW_ServerEvent,
+} from '../types'
+
+/** Browser-side interactions */
+export class Browser extends Helper {
+    constructor() {
+        super()
+    }
+
+    /**
+     * Setter. Enables console debug logs for events
+     */
+    set debugLogs(debug: boolean) {
+        this.debugLogs_ = debug
+    }
+
+    /**
+     * Setter. Provides an ability to specify custom logger function to get special formatting. Using this enables ``debugLogs``
+     */
+    set customLogger(
+        fn: (method: string, eventName: string, ...args: unknown[]) => unknown,
+    ) {
+        this.customLogger_ = fn
+    }
+
+    /**
+     * Registers a browser event with an associated callback
+     *
+     * @param eventName - The name of the event to register
+     * @param callback - The callback function to be executed when the event is triggered
+     * @returns {Browser} The current browser instance, enabling method chaining
+     *
+     * @example
+     * // Registering an event
+     * fw.event.register("showNotification", (message, color) => {
+     *     // do something
+     * })
+     *
+     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+     */
+    public register<EventName extends T.RageFW_BrowserEvent>(
+        eventName: EventName,
+        callback: T.RageFW_BrowserCallback<EventName>,
+    ): Browser {
+        this.log_('register', eventName, callback)
+
+        rpc.register<
+            Parameters<typeof callback>,
+            ReturnType<typeof callback>,
+            EventName
+        >(eventName, async (...data) => await callback(...data))
+
+        return this
+    }
+
+    /**
+     * Unregisters a browser event, removing the associated callback
+     *
+     * @param eventName - The name of the event to unregister
+     * @returns {Browser} The current browser instance, enabling method chaining
+     *
+     * @example
+     * // Unregistering an event
+     * fw.event.unregister("showNotification")
+     *
+     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+     */
+    public unregister<EventName extends T.RageFW_BrowserEvent>(
+        eventName: EventName,
+    ): Browser {
+        rpc.unregister<EventName>(eventName)
+
+        return this
+    }
+
+    /**
+     * Triggers a browser event from the browser with arguments from shared types
+     *
+     * Formerly known as ``call`` or ``emit``
+     *
+     * @param eventName - The name of the browser event to trigger
+     * @param [args] - Arguments for the browser event, if present
+     * @returns {Promise} resolving to the browser's response for the event
+     *
+     * @example
+     * // Triggering a browser event without arguments
+     * fw.event.trigger("browserEventName")
+     *
+     * @example
+     * // Triggering a browser event with arguments
+     * fw.event.trigger("browserEventName", ["message to me"])
+     *
+     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+     */
+    public async trigger<EventName extends T.RageFW_BrowserEvent>(
+        eventName: EventName,
+        ...args: T._BrowserEventHasArgs<EventName> extends true
+            ? [T.RageFW_BrowserArgs<EventName>]
+            : []
+    ): Promise<T.RageFW_BrowserReturn<EventName>> {
+        this.log_('[RPC](trigger):', eventName, ...args)
+
+        return await rpc.call<
+            typeof args,
+            EventName,
+            T.RageFW_BrowserReturn<EventName>
+        >(eventName, args)
+    }
+
+    /**
+     * Triggers a server event from the browser with arguments from shared types
+     *
+     * Formerly known as ``callServer`` or ``emitServer``
+     *
+     * @param eventName - The name of the server event to trigger
+     * @param [args] - Arguments for the server event, if present
+     * @returns {Promise} resolving to the server's response for the event
+     *
+     * @example
+     * // Triggering a server event without arguments
+     * fw.event.triggerServer("serverEventName")
+     *
+     * @example
+     * // Triggering a server event with arguments
+     * fw.event.triggerServer("serverEventName", ["message to server"])
+     *
+     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+     */
+    public async triggerServer<EventName extends T.RageFW_ServerEvent>(
+        eventName: EventName,
+        ...args: T._ServerEventHasArgs<EventName> extends true
+            ? [T.RageFW_ServerArgs<EventName>]
+            : []
+    ): Promise<T.RageFW_ServerReturn<EventName>> {
+        this.log_('[RPC](triggerServer):', eventName, ...args)
+
+        return await rpc.callServer<
+            typeof args,
+            EventName,
+            T.RageFW_ServerReturn<EventName>
+        >(eventName, args)
+    }
+
+    /**
+     * Triggers a client event from the browser with arguments from shared types
+     *
+     * Formerly known as ``callClient`` or ``emitClient``
+     *
+     * @param eventName - The name of the client event to trigger
+     * @param [args] - Arguments for the client event, if present
+     * @returns {Promise} resolving to the client's response for the event
+     *
+     * @example
+     * // Triggering a client event without arguments
+     * fw.event.triggerClient("clientEventName")
+     *
+     * @example
+     * // Triggering a client event with arguments
+     * fw.event.triggerClient("clientEventName", ["message to client"])
+     *
+     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+     */
+    public async triggerClient<EventName extends T.RageFW_ClientEvent>(
+        eventName: EventName,
+        ...args: T._ClientEventHasArgs<EventName> extends true
+            ? [T.RageFW_ClientArgs<EventName>]
+            : []
+    ): Promise<T.RageFW_ClientReturn<EventName>> {
+        this.log_('[RPC](triggerClient):', eventName, ...args)
+
+        return await rpc.callClient<
+            typeof args,
+            EventName,
+            T.RageFW_ClientReturn<EventName>
+        >(eventName, args)
+    }
+}
+
+// new Browser()
+//     .register('customCefEvent', async (a, b) => true)
+//     .triggerServer('customServerEvent', ['', 1])

browser/src/core/helper.ts

@@ -0,0 +1,21 @@
+export class Helper {
+    protected debugLogs_: boolean = false
+    protected customLogger_:
+        | undefined
+        | ((method: string, eventName: string, ...args: unknown[]) => unknown) =
+        undefined
+
+    constructor() {}
+
+    protected log_(
+        method: string,
+        eventName: string,
+        ...args: unknown[]
+    ): void {
+        if (this.customLogger_) {
+            this.customLogger_(method, eventName, ...args)
+        } else if (this.debugLogs_) {
+            console.log('[RPC](' + method + ')', eventName + ':', ...args)
+        }
+    }
+}

browser/src/core/index.ts

@@ -0,0 +1,3 @@
+export * from './browser'
+export * from './helper'
+export * from './rpc'

browser/src/core/rpc.ts

@@ -0,0 +1,6 @@
+import { Rpc } from '@entityseven/rage-fw-rpc'
+
+export const rpc = new Rpc({
+    forceBrowserDevMode: process.env.RageFW_forceBrowserDevMode === 'true',
+    debugLogs: false,
+})

browser/src/index.ts

@@ -0,0 +1,16 @@
+import { Browser, rpc } from './core'
+
+/**
+ * Package used on a browser-side of your Rage:MP Server
+ *
+ * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+ */
+export const fw = {
+    /** Browser-side interactions */
+    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')
+})()

browser/src/types/browser.ts

@@ -0,0 +1,40 @@
+import type { RageFW_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 RageFW_BrowserEvent = keyof RageFW_ICustomBrowserEvent
+
+/**
+ * Array of arguments of an event you pass as a generic
+ * These only include custom browser events
+ */
+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 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 RageFW_BrowserCallback<K extends keyof RageFW_ICustomBrowserEvent> =
+    (...args: RageFW_BrowserArgs<K>) => Promise<RageFW_BrowserReturn<K>>
+
+export type _BrowserEventHasArgs<
+    EventName extends keyof RageFW_ICustomBrowserEvent,
+> = keyof RageFW_ICustomBrowserEvent extends never
+    ? false
+    : Parameters<RageFW_ICustomBrowserEvent[EventName]>[0] extends undefined
+      ? false
+      : true

browser/src/types/client.ts

@@ -1,6 +1,6 @@
-import type { RageFW_ICustomClientEvent } from 'rage-fw-shared-types'
+import type { RageFW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
 
-export type { RageFW_ICustomClientEvent } from 'rage-fw-shared-types'
+export type { RageFW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
 
 /**
  * Union of all available client event names

browser/src/types/index.ts

@@ -1,3 +1,3 @@
-export * from './cef'
+export * from './browser'
 export * from './client'
 export * from './server'

browser/src/types/server.ts

@@ -1,6 +1,6 @@
-import type { RageFW_ICustomServerEvent } from 'rage-fw-shared-types'
+import type { RageFW_ICustomServerEvent } from '@entityseven/rage-fw-shared-types'
 
-export type { RageFW_ICustomServerEvent } from 'rage-fw-shared-types'
+export type { RageFW_ICustomServerEvent } from '@entityseven/rage-fw-shared-types'
 
 /**
  * Union of all available server event names

cef/package.json

@@ -1,29 +0,0 @@
-{
-    "name": "@entityseven/rage-fw-cef",
-    "version": "0.1.0",
-    "main": "dist/index.js",
-    "types": "dist/src/index.d.ts",
-    "files": [
-        "dist/**/*",
-        "readme.md"
-    ],
-    "scripts": {
-        "build": "tsup"
-    },
-    "dependencies": {
-        "rage-fw-rpc": "workspace:^"
-    },
-    "peerDependencies": {
-        "@ragempcommunity/types-cef": "^2.1.8",
-        "rage-fw-shared-types": "workspace:^"
-    },
-    "description": "RageFW CEF side",
-    "keywords": [],
-    "author": "SashaGoncharov19",
-    "contributors": [{
-        "name": "rilaxik",
-        "email": "dev.rilaxik@gmail.com",
-        "url": "https://github.com/rilaxik"
-    }],
-    "license": "MIT"
-}

cef/src/index.ts

@@ -1,113 +0,0 @@
-import { Rpc } from 'rage-fw-rpc'
-
-import type {
-    _CefEventHasArgs,
-    _ClientEventHasArgs,
-    _ServerEventHasArgs,
-    RageFW_CefArgs,
-    RageFW_CefCallback,
-    RageFW_CefReturn,
-    RageFW_ClientArgs,
-    RageFW_ClientReturn,
-    RageFW_ICustomCefEvent,
-    RageFW_ICustomClientEvent,
-    RageFW_ICustomServerEvent,
-    RageFW_ServerArgs,
-    RageFW_ServerReturn,
-} from './types'
-
-class Cef {
-    private _debugMode: boolean = false
-    private _rpc: Rpc = new Rpc()
-
-    constructor() {}
-
-    set debug(debug: boolean) {
-        this._debugMode = debug
-    }
-
-    get rpc(): Rpc {
-        return this._rpc
-    }
-
-    public register<EventName extends keyof RageFW_ICustomCefEvent>(
-        eventName: EventName,
-        callback: RageFW_CefCallback<EventName>,
-    ): void {
-        if (this._debugMode) {
-            console.log('[RPC](register):', eventName, callback)
-        }
-
-        if ('mp' in window) {
-            this._rpc.register(eventName, callback)
-        }
-    }
-
-    public async trigger<EventName extends keyof RageFW_ICustomCefEvent>(
-        eventName: EventName,
-        ...args: _CefEventHasArgs<EventName> extends true
-            ? [RageFW_CefArgs<EventName>]
-            : []
-    ): Promise<RageFW_CefReturn<EventName>> {
-        if (this._debugMode) {
-            console.log('[RPC](trigger):', eventName, ...args)
-        }
-
-        if ('mp' in window) {
-            return await this._rpc.call(eventName, args)
-        }
-
-        return Promise.reject(
-            'RageFW was started in window which does not contain MP',
-        )
-    }
-
-    public async triggerServer<
-        EventName extends keyof RageFW_ICustomServerEvent,
-    >(
-        eventName: EventName,
-        ...args: _ServerEventHasArgs<EventName> extends true
-            ? [RageFW_ServerArgs<EventName>]
-            : []
-    ): Promise<RageFW_ServerReturn<EventName>> {
-        if (this._debugMode) {
-            console.log('[RPC](triggerServer):', eventName, ...args)
-        }
-
-        if ('mp' in window) {
-            return await this._rpc.callServer(eventName, args)
-        }
-
-        return Promise.reject(
-            'RageFW was started in window which does not contain MP',
-        )
-    }
-
-    public async triggerClient<
-        EventName extends keyof RageFW_ICustomClientEvent,
-    >(
-        eventName: EventName,
-        ...args: _ClientEventHasArgs<EventName> extends true
-            ? [RageFW_ClientArgs<EventName>]
-            : []
-    ): Promise<RageFW_ClientReturn<EventName>> {
-        if (this._debugMode) {
-            console.log('[RPC](triggerClient):', eventName, ...args)
-        }
-
-        if ('mp' in window) {
-            return await this._rpc.callClient(eventName, args)
-        }
-
-        return Promise.reject(
-            'RageFW was started in window which does not contain MP',
-        )
-    }
-}
-
-export const fw = {
-    event: new Cef(),
-}
-;(async () => {
-    await fw.event.triggerClient('cefReady')
-})()

cef/src/types/cef.ts

@@ -1,40 +0,0 @@
-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_CefArgs<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_CefArgs<K>,
-) => Promise<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

cli/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Entity Seven Group
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cli/package.json

@@ -1,19 +1,20 @@
 {
     "name": "@entityseven/create-rage-fw",
-    "version": "0.1.0",
+    "version": "0.1.2",
     "bin": {
         "rage-fw": "dist/index.js"
     },
     "main": "dist/index.js",
+    "files": [
+        "dist/**/*",
+        "readme.md",
+        "LICENSE"
+    ],
     "scripts": {
         "watch": "tsc -w",
         "build": "tsup",
         "start": "npx ./dist create"
     },
-    "files": [
-        "dist/**/*",
-        "readme.md"
-    ],
     "dependencies": {
         "@inquirer/prompts": "^5.0.5",
         "ky": "^1.7.2",
@@ -26,11 +27,15 @@
         "prettier": "^3.3.2",
         "typescript": "^5.4.5"
     },
-    "description": "CLI to scaffold a template project for RageFW",
-    "keywords": [],
-    "author": "rilaxik",
-    "contributors": [{
-        "name": "SashaGoncharov19"
-    }],
+    "description": "CLI to scaffold a preview for Rage-FW",
+    "keywords": ["create-rage-fw","ragefw-cli", "ragefw", "rage-fw", "ragemp", "rage:mp", "rage", "gta5"],
+    "author": "Entity Seven Group",
+    "contributors": [
+        {
+            "name": "Danya H",
+            "email": "dev.rilaxik@gmail.com",
+            "url": "https://github.com/rilaxik/"
+        }
+    ],
     "license": "MIT"
 }

cli/readme.md

@@ -1,29 +1,41 @@
-# RageFW CLI
+To make you life easier while using RageFW we created a basic CLI. At the moment automation we have only works via [pnpm](https://pnpm.io/) and [bun](https://bun.sh/)
 
-To make you life easier while using RageFW we created a basic CLI. At the moment automation we have only works via [pnpm](https://pnpm.io/)
+``pnpm create @entityseven/rage-fw@latest``
 
-``pnpm create rage-fw@latest``
+``bun create @entityseven/rage-fw@latest``
 
-## TL;DR
+# TL;DR
 - ``Initialize new project`` - create new template project
+- ``Test our RPC`` - scaffold an example for ``@entityseven/rage-fw-rpc``
 - ``Install RAGE:MP updater`` - download and update RAGE:MP server files
 
-## Options
+# Options
 For now, you will see a few available options. They are described in detail below
 
 - ``Initialize new project``
+- ``Test our RPC``
 - ``Install RAGE:MP updater``
 
-### Initialize new project
-Using this options will forward you to common project-creation menu
+## Initialize new project
+Using this option will forward you to common project creation menu
+
 - ``Enter project name``
+  This option will specify a name for your project which is used as a folder name too. Defaults to **rage-fw-example**
 
-This option will specify a name for your project which is used as a folder name too. Defaults to **rage-fw**
+- ``Select front-end``
+  Use selector menu to choose which front-end framework you want to use. We will do our best to expand this menu with various solutions
 
-- ``Select frontend``
+## Test our RPC
+Using this option will forward you to common project creation menu
 
-Use this selector menu to choose which frontend framework you want to use. We will do our best to expand this menu after some time.
-Defaults to **React + TypeScript (Vite)**
+- ``Enter project name``
+  This option will specify a name for your project which is used as a folder name too. Defaults to **rage-fw-rpc-example**
 
-### Install Rage:MP updater
-This option will simplify installation process of Rage:MP server files required to start your server
+- ``Select front-end``
+  Use selector menu to choose which front-end framework you want to use. We will do our best to expand this menu with various solutions
+
+## Install Rage:MP updater
+This option will simplify installation and update process of Rage:MP server files required to start your server
+
+# Contribution
+If you wish to help us in expanding examples selection with different framework you are very welcome to open PRs and Issues

cli/src/commands/create.ts

@@ -18,19 +18,19 @@ export async function initProject() {
 
     if (!framework) {
         framework = await select({
-            message: c.gray('Select frontend:'),
+            message: c.gray('Select front-end:'),
             default: 'react-18',
             loop: true,
             choices: [
                 {
-                    name: 'React + TypeScript (Vite)',
+                    name: 'React 18',
                     value: 'react-18',
-                    description: 'React + TypeScript (Vite) as a frontend',
+                    description: 'React 18 + TypeScript (Vite) as a front-end',
                 },
             ],
         })
     } else {
-        console.log(c.gray('Frontend:'), framework)
+        console.log(c.gray('Front-end:'), framework)
     }
 
     console.log(
@@ -38,7 +38,7 @@ export async function initProject() {
         folder,
         c.gray('with'),
         framework,
-        c.gray('as a frontend..'),
+        c.gray('as a front-end..'),
     )
 
     cloneBranch(
@@ -56,5 +56,6 @@ export async function initProject() {
         })
         .catch(e => {
             console.log(c.red('Error occured: \n', e))
+            console.log(c.red('Please open an issue if you see this'))
         })
 }

cli/src/commands/test-rpc.ts

@@ -5,14 +5,14 @@ import { cloneBranch } from '../utils/cloner'
 
 const choices = {
     'rpc-react-18': {
-        name: 'Vite + React 18 + TypeScript',
+        name: 'React 18',
         value: 'rpc-react-18',
-        description: 'Vite + React 18 + TypeScript as a frontend',
+        description: 'Vite + React 18 + TypeScript as a front-end',
     },
     'rpc-svelte-5': {
-        name: 'Vite + Svelte 5 + TypeScript',
+        name: 'Svelte 5',
         value: 'rpc-svelte-5',
-        description: 'Vite + Svelte 5 + TypeScript as a frontend',
+        description: 'Vite + Svelte 5 + TypeScript as a front-end',
     },
 } as const
 
@@ -31,13 +31,13 @@ export async function testRpc() {
 
     if (!framework) {
         framework = await select({
-            message: c.gray('Select frontend:'),
+            message: c.gray('Select front-end:'),
             default: 'rpc-react-18',
             loop: true,
             choices: Object.values(choices),
         })
     } else {
-        console.log(c.gray('Frontend:'), framework)
+        console.log(c.gray('Front-end:'), framework)
     }
 
     console.log(
@@ -63,5 +63,6 @@ export async function testRpc() {
         })
         .catch(e => {
             console.log(c.red('Error occured: \n', e))
+            console.log(c.red('Please open an issue if you see this'))
         })
 }

cli/src/index.ts

@@ -12,10 +12,19 @@ enum Actions {
     UPDATER = 'UPDATER',
 }
 
+process.on('exit', () => {
+    console.log(c.blueBright('\n\nRage FW CLI | Exiting..'))
+    process.exit(0)
+})
+
+process.on('SIGINT', () => {
+    console.log(c.blueBright('\n\nRage FW CLI | Exiting..'))
+    process.exit(0)
+})
 ;(async () => {
     await checkForUpdates()
 
-    console.log(c.blueBright('Rage FW CLI | Powered by Entity Seven Group ️<3'))
+    console.log(c.blueBright('Rage FW CLI | Powered by Entity Seven Group <3'))
 
     const action = await select({
         message: c.gray('Select action:'),
@@ -26,16 +35,16 @@ enum Actions {
                 description: 'Initialize a new project and start developing',
             },
             {
-                name: 'Test our RPC',
+                name: 'Test our Rpc',
                 value: Actions.TEST_RPC,
                 description:
-                    'Initialize a new skeleton project with our RPC set up',
+                    'Initialize a new skeleton project with our Rpc all set',
             },
             {
                 name: 'Install RAGE:MP updater',
                 value: Actions.UPDATER,
                 description:
-                    'Use our tool to download or update RAGE:MP server files in two clicks',
+                    'Use our tool to download or update RAGE:MP server files in just two clicks',
             },
         ],
         loop: true,
@@ -53,5 +62,6 @@ enum Actions {
             break
         default:
             console.log(c.red('Something went wrong..'))
+            console.log(c.red('Please open an issue if you see this'))
     }
 })()

client/LICENSE

@@ -0,0 +1,15 @@
+Custom Attribution-NoDerivs Software License
+
+Copyright (c) 2024 Entity Seven Group
+
+This license allows you to use, copy, and distribute the RageFW (the "Software"), including for commercial purposes, provided that the following conditions are met:
+
+1. **Attribution:** You must give appropriate credit to the original author of the Software, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
+
+2. **No Derivative Works:** You may not modify, transform, or build upon the Software.
+
+3. **Usage and Commercial Use:** You are allowed to use, sell, and gain income from projects that utilize the Software, as long as you comply with the terms of this license.
+
+4. **No Additional Restrictions:** You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

client/package.json

@@ -1,30 +1,38 @@
 {
     "name": "@entityseven/rage-fw-client",
-    "version": "0.1.0",
+    "version": "0.2.0",
     "main": "dist/index.js",
     "types": "dist/src/index.d.ts",
     "files": [
         "dist/**/*",
-        "readme.md"
+        "readme.md",
+        "LICENSE"
     ],
     "scripts": {
         "build": "tsup"
     },
     "dependencies": {
-        "rage-fw-rpc": "workspace:^"
+        "@entityseven/rage-fw-rpc": "0.2.5"
     },
     "peerDependencies": {
-        "@ragempcommunity/types-client": "^2.1.8",
-        "rage-fw-shared-types": "workspace:^"
+        "@entityseven/rage-fw-shared-types": "0.2.0",
+        "@ragempcommunity/types-client": "^2.1.8"
     },
-    "description": "RageFW Client side",
-    "keywords": [],
-    "author": "SashaGoncharov19",
-    "contributors": [{
-        "name": "rilaxik",
+    "description": "Package used on a client-side of your Rage:MP Server",
+    "keywords": ["rage-fw-client", "ragefw", "rage-fw", "ragemp", "rage:mp", "rage", "gta5"],
+    "author": "Entity Seven Group",
+    "contributors": [
+        {
+            "name": "Danya H",
             "email": "dev.rilaxik@gmail.com",
-        "url": "https://github.com/rilaxik"
-    }],
-    "license": "MIT",
-    "gitHead": "053e4fd12aa120d53e11e0d2009c0df78c1a2ad0"
+            "url": "https://github.com/rilaxik/"
+        },
+        {
+            "name": "Oleksandr Honcharov",
+            "email": "0976053529@ukr.net",
+            "url": "https://github.com/SashaGoncharov19/"
+        }
+    ],
+    "license": "Custom-Attribution-NoDerivs",
+    "gitHead": "ffd542c1deddb3033e16e0dae7557313ae09b05f"
 }

client/readme.md

@@ -1,2 +1,2 @@
 # RageFW Client
-[Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki/Docs)
+[Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki)

client/src/core/client.ts

@@ -1,33 +1,86 @@
-import { Rpc } from 'rage-fw-rpc'
-
-import type {
-    RageFW_ClientArgs,
-    RageFW_ClientCallback,
-    RageFW_ClientEvent,
-} from '../types'
+import { rpc } from './rpc'
+import { Middleware } from './middleware'
+import type * as T from '../types'
 
+/** Client-side interactions */
 export class Client {
-    private _rpc: Rpc = new Rpc()
-
-    get rpc(): Rpc {
-        return this._rpc
-    }
-
-    public register<EventName extends RageFW_ClientEvent>(
+    /**
+     * Registers a client event with an associated callback
+     *
+     * @param eventName - The name of the event to register
+     * @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 {Client} The current client instance, enabling method chaining
+     *
+     * @example
+     * // Registering an event
+     * fw.event.register("playerDeath", (player, reason, killer) => {
+     *     fw.system.log.info(player, reason, killer)
+     * })
+     *
+     * @example
+     * // Registering an event with middlewares
+     * fw.event.register("playerDeath", (player, reason, killer) => {
+     *     fw.system.log.info(player, reason, killer)
+     * }, {
+     *     middlewares: [ignoreSuicide] // <- your middlewares here
+     * })
+     *
+     * // or
+     *
+     * fw.event.register("playerDeath", (player, reason, killer) => {
+     *     fw.system.log.info(player, reason, killer)
+     * }, {
+     *     middlewares: {
+     *         executables: [ignoreSuicide], // <- your middlewares here
+     *         onError: (msg) => fw.system.log.info(`${player.socialClub} has commited suicide`)
+     *     }
+     * })
+     *
+     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+     */
+    public register<EventName extends T.RageFW_ClientEvent>(
         eventName: EventName,
-        callback: RageFW_ClientCallback<EventName>,
-    ): void {
-        this._rpc.register(
-            eventName,
-            async (data: RageFW_ClientArgs<EventName>) => {
-                return await callback(data)
+        callback: T.RageFW_ClientCallback<EventName>,
+        options?: {
+            middlewares?: T.RageFW_MiddlewareOptions<EventName>
         },
-        )
+    ): Client {
+        rpc.register<
+            Parameters<typeof callback>,
+            ReturnType<typeof callback> | Promise<unknown>,
+            EventName
+        >(eventName, async (...data) => {
+            if (!options?.middlewares) return await callback(...data)
+
+            await Middleware.process(options.middlewares, callback, data)
+        })
+
+        return this
     }
 
-    public unregister<EventName extends RageFW_ClientEvent>(
+    /**
+     * Unregisters a client event, removing the associated callback
+     *
+     * @param eventName - The name of the event to unregister
+     * @returns {Client} The current client instance, enabling method chaining
+     *
+     * @example
+     * // Unregistering an event
+     * fw.event.unregister("playerDeath")
+     *
+     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+     */
+    public unregister<EventName extends T.RageFW_ClientEvent>(
         eventName: EventName,
-    ): void {
-        this._rpc.unregister(eventName)
+    ): Client {
+        rpc.unregister<EventName>(eventName)
+
+        return this
     }
 }
+
+// new Client()
+//     .register('customClientEvent', async (a, b) => true)
+//     .unregister('customClientEvent')

client/src/core/index.ts

@@ -1,3 +1,5 @@
 export * from './client'
-export * from './player'
 export * from './logger'
+export * from './middleware'
+export * from './player'
+export * from './rpc'

client/src/core/logger.ts

@@ -1,19 +1,40 @@
+/**
+ * Used to log to a client in-game console
+ */
 export class Logger {
-    public error(...message: unknown[]) {
-        mp.console.logError(
-            `[${new Date().toLocaleTimeString()}] [ERROR] ${message.join(' ')}`,
+    /**
+     * Informational logs. Colored in white
+     *
+     * @example
+     * fw.system.log.info('some information to be logged')
+     */
+    public info(...message: unknown[]) {
+        mp.console.logInfo(
+            `[${new Date().toLocaleTimeString()}] [INFO] ${message.join(' ')}`,
         )
     }
 
+    /**
+     * Warning logs. Colored in yellow
+     *
+     * @example
+     * fw.system.log.warn('warning message')
+     */
     public warn(...message: unknown[]) {
         mp.console.logWarning(
             `[${new Date().toLocaleTimeString()}] [WARN] ${message.join(' ')}`,
         )
     }
 
-    public info(...message: unknown[]) {
-        mp.console.logInfo(
-            `[${new Date().toLocaleTimeString()}] [INFO] ${message.join(' ')}`,
+    /**
+     * Error logs. Colored in red
+     *
+     * @example
+     * fw.system.log.info('some error information')
+     */
+    public error(...message: unknown[]) {
+        mp.console.logError(
+            `[${new Date().toLocaleTimeString()}] [ERROR] ${message.join(' ')}`,
         )
     }
 }

client/src/core/middleware.ts

@@ -0,0 +1,54 @@
+import type * as T from '../types'
+
+export class Middleware {
+    constructor() {}
+
+    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)
+
+            if (typeof result === 'boolean' && !result)
+                return { success: result, id: i }
+            if (typeof result !== 'boolean' && !result.success)
+                return { ...result, id: i }
+        }
+
+        return {
+            success: true,
+        }
+    }
+
+    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 Middleware.execute(
+                middlewareOptions,
+                args,
+            )
+
+            if (middlewaresResponse.success) return await callback(...args)
+        } else {
+            const middlewaresResponse = await Middleware.execute(
+                middlewareOptions.executables,
+                args,
+            )
+
+            if (middlewaresResponse.success) {
+                return await callback(...args)
+            } else {
+                middlewareOptions.onError(
+                    middlewaresResponse.message ??
+                        'Middleware with id ' +
+                            middlewaresResponse.id +
+                            ' failed',
+                )
+            }
+        }
+    }
+}

client/src/core/player.ts

@@ -1,53 +1,118 @@
-import { Rpc } from 'rage-fw-rpc'
-import type { RageFW_ICustomClientEvent } from 'rage-fw-shared-types'
-
-import {
-    _CefEventHasArgs,
-    _ClientEventHasArgs,
-    _ServerEventHasArgs,
-    RageFW_CefArgs,
-    RageFW_CefEvent,
-    RageFW_CefReturn,
-    RageFW_ClientArgs,
-    RageFW_ClientReturn,
-    RageFW_ClientServerEvent,
-    RageFW_ClientServerArgs,
-    RageFW_ClientServerReturn,
-} from '../types'
+import { rpc } from './rpc'
+import type * as T from '../types'
 
+/** Handles event manipulations that require player to be present in context */
 export class Player {
-    private _rpc: Rpc = new Rpc()
-    public browser: BrowserMp | undefined
+    private _browser: BrowserMp | undefined = undefined
 
-    get rpc(): Rpc {
-        return this._rpc
-    }
-    public trigger<EventName extends keyof RageFW_ICustomClientEvent>(
-        eventName: EventName,
-        ...args: _ClientEventHasArgs<EventName> extends true
-            ? [RageFW_ClientArgs<EventName>]
-            : []
-    ): Promise<RageFW_ClientReturn<EventName>> {
-        return this._rpc.call(eventName, args)
+    /**
+     * Setter. Also shares browser with ``rage-fw-rpc``
+     */
+    set browser(browser: BrowserMp) {
+        this._browser = browser
+        rpc.browser = browser
     }
 
-    public triggerServer<EventName extends RageFW_ClientServerEvent>(
+    /**
+     * Triggers a client event from the client with arguments from shared types
+     *
+     * Formerly known as ``call`` or ``emit``
+     *
+     * @param eventName - The name of the client event to trigger
+     * @param [args] - Arguments for the client event, if present
+     * @returns {Promise} resolving to the client's response for the event
+     *
+     * @example
+     * // Triggering a client event without arguments
+     * fw.player.trigger("clientEventName")
+     *
+     * @example
+     * // Triggering a client event with arguments
+     * fw.player.trigger("clientEventName", ["message to me"])
+     *
+     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+     */
+    public async trigger<EventName extends keyof T.RageFW_ICustomClientEvent>(
         eventName: EventName,
-        ...args: _ServerEventHasArgs<EventName> extends true
-            ? [RageFW_ClientServerArgs<EventName>]
+        ...args: T._ClientEventHasArgs<EventName> extends true
+            ? [T.RageFW_ClientArgs<EventName>]
             : []
-    ): Promise<RageFW_ClientServerReturn<EventName>> {
-        return this._rpc.callServer(eventName, args)
+    ): Promise<T.RageFW_ClientReturn<EventName>> {
+        return await rpc.call<
+            typeof args,
+            EventName,
+            T.RageFW_ClientReturn<EventName>
+        >(eventName, args)
     }
 
-    public triggerBrowser<EventName extends RageFW_CefEvent>(
+    /**
+     * Triggers a server event from the client with arguments from shared types
+     *
+     * Formerly known as ``callServer`` or ``emitServer``
+     *
+     * @param eventName - The name of the server event to trigger
+     * @param [args] - Arguments for the server event, if present
+     * @returns {Promise} resolving to the server's response for the event
+     *
+     * @example
+     * // Triggering a server event without arguments
+     * fw.player.triggerServer("serverEventName")
+     *
+     * @example
+     * // Triggering a server event with arguments
+     * fw.player.triggerServer("serverEventName", ["message to server"])
+     *
+     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+     */
+    public async triggerServer<EventName extends T.RageFW_ServerEvent>(
         eventName: EventName,
-        ...args: _CefEventHasArgs<EventName> extends true
-            ? [RageFW_CefArgs<EventName>]
+        ...args: T._ServerEventHasArgs<EventName> extends true
+            ? [T.RageFW_ServerArgs<EventName>]
             : []
-    ): Promise<RageFW_CefReturn<EventName>> {
-        if (!this.browser)
+    ): Promise<T.RageFW_ClientServerReturn<EventName>> {
+        return await rpc.callServer<
+            typeof args,
+            EventName,
+            T.RageFW_ClientServerReturn<EventName>
+        >(eventName, args)
+    }
+
+    /**
+     * Triggers a browser event from the client with arguments from shared types
+     *
+     * Formerly known as ``callBrowser`` or ``emitBrowser``
+     *
+     * @param eventName - The name of the browser event to trigger
+     * @param [args] - Arguments for the browser event, if present
+     * @returns {Promise} resolving to the browser's response for the event
+     *
+     * @example
+     * // Triggering a browser event without arguments
+     * fw.player.triggerBrowser("browserEventName")
+     *
+     * @example
+     * // Triggering a browser event with arguments
+     * fw.player.triggerBrowser("browserEventName", ["message to browser"])
+     *
+     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+     */
+    public async triggerBrowser<EventName extends T.RageFW_BrowserEvent>(
+        eventName: EventName,
+        ...args: T._BrowserEventHasArgs<EventName> extends true
+            ? [T.RageFW_BrowserArgs<EventName>]
+            : []
+    ): Promise<T.RageFW_BrowserReturn<EventName>> {
+        if (!this._browser)
             throw new Error('You need to initialize browser first')
-        return this._rpc.callBrowser(this.browser, eventName, args)
+
+        return await rpc.callBrowser<
+            typeof args,
+            EventName,
+            T.RageFW_BrowserReturn<EventName>
+        >(eventName, args)
     }
 }
+
+// new Player().trigger('customClientEvent', ['', 1])
+// new Player().triggerServer('customServerEvent', ['', 1])
+// new Player().triggerBrowser('customCefEvent', ['', 1])

client/src/core/rpc.ts

@@ -0,0 +1,5 @@
+import { Rpc } from '@entityseven/rage-fw-rpc'
+
+export const rpc = new Rpc({
+    debugLogs: false,
+})

client/src/index.ts

@@ -1,9 +1,22 @@
-import { Client, Logger, Player } from './core'
+import { Client, Logger, Player, rpc } from './core'
 
+export type { RageFW_MiddlewareFunction } from './types'
+
+/**
+ * Package used on a client-side of your Rage:MP Server
+ *
+ * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+ */
 export const fw = {
+    /** Client-side interactions */
     event: new Client(),
+    /** Handles event manipulations that require player to be present in context */
     player: new Player(),
+    /** Handles functions used to interact with the client environment */
     system: {
+        /** Used to log in a client in-game console */
         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,
 }

client/src/types/browser.ts

@@ -1,20 +1,29 @@
 /// <reference types="@ragempcommunity/types-client" />
 
-import type { RageFW_ICustomCefEvent } from 'rage-fw-shared-types'
+import type { RageFW_ICustomBrowserEvent } from '@entityseven/rage-fw-shared-types'
 
-export type RageFW_CefEvent = keyof RageFW_ICustomCefEvent
+/**
+ * Union of all available browser event names callable from client
+ * These only include custom events
+ */
+export type RageFW_BrowserEvent = keyof RageFW_ICustomBrowserEvent
 
-export type RageFW_CefArgs<K extends RageFW_CefEvent> = Parameters<
-    RageFW_ICustomCefEvent[K]
+/**
+ * Array of arguments for an event, name of which you pass as a generic
+ * These only include custom events
+ */
+export type RageFW_BrowserArgs<K extends RageFW_BrowserEvent> = Parameters<
+    RageFW_ICustomBrowserEvent[K]
 >
 
-export type RageFW_CefReturn<K extends RageFW_CefEvent> = ReturnType<
-    RageFW_ICustomCefEvent[K]
+export type RageFW_BrowserReturn<K extends RageFW_BrowserEvent> = ReturnType<
+    RageFW_ICustomBrowserEvent[K]
 >
 
-export type _CefEventHasArgs<EventName extends keyof RageFW_ICustomCefEvent> =
-    keyof RageFW_ICustomCefEvent extends never
+export type _BrowserEventHasArgs<
+    EventName extends keyof RageFW_ICustomBrowserEvent,
+> = keyof RageFW_ICustomBrowserEvent extends never
     ? false
-        : Parameters<RageFW_ICustomCefEvent[EventName]>[0] extends undefined
+    : Parameters<RageFW_ICustomBrowserEvent[EventName]>[0] extends undefined
       ? false
       : true

client/src/types/client.ts

@@ -1,6 +1,8 @@
 /// <reference types="@ragempcommunity/types-client" />
 
-import type { RageFW_ICustomClientEvent } from 'rage-fw-shared-types'
+import type { RageFW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
+
+export type { RageFW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
 
 /**
  * Union of all available client event names
@@ -21,23 +23,28 @@ export type RageFW_ClientArgs<K extends RageFW_ClientEvent> =
           ? 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_ClientCallback<K extends RageFW_ClientEvent> = (
-    args: RageFW_ClientArgs<K>,
-) => Promise<RageFW_ClientReturn<K>>
-
 /**
  * Return type for an event, name of which you pass as a generic
- * These only include custom events
+ * These include custom and system events
  */
 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
 
+/**
+ * Callback (function) for an event, name of which you pass as a generic
+ * These include custom and system events
+ */
+export type RageFW_ClientCallback<K extends RageFW_ClientEvent> = (
+    ...args: RageFW_ClientArgs<K>
+) => Promise<RageFW_ClientReturn<K>>
+
+/**
+ *
+ */
 export type _ClientEventHasArgs<
     EventName extends keyof RageFW_ICustomClientEvent,
 > = keyof RageFW_ICustomClientEvent extends never

client/src/types/index.ts

@@ -1,3 +1,4 @@
-export * from './client'
-export * from './server'
 export * from './browser'
+export * from './client'
+export * from './middleware'
+export * from './server'

client/src/types/middleware.ts

@@ -0,0 +1,26 @@
+import type * as T from './client'
+
+export type RageFW_MiddlewareResponse =
+    | {
+          success: boolean
+          message?: string
+      }
+    | boolean
+
+export type RageFW_MiddlewareResponseInternal = {
+    success: boolean
+    message?: string
+    id?: number
+}
+
+export type RageFW_MiddlewareFunction<EventName extends T.RageFW_ClientEvent> =
+    (
+        ...args: T.RageFW_ClientArgs<EventName>
+    ) => Promise<RageFW_MiddlewareResponse>
+
+export type RageFW_MiddlewareOptions<EventName extends T.RageFW_ClientEvent> =
+    | RageFW_MiddlewareFunction<EventName>[]
+    | {
+          executables: RageFW_MiddlewareFunction<EventName>[]
+          onError: (error: string) => unknown
+      }

client/src/types/server.ts

@@ -3,19 +3,19 @@
 import type {
     RageFW_ICustomClientEvent,
     RageFW_ICustomServerEvent,
-} from 'rage-fw-shared-types'
+} from '@entityseven/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_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 RageFW_ClientServerArgs<K extends RageFW_ClientServerEvent> =
+export type RageFW_ServerArgs<K extends RageFW_ServerEvent> =
     K extends keyof RageFW_ICustomServerEvent
         ? Parameters<RageFW_ICustomServerEvent[K]>
         : never
@@ -24,7 +24,7 @@ export type RageFW_ClientServerArgs<K extends RageFW_ClientServerEvent> =
  * Return type for an event, name of which you pass as a generic
  * These only include custom events
  */
-export type RageFW_ClientServerReturn<K extends RageFW_ClientServerEvent> =
+export type RageFW_ClientServerReturn<K extends RageFW_ServerEvent> =
     K extends keyof RageFW_ICustomServerEvent
         ? ReturnType<RageFW_ICustomServerEvent[K]>
         : never

lerna.json

@@ -1,5 +1,5 @@
 {
     "$schema": "node_modules/lerna/schemas/lerna-schema.json",
-    "version": "0.2.0",
+    "version": "0.2.1-0.2.0-alpha.2.0",
     "npmClient": "pnpm"
 }

package.json

@@ -1,14 +1,13 @@
 {
-  "private": true,
   "scripts": {
-    "publish": "pnpm build && lerna publish --force-publish",
+    "publish": "lerna publish --force-publish",
     "build": "lerna run build",
     "lint": "eslint --c .eslintrc.yaml --ext .ts client/ server/ shared-types/",
 
-    "rebuild:cef": "cd cef && pnpm build",
+    "rebuild:browser": "cd browser && pnpm build",
     "rebuild:client": "cd client && pnpm build",
     "rebuild:server": "cd server && pnpm build",
-    "rebuild": "pnpm rebuild:cef && pnpm rebuild:client && pnpm rebuild:server"
+    "rebuild": "pnpm rebuild:browser && pnpm rebuild:client && pnpm rebuild:server"
   },
   "dependencies": {
     "@microsoft/api-extractor": "^7.47.0",
@@ -17,6 +16,7 @@
     "@ragempcommunity/types-server": "^2.1.8",
     "@typescript-eslint/eslint-plugin": "^7.13.0",
     "@typescript-eslint/parser": "^7.13.0",
+    "@types/node": "^22.8.1",
     "eslint": "^8.56.0",
     "lerna": "^8.1.3",
     "prettier": "^3.3.1",
@@ -25,5 +25,20 @@
     "typescript": "^5.4.5",
     "winston": "^3.13.0"
   },
-  "type": "module"
+  "private": true,
+  "type": "module",
+  "license": "SEE INDIVIDUALLY FOR EACH PACKAGE",
+  "author": "Entity Seven Group",
+  "contributors": [
+    {
+      "name": "Danya H",
+      "email": "dev.rilaxik@gmail.com",
+      "url": "https://github.com/rilaxik/"
+    },
+    {
+      "name": "Oleksandr Honcharov",
+      "email": "0976053529@ukr.net",
+      "url": "https://github.com/SashaGoncharov19/"
+    }
+  ]
 }

pnpm-workspace.yaml

@@ -1,7 +1,5 @@
 packages:
   - "server"
   - "client"
-  - "cef"
-  - "rpc"
-  - "cli"
+  - "browser"
   - "shared-types"

readme.md

@@ -13,7 +13,7 @@ You can find out more about our CLI [here](https://git.entityseven.com/entitysev
 
 At the moment automation we have only works via [pnpm](https://pnpm.io/). To scaffold a basic project with minor settings you can use our CLI:
 
-``pnpm create rage-fw``
+``pnpm create @entityseven/rage-fw``
 
 This will give you a few options, among them, you can find ``Initialize new project``. Use that option to scaffold a new project for yourself using the preferred frontend framework
 

rpc/package.json

@@ -1,13 +1,16 @@
 {
   "name": "@entityseven/rage-fw-rpc",
-    "description": "Rage FW RPC",
-    "version": "0.2.0",
+  "version": "0.2.5",
+  "main": "dist/index.js",
+  "types": "dist/src/index.d.ts",
   "scripts": {
     "build": "tsup",
     "start": "npx ./dist create"
   },
   "files": [
-        "dist/**/*"
+    "dist/**/*",
+    "readme.md",
+    "LICENSE"
   ],
   "devDependencies": {
     "@microsoft/api-extractor": "^7.47.9",
@@ -17,25 +20,25 @@
   "peerDependencies": {
     "typescript": "^5"
   },
+  "description": "Rage-FW RPC (Remote procedure caller) for Rage:MP",
   "keywords": [
+    "ragefw",
+    "rage-fw",
     "ragemp",
     "rage",
     "rpc",
     "rage-rpc",
-        "ragerpc"
+    "ragerpc",
+    "gta5"
   ],
-    "main": "dist/index.js",
-    "types": "dist/src/index.d.ts",
-    "author": {
-        "name": "rilaxik",
-        "email": "dev.rilaxik@gmail.com",
-        "url": "https://github.com/rilaxik"
-    },
+  "author": "Entity Seven Group",
   "contributors": [
     {
-            "name": "SashaGoncharov19",
-            "url": "https://github.com/SashaGoncharov19"
+      "name": "Danya H",
+      "email": "dev.rilaxik@gmail.com",
+      "url": "https://github.com/rilaxik/"
     }
   ],
-    "license": "MIT"
+  "license": "MIT",
+  "gitHead": "04eb7240735c4a0e4855ebabbe8d5b326819fa76"
 }

rpc/readme.md

@@ -3,13 +3,13 @@ is an all-in package with asynchronous RPC implementation for RageMP servers in
 
 # Installation
 ``` shell 
-npm i rage-fw-rpc
+npm i @entityseven/rage-fw-rpc
 ```
 ```shell 
-pnpm i rage-fw-rpc
+pnpm i @entityseven/rage-fw-rpc
 ```
 ```shell 
-yarn add rage-fw-rpc
+yarn add @entityseven/rage-fw-rpc
 ```
 
 Import installed package and initialize rpc:
@@ -20,6 +20,11 @@ Import installed package and initialize rpc:
 export const rpc = new Rpc(/* options */)
 ```
 
+# Motivation
+The idea was to create an extensible package, with various features to simplify the development process and provide as much comfort as possible. It should also be using similar architecture as the framework it was specially built for
+
+Inspired by usage of [rage-rpc](https://github.com/micaww/rage-rpc)
+
 # Features
 - Type-safe events via [TS generics](https://www.typescriptlang.org/docs/handbook/2/generics.html), avoiding type wrappers
 - Built-in logging options for each environment 
@@ -28,7 +33,7 @@ Import installed package and initialize rpc:
 - Actual human-readable errors
 
 # Docs
-*Extended version with details coming soon*
+## [Extended version available here](https://git.entityseven.com/entityseven/rage-framework/wiki/RPC%400.2.5)
 
 ## register
 Registers a callback function for a specified event

server/LICENSE

@@ -0,0 +1,15 @@
+Custom Attribution-NoDerivs Software License
+
+Copyright (c) 2024 Entity Seven Group
+
+This license allows you to use, copy, and distribute the RageFW (the "Software"), including for commercial purposes, provided that the following conditions are met:
+
+1. **Attribution:** You must give appropriate credit to the original author of the Software, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
+
+2. **No Derivative Works:** You may not modify, transform, or build upon the Software.
+
+3. **Usage and Commercial Use:** You are allowed to use, sell, and gain income from projects that utilize the Software, as long as you comply with the terms of this license.
+
+4. **No Additional Restrictions:** You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

server/package.json

@@ -1,30 +1,38 @@
 {
     "name": "@entityseven/rage-fw-server",
-    "version": "0.1.0",
+    "version": "0.2.0",
     "main": "dist/index.js",
     "types": "dist/src/index.d.ts",
     "files": [
         "dist/**/*",
-        "readme.md"
+        "readme.md",
+        "LICENSE"
     ],
     "scripts": {
         "build": "tsup"
     },
     "dependencies": {
-        "rage-fw-rpc": "workspace:^"
+        "@entityseven/rage-fw-rpc": "0.2.5"
     },
     "peerDependencies": {
-        "@ragempcommunity/types-server": "^2.1.8",
-        "rage-fw-shared-types": "workspace:^"
+        "@entityseven/rage-fw-shared-types": "0.2.0",
+        "@ragempcommunity/types-server": "^2.1.8"
     },
-    "description": "RageFW Server side",
-    "keywords": [],
-    "author": "SashaGoncharov19",
-    "contributors": [{
-        "name": "rilaxik",
+    "description": "Package used on a server-side of your Rage:MP Server",
+    "keywords": ["rage-fw-server", "ragefw", "rage-fw", "ragemp", "rage:mp", "rage", "gta5"],
+    "author": "Entity Seven Group",
+    "contributors": [
+        {
+            "name": "Danya H",
             "email": "dev.rilaxik@gmail.com",
-        "url": "https://github.com/rilaxik"
-    }],
-    "license": "MIT",
-    "gitHead": "053e4fd12aa120d53e11e0d2009c0df78c1a2ad0"
+            "url": "https://github.com/rilaxik/"
+        },
+        {
+            "name": "Oleksandr Honcharov",
+            "email": "0976053529@ukr.net",
+            "url": "https://github.com/SashaGoncharov19/"
+        }
+    ],
+    "license": "Custom-Attribution-NoDerivs",
+    "gitHead": "ffd542c1deddb3033e16e0dae7557313ae09b05f"
 }

server/readme.md

@@ -1,2 +1,2 @@
 # RageFW Server
-[Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki/Docs)
+[Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki)

server/src/core/index.ts

@@ -1,3 +1,5 @@
-export * from './player'
-export * from './server'
 export * from './logger'
+export * from './middleware'
+export * from './player'
+export * from './rpc'
+export * from './server'

server/src/core/logger.ts

@@ -2,6 +2,7 @@ import winston, { format } from 'winston'
 
 const { timestamp, printf, colorize } = format
 
+/** Used to log in a server console */
 export class Logger {
     private format = printf(({ message, level, timestamp }) => {
         return `[${new Date(timestamp).toLocaleTimeString()}] [${level}]: ${message}`
@@ -23,14 +24,32 @@ export class Logger {
         ),
     })
 
+    /**
+     * Informational logs. Colored in white
+     *
+     * @example
+     * fw.system.log.info('some information to be logged')
+     */
     public info(...message: unknown[]) {
         this.systemLogger.info(message.join(' '))
     }
 
+    /**
+     * Warning logs. Colored in yellow
+     *
+     * @example
+     * fw.system.log.warn('warning message')
+     */
     public warn(...message: unknown[]) {
         this.systemLogger.warn(message.join(' '))
     }
 
+    /**
+     * Error logs. Colored in red
+     *
+     * @example
+     * fw.system.log.info('some error information')
+     */
     public error(...message: unknown[]) {
         this.systemLogger.error(message.join(' '))
     }

server/src/core/middleware.ts

@@ -0,0 +1,54 @@
+import type * as T from '../types'
+
+export class Middleware {
+    constructor() {}
+
+    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)
+
+            if (typeof result === 'boolean' && !result)
+                return { success: result, id: i }
+            if (typeof result !== 'boolean' && !result.success)
+                return { ...result, id: i }
+        }
+
+        return {
+            success: true,
+        }
+    }
+
+    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 Middleware.execute(
+                middlewareOptions,
+                args,
+            )
+
+            if (middlewaresResponse.success) return await callback(...args)
+        } else {
+            const middlewaresResponse = await Middleware.execute(
+                middlewareOptions.executables,
+                args,
+            )
+
+            if (middlewaresResponse.success) {
+                return await callback(...args)
+            } else {
+                middlewareOptions.onError(
+                    middlewaresResponse.message ??
+                        'Middleware with id ' +
+                            middlewaresResponse.id +
+                            ' failed',
+                )
+            }
+        }
+    }
+}

server/src/core/player.ts

@@ -1,40 +1,68 @@
-import { Rpc } from 'rage-fw-rpc'
-
-import type {
-    _CefEventHasArgs,
-    _ClientEventHasArgs,
-    RageFW_CefArgs,
-    RageFW_CefEvent,
-    RageFW_CefReturn,
-    RageFW_ClientEvent,
-    RageFW_ServerClientArgs,
-    RageFW_ServerClientReturn,
-} from '../types'
+import { rpc } from './rpc'
+import type * as T from '../types'
 
+/** Handles event manipulations that require player to be present in context */
 export class Player {
-    private _rpc: Rpc = new Rpc()
-
-    get rpc(): Rpc {
-        return this._rpc
-    }
-
-    public triggerClient<EventName extends RageFW_ClientEvent>(
+    /**
+     * Triggers a client event from the server with arguments from shared types
+     *
+     * Formerly known as ``callClient`` or ``emitClient``
+     *
+     * @param {PlayerMp} player - Player object as an event target
+     * @param eventName - The name of the client event to trigger
+     * @param [args] - Arguments for the client event, if present
+     * @returns {Promise} resolving to the client's response for the event
+     *
+     * @example
+     * // Triggering a client event without arguments
+     * fw.player.triggerClient("clientEventName")
+     *
+     * @example
+     * // Triggering a client event with arguments
+     * fw.player.triggerClient("clientEventName", ["message to client"])
+     *
+     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+     */
+    public async triggerClient<EventName extends T.RageFW_ClientEvent>(
         player: PlayerMp,
         eventName: EventName,
-        ...args: _ClientEventHasArgs<EventName> extends true
-            ? [RageFW_ServerClientArgs<EventName>]
+        ...args: T._ClientEventHasArgs<EventName> extends true
+            ? [T.RageFW_ClientArgs<EventName>]
             : []
-    ): Promise<RageFW_ServerClientReturn<EventName>> {
-        return this._rpc.callClient(player, eventName, args)
+    ): Promise<T.RageFW_ClientReturn<EventName>> {
+        return await rpc.callClient(player, eventName, args)
     }
 
-    public triggerBrowser<EventName extends RageFW_CefEvent>(
+    /**
+     * Triggers a browser event from the server with arguments from shared types
+     *
+     * Formerly known as ``callBrowser`` or ``emitBrowser``
+     *
+     * @param {PlayerMp} player - Player object as an event target
+     * @param eventName - The name of the browser event to trigger
+     * @param [args] - Arguments for the browser event, if present
+     * @returns {Promise} resolving to the browser's response for the event
+     *
+     * @example
+     * // Triggering a browser event without arguments
+     * fw.player.triggerBrowser("browserEventName")
+     *
+     * @example
+     * // Triggering a browser event with arguments
+     * fw.player.triggerBrowser("browserEventName", ["message to browser"])
+     *
+     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+     */
+    public async triggerBrowser<EventName extends T.RageFW_BrowserEvent>(
         player: PlayerMp,
         eventName: EventName,
-        ...args: _CefEventHasArgs<EventName> extends true
-            ? [RageFW_CefArgs<EventName>]
+        ...args: T._BrowserEventHasArgs<EventName> extends true
+            ? [T.RageFW_BrowserArgs<EventName>]
             : []
-    ): Promise<RageFW_CefReturn<EventName>> {
-        return this._rpc.callBrowser(player, eventName, args)
+    ): 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])

server/src/core/rpc.ts

@@ -0,0 +1,5 @@
+import { Rpc } from '@entityseven/rage-fw-rpc'
+
+export const rpc = new Rpc({
+    debugLogs: false,
+})

server/src/core/server.ts

@@ -1,117 +1,96 @@
-import { Rpc } from 'rage-fw-rpc'
-import { RageFW_ICustomServerEvent } from 'rage-fw-shared-types'
-
-import { nativeEvents } from '../native.events'
-import type {
-    _ServerEventHasArgs,
-    RageFW_ServerArgs,
-    RageFW_ServerCallback,
-    RageFW_ServerCallbackCustom,
-    RageFW_ServerCallbackNative,
-    RageFW_ServerEvent,
-    RageFW_ServerReturn,
-} from '../types'
+import { rpc } from './rpc'
+import { Middleware } from './middleware'
+import type * as T from '../types'
 
+/** Server-side interactions */
 export class Server {
-    private _rpc: Rpc = new Rpc()
-
-    get rpc(): Rpc {
-        return this._rpc
-    }
-
-    private isNativeEvent(eventName: string): eventName is keyof IServerEvents {
-        return nativeEvents.includes(eventName)
-    }
-
-    private registerCustom<EventName extends keyof RageFW_ICustomServerEvent>(
+    /**
+     * Registers a server event with an associated callback
+     *
+     * @param eventName - The name of the event to register
+     * @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 {Server} The current server instance, enabling method chaining
+     *
+     * @example
+     * // Registering an event
+     * fw.event.register("playerJoin", (player) => {
+     *     fw.system.log.info(`${player.socialClub} has joined the game`)
+     * })
+     *
+     * @example
+     * // Registering an event with middlewares
+     * fw.event.register("playerJoin", (player) => {
+     *     fw.system.log.info(`${player.name} has joined the game`)
+     * }, {
+     *     middlewares: [ignoreBots] // <- your middlewares here
+     * })
+     *
+     * // or
+     *
+     * fw.event.register("playerJoin", (player) => {
+     *     fw.system.log.info(`${player.socialClub} has joined the game`)
+     * }, {
+     *     middlewares: {
+     *         executables: [ignoreBots], // <- your middlewares here
+     *         onError: (msg) => fw.system.log.info(`[BOT] ${player.socialClub} has joined the game`)
+     *     }
+     * })
+     *
+     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+     */
+    public register<EventName extends T.RageFW_ServerEvent>(
         eventName: EventName,
-        callback: RageFW_ServerCallbackCustom<EventName>,
-    ): void {
-        this._rpc.register(
-            eventName,
+        callback: T.RageFW_ServerCallback<EventName>,
+        options?: {
+            middlewares?: T.RageFW_MiddlewareOptions<EventName>
+        },
+    ): Server {
+        rpc.register<
+            Parameters<typeof callback>,
+            ReturnType<typeof callback> | Promise<unknown>,
+            EventName
+        >(eventName, async (...data) => {
+            if (!options?.middlewares) return await callback(...data)
+
+            await Middleware.process(options.middlewares, callback, data)
+        })
+
+        return this
+    }
+
+    /**
+     * Unregisters a server event, removing the associated callback
+     *
+     * @param eventName - The name of the event to unregister
+     * @returns {Server} The current server instance, enabling method chaining
+     *
+     * @example
+     * // Unregistering an event
+     * fw.event.unregister("playerJoin")
+     *
+     * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+     */
+    public unregister<EventName extends T.RageFW_ServerEvent>(
+        eventName: EventName,
+    ): Server {
+        rpc.unregister<EventName>(eventName)
+
+        return this
+    }
+
     // fixme
-            async (args: RageFW_ServerArgs<EventName>, info) => {
-                await callback([info.player as PlayerMp, ...args])
-            },
-        )
+    // public trigger<EventName extends keyof T.RageFW_ICustomServerEvent>(
+    //     eventName: EventName,
+    //     ...args: T._ServerEventHasArgs<EventName> extends true
+    //         ? [T.RageFW_ServerArgs<EventName>]
+    //         : []
+    // ): Promise<T.RageFW_ServerReturn<EventName>> {
+    //     return rpc.call(eventName, args)
+    // }
 }
 
-    private registerNative<EventName extends keyof IServerEvents>(
-        eventName: EventName,
-        callback: RageFW_ServerCallbackNative<EventName>,
-    ): void {
-        mp.events.add(
-            eventName,
-            (...args: Parameters<IServerEvents[EventName]>) =>
-                callback([...args]),
-        )
-    }
-
-    public register<EventName extends RageFW_ServerEvent>(
-        eventName: EventName,
-        callback: RageFW_ServerCallback<EventName>,
-    ): void {
-        if (this.isNativeEvent(eventName)) {
-            this.registerNative(
-                eventName,
-                callback as RageFW_ServerCallbackNative,
-            )
-        } else {
-            this.registerCustom(
-                eventName,
-                callback as unknown as RageFW_ServerCallbackCustom,
-            )
-        }
-    }
-
-    public registerMany<EventName extends RageFW_ServerEvent>(events: {
-        [event in EventName]: RageFW_ServerCallback<event>
-    }): void {
-        Object.entries<RageFW_ServerCallback<EventName>>(events).map(
-            ([eventName, callback]) => {
-                if (this.isNativeEvent(eventName)) {
-                    this.registerNative(
-                        eventName,
-                        callback as RageFW_ServerCallbackNative,
-                    )
-                } else {
-                    this.registerCustom(
-                        eventName as keyof RageFW_ICustomServerEvent,
-                        callback as unknown as RageFW_ServerCallbackCustom,
-                    )
-                }
-            },
-        )
-    }
-
-    private unregisterCustom<EventName extends keyof RageFW_ICustomServerEvent>(
-        eventName: EventName,
-    ): void {
-        this._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)
-        }
-    }
-
-    public trigger<EventName extends keyof RageFW_ICustomServerEvent>(
-        eventName: EventName,
-        ...args: _ServerEventHasArgs<EventName> extends true
-            ? [RageFW_ServerArgs<EventName>]
-            : []
-    ): Promise<RageFW_ServerReturn<EventName>> {
-        return this._rpc.call(eventName, args)
-    }
-}
+// new Server()
+//     .register('customServerEvent', async (a, b, c) => true)
+//     .unregister('customServerEvent')

server/src/index.ts

@@ -1,11 +1,24 @@
-import { Logger, Player, Server } from './core'
+import { Logger, Player, Server, rpc } from './core'
 
+export type { RageFW_MiddlewareFunction } from './types'
+
+/**
+ * Package used on a server-side of your Rage:MP Server
+ *
+ * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
+ */
 export const fw = {
+    /** Server-side interactions */
     event: new Server(),
+    /** Handles event manipulations that require player to be present in context */
     player: new Player(),
+    /** Handles functions used to interact with the client environment */
     system: {
+        /** Used to log in a server console */
         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,
 }
 
 fw.system.log.info(

server/src/types/browser.ts

@@ -1,18 +1,34 @@
-import type { RageFW_ICustomCefEvent } from 'rage-fw-shared-types'
+import type { RageFW_ICustomBrowserEvent } from '@entityseven/rage-fw-shared-types'
 
-export type RageFW_CefEvent = keyof RageFW_ICustomCefEvent
+/**
+ * Union of all available browser event names
+ * These only include custom events
+ */
+export type RageFW_BrowserEvent = keyof RageFW_ICustomBrowserEvent
 
-export type RageFW_CefArgs<K extends RageFW_CefEvent> = Parameters<
-    RageFW_ICustomCefEvent[K]
+/**
+ * Array of arguments of an event you pass as a generic
+ * These only include custom events
+ */
+export type RageFW_BrowserArgs<K extends RageFW_BrowserEvent> = Parameters<
+    RageFW_ICustomBrowserEvent[K]
 >
 
-export type RageFW_CefReturn<K extends RageFW_CefEvent> = ReturnType<
-    RageFW_ICustomCefEvent[K]
+/**
+ * Return type of event you pass as a generic
+ * These only include custom events
+ */
+export type RageFW_BrowserReturn<K extends RageFW_BrowserEvent> = ReturnType<
+    RageFW_ICustomBrowserEvent[K]
 >
 
-export type _CefEventHasArgs<EventName extends keyof RageFW_ICustomCefEvent> =
-    keyof RageFW_ICustomCefEvent extends never
+/**
+ *
+ */
+export type _BrowserEventHasArgs<
+    EventName extends keyof RageFW_ICustomBrowserEvent,
+> = keyof RageFW_ICustomBrowserEvent extends never
     ? false
-        : Parameters<RageFW_ICustomCefEvent[EventName]>[0] extends undefined
+    : Parameters<RageFW_ICustomBrowserEvent[EventName]>[0] extends undefined
       ? false
       : true

server/src/types/client.ts

@@ -1,6 +1,6 @@
 /// <reference types="@ragempcommunity/types-server" />
 
-import type { RageFW_ICustomClientEvent } from 'rage-fw-shared-types'
+import type { RageFW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
 
 /**
  * Union of all available client event names
@@ -12,7 +12,7 @@ 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_ServerClientArgs<K extends RageFW_ClientEvent> =
+export type RageFW_ClientArgs<K extends RageFW_ClientEvent> =
     K extends RageFW_ClientEvent
         ? Parameters<RageFW_ICustomClientEvent[K]>
         : never
@@ -21,11 +21,14 @@ export type RageFW_ServerClientArgs<K extends RageFW_ClientEvent> =
  * Return type of event you pass as a generic
  * These only include custom events
  */
-export type RageFW_ServerClientReturn<K extends RageFW_ClientEvent> =
+export type RageFW_ClientReturn<K extends RageFW_ClientEvent> =
     K extends RageFW_ClientEvent
         ? ReturnType<RageFW_ICustomClientEvent[K]>
         : never
 
+/**
+ *
+ */
 export type _ClientEventHasArgs<
     EventName extends keyof RageFW_ICustomClientEvent,
 > = keyof RageFW_ICustomClientEvent extends never

server/src/types/index.ts

@@ -1,3 +1,4 @@
-export * from './client'
-export * from './server'
 export * from './browser'
+export * from './client'
+export * from './middleware'
+export * from './server'

server/src/types/middleware.ts

@@ -0,0 +1,26 @@
+import type * as T from './server'
+
+export type RageFW_MiddlewareResponse =
+    | {
+          success: boolean
+          message?: string
+      }
+    | boolean
+
+export type RageFW_MiddlewareResponseInternal = {
+    success: boolean
+    message?: string
+    id?: number
+}
+
+export type RageFW_MiddlewareFunction<EventName extends T.RageFW_ServerEvent> =
+    (
+        ...args: T.RageFW_ServerArgs<EventName>
+    ) => Promise<RageFW_MiddlewareResponse>
+
+export type RageFW_MiddlewareOptions<EventName extends T.RageFW_ServerEvent> =
+    | RageFW_MiddlewareFunction<EventName>[]
+    | {
+          executables: RageFW_MiddlewareFunction<EventName>[]
+          onError: (error: string) => unknown
+      }

server/src/types/server.ts

@@ -3,8 +3,9 @@
 import type {
     RageFW_ICustomClientEvent,
     RageFW_ICustomServerEvent,
-} from 'rage-fw-shared-types'
-export type { RageFW_ICustomServerEvent } from 'rage-fw-shared-types'
+} from '@entityseven/rage-fw-shared-types'
+
+export type { RageFW_ICustomServerEvent } from '@entityseven/rage-fw-shared-types'
 
 /**
  * Union of all available server event names
@@ -20,20 +21,9 @@ export type RageFW_ServerEvent =
  */
 export type RageFW_ServerArgs<K extends RageFW_ServerEvent> =
     K extends keyof RageFW_ICustomServerEvent
-        ? Parameters<RageFW_ICustomServerEvent[K]>
+        ? [PlayerMp, ...Parameters<RageFW_ICustomServerEvent[K]>]
         : K extends keyof IServerEvents
-          ? Parameters<IServerEvents[K]>
-          : never
-
-/**
- * Callback (function) for an event, name of which you pass as a generic
- * These include system and custom events
- */
-export type RageFW_ServerCallback<K extends RageFW_ServerEvent> =
-    K extends keyof RageFW_ICustomServerEvent
-        ? RageFW_ServerCallbackCustom<K>
-        : K extends keyof IServerEvents
-          ? RageFW_ServerCallbackNative<K>
+          ? [PlayerMp, Parameters<IServerEvents[K]>]
           : never
 
 /**
@@ -45,28 +35,19 @@ export type RageFW_ServerReturn<K extends RageFW_ServerEvent> =
         ? ReturnType<RageFW_ICustomServerEvent[K]>
         : K extends keyof IServerEvents
           ? ReturnType<IServerEvents[K]>
-          : never
+          : void
 
 /**
- * Array of arguments for an event, name of which you pass as a generic
- * These only include custom events
+ * Callback (function) for an event, name of which you pass as a generic
+ * These include system and custom events
  */
-export type RageFW_ServerCallbackCustom<
-    K extends keyof RageFW_ICustomServerEvent = keyof RageFW_ICustomServerEvent,
-> = (
-    payload: [player: PlayerMp, ...args: RageFW_ServerArgs<K>],
+export type RageFW_ServerCallback<K extends RageFW_ServerEvent> = (
+    ...args: RageFW_ServerArgs<K>
 ) => Promise<RageFW_ServerReturn<K>>
 
 /**
- * Array of arguments for an event, name of which you pass as a generic
- * These only include system events
+ *
  */
-export type RageFW_ServerCallbackNative<
-    K extends keyof IServerEvents = keyof IServerEvents,
-> = (
-    payload: Parameters<IServerEvents[K]>,
-) => Promise<ReturnType<IServerEvents[K]>>
-
 export type _ServerEventHasArgs<EventName extends RageFW_ServerEvent> =
     EventName extends keyof RageFW_ICustomServerEvent
         ? keyof RageFW_ICustomClientEvent extends never

shared-types/LICENSE

@@ -0,0 +1,13 @@
+# Custom Attribution-NoDerivs Software License
+
+This license allows you to use, copy, and distribute the RageFW (the "Software"), including for commercial purposes, provided that the following conditions are met:
+
+1. **Attribution:** You must give appropriate credit to the original author of the Software, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
+
+2. **No Derivative Works:** You may not modify, transform, or build upon the Software.
+
+3. **Usage and Commercial Use:** You are allowed to use, sell, and gain income from projects that utilize the Software, as long as you comply with the terms of this license.
+
+4. **No Additional Restrictions:** You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

shared-types/package.json

@@ -1,12 +1,28 @@
 {
-    "name": "rage-fw-shared-types",
-    "version": "0.1.0",
+    "name": "@entityseven/rage-fw-shared-types",
+    "version": "0.2.0",
     "types": "types/types/index.d.ts",
     "files": [
-        "types/**/*"
+        "types/**/*",
+        "readme.md",
+        "LICENSE"
     ],
-    "author": "SashaGoncharov19",
-    "license": "MIT",
+    "description": "Package used among all environments of your Rage-FW based server",
+    "keywords": ["rage-fw-shared-types", "rage-fw-shared","ragefw", "rage-fw", "ragemp", "rage:mp", "rage", "gta5"],
     "type": "module",
-    "gitHead": "053e4fd12aa120d53e11e0d2009c0df78c1a2ad0"
+    "author": "Entity Seven Group",
+    "contributors": [
+        {
+            "name": "Danya H",
+            "email": "dev.rilaxik@gmail.com",
+            "url": "https://github.com/rilaxik/"
+        },
+        {
+            "name": "Oleksandr Honcharov",
+            "email": "0976053529@ukr.net",
+            "url": "https://github.com/SashaGoncharov19/"
+        }
+    ],
+    "license": "Custom-Attribution-NoDerivs",
+    "gitHead": "ffd542c1deddb3033e16e0dae7557313ae09b05f"
 }

shared-types/readme.md

@@ -1,2 +1,2 @@
 # RageFW Shared types
-[Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki/Docs)
+[Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki)

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

@@ -1,9 +1,14 @@
-declare module 'rage-fw-shared-types' {
-    export interface RageFW_ICustomServerEvent {}
+declare module '@entityseven/rage-fw-shared-types' {
+    export interface RageFW_ICustomServerEvent {
+        customServerEvent(arg1: string, arg2: number): boolean
+    }
 
     export interface RageFW_ICustomClientEvent {
         cefReady(): void
+        customClientEvent(arg1: string, arg2: number): boolean
     }
 
-    export interface RageFW_ICustomCefEvent {}
+    export interface RageFW_ICustomBrowserEvent {
+        customCefEvent(arg1: string, arg2: number): boolean
+    }
 }