@quenty/templateprovider 4.0.0-canary.236.5597d0a.0 → 4.1.0

package/CHANGELOG.md

@@ -3,7 +3,66 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [4.0.0-canary.236.5597d0a.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/templateprovider@3.4.0...@quenty/templateprovider@4.0.0-canary.236.5597d0a.0) (2021-12-18)
+# [4.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/templateprovider@4.0.0...@quenty/templateprovider@4.1.0) (2022-03-10)
+
+
+### Bug Fixes
+
+* Make ModuleProvider work with loader ([97361ba](https://github.com/Quenty/NevermoreEngine/commit/97361ba14b02f4a911846147980d3099a028ddc4))
+
+
+
+
+
+# [4.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/templateprovider@3.8.0...@quenty/templateprovider@4.0.0) (2022-03-06)
+
+**Note:** Version bump only for package @quenty/templateprovider
+
+
+
+
+
+# [3.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/templateprovider@3.7.1...@quenty/templateprovider@3.8.0) (2022-01-17)
+
+**Note:** Version bump only for package @quenty/templateprovider
+
+
+
+
+
+## [3.7.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/templateprovider@3.7.0...@quenty/templateprovider@3.7.1) (2022-01-16)
+
+**Note:** Version bump only for package @quenty/templateprovider
+
+
+
+
+
+# [3.7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/templateprovider@3.6.0...@quenty/templateprovider@3.7.0) (2022-01-07)
+
+**Note:** Version bump only for package @quenty/templateprovider
+
+
+
+
+
+# [3.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/templateprovider@3.5.1...@quenty/templateprovider@3.6.0) (2022-01-03)
+
+**Note:** Version bump only for package @quenty/templateprovider
+
+
+
+
+
+## [3.5.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/templateprovider@3.5.0...@quenty/templateprovider@3.5.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/templateprovider
+
+
+
+
+
+# [3.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/templateprovider@3.4.0...@quenty/templateprovider@3.5.0) (2021-12-18)
 
 **Note:** Version bump only for package @quenty/templateprovider
 

package/README.md

@@ -1,10 +1,10 @@
 ## TemplateProvider
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
   </a>
   <a href="https://discord.gg/mhtGUS8">
-    <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
   </a>
   <a href="https://github.com/Quenty/NevermoreEngine/actions">
     <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
@@ -13,6 +13,8 @@
 
 Base of a template retrieval system
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/TemplateProvider">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/templateprovider --save

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/templateprovider",
-  "version": "4.0.0-canary.236.5597d0a.0",
+  "version": "4.1.0",
   "description": "Base of a template retrieval system",
   "keywords": [
     "Roblox",
@@ -25,15 +25,15 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "3.2.0",
-    "@quenty/insertserviceutils": "4.0.0-canary.236.5597d0a.0",
-    "@quenty/loader": "3.1.1",
-    "@quenty/maid": "2.0.1",
-    "@quenty/promise": "4.0.0-canary.236.5597d0a.0",
-    "@quenty/string": "2.2.0"
+    "@quenty/baseobject": "^4.1.0",
+    "@quenty/insertserviceutils": "^4.1.0",
+    "@quenty/loader": "^4.0.0",
+    "@quenty/maid": "^2.2.0",
+    "@quenty/promise": "^4.1.0",
+    "@quenty/string": "^2.2.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5597d0abdadd88f369f1401a558a8d6d1a1c5aab"
+  "gitHead": "0797de955876b050fb24875de0423453e268b2ce"
 }

package/src/Shared/ModuleProvider.lua

@@ -1,5 +1,7 @@
---- Creates a service that provides modules from a parent module, either by name, or by list!
--- @classmod ModuleProvider
+--[=[
+	Creates a service that provides modules from a parent module, either by name, or by list!
+	@class ModuleProvider
+]=]
 
 local ModuleProvider = {}
 ModuleProvider.ClassName = "ModuleProvider"
@@ -73,6 +75,13 @@ function ModuleProvider:_addToRegistery(moduleScript)
 			:format(moduleScript.Name))
 	end
 
+	if not moduleScript.Parent:FindFirstChild("loader") then
+		local fakeLoader = script.Parent.ModuleProviderFakeLoader:Clone()
+		fakeLoader.Name = "loader"
+		fakeLoader.Archivable = false
+		fakeLoader.Parent = moduleScript.Parent
+	end
+
 	local _module
 	xpcall(function()
 		_module = require(moduleScript)

package/src/Shared/ModuleProviderFakeLoader.lua

@@ -0,0 +1,16 @@
+--[=[
+	Creates a service that provides modules from a parent module, either by name, or by list!
+	@class ModuleProviderFakeLoader
+]=]
+
+local function load(script)
+	local moduleProvider = script:FindFirstAncestorWhichIsA("ModuleScript")
+	assert(moduleProvider, "No moduleProvider")
+
+	local loader = require(moduleProvider.Parent.loader)
+	return loader.load(moduleProvider)
+end
+
+return {
+	load = load
+}

package/src/Shared/TaggedTemplateProvider.lua

@@ -1,6 +1,7 @@
---- Like a template provider, but it also reparents and retrieves tagged objects
--- @classmod TaggedTemplateProvider
--- @author Quenty
+--[=[
+	Like a template provider, but it also reparents and retrieves tagged objects
+	@class TaggedTemplateProvider
+]=]
 
 local require = require(script.Parent.loader).load(script)
 

package/src/Shared/TemplateContainerUtils.lua

@@ -1,6 +1,7 @@
---- Utility functions for the TemplateProvider
--- @module TemplateContainerUtils
--- @author Quenty
+--[=[
+	Utility functions for the TemplateProvider
+	@class TemplateContainerUtils
+]=]
 
 local Workspace = game:GetService("Workspace")
 local RunService = game:GetService("RunService")

package/src/Shared/TemplateProvider.lua

@@ -1,5 +1,37 @@
---- Base of a template retrieval system
--- @classmod TemplateProvider
+--[=[
+	Base of a template retrieval system. Templates can be retrieved from Roblox, or from the cloud,
+	and then retrieved by name. Folders are ignored, so assets may be organized however you want.
+
+	Templates can repliate to client if desired.
+
+	```lua
+	-- shared/Templates.lua
+
+	return TemplateProvider.new(182451181, script) -- Load from Roblox cloud
+	```
+
+	```lua
+	-- Server
+	local serviceBag = ServiceBag.new()
+	local templates = serviceBag:GetService(packages.Templates)
+	serviceBag:Init()
+	serviceBag:Start()
+	```
+
+	```lua
+	-- Client
+	local serviceBag = ServiceBag.new()
+	local templates = serviceBag:GetService(packages.Templates)
+	serviceBag:Init()
+	serviceBag:Start()
+
+	templates:PromiseClone("Crate"):Then(function(crate)
+		print("Got crate from the cloud!")
+	end)
+	```
+
+	@class TemplateProvider
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -15,7 +47,11 @@ local TemplateProvider = {}
 TemplateProvider.ClassName = "TemplateProvider"
 TemplateProvider.__index = TemplateProvider
 
--- @param[opt=nil] container
+--[=[
+	Constructs a new [TemplateProvider].
+	@param container Instance | table | number -- Value
+	@param replicationParent Instance? -- Place to replicate instances to.
+]=]
 function TemplateProvider.new(container, replicationParent)
 	local self = setmetatable({}, TemplateProvider)
 
@@ -48,7 +84,9 @@ function TemplateProvider.new(container, replicationParent)
 	return self
 end
 
--- Initializes the container provider
+--[=[
+	Initializes the container provider. Should be done via [ServiceBag].
+]=]
 function TemplateProvider:Init()
 	assert(not self._initialized, "Already initialized")
 
@@ -64,6 +102,11 @@ function TemplateProvider:Init()
 	end
 end
 
+--[=[
+	Promises to clone the template as soon as it exists.
+	@param templateName string
+	@return Promise<Instance>
+]=]
 function TemplateProvider:PromiseClone(templateName)
 	assert(type(templateName) == "string", "templateName must be a string")
 
@@ -84,7 +127,7 @@ function TemplateProvider:PromiseClone(templateName)
 			self._maid[promise] = nil
 		end)
 
-		delay(5, function()
+		task.delay(5, function()
 			if promise:IsPending() then
 				warn(("[TemplateProvider.PromiseClone] - May fail to replicate template %q from cloud. %s")
 					:format(templateName, self:_getReplicationHint()))
@@ -109,7 +152,16 @@ function TemplateProvider:_getReplicationHint()
 	return hint
 end
 
--- Clones the template. If it has a prefix of "Template" then it will remove it
+--[=[
+	Clones the template.
+
+	:::info
+	If the template name has a prefix of "Template" then it will remove it on the cloned instance.
+	:::
+
+	@param templateName string
+	@return Instance?
+]=]
 function TemplateProvider:Clone(templateName)
 	assert(type(templateName) == "string", "templateName must be a string")
 
@@ -126,7 +178,12 @@ function TemplateProvider:Clone(templateName)
 	return newItem
 end
 
--- Returns the raw template
+--[=[
+	Returns the raw template
+
+	@param templateName string
+	@return Instance?
+]=]
 function TemplateProvider:Get(templateName)
 	assert(type(templateName) == "string", "templateName must be a string")
 	self:_verifyInit()
@@ -134,7 +191,11 @@ function TemplateProvider:Get(templateName)
 	return self._registry[templateName]
 end
 
--- Adds a new container to the provider for provision of assets
+--[=[
+	Adds a new container to the provider for provision of assets.
+
+	@param container Instance | number
+]=]
 function TemplateProvider:AddContainer(container)
 	assert(typeof(container) == "Instance" or type(container) == "number", "Bad container")
 	self:_verifyInit()
@@ -151,6 +212,11 @@ function TemplateProvider:AddContainer(container)
 	end
 end
 
+--[=[
+	Removes a container from the provisioning set.
+
+	@param container Instance | number
+]=]
 function TemplateProvider:RemoveContainer(container)
 	assert(typeof(container) == "Instance", "Bad container")
 	self:_verifyInit()
@@ -159,7 +225,11 @@ function TemplateProvider:RemoveContainer(container)
 	self._maid[container] = nil
 end
 
--- Returns whether or not a template is registered at the time
+--[=[
+	Returns whether or not a template is registered at the time
+	@param templateName string
+	@return boolean
+]=]
 function TemplateProvider:IsAvailable(templateName)
 	assert(type(templateName) == "string", "templateName must be a string")
 	self:_verifyInit()
@@ -167,7 +237,11 @@ function TemplateProvider:IsAvailable(templateName)
 	return self._registry[templateName] ~= nil
 end
 
--- Returns all current registered items
+--[=[
+	Returns all current registered items.
+
+	@return { Instance }
+]=]
 function TemplateProvider:GetAll()
 	self:_verifyInit()
 
@@ -179,7 +253,11 @@ function TemplateProvider:GetAll()
 	return list
 end
 
--- Gets the container
+--[=[
+	Gets all current the containers.
+
+	@return { Instance | number }
+]=]
 function TemplateProvider:GetContainers()
 	self:_verifyInit()
 
@@ -300,6 +378,9 @@ function TemplateProvider:_removeFromRegistry(child)
 	end
 end
 
+--[=[
+	Cleans up the provider
+]=]
 function TemplateProvider:Destroy()
 	self._maid:DoCleaning()
 end