factorio-clusterio/packages/lib/src/data/messages_host.ts

import { Type, Static } from "@sinclair/typebox";
import { jsonArray, plainJson, StringEnum } from "./composites";
import { CollectorResultSerialized } from "../prometheus";
import { HostConfig } from "../config/definitions";

export class HostStopRequest {
	declare ["constructor"]: typeof HostStopRequest;
	static type = "request" as const;
	static src = ["control", "controller"] as const;
	static dst = "host" as const;
	static permission = "core.host.stop" as const;
}

export class HostRestartRequest {
	declare ["constructor"]: typeof HostRestartRequest;
	static type = "request" as const;
	static src = ["control", "controller"] as const;
	static dst = "host" as const;
	static permission = "core.host.restart" as const;
}

export class HostConfigGetRequest {
	declare ["constructor"]: typeof HostConfigGetRequest;
	static type = "request" as const;
	static src = ["control", "controller"] as const;
	static dst = "host" as const;
	static permission = "core.host.get_config" as const;
	static Response = plainJson(HostConfig.jsonSchema);
}

export class HostConfigSetFieldRequest {
	declare ["constructor"]: typeof HostConfigSetFieldRequest;
	static type = "request" as const;
	static src = ["control", "controller"] as const;
	static dst = "host" as const;
	static permission = "core.host.update_config" as const;

	constructor(
		public field: string,
		public value: string,
	) { }

	static jsonSchema = Type.Object({
		"field": Type.String(),
		"value": Type.String(),
	});

	static fromJSON(json: Static<typeof this.jsonSchema>) {
		return new this(json.field, json.value);
	}
}

export class HostConfigSetPropRequest {
	declare ["constructor"]: typeof HostConfigSetPropRequest;
	static type = "request" as const;
	static src = ["control", "controller"] as const;
	static dst = "host" as const;
	static permission = "core.host.update_config" as const;

	constructor(
		public field: string,
		public prop: string,
		public value?: unknown,
	) { }

	static jsonSchema = Type.Object({
		"field": Type.String(),
		"prop": Type.String(),
		"value": Type.Optional(Type.Unknown()),
	});

	static fromJSON(json: Static<typeof this.jsonSchema>) {
		return new this(json.field, json.prop, json.value);
	}
}

export class HostDetails {
	constructor(
		public version: string,
		public name: string,
		public id: number,
		public connected: boolean,
		public remoteAddress = "",
		public publicAddress: string = "",
		public tokenValidAfter: number = 0,
		/** Millisecond Unix timestamp this entry was last updated at */
		public updatedAtMs = 0,
		public isDeleted = false,
	) { }

	static jsonSchema = Type.Object({
		"version": Type.String(),
		"name": Type.String(),
		"id": Type.Integer(),
		"connected": Type.Boolean(),
		"remoteAddress": Type.Optional(Type.String()),
		"publicAddress": Type.Optional(Type.String()),
		"tokenValidAfter": Type.Optional(Type.Number()),
		"updatedAtMs": Type.Optional(Type.Number()),
		"isDeleted": Type.Optional(Type.Boolean()),
	});

	static fromJSON(json: Static<typeof this.jsonSchema>) {
		return new this(
			json.version,
			json.name,
			json.id,
			json.connected,
			json.remoteAddress,
			json.publicAddress,
			json.tokenValidAfter,
			json.updatedAtMs,
			json.isDeleted,
		);
	}
}

export class HostListRequest {
	declare ["constructor"]: typeof HostListRequest;
	static type = "request" as const;
	static src = "control" as const;
	static dst = "controller" as const;
	static permission = "core.host.list" as const;
	static Response = jsonArray(HostDetails);
}

export class HostInfoUpdate {
	constructor(
		public name: string,
		public publicAddress: string,
	) { }

	static jsonSchema = Type.Object({
		"name": Type.String(),
		"publicAddress": Type.String(),
	});

	static fromJSON(json: Static<typeof this.jsonSchema>) {
		return new this(
			json.name,
			json.publicAddress,
		);
	}
}

export class HostInfoUpdateEvent {
	declare ["constructor"]: typeof HostInfoUpdateEvent;
	static type = "event" as const;
	static src = "host" as const;
	static dst = "controller" as const;

	constructor(
		public update: HostInfoUpdate,
	) { }

	static jsonSchema = Type.Object({
		"update": HostInfoUpdate.jsonSchema,
	});

	static fromJSON(json: Static<typeof this.jsonSchema>) {
		return new this(HostInfoUpdate.fromJSON(json.update));
	}
}

export class HostUpdatesEvent {
	declare ["constructor"]: typeof HostUpdatesEvent;
	static type = "event" as const;
	static src = "controller" as const;
	static dst = "control" as const;
	static permission = "core.host.subscribe" as const;

	constructor(
		public updates: HostDetails[],
	) { }

	static jsonSchema = Type.Object({
		"updates": Type.Array(HostDetails.jsonSchema),
	});

	static fromJSON(json: Static<typeof this.jsonSchema>) {
		return new this(json.updates.map(update => HostDetails.fromJSON(update)));
	}
}

export class HostMetricsRequest {
	declare ["constructor"]: typeof HostMetricsRequest;
	static type = "request" as const;
	static src = "controller" as const;
	static dst = "host" as const;
	static Response = class Response { // TODO: Use JSON class pattern in Prometheus
		constructor(
			public results: CollectorResultSerialized[],
		) { }

		static jsonSchema = Type.Object({
			"results": Type.Array(CollectorResultSerialized),
		});

		static fromJSON(json: Static<typeof this.jsonSchema>) {
			return new this(json.results);
		}
	};
}

export class ControllerConnectionEvent {
	declare ["constructor"]: typeof ControllerConnectionEvent;
	static type = "event" as const;
	static src = "host" as const;
	static dst = "instance" as const;

	constructor(
		public event: "connect" | "drop" | "resume" | "close",
	) { }

	static jsonSchema = Type.Object({
		"event": StringEnum(["connect", "drop", "resume", "close"]),
	});

	static fromJSON(json: Static<typeof this.jsonSchema>) {
		return new this(json.event);
	}
}

export class PrepareControllerDisconnectRequest {
	declare ["constructor"]: typeof PrepareControllerDisconnectRequest;
	static type = "request" as const;
	static src = "host" as const;
	static dst = "instance" as const;
}

export class SyncUserListsEvent {
	declare ["constructor"]: typeof SyncUserListsEvent;
	static type = "event" as const;
	static src = "controller" as const;
	static dst = "host" as const;

	constructor(
		public adminlist: Set<string>,
		public banlist: Map<string, string>,
		public whitelist: Set<string>,
	) { }

	static jsonSchema = Type.Object({
		"adminlist": Type.Array(Type.String()),
		"banlist": Type.Array(
			Type.Tuple([Type.String(), Type.String()])
		),
		"whitelist": Type.Array(Type.String()),
	});

	static fromJSON(json: Static<typeof this.jsonSchema>) {
		return new this(new Set(json.adminlist), new Map(json.banlist), new Set(json.whitelist));
	}

	toJSON() {
		return {
			adminlist: [...this.adminlist],
			banlist: [...this.banlist],
			whitelist: [...this.whitelist],
		};
	}
}

export class HostRevokeTokensRequest {
	declare["constructor"]: typeof HostRevokeTokensRequest;
	static type = "request" as const;
	static src = "control" as const;
	static dst = "controller" as const;
	static permission = "core.host.revoke_token" as const;

	constructor(
		public hostId: number,
	) { }

	static jsonSchema = Type.Object({
		"hostId": Type.Number(),
	});

	static fromJSON(json: Static<typeof this.jsonSchema>) {
		return new this(json.hostId);
	}
}