Compare commits

..

No commits in common. "dev" and "master" have entirely different histories.
dev ... master

68 changed files with 9248 additions and 5168 deletions

View File

@ -1,8 +0,0 @@
# Changesets
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
with multi-package repos, or single-package repos to help you version and publish your code. You can
find the full documentation for it [in our repository](https://github.com/changesets/changesets)
We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

View File

@ -1,13 +0,0 @@
{
"$schema": "https://unpkg.com/@changesets/config@3.0.5/schema.json",
"changelog": "@changesets/cli/changelog",
"commit": false,
"fixed": [
["@entityseven/rage-fw-browser","@entityseven/rage-fw-client","@entityseven/rage-fw-server"]
],
"linked": [],
"access": "public",
"baseBranch": "master",
"updateInternalDependencies": "patch",
"ignore": []
}

31
.eslintrc.yaml Normal file
View File

@ -0,0 +1,31 @@
env:
node: true
es6: true
es2019: true
extends:
- 'eslint:recommended'
- 'plugin:@typescript-eslint/recommended'
# - 'prettier'
parser: '@typescript-eslint/parser'
parserOptions:
ecmaVersion: '2019'
sourceType: 'script'
plugins:
- '@typescript-eslint'
ignorePatterns:
- 'node_modules'
rules: {
'@typescript-eslint/no-explicit-any': 'off',
'@typescript-eslint/no-unused-vars': [
'warn',
{
"argsIgnorePattern": '^_',
"varsIgnorePattern": '^_',
"caughtErrorsIgnorePattern": '^_'
}
],
'@typescript-eslint/ban-ts-comment': 'off',
'@typescript-eslint/ban-types': 'off',
'consistent-return': 'warn',
'no-empty': 'off',
}

1
.gitignore vendored
View File

@ -2,4 +2,3 @@
node_modules node_modules
dist dist
.nx/cache

View File

@ -1,33 +0,0 @@
{
"dependencyTypes": ["prod", "peer", "dev"],
"versionGroups": [
{
"label": "Ensure @ragempcommunity/types-* always match",
"packages": ["**"],
"dependencies": ["@ragempcommunity/types-cef","@ragempcommunity/types-client", "@ragempcommunity/types-server"],
"pinVersion": "sameRange",
"range": "^"
},
{
"label": "Use workspace protocol when developing local packages",
"packages": ["**"],
"dependencies": ["@entityseven/rage-fw-shared-types", "@entityseven/rage-fw-rpc"]
"pinVersion": "workspace:*",
"range": ""
},
{
"label": "Ensure @types/node match same version (for tsup)",
"packages": ["**"],
"dependencies": ["@types/node"],
"pinVersion": "sameRange",
"range": ""
},
{
"label": "Ensure newest breaking Typescript version",
"packages": ["**"],
"dependencies": ["typescript"],
"pinVersion": "sameRange",
"range": "^"
}
]
}

View File

@ -1,4 +1,4 @@
# Custom Attribution-NoDerives Software License # 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: This license allows you to use, copy, and distribute the RageFW (the "Software"), including for commercial purposes, provided that the following conditions are met:

View File

@ -1,4 +1,4 @@
Custom Attribution-NoDerives Software License Custom Attribution-NoDerivs Software License
Copyright (c) 2024 Entity Seven Group Copyright (c) 2024 Entity Seven Group

View File

@ -1,38 +1,22 @@
{ {
"private": false,
"name": "@entityseven/rage-fw-browser", "name": "@entityseven/rage-fw-browser",
"version": "0.2.0", "version": "0.2.0",
"main": "dist/index.js",
"types": "dist/src/index.d.ts",
"files": [ "files": [
"dist/**/*", "dist/**/*",
"readme.md", "readme.md",
"LICENSE", "LICENSE"
"package.json"
], ],
"main": "src/index.ts",
"exports": {
".": "./src/index.ts"
},
"publishConfig": {
"access": "public",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"exports": {
".": "./dist/index.js"
}
},
"scripts": { "scripts": {
"build": "tsup" "build": "tsup"
}, },
"dependencies": { "dependencies": {
"@entityseven/rage-fw-rpc": "workspace:*" "@entityseven/rage-fw-rpc": "0.2.5"
},
"devDependencies": {
"@types/node": "22.12.0"
}, },
"peerDependencies": { "peerDependencies": {
"@entityseven/rage-fw-shared-types": "workspace:*", "@entityseven/rage-fw-shared-types": "0.2.0",
"@ragempcommunity/types-cef": "^2.1.8", "@ragempcommunity/types-cef": "^2.1.8"
"typescript": "^5.7.3"
}, },
"description": "Package used on a browser-side of your Rage:MP Server", "description": "Package used on a browser-side of your Rage:MP Server",
"keywords": [ "keywords": [

View File

@ -1,9 +1,14 @@
import { FW_Helper } from './helper' import { Helper } from './helper'
import { rpc } from './rpc' import { rpc } from './rpc'
import type * as T from '../types' import type * as T from '../types'
import {
RageFW_BrowserEvent,
RageFW_ClientEvent,
RageFW_ServerEvent,
} from '../types'
/** Browser-side interactions */ /** Browser-side interactions */
export class FW_Browser extends FW_Helper { export class Browser extends Helper {
constructor() { constructor() {
super() super()
} }
@ -29,7 +34,7 @@ export class FW_Browser extends FW_Helper {
* *
* @param eventName - The name of the event to register * @param eventName - The name of the event to register
* @param callback - The callback function to be executed when the event is triggered * @param callback - The callback function to be executed when the event is triggered
* @returns {FW_Browser} The current browser instance, enabling method chaining * @returns {Browser} The current browser instance, enabling method chaining
* *
* @example * @example
* // Registering an event * // Registering an event
@ -39,10 +44,10 @@ export class FW_Browser extends FW_Helper {
* *
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki} * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/ */
public register<EventName extends T.FW_BrowserEvent>( public register<EventName extends T.RageFW_BrowserEvent>(
eventName: EventName, eventName: EventName,
callback: T.FW_BrowserCallback<EventName>, callback: T.RageFW_BrowserCallback<EventName>,
): FW_Browser { ): Browser {
this.log_('register', eventName, callback) this.log_('register', eventName, callback)
rpc.register< rpc.register<
@ -58,7 +63,7 @@ export class FW_Browser extends FW_Helper {
* Unregisters a browser event, removing the associated callback * Unregisters a browser event, removing the associated callback
* *
* @param eventName - The name of the event to unregister * @param eventName - The name of the event to unregister
* @returns {FW_Browser} The current browser instance, enabling method chaining * @returns {Browser} The current browser instance, enabling method chaining
* *
* @example * @example
* // Unregistering an event * // Unregistering an event
@ -66,51 +71,21 @@ export class FW_Browser extends FW_Helper {
* *
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki} * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/ */
public unregister<EventName extends T.FW_BrowserEvent>( public unregister<EventName extends T.RageFW_BrowserEvent>(
eventName: EventName, eventName: EventName,
): FW_Browser { ): Browser {
rpc.unregister<EventName>(eventName) rpc.unregister<EventName>(eventName)
return this return this
} }
/** /**
* Triggers a browser event from the browser with arguments from 'rage-fw-shared-types' * Triggers a browser event from the browser with arguments from shared types
* *
* Formerly known as ``call`` or ``emit`` * Formerly known as ``call`` or ``emit``
* *
* @param eventName - The name of the browser event to trigger * @param eventName - The name of the browser event to trigger
* @param [args] - Arguments for the browser event, if present * @param [args] - Arguments for the browser event, if present
* @returns {void}
*
* @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 trigger<EventName extends T.FW_BrowserEvent>(
eventName: EventName,
...args: T._BrowserEventHasArgs<EventName> extends true
? [T.FW_BrowserArgs<EventName>]
: []
): void {
this.log_('[RPC](trigger):', eventName, ...args)
rpc.call<typeof args, EventName>(eventName, args)
}
/**
* Triggers an asynchronous browser event from the browser with arguments from 'rage-fw-shared-types', and expects to receive a response from an event
*
* Formerly known as ``callAsync`` or ``emitAsync``
*
* @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 * @returns {Promise} resolving to the browser's response for the event
* *
* @example * @example
@ -123,58 +98,28 @@ export class FW_Browser extends FW_Helper {
* *
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki} * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/ */
public async triggerAsync<EventName extends T.FW_BrowserEvent>( public async trigger<EventName extends T.RageFW_BrowserEvent>(
eventName: EventName, eventName: EventName,
...args: T._BrowserEventHasArgs<EventName> extends true ...args: T._BrowserEventHasArgs<EventName> extends true
? [T.FW_BrowserArgs<EventName>] ? [T.RageFW_BrowserArgs<EventName>]
: [] : []
): Promise<T.FW_BrowserReturn<EventName>> { ): Promise<T.RageFW_BrowserReturn<EventName>> {
this.log_('[RPC](trigger):', eventName, ...args) this.log_('[RPC](trigger):', eventName, ...args)
return await rpc.callAsync< return await rpc.call<
typeof args, typeof args,
EventName, EventName,
T.FW_BrowserReturn<EventName> T.RageFW_BrowserReturn<EventName>
>(eventName, args) >(eventName, args)
} }
/** /**
* Triggers a server event from the browser with arguments from 'rage-fw-shared-types' * Triggers a server event from the browser with arguments from shared types
* *
* Formerly known as ``callServer`` or ``emitServer`` * Formerly known as ``callServer`` or ``emitServer``
* *
* @param eventName - The name of the server event to trigger * @param eventName - The name of the server event to trigger
* @param [args] - Arguments for the server event, if present * @param [args] - Arguments for the server event, if present
* @returns {void}
*
* @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 triggerServer<EventName extends T.FW_ServerEvent>(
eventName: EventName,
...args: T._ServerEventHasArgs<EventName> extends true
? [T.FW_ServerArgs<EventName>]
: []
): void {
this.log_('[RPC](triggerServer):', eventName, ...args)
rpc.callServer<typeof args, EventName>(eventName, args)
}
/**
* Triggers an asynchronous server event from the browser with arguments from 'rage-fw-shared-types', and expects to receive a response from an event
*
* Formerly known as ``callServerAsync`` or ``emitServerAsync``
*
* @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 * @returns {Promise} resolving to the server's response for the event
* *
* @example * @example
@ -187,58 +132,28 @@ export class FW_Browser extends FW_Helper {
* *
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki} * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/ */
public async triggerServerAsync<EventName extends T.FW_ServerEvent>( public async triggerServer<EventName extends T.RageFW_ServerEvent>(
eventName: EventName, eventName: EventName,
...args: T._ServerEventHasArgs<EventName> extends true ...args: T._ServerEventHasArgs<EventName> extends true
? [T.FW_ServerArgs<EventName>] ? [T.RageFW_ServerArgs<EventName>]
: [] : []
): Promise<T.FW_ServerReturn<EventName>> { ): Promise<T.RageFW_ServerReturn<EventName>> {
this.log_('[RPC](triggerServer):', eventName, ...args) this.log_('[RPC](triggerServer):', eventName, ...args)
return await rpc.callServerAsync< return await rpc.callServer<
typeof args, typeof args,
EventName, EventName,
T.FW_ServerReturn<EventName> T.RageFW_ServerReturn<EventName>
>(eventName, args) >(eventName, args)
} }
/** /**
* Triggers a browser event from the browser with arguments from 'rage-fw-shared-types' * Triggers a client event from the browser with arguments from shared types
* *
* Formerly known as ``callClient`` or ``emitClient`` * Formerly known as ``callClient`` or ``emitClient``
* *
* @param eventName - The name of the client event to trigger * @param eventName - The name of the client event to trigger
* @param [args] - Arguments for the client event, if present * @param [args] - Arguments for the client event, if present
* @returns {void}
*
* @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 triggerClient<EventName extends T.FW_ClientEvent>(
eventName: EventName,
...args: T._ClientEventHasArgs<EventName> extends true
? [T.FW_ClientArgs<EventName>]
: []
): void {
this.log_('[RPC](triggerClient):', eventName, ...args)
rpc.callClient<typeof args, EventName>(eventName, args)
}
/**
* Triggers an asynchronous client event from the browser with arguments from 'rage-fw-shared-types', and expects to receive a response from an event
*
* Formerly known as ``callClientAsync`` or ``emitClientAsync``
*
* @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 * @returns {Promise} resolving to the client's response for the event
* *
* @example * @example
@ -251,18 +166,22 @@ export class FW_Browser extends FW_Helper {
* *
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki} * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/ */
public async triggerClientAsync<EventName extends T.FW_ClientEvent>( public async triggerClient<EventName extends T.RageFW_ClientEvent>(
eventName: EventName, eventName: EventName,
...args: T._ClientEventHasArgs<EventName> extends true ...args: T._ClientEventHasArgs<EventName> extends true
? [T.FW_ClientArgs<EventName>] ? [T.RageFW_ClientArgs<EventName>]
: [] : []
): Promise<T.FW_ClientReturn<EventName>> { ): Promise<T.RageFW_ClientReturn<EventName>> {
this.log_('[RPC](triggerClient):', eventName, ...args) this.log_('[RPC](triggerClient):', eventName, ...args)
return await rpc.callClientAsync< return await rpc.callClient<
typeof args, typeof args,
EventName, EventName,
T.FW_ClientReturn<EventName> T.RageFW_ClientReturn<EventName>
>(eventName, args) >(eventName, args)
} }
} }
// new Browser()
// .register('customCefEvent', async (a, b) => true)
// .triggerServer('customServerEvent', ['', 1])

View File

@ -1,4 +1,4 @@
export class FW_Helper { export class Helper {
protected debugLogs_: boolean = false protected debugLogs_: boolean = false
protected customLogger_: protected customLogger_:
| undefined | undefined

View File

@ -1,4 +1,4 @@
import { FW_Browser, rpc } from './core' import { Browser, rpc } from './core'
/** /**
* Package used on a browser-side of your Rage:MP Server * Package used on a browser-side of your Rage:MP Server
@ -7,7 +7,10 @@ import { FW_Browser, rpc } from './core'
*/ */
export const fw = { export const fw = {
/** Browser-side interactions */ /** Browser-side interactions */
event: new FW_Browser(), 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 */ /** ``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, rpc,
} }
;(async () => {
await fw.event.triggerClient('cefReady')
})()

View File

@ -1,41 +1,40 @@
import type { FW_ICustomBrowserEvent } from '@entityseven/rage-fw-shared-types' import type { RageFW_ICustomBrowserEvent } from '@entityseven/rage-fw-shared-types'
export type { FW_ICustomBrowserEvent } from '@entityseven/rage-fw-shared-types' export type { RageFW_ICustomBrowserEvent } from '@entityseven/rage-fw-shared-types'
/** /**
* Union of all available browser event names * Union of all available browser event names
* These only include custom events * These only include custom events
*/ */
export type FW_BrowserEvent = keyof FW_ICustomBrowserEvent export type RageFW_BrowserEvent = keyof RageFW_ICustomBrowserEvent
/** /**
* Array of arguments of an event you pass as a generic * Array of arguments of an event you pass as a generic
* These only include custom browser events * These only include custom browser events
*/ */
export type FW_BrowserArgs<K extends FW_BrowserEvent> = Parameters< export type RageFW_BrowserArgs<K extends RageFW_BrowserEvent> = Parameters<
FW_ICustomBrowserEvent[K] RageFW_ICustomBrowserEvent[K]
> >
/** /**
* Return type of event you pass as a generic * Return type of event you pass as a generic
* These only include custom browser events * These only include custom browser events
*/ */
export type FW_BrowserReturn<K extends FW_BrowserEvent> = ReturnType< export type RageFW_BrowserReturn<K extends RageFW_BrowserEvent> = ReturnType<
FW_ICustomBrowserEvent[K] RageFW_ICustomBrowserEvent[K]
> >
/** /**
* Callback (function) of event you pass as a generic * Callback (function) of event you pass as a generic
* These only include custom browser events * These only include custom browser events
*/ */
export type FW_BrowserCallback<K extends keyof FW_ICustomBrowserEvent> = ( export type RageFW_BrowserCallback<K extends keyof RageFW_ICustomBrowserEvent> =
...args: FW_BrowserArgs<K> (...args: RageFW_BrowserArgs<K>) => Promise<RageFW_BrowserReturn<K>>
) => Promise<FW_BrowserReturn<K>>
export type _BrowserEventHasArgs< export type _BrowserEventHasArgs<
EventName extends keyof FW_ICustomBrowserEvent, EventName extends keyof RageFW_ICustomBrowserEvent,
> = keyof FW_ICustomBrowserEvent extends never > = keyof RageFW_ICustomBrowserEvent extends never
? false ? false
: Parameters<FW_ICustomBrowserEvent[EventName]>[0] extends undefined : Parameters<RageFW_ICustomBrowserEvent[EventName]>[0] extends undefined
? false ? false
: true : true

View File

@ -1,32 +1,33 @@
import type { FW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types' import type { RageFW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
export type { FW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types' export type { RageFW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
/** /**
* Union of all available client event names * Union of all available client event names
* These only include custom events and some internals for RageFW * These only include custom events and some extras from RageFW
*/ */
export type FW_ClientEvent = keyof FW_ICustomClientEvent export type RageFW_ClientEvent = keyof RageFW_ICustomClientEvent
/** /**
* Array of arguments of event you pass as a generic * Array of arguments of event you pass as a generic
* These only include custom client events * These only include custom client events
*/ */
export type FW_ClientArgs<K extends FW_ClientEvent> = Parameters< export type RageFW_ClientArgs<K extends RageFW_ClientEvent> = Parameters<
FW_ICustomClientEvent[K] RageFW_ICustomClientEvent[K]
> >
/** /**
* Return type of event you pass as a generic * Return type of event you pass as a generic
* These only include custom client events * These only include custom client events
*/ */
export type FW_ClientReturn<K extends FW_ClientEvent> = ReturnType< export type RageFW_ClientReturn<K extends RageFW_ClientEvent> = ReturnType<
FW_ICustomClientEvent[K] RageFW_ICustomClientEvent[K]
> >
export type _ClientEventHasArgs<EventName extends keyof FW_ICustomClientEvent> = export type _ClientEventHasArgs<
keyof FW_ICustomClientEvent extends never EventName extends keyof RageFW_ICustomClientEvent,
> = keyof RageFW_ICustomClientEvent extends never
? false ? false
: Parameters<FW_ICustomClientEvent[EventName]>[0] extends undefined : Parameters<RageFW_ICustomClientEvent[EventName]>[0] extends undefined
? false ? false
: true : true

View File

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

View File

@ -1,32 +1,33 @@
import type { FW_ICustomServerEvent } from '@entityseven/rage-fw-shared-types' import type { RageFW_ICustomServerEvent } from '@entityseven/rage-fw-shared-types'
export type { FW_ICustomServerEvent } from '@entityseven/rage-fw-shared-types' export type { RageFW_ICustomServerEvent } from '@entityseven/rage-fw-shared-types'
/** /**
* Union of all available server event names * Union of all available server event names
* These only include custom events * These only include custom events
*/ */
export type FW_ServerEvent = keyof FW_ICustomServerEvent export type RageFW_ServerEvent = keyof RageFW_ICustomServerEvent
/** /**
* Array of arguments of event you pass as a generic * Array of arguments of event you pass as a generic
* These only include custom server events * These only include custom server events
*/ */
export type FW_ServerArgs<K extends FW_ServerEvent> = Parameters< export type RageFW_ServerArgs<K extends RageFW_ServerEvent> = Parameters<
FW_ICustomServerEvent[K] RageFW_ICustomServerEvent[K]
> >
/** /**
* Return type of event you pass as a generic * Return type of event you pass as a generic
* These only include custom server events * These only include custom server events
*/ */
export type FW_ServerReturn<K extends FW_ServerEvent> = ReturnType< export type RageFW_ServerReturn<K extends RageFW_ServerEvent> = ReturnType<
FW_ICustomServerEvent[K] RageFW_ICustomServerEvent[K]
> >
export type _ServerEventHasArgs<EventName extends keyof FW_ICustomServerEvent> = export type _ServerEventHasArgs<
keyof FW_ICustomServerEvent extends never EventName extends keyof RageFW_ICustomServerEvent,
> = keyof RageFW_ICustomServerEvent extends never
? false ? false
: Parameters<FW_ICustomServerEvent[EventName]>[0] extends undefined : Parameters<RageFW_ICustomServerEvent[EventName]>[0] extends undefined
? false ? false
: true : true

View File

@ -1,8 +1,25 @@
{ {
"$schema": "https://json.schemastore.org/tsconfig", "$schema": "https://json.schemastore.org/tsconfig",
"display": "Browser", "display": "Base",
"exclude": [
"node_modules"
],
"compilerOptions": { "compilerOptions": {
"types": ["./node_modules/@ragempcommunity/types-cef/index.d.ts", "node"] "incremental": false,
}, "composite": false,
"extends": ["../tsconfig.ragefw.json"] "target": "ES2022",
"experimentalDecorators": true,
"moduleDetection": "auto",
"module": "CommonJS",
"resolveJsonModule": true,
"declaration": false,
"declarationMap": false,
"sourceMap": false,
"downlevelIteration": false,
"inlineSourceMap": false,
"esModuleInterop": true,
"forceConsistentCasingInFileNames": true,
"strict": true,
"skipLibCheck": true
}
} }

View File

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

View File

@ -13,8 +13,7 @@
"scripts": { "scripts": {
"watch": "tsc -w", "watch": "tsc -w",
"build": "tsup", "build": "tsup",
"start": "npx ./dist create", "start": "npx ./dist create"
"install": "pnpm install --ignore-workspace"
}, },
"dependencies": { "dependencies": {
"@inquirer/prompts": "^5.0.5", "@inquirer/prompts": "^5.0.5",
@ -23,12 +22,12 @@
"yargs": "^17.7.2" "yargs": "^17.7.2"
}, },
"devDependencies": { "devDependencies": {
"@types/node": "^22.12.0", "@types/node": "^20.14.2",
"@types/yargs": "^17.0.32", "@types/yargs": "^17.0.32",
"prettier": "^3.3.2", "prettier": "^3.3.2",
"typescript": "^5.7.3" "typescript": "^5.4.5"
}, },
"description": "CLI to scaffold a preview for Rage FW", "description": "CLI to scaffold a preview for Rage-FW",
"keywords": ["create-rage-fw","ragefw-cli", "ragefw", "rage-fw", "ragemp", "rage:mp", "rage", "gta5"], "keywords": ["create-rage-fw","ragefw-cli", "ragefw", "rage-fw", "ragemp", "rage:mp", "rage", "gta5"],
"author": "Entity Seven Group", "author": "Entity Seven Group",
"contributors": [ "contributors": [

488
cli/pnpm-lock.yaml generated
View File

@ -1,488 +0,0 @@
lockfileVersion: '9.0'
settings:
autoInstallPeers: true
excludeLinksFromLockfile: false
importers:
.:
dependencies:
'@inquirer/prompts':
specifier: ^5.0.5
version: 5.5.0
chalk:
specifier: 4.1.2
version: 4.1.2
ky:
specifier: ^1.7.2
version: 1.7.4
yargs:
specifier: ^17.7.2
version: 17.7.2
devDependencies:
'@types/node':
specifier: ^22.12.0
version: 22.12.0
'@types/yargs':
specifier: ^17.0.32
version: 17.0.33
prettier:
specifier: ^3.3.2
version: 3.4.2
typescript:
specifier: ^5.7.3
version: 5.7.3
packages:
'@inquirer/checkbox@2.5.0':
resolution: {integrity: sha512-sMgdETOfi2dUHT8r7TT1BTKOwNvdDGFDXYWtQ2J69SvlYNntk9I/gJe7r5yvMwwsuKnYbuRs3pNhx4tgNck5aA==}
engines: {node: '>=18'}
'@inquirer/confirm@3.2.0':
resolution: {integrity: sha512-oOIwPs0Dvq5220Z8lGL/6LHRTEr9TgLHmiI99Rj1PJ1p1czTys+olrgBqZk4E2qC0YTzeHprxSQmoHioVdJ7Lw==}
engines: {node: '>=18'}
'@inquirer/core@9.2.1':
resolution: {integrity: sha512-F2VBt7W/mwqEU4bL0RnHNZmC/OxzNx9cOYxHqnXX3MP6ruYvZUZAW9imgN9+h/uBT/oP8Gh888J2OZSbjSeWcg==}
engines: {node: '>=18'}
'@inquirer/editor@2.2.0':
resolution: {integrity: sha512-9KHOpJ+dIL5SZli8lJ6xdaYLPPzB8xB9GZItg39MBybzhxA16vxmszmQFrRwbOA918WA2rvu8xhDEg/p6LXKbw==}
engines: {node: '>=18'}
'@inquirer/expand@2.3.0':
resolution: {integrity: sha512-qnJsUcOGCSG1e5DTOErmv2BPQqrtT6uzqn1vI/aYGiPKq+FgslGZmtdnXbhuI7IlT7OByDoEEqdnhUnVR2hhLw==}
engines: {node: '>=18'}
'@inquirer/figures@1.0.9':
resolution: {integrity: sha512-BXvGj0ehzrngHTPTDqUoDT3NXL8U0RxUk2zJm2A66RhCEIWdtU1v6GuUqNAgArW4PQ9CinqIWyHdQgdwOj06zQ==}
engines: {node: '>=18'}
'@inquirer/input@2.3.0':
resolution: {integrity: sha512-XfnpCStx2xgh1LIRqPXrTNEEByqQWoxsWYzNRSEUxJ5c6EQlhMogJ3vHKu8aXuTacebtaZzMAHwEL0kAflKOBw==}
engines: {node: '>=18'}
'@inquirer/number@1.1.0':
resolution: {integrity: sha512-ilUnia/GZUtfSZy3YEErXLJ2Sljo/mf9fiKc08n18DdwdmDbOzRcTv65H1jjDvlsAuvdFXf4Sa/aL7iw/NanVA==}
engines: {node: '>=18'}
'@inquirer/password@2.2.0':
resolution: {integrity: sha512-5otqIpgsPYIshqhgtEwSspBQE40etouR8VIxzpJkv9i0dVHIpyhiivbkH9/dGiMLdyamT54YRdGJLfl8TFnLHg==}
engines: {node: '>=18'}
'@inquirer/prompts@5.5.0':
resolution: {integrity: sha512-BHDeL0catgHdcHbSFFUddNzvx/imzJMft+tWDPwTm3hfu8/tApk1HrooNngB2Mb4qY+KaRWF+iZqoVUPeslEog==}
engines: {node: '>=18'}
'@inquirer/rawlist@2.3.0':
resolution: {integrity: sha512-zzfNuINhFF7OLAtGHfhwOW2TlYJyli7lOUoJUXw/uyklcwalV6WRXBXtFIicN8rTRK1XTiPWB4UY+YuW8dsnLQ==}
engines: {node: '>=18'}
'@inquirer/search@1.1.0':
resolution: {integrity: sha512-h+/5LSj51dx7hp5xOn4QFnUaKeARwUCLs6mIhtkJ0JYPBLmEYjdHSYh7I6GrLg9LwpJ3xeX0FZgAG1q0QdCpVQ==}
engines: {node: '>=18'}
'@inquirer/select@2.5.0':
resolution: {integrity: sha512-YmDobTItPP3WcEI86GvPo+T2sRHkxxOq/kXmsBjHS5BVXUgvgZ5AfJjkvQvZr03T81NnI3KrrRuMzeuYUQRFOA==}
engines: {node: '>=18'}
'@inquirer/type@1.5.5':
resolution: {integrity: sha512-MzICLu4yS7V8AA61sANROZ9vT1H3ooca5dSmI1FjZkzq7o/koMsRfQSzRtFo+F3Ao4Sf1C0bpLKejpKB/+j6MA==}
engines: {node: '>=18'}
'@inquirer/type@2.0.0':
resolution: {integrity: sha512-XvJRx+2KR3YXyYtPUUy+qd9i7p+GO9Ko6VIIpWlBrpWwXDv8WLFeHTxz35CfQFUiBMLXlGHhGzys7lqit9gWag==}
engines: {node: '>=18'}
'@types/mute-stream@0.0.4':
resolution: {integrity: sha512-CPM9nzrCPPJHQNA9keH9CVkVI+WR5kMa+7XEs5jcGQ0VoAGnLv242w8lIVgwAEfmE4oufJRaTc9PNLQl0ioAow==}
'@types/node@22.12.0':
resolution: {integrity: sha512-Fll2FZ1riMjNmlmJOdAyY5pUbkftXslB5DgEzlIuNaiWhXd00FhWxVC/r4yV/4wBb9JfImTu+jiSvXTkJ7F/gA==}
'@types/wrap-ansi@3.0.0':
resolution: {integrity: sha512-ltIpx+kM7g/MLRZfkbL7EsCEjfzCcScLpkg37eXEtx5kmrAKBkTJwd1GIAjDSL8wTpM6Hzn5YO4pSb91BEwu1g==}
'@types/yargs-parser@21.0.3':
resolution: {integrity: sha512-I4q9QU9MQv4oEOz4tAHJtNz1cwuLxn2F3xcc2iV5WdqLPpUnj30aUuxt1mAxYTG+oe8CZMV/+6rU4S4gRDzqtQ==}
'@types/yargs@17.0.33':
resolution: {integrity: sha512-WpxBCKWPLr4xSsHgz511rFJAM+wS28w2zEO1QDNY5zM/S8ok70NNfztH0xwhqKyaK0OHCbN98LDAZuy1ctxDkA==}
ansi-escapes@4.3.2:
resolution: {integrity: sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ==}
engines: {node: '>=8'}
ansi-regex@5.0.1:
resolution: {integrity: sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==}
engines: {node: '>=8'}
ansi-styles@4.3.0:
resolution: {integrity: sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==}
engines: {node: '>=8'}
chalk@4.1.2:
resolution: {integrity: sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==}
engines: {node: '>=10'}
chardet@0.7.0:
resolution: {integrity: sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==}
cli-width@4.1.0:
resolution: {integrity: sha512-ouuZd4/dm2Sw5Gmqy6bGyNNNe1qt9RpmxveLSO7KcgsTnU7RXfsw+/bukWGo1abgBiMAic068rclZsO4IWmmxQ==}
engines: {node: '>= 12'}
cliui@8.0.1:
resolution: {integrity: sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==}
engines: {node: '>=12'}
color-convert@2.0.1:
resolution: {integrity: sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==}
engines: {node: '>=7.0.0'}
color-name@1.1.4:
resolution: {integrity: sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==}
emoji-regex@8.0.0:
resolution: {integrity: sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==}
escalade@3.2.0:
resolution: {integrity: sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==}
engines: {node: '>=6'}
external-editor@3.1.0:
resolution: {integrity: sha512-hMQ4CX1p1izmuLYyZqLMO/qGNw10wSv9QDCPfzXfyFrOaCSSoRfqE1Kf1s5an66J5JZC62NewG+mK49jOCtQew==}
engines: {node: '>=4'}
get-caller-file@2.0.5:
resolution: {integrity: sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==}
engines: {node: 6.* || 8.* || >= 10.*}
has-flag@4.0.0:
resolution: {integrity: sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==}
engines: {node: '>=8'}
iconv-lite@0.4.24:
resolution: {integrity: sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==}
engines: {node: '>=0.10.0'}
is-fullwidth-code-point@3.0.0:
resolution: {integrity: sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==}
engines: {node: '>=8'}
ky@1.7.4:
resolution: {integrity: sha512-zYEr/gh7uLW2l4su11bmQ2M9xLgQLjyvx58UyNM/6nuqyWFHPX5ktMjvpev3F8QWdjSsHUpnWew4PBCswBNuMQ==}
engines: {node: '>=18'}
mute-stream@1.0.0:
resolution: {integrity: sha512-avsJQhyd+680gKXyG/sQc0nXaC6rBkPOfyHYcFb9+hdkqQkR9bdnkJ0AMZhke0oesPqIO+mFFJ+IdBc7mst4IA==}
engines: {node: ^14.17.0 || ^16.13.0 || >=18.0.0}
os-tmpdir@1.0.2:
resolution: {integrity: sha512-D2FR03Vir7FIu45XBY20mTb+/ZSWB00sjU9jdQXt83gDrI4Ztz5Fs7/yy74g2N5SVQY4xY1qDr4rNddwYRVX0g==}
engines: {node: '>=0.10.0'}
prettier@3.4.2:
resolution: {integrity: sha512-e9MewbtFo+Fevyuxn/4rrcDAaq0IYxPGLvObpQjiZBMAzB9IGmzlnG9RZy3FFas+eBMu2vA0CszMeduow5dIuQ==}
engines: {node: '>=14'}
hasBin: true
require-directory@2.1.1:
resolution: {integrity: sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==}
engines: {node: '>=0.10.0'}
safer-buffer@2.1.2:
resolution: {integrity: sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==}
signal-exit@4.1.0:
resolution: {integrity: sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==}
engines: {node: '>=14'}
string-width@4.2.3:
resolution: {integrity: sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==}
engines: {node: '>=8'}
strip-ansi@6.0.1:
resolution: {integrity: sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==}
engines: {node: '>=8'}
supports-color@7.2.0:
resolution: {integrity: sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==}
engines: {node: '>=8'}
tmp@0.0.33:
resolution: {integrity: sha512-jRCJlojKnZ3addtTOjdIqoRuPEKBvNXcGYqzO6zWZX8KfKEpnGY5jfggJQ3EjKuu8D4bJRr0y+cYJFmYbImXGw==}
engines: {node: '>=0.6.0'}
type-fest@0.21.3:
resolution: {integrity: sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==}
engines: {node: '>=10'}
typescript@5.7.3:
resolution: {integrity: sha512-84MVSjMEHP+FQRPy3pX9sTVV/INIex71s9TL2Gm5FG/WG1SqXeKyZ0k7/blY/4FdOzI12CBy1vGc4og/eus0fw==}
engines: {node: '>=14.17'}
hasBin: true
undici-types@6.20.0:
resolution: {integrity: sha512-Ny6QZ2Nju20vw1SRHe3d9jVu6gJ+4e3+MMpqu7pqE5HT6WsTSlce++GQmK5UXS8mzV8DSYHrQH+Xrf2jVcuKNg==}
wrap-ansi@6.2.0:
resolution: {integrity: sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==}
engines: {node: '>=8'}
wrap-ansi@7.0.0:
resolution: {integrity: sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==}
engines: {node: '>=10'}
y18n@5.0.8:
resolution: {integrity: sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==}
engines: {node: '>=10'}
yargs-parser@21.1.1:
resolution: {integrity: sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==}
engines: {node: '>=12'}
yargs@17.7.2:
resolution: {integrity: sha512-7dSzzRQ++CKnNI/krKnYRV7JKKPUXMEh61soaHKg9mrWEhzFWhFnxPxGl+69cD1Ou63C13NUPCnmIcrvqCuM6w==}
engines: {node: '>=12'}
yoctocolors-cjs@2.1.2:
resolution: {integrity: sha512-cYVsTjKl8b+FrnidjibDWskAv7UKOfcwaVZdp/it9n1s9fU3IkgDbhdIRKCW4JDsAlECJY0ytoVPT3sK6kideA==}
engines: {node: '>=18'}
snapshots:
'@inquirer/checkbox@2.5.0':
dependencies:
'@inquirer/core': 9.2.1
'@inquirer/figures': 1.0.9
'@inquirer/type': 1.5.5
ansi-escapes: 4.3.2
yoctocolors-cjs: 2.1.2
'@inquirer/confirm@3.2.0':
dependencies:
'@inquirer/core': 9.2.1
'@inquirer/type': 1.5.5
'@inquirer/core@9.2.1':
dependencies:
'@inquirer/figures': 1.0.9
'@inquirer/type': 2.0.0
'@types/mute-stream': 0.0.4
'@types/node': 22.12.0
'@types/wrap-ansi': 3.0.0
ansi-escapes: 4.3.2
cli-width: 4.1.0
mute-stream: 1.0.0
signal-exit: 4.1.0
strip-ansi: 6.0.1
wrap-ansi: 6.2.0
yoctocolors-cjs: 2.1.2
'@inquirer/editor@2.2.0':
dependencies:
'@inquirer/core': 9.2.1
'@inquirer/type': 1.5.5
external-editor: 3.1.0
'@inquirer/expand@2.3.0':
dependencies:
'@inquirer/core': 9.2.1
'@inquirer/type': 1.5.5
yoctocolors-cjs: 2.1.2
'@inquirer/figures@1.0.9': {}
'@inquirer/input@2.3.0':
dependencies:
'@inquirer/core': 9.2.1
'@inquirer/type': 1.5.5
'@inquirer/number@1.1.0':
dependencies:
'@inquirer/core': 9.2.1
'@inquirer/type': 1.5.5
'@inquirer/password@2.2.0':
dependencies:
'@inquirer/core': 9.2.1
'@inquirer/type': 1.5.5
ansi-escapes: 4.3.2
'@inquirer/prompts@5.5.0':
dependencies:
'@inquirer/checkbox': 2.5.0
'@inquirer/confirm': 3.2.0
'@inquirer/editor': 2.2.0
'@inquirer/expand': 2.3.0
'@inquirer/input': 2.3.0
'@inquirer/number': 1.1.0
'@inquirer/password': 2.2.0
'@inquirer/rawlist': 2.3.0
'@inquirer/search': 1.1.0
'@inquirer/select': 2.5.0
'@inquirer/rawlist@2.3.0':
dependencies:
'@inquirer/core': 9.2.1
'@inquirer/type': 1.5.5
yoctocolors-cjs: 2.1.2
'@inquirer/search@1.1.0':
dependencies:
'@inquirer/core': 9.2.1
'@inquirer/figures': 1.0.9
'@inquirer/type': 1.5.5
yoctocolors-cjs: 2.1.2
'@inquirer/select@2.5.0':
dependencies:
'@inquirer/core': 9.2.1
'@inquirer/figures': 1.0.9
'@inquirer/type': 1.5.5
ansi-escapes: 4.3.2
yoctocolors-cjs: 2.1.2
'@inquirer/type@1.5.5':
dependencies:
mute-stream: 1.0.0
'@inquirer/type@2.0.0':
dependencies:
mute-stream: 1.0.0
'@types/mute-stream@0.0.4':
dependencies:
'@types/node': 22.12.0
'@types/node@22.12.0':
dependencies:
undici-types: 6.20.0
'@types/wrap-ansi@3.0.0': {}
'@types/yargs-parser@21.0.3': {}
'@types/yargs@17.0.33':
dependencies:
'@types/yargs-parser': 21.0.3
ansi-escapes@4.3.2:
dependencies:
type-fest: 0.21.3
ansi-regex@5.0.1: {}
ansi-styles@4.3.0:
dependencies:
color-convert: 2.0.1
chalk@4.1.2:
dependencies:
ansi-styles: 4.3.0
supports-color: 7.2.0
chardet@0.7.0: {}
cli-width@4.1.0: {}
cliui@8.0.1:
dependencies:
string-width: 4.2.3
strip-ansi: 6.0.1
wrap-ansi: 7.0.0
color-convert@2.0.1:
dependencies:
color-name: 1.1.4
color-name@1.1.4: {}
emoji-regex@8.0.0: {}
escalade@3.2.0: {}
external-editor@3.1.0:
dependencies:
chardet: 0.7.0
iconv-lite: 0.4.24
tmp: 0.0.33
get-caller-file@2.0.5: {}
has-flag@4.0.0: {}
iconv-lite@0.4.24:
dependencies:
safer-buffer: 2.1.2
is-fullwidth-code-point@3.0.0: {}
ky@1.7.4: {}
mute-stream@1.0.0: {}
os-tmpdir@1.0.2: {}
prettier@3.4.2: {}
require-directory@2.1.1: {}
safer-buffer@2.1.2: {}
signal-exit@4.1.0: {}
string-width@4.2.3:
dependencies:
emoji-regex: 8.0.0
is-fullwidth-code-point: 3.0.0
strip-ansi: 6.0.1
strip-ansi@6.0.1:
dependencies:
ansi-regex: 5.0.1
supports-color@7.2.0:
dependencies:
has-flag: 4.0.0
tmp@0.0.33:
dependencies:
os-tmpdir: 1.0.2
type-fest@0.21.3: {}
typescript@5.7.3: {}
undici-types@6.20.0: {}
wrap-ansi@6.2.0:
dependencies:
ansi-styles: 4.3.0
string-width: 4.2.3
strip-ansi: 6.0.1
wrap-ansi@7.0.0:
dependencies:
ansi-styles: 4.3.0
string-width: 4.2.3
strip-ansi: 6.0.1
y18n@5.0.8: {}
yargs-parser@21.1.1: {}
yargs@17.7.2:
dependencies:
cliui: 8.0.1
escalade: 3.2.0
get-caller-file: 2.0.5
require-directory: 2.1.1
string-width: 4.2.3
y18n: 5.0.8
yargs-parser: 21.1.1
yoctocolors-cjs@2.1.2: {}

View File

@ -3,22 +3,9 @@ import { input, select } from '@inquirer/prompts'
import path from 'node:path' import path from 'node:path'
import { cloneBranch } from '../utils/cloner' import { cloneBranch } from '../utils/cloner'
const choices = {
'react-18': {
name: 'React 18',
value: 'react-18',
description: 'React 18 + TypeScript (Vite) as a front-end',
},
'svelte-5': {
name: 'Svelte 5',
value: 'svelte-5',
description: 'Svelte 5 + TypeScript (Vite) as a front-end',
},
} as const
export async function initProject() { export async function initProject() {
let folder: string | undefined let folder
let framework: keyof typeof choices | undefined let framework
if (!folder) { if (!folder) {
folder = await input({ folder = await input({
@ -34,17 +21,23 @@ export async function initProject() {
message: c.gray('Select front-end:'), message: c.gray('Select front-end:'),
default: 'react-18', default: 'react-18',
loop: true, loop: true,
choices: Object.values(choices), choices: [
{
name: 'React 18',
value: 'react-18',
description: 'React 18 + TypeScript (Vite) as a front-end',
},
],
}) })
} else { } else {
console.log(c.gray('Front-end:'), choices[framework].name) console.log(c.gray('Front-end:'), framework)
} }
console.log( console.log(
c.gray('\nScaffolding template project into'), c.gray('\nScaffolding template project into'),
folder, folder,
c.gray('with'), c.gray('with'),
choices[framework].name, framework,
c.gray('as a front-end..'), c.gray('as a front-end..'),
) )
@ -57,12 +50,12 @@ export async function initProject() {
console.log(c.gray('Scaffolded project into'), folder) console.log(c.gray('Scaffolded project into'), folder)
console.log( console.log(
c.gray( c.gray(
`Project was created in: ${path.join(process.cwd(), folder)}`, `Project was created ar dir: ${path.join(process.cwd(), folder)}`,
), ),
) )
}) })
.catch(e => { .catch(e => {
console.log(c.red('Error occurred: \n', e)) console.log(c.red('Error occured: \n', e))
console.log(c.red('Please open an issue if you see this')) console.log(c.red('Please open an issue if you see this'))
}) })
} }

View File

@ -17,8 +17,8 @@ const choices = {
} as const } as const
export async function testRpc() { export async function testRpc() {
let folder: string | undefined let folder
let framework: keyof typeof choices | undefined let framework
if (!folder) { if (!folder) {
folder = await input({ folder = await input({
@ -37,7 +37,7 @@ export async function testRpc() {
choices: Object.values(choices), choices: Object.values(choices),
}) })
} else { } else {
console.log(c.gray('Front-end:'), choices[framework].name) console.log(c.gray('Front-end:'), framework)
} }
console.log( console.log(
@ -45,7 +45,7 @@ export async function testRpc() {
folder, folder,
c.gray('with'), c.gray('with'),
choices[framework].name, choices[framework].name,
c.gray('as a frontend'), c.gray('as a frontend..'),
) )
cloneBranch( cloneBranch(
@ -62,7 +62,7 @@ export async function testRpc() {
) )
}) })
.catch(e => { .catch(e => {
console.log(c.red('Error occurred: \n', e)) console.log(c.red('Error occured: \n', e))
console.log(c.red('Please open an issue if you see this')) console.log(c.red('Please open an issue if you see this'))
}) })
} }

View File

@ -1,9 +1,9 @@
{ {
"compilerOptions": { "compilerOptions": {
"target": "esnext", "target": "es6",
"module": "commonjs", "module": "commonjs",
"moduleResolution": "node", "moduleResolution": "node",
"lib": ["DOM", "esnext"], "lib": ["DOM", "ES6"],
"declaration": true, "declaration": true,
"declarationMap": true, "declarationMap": true,
"sourceMap": true, "sourceMap": true,

View File

@ -1,4 +1,4 @@
Custom Attribution-NoDerives Software License Custom Attribution-NoDerivs Software License
Copyright (c) 2024 Entity Seven Group Copyright (c) 2024 Entity Seven Group

View File

@ -1,50 +1,25 @@
{ {
"private": false,
"name": "@entityseven/rage-fw-client", "name": "@entityseven/rage-fw-client",
"version": "0.2.0", "version": "0.2.0",
"main": "dist/index.js",
"types": "dist/src/index.d.ts",
"files": [ "files": [
"dist/**/*", "dist/**/*",
"readme.md", "readme.md",
"LICENSE", "LICENSE"
"package.json"
], ],
"main": "src/index.ts",
"exports": {
".": "./src/index.ts"
},
"publishConfig": {
"access": "public",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"exports": {
".": "./dist/index.js"
}
},
"scripts": { "scripts": {
"build": "tsup" "build": "tsup"
}, },
"dependencies": { "dependencies": {
"@entityseven/rage-fw-rpc": "workspace:*", "@entityseven/rage-fw-rpc": "0.2.5"
"zod": "^3.24.1"
},
"devDependencies": {
"@types/node": "22.12.0"
}, },
"peerDependencies": { "peerDependencies": {
"@entityseven/rage-fw-shared-types": "workspace:*", "@entityseven/rage-fw-shared-types": "0.2.0",
"@ragempcommunity/types-client": "^2.1.8", "@ragempcommunity/types-client": "^2.1.8"
"typescript": "^5.7.3"
}, },
"description": "Package used on a client-side of your Rage:MP Server", "description": "Package used on a client-side of your Rage:MP Server",
"keywords": [ "keywords": ["rage-fw-client", "ragefw", "rage-fw", "ragemp", "rage:mp", "rage", "gta5"],
"rage-fw-client",
"ragefw",
"rage-fw",
"ragemp",
"rage:mp",
"rage",
"gta5"
],
"author": "Entity Seven Group", "author": "Entity Seven Group",
"contributors": [ "contributors": [
{ {

View File

@ -1,9 +1,9 @@
import { rpc } from './rpc' import { rpc } from './rpc'
import { FW_Middleware } from './middleware' import { Middleware } from './middleware'
import type * as T from '../types' import type * as T from '../types'
/** Client-side interactions */ /** Client-side interactions */
export class FW_Client { export class Client {
/** /**
* Registers a client event with an associated callback * Registers a client event with an associated callback
* *
@ -11,7 +11,7 @@ export class FW_Client {
* @param callback - The callback function to be executed when the event is triggered * @param callback - The callback function to be executed when the event is triggered
* @param [options] - Optional settings for callback execution * @param [options] - Optional settings for callback execution
* @param [options.middlewares] - Middleware functions to be checked before the callback executes * @param [options.middlewares] - Middleware functions to be checked before the callback executes
* @returns {FW_Client} The current client instance, enabling method chaining * @returns {Client} The current client instance, enabling method chaining
* *
* @example * @example
* // Registering an event * // Registering an event
@ -40,13 +40,13 @@ export class FW_Client {
* *
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki} * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/ */
public register<EventName extends T.FW_ClientEvent>( public register<EventName extends T.RageFW_ClientEvent>(
eventName: EventName, eventName: EventName,
callback: T.FW_ClientCallback<EventName>, callback: T.RageFW_ClientCallback<EventName>,
options?: { options?: {
middlewares?: T.FW_MiddlewareOptions<EventName> middlewares?: T.RageFW_MiddlewareOptions<EventName>
}, },
): FW_Client { ): Client {
rpc.register< rpc.register<
Parameters<typeof callback>, Parameters<typeof callback>,
ReturnType<typeof callback> | Promise<unknown>, ReturnType<typeof callback> | Promise<unknown>,
@ -54,7 +54,7 @@ export class FW_Client {
>(eventName, async (...data) => { >(eventName, async (...data) => {
if (!options?.middlewares) return await callback(...data) if (!options?.middlewares) return await callback(...data)
await FW_Middleware.process(options.middlewares, callback, data) await Middleware.process(options.middlewares, callback, data)
}) })
return this return this
@ -72,11 +72,15 @@ export class FW_Client {
* *
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki} * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/ */
public unregister<EventName extends T.FW_ClientEvent>( public unregister<EventName extends T.RageFW_ClientEvent>(
eventName: EventName, eventName: EventName,
): FW_Client { ): Client {
rpc.unregister<EventName>(eventName) rpc.unregister<EventName>(eventName)
return this return this
} }
} }
// new Client()
// .register('customClientEvent', async (a, b) => true)
// .unregister('customClientEvent')

View File

@ -1,7 +1,7 @@
/** /**
* Used to log to a client in-game console * Used to log to a client in-game console
*/ */
export class FW_Logger { export class Logger {
/** /**
* Informational logs. Colored in white * Informational logs. Colored in white
* *
@ -10,7 +10,7 @@ export class FW_Logger {
*/ */
public info(...message: unknown[]) { public info(...message: unknown[]) {
mp.console.logInfo( mp.console.logInfo(
`[${new Date().toLocaleTimeString(undefined, { hour: 'numeric', minute: 'numeric', second: 'numeric', fractionalSecondDigits: 2 })}] [INFO] ${message.join(' ')}`, `[${new Date().toLocaleTimeString()}] [INFO] ${message.join(' ')}`,
) )
} }
@ -22,7 +22,7 @@ export class FW_Logger {
*/ */
public warn(...message: unknown[]) { public warn(...message: unknown[]) {
mp.console.logWarning( mp.console.logWarning(
`[${new Date().toLocaleTimeString(undefined, { hour: 'numeric', minute: 'numeric', second: 'numeric', fractionalSecondDigits: 2 })}] [WARN] ${message.join(' ')}`, `[${new Date().toLocaleTimeString()}] [WARN] ${message.join(' ')}`,
) )
} }
@ -34,7 +34,7 @@ export class FW_Logger {
*/ */
public error(...message: unknown[]) { public error(...message: unknown[]) {
mp.console.logError( mp.console.logError(
`[${new Date().toLocaleTimeString(undefined, { hour: 'numeric', minute: 'numeric', second: 'numeric', fractionalSecondDigits: 2 })}] [ERROR] ${message.join(' ')}`, `[${new Date().toLocaleTimeString()}] [ERROR] ${message.join(' ')}`,
) )
} }
} }

View File

@ -1,12 +1,12 @@
import type * as T from '../types' import type * as T from '../types'
export class FW_Middleware { export class Middleware {
constructor() {} constructor() {}
private static async execute<EventName extends T.FW_ClientEvent>( private static async execute<EventName extends T.RageFW_ClientEvent>(
middlewares: T.FW_MiddlewareFunction<EventName>[], middlewares: T.RageFW_MiddlewareFunction<EventName>[],
args: T.FW_ClientArgs<EventName>, args: T.RageFW_ClientArgs<EventName>,
): Promise<T.FW_MiddlewareResponseInternal> { ): Promise<T.RageFW_MiddlewareResponseInternal> {
for (let i = 0; i < middlewares.length; i++) { for (let i = 0; i < middlewares.length; i++) {
const result = await middlewares[i](...args) const result = await middlewares[i](...args)
@ -21,20 +21,20 @@ export class FW_Middleware {
} }
} }
public static async process<EventName extends T.FW_ClientEvent>( public static async process<EventName extends T.RageFW_ClientEvent>(
middlewareOptions: T.FW_MiddlewareOptions<EventName>, middlewareOptions: T.RageFW_MiddlewareOptions<EventName>,
callback: T.FW_ClientCallback<EventName>, callback: T.RageFW_ClientCallback<EventName>,
args: T.FW_ClientArgs<EventName>, args: T.RageFW_ClientArgs<EventName>,
) { ) {
if (Array.isArray(middlewareOptions)) { if (Array.isArray(middlewareOptions)) {
const middlewaresResponse = await FW_Middleware.execute( const middlewaresResponse = await Middleware.execute(
middlewareOptions, middlewareOptions,
args, args,
) )
if (middlewaresResponse.success) return await callback(...args) if (middlewaresResponse.success) return await callback(...args)
} else { } else {
const middlewaresResponse = await FW_Middleware.execute( const middlewaresResponse = await Middleware.execute(
middlewareOptions.executables, middlewareOptions.executables,
args, args,
) )

View File

@ -2,7 +2,7 @@ import { rpc } from './rpc'
import type * as T from '../types' import type * as T from '../types'
/** Handles event manipulations that require player to be present in context */ /** Handles event manipulations that require player to be present in context */
export class FW_Player { export class Player {
private _browser: BrowserMp | undefined = undefined private _browser: BrowserMp | undefined = undefined
/** /**
@ -14,40 +14,12 @@ export class FW_Player {
} }
/** /**
* Triggers a client event from the client with arguments from 'rage-fw-shared-types' * Triggers a client event from the client with arguments from shared types
* *
* Formerly known as ``call`` or ``emit`` * Formerly known as ``call`` or ``emit``
* *
* @param eventName - The name of the client event to trigger * @param eventName - The name of the client event to trigger
* @param [args] - Arguments for the client event, if present * @param [args] - Arguments for the client event, if present
* @returns {void}
*
* @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 trigger<EventName extends keyof T.FW_ICustomClientEvent>(
eventName: EventName,
...args: T._ClientEventHasArgs<EventName> extends true
? [T.FW_ClientArgs<EventName>]
: []
): void {
rpc.call<typeof args, EventName>(eventName, args)
}
/**
* Triggers an asynchronous client event from the client with arguments from 'rage-fw-shared-types', and expects to receive a response from an event
*
* Formerly known as ``callAsync`` or ``emitAsync``
*
* @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 * @returns {Promise} resolving to the client's response for the event
* *
* @example * @example
@ -60,54 +32,26 @@ export class FW_Player {
* *
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki} * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/ */
public async triggerAsync<EventName extends keyof T.FW_ICustomClientEvent>( public async trigger<EventName extends keyof T.RageFW_ICustomClientEvent>(
eventName: EventName, eventName: EventName,
...args: T._ClientEventHasArgs<EventName> extends true ...args: T._ClientEventHasArgs<EventName> extends true
? [T.FW_ClientArgs<EventName>] ? [T.RageFW_ClientArgs<EventName>]
: [] : []
): Promise<T.FW_ClientReturn<EventName>> { ): Promise<T.RageFW_ClientReturn<EventName>> {
return await rpc.callAsync< return await rpc.call<
typeof args, typeof args,
EventName, EventName,
T.FW_ClientReturn<EventName> T.RageFW_ClientReturn<EventName>
>(eventName, args) >(eventName, args)
} }
/** /**
* Triggers a server event from the client with arguments from 'rage-fw-shared-types' * Triggers a server event from the client with arguments from shared types
* *
* Formerly known as ``callServer`` or ``emitServer`` * Formerly known as ``callServer`` or ``emitServer``
* *
* @param eventName - The name of the server event to trigger * @param eventName - The name of the server event to trigger
* @param [args] - Arguments for the server event, if present * @param [args] - Arguments for the server event, if present
* @returns {void}
*
* @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 triggerServer<EventName extends T.FW_ServerEvent>(
eventName: EventName,
...args: T._ServerEventHasArgs<EventName> extends true
? [T.FW_ServerArgs<EventName>]
: []
): void {
rpc.callServer<typeof args, EventName>(eventName, args)
}
/**
* Triggers an asynchronous server event from the client with arguments from 'rage-fw-shared-types', and expects to receive a response from an event
*
* Formerly known as ``callServerAsync`` or ``emitServerAsync``
*
* @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 * @returns {Promise} resolving to the server's response for the event
* *
* @example * @example
@ -120,57 +64,26 @@ export class FW_Player {
* *
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki} * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/ */
public async triggerServerAsync<EventName extends T.FW_ServerEvent>( public async triggerServer<EventName extends T.RageFW_ServerEvent>(
eventName: EventName, eventName: EventName,
...args: T._ServerEventHasArgs<EventName> extends true ...args: T._ServerEventHasArgs<EventName> extends true
? [T.FW_ServerArgs<EventName>] ? [T.RageFW_ServerArgs<EventName>]
: [] : []
): Promise<T.FW_ClientServerReturn<EventName>> { ): Promise<T.RageFW_ClientServerReturn<EventName>> {
return await rpc.callServerAsync< return await rpc.callServer<
typeof args, typeof args,
EventName, EventName,
T.FW_ClientServerReturn<EventName> T.RageFW_ClientServerReturn<EventName>
>(eventName, args) >(eventName, args)
} }
/** /**
* Triggers a browser event from the client with arguments from 'rage-fw-shared-types' * Triggers a browser event from the client with arguments from shared types
* *
* Formerly known as ``callBrowser`` or ``emitBrowser`` * Formerly known as ``callBrowser`` or ``emitBrowser``
* *
* @param eventName - The name of the browser event to trigger * @param eventName - The name of the browser event to trigger
* @param [args] - Arguments for the browser event, if present * @param [args] - Arguments for the browser event, if present
* @returns {void}
*
* @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 triggerBrowser<EventName extends T.FW_BrowserEvent>(
eventName: EventName,
...args: T._BrowserEventHasArgs<EventName> extends true
? [T.FW_BrowserArgs<EventName>]
: []
): void {
if (!this._browser)
throw new Error('You need to initialize browser first')
rpc.callBrowser<typeof args, EventName>(eventName, args)
}
/**
* Triggers an asynchronous browser event from the client with arguments from 'rage-fw-shared-types', and expects to receive a response from an event
*
* Formerly known as ``callBrowserAsync`` or ``emitBrowserAsync``
*
* @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 * @returns {Promise} resolving to the browser's response for the event
* *
* @example * @example
@ -183,19 +96,23 @@ export class FW_Player {
* *
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki} * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/ */
public async triggerBrowserAsync<EventName extends T.FW_BrowserEvent>( public async triggerBrowser<EventName extends T.RageFW_BrowserEvent>(
eventName: EventName, eventName: EventName,
...args: T._BrowserEventHasArgs<EventName> extends true ...args: T._BrowserEventHasArgs<EventName> extends true
? [T.FW_BrowserArgs<EventName>] ? [T.RageFW_BrowserArgs<EventName>]
: [] : []
): Promise<T.FW_BrowserReturn<EventName>> { ): Promise<T.RageFW_BrowserReturn<EventName>> {
if (!this._browser) if (!this._browser)
throw new Error('You need to initialize browser first') throw new Error('You need to initialize browser first')
return await rpc.callBrowserAsync< return await rpc.callBrowser<
typeof args, typeof args,
EventName, EventName,
T.FW_BrowserReturn<EventName> T.RageFW_BrowserReturn<EventName>
>(eventName, args) >(eventName, args)
} }
} }
// new Player().trigger('customClientEvent', ['', 1])
// new Player().triggerServer('customServerEvent', ['', 1])
// new Player().triggerBrowser('customCefEvent', ['', 1])

View File

@ -1,6 +1,6 @@
import { FW_Client, FW_Logger, FW_Player, rpc } from './core' import { Client, Logger, Player, rpc } from './core'
export type { FW_MiddlewareFunction } from './types' export type { RageFW_MiddlewareFunction } from './types'
/** /**
* Package used on a client-side of your Rage:MP Server * Package used on a client-side of your Rage:MP Server
@ -9,13 +9,13 @@ export type { FW_MiddlewareFunction } from './types'
*/ */
export const fw = { export const fw = {
/** Client-side interactions */ /** Client-side interactions */
event: new FW_Client(), event: new Client(),
/** Handles event manipulations that require player to be present in context */ /** Handles event manipulations that require player to be present in context */
player: new FW_Player(), player: new Player(),
/** Handles functions used to interact with the client environment */ /** Handles functions used to interact with the client environment */
system: { system: {
/** Used to log in a client in-game console */ /** Used to log in a client in-game console */
log: new FW_Logger(), 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 */ /** ``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, rpc,

View File

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

View File

@ -1,22 +1,24 @@
/// <reference types="@ragempcommunity/types-client" /> /// <reference types="@ragempcommunity/types-client" />
import type { FW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types' import type { RageFW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
export type { FW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types' export type { RageFW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
/** /**
* Union of all available client event names * Union of all available client event names
* These include custom and system events * These include custom and system events
*/ */
export type FW_ClientEvent = keyof FW_ICustomClientEvent | keyof IClientEvents export type RageFW_ClientEvent =
| keyof RageFW_ICustomClientEvent
| keyof IClientEvents
/** /**
* Array of arguments for an event, name of which you pass as a generic * Array of arguments for an event, name of which you pass as a generic
* These include custom and system events * These include custom and system events
*/ */
export type FW_ClientArgs<K extends FW_ClientEvent> = export type RageFW_ClientArgs<K extends RageFW_ClientEvent> =
K extends keyof FW_ICustomClientEvent K extends keyof RageFW_ICustomClientEvent
? Parameters<FW_ICustomClientEvent[K]> ? Parameters<RageFW_ICustomClientEvent[K]>
: K extends keyof IClientEvents : K extends keyof IClientEvents
? Parameters<IClientEvents[K]> ? Parameters<IClientEvents[K]>
: never : never
@ -25,9 +27,9 @@ export type FW_ClientArgs<K extends FW_ClientEvent> =
* Return type for an event, name of which you pass as a generic * Return type for an event, name of which you pass as a generic
* These include custom and system events * These include custom and system events
*/ */
export type FW_ClientReturn<K extends FW_ClientEvent> = export type RageFW_ClientReturn<K extends RageFW_ClientEvent> =
K extends keyof FW_ICustomClientEvent K extends keyof RageFW_ICustomClientEvent
? ReturnType<FW_ICustomClientEvent[K]> ? ReturnType<RageFW_ICustomClientEvent[K]>
: K extends keyof IClientEvents : K extends keyof IClientEvents
? ReturnType<IClientEvents[K]> ? ReturnType<IClientEvents[K]>
: void : void
@ -36,16 +38,17 @@ export type FW_ClientReturn<K extends FW_ClientEvent> =
* Callback (function) for an event, name of which you pass as a generic * Callback (function) for an event, name of which you pass as a generic
* These include custom and system events * These include custom and system events
*/ */
export type FW_ClientCallback<K extends FW_ClientEvent> = ( export type RageFW_ClientCallback<K extends RageFW_ClientEvent> = (
...args: FW_ClientArgs<K> ...args: RageFW_ClientArgs<K>
) => Promise<FW_ClientReturn<K>> ) => Promise<RageFW_ClientReturn<K>>
/** /**
* *
*/ */
export type _ClientEventHasArgs<EventName extends keyof FW_ICustomClientEvent> = export type _ClientEventHasArgs<
keyof FW_ICustomClientEvent extends never EventName extends keyof RageFW_ICustomClientEvent,
> = keyof RageFW_ICustomClientEvent extends never
? false ? false
: Parameters<FW_ICustomClientEvent[EventName]>[0] extends undefined : Parameters<RageFW_ICustomClientEvent[EventName]>[0] extends undefined
? false ? false
: true : true

View File

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

View File

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

View File

@ -1,37 +1,38 @@
/// <reference types="@ragempcommunity/types-client" /> /// <reference types="@ragempcommunity/types-client" />
import type { import type {
FW_ICustomClientEvent, RageFW_ICustomClientEvent,
FW_ICustomServerEvent, RageFW_ICustomServerEvent,
} from '@entityseven/rage-fw-shared-types' } from '@entityseven/rage-fw-shared-types'
/** /**
* Union of all available server event names callable from client * Union of all available server event names callable from client
* These only include custom events * These only include custom events
*/ */
export type FW_ServerEvent = keyof FW_ICustomServerEvent export type RageFW_ServerEvent = keyof RageFW_ICustomServerEvent
/** /**
* Array of arguments for an event, name of which you pass as a generic * Array of arguments for an event, name of which you pass as a generic
* These only include custom events * These only include custom events
*/ */
export type FW_ServerArgs<K extends FW_ServerEvent> = export type RageFW_ServerArgs<K extends RageFW_ServerEvent> =
K extends keyof FW_ICustomServerEvent K extends keyof RageFW_ICustomServerEvent
? Parameters<FW_ICustomServerEvent[K]> ? Parameters<RageFW_ICustomServerEvent[K]>
: never : never
/** /**
* Return type for an event, name of which you pass as a generic * Return type for an event, name of which you pass as a generic
* These only include custom events * These only include custom events
*/ */
export type FW_ClientServerReturn<K extends FW_ServerEvent> = export type RageFW_ClientServerReturn<K extends RageFW_ServerEvent> =
K extends keyof FW_ICustomServerEvent K extends keyof RageFW_ICustomServerEvent
? ReturnType<FW_ICustomServerEvent[K]> ? ReturnType<RageFW_ICustomServerEvent[K]>
: never : never
export type _ServerEventHasArgs<EventName extends keyof FW_ICustomServerEvent> = export type _ServerEventHasArgs<
keyof FW_ICustomClientEvent extends never EventName extends keyof RageFW_ICustomServerEvent,
> = keyof RageFW_ICustomClientEvent extends never
? false ? false
: Parameters<FW_ICustomServerEvent[EventName]>[0] extends undefined : Parameters<RageFW_ICustomServerEvent[EventName]>[0] extends undefined
? false ? false
: true : true

View File

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

View File

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

View File

@ -1,57 +0,0 @@
import globals from 'globals'
import pluginJs from '@eslint/js'
import tseslint from 'typescript-eslint'
import type { Linter } from 'eslint'
export default [
{
ignores: ['**/.*/*', '**/dist/*', '**/node_modules/*', '*.config.*'],
},
pluginJs.configs.recommended,
...(tseslint.configs.recommended as Linter.Config[]),
{
name: 'global',
rules: {
'@typescript-eslint/no-explicit-any': 'off',
'@typescript-eslint/no-unused-vars': [
'warn',
{
argsIgnorePattern: '^_',
varsIgnorePattern: '^_',
caughtErrorsIgnorePattern: '^_',
},
],
'@typescript-eslint/ban-ts-comment': 'off',
'@typescript-eslint/ban-types': 'off',
'consistent-return': 'off',
'no-empty': 'off',
},
},
{
name: 'browser/rpc',
files: ['browser/src/*.{ts,js}', 'rpc/src/*.{ts,js}'],
languageOptions: {
globals: { ...globals.browser, ...globals.node, ...globals.es2022 },
},
},
{
name: 'cli',
files: ['cli/src/*.{ts,js}'],
languageOptions: {
globals: { ...globals.node, ...globals.es2024 },
ecmaVersion: 2024,
},
},
{
name: 'client/server/shared',
files: [
'client/**/*.{ts,js}',
'server/**/*.{ts,js}',
'shared/**/*.{ts,js}',
],
languageOptions: {
globals: { ...globals.node, ...globals.es2022 },
},
},
] satisfies Linter.Config[]

5
lerna.json Normal file
View File

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

View File

@ -1,46 +1,29 @@
{ {
"workspaces": [
"*",
"!cli"
],
"scripts": { "scripts": {
"lint": "eslint . --config eslint.config.ts", "publish": "lerna publish --force-publish",
"_____build": "echo build", "build": "lerna run build",
"build:browser": "cd browser && pnpm build", "lint": "eslint --c .eslintrc.yaml --ext .ts client/ server/ shared-types/",
"build:client": "cd client && pnpm build",
"build:server": "cd server && pnpm build", "rebuild:browser": "cd browser && pnpm build",
"build:rpc": "cd rpc && pnpm build", "rebuild:client": "cd client && pnpm build",
"build": "pnpm build:browser && pnpm build:client && pnpm build:server && pnpm build:rpc", "rebuild:server": "cd server && pnpm build",
"_____deps": "echo must be ran before lerna commands", "rebuild": "pnpm rebuild:browser && pnpm rebuild:client && pnpm rebuild:server"
"deps:check": "syncpack list-mismatches",
"deps:fix": "syncpack fix-mismatches",
"_____publish": "echo publish",
"publish:check": "pnpm run deps:check && pnpm run lint",
"publish:changeset": "pnpm changeset add",
"publish:version": "pnpm changeset version"
}, },
"dependencies": { "dependencies": {
"@changesets/cli": "^2.27.12", "@microsoft/api-extractor": "^7.47.0",
"@eslint/js": "^9.19.0",
"@microsoft/api-extractor": "^7.49.1",
"@ragempcommunity/types-cef": "^2.1.8", "@ragempcommunity/types-cef": "^2.1.8",
"@ragempcommunity/types-client": "^2.1.8", "@ragempcommunity/types-client": "^2.1.8",
"@ragempcommunity/types-server": "^2.1.8", "@ragempcommunity/types-server": "^2.1.8",
"eslint": "^9.19.0", "@typescript-eslint/eslint-plugin": "^7.13.0",
"globals": "^15.14.0", "@typescript-eslint/parser": "^7.13.0",
"jiti": "^2.4.2", "@types/node": "^22.8.1",
"prettier": "^3.4.2", "eslint": "^8.56.0",
"tsup": "^8.3.6", "lerna": "^8.1.3",
"typescript": "^5.7.3", "prettier": "^3.3.1",
"typescript-eslint": "^8.22.0", "rage-rpc": "^0.4.0",
"winston": "^3.17.0" "tsup": "^8.1.0",
}, "typescript": "^5.4.5",
"engines": { "winston": "^3.13.0"
"node": ">=14",
"pnpm": ">=10"
},
"pnpm": {
"requiredScripts": []
}, },
"private": true, "private": true,
"type": "module", "type": "module",
@ -57,8 +40,5 @@
"email": "0976053529@ukr.net", "email": "0976053529@ukr.net",
"url": "https://github.com/SashaGoncharov19/" "url": "https://github.com/SashaGoncharov19/"
} }
], ]
"devDependencies": {
"syncpack": "^13.0.0"
}
} }

8545
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@ -1,3 +1,5 @@
packages: packages:
- "*" - "server"
- "!cli" - "client"
- "browser"
- "shared-types"

19
rpc/index.d.ts vendored
View File

@ -1,8 +1,25 @@
export {} export {}
declare var global: Record<string, (...args: any[]) => unknown> interface Mp {
trigger(event: string, data?: any): void
events: {
add(event: string, data: any): void
call(event: string, data: any): void
callRemote(event: string, data: any): void
remove(event: string): void
}
joaat?: unknown
game: {
joaat?: unknown
}
console: {
logInfo: (...args: unknown[]) => void
}
}
declare global { declare global {
const mp: Mp
const global: Record<string, (...args: any[]) => unknown>
interface Window { interface Window {
[p: string]: any [p: string]: any
} }

View File

@ -1,19 +1,8 @@
{ {
"private": false,
"name": "@entityseven/rage-fw-rpc", "name": "@entityseven/rage-fw-rpc",
"version": "0.2.5", "version": "0.2.5",
"main": "src/index.ts",
"exports": {
".": "./src/index.ts"
},
"publishConfig": {
"access": "public",
"main": "dist/index.js", "main": "dist/index.js",
"types": "dist/index.d.ts", "types": "dist/src/index.d.ts",
"exports": {
".": "./dist/index.js"
}
},
"scripts": { "scripts": {
"build": "tsup", "build": "tsup",
"start": "npx ./dist create" "start": "npx ./dist create"
@ -24,10 +13,12 @@
"LICENSE" "LICENSE"
], ],
"devDependencies": { "devDependencies": {
"@types/node": "22.12.0" "@microsoft/api-extractor": "^7.47.9",
"prettier": "^3.3.2",
"tsup": "^8.3.0"
}, },
"peerDependencies": { "peerDependencies": {
"typescript": "^5.7.3" "typescript": "^5"
}, },
"description": "Rage-FW RPC (Remote procedure caller) for Rage:MP", "description": "Rage-FW RPC (Remote procedure caller) for Rage:MP",
"keywords": [ "keywords": [

View File

@ -1,5 +1,3 @@
/// <reference types="@ragempcommunity/types-cef" />
import { Wrapper } from './wrapper' import { Wrapper } from './wrapper'
import { import {
Environment, Environment,
@ -26,7 +24,7 @@ export class Browser extends Wrapper {
* NOT INTENDED FOR OUT-OF-CONTEXT USE * NOT INTENDED FOR OUT-OF-CONTEXT USE
*/ */
public _resolveEmitDestination(dataRaw: string) { public _resolveEmitDestination(dataRaw: string) {
const state = Utils.prepareExecution(dataRaw) let state = Utils.prepareExecution(dataRaw)
switch (state.calledTo) { switch (state.calledTo) {
case Environment.BROWSER: case Environment.BROWSER:

View File

@ -1,5 +1,3 @@
/// <reference types="@ragempcommunity/types-client" />
import { Wrapper } from './wrapper' import { Wrapper } from './wrapper'
import { import {
Environment, Environment,

View File

@ -77,7 +77,7 @@ class Rpc extends Wrapper {
* *
* @template CallbackArguments - An array of argument types that the callback function accepts * @template CallbackArguments - An array of argument types that the callback function accepts
* @template CallbackReturn - The type of the value returned by the callback function * @template CallbackReturn - The type of the value returned by the callback function
* @template EventName - A string or union representing the event name * @template EventName - A string representing the event name or union of names
* *
* @param {EventName} eventName - The name of the event to register the callback for * @param {EventName} eventName - The name of the event to register the callback for
* @param {(...args: CallbackArguments) => CallbackReturn} cb - The callback function that is called when the event is triggered * @param {(...args: CallbackArguments) => CallbackReturn} cb - The callback function that is called when the event is triggered
@ -91,7 +91,7 @@ class Rpc extends Wrapper {
*/ */
public register< public register<
CallbackArguments extends unknown[] = unknown[], CallbackArguments extends unknown[] = unknown[],
CallbackReturn = unknown, CallbackReturn extends unknown = unknown,
EventName extends string = string, EventName extends string = string,
>( >(
eventName: EventName, eventName: EventName,
@ -116,7 +116,7 @@ class Rpc extends Wrapper {
/** /**
* Unregisters callback function for a specified event * Unregisters callback function for a specified event
* *
* @template EventName - A string or union representing the event name * @template EventName - A string representing the event name or union of names
* *
* @param {EventName} eventName - The name of the event to register the callback for * @param {EventName} eventName - The name of the event to register the callback for
* *
@ -133,113 +133,74 @@ class Rpc extends Wrapper {
Utils.errorUnknownEnvironment(this.environment_) Utils.errorUnknownEnvironment(this.environment_)
delete this.state_[eventName] delete this.state_[eventName]
mp.events.remove(eventName)
} }
/** /**
* Calls a client-side event from browser or server. Use 'call' to call client from client * Calls a client-side event from server or browser
* *
* @template Arguments - An array of argument types to be passed to the client event * @template Arguments - An array of argument types to be passed to the client event
* @template EventName - A string or union representing the client event name * @template EventName - A string representing the client event name or union of names
* @template Return - The type of the value returned by the client event
* *
* @param {EventName} eventName - The name of the client event to be called * @param {EventName} eventName - The name of the client event to be called
* @param {Arguments} [args] - Optional arguments to pass to the client event * @param {Arguments} [args] - Optional arguments to pass to the client event
* @returns {void} * @returns {Promise<Return>} A promise resolving to the return value of the client event
* *
* @example * @example
* // Calls an event on a client without specifying a player * // Calls an event on client without specifying a player
* callClient<[], string, object>('onDataRequest') * callClient<[], string, object>('onDataRequest').then(response => {
* console.log(`Received: ${response}`) // ^ object
* })
*/ */
public callClient< public async callClient<
Arguments extends unknown[] = unknown[], Arguments extends unknown[] = unknown[],
EventName extends string = string, EventName extends string = string,
>(eventName: EventName, args?: Arguments): void Return extends unknown = unknown,
>(eventName: EventName, args?: Arguments): Promise<Return>
/** /**
* Calls a client-side event from server or server. Use 'call' to call client from client * Calls a client-side event from server or browser
* *
* @template Arguments - An array of argument types to be passed to the client event * @template Arguments - An array of argument types to be passed to the client event
* @template EventName - A string or union representing the client event name * @template EventName - A string representing the client event name or union of names
* @template Return - The type of the value returned by the client event
* *
* @param {PlayerMp} player - The player for whom the client event is called * @param {PlayerMp} player - The player for whom the client event is called
* @param {EventName} eventName - The name of the client event to be called * @param {EventName} eventName - The name of the client event to be called
* @param {Arguments} [args] - Optional arguments to pass to the client event * @param {Arguments} [args] - Optional arguments to pass to the client event
* @returns {void} A promise resolving to the return value of the client event * @returns {Promise<Return>} A promise resolving to the return value of the client event
* *
* @example * @example
* // Calls an event on a client for a specific player * // Calls an event on client for a specific player
* callClient<[string, number], string, boolean>(player, 'onPlayerAction', ['jump', 2]) * callClient<[string, number], string, boolean>(player, 'onPlayerAction', ['jump', 2]).then(result => {
* console.log(`Action success: ${result}`) // ^ boolean
* })
*/ */
public callClient< public async callClient<
Arguments extends unknown[] = unknown[], Arguments extends unknown[] = unknown[],
EventName extends string = string, EventName extends string = string,
>(player: PlayerMp, eventName: EventName, args?: Arguments): void Return extends unknown = unknown,
public callClient( >(player: PlayerMp, eventName: EventName, args?: Arguments): Promise<Return>
public async callClient(
playerOrEventName: PlayerMp | string, playerOrEventName: PlayerMp | string,
eventNameOrArgs?: string | unknown[], eventNameOrArgs?: string | unknown[],
args?: unknown[], args?: unknown[],
) { ) {
if (_is1StParamPlayer(playerOrEventName)) { _is1StParamPlayer(playerOrEventName)
this.log( ? this.log(
'callClient', 'callClient',
eventNameOrArgs as string, eventNameOrArgs as string,
playerOrEventName, playerOrEventName,
eventNameOrArgs, eventNameOrArgs,
args, args,
) )
} else { : this.log(
this.log('callClient', playerOrEventName as string, eventNameOrArgs) 'callClient',
} playerOrEventName as string,
eventNameOrArgs,
)
if (this.forceBrowserDevMode_) return if (this.forceBrowserDevMode_) return
Utils.errorUnknownEnvironment(this.environment_) Utils.errorUnknownEnvironment(this.environment_)
if (this.environment_ === Environment.CLIENT) {
// client
this.call(playerOrEventName as string, args as unknown[])
}
// server
if (
this.environment_ === Environment.SERVER &&
_is1StParamPlayer(playerOrEventName) &&
_is2NdParamEventName(eventNameOrArgs)
) {
const state: RPCState = {
uuid: Utils.generateUUID(),
eventName: eventNameOrArgs,
calledTo: Environment.CLIENT,
calledFrom: this.environment_,
knownError: undefined,
data: args as unknown[],
type: RPCEventType.EVENT,
}
const dataRaw = Utils.prepareTransfer(state)
playerOrEventName.call(Events.LOCAL_EVENT_LISTENER, [dataRaw])
}
// browser
if (
this.environment_ === Environment.BROWSER &&
!_is1StParamPlayer(playerOrEventName) &&
!_is2NdParamEventName(eventNameOrArgs)
) {
const state: RPCState = {
uuid: Utils.generateUUID(),
eventName: playerOrEventName,
calledTo: Environment.CLIENT,
calledFrom: this.environment_,
knownError: undefined,
data: eventNameOrArgs,
type: RPCEventType.EVENT,
}
const dataRaw = Utils.prepareTransfer(state)
mp.trigger(Events.LOCAL_EVENT_LISTENER, dataRaw)
}
function _is1StParamPlayer(x: unknown): x is PlayerMp { function _is1StParamPlayer(x: unknown): x is PlayerMp {
return typeof x === 'object' return typeof x === 'object'
} }
@ -247,80 +208,10 @@ class Rpc extends Wrapper {
function _is2NdParamEventName(x: unknown): x is string { function _is2NdParamEventName(x: unknown): x is string {
return typeof x === 'string' return typeof x === 'string'
} }
}
/**
* Calls an asynchronous client-side event from server or browser, expecting a response. Use 'callAsync' to call client from client
*
* @template Arguments - An array of argument types to be passed to the client event
* @template EventName - A string or union representing the client event name
* @template Return - The type of the value returned by the client event
*
* @param {EventName} eventName - The name of the client event to be called
* @param {Arguments} [args] - Optional arguments to pass to the client event
* @returns {Promise<Return>} A promise resolving to the return value of the client event
*
* @example
* // Calls an event on a client without specifying a player
* callClient<[], string, object>('onDataRequest').then(response => {
* console.log(`Received: ${response}`) // ^ object
* })
*/
public async callClientAsync<
Arguments extends unknown[] = unknown[],
EventName extends string = string,
Return = unknown,
>(eventName: EventName, args?: Arguments): Promise<Return>
/**
* Calls an asynchronous client-side event from server or browser, expecting a response. Use 'callAsync' to call client from client
*
* @template Arguments - An array of argument types to be passed to the client event
* @template EventName - A string or union representing the client event name
* @template Return - The type of the value returned by the client event
*
* @param {PlayerMp} player - The player for whom the client event is called
* @param {EventName} eventName - The name of the client event to be called
* @param {Arguments} [args] - Optional arguments to pass to the client event
* @returns {Promise<Return>} A promise resolving to the return value of the client event
*
* @example
* // Calls an event on a client for a specific player
* callClient<[string, number], string, boolean>(player, 'onPlayerAction', ['jump', 2]).then(result => {
* console.log(`Action success: ${result}`) // ^ boolean
* })
*/
public async callClientAsync<
Arguments extends unknown[] = unknown[],
EventName extends string = string,
Return = unknown,
>(player: PlayerMp, eventName: EventName, args?: Arguments): Promise<Return>
public async callClientAsync(
playerOrEventName: PlayerMp | string,
eventNameOrArgs?: string | unknown[],
args?: unknown[],
) {
if (_is1StParamPlayer(playerOrEventName)) {
this.log(
'callClientAsync',
eventNameOrArgs as string,
playerOrEventName,
eventNameOrArgs,
args,
)
} else {
this.log(
'callClientAsync',
playerOrEventName as string,
eventNameOrArgs,
)
}
if (this.forceBrowserDevMode_) return
Utils.errorUnknownEnvironment(this.environment_)
if (this.environment_ === Environment.CLIENT) { if (this.environment_ === Environment.CLIENT) {
// client // client
return await this.callAsync( return await this.call(
playerOrEventName as string, playerOrEventName as string,
args as unknown[], args as unknown[],
) )
@ -332,7 +223,7 @@ class Rpc extends Wrapper {
_is1StParamPlayer(playerOrEventName) && _is1StParamPlayer(playerOrEventName) &&
_is2NdParamEventName(eventNameOrArgs) _is2NdParamEventName(eventNameOrArgs)
) { ) {
let state: RPCState = { const state: RPCState = {
uuid: Utils.generateUUID(), uuid: Utils.generateUUID(),
eventName: eventNameOrArgs, eventName: eventNameOrArgs,
calledTo: Environment.CLIENT, calledTo: Environment.CLIENT,
@ -345,13 +236,7 @@ class Rpc extends Wrapper {
const dataRaw = Utils.prepareTransfer(state) const dataRaw = Utils.prepareTransfer(state)
playerOrEventName.call(Events.LOCAL_EVENT_LISTENER, [dataRaw]) playerOrEventName.call(Events.LOCAL_EVENT_LISTENER, [dataRaw])
return (await this.responseHandler(state.uuid)).data
return await this.responseHandler(state.uuid)
.then(r => r.data)
.catch((e: string) => {
state.knownError = e
return this.triggerError_(state)
})
} }
// browser // browser
@ -373,78 +258,15 @@ class Rpc extends Wrapper {
const dataRaw = Utils.prepareTransfer(state) const dataRaw = Utils.prepareTransfer(state)
mp.trigger(Events.LOCAL_EVENT_LISTENER, dataRaw) mp.trigger(Events.LOCAL_EVENT_LISTENER, dataRaw)
return (await this.responseHandler(state.uuid)).data
return await this.responseHandler(state.uuid)
.then(r => r.data)
.catch((e: string) => {
state.knownError = e
return this.triggerError_(state)
})
}
function _is1StParamPlayer(x: unknown): x is PlayerMp {
return typeof x === 'object'
}
function _is2NdParamEventName(x: unknown): x is string {
return typeof x === 'string'
} }
} }
/** /**
* Calls a server-side event from browser or client. Use 'call' to call server from server * Calls a server-side event from browser or client
* *
* @template Arguments - An array of argument types to be passed to the server event * @template Arguments - An array of argument types to be passed to the server event
* @template EventName - A string or union representing the server event name * @template EventName - A string representing the server event name or union of names
*
* @param {EventName} eventName - The name of the server event to be called
* @param {Arguments} [args] - Optional arguments to pass to the server event
* @returns {void}
*
* @example
* // Calls an event on a server
* callServer<[], string, object>('onDataRequest')
*/
public callServer<
Arguments extends unknown[] = unknown[],
EventName extends string = string,
>(eventName: EventName, args?: Arguments): void {
this.log('callServer', eventName, args)
if (this.forceBrowserDevMode_) return
Utils.errorUnknownEnvironment(this.environment_)
const state: RPCState = {
uuid: Utils.generateUUID(),
eventName,
calledTo: Environment.SERVER,
calledFrom: this.environment_,
knownError: undefined,
data: args,
type: RPCEventType.EVENT,
}
const dataRaw = Utils.prepareTransfer(state)
switch (this.environment_) {
case Environment.SERVER:
this.callSelf(state)
break
case Environment.CLIENT:
mp.events.callRemote(Events.LOCAL_EVENT_LISTENER, dataRaw)
break
case Environment.BROWSER:
mp.trigger(Events.LOCAL_EVENT_LISTENER, dataRaw)
break
}
}
/**
* Calls an asynchronous server-side event from browser or client, expecting a response. Use 'callAsync' to call server from server
*
* @template Arguments - An array of argument types to be passed to the server event
* @template EventName - A string or union representing the server event name
* @template Return - The type of the value returned by the server event * @template Return - The type of the value returned by the server event
* *
* @param {EventName} eventName - The name of the server event to be called * @param {EventName} eventName - The name of the server event to be called
@ -452,17 +274,17 @@ class Rpc extends Wrapper {
* @returns {Promise<Return>} A promise resolving to the return value of the server event * @returns {Promise<Return>} A promise resolving to the return value of the server event
* *
* @example * @example
* // Calls an event on a server * // Calls an event on server
* callServer<[], string, object>('onDataRequest').then(response => { * callServer<[], string, object>('onDataRequest').then(response => {
* console.log(`Received: ${response}`) // ^ object * console.log(`Received: ${response}`) // ^ object
* }) * })
*/ */
public async callServerAsync< public async callServer<
Arguments extends unknown[] = unknown[], Arguments extends unknown[] = unknown[],
EventName extends string = string, EventName extends string = string,
Return = unknown, Return extends unknown = unknown,
>(eventName: EventName, args?: Arguments): Promise<Return> { >(eventName: EventName, args?: Arguments): Promise<Return> {
this.log('callServerAsync', eventName, args) this.log('callServer', eventName, args)
if (this.forceBrowserDevMode_) if (this.forceBrowserDevMode_)
return undefined as unknown as Promise<Return> return undefined as unknown as Promise<Return>
Utils.errorUnknownEnvironment(this.environment_) Utils.errorUnknownEnvironment(this.environment_)
@ -481,7 +303,7 @@ class Rpc extends Wrapper {
switch (this.environment_) { switch (this.environment_) {
case Environment.SERVER: case Environment.SERVER:
return this.callSelfAsync(state) return this.callSelf(state)
case Environment.CLIENT: case Environment.CLIENT:
mp.events.callRemote(Events.LOCAL_EVENT_LISTENER, dataRaw) mp.events.callRemote(Events.LOCAL_EVENT_LISTENER, dataRaw)
@ -492,108 +314,75 @@ class Rpc extends Wrapper {
break break
} }
return await this.responseHandler(state.uuid) return (await this.responseHandler(state.uuid)).data
.then(r => r.data)
.catch((e: string) => {
state.knownError = e
return this.triggerError_(state)
})
} }
/** /**
* Calls a browser-side event from client or server. Use 'call' to call browser from browser * Calls a browser-side event from server or client
*
* @template Arguments - An array of argument types to be passed to the browser event
* @template EventName - A string or union representing the browser event name
*
* @param {EventName} eventName - The name of the browser event to be called
* @param {Arguments} [args] - Optional arguments to pass to the browser event
* @returns {void}
*
* @example
* // Calls an event on a browser without specifying a player
* callBrowser<[], string, object>('onDataRequest')
*/
public callBrowser<
Arguments extends unknown[] = unknown[],
EventName extends string = string,
>(eventName: EventName, args?: Arguments): void
/**
* Calls a browser-side event from client or server. Use 'call' to call browser from browser
* *
* @template Arguments - An array of argument types to be passed to the browser event * @template Arguments - An array of argument types to be passed to the browser event
* @template EventName - A string representing the browser event name or union of names * @template EventName - A string representing the browser event name or union of names
* @template Return - The type of the value returned by the browser event
*
* @param {EventName} eventName - The name of the browser event to be called
* @param {Arguments} [args] - Optional arguments to pass to the browser event
* @returns {Promise<Return>} A promise resolving to the return value of the browser event
*
* @example
* // Calls an event on browser without specifying a player
* callBrowser<[], string, object>('onDataRequest').then(response => {
* console.log(`Received: ${response}`) // ^ object
* })
*/
public async callBrowser<
Arguments extends unknown[] = unknown[],
EventName extends string = string,
Return extends unknown = unknown,
>(eventName: EventName, args?: Arguments): Promise<Return>
/**
* Calls a browser-side event from server or client
*
* @template Arguments - An array of argument types to be passed to the browser event
* @template EventName - A string representing the browser event name or union of names
* @template Return - The type of the value returned by the browser event
* *
* @param {PlayerMp} player - The player for whom the browser event is called * @param {PlayerMp} player - The player for whom the browser event is called
* @param {EventName} eventName - The name of the browser event to be called * @param {EventName} eventName - The name of the browser event to be called
* @param {Arguments} [args] - Optional arguments to pass to the browser event * @param {Arguments} [args] - Optional arguments to pass to the browser event
* @returns {void} * @returns {Promise<Return>} A promise resolving to the return value of the browser event
* *
* @example * @example
* // Calls an event on a browser for a specific player * // Calls an event on a browser for a specific player
* callBrowser<[string, number], string, boolean>(player, 'onPlayerAction', ['jump', 2]) * callBrowser<[string, number], string, boolean>(player, 'onPlayerAction', ['jump', 2]).then(result => {
* console.log(`Action success: ${result}`) // ^ boolean
* })
*/ */
public callBrowser< public async callBrowser<
Arguments extends unknown[] = unknown[], Arguments extends unknown[] = unknown[],
EventName extends string = string, EventName extends string = string,
>(player: PlayerMp, eventName: EventName, args?: Arguments): void Return extends unknown = unknown,
public callBrowser( >(player: PlayerMp, eventName: EventName, args?: Arguments): Promise<Return>
public async callBrowser(
playerOrEventName: PlayerMp | string, playerOrEventName: PlayerMp | string,
eventNameOrArgs?: string | unknown[], eventNameOrArgs?: string | unknown[],
args?: unknown[], args?: unknown[],
) { ) {
if (_is1StParamPlayer(playerOrEventName)) { _is1StParamPlayer(playerOrEventName)
this.log( ? this.log(
'callBrowser', 'DEV callClient',
eventNameOrArgs as string, eventNameOrArgs as string,
playerOrEventName, playerOrEventName,
eventNameOrArgs, eventNameOrArgs,
args, args,
) )
} else { : this.log(
this.log( 'DEV callClient',
'callBrowser',
playerOrEventName as string, playerOrEventName as string,
eventNameOrArgs, eventNameOrArgs,
) )
}
if (this.forceBrowserDevMode_) return if (this.forceBrowserDevMode_) return
Utils.errorUnknownEnvironment(this.environment_) Utils.errorUnknownEnvironment(this.environment_)
const state: RPCState = {
uuid: Utils.generateUUID(),
eventName: !_is1StParamPlayer(playerOrEventName)
? playerOrEventName
: _is2NdParamEventName(eventNameOrArgs)
? eventNameOrArgs
: '',
calledTo: Environment.BROWSER,
calledFrom: this.environment_,
knownError: undefined,
data: _is1StParamPlayer(playerOrEventName) ? args : eventNameOrArgs,
type: RPCEventType.EVENT,
}
const dataRaw = Utils.prepareTransfer(state)
switch (this.environment_) {
case Environment.BROWSER:
this.callSelf(state)
break
case Environment.CLIENT:
mp.events.callRemote(Events.LOCAL_EVENT_LISTENER, dataRaw)
break
case Environment.SERVER:
;(playerOrEventName as PlayerMp).call(
Events.LOCAL_EVENT_LISTENER,
[dataRaw],
)
break
}
function _is1StParamPlayer(x: unknown): x is PlayerMp { function _is1StParamPlayer(x: unknown): x is PlayerMp {
return typeof x === 'object' return typeof x === 'object'
} }
@ -601,76 +390,6 @@ class Rpc extends Wrapper {
function _is2NdParamEventName(x: unknown): x is string { function _is2NdParamEventName(x: unknown): x is string {
return typeof x === 'string' return typeof x === 'string'
} }
}
/**
* Calls an asynchronous browser-side event from client or server, expecting response. Use 'callAsync' to call browser from browser
*
* @template Arguments - An array of argument types to be passed to the browser event
* @template EventName - A string or union representing the browser event name
* @template Return - The type of the value returned by the browser event
*
* @param {EventName} eventName - The name of the browser event to be called
* @param {Arguments} [args] - Optional arguments to pass to the browser event
* @returns {Promise<Return>} A promise resolving to the return value of the browser event
*
* @example
* // Calls an event on a browser without specifying a player
* callBrowser<[], string, object>('onDataRequest').then(response => {
* console.log(`Received: ${response}`) // ^ object
* })
*/
public async callBrowserAsync<
Arguments extends unknown[] = unknown[],
EventName extends string = string,
Return = unknown,
>(eventName: EventName, args?: Arguments): Promise<Return>
/**
* Calls an asynchronous browser-side event from client or server, expecting response. Use 'callAsync' to call browser from browser
*
* @template Arguments - An array of argument types to be passed to the browser event
* @template EventName - A string representing the browser event name or union of names
* @template Return - The type of the value returned by the browser event
*
* @param {PlayerMp} player - The player for whom the browser event is called
* @param {EventName} eventName - The name of the browser event to be called
* @param {Arguments} [args] - Optional arguments to pass to the browser event
* @returns {Promise<Return>} A promise resolving to the return value of the browser event
*
* @example
* // Calls an asynchronous event on a browser for a specific player
* callBrowser<[string, number], string, boolean>(player, 'onPlayerAction', ['jump', 2]).then(result => {
* console.log(`Action success: ${result}`) // ^ boolean
* })
*/
public async callBrowserAsync<
Arguments extends unknown[] = unknown[],
EventName extends string = string,
Return = unknown,
>(player: PlayerMp, eventName: EventName, args?: Arguments): Promise<Return>
public async callBrowserAsync(
playerOrEventName: PlayerMp | string,
eventNameOrArgs?: string | unknown[],
args?: unknown[],
) {
if (_is1StParamPlayer(playerOrEventName)) {
this.log(
'callBrowserAsync',
eventNameOrArgs as string,
playerOrEventName,
eventNameOrArgs,
args,
)
} else {
this.log(
'callBrowserAsync',
playerOrEventName as string,
eventNameOrArgs,
)
}
if (this.forceBrowserDevMode_) return
Utils.errorUnknownEnvironment(this.environment_)
const state: RPCState = { const state: RPCState = {
uuid: Utils.generateUUID(), uuid: Utils.generateUUID(),
@ -704,62 +423,14 @@ class Rpc extends Wrapper {
break break
} }
return await this.responseHandler(state.uuid) return (await this.responseHandler(state.uuid)).data
.then(r => r.data)
.catch((e: string) => {
state.knownError = e
return this.triggerError_(state)
})
function _is1StParamPlayer(x: unknown): x is PlayerMp {
return typeof x === 'object'
}
function _is2NdParamEventName(x: unknown): x is string {
return typeof x === 'string'
}
} }
/** /**
* Calls an event in current environment * Calls an event in current environment
* *
* @template Arguments - An array of argument types to be passed to the event * @template Arguments - An array of argument types to be passed to the event
* @template EventName - A string or union representing the event name * @template EventName - A string representing the event name or union of names
*
* @param {EventName} eventName - The name of the event to be called
* @param {Arguments} [args] - Optional arguments to pass to the event
* @returns {void}
*
* @example
* // Calls an event in current environment
* call<[], string>('getSomething')
*/
public call<
Arguments extends unknown[] = unknown[],
EventName extends string = string,
>(eventName: EventName, args?: Arguments): void {
this.log('call', eventName, args)
if (this.forceBrowserDevMode_) return
Utils.errorUnknownEnvironment(this.environment_)
const state: RPCState = {
uuid: Utils.generateUUID(),
eventName,
calledTo: this.environment_,
calledFrom: this.environment_,
knownError: undefined,
data: args,
type: RPCEventType.EVENT,
}
this.callSelf(state)
}
/**
* Calls an asynchronous event in current environment, expecting a response
*
* @template Arguments - An array of argument types to be passed to the event
* @template EventName - A string or union representing the event name
* @template Return - The type of the value returned by the event * @template Return - The type of the value returned by the event
* *
* @param {EventName} eventName - The name of the event to be called * @param {EventName} eventName - The name of the event to be called
@ -772,17 +443,17 @@ class Rpc extends Wrapper {
* console.log(`Received: ${response}`) // ^ number * console.log(`Received: ${response}`) // ^ number
* }) * })
*/ */
public async callAsync< public async call<
Arguments extends unknown[] = unknown[], Arguments extends unknown[] = unknown[],
EventName extends string = string, EventName extends string = string,
Return = unknown, Return extends unknown = unknown,
>(eventName: EventName, args?: Arguments): Promise<Return> { >(eventName: EventName, args?: Arguments): Promise<Return> {
this.log('callAsync', eventName, args) this.log('call', eventName, args)
if (this.forceBrowserDevMode_) if (this.forceBrowserDevMode_)
return undefined as unknown as Promise<Return> return undefined as unknown as Promise<Return>
Utils.errorUnknownEnvironment(this.environment_) Utils.errorUnknownEnvironment(this.environment_)
const state: RPCState = { let state: RPCState = {
uuid: Utils.generateUUID(), uuid: Utils.generateUUID(),
eventName, eventName,
calledTo: this.environment_, calledTo: this.environment_,
@ -792,25 +463,13 @@ class Rpc extends Wrapper {
type: RPCEventType.EVENT, type: RPCEventType.EVENT,
} }
return await this.callSelfAsync<Return>(state) return await this.callSelf<Return>(state)
} }
/** /**
* redirects an event in cases of it calling its own environment * redirects an event in cases of it calling its own environment
*/ */
private callSelf(state: RPCState): void { private async callSelf<Return extends unknown = unknown>(
state = this.verifyEvent_(state)
if (state.knownError) {
this.triggerError_(state, state.knownError)
}
this.state_[state.eventName](...state.data)
}
/**
* redirects an asynchronous event in cases of it calling its own environment
*/
private async callSelfAsync<Return = unknown>(
state: RPCState, state: RPCState,
): Promise<Return> { ): Promise<Return> {
state = this.verifyEvent_(state) state = this.verifyEvent_(state)

View File

@ -1,10 +1,8 @@
/// <reference types="@ragempcommunity/types-server" />
import { Wrapper } from './wrapper' import { Wrapper } from './wrapper'
import { import {
type PlayerMp,
Environment, Environment,
Events, Events,
type PlayerMp,
RPCEventType, RPCEventType,
RPCState, RPCState,
RpcWrapperConfig, RpcWrapperConfig,
@ -22,7 +20,7 @@ export class Server extends Wrapper {
) { ) {
super(options) super(options)
if (options.forceBrowserDevMode) return if (!!options.forceBrowserDevMode) return
// specific event to save player in context as it is not available on server -> server calls // specific event to save player in context as it is not available on server -> server calls
mp.events.add( mp.events.add(
@ -37,7 +35,7 @@ export class Server extends Wrapper {
* NOT INTENDED FOR OUT-OF-CONTEXT USE * NOT INTENDED FOR OUT-OF-CONTEXT USE
*/ */
public _resolveEmitDestination(player: PlayerMp, dataRaw: string) { public _resolveEmitDestination(player: PlayerMp, dataRaw: string) {
const state = Utils.prepareExecution(dataRaw) let state = Utils.prepareExecution(dataRaw)
switch (state.calledTo) { switch (state.calledTo) {
case Environment.SERVER: case Environment.SERVER:

View File

@ -29,7 +29,7 @@ export class Wrapper {
// checks if event is available (registered) in current environment // checks if event is available (registered) in current environment
protected verifyEvent_(data: string | RPCState): RPCState { protected verifyEvent_(data: string | RPCState): RPCState {
const rpcData = let rpcData =
typeof data === 'string' ? Utils.prepareExecution(data) : data typeof data === 'string' ? Utils.prepareExecution(data) : data
if (!this.state_[rpcData.eventName]) { if (!this.state_[rpcData.eventName]) {

View File

@ -1,18 +1,29 @@
{ {
"$schema": "https://json.schemastore.org/tsconfig",
"display": "RPC",
"compilerOptions": { "compilerOptions": {
"target": "es6",
"module": "commonjs",
"moduleResolution": "node", "moduleResolution": "node",
"lib": [ "lib": [
"es2022", "ES6",
"dom" "dom"
], ],
"declaration": true, "declaration": true,
"declarationMap": true, "declarationMap": true,
"sourceMap": true, "sourceMap": true,
"outDir": "bin",
"esModuleInterop": true,
"strict": true,
"forceConsistentCasingInFileNames": true,
"noImplicitAny": true,
}, },
"include": [ "include": [
"src" "src/**/*",
"./index.d.ts"
], ],
"extends": ["../tsconfig.ragefw.json"] "exclude": [
"node_modules",
"dist"
]
} }

View File

@ -1,4 +1,4 @@
Custom Attribution-NoDerives Software License Custom Attribution-NoDerivs Software License
Copyright (c) 2024 Entity Seven Group Copyright (c) 2024 Entity Seven Group

View File

@ -1,50 +1,25 @@
{ {
"private": false,
"name": "@entityseven/rage-fw-server", "name": "@entityseven/rage-fw-server",
"version": "0.2.0", "version": "0.2.0",
"main": "dist/index.js",
"types": "dist/src/index.d.ts",
"files": [ "files": [
"dist/**/*", "dist/**/*",
"readme.md", "readme.md",
"LICENSE", "LICENSE"
"package.json"
], ],
"main": "src/index.ts",
"exports": {
".": "./src/index.ts"
},
"publishConfig": {
"access": "public",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"exports": {
".": "./dist/index.js"
}
},
"scripts": { "scripts": {
"build": "tsup" "build": "tsup"
}, },
"dependencies": { "dependencies": {
"@entityseven/rage-fw-rpc": "workspace:*", "@entityseven/rage-fw-rpc": "0.2.5"
"zod": "^3.24.1"
},
"devDependencies": {
"@types/node": "22.12.0"
}, },
"peerDependencies": { "peerDependencies": {
"@entityseven/rage-fw-shared-types": "workspace:*", "@entityseven/rage-fw-shared-types": "0.2.0",
"@ragempcommunity/types-server": "^2.1.8", "@ragempcommunity/types-server": "^2.1.8"
"typescript": "^5.7.3"
}, },
"description": "Package used on a server-side of your Rage:MP Server", "description": "Package used on a server-side of your Rage:MP Server",
"keywords": [ "keywords": ["rage-fw-server", "ragefw", "rage-fw", "ragemp", "rage:mp", "rage", "gta5"],
"rage-fw-server",
"ragefw",
"rage-fw",
"ragemp",
"rage:mp",
"rage",
"gta5"
],
"author": "Entity Seven Group", "author": "Entity Seven Group",
"contributors": [ "contributors": [
{ {

View File

@ -3,9 +3,9 @@ import winston, { format } from 'winston'
const { timestamp, printf, colorize } = format const { timestamp, printf, colorize } = format
/** Used to log in a server console */ /** Used to log in a server console */
export class FW_Logger { export class Logger {
private format = printf(({ message, level }) => { private format = printf(({ message, level, timestamp }) => {
return `[${new Date().toLocaleTimeString(undefined, { hour: 'numeric', minute: 'numeric', second: 'numeric', fractionalSecondDigits: 2 })}] [${level}]: ${message}` return `[${new Date(timestamp).toLocaleTimeString()}] [${level}]: ${message}`
}) })
private systemLogger = winston.createLogger({ private systemLogger = winston.createLogger({

View File

@ -1,12 +1,12 @@
import type * as T from '../types' import type * as T from '../types'
export class FW_Middleware { export class Middleware {
constructor() {} constructor() {}
private static async execute<EventName extends T.FW_ServerEvent>( private static async execute<EventName extends T.RageFW_ServerEvent>(
middlewares: T.FW_MiddlewareFunction<EventName>[], middlewares: T.RageFW_MiddlewareFunction<EventName>[],
args: T.FW_ServerArgs<EventName>, args: T.RageFW_ServerArgs<EventName>,
): Promise<T.FW_MiddlewareResponseInternal> { ): Promise<T.RageFW_MiddlewareResponseInternal> {
for (let i = 0; i < middlewares.length; i++) { for (let i = 0; i < middlewares.length; i++) {
const result = await middlewares[i](...args) const result = await middlewares[i](...args)
@ -21,20 +21,20 @@ export class FW_Middleware {
} }
} }
public static async process<EventName extends T.FW_ServerEvent>( public static async process<EventName extends T.RageFW_ServerEvent>(
middlewareOptions: T.FW_MiddlewareOptions<EventName>, middlewareOptions: T.RageFW_MiddlewareOptions<EventName>,
callback: T.FW_ServerCallback<EventName>, callback: T.RageFW_ServerCallback<EventName>,
args: T.FW_ServerArgs<EventName>, args: T.RageFW_ServerArgs<EventName>,
) { ) {
if (Array.isArray(middlewareOptions)) { if (Array.isArray(middlewareOptions)) {
const middlewaresResponse = await FW_Middleware.execute( const middlewaresResponse = await Middleware.execute(
middlewareOptions, middlewareOptions,
args, args,
) )
if (middlewaresResponse.success) return await callback(...args) if (middlewaresResponse.success) return await callback(...args)
} else { } else {
const middlewaresResponse = await FW_Middleware.execute( const middlewaresResponse = await Middleware.execute(
middlewareOptions.executables, middlewareOptions.executables,
args, args,
) )

View File

@ -2,45 +2,15 @@ import { rpc } from './rpc'
import type * as T from '../types' import type * as T from '../types'
/** Handles event manipulations that require player to be present in context */ /** Handles event manipulations that require player to be present in context */
export class FW_Player { export class Player {
/** /**
* Triggers a client event from the server with arguments from 'rage-fw-shared-types' * Triggers a client event from the server with arguments from shared types
* *
* Formerly known as ``callClient`` or ``emitClient`` * Formerly known as ``callClient`` or ``emitClient``
* *
* @param {PlayerMp} player - Player object as an event target * @param {PlayerMp} player - Player object as an event target
* @param eventName - The name of the client event to trigger * @param eventName - The name of the client event to trigger
* @param [args] - Arguments for the client event, if present * @param [args] - Arguments for the client event, if present
* @returns {void}
*
* @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 triggerClient<EventName extends T.FW_ClientEvent>(
player: PlayerMp,
eventName: EventName,
...args: T._ClientEventHasArgs<EventName> extends true
? [T.FW_ClientArgs<EventName>]
: []
): void {
rpc.callClient<typeof args, EventName>(player, eventName, args)
}
/**
* Triggers an asynchronous client event from the server with arguments from 'rage-fw-shared-types', and expects to receive a response from an event
*
* Formerly known as ``callClientAsync`` or ``emitClientAsync``
*
* @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 * @returns {Promise} resolving to the client's response for the event
* *
* @example * @example
@ -53,29 +23,25 @@ export class FW_Player {
* *
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki} * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/ */
public async triggerClientAsync<EventName extends T.FW_ClientEvent>( public async triggerClient<EventName extends T.RageFW_ClientEvent>(
player: PlayerMp, player: PlayerMp,
eventName: EventName, eventName: EventName,
...args: T._ClientEventHasArgs<EventName> extends true ...args: T._ClientEventHasArgs<EventName> extends true
? [T.FW_ClientArgs<EventName>] ? [T.RageFW_ClientArgs<EventName>]
: [] : []
): Promise<T.FW_ClientReturn<EventName>> { ): Promise<T.RageFW_ClientReturn<EventName>> {
return await rpc.callClientAsync< return await rpc.callClient(player, eventName, args)
typeof args,
EventName,
T.FW_ClientReturn<EventName>
>(player, eventName, args)
} }
/** /**
* Triggers a browser event from the server with arguments from 'rage-fw-shared-types' * Triggers a browser event from the server with arguments from shared types
* *
* Formerly known as ``callBrowser`` or ``emitBrowser`` * Formerly known as ``callBrowser`` or ``emitBrowser``
* *
* @param {PlayerMp} player - Player object as an event target * @param {PlayerMp} player - Player object as an event target
* @param eventName - The name of the browser event to trigger * @param eventName - The name of the browser event to trigger
* @param [args] - Arguments for the browser event, if present * @param [args] - Arguments for the browser event, if present
* @returns {void} * @returns {Promise} resolving to the browser's response for the event
* *
* @example * @example
* // Triggering a browser event without arguments * // Triggering a browser event without arguments
@ -87,47 +53,16 @@ export class FW_Player {
* *
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki} * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/ */
public triggerBrowser<EventName extends T.FW_BrowserEvent>( public async triggerBrowser<EventName extends T.RageFW_BrowserEvent>(
player: PlayerMp, player: PlayerMp,
eventName: EventName, eventName: EventName,
...args: T._BrowserEventHasArgs<EventName> extends true ...args: T._BrowserEventHasArgs<EventName> extends true
? [T.FW_BrowserArgs<EventName>] ? [T.RageFW_BrowserArgs<EventName>]
: [] : []
): void { ): Promise<T.RageFW_BrowserReturn<EventName>> {
rpc.callBrowser<typeof args, EventName>(player, eventName, args) return await rpc.callBrowser(player, eventName, args)
}
} }
/** // new Player().triggerBrowser({} as PlayerMp, 'customCefEvent', ['', 1])
* Triggers an asynchronous browser event from the server with arguments from 'rage-fw-shared-types', and expects to receive a response from an event // new Player().triggerClient({} as PlayerMp, 'customClientEvent', ['', 1])
*
* Formerly known as ``callBrowserAsync`` or ``emitBrowserAsync``
*
* @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.triggerBrowserAsync("browserEventName")
*
* @example
* // Triggering a browser event with arguments
* fw.player.triggerBrowserAsync("browserEventName", ["message to browser"])
*
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/
public async triggerBrowserAsync<EventName extends T.FW_BrowserEvent>(
player: PlayerMp,
eventName: EventName,
...args: T._BrowserEventHasArgs<EventName> extends true
? [T.FW_BrowserArgs<EventName>]
: []
): Promise<T.FW_BrowserReturn<EventName>> {
return await rpc.callBrowserAsync<
typeof args,
EventName,
T.FW_BrowserReturn<EventName>
>(player, eventName, args)
}
}

View File

@ -1,9 +1,9 @@
import { rpc } from './rpc' import { rpc } from './rpc'
import { FW_Middleware } from './middleware' import { Middleware } from './middleware'
import type * as T from '../types' import type * as T from '../types'
/** Server-side interactions */ /** Server-side interactions */
export class FW_Server { export class Server {
/** /**
* Registers a server event with an associated callback * Registers a server event with an associated callback
* *
@ -11,7 +11,7 @@ export class FW_Server {
* @param callback - The callback function to be executed when the event is triggered * @param callback - The callback function to be executed when the event is triggered
* @param [options] - Optional settings for callback execution * @param [options] - Optional settings for callback execution
* @param [options.middlewares] - Middleware functions to be checked before the callback executes * @param [options.middlewares] - Middleware functions to be checked before the callback executes
* @returns {FW_Server} The current server instance, enabling method chaining * @returns {Server} The current server instance, enabling method chaining
* *
* @example * @example
* // Registering an event * // Registering an event
@ -40,13 +40,13 @@ export class FW_Server {
* *
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki} * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/ */
public register<EventName extends T.FW_ServerEvent>( public register<EventName extends T.RageFW_ServerEvent>(
eventName: EventName, eventName: EventName,
callback: T.FW_ServerCallback<EventName>, callback: T.RageFW_ServerCallback<EventName>,
options?: { options?: {
middlewares?: T.FW_MiddlewareOptions<EventName> middlewares?: T.RageFW_MiddlewareOptions<EventName>
}, },
): FW_Server { ): Server {
rpc.register< rpc.register<
Parameters<typeof callback>, Parameters<typeof callback>,
ReturnType<typeof callback> | Promise<unknown>, ReturnType<typeof callback> | Promise<unknown>,
@ -54,7 +54,7 @@ export class FW_Server {
>(eventName, async (...data) => { >(eventName, async (...data) => {
if (!options?.middlewares) return await callback(...data) if (!options?.middlewares) return await callback(...data)
await FW_Middleware.process(options.middlewares, callback, data) await Middleware.process(options.middlewares, callback, data)
}) })
return this return this
@ -64,7 +64,7 @@ export class FW_Server {
* Unregisters a server event, removing the associated callback * Unregisters a server event, removing the associated callback
* *
* @param eventName - The name of the event to unregister * @param eventName - The name of the event to unregister
* @returns {FW_Server} The current server instance, enabling method chaining * @returns {Server} The current server instance, enabling method chaining
* *
* @example * @example
* // Unregistering an event * // Unregistering an event
@ -72,21 +72,25 @@ export class FW_Server {
* *
* @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki} * @see {@link https://git.entityseven.com/entityseven/rage-framework/wiki Wiki}
*/ */
public unregister<EventName extends T.FW_ServerEvent>( public unregister<EventName extends T.RageFW_ServerEvent>(
eventName: EventName, eventName: EventName,
): FW_Server { ): Server {
rpc.unregister<EventName>(eventName) rpc.unregister<EventName>(eventName)
return this return this
} }
// fixme // fixme
// public trigger<EventName extends keyof T.FW_ICustomServerEvent>( // public trigger<EventName extends keyof T.RageFW_ICustomServerEvent>(
// eventName: EventName, // eventName: EventName,
// ...args: T._ServerEventHasArgs<EventName> extends true // ...args: T._ServerEventHasArgs<EventName> extends true
// ? [T.FW_ServerArgs<EventName>] // ? [T.RageFW_ServerArgs<EventName>]
// : [] // : []
// ): Promise<T.FW_ServerReturn<EventName>> { // ): Promise<T.RageFW_ServerReturn<EventName>> {
// return rpc.call(eventName, args) // return rpc.call(eventName, args)
// } // }
} }
// new Server()
// .register('customServerEvent', async (a, b, c) => true)
// .unregister('customServerEvent')

View File

@ -1,6 +1,6 @@
import { FW_Logger, FW_Player, FW_Server, rpc } from './core' import { Logger, Player, Server, rpc } from './core'
export type { FW_MiddlewareFunction } from './types' export type { RageFW_MiddlewareFunction } from './types'
/** /**
* Package used on a server-side of your Rage:MP Server * Package used on a server-side of your Rage:MP Server
@ -9,13 +9,13 @@ export type { FW_MiddlewareFunction } from './types'
*/ */
export const fw = { export const fw = {
/** Server-side interactions */ /** Server-side interactions */
event: new FW_Server(), event: new Server(),
/** Handles event manipulations that require player to be present in context */ /** Handles event manipulations that require player to be present in context */
player: new FW_Player(), player: new Player(),
/** Handles functions used to interact with the client environment */ /** Handles functions used to interact with the client environment */
system: { system: {
/** Used to log in a server console */ /** Used to log in a server console */
log: new FW_Logger(), 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 */ /** ``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, rpc,

View File

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

View File

@ -1,35 +1,38 @@
/// <reference types="@ragempcommunity/types-server" /> /// <reference types="@ragempcommunity/types-server" />
import type { FW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types' import type { RageFW_ICustomClientEvent } from '@entityseven/rage-fw-shared-types'
/** /**
* Union of all available client event names * Union of all available client event names
* These only include custom events * These only include custom events
*/ */
export type FW_ClientEvent = keyof FW_ICustomClientEvent export type RageFW_ClientEvent = keyof RageFW_ICustomClientEvent
/** /**
* Array of arguments of an event you pass as a generic * Array of arguments of an event you pass as a generic
* These only include custom events * These only include custom events
*/ */
export type FW_ClientArgs<K extends FW_ClientEvent> = K extends FW_ClientEvent export type RageFW_ClientArgs<K extends RageFW_ClientEvent> =
? Parameters<FW_ICustomClientEvent[K]> K extends RageFW_ClientEvent
? Parameters<RageFW_ICustomClientEvent[K]>
: never : never
/** /**
* Return type of event you pass as a generic * Return type of event you pass as a generic
* These only include custom events * These only include custom events
*/ */
export type FW_ClientReturn<K extends FW_ClientEvent> = K extends FW_ClientEvent export type RageFW_ClientReturn<K extends RageFW_ClientEvent> =
? ReturnType<FW_ICustomClientEvent[K]> K extends RageFW_ClientEvent
? ReturnType<RageFW_ICustomClientEvent[K]>
: never : never
/** /**
* *
*/ */
export type _ClientEventHasArgs<EventName extends keyof FW_ICustomClientEvent> = export type _ClientEventHasArgs<
keyof FW_ICustomClientEvent extends never EventName extends keyof RageFW_ICustomClientEvent,
> = keyof RageFW_ICustomClientEvent extends never
? false ? false
: Parameters<FW_ICustomClientEvent[EventName]>[0] extends undefined : Parameters<RageFW_ICustomClientEvent[EventName]>[0] extends undefined
? false ? false
: true : true

View File

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

View File

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

View File

@ -1,25 +1,27 @@
/// <reference types="@ragempcommunity/types-server" /> /// <reference types="@ragempcommunity/types-server" />
import type { import type {
FW_ICustomClientEvent, RageFW_ICustomClientEvent,
FW_ICustomServerEvent, RageFW_ICustomServerEvent,
} from '@entityseven/rage-fw-shared-types' } from '@entityseven/rage-fw-shared-types'
export type { FW_ICustomServerEvent } from '@entityseven/rage-fw-shared-types' export type { RageFW_ICustomServerEvent } from '@entityseven/rage-fw-shared-types'
/** /**
* Union of all available server event names * Union of all available server event names
* These also include system events * These also include system events
*/ */
export type FW_ServerEvent = keyof FW_ICustomServerEvent | keyof IServerEvents export type RageFW_ServerEvent =
| keyof RageFW_ICustomServerEvent
| keyof IServerEvents
/** /**
* Array of arguments for an event, name of which you pass as a generic * Array of arguments for an event, name of which you pass as a generic
* These also include system events * These also include system events
*/ */
export type FW_ServerArgs<K extends FW_ServerEvent> = export type RageFW_ServerArgs<K extends RageFW_ServerEvent> =
K extends keyof FW_ICustomServerEvent K extends keyof RageFW_ICustomServerEvent
? [PlayerMp, ...Parameters<FW_ICustomServerEvent[K]>] ? [PlayerMp, ...Parameters<RageFW_ICustomServerEvent[K]>]
: K extends keyof IServerEvents : K extends keyof IServerEvents
? [PlayerMp, Parameters<IServerEvents[K]>] ? [PlayerMp, Parameters<IServerEvents[K]>]
: never : never
@ -28,9 +30,9 @@ export type FW_ServerArgs<K extends FW_ServerEvent> =
* Return type for an event, name of which you pass as a generic * Return type for an event, name of which you pass as a generic
* These include system and custom events * These include system and custom events
*/ */
export type FW_ServerReturn<K extends FW_ServerEvent> = export type RageFW_ServerReturn<K extends RageFW_ServerEvent> =
K extends keyof FW_ICustomServerEvent K extends keyof RageFW_ICustomServerEvent
? ReturnType<FW_ICustomServerEvent[K]> ? ReturnType<RageFW_ICustomServerEvent[K]>
: K extends keyof IServerEvents : K extends keyof IServerEvents
? ReturnType<IServerEvents[K]> ? ReturnType<IServerEvents[K]>
: void : void
@ -39,18 +41,20 @@ export type FW_ServerReturn<K extends FW_ServerEvent> =
* Callback (function) for an event, name of which you pass as a generic * Callback (function) for an event, name of which you pass as a generic
* These include system and custom events * These include system and custom events
*/ */
export type FW_ServerCallback<K extends FW_ServerEvent> = ( export type RageFW_ServerCallback<K extends RageFW_ServerEvent> = (
...args: FW_ServerArgs<K> ...args: RageFW_ServerArgs<K>
) => Promise<FW_ServerReturn<K>> ) => Promise<RageFW_ServerReturn<K>>
/** /**
* *
*/ */
export type _ServerEventHasArgs<EventName extends FW_ServerEvent> = export type _ServerEventHasArgs<EventName extends RageFW_ServerEvent> =
EventName extends keyof FW_ICustomServerEvent EventName extends keyof RageFW_ICustomServerEvent
? keyof FW_ICustomClientEvent extends never ? keyof RageFW_ICustomClientEvent extends never
? false ? false
: Parameters<FW_ICustomServerEvent[EventName]>[0] extends undefined : Parameters<
RageFW_ICustomServerEvent[EventName]
>[0] extends undefined
? false ? false
: true : true
: EventName extends keyof IServerEvents : EventName extends keyof IServerEvents

View File

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

View File

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

View File

@ -1,4 +1,4 @@
# Custom Attribution-NoDerives Software License # 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: This license allows you to use, copy, and distribute the RageFW (the "Software"), including for commercial purposes, provided that the following conditions are met:

View File

@ -1,14 +1,12 @@
{ {
"private": false, "name": "@entityseven/rage-fw-shared-types",
"version": "0.2.0",
"types": "types/types/index.d.ts",
"files": [ "files": [
"types/**/*", "types/**/*",
"readme.md", "readme.md",
"LICENSE", "LICENSE"
"package.json"
], ],
"types": "types/types/index.d.ts",
"name": "@entityseven/rage-fw-shared-types",
"version": "0.2.0",
"description": "Package used among all environments of your Rage-FW based server", "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"], "keywords": ["rage-fw-shared-types", "rage-fw-shared","ragefw", "rage-fw", "ragemp", "rage:mp", "rage", "gta5"],
"type": "module", "type": "module",
@ -25,6 +23,6 @@
"url": "https://github.com/SashaGoncharov19/" "url": "https://github.com/SashaGoncharov19/"
} }
], ],
"license": "Custom-Attribution-NoDerives", "license": "Custom-Attribution-NoDerivs",
"gitHead": "ffd542c1deddb3033e16e0dae7557313ae09b05f" "gitHead": "ffd542c1deddb3033e16e0dae7557313ae09b05f"
} }

View File

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

View File

@ -1,9 +1,9 @@
{ {
"compilerOptions": { "compilerOptions": {
"target": "es2022", "target": "ESNext",
"lib": [ "lib": [
"ESNext", "ESNext",
"es2022", "ES2019",
"dom" "dom"
], ],
"moduleResolution": "node", "moduleResolution": "node",

View File

@ -1,29 +0,0 @@
{
"compilerOptions": {
"incremental": false,
"composite": false,
"target": "es2022",
"moduleDetection": "auto",
"module": "commonjs",
"esModuleInterop": true,
"experimentalDecorators": true,
"forceConsistentCasingInFileNames": true,
"noImplicitAny": true,
"resolveJsonModule": true,
"skipLibCheck": true,
"strict": true,
"declaration": false,
"declarationMap": false,
"downlevelIteration": false,
"inlineSourceMap": false,
"sourceMap": false
},
"exclude": [
"node_modules",
"dist",
".tsup"
]
}