@leaflow/sdk 0.0.0-dev.472.g83cc4b9 → 0.0.0-dev.476.gdbfc694

package/dist/proto/leaflow/fleet/virtualdesktop/input/v1/input_pb.d.ts

@@ -380,15 +380,18 @@ export declare const PointerWheelSchema: GenMessage<PointerWheel>;
  */
 export type TextInputState = Message<"leaflow.fleet.virtualdesktop.input.v1.TextInputState"> & {
     /**
-     * The window of the focused editor. 0 when no window has focus.
+     * The window that has the keyboard focus. 0 when no window has it.
      *
      * @generated from field: uint64 window_id = 1;
      */
     windowId: bigint;
     /**
-     * An editable control or a terminal has focus and accepts text, whether
-     * or not its caret is known. The participant keeps a local text field focused
-     * while it is set, so that its own input method can start.
+     * The window takes typed text: an editor, a terminal, or any window that
+     * reads keys, whether or not the session knows its editor or caret. Unset
+     * while no window has the keyboard focus or an application grabbed the
+     * keyboard, as an open menu does. The participant keeps its own input
+     * method on while it is set, with a local text field focused where it needs
+     * one.
      *
      * @generated from field: bool enabled = 2;
      */
@@ -417,7 +420,8 @@ export type TextInputState = Message<"leaflow.fleet.virtualdesktop.input.v1.Text
     /**
      * Identifies the focused editor within the session, opaque. Different
      * editors of one window differ; moving the caret or resizing does not change
-     * it. Empty when nothing editable has focus or it cannot be verified.
+     * it. Empty when the session cannot tell which editor has the focus; text
+     * then goes where the keys go, as typed keys where nothing else takes it.
      *
      * @generated from field: string input_context_id = 6;
      */
@@ -439,13 +443,32 @@ export type TextInputState = Message<"leaflow.fleet.virtualdesktop.input.v1.Text
      */
     controlRectangle?: Rectangle | undefined;
     /**
-     * The editor's native input context takes Composition messages: preedit
-     * text and the real keys consumed while composing. Otherwise the participant
-     * sends only InsertText.
+     * The editor shows preedit text itself: its native input context takes
+     * Composition messages, the preedit and the real keys consumed while
+     * composing, and the participant does not draw its input method's preedit.
+     * Otherwise the participant draws the preedit itself, at cursor_rectangle,
+     * else control_rectangle, else where the person last pressed in the window,
+     * and sends only InsertText.
      *
      * @generated from field: bool composition_supported = 9;
      */
     compositionSupported: boolean;
+    /**
+     * What the editor is for, as its application declared it to its input
+     * method (IBus ContentType, GTK input-purpose). A participant switches its
+     * input method off for PASSWORD and PIN, as a native one does. UNSPECIFIED
+     * when it declared nothing.
+     *
+     * @generated from field: leaflow.fleet.virtualdesktop.input.v1.InputPurpose purpose = 10;
+     */
+    purpose: InputPurpose;
+    /**
+     * How the editor wants its text, as its application declared it (IBus
+     * ContentType, GTK input-hints).
+     *
+     * @generated from field: repeated leaflow.fleet.virtualdesktop.input.v1.InputHint hints = 11;
+     */
+    hints: InputHint[];
 };
 /**
  * Describes the message leaflow.fleet.virtualdesktop.input.v1.TextInputState.
@@ -471,21 +494,21 @@ export type InsertText = Message<"leaflow.fleet.virtualdesktop.input.v1.InsertTe
      */
     text: string;
     /**
-     * The window of the editor, from TextInputState. A window that is gone or
-     * no longer focused cancels the insertion; it is never activated for it.
+     * The window, from TextInputState. A window that is gone or no longer
+     * focused cancels the insertion; it is never activated for it.
      *
      * @generated from field: uint64 window_id = 3;
      */
     windowId: bigint;
     /**
-     * TextInputState.input_context_id of the editor.
+     * TextInputState.input_context_id of the editor. Empty when it named none.
      *
      * @generated from field: string input_context_id = 4;
      */
     inputContextId: string;
     /**
      * TextInputState.focus_serial when the composition began. Checked for
-     * INSERT_FROM_COMPOSITION only.
+     * INSERT_FROM_COMPOSITION with an input_context_id only.
      *
      * @generated from field: uint64 focus_serial = 5;
      */
@@ -542,7 +565,7 @@ export type Composition = Message<"leaflow.fleet.virtualdesktop.input.v1.Composi
     resizeCounter: bigint;
     /**
      * Chosen by the participant at BEGIN, unique on the connection; the later
-     * phases repeat it.
+     * phases repeat it. A KEY release may name any composition, or none.
      *
      * @generated from field: uint64 composition_id = 6;
      */
@@ -554,8 +577,9 @@ export type Composition = Message<"leaflow.fleet.virtualdesktop.input.v1.Composi
      */
     phase: CompositionPhase;
     /**
-     * UPDATE and COMMIT: the preedit or committed text, UTF-8, at most 64 KiB.
-     * May be empty to end an empty composition. Empty for the other phases.
+     * UPDATE: the whole preedit text now. COMMIT: the whole result. UTF-8, at
+     * most 64 KiB. May be empty: an empty UPDATE hides the preedit, an empty
+     * COMMIT ends the composition without text. Empty for the other phases.
      *
      * @generated from field: string text = 8;
      */
@@ -587,7 +611,11 @@ export type Composition = Message<"leaflow.fleet.virtualdesktop.input.v1.Composi
  */
 export declare const CompositionSchema: GenMessage<Composition>;
 /**
- * A real key consumed while composing. Never made up from text.
+ * A real key consumed while composing. Never made up from text. The session
+ * knows a key by the participant and its code, as a keyboard does: a release
+ * lets go the key of that code the participant holds, whatever composition it
+ * names, and a press of a key already held changes nothing. The key that ends
+ * a composition is released after it; its release is still sent.
  *
  * @generated from message leaflow.fleet.virtualdesktop.input.v1.CompositionKey
  */
@@ -658,8 +686,9 @@ export declare const InputErrorSchema: GenMessage<InputError>;
  *   TEXT_INPUT_NOT_DELIVERED      the text could not be handed over;
  *   TEXT_INPUT_UNCONFIRMED        the application did not confirm the text
  *                                 (see paused);
- *   NATIVE_COMPOSITION_CANCELLED  the native input context ended the
- *                                 composition.
+ *   NATIVE_COMPOSITION_CANCELLED  the composition ended without its COMMIT,
+ *                                 as when another participant typed into
+ *                                 its editor.
  *
  * @generated from message leaflow.fleet.virtualdesktop.input.v1.TextInputError
  */
@@ -1219,6 +1248,174 @@ export type GetPointerPositionResponse = Message<"leaflow.fleet.virtualdesktop.i
  * Use `create(GetPointerPositionResponseSchema)` to create a new message.
  */
 export declare const GetPointerPositionResponseSchema: GenMessage<GetPointerPositionResponse>;
+/**
+ * What an editor is for (IBus InputPurpose, GTK GtkInputPurpose).
+ *
+ * @generated from enum leaflow.fleet.virtualdesktop.input.v1.InputPurpose
+ */
+export declare enum InputPurpose {
+    /**
+     * @generated from enum value: INPUT_PURPOSE_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * Any text.
+     *
+     * @generated from enum value: INPUT_PURPOSE_FREE_FORM = 1;
+     */
+    FREE_FORM = 1,
+    /**
+     * Letters only.
+     *
+     * @generated from enum value: INPUT_PURPOSE_ALPHA = 2;
+     */
+    ALPHA = 2,
+    /**
+     * Digits only.
+     *
+     * @generated from enum value: INPUT_PURPOSE_DIGITS = 3;
+     */
+    DIGITS = 3,
+    /**
+     * A number.
+     *
+     * @generated from enum value: INPUT_PURPOSE_NUMBER = 4;
+     */
+    NUMBER = 4,
+    /**
+     * A phone number.
+     *
+     * @generated from enum value: INPUT_PURPOSE_PHONE = 5;
+     */
+    PHONE = 5,
+    /**
+     * A URL.
+     *
+     * @generated from enum value: INPUT_PURPOSE_URL = 6;
+     */
+    URL = 6,
+    /**
+     * An email address.
+     *
+     * @generated from enum value: INPUT_PURPOSE_EMAIL = 7;
+     */
+    EMAIL = 7,
+    /**
+     * The name of a person.
+     *
+     * @generated from enum value: INPUT_PURPOSE_NAME = 8;
+     */
+    NAME = 8,
+    /**
+     * A password: any text, hidden.
+     *
+     * @generated from enum value: INPUT_PURPOSE_PASSWORD = 9;
+     */
+    PASSWORD = 9,
+    /**
+     * A PIN: digits, hidden.
+     *
+     * @generated from enum value: INPUT_PURPOSE_PIN = 10;
+     */
+    PIN = 10,
+    /**
+     * A terminal: any text and control keys.
+     *
+     * @generated from enum value: INPUT_PURPOSE_TERMINAL = 11;
+     */
+    TERMINAL = 11
+}
+/**
+ * Describes the enum leaflow.fleet.virtualdesktop.input.v1.InputPurpose.
+ */
+export declare const InputPurposeSchema: GenEnum<InputPurpose>;
+/**
+ * How an editor wants its text (IBus InputHints, GTK GtkInputHints).
+ *
+ * @generated from enum leaflow.fleet.virtualdesktop.input.v1.InputHint
+ */
+export declare enum InputHint {
+    /**
+     * @generated from enum value: INPUT_HINT_UNSPECIFIED = 0;
+     */
+    UNSPECIFIED = 0,
+    /**
+     * Check for typos.
+     *
+     * @generated from enum value: INPUT_HINT_SPELLCHECK = 1;
+     */
+    SPELLCHECK = 1,
+    /**
+     * Do not check for typos.
+     *
+     * @generated from enum value: INPUT_HINT_NO_SPELLCHECK = 2;
+     */
+    NO_SPELLCHECK = 2,
+    /**
+     * Offer word completion.
+     *
+     * @generated from enum value: INPUT_HINT_WORD_COMPLETION = 3;
+     */
+    WORD_COMPLETION = 3,
+    /**
+     * Lowercase text.
+     *
+     * @generated from enum value: INPUT_HINT_LOWERCASE = 4;
+     */
+    LOWERCASE = 4,
+    /**
+     * Uppercase every character.
+     *
+     * @generated from enum value: INPUT_HINT_UPPERCASE_CHARS = 5;
+     */
+    UPPERCASE_CHARS = 5,
+    /**
+     * Capitalize every word.
+     *
+     * @generated from enum value: INPUT_HINT_UPPERCASE_WORDS = 6;
+     */
+    UPPERCASE_WORDS = 6,
+    /**
+     * Capitalize every sentence.
+     *
+     * @generated from enum value: INPUT_HINT_UPPERCASE_SENTENCES = 7;
+     */
+    UPPERCASE_SENTENCES = 7,
+    /**
+     * Show no on-screen keyboard.
+     *
+     * @generated from enum value: INPUT_HINT_INHIBIT_OSK = 8;
+     */
+    INHIBIT_OSK = 8,
+    /**
+     * The text runs vertically.
+     *
+     * @generated from enum value: INPUT_HINT_VERTICAL_WRITING = 9;
+     */
+    VERTICAL_WRITING = 9,
+    /**
+     * Offer emoji.
+     *
+     * @generated from enum value: INPUT_HINT_EMOJI = 10;
+     */
+    EMOJI = 10,
+    /**
+     * Offer no emoji.
+     *
+     * @generated from enum value: INPUT_HINT_NO_EMOJI = 11;
+     */
+    NO_EMOJI = 11,
+    /**
+     * Keep no typing history of it.
+     *
+     * @generated from enum value: INPUT_HINT_PRIVATE = 12;
+     */
+    PRIVATE = 12
+}
+/**
+ * Describes the enum leaflow.fleet.virtualdesktop.input.v1.InputHint.
+ */
+export declare const InputHintSchema: GenEnum<InputHint>;
 /**
  * Where a caret rectangle came from.
  *
@@ -1265,16 +1462,17 @@ export declare enum InputType {
      */
     UNSPECIFIED = 0,
     /**
-     * Ordinary text ("insertText"), such as from a virtual keyboard. It goes to
-     * the editor focused once the input before it has been applied.
+     * Ordinary text ("insertText"), such as from a virtual keyboard. It goes
+     * where the keys go once the input before it has been applied.
      *
      * @generated from enum value: INPUT_TYPE_INSERT_TEXT = 1;
      */
     INSERT_TEXT = 1,
     /**
-     * The result of a composition ("insertFromComposition"). It goes only to
-     * the editor the composition began in, and is cancelled when that editor
-     * lost focus since.
+     * The result of a composition ("insertFromComposition"). With an
+     * input_context_id it goes only to the editor the composition began in, and
+     * is cancelled when that editor lost focus since; without one, as
+     * INSERT_TEXT.
      *
      * @generated from enum value: INPUT_TYPE_INSERT_FROM_COMPOSITION = 2;
      */
@@ -1285,7 +1483,9 @@ export declare enum InputType {
  */
 export declare const InputTypeSchema: GenEnum<InputType>;
 /**
- * A step of a composition.
+ * A step of a composition. A composition ends with its COMMIT or CANCEL, or
+ * when its editor loses the focus (a TextInputState with another
+ * focus_serial); a step that did not reach the editor never ends it.
  *
  * @generated from enum leaflow.fleet.virtualdesktop.input.v1.CompositionPhase
  */
@@ -1295,33 +1495,38 @@ export declare enum CompositionPhase {
      */
     UNSPECIFIED = 0,
     /**
-     * A composition begins ("compositionstart").
+     * A composition begins ("compositionstart"), in the editor the
+     * TextInputState names. It shows nothing yet.
      *
      * @generated from enum value: COMPOSITION_PHASE_BEGIN = 1;
      */
     BEGIN = 1,
     /**
-     * The preedit text changed ("compositionupdate").
+     * The preedit text changed ("compositionupdate"). The session shows the
+     * latest UPDATE and may skip earlier ones the editor has not caught up
+     * with.
      *
      * @generated from enum value: COMPOSITION_PHASE_UPDATE = 2;
      */
     UPDATE = 2,
     /**
      * A real key the input method consumed while composing. The session hands
-     * it to the editor's native input context and waits until that context
-     * consumed it.
+     * it to the editor's native input context, which consumes it, so that the
+     * application sees the key but never as text. Its press or release never
+     * ends the composition.
      *
      * @generated from enum value: COMPOSITION_PHASE_KEY = 3;
      */
     KEY = 3,
     /**
-     * The composition ended with text ("compositionend").
+     * The composition ended with text ("compositionend"): the text is inserted
+     * and the preedit goes.
      *
      * @generated from enum value: COMPOSITION_PHASE_COMMIT = 4;
      */
     COMMIT = 4,
     /**
-     * The composition was abandoned.
+     * The composition was abandoned: the preedit goes.
      *
      * @generated from enum value: COMPOSITION_PHASE_CANCEL = 5;
      */
@@ -1418,9 +1623,9 @@ export declare const InputService: GenService<{
         output: typeof PressKeysResponseSchema;
     };
     /**
-     * Types text into the focused editor the way a participant's InsertText goes:
-     * through its input method context when it has one, else its accessible
-     * text interface, and into a terminal as keys.
+     * Types text into the focused window the way a participant's InsertText
+     * goes: through its editor's input method context when it has one, else its
+     * accessible text interface, else as typed keys.
      *
      * @generated from rpc leaflow.fleet.virtualdesktop.input.v1.InputService.TypeText
      */