factorio-clusterio/packages/create/templates/plugin-ts/index.ts

import * as lib from "@clusterio/lib";

import { PluginExampleEvent, PluginExampleRequest } from "./messages";

lib.definePermission({
	name: "// plugin_name //.example.permission.event",
	title: "Example permission event",
	description: "My plugin's example permission that I forgot to remove",
});

lib.definePermission({
	name: "// plugin_name //.example.permission.request",
	title: "Example permission request",
	description: "My plugin's example permission that I forgot to remove",
});// [web] //

lib.definePermission({
	name: "// plugin_name //.page.view",
	title: "Example page view permission",
	description: "My plugin's example page permission that I forgot to remove",
});// [] //

declare module "@clusterio/lib" {// [controller] //
	export interface ControllerConfigFields {
		"// plugin_name //.myControllerField": string;
	}// [] //// [host] //
	export interface HostConfigFields {
		"// plugin_name //.myHostField": string;
	}// [] //// [instance] //
	export interface InstanceConfigFields {
		"// plugin_name //.myInstanceField": string;
	}// [] //
}

export const plugin: lib.PluginDeclaration = {
	name: "// plugin_name //",
	title: "// plugin_name //",
	description: "I didn't update my description",
	// entry_points //
	// [controller] //
	controlConfigFields: {
		"// plugin_name //.myControllerField": {
			title: "My Controller Field",
			description: "This should be removed",
			type: "string",
			initialValue: "Remove Me",
		},
	},// [] //// [host] //
	hostConfigFields: {
		"// plugin_name //.myHostField": {
			title: "My Host Field",
			description: "This should be removed",
			type: "string",
			initialValue: "Remove Me",
		},
	},// [] //// [instance] //
	instanceConfigFields: {
		"// plugin_name //.myInstanceField": {
			title: "My Instance Field",
			description: "This should be removed",
			type: "string",
			initialValue: "Remove Me",
		},
	},// [] //

	messages: [
		PluginExampleEvent,
		PluginExampleRequest,
	],
};