@gtkx/ffi 0.1.53 → 0.2.0

package/README.md

@@ -21,25 +21,44 @@ GTKX bridges React's component model with GTK4's native widget system. Write fam
 ## Features
 
 - **React Components** — Use React hooks, state, and component patterns you already know
-- **Type-Safe** — Full TypeScript support with auto-generated types from GTK4 introspection data
+- **Hot Module Replacement** — Edit your code and see changes instantly, powered by Vite
 - **Native Performance** — Direct FFI bindings to GTK4 via Rust and libffi
+- **CLI & Scaffolding** — Get started in seconds with `npx @gtkx/cli create`
 - **CSS-in-JS Styling** — Emotion-style `css` template literals for GTK widgets
 - **Testing Library** — Familiar `screen`, `userEvent`, and query APIs for testing components
 
 ## Quick Start
 
+Create a new GTKX app with a single command:
+
 ```bash
-# Install dependencies
-npm install @gtkx/react @gtkx/ffi react
+npx @gtkx/cli create
+```
 
-# For TypeScript (recommended)
-npm install -D @types/react tsx typescript
+This launches an interactive wizard that sets up your project with TypeScript, your preferred package manager, and optional testing support.
 
-# For styling (optional)
-npm install @gtkx/css
+You can also pass options directly:
 
-# For testing (optional)
-npm install -D @gtkx/testing
+```bash
+npx @gtkx/cli create my-app --app-id com.example.myapp --pm pnpm --testing vitest
+```
+
+Then start developing with HMR:
+
+```bash
+cd my-app
+npm run dev
+```
+
+Edit your code and see changes instantly without restarting the app!
+
+### Manual Setup
+
+Alternatively, install packages directly:
+
+```bash
+npm install @gtkx/cli @gtkx/react @gtkx/ffi react
+npm install -D @types/react typescript
 ```
 
 Create your first app:
@@ -80,7 +99,13 @@ export const App = () => {
 };
 ```
 
-Run with:
+Run with HMR:
+
+```bash
+npx gtkx dev src/app.tsx
+```
+
+Or without HMR:
 
 ```bash
 npx tsx index.tsx
@@ -177,7 +202,8 @@ Query types: `ByRole`, `ByText`, `ByLabelText`, `ByTestId`
 A comprehensive showcase of GTK4 widgets and features:
 
 ```bash
-turbo start --filter=gtk4-demo
+cd examples/gtk4-demo
+pnpm dev
 ```
 
 ### Todo App
@@ -185,14 +211,16 @@ turbo start --filter=gtk4-demo
 A todo app demonstrating `@gtkx/testing` with realistic component tests:
 
 ```bash
-turbo start --filter=todo
-turbo test --filter=todo
+cd examples/todo
+pnpm dev
+pnpm test
 ```
 
 ## Packages
 
 | Package | Description |
 |---------|-------------|
+| [@gtkx/cli](packages/cli) | CLI for creating and developing GTKX apps with HMR |
 | [@gtkx/react](packages/react) | React reconciler and JSX components |
 | [@gtkx/ffi](packages/ffi) | TypeScript FFI bindings for GTK4 |
 | [@gtkx/native](packages/native) | Rust native module for FFI bridge |

package/dist/codegen/ffi-generator.js

@@ -410,7 +410,7 @@ export class CodeGenerator {
         sections.push(`export class ${className}${parentInfo.extendsClause}${implementsClause} {`);
         if (cls.glibTypeName) {
             const override = parentInfo.hasParent ? "override " : "";
-            sections.push(`  static ${override}readonly gtkTypeName: string = "${cls.glibTypeName}";\n`);
+            sections.push(`  static ${override}readonly glibTypeName: string = "${cls.glibTypeName}";\n`);
         }
         if (!parentInfo.hasParent) {
             sections.push(`  ptr: unknown;\n`);

package/dist/generated/gdk/app-launch-context.d.ts

@@ -23,7 +23,7 @@ import * as Gio from "../gio/index.js";
  * ```
  */
 export declare class AppLaunchContext extends Gio.AppLaunchContext {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/app-launch-context.js

@@ -24,7 +24,7 @@ import * as Gio from "../gio/index.js";
  * ```
  */
 export class AppLaunchContext extends Gio.AppLaunchContext {
-    static gtkTypeName = "GdkAppLaunchContext";
+    static glibTypeName = "GdkAppLaunchContext";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/button-event.d.ts

@@ -1,7 +1,7 @@
 import { Event } from "./event.js";
 /** An event related to a button on a pointer device. */
 export declare class ButtonEvent extends Event {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/button-event.js

@@ -2,7 +2,7 @@ import { call } from "@gtkx/native";
 import { Event } from "./event.js";
 /** An event related to a button on a pointer device. */
 export class ButtonEvent extends Event {
-    static gtkTypeName = "GdkButtonEvent";
+    static glibTypeName = "GdkButtonEvent";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/cairo-context.d.ts

@@ -9,7 +9,7 @@ import { DrawContext } from "./draw-context.js";
  * can then be used to draw on that surface.
  */
 export declare class CairoContext extends DrawContext {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/cairo-context.js

@@ -10,7 +10,7 @@ import { DrawContext } from "./draw-context.js";
  * can then be used to draw on that surface.
  */
 export class CairoContext extends DrawContext {
-    static gtkTypeName = "GdkCairoContext";
+    static glibTypeName = "GdkCairoContext";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/cicp-params.d.ts

@@ -23,7 +23,7 @@ import * as GObject from "../gobject/index.js";
  * parameters, or just to obtain information about the color state.
  */
 export declare class CicpParams extends GObject.GObject {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     /**
      * Creates a new `GdkCicpParams` object.
      *

package/dist/generated/gdk/cicp-params.js

@@ -24,7 +24,7 @@ import * as GObject from "../gobject/index.js";
  * parameters, or just to obtain information about the color state.
  */
 export class CicpParams extends GObject.GObject {
-    static gtkTypeName = "GdkCicpParams";
+    static glibTypeName = "GdkCicpParams";
     /**
      * Creates a new `GdkCicpParams` object.
      *

package/dist/generated/gdk/clipboard.d.ts

@@ -6,7 +6,7 @@ import { Texture } from "./texture.js";
 import * as GObject from "../gobject/index.js";
 import * as Gio from "../gio/index.js";
 export declare class Clipboard extends GObject.GObject {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/clipboard.js

@@ -28,7 +28,7 @@ const SIGNAL_META = {
     changed: { params: [], returnType: { type: "undefined" } },
 };
 export class Clipboard extends GObject.GObject {
-    static gtkTypeName = "GdkClipboard";
+    static glibTypeName = "GdkClipboard";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/content-deserializer.d.ts

@@ -14,7 +14,7 @@ import * as Gio from "../gio/index.js";
  * Also see [class@Gdk.ContentSerializer].
  */
 export declare class ContentDeserializer extends GObject.GObject {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/content-deserializer.js

@@ -15,7 +15,7 @@ import * as Gio from "../gio/index.js";
  * Also see [class@Gdk.ContentSerializer].
  */
 export class ContentDeserializer extends GObject.GObject {
-    static gtkTypeName = "GdkContentDeserializer";
+    static glibTypeName = "GdkContentDeserializer";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/content-provider.d.ts

@@ -4,7 +4,7 @@ import * as GLib from "../glib/index.js";
 import * as GObject from "../gobject/index.js";
 import * as Gio from "../gio/index.js";
 export declare class ContentProvider extends GObject.GObject {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     /**
      * Create a content provider that provides the given `bytes` as data for
      * the given @mime_type.

package/dist/generated/gdk/content-provider.js

@@ -17,7 +17,7 @@ const SIGNAL_META = {
     "content-changed": { params: [], returnType: { type: "undefined" } },
 };
 export class ContentProvider extends GObject.GObject {
-    static gtkTypeName = "GdkContentProvider";
+    static glibTypeName = "GdkContentProvider";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/content-serializer.d.ts

@@ -15,7 +15,7 @@ import * as Gio from "../gio/index.js";
  * Also see [class@Gdk.ContentDeserializer].
  */
 export declare class ContentSerializer extends GObject.GObject {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/content-serializer.js

@@ -16,7 +16,7 @@ import * as Gio from "../gio/index.js";
  * Also see [class@Gdk.ContentDeserializer].
  */
 export class ContentSerializer extends GObject.GObject {
-    static gtkTypeName = "GdkContentSerializer";
+    static glibTypeName = "GdkContentSerializer";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/crossing-event.d.ts

@@ -2,7 +2,7 @@ import { CrossingMode, NotifyType } from "./enums.js";
 import { Event } from "./event.js";
 /** An event caused by a pointing device moving between surfaces. */
 export declare class CrossingEvent extends Event {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/crossing-event.js

@@ -2,7 +2,7 @@ import { call } from "@gtkx/native";
 import { Event } from "./event.js";
 /** An event caused by a pointing device moving between surfaces. */
 export class CrossingEvent extends Event {
-    static gtkTypeName = "GdkCrossingEvent";
+    static glibTypeName = "GdkCrossingEvent";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/cursor.d.ts

@@ -37,7 +37,7 @@ import * as GObject from "../gobject/index.js";
  * the default cursor will be the ultimate fallback.
  */
 export declare class Cursor extends GObject.GObject {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     /**
      * Creates a new callback-based cursor object.
      *

package/dist/generated/gdk/cursor.js

@@ -39,7 +39,7 @@ import * as GObject from "../gobject/index.js";
  * the default cursor will be the ultimate fallback.
  */
 export class Cursor extends GObject.GObject {
-    static gtkTypeName = "GdkCursor";
+    static glibTypeName = "GdkCursor";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/delete-event.d.ts

@@ -1,7 +1,7 @@
 import { Event } from "./event.js";
 /** An event related to closing a top-level surface. */
 export declare class DeleteEvent extends Event {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
 }

package/dist/generated/gdk/delete-event.js

@@ -2,7 +2,7 @@ import { call } from "@gtkx/native";
 import { Event } from "./event.js";
 /** An event related to closing a top-level surface. */
 export class DeleteEvent extends Event {
-    static gtkTypeName = "GdkDeleteEvent";
+    static glibTypeName = "GdkDeleteEvent";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/device-tool.d.ts

@@ -2,7 +2,7 @@ import { AxisFlags, DeviceToolType } from "./enums.js";
 import * as GObject from "../gobject/index.js";
 /** A physical tool associated to a `GdkDevice`. */
 export declare class DeviceTool extends GObject.GObject {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/device-tool.js

@@ -3,7 +3,7 @@ import { getObject } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
 /** A physical tool associated to a `GdkDevice`. */
 export class DeviceTool extends GObject.GObject {
-    static gtkTypeName = "GdkDeviceTool";
+    static glibTypeName = "GdkDeviceTool";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/device.d.ts

@@ -7,7 +7,7 @@ import { DeviceTool } from "./device-tool.js";
 import * as GObject from "../gobject/index.js";
 import * as Pango from "../pango/index.js";
 export declare class Device extends GObject.GObject {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/device.js

@@ -21,7 +21,7 @@ const SIGNAL_META = {
     },
 };
 export class Device extends GObject.GObject {
-    static gtkTypeName = "GdkDevice";
+    static glibTypeName = "GdkDevice";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/display-manager.d.ts

@@ -1,7 +1,7 @@
 import { Display } from "./display.js";
 import * as GObject from "../gobject/index.js";
 export declare class DisplayManager extends GObject.GObject {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/display-manager.js

@@ -56,7 +56,7 @@ const SIGNAL_META = {
     },
 };
 export class DisplayManager extends GObject.GObject {
-    static gtkTypeName = "GdkDisplayManager";
+    static glibTypeName = "GdkDisplayManager";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/display.d.ts

@@ -12,7 +12,7 @@ import { Seat } from "./seat.js";
 import * as GObject from "../gobject/index.js";
 import * as Gio from "../gio/index.js";
 export declare class Display extends GObject.GObject {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/display.js

@@ -43,7 +43,7 @@ const SIGNAL_META = {
     },
 };
 export class Display extends GObject.GObject {
-    static gtkTypeName = "GdkDisplay";
+    static glibTypeName = "GdkDisplay";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/dmabuf-texture-builder.d.ts

@@ -62,7 +62,7 @@ import * as cairo from "../cairo/index.js";
  * * The header file [drm_fourcc.h](https://gitlab.freedesktop.org/mesa/drm/-/blob/main/include/drm/drm_fourcc.h)
  */
 export declare class DmabufTextureBuilder extends GObject.GObject {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     /**
      * Creates a new texture builder.
      */

package/dist/generated/gdk/dmabuf-texture-builder.js

@@ -64,7 +64,7 @@ import * as cairo from "../cairo/index.js";
  * * The header file [drm_fourcc.h](https://gitlab.freedesktop.org/mesa/drm/-/blob/main/include/drm/drm_fourcc.h)
  */
 export class DmabufTextureBuilder extends GObject.GObject {
-    static gtkTypeName = "GdkDmabufTextureBuilder";
+    static glibTypeName = "GdkDmabufTextureBuilder";
     /**
      * Creates a new texture builder.
      */

package/dist/generated/gdk/dmabuf-texture.d.ts

@@ -9,7 +9,7 @@ import { Texture } from "./texture.js";
  * Dma-buf textures can only be created on Linux.
  */
 export declare class DmabufTexture extends Texture {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     connect(signal: "notify", handler: (self: DmabufTexture, pspec: GObject.ParamSpec) => void, after?: boolean): number;

package/dist/generated/gdk/dmabuf-texture.js

@@ -10,7 +10,7 @@ import { Texture } from "./texture.js";
  * Dma-buf textures can only be created on Linux.
  */
 export class DmabufTexture extends Texture {
-    static gtkTypeName = "GdkDmabufTexture";
+    static glibTypeName = "GdkDmabufTexture";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/dndevent.d.ts

@@ -2,7 +2,7 @@ import { Drop } from "./drop.js";
 import { Event } from "./event.js";
 /** An event related to drag and drop operations. */
 export declare class DNDEvent extends Event {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/dndevent.js

@@ -4,7 +4,7 @@ import { Drop } from "./drop.js";
 import { Event } from "./event.js";
 /** An event related to drag and drop operations. */
 export class DNDEvent extends Event {
-    static gtkTypeName = "GdkDNDEvent";
+    static glibTypeName = "GdkDNDEvent";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/drag.d.ts

@@ -6,7 +6,7 @@ import { Display } from "./display.js";
 import { Surface } from "./surface.js";
 import * as GObject from "../gobject/index.js";
 export declare class Drag extends GObject.GObject {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/drag.js

@@ -27,7 +27,7 @@ const SIGNAL_META = {
     "drop-performed": { params: [], returnType: { type: "undefined" } },
 };
 export class Drag extends GObject.GObject {
-    static gtkTypeName = "GdkDrag";
+    static glibTypeName = "GdkDrag";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/draw-context.d.ts

@@ -14,7 +14,7 @@ import * as cairo from "../cairo/index.js";
  * A `GdkDrawContext` is always associated with a single toplevel surface.
  */
 export declare class DrawContext extends GObject.GObject {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/draw-context.js

@@ -16,7 +16,7 @@ import * as cairo from "../cairo/index.js";
  * A `GdkDrawContext` is always associated with a single toplevel surface.
  */
 export class DrawContext extends GObject.GObject {
-    static gtkTypeName = "GdkDrawContext";
+    static glibTypeName = "GdkDrawContext";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/drop.d.ts

@@ -24,7 +24,7 @@ import * as Gio from "../gio/index.js";
  * "Drag and Drop" section of the GTK documentation for more information.
  */
 export declare class Drop extends GObject.GObject {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/drop.js

@@ -24,7 +24,7 @@ import * as Gio from "../gio/index.js";
  * "Drag and Drop" section of the GTK documentation for more information.
  */
 export class Drop extends GObject.GObject {
-    static gtkTypeName = "GdkDrop";
+    static glibTypeName = "GdkDrop";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/event.d.ts

@@ -16,7 +16,7 @@ import { Surface } from "./surface.js";
  * `GdkEvent` structs are immutable.
  */
 export declare class Event {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     ptr: unknown;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;

package/dist/generated/gdk/event.js

@@ -16,7 +16,7 @@ import { Surface } from "./surface.js";
  * `GdkEvent` structs are immutable.
  */
 export class Event {
-    static gtkTypeName = "GdkEvent";
+    static glibTypeName = "GdkEvent";
     ptr;
     constructor(...args) {
         this.ptr = this.createPtr(args);

package/dist/generated/gdk/focus-event.d.ts

@@ -1,7 +1,7 @@
 import { Event } from "./event.js";
 /** An event related to a keyboard focus change. */
 export declare class FocusEvent extends Event {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/focus-event.js

@@ -2,7 +2,7 @@ import { call } from "@gtkx/native";
 import { Event } from "./event.js";
 /** An event related to a keyboard focus change. */
 export class FocusEvent extends Event {
-    static gtkTypeName = "GdkFocusEvent";
+    static glibTypeName = "GdkFocusEvent";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/frame-clock.d.ts

@@ -3,7 +3,7 @@ import { FrameClockPhase } from "./enums.js";
 import { FrameTimings } from "./frame-timings.js";
 import * as GObject from "../gobject/index.js";
 export declare class FrameClock extends GObject.GObject {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/frame-clock.js

@@ -46,7 +46,7 @@ const SIGNAL_META = {
     update: { params: [], returnType: { type: "undefined" } },
 };
 export class FrameClock extends GObject.GObject {
-    static gtkTypeName = "GdkFrameClock";
+    static glibTypeName = "GdkFrameClock";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/glcontext.d.ts

@@ -53,7 +53,7 @@ import { DrawContext } from "./draw-context.js";
  * that is currently set by calling [func@Gdk.GLContext.clear_current].
  */
 export declare class GLContext extends DrawContext {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
     /**

package/dist/generated/gdk/glcontext.js

@@ -52,7 +52,7 @@ import { DrawContext } from "./draw-context.js";
  * that is currently set by calling [func@Gdk.GLContext.clear_current].
  */
 export class GLContext extends DrawContext {
-    static gtkTypeName = "GdkGLContext";
+    static glibTypeName = "GdkGLContext";
     constructor(...args) {
         super(...args);
     }

package/dist/generated/gdk/gltexture-builder.d.ts

@@ -17,7 +17,7 @@ import * as cairo from "../cairo/index.js";
  * textures as well as kept around and reused to construct multiple textures.
  */
 export declare class GLTextureBuilder extends GObject.GObject {
-    static readonly gtkTypeName: string;
+    static readonly glibTypeName: string;
     /**
      * Creates a new texture builder.
      */