chrome-types 0.1.163 → 0.1.164

package/_all.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Sat Jan 14 2023 22:29:39 GMT+0000 (Coordinated Universal Time)
-// Built at b966f8180ede3753691c56b476f278f1c5afcdfd
+// Generated on Thu Jan 19 2023 22:30:07 GMT+0000 (Coordinated Universal Time)
+// Built at 264375da24bfa534433b1f5b573ba161dd31c98d
 
 // Includes all types, including MV2 + Platform Apps APIs.
 
@@ -2101,6 +2101,11 @@ declare namespace chrome {
      */
     export type SortDirectionType = "unsorted" | "ascending" | "descending" | "other";
 
+    /**
+     * A type of AutomationPosition.
+     */
+    export type PositionType = "null" | "text" | "tree";
+
     export interface Rect {
 
       left: number;
@@ -3463,6 +3468,8 @@ declare namespace chrome {
        */
       createPosition(
 
+        type: PositionType,
+
         offset: number,
 
         isUpstream?: boolean,
@@ -17388,6 +17395,63 @@ declare namespace chrome {
       },
     ) => void>;
 
+    /**
+     * Set the current composition. If this extension does not own the active IME, this fails.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function setComposition(
+
+      parameters: {
+
+        /**
+         * ID of the context where the composition text will be set
+         */
+        contextID: number,
+
+        /**
+         * Text to set
+         */
+        text: string,
+
+        /**
+         * Position in the text that the selection starts at.
+         */
+        selectionStart?: number,
+
+        /**
+         * Position in the text that the selection ends at.
+         */
+        selectionEnd?: number,
+
+        /**
+         * Position in the text of the cursor.
+         */
+        cursor: number,
+
+        /**
+         * List of segments and their associated types.
+         */
+        segments?: {
+
+          /**
+           * Index of the character to start this segment at
+           */
+          start: number,
+
+          /**
+           * Index of the character to end this segment after.
+           */
+          end: number,
+
+          /**
+           * The type of the underline to modify this segment.
+           */
+          style: UnderlineStyle,
+        }[],
+      },
+    ): Promise<boolean>;
+
     /**
      * Set the current composition. If this extension does not own the active IME, this fails.
      *
@@ -17449,6 +17513,22 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Clear the current composition. If this extension does not own the active IME, this fails.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function clearComposition(
+
+      parameters: {
+
+        /**
+         * ID of the context where the composition will be cleared
+         */
+        contextID: number,
+      },
+    ): Promise<boolean>;
+
     /**
      * Clear the current composition. If this extension does not own the active IME, this fails.
      *
@@ -17469,6 +17549,27 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Commits the provided text to the current input.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function commitText(
+
+      parameters: {
+
+        /**
+         * ID of the context where the text will be committed
+         */
+        contextID: number,
+
+        /**
+         * The text to commit
+         */
+        text: string,
+      },
+    ): Promise<boolean>;
+
     /**
      * Commits the provided text to the current input.
      *
@@ -17494,6 +17595,27 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Sends the key events. This function is expected to be used by virtual keyboards. When key(s) on a virtual keyboard is pressed by a user, this function is used to propagate that event to the system.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function sendKeyEvents(
+
+      parameters: {
+
+        /**
+         * ID of the context where the key events will be sent, or zero to send key events to non-input field.
+         */
+        contextID: number,
+
+        /**
+         * Data on the key event.
+         */
+        keyData: KeyboardEvent[],
+      },
+    ): Promise<void>;
+
     /**
      * Sends the key events. This function is expected to be used by virtual keyboards. When key(s) on a virtual keyboard is pressed by a user, this function is used to propagate that event to the system.
      *
@@ -17522,6 +17644,74 @@ declare namespace chrome {
      */
     export function hideInputView(): void;
 
+    /**
+     * Sets the properties of the candidate window. This fails if the extension doesn't own the active IME
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function setCandidateWindowProperties(
+
+      parameters: {
+
+        /**
+         * ID of the engine to set properties on.
+         */
+        engineID: string,
+
+        properties: {
+
+          /**
+           * True to show the Candidate window, false to hide it.
+           */
+          visible?: boolean,
+
+          /**
+           * True to show the cursor, false to hide it.
+           */
+          cursorVisible?: boolean,
+
+          /**
+           * True if the candidate window should be rendered vertical, false to make it horizontal.
+           */
+          vertical?: boolean,
+
+          /**
+           * The number of candidates to display per page.
+           */
+          pageSize?: number,
+
+          /**
+           * Text that is shown at the bottom of the candidate window.
+           */
+          auxiliaryText?: string,
+
+          /**
+           * True to display the auxiliary text, false to hide it.
+           */
+          auxiliaryTextVisible?: boolean,
+
+          /**
+           * The total number of candidates for the candidate window.
+           *
+           * @since Chrome 84
+           */
+          totalCandidates?: number,
+
+          /**
+           * The index of the current chosen candidate out of total candidates.
+           *
+           * @since Chrome 84
+           */
+          currentCandidateIndex?: number,
+
+          /**
+           * Where to display the candidate window.
+           */
+          windowPosition?: WindowPosition,
+        },
+      },
+    ): Promise<boolean>;
+
     /**
      * Sets the properties of the candidate window. This fails if the extension doesn't own the active IME
      *
@@ -17594,6 +17784,69 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Sets the current candidate list. This fails if this extension doesn't own the active IME
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function setCandidates(
+
+      parameters: {
+
+        /**
+         * ID of the context that owns the candidate window.
+         */
+        contextID: number,
+
+        /**
+         * List of candidates to show in the candidate window
+         */
+        candidates: {
+
+          /**
+           * The candidate
+           */
+          candidate: string,
+
+          /**
+           * The candidate's id
+           */
+          id: number,
+
+          /**
+           * The id to add these candidates under
+           */
+          parentId?: number,
+
+          /**
+           * Short string displayed to next to the candidate, often the shortcut key or index
+           */
+          label?: string,
+
+          /**
+           * Additional text describing the candidate
+           */
+          annotation?: string,
+
+          /**
+           * The usage or detail description of word.
+           */
+          usage?: {
+
+            /**
+             * The title string of details description.
+             */
+            title: string,
+
+            /**
+             * The body string of detail description.
+             */
+            body: string,
+          },
+        }[],
+      },
+    ): Promise<boolean>;
+
     /**
      * Sets the current candidate list. This fails if this extension doesn't own the active IME
      *
@@ -17661,6 +17914,27 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Set the position of the cursor in the candidate window. This is a no-op if this extension does not own the active IME.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function setCursorPosition(
+
+      parameters: {
+
+        /**
+         * ID of the context that owns the candidate window.
+         */
+        contextID: number,
+
+        /**
+         * ID of the candidate to select.
+         */
+        candidateID: number,
+      },
+    ): Promise<boolean>;
+
     /**
      * Set the position of the cursor in the candidate window. This is a no-op if this extension does not own the active IME.
      *
@@ -17686,6 +17960,28 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Shows/Hides an assistive window with the given properties.
+     *
+     * @chrome-returns-extra since Pending
+     * @since Chrome 85
+     */
+    export function setAssistiveWindowProperties(
+
+      parameters: {
+
+        /**
+         * ID of the context owning the assistive window.
+         */
+        contextID: number,
+
+        /**
+         * Properties of the assistive window.
+         */
+        properties: AssistiveWindowProperties,
+      },
+    ): Promise<boolean>;
+
     /**
      * Shows/Hides an assistive window with the given properties.
      *
@@ -17712,6 +18008,43 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Highlights/Unhighlights a button in an assistive window.
+     *
+     * @chrome-returns-extra since Pending
+     * @since Chrome 86
+     */
+    export function setAssistiveWindowButtonHighlighted(
+
+      parameters: {
+
+        /**
+         * ID of the context owning the assistive window.
+         */
+        contextID: number,
+
+        /**
+         * The ID of the button
+         */
+        buttonID: AssistiveWindowButton,
+
+        /**
+         * The window type the button belongs to.
+         */
+        windowType: AssistiveWindowType,
+
+        /**
+         * The text for the screenreader to announce.
+         */
+        announceString?: string,
+
+        /**
+         * Whether the button should be highlighted.
+         */
+        highlighted: boolean,
+      },
+    ): Promise<void>;
+
     /**
      * Highlights/Unhighlights a button in an assistive window.
      *
@@ -17751,6 +18084,16 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Adds the provided menu items to the language menu when this IME is active.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function setMenuItems(
+
+      parameters: MenuParameters,
+    ): Promise<void>;
+
     /**
      * Adds the provided menu items to the language menu when this IME is active.
      */
@@ -17761,6 +18104,16 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Updates the state of the MenuItems specified
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function updateMenuItems(
+
+      parameters: MenuParameters,
+    ): Promise<void>;
+
     /**
      * Updates the state of the MenuItems specified
      *
@@ -17773,6 +18126,37 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Deletes the text around the caret.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function deleteSurroundingText(
+
+      parameters: {
+
+        /**
+         * ID of the engine receiving the event.
+         */
+        engineID: string,
+
+        /**
+         * ID of the context where the surrounding text will be deleted.
+         */
+        contextID: number,
+
+        /**
+         * The offset from the caret position where deletion will start. This value can be negative.
+         */
+        offset: number,
+
+        /**
+         * The number of characters to be deleted
+         */
+        length: number,
+      },
+    ): Promise<void>;
+
     /**
      * Deletes the text around the caret.
      *

package/index.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Sat Jan 14 2023 22:29:32 GMT+0000 (Coordinated Universal Time)
-// Built at b966f8180ede3753691c56b476f278f1c5afcdfd
+// Generated on Thu Jan 19 2023 22:30:01 GMT+0000 (Coordinated Universal Time)
+// Built at 264375da24bfa534433b1f5b573ba161dd31c98d
 
 // Includes MV3+ APIs only.
 
@@ -1351,6 +1351,11 @@ declare namespace chrome {
      */
     export type SortDirectionType = "unsorted" | "ascending" | "descending" | "other";
 
+    /**
+     * A type of AutomationPosition.
+     */
+    export type PositionType = "null" | "text" | "tree";
+
     export interface Rect {
 
       left: number;
@@ -2713,6 +2718,8 @@ declare namespace chrome {
        */
       createPosition(
 
+        type: PositionType,
+
         offset: number,
 
         isUpstream?: boolean,
@@ -12949,6 +12956,63 @@ declare namespace chrome {
       },
     ) => void>;
 
+    /**
+     * Set the current composition. If this extension does not own the active IME, this fails.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function setComposition(
+
+      parameters: {
+
+        /**
+         * ID of the context where the composition text will be set
+         */
+        contextID: number,
+
+        /**
+         * Text to set
+         */
+        text: string,
+
+        /**
+         * Position in the text that the selection starts at.
+         */
+        selectionStart?: number,
+
+        /**
+         * Position in the text that the selection ends at.
+         */
+        selectionEnd?: number,
+
+        /**
+         * Position in the text of the cursor.
+         */
+        cursor: number,
+
+        /**
+         * List of segments and their associated types.
+         */
+        segments?: {
+
+          /**
+           * Index of the character to start this segment at
+           */
+          start: number,
+
+          /**
+           * Index of the character to end this segment after.
+           */
+          end: number,
+
+          /**
+           * The type of the underline to modify this segment.
+           */
+          style: UnderlineStyle,
+        }[],
+      },
+    ): Promise<boolean>;
+
     /**
      * Set the current composition. If this extension does not own the active IME, this fails.
      *
@@ -13010,6 +13074,22 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Clear the current composition. If this extension does not own the active IME, this fails.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function clearComposition(
+
+      parameters: {
+
+        /**
+         * ID of the context where the composition will be cleared
+         */
+        contextID: number,
+      },
+    ): Promise<boolean>;
+
     /**
      * Clear the current composition. If this extension does not own the active IME, this fails.
      *
@@ -13030,6 +13110,27 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Commits the provided text to the current input.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function commitText(
+
+      parameters: {
+
+        /**
+         * ID of the context where the text will be committed
+         */
+        contextID: number,
+
+        /**
+         * The text to commit
+         */
+        text: string,
+      },
+    ): Promise<boolean>;
+
     /**
      * Commits the provided text to the current input.
      *
@@ -13055,6 +13156,27 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Sends the key events. This function is expected to be used by virtual keyboards. When key(s) on a virtual keyboard is pressed by a user, this function is used to propagate that event to the system.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function sendKeyEvents(
+
+      parameters: {
+
+        /**
+         * ID of the context where the key events will be sent, or zero to send key events to non-input field.
+         */
+        contextID: number,
+
+        /**
+         * Data on the key event.
+         */
+        keyData: KeyboardEvent[],
+      },
+    ): Promise<void>;
+
     /**
      * Sends the key events. This function is expected to be used by virtual keyboards. When key(s) on a virtual keyboard is pressed by a user, this function is used to propagate that event to the system.
      *
@@ -13083,6 +13205,74 @@ declare namespace chrome {
      */
     export function hideInputView(): void;
 
+    /**
+     * Sets the properties of the candidate window. This fails if the extension doesn't own the active IME
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function setCandidateWindowProperties(
+
+      parameters: {
+
+        /**
+         * ID of the engine to set properties on.
+         */
+        engineID: string,
+
+        properties: {
+
+          /**
+           * True to show the Candidate window, false to hide it.
+           */
+          visible?: boolean,
+
+          /**
+           * True to show the cursor, false to hide it.
+           */
+          cursorVisible?: boolean,
+
+          /**
+           * True if the candidate window should be rendered vertical, false to make it horizontal.
+           */
+          vertical?: boolean,
+
+          /**
+           * The number of candidates to display per page.
+           */
+          pageSize?: number,
+
+          /**
+           * Text that is shown at the bottom of the candidate window.
+           */
+          auxiliaryText?: string,
+
+          /**
+           * True to display the auxiliary text, false to hide it.
+           */
+          auxiliaryTextVisible?: boolean,
+
+          /**
+           * The total number of candidates for the candidate window.
+           *
+           * @since Chrome 84
+           */
+          totalCandidates?: number,
+
+          /**
+           * The index of the current chosen candidate out of total candidates.
+           *
+           * @since Chrome 84
+           */
+          currentCandidateIndex?: number,
+
+          /**
+           * Where to display the candidate window.
+           */
+          windowPosition?: WindowPosition,
+        },
+      },
+    ): Promise<boolean>;
+
     /**
      * Sets the properties of the candidate window. This fails if the extension doesn't own the active IME
      *
@@ -13155,6 +13345,69 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Sets the current candidate list. This fails if this extension doesn't own the active IME
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function setCandidates(
+
+      parameters: {
+
+        /**
+         * ID of the context that owns the candidate window.
+         */
+        contextID: number,
+
+        /**
+         * List of candidates to show in the candidate window
+         */
+        candidates: {
+
+          /**
+           * The candidate
+           */
+          candidate: string,
+
+          /**
+           * The candidate's id
+           */
+          id: number,
+
+          /**
+           * The id to add these candidates under
+           */
+          parentId?: number,
+
+          /**
+           * Short string displayed to next to the candidate, often the shortcut key or index
+           */
+          label?: string,
+
+          /**
+           * Additional text describing the candidate
+           */
+          annotation?: string,
+
+          /**
+           * The usage or detail description of word.
+           */
+          usage?: {
+
+            /**
+             * The title string of details description.
+             */
+            title: string,
+
+            /**
+             * The body string of detail description.
+             */
+            body: string,
+          },
+        }[],
+      },
+    ): Promise<boolean>;
+
     /**
      * Sets the current candidate list. This fails if this extension doesn't own the active IME
      *
@@ -13222,6 +13475,27 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Set the position of the cursor in the candidate window. This is a no-op if this extension does not own the active IME.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function setCursorPosition(
+
+      parameters: {
+
+        /**
+         * ID of the context that owns the candidate window.
+         */
+        contextID: number,
+
+        /**
+         * ID of the candidate to select.
+         */
+        candidateID: number,
+      },
+    ): Promise<boolean>;
+
     /**
      * Set the position of the cursor in the candidate window. This is a no-op if this extension does not own the active IME.
      *
@@ -13247,6 +13521,28 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Shows/Hides an assistive window with the given properties.
+     *
+     * @chrome-returns-extra since Pending
+     * @since Chrome 85
+     */
+    export function setAssistiveWindowProperties(
+
+      parameters: {
+
+        /**
+         * ID of the context owning the assistive window.
+         */
+        contextID: number,
+
+        /**
+         * Properties of the assistive window.
+         */
+        properties: AssistiveWindowProperties,
+      },
+    ): Promise<boolean>;
+
     /**
      * Shows/Hides an assistive window with the given properties.
      *
@@ -13273,6 +13569,43 @@ declare namespace chrome {
       ) => void,
     ): void;
 
+    /**
+     * Highlights/Unhighlights a button in an assistive window.
+     *
+     * @chrome-returns-extra since Pending
+     * @since Chrome 86
+     */
+    export function setAssistiveWindowButtonHighlighted(
+
+      parameters: {
+
+        /**
+         * ID of the context owning the assistive window.
+         */
+        contextID: number,
+
+        /**
+         * The ID of the button
+         */
+        buttonID: AssistiveWindowButton,
+
+        /**
+         * The window type the button belongs to.
+         */
+        windowType: AssistiveWindowType,
+
+        /**
+         * The text for the screenreader to announce.
+         */
+        announceString?: string,
+
+        /**
+         * Whether the button should be highlighted.
+         */
+        highlighted: boolean,
+      },
+    ): Promise<void>;
+
     /**
      * Highlights/Unhighlights a button in an assistive window.
      *
@@ -13312,6 +13645,16 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Adds the provided menu items to the language menu when this IME is active.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function setMenuItems(
+
+      parameters: MenuParameters,
+    ): Promise<void>;
+
     /**
      * Adds the provided menu items to the language menu when this IME is active.
      */
@@ -13322,6 +13665,16 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Updates the state of the MenuItems specified
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function updateMenuItems(
+
+      parameters: MenuParameters,
+    ): Promise<void>;
+
     /**
      * Updates the state of the MenuItems specified
      *
@@ -13334,6 +13687,37 @@ declare namespace chrome {
       callback?: () => void,
     ): void;
 
+    /**
+     * Deletes the text around the caret.
+     *
+     * @chrome-returns-extra since Pending
+     */
+    export function deleteSurroundingText(
+
+      parameters: {
+
+        /**
+         * ID of the engine receiving the event.
+         */
+        engineID: string,
+
+        /**
+         * ID of the context where the surrounding text will be deleted.
+         */
+        contextID: number,
+
+        /**
+         * The offset from the caret position where deletion will start. This value can be negative.
+         */
+        offset: number,
+
+        /**
+         * The number of characters to be deleted
+         */
+        length: number,
+      },
+    ): Promise<void>;
+
     /**
      * Deletes the text around the caret.
      *

package/package.json

@@ -5,7 +5,7 @@
   "type": "module",
   "name": "chrome-types",
   "config": {
-    "build-hash": "6a838ae099c8a6e7"
+    "build-hash": "1f479c03b2c0b55d"
   },
   "repository": {
     "type": "git",
@@ -16,5 +16,5 @@
     "url": "https://github.com/GoogleChrome/chrome-types/issues"
   },
   "homepage": "https://github.com/GoogleChrome/chrome-types",
-  "version": "0.1.163"
+  "version": "0.1.164"
 }