@termix-ssh/plugin-sdk 1.0.21 → 1.0.22

package/dist/host/{use-permissions-VAND5GEG.js → use-permissions-EWRI3WLT.js}

@@ -7,7 +7,7 @@ import {
   resetPermissionsCache,
   setPermissionsForTesting,
   usePermissions
-} from "./chunk-FGX27MAA.js";
+} from "./chunk-JRV2HIDK.js";
 import "./chunk-YGYBM7SQ.js";
 export {
   hasPermission,

package/dist/host-commands.d.ts

@@ -17,6 +17,13 @@ export interface ExecResult {
     stderr: string;
     code: number | null;
 }
+/**
+ * Decodes raw command output. Strict UTF-8 first; when that fails, tries GBK,
+ * which is what a Chinese-locale Windows console sends (its bytes are almost
+ * never valid UTF-8) and keeps it only when it decodes without replacement
+ * characters. Anything else falls back to lossy UTF-8, the old behavior.
+ */
+export declare function decodeCommandOutput(buf: Buffer): string;
 /** Runs one non-interactive command over an existing ssh2 client. */
 export declare function execCommand(client: Client, command: string, timeoutMs?: number): Promise<ExecResult>;
 export type PackageManager = "apt" | "dnf" | "yum" | "pacman" | null;

package/dist/host-commands.js

@@ -11,6 +11,30 @@
 // Homebrew and OrbStack paths a non-interactive shell misses.
 import { EXTRA_PATH_DIRS } from "./host-scripts/docker.js";
 export { EXTRA_PATH_DIRS };
+/**
+ * Decodes raw command output. Strict UTF-8 first; when that fails, tries GBK,
+ * which is what a Chinese-locale Windows console sends (its bytes are almost
+ * never valid UTF-8) and keeps it only when it decodes without replacement
+ * characters. Anything else falls back to lossy UTF-8, the old behavior.
+ */
+export function decodeCommandOutput(buf) {
+    try {
+        return new TextDecoder("utf-8", { fatal: true, ignoreBOM: true }).decode(buf);
+    }
+    catch {
+        // not valid UTF-8, try the legacy codepage
+    }
+    try {
+        // A Node built with small-ICU has no GBK decoder and throws here.
+        const gbk = new TextDecoder("gbk").decode(buf);
+        if (!gbk.includes("�"))
+            return gbk;
+    }
+    catch {
+        // expected - fall through to lossy UTF-8
+    }
+    return buf.toString("utf8");
+}
 /** Runs one non-interactive command over an existing ssh2 client. */
 export function execCommand(client, command, timeoutMs = 30000) {
     return new Promise((resolve, reject) => {
@@ -48,8 +72,10 @@ export function execCommand(client, command, timeoutMs = 30000) {
                 return;
             }
             stream = _stream;
-            let stdout = "";
-            let stderr = "";
+            // Chunks are buffered and decoded once on close: a multi-byte character
+            // can be split across chunks, and charset detection needs it whole.
+            const stdout = [];
+            const stderr = [];
             let exitCode = null;
             stream
                 .on("close", (code) => {
@@ -57,11 +83,15 @@ export function execCommand(client, command, timeoutMs = 30000) {
                     settled = true;
                     exitCode = typeof code === "number" ? code : null;
                     cleanup();
-                    resolve({ stdout, stderr, code: exitCode });
+                    resolve({
+                        stdout: decodeCommandOutput(Buffer.concat(stdout)),
+                        stderr: decodeCommandOutput(Buffer.concat(stderr)),
+                        code: exitCode,
+                    });
                 }
             })
                 .on("data", (data) => {
-                stdout += data.toString("utf8");
+                stdout.push(data);
             })
                 .on("error", (streamErr) => {
                 if (!settled) {
@@ -73,7 +103,7 @@ export function execCommand(client, command, timeoutMs = 30000) {
             if (stream.stderr) {
                 stream.stderr
                     .on("data", (data) => {
-                    stderr += data.toString("utf8");
+                    stderr.push(data);
                 })
                     .on("error", (stderrErr) => {
                     if (!settled) {

package/dist/manifest.d.ts

@@ -20,7 +20,7 @@ export { ENV_NAME_PATTERN, MAX_ENV_DESCRIPTION_LENGTH, pluginDocsPage, pluginDoc
  * "^1.2" needs 1.2 or later). engine.termix is checked against the core
  * version by the server.
  */
-export declare const PLUGIN_API_VERSION = "1.12.0";
+export declare const PLUGIN_API_VERSION = "1.13.0";
 /** The API major, the default engine.api for a new plugin. */
 export declare const SUPPORTED_PLUGIN_API_VERSION: string;
 /** Whether this build's plugin API satisfies a manifest's engine.api. */
@@ -363,6 +363,33 @@ export interface PluginContributions {
     layouts?: PluginLayoutContribution[];
     /** Themes. Needs the ui:theme capability. */
     themes?: PluginThemeContribution[];
+    /** How the plugin shows in the Termix mobile app. Plugin API 1.13. */
+    mobile?: PluginMobileContribution;
+}
+/**
+ * - "webview": the app shows the plugin's UI from the server in a WebView.
+ * - "native": the app has its own screens for this plugin.
+ * - "none": nothing to show in the app.
+ */
+export declare const MOBILE_MODES: readonly ["webview", "native", "none"];
+export type PluginMobileMode = (typeof MOBILE_MODES)[number];
+export declare const MOBILE_SIZES: readonly ["phone", "tablet"];
+export type PluginMobileSize = (typeof MOBILE_SIZES)[number];
+export interface PluginMobileContribution {
+    mode: PluginMobileMode;
+    /**
+     * webview: a bundle built for the app, in the same folder as the frontend
+     * bundle. Unset means the normal frontend runs in a phone sized frame.
+     */
+    entry?: string;
+    /** webview: screen sizes the UI works at. Defaults to both. */
+    sizes?: PluginMobileSize[];
+    /** webview: tab, panel or card ids the app offers. Defaults to every tab. */
+    views?: string[];
+    /** native: the app feature that stands in for it. Defaults to the plugin id. */
+    feature?: string;
+    /** i18n key in the plugin's namespace, or plain text, shown in the app. */
+    note?: string;
 }
 /** A field a protocol login carries besides username and password. */
 export interface PluginProtocolCredentialField {

package/dist/manifest.js

@@ -22,7 +22,7 @@ export { ENV_NAME_PATTERN, MAX_ENV_DESCRIPTION_LENGTH, pluginDocsPage, pluginDoc
  * "^1.2" needs 1.2 or later). engine.termix is checked against the core
  * version by the server.
  */
-export const PLUGIN_API_VERSION = "1.12.0";
+export const PLUGIN_API_VERSION = "1.13.0";
 /** The API major, the default engine.api for a new plugin. */
 export const SUPPORTED_PLUGIN_API_VERSION = String(semver.major(PLUGIN_API_VERSION));
 /** Whether this build's plugin API satisfies a manifest's engine.api. */
@@ -171,6 +171,13 @@ export const SETTINGS_FIELD_TYPES = [
 export const SETTINGS_SCOPES = ["admin", "user", "host"];
 /** A layout id or theme id: short, lowercase, used as a CSS class for themes. */
 export const LOOK_ID_PATTERN = /^[a-z][a-z0-9-]{1,39}$/;
+/**
+ * - "webview": the app shows the plugin's UI from the server in a WebView.
+ * - "native": the app has its own screens for this plugin.
+ * - "none": nothing to show in the app.
+ */
+export const MOBILE_MODES = ["webview", "native", "none"];
+export const MOBILE_SIZES = ["phone", "tablet"];
 /** Protocol ids core keeps for itself. */
 export const RESERVED_PROTOCOL_IDS = ["ssh"];
 /** Login keys a declared credential field may not reuse. */
@@ -254,6 +261,7 @@ const ALLOWED_CONTRIBUTES = new Set([
     "protocols",
     "layouts",
     "themes",
+    "mobile",
 ]);
 const ALLOWED_SETTINGS_FIELD = [
     "key",
@@ -387,8 +395,107 @@ export function validateManifest(manifest) {
     validateProvidesSecret(m.providesSecret, errors);
     validateRequiresSecret(m.requiresSecret, errors);
     validateContributes(m.contributes, typeof m.id === "string" ? m.id : undefined, errors);
+    if (isPlainObject(m.contributes)) {
+        validateMobile(m.contributes, typeof m.frontend === "string" ? m.frontend : DEFAULT_FRONTEND_ENTRY, errors);
+    }
     return errors;
 }
+function folderOf(file) {
+    const parts = file.split("/").filter((part) => part !== "" && part !== ".");
+    return parts.slice(0, -1).join("/");
+}
+function validateMobile(contributes, frontend, errors) {
+    const mobile = contributes.mobile;
+    if (mobile === undefined)
+        return;
+    const where = "contributes.mobile";
+    if (!isPlainObject(mobile)) {
+        errors.push(`Field "${where}" must be an object`);
+        return;
+    }
+    rejectUnknown(mobile, ["mode", "entry", "sizes", "views", "feature", "note"], `"${where}"`, errors);
+    const mode = mobile.mode;
+    if (!MOBILE_MODES.includes(mode)) {
+        errors.push(`${where}.mode must be one of: ${MOBILE_MODES.join(", ")}`);
+        return;
+    }
+    for (const key of ["entry", "sizes", "views"]) {
+        if (mobile[key] !== undefined && mode !== "webview") {
+            errors.push(`${where}.${key} is only for mode "webview"`);
+        }
+    }
+    if (mobile.feature !== undefined && mode !== "native") {
+        errors.push(`${where}.feature is only for mode "native"`);
+    }
+    if (mobile.entry !== undefined &&
+        requireString(mobile.entry, `${where}.entry`, errors)) {
+        const before = errors.length;
+        requireRelativePath(mobile.entry, `${where}.entry`, errors);
+        if (!mobile.entry.endsWith(".js")) {
+            errors.push(`${where}.entry must be a .js file`);
+        }
+        else if (errors.length === before &&
+            folderOf(mobile.entry) !== folderOf(frontend)) {
+            // Core only serves the folder the frontend bundle sits in.
+            errors.push(`${where}.entry must sit in the same folder as the frontend bundle (${frontend})`);
+        }
+    }
+    if (mobile.sizes !== undefined) {
+        const sizes = mobile.sizes;
+        if (!Array.isArray(sizes) || sizes.length === 0) {
+            errors.push(`${where}.sizes must be a non-empty array`);
+        }
+        else {
+            const seen = new Set();
+            for (const size of sizes) {
+                if (!MOBILE_SIZES.includes(size)) {
+                    errors.push(`${where}.sizes entries must be one of: ${MOBILE_SIZES.join(", ")}`);
+                }
+                else if (seen.has(size)) {
+                    errors.push(`${where}.sizes duplicates "${String(size)}"`);
+                }
+                seen.add(size);
+            }
+        }
+    }
+    if (mobile.views !== undefined) {
+        const views = mobile.views;
+        if (!Array.isArray(views) || views.length === 0) {
+            errors.push(`${where}.views must be a non-empty array`);
+        }
+        else {
+            const declared = new Set();
+            for (const field of ["tabs", "panels", "dashboardCards"]) {
+                const list = contributes[field];
+                if (!Array.isArray(list))
+                    continue;
+                for (const view of list) {
+                    if (isPlainObject(view) && typeof view.id === "string") {
+                        declared.add(view.id);
+                    }
+                }
+            }
+            const seen = new Set();
+            for (const view of views) {
+                if (typeof view !== "string" || !declared.has(view)) {
+                    errors.push(`${where}.views entries must be ids from contributes.tabs, panels or dashboardCards, got: ${JSON.stringify(view)}`);
+                }
+                else if (seen.has(view)) {
+                    errors.push(`${where}.views duplicates "${view}"`);
+                }
+                seen.add(view);
+            }
+        }
+    }
+    if (mobile.feature !== undefined &&
+        (typeof mobile.feature !== "string" ||
+            !LOOK_ID_PATTERN.test(mobile.feature))) {
+        errors.push(`${where}.feature must match ${LOOK_ID_PATTERN} (lowercase letters, digits, dashes)`);
+    }
+    if (mobile.note !== undefined) {
+        requireString(mobile.note, `${where}.note`, errors);
+    }
+}
 function validateFeatures(features, errors) {
     if (features === undefined)
         return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@termix-ssh/plugin-sdk",
-  "version": "1.0.21",
+  "version": "1.0.22",
   "description": "The contract between Termix core and a plugin: types, the capability catalog and the manifest schema.",
   "license": "Apache-2.0",
   "repository": {
@@ -102,6 +102,10 @@
     "./testing-host": {
       "default": "./dist/host/testing-host.js"
     },
+    "./frame-host": {
+      "default": "./dist/host/frame-host.js"
+    },
+    "./frame-host.css": "./dist/host/frame-host.css",
     "./theme.css": "./dist/host/theme.css"
   },
   "files": [

package/schema/manifest.schema.json

@@ -1239,6 +1239,48 @@
               }
             }
           }
+        },
+        "mobile": {
+          "type": "object",
+          "description": "How the plugin shows in the Termix mobile app. Needs plugin API 1.13 (Termix 26.10.6).",
+          "additionalProperties": false,
+          "required": ["mode"],
+          "properties": {
+            "mode": {
+              "type": "string",
+              "enum": ["webview", "native", "none"],
+              "description": "webview: the app shows the plugin's UI from the server. native: the app has its own screens. none: nothing to show in the app."
+            },
+            "entry": {
+              "type": "string",
+              "pattern": "\\.js$",
+              "description": "webview only. A bundle built for the app, in the same folder as the frontend bundle. Unset means the normal frontend runs in a phone sized frame."
+            },
+            "sizes": {
+              "type": "array",
+              "minItems": 1,
+              "uniqueItems": true,
+              "items": { "type": "string", "enum": ["phone", "tablet"] },
+              "description": "webview only. Screen sizes the UI works at. Defaults to both."
+            },
+            "views": {
+              "type": "array",
+              "minItems": 1,
+              "uniqueItems": true,
+              "items": { "type": "string", "minLength": 1 },
+              "description": "webview only. Tab, panel or card ids the app offers. Defaults to every tab."
+            },
+            "feature": {
+              "type": "string",
+              "pattern": "^[a-z][a-z0-9-]{1,39}$",
+              "description": "native only. The app feature that stands in for this plugin. Defaults to the plugin id."
+            },
+            "note": {
+              "type": "string",
+              "minLength": 1,
+              "description": "i18n key in the plugin's namespace, or plain text, shown in the app."
+            }
+          }
         }
       }
     },