rename 'GetCallbackProxy' type to 'SchemaCallbackProxy<RoomState>'

Author: endel

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colyseus/schema",
-  "version": "3.0.14",
+  "version": "3.0.15",
   "description": "Binary state serializer with delta encoding for games",
   "bin": {
     "schema-codegen": "./bin/schema-codegen",

src/decoder/strategy/StateCallbacks.ts

@@ -17,7 +17,7 @@ import type { CollectionSchema } from "../../types/custom/CollectionSchema";
 // - Avoid closures by allowing to pass a context. (https://github.com/colyseus/schema/issues/155#issuecomment-1804694081)
 //
 
-export type GetCallbackProxy = (<T extends Schema>(instance: T) => CallbackProxy<T>);
+export type SchemaCallbackProxy<RoomState> = (<T extends Schema>(instance: T) => CallbackProxy<T>);
 
 export type CallbackProxy<T> = unknown extends T // is "any"?
     ? SchemaCallback<T> & CollectionCallback<any, any>
@@ -99,7 +99,7 @@ type CallContext = {
 }
 
 
-export function getDecoderStateCallbacks<T extends Schema>(decoder: Decoder<T>): GetCallbackProxy {
+export function getDecoderStateCallbacks<T extends Schema>(decoder: Decoder<T>): SchemaCallbackProxy<T> {
     const $root = decoder.root;
     const callbacks = $root.callbacks;
 

src/index.ts

@@ -45,11 +45,11 @@ export { TypeContext } from "./types/TypeContext";
 // Annotation types
 export type { DefinitionType, PrimitiveType, Definition, } from "./annotations";
 
-export { getDecoderStateCallbacks, CallbackProxy, SchemaCallback, CollectionCallback } from "./decoder/strategy/StateCallbacks";
+export { getDecoderStateCallbacks, CallbackProxy, SchemaCallback, CollectionCallback, SchemaCallbackProxy } from "./decoder/strategy/StateCallbacks";
 export { getRawChangesCallback } from "./decoder/strategy/RawChanges";
 
 export { Encoder } from "./encoder/Encoder";
-export { encodeSchemaOperation, encodeArray as encodeKeyValueOperation } from "./encoder/EncodeOperation";
+export { encodeSchemaOperation, encodeArray, encodeKeyValueOperation } from "./encoder/EncodeOperation";
 export { ChangeTree, Ref } from "./encoder/ChangeTree";
 export { StateView } from "./encoder/StateView";
 

test/callbacks/StateCallbacks.test.ts

@@ -2,9 +2,28 @@ import * as assert from "assert";
 
 import { Schema, type, ArraySchema, MapSchema, getDecoderStateCallbacks, decodeSchemaOperation, Decoder } from "../../src";
 import { createInstanceFromReflection, getCallbacks, getDecoder } from "../Schema";
+import { SchemaCallbackProxy } from "../../src/decoder/strategy/StateCallbacks";
 
 describe("StateCallbacks", () => {
 
+    it("TypeScript type inference", () => {
+        class Item extends Schema {
+            @type("number") amount: number;
+        }
+        class State extends Schema {
+            @type([Item]) items = new ArraySchema<Item>();
+            @type('int64') actionType: number;
+        }
+        const state = new State();
+        const decodedState = createInstanceFromReflection(state);
+        const decoder = getDecoder(decodedState);
+
+        const $ = getDecoderStateCallbacks(decoder);
+        const ref$: SchemaCallbackProxy<State> = $;
+
+        assert.strictEqual($, ref$);
+    });
+
     it("should trigger changes in order they've been originally made", () => {
         class State extends Schema {
             @type(['string']) boardTiles = new ArraySchema<string>();