@termix-ssh/plugin-sdk 1.0.15 → 1.0.17

package/dist/host/{use-permissions-LLN6TLAL.js → use-permissions-BYCDS5PD.js}

@@ -7,7 +7,7 @@ import {
   resetPermissionsCache,
   setPermissionsForTesting,
   usePermissions
-} from "./chunk-57DJU2ZA.js";
+} from "./chunk-2MU6WNSX.js";
 import "./chunk-YGYBM7SQ.js";
 export {
   hasPermission,

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.7.0";
+export declare const PLUGIN_API_VERSION = "1.9.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.7.0";
+export const PLUGIN_API_VERSION = "1.9.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/dist/testing.d.ts

@@ -23,7 +23,7 @@ export interface FakeWsRoute {
     options?: PluginWebSocketOptions;
 }
 import type { PluginLoginMethod, PluginVerifiedIdentity, PluginSecondFactor, PluginSshAuthProvider, PluginSshConnectOptions, PluginSshHost, PluginHostSummary, PluginShareableUser, PluginShareableRole, PluginSshKeyCredential, PluginSshKeyCredentialInput } from "./backend.js";
-import type { SyncEntityRegistration } from "./backend.js";
+import type { PluginSyncHost, SyncEntityRegistration } from "./backend.js";
 import type { PluginDatabase } from "./backend.js";
 import type { PluginExternalClientRequest, PluginProtocolTarget, PluginHostProbeTarget, PluginHostStatusEntry, PluginActivityProvider, PluginHostLockProvider, PluginAuthPolicyProvider, PluginCredentialSummary, PluginHostShareGrant, PluginHostStatusProvider, PluginNotification, PluginNotificationChannel, PluginNotifyHub, PluginFetchInit, PluginBinarySpec, PluginTlsCertificateInfo, PluginTlsStatus, PluginSummary, PluginKeyboardInteractiveHandler, PluginProcessHandle, PluginProcessOptions } from "./backend.js";
 /** A timer registered through ctx.schedule, run by hand with runScheduled. */
@@ -35,6 +35,8 @@ export interface FakeScheduledJob {
 }
 export interface FakeContextOptions {
     pluginId?: string;
+    /** What ctx.sync.host answers, for a sync provider's tests. */
+    syncHost?: Partial<PluginSyncHost>;
     manifest?: Partial<PluginManifest>;
     /** Acting user returned by currentActor and used by asUser. */
     actor?: string;
@@ -346,6 +348,8 @@ export interface FakePluginContext {
 export declare function createFakeContext(options?: FakeContextOptions): FakePluginContext;
 export interface MockContextOptions {
     pluginId?: string;
+    /** What ctx.sync.host answers, for a sync provider's tests. */
+    syncHost?: Partial<PluginSyncHost>;
     manifest?: Partial<PluginManifest>;
     /** Capabilities the plugin is granted. Anything else throws. */
     capabilities?: string[];

package/dist/testing.js

@@ -301,6 +301,12 @@ export function createFakeContext(options = {}) {
             registerEntity: (entity) => {
                 syncEntities.push(entity);
             },
+            provide: () => () => { },
+            get host() {
+                if (!options.syncHost)
+                    throw new Error("Pass syncHost to use ctx.sync.host");
+                return options.syncHost;
+            },
         },
         registry: {
             provide: (key, value) => {
@@ -562,6 +568,10 @@ export function createFakeContext(options = {}) {
                     };
                 },
             },
+            folders: {
+                ensure: async () => { },
+                removeEmpty: async () => true,
+            },
             locks: {
                 provide: (provider) => {
                     hostLockProviders.push(provider);
@@ -633,6 +643,7 @@ export function createFakeContext(options = {}) {
             tcpProbe: async (host, port) => options.reachable?.(host, port) ?? false,
         },
         ssh: {
+            transports: { provide: () => () => { } },
             probe: async (hostId, probeOptions) => options.reachable?.(hostId, probeOptions?.port) ?? false,
             connect: async (host, connectOptions) => {
                 sshConnections.push({ host, options: connectOptions });
@@ -1107,6 +1118,7 @@ export function createMockCtx(options = {}) {
     const checked = [];
     const base = createFakeContext({
         pluginId: options.pluginId,
+        syncHost: options.syncHost,
         actor: options.actor,
         settings: options.settings,
         coreSettings: options.coreSettings,
@@ -1341,6 +1353,16 @@ export function createMockCtx(options = {}) {
                     return ctx.hosts.activity.provide(provider);
                 },
             },
+            folders: {
+                ensure: async (name, style) => {
+                    require("hosts:write");
+                    return ctx.hosts.folders.ensure(name, style);
+                },
+                removeEmpty: async (name) => {
+                    require("hosts:write");
+                    return ctx.hosts.folders.removeEmpty(name);
+                },
+            },
             locks: {
                 provide: (provider) => {
                     require("hosts:lock");
@@ -1373,6 +1395,12 @@ export function createMockCtx(options = {}) {
         },
         ssh: {
             ...ctx.ssh,
+            transports: {
+                provide: (provider) => {
+                    require("ssh:transport");
+                    return ctx.ssh.transports.provide(provider);
+                },
+            },
             probe: async (hostId, probeOptions) => {
                 require("ssh:connect");
                 return ctx.ssh.probe(hostId, probeOptions);

package/package.json

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

package/schema/manifest.schema.json

@@ -152,6 +152,8 @@
           "users:write",
           "auth:provide",
           "auth:policy",
+          "sync:provide",
+          "ssh:transport",
           "system:tls",
           "device:serial",
           "hosts:write",

package/dist/host/types/src/ui/api/sync-api.d.ts

@@ -1,93 +0,0 @@
-export type SyncState = "idle" | "syncing" | "offline" | "error" | "signed_out";
-export interface SyncProxyHeader {
-    name: string;
-    value: string;
-    /** A saved header whose value is not sent back. */
-    set?: boolean;
-}
-export interface SyncBasicAuth {
-    username: string;
-    password: string;
-    set?: boolean;
-}
-export interface SyncEntityInfo {
-    type: string;
-    owner: string;
-    ownerName: string | null;
-    readOnly: boolean;
-    onServer: boolean;
-    onDevice: boolean;
-    enabled: boolean;
-}
-export interface SyncStatus {
-    linked: boolean;
-    serverUrl?: string;
-    serverName?: string | null;
-    serverVersion?: string | null;
-    account?: {
-        username?: string;
-        isAdmin?: boolean;
-        roles?: string[];
-        permissions?: string[];
-    };
-    status?: SyncState;
-    lastError?: string | null;
-    linkedAt?: string;
-    lastSyncAt?: string | null;
-    pending?: number;
-    conflicts?: number;
-    errors?: number;
-    firstSyncDone?: boolean;
-    allowInvalidCertificate?: boolean;
-    customHeaders?: SyncProxyHeader[];
-    basicAuth?: SyncBasicAuth | null;
-    entities: SyncEntityInfo[];
-}
-export type ProbeProblem = "invalid_url" | "unreachable" | "tls_untrusted" | "basic_auth_required" | "proxy_login" | "not_termix" | "version_mismatch" | "different_account";
-export interface ProbeResult {
-    ok: boolean;
-    serverUrl?: string;
-    name?: string;
-    version?: string | null;
-    problem?: ProbeProblem;
-    message?: string;
-}
-export interface ServerTarget {
-    serverUrl: string;
-    customHeaders?: SyncProxyHeader[];
-    basicAuth?: SyncBasicAuth | null;
-    allowInvalidCertificate?: boolean;
-}
-export interface SyncConflictItem {
-    id: number;
-    entityType: string;
-    syncId: string;
-    name: string;
-    createdAt: string;
-}
-export interface SyncErrorItem {
-    entityType: string;
-    syncId: string;
-    reason: string | null;
-}
-export declare function getSyncStatus(): Promise<SyncStatus>;
-export declare function probeServer(target: ServerTarget): Promise<ProbeResult>;
-export declare function getLinkPreview(): Promise<Record<string, number>>;
-export declare function completeLink(input: ServerTarget & {
-    token: string;
-    mode: "merge" | "replace";
-    serverName?: string;
-}): Promise<SyncStatus>;
-export declare function reloginLink(token: string): Promise<SyncStatus>;
-export declare function unlinkServer(keepData: boolean): Promise<SyncStatus>;
-export declare function syncNow(): Promise<SyncStatus>;
-export declare function updateSyncSettings(settings: {
-    disabledTypes?: string[];
-    customHeaders?: SyncProxyHeader[];
-    basicAuth?: SyncBasicAuth | null;
-    allowInvalidCertificate?: boolean;
-}): Promise<SyncStatus>;
-export declare function getSyncConflicts(): Promise<SyncConflictItem[]>;
-export declare function settleSyncConflict(id: number, keep: "mine" | "server"): Promise<void>;
-export declare function getSyncErrors(): Promise<SyncErrorItem[]>;
-export declare function retrySyncErrors(): Promise<SyncStatus>;

package/dist/host/types/src/ui/auth/ElectronLoginForm.d.ts

@@ -1,9 +0,0 @@
-import React from "react";
-interface ElectronLoginFormProps {
-    serverUrl: string;
-    onAuthSuccess: (token: string | null) => void | Promise<void>;
-    onChangeServer: () => void;
-    targetPurpose?: "local" | "link";
-}
-export declare function ElectronLoginForm({ serverUrl, onAuthSuccess, onChangeServer, targetPurpose, }: ElectronLoginFormProps): React.JSX.Element;
-export {};

package/dist/host/types/src/ui/hooks/use-sync-status.d.ts

@@ -1,4 +0,0 @@
-/** The desktop's sync status, kept current while the component is mounted. */
-export declare function useSyncStatus(): any;
-/** What needs the user's attention in Sync, for the rail badge. */
-export declare function useSyncAttentionCount(): number | null;

package/dist/host/types/src/ui/lib/sync-status.d.ts

@@ -1,6 +0,0 @@
-import { type SyncStatus } from "../api/sync-api";
-export declare function subscribeSyncStatus(listener: () => void): () => void;
-export declare function getSyncStatusSnapshot(): SyncStatus | null;
-/** Takes a status a request already returned, and checks again soon. */
-export declare function setSyncStatus(next: SyncStatus): void;
-export declare function refreshSyncStatus(): void;

package/dist/host/types/src/ui/settings/sync/LinkServerDialog.d.ts

@@ -1,12 +0,0 @@
-import { type SyncStatus } from "../../api/sync-api";
-interface LinkServerDialogProps {
-    open: boolean;
-    onOpenChange: (open: boolean) => void;
-    onLinked: (status: SyncStatus) => void;
-    /** Sign back in to the server this desktop is already linked to. */
-    relogin?: {
-        serverUrl: string;
-    };
-}
-export declare function LinkServerDialog({ open, onOpenChange, onLinked, relogin, }: LinkServerDialogProps): import("react").JSX.Element;
-export {};

package/dist/host/types/src/ui/settings/sync/ProxySettingsFields.d.ts

@@ -1,15 +0,0 @@
-import type { SyncBasicAuth, SyncProxyHeader } from "../../api/sync-api";
-interface ProxySettingsFieldsProps {
-    customHeaders: SyncProxyHeader[];
-    basicAuth: SyncBasicAuth | null;
-    onChange: (next: {
-        customHeaders?: SyncProxyHeader[];
-        basicAuth?: SyncBasicAuth | null;
-    }) => void;
-}
-/**
- * What a reverse proxy in front of the server wants: extra headers (a
- * Cloudflare Access service token, a gateway key) and basic auth.
- */
-export declare function ProxySettingsFields({ customHeaders, basicAuth, onChange, }: ProxySettingsFieldsProps): import("react").JSX.Element;
-export {};

package/dist/host/types/src/ui/settings/sync/saved-servers.d.ts

@@ -1,3 +0,0 @@
-export declare function getSavedServerUrls(): string[];
-export declare function rememberServerUrl(url: string): string[];
-export declare function forgetServerUrl(url: string): string[];