Skip to content

Self-hosted, plugin-based server management.

1.3 KB
Raw Blame
import { isFieldActive } from "@termix-ssh/plugin-sdk/settings";
import type { PluginSettingsField } from "@/api/plugins-api";

/**
 * Whether the generic form draws a field: not hidden (the plugin edits it in
 * its own UI) and its `requires` gate satisfied.
 *
 * Kept out of the component file so both the settings page and the host editor
 * section can import it without dragging a component along.
 */
export function isFieldShown(
  field: PluginSettingsField,
  values: Record<string, unknown>,
): boolean {
  return !field.hidden && isFieldActive(field, values);
}

/** Whether a plugin has any field the generic form would ever draw. */
export function hasVisibleFields(fields: PluginSettingsField[]): boolean {
  return fields.some((field) => !field.hidden);
}

/** Whether Settings lists a page for this plugin, by the same rule it uses. */
export function hasSettingsPage(
  plugin: {
    enabled: boolean;
    contributes?: {
      settings?: {
        user?: PluginSettingsField[];
        admin?: PluginSettingsField[];
      };
    } | null;
  },
  isAdmin: boolean,
): boolean {
  const settings = plugin.contributes?.settings;
  return (
    plugin.enabled &&
    (hasVisibleFields(settings?.user ?? []) ||
      (isAdmin && hasVisibleFields(settings?.admin ?? [])))
  );
}