@takaro/modules 0.0.15 → 0.0.18

package/src/modules/dailyRewards/index.ts

@@ -1,125 +1,135 @@
 /* eslint-disable quotes */
-import { BuiltinModule, ICommand, IFunction, IHook, IPermission } from '../../BuiltinModule.js';
+import {
+  ModuleTransferDTO,
+  ICommand,
+  IFunction,
+  IHook,
+  IPermission,
+  ModuleTransferVersionDTO,
+} from '../../BuiltinModule.js';
 
-export class DailyRewards extends BuiltinModule<DailyRewards> {
+export class DailyRewards extends ModuleTransferDTO<DailyRewards> {
   constructor() {
-    super(
-      'dailyRewards',
-      'Provides daily login rewards with streak tracking',
-      JSON.stringify({
-        $schema: 'http://json-schema.org/draft-07/schema#',
-        type: 'object',
-        properties: {
-          baseReward: {
-            type: 'number',
-            title: 'Base Reward',
-            description: 'Base amount of currency given for daily rewards. This is multiplied by streak level.',
-            default: 100,
-            minimum: 1,
-          },
-          maxStreak: {
-            type: 'number',
-            title: 'Maximum Streak',
-            description: 'Maximum streak level a player can reach',
-            default: 365,
-            minimum: 1,
-          },
-          milestoneRewards: {
-            type: 'array',
-            title: 'Milestone Rewards',
-            description: 'Additional rewards for reaching certain streak milestones',
-            items: {
-              type: 'object',
-              properties: {
-                days: {
-                  type: 'number',
-                  description: 'Days needed to reach milestone',
-                  minimum: 1,
-                },
-                reward: {
-                  type: 'number',
-                  description: 'Bonus reward amount',
-                },
-                message: {
-                  type: 'string',
-                  description: 'Message to show when milestone is reached',
+    super();
+    this.name = 'dailyRewards';
+    this.versions = [
+      new ModuleTransferVersionDTO({
+        description: 'Provides daily login rewards with streak tracking',
+        tag: '0.0.1',
+        configSchema: JSON.stringify({
+          $schema: 'http://json-schema.org/draft-07/schema#',
+          type: 'object',
+          properties: {
+            baseReward: {
+              type: 'number',
+              title: 'Base Reward',
+              description: 'Base amount of currency given for daily rewards. This is multiplied by streak level.',
+              default: 100,
+              minimum: 1,
+            },
+            maxStreak: {
+              type: 'number',
+              title: 'Maximum Streak',
+              description: 'Maximum streak level a player can reach',
+              default: 365,
+              minimum: 1,
+            },
+            milestoneRewards: {
+              type: 'array',
+              title: 'Milestone Rewards',
+              description: 'Additional rewards for reaching certain streak milestones',
+              items: {
+                type: 'object',
+                properties: {
+                  days: {
+                    type: 'number',
+                    description: 'Days needed to reach milestone',
+                    minimum: 1,
+                  },
+                  reward: {
+                    type: 'number',
+                    description: 'Bonus reward amount',
+                  },
+                  message: {
+                    type: 'string',
+                    description: 'Message to show when milestone is reached',
+                  },
                 },
               },
+              default: [
+                { days: 7, reward: 1000, message: 'You did it! 7 days in a row!' },
+                { days: 30, reward: 5000, message: "A whole month! You're on fire!" },
+                { days: 90, reward: 20000, message: "90 days! You're unstoppable!" },
+                { days: 180, reward: 50000, message: "Half a year! You're a legend!" },
+                { days: 365, reward: 150000, message: "365 days! You're a true champion!" },
+              ],
             },
-            default: [
-              { days: 7, reward: 1000, message: 'You did it! 7 days in a row!' },
-              { days: 30, reward: 5000, message: "A whole month! You're on fire!" },
-              { days: 90, reward: 20000, message: "90 days! You're unstoppable!" },
-              { days: 180, reward: 50000, message: "Half a year! You're a legend!" },
-              { days: 365, reward: 150000, message: "365 days! You're a true champion!" },
-            ],
           },
-        },
-        required: ['baseReward', 'maxStreak', 'milestoneRewards'],
-        additionalProperties: false,
-      }),
-    );
-
-    this.functions = [
-      new IFunction({
-        name: 'utils',
-        function: this.loadFn('functions', 'utils'),
-      }),
-    ];
+          required: ['baseReward', 'maxStreak', 'milestoneRewards'],
+          additionalProperties: false,
+        }),
+        functions: [
+          new IFunction({
+            name: 'utils',
+            function: this.loadFn('functions', 'utils'),
+          }),
+        ],
 
-    this.permissions = [
-      new IPermission({
-        permission: 'DAILY_CLAIM',
-        friendlyName: 'Claim Daily Rewards',
-        description: 'Allows the player to claim daily rewards',
-        canHaveCount: false,
-      }),
-      new IPermission({
-        permission: 'DAILY_REWARD_MULTIPLIER',
-        friendlyName: 'Multiplier',
-        description:
-          'Control the multiplier per role. This is useful to give your donors a little extra. Count is an integer multiplier.',
-        canHaveCount: true,
-      }),
-    ];
+        permissions: [
+          new IPermission({
+            permission: 'DAILY_CLAIM',
+            friendlyName: 'Claim Daily Rewards',
+            description: 'Allows the player to claim daily rewards',
+            canHaveCount: false,
+          }),
+          new IPermission({
+            permission: 'DAILY_REWARD_MULTIPLIER',
+            friendlyName: 'Multiplier',
+            description:
+              'Control the multiplier per role. This is useful to give your donors a little extra. Count is an integer multiplier.',
+            canHaveCount: true,
+          }),
+        ],
 
-    this.commands = [
-      new ICommand({
-        function: this.loadFn('commands', 'daily'),
-        name: 'daily',
-        trigger: 'daily',
-        helpText: 'Claim your daily reward',
-        arguments: [],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'streak'),
-        name: 'streak',
-        trigger: 'streak',
-        helpText: 'Check your current daily reward streak and next claim time',
-        arguments: [],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'topstreak'),
-        name: 'topstreak',
-        trigger: 'topstreak',
-        helpText: 'Shows the players with highest daily reward streaks',
-        arguments: [
-          {
-            name: 'count',
-            type: 'number',
-            defaultValue: '5',
-            helpText: 'Number of players to show (max 25)',
-            position: 0,
-          },
+        commands: [
+          new ICommand({
+            function: this.loadFn('commands', 'daily'),
+            name: 'daily',
+            trigger: 'daily',
+            helpText: 'Claim your daily reward',
+            arguments: [],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'streak'),
+            name: 'streak',
+            trigger: 'streak',
+            helpText: 'Check your current daily reward streak and next claim time',
+            arguments: [],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'topstreak'),
+            name: 'topstreak',
+            trigger: 'topstreak',
+            helpText: 'Shows the players with highest daily reward streaks',
+            arguments: [
+              {
+                name: 'count',
+                type: 'number',
+                defaultValue: '5',
+                helpText: 'Number of players to show (max 25)',
+                position: 0,
+              },
+            ],
+          }),
         ],
-      }),
-    ];
 
-    this.hooks = [
-      new IHook({
-        eventType: 'player-connected',
-        name: 'dailyLoginCheck',
-        function: this.loadFn('hooks', 'dailyLoginCheck'),
+        hooks: [
+          new IHook({
+            eventType: 'player-connected',
+            name: 'dailyLoginCheck',
+            function: this.loadFn('hooks', 'dailyLoginCheck'),
+          }),
+        ],
       }),
     ];
   }

package/src/modules/economyUtils/index.ts

@@ -1,188 +1,191 @@
-import { BuiltinModule, ICommand, ICronJob, IPermission } from '../../BuiltinModule.js';
+import { ModuleTransferDTO, ICommand, ICronJob, IPermission, ModuleTransferVersionDTO } from '../../BuiltinModule.js';
 
-export class EconomyUtils extends BuiltinModule<EconomyUtils> {
+export class EconomyUtils extends ModuleTransferDTO<EconomyUtils> {
   constructor() {
-    super(
-      'economyUtils',
-      'A set of commands to allow players to manage their currency.',
-      JSON.stringify({
-        $schema: 'http://json-schema.org/draft-07/schema#',
-        type: 'object',
-        properties: {
-          pendingAmount: {
-            title: 'Pending amount',
-            type: 'number',
-            description:
-              'When a player transfers money, they must confirm the transfer when the amount is equal or above this value. Set to 0 to disable.',
-            default: 0,
-          },
-          zombieKillReward: {
-            title: 'Zombie kill reward',
-            type: 'number',
-            description:
-              'The default amount of currency a player receives for killing a zombie. This can be overridden by roles.',
-            default: 1,
-          },
-        },
-        required: [],
-        additionalProperties: false,
-      }),
-    );
-
-    this.permissions = [
-      new IPermission({
-        permission: 'ECONOMY_UTILS_MANAGE_CURRENCY',
-        friendlyName: 'Manage currency',
-        description:
-          'Allows players to manage currency of other players. This includes granting and revoking currency.',
-        canHaveCount: false,
-      }),
-      new IPermission({
-        permission: 'ZOMBIE_KILL_REWARD_OVERRIDE',
-        friendlyName: 'Zombie kill reward override',
-        description: 'Allows a role to override the amount of currency a player receives for killing a entity.',
-        canHaveCount: true,
-      }),
-    ];
-
-    this.cronJobs = [
-      new ICronJob({
-        function: this.loadFn('cronJobs', 'zombieKillReward'),
-        name: 'zombieKillReward',
-        temporalValue: '*/5 * * * *',
-      }),
-    ];
+    super();
 
-    this.commands = [
-      new ICommand({
-        function: this.loadFn('commands', 'balance'),
-        name: 'balance',
-        trigger: 'balance',
-        helpText: 'Check your balance.',
-        arguments: [],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'topCurrency'),
-        name: 'topCurrency',
-        trigger: 'topcurrency',
-        helpText: 'List of the 10 players with the highest balance.',
-        arguments: [],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'grantCurrency'),
-        name: 'grantCurrency',
-        trigger: 'grantcurrency',
-        helpText: 'Grant money to a player. The money is not taken from your own balance but is new currency.',
-        arguments: [
-          {
-            name: 'receiver',
-            type: 'player',
-            helpText: 'The player to grant currency to.',
-            position: 0,
-            defaultValue: null,
-          },
-          {
-            name: 'amount',
-            type: 'number',
-            helpText: 'The amount of money.',
-            position: 1,
-            defaultValue: null,
-          },
-        ],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'revokeCurrency'),
-        name: 'revokeCurrency',
-        trigger: 'revokecurrency',
-        helpText: 'Revokes money from a player. The money disappears.',
-        arguments: [
-          {
-            name: 'receiver',
-            type: 'player',
-            helpText: 'The player to revoke currency from.',
-            position: 0,
-            defaultValue: null,
-          },
-          {
-            name: 'amount',
-            type: 'number',
-            helpText: 'The amount of money.',
-            position: 1,
-            defaultValue: null,
-          },
-        ],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'confirmTransfer'),
-        name: 'confirmTransfer',
-        trigger: 'confirmtransfer',
-        helpText: 'Confirms a pending transfer.',
-        arguments: [],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'transfer'),
-        name: 'transfer',
-        trigger: 'transfer',
-        helpText: 'Transfer money to another player.',
-        arguments: [
-          {
-            name: 'receiver',
-            type: 'player',
-            helpText: 'The player to transfer money to.',
-            position: 0,
-            defaultValue: null,
-          },
-          {
-            name: 'amount',
-            type: 'number',
-            helpText: 'The amount of money to transfer.',
-            position: 1,
-            defaultValue: null,
+    this.name = 'economyUtils';
+    this.versions = [
+      new ModuleTransferVersionDTO({
+        tag: '0.0.1',
+        description: 'A set of commands to allow players to manage their currency.',
+        configSchema: JSON.stringify({
+          $schema: 'http://json-schema.org/draft-07/schema#',
+          type: 'object',
+          properties: {
+            pendingAmount: {
+              title: 'Pending amount',
+              type: 'number',
+              description:
+                'When a player transfers money, they must confirm the transfer when the amount is equal or above this value. Set to 0 to disable.',
+              default: 0,
+            },
+            zombieKillReward: {
+              title: 'Zombie kill reward',
+              type: 'number',
+              description:
+                'The default amount of currency a player receives for killing a zombie. This can be overridden by roles.',
+              default: 1,
+            },
           },
+          required: [],
+          additionalProperties: false,
+        }),
+        permissions: [
+          new IPermission({
+            permission: 'ECONOMY_UTILS_MANAGE_CURRENCY',
+            friendlyName: 'Manage currency',
+            description:
+              'Allows players to manage currency of other players. This includes granting and revoking currency.',
+            canHaveCount: false,
+          }),
+          new IPermission({
+            permission: 'ZOMBIE_KILL_REWARD_OVERRIDE',
+            friendlyName: 'Zombie kill reward override',
+            description: 'Allows a role to override the amount of currency a player receives for killing a entity.',
+            canHaveCount: true,
+          }),
         ],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'claim'),
-        name: 'claim',
-        trigger: 'claim',
-        helpText: 'Claim your pending shop orders.',
-        arguments: [
-          {
-            name: 'all',
-            type: 'boolean',
-            helpText: 'If true, claim ALL pending orders. If false, claim only the first one.',
-            position: 0,
-            defaultValue: 'false',
-          },
+        cronJobs: [
+          new ICronJob({
+            function: this.loadFn('cronJobs', 'zombieKillReward'),
+            name: 'zombieKillReward',
+            temporalValue: '*/5 * * * *',
+          }),
         ],
-      }),
-      new ICommand({
-        function: this.loadFn('commands', 'shop'),
-        name: 'shop',
-        trigger: 'shop',
-        helpText: 'Browse the shop and view available items.',
-        arguments: [
-          {
-            name: 'page',
-            type: 'number',
-            helpText: 'Display more items from the shop by specifying a page number.',
-            position: 0,
-            defaultValue: '1',
-          },
-          {
-            name: 'item',
-            type: 'number',
-            helpText: 'Select a specific item to view more details.',
-            position: 1,
-            defaultValue: '0',
-          },
-          {
-            name: 'action',
-            type: 'string',
-            helpText: 'Perform an action on the selected item. Currently only "buy" is supported.',
-            position: 2,
-            defaultValue: 'none',
-          },
+
+        commands: [
+          new ICommand({
+            function: this.loadFn('commands', 'balance'),
+            name: 'balance',
+            trigger: 'balance',
+            helpText: 'Check your balance.',
+            arguments: [],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'topCurrency'),
+            name: 'topCurrency',
+            trigger: 'topcurrency',
+            helpText: 'List of the 10 players with the highest balance.',
+            arguments: [],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'grantCurrency'),
+            name: 'grantCurrency',
+            trigger: 'grantcurrency',
+            helpText: 'Grant money to a player. The money is not taken from your own balance but is new currency.',
+            arguments: [
+              {
+                name: 'receiver',
+                type: 'player',
+                helpText: 'The player to grant currency to.',
+                position: 0,
+                defaultValue: null,
+              },
+              {
+                name: 'amount',
+                type: 'number',
+                helpText: 'The amount of money.',
+                position: 1,
+                defaultValue: null,
+              },
+            ],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'revokeCurrency'),
+            name: 'revokeCurrency',
+            trigger: 'revokecurrency',
+            helpText: 'Revokes money from a player. The money disappears.',
+            arguments: [
+              {
+                name: 'receiver',
+                type: 'player',
+                helpText: 'The player to revoke currency from.',
+                position: 0,
+                defaultValue: null,
+              },
+              {
+                name: 'amount',
+                type: 'number',
+                helpText: 'The amount of money.',
+                position: 1,
+                defaultValue: null,
+              },
+            ],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'confirmTransfer'),
+            name: 'confirmTransfer',
+            trigger: 'confirmtransfer',
+            helpText: 'Confirms a pending transfer.',
+            arguments: [],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'transfer'),
+            name: 'transfer',
+            trigger: 'transfer',
+            helpText: 'Transfer money to another player.',
+            arguments: [
+              {
+                name: 'receiver',
+                type: 'player',
+                helpText: 'The player to transfer money to.',
+                position: 0,
+                defaultValue: null,
+              },
+              {
+                name: 'amount',
+                type: 'number',
+                helpText: 'The amount of money to transfer.',
+                position: 1,
+                defaultValue: null,
+              },
+            ],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'claim'),
+            name: 'claim',
+            trigger: 'claim',
+            helpText: 'Claim your pending shop orders.',
+            arguments: [
+              {
+                name: 'all',
+                type: 'boolean',
+                helpText: 'If true, claim ALL pending orders. If false, claim only the first one.',
+                position: 0,
+                defaultValue: 'false',
+              },
+            ],
+          }),
+          new ICommand({
+            function: this.loadFn('commands', 'shop'),
+            name: 'shop',
+            trigger: 'shop',
+            helpText: 'Browse the shop and view available items.',
+            arguments: [
+              {
+                name: 'page',
+                type: 'number',
+                helpText: 'Display more items from the shop by specifying a page number.',
+                position: 0,
+                defaultValue: '1',
+              },
+              {
+                name: 'item',
+                type: 'number',
+                helpText: 'Select a specific item to view more details.',
+                position: 1,
+                defaultValue: '0',
+              },
+              {
+                name: 'action',
+                type: 'string',
+                helpText: 'Perform an action on the selected item. Currently only "buy" is supported.',
+                position: 2,
+                defaultValue: 'none',
+              },
+            ],
+          }),
         ],
       }),
     ];