@termix-ssh/plugin-sdk 1.0.21 → 1.0.23

package/dist/testing.js

@@ -146,6 +146,8 @@ export function createFakeContext(options = {}) {
     const createdSshKeys = [];
     const notifications = [];
     const notifyHub = { current: null };
+    const operationHandlers = new Map();
+    const operationEvents = [];
     const fetches = [];
     const processRuns = [];
     const binaries = [];
@@ -855,6 +857,47 @@ export function createFakeContext(options = {}) {
                 });
             },
         },
+        operations: {
+            register: (id, handler) => {
+                operationHandlers.set(id, handler);
+            },
+            run: async (actionId, options = {}) => {
+                const handler = operationHandlers.get(actionId);
+                if (!handler)
+                    throw new Error(`No action "${actionId}"`);
+                const result = await handler.run(options.input ?? {}, {
+                    hostId: options.hostId,
+                    resourceKey: options.resourceKey,
+                    runId: null,
+                    dryRun: options.dryRun === true,
+                    signal: new AbortController().signal,
+                    log: () => { },
+                });
+                return { runId: null, status: "success", ...result };
+            },
+            invoke: async (actionId, options = {}) => {
+                const handler = operationHandlers.get(actionId);
+                if (!handler)
+                    throw new Error(`No action "${actionId}"`);
+                const result = await handler.run(options.input ?? {}, {
+                    hostId: options.hostId,
+                    resourceKey: options.resourceKey,
+                    runId: null,
+                    dryRun: options.dryRun === true,
+                    signal: new AbortController().signal,
+                    log: () => { },
+                });
+                return { runId: null, status: "success", ...result };
+            },
+            list: async () => ({
+                actions: manifest.contributes?.operations?.actions ?? [],
+            }),
+            emit: async (eventId, payload, options) => {
+                operationEvents.push({ eventId, payload, hostId: options?.hostId });
+            },
+            onEvent: () => () => { },
+            approvals: { provide: () => () => { } },
+        },
         notify: {
             channels: async () => {
                 if (!actor)
@@ -1016,6 +1059,8 @@ export function createFakeContext(options = {}) {
         createdSshKeys,
         notifications,
         notifyHub,
+        operationHandlers,
+        operationEvents,
         fetches,
         processRuns,
         binaries,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@termix-ssh/plugin-sdk",
-  "version": "1.0.21",
+  "version": "1.0.23",
   "description": "The contract between Termix core and a plugin: types, the capability catalog and the manifest schema.",
   "license": "Apache-2.0",
   "repository": {
@@ -61,6 +61,10 @@
       "types": "./dist/openapi.d.ts",
       "default": "./dist/openapi.js"
     },
+    "./operations": {
+      "types": "./dist/operations.d.ts",
+      "default": "./dist/operations.js"
+    },
     "./settings": {
       "types": "./dist/settings.d.ts",
       "default": "./dist/settings.js"
@@ -102,6 +106,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

@@ -536,6 +536,31 @@
             }
           }
         },
+        "hostSections": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["id", "titleKey"],
+            "properties": {
+              "id": { "type": "string", "minLength": 1 },
+              "titleKey": { "type": "string", "minLength": 1 },
+              "icon": { "type": "string", "minLength": 1 }
+            }
+          }
+        },
+        "operations": {
+          "type": "object",
+          "description": "What this plugin can do. Every surface finds these on its own. See the operations section of PLUGIN-GUIDE.md.",
+          "additionalProperties": false,
+          "properties": {
+            "actions": { "type": "array", "items": { "type": "object" } },
+            "events": { "type": "array", "items": { "type": "object" } },
+            "resources": { "type": "array", "items": { "type": "object" } },
+            "signals": { "type": "array", "items": { "type": "object" } },
+            "invokes": { "type": "array", "items": { "type": "string" } }
+          }
+        },
         "dashboardCards": {
           "type": "array",
           "items": {
@@ -1239,6 +1264,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."
+            }
+          }
         }
       }
     },