@takaro/modules 0.0.1

package/README.md

@@ -0,0 +1,3 @@
+# @takaro/modules
+
+Built-in modules for Takaro

package/dist/BuiltinModule.d.ts

@@ -0,0 +1,49 @@
+import { EventTypes } from './dto/index.js';
+import { TakaroDTO } from '@takaro/util';
+export declare class ICommandArgument extends TakaroDTO<ICommandArgument> {
+    name: string;
+    type: string;
+    helpText?: string;
+    defaultValue?: string | null;
+    position?: number;
+}
+export declare class ICommand extends TakaroDTO<ICommand> {
+    name: string;
+    function: string;
+    trigger: string;
+    helpText?: string;
+    arguments: ICommandArgument[];
+}
+export declare class IHook extends TakaroDTO<IHook> {
+    name: string;
+    function: string;
+    eventType: EventTypes;
+}
+export declare class ICronJob extends TakaroDTO<ICronJob> {
+    name: string;
+    function: string;
+    temporalValue: string;
+}
+export declare class IFunction extends TakaroDTO<IFunction> {
+    name: string;
+    function: string;
+}
+export declare class IPermission extends TakaroDTO<IPermission> {
+    permission: string;
+    description: string;
+    friendlyName: string;
+    canHaveCount?: boolean;
+}
+export declare class BuiltinModule<T> extends TakaroDTO<T> {
+    constructor(name: string, description: string, configSchema: string, uiSchema?: string);
+    name: string;
+    description: string;
+    configSchema: string;
+    uiSchema: string;
+    commands: Array<ICommand>;
+    hooks: Array<IHook>;
+    cronJobs: Array<ICronJob>;
+    functions: Array<IFunction>;
+    permissions: IPermission[];
+    protected loadFn(type: 'commands' | 'hooks' | 'cronJobs' | 'functions', name: string): string;
+}

package/dist/BuiltinModule.js

@@ -0,0 +1,194 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { readFileSync, readdirSync } from 'fs';
+import path from 'path';
+import * as url from 'url';
+import { IsString, IsOptional, IsNumber, IsArray, ValidateNested, IsEnum, IsBoolean } from 'class-validator';
+import { Type } from 'class-transformer';
+import { HookEvents } from './dto/index.js';
+import { TakaroDTO } from '@takaro/util';
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
+export class ICommandArgument extends TakaroDTO {
+}
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], ICommandArgument.prototype, "name", void 0);
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], ICommandArgument.prototype, "type", void 0);
+__decorate([
+    IsString(),
+    IsOptional(),
+    __metadata("design:type", String)
+], ICommandArgument.prototype, "helpText", void 0);
+__decorate([
+    IsString(),
+    IsOptional(),
+    __metadata("design:type", Object)
+], ICommandArgument.prototype, "defaultValue", void 0);
+__decorate([
+    IsNumber(),
+    IsOptional(),
+    __metadata("design:type", Number)
+], ICommandArgument.prototype, "position", void 0);
+export class ICommand extends TakaroDTO {
+}
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], ICommand.prototype, "name", void 0);
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], ICommand.prototype, "function", void 0);
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], ICommand.prototype, "trigger", void 0);
+__decorate([
+    IsString(),
+    IsOptional(),
+    __metadata("design:type", String)
+], ICommand.prototype, "helpText", void 0);
+__decorate([
+    ValidateNested({ each: true }),
+    Type(() => ICommandArgument),
+    IsOptional(),
+    __metadata("design:type", Array)
+], ICommand.prototype, "arguments", void 0);
+export class IHook extends TakaroDTO {
+}
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], IHook.prototype, "name", void 0);
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], IHook.prototype, "function", void 0);
+__decorate([
+    IsEnum(Object.values(HookEvents)),
+    __metadata("design:type", String)
+], IHook.prototype, "eventType", void 0);
+export class ICronJob extends TakaroDTO {
+}
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], ICronJob.prototype, "name", void 0);
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], ICronJob.prototype, "function", void 0);
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], ICronJob.prototype, "temporalValue", void 0);
+export class IFunction extends TakaroDTO {
+}
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], IFunction.prototype, "name", void 0);
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], IFunction.prototype, "function", void 0);
+export class IPermission extends TakaroDTO {
+    constructor() {
+        super(...arguments);
+        this.canHaveCount = false;
+    }
+}
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], IPermission.prototype, "permission", void 0);
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], IPermission.prototype, "description", void 0);
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], IPermission.prototype, "friendlyName", void 0);
+__decorate([
+    IsOptional(),
+    IsBoolean(),
+    __metadata("design:type", Boolean)
+], IPermission.prototype, "canHaveCount", void 0);
+export class BuiltinModule extends TakaroDTO {
+    constructor(name, description, configSchema, uiSchema = JSON.stringify({})) {
+        super();
+        this.commands = [];
+        this.hooks = [];
+        this.cronJobs = [];
+        this.functions = [];
+        this.permissions = [];
+        this.name = name;
+        this.description = description;
+        this.configSchema = configSchema;
+        this.uiSchema = uiSchema;
+    }
+    loadFn(type, name) {
+        const folderPath = path.join(__dirname, 'modules', this.name, type);
+        const files = readdirSync(folderPath);
+        const file = files.find((file) => file.replace('.js', '') === name);
+        if (!file) {
+            throw new Error(`Could not find ${name} in ${this.name}'s ${type}. Did you provide a function implementation?`);
+        }
+        return readFileSync(path.join(folderPath, file), 'utf-8');
+    }
+}
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], BuiltinModule.prototype, "name", void 0);
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], BuiltinModule.prototype, "description", void 0);
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], BuiltinModule.prototype, "configSchema", void 0);
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], BuiltinModule.prototype, "uiSchema", void 0);
+__decorate([
+    ValidateNested({ each: true }),
+    Type(() => ICommand),
+    __metadata("design:type", Array)
+], BuiltinModule.prototype, "commands", void 0);
+__decorate([
+    ValidateNested({ each: true }),
+    Type(() => IHook),
+    __metadata("design:type", Array)
+], BuiltinModule.prototype, "hooks", void 0);
+__decorate([
+    ValidateNested({ each: true }),
+    Type(() => ICronJob),
+    __metadata("design:type", Array)
+], BuiltinModule.prototype, "cronJobs", void 0);
+__decorate([
+    ValidateNested({ each: true }),
+    Type(() => IFunction),
+    __metadata("design:type", Array)
+], BuiltinModule.prototype, "functions", void 0);
+__decorate([
+    IsArray(),
+    Type(() => IPermission),
+    ValidateNested({ each: true }),
+    __metadata("design:type", Array)
+], BuiltinModule.prototype, "permissions", void 0);
+//# sourceMappingURL=BuiltinModule.js.map

package/dist/BuiltinModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BuiltinModule.js","sourceRoot":"","sources":["../src/BuiltinModule.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAC/C,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,KAAK,GAAG,MAAM,KAAK,CAAC;AAC3B,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC7G,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAc,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,MAAM,SAAS,GAAG,GAAG,CAAC,aAAa,CAAC,IAAI,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAEnE,MAAM,OAAO,gBAAiB,SAAQ,SAA2B;CAchE;AAZC;IADC,QAAQ,EAAE;;8CACE;AAEb;IADC,QAAQ,EAAE;;8CACE;AAGb;IAFC,QAAQ,EAAE;IACV,UAAU,EAAE;;kDACK;AAGlB;IAFC,QAAQ,EAAE;IACV,UAAU,EAAE;;sDACgB;AAG7B;IAFC,QAAQ,EAAE;IACV,UAAU,EAAE;;kDACK;AAGpB,MAAM,OAAO,QAAS,SAAQ,SAAmB;CAchD;AAZC;IADC,QAAQ,EAAE;;sCACE;AAEb;IADC,QAAQ,EAAE;;0CACM;AAEjB;IADC,QAAQ,EAAE;;yCACK;AAGhB;IAFC,QAAQ,EAAE;IACV,UAAU,EAAE;;0CACK;AAIlB;IAHC,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAC9B,IAAI,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC;IAC5B,UAAU,EAAE;;2CACiB;AAGhC,MAAM,OAAO,KAAM,SAAQ,SAAgB;CAO1C;AALC;IADC,QAAQ,EAAE;;mCACE;AAEb;IADC,QAAQ,EAAE;;uCACM;AAEjB;IADC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;;wCACZ;AAGxB,MAAM,OAAO,QAAS,SAAQ,SAAmB;CAOhD;AALC;IADC,QAAQ,EAAE;;sCACE;AAEb;IADC,QAAQ,EAAE;;0CACM;AAEjB;IADC,QAAQ,EAAE;;+CACW;AAGxB,MAAM,OAAO,SAAU,SAAQ,SAAoB;CAKlD;AAHC;IADC,QAAQ,EAAE;;uCACE;AAEb;IADC,QAAQ,EAAE;;2CACM;AAGnB,MAAM,OAAO,WAAY,SAAQ,SAAsB;IAAvD;;QASE,iBAAY,GAAa,KAAK,CAAC;IACjC,CAAC;CAAA;AARC;IADC,QAAQ,EAAE;;+CACQ;AAEnB;IADC,QAAQ,EAAE;;gDACS;AAEpB;IADC,QAAQ,EAAE;;iDACU;AAGrB;IAFC,UAAU,EAAE;IACZ,SAAS,EAAE;;iDACmB;AAGjC,MAAM,OAAO,aAAiB,SAAQ,SAAY;IAChD,YAAY,IAAY,EAAE,WAAmB,EAAE,YAAoB,EAAE,WAAmB,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QACxG,KAAK,EAAE,CAAC;QAkBH,aAAQ,GAAoB,EAAE,CAAC;QAG/B,UAAK,GAAiB,EAAE,CAAC;QAGzB,aAAQ,GAAoB,EAAE,CAAC;QAG/B,cAAS,GAAqB,EAAE,CAAC;QAIjC,gBAAW,GAAkB,EAAE,CAAC;QA9BrC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IA4BS,MAAM,CAAC,IAAqD,EAAE,IAAY;QAClF,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACpE,MAAM,KAAK,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;QACtC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC;QACpE,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,OAAO,IAAI,CAAC,IAAI,MAAM,IAAI,8CAA8C,CAAC,CAAC;QAClH,CAAC;QAED,OAAO,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;CACF;AAnCQ;IADN,QAAQ,EAAE;;2CACS;AAEb;IADN,QAAQ,EAAE;;kDACgB;AAEpB;IADN,QAAQ,EAAE;;mDACiB;AAErB;IADN,QAAQ,EAAE;;+CACa;AAIjB;IAFN,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAC9B,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC;8BACJ,KAAK;+CAAgB;AAG/B;IAFN,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAC9B,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC;8BACJ,KAAK;4CAAa;AAGzB;IAFN,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAC9B,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC;8BACJ,KAAK;+CAAgB;AAG/B;IAFN,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAC9B,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC;8BACJ,KAAK;gDAAiB;AAIjC;IAHN,OAAO,EAAE;IACT,IAAI,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC;IACvB,cAAc,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;;kDACQ"}

package/dist/dto/base.d.ts

@@ -0,0 +1,6 @@
+import { TakaroDTO } from '@takaro/util';
+import { EventTypes } from './index.js';
+export declare class BaseEvent<T> extends TakaroDTO<T> {
+    timestamp: string;
+    type: EventTypes;
+}

package/dist/dto/base.js

@@ -0,0 +1,28 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { TakaroDTO } from '@takaro/util';
+import { IsISO8601, IsString } from 'class-validator';
+import { Exclude } from 'class-transformer';
+export class BaseEvent extends TakaroDTO {
+    constructor() {
+        super(...arguments);
+        this.timestamp = new Date().toISOString();
+    }
+}
+__decorate([
+    IsISO8601(),
+    __metadata("design:type", String)
+], BaseEvent.prototype, "timestamp", void 0);
+__decorate([
+    IsString(),
+    Exclude({ toPlainOnly: true }),
+    __metadata("design:type", String)
+], BaseEvent.prototype, "type", void 0);
+//# sourceMappingURL=base.js.map

package/dist/dto/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/dto/base.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAEtD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,MAAM,OAAO,SAAa,SAAQ,SAAY;IAA9C;;QAEE,cAAS,GAAW,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAK/C,CAAC;CAAA;AALC;IADC,SAAS,EAAE;;4CACiC;AAI7C;IAFC,QAAQ,EAAE;IACV,OAAO,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;;uCACd"}

package/dist/dto/discordEvents.d.ts

@@ -0,0 +1,31 @@
+import { TakaroDTO } from '@takaro/util';
+import { ValueOf } from 'type-fest';
+import { BaseEvent } from './base.js';
+export declare const DiscordEvents: {
+    readonly DISCORD_MESSAGE: "discord-message";
+};
+export declare class BaseDiscordEvent<T> extends BaseEvent<T> {
+    type: ValueOf<typeof DiscordEvents>;
+    msg: string;
+}
+export declare class EventDiscordUser extends TakaroDTO<EventDiscordUser> {
+    id: string;
+    username: string;
+    displayName: string;
+    isBot: boolean;
+    isTakaroBot: boolean;
+}
+export declare class EventDiscordChannel extends TakaroDTO<EventDiscordChannel> {
+    id: string;
+    name: string;
+}
+export declare class HookEventDiscordMessage extends BaseEvent<HookEventDiscordMessage> {
+    type: "discord-message";
+    msg: string;
+    author: EventDiscordUser;
+    channel: EventDiscordChannel;
+}
+export declare function isDiscordMessageEvent(a: unknown): a is HookEventDiscordMessage;
+export declare const DiscordEventsMapping: {
+    readonly "discord-message": typeof HookEventDiscordMessage;
+};

package/dist/dto/discordEvents.js

@@ -0,0 +1,92 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { IsBoolean, IsEnum, IsString, ValidateNested } from 'class-validator';
+import { Type } from 'class-transformer';
+import { TakaroDTO } from '@takaro/util';
+import { BaseEvent } from './base.js';
+export const DiscordEvents = {
+    DISCORD_MESSAGE: 'discord-message',
+};
+export class BaseDiscordEvent extends BaseEvent {
+}
+__decorate([
+    IsEnum(DiscordEvents),
+    __metadata("design:type", Object)
+], BaseDiscordEvent.prototype, "type", void 0);
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], BaseDiscordEvent.prototype, "msg", void 0);
+export class EventDiscordUser extends TakaroDTO {
+}
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], EventDiscordUser.prototype, "id", void 0);
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], EventDiscordUser.prototype, "username", void 0);
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], EventDiscordUser.prototype, "displayName", void 0);
+__decorate([
+    IsBoolean(),
+    __metadata("design:type", Boolean)
+], EventDiscordUser.prototype, "isBot", void 0);
+__decorate([
+    IsBoolean(),
+    __metadata("design:type", Boolean)
+], EventDiscordUser.prototype, "isTakaroBot", void 0);
+export class EventDiscordChannel extends TakaroDTO {
+}
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], EventDiscordChannel.prototype, "id", void 0);
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], EventDiscordChannel.prototype, "name", void 0);
+export class HookEventDiscordMessage extends BaseEvent {
+    constructor() {
+        super(...arguments);
+        this.type = DiscordEvents.DISCORD_MESSAGE;
+    }
+}
+__decorate([
+    IsString(),
+    __metadata("design:type", Object)
+], HookEventDiscordMessage.prototype, "type", void 0);
+__decorate([
+    IsString(),
+    __metadata("design:type", String)
+], HookEventDiscordMessage.prototype, "msg", void 0);
+__decorate([
+    ValidateNested(),
+    Type(() => EventDiscordUser),
+    __metadata("design:type", EventDiscordUser)
+], HookEventDiscordMessage.prototype, "author", void 0);
+__decorate([
+    ValidateNested(),
+    Type(() => EventDiscordChannel),
+    __metadata("design:type", EventDiscordChannel)
+], HookEventDiscordMessage.prototype, "channel", void 0);
+export function isDiscordMessageEvent(a) {
+    if (typeof a === 'object' && a !== null) {
+        return 'type' in a && a.type === DiscordEvents.DISCORD_MESSAGE;
+    }
+    return false;
+}
+export const DiscordEventsMapping = {
+    [DiscordEvents.DISCORD_MESSAGE]: HookEventDiscordMessage,
+};
+//# sourceMappingURL=discordEvents.js.map

package/dist/dto/discordEvents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"discordEvents.js","sourceRoot":"","sources":["../../src/dto/discordEvents.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAC9E,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,eAAe,EAAE,iBAAiB;CAC1B,CAAC;AAEX,MAAM,OAAO,gBAAoB,SAAQ,SAAY;CAMpD;AAJS;IADP,MAAM,CAAC,aAAa,CAAC;;8CACsB;AAG5C;IADC,QAAQ,EAAE;;6CACC;AAGd,MAAM,OAAO,gBAAiB,SAAQ,SAA2B;CAehE;AAbC;IADC,QAAQ,EAAE;;4CACA;AAGX;IADC,QAAQ,EAAE;;kDACM;AAGjB;IADC,QAAQ,EAAE;;qDACS;AAGpB;IADC,SAAS,EAAE;;+CACG;AAGf;IADC,SAAS,EAAE;;qDACS;AAGvB,MAAM,OAAO,mBAAoB,SAAQ,SAA8B;CAMtE;AAJC;IADC,QAAQ,EAAE;;+CACA;AAGX;IADC,QAAQ,EAAE;;iDACE;AAGf,MAAM,OAAO,uBAAwB,SAAQ,SAAkC;IAA/E;;QAEE,SAAI,GAAG,aAAa,CAAC,eAAe,CAAC;IAYvC,CAAC;CAAA;AAZC;IADC,QAAQ,EAAE;;qDAC0B;AAGrC;IADC,QAAQ,EAAE;;oDACC;AAIZ;IAFC,cAAc,EAAE;IAChB,IAAI,CAAC,GAAG,EAAE,CAAC,gBAAgB,CAAC;8BACrB,gBAAgB;uDAAC;AAIzB;IAFC,cAAc,EAAE;IAChB,IAAI,CAAC,GAAG,EAAE,CAAC,mBAAmB,CAAC;8BACvB,mBAAmB;wDAAC;AAG/B,MAAM,UAAU,qBAAqB,CAAC,CAAU;IAC9C,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC;QACxC,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,aAAa,CAAC,eAAe,CAAC;IACjE,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,CAAC,aAAa,CAAC,eAAe,CAAC,EAAE,uBAAuB;CAChD,CAAC"}

package/dist/dto/gameEvents.d.ts

@@ -0,0 +1,84 @@
+import { TakaroDTO } from '@takaro/util';
+import { BaseEvent } from './base.js';
+import { ValueOf } from 'type-fest';
+export declare const GameEvents: {
+    readonly LOG_LINE: "log";
+    readonly PLAYER_CONNECTED: "player-connected";
+    readonly PLAYER_DISCONNECTED: "player-disconnected";
+    readonly CHAT_MESSAGE: "chat-message";
+    readonly PLAYER_DEATH: "player-death";
+    readonly ENTITY_KILLED: "entity-killed";
+};
+export type GameEventTypes = ValueOf<typeof GameEvents>;
+export declare class IGamePlayer extends TakaroDTO<IGamePlayer> {
+    /**
+     * Unique identifier for this player, as used by the game
+     */
+    gameId: string;
+    /**
+     * The players username
+     */
+    name: string;
+    steamId?: string;
+    epicOnlineServicesId?: string;
+    xboxLiveId?: string;
+    platformId?: string;
+    ip?: string;
+    ping?: number;
+}
+export declare class BaseGameEvent<T> extends BaseEvent<T> {
+    type: ValueOf<typeof GameEvents>;
+    msg: string;
+}
+export interface IPosition {
+    x: number;
+    y: number;
+    z: number;
+}
+export declare class EventLogLine extends BaseGameEvent<EventLogLine> {
+    type: "log";
+}
+export declare class EventPlayerConnected extends BaseGameEvent<EventPlayerConnected> {
+    type: "player-connected";
+    player: IGamePlayer;
+}
+export declare class EventPlayerDisconnected extends BaseGameEvent<EventPlayerDisconnected> {
+    type: "player-disconnected";
+    player: IGamePlayer;
+}
+export declare enum ChatChannel {
+    GLOBAL = "global",
+    TEAM = "team",
+    WHISPER = "whisper"
+}
+export declare class EventChatMessage extends BaseGameEvent<EventChatMessage> {
+    type: "chat-message";
+    player?: IGamePlayer;
+    channel: ChatChannel;
+    msg: string;
+}
+export declare class IPosition {
+    x: number;
+    y: number;
+    z: number;
+}
+export declare class EventPlayerDeath extends BaseGameEvent<EventPlayerDeath> {
+    type: "player-death";
+    player: IGamePlayer;
+    attacker?: IGamePlayer;
+    position: IPosition;
+}
+export declare class EventEntityKilled extends BaseGameEvent<EventEntityKilled> {
+    type: "entity-killed";
+    player: IGamePlayer;
+    entity: string;
+    weapon: string;
+}
+export declare const GameEventsMapping: {
+    readonly "player-connected": typeof EventPlayerConnected;
+    readonly "player-disconnected": typeof EventPlayerDisconnected;
+    readonly "chat-message": typeof EventChatMessage;
+    readonly "player-death": typeof EventPlayerDeath;
+    readonly "entity-killed": typeof EventEntityKilled;
+    readonly log: typeof EventLogLine;
+};