@quenty/avatareditorutils 7.20.3 → 7.20.4-canary.11a5dcf.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [7.20.4-canary.11a5dcf.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/avatareditorutils@7.20.3...@quenty/avatareditorutils@7.20.4-canary.11a5dcf.0) (2025-05-10)
+
+
+### Bug Fixes
+
+* Additional type checking updates ([05ba29a](https://github.com/Quenty/NevermoreEngine/commit/05ba29a03efc9f3feed74b34f1d9dfb237496214))
+
+
+
+
+
 ## [7.20.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/avatareditorutils@7.20.2...@quenty/avatareditorutils@7.20.3) (2025-04-10)
 
 **Note:** Version bump only for package @quenty/avatareditorutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/avatareditorutils",
-  "version": "7.20.3",
+  "version": "7.20.4-canary.11a5dcf.0",
   "description": "Provides utility functions to work with the Roblox AvatarEditorService",
   "keywords": [
     "Roblox",
@@ -25,22 +25,22 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/aggregator": "^1.4.3",
-    "@quenty/brio": "^14.17.3",
-    "@quenty/enumutils": "^3.4.2",
-    "@quenty/loader": "^10.8.3",
-    "@quenty/maid": "^3.4.3",
-    "@quenty/memoize": "^1.6.3",
-    "@quenty/observablecollection": "^12.20.3",
-    "@quenty/pagesutils": "^5.11.4",
-    "@quenty/promise": "^10.10.4",
-    "@quenty/rx": "^13.17.3",
-    "@quenty/servicebag": "^11.11.4",
-    "@quenty/symbol": "^3.4.2",
-    "@quenty/valueobject": "^13.17.3"
+    "@quenty/aggregator": "1.4.4-canary.11a5dcf.0",
+    "@quenty/brio": "14.17.4-canary.11a5dcf.0",
+    "@quenty/enumutils": "3.4.2",
+    "@quenty/loader": "10.8.4-canary.11a5dcf.0",
+    "@quenty/maid": "3.4.4-canary.11a5dcf.0",
+    "@quenty/memoize": "1.6.4-canary.11a5dcf.0",
+    "@quenty/observablecollection": "12.20.4-canary.11a5dcf.0",
+    "@quenty/pagesutils": "5.11.5-canary.11a5dcf.0",
+    "@quenty/promise": "10.10.5-canary.11a5dcf.0",
+    "@quenty/rx": "13.17.4-canary.11a5dcf.0",
+    "@quenty/servicebag": "11.11.5-canary.11a5dcf.0",
+    "@quenty/symbol": "3.4.3-canary.11a5dcf.0",
+    "@quenty/valueobject": "13.17.4-canary.11a5dcf.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
+  "gitHead": "11a5dcf7d4c7a0bfbf3337e97d30e8346ea09d3f"
 }

package/src/Client/AvatarEditorInventory.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class AvatarEditorInventory
 ]=]
@@ -5,26 +6,49 @@
 local require = require(script.Parent.loader).load(script)
 
 local BaseObject = require("BaseObject")
+local Observable = require("Observable")
 local ObservableMap = require("ObservableMap")
-local Rx = require("Rx")
 local PagesUtils = require("PagesUtils")
 local Promise = require("Promise")
+local Rx = require("Rx")
 
 local AvatarEditorInventory = setmetatable({}, BaseObject)
 AvatarEditorInventory.ClassName = "AvatarEditorInventory"
 AvatarEditorInventory.__index = AvatarEditorInventory
 
-function AvatarEditorInventory.new()
-	local self = setmetatable(BaseObject.new(), AvatarEditorInventory)
+export type AssetData = unknown
+
+export type AvatarEditorInventory = typeof(setmetatable(
+	{} :: {
+		_assetIdToAsset: ObservableMap.ObservableMap<number, AssetData>,
+	},
+	{} :: typeof({ __index = AvatarEditorInventory })
+)) & BaseObject.BaseObject
+
+--[=[
+	Constructs a new AvatarEditorInventory
+
+	@return AvatarEditorInventory
+]=]
+function AvatarEditorInventory.new(): AvatarEditorInventory
+	local self: AvatarEditorInventory = setmetatable(BaseObject.new() :: any, AvatarEditorInventory)
 
 	self._assetIdToAsset = self._maid:Add(ObservableMap.new())
 
 	return self
 end
 
-function AvatarEditorInventory:PromiseProcessPages(inventoryPages: Pages)
+--[=[
+	Processes the pages and stores the asset data in the inventory.
+	@param inventoryPages Pages
+	@return Promise.Promise<()>
+]=]
+function AvatarEditorInventory.PromiseProcessPages(
+	self: AvatarEditorInventory,
+	inventoryPages: Pages
+): Promise.Promise<()>
 	return Promise.spawn(function(resolve, reject)
-		local pageData = inventoryPages:GetCurrentPage()
+		local pageData: any = inventoryPages:GetCurrentPage()
 		while pageData do
 			for _, data in pageData do
 				self._assetIdToAsset:Set(data.AssetId, data)
@@ -46,18 +70,31 @@ function AvatarEditorInventory:PromiseProcessPages(inventoryPages: Pages)
 	end)
 end
 
-function AvatarEditorInventory:IsAssetIdInInventory(assetId: number): boolean
+--[=[
+	Returns the asset data for the given assetId.
+	@param assetId number
+	@return boolean
+]=]
+function AvatarEditorInventory.IsAssetIdInInventory(self: AvatarEditorInventory, assetId: number): boolean
 	return self._assetIdToAsset:Get(assetId) ~= nil
 end
 
-function AvatarEditorInventory:ObserveAssetIdInInventory(assetId: number)
+--[=[
+	Observes the assetId in the inventory. Returns true if it is in the inventory.
+	@param assetId number
+	@return Observable<AssetData>
+]=]
+function AvatarEditorInventory.ObserveAssetIdInInventory(
+	self: AvatarEditorInventory,
+	assetId: number
+): Observable.Observable<AssetData>
 	assert(type(assetId) == "number", "Bad assetId")
 
 	return self._assetIdToAsset:ObserveAtKey(assetId):Pipe({
 		Rx.map(function(data)
 			return data ~= nil
-		end)
-	})
+		end) :: any,
+	}) :: any
 end
 
-return AvatarEditorInventory
+return AvatarEditorInventory

package/src/Client/AvatarEditorInventoryServiceClient.lua

@@ -11,15 +11,15 @@ local AvatarEditorUtils = require("AvatarEditorUtils")
 local EnumUtils = require("EnumUtils")
 local Maid = require("Maid")
 local MemorizeUtils = require("MemorizeUtils")
+local PagesProxy = require("PagesProxy")
 local Promise = require("Promise")
+local ServiceBag = require("ServiceBag")
 local ValueObject = require("ValueObject")
-local PagesProxy = require("PagesProxy")
-local _ServiceBag = require("ServiceBag")
 
 local AvatarEditorInventoryServiceClient = {}
 AvatarEditorInventoryServiceClient.ServiceName = "AvatarEditorInventoryServiceClient"
 
-function AvatarEditorInventoryServiceClient:Init(serviceBag: _ServiceBag.ServiceBag)
+function AvatarEditorInventoryServiceClient:Init(serviceBag: ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
@@ -34,15 +34,14 @@ function AvatarEditorInventoryServiceClient:Init(serviceBag: _ServiceBag.Service
 	end))
 
 	self._promiseInventoryPages = MemorizeUtils.memoize(function(avatarAssetTypes)
-		return AvatarEditorUtils.promiseInventoryPages(avatarAssetTypes)
-			:Then(function(catalogPages)
-				-- Allow for replay
-				return PagesProxy.new(catalogPages)
-			end)
+		return AvatarEditorUtils.promiseInventoryPages(avatarAssetTypes):Then(function(catalogPages)
+			-- Allow for replay
+			return PagesProxy.new(catalogPages)
+		end)
 	end)
 end
 
-function AvatarEditorInventoryServiceClient:PromiseInventoryPages(avatarAssetTypes)
+function AvatarEditorInventoryServiceClient:PromiseInventoryPages(avatarAssetTypes: Enum.AvatarAssetType)
 	return self:PromiseEnsureAccess()
 		:Then(function()
 			return self._promiseInventoryPages(avatarAssetTypes)
@@ -52,7 +51,7 @@ function AvatarEditorInventoryServiceClient:PromiseInventoryPages(avatarAssetTyp
 		end)
 end
 
-function AvatarEditorInventoryServiceClient:PromiseInventoryForAvatarAssetType(avatarAssetType)
+function AvatarEditorInventoryServiceClient:PromiseInventoryForAvatarAssetType(avatarAssetType: Enum.AvatarAssetType)
 	assert(EnumUtils.isOfType(Enum.AvatarAssetType, avatarAssetType), "Bad avatarAssetType")
 
 	if self._assetTypeToInventoryPromises[avatarAssetType] then
@@ -62,7 +61,7 @@ function AvatarEditorInventoryServiceClient:PromiseInventoryForAvatarAssetType(a
 	local inventory = self._maid:Add(AvatarEditorInventory.new())
 
 	self._assetTypeToInventoryPromises[avatarAssetType] = AvatarEditorUtils.promiseInventoryPages({
-		avatarAssetType
+		avatarAssetType,
 	})
 		:Then(function(inventoryPages)
 			return inventory:PromiseProcessPages(inventoryPages)
@@ -74,7 +73,7 @@ function AvatarEditorInventoryServiceClient:PromiseInventoryForAvatarAssetType(a
 	return self._assetTypeToInventoryPromises[avatarAssetType]
 end
 
-function AvatarEditorInventoryServiceClient:IsInventoryAccessAllowed()
+function AvatarEditorInventoryServiceClient:IsInventoryAccessAllowed(): boolean
 	return self._isAccessAllowed.Value
 end
 
@@ -82,7 +81,7 @@ function AvatarEditorInventoryServiceClient:ObserveIsInventoryAccessAllowed()
 	return self._isAccessAllowed:Observe()
 end
 
-function AvatarEditorInventoryServiceClient:PromiseEnsureAccess()
+function AvatarEditorInventoryServiceClient:PromiseEnsureAccess(): Promise.Promise<()>
 	if self._isAccessAllowed.Value then
 		return Promise.resolved()
 	end
@@ -108,4 +107,4 @@ function AvatarEditorInventoryServiceClient:Destroy()
 	self._maid:DoCleaning()
 end
 
-return AvatarEditorInventoryServiceClient
+return AvatarEditorInventoryServiceClient

package/src/Shared/AvatarEditorUtils.lua

@@ -184,7 +184,9 @@ end
 	@param humanoidDescription HumanoidDescription
 	@return Promise<HumanoidDescription?>
 ]=]
-function AvatarEditorUtils.promiseCheckApplyDefaultClothing(humanoidDescription: HumanoidDescription): Promise.Promise<HumanoidDescription?>
+function AvatarEditorUtils.promiseCheckApplyDefaultClothing(
+	humanoidDescription: HumanoidDescription
+): Promise.Promise<HumanoidDescription?>
 	assert(
 		typeof(humanoidDescription) == "Instance" and humanoidDescription:IsA("HumanoidDescription"),
 		"Bad humanoidDescription"
@@ -526,7 +528,7 @@ end
 
 	@return Promise<AvatarPromptResult>
 ]=]
-function AvatarEditorUtils.promptAllowInventoryReadAccess()
+function AvatarEditorUtils.promptAllowInventoryReadAccess(): Promise.Promise<()>
 	local maid = Maid.new()
 
 	local promise = Promise.new()
@@ -763,7 +765,11 @@ end
 	@param rigType HumanoidRigType
 	@return Promise<AvatarPromptResult>
 ]=]
-function AvatarEditorUtils.promptUpdateOutfit(outfitId: number, updatedOutfit: HumanoidDescription, rigType: Enum.HumanoidRigType)
+function AvatarEditorUtils.promptUpdateOutfit(
+	outfitId: number,
+	updatedOutfit: HumanoidDescription,
+	rigType: Enum.HumanoidRigType
+)
 	assert(type(outfitId) == "number", "Bad outfitId")
 	assert(typeof(updatedOutfit) == "Instance" and updatedOutfit:IsA("HumanoidDescription"), "Bad updatedOutfit")
 	assert(EnumUtils.isOfType(Enum.HumanoidRigType, rigType), "Bad rigType")
@@ -776,13 +782,15 @@ function AvatarEditorUtils.promptUpdateOutfit(outfitId: number, updatedOutfit: H
 		maid:DoCleaning()
 	end)
 
-	maid:GiveTask(AvatarEditorService.PromptUpdateOutfitCompleted:Connect(function(avatarPromptResult: Enum.AvatarPromptResult)
-		if avatarPromptResult == Enum.AvatarPromptResult.Success then
-			promise:Resolve(avatarPromptResult)
-		else
-			promise:Reject(avatarPromptResult)
-		end
-	end))
+	maid:GiveTask(
+		AvatarEditorService.PromptUpdateOutfitCompleted:Connect(function(avatarPromptResult: Enum.AvatarPromptResult)
+			if avatarPromptResult == Enum.AvatarPromptResult.Success then
+				promise:Resolve(avatarPromptResult)
+			else
+				promise:Reject(avatarPromptResult)
+			end
+		end)
+	)
 
 	local ok, err = pcall(function()
 		AvatarEditorService:PromptUpdateOutfit(outfitId, updatedOutfit, rigType)
@@ -795,4 +803,4 @@ function AvatarEditorUtils.promptUpdateOutfit(outfitId: number, updatedOutfit: H
 	return promise
 end
 
-return AvatarEditorUtils
+return AvatarEditorUtils

package/src/Shared/Cache/CatalogSearchServiceCache.lua

@@ -4,27 +4,26 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local MemorizeUtils = require("MemorizeUtils")
-local AvatarEditorUtils = require("AvatarEditorUtils")
 local Aggregator = require("Aggregator")
+local AvatarEditorUtils = require("AvatarEditorUtils")
 local Maid = require("Maid")
+local MemorizeUtils = require("MemorizeUtils")
 local PagesProxy = require("PagesProxy")
-local _ServiceBag = require("ServiceBag")
+local ServiceBag = require("ServiceBag")
 
 local CatalogSearchServiceCache = {}
 CatalogSearchServiceCache.ServiceName = "CatalogSearchServiceCache"
 
-function CatalogSearchServiceCache:Init(serviceBag: _ServiceBag.ServiceBag)
+function CatalogSearchServiceCache:Init(serviceBag: ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
 
 	-- TODO: If you scroll down long enough this leaks memory
 	self._promiseSearchCatalog = MemorizeUtils.memoize(function(params)
-		return AvatarEditorUtils.promiseSearchCatalog(params)
-			:Then(function(catalogPages)
-				return PagesProxy.new(catalogPages)
-			end)
+		return AvatarEditorUtils.promiseSearchCatalog(params):Then(function(catalogPages)
+			return PagesProxy.new(catalogPages)
+		end)
 	end)
 
 	self._assetAggregator = self._maid:Add(Aggregator.new("AvatarEditorUtils.promiseBatchItemDetails", function(itemIds)
@@ -32,9 +31,10 @@ function CatalogSearchServiceCache:Init(serviceBag: _ServiceBag.ServiceBag)
 	end))
 	self._assetAggregator:SetMaxBatchSize(100)
 
-	self._bundleAggregator = self._maid:Add(Aggregator.new("AvatarEditorUtils.promiseBatchItemDetails", function(itemIds)
-		return AvatarEditorUtils.promiseBatchItemDetails(itemIds, Enum.AvatarItemType.Bundle)
-	end))
+	self._bundleAggregator =
+		self._maid:Add(Aggregator.new("AvatarEditorUtils.promiseBatchItemDetails", function(itemIds)
+			return AvatarEditorUtils.promiseBatchItemDetails(itemIds, Enum.AvatarItemType.Bundle)
+		end))
 	self._bundleAggregator:SetMaxBatchSize(100)
 end
 
@@ -58,14 +58,13 @@ function CatalogSearchServiceCache:PromiseItemDetails(assetId, avatarItemType)
 end
 
 function CatalogSearchServiceCache:PromiseSearchCatalog(params)
-	return self._promiseSearchCatalog(params)
-		:Then(function(pagesProxy)
-			return pagesProxy:Clone()
-		end)
+	return self._promiseSearchCatalog(params):Then(function(pagesProxy)
+		return pagesProxy:Clone()
+	end)
 end
 
 function CatalogSearchServiceCache:Destroy()
 	self._maid:DoCleaning()
 end
 
-return CatalogSearchServiceCache
+return CatalogSearchServiceCache