refactor: refine types and code

src/__tests__/sync/client.spec.luau

@@ -7,7 +7,7 @@ return function()
 		local client = sync.client({ atoms = { a = a } })
 
 		client:sync({
-			type = "set",
+			type = "init",
 			data = { a = 2 },
 		})
 

src/__tests__/sync/server.spec.luau

@@ -17,7 +17,7 @@ return function()
 		server:hydrate(target)
 
 		expect(player).to.equal(target)
-		expect(payload.type).to.equal("set")
+		expect(payload.type).to.equal("init")
 		expect(payload.data.a).to.equal(1)
 
 		disconnect()

src/index.d.ts

@@ -76,34 +76,36 @@ declare namespace Charm {
 	// Sync
 
 	const sync: {
-		client(options: ClientOptions): ClientSyncer;
+		client: <T extends Record<string, Atom<any>>>(options: ClientOptions<T>) => ClientSyncer<T>;
-		server(options: ServerOptions): ServerSyncer;
+		server: <T extends Record<string, Atom<any>>>(options: ServerOptions<T>) => ServerSyncer<T>;
+		collect: (root: Instance) => Record<string, Atom<any>>;
 	};
 
-	interface SyncPatch {
+	interface None {
-		[key: string | number | symbol]: SyncPatch | { __none: "__none" } | string | number | boolean | undefined;
+		__none: "__none";
 	}
 
-	interface SyncPayload {
+	type SyncPatch<T> = {
-		type: "set" | "patch";
+		readonly [P in keyof T]?: (T[P] extends object ? SyncPatch<T[P]> : T[P]) | (T[P] extends undefined ? None : never);
-		data: SyncPatch;
+	};
+
+	type SyncPayload<T> = { type: "init"; data: T } | { type: "patch"; data: SyncPatch<T> };
+
+	interface ClientOptions<T extends Record<string, Atom<any>>> {
+		atoms: T;
 	}
 
-	interface ClientOptions {
+	interface ServerOptions<T extends Record<string, Atom<any>>> {
-		atoms: Record<string, Atom<any>>;
+		atoms: T;
-	}
-
-	interface ServerOptions {
-		atoms: Record<string, Atom<any>>;
 		interval?: number;
 	}
 
-	interface ClientSyncer {
+	interface ClientSyncer<T extends Record<string, Atom<any>>> {
-		sync(payload: SyncPayload): void;
+		sync(payload: SyncPayload<T>): void;
 	}
 
-	interface ServerSyncer {
+	interface ServerSyncer<T extends Record<string, Atom<any>>> {
-		connect(callback: (player: Player, payload: SyncPayload) => void): Cleanup;
+		connect(callback: (player: Player, payload: SyncPayload<T>) => void): Cleanup;
 		hydrate(player: Player): void;
 	}
 }

src/init.luau

@@ -21,16 +21,16 @@ export type SyncPayload = types.SyncPayload
 
 return {
 	atom = atom,
+	capture = capture,
 	derive = derive,
 	effect = effect,
 	isAtom = isAtom,
 	map = map,
 	observe = observe,
-	subscribe = subscribe,
-	unwrap = unwrap,
-	capture = capture,
-	sync = sync,
 	useAtom = useAtom,
 	useAtomState = useAtomState,
 	useSetAtom = useSetAtom,
+	subscribe = subscribe,
+	sync = sync,
+	unwrap = unwrap,
 }

src/sync/server.luau

@@ -42,10 +42,12 @@ local function server(options: ServerOptions): ServerSyncer
 			state = getState()
 
 			if state ~= previous then
+				local diffs = patch.diff(previous, state)
+
 				for _, player in Players:GetPlayers() do
 					callback(player, {
 						type = "patch",
-						data = patch.diff(previous, state),
+						data = diffs,
 					})
 				end
 			end
@@ -66,7 +68,7 @@ local function server(options: ServerOptions): ServerSyncer
 		assert(sync, "connect() must be called before hydrate()")
 
 		sync(player, {
-			type = "set",
+			type = "init",
 			data = getState(),
 		})
 	end

src/types.luau

@@ -9,7 +9,7 @@ export type AtomOptions<T> = {
 }
 
 export type SyncPayload = {
-	type: "patch" | "set",
+	type: "patch" | "init",
 	data: { [any]: any },
 }