@girs/gdkwin32-4.0 4.3.0 → 4.5.0

package/README.md

@@ -4,82 +4,77 @@
 ![version](https://img.shields.io/npm/v/@girs/gdkwin32-4.0)
 ![downloads/week](https://img.shields.io/npm/dw/@girs/gdkwin32-4.0)
 
+GJS TypeScript type definitions for GdkWin32-4.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.5.0.
 
-GJS TypeScript type definitions for GdkWin32-4.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.0.
+This package contains type declarations only. It ships no runtime code, so it adds
+nothing to your program and works with any bundler or none at all.
 
 ## Install
 
-Install the type definitions with npm:
 ```bash
 npm install @girs/gdkwin32-4.0
 ```
 
-## Usage
+Any package manager works. The package has no dependencies beyond other `@girs/*`
+type packages.
+
+## What it exports
+
+| Import | What you get |
+|---|---|
+| `@girs/gdkwin32-4.0` | the namespace as a default export, plus the ambient and global declarations |
+| `@girs/gdkwin32-4.0/ambient` | only the `gi://` module declarations |
+| `@girs/gdkwin32-4.0/import` | only the `imports.gi` declarations |
+| `@girs/gdkwin32-4.0/gdkwin32-4.0` | the namespace, without the side-effecting declarations |
+
+## Three ways to import
+
+Which one you use depends on how you write imports elsewhere, not on your toolchain.
+
+### As a module
 
-Import it like any other module:
 ```ts
 import GdkWin32 from '@girs/gdkwin32-4.0';
 ```
 
-### Ambient Modules
+### As `gi://`
 
-[Ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) let you write the same import you would in plain JavaScript.
-For this you need to include `@girs/gdkwin32-4.0` or `@girs/gdkwin32-4.0/ambient` in your `tsconfig` or entry point Typescript file:
+GJS resolves `gi://` at runtime. To give it types, reference the package once, either
+from your entry point or from `tsconfig.json`:
 
-`index.ts`:
 ```ts
-import '@girs/gdkwin32-4.0'
+import '@girs/gdkwin32-4.0';
 ```
 
-`tsconfig.json`:
 ```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/gdkwin32-4.0"],
-  ...
-}
+{ "include": ["@girs/gdkwin32-4.0"] }
 ```
 
-The ambient module now resolves with types:
+Then the runtime spelling type-checks:
 
 ```ts
 import GdkWin32 from 'gi://GdkWin32?version=4.0';
 ```
 
-### Global import
-
-GJS's global `imports.gi` works too, with types.
-For this you need to include `@girs/gdkwin32-4.0` or `@girs/gdkwin32-4.0/import` in your `tsconfig` or entry point Typescript file:
+Referencing `@girs/gdkwin32-4.0/ambient` instead pulls in these declarations
+alone. See [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules).
 
-`index.ts`:
-```ts
-import '@girs/gdkwin32-4.0'
-```
-
-`tsconfig.json`:
-```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/gdkwin32-4.0"],
-  ...
-}
-```
+### As `imports.gi`
 
-That form carries types as well:
+GJS's global object works the same way, via `@girs/gdkwin32-4.0/import`:
 
 ```ts
 const GdkWin32 = imports.gi.GdkWin32;
 ```
 
-### Bundle
+## Building
 
-Most projects want a bundler. [esbuild](https://esbuild.github.io/) is the smallest thing that works; the [examples directory](https://github.com/gjsify/ts-for-gir/tree/main/examples) has setups for several others.
+The declarations need no build step. If you bundle, every bundler works, since there is
+no runtime code to resolve. The [examples](https://github.com/gjsify/ts-for-gir/tree/main/examples)
+show working setups for several.
 
 ## Other packages
 
-All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
+Every pre-generated package is at [gjsify/types](https://github.com/gjsify/types).
+
 

package/gdkwin32-4.0.d.ts

@@ -42,16 +42,16 @@ export namespace GdkWin32 {
          *   is not Windows, the Windows version is not recent enough, or it was explicitly
          *   disabled at compile- or runtime
          */
-        NOT_AVAILABLE,
+        NOT_AVAILABLE = 0,
         /**
          * The requested format is not supported
          */
-        UNSUPPORTED_FORMAT,
+        UNSUPPORTED_FORMAT = 1,
         /**
          * GTK failed to create the resource for other
          *   reasons
          */
-        CREATION_FAILED,
+        CREATION_FAILED = 2,
     }
 
 
@@ -63,11 +63,11 @@ export namespace GdkWin32 {
         /**
          * event not handled, continue processing.
          */
-        CONTINUE,
+        CONTINUE = 0,
         /**
          * event handled, terminate processing.
          */
-        REMOVE,
+        REMOVE = 1,
     }
 
 
@@ -378,6 +378,7 @@ export namespace GdkWin32 {
          * makes sense to transfer the {@link GLib.Variant} between processes on the same machine,
          * (as opposed to over the network), and within the same file system namespace.
          * @returns a {@link GLib.Variant}, or `null` when serialization fails. The {@link GLib.Variant} will not be floating.
+         * @since 2.38
          */
         serialize(): GLib.Variant | null;
 
@@ -399,6 +400,7 @@ export namespace GdkWin32 {
          * - If `icon` is a {@link Gio.ThemedIcon} with exactly one name and no fallbacks,
          *   the encoding is simply the name (such as `network-server`).
          * @returns An allocated NUL-terminated UTF8 string or `null` if `icon` can't be serialized. Use `g_free()` to free.
+         * @since 2.20
          */
         to_string(): string | null;
 
@@ -421,6 +423,7 @@ export namespace GdkWin32 {
          * As serialization will avoid using raw icon data when possible, it only
          * makes sense to transfer the {@link GLib.Variant} between processes on the same machine,
          * (as opposed to over the network), and within the same file system namespace.
+         * @since 2.38
          * @virtual
          */
         vfunc_serialize(): GLib.Variant | null;
@@ -428,6 +431,7 @@ export namespace GdkWin32 {
         /**
          * Serializes the `icon` into string tokens.
          * This is can be invoked when `g_icon_new_for_string()` is called.
+         * @since 2.20
          * @virtual
          */
         vfunc_to_tokens(): [boolean, string[], number];
@@ -438,6 +442,7 @@ export namespace GdkWin32 {
          * @param size an integer.
          * @param cancellable optional {@link Gio.Cancellable} object, `null` to ignore.
          * @returns a {@link Gio.InputStream} to read the icon from.
+         * @throws GLib.Error
          */
         load(size: number, cancellable: Gio.Cancellable | null): [Gio.InputStream, string];
 
@@ -474,6 +479,7 @@ export namespace GdkWin32 {
          * Finishes an asynchronous icon load started in `g_loadable_icon_load_async()`.
          * @param res a {@link Gio.AsyncResult}.
          * @returns a {@link Gio.InputStream} to read the icon from.
+         * @throws GLib.Error
          */
         load_finish(res: Gio.AsyncResult): [Gio.InputStream, string];
 
@@ -685,12 +691,15 @@ export namespace GdkWin32 {
          * possibly with changing properties in between.
          * @param data user data to pass to the destroy function
          * @returns a newly built {@link Gdk.Texture} or `NULL`   if the format is not supported
+         * @since 4.20
+         * @throws GLib.Error
          */
         build(data: null): Gdk.Texture | null;
 
         /**
          * Gets the color state previously set via `gdk_d3d12_texture_builder_set_color_state()`.
          * @returns the color state
+         * @since 4.20
          */
         get_color_state(): Gdk.ColorState | null;
 
@@ -698,12 +707,14 @@ export namespace GdkWin32 {
          * Returns the value that GTK should wait for on the fence
          * before using the resource.
          * @returns the fence wait value
+         * @since 4.20
          */
         get_fence_wait(): number;
 
         /**
          * Whether the data is premultiplied.
          * @returns whether the data is premultiplied
+         * @since 4.20
          */
         get_premultiplied(): boolean;
 
@@ -711,6 +722,7 @@ export namespace GdkWin32 {
          * Gets the region previously set via `gdk_d3d12_texture_builder_set_update_region()` or
          * `null` if none was set.
          * @returns The region
+         * @since 4.20
          */
         get_update_region(): cairo.Region | null;
 
@@ -718,6 +730,7 @@ export namespace GdkWin32 {
          * Gets the texture previously set via `gdk_d3d12_texture_builder_set_update_texture()` or
          * `null` if none was set.
          * @returns The texture
+         * @since 4.20
          */
         get_update_texture(): Gdk.Texture | null;
 
@@ -728,6 +741,7 @@ export namespace GdkWin32 {
          * correct colorstate based on the format.
          * If you don't know what colorstates are, this is probably the right thing.
          * @param color_state a {@link Gdk.ColorState} or `NULL` to unset the colorstate.
+         * @since 4.20
          */
         set_color_state(color_state: Gdk.ColorState | null): void;
 
@@ -737,6 +751,7 @@ export namespace GdkWin32 {
          * 
          * When no fence is set, this value has no effect.
          * @param fence_wait the value to wait on
+         * @since 4.20
          */
         set_fence_wait(fence_wait: bigint | number): void;
 
@@ -746,6 +761,7 @@ export namespace GdkWin32 {
          * Unless otherwise specified, all formats including alpha channels are assumed
          * to be premultiplied.
          * @param premultiplied whether the data is premultiplied
+         * @since 4.20
          */
         set_premultiplied(premultiplied: boolean): void;
 
@@ -761,6 +777,7 @@ export namespace GdkWin32 {
          * 
          * An example would be a screen recording where only the mouse pointer moves.
          * @param region the region to update
+         * @since 4.20
          */
         set_update_region(region: cairo.Region | null): void;
 
@@ -768,6 +785,7 @@ export namespace GdkWin32 {
          * Sets the texture to be updated by this texture. See
          * {@link Gdk.D3d12TextureBuilder.set_update_region} for an explanation.
          * @param texture the texture to update
+         * @since 4.20
          */
         set_update_texture(texture: Gdk.Texture | null): void;
     }
@@ -840,6 +858,7 @@ export namespace GdkWin32 {
         /**
          * Retrieves the EGL display connection object for the given GDK display.
          * @returns the EGL display
+         * @since 4.4
          */
         get_egl_display(): null;
 
@@ -1202,11 +1221,13 @@ export namespace GdkWin32 {
         // Static methods
         /**
          * @param surface a {@link Gdk.Surface}
+         * @deprecated since 4.8: Use `gdk_win32_surface_get_handle()` instead.
          */
         static get_impl_hwnd(surface: Gdk.Surface): win32.HWND;
 
         /**
          * @param surface a {@link Gdk.Surface}
+         * @deprecated since 4.8: Use `GDK_IS_WIN32_SURFACE` instead.
          */
         static is_win32(surface: Gdk.Surface): boolean;
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/gdkwin32-4.0",
-    "version": "4.3.0",
+    "version": "4.5.0",
     "description": "GJS TypeScript type definitions for GdkWin32-4.0",
     "type": "module",
     "module": "gdkwin32-4.0.js",
@@ -31,19 +31,19 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.3.0",
-      "@girs/win32-1.0": "^4.3.0",
-      "@girs/gdk-4.0": "^4.3.0",
-      "@girs/cairo-1.0": "^4.3.0",
-      "@girs/gobject-2.0": "^4.3.0",
-      "@girs/glib-2.0": "^4.3.0",
-      "@girs/pangocairo-1.0": "^4.3.0",
-      "@girs/pango-1.0": "^4.3.0",
-      "@girs/harfbuzz-0.0": "^4.3.0",
-      "@girs/freetype2-2.0": "^4.3.0",
-      "@girs/gio-2.0": "^4.3.0",
-      "@girs/gmodule-2.0": "^4.3.0",
-      "@girs/gdkpixbuf-2.0": "^4.3.0"    },
+      "@girs/gjs": "^4.5.0",
+      "@girs/win32-1.0": "^4.5.0",
+      "@girs/gdk-4.0": "^4.5.0",
+      "@girs/cairo-1.0": "^4.5.0",
+      "@girs/gobject-2.0": "^4.5.0",
+      "@girs/glib-2.0": "^4.5.0",
+      "@girs/pangocairo-1.0": "^4.5.0",
+      "@girs/pango-1.0": "^4.5.0",
+      "@girs/harfbuzz-0.0": "^4.5.0",
+      "@girs/freetype2-2.0": "^4.5.0",
+      "@girs/gio-2.0": "^4.5.0",
+      "@girs/gmodule-2.0": "^4.5.0",
+      "@girs/gdkpixbuf-2.0": "^4.5.0"    },
     "devDependencies": {
       "typescript": "*"
     },