@termix-ssh/plugin-sdk 1.0.0 → 1.0.1

package/dist/host/{chunk-F3SDZDDG.js → chunk-COGRSHKO.js}

@@ -4759,6 +4759,18 @@ async function buildOriginWsUrl({
   };
 }
 
+// src/types/onboarding.ts
+var LEGACY_SEEN = Object.freeze({
+  plugins: 1,
+  "desktop-sync": 1,
+  preset: 1,
+  appearance: 1,
+  security: 1
+});
+function pluginStepKey(pluginId, id) {
+  return `${pluginId}:${id}`;
+}
+
 // src/types/ui-preferences.ts
 var SIMPLE_RAIL_VISIBLE = ["hosts", "credentials", "connections"];
 var CORE_HIDEABLE_RAIL_VIEWS = [
@@ -4870,6 +4882,7 @@ var AREA_SPECS = {
   },
   rail: {
     hiddenTabs: { kind: "stringArray" },
+    order: { kind: "stringArray" },
     hidePluginItems: { kind: "bool" }
   },
   dashboard: {
@@ -5024,7 +5037,7 @@ async function updateRole(roleId, roleData) {
   try {
     const response = await rbacApi.put(`/rbac/roles/${roleId}`, roleData);
     if (roleData.permissions) {
-      const { notifyPermissionsChanged } = await import("./use-permissions-NULZL43J.js");
+      const { notifyPermissionsChanged } = await import("./use-permissions-SKWXHWDJ.js");
       notifyPermissionsChanged();
     }
     return response.data;
@@ -5574,7 +5587,7 @@ function createRemoteOriginApiInstance(path) {
   });
   instance.interceptors.request.use(
     async (config) => {
-      const { getLinkedSession: getLinkedSession2 } = await import("./linked-server-FZGWQW32.js");
+      const { getLinkedSession: getLinkedSession2 } = await import("./linked-server-BD573BEG.js");
       const linked = await getLinkedSession2();
       config.baseURL = linked ? `${linked.serverUrl}${path}` : "http://no-server-configured";
       if (config.headers.set) {
@@ -5926,6 +5939,7 @@ function notifySyncChanged() {
 }
 
 export {
+  getPluginStoreState,
   usePluginStore,
   setPluginSummaries,
   markPluginsSettled,
@@ -5957,6 +5971,7 @@ export {
   notifySyncChanged,
   resolveConnectionOrigin,
   buildOriginWsUrl,
+  pluginStepKey,
   PRESETS,
   hydrateLocalSharedHostAuth,
   resolveRemoteHostId,

package/dist/host/{linked-server-FZGWQW32.js → linked-server-BD573BEG.js}

@@ -3,7 +3,7 @@ import {
   SYNC_CHANGED_EVENT,
   getLinkedSession,
   notifySyncChanged
-} from "./chunk-F3SDZDDG.js";
+} from "./chunk-COGRSHKO.js";
 import "./chunk-YC2MAKSP.js";
 export {
   SYNC_CHANGED_EVENT,

package/dist/host/{rbac-api-6KDMBVDZ.js → rbac-api-7GHDJLU4.js}

@@ -23,7 +23,7 @@ import {
   shareHost,
   updateHostAccess,
   updateRole
-} from "./chunk-F3SDZDDG.js";
+} from "./chunk-COGRSHKO.js";
 import "./chunk-YC2MAKSP.js";
 export {
   assignRoleToUser,

package/dist/host/testing-host.js

@@ -32,6 +32,7 @@ import {
   listSettingsComponents,
   loadPaletteGroup,
   notifyShellReady,
+  onboardingSteps,
   registeredDashboardCardList,
   resetShellBridge,
   setPluginApiForTesting,
@@ -39,16 +40,16 @@ import {
   setShellCallbacks,
   setShellHosts,
   setShellLayoutProvider
-} from "./chunk-XH5NXL6Y.js";
+} from "./chunk-7GL25GFS.js";
 import {
   setPermissionsForTesting
-} from "./chunk-XGWE7BTJ.js";
+} from "./chunk-3KG44G55.js";
 import {
   getTabType,
   listTabTypes,
   setFrontendState,
   setPluginSummaries
-} from "./chunk-F3SDZDDG.js";
+} from "./chunk-COGRSHKO.js";
 import "./chunk-YC2MAKSP.js";
 
 // src/ui/plugin-host/testing-host.tsx
@@ -61,7 +62,8 @@ var CORE_UNSAVED = /* @__PURE__ */ new Set([
   "settings",
   "user-profile",
   "admin-settings",
-  "split-screen"
+  "split-screen",
+  "plugins"
 ]);
 function isUnregisteredPluginTabType(type) {
   return !CORE_UNSAVED.has(type) && !getTabType(type);
@@ -191,6 +193,7 @@ async function renderPlugin(plugin, options = {}) {
   setFrontendState(pluginId, "active");
   if (options.ready) notifyShellReady();
   const mine = (items) => items.filter((item) => item.pluginId === pluginId);
+  const unprefixed = (items) => mine(items).map((item) => item.id.slice(pluginId.length + 1));
   const tabRecord = (type, host) => ({
     id: `${type}-test`,
     instanceId: `${type}-test`,
@@ -230,7 +233,8 @@ async function renderPlugin(plugin, options = {}) {
       secondFactors: () => mine(listSecondFactorUIs()).map((factor) => factor.id),
       paletteGroups: () => mine(listPaletteGroups()).map((group) => group.id),
       keybindingActions: () => mine(listKeybindingActions()).map((action) => action.id),
-      keybindingDefaults: () => mine(listKeybindingDefaults()).map((binding) => binding.id)
+      keybindingDefaults: () => mine(listKeybindingDefaults()).map((binding) => binding.id),
+      onboardingSteps: () => unprefixed(onboardingSteps.list())
     },
     async loadPaletteGroup(id) {
       const group = listPaletteGroups().find((entry) => entry.id === id) ?? missing("a palette group", id);
@@ -303,6 +307,35 @@ async function renderPlugin(plugin, options = {}) {
       if (!Component) missing(`an extension "${component}" component`, id);
       return wrap(/* @__PURE__ */ jsx(Component, { ...props }));
     },
+    renderOnboardingStep(id, props = {}) {
+      const step = onboardingSteps.get(`${pluginId}:${id}`) ?? missing("an onboarding step", id);
+      const Component = step.Component;
+      let canContinue = true;
+      let beforeNext = null;
+      const element = wrap(
+        /* @__PURE__ */ jsx(
+          Component,
+          {
+            mode: "full",
+            isAdmin: true,
+            isDesktop: false,
+            shellReady: false,
+            setCanContinue: (ok) => {
+              canContinue = ok;
+            },
+            setBeforeNext: (fn) => {
+              beforeNext = fn;
+            },
+            ...props
+          }
+        )
+      );
+      return {
+        element,
+        canContinue: () => canContinue,
+        next: async () => beforeNext ? await beforeNext() : true
+      };
+    },
     renderDashboardCard(id) {
       const card = getRegisteredDashboardCard(id) ?? missing("a card", id);
       const Component = card.component;

package/dist/host/types/src/types/credential-sidebar-preferences.d.ts

@@ -19,7 +19,18 @@ export interface CredentialSidebarFilterState {
     type: string[];
     tags: string[];
 }
-export interface CredentialSidebarDisplayPreferences {
+/** Which parts of a credential row are shown. */
+export interface CredentialRowFields {
+    showUsername: boolean;
+    /** The "3h" count of hosts using it. */
+    showUsageCount: boolean;
+    showTypeBadge: boolean;
+    showPinIcon: boolean;
+    showSharedBadge: boolean;
+}
+export declare const CREDENTIAL_ROW_FIELD_KEYS: (keyof CredentialRowFields)[];
+export declare function defaultCredentialRowFields(): CredentialRowFields;
+export interface CredentialSidebarDisplayPreferences extends CredentialRowFields {
     density: CredentialDensity;
     showTags: boolean;
     trayTrigger: CredentialTrayTrigger;

package/dist/host/types/src/types/host-sidebar-preferences.d.ts

@@ -29,7 +29,19 @@ export interface HostSidebarFilterState {
     features: string[];
     tags: string[];
 }
-export interface HostSidebarDisplayPreferences {
+/** Which parts of a host row are shown. */
+export interface HostRowFields {
+    showAddress: boolean;
+    showUsername: boolean;
+    showPort: boolean;
+    showPinIcon: boolean;
+    showSharedBadge: boolean;
+    /** Badges plugins add next to the name. */
+    showBadges: boolean;
+}
+export declare const HOST_ROW_FIELD_KEYS: (keyof HostRowFields)[];
+export declare function defaultHostRowFields(): HostRowFields;
+export interface HostSidebarDisplayPreferences extends HostRowFields {
     density: HostDensity;
     showTags: boolean;
     trayTrigger: HostTrayTrigger;
@@ -39,6 +51,11 @@ export interface HostSidebarDisplayPreferences {
     /** When false, nested folders hide the parent-path breadcrumb before their name. */
     showFolderPaths: boolean;
     hostClickBehavior: HostClickBehavior;
+    /**
+     * Host action id to whether it shows in the row's connect bar. An action
+     * missing here follows its own default. Every action stays in the menu.
+     */
+    barActions: Record<string, boolean>;
 }
 export interface HostSidebarPreferences {
     version: number;

package/dist/host/types/src/types/onboarding.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Onboarding step bookkeeping, shared by the frontend and the ui-preferences
+ * route. Dependency-free for the backend's NodeNext build.
+ *
+ * Each step has a key and a version. A user's `seen` map records the highest
+ * version of each step they have been shown, so bumping one step's version
+ * shows that step again (and only that step) to everyone who saw it before.
+ * Plugin steps are keyed `<pluginId>:<id>`.
+ */
+export declare const CORE_ONBOARDING_STEPS: {
+    readonly plugins: 1;
+    readonly "desktop-sync": 1;
+    readonly preset: 1;
+    readonly appearance: 1;
+    readonly security: 1;
+};
+export type CoreOnboardingStepKey = keyof typeof CORE_ONBOARDING_STEPS;
+/**
+ * What a user who finished the old single-version onboarding counts as
+ * having seen. Frozen on purpose: a later bump in CORE_ONBOARDING_STEPS must
+ * still show the bumped step to these users.
+ */
+export declare const LEGACY_SEEN: Readonly<Record<string, number>>;
+export declare const MAX_SEEN_ENTRIES = 500;
+export declare function pluginStepKey(pluginId: string, id: string): string;
+export declare function isValidSeenEntry(key: string, version: unknown): boolean;
+export declare function sanitizeSeen(input: unknown): Record<string, number>;
+/** Per-key max, so a stale tab never lowers what another tab recorded. */
+export declare function mergeSeen(a: Record<string, number> | undefined, b: Record<string, number> | undefined): Record<string, number>;

package/dist/host/types/src/types/plugin-onboarding.d.ts

@@ -0,0 +1,39 @@
+/**
+ * The onboarding plugin picker: what the admin chose for each plugin, and the
+ * dependency rules that keep the result loadable. Shared by the picker (to
+ * show "kept because X needs it" live) and the backend apply route.
+ */
+export type PluginChoice = "enabled" | "disabled" | "remove";
+export declare const PLUGIN_CHOICES: readonly PluginChoice[];
+export interface ChoicePlugin {
+    id: string;
+    /** Hard dependencies (plugin ids). */
+    dependencies: string[];
+}
+export interface ChoiceAdjustment {
+    id: string;
+    from: PluginChoice;
+    to: PluginChoice;
+    /** The plugins whose choice forced this one up. */
+    requiredBy: string[];
+}
+export declare function isPluginChoice(value: unknown): value is PluginChoice;
+/**
+ * Raise choices until every plugin's dependencies can serve it: an enabled
+ * plugin needs its dependencies enabled, and a kept but disabled plugin
+ * needs them at least kept. Ids missing from `choices` stay as they are and
+ * are never adjusted.
+ */
+export declare function resolvePluginChoices(plugins: ChoicePlugin[], choices: Record<string, PluginChoice>): {
+    choices: Record<string, PluginChoice>;
+    adjustments: ChoiceAdjustment[];
+};
+/**
+ * The order to apply resolved choices in: enable dependencies first, and
+ * disable or remove dependents first.
+ */
+export declare function applyOrder(plugins: ChoicePlugin[], resolved: Record<string, PluginChoice>): {
+    enable: string[];
+    disable: string[];
+    remove: string[];
+};

package/dist/host/types/src/types/ui-preferences.d.ts

@@ -17,8 +17,6 @@
  */
 /** 2: the docker and host metrics areas moved to their plugins. */
 export declare const UI_PREFERENCES_VERSION = 3;
-/** Bump when onboarding gains steps existing users should be shown again. */
-export declare const UI_ONBOARDING_VERSION = 2;
 export type UiPreset = "simple" | "balanced" | "advanced" | "custom";
 export type UiAreaKey = "chrome" | "hostList" | "credentialList" | "rail" | "dashboard" | "hostEditor";
 export type UiDensity = "comfortable" | "compact";
@@ -50,6 +48,8 @@ export interface UiRailPreferences {
      * items are only known at runtime, so the preset cannot list them.
      */
     hidePluginItems?: boolean;
+    /** Rail item ids in the user's order. Items not listed keep their place. */
+    order?: string[];
 }
 export interface UiDashboardPreferences {
     enabledCards: string[];
@@ -73,10 +73,17 @@ export type UiOverrides = {
     [key: UiPluginAreaKey]: Record<string, unknown>;
 };
 export interface UiOnboardingState {
-    /** 0 means "never completed". Compared against UI_ONBOARDING_VERSION. */
-    completedVersion: number;
+    /** Step key to the highest version of that step the user was shown. */
+    seen: Record<string, number>;
+    /** When the first full run finished. Null means it never has. */
     completedAt: string | null;
     skipped: boolean;
+    /**
+     * Set for users carried over from the old single-version onboarding. The
+     * client marks every plugin step that exists right now as seen without
+     * showing it, then clears this.
+     */
+    baselinePending: boolean;
 }
 export interface UiPreferences {
     version: number;
@@ -87,6 +94,8 @@ export interface UiPreferences {
 export declare const PRESETS: Record<Exclude<UiPreset, "custom">, UiAreaPreferences>;
 export declare const UI_AREA_KEYS: UiAreaKey[];
 export declare function sanitizeUiOverrides(input: unknown): UiOverrides;
+export declare function defaultOnboardingState(): UiOnboardingState;
+export declare function sanitizeOnboarding(input: unknown): UiOnboardingState;
 export declare function defaultUiPreferences(): UiPreferences;
 export declare function sanitizeUiPreferences(input: unknown): UiPreferences;
 /**

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

@@ -128,7 +128,7 @@ export type HostFolder = {
     localOnly?: boolean;
 };
 /** Core's own tab types. Plugins register theirs at runtime. */
-type KnownTabType = "dashboard" | "host-manager" | "settings" | "user-profile" | "admin-settings" | "split-screen";
+type KnownTabType = "dashboard" | "host-manager" | "settings" | "user-profile" | "admin-settings" | "split-screen" | "plugins";
 /**
  * TabType covers every built-in tab plus any plugin-contributed tab id.
  * `string & {}` (rather than plain `string`) keeps IDE autocomplete

package/dist/host/types/src/ui/api/plugins-api.d.ts

@@ -1,3 +1,6 @@
+import type { ChoiceAdjustment, PluginChoice } from "../../types/plugin-onboarding";
+import type { ChangelogRelease, ReleaseNotes } from "@termix-ssh/plugin-sdk/changelog";
+export type { PluginChoice };
 export interface PluginTabContribution {
     id: string;
     titleKey: string;
@@ -124,5 +127,196 @@ export interface PluginSummary {
         http: string[];
         ws: string[];
     };
+    registryId?: string | null;
+    autoUpdate?: boolean;
+    pinnedVersion?: string | null;
+    description?: string;
+    author?: string;
+    repository?: string;
+    /** A YouTube video id from the manifest. Admins only. */
+    videoId?: string;
+    signedBy?: string | null;
 }
 export declare function getPlugins(): Promise<PluginSummary[]>;
+/** Fired after any change to installed plugins; the loader resyncs on it. */
+export declare const PLUGINS_CHANGED_EVENT = "termix:plugins-changed";
+export interface RegistryPluginVersion {
+    version: string;
+    compatible: boolean;
+    capabilities: string[];
+    publishedAt?: string;
+    releaseNotesUrl?: string;
+    notes?: ReleaseNotes;
+    size: number;
+}
+export interface RegistryPluginEntry {
+    id: string;
+    name: string;
+    description: string;
+    author: string;
+    category: string;
+    repository?: string;
+    icon?: string;
+    videoId?: string;
+    versions: RegistryPluginVersion[];
+    latestVersion: string | null;
+    installed: boolean;
+    installedVersion: string | null;
+    updateAvailable: boolean;
+    addedCapabilities: string[];
+    pinnedVersion: string | null;
+    autoUpdate: boolean;
+    bundled: boolean;
+    /** Active installs when known, release downloads otherwise. */
+    installCount: number | null;
+    installCountSource: string | null;
+}
+export interface RegistryListing {
+    registry: {
+        id: string;
+        url: string;
+        lastCheckedAt: string | null;
+        error: string | null;
+    };
+    managedByServer: boolean;
+    plugins: RegistryPluginEntry[];
+}
+export interface PluginStateChange {
+    id: string;
+    enabled: boolean;
+    enable: string[];
+    disable: string[];
+    missing: string[];
+    state?: string;
+}
+export interface PluginDataSummary {
+    id: string;
+    tables: Array<{
+        name: string;
+        rows: number | null;
+    }>;
+    kvKeys: number;
+    settings: {
+        admin: number;
+        user: number;
+        host: number;
+        secret: number;
+    };
+    migrations: Array<{
+        id: string;
+        appliedAt: string | null;
+    }>;
+    grants: Array<{
+        capability: string;
+        source: string;
+        grantedAt: string | null;
+    }>;
+    filesBytes: number;
+}
+export interface UpdateAllResult {
+    updated: Array<{
+        id: string;
+        version: string;
+    }>;
+    needsReview: Array<{
+        id: string;
+        capabilities: string[];
+    }>;
+    failed: Array<{
+        id: string;
+        error: string;
+    }>;
+}
+export declare function getPluginRegistry(refresh?: boolean): Promise<RegistryListing>;
+/** `capabilities` is exactly what the consent prompt showed. */
+export declare function installPlugin(pluginId: string, options: {
+    version?: string;
+    capabilities: string[];
+}): Promise<{
+    id: string;
+    version: string;
+    state: string;
+}>;
+export declare function updatePlugin(pluginId: string, options?: {
+    version?: string;
+    acceptCapabilities?: boolean;
+    capabilities?: string[];
+}): Promise<{
+    id: string;
+    version: string;
+    state: string;
+}>;
+export declare function updateAllPlugins(): Promise<UpdateAllResult>;
+export declare function uninstallPlugin(pluginId: string): Promise<void>;
+export declare function previewPluginState(pluginId: string, enabled: boolean): Promise<PluginStateChange>;
+export declare function setPluginState(pluginId: string, enabled: boolean): Promise<PluginStateChange>;
+export declare function retryPlugin(pluginId: string): Promise<void>;
+export declare function setPluginOptions(pluginId: string, options: {
+    autoUpdate?: boolean;
+    pinned?: boolean;
+}): Promise<{
+    autoUpdate: boolean;
+    pinnedVersion: string | null;
+}>;
+export declare function getPluginData(pluginId: string): Promise<PluginDataSummary>;
+export declare function getPluginChangelog(pluginId: string): Promise<ChangelogRelease[]>;
+export declare function deletePluginData(pluginId: string): Promise<void>;
+export interface DeveloperModeState {
+    enabled: boolean;
+    /** TERMIX_REQUIRE_SIGNED_PLUGINS blocks file installs even in developer mode. */
+    signedOnly: boolean;
+}
+export declare function getDeveloperMode(): Promise<DeveloperModeState>;
+/** Fired after developer mode changes; detail is the new value. */
+export declare const DEVELOPER_MODE_CHANGED_EVENT = "termix:plugin-developer-mode";
+export declare function setDeveloperMode(enabled: boolean): Promise<void>;
+export interface PluginUploadPreview {
+    token: string;
+    id: string;
+    name: string;
+    version: string;
+    description: string;
+    author: string;
+    capabilities: string[];
+    replaces: string | null;
+}
+export declare function uploadPlugin(file: Blob): Promise<PluginUploadPreview>;
+export declare function installUploadedPlugin(token: string, capabilities: string[]): Promise<{
+    id: string;
+    version: string;
+    state: string;
+}>;
+export interface OnboardingPluginInfo {
+    id: string;
+    name: string;
+    description: string;
+    icon: string | null;
+    category: string;
+    version: string;
+    source: "bundled" | "user";
+    state: string;
+    dependencies: string[];
+    recommended: boolean;
+    consent: boolean;
+}
+export interface OnboardingPluginList {
+    pending: boolean;
+    /** On an upgrade the picker starts from what is on, not the defaults. */
+    reason: "fresh" | "upgrade" | null;
+    managedByLinkedServer: boolean;
+    plugins: OnboardingPluginInfo[];
+}
+export interface OnboardingApplyResult {
+    resolved: Record<string, PluginChoice>;
+    adjustments: ChoiceAdjustment[];
+    enabled: string[];
+    disabled: string[];
+    removed: string[];
+    failed: {
+        id: string;
+        error: string;
+        code?: string;
+    }[];
+}
+export declare function getOnboardingPlugins(): Promise<OnboardingPluginList>;
+export declare function applyOnboardingPlugins(choices: Record<string, PluginChoice>): Promise<OnboardingApplyResult>;

package/dist/host/types/src/ui/components/connection/ConnectionLogPanel.d.ts

@@ -2,8 +2,9 @@ interface ConnectionLogPanelProps {
     isConnecting: boolean;
     isConnected: boolean;
     hasConnectionError: boolean;
+    /** Kept for older callers. The log always sits at the bottom. */
     position?: "top" | "bottom";
     className?: string;
 }
-export declare function ConnectionLogPanel({ isConnecting, isConnected, hasConnectionError, position, className, }: ConnectionLogPanelProps): import("react").JSX.Element;
+export declare function ConnectionLogPanel({ isConnecting, isConnected, hasConnectionError, className, }: ConnectionLogPanelProps): import("react").JSX.Element;
 export {};

package/dist/host/types/src/ui/components/connection/ConnectionScreen.d.ts

@@ -12,9 +12,7 @@ export interface ConnectionScreenProps {
     message?: string;
     /** Second line under the headline, usually user@host:port. */
     detail?: string;
-    /** Headline once it has failed and is not retrying on its own. */
-    errorMessage?: string;
-    /** The reason it failed, shown under the headline. */
+    /** The reason it failed. Falls back to the last error in the log. */
     errorDetail?: string | null;
     /** Shown instead of a failure when the feature cannot run here. */
     unavailable?: ConnectionUnavailable | null;
@@ -23,12 +21,14 @@ export interface ConnectionScreenProps {
     maxAttempts?: number;
     nextRetryInMs?: number | null;
     onManualRetry?: () => void;
-    retryLabel?: string;
+    /** Headline when it was up and dropped. */
     disconnectedMessage?: string;
+    /** Overrides closing the tab this sits in. False hides the button. */
+    onClose?: (() => void) | false;
     extraActions?: React.ReactNode;
     logPosition?: "top" | "bottom";
     emptyState?: React.ReactNode;
     className?: string;
 }
 /** The one screen every connection shows until it is up. */
-export declare function ConnectionScreen({ status, message, detail, errorMessage, errorDetail, unavailable, backgroundColor, attempt, maxAttempts, nextRetryInMs, onManualRetry, retryLabel, disconnectedMessage, extraActions, logPosition, emptyState, className, }: ConnectionScreenProps): React.JSX.Element;
+export declare function ConnectionScreen({ status, message, detail, errorDetail, unavailable, backgroundColor, attempt, maxAttempts, nextRetryInMs, onManualRetry, disconnectedMessage, onClose, extraActions, logPosition, emptyState, className, }: ConnectionScreenProps): React.JSX.Element;