SDK changelog
Changes to @termix-ssh/plugin-sdk. A release that bumps the plugin API says so at the top.
2.11.0
Plugin API 2.9.0. Needs Termix 26.11.2.
Added
ctx.diagnostics.provide({ title, collect })adds a section about the plugin's own state to the diagnostics report admins make. Core masks it and caps it at 64 KB. Termix 26.11.3app.openDiagnostics({ pluginId })opens the diagnostics report page with this plugin first. In a frame it needs a click. Termix 26.11.3ctx.hosts.connectPolicy.disconnect(hostId, { reason })ends every connection core holds open to a host, andprovide({ check, probes: true })also gates status checks. Termix 26.11.3app.deepLinks.onOpen(listener): termix:// links the desktop app was opened with, replayed for a listener that starts late. Termix 26.11.3ctx.credentials.resolveLogin(credentialId): a saved credential's username and password, for a login the plugin makes itself, like a Quick Connect session. Only the user's own or shared credentials. Needscredentials:read.QuickConnectLogin.credentialIdcarries one from the browser without its secret, andviewOnlyasks for a session without input. Termix 26.11.3useConfirmtakes acheckbox(label,checked,onChange, and text used while it is ticked), like Delete permanently. Termix 26.11.3 draws it, older versions ignore it- Data badges and text can carry an
icon, acolorand, for badges, avariant(outline,filledoricon). Termix 26.11.3 draws them, older versions ignore them - Login methods can offer
logoutRedirect(session): where to send the browser when a user signs out of a session the method made, like the identity provider's sign out page. Termix 26.11.3 uses it, older versions ignore it ctx.credentials.registerSecretResolver(scheme, resolve, { unlockTab }): whenresolvethrows an error with codeunlock-requiredfor the person connecting, the connect answers access required with that tab, so clients offer Verify instead of failing. Termix 26.11.3registerAction(id, handler, { private: true }): only your own plugin views may run the action, even when another plugin lists it inuses. Termix 26.11.3 enforces it, older versions ignore itapp.registerHostTreeChildren({ id, when, useChildren })lists containers, guests and the like under a host in layouts that draw a host tree, andHostTreeChildrenfrom theuientry reads them. Works from a frame. Termix 26.11.3
2.10.1
Plugin API 2.9.0. Needs Termix 26.11.2.
Fixed
termix-plugin buildno longer writes the build folder into the bundle for?urlimports, so the same plugin builds to the same file in any folder
2.10.0
Plugin API 2.9.0. Needs Termix 26.11.2.
Added
useShellScroll(on)in/frontend: Termix scrolls a framed tab instead of the page's own scroll box, so parts from other plugins on it move with the pagePanelToolbarin/ui: a sidebar panel's search, icon buttons and icon only add button on one rowregisterHostEditorSection({ simple: true })shows a section in the simple host editor, and sections get anadvancedprop so they can keep rarer fields for advanceddeclareActionSlot({ fit: "bar" }): a framed button in the slot is as wide as its content and as tall as the bar, for buttons that fill a tab bartermix-plugin validatewarns when a panel stacks a full widthPanelSearchover a labelledAddButton, and points toPanelToolbar
Fixed
scriptShellruns its command undersh -c, so host scripts work when the login shell is fish or csh
2.9.0
Plugin API 2.9.0. Needs Termix 26.11.2.
Added
-
ctx.usersaccount calls for provisioning plugins:get,findByUsername,findByEmailandlistRoleswithusers:read, andcreate,update,setDisabled,delete,syncRolesandsetAdminwithusers:write. Accounts a plugin makes have no password, and their first SSO or LDAP sign in with the same verified email is linked to them. Optional in the types, so checktypeof ctx.users.create === "function"first -
ctx.http.router({ publicAuthorization: true })passes the Authorization header to the declared public routes, for protocols with their own bearer token like SCIM. Termix API keys and session tokens are never passed -
createMockCtxtakesaccountsandrolesforctx.users, and records changes inaccounts -
/uicalls for account management:disableUser,enableUser,updateMyProfile,adminUpdateUserProfile,getAdminHostBypass,updateAdminHostBypass,getExternalSignupApproval,updateExternalSignupApproval -
/uicalls for invite links:listUserInvites,createUserInvite,revokeUserInvite,checkUserInvite,acceptUserInvite,inviteLink -
/uicalls for the access review:getAccessReview,downloadAccessReviewCsv -
getUserListtakes astatusfilter, andUserInfocarries the display name, email, account state and last sign in -
AdminSectionincludesaccess
2.8.1
Plugin API 2.8.0. Needs Termix 26.11.2.
Fixed
net-guardalso refuses private IPv4 addresses written in IPv4-compatible (::10.0.0.1) or NAT64 (64:ff9b::10.0.0.1) form
2.8.0
Plugin API 2.8.0. Needs Termix 26.11.2.
Added
ctx.desktop.local.fs.openInEditor(path)opens a local file in the external editor the person picked in the desktop app, or with its default app. The app starts the editor, so the plugin needs no process grantctx.schedule.keepAwake(reason, awake)tells Termix the plugin has work that needs its process running. A plugin that calls it lets Termix stop the process when there is none, and its jobs shorter than the idle time then run only while it runs. Optional in the types, so call it asctx.schedule.keepAwake?.(...)createMockCtxrecords those reasons inawakectx.desktop.grantView({ url, ignoreCert })lets the plugin's frames show one page:NativeViewfrom/uitakes thegrantand Termix draws a native view on the desktop or a credentialless sandboxed iframe in a browser. Needsdesktop:window.createMockCtxrecords them inviewGrantsapp.serial: Web Serial through Termix for a plugin withdevice:serial. The browser's picker opens from a click and the plugin gets only the port the person picked- Login methods can describe themselves for the sign in screen:
fieldsfor form methods,kind: "webauthn"withoptionsfor passkeys,placementand per instanceviews. Second factors take aprompt(code,fieldsorwebauthn) ctx.auth.registerWebAuthnCeremonyandapp.auth.webauthn(id, extra)run WebAuthn steps from a plugin's own screens, such as adding a passkey. Termix runs the browser prompt and the plugin's server checks the answer.createMockCtxrecords them inauth.webAuthnCeremoniesapp.session.signOut()andapp.session.reload()for login policy plugins (auth:policy)
Changed
- On the desktop app, plugin processes run on the app's pinned Node with the same flags as on a server, inside an OS sandbox. Desktop only code that used
fsorchild_processfreely must move toctx.desktop.local registerLoginMethodandregisterSecondFactorUIin a frame take onlyenrollment; the sign in steps are drawn from what the backend describes.componentis optional and only works for plugins in the pageNativeViewno longer takesignoreCert. Only a grant from the plugin's server can trust a bad certificatetermix-plugin validaterefuses theme CSS that loads anything from outside the plugin, throughurl(),image-set(),src(), root paths or CSS escapes- A plugin process now stops when idle unless it provides something on core's own request paths (logins, connects, sync, host status and locks, alerts, approvals, TLS, looks) or runs a job more often than the idle time. Operations, services, registry values, event listeners, settings hooks and jobs it registered stay with core and start the process again when called
Fixed
- The sandbox mock of
createMockCtxletsctx.auth.completeRedirectLoginkeep the live request, and hands login hooks a plain copy of the request, as a plugin process does
2.7.1
Plugin API 2.7.0. Needs Termix 26.11.2.
Fixed
renderSlotinrenderWithAppdraws a component part once, not twice, in a slot that is not a data slot
2.7.0
Plugin API 2.7.0. Needs Termix 26.11.2.
Added
- Inside a frame,
useSlotContributions,useExtensions,getExtensionandusePluginComponentnow return other plugins' parts. Their components draw as placeholders and Termix draws the real view over each one, soComponentSlot,ActionSlotandPluginComponentwork in frames too ForeignSlotin/uidraws such a part with your own class, style andinteractiveflag;ForeignInteractiveturns clicks off for every part inside it (an edit mode)useForeignOccluderandForeignOccluderin/uihide other plugins' parts under a menu or popover you draw yourself. Popover, DropdownMenu, Select, Sheet, Dialog, AlertDialog, Tooltip, InlineView and PanePrompt do it alreadydeclareActionSlottakesfit: "overlay": the part covers the box, is see-through and only takes clicks while it draws something- A frame may place the parts of a slot it declared, an extension point or component id under its own plugin id, or any id in its manifest
contributes.uses useShell()answers inside a frame with a read only view: tabs, the active tab, splits, the user and whether it is mobile.tabs.setActiveworks right after the person used the framerenderWithApptakesotherswith other plugins' slot parts, extension items and components for a plugin that draws them
2.6.0
Plugin API 2.6.0. Needs Termix 26.11.2.
Added
ctx.operations.runs.cancel({ runId })andctx.operations.runs.undo({ runId, confirmed })cancel or undo a run from inside one of the plugin's own requests, as the person on that request. Needsoperations:invokeapp.stepUp()asks the person to prove a second factor in a prompt the shell owns and answers true or false; a plugin never sees the code. In a frame it works only right after the person used the framecreateMockCtxanswersctx.operations.runsand recordsrunCalls- Data slots:
registerSlotContributiontakeskind: "data"with auseValue(context, rowKey)hook that returns plain values (bars,stat,badge,dot,text). The shell draws them, and in a frame the hook runs in the background frame, so a row costs no iframe useValueonregisterHostBadge,registerHostStatusIndicatorandregisterHostEditorToolbarItem, which now work from a frame. Theircomponentis optional and in-page onlydeclareActionSlottakesshapesandrowsfor data slotsDATA_SLOTSin/manifestlists the data slots in TermixDataSlot,DataValues,HostDataItemsandparseDataValuein/uifor slot owners and layoutsrenderWithAppresults havereadDataValuesandrenderHostItems, andrenderSlotdraws data valuestermix-plugin validatewarns about a component in a data slot or per row slot, and about host badges, status indicators and toolbar items with a component
2.5.0
Plugin API 2.5.0. Needs Termix 26.11.2.
Added
ctx.operations.approvals.decide({ approvalId, approve, comment })approves or rejects a waiting action from inside one of the plugin's own requests, as the person on that request. Needsoperations:approvecheckFrameViewsin/testingrenders every view a plugin registers and lists the core requests a plugin frame would be refuseddeclareActionSlottakesfit(inline,contentorfill): how a framed plugin's component sizes itself in the slotcreateMockCtxanswersctx.operations.approvals.decide
2.4.0
Plugin API 2.4.0. Needs Termix 26.11.2.
Added
PluginHostLockProvider.lockedHosts()lists every host a provider locks. A plugin process needs it to provide host locksctx.hosts.status.provide,ctx.sync.provideandctx.sync.hostwork in a plugin processctx.sync.host.desktop.connectionOrigin()reads the desktop wide default for where connections startctx.files.readEnvFile(name)reads the file an admin named in a manifestenvvariable marked"file": true, such as a mounted config file. A plugin process can't read it itself- Manifest
enventries take"file": true - Capability
config:secretsandctx.files.readSecret({ env } | { file })read a secret a config file points at, such as a Docker secret. Never Termix's own variables, key files or data folder createMockCtx({ envFiles, configSecrets })answersctx.files.readEnvFileandreadSecret
Changed
- In a plugin process,
ctx.sync.host.replica.orderSelfReferences, an entity'scovers,http.normalizeServerUrl,plugins.lastRemoteandplugins.localNamesreturn Promises createMockCtx({ sandbox: true })takes host locks withlockedHosts, a host status provider and a sync provider
2.3.0
Plugin API 2.3.0. Needs Termix 26.11.2.
Added
ctx.ssh.prepare,ctx.ssh.openTransportandctx.ssh.jumpChainwork in a plugin process. Your own ssh2 client runs over a stream Termix opens, and Termix keeps the host key checkforwardOut,forwardIn,unforwardInand thetcp connectionevent on clients fromctx.ssh.connect,withConnectionandjumpChainin a plugin process. AforwardOutchannel or any other stream works assockforctx.ssh.connectctx.desktop.localworks in a plugin process, with streams forfs.openRead,fs.openDownload,pluginFetchandpty.spawn- Manifest
sandbox.workerslets a plugin process start worker threads. Each worker keeps the process's limits, and workers from code strings are refused validatewarns whenpackage.jsonbuilds workers but the manifest has nosandbox.workersctx.network.lookup(name, { family })looks up a host name on the Termix server and answers the first address or null. Needsnetwork:probe. A plugin process can't look names up itself withoutnetwork:socketscreateMockCtx({ resolve })answersctx.network.lookup
Changed
- Login methods, keyboard-interactive handlers and
ctx.auth.completeRedirectLoginwork in a plugin process. A login method gets a plain copy of the request, andrequest.res.cookie/clearCookieonly set cookies namedtmxp_<id>_* - An SSH auth provider's
onBannerandonKeyboardInteractive, a keyboard-interactive handler'sdetectandautoAnswerPasswords, andonBannerfromctx.ssh.preparemay return a Promise. Await them. An answer that takes over 5 seconds counts as none - An SSH auth provider in a plugin process may also set the socket
timeout - A sync entity's
shouldSyncmay return a Promise. Termix waits for it, so one from a plugin process works - A plugin process gets
VERSION,TERMIX_DEPLOYMENT(desktop,dockerorserver) andTERMIX_SANDBOX_PLUGIN(its id) from Termix, andvalidateno longer warns about reading them createMockCtx({ sandbox: true })takesssh.preparewith your own client and socket, asockforssh.connect,ssh.openTransport,ssh.jumpChainanddesktop.local, and itsssh.prepareconfig names the hostctx.asUserin a plugin process gives back exactly what its callback returned or threw, so a live object such as an SSH connection and your own error classes workPluginAuthPolicyProvider.allowRememberDevicemay return a PromisecreateMockCtx({ sandbox: true })takes login methods, keyboard-interactive handlers,completeRedirectLoginand async banner hooks, and refuses a login method cookie outsidetmxp_<id>_*
Fixed
createMockCtx({ sandbox: true })no longer refuses anAbortSignalinctx.fetchor Drizzle queries inctx.db.batch; a plugin process takes both- The test setup no longer fails a test now and then with "server closed before listening" when a test server first lands on a port fetch refuses
2.2.1
Plugin API 2.2.0. Needs Termix 26.11.2.
Added
applyCertificateAuthworks in a plugin process: it puts the certificate on the config and Termix applies it to the real client.isSandboxSshClientandSANDBOX_CERTIFICATE_FIELDin/ssh-certs
Changed
- An SSH auth provider's
onAuthFailedandconnectOptions, andonAuthFailedfromctx.ssh.prepare, may return a Promise. Await them createMockCtx({ sandbox: true })lets aprocess.runhandle'sexitedPromise through, readsctx.http.baseUrl(req)without checking the request, and refusesonBannerandonKeyboardInteractiveon an SSH auth provider, the way a plugin process does
2.2.0
Plugin API 2.2.0. Needs Termix 26.11.2.
Added
ctx.audit.chain(audit:read):status(),verify()andcheckHead(head)for the audit log's hash chain- Stored and subscribed audit lines carry
hashandprevHash /ui:getMyApiKeys,revokeMyApiKey,revokeAllMyApiKeys,revokeEveryoneSessions,getAdminHoldSettings,setAdminHoldMinutes,getAdminHolds,cancelAdminHoldandisAdminHoldTicketcreateMockCtxtakesauditChainfor whatctx.audit.chainanswers
Changed
/uicreateApiKey: leaveexpiresAtout for the server's 90 days or pass null for never, and leavescopesout for read only or pass["full"]
2.1.0
Plugin API 2.1.0. A plugin API 2 frontend now runs in sandboxed frames. See "Frames" in PLUGIN-GUIDE.md.
Added
app.framesays whether the frontend runs in a frame and which one: the background frame or a viewcheckFrameAppin/testingruns activate the way a frame does and lists what the shell would not get
2.0.0
Plugin API 2.0.0. Every plugin backend now runs in its own process. See "The plugin process" and "Moving from API 1" in PLUGIN-GUIDE.md.
Added
- Manifest
sandboxblock:schedules,events,registry,memoryMbandalwaysOn ctx.db.batch()runs writes in one transactionctx.schedule.everytakes anid- Capability
network:socketsfor plugins that open their own listeners and connections CAPABILITY_PROCESS_GRANTS,modulesGrantedBy,SANDBOX_GATED_MODULESandSANDBOX_BLOCKED_MODULESin/capabilitiesisLegacyPluginApiandLEGACY_PLUGIN_API_VERSIONin/manifestcreateMockCtx({ sandbox: true })applies the rules of a plugin process in tests, withsandboxContext,SandboxRuleErrorandassertCrossabletermix-plugin validatewarns about Node modules a plugin process can't use
Changed
services.get,services.providers,registry.consume,registry.revoke,secrets.withdraw,hosts.sessionActive,ssh.poolKey,ssh.classifyKeyboardInteractive,ssh.requiresSecret,ssh.supportsBackground,auth.listSecondFactors,desktop.availableanddesktop.local.availablereturn Promisesctx.events.onandctx.registry.provideneed the topic or key listed in the manifestsandboxblock- The fake ctx answers those reads with Promises too
1.1.6
Plugin API 1.17.0.
Fixed
execElevatedsends the sudo password on stdin instead of putting it in the command.buildSudoCommandno longer takes the password: sendsudoStdin(password)as the command's stdinexecCommandtakes an optionalstdin
1.1.5
Plugin API 1.17.0.
Added
@termix-ssh/plugin-sdk/net-guardwithresolveTarget,pinnedLookupandisPrivateAddress, so sockets a plugin opens itself get the same private address check asctx.fetch/uiexportsgetHostKeyPolicyandupdateHostKeyPolicy, the admin switch that lets connections with nobody to ask trust a host's first key
1.1.4
Plugin API 1.17.0.
Added
contributes.settings.host.enablePermissionlimits who may change a plugin's host switch
1.1.3
Plugin API 1.16.0.
Fixed
generateSshKeyPairno longer hands out an unreadable key. ssh2 broke about 1 in 256 ed25519 keys
1.1.2
Plugin API 1.16.0.
Added
- Sync entities take
matchOn, columns that identify a row besides its syncId, so a row made on both sides (one per host) is merged instead of failing PluginHostRecordhashasPasswordandhasSudoPassword, so a plugin knows a saved password exists without seeing itctx.credentials.setSshKeyCertificatestores an OpenSSH certificate on one of the acting user's SSH key credentials, or clears it withnull/uiexportsToolbarBand(a toolbar row outside the PanelShell toolbar),ToolbarSelect(a small select for those rows) andTOOLBAR_FIT(the classes that make every control in a row 32px)PANEL.section, the one inner layout for a SectionCard bodyTextAreaFieldtakesfill, so a config or log editor uses the rest of the heightregisterHostBadgetakesuseDot. Every plugin's dots merge into one dot on the host row, with the worst tone and each reason in its tooltip./uiexportsHostDotGroupfor layouts that draw host rows/uiexportsgetCredentialStorageandupdateCredentialStorage, andHostPolicyhascredentialStorageLoginMethodUIPropshasview, the login page a method is drawn onctx.auth.identitieslists, links and unlinks a user's external identities- Connect policy input has
stepUpAt, and arequestdecision can setrequestKind: "verify" /uiexportslistStepUpFactors,challengeStepUp,verifyStepUpanduseSecondFactors, to ask a signed in user for a second factor/uiexportsgetHostDeviceAuth,setHostDeviceAuth,getFolderDeviceAuthandsetFolderDeviceAuthfor logins kept on a desktop
Changed
- Controls in the PanelShell toolbar, tab band and footer are all 32px, so small buttons line up with search boxes and selects
SegmentedandViewTogglematch the height of inputs and buttons, andSegmentedkeeps its natural widthFormFooterbuttons are full heightPANEL.bodyisp-3, the same paddingInlineViewgives a form- A body with a pinned footer no longer draws a closing line just above the footer's own line
- The placeholder for a plugin view that is still starting uses
LoadingState termix-plugin validatewarns about UI drift: raw loading spinners, small back buttons, native selects, stretched filters, filled headers, capped log views and footers that scroll away- A
ToolbarBandright inside aTileStackleaves the line under it to the stack ListBadgeandStatusBadgekeep their own width in a table cell instead of filling it
Fixed
parseCpuLineno longer counts guest and guest_nice twice, so CPU percent on hosts running VMs is no longer too high
1.1.1
Plugin API 1.15.0.
Added
ctx.hosts.connectPolicy.provideand thehosts:connect-policycapability, so a plugin can allow, deny or ask for an access request before an SSH or remote desktop session opens- SSH prepare outcomes can carry the error codes
access-deniedandaccess-requiredwith arequestTab
1.1.0
Plugin API 1.15.0.
Added
/uiexportsTileGrid,TileFrameandTilePicker, the 12 column tile grid the dashboard, the host page and Host Metrics share, plusappendTile,flowTiles,removeTile,sanitizeTilesand theTileSlottyperegisterDashboardCardtakesentries, so one card can be placed many times with its ownconfig, anddefaultSizefor the grid- Dashboard cards get
config,setConfigandeditMode /uiexportsTileWall(a fixed grid of tiles with shared lines),TileStackandTileColumn(sections stacked with a line between),TileEditBar, andSeamlessTileContextwithuseInSeamlessTile/uiexportsStatTile,InfoGrid,StatusDot,StatusBadgeandstatusTone,LoadingState,NoticePanel,PagerwithusePagedandpageOf,DataTablewithDataTableRow,SideNavwithSideNavItem,PanelFrameandRefreshButtonInlineViewtakesstacked, which lays SectionCards out in one column with lines between themGroupHeadingtakesplain, which drops the rule after the title. Inside a tile layout that is the default
Changed
Card,SectionCard,MetricCardandDataViewuse the tile look: no fill, and inside a tile layout no box either.DataViewgrids sit edge to edge with shared lines
1.0.25
Plugin API 1.14.0.
Added
- Host click behavior
hostPageopens a host page when a plugin offers one createApiKeytakes scopes, to limit a key to actions
1.0.24
Plugin API 1.14.0.
Added
app.registerHostSectionadds a card to the host page/uiexportsHostTabEmbed, which draws any tab type inside another view, the host section registry, andoperationsApifor core's/operationsroutes
1.0.23
Plugin API 1.14.0.
Added
contributes.operationsdeclares a plugin's actions, events, resources and signals, so Automations, Fleets, the assistant, the CLI, the phone app and the command palette can find them with no wiringctx.operationsregisters handlers, runs other plugins' declared actions, emits events and provides approval rules, with the newoperations:provide,operations:invokeandoperations:approvecapabilities@termix-ssh/plugin-sdk/operationshas the types, input checks, redaction and JSON Schema for declared actionscontributes.hostSectionsdeclares cards for the host page
1.0.22
Plugin API 1.13.0.
Added
contributes.mobilein the manifest says how a plugin shows in the Termix mobile app:webview,nativeornone, with an optional mobile bundle, screen sizes, views and a notetermix-plugin buildbundlessrc/mobileinto thecontributes.mobile.entryfile, andvalidatechecks that it exists@termix-ssh/plugin-sdk/frame-hostruns one plugin view outside the shell, with core's bridge, registries and CSS, so the mobile app can showwebviewplugins- SSH transport providers get the host's owner, sync id, connection origin and local only flag in
claimsandopen, and core's SSH relay takes asyncIdinstead of a host id ctx.sync.host.entities.idsOfmaps sync ids to the local ids of the user's own rows of one type- Rail items take
useStatusfor a small ok, warning or error dot on the icon shell.editHost(hostId)opens the editor of a saved host- A sync entity can be read only with
load,writeanderase, so a plugin can sync rows a user does not own, like a shared library, down to linked desktops getFolderAuthOverrideandsetFolderAuthOverridein@termix-ssh/plugin-sdk/uiread and set a user's own login for the shared hosts in a folder
Fixed
@termix-ssh/plugin-sdk/uiis built in production mode, so outside Termix it no longer sends requests to the Vite dev server pathexecCommandbuffers output and decodes it once as strict UTF-8 with a GBK fallback, exposed asdecodeCommandOutput, so messages from a Windows host on a legacy codepage are readable instead of � characters
1.0.21
Plugin API 1.12.0.
Added
@termix-ssh/plugin-sdk/host-scripts: Docker, Linux metrics, systemd, journal and OpenRC command builders and parsers, plusscriptShell()andpasswordSudoScript()to send scripts tobash -son stdin. It has no Node or ssh2 imports, so the Termix mobile app runs the same code
1.0.20
Plugin API 1.12.0.
Added
columnsandonColumnsonViewToggleshow a cards per row picker: Auto fits as many as the pane has room for, or pick 1 to 6sizeandminCardWidthonDataView, so a card grid follows that pick, and theGridSizetypeusePluginPanelViewalso keepscolumns, the cards per row pick, withsetColumns
1.0.19
Plugin API 1.11.0.
Added
app.registerCompanionLayoutanduseCompanions, so a plugin can let each host turn the panel bar on or off, move it and choose which panels show and in what order
1.0.18
Plugin API 1.10.0.
Added
clientCerton the sync link, link patch and remote target, and theclient_certremote error kind, so a sync plugin can link to a server that needs mutual TLS
1.0.17
Plugin API 1.9.0.
Added
app.registerCompanionandapp.toggleCompanion, so a plugin can add a panel beside any host tab. The user opens, resizes and moves it, and the tab keeps runningNativeViewin@termix-ssh/plugin-sdk/ui, which shows a web page in a native view in the desktop app, for sites that do not work in an iframe
1.0.16
Plugin API 1.8.0.
Added
ctx.sync.provideand thesync:providecapability, so a plugin can answer every /sync requestctx.ssh.transports.provideand thessh:transportcapability, so a plugin can carry SSH connections over its own streamctx.hosts.folders.ensureandremoveEmpty
Removed
- The sync screens and calls in
@termix-ssh/plugin-sdk/ui:LinkServerDialog,ProxySettingsFields,useSyncStatus,refreshSyncStatus,setSyncStatus,getSyncConflicts,getSyncErrors,retrySyncErrors,settleSyncConflict,syncNow,unlinkServer,updateSyncSettingsand their types. They moved into the sync plugin
1.0.15
Plugin API 1.7.0.
Added
ctx.auth.policy.provideand theauth:policycapability, so a plugin can set an idle timeout, cap session length, turn off remember me and require a second factorctx.auth.listSecondFactorslists the second factors from every running pluginAuthEnrollmentSectionstakesfactorsOnlygetHttpsSettingsandupdateHttpsSettingsin@termix-ssh/plugin-sdk/ui
Fixed
- Plugin frontend tests against a locally linked SDK failed with a second copy of React
1.0.14
Plugin API 1.6.0.
Added
ctx.hosts.locks.provideand thehosts:lockcapability, so a plugin can manage hosts that stay read only for everyone else and block adding hosts by handctx.hosts.setSharesto replace every grant on a host in one callctx.credentials.listreturns the acting user's credentials by name, without secretsctx.hosts.createandupdatetakepassword,key,keyPassword,keyType,sudoPassword,protocolAuthandpluginEnable
1.0.13
Plugin API 1.5.0.
Added
runtime: "desktop"in the manifest for a plugin that only loads on the desktop appdesktop:localandctx.desktop.local: file system, local shell and machine info on the desktop app's own backendctx.audit.subscribe,ctx.audit.listandctx.audit.exportBatchesunderaudit:readctx.hosts.importMany,importSshConfig,exportManyandregisterImportNormalizer, with thehosts:exportcapabilityctx.credentials.publicKeyandresolveKeyRefs,ctx.ssh.exec, and@termix-ssh/plugin-sdk/ssh-keysctx.hosts.status.provideandctx.hosts.activity.provideso a plugin can own host status and recent activity, withctx.network.tcpProbe,ctx.ssh.probe,ctx.hosts.probeTargetsandctx.hosts.sessionActiveregisterHostStatusIndicatorandregisterHostEditorToolbarItem, andorderfor host badges- Onboarding steps can sit in a
startsection, take apositionandreplacesa core step - A plugin can provide the app name, tagline and logo through the
<id>.brandingProviderregistry key
1.0.12
Plugin API 1.4.0.
Added
contributes.layoutsandapp.registerLayout()for a whole-app layout, with theui:layoutcapability. Needsengine.api1.4contributes.themesfor CSS-only themes, with theui:themecapability.termix-plugin validatechecks theme CSS andpackships ituseShell()gives a layout the live shell: tabs, splits, hosts, docks, the command palette and the registries. The shell's home tab is left out until some plugin registers adashboardtab typeTabStageandShellConfirmCapturein@termix-ssh/plugin-sdk/ui, for a layout to place tabsvalidateThemeCss()in@termix-ssh/plugin-sdk/manifest@termix-ssh/plugin-sdk/uialso exports what a whole layout is built from: the API client, shared types, hooks,useShellController()andAPP_VERSION. These reach into core, so they can change with a core release@termix-ssh/plugin-sdk/testing-hostexports the registries and permission seam a layout's own tests fill directly- A plugin that only holds themes needs no source:
termix-plugin buildwrites an empty backend andvalidatedoes not ask for a frontend termix-plugin validateflagsui:layoutorui:themewith nothing contributed, and a layout plugin with no frontend
Fixed
- The manifest JSON schema lists the
notify:hubandplugins:readcapabilities - Plugin tests and type checks work with the SDK linked from a local Termix checkout
1.0.11
Plugin API 1.3.0.
Added
ctx.auth.issueUserToken()mints a short-lived session for a user, for calling Termix's own API as them from background work. Needsusers:impersonateandengine.api1.3ctx.users.getLocale()reads a user's UI language. Needsusers:readandengine.api1.3
1.0.10
Changed
termix-plugin packincludes the plugin'sLICENSEandNOTICEfiles, so third-party notices ship with it
1.0.9
Added
- Worker entries in
package.jsontermix.workers, each bundled on its own intodist/workers/<name>.js - A
.wasm,.ttfor.otfimport gives the file's bytes, intermix-plugin buildand in plugin tests
Fixed
- The plugin guide listed jszip, guacamole-lite and @anthropic-ai/sdk as shared packages, but they are bundled
1.0.8
Added
publicRateLimitonctx.http.router(), for a plugin whose public routes serve a proxied page
1.0.7
Fixed
- A migration file, or a part of one, holding only comments made core fail to start the plugin
1.0.6
Added
PLUGIN-GUIDE.md, a guide to building, testing and releasing a plugin, written so AI coding tools can read it too
1.0.5
Fixed
execCommandtimeout errors no longer include the command, which could hold a sudo passwordtermix-plugin validatefails when a plugin ships migrations for some database engines but not all threetermix-plugin migrationsloads the table definitions from a path with a#or other URL characters in it- Text, json and encrypted columns are
longtexton MySQL in new migrations, so they are no longer capped at 64KB. Existing migrations keeptext i18next,react-dom,react-i18nextandsonnerare optional peer dependencies, so npm stops installing them into backend-only pluginstermix-plugin validateaccepts a beta version like1.1.0-beta.1when the changelog's newest release is1.1.0or older, so beta releases pass
1.0.4
Fixed
termix-plugin buildputs a plugin's own Tailwind classes in core's utilities layer, so responsive, hover and group variants andclassNameoverrides on SDK components work. Plain classes core already ships stay below core's utilities as before, while variants core ships go with the plugin's own somax-h-56 md:max-h-nonekeeps its order. Rebuild a plugin to pick it up
1.0.3
Plugin API 1.2.0.
Added
docsmanifest field: an https link to the plugin's docs. Termix shows it as a Documentation link on the plugin's page and in its settingsenvmanifest field: the environment variables the plugin reads, listed in its docs and on its pageapp.docsanduseDocsUrl()for links into the plugin's own docs, andDocsLinkin@termix-ssh/plugin-sdk/uiPanelShelltakes adocslink and shows it as a book icon in the header@termix-ssh/plugin-sdk/openapiwithbuildOpenApi(), andtermix-plugin openapi, which writesdist/openapi.jsonfrom the@openapiblocks insrc/backend.buildruns it too@termix-ssh/plugin-sdk/docswithpluginDocsUrl(),pluginDocsPage()andpluginEnvVars()termix-plugin validatewarns whendocs/index.mdis missing or the source reads an env var the manifest does not list
1.0.2
Added
featuresmanifest field: up to 20 short lines about what the plugin does, shown on its page.pluginFeatures()reads them
Changed
parseChangelog()andvalidateChangelog()flag a## Unreleasedsection. Notes go under the version they ship in
Removed
Changelog.unreleased
1.0.1
Added
- Plugin API 1.1
app.registerOnboardingStep()adds a step to onboarding, withOnboardingStepPropsandOnboardingStepContribution. Needsengine.api1.1videomanifest field: a YouTube link shown at the top of the plugin's page, read withyoutubeVideoId()@termix-ssh/plugin-sdk/changelogparses and checks a plugin'sCHANGELOG.mdtermix-plugin changelogprints one version's notes fromCHANGELOG.mdtermix-plugin devinstalls a plugin on a running server and reinstalls it on every change. Needs developer mode and an admin API keyrenderOnboardingStep()andregistered.onboardingSteps()inrenderWithApp()AddButton,FormFooter,ListRow,ListRowAction,ListRowFolder,ListBadgeandPanelListin@termix-ssh/plugin-sdk/uiPanelSearchtakesdisabled,title,onEnterandinputRef, andSurfaceScopetakesonClose
Changed
- Release notes moved from
CHANGELOG.jsontoCHANGELOG.md, whichpacknow ships.validateflags a leftoverCHANGELOG.json ConnectionScreendroppederrorMessageandretryLabeland gainedonClose.ConnectionLogPaneldroppedposition- Plugin tests run in worker threads, since forked workers crash now and then on Windows
- The test setup stubs
ResizeObserverfor Radix controls under jsdom onboardingis a reserved plugin id
Deprecated
- The
onboarding.*action slots. UseregisterOnboardingStep()
Removed
schema/changelog.schema.json
1.0.0
Added
- Backend, frontend, database, manifest, capability and settings types for plugin API 1.0
- Testing helpers and a Vitest preset for plugin tests
- The
@termix-ssh/plugin-sdk/uicomponent set - The
termix-pluginCLI to build, validate, test, pack, sign and write migrations