Compare commits

..

No commits in common. "fd9f1cab1859feef68f47fab71ad8da17f1b9fa0" and "495217ecd5bd992890a4bcae23910807faf263e1" have entirely different histories.

25 changed files with 8575 additions and 6517 deletions

Binary file not shown.

View File

@ -8,15 +8,11 @@
"readme.md",
"LICENSE"
],
"exports": {
".": "./dist/index.js"
},
"scripts": {
"build": "tsup"
},
"dependencies": {
"@entityseven/rage-fw-rpc": "0.2.5",
"zod": "^3.23.8"
"@entityseven/rage-fw-rpc": "0.2.5"
},
"peerDependencies": {
"@entityseven/rage-fw-shared-types": "0.2.0",

View File

@ -1,7 +1,11 @@
import { rpc } from './rpc'
import { Helper } from './helper'
import { Validation } from './validation'
import { rpc } from './rpc'
import type * as T from '../types'
import {
RageFW_BrowserEvent,
RageFW_ClientEvent,
RageFW_ServerEvent,
} from '../types'
/** Browser-side interactions */
export class Browser extends Helper {
@ -30,8 +34,6 @@ 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
@ -45,27 +47,14 @@ 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> | Promise<unknown>,
ReturnType<typeof callback>,
EventName
>(eventName, async (...data) => {
if (!options?.validation) return await callback(...data)
const validationSuccess = Validation.process(
data,
options?.validation,
)
if (!validationSuccess) return
return await callback(...data)
})
>(eventName, async (...data) => await callback(...data))
return this
}

View File

@ -1,26 +0,0 @@
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
}
}
}

View File

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

View File

@ -1,11 +0,0 @@
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

View File

@ -4,6 +4,7 @@ export default defineConfig({
entry: ['src/index.ts'],
outDir: './dist',
format: ['cjs'],
noExternal: ['rage-rpc'],
experimentalDts: true,
splitting: false,
sourcemap: false,

Binary file not shown.

View File

@ -8,30 +8,18 @@
"readme.md",
"LICENSE"
],
"exports": {
".": "./dist/index.js"
},
"scripts": {
"build": "tsup"
},
"dependencies": {
"@entityseven/rage-fw-rpc": "0.2.5",
"zod": "^3.23.8"
"@entityseven/rage-fw-rpc": "0.2.5"
},
"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"
],
"keywords": ["rage-fw-client", "ragefw", "rage-fw", "ragemp", "rage:mp", "rage", "gta5"],
"author": "Entity Seven Group",
"contributors": [
{

View File

@ -1,6 +1,5 @@
import { rpc } from './rpc'
import { Middleware } from './middleware'
import { Validation } from './validation'
import type * as T from '../types'
/** Client-side interactions */
@ -11,7 +10,6 @@ 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
*
@ -46,7 +44,6 @@ export class Client {
eventName: EventName,
callback: T.RageFW_ClientCallback<EventName>,
options?: {
validation?: T.RageFW_ValidationOptions
middlewares?: T.RageFW_MiddlewareOptions<EventName>
},
): Client {
@ -55,22 +52,9 @@ export class Client {
ReturnType<typeof callback> | Promise<unknown>,
EventName
>(eventName, async (...data) => {
if (!options?.middlewares && !options?.validation)
return await callback(...data)
if (!options?.middlewares) return await 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)
await Middleware.process(options.middlewares, callback, data)
})
return this

View File

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

View File

@ -4,8 +4,8 @@ export class Middleware {
constructor() {}
private static async execute<EventName extends T.RageFW_ClientEvent>(
args: T.RageFW_ClientArgs<EventName>,
middlewares: T.RageFW_MiddlewareFunction<EventName>[],
args: T.RageFW_ClientArgs<EventName>,
): Promise<T.RageFW_MiddlewareResponseInternal> {
for (let i = 0; i < middlewares.length; i++) {
const result = await middlewares[i](...args)
@ -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(
args,
middlewareOptions,
args,
)
return middlewaresResponse.success
if (middlewaresResponse.success) return await callback(...args)
} else {
const middlewaresResponse = await Middleware.execute(
args,
middlewareOptions.executables,
args,
)
if (middlewaresResponse.success) {
return true
return await callback(...args)
} else {
middlewareOptions.onError(
middlewaresResponse.message ??
@ -48,7 +48,6 @@ export class Middleware {
middlewaresResponse.id +
' failed',
)
return false
}
}
}

View File

@ -1,26 +0,0 @@
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
}
}
}

View File

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

View File

@ -1,11 +0,0 @@
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

View File

@ -4,6 +4,7 @@ export default defineConfig({
entry: ['src/index.ts'],
outDir: './dist',
format: ['cjs'],
noExternal: ['rage-rpc'],
experimentalDts: true,
splitting: false,
sourcemap: false,

3789
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@ -8,30 +8,18 @@
"readme.md",
"LICENSE"
],
"exports": {
".": "./dist/index.js"
},
"scripts": {
"build": "tsup"
},
"dependencies": {
"@entityseven/rage-fw-rpc": "0.2.5",
"zod": "^3.23.8"
"@entityseven/rage-fw-rpc": "0.2.5"
},
"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"
],
"keywords": ["rage-fw-server", "ragefw", "rage-fw", "ragemp", "rage:mp", "rage", "gta5"],
"author": "Entity Seven Group",
"contributors": [
{

View File

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

View File

@ -4,8 +4,8 @@ export class Middleware {
constructor() {}
private static async execute<EventName extends T.RageFW_ServerEvent>(
args: T.RageFW_ServerArgs<EventName>,
middlewares: T.RageFW_MiddlewareFunction<EventName>[],
args: T.RageFW_ServerArgs<EventName>,
): Promise<T.RageFW_MiddlewareResponseInternal> {
for (let i = 0; i < middlewares.length; i++) {
const result = await middlewares[i](...args)
@ -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(
args,
middlewareOptions,
args,
)
return middlewaresResponse.success
if (middlewaresResponse.success) return await callback(...args)
} else {
const middlewaresResponse = await Middleware.execute(
args,
middlewareOptions.executables,
args,
)
if (middlewaresResponse.success) {
return true
return await callback(...args)
} else {
middlewareOptions.onError(
middlewaresResponse.message ??
@ -48,7 +48,6 @@ export class Middleware {
middlewaresResponse.id +
' failed',
)
return false
}
}
}

View File

@ -1,6 +1,5 @@
import { rpc } from './rpc'
import { Middleware } from './middleware'
import { Validation } from './validation'
import type * as T from '../types'
/** Server-side interactions */
@ -11,7 +10,6 @@ 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
*
@ -46,7 +44,6 @@ export class Server {
eventName: EventName,
callback: T.RageFW_ServerCallback<EventName>,
options?: {
validation?: T.RageFW_ValidationOptions
middlewares?: T.RageFW_MiddlewareOptions<EventName>
},
): Server {
@ -55,22 +52,9 @@ export class Server {
ReturnType<typeof callback> | Promise<unknown>,
EventName
>(eventName, async (...data) => {
if (!options?.middlewares && !options?.validation)
return await callback(...data)
if (!options?.middlewares) return await 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)
await Middleware.process(options.middlewares, callback, data)
})
return this
@ -106,3 +90,7 @@ export class Server {
// return rpc.call(eventName, args)
// }
}
// new Server()
// .register('customServerEvent', async (a, b, c) => true)
// .unregister('customServerEvent')

View File

@ -1,26 +0,0 @@
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
}
}
}

View File

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

View File

@ -1,11 +0,0 @@
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

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,
})