mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-13 15:14:52 +09:00
Hornwitser
5dcaca4d0b
Migrate the usage of CommonJS specific code and imports to ESM. Roughly summarised this: - Changes all require() calls to import statement or expressions. - Changes usage of module.exports to export statements. - Replaces require.resolve with import.meta.resolve. - Replaces conditional imports with conditional subpath imports. - Replaces module === require.main with import.meta.main. - Adds the full filename with extention to all relative imports. - Changes all usage of __dirname and __filename to their import.meta equivalents. - Sets "type": "module" in package.json files. - Removes usage of "use strict". - Adds .ts an an alias of .js for the webpack build. Due to differences in how require and import resolves files the plugin entrypoints will have to include the filename and extension after this migration in order to work.
109 lines
2.9 KiB
TypeScript
109 lines
2.9 KiB
TypeScript
import { Static, Type } from "@sinclair/typebox";
|
|
import { StringEnum } from "./composites.js";
|
|
import { TargetVersion, TargetVersionSchema } from "./version.js";
|
|
|
|
export const InstanceStatus = StringEnum([
|
|
"unknown",
|
|
"unassigned",
|
|
"stopped",
|
|
"starting",
|
|
"running",
|
|
"stopping",
|
|
"creating_save",
|
|
"exporting_data",
|
|
"deleted",
|
|
]);
|
|
|
|
/**
|
|
* Current status of the instance. One of:
|
|
* - `unknown`: Instance is assigned to a host but this host is currently
|
|
* not connected to the contreller.
|
|
* - `unassigned`: Instance is not assigned to a a host and exists only on
|
|
* the controller.
|
|
* - `stopped`: Instance is stopped.
|
|
* - `starting`: Instance is in the process of starting up.
|
|
* - `running`: Instance is running normally.
|
|
* - `stopping`: Instance is in the process of stopping.
|
|
* - `creating_save`: Instance is in the process of creating a save.
|
|
* - `exporting_data`: Instance is in the process of exporting game data.
|
|
* - `deleted`: Instance has been deleted.
|
|
*/
|
|
export type InstanceStatus = Static<typeof InstanceStatus>;
|
|
|
|
export default class InstanceDetails {
|
|
constructor(
|
|
public name: string,
|
|
public id: number,
|
|
public assignedHost: number | undefined,
|
|
public gamePort: number | undefined,
|
|
public status: InstanceStatus,
|
|
public factorioVersion: TargetVersion | undefined,
|
|
public startedAtMs = 0,
|
|
/** Millisecond Unix timestamp this entry was last updated at */
|
|
public updatedAtMs = 0,
|
|
public excludeFromStartAll = false
|
|
) {}
|
|
|
|
get isDeleted() {
|
|
return this.status === "deleted";
|
|
}
|
|
|
|
static jsonSchema = Type.Object({
|
|
"name": Type.String(),
|
|
"id": Type.Integer(),
|
|
"assignedHost": Type.Optional(Type.Integer()),
|
|
"gamePort": Type.Optional(Type.Integer()),
|
|
"status": StringEnum([
|
|
"unknown", "unassigned", "stopped", "starting", "running", "stopping",
|
|
"creating_save", "exporting_data", "deleted",
|
|
]),
|
|
"factorioVersion": Type.Optional(TargetVersionSchema),
|
|
"startedAtMs": Type.Optional(Type.Number()),
|
|
"updatedAtMs": Type.Optional(Type.Number()),
|
|
"excludeFromStartAll": Type.Optional(Type.Boolean()),
|
|
});
|
|
|
|
static fromJSON(json: Static<typeof this.jsonSchema>) {
|
|
return new this(
|
|
json.name,
|
|
json.id,
|
|
json.assignedHost,
|
|
json.gamePort,
|
|
json.status,
|
|
json.factorioVersion,
|
|
json.startedAtMs,
|
|
json.updatedAtMs,
|
|
json.excludeFromStartAll
|
|
);
|
|
}
|
|
|
|
toJSON() {
|
|
const json = {
|
|
name: this.name,
|
|
id: this.id,
|
|
status: this.status,
|
|
} as Static<typeof InstanceDetails.jsonSchema>;
|
|
|
|
if (this.assignedHost !== undefined) {
|
|
json.assignedHost = this.assignedHost;
|
|
}
|
|
if (this.gamePort !== undefined) {
|
|
json.gamePort = this.gamePort;
|
|
}
|
|
if (this.factorioVersion !== undefined) {
|
|
json.factorioVersion = this.factorioVersion;
|
|
}
|
|
if (this.startedAtMs !== 0) {
|
|
json.startedAtMs = this.startedAtMs;
|
|
}
|
|
if (this.updatedAtMs !== 0) {
|
|
json.updatedAtMs = this.updatedAtMs;
|
|
}
|
|
if (this.excludeFromStartAll !== false) {
|
|
json.excludeFromStartAll = this.excludeFromStartAll;
|
|
}
|
|
|
|
return json;
|
|
}
|
|
}
|