@rbxts/replion 1.0.1 → 1.0.3

package/README.md

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

package/package.json

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

package/src/Client.lua

@@ -97,7 +97,7 @@ function Client:_applyUpdates(updates: Shared.GenericDataTable)
 			anyChanged = true
 			local signal = self._signals[key];
 			if signal then
-				signal:Fire(self.data[key], self.data[key]); -- Note: Sends improper 'old' argument due to shallow copy optimization.
+				signal:Fire(self.data[key], self.data[key]); -- Warning: Sends improper 'old' argument due to shallow copy optimization.
 			end;
 		elseif self.data[key] ~= oldValue then
 			anyChanged = true;

package/src/Server.lua

@@ -55,7 +55,7 @@ type Replion = typeof(setmetatable({}, Server));
 Server._activeReplions = {} :: { [Player]: { [string]: Replion } };
 Server._globalReplions = {} :: { [string]: Replion };
 
--- This method is private because this it isn't able to give correct types for the found Replion, and that's unideal for public use.
+-- Note: This method is private because this it isn't able to give correct types for the found Replion, and that's unideal for public use.
 function Server._getPlayerReplion(player: Player, channel: string)
 	local playerReplions = Server._activeReplions[player];
 	if not playerReplions then return nil; end;
@@ -63,7 +63,7 @@ function Server._getPlayerReplion(player: Player, channel: string)
 	return playerReplions[channel];
 end;
 
--- This method is private because this it isn't able to give correct types for the found Replion, and that's unideal for public use.
+-- Note: This method is private because this it isn't able to give correct types for the found Replion, and that's unideal for public use.
 function Server._getGlobalReplion(channel: string)
 	return Server._globalReplions[channel];
 end;

package/src/index.d.ts

@@ -1,20 +1,40 @@
-interface State<T> {
-    get(): T;
-    set(newValue: T): void;
-}
+import { Connection } from '@rbxts/sleitnick-signal';
+
+declare namespace Replion {
+	interface ServerConfig<T extends object> {
+		channel: string;
+		replicateTo?: Player;
+		data: T;
+	}
+
+	class Server<T extends object> {
+		constructor(config: ServerConfig<T>);
+
+		set<K extends keyof T>(key: K, value: T[K] | ((oldValue: T[K]) => T[K])): void;
+		set(path: string[], value: any | ((oldValue: any) => any)): void;
+
+		get(): T;
+		get<K extends keyof T>(key: K): T[K];
+		get(path: string[]): any;
+
+		destroy(): void;
+	}
+
+	class Client<T extends object> {
+		static waitForReplion<T extends object>(channel: string): Client<T>;
+
+		get(): T;
+		get<K extends keyof T>(key: K): T[K];
+		get(path: string[]): any;
+
+		observe(key: undefined, callback: (newValue: T, oldValue: T | undefined) => void): Connection;
+		observe<K extends keyof T>(
+			key: K,
+			callback: (newValue: T[K], oldValue: T[K] | undefined) => void,
+		): Connection;
 
-declare namespace Observers {
-    function state<T>(initialValue: T): State<T>;
-    function state<T>(): State<T | undefined>;
-
-    function observeAttribute<T extends AttributeValue>(instance: Instance, attribute: string, callback: (value: T | undefined) => (() => void) | void): () => void;
-    function observeState<T>(state: State<T>, callback: (value: T) => void): () => void;
-    function observePlayers(callback: (player: Player) => (() => void) | void): () => void;
-    function observeCharacters(callback: (char: Model, player: Player) => (() => void) | void): () => void;
-    function observeAttribute<T extends AttributeValue>(instance: Instance, attribute: string, callback: (value: T | undefined) => (() => void) | void): () => void;
-    function observeChildren(instance: Instance, callback: (child: Instance) => (() => void) | void): () => void;
-    function observeTag<T extends Instance>(tag: string, callback: (instance: T) => (() => void) | void, ancestors?: Instance[]): () => void;
-    function observeProperty<P extends Instance, K extends InstancePropertyNames<P>>(instance: P, property: K, callback: (value: P[K]) => (() => void) | void): () => void;
+		destroy(): void;
+	}
 }
 
-export = Observers;
+export = Replion;