chrome-types 0.1.315 → 0.1.317

package/_all.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Fri Nov 01 2024 22:31:05 GMT+0000 (Coordinated Universal Time)
-// Built at a5c2aaa7e5af3f4ceaea0a606c79e537a859cdae
+// Generated on Thu Nov 07 2024 22:31:27 GMT+0000 (Coordinated Universal Time)
+// Built at ffca9c169a23fc1884e7fda28d3af60c24a6eff2
 
 // Includes all types, including MV2 + Platform Apps APIs.
 
@@ -7027,6 +7027,29 @@ declare namespace chrome {
       partitionKey?: CookiePartitionKey;
     }
 
+    /**
+     * Details to identify the frame.
+     *
+     * @since Pending
+     */
+    export interface FrameDetails {
+
+      /**
+       * The unique identifier for the tab containing the frame.
+       */
+      tabId?: number;
+
+      /**
+       * The unique identifier for the frame within the tab.
+       */
+      frameId?: number;
+
+      /**
+       * The unique identifier for the document. If the frameId and/or tabId are provided they will be validated to match the document found by provided document ID.
+       */
+      documentId?: string;
+    }
+
     /**
      * Fired when a cookie is set or removed. As a special case, note that updating a cookie's properties is implemented as a two step process: the cookie to be updated is first removed entirely, generating a notification with "cause" of "overwrite" . Afterwards, a new cookie is written with the updated values, generating a second notification with "cause" "explicit".
      */
@@ -7427,6 +7450,45 @@ declare namespace chrome {
         cookieStores: CookieStore[],
       ) => void,
     ): void;
+
+    /**
+     * The partition key for the frame indicated.
+     *
+     * @since Pending
+     */
+    export function getPartitionKey(
+
+      details: FrameDetails,
+    ): Promise<{
+
+      /**
+       * The partition key for reading or modifying cookies with the Partitioned attribute.
+       */
+      partitionKey: CookiePartitionKey,
+    }>;
+
+    /**
+     * The partition key for the frame indicated.
+     *
+     * @since Pending
+     */
+    export function getPartitionKey(
+
+      details: FrameDetails,
+
+      /**
+       * @param details Contains details about the partition key that's been retrieved.
+       */
+      callback?: (
+        details: {
+
+          /**
+           * The partition key for reading or modifying cookies with the Partitioned attribute.
+           */
+          partitionKey: CookiePartitionKey,
+        },
+      ) => void,
+    ): void;
   }
 
   /**
@@ -12374,7 +12436,7 @@ declare namespace chrome {
     /**
      * Returns the available Tokens. In a regular user's session the list will always contain the user's token with `id` `"user"`. If a system-wide TPM token is available, the returned list will also contain the system-wide token with `id` `"system"`. The system-wide token will be the same for all sessions on this device (device in the sense of e.g. a Chromebook).
      *
-     * @chrome-returns-extra since Pending
+     * @chrome-returns-extra since Chrome 131
      */
     export function getTokens(): Promise<Token[]>;
 
@@ -12396,7 +12458,7 @@ declare namespace chrome {
     /**
      * Returns the list of all client certificates available from the given token. Can be used to check for the existence and expiration of client certificates that are usable for a certain authentication.
      *
-     * @chrome-returns-extra since Pending
+     * @chrome-returns-extra since Chrome 131
      * @param tokenId The id of a Token returned by `getTokens`.
      */
     export function getCertificates(
@@ -12425,7 +12487,7 @@ declare namespace chrome {
     /**
      * Imports `certificate` to the given token if the certified key is already stored in this token. After a successful certification request, this function should be used to store the obtained certificate and to make it available to the operating system and browser for authentication.
      *
-     * @chrome-returns-extra since Pending
+     * @chrome-returns-extra since Chrome 131
      * @param tokenId The id of a Token returned by `getTokens`.
      * @param certificate The DER encoding of a X.509 certificate.
      */
@@ -12455,7 +12517,7 @@ declare namespace chrome {
     /**
      * Removes `certificate` from the given token if present. Should be used to remove obsolete certificates so that they are not considered during authentication and do not clutter the certificate choice. Should be used to free storage in the certificate store.
      *
-     * @chrome-returns-extra since Pending
+     * @chrome-returns-extra since Chrome 131
      * @param tokenId The id of a Token returned by `getTokens`.
      * @param certificate The DER encoding of a X.509 certificate.
      */
@@ -12489,7 +12551,7 @@ declare namespace chrome {
      *
      * This function is highly restricted and will fail if the current device is not managed, the current user is not managed, or if this operation has not explicitly been enabled for the caller by enterprise device policy. The challenged key does not reside in the `"system"` or `"user"` token and is not accessible by any other API.
      *
-     * @chrome-returns-extra since Pending
+     * @chrome-returns-extra since Chrome 131
      * @param options Object containing the fields defined in {@link ChallengeKeyOptions}.
      * @since Chrome 110
      */
@@ -12524,7 +12586,7 @@ declare namespace chrome {
     /**
      * Challenges a hardware-backed Enterprise Machine Key and emits the response as part of a remote attestation protocol. Only useful on ChromeOS and in conjunction with the Verified Access Web API which both issues challenges and verifies responses. A successful verification by the Verified Access Web API is a strong signal of all of the following: \* The current device is a legitimate ChromeOS device. \* The current device is managed by the domain specified during verification. \* The current signed-in user is managed by the domain specified during verification. \* The current device state complies with enterprise device policy. For example, a policy may specify that the device must not be in developer mode. \* Any device identity emitted by the verification is tightly bound to the hardware of the current device. This function is highly restricted and will fail if the current device is not managed, the current user is not managed, or if this operation has not explicitly been enabled for the caller by enterprise device policy. The Enterprise Machine Key does not reside in the `"system"` token and is not accessible by any other API.
      *
-     * @chrome-returns-extra since Pending
+     * @chrome-returns-extra since Chrome 131
      * @param challenge A challenge as emitted by the Verified Access Web API.
      * @param registerKey If set, the current Enterprise Machine Key is registered with the `"system"` token and relinquishes the Enterprise Machine Key role. The key can then be associated with a certificate and used like any other signing key. This key is 2048-bit RSA. Subsequent calls to this function will then generate a new Enterprise Machine Key.
      * @deprecated Use {@link challengeKey} instead.
@@ -12571,7 +12633,7 @@ declare namespace chrome {
     /**
      * Challenges a hardware-backed Enterprise User Key and emits the response as part of a remote attestation protocol. Only useful on ChromeOS and in conjunction with the Verified Access Web API which both issues challenges and verifies responses. A successful verification by the Verified Access Web API is a strong signal of all of the following: \* The current device is a legitimate ChromeOS device. \* The current device is managed by the domain specified during verification. \* The current signed-in user is managed by the domain specified during verification. \* The current device state complies with enterprise user policy. For example, a policy may specify that the device must not be in developer mode. \* The public key emitted by the verification is tightly bound to the hardware of the current device and to the current signed-in user. This function is highly restricted and will fail if the current device is not managed, the current user is not managed, or if this operation has not explicitly been enabled for the caller by enterprise user policy. The Enterprise User Key does not reside in the `"user"` token and is not accessible by any other API.
      *
-     * @chrome-returns-extra since Pending
+     * @chrome-returns-extra since Chrome 131
      * @param challenge A challenge as emitted by the Verified Access Web API.
      * @param registerKey If set, the current Enterprise User Key is registered with the `"user"` token and relinquishes the Enterprise User Key role. The key can then be associated with a certificate and used like any other signing key. This key is 2048-bit RSA. Subsequent calls to this function will then generate a new Enterprise User Key.
      * @deprecated Use {@link challengeKey} instead.
@@ -20551,6 +20613,7 @@ declare namespace chrome {
 
       /**
        * @deprecated Removed in M131. There is no active ARP polling now.
+       * @chrome-deprecated-since Chrome 131
        */
       AllowGatewayARPPolling?: boolean;
 
@@ -32841,14 +32904,14 @@ declare namespace chrome {
     /**
      * Type of requestor.
      *
-     * @since Pending
+     * @since Chrome 131
      */
     export type TtsClientSource = "chromefeature" | "extension";
 
     /**
      * Identifier for the client requesting status.
      *
-     * @since Pending
+     * @since Chrome 131
      */
     export interface TtsClient {
 
@@ -32870,6 +32933,19 @@ declare namespace chrome {
      */
     export type VoiceGender = "male" | "female";
 
+    /**
+     * Options for uninstalling a given language.
+     *
+     * @since Pending
+     */
+    export interface LanguageUninstallOptions {
+
+      /**
+       * True if the TTS client wants the language to be immediately uninstalled. The engine may choose whether or when to uninstall the language, based on this parameter and the requestor information. If false, it may use other criteria, such as recent usage, to determine when to uninstall.
+       */
+      uninstallImmediately: boolean;
+    }
+
     /**
      * The install status of a voice.
      *
@@ -33038,13 +33114,24 @@ declare namespace chrome {
     /**
      * Fired when a TTS client requests to install a new language. The engine should attempt to download and install the language, and call ttsEngine.updateLanguage with the result. On success, the engine should also call ttsEngine.updateVoices to register the newly available voices.
      *
-     * @since Pending
+     * @since Chrome 131
      */
     export const onInstallLanguageRequest: events.Event<(
       requestor: TtsClient,
       lang: string,
     ) => void>;
 
+    /**
+     * Fired when a TTS client indicates a language is no longer needed.
+     *
+     * @since Pending
+     */
+    export const onUninstallLanguageRequest: events.Event<(
+      requestor: TtsClient,
+      lang: string,
+      uninstallOptions: LanguageUninstallOptions,
+    ) => void>;
+
     /**
      * Fired when a TTS client requests the install status of a language.
      *

package/index.d.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-// Generated on Fri Nov 01 2024 22:31:01 GMT+0000 (Coordinated Universal Time)
-// Built at a5c2aaa7e5af3f4ceaea0a606c79e537a859cdae
+// Generated on Thu Nov 07 2024 22:31:22 GMT+0000 (Coordinated Universal Time)
+// Built at ffca9c169a23fc1884e7fda28d3af60c24a6eff2
 
 // Includes MV3+ APIs only.
 
@@ -3763,6 +3763,29 @@ declare namespace chrome {
       partitionKey?: CookiePartitionKey;
     }
 
+    /**
+     * Details to identify the frame.
+     *
+     * @since Pending
+     */
+    export interface FrameDetails {
+
+      /**
+       * The unique identifier for the tab containing the frame.
+       */
+      tabId?: number;
+
+      /**
+       * The unique identifier for the frame within the tab.
+       */
+      frameId?: number;
+
+      /**
+       * The unique identifier for the document. If the frameId and/or tabId are provided they will be validated to match the document found by provided document ID.
+       */
+      documentId?: string;
+    }
+
     /**
      * Fired when a cookie is set or removed. As a special case, note that updating a cookie's properties is implemented as a two step process: the cookie to be updated is first removed entirely, generating a notification with "cause" of "overwrite" . Afterwards, a new cookie is written with the updated values, generating a second notification with "cause" "explicit".
      */
@@ -4163,6 +4186,45 @@ declare namespace chrome {
         cookieStores: CookieStore[],
       ) => void,
     ): void;
+
+    /**
+     * The partition key for the frame indicated.
+     *
+     * @since Pending
+     */
+    export function getPartitionKey(
+
+      details: FrameDetails,
+    ): Promise<{
+
+      /**
+       * The partition key for reading or modifying cookies with the Partitioned attribute.
+       */
+      partitionKey: CookiePartitionKey,
+    }>;
+
+    /**
+     * The partition key for the frame indicated.
+     *
+     * @since Pending
+     */
+    export function getPartitionKey(
+
+      details: FrameDetails,
+
+      /**
+       * @param details Contains details about the partition key that's been retrieved.
+       */
+      callback?: (
+        details: {
+
+          /**
+           * The partition key for reading or modifying cookies with the Partitioned attribute.
+           */
+          partitionKey: CookiePartitionKey,
+        },
+      ) => void,
+    ): void;
   }
 
   /**
@@ -8494,7 +8556,7 @@ declare namespace chrome {
     /**
      * Returns the available Tokens. In a regular user's session the list will always contain the user's token with `id` `"user"`. If a system-wide TPM token is available, the returned list will also contain the system-wide token with `id` `"system"`. The system-wide token will be the same for all sessions on this device (device in the sense of e.g. a Chromebook).
      *
-     * @chrome-returns-extra since Pending
+     * @chrome-returns-extra since Chrome 131
      */
     export function getTokens(): Promise<Token[]>;
 
@@ -8516,7 +8578,7 @@ declare namespace chrome {
     /**
      * Returns the list of all client certificates available from the given token. Can be used to check for the existence and expiration of client certificates that are usable for a certain authentication.
      *
-     * @chrome-returns-extra since Pending
+     * @chrome-returns-extra since Chrome 131
      * @param tokenId The id of a Token returned by `getTokens`.
      */
     export function getCertificates(
@@ -8545,7 +8607,7 @@ declare namespace chrome {
     /**
      * Imports `certificate` to the given token if the certified key is already stored in this token. After a successful certification request, this function should be used to store the obtained certificate and to make it available to the operating system and browser for authentication.
      *
-     * @chrome-returns-extra since Pending
+     * @chrome-returns-extra since Chrome 131
      * @param tokenId The id of a Token returned by `getTokens`.
      * @param certificate The DER encoding of a X.509 certificate.
      */
@@ -8575,7 +8637,7 @@ declare namespace chrome {
     /**
      * Removes `certificate` from the given token if present. Should be used to remove obsolete certificates so that they are not considered during authentication and do not clutter the certificate choice. Should be used to free storage in the certificate store.
      *
-     * @chrome-returns-extra since Pending
+     * @chrome-returns-extra since Chrome 131
      * @param tokenId The id of a Token returned by `getTokens`.
      * @param certificate The DER encoding of a X.509 certificate.
      */
@@ -8609,7 +8671,7 @@ declare namespace chrome {
      *
      * This function is highly restricted and will fail if the current device is not managed, the current user is not managed, or if this operation has not explicitly been enabled for the caller by enterprise device policy. The challenged key does not reside in the `"system"` or `"user"` token and is not accessible by any other API.
      *
-     * @chrome-returns-extra since Pending
+     * @chrome-returns-extra since Chrome 131
      * @param options Object containing the fields defined in {@link ChallengeKeyOptions}.
      * @since Chrome 110
      */
@@ -8644,7 +8706,7 @@ declare namespace chrome {
     /**
      * Challenges a hardware-backed Enterprise Machine Key and emits the response as part of a remote attestation protocol. Only useful on ChromeOS and in conjunction with the Verified Access Web API which both issues challenges and verifies responses. A successful verification by the Verified Access Web API is a strong signal of all of the following: \* The current device is a legitimate ChromeOS device. \* The current device is managed by the domain specified during verification. \* The current signed-in user is managed by the domain specified during verification. \* The current device state complies with enterprise device policy. For example, a policy may specify that the device must not be in developer mode. \* Any device identity emitted by the verification is tightly bound to the hardware of the current device. This function is highly restricted and will fail if the current device is not managed, the current user is not managed, or if this operation has not explicitly been enabled for the caller by enterprise device policy. The Enterprise Machine Key does not reside in the `"system"` token and is not accessible by any other API.
      *
-     * @chrome-returns-extra since Pending
+     * @chrome-returns-extra since Chrome 131
      * @param challenge A challenge as emitted by the Verified Access Web API.
      * @param registerKey If set, the current Enterprise Machine Key is registered with the `"system"` token and relinquishes the Enterprise Machine Key role. The key can then be associated with a certificate and used like any other signing key. This key is 2048-bit RSA. Subsequent calls to this function will then generate a new Enterprise Machine Key.
      * @deprecated Use {@link challengeKey} instead.
@@ -8691,7 +8753,7 @@ declare namespace chrome {
     /**
      * Challenges a hardware-backed Enterprise User Key and emits the response as part of a remote attestation protocol. Only useful on ChromeOS and in conjunction with the Verified Access Web API which both issues challenges and verifies responses. A successful verification by the Verified Access Web API is a strong signal of all of the following: \* The current device is a legitimate ChromeOS device. \* The current device is managed by the domain specified during verification. \* The current signed-in user is managed by the domain specified during verification. \* The current device state complies with enterprise user policy. For example, a policy may specify that the device must not be in developer mode. \* The public key emitted by the verification is tightly bound to the hardware of the current device and to the current signed-in user. This function is highly restricted and will fail if the current device is not managed, the current user is not managed, or if this operation has not explicitly been enabled for the caller by enterprise user policy. The Enterprise User Key does not reside in the `"user"` token and is not accessible by any other API.
      *
-     * @chrome-returns-extra since Pending
+     * @chrome-returns-extra since Chrome 131
      * @param challenge A challenge as emitted by the Verified Access Web API.
      * @param registerKey If set, the current Enterprise User Key is registered with the `"user"` token and relinquishes the Enterprise User Key role. The key can then be associated with a certificate and used like any other signing key. This key is 2048-bit RSA. Subsequent calls to this function will then generate a new Enterprise User Key.
      * @deprecated Use {@link challengeKey} instead.
@@ -25680,14 +25742,14 @@ declare namespace chrome {
     /**
      * Type of requestor.
      *
-     * @since Pending
+     * @since Chrome 131
      */
     export type TtsClientSource = "chromefeature" | "extension";
 
     /**
      * Identifier for the client requesting status.
      *
-     * @since Pending
+     * @since Chrome 131
      */
     export interface TtsClient {
 
@@ -25709,6 +25771,19 @@ declare namespace chrome {
      */
     export type VoiceGender = "male" | "female";
 
+    /**
+     * Options for uninstalling a given language.
+     *
+     * @since Pending
+     */
+    export interface LanguageUninstallOptions {
+
+      /**
+       * True if the TTS client wants the language to be immediately uninstalled. The engine may choose whether or when to uninstall the language, based on this parameter and the requestor information. If false, it may use other criteria, such as recent usage, to determine when to uninstall.
+       */
+      uninstallImmediately: boolean;
+    }
+
     /**
      * The install status of a voice.
      *
@@ -25877,13 +25952,24 @@ declare namespace chrome {
     /**
      * Fired when a TTS client requests to install a new language. The engine should attempt to download and install the language, and call ttsEngine.updateLanguage with the result. On success, the engine should also call ttsEngine.updateVoices to register the newly available voices.
      *
-     * @since Pending
+     * @since Chrome 131
      */
     export const onInstallLanguageRequest: events.Event<(
       requestor: TtsClient,
       lang: string,
     ) => void>;
 
+    /**
+     * Fired when a TTS client indicates a language is no longer needed.
+     *
+     * @since Pending
+     */
+    export const onUninstallLanguageRequest: events.Event<(
+      requestor: TtsClient,
+      lang: string,
+      uninstallOptions: LanguageUninstallOptions,
+    ) => void>;
+
     /**
      * Fired when a TTS client requests the install status of a language.
      *

package/package.json

@@ -5,7 +5,7 @@
   "type": "module",
   "name": "chrome-types",
   "config": {
-    "build-hash": "157f9e4b406d81b5"
+    "build-hash": "cc7b059b8ae82b7b"
   },
   "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.315"
+  "version": "0.1.317"
 }