@quenty/permissionprovider 9.0.0-canary.331.7eefa75.0 → 9.0.0

package/CHANGELOG.md

@@ -3,7 +3,157 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [9.0.0-canary.331.7eefa75.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.7.0...@quenty/permissionprovider@9.0.0-canary.331.7eefa75.0) (2023-02-27)
+# [9.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.21.0...@quenty/permissionprovider@9.0.0) (2023-10-11)
+
+**Note:** Version bump only for package @quenty/permissionprovider
+
+
+
+
+
+# [8.21.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.20.0...@quenty/permissionprovider@8.21.0) (2023-09-21)
+
+**Note:** Version bump only for package @quenty/permissionprovider
+
+
+
+
+
+# [8.20.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.19.0...@quenty/permissionprovider@8.20.0) (2023-09-04)
+
+**Note:** Version bump only for package @quenty/permissionprovider
+
+
+
+
+
+# [8.19.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.18.0...@quenty/permissionprovider@8.19.0) (2023-08-23)
+
+
+### Features
+
+* Add PermissionService:PromiseIsPermissionLevel(player, permissionLevel) ([2297438](https://github.com/Quenty/NevermoreEngine/commit/229743882002800c917e5fd131f81b4f7a36dc89))
+
+
+
+
+
+# [8.18.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.17.1...@quenty/permissionprovider@8.18.0) (2023-07-28)
+
+**Note:** Version bump only for package @quenty/permissionprovider
+
+
+
+
+
+## [8.17.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.17.0...@quenty/permissionprovider@8.17.1) (2023-07-18)
+
+**Note:** Version bump only for package @quenty/permissionprovider
+
+
+
+
+
+# [8.17.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.16.1...@quenty/permissionprovider@8.17.0) (2023-07-15)
+
+**Note:** Version bump only for package @quenty/permissionprovider
+
+
+
+
+
+## [8.16.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.16.0...@quenty/permissionprovider@8.16.1) (2023-07-11)
+
+**Note:** Version bump only for package @quenty/permissionprovider
+
+
+
+
+
+# [8.16.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.15.1...@quenty/permissionprovider@8.16.0) (2023-07-10)
+
+**Note:** Version bump only for package @quenty/permissionprovider
+
+
+
+
+
+## [8.15.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.15.0...@quenty/permissionprovider@8.15.1) (2023-07-03)
+
+**Note:** Version bump only for package @quenty/permissionprovider
+
+
+
+
+
+# [8.15.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.14.0...@quenty/permissionprovider@8.15.0) (2023-06-24)
+
+**Note:** Version bump only for package @quenty/permissionprovider
+
+
+
+
+
+# [8.14.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.13.0...@quenty/permissionprovider@8.14.0) (2023-06-17)
+
+**Note:** Version bump only for package @quenty/permissionprovider
+
+
+
+
+
+# [8.13.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.12.0...@quenty/permissionprovider@8.13.0) (2023-05-26)
+
+**Note:** Version bump only for package @quenty/permissionprovider
+
+
+
+
+
+# [8.12.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.11.0...@quenty/permissionprovider@8.12.0) (2023-04-24)
+
+
+### Features
+
+* Add PromiseIsCreator and PromiseIsAdmin utility helper methods on PermissionService ([179ed15](https://github.com/Quenty/NevermoreEngine/commit/179ed153a3c6329417569cfff93310a0e862bc1d))
+
+
+
+
+
+# [8.11.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.10.1...@quenty/permissionprovider@8.11.0) (2023-04-10)
+
+**Note:** Version bump only for package @quenty/permissionprovider
+
+
+
+
+
+## [8.10.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.10.0...@quenty/permissionprovider@8.10.1) (2023-04-07)
+
+**Note:** Version bump only for package @quenty/permissionprovider
+
+
+
+
+
+# [8.10.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.9.0...@quenty/permissionprovider@8.10.0) (2023-03-31)
+
+**Note:** Version bump only for package @quenty/permissionprovider
+
+
+
+
+
+# [8.9.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.8.0...@quenty/permissionprovider@8.9.0) (2023-03-05)
+
+**Note:** Version bump only for package @quenty/permissionprovider
+
+
+
+
+
+# [8.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/permissionprovider@8.7.0...@quenty/permissionprovider@8.8.0) (2023-02-27)
 
 **Note:** Version bump only for package @quenty/permissionprovider
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2022 Quenty
+Copyright (c) 2014-2023 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/permissionprovider",
-  "version": "9.0.0-canary.331.7eefa75.0",
+  "version": "9.0.0",
   "description": "Permission provider for Roblox, including authenticating against group membership",
   "keywords": [
     "Roblox",
@@ -25,17 +25,20 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "6.1.0",
-    "@quenty/grouputils": "7.0.0-canary.331.7eefa75.0",
-    "@quenty/loader": "6.1.0",
-    "@quenty/maid": "2.4.0",
-    "@quenty/promise": "7.0.0-canary.331.7eefa75.0",
-    "@quenty/remoting": "7.0.0-canary.331.7eefa75.0",
-    "@quenty/servicebag": "6.5.0",
-    "@quenty/table": "3.2.0"
+    "@quenty/baseobject": "^7.0.0",
+    "@quenty/brio": "^9.0.0",
+    "@quenty/grouputils": "^7.0.0",
+    "@quenty/loader": "^7.0.0",
+    "@quenty/maid": "^2.6.0",
+    "@quenty/playerutils": "^3.0.0",
+    "@quenty/promise": "^7.0.0",
+    "@quenty/remoting": "^7.0.0",
+    "@quenty/rx": "^8.0.0",
+    "@quenty/servicebag": "^7.0.0",
+    "@quenty/table": "^3.3.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7eefa756f8bd892b1210349a8133d6d56992dffb"
+  "gitHead": "fdeae46099587019ec5fc15317dc673aed379400"
 }

package/src/Client/PermissionServiceClient.lua

@@ -23,7 +23,22 @@ PermissionServiceClient.ServiceName = "PermissionServiceClient"
 	@param _serviceBag ServiceBag
 ]=]
 function PermissionServiceClient:Init(_serviceBag)
-	self._provider = PermissionProviderClient.new(PermissionProviderConstants.DEFAULT_REMOTE_FUNCTION_NAME)
+	self._providerPromise = Promise.resolved(PermissionProviderClient.new(PermissionProviderConstants.DEFAULT_REMOTE_FUNCTION_NAME))
+end
+
+--[=[
+	Returns whether the player is an admin.
+
+	@param player Player | nil
+	@return Promise<boolean>
+]=]
+function PermissionServiceClient:PromiseIsAdmin(player)
+	assert((typeof(player) == "Instance" and player:IsA("Player")) or player == nil, "Bad player")
+
+	return self:PromisePermissionProvider()
+		:Then(function(permissionProvider)
+			return permissionProvider:PromiseIsAdmin(player)
+		end)
 end
 
 --[=[
@@ -31,7 +46,7 @@ end
 	@return Promise<PermissionProviderClient>
 ]=]
 function PermissionServiceClient:PromisePermissionProvider()
-	return Promise.resolved(self._provider)
+	return self._providerPromise
 end
 
 return PermissionServiceClient

package/src/Client/Providers/PermissionProviderClient.lua

@@ -7,6 +7,8 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local Players = game:GetService("Players")
+
 local PermissionProviderConstants = require("PermissionProviderConstants")
 local Promise = require("Promise")
 local PromiseGetRemoteFunction = require("PromiseGetRemoteFunction")
@@ -25,9 +27,16 @@ end
 
 --[=[
 	Returns whether the local player is an admin.
+
+	@param player Player | nil
 	@return Promise<boolean>
 ]=]
-function PermissionProviderClient:PromiseIsAdmin()
+function PermissionProviderClient:PromiseIsAdmin(player)
+	player = player or Players.LocalPlayer
+	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
+
+	assert(player == Players.LocalPlayer, "We only support local player for now")
+
 	if self._cachedAdminPromise then
 		return self._cachedAdminPromise
 	end

package/src/Server/PermissionService.lua

@@ -26,10 +26,15 @@ local require = require(script.Parent.loader).load(script)
 
 local CreatorPermissionProvider = require("CreatorPermissionProvider")
 local GroupPermissionProvider = require("GroupPermissionProvider")
+local Maid = require("Maid")
+local PermissionLevel = require("PermissionLevel")
 local PermissionProviderConstants = require("PermissionProviderConstants")
 local PermissionProviderUtils = require("PermissionProviderUtils")
 local Promise = require("Promise")
-local Maid = require("Maid")
+local Rx = require("Rx")
+local RxBrioUtils = require("RxBrioUtils")
+local RxPlayerUtils = require("RxPlayerUtils")
+local PermissionLevelUtils = require("PermissionLevelUtils")
 
 local PermissionService = {}
 PermissionService.ServiceName = "PermissionService"
@@ -92,6 +97,69 @@ function PermissionService:PromisePermissionProvider()
 	return self._promise
 end
 
+--[=[
+	Returns whether the player is an admin.
+	@param player Player
+	@return Promise<boolean>
+]=]
+function PermissionService:PromiseIsAdmin(player)
+	assert(typeof(player) == "Instance" and player:IsA("Player"), "bad player")
+
+	return self:PromiseIsPermissionLevel(player, PermissionLevel.ADMIN)
+end
+
+--[=[
+	Returns whether the player is a creator.
+	@param player Player
+	@return Promise<boolean>
+]=]
+function PermissionService:PromiseIsCreator(player)
+	assert(typeof(player) == "Instance" and player:IsA("Player"), "bad player")
+
+	return self:PromiseIsPermissionLevel(player, PermissionLevel.CREATOR)
+end
+
+--[=[
+	Returns whether the player is a creator.
+	@param player Player
+	@param permissionLevel PermissionLevel
+	@return Promise<boolean>
+]=]
+function PermissionService:PromiseIsPermissionLevel(player, permissionLevel)
+	assert(typeof(player) == "Instance" and player:IsA("Player"), "bad player")
+	assert(PermissionLevelUtils.isPermissionLevel(permissionLevel), "Bad permissionLevel")
+
+	return self:PromisePermissionProvider()
+		:Then(function(permissionProvider)
+			return permissionProvider:PromiseIsPermissionLevel(player, permissionLevel)
+		end)
+end
+
+--[=[
+	Observe all creators in the game
+
+	@param permissionLevel PermissionLevel
+	@return Observable<Brio<Player>>
+]=]
+function PermissionService:ObservePermissionedPlayersBrio(permissionLevel)
+	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)
+						if hasPermission then
+							return Rx.of(player)
+						else
+							return Rx.EMPTY
+						end
+					end)
+				})
+		end);
+	})
+end
+
 function PermissionService:Destroy()
 	self._maid:DoCleaning()
 	self._provider = nil

package/src/Server/Providers/BasePermissionProvider.lua

@@ -8,6 +8,8 @@ local require = require(script.Parent.loader).load(script)
 
 local BaseObject = require("BaseObject")
 local GetRemoteFunction = require("GetRemoteFunction")
+local PermissionLevel = require("PermissionLevel")
+local PermissionLevelUtils = require("PermissionLevelUtils")
 local Table = require("Table")
 
 local BasePermissionProvider = setmetatable({}, BaseObject)
@@ -44,14 +46,51 @@ end
 --[=[
 	Returns whether the player is a creator.
 	@param player Player
+	@param permissionLevel PermissionLevel
 	@return Promise<boolean>
 ]=]
-function BasePermissionProvider:PromiseIsCreator(player)
+function BasePermissionProvider:PromiseIsPermissionLevel(player, permissionLevel)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
+	assert(PermissionLevelUtils.isPermissionLevel(permissionLevel), "Bad permissionLevel")
 
 	error("Not implemented")
 end
 
+--[=[
+	Returns whether the player is a creator.
+	@param player Player
+	@param permissionLevel PermissionLevel
+	@return Promise<boolean>
+]=]
+function BasePermissionProvider:IsPermissionLevel(player, permissionLevel)
+	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
+	assert(PermissionLevelUtils.isPermissionLevel(permissionLevel), "Bad permissionLevel")
+
+	local promise = self:PromiseIsPermissionLevel(player, permissionLevel)
+	if promise:IsPending() then
+		return false -- We won't yield for this
+	end
+
+	local ok, result = promise:Yield()
+	if not ok then
+		warn("[BasePermissionProvider] - %s"):format(tostring(result))
+		return false
+	end
+
+	return result
+end
+
+--[=[
+	Returns whether the player is a creator.
+	@param player Player
+	@return Promise<boolean>
+]=]
+function BasePermissionProvider:PromiseIsCreator(player)
+	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
+
+	return self:PromiseIsPermissionLevel(player, PermissionLevel.CREATOR)
+end
+
 --[=[
 	Returns whether the player is an admin.
 	@param player Player
@@ -60,7 +99,7 @@ end
 function BasePermissionProvider:PromiseIsAdmin(player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
-	error("Not implemented")
+	return self:PromiseIsPermissionLevel(player, PermissionLevel.ADMIN)
 end
 
 --[=[
@@ -76,18 +115,7 @@ end
 function BasePermissionProvider:IsCreator(player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
-	local promise = self:PromiseIsCreator(player)
-	if promise:IsPending() then
-		return false -- We won't yield for this
-	end
-
-	local ok, result = promise:Yield()
-	if not ok then
-		warn("[BasePermissionProvider] - %s"):format(tostring(result))
-		return false
-	end
-
-	return result
+	return self:IsCreator(player, PermissionLevel.CREATOR)
 end
 
 --[=[
@@ -103,18 +131,7 @@ end
 function BasePermissionProvider:IsAdmin(player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
-	local promise = self:PromiseIsAdmin(player)
-	if promise:IsPending() then
-		return false -- We won't yield for this
-	end
-
-	local ok, result = promise:Yield()
-	if not ok then
-		warn("[BasePermissionProvider] - %s"):format(tostring(result))
-		return false
-	end
-
-	return result
+	return self:IsPermissionLevel(player, PermissionLevel.ADMIN)
 end
 
 function BasePermissionProvider:_onServerInvoke(player)

package/src/Server/Providers/CreatorPermissionProvider.lua

@@ -12,6 +12,8 @@ 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 CreatorPermissionProvider = setmetatable({}, BasePermissionProvider)
 CreatorPermissionProvider.ClassName = "CreatorPermissionProvider"
@@ -31,23 +33,22 @@ function CreatorPermissionProvider.new(config)
 end
 
 --[=[
-	Returns whether the player is a creator.
-	@param player Player
-	@return Promise<boolean>
-]=]
-function CreatorPermissionProvider:PromiseIsCreator(player)
-	return Promise.resolved(player.UserId == self._userId
-		or RunService:IsStudio())
-end
+	Returns whether the player is at a specific permission level.
 
---[=[
-	Returns whether the player is an admin.
 	@param player Player
+	@param permissionLevel PermissionLevel
 	@return Promise<boolean>
 ]=]
-function CreatorPermissionProvider:PromiseIsAdmin(player)
-	return Promise.resolved(player.UserId == self._userId
-		or RunService:IsStudio())
+function CreatorPermissionProvider:PromiseIsPermissionLevel(player, permissionLevel)
+	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
+		return Promise.resolved(player.UserId == self._userId or RunService:IsStudio())
+	else
+		error("Unknown permissionLevel")
+	end
 end
 
 return CreatorPermissionProvider

package/src/Server/Providers/GroupPermissionProvider.lua

@@ -9,10 +9,12 @@ local require = require(script.Parent.loader).load(script)
 
 local Players = game:GetService("Players")
 
-local PermissionProviderConstants = require("PermissionProviderConstants")
-local Promise = require("Promise")
 local BasePermissionProvider = require("BasePermissionProvider")
 local GroupUtils = require("GroupUtils")
+local PermissionLevel = require("PermissionLevel")
+local PermissionLevelUtils = require("PermissionLevelUtils")
+local PermissionProviderConstants = require("PermissionProviderConstants")
+local Promise = require("Promise")
 
 local GroupPermissionProvider = setmetatable({}, BasePermissionProvider)
 GroupPermissionProvider.__index = GroupPermissionProvider
@@ -68,11 +70,26 @@ function GroupPermissionProvider:Start()
 end
 
 --[=[
-	Returns whether the player is a creator.
+	Returns whether the player is at a specific permission level
+
 	@param player Player
+	@param permissionLevel PermissionLevel
 	@return Promise<boolean>
 ]=]
-function GroupPermissionProvider:PromiseIsCreator(player)
+function GroupPermissionProvider:PromiseIsPermissionLevel(player, permissionLevel)
+	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
+	assert(PermissionLevelUtils.isPermissionLevel(permissionLevel), "Bad permissionLevel")
+
+	if permissionLevel == PermissionLevel.ADMIN then
+		return self:_promiseIsAdmin(player)
+	elseif permissionLevel == PermissionLevel.CREATOR then
+		return self:_promiseIsCreator(player)
+	else
+		error("Unknown permissionLevel")
+	end
+end
+
+function GroupPermissionProvider:_promiseIsCreator(player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 	assert(player:IsDescendantOf(game), "Bad player")
 
@@ -86,12 +103,7 @@ function GroupPermissionProvider:PromiseIsCreator(player)
 		end)
 end
 
---[=[
-	Returns whether the player is an admin.
-	@param player Player
-	@return Promise<boolean>
-]=]
-function GroupPermissionProvider:PromiseIsAdmin(player)
+function GroupPermissionProvider:_promiseIsAdmin(player)
 	assert(player:IsDescendantOf(game))
 
 	-- really not saving much time.

package/src/Shared/PermissionLevel.lua

@@ -0,0 +1,12 @@
+--[=[
+	@class PermissionLevel
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Table = require("Table")
+
+return Table.readonly({
+	ADMIN = "admin";
+	CREATOR = "creator";
+})

package/src/Shared/PermissionLevelUtils.lua

@@ -0,0 +1,20 @@
+--[=[
+	@class PermissionLevelUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local PermissionLevel = require("PermissionLevel")
+
+local PermissionLevelUtils = {}
+
+local ALLOWED = {}
+for _, item in pairs(PermissionLevel) do
+	ALLOWED[item] = true
+end
+
+function PermissionLevelUtils.isPermissionLevel(permissionLevel)
+	return ALLOWED[permissionLevel]
+end
+
+return PermissionLevelUtils