Update Zirconium, fix history, fix auto focus, fix context logging

example/server/index.server.ts

@@ -51,8 +51,12 @@ ZirconServer.Registry.Init(
 		.CreateDefaultUserGroup()
 		.CreateDefaultAdminGroup()
 		.AddFunction(
-			new ZirconFunctionBuilder("ping").Bind((context) => {
-				context.LogInfo("Pong!");
+			new ZirconFunctionBuilder("ping").AddArgument("string?").Bind((context, response) => {
+				if (response !== undefined) {
+					context.LogInfo("Pong! with {Argument}", response);
+				} else {
+					context.LogInfo("Pong!");
+				}
 			}),
 			["User"],
 		)
@@ -78,7 +82,7 @@ ZirconServer.Registry.Init(
 				)
 				.AddFunction(ZirconPrint)
 				.AddFunction(
-					new ZirconFunctionBuilder("with_varadic")
+					new ZirconFunctionBuilder("with_variadic")
 						.AddArgument("string")
 						.AddArgument("player")
 						.AddArgument("number?")

package.json

@@ -57,6 +57,6 @@
     "@rbxts/snapdragon": "2.0.0-beta.1",
     "@rbxts/string-utils": "^1.0.3",
     "@rbxts/t": "^1.3.5",
-    "@rbxts/zirconium": "^1.1.0-beta.1"
+    "@rbxts/zirconium": "^1.1.0-beta.2"
   }
 }

src/Class/StatefulZirconValidator.ts

@@ -1,3 +1,5 @@
+import { ZrValue } from "@rbxts/zirconium/out/Data/Locals";
+import ZrUndefined from "@rbxts/zirconium/out/Data/Undefined";
 import { ZirconValidator } from "./ZirconTypeValidator";
 
 export abstract class StatefulZirconValidator<T, U = never> implements ZirconValidator<T, U> {

src/Class/ZirconContext.ts

@@ -4,6 +4,7 @@ import { DestructureMode, TemplateTokenKind } from "@rbxts/message-templates/out
 import ZrContext from "@rbxts/zirconium/out/Data/Context";
 import { RbxSerializer } from "@rbxts/message-templates/out/RbxSerializer";
 import { ZirconFunction } from "./ZirconFunction";
+import { $print } from "rbxts-transform-debug";
 
 export class ZirconContext {
 	constructor(private innerContext: ZrContext, private executingFunction: ZirconFunction<any, any>) {}
@@ -23,9 +24,10 @@ export class ZirconContext {
 		import("../Services/LogService").then((log) => {
 			const message: Writable<LogEvent> = {
 				Level: level,
-				SourceContext: undefined,
+				SourceContext: `(function '${this.executingFunction.GetName()}')`,
 				Template: template,
 				Timestamp: DateTime.now().ToIsoDate(),
+				LogToPlayer: this.GetExecutor(),
 			};
 
 			const tokens = MessageTemplateParser.GetTokens(template);
@@ -46,13 +48,7 @@ export class ZirconContext {
 				}
 			}
 
-			log.ZirconLogService.WriteStructured({
-				Level: level,
-				SourceContext: `(function '${this.executingFunction.GetName()}')`,
-				LogToPlayer: this.GetExecutor(),
-				Template: template,
-				Timestamp: DateTime.now().ToIsoDate(),
-			});
+			log.ZirconLogService.WriteStructured(message);
 		});
 	}
 

src/Class/ZirconFunction.ts

@@ -6,29 +6,45 @@ import ZrLuauFunction, { ZrLuauArgument } from "@rbxts/zirconium/out/Data/LuauFu
 import ZrPlayerScriptContext from "@rbxts/zirconium/out/Runtime/PlayerScriptContext";
 import { $env } from "rbxts-transform-env";
 import Server from "../Server";
-import { ZirconFunctionBuilder } from "./ZirconFunctionBuilder";
-import { InferArguments, Validator, ZirconValidator } from "./ZirconTypeValidator";
+import { InferArguments, ZirconValidator } from "./ZirconTypeValidator";
 import { ZirconContext } from "./ZirconContext";
+import ZrUndefined from "@rbxts/zirconium/out/Data/Undefined";
+import { $print } from "rbxts-transform-debug";
+
+let zirconTypeOf: typeof import("Shared/typeId")["zirconTypeOf"] | undefined;
 
 export function emitArgumentError(
 	func: ZirconFunction<any, any>,
 	context: ZrContext,
-	arg: number,
+	arg: ZrValue | ZrUndefined,
+	index: number,
 	validator: ZirconValidator<unknown, unknown>,
 ) {
+	const err = typeIs(validator.ErrorMessage, "function")
+		? validator.ErrorMessage(arg, index, func)
+		: validator.ErrorMessage;
+
+	// Have to dynamically import
+	if (zirconTypeOf === undefined) {
+		zirconTypeOf = import("Shared/typeId").expect().zirconTypeOf;
+	}
+
 	Server.Log.WriteStructured({
-		SourceContext: tostring(func),
+		SourceContext: `(function '${func.GetName()}')`,
 		Level: LogLevel.Error,
-		Template: `Call to {FunctionName} failed - Argument#{ArgIndex} expected {ArgType}`,
+		Template: `Argument #{ArgIndex} to '{FunctionName}': ${err ?? "Expected {ValidatorType}, got {ArgType}"}`,
 		Timestamp: DateTime.now().ToIsoDate(),
 		FunctionName: func.GetName(),
-		CallingPlayer: context.getExecutor()!,
-		ArgIndex: arg + 1,
-		ArgType: validator.Type,
+		FunctionArgs: func.GetArgumentTypes(),
+		FunctionVariadicArg: func.GetVariadicType(),
+		LogToPlayer: context.getExecutor(),
+		ArgIndex: index + 1,
+		ValidatorType: validator.Type,
+		ArgType: zirconTypeOf(arg),
 	});
 }
 
-export interface ZirconFunctionMetadata<V extends readonly ZirconValidator<unknown, unknown>[]> {
+export interface ZirconFunctionMetadata {
 	readonly Description?: string;
 	readonly ArgumentValidators: ZirconValidator<unknown, unknown>[];
 	readonly VariadicValidator?: ZirconValidator<unknown, unknown>;
@@ -41,7 +57,7 @@ export class ZirconFunction<
 	public constructor(
 		private name: string,
 		private zirconCallback: (context: ZirconContext, ...args: InferArguments<V>) => R,
-		private metadata: ZirconFunctionMetadata<V>,
+		private metadata: ZirconFunctionMetadata,
 	) {
 		const { VariadicValidator, ArgumentValidators } = metadata;
 		super((context, ...args) => {
@@ -63,11 +79,8 @@ export class ZirconFunction<
 						}
 					} else {
 						if (RunService.IsServer()) {
-							emitArgumentError(this, context, i, validator);
-
-							if ($env("NODE_ENV") === "development") {
-								print("Got", argument);
-							}
+							emitArgumentError(this, context, argument, i, validator);
+							$print("Got", argument);
 						}
 						return;
 					}
@@ -87,10 +100,8 @@ export class ZirconFunction<
 						}
 					} else {
 						if (RunService.IsServer()) {
-							emitArgumentError(this, context, i, VariadicValidator);
-							if ($env("NODE_ENV") === "development") {
-								print("Got", argument);
-							}
+							emitArgumentError(this, context, argument, i, VariadicValidator);
+							$print("Got", argument);
 						}
 						return;
 					}
@@ -144,8 +155,4 @@ export class ZirconFunction<
 			") { [ZirconFunction] }"
 		);
 	}
-
-	public static args<V extends readonly Validator[]>(...value: V) {
-		return value;
-	}
 }

src/Class/ZirconTypeValidator.ts

@@ -14,6 +14,7 @@ import {
 import { ZirconFuzzyPlayers } from "./Validators/ZirconFuzzyPlayersValidator";
 import ZrRange from "@rbxts/zirconium/out/Data/Range";
 import { ZirconFunction } from "./ZirconFunction";
+import { zirconTypeOf } from "Shared/typeId";
 
 type PickFrom<T, U> = U extends never ? T : U;
 export interface ZirconValidator<T, U = never> {
@@ -26,6 +27,7 @@ export interface ZirconValidator<T, U = never> {
 	 */
 	Validate(value: unknown, player?: Player): value is T;
 	Transform?(value: T, player?: Player): U;
+	ErrorMessage?: ((arg: ZrValue | ZrUndefined, index: number, func: ZirconFunction<any, any>) => string) | string;
 }
 
 export interface ZirconArgument<T extends Validator> {
@@ -45,41 +47,47 @@ export const ZirconString: ZirconValidator<string> = {
 	Validate(value): value is string {
 		return typeIs(value, "string");
 	},
+	ErrorMessage: (value) => `Expected string, got ${zirconTypeOf(value)}`,
 };
 
 export const ZirconNumber: ZirconValidator<number> = {
 	Type: "number",
 	Validate(value): value is number {
 		return typeIs(value, "number");
 	},
+	ErrorMessage: (value) => `Expected number, got ${zirconTypeOf(value)}`,
 };
 
 export const ZirconBoolean: ZirconValidator<boolean> = {
 	Type: "boolean",
 	Validate(value): value is boolean {
 		return typeIs(value, "number");
 	},
+	ErrorMessage: (value) => `Expected boolean, got ${zirconTypeOf(value)}`,
 };
 
 export const ZirconObject: ZirconValidator<ZrObject> = {
 	Type: "object",
 	Validate(value): value is ZrObject {
 		return value instanceof ZrObject;
 	},
+	ErrorMessage: (value) => `Expected object, got ${zirconTypeOf(value)}`,
 };
 
 export const NativeEnum: ZirconValidator<ZrEnum> = {
 	Type: "ZrEnum",
 	Validate(value: unknown): value is ZrEnum {
 		return value instanceof ZrEnum;
 	},
+	ErrorMessage: (value) => `Expected enum, got ${zirconTypeOf(value)}`,
 };
 
 export const NativeEnumItem: ZirconValidator<ZrEnumItem> = {
 	Type: "ZrEnumItem",
 	Validate(value: unknown): value is ZrEnumItem {
 		return value instanceof ZrEnumItem;
 	},
+	ErrorMessage: (value) => `Expected enum item, got ${zirconTypeOf(value)}`,
 };
 
 export function ZirconOptional<K extends ZirconValidator<ZrValue, unknown>>(validator: K) {
@@ -114,6 +122,7 @@ export const ZirconDefined: ZirconValidator<ZrValue> = {
 	Validate(value: unknown): value is ZrValue {
 		return value !== ZrUndefined && value !== undefined;
 	},
+	ErrorMessage: (value) => `Expected defined, got ${zirconTypeOf(value)}`,
 };
 
 export const ZirconRange: ZirconValidator<ZrRange | number, ZrRange> = {
@@ -128,6 +137,7 @@ export const ZirconRange: ZirconValidator<ZrRange | number, ZrRange> = {
 			return value;
 		}
 	},
+	ErrorMessage: (value) => `Expected range, got ${zirconTypeOf(value)}`,
 };
 
 export function ZirconInstanceIsA<K extends keyof Instances>(typeName: K) {
@@ -139,6 +149,7 @@ export function ZirconInstanceIsA<K extends keyof Instances>(typeName: K) {
 		Transform(value) {
 			return value.value() as Instances[K];
 		},
+		ErrorMessage: (value) => `Expected Instance, got ${zirconTypeOf(value)}`,
 	});
 }
 

src/Client/BuiltInConsole/UI/DockedConsole.tsx

@@ -16,6 +16,7 @@ import { Workspace } from "@rbxts/services";
 import Padding from "Client/Components/Padding";
 import SearchTextBox from "Client/Components/SearchTextBox";
 import MultiSelectDropdown from "Client/Components/MultiSelectDropdown";
+import { $print } from "rbxts-transform-debug";
 
 export interface DockedConsoleProps extends MappedProps, MappedDispatch {}
 interface DockedConsoleState {
@@ -293,7 +294,9 @@ class ZirconConsoleComponent extends Roact.Component<DockedConsoleProps, DockedC
 										OnClick={() => {}}
 									/>
 									<ZirconSyntaxTextBox
+										RefocusOnSubmit={this.props.autoFocus}
 										AutoFocus={this.props.autoFocus}
+										PlaceholderText="Enter script to execute"
 										Size={new UDim2(1, -16 - 32 - 100, 1, 0)}
 										Position={new UDim2(0, 16, 0, 0)}
 										Focused={this.state.isVisible}
@@ -305,19 +308,32 @@ class ZirconConsoleComponent extends Roact.Component<DockedConsoleProps, DockedC
 										}}
 										OnHistoryTraversal={(direction) => {
 											let index = this.state.historyIndex;
+
+											const history = this.props.history;
+											let text = "";
 											if (direction === "back") {
-												index = this.state.historyIndex - 1;
+												if (index <= 0) {
+													index = history.size() - 1;
+												} else {
+													index = index - 1;
+												}
+
+												text = history[index];
 											} else if (direction === "forward") {
-												index = this.state.historyIndex + 1;
+												if (index >= history.size() - 1) {
+													index = 0;
+												} else {
+													index = index + 1;
+												}
+
+												text = history[index];
 											}
 
-											print("[historyTraversal]", direction);
+											$print("[historyTraversal]", direction, text, history);
 
 											this.setState({
 												historyIndex: index,
-												source: this.props.history[
-													index < 0 ? this.props.history.size() - index : index
-												],
+												source: text,
 											});
 										}}
 									/>