@gtkx/native 0.21.0 → 1.0.0-rc.2

package/README.md

@@ -1,70 +1,173 @@
 <p align="center">
-    <img src="https://raw.githubusercontent.com/eugeniodepalo/gtkx/main/logo.svg" alt="GTKX" width="100" height="100">
+  <img src="https://raw.githubusercontent.com/gtkx-org/gtkx/main/logo.svg" alt="GTKX" width="100" />
 </p>
 
 <h1 align="center">GTKX</h1>
 
 <p align="center">
-    <strong>Linux application development for the modern age powered by GTK4 and React</strong>
+  The React framework for Linux.<br />
+  Build GTK4 and Adwaita apps in TypeScript, with React components and hooks driving GNOME's own widgets. What you ship is a GNOME app.
 </p>
 
 <p align="center">
-    <a href="https://www.npmjs.com/package/@gtkx/react"><img src="https://img.shields.io/npm/v/@gtkx/react.svg" alt="npm version"></a>
-    <a href="https://github.com/gtkx-org/gtkx/actions"><img src="https://img.shields.io/github/actions/workflow/status/eugeniodepalo/gtkx/ci.yml" alt="CI"></a>
-    <a href="https://github.com/gtkx-org/gtkx/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MPL--2.0-blue.svg" alt="License"></a>
-    <a href="https://github.com/gtkx-org/gtkx/discussions"><img src="https://img.shields.io/badge/discussions-GitHub-blue" alt="GitHub Discussions"></a>
+  <a href="https://www.npmjs.com/package/create-gtkx"><img src="https://img.shields.io/npm/v/create-gtkx?color=cb3837&logo=npm&label=create-gtkx" alt="npm version" /></a>
+  <a href="https://www.npmjs.com/package/create-gtkx"><img src="https://img.shields.io/npm/dm/create-gtkx?color=cb3837&logo=npm&label=downloads" alt="npm downloads" /></a>
+  <img src="https://img.shields.io/badge/node-%E2%89%A524-339933?logo=node.js&logoColor=white" alt="Node >= 24" />
+  <a href="https://github.com/gtkx-org/gtkx/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MPL--2.0-blue.svg" alt="License: MPL-2.0" /></a>
+  <a href="https://github.com/gtkx-org/gtkx/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/gtkx-org/gtkx/ci.yml?branch=main&logo=github&label=CI" alt="CI status" /></a>
+  <img src="https://img.shields.io/badge/TypeScript-strict-3178c6?logo=typescript&logoColor=white" alt="TypeScript" />
+</p>
+
+<p align="center">
+  <a href="https://gtkx.dev">Homepage</a> &middot;
+  <a href="https://gtkx.dev/guide/why-gtkx">Documentation</a> &middot;
+  <a href="https://github.com/gtkx-org/gtkx/tree/main/examples">Examples</a> &middot;
+  <a href="https://github.com/gtkx-org/gtkx/blob/main/CONTRIBUTING.md">Contributing</a>
 </p>
 
 ---
 
+GTKX generates fully typed bindings for the entire GTK4 and Adwaita surface directly from GObject-Introspection. On top of those bindings you get the React programming model: components and hooks driving GObject instances, with Fast Refresh while you develop.
+
 <p align="center">
-    <img src="https://raw.githubusercontent.com/eugeniodepalo/gtkx/main/demo.gif" alt="GTKX Demo" width="100%">
+  <img src="https://raw.githubusercontent.com/gtkx-org/gtkx/main/examples/tutorial/assets/screenshot.png" alt="The Tasks app: an Adwaita window with a sidebar of smart views and colored lists on the left, and a boxed task list on the right." />
 </p>
 
----
+<p align="center">
+  <em>The Tasks app you build in the <a href="https://gtkx.dev/tutorial/">tutorial</a>.</em>
+</p>
+
+## Demo
+
+The intrinsic elements in this snippet render GTK4 widgets, and ordinary React hooks and events drive them:
+
+```tsx
+import * as Gtk from "@gtkx/gi/gtk";
+import { GtkApplication, GtkApplicationWindow, GtkBox, GtkButton, GtkLabel } from "@gtkx/jsx/gtk";
+import { createRoot, quit } from "@gtkx/react";
+import { useState } from "react";
+
+const Counter = () => {
+  const [count, setCount] = useState(0);
+
+  return (
+    <GtkApplicationWindow
+      title="Hello GTKX"
+      defaultWidth={400}
+      defaultHeight={300}
+      onCloseRequest={quit}
+    >
+      <GtkBox
+        orientation={Gtk.Orientation.VERTICAL}
+        spacing={20}
+        marginTop={40}
+        marginBottom={40}
+        marginStart={40}
+        marginEnd={40}
+        valign={Gtk.Align.CENTER}
+        halign={Gtk.Align.CENTER}
+      >
+        <GtkLabel cssClasses={["title-1"]}>Welcome to GTKX!</GtkLabel>
+        <GtkLabel cssClasses={["title-2"]}>{`Count: ${count}`}</GtkLabel>
+        <GtkButton
+          label="Increment"
+          onClicked={() => setCount((c) => c + 1)}
+          cssClasses={["suggested-action", "pill"]}
+        />
+      </GtkBox>
+    </GtkApplicationWindow>
+  );
+};
+
+const App = () => (
+  <GtkApplication>
+    <Counter />
+  </GtkApplication>
+);
+
+createRoot().render(<App />);
+```
+
+This is the [`hello-world`](https://github.com/gtkx-org/gtkx/tree/main/examples/hello-world) example, with `app.tsx` and `index.tsx` combined into a single snippet. `@gtkx/gi` and `@gtkx/jsx` are per-project bindings generated by the CLI, not packages you install from npm.
+
+## Why GTKX
+
+### A declarative layer for the GNOME stack
+
+GTK4 is mature, and GtkBuilder XML can lay out a static interface, but nothing re-renders that interface when your application state changes, and nothing hot-reloads it as you work. GTKX adds that missing layer, and the tooling around it, on top of the stack you already know:
+
+- a React reconciler that exposes every GObject as a JSX element,
+- a CLI for scaffolding, development, and production builds,
+- a dev server with Fast Refresh that patches your running UI in place,
+- CSS-in-JS styling and high-level list, grid, and dialog components,
+- a Testing Library-style API for querying and driving your widgets in tests,
+- and a Model Context Protocol (MCP) server that exposes your live app to AI agents.
+
+### The full GNOME API surface
+
+React Native and similar frameworks hide the native toolkit so one API can run everywhere. GTKX exposes it: GTK4, Adwaita, and any other GObject-Introspection library on your system. Linux-only by design.
+
+### Why Node.js, and why generated bindings
+
+GTKX runs on Node.js, which puts native modules, the npm ecosystem, and the tooling built for Node.js APIs within reach. GJS is GNOME's own runtime, built on SpiderMonkey rather than V8; node-gtk runs on Node.js but is lightly maintained, on the older nan/V8 ABI rather than N-API, and still centered on GTK3. The [why-gtkx guide](https://gtkx.dev/guide/why-gtkx) covers the comparison in full.
 
-GTKX is a modern framework for building native Linux applications using React and GTK. It provides the full range of GTK4, GLib, and Node.js APIs, allowing you to create rich, performant desktop applications with the tools and libraries you already know.
+GTKX generates the TypeScript types and the native FFI calls from the same GObject-Introspection data, so the types cannot drift from the calls they back. Codegen covers the whole GTK4 and Adwaita surface.
 
-## Features
+At runtime, the native Rust core calls straight into the system GTK4, Adwaita, and GLib libraries through libffi, without loading libgirepository at all.
 
-- **React 19** — Hooks, concurrent features, and the component model you know
-- **Fully native Node.js environment** - Runs on vanilla Node.js, with the help of a Neon native module
-- **TypeScript first** — Full type safety with auto-generated bindings
-- **Rich GLib support** — Provides bindings for most modern GLib/GObject libraries, including Adwaita
-- **HMR** — Fast refresh during development powered by Vite
-- **CSS-in-JS styling** — Easy styling with GTK CSS powered by Emotion
-- **Testing library** — Testing Library-inspired API for testing components and E2E
+## Quick start
 
-## Quick Start
+GTKX is Linux-only and needs Node.js 24 or later. See [Requirements](#requirements).
 
-```bash
-npx @gtkx/cli create my-app
+Scaffold a new app with the `create-gtkx` initializer:
+
+```sh
+npm create gtkx@rc
+```
+
+The same command works with other package managers: `pnpm create gtkx@rc` or `yarn create gtkx@rc`.
+
+Then run your new app:
+
+```sh
 cd my-app
 npm run dev
 ```
 
-## Examples
+To go further, follow the [tutorial](https://gtkx.dev/tutorial/).
 
-Explore complete applications in the [`examples/`](./examples) directory:
+## Documentation
 
-- **[hello-world](./examples/hello-world)** — Minimal application showing a counter
-- **[gtk-demo](./examples/gtk-demo)** — Full replica of the official GTK demo app
-- **[tutorial](./examples/tutorial)** — Notes app from the tutorial with GSettings and Adwaita
-- **[browser](./examples/browser)** — Simple browser using WebKitWebView
+The documentation at **[gtkx.dev](https://gtkx.dev)** includes a step-by-step tutorial that builds a complete GNOME app, from scaffolding to packaging and shipping, plus guides and a full API reference.
 
-## Documentation
+**[Read the docs &rarr;](https://gtkx.dev/guide/why-gtkx)**
 
-Visit [https://gtkx.dev](https://gtkx.dev) for the full documentation.
+## Requirements
 
-## Contributing
+GTKX is Linux-only. You need:
 
-Contributions are welcome! Please see the [contributing guidelines](./CONTRIBUTING.md).
+- Linux with the GTK4 (4.20 or later), Adwaita (1.8 or later), and GLib development libraries
+- Node.js 24 or later
 
-## Community
+The `@gtkx/native` addon ships prebuilt for x64 and arm64 glibc Linux; other targets need to build it from the GTKX repository, which requires a Rust toolchain.
+
+## Examples
+
+Explore the [example apps](https://github.com/gtkx-org/gtkx/tree/main/examples):
+
+- [`hello-world`](https://github.com/gtkx-org/gtkx/tree/main/examples/hello-world): the counter above.
+- [`gtk-demo`](https://github.com/gtkx-org/gtkx/tree/main/examples/gtk-demo): a React port of the official GTK4 widget showcase, covering lists, dialogs, gestures, CSS, and OpenGL.
+- [`browser`](https://github.com/gtkx-org/gtkx/tree/main/examples/browser): a WebKitWebView-based web browser.
+- [`tutorial`](https://github.com/gtkx-org/gtkx/tree/main/examples/tutorial): the Tasks app the documentation builds.
+
+## Status
+
+GTKX 1.0 is at the release candidate stage.
+
+## Contributing
 
-- [GitHub Discussions](https://github.com/gtkx-org/gtkx/discussions) — Questions, ideas, and general discussion
-- [Issue Tracker](https://github.com/gtkx-org/gtkx/issues) — Bug reports and feature requests
+Contributions are welcome. See [CONTRIBUTING.md](https://github.com/gtkx-org/gtkx/blob/main/CONTRIBUTING.md), the [Code of Conduct](https://github.com/gtkx-org/gtkx/blob/main/CODE_OF_CONDUCT.md), and the [security policy](https://github.com/gtkx-org/gtkx/blob/main/SECURITY.md). Building the repo needs Node.js 24 or later, pnpm, and a Rust toolchain.
 
 ## License
 
-[MPL-2.0](./LICENSE)
+GTKX is licensed under [MPL-2.0](https://github.com/gtkx-org/gtkx/blob/main/LICENSE).

package/index.d.ts

@@ -0,0 +1,190 @@
+/* auto-generated by NAPI-RS */
+/* eslint-disable */
+
+export declare class ExternalObject<T> {
+  readonly '': {
+    readonly '': unique symbol
+    [K: symbol]: T
+  }
+}
+/**
+ * Allocates a zero-filled native memory block of `size` bytes and returns an opaque handle to it.
+ * The optional `gtype` must be a registered boxed `GType` and selects `g_boxed_free` as the
+ * handle's destructor instead of `g_free`.
+ */
+export declare function alloc(size: number, gtype?: bigint | undefined | null): ExternalObject<Handle>
+
+/**
+ * Container layout used to marshal an array: a plain C `array`, a `glist`, `gslist`, `gptrarray`,
+ * `garray`, `gbytearray`, a `sized` buffer, or a `fixed`-length buffer.
+ */
+export type ArrayKind =  'array'|
+'glist'|
+'gslist'|
+'gptrarray'|
+'garray'|
+'gbytearray'|
+'sized'|
+'fixed';
+
+/**
+ * Resolves `symbolName` in `sharedLibrary` and precompiles its argument and return marshalling
+ * into a reusable call descriptor that `call` can invoke.
+ */
+export declare function bind(sharedLibrary: string, symbolName: string, argDescriptors: Array<Descriptor>, returnDescriptor: Descriptor): ExternalObject<CallDescriptor>
+
+/**
+ * Invokes a previously bound native function, encoding `values` and decoding the return value
+ * according to the call descriptor. Out and inout ('ref') arguments are written back in place.
+ */
+export declare function call(descriptor: ExternalObject<CallDescriptor>, values: unknown[]): unknown
+
+/**
+ * Lifetime of a marshalled callback closure: `call` lasts only for the duration of the call,
+ * `notified` is freed by a destroy notify, `async` spans a single async use, `forever` is never freed.
+ */
+export type CallbackScope =  'call'|
+'notified'|
+'async'|
+'forever';
+
+/** Copies `size` bytes from the `src` handle's memory into the `dest` handle's memory. */
+export declare function copy(dest: ExternalObject<Handle>, src: ExternalObject<Handle>, size: number): unknown
+
+/**
+ * Describes how a single native value (a function argument, a return value, or a struct field)
+ * is marshalled between JavaScript and C. The `kind` field selects the variant.
+ */
+export type Descriptor =
+  | { kind: 'int8' }
+  | { kind: 'uint8' }
+  | { kind: 'int16' }
+  | { kind: 'uint16' }
+  | { kind: 'int32' }
+  | { kind: 'uint32' }
+  | { kind: 'int64' }
+  | { kind: 'uint64' }
+  | { kind: 'bigint64' }
+  | { kind: 'biguint64' }
+  | { kind: 'float32' }
+  | { kind: 'float64' }
+  | { kind: 'enum', sharedLibrary: string, getTypeFnName: string, signed: boolean }
+  | { kind: 'flags', sharedLibrary: string, getTypeFnName: string, signed: boolean }
+  | { kind: 'boolean' }
+  | { kind: 'string', ownership: Ownership, length?: number }
+  | { kind: 'object', ownership: Ownership }
+  | { kind: 'unichar' }
+  | { kind: 'void' }
+  | { kind: 'buffer' }
+  | { kind: 'boxed', ownership: Ownership, typeName: string, sharedLibrary?: string, getTypeFnName?: string, freeFnName?: string, callerAllocated?: boolean, size?: number, inline?: boolean }
+  | { kind: 'struct', ownership: Ownership, size?: number, callerAllocated?: boolean, inline?: boolean }
+  | { kind: 'fundamental', ownership: Ownership, sharedLibrary: string, refFnName: string, unrefFnName: string, typeName?: string, inline?: boolean }
+  | { kind: 'array', itemDescriptor: Descriptor, arrayKind: ArrayKind, ownership: Ownership, sizeParamIndex?: number, fixedSize?: number, elementSize?: number }
+  | { kind: 'hashtable', keyDescriptor: Descriptor, valueDescriptor: Descriptor, ownership: Ownership }
+  | { kind: 'callback', argDescriptors: Array<Descriptor>, returnDescriptor: Descriptor, hasDestroy?: boolean, userDataIndex?: number, scope?: CallbackScope }
+  | { kind: 'ref', innerDescriptor: Descriptor, inout?: boolean }
+
+/** Returns the `GType` of the `GObject` referenced by `handle`, or 0 when the pointer is null. */
+export declare function getType(handle: ExternalObject<Handle>): bigint
+
+/**
+ * Returns the JavaScript wrapper object previously attached to the handle's `GObject`,
+ * or null when no wrapper is set.
+ */
+export declare function getWrapper(handle: ExternalObject<Handle>): object | null
+
+/**
+ * Installs the Node environment and the `GLib` main-loop integration on the current thread.
+ * Call once before any other native function.
+ */
+export declare function init(): void
+
+/**
+ * Enables or disables keeping the Node event loop alive while the `GLib` run loop is otherwise
+ * idle.
+ */
+export declare function keepAlive(enable: boolean): void
+
+/**
+ * Ownership transfer mode for a marshalled value: `borrowed` leaves the native side owning it,
+ * `full` transfers ownership (and the responsibility to free it) across the FFI boundary.
+ */
+export type Ownership =  'borrowed'|
+'full';
+
+/** Tears down the `GLib` main loop integration installed by `init`. */
+export declare function quit(): void
+
+/**
+ * Reads and decodes a value at `offset` bytes into the handle's memory, using `fieldDescriptor`
+ * to interpret the raw bytes.
+ */
+export declare function read(handle: ExternalObject<Handle>, fieldDescriptor: Descriptor, offset: number): unknown
+
+/**
+ * Registers a new `GObject` subtype named `name` deriving from `parentType`, wiring up any vfunc
+ * overrides and implemented interfaces, and returns the new `GType`.
+ */
+export declare function registerClass(name: string, parentType: bigint, options?: RegisterClassOptions | undefined | null): bigint
+
+/** An interface a registered class implements, together with the interface vfuncs it provides. */
+export interface RegisterClassInterface {
+  /** `GType` of the interface to implement. */
+  type: bigint
+  /**
+   * Byte size of the interface's vtable struct, used to bounds-check each vfunc's `byteOffset`.
+   * `g_type_query` reports nothing for an interface type, so the size has to come from the same
+   * generated metadata the offsets do; when it is omitted the offsets are only alignment-checked.
+   */
+  vtableSize?: number
+  /** Interface vfunc implementations to install. */
+  vfuncs: Array<RegisterClassVfunc>
+}
+
+/** Optional configuration for `registerClass`: vfunc overrides, implemented interfaces and properties. */
+export interface RegisterClassOptions {
+  /** Virtual function overrides for the class itself. */
+  vfuncs?: Array<RegisterClassVfunc>
+  /** Interfaces the class implements, each with its own vfuncs. */
+  interfaces?: Array<RegisterClassInterface>
+  /** Properties to install on the class. */
+  properties?: Array<RegisterClassProperty>
+}
+
+/** A property the registered class installs on its class structure. */
+export interface RegisterClassProperty {
+  /** Property id the class's `get_property`/`set_property` vfuncs dispatch on. Must be non-zero. */
+  id: number
+  /** Handle to the `GParamSpec` describing the property. Ownership transfers to the class. */
+  pspec: ExternalObject<Handle>
+}
+
+/**
+ * A single virtual function override for a registered class: which slot to patch and how its
+ * arguments and return value are marshalled to and from the JavaScript implementation.
+ */
+export interface RegisterClassVfunc {
+  /** Byte offset of the vfunc slot within the class (or interface) struct. */
+  byteOffset: number
+  /** Descriptor for each argument passed to the JavaScript implementation. */
+  argDescriptors: Array<Descriptor>
+  /** Descriptor for the value the JavaScript implementation returns. */
+  returnDescriptor: Descriptor
+  /** The JavaScript function that implements the vfunc. */
+  fn: (...args: never[]) => unknown
+}
+
+/**
+ * Calls the `getTypeFnName` registration function in `sharedLibrary` and returns the resulting
+ * `GType`, or 0 when the symbol is absent.
+ */
+export declare function resolveType(sharedLibrary: string, getTypeFnName: string): bigint
+
+/**
+ * Attaches the JavaScript `wrapper` object to the handle's `GObject` and registers a finalizer
+ * that releases it when the wrapper is garbage collected.
+ */
+export declare function setWrapper(handle: ExternalObject<Handle>, wrapper: object): void
+
+/** Encodes `value` with `fieldDescriptor` and writes it into the handle's memory at `offset` bytes. */
+export declare function write(handle: ExternalObject<Handle>, fieldDescriptor: Descriptor, offset: number, value: unknown): unknown