Flatten lib namespace

Move all functions and classes currently available through lib/name and
libName to be under a single flat namespace in lib.  This make
reorganising the lib namespace much simpler as the location of symbols
can move without breaking the consumers of lib.

The multi-entrypoint design was already problematic for the web plugin
system which couldn't effectively use it due to how webpack's shared
module system is awkward to set up with multiple entrypoints per package.
This commit is contained in:
Hornwitser committed 2023-07-28 16:03:29 +02:00
1 parent bb58670597
commit bfe119eaa3
143 files changed
+1798 -1918

No files matched your search

+1 -1
View File
@@ -5,7 +5,7 @@
*
* Tracks files stored on disk for data that extracted from Factorio using a
* given mod pack.
* @alias module:lib/data.ExportManifest
* @alias module:lib.ExportManifest
*/
class ExportManifest {
+1 -1
View File
@@ -15,7 +15,7 @@ const { integerModVersion, integerFactorioVersion, modVersionRegExp } = require(
*
* See https://wiki.factorio.com/Tutorial:Mod_structure#info.json for
* details of the invidiual fields sourced from info.json.
* @alias module:lib/data.ModInfo
* @alias module:lib.ModInfo
*/
class ModInfo {
/**
+6 -6
View File
@@ -9,7 +9,7 @@ const { integerFactorioVersion } = require("./version");
/**
* A setting for a mod.
* @typedef {object} module:lib/data.ModPack~ModSetting
* @typedef {object} module:lib.ModPack~ModSetting
* @property {boolean|number|string} value - Value of the given mod setting.
*/
const ModSettingJsonSchema = {
@@ -28,7 +28,7 @@ const ModSettingsJsonSchema = {
/**
* A mod in a mod pack
* @typedef {object} module:lib/data.ModPack~ModRecord
* @typedef {object} module:lib.ModPack~ModRecord
* @property {string} name - name of the mod.
* @property {boolean} enabled - if mod is to be loaded.
* @property {string} version - version of the mod.
@@ -49,7 +49,7 @@ const ModRecordJsonSchema = {
* Factorio Mod Pack
*
* Tracks mods and settings for a collection of Factorio mods.
* @alias module:lib/data.ModPack
* @alias module:lib.ModPack
*/
class ModPack {
/**
@@ -86,13 +86,13 @@ class ModPack {
/**
* Mods included in this mod pack
* @type {Map<string, module:lib/data.ModPack~ModRecord>}
* @type {Map<string, module:lib.ModPack~ModRecord>}
*/
mods = new Map();
/**
* Mod settings for this mod pack
* @type {Object<string, Map<string, module:lib/data.ModPack~ModSetting>>=}
* @type {Object<string, Map<string, module:lib.ModPack~ModSetting>>=}
*/
settings = {
"startup": new Map(),
@@ -102,7 +102,7 @@ class ModPack {
/**
* Mapping to files containing exported data for this modpack
* @type {module:lib/data.ExportManifest|undefined}
* @type {module:lib.ExportManifest|undefined}
*/
exportManifest;
+11 -11
View File
@@ -2,7 +2,7 @@
const { JsonString } = require("./composites");
// TODO: remove after config refactor
/** @memberof module:lib/data */
/** @memberof module:lib */
class RawConfig {
/** @type {object} */
serializedConfig;
@@ -24,7 +24,7 @@ class RawConfig {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class ControllerConfigGetRequest {
static type = "request";
static src = "control";
@@ -33,7 +33,7 @@ class ControllerConfigGetRequest {
static Response = RawConfig;
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class ControllerConfigSetFieldRequest {
static type = "request";
static src = "control";
@@ -64,7 +64,7 @@ class ControllerConfigSetFieldRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class ControllerConfigSetPropRequest {
static type = "request";
static src = "control";
@@ -99,7 +99,7 @@ class ControllerConfigSetPropRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class HostGenerateTokenRequest {
static type = "request";
static src = "control";
@@ -128,7 +128,7 @@ class HostGenerateTokenRequest {
static Response = JsonString;
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class HostConfigCreateRequest {
static type = "request";
static src = "control";
@@ -165,7 +165,7 @@ class HostConfigCreateRequest {
static Response = RawConfig;
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class LogSetSubscriptionsRequest {
static type = "request";
static src = "control";
@@ -214,7 +214,7 @@ class LogSetSubscriptionsRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class LogQueryRequest {
static type = "request";
static src = "control";
@@ -298,7 +298,7 @@ LogQueryRequest.Response = class Response {
}
};
/** @memberof module:lib/data */
/** @memberof module:lib */
class LogMessageEvent {
static type = "event";
static src = ["host", "controller"];
@@ -331,7 +331,7 @@ class LogMessageEvent {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class DebugDumpWsRequest {
static type = "request";
static src = "control";
@@ -339,7 +339,7 @@ class DebugDumpWsRequest {
static permission = "core.debug.dump_ws";
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class DebugWsMessageEvent {
static type = "event";
static src = "controller";
+35 -35
View File
@@ -2,7 +2,7 @@
const libSchema = require("../schema");
/** @memberof module:lib/data */
/** @memberof module:lib */
class Address {
/** Controller address */
static controller = 0;
@@ -44,9 +44,9 @@ class Address {
* `"allHosts"`: new Address(Address.broadcast, Address.host)
* `"allInstances"`: new Address(Address.broadcast, Address.instance)
* `"allControls"`: new Address(Address.broadcast, Address.control)
* @param {module:lib/data.Address|string|object} shorthand -
* @param {module:lib.Address|string|object} shorthand -
* Shorthand to translate with.
* @returns {module:lib/data.Address} Translated address.
* @returns {module:lib.Address} Translated address.
*/
static fromShorthand(shorthand) {
if (shorthand instanceof Address) { return shorthand; }
@@ -107,7 +107,7 @@ class Address {
/**
* Returns true if this address targets the given destination
* @param {module:lib/Data.Address} dst - Destination to check
* @param {module:lib.Address} dst - Destination to check
* @returns {boolean} true if this address is addressed to the given destination
*/
addressedTo(dst) {
@@ -129,7 +129,7 @@ class Address {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class Message {
/** @type {string} */
type;
@@ -161,7 +161,7 @@ class Message {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class HelloData {
/** @type {string} */
version;
@@ -190,9 +190,9 @@ class HelloData {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class MessageHello extends Message {
/** @type {module:lib/data.HelloData} */
/** @type {module:lib.HelloData} */
data;
constructor(data) {
@@ -214,7 +214,7 @@ class MessageHello extends Message {
}
};
/** @memberof module:lib/data */
/** @memberof module:lib */
class RegisterHostData {
/** @type {string} */
token;
@@ -263,9 +263,9 @@ class RegisterHostData {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class MessageRegisterHost extends Message {
/** @type {module:lib/data.RegisterHostData} */
/** @type {module:lib.RegisterHostData} */
data;
constructor(data) {
@@ -287,7 +287,7 @@ class MessageRegisterHost extends Message {
}
};
/** @memberof module:lib/data */
/** @memberof module:lib */
class RegisterControlData {
/** @type {string} */
token;
@@ -317,9 +317,9 @@ class RegisterControlData {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class MessageRegisterControl extends Message {
/** @type {module:lib/data.RegisterControlData} */
/** @type {module:lib.RegisterControlData} */
data;
constructor(data) {
@@ -341,7 +341,7 @@ class MessageRegisterControl extends Message {
}
};
/** @memberof module:lib/data */
/** @memberof module:lib */
class AccountDetails {
/** @type {string} */
name;
@@ -381,9 +381,9 @@ class AccountDetails {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class ReadyData {
/** @type {module:lib/data.Address} */
/** @type {module:lib.Address} */
src;
/** @type {string} */
sessionToken;
@@ -427,9 +427,9 @@ class ReadyData {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class MessageReady extends Message {
/** @type {module:lib/data.ReadyData} */
/** @type {module:lib.ReadyData} */
data;
constructor(data) {
@@ -451,7 +451,7 @@ class MessageReady extends Message {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class ResumeData {
/** @type {string} */
sessionToken;
@@ -478,9 +478,9 @@ class ResumeData {
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class MessageResume extends Message {
/** @type {module:lib/data.ResumeData} */
/** @type {module:lib.ResumeData} */
data;
constructor(data) {
@@ -502,7 +502,7 @@ class MessageResume extends Message {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class ContinueData {
/** @type {number} */
sessionTimeout;
@@ -532,9 +532,9 @@ class ContinueData {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class MessageContinue extends Message {
/** @type {module:lib/data.ContinueData} */
/** @type {module:lib.ContinueData} */
data;
constructor(data) {
@@ -556,7 +556,7 @@ class MessageContinue extends Message {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class MessageInvalidate extends Message {
constructor() {
super("invalidate");
@@ -574,7 +574,7 @@ class MessageInvalidate extends Message {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class MessageHeartbeat extends Message {
/** @type {integer|undefined} */
seq;
@@ -598,7 +598,7 @@ class MessageHeartbeat extends Message {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class MessageRequest extends Message {
/** @type {number} */
seq;
@@ -644,7 +644,7 @@ class MessageRequest extends Message {
}
};
/** @memberof module:lib/data */
/** @memberof module:lib */
class MessageResponse extends Message {
/** @type {number} */
seq;
@@ -685,7 +685,7 @@ class MessageResponse extends Message {
}
};
/** @memberof module:lib/data */
/** @memberof module:lib */
class ResponseError {
/** @type {string} */
message;
@@ -715,7 +715,7 @@ class ResponseError {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class MessageResponseError extends Message {
/** @type {number} */
seq;
@@ -723,7 +723,7 @@ class MessageResponseError extends Message {
src;
/** @type {Address} */
dst;
/** @type {module:lib/data.ResponseError} */
/** @type {module:lib.ResponseError} */
data;
constructor(seq, src, dst, data) {
@@ -756,7 +756,7 @@ class MessageResponseError extends Message {
}
};
/** @memberof module:lib/data */
/** @memberof module:lib */
class MessageEvent extends Message {
/** @type {number} */
seq;
@@ -802,7 +802,7 @@ class MessageEvent extends Message {
}
};
/** @memberof module:lib/data */
/** @memberof module:lib */
class MessageDisconnect extends Message {
/** @type {string} */
data;
@@ -853,7 +853,7 @@ Message.jsonSchema = {
};
Message.validate = libSchema.compile(Message.jsonSchema);
/** @memberof module:lib/data */
/** @memberof module:lib */
class PingRequest {
static type = "request";
static src = ["controller", "host", "control"];
+9 -9
View File
@@ -2,7 +2,7 @@
const { jsonArray } = require("./composites");
/** @memberof module:lib/data */
/** @memberof module:lib */
class HostDetails {
/** @type {string} */
agent;
@@ -44,7 +44,7 @@ class HostDetails {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class HostListRequest {
static type = "request";
static src = "control";
@@ -53,7 +53,7 @@ class HostListRequest {
static Response = jsonArray(HostDetails);
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class HostSetSubscriptionsRequest {
static type = "request";
static src = "control";
@@ -88,13 +88,13 @@ class HostSetSubscriptionsRequest {
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class HostUpdateEvent {
static type = "event";
static src = "controller";
static dst = "control";
/** @type {module:lib/data.HostDetails} */
/** @type {module:lib.HostDetails} */
update;
constructor(update) {
@@ -114,7 +114,7 @@ class HostUpdateEvent {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class HostMetricsRequest {
static type = "request";
static src = "controller";
@@ -143,7 +143,7 @@ HostMetricsRequest.Response = class Response { // TODO: Use JSON class pattern i
}
};
/** @memberof module:lib/data */
/** @memberof module:lib */
class ControllerConnectionEvent {
static type = "event";
static src = "host";
@@ -169,14 +169,14 @@ class ControllerConnectionEvent {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class PrepareControllerDisconnectRequest {
static type = "request";
static src = "host";
static dst = "instance";
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class SyncUserListsEvent {
static type = "event";
static src = "controller";
+47 -47
View File
@@ -2,7 +2,7 @@
const PlayerStats = require("../PlayerStats");
const { JsonString, jsonArray } = require("./composites");
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceDetails {
/** @type {string} */
name;
@@ -43,7 +43,7 @@ class InstanceDetails {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceDetailsGetRequest {
static type = "request";
static src = "control";
@@ -72,7 +72,7 @@ class InstanceDetailsGetRequest {
static Response = InstanceDetails;
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceDetailsListRequest {
static type = "request";
static src = "control";
@@ -81,7 +81,7 @@ class InstanceDetailsListRequest {
static Response = jsonArray(InstanceDetails);
};
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceDetailsSetSubscriptionsRequest {
static type = "request";
static src = "control";
@@ -115,13 +115,13 @@ class InstanceDetailsSetSubscriptionsRequest {
}
};
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceDetailsUpdateEvent {
static type = "event";
static src = "controller";
static dst = "control";
/** @type {module:lib/data.InstanceDetails} */
/** @type {module:lib.InstanceDetails} */
details;
constructor(details) {
@@ -139,7 +139,7 @@ class InstanceDetailsUpdateEvent {
}
};
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceCreateRequest {
static type = "request";
static src = "control";
@@ -167,7 +167,7 @@ class InstanceCreateRequest {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceConfigGetRequest {
static type = "request";
static src = "control";
@@ -215,7 +215,7 @@ InstanceConfigGetRequest.Response = class Response {
}
};
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceConfigSetFieldRequest {
static type = "request";
static src = "control";
@@ -250,7 +250,7 @@ class InstanceConfigSetFieldRequest {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceConfigSetPropRequest {
static type = "request";
static src = "control";
@@ -291,7 +291,7 @@ class InstanceConfigSetPropRequest {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceAssignRequest {
static type = "request";
static src = "control";
@@ -322,7 +322,7 @@ class InstanceAssignRequest {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceMetricsRequest {
static type = "request";
static src = "host";
@@ -351,7 +351,7 @@ InstanceMetricsRequest.Response = class Response { // TODO: Use JSON class patte
}
};
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceStartRequest {
static type = "request";
static src = ["control", "controller"];
@@ -377,7 +377,7 @@ class InstanceStartRequest {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class SaveDetails {
/** @type {string} */
type;
@@ -419,7 +419,7 @@ class SaveDetails {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceListSavesRequest {
static type = "request";
static src = "control";
@@ -428,7 +428,7 @@ class InstanceListSavesRequest {
static Response = jsonArray(SaveDetails);
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceSetSaveListSubscriptionsRequest {
static type = "request";
static src = "control";
@@ -462,7 +462,7 @@ class InstanceSetSaveListSubscriptionsRequest {
}
};
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceSaveListUpdateEvent {
static type = "event";
static src = ["instance", "host", "controller"];
@@ -470,7 +470,7 @@ class InstanceSaveListUpdateEvent {
/** @type {number} */
instanceId;
/** @type {module:lib/data.SaveDetails} */
/** @type {module:lib.SaveDetails} */
saves;
constructor(instanceId, saves) {
@@ -495,7 +495,7 @@ class InstanceSaveListUpdateEvent {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceCreateSaveRequest {
static type = "request";
static src = "control";
@@ -534,7 +534,7 @@ class InstanceCreateSaveRequest {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceRenameSaveRequest {
static type = "request";
static src = ["control", "controller"];
@@ -569,7 +569,7 @@ class InstanceRenameSaveRequest {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceCopySaveRequest {
static type = "request";
static src = ["control", "controller"];
@@ -604,7 +604,7 @@ class InstanceCopySaveRequest {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceDeleteSaveRequest {
static type = "request";
static src = ["control", "controller"];
@@ -635,7 +635,7 @@ class InstanceDeleteSaveRequest {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceDownloadSaveRequest {
static type = "request";
static src = "control";
@@ -668,7 +668,7 @@ class InstanceDownloadSaveRequest {
static Response = JsonString;
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceTransferSaveRequest {
static type = "request";
static src = ["control", "controller"];
@@ -724,7 +724,7 @@ class InstanceTransferSaveRequest {
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstancePullSaveRequest {
static type = "request";
static src = "controller";
@@ -760,7 +760,7 @@ class InstancePullSaveRequest {
static Response = JsonString;
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstancePushSaveRequest {
static type = "request";
static src = "controller";
@@ -794,7 +794,7 @@ class InstancePushSaveRequest {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceLoadScenarioRequest {
static type = "request";
static src = "control";
@@ -833,7 +833,7 @@ class InstanceLoadScenarioRequest {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceExportDataRequest {
static type = "request";
static src = "control";
@@ -841,7 +841,7 @@ class InstanceExportDataRequest {
static permission = "core.instance.export_data";
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceExtractPlayersRequest {
static type = "request";
static src = "control";
@@ -849,7 +849,7 @@ class InstanceExtractPlayersRequest {
static permission = "core.instance.extract_players";
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceStopRequest {
static type = "request";
static src = "control";
@@ -857,7 +857,7 @@ class InstanceStopRequest {
static permission = "core.instance.stop";
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceKillRequest {
static type = "request";
static src = "control";
@@ -865,7 +865,7 @@ class InstanceKillRequest {
static permission = "core.instance.kill";
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceDeleteRequest {
static type = "request";
static src = "control";
@@ -892,7 +892,7 @@ class InstanceDeleteRequest {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceDeleteInternalRequest {
static type = "request";
static src = "controller";
@@ -918,7 +918,7 @@ class InstanceDeleteInternalRequest {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceSendRconRequest {
static type = "request";
static src = "control";
@@ -948,7 +948,7 @@ class InstanceSendRconRequest {
}
// TODO remove this after config refactor
/** @memberof module:lib/data */
/** @memberof module:lib */
class RawInstanceInfo {
/** @type {object} */
config;
@@ -977,13 +977,13 @@ class RawInstanceInfo {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstancesUpdateRequest {
static type = "request";
static src = "host";
static dst = "controller";
/** @type {Array<module:lib/data.RawInstanceInfo>} */
/** @type {Array<module:lib.RawInstanceInfo>} */
instances;
constructor(instances) {
@@ -1004,7 +1004,7 @@ class InstancesUpdateRequest {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceAssignInternalRequest {
static type = "request";
static src = "controller";
@@ -1035,7 +1035,7 @@ class InstanceAssignInternalRequest {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceUnassignInternalRequest {
static type = "request";
static src = "controller";
@@ -1061,7 +1061,7 @@ class InstanceUnassignInternalRequest {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceInitialisedEvent {
static type = "event";
static src = "instance";
@@ -1090,7 +1090,7 @@ class InstanceInitialisedEvent {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceStatusChangedEvent {
static type = "event";
static src = ["instance", "host"];
@@ -1129,13 +1129,13 @@ class InstanceStatusChangedEvent {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceDetailsChangedEvent {
static type = "event";
static src = "instance";
static dst = "controller";
/** @type {module:lib/data.InstanceDetails} */
/** @type {module:lib.InstanceDetails} */
details;
constructor(details) {
@@ -1149,7 +1149,7 @@ class InstanceDetailsChangedEvent {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceBanlistUpdateEvent {
static type = "event";
static src = "controller";
@@ -1185,7 +1185,7 @@ class InstanceBanlistUpdateEvent {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceAdminlistUpdateEvent {
static type = "event";
static src = "controller";
@@ -1216,7 +1216,7 @@ class InstanceAdminlistUpdateEvent {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstanceWhitelistUpdateEvent {
static type = "event";
static src = "controller";
@@ -1247,7 +1247,7 @@ class InstanceWhitelistUpdateEvent {
}
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class InstancePlayerUpdateEvent {
static type = "event";
static src = "instance";
+19 -19
View File
@@ -4,7 +4,7 @@ const ModInfo = require("./ModInfo");
const { jsonArray, JsonString } = require("./composites");
/* @memberof module:lib/data */
/* @memberof module:lib */
class ModPackGetRequest {
static type = "request";
static src = ["instance", "control"];
@@ -33,7 +33,7 @@ class ModPackGetRequest {
static Response = ModPack;
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class ModPackGetDefaultRequest {
static type = "request";
static src = ["instance", "control"];
@@ -42,7 +42,7 @@ class ModPackGetDefaultRequest {
static Response = ModPack;
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class ModPackListRequest {
static type = "request";
static src = "control";
@@ -51,14 +51,14 @@ class ModPackListRequest {
static Response = jsonArray(ModPack);
}
/** @memberof module:lib/data */
/** @memberof module:lib */
class ModPackCreateRequest {
static type = "request";
static src = "control";
static dst = "controller";
static permission = "core.mod_pack.create";
/** @type {module:lib/data.ModPack} */
/** @type {module:lib.ModPack} */
modPack;
constructor(modPack) {
@@ -78,14 +78,14 @@ class ModPackCreateRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class ModPackUpdateRequest {
static type = "request";
static src = "control";
static dst = "controller";
static permission = "core.mod_pack.update";
/** @type {module:lib/data.ModPack} */
/** @type {module:lib.ModPack} */
modPack;
constructor(modPack) {
@@ -105,7 +105,7 @@ class ModPackUpdateRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class ModPackDeleteRequest {
static type = "request";
static src = "control";
@@ -132,7 +132,7 @@ class ModPackDeleteRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class ModPackSetSubscriptionsRequest {
static type = "request";
static src = "control";
@@ -166,7 +166,7 @@ class ModPackSetSubscriptionsRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class ModGetRequest {
static type = "request";
static src = "control";
@@ -199,7 +199,7 @@ class ModGetRequest {
static Response = ModInfo;
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class ModListRequest {
static type = "request";
static src = "control";
@@ -208,7 +208,7 @@ class ModListRequest {
static Response = jsonArray(ModInfo);
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class ModSearchRequest {
static type = "request";
static src = "control";
@@ -305,7 +305,7 @@ ModSearchRequest.Response = class Response {
}
};
/* @memberof module:lib/data */
/* @memberof module:lib */
class ModSetSubscriptionsRequest {
static type = "request";
static src = "control";
@@ -339,7 +339,7 @@ class ModSetSubscriptionsRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class ModDownloadRequest {
static type = "request";
static src = "control";
@@ -372,7 +372,7 @@ class ModDownloadRequest {
static Response = JsonString;
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class ModDeleteRequest {
static type = "request";
static src = "control";
@@ -403,13 +403,13 @@ class ModDeleteRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class ModPackUpdateEvent {
static type = "event";
static src = "controller";
static dst = "control";
/** @type {module:lib/data.ModPack} */
/** @type {module:lib.ModPack} */
modPack;
constructor(modPack) {
@@ -429,13 +429,13 @@ class ModPackUpdateEvent {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class ModUpdateEvent {
static type = "event";
static src = "controller";
static dst = "control";
/** @type {module:lib/data.ModInfo} */
/** @type {module:lib.ModInfo} */
mod;
constructor(mod) {
+23 -23
View File
@@ -2,7 +2,7 @@
const PlayerStats = require("../PlayerStats");
const { jsonArray, JsonNumber } = require("./composites");
/* @memberof module:lib/data */
/* @memberof module:lib */
class RawPermission { // TODO refactor into lib/user.Permission
/** @type {string} */
name;
@@ -32,7 +32,7 @@ class RawPermission { // TODO refactor into lib/user.Permission
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class PermissionListRequest {
static type = "request";
static src = "control";
@@ -77,7 +77,7 @@ class RawRole { // TODO refactor into lib/user.Role
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class RoleListRequest {
static type = "request";
static src = "control";
@@ -86,7 +86,7 @@ class RoleListRequest {
static Response = jsonArray(RawRole);
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class RoleCreateRequest {
static type = "request";
static src = "control";
@@ -126,7 +126,7 @@ class RoleCreateRequest {
static Response = JsonNumber;
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class RoleUpdateRequest {
static type = "request";
static src = "control";
@@ -168,7 +168,7 @@ class RoleUpdateRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class RoleGrantDefaultPermissionsRequest {
static type = "request";
static src = "control";
@@ -195,7 +195,7 @@ class RoleGrantDefaultPermissionsRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class RoleDeleteRequest {
static type = "request";
static src = "control";
@@ -222,7 +222,7 @@ class RoleDeleteRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class RawUser { // TODO refactor into lib/user.User
/** @type {string} */
name;
@@ -240,9 +240,9 @@ class RawUser { // TODO refactor into lib/user.User
banReason;
/** @type {boolean|undefined} */
isDeleted;
/** @type {module:lib/PlayerStats} */
/** @type {module:lib.PlayerStats} */
playerStats;
/** @type {Map<number, module:lib/PlayerStats>|undefined} */
/** @type {Map<number, module:lib.PlayerStats>|undefined} */
instanceStats;
constructor(
@@ -321,7 +321,7 @@ class RawUser { // TODO refactor into lib/user.User
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class UserGetRequest {
static type = "request";
static src = "control";
@@ -350,7 +350,7 @@ class UserGetRequest {
static Response = RawUser;
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class UserListRequest {
static type = "request";
static src = "control";
@@ -359,7 +359,7 @@ class UserListRequest {
static Response = jsonArray(RawUser);
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class UserSetSubscriptionsRequest {
static type = "request";
static src = "control";
@@ -393,7 +393,7 @@ class UserSetSubscriptionsRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class UserCreateRequest {
static type = "request";
static src = "control";
@@ -420,7 +420,7 @@ class UserCreateRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class UserRevokeTokenRequest {
static type = "request";
static src = "control";
@@ -447,7 +447,7 @@ class UserRevokeTokenRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class UserUpdateRolesRequest {
static type = "request";
static src = "control";
@@ -481,7 +481,7 @@ class UserUpdateRolesRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class UserSetAdminRequest {
static type = "request";
static src = "control";
@@ -516,7 +516,7 @@ class UserSetAdminRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class UserSetWhitelistedRequest {
static type = "request";
static src = "control";
@@ -551,7 +551,7 @@ class UserSetWhitelistedRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class UserSetBannedRequest {
static type = "request";
static src = "control";
@@ -590,7 +590,7 @@ class UserSetBannedRequest {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class UserDeleteRequest {
static type = "request";
static src = "control";
@@ -618,7 +618,7 @@ class UserDeleteRequest {
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class AccountUpdateEvent {
static type = "event";
static src = "controller";
@@ -657,13 +657,13 @@ class AccountUpdateEvent {
}
}
/* @memberof module:lib/data */
/* @memberof module:lib */
class UserUpdateEvent {
static type = "event";
static src = "controller";
static dst = "control";
/** @type {module:lib/data.RawUser} */
/** @type {module:lib.RawUser} */
user;
constructor(user) {
+3 -3
View File
@@ -9,7 +9,7 @@
* number of leading zeros in them.
* @param {string} version - string representation of version.
* @returns {number} numeric representation.
* @alias module:lib/data.integerModVersion
* @alias module:lib.integerModVersion
*/
function integerModVersion(version) {
const [major, minor, sub] = version.split(".").map(n => Number.parseInt(n, 10));
@@ -23,7 +23,7 @@ function integerModVersion(version) {
* number of leading zeros in them.
* @param {string} version - string representation of version.
* @returns {number} numeric representation.
* @alias module:lib/data.integerFactorioVersion
* @alias module:lib.integerFactorioVersion
*/
function integerFactorioVersion(version) {
const [main, major, minor] = version.split(".").map(n => Number.parseInt(n, 10));
@@ -33,7 +33,7 @@ function integerFactorioVersion(version) {
/**
* Matches valid mod versions.
* @type {RegExp}
* @alias module:lib/data.modVersionRegExp
* @alias module:lib.modVersionRegExp
*/
const modVersionRegExp = /^\d+\.\d+\.\d+$/;