feat!: use alien-signals for reactivity (#50)

* feat: use alien-signals

* refactor: remove pnpm, fix tests

* fix: `effectScope` should set scope

* fix: check previous value before calling listener

* refactor: improve imports

* refactor: exclude re-exports from wally

* refactor: embrace scope cleanup, restructure code

* fix: update pkgs dir references

* ci: simplify pesde install

* build: install dev deps with wally

* feat: add detached, add more tests

* test: simplify mapped test update

* chore: rephrase doc comment

* perf: optimize subscribe and mapped

* refactor: avoid ambiguous optional function type

* refactor: add assertion error messages

* perf: optimize mapped, add benches

* chore: delete redundant benchmarks

* perf: simplify mapped logic

* test: prettify test library

* test: try different gray

* test: color brackets

* refactor: sync 2.0.4

* refactor: use setCurrentSub instead of pauseTracking

* test: improve test suite

* test: separate parent from root

* refactor: iterate over previous data in mapped

* refactor: improve logic

* style: use `---` doc comments

* refactor: improve logic

* chore: housekeeping

* ci: add pnpm step

* ci: init submodules

* test: use lune

* refactor: improve structure and alien-signals integration

* ci: update test file path

* feat: add peek and roblox-ts types

* feat: add deep freeze flag, misc refactors

* refactor: reduce type casting, housekeeping

* refactor: rewrite untracked, update alien-signals

* chore: update eslint, housekeeping

* refactor: start charm-sync rewrite

* fix: send init payload even if atom did not update

* test: add all sync tests

* feat: prepare for alpha release

* feat: add peek, make untracked escape scope

* fix: wrap hooks in untracked, update types

* feat: add flag for inner effect tracking

* refactor: add docs, remove some modules

* refactor: align with alien-signals 3.0

* feat: add signal api

* refactor: update charm sync api

* feat: update alien-signals

* refactor: remove unnecessary features, update docs

* feat: finalize sync docs

* docs: update sync section

* docs: simplify examples

* docs: capitalize headers

* docs: add migration tips

* docs: fix whitespace

* docs: rephrase computed arg change

* refactor: rename batch, misc fixes & perf updates

* refactor: simplify charm sync validation

* feat: update alien-signals, add recursion flag

* feat: add `recursive()`

* fix: allow dispose in observers

* feat: add `trigger()`, refactor source

* docs: update readme

* chore: prepare release candidate

* test: make some tests more reliable

* docs: fix typo

* feat: add `reactive()`

* chore: bump versions

* docs: reword reactive docs

* docs: fix typo

* feat: add `toRaw()`

* fix: check for nil diffs

* chore: bump versions

* perf: do not create proxies for iteration

* fix: make `toRaw` track all calls

* fix: check none before patching mutable tables

* chore: bump charm-sync version

* docs: add fishing game example project

* feat: sync signals that return reactive proxy

* fix: refine reactive proxy logic

* fix: prevent early reactive gc, alien-signals 3.1.1

* fix: wrap iterated values in `reactive()`

* fix: loosen client signal types

* chore: bump release candidate

* fix: remove unsynced signals immediately

* test: use lute for tests

* chore: bump versions

* ci: set up lute

* refactor: improve source readability

* ci: upgrade lute

* build: loosen workspace version requirements

* chore: bump deps

* fix: update signal overload for setter (#58)

* fix: add missing recursed check

* test: add important vue reactivity tests

* chore: fix react tests, run stylua

* chore: update vide

* docs: improve intro and explain getters

* docs: adjust ordering by importance

* docs: move listen nesting note

* build: fix react peer dep for ci

* chore: update lockfile

* ci: use javascript eslint config

* ci: ignore eslint config file

* refactor: move test directories

* feat: allow recursion in effects by default

* release: charm v0.11.0-rc.4

* refactor: remove recursive()

* refactor: reorganize repo, create deep-charm

* docs: rephrase some sections

* feat: export getter and setter types

* docs: rephrase intro again

* feat!: run listen and subscribe callback in untracked

* refactor!: remove peek

* docs: note peek in migration guide

* release: charm v0.11.0-rc.5

* release: charm-sync v0.4.0-rc.7

* release: react-charm v0.4.0-rc.4

* fix: remove old keys when updating key in `mapped()`

* refactor: shorten error traceback, housekeeping

* refactor: keep error level in some cases

* fix: check if cleanup functions disposed effect

* refactor!: run effects in batched

* ci: check eslint and prettier

* perf: run observe fn in untracked

* perf: call mapper as-is in `mapped()`

* refactor: error for effect cleanup errors

* refactor: use new type solver

* ci: disable new solver flag until 0.714

* chore: housekeeping

* refactor: improve errors in nonstrict, optimize noyield

* chore: housekeeping

* refactor: satisfy new solver

* refactor: improve error traceback

* docs: link roblox signals

* chore: housekeeping

* perf: remove `clearPending` inline operation

* refactor: check type of cleanup

* ci: remove selene

* fix: always return pending value in signal setter

* test: add multi benchmark

* release: charm v0.11.0-rc.6

* test: add cleanup order tests

* chore: bump deps

* docs: add warning for deep-charm and note for `observe()`

---------

Co-authored-by: safazi <safazics@gmail.com>

packages/vide-charm/Charm.luau

@@ -0,0 +1 @@
+return require(script.Parent.Parent.charm.src)

packages/vide-charm/Vide.luau

@@ -0,0 +1 @@
+return require(script.Parent.Parent.vide.src)

packages/vide-charm/default.project.json

@@ -0,0 +1,6 @@
+{
+	"name": "vide-charm",
+	"tree": {
+		"$path": "src"
+	}
+}

packages/vide-charm/package.json

@@ -0,0 +1,30 @@
+{
+	"name": "@rbxts/vide-charm",
+	"version": "0.4.0-rc.4",
+	"description": "Vide bindings for Charm state management",
+	"license": "MIT",
+	"main": "src/init.luau",
+	"types": "src/index.d.ts",
+	"files": [
+		"src",
+		"*.luau",
+		"!wally.toml",
+		"!wally.lock",
+		"!default.project.json",
+		"!test"
+	],
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/littensy/charm.git"
+	},
+	"scripts": {
+		"prepare": "cp ../../LICENSE . && cp ../../README.md .",
+		"publish:wally": "wally publish"
+	},
+	"dependencies": {
+		"@rbxts/charm": "workspace:^"
+	},
+	"peerDependencies": {
+		"@rbxts/vide": "*"
+	}
+}

packages/vide-charm/src/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Returns a reactive source that subscribes to the current value of the given
+ * signal or getter function.
+ *
+ * @param getter The getter function to subscribe to.
+ * @return The reactive source.
+ */
+export function useSignalState<T>(getter: () => T, dependencies?: any[]): () => T;
+
+// Aliases
+export { useSignalState as useAtom };

packages/vide-charm/src/init.luau

@@ -0,0 +1,22 @@
+local Charm = require("./Charm")
+local Vide = require("./Vide")
+
+--[[
+	Returns a reactive source that subscribes to the current value of the given
+	signal or getter function.
+
+	@param getter The getter function to subscribe to.
+	@return The reactive source.
+]]
+local function useSignalState<State>(getter: () -> State): () -> State
+	local state = Vide.source(getter())
+
+	Vide.cleanup(Charm.listen(getter, state :: (State, State?) -> ()))
+
+	return state
+end
+
+return {
+	useSignalState = useSignalState,
+	useAtom = useSignalState,
+}

packages/vide-charm/test/init.luau

@@ -0,0 +1,7 @@
+local test = require("../../tests/test")
+
+test.describe("useSignalState", function()
+	require("@self/useSignalState.test")
+end)
+
+return {}

packages/vide-charm/test/useSignalState.test.luau

@@ -0,0 +1,59 @@
+local Charm = require("../Charm")
+local Vide = require("../Vide")
+local VideCharm = require("../src")
+local test = require("../../../tests/test")
+
+test("tracks signal state", function()
+	local getState, setState = Charm.signal(0)
+	local source: () -> number
+	local cleanup = Vide.root(function()
+		source = VideCharm.useSignalState(getState)
+	end)
+	assert(source() == 0, "should return 0")
+	setState(1)
+	assert(source() == 1, "should return 1")
+	cleanup()
+end)
+
+test("accepts a selector", function()
+	local getState, setState = Charm.signal(0)
+	local source: () -> number
+	local cleanup = Vide.root(function()
+		source = VideCharm.useSignalState(function()
+			return 2 * getState()
+		end)
+	end)
+	assert(source() == 0, "should return 0")
+	setState(1)
+	assert(source() == 2, "should return 2")
+	cleanup()
+end)
+
+test("updates source in untracked", function()
+	local getOuter, setOuter = Charm.signal(nil :: any)
+	local getInner, setInner = Charm.signal(0)
+	local spyCalls = 0
+	local cleanup = Vide.root(function()
+		return Vide.show(VideCharm.useSignalState(getOuter), function()
+			-- Charm effects created in Vide scopes triggered by useSignalState might
+			-- incorrectly get treated as an inner effect in useSignalState. This test
+			-- ensures that doesn't happen.
+			Vide.cleanup(Charm.effect(function()
+				getInner()
+				spyCalls += 1
+			end))
+			return nil
+		end)
+	end)
+	assert(spyCalls == 0, "should not call spy initially")
+	setOuter(true)
+	assert(spyCalls == 1, "should call spy when visible")
+	setInner(1)
+	assert(spyCalls == 2, "spy should run when counter updates")
+	setOuter({}) -- set to a truthy value to trigger an outer effect re-run
+	setInner(2)
+	assert(spyCalls == 3, "spy should still run when counter updates")
+	cleanup()
+end)
+
+return {}

packages/vide-charm/wally.toml

@@ -0,0 +1,17 @@
+[package]
+name = "littensy/vide-charm"
+version = "0.4.0-rc.5"
+registry = "https://github.com/UpliftGames/wally-index"
+realm = "shared"
+exclude = [
+	"node_modules",
+	"test",
+	"src/index.d.ts",
+	"package.json",
+	"Vide.luau",
+	"Charm.luau",
+]
+
+[dependencies]
+Charm = "littensy/charm@^0.11.0-rc.6"
+Vide = "centau/vide@^0.4"