Port packages/web_ui to TypeScript (#508)

* .jsx to .tsx

* controller: tsc --build before webpack-cli

* Type Annotation

* disabled move into the <Input/> and <Checkbox/>

* cleanup debug left over

* documentation

* default ModPack

* modPackUpdateHandlers no undefined

* PluginInfo changes proposition

* PluginInfo changes proposition miss

* ModRecord & ModInfo feedback loop at const mods = [ ?

* ["connect", "drop", "resume", "close"] as const

* .tsx to .ts when possible
This commit is contained in:
Luciole authored and GitHub committed 2023-09-02 14:51:35 +02:00
1 parent a4893751e9
commit 838170a9ff
92 files changed
+1104 -707

No files matched your search

@@ -1,3 +1,5 @@
import type { Control } from "../util/websocket";
import React, { useEffect, useState } from "react";
import { BrowserRouter } from "react-router-dom";
@@ -13,7 +15,10 @@ import { Card, ConfigProvider, Spin, Typography, theme } from "antd";
const { Paragraph } = Typography;
function ErrorCard(props) {
export type ErrorProps = {
error: Error;
};
function ErrorCard(props: ErrorProps) {
return <div className="login-container">
<Card>
<h1>An unexpected error occured</h1>
@@ -22,7 +27,11 @@ function ErrorCard(props) {
</div>;
}
export default function App(props) {
type AppProps = {
control: Control;
};
export default function App(props: AppProps) {
let [connected, setConnected] = useState(false);
let [token, setToken] = useState(localStorage.getItem("controller_token") || null);
let connector = props.control.connector;
@@ -35,7 +44,11 @@ export default function App(props) {
useEffect(() => {
function onConnect() {
localStorage.setItem("controller_token", token);
if (token === null) {
localStorage.removeItem("controller_token");
} else {
localStorage.setItem("controller_token", token);
}
setConnected(true);
}
@@ -43,7 +56,7 @@ export default function App(props) {
setConnected(false);
}
function onError(err) {
function onError(err: any) {
logger.error(`Unexpected error in connector:\n${err.stack}`);
clearToken();
setConnected(false);
@@ -96,7 +109,7 @@ export default function App(props) {
theme={{ algorithm: theme.darkAlgorithm }}
>
<ControlContext.Provider value={props.control}>
<BrowserRouter basename={webRoot}>
<BrowserRouter basename={window.webRoot}>
{page}
</BrowserRouter>
</ControlContext.Provider>
@@ -1,3 +1,4 @@
import type { BaseButtonProps } from "antd/es/button/button";
import React, { useContext, useState } from "react";
import { Button, Form, Modal, Select, Typography } from "antd";
@@ -10,7 +11,14 @@ import { useHostList } from "../model/host";
const { Paragraph } = Typography;
export default function AssignInstanceModal(props) {
type AssignInstanceModalProps = {
id?: number;
hostId?: number;
buttonProps: BaseButtonProps & { style: React.CSSProperties };
buttonContent: string;
onFinish?: () => void;
};
export default function AssignInstanceModal(props: AssignInstanceModalProps) {
let [open, setOpen] = useState(false);
let [hostList] = useHostList();
let [applying, setApplying] = useState(false);
@@ -30,7 +38,7 @@ export default function AssignInstanceModal(props) {
setApplying(true);
control.send(
new lib.InstanceAssignRequest(props.id, hostId)
new lib.InstanceAssignRequest(props.id!, hostId)
).then(() => {
setOpen(false);
if (props.onFinish) {
@@ -1,11 +1,13 @@
import type * as lib from "@clusterio/lib";
import React, { useEffect, useState } from "react";
import { Button, Card, Checkbox, Form, Input, InputNumber, Space, Spin, Tooltip, Tree, Typography } from "antd";
import ReloadOutlined from "@ant-design/icons/ReloadOutlined";
const { Title } = Typography;
function getInitialValues(config, props) {
let initialValues = {};
function getInitialValues(config: lib.Config, props: BaseConfigTreeProps) {
let initialValues: any = {};
for (let [name, GroupClass] of props.ConfigClass.groups) {
let group = config.group(name);
for (let def of GroupClass.definitions.values()) {
@@ -13,7 +15,7 @@ function getInitialValues(config, props) {
continue;
}
let value = group.get(def.name);
let value = group.get(def.name) as any;
let fieldName = `${group.name}.${def.name}`;
if (def.type === "object") {
@@ -29,10 +31,18 @@ function getInitialValues(config, props) {
return initialValues;
}
export default function BaseConfigTree(props) {
let [config, setConfig] = useState(null);
type BaseConfigTreeProps = {
ConfigClass: typeof lib.Config;
retrieveConfig: () => Promise<lib.SerializedConfig>;
setField: (field:string, value:any) => Promise<void>;
setProp: (field:string, prop:string, value:any) => Promise<void>;
id?: number;
onApply?: () => void;
};
export default function BaseConfigTree(props: BaseConfigTreeProps) {
let [config, setConfig] = useState<lib.Config|null>(null);
let [form] = Form.useForm();
let [changedFields, setChangedFields] = useState(new Set());
let [changedFields, setChangedFields] = useState<Set<string>>(new Set());
let [errorFields, setErrorFields] = useState(new Map());
let [applying, setApplying] = useState(false);
@@ -49,7 +59,7 @@ export default function BaseConfigTree(props) {
});
}, [props.id]);
function renderInput(def) {
function renderInput(def: lib.FieldDefinition) {
if (def.type === "boolean") {
return <Checkbox/>;
}
@@ -67,8 +77,8 @@ export default function BaseConfigTree(props) {
return <Spin/>;
}
let initialValues = {};
function onValuesChange(changedValues) {
let initialValues: any = {};
function onValuesChange(changedValues: object) {
let newChangedFields = new Set(changedFields);
let changed = false;
for (let [key, value] of Object.entries(changedValues)) {
@@ -93,11 +103,23 @@ export default function BaseConfigTree(props) {
title="A restart is required for this setting to take effect"
><ReloadOutlined/></Tooltip>;
type ChildNode = {
key: string;
children: any[];
title?: React.ReactElement;
};
type TreeNode = {
key: string;
title: string;
children: ChildNode[];
};
let treeData = [];
let propsMap = new Map();
for (let [name, GroupClass] of props.ConfigClass.groups) {
let group = config.group(name);
let treeNode = {
let treeNode: TreeNode = {
key: group.name,
title: group.name,
children: [],
@@ -108,9 +130,9 @@ export default function BaseConfigTree(props) {
continue;
}
let value = group.get(def.name);
let value = group.get(def.name) as any;
let fieldName = `${group.name}.${def.name}`;
let childNode = {
let childNode: ChildNode = {
key: fieldName,
children: [],
};
@@ -127,7 +149,7 @@ export default function BaseConfigTree(props) {
for (let prop of Object.keys(value)) {
let propPath = `${group.name}.${def.name}.${prop}`;
let restart = Boolean(
def.restartRequiredProps && def.restartRequired ^ restartRequiredProps.has(prop)
def.restartRequiredProps && Number(def.restartRequired) ^ Number(restartRequiredProps.has(prop))
);
childNode.children.push({
key: propPath,
@@ -180,7 +202,7 @@ export default function BaseConfigTree(props) {
let propValue = form.getFieldValue(`${newPropPath}.value`);
if (!Object.prototype.hasOwnProperty.call(value, propName)) {
let newConfig = new props.ConfigClass("control");
await newConfig.load(config.serialize());
await newConfig.load(config!.serialize());
newConfig.setProp(fieldName, propName, null);
setConfig(newConfig);
}
@@ -252,7 +274,7 @@ export default function BaseConfigTree(props) {
return newChanged;
});
} catch (err) {
} catch (err: any) {
setErrorFields(errors => {
let newErrors = new Map(errors);
newErrors.set(field, err.message);
@@ -1,3 +0,0 @@
import React from "react";
export default React.createContext();
@@ -0,0 +1,5 @@
import type { Control } from "../util/websocket";
import React from "react";
export default React.createContext<Control>({} as Control);
@@ -6,7 +6,7 @@ import BaseConfigTree from "./BaseConfigTree";
import ControlContext from "./ControlContext";
export default function ControllerConfigTree(props) {
export default function ControllerConfigTree() {
let control = useContext(ControlContext);
async function retrieveConfig() {
@@ -14,14 +14,14 @@ export default function ControllerConfigTree(props) {
return result.serializedConfig;
}
async function setField(field, value) {
async function setField(field: string, value: any) {
await control.send(new lib.ControllerConfigSetFieldRequest(
field,
String(value),
));
}
async function setProp(field, prop, value) {
async function setProp(field: string, prop: string, value: any) {
if (value) {
try {
value = JSON.parse(value);
@@ -7,7 +7,11 @@ import ControlContext from "./ControlContext";
import { notifyErrorHandler } from "../util/notify";
export default function CreateSaveModal(props) {
type CreateSaveModalProps = {
instance: any;
};
export default function CreateSaveModal(props: CreateSaveModalProps) {
let [open, setOpen] = useState(false);
let [creatingSave, setCreatingSave] = useState(false);
let [form] = Form.useForm();
@@ -23,7 +27,7 @@ export default function CreateSaveModal(props) {
let result;
try {
result = lib.readMapExchangeString(values.exchangeString);
} catch (err) {
} catch (err: any) {
form.setFields([{ name: "exchangeString", errors: [err.message] }]);
return;
}
@@ -34,7 +38,7 @@ export default function CreateSaveModal(props) {
if (values.mapGenSettings && values.mapGenSettings.trim()) {
try {
mapGenSettings = JSON.parse(values.mapGenSettings);
} catch (err) {
} catch (err: any) {
form.setFields([{ name: "mapGenSettings", errors: [err.message] }]);
return;
}
@@ -43,7 +47,7 @@ export default function CreateSaveModal(props) {
if (values.mapSettings && values.mapSettings.trim()) {
try {
mapSettings = JSON.parse(values.mapSettings);
} catch (err) {
} catch (err: any) {
form.setFields([{ name: "mapSettings", errors: [err.message] }]);
return;
}
@@ -69,7 +73,7 @@ export default function CreateSaveModal(props) {
let result;
try {
result = lib.readMapExchangeString(exchangeString);
} catch (err) {
} catch (err: any) {
form.setFields([{ name: "exchangeString", errors: [err.message] }]);
return;
}
@@ -1,20 +0,0 @@
import React from "react";
export default class ErrorBoundary extends React.Component {
constructor(props) {
super(props);
this.state = { error: null };
}
static getDerivedStateFromError(error) {
return { error };
}
render() {
if (this.state.error) {
return <this.props.Component error={this.state.error} />;
}
return this.props.children;
}
}
@@ -0,0 +1,27 @@
import React from "react";
import type { ErrorProps } from "./App";
type ErrorBoundaryProps = {
Component: (props: ErrorProps) => React.JSX.Element;
children?: React.ReactElement;
};
type ErrorBoundaryState = {
error: Error | null;
};
export default class ErrorBoundary extends React.Component<ErrorBoundaryProps, ErrorBoundaryState> {
state: ErrorBoundaryState = { error: null };
static getDerivedStateFromError(error: any) {
return { error };
}
render() {
if (this.state.error) {
return <this.props.Component error={this.state.error} />;
}
return this.props.children;
}
}
@@ -2,11 +2,12 @@ import React from "react";
import { Typography } from "antd";
import PageLayout from "./PageLayout";
import type { ErrorProps } from "./App";
const { Paragraph } = Typography;
export default function ErrorPage(props) {
export default function ErrorPage(props: ErrorProps) {
return <PageLayout nav={[{ name: "Error" }]}>
<h2>An unexpected error occured</h2>
<Paragraph code className="error-traceback">{props.error.stack}</Paragraph>
@@ -13,8 +13,7 @@ import PluginExtra from "./PluginExtra";
const { Title } = Typography;
export default function HostViewPage(props) {
export default function HostViewPage() {
let params = useParams();
let hostId = Number(params.id);
let account = useAccount();
@@ -23,20 +22,20 @@ export default function HostViewPage(props) {
instanceList = instanceList.filter(instance => instance.assignedHost === hostId);
let nav = [{ name: "Hosts", path: "/hosts" }, { name: host.name || hostId }];
let nav = [{ name: "Hosts", path: "/hosts" }, { name: host.name || String(hostId) }];
if (host.loading) {
return <PageLayout nav={nav}><Spin size="large" /></PageLayout>;
}
if (host.missing) {
return <PageLayout nav={nav}>
<PageHeader title={hostId} />
<PageHeader title={String(hostId)} />
<p>Host with id {hostId} was not found on the controller.</p>
</PageLayout>;
}
return <PageLayout nav={nav}>
<PageHeader title={host.name || hostId} />
<PageHeader title={host.name || String(hostId)} />
<Descriptions bordered size="small" column={{ xs: 1, sm: 2, xl: 4 }}>
<Descriptions.Item label="Name">{host["name"]}</Descriptions.Item>
@@ -3,6 +3,7 @@ import { useNavigate } from "react-router-dom";
import { Button, Form, InputNumber, Modal, Table, Tag, Typography } from "antd";
import CopyOutlined from "@ant-design/icons/lib/icons/CopyOutlined";
import type { PluginWebApi } from "@clusterio/controller/src/routes";
import * as lib from "@clusterio/lib";
import { useAccount } from "../model/account";
@@ -13,19 +14,19 @@ import PluginExtra from "./PluginExtra";
import { useHostList } from "../model/host";
import notify, { notifyErrorHandler } from "../util/notify";
const strcmp = new Intl.Collator(undefined, { numerice: "true", sensitivity: "base" }).compare;
const strcmp = new Intl.Collator(undefined, { numeric: true, sensitivity: "base" }).compare;
function GenerateHostTokenButton(props) {
function GenerateHostTokenButton() {
let control = useContext(ControlContext);
let [open, setOpen] = useState(false);
let [token, setToken] = useState(null);
let [hostId, setHostId] = useState(null);
let [token, setToken] = useState<string|null>(null);
let [hostId, setHostId] = useState<number|null>(null);
let [form] = Form.useForm();
let [pluginList, setPluginList] = useState([]);
let [pluginList, setPluginList] = useState<PluginWebApi[]>([]);
useEffect(() => {
(async () => {
let response = await fetch(`${webRoot}api/plugins`);
let response = await fetch(`${window.webRoot}api/plugins`);
if (response.ok) {
const plugins = await response.json();
setPluginList(plugins);
@@ -36,7 +37,7 @@ function GenerateHostTokenButton(props) {
}, []);
async function generateToken() {
let id = null;
let id = undefined;
let values = form.getFieldsValue();
if (values.hostId) {
id = Number.parseInt(values.hostId, 10);
@@ -49,7 +50,7 @@ function GenerateHostTokenButton(props) {
let newToken = await control.send(new lib.HostGenerateTokenRequest(id));
setToken(newToken);
setHostId(id);
setHostId(id??null);
}
// Generate a new random
@@ -60,6 +61,7 @@ function GenerateHostTokenButton(props) {
}, [open]);
// Only install plugins that aren't filesystem paths. Npm modules have max 1 forward slash in their name.
//@ts-ignore TODO::: this doesn't filter anything, `x.split("/") <= 1` is always = true. repair or shouldn't filter ?
const pluginString = pluginList.map(p => `"${p.requirePath}"`).filter(x => x.split("/") <= 1).join(" ");
return <>
<Button
@@ -138,10 +140,11 @@ function GenerateHostTokenButton(props) {
</>;
}
function CopyButton({ text, message }) {
function CopyButton({ text, message }: { text:string, message:string }) {
let [clipboardPermision, setClipboardPermission] = useState("granted");
useEffect(() => {
(async () => {
//@ts-ignore https://developer.mozilla.org/en-US/docs/Web/API/Clipboard/write
let result = await navigator.permissions.query({ name: "clipboard-write" });
// result.state is "granted", "denied" or "prompt"
setClipboardPermission(result.state);
@@ -152,13 +155,20 @@ function CopyButton({ text, message }) {
}, []);
async function checkClipboardPermission() {
let result = await navigator.permissions.query({ name: "clipboard-write" });
// result.state is "granted", "denied" or "prompt"
setClipboardPermission(result.state);
result.onchange = function () {
try {
//@ts-ignore https://developer.mozilla.org/en-US/docs/Web/API/Clipboard/write
let result = await navigator.permissions.query({ name: "clipboard-write" });
// result.state is "granted", "denied" or "prompt"
setClipboardPermission(result.state);
};
return result.state === "granted";
result.onchange = function () {
setClipboardPermission(result.state);
};
return result.state === "granted";
} catch (err: any) {
//If it fail because "clipboard-write" is not supported.
return err.name === "TypeError";
}
}
return <Button
@@ -184,7 +194,7 @@ export default function HostsPage() {
return <PageLayout nav={[{ name: "Hosts" }]}>
<PageHeader
title="Hosts"
extra={account.hasPermission("core.host.generate_token") && <GenerateHostTokenButton />}
extra={account.hasPermission("core.host.generate_token") && <GenerateHostTokenButton /> || undefined}
/>
<Table
columns={[
@@ -208,7 +218,7 @@ export default function HostsPage() {
{
title: "Public address",
dataIndex: "publicAddress",
sorter: (a, b) => strcmp(a.publicAddress, b.publicAddress),
sorter: (a, b) => strcmp(a.publicAddress??"", b.publicAddress??""),
},
{
title: "Connected",
@@ -218,7 +228,7 @@ export default function HostsPage() {
>
{host.connected ? "Connected" : "Disconnected"}
</Tag>,
sorter: (a, b) => a.connected - b.connected,
sorter: (a, b) => Number(a.connected) - Number(b.connected),
},
]}
dataSource={hostList}
@@ -6,19 +6,23 @@ import BaseConfigTree from "./BaseConfigTree";
import ControlContext from "./ControlContext";
export default function InstanceConfigTree(props) {
type InstanceConfigTreeProps = {
id: number;
};
export default function InstanceConfigTree(props: InstanceConfigTreeProps) {
let control = useContext(ControlContext);
async function retrieveConfig() {
let result = await control.send(new lib.InstanceConfigGetRequest(props.id));
return result.config;
return result.serializedConfig;
}
async function setField(field, value) {
async function setField(field: string, value: any) {
await control.send(new lib.InstanceConfigSetFieldRequest(props.id, field, value));
}
async function setProp(field, prop, value) {
async function setProp(field: string, prop: string, value: any) {
if (value) {
try {
value = JSON.parse(value);
@@ -2,21 +2,30 @@ import React from "react";
import { useNavigate } from "react-router-dom";
import { message, Button, Space, Table } from "antd";
import CopyOutlined from "@ant-design/icons/CopyOutlined";
import type { SizeType } from "antd/es/config-provider/SizeContext";
import type { ColumnsType } from "antd/es/table";
import { useAccount } from "../model/account";
import { useHostList } from "../model/host";
import InstanceStatusTag from "./InstanceStatusTag";
import StartStopInstanceButton from "./StartStopInstanceButton";
import { InstanceDetails } from "@clusterio/lib";
const strcmp = new Intl.Collator(undefined, { numerice: "true", sensitivity: "base" }).compare;
const strcmp = new Intl.Collator(undefined, { numeric: true, sensitivity: "base" }).compare;
export default function InstanceList(props) {
type InstanceListProps = {
instances: InstanceDetails[];
size?: SizeType;
hideAssignedHost?: boolean;
};
export default function InstanceList(props: InstanceListProps) {
let account = useAccount();
let navigate = useNavigate();
let [hostList] = useHostList();
function hostName(hostId) {
if (hostId === null) {
function hostName(hostId?: number|null) {
if (hostId === null ||hostId === undefined) {
return "";
}
let host = hostList.find(s => s.id === hostId);
@@ -26,7 +35,7 @@ export default function InstanceList(props) {
return String(hostId);
}
function instancePublicAddress(instance) {
function instancePublicAddress(instance: InstanceDetails) {
let host = hostList.find(s => s.id === instance.assignedHost);
if (host && host.publicAddress) {
if (instance.gamePort) {
@@ -37,7 +46,7 @@ export default function InstanceList(props) {
return null;
}
let columns = [
let columns: ColumnsType<InstanceDetails> = [
{
title: "Name",
dataIndex: "name",
@@ -63,13 +72,13 @@ export default function InstanceList(props) {
icon={<CopyOutlined/>}
onClick={(e) => {
e.stopPropagation();
navigator.clipboard.writeText(publicAddress);
navigator.clipboard.writeText(publicAddress??"");
message.success("Copied public address!");
}}
/>
</> : "";
},
sorter: (a, b) => strcmp(hostPublicAddress(a.assignedHost), hostPublicAddress(b.assignedHost)),
sorter: (a, b) => strcmp(instancePublicAddress(a)||"", instancePublicAddress(b)||""),
responsive: ["lg"],
},
{
@@ -78,7 +87,10 @@ export default function InstanceList(props) {
render: instance => <InstanceStatusTag status={instance["status"]} />,
sorter: (a, b) => strcmp(a["status"], b["status"]),
},
...(account.hasAnyPermission("core.instance.start", "core.instance.stop") ? [{
];
if (account.hasAnyPermission("core.instance.start", "core.instance.stop")) {
columns.push({
key: "action",
render: instance => <StartStopInstanceButton
buttonProps={{ size: "small" }}
@@ -87,8 +99,8 @@ export default function InstanceList(props) {
responsive: ["sm"],
align: "right",
width: 100,
}] : []),
];
})
}
if (props.hideAssignedHost) {
columns.splice(1, 1);
@@ -9,12 +9,16 @@ import { notifyErrorHandler } from "../util/notify";
const { Title, Paragraph } = Typography;
export default function InstanceRcon(props) {
type InstanceRconProps = {
id: number;
disabled: boolean;
};
export default function InstanceRcon(props: InstanceRconProps) {
let control = useContext(ControlContext);
let [output, setOutput] = useState(null);
let [output, setOutput] = useState<string|null>(null);
let [running, setRunning] = useState(false);
async function sendCommand(command) {
async function sendCommand(command: string) {
if (!command) {
setOutput(null);
return;
@@ -13,8 +13,10 @@ export const statusColors = {
deleted: "#262626",
};
export default function InstanceStatusTag(props) {
type InstanceStatusTag = {
status: keyof typeof statusColors;
};
export default function InstanceStatusTag(props: InstanceStatusTag) {
return <Tag color={statusColors[props.status]}>
{props.status.replace("_", " ")}
</Tag>;
@@ -1,6 +1,7 @@
import React, { useContext, useState } from "react";
import { useNavigate, useParams } from "react-router-dom";
import { Alert, Button, Descriptions, Dropdown, Menu, Modal, Space, Spin, Typography } from "antd";
import { Alert, Button, Descriptions, Dropdown, Menu, MenuProps, Modal, Space, Spin, Typography } from "antd";
import type { ItemType } from 'antd/es/menu/hooks/useItems';
import DeleteOutlined from "@ant-design/icons/DeleteOutlined";
import DownOutlined from "@ant-design/icons/DownOutlined";
@@ -19,14 +20,17 @@ import StartStopInstanceButton from "./StartStopInstanceButton";
import LoadScenarioModal from "./LoadScenarioModal";
import SavesList from "./SavesList";
import { notifyErrorHandler } from "../util/notify";
import { useInstance } from "../model/instance";
import { useHost } from "../model/host";
import { InstanceState, useInstance } from "../model/instance";
import { HostState, useHost } from "../model/host";
import InstanceStatusTag from "./InstanceStatusTag";
const { Title } = Typography;
function InstanceDescription(props) {
type InstanceDescriptionProps = {
host: HostState;
instance: InstanceState;
};
function InstanceDescription(props: InstanceDescriptionProps) {
let account = useAccount();
const { host, instance } = props;
@@ -45,18 +49,18 @@ function InstanceDescription(props) {
hostId={instance.assignedHost}
buttonProps={{
size: "small",
style: { float: "Right" },
style: { float: "right" },
type: assigned ? "default" : "primary",
disabled: !["unknown", "unassigned", "stopped"].includes(instance.status),
disabled: !["unknown", "unassigned", "stopped"].includes(instance.status!),
}}
buttonContent={assigned ? "Reassign" : "Assign"}
/>}
</Descriptions.Item>
<Descriptions.Item label="Status"><InstanceStatusTag status={instance.status} /></Descriptions.Item>
<Descriptions.Item label="Status"><InstanceStatusTag status={instance.status!} /></Descriptions.Item>
</Descriptions>;
}
export default function InstanceViewPage(props) {
export default function InstanceViewPage() {
let params = useParams();
let instanceId = Number(params.id);
@@ -93,7 +97,7 @@ export default function InstanceViewPage(props) {
</PageLayout>;
}
let instanceButtonMenuItems = [];
let instanceButtonMenuItems: ItemType[] = [];
if (account.hasPermission("core.instance.export_data")) {
instanceButtonMenuItems.push({
disabled: exportingData || instance.status !== "stopped",
@@ -110,7 +114,7 @@ export default function InstanceViewPage(props) {
}
if (account.hasPermission("core.instance.kill")) {
instanceButtonMenuItems.push({
disabled: ["unknown", "unassigned", "stopped"].includes(instance.status),
disabled: ["unknown", "unassigned", "stopped"].includes(instance.status!),
key: "kill",
label: "Kill process",
});
@@ -120,16 +124,16 @@ export default function InstanceViewPage(props) {
instanceButtonMenuItems.push({ type: "divider" });
}
instanceButtonMenuItems.push({
disabled: !["unknown", "unassigned", "stopped"].includes(instance.status),
disabled: !["unknown", "unassigned", "stopped"].includes(instance.status!),
danger: true,
key: "delete",
icon: <DeleteOutlined />,
label: "Delete",
});
}
let instanceButtonsMenuProps = {
let instanceButtonsMenuProps: MenuProps = {
items: instanceButtonMenuItems,
onClick: ({ key }) => {
onClick: ({ key }: { key:string }) => {
if (key === "export") {
setExportingData(true);
control.sendTo(
@@ -188,7 +192,7 @@ export default function InstanceViewPage(props) {
return <PageLayout nav={nav}>
<PageHeader
title={instance.name}
title={instance.name??""}
extra={instanceButtons}
/>
<InstanceDescription host={host} instance={instance} />
@@ -13,7 +13,7 @@ import { useInstanceList } from "../model/instance";
import InstanceList from "./InstanceList";
import { notifyErrorHandler } from "../util/notify";
function CreateInstanceButton(props) {
function CreateInstanceButton() {
let control = useContext(ControlContext);
let navigate = useNavigate();
let [open, setOpen] = useState(false);
@@ -72,8 +72,9 @@ export default function InstancesPage() {
{account.hasPermission("core.instance.start")
&& <Button onClick={e => instanceList.forEach(instance => {
if (instance.status === "stopped") {
control.send(
new lib.InstanceStartRequest(undefined), { instanceId: instance.id }
control.sendTo(
{ instanceId: instance.id },
new lib.InstanceStartRequest(undefined),
).catch(notifyErrorHandler("Error starting instance"));
}
})
@@ -5,9 +5,12 @@ import * as lib from "@clusterio/lib";
import ControlContext from "./ControlContext";
import { notifyErrorHandler } from "../util/notify";
import { InstanceState } from "../model/instance";
export default function LoadScenarioModal(props) {
type LoadScenarioModalProps = {
instance: InstanceState;
};
export default function LoadScenarioModal(props: LoadScenarioModalProps) {
let [open, setOpen] = useState(false);
let [loadingScenario, setLoadingScenario] = useState(false);
let [form] = Form.useForm();
@@ -23,7 +26,7 @@ export default function LoadScenarioModal(props) {
let result;
try {
result = lib.readMapExchangeString(values.exchangeString);
} catch (err) {
} catch (err: any) {
form.setFields([{ name: "exchangeString", errors: [err.message] }]);
return;
}
@@ -34,7 +37,7 @@ export default function LoadScenarioModal(props) {
if (values.mapGenSettings && values.mapGenSettings.trim()) {
try {
mapGenSettings = JSON.parse(values.mapGenSettings);
} catch (err) {
} catch (err: any) {
form.setFields([{ name: "mapGenSettings", errors: [err.message] }]);
return;
}
@@ -43,7 +46,7 @@ export default function LoadScenarioModal(props) {
if (values.mapSettings && values.mapSettings.trim()) {
try {
mapSettings = JSON.parse(values.mapGenSettings);
} catch (err) {
} catch (err: any) {
form.setFields([{ name: "mapSettings", errors: [err.message] }]);
return;
}
@@ -52,7 +55,7 @@ export default function LoadScenarioModal(props) {
setLoadingScenario(true);
control.sendTo(
{ instanceId: props.instance.id },
{ instanceId: props.instance.id! },
new lib.InstanceLoadScenarioRequest(scenario, seed, mapGenSettings, mapSettings),
).then(() => {
setOpen(false);
@@ -68,7 +71,7 @@ export default function LoadScenarioModal(props) {
let result;
try {
result = lib.readMapExchangeString(exchangeString);
} catch (err) {
} catch (err: any) {
form.setFields([{ name: "exchangeString", errors: [err.message] }]);
return;
}
@@ -1,4 +1,4 @@
import React, { useEffect, useContext, useRef, useState } from "react";
import React, { useEffect, useContext, useRef, useState, ReactElement } from "react";
import { Typography } from "antd";
import * as lib from "@clusterio/lib";
@@ -8,18 +8,27 @@ import ControlContext from "./ControlContext";
const { Paragraph } = Typography;
type Parsed = {
format: string;
type: string;
level: string;
time: string;
file: string;
action: string;
message: string;
};
function formatParsedOutput(parsed, key) {
let time = "";
function formatParsedOutput(parsed: Parsed, key: number) {
let time: ReactElement|string = "";
if (parsed.format === "seconds") {
time = <span className="factorio-time">{parsed.time.padStart(8)} </span>;
} else if (parsed.format === "date") {
time = <span className="factorio-time">{parsed.time} </span>;
}
let info = "";
let info: ReactElement|string = "";
if (parsed.type === "log") {
let level = parsed.level;
let level: ReactElement|string = parsed.level;
if (level === "Script") {
level = <span className="factorio-script">{level}</span>;
} else if (level === "Verbose") {
@@ -41,7 +50,12 @@ function formatParsedOutput(parsed, key) {
return <span key={key}>{time}{info}{parsed.message}<br/></span>;
}
function formatLog(info, key) {
type Info = {
level: string;
message: string;
parsed?: Parsed;
};
function formatLog(info: Info, key: number): ReactElement {
if (info.level === "server" && info.parsed) {
return formatParsedOutput(info.parsed, key);
}
@@ -49,12 +63,18 @@ function formatLog(info, key) {
return <span key={key}>[{level}] {info.message}<br/></span>;
}
export default function LogConsole(props) {
type LogConsoleProps = {
all?: boolean;
controller?: boolean;
hosts?: number[];
instances?: number[];
};
export default function LogConsole(props: LogConsoleProps) {
let account = useAccount();
let control = useContext(ControlContext);
let anchor = useRef();
let anchor = useRef<any>();
let [pastLines, setPastLines] = useState([<span key={0}>{"Loading past entries..."}<br/></span>]);
let [lines, setLines] = useState([]);
let [lines, setLines] = useState<ReactElement[]>([]);
useEffect(() => {
let logFilter = {
@@ -79,7 +99,7 @@ export default function LogConsole(props) {
400,
"desc",
)).then(result => {
setPastLines(result.log.map((info, index) => formatLog(info, -index - 1)).reverse());
setPastLines(result.log.map((info, index) => formatLog(info as Info, -index - 1)).reverse());
}).catch(err => {
setPastLines([<span key={0}>{`Error loading log: ${err.message}`}<br/></span>]);
});
@@ -87,7 +107,7 @@ export default function LogConsole(props) {
setPastLines([]);
}
function logHandler(info) {
function logHandler(info: Info) {
setLines(currentLines => currentLines.concat(
[formatLog(info, currentLines.length)]
));
@@ -107,4 +127,3 @@ export default function LogConsole(props) {
</Paragraph>
</>;
}
@@ -7,8 +7,10 @@ import ControlContext from "./ControlContext";
const { Paragraph } = Typography;
function TokenAuth(props) {
type SetTokenProps = {
setToken: (token: string) => void;
};
function TokenAuth(props: SetTokenProps) {
return <>
<Paragraph>If you have generated an authentication token from the controller, use that here.</Paragraph>
<Form
@@ -32,7 +34,7 @@ function TokenAuth(props) {
</>;
}
export default function LoginForm(props) {
export default function LoginForm(props: SetTokenProps) {
let plugins = useContext(ControlContext).plugins;
let loginForms = [];
@@ -1,54 +0,0 @@
import React, { Fragment } from "react";
import { Descriptions, Grid, Typography } from "antd";
import ExclamationCircleOutlined from "@ant-design/icons/ExclamationCircleOutlined";
import * as lib from "@clusterio/lib";
const { useBreakpoint } = Grid;
export default function ModDetails(props) {
let screens = useBreakpoint();
const mod = props.mod;
return <Descriptions className="borderless" bordered size="small" column={{ xs: 1, sm: 1, md: 1, lg: 2 }}>
{mod.error && <Descriptions.Item label={<><ExclamationCircleOutlined/> Error</>} span={2}>
{mod.error === "missing" && "The given version of this mod is missing from the controller storage."}
{mod.error === "bad_checksum"
&& "Checksum of the mod in the controller storage does not match the checksum provided " +
"by this mod pack."
}
</Descriptions.Item>}
{props.actions && !screens.lg
&& <Descriptions.Item label="Action">{props.actions(mod)}</Descriptions.Item>
}
{mod.title && <Descriptions.Item label="Title">{mod.title}</Descriptions.Item>}
{mod.version && <Descriptions.Item label="Version" span={mod.title ? 1 : 2}>{mod.version}</Descriptions.Item>}
{mod.description && <Descriptions.Item label="Description" span={2}>{mod.description}</Descriptions.Item> }
{mod.author && <Descriptions.Item label="Author" span={2}>{mod.author}</Descriptions.Item>}
<Descriptions.Item label="Mod&nbsp;Portal" span={2}>
<Typography.Link href={`https://mods.factorio.com/mod/${mod.name}`}>
{`https://mods.factorio.com/mod/${mod.name}`}
</Typography.Link>
</Descriptions.Item>
{mod.contact && <Descriptions.Item label="Contact" span={2}>{mod.contact}</Descriptions.Item>}
{mod.homepage && <Descriptions.Item label="Homepage" span={2}>{mod.homepage}</Descriptions.Item>}
<Descriptions.Item label="Internal&nbsp;Name" span={mod.factorioVersion ? 1 : 2}>{mod.name}</Descriptions.Item>
{mod.factorioVersion
&& <Descriptions.Item label="Factorio&nbsp;Version">{mod.factorioVersion}</Descriptions.Item>
}
{mod.filename && <Descriptions.Item label="Filename">{mod.filename}</Descriptions.Item>}
{mod.size !== undefined
&& <Descriptions.Item label="Size">{lib.formatBytes(mod.size)}</Descriptions.Item>
}
{mod.sha1 && <Descriptions.Item label="SHA1" span={2}>{mod.sha1}</Descriptions.Item>}
{mod.dependencies && mod.dependencies.length
&& <Descriptions.Item label="Dependencies" span={2}>
{mod.dependencies
.filter(e => !e.startsWith("(?)"))
.map((e, i) => <Fragment key={i}>{e}<br/></Fragment>)
}
</Descriptions.Item>
}
</Descriptions>;
}
@@ -0,0 +1,64 @@
import React, { Fragment } from "react";
import { Descriptions, Grid, Typography } from "antd";
import ExclamationCircleOutlined from "@ant-design/icons/ExclamationCircleOutlined";
import * as lib from "@clusterio/lib";
const { useBreakpoint } = Grid;
type ModDetailsProps = {
mod: lib.ModInfo|lib.ModRecord;
actions: (mod: lib.ModInfo|lib.ModRecord) => React.JSX.Element;
};
export default function ModDetails(props: ModDetailsProps) {
let screens = useBreakpoint();
const mod = props.mod;
return <Descriptions className="borderless" bordered size="small" column={{ xs: 1, sm: 1, md: 1, lg: 2 }}>
{!(mod instanceof lib.ModInfo) && mod.error && <Descriptions.Item label={<><ExclamationCircleOutlined/> Error</>} span={2}>
{mod.error === "missing" && "The given version of this mod is missing from the controller storage."}
{mod.error === "bad_checksum"
&& "Checksum of the mod in the controller storage does not match the checksum provided " +
"by this mod pack."
}
</Descriptions.Item>}
{props.actions && !screens.lg
&& <Descriptions.Item label="Action">{props.actions(mod)}</Descriptions.Item>
}
{ (mod instanceof lib.ModInfo) && <>
{mod.title && <Descriptions.Item label="Title">{mod.title}</Descriptions.Item>}
{mod.version && <Descriptions.Item label="Version" span={mod.title ? 1 : 2}>{mod.version}</Descriptions.Item>}
{mod.description && <Descriptions.Item label="Description" span={2}>{mod.description}</Descriptions.Item> }
{mod.author && <Descriptions.Item label="Author" span={2}>{mod.author}</Descriptions.Item>}
</>}
<Descriptions.Item label="Mod&nbsp;Portal" span={2}>
<Typography.Link href={`https://mods.factorio.com/mod/${mod.name}`}>
{`https://mods.factorio.com/mod/${mod.name}`}
</Typography.Link>
</Descriptions.Item>
{ (mod instanceof lib.ModInfo) && <>
{mod.contact && <Descriptions.Item label="Contact" span={2}>{mod.contact}</Descriptions.Item>}
{mod.homepage && <Descriptions.Item label="Homepage" span={2}>{mod.homepage}</Descriptions.Item>}
<Descriptions.Item label="Internal&nbsp;Name" span={mod.factorioVersion ? 1 : 2}>{mod.name}</Descriptions.Item>
{mod.factorioVersion
&& <Descriptions.Item label="Factorio&nbsp;Version">{mod.factorioVersion}</Descriptions.Item>
}
{mod.filename && <Descriptions.Item label="Filename">{mod.filename}</Descriptions.Item>}
{mod.size !== undefined
&& <Descriptions.Item label="Size">{lib.formatBytes(mod.size)}</Descriptions.Item>
}
{mod.sha1 && <Descriptions.Item label="SHA1" span={2}>{mod.sha1}</Descriptions.Item>}
{mod.dependencies && mod.dependencies.length
&& <Descriptions.Item label="Dependencies" span={2}>
{mod.dependencies
.filter(e => !e.startsWith("(?)"))
.map((e, i) => <Fragment key={i}>{e}<br/></Fragment>)
}
</Descriptions.Item>
}
</>}
</Descriptions>;
}
@@ -3,7 +3,11 @@ import { useNavigate, useParams } from "react-router-dom";
import {
Button, Card, Checkbox, Col, ConfigProvider, Descriptions, Form, Input, Pagination,
Popconfirm, Row, Table, Tag, Typography, Select, Skeleton, Space, Spin, Switch, Modal, Tooltip,
TablePaginationConfig,
} from "antd";
import { FieldData } from "rc-field-form/lib/interface";
import type { SorterResult, FilterValue, TableCurrentDataSource } from "antd/es/table/interface";
import ExportOutlined from "@ant-design/icons/ExportOutlined";
import FileUnknownOutlined from "@ant-design/icons/FileUnknownOutlined";
import FileExclamationOutlined from "@ant-design/icons/FileExclamationOutlined";
@@ -25,18 +29,48 @@ import ModDetails from "./ModDetails";
const { logger } = lib;
const { Paragraph, Text } = Typography;
const strcmp = new Intl.Collator(undefined, { numerice: "true", sensitivity: "base" }).compare;
const strcmp = new Intl.Collator(undefined, { numeric: true, sensitivity: "base" }).compare;
function SearchModsTable(props) {
type ModChange =
{
type: "name" | "description" | "factorioVersion",
name?: never,
scope?: never,
value: string,
} | {
type: "settings.set" | "settings.delete",
name: string,
scope: "startup" | "runtime-global" | "runtime-per-user",
value: lib.ModSetting,
} | {
type: "mods.set" | "mods.delete",
name: string,
scope?: never,
value: lib.ModRecord | lib.ModInfo,
}
;
type ModResult = {
name: string;
versions: lib.ModInfo[];
};
type SearchModsTableProps = {
modPack: lib.ModPack;
changes: ModChange[];
onChange: (change: ModChange) => void;
};
function SearchModsTable(props: SearchModsTableProps) {
const control = useContext(ControlContext);
const [searchText, setSearchText] = useState("");
const [modResultSort, setModResultSort] = useState("title");
const [modResultSortOrder, setModResultSortOrder] = useState("asc");
const [modResults, setModResults] = useState([]);
const [modResultPage, setModResultPage] = useState(1);
const [modResultPageSize, setModResultPageSize] = useState(10);
const [modResultCount, setModResultCount] = useState(2);
const [modResultSelectedVersion, setModResultSelectedVersion] = useState(new Map());
const [searchText, setSearchText] = useState<string>("");
const [modResultSort, setModResultSort] = useState<string|undefined>("title");
const [modResultSortOrder, setModResultSortOrder] = useState<string|undefined>("asc");
const [modResults, setModResults] = useState<ModResult[]>([]);
const [modResultPage, setModResultPage] = useState<number>(1);
const [modResultPageSize, setModResultPageSize] = useState<number>(10);
const [modResultCount, setModResultCount] = useState<number>(2);
const [modResultSelectedVersion, setModResultSelectedVersion] = useState<Map<string,number>>(new Map());
const factorioVersion = props.modPack.factorioVersion.split(".").slice(0, 2).join(".");
@@ -57,7 +91,7 @@ function SearchModsTable(props) {
// of || 0 on modResultSelectedVersion.get() calls. Remove when updating React.
setModResults(response.results);
setModResultSelectedVersion(new Map(response.results.map(({ name, versions }) => [name, 0])));
setModResultCount(response.result_count);
setModResultCount(response.resultCount);
});
return () => {
@@ -65,20 +99,29 @@ function SearchModsTable(props) {
};
}, [searchText, factorioVersion, modResultPageSize, modResultPage, modResultSort, modResultSortOrder]);
function modResultPageChanged(page, pageSize) {
function modResultPageChanged(page: number, pageSize: number) {
setModResultPage(page);
setModResultPageSize(pageSize);
}
function modResultsTableChanged(pagination, filters, sorters, extra) {
function modResultsTableChanged(
pagination: TablePaginationConfig,
filters: Record<string, FilterValue | null>,
sorter: SorterResult<ModResult>|SorterResult<ModResult>[],
extra: TableCurrentDataSource<ModResult>,
) {
if (extra.action === "sort") {
if (sorters.order) {
if (sorter instanceof Array) {
sorter = sorter[0];
}
if (sorter.order) {
const mapping = {
ascend: "asc",
descend: "desc",
};
setModResultSort(sorters.columnKey);
setModResultSortOrder(mapping[sorters.order]);
setModResultSort(String(sorter.columnKey));
setModResultSortOrder(mapping[sorter.order]);
} else {
setModResultSort(undefined);
setModResultSortOrder(undefined);
@@ -86,9 +129,9 @@ function SearchModsTable(props) {
}
}
function actions(mod) {
function actions(mod: lib.ModInfo|lib.ModRecord) {
return <Space>
{(!props.modPack.mods.has(mod.name) || props.modPack.mods.get(mod.name).version !== mod.version)
{(!props.modPack.mods.has(mod.name) || props.modPack.mods.get(mod.name)?.version !== mod.version)
&& <Typography.Link
onClick={() => {
props.onChange({
@@ -106,7 +149,7 @@ function SearchModsTable(props) {
props.onChange({
type: "mods.delete",
name: mod.name,
value: { name: mod.name, version: mod.version, sha1: mod.sha1 },
value: { name: mod.name, enabled: false, version: mod.version, sha1: mod.sha1 },
});
}}
>remove</Typography.Link>
@@ -142,14 +185,14 @@ function SearchModsTable(props) {
{
title: "Title",
key: "title",
render: results => results.versions[0].title,
render: (result:ModResult) => result.versions[0].title,
defaultSortOrder: "ascend",
sorter: true,
},
{
title: "Author",
key: "author",
render: results => results.versions[0].author,
render: (result:ModResult) => result.versions[0].author,
responsive: ["lg"],
sorter: true,
},
@@ -157,7 +200,7 @@ function SearchModsTable(props) {
title: "Version",
key: "version",
align: "right",
render: result => <Select
render: (result:ModResult) => <Select
size="small"
bordered={false}
value={modResultSelectedVersion.get(result.name) || 0}
@@ -173,7 +216,7 @@ function SearchModsTable(props) {
title: "Action",
key: "action",
responsive: ["lg"],
render: result => actions(result.versions[modResultSelectedVersion.get(result.name) || 0]),
render: (result:ModResult) => actions(result.versions[modResultSelectedVersion.get(result.name) || 0]),
},
]}
expandable={{
@@ -192,34 +235,44 @@ function SearchModsTable(props) {
</>;
}
function ModsTable(props) {
type ModsTableProps = {
modPack: lib.ModPack;
changes: ModChange[];
onChange: (change: ModChange) => void;
onRevert: (change: ModChange) => void;
};
function ModsTable(props: ModsTableProps) {
const [showAddMods, setShowAddMods] = useState(false);
const [modList] = useModList();
const deletedMods = new Map();
const changedMods = new Map();
const deletedMods: Map<string, lib.ModRecord|lib.ModInfo> = new Map();
const changedMods: Map<string, lib.ModRecord|lib.ModInfo> = new Map();
for (let change of props.changes) {
if (props.modPack.mods.has(change.name)) {
if (change.type === "mods.set") {
changedMods.set(change.name, change.value);
if (change.name) {
if (props.modPack.mods.has(change.name)) {
if (change.type === "mods.set") {
changedMods.set(change.name, change.value);
}
} else if (change.type === "mods.delete") {
deletedMods.set(change.name, change.value);
}
} else if (change.type === "mods.delete") {
deletedMods.set(change.name, change.value);
}
}
const modListMap = new Map(modList.map(mod => [`${mod.name}_${mod.version}`, mod]));
const mods = [...props.modPack.mods.values(), ...deletedMods.values()].map(
mod => {
(mod: lib.ModRecord|lib.ModInfo): lib.ModInfo|lib.ModRecord => {
const candidate = modListMap.get(`${mod.name}_${mod.version}`);
if (!candidate) {
return {
...mod,
enabled: (mod as any).enabled ?? false,
error: "missing",
};
} else if (mod.sha1 && candidate.sha1 !== mod.sha1) {
return {
...mod,
enabled: (mod as any).enabled ?? false,
error: "bad_checksum",
};
}
@@ -227,7 +280,7 @@ function ModsTable(props) {
}
);
function actions(mod) {
function actions(mod: lib.ModRecord|lib.ModInfo) {
return <Space>
{!deletedMods.has(mod.name) && <Typography.Link
type="danger"
@@ -241,7 +294,7 @@ function ModsTable(props) {
>remove</Typography.Link>}
{(deletedMods.has(mod.name) || changedMods.has(mod.name)) && <Typography.Link
onClick={() => {
props.onRevert({
props.onRevert && props.onRevert({
type: deletedMods.has(mod.name) ? "mods.delete" : "mods.set",
name: mod.name,
value: mod,
@@ -275,16 +328,16 @@ function ModsTable(props) {
return { disabled: deletedMods.has(mod.name) };
},
onChange(selectedRowKeys, selectedRows) {
function setEnabled(modNames, enabled) {
function setEnabled(modNames: string[], enabled: boolean) {
for (let name of modNames) {
props.onChange({
type: "mods.set",
name,
value: { ...props.modPack.mods.get(name), enabled },
value: { ...props.modPack.mods.get(name)!, enabled },
});
}
}
const added = selectedRowKeys.filter(key => !props.modPack.mods.get(key).enabled);
const added = selectedRowKeys.filter(key => !props.modPack.mods.get(key as string)?.enabled) as string[];
const removed = [...props.modPack.mods.values()].filter(
mod => mod.enabled && selectedRowKeys.indexOf(mod.name) === -1
).map(mod => mod.name);
@@ -341,16 +394,18 @@ function ModsTable(props) {
}
// Returns true if a change record with the given fields exist
function hasChange(changes, field) {
return changes.some(change => Object.entries(field).every(([key, value]) => change[key] === value));
function hasChange(changes: ModChange[], field:Partial<ModChange>) {
return changes
.some(change => Object.entries(field)
.every(([key, value]) => (change as any)[key] === value));
}
// picks out the value property from settings.
function pickValue(map) {
function pickValue(map: Map<string, lib.ModSetting>): [string, string|number|boolean][] {
return [...map].map(([name, value]) => [name, value.value]);
}
function groupToMap(array, fn) {
function groupToMap(array: any[], fn: (...args:any) => any) {
const map = new Map();
for (let index = 0; index < array.length; index++) {
let key = fn(array[index], index, array);
@@ -362,7 +417,15 @@ function groupToMap(array, fn) {
return map;
}
const SettingsTableField = memo((props) => {
type SettingsTableFieldProps = {
name: string;
type: string;
scope: string;
allowedValues: any;
locale: Map<string, any>;
changed: boolean;
}
const SettingsTableField = memo((props: SettingsTableFieldProps) => {
const name = props.name;
const isBoolean = props.type === "bool-setting";
const isNumber = ["int-setting", "double-setting"].includes(props.type);
@@ -388,20 +451,29 @@ const SettingsTableField = memo((props) => {
wrapperCol={{ span: 16 }}
valuePropName={isBoolean ? "checked" : "value"}
rules={[...isNumber ? [{
validator(rule, value) {
validator(rule: any, value: any) {
if (Number.isNaN(Number(value))) {
return Promise.reject(new Error("Must be a number"));
}
return Promise.resolve();
},
}] : []]}
className={ props.changed && "changed" }
className={ props.changed && "changed" || "" }
>
{input}
</Form.Item>;
});
function SettingsTable(props) {
type SettingsTableProps = {
modPack: lib.ModPack;
prototypes: any;
locale: any;
changes: ModChange[];
onChange: (change: ModChange) => void;
onRevert: (change: ModChange) => void;
};
function SettingsTable(props: SettingsTableProps) {
const [modList] = useModList();
const modsInPack = new Set([...props.modPack.mods.values()].map(mod => `${mod.name}_${mod.version}`));
const modTitles = new Map(modList
@@ -412,10 +484,13 @@ function SettingsTable(props) {
const types = ["bool-setting", "int-setting", "double-setting", "string-setting"];
let prototypes = Object.entries(props.prototypes)
.filter(([type, _]) => types.includes(type))
.flatMap(([_, settingPrototypes]) => Object.values(settingPrototypes))
.flatMap<any>(([_, settingPrototypes]: [string, any]) => Object.values(settingPrototypes))
;
function controls(scope, storedFields) {
function controls(
scope: "startup"|"runtime-global"|"runtime-per-user",
storedFields: [string, string|number|boolean][]
) {
let fields = new Map(prototypes
.filter(p => p.setting_type === scope)
.sort((a, b) => strcmp(a.mod, b.mod) || strcmp(a.order || "", b.order || "") || strcmp(a.name, b.name))
@@ -473,10 +548,10 @@ function SettingsTable(props) {
</>;
}
function CopyButton(props) {
function CopyButton(props: { content: string }) {
let clipboard = useClipboard();
let [copiedVisible, setCopiedVisible] = useState(false);
let copiedTimeout = useRef();
let [copiedVisible, setCopiedVisible] = useState<boolean|undefined>(false);
let copiedTimeout = useRef<ReturnType<typeof setTimeout>|undefined>();
useEffect(() => () => {
clearTimeout(copiedTimeout.current);
@@ -493,7 +568,7 @@ function CopyButton(props) {
copiedTimeout.current = setTimeout(() => {
setCopiedVisible(false);
}, 3000);
} catch (err) {
} catch (err: any) {
logger.error(`Writing to clipboard failed:\n${err.stack}`);
notify("Unable to copy to clipboard", "error", "Use ordinary select and copy instead.");
}
@@ -501,13 +576,13 @@ function CopyButton(props) {
</Tooltip>;
}
function ExportButton(props) {
let [open, setOpen] = useState(false);
function ExportButton(props: { modPack: lib.ModPack }) {
let [open, setOpen] = useState<boolean>(false);
function close() {
setOpen(false);
}
let exportString;
let exportString = "";
if (open) { exportString = props.modPack.toModPackString(); }
return <>
@@ -530,10 +605,10 @@ function ExportButton(props) {
</>;
}
function useExportedAsset(modPack, asset) {
let [assetData, setAssetData] = useState(asset === "locale" ? new Map() : {});
let assetFilename;
if (modPack instanceof lib.ModPack && modPack.exportManifest && modPack.exportManifest.assets[asset]) {
function useExportedAsset(modPack: lib.ModPack, asset: "settings"|"locale"): Map<any, any> | any {
let [assetData, setAssetData] = useState<Map<any, any>|any>(asset === "locale" ? new Map() : {});
let assetFilename: string | undefined;
if (modPack instanceof lib.ModPack && modPack.exportManifest?.assets[asset]) {
assetFilename = modPack.exportManifest.assets[asset];
}
useEffect(() => {
@@ -542,7 +617,7 @@ function useExportedAsset(modPack, asset) {
return;
}
let response = await fetch(`${staticRoot}static/${assetFilename}`);
let response = await fetch(`${window.staticRoot}static/${assetFilename}`);
if (response.ok) {
let data = await response.json();
setAssetData(asset === "locale" ? new Map(data) : data);
@@ -557,7 +632,7 @@ function useExportedAsset(modPack, asset) {
return assetData;
}
function applyModPackChanges(modPack, changes) {
function applyModPackChanges(modPack: lib.ModPack, changes: ModChange[]) {
let modifiedModPack = modPack.shallowClone();
for (let change of changes) {
// Only modify fields that change to reduce re-renders
@@ -566,6 +641,7 @@ function applyModPackChanges(modPack, changes) {
}
if (
["settings.set", "settings.delete"].includes(change.type)
&& change.scope
&& modifiedModPack.settings[change.scope] === modPack.settings[change.scope]
) {
if (modifiedModPack.settings === modPack.settings) {
@@ -581,13 +657,19 @@ function applyModPackChanges(modPack, changes) {
} else if (change.type === "factorioVersion") {
modifiedModPack.factorioVersion = change.value;
} else if (change.type === "mods.set") {
modifiedModPack.mods.set(change.name, change.value);
if (change.name) {
modifiedModPack.mods.set(change.name, change.value as lib.ModRecord);
}
} else if (change.type === "mods.delete") {
modifiedModPack.mods.delete(change.name);
modifiedModPack.mods.delete(change.name!);
} else if (change.type === "settings.set") {
modifiedModPack.settings[change.scope].set(change.name, change.value);
if (change.scope && change.name) {
modifiedModPack.settings[change.scope].set(change.name, change.value);
}
} else if (change.type === "settings.delete") {
modifiedModPack.settings[change.scope].delete(change.name);
if (change.scope && change.name) {
modifiedModPack.settings[change.scope].delete(change.name);
}
} else {
throw new Error(`Unknown change type ${change.type}`);
}
@@ -603,13 +685,13 @@ export default function ModPackViewPage() {
let modPackId = Number(params.id);
const [form] = Form.useForm();
let [modPack] = useModPack(modPackId);
let prototypes = useExportedAsset(modPack, "settings");
let locale = useExportedAsset(modPack, "locale");
let [changes, setChanges] = useState([]);
let syncTimeout = useRef();
let [modPack] = useModPack(modPackId) as lib.ModPack[];
let prototypes: any = useExportedAsset(modPack, "settings");
let locale: Map<any, any> = useExportedAsset(modPack, "locale");
let [changes, setChanges] = useState<ModChange[]>([]);
let syncTimeout = useRef<ReturnType<typeof setTimeout>|undefined>();
let modifiedModPack;
let modifiedModPack: any;
if (!(modPack instanceof lib.ModPack)) {
// Loading or invalid id
modifiedModPack = modPack;
@@ -620,7 +702,7 @@ export default function ModPackViewPage() {
useEffect(() => () => { clearTimeout(syncTimeout.current); });
const pushChange = useCallback((change) => {
const pushChange = useCallback((change: ModChange) => {
setChanges(oldChanges => {
const newChanges = [...oldChanges];
if (
@@ -637,7 +719,7 @@ export default function ModPackViewPage() {
});
}, []);
const revertChange = useCallback((change) => {
const revertChange = useCallback((change: ModChange) => {
setChanges(oldChanges => {
const newChanges = [...oldChanges];
const index = newChanges.findLastIndex(reference => (
@@ -652,20 +734,19 @@ export default function ModPackViewPage() {
});
}, []);
function syncPack(fields) {
function syncPack(fields: FieldData[]) {
for (let field of fields) {
if (!field.touched || field.validating || field.errors.length) {
if (!field.touched || field.validating || (field.errors?.length??false)) {
continue;
}
if (["name", "description", "factorioVersion"].includes(field.name[0])) {
if (modifiedModPack[field.name[0]] !== field.value) {
pushChange({ type: field.name[0], value: field.value });
}
} else if (["startup", "runtime-global", "runtime-per-user"].includes(field.name[0])) {
let [scope, settingName] = field.name;
let [scope, settingName]: ["startup"|"runtime-global"|"runtime-per-user", string] = field.name;
let value = field.value;
if (typeof modPack.settings[scope].get(settingName).value === "number") {
if (typeof modPack.settings[scope].get(settingName)?.value === "number") {
value = Number(value);
if (Number.isNaN(value)) {
continue;
@@ -678,10 +759,10 @@ export default function ModPackViewPage() {
}
}
let nav = [{ name: "Mods", path: "/mods" }, { name: "Mod Packs" }, { name: modPack.name || modPackId }];
let nav = [{ name: "Mods", path: "/mods" }, { name: "Mod Packs" }, { name: modPack.name || String(modPackId) }];
if (modifiedModPack.loading) {
return <PageLayout nav={nav}>
<PageHeader title={modPackId} />
<PageHeader title={String(modPackId)} />
<Spin size="large" />
</PageLayout>;
}
@@ -704,11 +785,13 @@ export default function ModPackViewPage() {
okText="Delete"
okButtonProps={{ danger: true }}
onConfirm={() => {
control.send(
new lib.ModPackDeleteRequest(modPack.id)
).then(() => {
navigate("/mods");
}).catch(notifyErrorHandler("Error deleting mod pack"));
if (modPack.id !== undefined) {
control.send(
new lib.ModPackDeleteRequest(modPack.id)
).then(() => {
navigate("/mods");
}).catch(notifyErrorHandler("Error deleting mod pack"));
}
}}
>
<Button danger icon={<DeleteOutlined />}>Delete</Button>
@@ -739,7 +822,7 @@ export default function ModPackViewPage() {
<Descriptions.Item span={3} label="Name">
<Form.Item noStyle name="name">
<Input
className={hasChange(changes, { type: "name" }) && "changed"}
className={hasChange(changes, { type: "name" }) && "changed" || ""}
/>
</Form.Item>
</Descriptions.Item>
@@ -747,7 +830,7 @@ export default function ModPackViewPage() {
<Form.Item noStyle name="description">
<Input.TextArea
autoSize={{ minRows: 2 }}
className={hasChange(changes, { type: "description" }) && "changed"}
className={hasChange(changes, { type: "description" }) && "changed" || ""}
/>
</Form.Item>
</Descriptions.Item>
@@ -764,7 +847,7 @@ export default function ModPackViewPage() {
}]}
>
<Input
className={hasChange(changes, { type: "factorioVersion" }) && "changed"}
className={hasChange(changes, { type: "factorioVersion" }) && "changed" || ""}
/>
</Form.Item>
</Descriptions.Item>
@@ -812,5 +895,4 @@ export default function ModPackViewPage() {
</Row>
</div>
</PageLayout>;
}
@@ -18,8 +18,7 @@ import PluginExtra from "./PluginExtra";
import SectionHeader from "./SectionHeader";
import ModDetails from "./ModDetails";
const strcmp = new Intl.Collator(undefined, { numerice: "true", sensitivity: "base" }).compare;
const strcmp = new Intl.Collator(undefined, { numeric: true, sensitivity: "base" }).compare;
function ImportModPackButton() {
let control = useContext(ControlContext);
@@ -94,11 +93,11 @@ function CreateModPackButton() {
} catch {
return; // Validation failed
}
const modPack = lib.ModPack.fromJSON({});
const modPack = lib.ModPack.fromJSON({} as any);
modPack.name = values.name;
modPack.factorioVersion = values.factorioVersion;
if (values.description) { modPack.description = values.description; }
await control.send(new lib.ModPackCreateRequest(modPack.toJSON()));
await control.send(new lib.ModPackCreateRequest(modPack));
navigate(`/mods/mod-packs/${modPack.id}/view`);
})().catch(notifyErrorHandler("Error creating mod pack"));
}}
@@ -133,17 +132,17 @@ export default function ModsPage() {
let [modList] = useModList();
let [modPackList] = useModPackList();
function actions(mod) {
function actions(mod: lib.ModInfo|lib.ModRecord) {
return <Space>
{account.hasPermission("core.mod.download")
&& <Typography.Link
onClick={() => {
control.send(
new lib.ModDownloadRequest(mod.name, mod.version)
).then(streamId => {
let url = new URL(webRoot, document.location);
).then((streamId: string) => {
let url = new URL(window.webRoot, document.location.origin);
url.pathname += `api/stream/${streamId}`;
document.location = url;
document.location = url.href;
}).catch(
notifyErrorHandler("Error downloading save")
);
@@ -174,9 +173,9 @@ export default function ModsPage() {
accept=".zip"
multiple
headers={{
"X-Access-Token": control.connector.token,
"X-Access-Token": control.connector.token||"",
}}
action={`${webRoot}api/upload-mod`}
action={`${window.webRoot}api/upload-mod`}
>
<Button icon={<UploadOutlined/>}>Upload</Button>
</Upload>;
@@ -212,7 +211,7 @@ export default function ModsPage() {
]}
dataSource={modPackList}
pagination={false}
rowKey={modPack => modPack.id}
rowKey={modPack => Number(modPack.id)}
onRow={(modPack, rowIndex) => ({
onClick: event => {
navigate(`/mods/mod-packs/${modPack.id}/view`);
@@ -261,7 +260,7 @@ export default function ModsPage() {
},
]}
expandable={{
expandedRowRender: mod => <ModDetails mod={mod} actions={actions} />,
expandedRowRender: (mod: lib.ModInfo) => <ModDetails mod={mod} actions={actions} />,
expandedRowClassName: () => "no-expanded-padding",
}}
dataSource={modList}
@@ -1,6 +1,11 @@
import React from "react";
export default function PageHeader(props) {
type PageHeaderProps = {
title: string|React.ReactElement;
extra?: React.JSX.Element;
};
export default function PageHeader(props: PageHeaderProps): React.JSX.Element {
return <div className="page-header">
<h2 className="page-header-title">{props.title}</h2>
{props.extra && <div className="page-header-extra">{props.extra}</div>}
@@ -4,7 +4,14 @@ import { Layout, Breadcrumb } from "antd";
const { Content } = Layout;
export default function PageLayout(props) {
type PageLayoutProps = {
nav: {
path?: string;
name: string;
}[];
children?: any;
};
export default function PageLayout(props: PageLayoutProps) {
return <>
<Breadcrumb className="site-breadcrumb">
{props.nav.map((part, index) => <Breadcrumb.Item key={index}>
@@ -1,17 +0,0 @@
import React, { useContext } from "react";
import ControlContext from "./ControlContext";
export default function PluginExtra(params) {
let control = useContext(ControlContext);
let components = [];
for (let [name, plugin] of control.plugins) {
if (Object.prototype.hasOwnProperty.call(plugin.componentExtra, params.component)) {
let ComponentExtra = plugin.componentExtra[params.component];
components.push(<ComponentExtra key={name} plugin={plugin} {...params}/>);
}
}
return components;
}
@@ -0,0 +1,31 @@
import React, { useContext } from "react";
import * as lib from "@clusterio/lib";
import ControlContext from "./ControlContext";
import { RawUserState } from "../model/user";
import { HostState } from "../model/host";
import { InstanceState } from "../model/instance";
import { RawRoleState } from "./RoleViewPage";
type PluginExtraProps = {
component: string;
instance?: InstanceState;
user?: RawUserState;
host?: HostState;
role?: RawRoleState;
};
export default function PluginExtra(props: PluginExtraProps) {
let control = useContext(ControlContext);
let components = [];
for (let [name, plugin] of control.plugins) {
if (Object.prototype.hasOwnProperty.call(plugin.componentExtra, props.component)) {
type ComponentExtra = {[key: string]: React.ComponentType<PluginExtraProps & {plugin:lib.BaseWebPlugin}>};
let ComponentExtra = (plugin.componentExtra as ComponentExtra)[props.component];
components.push(<ComponentExtra key={name} plugin={plugin} {...props}/>);
}
}
return components;
}
@@ -2,19 +2,21 @@ import React, { useEffect, useContext, useState } from "react";
import { useParams } from "react-router-dom";
import { Alert, Descriptions, Spin } from "antd";
import type { PluginWebApi } from "@clusterio/controller/src/routes";
import ControlContext from "./ControlContext";
import PageLayout from "./PageLayout";
import notify from "../util/notify";
export default function PluginViewPage() {
let params = useParams();
let plugins = useContext(ControlContext).plugins;
let [pluginList, setPluginList] = useState(null);
let pluginName = params.name;
let [pluginList, setPluginList] = useState<PluginWebApi[]>([]);
let pluginName = String(params.name);
useEffect(() => {
(async () => {
let response = await fetch(`${webRoot}api/plugins`);
let response = await fetch(`${window.webRoot}api/plugins`);
if (response.ok) {
setPluginList(await response.json());
} else {
@@ -28,7 +30,7 @@ export default function PluginViewPage() {
let nav = [{ name: "Plugins", path: "/plugins" }, { name: pluginTitle }];
if (!pluginList) {
return <PageLayout nav={nav}>
<Descriptions borderd size="small" title={pluginTitle} />
<Descriptions bordered size="small" title={pluginTitle} />
<Spin size="large" />
</PageLayout>;
}
@@ -1,3 +0,0 @@
import React from "react";
export default React.createContext();
@@ -2,21 +2,23 @@ import React, { useContext, useEffect, useState } from "react";
import { useNavigate } from "react-router-dom";
import { Table } from "antd";
import type { PluginWebApi } from "@clusterio/controller/src/routes";
import notify from "../util/notify";
import ControlContext from "./ControlContext";
import PageLayout from "./PageLayout";
const strcmp = new Intl.Collator(undefined, { numerice: "true", sensitivity: "base" }).compare;
const strcmp = new Intl.Collator(undefined, { numeric: true, sensitivity: "base" }).compare;
export default function PluginsPage() {
let plugins = useContext(ControlContext).plugins;
let navigate = useNavigate();
let [pluginList, setPluginList] = useState([]);
let [pluginList, setPluginList] = useState<PluginWebApi[]>([]);
useEffect(() => {
(async () => {
let response = await fetch(`${webRoot}api/plugins`);
let response = await fetch(`${window.webRoot}api/plugins`);
if (response.ok) {
setPluginList(await response.json());
} else {
@@ -28,7 +30,7 @@ export default function PluginsPage() {
let tableContents = [];
for (let meta of pluginList) {
if (plugins.has(meta.name)) {
let plugin = plugins.get(meta.name);
let plugin = plugins.get(meta.name)!;
tableContents.push({
meta,
info: plugin.info,
@@ -70,7 +72,7 @@ export default function PluginsPage() {
title: "Loaded",
dataIndex: ["meta", "loaded"],
render: loaded => (loaded ? "Yes" : null),
sorter: (a, b) => a.loaded - b.loaded,
sorter: (a, b) => Number(a.meta.loaded) - Number(b.meta.loaded),
responsive: ["sm"],
},
]}
@@ -13,9 +13,14 @@ import PluginExtra from "./PluginExtra";
import { notifyErrorHandler } from "../util/notify";
function useRole(id) {
export type RawRoleState = Partial<lib.RawRole> & {
loading?: Boolean;
missing?: Boolean;
present?: Boolean;
};
function useRole(id: number): [RawRoleState, () => void] {
let control = useContext(ControlContext);
let [role, setRole] = useState({ loading: true });
let [role, setRole] = useState<RawRoleState>({ loading: true });
function updateRole() {
// XXX optimize by requesting only the role in question
@@ -51,10 +56,10 @@ export default function RoleViewPage() {
let [edited, setEdited] = useState(false);
let nav = [{ name: "Roles", path: "/roles" }, { name: role["name"] || roleId }];
let nav = [{ name: "Roles", path: "/roles" }, { name: role.name || String(roleId) }];
if (role.loading) {
return <PageLayout nav={nav}>
<PageHeader title={roleId} />
<PageHeader title={String(roleId)} />
<Spin size="large" />
</PageLayout>;
}
@@ -71,7 +76,7 @@ export default function RoleViewPage() {
description: role["description"],
permissions: {
...Object.fromEntries([...lib.permissions.values()].map(perm => [
perm.name, role["permissions"].includes(perm.name),
perm.name, role.permissions!.includes(perm.name),
])),
},
};
@@ -96,7 +101,7 @@ export default function RoleViewPage() {
}}
>
<PageHeader
title={role["name"]}
title={role.name!}
extra={<>
{canUpdate && <Button type={edited ? "primary" : "default"} htmlType="submit">Apply</Button>}
{account.hasPermission("core.role.delete") && <Popconfirm
@@ -11,8 +11,7 @@ import PageHeader from "./PageHeader";
import PageLayout from "./PageLayout";
import PluginExtra from "./PluginExtra";
const strcmp = new Intl.Collator(undefined, { numerice: "true", sensitivity: "base" }).compare;
const strcmp = new Intl.Collator(undefined, { numeric: true, sensitivity: "base" }).compare;
function CreateRoleButton() {
let control = useContext(ControlContext);
@@ -27,11 +26,11 @@ function CreateRoleButton() {
return;
}
let result = await control.send(
let idRole = await control.send(
new lib.RoleCreateRequest(values.roleName, values.description || "", [])
);
setOpen(false);
navigate(`/roles/${result.id}/view`);
navigate(`/roles/${idRole}/view`);
}
return <>
@@ -64,7 +63,7 @@ export default function RolesPage() {
let control = useContext(ControlContext);
let navigate = useNavigate();
let [roles, setRoles] = useState([]);
let [roles, setRoles] = useState<lib.RawRole[]>([]);
useEffect(() => {
control.send(new lib.RoleListRequest()).then(newRoles => {
@@ -75,7 +74,7 @@ export default function RolesPage() {
return <PageLayout nav={[{ name: "Roles" }]}>
<PageHeader
title="Roles"
extra={account.hasPermission("core.role.create") && <CreateRoleButton />}
extra={account.hasPermission("core.role.create") && <CreateRoleButton /> || undefined}
/>
<Table
columns={[
@@ -12,12 +12,19 @@ import { useAccount } from "../model/account";
import ControlContext from "./ControlContext";
import CreateSaveModal from "./CreateSaveModal";
import SectionHeader from "./SectionHeader";
import { useInstanceList } from "../model/instance";
import { InstanceState, useInstanceList } from "../model/instance";
import { useSaves } from "../model/saves";
import { notifyErrorHandler } from "../util/notify";
function RenameModal(props) {
type ModalProps = {
disabled: boolean;
save: lib.SaveDetails;
instanceId: number;
}
function RenameModal(props: ModalProps) {
let control = useContext(ControlContext);
let [open, setOpen] = useState(false);
let [form] = Form.useForm();
@@ -56,7 +63,7 @@ function RenameModal(props) {
</>;
}
function CopyModal(props) {
function CopyModal(props: ModalProps) {
let control = useContext(ControlContext);
let [open, setOpen] = useState(false);
let [form] = Form.useForm();
@@ -95,7 +102,8 @@ function CopyModal(props) {
</>;
}
function TransferModal(props) {
function TransferModal(props: ModalProps) {
let account = useAccount();
let control = useContext(ControlContext);
let [open, setOpen] = useState(false);
@@ -142,7 +150,7 @@ function TransferModal(props) {
<Select
autoFocus
showSearch
filterOption={(input, option) => option.title.toLowerCase().indexOf(input.toLowerCase()) >= 0}
filterOption={(input, option) => (option?.title.toLowerCase().indexOf(input.toLowerCase())??-1) >= 0}
>
{instanceList.filter(
instance => instance["id"] !== props.instanceId
@@ -161,32 +169,42 @@ function TransferModal(props) {
<Form.Item
name="transferredName"
label="Transferred name"
disabled={!account.hasAnyPermission("core.instance.save.rename", "core.instance.save.copy")}
>
<Input />
<Input
disabled={!account.hasAnyPermission("core.instance.save.rename", "core.instance.save.copy")}
/>
</Form.Item>
<Form.Item
name="copy"
valuePropName="checked"
label="Copy"
tooltip="Copy instead of moving the save to the new instance."
disabled={!account.hasPermission("core.instance.save.copy")}
>
<Checkbox />
<Checkbox
disabled={!account.hasPermission("core.instance.save.copy")}
/>
</Form.Item>
</Form>
</Modal>
</>;
}
export default function SavesList(props) {
type File = {
uid: string;
name: string;
percent: number;
status: string;
}
export default function SavesList(props: { instance: InstanceState }) {
let account = useAccount();
let control = useContext(ControlContext);
let saves = useSaves(props.instance.id);
let [starting, setStarting] = useState(false);
let [uploadingFiles, setUploadingFiles] = useState([]);
let [uploadingFiles, setUploadingFiles] = useState<File[]>([]);
let hostOffline = ["unassigned", "unknown"].includes(props.instance.status);
let hostOffline = ["unassigned", "unknown"].includes(props.instance.status!);
const saveTable = <Table
size="small"
columns={[
@@ -228,7 +246,7 @@ export default function SavesList(props) {
onClick={() => {
setStarting(true);
control.sendTo(
{ instanceId: props.instance.id },
{ instanceId: props.instance.id! },
new lib.InstanceStartRequest(save.name),
).catch(
notifyErrorHandler("Error loading save")
@@ -238,27 +256,27 @@ export default function SavesList(props) {
}}
>Load save</Button>}
{account.hasPermission("core.instance.save.rename") && <RenameModal
disabled={hostOffline} instanceId={props.instance.id} save={save}
disabled={hostOffline} instanceId={props.instance.id!} save={save}
/>}
{account.hasPermission("core.instance.save.copy") && <CopyModal
disabled={hostOffline} instanceId={props.instance.id} save={save}
disabled={hostOffline} instanceId={props.instance.id!} save={save}
/>}
{account.hasPermission("core.instance.save.download") && <Button
disabled={hostOffline}
onClick={() => {
control.send(
new lib.InstanceDownloadSaveRequest(props.instance.id, save.name)
new lib.InstanceDownloadSaveRequest(props.instance.id!, save.name)
).then(streamId => {
let url = new URL(webRoot, document.location);
let url = new URL(window.webRoot, document.location.href);
url.pathname += `api/stream/${streamId}`;
document.location = url;
document.location.assign(url);
}).catch(
notifyErrorHandler("Error downloading save")
);
}}
>Download</Button>}
{account.hasPermission("core.instance.save.transfer") && <TransferModal
disabled={hostOffline} instanceId={props.instance.id} save={save}
disabled={hostOffline} instanceId={props.instance.id!} save={save}
/>}
{account.hasPermission("core.instance.save.delete") && <Popconfirm
title="Permanently delete save?"
@@ -267,7 +285,7 @@ export default function SavesList(props) {
okButtonProps={{ danger: true }}
onConfirm={() => {
control.send(
new lib.InstanceDeleteSaveRequest(props.instance.id, save.name)
new lib.InstanceDeleteSaveRequest(props.instance.id!, save.name)
).catch(notifyErrorHandler("Error deleting save"));
}}
>
@@ -277,7 +295,7 @@ export default function SavesList(props) {
}}
/>;
function onChange(changeEvent) {
function onChange(changeEvent: any) {
if (["done", "error"].includes(changeEvent.file.status)) {
if (changeEvent.file.status === "error") {
notifyErrorHandler("Error uploading file")(changeEvent.file.error);
@@ -292,7 +310,7 @@ export default function SavesList(props) {
return;
}
let file = {
let file: File = {
uid: changeEvent.file.uid,
name: changeEvent.file.name,
percent: changeEvent.file.percent,
@@ -314,13 +332,13 @@ export default function SavesList(props) {
name: "file",
accept: ".zip",
headers: {
"X-Access-Token": control.connector.token,
"X-Access-Token": control.connector.token || "",
},
data: {
instance_id: props.instance.id,
},
showUploadList: false,
action: `${webRoot}api/upload-save`,
action: `${window.webRoot}api/upload-save`,
onChange,
};
@@ -343,7 +361,7 @@ export default function SavesList(props) {
{file.name}
<Progress
percent={file.percent}
format={percent => `${Math.floor(percent)}%`}
format={percent => `${Math.floor(percent||0)}%`}
status={file.status === "error" ? "exception" : "normal"}
/>
</List.Item>)}
@@ -1,6 +1,10 @@
import React from "react";
export default function SectionHeader(props) {
type SectionHeader = {
title: string;
extra?: React.JSX.Element;
};
export default function SectionHeader(props: SectionHeader): React.JSX.Element {
return <div className="section-header">
<div className="section-header-title">{props.title}</div>
{props.extra && <div className="section-header-extra">{props.extra}</div>}
@@ -1,6 +1,6 @@
import React, { useContext, useEffect, useState } from "react";
import { Route, Routes, useNavigate } from "react-router-dom";
import { Dropdown, Layout, Menu } from "antd";
import { Dropdown, Layout, Menu, MenuProps } from "antd";
import UserOutlined from "@ant-design/icons/UserOutlined";
import webUiPackage from "../../package.json";
@@ -12,22 +12,21 @@ import { pages } from "../pages";
const { Header, Sider } = Layout;
export default function SiteLayout(props) {
export default function SiteLayout() {
let navigate = useNavigate();
let [currentSidebarPath, setCurrentSidebarPath] = useState(null);
let [currentSidebarPath, setCurrentSidebarPath] = useState<string|null>(null);
let account = useAccount();
let plugins = useContext(ControlContext).plugins;
function SetSidebar(setSidebarProps) {
function SetSidebar(props: { path: string|null }) {
useEffect(() => {
setCurrentSidebarPath(setSidebarProps.path);
setCurrentSidebarPath(props.path);
});
return null;
}
let accountMenuProps = {
onClick: ({ key }) => {
let accountMenuProps: MenuProps = {
onClick: ({ key }: {key:string}) => {
if (key === "user") {
navigate(`/users/${account.name}/view`);
} else if (key === "logOut") {
@@ -87,7 +86,7 @@ export default function SiteLayout(props) {
<Dropdown
className="account-dropdown-header"
placement="bottomRight"
trigger="click"
trigger={["click"]}
menu={accountMenuProps}
>
<UserOutlined/>
@@ -105,7 +104,7 @@ export default function SiteLayout(props) {
<Menu
mode="inline"
defaultOpenKeys={[...menuGroups.keys()]}
selectedKeys={[currentSidebarPath]}
selectedKeys={currentSidebarPath ? [currentSidebarPath] : []}
style={{ height: "100%", borderRight: 0 }}
onClick={({ key }) => navigate(key)}
items={menuItems}
@@ -5,27 +5,33 @@ import * as lib from "@clusterio/lib";
import ControlContext from "./ControlContext";
import { notifyErrorHandler } from "../util/notify";
import type { InstanceState } from "../model/instance";
import { ButtonProps } from "antd/es/button";
export default function StartStopInstanceButton(props) {
type StartStopInstanceButtonProps = {
instance: InstanceState;
onFinish?: () => void;
buttonProps?: ButtonProps;
};
export default function StartStopInstanceButton(props: StartStopInstanceButtonProps) {
let control = useContext(ControlContext);
let [switching, setSwitching] = useState(false);
let [switching, setSwitching] = useState<boolean>(false);
function onClick(event) {
const onClick: React.MouseEventHandler<HTMLElement> = function(event) {
event.stopPropagation();
setSwitching(true);
let action;
if (props.instance["status"] === "stopped") {
if (props.instance.status === "stopped") {
action = control.sendTo(
{ instanceId: props.instance["id"] },
{ instanceId: props.instance.id! },
new lib.InstanceStartRequest(undefined),
).catch(
notifyErrorHandler("Error starting instance")
);
} else if (["starting", "running"].includes(props.instance["status"])) {
} else if (["starting", "running"].includes(props.instance.status!)) {
action = control.sendTo(
{ instanceId: props.instance["id"] },
{ instanceId: props.instance.id! },
new lib.InstanceStopRequest(),
).catch(
notifyErrorHandler("Error stopping instance")
@@ -48,11 +54,9 @@ export default function StartStopInstanceButton(props) {
{...(props.buttonProps || {})}
loading={switching}
type="primary"
disabled={!["starting", "running", "stopped"].includes(props.instance["status"])}
disabled={!["starting", "running", "stopped"].includes(props.instance.status!)}
onClick={onClick}
>
{props.instance["status"] === "stopped" ? "Start" : "Stop"}
{props.instance.status === "stopped" ? "Start" : "Stop"}
</Button>;
}
@@ -19,7 +19,7 @@ import notify, { notifyErrorHandler } from "../util/notify";
import { formatDuration } from "../util/time_format";
import { formatLastSeen, sortLastSeen, useUser } from "../model/user";
const strcmp = new Intl.Collator(undefined, { numerice: "true", sensitivity: "base" }).compare;
const strcmp = new Intl.Collator(undefined, { numeric: true, sensitivity: "base" }).compare;
// The user page has a lot of optional elements, that does not make it
@@ -27,7 +27,7 @@ const strcmp = new Intl.Collator(undefined, { numerice: "true", sensitivity: "ba
// eslint-disable-next-line complexity
export default function UserViewPage() {
let params = useParams();
let userName = params.name;
let userName = params.name as string;
let navigate = useNavigate();
@@ -35,12 +35,12 @@ export default function UserViewPage() {
let control = useContext(ControlContext);
let [instanceList] = useInstanceList();
let [user] = useUser(userName);
let [roles, setRoles] = useState(null);
let [roles, setRoles] = useState<Map<number, lib.RawRole>>(new Map());
let [form] = Form.useForm();
let [rolesDirty, setRolesDirty] = useState(false);
let [banReasonDirty, setBanReasonDirty] = useState(false);
let [applyingRoles, setApplyingRoles] = useState(false);
let [rolesError, setRolesError] = useState();
let [rolesDirty, setRolesDirty] = useState<boolean>(false);
let [banReasonDirty, setBanReasonDirty] = useState<boolean>(false);
let [applyingRoles, setApplyingRoles] = useState<boolean>(false);
let [rolesError, setRolesError] = useState<string|undefined>();
useEffect(() => {
control.send(new lib.RoleListRequest()).then(newRoles => {
@@ -88,9 +88,9 @@ export default function UserViewPage() {
loading={!roles}
mode="multiple"
showArrow={true}
filterOption={(inputValue, option) => {
filterOption={(inputValue:string, option: any): boolean => {
let role = roles.get(option.value);
return role && role.name.toLowerCase().includes(inputValue.toLowerCase());
return role?.name.toLowerCase().includes(inputValue.toLowerCase()) ?? false;
}}
>
{roles && [...roles.values()].map(r => <Select.Option
@@ -100,9 +100,9 @@ export default function UserViewPage() {
</Select>
</Form.Item>;
function instanceName(id) {
function instanceName(id: number): string {
let instance = instanceList.find(i => i.id === id);
return instance ? instance.name : id;
return instance ? instance.name : String(id);
}
return <PageLayout nav={nav}>
@@ -181,7 +181,7 @@ export default function UserViewPage() {
<Col flex="auto">
{account.hasPermission("core.user.update_roles")
? roleSelector
: [...user.roles].map(id => <Tag key={id}>{
: [...user.roles!].map(id => <Tag key={id}>{
roles ? (roles.get(id) || { name: id }).name : id
}</Tag>)
}
@@ -198,7 +198,7 @@ export default function UserViewPage() {
new lib.UserUpdateRolesRequest(userName, newRoles)
).then(() => {
setRolesDirty(false);
setRolesError();
setRolesError(undefined);
}).catch(err => {
setRolesError(err.message);
return form.validateFields();
@@ -288,10 +288,10 @@ export default function UserViewPage() {
<SectionHeader title="Player stats" />
<Descriptions size="small" bordered column={{ xs: 1, sm: 2, lg: 3 }}>
<Descriptions.Item label="Total online time">
{formatDuration(user.playerStats.onlineTimeMs || 0)}
{formatDuration(user.playerStats?.onlineTimeMs ?? 0)}
</Descriptions.Item>
<Descriptions.Item label="Total join count">
{user.playerStats.joinCount || 0}
{user.playerStats?.joinCount ?? 0}
</Descriptions.Item>
<Descriptions.Item label="Last seen">
{formatLastSeen(user) || " "}
@@ -306,7 +306,7 @@ export default function UserViewPage() {
key: "instance",
render: ([id]) => instanceName(id),
defaultSortOrder: "ascend",
sorter: (a, b) => strcmp(a[0], b[0]),
sorter: (a, b) => strcmp(instanceName(a[0]), instanceName(b[0])),
},
{
title: "Online time",
@@ -328,7 +328,7 @@ export default function UserViewPage() {
sorter: (a, b) => sortLastSeen(user, user, a[0], b[0]),
},
]}
dataSource={[...user.instanceStats.entries()]}
dataSource={[...(user.instanceStats || []).entries()]}
pagination={false}
rowKey={([id]) => id}
onRow={([id], rowIndex) => ({
@@ -13,7 +13,7 @@ import PageLayout from "./PageLayout";
import PluginExtra from "./PluginExtra";
import { formatLastSeen, sortLastSeen, useUserList } from "../model/user";
const strcmp = new Intl.Collator(undefined, { numerice: "true", sensitivity: "base" }).compare;
const strcmp = new Intl.Collator(undefined, { numeric: true, sensitivity: "base" }).compare;
function CreateUserButton() {
@@ -75,14 +75,14 @@ export default function UsersPage() {
return <PageLayout nav={[{ name: "Users" }]}>
<PageHeader
title="Users"
extra={account.hasPermission("core.user.create") && <CreateUserButton />}
extra={account.hasPermission("core.user.create") && <CreateUserButton /> || undefined}
/>
<Table
columns={[
{
title: "Name",
key: "name",
render: user => <Space>
render: (user: lib.RawUser) => <Space>
{user.name}
<span>
{user.isAdmin && <Tag color="gold">Admin</Tag>}
@@ -96,21 +96,21 @@ export default function UsersPage() {
{
title: "Roles",
key: "roles",
render: user => user.roles.map(id => <Tag key={id}>{(roles.get(id) || { name: id }).name}</Tag>),
render: (user: lib.RawUser) => user.roles.map(id => <Tag key={id}>{(roles.get(id) || { name: id }).name}</Tag>),
},
{
title: "Online time",
key: "onlineTime",
render: user => (user.playerStats.onlineTimeMs
render: (user: lib.RawUser) => (user.playerStats?.onlineTimeMs
? formatDuration(user.playerStats.onlineTimeMs) : null),
sorter: (a, b) => (a.playerStats.onlineTimeMs || 0) -
(b.playerStats.onlineTimeMs || 0),
sorter: (a, b) => (a.playerStats?.onlineTimeMs ?? 0) -
(b.playerStats?.onlineTimeMs ?? 0),
responsive: ["lg"],
},
{
title: "Last seen",
key: "lastSeen",
render: user => formatLastSeen(user),
render: (user: lib.RawUser) => formatLastSeen(user),
sorter: (a, b) => sortLastSeen(a, b),
responsive: ["lg"],
},