@quenty/cmdrservice 13.22.2-canary.547.ba47c62.0 → 13.22.3-canary.550.afa1b3b.0

package/CHANGELOG.md

@@ -3,7 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [13.22.2-canary.547.ba47c62.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/cmdrservice@13.22.0...@quenty/cmdrservice@13.22.2-canary.547.ba47c62.0) (2025-04-07)
+## [13.22.3-canary.550.afa1b3b.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/cmdrservice@13.22.2...@quenty/cmdrservice@13.22.3-canary.550.afa1b3b.0) (2025-04-10)
+
+**Note:** Version bump only for package @quenty/cmdrservice
+
+
+
+
+
+## [13.22.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/cmdrservice@13.22.0...@quenty/cmdrservice@13.22.2) (2025-04-07)
 
 
 ### Bug Fixes

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2024 James Onnen (Quenty)
+Copyright (c) 2014-2025 James Onnen (Quenty)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/cmdrservice",
-  "version": "13.22.2-canary.547.ba47c62.0",
+  "version": "13.22.3-canary.550.afa1b3b.0",
   "description": "Bridge between cmdr and Nevermore services using servicebag",
   "keywords": [
     "Roblox",
@@ -25,18 +25,18 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "10.8.2-canary.547.ba47c62.0",
-    "@quenty/maid": "3.4.2-canary.547.ba47c62.0",
-    "@quenty/permissionprovider": "14.19.2-canary.547.ba47c62.0",
-    "@quenty/promise": "10.10.3-canary.547.ba47c62.0",
-    "@quenty/remoting": "12.18.2-canary.547.ba47c62.0",
-    "@quenty/servicebag": "11.11.3-canary.547.ba47c62.0",
-    "@quenty/string": "3.3.3-canary.547.ba47c62.0",
-    "@quenty/templateprovider": "11.18.2-canary.547.ba47c62.0",
+    "@quenty/loader": "10.8.3-canary.550.afa1b3b.0",
+    "@quenty/maid": "3.4.3-canary.550.afa1b3b.0",
+    "@quenty/permissionprovider": "14.19.3-canary.550.afa1b3b.0",
+    "@quenty/promise": "10.10.4-canary.550.afa1b3b.0",
+    "@quenty/remoting": "12.18.3-canary.550.afa1b3b.0",
+    "@quenty/servicebag": "11.11.4-canary.550.afa1b3b.0",
+    "@quenty/string": "3.3.3",
+    "@quenty/templateprovider": "11.18.3-canary.550.afa1b3b.0",
     "@quentystudios/cmdr": "^1.12.0-quenty.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ba47c62e32170bf74377b0c658c60b84306dc294"
+  "gitHead": "afa1b3b99b862698c3ab46009497bd507150867c"
 }

package/src/Server/CmdrService.lua

@@ -16,18 +16,33 @@ local Promise = require("Promise")
 local Maid = require("Maid")
 local PermissionService = require("PermissionService")
 local _ServiceBag = require("ServiceBag")
+local _CmdrTypes = require("CmdrTypes")
 
 local CmdrService = {}
 CmdrService.ServiceName = "CmdrService"
 
+export type CmdrService = typeof(setmetatable(
+	{} :: {
+		_maid: Maid.Maid,
+		_serviceBag: _ServiceBag.ServiceBag,
+		_serviceId: string,
+		_promiseCmdr: Promise.Promise<any>,
+		_cmdrTemplateProviderServer: any,
+		_permissionService: PermissionService.PermissionService,
+		_definitionData: { [string]: _CmdrTypes.CommandDefinition },
+		_executeData: { [string]: (context: _CmdrTypes.CommandContext, ...any) -> string? },
+	},
+	{} :: typeof({ __index = CmdrService })
+))
+
 local GLOBAL_REGISTRY = setmetatable({}, { __mode = "kv" })
 
 --[=[
 	Initializes the CmdrService. Should be done via [ServiceBag].
 	@param serviceBag ServiceBag
 ]=]
-function CmdrService:Init(serviceBag: _ServiceBag.ServiceBag)
-	assert(not self._serviceBag, "Already initialized")
+function CmdrService.Init(self: CmdrService, serviceBag: _ServiceBag.ServiceBag)
+	assert(not (self :: any)._serviceBag, "Already initialized")
 	self._maid = Maid.new()
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 
@@ -55,7 +70,6 @@ function CmdrService:Init(serviceBag: _ServiceBag.ServiceBag)
 		resolve(cmdr)
 	end))
 
-
 	self._definitionData = {}
 	self._executeData = {}
 
@@ -100,7 +114,7 @@ end
 	Returns cmdr
 	@return Promise<Cmdr>
 ]=]
-function CmdrService:PromiseCmdr()
+function CmdrService.PromiseCmdr(self: CmdrService)
 	assert(self._promiseCmdr, "Not initialized")
 
 	return self._promiseCmdr
@@ -111,8 +125,12 @@ end
 	@param commandData table
 	@param execute (context: table, ... T)
 ]=]
-function CmdrService:RegisterCommand(commandData, execute)
-	assert(self._promiseCmdr, "Not initialized")
+function CmdrService.RegisterCommand(
+	self: CmdrService,
+	commandData: _CmdrTypes.CommandDefinition,
+	execute: (context: _CmdrTypes.CommandContext, ...any) -> string?
+): ()
+	assert((self :: any)._promiseCmdr, "Not initialized")
 	assert(commandData, "No commandData")
 	assert(commandData.Name, "No commandData.Name")
 	assert(execute, "No execute")
@@ -159,7 +177,7 @@ end
 	@param ... any
 	@private
 ]=]
-function CmdrService:__executeCommand(cmdrCommandId: string, ...)
+function CmdrService.__executeCommand(self: CmdrService, cmdrCommandId: string, ...): string?
 	assert(type(cmdrCommandId) == "string", "Bad cmdrCommandId")
 	assert(self._promiseCmdr, "CmdrService is not initialized yet")
 
@@ -178,13 +196,13 @@ end
 	@return CmdrService
 	@private
 ]=]
-function CmdrService:__getServiceFromId(cmdrServiceId: string)
+function CmdrService.__getServiceFromId(_self: CmdrService, cmdrServiceId: string)
 	assert(type(cmdrServiceId) == "string", "Bad cmdrServiceId")
 
 	return GLOBAL_REGISTRY[cmdrServiceId]
 end
 
-function CmdrService:Destroy()
+function CmdrService.Destroy(self: CmdrService)
 	self._maid:DoCleaning()
 end
 

package/src/Shared/CmdrTypes.lua

@@ -0,0 +1,46 @@
+--!strict
+
+export type NamedObject = {
+    Name: string
+}
+
+export type TypeDefinition<T> = {
+    DisplayName: string?,
+    Prefixes: string?,
+    Transform: ((string, Player) -> T)?,
+    Validate: ((T) -> (boolean, string?) | boolean)?,
+    ValidateOnce: ((T) -> (boolean, string?) | boolean)?,
+    Autocomplete: ((T) -> ({ string }, { IsPartial: boolean? }?) | { string })?,
+    Parse: (T) -> any,
+    Default: ((Player) -> string)?,
+    Listable: boolean?,
+}
+
+export type CommandArgument = {
+    Type: string | TypeDefinition<any>,
+    Name: string,
+    Description: string,
+    Optional: boolean?,
+    Default: any?,
+}
+
+export type CommandContext = {
+    GetData: (self: CommandContext) -> any,
+    GetPlayer: (self: CommandContext) -> Player,
+    GetArgs: (self: CommandContext) -> { any },
+    GetCommandName: (self: CommandContext) -> string,
+    GetCommandId: (self: CommandContext) -> string,
+}
+
+export type CommandDefinition = {
+    Name: string,
+    Aliases: { string }?,
+    Description: string,
+    Group: any?,
+    Args: { CommandArgument | (CommandContext) -> CommandArgument },
+    Data: ((CommandContext) -> any)?,
+    ClientRun: ((CommandContext, ...any) -> string?)?,
+    AutoExec: { string }?,
+}
+
+return {}