@girs/gdl-3 4.4.0 → 4.5.0

package/README.md

@@ -4,82 +4,96 @@
 ![version](https://img.shields.io/npm/v/@girs/gdl-3)
 ![downloads/week](https://img.shields.io/npm/dw/@girs/gdl-3)
 
+GJS TypeScript type definitions for Gdl-3 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.5.0.
 
-GJS TypeScript type definitions for Gdl-3 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.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/gdl-3
 ```
 
-## Usage
+Any package manager works. The package has no dependencies beyond other `@girs/*`
+type packages.
+
+## What it exports
+
+| Import | What you get |
+|---|---|
+| `@girs/gdl-3` | the namespace as a default export, plus the ambient and global declarations |
+| `@girs/gdl-3/ambient` | only the `gi://` module declarations |
+| `@girs/gdl-3/import` | only the `imports.gi` declarations |
+| `@girs/gdl-3/gdl-3` | the namespace, without the side-effecting declarations |
+| `@girs/gdl-3/vocabulary` | GIR-derived widget data: settable properties, enum nicks, slot candidates |
+
+## 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 Gdl from '@girs/gdl-3';
 ```
 
-### 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/gdl-3` or `@girs/gdl-3/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/gdl-3'
+import '@girs/gdl-3';
 ```
 
-`tsconfig.json`:
 ```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/gdl-3"],
-  ...
-}
+{ "include": ["@girs/gdl-3"] }
 ```
 
-The ambient module now resolves with types:
+Then the runtime spelling type-checks:
 
 ```ts
 import Gdl from 'gi://Gdl?version=3';
 ```
 
-### Global import
+Referencing `@girs/gdl-3/ambient` instead pulls in these declarations
+alone. See [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules).
+
+### As `imports.gi`
 
-GJS's global `imports.gi` works too, with types.
-For this you need to include `@girs/gdl-3` or `@girs/gdl-3/import` in your `tsconfig` or entry point Typescript file:
+GJS's global object works the same way, via `@girs/gdl-3/import`:
 
-`index.ts`:
 ```ts
-import '@girs/gdl-3'
+const Gdl = imports.gi.Gdl;
 ```
 
-`tsconfig.json`:
-```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/gdl-3"],
-  ...
-}
-```
+## Widget vocabulary
 
-That form carries types as well:
+`gdl-3` declares widgets, so it also carries what the GIR says about them, as
+types and as values a test can read:
 
 ```ts
-const Gdl = imports.gi.Gdl;
+import type { Widgets, PropsOf } from '@girs/gdl-3/vocabulary';
+import { OWN_PROPS, ENUM_NICKS, PROVENANCE } from '@girs/gdl-3/vocabulary';
 ```
 
-### Bundle
+Properties are keyed the way GObject registered them, writable-only and optional, so they
+match `g_object_set`, GtkBuilder XML and Blueprint. `PROVENANCE.libraryVersion` names the
+library release this was generated from, which lets a check tell "newer than what is
+installed" from "wrong".
 
-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.
+This subpath answers what the GIR says, not what the installed library has. For the
+second question, ask the library.
+
+## Building
+
+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/gdl-3-vocabulary.d.ts

@@ -0,0 +1,418 @@
+/**
+ * The GIR-derived widget VOCABULARY for Gdl-3.
+ *
+ * GENERATED — do not edit. Provenance: Gdl-3 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object Atk.ImplementorIface — prop(s) no TypeScript value satisfies: Gdl.DockObject.pixbuf-icon
+ *
+ * 12 concrete widgets, 12 declarations, 3 enum nick unions, 4 slot candidates.
+ *
+ * Module-scoped exports only. There is no `JSX` namespace here, no tag spelling and
+ * no `on<Signal>` prop name: those are DIALECT, and every framework answers them
+ * differently. The shape to avoid is the GLOBAL AUGMENT — a `declare global` on
+ * `React.JSX` collides with every other library on a shared tag — while a
+ * module-scoped `JSX` behind a `jsxImportSource` does not. This package is used by
+ * projects that want nothing to do with JSX, so it emits neither; a consumer declaring
+ * a module-scoped namespace over these names is doing it right.
+ *
+ * Three things this is and `ConstructorProps` is not: WRITABLE-only (measured on
+ * Gtk-4.0, `ConstructorProps` offers 150 read-only properties across 68 classes as
+ * settable, and GTK's failure mode for writing one is exit 0), OPTIONAL, and keyed
+ * by the name GObject actually REGISTERED — the dashed spelling `g_object_set`,
+ * GtkBuilder XML and Blueprint all use.
+ *
+ * Signal handler types are not re-derived: `X.SignalSignatures`, which this package
+ * already emits for every class with the parent chain, every implemented interface
+ * and the `notify::` keys folded in, is what `Widgets[G]['signals']` points at.
+ */
+
+import type GObject from '@girs/gobject-2.0';
+import type Gdl from './gdl-3.js';
+import type Gtk from '@girs/gtk-3.0';
+import type { GtkBinConstructOnly, GtkBinProps, GtkBoxConstructOnly, GtkBoxProps, GtkBuildableConstructOnly, GtkBuildableProps, GtkContainerConstructOnly, GtkContainerProps, GtkNotebookConstructOnly, GtkNotebookProps, GtkOrientableConstructOnly, GtkOrientableProps, GtkOrientationNick, GtkPositionTypeNick, GtkWidgetConstructOnly, GtkWidgetProps, GtkWindowConstructOnly, GtkWindowProps } from '@girs/gtk-3.0/vocabulary';
+
+// ---------------------------------------------------------------------------
+// Enum nicks — the string vocabulary GObject registered, from GIR's `glib:nick`.
+//
+// Not derived from the member name. Substituting underscores for dashes is not a law:
+// some nicks keep an underscore the substitution would have replaced, and only the
+// attribute knows which. Gtk-4.0 and Adw-1 contradict no derivation at all, which is
+// how a derived nick passes review and breaks elsewhere.
+// Re-measure with `scripts/check-nick-derivation.mjs` in ts-for-gir.
+// ---------------------------------------------------------------------------
+
+export type GdlDockBarStyleNick = 'icons' | 'text' | 'both' | 'auto';
+export type GdlDockPlacementNick = 'none' | 'top' | 'bottom' | 'right' | 'left' | 'center' | 'floating';
+export type GdlSwitcherStyleNick = 'text' | 'icon' | 'both' | 'toolbar' | 'tabs' | 'none';
+
+// ---------------------------------------------------------------------------
+// Property surfaces — one interface per GIR DECLARATION, mirroring GIR's own
+// inheritance rather than flattening per widget.
+//
+// The interfaces are load-bearing, not tidiness: `GtkBox` declares four properties
+// of its own and `orientation` is not among them — it lives on `Gtk.Orientable`,
+// because GObject installs interface properties on the implementor at runtime while
+// GIR keeps them once, on the interface.
+// ---------------------------------------------------------------------------
+
+export interface GdlDockProps extends GdlDockObjectProps, GtkBuildableProps {
+    /** @default NULL */
+    'default-title'?: string;
+    /** @default FALSE */
+    floating?: boolean;
+    /** @default 0 */
+    floatx?: number;
+    /** @default 0 */
+    floaty?: number;
+    /** @default -1 */
+    height?: number;
+    /**
+     * Whether or not to prevent a floating dock window from appearing in the taskbar.
+     * @since 3.6
+     * @default TRUE
+     */
+    'skip-taskbar'?: boolean;
+    /** @default -1 */
+    width?: number;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GdlDockConstructOnly = GdlDockObjectConstructOnly | GtkBuildableConstructOnly | 'floating';
+
+export interface GdlDockBarProps extends GtkBoxProps, GtkBuildableProps, GtkOrientableProps {
+    /** @default GDL_DOCK_BAR_BOTH */
+    'dockbar-style'?: GdlDockBarStyleNick | Gdl.DockBarStyle;
+    /** The #GdlDockMaster object attached to the dockbar. */
+    master?: GObject.Object;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GdlDockBarConstructOnly = GtkBoxConstructOnly | GtkBuildableConstructOnly | GtkOrientableConstructOnly;
+
+export interface GdlDockItemProps extends GdlDockObjectProps, GtkBuildableProps {
+    /** @default GDL_DOCK_ITEM_BEH_NORMAL */
+    behavior?: number;
+    /**
+     * If set, the dock item is closed.
+     * @since 3.6
+     * @default FALSE
+     */
+    closed?: boolean;
+    /**
+     * If set, the dock item is hidden but it has a corresponding icon in the dock bar allowing to show it again.
+     * @since 3.6
+     * @default FALSE
+     */
+    iconified?: boolean;
+    /** @default FALSE */
+    locked?: boolean;
+    /**
+     * The orientation of the docking item.
+     * @default GTK_ORIENTATION_VERTICAL
+     */
+    orientation?: GtkOrientationNick | Gtk.Orientation;
+    /** @default -1 */
+    'preferred-height'?: number;
+    /** @default -1 */
+    'preferred-width'?: number;
+    /** @default TRUE */
+    resize?: boolean;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GdlDockItemConstructOnly = GdlDockObjectConstructOnly | GtkBuildableConstructOnly;
+
+export interface GdlDockItemButtonImageProps extends GtkWidgetProps, GtkBuildableProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GdlDockItemButtonImageConstructOnly = GtkWidgetConstructOnly | GtkBuildableConstructOnly;
+
+export interface GdlDockItemGripProps extends GtkContainerProps, GtkBuildableProps {
+    item?: Gdl.DockItem;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GdlDockItemGripConstructOnly = GtkContainerConstructOnly | GtkBuildableConstructOnly | 'item';
+
+export interface GdlDockNotebookProps extends GdlDockItemProps, GtkBuildableProps {
+    /** @default -1 */
+    page?: number;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GdlDockNotebookConstructOnly = GdlDockItemConstructOnly | GtkBuildableConstructOnly;
+
+export interface GdlDockObjectProps extends GtkContainerProps, GtkBuildableProps {
+    /**
+     * A long descriptive name.
+     * @default NULL
+     */
+    'long-name'?: string;
+    /** The master which manages all the objects in a dock ring */
+    master?: Gdl.DockMaster;
+    /**
+     * The object name.
+     * @default NULL
+     */
+    name?: string;
+    /**
+     * A GdkPixbuf to use for the icon of the dock object.
+     * @since 3.3.2
+     */
+    'pixbuf-icon'?: never;
+    /**
+     * A stock id to use for the icon of the dock object.
+     * @default NULL
+     */
+    'stock-id'?: string;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GdlDockObjectConstructOnly = GtkContainerConstructOnly | GtkBuildableConstructOnly | 'name';
+
+export interface GdlDockPanedProps extends GdlDockItemProps, GtkBuildableProps {
+    /** @default 0 */
+    position?: number;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GdlDockPanedConstructOnly = GdlDockItemConstructOnly | GtkBuildableConstructOnly;
+
+export interface GdlDockPlaceholderProps extends GdlDockObjectProps, GtkBuildableProps {
+    /** @default FALSE */
+    floating?: boolean;
+    /** @default -1 */
+    floatx?: number;
+    /** @default -1 */
+    floaty?: number;
+    /** @default -1 */
+    height?: number;
+    host?: Gdl.DockObject;
+    /** @default GDL_DOCK_CENTER */
+    'next-placement'?: GdlDockPlacementNick | Gdl.DockPlacement;
+    /** @default FALSE */
+    sticky?: boolean;
+    /** @default -1 */
+    width?: number;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GdlDockPlaceholderConstructOnly = GdlDockObjectConstructOnly | GtkBuildableConstructOnly | 'floating' | 'floatx' | 'floaty' | 'sticky';
+
+export interface GdlDockTablabelProps extends GtkBinProps, GtkBuildableProps {
+    item?: Gdl.DockItem;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GdlDockTablabelConstructOnly = GtkBinConstructOnly | GtkBuildableConstructOnly;
+
+/** The GdlDockLayout struct contains only private fields and should not be directly accessed. */
+export interface GdlPreviewWindowProps extends GtkWindowProps, GtkBuildableProps {
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GdlPreviewWindowConstructOnly = GtkWindowConstructOnly | GtkBuildableConstructOnly;
+
+export interface GdlSwitcherProps extends GtkNotebookProps, GtkBuildableProps {
+    /** @default GDL_SWITCHER_STYLE_BOTH */
+    'switcher-style'?: GdlSwitcherStyleNick | Gdl.SwitcherStyle;
+    /** @default GTK_POS_BOTTOM */
+    'tab-pos'?: GtkPositionTypeNick | Gtk.PositionType;
+    /** @default FALSE */
+    'tab-reorderable'?: boolean;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type GdlSwitcherConstructOnly = GtkNotebookConstructOnly | GtkBuildableConstructOnly;
+
+// ---------------------------------------------------------------------------
+// The GType-keyed widget map.
+//
+// Keyed by GType because that is also the GtkBuilder XML key and the typelib key. A
+// consumer maps GTypes to tags in ITS convention — kebab for JSX intrinsics, Pascal
+// for a Vue `GlobalComponents`, the class itself for a renderer whose element type
+// is the class. None of those is baked in here.
+//
+// `slotCandidates` is a candidate list and never an answer: derived from methods
+// taking exactly one widget argument. The GIR cannot tell adoption from reference —
+// `set_title_widget` parents its argument and `set_activatable_widget` does not, and
+// both are `void f(GtkWidget*)` at `transfer-ownership="none"`. Curation decides;
+// this is what notices when a release adds a candidate.
+// ---------------------------------------------------------------------------
+
+export interface Widgets {
+    GdlDock: {
+        class: Gdl.Dock;
+        props: GdlDockProps;
+        signals: Gdl.Dock.SignalSignatures;
+        constructOnly: GdlDockConstructOnly;
+        slotCandidates: {};
+    };
+    GdlDockBar: {
+        class: Gdl.DockBar;
+        props: GdlDockBarProps;
+        signals: Gdl.DockBar.SignalSignatures;
+        constructOnly: GdlDockBarConstructOnly;
+        slotCandidates: {};
+    };
+    GdlDockItem: {
+        class: Gdl.DockItem;
+        props: GdlDockItemProps;
+        signals: Gdl.DockItem.SignalSignatures;
+        constructOnly: GdlDockItemConstructOnly;
+        slotCandidates: {
+        'child': 'set_child';
+        'default-position': 'set_default_position';
+        'tablabel': 'set_tablabel';
+        };
+    };
+    GdlDockItemButtonImage: {
+        class: Gdl.DockItemButtonImage;
+        props: GdlDockItemButtonImageProps;
+        signals: Gdl.DockItemButtonImage.SignalSignatures;
+        constructOnly: GdlDockItemButtonImageConstructOnly;
+        slotCandidates: {};
+    };
+    GdlDockItemGrip: {
+        class: Gdl.DockItemGrip;
+        props: GdlDockItemGripProps;
+        signals: Gdl.DockItemGrip.SignalSignatures;
+        constructOnly: GdlDockItemGripConstructOnly;
+        slotCandidates: {
+        'label': 'set_label';
+        };
+    };
+    GdlDockNotebook: {
+        class: Gdl.DockNotebook;
+        props: GdlDockNotebookProps;
+        signals: Gdl.DockNotebook.SignalSignatures;
+        constructOnly: GdlDockNotebookConstructOnly;
+        slotCandidates: {};
+    };
+    GdlDockObject: {
+        class: Gdl.DockObject;
+        props: GdlDockObjectProps;
+        signals: Gdl.DockObject.SignalSignatures;
+        constructOnly: GdlDockObjectConstructOnly;
+        slotCandidates: {};
+    };
+    GdlDockPaned: {
+        class: Gdl.DockPaned;
+        props: GdlDockPanedProps;
+        signals: Gdl.DockPaned.SignalSignatures;
+        constructOnly: GdlDockPanedConstructOnly;
+        slotCandidates: {};
+    };
+    GdlDockPlaceholder: {
+        class: Gdl.DockPlaceholder;
+        props: GdlDockPlaceholderProps;
+        signals: Gdl.DockPlaceholder.SignalSignatures;
+        constructOnly: GdlDockPlaceholderConstructOnly;
+        slotCandidates: {};
+    };
+    GdlDockTablabel: {
+        class: Gdl.DockTablabel;
+        props: GdlDockTablabelProps;
+        signals: Gdl.DockTablabel.SignalSignatures;
+        constructOnly: GdlDockTablabelConstructOnly;
+        slotCandidates: {};
+    };
+    GdlPreviewWindow: {
+        class: Gdl.PreviewWindow;
+        props: GdlPreviewWindowProps;
+        signals: Gdl.PreviewWindow.SignalSignatures;
+        constructOnly: GdlPreviewWindowConstructOnly;
+        slotCandidates: {};
+    };
+    GdlSwitcher: {
+        class: Gdl.Switcher;
+        props: GdlSwitcherProps;
+        signals: Gdl.Switcher.SignalSignatures;
+        constructOnly: GdlSwitcherConstructOnly;
+        slotCandidates: {};
+    };
+}
+
+/** Every GType this namespace can create. A consumer derives its own tag map. */
+export type WidgetGType = keyof Widgets;
+
+// ---------------------------------------------------------------------------
+// Child holders — the same shape, for objects that CARRY a widget without being one.
+//
+// `GtkListItem`, `GtkListHeader`, `GtkColumnViewCell` and `AdwToggle` descend from
+// `GObject.Object` and hold a widget through `set_child`/`get_child`. A renderer places
+// them exactly like a container, so they belong in the vocabulary; a check asking "is
+// this a widget" must still be able to say no. Hence a sibling table rather than four
+// more rows in `Widgets`: concatenate them when you mean both.
+// ---------------------------------------------------------------------------
+
+export interface ChildHolders {
+
+}
+
+/** Every GType this namespace holds a child in without it being a widget. */
+export type ChildHolderGType = keyof ChildHolders;
+
+/** The writable, optional, GObject-keyed property surface of one GType. */
+export type PropsOf<G extends WidgetGType> = Widgets[G]['props'];
+
+/** The signal table this package already emits, reached by GType. */
+export type SignalsOf<G extends WidgetGType> = Widgets[G]['signals'];
+
+/** The instance type — what a `ref`-shaped prop should infer. */
+export type InstanceOf<G extends WidgetGType> = Widgets[G]['class'];
+
+/** Property names that can only be set at construction. */
+export type ConstructOnlyOf<G extends WidgetGType> = Widgets[G]['constructOnly'];
+
+/** Candidate child slots — see the note above; curation decides. */
+export type SlotCandidatesOf<G extends WidgetGType> = keyof Widgets[G]['slotCandidates'];
+
+/**
+ * The same facts as runtime data, for a consumer that CHECKS them.
+ *
+ * Types are erased, so a spec that asks the installed GTK whether every property
+ * here is a writable ParamSpec, every signal resolvable by `GObject.signal_lookup`
+ * and every nick resolvable through an enum lookup cannot read the interfaces
+ * above. Emitted headlessly with no GTK present, which is exactly why the checking
+ * belongs to the consumer and the DATA belongs here.
+ */
+export const PROVENANCE: {
+    readonly namespace: string;
+    readonly version: string;
+    /** The version the LIBRARY states, or null where it states none. Never the namespace's. */
+    readonly libraryVersion: string | null;
+    readonly childHolders: number;
+    readonly droppedBases: readonly string[];
+    readonly inlinedBases: readonly string[];
+    readonly unsettableProps: readonly string[];
+};
+
+/** Declaration GType -> its own settable properties, as GObject registered them. */
+export const OWN_PROPS: Readonly<Record<string, readonly string[]>>;
+
+/**
+ * Declaration GType -> the signals it registers itself, never its parents'.
+ *
+ * Keyed like `OWN_PROPS`, so both are read at every link of a `DECLS` chain. An
+ * abstract base has no `Widgets` row and still owns signals — `GtkWidget` owns 13.
+ */
+export const OWN_SIGNALS: Readonly<Record<string, readonly string[]>>;
+
+/** Widget GType -> every declaration its members come from, self first. */
+export const DECLS: Readonly<Record<string, readonly string[]>>;
+
+/** The GTypes in `DECLS` that hold a widget without being one — see `ChildHolders`. */
+export const CHILD_HOLDERS: readonly string[];
+
+/** Enum GType -> the nicks this surface offers. */
+export const ENUM_NICKS: Readonly<Record<string, readonly string[]>>;
+
+/** Widget GType -> slot name -> the method that may adopt a child there. */
+export const SLOT_CANDIDATES: Readonly<Record<string, Readonly<Record<string, string>>>>;
+
+/**
+ * `Type`, `Type.property` and `Type::signal` -> the release that introduced it.
+ *
+ * What keeps a runtime cross-check honest across a version gap without an
+ * allowlist: a name the installed library lacks is a defect UNLESS the version
+ * here is newer than the one running.
+ *
+ * ALL THREE key shapes, because that test only works for the names it covers. A
+ * property-only map leaves a consumer no way to explain a missing SIGNAL, which is
+ * a correct vocabulary reported as 18 defects; a member-only map leaves it no way to
+ * explain a missing CLASS, and that one fails as a bare
+ * `TypeError: can't access property "$gtype", ctor() is undefined` that does not
+ * even name the GType.
+ *
+ * A key is present only where the GIR states a version — sparse by nature (`version`
+ * sits on 29 of the 301 classes and interfaces in Gtk-4.0), never inferred.
+ */
+export const SINCE: Readonly<Record<string, string>>;

package/gdl-3-vocabulary.js

@@ -0,0 +1,83 @@
+// The widget vocabulary of Gdl-3 as runtime data.
+//
+// GENERATED — do not edit. Provenance: Gdl-3 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object Atk.ImplementorIface — prop(s) no TypeScript value satisfies: Gdl.DockObject.pixbuf-icon
+//
+// The type half of this subpath is the sibling `.d.ts`. This file exists because
+// types are erased: a consumer that wants to ask the installed library whether every
+// name here is real needs values, not declarations.
+
+export const PROVENANCE = {
+    namespace: 'Gdl',
+    version: '3',
+    libraryVersion: null,
+    childHolders: 0,
+    droppedBases: ['GObject.InitiallyUnowned', 'GObject.Object', 'Atk.ImplementorIface'],
+    inlinedBases: [],
+    unsettableProps: ['Gdl.DockObject.pixbuf-icon'],
+};
+
+export const OWN_PROPS = {
+    GdlDock: ['default-title', 'floating', 'floatx', 'floaty', 'height', 'skip-taskbar', 'width'],
+    GdlDockBar: ['dockbar-style', 'master'],
+    GdlDockItem: ['behavior', 'closed', 'iconified', 'locked', 'orientation', 'preferred-height', 'preferred-width', 'resize'],
+    GdlDockItemGrip: ['item'],
+    GdlDockNotebook: ['page'],
+    GdlDockObject: ['long-name', 'master', 'name', 'pixbuf-icon', 'stock-id'],
+    GdlDockPaned: ['position'],
+    GdlDockPlaceholder: ['floating', 'floatx', 'floaty', 'height', 'host', 'next-placement', 'sticky', 'width'],
+    GdlDockTablabel: ['item'],
+    GdlSwitcher: ['switcher-style', 'tab-pos', 'tab-reorderable'],
+};
+
+export const OWN_SIGNALS = {
+    GdlDock: ['layout-changed'],
+    GdlDockItem: ['deselected', 'dock-drag-begin', 'dock-drag-end', 'dock-drag-motion', 'move-focus-child', 'selected'],
+    GdlDockObject: ['detach', 'dock'],
+    GdlDockTablabel: ['button-pressed-handle'],
+};
+
+export const DECLS = {
+    GdlDock: ['GdlDock', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
+    GdlDockBar: ['GdlDockBar', 'GtkBox', 'GtkContainer', 'GtkWidget', 'GtkBuildable', 'GtkOrientable'],
+    GdlDockItem: ['GdlDockItem', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
+    GdlDockItemButtonImage: ['GdlDockItemButtonImage', 'GtkWidget', 'GtkBuildable'],
+    GdlDockItemGrip: ['GdlDockItemGrip', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
+    GdlDockNotebook: ['GdlDockNotebook', 'GdlDockItem', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
+    GdlDockObject: ['GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
+    GdlDockPaned: ['GdlDockPaned', 'GdlDockItem', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
+    GdlDockPlaceholder: ['GdlDockPlaceholder', 'GdlDockObject', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
+    GdlDockTablabel: ['GdlDockTablabel', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
+    GdlPreviewWindow: ['GdlPreviewWindow', 'GtkWindow', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
+    GdlSwitcher: ['GdlSwitcher', 'GtkNotebook', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
+};
+
+// The GTypes above that are NOT widgets: they hold one through `set_child`/`get_child`
+// and descend from `GObject.Object`. A renderer places them like a container; a check
+// asking "is this a widget" must not count them. Derived from the accessor pair, never
+// from a list — the count is in the provenance line above.
+export const CHILD_HOLDERS = [];
+
+export const ENUM_NICKS = {
+    GdlDockBarStyle: ['icons', 'text', 'both', 'auto'],
+    GdlDockPlacement: ['none', 'top', 'bottom', 'right', 'left', 'center', 'floating'],
+    GdlSwitcherStyle: ['text', 'icon', 'both', 'toolbar', 'tabs', 'none'],
+};
+
+export const SLOT_CANDIDATES = {
+    GdlDockItem: {
+        'child': 'set_child',
+        'default-position': 'set_default_position',
+        'tablabel': 'set_tablabel',
+    },
+    GdlDockItemGrip: {
+        'label': 'set_label',
+    },
+};
+
+export const SINCE = {
+    'GdlDock.skip-taskbar': '3.6',
+    'GdlDockItem.closed': '3.6',
+    'GdlDockItem.iconified': '3.6',
+    'GdlDockItem::move-focus-child': '3.3.2',
+    'GdlDockObject.pixbuf-icon': '3.3.2',
+};

package/gdl-3.d.ts

@@ -47,19 +47,19 @@ export namespace Gdl {
         /**
          * Buttons display only icons in the dockbar.
          */
-        ICONS,
+        ICONS = 0,
         /**
          * Buttons display only text labels in the dockbar.
          */
-        TEXT,
+        TEXT = 1,
         /**
          * Buttons display text and icons in the dockbar.
          */
-        BOTH,
+        BOTH = 2,
         /**
          * identical to `GDL_DOCK_BAR_BOTH`.
          */
-        AUTO,
+        AUTO = 3,
     }
 
 
@@ -71,11 +71,11 @@ export namespace Gdl {
         /**
          * Display a small cross
          */
-        CLOSE,
+        CLOSE = 0,
         /**
          * Display a small triangle
          */
-        ICONIFY,
+        ICONIFY = 1,
     }
 
 
@@ -94,31 +94,31 @@ export namespace Gdl {
         /**
          * No position defined
          */
-        NONE,
+        NONE = 0,
         /**
          * Dock object on the top
          */
-        TOP,
+        TOP = 1,
         /**
          * Dock object on the bottom
          */
-        BOTTOM,
+        BOTTOM = 2,
         /**
          * Dock object on the right
          */
-        RIGHT,
+        RIGHT = 3,
         /**
          * Dock object on the left
          */
-        LEFT,
+        LEFT = 4,
         /**
          * Dock object on top of the other
          */
-        CENTER,
+        CENTER = 5,
         /**
          * Dock object in its own window
          */
-        FLOATING,
+        FLOATING = 6,
     }
 
 
@@ -137,38 +137,45 @@ export namespace Gdl {
         /**
          * Tabs display only text labels.
          */
-        TEXT,
+        TEXT = 0,
         /**
          * Tabs display only icons.
          */
-        ICON,
+        ICON = 1,
         /**
          * Tabs display text and icons.
          */
-        BOTH,
+        BOTH = 2,
         /**
          * Same as `GDL_SWITCHER_STYLE_BOTH`.
          */
-        TOOLBAR,
+        TOOLBAR = 3,
         /**
          * Tabs display like notebook tabs.
          */
-        TABS,
+        TABS = 4,
         /**
          * Do not display tabs.
          */
-        NONE,
+        NONE = 5,
     }
 
 
+    /**
+     * @default master
+     */
     const DOCK_MASTER_PROPERTY: string;
 
+    /**
+     * @default name
+     */
     const DOCK_NAME_PROPERTY: string;
 
     /**
      * Minimum shift count to be used for user defined flags, to be stored in
      * {@link Gdl.DockObject}.flags.
      * @deprecated since 3.6: Use a private flag instead
+     * @default 8
      */
     const DOCK_OBJECT_FLAGS_SHIFT: number;
 
@@ -217,55 +224,55 @@ export namespace Gdl {
         /**
          * Normal dock item
          */
-        NORMAL,
+        NORMAL = 0,
         /**
          * item cannot be undocked
          */
-        NEVER_FLOATING,
+        NEVER_FLOATING = 1,
         /**
          * item cannot be docked vertically
          */
-        NEVER_VERTICAL,
+        NEVER_VERTICAL = 2,
         /**
          * item cannot be docked horizontally
          */
-        NEVER_HORIZONTAL,
+        NEVER_HORIZONTAL = 4,
         /**
          * item is locked, it cannot be moved around
          */
-        LOCKED,
+        LOCKED = 8,
         /**
          * item cannot be docked at top
          */
-        CANT_DOCK_TOP,
+        CANT_DOCK_TOP = 16,
         /**
          * item cannot be docked at bottom
          */
-        CANT_DOCK_BOTTOM,
+        CANT_DOCK_BOTTOM = 32,
         /**
          * item cannot be docked left
          */
-        CANT_DOCK_LEFT,
+        CANT_DOCK_LEFT = 64,
         /**
          * item cannot be docked right
          */
-        CANT_DOCK_RIGHT,
+        CANT_DOCK_RIGHT = 128,
         /**
          * item cannot be docked at center
          */
-        CANT_DOCK_CENTER,
+        CANT_DOCK_CENTER = 256,
         /**
          * item cannot be closed
          */
-        CANT_CLOSE,
+        CANT_CLOSE = 512,
         /**
          * item cannot be iconified
          */
-        CANT_ICONIFY,
+        CANT_ICONIFY = 1024,
         /**
          * item doesn't have a grip
          */
-        NO_GRIP,
+        NO_GRIP = 2048,
     }
 
 
@@ -285,19 +292,19 @@ export namespace Gdl {
         /**
          * item is in a drag operation
          */
-        IN_DRAG,
+        IN_DRAG = 256,
         /**
          * item is in a predrag operation
          */
-        IN_PREDRAG,
+        IN_PREDRAG = 512,
         /**
          * item is iconified
          */
-        ICONIFIED,
+        ICONIFIED = 1024,
         /**
          * indicates the user has started an action on the dock item
          */
-        USER_ACTION,
+        USER_ACTION = 2048,
     }
 
 
@@ -319,19 +326,19 @@ export namespace Gdl {
         /**
          * Object is created and destroyed by the master, not the user
          */
-        AUTOMATIC,
+        AUTOMATIC = 1,
         /**
          * Object has a parent
          */
-        ATTACHED,
+        ATTACHED = 2,
         /**
          * Object is currently part of a rearrangement
          */
-        IN_REFLOW,
+        IN_REFLOW = 4,
         /**
          * Object will be removed
          */
-        IN_DETACH,
+        IN_DETACH = 8,
     }
 
 
@@ -351,11 +358,11 @@ export namespace Gdl {
         /**
          * The parameter is to be exported for later layout rebuilding
          */
-        EXPORT,
+        EXPORT = 256,
         /**
          * The parameter must be set after adding the children objects
          */
-        AFTER,
+        AFTER = 512,
     }
 
 
@@ -827,13 +834,13 @@ export namespace Gdl {
              * @signal
              * @run-first
              */
-            "dock-drag-end": (arg0: boolean) => void;
+            "dock-drag-end": (cancel: boolean) => void;
             /**
              * Signals that a dock item dragging motion event has occured.
              * @signal
              * @run-first
              */
-            "dock-drag-motion": (arg0: Gdk.Device, arg1: number, arg2: number) => void;
+            "dock-drag-motion": (device: Gdk.Device, x: number, y: number) => void;
             /**
              * The ::move-focus-child signal is emitted when a change of focus is
              * requested for the child widget of a dock item.  The `dir` parameter
@@ -843,7 +850,7 @@ export namespace Gdl {
              * @action
              * @run-last
              */
-            "move-focus-child": (arg0: Gtk.DirectionType) => void;
+            "move-focus-child": (dir: Gtk.DirectionType) => void;
             /**
              * Signals that this dock has been selected from a switcher.
              * @signal
@@ -2160,13 +2167,13 @@ export namespace Gdl {
              * @signal
              * @run-last
              */
-            detach: (arg0: boolean) => void;
+            detach: (recursive: boolean) => void;
             /**
              * Signals that the {@link Gdl.DockObject} has been docked.
              * @signal
              * @run-first
              */
-            dock: (arg0: DockObject, arg1: DockPlacement, arg2: unknown | null) => void;
+            dock: (requestor: DockObject, position: DockPlacement, other_data: unknown | null) => void;
             "notify::long-name": (pspec: GObject.ParamSpec) => void;
             "notify::master": (pspec: GObject.ParamSpec) => void;
             "notify::name": (pspec: GObject.ParamSpec) => void;
@@ -2972,7 +2979,7 @@ export namespace Gdl {
              * @signal
              * @run-last
              */
-            "button-pressed-handle": (arg0: Gdk.Event) => void;
+            "button-pressed-handle": (event: Gdk.Event) => void;
             "notify::item": (pspec: GObject.ParamSpec) => void;
             "notify::border-width": (pspec: GObject.ParamSpec) => void;
             "notify::child": (pspec: GObject.ParamSpec) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/gdl-3",
-    "version": "4.4.0",
+    "version": "4.5.0",
     "description": "GJS TypeScript type definitions for Gdl-3",
     "type": "module",
     "module": "gdl-3.js",
@@ -16,10 +16,10 @@
         "import": "./gdl-3-import.js",
         "default": "./gdl-3-import.js"
       },
-      "./surface": {
-        "types": "./gdl-3-surface.d.ts",
-        "import": "./gdl-3-surface.js",
-        "default": "./gdl-3-surface.js"
+      "./vocabulary": {
+        "types": "./gdl-3-vocabulary.d.ts",
+        "import": "./gdl-3-vocabulary.js",
+        "default": "./gdl-3-vocabulary.js"
       },
       "./gdl-3": {
         "types": "./gdl-3.d.ts",
@@ -36,20 +36,20 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.4.0",
-      "@girs/gtk-3.0": "^4.4.0",
-      "@girs/xlib-2.0": "^4.4.0",
-      "@girs/gdk-3.0": "^4.4.0",
-      "@girs/cairo-1.0": "^4.4.0",
-      "@girs/gobject-2.0": "^4.4.0",
-      "@girs/glib-2.0": "^4.4.0",
-      "@girs/pango-1.0": "^4.4.0",
-      "@girs/harfbuzz-0.0": "^4.4.0",
-      "@girs/freetype2-2.0": "^4.4.0",
-      "@girs/gio-2.0": "^4.4.0",
-      "@girs/gmodule-2.0": "^4.4.0",
-      "@girs/gdkpixbuf-2.0": "^4.4.0",
-      "@girs/atk-1.0": "^4.4.0"    },
+      "@girs/gjs": "^4.5.0",
+      "@girs/gtk-3.0": "^4.5.0",
+      "@girs/xlib-2.0": "^4.5.0",
+      "@girs/gdk-3.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/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",
+      "@girs/atk-1.0": "^4.5.0"    },
     "devDependencies": {
       "typescript": "*"
     },

package/tsconfig.json

@@ -62,7 +62,7 @@
       ]
 }
   },
-  "include": ["./gdl-3.d.ts","./gdl-3-surface.d.ts"]
+  "include": ["./gdl-3.d.ts","./gdl-3-vocabulary.d.ts"]
 }