@rbxts/centurion-ui 1.0.7 → 2.0.0-rc.1

package/vide/src/switch.luau

@@ -0,0 +1,114 @@
+local branch = require "./branch"
+local source = require "./source"
+local effect = require "./effect"
+local timeout = require "./timeout" ()
+
+type Array<T> = { T }
+type Map<K, V> = { [K]: V }
+type Source<T> = () -> T
+type Component<T> = (Source<boolean>) -> (T, ...number)
+
+local function switch_map<K, Obj>(
+    input: Source<K>,
+    map: Map<K, Component<Obj>>
+): Source<nil | Obj | Array<Obj>>
+    local scopes = {} :: Map<K, {
+        destroy: () -> (),
+        object: Obj,
+        delay: number,
+        present: (boolean?) -> boolean,
+        timeout: { cancel: boolean }?
+    }>
+
+    local output = source(nil :: nil | Obj | Array<Obj>)
+    local function update_output()
+        local objects = {}
+
+        for _, scope in scopes do
+            table.insert(objects, scope.object)
+        end
+
+        output(
+            if objects[2] then objects
+            elseif objects[1] then objects[1]
+            else nil
+        )
+    end
+
+    effect(function()
+        local key: K? = input()
+
+        -- destroy (or queue destroy) all scopes not associated with the input key
+        for k, scope in scopes do
+            if k == key then continue end
+
+            scope.present(false)
+
+            if scope.delay == 0 then
+                scope.destroy()
+                scopes[k] = nil
+            else
+                if scope.timeout == nil then
+                    scope.timeout = timeout(scope.delay, function()
+                        scope.destroy()
+                        scopes[k] = nil
+                        update_output()
+                    end)
+                end
+            end
+        end
+
+        -- create new scope or abort destruction of existing scope if key exists
+        if key ~= nil then
+            local scope = scopes[key]
+
+            if scope then
+                scope.present(true)
+
+                if scope.timeout then
+                    scope.timeout.cancel = true
+                    scope.timeout = nil
+                end
+            else
+                local component = map[key]
+
+                if component ~= nil then
+                    if type(component) ~= "function" then
+                        error("map must map a value to a function", 0)
+                    end
+
+                    local present = source(false)
+
+                    local delay = nil :: number?
+                    local destroy, object = branch(function()
+                        local object, t = component(present)
+                        delay = t
+                        return object
+                    end)
+
+                    present(true)
+
+                    scopes[key] = {
+                        destroy = destroy,
+                        object = object,
+                        delay = delay or 0,
+                        present = present,
+                        timeout = nil
+                    }
+                end
+            end
+        end
+
+        update_output()
+    end)
+
+    return output
+end
+
+local function switch<K, Obj>(input: Source<K>): (map: Map<K, Component<Obj>>) -> Source<nil | Obj | Array<Obj>>
+    return function(map)
+        return switch_map(input, map)
+    end
+end
+
+return switch

package/vide/src/timeout.luau

@@ -0,0 +1,27 @@
+local queue = {} :: {
+    { t: number, fn: () -> (), cancel: boolean }
+}
+
+local function timeout(t: number, fn: () -> ())
+    local handle = { t = t, fn = fn, cancel = false }
+    table.insert(queue, handle)
+    return handle
+end
+
+local function update_timeouts(dt: number)
+    for i = #queue, 1, -1 do
+        local handle = queue[i]
+        handle.t -= dt
+        
+        if handle.cancel or handle.t <= 0 then
+            queue[i] = queue[#queue]
+            queue[#queue] = nil
+
+            if not handle.cancel then
+                handle.fn()
+            end
+        end
+    end
+end
+
+return function() return timeout, update_timeouts end

package/vide/src/untrack.luau

@@ -0,0 +1,25 @@
+local graph = require "./graph"
+type Node<T> = graph.Node<T>
+local get_scope = graph.get_scope
+
+local function untrack<T>(source: () -> T): T
+    local scope = get_scope()
+    
+    if scope then
+        -- sources are only tracked if the node in scope has an effect
+        local effect = scope.effect
+        scope.effect = false
+
+        local ok, result = xpcall(source, debug.traceback)
+
+        scope.effect = effect :: () -> ()
+
+        if not ok then error(result, 0) end
+
+        return result :: T
+    else
+        return source()
+    end
+end
+
+return untrack :: ( <T>(fn: () -> T) -> T ) & ( (fn: () -> ()) -> () )

package/vide/src/values.luau

@@ -0,0 +1,131 @@
+local flags = require "./flags"
+local branch = require "./branch"
+local source = require "./source"
+local effect = require "./effect"
+local timeout = require "./timeout" ()
+
+type Array<T> = { T }
+type Map<K, V> = { [K]: V }
+type Source<T> = () -> T
+
+local function values<K, V, Obj>(
+    input: Source<Map<K, V>>,
+    component: (V, Source<K>, Source<boolean>) -> (Obj, ...number)
+): Source<Array<Obj>>
+    local update_count = 0
+    local scopes = {} :: Map<V, {
+        destroy: () -> (),
+        object: Obj,
+        index: K?,
+        index_source: (K?) -> K,
+        count: number,
+        delay: number,
+        present: (boolean?) -> boolean,
+        timeout: { cancel: boolean }?,
+    }>
+
+    local output = source({} :: Array<Obj>)
+    local function update_output()
+        local objects = table.create(4)
+
+        for _, scope in scopes do
+            table.insert(objects, scope.object)
+        end
+
+        output(objects)
+    end
+
+    effect(function()
+        local data = input()
+
+        local count = update_count
+        update_count += 1
+
+        local children_need_update = false -- set to true if a scope is created or destroyed
+
+        if flags.strict then -- check for duplicate values
+            local map = {}
+            for _, v in data do
+                if map[v] then
+                    error("table source passed to `values()` contains duplicate values", 0)
+                end
+                map[v] = true
+            end
+        end
+
+        -- create or update scopes
+        for i, v in data do
+            local scope = scopes[v]
+
+            if scope == nil then -- create new scope and create component
+                local index_source = source(i)
+                local present = source(false)
+
+                local delay = nil :: number?
+                local destroy, object = branch(function()
+                    local object, t = component(v, index_source, present)
+                    delay = t
+                    return object
+                end)
+
+                present(true)
+                
+                children_need_update = true
+
+                scopes[v] = {
+                    destroy = destroy,
+                    object = object,
+                    index = i,
+                    index_source = index_source,
+                    count = count,
+                    delay = delay or 0,
+                    present = present,
+                    timeout = nil,
+                }
+            else -- update scope
+                scope.count = count
+
+                if scope.index ~= i then
+                    if scope.timeout then -- value is in input table again; cancel destruction
+                        scope.timeout.cancel = true
+                        scope.timeout = nil
+                        scope.present(true)
+                    end
+                    
+                    scope.index = i
+                    scope.index_source(i)
+                end
+            end
+        end
+
+        -- destroy scopes
+        for v, scope in scopes do
+            if scope.count < count then -- if count is not latest then value is no longer in the input table
+                scope.present(false)
+
+                if scope.delay == 0 then
+                    scope.destroy()
+                    scopes[v] = nil
+                    children_need_update = true
+                else
+                    scope.index = nil -- set to nil for the `scope.index ~= i` check
+                    if scope.timeout == nil then
+                        scope.timeout = timeout(scope.delay, function() -- todo: possible redundant updates
+                            scope.destroy()
+                            scopes[v] = nil
+                            update_output()
+                        end)
+                    end
+                end
+            end
+        end
+
+        if children_need_update then
+            update_output()
+        end
+    end)
+
+    return output
+end
+
+return values

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

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

package/out/app/centurion-app.luau

@@ -1,86 +0,0 @@
--- Compiled with roblox-ts v3.0.0
-local TS = _G[script]
-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
-local _components = TS.import(script, script.Parent.Parent, "components")
-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 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
-local usePx = _use_px.usePx
-local _store = TS.import(script, script.Parent.Parent, "store")
-local mouseOverInterface = _store.mouseOverInterface
-local options = _store.options
-local visible = _store.visible
-local MOUSE_INPUT_TYPES = {
-	[Enum.UserInputType.MouseButton1] = true,
-	[Enum.UserInputType.MouseButton2] = true,
-	[Enum.UserInputType.Touch] = true,
-}
-local function CenturionApp(client)
-	useClient(client)
-	usePx()
-	local validKeys = derive(function()
-		local _set = {}
-		for _, _v in options().activationKeys do
-			_set[_v] = true
-		end
-		return _set
-	end)
-	useEvent(UserInputService.InputBegan, function(input, gameProcessed)
-		local _exp = validKeys()
-		local _keyCode = input.KeyCode
-		local _condition = _exp[_keyCode] ~= nil
-		if _condition then
-			_condition = not gameProcessed
-		end
-		if _condition then
-			visible(not visible())
-		else
-			local _condition_1 = options().hideOnLostFocus
-			if _condition_1 then
-				local _userInputType = input.UserInputType
-				_condition_1 = MOUSE_INPUT_TYPES[_userInputType] ~= nil
-				if _condition_1 then
-					_condition_1 = not mouseOverInterface()
-				end
-			end
-			if _condition_1 then
-				visible(false)
-			end
-		end
-	end)
-	return Vide.jsx(Layer, {
-		name = "Centurion",
-		displayOrder = function()
-			return options().displayOrder
-		end,
-		visible = visible,
-	}, Vide.jsx(Group, {
-		anchor = function()
-			return options().anchor
-		end,
-		size = function()
-			local size = options().size
-			return if typeof(size) == "UDim2" then size else size(px)
-		end,
-		position = function()
-			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()
-			return UDim.new(0, px(8))
-		end,
-		SortOrder = "LayoutOrder",
-	})))
-end
-return {
-	CenturionApp = CenturionApp,
-}

package/out/app/index.d.ts

@@ -1,32 +0,0 @@
-import { CenturionClient } from "@rbxts/centurion";
-import { InterfaceOptions } from "../types";
-export declare namespace CenturionUI {
-    /**
-     * Returns whether the terminal UI is visible.
-     *
-     * @returns Whether the terminal UI is visible.
-     */
-    function isVisible(): boolean;
-    /**
-     * Sets the visibility of the terminal UI.
-     *
-     * @param visible Whether the terminal UI should be visible.
-     */
-    function setVisible(visible: boolean): void;
-    /**
-     * Updates the terminal UI options.
-     *
-     * @param options The options to update.
-     */
-    function updateOptions(options: Partial<InterfaceOptions>): void;
-    /**
-     * Mounts the terminal UI.
-     *
-     * If `registerBuiltInCommands` is **true** (default), client commands
-     * will be registered.
-     *
-     * @param client The Centurion client.
-     * @param options The terminal UI options.
-     */
-    function start(client: CenturionClient, options?: Partial<InterfaceOptions>): void;
-}

package/out/app/init.luau

@@ -1,105 +0,0 @@
--- Compiled with roblox-ts v3.0.0
-local TS = _G[script]
-local CenturionType = TS.import(script, TS.getModule(script, "@rbxts", "centurion").out).CenturionType
-local Players = TS.import(script, TS.getModule(script, "@rbxts", "services")).Players
-local mount = TS.import(script, TS.getModule(script, "@rbxts", "vide").src).mount
-local DEFAULT_INTERFACE_OPTIONS = TS.import(script, script.Parent, "constants", "options").DEFAULT_INTERFACE_OPTIONS
-local DefaultPalette = TS.import(script, script.Parent, "palette").DefaultPalette
-local _store = TS.import(script, script.Parent, "store")
-local uiOptions = _store.options
-local uiVisible = _store.visible
-local CenturionApp = TS.import(script, script, "centurion-app").CenturionApp
-local CenturionUI = {}
-do
-	local _container = CenturionUI
-	--[[
-		*
-			 * Returns whether the terminal UI is visible.
-			 *
-			 * @returns Whether the terminal UI is visible.
-			 
-	]]
-	local function isVisible()
-		return uiVisible()
-	end
-	_container.isVisible = isVisible
-	--[[
-		*
-			 * Sets the visibility of the terminal UI.
-			 *
-			 * @param visible Whether the terminal UI should be visible.
-			 
-	]]
-	local function setVisible(visible)
-		uiVisible(visible)
-	end
-	_container.setVisible = setVisible
-	--[[
-		*
-			 * Updates the terminal UI options.
-			 *
-			 * @param options The options to update.
-			 
-	]]
-	local function updateOptions(options)
-		local _object = table.clone(DEFAULT_INTERFACE_OPTIONS)
-		setmetatable(_object, nil)
-		for _k, _v in uiOptions() do
-			_object[_k] = _v
-		end
-		for _k, _v in options do
-			_object[_k] = _v
-		end
-		uiOptions(_object)
-	end
-	_container.updateOptions = updateOptions
-	--[[
-		*
-			 * Mounts the terminal UI.
-			 *
-			 * If `registerBuiltInCommands` is **true** (default), client commands
-			 * will be registered.
-			 *
-			 * @param client The Centurion client.
-			 * @param options The terminal UI options.
-			 
-	]]
-	local registerCommands
-	local function start(client, options)
-		if options == nil then
-			options = {}
-		end
-		if client.config.registerBuiltInCommands then
-			registerCommands(client.registry)
-		end
-		updateOptions(options)
-		mount(function()
-			return CenturionApp(client)
-		end, Players.LocalPlayer:WaitForChild("PlayerGui"))
-	end
-	_container.start = start
-	function registerCommands(registry)
-		registry:registerCommand({
-			name = "theme",
-			description = "Change the terminal's theme",
-			arguments = { {
-				name = "name",
-				description = "The name of the theme",
-				type = CenturionType.String,
-				suggestions = { "mocha", "macchiato", "frappe", "latte" },
-			} },
-		}, function(ctx, theme)
-			if not (DefaultPalette[theme] ~= nil) then
-				ctx:error("Invalid theme")
-				return nil
-			end
-			updateOptions({
-				palette = DefaultPalette[theme],
-			})
-			ctx:reply(`Set theme to '{theme}'`)
-		end, { "centurion" })
-	end
-end
-return {
-	CenturionUI = CenturionUI,
-}

package/out/components/history/history-line.d.ts

@@ -1,9 +0,0 @@
-import { HistoryEntry } from "@rbxts/centurion";
-import Vide, { Derivable } from "@rbxts/vide";
-interface HistoryLineProps {
-    data: HistoryEntry;
-    position?: Derivable<UDim2>;
-    order?: Derivable<number>;
-}
-export declare function HistoryLine({ data, position, order }: HistoryLineProps): Vide.Node;
-export {};

package/out/components/history/history-line.luau

@@ -1,88 +0,0 @@
--- Compiled with roblox-ts v3.0.0
-local TS = _G[script]
-local _vide = TS.import(script, TS.getModule(script, "@rbxts", "vide").src)
-local Vide = _vide
-local derive = _vide.derive
-local HISTORY_TEXT_SIZE = TS.import(script, script.Parent.Parent.Parent, "constants", "text").HISTORY_TEXT_SIZE
-local px = TS.import(script, script.Parent.Parent.Parent, "hooks", "use-px").px
-local options = TS.import(script, script.Parent.Parent.Parent, "store").options
-local Frame = TS.import(script, script.Parent.Parent, "ui", "frame").Frame
-local Group = TS.import(script, script.Parent.Parent, "ui", "group").Group
-local Outline = TS.import(script, script.Parent.Parent, "ui", "outline").Outline
-local Text = TS.import(script, script.Parent.Parent, "ui", "text").Text
-local TextField = TS.import(script, script.Parent.Parent, "ui", "text-field").TextField
-local function HistoryLine(_param)
-	local data = _param.data
-	local position = _param.position
-	local order = _param.order
-	local date = derive(function()
-		local dateTime = DateTime.fromUnixTimestamp(data.sentAt):FormatLocalTime("LT", "en-us")
-		local dateParts = string.split(dateTime, " ")
-		return `<b>{dateParts[1]}</b> {dateParts[2]}`
-	end)
-	return Vide.jsx(Group, {
-		automaticSize = "Y",
-		size = UDim2.fromScale(1, 0),
-		position = position,
-		layoutOrder = order,
-	}, Vide.jsx(Frame, {
-		backgroundColor = function()
-			return options().palette.surface
-		end,
-		size = function()
-			return UDim2.fromOffset(px(76), px(HISTORY_TEXT_SIZE + 4))
-		end,
-		cornerRadius = function()
-			return UDim.new(0, px(4))
-		end,
-	}, Vide.jsx(Text, {
-		size = UDim2.fromScale(1, 1),
-		text = date,
-		textColor = function()
-			return options().palette.text
-		end,
-		textSize = function()
-			return px(HISTORY_TEXT_SIZE)
-		end,
-		richText = true,
-	}), Vide.jsx(Outline, {
-		innerThickness = function()
-			return px(1)
-		end,
-		innerTransparency = 0.25,
-		innerColor = function()
-			return if data.success then options().palette.success else options().palette.error
-		end,
-		outerThickness = 0,
-		cornerRadius = function()
-			return UDim.new(0, px(4))
-		end,
-	})), Vide.jsx(TextField, {
-		automaticSize = "Y",
-		anchor = Vector2.new(1, 0),
-		size = function()
-			return UDim2.new(1, -px(84), 0, 0)
-		end,
-		position = function()
-			return UDim2.new(1, 0, 0, px(2))
-		end,
-		text = data.text,
-		textSize = function()
-			return px(HISTORY_TEXT_SIZE)
-		end,
-		textColor = function()
-			local palette = options().palette
-			return if data.success then palette.text else palette.error
-		end,
-		textEditable = false,
-		textXAlignment = "Left",
-		clearTextOnFocus = false,
-		font = function()
-			return options().font.medium
-		end,
-		richText = true,
-	}))
-end
-return {
-	HistoryLine = HistoryLine,
-}

package/out/components/history/history-list.d.ts

@@ -1,11 +0,0 @@
-import { HistoryEntry } from "@rbxts/centurion";
-import Vide, { Derivable } from "@rbxts/vide";
-interface HistoryListProps {
-    entries: Derivable<HistoryEntry[]>;
-    size?: Derivable<UDim2>;
-    position?: Derivable<UDim2>;
-    scrollingEnabled?: Derivable<boolean>;
-    onContentSizeChanged?: (size: Vector2) => void;
-}
-export declare function HistoryList({ entries, size, position, scrollingEnabled, onContentSizeChanged, }: HistoryListProps): Vide.Node;
-export {};