@girs/gcr-3 3.41.0-3.2.4 → 3.41.0-3.2.6

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/gcr-3)
 
 
-GJS TypeScript type definitions for Gcr-3, generated from library version 3.41.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.4.
+GJS TypeScript type definitions for Gcr-3, generated from library version 3.41.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.6.
 
 A library for bits of crypto UI and parsing
 
@@ -82,6 +82,19 @@ Now you have also type support for this, too:
 const Gcr = imports.gi.Gcr;
 ```
 
+
+### ESM vs. CommonJS
+
+GJS supports two different import syntaxes. The new modern ESM syntax and the old global imports syntax.
+
+In TypeScript projects for GJS and GNOME Shell extensions, you have the flexibility to use `ESM` syntax and then decide the import syntax for your bundled file. If your bundler is configured to use `CommonJS`, it will convert to the GJS-specific global imports syntax, like `const moduleName = imports.gi[moduleName]`. This is different from the traditional `require` syntax seen in Node.js. The global imports syntax is chosen because it aligns with the CommonJS format supported by NPM, which is used for the generated type definitions and this package.
+
+On the other hand, if you configure your bundler to use ESM, it will retain the ESM import syntax. It's crucial to ensure that your bundler is set up to correctly translate and bundle these imports into either CommonJS or ESM format, depending on your project's requirements.
+
+This approach is particularly important due to the `@girs` types, which include both `*.cjs `files, using the GJS global imports syntax, and `*.js` files, which utilize the ESM syntax. By appropriately setting up your bundler, you can control which syntax—CommonJS or ESM—is used in your project. The choice of CommonJS in this context is also due to the similarity between the GJS-specific global imports and CommonJS syntax, allowing for easier management and bundling in these specific types of projects.
+
+Since GNOME Shell 45, you should only use ESM, even for GNOME Shell extensions. Before that, extensions had to use the global import syntax, unlike normal GJS applications, where ESM has been available for some time.
+
 ### Bundle
 
 Depending on your project configuration, it is recommended to use a bundler like [esbuild](https://esbuild.github.io/). You can find examples using different bundlers [here](https://github.com/gjsify/ts-for-gir/tree/main/examples).

package/gcr-3-ambient.d.ts

@@ -1,9 +1,12 @@
 
-
 declare module 'gi://Gcr?version=3' {
     import Gcr3 from '@girs/gcr-3';
     export default Gcr3;
 }
 
+declare module 'gi://Gcr' {
+    import Gcr3 from '@girs/gcr-3';
+    export default Gcr3;
+}
 
 

package/gcr-3-import.d.ts

@@ -1,5 +1,4 @@
 
-
 import Gcr3 from '@girs/gcr-3';
 
 declare global {

package/gcr-3.d.cts

@@ -1778,6 +1778,51 @@ export module Prompt {
          * user about a previous 'unsuccessful' prompt.
          */
         warning?: string | null
+        /**
+         * The string handle of the caller's window.
+         * 
+         * The caller window indicates to the prompt which window is prompting the
+         * user. The prompt may choose to ignore this information or use it in whatever
+         * way it sees fit.
+         * 
+         * In X11, this will be a stringified version of the XWindow handle; in
+         * Wayland this is the result of an export using the XDG foreign
+         * protocol.
+         */
+        callerWindow?: string | null
+        /**
+         * The label for the cancel button in the prompt.
+         */
+        cancelLabel?: string | null
+        /**
+         * Whether the additional choice is chosen or not.
+         * 
+         * The additional choice would have been setup using #GcrPrompt:choice-label.
+         */
+        choiceChosen?: boolean | null
+        /**
+         * The label for the additional choice.
+         * 
+         * If this is a non-%NULL value then an additional boolean choice will be
+         * displayed by the prompt allowing the user to select or deselect it.
+         * 
+         * If %NULL, then no additional choice is displayed.
+         * 
+         * The initial value of the choice can be set with #GcrPrompt:choice-chosen.
+         */
+        choiceLabel?: string | null
+        /**
+         * The label for the continue button in the prompt.
+         */
+        continueLabel?: string | null
+        /**
+         * Whether the prompt will prompt for a new password.
+         * 
+         * This will cause the prompt implementation to ask the user to confirm the
+         * password and/or display other relevant user interface for creating a new
+         * password.
+         */
+        passwordNew?: boolean | null
     }
 
 }
@@ -1798,16 +1843,38 @@ export interface Prompt {
      * protocol.
      */
     caller_window: string | null
+    /**
+     * The string handle of the caller's window.
+     * 
+     * The caller window indicates to the prompt which window is prompting the
+     * user. The prompt may choose to ignore this information or use it in whatever
+     * way it sees fit.
+     * 
+     * In X11, this will be a stringified version of the XWindow handle; in
+     * Wayland this is the result of an export using the XDG foreign
+     * protocol.
+     */
+    callerWindow: string | null
     /**
      * The label for the cancel button in the prompt.
      */
     cancel_label: string | null
+    /**
+     * The label for the cancel button in the prompt.
+     */
+    cancelLabel: string | null
     /**
      * Whether the additional choice is chosen or not.
      * 
      * The additional choice would have been setup using #GcrPrompt:choice-label.
      */
     choice_chosen: boolean
+    /**
+     * Whether the additional choice is chosen or not.
+     * 
+     * The additional choice would have been setup using #GcrPrompt:choice-label.
+     */
+    choiceChosen: boolean
     /**
      * The label for the additional choice.
      * 
@@ -1819,10 +1886,25 @@ export interface Prompt {
      * The initial value of the choice can be set with #GcrPrompt:choice-chosen.
      */
     choice_label: string | null
+    /**
+     * The label for the additional choice.
+     * 
+     * If this is a non-%NULL value then an additional boolean choice will be
+     * displayed by the prompt allowing the user to select or deselect it.
+     * 
+     * If %NULL, then no additional choice is displayed.
+     * 
+     * The initial value of the choice can be set with #GcrPrompt:choice-chosen.
+     */
+    choiceLabel: string | null
     /**
      * The label for the continue button in the prompt.
      */
     continue_label: string | null
+    /**
+     * The label for the continue button in the prompt.
+     */
+    continueLabel: string | null
     /**
      * The detailed description of the prompt.
      * 
@@ -1844,6 +1926,14 @@ export interface Prompt {
      * password.
      */
     password_new: boolean
+    /**
+     * Whether the prompt will prompt for a new password.
+     * 
+     * This will cause the prompt implementation to ask the user to confirm the
+     * password and/or display other relevant user interface for creating a new
+     * password.
+     */
+    passwordNew: boolean
     /**
      * Indication of the password strength.
      * 
@@ -1853,6 +1943,15 @@ export interface Prompt {
      * This is only valid after a successful prompt for a password.
      */
     readonly password_strength: number
+    /**
+     * Indication of the password strength.
+     * 
+     * Prompts will return a zero value if the password is empty, and a value
+     * greater than zero if the password has any characters.
+     * 
+     * This is only valid after a successful prompt for a password.
+     */
+    readonly passwordStrength: number
     /**
      * The title of the prompt.
      * 
@@ -2610,6 +2709,10 @@ export module CertificateRequest {
          * The private key that this certificate request is for.
          */
         private_key?: Gck.Object | null
+        /**
+         * The private key that this certificate request is for.
+         */
+        privateKey?: Gck.Object | null
     }
 
 }
@@ -2622,6 +2725,10 @@ export interface CertificateRequest {
      * The private key that this certificate request is for.
      */
     readonly private_key: Gck.Object
+    /**
+     * The private key that this certificate request is for.
+     */
+    readonly privateKey: Gck.Object
 
     // Owm methods of Gcr-3.Gcr.CertificateRequest
 
@@ -2889,16 +2996,31 @@ export interface Parser {
      * generally only valid during a #GcrParser::parsed signal.
      */
     readonly parsed_attributes: Gck.Attributes
+    /**
+     * Get the attributes that make up the currently parsed item. This is
+     * generally only valid during a #GcrParser::parsed signal.
+     */
+    readonly parsedAttributes: Gck.Attributes
     /**
      * The description of the type of the currently parsed item. This is generally
      * only valid during a #GcrParser::parsed signal.
      */
     readonly parsed_description: string | null
+    /**
+     * The description of the type of the currently parsed item. This is generally
+     * only valid during a #GcrParser::parsed signal.
+     */
+    readonly parsedDescription: string | null
     /**
      * The label of the currently parsed item. This is generally
      * only valid during a #GcrParser::parsed signal.
      */
     readonly parsed_label: string | null
+    /**
+     * The label of the currently parsed item. This is generally
+     * only valid during a #GcrParser::parsed signal.
+     */
+    readonly parsedLabel: string | null
 
     // Own fields of Gcr-3.Gcr.Parser
 
@@ -3710,6 +3832,20 @@ export module SystemPrompt {
          * The timeout in seconds to wait when opening the prompt.
          */
         timeout_seconds?: number | null
+        /**
+         * The DBus bus name of the prompter to use for prompting, or %NULL
+         * for the default prompter.
+         */
+        busName?: string | null
+        /**
+         * The #GcrSecretExchange to use when transferring passwords. A default
+         * secret exchange will be used if this is not set.
+         */
+        secretExchange?: SecretExchange | null
+        /**
+         * The timeout in seconds to wait when opening the prompt.
+         */
+        timeoutSeconds?: number | null
     }
 
 }
@@ -3723,15 +3859,29 @@ export interface SystemPrompt extends Prompt, Gio.AsyncInitable, Gio.Initable {
      * for the default prompter.
      */
     readonly bus_name: string | null
+    /**
+     * The DBus bus name of the prompter to use for prompting, or %NULL
+     * for the default prompter.
+     */
+    readonly busName: string | null
     /**
      * The #GcrSecretExchange to use when transferring passwords. A default
      * secret exchange will be used if this is not set.
      */
     secret_exchange: SecretExchange
+    /**
+     * The #GcrSecretExchange to use when transferring passwords. A default
+     * secret exchange will be used if this is not set.
+     */
+    secretExchange: SecretExchange
     /**
      * The timeout in seconds to wait when opening the prompt.
      */
     readonly timeout_seconds: number
+    /**
+     * The timeout in seconds to wait when opening the prompt.
+     */
+    readonly timeoutSeconds: number
 
     // Own fields of Gcr-3.Gcr.SystemPrompt
 
@@ -3972,6 +4122,11 @@ export module SystemPrompter {
          * #GcrPrompt implementation.
          */
         prompt_type?: GObject.GType | null
+        /**
+         * The #GType for prompts created by this prompter. This must be a
+         * #GcrPrompt implementation.
+         */
+        promptType?: GObject.GType | null
     }
 
 }
@@ -3985,6 +4140,11 @@ export interface SystemPrompter {
      * #GcrPrompt implementation.
      */
     readonly prompt_type: GObject.GType
+    /**
+     * The #GType for prompts created by this prompter. This must be a
+     * #GcrPrompt implementation.
+     */
+    readonly promptType: GObject.GType
     /**
      * Whether the prompter is prompting or not.
      */

package/gcr-3.d.ts

@@ -1780,6 +1780,51 @@ module Prompt {
          * user about a previous 'unsuccessful' prompt.
          */
         warning?: string | null
+        /**
+         * The string handle of the caller's window.
+         * 
+         * The caller window indicates to the prompt which window is prompting the
+         * user. The prompt may choose to ignore this information or use it in whatever
+         * way it sees fit.
+         * 
+         * In X11, this will be a stringified version of the XWindow handle; in
+         * Wayland this is the result of an export using the XDG foreign
+         * protocol.
+         */
+        callerWindow?: string | null
+        /**
+         * The label for the cancel button in the prompt.
+         */
+        cancelLabel?: string | null
+        /**
+         * Whether the additional choice is chosen or not.
+         * 
+         * The additional choice would have been setup using #GcrPrompt:choice-label.
+         */
+        choiceChosen?: boolean | null
+        /**
+         * The label for the additional choice.
+         * 
+         * If this is a non-%NULL value then an additional boolean choice will be
+         * displayed by the prompt allowing the user to select or deselect it.
+         * 
+         * If %NULL, then no additional choice is displayed.
+         * 
+         * The initial value of the choice can be set with #GcrPrompt:choice-chosen.
+         */
+        choiceLabel?: string | null
+        /**
+         * The label for the continue button in the prompt.
+         */
+        continueLabel?: string | null
+        /**
+         * Whether the prompt will prompt for a new password.
+         * 
+         * This will cause the prompt implementation to ask the user to confirm the
+         * password and/or display other relevant user interface for creating a new
+         * password.
+         */
+        passwordNew?: boolean | null
     }
 
 }
@@ -1800,16 +1845,38 @@ interface Prompt {
      * protocol.
      */
     caller_window: string | null
+    /**
+     * The string handle of the caller's window.
+     * 
+     * The caller window indicates to the prompt which window is prompting the
+     * user. The prompt may choose to ignore this information or use it in whatever
+     * way it sees fit.
+     * 
+     * In X11, this will be a stringified version of the XWindow handle; in
+     * Wayland this is the result of an export using the XDG foreign
+     * protocol.
+     */
+    callerWindow: string | null
     /**
      * The label for the cancel button in the prompt.
      */
     cancel_label: string | null
+    /**
+     * The label for the cancel button in the prompt.
+     */
+    cancelLabel: string | null
     /**
      * Whether the additional choice is chosen or not.
      * 
      * The additional choice would have been setup using #GcrPrompt:choice-label.
      */
     choice_chosen: boolean
+    /**
+     * Whether the additional choice is chosen or not.
+     * 
+     * The additional choice would have been setup using #GcrPrompt:choice-label.
+     */
+    choiceChosen: boolean
     /**
      * The label for the additional choice.
      * 
@@ -1821,10 +1888,25 @@ interface Prompt {
      * The initial value of the choice can be set with #GcrPrompt:choice-chosen.
      */
     choice_label: string | null
+    /**
+     * The label for the additional choice.
+     * 
+     * If this is a non-%NULL value then an additional boolean choice will be
+     * displayed by the prompt allowing the user to select or deselect it.
+     * 
+     * If %NULL, then no additional choice is displayed.
+     * 
+     * The initial value of the choice can be set with #GcrPrompt:choice-chosen.
+     */
+    choiceLabel: string | null
     /**
      * The label for the continue button in the prompt.
      */
     continue_label: string | null
+    /**
+     * The label for the continue button in the prompt.
+     */
+    continueLabel: string | null
     /**
      * The detailed description of the prompt.
      * 
@@ -1846,6 +1928,14 @@ interface Prompt {
      * password.
      */
     password_new: boolean
+    /**
+     * Whether the prompt will prompt for a new password.
+     * 
+     * This will cause the prompt implementation to ask the user to confirm the
+     * password and/or display other relevant user interface for creating a new
+     * password.
+     */
+    passwordNew: boolean
     /**
      * Indication of the password strength.
      * 
@@ -1855,6 +1945,15 @@ interface Prompt {
      * This is only valid after a successful prompt for a password.
      */
     readonly password_strength: number
+    /**
+     * Indication of the password strength.
+     * 
+     * Prompts will return a zero value if the password is empty, and a value
+     * greater than zero if the password has any characters.
+     * 
+     * This is only valid after a successful prompt for a password.
+     */
+    readonly passwordStrength: number
     /**
      * The title of the prompt.
      * 
@@ -2612,6 +2711,10 @@ module CertificateRequest {
          * The private key that this certificate request is for.
          */
         private_key?: Gck.Object | null
+        /**
+         * The private key that this certificate request is for.
+         */
+        privateKey?: Gck.Object | null
     }
 
 }
@@ -2624,6 +2727,10 @@ interface CertificateRequest {
      * The private key that this certificate request is for.
      */
     readonly private_key: Gck.Object
+    /**
+     * The private key that this certificate request is for.
+     */
+    readonly privateKey: Gck.Object
 
     // Owm methods of Gcr-3.Gcr.CertificateRequest
 
@@ -2891,16 +2998,31 @@ interface Parser {
      * generally only valid during a #GcrParser::parsed signal.
      */
     readonly parsed_attributes: Gck.Attributes
+    /**
+     * Get the attributes that make up the currently parsed item. This is
+     * generally only valid during a #GcrParser::parsed signal.
+     */
+    readonly parsedAttributes: Gck.Attributes
     /**
      * The description of the type of the currently parsed item. This is generally
      * only valid during a #GcrParser::parsed signal.
      */
     readonly parsed_description: string | null
+    /**
+     * The description of the type of the currently parsed item. This is generally
+     * only valid during a #GcrParser::parsed signal.
+     */
+    readonly parsedDescription: string | null
     /**
      * The label of the currently parsed item. This is generally
      * only valid during a #GcrParser::parsed signal.
      */
     readonly parsed_label: string | null
+    /**
+     * The label of the currently parsed item. This is generally
+     * only valid during a #GcrParser::parsed signal.
+     */
+    readonly parsedLabel: string | null
 
     // Own fields of Gcr-3.Gcr.Parser
 
@@ -3712,6 +3834,20 @@ module SystemPrompt {
          * The timeout in seconds to wait when opening the prompt.
          */
         timeout_seconds?: number | null
+        /**
+         * The DBus bus name of the prompter to use for prompting, or %NULL
+         * for the default prompter.
+         */
+        busName?: string | null
+        /**
+         * The #GcrSecretExchange to use when transferring passwords. A default
+         * secret exchange will be used if this is not set.
+         */
+        secretExchange?: SecretExchange | null
+        /**
+         * The timeout in seconds to wait when opening the prompt.
+         */
+        timeoutSeconds?: number | null
     }
 
 }
@@ -3725,15 +3861,29 @@ interface SystemPrompt extends Prompt, Gio.AsyncInitable, Gio.Initable {
      * for the default prompter.
      */
     readonly bus_name: string | null
+    /**
+     * The DBus bus name of the prompter to use for prompting, or %NULL
+     * for the default prompter.
+     */
+    readonly busName: string | null
     /**
      * The #GcrSecretExchange to use when transferring passwords. A default
      * secret exchange will be used if this is not set.
      */
     secret_exchange: SecretExchange
+    /**
+     * The #GcrSecretExchange to use when transferring passwords. A default
+     * secret exchange will be used if this is not set.
+     */
+    secretExchange: SecretExchange
     /**
      * The timeout in seconds to wait when opening the prompt.
      */
     readonly timeout_seconds: number
+    /**
+     * The timeout in seconds to wait when opening the prompt.
+     */
+    readonly timeoutSeconds: number
 
     // Own fields of Gcr-3.Gcr.SystemPrompt
 
@@ -3974,6 +4124,11 @@ module SystemPrompter {
          * #GcrPrompt implementation.
          */
         prompt_type?: GObject.GType | null
+        /**
+         * The #GType for prompts created by this prompter. This must be a
+         * #GcrPrompt implementation.
+         */
+        promptType?: GObject.GType | null
     }
 
 }
@@ -3987,6 +4142,11 @@ interface SystemPrompter {
      * #GcrPrompt implementation.
      */
     readonly prompt_type: GObject.GType
+    /**
+     * The #GType for prompts created by this prompter. This must be a
+     * #GcrPrompt implementation.
+     */
+    readonly promptType: GObject.GType
     /**
      * Whether the prompter is prompting or not.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/gcr-3",
-  "version": "3.41.0-3.2.4",
+  "version": "3.41.0-3.2.6",
   "description": "GJS TypeScript type definitions for Gcr-3, generated from library version 3.41.0",
   "type": "module",
   "module": "gcr-3.js",
@@ -25,11 +25,11 @@
     "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit gcr-3.d.cts"
   },
   "dependencies": {
-    "@girs/gck-1": "^1.0.0-3.2.4",
-    "@girs/gio-2.0": "^2.78.0-3.2.4",
-    "@girs/gjs": "^3.2.4",
-    "@girs/glib-2.0": "^2.78.0-3.2.4",
-    "@girs/gobject-2.0": "^2.78.0-3.2.4"
+    "@girs/gck-1": "^1.0.0-3.2.6",
+    "@girs/gio-2.0": "^2.78.0-3.2.6",
+    "@girs/gjs": "^3.2.6",
+    "@girs/glib-2.0": "^2.78.0-3.2.6",
+    "@girs/gobject-2.0": "^2.78.0-3.2.6"
   },
   "devDependencies": {
     "typescript": "*"