@termix-ssh/plugin-sdk 1.0.17 → 1.0.18

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.0.18
+
+Plugin API 1.10.0.
+
+### Added
+
+- `clientCert` on the sync link, link patch and remote target, and the `client_cert` remote error kind, so a sync plugin can link to a server that needs mutual TLS
+
 ## 1.0.17
 
 Plugin API 1.9.0.

package/PLUGIN-GUIDE.md

@@ -1,6 +1,6 @@
 # Termix plugin guide
 
-SDK 1.0.17 | Plugin API 1.9.0
+SDK 1.0.18 | Plugin API 1.10.0
 
 This guide is for anyone, person or AI coding tool, building a Termix plugin. It ships inside
 `@termix-ssh/plugin-sdk`, so the copy in your `node_modules` always matches the SDK you have installed.

package/dist/backend.d.ts

@@ -260,6 +260,14 @@ export interface SyncBasicAuth {
     username: string;
     password: string;
 }
+/** A client certificate for a server that asks for mutual TLS. */
+export interface SyncClientCert {
+    /** Base64 of the PFX/P12 file. */
+    pfx: string;
+    passphrase: string;
+    /** The file name, to show which certificate is saved. */
+    name: string | null;
+}
 /** Extra per server connection options. Kept open so new ones need no migration. */
 export type SyncLinkOptions = Record<string, unknown>;
 /** One server a desktop is linked to, with a replica of its data. */
@@ -274,6 +282,7 @@ export interface SyncLinkInfo {
     customHeaders: SyncProxyHeader[];
     basicAuth: SyncBasicAuth | null;
     allowInvalidCertificate: boolean;
+    clientCert: SyncClientCert | null;
     remoteUserId: string | null;
     remoteUsername: string | null;
     account: {
@@ -302,11 +311,12 @@ export interface SyncLinkCreate {
     customHeaders?: SyncProxyHeader[];
     basicAuth?: SyncBasicAuth | null;
     allowInvalidCertificate?: boolean;
+    clientCert?: SyncClientCert | null;
     remoteUserId?: string | null;
     remoteUsername?: string | null;
 }
-export type SyncLinkPatch = Partial<Pick<SyncLinkInfo, "serverName" | "serverVersion" | "sessionToken" | "customHeaders" | "basicAuth" | "allowInvalidCertificate" | "remoteUserId" | "remoteUsername" | "account" | "disabledTypes" | "options" | "knownTypes" | "cursor" | "status" | "lastError" | "lastSyncAt">>;
-export type SyncRemoteErrorKind = "offline" | "tls" | "proxy" | "basic_auth" | "signed_out" | "server";
+export type SyncLinkPatch = Partial<Pick<SyncLinkInfo, "serverName" | "serverVersion" | "sessionToken" | "customHeaders" | "basicAuth" | "allowInvalidCertificate" | "clientCert" | "remoteUserId" | "remoteUsername" | "account" | "disabledTypes" | "options" | "knownTypes" | "cursor" | "status" | "lastError" | "lastSyncAt">>;
+export type SyncRemoteErrorKind = "offline" | "tls" | "client_cert" | "proxy" | "basic_auth" | "signed_out" | "server";
 export interface SyncRemoteError extends Error {
     readonly kind: SyncRemoteErrorKind;
     readonly status?: number;
@@ -317,6 +327,7 @@ export interface SyncRemoteTarget {
     customHeaders?: SyncProxyHeader[];
     basicAuth?: SyncBasicAuth | null;
     allowInvalidCertificate?: boolean;
+    clientCert?: SyncClientCert | null;
 }
 export interface SyncRemoteRequest {
     method?: string;

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.9.0";
+export declare const PLUGIN_API_VERSION = "1.10.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. */

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.9.0";
+export const PLUGIN_API_VERSION = "1.10.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. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@termix-ssh/plugin-sdk",
-  "version": "1.0.17",
+  "version": "1.0.18",
   "description": "The contract between Termix core and a plugin: types, the capability catalog and the manifest schema.",
   "license": "Apache-2.0",
   "repository": {