@girs/gnomebg-4.0 4.0.0-3.2.4 → 4.0.0-3.2.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +14 -1
  2. package/gnomebg-4.0-ambient.d.ts +0 -1
  3. package/gnomebg-4.0-import.d.ts +0 -1
  4. package/gnomebg-4.0.d.cts +3 -0
  5. package/gnomebg-4.0.d.ts +3 -0
  6. package/package.json +15 -15
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/gnomebg-4.0)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for GnomeBG-4.0, generated from library version 4.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.4.
8
+ GJS TypeScript type definitions for GnomeBG-4.0, generated from library version 4.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.6.
9
9
 
10
10
 
11
11
  ## Install
@@ -81,6 +81,19 @@ Now you have also type support for this, too:
81
81
  const GnomeBG = imports.gi.GnomeBG;
82
82
  ```
83
83
 
84
+
85
+ ### ESM vs. CommonJS
86
+
87
+ GJS supports two different import syntaxes. The new modern ESM syntax and the old global imports syntax.
88
+
89
+ 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.
90
+
91
+ 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.
92
+
93
+ 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.
94
+
95
+ 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.
96
+
84
97
  ### Bundle
85
98
 
86
99
  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/gnomebg-4.0-ambient.d.ts CHANGED
@@ -1,5 +1,4 @@
1
1
 
2
-
3
2
  declare module 'gi://GnomeBG?version=4.0' {
4
3
  import GnomeBG40 from '@girs/gnomebg-4.0';
5
4
  export default GnomeBG40;
package/gnomebg-4.0-import.d.ts CHANGED
@@ -1,5 +1,4 @@
1
1
 
2
-
3
2
  import GnomeBG40 from '@girs/gnomebg-4.0';
4
3
 
5
4
  declare global {
package/gnomebg-4.0.d.cts CHANGED
@@ -142,8 +142,11 @@ export interface BGSlideShow {
142
142
 
143
143
  readonly file: Gio.File
144
144
  readonly has_multiple_sizes: boolean
145
+ readonly hasMultipleSizes: boolean
145
146
  readonly start_time: number
147
+ readonly startTime: number
146
148
  readonly total_duration: number
149
+ readonly totalDuration: number
147
150
 
148
151
  // Own fields of GnomeBG-4.0.GnomeBG.BGSlideShow
149
152
 
package/gnomebg-4.0.d.ts CHANGED
@@ -144,8 +144,11 @@ interface BGSlideShow {
144
144
 
145
145
  readonly file: Gio.File
146
146
  readonly has_multiple_sizes: boolean
147
+ readonly hasMultipleSizes: boolean
147
148
  readonly start_time: number
149
+ readonly startTime: number
148
150
  readonly total_duration: number
151
+ readonly totalDuration: number
149
152
 
150
153
  // Own fields of GnomeBG-4.0.GnomeBG.BGSlideShow
151
154
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/gnomebg-4.0",
3
- "version": "4.0.0-3.2.4",
3
+ "version": "4.0.0-3.2.6",
4
4
  "description": "GJS TypeScript type definitions for GnomeBG-4.0, generated from library version 4.0.0",
5
5
  "type": "module",
6
6
  "module": "gnomebg-4.0.js",
@@ -25,20 +25,20 @@
25
25
  "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit gnomebg-4.0.d.cts"
26
26
  },
27
27
  "dependencies": {
28
- "@girs/cairo-1.0": "^1.0.0-3.2.4",
29
- "@girs/freetype2-2.0": "^2.0.0-3.2.4",
30
- "@girs/gdesktopenums-3.0": "^3.0.0-3.2.4",
31
- "@girs/gdk-4.0": "^4.0.0-3.2.4",
32
- "@girs/gdkpixbuf-2.0": "^2.0.0-3.2.4",
33
- "@girs/gio-2.0": "^2.78.0-3.2.4",
34
- "@girs/gjs": "^3.2.4",
35
- "@girs/glib-2.0": "^2.78.0-3.2.4",
36
- "@girs/gmodule-2.0": "^2.0.0-3.2.4",
37
- "@girs/gnomedesktop-4.0": "^4.0.0-3.2.4",
38
- "@girs/gobject-2.0": "^2.78.0-3.2.4",
39
- "@girs/harfbuzz-0.0": "^8.2.1-3.2.4",
40
- "@girs/pango-1.0": "^1.51.0-3.2.4",
41
- "@girs/pangocairo-1.0": "^1.0.0-3.2.4"
28
+ "@girs/cairo-1.0": "^1.0.0-3.2.6",
29
+ "@girs/freetype2-2.0": "^2.0.0-3.2.6",
30
+ "@girs/gdesktopenums-3.0": "^3.0.0-3.2.6",
31
+ "@girs/gdk-4.0": "^4.0.0-3.2.6",
32
+ "@girs/gdkpixbuf-2.0": "^2.0.0-3.2.6",
33
+ "@girs/gio-2.0": "^2.78.0-3.2.6",
34
+ "@girs/gjs": "^3.2.6",
35
+ "@girs/glib-2.0": "^2.78.0-3.2.6",
36
+ "@girs/gmodule-2.0": "^2.0.0-3.2.6",
37
+ "@girs/gnomedesktop-4.0": "^4.0.0-3.2.6",
38
+ "@girs/gobject-2.0": "^2.78.0-3.2.6",
39
+ "@girs/harfbuzz-0.0": "^8.2.1-3.2.6",
40
+ "@girs/pango-1.0": "^1.51.0-3.2.6",
41
+ "@girs/pangocairo-1.0": "^1.0.0-3.2.6"
42
42
  },
43
43
  "devDependencies": {
44
44
  "typescript": "*"