@quenty/permissionprovider 14.19.3 → 14.19.4-canary.559.339cfa7.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [14.19.4-canary.559.339cfa7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@14.19.3...@quenty/permissionprovider@14.19.4-canary.559.339cfa7.0) (2025-05-10)
+
+
+### Bug Fixes
+
+* Additional type checking updates ([05ba29a](https://github.com/Quenty/NevermoreEngine/commit/05ba29a03efc9f3feed74b34f1d9dfb237496214))
+
+
+### Features
+
+* Add even more types ([b31717d](https://github.com/Quenty/NevermoreEngine/commit/b31717d8c9f7620c457f5018a2affa760a65334a))
+
+
+
+
+
 ## [14.19.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@14.19.2...@quenty/permissionprovider@14.19.3) (2025-04-10)
 
 **Note:** Version bump only for package @quenty/permissionprovider

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/permissionprovider",
-  "version": "14.19.3",
+  "version": "14.19.4-canary.559.339cfa7.0",
   "description": "Permission provider for Roblox, including authenticating against group membership",
   "keywords": [
     "Roblox",
@@ -25,20 +25,20 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.8.3",
-    "@quenty/brio": "^14.17.3",
-    "@quenty/grouputils": "^10.10.4",
-    "@quenty/loader": "^10.8.3",
-    "@quenty/maid": "^3.4.3",
-    "@quenty/playerutils": "^8.17.3",
-    "@quenty/promise": "^10.10.4",
-    "@quenty/remoting": "^12.18.3",
-    "@quenty/rx": "^13.17.3",
-    "@quenty/servicebag": "^11.11.4",
-    "@quenty/table": "^3.7.4"
+    "@quenty/baseobject": "10.8.4-canary.559.339cfa7.0",
+    "@quenty/brio": "14.17.4-canary.559.339cfa7.0",
+    "@quenty/grouputils": "10.10.5-canary.559.339cfa7.0",
+    "@quenty/loader": "10.8.4-canary.559.339cfa7.0",
+    "@quenty/maid": "3.4.4-canary.559.339cfa7.0",
+    "@quenty/playerutils": "8.17.4-canary.559.339cfa7.0",
+    "@quenty/promise": "10.10.5-canary.559.339cfa7.0",
+    "@quenty/remoting": "12.18.4-canary.559.339cfa7.0",
+    "@quenty/rx": "13.17.4-canary.559.339cfa7.0",
+    "@quenty/servicebag": "11.11.5-canary.559.339cfa7.0",
+    "@quenty/table": "3.7.5-canary.559.339cfa7.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
+  "gitHead": "339cfa778736f08768ed7305041f6221faa35bfc"
 }

package/src/Client/PermissionServiceClient.lua

@@ -11,11 +11,11 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local PermissionProviderConstants = require("PermissionProviderConstants")
+local Maid = require("Maid")
 local PermissionProviderClient = require("PermissionProviderClient")
+local PermissionProviderConstants = require("PermissionProviderConstants")
 local Promise = require("Promise")
-local Maid = require("Maid")
-local _ServiceBag = require("ServiceBag")
+local ServiceBag = require("ServiceBag")
 
 local PermissionServiceClient = {}
 PermissionServiceClient.ServiceName = "PermissionServiceClient"
@@ -24,7 +24,7 @@ PermissionServiceClient.ServiceName = "PermissionServiceClient"
 	Initializes the permission service on the client. Should be done via [ServiceBag].
 	@param serviceBag ServiceBag
 ]=]
-function PermissionServiceClient:Init(serviceBag: _ServiceBag.ServiceBag)
+function PermissionServiceClient:Init(serviceBag: ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "no serviceBag")
 	self._maid = Maid.new()

package/src/Client/Providers/PermissionProviderClient.lua

@@ -88,4 +88,4 @@ function PermissionProviderClient._promiseRemoteFunction(self: PermissionProvide
 	return self._remoteFunctionPromise
 end
 
-return PermissionProviderClient
+return PermissionProviderClient

package/src/Server/PermissionProviderUtils.lua

@@ -75,15 +75,15 @@ end
 function PermissionProviderUtils.createConfigFromGame(): PermissionProviderConfig
 	if game.CreatorType == Enum.CreatorType.Group then
 		return PermissionProviderUtils.createGroupRankConfig({
-			groupId = game.CreatorId;
-			minAdminRequiredRank = 250;
-			minCreatorRequiredRank = 254;
+			groupId = game.CreatorId,
+			minAdminRequiredRank = 250,
+			minCreatorRequiredRank = 254,
 		})
 	else
 		return PermissionProviderUtils.createSingleUserConfig({
-			userId = game.CreatorId;
+			userId = game.CreatorId,
 		})
 	end
 end
 
-return PermissionProviderUtils
+return PermissionProviderUtils

package/src/Server/PermissionService.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Provides permissions for the game. See [BasePermissionProvider].
 
@@ -24,21 +25,21 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local BasePermissionProvider = require("BasePermissionProvider")
+local Brio = require("Brio")
 local CreatorPermissionProvider = require("CreatorPermissionProvider")
 local GroupPermissionProvider = require("GroupPermissionProvider")
 local Maid = require("Maid")
+local Observable = require("Observable")
 local PermissionLevel = require("PermissionLevel")
+local PermissionLevelUtils = require("PermissionLevelUtils")
 local PermissionProviderConstants = require("PermissionProviderConstants")
 local PermissionProviderUtils = require("PermissionProviderUtils")
 local Promise = require("Promise")
 local Rx = require("Rx")
 local RxBrioUtils = require("RxBrioUtils")
 local RxPlayerUtils = require("RxPlayerUtils")
-local PermissionLevelUtils = require("PermissionLevelUtils")
-local _ServiceBag = require("ServiceBag")
-local _Observable = require("Observable")
-local _Brio = require("Brio")
-local _BasePermissionProvider = require("BasePermissionProvider")
+local ServiceBag = require("ServiceBag")
 
 local PermissionService = {}
 PermissionService.ServiceName = "PermissionService"
@@ -56,7 +57,7 @@ export type PermissionService = typeof(setmetatable(
 	Initializes the service. Should be done via [ServiceBag].
 	@param _serviceBag ServiceBag
 ]=]
-function PermissionService:Init(_serviceBag: _ServiceBag.ServiceBag)
+function PermissionService.Init(self: PermissionService, _serviceBag: ServiceBag.ServiceBag)
 	assert(not self._promise, "Already initialized")
 	assert(not self._provider, "Already have provider")
 
@@ -71,7 +72,10 @@ end
 
 	@param config { type: string }
 ]=]
-function PermissionService:SetProviderFromConfig(config: PermissionProviderUtils.PermissionProviderConfig)
+function PermissionService.SetProviderFromConfig(
+	self: PermissionService,
+	config: PermissionProviderUtils.PermissionProviderConfig
+)
 	assert(self._promise, "Not initialized")
 	assert(not self._provider, "Already have provider set")
 
@@ -87,7 +91,7 @@ end
 --[=[
 	Starts the permission service. Should be done via [ServiceBag].
 ]=]
-function PermissionService:Start()
+function PermissionService.Start(self: PermissionService)
 	if not self._provider then
 		self:SetProviderFromConfig(PermissionProviderUtils.createConfigFromGame())
 	end
@@ -101,7 +105,9 @@ end
 	Returns the permission provider
 	@return Promise<BasePermissionProvider>
 ]=]
-function PermissionService:PromisePermissionProvider(): Promise.Promise<_BasePermissionProvider.BasePermissionProvider>
+function PermissionService.PromisePermissionProvider(
+	self: PermissionService
+): Promise.Promise<BasePermissionProvider.BasePermissionProvider>
 	assert(self._promise, "Not initialized")
 
 	return self._promise
@@ -112,7 +118,7 @@ end
 	@param player Player
 	@return Promise<boolean>
 ]=]
-function PermissionService:PromiseIsAdmin(player: Player): Promise.Promise<boolean>
+function PermissionService.PromiseIsAdmin(self: PermissionService, player: Player): Promise.Promise<boolean>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "bad player")
 
 	return self:PromiseIsPermissionLevel(player, PermissionLevel.ADMIN)
@@ -123,7 +129,7 @@ end
 	@param player Player
 	@return Promise<boolean>
 ]=]
-function PermissionService:PromiseIsCreator(player: Player): Promise.Promise<boolean>
+function PermissionService.PromiseIsCreator(self: PermissionService, player: Player): Promise.Promise<boolean>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "bad player")
 
 	return self:PromiseIsPermissionLevel(player, PermissionLevel.CREATOR)
@@ -135,7 +141,8 @@ end
 	@param permissionLevel PermissionLevel
 	@return Promise<boolean>
 ]=]
-function PermissionService:PromiseIsPermissionLevel(
+function PermissionService.PromiseIsPermissionLevel(
+	self: PermissionService,
 	player: Player,
 	permissionLevel: PermissionLevel.PermissionLevel
 ): Promise.Promise<boolean>
@@ -153,25 +160,28 @@ end
 	@param permissionLevel PermissionLevel
 	@return Observable<Brio<Player>>
 ]=]
-function PermissionService:ObservePermissionedPlayersBrio(permissionLevel: PermissionLevel.PermissionLevel): _Observable.Observable<_Brio.Brio<Player>>
+function PermissionService.ObservePermissionedPlayersBrio(
+	self: PermissionService,
+	permissionLevel: PermissionLevel.PermissionLevel
+): Observable.Observable<Brio.Brio<Player>>
 	assert(PermissionLevelUtils.isPermissionLevel(permissionLevel), "Bad permissionLevel")
 
 	return RxPlayerUtils.observePlayersBrio():Pipe({
 		RxBrioUtils.flatMapBrio(function(player)
 			return Rx.fromPromise(self:PromiseIsPermissionLevel(player, permissionLevel)):Pipe({
-				Rx.switchMap(function(hasPermission)
+				Rx.switchMap(function(hasPermission): any
 					if hasPermission then
 						return Rx.of(player)
 					else
 						return Rx.EMPTY
 					end
-				end),
-			})
-		end),
-	})
+				end) :: any,
+			}) :: any
+		end) :: any,
+	}) :: any
 end
 
-function PermissionService:Destroy()
+function PermissionService.Destroy(self: PermissionService)
 	self._maid:DoCleaning()
 	self._provider = nil
 end

package/src/Server/Providers/BasePermissionProvider.lua

@@ -11,9 +11,9 @@ local BaseObject = require("BaseObject")
 local GetRemoteFunction = require("GetRemoteFunction")
 local PermissionLevel = require("PermissionLevel")
 local PermissionLevelUtils = require("PermissionLevelUtils")
+local PermissionProviderUtils = require("PermissionProviderUtils")
+local Promise = require("Promise")
 local Table = require("Table")
-local _Promise = require("Promise")
-local _PermissionProviderUtils = require("PermissionProviderUtils")
 
 local BasePermissionProvider = setmetatable({}, BaseObject)
 BasePermissionProvider.ClassName = "BasePermissionProvider"
@@ -34,7 +34,7 @@ export type BasePermissionProvider = typeof(setmetatable(
 	@param config { remoteFunctionName: string }
 	@return BasePermissionProvider
 ]=]
-function BasePermissionProvider.new(config: _PermissionProviderUtils.PermissionProviderConfig): BasePermissionProvider
+function BasePermissionProvider.new(config: PermissionProviderUtils.PermissionProviderConfig): BasePermissionProvider
 	local self: BasePermissionProvider = setmetatable(BaseObject.new() :: any, BasePermissionProvider)
 
 	self._config = Table.readonly(assert(config, "Bad config") :: any)
@@ -66,7 +66,7 @@ function BasePermissionProvider.PromiseIsPermissionLevel(
 	_self: BasePermissionProvider,
 	player: Player,
 	permissionLevel: PermissionLevel.PermissionLevel
-): _Promise.Promise<boolean>
+): Promise.Promise<boolean>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 	assert(PermissionLevelUtils.isPermissionLevel(permissionLevel), "Bad permissionLevel")
 
@@ -106,10 +106,7 @@ end
 	@param player Player
 	@return Promise<boolean>
 ]=]
-function BasePermissionProvider.PromiseIsCreator(
-	self: BasePermissionProvider,
-	player: Player
-): _Promise.Promise<boolean>
+function BasePermissionProvider.PromiseIsCreator(self: BasePermissionProvider, player: Player): Promise.Promise<boolean>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self:PromiseIsPermissionLevel(player, PermissionLevel.CREATOR)
@@ -120,7 +117,7 @@ end
 	@param player Player
 	@return Promise<boolean>
 ]=]
-function BasePermissionProvider.PromiseIsAdmin(self: BasePermissionProvider, player: Player): _Promise.Promise<boolean>
+function BasePermissionProvider.PromiseIsAdmin(self: BasePermissionProvider, player: Player): Promise.Promise<boolean>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return self:PromiseIsPermissionLevel(player, PermissionLevel.ADMIN)
@@ -169,4 +166,4 @@ function BasePermissionProvider._onServerInvoke(self: BasePermissionProvider, pl
 	return result and true or false
 end
 
-return BasePermissionProvider
+return BasePermissionProvider

package/src/Server/Providers/CreatorPermissionProvider.lua

@@ -11,11 +11,11 @@ local require = require(script.Parent.loader).load(script)
 local RunService = game:GetService("RunService")
 
 local BasePermissionProvider = require("BasePermissionProvider")
-local PermissionProviderConstants = require("PermissionProviderConstants")
-local Promise = require("Promise")
 local PermissionLevel = require("PermissionLevel")
 local PermissionLevelUtils = require("PermissionLevelUtils")
-local _PermissionProviderUtils = require("PermissionProviderUtils")
+local PermissionProviderConstants = require("PermissionProviderConstants")
+local PermissionProviderUtils = require("PermissionProviderUtils")
+local Promise = require("Promise")
 
 local CreatorPermissionProvider = setmetatable({}, BasePermissionProvider)
 CreatorPermissionProvider.ClassName = "CreatorPermissionProvider"
@@ -23,7 +23,7 @@ CreatorPermissionProvider.__index = CreatorPermissionProvider
 
 export type CreatorPermissionProvider = typeof(setmetatable(
 	{} :: {
-		_config: _PermissionProviderUtils.SingleUserConfig,
+		_config: PermissionProviderUtils.SingleUserConfig,
 		_userId: number,
 	},
 	{} :: typeof({ __index = CreatorPermissionProvider })
@@ -33,7 +33,7 @@ export type CreatorPermissionProvider = typeof(setmetatable(
 	@param config table
 	@return CreatorPermissionProvider
 ]=]
-function CreatorPermissionProvider.new(config: _PermissionProviderUtils.SingleUserConfig): CreatorPermissionProvider
+function CreatorPermissionProvider.new(config: PermissionProviderUtils.SingleUserConfig): CreatorPermissionProvider
 	local self: CreatorPermissionProvider =
 		setmetatable(BasePermissionProvider.new(config) :: any, CreatorPermissionProvider)
 
@@ -50,16 +50,19 @@ end
 	@param permissionLevel PermissionLevel
 	@return Promise<boolean>
 ]=]
-function CreatorPermissionProvider.PromiseIsPermissionLevel(self: CreatorPermissionProvider, player: Player, permissionLevel: PermissionLevel.PermissionLevel): Promise.Promise<boolean>
+function CreatorPermissionProvider.PromiseIsPermissionLevel(
+	self: CreatorPermissionProvider,
+	player: Player,
+	permissionLevel: PermissionLevel.PermissionLevel
+): Promise.Promise<boolean>
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 	assert(PermissionLevelUtils.isPermissionLevel(permissionLevel), "Bad permissionLevel")
 
-	if permissionLevel == PermissionLevel.ADMIN
-		or permissionLevel == PermissionLevel.CREATOR then
+	if permissionLevel == PermissionLevel.ADMIN or permissionLevel == PermissionLevel.CREATOR then
 		return Promise.resolved(player.UserId == self._userId or RunService:IsStudio())
 	else
 		error("Unknown permissionLevel")
 	end
 end
 
-return CreatorPermissionProvider
+return CreatorPermissionProvider

package/src/Server/Providers/GroupPermissionProvider.lua

@@ -15,8 +15,8 @@ local GroupUtils = require("GroupUtils")
 local PermissionLevel = require("PermissionLevel")
 local PermissionLevelUtils = require("PermissionLevelUtils")
 local PermissionProviderConstants = require("PermissionProviderConstants")
+local PermissionProviderUtils = require("PermissionProviderUtils")
 local Promise = require("Promise")
-local _PermissionProviderUtils = require("PermissionProviderUtils")
 
 local GroupPermissionProvider = setmetatable({}, BasePermissionProvider)
 GroupPermissionProvider.__index = GroupPermissionProvider
@@ -24,7 +24,7 @@ GroupPermissionProvider.ClassName = "GroupPermissionProvider"
 
 export type GroupPermissionProvider = typeof(setmetatable(
 	{} :: {
-		_config: _PermissionProviderUtils.GroupRankConfig,
+		_config: PermissionProviderUtils.GroupRankConfig,
 		_groupId: number,
 		_minAdminRequiredRank: number,
 		_minCreatorRequiredRank: number,
@@ -39,7 +39,7 @@ export type GroupPermissionProvider = typeof(setmetatable(
 	@param config table
 	@return GroupPermissionProvider
 ]=]
-function GroupPermissionProvider.new(config: _PermissionProviderUtils.GroupRankConfig): GroupPermissionProvider
+function GroupPermissionProvider.new(config: PermissionProviderUtils.GroupRankConfig): GroupPermissionProvider
 	local self = setmetatable(BasePermissionProvider.new(config) :: any, GroupPermissionProvider)
 
 	assert(self._config.type == PermissionProviderConstants.GROUP_RANK_CONFIG_TYPE, "Bad configType")
@@ -158,7 +158,10 @@ function GroupPermissionProvider._handlePlayer(self: GroupPermissionProvider, pl
 	end)
 end
 
-function GroupPermissionProvider._promiseRankInGroup(self: GroupPermissionProvider, player: Player): Promise.Promise<number>
+function GroupPermissionProvider._promiseRankInGroup(
+	self: GroupPermissionProvider,
+	player: Player
+): Promise.Promise<number>
 	assert(typeof(player) == "Instance", "Bad player")
 
 	if self._promiseRankPromisesCache[player.UserId] then
@@ -169,4 +172,4 @@ function GroupPermissionProvider._promiseRankInGroup(self: GroupPermissionProvid
 	return self._promiseRankPromisesCache[player.UserId]
 end
 
-return GroupPermissionProvider
+return GroupPermissionProvider

package/src/Shared/PermissionLevelUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class PermissionLevelUtils
 ]=]
@@ -20,4 +21,4 @@ function PermissionLevelUtils.isPermissionLevel(permissionLevel: any): boolean
 	return ALLOWED[permissionLevel] == true
 end
 
-return PermissionLevelUtils
+return PermissionLevelUtils

package/src/Shared/PermissionProviderConstants.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Constants for the permission system
 	@class PermissionProviderConstants

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

@@ -9,7 +9,9 @@ serviceBag:GetService(require("PermissionServiceClient"))
 serviceBag:Init()
 serviceBag:Start()
 
-serviceBag:GetService(require("PermissionServiceClient")):PromisePermissionProvider()
+serviceBag
+	:GetService(require("PermissionServiceClient"))
+	:PromisePermissionProvider()
 	:Then(function(permissionProvider)
 		return permissionProvider:PromiseIsAdmin()
 	end)
@@ -17,4 +19,4 @@ serviceBag:GetService(require("PermissionServiceClient")):PromisePermissionProvi
 		print("isAdmin", isAdmin)
 	end)
 
-print("Loaded")
+print("Loaded")