mirror of
https://github.com/Termix-SSH/Termix.git
synced 2026-11-04 09:35:24 +00:00
Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3ae56a96d0 | ||
|
|
631f6ac9f7 |
No files matched your search
Generated
+2
-2
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "termix",
|
"name": "termix",
|
||||||
"version": "26.11.0",
|
"version": "26.11.1",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "termix",
|
"name": "termix",
|
||||||
"version": "26.11.0",
|
"version": "26.11.1",
|
||||||
"hasInstallScript": true,
|
"hasInstallScript": true,
|
||||||
"workspaces": [
|
"workspaces": [
|
||||||
"packages/*"
|
"packages/*"
|
||||||
|
|||||||
+1
-1
@@ -4,7 +4,7 @@
|
|||||||
"workspaces": [
|
"workspaces": [
|
||||||
"packages/*"
|
"packages/*"
|
||||||
],
|
],
|
||||||
"version": "26.11.0",
|
"version": "26.11.1",
|
||||||
"description": "Self-hosted, plugin-based server management.",
|
"description": "Self-hosted, plugin-based server management.",
|
||||||
"author": "Karmaa",
|
"author": "Karmaa",
|
||||||
"main": "electron/main.cjs",
|
"main": "electron/main.cjs",
|
||||||
|
|||||||
@@ -1,5 +1,14 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 1.0.24
|
||||||
|
|
||||||
|
Plugin API 1.14.0.
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- `app.registerHostSection` adds a card to the host page
|
||||||
|
- `/ui` exports `HostTabEmbed`, which draws any tab type inside another view, the host section registry, and `operationsApi` for core's `/operations` routes
|
||||||
|
|
||||||
## 1.0.23
|
## 1.0.23
|
||||||
|
|
||||||
Plugin API 1.14.0.
|
Plugin API 1.14.0.
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Termix plugin guide
|
# Termix plugin guide
|
||||||
|
|
||||||
SDK 1.0.23 | Plugin API 1.14.0
|
SDK 1.0.24 | Plugin API 1.14.0
|
||||||
|
|
||||||
This guide is for anyone, person or AI coding tool, building a Termix plugin. It ships inside
|
This guide is for anyone, person or AI coding tool, building a Termix plugin. It ships inside
|
||||||
`@termix-ssh/plugin-sdk`, so the copy in your `node_modules` always matches the SDK you have installed.
|
`@termix-ssh/plugin-sdk`, so the copy in your `node_modules` always matches the SDK you have installed.
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@termix-ssh/plugin-sdk",
|
"name": "@termix-ssh/plugin-sdk",
|
||||||
"version": "1.0.23",
|
"version": "1.0.24",
|
||||||
"description": "The contract between Termix core and a plugin: types, the capability catalog and the manifest schema.",
|
"description": "The contract between Termix core and a plugin: types, the capability catalog and the manifest schema.",
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
"repository": {
|
"repository": {
|
||||||
|
|||||||
@@ -670,6 +670,22 @@ export type HostStatusIndicatorContribution = HostBadgeContribution;
|
|||||||
/** A control in the host editor's toolbar. */
|
/** A control in the host editor's toolbar. */
|
||||||
export type HostEditorToolbarItemContribution = HostBadgeContribution;
|
export type HostEditorToolbarItemContribution = HostBadgeContribution;
|
||||||
|
|
||||||
|
export interface HostSectionProps {
|
||||||
|
host: PluginHostRecord;
|
||||||
|
isVisible: boolean;
|
||||||
|
shell: ShellApi;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface HostSectionContribution {
|
||||||
|
/** Declare it in manifest contributes.hostSections too. */
|
||||||
|
id: string;
|
||||||
|
titleKey: string;
|
||||||
|
/** Lower sorts first. */
|
||||||
|
order?: number;
|
||||||
|
when?: (host: PluginHostRecord) => boolean;
|
||||||
|
component: ComponentType<HostSectionProps>;
|
||||||
|
}
|
||||||
|
|
||||||
export interface HostContextMenuItemContribution {
|
export interface HostContextMenuItemContribution {
|
||||||
id: string;
|
id: string;
|
||||||
titleKey: string;
|
titleKey: string;
|
||||||
@@ -1172,6 +1188,11 @@ export interface TermixApp extends TermixAppInfo {
|
|||||||
registerHostContextMenuItem: (
|
registerHostContextMenuItem: (
|
||||||
item: HostContextMenuItemContribution,
|
item: HostContextMenuItemContribution,
|
||||||
) => Disposer;
|
) => Disposer;
|
||||||
|
/**
|
||||||
|
* A card on the host page. Core 26.11.1 and newer; call it as
|
||||||
|
* app.registerHostSection?.(...) if your plugin allows older cores.
|
||||||
|
*/
|
||||||
|
registerHostSection: (section: HostSectionContribution) => Disposer;
|
||||||
registerPaletteEntry: (entry: PaletteEntryContribution) => Disposer;
|
registerPaletteEntry: (entry: PaletteEntryContribution) => Disposer;
|
||||||
registerPaletteGroup: (group: PaletteGroupContribution) => Disposer;
|
registerPaletteGroup: (group: PaletteGroupContribution) => Disposer;
|
||||||
registerKeybindingAction: (action: KeybindingActionContribution) => Disposer;
|
registerKeybindingAction: (action: KeybindingActionContribution) => Disposer;
|
||||||
|
|||||||
@@ -159,8 +159,10 @@ HostProtocolAuthInput (type): HostProtocolAuthInput
|
|||||||
HostProtocolDef (type): HostProtocolDef
|
HostProtocolDef (type): HostProtocolDef
|
||||||
HostProtocols (type): HostProtocols
|
HostProtocols (type): HostProtocols
|
||||||
HostRowFields (type): HostRowFields
|
HostRowFields (type): HostRowFields
|
||||||
|
HostSectionDef (type): HostSectionDef
|
||||||
HostSidebarFilterState (type): HostSidebarFilterState
|
HostSidebarFilterState (type): HostSidebarFilterState
|
||||||
HostSidebarPreferences (type): HostSidebarPreferences
|
HostSidebarPreferences (type): HostSidebarPreferences
|
||||||
|
HostTabEmbed (value): ({ host, type, label, data, isVisible, shell, }: { host: Host; type: string; label?: string; data?: Record<string, unknown>; isVisible?: boolean; shell: TabShellCallbacks; }) => Element
|
||||||
HostTrayTrigger (type): HostTrayTrigger
|
HostTrayTrigger (type): HostTrayTrigger
|
||||||
HttpsSettings (type): HttpsSettings
|
HttpsSettings (type): HttpsSettings
|
||||||
IconPicker (value): ({ value, color, onChange, }: { value: string; color?: string; onChange: (icon: string) => void; }) => Element
|
IconPicker (value): ({ value, color, onChange, }: { value: string; color?: string; onChange: (icon: string) => void; }) => Element
|
||||||
@@ -457,6 +459,7 @@ hostBadgesFor (value): (all: HostBadgeDef[], host: Host) => HostBadgeDef[]
|
|||||||
hostEditorToolbarItemsFor (value): (all: HostBadgeDef[], host: Host) => HostBadgeDef[]
|
hostEditorToolbarItemsFor (value): (all: HostBadgeDef[], host: Host) => HostBadgeDef[]
|
||||||
hostMenuItemsFor (value): (all: HostContextMenuItemDef[], host: Host) => HostContextMenuItemDef[]
|
hostMenuItemsFor (value): (all: HostContextMenuItemDef[], host: Host) => HostContextMenuItemDef[]
|
||||||
hostProtocolFlags (value): (host: { enableSsh?: boolean; pluginSettings?: Record<string, Record<string, unknown>>; }, list?: HostProtocolDef[]) => HostProtocols
|
hostProtocolFlags (value): (host: { enableSsh?: boolean; pluginSettings?: Record<string, Record<string, unknown>>; }, list?: HostProtocolDef[]) => HostProtocols
|
||||||
|
hostSectionsFor (value): (all: HostSectionDef[], host: Host) => HostSectionDef[]
|
||||||
hostStatusIndicatorsFor (value): (all: HostBadgeDef[], host: Host) => HostBadgeDef[]
|
hostStatusIndicatorsFor (value): (all: HostBadgeDef[], host: Host) => HostBadgeDef[]
|
||||||
hydrateLocalSharedHostAuth (value): <T>(host: T) => Promise<T>
|
hydrateLocalSharedHostAuth (value): <T>(host: T) => Promise<T>
|
||||||
invalidateHostsAndStatusCaches (value): () => void
|
invalidateHostsAndStatusCaches (value): () => void
|
||||||
@@ -475,6 +478,7 @@ linkExternalToPasswordAccount (value): (externalUserId: string, targetUsername:
|
|||||||
linkedServerUrl (value): () => Promise<string>
|
linkedServerUrl (value): () => Promise<string>
|
||||||
listHostActions (value): () => HostActionDef[]
|
listHostActions (value): () => HostActionDef[]
|
||||||
listHostProtocols (value): () => HostProtocolDef[]
|
listHostProtocols (value): () => HostProtocolDef[]
|
||||||
|
listHostSections (value): () => HostSectionDef[]
|
||||||
loadPaletteGroup (value): (group: PaletteGroupDef) => Promise<PaletteItemDef[]>
|
loadPaletteGroup (value): (group: PaletteGroupDef) => Promise<PaletteItemDef[]>
|
||||||
logoutUser (value): () => Promise<{ success: boolean; message: string; }>
|
logoutUser (value): () => Promise<{ success: boolean; message: string; }>
|
||||||
makeHostSshSubTabs (value): (t: (key: string, options?: { defaultValue?: string; }) => string, protocols?: Record<string, boolean>, defaultsMode?: boolean) => HostTab[]
|
makeHostSshSubTabs (value): (t: (key: string, options?: { defaultValue?: string; }) => string, protocols?: Record<string, boolean>, defaultsMode?: boolean) => HostTab[]
|
||||||
@@ -488,6 +492,7 @@ moveSplitDrag (value): (x: number, y: number) => void
|
|||||||
normalizeLanguageCode (value): (language?: string) => string
|
normalizeLanguageCode (value): (language?: string) => string
|
||||||
notifySyncChanged (value): () => void
|
notifySyncChanged (value): () => void
|
||||||
openInSplit (value): (target: SplitOpenTarget, open: () => void) => void
|
openInSplit (value): (target: SplitOpenTarget, open: () => void) => void
|
||||||
|
operationsApi (value): AxiosInstance
|
||||||
paletteEntriesFor (value): (all: PaletteEntryDef[], scope: "global" | "host", host?: Host) => PaletteEntryDef[]
|
paletteEntriesFor (value): (all: PaletteEntryDef[], scope: "global" | "host", host?: Host) => PaletteEntryDef[]
|
||||||
parseCustomKeybindings (value): (raw?: string) => CustomKeybinding[]
|
parseCustomKeybindings (value): (raw?: string) => CustomKeybinding[]
|
||||||
parseServerTime (value): (ts: string) => Date
|
parseServerTime (value): (ts: string) => Date
|
||||||
@@ -598,6 +603,7 @@ useHostContextMenuItems (value): () => HostContextMenuItemDef[]
|
|||||||
useHostEditorSections (value): () => HostEditorSectionDef[]
|
useHostEditorSections (value): () => HostEditorSectionDef[]
|
||||||
useHostEditorToolbarItems (value): () => HostBadgeDef[]
|
useHostEditorToolbarItems (value): () => HostBadgeDef[]
|
||||||
useHostProtocols (value): () => HostProtocolDef[]
|
useHostProtocols (value): () => HostProtocolDef[]
|
||||||
|
useHostSections (value): () => HostSectionDef[]
|
||||||
useHostStatus (value): (hostId: number, statusCheckEnabled?: boolean) => StatusValue
|
useHostStatus (value): (hostId: number, statusCheckEnabled?: boolean) => StatusValue
|
||||||
useHostStatusIndicators (value): () => HostBadgeDef[]
|
useHostStatusIndicators (value): () => HostBadgeDef[]
|
||||||
useInstalledPlugins (value): () => PluginSummary[]
|
useInstalledPlugins (value): () => PluginSummary[]
|
||||||
|
|||||||
@@ -19,6 +19,12 @@ const SDK_UI = path.join(ROOT, "src", "ui", "plugin-host", "sdk-ui.ts");
|
|||||||
const TSCONFIG = path.join(ROOT, "tsconfig.app.json");
|
const TSCONFIG = path.join(ROOT, "tsconfig.app.json");
|
||||||
|
|
||||||
const ALLOWED = [
|
const ALLOWED = [
|
||||||
|
"useHostSections",
|
||||||
|
"operationsApi",
|
||||||
|
"listHostSections",
|
||||||
|
"hostSectionsFor",
|
||||||
|
"HostTabEmbed",
|
||||||
|
"HostSectionDef",
|
||||||
"ACCENT_PRESET_COLORS",
|
"ACCENT_PRESET_COLORS",
|
||||||
"APP_VERSION",
|
"APP_VERSION",
|
||||||
"AccessRecord",
|
"AccessRecord",
|
||||||
|
|||||||
@@ -79,6 +79,34 @@ export function createPluginApi(pluginId: string): AxiosInstance {
|
|||||||
}) as AxiosInstance;
|
}) as AxiosInstance;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An axios client rooted at core's /operations routes: the action catalog,
|
||||||
|
* runs, approvals, events, signals and cross host resources.
|
||||||
|
*/
|
||||||
|
export function createOperationsApi(): AxiosInstance {
|
||||||
|
return new Proxy(authApi, {
|
||||||
|
get(target, property, receiver) {
|
||||||
|
const value = Reflect.get(target, property, receiver);
|
||||||
|
if (typeof value !== "function") return value;
|
||||||
|
if (
|
||||||
|
property === "get" ||
|
||||||
|
property === "delete" ||
|
||||||
|
property === "post" ||
|
||||||
|
property === "put" ||
|
||||||
|
property === "patch"
|
||||||
|
) {
|
||||||
|
return (url: string, ...rest: unknown[]) =>
|
||||||
|
(value as (...args: unknown[]) => unknown).call(
|
||||||
|
target,
|
||||||
|
`/operations${url.startsWith("/") ? url : `/${url}`}`,
|
||||||
|
...rest,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return value.bind(target);
|
||||||
|
},
|
||||||
|
}) as AxiosInstance;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A raw fetch on this plugin's /plugin-api mount point, for a response the
|
* A raw fetch on this plugin's /plugin-api mount point, for a response the
|
||||||
* caller reads as a stream (server-sent events). axios buffers the whole
|
* caller reads as a stream (server-sent events). axios buffers the whole
|
||||||
|
|||||||
@@ -41,6 +41,10 @@ import {
|
|||||||
type KeybindingEditorProps,
|
type KeybindingEditorProps,
|
||||||
} from "@/shell/keybinding-registry";
|
} from "@/shell/keybinding-registry";
|
||||||
import { registerHostProtocol } from "@/sidebar/host-protocols";
|
import { registerHostProtocol } from "@/sidebar/host-protocols";
|
||||||
|
import {
|
||||||
|
registerHostSection,
|
||||||
|
type HostSectionRenderProps,
|
||||||
|
} from "@/shell/host-sections";
|
||||||
import {
|
import {
|
||||||
registerDashboardCard,
|
registerDashboardCard,
|
||||||
type DashboardCardRenderProps,
|
type DashboardCardRenderProps,
|
||||||
@@ -424,6 +428,21 @@ export function createPluginApp(
|
|||||||
);
|
);
|
||||||
},
|
},
|
||||||
|
|
||||||
|
registerHostSection(section) {
|
||||||
|
return track(
|
||||||
|
registerHostSection({
|
||||||
|
id: section.id,
|
||||||
|
pluginId,
|
||||||
|
titleKey: key(section.titleKey),
|
||||||
|
order: section.order,
|
||||||
|
when: hostCallback(section.when ?? (() => true)) as never,
|
||||||
|
component: scoped(
|
||||||
|
section.component as unknown as ComponentType<HostSectionRenderProps>,
|
||||||
|
),
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
},
|
||||||
|
|
||||||
registerHostContextMenuItem(item) {
|
registerHostContextMenuItem(item) {
|
||||||
return track(
|
return track(
|
||||||
registerHostContextMenuItem({
|
registerHostContextMenuItem({
|
||||||
|
|||||||
@@ -823,3 +823,13 @@ export {
|
|||||||
rightDockableIds,
|
rightDockableIds,
|
||||||
useRailItems,
|
useRailItems,
|
||||||
} from "@/sidebar/rail-items";
|
} from "@/sidebar/rail-items";
|
||||||
|
export {
|
||||||
|
hostSectionsFor,
|
||||||
|
type HostSectionDef,
|
||||||
|
listHostSections,
|
||||||
|
useHostSections,
|
||||||
|
} from "@/shell/host-sections";
|
||||||
|
export { HostTabEmbed } from "@/shell/HostTabEmbed";
|
||||||
|
import { createOperationsApi } from "@/lib/plugin-transport";
|
||||||
|
/** Core's /operations routes, with the user's own session. */
|
||||||
|
export const operationsApi = createOperationsApi();
|
||||||
@@ -471,6 +471,7 @@ export {
|
|||||||
resetHostContributions,
|
resetHostContributions,
|
||||||
} from "@/sidebar/host-contributions";
|
} from "@/sidebar/host-contributions";
|
||||||
export { registerHostProtocol } from "@/sidebar/host-protocols";
|
export { registerHostProtocol } from "@/sidebar/host-protocols";
|
||||||
|
export { registerHostSection, resetHostSections } from "@/shell/host-sections";
|
||||||
export {
|
export {
|
||||||
RAIL_ITEMS,
|
RAIL_ITEMS,
|
||||||
registerRailItem,
|
registerRailItem,
|
||||||
|
|||||||
@@ -0,0 +1,45 @@
|
|||||||
|
import { useMemo } from "react";
|
||||||
|
import type { Host, Tab } from "@/types/ui-types";
|
||||||
|
import type { TabShellCallbacks } from "@/shell/tab-registry";
|
||||||
|
import { renderTabContent } from "@/shell/tabUtils";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Draws a registered tab type inside another view, such as a host page, with
|
||||||
|
* the same props the tab stage gives it. The embed has its own instance id, so
|
||||||
|
* it never collides with the same tool opened as a normal tab.
|
||||||
|
*/
|
||||||
|
export function HostTabEmbed({
|
||||||
|
host,
|
||||||
|
type,
|
||||||
|
label,
|
||||||
|
data,
|
||||||
|
isVisible = true,
|
||||||
|
shell,
|
||||||
|
}: {
|
||||||
|
host: Host;
|
||||||
|
type: string;
|
||||||
|
label?: string;
|
||||||
|
data?: Record<string, unknown>;
|
||||||
|
isVisible?: boolean;
|
||||||
|
shell: TabShellCallbacks;
|
||||||
|
}) {
|
||||||
|
const tab = useMemo<Tab>(
|
||||||
|
() => ({
|
||||||
|
id: `embed-${type}-${host.id}`,
|
||||||
|
instanceId: `embed-${type}-${host.id}`,
|
||||||
|
type,
|
||||||
|
label: label ?? host.name ?? host.ip,
|
||||||
|
host,
|
||||||
|
openedAt: Date.now(),
|
||||||
|
data,
|
||||||
|
}),
|
||||||
|
// A new host or tool is a new tab; label and data changes keep it.
|
||||||
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
||||||
|
[type, host.id],
|
||||||
|
);
|
||||||
|
return (
|
||||||
|
<div className="h-full min-h-0 flex flex-col">
|
||||||
|
{renderTabContent(tab, { shell, isVisible, isFocusedPane: isVisible })}
|
||||||
|
</div>
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
import type { ComponentType } from "react";
|
||||||
|
import type { Host } from "@/types/ui-types";
|
||||||
|
import { byOrderThenId, createRegistry } from "@/lib/registry";
|
||||||
|
import type { TabShellCallbacks } from "@/shell/tab-registry";
|
||||||
|
|
||||||
|
export interface HostSectionRenderProps {
|
||||||
|
host: Host;
|
||||||
|
isVisible: boolean;
|
||||||
|
shell: TabShellCallbacks;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A card a plugin adds to a host page. The page itself belongs to a plugin;
|
||||||
|
* core only keeps the list so any plugin can fill it.
|
||||||
|
*/
|
||||||
|
export interface HostSectionDef {
|
||||||
|
id: string;
|
||||||
|
pluginId?: string;
|
||||||
|
titleKey: string;
|
||||||
|
order?: number;
|
||||||
|
when: (host: Host) => boolean;
|
||||||
|
component: ComponentType<HostSectionRenderProps>;
|
||||||
|
}
|
||||||
|
|
||||||
|
const sections = createRegistry<HostSectionDef>(byOrderThenId);
|
||||||
|
|
||||||
|
export const registerHostSection = sections.register;
|
||||||
|
export const useHostSections = sections.useList;
|
||||||
|
export const listHostSections = sections.list;
|
||||||
|
export const resetHostSections = sections.reset;
|
||||||
|
|
||||||
|
export function hostSectionsFor(
|
||||||
|
all: HostSectionDef[],
|
||||||
|
host: Host,
|
||||||
|
): HostSectionDef[] {
|
||||||
|
return all.filter((section) => {
|
||||||
|
try {
|
||||||
|
return section.when(host);
|
||||||
|
} catch {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
Reference in new issue
Block a user