92 lines
3.3 KiB
TypeScript
92 lines
3.3 KiB
TypeScript
/**
|
|
* @file Utility functions that are plugin-instance-specific (i.e. use PluginData)
|
|
*/
|
|
|
|
import { Member } from "eris";
|
|
import { configUtils, helpers, PluginBlueprint, PluginData, PluginOptions } from "knub";
|
|
import { decodeAndValidateStrict, StrictValidationError } from "./validatorUtils";
|
|
import { deepKeyIntersect, errorMessage, successMessage } from "./utils";
|
|
import { ZeppelinPluginBlueprint } from "./plugins/ZeppelinPluginBlueprint";
|
|
import { TZeppelinKnub } from "./types";
|
|
import { ExtendedMatchParams } from "knub/dist/config/PluginConfigManager"; // TODO: Export from Knub index
|
|
|
|
const { getMemberLevel } = helpers;
|
|
|
|
export function canActOn(pluginData: PluginData<any>, member1: Member, member2: Member, allowSameLevel = false) {
|
|
if (member2.id === pluginData.client.user.id) {
|
|
return false;
|
|
}
|
|
|
|
const ourLevel = getMemberLevel(pluginData, member1);
|
|
const memberLevel = getMemberLevel(pluginData, member2);
|
|
return allowSameLevel ? ourLevel >= memberLevel : ourLevel > memberLevel;
|
|
}
|
|
|
|
export function hasPermission(pluginData: PluginData<any>, permission: string, matchParams: ExtendedMatchParams) {
|
|
const config = pluginData.config.getMatchingConfig(matchParams);
|
|
return helpers.hasPermission(config, permission);
|
|
}
|
|
|
|
export function getPluginConfigPreprocessor(
|
|
blueprint: ZeppelinPluginBlueprint,
|
|
customPreprocessor?: PluginBlueprint<any>["configPreprocessor"],
|
|
) {
|
|
return async (options: PluginOptions<any>) => {
|
|
if (customPreprocessor) {
|
|
options = await customPreprocessor(options);
|
|
}
|
|
|
|
const decodedConfig = blueprint.configSchema
|
|
? decodeAndValidateStrict(blueprint.configSchema, options.config)
|
|
: options.config;
|
|
if (decodedConfig instanceof StrictValidationError) {
|
|
console.log("o", options);
|
|
throw decodedConfig;
|
|
}
|
|
|
|
const decodedOverrides = [];
|
|
for (const override of options.overrides || []) {
|
|
const overrideConfigMergedWithBaseConfig = configUtils.mergeConfig(options.config, override.config || {});
|
|
const decodedOverrideConfig = blueprint.configSchema
|
|
? decodeAndValidateStrict(blueprint.configSchema, overrideConfigMergedWithBaseConfig)
|
|
: overrideConfigMergedWithBaseConfig;
|
|
if (decodedOverrideConfig instanceof StrictValidationError) {
|
|
throw decodedOverrideConfig;
|
|
}
|
|
decodedOverrides.push({
|
|
...override,
|
|
config: deepKeyIntersect(decodedOverrideConfig, override.config || {}),
|
|
});
|
|
}
|
|
|
|
return {
|
|
config: decodedConfig,
|
|
overrides: decodedOverrides,
|
|
};
|
|
};
|
|
}
|
|
|
|
export function sendSuccessMessage(pluginData: PluginData<any>, channel, body) {
|
|
const emoji = pluginData.guildConfig.success_emoji || undefined;
|
|
return channel.createMessage(successMessage(body, emoji));
|
|
}
|
|
|
|
export function sendErrorMessage(pluginData: PluginData<any>, channel, body) {
|
|
const emoji = pluginData.guildConfig.error_emoji || undefined;
|
|
return channel.createMessage(errorMessage(body, emoji));
|
|
}
|
|
|
|
export function getBaseUrl(pluginData: PluginData<any>) {
|
|
const knub = pluginData.getKnubInstance() as TZeppelinKnub;
|
|
return knub.getGlobalConfig().url;
|
|
}
|
|
|
|
export function isOwner(pluginData: PluginData<any>, userId: string) {
|
|
const knub = pluginData.getKnubInstance() as TZeppelinKnub;
|
|
const owners = knub.getGlobalConfig().owners;
|
|
if (!owners) {
|
|
return false;
|
|
}
|
|
|
|
return owners.includes(userId);
|
|
}
|