@rbxts/replion 1.0.18 → 1.0.19

package/README.md

@@ -2,4 +2,4 @@
 
 ## Install
 Install with [wally](https://wally.run/):\
-`Replion = "shouxtech/replion@1.0.18"`
+`Replion = "shouxtech/replion@1.0.19"`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rbxts/replion",
-  "version": "1.0.18",
+  "version": "1.0.19",
   "description": "",
   "main": "src/init.lua",
   "scripts": {},

package/src/BaseReplion.lua

@@ -1,11 +1,12 @@
 --!strict
-export type GenericDataTable = { [string]: any };
-
 local isTypeScriptEnv = script.Parent.Name == 'src';
 local dependencies = if isTypeScriptEnv then script.Parent.Parent.Parent else script.Parent.Parent;
 local Shared = require(script.Parent.Shared);
 local Signal = require(isTypeScriptEnv and dependencies['sleitnick-signal'] or dependencies.Signal);
 
+export type GenericDataTable = { [string]: any };
+export type Observer = (newValue: any, oldValue: any) -> ();
+
 local BaseReplion = {};
 BaseReplion.__index = BaseReplion;
 
@@ -25,10 +26,12 @@ function BaseReplion:get(path: { string }?)
 	return Shared.getNestedValue(self.data, path);
 end;
 
-function BaseReplion:observe(path: { string }?, callback: (any, any) -> ())
+function BaseReplion:subscribe(path: { string }?, callback: Observer)
 	if not path then
-		task.spawn(callback, self.data, nil);
-		return self._allSignal:Connect(callback);
+		local connection = self._allSignal:Connect(callback);
+		return function()
+			connection:Disconnect()
+		end;
 	end;
 
 	local signalKey = Shared.getSignalKey(path);
@@ -36,15 +39,24 @@ function BaseReplion:observe(path: { string }?, callback: (any, any) -> ())
 		self._signals[signalKey] = Signal.new();
 	end;
 
-	local initialValue = Shared.getNestedValue(self.data, path);
-
-	task.spawn(callback, initialValue, nil);
 	local connection = self._signals[signalKey]:Connect(callback);
+	
 	return function()
 		connection:Disconnect();
 	end;
 end;
 
+function BaseReplion:observe(path: { string }?, callback: Observer)
+	if path then
+		local initialValue = Shared.getNestedValue(self.data, path);
+		task.spawn(callback, initialValue, nil);
+	else
+		task.spawn(callback, self.data, nil);
+	end;
+
+	return self:subscribe(path, callback);
+end;
+
 function BaseReplion:destroy()
 	self._allSignal:Destroy();
 	for _, signal in self._signals do

package/src/Client.lua

@@ -5,7 +5,6 @@ local BaseReplion = require(script.Parent.BaseReplion)
 local Shared = require(script.Parent.Shared);
 local Signal = require(isTypeScriptEnv and dependencies['sleitnick-signal'] or dependencies.Signal);
 
-type Observer = (newValue: any, oldValue: any) -> ();
 type Deletion = { path: { string }, oldTable: any };
 
 local remote = script.Parent:WaitForChild(Shared.REMOTE_NAME) :: RemoteEvent;
@@ -49,7 +48,7 @@ function Client.waitForReplion(channel: string)
 	return replion;
 end;
 
-function Client.new(channel: string, data: Shared.GenericDataTable)
+function Client.new(channel: string, data: BaseReplion.GenericDataTable)
 	local self = setmetatable({}, Client);
 
 	self.channel = channel;
@@ -63,7 +62,11 @@ function Client:get(path: { string }?)
 	return self._base:get(path);
 end;
 
-function Client:observe(path: { string }?, callback: Observer)
+function Client:subscribe(path: { string }?, callback: BaseReplion.Observer)
+	return self._base:subscribe(path, callback);
+end;
+
+function Client:observe(path: { string }?, callback: BaseReplion.Observer)
 	return self._base:observe(path, callback);
 end;
 
@@ -123,7 +126,7 @@ function Client:_notifyRecursiveUpdates(currentPath: { string }, updateTree: any
 	end;
 end;
 
-function Client:_applyUpdates(updates: Shared.GenericDataTable)
+function Client:_applyUpdates(updates: BaseReplion.GenericDataTable)
 	local deletions: { Deletion } = {};
 	self:_collectDeletions(self._base.data, updates, {}, deletions);
 

package/src/Server.lua

@@ -10,9 +10,8 @@ local Sift = require(isTypeScriptEnv and dependencies.sift.out or dependencies.S
 type ServerConfig = {
 	channel: string;
 	replicateTo: Player?;
-	data: Shared.GenericDataTable;
+	data: BaseReplion.GenericDataTable;
 };
-type Observer = (newValue: any, oldValue: any) -> ();
 
 local remote = script.Parent:FindFirstChild(Shared.REMOTE_NAME) :: RemoteEvent;
 if not remote then
@@ -79,7 +78,7 @@ function Server.new(config: ServerConfig)
 	
 	self._base = BaseReplion.new(Sift.Dictionary.copyDeep(config.data));
 
-	self._queuedUpdates = {} :: Shared.GenericDataTable;
+	self._queuedUpdates = {} :: BaseReplion.GenericDataTable;
 	self._isQueued = false;
 	self._destroyed = false;
 
@@ -97,7 +96,11 @@ function Server.new(config: ServerConfig)
 	return self;
 end;
 
-function Server:observe(path: { string }?, callback: Observer)
+function Server:subscribe(path: { string }?, callback: BaseReplion.Observer)
+	return self._base:subscribe(path, callback);
+end;
+
+function Server:observe(path: { string }?, callback: BaseReplion.Observer)
 	return self._base:observe(path, callback);
 end;
 

package/src/Shared.lua

@@ -1,6 +1,4 @@
 --!strict
-export type GenericDataTable = { [string]: any };
-
 local Shared = {};
 
 Shared.REMOTE_NAME = 'ReplionNetwork';

package/src/index.d.ts

@@ -6,7 +6,6 @@ declare namespace Replion {
 	type Path<T> = T extends object
 		? { [K in keyof T & string]: [K] | [K, ...Path<T[K]>] }[keyof T & string]
 		: never;
-
 	/**
 	 * Resolves the type of the value at a specific path P within object T.
 	 */
@@ -30,6 +29,12 @@ declare namespace Replion {
 		get(): T;
 		get<P extends Path<T>>(path: P): PathValue<T, P>;
 
+		subscribe(key: undefined, callback: (newValue: T, oldValue: Partial<T>) => void): Cleanup;
+		subscribe<P extends Path<T>>(
+			path: P,
+			callback: (newValue: PathValue<T, P>, oldValue: PathValue<T, P> | undefined) => void,
+		): Cleanup;
+
 		observe(key: undefined, callback: (newValue: T, oldValue: Partial<T>) => void): Cleanup;
 		observe<P extends Path<T>>(
 			path: P,