Compare commits

...
Author SHA1 Message Date
rilaxik fd9f1cab18 upd core
- added zod integration (validation) for testing
2024-11-01 13:20:07 +00:00
rilaxik 21ca123797 upd core
- specified exact exports for further compatibility
2024-11-01 13:19:43 +00:00
rilaxik 495217ecd5 upd cli
- handled process exit
- updated docs + readme
- typos fix
2024-10-30 18:31:53 +00:00
rilaxik 7e43e0d106 Merge remote-tracking branch 'origin/master'
# Conflicts:
#	cli/package.json
#	rpc/package.json
2024-10-30 17:01:42 +00:00
rilaxik 2f1d1d9f0d hotfix
- licenses
- package.json consistency
- links bump
2024-10-30 17:00:36 +00:00
rilaxik cc40d90070 hotfix
- licenses
- package.json consistency
- links bump
2024-10-30 16:59:33 +00:00
rilaxik 469d970654 Merge branch 'dev' 2024-10-30 16:29:29 +00:00
rilaxik 217e0ddf01 Merge pull request 'Server/Client middlewares + JSDoc' (#6) from unstable into dev
Reviewed-on: #6
2024-10-30 16:21:29 +00:00
rilaxik ea572070ef versions rollback 2024-10-30 16:21:03 +00:00
rilaxik d56475d08a Merge pull request 'Consistency updates + cleanup' (#5) from unstable into dev
Reviewed-on: #5
2024-10-29 17:03:31 +00:00
rilaxik c2684a48fc Merge pull request 'Rpc integration + type fixes' (#3) from dev into master
Reviewed-on: #3
2024-10-28 12:13:19 +00:00
sashagoncharov19 0059a41d0d Update readme.md 2024-06-17 03:47:57 +00:00
rilaxik cc1ebbd66b quickfix issue template had extra optional label 2024-06-15 14:54:07 +01:00
sashagoncharov19 301a65e77f v0.1.0
Reviewed-on: #2
2024-06-15 13:50:13 +00:00
45 changed files with 6794 additions and 8687 deletions
+2 -2
View File
@@ -28,7 +28,7 @@ body:
- type: textarea
id: reproduction
attributes:
label: Reproduction (Optional)
label: Reproduction
description: Steps to reproduce the bug, if applicable
validations:
required: true
@@ -57,7 +57,7 @@ body:
- type: textarea
id: additional_information
attributes:
label: Additional Information
label: Additional Information (Optional)
description: Add any other information that might be useful in diagnosing the issue
validations:
required: false
View File
+15
View File
@@ -0,0 +1,15 @@
Custom Attribution-NoDerivs Software License
Copyright (c) 2024 Entity Seven Group
This license allows you to use, copy, and distribute the RageFW (the "Software"), including for commercial purposes, provided that the following conditions are met:
1. **Attribution:** You must give appropriate credit to the original author of the Software, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
2. **No Derivative Works:** You may not modify, transform, or build upon the Software.
3. **Usage and Commercial Use:** You are allowed to use, sell, and gain income from projects that utilize the Software, as long as you comply with the terms of this license.
4. **No Additional Restrictions:** You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
BIN
View File
Binary file not shown.
+46 -29
View File
@@ -1,32 +1,49 @@
{
"name": "@entityseven/rage-fw-browser",
"version": "0.2.1-0.2.0-alpha.2.0",
"main": "dist/index.js",
"types": "dist/src/index.d.ts",
"files": [
"dist/**/*",
"readme.md"
],
"scripts": {
"build": "tsup"
"name": "@entityseven/rage-fw-browser",
"version": "0.2.0",
"main": "dist/index.js",
"types": "dist/src/index.d.ts",
"files": [
"dist/**/*",
"readme.md",
"LICENSE"
],
"exports": {
".": "./dist/index.js"
},
"scripts": {
"build": "tsup"
},
"dependencies": {
"@entityseven/rage-fw-rpc": "0.2.5",
"zod": "^3.23.8"
},
"peerDependencies": {
"@entityseven/rage-fw-shared-types": "0.2.0",
"@ragempcommunity/types-cef": "^2.1.8"
},
"description": "Package used on a browser-side of your Rage:MP Server",
"keywords": [
"ragefw",
"rage-fw",
"ragemp",
"rage:mp",
"rage",
"gta5"
],
"author": "Entity Seven Group",
"contributors": [
{
"name": "Danya H",
"email": "[email protected]",
"url": "https://github.com/rilaxik/"
},
"dependencies": {
"@entityseven/rage-fw-rpc": "latest"
},
"peerDependencies": {
"@entityseven/rage-fw-shared-types": "workspace:^",
"@ragempcommunity/types-cef": "^2.1.8"
},
"description": "RageFW CEF side",
"keywords": [],
"author": "SashaGoncharov19",
"contributors": [
{
"name": "rilaxik",
"email": "[email protected]",
"url": "https://github.com/rilaxik"
}
],
"license": "MIT",
"gitHead": "ffd542c1deddb3033e16e0dae7557313ae09b05f"
{
"name": "Oleksandr Honcharov",
"email": "[email protected]",
"url": "https://github.com/SashaGoncharov19/"
}
],
"license": "Custom-Attribution-NoDerivs",
"gitHead": "ffd542c1deddb3033e16e0dae7557313ae09b05f"
}
+2 -2
View File
@@ -1,2 +1,2 @@
# RageFW CEF
[Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki/Docs)
# RageFW Browser
[Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki)
+19 -8
View File
@@ -1,11 +1,7 @@
import { Helper } from './helper'
import { rpc } from './rpc'
import { Helper } from './helper'
import { Validation } from './validation'
import type * as T from '../types'
import {
RageFW_BrowserEvent,
RageFW_ClientEvent,
RageFW_ServerEvent,
} from '../types'
/** Browser-side interactions */
export class Browser extends Helper {
@@ -34,6 +30,8 @@ export class Browser extends Helper {
*
* @param eventName - The name of the event to register
* @param callback - The callback function to be executed when the event is triggered
* @param [options] - Optional settings for callback execution
* @param [options.validation] - Validation schema to be checked before the callback executes
* @returns {Browser} The current browser instance, enabling method chaining
*
* @example
@@ -47,14 +45,27 @@ export class Browser extends Helper {
public register<EventName extends T.RageFW_BrowserEvent>(
eventName: EventName,
callback: T.RageFW_BrowserCallback<EventName>,
options?: {
validation?: T.RageFW_ValidationOptions
},
): Browser {
this.log_('register', eventName, callback)
rpc.register<
Parameters<typeof callback>,
ReturnType<typeof callback>,
ReturnType<typeof callback> | Promise<unknown>,
EventName
>(eventName, async (...data) => await callback(...data))
>(eventName, async (...data) => {
if (!options?.validation) return await callback(...data)
const validationSuccess = Validation.process(
data,
options?.validation,
)
if (!validationSuccess) return
return await callback(...data)
})
return this
}
+26
View File
@@ -0,0 +1,26 @@
import type * as T from '../types'
export class Validation {
constructor() {}
public static process<EventName extends T.RageFW_BrowserEvent>(
args: T.RageFW_BrowserArgs<EventName>,
validationOptions?: T.RageFW_ValidationOptions,
): boolean {
if (!validationOptions) return true
if ('schema' in validationOptions) {
const validationResponse = validationOptions.schema.safeParse(args)
if (validationResponse.success) {
return true
} else {
validationOptions.onError(validationResponse.error)
return false
}
} else {
const validationResponse = validationOptions.safeParse(args)
return validationResponse.success
}
}
}
+1
View File
@@ -1,3 +1,4 @@
export * from './browser'
export * from './client'
export * from './server'
export * from './validation'
+11
View File
@@ -0,0 +1,11 @@
import type { z } from 'zod'
export type RageFW_ValidationSchema = z.ZodTuple<any, any> | z.ZodArray<any>
export type RageFW_ValidationSchemaExtended = {
schema: RageFW_ValidationSchema
onError: (error: z.ZodError) => unknown
}
export type RageFW_ValidationOptions =
| RageFW_ValidationSchema
| RageFW_ValidationSchemaExtended
-1
View File
@@ -4,7 +4,6 @@ export default defineConfig({
entry: ['src/index.ts'],
outDir: './dist',
format: ['cjs'],
noExternal: ['rage-rpc'],
experimentalDts: true,
splitting: false,
sourcemap: false,
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2024 Entity Seven Group
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+16 -11
View File
@@ -1,19 +1,20 @@
{
"name": "@entityseven/create-rage-fw",
"version": "0.1.1",
"version": "0.1.2",
"bin": {
"rage-fw": "dist/index.js"
},
"main": "dist/index.js",
"files": [
"dist/**/*",
"readme.md",
"LICENSE"
],
"scripts": {
"watch": "tsc -w",
"build": "tsup",
"start": "npx ./dist create"
},
"files": [
"dist/**/*",
"readme.md"
],
"dependencies": {
"@inquirer/prompts": "^5.0.5",
"ky": "^1.7.2",
@@ -26,11 +27,15 @@
"prettier": "^3.3.2",
"typescript": "^5.4.5"
},
"description": "CLI to scaffold a template project for RageFW",
"keywords": [],
"author": "rilaxik",
"contributors": [{
"name": "SashaGoncharov19"
}],
"description": "CLI to scaffold a preview for Rage-FW",
"keywords": ["create-rage-fw","ragefw-cli", "ragefw", "rage-fw", "ragemp", "rage:mp", "rage", "gta5"],
"author": "Entity Seven Group",
"contributors": [
{
"name": "Danya H",
"email": "[email protected]",
"url": "https://github.com/rilaxik/"
}
],
"license": "MIT"
}
+26 -14
View File
@@ -1,29 +1,41 @@
# RageFW CLI
To make you life easier while using RageFW we created a basic CLI. At the moment automation we have only works via [pnpm](https://pnpm.io/)
To make you life easier while using RageFW we created a basic CLI. At the moment automation we have only works via [pnpm](https://pnpm.io/) and [bun](https://bun.sh/)
``pnpm create @entityseven/rage-fw@latest``
## TL;DR
``bun create @entityseven/rage-fw@latest``
# TL;DR
- ``Initialize new project`` - create new template project
- ``Test our RPC`` - scaffold an example for ``@entityseven/rage-fw-rpc``
- ``Install RAGE:MP updater`` - download and update RAGE:MP server files
## Options
# Options
For now, you will see a few available options. They are described in detail below
- ``Initialize new project``
- ``Test our RPC``
- ``Install RAGE:MP updater``
### Initialize new project
Using this options will forward you to common project-creation menu
- ``Enter project name``
## Initialize new project
Using this option will forward you to common project creation menu
This option will specify a name for your project which is used as a folder name too. Defaults to **rage-fw**
- ``Enter project name``
This option will specify a name for your project which is used as a folder name too. Defaults to **rage-fw-example**
- ``Select frontend``
- ``Select front-end``
Use selector menu to choose which front-end framework you want to use. We will do our best to expand this menu with various solutions
Use this selector menu to choose which frontend framework you want to use. We will do our best to expand this menu after some time.
Defaults to **React + TypeScript (Vite)**
## Test our RPC
Using this option will forward you to common project creation menu
### Install Rage:MP updater
This option will simplify installation process of Rage:MP server files required to start your server
- ``Enter project name``
This option will specify a name for your project which is used as a folder name too. Defaults to **rage-fw-rpc-example**
- ``Select front-end``
Use selector menu to choose which front-end framework you want to use. We will do our best to expand this menu with various solutions
## Install Rage:MP updater
This option will simplify installation and update process of Rage:MP server files required to start your server
# Contribution
If you wish to help us in expanding examples selection with different framework you are very welcome to open PRs and Issues
+6 -5
View File
@@ -18,19 +18,19 @@ export async function initProject() {
if (!framework) {
framework = await select({
message: c.gray('Select frontend:'),
message: c.gray('Select front-end:'),
default: 'react-18',
loop: true,
choices: [
{
name: 'React + TypeScript (Vite)',
name: 'React 18',
value: 'react-18',
description: 'React + TypeScript (Vite) as a frontend',
description: 'React 18 + TypeScript (Vite) as a front-end',
},
],
})
} else {
console.log(c.gray('Frontend:'), framework)
console.log(c.gray('Front-end:'), framework)
}
console.log(
@@ -38,7 +38,7 @@ export async function initProject() {
folder,
c.gray('with'),
framework,
c.gray('as a frontend..'),
c.gray('as a front-end..'),
)
cloneBranch(
@@ -56,5 +56,6 @@ export async function initProject() {
})
.catch(e => {
console.log(c.red('Error occured: \n', e))
console.log(c.red('Please open an issue if you see this'))
})
}
+7 -6
View File
@@ -5,14 +5,14 @@ import { cloneBranch } from '../utils/cloner'
const choices = {
'rpc-react-18': {
name: 'Vite + React 18 + TypeScript',
name: 'React 18',
value: 'rpc-react-18',
description: 'Vite + React 18 + TypeScript as a frontend',
description: 'Vite + React 18 + TypeScript as a front-end',
},
'rpc-svelte-5': {
name: 'Vite + Svelte 5 + TypeScript',
name: 'Svelte 5',
value: 'rpc-svelte-5',
description: 'Vite + Svelte 5 + TypeScript as a frontend',
description: 'Vite + Svelte 5 + TypeScript as a front-end',
},
} as const
@@ -31,13 +31,13 @@ export async function testRpc() {
if (!framework) {
framework = await select({
message: c.gray('Select frontend:'),
message: c.gray('Select front-end:'),
default: 'rpc-react-18',
loop: true,
choices: Object.values(choices),
})
} else {
console.log(c.gray('Frontend:'), framework)
console.log(c.gray('Front-end:'), framework)
}
console.log(
@@ -63,5 +63,6 @@ export async function testRpc() {
})
.catch(e => {
console.log(c.red('Error occured: \n', e))
console.log(c.red('Please open an issue if you see this'))
})
}
+14 -4
View File
@@ -12,10 +12,19 @@ enum Actions {
UPDATER = 'UPDATER',
}
process.on('exit', () => {
console.log(c.blueBright('\n\nRage FW CLI | Exiting..'))
process.exit(0)
})
process.on('SIGINT', () => {
console.log(c.blueBright('\n\nRage FW CLI | Exiting..'))
process.exit(0)
})
;(async () => {
await checkForUpdates()
console.log(c.blueBright('Rage FW CLI | Powered by Entity Seven Group <3'))
console.log(c.blueBright('Rage FW CLI | Powered by Entity Seven Group <3'))
const action = await select({
message: c.gray('Select action:'),
@@ -26,16 +35,16 @@ enum Actions {
description: 'Initialize a new project and start developing',
},
{
name: 'Test our RPC',
name: 'Test our Rpc',
value: Actions.TEST_RPC,
description:
'Initialize a new skeleton project with our RPC set up',
'Initialize a new skeleton project with our Rpc all set',
},
{
name: 'Install RAGE:MP updater',
value: Actions.UPDATER,
description:
'Use our tool to download or update RAGE:MP server files in two clicks',
'Use our tool to download or update RAGE:MP server files in just two clicks',
},
],
loop: true,
@@ -53,5 +62,6 @@ enum Actions {
break
default:
console.log(c.red('Something went wrong..'))
console.log(c.red('Please open an issue if you see this'))
}
})()
+15
View File
@@ -0,0 +1,15 @@
Custom Attribution-NoDerivs Software License
Copyright (c) 2024 Entity Seven Group
This license allows you to use, copy, and distribute the RageFW (the "Software"), including for commercial purposes, provided that the following conditions are met:
1. **Attribution:** You must give appropriate credit to the original author of the Software, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
2. **No Derivative Works:** You may not modify, transform, or build upon the Software.
3. **Usage and Commercial Use:** You are allowed to use, sell, and gain income from projects that utilize the Software, as long as you comply with the terms of this license.
4. **No Additional Restrictions:** You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
BIN
View File
Binary file not shown.
+47 -29
View File
@@ -1,32 +1,50 @@
{
"name": "@entityseven/rage-fw-client",
"version": "0.2.1-0.2.0-alpha.2.0",
"main": "dist/index.js",
"types": "dist/src/index.d.ts",
"files": [
"dist/**/*",
"readme.md"
],
"scripts": {
"build": "tsup"
"name": "@entityseven/rage-fw-client",
"version": "0.2.0",
"main": "dist/index.js",
"types": "dist/src/index.d.ts",
"files": [
"dist/**/*",
"readme.md",
"LICENSE"
],
"exports": {
".": "./dist/index.js"
},
"scripts": {
"build": "tsup"
},
"dependencies": {
"@entityseven/rage-fw-rpc": "0.2.5",
"zod": "^3.23.8"
},
"peerDependencies": {
"@entityseven/rage-fw-shared-types": "0.2.0",
"@ragempcommunity/types-client": "^2.1.8"
},
"description": "Package used on a client-side of your Rage:MP Server",
"keywords": [
"rage-fw-client",
"ragefw",
"rage-fw",
"ragemp",
"rage:mp",
"rage",
"gta5"
],
"author": "Entity Seven Group",
"contributors": [
{
"name": "Danya H",
"email": "[email protected]",
"url": "https://github.com/rilaxik/"
},
"dependencies": {
"@entityseven/rage-fw-rpc": "latest"
},
"peerDependencies": {
"@entityseven/rage-fw-shared-types": "workspace:^",
"@ragempcommunity/types-client": "^2.1.8"
},
"description": "RageFW Client side",
"keywords": [],
"author": "SashaGoncharov19",
"contributors": [
{
"name": "rilaxik",
"email": "[email protected]",
"url": "https://github.com/rilaxik"
}
],
"license": "MIT",
"gitHead": "ffd542c1deddb3033e16e0dae7557313ae09b05f"
{
"name": "Oleksandr Honcharov",
"email": "[email protected]",
"url": "https://github.com/SashaGoncharov19/"
}
],
"license": "Custom-Attribution-NoDerivs",
"gitHead": "ffd542c1deddb3033e16e0dae7557313ae09b05f"
}
+1 -1
View File
@@ -1,2 +1,2 @@
# RageFW Client
[Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki/Docs)
[Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki)
+18 -2
View File
@@ -1,5 +1,6 @@
import { rpc } from './rpc'
import { Middleware } from './middleware'
import { Validation } from './validation'
import type * as T from '../types'
/** Client-side interactions */
@@ -10,6 +11,7 @@ export class Client {
* @param eventName - The name of the event to register
* @param callback - The callback function to be executed when the event is triggered
* @param [options] - Optional settings for callback execution
* @param [options.validation] - Validation schema to be checked before the callback executes
* @param [options.middlewares] - Middleware functions to be checked before the callback executes
* @returns {Client} The current client instance, enabling method chaining
*
@@ -44,6 +46,7 @@ export class Client {
eventName: EventName,
callback: T.RageFW_ClientCallback<EventName>,
options?: {
validation?: T.RageFW_ValidationOptions
middlewares?: T.RageFW_MiddlewareOptions<EventName>
},
): Client {
@@ -52,9 +55,22 @@ export class Client {
ReturnType<typeof callback> | Promise<unknown>,
EventName
>(eventName, async (...data) => {
if (!options?.middlewares) return await callback(...data)
if (!options?.middlewares && !options?.validation)
return await callback(...data)
await Middleware.process(options.middlewares, callback, data)
const validationSuccess = Validation.process(
data,
options?.validation,
)
if (!validationSuccess) return
const middlewaresSuccess = await Middleware.process(
data,
options?.middlewares,
)
if (!middlewaresSuccess) return
return await callback(...data)
})
return this
-1
View File
@@ -1,5 +1,4 @@
export * from './client'
export * from './logger'
export * from './middleware'
export * from './player'
export * from './rpc'
+10 -9
View File
@@ -4,8 +4,8 @@ export class Middleware {
constructor() {}
private static async execute<EventName extends T.RageFW_ClientEvent>(
middlewares: T.RageFW_MiddlewareFunction<EventName>[],
args: T.RageFW_ClientArgs<EventName>,
middlewares: T.RageFW_MiddlewareFunction<EventName>[],
): Promise<T.RageFW_MiddlewareResponseInternal> {
for (let i = 0; i < middlewares.length; i++) {
const result = await middlewares[i](...args)
@@ -22,25 +22,25 @@ export class Middleware {
}
public static async process<EventName extends T.RageFW_ClientEvent>(
middlewareOptions: T.RageFW_MiddlewareOptions<EventName>,
callback: T.RageFW_ClientCallback<EventName>,
args: T.RageFW_ClientArgs<EventName>,
) {
middlewareOptions?: T.RageFW_MiddlewareOptions<EventName>,
): Promise<boolean> {
if (!middlewareOptions) return true
if (Array.isArray(middlewareOptions)) {
const middlewaresResponse = await Middleware.execute(
middlewareOptions,
args,
middlewareOptions,
)
if (middlewaresResponse.success) return await callback(...args)
return middlewaresResponse.success
} else {
const middlewaresResponse = await Middleware.execute(
middlewareOptions.executables,
args,
middlewareOptions.executables,
)
if (middlewaresResponse.success) {
return await callback(...args)
return true
} else {
middlewareOptions.onError(
middlewaresResponse.message ??
@@ -48,6 +48,7 @@ export class Middleware {
middlewaresResponse.id +
' failed',
)
return false
}
}
}
+26
View File
@@ -0,0 +1,26 @@
import type * as T from '../types'
export class Validation {
constructor() {}
public static process<EventName extends T.RageFW_ClientEvent>(
args: T.RageFW_ClientArgs<EventName>,
validationOptions?: T.RageFW_ValidationOptions,
): boolean {
if (!validationOptions) return true
if ('schema' in validationOptions) {
const validationResponse = validationOptions.schema.safeParse(args)
if (validationResponse.success) {
return true
} else {
validationOptions.onError(validationResponse.error)
return false
}
} else {
const validationResponse = validationOptions.safeParse(args)
return validationResponse.success
}
}
}
+1
View File
@@ -2,3 +2,4 @@ export * from './browser'
export * from './client'
export * from './middleware'
export * from './server'
export * from './validation'
+11
View File
@@ -0,0 +1,11 @@
import type { z } from 'zod'
export type RageFW_ValidationSchema = z.ZodTuple<any, any> | z.ZodArray<any>
export type RageFW_ValidationSchemaExtended = {
schema: RageFW_ValidationSchema
onError: (error: z.ZodError) => unknown
}
export type RageFW_ValidationOptions =
| RageFW_ValidationSchema
| RageFW_ValidationSchemaExtended
-1
View File
@@ -4,7 +4,6 @@ export default defineConfig({
entry: ['src/index.ts'],
outDir: './dist',
format: ['cjs'],
noExternal: ['rage-rpc'],
experimentalDts: true,
splitting: false,
sourcemap: false,
+16 -2
View File
@@ -1,5 +1,4 @@
{
"private": true,
"scripts": {
"publish": "lerna publish --force-publish",
"build": "lerna run build",
@@ -26,5 +25,20 @@
"typescript": "^5.4.5",
"winston": "^3.13.0"
},
"type": "module"
"private": true,
"type": "module",
"license": "SEE INDIVIDUALLY FOR EACH PACKAGE",
"author": "Entity Seven Group",
"contributors": [
{
"name": "Danya H",
"email": "[email protected]",
"url": "https://github.com/rilaxik/"
},
{
"name": "Oleksandr Honcharov",
"email": "[email protected]",
"url": "https://github.com/SashaGoncharov19/"
}
]
}
+6227 -8464
View File
File diff suppressed because it is too large Load Diff
+42 -40
View File
@@ -1,42 +1,44 @@
{
"name": "@entityseven/rage-fw-rpc",
"description": "Rage FW RPC",
"version": "0.2.5",
"scripts": {
"build": "tsup",
"start": "npx ./dist create"
},
"files": [
"dist/**/*"
],
"devDependencies": {
"@microsoft/api-extractor": "^7.47.9",
"prettier": "^3.3.2",
"tsup": "^8.3.0"
},
"peerDependencies": {
"typescript": "^5"
},
"keywords": [
"ragemp",
"rage",
"rpc",
"rage-rpc",
"ragerpc"
],
"main": "dist/index.js",
"types": "dist/src/index.d.ts",
"author": {
"name": "rilaxik",
"email": "[email protected]",
"url": "https://github.com/rilaxik"
},
"contributors": [
{
"name": "SashaGoncharov19",
"url": "https://github.com/SashaGoncharov19"
}
],
"license": "MIT",
"gitHead": "04eb7240735c4a0e4855ebabbe8d5b326819fa76"
"name": "@entityseven/rage-fw-rpc",
"version": "0.2.5",
"main": "dist/index.js",
"types": "dist/src/index.d.ts",
"scripts": {
"build": "tsup",
"start": "npx ./dist create"
},
"files": [
"dist/**/*",
"readme.md",
"LICENSE"
],
"devDependencies": {
"@microsoft/api-extractor": "^7.47.9",
"prettier": "^3.3.2",
"tsup": "^8.3.0"
},
"peerDependencies": {
"typescript": "^5"
},
"description": "Rage-FW RPC (Remote procedure caller) for Rage:MP",
"keywords": [
"ragefw",
"rage-fw",
"ragemp",
"rage",
"rpc",
"rage-rpc",
"ragerpc",
"gta5"
],
"author": "Entity Seven Group",
"contributors": [
{
"name": "Danya H",
"email": "[email protected]",
"url": "https://github.com/rilaxik/"
}
],
"license": "MIT",
"gitHead": "04eb7240735c4a0e4855ebabbe8d5b326819fa76"
}
+3 -3
View File
@@ -3,13 +3,13 @@ is an all-in package with asynchronous RPC implementation for RageMP servers in
# Installation
``` shell
npm i rage-fw-rpc
npm i @entityseven/rage-fw-rpc
```
```shell
pnpm i rage-fw-rpc
pnpm i @entityseven/rage-fw-rpc
```
```shell
yarn add rage-fw-rpc
yarn add @entityseven/rage-fw-rpc
```
Import installed package and initialize rpc:
+15
View File
@@ -0,0 +1,15 @@
Custom Attribution-NoDerivs Software License
Copyright (c) 2024 Entity Seven Group
This license allows you to use, copy, and distribute the RageFW (the "Software"), including for commercial purposes, provided that the following conditions are met:
1. **Attribution:** You must give appropriate credit to the original author of the Software, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
2. **No Derivative Works:** You may not modify, transform, or build upon the Software.
3. **Usage and Commercial Use:** You are allowed to use, sell, and gain income from projects that utilize the Software, as long as you comply with the terms of this license.
4. **No Additional Restrictions:** You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+47 -29
View File
@@ -1,32 +1,50 @@
{
"name": "@entityseven/rage-fw-server",
"version": "0.2.1-0.2.0-alpha.2.0",
"main": "dist/index.js",
"types": "dist/src/index.d.ts",
"files": [
"dist/**/*",
"readme.md"
],
"scripts": {
"build": "tsup"
"name": "@entityseven/rage-fw-server",
"version": "0.2.0",
"main": "dist/index.js",
"types": "dist/src/index.d.ts",
"files": [
"dist/**/*",
"readme.md",
"LICENSE"
],
"exports": {
".": "./dist/index.js"
},
"scripts": {
"build": "tsup"
},
"dependencies": {
"@entityseven/rage-fw-rpc": "0.2.5",
"zod": "^3.23.8"
},
"peerDependencies": {
"@entityseven/rage-fw-shared-types": "0.2.0",
"@ragempcommunity/types-server": "^2.1.8"
},
"description": "Package used on a server-side of your Rage:MP Server",
"keywords": [
"rage-fw-server",
"ragefw",
"rage-fw",
"ragemp",
"rage:mp",
"rage",
"gta5"
],
"author": "Entity Seven Group",
"contributors": [
{
"name": "Danya H",
"email": "[email protected]",
"url": "https://github.com/rilaxik/"
},
"dependencies": {
"@entityseven/rage-fw-rpc": "latest"
},
"peerDependencies": {
"@entityseven/rage-fw-shared-types": "workspace:^",
"@ragempcommunity/types-server": "^2.1.8"
},
"description": "RageFW Server side",
"keywords": [],
"author": "SashaGoncharov19",
"contributors": [
{
"name": "rilaxik",
"email": "[email protected]",
"url": "https://github.com/rilaxik"
}
],
"license": "MIT",
"gitHead": "ffd542c1deddb3033e16e0dae7557313ae09b05f"
{
"name": "Oleksandr Honcharov",
"email": "[email protected]",
"url": "https://github.com/SashaGoncharov19/"
}
],
"license": "Custom-Attribution-NoDerivs",
"gitHead": "ffd542c1deddb3033e16e0dae7557313ae09b05f"
}
+1 -1
View File
@@ -1,2 +1,2 @@
# RageFW Server
[Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki/Docs)
[Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki)
-1
View File
@@ -1,5 +1,4 @@
export * from './logger'
export * from './middleware'
export * from './player'
export * from './rpc'
export * from './server'
+10 -9
View File
@@ -4,8 +4,8 @@ export class Middleware {
constructor() {}
private static async execute<EventName extends T.RageFW_ServerEvent>(
middlewares: T.RageFW_MiddlewareFunction<EventName>[],
args: T.RageFW_ServerArgs<EventName>,
middlewares: T.RageFW_MiddlewareFunction<EventName>[],
): Promise<T.RageFW_MiddlewareResponseInternal> {
for (let i = 0; i < middlewares.length; i++) {
const result = await middlewares[i](...args)
@@ -22,25 +22,25 @@ export class Middleware {
}
public static async process<EventName extends T.RageFW_ServerEvent>(
middlewareOptions: T.RageFW_MiddlewareOptions<EventName>,
callback: T.RageFW_ServerCallback<EventName>,
args: T.RageFW_ServerArgs<EventName>,
) {
middlewareOptions?: T.RageFW_MiddlewareOptions<EventName>,
): Promise<boolean> {
if (!middlewareOptions) return true
if (Array.isArray(middlewareOptions)) {
const middlewaresResponse = await Middleware.execute(
middlewareOptions,
args,
middlewareOptions,
)
if (middlewaresResponse.success) return await callback(...args)
return middlewaresResponse.success
} else {
const middlewaresResponse = await Middleware.execute(
middlewareOptions.executables,
args,
middlewareOptions.executables,
)
if (middlewaresResponse.success) {
return await callback(...args)
return true
} else {
middlewareOptions.onError(
middlewaresResponse.message ??
@@ -48,6 +48,7 @@ export class Middleware {
middlewaresResponse.id +
' failed',
)
return false
}
}
}
+18 -6
View File
@@ -1,5 +1,6 @@
import { rpc } from './rpc'
import { Middleware } from './middleware'
import { Validation } from './validation'
import type * as T from '../types'
/** Server-side interactions */
@@ -10,6 +11,7 @@ export class Server {
* @param eventName - The name of the event to register
* @param callback - The callback function to be executed when the event is triggered
* @param [options] - Optional settings for callback execution
* @param [options.validation] - Validation schema to be checked before the callback executes
* @param [options.middlewares] - Middleware functions to be checked before the callback executes
* @returns {Server} The current server instance, enabling method chaining
*
@@ -44,6 +46,7 @@ export class Server {
eventName: EventName,
callback: T.RageFW_ServerCallback<EventName>,
options?: {
validation?: T.RageFW_ValidationOptions
middlewares?: T.RageFW_MiddlewareOptions<EventName>
},
): Server {
@@ -52,9 +55,22 @@ export class Server {
ReturnType<typeof callback> | Promise<unknown>,
EventName
>(eventName, async (...data) => {
if (!options?.middlewares) return await callback(...data)
if (!options?.middlewares && !options?.validation)
return await callback(...data)
await Middleware.process(options.middlewares, callback, data)
const validationSuccess = Validation.process(
data,
options?.validation,
)
if (!validationSuccess) return
const middlewaresSuccess = await Middleware.process(
data,
options?.middlewares,
)
if (!middlewaresSuccess) return
return await callback(...data)
})
return this
@@ -90,7 +106,3 @@ export class Server {
// return rpc.call(eventName, args)
// }
}
// new Server()
// .register('customServerEvent', async (a, b, c) => true)
// .unregister('customServerEvent')
+26
View File
@@ -0,0 +1,26 @@
import type * as T from '../types'
export class Validation {
constructor() {}
public static process<EventName extends T.RageFW_ServerEvent>(
args: T.RageFW_ServerArgs<EventName>,
validationOptions?: T.RageFW_ValidationOptions,
): boolean {
if (!validationOptions) return true
if ('schema' in validationOptions) {
const validationResponse = validationOptions.schema.safeParse(args)
if (validationResponse.success) {
return true
} else {
validationOptions.onError(validationResponse.error)
return false
}
} else {
const validationResponse = validationOptions.safeParse(args)
return validationResponse.success
}
}
}
+1
View File
@@ -2,3 +2,4 @@ export * from './browser'
export * from './client'
export * from './middleware'
export * from './server'
export * from './validation'
+11
View File
@@ -0,0 +1,11 @@
import type { z } from 'zod'
export type RageFW_ValidationSchema = z.ZodTuple<any, any> | z.ZodArray<any>
export type RageFW_ValidationSchemaExtended = {
schema: RageFW_ValidationSchema
onError: (error: z.ZodError) => unknown
}
export type RageFW_ValidationOptions =
| RageFW_ValidationSchema
| RageFW_ValidationSchemaExtended
+2 -2
View File
@@ -1,12 +1,12 @@
import { defineConfig } from 'tsup'
export default defineConfig({
entry: ['src/index.ts'],
entry: ['./src/index.ts'],
outDir: './dist',
format: ['cjs'],
noExternal: ['rage-rpc'],
experimentalDts: true,
splitting: false,
sourcemap: false,
clean: true,
bundle: false,
})
+13
View File
@@ -0,0 +1,13 @@
# Custom Attribution-NoDerivs Software License
This license allows you to use, copy, and distribute the RageFW (the "Software"), including for commercial purposes, provided that the following conditions are met:
1. **Attribution:** You must give appropriate credit to the original author of the Software, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
2. **No Derivative Works:** You may not modify, transform, or build upon the Software.
3. **Usage and Commercial Use:** You are allowed to use, sell, and gain income from projects that utilize the Software, as long as you comply with the terms of this license.
4. **No Additional Restrictions:** You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+20 -4
View File
@@ -1,12 +1,28 @@
{
"name": "@entityseven/rage-fw-shared-types",
"version": "0.2.1-0.2.0-alpha.2.0",
"version": "0.2.0",
"types": "types/types/index.d.ts",
"files": [
"types/**/*"
"types/**/*",
"readme.md",
"LICENSE"
],
"author": "SashaGoncharov19",
"license": "MIT",
"description": "Package used among all environments of your Rage-FW based server",
"keywords": ["rage-fw-shared-types", "rage-fw-shared","ragefw", "rage-fw", "ragemp", "rage:mp", "rage", "gta5"],
"type": "module",
"author": "Entity Seven Group",
"contributors": [
{
"name": "Danya H",
"email": "[email protected]",
"url": "https://github.com/rilaxik/"
},
{
"name": "Oleksandr Honcharov",
"email": "[email protected]",
"url": "https://github.com/SashaGoncharov19/"
}
],
"license": "Custom-Attribution-NoDerivs",
"gitHead": "ffd542c1deddb3033e16e0dae7557313ae09b05f"
}
+1 -1
View File
@@ -1,2 +1,2 @@
# RageFW Shared types
[Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki/Docs)
[Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki)