🌉flamework-gateways-mod🌉

A Flamework networking mod

✨ Featuring

🌉 Gateways - Handle remote events and functions with classes

🛡️ Guards - Block certain requests before they are processed

📞 Pipes - Transform and validate parameters passed to requests

🌻 Motivation

This is mainly a personal project to handle remotes with classes and decorators.

🔌 Installation

``
npm install @flamework/core@modding
npm install -D rbxts-transformer-flamework@modding
`

`
npm install @rbxts/flamework-gateways-mod
`

📚 Examples

$3

connectServer and connectClient should be called before igniting Flamework.

Do note that guards & pipes will not be applied to external listeners like .on, .wait, etc.!

`ts
type ServerGateway = OneGateway & AnotherGateway;

const server = connectServer();

server.emit("clientEvent", players, ...args);
server.broadcast("clientEvent", ...args);
`

`ts
type ClientGateway = OneGateway & AnotherGateway;

const client = connectClient();

client.emit("serverEvent", ...args);
client.request("serverInvoke", ...args);
`

$3

Gateways should be added to Flamework.addPaths()

`ts
@Gateway({
guards: [new AdminGuard(["littensy"])],
})
class AdminGateway {
constructor(private readonly adminService: AdminService) {}

@OnEvent()
@UseGuards(CommandDebounceGuard)
@UsePipes([], CommandPipe)
async processCommand(player: Player, message: string | Array) {
this.adminService.runCommand(player, message as Array);
}

@OnInvoke()
async getCommands() {
return this.adminService.getCommands();
}
}
`

$3

Creatable guards

`ts
class AdminGuard implements CanActivate {
constructor(private readonly admins: Array) {}

canActivate(context: ExecutionContext) {
return this.admins.includes(context.getPlayer().Name);
}
}
`

Singleton guards should be added to Flamework.addPaths()

`ts
@Guard()
class CommandDebounceGuard implements CanActivate {
constructor(private readonly roduxService: RoduxService) {}

canActivate(context: ExecutionContext) {
const state = this.roduxService.getState();
return time() >= state.commandDebounce;
}
}
`

$3

Creatable pipe

`ts
class CommandPipe implements PipeTransform {
transform(value: unknown) {
assert(typeIs(value, "string"), "(CommandPipe) Value must be a string");
return value.split(" ");
}
}
`

Singleton pipes should be added to Flamework.addPaths()

⚠️ Limitations

❌ Client-side RemoteFunctions are not supported
- It is difficult to safely determine whether a client remote is a function or an event from the server.

❌ Some type limitations
- Pipe transformation input/output is not type checked, use Input | Output` in the parameter type to keep track (see examples).