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

+3 -4
View File
@@ -2,8 +2,7 @@
const fs = require("fs-extra");
const path = require("path");
const libFileOps = require("@clusterio/lib/file_ops");
const libPlugin = require("@clusterio/lib/plugin");
const lib = require("@clusterio/lib");
const {
AcquireRequest,
@@ -34,11 +33,11 @@ async function saveDatabase(controllerConfig, playerDatastore, logger) {
let file = path.resolve(controllerConfig.get("controller.database_directory"), "inventories.json");
logger.verbose(`writing ${file}`);
let content = JSON.stringify(Array.from(playerDatastore));
await libFileOps.safeOutputFile(file, content);
await lib.safeOutputFile(file, content);
}
}
class ControllerPlugin extends libPlugin.BaseControllerPlugin {
class ControllerPlugin extends lib.BaseControllerPlugin {
async init() {
this.acquiredPlayers = new Map();
this.playerDatastore = await loadDatabase(this.controller.config, this.logger);
+4 -4
View File
@@ -1,8 +1,8 @@
"use strict";
const { libConfig, libUsers } = require("@clusterio/lib");
const lib = require("@clusterio/lib");
let messages = require("./messages");
class ControllerConfigGroup extends libConfig.PluginConfigGroup { }
class ControllerConfigGroup extends lib.PluginConfigGroup { }
ControllerConfigGroup.defaultAccess = ["controller", "host", "control"];
ControllerConfigGroup.groupName = "inventory_sync";
ControllerConfigGroup.define({
@@ -22,7 +22,7 @@ ControllerConfigGroup.define({
});
ControllerConfigGroup.finalize();
class InstanceConfigGroup extends libConfig.PluginConfigGroup { }
class InstanceConfigGroup extends lib.PluginConfigGroup { }
InstanceConfigGroup.defaultAccess = ["controller", "host", "control"];
InstanceConfigGroup.groupName = "inventory_sync";
InstanceConfigGroup.define({
@@ -34,7 +34,7 @@ InstanceConfigGroup.define({
});
InstanceConfigGroup.finalize();
libUsers.definePermission({
lib.definePermission({
name: "inventory_sync.inventory.view",
title: "View player inventories",
description: "View player inventories",
+7 -10
View File
@@ -2,16 +2,13 @@
* @module
*/
"use strict";
const libErrors = require("@clusterio/lib/errors");
const libPlugin = require("@clusterio/lib/plugin");
const libLuaTools = require("@clusterio/lib/lua_tools");
const lib = require("@clusterio/lib");
const {
AcquireRequest,
ReleaseRequest,
UploadRequest,
DownloadRequest,
DatabaseStatsRequest,
} = require("./messages");
/**
@@ -24,7 +21,7 @@ function chunkify(chunkSize, string) {
return string.match(new RegExp(`.{1,${chunkSize}}`, "g"));
}
class InstancePlugin extends libPlugin.BaseInstancePlugin {
class InstancePlugin extends lib.BaseInstancePlugin {
async init() {
this.playersToRelease = new Set();
this.disconnecting = false;
@@ -82,14 +79,14 @@ class InstancePlugin extends libPlugin.BaseInstancePlugin {
message: acquireResponse.message,
};
} catch (err) {
if (!(err instanceof libErrors.SessionLost)) {
if (!(err instanceof lib.SessionLost)) {
this.logger.error(`Unexpected error sending aquire request:\n${err.stack}`);
response.message = err.message;
}
}
}
let json = libLuaTools.escapeString(JSON.stringify(response));
let json = lib.escapeString(JSON.stringify(response));
await this.sendRcon(`/sc inventory_sync.acquire_response("${json}")`, true);
}
@@ -101,7 +98,7 @@ class InstancePlugin extends libPlugin.BaseInstancePlugin {
try {
await this.instance.sendTo("controller", new ReleaseRequest(this.instance.id, request.player_name));
} catch (err) {
if (err instanceof libErrors.SessionLost) {
if (err instanceof lib.SessionLost) {
this.playersToRelease.set(request.player_name);
} else {
this.logger.error(`Unexpected error releasing player ${request.player_name}:\n${err.stack}`);
@@ -122,7 +119,7 @@ class InstancePlugin extends libPlugin.BaseInstancePlugin {
);
} catch (err) {
if (!(err instanceof libErrors.SessionLost)) {
if (!(err instanceof lib.SessionLost)) {
this.logger.error(`Unexpected error uploading inventory for ${player_data.name}:\n${err.stack}`);
}
return;
@@ -149,7 +146,7 @@ class InstancePlugin extends libPlugin.BaseInstancePlugin {
this.logger.verbose(`Sending inventory for ${playerName} in ${chunks.length} chunks`);
for (let i = 0; i < chunks.length; i++) {
// this.logger.verbose(`Sending chunk ${i+1} of ${chunks.length}`)
const chunk = libLuaTools.escapeString(chunks[i]);
const chunk = lib.escapeString(chunks[i]);
await this.sendRcon(
`/sc inventory_sync.download_inventory('${playerName}','${chunk}',${i + 1},${chunks.length})`,
true
+2 -2
View File
@@ -1,6 +1,6 @@
import React, { useContext, useEffect, useState } from "react";
import { libPlugin } from "@clusterio/lib";
import * as lib from "@clusterio/lib";
import { PageLayout, ControlContext } from "@clusterio/web_ui";
import { DatabaseStatsRequest } from "../messages";
@@ -28,7 +28,7 @@ function InventoryPage() {
</PageLayout>;
}
export class WebPlugin extends libPlugin.BaseWebPlugin {
export class WebPlugin extends lib.BaseWebPlugin {
async init() {
this.pages = [
{