@girs/amtk-5 4.3.0 → 4.5.0

package/README.md

@@ -4,82 +4,96 @@
 ![version](https://img.shields.io/npm/v/@girs/amtk-5)
 ![downloads/week](https://img.shields.io/npm/dw/@girs/amtk-5)
 
+GJS TypeScript type definitions for Amtk-5 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.5.0.
 
-GJS TypeScript type definitions for Amtk-5 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/amtk-5
 ```
 
-## Usage
+Any package manager works. The package has no dependencies beyond other `@girs/*`
+type packages.
+
+## What it exports
+
+| Import | What you get |
+|---|---|
+| `@girs/amtk-5` | the namespace as a default export, plus the ambient and global declarations |
+| `@girs/amtk-5/ambient` | only the `gi://` module declarations |
+| `@girs/amtk-5/import` | only the `imports.gi` declarations |
+| `@girs/amtk-5/amtk-5` | the namespace, without the side-effecting declarations |
+| `@girs/amtk-5/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 Amtk from '@girs/amtk-5';
 ```
 
-### 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/amtk-5` or `@girs/amtk-5/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/amtk-5'
+import '@girs/amtk-5';
 ```
 
-`tsconfig.json`:
 ```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/amtk-5"],
-  ...
-}
+{ "include": ["@girs/amtk-5"] }
 ```
 
-The ambient module now resolves with types:
+Then the runtime spelling type-checks:
 
 ```ts
 import Amtk from 'gi://Amtk?version=5';
 ```
 
-### Global import
+Referencing `@girs/amtk-5/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/amtk-5` or `@girs/amtk-5/import` in your `tsconfig` or entry point Typescript file:
+GJS's global object works the same way, via `@girs/amtk-5/import`:
 
-`index.ts`:
 ```ts
-import '@girs/amtk-5'
+const Amtk = imports.gi.Amtk;
 ```
 
-`tsconfig.json`:
-```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/amtk-5"],
-  ...
-}
-```
+## Widget vocabulary
 
-That form carries types as well:
+`amtk-5` declares widgets, so it also carries what the GIR says about them, as
+types and as values a test can read:
 
 ```ts
-const Amtk = imports.gi.Amtk;
+import type { Widgets, PropsOf } from '@girs/amtk-5/vocabulary';
+import { OWN_PROPS, ENUM_NICKS, PROVENANCE } from '@girs/amtk-5/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/amtk-5-surface.d.ts

@@ -87,6 +87,23 @@ export interface Widgets {
 /** 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'];
 
@@ -122,6 +139,9 @@ 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[]>>;
 

package/amtk-5-surface.js

@@ -18,6 +18,12 @@ export const DECLS = {
     AmtkTreeViewScrolledWindowSizing: ['AmtkTreeViewScrolledWindowSizing', 'GtkScrolledWindow', 'GtkBin', '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 = {};
 
 export const SLOT_CANDIDATES = {};

package/amtk-5-vocabulary.d.ts

@@ -0,0 +1,183 @@
+/**
+ * The GIR-derived widget VOCABULARY for Amtk-5.
+ *
+ * GENERATED — do not edit. Provenance: Amtk-5 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object Atk.ImplementorIface
+ *
+ * 1 concrete widgets, 1 declarations, 0 enum nick unions, 0 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 Amtk from './amtk-5.js';
+import type { GtkBinConstructOnly, GtkBinProps, GtkBuildableConstructOnly, GtkBuildableProps, GtkContainerConstructOnly, GtkContainerProps, GtkScrolledWindowConstructOnly, GtkScrolledWindowProps, GtkWidgetConstructOnly, GtkWidgetProps } 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.
+// ---------------------------------------------------------------------------
+
+
+
+// ---------------------------------------------------------------------------
+// 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 AmtkTreeViewScrolledWindowSizingProps extends GtkScrolledWindowProps, GtkBuildableProps {
+    /**
+     * Whether to take the #GdkMonitor size into account as a maximum width and height to apply.
+     * @since 5.10
+     * @default TRUE
+     */
+    'monitor-limit-enabled'?: boolean;
+}
+/** Settable only at construction — a renderer must REBUILD, not patch. */
+export type AmtkTreeViewScrolledWindowSizingConstructOnly = GtkScrolledWindowConstructOnly | 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 {
+    AmtkTreeViewScrolledWindowSizing: {
+        class: Amtk.TreeViewScrolledWindowSizing;
+        props: AmtkTreeViewScrolledWindowSizingProps;
+        signals: Amtk.TreeViewScrolledWindowSizing.SignalSignatures;
+        constructOnly: AmtkTreeViewScrolledWindowSizingConstructOnly;
+        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/amtk-5-vocabulary.js

@@ -0,0 +1,41 @@
+// The widget vocabulary of Amtk-5 as runtime data.
+//
+// GENERATED — do not edit. Provenance: Amtk-5 — dropped empty base(s): GObject.InitiallyUnowned GObject.Object Atk.ImplementorIface
+//
+// 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: 'Amtk',
+    version: '5',
+    libraryVersion: null,
+    childHolders: 0,
+    droppedBases: ['GObject.InitiallyUnowned', 'GObject.Object', 'Atk.ImplementorIface'],
+    inlinedBases: [],
+    unsettableProps: [],
+};
+
+export const OWN_PROPS = {
+    AmtkTreeViewScrolledWindowSizing: ['monitor-limit-enabled'],
+};
+
+export const OWN_SIGNALS = {};
+
+export const DECLS = {
+    AmtkTreeViewScrolledWindowSizing: ['AmtkTreeViewScrolledWindowSizing', 'GtkScrolledWindow', 'GtkBin', '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 = {};
+
+export const SLOT_CANDIDATES = {};
+
+export const SINCE = {
+    'AmtkTreeViewScrolledWindowSizing.monitor-limit-enabled': '5.10',
+};

package/amtk-5.d.ts

@@ -266,40 +266,40 @@ export namespace Amtk {
         /**
          * No flags.
          */
-        FLAGS_NONE,
+        FLAGS_NONE = 0,
         /**
          * Do not associate the created object with the
          *   {@link Gio.Action}. For example if the object to create is a {@link Gtk.Actionable}, do not
          *   call `gtk_actionable_set_detailed_action_name()`.
          */
-        IGNORE_GACTION,
+        IGNORE_GACTION = 1,
         /**
          * Do not set an icon.
          */
-        IGNORE_ICON,
+        IGNORE_ICON = 2,
         /**
          * Do not set a label/short description.
          */
-        IGNORE_LABEL,
+        IGNORE_LABEL = 4,
         /**
          * Do not set a tooltip/long description.
          */
-        IGNORE_TOOLTIP,
+        IGNORE_TOOLTIP = 8,
         /**
          * Ignore completely the accelerators.
          */
-        IGNORE_ACCELS,
+        IGNORE_ACCELS = 16,
         /**
          * Ignore the accelerators for
          *   documentation purposes only. For example do not add/configure a
          *   {@link Gtk.AccelLabel}.
          */
-        IGNORE_ACCELS_FOR_DOC,
+        IGNORE_ACCELS_FOR_DOC = 32,
         /**
          * Do not call
          *   `gtk_application_set_accels_for_action()`.
          */
-        IGNORE_ACCELS_FOR_APP,
+        IGNORE_ACCELS_FOR_APP = 64,
     }
 
 
@@ -345,12 +345,16 @@ export namespace Amtk {
         emit(signal: string, ...args: any[]): void;
 
         // Static methods
+        /**
+         * @since 3.0
+         */
         static get_singleton(): ActionInfoCentralStore;
 
         // Methods
         /**
          * @param action_name an action name.
          * @returns the found {@link Amtk.ActionInfo}, or `null`.
+         * @since 2.0
          */
         lookup(action_name: string): ActionInfo;
     }
@@ -406,6 +410,7 @@ export namespace Amtk {
          * {@link Amtk.ActionInfo} with the same action name. The stores take their own
          * reference on `info`.
          * @param info an {@link Amtk.ActionInfo}.
+         * @since 2.0
          */
         add(info: ActionInfo): void;
 
@@ -418,6 +423,7 @@ export namespace Amtk {
          * An API similar to `g_action_map_add_action_entries()`.
          * @param entries a pointer to the first item in an array of {@link Amtk.ActionInfoEntry} structs.
          * @param translation_domain a gettext domain, or `null`.
+         * @since 2.0
          */
         add_entries(entries: ActionInfoEntry[], translation_domain: string | null): void;
 
@@ -429,12 +435,14 @@ export namespace Amtk {
          * You probably want to call this function on the application store after
          * creating the menu and toolbar. But it can also be useful for a store provided
          * by a library, to easily see which actions are not used by the application.
+         * @since 2.0
          */
         check_all_used(): void;
 
         /**
          * @param action_name an action name.
          * @returns the found {@link Amtk.ActionInfo}, or `null`.
+         * @since 2.0
          */
         lookup(action_name: string): ActionInfo;
 
@@ -462,6 +470,7 @@ export namespace Amtk {
          * {@link Amtk.Factory}, containing information about actions that are not added to any
          * menu or toolbar.
          * @param application a {@link Gtk.Application}.
+         * @since 5.0
          */
         set_all_accels_to_app(application: Gtk.Application): void;
     }
@@ -546,6 +555,7 @@ export namespace Amtk {
          * are added to the default {@link Gtk.RecentManager} with
          * `gtk_recent_manager_add_item()`, the files will normally show up in the
          * {@link Gtk.RecentChooserMenu}.
+         * @since 5.6
          */
         static create_open_recent_menu_base(): Gtk.RecentChooserMenu;
 
@@ -553,6 +563,7 @@ export namespace Amtk {
          * Returns the {@link Amtk.ApplicationWindow} of `gtk_window`. The returned object is
          * guaranteed to be the same for the lifetime of `gtk_window`.
          * @param gtk_window a {@link Gtk.ApplicationWindow}.
+         * @since 2.0
          */
         static get_from_gtk_application_window(gtk_window: Gtk.ApplicationWindow): ApplicationWindow;
 
@@ -566,6 +577,7 @@ export namespace Amtk {
          * So `amtk_menu_item_set_long_description()` must have been called, which is the
          * case if the {@link Gtk.MenuItem} has been created with {@link Amtk.Factory}.
          * @param menu_shell a {@link Gtk.MenuShell}.
+         * @since 2.0
          */
         connect_menu_to_statusbar(menu_shell: Gtk.MenuShell): void;
 
@@ -577,6 +589,7 @@ export namespace Amtk {
          * The full path is retrieved with
          * `amtk_utils_recent_chooser_menu_get_item_uri()`.
          * @param menu a {@link Gtk.RecentChooserMenu}.
+         * @since 2.0
          */
         connect_recent_chooser_menu_to_statusbar(menu: Gtk.RecentChooserMenu): void;
 
@@ -592,6 +605,7 @@ export namespace Amtk {
          *   `g_application_open()` is called (with an empty hint), so the {@link Gio.Application}
          *   must have the {@link Gio.ApplicationFlags.HANDLES_OPEN} flag set.
          * @returns a new {@link Gtk.RecentChooserMenu}.
+         * @since 3.0
          */
         create_open_recent_menu(): Gtk.Widget;
 
@@ -600,22 +614,26 @@ export namespace Amtk {
          * submenu. The {@link Gtk.RecentChooserMenu} is created with
          * `amtk_application_window_create_open_recent_menu()`.
          * @returns a new {@link Gtk.MenuItem}.
+         * @since 2.0
          */
         create_open_recent_menu_item(): Gtk.Widget;
 
         /**
          * @returns the {@link Gtk.ApplicationWindow} of `amtk_window`.
+         * @since 2.0
          */
         get_application_window(): Gtk.ApplicationWindow;
 
         /**
          * @returns the {@link Amtk.ApplicationWindow.statusbar}.
+         * @since 2.0
          */
         get_statusbar(): Gtk.Statusbar | null;
 
         /**
          * Sets the {@link Amtk.ApplicationWindow.statusbar} property.
          * @param statusbar a {@link Gtk.Statusbar}, or `null`.
+         * @since 2.0
          */
         set_statusbar(statusbar: Gtk.Statusbar | null): void;
     }
@@ -707,6 +725,7 @@ export namespace Amtk {
          * information.
          * @param action_name an action name.
          * @returns a new {@link Gtk.CheckMenuItem} for `action_name`.
+         * @since 3.0
          */
         create_check_menu_item(action_name: string): Gtk.Widget;
 
@@ -722,6 +741,7 @@ export namespace Amtk {
          * @param action_name an action name.
          * @param flags {@link Amtk.FactoryFlags}.
          * @returns a new {@link Gtk.CheckMenuItem} for `action_name`.
+         * @since 3.0
          */
         create_check_menu_item_full(action_name: string, flags: FactoryFlags): Gtk.Widget;
 
@@ -730,6 +750,7 @@ export namespace Amtk {
          * {@link Amtk.Factory.default_flags}.
          * @param action_name an action name.
          * @returns a new {@link Gio.MenuItem} for `action_name`.
+         * @since 5.0
          */
         create_gmenu_item(action_name: string): Gio.MenuItem;
 
@@ -742,6 +763,7 @@ export namespace Amtk {
          * @param action_name an action name.
          * @param flags {@link Amtk.FactoryFlags}.
          * @returns a new {@link Gio.MenuItem} for `action_name`.
+         * @since 5.0
          */
         create_gmenu_item_full(action_name: string, flags: FactoryFlags): Gio.MenuItem;
 
@@ -750,6 +772,7 @@ export namespace Amtk {
          * {@link Amtk.Factory.default_flags}.
          * @param action_name an action name.
          * @returns a new {@link Gtk.MenuItem} for `action_name`.
+         * @since 3.0
          */
         create_menu_item(action_name: string): Gtk.Widget;
 
@@ -759,6 +782,7 @@ export namespace Amtk {
          * @param action_name an action name.
          * @param flags {@link Amtk.FactoryFlags}.
          * @returns a new {@link Gtk.MenuItem} for `action_name`.
+         * @since 3.0
          */
         create_menu_item_full(action_name: string, flags: FactoryFlags): Gtk.Widget;
 
@@ -770,6 +794,7 @@ export namespace Amtk {
          * information.
          * @param action_name an action name.
          * @returns a new {@link Gtk.MenuToolButton} for `action_name`.
+         * @since 3.0
          */
         create_menu_tool_button(action_name: string): Gtk.MenuToolButton;
 
@@ -782,6 +807,7 @@ export namespace Amtk {
          * @param action_name an action name.
          * @param flags {@link Amtk.FactoryFlags}.
          * @returns a new {@link Gtk.MenuToolButton} for `action_name`.
+         * @since 3.0
          */
         create_menu_tool_button_full(action_name: string, flags: FactoryFlags): Gtk.MenuToolButton;
 
@@ -790,6 +816,7 @@ export namespace Amtk {
          * {@link Amtk.Factory.default_flags}.
          * @param action_name an action name.
          * @returns a new {@link Gtk.ShortcutsShortcut} for `action_name`.
+         * @since 5.0
          */
         create_shortcut(action_name: string): Gtk.Widget;
 
@@ -818,6 +845,7 @@ export namespace Amtk {
          * @param action_name an action name.
          * @param flags {@link Amtk.FactoryFlags}.
          * @returns a new {@link Gtk.ShortcutsShortcut} for `action_name`.
+         * @since 5.0
          */
         create_shortcut_full(action_name: string, flags: FactoryFlags): Gtk.Widget;
 
@@ -826,6 +854,7 @@ export namespace Amtk {
          * {@link Amtk.Factory.default_flags}.
          * @param entries a   pointer to the first item in an array of {@link Amtk.ActionInfoEntry} structs.
          * @returns a new simple {@link Gtk.Menu} for `entries`.
+         * @since 5.0
          */
         create_simple_menu(entries: ActionInfoEntry[]): Gtk.Widget;
 
@@ -845,6 +874,7 @@ export namespace Amtk {
          * @param entries a   pointer to the first item in an array of {@link Amtk.ActionInfoEntry} structs.
          * @param flags {@link Amtk.FactoryFlags}.
          * @returns a new simple {@link Gtk.Menu} for `entries`.
+         * @since 5.0
          */
         create_simple_menu_full(entries: ActionInfoEntry[], flags: FactoryFlags): Gtk.Widget;
 
@@ -853,6 +883,7 @@ export namespace Amtk {
          * {@link Amtk.Factory.default_flags}.
          * @param action_name an action name.
          * @returns a new {@link Gtk.ToolButton} for `action_name`.
+         * @since 3.0
          */
         create_tool_button(action_name: string): Gtk.ToolItem;
 
@@ -862,22 +893,26 @@ export namespace Amtk {
          * @param action_name an action name.
          * @param flags {@link Amtk.FactoryFlags}.
          * @returns a new {@link Gtk.ToolButton} for `action_name`.
+         * @since 3.0
          */
         create_tool_button_full(action_name: string, flags: FactoryFlags): Gtk.ToolItem;
 
         /**
          * @returns the {@link Amtk.Factory.application}.
+         * @since 3.0
          */
         get_application(): Gtk.Application | null;
 
         /**
          * @returns the {@link Amtk.Factory.default_flags}.
+         * @since 3.0
          */
         get_default_flags(): FactoryFlags;
 
         /**
          * Sets the {@link Amtk.Factory.default_flags} property.
          * @param default_flags the new value.
+         * @since 3.0
          */
         set_default_flags(default_flags: FactoryFlags): void;
     }
@@ -894,7 +929,7 @@ export namespace Amtk {
              * @since 2.0
              * @run-first
              */
-            "menu-item-deselected": (arg0: Gtk.MenuItem) => void;
+            "menu-item-deselected": (menu_item: Gtk.MenuItem) => void;
             /**
              * The ::menu-item-selected signal is emitted when the
              * {@link Gtk.MenuItem.SignalSignatures.select | Gtk.MenuItem::select} signal is emitted on a {@link Gtk.MenuItem} belonging
@@ -903,7 +938,7 @@ export namespace Amtk {
              * @since 2.0
              * @run-first
              */
-            "menu-item-selected": (arg0: Gtk.MenuItem) => void;
+            "menu-item-selected": (menu_item: Gtk.MenuItem) => void;
             "notify::menu-shell": (pspec: GObject.ParamSpec) => void;
         }
 
@@ -967,6 +1002,7 @@ export namespace Amtk {
          * Returns the {@link Amtk.MenuShell} of `gtk_menu_shell`. The returned object is
          * guaranteed to be the same for the lifetime of `gtk_menu_shell`.
          * @param gtk_menu_shell a {@link Gtk.MenuShell}.
+         * @since 2.0
          */
         static get_from_gtk_menu_shell(gtk_menu_shell: Gtk.MenuShell): MenuShell;
 
@@ -986,6 +1022,7 @@ export namespace Amtk {
         // Methods
         /**
          * @returns the {@link Gtk.MenuShell} of `amtk_menu_shell`.
+         * @since 2.0
          */
         get_menu_shell(): Gtk.MenuShell;
     }
@@ -1118,17 +1155,20 @@ export namespace Amtk {
         // Methods
         /**
          * @returns the current value of the   {@link Amtk.TreeViewScrolledWindowSizing.monitor_limit_enabled} property.
+         * @since 5.10
          */
         get_monitor_limit(): boolean;
 
         /**
          * @returns the {@link Gtk.TreeView}, if the child widget is   a {@link Gtk.TreeView}. Otherwise `null` is returned.
+         * @since 5.10
          */
         get_tree_view(): Gtk.TreeView | null;
 
         /**
          * Sets the {@link Amtk.TreeViewScrolledWindowSizing.monitor_limit_enabled} property.
          * @param monitor_limit the new value.
+         * @since 5.10
          */
         set_monitor_limit(monitor_limit: boolean): void;
     }
@@ -1150,6 +1190,7 @@ export namespace Amtk {
         // Methods
         /**
          * @returns a copy of `info`. The copy will have a reference count of one.
+         * @since 2.0
          */
         copy(): ActionInfo;
 
@@ -1158,16 +1199,19 @@ export namespace Amtk {
          * returns a `null`-terminated array, to be suitable for
          * `gtk_application_set_accels_for_action()`.
          * @returns a `null`-terminated array of accelerators in the format understood by `gtk_accelerator_parse()`.
+         * @since 2.0
          */
         get_accels(): string[];
 
         /**
          * @returns the action name, or `null`. Example: `"win.save"`. Can be a detailed action name, see `g_action_parse_detailed_name()`.
+         * @since 2.0
          */
         get_action_name(): string | null;
 
         /**
          * @returns the icon name, or `null`.
+         * @since 2.0
          */
         get_icon_name(): string | null;
 
@@ -1175,11 +1219,13 @@ export namespace Amtk {
          * Gets the label. The label has normally a mnemonic. To remove the mnemonic,
          * there is the `amtk_utils_remove_mnemonic()` function.
          * @returns the label (i.e. a short description), or `null`.
+         * @since 2.0
          */
         get_label(): string | null;
 
         /**
          * @returns the tooltip (i.e. a long description), or `null`.
+         * @since 2.0
          */
         get_tooltip(): string | null;
 
@@ -1187,18 +1233,21 @@ export namespace Amtk {
          * Returns whether `info` has been used (for example by an {@link Amtk.Factory}
          * function). See also `amtk_action_info_store_check_all_used()`.
          * @returns whether `info` has been used.
+         * @since 3.0
          */
         has_been_used(): boolean;
 
         /**
          * Mark `info` as used. An {@link Amtk.Factory} function that uses an {@link Amtk.ActionInfo}
          * should call this function. See `amtk_action_info_store_check_all_used()`.
+         * @since 3.0
          */
         mark_as_used(): void;
 
         /**
          * Increments the reference count of `info` by one.
          * @returns the passed in `info`.
+         * @since 2.0
          */
         ref(): ActionInfo;
 
@@ -1208,6 +1257,7 @@ export namespace Amtk {
          * `accels` must not be `null`, it must be a `null`-terminated array, to be
          * consistent with `gtk_application_set_accels_for_action()`.
          * @param accels a `null`-terminated array of accelerators in the format understood by `gtk_accelerator_parse()`.
+         * @since 2.0
          */
         set_accels(accels: string[]): void;
 
@@ -1215,11 +1265,13 @@ export namespace Amtk {
          * Sets the action name, for example `"win.save"`. Can be a detailed action
          * name, see `g_action_parse_detailed_name()`.
          * @param action_name the action name.
+         * @since 2.0
          */
         set_action_name(action_name: string): void;
 
         /**
          * @param icon_name the icon name, or `null`.
+         * @since 2.0
          */
         set_icon_name(icon_name: string | null): void;
 
@@ -1227,17 +1279,20 @@ export namespace Amtk {
          * Sets the label with a mnemonic. To know how to encode the mnemonic, see the
          * documentation of `gtk_label_new_with_mnemonic()`.
          * @param label the label (i.e. a short description), or `null`.
+         * @since 2.0
          */
         set_label(label: string | null): void;
 
         /**
          * @param tooltip the tooltip (i.e. a long description), or `null`.
+         * @since 2.0
          */
         set_tooltip(tooltip: string | null): void;
 
         /**
          * Decrements the reference count of `info` by one. If the reference count drops
          * to 0, `info` is freed.
+         * @since 2.0
          */
         unref(): void;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/amtk-5",
-    "version": "4.3.0",
+    "version": "4.5.0",
     "description": "GJS TypeScript type definitions for Amtk-5",
     "type": "module",
     "module": "amtk-5.js",
@@ -16,10 +16,10 @@
         "import": "./amtk-5-import.js",
         "default": "./amtk-5-import.js"
       },
-      "./surface": {
-        "types": "./amtk-5-surface.d.ts",
-        "import": "./amtk-5-surface.js",
-        "default": "./amtk-5-surface.js"
+      "./vocabulary": {
+        "types": "./amtk-5-vocabulary.d.ts",
+        "import": "./amtk-5-vocabulary.js",
+        "default": "./amtk-5-vocabulary.js"
       },
       "./amtk-5": {
         "types": "./amtk-5.d.ts",
@@ -36,20 +36,20 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.3.0",
-      "@girs/gtk-3.0": "^4.3.0",
-      "@girs/xlib-2.0": "^4.3.0",
-      "@girs/gdk-3.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/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/atk-1.0": "^4.3.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": ["./amtk-5.d.ts","./amtk-5-surface.d.ts"]
+  "include": ["./amtk-5.d.ts","./amtk-5-vocabulary.d.ts"]
 }