@girs/meta-12 12.0.0-3.0.0-beta.13 → 12.0.0-3.0.0-beta.15

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 (9) hide show
  1. package/README.md +60 -4
  2. package/meta-12-ambient.d.ts +13 -0
  3. package/meta-12-import.d.ts +13 -0
  4. package/meta-12.cjs +2 -0
  5. package/meta-12.d.cts +18 -2
  6. package/meta-12.d.ts +18 -2
  7. package/meta-12.js +2 -0
  8. package/package.json +21 -19
  9. package/tsconfig.doc.json +2 -0
package/README.md CHANGED
@@ -1,11 +1,11 @@
1
1
 
2
2
  # Meta-12
3
3
 
4
- GJS TypeScript type definitions for Meta-12, generated from library version 12.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gjs) v3.0.0-beta.13.
4
+ GJS TypeScript type definitions for Meta-12, generated from library version 12.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.0.0-beta.15.
5
5
 
6
6
  ## Install
7
7
 
8
- To use this type definitions, install them with NPM like this:
8
+ To use this type definitions, install them with NPM:
9
9
  ```bash
10
10
  npm install @girs/meta-12
11
11
  ```
@@ -22,10 +22,66 @@ Or if you prefer CommonJS, you can also use this:
22
22
  const Meta = require('@girs/meta-12');
23
23
  ```
24
24
 
25
- If you use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules), you can also import this module like you would do this in JavaScript:
25
+ ### Ambient Modules
26
+
27
+ You can also use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) to import this module like you would do this in JavaScript.
28
+ For this you need to include `@girs/meta-12` or `@girs/meta-12/ambient` in your `tsconfig` or entry point Typescript file:
29
+
30
+ `index.ts`:
31
+ ```ts
32
+ import '@girs/meta-12'
33
+ ```
34
+
35
+ `tsconfig.json`:
36
+ ```json
37
+ {
38
+ "compilerOptions": {
39
+ ...
40
+ },
41
+ "include": ["@girs/meta-12"],
42
+ ...
43
+ }
44
+ ```
45
+
46
+ Now you can import the ambient module with TypeScript support:
26
47
 
27
48
  ```ts
28
49
  import Meta from 'gi://Meta?version=12';
29
50
  ```
30
51
 
31
- 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).
52
+
53
+ ### Global import
54
+
55
+ You can also import the module with Typescript support using the global `imports.gi` object of GJS.
56
+ For this you need to include `@girs/meta-12` or `@girs/meta-12/import` in your `tsconfig` or entry point Typescript file:
57
+
58
+ `index.ts`:
59
+ ```ts
60
+ import '@girs/meta-12'
61
+ ```
62
+
63
+ `tsconfig.json`:
64
+ ```json
65
+ {
66
+ "compilerOptions": {
67
+ ...
68
+ },
69
+ "include": ["@girs/meta-12"],
70
+ ...
71
+ }
72
+ ```
73
+
74
+ Now you have also type support for this, too:
75
+
76
+ ```ts
77
+ const Meta = imports.gi.Meta;
78
+ ```
79
+
80
+ ### Bundle
81
+
82
+ 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).
83
+
84
+ ## Other packages
85
+
86
+ All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
87
+
package/meta-12-ambient.d.ts ADDED
@@ -0,0 +1,13 @@
1
+
2
+
3
+ declare module 'gi://Meta?version=12' {
4
+ import Meta12 from '@girs/meta-12';
5
+ export default Meta12;
6
+ }
7
+
8
+ declare module 'gi://Meta' {
9
+ import Meta12 from '@girs/meta-12';
10
+ export default Meta12;
11
+ }
12
+
13
+
package/meta-12-import.d.ts ADDED
@@ -0,0 +1,13 @@
1
+
2
+
3
+ import Meta12 from '@girs/meta-12';
4
+
5
+ declare global {
6
+ export interface GjsGiImports {
7
+ Meta: typeof Meta12;
8
+ }
9
+ }
10
+
11
+ export default GjsGiImports;
12
+
13
+
package/meta-12.cjs CHANGED
@@ -7,3 +7,5 @@
7
7
 
8
8
 
9
9
 
10
+
11
+
package/meta-12.d.cts CHANGED
@@ -3,8 +3,11 @@
3
3
  * Type Definitions for Gjs (https://gjs.guide/)
4
4
  *
5
5
  * These type definitions are automatically generated, do not edit them by hand.
6
- * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gjs
6
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
7
7
  */
8
+
9
+ import './meta-12-ambient.d.ts';
10
+ import './meta-12-import.d.ts';
8
11
  /**
9
12
  * Meta-12
10
13
  */
@@ -3172,14 +3175,25 @@ export interface CursorTracker {
3172
3175
 
3173
3176
  // Owm methods of Meta-12.Meta.CursorTracker
3174
3177
 
3178
+ /**
3179
+ * Get the hotspot of the current cursor sprite.
3180
+ */
3175
3181
  get_hot(): [ /* x */ number, /* y */ number ]
3176
3182
  /**
3177
3183
  * Get the current pointer position and state.
3178
3184
  */
3179
3185
  get_pointer(): [ /* coords */ Graphene.Point, /* mods */ Clutter.ModifierType ]
3180
3186
  get_pointer_visible(): boolean
3187
+ /**
3188
+ * Get the scale factor of the cursor sprite
3189
+ * @returns The scale factor of the cursor sprite
3190
+ */
3181
3191
  get_scale(): number
3182
- get_sprite(): Cogl.Texture
3192
+ /**
3193
+ * Get the #CoglTexture of the cursor sprite
3194
+ * @returns the #CoglTexture of the cursor sprite
3195
+ */
3196
+ get_sprite(): Cogl.Texture | null
3183
3197
  set_pointer_visible(visible: boolean): void
3184
3198
 
3185
3199
  // Own signals of Meta-12.Meta.CursorTracker
@@ -3219,6 +3233,7 @@ export class CursorTracker extends GObject.Object {
3219
3233
  /**
3220
3234
  * Retrieves the cursor tracker object for `display`.
3221
3235
  * @param display the #MetaDisplay
3236
+ * @returns the cursor tracker object for @display.
3222
3237
  */
3223
3238
  static get_for_display(display: Display): CursorTracker
3224
3239
  }
@@ -5760,6 +5775,7 @@ export interface Window extends Gio.Initable {
5760
5775
  */
5761
5776
  has_attached_dialogs(): boolean
5762
5777
  has_focus(): boolean
5778
+ has_pointer(): boolean
5763
5779
  is_above(): boolean
5764
5780
  is_always_on_all_workspaces(): boolean
5765
5781
  /**
package/meta-12.d.ts CHANGED
@@ -3,8 +3,11 @@
3
3
  * Type Definitions for Gjs (https://gjs.guide/)
4
4
  *
5
5
  * These type definitions are automatically generated, do not edit them by hand.
6
- * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gjs
6
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
7
7
  */
8
+
9
+ import './meta-12-ambient.d.ts';
10
+ import './meta-12-import.d.ts';
8
11
  /**
9
12
  * Meta-12
10
13
  */
@@ -3174,14 +3177,25 @@ interface CursorTracker {
3174
3177
 
3175
3178
  // Owm methods of Meta-12.Meta.CursorTracker
3176
3179
 
3180
+ /**
3181
+ * Get the hotspot of the current cursor sprite.
3182
+ */
3177
3183
  get_hot(): [ /* x */ number, /* y */ number ]
3178
3184
  /**
3179
3185
  * Get the current pointer position and state.
3180
3186
  */
3181
3187
  get_pointer(): [ /* coords */ Graphene.Point, /* mods */ Clutter.ModifierType ]
3182
3188
  get_pointer_visible(): boolean
3189
+ /**
3190
+ * Get the scale factor of the cursor sprite
3191
+ * @returns The scale factor of the cursor sprite
3192
+ */
3183
3193
  get_scale(): number
3184
- get_sprite(): Cogl.Texture
3194
+ /**
3195
+ * Get the #CoglTexture of the cursor sprite
3196
+ * @returns the #CoglTexture of the cursor sprite
3197
+ */
3198
+ get_sprite(): Cogl.Texture | null
3185
3199
  set_pointer_visible(visible: boolean): void
3186
3200
 
3187
3201
  // Own signals of Meta-12.Meta.CursorTracker
@@ -3221,6 +3235,7 @@ class CursorTracker extends GObject.Object {
3221
3235
  /**
3222
3236
  * Retrieves the cursor tracker object for `display`.
3223
3237
  * @param display the #MetaDisplay
3238
+ * @returns the cursor tracker object for @display.
3224
3239
  */
3225
3240
  static get_for_display(display: Display): CursorTracker
3226
3241
  }
@@ -5762,6 +5777,7 @@ interface Window extends Gio.Initable {
5762
5777
  */
5763
5778
  has_attached_dialogs(): boolean
5764
5779
  has_focus(): boolean
5780
+ has_pointer(): boolean
5765
5781
  is_above(): boolean
5766
5782
  is_always_on_all_workspaces(): boolean
5767
5783
  /**
package/meta-12.js CHANGED
@@ -6,3 +6,5 @@
6
6
  export default Meta;
7
7
 
8
8
 
9
+
10
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/meta-12",
3
- "version": "12.0.0-3.0.0-beta.13",
3
+ "version": "12.0.0-3.0.0-beta.15",
4
4
  "description": "GJS TypeScript type definitions for Meta-12, generated from library version 12.0.0",
5
5
  "type": "module",
6
6
  "module": "meta-12.js",
@@ -12,6 +12,8 @@
12
12
  "tsconfig": "./tsconfig.doc.json"
13
13
  },
14
14
  "exports": {
15
+ "./ambient": "./meta-12-ambient.d.ts",
16
+ "./import": "./meta-12-import.d.ts",
15
17
  ".": {
16
18
  "import": {
17
19
  "types": "./meta-12.d.ts",
@@ -29,24 +31,24 @@
29
31
  "test:cjs": "tsc --noEmit meta-12.d.cts"
30
32
  },
31
33
  "dependencies": {
32
- "@girs/atk-1.0": "^2.45.1-3.0.0-beta.13",
33
- "@girs/cairo-1.0": "^1.0.0-3.0.0-beta.13",
34
- "@girs/clutter-12": "^12.0.0-3.0.0-beta.13",
35
- "@girs/cogl-12": "^12.0.0-3.0.0-beta.13",
36
- "@girs/coglpango-12": "^12.0.0-3.0.0-beta.13",
37
- "@girs/freetype2-2.0": "^2.0.0-3.0.0-beta.13",
38
- "@girs/gdesktopenums-3.0": "^3.0.0-3.0.0-beta.13",
39
- "@girs/gio-2.0": "^2.76.1-3.0.0-beta.13",
40
- "@girs/gl-1.0": "^1.0.0-3.0.0-beta.13",
41
- "@girs/glib-2.0": "^2.76.1-3.0.0-beta.13",
42
- "@girs/gobject-2.0": "^2.76.1-3.0.0-beta.13",
43
- "@girs/graphene-1.0": "^1.0.0-3.0.0-beta.13",
44
- "@girs/harfbuzz-0.0": "^6.0.0-3.0.0-beta.13",
45
- "@girs/json-1.0": "^1.7.1-3.0.0-beta.13",
46
- "@girs/pango-1.0": "^1.50.13-3.0.0-beta.13",
47
- "@girs/pangocairo-1.0": "^1.0.0-3.0.0-beta.13",
48
- "@girs/xfixes-4.0": "^4.0.0-3.0.0-beta.13",
49
- "@girs/xlib-2.0": "^2.0.0-3.0.0-beta.13"
34
+ "@girs/xlib-2.0": "^2.0.0-3.0.0-beta.15",
35
+ "@girs/xfixes-4.0": "^4.0.0-3.0.0-beta.15",
36
+ "@girs/gobject-2.0": "^2.76.1-3.0.0-beta.15",
37
+ "@girs/glib-2.0": "^2.76.1-3.0.0-beta.15",
38
+ "@girs/gdesktopenums-3.0": "^3.0.0-3.0.0-beta.15",
39
+ "@girs/coglpango-12": "^12.0.0-3.0.0-beta.15",
40
+ "@girs/pangocairo-1.0": "^1.0.0-3.0.0-beta.15",
41
+ "@girs/cairo-1.0": "^1.0.0-3.0.0-beta.15",
42
+ "@girs/pango-1.0": "^1.50.13-3.0.0-beta.15",
43
+ "@girs/harfbuzz-0.0": "^6.0.0-3.0.0-beta.15",
44
+ "@girs/freetype2-2.0": "^2.0.0-3.0.0-beta.15",
45
+ "@girs/gio-2.0": "^2.76.1-3.0.0-beta.15",
46
+ "@girs/cogl-12": "^12.0.0-3.0.0-beta.15",
47
+ "@girs/graphene-1.0": "^1.0.0-3.0.0-beta.15",
48
+ "@girs/gl-1.0": "^1.0.0-3.0.0-beta.15",
49
+ "@girs/clutter-12": "^12.0.0-3.0.0-beta.15",
50
+ "@girs/json-1.0": "^1.7.1-3.0.0-beta.15",
51
+ "@girs/atk-1.0": "^2.45.1-3.0.0-beta.15"
50
52
  },
51
53
  "devDependencies": {
52
54
  "typescript": "^5.0.4"
package/tsconfig.doc.json CHANGED
@@ -17,3 +17,5 @@
17
17
  },
18
18
  "include": ["./meta-12.d.ts"]
19
19
  }
20
+
21
+