@termix-ssh/plugin-sdk 1.0.1 → 1.0.4

package/dist/changelog.js

@@ -3,12 +3,7 @@
  *
  *   # Changelog
  *
- *   ## Unreleased
- *
- *   ### Added
- *   - Something merged but not shipped yet
- *
- *   ## 1.1.0 - 2026-10-06
+ *   ## 1.1.0
  *
  *   An optional summary paragraph.
  *
@@ -19,7 +14,8 @@
  *   - Something broken
  *
  * Releases are listed newest first, and the newest one has to be the
- * manifest version. The date is optional until the version ships.
+ * manifest version. Notes go straight under the version they ship in, there
+ * is no Unreleased section.
  */
 import semver from "semver";
 export const CHANGE_TYPES = [
@@ -94,7 +90,7 @@ export function parseReleaseNotes(body, where = "release") {
 /** Parses a whole CHANGELOG.md. Problems are reported, never thrown. */
 export function parseChangelog(markdown) {
     const problems = [];
-    const changelog = { unreleased: [], releases: [] };
+    const changelog = { releases: [] };
     const lines = markdown.replace(/\r/g, "").split("\n");
     const blocks = [];
     let fence = false;
@@ -109,13 +105,9 @@ export function parseChangelog(markdown) {
         }
     });
     const seen = new Set();
-    blocks.forEach((block, i) => {
+    blocks.forEach((block) => {
         if (UNRELEASED_HEADING.test(block.heading)) {
-            if (i !== 0)
-                problems.push(`"## Unreleased" has to come first`);
-            const notes = parseReleaseNotes(block.body.join("\n"), "Unreleased");
-            problems.push(...notes.problems);
-            changelog.unreleased = notes.changes;
+            problems.push(`line ${block.line}: drop "## Unreleased", notes go under the version they ship in`);
             return;
         }
         const match = RELEASE_HEADING.exec(block.heading);

package/dist/docs.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Docs links and env var entries from a manifest. Kept apart from manifest.ts
+ * so the browser can use them without pulling in semver.
+ */
+/**
+ * A docs link, or null for anything that is not an https URL. Core only ever
+ * opens it in a new tab, but a javascript: or file: link should never get there.
+ */
+export declare function pluginDocsUrl(value: unknown): string | null;
+/** Joins a page and anchor onto a plugin's docs URL. */
+export declare function pluginDocsPage(base: string, page?: string, anchor?: string): string;
+export declare const ENV_NAME_PATTERN: RegExp;
+export declare const MAX_ENV_DESCRIPTION_LENGTH = 300;
+/**
+ * An environment variable a plugin reads. Only shown in docs and on the
+ * plugin's page, so people know what they can set.
+ */
+export interface PluginEnvVar {
+    name: string;
+    description: string;
+    /** The value used when it is not set, as written in a compose file. */
+    default?: string;
+    required?: boolean;
+    /** Holds a password or key. */
+    secret?: boolean;
+}
+/** The usable env entries of a manifest. Bad ones are dropped. */
+export declare function pluginEnvVars(value: unknown): PluginEnvVar[];

package/dist/docs.js

@@ -0,0 +1,39 @@
+/**
+ * Docs links and env var entries from a manifest. Kept apart from manifest.ts
+ * so the browser can use them without pulling in semver.
+ */
+/**
+ * A docs link, or null for anything that is not an https URL. Core only ever
+ * opens it in a new tab, but a javascript: or file: link should never get there.
+ */
+export function pluginDocsUrl(value) {
+    if (typeof value !== "string")
+        return null;
+    try {
+        const url = new URL(value.trim());
+        if (url.protocol !== "https:")
+            return null;
+        return url.toString().replace(/\/$/, "");
+    }
+    catch {
+        return null;
+    }
+}
+/** Joins a page and anchor onto a plugin's docs URL. */
+export function pluginDocsPage(base, page, anchor) {
+    const clean = (page ?? "").replace(/^\/+|\/+$/g, "");
+    const url = clean ? `${base}/${clean}` : base;
+    return anchor ? `${url}#${anchor.replace(/^#/, "")}` : url;
+}
+export const ENV_NAME_PATTERN = /^[A-Z][A-Z0-9_]{0,63}$/;
+export const MAX_ENV_DESCRIPTION_LENGTH = 300;
+/** The usable env entries of a manifest. Bad ones are dropped. */
+export function pluginEnvVars(value) {
+    if (!Array.isArray(value))
+        return [];
+    return value.filter((v) => typeof v === "object" &&
+        v !== null &&
+        typeof v.name === "string" &&
+        ENV_NAME_PATTERN.test(v.name) &&
+        typeof v.description === "string");
+}

package/dist/frontend.d.ts

@@ -816,6 +816,15 @@ export interface DesktopApi {
     /** Called when the desktop app connects to or leaves a remote server. */
     onRemoteServerChange: (listener: () => void) => Disposer;
 }
+/** Links into this plugin's docs, from the manifest's docs field. */
+export interface DocsApi {
+    /** The docs link, or null when the manifest has none. */
+    readonly url: string | null;
+    /** A page of the docs ("setup"), with an optional anchor. */
+    page: (page?: string, anchor?: string) => string | null;
+    /** Opens a page in a new tab. Does nothing without a docs link. */
+    open: (page?: string, anchor?: string) => void;
+}
 export interface TermixAppInfo {
     readonly pluginId: string;
     readonly manifest: PluginManifest;
@@ -913,6 +922,8 @@ export interface TermixApp extends TermixAppInfo {
     confirm: (options: ConfirmRequest) => Promise<boolean>;
     /** The desktop app, when the frontend runs in it. */
     desktop: DesktopApi;
+    /** This plugin's docs. Needs plugin API 1.2. */
+    docs: DocsApi;
     /**
      * Fires after this plugin's settings are saved from the settings screen or
      * the host editor. Disposed automatically.
@@ -966,6 +977,7 @@ export interface SshAuthTypeInfo {
  */
 export interface PluginHostBridge {
     usePluginId: () => string;
+    useDocsUrl: (pluginId: string, page?: string, anchor?: string) => string | null;
     useTranslation: (pluginId: string) => {
         t: TranslateFn;
         language: string;
@@ -1107,6 +1119,11 @@ export interface HostStatusInfo {
 export declare function __setPluginHost(bridge: PluginHostBridge | null): void;
 /** The id of the plugin that registered the component being rendered. */
 export declare function usePluginId(): string;
+/**
+ * A page of this plugin's docs, or null when the manifest has no docs link.
+ * Pass it to PanelShell's docs prop or use DocsLink. Needs plugin API 1.2.
+ */
+export declare function useDocsUrl(page?: string, anchor?: string): string | null;
 /**
  * Translation bound to this plugin's namespace. Keys the plugin does not
  * define fall back to core's shared strings (common.*, hosts.*).

package/dist/frontend.js

@@ -49,6 +49,14 @@ function requireHost() {
 export function usePluginId() {
     return requireHost().usePluginId();
 }
+/**
+ * A page of this plugin's docs, or null when the manifest has no docs link.
+ * Pass it to PanelShell's docs prop or use DocsLink. Needs plugin API 1.2.
+ */
+export function useDocsUrl(page, anchor) {
+    const bridge = requireHost();
+    return bridge.useDocsUrl(bridge.usePluginId(), page, anchor);
+}
 /**
  * Translation bound to this plugin's namespace. Keys the plugin does not
  * define fall back to core's shared strings (common.*, hosts.*).

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

@@ -5037,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-SKWXHWDJ.js");
+      const { notifyPermissionsChanged } = await import("./use-permissions-KIQCJ35M.js");
       notifyPermissionsChanged();
     }
     return response.data;
@@ -5266,6 +5266,7 @@ async function getUserPreferences() {
 }
 
 // src/ui/main-axios.ts
+var TRUST_TOKEN_KEY = "termixTrustToken";
 function getLoggerForService(serviceName) {
   if (serviceName.includes("SSH") || serviceName.includes("ssh")) {
     return sshLogger;
@@ -5427,6 +5428,15 @@ function createApiInstance(baseURL, serviceName = "API") {
           config.headers["Authorization"] = `Bearer ${jwt}`;
         }
       }
+      const trustToken = localStorage.getItem(TRUST_TOKEN_KEY);
+      const isLogin = config.url?.includes("/users/login") || /\/users\/auth\/[^/]+\/verify$/.test(config.url ?? "");
+      if (trustToken && isLogin) {
+        if (config.headers.set) {
+          config.headers.set("X-Termix-Trust-Token", trustToken);
+        } else {
+          config.headers["X-Termix-Trust-Token"] = trustToken;
+        }
+      }
     }
     if (typeof window !== "undefined" && window.ReactNativeWebView) {
       let platform = "Unknown";
@@ -5587,7 +5597,7 @@ function createRemoteOriginApiInstance(path) {
   });
   instance.interceptors.request.use(
     async (config) => {
-      const { getLinkedSession: getLinkedSession2 } = await import("./linked-server-BD573BEG.js");
+      const { getLinkedSession: getLinkedSession2 } = await import("./linked-server-4VWYYABP.js");
       const linked = await getLinkedSession2();
       config.baseURL = linked ? `${linked.serverUrl}${path}` : "http://no-server-configured";
       if (config.headers.set) {
@@ -6009,6 +6019,7 @@ export {
   patchOpenTab,
   parseCustomKeybindings,
   getUserPreferences,
+  TRUST_TOKEN_KEY,
   setCookie,
   getCookie,
   markUserAuthenticated,

package/dist/host/{chunk-3KG44G55.js → chunk-O2OHNVFX.js}

@@ -21,7 +21,7 @@ var inFlight = null;
 function load() {
   if (cache) return Promise.resolve(cache);
   if (inFlight) return inFlight;
-  inFlight = import("./rbac-api-7GHDJLU4.js").then(({ getMyPermissions }) => getMyPermissions()).then((result) => {
+  inFlight = import("./rbac-api-WIJVZH3M.js").then(({ getMyPermissions }) => getMyPermissions()).then((result) => {
     cache = {
       permissions: result.permissions ?? [],
       isAdmin: !!result.isAdmin