@cmusei/console-forge 0.0.1 → 0.9.0

package/lib/components/console-toolbar/console-toolbar.component.d.ts

@@ -12,6 +12,7 @@ export declare class ConsoleToolbarComponent {
     canvasRecordingStarted: import("@angular/core").OutputEmitterRef<void>;
     canvasRecordingFinished: import("@angular/core").OutputEmitterRef<Blob>;
     ctrlAltDelSent: import("@angular/core").OutputEmitterRef<void>;
+    keyboardInputSent: import("@angular/core").OutputEmitterRef<string>;
     networkConnectionRequested: import("@angular/core").OutputEmitterRef<string>;
     networkDisconnectRequested: import("@angular/core").OutputEmitterRef<void>;
     powerRequestSent: import("@angular/core").OutputEmitterRef<ConsolePowerRequest>;
@@ -29,6 +30,7 @@ export declare class ConsoleToolbarComponent {
     constructor();
     protected handleCopyScreenshot(): Promise<void>;
     protected handleFullscreen(): Promise<void>;
+    protected handleKeyboardInputSend(text: string): Promise<void>;
     protected handleNetworkConnectionRequest(networkName: string): void;
     protected handleRecordScreenStart(): void;
     protected handleRecordScreenStop(): Promise<Blob>;
@@ -36,5 +38,5 @@ export declare class ConsoleToolbarComponent {
     private handleSendPowerRequest;
     protected handleSendTextToClipboard(text: string): Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ConsoleToolbarComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ConsoleToolbarComponent, "cf-console-toolbar", never, { "consoleClient": { "alias": "consoleClient"; "required": true; "isSignal": true; }; "consoleNetworkConfig": { "alias": "consoleNetworkConfig"; "required": false; "isSignal": true; }; "customToolbarComponent": { "alias": "customToolbarComponent"; "required": false; "isSignal": true; }; }, { "canvasRecordingStarted": "canvasRecordingStarted"; "canvasRecordingFinished": "canvasRecordingFinished"; "ctrlAltDelSent": "ctrlAltDelSent"; "networkConnectionRequested": "networkConnectionRequested"; "networkDisconnectRequested": "networkDisconnectRequested"; "powerRequestSent": "powerRequestSent"; "screenshotCopied": "screenshotCopied"; "toggleFullscreen": "toggleFullscreen"; }, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ConsoleToolbarComponent, "cf-console-toolbar", never, { "consoleClient": { "alias": "consoleClient"; "required": true; "isSignal": true; }; "consoleNetworkConfig": { "alias": "consoleNetworkConfig"; "required": false; "isSignal": true; }; "customToolbarComponent": { "alias": "customToolbarComponent"; "required": false; "isSignal": true; }; }, { "canvasRecordingStarted": "canvasRecordingStarted"; "canvasRecordingFinished": "canvasRecordingFinished"; "ctrlAltDelSent": "ctrlAltDelSent"; "keyboardInputSent": "keyboardInputSent"; "networkConnectionRequested": "networkConnectionRequested"; "networkDisconnectRequested": "networkDisconnectRequested"; "powerRequestSent": "powerRequestSent"; "screenshotCopied": "screenshotCopied"; "toggleFullscreen": "toggleFullscreen"; }, never, never, true, never>;
 }

package/lib/components/console-toolbar-default/console-toolbar-default.component.d.ts

@@ -8,23 +8,27 @@ import * as i0 from "@angular/core";
 export declare class ConsoleToolbarDefaultComponent implements ConsoleToolbarComponentBase {
     consoleContext: import("@angular/core").InputSignal<ConsoleToolbarContext>;
     protected isClipboardDialogOpen: boolean;
+    protected isKeyboardDialogOpen: boolean;
     protected isNetworkDialogOpen: boolean;
     protected isPowerDialogOpen: boolean;
     protected isSettingsDialogOpen: boolean;
+    protected keyboardInputText: import("@angular/core").ModelSignal<string>;
     protected readonly cfConfig: ConsoleForgeConfig;
+    private readonly clipboardService;
     protected readonly clipboardTextInput: import("@angular/core").Signal<ElementRef<any> | undefined>;
-    protected readonly userSettings: import("@angular/core").Signal<import("../../models/console-user-settings").ConsoleUserSettings>;
     protected handleChangeToolbarPosition(position: ConsoleToolbarPosition): void;
     protected handleClipboardDialogOpenClose(isOpen: boolean): void;
     protected handleClipboardCopyLastText(text: string): void;
     protected handleNetworkChangeRequested(networkName?: string): void;
     protected handleNetworkDialogOpenClose(isOpen: boolean): void;
     protected handleRecordToggle(): void;
-    protected handleSendClipboardText(event: Event, text: string): void;
+    protected handleSendClipboardText(event: Event, text: string): Promise<void>;
+    protected handlSendKeyboardCtrlAltDel(): Promise<void>;
+    protected handleSendKeyboardInput(event: Event, text: string): Promise<void>;
     protected handleSendPowerRequest(request: ConsolePowerRequest): Promise<void>;
     protected handleSettingsDialogOpenClose(isOpen: boolean): void;
     protected handleSettingsAllowLocalClipboardWrite(allow: boolean): void;
     protected handleSettingsPreserveAspectRatioChange(preserveAspectRatioOnScale: boolean): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ConsoleToolbarDefaultComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ConsoleToolbarDefaultComponent, "cf-console-toolbar-default", never, { "consoleContext": { "alias": "consoleContext"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ConsoleToolbarDefaultComponent, "cf-console-toolbar-default", never, { "consoleContext": { "alias": "consoleContext"; "required": true; "isSignal": true; }; "keyboardInputText": { "alias": "keyboardInputText"; "required": false; "isSignal": true; }; }, { "keyboardInputText": "keyboardInputTextChange"; }, never, never, true, never>;
 }

package/lib/models/console-supported-features.d.ts

@@ -1,4 +1,30 @@
 export interface ConsoleSupportedFeatures {
+    /**
+     * This is basically a stupid kludge that is only here because VMWare's client has a very weird implementation of "copy".
+     *
+     * The VMWare "WMKS" client only emits clipboard events after the remote console's clipboard receives new data (i.e. you copy some content on the remote desktop)
+     * AND after the console canvas loses focus. That is, no matter how much copying you do, the client doesn't know about until the canvas housing the console
+     * is blurred.
+     *
+     * The downstream effect of this that, unlike with other protocols, we can't gracefully emit events when copies happen or automatically copy to your local
+     * clipboard in a reasonable way, because we can't know when the remote copy happened and if you really want it copied to your local CB or not. So when this
+     * flag is set to false (VMWare is the only service which does this), we show a panel in the default toolbar that you can manually copy content from and
+     * automatically receives the last "copy" event from the console.
+     *
+     * Yuck.
+     */
+    clipboardAutomaticLocalCopy: boolean;
+    /**
+     * Indicates whether the remote console protocol allows us to write content directly to the clipboard of the remote machine.
+     */
+    clipboardRemoteWrite: boolean;
+    /**
+     * Indicates whether there remote console offers an on-screen keyboard. (Hint: probably not. As far as we know, VMWare's WMKS is the only one that will do this.)
+     */
     onScreenKeyboard: boolean;
+    /**
+     * Indicates whether the remote console protocol allows us to issue power requests (like restart, reboot, and hard reboot). This is typically a configuration detail
+     * of the machine, so we usually have to rely on the protocol-specific service to tell us whether the feature is enabled (see our VNC client, wrapping noVnc, for an example)
+     */
     powerManagement: boolean;
 }

package/lib/models/console-toolbar-context.d.ts

@@ -5,13 +5,17 @@ import { ConsoleSupportedFeatures } from "./console-supported-features";
 import { ConsoleComponentNetworkConfig } from "./console-component-network-config";
 import { UserSettingsService } from "../services/user-settings.service";
 export interface ConsoleToolbarContext {
+    clipboard: {
+        consoleClipboardText: Signal<string>;
+        sendTextToConsoleClipboard(text: string): Promise<void>;
+    };
     console: {
         copyScreenshot(): Promise<void>;
         recordScreenStart(): void;
         recordScreenStop(): Promise<Blob>;
         sendCtrlAltDel(): Promise<void>;
+        sendKeyboardInput(text: string): Promise<void>;
         sendPowerRequest(request: ConsolePowerRequest): Promise<void>;
-        sendTextToClipboard(text: string): Promise<void>;
         supportedFeatures: Signal<ConsoleSupportedFeatures>;
         toggleFullscreen(): Promise<void>;
     };

package/lib/services/clipboard/clipboard.helpers.d.ts

@@ -3,12 +3,6 @@
  *
  * @param clipboardItem - The ClipboardItem to extract text from.
  * @returns A promise that resolves to the extracted text, or null if no text is present.
- *
- * @example
- * const text = await getTextFromClipboardItem(item);
- * if (text) {
- *   console.log("Clipboard text:", text);
- * }
  */
 export declare function getTextFromClipboardItem(clipboardItem?: ClipboardItem): Promise<string | null>;
 export declare function getClipboardItemFromText(text: string): ClipboardItem;

package/lib/services/console-clients/console-client.service.d.ts

@@ -8,10 +8,10 @@ export interface ConsoleClientService {
     readonly consoleClipboardUpdated: Signal<string>;
     readonly supportedFeatures: Signal<ConsoleSupportedFeatures>;
     connect(url: string, options: ConsoleConnectionOptions): Promise<ConsoleSupportedFeatures>;
-    copyVmClipboard(): Promise<void>;
     disconnect(): Promise<void>;
     sendClipboardText(text: string): Promise<void>;
     sendCtrlAltDelete(): Promise<void>;
+    sendKeyboardInput(text: string): Promise<void>;
     sendPowerRequest(request: ConsolePowerRequest): Promise<void>;
     setPreserveAspectRatioOnScale(preserve: boolean): Promise<void>;
     setIsViewOnly(isViewOnly: boolean): Promise<void>;

package/lib/services/console-clients/vmware/vmware-console-client.service.d.ts

@@ -9,6 +9,7 @@ export declare class VmWareConsoleClientService implements ConsoleClientService
     private readonly clipboardService;
     private readonly logger;
     private readonly document;
+    private readonly userSettings;
     private readonly window;
     private wmksClient?;
     private readonly _connectionStatus;
@@ -21,9 +22,9 @@ export declare class VmWareConsoleClientService implements ConsoleClientService
     private readonly _needsCanvasSizeUpdateSub;
     connect(url: string, options: ConsoleConnectionOptions): Promise<ConsoleSupportedFeatures>;
     disconnect(): Promise<void>;
-    copyVmClipboard(): Promise<void>;
     sendClipboardText(text: string): Promise<void>;
     sendCtrlAltDelete(): Promise<void>;
+    sendKeyboardInput(text: string): Promise<void>;
     sendPowerRequest(request: ConsolePowerRequest): Promise<void>;
     setIsViewOnly(isViewOnly: boolean): Promise<void>;
     setPreserveAspectRatioOnScale(scaleToContainerSize: boolean): Promise<void>;

package/lib/services/console-clients/vnc-console-client/vnc-console-client.service.d.ts

@@ -19,9 +19,9 @@ export declare class VncConsoleClientService implements ConsoleClientService {
     connect(url: string, options: ConsoleConnectionOptions): Promise<ConsoleSupportedFeatures>;
     disconnect(): Promise<void>;
     dispose(): Promise<void>;
-    copyVmClipboard(): Promise<void>;
     sendClipboardText(text: string): Promise<void>;
     sendCtrlAltDelete(): Promise<void>;
+    sendKeyboardInput(text: string): Promise<void>;
     sendPowerRequest(request: ConsolePowerRequest): Promise<void>;
     setIsViewOnly(isViewOnly: boolean): Promise<void>;
     setPreserveAspectRatioOnScale(preserve: boolean): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cmusei/console-forge",
-  "version": "0.0.1",
+  "version": "0.9.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/cmu-sei/console-forge.git"