@termix-ssh/plugin-sdk 1.0.23 → 1.0.24

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # 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
 
 Plugin API 1.14.0.

package/PLUGIN-GUIDE.md

@@ -1,6 +1,6 @@
 # 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
 `@termix-ssh/plugin-sdk`, so the copy in your `node_modules` always matches the SDK you have installed.

package/dist/frontend.d.ts

@@ -643,6 +643,20 @@ export interface HostBadgeContribution {
 export type HostStatusIndicatorContribution = HostBadgeContribution;
 /** A control in the host editor's toolbar. */
 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 {
     id: string;
     titleKey: string;
@@ -1085,6 +1099,11 @@ export interface TermixApp extends TermixAppInfo {
     /** Adds a control to the host editor's toolbar. */
     registerHostEditorToolbarItem: (item: HostEditorToolbarItemContribution) => Disposer;
     registerHostContextMenuItem: (item: HostContextMenuItemContribution) => 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;
     registerPaletteGroup: (group: PaletteGroupContribution) => Disposer;
     registerKeybindingAction: (action: KeybindingActionContribution) => Disposer;

package/dist/host/{chunk-X65V7ZRW.js → chunk-5W6F6GJJ.js}

@@ -3060,6 +3060,23 @@ function withProtocolSettings(pluginSettings, flags, list = listHostProtocols())
   return next;
 }
 
+// src/ui/shell/host-sections.ts
+init_define_import_meta_env();
+var sections2 = createRegistry(byOrderThenId);
+var registerHostSection = sections2.register;
+var useHostSections = sections2.useList;
+var listHostSections = sections2.list;
+var resetHostSections = sections2.reset;
+function hostSectionsFor(all, host) {
+  return all.filter((section) => {
+    try {
+      return section.when(host);
+    } catch {
+      return false;
+    }
+  });
+}
+
 // src/ui/dashboard/dashboard-cards-registry.ts
 init_define_import_meta_env();
 var registry3 = createRegistry();
@@ -3244,6 +3261,22 @@ function createPluginApi(pluginId) {
     }
   });
 }
+function createOperationsApi() {
+  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, ...rest) => value.call(
+          target,
+          `/operations${url.startsWith("/") ? url : `/${url}`}`,
+          ...rest
+        );
+      }
+      return value.bind(target);
+    }
+  });
+}
 function pluginFetch(pluginId, path2, init = {}) {
   const base = (authApi.defaults.baseURL ?? "").replace(/\/+$/, "");
   const headers = new Headers(init.headers);
@@ -8688,6 +8721,20 @@ function createPluginApp(pluginId, manifest, contributes, options = {}) {
         })
       );
     },
+    registerHostSection(section) {
+      return track(
+        registerHostSection({
+          id: section.id,
+          pluginId,
+          titleKey: key(section.titleKey),
+          order: section.order,
+          when: hostCallback(section.when ?? (() => true)),
+          component: scoped(
+            section.component
+          )
+        })
+      );
+    },
     registerHostContextMenuItem(item) {
       return track(
         registerHostContextMenuItem({
@@ -9096,6 +9143,11 @@ export {
   hostProtocolFlags,
   enabledHostProtocols,
   withProtocolSettings,
+  registerHostSection,
+  useHostSections,
+  listHostSections,
+  resetHostSections,
+  hostSectionsFor,
   registerDashboardCard,
   getRegisteredDashboardCard,
   registeredDashboardCardList,
@@ -9113,6 +9165,7 @@ export {
   registerSlotContribution,
   getSlotContributions,
   resetActionRegistry,
+  createOperationsApi,
   pluginWsUrl,
   PluginComponent,
   onboardingSteps,

package/dist/host/{chunk-BP42N374.js → chunk-EKXGDM5P.js}

@@ -1,7 +1,7 @@
 const __termixNoGlob = () => ({});
 import {
   useTheme
-} from "./chunk-X65V7ZRW.js";
+} from "./chunk-5W6F6GJJ.js";
 import {
   init_define_import_meta_env
 } from "./chunk-YGYBM7SQ.js";

package/dist/host/{chunk-GBBKHJRQ.js → chunk-RWFXGG4Q.js}

@@ -15,7 +15,7 @@ import {
   useCompanionState,
   useIsMobile,
   useSettingsComponents
-} from "./chunk-X65V7ZRW.js";
+} from "./chunk-5W6F6GJJ.js";
 import {
   usePermissions
 } from "./chunk-GRH7GSKG.js";

package/dist/host/frame-host.js

@@ -1,7 +1,7 @@
 const __termixNoGlob = () => ({});
 import {
   Toaster
-} from "./chunk-BP42N374.js";
+} from "./chunk-EKXGDM5P.js";
 import {
   ThemeProvider,
   createPluginApp,
@@ -12,7 +12,7 @@ import {
   setPluginThemes,
   sshHostToHost,
   useTheme
-} from "./chunk-X65V7ZRW.js";
+} from "./chunk-5W6F6GJJ.js";
 import "./chunk-GRH7GSKG.js";
 import {
   SurfaceScope,

package/dist/host/testing-host.js

@@ -7,7 +7,7 @@ import {
   PluginViewPlaceholder,
   renderTabContent,
   trackTabHandle
-} from "./chunk-GBBKHJRQ.js";
+} from "./chunk-RWFXGG4Q.js";
 import {
   RAIL_ITEMS,
   ServerStatusProvider,
@@ -46,6 +46,7 @@ import {
   registerDashboardCard,
   registerHostAction,
   registerHostProtocol,
+  registerHostSection,
   registerKeybindingAction,
   registerKeybindingDefault,
   registerRailItem,
@@ -54,6 +55,7 @@ import {
   resetActionRegistry,
   resetDashboardCards,
   resetHostContributions,
+  resetHostSections,
   resetKeybindingRegistry,
   resetRegisteredRailItems,
   resolveLayoutTabTarget,
@@ -61,7 +63,7 @@ import {
   setRemoteServerUrlForTesting,
   useShellController,
   useTabStageStore
-} from "./chunk-X65V7ZRW.js";
+} from "./chunk-5W6F6GJJ.js";
 import {
   setPermissionsForTesting
 } from "./chunk-GRH7GSKG.js";
@@ -499,6 +501,7 @@ export {
   registerDashboardCard,
   registerHostAction,
   registerHostProtocol,
+  registerHostSection,
   registerKeybindingAction,
   registerKeybindingDefault,
   registerRailItem,
@@ -507,6 +510,7 @@ export {
   resetActionRegistry,
   resetDashboardCards,
   resetHostContributions,
+  resetHostSections,
   resetKeybindingRegistry,
   resetPluginStore,
   resetRegisteredRailItems,

package/dist/host/types/src/ui/lib/plugin-transport.d.ts

@@ -25,6 +25,11 @@ import { type ConnectionOrigin, type WebSocketConnectionTarget } from "./connect
  * reporting all behave identically.
  */
 export declare function createPluginApi(pluginId: string): AxiosInstance;
+/**
+ * An axios client rooted at core's /operations routes: the action catalog,
+ * runs, approvals, events, signals and cross host resources.
+ */
+export declare function createOperationsApi(): AxiosInstance;
 /**
  * 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

package/dist/host/types/src/ui/plugin-host/sdk-ui.d.ts

@@ -196,3 +196,7 @@ export { useEditorDefaultKeys } from "../sidebar/host-defaults/catalog";
 export { enabledHostProtocols, type HostProtocolDef, hostProtocolFlags, type HostProtocols, listHostProtocols, protocolEnabled, protocolPort, useHostProtocols, withProtocolSettings, } from "../sidebar/host-protocols";
 export { quickConnectTargets } from "../sidebar/quick-connect-host";
 export { groupRailItems, isCoreRailView, moveRailItem, promotableIds, type RailGroup, type RailItemDef, railItemLabel, rightDockableIds, useRailItems, } from "../sidebar/rail-items";
+export { hostSectionsFor, type HostSectionDef, listHostSections, useHostSections, } from "../shell/host-sections";
+export { HostTabEmbed } from "../shell/HostTabEmbed";
+/** Core's /operations routes, with the user's own session. */
+export declare const operationsApi: import("axios").AxiosInstance;

package/dist/host/types/src/ui/shell/HostTabEmbed.d.ts

@@ -0,0 +1,15 @@
+import type { Host } from "../../types/ui-types";
+import type { TabShellCallbacks } from "./tab-registry";
+/**
+ * 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 declare function HostTabEmbed({ host, type, label, data, isVisible, shell, }: {
+    host: Host;
+    type: string;
+    label?: string;
+    data?: Record<string, unknown>;
+    isVisible?: boolean;
+    shell: TabShellCallbacks;
+}): import("react").JSX.Element;

package/dist/host/types/src/ui/shell/host-sections.d.ts

@@ -0,0 +1,25 @@
+import type { ComponentType } from "react";
+import type { Host } from "../../types/ui-types";
+import type { TabShellCallbacks } from "./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>;
+}
+export declare const registerHostSection: (item: HostSectionDef) => () => void;
+export declare const useHostSections: () => HostSectionDef[];
+export declare const listHostSections: () => HostSectionDef[];
+export declare const resetHostSections: () => void;
+export declare function hostSectionsFor(all: HostSectionDef[], host: Host): HostSectionDef[];

package/dist/host/ui.js

@@ -16,15 +16,16 @@ import {
   markTabSurfaceUsed,
   preloadTabSurface,
   recordHostActionPreference,
+  renderTabContent,
   runAdaptiveBackgroundTask,
   tabIcon,
   useInstalledPlugins,
   usePluginHostSections,
   useTabHandlesVersion
-} from "./chunk-GBBKHJRQ.js";
+} from "./chunk-RWFXGG4Q.js";
 import {
   Toaster
-} from "./chunk-BP42N374.js";
+} from "./chunk-EKXGDM5P.js";
 import {
   ACCENT_PRESET_COLORS,
   BUILTIN_THEMES,
@@ -48,6 +49,7 @@ import {
   canJoinSplit,
   challengeSecondFactor,
   changeAppLanguage,
+  createOperationsApi,
   createPluginApp,
   createQuickConnectHost,
   defaultConnectAction,
@@ -75,6 +77,7 @@ import {
   hostEditorToolbarItemsFor,
   hostMenuItemsFor,
   hostProtocolFlags,
+  hostSectionsFor,
   hostStatusIndicatorsFor,
   i18n_default,
   installPluginHostBridge,
@@ -86,6 +89,7 @@ import {
   layoutLabel,
   listHostActions,
   listHostProtocols,
+  listHostSections,
   listPanes,
   listRegisteredRailItems,
   loadPaletteGroup,
@@ -139,6 +143,7 @@ import {
   useHostEditorSections,
   useHostEditorToolbarItems,
   useHostProtocols,
+  useHostSections,
   useHostStatus,
   useHostStatusIndicators,
   useIsMobile,
@@ -165,7 +170,7 @@ import {
   useThemes,
   verifySecondFactor,
   withProtocolSettings
-} from "./chunk-X65V7ZRW.js";
+} from "./chunk-5W6F6GJJ.js";
 import {
   usePermissions
 } from "./chunk-GRH7GSKG.js";
@@ -33305,6 +33310,38 @@ function AuthEnrollmentSections({
     );
   }) });
 }
+
+// src/ui/shell/HostTabEmbed.tsx
+init_define_import_meta_env();
+import { useMemo as useMemo10 } from "react";
+import { jsx as jsx55 } from "react/jsx-runtime";
+function HostTabEmbed({
+  host,
+  type,
+  label,
+  data,
+  isVisible = true,
+  shell: shell2
+}) {
+  const tab = useMemo10(
+    () => ({
+      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 /* @__PURE__ */ jsx55("div", { className: "h-full min-h-0 flex flex-col", children: renderTabContent(tab, { shell: shell2, isVisible, isFocusedPane: isVisible }) });
+}
+
+// src/ui/plugin-host/sdk-ui.ts
+var operationsApi = createOperationsApi();
 export {
   ACCENT_PRESET_COLORS,
   APP_VERSION,
@@ -33404,6 +33441,7 @@ export {
   HostFeatureFields,
   HostKeyVerificationDialog,
   HostOnly,
+  HostTabEmbed,
   IconPicker,
   InlineView,
   Input,
@@ -33638,6 +33676,7 @@ export {
   hostEditorToolbarItemsFor,
   hostMenuItemsFor,
   hostProtocolFlags,
+  hostSectionsFor,
   hostStatusIndicatorsFor,
   hydrateLocalSharedHostAuth,
   invalidateHostsAndStatusCaches,
@@ -33656,6 +33695,7 @@ export {
   remoteServerUrl as linkedServerUrl,
   listHostActions,
   listHostProtocols,
+  listHostSections,
   loadPaletteGroup,
   logoutUser,
   makeHostSshSubTabs,
@@ -33669,6 +33709,7 @@ export {
   normalizeLanguageCode,
   notifySyncChanged,
   openInSplit,
+  operationsApi,
   paletteEntriesFor,
   parseCustomKeybindings,
   parseServerTime,
@@ -33779,6 +33820,7 @@ export {
   useHostEditorSections,
   useHostEditorToolbarItems,
   useHostProtocols,
+  useHostSections,
   useHostStatus,
   useHostStatusIndicators,
   useInstalledPlugins,

package/package.json

@@ -1,6 +1,6 @@
 {
   "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.",
   "license": "Apache-2.0",
   "repository": {