@takaro/modules 0.0.14 → 0.0.18

package/src/modules/teleports/index.ts

@@ -1,193 +1,209 @@
-import { BuiltinModule, ICommand, IFunction, IPermission } from '../../BuiltinModule.js';
+import {
+  ModuleTransferDTO,
+  ICommand,
+  IFunction,
+  IPermission,
+  ModuleTransferVersionDTO,
+  ICronJob,
+} from '../../BuiltinModule.js';
 import { Duration } from 'luxon';
 
-export class Teleports extends BuiltinModule<Teleports> {
+export class Teleports extends ModuleTransferDTO<Teleports> {
   constructor() {
-    super(
-      'teleports',
-      'A set of commands to allow players to set their own teleport points and teleport to them.',
-      JSON.stringify({
-        $schema: 'http://json-schema.org/draft-07/schema#',
-        type: 'object',
-        properties: {
-          timeout: {
-            title: 'Timeout',
-            description: 'The time one has to wait before teleporting again.',
-            'x-component': 'duration',
-            type: 'number',
-            minimum: 0,
-            default: Duration.fromObject({ second: 1 }).as('milliseconds'),
-          },
-          allowPublicTeleports: {
-            type: 'boolean',
-            description: 'Players can create public teleports.',
-            default: false,
-          },
-        },
-        required: [],
-        additionalProperties: false,
-      }),
-      JSON.stringify({
-        timeout: { 'ui:widget': 'duration' },
-      }),
-    );
+    super();
 
-    this.functions = [
-      new IFunction({
-        name: 'utils',
-        function: this.loadFn('functions', 'utils'),
-      }),
-    ];
-
-    this.permissions = [
-      new IPermission({
-        permission: 'TELEPORTS_CREATE_PUBLIC',
-        friendlyName: 'Create Public Teleports',
-        description: 'Allows the player to create public teleports.',
-        canHaveCount: true,
-      }),
-      new IPermission({
-        permission: 'TELEPORTS_USE',
-        friendlyName: 'Use Teleports',
-        description: 'Allows the player to use teleports modules.',
-        canHaveCount: true,
-      }),
-      new IPermission({
-        permission: 'TELEPORTS_MANAGE_WAYPOINTS',
-        friendlyName: 'Manage waypoints',
-        description: 'Allows creating, deleting, and managing waypoints.',
-        canHaveCount: false,
-      }),
-    ];
-
-    this.commands = [
-      new ICommand({
-        function: this.loadFn('commands', 'teleport'),
-        name: 'teleport',
-        trigger: 'tp',
-        helpText: 'Teleports to one of your set locations.',
-        arguments: [
-          {
-            name: 'tp',
-            type: 'string',
-            defaultValue: null,
-            helpText: 'The location to teleport to.',
-            position: 0,
-          },
-        ],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'tplist'),
-        name: 'tplist',
-        trigger: 'tplist',
-        helpText: 'Lists all your set locations.',
-        arguments: [],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'settp'),
-        name: 'settp',
-        trigger: 'settp',
-        helpText: 'Sets a location to teleport to.',
-        arguments: [
-          {
-            name: 'tp',
-            type: 'string',
-            defaultValue: null,
-            helpText: 'The location name.',
-            position: 0,
+    this.name = 'teleports';
+    this.versions = [
+      new ModuleTransferVersionDTO({
+        tag: '0.0.2',
+        description: 'A set of commands to allow players to set their own teleport points and teleport to them.',
+        configSchema: JSON.stringify({
+          $schema: 'http://json-schema.org/draft-07/schema#',
+          type: 'object',
+          properties: {
+            timeout: {
+              title: 'Timeout',
+              description: 'The time one has to wait before teleporting again.',
+              'x-component': 'duration',
+              type: 'number',
+              minimum: 0,
+              default: Duration.fromObject({ second: 1 }).as('milliseconds'),
+            },
+            allowPublicTeleports: {
+              type: 'boolean',
+              description: 'Players can create public teleports.',
+              default: false,
+            },
           },
+          required: [],
+          additionalProperties: false,
+        }),
+        uiSchema: JSON.stringify({
+          timeout: { 'ui:widget': 'duration' },
+        }),
+        functions: [
+          new IFunction({
+            name: 'utils',
+            function: this.loadFn('functions', 'utils'),
+          }),
         ],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'deletetp'),
-        name: 'deletetp',
-        trigger: 'deletetp',
-        helpText: 'Deletes a location.',
-        arguments: [
-          {
-            name: 'tp',
-            type: 'string',
-            defaultValue: null,
-            helpText: 'The location name.',
-            position: 0,
-          },
+        permissions: [
+          new IPermission({
+            permission: 'TELEPORTS_CREATE_PUBLIC',
+            friendlyName: 'Create Public Teleports',
+            description: 'Allows the player to create public teleports.',
+            canHaveCount: true,
+          }),
+          new IPermission({
+            permission: 'TELEPORTS_USE',
+            friendlyName: 'Use Teleports',
+            description: 'Allows the player to use teleports modules.',
+            canHaveCount: true,
+          }),
+          new IPermission({
+            permission: 'TELEPORTS_MANAGE_WAYPOINTS',
+            friendlyName: 'Manage waypoints',
+            description: 'Allows creating, deleting, and managing waypoints.',
+            canHaveCount: false,
+          }),
         ],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'setpublic'),
-        name: 'setpublic',
-        trigger: 'setpublic',
-        helpText: 'Sets a teleport to be public, allowing other players to teleport to it.',
-        arguments: [
-          {
-            name: 'tp',
-            type: 'string',
-            defaultValue: null,
-            helpText: 'The location name.',
-            position: 0,
-          },
+        commands: [
+          new ICommand({
+            function: this.loadFn('commands', 'teleport'),
+            name: 'teleport',
+            trigger: 'tp',
+            helpText: 'Teleports to one of your set locations.',
+            arguments: [
+              {
+                name: 'tp',
+                type: 'string',
+                defaultValue: null,
+                helpText: 'The location to teleport to.',
+                position: 0,
+              },
+            ],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'tplist'),
+            name: 'tplist',
+            trigger: 'tplist',
+            helpText: 'Lists all your set locations.',
+            arguments: [],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'settp'),
+            name: 'settp',
+            trigger: 'settp',
+            helpText: 'Sets a location to teleport to.',
+            arguments: [
+              {
+                name: 'tp',
+                type: 'string',
+                defaultValue: null,
+                helpText: 'The location name.',
+                position: 0,
+              },
+            ],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'deletetp'),
+            name: 'deletetp',
+            trigger: 'deletetp',
+            helpText: 'Deletes a location.',
+            arguments: [
+              {
+                name: 'tp',
+                type: 'string',
+                defaultValue: null,
+                helpText: 'The location name.',
+                position: 0,
+              },
+            ],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'setpublic'),
+            name: 'setpublic',
+            trigger: 'setpublic',
+            helpText: 'Sets a teleport to be public, allowing other players to teleport to it.',
+            arguments: [
+              {
+                name: 'tp',
+                type: 'string',
+                defaultValue: null,
+                helpText: 'The location name.',
+                position: 0,
+              },
+            ],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'setprivate'),
+            name: 'setprivate',
+            trigger: 'setprivate',
+            helpText: 'Sets a teleport to be private, only the teleport owner can teleport to it.',
+            arguments: [
+              {
+                name: 'tp',
+                type: 'string',
+                defaultValue: null,
+                helpText: 'The location name.',
+                position: 0,
+              },
+            ],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'setwaypoint'),
+            name: 'setwaypoint',
+            trigger: 'setwaypoint',
+            helpText: 'Creates a new waypoint.',
+            arguments: [
+              {
+                name: 'waypoint',
+                type: 'string',
+                defaultValue: null,
+                helpText: 'The location name.',
+                position: 0,
+              },
+            ],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'deletewaypoint'),
+            name: 'deletewaypoint',
+            trigger: 'deletewaypoint',
+            helpText: 'Deletes a waypoint.',
+            arguments: [
+              {
+                name: 'waypoint',
+                type: 'string',
+                defaultValue: null,
+                helpText: 'The location name.',
+                position: 0,
+              },
+            ],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'listwaypoints'),
+            name: 'listwaypoints',
+            trigger: 'waypoints',
+            helpText: 'Lists all waypoints.',
+            arguments: [],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'teleportwaypoint'),
+            name: 'teleportwaypoint',
+            trigger: 'teleportwaypoint',
+            arguments: [],
+            helpText:
+              'Placeholder command, this will not be used directly. The module will install aliases for this command corresponding to the waypoint names.',
+          }),
         ],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'setprivate'),
-        name: 'setprivate',
-        trigger: 'setprivate',
-        helpText: 'Sets a teleport to be private, only the teleport owner can teleport to it.',
-        arguments: [
-          {
-            name: 'tp',
-            type: 'string',
-            defaultValue: null,
-            helpText: 'The location name.',
-            position: 0,
-          },
+        cronJobs: [
+          new ICronJob({
+            name: 'Waypoint reconciler',
+            temporalValue: '*/30 * * * *',
+            function: this.loadFn('cronJobs', 'Waypoint reconciler'),
+          }),
         ],
       }),
-      new ICommand({
-        function: this.loadFn('commands', 'setwaypoint'),
-        name: 'setwaypoint',
-        trigger: 'setwaypoint',
-        helpText: 'Creates a new waypoint.',
-        arguments: [
-          {
-            name: 'waypoint',
-            type: 'string',
-            defaultValue: null,
-            helpText: 'The location name.',
-            position: 0,
-          },
-        ],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'deletewaypoint'),
-        name: 'deletewaypoint',
-        trigger: 'deletewaypoint',
-        helpText: 'Deletes a waypoint.',
-        arguments: [
-          {
-            name: 'waypoint',
-            type: 'string',
-            defaultValue: null,
-            helpText: 'The location name.',
-            position: 0,
-          },
-        ],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'listwaypoints'),
-        name: 'listwaypoints',
-        trigger: 'waypoints',
-        helpText: 'Lists all waypoints.',
-        arguments: [],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'teleportwaypoint'),
-        name: 'teleportwaypoint',
-        trigger: 'teleportwaypoint',
-        arguments: [],
-        helpText:
-          'Placeholder command, this will not be used directly. The module will install aliases for this command corresponding to the waypoint names.',
-      }),
     ];
   }
 }

package/src/modules/timedShutdown/index.ts

@@ -1,37 +1,42 @@
-import { BuiltinModule, ICronJob } from '../../BuiltinModule.js';
+import { ModuleTransferDTO, ICronJob, ModuleTransferVersionDTO } from '../../BuiltinModule.js';
 
-export class TimedShutdown extends BuiltinModule<TimedShutdown> {
+export class TimedShutdown extends ModuleTransferDTO<TimedShutdown> {
   constructor() {
-    super(
-      'timedShutdown',
-      'Automatically shut down the server at a specific time.',
-      JSON.stringify({
-        $schema: 'http://json-schema.org/draft-07/schema#',
-        type: 'object',
-        properties: {
-          warningMessage: {
-            type: 'string',
-            title: 'Warning message',
-            description: 'Message to send to players before the server shuts down.',
-            default: 'Server is shutting down in 5 minutes!',
-            minLength: 1,
-            maxLength: 1024,
+    super();
+
+    this.name = 'timedShutdown';
+    this.versions = [
+      new ModuleTransferVersionDTO({
+        tag: '0.0.1',
+        description: 'Automatically shut down the server at a specific time.',
+        configSchema: JSON.stringify({
+          $schema: 'http://json-schema.org/draft-07/schema#',
+          type: 'object',
+          properties: {
+            warningMessage: {
+              type: 'string',
+              title: 'Warning message',
+              description: 'Message to send to players before the server shuts down.',
+              default: 'Server is shutting down in 5 minutes!',
+              minLength: 1,
+              maxLength: 1024,
+            },
           },
-        },
-        required: ['warningMessage'],
-      }),
-    );
+          required: ['warningMessage'],
+        }),
 
-    this.cronJobs = [
-      new ICronJob({
-        name: 'Shutdown',
-        temporalValue: '3 30 * * *',
-        function: this.loadFn('cronJobs', 'Shutdown'),
-      }),
-      new ICronJob({
-        name: 'warning',
-        temporalValue: '3 25 * * *',
-        function: this.loadFn('cronJobs', 'warning'),
+        cronJobs: [
+          new ICronJob({
+            name: 'Shutdown',
+            temporalValue: '30 3 * * *',
+            function: this.loadFn('cronJobs', 'Shutdown'),
+          }),
+          new ICronJob({
+            name: 'warning',
+            temporalValue: '25 3 * * *',
+            function: this.loadFn('cronJobs', 'warning'),
+          }),
+        ],
       }),
     ];
   }

package/src/modules/utils/commands/help.js

@@ -1,33 +1,33 @@
-import { takaro, data, TakaroUserError } from '@takaro/helpers';
-
+import { data, takaro, TakaroUserError } from '@takaro/helpers';
 async function main() {
-  const enabledModules = await takaro.gameserver.gameServerControllerGetInstalledModules(data.gameServerId);
+  const enabledModules = await takaro.module.moduleInstallationsControllerGetInstalledModules({
+    filters: { gameserverId: [data.gameServerId] },
+  });
 
   const moduleCommands = await Promise.all(
     enabledModules.data.data.map(async (mod) => {
-      return (await takaro.module.moduleControllerGetOne(mod.moduleId)).data.data.commands;
-    })
+      const installedVersion = await takaro.module.moduleVersionControllerGetModuleVersion(mod.versionId);
+      return installedVersion.data.data.commands;
+    }),
   );
+  const allCommandsFlat = moduleCommands.flat();
 
   if (data.arguments.command === 'all') {
     await data.player.pm('Available commands:');
 
-    for (const mod of moduleCommands) {
-      await Promise.all(
-        mod.map(async (command) => {
-          await data.player.pm(`${command.name}: ${command.helpText}`);
-        })
-      );
-    }
+    await Promise.all(
+      allCommandsFlat.map(async (command) => {
+        await data.player.pm(`${command.name}: ${command.helpText}`);
+      }),
+    );
   } else {
-    const allCommandsFlat = moduleCommands.flat();
     const requestedCommand = allCommandsFlat.find((c) => {
       return c.name === data.arguments.command;
     });
 
     if (!requestedCommand) {
       throw new TakaroUserError(
-        `Unknown command "${data.arguments.command}", use this command without arguments to see all available commands.`
+        `Unknown command "${data.arguments.command}", use this command without arguments to see all available commands.`,
       );
     } else {
       await data.player.pm(`${requestedCommand.name}: ${requestedCommand.helpText}`);

package/src/modules/utils/index.ts

@@ -1,38 +1,42 @@
-import { BuiltinModule, ICommand } from '../../BuiltinModule.js';
+import { ModuleTransferDTO, ICommand, ModuleTransferVersionDTO } from '../../BuiltinModule.js';
 
-export class Utils extends BuiltinModule<Utils> {
+export class Utils extends ModuleTransferDTO<Utils> {
   constructor() {
-    super(
-      'utils',
-      'A collection of useful commands',
-      JSON.stringify({
-        $schema: 'http://json-schema.org/draft-07/schema#',
-        type: 'object',
-        additionalProperties: false,
-      }),
-    );
+    super();
 
-    this.commands = [
-      new ICommand({
-        function: this.loadFn('commands', 'ping'),
-        name: 'ping',
-        trigger: 'ping',
-        helpText: 'Replies with pong, useful for testing if the connection works.',
-        arguments: [],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'help'),
-        name: 'help',
-        trigger: 'help',
-        helpText: 'The text you are reading right now, displays information about commands.',
-        arguments: [
-          {
-            name: 'command',
-            type: 'string',
-            defaultValue: 'all',
-            helpText: 'The command to get help for',
-            position: 0,
-          },
+    this.name = 'utils';
+    this.versions = [
+      new ModuleTransferVersionDTO({
+        tag: '0.0.1',
+        description: 'A collection of useful commands',
+        configSchema: JSON.stringify({
+          $schema: 'http://json-schema.org/draft-07/schema#',
+          type: 'object',
+          additionalProperties: false,
+        }),
+        commands: [
+          new ICommand({
+            function: this.loadFn('commands', 'ping'),
+            name: 'ping',
+            trigger: 'ping',
+            helpText: 'Replies with pong, useful for testing if the connection works.',
+            arguments: [],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'help'),
+            name: 'help',
+            trigger: 'help',
+            helpText: 'The text you are reading right now, displays information about commands.',
+            arguments: [
+              {
+                name: 'command',
+                type: 'string',
+                defaultValue: 'all',
+                helpText: 'The command to get help for',
+                position: 0,
+              },
+            ],
+          }),
         ],
       }),
     ];

package/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "../../tsconfig.esm.json",
+  "extends": "../../tsconfig.json",
   "compilerOptions": {
     "rootDir": "src",
     "outDir": "dist",