@girs/cogl-13 13.0.0-3.2.4 → 13.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.
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/cogl-13)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Cogl-13, generated from library version 13.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.4.
8
+ GJS TypeScript type definitions for Cogl-13, generated from library version 13.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 Cogl = imports.gi.Cogl;
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).
@@ -1,9 +1,12 @@
1
1
 
2
-
3
2
  declare module 'gi://Cogl?version=13' {
4
3
  import Cogl13 from '@girs/cogl-13';
5
4
  export default Cogl13;
6
5
  }
7
6
 
7
+ declare module 'gi://Cogl' {
8
+ import Cogl13 from '@girs/cogl-13';
9
+ export default Cogl13;
10
+ }
8
11
 
9
12
 
@@ -1,5 +1,4 @@
1
1
 
2
-
3
2
  import Cogl13 from '@girs/cogl-13';
4
3
 
5
4
  declare global {
package/cogl-13.d.cts CHANGED
@@ -2073,6 +2073,7 @@ export module Framebuffer {
2073
2073
  driver_config?: any | null
2074
2074
  height?: number | null
2075
2075
  width?: number | null
2076
+ driverConfig?: any | null
2076
2077
  }
2077
2078
 
2078
2079
  }
@@ -2082,6 +2083,7 @@ export interface Framebuffer {
2082
2083
  // Own properties of Cogl-13.Cogl.Framebuffer
2083
2084
 
2084
2085
  readonly driver_config: any
2086
+ readonly driverConfig: any
2085
2087
  height: number
2086
2088
  width: number
2087
2089
 
package/cogl-13.d.ts CHANGED
@@ -2075,6 +2075,7 @@ module Framebuffer {
2075
2075
  driver_config?: any | null
2076
2076
  height?: number | null
2077
2077
  width?: number | null
2078
+ driverConfig?: any | null
2078
2079
  }
2079
2080
 
2080
2081
  }
@@ -2084,6 +2085,7 @@ interface Framebuffer {
2084
2085
  // Own properties of Cogl-13.Cogl.Framebuffer
2085
2086
 
2086
2087
  readonly driver_config: any
2088
+ readonly driverConfig: any
2087
2089
  height: number
2088
2090
  width: number
2089
2091
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/cogl-13",
3
- "version": "13.0.0-3.2.4",
3
+ "version": "13.0.0-3.2.6",
4
4
  "description": "GJS TypeScript type definitions for Cogl-13, generated from library version 13.0.0",
5
5
  "type": "module",
6
6
  "module": "cogl-13.js",
@@ -25,12 +25,12 @@
25
25
  "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit cogl-13.d.cts"
26
26
  },
27
27
  "dependencies": {
28
- "@girs/cairo-1.0": "^1.0.0-3.2.4",
29
- "@girs/gjs": "^3.2.4",
30
- "@girs/gl-1.0": "^1.0.0-3.2.4",
31
- "@girs/glib-2.0": "^2.78.0-3.2.4",
32
- "@girs/gobject-2.0": "^2.78.0-3.2.4",
33
- "@girs/graphene-1.0": "^1.0.0-3.2.4"
28
+ "@girs/cairo-1.0": "^1.0.0-3.2.6",
29
+ "@girs/gjs": "^3.2.6",
30
+ "@girs/gl-1.0": "^1.0.0-3.2.6",
31
+ "@girs/glib-2.0": "^2.78.0-3.2.6",
32
+ "@girs/gobject-2.0": "^2.78.0-3.2.6",
33
+ "@girs/graphene-1.0": "^1.0.0-3.2.6"
34
34
  },
35
35
  "devDependencies": {
36
36
  "typescript": "*"