@girs/grl-0.1 0.1.0-3.2.4 → 0.1.0-3.2.6

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/grl-0.1)
 
 
-GJS TypeScript type definitions for Grl-0.1, generated from library version 0.1.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.4.
+GJS TypeScript type definitions for Grl-0.1, generated from library version 0.1.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 Grl = imports.gi.Grl;
 ```
 
+
+### 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/grl-0.1-ambient.d.ts

@@ -1,9 +1,12 @@
 
-
 declare module 'gi://Grl?version=0.1' {
     import Grl01 from '@girs/grl-0.1';
     export default Grl01;
 }
 
+declare module 'gi://Grl' {
+    import Grl01 from '@girs/grl-0.1';
+    export default Grl01;
+}
 
 

package/grl-0.1-import.d.ts

@@ -1,5 +1,4 @@
 
-
 import Grl01 from '@girs/grl-0.1';
 
 declare global {

package/grl-0.1.d.cts

@@ -1590,6 +1590,11 @@ export module MediaSource {
          * bigger than a certain threshold into smaller queries.
          */
         auto_split_threshold?: number | null
+        /**
+         * Transparently split queries with count requests
+         * bigger than a certain threshold into smaller queries.
+         */
+        autoSplitThreshold?: number | null
     }
 
 }
@@ -1603,6 +1608,11 @@ export interface MediaSource {
      * bigger than a certain threshold into smaller queries.
      */
     auto_split_threshold: number
+    /**
+     * Transparently split queries with count requests
+     * bigger than a certain threshold into smaller queries.
+     */
+    autoSplitThreshold: number
 
     // Own fields of Grl-0.1.Grl.MediaSource
 
@@ -2171,6 +2181,18 @@ export module MetadataSource {
          * The name of the source.
          */
         source_name?: string | null
+        /**
+         * A description of the source
+         */
+        sourceDesc?: string | null
+        /**
+         * The identifier of the source.
+         */
+        sourceId?: string | null
+        /**
+         * The name of the source.
+         */
+        sourceName?: string | null
     }
 
 }
@@ -2183,14 +2205,26 @@ export interface MetadataSource {
      * A description of the source
      */
     source_desc: string
+    /**
+     * A description of the source
+     */
+    sourceDesc: string
     /**
      * The identifier of the source.
      */
     source_id: string
+    /**
+     * The identifier of the source.
+     */
+    sourceId: string
     /**
      * The name of the source.
      */
     source_name: string
+    /**
+     * The name of the source.
+     */
+    sourceName: string
 
     // Own fields of Grl-0.1.Grl.MetadataSource
 

package/grl-0.1.d.ts

@@ -1592,6 +1592,11 @@ module MediaSource {
          * bigger than a certain threshold into smaller queries.
          */
         auto_split_threshold?: number | null
+        /**
+         * Transparently split queries with count requests
+         * bigger than a certain threshold into smaller queries.
+         */
+        autoSplitThreshold?: number | null
     }
 
 }
@@ -1605,6 +1610,11 @@ interface MediaSource {
      * bigger than a certain threshold into smaller queries.
      */
     auto_split_threshold: number
+    /**
+     * Transparently split queries with count requests
+     * bigger than a certain threshold into smaller queries.
+     */
+    autoSplitThreshold: number
 
     // Own fields of Grl-0.1.Grl.MediaSource
 
@@ -2173,6 +2183,18 @@ module MetadataSource {
          * The name of the source.
          */
         source_name?: string | null
+        /**
+         * A description of the source
+         */
+        sourceDesc?: string | null
+        /**
+         * The identifier of the source.
+         */
+        sourceId?: string | null
+        /**
+         * The name of the source.
+         */
+        sourceName?: string | null
     }
 
 }
@@ -2185,14 +2207,26 @@ interface MetadataSource {
      * A description of the source
      */
     source_desc: string
+    /**
+     * A description of the source
+     */
+    sourceDesc: string
     /**
      * The identifier of the source.
      */
     source_id: string
+    /**
+     * The identifier of the source.
+     */
+    sourceId: string
     /**
      * The name of the source.
      */
     source_name: string
+    /**
+     * The name of the source.
+     */
+    sourceName: string
 
     // Own fields of Grl-0.1.Grl.MetadataSource
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/grl-0.1",
-  "version": "0.1.0-3.2.4",
+  "version": "0.1.0-3.2.6",
   "description": "GJS TypeScript type definitions for Grl-0.1, generated from library version 0.1.0",
   "type": "module",
   "module": "grl-0.1.js",
@@ -25,10 +25,10 @@
     "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit grl-0.1.d.cts"
   },
   "dependencies": {
-    "@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/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": "*"