@rbxts/scribe-vide 2.6.0 → 2.6.1

package/Scribe-source-map.json

@@ -1 +1 @@
-{"version":"2.6.0","format":1,"description":"Segments are [packedLine, sourceLine]. Use the last segment at or before the packed line, then add its line offset.","files":{"addons/ui/ScribeVide.luau":{"sourceSha256":"123e57abd02f0767479a2798e7a60d05a9c5ea88c59736fb971ccb17327af5a1","packedSha256":"123e57abd02f0767479a2798e7a60d05a9c5ea88c59736fb971ccb17327af5a1","segments":[[1,1]],"packagePath":"init.luau"}}}
+{"version":"2.6.1","format":1,"description":"Segments are [packedLine, sourceLine]. Use the last segment at or before the packed line, then add its line offset.","files":{"addons/ui/ScribeVide.luau":{"sourceSha256":"38acf84ef3e9d2facf76e91dfd06844e6f52f498f0aae70f8f5a69f1b5815793","packedSha256":"38acf84ef3e9d2facf76e91dfd06844e6f52f498f0aae70f8f5a69f1b5815793","segments":[[1,1]],"packagePath":"init.luau"}}}

package/index.d.ts

@@ -5,8 +5,9 @@ import type Scribe from "@rbxts/scribe";
 declare function ScribeVide(vide: Pick<typeof Vide, "source">): ScribeVide.Adapter;
 
 declare namespace ScribeVide {
-	/** Register the returned disconnect with vide.cleanup inside the owning scope. */
-	type Adapter = <T>(this: void, accessor: Scribe.ReadableNode<T>) => LuaTuple<[Vide.Source<T>, () => void]>;
+	type Adapter =
+		/** Tracks an accessor in a source; register the disconnect with vide.cleanup. */
+		<T>(this: void, accessor: Scribe.ReadableNode<T>) => LuaTuple<[Vide.Source<T>, () => void]>;
 }
 
 export = ScribeVide;

package/init.luau

@@ -1,15 +1,41 @@
 --!strict
 -- Vide adapter. Copy into your game; not part of the Scribe package.
 --   local useScribe = require(path.to.ScribeVide)(vide)
---   local coins, disconnect = useScribe(Data.Coins)
+--   local coins, disconnect = useScribe(Data.Coins) -- coins: Source<number>
+-- Nullable or any-typed reads need a getter cast: (score :: () -> number?)().
 
 export type Disconnect = () -> ()
 
-return function(vide: any)
-	--- A source tracking one accessor. Hand the disconnect to `vide.cleanup`.
-	return function(accessor: any): (any, Disconnect)
-		local source = vide.source(accessor.Get())
-		local disconnect = accessor.Observe(source)
+export type Readable<T> = {
+	--[[
+	Returns the current value.
+	]]
+	read Get: () -> T,
+	--[[
+	Runs now and on each change; returns a disconnect function.
+	]]
+	read Observe: (callback: (value: T) -> ()) -> Disconnect,
+}
+
+-- Matches Vide's getter/setter overloads.
+export type Source<T> = (() -> T) & ((value: T) -> T)
+
+export type Vide = {
+	read source: (value: any) -> any,
+}
+
+--[[
+Creates a Vide adapter for Scribe accessors.
+]]
+return function(vide: Vide)
+	--[[
+	Tracks an accessor; pass the returned disconnect to vide.cleanup.
+	]]
+	return function<T>(accessor: Readable<T>): (Source<T>, Disconnect)
+		local source: Source<T> = vide.source(accessor.Get())
+		local disconnect = accessor.Observe(function(value)
+			source(value)
+		end)
 		return source, disconnect
 	end
 end

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rbxts/scribe-vide",
-  "version": "2.6.0",
+  "version": "2.6.1",
   "description": "Optional vide addon for Scribe",
   "main": "init.luau",
   "types": "index.d.ts",
@@ -12,7 +12,7 @@
   "homepage": "https://scribe.ericplane.dev/",
   "author": "ericplane",
   "peerDependencies": {
-    "@rbxts/scribe": "^2.6.0",
+    "@rbxts/scribe": "^2.6.1",
     "@rbxts/vide": "^0.6.1"
   },
   "publishConfig": {