@quenty/gameconfig 12.24.0 → 12.24.2-canary.547.11ae689.0

package/src/Shared/Config/Asset/GameConfigAssetBase.lua

@@ -1,50 +1,67 @@
+--!strict
 --[=[
 	@class GameConfigAssetBase
 ]=]
 
 local require = require(script.Parent.loader).load(script)
 
+local AttributeValue = require("AttributeValue")
 local BaseObject = require("BaseObject")
-local Rx = require("Rx")
-local RxAttributeUtils = require("RxAttributeUtils")
-local RxInstanceUtils = require("RxInstanceUtils")
 local GameConfigAssetConstants = require("GameConfigAssetConstants")
-local Promise = require("Promise")
 local GameConfigAssetUtils = require("GameConfigAssetUtils")
-local AttributeValue = require("AttributeValue")
 local GameConfigTranslator = require("GameConfigTranslator")
+local Promise = require("Promise")
+local Rx = require("Rx")
+local RxAttributeUtils = require("RxAttributeUtils")
+local RxInstanceUtils = require("RxInstanceUtils")
+local _CancelToken = require("CancelToken")
+local _JSONTranslator = require("JSONTranslator")
+local _Observable = require("Observable")
+local _ServiceBag = require("ServiceBag")
+local _GameConfigAssetTypes = require("GameConfigAssetTypes")
 
 local GameConfigAssetBase = setmetatable({}, BaseObject)
 GameConfigAssetBase.ClassName = "GameConfigAssetBase"
 GameConfigAssetBase.__index = GameConfigAssetBase
 
+export type GameConfigAssetBase = typeof(setmetatable(
+	{} :: {
+		_obj: Folder,
+		_serviceBag: _ServiceBag.ServiceBag,
+		_nameTranslationKey: AttributeValue.AttributeValue<string>,
+		_descriptionTranslationKey: AttributeValue.AttributeValue<string>,
+		_configTranslator: _JSONTranslator.JSONTranslator,
+	},
+	{ __index = GameConfigAssetBase}
+))
+
 --[=[
 	Constructs a new GameConfigAssetBase. Should be done via binder. This is a base class.
 	@param obj Folder
 	@param serviceBag ServiceBag
 	@return GameConfigAssetBase
 ]=]
-function GameConfigAssetBase.new(obj, serviceBag)
-	local self = setmetatable(BaseObject.new(obj), GameConfigAssetBase)
+function GameConfigAssetBase.new(obj: Folder, serviceBag: _ServiceBag.ServiceBag): GameConfigAssetBase
+	local self: GameConfigAssetBase = setmetatable(BaseObject.new(obj) :: any, GameConfigAssetBase)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._nameTranslationKey = AttributeValue.new(self._obj, "NameTranslationKey", "assets.name.unknown")
-	self._descriptionTranslationKey = AttributeValue.new(self._obj, "DescriptionTranslationKey", "assets.description.unknown")
+	self._descriptionTranslationKey =
+		AttributeValue.new(self._obj, "DescriptionTranslationKey", "assets.description.unknown")
 	self._configTranslator = self._serviceBag:GetService(GameConfigTranslator)
 
 	return self
 end
 
-
 --[=[
 	Observes the translated name
 	@return Observable<string>
 ]=]
-function GameConfigAssetBase:ObserveTranslatedName()
+function GameConfigAssetBase:ObserveTranslatedName(): _Observable.Observable<string>
 	return self:ObserveNameTranslationKey():Pipe({
 		Rx.switchMap(function(key)
 			return self._configTranslator:ObserveFormatByKey(key)
-		end)
+		end),
 	})
 end
 
@@ -52,22 +69,33 @@ end
 	Observes the translated description
 	@return Observable<string>
 ]=]
-function GameConfigAssetBase:ObserveTranslatedDescription()
+function GameConfigAssetBase:ObserveTranslatedDescription(): _Observable.Observable<string>
 	return self:ObserveDescriptionTranslationKey():Pipe({
 		Rx.switchMap(function(key)
 			return self._configTranslator:ObserveFormatByKey(key)
-		end)
+		end),
 	})
 end
 
-function GameConfigAssetBase:SetNameTranslationKey(nameTranslationKey)
+--[=[
+	Sets the name translation key
+	@param nameTranslationKey string?
+]=]
+function GameConfigAssetBase:SetNameTranslationKey(nameTranslationKey: string?)
 	assert(type(nameTranslationKey) == "string" or nameTranslationKey == nil, "Bad nameTranslationKey")
 
 	self._nameTranslationKey.Value = nameTranslationKey or "assets.name.unknown"
 end
 
-function GameConfigAssetBase:SetDescriptionTranslationKey(descriptionTranslationKey)
-	assert(type(descriptionTranslationKey) == "string" or descriptionTranslationKey == nil, "Bad descriptionTranslationKey")
+--[=[
+	Sets the description translation key
+	@param descriptionTranslationKey string?
+]=]
+function GameConfigAssetBase:SetDescriptionTranslationKey(descriptionTranslationKey: string?)
+	assert(
+		type(descriptionTranslationKey) == "string" or descriptionTranslationKey == nil,
+		"Bad descriptionTranslationKey"
+	)
 
 	self._descriptionTranslationKey.Value = descriptionTranslationKey or "assets.description.unknown"
 end
@@ -76,7 +104,7 @@ end
 	Gets the asset id
 	@return number
 ]=]
-function GameConfigAssetBase:GetAssetId()
+function GameConfigAssetBase:GetAssetId(): number
 	return self._obj:GetAttribute(GameConfigAssetConstants.ASSET_ID_ATTRIBUTE)
 end
 
@@ -84,7 +112,7 @@ end
 	Observes the assetId
 	@return Observable<number>
 ]=]
-function GameConfigAssetBase:ObserveAssetId()
+function GameConfigAssetBase:ObserveAssetId(): _Observable.Observable<number>
 	return RxAttributeUtils.observeAttribute(self._obj, GameConfigAssetConstants.ASSET_ID_ATTRIBUTE, nil)
 end
 
@@ -92,7 +120,7 @@ end
 	Gets the asset type
 	@return string?
 ]=]
-function GameConfigAssetBase:GetAssetType()
+function GameConfigAssetBase:GetAssetType(): string?
 	return self._obj:GetAttribute(GameConfigAssetConstants.ASSET_TYPE_ATTRIBUTE)
 end
 
@@ -100,7 +128,7 @@ end
 	Observes the asset type
 	@return Observable<string?>
 ]=]
-function GameConfigAssetBase:ObserveAssetType()
+function GameConfigAssetBase:ObserveAssetType(): _Observable.Observable<string?>
 	return RxAttributeUtils.observeAttribute(self._obj, GameConfigAssetConstants.ASSET_TYPE_ATTRIBUTE, nil)
 end
 
@@ -108,7 +136,7 @@ end
 	Observes the asset key
 	@return Observable<string>
 ]=]
-function GameConfigAssetBase:ObserveAssetKey()
+function GameConfigAssetBase:ObserveAssetKey(): _Observable.Observable<string>
 	return RxInstanceUtils.observeProperty(self._obj, "Name")
 end
 
@@ -116,28 +144,34 @@ end
 	Gets the asset key
 	@return string
 ]=]
-function GameConfigAssetBase:GetAssetKey()
+function GameConfigAssetBase:GetAssetKey(): string
 	return self._obj.Name
 end
 
+export type GameConfigAssetState = {
+	assetId: number,
+	assetKey: string,
+	assetType: _GameConfigAssetTypes.GameConfigAssetType,
+}
+
 --[=[
 	Observes the asset state
 	@return any
 ]=]
-function GameConfigAssetBase:ObserveState()
+function GameConfigAssetBase:ObserveState(): _Observable.Observable<GameConfigAssetState>
 	return Rx.combineLatest({
-		assetId = self:ObserveAssetId();
-		assetKey = self:ObserveAssetKey();
-		assetType = self:ObserveAssetType();
-	})
+		assetId = self:ObserveAssetId(),
+		assetKey = self:ObserveAssetKey(),
+		assetType = self:ObserveAssetType(),
+	}) :: any
 end
 
 --[=[
 	Promises the cloud price in Robux
 	@param cancelToken CancelToken
-	@return Promise<string?>
+	@return Promise<number?>
 ]=]
-function GameConfigAssetBase:PromiseCloudPriceInRobux(cancelToken)
+function GameConfigAssetBase:PromiseCloudPriceInRobux(cancelToken: _CancelToken.CancelToken): Promise.Promise<number>
 	return Rx.toPromise(self:ObserveCloudPriceInRobux(), cancelToken)
 end
 
@@ -146,7 +180,7 @@ end
 	@param cancelToken CancelToken
 	@return Promise<string?>
 ]=]
-function GameConfigAssetBase:PromiseCloudName(cancelToken)
+function GameConfigAssetBase:PromiseCloudName(cancelToken: _CancelToken.CancelToken): Promise.Promise<string>
 	return Rx.toPromise(self:ObserveCloudName(), cancelToken)
 end
 --[=[
@@ -154,7 +188,7 @@ end
 	@param _cancelToken CancelToken
 	@return Promise<Color3>
 ]=]
-function GameConfigAssetBase:PromiseColor(_cancelToken)
+function GameConfigAssetBase:PromiseColor(_cancelToken: _CancelToken.CancelToken): Promise.Promise<Color3>
 	return Promise.resolved(Color3.fromRGB(66, 158, 166))
 end
 
@@ -163,7 +197,7 @@ end
 	@param cancelToken CancelToken
 	@return Promise<string?>
 ]=]
-function GameConfigAssetBase:PromiseNameTranslationKey(cancelToken)
+function GameConfigAssetBase:PromiseNameTranslationKey(cancelToken: _CancelToken.CancelToken): Promise.Promise<string>
 	return Rx.toPromise(self:ObserveNameTranslationKey(), cancelToken)
 end
 
@@ -171,7 +205,7 @@ end
 	Observes the name translation key.
 	@return Observable<string?>
 ]=]
-function GameConfigAssetBase:ObserveNameTranslationKey()
+function GameConfigAssetBase:ObserveNameTranslationKey(): _Observable.Observable<string?>
 	return self._nameTranslationKey:Observe()
 end
 
@@ -179,7 +213,7 @@ end
 	Observes the description translation key.
 	@return Observable<string?>
 ]=]
-function GameConfigAssetBase:ObserveDescriptionTranslationKey()
+function GameConfigAssetBase:ObserveDescriptionTranslationKey(): _Observable.Observable<string?>
 	return self._descriptionTranslationKey:Observe()
 end
 
@@ -188,7 +222,7 @@ end
 	translation keys.
 	@return Observable<string?>
 ]=]
-function GameConfigAssetBase:ObserveCloudName()
+function GameConfigAssetBase:ObserveCloudName(): _Observable.Observable<string?>
 	return self:_observeCloudProperty({ "Name" }, "string")
 end
 
@@ -197,7 +231,7 @@ end
 	translation keys.
 	@return Observable<string?>
 ]=]
-function GameConfigAssetBase:ObserveCloudDescription()
+function GameConfigAssetBase:ObserveCloudDescription(): _Observable.Observable<string?>
 	return self:_observeCloudProperty({ "Description" }, "string")
 end
 
@@ -205,25 +239,28 @@ end
 	Observes the cost in Robux.
 	@return Observable<number?>
 ]=]
-function GameConfigAssetBase:ObserveCloudPriceInRobux()
+function GameConfigAssetBase:ObserveCloudPriceInRobux(): _Observable.Observable<number?>
 	return self:_observeCloudProperty({ "PriceInRobux" }, "number")
 end
 
 --[=[
 	@return Observable<number?>
 ]=]
-function GameConfigAssetBase:ObserveCloudIconImageAssetId()
+function GameConfigAssetBase:ObserveCloudIconImageAssetId(): _Observable.Observable<number?>
 	return self:_observeCloudProperty({ "IconImageAssetId", "IconImageId" }, "number")
 end
 
-function GameConfigAssetBase:_observeCloudProperty(propertyNameList, expectedType)
+function GameConfigAssetBase:_observeCloudProperty(
+	propertyNameList: { string },
+	expectedType: string
+): _Observable.Observable<any?>
 	assert(type(propertyNameList) == "table", "Bad propertyNameList")
 	assert(type(expectedType) == "string", "Bad expectedType")
 
 	return self:_observeCloudDataFromState():Pipe({
 		Rx.map(function(data)
 			if type(data) == "table" then
-				for _, propertyName in pairs(propertyNameList) do
+				for _, propertyName in propertyNameList do
 					local result = data[propertyName]
 					if type(result) == expectedType then
 						return result
@@ -234,31 +271,35 @@ function GameConfigAssetBase:_observeCloudProperty(propertyNameList, expectedTyp
 			else
 				return nil
 			end
-		end)
+		end),
 	})
 end
 
-function GameConfigAssetBase:_observeCloudDataFromState()
+function GameConfigAssetBase:_observeCloudDataFromState(): _Observable.Observable<any?>
 	if self._cloudDataObservable then
 		return self._cloudDataObservable
 	end
 
 	self._cloudDataObservable = self:ObserveState():Pipe({
-		Rx.switchMap(function(state)
-			if type(state.assetId) == "number" and type(state.assetType) == "string" and type(state.assetKey) == "string" then
+		Rx.switchMap(function(state): any
+			if
+				type(state.assetId) == "number"
+				and type(state.assetType) == "string"
+				and type(state.assetKey) == "string"
+			then
 				return Rx.fromPromise(self:_promiseCloudDataForState(state))
 			else
 				return Rx.of(nil)
 			end
-		end);
-		Rx.distinct();
-		Rx.shareReplay(1);
+		end),
+		Rx.distinct() :: any,
+		Rx.shareReplay(1) :: any,
 	})
 
 	return self._cloudDataObservable
 end
 
-function GameConfigAssetBase:_promiseCloudDataForState(state)
+function GameConfigAssetBase:_promiseCloudDataForState(state: GameConfigAssetState): Promise.Promise<any?>
 	return GameConfigAssetUtils.promiseCloudDataForAssetType(self._serviceBag, state.assetType, state.assetId)
 end
 

package/src/Shared/Config/Asset/GameConfigAssetUtils.lua

@@ -10,6 +10,7 @@ local BadgeUtils = require("BadgeUtils")
 local GameConfigAssetTypes = require("GameConfigAssetTypes")
 local MarketplaceServiceCache = require("MarketplaceServiceCache")
 local Promise = require("Promise")
+local _ServiceBag = require("ServiceBag")
 
 local GameConfigAssetUtils = {}
 
@@ -21,7 +22,12 @@ local GameConfigAssetUtils = {}
 	@param assetId number
 	@return Instance
 ]=]
-function GameConfigAssetUtils.create(binder, assetType, assetKey, assetId)
+function GameConfigAssetUtils.create(
+	binder,
+	assetType: GameConfigAssetTypes.GameConfigAssetType,
+	assetKey: string,
+	assetId: number
+): Folder
 	local asset = Instance.new("Folder")
 	asset.Name = assetKey
 
@@ -41,7 +47,7 @@ end
 	@param assetId number
 	@return Promise<any>
 ]=]
-function GameConfigAssetUtils.promiseCloudDataForAssetType(serviceBag, assetType, assetId)
+function GameConfigAssetUtils.promiseCloudDataForAssetType(serviceBag: _ServiceBag.ServiceBag, assetType: GameConfigAssetTypes.GameConfigAssetType, assetId: number): Promise.Promise<any>
 	assert(type(assetType) == "string", "Bad assetType")
 	assert(type(assetId) == "number", "Bad assetId")
 

package/src/Shared/Config/AssetTypes/GameConfigAssetTypeUtils.lua

@@ -19,7 +19,7 @@ local pluralMap = {
 	[GameConfigAssetTypes.MEMBERSHIP] = "memberships";
 }
 
-for _, item in pairs(GameConfigAssetTypes) do
+for _, item in GameConfigAssetTypes do
 	assert(pluralMap[item], "Missing plural")
 end
 

package/src/Shared/Config/AssetTypes/GameConfigAssetTypes.lua

@@ -6,63 +6,84 @@ local require = require(script.Parent.loader).load(script)
 
 local Table = require("Table")
 
+export type GameConfigAssetType =
+	"badge"
+	| "product"
+	| "pass"
+	| "asset"
+	| "bundle"
+	| "place"
+	| "subscription"
+	| "membership"
+
+export type GameConfigAssetTypes = {
+	BADGE: "badge",
+	PRODUCT: "product",
+	PASS: "pass",
+	ASSET: "asset",
+	BUNDLE: "bundle",
+	PLACE: "place",
+	SUBSCRIPTION: "subscription",
+	MEMBERSHIP: "membership",
+}
+
 return Table.readonly({
---[=[
+	--[=[
 	Specifies the asset is of type badge
 	@prop BADGE string
 	@within GameConfigAssetTypes
 ]=]
-	BADGE = "badge";
+	BADGE = "badge",
 
---[=[
+	--[=[
 	Specifies the asset is of type product
 	@prop PRODUCT string
 	@within GameConfigAssetTypes
 ]=]
-	PRODUCT = "product";
+	PRODUCT = "product",
 
---[=[
+	--[=[
 	Specifies the asset is of type pass
 	@prop PASS string
 	@within GameConfigAssetTypes
 ]=]
-	PASS = "pass";
+	PASS = "pass",
 
---[=[
+	--[=[
 	Specifies the asset is of type asset. This is basically anything in Roblox's asset id system.
 	Think models, UGC, et cetera.
 
 	@prop ASSET string
 	@within GameConfigAssetTypes
 ]=]
-	ASSET = "asset";
+	ASSET = "asset",
 
---[=[
+	--[=[
 	Bundle asset type
 
 	@prop BUNDLE string
 	@within GameConfigAssetTypes
 ]=]
-	BUNDLE = "bundle";
+	BUNDLE = "bundle",
 
---[=[
+	--[=[
 	Specifies the asset is of type place
 	@prop PLACE string
 	@within GameConfigAssetTypes
 ]=]
-	PLACE = "place";
+	PLACE = "place",
 
---[=[
+	--[=[
 	Specifies the asset is of type subscription
 	@prop SUBSCRIPTION string
 	@within GameConfigAssetTypes
 ]=]
-	SUBSCRIPTION = "subscription";
+	SUBSCRIPTION = "subscription",
 
---[=[
+	--[=[
 	Specifies the asset is of type membership (Roblox Premium)
 	@prop MEMBERSHIP string
 	@within GameConfigAssetTypes
 ]=]
-	MEMBERSHIP = "membership";
-})
+	MEMBERSHIP = "membership",
+} :: GameConfigAssetTypes)