mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-12 23:04:52 +09:00
Adds a permissions array to PluginDeclaration, a type-level Permissions registry that plugins extend with module augmentation, and registerPluginPermissions() called from all entrypoints. checkPermission and the web UI hasPermission helpers now take PermissionName so typos are compile errors. Core definitions move into a corePermissions array that the interface derives its keys from. Closes #987 Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com> Co-authored-by: Cooldude2606 <25043174+Cooldude2606@users.noreply.github.com>
94 lines
2.8 KiB
React
94 lines
2.8 KiB
React
import React, {
|
|
useContext, useEffect, useState,
|
|
//%if controller // Subscribing requires web content and the controller
|
|
useCallback, useSyncExternalStore,
|
|
//%endif
|
|
} from "react";
|
|
|
|
// import {
|
|
//
|
|
// } from "antd";
|
|
|
|
import {
|
|
BaseWebPlugin, PageLayout, PageHeader, Control, ControlContext, notifyErrorHandler,
|
|
} from "@clusterio/web_ui";
|
|
//%if multi_context // Messages requires multi context
|
|
|
|
import {
|
|
PluginExampleEvent, PluginExampleRequest,
|
|
//%endif
|
|
//%if controller // 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";
|
|
|
|
function MyTemplatePage() {
|
|
let control = useContext(ControlContext);
|
|
//%if controller // Subscribing requires web content and the controller
|
|
const plugin = control.plugins.get("__plugin_name__");
|
|
const [subscribableData, synced] = plugin.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 class WebPlugin extends BaseWebPlugin {
|
|
//%if controller // Subscribing requires web content and the controller
|
|
subscribableData = new lib.MapSubscriber(ExampleSubscribableUpdate, this.control);
|
|
|
|
//%endif
|
|
async init() {
|
|
this.pages = [
|
|
{
|
|
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
|
|
|
|
this.control.handle(PluginExampleEvent, this.handlePluginExampleEvent.bind(this));
|
|
this.control.handle(PluginExampleRequest, this.handlePluginExampleRequest.bind(this));
|
|
//%endif
|
|
}
|
|
//%if controller// Subscribing requires web content and the controller
|
|
|
|
useSubscribableData() {
|
|
const control = useContext(ControlContext);
|
|
const subscribe = useCallback((callback) => this.subscribableData.subscribe(callback), [control]);
|
|
return useSyncExternalStore(subscribe, () => this.subscribableData.getSnapshot());
|
|
}
|
|
//%endif
|
|
//%if multi_context
|
|
|
|
async handlePluginExampleEvent(event) {
|
|
this.logger.info(JSON.stringify(event));
|
|
}
|
|
|
|
async handlePluginExampleRequest(request) {
|
|
this.logger.info(JSON.stringify(request));
|
|
return {
|
|
myResponseString: request.myString,
|
|
myResponseNumbers: request.myNumberArray,
|
|
};
|
|
}
|
|
//%endif
|
|
}
|