@girs/peas-2 2.0.0-3.2.4 → 2.0.0-3.2.6

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/peas-2)
 
 
-GJS TypeScript type definitions for Peas-2, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.4.
+GJS TypeScript type definitions for Peas-2, generated from library version 2.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.6.
 
 
 ## Install
@@ -81,6 +81,19 @@ Now you have also type support for this, too:
 const Peas = imports.gi.Peas;
 ```
 
+
+### 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/peas-2",
-  "version": "2.0.0-3.2.4",
+  "version": "2.0.0-3.2.6",
   "description": "GJS TypeScript type definitions for Peas-2, generated from library version 2.0.0",
   "type": "module",
   "module": "peas-2.js",
@@ -25,11 +25,11 @@
     "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit peas-2.d.cts"
   },
   "dependencies": {
-    "@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/gmodule-2.0": "^2.0.0-3.2.4",
-    "@girs/gobject-2.0": "^2.78.0-3.2.4"
+    "@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/gmodule-2.0": "^2.0.0-3.2.6",
+    "@girs/gobject-2.0": "^2.78.0-3.2.6"
   },
   "devDependencies": {
     "typescript": "*"

package/peas-2-ambient.d.ts

@@ -1,9 +1,12 @@
 
-
 declare module 'gi://Peas?version=2' {
     import Peas2 from '@girs/peas-2';
     export default Peas2;
 }
 
+declare module 'gi://Peas' {
+    import Peas2 from '@girs/peas-2';
+    export default Peas2;
+}
 
 

package/peas-2-import.d.ts

@@ -1,5 +1,4 @@
 
-
 import Peas2 from '@girs/peas-2';
 
 declare global {

package/peas-2.d.cts

@@ -114,6 +114,32 @@ export module Engine {
          * See [ctor`Engine`.new_with_nonglobal_loaders] for more information.
          */
         nonglobal_loaders?: boolean | null
+        /**
+         * The list of loaded plugins.
+         * 
+         * This will be modified when [method`Engine`.load_plugin] or
+         * [method`Engine`.unload_plugin] is called.
+         * 
+         * This can be used with [class`Gio`.Settings] to save the loaded plugins by
+         * binding to this property after instantiating the engine by doing:
+         * 
+         * ```c
+         *   g_settings_bind (gsettings_object,
+         *                    LOADED_PLUGINS_KEY,
+         *                    engine,
+         *                    "loaded-plugins",
+         *                    G_SETTINGS_BIND_DEFAULT);
+         * ```
+         * 
+         * Note: notify will not be called when the engine is being destroyed.
+         */
+        loadedPlugins?: string[] | null
+        /**
+         * If non-global plugin loaders should be used.
+         * 
+         * See [ctor`Engine`.new_with_nonglobal_loaders] for more information.
+         */
+        nonglobalLoaders?: boolean | null
     }
 
 }
@@ -142,12 +168,38 @@ export interface Engine extends Gio.ListModel {
      * Note: notify will not be called when the engine is being destroyed.
      */
     loaded_plugins: string[]
+    /**
+     * The list of loaded plugins.
+     * 
+     * This will be modified when [method`Engine`.load_plugin] or
+     * [method`Engine`.unload_plugin] is called.
+     * 
+     * This can be used with [class`Gio`.Settings] to save the loaded plugins by
+     * binding to this property after instantiating the engine by doing:
+     * 
+     * ```c
+     *   g_settings_bind (gsettings_object,
+     *                    LOADED_PLUGINS_KEY,
+     *                    engine,
+     *                    "loaded-plugins",
+     *                    G_SETTINGS_BIND_DEFAULT);
+     * ```
+     * 
+     * Note: notify will not be called when the engine is being destroyed.
+     */
+    loadedPlugins: string[]
     /**
      * If non-global plugin loaders should be used.
      * 
      * See [ctor`Engine`.new_with_nonglobal_loaders] for more information.
      */
     readonly nonglobal_loaders: boolean
+    /**
+     * If non-global plugin loaders should be used.
+     * 
+     * See [ctor`Engine`.new_with_nonglobal_loaders] for more information.
+     */
+    readonly nonglobalLoaders: boolean
 
     // Owm methods of Peas-2.Peas.Engine
 
@@ -380,6 +432,10 @@ export module ExtensionBase {
          * The [class`PluginInfo]` related to the current plugin.
          */
         plugin_info?: PluginInfo | null
+        /**
+         * The [class`PluginInfo]` related to the current plugin.
+         */
+        pluginInfo?: PluginInfo | null
     }
 
 }
@@ -396,10 +452,22 @@ export interface ExtensionBase {
      * [method`PluginInfo`.get_data_dir].
      */
     readonly data_dir: string | null
+    /**
+     * The The full path of the directory where the plugin
+     * should look for its data files.
+     * 
+     * Note: This is the same path as that returned by
+     * [method`PluginInfo`.get_data_dir].
+     */
+    readonly dataDir: string | null
     /**
      * The [class`PluginInfo]` related to the current plugin.
      */
     readonly plugin_info: PluginInfo
+    /**
+     * The [class`PluginInfo]` related to the current plugin.
+     */
+    readonly pluginInfo: PluginInfo
 
     // Own fields of Peas-2.Peas.ExtensionBase
 
@@ -487,6 +555,8 @@ export module ExtensionSet {
         construct_properties?: any | null
         engine?: Engine | null
         extension_type?: GObject.GType | null
+        constructProperties?: any | null
+        extensionType?: GObject.GType | null
     }
 
 }
@@ -496,8 +566,10 @@ export interface ExtensionSet extends Gio.ListModel {
     // Own properties of Peas-2.Peas.ExtensionSet
 
     readonly construct_properties: any
+    readonly constructProperties: any
     readonly engine: Engine
     readonly extension_type: GObject.GType
+    readonly extensionType: GObject.GType
 
     // Owm methods of Peas-2.Peas.ExtensionSet
 
@@ -652,6 +724,11 @@ export module ObjectModule {
         path?: string | null
         resident?: boolean | null
         symbol?: string | null
+        /**
+         * Whether the module is loaded with local linkage, i.e. #G_MODULE_BIND_LOCAL.
+         */
+        localLinkage?: boolean | null
+        moduleName?: string | null
     }
 
 }
@@ -664,7 +741,12 @@ export interface ObjectModule extends GObject.TypePlugin {
      * Whether the module is loaded with local linkage, i.e. #G_MODULE_BIND_LOCAL.
      */
     readonly local_linkage: boolean
+    /**
+     * Whether the module is loaded with local linkage, i.e. #G_MODULE_BIND_LOCAL.
+     */
+    readonly localLinkage: boolean
     readonly module_name: string | null
+    readonly moduleName: string | null
     readonly path: string | null
     readonly resident: boolean
     readonly symbol: string | null
@@ -785,11 +867,15 @@ export interface PluginInfo {
     readonly dependencies: string[]
     readonly description: string | null
     readonly help_uri: string | null
+    readonly helpUri: string | null
     readonly hidden: boolean
     readonly icon_name: string | null
+    readonly iconName: string | null
     readonly loaded: boolean
     readonly module_dir: string | null
+    readonly moduleDir: string | null
     readonly module_name: string | null
+    readonly moduleName: string | null
     readonly name: string | null
     readonly version: string | null
     readonly website: string | null

package/peas-2.d.ts

@@ -116,6 +116,32 @@ module Engine {
          * See [ctor`Engine`.new_with_nonglobal_loaders] for more information.
          */
         nonglobal_loaders?: boolean | null
+        /**
+         * The list of loaded plugins.
+         * 
+         * This will be modified when [method`Engine`.load_plugin] or
+         * [method`Engine`.unload_plugin] is called.
+         * 
+         * This can be used with [class`Gio`.Settings] to save the loaded plugins by
+         * binding to this property after instantiating the engine by doing:
+         * 
+         * ```c
+         *   g_settings_bind (gsettings_object,
+         *                    LOADED_PLUGINS_KEY,
+         *                    engine,
+         *                    "loaded-plugins",
+         *                    G_SETTINGS_BIND_DEFAULT);
+         * ```
+         * 
+         * Note: notify will not be called when the engine is being destroyed.
+         */
+        loadedPlugins?: string[] | null
+        /**
+         * If non-global plugin loaders should be used.
+         * 
+         * See [ctor`Engine`.new_with_nonglobal_loaders] for more information.
+         */
+        nonglobalLoaders?: boolean | null
     }
 
 }
@@ -144,12 +170,38 @@ interface Engine extends Gio.ListModel {
      * Note: notify will not be called when the engine is being destroyed.
      */
     loaded_plugins: string[]
+    /**
+     * The list of loaded plugins.
+     * 
+     * This will be modified when [method`Engine`.load_plugin] or
+     * [method`Engine`.unload_plugin] is called.
+     * 
+     * This can be used with [class`Gio`.Settings] to save the loaded plugins by
+     * binding to this property after instantiating the engine by doing:
+     * 
+     * ```c
+     *   g_settings_bind (gsettings_object,
+     *                    LOADED_PLUGINS_KEY,
+     *                    engine,
+     *                    "loaded-plugins",
+     *                    G_SETTINGS_BIND_DEFAULT);
+     * ```
+     * 
+     * Note: notify will not be called when the engine is being destroyed.
+     */
+    loadedPlugins: string[]
     /**
      * If non-global plugin loaders should be used.
      * 
      * See [ctor`Engine`.new_with_nonglobal_loaders] for more information.
      */
     readonly nonglobal_loaders: boolean
+    /**
+     * If non-global plugin loaders should be used.
+     * 
+     * See [ctor`Engine`.new_with_nonglobal_loaders] for more information.
+     */
+    readonly nonglobalLoaders: boolean
 
     // Owm methods of Peas-2.Peas.Engine
 
@@ -382,6 +434,10 @@ module ExtensionBase {
          * The [class`PluginInfo]` related to the current plugin.
          */
         plugin_info?: PluginInfo | null
+        /**
+         * The [class`PluginInfo]` related to the current plugin.
+         */
+        pluginInfo?: PluginInfo | null
     }
 
 }
@@ -398,10 +454,22 @@ interface ExtensionBase {
      * [method`PluginInfo`.get_data_dir].
      */
     readonly data_dir: string | null
+    /**
+     * The The full path of the directory where the plugin
+     * should look for its data files.
+     * 
+     * Note: This is the same path as that returned by
+     * [method`PluginInfo`.get_data_dir].
+     */
+    readonly dataDir: string | null
     /**
      * The [class`PluginInfo]` related to the current plugin.
      */
     readonly plugin_info: PluginInfo
+    /**
+     * The [class`PluginInfo]` related to the current plugin.
+     */
+    readonly pluginInfo: PluginInfo
 
     // Own fields of Peas-2.Peas.ExtensionBase
 
@@ -489,6 +557,8 @@ module ExtensionSet {
         construct_properties?: any | null
         engine?: Engine | null
         extension_type?: GObject.GType | null
+        constructProperties?: any | null
+        extensionType?: GObject.GType | null
     }
 
 }
@@ -498,8 +568,10 @@ interface ExtensionSet extends Gio.ListModel {
     // Own properties of Peas-2.Peas.ExtensionSet
 
     readonly construct_properties: any
+    readonly constructProperties: any
     readonly engine: Engine
     readonly extension_type: GObject.GType
+    readonly extensionType: GObject.GType
 
     // Owm methods of Peas-2.Peas.ExtensionSet
 
@@ -654,6 +726,11 @@ module ObjectModule {
         path?: string | null
         resident?: boolean | null
         symbol?: string | null
+        /**
+         * Whether the module is loaded with local linkage, i.e. #G_MODULE_BIND_LOCAL.
+         */
+        localLinkage?: boolean | null
+        moduleName?: string | null
     }
 
 }
@@ -666,7 +743,12 @@ interface ObjectModule extends GObject.TypePlugin {
      * Whether the module is loaded with local linkage, i.e. #G_MODULE_BIND_LOCAL.
      */
     readonly local_linkage: boolean
+    /**
+     * Whether the module is loaded with local linkage, i.e. #G_MODULE_BIND_LOCAL.
+     */
+    readonly localLinkage: boolean
     readonly module_name: string | null
+    readonly moduleName: string | null
     readonly path: string | null
     readonly resident: boolean
     readonly symbol: string | null
@@ -787,11 +869,15 @@ interface PluginInfo {
     readonly dependencies: string[]
     readonly description: string | null
     readonly help_uri: string | null
+    readonly helpUri: string | null
     readonly hidden: boolean
     readonly icon_name: string | null
+    readonly iconName: string | null
     readonly loaded: boolean
     readonly module_dir: string | null
+    readonly moduleDir: string | null
     readonly module_name: string | null
+    readonly moduleName: string | null
     readonly name: string | null
     readonly version: string | null
     readonly website: string | null