upd cli

- handled process exit - updated docs + readme - typos fix
Merge remote-tracking branch 'origin/master'
2024-10-30 18:31:53 +00:00 · 2024-10-30 17:01:42 +00:00 · 2024-10-30 17:00:36 +00:00 · 2024-10-30 16:59:33 +00:00 · 2024-10-30 16:29:29 +00:00 · 2024-10-30 16:21:29 +00:00
44 changed files with 9349 additions and 6386 deletions
@@ -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
@@ -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.
@@ -1,29 +1,45 @@
 {
-    "name": "@entityseven/rage-fw-browser",
-    "version": "0.1.2",
-    "main": "dist/index.js",
-    "types": "dist/src/index.d.ts",
-    "files": [
-        "dist/**/*",
-        "readme.md"
-    ],
-    "scripts": {
-        "build": "tsup"
+  "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": "[email protected]",
+      "url": "https://github.com/rilaxik/"
    },
-    "dependencies": {
-        "@entityseven/rage-fw-rpc": "latest"
-    },
-    "peerDependencies": {
-        "@ragempcommunity/types-cef": "^2.1.8",
-        "@entityseven/rage-fw-shared-types": "workspace:^"
-    },
-    "description": "RageFW CEF side",
-    "keywords": [],
-    "author": "SashaGoncharov19",
-    "contributors": [{
-        "name": "rilaxik",
-        "email": "[email protected]",
-        "url": "https://github.com/rilaxik"
-    }],
-    "license": "MIT"
+    {
+      "name": "Oleksandr Honcharov",
+      "email": "[email protected]",
+      "url": "https://github.com/SashaGoncharov19/"
+    }
+  ],
+  "license": "Custom-Attribution-NoDerivs",
+  "gitHead": "ffd542c1deddb3033e16e0dae7557313ae09b05f"
 }
@@ -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)
@@ -7,21 +7,43 @@ import {
    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>,
@@ -37,6 +59,18 @@ export class Browser extends Helper {
        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 {
@@ -45,6 +79,25 @@ export class Browser extends Helper {
        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
@@ -60,6 +113,25 @@ export class Browser extends Helper {
        >(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
@@ -75,6 +147,25 @@ export class Browser extends Helper {
        >(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
@@ -1,7 +1,6 @@
 import { Rpc } from '@entityseven/rage-fw-rpc'

 export const rpc = new Rpc({
-    forceBrowserDevMode:
-        process.env.RageFW_forceBrowserDevMode === 'true' ?? false,
+    forceBrowserDevMode: process.env.RageFW_forceBrowserDevMode === 'true',
    debugLogs: false,
 })
@@ -1,7 +1,14 @@
 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 () => {
@@ -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.
@@ -1,19 +1,20 @@
 {
    "name": "@entityseven/create-rage-fw",
-    "version": "0.1.1",
+    "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": "[email protected]",
+            "url": "https://github.com/rilaxik/"
+        }
+    ],
    "license": "MIT"
 }
@@ -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/)
+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/)

 ``pnpm create @entityseven/rage-fw@latest``

-## TL;DR
+``bun create @entityseven/rage-fw@latest``
+
+# 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
- ``Enter project name`` 
+## Initialize new project
+Using this option will forward you to common project creation menu

-This option will specify a name for your project which is used as a folder name too. Defaults to **rage-fw**
+- ``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**

- ``Select frontend``
+- ``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

-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)**
+## Test our RPC
+Using this option will forward you to common project creation menu

-### Install Rage:MP updater
-This option will simplify installation process of Rage:MP server files required to start your server
+- ``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**
+
+- ``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
@@ -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'))
        })
 }
@@ -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'))
        })
 }
@@ -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'))
    }
 })()
@@ -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.
@@ -1,30 +1,38 @@
 {
    "name": "@entityseven/rage-fw-client",
-    "version": "0.1.2",
+    "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": {
-        "@entityseven/rage-fw-rpc": "latest"
+        "@entityseven/rage-fw-rpc": "0.2.5"
    },
    "peerDependencies": {
-        "@ragempcommunity/types-client": "^2.1.8",
-        "@entityseven/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",
-        "email": "[email protected]",
-        "url": "https://github.com/rilaxik"
-    }],
-    "license": "MIT",
-    "gitHead": "053e4fd12aa120d53e11e0d2009c0df78c1a2ad0"
+    "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": "[email protected]",
+            "url": "https://github.com/rilaxik/"
+        },
+        {
+            "name": "Oleksandr Honcharov",
+            "email": "[email protected]",
+            "url": "https://github.com/SashaGoncharov19/"
+        }
+    ],
+    "license": "Custom-Attribution-NoDerivs",
+    "gitHead": "ffd542c1deddb3033e16e0dae7557313ae09b05f"
 }
@@ -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)
@@ -1,20 +1,77 @@
 import { rpc } from './rpc'
+import { Middleware } from './middleware'
 import type * as T from '../types'

+/** Client-side interactions */
 export class Client {
+    /**
+     * 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: T.RageFW_ClientCallback<EventName>,
+        options?: {
+            middlewares?: T.RageFW_MiddlewareOptions<EventName>
+        },
    ): Client {
        rpc.register<
            Parameters<typeof callback>,
-            ReturnType<typeof callback>,
+            ReturnType<typeof callback> | Promise<unknown>,
            EventName
-        >(eventName, async (...data) => await callback(...data))
+        >(eventName, async (...data) => {
+            if (!options?.middlewares) return await callback(...data)
+
+            await Middleware.process(options.middlewares, callback, data)
+        })

        return this
    }

+    /**
+     * 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,
    ): Client {
@@ -1,4 +1,5 @@
 export * from './client'
 export * from './logger'
+export * from './middleware'
 export * from './player'
 export * from './rpc'
@@ -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(' ')}`,
        )
    }
 }
@@ -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',
+                )
+            }
+        }
+    }
+}
@@ -1,14 +1,37 @@
 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 _browser: BrowserMp | undefined = undefined

+    /**
+     * Setter. Also shares browser with ``rage-fw-rpc``
+     */
    set browser(browser: BrowserMp) {
        this._browser = browser
        rpc.browser = browser
    }

+    /**
+     * 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: T._ClientEventHasArgs<EventName> extends true
@@ -22,6 +45,25 @@ export class Player {
        >(eventName, args)
    }

+    /**
+     * 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: T._ServerEventHasArgs<EventName> extends true
@@ -35,6 +77,25 @@ export class Player {
        >(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
@@ -1,10 +1,22 @@
 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,
 }
@@ -1,3 +1,4 @@
-export * from './client'
-export * from './server'
 export * from './browser'
+export * from './client'
+export * from './middleware'
+export * from './server'
@@ -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
+      }
@@ -1,5 +1,5 @@
 {
    "$schema": "node_modules/lerna/schemas/lerna-schema.json",
-    "version": "0.2.5",
+    "version": "0.2.1-0.2.0-alpha.2.0",
    "npmClient": "pnpm"
 }
@@ -1,14 +1,13 @@
 {
-  "private": true,
  "scripts": {
    "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",
@@ -26,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": "[email protected]",
+      "url": "https://github.com/rilaxik/"
+    },
+    {
+      "name": "Oleksandr Honcharov",
+      "email": "[email protected]",
+      "url": "https://github.com/SashaGoncharov19/"
+    }
+  ]
 }
@@ -1,42 +1,44 @@
 {
-    "name": "@entityseven/rage-fw-rpc",
-    "description": "Rage FW RPC",
-    "version": "0.2.5",
-    "scripts": {
-        "build": "tsup",
-        "start": "npx ./dist create"
-    },
-    "files": [
-        "dist/**/*"
-    ],
-    "devDependencies": {
-        "@microsoft/api-extractor": "^7.47.9",
-        "prettier": "^3.3.2",
-        "tsup": "^8.3.0"
-    },
-    "peerDependencies": {
-        "typescript": "^5"
-    },
-    "keywords": [
-        "ragemp",
-        "rage",
-        "rpc",
-        "rage-rpc",
-        "ragerpc"
-    ],
-    "main": "dist/index.js",
-    "types": "dist/src/index.d.ts",
-    "author": {
-        "name": "rilaxik",
-        "email": "[email protected]",
-        "url": "https://github.com/rilaxik"
-    },
-    "contributors": [
-        {
-            "name": "SashaGoncharov19",
-            "url": "https://github.com/SashaGoncharov19"
-        }
-    ],
-    "license": "MIT",
-    "gitHead": "04eb7240735c4a0e4855ebabbe8d5b326819fa76"
+  "name": "@entityseven/rage-fw-rpc",
+  "version": "0.2.5",
+  "main": "dist/index.js",
+  "types": "dist/src/index.d.ts",
+  "scripts": {
+    "build": "tsup",
+    "start": "npx ./dist create"
+  },
+  "files": [
+    "dist/**/*",
+    "readme.md",
+    "LICENSE"
+  ],
+  "devDependencies": {
+    "@microsoft/api-extractor": "^7.47.9",
+    "prettier": "^3.3.2",
+    "tsup": "^8.3.0"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "description": "Rage-FW RPC (Remote procedure caller) for Rage:MP",
+  "keywords": [
+    "ragefw",
+    "rage-fw",
+    "ragemp",
+    "rage",
+    "rpc",
+    "rage-rpc",
+    "ragerpc",
+    "gta5"
+  ],
+  "author": "Entity Seven Group",
+  "contributors": [
+    {
+      "name": "Danya H",
+      "email": "[email protected]",
+      "url": "https://github.com/rilaxik/"
+    }
+  ],
+  "license": "MIT",
+  "gitHead": "04eb7240735c4a0e4855ebabbe8d5b326819fa76"
 }
@@ -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:
@@ -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.
@@ -1,30 +1,38 @@
 {
    "name": "@entityseven/rage-fw-server",
-    "version": "0.1.2",
+    "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": {
-        "@entityseven/rage-fw-rpc": "latest"
+        "@entityseven/rage-fw-rpc": "0.2.5"
    },
    "peerDependencies": {
-        "@ragempcommunity/types-server": "^2.1.8",
-        "@entityseven/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",
-        "email": "[email protected]",
-        "url": "https://github.com/rilaxik"
-    }],
-    "license": "MIT",
-    "gitHead": "053e4fd12aa120d53e11e0d2009c0df78c1a2ad0"
+    "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": "[email protected]",
+            "url": "https://github.com/rilaxik/"
+        },
+        {
+            "name": "Oleksandr Honcharov",
+            "email": "[email protected]",
+            "url": "https://github.com/SashaGoncharov19/"
+        }
+    ],
+    "license": "Custom-Attribution-NoDerivs",
+    "gitHead": "ffd542c1deddb3033e16e0dae7557313ae09b05f"
 }
@@ -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)
@@ -1,4 +1,5 @@
 export * from './logger'
+export * from './middleware'
 export * from './player'
 export * from './rpc'
 export * from './server'
@@ -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(' '))
    }
@@ -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',
+                )
+            }
+        }
+    }
+}
@@ -1,7 +1,28 @@
 import { rpc } from './rpc'
 import type * as T from '../types'

+/** Handles event manipulations that require player to be present in context */
 export class Player {
+    /**
+     * 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,
@@ -12,6 +33,26 @@ export class Player {
        return await rpc.callClient(player, eventName, args)
    }

+    /**
+     * 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,
@@ -1,20 +1,77 @@
 import { rpc } from './rpc'
+import { Middleware } from './middleware'
 import type * as T from '../types'

+/** Server-side interactions */
 export class Server {
+    /**
+     * 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: T.RageFW_ServerCallback<EventName>,
+        options?: {
+            middlewares?: T.RageFW_MiddlewareOptions<EventName>
+        },
    ): Server {
        rpc.register<
            Parameters<typeof callback>,
-            ReturnType<typeof callback>,
+            ReturnType<typeof callback> | Promise<unknown>,
            EventName
-        >(eventName, async (...data) => await callback(...data))
+        >(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 {
@@ -1,11 +1,23 @@
 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,
 }

@@ -1,3 +1,4 @@
-export * from './client'
-export * from './server'
 export * from './browser'
+export * from './client'
+export * from './middleware'
+export * from './server'
@@ -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
+      }
@@ -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.
@@ -1,12 +1,28 @@
 {
    "name": "@entityseven/rage-fw-shared-types",
-    "version": "0.1.2",
+    "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": "[email protected]",
+            "url": "https://github.com/rilaxik/"
+        },
+        {
+            "name": "Oleksandr Honcharov",
+            "email": "[email protected]",
+            "url": "https://github.com/SashaGoncharov19/"
+        }
+    ],
+    "license": "Custom-Attribution-NoDerivs",
+    "gitHead": "ffd542c1deddb3033e16e0dae7557313ae09b05f"
 }
@@ -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)
Author	SHA1	Message	Date
rilaxik	495217ecd5	upd cli - handled process exit - updated docs + readme - typos fix	2024-10-30 18:31:53 +00:00
rilaxik	7e43e0d106	Merge remote-tracking branch 'origin/master' # Conflicts: # cli/package.json # rpc/package.json	2024-10-30 17:01:42 +00:00
rilaxik	2f1d1d9f0d	hotfix - licenses - package.json consistency - links bump	2024-10-30 17:00:36 +00:00
rilaxik	cc40d90070	hotfix - licenses - package.json consistency - links bump	2024-10-30 16:59:33 +00:00
rilaxik	469d970654	Merge branch 'dev'	2024-10-30 16:29:29 +00:00
rilaxik	217e0ddf01	Merge pull request 'Server/Client middlewares + JSDoc' (#6 ) from unstable into dev Reviewed-on: #6	2024-10-30 16:21:29 +00:00
rilaxik	ea572070ef	versions rollback	2024-10-30 16:21:03 +00:00
rilaxik	7308fc26e0	v0.2.1-0.2.0-alpha.2.0	2024-10-30 16:18:08 +00:00
rilaxik	ffd542c1de	v0.2.1-0.2.0-alpha.1.0	2024-10-30 16:17:28 +00:00
rilaxik	914300924a	v0.2.0	2024-10-30 16:16:45 +00:00
rilaxik	bc295a777b	jsdoc	2024-10-30 15:38:06 +00:00
rilaxik	cd27764a30	jsdoc	2024-10-30 15:27:22 +00:00
rilaxik	30d125ce8e	version bump	2024-10-29 17:06:14 +00:00
rilaxik	622676d189	feat core - server/client middlewares	2024-10-29 17:03:07 +00:00
rilaxik	c2684a48fc	Merge pull request 'Rpc integration + type fixes' (#3 ) from dev into master Reviewed-on: #3	2024-10-28 12:13:19 +00:00
sashagoncharov19	0059a41d0d	Update readme.md	2024-06-17 03:47:57 +00:00
rilaxik	cc1ebbd66b	quickfix issue template had extra optional label	2024-06-15 14:54:07 +01:00
sashagoncharov19	301a65e77f	v0.1.0 Reviewed-on: #2	2024-06-15 13:50:13 +00:00