@quenty/cmdrservice 3.8.0 → 3.9.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.9.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/cmdrservice@3.8.1...@quenty/cmdrservice@3.9.0) (2022-01-17)
+
+
+### Bug Fixes
+
+* Cmdrservice can yield while requiring cmdrclient, prevent this from yielding all services ([2330373](https://github.com/Quenty/NevermoreEngine/commit/23303730a2993c544d361eff2752b3d71a75abdb))
+
+
+
+
+
+## [3.8.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/cmdrservice@3.8.0...@quenty/cmdrservice@3.8.1) (2022-01-16)
+
+**Note:** Version bump only for package @quenty/cmdrservice
+
+
+
+
+
 # [3.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/cmdrservice@3.7.0...@quenty/cmdrservice@3.8.0) (2022-01-07)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/cmdrservice",
-  "version": "3.8.0",
+  "version": "3.9.0",
   "description": "Bridge between cmdr and Nevermore services using servicebag",
   "keywords": [
     "Roblox",
@@ -25,14 +25,14 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^3.3.0",
-    "@quenty/maid": "^2.0.2",
-    "@quenty/permissionprovider": "^4.6.0",
-    "@quenty/promise": "^3.5.0",
-    "@quenty/remoting": "^3.5.0",
-    "@quenty/servicebag": "^3.4.0",
+    "@quenty/loader": "^3.4.0",
+    "@quenty/maid": "^2.1.0",
+    "@quenty/permissionprovider": "^4.7.0",
+    "@quenty/promise": "^3.6.0",
+    "@quenty/remoting": "^3.6.0",
+    "@quenty/servicebag": "^3.5.0",
     "@quenty/string": "^2.2.1",
-    "@quenty/templateprovider": "^3.7.0"
+    "@quenty/templateprovider": "^3.8.0"
   },
   "peerDependencies": {
     "@quentystudios/cmdr": "^1.8.4-quenty.1"
@@ -40,5 +40,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5a3f3fb6c908fd3874f5ceacc70b404780275119"
+  "gitHead": "c094ba8f4e128cdff08919d89de226d3d65247ce"
 }

package/src/Client/CmdrServiceClient.lua

@@ -1,5 +1,7 @@
 --[=[
-	Loads cmdr on the client
+	Loads cmdr on the client. See [CmdrService] for the server equivalent.
+
+	@client
 	@class CmdrServiceClient
 ]=]
 
@@ -13,9 +15,14 @@ local PromiseUtils = require("PromiseUtils")
 local PermissionServiceClient = require("PermissionServiceClient")
 local Maid = require("Maid")
 local String = require("String")
+local Promise = require("Promise")
 
 local CmdrServiceClient = {}
 
+--[=[
+	Starts the cmdr service on the client. Should be done via [ServiceBag].
+	@param serviceBag ServiceBag
+]=]
 function CmdrServiceClient:Init(serviceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
@@ -24,6 +31,9 @@ function CmdrServiceClient:Init(serviceBag)
 	self._permissionService = serviceBag:GetService(PermissionServiceClient)
 end
 
+--[=[
+	Starts the service. Should be done via [ServiceBag].
+]=]
 function CmdrServiceClient:Start()
 	assert(self._serviceBag, "Not initialized")
 
@@ -58,6 +68,10 @@ function CmdrServiceClient:_setBindings(cmdr)
 	cmdr.Dispatcher:Run("bind", Enum.KeyCode.G.Name, "blink")
 end
 
+--[=[
+	Retrieves the cmdr for the client.
+	@return Promise<CmdrClient>
+]=]
 function CmdrServiceClient:PromiseCmdr()
 	assert(self._serviceBag, "Not initialized")
 
@@ -67,7 +81,10 @@ function CmdrServiceClient:PromiseCmdr()
 
 	self._cmdrPromise = promiseChild(ReplicatedStorage, "CmdrClient")
 		:Then(function(cmdClient)
-			return require(cmdClient)
+			return Promise.spawn(function(resolve, _reject)
+				-- Requiring cmdr can yield
+				return resolve(require(cmdClient))
+			end)
 		end)
 
 	return self._cmdrPromise

package/src/Server/CmdrService.lua

@@ -2,6 +2,7 @@
 	Bridge to https://eryn.io/Cmdr/
 
 	Uses [PermissionService] to provide permissions.
+	@server
 	@class CmdrService
 ]=]
 
@@ -116,23 +117,35 @@ function CmdrService:RegisterCommand(commandData, execute)
 	self._cmdr.Registry:RegisterCommand(commandScript, commandServerScript)
 end
 
-function CmdrService:__ExecuteCommand(id, ...)
-	assert(type(id) == "string", "Bad serviceId")
-	assert(self._cmdr, "Not initialized")
+--[=[
+	Private function used by the execution template to retrieve the execution function.
+	@param cmdrCommandId string
+	@param ... any
+	@private
+]=]
+function CmdrService:__executeCommand(cmdrCommandId, ...)
+	assert(type(cmdrCommandId) == "string", "Bad cmdrCommandId")
+	assert(self._cmdr, "CmdrService is not initialized yet")
 
-	local execute = self._executeData[id]
+	local execute = self._executeData[cmdrCommandId]
 	if not execute then
-		error(("[CmdrService] - No command definition for id %q"):format(tostring(id)))
+		error(("[CmdrService] - No command definition for cmdrCommandId %q"):format(tostring(cmdrCommandId)))
 	end
 
 	return execute(...)
 end
 
--- Global, but only intended for internal use
-function CmdrService:__GetServiceFromId(id)
-	assert(type(id) == "string", "Bad serviceId")
+--[=[
+	Global usage but only intended for internal use
+
+	@param cmdrServiceId string
+	@return CmdrService
+	@private
+]=]
+function CmdrService:__getServiceFromId(cmdrServiceId)
+	assert(type(cmdrServiceId) == "string", "Bad cmdrServiceId")
 
-	return GLOBAL_REGISTRY[id]
+	return GLOBAL_REGISTRY[cmdrServiceId]
 end
 
 return CmdrService

package/src/Server/CmdrTemplateProviderServer/CmdrExecutionTemplate.lua

@@ -1,5 +1,5 @@
 --[=[
-	Generic command definition template
+	Generic command definition template which we can use to
 	@class CmdrCommandDefinitionTemplate
 ]=]
 
@@ -15,8 +15,8 @@ end
 local cmdrServiceId = waitForValue(script:WaitForChild("CmdrServiceId"))
 local cmdrCommandId = waitForValue(script:WaitForChild("CmdrCommandId"))
 local commandServiceDefinition = require(waitForValue(script:WaitForChild("CmdrServiceTarget")))
-local cmdrService = commandServiceDefinition:__GetServiceFromId(cmdrServiceId)
+local cmdrService = commandServiceDefinition:__getServiceFromId(cmdrServiceId)
 
 return function(...)
-	return cmdrService:__ExecuteCommand(cmdrCommandId, ...)
+	return cmdrService:__executeCommand(cmdrCommandId, ...)
 end

package/test/scripts/Client/ClientMain.client.lua

@@ -1,6 +1,6 @@
--- Main injection point
--- @script ClientMain
--- @author Quenty
+--[[
+	@class ClientMain
+]]
 
 local packages = game:GetService("ReplicatedStorage"):WaitForChild("Packages")
 

package/test/scripts/Server/ServerMain.server.lua

@@ -1,5 +1,6 @@
--- Main injection point
--- @script ServerMain
+--[[
+	@class ServerMain
+]]
 
 local ReplicatedStorage = game:GetService("ReplicatedStorage")
 local ServerScriptService = game:GetService("ServerScriptService")
@@ -24,8 +25,8 @@ serviceBag:GetService(require(serverFolder.CmdrService)):RegisterCommand({
 	Group = "Admin";
 	Args = {
 		{
+			Name = "Players";
 			Type = "players";
-			Name = "players";
 			Description = "Victims";
 		},
 	};