@rbxts/centurion-ui 1.0.0-dev-0822e84 → 1.0.0-dev-ba19f7f

package/out/app/centurion-app.d.ts

@@ -1,3 +1,3 @@
-import { ClientAPI } from "@rbxts/centurion";
+import { CenturionClient } from "@rbxts/centurion";
 import Vide from "@rbxts/vide";
-export declare function CenturionApp(api: ClientAPI): Vide.Node;
+export declare function CenturionApp(client: CenturionClient): Vide.Node;

package/out/app/centurion-app.lua

@@ -1,8 +1,6 @@
 -- Compiled with roblox-ts v2.3.0-dev-26ec859
 local TS = _G[script]
-local _services = TS.import(script, TS.getModule(script, "@rbxts", "services"))
-local GuiService = _services.GuiService
-local UserInputService = _services.UserInputService
+local UserInputService = TS.import(script, TS.getModule(script, "@rbxts", "services")).UserInputService
 local _vide = TS.import(script, TS.getModule(script, "@rbxts", "vide").src)
 local Vide = _vide
 local derive = _vide.derive
@@ -11,8 +9,8 @@ local Suggestions = _components.Suggestions
 local Terminal = _components.Terminal
 local Group = TS.import(script, script.Parent.Parent, "components", "ui", "group").Group
 local Layer = TS.import(script, script.Parent.Parent, "components", "ui", "layer").Layer
-local useAPI = TS.import(script, script.Parent.Parent, "hooks", "use-api").useAPI
 local useAtom = TS.import(script, script.Parent.Parent, "hooks", "use-atom").useAtom
+local useClient = TS.import(script, script.Parent.Parent, "hooks", "use-client").useClient
 local useEvent = TS.import(script, script.Parent.Parent, "hooks", "use-event").useEvent
 local _use_px = TS.import(script, script.Parent.Parent, "hooks", "use-px")
 local px = _use_px.px
@@ -26,8 +24,8 @@ local MOUSE_INPUT_TYPES = {
 	[Enum.UserInputType.MouseButton2] = true,
 	[Enum.UserInputType.Touch] = true,
 }
-local function CenturionApp(api)
-	useAPI(api)
+local function CenturionApp(client)
+	useClient(client)
 	usePx()
 	local options = useAtom(interfaceOptions)
 	local visible = useAtom(interfaceVisible)
@@ -63,22 +61,20 @@ local function CenturionApp(api)
 	end)
 	return Vide.jsx(Layer, {
 		displayOrder = function()
-			local _condition = options().displayOrder
-			if _condition == nil then
-				_condition = 0
-			end
-			return _condition
+			return options().displayOrder
 		end,
 		visible = visible,
 	}, Vide.jsx(Group, {
 		anchorPoint = function()
-			return options().anchorPoint or Vector2.new(0, 0)
+			return options().anchorPoint
 		end,
 		size = function()
-			return options().size or UDim2.new(0, px(1024), 1, 0)
+			local size = options().size
+			return if typeof(size) == "UDim2" then size else size(px)
 		end,
 		position = function()
-			return options().position or UDim2.fromOffset(px(16), px(8) + (GuiService:GetGuiInset()).Y)
+			local position = options().position
+			return if typeof(position) == "UDim2" then position else position(px)
 		end,
 	}, Vide.jsx(Terminal), Vide.jsx(Suggestions), Vide.jsx("uilistlayout", {
 		Padding = function()

package/out/app/index.d.ts

@@ -1,7 +1,8 @@
-import { ClientAPI } from "@rbxts/centurion";
+import { CenturionClient } from "@rbxts/centurion";
 import { InterfaceOptions } from "../types";
 export declare namespace CenturionUI {
+    function isVisible(): boolean;
     function setVisible(visible: boolean): void;
     function updateOptions(options: Partial<InterfaceOptions>): void;
-    function create(options?: Partial<InterfaceOptions>): (api: ClientAPI) => void;
+    function start(client: CenturionClient, options?: Partial<InterfaceOptions>): void;
 }

package/out/app/init.lua

@@ -16,6 +16,10 @@ do
 	local _container = CenturionUI
 	local MAX_PRELOAD_ATTEMPTS = 3
 	local PRELOAD_ATTEMPT_INTERVAL = 3
+	local function isVisible()
+		return interfaceVisible()
+	end
+	_container.isVisible = isVisible
 	local function setVisible(visible)
 		interfaceVisible(visible)
 	end
@@ -27,52 +31,52 @@ do
 			for _k, _v in options do
 				_object[_k] = _v
 			end
+			for _k, _v in DEFAULT_INTERFACE_OPTIONS do
+				_object[_k] = _v
+			end
 			return _object
 		end)
 	end
 	_container.updateOptions = updateOptions
 	local registerCommands
-	local function create(options)
+	local function start(client, options)
 		if options == nil then
 			options = {}
 		end
-		return function(api)
-			if api.config.registerBuiltInCommands then
-				registerCommands(api.registry)
+		if client.config.registerBuiltInCommands then
+			registerCommands(client.registry)
+		end
+		updateOptions(options)
+		-- Attempt to preload font
+		task.spawn(function()
+			local _result = options.font
+			if _result ~= nil then
+				_result = _result.regular
 			end
-			updateOptions(options)
-			-- Attempt to preload font
-			task.spawn(function()
-				local _result = options.font
-				if _result ~= nil then
-					_result = _result.regular
-				end
-				local _condition = _result
-				if _condition == nil then
-					_condition = DEFAULT_INTERFACE_OPTIONS.font.regular
-				end
-				local fontFamily = _condition.Family
-				local attempts = 0
-				while attempts < MAX_PRELOAD_ATTEMPTS do
-					ContentProvider:PreloadAsync({ fontFamily }, function(_, status)
-						if status == Enum.AssetFetchStatus.Success then
-							attempts = MAX_PRELOAD_ATTEMPTS
-						end
-					end)
-					if attempts == MAX_PRELOAD_ATTEMPTS then
-						break
+			local _condition = _result
+			if _condition == nil then
+				_condition = DEFAULT_INTERFACE_OPTIONS.font.regular
+			end
+			local fontFamily = _condition.Family
+			local attempts = 0
+			while attempts < MAX_PRELOAD_ATTEMPTS do
+				ContentProvider:PreloadAsync({ fontFamily }, function(_, status)
+					if status == Enum.AssetFetchStatus.Success then
+						attempts = MAX_PRELOAD_ATTEMPTS
 					end
-					task.wait(PRELOAD_ATTEMPT_INTERVAL)
-					attempts += 1
+				end)
+				if attempts == MAX_PRELOAD_ATTEMPTS then
+					break
 				end
-			end)
-			local target = Players.LocalPlayer:WaitForChild("PlayerGui")
-			mount(function()
-				return CenturionApp(api)
-			end, target)
-		end
+				task.wait(PRELOAD_ATTEMPT_INTERVAL)
+				attempts += 1
+			end
+		end)
+		mount(function()
+			return CenturionApp(client)
+		end, Players.LocalPlayer:WaitForChild("PlayerGui"))
 	end
-	_container.create = create
+	_container.start = start
 	function registerCommands(registry)
 		registry:registerCommand({
 			name = "theme",

package/out/components/terminal/terminal-text-field.lua

@@ -7,8 +7,8 @@ local Vide = _vide
 local cleanup = _vide.cleanup
 local effect = _vide.effect
 local source = _vide.source
-local getAPI = TS.import(script, script.Parent.Parent.Parent, "hooks", "use-api").getAPI
 local useAtom = TS.import(script, script.Parent.Parent.Parent, "hooks", "use-atom").useAtom
+local useClient = TS.import(script, script.Parent.Parent.Parent, "hooks", "use-client").useClient
 local useEvent = TS.import(script, script.Parent.Parent.Parent, "hooks", "use-event").useEvent
 local px = TS.import(script, script.Parent.Parent.Parent, "hooks", "use-px").px
 local _store = TS.import(script, script.Parent.Parent.Parent, "store")
@@ -37,7 +37,7 @@ local function TerminalTextField(_param)
 	local backgroundTransparency = _param.backgroundTransparency
 	local onTextChange = _param.onTextChange
 	local onSubmit = _param.onSubmit
-	local api = getAPI()
+	local client = useClient()
 	local options = useAtom(interfaceOptions)
 	local visible = useAtom(interfaceVisible)
 	local valid = useAtom(terminalTextValid)
@@ -128,7 +128,7 @@ local function TerminalTextField(_param)
 			end
 			newText ..= string.sub(_exp, _condition + 1)
 		end
-		local argNames = getArgumentNames(api.registry, command)
+		local argNames = getArgumentNames(client.registry, command)
 		for i = argIndex + 1, #argNames - 1 do
 			newText = `{newText} {argNames[i + 1]}`
 		end
@@ -186,7 +186,7 @@ local function TerminalTextField(_param)
 				table.remove(pathParts, _arg0 + 1)
 				table.insert(pathParts, suggestionTitle)
 			end
-			local _nextCommand = api.registry:getCommandByString(formatPartsAsPath(pathParts))
+			local _nextCommand = client.registry:getCommandByString(formatPartsAsPath(pathParts))
 			if _nextCommand ~= nil then
 				_nextCommand = _nextCommand.options
 			end
@@ -216,7 +216,7 @@ local function TerminalTextField(_param)
 			return nil
 		end
 		local argIndex = terminalArgIndex()
-		local _commandArgs = api.registry:getCommand(commandPath)
+		local _commandArgs = client.registry:getCommand(commandPath)
 		if _commandArgs ~= nil then
 			_commandArgs = _commandArgs.options.arguments
 		end

package/out/components/terminal/terminal.lua

@@ -8,8 +8,8 @@ local Vide = _vide
 local effect = _vide.effect
 local source = _vide.source
 local HISTORY_TEXT_SIZE = TS.import(script, script.Parent.Parent.Parent, "constants", "text").HISTORY_TEXT_SIZE
-local getAPI = TS.import(script, script.Parent.Parent.Parent, "hooks", "use-api").getAPI
 local useAtom = TS.import(script, script.Parent.Parent.Parent, "hooks", "use-atom").useAtom
+local useClient = TS.import(script, script.Parent.Parent.Parent, "hooks", "use-client").useClient
 local useHistory = TS.import(script, script.Parent.Parent.Parent, "hooks", "use-history").useHistory
 local useMotion = TS.import(script, script.Parent.Parent.Parent, "hooks", "use-motion").useMotion
 local px = TS.import(script, script.Parent.Parent.Parent, "hooks", "use-px").px
@@ -37,7 +37,7 @@ local TerminalTextField = TS.import(script, script.Parent, "terminal-text-field"
 local MAX_HEIGHT = HISTORY_TEXT_SIZE * 10
 local TEXT_FIELD_HEIGHT = 40
 local function Terminal()
-	local api = getAPI()
+	local client = useClient()
 	local options = useAtom(interfaceOptions)
 	local missingArgs = source({})
 	local history = useHistory()
@@ -114,8 +114,8 @@ local function Terminal()
 			-- If the text ends in a space, we want to count that as having traversed
 			-- to the next "part" of the text.
 			local atNextPart = string.sub(text, -1) == " "
-			local path = getValidPath(api.registry, parts)
-			local command = if path ~= nil then api.registry:getCommand(path) else nil
+			local path = getValidPath(client.registry, parts)
+			local command = if path ~= nil then client.registry:getCommand(path) else nil
 			if command ~= nil then
 				-- Check for missing arguments
 				local missing = getMissingArgs(command, parts)
@@ -140,7 +140,7 @@ local function Terminal()
 			if command == nil or argIndex == -1 then
 				-- Get command suggestions
 				local parentPath = if not (#parts == 0) then RegistryPath.new(ArrayUtil.slice(parts, 0, #parts - (if atNextPart then 0 else 1))) else nil
-				local _exp = api.registry
+				local _exp = client.registry
 				local _result = parentPath
 				if _result ~= nil then
 					_result = _result:isEmpty()
@@ -177,7 +177,7 @@ local function Terminal()
 				local numArgs = _condition
 				endIndex = if numArgs ~= "rest" then i + (numArgs - 1) else nil
 			end
-			local _registry = api.registry
+			local _registry = client.registry
 			local _result = currentArg
 			if _result ~= nil then
 				_result = _result.type
@@ -236,9 +236,9 @@ local function Terminal()
 		end,
 		onSubmit = function()
 			local commandPath = currentCommandPath()
-			local command = if commandPath ~= nil then api.registry:getCommand(commandPath) else nil
+			local command = if commandPath ~= nil then client.registry:getCommand(commandPath) else nil
 			if commandPath == nil or command == nil then
-				api.dispatcher:addHistoryEntry({
+				client.dispatcher:addHistoryEntry({
 					success = false,
 					text = "Command not found.",
 					sentAt = os.time(),
@@ -247,7 +247,7 @@ local function Terminal()
 			end
 			local missing = missingArgs()
 			if not (#missing == 0) then
-				api.dispatcher:addHistoryEntry({
+				client.dispatcher:addHistoryEntry({
 					success = false,
 					text = `Missing arguments: {table.concat(missing, ", ")}`,
 					sentAt = os.time(),
@@ -255,7 +255,7 @@ local function Terminal()
 				return nil
 			end
 			local args = ArrayUtil.slice(terminalTextParts(), commandPath:size())
-			api.dispatcher:run(commandPath, args)
+			client.dispatcher:run(commandPath, args)
 		end,
 	}))
 end

package/out/constants/options.lua

@@ -1,18 +1,25 @@
 -- Compiled with roblox-ts v2.3.0-dev-26ec859
 local TS = _G[script]
+local GuiService = TS.import(script, TS.getModule(script, "@rbxts", "services")).GuiService
 local DefaultPalette = TS.import(script, script.Parent.Parent, "palette").DefaultPalette
 local DEFAULT_INTERFACE_OPTIONS = {
+	anchorPoint = Vector2.new(),
+	position = function(px)
+		return UDim2.fromOffset(px(16), px(8) + (GuiService:GetGuiInset()).Y)
+	end,
+	size = function(px)
+		return UDim2.new(0, px(1024), 1, 0)
+	end,
 	displayOrder = 1000,
-	activationKeys = { Enum.KeyCode.F2 },
+	backgroundTransparency = 0.2,
 	hideOnLostFocus = true,
+	activationKeys = { Enum.KeyCode.F2 },
 	font = {
 		regular = Font.new("rbxassetid://16658221428"),
 		medium = Font.new("rbxassetid://16658221428", Enum.FontWeight.Medium),
 		bold = Font.new("rbxassetid://16658221428", Enum.FontWeight.Bold),
 	},
 	palette = DefaultPalette.mocha,
-	backgroundTransparency = 0.2,
-	showShortcutSuggestions = true,
 }
 return {
 	DEFAULT_INTERFACE_OPTIONS = DEFAULT_INTERFACE_OPTIONS,

package/out/hooks/use-client.d.ts

@@ -0,0 +1,2 @@
+import { CenturionClient } from "@rbxts/centurion";
+export declare function useClient(client?: CenturionClient): CenturionClient;

package/out/hooks/use-client.lua

@@ -0,0 +1,17 @@
+-- Compiled with roblox-ts v2.3.0-dev-26ec859
+local TS = _G[script]
+local source = TS.import(script, TS.getModule(script, "@rbxts", "vide").src).source
+local clientState = source()
+local function useClient(client)
+	local value = clientState()
+	if value ~= nil then
+		return value
+	end
+	local _arg0 = client ~= nil
+	assert(_arg0, "No client has been set.")
+	clientState(client)
+	return client
+end
+return {
+	useClient = useClient,
+}

package/out/hooks/use-history.lua

@@ -7,15 +7,15 @@ local derive = _vide.derive
 local source = _vide.source
 local HISTORY_TEXT_SIZE = TS.import(script, script.Parent.Parent, "constants", "text").HISTORY_TEXT_SIZE
 local interfaceOptions = TS.import(script, script.Parent.Parent, "store").interfaceOptions
-local getAPI = TS.import(script, script.Parent, "use-api").getAPI
 local useAtom = TS.import(script, script.Parent, "use-atom").useAtom
+local useClient = TS.import(script, script.Parent, "use-client").useClient
 local useEvent = TS.import(script, script.Parent, "use-event").useEvent
 local px = TS.import(script, script.Parent, "use-px").px
 local function useHistory()
-	local api = getAPI()
+	local client = useClient()
 	local options = useAtom(interfaceOptions)
-	local history = source(api.dispatcher:getHistory())
-	useEvent(api.dispatcher.historyUpdated, function(entries)
+	local history = source(client.dispatcher:getHistory())
+	useEvent(client.dispatcher.historyUpdated, function(entries)
 		local _array = {}
 		local _length = #_array
 		table.move(entries, 1, #entries, _length + 1, _array)

package/out/hooks/use-px.d.ts

@@ -1,4 +1,4 @@
-interface ScaleFunction {
+export interface ScaleFunction {
     /**
      * Scales `pixels` based on the current viewport size and rounds the result.
      */
@@ -33,4 +33,3 @@ export declare const px: ScaleFunction;
  * called once in `Vide.mount`.
  */
 export declare function usePx(): void;
-export {};

package/out/types.d.ts

@@ -1,11 +1,12 @@
 import { CommandShortcut, HistoryEntry } from "@rbxts/centurion";
+import { ScaleFunction } from "./hooks/use-px";
 import { InterfacePalette } from "./palette";
 export interface InterfaceOptions {
-    anchorPoint?: Vector2;
-    size?: UDim2;
-    position?: UDim2;
-    backgroundTransparency?: number;
-    displayOrder?: number;
+    anchorPoint: Vector2;
+    size: UDim2 | ((px: ScaleFunction) => UDim2);
+    position: UDim2 | ((px: ScaleFunction) => UDim2);
+    displayOrder: number;
+    backgroundTransparency: number;
     hideOnLostFocus: boolean;
     activationKeys: Enum.KeyCode[];
     font: {
@@ -14,7 +15,6 @@ export interface InterfaceOptions {
         bold: Font;
     };
     palette: InterfacePalette;
-    showShortcutSuggestions?: boolean;
 }
 export interface HistoryLineData {
     entry: HistoryEntry;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rbxts/centurion-ui",
   "description": "Terminal UI for the Centurion command framework",
-  "version": "1.0.0-dev-0822e84",
+  "version": "1.0.0-dev-ba19f7f",
   "author": "paradoxuum",
   "license": "MIT",
   "main": "out/init.lua",
@@ -32,7 +32,7 @@
     "dev": "shx rm -rf out && rbxtsc -w"
   },
   "devDependencies": {
-    "@rbxts/centurion": "^1.0.0-dev-0822e84",
+    "@rbxts/centurion": "^1.0.0-dev-ba19f7f",
     "@rbxts/compiler-types": "2.3.0-types.1",
     "@rbxts/types": "^1.0.794",
     "roblox-ts": "2.3.0-dev-26ec859",

package/out/hooks/use-api.d.ts

@@ -1,3 +0,0 @@
-import { ClientAPI } from "@rbxts/centurion";
-export declare function getAPI(): ClientAPI;
-export declare function useAPI(clientAPI: ClientAPI): import("@rbxts/vide").Source<ClientAPI | undefined>;

package/out/hooks/use-api.lua

@@ -1,18 +0,0 @@
--- Compiled with roblox-ts v2.3.0-dev-26ec859
-local TS = _G[script]
-local source = TS.import(script, TS.getModule(script, "@rbxts", "vide").src).source
-local api = source()
-local function getAPI()
-	local value = api()
-	local _arg0 = value ~= nil
-	assert(_arg0, "Client API has not been set")
-	return value
-end
-local function useAPI(clientAPI)
-	api(clientAPI)
-	return api
-end
-return {
-	getAPI = getAPI,
-	useAPI = useAPI,
-}