mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-11 23:04:52 +09:00
7122cbccf8
Replace invokeHook and the per plugin on* methods with AsyncHook collections on the controller, host, instance, clusterioctl and web control objects. Plugin entrypoints export a default function that receives a load context and attaches handlers to the hooks it needs. Class exports still load through fromContext with a deprecation warning. The create templates and docs use the entrypoint function. This is clusterio/clusterio#921 recreated on top of master after the ESM migration and the PluginDeclaration permissions change. Closes #730 Co-Authored-By: Cooldude2606 <25043174+Cooldude2606@users.noreply.github.com> Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
91 lines
2.9 KiB
TypeScript
91 lines
2.9 KiB
TypeScript
import React, {
|
|
useContext, useEffect, useState,
|
|
//%if controller & web // Subscribing requires web content and the controller
|
|
useCallback, useSyncExternalStore,
|
|
//%endif
|
|
} from "react";
|
|
|
|
// import {
|
|
//
|
|
// } from "antd";
|
|
|
|
import {
|
|
PageLayout, PageHeader, Control, ControlContext, notifyErrorHandler,
|
|
type WebPluginContext,
|
|
} from "@clusterio/web_ui";
|
|
//%if multi_context // Messages requires multi context
|
|
|
|
import {
|
|
PluginExampleEvent, PluginExampleRequest,
|
|
//%endif
|
|
//%if controller & web // Subscribing requires web content and the controller
|
|
ExampleSubscribableUpdate, ExampleSubscribableValue,
|
|
//%endif
|
|
//%if multi_context // Messages requires multi context
|
|
} from "../messages.js";
|
|
//%endif
|
|
|
|
import * as lib from "@clusterio/lib";
|
|
//%if controller // Subscribing requires web content and the controller
|
|
|
|
// Created when the plugin is loaded, before any page is rendered
|
|
let exampleSubscriber: lib.MapSubscriber<ExampleSubscribableUpdate>;
|
|
|
|
function useSubscribableData() {
|
|
const control = useContext(ControlContext);
|
|
const subscribe = useCallback((callback: () => void) => exampleSubscriber.subscribe(callback), [control]);
|
|
return useSyncExternalStore(subscribe, () => exampleSubscriber.getSnapshot());
|
|
}
|
|
//%endif
|
|
|
|
function MyTemplatePage() {
|
|
const control = useContext(ControlContext);
|
|
//%if controller // Subscribing requires web content and the controller
|
|
const [subscribableData, synced] = useSubscribableData();
|
|
//%endif
|
|
|
|
return <PageLayout nav={[{ name: "__plugin_name__" }]}>
|
|
<PageHeader title="__plugin_name__" />
|
|
//%if controller // Subscribing requires web content and the controller
|
|
Synced: {String(synced)} Data: {JSON.stringify([...subscribableData.values()])}
|
|
//%endif
|
|
</PageLayout>;
|
|
}
|
|
|
|
export default async function loadWebPlugin(context: WebPluginContext) {
|
|
const { control, logger, plugin } = context;
|
|
//%if controller // Subscribing requires web content and the controller
|
|
exampleSubscriber = new lib.MapSubscriber(ExampleSubscribableUpdate, control);
|
|
//%endif
|
|
|
|
control.hooks.pages.attach(plugin.name, () => [
|
|
{
|
|
path: "/__plugin_name__",
|
|
sidebarName: "__plugin_name__",
|
|
// This permission is client side only, so it must match the permission string of a resource request to be secure
|
|
// An undefined value means that the page will always be visible
|
|
//%if controller // Subscribing requires web content and the controller
|
|
permission: "__plugin_name__.example.permission.subscribe",
|
|
//%endif
|
|
//%if !controller
|
|
permission: "__plugin_name__.page.view",
|
|
//%endif
|
|
content: <MyTemplatePage/>,
|
|
},
|
|
]);
|
|
//%if multi_context
|
|
|
|
control.handle(PluginExampleEvent, async (event: PluginExampleEvent) => {
|
|
logger.info(JSON.stringify(event));
|
|
});
|
|
|
|
control.handle(PluginExampleRequest, async (request: PluginExampleRequest) => {
|
|
logger.info(JSON.stringify(request));
|
|
return {
|
|
myResponseString: request.myString,
|
|
myResponseNumbers: request.myNumberArray,
|
|
};
|
|
});
|
|
//%endif
|
|
}
|