@takaro/modules 0.0.0-next.0da151e

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@takaro/modules",
+  "version": "0.0.0-next.0da151e",
+  "description": "Built-in modules for Takaro",
+  "main": "dist/main.js",
+  "types": "dist/main.d.ts",
+  "type": "module",
+  "scripts": {
+    "start:dev": "tsc --watch --preserveWatchOutput -p ./tsconfig.build.json",
+    "build": "tsc -p ./tsconfig.build.json",
+    "postbuild": "npm run build:builtin-json",
+    "build:builtin-json": "node --import=ts-node-maintained/register/esm ./scripts/buildBuiltinJson.ts"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC"
+}

package/scripts/buildBuiltinJson.ts

@@ -0,0 +1,81 @@
+import 'reflect-metadata';
+import { getModules } from '@takaro/modules';
+import { writeFile } from 'fs/promises';
+import { readdir, readFile, stat } from 'node:fs/promises';
+import path from 'path';
+
+const __dirname = path.dirname(new URL(import.meta.url).pathname);
+
+async function main() {
+  // Built in modules
+  // TODO: we should probably 'export' them in CI and save it as JSON so it's consistent with the community modules
+  const modules = getModules();
+  const modulesJson = JSON.stringify(modules, null, 2);
+  await writeFile('dist/modules.json', modulesJson);
+  await writeFile('../web-docs/docs/modules/modules.json', modulesJson);
+  await writeFile('../e2e/src/web-main/fixtures/modules.json', modulesJson);
+
+  // Community modules
+  const files = await readdir(`${__dirname}/../src/community-modules/modules`);
+  const communityModules: Array<string> = [];
+
+  for (const file of files) {
+    const content = await readFile(`${__dirname}/../src/community-modules/modules/${file}`, 'utf-8');
+    communityModules.push(JSON.parse(content));
+  }
+
+  const communityModulesJson = JSON.stringify(communityModules, null, 2);
+  await writeFile('dist/community-modules.json', communityModulesJson);
+  await writeFile('../web-docs/docs/community-modules.json', communityModulesJson);
+  await writeFile('../e2e/src/web-main/fixtures/community-modules.json', communityModulesJson);
+
+  const startMarker = '{/* AUTO-GENERATED CONTENT () */}';
+  const endMarker = '{/* END AUTO-GENERATED CONTENT */}';
+
+  // Generate docs pages for each builtin module
+  for (const mod of modules) {
+    const fileExists = await stat(`../web-docs/docs/modules/${mod.name}.mdx`).catch(() => null);
+    // This is also generated, but docusaurus takes the first content of the page as the title, so we cannot put the auto-generated content at the top
+    const autoGeneratedContent = `---
+description: ${mod.versions.find((v) => v.tag === 'latest')?.description}
+---
+
+${startMarker}
+
+import { Commands, Config, CronJobs, Hooks } from './helpers';
+
+# ${mod.name}
+
+export function Module() {
+  const mod = ${JSON.stringify(mod, null, 2)};
+
+  return (
+    <div>
+      <p>{mod.versions[0].description}</p>
+      <Commands commands={mod.versions[0].commands} />
+      <CronJobs cronJobs={mod.versions[0].cronJobs} />
+      <Hooks hooks={mod.versions[0].hooks} />
+      <Config configSchema={mod.versions[0].configSchema} />
+    </div>
+  )
+}
+
+<Module />
+
+${endMarker}`;
+
+    // If file doesnt exist yet, create it
+    if (!fileExists) {
+      await writeFile(`../web-docs/docs/modules/${mod.name}.mdx`, autoGeneratedContent);
+    } else {
+      const existingFile = await readFile(`../web-docs/docs/modules/${mod.name}.mdx`, 'utf-8');
+      // Otherwise, fine the auto generated content markers and replace it
+      const end = existingFile.indexOf(endMarker) + endMarker.length;
+
+      const newFile = autoGeneratedContent + existingFile.slice(end);
+      await writeFile(`../web-docs/docs/modules/${mod.name}.mdx`, newFile);
+    }
+  }
+}
+
+main().catch(console.error);

package/src/BuiltinModule.ts

@@ -0,0 +1,159 @@
+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 { EventTypes, HookEvents } from './dto/index.js';
+import { TakaroDTO } from '@takaro/util';
+
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
+
+export class ICommandArgument extends TakaroDTO<ICommandArgument> {
+  @IsString()
+  name: string;
+  @IsString()
+  type: string;
+  @IsString()
+  @IsOptional()
+  helpText?: string;
+  @IsString()
+  @IsOptional()
+  defaultValue?: string | null;
+  @IsNumber()
+  @IsOptional()
+  position?: number;
+}
+
+export class ICommand extends TakaroDTO<ICommand> {
+  @IsString()
+  name: string;
+  @IsString()
+  @IsOptional()
+  description?: string;
+  @IsString()
+  function: string;
+  @IsString()
+  trigger: string;
+  @IsString()
+  @IsOptional()
+  helpText?: string;
+  @ValidateNested({ each: true })
+  @Type(() => ICommandArgument)
+  @IsOptional()
+  arguments: ICommandArgument[];
+  @IsArray()
+  @IsString({ each: true })
+  @IsOptional()
+  requiredPermissions?: string[];
+}
+
+export class IHook extends TakaroDTO<IHook> {
+  @IsString()
+  name: string;
+  @IsString()
+  @IsOptional()
+  description?: string;
+  @IsString()
+  function: string;
+  @IsEnum(Object.values(HookEvents))
+  eventType: EventTypes;
+  @IsString()
+  @IsOptional()
+  regex?: string;
+}
+
+export class ICronJob extends TakaroDTO<ICronJob> {
+  @IsString()
+  name: string;
+  @IsString()
+  @IsOptional()
+  description?: string;
+  @IsString()
+  function: string;
+  @IsString()
+  temporalValue: string;
+}
+
+export class IFunction extends TakaroDTO<IFunction> {
+  @IsString()
+  name: string;
+  @IsString()
+  @IsOptional()
+  description?: string;
+  @IsString()
+  function: string;
+}
+
+export class IPermission extends TakaroDTO<IPermission> {
+  @IsString()
+  permission: string;
+  @IsString()
+  description: string;
+  @IsString()
+  friendlyName: string;
+  @IsOptional()
+  @IsBoolean()
+  canHaveCount?: boolean;
+}
+
+export class ModuleTransferVersionDTO<T> extends TakaroDTO<T> {
+  @IsString()
+  public tag: string;
+  @IsString()
+  public description: string;
+  @IsString()
+  public configSchema: string;
+  @IsString()
+  public uiSchema: string;
+  @ValidateNested({ each: true })
+  @Type(() => ICommand)
+  @IsOptional()
+  public commands?: Array<ICommand>;
+  @ValidateNested({ each: true })
+  @Type(() => IHook)
+  @IsOptional()
+  public hooks?: Array<IHook>;
+  @ValidateNested({ each: true })
+  @Type(() => ICronJob)
+  @IsOptional()
+  public cronJobs?: Array<ICronJob>;
+  @ValidateNested({ each: true })
+  @Type(() => IFunction)
+  @IsOptional()
+  public functions?: Array<IFunction>;
+  @IsArray()
+  @Type(() => IPermission)
+  @ValidateNested({ each: true })
+  @IsOptional()
+  public permissions?: IPermission[];
+}
+
+export class ModuleTransferDTO<T> extends TakaroDTO<T> {
+  @IsString()
+  public name: string;
+  @IsString()
+  @IsOptional()
+  takaroVersion = process.env.TAKARO_VERSION;
+  @IsString()
+  @IsOptional()
+  public author?: string;
+  @IsArray()
+  @IsString({ each: true })
+  @IsOptional()
+  public supportedGames?: string[];
+
+  @ValidateNested({ each: true })
+  @Type(() => ModuleTransferVersionDTO)
+  versions: ModuleTransferVersionDTO<T>[];
+
+  protected loadFn(type: 'commands' | 'hooks' | 'cronJobs' | 'functions', name: string) {
+    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');
+  }
+}

package/src/__tests__/aliases.integration.test.ts

@@ -0,0 +1,90 @@
+import { IntegrationTest, expect, IModuleTestsSetupData, modulesTestSetup, EventsAwaiter } from '@takaro/test';
+import { GameEvents } from '../dto/index.js';
+import { describe } from 'node:test';
+
+const group = 'Aliases';
+
+const tests = [
+  new IntegrationTest<IModuleTestsSetupData>({
+    group,
+    snapshot: false,
+    setup: modulesTestSetup,
+    name: 'Can install and use aliases',
+    test: async function () {
+      await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.teleportsModule.latestVersion.id,
+        systemConfig: JSON.stringify({
+          commands: {
+            teleport: {
+              delay: 0,
+              aliases: ['tp', 'tellyport'],
+            },
+          },
+        }),
+      });
+
+      const setEvents = (await new EventsAwaiter().connect(this.client)).waitForEvents(GameEvents.CHAT_MESSAGE, 1);
+      await this.client.command.commandControllerTrigger(this.setupData.gameserver.id, {
+        msg: '/settp test',
+        playerId: this.setupData.players[0].id,
+      });
+
+      expect((await setEvents).length).to.be.eq(1);
+      expect((await setEvents)[0].data.meta.msg).to.be.eq('Teleport test set.');
+
+      const events = (await new EventsAwaiter().connect(this.client)).waitForEvents(GameEvents.CHAT_MESSAGE, 1);
+      await this.client.command.commandControllerTrigger(this.setupData.gameserver.id, {
+        msg: '/tellyport test',
+        playerId: this.setupData.players[0].id,
+      });
+
+      expect((await events).length).to.be.eq(1);
+      expect((await events)[0].data.meta.msg).to.be.eq('Teleported to test.');
+    },
+  }),
+  new IntegrationTest<IModuleTestsSetupData>({
+    group,
+    snapshot: false,
+    setup: modulesTestSetup,
+    name: 'Aliases are case insensitive',
+    test: async function () {
+      await this.client.module.moduleInstallationsControllerInstallModule({
+        gameServerId: this.setupData.gameserver.id,
+        versionId: this.setupData.teleportsModule.latestVersion.id,
+        systemConfig: JSON.stringify({
+          commands: {
+            teleport: {
+              delay: 0,
+              aliases: ['tp', 'tellyport'],
+            },
+          },
+        }),
+      });
+
+      const setEvents = (await new EventsAwaiter().connect(this.client)).waitForEvents(GameEvents.CHAT_MESSAGE, 1);
+      await this.client.command.commandControllerTrigger(this.setupData.gameserver.id, {
+        msg: '/settp test',
+        playerId: this.setupData.players[0].id,
+      });
+
+      expect((await setEvents).length).to.be.eq(1);
+      expect((await setEvents)[0].data.meta.msg).to.be.eq('Teleport test set.');
+
+      const events = (await new EventsAwaiter().connect(this.client)).waitForEvents(GameEvents.CHAT_MESSAGE, 1);
+      await this.client.command.commandControllerTrigger(this.setupData.gameserver.id, {
+        msg: '/TelLyPoRt test',
+        playerId: this.setupData.players[0].id,
+      });
+
+      expect((await events).length).to.be.eq(1);
+      expect((await events)[0].data.meta.msg).to.be.eq('Teleported to test.');
+    },
+  }),
+];
+
+describe(group, function () {
+  tests.forEach((test) => {
+    test.run();
+  });
+});